include/common.h

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