sys/sys/rman.h

   1 /*
   2  * Copyright 1998 Massachusetts Institute of Technology
   3  *
   4  * Permission to use, copy, modify, and distribute this software and
   5  * its documentation for any purpose and without fee is hereby
   6  * granted, provided that both the above copyright notice and this
   7  * permission notice appear in all copies, that both the above
   8  * copyright notice and this permission notice appear in all
   9  * supporting documentation, and that the name of M.I.T. not be used
  10  * in advertising or publicity pertaining to distribution of the
  11  * software without specific, written prior permission.  M.I.T. makes
  12  * no representations about the suitability of this software for any
  13  * purpose.  It is provided "as is" without express or implied
  14  * warranty.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''.  M.I.T. DISCLAIMS
  17  * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
  18  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  19  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
  20  * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  23  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  25  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  26  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  * $FreeBSD$
  30  */
  31
  32 #ifndef _SYS_RMAN_H_
  33 #define _SYS_RMAN_H_    1
  34
  35 #ifndef _KERNEL
  36 #include <sys/queue.h>
  37 #endif
  38
  39 #define RF_ALLOCATED    0x0001  /* resource has been reserved */
  40 #define RF_ACTIVE       0x0002  /* resource allocation has been activated */
  41 #define RF_SHAREABLE    0x0004  /* resource permits contemporaneous sharing */
  42 #define RF_TIMESHARE    0x0008  /* resource permits time-division sharing */
  43 #define RF_WANTED       0x0010  /* somebody is waiting for this resource */
  44 #define RF_FIRSTSHARE   0x0020  /* first in sharing list */
  45 #define RF_PREFETCHABLE 0x0040  /* resource is prefetchable */
  46
  47 #define RF_ALIGNMENT_SHIFT      10 /* alignment size bit starts bit 10 */
  48 #define RF_ALIGNMENT_MASK       (0x003F << RF_ALIGNMENT_SHIFT)
  49                                 /* resource address alignemnt size bit mask */
  50 #define RF_ALIGNMENT_LOG2(x)    ((x) << RF_ALIGNMENT_SHIFT)
  51 #define RF_ALIGNMENT(x)         (((x) & RF_ALIGNMENT_MASK) >> RF_ALIGNMENT_SHIFT)
  52
  53 enum    rman_type { RMAN_UNINIT = 0, RMAN_GAUGE, RMAN_ARRAY };
  54
  55 /*
  56  * String length exported to userspace for resource names, etc.
  57  */
  58 #define RM_TEXTLEN      32
  59
  60 /*
  61  * Userspace-exported structures.
  62  */
  63 struct u_resource {
  64         uintptr_t       r_handle;               /* resource uniquifier */
  65         uintptr_t       r_parent;               /* parent rman */
  66         uintptr_t       r_device;               /* device owning this resource */
  67         char            r_devname[RM_TEXTLEN];  /* device name XXX obsolete */
  68
  69         u_long          r_start;                /* offset in resource space */
  70         u_long          r_size;                 /* size in resource space */
  71         u_int           r_flags;                /* RF_* flags */
  72 };
  73
  74 struct u_rman {
  75         uintptr_t       rm_handle;              /* rman uniquifier */
  76         char            rm_descr[RM_TEXTLEN];   /* rman description */
  77
  78         u_long          rm_start;               /* base of managed region */
  79         u_long          rm_size;                /* size of managed region */
  80         enum rman_type  rm_type;                /* region type */
  81 };
  82
  83 #ifdef _KERNEL
  84 /*
  85  * We use a linked list rather than a bitmap because we need to be able to
  86  * represent potentially huge objects (like all of a processor's physical
  87  * address space).  That is also why the indices are defined to have type
  88  * `unsigned long' -- that being the largest integral type in ISO C (1990).
  89  * The 1999 version of C allows `long long'; we may need to switch to that
  90  * at some point in the future, particularly if we want to support 36-bit
  91  * addresses on IA32 hardware.
  92  */
  93 TAILQ_HEAD(resource_head, resource);
  94 struct resource {
  95         TAILQ_ENTRY(resource)   r_link;
  96         LIST_ENTRY(resource)    r_sharelink;
  97         LIST_HEAD(, resource)   *r_sharehead;
  98         u_long  r_start;        /* index of the first entry in this resource */
  99         u_long  r_end;          /* index of the last entry (inclusive) */
 100         u_int   r_flags;
 101         void    *r_virtual;     /* virtual address of this resource */
 102         bus_space_tag_t r_bustag; /* bus_space tag */
 103         bus_space_handle_t r_bushandle; /* bus_space handle */
 104         struct  device *r_dev;  /* device which has allocated this resource */
 105         struct  rman *r_rm;     /* resource manager from whence this came */
 106 };
 107
 108 struct rman {
 109         struct  resource_head   rm_list;
 110         struct  mtx *rm_mtx;    /* mutex used to protect rm_list */
 111         TAILQ_ENTRY(rman)       rm_link; /* link in list of all rmans */
 112         u_long  rm_start;       /* index of globally first entry */
 113         u_long  rm_end;         /* index of globally last entry */
 114         enum    rman_type rm_type; /* what type of resource this is */
 115         const   char *rm_descr; /* text descripion of this resource */
 116 };
 117 TAILQ_HEAD(rman_head, rman);
 118
 119 int     rman_activate_resource(struct resource *r);
 120 int     rman_await_resource(struct resource *r, int pri, int timo);
 121 int     rman_deactivate_resource(struct resource *r);
 122 int     rman_fini(struct rman *rm);
 123 int     rman_init(struct rman *rm);
 124 int     rman_manage_region(struct rman *rm, u_long start, u_long end);
 125 int     rman_release_resource(struct resource *r);
 126 struct resource *rman_reserve_resource(struct rman *rm, u_long start,
 127                                         u_long end, u_long count,
 128                                         u_int flags, struct device *dev);
 129 struct resource *rman_reserve_resource_bound(struct rman *rm, u_long start,
 130                                         u_long end, u_long count, u_long bound,
 131                                         u_int flags, struct device *dev);
 132 uint32_t rman_make_alignment_flags(uint32_t size);
 133
 134 #define rman_get_start(r)       ((r)->r_start)
 135 #define rman_get_end(r)         ((r)->r_end)
 136 #define rman_get_size(r)        (((r)->r_end - (r)->r_start) + 1)
 137 #define rman_get_flags(r)       ((r)->r_flags)
 138 #define rman_set_virtual(r,v)   ((r)->r_virtual = (v))
 139 #define rman_get_virtual(r)     ((r)->r_virtual)
 140 #define rman_set_bustag(r,t)    ((r)->r_bustag = (t))
 141 #define rman_get_bustag(r)      ((r)->r_bustag)
 142 #define rman_set_bushandle(r,h) ((r)->r_bushandle = (h))
 143 #define rman_get_bushandle(r)   ((r)->r_bushandle)
 144
 145 extern  struct rman_head rman_head;
 146 #endif /* _KERNEL */
 147
 148 #endif /* !_SYS_RMAN_H_ */