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 _OPENFIRM_H_
  61 #define _OPENFIRM_H_
  62
  63 /*
  64  * Prototypes for Open Firmware Interface Routines
  65  */
  66
  67 typedef unsigned long cell_t;
  68
  69 typedef unsigned int    ihandle_t;
  70 typedef unsigned int    phandle_t;
  71
  72 #ifdef _KERNEL
  73 #include <sys/cdefs.h>
  74 #include <sys/types.h>
  75 #include <sys/malloc.h>
  76
  77 MALLOC_DECLARE(M_OFWPROP);
  78
  79 /*
  80  * Stuff that is used by the Open Firmware code.
  81  */
  82 void    set_openfirm_callback(int (*)(void *));
  83 int     openfirmware(void *);
  84
  85 /*
  86  * This isn't actually an Open Firmware function, but it seemed like the right
  87  * place for it to go.
  88  */
  89 void            OF_init(int (*openfirm)(void *));
  90
  91 /* Generic functions */
  92 int             OF_test(char *);
  93 void            OF_printf(const char *, ...);
  94
  95 /* Device tree functions */
  96 phandle_t       OF_peer(phandle_t);
  97 phandle_t       OF_child(phandle_t);
  98 phandle_t       OF_parent(phandle_t);
  99 phandle_t       OF_instance_to_package(ihandle_t);
 100 int             OF_getproplen(phandle_t, char *);
 101 int             OF_getprop(phandle_t, char *, void *, int);
 102 int             OF_getprop_alloc(phandle_t package, char *propname, int elsz,
 103     void **buf);
 104 int             OF_nextprop(phandle_t, char *, char *);
 105 int             OF_setprop(phandle_t, char *, void *, int);
 106 int             OF_canon(const char *, char *, int);
 107 phandle_t       OF_finddevice(const char *);
 108 int             OF_instance_to_path(ihandle_t, char *, int);
 109 int             OF_package_to_path(phandle_t, char *, int);
 110 int             OF_call_method(char *, ihandle_t, int, int, ...);
 111
 112 /* Device I/O functions */
 113 ihandle_t       OF_open(char *);
 114 void            OF_close(ihandle_t);
 115 int             OF_read(ihandle_t, void *, int);
 116 int             OF_write(ihandle_t, void *, int);
 117 int             OF_seek(ihandle_t, u_quad_t);
 118
 119 /* Memory functions */
 120 void            *OF_claim(void *, u_int, u_int);
 121 void            OF_release(void *, u_int);
 122
 123 /* Control transfer functions */
 124 void            OF_boot(char *);
 125 void            OF_enter(void);
 126 void            OF_exit(void) __attribute__((noreturn));
 127 void            OF_chain(void *, u_int,
 128     void (*)(void *, u_int, void *, void *, u_int), void *, u_int);
 129
 130 /* User interface functions */
 131 int             OF_interpret(char *, int, ...);
 132
 133 /* Time function */
 134 int             OF_milliseconds(void);
 135
 136 #endif /* _KERNEL */
 137 #endif /* _OPENFIRM_H_ */