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 /* common/flash.c */
 344 void flash_perror (int);
 345
 346 /* common/cmd_source.c */
 347 int     source (ulong addr, const char *fit_uname);
 348
 349 extern ulong load_addr;         /* Default Load Address */
 350 extern ulong save_addr;         /* Default Save Address */
 351 extern ulong save_size;         /* Default Save Size */
 352
 353 /* common/cmd_doc.c */
 354 void    doc_probe(unsigned long physadr);
 355
 356 /* common/cmd_net.c */
 357 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 358
 359 /* common/cmd_fat.c */
 360 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
 361
 362 /* common/cmd_ext2.c */
 363 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
 364
 365 /* common/cmd_nvedit.c */
 366 int     env_init     (void);
 367 void    env_relocate (void);
 368 int     envmatch     (uchar *, int);
 369 char    *getenv      (const char *);
 370 int     getenv_f     (const char *name, char *buf, unsigned len);
 371 ulong getenv_ulong(const char *name, int base, ulong default_val);
 372
 373 /**
 374  * getenv_hex() - Return an environment variable as a hex value
 375  *
 376  * Decode an environment as a hex number (it may or may not have a 0x
 377  * prefix). If the environment variable cannot be found, or does not start
 378  * with hex digits, the default value is returned.
 379  *
 380  * @varname:            Variable to decode
 381  * @default_val:        Value to return on error
 382  */
 383 ulong getenv_hex(const char *varname, ulong default_val);
 384
 385 /*
 386  * Read an environment variable as a boolean
 387  * Return -1 if variable does not exist (default to true)
 388  */
 389 int getenv_yesno(const char *var);
 390 int     saveenv      (void);
 391 int     setenv       (const char *, const char *);
 392 int setenv_ulong(const char *varname, ulong value);
 393 int setenv_hex(const char *varname, ulong value);
 394 /**
 395  * setenv_addr - Set an environment variable to an address in hex
 396  *
 397  * @varname:    Environmet variable to set
 398  * @addr:       Value to set it to
 399  * @return 0 if ok, 1 on error
 400  */
 401 static inline int setenv_addr(const char *varname, const void *addr)
 402 {
 403         return setenv_hex(varname, (ulong)addr);
 404 }
 405
 406 #ifdef CONFIG_ARM
 407 # include <asm/mach-types.h>
 408 # include <asm/setup.h>
 409 # include <asm/u-boot-arm.h>    /* ARM version to be fixed! */
 410 #endif /* CONFIG_ARM */
 411 #ifdef CONFIG_X86               /* x86 version to be fixed! */
 412 # include <asm/u-boot-x86.h>
 413 #endif /* CONFIG_X86 */
 414 #ifdef CONFIG_SANDBOX
 415 # include <asm/u-boot-sandbox.h>        /* TODO(sjg) what needs to be fixed? */
 416 #endif
 417 #ifdef CONFIG_NDS32
 418 # include <asm/mach-types.h>
 419 # include <asm/u-boot-nds32.h>
 420 #endif /* CONFIG_NDS32 */
 421 #ifdef CONFIG_MIPS
 422 # include <asm/u-boot-mips.h>
 423 #endif /* CONFIG_MIPS */
 424
 425 #ifdef CONFIG_AUTO_COMPLETE
 426 int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
 427 #endif
 428 int get_env_id (void);
 429
 430 void    pci_init      (void);
 431 void    pci_init_board(void);
 432 void    pciinfo       (int, int);
 433
 434 #if defined(CONFIG_PCI) && defined(CONFIG_4xx)
 435     int    pci_pre_init        (struct pci_controller *);
 436     int    is_pci_host         (struct pci_controller *);
 437 #endif
 438
 439 #if defined(CONFIG_PCI) && (defined(CONFIG_440) || defined(CONFIG_405EX))
 440 #   if defined(CONFIG_SYS_PCI_TARGET_INIT)
 441         void    pci_target_init      (struct pci_controller *);
 442 #   endif
 443 #   if defined(CONFIG_SYS_PCI_MASTER_INIT)
 444         void    pci_master_init      (struct pci_controller *);
 445 #   endif
 446 #if defined(CONFIG_440SPE) || \
 447     defined(CONFIG_460EX) || defined(CONFIG_460GT) || \
 448     defined(CONFIG_405EX)
 449    void pcie_setup_hoses(int busno);
 450 #endif
 451 #endif
 452
 453 int     misc_init_f   (void);
 454 int     misc_init_r   (void);
 455
 456 /* common/exports.c */
 457 void    jumptable_init(void);
 458
 459 /* common/kallsysm.c */
 460 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
 461
 462 /* api/api.c */
 463 void    api_init (void);
 464
 465 /* common/memsize.c */
 466 long    get_ram_size  (long *, long);
 467
 468 /* $(BOARD)/$(BOARD).c */
 469 void    reset_phy     (void);
 470 void    fdc_hw_init   (void);
 471
 472 /* $(BOARD)/eeprom.c */
 473 void eeprom_init  (void);
 474 #ifndef CONFIG_SPI
 475 int  eeprom_probe (unsigned dev_addr, unsigned offset);
 476 #endif
 477 int  eeprom_read  (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
 478 int  eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
 479 #ifdef CONFIG_LWMON
 480 extern uchar pic_read  (uchar reg);
 481 extern void  pic_write (uchar reg, uchar val);
 482 #endif
 483
 484 /*
 485  * Set this up regardless of board
 486  * type, to prevent errors.
 487  */
 488 #if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
 489 # define CONFIG_SYS_DEF_EEPROM_ADDR 0
 490 #else
 491 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
 492 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
 493 #endif
 494 #endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
 495
 496 #if defined(CONFIG_SPI)
 497 extern void spi_init_f (void);
 498 extern void spi_init_r (void);
 499 extern ssize_t spi_read  (uchar *, int, uchar *, int);
 500 extern ssize_t spi_write (uchar *, int, uchar *, int);
 501 #endif
 502
 503 #ifdef CONFIG_RPXCLASSIC
 504 void rpxclassic_init (void);
 505 #endif
 506
 507 void rpxlite_init (void);
 508
 509 #ifdef CONFIG_MBX
 510 /* $(BOARD)/mbx8xx.c */
 511 void    mbx_init (void);
 512 void    board_serial_init (void);
 513 void    board_ether_init (void);
 514 #endif
 515
 516 #ifdef CONFIG_HERMES
 517 /* $(BOARD)/hermes.c */
 518 void hermes_start_lxt980 (int speed);
 519 #endif
 520
 521 #ifdef CONFIG_EVB64260
 522 void  evb64260_init(void);
 523 void  debug_led(int, int);
 524 void  display_mem_map(void);
 525 void  perform_soft_reset(void);
 526 #endif
 527
 528 /* $(BOARD)/$(BOARD).c */
 529 int board_early_init_f (void);
 530 int board_late_init (void);
 531 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
 532 int board_early_init_r (void);
 533 void board_poweroff (void);
 534
 535 #if defined(CONFIG_SYS_DRAM_TEST)
 536 int testdram(void);
 537 #endif /* CONFIG_SYS_DRAM_TEST */
 538
 539 /* $(CPU)/start.S */
 540 #if defined(CONFIG_5xx) || \
 541     defined(CONFIG_8xx)
 542 uint    get_immr      (uint);
 543 #endif
 544 uint    get_pir       (void);
 545 #if defined(CONFIG_MPC5xxx)
 546 uint    get_svr       (void);
 547 #endif
 548 uint    get_pvr       (void);
 549 uint    get_svr       (void);
 550 uint    rd_ic_cst     (void);
 551 void    wr_ic_cst     (uint);
 552 void    wr_ic_adr     (uint);
 553 uint    rd_dc_cst     (void);
 554 void    wr_dc_cst     (uint);
 555 void    wr_dc_adr     (uint);
 556 int     icache_status (void);
 557 void    icache_enable (void);
 558 void    icache_disable(void);
 559 int     dcache_status (void);
 560 void    dcache_enable (void);
 561 void    dcache_disable(void);
 562 void    mmu_disable(void);
 563 #if defined(CONFIG_ARM)
 564 void    relocate_code(ulong);
 565 #else
 566 void    relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
 567 #endif
 568 ulong   get_endaddr   (void);
 569 void    trap_init     (ulong);
 570 #if defined (CONFIG_4xx)        || \
 571     defined (CONFIG_MPC5xxx)    || \
 572     defined (CONFIG_74xx_7xx)   || \
 573     defined (CONFIG_74x)        || \
 574     defined (CONFIG_75x)        || \
 575     defined (CONFIG_74xx)       || \
 576     defined (CONFIG_MPC8220)    || \
 577     defined (CONFIG_MPC85xx)    || \
 578     defined (CONFIG_MPC86xx)    || \
 579     defined (CONFIG_MPC83xx)
 580 unsigned char   in8(unsigned int);
 581 void            out8(unsigned int, unsigned char);
 582 unsigned short  in16(unsigned int);
 583 unsigned short  in16r(unsigned int);
 584 void            out16(unsigned int, unsigned short value);
 585 void            out16r(unsigned int, unsigned short value);
 586 unsigned long   in32(unsigned int);
 587 unsigned long   in32r(unsigned int);
 588 void            out32(unsigned int, unsigned long value);
 589 void            out32r(unsigned int, unsigned long value);
 590 void            ppcDcbf(unsigned long value);
 591 void            ppcDcbi(unsigned long value);
 592 void            ppcSync(void);
 593 void            ppcDcbz(unsigned long value);
 594 #endif
 595 #if defined (CONFIG_MICROBLAZE)
 596 unsigned short  in16(unsigned int);
 597 void            out16(unsigned int, unsigned short value);
 598 #endif
 599
 600 #if defined (CONFIG_MPC83xx)
 601 void            ppcDWload(unsigned int *addr, unsigned int *ret);
 602 void            ppcDWstore(unsigned int *addr, unsigned int *value);
 603 void disable_addr_trans(void);
 604 void enable_addr_trans(void);
 605 #if defined(CONFIG_DDR_ECC) && !defined(CONFIG_ECC_INIT_VIA_DDRCONTROLLER)
 606 void ddr_enable_ecc(unsigned int dram_size);
 607 #endif
 608 #endif
 609
 610 /* $(CPU)/cpu.c */
 611 static inline int cpumask_next(int cpu, unsigned int mask)
 612 {
 613         for (cpu++; !((1 << cpu) & mask); cpu++)
 614                 ;
 615
 616         return cpu;
 617 }
 618
 619 #define for_each_cpu(iter, cpu, num_cpus, mask) \
 620         for (iter = 0, cpu = cpumask_next(-1, mask); \
 621                 iter < num_cpus; \
 622                 iter++, cpu = cpumask_next(cpu, mask)) \
 623
 624 int     cpu_numcores  (void);
 625 u32     cpu_mask      (void);
 626 int     is_core_valid (unsigned int);
 627 int     probecpu      (void);
 628 int     checkcpu      (void);
 629 int     checkicache   (void);
 630 int     checkdcache   (void);
 631 void    upmconfig     (unsigned int, unsigned int *, unsigned int);
 632 ulong   get_tbclk     (void);
 633 void    reset_cpu     (ulong addr);
 634 #if defined (CONFIG_OF_LIBFDT) && defined (CONFIG_OF_BOARD_SETUP)
 635 void ft_cpu_setup(void *blob, bd_t *bd);
 636 #ifdef CONFIG_PCI
 637 void ft_pci_setup(void *blob, bd_t *bd);
 638 #endif
 639 #endif
 640
 641
 642 /* $(CPU)/serial.c */
 643 int     serial_init   (void);
 644 void    serial_setbrg (void);
 645 void    serial_putc   (const char);
 646 void    serial_putc_raw(const char);
 647 void    serial_puts   (const char *);
 648 int     serial_getc   (void);
 649 int     serial_tstc   (void);
 650
 651 void    _serial_setbrg (const int);
 652 void    _serial_putc   (const char, const int);
 653 void    _serial_putc_raw(const char, const int);
 654 void    _serial_puts   (const char *, const int);
 655 int     _serial_getc   (const int);
 656 int     _serial_tstc   (const int);
 657
 658 /* $(CPU)/speed.c */
 659 int     get_clocks (void);
 660 int     get_clocks_866 (void);
 661 int     sdram_adjust_866 (void);
 662 int     adjust_sdram_tbs_8xx (void);
 663 #if defined(CONFIG_8260)
 664 int     prt_8260_clks (void);
 665 #elif defined(CONFIG_MPC5xxx)
 666 int     prt_mpc5xxx_clks (void);
 667 #endif
 668 #if defined(CONFIG_MPC8220)
 669 int     prt_mpc8220_clks (void);
 670 #endif
 671 #ifdef CONFIG_4xx
 672 ulong   get_OPB_freq (void);
 673 ulong   get_PCI_freq (void);
 674 #endif
 675 #if defined(CONFIG_S3C24X0) || \
 676     defined(CONFIG_LH7A40X) || \
 677     defined(CONFIG_EP93XX)
 678 ulong   get_FCLK (void);
 679 ulong   get_HCLK (void);
 680 ulong   get_PCLK (void);
 681 ulong   get_UCLK (void);
 682 #endif
 683 #if defined(CONFIG_LH7A40X)
 684 ulong   get_PLLCLK (void);
 685 #endif
 686 #if defined CONFIG_INCA_IP
 687 uint    incaip_get_cpuclk (void);
 688 #endif
 689 #if defined(CONFIG_IMX)
 690 ulong get_systemPLLCLK(void);
 691 ulong get_FCLK(void);
 692 ulong get_HCLK(void);
 693 ulong get_BCLK(void);
 694 ulong get_PERCLK1(void);
 695 ulong get_PERCLK2(void);
 696 ulong get_PERCLK3(void);
 697 #endif
 698 ulong   get_bus_freq  (ulong);
 699 int get_serial_clock(void);
 700
 701 #if defined(CONFIG_MPC83xx) || defined(CONFIG_MPC85xx)
 702 ulong get_ddr_freq(ulong);
 703 #endif
 704 #if defined(CONFIG_MPC85xx)
 705 typedef MPC85xx_SYS_INFO sys_info_t;
 706 void    get_sys_info  ( sys_info_t * );
 707 #endif
 708 #if defined(CONFIG_MPC86xx)
 709 typedef MPC86xx_SYS_INFO sys_info_t;
 710 void   get_sys_info  ( sys_info_t * );
 711 static inline ulong get_ddr_freq(ulong dummy)
 712 {
 713         return get_bus_freq(dummy);
 714 }
 715 #endif
 716
 717 #if defined(CONFIG_4xx)
 718 #  if defined(CONFIG_440)
 719 #       if defined(CONFIG_440SPE)
 720          unsigned long determine_sysper(void);
 721          unsigned long determine_pci_clock_per(void);
 722 #       endif
 723 #  endif
 724 typedef PPC4xx_SYS_INFO sys_info_t;
 725 int     ppc440spe_revB(void);
 726 void    get_sys_info  ( sys_info_t * );
 727 #endif
 728
 729 /* $(CPU)/cpu_init.c */
 730 #if defined(CONFIG_8xx) || defined(CONFIG_8260)
 731 void    cpu_init_f    (volatile immap_t *immr);
 732 #endif
 733 #if defined(CONFIG_4xx) || defined(CONFIG_MPC85xx) || defined(CONFIG_MCF52x2) ||defined(CONFIG_MPC86xx)
 734 void    cpu_init_f    (void);
 735 #endif
 736
 737 int     cpu_init_r    (void);
 738 #if defined(CONFIG_8260)
 739 int     prt_8260_rsr  (void);
 740 #elif defined(CONFIG_MPC83xx)
 741 int     prt_83xx_rsr  (void);
 742 #endif
 743
 744 /* $(CPU)/interrupts.c */
 745 int     interrupt_init     (void);
 746 void    timer_interrupt    (struct pt_regs *);
 747 void    external_interrupt (struct pt_regs *);
 748 void    irq_install_handler(int, interrupt_handler_t *, void *);
 749 void    irq_free_handler   (int);
 750 void    reset_timer        (void);
 751 ulong   get_timer          (ulong base);
 752 void    enable_interrupts  (void);
 753 int     disable_interrupts (void);
 754
 755 /* $(CPU)/.../commproc.c */
 756 int     dpram_init (void);
 757 uint    dpram_base(void);
 758 uint    dpram_base_align(uint align);
 759 uint    dpram_alloc(uint size);
 760 uint    dpram_alloc_align(uint size,uint align);
 761 void    bootcount_store (ulong);
 762 ulong   bootcount_load (void);
 763 #define BOOTCOUNT_MAGIC         0xB001C041
 764
 765 /* $(CPU)/.../<eth> */
 766 void mii_init (void);
 767
 768 /* $(CPU)/.../lcd.c */
 769 ulong   lcd_setmem (ulong);
 770
 771 /* $(CPU)/.../video.c */
 772 ulong   video_setmem (ulong);
 773
 774 /* arch/$(ARCH)/lib/cache.c */
 775 void    enable_caches(void);
 776 void    flush_cache   (unsigned long, unsigned long);
 777 void    flush_dcache_all(void);
 778 void    flush_dcache_range(unsigned long start, unsigned long stop);
 779 void    invalidate_dcache_range(unsigned long start, unsigned long stop);
 780 void    invalidate_dcache_all(void);
 781 void    invalidate_icache_all(void);
 782
 783 /* arch/$(ARCH)/lib/ticks.S */
 784 unsigned long long get_ticks(void);
 785 void    wait_ticks    (unsigned long);
 786
 787 /* arch/$(ARCH)/lib/time.c */
 788 void    __udelay      (unsigned long);
 789 ulong   usec2ticks    (unsigned long usec);
 790 ulong   ticks2usec    (unsigned long ticks);
 791 int     init_timebase (void);
 792
 793 /* lib/gunzip.c */
 794 int gunzip(void *, int, unsigned char *, unsigned long *);
 795 int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
 796                                                 int stoponerr, int offset);
 797
 798 /* lib/qsort.c */
 799 void qsort(void *base, size_t nmemb, size_t size,
 800            int(*compar)(const void *, const void *));
 801 int strcmp_compar(const void *, const void *);
 802
 803 /* lib/time.c */
 804 void    udelay        (unsigned long);
 805 void mdelay(unsigned long);
 806
 807 /* lib/uuid.c */
 808 void uuid_str_to_bin(const char *uuid, unsigned char *out);
 809 int uuid_str_valid(const char *uuid);
 810
 811 /* lib/vsprintf.c */
 812 #include <vsprintf.h>
 813
 814 /* lib/strmhz.c */
 815 char *  strmhz(char *buf, unsigned long hz);
 816
 817 /* lib/crc32.c */
 818 #include <u-boot/crc.h>
 819
 820 /* lib/rand.c */
 821 #if defined(CONFIG_RANDOM_MACADDR) || \
 822         defined(CONFIG_BOOTP_RANDOM_DELAY) || \
 823         defined(CONFIG_CMD_LINK_LOCAL)
 824 #define RAND_MAX -1U
 825 void srand(unsigned int seed);
 826 unsigned int rand(void);
 827 unsigned int rand_r(unsigned int *seedp);
 828 #endif
 829
 830 /* common/console.c */
 831 int     console_init_f(void);   /* Before relocation; uses the serial  stuff    */
 832 int     console_init_r(void);   /* After  relocation; uses the console stuff    */
 833 int     console_assign(int file, const char *devname);  /* Assign the console   */
 834 int     ctrlc (void);
 835 int     had_ctrlc (void);       /* have we had a Control-C since last clear? */
 836 void    clear_ctrlc (void);     /* clear the Control-C condition */
 837 int     disable_ctrlc (int);    /* 1 to disable, 0 to enable Control-C detect */
 838
 839 /*
 840  * STDIO based functions (can always be used)
 841  */
 842 /* serial stuff */
 843 int     serial_printf (const char *fmt, ...)
 844                 __attribute__ ((format (__printf__, 1, 2)));
 845 /* stdin */
 846 int     getc(void);
 847 int     tstc(void);
 848
 849 /* stdout */
 850 void    putc(const char c);
 851 void    puts(const char *s);
 852 int     printf(const char *fmt, ...)
 853                 __attribute__ ((format (__printf__, 1, 2)));
 854 int     vprintf(const char *fmt, va_list args);
 855
 856 /* stderr */
 857 #define eputc(c)                fputc(stderr, c)
 858 #define eputs(s)                fputs(stderr, s)
 859 #define eprintf(fmt,args...)    fprintf(stderr,fmt ,##args)
 860
 861 /*
 862  * FILE based functions (can only be used AFTER relocation!)
 863  */
 864 #define stdin           0
 865 #define stdout          1
 866 #define stderr          2
 867 #define MAX_FILES       3
 868
 869 int     fprintf(int file, const char *fmt, ...)
 870                 __attribute__ ((format (__printf__, 2, 3)));
 871 void    fputs(int file, const char *s);
 872 void    fputc(int file, const char c);
 873 int     ftstc(int file);
 874 int     fgetc(int file);
 875
 876 /* lib/gzip.c */
 877 int gzip(void *dst, unsigned long *lenp,
 878                 unsigned char *src, unsigned long srclen);
 879 int zzip(void *dst, unsigned long *lenp, unsigned char *src,
 880                 unsigned long srclen, int stoponerr,
 881                 int (*func)(unsigned long, unsigned long));
 882
 883 /* lib/net_utils.c */
 884 #include <net.h>
 885 static inline IPaddr_t getenv_IPaddr(char *var)
 886 {
 887         return string_to_ip(getenv(var));
 888 }
 889
 890 /*
 891  * CONSOLE multiplexing.
 892  */
 893 #ifdef CONFIG_CONSOLE_MUX
 894 #include <iomux.h>
 895 #endif
 896
 897 int     pcmcia_init (void);
 898
 899 #ifdef CONFIG_STATUS_LED
 900 # include <status_led.h>
 901 #endif
 902
 903 #include <bootstage.h>
 904
 905 #ifdef CONFIG_SHOW_ACTIVITY
 906 void show_activity(int arg);
 907 #endif
 908
 909 /* Multicore arch functions */
 910 #ifdef CONFIG_MP
 911 int cpu_status(int nr);
 912 int cpu_reset(int nr);
 913 int cpu_disable(int nr);
 914 int cpu_release(int nr, int argc, char * const argv[]);
 915 #endif
 916
 917 /* Define a null map_sysmem() if the architecture doesn't use it */
 918 # ifndef CONFIG_ARCH_MAP_SYSMEM
 919 static inline void *map_sysmem(phys_addr_t paddr, unsigned long len)
 920 {
 921         return (void *)(uintptr_t)paddr;
 922 }
 923
 924 static inline void unmap_sysmem(const void *vaddr)
 925 {
 926 }
 927
 928 static inline phys_addr_t map_to_sysmem(void *ptr)
 929 {
 930         return (phys_addr_t)(uintptr_t)ptr;
 931 }
 932 # endif
 933
 934 #endif /* __ASSEMBLY__ */
 935
 936 #ifdef CONFIG_PPC
 937 /*
 938  * Has to be included outside of the #ifndef __ASSEMBLY__ section.
 939  * Otherwise might lead to compilation errors in assembler files.
 940  */
 941 #include <asm/cache.h>
 942 #endif
 943
 944 /* Put only stuff here that the assembler can digest */
 945
 946 #ifdef CONFIG_POST
 947 #define CONFIG_HAS_POST
 948 #ifndef CONFIG_POST_ALT_LIST
 949 #define CONFIG_POST_STD_LIST
 950 #endif
 951 #endif
 952
 953 #ifdef CONFIG_INIT_CRITICAL
 954 #error CONFIG_INIT_CRITICAL is deprecated!
 955 #error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
 956 #endif
 957
 958 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
 959
 960 #define ROUND(a,b)              (((a) + (b) - 1) & ~((b) - 1))
 961 #define DIV_ROUND(n,d)          (((n) + ((d)/2)) / (d))
 962 #define DIV_ROUND_UP(n,d)       (((n) + (d) - 1) / (d))
 963 #define roundup(x, y)           ((((x) + ((y) - 1)) / (y)) * (y))
 964
 965 #define ALIGN(x,a)              __ALIGN_MASK((x),(typeof(x))(a)-1)
 966 #define __ALIGN_MASK(x,mask)    (((x)+(mask))&~(mask))
 967
 968 /*
 969  * ARCH_DMA_MINALIGN is defined in asm/cache.h for each architecture.  It
 970  * is used to align DMA buffers.
 971  */
 972 #ifndef __ASSEMBLY__
 973 #include <asm/cache.h>
 974 #endif
 975
 976 /*
 977  * The ALLOC_CACHE_ALIGN_BUFFER macro is used to allocate a buffer on the
 978  * stack that meets the minimum architecture alignment requirements for DMA.
 979  * Such a buffer is useful for DMA operations where flushing and invalidating
 980  * the cache before and after a read and/or write operation is required for
 981  * correct operations.
 982  *
 983  * When called the macro creates an array on the stack that is sized such
 984  * that:
 985  *
 986  * 1) The beginning of the array can be advanced enough to be aligned.
 987  *
 988  * 2) The size of the aligned portion of the array is a multiple of the minimum
 989  *    architecture alignment required for DMA.
 990  *
 991  * 3) The aligned portion contains enough space for the original number of
 992  *    elements requested.
 993  *
 994  * The macro then creates a pointer to the aligned portion of this array and
 995  * assigns to the pointer the address of the first element in the aligned
 996  * portion of the array.
 997  *
 998  * Calling the macro as:
 999  *
1000  *     ALLOC_CACHE_ALIGN_BUFFER(uint32_t, buffer, 1024);
1001  *
1002  * Will result in something similar to saying:
1003  *
1004  *     uint32_t    buffer[1024];
1005  *
1006  * The following differences exist:
1007  *
1008  * 1) The resulting buffer is guaranteed to be aligned to the value of
1009  *    ARCH_DMA_MINALIGN.
1010  *
1011  * 2) The buffer variable created by the macro is a pointer to the specified
1012  *    type, and NOT an array of the specified type.  This can be very important
1013  *    if you want the address of the buffer, which you probably do, to pass it
1014  *    to the DMA hardware.  The value of &buffer is different in the two cases.
1015  *    In the macro case it will be the address of the pointer, not the address
1016  *    of the space reserved for the buffer.  However, in the second case it
1017  *    would be the address of the buffer.  So if you are replacing hard coded
1018  *    stack buffers with this macro you need to make sure you remove the & from
1019  *    the locations where you are taking the address of the buffer.
1020  *
1021  * Note that the size parameter is the number of array elements to allocate,
1022  * not the number of bytes.
1023  *
1024  * This macro can not be used outside of function scope, or for the creation
1025  * of a function scoped static buffer.  It can not be used to create a cache
1026  * line aligned global buffer.
1027  */
1028 #define PAD_COUNT(s, pad) ((s - 1) / pad + 1)
1029 #define PAD_SIZE(s, pad) (PAD_COUNT(s, pad) * pad)
1030 #define ALLOC_ALIGN_BUFFER_PAD(type, name, size, align, pad)            \
1031         char __##name[ROUND(PAD_SIZE(size * sizeof(type), pad), align)  \
1032                       + (align - 1)];                                   \
1033                                                                         \
1034         type *name = (type *) ALIGN((uintptr_t)__##name, align)
1035 #define ALLOC_ALIGN_BUFFER(type, name, size, align)             \
1036         ALLOC_ALIGN_BUFFER_PAD(type, name, size, align, 1)
1037 #define ALLOC_CACHE_ALIGN_BUFFER_PAD(type, name, size, pad)             \
1038         ALLOC_ALIGN_BUFFER_PAD(type, name, size, ARCH_DMA_MINALIGN, pad)
1039 #define ALLOC_CACHE_ALIGN_BUFFER(type, name, size)                      \
1040         ALLOC_ALIGN_BUFFER(type, name, size, ARCH_DMA_MINALIGN)
1041
1042 /*
1043  * DEFINE_CACHE_ALIGN_BUFFER() is similar to ALLOC_CACHE_ALIGN_BUFFER, but it's
1044  * purpose is to allow allocating aligned buffers outside of function scope.
1045  * Usage of this macro shall be avoided or used with extreme care!
1046  */
1047 #define DEFINE_ALIGN_BUFFER(type, name, size, align)                    \
1048         static char __##name[roundup(size * sizeof(type), align)]       \
1049                         __aligned(align);                               \
1050                                                                         \
1051         static type *name = (type *)__##name
1052 #define DEFINE_CACHE_ALIGN_BUFFER(type, name, size)                     \
1053         DEFINE_ALIGN_BUFFER(type, name, size, ARCH_DMA_MINALIGN)
1054
1055 /* Pull in stuff for the build system */
1056 #ifdef DO_DEPS_ONLY
1057 # include <environment.h>
1058 #endif
1059
1060 #endif  /* __COMMON_H_ */