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