include/common.h

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