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