[src/trunk]: src/share/man/man4 Add man page and cross-refs for experimental ...

[pgoyette <pgoyette%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/cbae95748a41
branches:  trunk
changeset: 751519:cbae95748a41
user:      pgoyette <pgoyette%NetBSD.org@localhost>
date:      Sat Feb 06 20:11:33 2010 +0000

description:
Add man page and cross-refs for experimental acpismbus(4)

diffstat:

 share/man/man4/Makefile    |   4 +-
 share/man/man4/acpi.4      |   9 +++-
 share/man/man4/acpismbus.4 |  82 ++++++++++++++++++++++++++++++++++++++++++++++
 share/man/man4/iic.4       |   7 ++-
 4 files changed, 96 insertions(+), 6 deletions(-)

diffs (183 lines):

diff -r 966984b6c5d9 -r cbae95748a41 share/man/man4/Makefile
--- a/share/man/man4/Makefile   Sat Feb 06 20:10:18 2010 +0000
+++ b/share/man/man4/Makefile   Sat Feb 06 20:11:33 2010 +0000
@@ -1,4 +1,4 @@
-#      $NetBSD: Makefile,v 1.502 2010/02/06 11:26:56 tonio Exp $
+#      $NetBSD: Makefile,v 1.503 2010/02/06 20:11:33 pgoyette Exp $
 #      @(#)Makefile    8.1 (Berkeley) 6/18/93
 
 MAN=   aac.4 ac97.4 acardide.4 aceride.4 acphy.4 acpidalb.4 \
@@ -80,7 +80,7 @@
 
 # ACPI devices
 MAN+=  acpi.4 acpiacad.4 acpibat.4 acpibut.4 acpiec.4 acpilid.4 \
-       acpitz.4
+       acpismbus.4 acpitz.4
 
 # Radio devices
 MAN+=  radio.4 az.4 mr.4 rt.4 rtii.4 sf2r.4
diff -r 966984b6c5d9 -r cbae95748a41 share/man/man4/acpi.4
--- a/share/man/man4/acpi.4     Sat Feb 06 20:10:18 2010 +0000
+++ b/share/man/man4/acpi.4     Sat Feb 06 20:11:33 2010 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: acpi.4,v 1.37 2010/01/31 15:05:20 wiz Exp $
+.\" $NetBSD: acpi.4,v 1.38 2010/02/06 20:11:33 pgoyette Exp $
 .\"
 .\" Copyright (c) 2002, 2004 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -24,7 +24,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd January 31, 2010
+.Dd February 6, 2010
 .Dt ACPI 4
 .Os
 .Sh NAME
@@ -39,6 +39,7 @@
 .Cd "acpiec*   at acpi?"
 .Cd "acpiecdt* at acpi?"
 .Cd "acpilid*  at acpi?"
+.Cd "acpismbus* at acpi?"
 .Cd "acpitz*   at acpi?"
 .Cd "aiboost*  at acpi?"
 .Cd "asus*     at acpi?"
@@ -192,6 +193,9 @@
 .It acpilid
 .Tn ACPI
 lid switches.
+.It acpismbus
+.Tn ACPI
+SMBus via Control Method Interface.
 .It acpitz
 .Tn ACPI
 thermal zones.
@@ -385,6 +389,7 @@
 .Xr acpidalb 4 ,
 .Xr acpiec 4 ,
 .Xr acpilid 4 ,
+.Xr acpismbus 4 ,
 .Xr acpitz 4 ,
 .Xr aiboost 4 ,
 .Xr apm 4 ,
diff -r 966984b6c5d9 -r cbae95748a41 share/man/man4/acpismbus.4
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man4/acpismbus.4        Sat Feb 06 20:11:33 2010 +0000
@@ -0,0 +1,82 @@
+.\" $NetBSD: acpismbus.4,v 1.1 2010/02/06 20:11:33 pgoyette Exp $
+.\"
+.\" Copyright (c) 2009 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed to The NetBSD Foundation
+.\" by Paul Goyette
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
+.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
+.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+.\" POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd October XXX, 2009
+.Dt ACPISMBUS 4
+.Os
+.Sh NAME
+.Nm acpismbus
+.Nd ACPI SMBus Control Method Interface
+.Sh SYNOPSIS
+.Cd "acpismbus* at acpi?"
+.Cd "iic* at acpismbus?"
+.Sh DESCRIPTION
+The
+.Nm
+driver supports instances of the ACPI SMBus Control Method Interface.
+This enables i2c access to bus segments which might not otherwise be
+accessible due to missing "native" driver support.
+The SMBus Process Call protocol is not supported.
+All other SMBus protocols are supported to the extent that the underlying
+controller supports them.
+.Sh SEE ALSO
+.Xr acpi 4 ,
+.Xr iic 4
+.Sh HISTORY
+The
+.Nm
+driver
+appeared in
+.Nx 6.0 .
+.Sh BUGS
+Although
+.Nm
+SMBus Alerts can be associated with individual devices, this
+capability is ignored.
+When an
+.Nm
+SMBus Alert is generated, all devices on the i2c bus segment which have
+registered an interrupt routine are notified.
+.Pp
+The SMBus CMI protocol defines a method to provide a list of devices on an
+i2c bus segment and their addresses.
+The
+.Nm
+driver makes no attempt to retrieve or process this device list.
+.Pp
+There is currently no way to determine if the i2c controller managed by
+an instance of the ACPI SMBus CMI can also be accessed using a native
+device driver.
+Therefore, the
+.Nm
+driver should not be enabled by default.
+If both a native driver and the
+.Nm
+driver attempt to access the same i2c bus segment, the results are
+undefined.
diff -r 966984b6c5d9 -r cbae95748a41 share/man/man4/iic.4
--- a/share/man/man4/iic.4      Sat Feb 06 20:10:18 2010 +0000
+++ b/share/man/man4/iic.4      Sat Feb 06 20:11:33 2010 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: iic.4,v 1.3 2009/08/22 00:17:03 joerg Exp $
+.\"    $NetBSD: iic.4,v 1.4 2010/02/06 20:11:33 pgoyette Exp $
 .\"    $OpenBSD: iic.4,v 1.74 2008/09/10 16:13:43 reyk Exp $
 .\"
 .\" Copyright (c) 2004, 2006 Alexander Yurchenko <grange%openbsd.org@localhost>
@@ -16,7 +16,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd June 4, 2009
+.Dd February 6, 2010
 .Dt IIC 4
 .Os
 .Sh NAME
@@ -30,6 +30,7 @@
 .\" cat /tmp/x
 .\"
 .Cd "iic* at alipm?               # sparc64 "
+.Cd "iic* at acpismbus?           # amd64 i386"
 .Cd "iic* at amdpm?               # amd64 i386 "
 .Cd "iic* at armadillo9iic?       # evbarm "
 .Cd "iic0 at at91twi?             # evbarm "
@@ -96,6 +97,8 @@
 .Bl -tag -width 18n -compact
 .It Xr alipm 4
 Acer Labs M7101 SMBus controller
+.It Xr acpismbus 4
+ACPI SMBus Control Method Interface
 .It Xr amdpm 4
 AMD768 Power Management Controller and AMD8111 System Management Controller
 .It Xr armadillo9iic 4