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