diff mbox series

[v2,5/6] docs: i2c: summary: document 'local' and 'remote' targets

Message ID 20240610081023.8118-6-wsa+renesas@sang-engineering.com
State Superseded
Headers show
Series docs: i2c: summary: update and use inclusive wording | expand

Commit Message

Wolfram Sang June 10, 2024, 8:10 a.m. UTC
Because Linux can be a target as well, add terminology to differentiate
between Linux being the target and Linux accessing targets.

Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
---
 Documentation/i2c/summary.rst | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

Comments

Wolfram Sang June 13, 2024, 7:55 p.m. UTC | #1
> -``drivers/media/gpio/`` for GPIO expanders and ``drivers/media/i2c/`` for

Heh, for four years, nobody (including me) noticed that there is no
'drivers/media/gpio' directory...
diff mbox series

Patch

diff --git a/Documentation/i2c/summary.rst b/Documentation/i2c/summary.rst
index b10b6aaafcec..203f6c9b2472 100644
--- a/Documentation/i2c/summary.rst
+++ b/Documentation/i2c/summary.rst
@@ -49,11 +49,16 @@  whole class of I2C adapters. Each specific adapter driver either depends on
 an algorithm driver in the ``drivers/i2c/algos/`` subdirectory, or includes
 its own implementation.
 
-A **target** chip is a node that responds to communications when addressed
-by the controller. In Linux it is called a **client**. Client drivers are kept
-in a directory specific to the feature they provide, for example
-``drivers/media/gpio/`` for GPIO expanders and ``drivers/media/i2c/`` for
-video-related chips.
+A **target** chip is a node that responds to communications when addressed by a
+controller. In the Linux kernel implementation it is called a **client**. While
+targets are usually separate external chips, Linux can also act as a target
+(needs hardware support) and respond to another controller on the bus. This is
+then called a **local target**. In contrast, an external chip is called a
+**remote target**.
+
+Client drivers are kept in a directory specific to the feature they
+provide, for example ``drivers/media/gpio/`` for GPIO expanders and
+``drivers/media/i2c/`` for video-related chips.
 
 For the example configuration in figure, you will need a driver for your
 I2C adapter, and drivers for your I2C devices (usually one driver for each