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