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