File:  [DragonFly] / src / share / man / man9 / BUS_READ_IVAR.9
Revision 1.2: download - view: text, annotated - select for diffs
Tue Jun 17 04:37:01 2003 UTC (11 years, 3 months ago) by dillon
Branches: MAIN
CVS tags: HEAD
Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids.  Most
ids have been removed from !lint sections and moved into comment sections.

    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: src/share/man/man9/BUS_READ_IVAR.9,v 1.3.2.4 2001/12/17 11:30:18 ru Exp $
   30: .\" $DragonFly: src/share/man/man9/BUS_READ_IVAR.9,v 1.2 2003/06/17 04:37:01 dillon Exp $
   31: .\"
   32: .Dd June 16, 1998
   33: .Dt BUS_READ_IVAR 9
   34: .Os
   35: .Sh NAME
   36: .Nm BUS_READ_IVAR ,
   37: .Nm BUS_WRITE_IVAR
   38: .Nd manipulate bus-specific device instance variables
   39: .Sh SYNOPSIS
   40: .In sys/param.h
   41: .In sys/bus.h
   42: .Ft int
   43: .Fn BUS_READ_IVAR "device_t dev" "device_t child" "int index" "uintptr_t *result"
   44: .Ft int
   45: .Fn BUS_WRITE_IVAR "device_t dev" "device_t child" "int index" "uintptr_t value"
   46: .Sh DESCRIPTION
   47: These two methods manage a bus specific set of instance variables of
   48: a child device.  The intention is that each different type of bus
   49: defines a set of appropriate instance variables (such as ports and
   50: irqs for ISA bus etc.)
   51: .Pp
   52: This information could be given to the child device as a struct but
   53: that makes it hard for a bus to add or remove variables without
   54: forcing an edit and recompile for all drivers which may not be
   55: possible for vendor supplied binary drivers.
   56: .Sh RETURN VALUES
   57: Zero is returned on success, otherwise an appropriate error is returned.
   58: .Sh SEE ALSO
   59: .Xr device 9 ,
   60: .Xr driver 9
   61: .Sh AUTHORS
   62: This man page was written by
   63: .An Doug Rabson .