Skip to content

Commit

Permalink
Improve the architecture of SpiFuture
Browse files Browse the repository at this point in the history
After trying to use `SpiFuture` in the real world, I encountered some
problems that these changes address. Specifically, I added the ability
for the `Spi` struct to be part of some user type. The `AsSpi` trait
provides an interface for the `SpiFuture`. This has the added benefit of
simplifying the implementation.
  • Loading branch information
bradleyharden committed Feb 26, 2022
1 parent 0ebcacd commit 3e850bb
Show file tree
Hide file tree
Showing 4 changed files with 311 additions and 274 deletions.
1 change: 1 addition & 0 deletions hal/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Unreleased Changes

- Improve the architecture of `SpiFuture` (#577)
- Update `seq_macro` and remove `replace_with` dependencies (#568)
- Add a `bsp_peripherals!` macro and fix a bug in `bsp_pins!` (#515)
- Updated to 2021 edition, updated dependencies, removed unused dependencies (#562)
Expand Down
34 changes: 34 additions & 0 deletions hal/src/sercom/v2/spi.rs
Original file line number Diff line number Diff line change
Expand Up @@ -779,6 +779,31 @@ where
self.change()
}

/// Return the transaction length, in bytes
///
/// This function is valid for all chips and SPI configurations. It returns
/// the number of bytes in a single SPI transaction.
#[cfg(any(feature = "samd11", feature = "samd21"))]
#[inline]
pub fn transaction_length(&self) -> u8 {
Z::BYTES
}

/// Return the transaction length, in bytes
///
/// This function is valid for all chips and SPI configurations. It returns
/// the number of bytes in a single SPI transaction.
#[cfg(feature = "min-samd51g")]
#[inline]
pub fn transaction_length(&self) -> u8 {
use typenum::Unsigned;
if Z::U8 == DynLength::U8 {
self.regs.get_length()
} else {
Z::U8
}
}

/// Get the clock polarity
#[inline]
pub fn get_cpol(&self) -> Polarity {
Expand Down Expand Up @@ -1178,6 +1203,15 @@ where
}
}

/// Return the transaction length, in bytes
///
/// This function is valid for all chips and SPI configurations. It returns
/// the number of bytes in a single SPI transaction.
#[inline]
pub fn transaction_length(&self) -> u8 {
self.config.as_ref().transaction_length()
}

/// Update the SPI configuration.
///
/// Calling this method will temporarily disable the SERCOM peripheral, as
Expand Down
5 changes: 5 additions & 0 deletions hal/src/sercom/v2/spi/char_size.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ pub trait CharSize: Sealed {

/// Register bit pattern for the corresponding `CharSize`
const BITS: u8;

/// Number of bytes in an SPI transaction
const BYTES: u8;
}

/// Type alias to recover the [`Word`](CharSize::Word) type from an
Expand All @@ -44,10 +47,12 @@ impl Sealed for EightBit {}
impl CharSize for EightBit {
type Word = u8;
const BITS: u8 = 0;
const BYTES: u8 = 1;
}

impl Sealed for NineBit {}
impl CharSize for NineBit {
type Word = u16;
const BITS: u8 = 1;
const BYTES: u8 = 2;
}
Loading

0 comments on commit 3e850bb

Please # to comment.