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