Skip to content

Commit

Permalink
Documentation: i2c: slave: describe buffer problems a bit better
Browse files Browse the repository at this point in the history
Signed-off-by: Wolfram Sang <wsa@the-dreams.de>
  • Loading branch information
Wolfram Sang committed Jul 23, 2016
1 parent 85946ab commit 38fa8af
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions Documentation/i2c/slave-interface
Original file line number Diff line number Diff line change
Expand Up @@ -173,13 +173,14 @@ During development of this API, the question of using buffers instead of just
bytes came up. Such an extension might be possible, usefulness is unclear at
this time of writing. Some points to keep in mind when using buffers:

* Buffers should be opt-in and slave drivers will always have to support
byte-based transactions as the ultimate fallback because this is how the
majority of HW works.

* For backends simulating hardware registers, buffers are not helpful because
on writes an action should be immediately triggered. For reads, the data in
the buffer might get stale.
* Buffers should be opt-in and backend drivers will always have to support
byte-based transactions as the ultimate fallback anyhow because this is how
the majority of HW works.

* For backends simulating hardware registers, buffers are largely not helpful
because after each byte written an action should be immediately triggered.
For reads, the data kept in the buffer might get stale if the backend just
updated a register because of internal processing.

* A master can send STOP at any time. For partially transferred buffers, this
means additional code to handle this exception. Such code tends to be
Expand Down

0 comments on commit 38fa8af

Please sign in to comment.