include/common.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * Common header file for U-Boot
   4  *
   5  * This file still includes quite a bit of stuff that should be in separate
   6  * headers. Please think before adding more things.
   7  * Patches to remove things are welcome.
   8  *
   9  * (C) Copyright 2000-2009
  10  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
  11  */
  12
  13 #ifndef __COMMON_H_
  14 #define __COMMON_H_     1
  15
  16 #ifndef __ASSEMBLY__            /* put C only stuff in this section */
  17
  18 typedef volatile unsigned long  vu_long;
  19 typedef volatile unsigned short vu_short;
  20 typedef volatile unsigned char  vu_char;
  21
  22 #include <config.h>
  23 #include <errno.h>
  24 #include <time.h>
  25 #include <asm-offsets.h>
  26 #include <linux/bitops.h>
  27 #include <linux/bug.h>
  28 #include <linux/delay.h>
  29 #include <linux/types.h>
  30 #include <linux/printk.h>
  31 #include <linux/string.h>
  32 #include <linux/stringify.h>
  33 #include <asm/ptrace.h>
  34 #include <stdarg.h>
  35 #include <stdio.h>
  36 #include <linux/kernel.h>
  37
  38 #include <part.h>
  39 #include <flash.h>
  40 #include <image.h>
  41
  42 #ifdef __LP64__
  43 #define CONFIG_SYS_SUPPORT_64BIT_DATA
  44 #endif
  45
  46 #include <log.h>
  47
  48 #include <asm/u-boot.h> /* boot information for Linux kernel */
  49 #include <asm/global_data.h>    /* global data used for startup functions */
  50
  51 /* startup functions, used in:
  52  * common/board_f.c
  53  * common/init/board_init.c
  54  * common/board_r.c
  55  * common/board_info.c
  56  */
  57 #include <init.h>
  58
  59 /*
  60  * Function Prototypes
  61  */
  62 void    hang            (void) __attribute__ ((noreturn));
  63
  64 #include <display_options.h>
  65
  66 extern u8 __dtb_dt_begin[];     /* embedded device tree blob */
  67 extern u8 __dtb_dt_spl_begin[]; /* embedded device tree blob for SPL/TPL */
  68
  69 /**
  70  * arch_fixup_fdt() - Write arch-specific information to fdt
  71  *
  72  * Defined in arch/$(ARCH)/lib/bootm-fdt.c
  73  *
  74  * @blob:       FDT blob to write to
  75  * @return 0 if ok, or -ve FDT_ERR_... on failure
  76  */
  77 int arch_fixup_fdt(void *blob);
  78
  79 /* common/cmd_source.c */
  80 int     source (ulong addr, const char *fit_uname);
  81
  82 extern ulong load_addr;         /* Default Load Address */
  83 extern ulong save_addr;         /* Default Save Address */
  84 extern ulong save_size;         /* Default Save Size */
  85
  86 /* common/cmd_net.c */
  87 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
  88
  89 /* common/cmd_fat.c */
  90 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
  91
  92 /* common/cmd_ext2.c */
  93 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
  94
  95 /* common/exports.c */
  96 void    jumptable_init(void);
  97
  98 /* common/kallsysm.c */
  99 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
 100
 101 /* common/memsize.c */
 102 long    get_ram_size  (long *, long);
 103 phys_size_t get_effective_memsize(void);
 104
 105 /* $(BOARD)/$(BOARD).c */
 106 void    reset_phy     (void);
 107 void    fdc_hw_init   (void);
 108
 109 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C) && defined(CONFIG_SYS_I2C_EEPROM_ADDR)
 110 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
 111 #endif
 112
 113 #if defined(CONFIG_SYS_DRAM_TEST)
 114 int testdram(void);
 115 #endif /* CONFIG_SYS_DRAM_TEST */
 116
 117 #if defined(CONFIG_ARM)
 118 void    relocate_code(ulong);
 119 #else
 120 void    relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
 121 #endif
 122
 123 void s_init(void);
 124
 125 void    upmconfig     (unsigned int, unsigned int *, unsigned int);
 126 ulong   get_tbclk     (void);
 127 void    reset_misc    (void);
 128 void    reset_cpu     (ulong addr);
 129 void ft_cpu_setup(void *blob, bd_t *bd);
 130 void ft_pci_setup(void *blob, bd_t *bd);
 131
 132 /* $(CPU)/speed.c */
 133 int     get_clocks (void);
 134 ulong   get_bus_freq  (ulong);
 135 int get_serial_clock(void);
 136
 137 /* lib/uuid.c */
 138 #include <uuid.h>
 139
 140 /* lib/vsprintf.c */
 141 #include <vsprintf.h>
 142
 143 /* lib/net_utils.c */
 144 #include <net.h>
 145
 146 #include <bootstage.h>
 147
 148 #else   /* __ASSEMBLY__ */
 149
 150 #endif  /* __ASSEMBLY__ */
 151
 152 /* Put only stuff here that the assembler can digest */
 153
 154 #ifdef CONFIG_POST
 155 #define CONFIG_HAS_POST
 156 #ifndef CONFIG_POST_ALT_LIST
 157 #define CONFIG_POST_STD_LIST
 158 #endif
 159 #endif
 160
 161 #define ROUND(a,b)              (((a) + (b) - 1) & ~((b) - 1))
 162
 163 /*
 164  * check_member() - Check the offset of a structure member
 165  *
 166  * @structure:  Name of structure (e.g. global_data)
 167  * @member:     Name of member (e.g. baudrate)
 168  * @offset:     Expected offset in bytes
 169  */
 170 #define check_member(structure, member, offset) _Static_assert( \
 171         offsetof(struct structure, member) == offset, \
 172         "`struct " #structure "` offset for `" #member "` is not " #offset)
 173
 174 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
 175 #ifdef CONFIG_EFI_STUB
 176 #define ll_boot_init()  false
 177 #else
 178 #define ll_boot_init()  true
 179 #endif
 180
 181 /* Pull in stuff for the build system */
 182 #ifdef DO_DEPS_ONLY
 183 # include <env_internal.h>
 184 #endif
 185
 186 #endif  /* __COMMON_H_ */