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