]> git.dujemihanovic.xyz Git - linux.git/commitdiff
docs: i2c: summary: document 'local' and 'remote' targets
authorWolfram Sang <wsa+renesas@sang-engineering.com>
Fri, 21 Jun 2024 07:30:12 +0000 (09:30 +0200)
committerWolfram Sang <wsa+renesas@sang-engineering.com>
Sat, 22 Jun 2024 08:11:53 +0000 (10:11 +0200)
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>
Reviewed-by: Easwar Hariharan <eahariha@linux.microsoft.com>
Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
Documentation/i2c/summary.rst

index a6da1032fa06510b3874c07558b932d0041783ab..ff8bda32b9c3d2d46233e84b46a79eb075236922 100644 (file)
@@ -49,10 +49,15 @@ 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
+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**.
+
+Target drivers are kept in a directory specific to the feature they provide,
+for example ``drivers/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