summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarc Balmer <mbalmer@cvs.openbsd.org>2008-11-24 14:17:58 +0000
committerMarc Balmer <mbalmer@cvs.openbsd.org>2008-11-24 14:17:58 +0000
commit4ccab8e3f7fa6032b180716879392bd780fa8605 (patch)
tree3fedf4b868f1d74204dc42be46cefa56406cc62f
parent11f9b2865a5705043bc12b64cdb14e23ccdc9f9b (diff)
Document SYNOPSIS for attachment of these devices at runtime.
-rw-r--r--share/man/man4/gpioiic.419
-rw-r--r--share/man/man4/gpioow.421
2 files changed, 33 insertions, 7 deletions
diff --git a/share/man/man4/gpioiic.4 b/share/man/man4/gpioiic.4
index 692a03ffc77..69bf26d190d 100644
--- a/share/man/man4/gpioiic.4
+++ b/share/man/man4/gpioiic.4
@@ -1,4 +1,4 @@
-.\" $OpenBSD: gpioiic.4,v 1.4 2007/05/31 19:19:50 jmc Exp $
+.\" $OpenBSD: gpioiic.4,v 1.5 2008/11/24 14:17:57 mbalmer Exp $
.\"
.\" Copyright (c) 2006 Alexander Yurchenko <grange@openbsd.org>
.\"
@@ -14,7 +14,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: May 31 2007 $
+.Dd $Mdocdate: November 24 2008 $
.Dt GPIOIIC 4
.Os
.Sh NAME
@@ -22,6 +22,7 @@
.Nd GPIO I2C controller
.Sh SYNOPSIS
.Cd "gpioiic* at gpio? offset 0 mask 0x3"
+.Cd "gpioiic* at gpio?"
.Cd "iic* at gpioiic?"
.Sh DESCRIPTION
The
@@ -32,11 +33,23 @@ a serial clock (SCL).
Both GPIO pins must be able to drive an output and the SDA pin must be
also able to read an input.
.Pp
-The pins are specified in the kernel configuration with the
+The pins can be specified in the kernel configuration with the
.Ar offset
and the
.Ar mask
locators.
+The
+.Ar offset
+and
+.Ar mask
+can also be specified when
+.Nm
+is attached at runtime using the
+.Ar GPIOATTACH
+.Xr ioctl 2
+on the
+.Xr gpio 4
+device.
Each bit in the
.Ar mask
locator defines one pin; the pin number is calculated as an addition of
diff --git a/share/man/man4/gpioow.4 b/share/man/man4/gpioow.4
index d31dc044a21..b9e833cf074 100644
--- a/share/man/man4/gpioow.4
+++ b/share/man/man4/gpioow.4
@@ -1,4 +1,4 @@
-.\" $OpenBSD: gpioow.4,v 1.4 2007/05/31 19:19:50 jmc Exp $
+.\" $OpenBSD: gpioow.4,v 1.5 2008/11/24 14:17:57 mbalmer Exp $
.\"
.\" Copyright (c) 2006 Alexander Yurchenko <grange@openbsd.org>
.\"
@@ -14,7 +14,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: May 31 2007 $
+.Dd $Mdocdate: November 24 2008 $
.Dt GPIOOW 4
.Os
.Sh NAME
@@ -22,6 +22,7 @@
.Nd 1-Wire bus bit-banging through GPIO pin
.Sh SYNOPSIS
.Cd "gpioow* at gpio? offset 0 mask 0x1"
+.Cd "gpioow* at gpio?"
.Cd "onewire* at gpioow?"
.Sh DESCRIPTION
The
@@ -30,12 +31,24 @@ driver allows bit-banging a 1-Wire bus as a master using one GPIO pin.
The pin is used as a data signal.
The GPIO pin must be able to drive an output and read an input.
.Pp
-The pin number is specified in the kernel configuration with the
+The pin number can specified in the kernel configuration with the
.Ar offset
locator.
The
.Ar mask
-locator should always be 0x1.
+locator should always be 0x1 in this case.
+The
+.Ar offset
+and
+.Ar mask
+can also be specified when
+.Nm
+is attached at runtime using the
+.Ar GPIOATTACH
+.Xr ioctl 2
+on the
+.Xr gpio 4
+device.
.Sh SEE ALSO
.Xr gpio 4 ,
.Xr intro 4 ,