dec_prom.h revision 1.23 1 /* $NetBSD: dec_prom.h,v 1.23 2011/02/20 07:50:25 matt Exp $ */
2
3 /*
4 * Copyright (c) 1992, 1993
5 * The Regents of the University of California. All rights reserved.
6 *
7 * This code is derived from software contributed to Berkeley by
8 * Ralph Campbell.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 *
34 * @(#)dec_prom.h 8.1 (Berkeley) 6/10/93
35 *
36 * machMon.h --
37 *
38 * Structures, constants and defines for access to the pmax prom.
39 *
40 * Copyright (C) 1989 Digital Equipment Corporation.
41 * Permission to use, copy, modify, and distribute this software and
42 * its documentation for any purpose and without fee is hereby granted,
43 * provided that the above copyright notice appears in all copies.
44 * Digital Equipment Corporation makes no representations about the
45 * suitability of this software for any purpose. It is provided "as is"
46 * without express or implied warranty.
47 *
48 * from: Header: /sprite/src/kernel/mach/ds3100.md/RCS/machMon.h,
49 * v 9.3 90/02/20 14:34:07 shirriff Exp SPRITE (Berkeley)
50 */
51
52 #ifndef _PMAX_DEC_PROM_H_
53 #define _PMAX_DEC_PROM_H_
54
55 /*
56 * This file was created based on information from the document
57 * "TURBOchannel Firmware Specification" (EK-TCAAD-FS-003)
58 * by Digital Equipment Corporation.
59 */
60
61 #ifndef _LOCORE
62 #include <sys/types.h>
63 #include <sys/cdefs.h>
64 #include <machine/int_types.h>
65
66 /*
67 * Programs loaded by the new PROMs pass the following arguments:
68 * a0 argc
69 * a1 argv
70 * a2 DEC_PROM_MAGIC
71 * a3 The callback vector defined below
72 */
73
74 #define DEC_PROM_MAGIC 0x30464354
75
76 typedef struct memmap {
77 int pagesize; /* system page size */
78 u_char bitmap[15360]; /* bit for each page indicating safe to use */
79 } memmap;
80
81 typedef struct {
82 int revision; /* hardware revision level */
83 int clk_period; /* clock period in nano seconds */
84 int slot_size; /* slot size in magabytes */
85 int io_timeout; /* I/O timeout in cycles */
86 int dma_range; /* DMA address range in megabytes */
87 int max_dma_burst; /* maximum DMA burst length */
88 int parity; /* true if system module supports T.C. parity */
89 int reserved[4];
90 } tcinfo;
91
92 typedef int jmp_buf[12];
93 typedef void (*psig_t)(int);
94
95 struct callback {
96 void *(*_memcpy)(void *, void *, int); /* 00 */
97 void *(*_memset)(void *, int, int); /* 04 */
98 char *(*_strcat)(char *, char *); /* 08 */
99 int (*_strcmp)(char *, char *); /* 0c */
100 char *(*_strcpy)(char *, char *); /* 10 */
101 int (*_strlen)(char *); /* 14 */
102 char *(*_strncat)(char *, char *, int); /* 18 */
103 char *(*_strncpy)(char *, char *, int); /* 1c */
104 int (*_strncmp)(char *, char *, int); /* 20 */
105 int (*_getchar)(void); /* 24 */
106 char *(*_gets)(char *); /* 28 */
107 int (*_puts)(char *); /* 2c */
108 int (*_printf)(const char *, ...); /* 30 */
109 int (*_sprintf)(char *, char *, ...); /* 34 */
110 int (*_io_poll)(void); /* 38 */
111 long (*_strtol)(char *, char **, int); /* 3c */
112 psig_t (*_signal)(int, psig_t); /* 40 */
113 int (*_raise)(int); /* 44 */
114 long (*_time)(long *); /* 48 */
115 int (*_setjmp)(jmp_buf); /* 4c */
116 void (*_longjmp)(jmp_buf, int); /* 50 */
117 int (*_bootinit)(char *); /* 54 */
118 int (*_bootread)(int, void *, int); /* 58 */
119 int (*_bootwrite)(int, void *, int); /* 5c */
120 int (*_setenv)(char *, char *); /* 60 */
121 char *(*_getenv)(const char *); /* 64 */
122 int (*_unsetenv)(char *); /* 68 */
123 u_long (*_slot_address)(int); /* 6c */
124 void (*_wbflush)(void); /* 70 */
125 void (*_msdelay)(int); /* 74 */
126 void (*_leds)(int); /* 78 */
127 void (*_clear_cache)(char *, int); /* 7c */
128 int (*_getsysid)(void); /* 80 */
129 int (*_getbitmap)(memmap *); /* 84 */
130 int (*_disableintr)(int); /* 88 */
131 int (*_enableintr)(int); /* 8c */
132 int (*_testintr)(int); /* 90 */
133 void *_reserved_data; /* 94 */
134 int (*_console_init)(void); /* 98 */
135 void (*_halt)(int *, int); /* 9c */
136 void (*_showfault)(void); /* a0 */
137 tcinfo *(*_gettcinfo)(void); /* XXX bogus proto */ /* a4 */
138 int (*_execute_cmd)(char *); /* a8 */
139 void (*_rex)(char); /* ac */
140 /* b0 to d4 reserved */
141 };
142
143 extern const struct callback *callv;
144 #ifdef _LP64
145 extern struct callback callvec;
146 #else
147 extern const struct callback callvec;
148 #endif
149
150 #ifdef _KERNEL
151 intptr_t promcall(void *, ...);
152 #endif
153
154 #if defined(_STANDALONE) && !defined(_NO_PROM_DEFINES)
155 #define memcpy (*callv -> _memcpy)
156 #define memset (*callv -> _memset)
157 #define strcat (*callv -> _strcat)
158 #define strcmp (*callv -> _strcmp)
159 #define strcpy (*callv -> _strcpy)
160 #define strlen (*callv -> _strlen)
161 #define strncat (*callv -> _strncat)
162 #define strncpy (*callv -> _strncpy)
163 #define strncmp (*callv -> _strncmp)
164 #define getchar (*callv -> _getchar)
165 #define gets (*callv -> _gets)
166 #define puts (*callv -> _puts)
167 #define printf (*callv -> _printf)
168 #define sprintf (*callv -> _sprintf)
169 #define io_poll (*callv -> _io_poll)
170 #define strtol (*callv -> _strtol)
171 #define raise (*callv -> _raise)
172 #define time (*callv -> _time)
173 #define setjmp (*callv -> _setjmp)
174 #define longjmp (*callv -> _longjmp)
175 #define bootinit (*callv -> _bootinit)
176 #define bootread (*callv -> _bootread)
177 #define bootwrite (*callv -> _bootwrite)
178 #define setenv (*callv -> _setenv)
179 #define getenv (*callv -> _getenv)
180 #define unsetenv (*callv -> _unsetenv)
181 #define wbflush (*callv -> _wbflush)
182 #define msdelay (*callv -> _msdelay)
183 #define leds (*callv -> _leds)
184 #define clear_cache (*callv -> _clear_cache)
185 #define getsysid (*callv -> _getsysid)
186 #define getbitmap (*callv -> _getbitmap)
187 #define disableintr (*callv -> _disableintr)
188 #define enableintr (*callv -> _enableintr)
189 #define testintr (*callv -> _testintr)
190 #define console_init (*callv -> _console_init)
191 #define halt (*callv -> _halt)
192 #define showfault (*callv -> _showfault)
193 #define gettcinfo (*callv -> _gettcinfo)
194 #define execute_cmd (*callv -> _execute_cmd)
195 #define rex (*callv -> _rex)
196
197 #define bzero(dst, len) memset(dst, 0, len)
198 /* XXX make sure that no calls to bcopy overlap! */
199 #define bcopy(src, dst, len) memcpy(dst, src, len)
200 #endif
201
202 /*
203 * The prom routines use the following structure to hold strings.
204 */
205 typedef struct {
206 char *argPtr[16]; /* Pointers to the strings. */
207 char strings[256]; /* Buffer for the strings. */
208 char *end; /* Pointer to end of used buf. */
209 int num; /* Number of strings used. */
210 } MachStringTable;
211
212 #endif /* _LOCORE */
213
214 /*
215 * The prom has a jump table at the beginning of it to get to its
216 * functions.
217 */
218 #define DEC_PROM_JUMP_TABLE_ADDR 0xBFC00000
219
220 /*
221 * Each entry in the jump table is 8 bytes - 4 for the jump and 4 for a nop.
222 */
223 #define DEC_PROM_FUNC_ADDR(funcNum) (DEC_PROM_JUMP_TABLE_ADDR+((funcNum)*8))
224
225 /*
226 * The functions:
227 *
228 * DEC_PROM_RESET Run diags, check bootmode, reinit.
229 * DEC_PROM_EXEC Load new program image.
230 * DEC_PROM_RESTART Re-enter monitor command loop.
231 * DEC_PROM_REINIT Re-init monitor, then cmd loop.
232 * DEC_PROM_REBOOT Check bootmode, no config.
233 * DEC_PROM_AUTOBOOT Autoboot the system.
234 *
235 * The following routines access PROM saio routines and may be used by
236 * standalone programs that would like to use PROM I/O:
237 *
238 * DEC_PROM_OPEN Open a file.
239 * DEC_PROM_READ Read from a file.
240 * DEC_PROM_WRITE Write to a file.
241 * DEC_PROM_IOCTL Iocontrol on a file.
242 * DEC_PROM_CLOSE Close a file.
243 * DEC_PROM_LSEEK Seek on a file.
244 * DEC_PROM_GETCHAR Get character from console.
245 * DEC_PROM_PUTCHAR Put character on console.
246 * DEC_PROM_SHOWCHAR Show a char visibly.
247 * DEC_PROM_GETS gets with editing.
248 * DEC_PROM_PUTS Put string to console.
249 * DEC_PROM_PRINTF Kernel style printf to console.
250 *
251 * PROM protocol entry points:
252 *
253 * DEC_PROM_INITPROTO Initialize protocol.
254 * DEC_PROM_PROTOENABLE Enable protocol mode.
255 * DEC_PROM_PROTODISABLE Disable protocol mode.
256 * DEC_PROM_GETPKT Get protocol packet.
257 * DEC_PROM_PUTPKT Put protocol packet.
258 *
259 * The following are other prom routines:
260 * DEC_PROM_FLUSHCACHE Flush entire cache ().
261 * DEC_PROM_CLEARCACHE Clear I & D cache in range (addr, len).
262 * DEC_PROM_SAVEREGS Save registers in a buffer.
263 * DEC_PROM_LOADREGS Get register back from buffer.
264 * DEC_PROM_JUMPS8 Jump to address in s8.
265 * DEC_PROM_GETENV2 Gets a string from system environment.
266 * DEC_PROM_SETENV2 Sets a string in system environment.
267 * DEC_PROM_ATONUM Converts ascii string to number.
268 * DEC_PROM_STRCMP Compares strings (strcmp).
269 * DEC_PROM_STRLEN Length of string (strlen).
270 * DEC_PROM_STRCPY Copies string (strcpy).
271 * DEC_PROM_STRCAT Appends string (strcat).
272 * DEC_PROM_GETCMD Gets a command.
273 * DEC_PROM_GETNUMS Gets numbers.
274 * DEC_PROM_ARGPARSE Parses string to argc,argv.
275 * DEC_PROM_HELP Help on prom commands.
276 * DEC_PROM_DUMP Dumps memory.
277 * DEC_PROM_SETENV Sets a string in system environment.
278 * DEC_PROM_UNSETENV Unsets a string in system environment
279 * DEC_PROM_PRINTENV Prints system environment
280 * DEC_PROM_JUMP2S8 Jumps to s8
281 * DEC_PROM_ENABLE Performs prom enable command.
282 * DEC_PROM_DISABLE Performs prom disable command.
283 * DEC_PROM_ZEROB Zeros a system buffer.
284 * DEC_PROM_HALT Handler for halt interrupt.
285 * DEC_PROM_STARTCVAX 58xx VAX Diagnostic Supervisor support.
286 */
287 #define DEC_PROM_RESET DEC_PROM_FUNC_ADDR(0)
288 #define DEC_PROM_EXEC DEC_PROM_FUNC_ADDR(1)
289 #define DEC_PROM_RESTART DEC_PROM_FUNC_ADDR(2)
290 #define DEC_PROM_REINIT DEC_PROM_FUNC_ADDR(3)
291 #define DEC_PROM_REBOOT DEC_PROM_FUNC_ADDR(4)
292 #define DEC_PROM_AUTOBOOT DEC_PROM_FUNC_ADDR(5)
293 #define DEC_PROM_OPEN DEC_PROM_FUNC_ADDR(6)
294 #define DEC_PROM_READ DEC_PROM_FUNC_ADDR(7)
295 #define DEC_PROM_WRITE DEC_PROM_FUNC_ADDR(8)
296 #define DEC_PROM_IOCTL DEC_PROM_FUNC_ADDR(9)
297 #define DEC_PROM_CLOSE DEC_PROM_FUNC_ADDR(10)
298 #define DEC_PROM_LSEEK DEC_PROM_FUNC_ADDR(11)
299 #define DEC_PROM_GETCHAR DEC_PROM_FUNC_ADDR(12)
300 #define DEC_PROM_PUTCHAR DEC_PROM_FUNC_ADDR(13)
301 #define DEC_PROM_SHOWCHAR DEC_PROM_FUNC_ADDR(14)
302 #define DEC_PROM_GETS DEC_PROM_FUNC_ADDR(15)
303 #define DEC_PROM_PUTS DEC_PROM_FUNC_ADDR(16)
304 #define DEC_PROM_PRINTF DEC_PROM_FUNC_ADDR(17)
305 #define DEC_PROM_INITPROTO DEC_PROM_FUNC_ADDR(18)
306 #define DEC_PROM_PROTOENABLE DEC_PROM_FUNC_ADDR(19)
307 #define DEC_PROM_PROTODISABLE DEC_PROM_FUNC_ADDR(20)
308 #define DEC_PROM_GETPKT DEC_PROM_FUNC_ADDR(21)
309 #define DEC_PROM_PUTPKT DEC_PROM_FUNC_ADDR(22)
310 #define DEC_PROM_FLUSHCACHE DEC_PROM_FUNC_ADDR(28)
311 #define DEC_PROM_CLEARCACHE DEC_PROM_FUNC_ADDR(29)
312 #define DEC_PROM_SAVEREGS DEC_PROM_FUNC_ADDR(30)
313 #define DEC_PROM_LOADREGS DEC_PROM_FUNC_ADDR(31)
314 #define DEC_PROM_JUMPS8 DEC_PROM_FUNC_ADDR(32)
315 #define DEC_PROM_GETENV2 DEC_PROM_FUNC_ADDR(33)
316 #define DEC_PROM_SETENV2 DEC_PROM_FUNC_ADDR(34)
317 #define DEC_PROM_ATONUM DEC_PROM_FUNC_ADDR(35)
318 #define DEC_PROM_STRCMP DEC_PROM_FUNC_ADDR(36)
319 #define DEC_PROM_STRLEN DEC_PROM_FUNC_ADDR(37)
320 #define DEC_PROM_STRCPY DEC_PROM_FUNC_ADDR(38)
321 #define DEC_PROM_STRCAT DEC_PROM_FUNC_ADDR(39)
322 #define DEC_PROM_GETCMD DEC_PROM_FUNC_ADDR(40)
323 #define DEC_PROM_GETNUMS DEC_PROM_FUNC_ADDR(41)
324 #define DEC_PROM_ARGPARSE DEC_PROM_FUNC_ADDR(42)
325 #define DEC_PROM_HELP DEC_PROM_FUNC_ADDR(43)
326 #define DEC_PROM_DUMP DEC_PROM_FUNC_ADDR(44)
327 #define DEC_PROM_SETENV DEC_PROM_FUNC_ADDR(45)
328 #define DEC_PROM_UNSETENV DEC_PROM_FUNC_ADDR(46)
329 #define DEC_PROM_PRINTENV DEC_PROM_FUNC_ADDR(47)
330 #define DEC_PROM_JUMP2S8 DEC_PROM_FUNC_ADDR(48)
331 #define DEC_PROM_ENABLE DEC_PROM_FUNC_ADDR(49)
332 #define DEC_PROM_DISABLE DEC_PROM_FUNC_ADDR(50)
333 #define DEC_PROM_ZEROB DEC_PROM_FUNC_ADDR(51)
334 #define DEC_PROM_HALT DEC_PROM_FUNC_ADDR(54)
335 #define DEC_PROM_STARTCVAX DEC_PROM_FUNC_ADDR(97)
336
337 /*
338 * The nonvolatile ram has a flag to indicate it is usable.
339 */
340 #define MACH_USE_NON_VOLATILE ((char *)0xbd0000c0)
341 #define MACH_NON_VOLATILE_FLAG 0x02
342
343 #define DEC_REX_MAGIC 0x30464354 /* REX Magic number */
344
345 #endif /* !_PMAX_DEC_PROM_H_ */
346