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:
67 * common/init/board_init.c
76 void hang (void) __attribute__ ((noreturn));
80 #include <display_options.h>
83 void main_loop (void);
84 int run_command(const char *cmd, int flag);
85 int run_command_repeatable(const char *cmd, int flag);
88 * Run a list of commands separated by ; or even \0
90 * Note that if 'len' is not -1, then the command does not need to be nul
91 * terminated, Memory will be allocated for the command in that case.
93 * @param cmd List of commands to run, each separated bu semicolon
94 * @param len Length of commands excluding terminator if known (-1 if not)
95 * @param flag Execution flags (CMD_FLAG_...)
96 * @return 0 on success, or != 0 on error.
98 int run_command_list(const char *cmd, int len, int flag);
100 int checkflash(void);
102 extern u8 __dtb_dt_begin[]; /* embedded device tree blob */
103 extern u8 __dtb_dt_spl_begin[]; /* embedded device tree blob for SPL/TPL */
107 * Show the DRAM size in a board-specific way
109 * This is used by boards to display DRAM information in their own way.
111 * @param size Size of DRAM (which should be displayed along with other info)
113 void board_show_dram(phys_size_t size);
116 * arch_fixup_fdt() - Write arch-specific information to fdt
118 * Defined in arch/$(ARCH)/lib/bootm-fdt.c
120 * @blob: FDT blob to write to
121 * @return 0 if ok, or -ve FDT_ERR_... on failure
123 int arch_fixup_fdt(void *blob);
126 void flash_perror (int);
128 /* common/cmd_source.c */
129 int source (ulong addr, const char *fit_uname);
131 extern ulong load_addr; /* Default Load Address */
132 extern ulong save_addr; /* Default Save Address */
133 extern ulong save_size; /* Default Save Size */
135 /* common/cmd_net.c */
136 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
138 /* common/cmd_fat.c */
139 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
141 /* common/cmd_ext2.c */
142 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
144 /* common/cmd_nvedit.c */
146 void env_relocate (void);
147 int envmatch (uchar *, int);
150 * env_get() - Look up the value of an environment variable
152 * In U-Boot proper this can be called before relocation (which is when the
153 * environment is loaded from storage, i.e. GD_FLG_ENV_READY is 0). In that
154 * case this function calls env_get_f().
156 * @varname: Variable to look up
157 * @return value of variable, or NULL if not found
159 char *env_get(const char *varname);
162 * env_get_f() - Look up the value of an environment variable (early)
164 * This function is called from env_get() if the environment has not been
165 * loaded yet (GD_FLG_ENV_READY flag is 0). Some environment locations will
166 * support reading the value (slowly) and some will not.
168 * @varname: Variable to look up
169 * @return value of variable, or NULL if not found
171 int env_get_f(const char *name, char *buf, unsigned len);
174 * env_get_ulong() - Return an environment variable as an integer value
176 * Most U-Boot environment variables store hex values. For those which store
177 * (e.g.) base-10 integers, this function can be used to read the value.
179 * @name: Variable to look up
180 * @base: Base to use (e.g. 10 for base 10, 2 for binary)
181 * @default_val: Default value to return if no value is found
182 * @return the value found, or @default_val if none
184 ulong env_get_ulong(const char *name, int base, ulong default_val);
187 * env_get_hex() - Return an environment variable as a hex value
189 * Decode an environment as a hex number (it may or may not have a 0x
190 * prefix). If the environment variable cannot be found, or does not start
191 * with hex digits, the default value is returned.
193 * @varname: Variable to decode
194 * @default_val: Value to return on error
196 ulong env_get_hex(const char *varname, ulong default_val);
199 * Read an environment variable as a boolean
200 * Return -1 if variable does not exist (default to true)
202 int env_get_yesno(const char *var);
205 * env_set() - set an environment variable
207 * This sets or deletes the value of an environment variable. For setting the
208 * value the variable is created if it does not already exist.
210 * @varname: Variable to adjust
211 * @value: Value to set for the variable, or NULL or "" to delete the variable
212 * @return 0 if OK, 1 on error
214 int env_set(const char *varname, const char *value);
217 * env_set_ulong() - set an environment variable to an integer
219 * @varname: Variable to adjust
220 * @value: Value to set for the variable (will be converted to a string)
221 * @return 0 if OK, 1 on error
223 int env_set_ulong(const char *varname, ulong value);
226 * env_set_hex() - set an environment variable to a hex value
228 * @varname: Variable to adjust
229 * @value: Value to set for the variable (will be converted to a hex string)
230 * @return 0 if OK, 1 on error
232 int env_set_hex(const char *varname, ulong value);
235 * env_set_addr - Set an environment variable to an address in hex
237 * @varname: Environment variable to set
238 * @addr: Value to set it to
239 * @return 0 if ok, 1 on error
241 static inline int env_set_addr(const char *varname, const void *addr)
243 return env_set_hex(varname, (ulong)addr);
246 #ifdef CONFIG_AUTO_COMPLETE
247 int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
249 int get_env_id (void);
251 void pci_init_board(void);
253 /* common/exports.c */
254 void jumptable_init(void);
256 /* common/kallsysm.c */
257 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
259 /* common/memsize.c */
260 long get_ram_size (long *, long);
261 phys_size_t get_effective_memsize(void);
263 /* $(BOARD)/$(BOARD).c */
264 void reset_phy (void);
265 void fdc_hw_init (void);
267 /* $(BOARD)/eeprom.c */
268 #ifdef CONFIG_CMD_EEPROM
269 void eeprom_init (int bus);
270 int eeprom_read (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
271 int eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
274 * Some EEPROM code is depecated because it used the legacy I2C interface. Add
275 * some macros here so we don't have to touch every one of those uses
277 #define eeprom_init(bus)
278 #define eeprom_read(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
279 #define eeprom_write(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
283 * Set this up regardless of board
284 * type, to prevent errors.
286 #if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
287 # define CONFIG_SYS_DEF_EEPROM_ADDR 0
289 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
290 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
292 #endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
294 #if defined(CONFIG_SPI)
295 extern void spi_init_f (void);
296 extern void spi_init_r (void);
297 extern ssize_t spi_read (uchar *, int, uchar *, int);
298 extern ssize_t spi_write (uchar *, int, uchar *, int);
301 /* $(BOARD)/$(BOARD).c */
302 int board_early_init_f (void);
303 int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */
304 int board_late_init (void);
305 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
306 int board_early_init_r (void);
308 #if defined(CONFIG_SYS_DRAM_TEST)
310 #endif /* CONFIG_SYS_DRAM_TEST */
313 int icache_status (void);
314 void icache_enable (void);
315 void icache_disable(void);
316 int dcache_status (void);
317 void dcache_enable (void);
318 void dcache_disable(void);
319 void mmu_disable(void);
320 #if defined(CONFIG_ARM)
321 void relocate_code(ulong);
323 void relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
325 ulong get_endaddr (void);
326 void trap_init (ulong);
329 static inline int cpumask_next(int cpu, unsigned int mask)
331 for (cpu++; !((1 << cpu) & mask); cpu++)
337 #define for_each_cpu(iter, cpu, num_cpus, mask) \
338 for (iter = 0, cpu = cpumask_next(-1, mask); \
340 iter++, cpu = cpumask_next(cpu, mask)) \
342 int cpu_numcores (void);
343 int cpu_num_dspcores(void);
345 u32 cpu_dsp_mask(void);
346 int is_core_valid (unsigned int);
351 int checkicache (void);
352 int checkdcache (void);
353 void upmconfig (unsigned int, unsigned int *, unsigned int);
354 ulong get_tbclk (void);
355 void reset_misc (void);
356 void reset_cpu (ulong addr);
357 void ft_cpu_setup(void *blob, bd_t *bd);
358 void ft_pci_setup(void *blob, bd_t *bd);
360 void smp_set_core_boot_addr(unsigned long addr, int corenr);
361 void smp_kick_all_cpus(void);
363 /* $(CPU)/serial.c */
364 int serial_init (void);
365 void serial_setbrg (void);
366 void serial_putc (const char);
367 void serial_putc_raw(const char);
368 void serial_puts (const char *);
369 int serial_getc (void);
370 int serial_tstc (void);
373 int get_clocks (void);
374 ulong get_bus_freq (ulong);
375 int get_serial_clock(void);
377 /* $(CPU)/interrupts.c */
378 int interrupt_init (void);
379 void timer_interrupt (struct pt_regs *);
380 void external_interrupt (struct pt_regs *);
381 void irq_install_handler(int, interrupt_handler_t *, void *);
382 void irq_free_handler (int);
383 void reset_timer (void);
385 /* Return value of monotonic microsecond timer */
386 unsigned long timer_get_us(void);
388 void enable_interrupts (void);
389 int disable_interrupts (void);
391 /* $(CPU)/.../commproc.c */
392 int dpram_init (void);
393 uint dpram_base(void);
394 uint dpram_base_align(uint align);
395 uint dpram_alloc(uint size);
396 uint dpram_alloc_align(uint size,uint align);
397 void bootcount_store (ulong);
398 ulong bootcount_load (void);
399 #define BOOTCOUNT_MAGIC 0xB001C041
401 /* $(CPU)/.../<eth> */
402 void mii_init (void);
404 /* $(CPU)/.../lcd.c */
405 ulong lcd_setmem (ulong);
407 /* $(CPU)/.../video.c */
408 ulong video_setmem (ulong);
410 /* arch/$(ARCH)/lib/cache.c */
411 void enable_caches(void);
412 void flush_cache (unsigned long, unsigned long);
413 void flush_dcache_all(void);
414 void flush_dcache_range(unsigned long start, unsigned long stop);
415 void invalidate_dcache_range(unsigned long start, unsigned long stop);
416 void invalidate_dcache_all(void);
417 void invalidate_icache_all(void);
420 /* Disable caches (else flush caches but leave them active) */
421 CBL_DISABLE_CACHES = 1 << 0,
422 CBL_SHOW_BOOTSTAGE_REPORT = 1 << 1,
428 * Clean up ready for linux
430 * @param flags Flags to control what is done
432 int cleanup_before_linux_select(int flags);
434 /* arch/$(ARCH)/lib/ticks.S */
435 uint64_t get_ticks(void);
436 void wait_ticks (unsigned long);
438 /* arch/$(ARCH)/lib/time.c */
439 ulong usec2ticks (unsigned long usec);
440 ulong ticks2usec (unsigned long ticks);
443 int gzip_parse_header(const unsigned char *src, unsigned long len);
444 int gunzip(void *, int, unsigned char *, unsigned long *);
445 int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
446 int stoponerr, int offset);
449 * gzwrite progress indicators: defined weak to allow board-specific
452 * gzwrite_progress_init called on startup
453 * gzwrite_progress called during decompress/write loop
454 * gzwrite_progress_finish called at end of loop to
455 * indicate success (retcode=0) or failure
457 void gzwrite_progress_init(u64 expected_size);
459 void gzwrite_progress(int iteration,
463 void gzwrite_progress_finish(int retcode,
470 * decompress and write gzipped image from memory to block device
472 * @param src compressed image address
473 * @param len compressed image length in bytes
474 * @param dev block device descriptor
475 * @param szwritebuf bytes per write (pad to erase size)
476 * @param startoffs offset in bytes of first write
477 * @param szexpected expected uncompressed length
478 * may be zero to use gzip trailer
479 * for files under 4GiB
481 int gzwrite(unsigned char *src, int len,
482 struct blk_desc *dev,
483 unsigned long szwritebuf,
487 /* lib/lz4_wrapper.c */
488 int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn);
491 void qsort(void *base, size_t nmemb, size_t size,
492 int(*compar)(const void *, const void *));
493 int strcmp_compar(const void *, const void *);
499 #include <vsprintf.h>
502 char * strmhz(char *buf, unsigned long hz);
505 #include <u-boot/crc.h>
509 void srand(unsigned int seed);
510 unsigned int rand(void);
511 unsigned int rand_r(unsigned int *seedp);
514 * STDIO based functions (can always be used)
517 int serial_printf (const char *fmt, ...)
518 __attribute__ ((format (__printf__, 1, 2)));
521 int gzip(void *dst, unsigned long *lenp,
522 unsigned char *src, unsigned long srclen);
523 int zzip(void *dst, unsigned long *lenp, unsigned char *src,
524 unsigned long srclen, int stoponerr,
525 int (*func)(unsigned long, unsigned long));
527 /* lib/net_utils.c */
529 static inline struct in_addr env_get_ip(char *var)
531 return string_to_ip(env_get(var));
534 int pcmcia_init (void);
536 #ifdef CONFIG_LED_STATUS
537 # include <status_led.h>
540 #include <bootstage.h>
542 #ifdef CONFIG_SHOW_ACTIVITY
543 void show_activity(int arg);
546 /* Multicore arch functions */
548 int cpu_status(int nr);
549 int cpu_reset(int nr);
550 int cpu_disable(int nr);
551 int cpu_release(int nr, int argc, char * const argv[]);
554 #else /* __ASSEMBLY__ */
556 /* Drop a C type modifier (like in 3UL) for constants used in assembly. */
559 #endif /* __ASSEMBLY__ */
561 /* Put only stuff here that the assembler can digest */
563 /* Declare an unsigned long constant digestable both by C and an assembler. */
564 #define UL(x) _AC(x, UL)
567 #define CONFIG_HAS_POST
568 #ifndef CONFIG_POST_ALT_LIST
569 #define CONFIG_POST_STD_LIST
573 #ifdef CONFIG_INIT_CRITICAL
574 #error CONFIG_INIT_CRITICAL is deprecated!
575 #error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
578 #define ROUND(a,b) (((a) + (b) - 1) & ~((b) - 1))
581 * check_member() - Check the offset of a structure member
583 * @structure: Name of structure (e.g. global_data)
584 * @member: Name of member (e.g. baudrate)
585 * @offset: Expected offset in bytes
587 #define check_member(structure, member, offset) _Static_assert( \
588 offsetof(struct structure, member) == offset, \
589 "`struct " #structure "` offset for `" #member "` is not " #offset)
591 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
592 #ifdef CONFIG_EFI_STUB
593 #define ll_boot_init() false
595 #define ll_boot_init() true
598 /* Pull in stuff for the build system */
600 # include <environment.h>
603 #endif /* __COMMON_H_ */