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