diff options
author | nsouch <nsouch@FreeBSD.org> | 1998-10-28 00:42:34 +0000 |
---|---|---|
committer | nsouch <nsouch@FreeBSD.org> | 1998-10-28 00:42:34 +0000 |
commit | b7ace7b46d66ca25e1d3bf9bbe72fb8df26127df (patch) | |
tree | 0dd4d58b7d701617c58d1c436d53042d6569cf2c /share/man | |
parent | c3db01939ddca14d91c18d4ae9048eb026b9af3e (diff) | |
download | FreeBSD-src-b7ace7b46d66ca25e1d3bf9bbe72fb8df26127df.zip FreeBSD-src-b7ace7b46d66ca25e1d3bf9bbe72fb8df26127df.tar.gz |
More I2C framework docs. See iicbus(4) for more info.
Diffstat (limited to 'share/man')
-rw-r--r-- | share/man/man4/lpbb.4 | 79 | ||||
-rw-r--r-- | share/man/man4/smb.4 | 70 | ||||
-rw-r--r-- | share/man/man4/smbus.4 | 75 |
3 files changed, 224 insertions, 0 deletions
diff --git a/share/man/man4/lpbb.4 b/share/man/man4/lpbb.4 new file mode 100644 index 0000000..14033d9 --- /dev/null +++ b/share/man/man4/lpbb.4 @@ -0,0 +1,79 @@ +.\" 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 LPBB 4 +.Os FreeBSD +.Sh NAME +.Nm lpbb +.Nd +Parallel port I2C bit-banging interface +.Sh SYNOPSIS +.Cd "controller iicbus" +.Cd "controller iicbb0" +.Pp +.Cd "device lpbb0 at ppbus?" +.Cd "device iic0 at iicbus?" +.Sh DESCRIPTION +The +.Em lpbb +driver supports the Philips official I2C parallel bit-banging interface. +.Pp + + LS05 pin 14 (Vcc) o ------- + | | | + +--+--+---------------------+--+--+------------+------+-o 1 | + | | | | | | ===.1uF | +5V | + -------- [R][R][R] 3x10K 3x10K [R][R][R] LS05 | | | + | | | | | | | | pin 7 o-+------+-o 2 | + | 12 o-+--+ | | 3|\\ 4 | | | (Gnd) | GND | + | 17 o-+-----|--|----| >o-------------+--|--|--------------+ | | + | | | | |/ 8 /|9 | | 10 /|11 +----+-o 3 | + | 15 o-+-----+--|--------------o< |------+--|------o< |----+ | SCL | + | | | 1|\\ 2 \\| | \\| | | + | 9 o-+--------|----| >o-------------------+--------------+----+-o 4 | + | | | |/ 6 /|5 | | SDA | + | 11 o-+--------+----------------------------------o< |----+ ------- + | 10 o-+-+ \\| 4-pin + | 13 o-+-+--oGND Connector + | 25 o-+-+ ------------------ Part List -------------------------- + -------- | 1 - .1 uF capacitor | 6 - 10K 5% resistors | + 25-pin male D | 1 - 4-pin connector | 1 - 25-pin male D connector | + connector to PC | 1 - 74LS05 open collector hex inverter | + printer port ------------------------------------------------------- +.Pp +.Sh SEE ALSO +.Xr iicbus 4 , +.Xr iicbb 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/smb.4 b/share/man/man4/smb.4 new file mode 100644 index 0000000..90d126e --- /dev/null +++ b/share/man/man4/smb.4 @@ -0,0 +1,70 @@ +.\" 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 SMB 4 +.Os FreeBSD +.Sh NAME +.Nm smb +.Nd +SMB generic i/o device driver +.Sh SYNOPSIS +.Cd "device smb0 at smbus?" +.Sh DESCRIPTION +The +.Em smb +character device driver provides generic i/o to any +.Xr smbus 4 +instance. In order to control SMB devices, use /dev/smb? with the +following ioctls: +.Pp +.Bl -column "System Management Bus ioctls" -compact +.It Em Ioctl Ta Em Description +.It Sy SMB_QUICK_WRITE Ta "QuickWrite command" +.It Sy SMB_QUICK_READ Ta "QuickRead command" +.It Sy SMB_SENDB Ta "SendByte command" +.It Sy SMB_RECVB Ta "ReceiveByte command" +.It Sy SMB_WRITEB Ta "WriteByte command" +.It Sy SMB_WRITEW Ta "WriteWord command" +.It Sy SMB_READB Ta "ReadByte command" +.It Sy SMB_READW Ta "ReadWord command" +.It Sy SMB_PCALL Ta "ProcedureCall command" +.It Sy SMB_BWRITE Ta "BlockWrite command" +.It Sy SMB_BREAD Ta "BlockRead command" +.El +.Pp +Using the write routine is equivalent to a SMB_WRITEW ioctl. +.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 . diff --git a/share/man/man4/smbus.4 b/share/man/man4/smbus.4 new file mode 100644 index 0000000..34e070b --- /dev/null +++ b/share/man/man4/smbus.4 @@ -0,0 +1,75 @@ +.\" 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 SMBBUS 4 +.Os FreeBSD +.Sh NAME +.Nm smbus +.Nd +System Management Bus +.Sh SYNOPSIS +.Cd "controller smbus" +.Pp +.Cd "device iicsmb0 at iicbus?" +.Cd "device bktr0" +.Sh DESCRIPTION +The +.Em smbus +system provides a uniform, modular and architecture-independent +system for the implementation of drivers to control various SMB devices +and to utilize different SMB controllers (I2C, PIIX4, Brooktree848, vm86...). +.Sh System Management Bus +The +.Em System Management Bus +is a two-wire interface through which simple power-related chips can communicate +with rest of the system. It uses I2C as its backbone (see +.Xr iicbus 4 ). + +A system using SMB passes messages to and from devices instead of tripping +individual control lines. + +With the SMBus, a device can provide manufacturer information, tell the +system what its model/part number is, save its state for a suspend event, +report different types of errors, accept control parameters, and return its +status. + +The SMBus may share the same host device and phusical bus as ACCESS bus +componants provided that an appropriate electrival bridge is provided +between the internal SMB devices and esternal ACCESS bus devices. +.Sh SEE ALSO +.Xr iicbus 4 , +.Xr iicsmb 4 , +.Xr bktr 4 , +.Xr smb 4 +.Sh HISTORY +The +.Nm +manual page first appeared in +.Fx 3.0 . +.Sh AUTHOR +This +manual page was written by +.An Nicolas Souchu . |