share/man/man4/iicbus.4

   1 .\" Copyright (c) 1998, Nicolas Souchu
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: src/share/man/man4/iicbus.4,v 1.7.2.3 2001/08/17 13:08:38 ru Exp $
  26 .\" $DragonFly: src/share/man/man4/iicbus.4,v 1.2 2003/06/17 04:36:59 dillon Exp $
  27 .\"
  28 .Dd August 6, 1998
  29 .Dt IICBUS 4
  30 .Os
  31 .Sh NAME
  32 .Nm iicbus
  33 .Nd I2C bus system
  34 .Sh SYNOPSIS
  35 .Cd "device iicbus"
  36 .Cd "device iicbb"
  37 .Pp
  38 .Cd "device iic"
  39 .Cd "device ic"
  40 .Cd "device iicsmb"
  41 .Sh DESCRIPTION
  42 The
  43 .Em iicbus
  44 system provides a uniform, modular and architecture-independent
  45 system for the implementation of drivers to control various I2C devices
  46 and to utilize different I2C controllers.
  47 .Sh I2C
  48 I2C is an acronym for Inter Integrated Circuit bus.
  49 The I2C bus was developed
  50 in the early 1980's by Philips semiconductors.
  51 It's purpose was to provide an
  52 easy way to connect a CPU to peripheral chips in a TV-set.
  53 .Pp
  54 The BUS physically consists of 2 active wires and a ground connection.
  55 The active wires, SDA and SCL, are both bidirectional.
  56 Where SDA is the
  57 Serial DAta line and SCL is the Serial CLock line.
  58 .Pp
  59 Every component hooked up to the bus has its own unique address whether it
  60 is a CPU, LCD driver, memory, or complex function chip.
  61 Each of these chips
  62 can act as a receiver and/or transmitter depending on its functionality.
  63 Obviously an LCD driver is only a receiver, while a memory or I/O chip can
  64 both be transmitter and receiver.
  65 Furthermore there may be one or
  66 more BUS MASTERs.
  67 .Pp
  68 The BUS MASTER is the chip issuing the commands on the BUS.
  69 In the I2C protocol
  70 specification it is stated that the IC that initiates a data transfer on the
  71 bus is considered the BUS MASTER.
  72 At that time all the others are regarded to
  73 as the BUS SLAVEs.
  74 As mentioned before, the IC bus is a Multi-MASTER BUS.
  75 This means that more than one IC capable of initiating data transfer can be
  76 connected to it.
  77 .Sh DEVICES
  78 Some I2C device drivers are available:
  79 .Pp
  80 .Bl -column "Device drivers" -compact
  81 .It Em Devices Ta Em Description
  82 .It Sy iic Ta "general i/o operation"
  83 .It Sy ic Ta "network IP interface"
  84 .It Sy iicsmb Ta "I2C to SMB software bridge"
  85 .El
  86 .Sh INTERFACES
  87 The I2C protocol may be implemented by hardware or software.
  88 Software
  89 interfaces rely on very simple hardware, usually two lines
  90 twiddled by 2 registers.
  91 Hardware interfaces are more intelligent and receive
  92 8-bit characters they write to the bus according to the I2C protocol.
  93 .Pp
  94 I2C interfaces may act on the bus as slave devices, allowing spontaneous
  95 bidirectional communications, thanks to the multi-master capabilities of the
  96 I2C protocol.
  97 .Pp
  98 Some I2C interfaces are available:
  99 .Pp
 100 .Bl -column "Interface drivers" -compact
 101 .It Em Interface Ta Em Description
 102 .It Sy pcf Ta "Philips PCF8584 master/slave interface"
 103 .It Sy iicbb Ta "generic bit-banging master-only driver"
 104 .It Sy lpbb Ta "parallel port specific bit-banging interface"
 105 .It Sy bktr Ta "Brooktree848 video chipset, hardware and software master-only interface"
 106 .El
 107 .Sh SEE ALSO
 108 .Xr iicbb 4 ,
 109 .Xr lpbb 4 ,
 110 .Xr pcf 4
 111 .Sh HISTORY
 112 The
 113 .Nm
 114 manual page first appeared in
 115 .Fx 3.0 .
 116 .Sh AUTHORS
 117 This
 118 manual page was written by
 119 .An Nicolas Souchu .