xref: /openbmc/u-boot/include/common.h (revision 86bedaeb)
1 /*
2  * (C) Copyright 2000-2009
3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4  *
5  * SPDX-License-Identifier:	GPL-2.0+
6  */
7 
8 #ifndef __COMMON_H_
9 #define __COMMON_H_	1
10 
11 #ifndef __ASSEMBLY__		/* put C only stuff in this section */
12 
13 typedef unsigned char		uchar;
14 typedef volatile unsigned long	vu_long;
15 typedef volatile unsigned short vu_short;
16 typedef volatile unsigned char	vu_char;
17 
18 #include <config.h>
19 #include <asm-offsets.h>
20 #include <linux/bitops.h>
21 #include <linux/types.h>
22 #include <linux/string.h>
23 #include <linux/stringify.h>
24 #include <asm/ptrace.h>
25 #include <stdarg.h>
26 #include <linux/kernel.h>
27 #if defined(CONFIG_PCI) && defined(CONFIG_4xx)
28 #include <pci.h>
29 #endif
30 #if defined(CONFIG_8xx)
31 #include <asm/8xx_immap.h>
32 #if defined(CONFIG_MPC859)	|| defined(CONFIG_MPC859T)	|| \
33     defined(CONFIG_MPC866)	|| \
34     defined(CONFIG_MPC866P)
35 # define CONFIG_MPC866_FAMILY 1
36 #elif defined(CONFIG_MPC885)
37 # define CONFIG_MPC885_FAMILY   1
38 #endif
39 #if   defined(CONFIG_MPC860)	   \
40    || defined(CONFIG_MPC860T)	   \
41    || defined(CONFIG_MPC866_FAMILY) \
42    || defined(CONFIG_MPC885_FAMILY)
43 # define CONFIG_MPC86x 1
44 #endif
45 #elif defined(CONFIG_5xx)
46 #include <asm/5xx_immap.h>
47 #elif defined(CONFIG_MPC5xxx)
48 #include <mpc5xxx.h>
49 #elif defined(CONFIG_MPC512X)
50 #include <asm/immap_512x.h>
51 #elif defined(CONFIG_MPC8260)
52 #if   defined(CONFIG_MPC8247) \
53    || defined(CONFIG_MPC8272)
54 #define CONFIG_MPC8272_FAMILY	1
55 #endif
56 #include <asm/immap_8260.h>
57 #endif
58 #ifdef CONFIG_MPC86xx
59 #include <mpc86xx.h>
60 #include <asm/immap_86xx.h>
61 #endif
62 #ifdef CONFIG_MPC85xx
63 #include <mpc85xx.h>
64 #include <asm/immap_85xx.h>
65 #endif
66 #ifdef CONFIG_MPC83xx
67 #include <mpc83xx.h>
68 #include <asm/immap_83xx.h>
69 #endif
70 #ifdef	CONFIG_4xx
71 #include <asm/ppc4xx.h>
72 #endif
73 #ifdef CONFIG_BLACKFIN
74 #include <asm/blackfin.h>
75 #endif
76 #ifdef CONFIG_SOC_DA8XX
77 #include <asm/arch/hardware.h>
78 #endif
79 
80 #include <part.h>
81 #include <flash.h>
82 #include <image.h>
83 
84 /* Bring in printf format macros if inttypes.h is included */
85 #define __STDC_FORMAT_MACROS
86 
87 #ifdef __LP64__
88 #define CONFIG_SYS_SUPPORT_64BIT_DATA
89 #endif
90 
91 #ifdef DEBUG
92 #define _DEBUG	1
93 #else
94 #define _DEBUG	0
95 #endif
96 
97 #ifndef pr_fmt
98 #define pr_fmt(fmt) fmt
99 #endif
100 
101 /*
102  * Output a debug text when condition "cond" is met. The "cond" should be
103  * computed by a preprocessor in the best case, allowing for the best
104  * optimization.
105  */
106 #define debug_cond(cond, fmt, args...)			\
107 	do {						\
108 		if (cond)				\
109 			printf(pr_fmt(fmt), ##args);	\
110 	} while (0)
111 
112 #define debug(fmt, args...)			\
113 	debug_cond(_DEBUG, fmt, ##args)
114 
115 /*
116  * An assertion is run-time check done in debug mode only. If DEBUG is not
117  * defined then it is skipped. If DEBUG is defined and the assertion fails,
118  * then it calls panic*( which may or may not reset/halt U-Boot (see
119  * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
120  * before release, and after release it is hoped that they don't matter. But
121  * in any case these failing assertions cannot be fixed with a reset (which
122  * may just do the same assertion again).
123  */
124 void __assert_fail(const char *assertion, const char *file, unsigned line,
125 		   const char *function);
126 #define assert(x) \
127 	({ if (!(x) && _DEBUG) \
128 		__assert_fail(#x, __FILE__, __LINE__, __func__); })
129 
130 #define error(fmt, args...) do {					\
131 		printf("ERROR: " pr_fmt(fmt) "\nat %s:%d/%s()\n",	\
132 			##args, __FILE__, __LINE__, __func__);		\
133 } while (0)
134 
135 #ifndef BUG
136 #define BUG() do { \
137 	printf("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __FUNCTION__); \
138 	panic("BUG!"); \
139 } while (0)
140 #define BUG_ON(condition) do { if (unlikely((condition)!=0)) BUG(); } while(0)
141 #endif /* BUG */
142 
143 /* Force a compilation error if condition is true */
144 #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
145 
146 typedef void (interrupt_handler_t)(void *);
147 
148 #include <asm/u-boot.h> /* boot information for Linux kernel */
149 #include <asm/global_data.h>	/* global data used for startup functions */
150 
151 /*
152  * enable common handling for all TQM8xxL/M boards:
153  * - CONFIG_TQM8xxM will be defined for all TQM8xxM boards
154  * - CONFIG_TQM8xxL will be defined for all TQM8xxL _and_ TQM8xxM boards
155  *                  and for the TQM885D board
156  */
157 #if defined(CONFIG_TQM823M) || defined(CONFIG_TQM850M) || \
158     defined(CONFIG_TQM855M) || defined(CONFIG_TQM860M) || \
159     defined(CONFIG_TQM862M) || defined(CONFIG_TQM866M)
160 # ifndef CONFIG_TQM8xxM
161 #  define CONFIG_TQM8xxM
162 # endif
163 #endif
164 #if defined(CONFIG_TQM823L) || defined(CONFIG_TQM850L) || \
165     defined(CONFIG_TQM855L) || defined(CONFIG_TQM860L) || \
166     defined(CONFIG_TQM862L) || defined(CONFIG_TQM8xxM) || \
167     defined(CONFIG_TQM885D)
168 # ifndef CONFIG_TQM8xxL
169 #  define CONFIG_TQM8xxL
170 # endif
171 #endif
172 
173 #if defined(CONFIG_ENV_IS_EMBEDDED)
174 #define TOTAL_MALLOC_LEN	CONFIG_SYS_MALLOC_LEN
175 #elif ( ((CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) < CONFIG_SYS_MONITOR_BASE) || \
176 	(CONFIG_ENV_ADDR >= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) ) || \
177       defined(CONFIG_ENV_IS_IN_NVRAM)
178 #define	TOTAL_MALLOC_LEN	(CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
179 #else
180 #define	TOTAL_MALLOC_LEN	CONFIG_SYS_MALLOC_LEN
181 #endif
182 
183 /*
184  * Function Prototypes
185  */
186 int dram_init(void);
187 
188 void	hang		(void) __attribute__ ((noreturn));
189 
190 int	timer_init(void);
191 int	cpu_init(void);
192 
193 /* */
194 phys_size_t initdram (int);
195 int	display_options (void);
196 
197 /**
198  * print_size() - Print a size with a suffic
199  *
200  * print sizes as "xxx KiB", "xxx.y KiB", "xxx MiB", "xxx.y MiB",
201  * xxx GiB, xxx.y GiB, etc as needed; allow for optional trailing string
202  * (like "\n")
203  *
204  * @size:	Size to print
205  * @suffix	String to print after the size
206  */
207 void print_size(uint64_t size, const char *suffix);
208 
209 int print_buffer(ulong addr, const void *data, uint width, uint count,
210 		 uint linelen);
211 
212 /* common/main.c */
213 void	main_loop	(void);
214 int run_command(const char *cmd, int flag);
215 int run_command_repeatable(const char *cmd, int flag);
216 
217 /**
218  * Run a list of commands separated by ; or even \0
219  *
220  * Note that if 'len' is not -1, then the command does not need to be nul
221  * terminated, Memory will be allocated for the command in that case.
222  *
223  * @param cmd	List of commands to run, each separated bu semicolon
224  * @param len	Length of commands excluding terminator if known (-1 if not)
225  * @param flag	Execution flags (CMD_FLAG_...)
226  * @return 0 on success, or != 0 on error.
227  */
228 int run_command_list(const char *cmd, int len, int flag);
229 extern char console_buffer[];
230 
231 /* arch/$(ARCH)/lib/board.c */
232 void board_init_f(ulong);
233 void board_init_r(gd_t *, ulong) __attribute__ ((noreturn));
234 int checkboard(void);
235 int show_board_info(void);
236 int checkflash(void);
237 int checkdram(void);
238 int last_stage_init(void);
239 extern ulong monitor_flash_len;
240 int mac_read_from_eeprom(void);
241 extern u8 __dtb_dt_begin[];	/* embedded device tree blob */
242 int set_cpu_clk_info(void);
243 int mdm_init(void);
244 #if defined(CONFIG_DISPLAY_CPUINFO)
245 int print_cpuinfo(void);
246 #else
247 static inline int print_cpuinfo(void)
248 {
249 	return 0;
250 }
251 #endif
252 int update_flash_size(int flash_size);
253 int arch_early_init_r(void);
254 
255 /**
256  * Show the DRAM size in a board-specific way
257  *
258  * This is used by boards to display DRAM information in their own way.
259  *
260  * @param size	Size of DRAM (which should be displayed along with other info)
261  */
262 void board_show_dram(ulong size);
263 
264 /**
265  * arch_fixup_fdt() - Write arch-specific information to fdt
266  *
267  * Defined in arch/$(ARCH)/lib/bootm-fdt.c
268  *
269  * @blob:	FDT blob to write to
270  * @return 0 if ok, or -ve FDT_ERR_... on failure
271  */
272 int arch_fixup_fdt(void *blob);
273 
274 /* common/flash.c */
275 void flash_perror (int);
276 
277 /* common/cmd_source.c */
278 int	source (ulong addr, const char *fit_uname);
279 
280 extern ulong load_addr;		/* Default Load Address */
281 extern ulong save_addr;		/* Default Save Address */
282 extern ulong save_size;		/* Default Save Size */
283 
284 /* common/cmd_doc.c */
285 void	doc_probe(unsigned long physadr);
286 
287 /* common/cmd_net.c */
288 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
289 
290 /* common/cmd_fat.c */
291 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
292 
293 /* common/cmd_ext2.c */
294 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
295 
296 /* common/cmd_nvedit.c */
297 int	env_init     (void);
298 void	env_relocate (void);
299 int	envmatch     (uchar *, int);
300 
301 /* Avoid unfortunate conflict with libc's getenv() */
302 #ifdef CONFIG_SANDBOX
303 #define getenv uboot_getenv
304 #endif
305 char	*getenv	     (const char *);
306 int	getenv_f     (const char *name, char *buf, unsigned len);
307 ulong getenv_ulong(const char *name, int base, ulong default_val);
308 
309 /**
310  * getenv_hex() - Return an environment variable as a hex value
311  *
312  * Decode an environment as a hex number (it may or may not have a 0x
313  * prefix). If the environment variable cannot be found, or does not start
314  * with hex digits, the default value is returned.
315  *
316  * @varname:		Variable to decode
317  * @default_val:	Value to return on error
318  */
319 ulong getenv_hex(const char *varname, ulong default_val);
320 
321 /*
322  * Read an environment variable as a boolean
323  * Return -1 if variable does not exist (default to true)
324  */
325 int getenv_yesno(const char *var);
326 int	saveenv	     (void);
327 int	setenv	     (const char *, const char *);
328 int setenv_ulong(const char *varname, ulong value);
329 int setenv_hex(const char *varname, ulong value);
330 /**
331  * setenv_addr - Set an environment variable to an address in hex
332  *
333  * @varname:	Environment variable to set
334  * @addr:	Value to set it to
335  * @return 0 if ok, 1 on error
336  */
337 static inline int setenv_addr(const char *varname, const void *addr)
338 {
339 	return setenv_hex(varname, (ulong)addr);
340 }
341 
342 #ifdef CONFIG_ARM
343 # include <asm/mach-types.h>
344 # include <asm/setup.h>
345 # include <asm/u-boot-arm.h>	/* ARM version to be fixed! */
346 #endif /* CONFIG_ARM */
347 #ifdef CONFIG_X86		/* x86 version to be fixed! */
348 # include <asm/u-boot-x86.h>
349 #endif /* CONFIG_X86 */
350 #ifdef CONFIG_SANDBOX
351 # include <asm/u-boot-sandbox.h>	/* TODO(sjg) what needs to be fixed? */
352 #endif
353 #ifdef CONFIG_NDS32
354 # include <asm/mach-types.h>
355 # include <asm/setup.h>
356 # include <asm/u-boot-nds32.h>
357 #endif /* CONFIG_NDS32 */
358 #ifdef CONFIG_MIPS
359 # include <asm/u-boot-mips.h>
360 #endif /* CONFIG_MIPS */
361 #ifdef CONFIG_ARC
362 # include <asm/u-boot-arc.h>
363 #endif /* CONFIG_ARC */
364 
365 #ifdef CONFIG_AUTO_COMPLETE
366 int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
367 #endif
368 int get_env_id (void);
369 
370 void	pci_init      (void);
371 void	pci_init_board(void);
372 void	pciinfo	      (int, int);
373 
374 #if defined(CONFIG_PCI) && defined(CONFIG_4xx)
375     int	   pci_pre_init	       (struct pci_controller *);
376     int	   is_pci_host	       (struct pci_controller *);
377 #endif
378 
379 #if defined(CONFIG_PCI) && (defined(CONFIG_440) || defined(CONFIG_405EX))
380 #   if defined(CONFIG_SYS_PCI_TARGET_INIT)
381 	void	pci_target_init	     (struct pci_controller *);
382 #   endif
383 #   if defined(CONFIG_SYS_PCI_MASTER_INIT)
384 	void	pci_master_init	     (struct pci_controller *);
385 #   endif
386 #if defined(CONFIG_440SPE) || \
387     defined(CONFIG_460EX) || defined(CONFIG_460GT) || \
388     defined(CONFIG_405EX)
389    void pcie_setup_hoses(int busno);
390 #endif
391 #endif
392 
393 int	misc_init_f   (void);
394 int	misc_init_r   (void);
395 
396 /* common/exports.c */
397 void	jumptable_init(void);
398 
399 /* common/kallsysm.c */
400 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
401 
402 /* api/api.c */
403 void	api_init (void);
404 
405 /* common/memsize.c */
406 long	get_ram_size  (long *, long);
407 phys_size_t get_effective_memsize(void);
408 
409 /* $(BOARD)/$(BOARD).c */
410 void	reset_phy     (void);
411 void	fdc_hw_init   (void);
412 
413 /* $(BOARD)/eeprom.c */
414 void eeprom_init  (void);
415 #ifndef CONFIG_SPI
416 int  eeprom_probe (unsigned dev_addr, unsigned offset);
417 #endif
418 int  eeprom_read  (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
419 int  eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
420 
421 /*
422  * Set this up regardless of board
423  * type, to prevent errors.
424  */
425 #if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
426 # define CONFIG_SYS_DEF_EEPROM_ADDR 0
427 #else
428 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
429 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
430 #endif
431 #endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
432 
433 #if defined(CONFIG_SPI)
434 extern void spi_init_f (void);
435 extern void spi_init_r (void);
436 extern ssize_t spi_read	 (uchar *, int, uchar *, int);
437 extern ssize_t spi_write (uchar *, int, uchar *, int);
438 #endif
439 
440 /* $(BOARD)/$(BOARD).c */
441 int board_early_init_f (void);
442 int board_late_init (void);
443 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
444 int board_early_init_r (void);
445 void board_poweroff (void);
446 
447 #if defined(CONFIG_SYS_DRAM_TEST)
448 int testdram(void);
449 #endif /* CONFIG_SYS_DRAM_TEST */
450 
451 /* $(CPU)/start.S */
452 #if defined(CONFIG_5xx) || \
453     defined(CONFIG_8xx)
454 uint	get_immr      (uint);
455 #endif
456 uint	get_pir	      (void);
457 #if defined(CONFIG_MPC5xxx)
458 uint	get_svr       (void);
459 #endif
460 uint	get_pvr	      (void);
461 uint	get_svr	      (void);
462 uint	rd_ic_cst     (void);
463 void	wr_ic_cst     (uint);
464 void	wr_ic_adr     (uint);
465 uint	rd_dc_cst     (void);
466 void	wr_dc_cst     (uint);
467 void	wr_dc_adr     (uint);
468 int	icache_status (void);
469 void	icache_enable (void);
470 void	icache_disable(void);
471 int	dcache_status (void);
472 void	dcache_enable (void);
473 void	dcache_disable(void);
474 void	mmu_disable(void);
475 #if defined(CONFIG_ARM)
476 void	relocate_code(ulong);
477 #else
478 void	relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
479 #endif
480 ulong	get_endaddr   (void);
481 void	trap_init     (ulong);
482 #if defined (CONFIG_4xx)	|| \
483     defined (CONFIG_MPC5xxx)	|| \
484     defined (CONFIG_MPC85xx)	|| \
485     defined (CONFIG_MPC86xx)	|| \
486     defined (CONFIG_MPC83xx)
487 unsigned char	in8(unsigned int);
488 void		out8(unsigned int, unsigned char);
489 unsigned short	in16(unsigned int);
490 unsigned short	in16r(unsigned int);
491 void		out16(unsigned int, unsigned short value);
492 void		out16r(unsigned int, unsigned short value);
493 unsigned long	in32(unsigned int);
494 unsigned long	in32r(unsigned int);
495 void		out32(unsigned int, unsigned long value);
496 void		out32r(unsigned int, unsigned long value);
497 void		ppcDcbf(unsigned long value);
498 void		ppcDcbi(unsigned long value);
499 void		ppcSync(void);
500 void		ppcDcbz(unsigned long value);
501 #endif
502 #if defined (CONFIG_MICROBLAZE)
503 unsigned short	in16(unsigned int);
504 void		out16(unsigned int, unsigned short value);
505 #endif
506 
507 #if defined (CONFIG_MPC83xx)
508 void		ppcDWload(unsigned int *addr, unsigned int *ret);
509 void		ppcDWstore(unsigned int *addr, unsigned int *value);
510 void disable_addr_trans(void);
511 void enable_addr_trans(void);
512 #if defined(CONFIG_DDR_ECC) && !defined(CONFIG_ECC_INIT_VIA_DDRCONTROLLER)
513 void ddr_enable_ecc(unsigned int dram_size);
514 #endif
515 #endif
516 
517 /*
518  * Return the current value of a monotonically increasing microsecond timer.
519  * Granularity may be larger than 1us if hardware does not support this.
520  */
521 ulong timer_get_us(void);
522 
523 /* $(CPU)/cpu.c */
524 static inline int cpumask_next(int cpu, unsigned int mask)
525 {
526 	for (cpu++; !((1 << cpu) & mask); cpu++)
527 		;
528 
529 	return cpu;
530 }
531 
532 #define for_each_cpu(iter, cpu, num_cpus, mask) \
533 	for (iter = 0, cpu = cpumask_next(-1, mask); \
534 		iter < num_cpus; \
535 		iter++, cpu = cpumask_next(cpu, mask)) \
536 
537 int	cpu_numcores  (void);
538 u32	cpu_mask      (void);
539 int	is_core_valid (unsigned int);
540 int	probecpu      (void);
541 int	checkcpu      (void);
542 int	checkicache   (void);
543 int	checkdcache   (void);
544 void	upmconfig     (unsigned int, unsigned int *, unsigned int);
545 ulong	get_tbclk     (void);
546 void	reset_misc    (void);
547 void	reset_cpu     (ulong addr);
548 #if defined (CONFIG_OF_LIBFDT) && defined (CONFIG_OF_BOARD_SETUP)
549 void ft_cpu_setup(void *blob, bd_t *bd);
550 #ifdef CONFIG_PCI
551 void ft_pci_setup(void *blob, bd_t *bd);
552 #endif
553 #endif
554 
555 void smp_set_core_boot_addr(unsigned long addr, int corenr);
556 void smp_kick_all_cpus(void);
557 
558 /* $(CPU)/serial.c */
559 int	serial_init   (void);
560 void	serial_setbrg (void);
561 void	serial_putc   (const char);
562 void	serial_putc_raw(const char);
563 void	serial_puts   (const char *);
564 int	serial_getc   (void);
565 int	serial_tstc   (void);
566 
567 /* These versions take a stdio_dev pointer */
568 struct stdio_dev;
569 int serial_stub_getc(struct stdio_dev *sdev);
570 int serial_stub_tstc(struct stdio_dev *sdev);
571 
572 /* $(CPU)/speed.c */
573 int	get_clocks (void);
574 int	get_clocks_866 (void);
575 int	sdram_adjust_866 (void);
576 int	adjust_sdram_tbs_8xx (void);
577 #if defined(CONFIG_MPC8260)
578 int	prt_8260_clks (void);
579 #elif defined(CONFIG_MPC5xxx)
580 int	prt_mpc5xxx_clks (void);
581 #endif
582 #ifdef CONFIG_4xx
583 ulong	get_OPB_freq (void);
584 ulong	get_PCI_freq (void);
585 #endif
586 #if defined(CONFIG_S3C24X0) || \
587     defined(CONFIG_LH7A40X) || \
588     defined(CONFIG_EP93XX)
589 ulong	get_FCLK (void);
590 ulong	get_HCLK (void);
591 ulong	get_PCLK (void);
592 ulong	get_UCLK (void);
593 #endif
594 #if defined(CONFIG_LH7A40X)
595 ulong	get_PLLCLK (void);
596 #endif
597 #if defined(CONFIG_IMX)
598 ulong get_systemPLLCLK(void);
599 ulong get_FCLK(void);
600 ulong get_HCLK(void);
601 ulong get_BCLK(void);
602 ulong get_PERCLK1(void);
603 ulong get_PERCLK2(void);
604 ulong get_PERCLK3(void);
605 #endif
606 ulong	get_bus_freq  (ulong);
607 int get_serial_clock(void);
608 
609 #if defined(CONFIG_MPC85xx)
610 typedef MPC85xx_SYS_INFO sys_info_t;
611 void	get_sys_info  ( sys_info_t * );
612 #  if defined(CONFIG_OF_LIBFDT)
613 	void ft_fixup_cpu(void *, u64);
614 	void ft_fixup_num_cores(void *);
615 #  endif
616 #endif
617 #if defined(CONFIG_MPC86xx)
618 typedef MPC86xx_SYS_INFO sys_info_t;
619 void   get_sys_info  ( sys_info_t * );
620 static inline ulong get_ddr_freq(ulong dummy)
621 {
622 	return get_bus_freq(dummy);
623 }
624 #else
625 ulong get_ddr_freq(ulong);
626 #endif
627 
628 #if defined(CONFIG_4xx)
629 #  if defined(CONFIG_440)
630 #	if defined(CONFIG_440SPE)
631 	 unsigned long determine_sysper(void);
632 	 unsigned long determine_pci_clock_per(void);
633 #	endif
634 #  endif
635 typedef PPC4xx_SYS_INFO sys_info_t;
636 int	ppc440spe_revB(void);
637 void	get_sys_info  ( sys_info_t * );
638 #endif
639 
640 /* $(CPU)/cpu_init.c */
641 #if defined(CONFIG_8xx) || defined(CONFIG_MPC8260)
642 void	cpu_init_f    (volatile immap_t *immr);
643 #endif
644 #if defined(CONFIG_4xx) || defined(CONFIG_MCF52x2) || defined(CONFIG_MPC86xx)
645 void	cpu_init_f    (void);
646 #endif
647 #ifdef CONFIG_MPC85xx
648 ulong cpu_init_f(void);
649 #endif
650 
651 int	cpu_init_r    (void);
652 #if defined(CONFIG_MPC8260)
653 int	prt_8260_rsr  (void);
654 #elif defined(CONFIG_MPC83xx)
655 int	prt_83xx_rsr  (void);
656 #endif
657 
658 /* $(CPU)/interrupts.c */
659 int	interrupt_init	   (void);
660 void	timer_interrupt	   (struct pt_regs *);
661 void	external_interrupt (struct pt_regs *);
662 void	irq_install_handler(int, interrupt_handler_t *, void *);
663 void	irq_free_handler   (int);
664 void	reset_timer	   (void);
665 ulong	get_timer	   (ulong base);
666 
667 /* Return value of monotonic microsecond timer */
668 unsigned long timer_get_us(void);
669 
670 void	enable_interrupts  (void);
671 int	disable_interrupts (void);
672 
673 /* $(CPU)/.../commproc.c */
674 int	dpram_init (void);
675 uint	dpram_base(void);
676 uint	dpram_base_align(uint align);
677 uint	dpram_alloc(uint size);
678 uint	dpram_alloc_align(uint size,uint align);
679 void	bootcount_store (ulong);
680 ulong	bootcount_load (void);
681 #define BOOTCOUNT_MAGIC		0xB001C041
682 
683 /* $(CPU)/.../<eth> */
684 void mii_init (void);
685 
686 /* $(CPU)/.../lcd.c */
687 ulong	lcd_setmem (ulong);
688 
689 /* $(CPU)/.../video.c */
690 ulong	video_setmem (ulong);
691 
692 /* arch/$(ARCH)/lib/cache.c */
693 void	enable_caches(void);
694 void	flush_cache   (unsigned long, unsigned long);
695 void	flush_dcache_all(void);
696 void	flush_dcache_range(unsigned long start, unsigned long stop);
697 void	invalidate_dcache_range(unsigned long start, unsigned long stop);
698 void	invalidate_dcache_all(void);
699 void	invalidate_icache_all(void);
700 
701 /* arch/$(ARCH)/lib/ticks.S */
702 uint64_t get_ticks(void);
703 void	wait_ticks    (unsigned long);
704 
705 /* arch/$(ARCH)/lib/time.c */
706 void	__udelay      (unsigned long);
707 ulong	usec2ticks    (unsigned long usec);
708 ulong	ticks2usec    (unsigned long ticks);
709 int	init_timebase (void);
710 
711 /* lib/gunzip.c */
712 int gunzip(void *, int, unsigned char *, unsigned long *);
713 int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
714 						int stoponerr, int offset);
715 
716 /* lib/qsort.c */
717 void qsort(void *base, size_t nmemb, size_t size,
718 	   int(*compar)(const void *, const void *));
719 int strcmp_compar(const void *, const void *);
720 
721 /* lib/time.c */
722 void	udelay        (unsigned long);
723 void mdelay(unsigned long);
724 
725 /* lib/uuid.c */
726 #include <uuid.h>
727 
728 /* lib/vsprintf.c */
729 #include <vsprintf.h>
730 
731 /* lib/strmhz.c */
732 char *	strmhz(char *buf, unsigned long hz);
733 
734 /* lib/crc32.c */
735 #include <u-boot/crc.h>
736 
737 /* lib/rand.c */
738 #define RAND_MAX -1U
739 void srand(unsigned int seed);
740 unsigned int rand(void);
741 unsigned int rand_r(unsigned int *seedp);
742 
743 /* common/console.c */
744 int	console_init_f(void);	/* Before relocation; uses the serial  stuff	*/
745 int	console_init_r(void);	/* After  relocation; uses the console stuff	*/
746 int	console_assign(int file, const char *devname);	/* Assign the console	*/
747 int	ctrlc (void);
748 int	had_ctrlc (void);	/* have we had a Control-C since last clear? */
749 void	clear_ctrlc (void);	/* clear the Control-C condition */
750 int	disable_ctrlc (int);	/* 1 to disable, 0 to enable Control-C detect */
751 int confirm_yesno(void);        /*  1 if input is "y", "Y", "yes" or "YES" */
752 /*
753  * STDIO based functions (can always be used)
754  */
755 /* serial stuff */
756 int	serial_printf (const char *fmt, ...)
757 		__attribute__ ((format (__printf__, 1, 2)));
758 /* stdin */
759 int	getc(void);
760 int	tstc(void);
761 
762 /* stdout */
763 void	putc(const char c);
764 void	puts(const char *s);
765 int	printf(const char *fmt, ...)
766 		__attribute__ ((format (__printf__, 1, 2)));
767 int	vprintf(const char *fmt, va_list args);
768 
769 /* stderr */
770 #define eputc(c)		fputc(stderr, c)
771 #define eputs(s)		fputs(stderr, s)
772 #define eprintf(fmt,args...)	fprintf(stderr,fmt ,##args)
773 
774 /*
775  * FILE based functions (can only be used AFTER relocation!)
776  */
777 #define stdin		0
778 #define stdout		1
779 #define stderr		2
780 #define MAX_FILES	3
781 
782 int	fprintf(int file, const char *fmt, ...)
783 		__attribute__ ((format (__printf__, 2, 3)));
784 void	fputs(int file, const char *s);
785 void	fputc(int file, const char c);
786 int	ftstc(int file);
787 int	fgetc(int file);
788 
789 /* lib/gzip.c */
790 int gzip(void *dst, unsigned long *lenp,
791 		unsigned char *src, unsigned long srclen);
792 int zzip(void *dst, unsigned long *lenp, unsigned char *src,
793 		unsigned long srclen, int stoponerr,
794 		int (*func)(unsigned long, unsigned long));
795 
796 /* lib/net_utils.c */
797 #include <net.h>
798 static inline IPaddr_t getenv_IPaddr(char *var)
799 {
800 	return string_to_ip(getenv(var));
801 }
802 
803 /*
804  * CONSOLE multiplexing.
805  */
806 #ifdef CONFIG_CONSOLE_MUX
807 #include <iomux.h>
808 #endif
809 
810 int	pcmcia_init (void);
811 
812 #ifdef CONFIG_STATUS_LED
813 # include <status_led.h>
814 #endif
815 
816 #include <bootstage.h>
817 
818 #ifdef CONFIG_SHOW_ACTIVITY
819 void show_activity(int arg);
820 #endif
821 
822 /* Multicore arch functions */
823 #ifdef CONFIG_MP
824 int cpu_status(int nr);
825 int cpu_reset(int nr);
826 int cpu_disable(int nr);
827 int cpu_release(int nr, int argc, char * const argv[]);
828 #endif
829 
830 /* Define a null map_sysmem() if the architecture doesn't use it */
831 # ifndef CONFIG_ARCH_MAP_SYSMEM
832 static inline void *map_sysmem(phys_addr_t paddr, unsigned long len)
833 {
834 	return (void *)(uintptr_t)paddr;
835 }
836 
837 static inline void unmap_sysmem(const void *vaddr)
838 {
839 }
840 
841 static inline phys_addr_t map_to_sysmem(const void *ptr)
842 {
843 	return (phys_addr_t)(uintptr_t)ptr;
844 }
845 # endif
846 
847 #endif /* __ASSEMBLY__ */
848 
849 #ifdef CONFIG_PPC
850 /*
851  * Has to be included outside of the #ifndef __ASSEMBLY__ section.
852  * Otherwise might lead to compilation errors in assembler files.
853  */
854 #include <asm/cache.h>
855 #endif
856 
857 /* Put only stuff here that the assembler can digest */
858 
859 #ifdef CONFIG_POST
860 #define CONFIG_HAS_POST
861 #ifndef CONFIG_POST_ALT_LIST
862 #define CONFIG_POST_STD_LIST
863 #endif
864 #endif
865 
866 #ifdef CONFIG_INIT_CRITICAL
867 #error CONFIG_INIT_CRITICAL is deprecated!
868 #error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
869 #endif
870 
871 #define ROUND(a,b)		(((a) + (b) - 1) & ~((b) - 1))
872 
873 /*
874  * ARCH_DMA_MINALIGN is defined in asm/cache.h for each architecture.  It
875  * is used to align DMA buffers.
876  */
877 #ifndef __ASSEMBLY__
878 #include <asm/cache.h>
879 #endif
880 
881 /*
882  * The ALLOC_CACHE_ALIGN_BUFFER macro is used to allocate a buffer on the
883  * stack that meets the minimum architecture alignment requirements for DMA.
884  * Such a buffer is useful for DMA operations where flushing and invalidating
885  * the cache before and after a read and/or write operation is required for
886  * correct operations.
887  *
888  * When called the macro creates an array on the stack that is sized such
889  * that:
890  *
891  * 1) The beginning of the array can be advanced enough to be aligned.
892  *
893  * 2) The size of the aligned portion of the array is a multiple of the minimum
894  *    architecture alignment required for DMA.
895  *
896  * 3) The aligned portion contains enough space for the original number of
897  *    elements requested.
898  *
899  * The macro then creates a pointer to the aligned portion of this array and
900  * assigns to the pointer the address of the first element in the aligned
901  * portion of the array.
902  *
903  * Calling the macro as:
904  *
905  *     ALLOC_CACHE_ALIGN_BUFFER(uint32_t, buffer, 1024);
906  *
907  * Will result in something similar to saying:
908  *
909  *     uint32_t    buffer[1024];
910  *
911  * The following differences exist:
912  *
913  * 1) The resulting buffer is guaranteed to be aligned to the value of
914  *    ARCH_DMA_MINALIGN.
915  *
916  * 2) The buffer variable created by the macro is a pointer to the specified
917  *    type, and NOT an array of the specified type.  This can be very important
918  *    if you want the address of the buffer, which you probably do, to pass it
919  *    to the DMA hardware.  The value of &buffer is different in the two cases.
920  *    In the macro case it will be the address of the pointer, not the address
921  *    of the space reserved for the buffer.  However, in the second case it
922  *    would be the address of the buffer.  So if you are replacing hard coded
923  *    stack buffers with this macro you need to make sure you remove the & from
924  *    the locations where you are taking the address of the buffer.
925  *
926  * Note that the size parameter is the number of array elements to allocate,
927  * not the number of bytes.
928  *
929  * This macro can not be used outside of function scope, or for the creation
930  * of a function scoped static buffer.  It can not be used to create a cache
931  * line aligned global buffer.
932  */
933 #define PAD_COUNT(s, pad) (((s) - 1) / (pad) + 1)
934 #define PAD_SIZE(s, pad) (PAD_COUNT(s, pad) * pad)
935 #define ALLOC_ALIGN_BUFFER_PAD(type, name, size, align, pad)		\
936 	char __##name[ROUND(PAD_SIZE((size) * sizeof(type), pad), align)  \
937 		      + (align - 1)];					\
938 									\
939 	type *name = (type *) ALIGN((uintptr_t)__##name, align)
940 #define ALLOC_ALIGN_BUFFER(type, name, size, align)		\
941 	ALLOC_ALIGN_BUFFER_PAD(type, name, size, align, 1)
942 #define ALLOC_CACHE_ALIGN_BUFFER_PAD(type, name, size, pad)		\
943 	ALLOC_ALIGN_BUFFER_PAD(type, name, size, ARCH_DMA_MINALIGN, pad)
944 #define ALLOC_CACHE_ALIGN_BUFFER(type, name, size)			\
945 	ALLOC_ALIGN_BUFFER(type, name, size, ARCH_DMA_MINALIGN)
946 
947 /*
948  * DEFINE_CACHE_ALIGN_BUFFER() is similar to ALLOC_CACHE_ALIGN_BUFFER, but it's
949  * purpose is to allow allocating aligned buffers outside of function scope.
950  * Usage of this macro shall be avoided or used with extreme care!
951  */
952 #define DEFINE_ALIGN_BUFFER(type, name, size, align)			\
953 	static char __##name[ALIGN(size * sizeof(type), align)]	\
954 			__aligned(align);				\
955 									\
956 	static type *name = (type *)__##name
957 #define DEFINE_CACHE_ALIGN_BUFFER(type, name, size)			\
958 	DEFINE_ALIGN_BUFFER(type, name, size, ARCH_DMA_MINALIGN)
959 
960 /* Pull in stuff for the build system */
961 #ifdef DO_DEPS_ONLY
962 # include <environment.h>
963 #endif
964 
965 #endif	/* __COMMON_H_ */
966