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