linux-i2c.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Wolfram Sang <wsa+renesas@sang-engineering.com>
To: linux-i2c@vger.kernel.org
Cc: Easwar Hariharan <eahariha@linux.microsoft.com>,
	Andi Shyti <andi.shyti@kernel.org>,
	linux-doc@vger.kernel.org,
	Wolfram Sang <wsa+renesas@sang-engineering.com>,
	linux-kernel@vger.kernel.org
Subject: [PATCH v2 5/6] docs: i2c: summary: document 'local' and 'remote' targets
Date: Mon, 10 Jun 2024 10:10:20 +0200	[thread overview]
Message-ID: <20240610081023.8118-6-wsa+renesas@sang-engineering.com> (raw)
In-Reply-To: <20240610081023.8118-1-wsa+renesas@sang-engineering.com>

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(-)

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
-- 
2.43.0


  parent reply	other threads:[~2024-06-10  8:10 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-06-10  8:10 [PATCH v2 0/6] docs: i2c: summary: update and use inclusive wording Wolfram Sang
2024-06-10  8:10 ` [PATCH v2 1/6] docs: i2c: summary: start sentences consistently Wolfram Sang
2024-06-10  8:10 ` [PATCH v2 2/6] docs: i2c: summary: update I2C specification link Wolfram Sang
2024-06-10  8:10 ` [PATCH v2 3/6] docs: i2c: summary: update speed mode description Wolfram Sang
2024-06-10  8:10 ` [PATCH v2 4/6] docs: i2c: summary: document use of inclusive language Wolfram Sang
2024-06-10 17:25   ` Easwar Hariharan
2024-06-10 20:29     ` Wolfram Sang
2024-06-10 21:43       ` Easwar Hariharan
2024-06-12 16:14         ` Wolfram Sang
2024-06-13 19:52     ` Wolfram Sang
2024-06-13 19:57       ` Easwar Hariharan
2024-06-10  8:10 ` Wolfram Sang [this message]
2024-06-13 19:55   ` [PATCH v2 5/6] docs: i2c: summary: document 'local' and 'remote' targets Wolfram Sang
2024-06-10  8:10 ` [PATCH v2 6/6] docs: i2c: summary: rephrase paragraph explaining the figure Wolfram Sang

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240610081023.8118-6-wsa+renesas@sang-engineering.com \
    --to=wsa+renesas@sang-engineering.com \
    --cc=andi.shyti@kernel.org \
    --cc=eahariha@linux.microsoft.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-i2c@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).