lib/libdevinfo/devinfo.h

   1 /*-
   2  * Copyright (c) 2000 Michael Smith
   3  * Copyright (c) 2000 BSDi
   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  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  * $FreeBSD: src/lib/libdevinfo/devinfo.h,v 1.5 2005/08/31 14:57:39 rodrigc Exp $
  28  * $DragonFly: src/lib/libdevinfo/devinfo.h,v 1.1 2008/09/30 12:20:29 hasso Exp $
  29  */
  30
  31 #ifndef _DEVINFO_H_INCLUDED
  32 #define _DEVINFO_H_INCLUDED
  33
  34 #include <sys/cdefs.h>
  35 #include <sys/types.h>
  36
  37 typedef __uintptr_t     devinfo_handle_t;
  38 #define DEVINFO_ROOT_DEVICE     ((devinfo_handle_t)0)
  39
  40 /*
  41  * State of the device.
  42  */
  43 /* XXX not sure if I want a copy here, or expose sys/bus.h */
  44 typedef enum devinfo_state {
  45         DIS_NOTPRESENT,                 /* not probed or probe failed */
  46         DIS_ALIVE,                      /* probe succeeded */
  47         DIS_INPROGRESS,                 /* attach in progress */
  48         DIS_ATTACHED,                   /* attach method called */
  49         DIS_BUSY                        /* device is open */
  50 } devinfo_state_t;
  51
  52 struct devinfo_dev {
  53         devinfo_handle_t        dd_handle;      /* device handle */
  54         devinfo_handle_t        dd_parent;      /* parent handle */
  55
  56         char                    *dd_name;       /* name of device */
  57         char                    *dd_desc;       /* device description */
  58         char                    *dd_drivername; /* name of attached driver*/
  59         char                    *dd_pnpinfo;    /* pnp info from parent bus */
  60         char                    *dd_location;   /* Where bus thinks dev at */
  61         uint32_t                dd_devflags;    /* API flags */
  62         uint16_t                dd_flags;       /* internal dev flags */
  63 #define DIF_ENABLED     0x0001          /* device should be probed/attached */
  64         devinfo_state_t         dd_state;       /* attachement state of dev */
  65 };
  66
  67 struct devinfo_rman {
  68         devinfo_handle_t        dm_handle;      /* resource manager handle */
  69
  70         unsigned long           dm_start;       /* resource start */
  71         unsigned long           dm_size;        /* resource size */
  72
  73         char                    *dm_desc;       /* resource description */
  74 };
  75
  76 struct devinfo_res {
  77         devinfo_handle_t        dr_handle;      /* resource handle */
  78         devinfo_handle_t        dr_rman;        /* resource manager handle */
  79         devinfo_handle_t        dr_device;      /* owning device */
  80
  81         unsigned long           dr_start;       /* region start */
  82         unsigned long           dr_size;        /* region size */
  83         /* XXX add flags */
  84 };
  85
  86 __BEGIN_DECLS
  87
  88 /*
  89  * Acquire a coherent copy of the kernel's device and resource tables.
  90  * This must return success (zero) before any other interfaces will
  91  * function.  Sets errno on failure.
  92  */
  93 extern int      devinfo_init(void);
  94
  95 /*
  96  * Release the storage associated with the internal copy of the device
  97  * and resource tables. devinfo_init must be called before any attempt
  98  * is made to use any other interfaces.
  99  */
 100 extern void     devinfo_free(void);
 101
 102 /*
 103  * Find a device/resource/resource manager by its handle.
 104  */
 105 extern struct devinfo_dev
 106         *devinfo_handle_to_device(devinfo_handle_t handle);
 107 extern struct devinfo_res
 108         *devinfo_handle_to_resource(devinfo_handle_t handle);
 109 extern struct devinfo_rman
 110         *devinfo_handle_to_rman(devinfo_handle_t handle);
 111
 112 /*
 113  * Iterate over the children of a device, calling (fn) on each.  If
 114  * (fn) returns nonzero, abort the scan and return.
 115  */
 116 extern int
 117         devinfo_foreach_device_child(struct devinfo_dev *parent,
 118             int (* fn)(struct devinfo_dev *child, void *arg),
 119             void *arg);
 120
 121 /*
 122  * Iterate over all the resources owned by a device, calling (fn) on each.
 123  * If (fn) returns nonzero, abort the scan and return.
 124  */
 125 extern int
 126         devinfo_foreach_device_resource(struct devinfo_dev *dev,
 127             int (* fn)(struct devinfo_dev *dev,
 128             struct devinfo_res *res, void *arg),
 129             void *arg);
 130
 131 /*
 132  * Iterate over all the resources owned by a resource manager, calling (fn)
 133  * on each.  If (fn) returns nonzero, abort the scan and return.
 134  */
 135 extern int
 136         devinfo_foreach_rman_resource(struct devinfo_rman *rman,
 137             int (* fn)(struct devinfo_res *res, void *arg),
 138             void *arg);
 139
 140 /*
 141  * Iterate over all the resource managers, calling (fn) on each.  If (fn)
 142  * returns nonzero, abort the scan and return.
 143  */
 144 extern int
 145         devinfo_foreach_rman(int (* fn)(struct devinfo_rman *rman, void *arg),
 146             void *arg);
 147
 148 __END_DECLS
 149
 150 #endif /* ! _DEVINFO_H_INCLUDED */