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 * Get the uppermost pointer that is valid to access
111 * Some systems may not map all of their address space. This function allows
112 * boards to indicate what their highest support pointer value is for DRAM
115 * @param total_size Size of U-Boot (unused?)
117 ulong board_get_usable_ram_top(ulong total_size);
120 * arch_fixup_fdt() - Write arch-specific information to fdt
122 * Defined in arch/$(ARCH)/lib/bootm-fdt.c
124 * @blob: FDT blob to write to
125 * @return 0 if ok, or -ve FDT_ERR_... on failure
127 int arch_fixup_fdt(void *blob);
130 void flash_perror (int);
132 /* common/cmd_source.c */
133 int source (ulong addr, const char *fit_uname);
135 extern ulong load_addr; /* Default Load Address */
136 extern ulong save_addr; /* Default Save Address */
137 extern ulong save_size; /* Default Save Size */
139 /* common/cmd_net.c */
140 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
142 /* common/cmd_fat.c */
143 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
145 /* common/cmd_ext2.c */
146 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
148 /* common/cmd_nvedit.c */
150 void env_relocate (void);
151 int envmatch (uchar *, int);
154 * env_get() - Look up the value of an environment variable
156 * In U-Boot proper this can be called before relocation (which is when the
157 * environment is loaded from storage, i.e. GD_FLG_ENV_READY is 0). In that
158 * case this function calls env_get_f().
160 * @varname: Variable to look up
161 * @return value of variable, or NULL if not found
163 char *env_get(const char *varname);
166 * env_get_ulong() - Return an environment variable as an integer value
168 * Most U-Boot environment variables store hex values. For those which store
169 * (e.g.) base-10 integers, this function can be used to read the value.
171 * @name: Variable to look up
172 * @base: Base to use (e.g. 10 for base 10, 2 for binary)
173 * @default_val: Default value to return if no value is found
174 * @return the value found, or @default_val if none
176 ulong env_get_ulong(const char *name, int base, ulong default_val);
179 * env_get_hex() - Return an environment variable as a hex value
181 * Decode an environment as a hex number (it may or may not have a 0x
182 * prefix). If the environment variable cannot be found, or does not start
183 * with hex digits, the default value is returned.
185 * @varname: Variable to decode
186 * @default_val: Value to return on error
188 ulong env_get_hex(const char *varname, ulong default_val);
191 * Read an environment variable as a boolean
192 * Return -1 if variable does not exist (default to true)
194 int env_get_yesno(const char *var);
197 * env_set() - set an environment variable
199 * This sets or deletes the value of an environment variable. For setting the
200 * value the variable is created if it does not already exist.
202 * @varname: Variable to adjust
203 * @value: Value to set for the variable, or NULL or "" to delete the variable
204 * @return 0 if OK, 1 on error
206 int env_set(const char *varname, const char *value);
209 * env_set_ulong() - set an environment variable to an integer
211 * @varname: Variable to adjust
212 * @value: Value to set for the variable (will be converted to a string)
213 * @return 0 if OK, 1 on error
215 int env_set_ulong(const char *varname, ulong value);
218 * env_set_hex() - set an environment variable to a hex value
220 * @varname: Variable to adjust
221 * @value: Value to set for the variable (will be converted to a hex string)
222 * @return 0 if OK, 1 on error
224 int env_set_hex(const char *varname, ulong value);
227 * env_set_addr - Set an environment variable to an address in hex
229 * @varname: Environment variable to set
230 * @addr: Value to set it to
231 * @return 0 if ok, 1 on error
233 static inline int env_set_addr(const char *varname, const void *addr)
235 return env_set_hex(varname, (ulong)addr);
238 void pci_init_board(void);
240 /* common/exports.c */
241 void jumptable_init(void);
243 /* common/kallsysm.c */
244 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
246 /* common/memsize.c */
247 long get_ram_size (long *, long);
248 phys_size_t get_effective_memsize(void);
250 /* $(BOARD)/$(BOARD).c */
251 void reset_phy (void);
252 void fdc_hw_init (void);
254 /* $(BOARD)/eeprom.c */
255 #ifdef CONFIG_CMD_EEPROM
256 void eeprom_init (int bus);
257 int eeprom_read (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
258 int eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
261 * Some EEPROM code is depecated because it used the legacy I2C interface. Add
262 * some macros here so we don't have to touch every one of those uses
264 #define eeprom_init(bus)
265 #define eeprom_read(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
266 #define eeprom_write(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
269 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C) && defined(CONFIG_SYS_I2C_EEPROM_ADDR)
270 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
273 /* $(BOARD)/$(BOARD).c */
274 int board_early_init_f (void);
275 int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */
276 int board_late_init (void);
277 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
278 int board_early_init_r (void);
280 #if defined(CONFIG_SYS_DRAM_TEST)
282 #endif /* CONFIG_SYS_DRAM_TEST */
285 int icache_status (void);
286 void icache_enable (void);
287 void icache_disable(void);
288 int dcache_status (void);
289 void dcache_enable (void);
290 void dcache_disable(void);
291 void mmu_disable(void);
292 #if defined(CONFIG_ARM)
293 void relocate_code(ulong);
295 void relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
297 ulong get_endaddr (void);
298 void trap_init (ulong);
301 static inline int cpumask_next(int cpu, unsigned int mask)
303 for (cpu++; !((1 << cpu) & mask); cpu++)
309 #define for_each_cpu(iter, cpu, num_cpus, mask) \
310 for (iter = 0, cpu = cpumask_next(-1, mask); \
312 iter++, cpu = cpumask_next(cpu, mask)) \
314 int cpu_numcores (void);
315 int cpu_num_dspcores(void);
317 u32 cpu_dsp_mask(void);
318 int is_core_valid (unsigned int);
323 int checkicache (void);
324 int checkdcache (void);
325 void upmconfig (unsigned int, unsigned int *, unsigned int);
326 ulong get_tbclk (void);
327 void reset_misc (void);
328 void reset_cpu (ulong addr);
329 void ft_cpu_setup(void *blob, bd_t *bd);
330 void ft_pci_setup(void *blob, bd_t *bd);
332 void smp_set_core_boot_addr(unsigned long addr, int corenr);
333 void smp_kick_all_cpus(void);
335 /* $(CPU)/serial.c */
336 int serial_init (void);
337 void serial_setbrg (void);
338 void serial_putc (const char);
339 void serial_putc_raw(const char);
340 void serial_puts (const char *);
341 int serial_getc (void);
342 int serial_tstc (void);
345 int get_clocks (void);
346 ulong get_bus_freq (ulong);
347 int get_serial_clock(void);
349 /* $(CPU)/interrupts.c */
350 int interrupt_init (void);
351 void timer_interrupt (struct pt_regs *);
352 void external_interrupt (struct pt_regs *);
353 void irq_install_handler(int, interrupt_handler_t *, void *);
354 void irq_free_handler (int);
355 void reset_timer (void);
357 /* Return value of monotonic microsecond timer */
358 unsigned long timer_get_us(void);
360 void enable_interrupts (void);
361 int disable_interrupts (void);
363 /* $(CPU)/.../commproc.c */
364 void bootcount_store (ulong);
365 ulong bootcount_load (void);
367 /* $(CPU)/.../<eth> */
368 void mii_init (void);
370 /* arch/$(ARCH)/lib/cache.c */
371 void enable_caches(void);
372 void flush_cache (unsigned long, unsigned long);
373 void flush_dcache_all(void);
374 void flush_dcache_range(unsigned long start, unsigned long stop);
375 void invalidate_dcache_range(unsigned long start, unsigned long stop);
376 void invalidate_dcache_all(void);
377 void invalidate_icache_all(void);
380 /* Disable caches (else flush caches but leave them active) */
381 CBL_DISABLE_CACHES = 1 << 0,
382 CBL_SHOW_BOOTSTAGE_REPORT = 1 << 1,
388 * Clean up ready for linux
390 * @param flags Flags to control what is done
392 int cleanup_before_linux_select(int flags);
394 /* arch/$(ARCH)/lib/ticks.S */
395 uint64_t get_ticks(void);
396 void wait_ticks (unsigned long);
398 /* arch/$(ARCH)/lib/time.c */
399 ulong usec2ticks (unsigned long usec);
400 ulong ticks2usec (unsigned long ticks);
402 /* lib/lz4_wrapper.c */
403 int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn);
406 void qsort(void *base, size_t nmemb, size_t size,
407 int(*compar)(const void *, const void *));
408 int strcmp_compar(const void *, const void *);
414 #include <vsprintf.h>
417 char * strmhz(char *buf, unsigned long hz);
420 #include <u-boot/crc.h>
424 void srand(unsigned int seed);
425 unsigned int rand(void);
426 unsigned int rand_r(unsigned int *seedp);
429 * STDIO based functions (can always be used)
432 int serial_printf (const char *fmt, ...)
433 __attribute__ ((format (__printf__, 1, 2)));
435 /* lib/net_utils.c */
437 static inline struct in_addr env_get_ip(char *var)
439 return string_to_ip(env_get(var));
442 int pcmcia_init (void);
444 #ifdef CONFIG_LED_STATUS
445 # include <status_led.h>
448 #include <bootstage.h>
450 #ifdef CONFIG_SHOW_ACTIVITY
451 void show_activity(int arg);
454 /* Multicore arch functions */
456 int cpu_status(u32 nr);
457 int cpu_reset(u32 nr);
458 int cpu_disable(u32 nr);
459 int cpu_release(u32 nr, int argc, char * const argv[]);
462 #else /* __ASSEMBLY__ */
464 #endif /* __ASSEMBLY__ */
466 /* Put only stuff here that the assembler can digest */
469 #define CONFIG_HAS_POST
470 #ifndef CONFIG_POST_ALT_LIST
471 #define CONFIG_POST_STD_LIST
475 #define ROUND(a,b) (((a) + (b) - 1) & ~((b) - 1))
478 * check_member() - Check the offset of a structure member
480 * @structure: Name of structure (e.g. global_data)
481 * @member: Name of member (e.g. baudrate)
482 * @offset: Expected offset in bytes
484 #define check_member(structure, member, offset) _Static_assert( \
485 offsetof(struct structure, member) == offset, \
486 "`struct " #structure "` offset for `" #member "` is not " #offset)
488 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
489 #ifdef CONFIG_EFI_STUB
490 #define ll_boot_init() false
492 #define ll_boot_init() true
495 /* Pull in stuff for the build system */
497 # include <environment.h>
500 #endif /* __COMMON_H_ */