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