oldmon.h revision 1.14 1 1.14 christos /* $NetBSD: oldmon.h,v 1.14 2005/05/31 00:54:05 christos Exp $ */
2 1.4 deraadt
3 1.1 deraadt /*
4 1.1 deraadt * Copyright (C) 1985 Regents of the University of California
5 1.1 deraadt * Copyright (c) 1993 Adam Glass
6 1.1 deraadt * All rights reserved.
7 1.1 deraadt *
8 1.1 deraadt * Redistribution and use in source and binary forms, with or without
9 1.1 deraadt * modification, are permitted provided that the following conditions
10 1.1 deraadt * are met:
11 1.1 deraadt * 1. Redistributions of source code must retain the above copyright
12 1.1 deraadt * notice, this list of conditions and the following disclaimer.
13 1.1 deraadt * 2. Redistributions in binary form must reproduce the above copyright
14 1.1 deraadt * notice, this list of conditions and the following disclaimer in the
15 1.1 deraadt * documentation and/or other materials provided with the distribution.
16 1.1 deraadt * 3. All advertising materials mentioning features or use of this software
17 1.1 deraadt * must display the following acknowledgement:
18 1.1 deraadt * This product includes software developed by Adam Glass.
19 1.1 deraadt * 4. The name of the Author may not be used to endorse or promote products
20 1.1 deraadt * derived from this software without specific prior written permission.
21 1.1 deraadt *
22 1.1 deraadt * THIS SOFTWARE IS PROVIDED BY Adam Glass ``AS IS'' AND
23 1.1 deraadt * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 1.1 deraadt * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 1.1 deraadt * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 1.1 deraadt * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 1.1 deraadt * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 1.1 deraadt * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 1.1 deraadt * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 1.1 deraadt * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 1.1 deraadt * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 1.1 deraadt * SUCH DAMAGE.
33 1.1 deraadt *
34 1.1 deraadt * from: Sprite /cdrom/src/kernel/Cvsroot/kernel/mach/sun3.md/machMon.h,v
35 1.1 deraadt * 9.1 90/10/03 13:52:34 mgbaker Exp SPRITE (Berkeley)
36 1.1 deraadt */
37 1.1 deraadt #ifndef _MACHINE_OLDMON_H
38 1.1 deraadt #define _MACHINE_OLDMON_H
39 1.13 darrenr
40 1.13 darrenr #if defined(_KERNEL_OPT)
41 1.13 darrenr #include "opt_sparc_arch.h"
42 1.13 darrenr #endif
43 1.1 deraadt
44 1.1 deraadt /*
45 1.1 deraadt * Structures, constants and defines for access to the sun monitor.
46 1.1 deraadt * These are translated from the sun monitor header file "sunromvec.h".
47 1.1 deraadt *
48 1.1 deraadt * The memory addresses for the PROM, and the EEPROM.
49 1.1 deraadt * On the sun2 these addresses are actually 0x00EF??00
50 1.1 deraadt * but only the bottom 24 bits are looked at so these still
51 1.1 deraadt * work ok.
52 1.1 deraadt */
53 1.1 deraadt #define PROM_BASE 0xffe81000
54 1.1 deraadt
55 1.5 pk enum maptypes { /* Page map entry types. */
56 1.5 pk MAP_MAINMEM,
57 1.5 pk MAP_OBIO,
58 1.5 pk MAP_MBMEM,
59 1.5 pk MAP_MBIO,
60 1.5 pk MAP_VME16A16D,
61 1.5 pk MAP_VME16A32D,
62 1.5 pk MAP_VME24A16D,
63 1.5 pk MAP_VME24A32D,
64 1.5 pk MAP_VME32A16D,
65 1.5 pk MAP_VME32A32D
66 1.5 pk };
67 1.5 pk /*
68 1.5 pk * This table gives information about the resources needed by a device.
69 1.5 pk */
70 1.5 pk struct devinfo {
71 1.5 pk unsigned int d_devbytes; /* Bytes occupied by device in IO space.*/
72 1.5 pk unsigned int d_dmabytes; /* Bytes needed by device in DMA memory.*/
73 1.5 pk unsigned int d_localbytes;/* Bytes needed by device for local info.*/
74 1.5 pk unsigned int d_stdcount; /* How many standard addresses. */
75 1.5 pk unsigned long *d_stdaddrs; /* The vector of standard addresses. */
76 1.5 pk enum maptypes d_devtype; /* What map space device is in. */
77 1.5 pk unsigned int d_maxiobytes;/* Size to break big I/O's into. */
78 1.5 pk };
79 1.5 pk
80 1.1 deraadt /*
81 1.9 pk * A "stand alone I/O request".
82 1.9 pk * This is passed as the main argument to the PROM I/O routines
83 1.9 pk * in the `om_boottable' structure.
84 1.9 pk */
85 1.9 pk struct saioreq {
86 1.9 pk char si_flgs;
87 1.9 pk struct om_boottable *si_boottab;/* Points to boottab entry if any */
88 1.9 pk char *si_devdata; /* Device-specific data pointer */
89 1.9 pk int si_ctlr; /* Controller number or address */
90 1.9 pk int si_unit; /* Unit number within controller */
91 1.9 pk long si_boff; /* Partition number within unit */
92 1.9 pk long si_cyloff;
93 1.9 pk long si_offset;
94 1.9 pk long si_bn; /* Block number to R/W */
95 1.9 pk char *si_ma; /* Memory address to R/W */
96 1.9 pk int si_cc; /* Character count to R/W */
97 1.9 pk struct saif *si_sif; /* net if. pointer (set by b_open) */
98 1.9 pk char *si_devaddr; /* Points to mapped in device */
99 1.9 pk char *si_dmaaddr; /* Points to allocated DMA space */
100 1.9 pk };
101 1.9 pk #define SAIO_F_READ 0x01
102 1.9 pk #define SAIO_F_WRITE 0x02
103 1.9 pk #define SAIO_F_ALLOC 0x04
104 1.9 pk #define SAIO_F_FILE 0x08
105 1.9 pk #define SAIO_F_EOF 0x10 /* EOF on device */
106 1.9 pk #define SAIO_F_AJAR 0x20 /* Descriptor "ajar" (stopped but not closed) */
107 1.9 pk
108 1.9 pk
109 1.9 pk /*
110 1.1 deraadt * The table entry that describes a device. It exists in the PROM; a
111 1.1 deraadt * pointer to it is passed in MachMonBootParam. It can be used to locate
112 1.1 deraadt * PROM subroutines for opening, reading, and writing the device.
113 1.1 deraadt *
114 1.1 deraadt * When using this interface, only one device can be open at once.
115 1.1 deraadt *
116 1.11 pk * NOTE: I am not sure what arguments boot, open, close, and strategy take.
117 1.11 pk * What is here is just translated verbatim from the sun monitor code. We
118 1.1 deraadt * should figure this out eventually if we need it.
119 1.1 deraadt */
120 1.1 deraadt struct om_boottable {
121 1.5 pk char b_devname[2]; /* The name of the device */
122 1.11 pk int (*b_probe) __P((void)); /* probe() --> -1 or found controller
123 1.1 deraadt number */
124 1.6 christos int (*b_boot) __P((void)); /* boot(bp) --> -1 or start address */
125 1.9 pk int (*b_open)
126 1.9 pk __P((struct saioreq *));/* open(iobp) --> -1 or 0 */
127 1.9 pk int (*b_close)
128 1.9 pk __P((struct saioreq *));/* close(iobp) --> -1 or 0 */
129 1.9 pk int (*b_strategy)
130 1.9 pk __P((struct saioreq *, int));/* strategy(iobp,rw) --> -1 or 0 */
131 1.5 pk char *b_desc; /* Printable string describing dev */
132 1.5 pk struct devinfo *b_devinfo; /* info to configure device. */
133 1.1 deraadt };
134 1.1 deraadt
135 1.1 deraadt /*
136 1.1 deraadt * Structure set up by the boot command to pass arguments to the program that
137 1.1 deraadt * is booted.
138 1.1 deraadt */
139 1.1 deraadt struct om_bootparam {
140 1.1 deraadt char *argPtr[8]; /* String arguments */
141 1.1 deraadt char strings[100]; /* String table for string arguments */
142 1.1 deraadt char devName[2]; /* Device name */
143 1.1 deraadt int ctlrNum; /* Controller number */
144 1.1 deraadt int unitNum; /* Unit number */
145 1.1 deraadt int partNum; /* Partition/file number */
146 1.1 deraadt char *fileName; /* File name, points into strings */
147 1.1 deraadt struct om_boottable *bootTable; /* Points to table entry for device */
148 1.1 deraadt };
149 1.1 deraadt
150 1.1 deraadt /*
151 1.1 deraadt * Here is the structure of the vector table which is at the front of the boot
152 1.1 deraadt * rom. The functions defined in here are explained below.
153 1.1 deraadt *
154 1.1 deraadt * NOTE: This struct has references to the structures keybuf and globram which
155 1.1 deraadt * I have not translated. If anyone needs to use these they should
156 1.1 deraadt * translate these structs into Sprite format.
157 1.1 deraadt */
158 1.1 deraadt struct om_vector {
159 1.1 deraadt char *initSp; /* Initial system stack ptr for hardware */
160 1.6 christos int (*startMon) __P((void));/* Initial PC for hardware */
161 1.1 deraadt int *diagberr; /* Bus err handler for diags */
162 1.1 deraadt
163 1.1 deraadt /* Monitor and hardware revision and identification */
164 1.1 deraadt struct om_bootparam **bootParam; /* Info for bootstrapped pgm */
165 1.1 deraadt u_long *memorySize; /* Usable memory in bytes */
166 1.1 deraadt
167 1.1 deraadt /* Single-character input and output */
168 1.6 christos int (*getChar) __P((void)); /* Get char from input source */
169 1.6 christos void (*putChar) __P((int)); /* Put char to output sink */
170 1.6 christos int (*mayGet) __P((void)); /* Maybe get char, or -1 */
171 1.6 christos int (*mayPut) __P((int)); /* Maybe put char, or -1 */
172 1.1 deraadt u_char *echo; /* Should getchar echo? */
173 1.1 deraadt u_char *inSource; /* Input source selector */
174 1.1 deraadt u_char *outSink; /* Output sink selector */
175 1.1 deraadt #define PROMDEV_KBD 0 /* input from keyboard */
176 1.1 deraadt #define PROMDEV_SCREEN 0 /* output to screen */
177 1.1 deraadt #define PROMDEV_TTYA 1 /* in/out to ttya */
178 1.1 deraadt #define PROMDEV_TTYB 2 /* in/out to ttyb */
179 1.1 deraadt
180 1.1 deraadt /* Keyboard input (scanned by monitor nmi routine) */
181 1.6 christos int (*getKey) __P((void)); /* Get next key if one exists */
182 1.6 christos int (*initGetKey) __P((void));/* Initialize get key */
183 1.1 deraadt u_int *translation; /* Kbd translation selector */
184 1.1 deraadt u_char *keyBid; /* Keyboard ID byte */
185 1.1 deraadt int *screen_x; /* V2: Screen x pos (R/O) */
186 1.1 deraadt int *screen_y; /* V2: Screen y pos (R/O) */
187 1.1 deraadt struct keybuf *keyBuf; /* Up/down keycode buffer */
188 1.1 deraadt
189 1.1 deraadt /* Monitor revision level. */
190 1.1 deraadt char *monId;
191 1.1 deraadt
192 1.1 deraadt /* Frame buffer output and terminal emulation */
193 1.6 christos int (*fbWriteChar) __P((void));/* Write a character to FB */
194 1.1 deraadt int *fbAddr; /* Address of frame buffer */
195 1.1 deraadt char **font; /* Font table for FB */
196 1.14 christos void (*fbWriteStr) __P((const char *, int));
197 1.6 christos /* Quickly write string to FB */
198 1.1 deraadt
199 1.1 deraadt /* Reboot interface routine -- resets and reboots system. */
200 1.14 christos void (*reBoot) __P((const char *)) /* e.g. reBoot("xy()vmunix") */
201 1.12 pk __attribute__((__noreturn__));
202 1.1 deraadt
203 1.1 deraadt /* Line input and parsing */
204 1.1 deraadt u_char *lineBuf; /* The line input buffer */
205 1.1 deraadt u_char **linePtr; /* Cur pointer into linebuf */
206 1.1 deraadt int *lineSize; /* length of line in linebuf */
207 1.6 christos int (*getLine) __P((void)); /* Get line from user */
208 1.6 christos u_char (*getNextChar) __P((void));/* Get next char from linebuf */
209 1.6 christos u_char (*peekNextChar) __P((void));/* Peek at next char */
210 1.1 deraadt int *fbThere; /* =1 if frame buffer there */
211 1.6 christos int (*getNum) __P((void)); /* Grab hex num from line */
212 1.1 deraadt
213 1.1 deraadt /* Print formatted output to current output sink */
214 1.6 christos int (*printf) __P((void)); /* Similar to "Kernel printf" */
215 1.6 christos int (*printHex) __P((void));/* Format N digits in hex */
216 1.1 deraadt
217 1.1 deraadt /* Led stuff */
218 1.1 deraadt u_char *leds; /* RAM copy of LED register */
219 1.6 christos int (*setLeds) __P((void)); /* Sets LED's and RAM copy */
220 1.1 deraadt
221 1.11 pk /* Non-maskable interrupt (nmi) information */
222 1.6 christos int (*nmiAddr) __P((void)); /* Addr for level 7 vector */
223 1.6 christos void (*abortEntry) __P((void));/* Entry for keyboard abort */
224 1.1 deraadt int *nmiClock; /* Counts up in msec */
225 1.1 deraadt
226 1.1 deraadt /* Frame buffer type: see <machine/fbio.h> */
227 1.1 deraadt int *fbType;
228 1.1 deraadt
229 1.1 deraadt /* Assorted other things */
230 1.11 pk u_long romvecVersion; /* Version # of Romvec */
231 1.1 deraadt struct globram *globRam; /* monitor global variables */
232 1.1 deraadt caddr_t kbdZscc; /* Addr of keyboard in use */
233 1.1 deraadt
234 1.1 deraadt int *keyrInit; /* ms before kbd repeat */
235 1.1 deraadt u_char *keyrTick; /* ms between repetitions */
236 1.1 deraadt u_long *memoryAvail; /* V1: Main mem usable size */
237 1.1 deraadt long *resetAddr; /* where to jump on a reset */
238 1.1 deraadt long *resetMap; /* pgmap entry for resetaddr */
239 1.1 deraadt /* Really struct pgmapent * */
240 1.1 deraadt
241 1.12 pk __dead void (*exitToMon) __P((void)) /* Exit from user program */
242 1.12 pk __attribute__((noreturn));
243 1.1 deraadt u_char **memorybitmap; /* V1: &{0 or &bits} */
244 1.7 christos void (*setcxsegmap) /* Set seg in any context */
245 1.8 christos __P((int, caddr_t, int));
246 1.10 christos void (**vector_cmd) __P((u_long, char *));/* V2: Handler for 'v' cmd */
247 1.1 deraadt u_long *ExpectedTrapSig;
248 1.1 deraadt u_long *TrapVectorTable;
249 1.1 deraadt int dummy1z;
250 1.1 deraadt int dummy2z;
251 1.1 deraadt int dummy3z;
252 1.1 deraadt int dummy4z;
253 1.1 deraadt };
254 1.1 deraadt
255 1.1 deraadt #define romVectorPtr ((struct om_vector *)PROM_BASE)
256 1.1 deraadt
257 1.1 deraadt #define mon_printf (romVectorPtr->printf)
258 1.1 deraadt #define mon_putchar (romVectorPtr->putChar)
259 1.1 deraadt #define mon_may_getchar (romVectorPtr->mayGet)
260 1.1 deraadt #define mon_exit_to_mon (romVectorPtr->exitToMon)
261 1.1 deraadt #define mon_reboot (romVectorPtr->exitToMon)
262 1.1 deraadt #define mon_panic(x) { mon_printf(x); mon_exit_to_mon();}
263 1.1 deraadt
264 1.1 deraadt #define mon_setcxsegmap(context, va, sme) \
265 1.1 deraadt romVectorPtr->setcxsegmap(context, va, sme)
266 1.1 deraadt
267 1.1 deraadt /*
268 1.3 deraadt * OLDMON_STARTVADDR and OLDMON_ENDVADDR denote the range of the damn monitor.
269 1.11 pk *
270 1.1 deraadt * supposedly you can steal pmegs within this range that do not contain
271 1.11 pk * valid pages.
272 1.1 deraadt */
273 1.3 deraadt #define OLDMON_STARTVADDR 0xFFD00000
274 1.3 deraadt #define OLDMON_ENDVADDR 0xFFF00000
275 1.1 deraadt
276 1.1 deraadt /*
277 1.1 deraadt * These describe the monitor's short segment which it basically uses to map
278 1.1 deraadt * one stupid page that it uses for storage. MONSHORTPAGE is the page,
279 1.1 deraadt * and MONSHORTSEG is the segment that it is in. If this sounds dumb to
280 1.1 deraadt * you, it is. I can change the pmeg, but not the virtual address.
281 1.1 deraadt * Sun defines these with the high nibble set to 0xF. I believe this was
282 1.1 deraadt * for the monitor source which accesses this piece of memory with addressing
283 1.1 deraadt * limitations or some such crud. I haven't replicated this here, because
284 1.1 deraadt * it is confusing, and serves no obvious purpose if you aren't the monitor.
285 1.1 deraadt *
286 1.1 deraadt */
287 1.1 deraadt #define MONSHORTPAGE 0x0FFFE000
288 1.1 deraadt #define MONSHORTSEG 0x0FFE0000
289 1.1 deraadt
290 1.5 pk
291 1.5 pk
292 1.5 pk /*
293 1.5 pk * Ethernet interface descriptor
294 1.5 pk * First, set: saiop->si_devaddr, saiop->si_dmaaddr, etc.
295 1.5 pk * Then: saiop->si_boottab->b_open() will set:
296 1.5 pk * saiop->si_sif;
297 1.5 pk * saiop->si_devdata;
298 1.5 pk * The latter is the first arg to the following functions.
299 1.5 pk * Note that the buffer must be in DVMA space...
300 1.5 pk */
301 1.5 pk struct saif {
302 1.5 pk /* transmit packet, returns zero on success. */
303 1.5 pk int (*sif_xmit)(void *devdata, char *buf, int len);
304 1.5 pk /* wait for packet, zero if none arrived */
305 1.5 pk int (*sif_poll)(void *devdata, char *buf);
306 1.5 pk /* reset interface, set addresses, etc. */
307 1.5 pk int (*sif_reset)(void *devdata, struct saioreq *sip);
308 1.5 pk /* Later (sun4 only) proms have more stuff here. */
309 1.5 pk };
310 1.10 christos
311 1.10 christos
312 1.10 christos #if defined(SUN4)
313 1.10 christos void oldmon_w_trace __P((u_long));
314 1.10 christos void oldmon_w_cmd __P((u_long, char *));
315 1.10 christos #endif
316 1.10 christos
317 1.6 christos #endif /* _MACHINE_OLDMON_H */
318