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