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