1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * (C) Copyright 2000-2009
4 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
10 #ifndef __ASSEMBLY__ /* put C only stuff in this section */
12 typedef unsigned char uchar;
13 typedef volatile unsigned long vu_long;
14 typedef volatile unsigned short vu_short;
15 typedef volatile unsigned char vu_char;
20 #include <asm-offsets.h>
21 #include <linux/bitops.h>
22 #include <linux/bug.h>
23 #include <linux/delay.h>
24 #include <linux/types.h>
25 #include <linux/printk.h>
26 #include <linux/string.h>
27 #include <linux/stringify.h>
28 #include <asm/ptrace.h>
31 #include <linux/kernel.h>
38 #define CONFIG_SYS_SUPPORT_64BIT_DATA
43 typedef void (interrupt_handler_t)(void *);
45 #include <asm/u-boot.h> /* boot information for Linux kernel */
46 #include <asm/global_data.h> /* global data used for startup functions */
48 #if defined(CONFIG_ENV_IS_EMBEDDED)
49 #define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
50 #elif ( ((CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) < CONFIG_SYS_MONITOR_BASE) || \
51 (CONFIG_ENV_ADDR >= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) ) || \
52 defined(CONFIG_ENV_IS_IN_NVRAM)
53 #define TOTAL_MALLOC_LEN (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
55 #define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
58 /* startup functions, used in:
60 * common/init/board_init.c
69 void hang (void) __attribute__ ((noreturn));
73 #include <display_options.h>
76 void main_loop (void);
77 int run_command(const char *cmd, int flag);
78 int run_command_repeatable(const char *cmd, int flag);
81 * Run a list of commands separated by ; or even \0
83 * Note that if 'len' is not -1, then the command does not need to be nul
84 * terminated, Memory will be allocated for the command in that case.
86 * @param cmd List of commands to run, each separated bu semicolon
87 * @param len Length of commands excluding terminator if known (-1 if not)
88 * @param flag Execution flags (CMD_FLAG_...)
89 * @return 0 on success, or != 0 on error.
91 int run_command_list(const char *cmd, int len, int flag);
95 extern u8 __dtb_dt_begin[]; /* embedded device tree blob */
96 extern u8 __dtb_dt_spl_begin[]; /* embedded device tree blob for SPL/TPL */
100 * Show the DRAM size in a board-specific way
102 * This is used by boards to display DRAM information in their own way.
104 * @param size Size of DRAM (which should be displayed along with other info)
106 void board_show_dram(phys_size_t size);
109 * arch_fixup_fdt() - Write arch-specific information to fdt
111 * Defined in arch/$(ARCH)/lib/bootm-fdt.c
113 * @blob: FDT blob to write to
114 * @return 0 if ok, or -ve FDT_ERR_... on failure
116 int arch_fixup_fdt(void *blob);
119 void flash_perror (int);
121 /* common/cmd_source.c */
122 int source (ulong addr, const char *fit_uname);
124 extern ulong load_addr; /* Default Load Address */
125 extern ulong save_addr; /* Default Save Address */
126 extern ulong save_size; /* Default Save Size */
128 /* common/cmd_net.c */
129 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
131 /* common/cmd_fat.c */
132 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
134 /* common/cmd_ext2.c */
135 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
137 /* common/cmd_nvedit.c */
139 void env_relocate (void);
140 int envmatch (uchar *, int);
143 * env_get() - Look up the value of an environment variable
145 * In U-Boot proper this can be called before relocation (which is when the
146 * environment is loaded from storage, i.e. GD_FLG_ENV_READY is 0). In that
147 * case this function calls env_get_f().
149 * @varname: Variable to look up
150 * @return value of variable, or NULL if not found
152 char *env_get(const char *varname);
155 * env_get_f() - Look up the value of an environment variable (early)
157 * This function is called from env_get() if the environment has not been
158 * loaded yet (GD_FLG_ENV_READY flag is 0). Some environment locations will
159 * support reading the value (slowly) and some will not.
161 * @varname: Variable to look up
162 * @return value of variable, or NULL if not found
164 int env_get_f(const char *name, char *buf, unsigned len);
167 * env_get_ulong() - Return an environment variable as an integer value
169 * Most U-Boot environment variables store hex values. For those which store
170 * (e.g.) base-10 integers, this function can be used to read the value.
172 * @name: Variable to look up
173 * @base: Base to use (e.g. 10 for base 10, 2 for binary)
174 * @default_val: Default value to return if no value is found
175 * @return the value found, or @default_val if none
177 ulong env_get_ulong(const char *name, int base, ulong default_val);
180 * env_get_hex() - Return an environment variable as a hex value
182 * Decode an environment as a hex number (it may or may not have a 0x
183 * prefix). If the environment variable cannot be found, or does not start
184 * with hex digits, the default value is returned.
186 * @varname: Variable to decode
187 * @default_val: Value to return on error
189 ulong env_get_hex(const char *varname, ulong default_val);
192 * Read an environment variable as a boolean
193 * Return -1 if variable does not exist (default to true)
195 int env_get_yesno(const char *var);
198 * env_set() - set an environment variable
200 * This sets or deletes the value of an environment variable. For setting the
201 * value the variable is created if it does not already exist.
203 * @varname: Variable to adjust
204 * @value: Value to set for the variable, or NULL or "" to delete the variable
205 * @return 0 if OK, 1 on error
207 int env_set(const char *varname, const char *value);
210 * env_set_ulong() - set an environment variable to an integer
212 * @varname: Variable to adjust
213 * @value: Value to set for the variable (will be converted to a string)
214 * @return 0 if OK, 1 on error
216 int env_set_ulong(const char *varname, ulong value);
219 * env_set_hex() - set an environment variable to a hex value
221 * @varname: Variable to adjust
222 * @value: Value to set for the variable (will be converted to a hex string)
223 * @return 0 if OK, 1 on error
225 int env_set_hex(const char *varname, ulong value);
228 * env_set_addr - Set an environment variable to an address in hex
230 * @varname: Environment variable to set
231 * @addr: Value to set it to
232 * @return 0 if ok, 1 on error
234 static inline int env_set_addr(const char *varname, const void *addr)
236 return env_set_hex(varname, (ulong)addr);
239 #ifdef CONFIG_AUTO_COMPLETE
240 int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
242 int get_env_id (void);
244 void pci_init_board(void);
246 /* common/exports.c */
247 void jumptable_init(void);
249 /* common/kallsysm.c */
250 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
252 /* common/memsize.c */
253 long get_ram_size (long *, long);
254 phys_size_t get_effective_memsize(void);
256 /* $(BOARD)/$(BOARD).c */
257 void reset_phy (void);
258 void fdc_hw_init (void);
260 /* $(BOARD)/eeprom.c */
261 #ifdef CONFIG_CMD_EEPROM
262 void eeprom_init (int bus);
263 int eeprom_read (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
264 int eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
267 * Some EEPROM code is depecated because it used the legacy I2C interface. Add
268 * some macros here so we don't have to touch every one of those uses
270 #define eeprom_init(bus)
271 #define eeprom_read(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
272 #define eeprom_write(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
275 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C) && defined(CONFIG_SYS_I2C_EEPROM_ADDR)
276 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
279 /* $(BOARD)/$(BOARD).c */
280 int board_early_init_f (void);
281 int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */
282 int board_late_init (void);
283 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
284 int board_early_init_r (void);
286 #if defined(CONFIG_SYS_DRAM_TEST)
288 #endif /* CONFIG_SYS_DRAM_TEST */
291 int icache_status (void);
292 void icache_enable (void);
293 void icache_disable(void);
294 int dcache_status (void);
295 void dcache_enable (void);
296 void dcache_disable(void);
297 void mmu_disable(void);
298 #if defined(CONFIG_ARM)
299 void relocate_code(ulong);
301 void relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
303 ulong get_endaddr (void);
304 void trap_init (ulong);
307 static inline int cpumask_next(int cpu, unsigned int mask)
309 for (cpu++; !((1 << cpu) & mask); cpu++)
315 #define for_each_cpu(iter, cpu, num_cpus, mask) \
316 for (iter = 0, cpu = cpumask_next(-1, mask); \
318 iter++, cpu = cpumask_next(cpu, mask)) \
320 int cpu_numcores (void);
321 int cpu_num_dspcores(void);
323 u32 cpu_dsp_mask(void);
324 int is_core_valid (unsigned int);
329 int checkicache (void);
330 int checkdcache (void);
331 void upmconfig (unsigned int, unsigned int *, unsigned int);
332 ulong get_tbclk (void);
333 void reset_misc (void);
334 void reset_cpu (ulong addr);
335 void ft_cpu_setup(void *blob, bd_t *bd);
336 void ft_pci_setup(void *blob, bd_t *bd);
338 void smp_set_core_boot_addr(unsigned long addr, int corenr);
339 void smp_kick_all_cpus(void);
341 /* $(CPU)/serial.c */
342 int serial_init (void);
343 void serial_setbrg (void);
344 void serial_putc (const char);
345 void serial_putc_raw(const char);
346 void serial_puts (const char *);
347 int serial_getc (void);
348 int serial_tstc (void);
349 int serial_setconfig(uint config);
352 int get_clocks (void);
353 ulong get_bus_freq (ulong);
354 int get_serial_clock(void);
356 /* $(CPU)/interrupts.c */
357 int interrupt_init (void);
358 void timer_interrupt (struct pt_regs *);
359 void external_interrupt (struct pt_regs *);
360 void irq_install_handler(int, interrupt_handler_t *, void *);
361 void irq_free_handler (int);
362 void reset_timer (void);
364 /* Return value of monotonic microsecond timer */
365 unsigned long timer_get_us(void);
367 void enable_interrupts (void);
368 int disable_interrupts (void);
370 /* $(CPU)/.../commproc.c */
371 int dpram_init (void);
372 uint dpram_base(void);
373 uint dpram_base_align(uint align);
374 uint dpram_alloc(uint size);
375 uint dpram_alloc_align(uint size,uint align);
376 void bootcount_store (ulong);
377 ulong bootcount_load (void);
379 /* $(CPU)/.../<eth> */
380 void mii_init (void);
382 /* $(CPU)/.../lcd.c */
383 ulong lcd_setmem (ulong);
385 /* $(CPU)/.../video.c */
386 ulong video_setmem (ulong);
388 /* arch/$(ARCH)/lib/cache.c */
389 void enable_caches(void);
390 void flush_cache (unsigned long, unsigned long);
391 void flush_dcache_all(void);
392 void flush_dcache_range(unsigned long start, unsigned long stop);
393 void invalidate_dcache_range(unsigned long start, unsigned long stop);
394 void invalidate_dcache_all(void);
395 void invalidate_icache_all(void);
398 /* Disable caches (else flush caches but leave them active) */
399 CBL_DISABLE_CACHES = 1 << 0,
400 CBL_SHOW_BOOTSTAGE_REPORT = 1 << 1,
406 * Clean up ready for linux
408 * @param flags Flags to control what is done
410 int cleanup_before_linux_select(int flags);
412 /* arch/$(ARCH)/lib/ticks.S */
413 uint64_t get_ticks(void);
414 void wait_ticks (unsigned long);
416 /* arch/$(ARCH)/lib/time.c */
417 ulong usec2ticks (unsigned long usec);
418 ulong ticks2usec (unsigned long ticks);
421 int gzip_parse_header(const unsigned char *src, unsigned long len);
422 int gunzip(void *, int, unsigned char *, unsigned long *);
423 int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
424 int stoponerr, int offset);
427 * gzwrite progress indicators: defined weak to allow board-specific
430 * gzwrite_progress_init called on startup
431 * gzwrite_progress called during decompress/write loop
432 * gzwrite_progress_finish called at end of loop to
433 * indicate success (retcode=0) or failure
435 void gzwrite_progress_init(u64 expected_size);
437 void gzwrite_progress(int iteration,
441 void gzwrite_progress_finish(int retcode,
448 * decompress and write gzipped image from memory to block device
450 * @param src compressed image address
451 * @param len compressed image length in bytes
452 * @param dev block device descriptor
453 * @param szwritebuf bytes per write (pad to erase size)
454 * @param startoffs offset in bytes of first write
455 * @param szexpected expected uncompressed length
456 * may be zero to use gzip trailer
457 * for files under 4GiB
459 int gzwrite(unsigned char *src, int len,
460 struct blk_desc *dev,
461 unsigned long szwritebuf,
465 /* lib/lz4_wrapper.c */
466 int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn);
469 void qsort(void *base, size_t nmemb, size_t size,
470 int(*compar)(const void *, const void *));
471 int strcmp_compar(const void *, const void *);
477 #include <vsprintf.h>
480 char * strmhz(char *buf, unsigned long hz);
483 #include <u-boot/crc.h>
487 void srand(unsigned int seed);
488 unsigned int rand(void);
489 unsigned int rand_r(unsigned int *seedp);
492 * STDIO based functions (can always be used)
495 int serial_printf (const char *fmt, ...)
496 __attribute__ ((format (__printf__, 1, 2)));
499 int gzip(void *dst, unsigned long *lenp,
500 unsigned char *src, unsigned long srclen);
501 int zzip(void *dst, unsigned long *lenp, unsigned char *src,
502 unsigned long srclen, int stoponerr,
503 int (*func)(unsigned long, unsigned long));
505 /* lib/net_utils.c */
507 static inline struct in_addr env_get_ip(char *var)
509 return string_to_ip(env_get(var));
512 int pcmcia_init (void);
514 #ifdef CONFIG_LED_STATUS
515 # include <status_led.h>
518 #include <bootstage.h>
520 #ifdef CONFIG_SHOW_ACTIVITY
521 void show_activity(int arg);
524 /* Multicore arch functions */
526 int cpu_status(u32 nr);
527 int cpu_reset(u32 nr);
528 int cpu_disable(u32 nr);
529 int cpu_release(u32 nr, int argc, char * const argv[]);
532 #else /* __ASSEMBLY__ */
534 #endif /* __ASSEMBLY__ */
536 /* Put only stuff here that the assembler can digest */
539 #define CONFIG_HAS_POST
540 #ifndef CONFIG_POST_ALT_LIST
541 #define CONFIG_POST_STD_LIST
545 #ifdef CONFIG_INIT_CRITICAL
546 #error CONFIG_INIT_CRITICAL is deprecated!
547 #error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
550 #define ROUND(a,b) (((a) + (b) - 1) & ~((b) - 1))
553 * check_member() - Check the offset of a structure member
555 * @structure: Name of structure (e.g. global_data)
556 * @member: Name of member (e.g. baudrate)
557 * @offset: Expected offset in bytes
559 #define check_member(structure, member, offset) _Static_assert( \
560 offsetof(struct structure, member) == offset, \
561 "`struct " #structure "` offset for `" #member "` is not " #offset)
563 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
564 #ifdef CONFIG_EFI_STUB
565 #define ll_boot_init() false
567 #define ll_boot_init() true
570 /* Pull in stuff for the build system */
572 # include <environment.h>
575 #endif /* __COMMON_H_ */