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