include/common.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * (C) Copyright 2000-2009
   4  * Wolfgang Denk, DENX Software Engineering, [email protected].
   5  */
   6
   7 #ifndef __COMMON_H_
   8 #define __COMMON_H_     1
   9
  10 #ifndef __ASSEMBLY__            /* put C only stuff in this section */
  11
  12 typedef unsigned char           uchar;
  13 typedef volatile unsigned long  vu_long;
  14 typedef volatile unsigned short vu_short;
  15 typedef volatile unsigned char  vu_char;
  16
  17 #include <config.h>
  18 #include <errno.h>
  19 #include <time.h>
  20 #include <asm-offsets.h>
  21 #include <linux/bitops.h>
  22 #include <linux/bug.h>
  23 #include <linux/delay.h>
  24 #include <linux/types.h>
  25 #include <linux/printk.h>
  26 #include <linux/string.h>
  27 #include <linux/stringify.h>
  28 #include <asm/ptrace.h>
  29 #include <stdarg.h>
  30 #include <stdio.h>
  31 #include <linux/kernel.h>
  32
  33 #include <part.h>
  34 #include <flash.h>
  35 #include <image.h>
  36
  37 #ifdef __LP64__
  38 #define CONFIG_SYS_SUPPORT_64BIT_DATA
  39 #endif
  40
  41 #include <log.h>
  42
  43 typedef void (interrupt_handler_t)(void *);
  44
  45 #include <asm/u-boot.h> /* boot information for Linux kernel */
  46 #include <asm/global_data.h>    /* global data used for startup functions */
  47
  48 #if defined(CONFIG_ENV_IS_EMBEDDED)
  49 #define TOTAL_MALLOC_LEN        CONFIG_SYS_MALLOC_LEN
  50 #elif ( ((CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) < CONFIG_SYS_MONITOR_BASE) || \
  51         (CONFIG_ENV_ADDR >= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) ) || \
  52       defined(CONFIG_ENV_IS_IN_NVRAM)
  53 #define TOTAL_MALLOC_LEN        (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
  54 #else
  55 #define TOTAL_MALLOC_LEN        CONFIG_SYS_MALLOC_LEN
  56 #endif
  57
  58 /* startup functions, used in:
  59  * common/board_f.c
  60  * common/init/board_init.c
  61  * common/board_r.c
  62  * common/board_info.c
  63  */
  64 #include <init.h>
  65
  66 /*
  67  * Function Prototypes
  68  */
  69 void    hang            (void) __attribute__ ((noreturn));
  70
  71 int     cpu_init(void);
  72
  73 #include <display_options.h>
  74
  75 /* common/main.c */
  76 void    main_loop       (void);
  77 int run_command(const char *cmd, int flag);
  78 int run_command_repeatable(const char *cmd, int flag);
  79
  80 /**
  81  * Run a list of commands separated by ; or even \0
  82  *
  83  * Note that if 'len' is not -1, then the command does not need to be nul
  84  * terminated, Memory will be allocated for the command in that case.
  85  *
  86  * @param cmd   List of commands to run, each separated bu semicolon
  87  * @param len   Length of commands excluding terminator if known (-1 if not)
  88  * @param flag  Execution flags (CMD_FLAG_...)
  89  * @return 0 on success, or != 0 on error.
  90  */
  91 int run_command_list(const char *cmd, int len, int flag);
  92
  93 int checkflash(void);
  94 int checkdram(void);
  95 extern u8 __dtb_dt_begin[];     /* embedded device tree blob */
  96 extern u8 __dtb_dt_spl_begin[]; /* embedded device tree blob for SPL/TPL */
  97 int mdm_init(void);
  98
  99 /**
 100  * Show the DRAM size in a board-specific way
 101  *
 102  * This is used by boards to display DRAM information in their own way.
 103  *
 104  * @param size  Size of DRAM (which should be displayed along with other info)
 105  */
 106 void board_show_dram(phys_size_t size);
 107
 108 /**
 109  * Get the uppermost pointer that is valid to access
 110  *
 111  * Some systems may not map all of their address space. This function allows
 112  * boards to indicate what their highest support pointer value is for DRAM
 113  * access.
 114  *
 115  * @param total_size    Size of U-Boot (unused?)
 116  */
 117 ulong board_get_usable_ram_top(ulong total_size);
 118
 119 /**
 120  * arch_fixup_fdt() - Write arch-specific information to fdt
 121  *
 122  * Defined in arch/$(ARCH)/lib/bootm-fdt.c
 123  *
 124  * @blob:       FDT blob to write to
 125  * @return 0 if ok, or -ve FDT_ERR_... on failure
 126  */
 127 int arch_fixup_fdt(void *blob);
 128
 129 /* common/flash.c */
 130 void flash_perror (int);
 131
 132 /* common/cmd_source.c */
 133 int     source (ulong addr, const char *fit_uname);
 134
 135 extern ulong load_addr;         /* Default Load Address */
 136 extern ulong save_addr;         /* Default Save Address */
 137 extern ulong save_size;         /* Default Save Size */
 138
 139 /* common/cmd_net.c */
 140 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 141
 142 /* common/cmd_fat.c */
 143 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
 144
 145 /* common/cmd_ext2.c */
 146 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
 147
 148 /* common/cmd_nvedit.c */
 149 void    env_relocate (void);
 150 int     envmatch     (uchar *, int);
 151
 152 /**
 153  * env_get() - Look up the value of an environment variable
 154  *
 155  * In U-Boot proper this can be called before relocation (which is when the
 156  * environment is loaded from storage, i.e. GD_FLG_ENV_READY is 0). In that
 157  * case this function calls env_get_f().
 158  *
 159  * @varname:    Variable to look up
 160  * @return value of variable, or NULL if not found
 161  */
 162 char *env_get(const char *varname);
 163
 164 /**
 165  * env_get_ulong() - Return an environment variable as an integer value
 166  *
 167  * Most U-Boot environment variables store hex values. For those which store
 168  * (e.g.) base-10 integers, this function can be used to read the value.
 169  *
 170  * @name:       Variable to look up
 171  * @base:       Base to use (e.g. 10 for base 10, 2 for binary)
 172  * @default_val: Default value to return if no value is found
 173  * @return the value found, or @default_val if none
 174  */
 175 ulong env_get_ulong(const char *name, int base, ulong default_val);
 176
 177 /**
 178  * env_get_hex() - Return an environment variable as a hex value
 179  *
 180  * Decode an environment as a hex number (it may or may not have a 0x
 181  * prefix). If the environment variable cannot be found, or does not start
 182  * with hex digits, the default value is returned.
 183  *
 184  * @varname:            Variable to decode
 185  * @default_val:        Value to return on error
 186  */
 187 ulong env_get_hex(const char *varname, ulong default_val);
 188
 189 /*
 190  * Read an environment variable as a boolean
 191  * Return -1 if variable does not exist (default to true)
 192  */
 193 int env_get_yesno(const char *var);
 194
 195 /**
 196  * env_set() - set an environment variable
 197  *
 198  * This sets or deletes the value of an environment variable. For setting the
 199  * value the variable is created if it does not already exist.
 200  *
 201  * @varname: Variable to adjust
 202  * @value: Value to set for the variable, or NULL or "" to delete the variable
 203  * @return 0 if OK, 1 on error
 204  */
 205 int env_set(const char *varname, const char *value);
 206
 207 /**
 208  * env_set_ulong() - set an environment variable to an integer
 209  *
 210  * @varname: Variable to adjust
 211  * @value: Value to set for the variable (will be converted to a string)
 212  * @return 0 if OK, 1 on error
 213  */
 214 int env_set_ulong(const char *varname, ulong value);
 215
 216 /**
 217  * env_set_hex() - set an environment variable to a hex value
 218  *
 219  * @varname: Variable to adjust
 220  * @value: Value to set for the variable (will be converted to a hex string)
 221  * @return 0 if OK, 1 on error
 222  */
 223 int env_set_hex(const char *varname, ulong value);
 224
 225 /**
 226  * env_set_addr - Set an environment variable to an address in hex
 227  *
 228  * @varname:    Environment variable to set
 229  * @addr:       Value to set it to
 230  * @return 0 if ok, 1 on error
 231  */
 232 static inline int env_set_addr(const char *varname, const void *addr)
 233 {
 234         return env_set_hex(varname, (ulong)addr);
 235 }
 236
 237 void    pci_init_board(void);
 238
 239 /* common/exports.c */
 240 void    jumptable_init(void);
 241
 242 /* common/kallsysm.c */
 243 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
 244
 245 /* common/memsize.c */
 246 long    get_ram_size  (long *, long);
 247 phys_size_t get_effective_memsize(void);
 248
 249 /* $(BOARD)/$(BOARD).c */
 250 void    reset_phy     (void);
 251 void    fdc_hw_init   (void);
 252
 253 /* $(BOARD)/eeprom.c */
 254 #ifdef CONFIG_CMD_EEPROM
 255 void eeprom_init  (int bus);
 256 int  eeprom_read  (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
 257 int  eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
 258 #else
 259 /*
 260  * Some EEPROM code is depecated because it used the legacy I2C interface. Add
 261  * some macros here so we don't have to touch every one of those uses
 262  */
 263 #define eeprom_init(bus)
 264 #define eeprom_read(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
 265 #define eeprom_write(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
 266 #endif
 267
 268 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C) && defined(CONFIG_SYS_I2C_EEPROM_ADDR)
 269 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
 270 #endif
 271
 272 /* $(BOARD)/$(BOARD).c */
 273 int board_early_init_f (void);
 274 int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */
 275 int board_late_init (void);
 276 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
 277 int board_early_init_r (void);
 278
 279 #if defined(CONFIG_SYS_DRAM_TEST)
 280 int testdram(void);
 281 #endif /* CONFIG_SYS_DRAM_TEST */
 282
 283 /* $(CPU)/start.S */
 284 int     icache_status (void);
 285 void    icache_enable (void);
 286 void    icache_disable(void);
 287 int     dcache_status (void);
 288 void    dcache_enable (void);
 289 void    dcache_disable(void);
 290 void    mmu_disable(void);
 291 #if defined(CONFIG_ARM)
 292 void    relocate_code(ulong);
 293 #else
 294 void    relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
 295 #endif
 296 ulong   get_endaddr   (void);
 297 void    trap_init     (ulong);
 298
 299 /* $(CPU)/cpu.c */
 300 static inline int cpumask_next(int cpu, unsigned int mask)
 301 {
 302         for (cpu++; !((1 << cpu) & mask); cpu++)
 303                 ;
 304
 305         return cpu;
 306 }
 307
 308 #define for_each_cpu(iter, cpu, num_cpus, mask) \
 309         for (iter = 0, cpu = cpumask_next(-1, mask); \
 310                 iter < num_cpus; \
 311                 iter++, cpu = cpumask_next(cpu, mask)) \
 312
 313 int     cpu_numcores  (void);
 314 int     cpu_num_dspcores(void);
 315 u32     cpu_mask      (void);
 316 u32     cpu_dsp_mask(void);
 317 int     is_core_valid (unsigned int);
 318
 319 void s_init(void);
 320
 321 int     checkcpu      (void);
 322 int     checkicache   (void);
 323 int     checkdcache   (void);
 324 void    upmconfig     (unsigned int, unsigned int *, unsigned int);
 325 ulong   get_tbclk     (void);
 326 void    reset_misc    (void);
 327 void    reset_cpu     (ulong addr);
 328 void ft_cpu_setup(void *blob, bd_t *bd);
 329 void ft_pci_setup(void *blob, bd_t *bd);
 330
 331 void smp_set_core_boot_addr(unsigned long addr, int corenr);
 332 void smp_kick_all_cpus(void);
 333
 334 /* $(CPU)/serial.c */
 335 int     serial_init   (void);
 336 void    serial_setbrg (void);
 337 void    serial_putc   (const char);
 338 void    serial_putc_raw(const char);
 339 void    serial_puts   (const char *);
 340 int     serial_getc   (void);
 341 int     serial_tstc   (void);
 342
 343 /* $(CPU)/speed.c */
 344 int     get_clocks (void);
 345 ulong   get_bus_freq  (ulong);
 346 int get_serial_clock(void);
 347
 348 /* $(CPU)/interrupts.c */
 349 int     interrupt_init     (void);
 350 void    timer_interrupt    (struct pt_regs *);
 351 void    external_interrupt (struct pt_regs *);
 352 void    irq_install_handler(int, interrupt_handler_t *, void *);
 353 void    irq_free_handler   (int);
 354 void    reset_timer        (void);
 355
 356 /* Return value of monotonic microsecond timer */
 357 unsigned long timer_get_us(void);
 358
 359 void    enable_interrupts  (void);
 360 int     disable_interrupts (void);
 361
 362 /* $(CPU)/.../commproc.c */
 363 void    bootcount_store (ulong);
 364 ulong   bootcount_load (void);
 365
 366 /* $(CPU)/.../<eth> */
 367 void mii_init (void);
 368
 369 /* arch/$(ARCH)/lib/cache.c */
 370 void    enable_caches(void);
 371 void    flush_cache   (unsigned long, unsigned long);
 372 void    flush_dcache_all(void);
 373 void    flush_dcache_range(unsigned long start, unsigned long stop);
 374 void    invalidate_dcache_range(unsigned long start, unsigned long stop);
 375 void    invalidate_dcache_all(void);
 376 void    invalidate_icache_all(void);
 377
 378 enum {
 379         /* Disable caches (else flush caches but leave them active) */
 380         CBL_DISABLE_CACHES              = 1 << 0,
 381         CBL_SHOW_BOOTSTAGE_REPORT       = 1 << 1,
 382
 383         CBL_ALL                         = 3,
 384 };
 385
 386 /**
 387  * Clean up ready for linux
 388  *
 389  * @param flags         Flags to control what is done
 390  */
 391 int cleanup_before_linux_select(int flags);
 392
 393 /* arch/$(ARCH)/lib/ticks.S */
 394 uint64_t get_ticks(void);
 395 void    wait_ticks    (unsigned long);
 396
 397 /* arch/$(ARCH)/lib/time.c */
 398 ulong   usec2ticks    (unsigned long usec);
 399 ulong   ticks2usec    (unsigned long ticks);
 400
 401 /* lib/lz4_wrapper.c */
 402 int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn);
 403
 404 /* lib/qsort.c */
 405 void qsort(void *base, size_t nmemb, size_t size,
 406            int(*compar)(const void *, const void *));
 407 int strcmp_compar(const void *, const void *);
 408
 409 /* lib/uuid.c */
 410 #include <uuid.h>
 411
 412 /* lib/vsprintf.c */
 413 #include <vsprintf.h>
 414
 415 /* lib/strmhz.c */
 416 char *  strmhz(char *buf, unsigned long hz);
 417
 418 /* lib/crc32.c */
 419 #include <u-boot/crc.h>
 420
 421 /* lib/rand.c */
 422 #define RAND_MAX -1U
 423 void srand(unsigned int seed);
 424 unsigned int rand(void);
 425 unsigned int rand_r(unsigned int *seedp);
 426
 427 /*
 428  * STDIO based functions (can always be used)
 429  */
 430 /* serial stuff */
 431 int     serial_printf (const char *fmt, ...)
 432                 __attribute__ ((format (__printf__, 1, 2)));
 433
 434 /* lib/net_utils.c */
 435 #include <net.h>
 436 static inline struct in_addr env_get_ip(char *var)
 437 {
 438         return string_to_ip(env_get(var));
 439 }
 440
 441 int     pcmcia_init (void);
 442
 443 #ifdef CONFIG_LED_STATUS
 444 # include <status_led.h>
 445 #endif
 446
 447 #include <bootstage.h>
 448
 449 #ifdef CONFIG_SHOW_ACTIVITY
 450 void show_activity(int arg);
 451 #endif
 452
 453 /* Multicore arch functions */
 454 #ifdef CONFIG_MP
 455 int cpu_status(u32 nr);
 456 int cpu_reset(u32 nr);
 457 int cpu_disable(u32 nr);
 458 int cpu_release(u32 nr, int argc, char * const argv[]);
 459 #endif
 460
 461 #else   /* __ASSEMBLY__ */
 462
 463 #endif  /* __ASSEMBLY__ */
 464
 465 /* Put only stuff here that the assembler can digest */
 466
 467 #ifdef CONFIG_POST
 468 #define CONFIG_HAS_POST
 469 #ifndef CONFIG_POST_ALT_LIST
 470 #define CONFIG_POST_STD_LIST
 471 #endif
 472 #endif
 473
 474 #define ROUND(a,b)              (((a) + (b) - 1) & ~((b) - 1))
 475
 476 /*
 477  * check_member() - Check the offset of a structure member
 478  *
 479  * @structure:  Name of structure (e.g. global_data)
 480  * @member:     Name of member (e.g. baudrate)
 481  * @offset:     Expected offset in bytes
 482  */
 483 #define check_member(structure, member, offset) _Static_assert( \
 484         offsetof(struct structure, member) == offset, \
 485         "`struct " #structure "` offset for `" #member "` is not " #offset)
 486
 487 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
 488 #ifdef CONFIG_EFI_STUB
 489 #define ll_boot_init()  false
 490 #else
 491 #define ll_boot_init()  true
 492 #endif
 493
 494 /* Pull in stuff for the build system */
 495 #ifdef DO_DEPS_ONLY
 496 # include <environment.h>
 497 #endif
 498
 499 #endif  /* __COMMON_H_ */