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