xref: /openbmc/u-boot/include/common.h (revision 412ae53a)
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 
80 #include <part.h>
81 #include <flash.h>
82 #include <image.h>
83 
84 /* Bring in printf format macros if inttypes.h is included */
85 #define __STDC_FORMAT_MACROS
86 
87 #ifdef __LP64__
88 #define CONFIG_SYS_SUPPORT_64BIT_DATA
89 #endif
90 
91 #ifdef DEBUG
92 #define _DEBUG	1
93 #else
94 #define _DEBUG	0
95 #endif
96 
97 #ifndef pr_fmt
98 #define pr_fmt(fmt) fmt
99 #endif
100 
101 /*
102  * Output a debug text when condition "cond" is met. The "cond" should be
103  * computed by a preprocessor in the best case, allowing for the best
104  * optimization.
105  */
106 #define debug_cond(cond, fmt, args...)			\
107 	do {						\
108 		if (cond)				\
109 			printf(pr_fmt(fmt), ##args);	\
110 	} while (0)
111 
112 #define debug(fmt, args...)			\
113 	debug_cond(_DEBUG, fmt, ##args)
114 
115 /*
116  * An assertion is run-time check done in debug mode only. If DEBUG is not
117  * defined then it is skipped. If DEBUG is defined and the assertion fails,
118  * then it calls panic*( which may or may not reset/halt U-Boot (see
119  * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
120  * before release, and after release it is hoped that they don't matter. But
121  * in any case these failing assertions cannot be fixed with a reset (which
122  * may just do the same assertion again).
123  */
124 void __assert_fail(const char *assertion, const char *file, unsigned line,
125 		   const char *function);
126 #define assert(x) \
127 	({ if (!(x) && _DEBUG) \
128 		__assert_fail(#x, __FILE__, __LINE__, __func__); })
129 
130 #define error(fmt, args...) do {					\
131 		printf("ERROR: " pr_fmt(fmt) "\nat %s:%d/%s()\n",	\
132 			##args, __FILE__, __LINE__, __func__);		\
133 } while (0)
134 
135 #ifndef BUG
136 #define BUG() do { \
137 	printf("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __FUNCTION__); \
138 	panic("BUG!"); \
139 } while (0)
140 #define BUG_ON(condition) do { if (unlikely((condition)!=0)) BUG(); } while(0)
141 #endif /* BUG */
142 
143 /* Force a compilation error if condition is true */
144 #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
145 
146 typedef void (interrupt_handler_t)(void *);
147 
148 #include <asm/u-boot.h> /* boot information for Linux kernel */
149 #include <asm/global_data.h>	/* global data used for startup functions */
150 
151 /*
152  * enable common handling for all TQM8xxL/M boards:
153  * - CONFIG_TQM8xxM will be defined for all TQM8xxM boards
154  * - CONFIG_TQM8xxL will be defined for all TQM8xxL _and_ TQM8xxM boards
155  *                  and for the TQM885D board
156  */
157 #if defined(CONFIG_TQM823M) || defined(CONFIG_TQM850M) || \
158     defined(CONFIG_TQM855M) || defined(CONFIG_TQM860M) || \
159     defined(CONFIG_TQM862M) || defined(CONFIG_TQM866M)
160 # ifndef CONFIG_TQM8xxM
161 #  define CONFIG_TQM8xxM
162 # endif
163 #endif
164 #if defined(CONFIG_TQM823L) || defined(CONFIG_TQM850L) || \
165     defined(CONFIG_TQM855L) || defined(CONFIG_TQM860L) || \
166     defined(CONFIG_TQM862L) || defined(CONFIG_TQM8xxM) || \
167     defined(CONFIG_TQM885D)
168 # ifndef CONFIG_TQM8xxL
169 #  define CONFIG_TQM8xxL
170 # endif
171 #endif
172 
173 #if defined(CONFIG_ENV_IS_EMBEDDED)
174 #define TOTAL_MALLOC_LEN	CONFIG_SYS_MALLOC_LEN
175 #elif ( ((CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) < CONFIG_SYS_MONITOR_BASE) || \
176 	(CONFIG_ENV_ADDR >= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) ) || \
177       defined(CONFIG_ENV_IS_IN_NVRAM)
178 #define	TOTAL_MALLOC_LEN	(CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
179 #else
180 #define	TOTAL_MALLOC_LEN	CONFIG_SYS_MALLOC_LEN
181 #endif
182 
183 /*
184  * Function Prototypes
185  */
186 int dram_init(void);
187 
188 void	hang		(void) __attribute__ ((noreturn));
189 
190 int	timer_init(void);
191 int	cpu_init(void);
192 
193 /* */
194 phys_size_t initdram (int);
195 int	display_options (void);
196 
197 /**
198  * print_size() - Print a size with a suffic
199  *
200  * print sizes as "xxx KiB", "xxx.y KiB", "xxx MiB", "xxx.y MiB",
201  * xxx GiB, xxx.y GiB, etc as needed; allow for optional trailing string
202  * (like "\n")
203  *
204  * @size:	Size to print
205  * @suffix	String to print after the size
206  */
207 void print_size(uint64_t size, const char *suffix);
208 
209 int print_buffer(ulong addr, const void *data, uint width, uint count,
210 		 uint linelen);
211 
212 /* common/main.c */
213 void	main_loop	(void);
214 int run_command(const char *cmd, int flag);
215 int run_command_repeatable(const char *cmd, int flag);
216 
217 /**
218  * Run a list of commands separated by ; or even \0
219  *
220  * Note that if 'len' is not -1, then the command does not need to be nul
221  * terminated, Memory will be allocated for the command in that case.
222  *
223  * @param cmd	List of commands to run, each separated bu semicolon
224  * @param len	Length of commands excluding terminator if known (-1 if not)
225  * @param flag	Execution flags (CMD_FLAG_...)
226  * @return 0 on success, or != 0 on error.
227  */
228 int run_command_list(const char *cmd, int len, int flag);
229 extern char console_buffer[];
230 
231 /* arch/$(ARCH)/lib/board.c */
232 void board_init_f(ulong);
233 void board_init_r(gd_t *, ulong) __attribute__ ((noreturn));
234 int checkboard(void);
235 int show_board_info(void);
236 int checkflash(void);
237 int checkdram(void);
238 int last_stage_init(void);
239 extern ulong monitor_flash_len;
240 int mac_read_from_eeprom(void);
241 extern u8 __dtb_dt_begin[];	/* embedded device tree blob */
242 int set_cpu_clk_info(void);
243 int mdm_init(void);
244 #if defined(CONFIG_DISPLAY_CPUINFO)
245 int print_cpuinfo(void);
246 #else
247 static inline int print_cpuinfo(void)
248 {
249 	return 0;
250 }
251 #endif
252 int update_flash_size(int flash_size);
253 int arch_early_init_r(void);
254 
255 /**
256  * Reserve all necessary stacks
257  *
258  * This is used in generic board init sequence in common/board_f.c. Each
259  * architecture could provide this function to tailor the required stacks.
260  *
261  * On entry gd->start_addr_sp is pointing to the suggested top of the stack.
262  * The callee ensures gd->start_add_sp is 16-byte aligned, so architectures
263  * require only this can leave it untouched.
264  *
265  * On exit gd->start_addr_sp and gd->irq_sp should be set to the respective
266  * positions of the stack. The stack pointer(s) will be set to this later.
267  * gd->irq_sp is only required, if the architecture needs it.
268  *
269  * @return 0 if no error
270  */
271 __weak int arch_reserve_stacks(void);
272 
273 /**
274  * Show the DRAM size in a board-specific way
275  *
276  * This is used by boards to display DRAM information in their own way.
277  *
278  * @param size	Size of DRAM (which should be displayed along with other info)
279  */
280 void board_show_dram(ulong size);
281 
282 /**
283  * arch_fixup_fdt() - Write arch-specific information to fdt
284  *
285  * Defined in arch/$(ARCH)/lib/bootm-fdt.c
286  *
287  * @blob:	FDT blob to write to
288  * @return 0 if ok, or -ve FDT_ERR_... on failure
289  */
290 int arch_fixup_fdt(void *blob);
291 
292 /* common/flash.c */
293 void flash_perror (int);
294 
295 /* common/cmd_source.c */
296 int	source (ulong addr, const char *fit_uname);
297 
298 extern ulong load_addr;		/* Default Load Address */
299 extern ulong save_addr;		/* Default Save Address */
300 extern ulong save_size;		/* Default Save Size */
301 
302 /* common/cmd_doc.c */
303 void	doc_probe(unsigned long physadr);
304 
305 /* common/cmd_net.c */
306 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
307 
308 /* common/cmd_fat.c */
309 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
310 
311 /* common/cmd_ext2.c */
312 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
313 
314 /* common/cmd_nvedit.c */
315 int	env_init     (void);
316 void	env_relocate (void);
317 int	envmatch     (uchar *, int);
318 
319 /* Avoid unfortunate conflict with libc's getenv() */
320 #ifdef CONFIG_SANDBOX
321 #define getenv uboot_getenv
322 #endif
323 char	*getenv	     (const char *);
324 int	getenv_f     (const char *name, char *buf, unsigned len);
325 ulong getenv_ulong(const char *name, int base, ulong default_val);
326 
327 /**
328  * getenv_hex() - Return an environment variable as a hex value
329  *
330  * Decode an environment as a hex number (it may or may not have a 0x
331  * prefix). If the environment variable cannot be found, or does not start
332  * with hex digits, the default value is returned.
333  *
334  * @varname:		Variable to decode
335  * @default_val:	Value to return on error
336  */
337 ulong getenv_hex(const char *varname, ulong default_val);
338 
339 /*
340  * Read an environment variable as a boolean
341  * Return -1 if variable does not exist (default to true)
342  */
343 int getenv_yesno(const char *var);
344 int	saveenv	     (void);
345 int	setenv	     (const char *, const char *);
346 int setenv_ulong(const char *varname, ulong value);
347 int setenv_hex(const char *varname, ulong value);
348 /**
349  * setenv_addr - Set an environment variable to an address in hex
350  *
351  * @varname:	Environment variable to set
352  * @addr:	Value to set it to
353  * @return 0 if ok, 1 on error
354  */
355 static inline int setenv_addr(const char *varname, const void *addr)
356 {
357 	return setenv_hex(varname, (ulong)addr);
358 }
359 
360 #ifdef CONFIG_ARM
361 # include <asm/mach-types.h>
362 # include <asm/setup.h>
363 # include <asm/u-boot-arm.h>	/* ARM version to be fixed! */
364 #endif /* CONFIG_ARM */
365 #ifdef CONFIG_X86		/* x86 version to be fixed! */
366 # include <asm/u-boot-x86.h>
367 #endif /* CONFIG_X86 */
368 #ifdef CONFIG_SANDBOX
369 # include <asm/u-boot-sandbox.h>	/* TODO(sjg) what needs to be fixed? */
370 #endif
371 #ifdef CONFIG_NDS32
372 # include <asm/mach-types.h>
373 # include <asm/setup.h>
374 # include <asm/u-boot-nds32.h>
375 #endif /* CONFIG_NDS32 */
376 #ifdef CONFIG_MIPS
377 # include <asm/u-boot-mips.h>
378 #endif /* CONFIG_MIPS */
379 #ifdef CONFIG_ARC
380 # include <asm/u-boot-arc.h>
381 #endif /* CONFIG_ARC */
382 
383 #ifdef CONFIG_AUTO_COMPLETE
384 int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
385 #endif
386 int get_env_id (void);
387 
388 void	pci_init      (void);
389 void	pci_init_board(void);
390 void	pciinfo	      (int, int);
391 
392 #if defined(CONFIG_PCI) && defined(CONFIG_4xx)
393     int	   pci_pre_init	       (struct pci_controller *);
394     int	   is_pci_host	       (struct pci_controller *);
395 #endif
396 
397 #if defined(CONFIG_PCI) && (defined(CONFIG_440) || defined(CONFIG_405EX))
398 #   if defined(CONFIG_SYS_PCI_TARGET_INIT)
399 	void	pci_target_init	     (struct pci_controller *);
400 #   endif
401 #   if defined(CONFIG_SYS_PCI_MASTER_INIT)
402 	void	pci_master_init	     (struct pci_controller *);
403 #   endif
404 #if defined(CONFIG_440SPE) || \
405     defined(CONFIG_460EX) || defined(CONFIG_460GT) || \
406     defined(CONFIG_405EX)
407    void pcie_setup_hoses(int busno);
408 #endif
409 #endif
410 
411 int	misc_init_f   (void);
412 int	misc_init_r   (void);
413 
414 /* common/exports.c */
415 void	jumptable_init(void);
416 
417 /* common/kallsysm.c */
418 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
419 
420 /* api/api.c */
421 void	api_init (void);
422 
423 /* common/memsize.c */
424 long	get_ram_size  (long *, long);
425 phys_size_t get_effective_memsize(void);
426 
427 /* $(BOARD)/$(BOARD).c */
428 void	reset_phy     (void);
429 void	fdc_hw_init   (void);
430 
431 /* $(BOARD)/eeprom.c */
432 void eeprom_init  (void);
433 #ifndef CONFIG_SPI
434 int  eeprom_probe (unsigned dev_addr, unsigned offset);
435 #endif
436 int  eeprom_read  (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
437 int  eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
438 
439 /*
440  * Set this up regardless of board
441  * type, to prevent errors.
442  */
443 #if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
444 # define CONFIG_SYS_DEF_EEPROM_ADDR 0
445 #else
446 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
447 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
448 #endif
449 #endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
450 
451 #if defined(CONFIG_SPI)
452 extern void spi_init_f (void);
453 extern void spi_init_r (void);
454 extern ssize_t spi_read	 (uchar *, int, uchar *, int);
455 extern ssize_t spi_write (uchar *, int, uchar *, int);
456 #endif
457 
458 /* $(BOARD)/$(BOARD).c */
459 int board_early_init_f (void);
460 int board_late_init (void);
461 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
462 int board_early_init_r (void);
463 void board_poweroff (void);
464 
465 #if defined(CONFIG_SYS_DRAM_TEST)
466 int testdram(void);
467 #endif /* CONFIG_SYS_DRAM_TEST */
468 
469 /* $(CPU)/start.S */
470 #if defined(CONFIG_5xx) || \
471     defined(CONFIG_8xx)
472 uint	get_immr      (uint);
473 #endif
474 uint	get_pir	      (void);
475 #if defined(CONFIG_MPC5xxx)
476 uint	get_svr       (void);
477 #endif
478 uint	get_pvr	      (void);
479 uint	get_svr	      (void);
480 uint	rd_ic_cst     (void);
481 void	wr_ic_cst     (uint);
482 void	wr_ic_adr     (uint);
483 uint	rd_dc_cst     (void);
484 void	wr_dc_cst     (uint);
485 void	wr_dc_adr     (uint);
486 int	icache_status (void);
487 void	icache_enable (void);
488 void	icache_disable(void);
489 int	dcache_status (void);
490 void	dcache_enable (void);
491 void	dcache_disable(void);
492 void	mmu_disable(void);
493 #if defined(CONFIG_ARM)
494 void	relocate_code(ulong);
495 #else
496 void	relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
497 #endif
498 ulong	get_endaddr   (void);
499 void	trap_init     (ulong);
500 #if defined (CONFIG_4xx)	|| \
501     defined (CONFIG_MPC5xxx)	|| \
502     defined (CONFIG_MPC85xx)	|| \
503     defined (CONFIG_MPC86xx)	|| \
504     defined (CONFIG_MPC83xx)
505 unsigned char	in8(unsigned int);
506 void		out8(unsigned int, unsigned char);
507 unsigned short	in16(unsigned int);
508 unsigned short	in16r(unsigned int);
509 void		out16(unsigned int, unsigned short value);
510 void		out16r(unsigned int, unsigned short value);
511 unsigned long	in32(unsigned int);
512 unsigned long	in32r(unsigned int);
513 void		out32(unsigned int, unsigned long value);
514 void		out32r(unsigned int, unsigned long value);
515 void		ppcDcbf(unsigned long value);
516 void		ppcDcbi(unsigned long value);
517 void		ppcSync(void);
518 void		ppcDcbz(unsigned long value);
519 #endif
520 #if defined (CONFIG_MICROBLAZE)
521 unsigned short	in16(unsigned int);
522 void		out16(unsigned int, unsigned short value);
523 #endif
524 
525 #if defined (CONFIG_MPC83xx)
526 void		ppcDWload(unsigned int *addr, unsigned int *ret);
527 void		ppcDWstore(unsigned int *addr, unsigned int *value);
528 void disable_addr_trans(void);
529 void enable_addr_trans(void);
530 #if defined(CONFIG_DDR_ECC) && !defined(CONFIG_ECC_INIT_VIA_DDRCONTROLLER)
531 void ddr_enable_ecc(unsigned int dram_size);
532 #endif
533 #endif
534 
535 /*
536  * Return the current value of a monotonically increasing microsecond timer.
537  * Granularity may be larger than 1us if hardware does not support this.
538  */
539 ulong timer_get_us(void);
540 
541 /* $(CPU)/cpu.c */
542 static inline int cpumask_next(int cpu, unsigned int mask)
543 {
544 	for (cpu++; !((1 << cpu) & mask); cpu++)
545 		;
546 
547 	return cpu;
548 }
549 
550 #define for_each_cpu(iter, cpu, num_cpus, mask) \
551 	for (iter = 0, cpu = cpumask_next(-1, mask); \
552 		iter < num_cpus; \
553 		iter++, cpu = cpumask_next(cpu, mask)) \
554 
555 int	cpu_numcores  (void);
556 int	cpu_num_dspcores(void);
557 u32	cpu_mask      (void);
558 u32	cpu_dsp_mask(void);
559 int	is_core_valid (unsigned int);
560 int	probecpu      (void);
561 int	checkcpu      (void);
562 int	checkicache   (void);
563 int	checkdcache   (void);
564 void	upmconfig     (unsigned int, unsigned int *, unsigned int);
565 ulong	get_tbclk     (void);
566 void	reset_misc    (void);
567 void	reset_cpu     (ulong addr);
568 #if defined (CONFIG_OF_LIBFDT) && defined (CONFIG_OF_BOARD_SETUP)
569 void ft_cpu_setup(void *blob, bd_t *bd);
570 #ifdef CONFIG_PCI
571 void ft_pci_setup(void *blob, bd_t *bd);
572 #endif
573 #endif
574 
575 void smp_set_core_boot_addr(unsigned long addr, int corenr);
576 void smp_kick_all_cpus(void);
577 
578 /* $(CPU)/serial.c */
579 int	serial_init   (void);
580 void	serial_setbrg (void);
581 void	serial_putc   (const char);
582 void	serial_putc_raw(const char);
583 void	serial_puts   (const char *);
584 int	serial_getc   (void);
585 int	serial_tstc   (void);
586 
587 /* These versions take a stdio_dev pointer */
588 struct stdio_dev;
589 int serial_stub_getc(struct stdio_dev *sdev);
590 int serial_stub_tstc(struct stdio_dev *sdev);
591 
592 /* $(CPU)/speed.c */
593 int	get_clocks (void);
594 int	get_clocks_866 (void);
595 int	sdram_adjust_866 (void);
596 int	adjust_sdram_tbs_8xx (void);
597 #if defined(CONFIG_MPC8260)
598 int	prt_8260_clks (void);
599 #elif defined(CONFIG_MPC5xxx)
600 int	prt_mpc5xxx_clks (void);
601 #endif
602 #ifdef CONFIG_4xx
603 ulong	get_OPB_freq (void);
604 ulong	get_PCI_freq (void);
605 #endif
606 #if defined(CONFIG_S3C24X0) || \
607     defined(CONFIG_LH7A40X) || \
608     defined(CONFIG_EP93XX)
609 ulong	get_FCLK (void);
610 ulong	get_HCLK (void);
611 ulong	get_PCLK (void);
612 ulong	get_UCLK (void);
613 #endif
614 #if defined(CONFIG_LH7A40X)
615 ulong	get_PLLCLK (void);
616 #endif
617 #if defined(CONFIG_IMX)
618 ulong get_systemPLLCLK(void);
619 ulong get_FCLK(void);
620 ulong get_HCLK(void);
621 ulong get_BCLK(void);
622 ulong get_PERCLK1(void);
623 ulong get_PERCLK2(void);
624 ulong get_PERCLK3(void);
625 #endif
626 ulong	get_bus_freq  (ulong);
627 int get_serial_clock(void);
628 
629 #if defined(CONFIG_MPC85xx)
630 typedef MPC85xx_SYS_INFO sys_info_t;
631 void	get_sys_info  ( sys_info_t * );
632 #  if defined(CONFIG_OF_LIBFDT)
633 	void ft_fixup_cpu(void *, u64);
634 	void ft_fixup_num_cores(void *);
635 #  endif
636 #endif
637 #if defined(CONFIG_MPC86xx)
638 typedef MPC86xx_SYS_INFO sys_info_t;
639 void   get_sys_info  ( sys_info_t * );
640 static inline ulong get_ddr_freq(ulong dummy)
641 {
642 	return get_bus_freq(dummy);
643 }
644 #else
645 ulong get_ddr_freq(ulong);
646 #endif
647 
648 #if defined(CONFIG_4xx)
649 #  if defined(CONFIG_440)
650 #	if defined(CONFIG_440SPE)
651 	 unsigned long determine_sysper(void);
652 	 unsigned long determine_pci_clock_per(void);
653 #	endif
654 #  endif
655 typedef PPC4xx_SYS_INFO sys_info_t;
656 int	ppc440spe_revB(void);
657 void	get_sys_info  ( sys_info_t * );
658 #endif
659 
660 /* $(CPU)/cpu_init.c */
661 #if defined(CONFIG_8xx) || defined(CONFIG_MPC8260)
662 void	cpu_init_f    (volatile immap_t *immr);
663 #endif
664 #if defined(CONFIG_4xx) || defined(CONFIG_MCF52x2) || defined(CONFIG_MPC86xx)
665 void	cpu_init_f    (void);
666 #endif
667 #ifdef CONFIG_MPC85xx
668 ulong cpu_init_f(void);
669 #endif
670 
671 int	cpu_init_r    (void);
672 #if defined(CONFIG_MPC8260)
673 int	prt_8260_rsr  (void);
674 #elif defined(CONFIG_MPC83xx)
675 int	prt_83xx_rsr  (void);
676 #endif
677 
678 /* $(CPU)/interrupts.c */
679 int	interrupt_init	   (void);
680 void	timer_interrupt	   (struct pt_regs *);
681 void	external_interrupt (struct pt_regs *);
682 void	irq_install_handler(int, interrupt_handler_t *, void *);
683 void	irq_free_handler   (int);
684 void	reset_timer	   (void);
685 ulong	get_timer	   (ulong base);
686 
687 /* Return value of monotonic microsecond timer */
688 unsigned long timer_get_us(void);
689 
690 void	enable_interrupts  (void);
691 int	disable_interrupts (void);
692 
693 /* $(CPU)/.../commproc.c */
694 int	dpram_init (void);
695 uint	dpram_base(void);
696 uint	dpram_base_align(uint align);
697 uint	dpram_alloc(uint size);
698 uint	dpram_alloc_align(uint size,uint align);
699 void	bootcount_store (ulong);
700 ulong	bootcount_load (void);
701 #define BOOTCOUNT_MAGIC		0xB001C041
702 
703 /* $(CPU)/.../<eth> */
704 void mii_init (void);
705 
706 /* $(CPU)/.../lcd.c */
707 ulong	lcd_setmem (ulong);
708 
709 /* $(CPU)/.../video.c */
710 ulong	video_setmem (ulong);
711 
712 /* arch/$(ARCH)/lib/cache.c */
713 void	enable_caches(void);
714 void	flush_cache   (unsigned long, unsigned long);
715 void	flush_dcache_all(void);
716 void	flush_dcache_range(unsigned long start, unsigned long stop);
717 void	invalidate_dcache_range(unsigned long start, unsigned long stop);
718 void	invalidate_dcache_all(void);
719 void	invalidate_icache_all(void);
720 
721 /* arch/$(ARCH)/lib/ticks.S */
722 uint64_t get_ticks(void);
723 void	wait_ticks    (unsigned long);
724 
725 /* arch/$(ARCH)/lib/time.c */
726 void	__udelay      (unsigned long);
727 ulong	usec2ticks    (unsigned long usec);
728 ulong	ticks2usec    (unsigned long ticks);
729 int	init_timebase (void);
730 
731 /* lib/gunzip.c */
732 int gunzip(void *, int, unsigned char *, unsigned long *);
733 int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
734 						int stoponerr, int offset);
735 
736 /* lib/qsort.c */
737 void qsort(void *base, size_t nmemb, size_t size,
738 	   int(*compar)(const void *, const void *));
739 int strcmp_compar(const void *, const void *);
740 
741 /* lib/time.c */
742 void	udelay        (unsigned long);
743 void mdelay(unsigned long);
744 
745 /* lib/uuid.c */
746 #include <uuid.h>
747 
748 /* lib/vsprintf.c */
749 #include <vsprintf.h>
750 
751 /* lib/strmhz.c */
752 char *	strmhz(char *buf, unsigned long hz);
753 
754 /* lib/crc32.c */
755 #include <u-boot/crc.h>
756 
757 /* lib/rand.c */
758 #define RAND_MAX -1U
759 void srand(unsigned int seed);
760 unsigned int rand(void);
761 unsigned int rand_r(unsigned int *seedp);
762 
763 /* common/console.c */
764 int	console_init_f(void);	/* Before relocation; uses the serial  stuff	*/
765 int	console_init_r(void);	/* After  relocation; uses the console stuff	*/
766 int	console_assign(int file, const char *devname);	/* Assign the console	*/
767 int	ctrlc (void);
768 int	had_ctrlc (void);	/* have we had a Control-C since last clear? */
769 void	clear_ctrlc (void);	/* clear the Control-C condition */
770 int	disable_ctrlc (int);	/* 1 to disable, 0 to enable Control-C detect */
771 int confirm_yesno(void);        /*  1 if input is "y", "Y", "yes" or "YES" */
772 /*
773  * STDIO based functions (can always be used)
774  */
775 /* serial stuff */
776 int	serial_printf (const char *fmt, ...)
777 		__attribute__ ((format (__printf__, 1, 2)));
778 /* stdin */
779 int	getc(void);
780 int	tstc(void);
781 
782 /* stdout */
783 void	putc(const char c);
784 void	puts(const char *s);
785 int	printf(const char *fmt, ...)
786 		__attribute__ ((format (__printf__, 1, 2)));
787 int	vprintf(const char *fmt, va_list args);
788 
789 /* stderr */
790 #define eputc(c)		fputc(stderr, c)
791 #define eputs(s)		fputs(stderr, s)
792 #define eprintf(fmt,args...)	fprintf(stderr,fmt ,##args)
793 
794 /*
795  * FILE based functions (can only be used AFTER relocation!)
796  */
797 #define stdin		0
798 #define stdout		1
799 #define stderr		2
800 #define MAX_FILES	3
801 
802 int	fprintf(int file, const char *fmt, ...)
803 		__attribute__ ((format (__printf__, 2, 3)));
804 void	fputs(int file, const char *s);
805 void	fputc(int file, const char c);
806 int	ftstc(int file);
807 int	fgetc(int file);
808 
809 /* lib/gzip.c */
810 int gzip(void *dst, unsigned long *lenp,
811 		unsigned char *src, unsigned long srclen);
812 int zzip(void *dst, unsigned long *lenp, unsigned char *src,
813 		unsigned long srclen, int stoponerr,
814 		int (*func)(unsigned long, unsigned long));
815 
816 /* lib/net_utils.c */
817 #include <net.h>
818 static inline IPaddr_t getenv_IPaddr(char *var)
819 {
820 	return string_to_ip(getenv(var));
821 }
822 
823 /*
824  * CONSOLE multiplexing.
825  */
826 #ifdef CONFIG_CONSOLE_MUX
827 #include <iomux.h>
828 #endif
829 
830 int	pcmcia_init (void);
831 
832 #ifdef CONFIG_STATUS_LED
833 # include <status_led.h>
834 #endif
835 
836 #include <bootstage.h>
837 
838 #ifdef CONFIG_SHOW_ACTIVITY
839 void show_activity(int arg);
840 #endif
841 
842 /* Multicore arch functions */
843 #ifdef CONFIG_MP
844 int cpu_status(int nr);
845 int cpu_reset(int nr);
846 int cpu_disable(int nr);
847 int cpu_release(int nr, int argc, char * const argv[]);
848 #endif
849 
850 /* Define a null map_sysmem() if the architecture doesn't use it */
851 # ifndef CONFIG_ARCH_MAP_SYSMEM
852 static inline void *map_sysmem(phys_addr_t paddr, unsigned long len)
853 {
854 	return (void *)(uintptr_t)paddr;
855 }
856 
857 static inline void unmap_sysmem(const void *vaddr)
858 {
859 }
860 
861 static inline phys_addr_t map_to_sysmem(const void *ptr)
862 {
863 	return (phys_addr_t)(uintptr_t)ptr;
864 }
865 # endif
866 
867 #endif /* __ASSEMBLY__ */
868 
869 #ifdef CONFIG_PPC
870 /*
871  * Has to be included outside of the #ifndef __ASSEMBLY__ section.
872  * Otherwise might lead to compilation errors in assembler files.
873  */
874 #include <asm/cache.h>
875 #endif
876 
877 /* Put only stuff here that the assembler can digest */
878 
879 #ifdef CONFIG_POST
880 #define CONFIG_HAS_POST
881 #ifndef CONFIG_POST_ALT_LIST
882 #define CONFIG_POST_STD_LIST
883 #endif
884 #endif
885 
886 #ifdef CONFIG_INIT_CRITICAL
887 #error CONFIG_INIT_CRITICAL is deprecated!
888 #error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
889 #endif
890 
891 #define ROUND(a,b)		(((a) + (b) - 1) & ~((b) - 1))
892 
893 /*
894  * ARCH_DMA_MINALIGN is defined in asm/cache.h for each architecture.  It
895  * is used to align DMA buffers.
896  */
897 #ifndef __ASSEMBLY__
898 #include <asm/cache.h>
899 #endif
900 
901 /*
902  * The ALLOC_CACHE_ALIGN_BUFFER macro is used to allocate a buffer on the
903  * stack that meets the minimum architecture alignment requirements for DMA.
904  * Such a buffer is useful for DMA operations where flushing and invalidating
905  * the cache before and after a read and/or write operation is required for
906  * correct operations.
907  *
908  * When called the macro creates an array on the stack that is sized such
909  * that:
910  *
911  * 1) The beginning of the array can be advanced enough to be aligned.
912  *
913  * 2) The size of the aligned portion of the array is a multiple of the minimum
914  *    architecture alignment required for DMA.
915  *
916  * 3) The aligned portion contains enough space for the original number of
917  *    elements requested.
918  *
919  * The macro then creates a pointer to the aligned portion of this array and
920  * assigns to the pointer the address of the first element in the aligned
921  * portion of the array.
922  *
923  * Calling the macro as:
924  *
925  *     ALLOC_CACHE_ALIGN_BUFFER(uint32_t, buffer, 1024);
926  *
927  * Will result in something similar to saying:
928  *
929  *     uint32_t    buffer[1024];
930  *
931  * The following differences exist:
932  *
933  * 1) The resulting buffer is guaranteed to be aligned to the value of
934  *    ARCH_DMA_MINALIGN.
935  *
936  * 2) The buffer variable created by the macro is a pointer to the specified
937  *    type, and NOT an array of the specified type.  This can be very important
938  *    if you want the address of the buffer, which you probably do, to pass it
939  *    to the DMA hardware.  The value of &buffer is different in the two cases.
940  *    In the macro case it will be the address of the pointer, not the address
941  *    of the space reserved for the buffer.  However, in the second case it
942  *    would be the address of the buffer.  So if you are replacing hard coded
943  *    stack buffers with this macro you need to make sure you remove the & from
944  *    the locations where you are taking the address of the buffer.
945  *
946  * Note that the size parameter is the number of array elements to allocate,
947  * not the number of bytes.
948  *
949  * This macro can not be used outside of function scope, or for the creation
950  * of a function scoped static buffer.  It can not be used to create a cache
951  * line aligned global buffer.
952  */
953 #define PAD_COUNT(s, pad) (((s) - 1) / (pad) + 1)
954 #define PAD_SIZE(s, pad) (PAD_COUNT(s, pad) * pad)
955 #define ALLOC_ALIGN_BUFFER_PAD(type, name, size, align, pad)		\
956 	char __##name[ROUND(PAD_SIZE((size) * sizeof(type), pad), align)  \
957 		      + (align - 1)];					\
958 									\
959 	type *name = (type *) ALIGN((uintptr_t)__##name, align)
960 #define ALLOC_ALIGN_BUFFER(type, name, size, align)		\
961 	ALLOC_ALIGN_BUFFER_PAD(type, name, size, align, 1)
962 #define ALLOC_CACHE_ALIGN_BUFFER_PAD(type, name, size, pad)		\
963 	ALLOC_ALIGN_BUFFER_PAD(type, name, size, ARCH_DMA_MINALIGN, pad)
964 #define ALLOC_CACHE_ALIGN_BUFFER(type, name, size)			\
965 	ALLOC_ALIGN_BUFFER(type, name, size, ARCH_DMA_MINALIGN)
966 
967 /*
968  * DEFINE_CACHE_ALIGN_BUFFER() is similar to ALLOC_CACHE_ALIGN_BUFFER, but it's
969  * purpose is to allow allocating aligned buffers outside of function scope.
970  * Usage of this macro shall be avoided or used with extreme care!
971  */
972 #define DEFINE_ALIGN_BUFFER(type, name, size, align)			\
973 	static char __##name[ALIGN(size * sizeof(type), align)]	\
974 			__aligned(align);				\
975 									\
976 	static type *name = (type *)__##name
977 #define DEFINE_CACHE_ALIGN_BUFFER(type, name, size)			\
978 	DEFINE_ALIGN_BUFFER(type, name, size, ARCH_DMA_MINALIGN)
979 
980 /* Pull in stuff for the build system */
981 #ifdef DO_DEPS_ONLY
982 # include <environment.h>
983 #endif
984 
985 #endif	/* __COMMON_H_ */
986