xref: /openbmc/u-boot/include/common.h (revision c9aa831e)
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 
315 /**
316  * Show the DRAM size in a board-specific way
317  *
318  * This is used by boards to display DRAM information in their own way.
319  *
320  * @param size	Size of DRAM (which should be displayed along with other info)
321  */
322 void board_show_dram(ulong size);
323 
324 /* common/flash.c */
325 void flash_perror (int);
326 
327 /* common/cmd_source.c */
328 int	source (ulong addr, const char *fit_uname);
329 
330 extern ulong load_addr;		/* Default Load Address */
331 extern ulong save_addr;		/* Default Save Address */
332 extern ulong save_size;		/* Default Save Size */
333 
334 /* common/cmd_doc.c */
335 void	doc_probe(unsigned long physadr);
336 
337 /* common/cmd_net.c */
338 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
339 
340 /* common/cmd_fat.c */
341 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
342 
343 /* common/cmd_ext2.c */
344 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
345 
346 /* common/cmd_nvedit.c */
347 int	env_init     (void);
348 void	env_relocate (void);
349 int	envmatch     (uchar *, int);
350 char	*getenv	     (const char *);
351 int	getenv_f     (const char *name, char *buf, unsigned len);
352 ulong getenv_ulong(const char *name, int base, ulong default_val);
353 /*
354  * Read an environment variable as a boolean
355  * Return -1 if variable does not exist (default to true)
356  */
357 int getenv_yesno(const char *var);
358 int	saveenv	     (void);
359 int	setenv	     (const char *, const char *);
360 int setenv_ulong(const char *varname, ulong value);
361 int setenv_hex(const char *varname, ulong value);
362 /**
363  * setenv_addr - Set an environment variable to an address in hex
364  *
365  * @varname:	Environmet variable to set
366  * @addr:	Value to set it to
367  * @return 0 if ok, 1 on error
368  */
369 static inline int setenv_addr(const char *varname, const void *addr)
370 {
371 	return setenv_hex(varname, (ulong)addr);
372 }
373 
374 #ifdef CONFIG_ARM
375 # include <asm/mach-types.h>
376 # include <asm/setup.h>
377 # include <asm/u-boot-arm.h>	/* ARM version to be fixed! */
378 #endif /* CONFIG_ARM */
379 #ifdef CONFIG_X86		/* x86 version to be fixed! */
380 # include <asm/u-boot-x86.h>
381 #endif /* CONFIG_X86 */
382 #ifdef CONFIG_SANDBOX
383 # include <asm/u-boot-sandbox.h>	/* TODO(sjg) what needs to be fixed? */
384 #endif
385 #ifdef CONFIG_NDS32
386 # include <asm/mach-types.h>
387 # include <asm/u-boot-nds32.h>
388 #endif /* CONFIG_NDS32 */
389 #ifdef CONFIG_MIPS
390 # include <asm/u-boot-mips.h>
391 #endif /* CONFIG_MIPS */
392 
393 #ifdef CONFIG_AUTO_COMPLETE
394 int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
395 #endif
396 int get_env_id (void);
397 
398 void	pci_init      (void);
399 void	pci_init_board(void);
400 void	pciinfo	      (int, int);
401 
402 #if defined(CONFIG_PCI) && defined(CONFIG_4xx)
403     int	   pci_pre_init	       (struct pci_controller *);
404     int	   is_pci_host	       (struct pci_controller *);
405 #endif
406 
407 #if defined(CONFIG_PCI) && (defined(CONFIG_440) || defined(CONFIG_405EX))
408 #   if defined(CONFIG_SYS_PCI_TARGET_INIT)
409 	void	pci_target_init	     (struct pci_controller *);
410 #   endif
411 #   if defined(CONFIG_SYS_PCI_MASTER_INIT)
412 	void	pci_master_init	     (struct pci_controller *);
413 #   endif
414 #if defined(CONFIG_440SPE) || \
415     defined(CONFIG_460EX) || defined(CONFIG_460GT) || \
416     defined(CONFIG_405EX)
417    void pcie_setup_hoses(int busno);
418 #endif
419 #endif
420 
421 int	misc_init_f   (void);
422 int	misc_init_r   (void);
423 
424 /* common/exports.c */
425 void	jumptable_init(void);
426 
427 /* common/kallsysm.c */
428 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
429 
430 /* api/api.c */
431 void	api_init (void);
432 
433 /* common/memsize.c */
434 long	get_ram_size  (long *, long);
435 
436 /* $(BOARD)/$(BOARD).c */
437 void	reset_phy     (void);
438 void	fdc_hw_init   (void);
439 
440 /* $(BOARD)/eeprom.c */
441 void eeprom_init  (void);
442 #ifndef CONFIG_SPI
443 int  eeprom_probe (unsigned dev_addr, unsigned offset);
444 #endif
445 int  eeprom_read  (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
446 int  eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
447 #ifdef CONFIG_LWMON
448 extern uchar pic_read  (uchar reg);
449 extern void  pic_write (uchar reg, uchar val);
450 #endif
451 
452 /*
453  * Set this up regardless of board
454  * type, to prevent errors.
455  */
456 #if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
457 # define CONFIG_SYS_DEF_EEPROM_ADDR 0
458 #else
459 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
460 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
461 #endif
462 #endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
463 
464 #if defined(CONFIG_SPI)
465 extern void spi_init_f (void);
466 extern void spi_init_r (void);
467 extern ssize_t spi_read	 (uchar *, int, uchar *, int);
468 extern ssize_t spi_write (uchar *, int, uchar *, int);
469 #endif
470 
471 #ifdef CONFIG_RPXCLASSIC
472 void rpxclassic_init (void);
473 #endif
474 
475 void rpxlite_init (void);
476 
477 #ifdef CONFIG_MBX
478 /* $(BOARD)/mbx8xx.c */
479 void	mbx_init (void);
480 void	board_serial_init (void);
481 void	board_ether_init (void);
482 #endif
483 
484 #ifdef CONFIG_HERMES
485 /* $(BOARD)/hermes.c */
486 void hermes_start_lxt980 (int speed);
487 #endif
488 
489 #ifdef CONFIG_EVB64260
490 void  evb64260_init(void);
491 void  debug_led(int, int);
492 void  display_mem_map(void);
493 void  perform_soft_reset(void);
494 #endif
495 
496 /* $(BOARD)/$(BOARD).c */
497 int board_early_init_f (void);
498 int board_late_init (void);
499 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
500 int board_early_init_r (void);
501 void board_poweroff (void);
502 
503 #if defined(CONFIG_SYS_DRAM_TEST)
504 int testdram(void);
505 #endif /* CONFIG_SYS_DRAM_TEST */
506 
507 /* $(CPU)/start.S */
508 #if defined(CONFIG_5xx) || \
509     defined(CONFIG_8xx)
510 uint	get_immr      (uint);
511 #endif
512 uint	get_pir	      (void);
513 #if defined(CONFIG_MPC5xxx)
514 uint	get_svr       (void);
515 #endif
516 uint	get_pvr	      (void);
517 uint	get_svr	      (void);
518 uint	rd_ic_cst     (void);
519 void	wr_ic_cst     (uint);
520 void	wr_ic_adr     (uint);
521 uint	rd_dc_cst     (void);
522 void	wr_dc_cst     (uint);
523 void	wr_dc_adr     (uint);
524 int	icache_status (void);
525 void	icache_enable (void);
526 void	icache_disable(void);
527 int	dcache_status (void);
528 void	dcache_enable (void);
529 void	dcache_disable(void);
530 void	mmu_disable(void);
531 void	relocate_code (ulong, gd_t *, ulong) __attribute__ ((noreturn));
532 ulong	get_endaddr   (void);
533 void	trap_init     (ulong);
534 #if defined (CONFIG_4xx)	|| \
535     defined (CONFIG_MPC5xxx)	|| \
536     defined (CONFIG_74xx_7xx)	|| \
537     defined (CONFIG_74x)	|| \
538     defined (CONFIG_75x)	|| \
539     defined (CONFIG_74xx)	|| \
540     defined (CONFIG_MPC8220)	|| \
541     defined (CONFIG_MPC85xx)	|| \
542     defined (CONFIG_MPC86xx)	|| \
543     defined (CONFIG_MPC83xx)
544 unsigned char	in8(unsigned int);
545 void		out8(unsigned int, unsigned char);
546 unsigned short	in16(unsigned int);
547 unsigned short	in16r(unsigned int);
548 void		out16(unsigned int, unsigned short value);
549 void		out16r(unsigned int, unsigned short value);
550 unsigned long	in32(unsigned int);
551 unsigned long	in32r(unsigned int);
552 void		out32(unsigned int, unsigned long value);
553 void		out32r(unsigned int, unsigned long value);
554 void		ppcDcbf(unsigned long value);
555 void		ppcDcbi(unsigned long value);
556 void		ppcSync(void);
557 void		ppcDcbz(unsigned long value);
558 #endif
559 #if defined (CONFIG_MICROBLAZE)
560 unsigned short	in16(unsigned int);
561 void		out16(unsigned int, unsigned short value);
562 #endif
563 
564 #if defined (CONFIG_MPC83xx)
565 void		ppcDWload(unsigned int *addr, unsigned int *ret);
566 void		ppcDWstore(unsigned int *addr, unsigned int *value);
567 void disable_addr_trans(void);
568 void enable_addr_trans(void);
569 #if defined(CONFIG_DDR_ECC) && !defined(CONFIG_ECC_INIT_VIA_DDRCONTROLLER)
570 void ddr_enable_ecc(unsigned int dram_size);
571 #endif
572 #endif
573 
574 /* $(CPU)/cpu.c */
575 static inline int cpumask_next(int cpu, unsigned int mask)
576 {
577 	for (cpu++; !((1 << cpu) & mask); cpu++)
578 		;
579 
580 	return cpu;
581 }
582 
583 #define for_each_cpu(iter, cpu, num_cpus, mask) \
584 	for (iter = 0, cpu = cpumask_next(-1, mask); \
585 		iter < num_cpus; \
586 		iter++, cpu = cpumask_next(cpu, mask)) \
587 
588 int	cpu_numcores  (void);
589 u32	cpu_mask      (void);
590 int	is_core_valid (unsigned int);
591 int	probecpu      (void);
592 int	checkcpu      (void);
593 int	checkicache   (void);
594 int	checkdcache   (void);
595 void	upmconfig     (unsigned int, unsigned int *, unsigned int);
596 ulong	get_tbclk     (void);
597 void	reset_cpu     (ulong addr);
598 #if defined (CONFIG_OF_LIBFDT) && defined (CONFIG_OF_BOARD_SETUP)
599 void ft_cpu_setup(void *blob, bd_t *bd);
600 #ifdef CONFIG_PCI
601 void ft_pci_setup(void *blob, bd_t *bd);
602 #endif
603 #endif
604 
605 
606 /* $(CPU)/serial.c */
607 int	serial_init   (void);
608 void	serial_setbrg (void);
609 void	serial_putc   (const char);
610 void	serial_putc_raw(const char);
611 void	serial_puts   (const char *);
612 int	serial_getc   (void);
613 int	serial_tstc   (void);
614 
615 void	_serial_setbrg (const int);
616 void	_serial_putc   (const char, const int);
617 void	_serial_putc_raw(const char, const int);
618 void	_serial_puts   (const char *, const int);
619 int	_serial_getc   (const int);
620 int	_serial_tstc   (const int);
621 
622 /* $(CPU)/speed.c */
623 int	get_clocks (void);
624 int	get_clocks_866 (void);
625 int	sdram_adjust_866 (void);
626 int	adjust_sdram_tbs_8xx (void);
627 #if defined(CONFIG_8260)
628 int	prt_8260_clks (void);
629 #elif defined(CONFIG_MPC5xxx)
630 int	prt_mpc5xxx_clks (void);
631 #endif
632 #if defined(CONFIG_MPC512X)
633 int	prt_mpc512xxx_clks (void);
634 #endif
635 #if defined(CONFIG_MPC8220)
636 int	prt_mpc8220_clks (void);
637 #endif
638 #ifdef CONFIG_4xx
639 ulong	get_OPB_freq (void);
640 ulong	get_PCI_freq (void);
641 #endif
642 #if defined(CONFIG_S3C24X0) || \
643     defined(CONFIG_LH7A40X) || \
644     defined(CONFIG_S3C6400) || \
645     defined(CONFIG_EP93XX)
646 ulong	get_FCLK (void);
647 ulong	get_HCLK (void);
648 ulong	get_PCLK (void);
649 ulong	get_UCLK (void);
650 #endif
651 #if defined(CONFIG_LH7A40X)
652 ulong	get_PLLCLK (void);
653 #endif
654 #if defined CONFIG_INCA_IP
655 uint	incaip_get_cpuclk (void);
656 #endif
657 #if defined(CONFIG_IMX)
658 ulong get_systemPLLCLK(void);
659 ulong get_FCLK(void);
660 ulong get_HCLK(void);
661 ulong get_BCLK(void);
662 ulong get_PERCLK1(void);
663 ulong get_PERCLK2(void);
664 ulong get_PERCLK3(void);
665 #endif
666 ulong	get_bus_freq  (ulong);
667 int get_serial_clock(void);
668 
669 #if defined(CONFIG_MPC83xx) || defined(CONFIG_MPC85xx)
670 ulong get_ddr_freq(ulong);
671 #endif
672 #if defined(CONFIG_MPC85xx)
673 typedef MPC85xx_SYS_INFO sys_info_t;
674 void	get_sys_info  ( sys_info_t * );
675 #endif
676 #if defined(CONFIG_MPC86xx)
677 typedef MPC86xx_SYS_INFO sys_info_t;
678 void   get_sys_info  ( sys_info_t * );
679 static inline ulong get_ddr_freq(ulong dummy)
680 {
681 	return get_bus_freq(dummy);
682 }
683 #endif
684 
685 #if defined(CONFIG_4xx)
686 #  if defined(CONFIG_440)
687 #	if defined(CONFIG_440SPE)
688 	 unsigned long determine_sysper(void);
689 	 unsigned long determine_pci_clock_per(void);
690 #	endif
691 #  endif
692 typedef PPC4xx_SYS_INFO sys_info_t;
693 int	ppc440spe_revB(void);
694 void	get_sys_info  ( sys_info_t * );
695 #endif
696 
697 /* $(CPU)/cpu_init.c */
698 #if defined(CONFIG_8xx) || defined(CONFIG_8260)
699 void	cpu_init_f    (volatile immap_t *immr);
700 #endif
701 #if defined(CONFIG_4xx) || defined(CONFIG_MPC85xx) || defined(CONFIG_MCF52x2) ||defined(CONFIG_MPC86xx)
702 void	cpu_init_f    (void);
703 #endif
704 
705 int	cpu_init_r    (void);
706 #if defined(CONFIG_8260)
707 int	prt_8260_rsr  (void);
708 #elif defined(CONFIG_MPC83xx)
709 int	prt_83xx_rsr  (void);
710 #endif
711 
712 /* $(CPU)/interrupts.c */
713 int	interrupt_init	   (void);
714 void	timer_interrupt	   (struct pt_regs *);
715 void	external_interrupt (struct pt_regs *);
716 void	irq_install_handler(int, interrupt_handler_t *, void *);
717 void	irq_free_handler   (int);
718 void	reset_timer	   (void);
719 ulong	get_timer	   (ulong base);
720 void	enable_interrupts  (void);
721 int	disable_interrupts (void);
722 
723 /* $(CPU)/.../commproc.c */
724 int	dpram_init (void);
725 uint	dpram_base(void);
726 uint	dpram_base_align(uint align);
727 uint	dpram_alloc(uint size);
728 uint	dpram_alloc_align(uint size,uint align);
729 void	bootcount_store (ulong);
730 ulong	bootcount_load (void);
731 #define BOOTCOUNT_MAGIC		0xB001C041
732 
733 /* $(CPU)/.../<eth> */
734 void mii_init (void);
735 
736 /* $(CPU)/.../lcd.c */
737 ulong	lcd_setmem (ulong);
738 
739 /* $(CPU)/.../video.c */
740 ulong	video_setmem (ulong);
741 
742 /* arch/$(ARCH)/lib/cache.c */
743 void	enable_caches(void);
744 void	flush_cache   (unsigned long, unsigned long);
745 void	flush_dcache_all(void);
746 void	flush_dcache_range(unsigned long start, unsigned long stop);
747 void	invalidate_dcache_range(unsigned long start, unsigned long stop);
748 void	invalidate_dcache_all(void);
749 void	invalidate_icache_all(void);
750 
751 /* arch/$(ARCH)/lib/ticks.S */
752 unsigned long long get_ticks(void);
753 void	wait_ticks    (unsigned long);
754 
755 /* arch/$(ARCH)/lib/time.c */
756 void	__udelay      (unsigned long);
757 ulong	usec2ticks    (unsigned long usec);
758 ulong	ticks2usec    (unsigned long ticks);
759 int	init_timebase (void);
760 
761 /* lib/gunzip.c */
762 int gunzip(void *, int, unsigned char *, unsigned long *);
763 int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
764 						int stoponerr, int offset);
765 
766 /* lib/qsort.c */
767 void qsort(void *base, size_t nmemb, size_t size,
768 	   int(*compar)(const void *, const void *));
769 int strcmp_compar(const void *, const void *);
770 
771 /* lib/time.c */
772 void	udelay        (unsigned long);
773 void mdelay(unsigned long);
774 
775 /* lib/uuid.c */
776 void uuid_str_to_bin(const char *uuid, unsigned char *out);
777 int uuid_str_valid(const char *uuid);
778 
779 /* lib/vsprintf.c */
780 #include <vsprintf.h>
781 
782 /* lib/strmhz.c */
783 char *	strmhz(char *buf, unsigned long hz);
784 
785 /* lib/crc32.c */
786 #include <u-boot/crc.h>
787 
788 /* lib/rand.c */
789 #if defined(CONFIG_RANDOM_MACADDR) || \
790 	defined(CONFIG_BOOTP_RANDOM_DELAY) || \
791 	defined(CONFIG_CMD_LINK_LOCAL)
792 #define RAND_MAX -1U
793 void srand(unsigned int seed);
794 unsigned int rand(void);
795 unsigned int rand_r(unsigned int *seedp);
796 #endif
797 
798 /* common/console.c */
799 int	console_init_f(void);	/* Before relocation; uses the serial  stuff	*/
800 int	console_init_r(void);	/* After  relocation; uses the console stuff	*/
801 int	console_assign(int file, const char *devname);	/* Assign the console	*/
802 int	ctrlc (void);
803 int	had_ctrlc (void);	/* have we had a Control-C since last clear? */
804 void	clear_ctrlc (void);	/* clear the Control-C condition */
805 int	disable_ctrlc (int);	/* 1 to disable, 0 to enable Control-C detect */
806 
807 /*
808  * STDIO based functions (can always be used)
809  */
810 /* serial stuff */
811 int	serial_printf (const char *fmt, ...)
812 		__attribute__ ((format (__printf__, 1, 2)));
813 /* stdin */
814 int	getc(void);
815 int	tstc(void);
816 
817 /* stdout */
818 void	putc(const char c);
819 void	puts(const char *s);
820 int	printf(const char *fmt, ...)
821 		__attribute__ ((format (__printf__, 1, 2)));
822 int	vprintf(const char *fmt, va_list args);
823 
824 /* stderr */
825 #define eputc(c)		fputc(stderr, c)
826 #define eputs(s)		fputs(stderr, s)
827 #define eprintf(fmt,args...)	fprintf(stderr,fmt ,##args)
828 
829 /*
830  * FILE based functions (can only be used AFTER relocation!)
831  */
832 #define stdin		0
833 #define stdout		1
834 #define stderr		2
835 #define MAX_FILES	3
836 
837 int	fprintf(int file, const char *fmt, ...)
838 		__attribute__ ((format (__printf__, 2, 3)));
839 void	fputs(int file, const char *s);
840 void	fputc(int file, const char c);
841 int	ftstc(int file);
842 int	fgetc(int file);
843 
844 /* lib/gzip.c */
845 int gzip(void *dst, unsigned long *lenp,
846 		unsigned char *src, unsigned long srclen);
847 int zzip(void *dst, unsigned long *lenp, unsigned char *src,
848 		unsigned long srclen, int stoponerr,
849 		int (*func)(unsigned long, unsigned long));
850 
851 /* lib/net_utils.c */
852 #include <net.h>
853 static inline IPaddr_t getenv_IPaddr(char *var)
854 {
855 	return string_to_ip(getenv(var));
856 }
857 
858 /*
859  * CONSOLE multiplexing.
860  */
861 #ifdef CONFIG_CONSOLE_MUX
862 #include <iomux.h>
863 #endif
864 
865 int	pcmcia_init (void);
866 
867 #ifdef CONFIG_STATUS_LED
868 # include <status_led.h>
869 #endif
870 
871 #include <bootstage.h>
872 
873 #ifdef CONFIG_SHOW_ACTIVITY
874 void show_activity(int arg);
875 #endif
876 
877 /* Multicore arch functions */
878 #ifdef CONFIG_MP
879 int cpu_status(int nr);
880 int cpu_reset(int nr);
881 int cpu_disable(int nr);
882 int cpu_release(int nr, int argc, char * const argv[]);
883 #endif
884 
885 /* Define a null map_sysmem() if the architecture doesn't use it */
886 # ifndef CONFIG_ARCH_MAP_SYSMEM
887 static inline void *map_sysmem(phys_addr_t paddr, unsigned long len)
888 {
889 	return (void *)(uintptr_t)paddr;
890 }
891 
892 static inline void unmap_sysmem(const void *vaddr)
893 {
894 }
895 # endif
896 
897 #endif /* __ASSEMBLY__ */
898 
899 #ifdef CONFIG_PPC
900 /*
901  * Has to be included outside of the #ifndef __ASSEMBLY__ section.
902  * Otherwise might lead to compilation errors in assembler files.
903  */
904 #include <asm/cache.h>
905 #endif
906 
907 /* Put only stuff here that the assembler can digest */
908 
909 #ifdef CONFIG_POST
910 #define CONFIG_HAS_POST
911 #ifndef CONFIG_POST_ALT_LIST
912 #define CONFIG_POST_STD_LIST
913 #endif
914 #endif
915 
916 #ifdef CONFIG_INIT_CRITICAL
917 #error CONFIG_INIT_CRITICAL is deprecated!
918 #error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
919 #endif
920 
921 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
922 
923 #define ROUND(a,b)		(((a) + (b) - 1) & ~((b) - 1))
924 #define DIV_ROUND(n,d)		(((n) + ((d)/2)) / (d))
925 #define DIV_ROUND_UP(n,d)	(((n) + (d) - 1) / (d))
926 #define roundup(x, y)		((((x) + ((y) - 1)) / (y)) * (y))
927 
928 #define ALIGN(x,a)		__ALIGN_MASK((x),(typeof(x))(a)-1)
929 #define __ALIGN_MASK(x,mask)	(((x)+(mask))&~(mask))
930 
931 /*
932  * ARCH_DMA_MINALIGN is defined in asm/cache.h for each architecture.  It
933  * is used to align DMA buffers.
934  */
935 #ifndef __ASSEMBLY__
936 #include <asm/cache.h>
937 #endif
938 
939 /*
940  * The ALLOC_CACHE_ALIGN_BUFFER macro is used to allocate a buffer on the
941  * stack that meets the minimum architecture alignment requirements for DMA.
942  * Such a buffer is useful for DMA operations where flushing and invalidating
943  * the cache before and after a read and/or write operation is required for
944  * correct operations.
945  *
946  * When called the macro creates an array on the stack that is sized such
947  * that:
948  *
949  * 1) The beginning of the array can be advanced enough to be aligned.
950  *
951  * 2) The size of the aligned portion of the array is a multiple of the minimum
952  *    architecture alignment required for DMA.
953  *
954  * 3) The aligned portion contains enough space for the original number of
955  *    elements requested.
956  *
957  * The macro then creates a pointer to the aligned portion of this array and
958  * assigns to the pointer the address of the first element in the aligned
959  * portion of the array.
960  *
961  * Calling the macro as:
962  *
963  *     ALLOC_CACHE_ALIGN_BUFFER(uint32_t, buffer, 1024);
964  *
965  * Will result in something similar to saying:
966  *
967  *     uint32_t    buffer[1024];
968  *
969  * The following differences exist:
970  *
971  * 1) The resulting buffer is guaranteed to be aligned to the value of
972  *    ARCH_DMA_MINALIGN.
973  *
974  * 2) The buffer variable created by the macro is a pointer to the specified
975  *    type, and NOT an array of the specified type.  This can be very important
976  *    if you want the address of the buffer, which you probably do, to pass it
977  *    to the DMA hardware.  The value of &buffer is different in the two cases.
978  *    In the macro case it will be the address of the pointer, not the address
979  *    of the space reserved for the buffer.  However, in the second case it
980  *    would be the address of the buffer.  So if you are replacing hard coded
981  *    stack buffers with this macro you need to make sure you remove the & from
982  *    the locations where you are taking the address of the buffer.
983  *
984  * Note that the size parameter is the number of array elements to allocate,
985  * not the number of bytes.
986  *
987  * This macro can not be used outside of function scope, or for the creation
988  * of a function scoped static buffer.  It can not be used to create a cache
989  * line aligned global buffer.
990  */
991 #define ALLOC_ALIGN_BUFFER(type, name, size, align)			\
992 	char __##name[ROUND(size * sizeof(type), align) + (align - 1)];	\
993 									\
994 	type *name = (type *) ALIGN((uintptr_t)__##name, align)
995 #define ALLOC_CACHE_ALIGN_BUFFER(type, name, size)			\
996 	ALLOC_ALIGN_BUFFER(type, name, size, ARCH_DMA_MINALIGN)
997 
998 /*
999  * DEFINE_CACHE_ALIGN_BUFFER() is similar to ALLOC_CACHE_ALIGN_BUFFER, but it's
1000  * purpose is to allow allocating aligned buffers outside of function scope.
1001  * Usage of this macro shall be avoided or used with extreme care!
1002  */
1003 #define DEFINE_ALIGN_BUFFER(type, name, size, align)			\
1004 	static char __##name[roundup(size * sizeof(type), align)]	\
1005 			__attribute__((aligned(align)));				\
1006 									\
1007 	static type *name = (type *)__##name
1008 #define DEFINE_CACHE_ALIGN_BUFFER(type, name, size)			\
1009 	DEFINE_ALIGN_BUFFER(type, name, size, ARCH_DMA_MINALIGN)
1010 
1011 /* Pull in stuff for the build system */
1012 #ifdef DO_DEPS_ONLY
1013 # include <environment.h>
1014 #endif
1015 
1016 #endif	/* __COMMON_H_ */
1017