Home | History | Annotate | Line # | Download | only in ofw
openfirm.h revision 1.12.8.1 
      1 /*	$NetBSD: openfirm.h,v 1.12.8.1 2000/11/22 16:03:57 bouyer 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 ofbus_attach_args {
     51 	char *oba_busname;
     52 	int oba_phandle;
     53 	/*
     54 	 * Special unit field for disk devices.
     55 	 * This is a KLUDGE to work around the fact that OpenFirmware
     56 	 * doesn't probe the scsi bus completely.
     57 	 * YES, I THINK THIS IS A BUG IN THE OPENFIRMWARE DEFINITION!!!	XXX
     58 	 * See also ofdisk.c.
     59 	 */
     60 	int oba_unit;
     61 };
     62 
     63 /*
     64  * The softc structure for devices we might be booted from (i.e. we might
     65  * want to set root/swap to) needs to start with these fields:		XXX
     66  */
     67 struct ofb_softc {
     68 	struct device sc_dev;
     69 	int sc_phandle;
     70 	int sc_unit;		/* Might be missing for non-disk devices */
     71 };
     72 
     73 
     74 /*
     75  * Functions and variables provided by machine-dependent code.
     76  */
     77 extern char *OF_buf;
     78 
     79 int	OF_peer (int phandle);
     80 int	OF_child (int phandle);
     81 int	OF_parent (int phandle);
     82 int	OF_instance_to_package (int ihandle);
     83 int	OF_getproplen (int handle, char *prop);
     84 int	OF_getprop (int handle, char *prop, void *buf, int buflen);
     85 int	OF_nextprop (int handle, char *prop, void *nextprop);
     86 int	OF_setprop (int handle, char *prop, const void *buf, int buflen);
     87 int	OF_finddevice (char *name);
     88 int	OF_instance_to_path (int ihandle, char *buf, int buflen);
     89 int	OF_package_to_path (int phandle, char *buf, int buflen);
     90 int	OF_call_method_1 (char *method, int ihandle, int nargs, ...);
     91 int	OF_call_method (char *method, int ihandle, int nargs,
     92 	    int nreturns, ...);
     93 int	OF_open (char *dname);
     94 void	OF_close (int handle);
     95 int	OF_read (int handle, void *addr, int len);
     96 int	OF_write (int handle, void *addr, int len);
     97 int	OF_seek (int handle, u_quad_t pos);
     98 void	OF_boot (char *bootspec) __attribute__((__noreturn__));
     99 void	OF_enter (void);
    100 void	OF_exit (void) __attribute__((__noreturn__));
    101 void	(*OF_set_callback (void (*newfunc)(void *))) (void *);
    102 int	openfirmware (void *);
    103 
    104 /*
    105  * Functions and variables provided by machine-independent code.
    106  */
    107 int	of_compatible (int, const char * const *);
    108 int	of_decode_int (const unsigned char *buf);
    109 int	of_packagename (int, char *, int);
    110 
    111 int	*of_network_decode_media (int, int *, int *);
    112