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