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