rman.h revision 150523
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: head/sys/sys/rman.h 150523 2005-09-24 20:07:03Z phk $ 30 */ 31 32#ifndef _SYS_RMAN_H_ 33#define _SYS_RMAN_H_ 1 34 35#ifndef _KERNEL 36#include <sys/queue.h> 37#else 38#include <machine/bus.h> 39#include <machine/resource.h> 40#endif 41 42#define RF_ALLOCATED 0x0001 /* resource has been reserved */ 43#define RF_ACTIVE 0x0002 /* resource allocation has been activated */ 44#define RF_SHAREABLE 0x0004 /* resource permits contemporaneous sharing */ 45#define RF_TIMESHARE 0x0008 /* resource permits time-division sharing */ 46#define RF_WANTED 0x0010 /* somebody is waiting for this resource */ 47#define RF_FIRSTSHARE 0x0020 /* first in sharing list */ 48#define RF_PREFETCHABLE 0x0040 /* resource is prefetchable */ 49#define RF_OPTIONAL 0x0080 /* for bus_alloc_resources() */ 50 51#define RF_ALIGNMENT_SHIFT 10 /* alignment size bit starts bit 10 */ 52#define RF_ALIGNMENT_MASK (0x003F << RF_ALIGNMENT_SHIFT) 53 /* resource address alignemnt size bit mask */ 54#define RF_ALIGNMENT_LOG2(x) ((x) << RF_ALIGNMENT_SHIFT) 55#define RF_ALIGNMENT(x) (((x) & RF_ALIGNMENT_MASK) >> RF_ALIGNMENT_SHIFT) 56 57enum rman_type { RMAN_UNINIT = 0, RMAN_GAUGE, RMAN_ARRAY }; 58 59/* 60 * String length exported to userspace for resource names, etc. 61 */ 62#define RM_TEXTLEN 32 63 64/* 65 * Userspace-exported structures. 66 */ 67struct u_resource { 68 uintptr_t r_handle; /* resource uniquifier */ 69 uintptr_t r_parent; /* parent rman */ 70 uintptr_t r_device; /* device owning this resource */ 71 char r_devname[RM_TEXTLEN]; /* device name XXX obsolete */ 72 73 u_long r_start; /* offset in resource space */ 74 u_long r_size; /* size in resource space */ 75 u_int r_flags; /* RF_* flags */ 76}; 77 78struct u_rman { 79 uintptr_t rm_handle; /* rman uniquifier */ 80 char rm_descr[RM_TEXTLEN]; /* rman description */ 81 82 u_long rm_start; /* base of managed region */ 83 u_long rm_size; /* size of managed region */ 84 enum rman_type rm_type; /* region type */ 85}; 86 87#ifdef _KERNEL 88 89/* 90 * The public (kernel) view of struct resource 91 * 92 * NB: Changing the offset/size/type of existing fields in struct resource 93 * NB: breaks the device driver ABI and is strongly FORBIDDEN. 94 * NB: Appending new fields is probably just misguided. 95 */ 96 97struct resource { 98 struct resource_i *__r_i; 99 bus_space_tag_t r_bustag; /* bus_space tag */ 100 bus_space_handle_t r_bushandle; /* bus_space handle */ 101}; 102 103/* 104 * We use a linked list rather than a bitmap because we need to be able to 105 * represent potentially huge objects (like all of a processor's physical 106 * address space). That is also why the indices are defined to have type 107 * `unsigned long' -- that being the largest integral type in ISO C (1990). 108 * The 1999 version of C allows `long long'; we may need to switch to that 109 * at some point in the future, particularly if we want to support 36-bit 110 * addresses on IA32 hardware. 111 */ 112TAILQ_HEAD(resource_head, resource_i); 113#ifdef __RMAN_RESOURCE_VISIBLE 114struct resource_i { 115 struct resource r_r; 116 TAILQ_ENTRY(resource_i) r_link; 117 LIST_ENTRY(resource_i) r_sharelink; 118 LIST_HEAD(, resource_i) *r_sharehead; 119 u_long r_start; /* index of the first entry in this resource */ 120 u_long r_end; /* index of the last entry (inclusive) */ 121 u_int r_flags; 122 void *r_virtual; /* virtual address of this resource */ 123 struct device *r_dev; /* device which has allocated this resource */ 124 struct rman *r_rm; /* resource manager from whence this came */ 125 void *r_spare1; /* Spare pointer 1 */ 126 void *r_spare2; /* Spare pointer 2 */ 127 int r_rid; /* optional rid for this resource. */ 128}; 129#else 130struct device; 131#endif 132 133struct rman { 134 struct resource_head rm_list; 135 struct mtx *rm_mtx; /* mutex used to protect rm_list */ 136 TAILQ_ENTRY(rman) rm_link; /* link in list of all rmans */ 137 u_long rm_start; /* index of globally first entry */ 138 u_long rm_end; /* index of globally last entry */ 139 enum rman_type rm_type; /* what type of resource this is */ 140 const char *rm_descr; /* text descripion of this resource */ 141}; 142TAILQ_HEAD(rman_head, rman); 143 144int rman_activate_resource(struct resource *r); 145int rman_await_resource(struct resource *r, int pri, int timo); 146bus_space_handle_t rman_get_bushandle(struct resource *); 147bus_space_tag_t rman_get_bustag(struct resource *); 148u_long rman_get_end(struct resource *); 149struct device *rman_get_device(struct resource *); 150u_int rman_get_flags(struct resource *); 151int rman_get_rid(struct resource *); 152u_long rman_get_size(struct resource *); 153u_long rman_get_start(struct resource *); 154void *rman_get_virtual(struct resource *); 155int rman_deactivate_resource(struct resource *r); 156int rman_fini(struct rman *rm); 157int rman_init(struct rman *rm); 158uint32_t rman_make_alignment_flags(uint32_t size); 159int rman_manage_region(struct rman *rm, u_long start, u_long end); 160int rman_release_resource(struct resource *r); 161struct resource *rman_reserve_resource(struct rman *rm, u_long start, 162 u_long end, u_long count, 163 u_int flags, struct device *dev); 164struct resource *rman_reserve_resource_bound(struct rman *rm, u_long start, 165 u_long end, u_long count, u_long bound, 166 u_int flags, struct device *dev); 167void rman_set_bushandle(struct resource *_r, bus_space_handle_t _h); 168void rman_set_bustag(struct resource *_r, bus_space_tag_t _t); 169void rman_set_device(struct resource *_r, struct device *_dev); 170void rman_set_end(struct resource *_r, u_long _end); 171void rman_set_rid(struct resource *_r, int _rid); 172void rman_set_start(struct resource *_r, u_long _start); 173void rman_set_virtual(struct resource *_r, void *_v); 174 175extern struct rman_head rman_head; 176#endif /* _KERNEL */ 177 178#endif /* !_SYS_RMAN_H_ */ 179