xref: /rk3399_rockchip-uboot/include/common.h (revision 281f69ede28cd3d8be5d62a96b5a0b73e6065858)
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 #endif
256 
257 int	misc_init_f   (void);
258 int	misc_init_r   (void);
259 
260 /* common/exports.c */
261 void	jumptable_init(void);
262 
263 /* common/memsize.c */
264 int	get_ram_size  (volatile long *, long);
265 
266 /* $(BOARD)/$(BOARD).c */
267 void	reset_phy     (void);
268 void	fdc_hw_init   (void);
269 
270 /* $(BOARD)/eeprom.c */
271 void eeprom_init  (void);
272 #ifndef CONFIG_SPI
273 int  eeprom_probe (unsigned dev_addr, unsigned offset);
274 #endif
275 int  eeprom_read  (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
276 int  eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
277 #ifdef CONFIG_LWMON
278 extern uchar pic_read  (uchar reg);
279 extern void  pic_write (uchar reg, uchar val);
280 #endif
281 
282 /*
283  * Set this up regardless of board
284  * type, to prevent errors.
285  */
286 #if defined(CONFIG_SPI) || !defined(CFG_I2C_EEPROM_ADDR)
287 # define CFG_DEF_EEPROM_ADDR 0
288 #else
289 # define CFG_DEF_EEPROM_ADDR CFG_I2C_EEPROM_ADDR
290 #endif /* CONFIG_SPI || !defined(CFG_I2C_EEPROM_ADDR) */
291 
292 #if defined(CONFIG_SPI)
293 extern void spi_init_f (void);
294 extern void spi_init_r (void);
295 extern ssize_t spi_read	 (uchar *, int, uchar *, int);
296 extern ssize_t spi_write (uchar *, int, uchar *, int);
297 #endif
298 
299 #ifdef CONFIG_RPXCLASSIC
300 void rpxclassic_init (void);
301 #endif
302 
303 void rpxlite_init (void);
304 
305 #ifdef CONFIG_MBX
306 /* $(BOARD)/mbx8xx.c */
307 void	mbx_init (void);
308 void	board_serial_init (void);
309 void	board_ether_init (void);
310 #endif
311 
312 #if defined(CONFIG_RPXCLASSIC)	|| defined(CONFIG_MBX) || \
313     defined(CONFIG_IAD210)	|| defined(CONFIG_XPEDITE1K) || \
314     defined(CONFIG_METROBOX)    || defined(CONFIG_KAREF)
315 void	board_get_enetaddr (uchar *addr);
316 #endif
317 
318 #ifdef CONFIG_HERMES
319 /* $(BOARD)/hermes.c */
320 void hermes_start_lxt980 (int speed);
321 #endif
322 
323 #ifdef CONFIG_EVB64260
324 void  evb64260_init(void);
325 void  debug_led(int, int);
326 void  display_mem_map(void);
327 void  perform_soft_reset(void);
328 #endif
329 
330 void	load_sernum_ethaddr (void);
331 
332 /* $(BOARD)/$(BOARD).c */
333 int board_early_init_f (void);
334 int board_late_init (void);
335 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
336 int board_early_init_r (void);
337 void board_poweroff (void);
338 
339 #if defined(CFG_DRAM_TEST)
340 int testdram(void);
341 #endif /* CFG_DRAM_TEST */
342 
343 /* $(CPU)/start.S */
344 #if defined(CONFIG_5xx) || \
345     defined(CONFIG_8xx)
346 uint	get_immr      (uint);
347 #endif
348 uint	get_pir	      (void);
349 #if defined(CONFIG_MPC5xxx)
350 uint	get_svr       (void);
351 #endif
352 uint	get_pvr	      (void);
353 uint	get_svr	      (void);
354 uint	rd_ic_cst     (void);
355 void	wr_ic_cst     (uint);
356 void	wr_ic_adr     (uint);
357 uint	rd_dc_cst     (void);
358 void	wr_dc_cst     (uint);
359 void	wr_dc_adr     (uint);
360 int	icache_status (void);
361 void	icache_enable (void);
362 void	icache_disable(void);
363 int	dcache_status (void);
364 void	dcache_enable (void);
365 void	dcache_disable(void);
366 void	relocate_code (ulong, gd_t *, ulong);
367 ulong	get_endaddr   (void);
368 void	trap_init     (ulong);
369 #if defined (CONFIG_4xx)	|| \
370     defined (CONFIG_MPC5xxx)	|| \
371     defined (CONFIG_74xx_7xx)	|| \
372     defined (CONFIG_74x)	|| \
373     defined (CONFIG_75x)	|| \
374     defined (CONFIG_74xx)	|| \
375     defined (CONFIG_MPC8220)	|| \
376     defined (CONFIG_MPC85xx)	|| \
377     defined (CONFIG_MPC86xx)	|| \
378     defined (CONFIG_MPC83XX)
379 unsigned char	in8(unsigned int);
380 void		out8(unsigned int, unsigned char);
381 unsigned short	in16(unsigned int);
382 unsigned short	in16r(unsigned int);
383 void		out16(unsigned int, unsigned short value);
384 void		out16r(unsigned int, unsigned short value);
385 unsigned long	in32(unsigned int);
386 unsigned long	in32r(unsigned int);
387 void		out32(unsigned int, unsigned long value);
388 void		out32r(unsigned int, unsigned long value);
389 void		ppcDcbf(unsigned long value);
390 void		ppcDcbi(unsigned long value);
391 void		ppcSync(void);
392 void		ppcDcbz(unsigned long value);
393 #endif
394 
395 /* $(CPU)/cpu.c */
396 int	checkcpu      (void);
397 int	checkicache   (void);
398 int	checkdcache   (void);
399 void	upmconfig     (unsigned int, unsigned int *, unsigned int);
400 ulong	get_tbclk     (void);
401 void	reset_cpu     (ulong addr);
402 
403 /* $(CPU)/serial.c */
404 int	serial_init   (void);
405 void	serial_addr   (unsigned int);
406 void	serial_setbrg (void);
407 void	serial_putc   (const char);
408 void	serial_putc_raw(const char);
409 void	serial_puts   (const char *);
410 int	serial_getc   (void);
411 int	serial_tstc   (void);
412 
413 void	_serial_setbrg (const int);
414 void	_serial_putc   (const char, const int);
415 void	_serial_putc_raw(const char, const int);
416 void	_serial_puts   (const char *, const int);
417 int	_serial_getc   (const int);
418 int	_serial_tstc   (const int);
419 
420 /* $(CPU)/speed.c */
421 int	get_clocks (void);
422 int	get_clocks_866 (void);
423 int	sdram_adjust_866 (void);
424 int	adjust_sdram_tbs_8xx (void);
425 #if defined(CONFIG_8260)
426 int	prt_8260_clks (void);
427 #elif defined(CONFIG_MPC83XX)
428 int print_clock_conf(void);
429 #elif defined(CONFIG_MPC5xxx)
430 int	prt_mpc5xxx_clks (void);
431 #endif
432 #if defined(CONFIG_MPC8220)
433 int	prt_mpc8220_clks (void);
434 #endif
435 #ifdef CONFIG_4xx
436 ulong	get_OPB_freq (void);
437 ulong	get_PCI_freq (void);
438 #endif
439 #if defined(CONFIG_S3C2400) || defined(CONFIG_S3C2410) || defined(CONFIG_LH7A40X)
440 ulong	get_FCLK (void);
441 ulong	get_HCLK (void);
442 ulong	get_PCLK (void);
443 ulong	get_UCLK (void);
444 #endif
445 #if defined(CONFIG_LH7A40X)
446 ulong	get_PLLCLK (void);
447 #endif
448 #if defined CONFIG_INCA_IP
449 uint	incaip_get_cpuclk (void);
450 #endif
451 #if defined(CONFIG_IMX)
452 ulong get_systemPLLCLK(void);
453 ulong get_FCLK(void);
454 ulong get_HCLK(void);
455 ulong get_BCLK(void);
456 ulong get_PERCLK1(void);
457 ulong get_PERCLK2(void);
458 ulong get_PERCLK3(void);
459 #endif
460 ulong	get_bus_freq  (ulong);
461 
462 #if defined(CONFIG_MPC85xx)
463 typedef MPC85xx_SYS_INFO sys_info_t;
464 void	get_sys_info  ( sys_info_t * );
465 #endif
466 #if defined(CONFIG_MPC86xx)
467 typedef MPC86xx_SYS_INFO sys_info_t;
468 void   get_sys_info  ( sys_info_t * );
469 #endif
470 
471 #if defined(CONFIG_4xx) || defined(CONFIG_IOP480)
472 #  if defined(CONFIG_440)
473     typedef PPC440_SYS_INFO sys_info_t;
474 #	if defined(CONFIG_440SPE)
475 	 unsigned long determine_sysper(void);
476 	 unsigned long determine_pci_clock_per(void);
477 #	endif
478 #  else
479     typedef PPC405_SYS_INFO sys_info_t;
480 #  endif
481 void	get_sys_info  ( sys_info_t * );
482 #endif
483 
484 /* $(CPU)/cpu_init.c */
485 #if defined(CONFIG_8xx) || defined(CONFIG_8260)
486 void	cpu_init_f    (volatile immap_t *immr);
487 #endif
488 #if defined(CONFIG_4xx) || defined(CONFIG_MPC85xx) || defined(CONFIG_MCF52x2) ||defined(CONFIG_MPC86xx)
489 void	cpu_init_f    (void);
490 #endif
491 
492 int	cpu_init_r    (void);
493 #if defined(CONFIG_8260)
494 int	prt_8260_rsr  (void);
495 #endif
496 
497 /* $(CPU)/interrupts.c */
498 int	interrupt_init	   (void);
499 void	timer_interrupt	   (struct pt_regs *);
500 void	external_interrupt (struct pt_regs *);
501 void	irq_install_handler(int, interrupt_handler_t *, void *);
502 void	irq_free_handler   (int);
503 void	reset_timer	   (void);
504 ulong	get_timer	   (ulong base);
505 void	set_timer	   (ulong t);
506 void	enable_interrupts  (void);
507 int	disable_interrupts (void);
508 
509 /* $(CPU)/.../commproc.c */
510 int	dpram_init (void);
511 uint	dpram_base(void);
512 uint	dpram_base_align(uint align);
513 uint	dpram_alloc(uint size);
514 uint	dpram_alloc_align(uint size,uint align);
515 void	post_word_store (ulong);
516 ulong	post_word_load (void);
517 void	bootcount_store (ulong);
518 ulong	bootcount_load (void);
519 #define BOOTCOUNT_MAGIC		0xB001C041
520 
521 /* $(CPU)/.../<eth> */
522 void mii_init (void);
523 
524 /* $(CPU)/.../lcd.c */
525 ulong	lcd_setmem (ulong);
526 
527 /* $(CPU)/.../vfd.c */
528 ulong	vfd_setmem (ulong);
529 
530 /* $(CPU)/.../video.c */
531 ulong	video_setmem (ulong);
532 
533 /* lib_$(ARCH)/cache.c */
534 void	flush_cache   (unsigned long, unsigned long);
535 
536 
537 /* lib_$(ARCH)/ticks.S */
538 unsigned long long get_ticks(void);
539 void	wait_ticks    (unsigned long);
540 
541 /* lib_$(ARCH)/time.c */
542 void	udelay	      (unsigned long);
543 ulong	usec2ticks    (unsigned long usec);
544 ulong	ticks2usec    (unsigned long ticks);
545 int	init_timebase (void);
546 
547 /* lib_generic/vsprintf.c */
548 ulong	simple_strtoul(const char *cp,char **endp,unsigned int base);
549 #ifdef CFG_64BIT_VSPRINTF
550 unsigned long long	simple_strtoull(const char *cp,char **endp,unsigned int base);
551 #endif
552 long	simple_strtol(const char *cp,char **endp,unsigned int base);
553 void	panic(const char *fmt, ...);
554 int	sprintf(char * buf, const char *fmt, ...);
555 int	vsprintf(char *buf, const char *fmt, va_list args);
556 
557 /* lib_generic/crc32.c */
558 ulong crc32 (ulong, const unsigned char *, uint);
559 ulong crc32_no_comp (ulong, const unsigned char *, uint);
560 
561 /* common/console.c */
562 int	console_init_f(void);	/* Before relocation; uses the serial  stuff	*/
563 int	console_init_r(void);	/* After  relocation; uses the console stuff	*/
564 int	console_assign (int file, char *devname);	/* Assign the console	*/
565 int	ctrlc (void);
566 int	had_ctrlc (void);	/* have we had a Control-C since last clear? */
567 void	clear_ctrlc (void);	/* clear the Control-C condition */
568 int	disable_ctrlc (int);	/* 1 to disable, 0 to enable Control-C detect */
569 
570 /*
571  * STDIO based functions (can always be used)
572  */
573 
574 /* serial stuff */
575 void	serial_printf (const char *fmt, ...);
576 
577 /* stdin */
578 int	getc(void);
579 int	tstc(void);
580 
581 /* stdout */
582 void	putc(const char c);
583 void	puts(const char *s);
584 void	printf(const char *fmt, ...);
585 void	vprintf(const char *fmt, va_list args);
586 
587 /* stderr */
588 #define eputc(c)		fputc(stderr, c)
589 #define eputs(s)		fputs(stderr, s)
590 #define eprintf(fmt,args...)	fprintf(stderr,fmt ,##args)
591 
592 /*
593  * FILE based functions (can only be used AFTER relocation!)
594  */
595 
596 #define stdin		0
597 #define stdout		1
598 #define stderr		2
599 #define MAX_FILES	3
600 
601 void	fprintf(int file, const char *fmt, ...);
602 void	fputs(int file, const char *s);
603 void	fputc(int file, const char c);
604 int	ftstc(int file);
605 int	fgetc(int file);
606 
607 int	pcmcia_init (void);
608 
609 #ifdef CONFIG_SHOW_BOOT_PROGRESS
610 void	show_boot_progress (int status);
611 #endif
612 
613 #ifdef CONFIG_INIT_CRITICAL
614 #error CONFIG_INIT_CRITICAL is depracted!
615 #error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
616 #endif
617 
618 #endif	/* __COMMON_H_ */
619