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