include/common.h

   1 /*
   2  * (C) Copyright 2000-2009
   3  * Wolfgang Denk, DENX Software Engineering, [email protected].
   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/delay.h>
  27 #include <linux/types.h>
  28 #include <linux/string.h>
  29 #include <linux/stringify.h>
  30 #include <asm/ptrace.h>
  31 #include <stdarg.h>
  32 #include <linux/kernel.h>
  33
  34 #include <part.h>
  35 #include <flash.h>
  36 #include <image.h>
  37
  38 /* Bring in printf format macros if inttypes.h is included */
  39 #define __STDC_FORMAT_MACROS
  40
  41 #ifdef __LP64__
  42 #define CONFIG_SYS_SUPPORT_64BIT_DATA
  43 #endif
  44
  45 #ifdef DEBUG
  46 #define _DEBUG  1
  47 #else
  48 #define _DEBUG  0
  49 #endif
  50
  51 #ifdef CONFIG_SPL_BUILD
  52 #define _SPL_BUILD      1
  53 #else
  54 #define _SPL_BUILD      0
  55 #endif
  56
  57 /* Define this at the top of a file to add a prefix to debug messages */
  58 #ifndef pr_fmt
  59 #define pr_fmt(fmt) fmt
  60 #endif
  61
  62 /*
  63  * Output a debug text when condition "cond" is met. The "cond" should be
  64  * computed by a preprocessor in the best case, allowing for the best
  65  * optimization.
  66  */
  67 #define debug_cond(cond, fmt, args...)                  \
  68         do {                                            \
  69                 if (cond)                               \
  70                         printf(pr_fmt(fmt), ##args);    \
  71         } while (0)
  72
  73 /* Show a message if DEBUG is defined in a file */
  74 #define debug(fmt, args...)                     \
  75         debug_cond(_DEBUG, fmt, ##args)
  76
  77 /* Show a message if not in SPL */
  78 #define warn_non_spl(fmt, args...)                      \
  79         debug_cond(!_SPL_BUILD, fmt, ##args)
  80
  81 /*
  82  * An assertion is run-time check done in debug mode only. If DEBUG is not
  83  * defined then it is skipped. If DEBUG is defined and the assertion fails,
  84  * then it calls panic*( which may or may not reset/halt U-Boot (see
  85  * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
  86  * before release, and after release it is hoped that they don't matter. But
  87  * in any case these failing assertions cannot be fixed with a reset (which
  88  * may just do the same assertion again).
  89  */
  90 void __assert_fail(const char *assertion, const char *file, unsigned line,
  91                    const char *function);
  92 #define assert(x) \
  93         ({ if (!(x) && _DEBUG) \
  94                 __assert_fail(#x, __FILE__, __LINE__, __func__); })
  95
  96 #define error(fmt, args...) do {                                        \
  97                 printf("ERROR: " pr_fmt(fmt) "\nat %s:%d/%s()\n",       \
  98                         ##args, __FILE__, __LINE__, __func__);          \
  99 } while (0)
 100
 101 #ifndef BUG
 102 #define BUG() do { \
 103         printf("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __FUNCTION__); \
 104         panic("BUG!"); \
 105 } while (0)
 106 #define BUG_ON(condition) do { if (unlikely((condition)!=0)) BUG(); } while(0)
 107 #endif /* BUG */
 108
 109 typedef void (interrupt_handler_t)(void *);
 110
 111 #include <asm/u-boot.h> /* boot information for Linux kernel */
 112 #include <asm/global_data.h>    /* global data used for startup functions */
 113
 114 #if defined(CONFIG_ENV_IS_EMBEDDED)
 115 #define TOTAL_MALLOC_LEN        CONFIG_SYS_MALLOC_LEN
 116 #elif ( ((CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) < CONFIG_SYS_MONITOR_BASE) || \
 117         (CONFIG_ENV_ADDR >= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) ) || \
 118       defined(CONFIG_ENV_IS_IN_NVRAM)
 119 #define TOTAL_MALLOC_LEN        (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
 120 #else
 121 #define TOTAL_MALLOC_LEN        CONFIG_SYS_MALLOC_LEN
 122 #endif
 123
 124 /*
 125  * Function Prototypes
 126  */
 127 int dram_init(void);
 128
 129 /**
 130  * dram_init_banksize() - Set up DRAM bank sizes
 131  *
 132  * This can be implemented by boards to set up the DRAM bank information in
 133  * gd->bd->bi_dram(). It is called just before relocation, after dram_init()
 134  * is called.
 135  *
 136  * If this is not provided, a default implementation will try to set up a
 137  * single bank. It will do this if CONFIG_NR_DRAM_BANKS and
 138  * CONFIG_SYS_SDRAM_BASE are set. The bank will have a start address of
 139  * CONFIG_SYS_SDRAM_BASE and the size will be determined by a call to
 140  * get_effective_memsize().
 141  *
 142  * @return 0 if OK, -ve on error
 143  */
 144 int dram_init_banksize(void);
 145
 146 void    hang            (void) __attribute__ ((noreturn));
 147
 148 int     timer_init(void);
 149 int     cpu_init(void);
 150
 151 #include <display_options.h>
 152
 153 /* common/main.c */
 154 void    main_loop       (void);
 155 int run_command(const char *cmd, int flag);
 156 int run_command_repeatable(const char *cmd, int flag);
 157
 158 /**
 159  * Run a list of commands separated by ; or even \0
 160  *
 161  * Note that if 'len' is not -1, then the command does not need to be nul
 162  * terminated, Memory will be allocated for the command in that case.
 163  *
 164  * @param cmd   List of commands to run, each separated bu semicolon
 165  * @param len   Length of commands excluding terminator if known (-1 if not)
 166  * @param flag  Execution flags (CMD_FLAG_...)
 167  * @return 0 on success, or != 0 on error.
 168  */
 169 int run_command_list(const char *cmd, int len, int flag);
 170
 171 /* arch/$(ARCH)/lib/board.c */
 172 void board_init_f(ulong);
 173 void board_init_r(gd_t *, ulong) __attribute__ ((noreturn));
 174
 175 /**
 176  * ulong board_init_f_alloc_reserve - allocate reserved area
 177  *
 178  * This function is called by each architecture very early in the start-up
 179  * code to allow the C runtime to reserve space on the stack for writable
 180  * 'globals' such as GD and the malloc arena.
 181  *
 182  * @top:        top of the reserve area, growing down.
 183  * @return:     bottom of reserved area
 184  */
 185 ulong board_init_f_alloc_reserve(ulong top);
 186
 187 /**
 188  * board_init_f_init_reserve - initialize the reserved area(s)
 189  *
 190  * This function is called once the C runtime has allocated the reserved
 191  * area on the stack. It must initialize the GD at the base of that area.
 192  *
 193  * @base:       top from which reservation was done
 194  */
 195 void board_init_f_init_reserve(ulong base);
 196
 197 /**
 198  * arch_setup_gd() - Set up the global_data pointer
 199  *
 200  * This pointer is special in some architectures and cannot easily be assigned
 201  * to. For example on x86 it is implemented by adding a specific record to its
 202  * Global Descriptor Table! So we we provide a function to carry out this task.
 203  * For most architectures this can simply be:
 204  *
 205  *    gd = gd_ptr;
 206  *
 207  * @gd_ptr:     Pointer to global data
 208  */
 209 void arch_setup_gd(gd_t *gd_ptr);
 210
 211 int checkboard(void);
 212 int show_board_info(void);
 213 int checkflash(void);
 214 int checkdram(void);
 215 int last_stage_init(void);
 216 extern ulong monitor_flash_len;
 217 int mac_read_from_eeprom(void);
 218 extern u8 __dtb_dt_begin[];     /* embedded device tree blob */
 219 int set_cpu_clk_info(void);
 220 int mdm_init(void);
 221 int print_cpuinfo(void);
 222 int update_flash_size(int flash_size);
 223 int arch_early_init_r(void);
 224
 225 /*
 226  * setup_board_extra() - Fill in extra details in the bd_t structure
 227  *
 228  * @return 0 if OK, -ve on error
 229  */
 230 int setup_board_extra(void);
 231
 232 /**
 233  * arch_fsp_init() - perform firmware support package init
 234  *
 235  * Where U-Boot relies on binary blobs to handle part of the system init, this
 236  * function can be used to set up the blobs. This is used on some Intel
 237  * platforms.
 238  */
 239 int arch_fsp_init(void);
 240
 241 /**
 242  * arch_cpu_init_dm() - init CPU after driver model is available
 243  *
 244  * This is called immediately after driver model is available before
 245  * relocation. This is similar to arch_cpu_init() but is able to reference
 246  * devices
 247  *
 248  * @return 0 if OK, -ve on error
 249  */
 250 int arch_cpu_init_dm(void);
 251
 252 /**
 253  * Reserve all necessary stacks
 254  *
 255  * This is used in generic board init sequence in common/board_f.c. Each
 256  * architecture could provide this function to tailor the required stacks.
 257  *
 258  * On entry gd->start_addr_sp is pointing to the suggested top of the stack.
 259  * The callee ensures gd->start_add_sp is 16-byte aligned, so architectures
 260  * require only this can leave it untouched.
 261  *
 262  * On exit gd->start_addr_sp and gd->irq_sp should be set to the respective
 263  * positions of the stack. The stack pointer(s) will be set to this later.
 264  * gd->irq_sp is only required, if the architecture needs it.
 265  *
 266  * @return 0 if no error
 267  */
 268 __weak int arch_reserve_stacks(void);
 269
 270 /**
 271  * Show the DRAM size in a board-specific way
 272  *
 273  * This is used by boards to display DRAM information in their own way.
 274  *
 275  * @param size  Size of DRAM (which should be displayed along with other info)
 276  */
 277 void board_show_dram(phys_size_t size);
 278
 279 /**
 280  * arch_fixup_fdt() - Write arch-specific information to fdt
 281  *
 282  * Defined in arch/$(ARCH)/lib/bootm-fdt.c
 283  *
 284  * @blob:       FDT blob to write to
 285  * @return 0 if ok, or -ve FDT_ERR_... on failure
 286  */
 287 int arch_fixup_fdt(void *blob);
 288
 289 int reserve_mmu(void);
 290 /* common/flash.c */
 291 void flash_perror (int);
 292
 293 /* common/cmd_source.c */
 294 int     source (ulong addr, const char *fit_uname);
 295
 296 extern ulong load_addr;         /* Default Load Address */
 297 extern ulong save_addr;         /* Default Save Address */
 298 extern ulong save_size;         /* Default Save Size */
 299
 300 /* common/cmd_net.c */
 301 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 302
 303 /* common/cmd_fat.c */
 304 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
 305
 306 /* common/cmd_ext2.c */
 307 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
 308
 309 /* common/cmd_nvedit.c */
 310 int     env_init     (void);
 311 void    env_relocate (void);
 312 int     envmatch     (uchar *, int);
 313
 314 /**
 315  * env_get() - Look up the value of an environment variable
 316  *
 317  * In U-Boot proper this can be called before relocation (which is when the
 318  * environment is loaded from storage, i.e. GD_FLG_ENV_READY is 0). In that
 319  * case this function calls env_get_f().
 320  *
 321  * @varname:    Variable to look up
 322  * @return value of variable, or NULL if not found
 323  */
 324 char *env_get(const char *varname);
 325
 326 /**
 327  * env_get_f() - Look up the value of an environment variable (early)
 328  *
 329  * This function is called from env_get() if the environment has not been
 330  * loaded yet (GD_FLG_ENV_READY flag is 0). Some environment locations will
 331  * support reading the value (slowly) and some will not.
 332  *
 333  * @varname:    Variable to look up
 334  * @return value of variable, or NULL if not found
 335  */
 336 int env_get_f(const char *name, char *buf, unsigned len);
 337
 338 ulong getenv_ulong(const char *name, int base, ulong default_val);
 339
 340 /**
 341  * getenv_hex() - Return an environment variable as a hex value
 342  *
 343  * Decode an environment as a hex number (it may or may not have a 0x
 344  * prefix). If the environment variable cannot be found, or does not start
 345  * with hex digits, the default value is returned.
 346  *
 347  * @varname:            Variable to decode
 348  * @default_val:        Value to return on error
 349  */
 350 ulong getenv_hex(const char *varname, ulong default_val);
 351
 352 /*
 353  * Read an environment variable as a boolean
 354  * Return -1 if variable does not exist (default to true)
 355  */
 356 int getenv_yesno(const char *var);
 357
 358 /**
 359  * env_set() - set an environment variable
 360  *
 361  * This sets or deletes the value of an environment variable. For setting the
 362  * value the variable is created if it does not already exist.
 363  *
 364  * @varname: Variable to adjust
 365  * @value: Value to set for the variable, or NULL or "" to delete the variable
 366  * @return 0 if OK, 1 on error
 367  */
 368 int env_set(const char *varname, const char *value);
 369
 370 /**
 371  * env_set_ulong() - set an environment variable to an integer
 372  *
 373  * @varname: Variable to adjust
 374  * @value: Value to set for the variable (will be converted to a string)
 375  * @return 0 if OK, 1 on error
 376  */
 377 int env_set_ulong(const char *varname, ulong value);
 378
 379 /**
 380  * env_set_hex() - set an environment variable to a hex value
 381  *
 382  * @varname: Variable to adjust
 383  * @value: Value to set for the variable (will be converted to a hex string)
 384  * @return 0 if OK, 1 on error
 385  */
 386 int env_set_hex(const char *varname, ulong value);
 387
 388 /**
 389  * env_set_addr - Set an environment variable to an address in hex
 390  *
 391  * @varname:    Environment variable to set
 392  * @addr:       Value to set it to
 393  * @return 0 if ok, 1 on error
 394  */
 395 static inline int env_set_addr(const char *varname, const void *addr)
 396 {
 397         return env_set_hex(varname, (ulong)addr);
 398 }
 399
 400 #ifdef CONFIG_AUTO_COMPLETE
 401 int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
 402 #endif
 403 int get_env_id (void);
 404
 405 void    pci_init      (void);
 406 void    pci_init_board(void);
 407
 408 #if defined(CONFIG_DTB_RESELECT)
 409 int     embedded_dtb_select(void);
 410 #endif
 411
 412 int     misc_init_f   (void);
 413 int     misc_init_r   (void);
 414
 415 /* common/exports.c */
 416 void    jumptable_init(void);
 417
 418 /* common/kallsysm.c */
 419 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
 420
 421 /* common/memsize.c */
 422 long    get_ram_size  (long *, long);
 423 phys_size_t get_effective_memsize(void);
 424
 425 /* $(BOARD)/$(BOARD).c */
 426 void    reset_phy     (void);
 427 void    fdc_hw_init   (void);
 428
 429 /* $(BOARD)/eeprom.c */
 430 #ifdef CONFIG_CMD_EEPROM
 431 void eeprom_init  (int bus);
 432 int  eeprom_read  (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
 433 int  eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
 434 #else
 435 /*
 436  * Some EEPROM code is depecated because it used the legacy I2C interface. Add
 437  * some macros here so we don't have to touch every one of those uses
 438  */
 439 #define eeprom_init(bus)
 440 #define eeprom_read(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
 441 #define eeprom_write(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
 442 #endif
 443
 444 /*
 445  * Set this up regardless of board
 446  * type, to prevent errors.
 447  */
 448 #if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
 449 # define CONFIG_SYS_DEF_EEPROM_ADDR 0
 450 #else
 451 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
 452 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
 453 #endif
 454 #endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
 455
 456 #if defined(CONFIG_SPI)
 457 extern void spi_init_f (void);
 458 extern void spi_init_r (void);
 459 extern ssize_t spi_read  (uchar *, int, uchar *, int);
 460 extern ssize_t spi_write (uchar *, int, uchar *, int);
 461 #endif
 462
 463 /* $(BOARD)/$(BOARD).c */
 464 int board_early_init_f (void);
 465 int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */
 466 int board_late_init (void);
 467 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
 468 int board_early_init_r (void);
 469 void board_poweroff (void);
 470
 471 #if defined(CONFIG_SYS_DRAM_TEST)
 472 int testdram(void);
 473 #endif /* CONFIG_SYS_DRAM_TEST */
 474
 475 /* $(CPU)/start.S */
 476 int     icache_status (void);
 477 void    icache_enable (void);
 478 void    icache_disable(void);
 479 int     dcache_status (void);
 480 void    dcache_enable (void);
 481 void    dcache_disable(void);
 482 void    mmu_disable(void);
 483 #if defined(CONFIG_ARM)
 484 void    relocate_code(ulong);
 485 #else
 486 void    relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
 487 #endif
 488 ulong   get_endaddr   (void);
 489 void    trap_init     (ulong);
 490
 491 /* $(CPU)/cpu.c */
 492 static inline int cpumask_next(int cpu, unsigned int mask)
 493 {
 494         for (cpu++; !((1 << cpu) & mask); cpu++)
 495                 ;
 496
 497         return cpu;
 498 }
 499
 500 #define for_each_cpu(iter, cpu, num_cpus, mask) \
 501         for (iter = 0, cpu = cpumask_next(-1, mask); \
 502                 iter < num_cpus; \
 503                 iter++, cpu = cpumask_next(cpu, mask)) \
 504
 505 int     cpu_numcores  (void);
 506 int     cpu_num_dspcores(void);
 507 u32     cpu_mask      (void);
 508 u32     cpu_dsp_mask(void);
 509 int     is_core_valid (unsigned int);
 510
 511 /**
 512  * arch_cpu_init() - basic cpu-dependent setup for an architecture
 513  *
 514  * This is called after early malloc is available. It should handle any
 515  * CPU- or SoC- specific init needed to continue the init sequence. See
 516  * board_f.c for where it is called. If this is not provided, a default
 517  * version (which does nothing) will be used.
 518  */
 519 int arch_cpu_init(void);
 520
 521 int     checkcpu      (void);
 522 int     checkicache   (void);
 523 int     checkdcache   (void);
 524 void    upmconfig     (unsigned int, unsigned int *, unsigned int);
 525 ulong   get_tbclk     (void);
 526 void    reset_misc    (void);
 527 void    reset_cpu     (ulong addr);
 528 void ft_cpu_setup(void *blob, bd_t *bd);
 529 void ft_pci_setup(void *blob, bd_t *bd);
 530
 531 void smp_set_core_boot_addr(unsigned long addr, int corenr);
 532 void smp_kick_all_cpus(void);
 533
 534 /* $(CPU)/serial.c */
 535 int     serial_init   (void);
 536 void    serial_setbrg (void);
 537 void    serial_putc   (const char);
 538 void    serial_putc_raw(const char);
 539 void    serial_puts   (const char *);
 540 int     serial_getc   (void);
 541 int     serial_tstc   (void);
 542
 543 /* $(CPU)/speed.c */
 544 int     get_clocks (void);
 545 ulong   get_bus_freq  (ulong);
 546 int get_serial_clock(void);
 547
 548 int     cpu_init_r    (void);
 549
 550 /* $(CPU)/interrupts.c */
 551 int     interrupt_init     (void);
 552 void    timer_interrupt    (struct pt_regs *);
 553 void    external_interrupt (struct pt_regs *);
 554 void    irq_install_handler(int, interrupt_handler_t *, void *);
 555 void    irq_free_handler   (int);
 556 void    reset_timer        (void);
 557
 558 /* Return value of monotonic microsecond timer */
 559 unsigned long timer_get_us(void);
 560
 561 void    enable_interrupts  (void);
 562 int     disable_interrupts (void);
 563
 564 /* $(CPU)/.../commproc.c */
 565 int     dpram_init (void);
 566 uint    dpram_base(void);
 567 uint    dpram_base_align(uint align);
 568 uint    dpram_alloc(uint size);
 569 uint    dpram_alloc_align(uint size,uint align);
 570 void    bootcount_store (ulong);
 571 ulong   bootcount_load (void);
 572 #define BOOTCOUNT_MAGIC         0xB001C041
 573
 574 /* $(CPU)/.../<eth> */
 575 void mii_init (void);
 576
 577 /* $(CPU)/.../lcd.c */
 578 ulong   lcd_setmem (ulong);
 579
 580 /* $(CPU)/.../video.c */
 581 ulong   video_setmem (ulong);
 582
 583 /* arch/$(ARCH)/lib/cache.c */
 584 void    enable_caches(void);
 585 void    flush_cache   (unsigned long, unsigned long);
 586 void    flush_dcache_all(void);
 587 void    flush_dcache_range(unsigned long start, unsigned long stop);
 588 void    invalidate_dcache_range(unsigned long start, unsigned long stop);
 589 void    invalidate_dcache_all(void);
 590 void    invalidate_icache_all(void);
 591
 592 enum {
 593         /* Disable caches (else flush caches but leave them active) */
 594         CBL_DISABLE_CACHES              = 1 << 0,
 595         CBL_SHOW_BOOTSTAGE_REPORT       = 1 << 1,
 596
 597         CBL_ALL                         = 3,
 598 };
 599
 600 /**
 601  * Clean up ready for linux
 602  *
 603  * @param flags         Flags to control what is done
 604  */
 605 int cleanup_before_linux_select(int flags);
 606
 607 /* arch/$(ARCH)/lib/ticks.S */
 608 uint64_t get_ticks(void);
 609 void    wait_ticks    (unsigned long);
 610
 611 /* arch/$(ARCH)/lib/time.c */
 612 ulong   usec2ticks    (unsigned long usec);
 613 ulong   ticks2usec    (unsigned long ticks);
 614
 615 /* lib/gunzip.c */
 616 int gunzip(void *, int, unsigned char *, unsigned long *);
 617 int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
 618                                                 int stoponerr, int offset);
 619
 620 /**
 621  * gzwrite progress indicators: defined weak to allow board-specific
 622  * overrides:
 623  *
 624  *      gzwrite_progress_init called on startup
 625  *      gzwrite_progress called during decompress/write loop
 626  *      gzwrite_progress_finish called at end of loop to
 627  *              indicate success (retcode=0) or failure
 628  */
 629 void gzwrite_progress_init(u64 expected_size);
 630
 631 void gzwrite_progress(int iteration,
 632                      u64 bytes_written,
 633                      u64 total_bytes);
 634
 635 void gzwrite_progress_finish(int retcode,
 636                              u64 totalwritten,
 637                              u64 totalsize,
 638                              u32 expected_crc,
 639                              u32 calculated_crc);
 640
 641 /**
 642  * decompress and write gzipped image from memory to block device
 643  *
 644  * @param       src             compressed image address
 645  * @param       len             compressed image length in bytes
 646  * @param       dev             block device descriptor
 647  * @param       szwritebuf      bytes per write (pad to erase size)
 648  * @param       startoffs       offset in bytes of first write
 649  * @param       szexpected      expected uncompressed length
 650  *                              may be zero to use gzip trailer
 651  *                              for files under 4GiB
 652  */
 653 int gzwrite(unsigned char *src, int len,
 654             struct blk_desc *dev,
 655             unsigned long szwritebuf,
 656             u64 startoffs,
 657             u64 szexpected);
 658
 659 /* lib/lz4_wrapper.c */
 660 int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn);
 661
 662 /* lib/qsort.c */
 663 void qsort(void *base, size_t nmemb, size_t size,
 664            int(*compar)(const void *, const void *));
 665 int strcmp_compar(const void *, const void *);
 666
 667 /* lib/uuid.c */
 668 #include <uuid.h>
 669
 670 /* lib/vsprintf.c */
 671 #include <vsprintf.h>
 672
 673 /* lib/strmhz.c */
 674 char *  strmhz(char *buf, unsigned long hz);
 675
 676 /* lib/crc32.c */
 677 #include <u-boot/crc.h>
 678
 679 /* lib/rand.c */
 680 #define RAND_MAX -1U
 681 void srand(unsigned int seed);
 682 unsigned int rand(void);
 683 unsigned int rand_r(unsigned int *seedp);
 684
 685 /*
 686  * STDIO based functions (can always be used)
 687  */
 688 /* serial stuff */
 689 int     serial_printf (const char *fmt, ...)
 690                 __attribute__ ((format (__printf__, 1, 2)));
 691 /* stdin */
 692 int     getc(void);
 693 int     tstc(void);
 694
 695 /* stdout */
 696 #if !defined(CONFIG_SPL_BUILD) || \
 697         (defined(CONFIG_TPL_BUILD) && defined(CONFIG_TPL_SERIAL_SUPPORT)) || \
 698         (defined(CONFIG_SPL_BUILD) && !defined(CONFIG_TPL_BUILD) && \
 699                 defined(CONFIG_SPL_SERIAL_SUPPORT))
 700 void    putc(const char c);
 701 void    puts(const char *s);
 702 int     printf(const char *fmt, ...)
 703                 __attribute__ ((format (__printf__, 1, 2)));
 704 int     vprintf(const char *fmt, va_list args);
 705 #else
 706 #define putc(...) do { } while (0)
 707 #define puts(...) do { } while (0)
 708 #define printf(...) do { } while (0)
 709 #define vprintf(...) do { } while (0)
 710 #endif
 711
 712 /* stderr */
 713 #define eputc(c)                fputc(stderr, c)
 714 #define eputs(s)                fputs(stderr, s)
 715 #define eprintf(fmt,args...)    fprintf(stderr,fmt ,##args)
 716
 717 /*
 718  * FILE based functions (can only be used AFTER relocation!)
 719  */
 720 #define stdin           0
 721 #define stdout          1
 722 #define stderr          2
 723 #define MAX_FILES       3
 724
 725 int     fprintf(int file, const char *fmt, ...)
 726                 __attribute__ ((format (__printf__, 2, 3)));
 727 void    fputs(int file, const char *s);
 728 void    fputc(int file, const char c);
 729 int     ftstc(int file);
 730 int     fgetc(int file);
 731
 732 /* lib/gzip.c */
 733 int gzip(void *dst, unsigned long *lenp,
 734                 unsigned char *src, unsigned long srclen);
 735 int zzip(void *dst, unsigned long *lenp, unsigned char *src,
 736                 unsigned long srclen, int stoponerr,
 737                 int (*func)(unsigned long, unsigned long));
 738
 739 /* lib/net_utils.c */
 740 #include <net.h>
 741 static inline struct in_addr getenv_ip(char *var)
 742 {
 743         return string_to_ip(env_get(var));
 744 }
 745
 746 int     pcmcia_init (void);
 747
 748 #ifdef CONFIG_LED_STATUS
 749 # include <status_led.h>
 750 #endif
 751
 752 #include <bootstage.h>
 753
 754 #ifdef CONFIG_SHOW_ACTIVITY
 755 void show_activity(int arg);
 756 #endif
 757
 758 /* Multicore arch functions */
 759 #ifdef CONFIG_MP
 760 int cpu_status(int nr);
 761 int cpu_reset(int nr);
 762 int cpu_disable(int nr);
 763 int cpu_release(int nr, int argc, char * const argv[]);
 764 #endif
 765
 766 #else   /* __ASSEMBLY__ */
 767
 768 /* Drop a C type modifier (like in 3UL) for constants used in assembly. */
 769 #define _AC(X, Y)       X
 770
 771 #endif  /* __ASSEMBLY__ */
 772
 773 /* Put only stuff here that the assembler can digest */
 774
 775 /* Declare an unsigned long constant digestable both by C and an assembler. */
 776 #define UL(x)           _AC(x, UL)
 777
 778 #ifdef CONFIG_POST
 779 #define CONFIG_HAS_POST
 780 #ifndef CONFIG_POST_ALT_LIST
 781 #define CONFIG_POST_STD_LIST
 782 #endif
 783 #endif
 784
 785 #ifdef CONFIG_INIT_CRITICAL
 786 #error CONFIG_INIT_CRITICAL is deprecated!
 787 #error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
 788 #endif
 789
 790 #define ROUND(a,b)              (((a) + (b) - 1) & ~((b) - 1))
 791
 792 /*
 793  * check_member() - Check the offset of a structure member
 794  *
 795  * @structure:  Name of structure (e.g. global_data)
 796  * @member:     Name of member (e.g. baudrate)
 797  * @offset:     Expected offset in bytes
 798  */
 799 #define check_member(structure, member, offset) _Static_assert( \
 800         offsetof(struct structure, member) == offset, \
 801         "`struct " #structure "` offset for `" #member "` is not " #offset)
 802
 803 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
 804 #ifdef CONFIG_EFI_STUB
 805 #define ll_boot_init()  false
 806 #else
 807 #define ll_boot_init()  true
 808 #endif
 809
 810 /* Pull in stuff for the build system */
 811 #ifdef DO_DEPS_ONLY
 812 # include <environment.h>
 813 #endif
 814
 815 #endif  /* __COMMON_H_ */