summaryrefslogtreecommitdiff
path: root/share
diff options
context:
space:
mode:
authorAlexander Yurchenko <grange@cvs.openbsd.org>2006-01-14 11:50:22 +0000
committerAlexander Yurchenko <grange@cvs.openbsd.org>2006-01-14 11:50:22 +0000
commit369c12ae634af78d590ead73dc8fcb2d9cb7ba94 (patch)
tree8e061ceaa05f82dfb44331062651cdcdf1774bfd /share
parentf16bfeddda9fc34e1163dbe3ba139c74c8a42cd9 (diff)
Add gpioiic(4) man page.
Diffstat (limited to 'share')
-rw-r--r--share/man/man4/Makefile4
-rw-r--r--share/man/man4/gpioiic.465
2 files changed, 67 insertions, 2 deletions
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index 0c105c0450b..8d223699f09 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -1,4 +1,4 @@
-# $OpenBSD: Makefile,v 1.334 2006/01/07 10:48:24 grange Exp $
+# $OpenBSD: Makefile,v 1.335 2006/01/14 11:50:21 grange Exp $
MAN= aac.4 ac97.4 acphy.4 acpi.4 acpitimer.4 \
adc.4 addcom.4 admcts.4 admlc.4 admtemp.4 \
@@ -13,7 +13,7 @@ MAN= aac.4 ac97.4 acphy.4 acpi.4 acpitimer.4 \
drum.4 eap.4 ec.4 eephy.4 ef.4 eg.4 ehci.4 eisa.4 el.4 em.4 \
emu.4 enc.4 ep.4 epic.4 esa.4 eso.4 ess.4 exphy.4 \
faith.4 fd.4 fdc.4 fms.4 fpa.4 fxp.4 gdt.4 gentbi.4 gem.4 gif.4 \
- gpio.4 gpr.4 gre.4 gscsio.4 gtp.4 \
+ gpio.4 gpioiic.4 gpr.4 gre.4 gscsio.4 gtp.4 \
hifn.4 hil.4 hilid.4 hilkbd.4 hilms.4 hme.4 hotplug.4 hpet.4 hsq.4 \
ichiic.4 ichwdt.4 icmp.4 icmp6.4 icsphy.4 idp.4 ifmedia.4 \
iha.4 iic.4 inet.4 inet6.4 inphy.4 iop.4 iophy.4 ioprbs.4 \
diff --git a/share/man/man4/gpioiic.4 b/share/man/man4/gpioiic.4
new file mode 100644
index 00000000000..a9735845b32
--- /dev/null
+++ b/share/man/man4/gpioiic.4
@@ -0,0 +1,65 @@
+.\" $OpenBSD: gpioiic.4,v 1.1 2006/01/14 11:50:21 grange Exp $
+.\"
+.\" Copyright (c) 2006 Alexander Yurchenko <grange@openbsd.org>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd January 14, 2006
+.Dt GPIOIIC 4
+.Os
+.Sh NAME
+.Nm gpioiic
+.Nd I2C bus bit-banging through GPIO pins
+.Sh SYNOPSIS
+.Cd "gpioiic* at gpio? offset 0 mask 0x3"
+.Cd "iic* at gpioiic?"
+.Sh DESCRIPTION
+The
+.Nm
+driver allows to bit-bang an I2C bus as a master using two GPIO pins.
+The first pin is used as a serial data (SDA) signal and the second as
+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
+.Ar offset
+and the
+.Ar mask
+locators.
+Each bit in the
+.Ar mask
+locator defines one pin, the pin number is calculated as an addition of
+the bit position and the
+.Ar offset
+locator.
+For example,
+.Ar offset 17
+and
+.Ar mask 0x5
+defines pin numbers 17 and 19.
+.Sh SEE ALSO
+.Xr gpio 4 ,
+.Xr iic 4 ,
+.Xr intro 4 ,
+.Sh HISTORY
+The
+.Nm
+driver first appeared in
+.Ox 3.9 .
+.Sh AUTHORS
+.An -nosplit
+The
+.Nm
+driver was written by
+.An Alexander Yurchenko Aq grange@openbsd.org .