diff options
author | nsouch <nsouch@FreeBSD.org> | 1998-10-28 00:40:53 +0000 |
---|---|---|
committer | nsouch <nsouch@FreeBSD.org> | 1998-10-28 00:40:53 +0000 |
commit | c3db01939ddca14d91c18d4ae9048eb026b9af3e (patch) | |
tree | 9c01cbd6d3aa11f5ce92af62b8da3def03997e81 /share/man | |
parent | 95a128b95548dd572048740ab65598edf3870385 (diff) | |
download | FreeBSD-src-c3db01939ddca14d91c18d4ae9048eb026b9af3e.zip FreeBSD-src-c3db01939ddca14d91c18d4ae9048eb026b9af3e.tar.gz |
I2C framework manpages. See iicbus(4) for more info.
Diffstat (limited to 'share/man')
-rw-r--r-- | share/man/man4/Makefile | 10 | ||||
-rw-r--r-- | share/man/man4/iic.4 | 63 | ||||
-rw-r--r-- | share/man/man4/iicbb.4 | 59 | ||||
-rw-r--r-- | share/man/man4/iicbus.4 | 108 | ||||
-rw-r--r-- | share/man/man4/iicsmb.4 | 57 |
5 files changed, 293 insertions, 4 deletions
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index 888dfcb..9d18c2b 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -1,10 +1,12 @@ # @(#)Makefile 8.1 (Berkeley) 6/18/93 MAN4= bpf.4 ccd.4 cd.4 ch.4 da.4 ddb.4 divert.4 drum.4 fd.4 fpa.4 \ - icmp.4 ifmib.4 inet.4 intro.4 ip.4 ipfirewall.4 \ - lkm.4 lo.4 natm.4 netintro.4 \ - null.4 od.4 pass.4 ppi.4 ppp.4 pt.4 pty.4 route.4 sa.4 \ - scsi.4 sd.4 sl.4 smp.4 snp.4 sppp.4 ssc.4 st.4 su.4 tcp.4 \ + icmp.4 ifmib.4 iic.4 iicbb.4 iicbus.4 iicsmb.4 \ + imm.4 inet.4 intro.4 ip.4 ipfirewall.4 \ + lkm.4 lo.4 lpbb.4 natm.4 netintro.4 \ + null.4 od.4 pass.4 plip.4 ppbus.4 ppc.4 ppi.4 ppp.4 pt.4 pty.4 \ + route.4 sa.4 scsi.4 \ + sd.4 sl.4 smb.4 smbus.4 smp.4 snp.4 sppp.4 ssc.4 st.4 su.4 tcp.4 \ ttcp.4 termios.4 tty.4 tun.4 udp.4 uk.4 update.4 unix.4 vinum.4 vn.4 \ worm.4 wst.4 xpt.4 yp.4 zero.4 diff --git a/share/man/man4/iic.4 b/share/man/man4/iic.4 new file mode 100644 index 0000000..9e18d9a --- /dev/null +++ b/share/man/man4/iic.4 @@ -0,0 +1,63 @@ +.\" Copyright (c) 1998, Nicolas Souchu +.\" All rights reserved. +.\" +.\" 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 AUTHOR 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 AUTHOR 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 25, 1998 +.Dt IIC 4 +.Os FreeBSD +.Sh NAME +.Nm iic +.Nd +I2C generic i/o device driver +.Sh SYNOPSIS +.Cd "device iic0 at iicbus?" +.Sh DESCRIPTION +The +.Em iic +character device driver provides generic i/o to any +.Xr iicbus 4 +instance. In order to control I2C devices, use /dev/iic? with the +following ioctls: +.Pp +.Bl -column "Ioctls" -compact +.It Em Ioctl Ta Em Description +.It Sy I2CSTART Ta "send start condition to the specified device (with 7-bit address) on the bus" +.It Sy I2CSTOP Ta "send stop condition to the bus" +.It Sy I2CRSTCARD Ta "reset the bus" +.El +.Pp +You may also use read/write routines, then I2C start/stop handshake is +managed by the iicbus system. +.Pp +.Sh SEE ALSO +.Xr iicbus 4 +.Sh HISTORY +The +.Nm +manual page first appeared in +.Fx 3.0 . +.Sh AUTHOR +This +manual page was written by +.An Nicolas Souchu . diff --git a/share/man/man4/iicbb.4 b/share/man/man4/iicbb.4 new file mode 100644 index 0000000..cbe5fb4 --- /dev/null +++ b/share/man/man4/iicbb.4 @@ -0,0 +1,59 @@ +.\" Copyright (c) 1998, Nicolas Souchu +.\" All rights reserved. +.\" +.\" 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 AUTHOR 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 AUTHOR 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 25, 1998 +.Dt IICBB 4 +.Os FreeBSD +.Sh NAME +.Nm iicbb +.Nd +I2C generic bit-banging driver +.Sh SYNOPSIS +.Cd "controller iicbb0" +.Pp +.Cd "device lpbb at ppbus?" +.Pp +For one or more iicbus busses: +.Cd "controller iicbus0" +.Sh DESCRIPTION +The +.Em iicbb +driver provides support to any bit-banging interface for the +.Xr iicbus 4 +system. +.Pp +.Sh SEE ALSO +.Xr iicbus 4 , +.Xr lpbb 4 , +.Xr ppbus 4 +.Sh HISTORY +The +.Nm +manual page first appeared in +.Fx 3.0 . +.Sh AUTHOR +This +manual page was written by +.An Nicolas Souchu . diff --git a/share/man/man4/iicbus.4 b/share/man/man4/iicbus.4 new file mode 100644 index 0000000..f45943a --- /dev/null +++ b/share/man/man4/iicbus.4 @@ -0,0 +1,108 @@ +.\" Copyright (c) 1998, Nicolas Souchu +.\" All rights reserved. +.\" +.\" 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 AUTHOR 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 AUTHOR 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 August 6, 1998 +.Dt IICBUS 4 +.Os FreeBSD +.Sh NAME +.Nm iicbus +.Nd +I2C bus system +.Sh SYNOPSIS +.Cd "controller iicbus0" +.Cd "controller iicbb0" +.Pp +.Cd "device iic0 at iicbus?" +.Cd "device ic0 at iicbus?" +.Cd "device iicsmb0 at iicbus?" +.Sh DESCRIPTION +The +.Em iicbus +system provides a uniform, modular and architecture-independent +system for the implementation of drivers to control various I2C devices +and to utilize different I2C controllers. +.Sh I2C +I2C is an acronym for Inter Integrated Circuit bus. The I2C bus was developed +in the early 1980's by Philips semiconductors. It's purpose was to provide an +easy way to connect a CPU to peripheral chips in a TV-set. +.Pp +The BUS physically consists of 2 active wires and a ground connection. +The active wires, SDA and SCL, are both bidirectional. Where SDA is the +Serial DAta line and SCL is the Serial CLock line. + +Every component hooked up to the bus has its own unique address whether it +is a CPU, LCD driver, memory, or complex function chip. Each of these chips +can act as a receiver and/or transmitter depending on it's functionality. +Obviously an LCD driver is only a receiver, while a memory or I/O chip can +both be transmitter and receiver. Furthermore there may be one or +more BUS MASTER's. + +The BUS MASTER is the chip issuing the commands on the BUS. In the I2C protocol +specification it is stated that the IC that initiates a data transfer on the +bus is considered the BUS MASTER. At that time all the others are regarded to +as the BUS SLAVEs. As mentioned before, the IC bus is a Multi-MASTER BUS. +This means that more than one IC capable of initiating data transfer can be +connected to it. +.Sh DEVICES +Some I2C device drivers are available: +.Pp +.Bl -column "Device drivers" -compact +.It Em Devices Ta Em Description +.It Sy iic Ta "general i/o operation" +.It Sy ic Ta "network IP interface" +.It Sy iicsmb Ta "I2C to SMB software bridge" +.El +.Sh INTERFACES +The I2C protocol may be implemented by hardware or software. Software +interfaces rely on very simple hardware, usually two lines +twiddled by 2 registers. Hardware interfaces are more intelligent and receive +8-bit characters they write to the bus according to the I2C protocol. + +I2C interfaces may act on the bus as slave devices, allowing spontaneous +bidirectional communications, thanks to the mutli-master capabilities of the +I2C protocol. + +Some I2C interfaces are available: +.Pp +.Bl -column "Interface drivers" -compact +.It Em Interface Ta Em Description +.It Sy pcf Ta "Philips PCF8584 master/slave interface" +.It Sy iicbb Ta "generic bit-banging master-only driver" +.It Sy lpbb Ta "parallel port specific bit-banging interface" +.It Sy bktr Ta "Brooktree848 video chipset, hardware and software master-only interface" +.El +.Sh SEE ALSO +.Xr pcf 4 , +.Xr iicbb 4 , +.Xr lpbb 4 +.Sh HISTORY +The +.Nm +manual page first appeared in +.Fx 3.0 . +.Sh AUTHOR +This +manual page was written by +.An Nicolas Souchu . diff --git a/share/man/man4/iicsmb.4 b/share/man/man4/iicsmb.4 new file mode 100644 index 0000000..0a1b92b --- /dev/null +++ b/share/man/man4/iicsmb.4 @@ -0,0 +1,57 @@ +.\" Copyright (c) 1998, Nicolas Souchu +.\" All rights reserved. +.\" +.\" 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 AUTHOR 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 AUTHOR 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 August 10, 1998 +.Dt IICSMB 4 +.Os FreeBSD +.Sh NAME +.Nm iicsmb +.Nd +I2C to SMB bridge +.Sh SYNOPSIS +.Cd "device iicsmb0 at iicbus?" +.Pp +For one or more smbus busses: +.Cd "controller smbus0" +.Sh DESCRIPTION +The +.Em iicsmb +driver supports SMB commands over +.Xr iicbus 4 +for the +.Xr smbus 4 +system. +.Pp +.Sh SEE ALSO +.Xr smbus 4 +.Sh HISTORY +The +.Nm +manual page first appeared in +.Fx 3.0 . +.Sh AUTHOR +This +manual page was written by +.An Nicolas Souchu . |