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