lkml.org 
[lkml]   [2020]   [Jan]   [23]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH v2 08/28] docs: i2c: i2c-protocol: properly name start and stop conditions
    Date
    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>
    ---
    Documentation/i2c/i2c-protocol.rst | 15 ++++++++-------
    1 file 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
    --
    2.25.0
    \
     
     \ /
      Last update: 2020-01-23 14:55    [W:4.627 / U:0.076 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site