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