include/common.h

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