rman.h revision 68727
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 68727 2000-11-14 20:46:02Z mckusick $ 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 46#define RF_ALIGNMENT_SHIFT 10 /* alignment size bit starts bit 10 */ 47#define RF_ALIGNMENT_MASK (0x003F << RF_ALIGNMENT_SHIFT) 48 /* resource address alignemnt size bit mask */ 49#define RF_ALIGNMENT_LOG2(x) ((x) << RF_ALIGNMENT_SHIFT) 50#define RF_ALIGNMENT(x) (((x) & RF_ALIGNMENT_MASK) >> RF_ALIGNMENT_SHIFT) 51 52enum rman_type { RMAN_UNINIT = 0, RMAN_GAUGE, RMAN_ARRAY }; 53 54/* 55 * String length exported to userspace for resource names, etc. 56 */ 57#define RM_TEXTLEN 32 58 59/* 60 * Userspace-exported structures. 61 */ 62struct u_resource { 63 uintptr_t r_handle; /* resource uniquifier */ 64 uintptr_t r_parent; /* parent rman */ 65 uintptr_t r_device; /* device owning this resource */ 66 char r_devname[RM_TEXTLEN]; /* device name XXX obsolete */ 67 68 u_long r_start; /* offset in resource space */ 69 u_long r_size; /* size in resource space */ 70 u_int r_flags; /* RF_* flags */ 71}; 72 73struct u_rman { 74 uintptr_t rm_handle; /* rman uniquifier */ 75 char rm_descr[RM_TEXTLEN]; /* rman description */ 76 77 u_long rm_start; /* base of managed region */ 78 u_long rm_size; /* size of managed region */ 79 enum rman_type rm_type; /* region type */ 80}; 81 82#ifdef _KERNEL 83/* 84 * We use a linked list rather than a bitmap because we need to be able to 85 * represent potentially huge objects (like all of a processor's physical 86 * address space). That is also why the indices are defined to have type 87 * `unsigned long' -- that being the largest integral type in ISO C (1990). 88 * The 1999 version of C allows `long long'; we may need to switch to that 89 * at some point in the future, particularly if we want to support 36-bit 90 * addresses on IA32 hardware. 91 */ 92TAILQ_HEAD(resource_head, resource); 93struct resource { 94 TAILQ_ENTRY(resource) r_link; 95 LIST_ENTRY(resource) r_sharelink; 96 LIST_HEAD(, resource) *r_sharehead; 97 u_long r_start; /* index of the first entry in this resource */ 98 u_long r_end; /* index of the last entry (inclusive) */ 99 u_int r_flags; 100 void *r_virtual; /* virtual address of this resource */ 101 bus_space_tag_t r_bustag; /* bus_space tag */ 102 bus_space_handle_t r_bushandle; /* bus_space handle */ 103 struct device *r_dev; /* device which has allocated this resource */ 104 struct rman *r_rm; /* resource manager from whence this came */ 105}; 106 107struct rman { 108 struct resource_head rm_list; 109 struct simplelock *rm_slock; /* mutex used to protect rm_list */ 110 TAILQ_ENTRY(rman) rm_link; /* link in list of all rmans */ 111 u_long rm_start; /* index of globally first entry */ 112 u_long rm_end; /* index of globally last entry */ 113 enum rman_type rm_type; /* what type of resource this is */ 114 const char *rm_descr; /* text descripion of this resource */ 115}; 116TAILQ_HEAD(rman_head, rman); 117 118int rman_activate_resource(struct resource *r); 119int rman_await_resource(struct resource *r, int pri, int timo); 120int rman_deactivate_resource(struct resource *r); 121int rman_fini(struct rman *rm); 122int rman_init(struct rman *rm); 123int rman_manage_region(struct rman *rm, u_long start, u_long end); 124int rman_release_resource(struct resource *r); 125struct resource *rman_reserve_resource(struct rman *rm, u_long start, 126 u_long end, u_long count, 127 u_int flags, struct device *dev); 128uint32_t rman_make_alignment_flags(uint32_t size); 129 130#define rman_get_start(r) ((r)->r_start) 131#define rman_get_end(r) ((r)->r_end) 132#define rman_get_size(r) (((r)->r_end - (r)->r_start) + 1) 133#define rman_get_flags(r) ((r)->r_flags) 134#define rman_set_virtual(r,v) ((r)->r_virtual = (v)) 135#define rman_get_virtual(r) ((r)->r_virtual) 136#define rman_set_bustag(r,t) ((r)->r_bustag = (t)) 137#define rman_get_bustag(r) ((r)->r_bustag) 138#define rman_set_bushandle(r,h) ((r)->r_bushandle = (h)) 139#define rman_get_bushandle(r) ((r)->r_bushandle) 140 141extern struct rman_head rman_head; 142#endif /* _KERNEL */ 143 144#endif /* !_SYS_RMAN_H_ */ 145