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 $
65 .Nm rman_activate_resource ,
66 .\".Nm rman_await_resource ,
67 .Nm rman_deactivate_resource ,
70 .Nm rman_manage_region ,
71 .Nm rman_release_resource ,
72 .Nm rman_reserve_resource ,
73 .\".Nm rman_reserve_resource_bound ,
74 .Nm rman_make_alignment_flags ,
80 .Nm rman_set_virtual ,
81 .Nm rman_get_virtual ,
84 .Nm rman_set_bushandle ,
85 .Nm rman_get_bushandle ,
88 .Nd resource management functions
93 .Fn rman_activate_resource "struct resource *r"
95 .\".Fn rman_await_resource "struct resource *r" "int pri2" "int timo"
97 .Fn rman_deactivate_resource "struct resource *r"
99 .Fn rman_fini "struct rman *rm"
101 .Fn rman_init "struct rman *rm"
103 .Fn rman_manage_region "struct rman *rm" "u_long start" "u_long end"
105 .Fn rman_release_resource "struct resource *r"
106 .Ft "struct resource *"
107 .Fo rman_reserve_resource
108 .Fa "struct rman *rm" "u_long start" "u_long end" "u_long count"
109 .Fa "u_int flags" "struct device *dev"
111 .\".Ft "struct resource *"
112 .\".Fo rman_reserve_resource_bound
113 .\".Fa "struct rman *rm" "u_long start" "u_long end" "u_long count"
114 .\".Fa "u_long bound" "u_int flags" "struct device *dev"
117 .Fn rman_make_alignment_flags "uint32_t size"
120 .Fn rman_get_start "struct resource *r"
122 .Fn rman_get_end "struct resource *r"
123 .Ft "struct device *"
124 .Fn rman_get_device "struct resource *r"
126 .Fn rman_get_size "struct resource *r"
128 .Fn rman_get_flags "struct resource *r"
130 .Fn rman_set_virtual "struct resource *r" "void *v"
132 .Fn rman_get_virtual "struct resource *r"
134 .Fn rman_set_bustag "struct resource *r" "bus_space_tag_t t"
136 .Fn rman_get_bustag "struct resource *r"
138 .Fn rman_set_bushandle "struct resource *r" "bus_space_handle_t h"
139 .Ft bus_space_handle_t
140 .Fn rman_get_bushandle "struct resource *r"
142 .\".Fn rman_set_rid "struct resource *r" "int rid"
144 .\".Fn rman_get_rid "struct resource *r"
148 set of functions provides a flexible resource management abstraction,
149 they are used extensively by the bus management code.
150 It implements the abstractions of region and resource.
151 A region descriptor is used to manage a region; this could be memory or
152 some other form of bus space.
154 Each region has a set of bounds.
155 Within these bounds, allocated segments may reside.
156 Each segment, termed a resource, has several properties which are
157 represented by a 16-bit flag register, as follows.
159 #define RF_ALLOCATED 0x0001 /* resource has been reserved */
160 #define RF_ACTIVE 0x0002 /* resource allocation has been activated */
161 #define RF_SHAREABLE 0x0004 /* resource permits contemporaneous sharing */
162 #define RF_TIMESHARE 0x0008 /* resource permits time-division sharing */
163 #define RF_WANTED 0x0010 /* somebody is waiting for this resource */
164 #define RF_FIRSTSHARE 0x0020 /* first in sharing list */
165 #define RF_PREFETCHABLE 0x0040 /* resource is prefetchable */
168 The remainder of the flag bits are used to represent the desired alignment
169 of the resource within the region.
173 function initializes the region descriptor, pointed to by the
175 argument, for use with the resource management functions.
176 It also initializes any mutexes associated with the structure.
180 function frees any structures associated with the structure
184 If any of the resources within the managed region have the
186 flag set, it will return
188 otherwise, any mutexes associated with the structure will be released
189 and destroyed, and the function will return 0.
192 .Fn rman_manage_region
193 function establishes the concept of a region which is under
198 argument points to the region descriptor.
203 arguments specify the bounds of the region.
206 This interface is not robust against programming errors which
207 add multiple copies of the same region.
210 .\".Fn rman_reserve_resource_bound
211 .\"function is where the bulk of the
214 .\"It attempts to reserve a contiguous range in the specified region
216 .\"for the use of the device
218 .\"The caller can specify the
222 .\"of an acceptable range, as well as
223 .\"alignment, and the code will attempt to find a free segment which fits.
224 .\"The default behavior is to allocate an exclusive segment, unless the
228 .\"flags are set, in which case a shared
229 .\"segment will be allocated.
230 .\"If this shared segment already exists, the caller has its device
231 .\"added to the list of consumers.
234 .Fn rman_reserve_resource
235 function is used to reserve resources within a previously established region.
236 .\"It is a simplified interface to
237 .\".Fn rman_reserve_resource_bound
238 .\"which passes 0 for the
243 .Fn rman_make_alignment_flags
244 function returns the flag mask corresponding to the desired alignment
246 .\"This should be used when calling
247 .\".Fn rman_reserve_resource_bound .
250 .Fn rman_release_resource
251 function releases the reserved resource
253 It may attempt to merge adjacent free resources.
256 .Fn rman_activate_resource
257 function marks a resource as active, by setting the
260 If this is a time shared resource, and the caller has not yet acquired
261 the resource, the function returns
265 .Fn rman_deactivate_resource
266 function marks a resource
268 as inactive, by clearing the
271 If other consumers are waiting for this range, it will wakeup their threads.
274 .\".Fn rman_await_resource
275 .\"function performs an asynchronous wait for a resource
277 .\"to become inactive, that is, for the
279 .\"flag to be cleared.
280 .\"It is used to enable cooperative sharing of a resource
281 .\"which can only be safely used by one thread at a time.
287 .\".Fn rman_await_resource
296 functions return the bounds, size and flags of the previously reserved
302 function associates a
309 function is used to retrieve this tag once set.
312 .Fn rman_set_bushandle
313 function associates a
314 .Vt bus_space_handle_t
319 .Fn rman_get_bushandle
320 function is used to retrieve this handle once set.
324 function is used to associate a kernel virtual address with a resource
328 function can be used to retrieve the KVA once set.
332 .\"function associates a resource identifier with a resource
336 .\"function retrieves this RID.
340 function returns a pointer to the device which reserved the resource
343 .\".Xr bus_activate_resource 9 ,
344 .Xr bus_alloc_resource 9 ,
345 .Xr bus_release_resource 9
346 .\".Xr bus_set_resource 9 ,
349 This manual page was written by
350 .An Bruce M Simpson Aq Mt bms@spc.org ,
352 .An Hiten Pandya Aq Mt hmp@backplane.com .