Home | History | Annotate | Line # | Download | only in ofw
openfirm.h revision 1.52 
      1 /*	$NetBSD: openfirm.h,v 1.52 2025/09/16 11:37:17 thorpej 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 #ifndef _OPENFIRM_H_
     35 #define _OPENFIRM_H_
     36 
     37 #include <sys/device.h>
     38 #include <prop/proplib.h>
     39 
     40 /*
     41  * Prototypes for OpenFirmware Interface Routines
     42  */
     43 
     44 /*
     45  * Machine-independent OpenFirmware-related structures.
     46  * XXX THESE DO NOT BELONG HERE.
     47  */
     48 
     49 /*
     50  * Generic OpenFirmware probe argument.
     51  * This is how all probe structures must start
     52  * in order to support generic OpenFirmware device drivers.
     53  */
     54 struct ofbus_attach_args {
     55 	const char	*oba_busname;
     56 	char		oba_ofname[64];
     57 	int		oba_phandle;
     58 
     59 	/*
     60 	 * Special unit field for disk devices.
     61 	 * This is a KLUDGE to work around the fact that OpenFirmware
     62 	 * doesn't probe the scsi bus completely.
     63 	 * YES, I THINK THIS IS A BUG IN THE OPENFIRMWARE DEFINITION!!!	XXX
     64 	 * See also ofdisk.c.
     65 	 */
     66 	int		oba_unit;
     67 };
     68 
     69 /*
     70  * Functions and variables provided by machine-dependent code.
     71  */
     72 extern char *OF_buf;
     73 
     74 void	OF_boot(const char *) __dead;
     75 int	OF_call_method(const char *, int, int, int, ...);
     76 int	OF_call_method_1(const char *, int, int, ...);
     77 int	OF_child(int);
     78 void	*OF_claim(void *, u_int, u_int);
     79 void	OF_close(int);
     80 void	OF_enter(void);
     81 void	OF_exit(void) __dead;
     82 int	OF_finddevice(const char *);
     83 int	OF_getprop(int, const char *, void *, int);
     84 int	OF_getproplen(int, const char *);
     85 int	OF_instance_to_package(int);
     86 int	OF_instance_to_path(int, char *, int);
     87 int	OF_interpret(const char *, int, int, ...);
     88 int	OF_milliseconds(void);
     89 int	OF_nextprop(int, const char *, void *);
     90 int	OF_open(const char *);
     91 int	OF_package_to_path(int, char *, int);
     92 int	OF_parent(int);
     93 int	OF_peer(int);
     94 void	OF_quiesce(void);
     95 int	OF_read(int, void *, int);
     96 void	OF_release(void *, u_int);
     97 int	OF_seek(int, u_quad_t);
     98 void	(*OF_set_callback(void(*)(void *)))(void *);
     99 int	OF_setprop(int, const char *, const void *, int);
    100 int	OF_write(int, const void *, int);
    101 
    102 int	openfirmware(void *);
    103 
    104 /*
    105  * Functions and variables provided by machine-independent code.
    106  */
    107 #ifdef _KERNEL
    108 struct device_compatible_entry;
    109 
    110 devhandle_t	devhandle_from_of(devhandle_t, int);
    111 int		devhandle_to_of(devhandle_t);
    112 
    113 #define	OF_DEVICE_CALL_REGISTER(_n_, _c_)				\
    114 	DEVICE_CALL_REGISTER(of_device_calls, _n_, _c_)
    115 
    116 int	of_compatible(int, const char * const *);
    117 int	of_compatible_match(int, const struct device_compatible_entry *);
    118 const struct device_compatible_entry *
    119 	of_compatible_lookup(int, const struct device_compatible_entry *);
    120 int	of_decode_int(const unsigned char *);
    121 int	of_packagename(int, char *, int);
    122 int	of_find_firstchild_byname(int, const char *);
    123 int	of_find_bycompat(int, const char *);
    124 int	of_getnode_byname(int, const char *);
    125 bool	of_to_uint32_prop(prop_dictionary_t, int, const char *, const char *);
    126 bool	of_to_dataprop(prop_dictionary_t, int, const char *, const char *);
    127 device_t of_device_from_phandle(int);
    128 
    129 int	*of_network_decode_media(int, int *, int *);
    130 char	*of_get_mode_string(char *, int);
    131 
    132 prop_array_t of_copy_i2c_devs(int, size_t, int);
    133 #endif /* _KERNEL */
    134 
    135 bool	of_hasprop(int, const char *);
    136 #define of_getprop_bool	of_hasprop
    137 int	of_getprop_uint32(int, const char *, uint32_t *);
    138 int	of_getprop_uint32_array(int, const char *, uint32_t *, int);
    139 int	of_getprop_uint64(int, const char *, uint64_t *);
    140 
    141 #endif /*_OPENFIRM_H_*/
    142