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/printk.h>
29 #include <linux/string.h>
30 #include <linux/stringify.h>
31 #include <asm/ptrace.h>
34 #include <linux/kernel.h>
40 /* Bring in printf format macros if inttypes.h is included */
41 #define __STDC_FORMAT_MACROS
44 #define CONFIG_SYS_SUPPORT_64BIT_DATA
53 #ifdef CONFIG_SPL_BUILD
60 * Output a debug text when condition "cond" is met. The "cond" should be
61 * computed by a preprocessor in the best case, allowing for the best
64 #define debug_cond(cond, fmt, args...) \
67 printf(pr_fmt(fmt), ##args); \
70 /* Show a message if DEBUG is defined in a file */
71 #define debug(fmt, args...) \
72 debug_cond(_DEBUG, fmt, ##args)
74 /* Show a message if not in SPL */
75 #define warn_non_spl(fmt, args...) \
76 debug_cond(!_SPL_BUILD, fmt, ##args)
79 * An assertion is run-time check done in debug mode only. If DEBUG is not
80 * defined then it is skipped. If DEBUG is defined and the assertion fails,
81 * then it calls panic*( which may or may not reset/halt U-Boot (see
82 * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
83 * before release, and after release it is hoped that they don't matter. But
84 * in any case these failing assertions cannot be fixed with a reset (which
85 * may just do the same assertion again).
87 void __assert_fail(const char *assertion, const char *file, unsigned line,
88 const char *function);
90 ({ if (!(x) && _DEBUG) \
91 __assert_fail(#x, __FILE__, __LINE__, __func__); })
95 printf("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __FUNCTION__); \
98 #define BUG_ON(condition) do { if (unlikely((condition)!=0)) BUG(); } while(0)
101 typedef void (interrupt_handler_t)(void *);
103 #include <asm/u-boot.h> /* boot information for Linux kernel */
104 #include <asm/global_data.h> /* global data used for startup functions */
106 #if defined(CONFIG_ENV_IS_EMBEDDED)
107 #define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
108 #elif ( ((CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) < CONFIG_SYS_MONITOR_BASE) || \
109 (CONFIG_ENV_ADDR >= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) ) || \
110 defined(CONFIG_ENV_IS_IN_NVRAM)
111 #define TOTAL_MALLOC_LEN (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
113 #define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
117 * Function Prototypes
122 * dram_init_banksize() - Set up DRAM bank sizes
124 * This can be implemented by boards to set up the DRAM bank information in
125 * gd->bd->bi_dram(). It is called just before relocation, after dram_init()
128 * If this is not provided, a default implementation will try to set up a
129 * single bank. It will do this if CONFIG_NR_DRAM_BANKS and
130 * CONFIG_SYS_SDRAM_BASE are set. The bank will have a start address of
131 * CONFIG_SYS_SDRAM_BASE and the size will be determined by a call to
132 * get_effective_memsize().
134 * @return 0 if OK, -ve on error
136 int dram_init_banksize(void);
138 void hang (void) __attribute__ ((noreturn));
140 int timer_init(void);
143 #include <display_options.h>
146 void main_loop (void);
147 int run_command(const char *cmd, int flag);
148 int run_command_repeatable(const char *cmd, int flag);
151 * Run a list of commands separated by ; or even \0
153 * Note that if 'len' is not -1, then the command does not need to be nul
154 * terminated, Memory will be allocated for the command in that case.
156 * @param cmd List of commands to run, each separated bu semicolon
157 * @param len Length of commands excluding terminator if known (-1 if not)
158 * @param flag Execution flags (CMD_FLAG_...)
159 * @return 0 on success, or != 0 on error.
161 int run_command_list(const char *cmd, int len, int flag);
163 /* arch/$(ARCH)/lib/board.c */
164 void board_init_f(ulong);
165 void board_init_r(gd_t *, ulong) __attribute__ ((noreturn));
168 * ulong board_init_f_alloc_reserve - allocate reserved area
170 * This function is called by each architecture very early in the start-up
171 * code to allow the C runtime to reserve space on the stack for writable
172 * 'globals' such as GD and the malloc arena.
174 * @top: top of the reserve area, growing down.
175 * @return: bottom of reserved area
177 ulong board_init_f_alloc_reserve(ulong top);
180 * board_init_f_init_reserve - initialize the reserved area(s)
182 * This function is called once the C runtime has allocated the reserved
183 * area on the stack. It must initialize the GD at the base of that area.
185 * @base: top from which reservation was done
187 void board_init_f_init_reserve(ulong base);
190 * arch_setup_gd() - Set up the global_data pointer
192 * This pointer is special in some architectures and cannot easily be assigned
193 * to. For example on x86 it is implemented by adding a specific record to its
194 * Global Descriptor Table! So we we provide a function to carry out this task.
195 * For most architectures this can simply be:
199 * @gd_ptr: Pointer to global data
201 void arch_setup_gd(gd_t *gd_ptr);
203 int checkboard(void);
204 int show_board_info(void);
205 int checkflash(void);
207 int last_stage_init(void);
208 extern ulong monitor_flash_len;
209 int mac_read_from_eeprom(void);
210 extern u8 __dtb_dt_begin[]; /* embedded device tree blob */
211 int set_cpu_clk_info(void);
213 int print_cpuinfo(void);
214 int update_flash_size(int flash_size);
215 int arch_early_init_r(void);
218 * setup_board_extra() - Fill in extra details in the bd_t structure
220 * @return 0 if OK, -ve on error
222 int setup_board_extra(void);
225 * arch_fsp_init() - perform firmware support package init
227 * Where U-Boot relies on binary blobs to handle part of the system init, this
228 * function can be used to set up the blobs. This is used on some Intel
231 int arch_fsp_init(void);
234 * arch_cpu_init_dm() - init CPU after driver model is available
236 * This is called immediately after driver model is available before
237 * relocation. This is similar to arch_cpu_init() but is able to reference
240 * @return 0 if OK, -ve on error
242 int arch_cpu_init_dm(void);
245 * Reserve all necessary stacks
247 * This is used in generic board init sequence in common/board_f.c. Each
248 * architecture could provide this function to tailor the required stacks.
250 * On entry gd->start_addr_sp is pointing to the suggested top of the stack.
251 * The callee ensures gd->start_add_sp is 16-byte aligned, so architectures
252 * require only this can leave it untouched.
254 * On exit gd->start_addr_sp and gd->irq_sp should be set to the respective
255 * positions of the stack. The stack pointer(s) will be set to this later.
256 * gd->irq_sp is only required, if the architecture needs it.
258 * @return 0 if no error
260 __weak int arch_reserve_stacks(void);
263 * Show the DRAM size in a board-specific way
265 * This is used by boards to display DRAM information in their own way.
267 * @param size Size of DRAM (which should be displayed along with other info)
269 void board_show_dram(phys_size_t size);
272 * arch_fixup_fdt() - Write arch-specific information to fdt
274 * Defined in arch/$(ARCH)/lib/bootm-fdt.c
276 * @blob: FDT blob to write to
277 * @return 0 if ok, or -ve FDT_ERR_... on failure
279 int arch_fixup_fdt(void *blob);
281 int reserve_mmu(void);
283 void flash_perror (int);
285 /* common/cmd_source.c */
286 int source (ulong addr, const char *fit_uname);
288 extern ulong load_addr; /* Default Load Address */
289 extern ulong save_addr; /* Default Save Address */
290 extern ulong save_size; /* Default Save Size */
292 /* common/cmd_net.c */
293 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
295 /* common/cmd_fat.c */
296 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
298 /* common/cmd_ext2.c */
299 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
301 /* common/cmd_nvedit.c */
303 void env_relocate (void);
304 int envmatch (uchar *, int);
307 * env_get() - Look up the value of an environment variable
309 * In U-Boot proper this can be called before relocation (which is when the
310 * environment is loaded from storage, i.e. GD_FLG_ENV_READY is 0). In that
311 * case this function calls env_get_f().
313 * @varname: Variable to look up
314 * @return value of variable, or NULL if not found
316 char *env_get(const char *varname);
319 * env_get_f() - Look up the value of an environment variable (early)
321 * This function is called from env_get() if the environment has not been
322 * loaded yet (GD_FLG_ENV_READY flag is 0). Some environment locations will
323 * support reading the value (slowly) and some will not.
325 * @varname: Variable to look up
326 * @return value of variable, or NULL if not found
328 int env_get_f(const char *name, char *buf, unsigned len);
331 * env_get_ulong() - Return an environment variable as an integer value
333 * Most U-Boot environment variables store hex values. For those which store
334 * (e.g.) base-10 integers, this function can be used to read the value.
336 * @name: Variable to look up
337 * @base: Base to use (e.g. 10 for base 10, 2 for binary)
338 * @default_val: Default value to return if no value is found
339 * @return the value found, or @default_val if none
341 ulong env_get_ulong(const char *name, int base, ulong default_val);
344 * env_get_hex() - Return an environment variable as a hex value
346 * Decode an environment as a hex number (it may or may not have a 0x
347 * prefix). If the environment variable cannot be found, or does not start
348 * with hex digits, the default value is returned.
350 * @varname: Variable to decode
351 * @default_val: Value to return on error
353 ulong env_get_hex(const char *varname, ulong default_val);
356 * Read an environment variable as a boolean
357 * Return -1 if variable does not exist (default to true)
359 int env_get_yesno(const char *var);
362 * env_set() - set an environment variable
364 * This sets or deletes the value of an environment variable. For setting the
365 * value the variable is created if it does not already exist.
367 * @varname: Variable to adjust
368 * @value: Value to set for the variable, or NULL or "" to delete the variable
369 * @return 0 if OK, 1 on error
371 int env_set(const char *varname, const char *value);
374 * env_set_ulong() - set an environment variable to an integer
376 * @varname: Variable to adjust
377 * @value: Value to set for the variable (will be converted to a string)
378 * @return 0 if OK, 1 on error
380 int env_set_ulong(const char *varname, ulong value);
383 * env_set_hex() - set an environment variable to a hex value
385 * @varname: Variable to adjust
386 * @value: Value to set for the variable (will be converted to a hex string)
387 * @return 0 if OK, 1 on error
389 int env_set_hex(const char *varname, ulong value);
392 * env_set_addr - Set an environment variable to an address in hex
394 * @varname: Environment variable to set
395 * @addr: Value to set it to
396 * @return 0 if ok, 1 on error
398 static inline int env_set_addr(const char *varname, const void *addr)
400 return env_set_hex(varname, (ulong)addr);
403 #ifdef CONFIG_AUTO_COMPLETE
404 int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
406 int get_env_id (void);
408 void pci_init (void);
409 void pci_init_board(void);
411 #if defined(CONFIG_DTB_RESELECT)
412 int embedded_dtb_select(void);
415 int misc_init_f (void);
416 int misc_init_r (void);
418 /* common/exports.c */
419 void jumptable_init(void);
421 /* common/kallsysm.c */
422 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
424 /* common/memsize.c */
425 long get_ram_size (long *, long);
426 phys_size_t get_effective_memsize(void);
428 /* $(BOARD)/$(BOARD).c */
429 void reset_phy (void);
430 void fdc_hw_init (void);
432 /* $(BOARD)/eeprom.c */
433 #ifdef CONFIG_CMD_EEPROM
434 void eeprom_init (int bus);
435 int eeprom_read (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
436 int eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
439 * Some EEPROM code is depecated because it used the legacy I2C interface. Add
440 * some macros here so we don't have to touch every one of those uses
442 #define eeprom_init(bus)
443 #define eeprom_read(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
444 #define eeprom_write(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
448 * Set this up regardless of board
449 * type, to prevent errors.
451 #if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
452 # define CONFIG_SYS_DEF_EEPROM_ADDR 0
454 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
455 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
457 #endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
459 #if defined(CONFIG_SPI)
460 extern void spi_init_f (void);
461 extern void spi_init_r (void);
462 extern ssize_t spi_read (uchar *, int, uchar *, int);
463 extern ssize_t spi_write (uchar *, int, uchar *, int);
466 /* $(BOARD)/$(BOARD).c */
467 int board_early_init_f (void);
468 int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */
469 int board_late_init (void);
470 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
471 int board_early_init_r (void);
472 void board_poweroff (void);
474 #if defined(CONFIG_SYS_DRAM_TEST)
476 #endif /* CONFIG_SYS_DRAM_TEST */
479 int icache_status (void);
480 void icache_enable (void);
481 void icache_disable(void);
482 int dcache_status (void);
483 void dcache_enable (void);
484 void dcache_disable(void);
485 void mmu_disable(void);
486 #if defined(CONFIG_ARM)
487 void relocate_code(ulong);
489 void relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
491 ulong get_endaddr (void);
492 void trap_init (ulong);
495 static inline int cpumask_next(int cpu, unsigned int mask)
497 for (cpu++; !((1 << cpu) & mask); cpu++)
503 #define for_each_cpu(iter, cpu, num_cpus, mask) \
504 for (iter = 0, cpu = cpumask_next(-1, mask); \
506 iter++, cpu = cpumask_next(cpu, mask)) \
508 int cpu_numcores (void);
509 int cpu_num_dspcores(void);
511 u32 cpu_dsp_mask(void);
512 int is_core_valid (unsigned int);
515 * arch_cpu_init() - basic cpu-dependent setup for an architecture
517 * This is called after early malloc is available. It should handle any
518 * CPU- or SoC- specific init needed to continue the init sequence. See
519 * board_f.c for where it is called. If this is not provided, a default
520 * version (which does nothing) will be used.
522 int arch_cpu_init(void);
525 int checkicache (void);
526 int checkdcache (void);
527 void upmconfig (unsigned int, unsigned int *, unsigned int);
528 ulong get_tbclk (void);
529 void reset_misc (void);
530 void reset_cpu (ulong addr);
531 void ft_cpu_setup(void *blob, bd_t *bd);
532 void ft_pci_setup(void *blob, bd_t *bd);
534 void smp_set_core_boot_addr(unsigned long addr, int corenr);
535 void smp_kick_all_cpus(void);
537 /* $(CPU)/serial.c */
538 int serial_init (void);
539 void serial_setbrg (void);
540 void serial_putc (const char);
541 void serial_putc_raw(const char);
542 void serial_puts (const char *);
543 int serial_getc (void);
544 int serial_tstc (void);
547 int get_clocks (void);
548 ulong get_bus_freq (ulong);
549 int get_serial_clock(void);
551 int cpu_init_r (void);
553 /* $(CPU)/interrupts.c */
554 int interrupt_init (void);
555 void timer_interrupt (struct pt_regs *);
556 void external_interrupt (struct pt_regs *);
557 void irq_install_handler(int, interrupt_handler_t *, void *);
558 void irq_free_handler (int);
559 void reset_timer (void);
561 /* Return value of monotonic microsecond timer */
562 unsigned long timer_get_us(void);
564 void enable_interrupts (void);
565 int disable_interrupts (void);
567 /* $(CPU)/.../commproc.c */
568 int dpram_init (void);
569 uint dpram_base(void);
570 uint dpram_base_align(uint align);
571 uint dpram_alloc(uint size);
572 uint dpram_alloc_align(uint size,uint align);
573 void bootcount_store (ulong);
574 ulong bootcount_load (void);
575 #define BOOTCOUNT_MAGIC 0xB001C041
577 /* $(CPU)/.../<eth> */
578 void mii_init (void);
580 /* $(CPU)/.../lcd.c */
581 ulong lcd_setmem (ulong);
583 /* $(CPU)/.../video.c */
584 ulong video_setmem (ulong);
586 /* arch/$(ARCH)/lib/cache.c */
587 void enable_caches(void);
588 void flush_cache (unsigned long, unsigned long);
589 void flush_dcache_all(void);
590 void flush_dcache_range(unsigned long start, unsigned long stop);
591 void invalidate_dcache_range(unsigned long start, unsigned long stop);
592 void invalidate_dcache_all(void);
593 void invalidate_icache_all(void);
596 /* Disable caches (else flush caches but leave them active) */
597 CBL_DISABLE_CACHES = 1 << 0,
598 CBL_SHOW_BOOTSTAGE_REPORT = 1 << 1,
604 * Clean up ready for linux
606 * @param flags Flags to control what is done
608 int cleanup_before_linux_select(int flags);
610 /* arch/$(ARCH)/lib/ticks.S */
611 uint64_t get_ticks(void);
612 void wait_ticks (unsigned long);
614 /* arch/$(ARCH)/lib/time.c */
615 ulong usec2ticks (unsigned long usec);
616 ulong ticks2usec (unsigned long ticks);
619 int gunzip(void *, int, unsigned char *, unsigned long *);
620 int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
621 int stoponerr, int offset);
624 * gzwrite progress indicators: defined weak to allow board-specific
627 * gzwrite_progress_init called on startup
628 * gzwrite_progress called during decompress/write loop
629 * gzwrite_progress_finish called at end of loop to
630 * indicate success (retcode=0) or failure
632 void gzwrite_progress_init(u64 expected_size);
634 void gzwrite_progress(int iteration,
638 void gzwrite_progress_finish(int retcode,
645 * decompress and write gzipped image from memory to block device
647 * @param src compressed image address
648 * @param len compressed image length in bytes
649 * @param dev block device descriptor
650 * @param szwritebuf bytes per write (pad to erase size)
651 * @param startoffs offset in bytes of first write
652 * @param szexpected expected uncompressed length
653 * may be zero to use gzip trailer
654 * for files under 4GiB
656 int gzwrite(unsigned char *src, int len,
657 struct blk_desc *dev,
658 unsigned long szwritebuf,
662 /* lib/lz4_wrapper.c */
663 int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn);
666 void qsort(void *base, size_t nmemb, size_t size,
667 int(*compar)(const void *, const void *));
668 int strcmp_compar(const void *, const void *);
674 #include <vsprintf.h>
677 char * strmhz(char *buf, unsigned long hz);
680 #include <u-boot/crc.h>
684 void srand(unsigned int seed);
685 unsigned int rand(void);
686 unsigned int rand_r(unsigned int *seedp);
689 * STDIO based functions (can always be used)
692 int serial_printf (const char *fmt, ...)
693 __attribute__ ((format (__printf__, 1, 2)));
696 int gzip(void *dst, unsigned long *lenp,
697 unsigned char *src, unsigned long srclen);
698 int zzip(void *dst, unsigned long *lenp, unsigned char *src,
699 unsigned long srclen, int stoponerr,
700 int (*func)(unsigned long, unsigned long));
702 /* lib/net_utils.c */
704 static inline struct in_addr env_get_ip(char *var)
706 return string_to_ip(env_get(var));
709 int pcmcia_init (void);
711 #ifdef CONFIG_LED_STATUS
712 # include <status_led.h>
715 #include <bootstage.h>
717 #ifdef CONFIG_SHOW_ACTIVITY
718 void show_activity(int arg);
721 /* Multicore arch functions */
723 int cpu_status(int nr);
724 int cpu_reset(int nr);
725 int cpu_disable(int nr);
726 int cpu_release(int nr, int argc, char * const argv[]);
729 #else /* __ASSEMBLY__ */
731 /* Drop a C type modifier (like in 3UL) for constants used in assembly. */
734 #endif /* __ASSEMBLY__ */
736 /* Put only stuff here that the assembler can digest */
738 /* Declare an unsigned long constant digestable both by C and an assembler. */
739 #define UL(x) _AC(x, UL)
742 #define CONFIG_HAS_POST
743 #ifndef CONFIG_POST_ALT_LIST
744 #define CONFIG_POST_STD_LIST
748 #ifdef CONFIG_INIT_CRITICAL
749 #error CONFIG_INIT_CRITICAL is deprecated!
750 #error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
753 #define ROUND(a,b) (((a) + (b) - 1) & ~((b) - 1))
756 * check_member() - Check the offset of a structure member
758 * @structure: Name of structure (e.g. global_data)
759 * @member: Name of member (e.g. baudrate)
760 * @offset: Expected offset in bytes
762 #define check_member(structure, member, offset) _Static_assert( \
763 offsetof(struct structure, member) == offset, \
764 "`struct " #structure "` offset for `" #member "` is not " #offset)
766 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
767 #ifdef CONFIG_EFI_STUB
768 #define ll_boot_init() false
770 #define ll_boot_init() true
773 /* Pull in stuff for the build system */
775 # include <environment.h>
778 #endif /* __COMMON_H_ */