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