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