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