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, cpu.h and timer.h. Please think before adding more
   7  * things. 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 int     cpu_init(void);
  68
  69 #include <display_options.h>
  70
  71 /* common/main.c */
  72 void    main_loop       (void);
  73 int run_command(const char *cmd, int flag);
  74 int run_command_repeatable(const char *cmd, int flag);
  75
  76 /**
  77  * Run a list of commands separated by ; or even \0
  78  *
  79  * Note that if 'len' is not -1, then the command does not need to be nul
  80  * terminated, Memory will be allocated for the command in that case.
  81  *
  82  * @param cmd   List of commands to run, each separated bu semicolon
  83  * @param len   Length of commands excluding terminator if known (-1 if not)
  84  * @param flag  Execution flags (CMD_FLAG_...)
  85  * @return 0 on success, or != 0 on error.
  86  */
  87 int run_command_list(const char *cmd, int len, int flag);
  88
  89 int checkflash(void);
  90 int checkdram(void);
  91 extern u8 __dtb_dt_begin[];     /* embedded device tree blob */
  92 extern u8 __dtb_dt_spl_begin[]; /* embedded device tree blob for SPL/TPL */
  93 int mdm_init(void);
  94
  95 /**
  96  * Show the DRAM size in a board-specific way
  97  *
  98  * This is used by boards to display DRAM information in their own way.
  99  *
 100  * @param size  Size of DRAM (which should be displayed along with other info)
 101  */
 102 void board_show_dram(phys_size_t size);
 103
 104 /**
 105  * Get the uppermost pointer that is valid to access
 106  *
 107  * Some systems may not map all of their address space. This function allows
 108  * boards to indicate what their highest support pointer value is for DRAM
 109  * access.
 110  *
 111  * @param total_size    Size of U-Boot (unused?)
 112  */
 113 ulong board_get_usable_ram_top(ulong total_size);
 114
 115 /**
 116  * arch_fixup_fdt() - Write arch-specific information to fdt
 117  *
 118  * Defined in arch/$(ARCH)/lib/bootm-fdt.c
 119  *
 120  * @blob:       FDT blob to write to
 121  * @return 0 if ok, or -ve FDT_ERR_... on failure
 122  */
 123 int arch_fixup_fdt(void *blob);
 124
 125 /* common/flash.c */
 126 void flash_perror (int);
 127
 128 /* common/cmd_source.c */
 129 int     source (ulong addr, const char *fit_uname);
 130
 131 extern ulong load_addr;         /* Default Load Address */
 132 extern ulong save_addr;         /* Default Save Address */
 133 extern ulong save_size;         /* Default Save Size */
 134
 135 /* common/cmd_net.c */
 136 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 137
 138 /* common/cmd_fat.c */
 139 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
 140
 141 /* common/cmd_ext2.c */
 142 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
 143
 144 void    pci_init_board(void);
 145
 146 /* common/exports.c */
 147 void    jumptable_init(void);
 148
 149 /* common/kallsysm.c */
 150 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
 151
 152 /* common/memsize.c */
 153 long    get_ram_size  (long *, long);
 154 phys_size_t get_effective_memsize(void);
 155
 156 /* $(BOARD)/$(BOARD).c */
 157 void    reset_phy     (void);
 158 void    fdc_hw_init   (void);
 159
 160 /* $(BOARD)/eeprom.c */
 161 #ifdef CONFIG_CMD_EEPROM
 162 void eeprom_init  (int bus);
 163 int  eeprom_read  (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
 164 int  eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
 165 #else
 166 /*
 167  * Some EEPROM code is depecated because it used the legacy I2C interface. Add
 168  * some macros here so we don't have to touch every one of those uses
 169  */
 170 #define eeprom_init(bus)
 171 #define eeprom_read(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
 172 #define eeprom_write(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
 173 #endif
 174
 175 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C) && defined(CONFIG_SYS_I2C_EEPROM_ADDR)
 176 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
 177 #endif
 178
 179 /* $(BOARD)/$(BOARD).c */
 180 int board_early_init_f (void);
 181 int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */
 182 int board_late_init (void);
 183 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
 184 int board_early_init_r (void);
 185
 186 #if defined(CONFIG_SYS_DRAM_TEST)
 187 int testdram(void);
 188 #endif /* CONFIG_SYS_DRAM_TEST */
 189
 190 /* $(CPU)/start.S */
 191 int     icache_status (void);
 192 void    icache_enable (void);
 193 void    icache_disable(void);
 194 int     dcache_status (void);
 195 void    dcache_enable (void);
 196 void    dcache_disable(void);
 197 void    mmu_disable(void);
 198 #if defined(CONFIG_ARM)
 199 void    relocate_code(ulong);
 200 #else
 201 void    relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
 202 #endif
 203 ulong   get_endaddr   (void);
 204 void    trap_init     (ulong);
 205
 206 /* $(CPU)/cpu.c */
 207 static inline int cpumask_next(int cpu, unsigned int mask)
 208 {
 209         for (cpu++; !((1 << cpu) & mask); cpu++)
 210                 ;
 211
 212         return cpu;
 213 }
 214
 215 #define for_each_cpu(iter, cpu, num_cpus, mask) \
 216         for (iter = 0, cpu = cpumask_next(-1, mask); \
 217                 iter < num_cpus; \
 218                 iter++, cpu = cpumask_next(cpu, mask)) \
 219
 220 int     cpu_numcores  (void);
 221 int     cpu_num_dspcores(void);
 222 u32     cpu_mask      (void);
 223 u32     cpu_dsp_mask(void);
 224 int     is_core_valid (unsigned int);
 225
 226 void s_init(void);
 227
 228 int     checkcpu      (void);
 229 int     checkicache   (void);
 230 int     checkdcache   (void);
 231 void    upmconfig     (unsigned int, unsigned int *, unsigned int);
 232 ulong   get_tbclk     (void);
 233 void    reset_misc    (void);
 234 void    reset_cpu     (ulong addr);
 235 void ft_cpu_setup(void *blob, bd_t *bd);
 236 void ft_pci_setup(void *blob, bd_t *bd);
 237
 238 void smp_set_core_boot_addr(unsigned long addr, int corenr);
 239 void smp_kick_all_cpus(void);
 240
 241 /* $(CPU)/serial.c */
 242 int     serial_init   (void);
 243 void    serial_setbrg (void);
 244 void    serial_putc   (const char);
 245 void    serial_putc_raw(const char);
 246 void    serial_puts   (const char *);
 247 int     serial_getc   (void);
 248 int     serial_tstc   (void);
 249
 250 /* $(CPU)/speed.c */
 251 int     get_clocks (void);
 252 ulong   get_bus_freq  (ulong);
 253 int get_serial_clock(void);
 254
 255 /* $(CPU)/interrupts.c */
 256 int     interrupt_init     (void);
 257 void    timer_interrupt    (struct pt_regs *);
 258 void    external_interrupt (struct pt_regs *);
 259 void    irq_install_handler(int, interrupt_handler_t *, void *);
 260 void    irq_free_handler   (int);
 261 void    reset_timer        (void);
 262
 263 /* Return value of monotonic microsecond timer */
 264 unsigned long timer_get_us(void);
 265
 266 void    enable_interrupts  (void);
 267 int     disable_interrupts (void);
 268
 269 /* $(CPU)/.../commproc.c */
 270 void    bootcount_store (ulong);
 271 ulong   bootcount_load (void);
 272
 273 /* $(CPU)/.../<eth> */
 274 void mii_init (void);
 275
 276 /* arch/$(ARCH)/lib/cache.c */
 277 void    enable_caches(void);
 278 void    flush_cache   (unsigned long, unsigned long);
 279 void    flush_dcache_all(void);
 280 void    flush_dcache_range(unsigned long start, unsigned long stop);
 281 void    invalidate_dcache_range(unsigned long start, unsigned long stop);
 282 void    invalidate_dcache_all(void);
 283 void    invalidate_icache_all(void);
 284
 285 enum {
 286         /* Disable caches (else flush caches but leave them active) */
 287         CBL_DISABLE_CACHES              = 1 << 0,
 288         CBL_SHOW_BOOTSTAGE_REPORT       = 1 << 1,
 289
 290         CBL_ALL                         = 3,
 291 };
 292
 293 /**
 294  * Clean up ready for linux
 295  *
 296  * @param flags         Flags to control what is done
 297  */
 298 int cleanup_before_linux_select(int flags);
 299
 300 /* arch/$(ARCH)/lib/ticks.S */
 301 uint64_t get_ticks(void);
 302 void    wait_ticks    (unsigned long);
 303
 304 /* arch/$(ARCH)/lib/time.c */
 305 ulong   usec2ticks    (unsigned long usec);
 306 ulong   ticks2usec    (unsigned long ticks);
 307
 308 /* lib/lz4_wrapper.c */
 309 int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn);
 310
 311 /* lib/qsort.c */
 312 void qsort(void *base, size_t nmemb, size_t size,
 313            int(*compar)(const void *, const void *));
 314 int strcmp_compar(const void *, const void *);
 315
 316 /* lib/uuid.c */
 317 #include <uuid.h>
 318
 319 /* lib/vsprintf.c */
 320 #include <vsprintf.h>
 321
 322 /* lib/strmhz.c */
 323 char *  strmhz(char *buf, unsigned long hz);
 324
 325 /* lib/crc32.c */
 326 #include <u-boot/crc.h>
 327
 328 /* lib/rand.c */
 329 #define RAND_MAX -1U
 330 void srand(unsigned int seed);
 331 unsigned int rand(void);
 332 unsigned int rand_r(unsigned int *seedp);
 333
 334 /*
 335  * STDIO based functions (can always be used)
 336  */
 337 /* serial stuff */
 338 int     serial_printf (const char *fmt, ...)
 339                 __attribute__ ((format (__printf__, 1, 2)));
 340
 341 /* lib/net_utils.c */
 342 #include <net.h>
 343 static inline struct in_addr env_get_ip(char *var)
 344 {
 345         return string_to_ip(env_get(var));
 346 }
 347
 348 #ifdef CONFIG_LED_STATUS
 349 # include <status_led.h>
 350 #endif
 351
 352 #include <bootstage.h>
 353
 354 #ifdef CONFIG_SHOW_ACTIVITY
 355 void show_activity(int arg);
 356 #endif
 357
 358 /* Multicore arch functions */
 359 #ifdef CONFIG_MP
 360 int cpu_status(u32 nr);
 361 int cpu_reset(u32 nr);
 362 int cpu_disable(u32 nr);
 363 int cpu_release(u32 nr, int argc, char * const argv[]);
 364 #endif
 365
 366 #else   /* __ASSEMBLY__ */
 367
 368 #endif  /* __ASSEMBLY__ */
 369
 370 /* Put only stuff here that the assembler can digest */
 371
 372 #ifdef CONFIG_POST
 373 #define CONFIG_HAS_POST
 374 #ifndef CONFIG_POST_ALT_LIST
 375 #define CONFIG_POST_STD_LIST
 376 #endif
 377 #endif
 378
 379 #define ROUND(a,b)              (((a) + (b) - 1) & ~((b) - 1))
 380
 381 /*
 382  * check_member() - Check the offset of a structure member
 383  *
 384  * @structure:  Name of structure (e.g. global_data)
 385  * @member:     Name of member (e.g. baudrate)
 386  * @offset:     Expected offset in bytes
 387  */
 388 #define check_member(structure, member, offset) _Static_assert( \
 389         offsetof(struct structure, member) == offset, \
 390         "`struct " #structure "` offset for `" #member "` is not " #offset)
 391
 392 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
 393 #ifdef CONFIG_EFI_STUB
 394 #define ll_boot_init()  false
 395 #else
 396 #define ll_boot_init()  true
 397 #endif
 398
 399 /* Pull in stuff for the build system */
 400 #ifdef DO_DEPS_ONLY
 401 # include <env_internal.h>
 402 #endif
 403
 404 #endif  /* __COMMON_H_ */