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