2 * (C) Copyright 2000-2009
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 * SPDX-License-Identifier: GPL-2.0+
11 #ifndef __ASSEMBLY__ /* put C only stuff in this section */
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;
18 /* Allow sharing constants with type modifiers between C and assembly. */
19 #define _AC(X, Y) (X##Y)
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>
32 #include <linux/kernel.h>
38 /* Bring in printf format macros if inttypes.h is included */
39 #define __STDC_FORMAT_MACROS
42 #define CONFIG_SYS_SUPPORT_64BIT_DATA
51 #ifdef CONFIG_SPL_BUILD
57 /* Define this at the top of a file to add a prefix to debug messages */
59 #define pr_fmt(fmt) fmt
63 * Output a debug text when condition "cond" is met. The "cond" should be
64 * computed by a preprocessor in the best case, allowing for the best
67 #define debug_cond(cond, fmt, args...) \
70 printf(pr_fmt(fmt), ##args); \
73 /* Show a message if DEBUG is defined in a file */
74 #define debug(fmt, args...) \
75 debug_cond(_DEBUG, fmt, ##args)
77 /* Show a message if not in SPL */
78 #define warn_non_spl(fmt, args...) \
79 debug_cond(!_SPL_BUILD, fmt, ##args)
82 * An assertion is run-time check done in debug mode only. If DEBUG is not
83 * defined then it is skipped. If DEBUG is defined and the assertion fails,
84 * then it calls panic*( which may or may not reset/halt U-Boot (see
85 * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
86 * before release, and after release it is hoped that they don't matter. But
87 * in any case these failing assertions cannot be fixed with a reset (which
88 * may just do the same assertion again).
90 void __assert_fail(const char *assertion, const char *file, unsigned line,
91 const char *function);
93 ({ if (!(x) && _DEBUG) \
94 __assert_fail(#x, __FILE__, __LINE__, __func__); })
96 #define error(fmt, args...) do { \
97 printf("ERROR: " pr_fmt(fmt) "\nat %s:%d/%s()\n", \
98 ##args, __FILE__, __LINE__, __func__); \
103 printf("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __FUNCTION__); \
106 #define BUG_ON(condition) do { if (unlikely((condition)!=0)) BUG(); } while(0)
109 typedef void (interrupt_handler_t)(void *);
111 #include <asm/u-boot.h> /* boot information for Linux kernel */
112 #include <asm/global_data.h> /* global data used for startup functions */
114 #if defined(CONFIG_ENV_IS_EMBEDDED)
115 #define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
116 #elif ( ((CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) < CONFIG_SYS_MONITOR_BASE) || \
117 (CONFIG_ENV_ADDR >= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) ) || \
118 defined(CONFIG_ENV_IS_IN_NVRAM)
119 #define TOTAL_MALLOC_LEN (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
121 #define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
125 * Function Prototypes
130 * dram_init_banksize() - Set up DRAM bank sizes
132 * This can be implemented by boards to set up the DRAM bank information in
133 * gd->bd->bi_dram(). It is called just before relocation, after dram_init()
136 * If this is not provided, a default implementation will try to set up a
137 * single bank. It will do this if CONFIG_NR_DRAM_BANKS and
138 * CONFIG_SYS_SDRAM_BASE are set. The bank will have a start address of
139 * CONFIG_SYS_SDRAM_BASE and the size will be determined by a call to
140 * get_effective_memsize().
142 * @return 0 if OK, -ve on error
144 int dram_init_banksize(void);
146 void hang (void) __attribute__ ((noreturn));
148 int timer_init(void);
151 #include <display_options.h>
154 void main_loop (void);
155 int run_command(const char *cmd, int flag);
156 int run_command_repeatable(const char *cmd, int flag);
159 * Run a list of commands separated by ; or even \0
161 * Note that if 'len' is not -1, then the command does not need to be nul
162 * terminated, Memory will be allocated for the command in that case.
164 * @param cmd List of commands to run, each separated bu semicolon
165 * @param len Length of commands excluding terminator if known (-1 if not)
166 * @param flag Execution flags (CMD_FLAG_...)
167 * @return 0 on success, or != 0 on error.
169 int run_command_list(const char *cmd, int len, int flag);
171 /* arch/$(ARCH)/lib/board.c */
172 void board_init_f(ulong);
173 void board_init_r(gd_t *, ulong) __attribute__ ((noreturn));
176 * ulong board_init_f_alloc_reserve - allocate reserved area
178 * This function is called by each architecture very early in the start-up
179 * code to allow the C runtime to reserve space on the stack for writable
180 * 'globals' such as GD and the malloc arena.
182 * @top: top of the reserve area, growing down.
183 * @return: bottom of reserved area
185 ulong board_init_f_alloc_reserve(ulong top);
188 * board_init_f_init_reserve - initialize the reserved area(s)
190 * This function is called once the C runtime has allocated the reserved
191 * area on the stack. It must initialize the GD at the base of that area.
193 * @base: top from which reservation was done
195 void board_init_f_init_reserve(ulong base);
198 * arch_setup_gd() - Set up the global_data pointer
200 * This pointer is special in some architectures and cannot easily be assigned
201 * to. For example on x86 it is implemented by adding a specific record to its
202 * Global Descriptor Table! So we we provide a function to carry out this task.
203 * For most architectures this can simply be:
207 * @gd_ptr: Pointer to global data
209 void arch_setup_gd(gd_t *gd_ptr);
211 int checkboard(void);
212 int show_board_info(void);
213 int checkflash(void);
215 int last_stage_init(void);
216 extern ulong monitor_flash_len;
217 int mac_read_from_eeprom(void);
218 extern u8 __dtb_dt_begin[]; /* embedded device tree blob */
219 int set_cpu_clk_info(void);
221 int print_cpuinfo(void);
222 int update_flash_size(int flash_size);
223 int arch_early_init_r(void);
226 * setup_board_extra() - Fill in extra details in the bd_t structure
228 * @return 0 if OK, -ve on error
230 int setup_board_extra(void);
233 * arch_fsp_init() - perform firmware support package init
235 * Where U-Boot relies on binary blobs to handle part of the system init, this
236 * function can be used to set up the blobs. This is used on some Intel
239 int arch_fsp_init(void);
242 * arch_cpu_init_dm() - init CPU after driver model is available
244 * This is called immediately after driver model is available before
245 * relocation. This is similar to arch_cpu_init() but is able to reference
248 * @return 0 if OK, -ve on error
250 int arch_cpu_init_dm(void);
253 * Reserve all necessary stacks
255 * This is used in generic board init sequence in common/board_f.c. Each
256 * architecture could provide this function to tailor the required stacks.
258 * On entry gd->start_addr_sp is pointing to the suggested top of the stack.
259 * The callee ensures gd->start_add_sp is 16-byte aligned, so architectures
260 * require only this can leave it untouched.
262 * On exit gd->start_addr_sp and gd->irq_sp should be set to the respective
263 * positions of the stack. The stack pointer(s) will be set to this later.
264 * gd->irq_sp is only required, if the architecture needs it.
266 * @return 0 if no error
268 __weak int arch_reserve_stacks(void);
271 * Show the DRAM size in a board-specific way
273 * This is used by boards to display DRAM information in their own way.
275 * @param size Size of DRAM (which should be displayed along with other info)
277 void board_show_dram(phys_size_t size);
280 * arch_fixup_fdt() - Write arch-specific information to fdt
282 * Defined in arch/$(ARCH)/lib/bootm-fdt.c
284 * @blob: FDT blob to write to
285 * @return 0 if ok, or -ve FDT_ERR_... on failure
287 int arch_fixup_fdt(void *blob);
289 int reserve_mmu(void);
291 void flash_perror (int);
293 /* common/cmd_source.c */
294 int source (ulong addr, const char *fit_uname);
296 extern ulong load_addr; /* Default Load Address */
297 extern ulong save_addr; /* Default Save Address */
298 extern ulong save_size; /* Default Save Size */
300 /* common/cmd_net.c */
301 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
303 /* common/cmd_fat.c */
304 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
306 /* common/cmd_ext2.c */
307 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
309 /* common/cmd_nvedit.c */
311 void env_relocate (void);
312 int envmatch (uchar *, int);
314 /* Avoid unfortunate conflict with libc's getenv() */
315 #ifdef CONFIG_SANDBOX
316 #define getenv uboot_getenv
318 char *getenv (const char *);
319 int getenv_f (const char *name, char *buf, unsigned len);
320 ulong getenv_ulong(const char *name, int base, ulong default_val);
323 * getenv_hex() - Return an environment variable as a hex value
325 * Decode an environment as a hex number (it may or may not have a 0x
326 * prefix). If the environment variable cannot be found, or does not start
327 * with hex digits, the default value is returned.
329 * @varname: Variable to decode
330 * @default_val: Value to return on error
332 ulong getenv_hex(const char *varname, ulong default_val);
335 * Read an environment variable as a boolean
336 * Return -1 if variable does not exist (default to true)
338 int getenv_yesno(const char *var);
341 * env_set() - set an environment variable
343 * This sets or deletes the value of an environment variable. For setting the
344 * value the variable is created if it does not already exist.
346 * @varname: Variable to adjust
347 * @value: Value to set for the variable, or NULL or "" to delete the variable
348 * @return 0 if OK, 1 on error
350 int env_set(const char *varname, const char *value);
353 * env_set_ulong() - set an environment variable to an integer
355 * @varname: Variable to adjust
356 * @value: Value to set for the variable (will be converted to a string)
357 * @return 0 if OK, 1 on error
359 int env_set_ulong(const char *varname, ulong value);
362 * env_set_hex() - set an environment variable to a hex value
364 * @varname: Variable to adjust
365 * @value: Value to set for the variable (will be converted to a hex string)
366 * @return 0 if OK, 1 on error
368 int env_set_hex(const char *varname, ulong value);
371 * env_set_addr - Set an environment variable to an address in hex
373 * @varname: Environment variable to set
374 * @addr: Value to set it to
375 * @return 0 if ok, 1 on error
377 static inline int env_set_addr(const char *varname, const void *addr)
379 return env_set_hex(varname, (ulong)addr);
382 #ifdef CONFIG_AUTO_COMPLETE
383 int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
385 int get_env_id (void);
387 void pci_init (void);
388 void pci_init_board(void);
390 #if defined(CONFIG_DTB_RESELECT)
391 int embedded_dtb_select(void);
394 int misc_init_f (void);
395 int misc_init_r (void);
397 /* common/exports.c */
398 void jumptable_init(void);
400 /* common/kallsysm.c */
401 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
403 /* common/memsize.c */
404 long get_ram_size (long *, long);
405 phys_size_t get_effective_memsize(void);
407 /* $(BOARD)/$(BOARD).c */
408 void reset_phy (void);
409 void fdc_hw_init (void);
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);
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
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)
427 * Set this up regardless of board
428 * type, to prevent errors.
430 #if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
431 # define CONFIG_SYS_DEF_EEPROM_ADDR 0
433 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
434 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
436 #endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
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);
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);
453 #if defined(CONFIG_SYS_DRAM_TEST)
455 #endif /* CONFIG_SYS_DRAM_TEST */
458 int icache_status (void);
459 void icache_enable (void);
460 void icache_disable(void);
461 int dcache_status (void);
462 void dcache_enable (void);
463 void dcache_disable(void);
464 void mmu_disable(void);
465 #if defined(CONFIG_ARM)
466 void relocate_code(ulong);
468 void relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
470 ulong get_endaddr (void);
471 void trap_init (ulong);
474 static inline int cpumask_next(int cpu, unsigned int mask)
476 for (cpu++; !((1 << cpu) & mask); cpu++)
482 #define for_each_cpu(iter, cpu, num_cpus, mask) \
483 for (iter = 0, cpu = cpumask_next(-1, mask); \
485 iter++, cpu = cpumask_next(cpu, mask)) \
487 int cpu_numcores (void);
488 int cpu_num_dspcores(void);
490 u32 cpu_dsp_mask(void);
491 int is_core_valid (unsigned int);
494 * arch_cpu_init() - basic cpu-dependent setup for an architecture
496 * This is called after early malloc is available. It should handle any
497 * CPU- or SoC- specific init needed to continue the init sequence. See
498 * board_f.c for where it is called. If this is not provided, a default
499 * version (which does nothing) will be used.
501 int arch_cpu_init(void);
504 int checkicache (void);
505 int checkdcache (void);
506 void upmconfig (unsigned int, unsigned int *, unsigned int);
507 ulong get_tbclk (void);
508 void reset_misc (void);
509 void reset_cpu (ulong addr);
510 void ft_cpu_setup(void *blob, bd_t *bd);
511 void ft_pci_setup(void *blob, bd_t *bd);
513 void smp_set_core_boot_addr(unsigned long addr, int corenr);
514 void smp_kick_all_cpus(void);
516 /* $(CPU)/serial.c */
517 int serial_init (void);
518 void serial_setbrg (void);
519 void serial_putc (const char);
520 void serial_putc_raw(const char);
521 void serial_puts (const char *);
522 int serial_getc (void);
523 int serial_tstc (void);
526 int get_clocks (void);
527 ulong get_bus_freq (ulong);
528 int get_serial_clock(void);
530 int cpu_init_r (void);
532 /* $(CPU)/interrupts.c */
533 int interrupt_init (void);
534 void timer_interrupt (struct pt_regs *);
535 void external_interrupt (struct pt_regs *);
536 void irq_install_handler(int, interrupt_handler_t *, void *);
537 void irq_free_handler (int);
538 void reset_timer (void);
540 /* Return value of monotonic microsecond timer */
541 unsigned long timer_get_us(void);
543 void enable_interrupts (void);
544 int disable_interrupts (void);
546 /* $(CPU)/.../commproc.c */
547 int dpram_init (void);
548 uint dpram_base(void);
549 uint dpram_base_align(uint align);
550 uint dpram_alloc(uint size);
551 uint dpram_alloc_align(uint size,uint align);
552 void bootcount_store (ulong);
553 ulong bootcount_load (void);
554 #define BOOTCOUNT_MAGIC 0xB001C041
556 /* $(CPU)/.../<eth> */
557 void mii_init (void);
559 /* $(CPU)/.../lcd.c */
560 ulong lcd_setmem (ulong);
562 /* $(CPU)/.../video.c */
563 ulong video_setmem (ulong);
565 /* arch/$(ARCH)/lib/cache.c */
566 void enable_caches(void);
567 void flush_cache (unsigned long, unsigned long);
568 void flush_dcache_all(void);
569 void flush_dcache_range(unsigned long start, unsigned long stop);
570 void invalidate_dcache_range(unsigned long start, unsigned long stop);
571 void invalidate_dcache_all(void);
572 void invalidate_icache_all(void);
575 /* Disable caches (else flush caches but leave them active) */
576 CBL_DISABLE_CACHES = 1 << 0,
577 CBL_SHOW_BOOTSTAGE_REPORT = 1 << 1,
583 * Clean up ready for linux
585 * @param flags Flags to control what is done
587 int cleanup_before_linux_select(int flags);
589 /* arch/$(ARCH)/lib/ticks.S */
590 uint64_t get_ticks(void);
591 void wait_ticks (unsigned long);
593 /* arch/$(ARCH)/lib/time.c */
594 ulong usec2ticks (unsigned long usec);
595 ulong ticks2usec (unsigned long ticks);
598 int gunzip(void *, int, unsigned char *, unsigned long *);
599 int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
600 int stoponerr, int offset);
603 * gzwrite progress indicators: defined weak to allow board-specific
606 * gzwrite_progress_init called on startup
607 * gzwrite_progress called during decompress/write loop
608 * gzwrite_progress_finish called at end of loop to
609 * indicate success (retcode=0) or failure
611 void gzwrite_progress_init(u64 expected_size);
613 void gzwrite_progress(int iteration,
617 void gzwrite_progress_finish(int retcode,
624 * decompress and write gzipped image from memory to block device
626 * @param src compressed image address
627 * @param len compressed image length in bytes
628 * @param dev block device descriptor
629 * @param szwritebuf bytes per write (pad to erase size)
630 * @param startoffs offset in bytes of first write
631 * @param szexpected expected uncompressed length
632 * may be zero to use gzip trailer
633 * for files under 4GiB
635 int gzwrite(unsigned char *src, int len,
636 struct blk_desc *dev,
637 unsigned long szwritebuf,
641 /* lib/lz4_wrapper.c */
642 int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn);
645 void qsort(void *base, size_t nmemb, size_t size,
646 int(*compar)(const void *, const void *));
647 int strcmp_compar(const void *, const void *);
653 #include <vsprintf.h>
656 char * strmhz(char *buf, unsigned long hz);
659 #include <u-boot/crc.h>
663 void srand(unsigned int seed);
664 unsigned int rand(void);
665 unsigned int rand_r(unsigned int *seedp);
668 * STDIO based functions (can always be used)
671 int serial_printf (const char *fmt, ...)
672 __attribute__ ((format (__printf__, 1, 2)));
678 #if !defined(CONFIG_SPL_BUILD) || \
679 (defined(CONFIG_TPL_BUILD) && defined(CONFIG_TPL_SERIAL_SUPPORT)) || \
680 (defined(CONFIG_SPL_BUILD) && !defined(CONFIG_TPL_BUILD) && \
681 defined(CONFIG_SPL_SERIAL_SUPPORT))
682 void putc(const char c);
683 void puts(const char *s);
684 int printf(const char *fmt, ...)
685 __attribute__ ((format (__printf__, 1, 2)));
686 int vprintf(const char *fmt, va_list args);
688 #define putc(...) do { } while (0)
689 #define puts(...) do { } while (0)
690 #define printf(...) do { } while (0)
691 #define vprintf(...) do { } while (0)
695 #define eputc(c) fputc(stderr, c)
696 #define eputs(s) fputs(stderr, s)
697 #define eprintf(fmt,args...) fprintf(stderr,fmt ,##args)
700 * FILE based functions (can only be used AFTER relocation!)
707 int fprintf(int file, const char *fmt, ...)
708 __attribute__ ((format (__printf__, 2, 3)));
709 void fputs(int file, const char *s);
710 void fputc(int file, const char c);
715 int gzip(void *dst, unsigned long *lenp,
716 unsigned char *src, unsigned long srclen);
717 int zzip(void *dst, unsigned long *lenp, unsigned char *src,
718 unsigned long srclen, int stoponerr,
719 int (*func)(unsigned long, unsigned long));
721 /* lib/net_utils.c */
723 static inline struct in_addr getenv_ip(char *var)
725 return string_to_ip(getenv(var));
728 int pcmcia_init (void);
730 #ifdef CONFIG_LED_STATUS
731 # include <status_led.h>
734 #include <bootstage.h>
736 #ifdef CONFIG_SHOW_ACTIVITY
737 void show_activity(int arg);
740 /* Multicore arch functions */
742 int cpu_status(int nr);
743 int cpu_reset(int nr);
744 int cpu_disable(int nr);
745 int cpu_release(int nr, int argc, char * const argv[]);
748 #else /* __ASSEMBLY__ */
750 /* Drop a C type modifier (like in 3UL) for constants used in assembly. */
753 #endif /* __ASSEMBLY__ */
755 /* Put only stuff here that the assembler can digest */
757 /* Declare an unsigned long constant digestable both by C and an assembler. */
758 #define UL(x) _AC(x, UL)
761 #define CONFIG_HAS_POST
762 #ifndef CONFIG_POST_ALT_LIST
763 #define CONFIG_POST_STD_LIST
767 #ifdef CONFIG_INIT_CRITICAL
768 #error CONFIG_INIT_CRITICAL is deprecated!
769 #error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
772 #define ROUND(a,b) (((a) + (b) - 1) & ~((b) - 1))
775 * check_member() - Check the offset of a structure member
777 * @structure: Name of structure (e.g. global_data)
778 * @member: Name of member (e.g. baudrate)
779 * @offset: Expected offset in bytes
781 #define check_member(structure, member, offset) _Static_assert( \
782 offsetof(struct structure, member) == offset, \
783 "`struct " #structure "` offset for `" #member "` is not " #offset)
785 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
786 #ifdef CONFIG_EFI_STUB
787 #define ll_boot_init() false
789 #define ll_boot_init() true
792 /* Pull in stuff for the build system */
794 # include <environment.h>
797 #endif /* __COMMON_H_ */