xref: /freebsd/share/man/man9/device_get_ivars.9 (revision 43a5ec4eb41567cc92586503212743d89686d78f)
1.\" -*- nroff -*-
2.\"
3.\" Copyright (c) 1998 Doug Rabson
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 June 16, 1998
32.Dt DEVICE_GET_IVARS 9
33.Os
34.Sh NAME
35.Nm device_get_ivars ,
36.Nm device_set_ivars
37.Nd access bus private variables
38.Sh SYNOPSIS
39.In sys/param.h
40.In sys/bus.h
41.Ft "void *"
42.Fn device_get_ivars "device_t dev"
43.Ft void
44.Fn device_set_ivars "device_t dev" "void *ivar"
45.Sh DESCRIPTION
46The
47.Fn device_get_ivars
48function returns the bus-specific instance variables of a device.
49.Pp
50The
51.Fn device_set_ivars
52function sets the bus-specific instance variables of a device.
53.Pp
54Typically, only bus drivers will use these functions.
55The kernel assumes that the bus driver will manage this memory, and no
56automatic memory allocation or deallocation happens.
57Client drivers should access ivars through the
58.Xr BUS_READ_IVAR 9
59interface instead.
60.Sh SEE ALSO
61.Xr device 9
62.Sh AUTHORS
63This manual page was written by
64.An Doug Rabson .
65