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