itsscb/embedded-hal
1
0
Fork 0
mirror of https://github.com/rust-embedded/embedded-hal.git synced 2026-04-15 02:40:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation for FullDuplex to try_ methods

Browse Source
This commit is contained in:
David Sawatzke
2020-07-27 18:55:05 +02:00
parent ce8a7b9729
commit b8df447267
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/spi.rs
View File

@@ -8,12 +8,12 @@ use nb;
///
/// - It's the task of the user of this interface to manage the slave select lines
///
/// - Due to how full duplex SPI works each `read` call must be preceded by a `send` call.
/// - Due to how full duplex SPI works each `try_read` call must be preceded by a `try_send` call.
///
/// - `read` calls only return the data received with the last `send` call.
/// - `try_read` calls only return the data received with the last `send` call.
/// Previously received data is discarded
///
/// - Data is only guaranteed to be clocked out when the `read` call succeeds.
/// - Data is only guaranteed to be clocked out when the `try_read` call succeeds.
/// The slave select line shouldn't be released before that.
///
/// - Some SPIs can work with 8-bit *and* 16-bit words. You can overload this trait with different