xref: /netbsd/sys/arch/pmax/include/dec_prom.h (revision 6b63c739)
1 /*
2  * Copyright (c) 1992, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * Ralph Campbell.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *	This product includes software developed by the University of
19  *	California, Berkeley and its contributors.
20  * 4. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *	from: @(#)dec_prom.h	8.1 (Berkeley) 6/10/93
37  *      $Id: dec_prom.h,v 1.3 1994/05/27 09:05:13 glass Exp $
38  *
39  * machMon.h --
40  *
41  *	Structures, constants and defines for access to the pmax prom.
42  *
43  *	Copyright (C) 1989 Digital Equipment Corporation.
44  *	Permission to use, copy, modify, and distribute this software and
45  *	its documentation for any purpose and without fee is hereby granted,
46  *	provided that the above copyright notice appears in all copies.
47  *	Digital Equipment Corporation makes no representations about the
48  *	suitability of this software for any purpose.  It is provided "as is"
49  *	without express or implied warranty.
50  *
51  * from: Header: /sprite/src/kernel/mach/ds3100.md/RCS/machMon.h,
52  *	v 9.3 90/02/20 14:34:07 shirriff Exp  SPRITE (Berkeley)
53  */
54 
55 #ifndef _DEC_PROM
56 #define _DEC_PROM
57 
58 /*
59  * This file was created based on information from the document
60  * "TURBOchannel Firmware Specification" (EK-TCAAD-FS-003)
61  * by Digital Equipment Corporation.
62  */
63 
64 #ifndef LOCORE
65 #include <sys/types.h>
66 #include <sys/cdefs.h>
67 
68 /*
69  * Programs loaded by the new PROMs pass the following arguments:
70  *	a0	argc
71  *	a1	argv
72  *	a2	DEC_PROM_MAGIC
73  *	a3	The callback vector defined below
74  */
75 
76 #define DEC_PROM_MAGIC	0x30464354
77 
78 typedef struct {
79 	int	pagesize;	/* system page size */
80 	u_char	*bitmap;	/* bit for each page indicating safe to use */
81 } memmap;
82 
83 typedef struct {
84 	int	revision;	/* hardware revision level */
85 	int	clk_period;	/* clock period in nano seconds */
86 	int	slot_size;	/* slot size in magabytes */
87 	int	io_timeout;	/* I/O timeout in cycles
88 	int	dma_range;	/* DMA address range in megabytes */
89 	int	max_dma_burst;	/* maximum DMA burst length */
90 	int	parity;		/* true if system module supports T.C. parity */
91 	int	reserved[4];
92 } tcinfo;
93 
94 typedef int jmp_buf[12];
95 typedef void (*psig_t)(int);
96 
97 struct callback {
98 	void	*(*memcpy) __P((void *s1, void *s2, int n));		/* 00 */
99 	void	*(*memset) __P((void *s1, int c, int n));		/* 04 */
100 	char	*(*strcat) __P((char *s1, char *s2));			/* 08 */
101 	int	(*strcmp) __P((char *s1, char *s2));			/* 0c */
102 	char	*(*strcpy) __P((char *s1, char *s2));			/* 10 */
103 	int	(*strlen) __P((char *s1));				/* 14 */
104 	char	*(*strncat) __P((char *s1, char *s2, int n));		/* 18 */
105 	char	*(*strncpy) __P((char *s1, char *s2, int n));		/* 1c */
106 	int	(*strncmp) __P((char *s1, char *s2, int n));		/* 20 */
107 	int	(*getchar) __P((void));					/* 24 */
108 	char	*(*gets) __P((char *s));				/* 28 */
109 	int	(*puts) __P((char *s));					/* 2c */
110 	int	(*printf) __P((char *fmt, ...));			/* 30 */
111 	int	(*sprintf) __P((char *s, char *fmt, ...));		/* 34 */
112 	int	(*io_poll) __P((void));					/* 38 */
113 	long	(*strtol) __P((char *s, char **endptr, int base));	/* 3c */
114 	psig_t	(*signal) __P((int sig, psig_t func));			/* 40 */
115 	int	(*raise) __P((int sig));				/* 44 */
116 	long	(*time) __P((long *tod));				/* 48 */
117 	int	(*setjmp) __P((jmp_buf env));				/* 4c */
118 	void	(*longjmp) __P((jmp_buf env, int value));		/* 50 */
119 	int	(*bootinit) __P((void));				/* 54 */
120 	int	(*bootread) __P((int b, void *buffer, int n));		/* 58 */
121 	int	(*bootwrite) __P((int b, void *buffer, int n));		/* 5c */
122 	int	(*setenv) __P((char *name, char *value));		/* 60 */
123 	char	*(*getenv) __P((char *name));				/* 64 */
124 	int	(*unsetenv) __P((char *name));				/* 68 */
125 	u_long	(*slot_address) __P((int sn));				/* 6c */
126 	void	(*wbflush) __P((void));					/* 70 */
127 	void	(*msdelay) __P((int delay));				/* 74 */
128 	void	(*leds) __P((int value));				/* 78 */
129 	void	(*clear_cache) __P((void));				/* 7c */
130 	int	(*getsysid) __P((void));				/* 80 */
131 	int	(*getbitmap) __P((memmap *map));			/* 84 */
132 	int	(*disableintr) __P((int sn));				/* 88 */
133 	int	(*enableintr) __P((int sn));				/* 8c */
134 	int	(*testintr) __P((int sn));				/* 90 */
135 	void	*reserved_data;						/* 94 */
136 	int	(*console_init) __P((void));				/* 98 */
137 	void	(*halt) __P((int *v, int cnt));				/* 9c */
138 	void	(*showfault) __P((void));				/* a0 */
139 	tcinfo	*(*gettcinfo) __P(());					/* a4 */
140 	int	(*execute_cmd) __P((char *cmd));			/* a8 */
141 	void	(*rex) __P((char cmd));					/* ac */
142 	/* b0 to d4 reserved */
143 };
144 
145 extern const struct callback *callv;
146 extern const struct callback callvec;
147 
148 /*
149  * The prom routines use the following structure to hold strings.
150  */
151 typedef struct {
152 	char	*argPtr[16];	/* Pointers to the strings. */
153 	char	strings[256];	/* Buffer for the strings. */
154 	char	*end;		/* Pointer to end of used buf. */
155 	int 	num;		/* Number of strings used. */
156 } MachStringTable;
157 
158 #endif /* LOCORE */
159 
160 /*
161  * The prom has a jump table at the beginning of it to get to its
162  * functions.
163  */
164 #define DEC_PROM_JUMP_TABLE_ADDR	0xBFC00000
165 
166 /*
167  * Each entry in the jump table is 8 bytes - 4 for the jump and 4 for a nop.
168  */
169 #define DEC_PROM_FUNC_ADDR(funcNum)	(DEC_PROM_JUMP_TABLE_ADDR+((funcNum)*8))
170 
171 /*
172  * The functions:
173  *
174  *	DEC_PROM_RESET		Run diags, check bootmode, reinit.
175  *	DEC_PROM_EXEC		Load new program image.
176  *	DEC_PROM_RESTART	Re-enter monitor command loop.
177  *	DEC_PROM_REINIT		Re-init monitor, then cmd loop.
178  *	DEC_PROM_REBOOT		Check bootmode, no config.
179  *	DEC_PROM_AUTOBOOT	Autoboot the system.
180  *
181  * The following routines access PROM saio routines and may be used by
182  * standalone programs that would like to use PROM I/O:
183  *
184  *	DEC_PROM_OPEN		Open a file.
185  *	DEC_PROM_READ		Read from a file.
186  *	DEC_PROM_WRITE		Write to a file.
187  *	DEC_PROM_IOCTL		Iocontrol on a file.
188  *	DEC_PROM_CLOSE		Close a file.
189  *	DEC_PROM_LSEEK		Seek on a file.
190  *	DEC_PROM_GETCHAR	Get character from console.
191  *	DEC_PROM_PUTCHAR	Put character on console.
192  *	DEC_PROM_SHOWCHAR	Show a char visibly.
193  *	DEC_PROM_GETS		gets with editing.
194  *	DEC_PROM_PUTS		Put string to console.
195  *	DEC_PROM_PRINTF		Kernel style printf to console.
196  *
197  * The following are other prom routines:
198  *	DEC_PROM_FLUSHCACHE	Flush entire cache ().
199  *	DEC_PROM_CLEARCACHE	Clear I & D cache in range (addr, len).
200  *	DEC_PROM_SAVEREGS	Save registers in a buffer.
201  *	DEC_PROM_LOADREGS	Get register back from buffer.
202  *	DEC_PROM_JUMPS8		Jump to address in s8.
203  *	DEC_PROM_GETENV2	Gets a string from system environment.
204  *	DEC_PROM_SETENV2	Sets a string in system environment.
205  *	DEC_PROM_ATONUM		Converts ascii string to number.
206  *	DEC_PROM_STRCMP		Compares strings (strcmp).
207  *	DEC_PROM_STRLEN		Length of string (strlen).
208  *	DEC_PROM_STRCPY		Copies string (strcpy).
209  *	DEC_PROM_STRCAT		Appends string (strcat).
210  *	DEC_PROM_GETCMD		Gets a command.
211  *	DEC_PROM_GETNUMS	Gets numbers.
212  *	DEC_PROM_ARGPARSE	Parses string to argc,argv.
213  *	DEC_PROM_HELP		Help on prom commands.
214  *	DEC_PROM_DUMP		Dumps memory.
215  *	DEC_PROM_SETENV		Sets a string in system environment.
216  *	DEC_PROM_UNSETENV	Unsets a string in system environment
217  *	DEC_PROM_PRINTENV	Prints system environment
218  *	DEC_PROM_JUMP2S8	Jumps to s8
219  *	DEC_PROM_ENABLE		Performs prom enable command.
220  *	DEC_PROM_DISABLE	Performs prom disable command.
221  *	DEC_PROM_ZEROB		Zeros a system buffer.
222  */
223 #define DEC_PROM_RESET		DEC_PROM_FUNC_ADDR(0)
224 #define DEC_PROM_EXEC		DEC_PROM_FUNC_ADDR(1)
225 #define DEC_PROM_RESTART	DEC_PROM_FUNC_ADDR(2)
226 #define DEC_PROM_REINIT		DEC_PROM_FUNC_ADDR(3)
227 #define DEC_PROM_REBOOT		DEC_PROM_FUNC_ADDR(4)
228 #define DEC_PROM_AUTOBOOT	DEC_PROM_FUNC_ADDR(5)
229 #define DEC_PROM_OPEN		DEC_PROM_FUNC_ADDR(6)
230 #define DEC_PROM_READ		DEC_PROM_FUNC_ADDR(7)
231 #define DEC_PROM_WRITE		DEC_PROM_FUNC_ADDR(8)
232 #define DEC_PROM_IOCTL		DEC_PROM_FUNC_ADDR(9)
233 #define DEC_PROM_CLOSE		DEC_PROM_FUNC_ADDR(10)
234 #define DEC_PROM_LSEEK		DEC_PROM_FUNC_ADDR(11)
235 #define DEC_PROM_GETCHAR	DEC_PROM_FUNC_ADDR(12)
236 #define DEC_PROM_PUTCHAR	DEC_PROM_FUNC_ADDR(13)
237 #define DEC_PROM_SHOWCHAR	DEC_PROM_FUNC_ADDR(14)
238 #define DEC_PROM_GETS		DEC_PROM_FUNC_ADDR(15)
239 #define DEC_PROM_PUTS		DEC_PROM_FUNC_ADDR(16)
240 #define DEC_PROM_PRINTF		DEC_PROM_FUNC_ADDR(17)
241 #define DEC_PROM_FLUSHCACHE	DEC_PROM_FUNC_ADDR(28)
242 #define DEC_PROM_CLEARCACHE	DEC_PROM_FUNC_ADDR(29)
243 #define DEC_PROM_SAVEREGS	DEC_PROM_FUNC_ADDR(30)
244 #define DEC_PROM_LOADREGS	DEC_PROM_FUNC_ADDR(31)
245 #define DEC_PROM_JUMPS8		DEC_PROM_FUNC_ADDR(32)
246 #define DEC_PROM_GETENV2	DEC_PROM_FUNC_ADDR(33)
247 #define DEC_PROM_SETENV2	DEC_PROM_FUNC_ADDR(34)
248 #define DEC_PROM_ATONUM		DEC_PROM_FUNC_ADDR(35)
249 #define DEC_PROM_STRCMP		DEC_PROM_FUNC_ADDR(36)
250 #define DEC_PROM_STRLEN		DEC_PROM_FUNC_ADDR(37)
251 #define DEC_PROM_STRCPY		DEC_PROM_FUNC_ADDR(38)
252 #define DEC_PROM_STRCAT		DEC_PROM_FUNC_ADDR(39)
253 #define DEC_PROM_GETCMD		DEC_PROM_FUNC_ADDR(40)
254 #define DEC_PROM_GETNUMS	DEC_PROM_FUNC_ADDR(41)
255 #define DEC_PROM_ARGPARSE	DEC_PROM_FUNC_ADDR(42)
256 #define DEC_PROM_HELP		DEC_PROM_FUNC_ADDR(43)
257 #define DEC_PROM_DUMP		DEC_PROM_FUNC_ADDR(44)
258 #define DEC_PROM_SETENV		DEC_PROM_FUNC_ADDR(45)
259 #define DEC_PROM_UNSETENV	DEC_PROM_FUNC_ADDR(46)
260 #define DEC_PROM_PRINTENV	DEC_PROM_FUNC_ADDR(47)
261 #define DEC_PROM_JUMP2S8	DEC_PROM_FUNC_ADDR(48)
262 #define DEC_PROM_ENABLE		DEC_PROM_FUNC_ADDR(49)
263 #define DEC_PROM_DISABLE	DEC_PROM_FUNC_ADDR(50)
264 #define DEC_PROM_ZEROB		DEC_PROM_FUNC_ADDR(51)
265 
266 /*
267  * The nonvolatile ram has a flag to indicate it is usable.
268  */
269 #define MACH_USE_NON_VOLATILE 	((char *)0xbd0000c0)
270 #define MACH_NON_VOLATILE_FLAG	0x02
271 
272 #endif /* _DEC_PROM */
273