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 #if defined(CONFIG_DISPLAY_CPUINFO)
 288 int print_cpuinfo(void);
 289 #else
 290 static inline int print_cpuinfo(void)
 291 {
 292         return 0;
 293 }
 294 #endif
 295 int update_flash_size(int flash_size);
 296 int arch_early_init_r(void);
 297
 298 /**
 299  * arch_cpu_init_dm() - init CPU after driver model is available
 300  *
 301  * This is called immediately after driver model is available before
 302  * relocation. This is similar to arch_cpu_init() but is able to reference
 303  * devices
 304  *
 305  * @return 0 if OK, -ve on error
 306  */
 307 int arch_cpu_init_dm(void);
 308
 309 /**
 310  * Reserve all necessary stacks
 311  *
 312  * This is used in generic board init sequence in common/board_f.c. Each
 313  * architecture could provide this function to tailor the required stacks.
 314  *
 315  * On entry gd->start_addr_sp is pointing to the suggested top of the stack.
 316  * The callee ensures gd->start_add_sp is 16-byte aligned, so architectures
 317  * require only this can leave it untouched.
 318  *
 319  * On exit gd->start_addr_sp and gd->irq_sp should be set to the respective
 320  * positions of the stack. The stack pointer(s) will be set to this later.
 321  * gd->irq_sp is only required, if the architecture needs it.
 322  *
 323  * @return 0 if no error
 324  */
 325 __weak int arch_reserve_stacks(void);
 326
 327 /**
 328  * Show the DRAM size in a board-specific way
 329  *
 330  * This is used by boards to display DRAM information in their own way.
 331  *
 332  * @param size  Size of DRAM (which should be displayed along with other info)
 333  */
 334 void board_show_dram(phys_size_t size);
 335
 336 /**
 337  * arch_fixup_fdt() - Write arch-specific information to fdt
 338  *
 339  * Defined in arch/$(ARCH)/lib/bootm-fdt.c
 340  *
 341  * @blob:       FDT blob to write to
 342  * @return 0 if ok, or -ve FDT_ERR_... on failure
 343  */
 344 int arch_fixup_fdt(void *blob);
 345
 346 /* common/flash.c */
 347 void flash_perror (int);
 348
 349 /* common/cmd_source.c */
 350 int     source (ulong addr, const char *fit_uname);
 351
 352 extern ulong load_addr;         /* Default Load Address */
 353 extern ulong save_addr;         /* Default Save Address */
 354 extern ulong save_size;         /* Default Save Size */
 355
 356 /* common/cmd_doc.c */
 357 void    doc_probe(unsigned long physadr);
 358
 359 /* common/cmd_net.c */
 360 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 361
 362 /* common/cmd_fat.c */
 363 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
 364
 365 /* common/cmd_ext2.c */
 366 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
 367
 368 /* common/cmd_nvedit.c */
 369 int     env_init     (void);
 370 void    env_relocate (void);
 371 int     envmatch     (uchar *, int);
 372
 373 /* Avoid unfortunate conflict with libc's getenv() */
 374 #ifdef CONFIG_SANDBOX
 375 #define getenv uboot_getenv
 376 #endif
 377 char    *getenv      (const char *);
 378 int     getenv_f     (const char *name, char *buf, unsigned len);
 379 ulong getenv_ulong(const char *name, int base, ulong default_val);
 380
 381 /**
 382  * getenv_hex() - Return an environment variable as a hex value
 383  *
 384  * Decode an environment as a hex number (it may or may not have a 0x
 385  * prefix). If the environment variable cannot be found, or does not start
 386  * with hex digits, the default value is returned.
 387  *
 388  * @varname:            Variable to decode
 389  * @default_val:        Value to return on error
 390  */
 391 ulong getenv_hex(const char *varname, ulong default_val);
 392
 393 /*
 394  * Read an environment variable as a boolean
 395  * Return -1 if variable does not exist (default to true)
 396  */
 397 int getenv_yesno(const char *var);
 398 int     saveenv      (void);
 399 int     setenv       (const char *, const char *);
 400 int setenv_ulong(const char *varname, ulong value);
 401 int setenv_hex(const char *varname, ulong value);
 402 /**
 403  * setenv_addr - Set an environment variable to an address in hex
 404  *
 405  * @varname:    Environment variable to set
 406  * @addr:       Value to set it to
 407  * @return 0 if ok, 1 on error
 408  */
 409 static inline int setenv_addr(const char *varname, const void *addr)
 410 {
 411         return setenv_hex(varname, (ulong)addr);
 412 }
 413
 414 #ifdef CONFIG_ARM
 415 # include <asm/mach-types.h>
 416 # include <asm/setup.h>
 417 # include <asm/u-boot-arm.h>    /* ARM version to be fixed! */
 418 #endif /* CONFIG_ARM */
 419 #ifdef CONFIG_X86               /* x86 version to be fixed! */
 420 # include <asm/u-boot-x86.h>
 421 #endif /* CONFIG_X86 */
 422 #ifdef CONFIG_SANDBOX
 423 # include <asm/u-boot-sandbox.h>        /* TODO(sjg) what needs to be fixed? */
 424 #endif
 425 #ifdef CONFIG_NDS32
 426 # include <asm/mach-types.h>
 427 # include <asm/setup.h>
 428 # include <asm/u-boot-nds32.h>
 429 #endif /* CONFIG_NDS32 */
 430 #ifdef CONFIG_MIPS
 431 # include <asm/u-boot-mips.h>
 432 #endif /* CONFIG_MIPS */
 433 #ifdef CONFIG_ARC
 434 # include <asm/u-boot-arc.h>
 435 #endif /* CONFIG_ARC */
 436
 437 #ifdef CONFIG_AUTO_COMPLETE
 438 int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
 439 #endif
 440 int get_env_id (void);
 441
 442 void    pci_init      (void);
 443 void    pci_init_board(void);
 444
 445 #if defined(CONFIG_PCI) && defined(CONFIG_4xx)
 446     int    pci_pre_init        (struct pci_controller *);
 447     int    is_pci_host         (struct pci_controller *);
 448 #endif
 449
 450 #if defined(CONFIG_PCI) && (defined(CONFIG_440) || defined(CONFIG_405EX))
 451 #   if defined(CONFIG_SYS_PCI_TARGET_INIT)
 452         void    pci_target_init      (struct pci_controller *);
 453 #   endif
 454 #   if defined(CONFIG_SYS_PCI_MASTER_INIT)
 455         void    pci_master_init      (struct pci_controller *);
 456 #   endif
 457 #if defined(CONFIG_440SPE) || \
 458     defined(CONFIG_460EX) || defined(CONFIG_460GT) || \
 459     defined(CONFIG_405EX)
 460    void pcie_setup_hoses(int busno);
 461 #endif
 462 #endif
 463
 464 int     misc_init_f   (void);
 465 int     misc_init_r   (void);
 466
 467 /* common/exports.c */
 468 void    jumptable_init(void);
 469
 470 /* common/kallsysm.c */
 471 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
 472
 473 /* api/api.c */
 474 void    api_init (void);
 475
 476 /* common/memsize.c */
 477 long    get_ram_size  (long *, long);
 478 phys_size_t get_effective_memsize(void);
 479
 480 /* $(BOARD)/$(BOARD).c */
 481 void    reset_phy     (void);
 482 void    fdc_hw_init   (void);
 483
 484 /* $(BOARD)/eeprom.c */
 485 void eeprom_init  (int bus);
 486 int  eeprom_read  (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
 487 int  eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
 488
 489 /*
 490  * Set this up regardless of board
 491  * type, to prevent errors.
 492  */
 493 #if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
 494 # define CONFIG_SYS_DEF_EEPROM_ADDR 0
 495 #else
 496 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
 497 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
 498 #endif
 499 #endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
 500
 501 #if defined(CONFIG_SPI)
 502 extern void spi_init_f (void);
 503 extern void spi_init_r (void);
 504 extern ssize_t spi_read  (uchar *, int, uchar *, int);
 505 extern ssize_t spi_write (uchar *, int, uchar *, int);
 506 #endif
 507
 508 /* $(BOARD)/$(BOARD).c */
 509 int board_early_init_f (void);
 510 int board_late_init (void);
 511 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
 512 int board_early_init_r (void);
 513 void board_poweroff (void);
 514
 515 #if defined(CONFIG_SYS_DRAM_TEST)
 516 int testdram(void);
 517 #endif /* CONFIG_SYS_DRAM_TEST */
 518
 519 /* $(CPU)/start.S */
 520 #if defined(CONFIG_5xx) || \
 521     defined(CONFIG_8xx)
 522 uint    get_immr      (uint);
 523 #endif
 524 #if defined(CONFIG_MPC5xxx)
 525 uint    get_svr       (void);
 526 #endif
 527 uint    get_pvr       (void);
 528 uint    get_svr       (void);
 529 uint    rd_ic_cst     (void);
 530 void    wr_ic_cst     (uint);
 531 void    wr_ic_adr     (uint);
 532 uint    rd_dc_cst     (void);
 533 void    wr_dc_cst     (uint);
 534 void    wr_dc_adr     (uint);
 535 int     icache_status (void);
 536 void    icache_enable (void);
 537 void    icache_disable(void);
 538 int     dcache_status (void);
 539 void    dcache_enable (void);
 540 void    dcache_disable(void);
 541 void    mmu_disable(void);
 542 #if defined(CONFIG_ARM)
 543 void    relocate_code(ulong);
 544 #else
 545 void    relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
 546 #endif
 547 ulong   get_endaddr   (void);
 548 void    trap_init     (ulong);
 549 #if defined (CONFIG_4xx)        || \
 550     defined (CONFIG_MPC5xxx)    || \
 551     defined (CONFIG_MPC85xx)    || \
 552     defined (CONFIG_MPC86xx)    || \
 553     defined (CONFIG_MPC83xx)
 554 unsigned char   in8(unsigned int);
 555 void            out8(unsigned int, unsigned char);
 556 unsigned short  in16(unsigned int);
 557 unsigned short  in16r(unsigned int);
 558 void            out16(unsigned int, unsigned short value);
 559 void            out16r(unsigned int, unsigned short value);
 560 unsigned long   in32(unsigned int);
 561 unsigned long   in32r(unsigned int);
 562 void            out32(unsigned int, unsigned long value);
 563 void            out32r(unsigned int, unsigned long value);
 564 void            ppcDcbf(unsigned long value);
 565 void            ppcDcbi(unsigned long value);
 566 void            ppcSync(void);
 567 void            ppcDcbz(unsigned long value);
 568 #endif
 569 #if defined (CONFIG_MICROBLAZE)
 570 unsigned short  in16(unsigned int);
 571 void            out16(unsigned int, unsigned short value);
 572 #endif
 573
 574 #if defined (CONFIG_MPC83xx)
 575 void            ppcDWload(unsigned int *addr, unsigned int *ret);
 576 void            ppcDWstore(unsigned int *addr, unsigned int *value);
 577 void disable_addr_trans(void);
 578 void enable_addr_trans(void);
 579 #if defined(CONFIG_DDR_ECC) && !defined(CONFIG_ECC_INIT_VIA_DDRCONTROLLER)
 580 void ddr_enable_ecc(unsigned int dram_size);
 581 #endif
 582 #endif
 583
 584 /* $(CPU)/cpu.c */
 585 static inline int cpumask_next(int cpu, unsigned int mask)
 586 {
 587         for (cpu++; !((1 << cpu) & mask); cpu++)
 588                 ;
 589
 590         return cpu;
 591 }
 592
 593 #define for_each_cpu(iter, cpu, num_cpus, mask) \
 594         for (iter = 0, cpu = cpumask_next(-1, mask); \
 595                 iter < num_cpus; \
 596                 iter++, cpu = cpumask_next(cpu, mask)) \
 597
 598 int     cpu_numcores  (void);
 599 int     cpu_num_dspcores(void);
 600 u32     cpu_mask      (void);
 601 u32     cpu_dsp_mask(void);
 602 int     is_core_valid (unsigned int);
 603
 604 /**
 605  * arch_cpu_init() - basic cpu-dependent setup for an architecture
 606  *
 607  * This is called after early malloc is available. It should handle any
 608  * CPU- or SoC- specific init needed to continue the init sequence. See
 609  * board_f.c for where it is called. If this is not provided, a default
 610  * version (which does nothing) will be used.
 611  */
 612 int arch_cpu_init(void);
 613
 614 int     checkcpu      (void);
 615 int     checkicache   (void);
 616 int     checkdcache   (void);
 617 void    upmconfig     (unsigned int, unsigned int *, unsigned int);
 618 ulong   get_tbclk     (void);
 619 void    reset_misc    (void);
 620 void    reset_cpu     (ulong addr);
 621 void ft_cpu_setup(void *blob, bd_t *bd);
 622 void ft_pci_setup(void *blob, bd_t *bd);
 623
 624 void smp_set_core_boot_addr(unsigned long addr, int corenr);
 625 void smp_kick_all_cpus(void);
 626
 627 /* $(CPU)/serial.c */
 628 int     serial_init   (void);
 629 void    serial_setbrg (void);
 630 void    serial_putc   (const char);
 631 void    serial_putc_raw(const char);
 632 void    serial_puts   (const char *);
 633 int     serial_getc   (void);
 634 int     serial_tstc   (void);
 635
 636 /* These versions take a stdio_dev pointer */
 637 struct stdio_dev;
 638 int serial_stub_getc(struct stdio_dev *sdev);
 639 int serial_stub_tstc(struct stdio_dev *sdev);
 640
 641 /* $(CPU)/speed.c */
 642 int     get_clocks (void);
 643 int     get_clocks_866 (void);
 644 int     sdram_adjust_866 (void);
 645 int     adjust_sdram_tbs_8xx (void);
 646 #if defined(CONFIG_MPC8260)
 647 int     prt_8260_clks (void);
 648 #elif defined(CONFIG_MPC5xxx)
 649 int     prt_mpc5xxx_clks (void);
 650 #endif
 651 #ifdef CONFIG_4xx
 652 ulong   get_OPB_freq (void);
 653 ulong   get_PCI_freq (void);
 654 #endif
 655 #if defined(CONFIG_S3C24X0) || \
 656     defined(CONFIG_LH7A40X) || \
 657     defined(CONFIG_EP93XX)
 658 ulong   get_FCLK (void);
 659 ulong   get_HCLK (void);
 660 ulong   get_PCLK (void);
 661 ulong   get_UCLK (void);
 662 #endif
 663 #if defined(CONFIG_LH7A40X)
 664 ulong   get_PLLCLK (void);
 665 #endif
 666 #if defined(CONFIG_IMX)
 667 ulong get_systemPLLCLK(void);
 668 ulong get_FCLK(void);
 669 ulong get_HCLK(void);
 670 ulong get_BCLK(void);
 671 ulong get_PERCLK1(void);
 672 ulong get_PERCLK2(void);
 673 ulong get_PERCLK3(void);
 674 #endif
 675 ulong   get_bus_freq  (ulong);
 676 int get_serial_clock(void);
 677
 678 #if defined(CONFIG_MPC85xx)
 679 typedef MPC85xx_SYS_INFO sys_info_t;
 680 void    get_sys_info  ( sys_info_t * );
 681 void ft_fixup_cpu(void *, u64);
 682 void ft_fixup_num_cores(void *);
 683 #endif
 684 #if defined(CONFIG_MPC86xx)
 685 typedef MPC86xx_SYS_INFO sys_info_t;
 686 void   get_sys_info  ( sys_info_t * );
 687 static inline ulong get_ddr_freq(ulong dummy)
 688 {
 689         return get_bus_freq(dummy);
 690 }
 691 #else
 692 ulong get_ddr_freq(ulong);
 693 #endif
 694
 695 #if defined(CONFIG_4xx)
 696 #  if defined(CONFIG_440)
 697 #       if defined(CONFIG_440SPE)
 698          unsigned long determine_sysper(void);
 699          unsigned long determine_pci_clock_per(void);
 700 #       endif
 701 #  endif
 702 typedef PPC4xx_SYS_INFO sys_info_t;
 703 int     ppc440spe_revB(void);
 704 void    get_sys_info  ( sys_info_t * );
 705 #endif
 706
 707 /* $(CPU)/cpu_init.c */
 708 #if defined(CONFIG_8xx) || defined(CONFIG_MPC8260)
 709 void    cpu_init_f    (volatile immap_t *immr);
 710 #endif
 711 #if defined(CONFIG_4xx) || defined(CONFIG_MCF52x2) || defined(CONFIG_MPC86xx)
 712 void    cpu_init_f    (void);
 713 #endif
 714 #ifdef CONFIG_MPC85xx
 715 ulong cpu_init_f(void);
 716 #endif
 717
 718 int     cpu_init_r    (void);
 719 #if defined(CONFIG_MPC8260)
 720 int     prt_8260_rsr  (void);
 721 #elif defined(CONFIG_MPC83xx)
 722 int     prt_83xx_rsr  (void);
 723 #endif
 724
 725 /* $(CPU)/interrupts.c */
 726 int     interrupt_init     (void);
 727 void    timer_interrupt    (struct pt_regs *);
 728 void    external_interrupt (struct pt_regs *);
 729 void    irq_install_handler(int, interrupt_handler_t *, void *);
 730 void    irq_free_handler   (int);
 731 void    reset_timer        (void);
 732
 733 /* Return value of monotonic microsecond timer */
 734 unsigned long timer_get_us(void);
 735
 736 void    enable_interrupts  (void);
 737 int     disable_interrupts (void);
 738
 739 /* $(CPU)/.../commproc.c */
 740 int     dpram_init (void);
 741 uint    dpram_base(void);
 742 uint    dpram_base_align(uint align);
 743 uint    dpram_alloc(uint size);
 744 uint    dpram_alloc_align(uint size,uint align);
 745 void    bootcount_store (ulong);
 746 ulong   bootcount_load (void);
 747 #define BOOTCOUNT_MAGIC         0xB001C041
 748
 749 /* $(CPU)/.../<eth> */
 750 void mii_init (void);
 751
 752 /* $(CPU)/.../lcd.c */
 753 ulong   lcd_setmem (ulong);
 754
 755 /* $(CPU)/.../video.c */
 756 ulong   video_setmem (ulong);
 757
 758 /* arch/$(ARCH)/lib/cache.c */
 759 void    enable_caches(void);
 760 void    flush_cache   (unsigned long, unsigned long);
 761 void    flush_dcache_all(void);
 762 void    flush_dcache_range(unsigned long start, unsigned long stop);
 763 void    invalidate_dcache_range(unsigned long start, unsigned long stop);
 764 void    invalidate_dcache_all(void);
 765 void    invalidate_icache_all(void);
 766
 767 enum {
 768         /* Disable caches (else flush caches but leave them active) */
 769         CBL_DISABLE_CACHES              = 1 << 0,
 770         CBL_SHOW_BOOTSTAGE_REPORT       = 1 << 1,
 771
 772         CBL_ALL                         = 3,
 773 };
 774
 775 /**
 776  * Clean up ready for linux
 777  *
 778  * @param flags         Flags to control what is done
 779  */
 780 int cleanup_before_linux_select(int flags);
 781
 782 /* arch/$(ARCH)/lib/ticks.S */
 783 uint64_t get_ticks(void);
 784 void    wait_ticks    (unsigned long);
 785
 786 /* arch/$(ARCH)/lib/time.c */
 787 ulong   usec2ticks    (unsigned long usec);
 788 ulong   ticks2usec    (unsigned long ticks);
 789 int     init_timebase (void);
 790
 791 /* lib/gunzip.c */
 792 int gunzip(void *, int, unsigned char *, unsigned long *);
 793 int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
 794                                                 int stoponerr, int offset);
 795
 796 /**
 797  * gzwrite progress indicators: defined weak to allow board-specific
 798  * overrides:
 799  *
 800  *      gzwrite_progress_init called on startup
 801  *      gzwrite_progress called during decompress/write loop
 802  *      gzwrite_progress_finish called at end of loop to
 803  *              indicate success (retcode=0) or failure
 804  */
 805 void gzwrite_progress_init(u64 expected_size);
 806
 807 void gzwrite_progress(int iteration,
 808                      u64 bytes_written,
 809                      u64 total_bytes);
 810
 811 void gzwrite_progress_finish(int retcode,
 812                              u64 totalwritten,
 813                              u64 totalsize,
 814                              u32 expected_crc,
 815                              u32 calculated_crc);
 816
 817 /**
 818  * decompress and write gzipped image from memory to block device
 819  *
 820  * @param       src             compressed image address
 821  * @param       len             compressed image length in bytes
 822  * @param       dev             block device descriptor
 823  * @param       szwritebuf      bytes per write (pad to erase size)
 824  * @param       startoffs       offset in bytes of first write
 825  * @param       szexpected      expected uncompressed length
 826  *                              may be zero to use gzip trailer
 827  *                              for files under 4GiB
 828  */
 829 int gzwrite(unsigned char *src, int len,
 830             struct blk_desc *dev,
 831             unsigned long szwritebuf,
 832             u64 startoffs,
 833             u64 szexpected);
 834
 835 /* lib/lz4_wrapper.c */
 836 int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn);
 837
 838 /* lib/qsort.c */
 839 void qsort(void *base, size_t nmemb, size_t size,
 840            int(*compar)(const void *, const void *));
 841 int strcmp_compar(const void *, const void *);
 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_LED_STATUS
 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_ */