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