1 /* $OpenBSD: openfirm.h,v 1.13 2016/07/09 12:31:05 kettenis 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(void *); 42 43 extern char OF_buf[]; 44 45 int OF_peer(int phandle); 46 int OF_child(int phandle); 47 int OF_parent(int phandle); 48 int OF_instance_to_package(int ihandle); 49 int OF_getproplen(int handle, char *prop); 50 int OF_getprop(int handle, char *prop, void *buf, int buflen); 51 uint32_t OF_getpropint(int handle, char *, uint32_t); 52 int OF_getpropintarray(int, char *, uint32_t *, int); 53 int OF_setprop(int, char *, const void *, int); 54 int OF_nextprop(int, char *, void *); 55 int OF_finddevice(char *name); 56 int OF_is_compatible(int, const char *); 57 int OF_instance_to_path(int ihandle, char *buf, int buflen); 58 int OF_package_to_path(int phandle, char *buf, int buflen); 59 int OF_call_method_1(char *method, int ihandle, int nargs, ...); 60 int OF_call_method(char *method, int ihandle, int nargs, int nreturns, ...); 61 int OF_open(char *dname); 62 void OF_close(int handle); 63 int OF_read(int handle, void *addr, int len); 64 int OF_write(int handle, void *addr, int len); 65 int OF_seek(int handle, u_quad_t pos); 66 void OF_boot(char *bootspec); 67 void OF_enter(void); 68 void OF_exit(void) __attribute__((__noreturn__)); 69 int OF_interpret(char *cmd, int nreturns, ...); 70 #if 0 71 void (*OF_set_callback(void (*newfunc)(void *))) (); 72 #endif 73 int OF_getnodebyname(int, const char *); 74 int OF_getnodebyphandle(uint32_t); 75 76 /* 77 * Some generic routines for OpenFirmware handling. 78 */ 79 int ofnmmatch(char *cp1, char *cp2); 80 void ofw_intr_establish(void); 81 82 /* 83 * Generic OpenFirmware probe argument. 84 * This is how all probe structures must start 85 * in order to support generic OpenFirmware device drivers. 86 */ 87 struct ofprobe { 88 int phandle; 89 /* 90 * Special unit field for disk devices. 91 * This is a KLUDGE to work around the fact that OpenFirmware 92 * doesn't probe the scsi bus completely. 93 * YES, I THINK THIS IS A BUG IN THE OPENFIRMWARE DEFINITION!!! XXX 94 * See also ofdisk.c. 95 */ 96 int unit; 97 }; 98 99 /* 100 * The softc structure for devices we might be booted from (i.e. we might 101 * want to set root/swap to) needs to start with these fields: XXX 102 */ 103 struct ofb_softc { 104 struct device sc_dev; 105 int sc_phandle; 106 int sc_unit; /* Might be missing for non-disk devices */ 107 }; 108