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/delay.h>
27 #include <linux/types.h>
28 #include <linux/string.h>
29 #include <linux/stringify.h>
30 #include <asm/ptrace.h>
32 #include <linux/kernel.h>
34 #ifdef CONFIG_FSL_LSCH3
35 #include <asm/arch/immap_lsch3.h>
37 #ifdef CONFIG_FSL_LSCH2
38 #include <asm/arch/immap_lsch2.h>
45 /* Bring in printf format macros if inttypes.h is included */
46 #define __STDC_FORMAT_MACROS
49 #define CONFIG_SYS_SUPPORT_64BIT_DATA
58 #ifdef CONFIG_SPL_BUILD
64 /* Define this at the top of a file to add a prefix to debug messages */
66 #define pr_fmt(fmt) fmt
70 * Output a debug text when condition "cond" is met. The "cond" should be
71 * computed by a preprocessor in the best case, allowing for the best
74 #define debug_cond(cond, fmt, args...) \
77 printf(pr_fmt(fmt), ##args); \
80 /* Show a message if DEBUG is defined in a file */
81 #define debug(fmt, args...) \
82 debug_cond(_DEBUG, fmt, ##args)
84 /* Show a message if not in SPL */
85 #define warn_non_spl(fmt, args...) \
86 debug_cond(!_SPL_BUILD, fmt, ##args)
89 * An assertion is run-time check done in debug mode only. If DEBUG is not
90 * defined then it is skipped. If DEBUG is defined and the assertion fails,
91 * then it calls panic*( which may or may not reset/halt U-Boot (see
92 * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
93 * before release, and after release it is hoped that they don't matter. But
94 * in any case these failing assertions cannot be fixed with a reset (which
95 * may just do the same assertion again).
97 void __assert_fail(const char *assertion, const char *file, unsigned line,
98 const char *function);
100 ({ if (!(x) && _DEBUG) \
101 __assert_fail(#x, __FILE__, __LINE__, __func__); })
103 #define error(fmt, args...) do { \
104 printf("ERROR: " pr_fmt(fmt) "\nat %s:%d/%s()\n", \
105 ##args, __FILE__, __LINE__, __func__); \
110 printf("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __FUNCTION__); \
113 #define BUG_ON(condition) do { if (unlikely((condition)!=0)) BUG(); } while(0)
116 typedef void (interrupt_handler_t)(void *);
118 #include <asm/u-boot.h> /* boot information for Linux kernel */
119 #include <asm/global_data.h> /* global data used for startup functions */
121 #if defined(CONFIG_ENV_IS_EMBEDDED)
122 #define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
123 #elif ( ((CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) < CONFIG_SYS_MONITOR_BASE) || \
124 (CONFIG_ENV_ADDR >= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) ) || \
125 defined(CONFIG_ENV_IS_IN_NVRAM)
126 #define TOTAL_MALLOC_LEN (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
128 #define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
132 * Function Prototypes
137 * dram_init_banksize() - Set up DRAM bank sizes
139 * This can be implemented by boards to set up the DRAM bank information in
140 * gd->bd->bi_dram(). It is called just before relocation, after dram_init()
143 * If this is not provided, a default implementation will try to set up a
144 * single bank. It will do this if CONFIG_NR_DRAM_BANKS and
145 * CONFIG_SYS_SDRAM_BASE are set. The bank will have a start address of
146 * CONFIG_SYS_SDRAM_BASE and the size will be determined by a call to
147 * get_effective_memsize().
149 * @return 0 if OK, -ve on error
151 int dram_init_banksize(void);
153 void hang (void) __attribute__ ((noreturn));
155 int timer_init(void);
158 #include <display_options.h>
161 void main_loop (void);
162 int run_command(const char *cmd, int flag);
163 int run_command_repeatable(const char *cmd, int flag);
166 * Run a list of commands separated by ; or even \0
168 * Note that if 'len' is not -1, then the command does not need to be nul
169 * terminated, Memory will be allocated for the command in that case.
171 * @param cmd List of commands to run, each separated bu semicolon
172 * @param len Length of commands excluding terminator if known (-1 if not)
173 * @param flag Execution flags (CMD_FLAG_...)
174 * @return 0 on success, or != 0 on error.
176 int run_command_list(const char *cmd, int len, int flag);
178 /* arch/$(ARCH)/lib/board.c */
179 void board_init_f(ulong);
180 void board_init_r(gd_t *, ulong) __attribute__ ((noreturn));
183 * ulong board_init_f_alloc_reserve - allocate reserved area
185 * This function is called by each architecture very early in the start-up
186 * code to allow the C runtime to reserve space on the stack for writable
187 * 'globals' such as GD and the malloc arena.
189 * @top: top of the reserve area, growing down.
190 * @return: bottom of reserved area
192 ulong board_init_f_alloc_reserve(ulong top);
195 * board_init_f_init_reserve - initialize the reserved area(s)
197 * This function is called once the C runtime has allocated the reserved
198 * area on the stack. It must initialize the GD at the base of that area.
200 * @base: top from which reservation was done
202 void board_init_f_init_reserve(ulong base);
205 * arch_setup_gd() - Set up the global_data pointer
207 * This pointer is special in some architectures and cannot easily be assigned
208 * to. For example on x86 it is implemented by adding a specific record to its
209 * Global Descriptor Table! So we we provide a function to carry out this task.
210 * For most architectures this can simply be:
214 * @gd_ptr: Pointer to global data
216 void arch_setup_gd(gd_t *gd_ptr);
218 int checkboard(void);
219 int show_board_info(void);
220 int checkflash(void);
222 int last_stage_init(void);
223 extern ulong monitor_flash_len;
224 int mac_read_from_eeprom(void);
225 extern u8 __dtb_dt_begin[]; /* embedded device tree blob */
226 int set_cpu_clk_info(void);
228 int print_cpuinfo(void);
229 int update_flash_size(int flash_size);
230 int arch_early_init_r(void);
233 * setup_board_extra() - Fill in extra details in the bd_t structure
235 * @return 0 if OK, -ve on error
237 int setup_board_extra(void);
240 * arch_fsp_init() - perform firmware support package init
242 * Where U-Boot relies on binary blobs to handle part of the system init, this
243 * function can be used to set up the blobs. This is used on some Intel
246 int arch_fsp_init(void);
249 * arch_cpu_init_dm() - init CPU after driver model is available
251 * This is called immediately after driver model is available before
252 * relocation. This is similar to arch_cpu_init() but is able to reference
255 * @return 0 if OK, -ve on error
257 int arch_cpu_init_dm(void);
260 * Reserve all necessary stacks
262 * This is used in generic board init sequence in common/board_f.c. Each
263 * architecture could provide this function to tailor the required stacks.
265 * On entry gd->start_addr_sp is pointing to the suggested top of the stack.
266 * The callee ensures gd->start_add_sp is 16-byte aligned, so architectures
267 * require only this can leave it untouched.
269 * On exit gd->start_addr_sp and gd->irq_sp should be set to the respective
270 * positions of the stack. The stack pointer(s) will be set to this later.
271 * gd->irq_sp is only required, if the architecture needs it.
273 * @return 0 if no error
275 __weak int arch_reserve_stacks(void);
278 * Show the DRAM size in a board-specific way
280 * This is used by boards to display DRAM information in their own way.
282 * @param size Size of DRAM (which should be displayed along with other info)
284 void board_show_dram(phys_size_t size);
287 * arch_fixup_fdt() - Write arch-specific information to fdt
289 * Defined in arch/$(ARCH)/lib/bootm-fdt.c
291 * @blob: FDT blob to write to
292 * @return 0 if ok, or -ve FDT_ERR_... on failure
294 int arch_fixup_fdt(void *blob);
297 void flash_perror (int);
299 /* common/cmd_source.c */
300 int source (ulong addr, const char *fit_uname);
302 extern ulong load_addr; /* Default Load Address */
303 extern ulong save_addr; /* Default Save Address */
304 extern ulong save_size; /* Default Save Size */
306 /* common/cmd_net.c */
307 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
309 /* common/cmd_fat.c */
310 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
312 /* common/cmd_ext2.c */
313 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
315 /* common/cmd_nvedit.c */
317 void env_relocate (void);
318 int envmatch (uchar *, int);
320 /* Avoid unfortunate conflict with libc's getenv() */
321 #ifdef CONFIG_SANDBOX
322 #define getenv uboot_getenv
324 char *getenv (const char *);
325 int getenv_f (const char *name, char *buf, unsigned len);
326 ulong getenv_ulong(const char *name, int base, ulong default_val);
329 * getenv_hex() - Return an environment variable as a hex value
331 * Decode an environment as a hex number (it may or may not have a 0x
332 * prefix). If the environment variable cannot be found, or does not start
333 * with hex digits, the default value is returned.
335 * @varname: Variable to decode
336 * @default_val: Value to return on error
338 ulong getenv_hex(const char *varname, ulong default_val);
341 * Read an environment variable as a boolean
342 * Return -1 if variable does not exist (default to true)
344 int getenv_yesno(const char *var);
346 int setenv (const char *, const char *);
347 int setenv_ulong(const char *varname, ulong value);
348 int setenv_hex(const char *varname, ulong value);
350 * setenv_addr - Set an environment variable to an address in hex
352 * @varname: Environment variable to set
353 * @addr: Value to set it to
354 * @return 0 if ok, 1 on error
356 static inline int setenv_addr(const char *varname, const void *addr)
358 return setenv_hex(varname, (ulong)addr);
361 #ifdef CONFIG_AUTO_COMPLETE
362 int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
364 int get_env_id (void);
366 void pci_init (void);
367 void pci_init_board(void);
369 int misc_init_f (void);
370 int misc_init_r (void);
372 /* common/exports.c */
373 void jumptable_init(void);
375 /* common/kallsysm.c */
376 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
378 /* common/memsize.c */
379 long get_ram_size (long *, long);
380 phys_size_t get_effective_memsize(void);
382 /* $(BOARD)/$(BOARD).c */
383 void reset_phy (void);
384 void fdc_hw_init (void);
386 /* $(BOARD)/eeprom.c */
387 #ifdef CONFIG_CMD_EEPROM
388 void eeprom_init (int bus);
389 int eeprom_read (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
390 int eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
393 * Some EEPROM code is depecated because it used the legacy I2C interface. Add
394 * some macros here so we don't have to touch every one of those uses
396 #define eeprom_init(bus)
397 #define eeprom_read(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
398 #define eeprom_write(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
402 * Set this up regardless of board
403 * type, to prevent errors.
405 #if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
406 # define CONFIG_SYS_DEF_EEPROM_ADDR 0
408 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
409 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
411 #endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
413 #if defined(CONFIG_SPI)
414 extern void spi_init_f (void);
415 extern void spi_init_r (void);
416 extern ssize_t spi_read (uchar *, int, uchar *, int);
417 extern ssize_t spi_write (uchar *, int, uchar *, int);
420 /* $(BOARD)/$(BOARD).c */
421 int board_early_init_f (void);
422 int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */
423 int board_late_init (void);
424 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
425 int board_early_init_r (void);
426 void board_poweroff (void);
428 #if defined(CONFIG_SYS_DRAM_TEST)
430 #endif /* CONFIG_SYS_DRAM_TEST */
433 int icache_status (void);
434 void icache_enable (void);
435 void icache_disable(void);
436 int dcache_status (void);
437 void dcache_enable (void);
438 void dcache_disable(void);
439 void mmu_disable(void);
440 #if defined(CONFIG_ARM)
441 void relocate_code(ulong);
443 void relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
445 ulong get_endaddr (void);
446 void trap_init (ulong);
448 #if defined (CONFIG_MICROBLAZE)
449 unsigned short in16(unsigned int);
450 void out16(unsigned int, unsigned short value);
454 static inline int cpumask_next(int cpu, unsigned int mask)
456 for (cpu++; !((1 << cpu) & mask); cpu++)
462 #define for_each_cpu(iter, cpu, num_cpus, mask) \
463 for (iter = 0, cpu = cpumask_next(-1, mask); \
465 iter++, cpu = cpumask_next(cpu, mask)) \
467 int cpu_numcores (void);
468 int cpu_num_dspcores(void);
470 u32 cpu_dsp_mask(void);
471 int is_core_valid (unsigned int);
474 * arch_cpu_init() - basic cpu-dependent setup for an architecture
476 * This is called after early malloc is available. It should handle any
477 * CPU- or SoC- specific init needed to continue the init sequence. See
478 * board_f.c for where it is called. If this is not provided, a default
479 * version (which does nothing) will be used.
481 int arch_cpu_init(void);
484 int checkicache (void);
485 int checkdcache (void);
486 void upmconfig (unsigned int, unsigned int *, unsigned int);
487 ulong get_tbclk (void);
488 void reset_misc (void);
489 void reset_cpu (ulong addr);
490 void ft_cpu_setup(void *blob, bd_t *bd);
491 void ft_pci_setup(void *blob, bd_t *bd);
493 void smp_set_core_boot_addr(unsigned long addr, int corenr);
494 void smp_kick_all_cpus(void);
496 /* $(CPU)/serial.c */
497 int serial_init (void);
498 void serial_setbrg (void);
499 void serial_putc (const char);
500 void serial_putc_raw(const char);
501 void serial_puts (const char *);
502 int serial_getc (void);
503 int serial_tstc (void);
505 /* These versions take a stdio_dev pointer */
507 int serial_stub_getc(struct stdio_dev *sdev);
508 int serial_stub_tstc(struct stdio_dev *sdev);
511 int get_clocks (void);
512 ulong get_bus_freq (ulong);
513 int get_serial_clock(void);
515 int cpu_init_r (void);
517 /* $(CPU)/interrupts.c */
518 int interrupt_init (void);
519 void timer_interrupt (struct pt_regs *);
520 void external_interrupt (struct pt_regs *);
521 void irq_install_handler(int, interrupt_handler_t *, void *);
522 void irq_free_handler (int);
523 void reset_timer (void);
525 /* Return value of monotonic microsecond timer */
526 unsigned long timer_get_us(void);
528 void enable_interrupts (void);
529 int disable_interrupts (void);
531 /* $(CPU)/.../commproc.c */
532 int dpram_init (void);
533 uint dpram_base(void);
534 uint dpram_base_align(uint align);
535 uint dpram_alloc(uint size);
536 uint dpram_alloc_align(uint size,uint align);
537 void bootcount_store (ulong);
538 ulong bootcount_load (void);
539 #define BOOTCOUNT_MAGIC 0xB001C041
541 /* $(CPU)/.../<eth> */
542 void mii_init (void);
544 /* $(CPU)/.../lcd.c */
545 ulong lcd_setmem (ulong);
547 /* $(CPU)/.../video.c */
548 ulong video_setmem (ulong);
550 /* arch/$(ARCH)/lib/cache.c */
551 void enable_caches(void);
552 void flush_cache (unsigned long, unsigned long);
553 void flush_dcache_all(void);
554 void flush_dcache_range(unsigned long start, unsigned long stop);
555 void invalidate_dcache_range(unsigned long start, unsigned long stop);
556 void invalidate_dcache_all(void);
557 void invalidate_icache_all(void);
560 /* Disable caches (else flush caches but leave them active) */
561 CBL_DISABLE_CACHES = 1 << 0,
562 CBL_SHOW_BOOTSTAGE_REPORT = 1 << 1,
568 * Clean up ready for linux
570 * @param flags Flags to control what is done
572 int cleanup_before_linux_select(int flags);
574 /* arch/$(ARCH)/lib/ticks.S */
575 uint64_t get_ticks(void);
576 void wait_ticks (unsigned long);
578 /* arch/$(ARCH)/lib/time.c */
579 ulong usec2ticks (unsigned long usec);
580 ulong ticks2usec (unsigned long ticks);
583 int gunzip(void *, int, unsigned char *, unsigned long *);
584 int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
585 int stoponerr, int offset);
588 * gzwrite progress indicators: defined weak to allow board-specific
591 * gzwrite_progress_init called on startup
592 * gzwrite_progress called during decompress/write loop
593 * gzwrite_progress_finish called at end of loop to
594 * indicate success (retcode=0) or failure
596 void gzwrite_progress_init(u64 expected_size);
598 void gzwrite_progress(int iteration,
602 void gzwrite_progress_finish(int retcode,
609 * decompress and write gzipped image from memory to block device
611 * @param src compressed image address
612 * @param len compressed image length in bytes
613 * @param dev block device descriptor
614 * @param szwritebuf bytes per write (pad to erase size)
615 * @param startoffs offset in bytes of first write
616 * @param szexpected expected uncompressed length
617 * may be zero to use gzip trailer
618 * for files under 4GiB
620 int gzwrite(unsigned char *src, int len,
621 struct blk_desc *dev,
622 unsigned long szwritebuf,
626 /* lib/lz4_wrapper.c */
627 int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn);
630 void qsort(void *base, size_t nmemb, size_t size,
631 int(*compar)(const void *, const void *));
632 int strcmp_compar(const void *, const void *);
638 #include <vsprintf.h>
641 char * strmhz(char *buf, unsigned long hz);
644 #include <u-boot/crc.h>
648 void srand(unsigned int seed);
649 unsigned int rand(void);
650 unsigned int rand_r(unsigned int *seedp);
653 * STDIO based functions (can always be used)
656 int serial_printf (const char *fmt, ...)
657 __attribute__ ((format (__printf__, 1, 2)));
663 #if !defined(CONFIG_SPL_BUILD) || \
664 (defined(CONFIG_TPL_BUILD) && defined(CONFIG_TPL_SERIAL_SUPPORT)) || \
665 (defined(CONFIG_SPL_BUILD) && !defined(CONFIG_TPL_BUILD) && \
666 defined(CONFIG_SPL_SERIAL_SUPPORT))
667 void putc(const char c);
668 void puts(const char *s);
669 int printf(const char *fmt, ...)
670 __attribute__ ((format (__printf__, 1, 2)));
671 int vprintf(const char *fmt, va_list args);
673 #define putc(...) do { } while (0)
674 #define puts(...) do { } while (0)
675 #define printf(...) do { } while (0)
676 #define vprintf(...) do { } while (0)
680 #define eputc(c) fputc(stderr, c)
681 #define eputs(s) fputs(stderr, s)
682 #define eprintf(fmt,args...) fprintf(stderr,fmt ,##args)
685 * FILE based functions (can only be used AFTER relocation!)
692 int fprintf(int file, const char *fmt, ...)
693 __attribute__ ((format (__printf__, 2, 3)));
694 void fputs(int file, const char *s);
695 void fputc(int file, const char c);
700 int gzip(void *dst, unsigned long *lenp,
701 unsigned char *src, unsigned long srclen);
702 int zzip(void *dst, unsigned long *lenp, unsigned char *src,
703 unsigned long srclen, int stoponerr,
704 int (*func)(unsigned long, unsigned long));
706 /* lib/net_utils.c */
708 static inline struct in_addr getenv_ip(char *var)
710 return string_to_ip(getenv(var));
713 int pcmcia_init (void);
715 #ifdef CONFIG_LED_STATUS
716 # include <status_led.h>
719 #include <bootstage.h>
721 #ifdef CONFIG_SHOW_ACTIVITY
722 void show_activity(int arg);
725 /* Multicore arch functions */
727 int cpu_status(int nr);
728 int cpu_reset(int nr);
729 int cpu_disable(int nr);
730 int cpu_release(int nr, int argc, char * const argv[]);
733 #else /* __ASSEMBLY__ */
735 /* Drop a C type modifier (like in 3UL) for constants used in assembly. */
738 #endif /* __ASSEMBLY__ */
740 /* Put only stuff here that the assembler can digest */
742 /* Declare an unsigned long constant digestable both by C and an assembler. */
743 #define UL(x) _AC(x, UL)
746 #define CONFIG_HAS_POST
747 #ifndef CONFIG_POST_ALT_LIST
748 #define CONFIG_POST_STD_LIST
752 #ifdef CONFIG_INIT_CRITICAL
753 #error CONFIG_INIT_CRITICAL is deprecated!
754 #error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
757 #define ROUND(a,b) (((a) + (b) - 1) & ~((b) - 1))
760 * check_member() - Check the offset of a structure member
762 * @structure: Name of structure (e.g. global_data)
763 * @member: Name of member (e.g. baudrate)
764 * @offset: Expected offset in bytes
766 #define check_member(structure, member, offset) _Static_assert( \
767 offsetof(struct structure, member) == offset, \
768 "`struct " #structure "` offset for `" #member "` is not " #offset)
770 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
771 #ifdef CONFIG_EFI_STUB
772 #define ll_boot_init() false
774 #define ll_boot_init() true
777 /* Pull in stuff for the build system */
779 # include <environment.h>
782 #endif /* __COMMON_H_ */