All of lore.kernel.org
 help / color / mirror / Atom feed
From: Luca Ceresoli <luca@lucaceresoli.net>
To: linux-doc@vger.kernel.org, linux-i2c@vger.kernel.org
Cc: Luca Ceresoli <luca@lucaceresoli.net>,
	Wolfram Sang <wsa@the-dreams.de>, Peter Rosin <peda@axentia.se>,
	linux-kernel@vger.kernel.org
Subject: [PATCH 19/26] docs: i2c: smbus-protocol: improve I2C Block transactions description
Date: Sun,  5 Jan 2020 23:50:05 +0100	[thread overview]
Message-ID: <20200105225012.11701-19-luca@lucaceresoli.net> (raw)
In-Reply-To: <20200105225012.11701-1-luca@lucaceresoli.net>

Clarify from the beginning what these transactions are, and specifically
how they differ from the SMBus counterparts, i.e. the lack of a Count byte.

Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net>
---
 Documentation/i2c/smbus-protocol.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/Documentation/i2c/smbus-protocol.rst b/Documentation/i2c/smbus-protocol.rst
index 7350e4b2c2fa..0edaf6069ac1 100644
--- a/Documentation/i2c/smbus-protocol.rst
+++ b/Documentation/i2c/smbus-protocol.rst
@@ -282,9 +282,10 @@ This is implemented the following way in the Linux kernel:
 I2C Block Transactions
 ======================
 
-The following I2C block transactions are supported by the
-SMBus layer and are described here for completeness.
-They are *NOT* defined by the SMBus specification.
+The following I2C block transactions are similar to the SMBus Block Read
+and Write operations, except these do not have a Count byte. They are
+supported by the SMBus layer and are described here for completeness, but
+they are *NOT* defined by the SMBus specification.
 
 I2C block transactions do not limit the number of bytes transferred
 but the SMBus layer places a limit of 32 bytes.
-- 
2.24.1


  parent reply	other threads:[~2020-01-05 23:14 UTC|newest]

Thread overview: 72+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-01-05 22:39 [PATCH 00/26] docs: i2c: rework I2C documentation, part I Luca Ceresoli
2020-01-05 22:49 ` [PATCH 01/26] docs: i2c: sort index logically Luca Ceresoli
2020-01-05 22:49   ` [PATCH 02/26] docs: i2c: summary: extend introduction Luca Ceresoli
2020-01-20  9:27     ` Jean Delvare
2020-01-20 21:54       ` Luca Ceresoli
2020-01-05 22:49   ` [PATCH 03/26] docs: i2c: summary: rewrite the "terminology" section Luca Ceresoli
2020-01-20 10:04     ` Jean Delvare
2020-01-05 22:49   ` [PATCH 04/26] docs: i2c: call it "I2C" consistently Luca Ceresoli
2020-01-07 10:33     ` Peter Rosin
2020-01-16  9:39     ` Jean Delvare
2020-01-05 22:49   ` [PATCH 05/26] docs: i2c: fix typo Luca Ceresoli
2020-01-07 10:33     ` Peter Rosin
2020-01-16  9:40     ` Jean Delvare
2020-01-05 22:49   ` [PATCH 06/26] docs: i2c: replace "I2C-transfer" -> "I2C transfer" consistently Luca Ceresoli
2020-01-07 10:34     ` Peter Rosin
2020-01-20 10:07     ` Jean Delvare
2020-01-05 22:49   ` [PATCH 07/26] docs: i2c: i2c-protocol: fix kernel-doc function syntax Luca Ceresoli
2020-01-20 10:51     ` Jean Delvare
2020-01-05 22:49   ` [PATCH 08/26] docs: i2c: i2c-protocol: properly name start and stop conditions Luca Ceresoli
2020-01-20 12:49     ` Jean Delvare
2020-01-05 22:49   ` [PATCH 09/26] docs: i2c: i2c-protocol: remove unneeded colons from table Luca Ceresoli
2020-01-20 13:38     ` Jean Delvare
2020-01-20 14:22       ` Jean Delvare
2020-01-05 22:49   ` [PATCH 10/26] docs: i2c: i2c-protocol: use proper names for ACK and NACK Luca Ceresoli
2020-01-20 13:50     ` Jean Delvare
2020-01-05 22:49   ` [PATCH 11/26] docs: i2c: smbus: fix link syntax Luca Ceresoli
2020-01-20 14:10     ` Jean Delvare
2020-01-05 22:49   ` [PATCH 12/26] docs: i2c: smbus-protocol: properly name start and stop conditions Luca Ceresoli
2020-01-20 14:16     ` Jean Delvare
2020-01-05 22:49   ` [PATCH 13/26] docs: i2c: smbus-protocol: remove unneeded colons from table Luca Ceresoli
2020-01-20 14:23     ` Jean Delvare
2020-01-05 22:50   ` [PATCH 14/26] docs: i2c: smbus-protocol: use proper names for ACK and NACK Luca Ceresoli
2020-01-20 14:26     ` Jean Delvare
2020-01-05 22:50   ` [PATCH 15/26] docs: i2c: smbus-protocol: enable kernel-doc function syntax Luca Ceresoli
2020-01-20 14:44     ` Jean Delvare
2020-01-21 17:31       ` Luca Ceresoli
2020-01-22 11:48         ` Jean Delvare
2020-01-23  9:51           ` Luca Ceresoli
2020-01-22 14:26         ` Jean Delvare
2020-01-22 15:37           ` Wolfram Sang
2020-01-23  9:51             ` Luca Ceresoli
2020-01-05 22:50   ` [PATCH 16/26] docs: i2c: smbus-protocol: fix " Luca Ceresoli
2020-01-20 14:51     ` Jean Delvare
2020-01-05 22:50   ` [PATCH 17/26] docs: i2c: i2c-protocol: fix typo Luca Ceresoli
2020-01-20 15:15     ` Jean Delvare
2020-01-05 22:50   ` [PATCH 18/26] docs: i2c: i2c-protocol: fix punctuation Luca Ceresoli
2020-01-20 15:16     ` Jean Delvare
2020-01-05 22:50   ` Luca Ceresoli [this message]
2020-01-21  9:16     ` [PATCH 19/26] docs: i2c: smbus-protocol: improve I2C Block transactions description Jean Delvare
2020-01-05 22:50   ` [PATCH 20/26] docs: i2c: instantiating-devices: fix internal hyperlink Luca Ceresoli
2020-01-21 10:07     ` Jean Delvare
2020-01-05 22:50   ` [PATCH 21/26] docs: i2c: instantiating-devices: rearrange static instatiation Luca Ceresoli
2020-01-21 18:02     ` Jean Delvare
2020-01-23  9:51       ` Luca Ceresoli
2020-01-05 22:50   ` [PATCH 22/26] docs: i2c: instantiating-devices: use monospace for filenames Luca Ceresoli
2020-01-22 10:08     ` Jean Delvare
2020-01-05 22:50   ` [PATCH 23/26] docs: i2c: old-module-parameters: fix internal hyperlink Luca Ceresoli
2020-01-22 10:16     ` Jean Delvare
2020-01-23  9:50       ` Luca Ceresoli
2020-01-20  9:08   ` [PATCH 01/26] docs: i2c: sort index logically Jean Delvare
2020-01-20  9:22     ` Luca Ceresoli
2020-01-20 13:56       ` Luca Ceresoli
2020-01-06  7:46 ` [PATCH 24/26] docs: i2c: old-module-parameters: clarify this is for obsolete kernels Luca Ceresoli
2020-01-22 11:18   ` Jean Delvare
2020-01-06  7:46 ` [PATCH 25/26] docs: i2c: old-module-parameters: use monospace for filenames Luca Ceresoli
2020-01-22 11:45   ` Jean Delvare
2020-01-06  7:49 ` [PATCH 26/26] docs: i2c: rename sections so the overall picture is clearer Luca Ceresoli
2020-01-07 10:36   ` Peter Rosin
2020-01-16  9:49   ` Jean Delvare
2020-01-16 10:38     ` Luca Ceresoli
2020-01-16 13:34       ` Peter Rosin
2020-01-06  8:03 ` [PATCH 00/26] docs: i2c: rework I2C documentation, part I Luca Ceresoli

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=20200105225012.11701-19-luca@lucaceresoli.net \
    --to=luca@lucaceresoli.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-i2c@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=peda@axentia.se \
    --cc=wsa@the-dreams.de \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.