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