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