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