xref: /rk3399_rockchip-uboot/include/common.h (revision 983fda8391fa0ccfd4e0fd0bfb5a5e662e07b222)
1 /*
2  * (C) Copyright 2000-2004
3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4  *
5  * See file CREDITS for list of people who contributed to this
6  * project.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License as
10  * published by the Free Software Foundation; either version 2 of
11  * the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21  * MA 02111-1307 USA
22  */
23 
24 #ifndef __COMMON_H_
25 #define __COMMON_H_	1
26 
27 #undef	_LINUX_CONFIG_H
28 #define _LINUX_CONFIG_H 1	/* avoid reading Linux autoconf.h file	*/
29 
30 typedef unsigned char		uchar;
31 typedef volatile unsigned long	vu_long;
32 typedef volatile unsigned short vu_short;
33 typedef volatile unsigned char	vu_char;
34 
35 #include <config.h>
36 #include <linux/bitops.h>
37 #include <linux/types.h>
38 #include <linux/string.h>
39 #include <asm/ptrace.h>
40 #include <stdarg.h>
41 #if defined(CONFIG_PCI) && defined(CONFIG_440)
42 #include <pci.h>
43 #endif
44 #if defined(CONFIG_8xx)
45 #include <asm/8xx_immap.h>
46 #if defined(CONFIG_MPC852)	|| defined(CONFIG_MPC852T)	|| \
47     defined(CONFIG_MPC859)	|| defined(CONFIG_MPC859T)	|| \
48     defined(CONFIG_MPC859DSL)	|| \
49     defined(CONFIG_MPC866)	|| defined(CONFIG_MPC866T)	|| \
50     defined(CONFIG_MPC866P)
51 # define CONFIG_MPC866_FAMILY 1
52 #elif defined(CONFIG_MPC870) \
53    || defined(CONFIG_MPC875) \
54    || defined(CONFIG_MPC880) \
55    || defined(CONFIG_MPC885)
56 # define CONFIG_MPC885_FAMILY   1
57 #endif
58 #if   defined(CONFIG_MPC860)	   \
59    || defined(CONFIG_MPC860T)	   \
60    || defined(CONFIG_MPC866_FAMILY) \
61    || defined(CONFIG_MPC885_FAMILY)
62 # define CONFIG_MPC86x 1
63 #endif
64 #elif defined(CONFIG_5xx)
65 #include <asm/5xx_immap.h>
66 #elif defined(CONFIG_MPC8220)
67 #include <asm/immap_8220.h>
68 #elif defined(CONFIG_8260)
69 #if   defined(CONFIG_MPC8247) \
70    || defined(CONFIG_MPC8248) \
71    || defined(CONFIG_MPC8271) \
72    || defined(CONFIG_MPC8272)
73 #define CONFIG_MPC8272_FAMILY	1
74 #endif
75 #if defined(CONFIG_MPC8272_FAMILY)
76 #define CONFIG_MPC8260	1
77 #endif
78 #include <asm/immap_8260.h>
79 #endif
80 #ifdef CONFIG_MPC85xx
81 #include <mpc85xx.h>
82 #include <asm/immap_85xx.h>
83 #endif
84 #ifdef	CONFIG_4xx
85 #include <ppc4xx.h>
86 #endif
87 #ifdef CONFIG_HYMOD
88 #include <board/hymod/hymod.h>
89 #endif
90 #ifdef CONFIG_ARM
91 #define asmlinkage	/* nothing */
92 #endif
93 
94 #include <part.h>
95 #include <flash.h>
96 #include <image.h>
97 
98 #ifdef	DEBUG
99 #define debug(fmt,args...)	printf (fmt ,##args)
100 #define debugX(level,fmt,args...) if (DEBUG>=level) printf(fmt,##args);
101 #else
102 #define debug(fmt,args...)
103 #define debugX(level,fmt,args...)
104 #endif	/* DEBUG */
105 
106 typedef void (interrupt_handler_t)(void *);
107 
108 #include <asm/u-boot.h> /* boot information for Linux kernel */
109 #include <asm/global_data.h>	/* global data used for startup functions */
110 
111 /*
112  * enable common handling for all TQM8xxL/M boards:
113  * - CONFIG_TQM8xxM will be defined for all TQM8xxM boards
114  * - CONFIG_TQM8xxL will be defined for all TQM8xxL _and_ TQM8xxM boards
115  */
116 #if defined(CONFIG_TQM823M) || defined(CONFIG_TQM850M) || \
117     defined(CONFIG_TQM855M) || defined(CONFIG_TQM860M) || \
118     defined(CONFIG_TQM862M) || defined(CONFIG_TQM866M)
119 # ifndef CONFIG_TQM8xxM
120 #  define CONFIG_TQM8xxM
121 # endif
122 #endif
123 #if defined(CONFIG_TQM823L) || defined(CONFIG_TQM850L) || \
124     defined(CONFIG_TQM855L) || defined(CONFIG_TQM860L) || \
125     defined(CONFIG_TQM862L) || defined(CONFIG_TQM8xxM)
126 # ifndef CONFIG_TQM8xxL
127 #  define CONFIG_TQM8xxL
128 # endif
129 #endif
130 
131 #ifndef CONFIG_SERIAL_MULTI
132 
133 #if defined(CONFIG_8xx_CONS_SMC1) || defined(CONFIG_8xx_CONS_SMC2) \
134  || defined(CONFIG_8xx_CONS_SCC1) || defined(CONFIG_8xx_CONS_SCC2) \
135  || defined(CONFIG_8xx_CONS_SCC3) || defined(CONFIG_8xx_CONS_SCC4)
136 
137 #define CONFIG_SERIAL_MULTI	1
138 
139 #endif
140 
141 #endif /* CONFIG_SERIAL_MULTI */
142 
143 /*
144  * General Purpose Utilities
145  */
146 #define min(X, Y)				\
147 	({ typeof (X) __x = (X), __y = (Y);	\
148 		(__x < __y) ? __x : __y; })
149 
150 #define max(X, Y)				\
151 	({ typeof (X) __x = (X), __y = (Y);	\
152 		(__x > __y) ? __x : __y; })
153 
154 
155 /*
156  * Function Prototypes
157  */
158 
159 #ifdef CONFIG_SERIAL_SOFTWARE_FIFO
160 void	serial_buffered_init (void);
161 void	serial_buffered_putc (const char);
162 void	serial_buffered_puts (const char *);
163 int	serial_buffered_getc (void);
164 int	serial_buffered_tstc (void);
165 #endif /* CONFIG_SERIAL_SOFTWARE_FIFO */
166 
167 void	hang		(void) __attribute__ ((noreturn));
168 
169 /* */
170 long int initdram (int);
171 int	display_options (void);
172 void	print_size (ulong, const char *);
173 
174 /* common/main.c */
175 void	main_loop	(void);
176 int	run_command	(const char *cmd, int flag);
177 int	readline	(const char *const prompt);
178 void	init_cmd_timeout(void);
179 void	reset_cmd_timeout(void);
180 
181 /* lib_$(ARCH)/board.c */
182 void	board_init_f  (ulong);
183 void	board_init_r  (gd_t *, ulong);
184 int	checkboard    (void);
185 int	checkflash    (void);
186 int	checkdram     (void);
187 char *	strmhz(char *buf, long hz);
188 int	last_stage_init(void);
189 extern ulong monitor_flash_len;
190 
191 /* common/flash.c */
192 void flash_perror (int);
193 
194 /* common/cmd_autoscript.c */
195 int	autoscript (ulong addr);
196 
197 /* common/cmd_bootm.c */
198 void	print_image_hdr (image_header_t *hdr);
199 
200 extern ulong load_addr;		/* Default Load Address */
201 
202 /* common/cmd_nvedit.c */
203 int	env_init     (void);
204 void	env_relocate (void);
205 char	*getenv	     (uchar *);
206 int	getenv_r     (uchar *name, uchar *buf, unsigned len);
207 int	saveenv	     (void);
208 #ifdef CONFIG_PPC		/* ARM version to be fixed! */
209 void inline setenv   (char *, char *);
210 #else
211 void	setenv	     (char *, char *);
212 #endif /* CONFIG_PPC */
213 #ifdef CONFIG_ARM
214 # include <asm/mach-types.h>
215 # include <asm/setup.h>
216 # include <asm/u-boot-arm.h>	/* ARM version to be fixed! */
217 #endif /* CONFIG_ARM */
218 #ifdef CONFIG_I386		/* x86 version to be fixed! */
219 # include <asm/u-boot-i386.h>
220 #endif /* CONFIG_I386 */
221 
222 #ifdef CONFIG_AUTO_COMPLETE
223 int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
224 #endif
225 
226 void	pci_init      (void);
227 void	pci_init_board(void);
228 void	pciinfo	      (int, int);
229 
230 #if defined(CONFIG_PCI) && defined(CONFIG_440)
231 #   if defined(CFG_PCI_PRE_INIT)
232     int	   pci_pre_init	       (struct pci_controller * );
233 #   endif
234 #   if defined(CFG_PCI_TARGET_INIT)
235 	void	pci_target_init	     (struct pci_controller *);
236 #   endif
237 #   if defined(CFG_PCI_MASTER_INIT)
238 	void	pci_master_init	     (struct pci_controller *);
239 #   endif
240     int	    is_pci_host		(struct pci_controller *);
241 #endif
242 
243 int	misc_init_f   (void);
244 int	misc_init_r   (void);
245 
246 /* common/exports.c */
247 void	jumptable_init(void);
248 
249 /* common/memsize.c */
250 int	get_ram_size  (volatile long *, long);
251 
252 /* $(BOARD)/$(BOARD).c */
253 void	reset_phy     (void);
254 void	fdc_hw_init   (void);
255 
256 /* $(BOARD)/eeprom.c */
257 void eeprom_init  (void);
258 #ifndef CONFIG_SPI
259 int  eeprom_probe (unsigned dev_addr, unsigned offset);
260 #endif
261 int  eeprom_read  (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
262 int  eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
263 #ifdef CONFIG_LWMON
264 extern uchar pic_read  (uchar reg);
265 extern void  pic_write (uchar reg, uchar val);
266 #endif
267 
268 /*
269  * Set this up regardless of board
270  * type, to prevent errors.
271  */
272 #if defined(CONFIG_SPI) || !defined(CFG_I2C_EEPROM_ADDR)
273 # define CFG_DEF_EEPROM_ADDR 0
274 #else
275 # define CFG_DEF_EEPROM_ADDR CFG_I2C_EEPROM_ADDR
276 #endif /* CONFIG_SPI || !defined(CFG_I2C_EEPROM_ADDR) */
277 
278 #if defined(CONFIG_SPI)
279 extern void spi_init_f (void);
280 extern void spi_init_r (void);
281 extern ssize_t spi_read	 (uchar *, int, uchar *, int);
282 extern ssize_t spi_write (uchar *, int, uchar *, int);
283 #endif
284 
285 #ifdef CONFIG_RPXCLASSIC
286 void rpxclassic_init (void);
287 #endif
288 
289 void rpxlite_init (void);
290 
291 #ifdef CONFIG_MBX
292 /* $(BOARD)/mbx8xx.c */
293 void	mbx_init (void);
294 void	board_serial_init (void);
295 void	board_ether_init (void);
296 #endif
297 
298 #if defined(CONFIG_RPXCLASSIC)	|| defined(CONFIG_MBX) || \
299     defined(CONFIG_IAD210)	|| defined(CONFIG_XPEDITE1K)
300 void	board_get_enetaddr (uchar *addr);
301 #endif
302 
303 #ifdef CONFIG_HERMES
304 /* $(BOARD)/hermes.c */
305 void hermes_start_lxt980 (int speed);
306 #endif
307 
308 #ifdef CONFIG_EVB64260
309 void  evb64260_init(void);
310 void  debug_led(int, int);
311 void  display_mem_map(void);
312 void  perform_soft_reset(void);
313 #endif
314 
315 void	load_sernum_ethaddr (void);
316 
317 /* $(BOARD)/$(BOARD).c */
318 int board_early_init_f (void);
319 int board_late_init (void);
320 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
321 int board_early_init_r (void);
322 void board_poweroff (void);
323 
324 #if defined(CFG_DRAM_TEST)
325 int testdram(void);
326 #endif /* CFG_DRAM_TEST */
327 
328 /* $(CPU)/start.S */
329 #if defined(CONFIG_5xx) || \
330     defined(CONFIG_8xx)
331 uint	get_immr      (uint);
332 #endif
333 uint	get_pir	      (void);
334 #if defined(CONFIG_MPC5xxx)
335 uint	get_svr       (void);
336 #endif
337 uint	get_pvr	      (void);
338 uint	get_svr	      (void);
339 uint	rd_ic_cst     (void);
340 void	wr_ic_cst     (uint);
341 void	wr_ic_adr     (uint);
342 uint	rd_dc_cst     (void);
343 void	wr_dc_cst     (uint);
344 void	wr_dc_adr     (uint);
345 int	icache_status (void);
346 void	icache_enable (void);
347 void	icache_disable(void);
348 int	dcache_status (void);
349 void	dcache_enable (void);
350 void	dcache_disable(void);
351 void	relocate_code (ulong, gd_t *, ulong);
352 ulong	get_endaddr   (void);
353 void	trap_init     (ulong);
354 #if defined (CONFIG_4xx)	|| \
355     defined (CONFIG_MPC5xxx)	|| \
356     defined (CONFIG_74xx_7xx)	|| \
357     defined (CONFIG_74x)	|| \
358     defined (CONFIG_75x)	|| \
359     defined (CONFIG_74xx)	|| \
360     defined (CONFIG_MPC8220)	|| \
361     defined(CONFIG_MPC85xx)
362 unsigned char	in8(unsigned int);
363 void		out8(unsigned int, unsigned char);
364 unsigned short	in16(unsigned int);
365 unsigned short	in16r(unsigned int);
366 void		out16(unsigned int, unsigned short value);
367 void		out16r(unsigned int, unsigned short value);
368 unsigned long	in32(unsigned int);
369 unsigned long	in32r(unsigned int);
370 void		out32(unsigned int, unsigned long value);
371 void		out32r(unsigned int, unsigned long value);
372 void		ppcDcbf(unsigned long value);
373 void		ppcDcbi(unsigned long value);
374 void		ppcSync(void);
375 void		ppcDcbz(unsigned long value);
376 #endif
377 
378 /* $(CPU)/cpu.c */
379 int	checkcpu      (void);
380 int	checkicache   (void);
381 int	checkdcache   (void);
382 void	upmconfig     (unsigned int, unsigned int *, unsigned int);
383 ulong	get_tbclk     (void);
384 
385 /* $(CPU)/serial.c */
386 int	serial_init   (void);
387 void	serial_setbrg (void);
388 void	serial_putc   (const char);
389 void	serial_puts   (const char *);
390 void	serial_addr   (unsigned int);
391 int	serial_getc   (void);
392 int	serial_tstc   (void);
393 
394 /* $(CPU)/speed.c */
395 int	get_clocks (void);
396 int	get_clocks_866 (void);
397 int	sdram_adjust_866 (void);
398 int	adjust_sdram_tbs_8xx (void);
399 #if defined(CONFIG_8260)
400 int	prt_8260_clks (void);
401 #endif
402 #if defined(CONFIG_MPC5xxx)
403 int	prt_mpc5xxx_clks (void);
404 #endif
405 #if defined(CONFIG_MPC8220)
406 int	prt_mpc8220_clks (void);
407 #endif
408 #ifdef CONFIG_4xx
409 ulong	get_OPB_freq (void);
410 ulong	get_PCI_freq (void);
411 #endif
412 #if defined(CONFIG_S3C2400) || defined(CONFIG_S3C2410) || defined(CONFIG_LH7A40X)
413 ulong	get_FCLK (void);
414 ulong	get_HCLK (void);
415 ulong	get_PCLK (void);
416 ulong	get_UCLK (void);
417 #endif
418 #if defined(CONFIG_LH7A40X)
419 ulong	get_PLLCLK (void);
420 #endif
421 #if defined CONFIG_INCA_IP
422 uint	incaip_get_cpuclk (void);
423 #endif
424 #if defined(CONFIG_IMX)
425 ulong get_systemPLLCLK(void);
426 ulong get_FCLK(void);
427 ulong get_HCLK(void);
428 ulong get_BCLK(void);
429 ulong get_PERCLK1(void);
430 ulong get_PERCLK2(void);
431 ulong get_PERCLK3(void);
432 #endif
433 ulong	get_bus_freq  (ulong);
434 
435 #if defined(CONFIG_MPC85xx)
436 typedef MPC85xx_SYS_INFO sys_info_t;
437 void	get_sys_info  ( sys_info_t * );
438 #endif
439 
440 #if defined(CONFIG_4xx) || defined(CONFIG_IOP480)
441 #  if defined(CONFIG_440)
442     typedef PPC440_SYS_INFO sys_info_t;
443 #  else
444     typedef PPC405_SYS_INFO sys_info_t;
445 #  endif
446 void	get_sys_info  ( sys_info_t * );
447 #endif
448 
449 /* $(CPU)/cpu_init.c */
450 #if defined(CONFIG_8xx) || defined(CONFIG_8260)
451 void	cpu_init_f    (volatile immap_t *immr);
452 #endif
453 #if defined(CONFIG_4xx) || defined(CONFIG_MPC85xx) || defined(CONFIG_MCF52x2)
454 void	cpu_init_f    (void);
455 #endif
456 
457 int	cpu_init_r    (void);
458 #if defined(CONFIG_8260)
459 int	prt_8260_rsr  (void);
460 #endif
461 
462 /* $(CPU)/interrupts.c */
463 int	interrupt_init	   (void);
464 void	timer_interrupt	   (struct pt_regs *);
465 void	external_interrupt (struct pt_regs *);
466 void	irq_install_handler(int, interrupt_handler_t *, void *);
467 void	irq_free_handler   (int);
468 void	reset_timer	   (void);
469 ulong	get_timer	   (ulong base);
470 void	set_timer	   (ulong t);
471 void	enable_interrupts  (void);
472 int	disable_interrupts (void);
473 
474 /* $(CPU)/.../commproc.c */
475 int	dpram_init (void);
476 uint	dpram_base(void);
477 uint	dpram_base_align(uint align);
478 uint	dpram_alloc(uint size);
479 uint	dpram_alloc_align(uint size,uint align);
480 void	post_word_store (ulong);
481 ulong	post_word_load (void);
482 void	bootcount_store (ulong);
483 ulong	bootcount_load (void);
484 #define BOOTCOUNT_MAGIC		0xB001C041
485 
486 /* $(CPU)/.../<eth> */
487 void mii_init (void);
488 
489 /* $(CPU)/.../lcd.c */
490 ulong	lcd_setmem (ulong);
491 
492 /* $(CPU)/.../vfd.c */
493 ulong	vfd_setmem (ulong);
494 
495 /* $(CPU)/.../video.c */
496 ulong	video_setmem (ulong);
497 
498 /* lib_$(ARCH)/cache.c */
499 void	flush_cache   (unsigned long, unsigned long);
500 
501 
502 /* lib_$(ARCH)/ticks.S */
503 unsigned long long get_ticks(void);
504 void	wait_ticks    (unsigned long);
505 
506 /* lib_$(ARCH)/time.c */
507 void	udelay	      (unsigned long);
508 ulong	usec2ticks    (unsigned long usec);
509 ulong	ticks2usec    (unsigned long ticks);
510 int	init_timebase (void);
511 
512 /* lib_generic/vsprintf.c */
513 ulong	simple_strtoul(const char *cp,char **endp,unsigned int base);
514 #ifdef CFG_64BIT_VSPRINTF
515 unsigned long long	simple_strtoull(const char *cp,char **endp,unsigned int base);
516 #endif
517 long	simple_strtol(const char *cp,char **endp,unsigned int base);
518 void	panic(const char *fmt, ...);
519 int	sprintf(char * buf, const char *fmt, ...);
520 int	vsprintf(char *buf, const char *fmt, va_list args);
521 
522 /* lib_generic/crc32.c */
523 ulong crc32 (ulong, const unsigned char *, uint);
524 ulong crc32_no_comp (ulong, const unsigned char *, uint);
525 
526 /* common/console.c */
527 int	console_init_f(void);	/* Before relocation; uses the serial  stuff	*/
528 int	console_init_r(void);	/* After  relocation; uses the console stuff	*/
529 int	console_assign (int file, char *devname);	/* Assign the console	*/
530 int	ctrlc (void);
531 int	had_ctrlc (void);	/* have we had a Control-C since last clear? */
532 void	clear_ctrlc (void);	/* clear the Control-C condition */
533 int	disable_ctrlc (int);	/* 1 to disable, 0 to enable Control-C detect */
534 
535 /*
536  * STDIO based functions (can always be used)
537  */
538 
539 /* serial stuff */
540 void	serial_printf (const char *fmt, ...);
541 
542 /* stdin */
543 int	getc(void);
544 int	tstc(void);
545 
546 /* stdout */
547 void	putc(const char c);
548 void	puts(const char *s);
549 void	printf(const char *fmt, ...);
550 void	vprintf(const char *fmt, va_list args);
551 
552 /* stderr */
553 #define eputc(c)		fputc(stderr, c)
554 #define eputs(s)		fputs(stderr, s)
555 #define eprintf(fmt,args...)	fprintf(stderr,fmt ,##args)
556 
557 /*
558  * FILE based functions (can only be used AFTER relocation!)
559  */
560 
561 #define stdin		0
562 #define stdout		1
563 #define stderr		2
564 #define MAX_FILES	3
565 
566 void	fprintf(int file, const char *fmt, ...);
567 void	fputs(int file, const char *s);
568 void	fputc(int file, const char c);
569 int	ftstc(int file);
570 int	fgetc(int file);
571 
572 int	pcmcia_init (void);
573 
574 #ifdef CONFIG_SHOW_BOOT_PROGRESS
575 void	show_boot_progress (int status);
576 #endif
577 
578 #endif	/* __COMMON_H_ */
579