1 /* $OpenBSD: openfirm.h,v 1.4 2001/06/25 23:04:39 drahn Exp $ */ 2 /* $NetBSD: openfirm.h,v 1.1 1996/09/30 16:35:10 ws Exp $ */ 3 4 /* 5 * Copyright (C) 1995, 1996 Wolfgang Solfrank. 6 * Copyright (C) 1995, 1996 TooLs GmbH. 7 * All rights reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 3. All advertising materials mentioning features or use of this software 18 * must display the following acknowledgement: 19 * This product includes software developed by TooLs GmbH. 20 * 4. The name of TooLs GmbH may not be used to endorse or promote products 21 * derived from this software without specific prior written permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR 24 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 25 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 26 * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 28 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 29 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 30 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 31 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 32 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 33 */ 34 /* 35 * Prototypes for OpenFirmware Interface Routines 36 */ 37 38 #include <sys/param.h> 39 #include <sys/device.h> 40 41 int openfirmware __P((void *)); 42 43 extern char OF_buf[]; 44 45 int OF_peer __P((int phandle)); 46 int OF_child __P((int phandle)); 47 int OF_parent __P((int phandle)); 48 int OF_instance_to_package __P((int ihandle)); 49 int OF_getprop __P((int handle, char *prop, void *buf, int buflen)); 50 int OF_finddevice __P((char *name)); 51 int OF_instance_to_path __P((int ihandle, char *buf, int buflen)); 52 int OF_package_to_path __P((int phandle, char *buf, int buflen)); 53 int OF_call_method_1 __P((char *method, int ihandle, int nargs, ...)); 54 int OF_call_method __P((char *method, int ihandle, int nargs, int nreturns, ...)); 55 int OF_open __P((char *dname)); 56 void OF_close __P((int handle)); 57 int OF_read __P((int handle, void *addr, int len)); 58 int OF_write __P((int handle, void *addr, int len)); 59 int OF_seek __P((int handle, u_quad_t pos)); 60 void OF_boot __P((char *bootspec)) __attribute__((__noreturn__)); 61 void OF_enter __P((void)); 62 void OF_exit __P((void)) __attribute__((__noreturn__)); 63 int OF_interpret __P((char *cmd, int nreturns, ...)); 64 #if 0 65 void (*OF_set_callback __P((void (*newfunc)(void *)))) (); 66 #endif 67 68 /* 69 * Some generic routines for OpenFirmware handling. 70 */ 71 int ofnmmatch __P((char *cp1, char *cp2)); 72 void ofw_intr_establish(void); 73 74 /* 75 * Generic OpenFirmware probe argument. 76 * This is how all probe structures must start 77 * in order to support generic OpenFirmware device drivers. 78 */ 79 struct ofprobe { 80 int phandle; 81 /* 82 * Special unit field for disk devices. 83 * This is a KLUDGE to work around the fact that OpenFirmware 84 * doesn't probe the scsi bus completely. 85 * YES, I THINK THIS IS A BUG IN THE OPENFIRMWARE DEFINITION!!! XXX 86 * See also ofdisk.c. 87 */ 88 int unit; 89 }; 90 91 /* 92 * The softc structure for devices we might be booted from (i.e. we might 93 * want to set root/swap to) needs to start with these fields: XXX 94 */ 95 struct ofb_softc { 96 struct device sc_dev; 97 int sc_phandle; 98 int sc_unit; /* Might be missing for non-disk devices */ 99 }; 100