linux-toradex.git/Documentation/i2c/i2c-protocol.rst, branch v6.4-rc3

docs: i2c: i2c-protocol: remove unused legend items

2022-08-11T21:05:11+00:00

"Comm", "Count", "DataLow", "DataHigh" are not used in this section.

Signed-off-by: Luca Ceresoli 
Signed-off-by: Wolfram Sang

docs: i2c: i2c-protocol,smbus-protocol: remove nonsense words

2022-08-11T21:03:02+00:00

"as usual" does not mean much here, especially as these are introductory
sections and 10-bit addressing hasn't been introduced yet.

Signed-off-by: Luca Ceresoli 
Signed-off-by: Wolfram Sang

docs: i2c: i2c-protocol: update introductory paragraph

2022-08-11T21:02:52+00:00

This sentence dates back to the pre-git era and it does not look very
professional... As there is no clear definition of "finished", and given
this page is already a pretty good overview, not to mention it is not the
kernel responsibility to document the protocol in detail, let's update the
text accordingly.

Signed-off-by: Luca Ceresoli 
Signed-off-by: Wolfram Sang

docs: i2c: i2c-protocol: use same wording as smbus-protocol

2020-01-29T21:02:07+00:00

In smbus-protocol.rst we use the text "Implemented by" for the same meaning
as "This corresponds to". Change everything to "Implemented by" for
coherency.

Signed-off-by: Luca Ceresoli 
Reported-by: Jean Delvare 
Reviewed-by: Jean Delvare 
Signed-off-by: Wolfram Sang

docs: i2c: rename sections so the overall picture is clearer

2020-01-29T21:02:06+00:00

Some of the section names are not very clear. Reading those names in the
index.rst page does not help much in grasping what the content is supposed
to be.

Rename those sections to clarify their content, especially when reading
the index page.

Signed-off-by: Luca Ceresoli 
Acked-by: Peter Rosin 
Reviewed-by: Jean Delvare 
Signed-off-by: Wolfram Sang

docs: i2c: i2c-protocol: use proper names for ACK and NACK

2020-01-29T21:01:34+00:00

Use the proper ACK and NACK naming from the I2C specification instead of
"accept" and "reverse accept".

Signed-off-by: Luca Ceresoli 
Reviewed-by: Jean Delvare 
Signed-off-by: Wolfram Sang

docs: i2c: i2c-protocol: remove unneeded colons from table

2020-01-29T21:01:32+00:00

These colons are not needed: the columns already nicely separate the
symbols from their description. They are also inconsistently preceded by
whitespace.

Remove the colons completely to simplify and clean up.

Signed-off-by: Luca Ceresoli 
Reviewed-by: Jean Delvare 
Signed-off-by: Wolfram Sang

docs: i2c: i2c-protocol: properly name start and stop conditions

2020-01-29T21:01:30+00:00

In I2C there is no such thing as a "start bit" or a "stop bit". Use the
proper naming: "start condition" and "stop condition".

Signed-off-by: Luca Ceresoli 
Reviewed-by: Jean Delvare 
Signed-off-by: Wolfram Sang

docs: i2c: i2c-protocol: fix kernel-doc function syntax

2020-01-29T21:01:29+00:00

This clarifies these are functions and adds a hyperlink to the function
documentation.

Signed-off-by: Luca Ceresoli 
Reviewed-by: Jean Delvare 
Signed-off-by: Wolfram Sang

docs: i2c: call it "I2C" consistently

2020-01-29T21:01:24+00:00

Uppercase "I2C" is used almost everywhere in the docs, but the lowercase
version "i2c" is used somewhere. Use the uppercase form consistently.

Signed-off-by: Luca Ceresoli 
Acked-by: Peter Rosin 
Reviewed-by: Jean Delvare 
Signed-off-by: Wolfram Sang