1 /* $NetBSD: bsd_openprom.h,v 1.11 1996/05/18 12:27:43 mrg 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 * Jan-Simon Pendry. 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 * @(#)bsd_openprom.h 8.1 (Berkeley) 6/11/93 39 */ 40 41 /* 42 * Sun4m support by Aaron Brown, Harvard University. 43 * Changes Copyright (c) 1995 The President and Fellows of Harvard College. 44 * All rights reserved. 45 */ 46 47 /* 48 * This file defines the interface between the kernel and the Openboot PROM. 49 * N.B.: this has been tested only on interface versions 0 and 2 (we have 50 * never seen interface version 1). 51 */ 52 53 /* 54 * The v0 interface tells us what virtual memory to scan to avoid PMEG 55 * conflicts, but the v2 interface fails to do so, and we must `magically' 56 * know where the OPENPROM lives in virtual space. 57 */ 58 #define OPENPROM_STARTVADDR 0xffd00000 59 #define OPENPROM_ENDVADDR 0xfff00000 60 61 #define OPENPROM_MAGIC 0x10010407 62 63 /* 64 * Version 0 PROM vector device operations (collected here to emphasise that 65 * they are deprecated). Open and close are obvious. Read and write are 66 * segregated according to the device type (block, network, or character); 67 * this is unnecessary and was eliminated from the v2 device operations, but 68 * we are stuck with it. 69 * 70 * Seek is probably only useful on tape devices, since the only character 71 * devices are the serial ports. 72 * 73 * Note that a v0 device name is always exactly two characters ("sd", "le", 74 * and so forth). 75 */ 76 struct v0devops { 77 int (*v0_open) __P((char *dev)); 78 int (*v0_close) __P((int d)); 79 int (*v0_rbdev) __P((int d, int nblks, int blkno, void *addr)); 80 int (*v0_wbdev) __P((int d, int nblks, int blkno, void *addr)); 81 int (*v0_wnet) __P((int d, int nbytes, void *addr)); 82 int (*v0_rnet) __P((int d, int nbytes, void *addr)); 83 int (*v0_rcdev) __P((int d, int nbytes, int, void *addr)); 84 int (*v0_wcdev) __P((int d, int nbytes, int, void *addr)); 85 int (*v0_seek) __P((int d, long offset, int whence)); 86 }; 87 88 /* 89 * Version 2 device operations. Open takes a device `path' such as 90 * /sbus/le@0,c00000,0 or /sbus/esp@.../sd@0,0, which means it can open 91 * anything anywhere, without any magic translation. 92 * 93 * The memory allocator and map functions are included here even though 94 * they relate only indirectly to devices (e.g., mmap is good for mapping 95 * device memory, and drivers need to allocate space in which to record 96 * the device state). 97 */ 98 struct v2devops { 99 /* 100 * Convert an `instance handle' (acquired through v2_open()) to 101 * a `package handle', a.k.a. a `node'. 102 */ 103 int (*v2_fd_phandle) __P((int d)); 104 105 /* Memory allocation and release. */ 106 void *(*v2_malloc) __P((caddr_t va, u_int sz)); 107 void (*v2_free) __P((caddr_t va, u_int sz)); 108 109 /* Device memory mapper. */ 110 caddr_t (*v2_mmap) __P((caddr_t va, int asi, u_int pa, u_int sz)); 111 void (*v2_munmap) __P((caddr_t va, u_int sz)); 112 113 /* Device open, close, etc. */ 114 int (*v2_open) __P((char *devpath)); 115 void (*v2_close) __P((int d)); 116 int (*v2_read) __P((int d, void *buf, int nbytes)); 117 int (*v2_write) __P((int d, void *buf, int nbytes)); 118 void (*v2_seek) __P((int d, int hi, int lo)); 119 120 void (*v2_chain) __P((void)); /* ??? */ 121 void (*v2_release) __P((void)); /* ??? */ 122 }; 123 124 /* 125 * The v0 interface describes memory regions with these linked lists. 126 * (The !$&@#+ v2 interface reformats these as properties, so that we 127 * have to extract them into local temporary memory and reinterpret them.) 128 */ 129 struct v0mlist { 130 struct v0mlist *next; 131 caddr_t addr; 132 u_int nbytes; 133 }; 134 135 /* 136 * V0 gives us three memory lists: Total physical memory, VM reserved to 137 * the PROM, and available physical memory (which, presumably, is just the 138 * total minus any pages mapped in the PROM's VM region). We can find the 139 * reserved PMEGs by scanning the taken VM. Unfortunately, the V2 prom 140 * forgot to provide taken VM, and we are stuck with scanning ``magic'' 141 * addresses. 142 */ 143 struct v0mem { 144 struct v0mlist **v0_phystot; /* physical memory */ 145 struct v0mlist **v0_vmprom; /* VM used by PROM */ 146 struct v0mlist **v0_physavail; /* available physical memory */ 147 }; 148 149 /* 150 * The version 0 PROM breaks up the string given to the boot command and 151 * leaves the decoded version behind. 152 */ 153 struct v0bootargs { 154 char *ba_argv[8]; /* argv format for boot string */ 155 char ba_args[100]; /* string space */ 156 char ba_bootdev[2]; /* e.g., "sd" for `b sd(...' */ 157 int ba_ctlr; /* controller # */ 158 int ba_unit; /* unit # */ 159 int ba_part; /* partition # */ 160 char *ba_kernel; /* kernel to boot, e.g., "vmunix" */ 161 void *ba_spare0; /* not decoded here XXX */ 162 }; 163 164 /* 165 * The version 2 PROM interface uses the more general, if less convenient, 166 * approach of passing the boot strings unchanged. We also get open file 167 * numbers for stdin and stdout (keyboard and screen, or whatever), for use 168 * with the v2 device ops. 169 */ 170 struct v2bootargs { 171 char **v2_bootpath; /* V2: Path to boot device */ 172 char **v2_bootargs; /* V2: Boot args */ 173 int *v2_fd0; /* V2: Stdin descriptor */ 174 int *v2_fd1; /* V2: Stdout descriptor */ 175 }; 176 177 /* 178 * The following structure defines the primary PROM vector interface. 179 * The Boot PROM hands the kernel a pointer to this structure in %o0. 180 * There are numerous substructures defined below. 181 */ 182 struct promvec { 183 /* Version numbers. */ 184 u_int pv_magic; /* Magic number */ 185 u_int pv_romvec_vers; /* interface version (0, 2) */ 186 u_int pv_plugin_vers; /* ??? */ 187 u_int pv_printrev; /* PROM rev # (* 10, e.g 1.9 = 19) */ 188 189 /* Version 0 memory descriptors (see below). */ 190 struct v0mem pv_v0mem; /* V0: Memory description lists. */ 191 192 /* Node operations (see below). */ 193 struct nodeops *pv_nodeops; /* node functions */ 194 195 char **pv_bootstr; /* Boot command, eg sd(0,0,0)vmunix */ 196 197 struct v0devops pv_v0devops; /* V0: device ops */ 198 199 /* 200 * PROMDEV_* cookies. I fear these may vanish in lieu of fd0/fd1 201 * (see below) in future PROMs, but for now they work fine. 202 */ 203 char *pv_stdin; /* stdin cookie */ 204 char *pv_stdout; /* stdout cookie */ 205 #define PROMDEV_KBD 0 /* input from keyboard */ 206 #define PROMDEV_SCREEN 0 /* output to screen */ 207 #define PROMDEV_TTYA 1 /* in/out to ttya */ 208 #define PROMDEV_TTYB 2 /* in/out to ttyb */ 209 210 /* Blocking getchar/putchar. NOT REENTRANT! (grr) */ 211 int (*pv_getchar) __P((void)); 212 void (*pv_putchar) __P((int ch)); 213 214 /* Non-blocking variants that return -1 on error. */ 215 int (*pv_nbgetchar) __P((void)); 216 int (*pv_nbputchar) __P((int ch)); 217 218 /* Put counted string (can be very slow). */ 219 void (*pv_putstr) __P((char *str, int len)); 220 221 /* Miscellany. */ 222 void (*pv_reboot) __P((char *bootstr)); 223 void (*pv_printf) __P((const char *fmt, ...)); 224 void (*pv_abort) __P((void)); /* L1-A abort */ 225 int *pv_ticks; /* Ticks since last reset */ 226 __dead void (*pv_halt) __P((void)) __attribute__((noreturn));/* Halt! */ 227 void (**pv_synchook) __P((void)); /* "sync" command hook */ 228 229 /* 230 * This eval's a FORTH string. Unfortunately, its interface 231 * changed between V0 and V2, which gave us much pain. 232 */ 233 union { 234 void (*v0_eval) __P((int len, char *str)); 235 void (*v2_eval) __P((char *str)); 236 } pv_fortheval; 237 238 struct v0bootargs **pv_v0bootargs; /* V0: Boot args */ 239 240 /* Extract Ethernet address from network device. */ 241 u_int (*pv_enaddr) __P((int d, char *enaddr)); 242 243 struct v2bootargs pv_v2bootargs; /* V2: Boot args + std in/out */ 244 struct v2devops pv_v2devops; /* V2: device operations */ 245 246 int pv_spare[15]; 247 248 /* 249 * The following is machine-dependent. 250 * 251 * The sun4c needs a PROM function to set a PMEG for another 252 * context, so that the kernel can map itself in all contexts. 253 * It is not possible simply to set the context register, because 254 * contexts 1 through N may have invalid translations for the 255 * current program counter. The hardware has a mode in which 256 * all memory references go to the PROM, so the PROM can do it 257 * easily. 258 */ 259 void (*pv_setctxt) __P((int ctxt, caddr_t va, int pmeg)); 260 #if defined(SUN4M) && defined(notyet) 261 /* 262 * The following are V3 ROM functions to handle MP machines in the 263 * Sun4m series. They have undefined results when run on a uniprocessor! 264 */ 265 int (*pv_v3cpustart) __P((u_int module, u_int ctxtbl, 266 int context, caddr_t pc)); 267 int (*pv_v3cpustop) __P((u_int module)); 268 int (*pv_v3cpuidle) __P((u_int module)); 269 int (*pv_v3cpuresume) __P((u_int module)); 270 #endif 271 }; 272 273 /* 274 * In addition to the global stuff defined in the PROM vectors above, 275 * the PROM has quite a collection of `nodes'. A node is described by 276 * an integer---these seem to be internal pointers, actually---and the 277 * nodes are arranged into an N-ary tree. Each node implements a fixed 278 * set of functions, as described below. The first two deal with the tree 279 * structure, allowing traversals in either breadth- or depth-first fashion. 280 * The rest deal with `properties'. 281 * 282 * A node property is simply a name/value pair. The names are C strings 283 * (NUL-terminated); the values are arbitrary byte strings (counted strings). 284 * Many values are really just C strings. Sometimes these are NUL-terminated, 285 * sometimes not, depending on the the interface version; v0 seems to 286 * terminate and v2 not. Many others are simply integers stored as four 287 * bytes in machine order: you just get them and go. The third popular 288 * format is an `address', which is made up of one or more sets of three 289 * integers as defined below. 290 * 291 * N.B.: for the `next' functions, next(0) = first, and next(last) = 0. 292 * Whoever designed this part had good taste. On the other hand, these 293 * operation vectors are global, rather than per-node, yet the pointers 294 * are not in the openprom vectors but rather found by indirection from 295 * there. So the taste balances out. 296 */ 297 struct openprom_addr { 298 int oa_space; /* address space (may be relative) */ 299 u_int oa_base; /* address within space */ 300 u_int oa_size; /* extent (number of bytes) */ 301 }; 302 303 struct nodeops { 304 /* 305 * Tree traversal. 306 */ 307 int (*no_nextnode) __P((int node)); /* next(node) */ 308 int (*no_child) __P((int node)); /* first child */ 309 310 /* 311 * Property functions. Proper use of getprop requires calling 312 * proplen first to make sure it fits. Kind of a pain, but no 313 * doubt more convenient for the PROM coder. 314 */ 315 int (*no_proplen) __P((int node, caddr_t name)); 316 int (*no_getprop) __P((int node, caddr_t name, caddr_t val)); 317 int (*no_setprop) __P((int node, caddr_t name, caddr_t val, 318 int len)); 319 caddr_t (*no_nextprop) __P((int node, caddr_t name)); 320 }; 321 322 void romhalt __P((void)) 323 __attribute__((__noreturn__)); 324 void romboot __P((char *)) 325 __attribute__((__noreturn__)); 326 327 extern struct promvec *promvec; 328