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