2 .\" Copyright (c) 2003 Bruce M Simpson <bms@spc.org>
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 .Nm rman_activate_resource ,
34 .Nm rman_adjust_resource ,
35 .Nm rman_deactivate_resource ,
38 .Nm rman_init_from_resource ,
39 .Nm rman_is_region_manager ,
40 .Nm rman_manage_region ,
41 .Nm rman_first_free_region ,
42 .Nm rman_last_free_region ,
43 .Nm rman_release_resource ,
44 .Nm rman_reserve_resource ,
45 .Nm rman_reserve_resource_bound ,
46 .Nm rman_make_alignment_flags ,
52 .Nm rman_set_virtual ,
53 .Nm rman_get_virtual ,
56 .Nm rman_set_bushandle ,
57 .Nm rman_get_bushandle ,
60 .Nd resource management functions
65 .Fn rman_activate_resource "struct resource *r"
67 .Fn rman_adjust_resource "struct resource *r" "u_long start" "u_long end"
69 .Fn rman_deactivate_resource "struct resource *r"
71 .Fn rman_fini "struct rman *rm"
73 .Fn rman_init "struct rman *rm"
75 .Fn rman_init_from_resource "struct rman *rm" "struct resource *r"
77 .Fn rman_is_region_manager "struct resource *r" "struct rman *rm"
79 .Fn rman_manage_region "struct rman *rm" "u_long start" "u_long end"
81 .Fn rman_first_free_region "struct rman *rm" "u_long *start" "u_long *end"
83 .Fn rman_last_free_region "struct rman *rm" "u_long *start" "u_long *end"
85 .Fn rman_release_resource "struct resource *r"
86 .Ft "struct resource *"
87 .Fo rman_reserve_resource
88 .Fa "struct rman *rm" "u_long start" "u_long end" "u_long count"
89 .Fa "u_int flags" "struct device *dev"
91 .Ft "struct resource *"
92 .Fo rman_reserve_resource_bound
93 .Fa "struct rman *rm" "u_long start" "u_long end" "u_long count"
94 .Fa "u_long bound" "u_int flags" "struct device *dev"
97 .Fn rman_make_alignment_flags "uint32_t size"
99 .Fn rman_get_start "struct resource *r"
101 .Fn rman_get_end "struct resource *r"
102 .Ft "struct device *"
103 .Fn rman_get_device "struct resource *r"
105 .Fn rman_get_size "struct resource *r"
107 .Fn rman_get_flags "struct resource *r"
109 .Fn rman_set_virtual "struct resource *r" "void *v"
111 .Fn rman_get_virtual "struct resource *r"
113 .Fn rman_set_bustag "struct resource *r" "bus_space_tag_t t"
115 .Fn rman_get_bustag "struct resource *r"
117 .Fn rman_set_bushandle "struct resource *r" "bus_space_handle_t h"
118 .Ft bus_space_handle_t
119 .Fn rman_get_bushandle "struct resource *r"
121 .Fn rman_set_rid "struct resource *r" "int rid"
123 .Fn rman_get_rid "struct resource *r"
127 set of functions provides a flexible resource management abstraction.
128 It is used extensively by the bus management code.
129 It implements the abstractions of region and resource.
130 A region descriptor is used to manage a region; this could be memory or
131 some other form of bus space.
133 Each region has a set of bounds.
134 Within these bounds, allocated segments may reside.
135 Each segment, termed a resource, has several properties which are
136 represented by a 16-bit flag register, as follows.
138 #define RF_ALLOCATED 0x0001 /* resource has been reserved */
139 #define RF_ACTIVE 0x0002 /* resource allocation has been activated */
140 #define RF_SHAREABLE 0x0004 /* resource permits contemporaneous sharing */
141 #define RF_FIRSTSHARE 0x0020 /* first in sharing list */
142 #define RF_PREFETCHABLE 0x0040 /* resource is prefetchable */
145 Bits 15:10 of the flag register are used to represent the desired alignment
146 of the resource within the region.
150 function initializes the region descriptor, pointed to by the
152 argument, for use with the resource management functions.
153 It is required that the fields
159 be set before calling
167 shall be set to a string that describes the resource to be managed.
172 fields may be set to limit the range of acceptable resource addresses.
173 If these fields are not set,
175 will initialize them to allow the entire range of resource addresses.
176 It also initializes any mutexes associated with the structure.
179 fails to initialize the mutex, it will return
180 .Er ENOMEM ; otherwise it will return 0 and
186 function frees any structures associated with the structure
190 If any of the resources within the managed region have the
192 flag set, it will return
194 otherwise, any mutexes associated with the structure will be released
195 and destroyed, and the function will return 0.
198 .Fn rman_manage_region
199 function establishes the concept of a region which is under
204 argument points to the region descriptor.
209 arguments specify the bounds of the region.
211 .Fn rman_manage_region
213 If the region overlaps with an existing region, it will return
215 If any part of the region falls outside of the valid address range for
220 will be returned when
221 .Fn rman_manage_region
222 failed to allocate memory for the region.
225 .Fn rman_init_from_resource
226 function is a wrapper routine to create a resource manager backed by an
232 and then adds a region to
234 corresponding to the address range allocated to
237 .Fn rman_manage_region .
240 .Fn rman_first_free_region
242 .Fn rman_last_free_region
243 functions can be used to query a resource manager for its first
248 contains no free region,
249 these functions will return
255 are set to the bounds of the free region and zero is returned.
258 .Fn rman_reserve_resource_bound
259 function is where the bulk of the
262 It attempts to reserve a contiguous range in the specified region
264 for the use of the device
266 The caller can specify the
270 of an acceptable range,
271 as well as a boundary restriction and required aligment,
272 and the code will attempt to find a free segment which fits.
275 argument is the lowest acceptable starting value of the resource.
278 argument is the highest acceptable ending value of the resource.
280 .Fa start No + Fa count No \- 1
283 for any allocation to happen.
284 The aligment requirement
290 argument may be set to specify a boundary restriction such that an
291 allocated region may cross an address that is a multiple of the
295 argument must be a power of two.
296 It may be set to zero to specify no boundary restriction.
297 A shared segment will be allocated if the
299 flag is set, otherwise an exclusive segment will be allocated.
300 If this shared segment already exists, the caller has its device
301 added to the list of consumers.
304 .Fn rman_reserve_resource
305 function is used to reserve resources within a previously established region.
306 It is a simplified interface to
307 .Fn rman_reserve_resource_bound
308 which passes 0 for the
313 .Fn rman_make_alignment_flags
314 function returns the flag mask corresponding to the desired alignment
316 This should be used when calling
317 .Fn rman_reserve_resource_bound .
320 .Fn rman_is_region_manager
321 function returns true if the allocated resource
329 .Fn rman_adjust_resource
330 function is used to adjust the reserved address range of an allocated resource
335 It can be used to grow or shrink one or both ends of the resource range.
336 The current implementation does not support entirely relocating the resource
339 if the new resource range does not overlap the old resource range.
340 If either end of the resource range grows and the new resource range would
341 conflict with another allocated resource,
342 the function will fail with
345 .Fn rman_adjust_resource
346 function does not support adjusting the resource range for shared resources
347 and will fail such attempts with
352 will have a start address of
354 and an end address of
356 and the function will return zero.
357 Note that none of the constraints of the original allocation request such
358 as alignment or boundary restrictions are checked by
359 .Fn rman_adjust_resource .
360 It is the caller's responsibility to enforce any such requirements.
363 .Fn rman_release_resource
364 function releases the reserved resource
366 It may attempt to merge adjacent free resources.
369 .Fn rman_activate_resource
370 function marks a resource as active, by setting the
373 If this is a time shared resource, and the caller has not yet acquired
374 the resource, the function returns
378 .Fn rman_deactivate_resource
379 function marks a resource
381 as inactive, by clearing the
384 If other consumers are waiting for this range, it will wakeup their threads.
392 functions return the bounds, size and flags of the previously reserved
398 function associates a
405 function is used to retrieve this tag once set.
408 .Fn rman_set_bushandle
409 function associates a
410 .Vt bus_space_handle_t
415 .Fn rman_get_bushandle
416 function is used to retrieve this handle once set.
420 function is used to associate a kernel virtual address with a resource
424 function can be used to retrieve the KVA once set.
428 function associates a resource identifier with a resource
432 function retrieves this RID.
436 function returns a pointer to the device which reserved the resource
439 .Xr bus_activate_resource 9 ,
440 .Xr bus_adjust_resource 9 ,
441 .Xr bus_alloc_resource 9 ,
442 .Xr bus_release_resource 9 ,
443 .Xr bus_set_resource 9 ,
446 This manual page was written by
447 .An Bruce M Simpson Aq bms@spc.org .