diff options
| author |   Luca Ceresoli <luca@lucaceresoli.net> | 2020-01-29 16:19:27 +0100 |
|---|---|---|
| committer |   Wolfram Sang <wsa@the-dreams.de> | 2020-01-29 22:01:13 +0100 |
| commit | 096c22f88ea09dab449f039863a46cb504b9b3ec (patch) | |
| tree | 5c772eca0de9f19f7aa8826c614d2867216729ef /Documentation/i2c | |
| parent | docs: i2c: sort index logically (diff) | |
| download | linux-dev-096c22f88ea09dab449f039863a46cb504b9b3ec.tar.xz linux-dev-096c22f88ea09dab449f039863a46cb504b9b3ec.zip | |
docs: i2c: summary: extend introduction
- state the "official" name (I²C, not I2C, according to the spec) at
the beginning but keep using the more practical I2C elsewhere
- mention some known different names
- add link to the specification document
Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net>
Reviewed-by: Jean Delvare <jdelvare@suse.de>
Signed-off-by: Wolfram Sang <wsa@the-dreams.de>
Diffstat (limited to 'Documentation/i2c')
| -rw-r--r-- | Documentation/i2c/summary.rst | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/Documentation/i2c/summary.rst b/Documentation/i2c/summary.rst index 3a24eac17375..dbab737d5075 100644 --- a/Documentation/i2c/summary.rst +++ b/Documentation/i2c/summary.rst @@ -2,12 +2,18 @@ I2C and SMBus ============= -I2C (pronounce: I squared C) is a protocol developed by Philips. It is a -slow two-wire protocol (variable speed, up to 400 kHz), with a high speed -extension (3.4 MHz). It provides an inexpensive bus for connecting many -types of devices with infrequent or low bandwidth communications needs. -I2C is widely used with embedded systems. Some systems use variants that -don't meet branding requirements, and so are not advertised as being I2C. +I²C (pronounce: I squared C and written I2C in the kernel documentation) is +a protocol developed by Philips. It is a slow two-wire protocol (variable +speed, up to 400 kHz), with a high speed extension (3.4 MHz). It provides +an inexpensive bus for connecting many types of devices with infrequent or +low bandwidth communications needs. I2C is widely used with embedded +systems. Some systems use variants that don't meet branding requirements, +and so are not advertised as being I2C but come under different names, +e.g. TWI (Two Wire Interface), IIC. + +The official I2C specification is the `"I2C-bus specification and user +manual" (UM10204) <https://www.nxp.com/docs/en/user-guide/UM10204.pdf>`_ +published by NXP Semiconductors. SMBus (System Management Bus) is based on the I2C protocol, and is mostly a subset of I2C protocols and signaling. Many I2C devices will work on an |