Skip to content

optimized SPI blocking write #523

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.

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
## [Unreleased]

- Bump `stm32f4-staging`
- Optimized version of blocking SPI write [#523]

[#523]: https://github.com/stm32-rs/stm32f4xx-hal/pull/523

## [v0.22.1] - 2024-11-03

Expand Down
68 changes: 51 additions & 17 deletions src/spi.rs
Original file line number Diff line number Diff line change
Expand Up @@ -607,7 +607,7 @@ impl<SPI: Instance, const BIDI: bool, W> Spi<SPI, BIDI, W> {
/// Convert the spi to another mode.
fn into_mode<const BIDI2: bool, W2: FrameSize>(self) -> Spi<SPI, BIDI2, W2> {
let mut spi = Spi::_new(self.inner.spi, self.pins);
spi.enable(false);
spi.disable();
spi.init()
}
}
Expand All @@ -624,7 +624,7 @@ impl<SPI: Instance, const BIDI: bool, W> SpiSlave<SPI, BIDI, W> {
/// Convert the spi to another mode.
fn into_mode<const BIDI2: bool, W2: FrameSize>(self) -> SpiSlave<SPI, BIDI2, W2> {
let mut spi = SpiSlave::_new(self.inner.spi, self.pins);
spi.enable(false);
spi.disable();
spi.init()
}
}
Expand Down Expand Up @@ -703,12 +703,18 @@ impl<SPI: Instance> Inner<SPI> {
Self { spi }
}

/// Enable/disable spi
pub fn enable(&mut self, enable: bool) {
self.spi.cr1().modify(|_, w| {
// spe: enable the SPI bus
w.spe().bit(enable)
});
/// Enable SPI
pub fn enable(&mut self) {
// spe: enable the SPI bus
self.spi.cr1().modify(|_, w| w.spe().set_bit());
}

/// Disable SPI
pub fn disable(&mut self) {
// Wait for !BSY
while self.is_busy() {}
// spe: disable the SPI bus
self.spi.cr1().modify(|_, w| w.spe().clear_bit());
}

/// Select which frame format is used for data transfers
Expand Down Expand Up @@ -752,6 +758,19 @@ impl<SPI: Instance> Inner<SPI> {
self.spi.sr().read().ovr().bit_is_set()
}

fn check_errors(&self) -> Result<(), Error> {
let sr = self.spi.sr().read();
if sr.ovr().bit_is_set() {
Err(Error::Overrun)
} else if sr.modf().bit_is_set() {
Err(Error::ModeFault)
} else if sr.crcerr().bit_is_set() {
Err(Error::Crc)
} else {
Ok(())
}
}

#[inline]
fn bidi_output(&mut self) {
self.spi.cr1().modify(|_, w| w.bidioe().set_bit());
Expand Down Expand Up @@ -811,23 +830,38 @@ impl<SPI: Instance> Inner<SPI> {
})
}

// Implement write as per the "Transmit only procedure"
// RM SPI::3.5. This is more than twice as fast as the
// default Write<> implementation (which reads and drops each
// received value)
fn spi_write<const BIDI: bool, W: FrameSize>(
&mut self,
words: impl IntoIterator<Item = W>,
) -> Result<(), Error> {
if BIDI {
self.bidi_output();
for word in words.into_iter() {
nb::block!(self.check_send(word))?;
}
} else {
for word in words.into_iter() {
nb::block!(self.check_send(word))?;
nb::block!(self.check_read::<W>())?;
}
// Write each word when the tx buffer is empty
for word in words {
loop {
let sr = self.spi.sr().read();
if sr.txe().bit_is_set() {
self.write_data_reg(word);
if sr.modf().bit_is_set() {
return Err(Error::ModeFault);
}
break;
}
}
}

Ok(())
// Wait for final TXE
while !self.is_tx_empty() {}
if !BIDI {
// Clear OVR set due to dropped received values
let _: W = self.read_data_reg();
}
let _ = self.spi.sr().read();
self.check_errors()
}

fn listen_event(&mut self, disable: Option<BitFlags<Event>>, enable: Option<BitFlags<Event>>) {
Expand Down