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