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 int checkflash(void);
  67 int checkdram(void);
  68 extern u8 __dtb_dt_begin[];     /* embedded device tree blob */
  69 extern u8 __dtb_dt_spl_begin[]; /* embedded device tree blob for SPL/TPL */
  70
  71 /**
  72  * arch_fixup_fdt() - Write arch-specific information to fdt
  73  *
  74  * Defined in arch/$(ARCH)/lib/bootm-fdt.c
  75  *
  76  * @blob:       FDT blob to write to
  77  * @return 0 if ok, or -ve FDT_ERR_... on failure
  78  */
  79 int arch_fixup_fdt(void *blob);
  80
  81 /* common/flash.c */
  82 void flash_perror (int);
  83
  84 /* common/cmd_source.c */
  85 int     source (ulong addr, const char *fit_uname);
  86
  87 extern ulong load_addr;         /* Default Load Address */
  88 extern ulong save_addr;         /* Default Save Address */
  89 extern ulong save_size;         /* Default Save Size */
  90
  91 /* common/cmd_net.c */
  92 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
  93
  94 /* common/cmd_fat.c */
  95 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
  96
  97 /* common/cmd_ext2.c */
  98 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
  99
 100 /* common/exports.c */
 101 void    jumptable_init(void);
 102
 103 /* common/kallsysm.c */
 104 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
 105
 106 /* common/memsize.c */
 107 long    get_ram_size  (long *, long);
 108 phys_size_t get_effective_memsize(void);
 109
 110 /* $(BOARD)/$(BOARD).c */
 111 void    reset_phy     (void);
 112 void    fdc_hw_init   (void);
 113
 114 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C) && defined(CONFIG_SYS_I2C_EEPROM_ADDR)
 115 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
 116 #endif
 117
 118 #if defined(CONFIG_SYS_DRAM_TEST)
 119 int testdram(void);
 120 #endif /* CONFIG_SYS_DRAM_TEST */
 121
 122 #if defined(CONFIG_ARM)
 123 void    relocate_code(ulong);
 124 #else
 125 void    relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
 126 #endif
 127
 128 void s_init(void);
 129
 130 void    upmconfig     (unsigned int, unsigned int *, unsigned int);
 131 ulong   get_tbclk     (void);
 132 void    reset_misc    (void);
 133 void    reset_cpu     (ulong addr);
 134 void ft_cpu_setup(void *blob, bd_t *bd);
 135 void ft_pci_setup(void *blob, bd_t *bd);
 136
 137 /* $(CPU)/speed.c */
 138 int     get_clocks (void);
 139 ulong   get_bus_freq  (ulong);
 140 int get_serial_clock(void);
 141
 142 /* lib/uuid.c */
 143 #include <uuid.h>
 144
 145 /* lib/vsprintf.c */
 146 #include <vsprintf.h>
 147
 148 /* lib/net_utils.c */
 149 #include <net.h>
 150
 151 #include <bootstage.h>
 152
 153 #else   /* __ASSEMBLY__ */
 154
 155 #endif  /* __ASSEMBLY__ */
 156
 157 /* Put only stuff here that the assembler can digest */
 158
 159 #ifdef CONFIG_POST
 160 #define CONFIG_HAS_POST
 161 #ifndef CONFIG_POST_ALT_LIST
 162 #define CONFIG_POST_STD_LIST
 163 #endif
 164 #endif
 165
 166 #define ROUND(a,b)              (((a) + (b) - 1) & ~((b) - 1))
 167
 168 /*
 169  * check_member() - Check the offset of a structure member
 170  *
 171  * @structure:  Name of structure (e.g. global_data)
 172  * @member:     Name of member (e.g. baudrate)
 173  * @offset:     Expected offset in bytes
 174  */
 175 #define check_member(structure, member, offset) _Static_assert( \
 176         offsetof(struct structure, member) == offset, \
 177         "`struct " #structure "` offset for `" #member "` is not " #offset)
 178
 179 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
 180 #ifdef CONFIG_EFI_STUB
 181 #define ll_boot_init()  false
 182 #else
 183 #define ll_boot_init()  true
 184 #endif
 185
 186 /* Pull in stuff for the build system */
 187 #ifdef DO_DEPS_ONLY
 188 # include <env_internal.h>
 189 #endif
 190
 191 #endif  /* __COMMON_H_ */