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