Home | History | Annotate | Line # | Download | only in ofw
      1  1.52   thorpej /*	$NetBSD: openfirm.h,v 1.52 2025/09/16 11:37:17 thorpej Exp $	*/
      2   1.1        ws 
      3   1.1        ws /*
      4   1.1        ws  * Copyright (C) 1995, 1996 Wolfgang Solfrank.
      5   1.1        ws  * Copyright (C) 1995, 1996 TooLs GmbH.
      6   1.1        ws  * All rights reserved.
      7   1.1        ws  *
      8   1.1        ws  * Redistribution and use in source and binary forms, with or without
      9   1.1        ws  * modification, are permitted provided that the following conditions
     10   1.1        ws  * are met:
     11   1.1        ws  * 1. Redistributions of source code must retain the above copyright
     12   1.1        ws  *    notice, this list of conditions and the following disclaimer.
     13   1.1        ws  * 2. Redistributions in binary form must reproduce the above copyright
     14   1.1        ws  *    notice, this list of conditions and the following disclaimer in the
     15   1.1        ws  *    documentation and/or other materials provided with the distribution.
     16   1.1        ws  * 3. All advertising materials mentioning features or use of this software
     17   1.1        ws  *    must display the following acknowledgement:
     18   1.1        ws  *	This product includes software developed by TooLs GmbH.
     19   1.1        ws  * 4. The name of TooLs GmbH may not be used to endorse or promote products
     20   1.1        ws  *    derived from this software without specific prior written permission.
     21   1.1        ws  *
     22   1.1        ws  * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
     23   1.1        ws  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     24   1.1        ws  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     25   1.1        ws  * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     26   1.1        ws  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
     27   1.1        ws  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
     28   1.1        ws  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
     29   1.1        ws  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
     30   1.1        ws  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
     31   1.1        ws  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     32   1.1        ws  */
     33  1.25   garbled 
     34  1.25   garbled #ifndef _OPENFIRM_H_
     35  1.25   garbled #define _OPENFIRM_H_
     36  1.25   garbled 
     37  1.45   thorpej #include <sys/device.h>
     38  1.25   garbled #include <prop/proplib.h>
     39  1.25   garbled 
     40   1.1        ws /*
     41   1.1        ws  * Prototypes for OpenFirmware Interface Routines
     42   1.1        ws  */
     43   1.1        ws 
     44   1.1        ws /*
     45   1.2       cgd  * Machine-independent OpenFirmware-related structures.
     46   1.2       cgd  * XXX THESE DO NOT BELONG HERE.
     47   1.1        ws  */
     48   1.1        ws 
     49   1.1        ws /*
     50   1.1        ws  * Generic OpenFirmware probe argument.
     51   1.1        ws  * This is how all probe structures must start
     52   1.1        ws  * in order to support generic OpenFirmware device drivers.
     53   1.1        ws  */
     54   1.7   mycroft struct ofbus_attach_args {
     55  1.18       chs 	const char	*oba_busname;
     56  1.18       chs 	char		oba_ofname[64];
     57  1.18       chs 	int		oba_phandle;
     58  1.18       chs 
     59   1.1        ws 	/*
     60   1.1        ws 	 * Special unit field for disk devices.
     61   1.1        ws 	 * This is a KLUDGE to work around the fact that OpenFirmware
     62   1.1        ws 	 * doesn't probe the scsi bus completely.
     63   1.1        ws 	 * YES, I THINK THIS IS A BUG IN THE OPENFIRMWARE DEFINITION!!!	XXX
     64   1.1        ws 	 * See also ofdisk.c.
     65   1.1        ws 	 */
     66  1.18       chs 	int		oba_unit;
     67   1.1        ws };
     68   1.1        ws 
     69   1.2       cgd /*
     70   1.2       cgd  * Functions and variables provided by machine-dependent code.
     71   1.2       cgd  */
     72   1.2       cgd extern char *OF_buf;
     73   1.2       cgd 
     74  1.30  christos void	OF_boot(const char *) __dead;
     75  1.30  christos int	OF_call_method(const char *, int, int, int, ...);
     76  1.30  christos int	OF_call_method_1(const char *, int, int, ...);
     77  1.17    simonb int	OF_child(int);
     78  1.30  christos void	*OF_claim(void *, u_int, u_int);
     79  1.30  christos void	OF_close(int);
     80  1.30  christos void	OF_enter(void);
     81  1.30  christos void	OF_exit(void) __dead;
     82  1.30  christos int	OF_finddevice(const char *);
     83  1.30  christos int	OF_getprop(int, const char *, void *, int);
     84  1.30  christos int	OF_getproplen(int, const char *);
     85  1.17    simonb int	OF_instance_to_package(int);
     86  1.30  christos int	OF_instance_to_path(int, char *, int);
     87  1.30  christos int	OF_interpret(const char *, int, int, ...);
     88  1.30  christos int	OF_milliseconds(void);
     89  1.20  christos int	OF_nextprop(int, const char *, void *);
     90  1.30  christos int	OF_open(const char *);
     91  1.17    simonb int	OF_package_to_path(int, char *, int);
     92  1.30  christos int	OF_parent(int);
     93  1.30  christos int	OF_peer(int);
     94  1.30  christos void	OF_quiesce(void);
     95  1.17    simonb int	OF_read(int, void *, int);
     96  1.30  christos void	OF_release(void *, u_int);
     97  1.17    simonb int	OF_seek(int, u_quad_t);
     98  1.17    simonb void	(*OF_set_callback(void(*)(void *)))(void *);
     99  1.30  christos int	OF_setprop(int, const char *, const void *, int);
    100  1.30  christos int	OF_write(int, const void *, int);
    101  1.30  christos 
    102  1.17    simonb int	openfirmware(void *);
    103   1.2       cgd 
    104   1.2       cgd /*
    105   1.2       cgd  * Functions and variables provided by machine-independent code.
    106   1.2       cgd  */
    107  1.46   thorpej #ifdef _KERNEL
    108  1.41   thorpej struct device_compatible_entry;
    109  1.41   thorpej 
    110  1.48   thorpej devhandle_t	devhandle_from_of(devhandle_t, int);
    111  1.45   thorpej int		devhandle_to_of(devhandle_t);
    112  1.45   thorpej 
    113  1.45   thorpej #define	OF_DEVICE_CALL_REGISTER(_n_, _c_)				\
    114  1.45   thorpej 	DEVICE_CALL_REGISTER(of_device_calls, _n_, _c_)
    115  1.45   thorpej 
    116  1.17    simonb int	of_compatible(int, const char * const *);
    117  1.43   thorpej int	of_compatible_match(int, const struct device_compatible_entry *);
    118  1.41   thorpej const struct device_compatible_entry *
    119  1.43   thorpej 	of_compatible_lookup(int, const struct device_compatible_entry *);
    120  1.20  christos int	of_decode_int(const unsigned char *);
    121  1.17    simonb int	of_packagename(int, char *, int);
    122  1.24   garbled int	of_find_firstchild_byname(int, const char *);
    123  1.39  jmcneill int	of_find_bycompat(int, const char *);
    124  1.25   garbled int	of_getnode_byname(int, const char *);
    125  1.42       mrg bool	of_to_uint32_prop(prop_dictionary_t, int, const char *, const char *);
    126  1.42       mrg bool	of_to_dataprop(prop_dictionary_t, int, const char *, const char *);
    127  1.45   thorpej device_t of_device_from_phandle(int);
    128   1.8   thorpej 
    129  1.17    simonb int	*of_network_decode_media(int, int *, int *);
    130  1.27  macallan char	*of_get_mode_string(char *, int);
    131  1.25   garbled 
    132  1.52   thorpej prop_array_t of_copy_i2c_devs(int, size_t, int);
    133  1.46   thorpej #endif /* _KERNEL */
    134  1.28    martin 
    135  1.34  jmcneill bool	of_hasprop(int, const char *);
    136  1.34  jmcneill #define of_getprop_bool	of_hasprop
    137  1.33  jmcneill int	of_getprop_uint32(int, const char *, uint32_t *);
    138  1.40       ryo int	of_getprop_uint32_array(int, const char *, uint32_t *, int);
    139  1.37  jmcneill int	of_getprop_uint64(int, const char *, uint64_t *);
    140  1.33  jmcneill 
    141  1.25   garbled #endif /*_OPENFIRM_H_*/
    142