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