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