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