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