441ddb6204edf1d43a71fe0dc8f613f8fc94a480
[dragonfly.git] / 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: src/sys/sys/rman.h,v 1.5.2.1 2001/06/05 08:06:07 imp Exp $
30  * $DragonFly: src/sys/sys/rman.h,v 1.11 2008/09/30 12:20:29 hasso Exp $
31  */
32
33 #ifndef _SYS_RMAN_H_
34 #define _SYS_RMAN_H_
35
36 #ifndef _SYS_TYPES_H_
37 #include <sys/types.h>
38 #endif
39 #ifndef _SYS_QUEUE_H_
40 #include <sys/queue.h>
41 #endif
42 #ifndef _SYS_BUS_H_
43 #include <sys/bus.h>    /* bus_space_tag_t */
44 #endif
45
46 #define RF_ALLOCATED    0x0001  /* resource has been reserved */
47 #define RF_ACTIVE       0x0002  /* resource allocation has been activated */
48 #define RF_SHAREABLE    0x0004  /* resource permits contemporaneous sharing */
49 #define RF_TIMESHARE    0x0008  /* resource permits time-division sharing */
50 #define RF_WANTED       0x0010  /* somebody is waiting for this resource */
51 #define RF_FIRSTSHARE   0x0020  /* first in sharing list */
52 #define RF_PREFETCHABLE 0x0040  /* resource is prefetchable */
53 #define RF_OPTIONAL     0x0080  /* for bus_alloc_resources() */
54
55 #define RF_ALIGNMENT_SHIFT      10 /* alignment size bit starts bit 10 */
56 #define RF_ALIGNMENT_MASK       (0x003F << RF_ALIGNMENT_SHIFT)
57                                 /* resource address alignemnt size bit mask */
58 #define RF_ALIGNMENT_LOG2(x)    ((x) << RF_ALIGNMENT_SHIFT)
59 #define RF_ALIGNMENT(x)         (((x) & RF_ALIGNMENT_MASK) >> RF_ALIGNMENT_SHIFT)
60
61 enum    rman_type { RMAN_UNINIT = 0, RMAN_GAUGE, RMAN_ARRAY };
62
63 /*
64  * String length exported to userspace for resource names, etc.
65  */
66 #define RM_TEXTLEN      32
67
68 /*
69  * Userspace-exported structures.
70  */
71 struct u_resource {
72         uintptr_t       r_handle;               /* resource uniquifier */
73         uintptr_t       r_parent;               /* parent rman */
74         uintptr_t       r_device;               /* device owning this resource */
75         char            r_devname[RM_TEXTLEN];  /* device name XXX obsolete */
76
77         u_long          r_start;                /* offset in resource space */
78         u_long          r_size;                 /* size in resource space */
79         u_int           r_flags;                /* RF_* flags */
80 };
81
82 struct u_rman {
83         uintptr_t       rm_handle;              /* rman uniquifier */
84         char            rm_descr[RM_TEXTLEN];   /* rman description */
85
86         u_long          rm_start;               /* base of managed region */
87         u_long          rm_size;                /* size of managed region */
88         enum rman_type  rm_type;                /* region type */
89 };
90
91 #ifdef _KERNEL
92 /*
93  * We use a linked list rather than a bitmap because we need to be able to
94  * represent potentially huge objects (like all of a processor's physical
95  * address space).  That is also why the indices are defined to have type
96  * `unsigned long' -- that being the largest integral type in Standard C.
97  */
98 TAILQ_HEAD(resource_head, resource);
99 struct  resource {
100         TAILQ_ENTRY(resource)   r_link;
101         LIST_ENTRY(resource)    r_sharelink;
102         LIST_HEAD(, resource)   *r_sharehead;
103         u_long  r_start;        /* index of the first entry in this resource */
104         u_long  r_end;          /* index of the last entry (inclusive) */
105         u_int   r_flags;
106         void    *r_virtual;     /* virtual address of this resource */
107         bus_space_tag_t r_bustag; /* bus_space tag */
108         bus_space_handle_t r_bushandle; /* bus_space handle */
109         struct  device *r_dev;  /* device which has allocated this resource */
110         struct  rman *r_rm;     /* resource manager from whence this came */
111 };
112
113 struct lwkt_token;
114 struct lwkt_tokref;
115
116 struct  rman {
117         struct  resource_head   rm_list;
118         struct  lwkt_token      *rm_slock; /* mutex used to protect rm_list */
119         TAILQ_ENTRY(rman)       rm_link; /* link in list of all rmans */
120         u_long  rm_start;       /* index of globally first entry */
121         u_long  rm_end;         /* index of globally last entry */
122         enum    rman_type rm_type; /* what type of resource this is */
123         const   char *rm_descr; /* text descripion of this resource */
124 };
125 TAILQ_HEAD(rman_head, rman);
126
127 int     rman_activate_resource(struct resource *r);
128 int     rman_await_resource(struct resource *r, struct lwkt_tokref *ilock, int slpflags, int timo);
129 int     rman_deactivate_resource(struct resource *r);
130 int     rman_fini(struct rman *rm);
131 int     rman_init(struct rman *rm);
132 int     rman_manage_region(struct rman *rm, u_long start, u_long end);
133 int     rman_release_resource(struct resource *r);
134 struct  resource *rman_reserve_resource(struct rman *rm, u_long start,
135                                         u_long end, u_long count,
136                                         u_int flags, struct device *dev);
137 uint32_t rman_make_alignment_flags(uint32_t size);
138
139 #define rman_get_start(r)       ((r)->r_start)
140 #define rman_get_end(r)         ((r)->r_end)
141 #define rman_get_device(r)      ((r)->r_dev)
142 #define rman_set_device(r,dev)  ((r)->r_dev = (dev))
143 #define rman_get_size(r)        ((r)->r_end - (r)->r_start + 1)
144 #define rman_get_flags(r)       ((r)->r_flags)
145 #define rman_set_virtual(r,v)   ((r)->r_virtual = (v))
146 #define rman_get_virtual(r)     ((r)->r_virtual)
147 #define rman_set_bustag(r,t)    ((r)->r_bustag = (t))
148 #define rman_get_bustag(r)      ((r)->r_bustag)
149 #define rman_set_bushandle(r,h) ((r)->r_bushandle = (h))
150 #define rman_get_bushandle(r)   ((r)->r_bushandle)
151
152 extern  struct rman_head rman_head;
153 #endif /* _KERNEL */
154
155 #endif /* !_SYS_RMAN_H_ */