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