git.sur5r.net Git - u-boot/blob - 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/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 /**
 339  * env_get_ulong() - Return an environment variable as an integer value
 340  *
 341  * Most U-Boot environment variables store hex values. For those which store
 342  * (e.g.) base-10 integers, this function can be used to read the value.
 343  *
 344  * @name:       Variable to look up
 345  * @base:       Base to use (e.g. 10 for base 10, 2 for binary)
 346  * @default_val: Default value to return if no value is found
 347  * @return the value found, or @default_val if none
 348  */
 349 ulong env_get_ulong(const char *name, int base, ulong default_val);
 350
 351 /**
 352  * env_get_hex() - Return an environment variable as a hex value
 353  *
 354  * Decode an environment as a hex number (it may or may not have a 0x
 355  * prefix). If the environment variable cannot be found, or does not start
 356  * with hex digits, the default value is returned.
 357  *
 358  * @varname:            Variable to decode
 359  * @default_val:        Value to return on error
 360  */
 361 ulong env_get_hex(const char *varname, ulong default_val);
 362
 363 /*
 364  * Read an environment variable as a boolean
 365  * Return -1 if variable does not exist (default to true)
 366  */
 367 int env_get_yesno(const char *var);
 368
 369 /**
 370  * env_set() - set an environment variable
 371  *
 372  * This sets or deletes the value of an environment variable. For setting the
 373  * value the variable is created if it does not already exist.
 374  *
 375  * @varname: Variable to adjust
 376  * @value: Value to set for the variable, or NULL or "" to delete the variable
 377  * @return 0 if OK, 1 on error
 378  */
 379 int env_set(const char *varname, const char *value);
 380
 381 /**
 382  * env_set_ulong() - set an environment variable to an integer
 383  *
 384  * @varname: Variable to adjust
 385  * @value: Value to set for the variable (will be converted to a string)
 386  * @return 0 if OK, 1 on error
 387  */
 388 int env_set_ulong(const char *varname, ulong value);
 389
 390 /**
 391  * env_set_hex() - set an environment variable to a hex value
 392  *
 393  * @varname: Variable to adjust
 394  * @value: Value to set for the variable (will be converted to a hex string)
 395  * @return 0 if OK, 1 on error
 396  */
 397 int env_set_hex(const char *varname, ulong value);
 398
 399 /**
 400  * env_set_addr - Set an environment variable to an address in hex
 401  *
 402  * @varname:    Environment variable to set
 403  * @addr:       Value to set it to
 404  * @return 0 if ok, 1 on error
 405  */
 406 static inline int env_set_addr(const char *varname, const void *addr)
 407 {
 408         return env_set_hex(varname, (ulong)addr);
 409 }
 410
 411 #ifdef CONFIG_AUTO_COMPLETE
 412 int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
 413 #endif
 414 int get_env_id (void);
 415
 416 void    pci_init      (void);
 417 void    pci_init_board(void);
 418
 419 #if defined(CONFIG_DTB_RESELECT)
 420 int     embedded_dtb_select(void);
 421 #endif
 422
 423 int     misc_init_f   (void);
 424 int     misc_init_r   (void);
 425
 426 /* common/exports.c */
 427 void    jumptable_init(void);
 428
 429 /* common/kallsysm.c */
 430 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
 431
 432 /* common/memsize.c */
 433 long    get_ram_size  (long *, long);
 434 phys_size_t get_effective_memsize(void);
 435
 436 /* $(BOARD)/$(BOARD).c */
 437 void    reset_phy     (void);
 438 void    fdc_hw_init   (void);
 439
 440 /* $(BOARD)/eeprom.c */
 441 #ifdef CONFIG_CMD_EEPROM
 442 void eeprom_init  (int bus);
 443 int  eeprom_read  (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
 444 int  eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
 445 #else
 446 /*
 447  * Some EEPROM code is depecated because it used the legacy I2C interface. Add
 448  * some macros here so we don't have to touch every one of those uses
 449  */
 450 #define eeprom_init(bus)
 451 #define eeprom_read(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
 452 #define eeprom_write(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
 453 #endif
 454
 455 /*
 456  * Set this up regardless of board
 457  * type, to prevent errors.
 458  */
 459 #if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
 460 # define CONFIG_SYS_DEF_EEPROM_ADDR 0
 461 #else
 462 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
 463 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
 464 #endif
 465 #endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
 466
 467 #if defined(CONFIG_SPI)
 468 extern void spi_init_f (void);
 469 extern void spi_init_r (void);
 470 extern ssize_t spi_read  (uchar *, int, uchar *, int);
 471 extern ssize_t spi_write (uchar *, int, uchar *, int);
 472 #endif
 473
 474 /* $(BOARD)/$(BOARD).c */
 475 int board_early_init_f (void);
 476 int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */
 477 int board_late_init (void);
 478 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
 479 int board_early_init_r (void);
 480 void board_poweroff (void);
 481
 482 #if defined(CONFIG_SYS_DRAM_TEST)
 483 int testdram(void);
 484 #endif /* CONFIG_SYS_DRAM_TEST */
 485
 486 /* $(CPU)/start.S */
 487 int     icache_status (void);
 488 void    icache_enable (void);
 489 void    icache_disable(void);
 490 int     dcache_status (void);
 491 void    dcache_enable (void);
 492 void    dcache_disable(void);
 493 void    mmu_disable(void);
 494 #if defined(CONFIG_ARM)
 495 void    relocate_code(ulong);
 496 #else
 497 void    relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
 498 #endif
 499 ulong   get_endaddr   (void);
 500 void    trap_init     (ulong);
 501
 502 /* $(CPU)/cpu.c */
 503 static inline int cpumask_next(int cpu, unsigned int mask)
 504 {
 505         for (cpu++; !((1 << cpu) & mask); cpu++)
 506                 ;
 507
 508         return cpu;
 509 }
 510
 511 #define for_each_cpu(iter, cpu, num_cpus, mask) \
 512         for (iter = 0, cpu = cpumask_next(-1, mask); \
 513                 iter < num_cpus; \
 514                 iter++, cpu = cpumask_next(cpu, mask)) \
 515
 516 int     cpu_numcores  (void);
 517 int     cpu_num_dspcores(void);
 518 u32     cpu_mask      (void);
 519 u32     cpu_dsp_mask(void);
 520 int     is_core_valid (unsigned int);
 521
 522 /**
 523  * arch_cpu_init() - basic cpu-dependent setup for an architecture
 524  *
 525  * This is called after early malloc is available. It should handle any
 526  * CPU- or SoC- specific init needed to continue the init sequence. See
 527  * board_f.c for where it is called. If this is not provided, a default
 528  * version (which does nothing) will be used.
 529  */
 530 int arch_cpu_init(void);
 531
 532 int     checkcpu      (void);
 533 int     checkicache   (void);
 534 int     checkdcache   (void);
 535 void    upmconfig     (unsigned int, unsigned int *, unsigned int);
 536 ulong   get_tbclk     (void);
 537 void    reset_misc    (void);
 538 void    reset_cpu     (ulong addr);
 539 void ft_cpu_setup(void *blob, bd_t *bd);
 540 void ft_pci_setup(void *blob, bd_t *bd);
 541
 542 void smp_set_core_boot_addr(unsigned long addr, int corenr);
 543 void smp_kick_all_cpus(void);
 544
 545 /* $(CPU)/serial.c */
 546 int     serial_init   (void);
 547 void    serial_setbrg (void);
 548 void    serial_putc   (const char);
 549 void    serial_putc_raw(const char);
 550 void    serial_puts   (const char *);
 551 int     serial_getc   (void);
 552 int     serial_tstc   (void);
 553
 554 /* $(CPU)/speed.c */
 555 int     get_clocks (void);
 556 ulong   get_bus_freq  (ulong);
 557 int get_serial_clock(void);
 558
 559 int     cpu_init_r    (void);
 560
 561 /* $(CPU)/interrupts.c */
 562 int     interrupt_init     (void);
 563 void    timer_interrupt    (struct pt_regs *);
 564 void    external_interrupt (struct pt_regs *);
 565 void    irq_install_handler(int, interrupt_handler_t *, void *);
 566 void    irq_free_handler   (int);
 567 void    reset_timer        (void);
 568
 569 /* Return value of monotonic microsecond timer */
 570 unsigned long timer_get_us(void);
 571
 572 void    enable_interrupts  (void);
 573 int     disable_interrupts (void);
 574
 575 /* $(CPU)/.../commproc.c */
 576 int     dpram_init (void);
 577 uint    dpram_base(void);
 578 uint    dpram_base_align(uint align);
 579 uint    dpram_alloc(uint size);
 580 uint    dpram_alloc_align(uint size,uint align);
 581 void    bootcount_store (ulong);
 582 ulong   bootcount_load (void);
 583 #define BOOTCOUNT_MAGIC         0xB001C041
 584
 585 /* $(CPU)/.../<eth> */
 586 void mii_init (void);
 587
 588 /* $(CPU)/.../lcd.c */
 589 ulong   lcd_setmem (ulong);
 590
 591 /* $(CPU)/.../video.c */
 592 ulong   video_setmem (ulong);
 593
 594 /* arch/$(ARCH)/lib/cache.c */
 595 void    enable_caches(void);
 596 void    flush_cache   (unsigned long, unsigned long);
 597 void    flush_dcache_all(void);
 598 void    flush_dcache_range(unsigned long start, unsigned long stop);
 599 void    invalidate_dcache_range(unsigned long start, unsigned long stop);
 600 void    invalidate_dcache_all(void);
 601 void    invalidate_icache_all(void);
 602
 603 enum {
 604         /* Disable caches (else flush caches but leave them active) */
 605         CBL_DISABLE_CACHES              = 1 << 0,
 606         CBL_SHOW_BOOTSTAGE_REPORT       = 1 << 1,
 607
 608         CBL_ALL                         = 3,
 609 };
 610
 611 /**
 612  * Clean up ready for linux
 613  *
 614  * @param flags         Flags to control what is done
 615  */
 616 int cleanup_before_linux_select(int flags);
 617
 618 /* arch/$(ARCH)/lib/ticks.S */
 619 uint64_t get_ticks(void);
 620 void    wait_ticks    (unsigned long);
 621
 622 /* arch/$(ARCH)/lib/time.c */
 623 ulong   usec2ticks    (unsigned long usec);
 624 ulong   ticks2usec    (unsigned long ticks);
 625
 626 /* lib/gunzip.c */
 627 int gunzip(void *, int, unsigned char *, unsigned long *);
 628 int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
 629                                                 int stoponerr, int offset);
 630
 631 /**
 632  * gzwrite progress indicators: defined weak to allow board-specific
 633  * overrides:
 634  *
 635  *      gzwrite_progress_init called on startup
 636  *      gzwrite_progress called during decompress/write loop
 637  *      gzwrite_progress_finish called at end of loop to
 638  *              indicate success (retcode=0) or failure
 639  */
 640 void gzwrite_progress_init(u64 expected_size);
 641
 642 void gzwrite_progress(int iteration,
 643                      u64 bytes_written,
 644                      u64 total_bytes);
 645
 646 void gzwrite_progress_finish(int retcode,
 647                              u64 totalwritten,
 648                              u64 totalsize,
 649                              u32 expected_crc,
 650                              u32 calculated_crc);
 651
 652 /**
 653  * decompress and write gzipped image from memory to block device
 654  *
 655  * @param       src             compressed image address
 656  * @param       len             compressed image length in bytes
 657  * @param       dev             block device descriptor
 658  * @param       szwritebuf      bytes per write (pad to erase size)
 659  * @param       startoffs       offset in bytes of first write
 660  * @param       szexpected      expected uncompressed length
 661  *                              may be zero to use gzip trailer
 662  *                              for files under 4GiB
 663  */
 664 int gzwrite(unsigned char *src, int len,
 665             struct blk_desc *dev,
 666             unsigned long szwritebuf,
 667             u64 startoffs,
 668             u64 szexpected);
 669
 670 /* lib/lz4_wrapper.c */
 671 int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn);
 672
 673 /* lib/qsort.c */
 674 void qsort(void *base, size_t nmemb, size_t size,
 675            int(*compar)(const void *, const void *));
 676 int strcmp_compar(const void *, const void *);
 677
 678 /* lib/uuid.c */
 679 #include <uuid.h>
 680
 681 /* lib/vsprintf.c */
 682 #include <vsprintf.h>
 683
 684 /* lib/strmhz.c */
 685 char *  strmhz(char *buf, unsigned long hz);
 686
 687 /* lib/crc32.c */
 688 #include <u-boot/crc.h>
 689
 690 /* lib/rand.c */
 691 #define RAND_MAX -1U
 692 void srand(unsigned int seed);
 693 unsigned int rand(void);
 694 unsigned int rand_r(unsigned int *seedp);
 695
 696 /*
 697  * STDIO based functions (can always be used)
 698  */
 699 /* serial stuff */
 700 int     serial_printf (const char *fmt, ...)
 701                 __attribute__ ((format (__printf__, 1, 2)));
 702 /* stdin */
 703 int     getc(void);
 704 int     tstc(void);
 705
 706 /* stdout */
 707 #if !defined(CONFIG_SPL_BUILD) || \
 708         (defined(CONFIG_TPL_BUILD) && defined(CONFIG_TPL_SERIAL_SUPPORT)) || \
 709         (defined(CONFIG_SPL_BUILD) && !defined(CONFIG_TPL_BUILD) && \
 710                 defined(CONFIG_SPL_SERIAL_SUPPORT))
 711 void    putc(const char c);
 712 void    puts(const char *s);
 713 int     printf(const char *fmt, ...)
 714                 __attribute__ ((format (__printf__, 1, 2)));
 715 int     vprintf(const char *fmt, va_list args);
 716 #else
 717 #define putc(...) do { } while (0)
 718 #define puts(...) do { } while (0)
 719 #define printf(...) do { } while (0)
 720 #define vprintf(...) do { } while (0)
 721 #endif
 722
 723 /* stderr */
 724 #define eputc(c)                fputc(stderr, c)
 725 #define eputs(s)                fputs(stderr, s)
 726 #define eprintf(fmt,args...)    fprintf(stderr,fmt ,##args)
 727
 728 /*
 729  * FILE based functions (can only be used AFTER relocation!)
 730  */
 731 #define stdin           0
 732 #define stdout          1
 733 #define stderr          2
 734 #define MAX_FILES       3
 735
 736 int     fprintf(int file, const char *fmt, ...)
 737                 __attribute__ ((format (__printf__, 2, 3)));
 738 void    fputs(int file, const char *s);
 739 void    fputc(int file, const char c);
 740 int     ftstc(int file);
 741 int     fgetc(int file);
 742
 743 /* lib/gzip.c */
 744 int gzip(void *dst, unsigned long *lenp,
 745                 unsigned char *src, unsigned long srclen);
 746 int zzip(void *dst, unsigned long *lenp, unsigned char *src,
 747                 unsigned long srclen, int stoponerr,
 748                 int (*func)(unsigned long, unsigned long));
 749
 750 /* lib/net_utils.c */
 751 #include <net.h>
 752 static inline struct in_addr env_get_ip(char *var)
 753 {
 754         return string_to_ip(env_get(var));
 755 }
 756
 757 int     pcmcia_init (void);
 758
 759 #ifdef CONFIG_LED_STATUS
 760 # include <status_led.h>
 761 #endif
 762
 763 #include <bootstage.h>
 764
 765 #ifdef CONFIG_SHOW_ACTIVITY
 766 void show_activity(int arg);
 767 #endif
 768
 769 /* Multicore arch functions */
 770 #ifdef CONFIG_MP
 771 int cpu_status(int nr);
 772 int cpu_reset(int nr);
 773 int cpu_disable(int nr);
 774 int cpu_release(int nr, int argc, char * const argv[]);
 775 #endif
 776
 777 #else   /* __ASSEMBLY__ */
 778
 779 /* Drop a C type modifier (like in 3UL) for constants used in assembly. */
 780 #define _AC(X, Y)       X
 781
 782 #endif  /* __ASSEMBLY__ */
 783
 784 /* Put only stuff here that the assembler can digest */
 785
 786 /* Declare an unsigned long constant digestable both by C and an assembler. */
 787 #define UL(x)           _AC(x, UL)
 788
 789 #ifdef CONFIG_POST
 790 #define CONFIG_HAS_POST
 791 #ifndef CONFIG_POST_ALT_LIST
 792 #define CONFIG_POST_STD_LIST
 793 #endif
 794 #endif
 795
 796 #ifdef CONFIG_INIT_CRITICAL
 797 #error CONFIG_INIT_CRITICAL is deprecated!
 798 #error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
 799 #endif
 800
 801 #define ROUND(a,b)              (((a) + (b) - 1) & ~((b) - 1))
 802
 803 /*
 804  * check_member() - Check the offset of a structure member
 805  *
 806  * @structure:  Name of structure (e.g. global_data)
 807  * @member:     Name of member (e.g. baudrate)
 808  * @offset:     Expected offset in bytes
 809  */
 810 #define check_member(structure, member, offset) _Static_assert( \
 811         offsetof(struct structure, member) == offset, \
 812         "`struct " #structure "` offset for `" #member "` is not " #offset)
 813
 814 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
 815 #ifdef CONFIG_EFI_STUB
 816 #define ll_boot_init()  false
 817 #else
 818 #define ll_boot_init()  true
 819 #endif
 820
 821 /* Pull in stuff for the build system */
 822 #ifdef DO_DEPS_ONLY
 823 # include <environment.h>
 824 #endif
 825
 826 #endif  /* __COMMON_H_ */