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/bug.h>
27 #include <linux/delay.h>
28 #include <linux/types.h>
29 #include <linux/printk.h>
30 #include <linux/string.h>
31 #include <linux/stringify.h>
32 #include <asm/ptrace.h>
35 #include <linux/kernel.h>
41 /* Bring in printf format macros if inttypes.h is included */
42 #define __STDC_FORMAT_MACROS
45 #define CONFIG_SYS_SUPPORT_64BIT_DATA
54 #ifdef CONFIG_SPL_BUILD
61 * Output a debug text when condition "cond" is met. The "cond" should be
62 * computed by a preprocessor in the best case, allowing for the best
65 #define debug_cond(cond, fmt, args...) \
68 printf(pr_fmt(fmt), ##args); \
71 /* Show a message if DEBUG is defined in a file */
72 #define debug(fmt, args...) \
73 debug_cond(_DEBUG, fmt, ##args)
75 /* Show a message if not in SPL */
76 #define warn_non_spl(fmt, args...) \
77 debug_cond(!_SPL_BUILD, fmt, ##args)
80 * An assertion is run-time check done in debug mode only. If DEBUG is not
81 * defined then it is skipped. If DEBUG is defined and the assertion fails,
82 * then it calls panic*( which may or may not reset/halt U-Boot (see
83 * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
84 * before release, and after release it is hoped that they don't matter. But
85 * in any case these failing assertions cannot be fixed with a reset (which
86 * may just do the same assertion again).
88 void __assert_fail(const char *assertion, const char *file, unsigned line,
89 const char *function);
91 ({ if (!(x) && _DEBUG) \
92 __assert_fail(#x, __FILE__, __LINE__, __func__); })
94 typedef void (interrupt_handler_t)(void *);
96 #include <asm/u-boot.h> /* boot information for Linux kernel */
97 #include <asm/global_data.h> /* global data used for startup functions */
99 #if defined(CONFIG_ENV_IS_EMBEDDED)
100 #define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
101 #elif ( ((CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) < CONFIG_SYS_MONITOR_BASE) || \
102 (CONFIG_ENV_ADDR >= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) ) || \
103 defined(CONFIG_ENV_IS_IN_NVRAM)
104 #define TOTAL_MALLOC_LEN (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
106 #define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
110 * Function Prototypes
115 * dram_init_banksize() - Set up DRAM bank sizes
117 * This can be implemented by boards to set up the DRAM bank information in
118 * gd->bd->bi_dram(). It is called just before relocation, after dram_init()
121 * If this is not provided, a default implementation will try to set up a
122 * single bank. It will do this if CONFIG_NR_DRAM_BANKS and
123 * CONFIG_SYS_SDRAM_BASE are set. The bank will have a start address of
124 * CONFIG_SYS_SDRAM_BASE and the size will be determined by a call to
125 * get_effective_memsize().
127 * @return 0 if OK, -ve on error
129 int dram_init_banksize(void);
131 void hang (void) __attribute__ ((noreturn));
133 int timer_init(void);
136 #include <display_options.h>
139 void main_loop (void);
140 int run_command(const char *cmd, int flag);
141 int run_command_repeatable(const char *cmd, int flag);
144 * Run a list of commands separated by ; or even \0
146 * Note that if 'len' is not -1, then the command does not need to be nul
147 * terminated, Memory will be allocated for the command in that case.
149 * @param cmd List of commands to run, each separated bu semicolon
150 * @param len Length of commands excluding terminator if known (-1 if not)
151 * @param flag Execution flags (CMD_FLAG_...)
152 * @return 0 on success, or != 0 on error.
154 int run_command_list(const char *cmd, int len, int flag);
156 /* arch/$(ARCH)/lib/board.c */
157 void board_init_f(ulong);
158 void board_init_r(gd_t *, ulong) __attribute__ ((noreturn));
161 * ulong board_init_f_alloc_reserve - allocate reserved area
163 * This function is called by each architecture very early in the start-up
164 * code to allow the C runtime to reserve space on the stack for writable
165 * 'globals' such as GD and the malloc arena.
167 * @top: top of the reserve area, growing down.
168 * @return: bottom of reserved area
170 ulong board_init_f_alloc_reserve(ulong top);
173 * board_init_f_init_reserve - initialize the reserved area(s)
175 * This function is called once the C runtime has allocated the reserved
176 * area on the stack. It must initialize the GD at the base of that area.
178 * @base: top from which reservation was done
180 void board_init_f_init_reserve(ulong base);
183 * arch_setup_gd() - Set up the global_data pointer
185 * This pointer is special in some architectures and cannot easily be assigned
186 * to. For example on x86 it is implemented by adding a specific record to its
187 * Global Descriptor Table! So we we provide a function to carry out this task.
188 * For most architectures this can simply be:
192 * @gd_ptr: Pointer to global data
194 void arch_setup_gd(gd_t *gd_ptr);
196 int checkboard(void);
197 int show_board_info(void);
198 int checkflash(void);
200 int last_stage_init(void);
201 extern ulong monitor_flash_len;
202 int mac_read_from_eeprom(void);
203 extern u8 __dtb_dt_begin[]; /* embedded device tree blob */
204 int set_cpu_clk_info(void);
206 int print_cpuinfo(void);
207 int update_flash_size(int flash_size);
208 int arch_early_init_r(void);
211 * setup_board_extra() - Fill in extra details in the bd_t structure
213 * @return 0 if OK, -ve on error
215 int setup_board_extra(void);
218 * arch_fsp_init() - perform firmware support package init
220 * Where U-Boot relies on binary blobs to handle part of the system init, this
221 * function can be used to set up the blobs. This is used on some Intel
224 int arch_fsp_init(void);
227 * arch_cpu_init_dm() - init CPU after driver model is available
229 * This is called immediately after driver model is available before
230 * relocation. This is similar to arch_cpu_init() but is able to reference
233 * @return 0 if OK, -ve on error
235 int arch_cpu_init_dm(void);
238 * Reserve all necessary stacks
240 * This is used in generic board init sequence in common/board_f.c. Each
241 * architecture could provide this function to tailor the required stacks.
243 * On entry gd->start_addr_sp is pointing to the suggested top of the stack.
244 * The callee ensures gd->start_add_sp is 16-byte aligned, so architectures
245 * require only this can leave it untouched.
247 * On exit gd->start_addr_sp and gd->irq_sp should be set to the respective
248 * positions of the stack. The stack pointer(s) will be set to this later.
249 * gd->irq_sp is only required, if the architecture needs it.
251 * @return 0 if no error
253 __weak int arch_reserve_stacks(void);
256 * Show the DRAM size in a board-specific way
258 * This is used by boards to display DRAM information in their own way.
260 * @param size Size of DRAM (which should be displayed along with other info)
262 void board_show_dram(phys_size_t size);
265 * arch_fixup_fdt() - Write arch-specific information to fdt
267 * Defined in arch/$(ARCH)/lib/bootm-fdt.c
269 * @blob: FDT blob to write to
270 * @return 0 if ok, or -ve FDT_ERR_... on failure
272 int arch_fixup_fdt(void *blob);
274 int reserve_mmu(void);
276 void flash_perror (int);
278 /* common/cmd_source.c */
279 int source (ulong addr, const char *fit_uname);
281 extern ulong load_addr; /* Default Load Address */
282 extern ulong save_addr; /* Default Save Address */
283 extern ulong save_size; /* Default Save Size */
285 /* common/cmd_net.c */
286 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
288 /* common/cmd_fat.c */
289 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
291 /* common/cmd_ext2.c */
292 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
294 /* common/cmd_nvedit.c */
296 void env_relocate (void);
297 int envmatch (uchar *, int);
300 * env_get() - Look up the value of an environment variable
302 * In U-Boot proper this can be called before relocation (which is when the
303 * environment is loaded from storage, i.e. GD_FLG_ENV_READY is 0). In that
304 * case this function calls env_get_f().
306 * @varname: Variable to look up
307 * @return value of variable, or NULL if not found
309 char *env_get(const char *varname);
312 * env_get_f() - Look up the value of an environment variable (early)
314 * This function is called from env_get() if the environment has not been
315 * loaded yet (GD_FLG_ENV_READY flag is 0). Some environment locations will
316 * support reading the value (slowly) and some will not.
318 * @varname: Variable to look up
319 * @return value of variable, or NULL if not found
321 int env_get_f(const char *name, char *buf, unsigned len);
324 * env_get_ulong() - Return an environment variable as an integer value
326 * Most U-Boot environment variables store hex values. For those which store
327 * (e.g.) base-10 integers, this function can be used to read the value.
329 * @name: Variable to look up
330 * @base: Base to use (e.g. 10 for base 10, 2 for binary)
331 * @default_val: Default value to return if no value is found
332 * @return the value found, or @default_val if none
334 ulong env_get_ulong(const char *name, int base, ulong default_val);
337 * env_get_hex() - Return an environment variable as a hex value
339 * Decode an environment as a hex number (it may or may not have a 0x
340 * prefix). If the environment variable cannot be found, or does not start
341 * with hex digits, the default value is returned.
343 * @varname: Variable to decode
344 * @default_val: Value to return on error
346 ulong env_get_hex(const char *varname, ulong default_val);
349 * Read an environment variable as a boolean
350 * Return -1 if variable does not exist (default to true)
352 int env_get_yesno(const char *var);
355 * env_set() - set an environment variable
357 * This sets or deletes the value of an environment variable. For setting the
358 * value the variable is created if it does not already exist.
360 * @varname: Variable to adjust
361 * @value: Value to set for the variable, or NULL or "" to delete the variable
362 * @return 0 if OK, 1 on error
364 int env_set(const char *varname, const char *value);
367 * env_set_ulong() - set an environment variable to an integer
369 * @varname: Variable to adjust
370 * @value: Value to set for the variable (will be converted to a string)
371 * @return 0 if OK, 1 on error
373 int env_set_ulong(const char *varname, ulong value);
376 * env_set_hex() - set an environment variable to a hex value
378 * @varname: Variable to adjust
379 * @value: Value to set for the variable (will be converted to a hex string)
380 * @return 0 if OK, 1 on error
382 int env_set_hex(const char *varname, ulong value);
385 * env_set_addr - Set an environment variable to an address in hex
387 * @varname: Environment variable to set
388 * @addr: Value to set it to
389 * @return 0 if ok, 1 on error
391 static inline int env_set_addr(const char *varname, const void *addr)
393 return env_set_hex(varname, (ulong)addr);
396 #ifdef CONFIG_AUTO_COMPLETE
397 int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
399 int get_env_id (void);
401 void pci_init (void);
402 void pci_init_board(void);
404 #if defined(CONFIG_DTB_RESELECT)
405 int embedded_dtb_select(void);
408 int misc_init_f (void);
409 int misc_init_r (void);
411 /* common/exports.c */
412 void jumptable_init(void);
414 /* common/kallsysm.c */
415 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
417 /* common/memsize.c */
418 long get_ram_size (long *, long);
419 phys_size_t get_effective_memsize(void);
421 /* $(BOARD)/$(BOARD).c */
422 void reset_phy (void);
423 void fdc_hw_init (void);
425 /* $(BOARD)/eeprom.c */
426 #ifdef CONFIG_CMD_EEPROM
427 void eeprom_init (int bus);
428 int eeprom_read (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
429 int eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
432 * Some EEPROM code is depecated because it used the legacy I2C interface. Add
433 * some macros here so we don't have to touch every one of those uses
435 #define eeprom_init(bus)
436 #define eeprom_read(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
437 #define eeprom_write(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
441 * Set this up regardless of board
442 * type, to prevent errors.
444 #if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
445 # define CONFIG_SYS_DEF_EEPROM_ADDR 0
447 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
448 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
450 #endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
452 #if defined(CONFIG_SPI)
453 extern void spi_init_f (void);
454 extern void spi_init_r (void);
455 extern ssize_t spi_read (uchar *, int, uchar *, int);
456 extern ssize_t spi_write (uchar *, int, uchar *, int);
459 /* $(BOARD)/$(BOARD).c */
460 int board_early_init_f (void);
461 int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */
462 int board_late_init (void);
463 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
464 int board_early_init_r (void);
465 void board_poweroff (void);
467 #if defined(CONFIG_SYS_DRAM_TEST)
469 #endif /* CONFIG_SYS_DRAM_TEST */
472 int icache_status (void);
473 void icache_enable (void);
474 void icache_disable(void);
475 int dcache_status (void);
476 void dcache_enable (void);
477 void dcache_disable(void);
478 void mmu_disable(void);
479 #if defined(CONFIG_ARM)
480 void relocate_code(ulong);
482 void relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
484 ulong get_endaddr (void);
485 void trap_init (ulong);
488 static inline int cpumask_next(int cpu, unsigned int mask)
490 for (cpu++; !((1 << cpu) & mask); cpu++)
496 #define for_each_cpu(iter, cpu, num_cpus, mask) \
497 for (iter = 0, cpu = cpumask_next(-1, mask); \
499 iter++, cpu = cpumask_next(cpu, mask)) \
501 int cpu_numcores (void);
502 int cpu_num_dspcores(void);
504 u32 cpu_dsp_mask(void);
505 int is_core_valid (unsigned int);
508 * arch_cpu_init() - basic cpu-dependent setup for an architecture
510 * This is called after early malloc is available. It should handle any
511 * CPU- or SoC- specific init needed to continue the init sequence. See
512 * board_f.c for where it is called. If this is not provided, a default
513 * version (which does nothing) will be used.
515 int arch_cpu_init(void);
518 int checkicache (void);
519 int checkdcache (void);
520 void upmconfig (unsigned int, unsigned int *, unsigned int);
521 ulong get_tbclk (void);
522 void reset_misc (void);
523 void reset_cpu (ulong addr);
524 void ft_cpu_setup(void *blob, bd_t *bd);
525 void ft_pci_setup(void *blob, bd_t *bd);
527 void smp_set_core_boot_addr(unsigned long addr, int corenr);
528 void smp_kick_all_cpus(void);
530 /* $(CPU)/serial.c */
531 int serial_init (void);
532 void serial_setbrg (void);
533 void serial_putc (const char);
534 void serial_putc_raw(const char);
535 void serial_puts (const char *);
536 int serial_getc (void);
537 int serial_tstc (void);
540 int get_clocks (void);
541 ulong get_bus_freq (ulong);
542 int get_serial_clock(void);
544 int cpu_init_r (void);
546 /* $(CPU)/interrupts.c */
547 int interrupt_init (void);
548 void timer_interrupt (struct pt_regs *);
549 void external_interrupt (struct pt_regs *);
550 void irq_install_handler(int, interrupt_handler_t *, void *);
551 void irq_free_handler (int);
552 void reset_timer (void);
554 /* Return value of monotonic microsecond timer */
555 unsigned long timer_get_us(void);
557 void enable_interrupts (void);
558 int disable_interrupts (void);
560 /* $(CPU)/.../commproc.c */
561 int dpram_init (void);
562 uint dpram_base(void);
563 uint dpram_base_align(uint align);
564 uint dpram_alloc(uint size);
565 uint dpram_alloc_align(uint size,uint align);
566 void bootcount_store (ulong);
567 ulong bootcount_load (void);
568 #define BOOTCOUNT_MAGIC 0xB001C041
570 /* $(CPU)/.../<eth> */
571 void mii_init (void);
573 /* $(CPU)/.../lcd.c */
574 ulong lcd_setmem (ulong);
576 /* $(CPU)/.../video.c */
577 ulong video_setmem (ulong);
579 /* arch/$(ARCH)/lib/cache.c */
580 void enable_caches(void);
581 void flush_cache (unsigned long, unsigned long);
582 void flush_dcache_all(void);
583 void flush_dcache_range(unsigned long start, unsigned long stop);
584 void invalidate_dcache_range(unsigned long start, unsigned long stop);
585 void invalidate_dcache_all(void);
586 void invalidate_icache_all(void);
589 /* Disable caches (else flush caches but leave them active) */
590 CBL_DISABLE_CACHES = 1 << 0,
591 CBL_SHOW_BOOTSTAGE_REPORT = 1 << 1,
597 * Clean up ready for linux
599 * @param flags Flags to control what is done
601 int cleanup_before_linux_select(int flags);
603 /* arch/$(ARCH)/lib/ticks.S */
604 uint64_t get_ticks(void);
605 void wait_ticks (unsigned long);
607 /* arch/$(ARCH)/lib/time.c */
608 ulong usec2ticks (unsigned long usec);
609 ulong ticks2usec (unsigned long ticks);
612 int gzip_parse_header(const unsigned char *src, unsigned long len);
613 int gunzip(void *, int, unsigned char *, unsigned long *);
614 int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
615 int stoponerr, int offset);
618 * gzwrite progress indicators: defined weak to allow board-specific
621 * gzwrite_progress_init called on startup
622 * gzwrite_progress called during decompress/write loop
623 * gzwrite_progress_finish called at end of loop to
624 * indicate success (retcode=0) or failure
626 void gzwrite_progress_init(u64 expected_size);
628 void gzwrite_progress(int iteration,
632 void gzwrite_progress_finish(int retcode,
639 * decompress and write gzipped image from memory to block device
641 * @param src compressed image address
642 * @param len compressed image length in bytes
643 * @param dev block device descriptor
644 * @param szwritebuf bytes per write (pad to erase size)
645 * @param startoffs offset in bytes of first write
646 * @param szexpected expected uncompressed length
647 * may be zero to use gzip trailer
648 * for files under 4GiB
650 int gzwrite(unsigned char *src, int len,
651 struct blk_desc *dev,
652 unsigned long szwritebuf,
656 /* lib/lz4_wrapper.c */
657 int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn);
660 void qsort(void *base, size_t nmemb, size_t size,
661 int(*compar)(const void *, const void *));
662 int strcmp_compar(const void *, const void *);
668 #include <vsprintf.h>
671 char * strmhz(char *buf, unsigned long hz);
674 #include <u-boot/crc.h>
678 void srand(unsigned int seed);
679 unsigned int rand(void);
680 unsigned int rand_r(unsigned int *seedp);
683 * STDIO based functions (can always be used)
686 int serial_printf (const char *fmt, ...)
687 __attribute__ ((format (__printf__, 1, 2)));
690 int gzip(void *dst, unsigned long *lenp,
691 unsigned char *src, unsigned long srclen);
692 int zzip(void *dst, unsigned long *lenp, unsigned char *src,
693 unsigned long srclen, int stoponerr,
694 int (*func)(unsigned long, unsigned long));
696 /* lib/net_utils.c */
698 static inline struct in_addr env_get_ip(char *var)
700 return string_to_ip(env_get(var));
703 int pcmcia_init (void);
705 #ifdef CONFIG_LED_STATUS
706 # include <status_led.h>
709 #include <bootstage.h>
711 #ifdef CONFIG_SHOW_ACTIVITY
712 void show_activity(int arg);
715 /* Multicore arch functions */
717 int cpu_status(int nr);
718 int cpu_reset(int nr);
719 int cpu_disable(int nr);
720 int cpu_release(int nr, int argc, char * const argv[]);
723 #else /* __ASSEMBLY__ */
725 /* Drop a C type modifier (like in 3UL) for constants used in assembly. */
728 #endif /* __ASSEMBLY__ */
730 /* Put only stuff here that the assembler can digest */
732 /* Declare an unsigned long constant digestable both by C and an assembler. */
733 #define UL(x) _AC(x, UL)
736 #define CONFIG_HAS_POST
737 #ifndef CONFIG_POST_ALT_LIST
738 #define CONFIG_POST_STD_LIST
742 #ifdef CONFIG_INIT_CRITICAL
743 #error CONFIG_INIT_CRITICAL is deprecated!
744 #error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
747 #define ROUND(a,b) (((a) + (b) - 1) & ~((b) - 1))
750 * check_member() - Check the offset of a structure member
752 * @structure: Name of structure (e.g. global_data)
753 * @member: Name of member (e.g. baudrate)
754 * @offset: Expected offset in bytes
756 #define check_member(structure, member, offset) _Static_assert( \
757 offsetof(struct structure, member) == offset, \
758 "`struct " #structure "` offset for `" #member "` is not " #offset)
760 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
761 #ifdef CONFIG_EFI_STUB
762 #define ll_boot_init() false
764 #define ll_boot_init() true
767 /* Pull in stuff for the build system */
769 # include <environment.h>
772 #endif /* __COMMON_H_ */