stand/libofw/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 #ifndef _OPENFIRM_H_
  58 #define _OPENFIRM_H_
  59 /*
  60  * Prototypes for Open Firmware Interface Routines
  61  */
  62
  63 #include <sys/types.h>
  64
  65 typedef uint32_t                ihandle_t;
  66 typedef uint32_t                phandle_t;
  67 typedef uint32_t                cell_t;
  68
  69 extern int              (*openfirmware)(void *);
  70 extern phandle_t        chosen;
  71 extern ihandle_t        memory, mmu;
  72 extern int              real_mode;
  73
  74 /*
  75  * This isn't actually an Open Firmware function, but it seemed like the right
  76  * place for it to go.
  77  */
  78 void            OF_init(int (*openfirm)(void *));
  79
  80 /* Generic functions */
  81 int             OF_test(char *);
  82 void            OF_quiesce(); /* Disable firmware */
  83
  84 /* Device tree functions */
  85 phandle_t       OF_peer(phandle_t);
  86 phandle_t       OF_child(phandle_t);
  87 phandle_t       OF_parent(phandle_t);
  88 phandle_t       OF_instance_to_package(ihandle_t);
  89 int             OF_getproplen(phandle_t, const char *);
  90 int             OF_getprop(phandle_t, const char *, void *, int);
  91 int             OF_getencprop(phandle_t, const char *, cell_t *, int);
  92 int             OF_nextprop(phandle_t, const char *, char *);
  93 int             OF_setprop(phandle_t, const char *, void *, int);
  94 int             OF_canon(const char *, char *, int);
  95 phandle_t       OF_finddevice(const char *);
  96 int             OF_instance_to_path(ihandle_t, char *, int);
  97 int             OF_package_to_path(phandle_t, char *, int);
  98 int             OF_call_method(char *, ihandle_t, int, int, ...);
  99
 100 /* Device I/O functions */
 101 ihandle_t       OF_open(char *);
 102 void            OF_close(ihandle_t);
 103 int             OF_read(ihandle_t, void *, int);
 104 int             OF_write(ihandle_t, void *, int);
 105 int             OF_seek(ihandle_t, u_quad_t);
 106 unsigned int    OF_blocks(ihandle_t);
 107 int             OF_block_size(ihandle_t);
 108
 109 /* Memory functions */
 110 void            *OF_claim(void *, u_int, u_int);
 111 void            OF_release(void *, u_int);
 112
 113 /* Control transfer functions */
 114 void            OF_boot(char *);
 115 void            OF_enter(void);
 116 void            OF_exit(void) __attribute__((noreturn));
 117 void            OF_chain(void *, u_int, void (*)(), void *, u_int);
 118
 119 /* Time function */
 120 int             OF_milliseconds(void);
 121
 122 #endif /* _OPENFIRM_H_ */