dec_prom.h Source File

Back to the index.

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

Generated on Fri Dec 7 2018 19:52:23 for GXemul by doxygen 1.8.13