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>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	Andi Shyti <andi.shyti@kernel.org>,
	Wolfram Sang <wsa+renesas@sang-engineering.com>
Subject: [PATCH v3 6/6] docs: i2c: summary: be clearer with 'controller/target' and 'adapter/client' pairs
Date: Fri, 14 Jun 2024 10:12:44 +0200	[thread overview]
Message-ID: <20240614081239.7128-14-wsa+renesas@sang-engineering.com> (raw)
In-Reply-To: <20240614081239.7128-8-wsa+renesas@sang-engineering.com>

This not only includes rewording, but also where to put which emphasis
on terms in this document.

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

diff --git a/Documentation/i2c/summary.rst b/Documentation/i2c/summary.rst
index ff8bda32b9c3..90f46f1504fe 100644
--- a/Documentation/i2c/summary.rst
+++ b/Documentation/i2c/summary.rst
@@ -31,9 +31,7 @@ implement all the common SMBus protocol semantics or messages.
 Terminology
 ===========
 
-The I2C bus connects one or more *controller* chips and one or more *target*
-chips.
-
+The I2C bus connects one or more controller chips and one or more target chips.
 
 .. kernel-figure::  i2c_bus.svg
    :alt:    Simple I2C bus with one controller and 3 targets
@@ -41,16 +39,16 @@ chips.
    Simple I2C bus
 
 A **controller** chip is a node that starts communications with targets. In the
-Linux kernel implementation it is called an **adapter** or bus. Adapter
-drivers are in the ``drivers/i2c/busses/`` subdirectory.
+Linux kernel implementation it is called an "adapter" or "bus". Controller
+drivers are usually in the ``drivers/i2c/busses/`` subdirectory.
 
-An **algorithm** contains general code that can be used to implement a
-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.
+An **algorithm** contains general code that can be used to implement a whole
+class of I2C controllers. Each specific controller 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 a
-controller. In the Linux kernel implementation it is called a **client**. While
+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
@@ -60,9 +58,18 @@ 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
-I2C adapter, and drivers for your I2C devices (usually one driver for each
-device).
+For the example configuration in the figure above, you will need one driver for
+the I2C controller, and drivers for your I2C targets. Usually one driver for
+each target.
+
+Synonyms
+--------
+
+As mentioned above, the Linux I2C implementation historically uses the terms
+"adapter" for controller and "client" for target. A number of data structures
+have these synonyms in their name. So, to discuss implementation details, it
+might be easier to use these terms. If speaking about I2C in general, the
+official terminology is preferred.
 
 Outdated terminology
 --------------------
-- 
2.43.0


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

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-06-14  8:12 [PATCH v3 0/6] docs: i2c: summary: update and use inclusive wording Wolfram Sang
2024-06-14  8:12 ` [PATCH v3 1/6] docs: i2c: summary: start sentences consistently Wolfram Sang
2024-06-15 17:47   ` Andi Shyti
2024-06-14  8:12 ` [PATCH v3 2/6] docs: i2c: summary: update I2C specification link Wolfram Sang
2024-06-15 17:48   ` Andi Shyti
2024-06-14  8:12 ` [PATCH v3 3/6] docs: i2c: summary: update speed mode description Wolfram Sang
2024-06-15 18:07   ` Andi Shyti
2024-06-14  8:12 ` [PATCH v3 4/6] docs: i2c: summary: document use of inclusive language Wolfram Sang
2024-06-15 18:12   ` Andi Shyti
2024-06-14  8:12 ` [PATCH v3 5/6] docs: i2c: summary: document 'local' and 'remote' targets Wolfram Sang
2024-06-15 20:49   ` Andi Shyti
2024-06-16 19:14     ` Wolfram Sang
2024-06-17 11:58       ` Andi Shyti
2024-06-17 16:45         ` Wolfram Sang
2024-06-17 16:57         ` Easwar Hariharan
2024-06-17 19:25           ` Andi Shyti
2024-06-19  7:10             ` Wolfram Sang
2024-06-20 16:05               ` Easwar Hariharan
2024-06-20 23:39                 ` Andi Shyti
2024-06-20 23:38               ` Andi Shyti
2024-06-21  7:03                 ` Wolfram Sang
2024-06-14  8:12 ` Wolfram Sang [this message]

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=20240614081239.7128-14-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).