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 and cpu.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 typedef void (interrupt_handler_t)(void *);
  50
  51 #include <asm/u-boot.h> /* boot information for Linux kernel */
  52 #include <asm/global_data.h>    /* global data used for startup functions */
  53
  54 /* startup functions, used in:
  55  * common/board_f.c
  56  * common/init/board_init.c
  57  * common/board_r.c
  58  * common/board_info.c
  59  */
  60 #include <init.h>
  61
  62 /*
  63  * Function Prototypes
  64  */
  65 void    hang            (void) __attribute__ ((noreturn));
  66
  67 #include <display_options.h>
  68
  69 /* common/main.c */
  70 void    main_loop       (void);
  71 int run_command(const char *cmd, int flag);
  72 int run_command_repeatable(const char *cmd, int flag);
  73
  74 /**
  75  * Run a list of commands separated by ; or even \0
  76  *
  77  * Note that if 'len' is not -1, then the command does not need to be nul
  78  * terminated, Memory will be allocated for the command in that case.
  79  *
  80  * @param cmd   List of commands to run, each separated bu semicolon
  81  * @param len   Length of commands excluding terminator if known (-1 if not)
  82  * @param flag  Execution flags (CMD_FLAG_...)
  83  * @return 0 on success, or != 0 on error.
  84  */
  85 int run_command_list(const char *cmd, int len, int flag);
  86
  87 int checkflash(void);
  88 int checkdram(void);
  89 extern u8 __dtb_dt_begin[];     /* embedded device tree blob */
  90 extern u8 __dtb_dt_spl_begin[]; /* embedded device tree blob for SPL/TPL */
  91 int mdm_init(void);
  92
  93 /**
  94  * Show the DRAM size in a board-specific way
  95  *
  96  * This is used by boards to display DRAM information in their own way.
  97  *
  98  * @param size  Size of DRAM (which should be displayed along with other info)
  99  */
 100 void board_show_dram(phys_size_t size);
 101
 102 /**
 103  * Get the uppermost pointer that is valid to access
 104  *
 105  * Some systems may not map all of their address space. This function allows
 106  * boards to indicate what their highest support pointer value is for DRAM
 107  * access.
 108  *
 109  * @param total_size    Size of U-Boot (unused?)
 110  */
 111 ulong board_get_usable_ram_top(ulong total_size);
 112
 113 /**
 114  * arch_fixup_fdt() - Write arch-specific information to fdt
 115  *
 116  * Defined in arch/$(ARCH)/lib/bootm-fdt.c
 117  *
 118  * @blob:       FDT blob to write to
 119  * @return 0 if ok, or -ve FDT_ERR_... on failure
 120  */
 121 int arch_fixup_fdt(void *blob);
 122
 123 /* common/flash.c */
 124 void flash_perror (int);
 125
 126 /* common/cmd_source.c */
 127 int     source (ulong addr, const char *fit_uname);
 128
 129 extern ulong load_addr;         /* Default Load Address */
 130 extern ulong save_addr;         /* Default Save Address */
 131 extern ulong save_size;         /* Default Save Size */
 132
 133 /* common/cmd_net.c */
 134 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 135
 136 /* common/cmd_fat.c */
 137 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
 138
 139 /* common/cmd_ext2.c */
 140 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
 141
 142 void    pci_init_board(void);
 143
 144 /* common/exports.c */
 145 void    jumptable_init(void);
 146
 147 /* common/kallsysm.c */
 148 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
 149
 150 /* common/memsize.c */
 151 long    get_ram_size  (long *, long);
 152 phys_size_t get_effective_memsize(void);
 153
 154 /* $(BOARD)/$(BOARD).c */
 155 void    reset_phy     (void);
 156 void    fdc_hw_init   (void);
 157
 158 /* $(BOARD)/eeprom.c */
 159 #ifdef CONFIG_CMD_EEPROM
 160 void eeprom_init  (int bus);
 161 int  eeprom_read  (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
 162 int  eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
 163 #else
 164 /*
 165  * Some EEPROM code is depecated because it used the legacy I2C interface. Add
 166  * some macros here so we don't have to touch every one of those uses
 167  */
 168 #define eeprom_init(bus)
 169 #define eeprom_read(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
 170 #define eeprom_write(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
 171 #endif
 172
 173 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C) && defined(CONFIG_SYS_I2C_EEPROM_ADDR)
 174 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
 175 #endif
 176
 177 /* $(BOARD)/$(BOARD).c */
 178 int board_early_init_f (void);
 179 int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */
 180 int board_late_init (void);
 181 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
 182 int board_early_init_r (void);
 183
 184 #if defined(CONFIG_SYS_DRAM_TEST)
 185 int testdram(void);
 186 #endif /* CONFIG_SYS_DRAM_TEST */
 187
 188 /* $(CPU)/start.S */
 189 int     icache_status (void);
 190 void    icache_enable (void);
 191 void    icache_disable(void);
 192 int     dcache_status(void);
 193 void    dcache_enable (void);
 194 void    dcache_disable(void);
 195 void    mmu_disable(void);
 196 #if defined(CONFIG_ARM)
 197 void    relocate_code(ulong);
 198 #else
 199 void    relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
 200 #endif
 201 ulong   get_endaddr   (void);
 202 void    trap_init     (ulong);
 203
 204 void s_init(void);
 205
 206 int     checkicache   (void);
 207 int     checkdcache   (void);
 208 void    upmconfig     (unsigned int, unsigned int *, unsigned int);
 209 ulong   get_tbclk     (void);
 210 void    reset_misc    (void);
 211 void    reset_cpu     (ulong addr);
 212 void ft_cpu_setup(void *blob, bd_t *bd);
 213 void ft_pci_setup(void *blob, bd_t *bd);
 214
 215 /* $(CPU)/speed.c */
 216 int     get_clocks (void);
 217 ulong   get_bus_freq  (ulong);
 218 int get_serial_clock(void);
 219
 220 /* $(CPU)/interrupts.c */
 221 int     interrupt_init     (void);
 222 void    timer_interrupt    (struct pt_regs *);
 223 void    external_interrupt (struct pt_regs *);
 224 void    irq_install_handler(int, interrupt_handler_t *, void *);
 225 void    irq_free_handler   (int);
 226 void    reset_timer        (void);
 227
 228 void    enable_interrupts  (void);
 229 int     disable_interrupts (void);
 230
 231 /* arch/$(ARCH)/lib/cache.c */
 232 void    enable_caches(void);
 233 void    flush_cache   (unsigned long, unsigned long);
 234 void    flush_dcache_all(void);
 235 void    flush_dcache_range(unsigned long start, unsigned long stop);
 236 void    invalidate_dcache_range(unsigned long start, unsigned long stop);
 237 void    invalidate_dcache_all(void);
 238 void    invalidate_icache_all(void);
 239
 240 enum {
 241         /* Disable caches (else flush caches but leave them active) */
 242         CBL_DISABLE_CACHES              = 1 << 0,
 243         CBL_SHOW_BOOTSTAGE_REPORT       = 1 << 1,
 244
 245         CBL_ALL                         = 3,
 246 };
 247
 248 /**
 249  * Clean up ready for linux
 250  *
 251  * @param flags         Flags to control what is done
 252  */
 253 int cleanup_before_linux_select(int flags);
 254
 255 /* lib/uuid.c */
 256 #include <uuid.h>
 257
 258 /* lib/vsprintf.c */
 259 #include <vsprintf.h>
 260
 261 /* lib/net_utils.c */
 262 #include <net.h>
 263
 264 #include <bootstage.h>
 265
 266 #else   /* __ASSEMBLY__ */
 267
 268 #endif  /* __ASSEMBLY__ */
 269
 270 /* Put only stuff here that the assembler can digest */
 271
 272 #ifdef CONFIG_POST
 273 #define CONFIG_HAS_POST
 274 #ifndef CONFIG_POST_ALT_LIST
 275 #define CONFIG_POST_STD_LIST
 276 #endif
 277 #endif
 278
 279 #define ROUND(a,b)              (((a) + (b) - 1) & ~((b) - 1))
 280
 281 /*
 282  * check_member() - Check the offset of a structure member
 283  *
 284  * @structure:  Name of structure (e.g. global_data)
 285  * @member:     Name of member (e.g. baudrate)
 286  * @offset:     Expected offset in bytes
 287  */
 288 #define check_member(structure, member, offset) _Static_assert( \
 289         offsetof(struct structure, member) == offset, \
 290         "`struct " #structure "` offset for `" #member "` is not " #offset)
 291
 292 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
 293 #ifdef CONFIG_EFI_STUB
 294 #define ll_boot_init()  false
 295 #else
 296 #define ll_boot_init()  true
 297 #endif
 298
 299 /* Pull in stuff for the build system */
 300 #ifdef DO_DEPS_ONLY
 301 # include <env_internal.h>
 302 #endif
 303
 304 #endif  /* __COMMON_H_ */