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