Fix some it's -> its typos in our manual pages.
[dragonfly.git] / 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 .\"
27 .Dd August 6, 1998
28 .Dt IICBUS 4
29 .Os
30 .Sh NAME
31 .Nm iicbus
32 .Nd I2C bus system
33 .Sh SYNOPSIS
34 .Cd "device iicbus"
35 .Cd "device iicbb"
36 .Pp
37 .Cd "device iic"
38 .Cd "device ic"
39 .Cd "device iicsmb"
40 .Sh DESCRIPTION
41 The
42 .Em iicbus
43 system provides a uniform, modular and architecture-independent
44 system for the implementation of drivers to control various I2C devices
45 and to utilize different I2C controllers.
46 .Sh I2C
47 I2C is an acronym for Inter Integrated Circuit bus.
48 The I2C bus was developed
49 in the early 1980's by Philips semiconductors.
50 Its purpose was to provide an
51 easy way to connect a CPU to peripheral chips in a TV-set.
52 .Pp
53 The BUS physically consists of 2 active wires and a ground connection.
54 The active wires, SDA and SCL, are both bidirectional.
55 Where SDA is the
56 Serial DAta line and SCL is the Serial CLock line.
57 .Pp
58 Every component hooked up to the bus has its own unique address whether it
59 is a CPU, LCD driver, memory, or complex function chip.
60 Each of these chips
61 can act as a receiver and/or transmitter depending on its functionality.
62 Obviously an LCD driver is only a receiver, while a memory or I/O chip can
63 both be transmitter and receiver.
64 Furthermore there may be one or
65 more BUS MASTERs.
66 .Pp
67 The BUS MASTER is the chip issuing the commands on the BUS.
68 In the I2C protocol
69 specification it is stated that the IC that initiates a data transfer on the
70 bus is considered the BUS MASTER.
71 At that time all the others are regarded to
72 as the BUS SLAVEs.
73 As mentioned before, the IC bus is a Multi-MASTER BUS.
74 This means that more than one IC capable of initiating data transfer can be
75 connected to it.
76 .Sh DEVICES
77 Some I2C device drivers are available:
78 .Pp
79 .Bl -column "Device drivers" -compact
80 .It Em Devices Ta Em Description
81 .It Sy iic Ta "general i/o operation"
82 .It Sy ic Ta "network IP interface"
83 .It Sy iicsmb Ta "I2C to SMB software bridge"
84 .El
85 .Sh INTERFACES
86 The I2C protocol may be implemented by hardware or software.
87 Software
88 interfaces rely on very simple hardware, usually two lines
89 twiddled by 2 registers.
90 Hardware interfaces are more intelligent and receive
91 8-bit characters they write to the bus according to the I2C protocol.
92 .Pp
93 I2C interfaces may act on the bus as slave devices, allowing spontaneous
94 bidirectional communications, thanks to the multi-master capabilities of the
95 I2C protocol.
96 .Pp
97 Some I2C interfaces are available:
98 .Pp
99 .Bl -column "Interface drivers" -compact
100 .It Em Interface Ta Em Description
101 .It Sy pcf Ta "Philips PCF8584 master/slave interface"
102 .It Sy iicbb Ta "generic bit-banging master-only driver"
103 .It Sy lpbb Ta "parallel port specific bit-banging interface"
104 .It Sy bktr Ta "Brooktree848 video chipset, hardware and software master-only interface"
105 .El
106 .Sh SEE ALSO
107 .Xr iicbb 4 ,
108 .Xr lpbb 4 ,
109 .Xr pcf 4
110 .Sh HISTORY
111 The
112 .Nm
113 manual page first appeared in
114 .Fx 3.0 .
115 .Sh AUTHORS
116 This
117 manual page was written by
118 .An Nicolas Souchu .