xref: /freebsd/share/man/man9/bus_activate_resource.9 (revision 729362425c09cf6b362366aabc6fb547eee8035a)
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_resources
36.Nd activates or deactivates a resources
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.Fn bus_activate_resource "device_t dev" "int type" "int *rid" "struct resource *r"
46.Ft int
47.Fn bus_deactivate_resource "device_t dev" "int type" "int *rid" "struct resource *r"
48.Sh DESCRIPTION
49Activates or deactivates a previously allocated resource.
50In general, resources must be activated before they can be accessed by
51the driver so that the bus driver can map the resource into the
52devices space.
53.Pp
54Its arguments are as follows:
55.Bl -item
56.It
57.Fa dev
58is the device that requests ownership of the resource.
59Before allocation, the resource is owned by the parent bus.
60.It
61.Fa type
62is the type of resource you want to allocate.
63It is one of:
64.Bl -tag -width SYS_RES_MEMORY
65.It Dv SYS_RES_IRQ
66for IRQs
67.It Dv SYS_RES_DRQ
68for ISA DMA lines
69.It Dv SYS_RES_IOPORT
70for I/O ports
71.It Dv SYS_RES_MEMORY
72for I/O memory
73.El
74.It
75.Fa rid
76points to a bus specific handle that identifies the resource being allocated.
77.It
78.Fa r
79points to the
80.Ft struct resource
81returned by
82.Xr bus_alloc_resource 9 .
83.El
84.Sh RETURN VALUES
85Zero indicates success.
86Non-zero is an error from errno.h.
87.\".Sh EXAMPLES
88.\".Bd -literal
89.\".Ed
90.Sh SEE ALSO
91.Xr bus_alloc_resource 9 ,
92.Xr device 9 ,
93.Xr driver 9
94.Sh AUTHORS
95.An -nosplit
96This man page was written by
97.An Warner Losh Aq imp@FreeBSD.org .
98