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_SOC_DA8XX
35 #include <asm/arch/hardware.h>
37 #ifdef CONFIG_FSL_LSCH3
38 #include <asm/arch/immap_lsch3.h>
40 #ifdef CONFIG_FSL_LSCH2
41 #include <asm/arch/immap_lsch2.h>
48 /* Bring in printf format macros if inttypes.h is included */
49 #define __STDC_FORMAT_MACROS
52 #define CONFIG_SYS_SUPPORT_64BIT_DATA
61 #ifdef CONFIG_SPL_BUILD
67 /* Define this at the top of a file to add a prefix to debug messages */
69 #define pr_fmt(fmt) fmt
73 * Output a debug text when condition "cond" is met. The "cond" should be
74 * computed by a preprocessor in the best case, allowing for the best
77 #define debug_cond(cond, fmt, args...) \
80 printf(pr_fmt(fmt), ##args); \
83 /* Show a message if DEBUG is defined in a file */
84 #define debug(fmt, args...) \
85 debug_cond(_DEBUG, fmt, ##args)
87 /* Show a message if not in SPL */
88 #define warn_non_spl(fmt, args...) \
89 debug_cond(!_SPL_BUILD, fmt, ##args)
92 * An assertion is run-time check done in debug mode only. If DEBUG is not
93 * defined then it is skipped. If DEBUG is defined and the assertion fails,
94 * then it calls panic*( which may or may not reset/halt U-Boot (see
95 * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
96 * before release, and after release it is hoped that they don't matter. But
97 * in any case these failing assertions cannot be fixed with a reset (which
98 * may just do the same assertion again).
100 void __assert_fail(const char *assertion, const char *file, unsigned line,
101 const char *function);
103 ({ if (!(x) && _DEBUG) \
104 __assert_fail(#x, __FILE__, __LINE__, __func__); })
106 #define error(fmt, args...) do { \
107 printf("ERROR: " pr_fmt(fmt) "\nat %s:%d/%s()\n", \
108 ##args, __FILE__, __LINE__, __func__); \
113 printf("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __FUNCTION__); \
116 #define BUG_ON(condition) do { if (unlikely((condition)!=0)) BUG(); } while(0)
119 typedef void (interrupt_handler_t)(void *);
121 #include <asm/u-boot.h> /* boot information for Linux kernel */
122 #include <asm/global_data.h> /* global data used for startup functions */
124 #if defined(CONFIG_ENV_IS_EMBEDDED)
125 #define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
126 #elif ( ((CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) < CONFIG_SYS_MONITOR_BASE) || \
127 (CONFIG_ENV_ADDR >= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) ) || \
128 defined(CONFIG_ENV_IS_IN_NVRAM)
129 #define TOTAL_MALLOC_LEN (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
131 #define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
135 * Function Prototypes
140 * dram_init_banksize() - Set up DRAM bank sizes
142 * This can be implemented by boards to set up the DRAM bank information in
143 * gd->bd->bi_dram(). It is called just before relocation, after dram_init()
146 * If this is not provided, a default implementation will try to set up a
147 * single bank. It will do this if CONFIG_NR_DRAM_BANKS and
148 * CONFIG_SYS_SDRAM_BASE are set. The bank will have a start address of
149 * CONFIG_SYS_SDRAM_BASE and the size will be determined by a call to
150 * get_effective_memsize().
152 * @return 0 if OK, -ve on error
154 int dram_init_banksize(void);
156 void hang (void) __attribute__ ((noreturn));
158 int timer_init(void);
161 #include <display_options.h>
164 void main_loop (void);
165 int run_command(const char *cmd, int flag);
166 int run_command_repeatable(const char *cmd, int flag);
169 * Run a list of commands separated by ; or even \0
171 * Note that if 'len' is not -1, then the command does not need to be nul
172 * terminated, Memory will be allocated for the command in that case.
174 * @param cmd List of commands to run, each separated bu semicolon
175 * @param len Length of commands excluding terminator if known (-1 if not)
176 * @param flag Execution flags (CMD_FLAG_...)
177 * @return 0 on success, or != 0 on error.
179 int run_command_list(const char *cmd, int len, int flag);
181 /* arch/$(ARCH)/lib/board.c */
182 void board_init_f(ulong);
183 void board_init_r(gd_t *, ulong) __attribute__ ((noreturn));
186 * ulong board_init_f_alloc_reserve - allocate reserved area
188 * This function is called by each architecture very early in the start-up
189 * code to allow the C runtime to reserve space on the stack for writable
190 * 'globals' such as GD and the malloc arena.
192 * @top: top of the reserve area, growing down.
193 * @return: bottom of reserved area
195 ulong board_init_f_alloc_reserve(ulong top);
198 * board_init_f_init_reserve - initialize the reserved area(s)
200 * This function is called once the C runtime has allocated the reserved
201 * area on the stack. It must initialize the GD at the base of that area.
203 * @base: top from which reservation was done
205 void board_init_f_init_reserve(ulong base);
208 * arch_setup_gd() - Set up the global_data pointer
210 * This pointer is special in some architectures and cannot easily be assigned
211 * to. For example on x86 it is implemented by adding a specific record to its
212 * Global Descriptor Table! So we we provide a function to carry out this task.
213 * For most architectures this can simply be:
217 * @gd_ptr: Pointer to global data
219 void arch_setup_gd(gd_t *gd_ptr);
221 int checkboard(void);
222 int show_board_info(void);
223 int checkflash(void);
225 int last_stage_init(void);
226 extern ulong monitor_flash_len;
227 int mac_read_from_eeprom(void);
228 extern u8 __dtb_dt_begin[]; /* embedded device tree blob */
229 int set_cpu_clk_info(void);
231 int print_cpuinfo(void);
232 int update_flash_size(int flash_size);
233 int arch_early_init_r(void);
236 * setup_board_extra() - Fill in extra details in the bd_t structure
238 * @return 0 if OK, -ve on error
240 int setup_board_extra(void);
243 * arch_fsp_init() - perform firmware support package init
245 * Where U-Boot relies on binary blobs to handle part of the system init, this
246 * function can be used to set up the blobs. This is used on some Intel
249 int arch_fsp_init(void);
252 * arch_cpu_init_dm() - init CPU after driver model is available
254 * This is called immediately after driver model is available before
255 * relocation. This is similar to arch_cpu_init() but is able to reference
258 * @return 0 if OK, -ve on error
260 int arch_cpu_init_dm(void);
263 * Reserve all necessary stacks
265 * This is used in generic board init sequence in common/board_f.c. Each
266 * architecture could provide this function to tailor the required stacks.
268 * On entry gd->start_addr_sp is pointing to the suggested top of the stack.
269 * The callee ensures gd->start_add_sp is 16-byte aligned, so architectures
270 * require only this can leave it untouched.
272 * On exit gd->start_addr_sp and gd->irq_sp should be set to the respective
273 * positions of the stack. The stack pointer(s) will be set to this later.
274 * gd->irq_sp is only required, if the architecture needs it.
276 * @return 0 if no error
278 __weak int arch_reserve_stacks(void);
281 * Show the DRAM size in a board-specific way
283 * This is used by boards to display DRAM information in their own way.
285 * @param size Size of DRAM (which should be displayed along with other info)
287 void board_show_dram(phys_size_t size);
290 * arch_fixup_fdt() - Write arch-specific information to fdt
292 * Defined in arch/$(ARCH)/lib/bootm-fdt.c
294 * @blob: FDT blob to write to
295 * @return 0 if ok, or -ve FDT_ERR_... on failure
297 int arch_fixup_fdt(void *blob);
300 void flash_perror (int);
302 /* common/cmd_source.c */
303 int source (ulong addr, const char *fit_uname);
305 extern ulong load_addr; /* Default Load Address */
306 extern ulong save_addr; /* Default Save Address */
307 extern ulong save_size; /* Default Save Size */
309 /* common/cmd_net.c */
310 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
312 /* common/cmd_fat.c */
313 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
315 /* common/cmd_ext2.c */
316 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
318 /* common/cmd_nvedit.c */
320 void env_relocate (void);
321 int envmatch (uchar *, int);
323 /* Avoid unfortunate conflict with libc's getenv() */
324 #ifdef CONFIG_SANDBOX
325 #define getenv uboot_getenv
327 char *getenv (const char *);
328 int getenv_f (const char *name, char *buf, unsigned len);
329 ulong getenv_ulong(const char *name, int base, ulong default_val);
332 * getenv_hex() - Return an environment variable as a hex value
334 * Decode an environment as a hex number (it may or may not have a 0x
335 * prefix). If the environment variable cannot be found, or does not start
336 * with hex digits, the default value is returned.
338 * @varname: Variable to decode
339 * @default_val: Value to return on error
341 ulong getenv_hex(const char *varname, ulong default_val);
344 * Read an environment variable as a boolean
345 * Return -1 if variable does not exist (default to true)
347 int getenv_yesno(const char *var);
349 int setenv (const char *, const char *);
350 int setenv_ulong(const char *varname, ulong value);
351 int setenv_hex(const char *varname, ulong value);
353 * setenv_addr - Set an environment variable to an address in hex
355 * @varname: Environment variable to set
356 * @addr: Value to set it to
357 * @return 0 if ok, 1 on error
359 static inline int setenv_addr(const char *varname, const void *addr)
361 return setenv_hex(varname, (ulong)addr);
364 #ifdef CONFIG_AUTO_COMPLETE
365 int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
367 int get_env_id (void);
369 void pci_init (void);
370 void pci_init_board(void);
372 int misc_init_f (void);
373 int misc_init_r (void);
375 /* common/exports.c */
376 void jumptable_init(void);
378 /* common/kallsysm.c */
379 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
381 /* common/memsize.c */
382 long get_ram_size (long *, long);
383 phys_size_t get_effective_memsize(void);
385 /* $(BOARD)/$(BOARD).c */
386 void reset_phy (void);
387 void fdc_hw_init (void);
389 /* $(BOARD)/eeprom.c */
390 #ifdef CONFIG_CMD_EEPROM
391 void eeprom_init (int bus);
392 int eeprom_read (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
393 int eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
396 * Some EEPROM code is depecated because it used the legacy I2C interface. Add
397 * some macros here so we don't have to touch every one of those uses
399 #define eeprom_init(bus)
400 #define eeprom_read(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
401 #define eeprom_write(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
405 * Set this up regardless of board
406 * type, to prevent errors.
408 #if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
409 # define CONFIG_SYS_DEF_EEPROM_ADDR 0
411 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
412 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
414 #endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
416 #if defined(CONFIG_SPI)
417 extern void spi_init_f (void);
418 extern void spi_init_r (void);
419 extern ssize_t spi_read (uchar *, int, uchar *, int);
420 extern ssize_t spi_write (uchar *, int, uchar *, int);
423 /* $(BOARD)/$(BOARD).c */
424 int board_early_init_f (void);
425 int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */
426 int board_late_init (void);
427 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
428 int board_early_init_r (void);
429 void board_poweroff (void);
431 #if defined(CONFIG_SYS_DRAM_TEST)
433 #endif /* CONFIG_SYS_DRAM_TEST */
436 int icache_status (void);
437 void icache_enable (void);
438 void icache_disable(void);
439 int dcache_status (void);
440 void dcache_enable (void);
441 void dcache_disable(void);
442 void mmu_disable(void);
443 #if defined(CONFIG_ARM)
444 void relocate_code(ulong);
446 void relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
448 ulong get_endaddr (void);
449 void trap_init (ulong);
451 #if defined (CONFIG_MICROBLAZE)
452 unsigned short in16(unsigned int);
453 void out16(unsigned int, unsigned short value);
457 static inline int cpumask_next(int cpu, unsigned int mask)
459 for (cpu++; !((1 << cpu) & mask); cpu++)
465 #define for_each_cpu(iter, cpu, num_cpus, mask) \
466 for (iter = 0, cpu = cpumask_next(-1, mask); \
468 iter++, cpu = cpumask_next(cpu, mask)) \
470 int cpu_numcores (void);
471 int cpu_num_dspcores(void);
473 u32 cpu_dsp_mask(void);
474 int is_core_valid (unsigned int);
477 * arch_cpu_init() - basic cpu-dependent setup for an architecture
479 * This is called after early malloc is available. It should handle any
480 * CPU- or SoC- specific init needed to continue the init sequence. See
481 * board_f.c for where it is called. If this is not provided, a default
482 * version (which does nothing) will be used.
484 int arch_cpu_init(void);
487 int checkicache (void);
488 int checkdcache (void);
489 void upmconfig (unsigned int, unsigned int *, unsigned int);
490 ulong get_tbclk (void);
491 void reset_misc (void);
492 void reset_cpu (ulong addr);
493 void ft_cpu_setup(void *blob, bd_t *bd);
494 void ft_pci_setup(void *blob, bd_t *bd);
496 void smp_set_core_boot_addr(unsigned long addr, int corenr);
497 void smp_kick_all_cpus(void);
499 /* $(CPU)/serial.c */
500 int serial_init (void);
501 void serial_setbrg (void);
502 void serial_putc (const char);
503 void serial_putc_raw(const char);
504 void serial_puts (const char *);
505 int serial_getc (void);
506 int serial_tstc (void);
508 /* These versions take a stdio_dev pointer */
510 int serial_stub_getc(struct stdio_dev *sdev);
511 int serial_stub_tstc(struct stdio_dev *sdev);
514 int get_clocks (void);
515 #if defined(CONFIG_LH7A40X) || \
516 defined(CONFIG_EP93XX)
517 ulong get_FCLK (void);
518 ulong get_HCLK (void);
519 ulong get_PCLK (void);
520 ulong get_UCLK (void);
522 #if defined(CONFIG_LH7A40X)
523 ulong get_PLLCLK (void);
525 #if defined(CONFIG_IMX)
526 ulong get_systemPLLCLK(void);
527 ulong get_FCLK(void);
528 ulong get_HCLK(void);
529 ulong get_BCLK(void);
530 ulong get_PERCLK1(void);
531 ulong get_PERCLK2(void);
532 ulong get_PERCLK3(void);
534 ulong get_bus_freq (ulong);
535 int get_serial_clock(void);
537 int cpu_init_r (void);
539 /* $(CPU)/interrupts.c */
540 int interrupt_init (void);
541 void timer_interrupt (struct pt_regs *);
542 void external_interrupt (struct pt_regs *);
543 void irq_install_handler(int, interrupt_handler_t *, void *);
544 void irq_free_handler (int);
545 void reset_timer (void);
547 /* Return value of monotonic microsecond timer */
548 unsigned long timer_get_us(void);
550 void enable_interrupts (void);
551 int disable_interrupts (void);
553 /* $(CPU)/.../commproc.c */
554 int dpram_init (void);
555 uint dpram_base(void);
556 uint dpram_base_align(uint align);
557 uint dpram_alloc(uint size);
558 uint dpram_alloc_align(uint size,uint align);
559 void bootcount_store (ulong);
560 ulong bootcount_load (void);
561 #define BOOTCOUNT_MAGIC 0xB001C041
563 /* $(CPU)/.../<eth> */
564 void mii_init (void);
566 /* $(CPU)/.../lcd.c */
567 ulong lcd_setmem (ulong);
569 /* $(CPU)/.../video.c */
570 ulong video_setmem (ulong);
572 /* arch/$(ARCH)/lib/cache.c */
573 void enable_caches(void);
574 void flush_cache (unsigned long, unsigned long);
575 void flush_dcache_all(void);
576 void flush_dcache_range(unsigned long start, unsigned long stop);
577 void invalidate_dcache_range(unsigned long start, unsigned long stop);
578 void invalidate_dcache_all(void);
579 void invalidate_icache_all(void);
582 /* Disable caches (else flush caches but leave them active) */
583 CBL_DISABLE_CACHES = 1 << 0,
584 CBL_SHOW_BOOTSTAGE_REPORT = 1 << 1,
590 * Clean up ready for linux
592 * @param flags Flags to control what is done
594 int cleanup_before_linux_select(int flags);
596 /* arch/$(ARCH)/lib/ticks.S */
597 uint64_t get_ticks(void);
598 void wait_ticks (unsigned long);
600 /* arch/$(ARCH)/lib/time.c */
601 ulong usec2ticks (unsigned long usec);
602 ulong ticks2usec (unsigned long ticks);
605 int gunzip(void *, int, unsigned char *, unsigned long *);
606 int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
607 int stoponerr, int offset);
610 * gzwrite progress indicators: defined weak to allow board-specific
613 * gzwrite_progress_init called on startup
614 * gzwrite_progress called during decompress/write loop
615 * gzwrite_progress_finish called at end of loop to
616 * indicate success (retcode=0) or failure
618 void gzwrite_progress_init(u64 expected_size);
620 void gzwrite_progress(int iteration,
624 void gzwrite_progress_finish(int retcode,
631 * decompress and write gzipped image from memory to block device
633 * @param src compressed image address
634 * @param len compressed image length in bytes
635 * @param dev block device descriptor
636 * @param szwritebuf bytes per write (pad to erase size)
637 * @param startoffs offset in bytes of first write
638 * @param szexpected expected uncompressed length
639 * may be zero to use gzip trailer
640 * for files under 4GiB
642 int gzwrite(unsigned char *src, int len,
643 struct blk_desc *dev,
644 unsigned long szwritebuf,
648 /* lib/lz4_wrapper.c */
649 int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn);
652 void qsort(void *base, size_t nmemb, size_t size,
653 int(*compar)(const void *, const void *));
654 int strcmp_compar(const void *, const void *);
660 #include <vsprintf.h>
663 char * strmhz(char *buf, unsigned long hz);
666 #include <u-boot/crc.h>
670 void srand(unsigned int seed);
671 unsigned int rand(void);
672 unsigned int rand_r(unsigned int *seedp);
675 * STDIO based functions (can always be used)
678 int serial_printf (const char *fmt, ...)
679 __attribute__ ((format (__printf__, 1, 2)));
685 #if !defined(CONFIG_SPL_BUILD) || \
686 (defined(CONFIG_TPL_BUILD) && defined(CONFIG_TPL_SERIAL_SUPPORT)) || \
687 (defined(CONFIG_SPL_BUILD) && !defined(CONFIG_TPL_BUILD) && \
688 defined(CONFIG_SPL_SERIAL_SUPPORT))
689 void putc(const char c);
690 void puts(const char *s);
691 int printf(const char *fmt, ...)
692 __attribute__ ((format (__printf__, 1, 2)));
693 int vprintf(const char *fmt, va_list args);
695 #define putc(...) do { } while (0)
696 #define puts(...) do { } while (0)
697 #define printf(...) do { } while (0)
698 #define vprintf(...) do { } while (0)
702 #define eputc(c) fputc(stderr, c)
703 #define eputs(s) fputs(stderr, s)
704 #define eprintf(fmt,args...) fprintf(stderr,fmt ,##args)
707 * FILE based functions (can only be used AFTER relocation!)
714 int fprintf(int file, const char *fmt, ...)
715 __attribute__ ((format (__printf__, 2, 3)));
716 void fputs(int file, const char *s);
717 void fputc(int file, const char c);
722 int gzip(void *dst, unsigned long *lenp,
723 unsigned char *src, unsigned long srclen);
724 int zzip(void *dst, unsigned long *lenp, unsigned char *src,
725 unsigned long srclen, int stoponerr,
726 int (*func)(unsigned long, unsigned long));
728 /* lib/net_utils.c */
730 static inline struct in_addr getenv_ip(char *var)
732 return string_to_ip(getenv(var));
735 int pcmcia_init (void);
737 #ifdef CONFIG_LED_STATUS
738 # include <status_led.h>
741 #include <bootstage.h>
743 #ifdef CONFIG_SHOW_ACTIVITY
744 void show_activity(int arg);
747 /* Multicore arch functions */
749 int cpu_status(int nr);
750 int cpu_reset(int nr);
751 int cpu_disable(int nr);
752 int cpu_release(int nr, int argc, char * const argv[]);
755 #else /* __ASSEMBLY__ */
757 /* Drop a C type modifier (like in 3UL) for constants used in assembly. */
760 #endif /* __ASSEMBLY__ */
762 /* Put only stuff here that the assembler can digest */
764 /* Declare an unsigned long constant digestable both by C and an assembler. */
765 #define UL(x) _AC(x, UL)
768 #define CONFIG_HAS_POST
769 #ifndef CONFIG_POST_ALT_LIST
770 #define CONFIG_POST_STD_LIST
774 #ifdef CONFIG_INIT_CRITICAL
775 #error CONFIG_INIT_CRITICAL is deprecated!
776 #error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
779 #define ROUND(a,b) (((a) + (b) - 1) & ~((b) - 1))
782 * check_member() - Check the offset of a structure member
784 * @structure: Name of structure (e.g. global_data)
785 * @member: Name of member (e.g. baudrate)
786 * @offset: Expected offset in bytes
788 #define check_member(structure, member, offset) _Static_assert( \
789 offsetof(struct structure, member) == offset, \
790 "`struct " #structure "` offset for `" #member "` is not " #offset)
792 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
793 #ifdef CONFIG_EFI_STUB
794 #define ll_boot_init() false
796 #define ll_boot_init() true
799 /* Pull in stuff for the build system */
801 # include <environment.h>
804 #endif /* __COMMON_H_ */