Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document implicit assumption in non-blocking spi trait #120

Merged
merged 4 commits into from
Sep 16, 2020
Merged

Document implicit assumption in non-blocking spi trait #120

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c4a8eb7
Document implicit assumption in spi non-blocking trait
david-sawatzke Jan 2, 2019
ce8a7b9
Document implicit assumption about the blocking behaviour of the calls
david-sawatzke Jan 3, 2019
b8df447
Update documentation for FullDuplex to `try_` methods
david-sawatzke Jul 27, 2020
5bae50b
Fix missed remaining `send` in FullDuplex documentation
david-sawatzke Sep 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion src/spi.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,13 @@ 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.
///
/// - `try_read` calls only return the data received with the last `try_send` call.
/// Previously received data is discarded
david-sawatzke marked this conversation as resolved.
Show resolved Hide resolved
///
/// - 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
/// `Word` types to allow operation in both modes.
Expand Down