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