include/common.h

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