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