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