]> git.sur5r.net Git - u-boot/blob - include/common.h
Merge with /home/raj/git/u-boot
[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 <part.h>
101 #include <flash.h>
102 #include <image.h>
103
104 #ifdef  DEBUG
105 #define debug(fmt,args...)      printf (fmt ,##args)
106 #define debugX(level,fmt,args...) if (DEBUG>=level) printf(fmt,##args);
107 #else
108 #define debug(fmt,args...)
109 #define debugX(level,fmt,args...)
110 #endif  /* DEBUG */
111
112 typedef void (interrupt_handler_t)(void *);
113
114 #include <asm/u-boot.h> /* boot information for Linux kernel */
115 #include <asm/global_data.h>    /* global data used for startup functions */
116
117 /*
118  * enable common handling for all TQM8xxL/M boards:
119  * - CONFIG_TQM8xxM will be defined for all TQM8xxM and TQM885D boards
120  * - CONFIG_TQM8xxL will be defined for all TQM8xxL _and_ TQM8xxM boards
121  */
122 #if defined(CONFIG_TQM823M) || defined(CONFIG_TQM850M) || \
123     defined(CONFIG_TQM855M) || defined(CONFIG_TQM860M) || \
124     defined(CONFIG_TQM862M) || defined(CONFIG_TQM866M) || \
125     defined(CONFIG_TQM885D)
126 # ifndef CONFIG_TQM8xxM
127 #  define CONFIG_TQM8xxM
128 # endif
129 #endif
130 #if defined(CONFIG_TQM823L) || defined(CONFIG_TQM850L) || \
131     defined(CONFIG_TQM855L) || defined(CONFIG_TQM860L) || \
132     defined(CONFIG_TQM862L) || defined(CONFIG_TQM8xxM)
133 # ifndef CONFIG_TQM8xxL
134 #  define CONFIG_TQM8xxL
135 # endif
136 #endif
137
138 #ifndef CONFIG_SERIAL_MULTI
139
140 #if defined(CONFIG_8xx_CONS_SMC1) || defined(CONFIG_8xx_CONS_SMC2) \
141  || defined(CONFIG_8xx_CONS_SCC1) || defined(CONFIG_8xx_CONS_SCC2) \
142  || defined(CONFIG_8xx_CONS_SCC3) || defined(CONFIG_8xx_CONS_SCC4)
143
144 #define CONFIG_SERIAL_MULTI     1
145
146 #endif
147
148 #endif /* CONFIG_SERIAL_MULTI */
149
150 /*
151  * General Purpose Utilities
152  */
153 #define min(X, Y)                               \
154         ({ typeof (X) __x = (X), __y = (Y);     \
155                 (__x < __y) ? __x : __y; })
156
157 #define max(X, Y)                               \
158         ({ typeof (X) __x = (X), __y = (Y);     \
159                 (__x > __y) ? __x : __y; })
160
161
162 /*
163  * Function Prototypes
164  */
165
166 #ifdef CONFIG_SERIAL_SOFTWARE_FIFO
167 void    serial_buffered_init (void);
168 void    serial_buffered_putc (const char);
169 void    serial_buffered_puts (const char *);
170 int     serial_buffered_getc (void);
171 int     serial_buffered_tstc (void);
172 #endif /* CONFIG_SERIAL_SOFTWARE_FIFO */
173
174 void    hang            (void) __attribute__ ((noreturn));
175
176 /* */
177 long int initdram (int);
178 int     display_options (void);
179 void    print_size (ulong, const char *);
180
181 /* common/main.c */
182 void    main_loop       (void);
183 int     run_command     (const char *cmd, int flag);
184 int     readline        (const char *const prompt);
185 void    init_cmd_timeout(void);
186 void    reset_cmd_timeout(void);
187
188 /* lib_$(ARCH)/board.c */
189 void    board_init_f  (ulong);
190 void    board_init_r  (gd_t *, ulong);
191 int     checkboard    (void);
192 int     checkflash    (void);
193 int     checkdram     (void);
194 char *  strmhz(char *buf, long hz);
195 int     last_stage_init(void);
196 extern ulong monitor_flash_len;
197
198 /* common/flash.c */
199 void flash_perror (int);
200
201 /* common/cmd_autoscript.c */
202 int     autoscript (ulong addr);
203
204 /* common/cmd_bootm.c */
205 void    print_image_hdr (image_header_t *hdr);
206
207 extern ulong load_addr;         /* Default Load Address */
208
209 /* common/cmd_nvedit.c */
210 int     env_init     (void);
211 void    env_relocate (void);
212 char    *getenv      (char *);
213 int     getenv_r     (char *name, char *buf, unsigned len);
214 int     saveenv      (void);
215 #ifdef CONFIG_PPC               /* ARM version to be fixed! */
216 void inline setenv   (char *, char *);
217 #else
218 void    setenv       (char *, char *);
219 #endif /* CONFIG_PPC */
220 #ifdef CONFIG_ARM
221 # include <asm/mach-types.h>
222 # include <asm/setup.h>
223 # include <asm/u-boot-arm.h>    /* ARM version to be fixed! */
224 #endif /* CONFIG_ARM */
225 #ifdef CONFIG_I386              /* x86 version to be fixed! */
226 # include <asm/u-boot-i386.h>
227 #endif /* CONFIG_I386 */
228
229 #ifdef CONFIG_AUTO_COMPLETE
230 int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
231 #endif
232
233 void    pci_init      (void);
234 void    pci_init_board(void);
235 void    pciinfo       (int, int);
236
237 #if defined(CONFIG_PCI) && defined(CONFIG_440)
238 #   if defined(CFG_PCI_PRE_INIT)
239     int    pci_pre_init        (struct pci_controller * );
240 #   endif
241 #   if defined(CFG_PCI_TARGET_INIT)
242         void    pci_target_init      (struct pci_controller *);
243 #   endif
244 #   if defined(CFG_PCI_MASTER_INIT)
245         void    pci_master_init      (struct pci_controller *);
246 #   endif
247     int     is_pci_host         (struct pci_controller *);
248 #if defined(CONFIG_440SPE)
249    void pcie_setup_hoses(void);
250 #endif
251 #endif
252
253 int     misc_init_f   (void);
254 int     misc_init_r   (void);
255
256 /* common/exports.c */
257 void    jumptable_init(void);
258
259 /* common/memsize.c */
260 int     get_ram_size  (volatile long *, long);
261
262 /* $(BOARD)/$(BOARD).c */
263 void    reset_phy     (void);
264 void    fdc_hw_init   (void);
265
266 /* $(BOARD)/eeprom.c */
267 void eeprom_init  (void);
268 #ifndef CONFIG_SPI
269 int  eeprom_probe (unsigned dev_addr, unsigned offset);
270 #endif
271 int  eeprom_read  (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
272 int  eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
273 #ifdef CONFIG_LWMON
274 extern uchar pic_read  (uchar reg);
275 extern void  pic_write (uchar reg, uchar val);
276 #endif
277
278 /*
279  * Set this up regardless of board
280  * type, to prevent errors.
281  */
282 #if defined(CONFIG_SPI) || !defined(CFG_I2C_EEPROM_ADDR)
283 # define CFG_DEF_EEPROM_ADDR 0
284 #else
285 # define CFG_DEF_EEPROM_ADDR CFG_I2C_EEPROM_ADDR
286 #endif /* CONFIG_SPI || !defined(CFG_I2C_EEPROM_ADDR) */
287
288 #if defined(CONFIG_SPI)
289 extern void spi_init_f (void);
290 extern void spi_init_r (void);
291 extern ssize_t spi_read  (uchar *, int, uchar *, int);
292 extern ssize_t spi_write (uchar *, int, uchar *, int);
293 #endif
294
295 #ifdef CONFIG_RPXCLASSIC
296 void rpxclassic_init (void);
297 #endif
298
299 void rpxlite_init (void);
300
301 #ifdef CONFIG_MBX
302 /* $(BOARD)/mbx8xx.c */
303 void    mbx_init (void);
304 void    board_serial_init (void);
305 void    board_ether_init (void);
306 #endif
307
308 #if defined(CONFIG_RPXCLASSIC)  || defined(CONFIG_MBX) || \
309     defined(CONFIG_IAD210)      || defined(CONFIG_XPEDITE1K) || \
310     defined(CONFIG_METROBOX)    || defined(CONFIG_KAREF)
311 void    board_get_enetaddr (uchar *addr);
312 #endif
313
314 #ifdef CONFIG_HERMES
315 /* $(BOARD)/hermes.c */
316 void hermes_start_lxt980 (int speed);
317 #endif
318
319 #ifdef CONFIG_EVB64260
320 void  evb64260_init(void);
321 void  debug_led(int, int);
322 void  display_mem_map(void);
323 void  perform_soft_reset(void);
324 #endif
325
326 void    load_sernum_ethaddr (void);
327
328 /* $(BOARD)/$(BOARD).c */
329 int board_early_init_f (void);
330 int board_late_init (void);
331 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
332 int board_early_init_r (void);
333 void board_poweroff (void);
334
335 #if defined(CFG_DRAM_TEST)
336 int testdram(void);
337 #endif /* CFG_DRAM_TEST */
338
339 /* $(CPU)/start.S */
340 #if defined(CONFIG_5xx) || \
341     defined(CONFIG_8xx)
342 uint    get_immr      (uint);
343 #endif
344 uint    get_pir       (void);
345 #if defined(CONFIG_MPC5xxx)
346 uint    get_svr       (void);
347 #endif
348 uint    get_pvr       (void);
349 uint    get_svr       (void);
350 uint    rd_ic_cst     (void);
351 void    wr_ic_cst     (uint);
352 void    wr_ic_adr     (uint);
353 uint    rd_dc_cst     (void);
354 void    wr_dc_cst     (uint);
355 void    wr_dc_adr     (uint);
356 int     icache_status (void);
357 void    icache_enable (void);
358 void    icache_disable(void);
359 int     dcache_status (void);
360 void    dcache_enable (void);
361 void    dcache_disable(void);
362 void    relocate_code (ulong, gd_t *, ulong);
363 ulong   get_endaddr   (void);
364 void    trap_init     (ulong);
365 #if defined (CONFIG_4xx)        || \
366     defined (CONFIG_MPC5xxx)    || \
367     defined (CONFIG_74xx_7xx)   || \
368     defined (CONFIG_74x)        || \
369     defined (CONFIG_75x)        || \
370     defined (CONFIG_74xx)       || \
371     defined (CONFIG_MPC8220)    || \
372     defined (CONFIG_MPC85xx)    || \
373     defined (CONFIG_MPC83XX)
374 unsigned char   in8(unsigned int);
375 void            out8(unsigned int, unsigned char);
376 unsigned short  in16(unsigned int);
377 unsigned short  in16r(unsigned int);
378 void            out16(unsigned int, unsigned short value);
379 void            out16r(unsigned int, unsigned short value);
380 unsigned long   in32(unsigned int);
381 unsigned long   in32r(unsigned int);
382 void            out32(unsigned int, unsigned long value);
383 void            out32r(unsigned int, unsigned long value);
384 void            ppcDcbf(unsigned long value);
385 void            ppcDcbi(unsigned long value);
386 void            ppcSync(void);
387 void            ppcDcbz(unsigned long value);
388 #endif
389
390 /* $(CPU)/cpu.c */
391 int     checkcpu      (void);
392 int     checkicache   (void);
393 int     checkdcache   (void);
394 void    upmconfig     (unsigned int, unsigned int *, unsigned int);
395 ulong   get_tbclk     (void);
396 void    reset_cpu     (ulong addr);
397
398 /* $(CPU)/serial.c */
399 int     serial_init   (void);
400 void    serial_addr   (unsigned int);
401 void    serial_setbrg (void);
402 void    serial_putc   (const char);
403 void    serial_putc_raw(const char);
404 void    serial_puts   (const char *);
405 int     serial_getc   (void);
406 int     serial_tstc   (void);
407
408 void    _serial_setbrg (const int);
409 void    _serial_putc   (const char, const int);
410 void    _serial_putc_raw(const char, const int);
411 void    _serial_puts   (const char *, const int);
412 int     _serial_getc   (const int);
413 int     _serial_tstc   (const int);
414
415 /* $(CPU)/speed.c */
416 int     get_clocks (void);
417 int     get_clocks_866 (void);
418 int     sdram_adjust_866 (void);
419 int     adjust_sdram_tbs_8xx (void);
420 #if defined(CONFIG_8260)
421 int     prt_8260_clks (void);
422 #elif defined(CONFIG_MPC83XX)
423 int print_clock_conf(void);
424 #elif defined(CONFIG_MPC5xxx)
425 int     prt_mpc5xxx_clks (void);
426 #endif
427 #if defined(CONFIG_MPC8220)
428 int     prt_mpc8220_clks (void);
429 #endif
430 #ifdef CONFIG_4xx
431 ulong   get_OPB_freq (void);
432 ulong   get_PCI_freq (void);
433 #endif
434 #if defined(CONFIG_S3C2400) || defined(CONFIG_S3C2410) || defined(CONFIG_LH7A40X)
435 ulong   get_FCLK (void);
436 ulong   get_HCLK (void);
437 ulong   get_PCLK (void);
438 ulong   get_UCLK (void);
439 #endif
440 #if defined(CONFIG_LH7A40X)
441 ulong   get_PLLCLK (void);
442 #endif
443 #if defined CONFIG_INCA_IP
444 uint    incaip_get_cpuclk (void);
445 #endif
446 #if defined(CONFIG_IMX)
447 ulong get_systemPLLCLK(void);
448 ulong get_FCLK(void);
449 ulong get_HCLK(void);
450 ulong get_BCLK(void);
451 ulong get_PERCLK1(void);
452 ulong get_PERCLK2(void);
453 ulong get_PERCLK3(void);
454 #endif
455 ulong   get_bus_freq  (ulong);
456
457 #if defined(CONFIG_MPC85xx)
458 typedef MPC85xx_SYS_INFO sys_info_t;
459 void    get_sys_info  ( sys_info_t * );
460 #endif
461
462 #if defined(CONFIG_4xx) || defined(CONFIG_IOP480)
463 #  if defined(CONFIG_440)
464     typedef PPC440_SYS_INFO sys_info_t;
465 #       if defined(CONFIG_440SPE)
466          unsigned long determine_sysper(void);
467          unsigned long determine_pci_clock_per(void);
468          int ppc440spe_revB(void);
469 #       endif
470 #  else
471     typedef PPC405_SYS_INFO sys_info_t;
472 #  endif
473 void    get_sys_info  ( sys_info_t * );
474 #endif
475
476 /* $(CPU)/cpu_init.c */
477 #if defined(CONFIG_8xx) || defined(CONFIG_8260)
478 void    cpu_init_f    (volatile immap_t *immr);
479 #endif
480 #if defined(CONFIG_4xx) || defined(CONFIG_MPC85xx) || defined(CONFIG_MCF52x2)
481 void    cpu_init_f    (void);
482 #endif
483
484 int     cpu_init_r    (void);
485 #if defined(CONFIG_8260)
486 int     prt_8260_rsr  (void);
487 #endif
488
489 /* $(CPU)/interrupts.c */
490 int     interrupt_init     (void);
491 void    timer_interrupt    (struct pt_regs *);
492 void    external_interrupt (struct pt_regs *);
493 void    irq_install_handler(int, interrupt_handler_t *, void *);
494 void    irq_free_handler   (int);
495 void    reset_timer        (void);
496 ulong   get_timer          (ulong base);
497 void    set_timer          (ulong t);
498 void    enable_interrupts  (void);
499 int     disable_interrupts (void);
500
501 /* $(CPU)/.../commproc.c */
502 int     dpram_init (void);
503 uint    dpram_base(void);
504 uint    dpram_base_align(uint align);
505 uint    dpram_alloc(uint size);
506 uint    dpram_alloc_align(uint size,uint align);
507 void    post_word_store (ulong);
508 ulong   post_word_load (void);
509 void    bootcount_store (ulong);
510 ulong   bootcount_load (void);
511 #define BOOTCOUNT_MAGIC         0xB001C041
512
513 /* $(CPU)/.../<eth> */
514 void mii_init (void);
515
516 /* $(CPU)/.../lcd.c */
517 ulong   lcd_setmem (ulong);
518
519 /* $(CPU)/.../vfd.c */
520 ulong   vfd_setmem (ulong);
521
522 /* $(CPU)/.../video.c */
523 ulong   video_setmem (ulong);
524
525 /* lib_$(ARCH)/cache.c */
526 void    flush_cache   (unsigned long, unsigned long);
527
528
529 /* lib_$(ARCH)/ticks.S */
530 unsigned long long get_ticks(void);
531 void    wait_ticks    (unsigned long);
532
533 /* lib_$(ARCH)/time.c */
534 void    udelay        (unsigned long);
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 void    panic(const char *fmt, ...);
546 int     sprintf(char * buf, const char *fmt, ...);
547 int     vsprintf(char *buf, const char *fmt, va_list args);
548
549 /* lib_generic/crc32.c */
550 ulong crc32 (ulong, const unsigned char *, uint);
551 ulong crc32_no_comp (ulong, const unsigned char *, uint);
552
553 /* common/console.c */
554 int     console_init_f(void);   /* Before relocation; uses the serial  stuff    */
555 int     console_init_r(void);   /* After  relocation; uses the console stuff    */
556 int     console_assign (int file, char *devname);       /* Assign the console   */
557 int     ctrlc (void);
558 int     had_ctrlc (void);       /* have we had a Control-C since last clear? */
559 void    clear_ctrlc (void);     /* clear the Control-C condition */
560 int     disable_ctrlc (int);    /* 1 to disable, 0 to enable Control-C detect */
561
562 /*
563  * STDIO based functions (can always be used)
564  */
565
566 /* serial stuff */
567 void    serial_printf (const char *fmt, ...);
568
569 /* stdin */
570 int     getc(void);
571 int     tstc(void);
572
573 /* stdout */
574 void    putc(const char c);
575 void    puts(const char *s);
576 void    printf(const char *fmt, ...);
577 void    vprintf(const char *fmt, va_list args);
578
579 /* stderr */
580 #define eputc(c)                fputc(stderr, c)
581 #define eputs(s)                fputs(stderr, s)
582 #define eprintf(fmt,args...)    fprintf(stderr,fmt ,##args)
583
584 /*
585  * FILE based functions (can only be used AFTER relocation!)
586  */
587
588 #define stdin           0
589 #define stdout          1
590 #define stderr          2
591 #define MAX_FILES       3
592
593 void    fprintf(int file, const char *fmt, ...);
594 void    fputs(int file, const char *s);
595 void    fputc(int file, const char c);
596 int     ftstc(int file);
597 int     fgetc(int file);
598
599 int     pcmcia_init (void);
600
601 #ifdef CONFIG_SHOW_BOOT_PROGRESS
602 void    show_boot_progress (int status);
603 #endif
604
605 #ifdef CONFIG_INIT_CRITICAL
606 #error CONFIG_INIT_CRITICAL is depracted!
607 #error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
608 #endif
609
610 #endif  /* __COMMON_H_ */