xref: /freebsd/share/man/man9/BUS_READ_IVAR.9 (revision 32eef9aeb1f39a1623cea55da147c89abbd5b9a5)
1cefd51ecSDoug Rabson.\" -*- nroff -*-
2cefd51ecSDoug Rabson.\"
3cefd51ecSDoug Rabson.\" Copyright (c) 1998 Doug Rabson
4cefd51ecSDoug Rabson.\"
5cefd51ecSDoug Rabson.\" All rights reserved.
6cefd51ecSDoug Rabson.\"
7cefd51ecSDoug Rabson.\" This program is free software.
8cefd51ecSDoug Rabson.\"
9cefd51ecSDoug Rabson.\" Redistribution and use in source and binary forms, with or without
10cefd51ecSDoug Rabson.\" modification, are permitted provided that the following conditions
11cefd51ecSDoug Rabson.\" are met:
12cefd51ecSDoug Rabson.\" 1. Redistributions of source code must retain the above copyright
13cefd51ecSDoug Rabson.\"    notice, this list of conditions and the following disclaimer.
14cefd51ecSDoug Rabson.\" 2. Redistributions in binary form must reproduce the above copyright
15cefd51ecSDoug Rabson.\"    notice, this list of conditions and the following disclaimer in the
16cefd51ecSDoug Rabson.\"    documentation and/or other materials provided with the distribution.
17cefd51ecSDoug Rabson.\"
18cefd51ecSDoug Rabson.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
19cefd51ecSDoug Rabson.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20cefd51ecSDoug Rabson.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21cefd51ecSDoug Rabson.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
22cefd51ecSDoug Rabson.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23cefd51ecSDoug Rabson.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24cefd51ecSDoug Rabson.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25cefd51ecSDoug Rabson.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26cefd51ecSDoug Rabson.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27cefd51ecSDoug Rabson.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28cefd51ecSDoug Rabson.\"
297f3dea24SPeter Wemm.\" $FreeBSD$
30cefd51ecSDoug Rabson.\"
31cefd51ecSDoug Rabson.Dd June 16, 1998
32cefd51ecSDoug Rabson.Dt BUS_READ_IVAR 9
333d45e180SRuslan Ermilov.Os
34cefd51ecSDoug Rabson.Sh NAME
35cefd51ecSDoug Rabson.Nm BUS_READ_IVAR ,
36cefd51ecSDoug Rabson.Nm BUS_WRITE_IVAR
37cefd51ecSDoug Rabson.Nd manipulate bus-specific device instance variables
38cefd51ecSDoug Rabson.Sh SYNOPSIS
3932eef9aeSRuslan Ermilov.In sys/param.h
4032eef9aeSRuslan Ermilov.In sys/bus.h
41cefd51ecSDoug Rabson.Ft int
42522e56cfSBruce Evans.Fn BUS_READ_IVAR "device_t dev" "device_t child" "int index" "uintptr_t *result"
43cefd51ecSDoug Rabson.Ft int
44522e56cfSBruce Evans.Fn BUS_WRITE_IVAR "device_t dev" "device_t child" "int index" "uintptr_t value"
45cefd51ecSDoug Rabson.Sh DESCRIPTION
46cefd51ecSDoug RabsonThese two methods manage a bus specific set of instance variables of
47cefd51ecSDoug Rabsona child device.  The intention is that each different type of bus
48cefd51ecSDoug Rabsondefines a set of appropriate instance variables (such as ports and
49cefd51ecSDoug Rabsonirqs for ISA bus etc.)
50cefd51ecSDoug Rabson.Pp
51cefd51ecSDoug RabsonThis information could be given to the child device as a struct but
52cefd51ecSDoug Rabsonthat makes it hard for a bus to add or remove variables without
53cefd51ecSDoug Rabsonforcing an edit and recompile for all drivers which may not be
54cefd51ecSDoug Rabsonpossible for vendor supplied binary drivers.
55cefd51ecSDoug Rabson.Sh RETURN VALUES
56cefd51ecSDoug RabsonZero is returned on success, otherwise an appropriate error is returned.
57cefd51ecSDoug Rabson.Sh SEE ALSO
58cefd51ecSDoug Rabson.Xr device 9 ,
59cefd51ecSDoug Rabson.Xr driver 9
60cefd51ecSDoug Rabson.Sh AUTHORS
61cefd51ecSDoug RabsonThis man page was written by
62cefd51ecSDoug Rabson.An Doug Rabson .
63