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, used in:
73 void hang (void) __attribute__ ((noreturn));
77 #include <display_options.h>
80 void main_loop (void);
81 int run_command(const char *cmd, int flag);
82 int run_command_repeatable(const char *cmd, int flag);
85 * Run a list of commands separated by ; or even \0
87 * Note that if 'len' is not -1, then the command does not need to be nul
88 * terminated, Memory will be allocated for the command in that case.
90 * @param cmd List of commands to run, each separated bu semicolon
91 * @param len Length of commands excluding terminator if known (-1 if not)
92 * @param flag Execution flags (CMD_FLAG_...)
93 * @return 0 on success, or != 0 on error.
95 int run_command_list(const char *cmd, int len, int flag);
97 /* arch/$(ARCH)/lib/board.c */
98 void board_init_r(gd_t *, ulong) __attribute__ ((noreturn));
101 * ulong board_init_f_alloc_reserve - allocate reserved area
103 * This function is called by each architecture very early in the start-up
104 * code to allow the C runtime to reserve space on the stack for writable
105 * 'globals' such as GD and the malloc arena.
107 * @top: top of the reserve area, growing down.
108 * @return: bottom of reserved area
110 ulong board_init_f_alloc_reserve(ulong top);
113 * board_init_f_init_reserve - initialize the reserved area(s)
115 * This function is called once the C runtime has allocated the reserved
116 * area on the stack. It must initialize the GD at the base of that area.
118 * @base: top from which reservation was done
120 void board_init_f_init_reserve(ulong base);
123 * arch_setup_gd() - Set up the global_data pointer
125 * This pointer is special in some architectures and cannot easily be assigned
126 * to. For example on x86 it is implemented by adding a specific record to its
127 * Global Descriptor Table! So we we provide a function to carry out this task.
128 * For most architectures this can simply be:
132 * @gd_ptr: Pointer to global data
134 void arch_setup_gd(gd_t *gd_ptr);
136 int checkboard(void);
137 int show_board_info(void);
138 int last_stage_init(void);
139 extern ulong monitor_flash_len;
140 int mac_read_from_eeprom(void);
141 extern u8 __dtb_dt_begin[]; /* embedded device tree blob */
142 extern u8 __dtb_dt_spl_begin[]; /* embedded device tree blob for SPL/TPL */
143 int set_cpu_clk_info(void);
145 int update_flash_size(int flash_size);
146 int arch_early_init_r(void);
149 * Show the DRAM size in a board-specific way
151 * This is used by boards to display DRAM information in their own way.
153 * @param size Size of DRAM (which should be displayed along with other info)
155 void board_show_dram(phys_size_t size);
158 * arch_fixup_fdt() - Write arch-specific information to fdt
160 * Defined in arch/$(ARCH)/lib/bootm-fdt.c
162 * @blob: FDT blob to write to
163 * @return 0 if ok, or -ve FDT_ERR_... on failure
165 int arch_fixup_fdt(void *blob);
168 void flash_perror (int);
170 /* common/cmd_source.c */
171 int source (ulong addr, const char *fit_uname);
173 extern ulong load_addr; /* Default Load Address */
174 extern ulong save_addr; /* Default Save Address */
175 extern ulong save_size; /* Default Save Size */
177 /* common/cmd_net.c */
178 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
180 /* common/cmd_fat.c */
181 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
183 /* common/cmd_ext2.c */
184 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
186 /* common/cmd_nvedit.c */
188 void env_relocate (void);
189 int envmatch (uchar *, int);
192 * env_get() - Look up the value of an environment variable
194 * In U-Boot proper this can be called before relocation (which is when the
195 * environment is loaded from storage, i.e. GD_FLG_ENV_READY is 0). In that
196 * case this function calls env_get_f().
198 * @varname: Variable to look up
199 * @return value of variable, or NULL if not found
201 char *env_get(const char *varname);
204 * env_get_f() - Look up the value of an environment variable (early)
206 * This function is called from env_get() if the environment has not been
207 * loaded yet (GD_FLG_ENV_READY flag is 0). Some environment locations will
208 * support reading the value (slowly) and some will not.
210 * @varname: Variable to look up
211 * @return value of variable, or NULL if not found
213 int env_get_f(const char *name, char *buf, unsigned len);
216 * env_get_ulong() - Return an environment variable as an integer value
218 * Most U-Boot environment variables store hex values. For those which store
219 * (e.g.) base-10 integers, this function can be used to read the value.
221 * @name: Variable to look up
222 * @base: Base to use (e.g. 10 for base 10, 2 for binary)
223 * @default_val: Default value to return if no value is found
224 * @return the value found, or @default_val if none
226 ulong env_get_ulong(const char *name, int base, ulong default_val);
229 * env_get_hex() - Return an environment variable as a hex value
231 * Decode an environment as a hex number (it may or may not have a 0x
232 * prefix). If the environment variable cannot be found, or does not start
233 * with hex digits, the default value is returned.
235 * @varname: Variable to decode
236 * @default_val: Value to return on error
238 ulong env_get_hex(const char *varname, ulong default_val);
241 * Read an environment variable as a boolean
242 * Return -1 if variable does not exist (default to true)
244 int env_get_yesno(const char *var);
247 * env_set() - set an environment variable
249 * This sets or deletes the value of an environment variable. For setting the
250 * value the variable is created if it does not already exist.
252 * @varname: Variable to adjust
253 * @value: Value to set for the variable, or NULL or "" to delete the variable
254 * @return 0 if OK, 1 on error
256 int env_set(const char *varname, const char *value);
259 * env_set_ulong() - set an environment variable to an integer
261 * @varname: Variable to adjust
262 * @value: Value to set for the variable (will be converted to a string)
263 * @return 0 if OK, 1 on error
265 int env_set_ulong(const char *varname, ulong value);
268 * env_set_hex() - set an environment variable to a hex value
270 * @varname: Variable to adjust
271 * @value: Value to set for the variable (will be converted to a hex string)
272 * @return 0 if OK, 1 on error
274 int env_set_hex(const char *varname, ulong value);
277 * env_set_addr - Set an environment variable to an address in hex
279 * @varname: Environment variable to set
280 * @addr: Value to set it to
281 * @return 0 if ok, 1 on error
283 static inline int env_set_addr(const char *varname, const void *addr)
285 return env_set_hex(varname, (ulong)addr);
288 #ifdef CONFIG_AUTO_COMPLETE
289 int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
291 int get_env_id (void);
293 void pci_init (void);
294 void pci_init_board(void);
296 int misc_init_r (void);
297 #if defined(CONFIG_VID)
298 int init_func_vid(void);
301 /* common/exports.c */
302 void jumptable_init(void);
304 /* common/kallsysm.c */
305 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
307 /* common/memsize.c */
308 long get_ram_size (long *, long);
309 phys_size_t get_effective_memsize(void);
311 /* $(BOARD)/$(BOARD).c */
312 void reset_phy (void);
313 void fdc_hw_init (void);
315 /* $(BOARD)/eeprom.c */
316 #ifdef CONFIG_CMD_EEPROM
317 void eeprom_init (int bus);
318 int eeprom_read (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
319 int eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
322 * Some EEPROM code is depecated because it used the legacy I2C interface. Add
323 * some macros here so we don't have to touch every one of those uses
325 #define eeprom_init(bus)
326 #define eeprom_read(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
327 #define eeprom_write(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
331 * Set this up regardless of board
332 * type, to prevent errors.
334 #if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
335 # define CONFIG_SYS_DEF_EEPROM_ADDR 0
337 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
338 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
340 #endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
342 #if defined(CONFIG_SPI)
343 extern void spi_init_f (void);
344 extern void spi_init_r (void);
345 extern ssize_t spi_read (uchar *, int, uchar *, int);
346 extern ssize_t spi_write (uchar *, int, uchar *, int);
349 /* $(BOARD)/$(BOARD).c */
350 int board_early_init_f (void);
351 int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */
352 int board_late_init (void);
353 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
354 int board_early_init_r (void);
356 #if defined(CONFIG_SYS_DRAM_TEST)
358 #endif /* CONFIG_SYS_DRAM_TEST */
361 int icache_status (void);
362 void icache_enable (void);
363 void icache_disable(void);
364 int dcache_status (void);
365 void dcache_enable (void);
366 void dcache_disable(void);
367 void mmu_disable(void);
368 #if defined(CONFIG_ARM)
369 void relocate_code(ulong);
371 void relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
373 ulong get_endaddr (void);
374 void trap_init (ulong);
377 static inline int cpumask_next(int cpu, unsigned int mask)
379 for (cpu++; !((1 << cpu) & mask); cpu++)
385 #define for_each_cpu(iter, cpu, num_cpus, mask) \
386 for (iter = 0, cpu = cpumask_next(-1, mask); \
388 iter++, cpu = cpumask_next(cpu, mask)) \
390 int cpu_numcores (void);
391 int cpu_num_dspcores(void);
393 u32 cpu_dsp_mask(void);
394 int is_core_valid (unsigned int);
399 int checkicache (void);
400 int checkdcache (void);
401 void upmconfig (unsigned int, unsigned int *, unsigned int);
402 ulong get_tbclk (void);
403 void reset_misc (void);
404 void reset_cpu (ulong addr);
405 void ft_cpu_setup(void *blob, bd_t *bd);
406 void ft_pci_setup(void *blob, bd_t *bd);
408 void smp_set_core_boot_addr(unsigned long addr, int corenr);
409 void smp_kick_all_cpus(void);
411 /* $(CPU)/serial.c */
412 int serial_init (void);
413 void serial_setbrg (void);
414 void serial_putc (const char);
415 void serial_putc_raw(const char);
416 void serial_puts (const char *);
417 int serial_getc (void);
418 int serial_tstc (void);
421 int get_clocks (void);
422 ulong get_bus_freq (ulong);
423 int get_serial_clock(void);
425 int cpu_init_r (void);
427 /* $(CPU)/interrupts.c */
428 int interrupt_init (void);
429 void timer_interrupt (struct pt_regs *);
430 void external_interrupt (struct pt_regs *);
431 void irq_install_handler(int, interrupt_handler_t *, void *);
432 void irq_free_handler (int);
433 void reset_timer (void);
435 /* Return value of monotonic microsecond timer */
436 unsigned long timer_get_us(void);
438 void enable_interrupts (void);
439 int disable_interrupts (void);
441 /* $(CPU)/.../commproc.c */
442 int dpram_init (void);
443 uint dpram_base(void);
444 uint dpram_base_align(uint align);
445 uint dpram_alloc(uint size);
446 uint dpram_alloc_align(uint size,uint align);
447 void bootcount_store (ulong);
448 ulong bootcount_load (void);
449 #define BOOTCOUNT_MAGIC 0xB001C041
451 /* $(CPU)/.../<eth> */
452 void mii_init (void);
454 /* $(CPU)/.../lcd.c */
455 ulong lcd_setmem (ulong);
457 /* $(CPU)/.../video.c */
458 ulong video_setmem (ulong);
460 /* arch/$(ARCH)/lib/cache.c */
461 void enable_caches(void);
462 void flush_cache (unsigned long, unsigned long);
463 void flush_dcache_all(void);
464 void flush_dcache_range(unsigned long start, unsigned long stop);
465 void invalidate_dcache_range(unsigned long start, unsigned long stop);
466 void invalidate_dcache_all(void);
467 void invalidate_icache_all(void);
470 /* Disable caches (else flush caches but leave them active) */
471 CBL_DISABLE_CACHES = 1 << 0,
472 CBL_SHOW_BOOTSTAGE_REPORT = 1 << 1,
478 * Clean up ready for linux
480 * @param flags Flags to control what is done
482 int cleanup_before_linux_select(int flags);
484 /* arch/$(ARCH)/lib/ticks.S */
485 uint64_t get_ticks(void);
486 void wait_ticks (unsigned long);
488 /* arch/$(ARCH)/lib/time.c */
489 ulong usec2ticks (unsigned long usec);
490 ulong ticks2usec (unsigned long ticks);
493 int gzip_parse_header(const unsigned char *src, unsigned long len);
494 int gunzip(void *, int, unsigned char *, unsigned long *);
495 int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
496 int stoponerr, int offset);
499 * gzwrite progress indicators: defined weak to allow board-specific
502 * gzwrite_progress_init called on startup
503 * gzwrite_progress called during decompress/write loop
504 * gzwrite_progress_finish called at end of loop to
505 * indicate success (retcode=0) or failure
507 void gzwrite_progress_init(u64 expected_size);
509 void gzwrite_progress(int iteration,
513 void gzwrite_progress_finish(int retcode,
520 * decompress and write gzipped image from memory to block device
522 * @param src compressed image address
523 * @param len compressed image length in bytes
524 * @param dev block device descriptor
525 * @param szwritebuf bytes per write (pad to erase size)
526 * @param startoffs offset in bytes of first write
527 * @param szexpected expected uncompressed length
528 * may be zero to use gzip trailer
529 * for files under 4GiB
531 int gzwrite(unsigned char *src, int len,
532 struct blk_desc *dev,
533 unsigned long szwritebuf,
537 /* lib/lz4_wrapper.c */
538 int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn);
541 void qsort(void *base, size_t nmemb, size_t size,
542 int(*compar)(const void *, const void *));
543 int strcmp_compar(const void *, const void *);
549 #include <vsprintf.h>
552 char * strmhz(char *buf, unsigned long hz);
555 #include <u-boot/crc.h>
559 void srand(unsigned int seed);
560 unsigned int rand(void);
561 unsigned int rand_r(unsigned int *seedp);
564 * STDIO based functions (can always be used)
567 int serial_printf (const char *fmt, ...)
568 __attribute__ ((format (__printf__, 1, 2)));
571 int gzip(void *dst, unsigned long *lenp,
572 unsigned char *src, unsigned long srclen);
573 int zzip(void *dst, unsigned long *lenp, unsigned char *src,
574 unsigned long srclen, int stoponerr,
575 int (*func)(unsigned long, unsigned long));
577 /* lib/net_utils.c */
579 static inline struct in_addr env_get_ip(char *var)
581 return string_to_ip(env_get(var));
584 int pcmcia_init (void);
586 #ifdef CONFIG_LED_STATUS
587 # include <status_led.h>
590 #include <bootstage.h>
592 #ifdef CONFIG_SHOW_ACTIVITY
593 void show_activity(int arg);
596 /* Multicore arch functions */
598 int cpu_status(int nr);
599 int cpu_reset(int nr);
600 int cpu_disable(int nr);
601 int cpu_release(int nr, int argc, char * const argv[]);
604 #else /* __ASSEMBLY__ */
606 /* Drop a C type modifier (like in 3UL) for constants used in assembly. */
609 #endif /* __ASSEMBLY__ */
611 /* Put only stuff here that the assembler can digest */
613 /* Declare an unsigned long constant digestable both by C and an assembler. */
614 #define UL(x) _AC(x, UL)
617 #define CONFIG_HAS_POST
618 #ifndef CONFIG_POST_ALT_LIST
619 #define CONFIG_POST_STD_LIST
623 #ifdef CONFIG_INIT_CRITICAL
624 #error CONFIG_INIT_CRITICAL is deprecated!
625 #error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
628 #define ROUND(a,b) (((a) + (b) - 1) & ~((b) - 1))
631 * check_member() - Check the offset of a structure member
633 * @structure: Name of structure (e.g. global_data)
634 * @member: Name of member (e.g. baudrate)
635 * @offset: Expected offset in bytes
637 #define check_member(structure, member, offset) _Static_assert( \
638 offsetof(struct structure, member) == offset, \
639 "`struct " #structure "` offset for `" #member "` is not " #offset)
641 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
642 #ifdef CONFIG_EFI_STUB
643 #define ll_boot_init() false
645 #define ll_boot_init() true
648 /* Pull in stuff for the build system */
650 # include <environment.h>
653 #endif /* __COMMON_H_ */