sys/dev/ofw/openfirm.h

   1 /*      $NetBSD: openfirm.h,v 1.26 2007/12/25 18:33:40 perry 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 #ifndef _OPENFIRM_H_
  35 #define _OPENFIRM_H_
  36
  37 #include <prop/proplib.h>
  38
  39 /*
  40  * Prototypes for OpenFirmware Interface Routines
  41  */
  42
  43 /*
  44  * Machine-independent OpenFirmware-related structures.
  45  * XXX THESE DO NOT BELONG HERE.
  46  */
  47
  48 /*
  49  * Generic OpenFirmware probe argument.
  50  * This is how all probe structures must start
  51  * in order to support generic OpenFirmware device drivers.
  52  */
  53 struct ofbus_attach_args {
  54         const char      *oba_busname;
  55         char            oba_ofname[64];
  56         int             oba_phandle;
  57
  58         /*
  59          * Special unit field for disk devices.
  60          * This is a KLUDGE to work around the fact that OpenFirmware
  61          * doesn't probe the scsi bus completely.
  62          * YES, I THINK THIS IS A BUG IN THE OPENFIRMWARE DEFINITION!!! XXX
  63          * See also ofdisk.c.
  64          */
  65         int             oba_unit;
  66 };
  67
  68
  69 /*
  70  * Functions and variables provided by machine-dependent code.
  71  */
  72 extern char *OF_buf;
  73
  74 int     OF_peer(int);
  75 int     OF_child(int);
  76 int     OF_parent(int);
  77 int     OF_instance_to_package(int);
  78 int     OF_getproplen(int, const char *);
  79 int     OF_getprop(int, const char *, void *, int);
  80 int     OF_nextprop(int, const char *, void *);
  81 int     OF_setprop(int, const char *, const void *, int);
  82 int     OF_finddevice(const char *);
  83 int     OF_instance_to_path(int, char *, int);
  84 int     OF_package_to_path(int, char *, int);
  85 int     OF_call_method_1(const char *, int, int, ...);
  86 int     OF_call_method(const char *, int, int, int, ...);
  87 int     OF_open(const char *);
  88 void    OF_close(int);
  89 int     OF_read(int, void *, int);
  90 int     OF_write(int, const void *, int);
  91 int     OF_seek(int, u_quad_t);
  92 void    *OF_claim(void *, u_int, u_int);
  93 void    OF_release(void *, u_int);
  94 int     OF_milliseconds(void);
  95 void    OF_boot(const char *) __dead;
  96 void    OF_enter(void);
  97 void    OF_exit(void) __dead;
  98 int     OF_interpret(const char *, int, int, ...);
  99 void    (*OF_set_callback(void(*)(void *)))(void *);
 100 int     openfirmware(void *);
 101
 102 /*
 103  * Functions and variables provided by machine-independent code.
 104  */
 105 int     of_compatible(int, const char * const *);
 106 int     of_decode_int(const unsigned char *);
 107 int     of_packagename(int, char *, int);
 108 int     of_find_firstchild_byname(int, const char *);
 109 int     of_getnode_byname(int, const char *);
 110 boolean_t       of_to_uint32_prop(prop_dictionary_t, int, const char *,
 111     const char *);
 112 boolean_t       of_to_dataprop(prop_dictionary_t, int, const char *,
 113     const char *);
 114
 115 int     *of_network_decode_media(int, int *, int *);
 116 char    *of_get_mode_string(char *, int);
 117
 118 #endif /*_OPENFIRM_H_*/