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