sys/dev/ofw/openfirm.h

   1 /*      $NetBSD: openfirm.h,v 1.1 1998/05/15 10:16:00 tsubai 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  * Copyright (C) 2000 Benno Rice.
  35  * All rights reserved.
  36  *
  37  * Redistribution and use in source and binary forms, with or without
  38  * modification, are permitted provided that the following conditions
  39  * are met:
  40  * 1. Redistributions of source code must retain the above copyright
  41  *    notice, this list of conditions and the following disclaimer.
  42  * 2. Redistributions in binary form must reproduce the above copyright
  43  *    notice, this list of conditions and the following disclaimer in the
  44  *    documentation and/or other materials provided with the distribution.
  45  *
  46  * THIS SOFTWARE IS PROVIDED BY Benno Rice ``AS IS'' AND ANY EXPRESS OR
  47  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  48  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  49  * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  50  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  51  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  52  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  53  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  54  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  55  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  56  *
  57  * $FreeBSD$
  58  */
  59
  60 #ifndef _DEV_OPENFIRM_H_
  61 #define _DEV_OPENFIRM_H_
  62
  63 #include <sys/types.h>
  64 #include <machine/_bus.h>
  65
  66 /*
  67  * Prototypes for Open Firmware Interface Routines
  68  */
  69
  70 typedef uint32_t        ihandle_t;
  71 typedef uint32_t        phandle_t;
  72 typedef uint32_t        pcell_t;
  73
  74 #ifdef _KERNEL
  75 #include <sys/malloc.h>
  76
  77 #include <machine/ofw_machdep.h>
  78
  79 MALLOC_DECLARE(M_OFWPROP);
  80
  81 /*
  82  * Open Firmware interface initialization.  OF_install installs the named
  83  * interface as the Open Firmware access mechanism, OF_init initializes it.
  84  */
  85
  86 boolean_t       OF_install(char *name, int prio);
  87 int             OF_init(void *cookie);
  88
  89 /*
  90  * Known Open Firmware interface names
  91  */
  92
  93 #define OFW_STD_DIRECT  "ofw_std"       /* Standard OF interface */
  94 #define OFW_STD_REAL    "ofw_real"      /* Real-mode OF interface */
  95 #define OFW_STD_32BIT   "ofw_32bit"     /* 32-bit OF interface */
  96 #define OFW_FDT         "ofw_fdt"       /* Flattened Device Tree */
  97
  98 /* Generic functions */
  99 int             OF_test(const char *name);
 100 void            OF_printf(const char *fmt, ...);
 101
 102 /* Device tree functions */
 103 phandle_t       OF_peer(phandle_t node);
 104 phandle_t       OF_child(phandle_t node);
 105 phandle_t       OF_parent(phandle_t node);
 106 ssize_t         OF_getproplen(phandle_t node, const char *propname);
 107 ssize_t         OF_getprop(phandle_t node, const char *propname, void *buf,
 108                     size_t len);
 109 ssize_t         OF_getencprop(phandle_t node, const char *prop, pcell_t *buf,
 110                     size_t len); /* Same as getprop, but maintains endianness */
 111 int             OF_hasprop(phandle_t node, const char *propname);
 112 ssize_t         OF_searchprop(phandle_t node, const char *propname, void *buf,
 113                     size_t len);
 114 ssize_t         OF_searchencprop(phandle_t node, const char *propname,
 115                     void *buf, size_t len);
 116 ssize_t         OF_getprop_alloc(phandle_t node, const char *propname,
 117                     int elsz, void **buf);
 118 ssize_t         OF_getencprop_alloc(phandle_t node, const char *propname,
 119                     int elsz, void **buf);
 120 int             OF_nextprop(phandle_t node, const char *propname, char *buf,
 121                     size_t len);
 122 int             OF_setprop(phandle_t node, const char *name, const void *buf,
 123                     size_t len);
 124 ssize_t         OF_canon(const char *path, char *buf, size_t len);
 125 phandle_t       OF_finddevice(const char *path);
 126 ssize_t         OF_package_to_path(phandle_t node, char *buf, size_t len);
 127
 128 /*
 129  * Some OF implementations (IBM, FDT) have a concept of effective phandles
 130  * used for device-tree cross-references. Given one of these, returns the
 131  * real phandle. If one can't be found (or running on OF implementations
 132  * without this property), returns its input.
 133  */
 134 phandle_t       OF_node_from_xref(phandle_t xref);
 135 phandle_t       OF_xref_from_node(phandle_t node);
 136
 137 /*
 138  * When properties contain references to other nodes using xref handles it is
 139  * often necessary to use interfaces provided by the driver for the referenced
 140  * instance.  These routines allow a driver that provides such an interface to
 141  * register its association with an xref handle, and for other drivers to obtain
 142  * the device_t associated with an xref handle.
 143  */
 144 device_t        OF_device_from_xref(phandle_t xref);
 145 phandle_t       OF_xref_from_device(device_t dev);
 146 int             OF_device_register_xref(phandle_t xref, device_t dev);
 147
 148 /* Device I/O functions */
 149 ihandle_t       OF_open(const char *path);
 150 void            OF_close(ihandle_t instance);
 151 ssize_t         OF_read(ihandle_t instance, void *buf, size_t len);
 152 ssize_t         OF_write(ihandle_t instance, const void *buf, size_t len);
 153 int             OF_seek(ihandle_t instance, uint64_t where);
 154
 155 phandle_t       OF_instance_to_package(ihandle_t instance);
 156 ssize_t         OF_instance_to_path(ihandle_t instance, char *buf, size_t len);
 157 int             OF_call_method(const char *method, ihandle_t instance,
 158                     int nargs, int nreturns, ...);
 159
 160 /* Memory functions */
 161 void            *OF_claim(void *virtrequest, size_t size, u_int align);
 162 void            OF_release(void *virt, size_t size);
 163
 164 /* Control transfer functions */
 165 void            OF_enter(void);
 166 void            OF_exit(void) __attribute__((noreturn));
 167
 168 /* User interface functions */
 169 int             OF_interpret(const char *cmd, int nreturns, ...);
 170
 171 /*
 172  * Decode the Nth register property of the given device node and create a bus
 173  * space tag and handle for accessing it.  This is for use in setting up things
 174  * like early console output before newbus is available.  The implementation is
 175  * machine-dependent, and sparc uses a different function signature as well.
 176  */
 177 #ifndef __sparc64__
 178 int             OF_decode_addr(phandle_t dev, int regno, bus_space_tag_t *ptag,
 179                     bus_space_handle_t *phandle);
 180 #endif
 181
 182 #endif /* _KERNEL */
 183 #endif /* _DEV_OPENFIRM_H_ */