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