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