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