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 #if defined(CONFIG_PCI) && defined(CONFIG_4xx)
  27 #include <pci.h>
  28 #endif
  29 #if defined(CONFIG_8xx)
  30 #include <asm/8xx_immap.h>
  31 #if defined(CONFIG_MPC852)      || defined(CONFIG_MPC852T)      || \
  32     defined(CONFIG_MPC859)      || defined(CONFIG_MPC859T)      || \
  33     defined(CONFIG_MPC859DSL)   || \
  34     defined(CONFIG_MPC866)      || defined(CONFIG_MPC866T)      || \
  35     defined(CONFIG_MPC866P)
  36 # define CONFIG_MPC866_FAMILY 1
  37 #elif defined(CONFIG_MPC870) \
  38    || defined(CONFIG_MPC875) \
  39    || defined(CONFIG_MPC880) \
  40    || defined(CONFIG_MPC885)
  41 # define CONFIG_MPC885_FAMILY   1
  42 #endif
  43 #if   defined(CONFIG_MPC860)       \
  44    || defined(CONFIG_MPC860T)      \
  45    || defined(CONFIG_MPC866_FAMILY) \
  46    || defined(CONFIG_MPC885_FAMILY)
  47 # define CONFIG_MPC86x 1
  48 #endif
  49 #elif defined(CONFIG_5xx)
  50 #include <asm/5xx_immap.h>
  51 #elif defined(CONFIG_MPC5xxx)
  52 #include <mpc5xxx.h>
  53 #elif defined(CONFIG_MPC512X)
  54 #include <asm/immap_512x.h>
  55 #elif defined(CONFIG_MPC8260)
  56 #if   defined(CONFIG_MPC8247) \
  57    || defined(CONFIG_MPC8248) \
  58    || defined(CONFIG_MPC8271) \
  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_HYMOD
  80 #include <board/hymod/hymod.h>
  81 #endif
  82 #ifdef CONFIG_ARM
  83 #define asmlinkage      /* nothing */
  84 #endif
  85 #ifdef CONFIG_BLACKFIN
  86 #include <asm/blackfin.h>
  87 #endif
  88 #ifdef CONFIG_SOC_DA8XX
  89 #include <asm/arch/hardware.h>
  90 #endif
  91
  92 #include <part.h>
  93 #include <flash.h>
  94 #include <image.h>
  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 /*
 107  * Output a debug text when condition "cond" is met. The "cond" should be
 108  * computed by a preprocessor in the best case, allowing for the best
 109  * optimization.
 110  */
 111 #define debug_cond(cond, fmt, args...)          \
 112         do {                                    \
 113                 if (cond)                       \
 114                         printf(fmt, ##args);    \
 115         } while (0)
 116
 117 #define debug(fmt, args...)                     \
 118         debug_cond(_DEBUG, fmt, ##args)
 119
 120 /*
 121  * An assertion is run-time check done in debug mode only. If DEBUG is not
 122  * defined then it is skipped. If DEBUG is defined and the assertion fails,
 123  * then it calls panic*( which may or may not reset/halt U-Boot (see
 124  * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
 125  * before release, and after release it is hoped that they don't matter. But
 126  * in any case these failing assertions cannot be fixed with a reset (which
 127  * may just do the same assertion again).
 128  */
 129 void __assert_fail(const char *assertion, const char *file, unsigned line,
 130                    const char *function);
 131 #define assert(x) \
 132         ({ if (!(x) && _DEBUG) \
 133                 __assert_fail(#x, __FILE__, __LINE__, __func__); })
 134
 135 #define error(fmt, args...) do {                                        \
 136                 printf("ERROR: " fmt "\nat %s:%d/%s()\n",               \
 137                         ##args, __FILE__, __LINE__, __func__);          \
 138 } while (0)
 139
 140 #ifndef BUG
 141 #define BUG() do { \
 142         printf("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __FUNCTION__); \
 143         panic("BUG!"); \
 144 } while (0)
 145 #define BUG_ON(condition) do { if (unlikely((condition)!=0)) BUG(); } while(0)
 146 #endif /* BUG */
 147
 148 /* Force a compilation error if condition is true */
 149 #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
 150
 151 typedef void (interrupt_handler_t)(void *);
 152
 153 #include <asm/u-boot.h> /* boot information for Linux kernel */
 154 #include <asm/global_data.h>    /* global data used for startup functions */
 155
 156 /*
 157  * enable common handling for all TQM8xxL/M boards:
 158  * - CONFIG_TQM8xxM will be defined for all TQM8xxM boards
 159  * - CONFIG_TQM8xxL will be defined for all TQM8xxL _and_ TQM8xxM boards
 160  *                  and for the TQM885D board
 161  */
 162 #if defined(CONFIG_TQM823M) || defined(CONFIG_TQM850M) || \
 163     defined(CONFIG_TQM855M) || defined(CONFIG_TQM860M) || \
 164     defined(CONFIG_TQM862M) || defined(CONFIG_TQM866M)
 165 # ifndef CONFIG_TQM8xxM
 166 #  define CONFIG_TQM8xxM
 167 # endif
 168 #endif
 169 #if defined(CONFIG_TQM823L) || defined(CONFIG_TQM850L) || \
 170     defined(CONFIG_TQM855L) || defined(CONFIG_TQM860L) || \
 171     defined(CONFIG_TQM862L) || defined(CONFIG_TQM8xxM) || \
 172     defined(CONFIG_TQM885D)
 173 # ifndef CONFIG_TQM8xxL
 174 #  define CONFIG_TQM8xxL
 175 # endif
 176 #endif
 177
 178 /*
 179  * General Purpose Utilities
 180  */
 181 #define min(X, Y)                               \
 182         ({ typeof(X) __x = (X);                 \
 183                 typeof(Y) __y = (Y);            \
 184                 (__x < __y) ? __x : __y; })
 185
 186 #define max(X, Y)                               \
 187         ({ typeof(X) __x = (X);                 \
 188                 typeof(Y) __y = (Y);            \
 189                 (__x > __y) ? __x : __y; })
 190
 191 #define MIN(x, y)  min(x, y)
 192 #define MAX(x, y)  max(x, y)
 193
 194 #define min3(X, Y, Z)                           \
 195         ({ typeof(X) __x = (X);                 \
 196                 typeof(Y) __y = (Y);            \
 197                 typeof(Z) __z = (Z);            \
 198                 __x < __y ? (__x < __z ? __x : __z) :   \
 199                 (__y < __z ? __y : __z); })
 200
 201 #define max3(X, Y, Z)                           \
 202         ({ typeof(X) __x = (X);                 \
 203                 typeof(Y) __y = (Y);            \
 204                 typeof(Z) __z = (Z);            \
 205                 __x > __y ? (__x > __z ? __x : __z) :   \
 206                 (__y > __z ? __y : __z); })
 207
 208 #define MIN3(x, y, z)  min3(x, y, z)
 209 #define MAX3(x, y, z)  max3(x, y, z)
 210
 211 /*
 212  * Return the absolute value of a number.
 213  *
 214  * This handles unsigned and signed longs, ints, shorts and chars.  For all
 215  * input types abs() returns a signed long.
 216  *
 217  * For 64-bit types, use abs64()
 218  */
 219 #define abs(x) ({                                               \
 220                 long ret;                                       \
 221                 if (sizeof(x) == sizeof(long)) {                \
 222                         long __x = (x);                         \
 223                         ret = (__x < 0) ? -__x : __x;           \
 224                 } else {                                        \
 225                         int __x = (x);                          \
 226                         ret = (__x < 0) ? -__x : __x;           \
 227                 }                                               \
 228                 ret;                                            \
 229         })
 230
 231 #define abs64(x) ({                             \
 232                 s64 __x = (x);                  \
 233                 (__x < 0) ? -__x : __x;         \
 234         })
 235
 236 #if defined(CONFIG_ENV_IS_EMBEDDED)
 237 #define TOTAL_MALLOC_LEN        CONFIG_SYS_MALLOC_LEN
 238 #elif ( ((CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) < CONFIG_SYS_MONITOR_BASE) || \
 239         (CONFIG_ENV_ADDR >= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) ) || \
 240       defined(CONFIG_ENV_IS_IN_NVRAM)
 241 #define TOTAL_MALLOC_LEN        (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
 242 #else
 243 #define TOTAL_MALLOC_LEN        CONFIG_SYS_MALLOC_LEN
 244 #endif
 245
 246 /**
 247  * container_of - cast a member of a structure out to the containing structure
 248  * @ptr:        the pointer to the member.
 249  * @type:       the type of the container struct this is embedded in.
 250  * @member:     the name of the member within the struct.
 251  *
 252  */
 253 #define container_of(ptr, type, member) ({                      \
 254         const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
 255         (type *)( (char *)__mptr - offsetof(type,member) );})
 256
 257 /*
 258  * Function Prototypes
 259  */
 260
 261 void    hang            (void) __attribute__ ((noreturn));
 262
 263 int     timer_init(void);
 264 int     cpu_init(void);
 265
 266 /* */
 267 phys_size_t initdram (int);
 268 int     display_options (void);
 269 void    print_size(unsigned long long, const char *);
 270 int print_buffer(ulong addr, const void *data, uint width, uint count,
 271                  uint linelen);
 272
 273 /* common/main.c */
 274 void    main_loop       (void);
 275 int run_command(const char *cmd, int flag);
 276
 277 /**
 278  * Run a list of commands separated by ; or even \0
 279  *
 280  * Note that if 'len' is not -1, then the command does not need to be nul
 281  * terminated, Memory will be allocated for the command in that case.
 282  *
 283  * @param cmd   List of commands to run, each separated bu semicolon
 284  * @param len   Length of commands excluding terminator if known (-1 if not)
 285  * @param flag  Execution flags (CMD_FLAG_...)
 286  * @return 0 on success, or != 0 on error.
 287  */
 288 int run_command_list(const char *cmd, int len, int flag);
 289 int     readline        (const char *const prompt);
 290 int     readline_into_buffer(const char *const prompt, char *buffer,
 291                         int timeout);
 292 int     parse_line (char *, char *[]);
 293 void    init_cmd_timeout(void);
 294 void    reset_cmd_timeout(void);
 295 extern char console_buffer[];
 296
 297 /* arch/$(ARCH)/lib/board.c */
 298 void    board_init_f(ulong);
 299 void    board_init_r  (gd_t *, ulong) __attribute__ ((noreturn));
 300 int     checkboard    (void);
 301 int     checkflash    (void);
 302 int     checkdram     (void);
 303 int     last_stage_init(void);
 304 extern ulong monitor_flash_len;
 305 int mac_read_from_eeprom(void);
 306 extern u8 __dtb_dt_begin[];     /* embedded device tree blob */
 307 int set_cpu_clk_info(void);
 308 #if defined(CONFIG_DISPLAY_CPUINFO)
 309 int print_cpuinfo(void);
 310 #else
 311 static inline int print_cpuinfo(void)
 312 {
 313         return 0;
 314 }
 315 #endif
 316 int update_flash_size(int flash_size);
 317 int arch_early_init_r(void);
 318
 319 /**
 320  * Show the DRAM size in a board-specific way
 321  *
 322  * This is used by boards to display DRAM information in their own way.
 323  *
 324  * @param size  Size of DRAM (which should be displayed along with other info)
 325  */
 326 void board_show_dram(ulong size);
 327
 328 /**
 329  * arch_fixup_memory_node() - Write arch-specific memory information to fdt
 330  *
 331  * Defined in arch/$(ARCH)/lib/bootm.c
 332  *
 333  * @blob:       FDT blob to write to
 334  * @return 0 if ok, or -ve FDT_ERR_... on failure
 335  */
 336 int arch_fixup_memory_node(void *blob);
 337
 338 /* common/flash.c */
 339 void flash_perror (int);
 340
 341 /* common/cmd_source.c */
 342 int     source (ulong addr, const char *fit_uname);
 343
 344 extern ulong load_addr;         /* Default Load Address */
 345 extern ulong save_addr;         /* Default Save Address */
 346 extern ulong save_size;         /* Default Save Size */
 347
 348 /* common/cmd_doc.c */
 349 void    doc_probe(unsigned long physadr);
 350
 351 /* common/cmd_net.c */
 352 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 353
 354 /* common/cmd_fat.c */
 355 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
 356
 357 /* common/cmd_ext2.c */
 358 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
 359
 360 /* common/cmd_nvedit.c */
 361 int     env_init     (void);
 362 void    env_relocate (void);
 363 int     envmatch     (uchar *, int);
 364
 365 /* Avoid unfortunate conflict with libc's getenv() */
 366 #ifdef CONFIG_SANDBOX
 367 #define getenv uboot_getenv
 368 #endif
 369 char    *getenv      (const char *);
 370 int     getenv_f     (const char *name, char *buf, unsigned len);
 371 ulong getenv_ulong(const char *name, int base, ulong default_val);
 372
 373 /**
 374  * getenv_hex() - Return an environment variable as a hex value
 375  *
 376  * Decode an environment as a hex number (it may or may not have a 0x
 377  * prefix). If the environment variable cannot be found, or does not start
 378  * with hex digits, the default value is returned.
 379  *
 380  * @varname:            Variable to decode
 381  * @default_val:        Value to return on error
 382  */
 383 ulong getenv_hex(const char *varname, ulong default_val);
 384
 385 /*
 386  * Read an environment variable as a boolean
 387  * Return -1 if variable does not exist (default to true)
 388  */
 389 int getenv_yesno(const char *var);
 390 int     saveenv      (void);
 391 int     setenv       (const char *, const char *);
 392 int setenv_ulong(const char *varname, ulong value);
 393 int setenv_hex(const char *varname, ulong value);
 394 /**
 395  * setenv_addr - Set an environment variable to an address in hex
 396  *
 397  * @varname:    Environment variable to set
 398  * @addr:       Value to set it to
 399  * @return 0 if ok, 1 on error
 400  */
 401 static inline int setenv_addr(const char *varname, const void *addr)
 402 {
 403         return setenv_hex(varname, (ulong)addr);
 404 }
 405
 406 #ifdef CONFIG_ARM
 407 # include <asm/mach-types.h>
 408 # include <asm/setup.h>
 409 # include <asm/u-boot-arm.h>    /* ARM version to be fixed! */
 410 #endif /* CONFIG_ARM */
 411 #ifdef CONFIG_X86               /* x86 version to be fixed! */
 412 # include <asm/u-boot-x86.h>
 413 #endif /* CONFIG_X86 */
 414 #ifdef CONFIG_SANDBOX
 415 # include <asm/u-boot-sandbox.h>        /* TODO(sjg) what needs to be fixed? */
 416 #endif
 417 #ifdef CONFIG_NDS32
 418 # include <asm/mach-types.h>
 419 # include <asm/setup.h>
 420 # include <asm/u-boot-nds32.h>
 421 #endif /* CONFIG_NDS32 */
 422 #ifdef CONFIG_MIPS
 423 # include <asm/u-boot-mips.h>
 424 #endif /* CONFIG_MIPS */
 425 #ifdef CONFIG_ARC
 426 # include <asm/u-boot-arc.h>
 427 #endif /* CONFIG_ARC */
 428
 429 #ifdef CONFIG_AUTO_COMPLETE
 430 int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
 431 #endif
 432 int get_env_id (void);
 433
 434 void    pci_init      (void);
 435 void    pci_init_board(void);
 436 void    pciinfo       (int, int);
 437
 438 #if defined(CONFIG_PCI) && defined(CONFIG_4xx)
 439     int    pci_pre_init        (struct pci_controller *);
 440     int    is_pci_host         (struct pci_controller *);
 441 #endif
 442
 443 #if defined(CONFIG_PCI) && (defined(CONFIG_440) || defined(CONFIG_405EX))
 444 #   if defined(CONFIG_SYS_PCI_TARGET_INIT)
 445         void    pci_target_init      (struct pci_controller *);
 446 #   endif
 447 #   if defined(CONFIG_SYS_PCI_MASTER_INIT)
 448         void    pci_master_init      (struct pci_controller *);
 449 #   endif
 450 #if defined(CONFIG_440SPE) || \
 451     defined(CONFIG_460EX) || defined(CONFIG_460GT) || \
 452     defined(CONFIG_405EX)
 453    void pcie_setup_hoses(int busno);
 454 #endif
 455 #endif
 456
 457 int     misc_init_f   (void);
 458 int     misc_init_r   (void);
 459
 460 /* common/exports.c */
 461 void    jumptable_init(void);
 462
 463 /* common/kallsysm.c */
 464 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
 465
 466 /* api/api.c */
 467 void    api_init (void);
 468
 469 /* common/memsize.c */
 470 long    get_ram_size  (long *, long);
 471 phys_size_t get_effective_memsize(void);
 472
 473 /* $(BOARD)/$(BOARD).c */
 474 void    reset_phy     (void);
 475 void    fdc_hw_init   (void);
 476
 477 /* $(BOARD)/eeprom.c */
 478 void eeprom_init  (void);
 479 #ifndef CONFIG_SPI
 480 int  eeprom_probe (unsigned dev_addr, unsigned offset);
 481 #endif
 482 int  eeprom_read  (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
 483 int  eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
 484 #ifdef CONFIG_LWMON
 485 extern uchar pic_read  (uchar reg);
 486 extern void  pic_write (uchar reg, uchar val);
 487 #endif
 488
 489 /*
 490  * Set this up regardless of board
 491  * type, to prevent errors.
 492  */
 493 #if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
 494 # define CONFIG_SYS_DEF_EEPROM_ADDR 0
 495 #else
 496 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
 497 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
 498 #endif
 499 #endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
 500
 501 #if defined(CONFIG_SPI)
 502 extern void spi_init_f (void);
 503 extern void spi_init_r (void);
 504 extern ssize_t spi_read  (uchar *, int, uchar *, int);
 505 extern ssize_t spi_write (uchar *, int, uchar *, int);
 506 #endif
 507
 508 #ifdef CONFIG_RPXCLASSIC
 509 void rpxclassic_init (void);
 510 #endif
 511
 512 void rpxlite_init (void);
 513
 514 #ifdef CONFIG_MBX
 515 /* $(BOARD)/mbx8xx.c */
 516 void    mbx_init (void);
 517 void    board_serial_init (void);
 518 void    board_ether_init (void);
 519 #endif
 520
 521 #ifdef CONFIG_HERMES
 522 /* $(BOARD)/hermes.c */
 523 void hermes_start_lxt980 (int speed);
 524 #endif
 525
 526 #ifdef CONFIG_EVB64260
 527 void  evb64260_init(void);
 528 void  debug_led(int, int);
 529 void  display_mem_map(void);
 530 void  perform_soft_reset(void);
 531 #endif
 532
 533 /* $(BOARD)/$(BOARD).c */
 534 int board_early_init_f (void);
 535 int board_late_init (void);
 536 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
 537 int board_early_init_r (void);
 538 void board_poweroff (void);
 539
 540 #if defined(CONFIG_SYS_DRAM_TEST)
 541 int testdram(void);
 542 #endif /* CONFIG_SYS_DRAM_TEST */
 543
 544 /* $(CPU)/start.S */
 545 #if defined(CONFIG_5xx) || \
 546     defined(CONFIG_8xx)
 547 uint    get_immr      (uint);
 548 #endif
 549 uint    get_pir       (void);
 550 #if defined(CONFIG_MPC5xxx)
 551 uint    get_svr       (void);
 552 #endif
 553 uint    get_pvr       (void);
 554 uint    get_svr       (void);
 555 uint    rd_ic_cst     (void);
 556 void    wr_ic_cst     (uint);
 557 void    wr_ic_adr     (uint);
 558 uint    rd_dc_cst     (void);
 559 void    wr_dc_cst     (uint);
 560 void    wr_dc_adr     (uint);
 561 int     icache_status (void);
 562 void    icache_enable (void);
 563 void    icache_disable(void);
 564 int     dcache_status (void);
 565 void    dcache_enable (void);
 566 void    dcache_disable(void);
 567 void    mmu_disable(void);
 568 #if defined(CONFIG_ARM)
 569 void    relocate_code(ulong);
 570 #else
 571 void    relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
 572 #endif
 573 ulong   get_endaddr   (void);
 574 void    trap_init     (ulong);
 575 #if defined (CONFIG_4xx)        || \
 576     defined (CONFIG_MPC5xxx)    || \
 577     defined (CONFIG_74xx_7xx)   || \
 578     defined (CONFIG_74x)        || \
 579     defined (CONFIG_75x)        || \
 580     defined (CONFIG_74xx)       || \
 581     defined (CONFIG_MPC85xx)    || \
 582     defined (CONFIG_MPC86xx)    || \
 583     defined (CONFIG_MPC83xx)
 584 unsigned char   in8(unsigned int);
 585 void            out8(unsigned int, unsigned char);
 586 unsigned short  in16(unsigned int);
 587 unsigned short  in16r(unsigned int);
 588 void            out16(unsigned int, unsigned short value);
 589 void            out16r(unsigned int, unsigned short value);
 590 unsigned long   in32(unsigned int);
 591 unsigned long   in32r(unsigned int);
 592 void            out32(unsigned int, unsigned long value);
 593 void            out32r(unsigned int, unsigned long value);
 594 void            ppcDcbf(unsigned long value);
 595 void            ppcDcbi(unsigned long value);
 596 void            ppcSync(void);
 597 void            ppcDcbz(unsigned long value);
 598 #endif
 599 #if defined (CONFIG_MICROBLAZE)
 600 unsigned short  in16(unsigned int);
 601 void            out16(unsigned int, unsigned short value);
 602 #endif
 603
 604 #if defined (CONFIG_MPC83xx)
 605 void            ppcDWload(unsigned int *addr, unsigned int *ret);
 606 void            ppcDWstore(unsigned int *addr, unsigned int *value);
 607 void disable_addr_trans(void);
 608 void enable_addr_trans(void);
 609 #if defined(CONFIG_DDR_ECC) && !defined(CONFIG_ECC_INIT_VIA_DDRCONTROLLER)
 610 void ddr_enable_ecc(unsigned int dram_size);
 611 #endif
 612 #endif
 613
 614 /*
 615  * Return the current value of a monotonically increasing microsecond timer.
 616  * Granularity may be larger than 1us if hardware does not support this.
 617  */
 618 ulong timer_get_us(void);
 619
 620 /* $(CPU)/cpu.c */
 621 static inline int cpumask_next(int cpu, unsigned int mask)
 622 {
 623         for (cpu++; !((1 << cpu) & mask); cpu++)
 624                 ;
 625
 626         return cpu;
 627 }
 628
 629 #define for_each_cpu(iter, cpu, num_cpus, mask) \
 630         for (iter = 0, cpu = cpumask_next(-1, mask); \
 631                 iter < num_cpus; \
 632                 iter++, cpu = cpumask_next(cpu, mask)) \
 633
 634 int     cpu_numcores  (void);
 635 u32     cpu_mask      (void);
 636 int     is_core_valid (unsigned int);
 637 int     probecpu      (void);
 638 int     checkcpu      (void);
 639 int     checkicache   (void);
 640 int     checkdcache   (void);
 641 void    upmconfig     (unsigned int, unsigned int *, unsigned int);
 642 ulong   get_tbclk     (void);
 643 void    reset_cpu     (ulong addr);
 644 #if defined (CONFIG_OF_LIBFDT) && defined (CONFIG_OF_BOARD_SETUP)
 645 void ft_cpu_setup(void *blob, bd_t *bd);
 646 #ifdef CONFIG_PCI
 647 void ft_pci_setup(void *blob, bd_t *bd);
 648 #endif
 649 #endif
 650
 651 void smp_set_core_boot_addr(unsigned long addr, int corenr);
 652 void smp_kick_all_cpus(void);
 653
 654 /* $(CPU)/serial.c */
 655 int     serial_init   (void);
 656 void    serial_setbrg (void);
 657 void    serial_putc   (const char);
 658 void    serial_putc_raw(const char);
 659 void    serial_puts   (const char *);
 660 int     serial_getc   (void);
 661 int     serial_tstc   (void);
 662
 663 void    _serial_setbrg (const int);
 664 void    _serial_putc   (const char, const int);
 665 void    _serial_putc_raw(const char, const int);
 666 void    _serial_puts   (const char *, const int);
 667 int     _serial_getc   (const int);
 668 int     _serial_tstc   (const int);
 669
 670 /* $(CPU)/speed.c */
 671 int     get_clocks (void);
 672 int     get_clocks_866 (void);
 673 int     sdram_adjust_866 (void);
 674 int     adjust_sdram_tbs_8xx (void);
 675 #if defined(CONFIG_MPC8260)
 676 int     prt_8260_clks (void);
 677 #elif defined(CONFIG_MPC5xxx)
 678 int     prt_mpc5xxx_clks (void);
 679 #endif
 680 #ifdef CONFIG_4xx
 681 ulong   get_OPB_freq (void);
 682 ulong   get_PCI_freq (void);
 683 #endif
 684 #if defined(CONFIG_S3C24X0) || \
 685     defined(CONFIG_LH7A40X) || \
 686     defined(CONFIG_EP93XX)
 687 ulong   get_FCLK (void);
 688 ulong   get_HCLK (void);
 689 ulong   get_PCLK (void);
 690 ulong   get_UCLK (void);
 691 #endif
 692 #if defined(CONFIG_LH7A40X)
 693 ulong   get_PLLCLK (void);
 694 #endif
 695 #if defined CONFIG_INCA_IP
 696 uint    incaip_get_cpuclk (void);
 697 #endif
 698 #if defined(CONFIG_IMX)
 699 ulong get_systemPLLCLK(void);
 700 ulong get_FCLK(void);
 701 ulong get_HCLK(void);
 702 ulong get_BCLK(void);
 703 ulong get_PERCLK1(void);
 704 ulong get_PERCLK2(void);
 705 ulong get_PERCLK3(void);
 706 #endif
 707 ulong   get_bus_freq  (ulong);
 708 int get_serial_clock(void);
 709
 710 #if defined(CONFIG_MPC83xx) || defined(CONFIG_MPC85xx)
 711 ulong get_ddr_freq(ulong);
 712 #endif
 713 #if defined(CONFIG_MPC85xx)
 714 typedef MPC85xx_SYS_INFO sys_info_t;
 715 void    get_sys_info  ( sys_info_t * );
 716 #  if defined(CONFIG_OF_LIBFDT)
 717         void ft_fixup_cpu(void *, u64);
 718         void ft_fixup_num_cores(void *);
 719 #  endif
 720 #endif
 721 #if defined(CONFIG_MPC86xx)
 722 typedef MPC86xx_SYS_INFO sys_info_t;
 723 void   get_sys_info  ( sys_info_t * );
 724 static inline ulong get_ddr_freq(ulong dummy)
 725 {
 726         return get_bus_freq(dummy);
 727 }
 728 #endif
 729
 730 #if defined(CONFIG_4xx)
 731 #  if defined(CONFIG_440)
 732 #       if defined(CONFIG_440SPE)
 733          unsigned long determine_sysper(void);
 734          unsigned long determine_pci_clock_per(void);
 735 #       endif
 736 #  endif
 737 typedef PPC4xx_SYS_INFO sys_info_t;
 738 int     ppc440spe_revB(void);
 739 void    get_sys_info  ( sys_info_t * );
 740 #endif
 741
 742 /* $(CPU)/cpu_init.c */
 743 #if defined(CONFIG_8xx) || defined(CONFIG_MPC8260)
 744 void    cpu_init_f    (volatile immap_t *immr);
 745 #endif
 746 #if defined(CONFIG_4xx) || defined(CONFIG_MPC85xx) || defined(CONFIG_MCF52x2) ||defined(CONFIG_MPC86xx)
 747 void    cpu_init_f    (void);
 748 #endif
 749
 750 int     cpu_init_r    (void);
 751 #if defined(CONFIG_MPC8260)
 752 int     prt_8260_rsr  (void);
 753 #elif defined(CONFIG_MPC83xx)
 754 int     prt_83xx_rsr  (void);
 755 #endif
 756
 757 /* $(CPU)/interrupts.c */
 758 int     interrupt_init     (void);
 759 void    timer_interrupt    (struct pt_regs *);
 760 void    external_interrupt (struct pt_regs *);
 761 void    irq_install_handler(int, interrupt_handler_t *, void *);
 762 void    irq_free_handler   (int);
 763 void    reset_timer        (void);
 764 ulong   get_timer          (ulong base);
 765
 766 /* Return value of monotonic microsecond timer */
 767 unsigned long timer_get_us(void);
 768
 769 void    enable_interrupts  (void);
 770 int     disable_interrupts (void);
 771
 772 /* $(CPU)/.../commproc.c */
 773 int     dpram_init (void);
 774 uint    dpram_base(void);
 775 uint    dpram_base_align(uint align);
 776 uint    dpram_alloc(uint size);
 777 uint    dpram_alloc_align(uint size,uint align);
 778 void    bootcount_store (ulong);
 779 ulong   bootcount_load (void);
 780 #define BOOTCOUNT_MAGIC         0xB001C041
 781
 782 /* $(CPU)/.../<eth> */
 783 void mii_init (void);
 784
 785 /* $(CPU)/.../lcd.c */
 786 ulong   lcd_setmem (ulong);
 787
 788 /* $(CPU)/.../video.c */
 789 ulong   video_setmem (ulong);
 790
 791 /* arch/$(ARCH)/lib/cache.c */
 792 void    enable_caches(void);
 793 void    flush_cache   (unsigned long, unsigned long);
 794 void    flush_dcache_all(void);
 795 void    flush_dcache_range(unsigned long start, unsigned long stop);
 796 void    invalidate_dcache_range(unsigned long start, unsigned long stop);
 797 void    invalidate_dcache_all(void);
 798 void    invalidate_icache_all(void);
 799
 800 /* arch/$(ARCH)/lib/ticks.S */
 801 unsigned long long get_ticks(void);
 802 void    wait_ticks    (unsigned long);
 803
 804 /* arch/$(ARCH)/lib/time.c */
 805 void    __udelay      (unsigned long);
 806 ulong   usec2ticks    (unsigned long usec);
 807 ulong   ticks2usec    (unsigned long ticks);
 808 int     init_timebase (void);
 809
 810 /* lib/gunzip.c */
 811 int gunzip(void *, int, unsigned char *, unsigned long *);
 812 int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
 813                                                 int stoponerr, int offset);
 814
 815 /* lib/qsort.c */
 816 void qsort(void *base, size_t nmemb, size_t size,
 817            int(*compar)(const void *, const void *));
 818 int strcmp_compar(const void *, const void *);
 819
 820 /* lib/time.c */
 821 void    udelay        (unsigned long);
 822 void mdelay(unsigned long);
 823
 824 /* lib/uuid.c */
 825 void uuid_str_to_bin(const char *uuid, unsigned char *out);
 826 int uuid_str_valid(const char *uuid);
 827
 828 /* lib/vsprintf.c */
 829 #include <vsprintf.h>
 830
 831 /* lib/strmhz.c */
 832 char *  strmhz(char *buf, unsigned long hz);
 833
 834 /* lib/crc32.c */
 835 #include <u-boot/crc.h>
 836
 837 /* lib/rand.c */
 838 #if defined(CONFIG_RANDOM_MACADDR) || \
 839         defined(CONFIG_BOOTP_RANDOM_DELAY) || \
 840         defined(CONFIG_CMD_LINK_LOCAL)
 841 #define RAND_MAX -1U
 842 void srand(unsigned int seed);
 843 unsigned int rand(void);
 844 unsigned int rand_r(unsigned int *seedp);
 845 #endif
 846
 847 /* common/console.c */
 848 int     console_init_f(void);   /* Before relocation; uses the serial  stuff    */
 849 int     console_init_r(void);   /* After  relocation; uses the console stuff    */
 850 int     console_assign(int file, const char *devname);  /* Assign the console   */
 851 int     ctrlc (void);
 852 int     had_ctrlc (void);       /* have we had a Control-C since last clear? */
 853 void    clear_ctrlc (void);     /* clear the Control-C condition */
 854 int     disable_ctrlc (int);    /* 1 to disable, 0 to enable Control-C detect */
 855
 856 /*
 857  * STDIO based functions (can always be used)
 858  */
 859 /* serial stuff */
 860 int     serial_printf (const char *fmt, ...)
 861                 __attribute__ ((format (__printf__, 1, 2)));
 862 /* stdin */
 863 int     getc(void);
 864 int     tstc(void);
 865
 866 /* stdout */
 867 void    putc(const char c);
 868 void    puts(const char *s);
 869 int     printf(const char *fmt, ...)
 870                 __attribute__ ((format (__printf__, 1, 2)));
 871 int     vprintf(const char *fmt, va_list args);
 872
 873 /* stderr */
 874 #define eputc(c)                fputc(stderr, c)
 875 #define eputs(s)                fputs(stderr, s)
 876 #define eprintf(fmt,args...)    fprintf(stderr,fmt ,##args)
 877
 878 /*
 879  * FILE based functions (can only be used AFTER relocation!)
 880  */
 881 #define stdin           0
 882 #define stdout          1
 883 #define stderr          2
 884 #define MAX_FILES       3
 885
 886 int     fprintf(int file, const char *fmt, ...)
 887                 __attribute__ ((format (__printf__, 2, 3)));
 888 void    fputs(int file, const char *s);
 889 void    fputc(int file, const char c);
 890 int     ftstc(int file);
 891 int     fgetc(int file);
 892
 893 /* lib/gzip.c */
 894 int gzip(void *dst, unsigned long *lenp,
 895                 unsigned char *src, unsigned long srclen);
 896 int zzip(void *dst, unsigned long *lenp, unsigned char *src,
 897                 unsigned long srclen, int stoponerr,
 898                 int (*func)(unsigned long, unsigned long));
 899
 900 /* lib/net_utils.c */
 901 #include <net.h>
 902 static inline IPaddr_t getenv_IPaddr(char *var)
 903 {
 904         return string_to_ip(getenv(var));
 905 }
 906
 907 /*
 908  * CONSOLE multiplexing.
 909  */
 910 #ifdef CONFIG_CONSOLE_MUX
 911 #include <iomux.h>
 912 #endif
 913
 914 int     pcmcia_init (void);
 915
 916 #ifdef CONFIG_STATUS_LED
 917 # include <status_led.h>
 918 #endif
 919
 920 #include <bootstage.h>
 921
 922 #ifdef CONFIG_SHOW_ACTIVITY
 923 void show_activity(int arg);
 924 #endif
 925
 926 /* Multicore arch functions */
 927 #ifdef CONFIG_MP
 928 int cpu_status(int nr);
 929 int cpu_reset(int nr);
 930 int cpu_disable(int nr);
 931 int cpu_release(int nr, int argc, char * const argv[]);
 932 #endif
 933
 934 /* Define a null map_sysmem() if the architecture doesn't use it */
 935 # ifndef CONFIG_ARCH_MAP_SYSMEM
 936 static inline void *map_sysmem(phys_addr_t paddr, unsigned long len)
 937 {
 938         return (void *)(uintptr_t)paddr;
 939 }
 940
 941 static inline void unmap_sysmem(const void *vaddr)
 942 {
 943 }
 944
 945 static inline phys_addr_t map_to_sysmem(const void *ptr)
 946 {
 947         return (phys_addr_t)(uintptr_t)ptr;
 948 }
 949 # endif
 950
 951 #endif /* __ASSEMBLY__ */
 952
 953 #ifdef CONFIG_PPC
 954 /*
 955  * Has to be included outside of the #ifndef __ASSEMBLY__ section.
 956  * Otherwise might lead to compilation errors in assembler files.
 957  */
 958 #include <asm/cache.h>
 959 #endif
 960
 961 /* Put only stuff here that the assembler can digest */
 962
 963 #ifdef CONFIG_POST
 964 #define CONFIG_HAS_POST
 965 #ifndef CONFIG_POST_ALT_LIST
 966 #define CONFIG_POST_STD_LIST
 967 #endif
 968 #endif
 969
 970 #ifdef CONFIG_INIT_CRITICAL
 971 #error CONFIG_INIT_CRITICAL is deprecated!
 972 #error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
 973 #endif
 974
 975 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
 976
 977 #define ROUND(a,b)              (((a) + (b) - 1) & ~((b) - 1))
 978 #define DIV_ROUND(n,d)          (((n) + ((d)/2)) / (d))
 979 #define DIV_ROUND_UP(n,d)       (((n) + (d) - 1) / (d))
 980 #define roundup(x, y)           ((((x) + ((y) - 1)) / (y)) * (y))
 981
 982 /*
 983  * Divide positive or negative dividend by positive divisor and round
 984  * to closest integer. Result is undefined for negative divisors and
 985  * for negative dividends if the divisor variable type is unsigned.
 986  */
 987 #define DIV_ROUND_CLOSEST(x, divisor)(                  \
 988 {                                                       \
 989         typeof(x) __x = x;                              \
 990         typeof(divisor) __d = divisor;                  \
 991         (((typeof(x))-1) > 0 ||                         \
 992          ((typeof(divisor))-1) > 0 || (__x) > 0) ?      \
 993                 (((__x) + ((__d) / 2)) / (__d)) :       \
 994                 (((__x) - ((__d) / 2)) / (__d));        \
 995 }                                                       \
 996 )
 997
 998 #define ALIGN(x,a)              __ALIGN_MASK((x),(typeof(x))(a)-1)
 999 #define __ALIGN_MASK(x,mask)    (((x)+(mask))&~(mask))
1000
1001 /*
1002  * ARCH_DMA_MINALIGN is defined in asm/cache.h for each architecture.  It
1003  * is used to align DMA buffers.
1004  */
1005 #ifndef __ASSEMBLY__
1006 #include <asm/cache.h>
1007 #endif
1008
1009 /*
1010  * The ALLOC_CACHE_ALIGN_BUFFER macro is used to allocate a buffer on the
1011  * stack that meets the minimum architecture alignment requirements for DMA.
1012  * Such a buffer is useful for DMA operations where flushing and invalidating
1013  * the cache before and after a read and/or write operation is required for
1014  * correct operations.
1015  *
1016  * When called the macro creates an array on the stack that is sized such
1017  * that:
1018  *
1019  * 1) The beginning of the array can be advanced enough to be aligned.
1020  *
1021  * 2) The size of the aligned portion of the array is a multiple of the minimum
1022  *    architecture alignment required for DMA.
1023  *
1024  * 3) The aligned portion contains enough space for the original number of
1025  *    elements requested.
1026  *
1027  * The macro then creates a pointer to the aligned portion of this array and
1028  * assigns to the pointer the address of the first element in the aligned
1029  * portion of the array.
1030  *
1031  * Calling the macro as:
1032  *
1033  *     ALLOC_CACHE_ALIGN_BUFFER(uint32_t, buffer, 1024);
1034  *
1035  * Will result in something similar to saying:
1036  *
1037  *     uint32_t    buffer[1024];
1038  *
1039  * The following differences exist:
1040  *
1041  * 1) The resulting buffer is guaranteed to be aligned to the value of
1042  *    ARCH_DMA_MINALIGN.
1043  *
1044  * 2) The buffer variable created by the macro is a pointer to the specified
1045  *    type, and NOT an array of the specified type.  This can be very important
1046  *    if you want the address of the buffer, which you probably do, to pass it
1047  *    to the DMA hardware.  The value of &buffer is different in the two cases.
1048  *    In the macro case it will be the address of the pointer, not the address
1049  *    of the space reserved for the buffer.  However, in the second case it
1050  *    would be the address of the buffer.  So if you are replacing hard coded
1051  *    stack buffers with this macro you need to make sure you remove the & from
1052  *    the locations where you are taking the address of the buffer.
1053  *
1054  * Note that the size parameter is the number of array elements to allocate,
1055  * not the number of bytes.
1056  *
1057  * This macro can not be used outside of function scope, or for the creation
1058  * of a function scoped static buffer.  It can not be used to create a cache
1059  * line aligned global buffer.
1060  */
1061 #define PAD_COUNT(s, pad) (((s) - 1) / (pad) + 1)
1062 #define PAD_SIZE(s, pad) (PAD_COUNT(s, pad) * pad)
1063 #define ALLOC_ALIGN_BUFFER_PAD(type, name, size, align, pad)            \
1064         char __##name[ROUND(PAD_SIZE((size) * sizeof(type), pad), align)  \
1065                       + (align - 1)];                                   \
1066                                                                         \
1067         type *name = (type *) ALIGN((uintptr_t)__##name, align)
1068 #define ALLOC_ALIGN_BUFFER(type, name, size, align)             \
1069         ALLOC_ALIGN_BUFFER_PAD(type, name, size, align, 1)
1070 #define ALLOC_CACHE_ALIGN_BUFFER_PAD(type, name, size, pad)             \
1071         ALLOC_ALIGN_BUFFER_PAD(type, name, size, ARCH_DMA_MINALIGN, pad)
1072 #define ALLOC_CACHE_ALIGN_BUFFER(type, name, size)                      \
1073         ALLOC_ALIGN_BUFFER(type, name, size, ARCH_DMA_MINALIGN)
1074
1075 /*
1076  * DEFINE_CACHE_ALIGN_BUFFER() is similar to ALLOC_CACHE_ALIGN_BUFFER, but it's
1077  * purpose is to allow allocating aligned buffers outside of function scope.
1078  * Usage of this macro shall be avoided or used with extreme care!
1079  */
1080 #define DEFINE_ALIGN_BUFFER(type, name, size, align)                    \
1081         static char __##name[roundup(size * sizeof(type), align)]       \
1082                         __aligned(align);                               \
1083                                                                         \
1084         static type *name = (type *)__##name
1085 #define DEFINE_CACHE_ALIGN_BUFFER(type, name, size)                     \
1086         DEFINE_ALIGN_BUFFER(type, name, size, ARCH_DMA_MINALIGN)
1087
1088 /* Pull in stuff for the build system */
1089 #ifdef DO_DEPS_ONLY
1090 # include <environment.h>
1091 #endif
1092
1093 #endif  /* __COMMON_H_ */