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