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