diff options
| author | Matthew Blecker <matthewb@chromium.org> | 2020-05-20 17:57:13 -0700 |
|---|---|---|
| committer | Commit Bot <commit-bot@chromium.org> | 2020-05-21 20:55:50 +0000 |
| commit | aac0c25ef5cc7cb6758dc9ed650fab4995c58fcd (patch) | |
| tree | cab049a3a8203734549d7d757b7ed5972f1cd45b | |
| parent | a998171f5b4db4ab21cef33e80e5acc129b35097 (diff) | |
| download | chrome-ec-aac0c25ef5cc7cb6758dc9ed650fab4995c58fcd.tar.gz | |
i2c-pseudo: Bring in FROMLIST v4 changes.
Changes in this diff:
- Documentation: I2C addresses on the controller streams are right-aligned
without any read/write bit.
- Documentation: fix "transacton" -> "transaction" typo
Patch v4 on linux-i2c:
https://lore.kernel.org/linux-i2c/20200521002907.176922-1-matthewb@chromium.org/
https://patchwork.ozlabs.org/project/linux-i2c/patch/20200521002907.176922-1-matthewb@chromium.org/
BRANCH=none
BUG=none
TEST=none (only documentation changes)
Change-Id: I1673e8bbd4135e7905342fc2cbcb9fb415a77256
Signed-off-by: Matthew Blecker <matthewb@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2210834
Reviewed-by: Harry Cutts <hcutts@chromium.org>
| -rw-r--r-- | extra/i2c_pseudo/Documentation.txt | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/extra/i2c_pseudo/Documentation.txt b/extra/i2c_pseudo/Documentation.txt index 86c5bfc928..77de99574b 100644 --- a/extra/i2c_pseudo/Documentation.txt +++ b/extra/i2c_pseudo/Documentation.txt @@ -115,7 +115,8 @@ The msg_id is a decimal number representing the index of the I2C message within its transaction, in other words the index in master_xfer() *msgs array arg. This starts at 0 after each I2C_BEGIN_XFER. This is guaranteed to not wrap. -The addr is the hexadecimal I2C address for this I2C message. +The addr is the hexadecimal I2C address for this I2C message. The address is +right-aligned without any read/write bit. The flags are the same bitmask flags used in struct i2c_msg, in hexadecimal form. Of particular importance to any pseudo controller is the read bit, which @@ -132,8 +133,8 @@ hexadecimal byte values, in the format shown in the example above. Read Command: I2C_COMMIT_XFER Example: "I2C_COMMIT_XFER\n" -Details: This indicates the end of an I2C transacton request, in other words the -end of the I2C messages from a single invocation of the I2C adapter's +Details: This indicates the end of an I2C transaction request, in other words +the end of the I2C messages from a single invocation of the I2C adapter's master_xfer() callback. This should be read exactly once after each I2C_BEGIN_XFER, with a varying number of I2C_XFER_REQ between them. |