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