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
50 typedef void (interrupt_handler_t)(void *);
52 #include <asm/u-boot.h> /* boot information for Linux kernel */
53 #include <asm/global_data.h> /* global data used for startup functions */
55 #if defined(CONFIG_ENV_IS_EMBEDDED)
56 #define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
57 #elif ( ((CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) < CONFIG_SYS_MONITOR_BASE) || \
58 (CONFIG_ENV_ADDR >= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) ) || \
59 defined(CONFIG_ENV_IS_IN_NVRAM)
60 #define TOTAL_MALLOC_LEN (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
62 #define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
65 /* startup functions */
74 * dram_init_banksize() - Set up DRAM bank sizes
76 * This can be implemented by boards to set up the DRAM bank information in
77 * gd->bd->bi_dram(). It is called just before relocation, after dram_init()
80 * If this is not provided, a default implementation will try to set up a
81 * single bank. It will do this if CONFIG_NR_DRAM_BANKS and
82 * CONFIG_SYS_SDRAM_BASE are set. The bank will have a start address of
83 * CONFIG_SYS_SDRAM_BASE and the size will be determined by a call to
84 * get_effective_memsize().
86 * @return 0 if OK, -ve on error
88 int dram_init_banksize(void);
90 void hang (void) __attribute__ ((noreturn));
95 #include <display_options.h>
98 void main_loop (void);
99 int run_command(const char *cmd, int flag);
100 int run_command_repeatable(const char *cmd, int flag);
103 * Run a list of commands separated by ; or even \0
105 * Note that if 'len' is not -1, then the command does not need to be nul
106 * terminated, Memory will be allocated for the command in that case.
108 * @param cmd List of commands to run, each separated bu semicolon
109 * @param len Length of commands excluding terminator if known (-1 if not)
110 * @param flag Execution flags (CMD_FLAG_...)
111 * @return 0 on success, or != 0 on error.
113 int run_command_list(const char *cmd, int len, int flag);
115 /* arch/$(ARCH)/lib/board.c */
116 void board_init_f(ulong);
117 void board_init_r(gd_t *, ulong) __attribute__ ((noreturn));
120 * ulong board_init_f_alloc_reserve - allocate reserved area
122 * This function is called by each architecture very early in the start-up
123 * code to allow the C runtime to reserve space on the stack for writable
124 * 'globals' such as GD and the malloc arena.
126 * @top: top of the reserve area, growing down.
127 * @return: bottom of reserved area
129 ulong board_init_f_alloc_reserve(ulong top);
132 * board_init_f_init_reserve - initialize the reserved area(s)
134 * This function is called once the C runtime has allocated the reserved
135 * area on the stack. It must initialize the GD at the base of that area.
137 * @base: top from which reservation was done
139 void board_init_f_init_reserve(ulong base);
142 * arch_setup_gd() - Set up the global_data pointer
144 * This pointer is special in some architectures and cannot easily be assigned
145 * to. For example on x86 it is implemented by adding a specific record to its
146 * Global Descriptor Table! So we we provide a function to carry out this task.
147 * For most architectures this can simply be:
151 * @gd_ptr: Pointer to global data
153 void arch_setup_gd(gd_t *gd_ptr);
155 int checkboard(void);
156 int show_board_info(void);
157 int last_stage_init(void);
158 extern ulong monitor_flash_len;
159 int mac_read_from_eeprom(void);
160 extern u8 __dtb_dt_begin[]; /* embedded device tree blob */
161 extern u8 __dtb_dt_spl_begin[]; /* embedded device tree blob for SPL/TPL */
162 int set_cpu_clk_info(void);
163 int print_cpuinfo(void);
164 int update_flash_size(int flash_size);
165 int arch_early_init_r(void);
168 * arch_fsp_init() - perform firmware support package init
170 * Where U-Boot relies on binary blobs to handle part of the system init, this
171 * function can be used to set up the blobs. This is used on some Intel
174 int arch_fsp_init(void);
177 * arch_cpu_init_dm() - init CPU after driver model is available
179 * This is called immediately after driver model is available before
180 * relocation. This is similar to arch_cpu_init() but is able to reference
183 * @return 0 if OK, -ve on error
185 int arch_cpu_init_dm(void);
188 * Reserve all necessary stacks
190 * This is used in generic board init sequence in common/board_f.c. Each
191 * architecture could provide this function to tailor the required stacks.
193 * On entry gd->start_addr_sp is pointing to the suggested top of the stack.
194 * The callee ensures gd->start_add_sp is 16-byte aligned, so architectures
195 * require only this can leave it untouched.
197 * On exit gd->start_addr_sp and gd->irq_sp should be set to the respective
198 * positions of the stack. The stack pointer(s) will be set to this later.
199 * gd->irq_sp is only required, if the architecture needs it.
201 * @return 0 if no error
203 __weak int arch_reserve_stacks(void);
206 * Show the DRAM size in a board-specific way
208 * This is used by boards to display DRAM information in their own way.
210 * @param size Size of DRAM (which should be displayed along with other info)
212 void board_show_dram(phys_size_t size);
215 * arch_fixup_fdt() - Write arch-specific information to fdt
217 * Defined in arch/$(ARCH)/lib/bootm-fdt.c
219 * @blob: FDT blob to write to
220 * @return 0 if ok, or -ve FDT_ERR_... on failure
222 int arch_fixup_fdt(void *blob);
224 int reserve_mmu(void);
226 void flash_perror (int);
228 /* common/cmd_source.c */
229 int source (ulong addr, const char *fit_uname);
231 extern ulong load_addr; /* Default Load Address */
232 extern ulong save_addr; /* Default Save Address */
233 extern ulong save_size; /* Default Save Size */
235 /* common/cmd_net.c */
236 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
238 /* common/cmd_fat.c */
239 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
241 /* common/cmd_ext2.c */
242 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
244 /* common/cmd_nvedit.c */
246 void env_relocate (void);
247 int envmatch (uchar *, int);
250 * env_get() - Look up the value of an environment variable
252 * In U-Boot proper this can be called before relocation (which is when the
253 * environment is loaded from storage, i.e. GD_FLG_ENV_READY is 0). In that
254 * case this function calls env_get_f().
256 * @varname: Variable to look up
257 * @return value of variable, or NULL if not found
259 char *env_get(const char *varname);
262 * env_get_f() - Look up the value of an environment variable (early)
264 * This function is called from env_get() if the environment has not been
265 * loaded yet (GD_FLG_ENV_READY flag is 0). Some environment locations will
266 * support reading the value (slowly) and some will not.
268 * @varname: Variable to look up
269 * @return value of variable, or NULL if not found
271 int env_get_f(const char *name, char *buf, unsigned len);
274 * env_get_ulong() - Return an environment variable as an integer value
276 * Most U-Boot environment variables store hex values. For those which store
277 * (e.g.) base-10 integers, this function can be used to read the value.
279 * @name: Variable to look up
280 * @base: Base to use (e.g. 10 for base 10, 2 for binary)
281 * @default_val: Default value to return if no value is found
282 * @return the value found, or @default_val if none
284 ulong env_get_ulong(const char *name, int base, ulong default_val);
287 * env_get_hex() - Return an environment variable as a hex value
289 * Decode an environment as a hex number (it may or may not have a 0x
290 * prefix). If the environment variable cannot be found, or does not start
291 * with hex digits, the default value is returned.
293 * @varname: Variable to decode
294 * @default_val: Value to return on error
296 ulong env_get_hex(const char *varname, ulong default_val);
299 * Read an environment variable as a boolean
300 * Return -1 if variable does not exist (default to true)
302 int env_get_yesno(const char *var);
305 * env_set() - set an environment variable
307 * This sets or deletes the value of an environment variable. For setting the
308 * value the variable is created if it does not already exist.
310 * @varname: Variable to adjust
311 * @value: Value to set for the variable, or NULL or "" to delete the variable
312 * @return 0 if OK, 1 on error
314 int env_set(const char *varname, const char *value);
317 * env_set_ulong() - set an environment variable to an integer
319 * @varname: Variable to adjust
320 * @value: Value to set for the variable (will be converted to a string)
321 * @return 0 if OK, 1 on error
323 int env_set_ulong(const char *varname, ulong value);
326 * env_set_hex() - set an environment variable to a hex value
328 * @varname: Variable to adjust
329 * @value: Value to set for the variable (will be converted to a hex string)
330 * @return 0 if OK, 1 on error
332 int env_set_hex(const char *varname, ulong value);
335 * env_set_addr - Set an environment variable to an address in hex
337 * @varname: Environment variable to set
338 * @addr: Value to set it to
339 * @return 0 if ok, 1 on error
341 static inline int env_set_addr(const char *varname, const void *addr)
343 return env_set_hex(varname, (ulong)addr);
346 #ifdef CONFIG_AUTO_COMPLETE
347 int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
349 int get_env_id (void);
351 void pci_init (void);
352 void pci_init_board(void);
354 #if defined(CONFIG_DTB_RESELECT)
355 int embedded_dtb_select(void);
358 int misc_init_f (void);
359 int misc_init_r (void);
360 #if defined(CONFIG_VID)
361 int init_func_vid(void);
364 /* common/exports.c */
365 void jumptable_init(void);
367 /* common/kallsysm.c */
368 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
370 /* common/memsize.c */
371 long get_ram_size (long *, long);
372 phys_size_t get_effective_memsize(void);
374 /* $(BOARD)/$(BOARD).c */
375 void reset_phy (void);
376 void fdc_hw_init (void);
378 /* $(BOARD)/eeprom.c */
379 #ifdef CONFIG_CMD_EEPROM
380 void eeprom_init (int bus);
381 int eeprom_read (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
382 int eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
385 * Some EEPROM code is depecated because it used the legacy I2C interface. Add
386 * some macros here so we don't have to touch every one of those uses
388 #define eeprom_init(bus)
389 #define eeprom_read(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
390 #define eeprom_write(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
394 * Set this up regardless of board
395 * type, to prevent errors.
397 #if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
398 # define CONFIG_SYS_DEF_EEPROM_ADDR 0
400 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
401 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
403 #endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
405 #if defined(CONFIG_SPI)
406 extern void spi_init_f (void);
407 extern void spi_init_r (void);
408 extern ssize_t spi_read (uchar *, int, uchar *, int);
409 extern ssize_t spi_write (uchar *, int, uchar *, int);
412 /* $(BOARD)/$(BOARD).c */
413 int board_early_init_f (void);
414 int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */
415 int board_late_init (void);
416 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
417 int board_early_init_r (void);
418 void board_poweroff (void);
420 #if defined(CONFIG_SYS_DRAM_TEST)
422 #endif /* CONFIG_SYS_DRAM_TEST */
425 int icache_status (void);
426 void icache_enable (void);
427 void icache_disable(void);
428 int dcache_status (void);
429 void dcache_enable (void);
430 void dcache_disable(void);
431 void mmu_disable(void);
432 #if defined(CONFIG_ARM)
433 void relocate_code(ulong);
435 void relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
437 ulong get_endaddr (void);
438 void trap_init (ulong);
441 static inline int cpumask_next(int cpu, unsigned int mask)
443 for (cpu++; !((1 << cpu) & mask); cpu++)
449 #define for_each_cpu(iter, cpu, num_cpus, mask) \
450 for (iter = 0, cpu = cpumask_next(-1, mask); \
452 iter++, cpu = cpumask_next(cpu, mask)) \
454 int cpu_numcores (void);
455 int cpu_num_dspcores(void);
457 u32 cpu_dsp_mask(void);
458 int is_core_valid (unsigned int);
463 int checkicache (void);
464 int checkdcache (void);
465 void upmconfig (unsigned int, unsigned int *, unsigned int);
466 ulong get_tbclk (void);
467 void reset_misc (void);
468 void reset_cpu (ulong addr);
469 void ft_cpu_setup(void *blob, bd_t *bd);
470 void ft_pci_setup(void *blob, bd_t *bd);
472 void smp_set_core_boot_addr(unsigned long addr, int corenr);
473 void smp_kick_all_cpus(void);
475 /* $(CPU)/serial.c */
476 int serial_init (void);
477 void serial_setbrg (void);
478 void serial_putc (const char);
479 void serial_putc_raw(const char);
480 void serial_puts (const char *);
481 int serial_getc (void);
482 int serial_tstc (void);
485 int get_clocks (void);
486 ulong get_bus_freq (ulong);
487 int get_serial_clock(void);
489 int cpu_init_r (void);
491 /* $(CPU)/interrupts.c */
492 int interrupt_init (void);
493 void timer_interrupt (struct pt_regs *);
494 void external_interrupt (struct pt_regs *);
495 void irq_install_handler(int, interrupt_handler_t *, void *);
496 void irq_free_handler (int);
497 void reset_timer (void);
499 /* Return value of monotonic microsecond timer */
500 unsigned long timer_get_us(void);
502 void enable_interrupts (void);
503 int disable_interrupts (void);
505 /* $(CPU)/.../commproc.c */
506 int dpram_init (void);
507 uint dpram_base(void);
508 uint dpram_base_align(uint align);
509 uint dpram_alloc(uint size);
510 uint dpram_alloc_align(uint size,uint align);
511 void bootcount_store (ulong);
512 ulong bootcount_load (void);
513 #define BOOTCOUNT_MAGIC 0xB001C041
515 /* $(CPU)/.../<eth> */
516 void mii_init (void);
518 /* $(CPU)/.../lcd.c */
519 ulong lcd_setmem (ulong);
521 /* $(CPU)/.../video.c */
522 ulong video_setmem (ulong);
524 /* arch/$(ARCH)/lib/cache.c */
525 void enable_caches(void);
526 void flush_cache (unsigned long, unsigned long);
527 void flush_dcache_all(void);
528 void flush_dcache_range(unsigned long start, unsigned long stop);
529 void invalidate_dcache_range(unsigned long start, unsigned long stop);
530 void invalidate_dcache_all(void);
531 void invalidate_icache_all(void);
534 /* Disable caches (else flush caches but leave them active) */
535 CBL_DISABLE_CACHES = 1 << 0,
536 CBL_SHOW_BOOTSTAGE_REPORT = 1 << 1,
542 * Clean up ready for linux
544 * @param flags Flags to control what is done
546 int cleanup_before_linux_select(int flags);
548 /* arch/$(ARCH)/lib/ticks.S */
549 uint64_t get_ticks(void);
550 void wait_ticks (unsigned long);
552 /* arch/$(ARCH)/lib/time.c */
553 ulong usec2ticks (unsigned long usec);
554 ulong ticks2usec (unsigned long ticks);
557 int gzip_parse_header(const unsigned char *src, unsigned long len);
558 int gunzip(void *, int, unsigned char *, unsigned long *);
559 int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
560 int stoponerr, int offset);
563 * gzwrite progress indicators: defined weak to allow board-specific
566 * gzwrite_progress_init called on startup
567 * gzwrite_progress called during decompress/write loop
568 * gzwrite_progress_finish called at end of loop to
569 * indicate success (retcode=0) or failure
571 void gzwrite_progress_init(u64 expected_size);
573 void gzwrite_progress(int iteration,
577 void gzwrite_progress_finish(int retcode,
584 * decompress and write gzipped image from memory to block device
586 * @param src compressed image address
587 * @param len compressed image length in bytes
588 * @param dev block device descriptor
589 * @param szwritebuf bytes per write (pad to erase size)
590 * @param startoffs offset in bytes of first write
591 * @param szexpected expected uncompressed length
592 * may be zero to use gzip trailer
593 * for files under 4GiB
595 int gzwrite(unsigned char *src, int len,
596 struct blk_desc *dev,
597 unsigned long szwritebuf,
601 /* lib/lz4_wrapper.c */
602 int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn);
605 void qsort(void *base, size_t nmemb, size_t size,
606 int(*compar)(const void *, const void *));
607 int strcmp_compar(const void *, const void *);
613 #include <vsprintf.h>
616 char * strmhz(char *buf, unsigned long hz);
619 #include <u-boot/crc.h>
623 void srand(unsigned int seed);
624 unsigned int rand(void);
625 unsigned int rand_r(unsigned int *seedp);
628 * STDIO based functions (can always be used)
631 int serial_printf (const char *fmt, ...)
632 __attribute__ ((format (__printf__, 1, 2)));
635 int gzip(void *dst, unsigned long *lenp,
636 unsigned char *src, unsigned long srclen);
637 int zzip(void *dst, unsigned long *lenp, unsigned char *src,
638 unsigned long srclen, int stoponerr,
639 int (*func)(unsigned long, unsigned long));
641 /* lib/net_utils.c */
643 static inline struct in_addr env_get_ip(char *var)
645 return string_to_ip(env_get(var));
648 int pcmcia_init (void);
650 #ifdef CONFIG_LED_STATUS
651 # include <status_led.h>
654 #include <bootstage.h>
656 #ifdef CONFIG_SHOW_ACTIVITY
657 void show_activity(int arg);
660 /* Multicore arch functions */
662 int cpu_status(int nr);
663 int cpu_reset(int nr);
664 int cpu_disable(int nr);
665 int cpu_release(int nr, int argc, char * const argv[]);
668 #else /* __ASSEMBLY__ */
670 /* Drop a C type modifier (like in 3UL) for constants used in assembly. */
673 #endif /* __ASSEMBLY__ */
675 /* Put only stuff here that the assembler can digest */
677 /* Declare an unsigned long constant digestable both by C and an assembler. */
678 #define UL(x) _AC(x, UL)
681 #define CONFIG_HAS_POST
682 #ifndef CONFIG_POST_ALT_LIST
683 #define CONFIG_POST_STD_LIST
687 #ifdef CONFIG_INIT_CRITICAL
688 #error CONFIG_INIT_CRITICAL is deprecated!
689 #error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
692 #define ROUND(a,b) (((a) + (b) - 1) & ~((b) - 1))
695 * check_member() - Check the offset of a structure member
697 * @structure: Name of structure (e.g. global_data)
698 * @member: Name of member (e.g. baudrate)
699 * @offset: Expected offset in bytes
701 #define check_member(structure, member, offset) _Static_assert( \
702 offsetof(struct structure, member) == offset, \
703 "`struct " #structure "` offset for `" #member "` is not " #offset)
705 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
706 #ifdef CONFIG_EFI_STUB
707 #define ll_boot_init() false
709 #define ll_boot_init() true
712 /* Pull in stuff for the build system */
714 # include <environment.h>
717 #endif /* __COMMON_H_ */