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