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