Move dram_init_banksize() to a common header
[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 /* Allow sharing constants with type modifiers between C and assembly. */
19 #define _AC(X, Y)       (X##Y)
20
21 #include <config.h>
22 #include <errno.h>
23 #include <time.h>
24 #include <asm-offsets.h>
25 #include <linux/bitops.h>
26 #include <linux/delay.h>
27 #include <linux/types.h>
28 #include <linux/string.h>
29 #include <linux/stringify.h>
30 #include <asm/ptrace.h>
31 #include <stdarg.h>
32 #include <linux/kernel.h>
33 #if defined(CONFIG_PCI) && defined(CONFIG_4xx)
34 #include <pci.h>
35 #endif
36 #if defined(CONFIG_8xx)
37 #include <asm/8xx_immap.h>
38 #if defined(CONFIG_MPC859)      || defined(CONFIG_MPC859T)      || \
39     defined(CONFIG_MPC866)      || \
40     defined(CONFIG_MPC866P)
41 # define CONFIG_MPC866_FAMILY 1
42 #elif defined(CONFIG_MPC885)
43 # define CONFIG_MPC885_FAMILY   1
44 #endif
45 #if   defined(CONFIG_MPC860)       \
46    || defined(CONFIG_MPC860T)      \
47    || defined(CONFIG_MPC866_FAMILY) \
48    || defined(CONFIG_MPC885_FAMILY)
49 # define CONFIG_MPC86x 1
50 #endif
51 #elif defined(CONFIG_5xx)
52 #include <asm/5xx_immap.h>
53 #elif defined(CONFIG_MPC5xxx)
54 #include <mpc5xxx.h>
55 #elif defined(CONFIG_MPC512X)
56 #include <asm/immap_512x.h>
57 #elif defined(CONFIG_MPC8260)
58 #if   defined(CONFIG_MPC8247) \
59    || defined(CONFIG_MPC8272)
60 #define CONFIG_MPC8272_FAMILY   1
61 #endif
62 #include <asm/immap_8260.h>
63 #endif
64 #ifdef CONFIG_MPC86xx
65 #include <mpc86xx.h>
66 #include <asm/immap_86xx.h>
67 #endif
68 #ifdef CONFIG_MPC85xx
69 #include <mpc85xx.h>
70 #include <asm/immap_85xx.h>
71 #endif
72 #ifdef CONFIG_MPC83xx
73 #include <mpc83xx.h>
74 #include <asm/immap_83xx.h>
75 #endif
76 #ifdef  CONFIG_4xx
77 #include <asm/ppc4xx.h>
78 #endif
79 #ifdef CONFIG_SOC_DA8XX
80 #include <asm/arch/hardware.h>
81 #endif
82 #ifdef CONFIG_FSL_LSCH3
83 #include <asm/arch/immap_lsch3.h>
84 #endif
85 #ifdef CONFIG_FSL_LSCH2
86 #include <asm/arch/immap_lsch2.h>
87 #endif
88
89 #include <part.h>
90 #include <flash.h>
91 #include <image.h>
92
93 /* Bring in printf format macros if inttypes.h is included */
94 #define __STDC_FORMAT_MACROS
95
96 #ifdef __LP64__
97 #define CONFIG_SYS_SUPPORT_64BIT_DATA
98 #endif
99
100 #ifdef DEBUG
101 #define _DEBUG  1
102 #else
103 #define _DEBUG  0
104 #endif
105
106 #ifdef CONFIG_SPL_BUILD
107 #define _SPL_BUILD      1
108 #else
109 #define _SPL_BUILD      0
110 #endif
111
112 /* Define this at the top of a file to add a prefix to debug messages */
113 #ifndef pr_fmt
114 #define pr_fmt(fmt) fmt
115 #endif
116
117 /*
118  * Output a debug text when condition "cond" is met. The "cond" should be
119  * computed by a preprocessor in the best case, allowing for the best
120  * optimization.
121  */
122 #define debug_cond(cond, fmt, args...)                  \
123         do {                                            \
124                 if (cond)                               \
125                         printf(pr_fmt(fmt), ##args);    \
126         } while (0)
127
128 /* Show a message if DEBUG is defined in a file */
129 #define debug(fmt, args...)                     \
130         debug_cond(_DEBUG, fmt, ##args)
131
132 /* Show a message if not in SPL */
133 #define warn_non_spl(fmt, args...)                      \
134         debug_cond(!_SPL_BUILD, fmt, ##args)
135
136 /*
137  * An assertion is run-time check done in debug mode only. If DEBUG is not
138  * defined then it is skipped. If DEBUG is defined and the assertion fails,
139  * then it calls panic*( which may or may not reset/halt U-Boot (see
140  * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
141  * before release, and after release it is hoped that they don't matter. But
142  * in any case these failing assertions cannot be fixed with a reset (which
143  * may just do the same assertion again).
144  */
145 void __assert_fail(const char *assertion, const char *file, unsigned line,
146                    const char *function);
147 #define assert(x) \
148         ({ if (!(x) && _DEBUG) \
149                 __assert_fail(#x, __FILE__, __LINE__, __func__); })
150
151 #define error(fmt, args...) do {                                        \
152                 printf("ERROR: " pr_fmt(fmt) "\nat %s:%d/%s()\n",       \
153                         ##args, __FILE__, __LINE__, __func__);          \
154 } while (0)
155
156 #ifndef BUG
157 #define BUG() do { \
158         printf("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __FUNCTION__); \
159         panic("BUG!"); \
160 } while (0)
161 #define BUG_ON(condition) do { if (unlikely((condition)!=0)) BUG(); } while(0)
162 #endif /* BUG */
163
164 typedef void (interrupt_handler_t)(void *);
165
166 #include <asm/u-boot.h> /* boot information for Linux kernel */
167 #include <asm/global_data.h>    /* global data used for startup functions */
168
169 /*
170  * enable common handling for all TQM8xxL/M boards:
171  * - CONFIG_TQM8xxM will be defined for all TQM8xxM boards
172  * - CONFIG_TQM8xxL will be defined for all TQM8xxL _and_ TQM8xxM boards
173  *                  and for the TQM885D board
174  */
175 #if defined(CONFIG_TQM823M) || defined(CONFIG_TQM850M) || \
176     defined(CONFIG_TQM855M) || defined(CONFIG_TQM860M) || \
177     defined(CONFIG_TQM862M) || defined(CONFIG_TQM866M)
178 # ifndef CONFIG_TQM8xxM
179 #  define CONFIG_TQM8xxM
180 # endif
181 #endif
182 #if defined(CONFIG_TQM823L) || defined(CONFIG_TQM850L) || \
183     defined(CONFIG_TQM855L) || defined(CONFIG_TQM860L) || \
184     defined(CONFIG_TQM862L) || defined(CONFIG_TQM8xxM) || \
185     defined(CONFIG_TQM885D)
186 # ifndef CONFIG_TQM8xxL
187 #  define CONFIG_TQM8xxL
188 # endif
189 #endif
190
191 #if defined(CONFIG_ENV_IS_EMBEDDED)
192 #define TOTAL_MALLOC_LEN        CONFIG_SYS_MALLOC_LEN
193 #elif ( ((CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) < CONFIG_SYS_MONITOR_BASE) || \
194         (CONFIG_ENV_ADDR >= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) ) || \
195       defined(CONFIG_ENV_IS_IN_NVRAM)
196 #define TOTAL_MALLOC_LEN        (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
197 #else
198 #define TOTAL_MALLOC_LEN        CONFIG_SYS_MALLOC_LEN
199 #endif
200
201 /*
202  * Function Prototypes
203  */
204 int dram_init(void);
205
206 /**
207  * dram_init_banksize() - Set up DRAM bank sizes
208  *
209  * This can be implemented by boards to set up the DRAM bank information in
210  * gd->bd->bi_dram(). It is called just before relocation, after dram_init()
211  * is called.
212  *
213  * If this is not provided, a default implementation will try to set up a
214  * single bank. It will do this if CONFIG_NR_DRAM_BANKS and
215  * CONFIG_SYS_SDRAM_BASE are set. The bank will have a start address of
216  * CONFIG_SYS_SDRAM_BASE and the size will be determined by a call to
217  * get_effective_memsize().
218  *
219  * @return 0 if OK, -ve on error
220  */
221 int dram_init_banksize(void);
222
223 void    hang            (void) __attribute__ ((noreturn));
224
225 int     timer_init(void);
226 int     cpu_init(void);
227
228 /* */
229 int initdram(void);
230
231 #include <display_options.h>
232
233 /* common/main.c */
234 void    main_loop       (void);
235 int run_command(const char *cmd, int flag);
236 int run_command_repeatable(const char *cmd, int flag);
237
238 /**
239  * Run a list of commands separated by ; or even \0
240  *
241  * Note that if 'len' is not -1, then the command does not need to be nul
242  * terminated, Memory will be allocated for the command in that case.
243  *
244  * @param cmd   List of commands to run, each separated bu semicolon
245  * @param len   Length of commands excluding terminator if known (-1 if not)
246  * @param flag  Execution flags (CMD_FLAG_...)
247  * @return 0 on success, or != 0 on error.
248  */
249 int run_command_list(const char *cmd, int len, int flag);
250
251 /* arch/$(ARCH)/lib/board.c */
252 void board_init_f(ulong);
253 void board_init_r(gd_t *, ulong) __attribute__ ((noreturn));
254
255 /**
256  * ulong board_init_f_alloc_reserve - allocate reserved area
257  *
258  * This function is called by each architecture very early in the start-up
259  * code to allow the C runtime to reserve space on the stack for writable
260  * 'globals' such as GD and the malloc arena.
261  *
262  * @top:        top of the reserve area, growing down.
263  * @return:     bottom of reserved area
264  */
265 ulong board_init_f_alloc_reserve(ulong top);
266
267 /**
268  * board_init_f_init_reserve - initialize the reserved area(s)
269  *
270  * This function is called once the C runtime has allocated the reserved
271  * area on the stack. It must initialize the GD at the base of that area.
272  *
273  * @base:       top from which reservation was done
274  */
275 void board_init_f_init_reserve(ulong base);
276
277 /**
278  * arch_setup_gd() - Set up the global_data pointer
279  *
280  * This pointer is special in some architectures and cannot easily be assigned
281  * to. For example on x86 it is implemented by adding a specific record to its
282  * Global Descriptor Table! So we we provide a function to carry out this task.
283  * For most architectures this can simply be:
284  *
285  *    gd = gd_ptr;
286  *
287  * @gd_ptr:     Pointer to global data
288  */
289 void arch_setup_gd(gd_t *gd_ptr);
290
291 int checkboard(void);
292 int show_board_info(void);
293 int checkflash(void);
294 int checkdram(void);
295 int last_stage_init(void);
296 extern ulong monitor_flash_len;
297 int mac_read_from_eeprom(void);
298 extern u8 __dtb_dt_begin[];     /* embedded device tree blob */
299 int set_cpu_clk_info(void);
300 int mdm_init(void);
301 int print_cpuinfo(void);
302 int update_flash_size(int flash_size);
303 int arch_early_init_r(void);
304
305 /**
306  * arch_fsp_init() - perform firmware support package init
307  *
308  * Where U-Boot relies on binary blobs to handle part of the system init, this
309  * function can be used to set up the blobs. This is used on some Intel
310  * platforms.
311  */
312 int arch_fsp_init(void);
313
314 /**
315  * arch_cpu_init_dm() - init CPU after driver model is available
316  *
317  * This is called immediately after driver model is available before
318  * relocation. This is similar to arch_cpu_init() but is able to reference
319  * devices
320  *
321  * @return 0 if OK, -ve on error
322  */
323 int arch_cpu_init_dm(void);
324
325 /**
326  * Reserve all necessary stacks
327  *
328  * This is used in generic board init sequence in common/board_f.c. Each
329  * architecture could provide this function to tailor the required stacks.
330  *
331  * On entry gd->start_addr_sp is pointing to the suggested top of the stack.
332  * The callee ensures gd->start_add_sp is 16-byte aligned, so architectures
333  * require only this can leave it untouched.
334  *
335  * On exit gd->start_addr_sp and gd->irq_sp should be set to the respective
336  * positions of the stack. The stack pointer(s) will be set to this later.
337  * gd->irq_sp is only required, if the architecture needs it.
338  *
339  * @return 0 if no error
340  */
341 __weak int arch_reserve_stacks(void);
342
343 /**
344  * Show the DRAM size in a board-specific way
345  *
346  * This is used by boards to display DRAM information in their own way.
347  *
348  * @param size  Size of DRAM (which should be displayed along with other info)
349  */
350 void board_show_dram(phys_size_t size);
351
352 /**
353  * arch_fixup_fdt() - Write arch-specific information to fdt
354  *
355  * Defined in arch/$(ARCH)/lib/bootm-fdt.c
356  *
357  * @blob:       FDT blob to write to
358  * @return 0 if ok, or -ve FDT_ERR_... on failure
359  */
360 int arch_fixup_fdt(void *blob);
361
362 /* common/flash.c */
363 void flash_perror (int);
364
365 /* common/cmd_source.c */
366 int     source (ulong addr, const char *fit_uname);
367
368 extern ulong load_addr;         /* Default Load Address */
369 extern ulong save_addr;         /* Default Save Address */
370 extern ulong save_size;         /* Default Save Size */
371
372 /* common/cmd_net.c */
373 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
374
375 /* common/cmd_fat.c */
376 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
377
378 /* common/cmd_ext2.c */
379 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
380
381 /* common/cmd_nvedit.c */
382 int     env_init     (void);
383 void    env_relocate (void);
384 int     envmatch     (uchar *, int);
385
386 /* Avoid unfortunate conflict with libc's getenv() */
387 #ifdef CONFIG_SANDBOX
388 #define getenv uboot_getenv
389 #endif
390 char    *getenv      (const char *);
391 int     getenv_f     (const char *name, char *buf, unsigned len);
392 ulong getenv_ulong(const char *name, int base, ulong default_val);
393
394 /**
395  * getenv_hex() - Return an environment variable as a hex value
396  *
397  * Decode an environment as a hex number (it may or may not have a 0x
398  * prefix). If the environment variable cannot be found, or does not start
399  * with hex digits, the default value is returned.
400  *
401  * @varname:            Variable to decode
402  * @default_val:        Value to return on error
403  */
404 ulong getenv_hex(const char *varname, ulong default_val);
405
406 /*
407  * Read an environment variable as a boolean
408  * Return -1 if variable does not exist (default to true)
409  */
410 int getenv_yesno(const char *var);
411 int     saveenv      (void);
412 int     setenv       (const char *, const char *);
413 int setenv_ulong(const char *varname, ulong value);
414 int setenv_hex(const char *varname, ulong value);
415 /**
416  * setenv_addr - Set an environment variable to an address in hex
417  *
418  * @varname:    Environment variable to set
419  * @addr:       Value to set it to
420  * @return 0 if ok, 1 on error
421  */
422 static inline int setenv_addr(const char *varname, const void *addr)
423 {
424         return setenv_hex(varname, (ulong)addr);
425 }
426
427 #ifdef CONFIG_ARM
428 # include <asm/mach-types.h>
429 # include <asm/setup.h>
430 # include <asm/u-boot-arm.h>    /* ARM version to be fixed! */
431 #endif /* CONFIG_ARM */
432 #ifdef CONFIG_X86               /* x86 version to be fixed! */
433 # include <asm/u-boot-x86.h>
434 #endif /* CONFIG_X86 */
435 #ifdef CONFIG_SANDBOX
436 # include <asm/u-boot-sandbox.h>        /* TODO(sjg) what needs to be fixed? */
437 #endif
438 #ifdef CONFIG_NDS32
439 # include <asm/mach-types.h>
440 # include <asm/setup.h>
441 # include <asm/u-boot-nds32.h>
442 #endif /* CONFIG_NDS32 */
443 #ifdef CONFIG_MIPS
444 # include <asm/u-boot-mips.h>
445 #endif /* CONFIG_MIPS */
446 #ifdef CONFIG_ARC
447 # include <asm/u-boot-arc.h>
448 #endif /* CONFIG_ARC */
449
450 #ifdef CONFIG_AUTO_COMPLETE
451 int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
452 #endif
453 int get_env_id (void);
454
455 void    pci_init      (void);
456 void    pci_init_board(void);
457
458 #if defined(CONFIG_PCI) && defined(CONFIG_4xx)
459     int    pci_pre_init        (struct pci_controller *);
460     int    is_pci_host         (struct pci_controller *);
461 #endif
462
463 #if defined(CONFIG_PCI) && (defined(CONFIG_440) || defined(CONFIG_405EX))
464 #   if defined(CONFIG_SYS_PCI_TARGET_INIT)
465         void    pci_target_init      (struct pci_controller *);
466 #   endif
467 #   if defined(CONFIG_SYS_PCI_MASTER_INIT)
468         void    pci_master_init      (struct pci_controller *);
469 #   endif
470 #if defined(CONFIG_440SPE) || \
471     defined(CONFIG_460EX) || defined(CONFIG_460GT) || \
472     defined(CONFIG_405EX)
473    void pcie_setup_hoses(int busno);
474 #endif
475 #endif
476
477 int     misc_init_f   (void);
478 int     misc_init_r   (void);
479
480 /* common/exports.c */
481 void    jumptable_init(void);
482
483 /* common/kallsysm.c */
484 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
485
486 /* api/api.c */
487 void    api_init (void);
488
489 /* common/memsize.c */
490 long    get_ram_size  (long *, long);
491 phys_size_t get_effective_memsize(void);
492
493 /* $(BOARD)/$(BOARD).c */
494 void    reset_phy     (void);
495 void    fdc_hw_init   (void);
496
497 /* $(BOARD)/eeprom.c */
498 void eeprom_init  (int bus);
499 int  eeprom_read  (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
500 int  eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
501
502 /*
503  * Set this up regardless of board
504  * type, to prevent errors.
505  */
506 #if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
507 # define CONFIG_SYS_DEF_EEPROM_ADDR 0
508 #else
509 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
510 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
511 #endif
512 #endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
513
514 #if defined(CONFIG_SPI)
515 extern void spi_init_f (void);
516 extern void spi_init_r (void);
517 extern ssize_t spi_read  (uchar *, int, uchar *, int);
518 extern ssize_t spi_write (uchar *, int, uchar *, int);
519 #endif
520
521 /* $(BOARD)/$(BOARD).c */
522 int board_early_init_f (void);
523 int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */
524 int board_late_init (void);
525 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
526 int board_early_init_r (void);
527 void board_poweroff (void);
528
529 #if defined(CONFIG_SYS_DRAM_TEST)
530 int testdram(void);
531 #endif /* CONFIG_SYS_DRAM_TEST */
532
533 /* $(CPU)/start.S */
534 #if defined(CONFIG_5xx) || \
535     defined(CONFIG_8xx)
536 uint    get_immr      (uint);
537 #endif
538 #if defined(CONFIG_MPC5xxx)
539 uint    get_svr       (void);
540 #endif
541 uint    get_pvr       (void);
542 uint    get_svr       (void);
543 uint    rd_ic_cst     (void);
544 void    wr_ic_cst     (uint);
545 void    wr_ic_adr     (uint);
546 uint    rd_dc_cst     (void);
547 void    wr_dc_cst     (uint);
548 void    wr_dc_adr     (uint);
549 int     icache_status (void);
550 void    icache_enable (void);
551 void    icache_disable(void);
552 int     dcache_status (void);
553 void    dcache_enable (void);
554 void    dcache_disable(void);
555 void    mmu_disable(void);
556 #if defined(CONFIG_ARM)
557 void    relocate_code(ulong);
558 #else
559 void    relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
560 #endif
561 ulong   get_endaddr   (void);
562 void    trap_init     (ulong);
563 #if defined (CONFIG_4xx)        || \
564     defined (CONFIG_MPC5xxx)    || \
565     defined (CONFIG_MPC85xx)    || \
566     defined (CONFIG_MPC86xx)    || \
567     defined (CONFIG_MPC83xx)
568 unsigned char   in8(unsigned int);
569 void            out8(unsigned int, unsigned char);
570 unsigned short  in16(unsigned int);
571 unsigned short  in16r(unsigned int);
572 void            out16(unsigned int, unsigned short value);
573 void            out16r(unsigned int, unsigned short value);
574 unsigned long   in32(unsigned int);
575 unsigned long   in32r(unsigned int);
576 void            out32(unsigned int, unsigned long value);
577 void            out32r(unsigned int, unsigned long value);
578 void            ppcDcbf(unsigned long value);
579 void            ppcDcbi(unsigned long value);
580 void            ppcSync(void);
581 void            ppcDcbz(unsigned long value);
582 #endif
583 #if defined (CONFIG_MICROBLAZE)
584 unsigned short  in16(unsigned int);
585 void            out16(unsigned int, unsigned short value);
586 #endif
587
588 #if defined (CONFIG_MPC83xx)
589 void            ppcDWload(unsigned int *addr, unsigned int *ret);
590 void            ppcDWstore(unsigned int *addr, unsigned int *value);
591 void disable_addr_trans(void);
592 void enable_addr_trans(void);
593 #if defined(CONFIG_DDR_ECC) && !defined(CONFIG_ECC_INIT_VIA_DDRCONTROLLER)
594 void ddr_enable_ecc(unsigned int dram_size);
595 #endif
596 #endif
597
598 /* $(CPU)/cpu.c */
599 static inline int cpumask_next(int cpu, unsigned int mask)
600 {
601         for (cpu++; !((1 << cpu) & mask); cpu++)
602                 ;
603
604         return cpu;
605 }
606
607 #define for_each_cpu(iter, cpu, num_cpus, mask) \
608         for (iter = 0, cpu = cpumask_next(-1, mask); \
609                 iter < num_cpus; \
610                 iter++, cpu = cpumask_next(cpu, mask)) \
611
612 int     cpu_numcores  (void);
613 int     cpu_num_dspcores(void);
614 u32     cpu_mask      (void);
615 u32     cpu_dsp_mask(void);
616 int     is_core_valid (unsigned int);
617
618 /**
619  * arch_cpu_init() - basic cpu-dependent setup for an architecture
620  *
621  * This is called after early malloc is available. It should handle any
622  * CPU- or SoC- specific init needed to continue the init sequence. See
623  * board_f.c for where it is called. If this is not provided, a default
624  * version (which does nothing) will be used.
625  */
626 int arch_cpu_init(void);
627
628 int     checkcpu      (void);
629 int     checkicache   (void);
630 int     checkdcache   (void);
631 void    upmconfig     (unsigned int, unsigned int *, unsigned int);
632 ulong   get_tbclk     (void);
633 void    reset_misc    (void);
634 void    reset_cpu     (ulong addr);
635 void ft_cpu_setup(void *blob, bd_t *bd);
636 void ft_pci_setup(void *blob, bd_t *bd);
637
638 void smp_set_core_boot_addr(unsigned long addr, int corenr);
639 void smp_kick_all_cpus(void);
640
641 /* $(CPU)/serial.c */
642 int     serial_init   (void);
643 void    serial_setbrg (void);
644 void    serial_putc   (const char);
645 void    serial_putc_raw(const char);
646 void    serial_puts   (const char *);
647 int     serial_getc   (void);
648 int     serial_tstc   (void);
649
650 /* These versions take a stdio_dev pointer */
651 struct stdio_dev;
652 int serial_stub_getc(struct stdio_dev *sdev);
653 int serial_stub_tstc(struct stdio_dev *sdev);
654
655 /* $(CPU)/speed.c */
656 int     get_clocks (void);
657 #if defined(CONFIG_MPC5xxx)
658 int     prt_mpc5xxx_clks (void);
659 #endif
660 #ifdef CONFIG_4xx
661 ulong   get_OPB_freq (void);
662 ulong   get_PCI_freq (void);
663 #endif
664 #if defined(CONFIG_S3C24X0) || \
665     defined(CONFIG_LH7A40X) || \
666     defined(CONFIG_EP93XX)
667 ulong   get_FCLK (void);
668 ulong   get_HCLK (void);
669 ulong   get_PCLK (void);
670 ulong   get_UCLK (void);
671 #endif
672 #if defined(CONFIG_LH7A40X)
673 ulong   get_PLLCLK (void);
674 #endif
675 #if defined(CONFIG_IMX)
676 ulong get_systemPLLCLK(void);
677 ulong get_FCLK(void);
678 ulong get_HCLK(void);
679 ulong get_BCLK(void);
680 ulong get_PERCLK1(void);
681 ulong get_PERCLK2(void);
682 ulong get_PERCLK3(void);
683 #endif
684 ulong   get_bus_freq  (ulong);
685 int get_serial_clock(void);
686
687 #if defined(CONFIG_MPC85xx)
688 typedef MPC85xx_SYS_INFO sys_info_t;
689 void    get_sys_info  ( sys_info_t * );
690 void ft_fixup_cpu(void *, u64);
691 void ft_fixup_num_cores(void *);
692 #endif
693 #if defined(CONFIG_MPC86xx)
694 typedef MPC86xx_SYS_INFO sys_info_t;
695 void   get_sys_info  ( sys_info_t * );
696 static inline ulong get_ddr_freq(ulong dummy)
697 {
698         return get_bus_freq(dummy);
699 }
700 #else
701 ulong get_ddr_freq(ulong);
702 #endif
703
704 #if defined(CONFIG_4xx)
705 #  if defined(CONFIG_440)
706 #       if defined(CONFIG_440SPE)
707          unsigned long determine_sysper(void);
708          unsigned long determine_pci_clock_per(void);
709 #       endif
710 #  endif
711 typedef PPC4xx_SYS_INFO sys_info_t;
712 int     ppc440spe_revB(void);
713 void    get_sys_info  ( sys_info_t * );
714 #endif
715
716 /* $(CPU)/cpu_init.c */
717 #if defined(CONFIG_8xx) || defined(CONFIG_MPC8260)
718 void    cpu_init_f    (volatile immap_t *immr);
719 #endif
720 #if defined(CONFIG_4xx) || defined(CONFIG_MCF52x2) || defined(CONFIG_MPC86xx)
721 void    cpu_init_f    (void);
722 #endif
723 #ifdef CONFIG_MPC85xx
724 ulong cpu_init_f(void);
725 #endif
726
727 int     cpu_init_r    (void);
728
729 /* $(CPU)/interrupts.c */
730 int     interrupt_init     (void);
731 void    timer_interrupt    (struct pt_regs *);
732 void    external_interrupt (struct pt_regs *);
733 void    irq_install_handler(int, interrupt_handler_t *, void *);
734 void    irq_free_handler   (int);
735 void    reset_timer        (void);
736
737 /* Return value of monotonic microsecond timer */
738 unsigned long timer_get_us(void);
739
740 void    enable_interrupts  (void);
741 int     disable_interrupts (void);
742
743 /* $(CPU)/.../commproc.c */
744 int     dpram_init (void);
745 uint    dpram_base(void);
746 uint    dpram_base_align(uint align);
747 uint    dpram_alloc(uint size);
748 uint    dpram_alloc_align(uint size,uint align);
749 void    bootcount_store (ulong);
750 ulong   bootcount_load (void);
751 #define BOOTCOUNT_MAGIC         0xB001C041
752
753 /* $(CPU)/.../<eth> */
754 void mii_init (void);
755
756 /* $(CPU)/.../lcd.c */
757 ulong   lcd_setmem (ulong);
758
759 /* $(CPU)/.../video.c */
760 ulong   video_setmem (ulong);
761
762 /* arch/$(ARCH)/lib/cache.c */
763 void    enable_caches(void);
764 void    flush_cache   (unsigned long, unsigned long);
765 void    flush_dcache_all(void);
766 void    flush_dcache_range(unsigned long start, unsigned long stop);
767 void    invalidate_dcache_range(unsigned long start, unsigned long stop);
768 void    invalidate_dcache_all(void);
769 void    invalidate_icache_all(void);
770
771 enum {
772         /* Disable caches (else flush caches but leave them active) */
773         CBL_DISABLE_CACHES              = 1 << 0,
774         CBL_SHOW_BOOTSTAGE_REPORT       = 1 << 1,
775
776         CBL_ALL                         = 3,
777 };
778
779 /**
780  * Clean up ready for linux
781  *
782  * @param flags         Flags to control what is done
783  */
784 int cleanup_before_linux_select(int flags);
785
786 /* arch/$(ARCH)/lib/ticks.S */
787 uint64_t get_ticks(void);
788 void    wait_ticks    (unsigned long);
789
790 /* arch/$(ARCH)/lib/time.c */
791 ulong   usec2ticks    (unsigned long usec);
792 ulong   ticks2usec    (unsigned long ticks);
793
794 /* lib/gunzip.c */
795 int gunzip(void *, int, unsigned char *, unsigned long *);
796 int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
797                                                 int stoponerr, int offset);
798
799 /**
800  * gzwrite progress indicators: defined weak to allow board-specific
801  * overrides:
802  *
803  *      gzwrite_progress_init called on startup
804  *      gzwrite_progress called during decompress/write loop
805  *      gzwrite_progress_finish called at end of loop to
806  *              indicate success (retcode=0) or failure
807  */
808 void gzwrite_progress_init(u64 expected_size);
809
810 void gzwrite_progress(int iteration,
811                      u64 bytes_written,
812                      u64 total_bytes);
813
814 void gzwrite_progress_finish(int retcode,
815                              u64 totalwritten,
816                              u64 totalsize,
817                              u32 expected_crc,
818                              u32 calculated_crc);
819
820 /**
821  * decompress and write gzipped image from memory to block device
822  *
823  * @param       src             compressed image address
824  * @param       len             compressed image length in bytes
825  * @param       dev             block device descriptor
826  * @param       szwritebuf      bytes per write (pad to erase size)
827  * @param       startoffs       offset in bytes of first write
828  * @param       szexpected      expected uncompressed length
829  *                              may be zero to use gzip trailer
830  *                              for files under 4GiB
831  */
832 int gzwrite(unsigned char *src, int len,
833             struct blk_desc *dev,
834             unsigned long szwritebuf,
835             u64 startoffs,
836             u64 szexpected);
837
838 /* lib/lz4_wrapper.c */
839 int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn);
840
841 /* lib/qsort.c */
842 void qsort(void *base, size_t nmemb, size_t size,
843            int(*compar)(const void *, const void *));
844 int strcmp_compar(const void *, const void *);
845
846 /* lib/uuid.c */
847 #include <uuid.h>
848
849 /* lib/vsprintf.c */
850 #include <vsprintf.h>
851
852 /* lib/strmhz.c */
853 char *  strmhz(char *buf, unsigned long hz);
854
855 /* lib/crc32.c */
856 #include <u-boot/crc.h>
857
858 /* lib/rand.c */
859 #define RAND_MAX -1U
860 void srand(unsigned int seed);
861 unsigned int rand(void);
862 unsigned int rand_r(unsigned int *seedp);
863
864 /*
865  * STDIO based functions (can always be used)
866  */
867 /* serial stuff */
868 int     serial_printf (const char *fmt, ...)
869                 __attribute__ ((format (__printf__, 1, 2)));
870 /* stdin */
871 int     getc(void);
872 int     tstc(void);
873
874 /* stdout */
875 #if !defined(CONFIG_SPL_BUILD) || \
876         (defined(CONFIG_TPL_BUILD) && defined(CONFIG_TPL_SERIAL_SUPPORT)) || \
877         (defined(CONFIG_SPL_BUILD) && !defined(CONFIG_TPL_BUILD) && \
878                 defined(CONFIG_SPL_SERIAL_SUPPORT))
879 void    putc(const char c);
880 void    puts(const char *s);
881 int     printf(const char *fmt, ...)
882                 __attribute__ ((format (__printf__, 1, 2)));
883 int     vprintf(const char *fmt, va_list args);
884 #else
885 #define putc(...) do { } while (0)
886 #define puts(...) do { } while (0)
887 #define printf(...) do { } while (0)
888 #define vprintf(...) do { } while (0)
889 #endif
890
891 /* stderr */
892 #define eputc(c)                fputc(stderr, c)
893 #define eputs(s)                fputs(stderr, s)
894 #define eprintf(fmt,args...)    fprintf(stderr,fmt ,##args)
895
896 /*
897  * FILE based functions (can only be used AFTER relocation!)
898  */
899 #define stdin           0
900 #define stdout          1
901 #define stderr          2
902 #define MAX_FILES       3
903
904 int     fprintf(int file, const char *fmt, ...)
905                 __attribute__ ((format (__printf__, 2, 3)));
906 void    fputs(int file, const char *s);
907 void    fputc(int file, const char c);
908 int     ftstc(int file);
909 int     fgetc(int file);
910
911 /* lib/gzip.c */
912 int gzip(void *dst, unsigned long *lenp,
913                 unsigned char *src, unsigned long srclen);
914 int zzip(void *dst, unsigned long *lenp, unsigned char *src,
915                 unsigned long srclen, int stoponerr,
916                 int (*func)(unsigned long, unsigned long));
917
918 /* lib/net_utils.c */
919 #include <net.h>
920 static inline struct in_addr getenv_ip(char *var)
921 {
922         return string_to_ip(getenv(var));
923 }
924
925 int     pcmcia_init (void);
926
927 #ifdef CONFIG_LED_STATUS
928 # include <status_led.h>
929 #endif
930
931 #include <bootstage.h>
932
933 #ifdef CONFIG_SHOW_ACTIVITY
934 void show_activity(int arg);
935 #endif
936
937 /* Multicore arch functions */
938 #ifdef CONFIG_MP
939 int cpu_status(int nr);
940 int cpu_reset(int nr);
941 int cpu_disable(int nr);
942 int cpu_release(int nr, int argc, char * const argv[]);
943 #endif
944
945 #else   /* __ASSEMBLY__ */
946
947 /* Drop a C type modifier (like in 3UL) for constants used in assembly. */
948 #define _AC(X, Y)       X
949
950 #endif  /* __ASSEMBLY__ */
951
952 #ifdef CONFIG_PPC
953 /*
954  * Has to be included outside of the #ifndef __ASSEMBLY__ section.
955  * Otherwise might lead to compilation errors in assembler files.
956  */
957 #include <asm/cache.h>
958 #endif
959
960 /* Put only stuff here that the assembler can digest */
961
962 /* Declare an unsigned long constant digestable both by C and an assembler. */
963 #define UL(x)           _AC(x, UL)
964
965 #ifdef CONFIG_POST
966 #define CONFIG_HAS_POST
967 #ifndef CONFIG_POST_ALT_LIST
968 #define CONFIG_POST_STD_LIST
969 #endif
970 #endif
971
972 #ifdef CONFIG_INIT_CRITICAL
973 #error CONFIG_INIT_CRITICAL is deprecated!
974 #error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
975 #endif
976
977 #define ROUND(a,b)              (((a) + (b) - 1) & ~((b) - 1))
978
979 /*
980  * check_member() - Check the offset of a structure member
981  *
982  * @structure:  Name of structure (e.g. global_data)
983  * @member:     Name of member (e.g. baudrate)
984  * @offset:     Expected offset in bytes
985  */
986 #define check_member(structure, member, offset) _Static_assert( \
987         offsetof(struct structure, member) == offset, \
988         "`struct " #structure "` offset for `" #member "` is not " #offset)
989
990 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
991 #ifdef CONFIG_EFI_STUB
992 #define ll_boot_init()  false
993 #else
994 #define ll_boot_init()  true
995 #endif
996
997 /* Pull in stuff for the build system */
998 #ifdef DO_DEPS_ONLY
999 # include <environment.h>
1000 #endif
1001
1002 #endif  /* __COMMON_H_ */