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