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