/share/man/man9/bus_activate_resource.9

 1.\" -*- nroff -*-
 2.\"
 3.\" Copyright (c) 2003 M. Warner Losh
 4.\"
 5.\" All rights reserved.
 6.\"
 7.\" This program is free software.
 8.\"
 9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
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.
17.\"
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.
28.\"
29.\" $FreeBSD$
30.\"
31.Dd March 28, 2003
32.Dt BUS_ACTIVATE_RESOURCE 9
33.Os
34.Sh NAME
35.Nm bus_activate_resource , bus_deactivate_resource
36.Nd activate or deactivate a resource
37.Sh SYNOPSIS
38.In sys/param.h
39.In sys/bus.h
40.Pp
41.In machine/bus.h
42.In sys/rman.h
43.In machine/resource.h
44.Ft int
45.Fo bus_activate_resource
46.Fa "device_t dev" "int type" "int rid" "struct resource *r"
47.Fc
48.Ft int
49.Fo bus_deactivate_resource
50.Fa "device_t dev" "int type" "int rid" "struct resource *r"
51.Fc
52.Sh DESCRIPTION
53These functions activate or deactivate a previously allocated resource.
54In general, resources must be activated before they can be accessed by
55the driver so that the bus driver can map the resource into the
56devices space.
57.Pp
58The arguments are as follows:
59.Bl -tag -width indent
60.It Fa dev
61The device that requests ownership of the resource.
62Before allocation, the resource is owned by the parent bus.
63.It Fa type
64The type of resource you want to allocate.
65It is one of:
66.Pp
67.Bl -tag -width ".Dv SYS_RES_MEMORY" -compact
68.It Dv SYS_RES_IRQ
69for IRQs
70.It Dv SYS_RES_DRQ
71for ISA DMA lines
72.It Dv SYS_RES_IOPORT
73for I/O ports
74.It Dv SYS_RES_MEMORY
75for I/O memory
76.El
77.It Fa rid
78A pointer to a bus specific handle that identifies the resource being allocated.
79.It Fa r
80A pointer to the
81.Vt "struct resource"
82returned by
83.Xr bus_alloc_resource 9 .
84.El
85.Sh RETURN VALUES
86Zero is returned on success, otherwise an error is returned.
87.Sh SEE ALSO
88.Xr bus_alloc_resource 9 ,
89.Xr device 9 ,
90.Xr driver 9
91.Sh AUTHORS
92This manual page was written by
93.An Warner Losh Aq imp@FreeBSD.org .