sys/boot/ofw/libofw/openfirm.h

   1 /*
   2  * Copyright (C) 1995, 1996 Wolfgang Solfrank.
   3  * Copyright (C) 1995, 1996 TooLs GmbH.
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 3. All advertising materials mentioning features or use of this software
  15  *    must display the following acknowledgement:
  16  *      This product includes software developed by TooLs GmbH.
  17  * 4. The name of TooLs GmbH may not be used to endorse or promote products
  18  *    derived from this software without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
  21  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  22  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  23  * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  25  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  26  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  27  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  28  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  29  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31 /*
  32  * Copyright (C) 2000 Benno Rice.
  33  * All rights reserved.
  34  *
  35  * Redistribution and use in source and binary forms, with or without
  36  * modification, are permitted provided that the following conditions
  37  * are met:
  38  * 1. Redistributions of source code must retain the above copyright
  39  *    notice, this list of conditions and the following disclaimer.
  40  * 2. Redistributions in binary form must reproduce the above copyright
  41  *    notice, this list of conditions and the following disclaimer in the
  42  *    documentation and/or other materials provided with the distribution.
  43  *
  44  * THIS SOFTWARE IS PROVIDED BY Benno Rice ``AS IS'' AND ANY EXPRESS OR
  45  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  46  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  47  * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  48  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  49  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  50  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  51  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  52  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  53  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  54  *
  55  * $NetBSD: openfirm.h,v 1.1 1998/05/15 10:16:00 tsubai Exp $
  56  * $FreeBSD: src/sys/boot/ofw/libofw/openfirm.h,v 1.8 2002/07/18 12:39:02 benno Exp $
  57  * $DragonFly: src/sys/boot/ofw/libofw/openfirm.h,v 1.1 2003/11/10 06:08:37 dillon Exp $
  58  */
  59 #ifndef _OPENFIRM_H_
  60 #define _OPENFIRM_H_
  61 /*
  62  * Prototypes for Openfirmware Interface Routines
  63  */
  64
  65 #include <sys/cdefs.h>
  66 #include <sys/types.h>
  67
  68 typedef unsigned int            ihandle_t;
  69 typedef unsigned int            phandle_t;
  70 typedef unsigned long int       cell_t;
  71
  72 extern int              (*openfirmware)(void *);
  73 extern phandle_t        chosen;
  74 extern ihandle_t        memory, mmu;
  75
  76 /*
  77  * This isn't actually an OpenFirmware function, but it seemed like the right
  78  * place for it to go.
  79  */
  80 void            OF_init(int (*openfirm)(void *));
  81
  82 /* Generic functions */
  83 int             OF_test(char *);
  84
  85 /* Device tree functions */
  86 phandle_t       OF_peer(phandle_t);
  87 phandle_t       OF_child(phandle_t);
  88 phandle_t       OF_parent(phandle_t);
  89 phandle_t       OF_instance_to_package(ihandle_t);
  90 int             OF_getproplen(phandle_t, char *);
  91 int             OF_getprop(phandle_t, char *, void *, int);
  92 int             OF_nextprop(phandle_t, char *, char *);
  93 int             OF_setprop(phandle_t, 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
 107 /* Memory functions */
 108 void            *OF_claim(void *, u_int, u_int);
 109 vm_offset_t     OF_claim_virt(vm_offset_t, size_t, int);
 110 void            *OF_alloc_phys(size_t, int);
 111 void            OF_release(void *, u_int);
 112 void            OF_release_phys(vm_offset_t, u_int);
 113
 114 /* Control transfer functions */
 115 void            OF_boot(char *);
 116 void            OF_enter(void);
 117 void            OF_exit(void) __attribute__((noreturn));
 118 void            OF_chain(void *, u_int, void (*)(), void *, u_int);
 119
 120 #if 0
 121 /* User interface functions */
 122 /* OF_interpret */
 123 void            *OF_set_callback(void *);
 124 void            OF_set_symbol_lookup(void *, void *);
 125 #endif
 126
 127 /* Time function */
 128 int             OF_milliseconds(void);
 129 #endif /* _OPENFIRM_H_ */