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