3 .\" Copyright (c) 2003 M. Warner Losh
5 .\" All rights reserved.
7 .\" This program is free software.
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\" notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\" notice, this list of conditions and the following disclaimer in the
16 .\" documentation and/or other materials provided with the distribution.
18 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
19 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
22 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 .Dt BUS_ACTIVATE_RESOURCE 9
35 .Nm bus_activate_resource , bus_deactivate_resource
36 .Nd activate or deactivate a resource
43 .In machine/resource.h
45 .Fo bus_activate_resource
46 .Fa "device_t dev" "int type" "int rid" "struct resource *r"
49 .Fo bus_deactivate_resource
50 .Fa "device_t dev" "int type" "int rid" "struct resource *r"
53 These functions activate or deactivate a previously allocated resource.
54 In general, resources must be activated before they can be accessed by
56 Bus drivers may perform additional actions to ensure that the resource is
59 the PCI bus driver enables memory decoding in a PCI device's command register
60 when activating a memory resource.
62 The arguments are as follows:
63 .Bl -tag -width indent
65 The device that requests ownership of the resource.
66 Before allocation, the resource is owned by the parent bus.
68 The type of resource you want to allocate.
71 .Bl -tag -width ".Dv SYS_RES_MEMORY" -compact
84 A pointer to a bus specific handle that identifies the resource being allocated.
89 .Xr bus_alloc_resource 9 .
92 Resources which can be mapped for CPU access by a
94 tag and handle will create a mapping of the entire resource when activated.
95 The tag and handle for this mapping are stored in
97 and can be retrieved via
100 .Xr rman_get_bushandle 9 .
101 These can be used with the
103 API to access device registers or memory described by
105 If the mapping is associated with a virtual address,
106 the virtual address can be retrieved via
107 .Xr rman_get_virtual 9 .
109 This implicit mapping can be disabled by passing the
112 .Xr bus_alloc_resource 9 .
113 A driver may use this if it wishes to allocate its own mappings of a resource
115 .Xr bus_map_resource 9 .
119 is also provided that accepts the associated resource as the first argument
123 The functions in this wrapper API are named similarly to the
127 is removed from their name.
130 can be used in place of
131 .Fn bus_space_read_4 .
132 The wrapper API is preferred in new drivers.
134 These two statements both read a 32-bit register at the start of a
137 bus_space_read_4(rman_get_bustag(res), rman_get_bushandle(res), 0);
141 Zero is returned on success, otherwise an error is returned.
143 .Xr bus_alloc_resource 9 ,
144 .Xr bus_map_resource 9 ,
149 This manual page was written by
150 .An Warner Losh Aq Mt imp@FreeBSD.org .