Skip to content

Commit d77367f

Browse files
author
Wolfram Sang
committed
docs: i2c: summary: document use of inclusive language
We now have the updated I2C specs and our own Code of Conduct, so we have all we need to switch over to the inclusive terminology. Define them here. Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com> Reviewed-by: Easwar Hariharan <eahariha@linux.microsoft.com> Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
1 parent a5b88cb commit d77367f

File tree

2 files changed

+25
-13
lines changed

2 files changed

+25
-13
lines changed

Documentation/i2c/i2c_bus.svg

Lines changed: 8 additions & 7 deletions
Loading

Documentation/i2c/summary.rst

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,16 @@ implement all the common SMBus protocol semantics or messages.
3131
Terminology
3232
===========
3333

34-
Using the terminology from the official documentation, the I2C bus connects
35-
one or more *master* chips and one or more *slave* chips.
34+
The I2C bus connects one or more *controller* chips and one or more *target*
35+
chips.
36+
3637

3738
.. kernel-figure:: i2c_bus.svg
38-
:alt: Simple I2C bus with one master and 3 slaves
39+
:alt: Simple I2C bus with one controller and 3 targets
3940

4041
Simple I2C bus
4142

42-
A **master** chip is a node that starts communications with slaves. In the
43+
A **controller** chip is a node that starts communications with targets. In the
4344
Linux kernel implementation it is called an **adapter** or bus. Adapter
4445
drivers are in the ``drivers/i2c/busses/`` subdirectory.
4546

@@ -48,12 +49,22 @@ whole class of I2C adapters. Each specific adapter driver either depends on
4849
an algorithm driver in the ``drivers/i2c/algos/`` subdirectory, or includes
4950
its own implementation.
5051

51-
A **slave** chip is a node that responds to communications when addressed
52-
by the master. In Linux it is called a **client**. Client drivers are kept
52+
A **target** chip is a node that responds to communications when addressed
53+
by the controller. In Linux it is called a **client**. Client drivers are kept
5354
in a directory specific to the feature they provide, for example
5455
``drivers/media/gpio/`` for GPIO expanders and ``drivers/media/i2c/`` for
5556
video-related chips.
5657

5758
For the example configuration in figure, you will need a driver for your
5859
I2C adapter, and drivers for your I2C devices (usually one driver for each
5960
device).
61+
62+
Outdated terminology
63+
--------------------
64+
65+
In earlier I2C specifications, controller was named "master" and target was
66+
named "slave". These terms have been obsoleted with v7 of the specification and
67+
their use is also discouraged by the Linux Kernel Code of Conduct. You may
68+
still find them in references to documentation which has not been updated. The
69+
general attitude, however, is to use the inclusive terms: controller and
70+
target. Work to replace the old terminology in the Linux Kernel is on-going.

0 commit comments

Comments
 (0)