diff options
| author | xoviat <[email protected]> | 2021-03-08 14:00:31 -0600 |
|---|---|---|
| committer | xoviat <[email protected]> | 2021-03-08 14:00:31 -0600 |
| commit | 5df6e57949f07dd2ec95dadaf31877a1ab30e1cc (patch) | |
| tree | 04bb2f717c3948936e2dd2a22dd0ab83b54626d9 /embassy-traits/src | |
| parent | f2ab4c4ec052e7b92a41e61941c5185d6c87e879 (diff) | |
update docs
Diffstat (limited to 'embassy-traits/src')
| -rw-r--r-- | embassy-traits/src/spi.rs | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/embassy-traits/src/spi.rs b/embassy-traits/src/spi.rs index cc5c33ec8..d0cf29e6d 100644 --- a/embassy-traits/src/spi.rs +++ b/embassy-traits/src/spi.rs | |||
| @@ -8,12 +8,12 @@ use core::future::Future; | |||
| 8 | /// | 8 | /// |
| 9 | /// - It's the task of the user of this interface to manage the slave select lines | 9 | /// - It's the task of the user of this interface to manage the slave select lines |
| 10 | /// | 10 | /// |
| 11 | /// - Due to how full duplex SPI works each `try_read` call must be preceded by a `try_send` call. | 11 | /// - Due to how full duplex SPI works each `read` call must be preceded by a `write` call. |
| 12 | /// | 12 | /// |
| 13 | /// - `try_read` calls only return the data received with the last `try_send` call. | 13 | /// - `read` calls only return the data received with the last `write` call. |
| 14 | /// Previously received data is discarded | 14 | /// Previously received data is discarded |
| 15 | /// | 15 | /// |
| 16 | /// - Data is only guaranteed to be clocked out when the `try_read` call succeeds. | 16 | /// - Data is only guaranteed to be clocked out when the `read` call succeeds. |
| 17 | /// The slave select line shouldn't be released before that. | 17 | /// The slave select line shouldn't be released before that. |
| 18 | /// | 18 | /// |
| 19 | /// - Some SPIs can work with 8-bit *and* 16-bit words. You can overload this trait with different | 19 | /// - Some SPIs can work with 8-bit *and* 16-bit words. You can overload this trait with different |
