diff options
| author | Luca Ceresoli <luca@lucaceresoli.net> | 2020-01-29 16:19:33 +0100 |
|---|---|---|
| committer | Wolfram Sang <wsa@the-dreams.de> | 2020-01-29 22:01:30 +0100 |
| commit | f954731d2af433ce012f8dc456206eccd3cf2ee4 (patch) | |
| tree | c3f19523ca964d211149dfba03dc9e25a41ff3ad /Documentation/i2c/i2c-protocol.rst | |
| parent | docs: i2c: i2c-protocol: fix kernel-doc function syntax (diff) | |
| download | linux-f954731d2af433ce012f8dc456206eccd3cf2ee4.tar.xz linux-f954731d2af433ce012f8dc456206eccd3cf2ee4.zip | |
docs: i2c: i2c-protocol: properly name start and stop conditions
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 <luca@lucaceresoli.net>
Reviewed-by: Jean Delvare <jdelvare@suse.de>
Signed-off-by: Wolfram Sang <wsa@the-dreams.de>
Diffstat (limited to 'Documentation/i2c/i2c-protocol.rst')
| -rw-r--r-- | Documentation/i2c/i2c-protocol.rst | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/Documentation/i2c/i2c-protocol.rst b/Documentation/i2c/i2c-protocol.rst index f289d7759a51..c090003f55ed 100644 --- a/Documentation/i2c/i2c-protocol.rst +++ b/Documentation/i2c/i2c-protocol.rst @@ -8,8 +8,8 @@ Key to symbols ============== =============== ============================================================= -S (1 bit) : Start bit -P (1 bit) : Stop bit +S : Start condition +P : Stop condition Rd/Wr (1 bit) : Read/Write bit. Rd equals 1, Wr equals 0. A, NA (1 bit) : Accept and reverse accept bit. Addr (7 bits): I2C 7 bit address. Note that this can be expanded as usual to @@ -46,9 +46,9 @@ Combined transactions This corresponds to i2c_transfer(). -They are just like the above transactions, but instead of a stop bit P -a start bit S is sent and the transaction continues. An example of -a byte read, followed by a byte write:: +They are just like the above transactions, but instead of a stop +condition P a start condition S is sent and the transaction continues. +An example of a byte read, followed by a byte write:: S Addr Rd [A] [Data] NA S Addr Wr [A] Data [A] P @@ -77,8 +77,9 @@ I2C_M_NOSTART: S Addr Rd [A] [Data] NA Data [A] P If you set the I2C_M_NOSTART variable for the first partial message, - we do not generate Addr, but we do generate the startbit S. This will - probably confuse all other clients on your bus, so don't try this. + we do not generate Addr, but we do generate the start condition S. + This will probably confuse all other clients on your bus, so don't + try this. This is often used to gather transmits from multiple data buffers in system memory into something that appears as a single transfer to the |