2 .\" Copyright (c) 2004 The DragonFly Project. All rights reserved.
4 .\" This code is derived from software contributed to The DragonFly Project
5 .\" by Hiten Pandya <hmp@backplane.com>.
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\" notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\" notice, this list of conditions and the following disclaimer in
15 .\" the documentation and/or other materials provided with the
17 .\" 3. Neither the name of The DragonFly Project nor the names of its
18 .\" contributors may be used to endorse or promote products derived
19 .\" from this software without specific, prior written permission.
21 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 .\" Copyright (c) 2003 Bruce M Simpson <bms@spc.org>
35 .\" All rights reserved.
37 .\" Redistribution and use in source and binary forms, with or without
38 .\" modification, are permitted provided that the following conditions
40 .\" 1. Redistributions of source code must retain the above copyright
41 .\" notice, this list of conditions and the following disclaimer.
42 .\" 2. Redistributions in binary form must reproduce the above copyright
43 .\" notice, this list of conditions and the following disclaimer in the
44 .\" documentation and/or other materials provided with the distribution.
46 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
47 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
48 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
49 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
50 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
51 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
52 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
53 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
54 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
55 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
58 .\" $FreeBSD: src/share/man/man9/rman.9,v 1.2 2003/05/30 21:13:32 ru Exp $
59 .\" $DragonFly: src/share/man/man9/rman.9,v 1.4 2006/10/27 22:39:05 swildner Exp $
66 .Nm rman_activate_resource ,
67 .Nm rman_await_resource ,
68 .Nm rman_deactivate_resource ,
71 .Nm rman_manage_region ,
72 .Nm rman_release_resource ,
73 .Nm rman_reserve_resource ,
74 .\".Nm rman_reserve_resource_bound ,
75 .Nm rman_make_alignment_flags ,
81 .Nm rman_set_virtual ,
82 .Nm rman_get_virtual ,
85 .Nm rman_set_bushandle ,
86 .Nm rman_get_bushandle ,
89 .Nd resource management functions
94 .Fn rman_activate_resource "struct resource *r"
96 .Fn rman_await_resource "struct resource *r" "int pri2" "int timo"
98 .Fn rman_deactivate_resource "struct resource *r"
100 .Fn rman_fini "struct rman *rm"
102 .Fn rman_init "struct rman *rm"
104 .Fn rman_manage_region "struct rman *rm" "u_long start" "u_long end"
106 .Fn rman_release_resource "struct resource *r"
107 .Ft "struct resource *"
108 .Fo rman_reserve_resource
109 .Fa "struct rman *rm" "u_long start" "u_long end" "u_long count"
110 .Fa "u_int flags" "struct device *dev"
112 .\".Ft "struct resource *"
113 .\".Fo rman_reserve_resource_bound
114 .\".Fa "struct rman *rm" "u_long start" "u_long end" "u_long count"
115 .\".Fa "u_long bound" "u_int flags" "struct device *dev"
118 .Fn rman_make_alignment_flags "uint32_t size"
121 .Fn rman_get_start "struct resource *r"
123 .Fn rman_get_end "struct resource *r"
124 .Ft "struct device *"
125 .Fn rman_get_device "struct resource *r"
127 .Fn rman_get_size "struct resource *r"
129 .Fn rman_get_flags "struct resource *r"
131 .Fn rman_set_virtual "struct resource *r" "void *v"
133 .Fn rman_get_virtual "struct resource *r"
135 .Fn rman_set_bustag "struct resource *r" "bus_space_tag_t t"
137 .Fn rman_get_bustag "struct resource *r"
139 .Fn rman_set_bushandle "struct resource *r" "bus_space_handle_t h"
140 .Ft bus_space_handle_t
141 .Fn rman_get_bushandle "struct resource *r"
143 .\".Fn rman_set_rid "struct resource *r" "int rid"
145 .\".Fn rman_get_rid "struct resource *r"
149 set of functions provides a flexible resource management abstraction,
150 they are used extensively by the bus management code.
151 It implements the abstractions of region and resource.
152 A region descriptor is used to manage a region; this could be memory or
153 some other form of bus space.
155 Each region has a set of bounds.
156 Within these bounds, allocated segments may reside.
157 Each segment, termed a resource, has several properties which are
158 represented by a 16-bit flag register, as follows.
160 #define RF_ALLOCATED 0x0001 /* resource has been reserved */
161 #define RF_ACTIVE 0x0002 /* resource allocation has been activated */
162 #define RF_SHAREABLE 0x0004 /* resource permits contemporaneous sharing */
163 #define RF_TIMESHARE 0x0008 /* resource permits time-division sharing */
164 #define RF_WANTED 0x0010 /* somebody is waiting for this resource */
165 #define RF_FIRSTSHARE 0x0020 /* first in sharing list */
166 #define RF_PREFETCHABLE 0x0040 /* resource is prefetchable */
169 The remainder of the flag bits are used to represent the desired alignment
170 of the resource within the region.
174 function initializes the region descriptor, pointed to by the
176 argument, for use with the resource management functions.
177 It also initializes any mutexes associated with the structure.
181 function frees any structures associated with the structure
185 If any of the resources within the managed region have the
187 flag set, it will return
189 otherwise, any mutexes associated with the structure will be released
190 and destroyed, and the function will return 0.
193 .Fn rman_manage_region
194 function establishes the concept of a region which is under
199 argument points to the region descriptor.
204 arguments specify the bounds of the region.
207 This interface is not robust against programming errors which
208 add multiple copies of the same region.
211 .\".Fn rman_reserve_resource_bound
212 .\"function is where the bulk of the
215 .\"It attempts to reserve a contiguous range in the specified region
217 .\"for the use of the device
219 .\"The caller can specify the
223 .\"of an acceptable range, as well as
224 .\"alignment, and the code will attempt to find a free segment which fits.
225 .\"The default behavior is to allocate an exclusive segment, unless the
229 .\"flags are set, in which case a shared
230 .\"segment will be allocated.
231 .\"If this shared segment already exists, the caller has its device
232 .\"added to the list of consumers.
235 .Fn rman_reserve_resource
236 function is used to reserve resources within a previously established region.
237 .\"It is a simplified interface to
238 .\".Fn rman_reserve_resource_bound
239 .\"which passes 0 for the
244 .Fn rman_make_alignment_flags
245 function returns the flag mask corresponding to the desired alignment
247 .\"This should be used when calling
248 .\".Fn rman_reserve_resource_bound .
251 .Fn rman_release_resource
252 function releases the reserved resource
254 It may attempt to merge adjacent free resources.
257 .Fn rman_activate_resource
258 function marks a resource as active, by setting the
261 If this is a time shared resource, and the caller has not yet acquired
262 the resource, the function returns
266 .Fn rman_deactivate_resource
267 function marks a resource
269 as inactive, by clearing the
272 If other consumers are waiting for this range, it will wakeup their threads.
275 .Fn rman_await_resource
276 function performs an asynchronous wait for a resource
278 to become inactive, that is, for the
281 It is used to enable cooperative sharing of a resource
282 which can only be safely used by one thread at a time.
288 .Fn rman_await_resource
297 functions return the bounds, size and flags of the previously reserved
303 function associates a
310 function is used to retrieve this tag once set.
313 .Fn rman_set_bushandle
314 function associates a
315 .Vt bus_space_handle_t
320 .Fn rman_get_bushandle
321 function is used to retrieve this handle once set.
325 function is used to associate a kernel virtual address with a resource
329 function can be used to retrieve the KVA once set.
333 .\"function associates a resource identifier with a resource
337 .\"function retrieves this RID.
341 function returns a pointer to the device which reserved the resource
344 .\".Xr bus_activate_resource 9 ,
345 .Xr bus_alloc_resource 9
346 .Xr bus_release_resource 9 ,
347 .\".Xr bus_set_resource 9 ,
350 This manual page was written by
351 .An Bruce M Simpson Aq bms@spc.org ,
353 .An Hiten Pandya Aq hmp@backplane.com .