xref: /freebsd/share/man/man9/bus_set_resource.9 (revision d4eeb02986980bf33dd56c41ceb9fc5f180c0d47)
1.\" -*- nroff -*-
2.\"
3.\" Copyright (c) 2003 M. Warner Losh <imp@FreeBSD.org>
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
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.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
15.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
18.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd March 29, 2003
28.Dt BUS_SET_RESOURCE 9
29.Os
30.Sh NAME
31.Nm bus_set_resource
32.Nd "associate a definite resource with a given resource ID"
33.Sh SYNOPSIS
34.In sys/param.h
35.In sys/bus.h
36.Pp
37.In machine/bus.h
38.In sys/rman.h
39.In machine/resource.h
40.Ft int
41.Fo bus_set_resource
42.Fa "device_t dev" "int type" "int rid" "rman_res_t start" "rman_res_t count"
43.Fc
44.Sh DESCRIPTION
45The
46.Fn bus_set_resource
47function
48sets the start address of the resource
49.Fa type , rid
50pair to be
51.Fa count
52long.
53Typically, client drivers do not use this interface.
54Bus drivers, however, often use it to set up the resources a client
55driver uses.
56.Pp
57The arguments are as follows:
58.Bl -tag -width indent
59.It Fa dev
60The device to set the resource on.
61.It Fa type
62The type of resource you want to allocate.
63It is one of:
64.Pp
65.Bl -tag -width ".Dv SYS_RES_MEMORY" -compact
66.It Dv SYS_RES_IRQ
67for IRQs
68.It Dv SYS_RES_DRQ
69for ISA DMA lines
70.It Dv SYS_RES_IOPORT
71for I/O ports
72.It Dv SYS_RES_MEMORY
73for I/O memory
74.El
75.It Fa rid
76A bus-specific handle that identifies the resource being allocated.
77.It Fa start
78The start address of this resource.
79.It Fa count
80The length of the resource.
81For example, the size of the memory in bytes.
82.El
83.Sh RETURN VALUES
84Zero is returned on success, otherwise an error is returned.
85.Sh SEE ALSO
86.Xr bus_alloc_resource 9 ,
87.Xr bus_get_resource 9 ,
88.Xr device 9 ,
89.Xr driver 9
90.Sh AUTHORS
91This manual page was written by
92.An Warner Losh Aq Mt imp@FreeBSD.org .
93