u-boot/include/common.h

   1 /*
   2  * (C) Copyright 2000-2004
   3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   4  *
   5  * See file CREDITS for list of people who contributed to this
   6  * project.
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License as
  10  * published by the Free Software Foundation; either version 2 of
  11  * the License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  21  * MA 02111-1307 USA
  22  */
  23
  24 #ifndef __COMMON_H_
  25 #define __COMMON_H_     1
  26
  27 #undef  _LINUX_CONFIG_H
  28 #define _LINUX_CONFIG_H 1       /* avoid reading Linux autoconf.h file  */
  29
  30 typedef unsigned char           uchar;
  31 typedef volatile unsigned long  vu_long;
  32 typedef volatile unsigned short vu_short;
  33 typedef volatile unsigned char  vu_char;
  34
  35 #include <config.h>
  36 #include <linux/bitops.h>
  37 #include <linux/types.h>
  38 #include <linux/string.h>
  39 #include <asm/ptrace.h>
  40 #include <stdarg.h>
  41 #if defined(CONFIG_PCI) && defined(CONFIG_440)
  42 #include <pci.h>
  43 #endif
  44 #if defined(CONFIG_8xx)
  45 #include <asm/8xx_immap.h>
  46 #if defined(CONFIG_MPC852)      || defined(CONFIG_MPC852T)      || \
  47     defined(CONFIG_MPC859)      || defined(CONFIG_MPC859T)      || \
  48     defined(CONFIG_MPC859DSL)   || \
  49     defined(CONFIG_MPC866)      || defined(CONFIG_MPC866T)      || \
  50     defined(CONFIG_MPC866P)
  51 # define CONFIG_MPC866_FAMILY 1
  52 #elif defined(CONFIG_MPC870) \
  53    || defined(CONFIG_MPC875) \
  54    || defined(CONFIG_MPC880) \
  55    || defined(CONFIG_MPC885)
  56 # define CONFIG_MPC885_FAMILY   1
  57 #endif
  58 #if   defined(CONFIG_MPC860)       \
  59    || defined(CONFIG_MPC860T)      \
  60    || defined(CONFIG_MPC866_FAMILY) \
  61    || defined(CONFIG_MPC885_FAMILY)
  62 # define CONFIG_MPC86x 1
  63 #endif
  64 #elif defined(CONFIG_5xx)
  65 #include <asm/5xx_immap.h>
  66 #elif defined(CONFIG_MPC5xxx)
  67 #include <mpc5xxx.h>
  68 #elif defined(CONFIG_MPC8220)
  69 #include <asm/immap_8220.h>
  70 #elif defined(CONFIG_8260)
  71 #if   defined(CONFIG_MPC8247) \
  72    || defined(CONFIG_MPC8248) \
  73    || defined(CONFIG_MPC8271) \
  74    || defined(CONFIG_MPC8272)
  75 #define CONFIG_MPC8272_FAMILY   1
  76 #endif
  77 #if defined(CONFIG_MPC8272_FAMILY)
  78 #define CONFIG_MPC8260  1
  79 #endif
  80 #include <asm/immap_8260.h>
  81 #endif
  82 #ifdef CONFIG_MPC85xx
  83 #include <mpc85xx.h>
  84 #include <asm/immap_85xx.h>
  85 #endif
  86 #ifdef CONFIG_MPC83XX
  87 #include <mpc83xx.h>
  88 #include <asm/immap_83xx.h>
  89 #endif
  90 #ifdef  CONFIG_4xx
  91 #include <ppc4xx.h>
  92 #endif
  93 #ifdef CONFIG_HYMOD
  94 #include <board/hymod/hymod.h>
  95 #endif
  96 #ifdef CONFIG_ARM
  97 #define asmlinkage      /* nothing */
  98 #endif
  99
 100 #include <flash.h>
 101 #include <image.h>
 102
 103 #ifdef  DEBUG
 104 #define debug(fmt,args...)      printf (fmt ,##args)
 105 #define debugX(level,fmt,args...) if (DEBUG>=level) printf(fmt,##args);
 106 #else
 107 #define debug(fmt,args...)
 108 #define debugX(level,fmt,args...)
 109 #endif  /* DEBUG */
 110
 111 typedef void (interrupt_handler_t)(void *);
 112
 113 #include <asm/u-boot.h> /* boot information for Linux kernel */
 114 #include <asm/global_data.h>    /* global data used for startup functions */
 115
 116 /*
 117  * enable common handling for all TQM8xxL/M boards:
 118  * - CONFIG_TQM8xxM will be defined for all TQM8xxM boards
 119  * - CONFIG_TQM8xxL will be defined for all TQM8xxL _and_ TQM8xxM boards
 120  */
 121 #if defined(CONFIG_TQM823M) || defined(CONFIG_TQM850M) || \
 122     defined(CONFIG_TQM855M) || defined(CONFIG_TQM860M) || \
 123     defined(CONFIG_TQM862M) || defined(CONFIG_TQM866M)
 124 # ifndef CONFIG_TQM8xxM
 125 #  define CONFIG_TQM8xxM
 126 # endif
 127 #endif
 128 #if defined(CONFIG_TQM823L) || defined(CONFIG_TQM850L) || \
 129     defined(CONFIG_TQM855L) || defined(CONFIG_TQM860L) || \
 130     defined(CONFIG_TQM862L) || defined(CONFIG_TQM8xxM)
 131 # ifndef CONFIG_TQM8xxL
 132 #  define CONFIG_TQM8xxL
 133 # endif
 134 #endif
 135
 136 #ifndef CONFIG_SERIAL_MULTI
 137
 138 #if defined(CONFIG_8xx_CONS_SMC1) || defined(CONFIG_8xx_CONS_SMC2) \
 139  || defined(CONFIG_8xx_CONS_SCC1) || defined(CONFIG_8xx_CONS_SCC2) \
 140  || defined(CONFIG_8xx_CONS_SCC3) || defined(CONFIG_8xx_CONS_SCC4)
 141
 142 #define CONFIG_SERIAL_MULTI     1
 143
 144 #endif
 145
 146 #endif /* CONFIG_SERIAL_MULTI */
 147
 148 /*
 149  * General Purpose Utilities
 150  */
 151 #define min(X, Y)                               \
 152         ({ typeof (X) __x = (X), __y = (Y);     \
 153                 (__x < __y) ? __x : __y; })
 154
 155 #define max(X, Y)                               \
 156         ({ typeof (X) __x = (X), __y = (Y);     \
 157                 (__x > __y) ? __x : __y; })
 158
 159
 160 /*
 161  * Function Prototypes
 162  */
 163
 164 void hang(void) __attribute__ ((noreturn));
 165
 166 /* */
 167 long int dram_init(void);
 168 int      timer_init(void);
 169 void     full_reset(void);
 170 void     all_led_on(void);
 171 void     all_led_off(void);
 172 void     print_size(ulong, const char *);
 173 void     print_board_info(void);
 174 void     macaddr_init(unsigned char *);
 175 void     flash_print_name(void);
 176 void     cpu_name(char *name);
 177 unsigned int main_cpu_clk(void);
 178
 179 /* common/main.c */
 180 void    main_loop               (void);
 181 int             run_command             (const char *cmd, int flag);
 182 int             readline                (const char *const prompt);
 183 void    init_cmd_timeout(void);
 184 void    reset_cmd_timeout(void);
 185
 186 /* lib_$(ARCH)/board.c */
 187 void    board_init_f  (ulong);
 188 void    board_init_r  (gd_t *, ulong);
 189 int             checkboard    (void);
 190 int             checkflash    (void);
 191 int             checkdram     (void);
 192 char *  strmhz(char *buf, long hz);
 193 int             last_stage_init(void);
 194 extern  ulong monitor_flash_len;
 195
 196 /* common/flash.c */
 197 void flash_perror (int);
 198
 199 /* common/cmd_autoscript.c */
 200 int     autoscript (ulong addr);
 201
 202 /*
 203  * Only TP-Link OFW and OpenWrt for TP-Link routers
 204  * use different (simply) image header
 205  */
 206 #if !defined(CONFIG_FOR_8DEVICES_CARAMBOLA2) && \
 207         !defined(CONFIG_FOR_BLACK_SWIFT_BOARD)   && \
 208         !defined(CONFIG_FOR_DLINK_DIR505_A1)     && \
 209         !defined(CONFIG_FOR_DRAGINO_V2)          && \
 210         !defined(CONFIG_FOR_MESH_POTATO_V2)
 211 #include "tpLinuxTag.h"
 212 #endif
 213
 214 /* common/cmd_bootm.c */
 215 #if defined(CONFIG_FOR_8DEVICES_CARAMBOLA2) || \
 216         defined(CONFIG_FOR_BLACK_SWIFT_BOARD)   || \
 217         defined(CONFIG_FOR_DLINK_DIR505_A1)     || \
 218         defined(CONFIG_FOR_DRAGINO_V2)          || \
 219         defined(CONFIG_FOR_MESH_POTATO_V2)
 220 void print_image_hdr(image_header_t *hdr);
 221 #else
 222 void print_image_hdr(tplink_image_header_t *hdr);
 223 #endif
 224
 225 extern ulong load_addr;         /* Default Load Address */
 226
 227 /* common/cmd_nvedit.c */
 228 int             env_init     (void);
 229 void    env_relocate (void);
 230 char    *getenv      (char *);
 231 int             getenv_r     (char *name, char *buf, unsigned len);
 232 int             saveenv      (void);
 233 void    setenv       (char *, char *);
 234
 235
 236 #ifdef CONFIG_ARM
 237 # include <asm/mach-types.h>
 238 # include <asm/setup.h>
 239 # include <asm/u-boot-arm.h>    /* ARM version to be fixed! */
 240 #endif /* CONFIG_ARM */
 241 #ifdef CONFIG_I386              /* x86 version to be fixed! */
 242 # include <asm/u-boot-i386.h>
 243 #endif /* CONFIG_I386 */
 244
 245 void    pci_init      (void);
 246 int             pci_init_board(void);
 247 void    pciinfo       (int, int);
 248
 249 #if defined(CONFIG_PCI) && defined(CONFIG_440)
 250 #   if defined(CFG_PCI_PRE_INIT)
 251     int    pci_pre_init        (struct pci_controller * );
 252 #   endif
 253 #   if defined(CFG_PCI_TARGET_INIT)
 254         void    pci_target_init      (struct pci_controller *);
 255 #   endif
 256 #   if defined(CFG_PCI_MASTER_INIT)
 257         void    pci_master_init      (struct pci_controller *);
 258 #   endif
 259     int     is_pci_host         (struct pci_controller *);
 260 #endif
 261
 262 int     misc_init_f   (void);
 263 int     misc_init_r   (void);
 264
 265 /* common/exports.c */
 266 void    jumptable_init(void);
 267
 268 /* common/memsize.c */
 269 int     get_ram_size  (volatile long *, long);
 270
 271 /* $(BOARD)/$(BOARD).c */
 272 void    reset_phy     (void);
 273 void    fdc_hw_init   (void);
 274
 275 /* $(BOARD)/eeprom.c */
 276 void eeprom_init  (void);
 277 #ifndef CONFIG_SPI
 278 int  eeprom_probe (unsigned dev_addr, unsigned offset);
 279 #endif
 280 int  eeprom_read  (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
 281 int  eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
 282 #ifdef CONFIG_LWMON
 283 extern uchar pic_read  (uchar reg);
 284 extern void  pic_write (uchar reg, uchar val);
 285 #endif
 286
 287 /*
 288  * Set this up regardless of board
 289  * type, to prevent errors.
 290  */
 291 #if defined(CONFIG_SPI) || !defined(CFG_I2C_EEPROM_ADDR)
 292 # define CFG_DEF_EEPROM_ADDR 0
 293 #else
 294 # define CFG_DEF_EEPROM_ADDR CFG_I2C_EEPROM_ADDR
 295 #endif /* CONFIG_SPI || !defined(CFG_I2C_EEPROM_ADDR) */
 296
 297 #if defined(CONFIG_SPI)
 298 extern void spi_init_f (void);
 299 extern void spi_init_r (void);
 300 extern ssize_t spi_read  (uchar *, int, uchar *, int);
 301 extern ssize_t spi_write (uchar *, int, uchar *, int);
 302 #endif
 303
 304 #ifdef CONFIG_RPXCLASSIC
 305 void rpxclassic_init (void);
 306 #endif
 307
 308 void rpxlite_init (void);
 309
 310 #ifdef CONFIG_MBX
 311 /* $(BOARD)/mbx8xx.c */
 312 void    mbx_init (void);
 313 void    board_serial_init (void);
 314 void    board_ether_init (void);
 315 #endif
 316
 317 #if defined(CONFIG_RPXCLASSIC)  || defined(CONFIG_MBX) || \
 318     defined(CONFIG_IAD210)      || defined(CONFIG_XPEDITE1K) || \
 319     defined(CONFIG_METROBOX)    || defined(CONFIG_KAREF)
 320 void    board_get_enetaddr (uchar *addr);
 321 #endif
 322
 323 #ifdef CONFIG_HERMES
 324 /* $(BOARD)/hermes.c */
 325 void hermes_start_lxt980 (int speed);
 326 #endif
 327
 328 #ifdef CONFIG_EVB64260
 329 void  evb64260_init(void);
 330 void  debug_led(int, int);
 331 void  display_mem_map(void);
 332 void  perform_soft_reset(void);
 333 #endif
 334
 335 void    load_sernum_ethaddr (void);
 336
 337 /* $(BOARD)/$(BOARD).c */
 338 int board_early_init_f (void);
 339 int board_late_init (void);
 340 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
 341 int board_early_init_r (void);
 342 void board_poweroff (void);
 343
 344 #if defined(CFG_DRAM_TEST)
 345 int testdram(void);
 346 #endif /* CFG_DRAM_TEST */
 347
 348 /* $(CPU)/start.S */
 349 #if defined(CONFIG_5xx) || \
 350     defined(CONFIG_8xx)
 351 uint    get_immr      (uint);
 352 #endif
 353 uint    get_pir       (void);
 354 #if defined(CONFIG_MPC5xxx)
 355 uint    get_svr       (void);
 356 #endif
 357 uint    get_pvr       (void);
 358 uint    get_svr       (void);
 359 uint    rd_ic_cst     (void);
 360 void    wr_ic_cst     (uint);
 361 void    wr_ic_adr     (uint);
 362 uint    rd_dc_cst     (void);
 363 void    wr_dc_cst     (uint);
 364 void    wr_dc_adr     (uint);
 365 int     icache_status (void);
 366 void    icache_enable (void);
 367 void    icache_disable(void);
 368 int     dcache_status (void);
 369 void    dcache_enable (void);
 370 void    dcache_disable(void);
 371 void    relocate_code (ulong, gd_t *, ulong);
 372 ulong   get_endaddr   (void);
 373 void    trap_init     (ulong);
 374 #if defined (CONFIG_4xx)        || \
 375     defined (CONFIG_MPC5xxx)    || \
 376     defined (CONFIG_74xx_7xx)   || \
 377     defined (CONFIG_74x)        || \
 378     defined (CONFIG_75x)        || \
 379     defined (CONFIG_74xx)       || \
 380     defined (CONFIG_MPC8220)    || \
 381     defined (CONFIG_MPC85xx)    || \
 382     defined (CONFIG_MPC83XX)
 383 unsigned char   in8(unsigned int);
 384 void            out8(unsigned int, unsigned char);
 385 unsigned short  in16(unsigned int);
 386 unsigned short  in16r(unsigned int);
 387 void            out16(unsigned int, unsigned short value);
 388 void            out16r(unsigned int, unsigned short value);
 389 unsigned long   in32(unsigned int);
 390 unsigned long   in32r(unsigned int);
 391 void            out32(unsigned int, unsigned long value);
 392 void            out32r(unsigned int, unsigned long value);
 393 void            ppcDcbf(unsigned long value);
 394 void            ppcDcbi(unsigned long value);
 395 void            ppcSync(void);
 396 void            ppcDcbz(unsigned long value);
 397 #endif
 398
 399 /* $(CPU)/cpu.c */
 400 int     checkcpu      (void);
 401 int     checkicache   (void);
 402 int     checkdcache   (void);
 403 void    upmconfig     (unsigned int, unsigned int *, unsigned int);
 404 ulong   get_tbclk     (void);
 405 void    reset_cpu     (ulong addr);
 406
 407 /* $(CPU)/serial.c */
 408 int     serial_init   (void);
 409 void    serial_addr   (unsigned int);
 410 void    serial_putc   (const char);
 411 void    serial_putc_raw(const char);
 412 void    serial_puts   (const char *);
 413 int     serial_getc   (void);
 414 int     serial_tstc   (void);
 415 void    serial_setbrg (void);
 416
 417 void    _serial_putc   (const char, const int);
 418 void    _serial_putc_raw(const char, const int);
 419 void    _serial_puts   (const char *, const int);
 420 int     _serial_getc   (const int);
 421 int     _serial_tstc   (const int);
 422
 423 /* $(CPU)/speed.c */
 424 int     get_clocks (void);
 425 int     get_clocks_866 (void);
 426 int     sdram_adjust_866 (void);
 427 int     adjust_sdram_tbs_8xx (void);
 428 #if defined(CONFIG_8260)
 429 int     prt_8260_clks (void);
 430 #elif defined(CONFIG_MPC83XX)
 431 int print_clock_conf(void);
 432 #elif defined(CONFIG_MPC5xxx)
 433 int     prt_mpc5xxx_clks (void);
 434 #endif
 435 #if defined(CONFIG_MPC8220)
 436 int     prt_mpc8220_clks (void);
 437 #endif
 438 #ifdef CONFIG_4xx
 439 ulong   get_OPB_freq (void);
 440 ulong   get_PCI_freq (void);
 441 #endif
 442 #if defined(CONFIG_S3C2400) || defined(CONFIG_S3C2410) || defined(CONFIG_LH7A40X)
 443 ulong   get_FCLK (void);
 444 ulong   get_HCLK (void);
 445 ulong   get_PCLK (void);
 446 ulong   get_UCLK (void);
 447 #endif
 448 #if defined(CONFIG_LH7A40X)
 449 ulong   get_PLLCLK (void);
 450 #endif
 451 #if defined CONFIG_INCA_IP
 452 uint    incaip_get_cpuclk (void);
 453 #endif
 454 #if defined(CONFIG_IMX)
 455 ulong get_systemPLLCLK(void);
 456 ulong get_FCLK(void);
 457 ulong get_HCLK(void);
 458 ulong get_BCLK(void);
 459 ulong get_PERCLK1(void);
 460 ulong get_PERCLK2(void);
 461 ulong get_PERCLK3(void);
 462 #endif
 463 ulong   get_bus_freq  (ulong);
 464
 465 #if defined(CONFIG_MPC85xx)
 466 typedef MPC85xx_SYS_INFO sys_info_t;
 467 void    get_sys_info  ( sys_info_t * );
 468 #endif
 469
 470 #if defined(CONFIG_4xx) || defined(CONFIG_IOP480)
 471 #  if defined(CONFIG_440)
 472     typedef PPC440_SYS_INFO sys_info_t;
 473 #  else
 474     typedef PPC405_SYS_INFO sys_info_t;
 475 #  endif
 476 void    get_sys_info  ( sys_info_t * );
 477 #endif
 478
 479 /* $(CPU)/cpu_init.c */
 480 #if defined(CONFIG_8xx) || defined(CONFIG_8260)
 481 void    cpu_init_f    (volatile immap_t *immr);
 482 #endif
 483 #if defined(CONFIG_4xx) || defined(CONFIG_MPC85xx) || defined(CONFIG_MCF52x2)
 484 void    cpu_init_f    (void);
 485 #endif
 486
 487 int     cpu_init_r    (void);
 488 #if defined(CONFIG_8260)
 489 int     prt_8260_rsr  (void);
 490 #endif
 491
 492 /* $(CPU)/interrupts.c */
 493 int     interrupt_init     (void);
 494 void    timer_interrupt    (struct pt_regs *);
 495 void    external_interrupt (struct pt_regs *);
 496 void    irq_install_handler(int, interrupt_handler_t *, void *);
 497 void    irq_free_handler   (int);
 498 ulong   get_timer          (ulong base);
 499
 500 /* $(CPU)/.../commproc.c */
 501 int     dpram_init (void);
 502 uint    dpram_base(void);
 503 uint    dpram_base_align(uint align);
 504 uint    dpram_alloc(uint size);
 505 uint    dpram_alloc_align(uint size,uint align);
 506 void    post_word_store (ulong);
 507 ulong   post_word_load (void);
 508 void    bootcount_store (ulong);
 509 ulong   bootcount_load (void);
 510 #define BOOTCOUNT_MAGIC         0xB001C041
 511
 512 /* $(CPU)/.../<eth> */
 513 void mii_init (void);
 514
 515 /* $(CPU)/.../lcd.c */
 516 ulong   lcd_setmem (ulong);
 517
 518 /* $(CPU)/.../vfd.c */
 519 ulong   vfd_setmem (ulong);
 520
 521 /* $(CPU)/.../video.c */
 522 ulong   video_setmem (ulong);
 523
 524 /* lib_$(ARCH)/cache.c */
 525 void    flush_cache   (unsigned long, unsigned long);
 526
 527
 528 /* lib_$(ARCH)/ticks.S */
 529 unsigned long long get_ticks(void);
 530 void    wait_ticks    (unsigned long);
 531
 532 /* lib_$(ARCH)/time.c */
 533 void    udelay        (unsigned long);
 534 #define milisecdelay(_x)                        udelay((_x) * 1000)
 535 ulong   usec2ticks    (unsigned long usec);
 536 ulong   ticks2usec    (unsigned long ticks);
 537 int     init_timebase (void);
 538
 539 /* lib_generic/vsprintf.c */
 540 ulong   simple_strtoul(const char *cp,char **endp,unsigned int base);
 541 #ifdef CFG_64BIT_VSPRINTF
 542 unsigned long long      simple_strtoull(const char *cp,char **endp,unsigned int base);
 543 #endif
 544 long    simple_strtol(const char *cp,char **endp,unsigned int base);
 545 int     sprintf(char * buf, const char *fmt, ...);
 546 int     vsprintf(char *buf, const char *fmt, va_list args);
 547
 548 /* common/console.c */
 549 int     console_init_f(void);   /* Before relocation; uses the serial  stuff    */
 550 int     console_init_r(void);   /* After  relocation; uses the console stuff    */
 551 int     console_assign (int file, char *devname);       /* Assign the console   */
 552 int     ctrlc (void);
 553 int     had_ctrlc (void);       /* have we had a Control-C since last clear? */
 554 void    clear_ctrlc (void);     /* clear the Control-C condition */
 555 int     disable_ctrlc (int);    /* 1 to disable, 0 to enable Control-C detect */
 556
 557 /*
 558  * STDIO based functions (can always be used)
 559  */
 560
 561 /* serial stuff */
 562 void    serial_printf (const char *fmt, ...);
 563
 564 /* stdin */
 565 int     getc(void);
 566 int     tstc(void);
 567
 568 /* stdout */
 569 void    putc(const char c);
 570 void    puts(const char *s);
 571 void    printf(const char *fmt, ...);
 572 //void  vprintf(const char *fmt, va_list args);
 573
 574 /* stderr */
 575 #define eputc(c)                fputc(stderr, c)
 576 #define eputs(s)                fputs(stderr, s)
 577 #define eprintf(fmt,args...)    fprintf(stderr,fmt ,##args)
 578
 579 /*
 580  * FILE based functions (can only be used AFTER relocation!)
 581  */
 582
 583 #define stdin           0
 584 #define stdout          1
 585 #define stderr          2
 586 #define MAX_FILES       3
 587
 588 void    fprintf(int file, const char *fmt, ...);
 589 void    fputs(int file, const char *s);
 590 void    fputc(int file, const char c);
 591 int     ftstc(int file);
 592 int     fgetc(int file);
 593
 594 int     pcmcia_init (void);
 595
 596 #endif  /* __COMMON_H_ */