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