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 initdram(void);
 168 void print_size(ulong, const char *);
 169
 170 /* common/main.c */
 171 void    main_loop               (void);
 172 int             run_command             (const char *cmd, int flag);
 173 int             readline                (const char *const prompt);
 174 void    init_cmd_timeout(void);
 175 void    reset_cmd_timeout(void);
 176
 177 /* lib_$(ARCH)/board.c */
 178 void    board_init_f  (ulong);
 179 void    board_init_r  (gd_t *, ulong);
 180 int             checkboard    (void);
 181 int             checkflash    (void);
 182 int             checkdram     (void);
 183 char *  strmhz(char *buf, long hz);
 184 int             last_stage_init(void);
 185 extern  ulong monitor_flash_len;
 186
 187 /* common/flash.c */
 188 void flash_perror (int);
 189
 190 /* common/cmd_autoscript.c */
 191 int     autoscript (ulong addr);
 192
 193 /*
 194  * Only TP-Link OFW and OpenWrt for TP-Link routers
 195  * use different (simply) image header
 196  */
 197 #if !defined(CONFIG_FOR_8DEVICES_CARAMBOLA2) && \
 198         !defined(CONFIG_FOR_DLINK_DIR505_A1)     && \
 199         !defined(CONFIG_FOR_DRAGINO_V2)          && \
 200         !defined(CONFIG_FOR_MESH_POTATO_V2)
 201 #include "tpLinuxTag.h"
 202 #endif
 203
 204 /* common/cmd_bootm.c */
 205 #if defined(CONFIG_FOR_8DEVICES_CARAMBOLA2) || \
 206         defined(CONFIG_FOR_DLINK_DIR505_A1)     || \
 207         defined(CONFIG_FOR_DRAGINO_V2)          || \
 208         defined(CONFIG_FOR_MESH_POTATO_V2)
 209 void print_image_hdr(image_header_t *hdr);
 210 #else
 211 void print_image_hdr(tplink_image_header_t *hdr);
 212 #endif
 213
 214 extern ulong load_addr;         /* Default Load Address */
 215
 216 /* common/cmd_nvedit.c */
 217 int             env_init     (void);
 218 void    env_relocate (void);
 219 char    *getenv      (char *);
 220 int             getenv_r     (char *name, char *buf, unsigned len);
 221 int             saveenv      (void);
 222 void    setenv       (char *, char *);
 223
 224
 225 #ifdef CONFIG_ARM
 226 # include <asm/mach-types.h>
 227 # include <asm/setup.h>
 228 # include <asm/u-boot-arm.h>    /* ARM version to be fixed! */
 229 #endif /* CONFIG_ARM */
 230 #ifdef CONFIG_I386              /* x86 version to be fixed! */
 231 # include <asm/u-boot-i386.h>
 232 #endif /* CONFIG_I386 */
 233
 234 void    pci_init      (void);
 235 int             pci_init_board(void);
 236 void    pciinfo       (int, int);
 237
 238 #if defined(CONFIG_PCI) && defined(CONFIG_440)
 239 #   if defined(CFG_PCI_PRE_INIT)
 240     int    pci_pre_init        (struct pci_controller * );
 241 #   endif
 242 #   if defined(CFG_PCI_TARGET_INIT)
 243         void    pci_target_init      (struct pci_controller *);
 244 #   endif
 245 #   if defined(CFG_PCI_MASTER_INIT)
 246         void    pci_master_init      (struct pci_controller *);
 247 #   endif
 248     int     is_pci_host         (struct pci_controller *);
 249 #endif
 250
 251 int     misc_init_f   (void);
 252 int     misc_init_r   (void);
 253
 254 /* common/exports.c */
 255 void    jumptable_init(void);
 256
 257 /* common/memsize.c */
 258 int     get_ram_size  (volatile long *, long);
 259
 260 /* $(BOARD)/$(BOARD).c */
 261 void    reset_phy     (void);
 262 void    fdc_hw_init   (void);
 263
 264 /* $(BOARD)/eeprom.c */
 265 void eeprom_init  (void);
 266 #ifndef CONFIG_SPI
 267 int  eeprom_probe (unsigned dev_addr, unsigned offset);
 268 #endif
 269 int  eeprom_read  (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
 270 int  eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
 271 #ifdef CONFIG_LWMON
 272 extern uchar pic_read  (uchar reg);
 273 extern void  pic_write (uchar reg, uchar val);
 274 #endif
 275
 276 /*
 277  * Set this up regardless of board
 278  * type, to prevent errors.
 279  */
 280 #if defined(CONFIG_SPI) || !defined(CFG_I2C_EEPROM_ADDR)
 281 # define CFG_DEF_EEPROM_ADDR 0
 282 #else
 283 # define CFG_DEF_EEPROM_ADDR CFG_I2C_EEPROM_ADDR
 284 #endif /* CONFIG_SPI || !defined(CFG_I2C_EEPROM_ADDR) */
 285
 286 #if defined(CONFIG_SPI)
 287 extern void spi_init_f (void);
 288 extern void spi_init_r (void);
 289 extern ssize_t spi_read  (uchar *, int, uchar *, int);
 290 extern ssize_t spi_write (uchar *, int, uchar *, int);
 291 #endif
 292
 293 #ifdef CONFIG_RPXCLASSIC
 294 void rpxclassic_init (void);
 295 #endif
 296
 297 void rpxlite_init (void);
 298
 299 #ifdef CONFIG_MBX
 300 /* $(BOARD)/mbx8xx.c */
 301 void    mbx_init (void);
 302 void    board_serial_init (void);
 303 void    board_ether_init (void);
 304 #endif
 305
 306 #if defined(CONFIG_RPXCLASSIC)  || defined(CONFIG_MBX) || \
 307     defined(CONFIG_IAD210)      || defined(CONFIG_XPEDITE1K) || \
 308     defined(CONFIG_METROBOX)    || defined(CONFIG_KAREF)
 309 void    board_get_enetaddr (uchar *addr);
 310 #endif
 311
 312 #ifdef CONFIG_HERMES
 313 /* $(BOARD)/hermes.c */
 314 void hermes_start_lxt980 (int speed);
 315 #endif
 316
 317 #ifdef CONFIG_EVB64260
 318 void  evb64260_init(void);
 319 void  debug_led(int, int);
 320 void  display_mem_map(void);
 321 void  perform_soft_reset(void);
 322 #endif
 323
 324 void    load_sernum_ethaddr (void);
 325
 326 /* $(BOARD)/$(BOARD).c */
 327 int board_early_init_f (void);
 328 int board_late_init (void);
 329 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
 330 int board_early_init_r (void);
 331 void board_poweroff (void);
 332
 333 #if defined(CFG_DRAM_TEST)
 334 int testdram(void);
 335 #endif /* CFG_DRAM_TEST */
 336
 337 /* $(CPU)/start.S */
 338 #if defined(CONFIG_5xx) || \
 339     defined(CONFIG_8xx)
 340 uint    get_immr      (uint);
 341 #endif
 342 uint    get_pir       (void);
 343 #if defined(CONFIG_MPC5xxx)
 344 uint    get_svr       (void);
 345 #endif
 346 uint    get_pvr       (void);
 347 uint    get_svr       (void);
 348 uint    rd_ic_cst     (void);
 349 void    wr_ic_cst     (uint);
 350 void    wr_ic_adr     (uint);
 351 uint    rd_dc_cst     (void);
 352 void    wr_dc_cst     (uint);
 353 void    wr_dc_adr     (uint);
 354 int     icache_status (void);
 355 void    icache_enable (void);
 356 void    icache_disable(void);
 357 int     dcache_status (void);
 358 void    dcache_enable (void);
 359 void    dcache_disable(void);
 360 void    relocate_code (ulong, gd_t *, ulong);
 361 ulong   get_endaddr   (void);
 362 void    trap_init     (ulong);
 363 #if defined (CONFIG_4xx)        || \
 364     defined (CONFIG_MPC5xxx)    || \
 365     defined (CONFIG_74xx_7xx)   || \
 366     defined (CONFIG_74x)        || \
 367     defined (CONFIG_75x)        || \
 368     defined (CONFIG_74xx)       || \
 369     defined (CONFIG_MPC8220)    || \
 370     defined (CONFIG_MPC85xx)    || \
 371     defined (CONFIG_MPC83XX)
 372 unsigned char   in8(unsigned int);
 373 void            out8(unsigned int, unsigned char);
 374 unsigned short  in16(unsigned int);
 375 unsigned short  in16r(unsigned int);
 376 void            out16(unsigned int, unsigned short value);
 377 void            out16r(unsigned int, unsigned short value);
 378 unsigned long   in32(unsigned int);
 379 unsigned long   in32r(unsigned int);
 380 void            out32(unsigned int, unsigned long value);
 381 void            out32r(unsigned int, unsigned long value);
 382 void            ppcDcbf(unsigned long value);
 383 void            ppcDcbi(unsigned long value);
 384 void            ppcSync(void);
 385 void            ppcDcbz(unsigned long value);
 386 #endif
 387
 388 /* $(CPU)/cpu.c */
 389 int     checkcpu      (void);
 390 int     checkicache   (void);
 391 int     checkdcache   (void);
 392 void    upmconfig     (unsigned int, unsigned int *, unsigned int);
 393 ulong   get_tbclk     (void);
 394 void    reset_cpu     (ulong addr);
 395
 396 /* $(CPU)/serial.c */
 397 int     serial_init   (void);
 398 void    serial_addr   (unsigned int);
 399 void    serial_putc   (const char);
 400 void    serial_putc_raw(const char);
 401 void    serial_puts   (const char *);
 402 int     serial_getc   (void);
 403 int     serial_tstc   (void);
 404
 405 void    _serial_putc   (const char, const int);
 406 void    _serial_putc_raw(const char, const int);
 407 void    _serial_puts   (const char *, const int);
 408 int     _serial_getc   (const int);
 409 int     _serial_tstc   (const int);
 410
 411 /* $(CPU)/speed.c */
 412 int     get_clocks (void);
 413 int     get_clocks_866 (void);
 414 int     sdram_adjust_866 (void);
 415 int     adjust_sdram_tbs_8xx (void);
 416 #if defined(CONFIG_8260)
 417 int     prt_8260_clks (void);
 418 #elif defined(CONFIG_MPC83XX)
 419 int print_clock_conf(void);
 420 #elif defined(CONFIG_MPC5xxx)
 421 int     prt_mpc5xxx_clks (void);
 422 #endif
 423 #if defined(CONFIG_MPC8220)
 424 int     prt_mpc8220_clks (void);
 425 #endif
 426 #ifdef CONFIG_4xx
 427 ulong   get_OPB_freq (void);
 428 ulong   get_PCI_freq (void);
 429 #endif
 430 #if defined(CONFIG_S3C2400) || defined(CONFIG_S3C2410) || defined(CONFIG_LH7A40X)
 431 ulong   get_FCLK (void);
 432 ulong   get_HCLK (void);
 433 ulong   get_PCLK (void);
 434 ulong   get_UCLK (void);
 435 #endif
 436 #if defined(CONFIG_LH7A40X)
 437 ulong   get_PLLCLK (void);
 438 #endif
 439 #if defined CONFIG_INCA_IP
 440 uint    incaip_get_cpuclk (void);
 441 #endif
 442 #if defined(CONFIG_IMX)
 443 ulong get_systemPLLCLK(void);
 444 ulong get_FCLK(void);
 445 ulong get_HCLK(void);
 446 ulong get_BCLK(void);
 447 ulong get_PERCLK1(void);
 448 ulong get_PERCLK2(void);
 449 ulong get_PERCLK3(void);
 450 #endif
 451 ulong   get_bus_freq  (ulong);
 452
 453 #if defined(CONFIG_MPC85xx)
 454 typedef MPC85xx_SYS_INFO sys_info_t;
 455 void    get_sys_info  ( sys_info_t * );
 456 #endif
 457
 458 #if defined(CONFIG_4xx) || defined(CONFIG_IOP480)
 459 #  if defined(CONFIG_440)
 460     typedef PPC440_SYS_INFO sys_info_t;
 461 #  else
 462     typedef PPC405_SYS_INFO sys_info_t;
 463 #  endif
 464 void    get_sys_info  ( sys_info_t * );
 465 #endif
 466
 467 /* $(CPU)/cpu_init.c */
 468 #if defined(CONFIG_8xx) || defined(CONFIG_8260)
 469 void    cpu_init_f    (volatile immap_t *immr);
 470 #endif
 471 #if defined(CONFIG_4xx) || defined(CONFIG_MPC85xx) || defined(CONFIG_MCF52x2)
 472 void    cpu_init_f    (void);
 473 #endif
 474
 475 int     cpu_init_r    (void);
 476 #if defined(CONFIG_8260)
 477 int     prt_8260_rsr  (void);
 478 #endif
 479
 480 /* $(CPU)/interrupts.c */
 481 int     interrupt_init     (void);
 482 void    timer_interrupt    (struct pt_regs *);
 483 void    external_interrupt (struct pt_regs *);
 484 void    irq_install_handler(int, interrupt_handler_t *, void *);
 485 void    irq_free_handler   (int);
 486 ulong   get_timer          (ulong base);
 487
 488 /* $(CPU)/.../commproc.c */
 489 int     dpram_init (void);
 490 uint    dpram_base(void);
 491 uint    dpram_base_align(uint align);
 492 uint    dpram_alloc(uint size);
 493 uint    dpram_alloc_align(uint size,uint align);
 494 void    post_word_store (ulong);
 495 ulong   post_word_load (void);
 496 void    bootcount_store (ulong);
 497 ulong   bootcount_load (void);
 498 #define BOOTCOUNT_MAGIC         0xB001C041
 499
 500 /* $(CPU)/.../<eth> */
 501 void mii_init (void);
 502
 503 /* $(CPU)/.../lcd.c */
 504 ulong   lcd_setmem (ulong);
 505
 506 /* $(CPU)/.../vfd.c */
 507 ulong   vfd_setmem (ulong);
 508
 509 /* $(CPU)/.../video.c */
 510 ulong   video_setmem (ulong);
 511
 512 /* lib_$(ARCH)/cache.c */
 513 void    flush_cache   (unsigned long, unsigned long);
 514
 515
 516 /* lib_$(ARCH)/ticks.S */
 517 unsigned long long get_ticks(void);
 518 void    wait_ticks    (unsigned long);
 519
 520 /* lib_$(ARCH)/time.c */
 521 void    udelay        (unsigned long);
 522 ulong   usec2ticks    (unsigned long usec);
 523 ulong   ticks2usec    (unsigned long ticks);
 524 int     init_timebase (void);
 525
 526 /* lib_generic/vsprintf.c */
 527 ulong   simple_strtoul(const char *cp,char **endp,unsigned int base);
 528 #ifdef CFG_64BIT_VSPRINTF
 529 unsigned long long      simple_strtoull(const char *cp,char **endp,unsigned int base);
 530 #endif
 531 long    simple_strtol(const char *cp,char **endp,unsigned int base);
 532 int     sprintf(char * buf, const char *fmt, ...);
 533 int     vsprintf(char *buf, const char *fmt, va_list args);
 534
 535 /* lib_generic/crc32.c */
 536 ulong crc32 (ulong, const unsigned char *, uint);
 537 ulong crc32_no_comp (ulong, const unsigned char *, uint);
 538
 539 /* common/console.c */
 540 int     console_init_f(void);   /* Before relocation; uses the serial  stuff    */
 541 int     console_init_r(void);   /* After  relocation; uses the console stuff    */
 542 int     console_assign (int file, char *devname);       /* Assign the console   */
 543 int     ctrlc (void);
 544 int     had_ctrlc (void);       /* have we had a Control-C since last clear? */
 545 void    clear_ctrlc (void);     /* clear the Control-C condition */
 546 int     disable_ctrlc (int);    /* 1 to disable, 0 to enable Control-C detect */
 547
 548 /*
 549  * STDIO based functions (can always be used)
 550  */
 551
 552 /* serial stuff */
 553 void    serial_printf (const char *fmt, ...);
 554
 555 /* stdin */
 556 int     getc(void);
 557 int     tstc(void);
 558
 559 /* stdout */
 560 void    putc(const char c);
 561 void    puts(const char *s);
 562 void    printf(const char *fmt, ...);
 563 //void  vprintf(const char *fmt, va_list args);
 564
 565 /* stderr */
 566 #define eputc(c)                fputc(stderr, c)
 567 #define eputs(s)                fputs(stderr, s)
 568 #define eprintf(fmt,args...)    fprintf(stderr,fmt ,##args)
 569
 570 /*
 571  * FILE based functions (can only be used AFTER relocation!)
 572  */
 573
 574 #define stdin           0
 575 #define stdout          1
 576 #define stderr          2
 577 #define MAX_FILES       3
 578
 579 void    fprintf(int file, const char *fmt, ...);
 580 void    fputs(int file, const char *s);
 581 void    fputc(int file, const char c);
 582 int     ftstc(int file);
 583 int     fgetc(int file);
 584
 585 int     pcmcia_init (void);
 586
 587 #endif  /* __COMMON_H_ */