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
  65 /*
  66  * Prototypes for Open Firmware Interface Routines
  67  */
  68
  69 typedef uint32_t        ihandle_t;
  70 typedef uint32_t        phandle_t;
  71 typedef uint32_t        pcell_t;
  72
  73 #ifdef _KERNEL
  74 #include <sys/malloc.h>
  75
  76 #include <machine/ofw_machdep.h>
  77
  78 MALLOC_DECLARE(M_OFWPROP);
  79
  80 /*
  81  * Open Firmware interface initialization.  OF_install installs the named
  82  * interface as the Open Firmware access mechanism, OF_init initializes it.
  83  */
  84
  85 boolean_t       OF_install(char *name, int prio);
  86 int             OF_init(void *cookie);
  87
  88 /*
  89  * Known Open Firmware interface names
  90  */
  91
  92 #define OFW_STD_DIRECT  "ofw_std"       /* Standard OF interface */
  93 #define OFW_STD_REAL    "ofw_real"      /* Real-mode OF interface */
  94 #define OFW_STD_32BIT   "ofw_32bit"     /* 32-bit OF interface */
  95 #define OFW_FDT         "ofw_fdt"       /* Flattened Device Tree */
  96
  97 /* Generic functions */
  98 int             OF_test(const char *name);
  99 void            OF_printf(const char *fmt, ...);
 100
 101 /* Device tree functions */
 102 phandle_t       OF_peer(phandle_t node);
 103 phandle_t       OF_child(phandle_t node);
 104 phandle_t       OF_parent(phandle_t node);
 105 ssize_t         OF_getproplen(phandle_t node, const char *propname);
 106 ssize_t         OF_getprop(phandle_t node, const char *propname, void *buf,
 107                     size_t len);
 108 int             OF_hasprop(phandle_t node, const char *propname);
 109 ssize_t         OF_searchprop(phandle_t node, const char *propname, void *buf,
 110                     size_t len);
 111 ssize_t         OF_getprop_alloc(phandle_t node, const char *propname,
 112                     int elsz, void **buf);
 113 int             OF_nextprop(phandle_t node, const char *propname, char *buf,
 114                     size_t len);
 115 int             OF_setprop(phandle_t node, const char *name, const void *buf,
 116                     size_t len);
 117 ssize_t         OF_canon(const char *path, char *buf, size_t len);
 118 phandle_t       OF_finddevice(const char *path);
 119 ssize_t         OF_package_to_path(phandle_t node, char *buf, size_t len);
 120
 121 /*
 122  * Some OF implementations (IBM, FDT) have a concept of effective phandles
 123  * used for device-tree cross-references. Given one of these, returns the
 124  * real phandle. If one can't be found (or running on OF implementations
 125  * without this property), returns its input.
 126  */
 127 phandle_t       OF_xref_phandle(phandle_t xref);
 128
 129 /* Device I/O functions */
 130 ihandle_t       OF_open(const char *path);
 131 void            OF_close(ihandle_t instance);
 132 ssize_t         OF_read(ihandle_t instance, void *buf, size_t len);
 133 ssize_t         OF_write(ihandle_t instance, const void *buf, size_t len);
 134 int             OF_seek(ihandle_t instance, uint64_t where);
 135
 136 phandle_t       OF_instance_to_package(ihandle_t instance);
 137 ssize_t         OF_instance_to_path(ihandle_t instance, char *buf, size_t len);
 138 int             OF_call_method(const char *method, ihandle_t instance,
 139                     int nargs, int nreturns, ...);
 140
 141 /* Memory functions */
 142 void            *OF_claim(void *virtrequest, size_t size, u_int align);
 143 void            OF_release(void *virt, size_t size);
 144
 145 /* Control transfer functions */
 146 void            OF_enter(void);
 147 void            OF_exit(void) __attribute__((noreturn));
 148
 149 /* User interface functions */
 150 int             OF_interpret(const char *cmd, int nreturns, ...);
 151
 152 #endif /* _KERNEL */
 153 #endif /* _DEV_OPENFIRM_H_ */