xref: /freebsd/share/man/man9/bus_set_resource.9 (revision 5f4c09dd85bff675e0ca63c55ea3c517e0fddfcc)
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.Dd March 29, 2003
26.Dt BUS_SET_RESOURCE 9
27.Os
28.Sh NAME
29.Nm bus_set_resource
30.Nd "associate a definite resource with a given resource ID"
31.Sh SYNOPSIS
32.In sys/param.h
33.In sys/bus.h
34.Pp
35.In machine/bus.h
36.In sys/rman.h
37.In machine/resource.h
38.Ft int
39.Fo bus_set_resource
40.Fa "device_t dev" "int type" "int rid" "rman_res_t start" "rman_res_t count"
41.Fc
42.Sh DESCRIPTION
43The
44.Fn bus_set_resource
45function
46sets the start address of the resource
47.Fa type , rid
48pair to be
49.Fa count
50long.
51Typically, client drivers do not use this interface.
52Bus drivers, however, often use it to set up the resources a client
53driver uses.
54.Pp
55The arguments are as follows:
56.Bl -tag -width indent
57.It Fa dev
58The device to set the resource on.
59.It Fa type
60The type of resource you want to allocate.
61It is one of:
62.Pp
63.Bl -tag -width ".Dv SYS_RES_MEMORY" -compact
64.It Dv SYS_RES_IRQ
65for IRQs
66.It Dv SYS_RES_DRQ
67for ISA DMA lines
68.It Dv SYS_RES_IOPORT
69for I/O ports
70.It Dv SYS_RES_MEMORY
71for I/O memory
72.El
73.It Fa rid
74A bus-specific handle that identifies the resource being allocated.
75.It Fa start
76The start address of this resource.
77.It Fa count
78The length of the resource.
79For example, the size of the memory in bytes.
80.El
81.Sh RETURN VALUES
82Zero is returned on success, otherwise an error is returned.
83.Sh SEE ALSO
84.Xr bus_alloc_resource 9 ,
85.Xr bus_get_resource 9 ,
86.Xr device 9 ,
87.Xr driver 9
88.Sh AUTHORS
89This manual page was written by
90.An Warner Losh Aq Mt imp@FreeBSD.org .
91