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