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