git.sur5r.net Git - u-boot/blob - include/common.h

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