From ce8a7b9729a67a507a557e99495d784d606999cd Mon Sep 17 00:00:00 2001 From: David Sawatzke Date: Thu, 3 Jan 2019 15:56:01 +0100 Subject: [PATCH] Document implicit assumption about the blocking behaviour of the calls --- src/spi.rs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/spi.rs b/src/spi.rs index 8308015..b9b55e6 100644 --- a/src/spi.rs +++ b/src/spi.rs @@ -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 {