Skip to content

Commit

Permalink
Document implicit assumption about the blocking behaviour of the calls
Browse files Browse the repository at this point in the history
  • Loading branch information
david-sawatzke committed Jan 3, 2019
1 parent b7567f3 commit 32125c0
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/spi.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ use nb;
/// - `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.
/// 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.
pub trait FullDuplex<Word> {
Expand Down

0 comments on commit 32125c0

Please sign in to comment.