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