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