| Message ID | 20200105225012.11701-19-luca@lucaceresoli.net |
|---|---|
| State | Changes Requested |
| Headers | show |
| Series | docs: i2c: rework I2C documentation, part I | expand |
On Sun, 5 Jan 2020 23:50:05 +0100, Luca Ceresoli wrote: > 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. Reviewed-by: Jean Delvare <jdelvare@suse.de>
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.
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(-)