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