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