Merge branch 'i2c/for-5.4' of git://git.kernel.org/pub/scm/linux/kernel/git/wsa/linux
[linux-2.6-block.git] / Documentation / i2c / summary.rst
CommitLineData
ccf988b6 1=============
1da177e4
LT
2I2C and SMBus
3=============
4
ccf988b6 5I2C (pronounce: I squared C) is a protocol developed by Philips. It is a
4298cfc3
DB
6slow two-wire protocol (variable speed, up to 400 kHz), with a high speed
7extension (3.4 MHz). It provides an inexpensive bus for connecting many
8types of devices with infrequent or low bandwidth communications needs.
9I2C is widely used with embedded systems. Some systems use variants that
10don't meet branding requirements, and so are not advertised as being I2C.
1da177e4 11
4298cfc3
DB
12SMBus (System Management Bus) is based on the I2C protocol, and is mostly
13a subset of I2C protocols and signaling. Many I2C devices will work on an
14SMBus, but some SMBus protocols add semantics beyond what is required to
15achieve I2C branding. Modern PC mainboards rely on SMBus. The most common
16devices connected through SMBus are RAM modules configured using I2C EEPROMs,
17and hardware monitoring chips.
1da177e4 18
4298cfc3
DB
19Because the SMBus is mostly a subset of the generalized I2C bus, we can
20use its protocols on many I2C systems. However, there are systems that don't
21meet both SMBus and I2C electrical constraints; and others which can't
22implement all the common SMBus protocol semantics or messages.
1da177e4
LT
23
24
25Terminology
26===========
27
ccf988b6
MCC
28When we talk about I2C, we use the following terms::
29
1da177e4
LT
30 Bus -> Algorithm
31 Adapter
32 Device -> Driver
33 Client
34
35An Algorithm driver contains general code that can be used for a whole class
45ccc6c5
JD
36of I2C adapters. Each specific adapter driver either depends on one algorithm
37driver, or includes its own implementation.
4298cfc3 38
1da177e4
LT
39A Driver driver (yes, this sounds ridiculous, sorry) contains the general
40code to access some type of device. Each detected device gets its own
41data in the Client structure. Usually, Driver and Client are more closely
42integrated than Algorithm and Adapter.
43
45ccc6c5
JD
44For a given configuration, you will need a driver for your I2C bus, and
45drivers for your I2C devices (usually one driver for each device).