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__); })
93 #define error(fmt, args...) do { \
94 printf("ERROR: " pr_fmt(fmt) "\nat %s:%d/%s()\n", \
95 ##args, __FILE__, __LINE__, __func__); \
100 printf("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __FUNCTION__); \
103 #define BUG_ON(condition) do { if (unlikely((condition)!=0)) BUG(); } while(0)
106 typedef void (interrupt_handler_t)(void *);
108 #include <asm/u-boot.h> /* boot information for Linux kernel */
109 #include <asm/global_data.h> /* global data used for startup functions */
111 #if defined(CONFIG_ENV_IS_EMBEDDED)
112 #define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
113 #elif ( ((CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) < CONFIG_SYS_MONITOR_BASE) || \
114 (CONFIG_ENV_ADDR >= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) ) || \
115 defined(CONFIG_ENV_IS_IN_NVRAM)
116 #define TOTAL_MALLOC_LEN (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
118 #define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
122 * Function Prototypes
127 * dram_init_banksize() - Set up DRAM bank sizes
129 * This can be implemented by boards to set up the DRAM bank information in
130 * gd->bd->bi_dram(). It is called just before relocation, after dram_init()
133 * If this is not provided, a default implementation will try to set up a
134 * single bank. It will do this if CONFIG_NR_DRAM_BANKS and
135 * CONFIG_SYS_SDRAM_BASE are set. The bank will have a start address of
136 * CONFIG_SYS_SDRAM_BASE and the size will be determined by a call to
137 * get_effective_memsize().
139 * @return 0 if OK, -ve on error
141 int dram_init_banksize(void);
143 void hang (void) __attribute__ ((noreturn));
145 int timer_init(void);
148 #include <display_options.h>
151 void main_loop (void);
152 int run_command(const char *cmd, int flag);
153 int run_command_repeatable(const char *cmd, int flag);
156 * Run a list of commands separated by ; or even \0
158 * Note that if 'len' is not -1, then the command does not need to be nul
159 * terminated, Memory will be allocated for the command in that case.
161 * @param cmd List of commands to run, each separated bu semicolon
162 * @param len Length of commands excluding terminator if known (-1 if not)
163 * @param flag Execution flags (CMD_FLAG_...)
164 * @return 0 on success, or != 0 on error.
166 int run_command_list(const char *cmd, int len, int flag);
168 /* arch/$(ARCH)/lib/board.c */
169 void board_init_f(ulong);
170 void board_init_r(gd_t *, ulong) __attribute__ ((noreturn));
173 * ulong board_init_f_alloc_reserve - allocate reserved area
175 * This function is called by each architecture very early in the start-up
176 * code to allow the C runtime to reserve space on the stack for writable
177 * 'globals' such as GD and the malloc arena.
179 * @top: top of the reserve area, growing down.
180 * @return: bottom of reserved area
182 ulong board_init_f_alloc_reserve(ulong top);
185 * board_init_f_init_reserve - initialize the reserved area(s)
187 * This function is called once the C runtime has allocated the reserved
188 * area on the stack. It must initialize the GD at the base of that area.
190 * @base: top from which reservation was done
192 void board_init_f_init_reserve(ulong base);
195 * arch_setup_gd() - Set up the global_data pointer
197 * This pointer is special in some architectures and cannot easily be assigned
198 * to. For example on x86 it is implemented by adding a specific record to its
199 * Global Descriptor Table! So we we provide a function to carry out this task.
200 * For most architectures this can simply be:
204 * @gd_ptr: Pointer to global data
206 void arch_setup_gd(gd_t *gd_ptr);
208 int checkboard(void);
209 int show_board_info(void);
210 int checkflash(void);
212 int last_stage_init(void);
213 extern ulong monitor_flash_len;
214 int mac_read_from_eeprom(void);
215 extern u8 __dtb_dt_begin[]; /* embedded device tree blob */
216 int set_cpu_clk_info(void);
218 int print_cpuinfo(void);
219 int update_flash_size(int flash_size);
220 int arch_early_init_r(void);
223 * setup_board_extra() - Fill in extra details in the bd_t structure
225 * @return 0 if OK, -ve on error
227 int setup_board_extra(void);
230 * arch_fsp_init() - perform firmware support package init
232 * Where U-Boot relies on binary blobs to handle part of the system init, this
233 * function can be used to set up the blobs. This is used on some Intel
236 int arch_fsp_init(void);
239 * arch_cpu_init_dm() - init CPU after driver model is available
241 * This is called immediately after driver model is available before
242 * relocation. This is similar to arch_cpu_init() but is able to reference
245 * @return 0 if OK, -ve on error
247 int arch_cpu_init_dm(void);
250 * Reserve all necessary stacks
252 * This is used in generic board init sequence in common/board_f.c. Each
253 * architecture could provide this function to tailor the required stacks.
255 * On entry gd->start_addr_sp is pointing to the suggested top of the stack.
256 * The callee ensures gd->start_add_sp is 16-byte aligned, so architectures
257 * require only this can leave it untouched.
259 * On exit gd->start_addr_sp and gd->irq_sp should be set to the respective
260 * positions of the stack. The stack pointer(s) will be set to this later.
261 * gd->irq_sp is only required, if the architecture needs it.
263 * @return 0 if no error
265 __weak int arch_reserve_stacks(void);
268 * Show the DRAM size in a board-specific way
270 * This is used by boards to display DRAM information in their own way.
272 * @param size Size of DRAM (which should be displayed along with other info)
274 void board_show_dram(phys_size_t size);
277 * arch_fixup_fdt() - Write arch-specific information to fdt
279 * Defined in arch/$(ARCH)/lib/bootm-fdt.c
281 * @blob: FDT blob to write to
282 * @return 0 if ok, or -ve FDT_ERR_... on failure
284 int arch_fixup_fdt(void *blob);
286 int reserve_mmu(void);
288 void flash_perror (int);
290 /* common/cmd_source.c */
291 int source (ulong addr, const char *fit_uname);
293 extern ulong load_addr; /* Default Load Address */
294 extern ulong save_addr; /* Default Save Address */
295 extern ulong save_size; /* Default Save Size */
297 /* common/cmd_net.c */
298 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
300 /* common/cmd_fat.c */
301 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
303 /* common/cmd_ext2.c */
304 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
306 /* common/cmd_nvedit.c */
308 void env_relocate (void);
309 int envmatch (uchar *, int);
312 * env_get() - Look up the value of an environment variable
314 * In U-Boot proper this can be called before relocation (which is when the
315 * environment is loaded from storage, i.e. GD_FLG_ENV_READY is 0). In that
316 * case this function calls env_get_f().
318 * @varname: Variable to look up
319 * @return value of variable, or NULL if not found
321 char *env_get(const char *varname);
324 * env_get_f() - Look up the value of an environment variable (early)
326 * This function is called from env_get() if the environment has not been
327 * loaded yet (GD_FLG_ENV_READY flag is 0). Some environment locations will
328 * support reading the value (slowly) and some will not.
330 * @varname: Variable to look up
331 * @return value of variable, or NULL if not found
333 int env_get_f(const char *name, char *buf, unsigned len);
336 * env_get_ulong() - Return an environment variable as an integer value
338 * Most U-Boot environment variables store hex values. For those which store
339 * (e.g.) base-10 integers, this function can be used to read the value.
341 * @name: Variable to look up
342 * @base: Base to use (e.g. 10 for base 10, 2 for binary)
343 * @default_val: Default value to return if no value is found
344 * @return the value found, or @default_val if none
346 ulong env_get_ulong(const char *name, int base, ulong default_val);
349 * env_get_hex() - Return an environment variable as a hex value
351 * Decode an environment as a hex number (it may or may not have a 0x
352 * prefix). If the environment variable cannot be found, or does not start
353 * with hex digits, the default value is returned.
355 * @varname: Variable to decode
356 * @default_val: Value to return on error
358 ulong env_get_hex(const char *varname, ulong default_val);
361 * Read an environment variable as a boolean
362 * Return -1 if variable does not exist (default to true)
364 int env_get_yesno(const char *var);
367 * env_set() - set an environment variable
369 * This sets or deletes the value of an environment variable. For setting the
370 * value the variable is created if it does not already exist.
372 * @varname: Variable to adjust
373 * @value: Value to set for the variable, or NULL or "" to delete the variable
374 * @return 0 if OK, 1 on error
376 int env_set(const char *varname, const char *value);
379 * env_set_ulong() - set an environment variable to an integer
381 * @varname: Variable to adjust
382 * @value: Value to set for the variable (will be converted to a string)
383 * @return 0 if OK, 1 on error
385 int env_set_ulong(const char *varname, ulong value);
388 * env_set_hex() - set an environment variable to a hex value
390 * @varname: Variable to adjust
391 * @value: Value to set for the variable (will be converted to a hex string)
392 * @return 0 if OK, 1 on error
394 int env_set_hex(const char *varname, ulong value);
397 * env_set_addr - Set an environment variable to an address in hex
399 * @varname: Environment variable to set
400 * @addr: Value to set it to
401 * @return 0 if ok, 1 on error
403 static inline int env_set_addr(const char *varname, const void *addr)
405 return env_set_hex(varname, (ulong)addr);
408 #ifdef CONFIG_AUTO_COMPLETE
409 int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
411 int get_env_id (void);
413 void pci_init (void);
414 void pci_init_board(void);
416 #if defined(CONFIG_DTB_RESELECT)
417 int embedded_dtb_select(void);
420 int misc_init_f (void);
421 int misc_init_r (void);
423 /* common/exports.c */
424 void jumptable_init(void);
426 /* common/kallsysm.c */
427 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
429 /* common/memsize.c */
430 long get_ram_size (long *, long);
431 phys_size_t get_effective_memsize(void);
433 /* $(BOARD)/$(BOARD).c */
434 void reset_phy (void);
435 void fdc_hw_init (void);
437 /* $(BOARD)/eeprom.c */
438 #ifdef CONFIG_CMD_EEPROM
439 void eeprom_init (int bus);
440 int eeprom_read (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
441 int eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
444 * Some EEPROM code is depecated because it used the legacy I2C interface. Add
445 * some macros here so we don't have to touch every one of those uses
447 #define eeprom_init(bus)
448 #define eeprom_read(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
449 #define eeprom_write(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
453 * Set this up regardless of board
454 * type, to prevent errors.
456 #if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
457 # define CONFIG_SYS_DEF_EEPROM_ADDR 0
459 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
460 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
462 #endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
464 #if defined(CONFIG_SPI)
465 extern void spi_init_f (void);
466 extern void spi_init_r (void);
467 extern ssize_t spi_read (uchar *, int, uchar *, int);
468 extern ssize_t spi_write (uchar *, int, uchar *, int);
471 /* $(BOARD)/$(BOARD).c */
472 int board_early_init_f (void);
473 int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */
474 int board_late_init (void);
475 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
476 int board_early_init_r (void);
477 void board_poweroff (void);
479 #if defined(CONFIG_SYS_DRAM_TEST)
481 #endif /* CONFIG_SYS_DRAM_TEST */
484 int icache_status (void);
485 void icache_enable (void);
486 void icache_disable(void);
487 int dcache_status (void);
488 void dcache_enable (void);
489 void dcache_disable(void);
490 void mmu_disable(void);
491 #if defined(CONFIG_ARM)
492 void relocate_code(ulong);
494 void relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
496 ulong get_endaddr (void);
497 void trap_init (ulong);
500 static inline int cpumask_next(int cpu, unsigned int mask)
502 for (cpu++; !((1 << cpu) & mask); cpu++)
508 #define for_each_cpu(iter, cpu, num_cpus, mask) \
509 for (iter = 0, cpu = cpumask_next(-1, mask); \
511 iter++, cpu = cpumask_next(cpu, mask)) \
513 int cpu_numcores (void);
514 int cpu_num_dspcores(void);
516 u32 cpu_dsp_mask(void);
517 int is_core_valid (unsigned int);
520 * arch_cpu_init() - basic cpu-dependent setup for an architecture
522 * This is called after early malloc is available. It should handle any
523 * CPU- or SoC- specific init needed to continue the init sequence. See
524 * board_f.c for where it is called. If this is not provided, a default
525 * version (which does nothing) will be used.
527 int arch_cpu_init(void);
530 int checkicache (void);
531 int checkdcache (void);
532 void upmconfig (unsigned int, unsigned int *, unsigned int);
533 ulong get_tbclk (void);
534 void reset_misc (void);
535 void reset_cpu (ulong addr);
536 void ft_cpu_setup(void *blob, bd_t *bd);
537 void ft_pci_setup(void *blob, bd_t *bd);
539 void smp_set_core_boot_addr(unsigned long addr, int corenr);
540 void smp_kick_all_cpus(void);
542 /* $(CPU)/serial.c */
543 int serial_init (void);
544 void serial_setbrg (void);
545 void serial_putc (const char);
546 void serial_putc_raw(const char);
547 void serial_puts (const char *);
548 int serial_getc (void);
549 int serial_tstc (void);
552 int get_clocks (void);
553 ulong get_bus_freq (ulong);
554 int get_serial_clock(void);
556 int cpu_init_r (void);
558 /* $(CPU)/interrupts.c */
559 int interrupt_init (void);
560 void timer_interrupt (struct pt_regs *);
561 void external_interrupt (struct pt_regs *);
562 void irq_install_handler(int, interrupt_handler_t *, void *);
563 void irq_free_handler (int);
564 void reset_timer (void);
566 /* Return value of monotonic microsecond timer */
567 unsigned long timer_get_us(void);
569 void enable_interrupts (void);
570 int disable_interrupts (void);
572 /* $(CPU)/.../commproc.c */
573 int dpram_init (void);
574 uint dpram_base(void);
575 uint dpram_base_align(uint align);
576 uint dpram_alloc(uint size);
577 uint dpram_alloc_align(uint size,uint align);
578 void bootcount_store (ulong);
579 ulong bootcount_load (void);
580 #define BOOTCOUNT_MAGIC 0xB001C041
582 /* $(CPU)/.../<eth> */
583 void mii_init (void);
585 /* $(CPU)/.../lcd.c */
586 ulong lcd_setmem (ulong);
588 /* $(CPU)/.../video.c */
589 ulong video_setmem (ulong);
591 /* arch/$(ARCH)/lib/cache.c */
592 void enable_caches(void);
593 void flush_cache (unsigned long, unsigned long);
594 void flush_dcache_all(void);
595 void flush_dcache_range(unsigned long start, unsigned long stop);
596 void invalidate_dcache_range(unsigned long start, unsigned long stop);
597 void invalidate_dcache_all(void);
598 void invalidate_icache_all(void);
601 /* Disable caches (else flush caches but leave them active) */
602 CBL_DISABLE_CACHES = 1 << 0,
603 CBL_SHOW_BOOTSTAGE_REPORT = 1 << 1,
609 * Clean up ready for linux
611 * @param flags Flags to control what is done
613 int cleanup_before_linux_select(int flags);
615 /* arch/$(ARCH)/lib/ticks.S */
616 uint64_t get_ticks(void);
617 void wait_ticks (unsigned long);
619 /* arch/$(ARCH)/lib/time.c */
620 ulong usec2ticks (unsigned long usec);
621 ulong ticks2usec (unsigned long ticks);
624 int gunzip(void *, int, unsigned char *, unsigned long *);
625 int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
626 int stoponerr, int offset);
629 * gzwrite progress indicators: defined weak to allow board-specific
632 * gzwrite_progress_init called on startup
633 * gzwrite_progress called during decompress/write loop
634 * gzwrite_progress_finish called at end of loop to
635 * indicate success (retcode=0) or failure
637 void gzwrite_progress_init(u64 expected_size);
639 void gzwrite_progress(int iteration,
643 void gzwrite_progress_finish(int retcode,
650 * decompress and write gzipped image from memory to block device
652 * @param src compressed image address
653 * @param len compressed image length in bytes
654 * @param dev block device descriptor
655 * @param szwritebuf bytes per write (pad to erase size)
656 * @param startoffs offset in bytes of first write
657 * @param szexpected expected uncompressed length
658 * may be zero to use gzip trailer
659 * for files under 4GiB
661 int gzwrite(unsigned char *src, int len,
662 struct blk_desc *dev,
663 unsigned long szwritebuf,
667 /* lib/lz4_wrapper.c */
668 int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn);
671 void qsort(void *base, size_t nmemb, size_t size,
672 int(*compar)(const void *, const void *));
673 int strcmp_compar(const void *, const void *);
679 #include <vsprintf.h>
682 char * strmhz(char *buf, unsigned long hz);
685 #include <u-boot/crc.h>
689 void srand(unsigned int seed);
690 unsigned int rand(void);
691 unsigned int rand_r(unsigned int *seedp);
694 * STDIO based functions (can always be used)
697 int serial_printf (const char *fmt, ...)
698 __attribute__ ((format (__printf__, 1, 2)));
701 int gzip(void *dst, unsigned long *lenp,
702 unsigned char *src, unsigned long srclen);
703 int zzip(void *dst, unsigned long *lenp, unsigned char *src,
704 unsigned long srclen, int stoponerr,
705 int (*func)(unsigned long, unsigned long));
707 /* lib/net_utils.c */
709 static inline struct in_addr env_get_ip(char *var)
711 return string_to_ip(env_get(var));
714 int pcmcia_init (void);
716 #ifdef CONFIG_LED_STATUS
717 # include <status_led.h>
720 #include <bootstage.h>
722 #ifdef CONFIG_SHOW_ACTIVITY
723 void show_activity(int arg);
726 /* Multicore arch functions */
728 int cpu_status(int nr);
729 int cpu_reset(int nr);
730 int cpu_disable(int nr);
731 int cpu_release(int nr, int argc, char * const argv[]);
734 #else /* __ASSEMBLY__ */
736 /* Drop a C type modifier (like in 3UL) for constants used in assembly. */
739 #endif /* __ASSEMBLY__ */
741 /* Put only stuff here that the assembler can digest */
743 /* Declare an unsigned long constant digestable both by C and an assembler. */
744 #define UL(x) _AC(x, UL)
747 #define CONFIG_HAS_POST
748 #ifndef CONFIG_POST_ALT_LIST
749 #define CONFIG_POST_STD_LIST
753 #ifdef CONFIG_INIT_CRITICAL
754 #error CONFIG_INIT_CRITICAL is deprecated!
755 #error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
758 #define ROUND(a,b) (((a) + (b) - 1) & ~((b) - 1))
761 * check_member() - Check the offset of a structure member
763 * @structure: Name of structure (e.g. global_data)
764 * @member: Name of member (e.g. baudrate)
765 * @offset: Expected offset in bytes
767 #define check_member(structure, member, offset) _Static_assert( \
768 offsetof(struct structure, member) == offset, \
769 "`struct " #structure "` offset for `" #member "` is not " #offset)
771 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
772 #ifdef CONFIG_EFI_STUB
773 #define ll_boot_init() false
775 #define ll_boot_init() true
778 /* Pull in stuff for the build system */
780 # include <environment.h>
783 #endif /* __COMMON_H_ */