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