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