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 like command.h. 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 int run_command(const char *cmd, int flag);
  70 int run_command_repeatable(const char *cmd, int flag);
  71
  72 /**
  73  * Run a list of commands separated by ; or even \0
  74  *
  75  * Note that if 'len' is not -1, then the command does not need to be nul
  76  * terminated, Memory will be allocated for the command in that case.
  77  *
  78  * @param cmd   List of commands to run, each separated bu semicolon
  79  * @param len   Length of commands excluding terminator if known (-1 if not)
  80  * @param flag  Execution flags (CMD_FLAG_...)
  81  * @return 0 on success, or != 0 on error.
  82  */
  83 int run_command_list(const char *cmd, int len, int flag);
  84
  85 int checkflash(void);
  86 int checkdram(void);
  87 extern u8 __dtb_dt_begin[];     /* embedded device tree blob */
  88 extern u8 __dtb_dt_spl_begin[]; /* embedded device tree blob for SPL/TPL */
  89 int mdm_init(void);
  90
  91 /**
  92  * Show the DRAM size in a board-specific way
  93  *
  94  * This is used by boards to display DRAM information in their own way.
  95  *
  96  * @param size  Size of DRAM (which should be displayed along with other info)
  97  */
  98 void board_show_dram(phys_size_t size);
  99
 100 /**
 101  * Get the uppermost pointer that is valid to access
 102  *
 103  * Some systems may not map all of their address space. This function allows
 104  * boards to indicate what their highest support pointer value is for DRAM
 105  * access.
 106  *
 107  * @param total_size    Size of U-Boot (unused?)
 108  */
 109 ulong board_get_usable_ram_top(ulong total_size);
 110
 111 /**
 112  * arch_fixup_fdt() - Write arch-specific information to fdt
 113  *
 114  * Defined in arch/$(ARCH)/lib/bootm-fdt.c
 115  *
 116  * @blob:       FDT blob to write to
 117  * @return 0 if ok, or -ve FDT_ERR_... on failure
 118  */
 119 int arch_fixup_fdt(void *blob);
 120
 121 /* common/flash.c */
 122 void flash_perror (int);
 123
 124 /* common/cmd_source.c */
 125 int     source (ulong addr, const char *fit_uname);
 126
 127 extern ulong load_addr;         /* Default Load Address */
 128 extern ulong save_addr;         /* Default Save Address */
 129 extern ulong save_size;         /* Default Save Size */
 130
 131 /* common/cmd_net.c */
 132 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 133
 134 /* common/cmd_fat.c */
 135 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
 136
 137 /* common/cmd_ext2.c */
 138 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
 139
 140 void    pci_init_board(void);
 141
 142 /* common/exports.c */
 143 void    jumptable_init(void);
 144
 145 /* common/kallsysm.c */
 146 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
 147
 148 /* common/memsize.c */
 149 long    get_ram_size  (long *, long);
 150 phys_size_t get_effective_memsize(void);
 151
 152 /* $(BOARD)/$(BOARD).c */
 153 void    reset_phy     (void);
 154 void    fdc_hw_init   (void);
 155
 156 /* $(BOARD)/eeprom.c */
 157 #ifdef CONFIG_CMD_EEPROM
 158 void eeprom_init  (int bus);
 159 int  eeprom_read  (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
 160 int  eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
 161 #else
 162 /*
 163  * Some EEPROM code is depecated because it used the legacy I2C interface. Add
 164  * some macros here so we don't have to touch every one of those uses
 165  */
 166 #define eeprom_init(bus)
 167 #define eeprom_read(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
 168 #define eeprom_write(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
 169 #endif
 170
 171 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C) && defined(CONFIG_SYS_I2C_EEPROM_ADDR)
 172 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
 173 #endif
 174
 175 /* $(BOARD)/$(BOARD).c */
 176 int board_early_init_f (void);
 177 int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */
 178 int board_late_init (void);
 179 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
 180 int board_early_init_r (void);
 181
 182 #if defined(CONFIG_SYS_DRAM_TEST)
 183 int testdram(void);
 184 #endif /* CONFIG_SYS_DRAM_TEST */
 185
 186 #if defined(CONFIG_ARM)
 187 void    relocate_code(ulong);
 188 #else
 189 void    relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
 190 #endif
 191 ulong   get_endaddr   (void);
 192 void    trap_init     (ulong);
 193
 194 void s_init(void);
 195
 196 void    upmconfig     (unsigned int, unsigned int *, unsigned int);
 197 ulong   get_tbclk     (void);
 198 void    reset_misc    (void);
 199 void    reset_cpu     (ulong addr);
 200 void ft_cpu_setup(void *blob, bd_t *bd);
 201 void ft_pci_setup(void *blob, bd_t *bd);
 202
 203 /* $(CPU)/speed.c */
 204 int     get_clocks (void);
 205 ulong   get_bus_freq  (ulong);
 206 int get_serial_clock(void);
 207
 208 /* lib/uuid.c */
 209 #include <uuid.h>
 210
 211 /* lib/vsprintf.c */
 212 #include <vsprintf.h>
 213
 214 /* lib/net_utils.c */
 215 #include <net.h>
 216
 217 #include <bootstage.h>
 218
 219 #else   /* __ASSEMBLY__ */
 220
 221 #endif  /* __ASSEMBLY__ */
 222
 223 /* Put only stuff here that the assembler can digest */
 224
 225 #ifdef CONFIG_POST
 226 #define CONFIG_HAS_POST
 227 #ifndef CONFIG_POST_ALT_LIST
 228 #define CONFIG_POST_STD_LIST
 229 #endif
 230 #endif
 231
 232 #define ROUND(a,b)              (((a) + (b) - 1) & ~((b) - 1))
 233
 234 /*
 235  * check_member() - Check the offset of a structure member
 236  *
 237  * @structure:  Name of structure (e.g. global_data)
 238  * @member:     Name of member (e.g. baudrate)
 239  * @offset:     Expected offset in bytes
 240  */
 241 #define check_member(structure, member, offset) _Static_assert( \
 242         offsetof(struct structure, member) == offset, \
 243         "`struct " #structure "` offset for `" #member "` is not " #offset)
 244
 245 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
 246 #ifdef CONFIG_EFI_STUB
 247 #define ll_boot_init()  false
 248 #else
 249 #define ll_boot_init()  true
 250 #endif
 251
 252 /* Pull in stuff for the build system */
 253 #ifdef DO_DEPS_ONLY
 254 # include <env_internal.h>
 255 #endif
 256
 257 #endif  /* __COMMON_H_ */