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