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 unsigned char           uchar;
  19 typedef volatile unsigned long  vu_long;
  20 typedef volatile unsigned short vu_short;
  21 typedef volatile unsigned char  vu_char;
  22
  23 #include <config.h>
  24 #include <errno.h>
  25 #include <time.h>
  26 #include <asm-offsets.h>
  27 #include <linux/bitops.h>
  28 #include <linux/bug.h>
  29 #include <linux/delay.h>
  30 #include <linux/types.h>
  31 #include <linux/printk.h>
  32 #include <linux/string.h>
  33 #include <linux/stringify.h>
  34 #include <asm/ptrace.h>
  35 #include <stdarg.h>
  36 #include <stdio.h>
  37 #include <linux/kernel.h>
  38
  39 #include <part.h>
  40 #include <flash.h>
  41 #include <image.h>
  42
  43 #ifdef __LP64__
  44 #define CONFIG_SYS_SUPPORT_64BIT_DATA
  45 #endif
  46
  47 #include <log.h>
  48
  49 #include <asm/u-boot.h> /* boot information for Linux kernel */
  50 #include <asm/global_data.h>    /* global data used for startup functions */
  51
  52 /* startup functions, used in:
  53  * common/board_f.c
  54  * common/init/board_init.c
  55  * common/board_r.c
  56  * common/board_info.c
  57  */
  58 #include <init.h>
  59
  60 /*
  61  * Function Prototypes
  62  */
  63 void    hang            (void) __attribute__ ((noreturn));
  64
  65 #include <display_options.h>
  66
  67 /* common/main.c */
  68 void    main_loop       (void);
  69
  70 int checkflash(void);
  71 int checkdram(void);
  72 extern u8 __dtb_dt_begin[];     /* embedded device tree blob */
  73 extern u8 __dtb_dt_spl_begin[]; /* embedded device tree blob for SPL/TPL */
  74 int mdm_init(void);
  75
  76 /**
  77  * Show the DRAM size in a board-specific way
  78  *
  79  * This is used by boards to display DRAM information in their own way.
  80  *
  81  * @param size  Size of DRAM (which should be displayed along with other info)
  82  */
  83 void board_show_dram(phys_size_t size);
  84
  85 /**
  86  * Get the uppermost pointer that is valid to access
  87  *
  88  * Some systems may not map all of their address space. This function allows
  89  * boards to indicate what their highest support pointer value is for DRAM
  90  * access.
  91  *
  92  * @param total_size    Size of U-Boot (unused?)
  93  */
  94 ulong board_get_usable_ram_top(ulong total_size);
  95
  96 /**
  97  * arch_fixup_fdt() - Write arch-specific information to fdt
  98  *
  99  * Defined in arch/$(ARCH)/lib/bootm-fdt.c
 100  *
 101  * @blob:       FDT blob to write to
 102  * @return 0 if ok, or -ve FDT_ERR_... on failure
 103  */
 104 int arch_fixup_fdt(void *blob);
 105
 106 /* common/flash.c */
 107 void flash_perror (int);
 108
 109 /* common/cmd_source.c */
 110 int     source (ulong addr, const char *fit_uname);
 111
 112 extern ulong load_addr;         /* Default Load Address */
 113 extern ulong save_addr;         /* Default Save Address */
 114 extern ulong save_size;         /* Default Save Size */
 115
 116 /* common/cmd_net.c */
 117 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 118
 119 /* common/cmd_fat.c */
 120 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
 121
 122 /* common/cmd_ext2.c */
 123 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
 124
 125 void    pci_init_board(void);
 126
 127 /* common/exports.c */
 128 void    jumptable_init(void);
 129
 130 /* common/kallsysm.c */
 131 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
 132
 133 /* common/memsize.c */
 134 long    get_ram_size  (long *, long);
 135 phys_size_t get_effective_memsize(void);
 136
 137 /* $(BOARD)/$(BOARD).c */
 138 void    reset_phy     (void);
 139 void    fdc_hw_init   (void);
 140
 141 /* $(BOARD)/eeprom.c */
 142 #ifdef CONFIG_CMD_EEPROM
 143 void eeprom_init  (int bus);
 144 int  eeprom_read  (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
 145 int  eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
 146 #else
 147 /*
 148  * Some EEPROM code is depecated because it used the legacy I2C interface. Add
 149  * some macros here so we don't have to touch every one of those uses
 150  */
 151 #define eeprom_init(bus)
 152 #define eeprom_read(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
 153 #define eeprom_write(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
 154 #endif
 155
 156 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C) && defined(CONFIG_SYS_I2C_EEPROM_ADDR)
 157 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
 158 #endif
 159
 160 /* $(BOARD)/$(BOARD).c */
 161 int board_early_init_f (void);
 162 int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */
 163 int board_late_init (void);
 164 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
 165 int board_early_init_r (void);
 166
 167 #if defined(CONFIG_SYS_DRAM_TEST)
 168 int testdram(void);
 169 #endif /* CONFIG_SYS_DRAM_TEST */
 170
 171 #if defined(CONFIG_ARM)
 172 void    relocate_code(ulong);
 173 #else
 174 void    relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
 175 #endif
 176 ulong   get_endaddr   (void);
 177 void    trap_init     (ulong);
 178
 179 void s_init(void);
 180
 181 void    upmconfig     (unsigned int, unsigned int *, unsigned int);
 182 ulong   get_tbclk     (void);
 183 void    reset_misc    (void);
 184 void    reset_cpu     (ulong addr);
 185 void ft_cpu_setup(void *blob, bd_t *bd);
 186 void ft_pci_setup(void *blob, bd_t *bd);
 187
 188 /* $(CPU)/speed.c */
 189 int     get_clocks (void);
 190 ulong   get_bus_freq  (ulong);
 191 int get_serial_clock(void);
 192
 193 /* lib/uuid.c */
 194 #include <uuid.h>
 195
 196 /* lib/vsprintf.c */
 197 #include <vsprintf.h>
 198
 199 /* lib/net_utils.c */
 200 #include <net.h>
 201
 202 #include <bootstage.h>
 203
 204 #else   /* __ASSEMBLY__ */
 205
 206 #endif  /* __ASSEMBLY__ */
 207
 208 /* Put only stuff here that the assembler can digest */
 209
 210 #ifdef CONFIG_POST
 211 #define CONFIG_HAS_POST
 212 #ifndef CONFIG_POST_ALT_LIST
 213 #define CONFIG_POST_STD_LIST
 214 #endif
 215 #endif
 216
 217 #define ROUND(a,b)              (((a) + (b) - 1) & ~((b) - 1))
 218
 219 /*
 220  * check_member() - Check the offset of a structure member
 221  *
 222  * @structure:  Name of structure (e.g. global_data)
 223  * @member:     Name of member (e.g. baudrate)
 224  * @offset:     Expected offset in bytes
 225  */
 226 #define check_member(structure, member, offset) _Static_assert( \
 227         offsetof(struct structure, member) == offset, \
 228         "`struct " #structure "` offset for `" #member "` is not " #offset)
 229
 230 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
 231 #ifdef CONFIG_EFI_STUB
 232 #define ll_boot_init()  false
 233 #else
 234 #define ll_boot_init()  true
 235 #endif
 236
 237 /* Pull in stuff for the build system */
 238 #ifdef DO_DEPS_ONLY
 239 # include <env_internal.h>
 240 #endif
 241
 242 #endif  /* __COMMON_H_ */