Struct Sai

pub struct Sai<'d, T: Instance, W: Word> { /* private fields */ }

SAI sub-block driver.

Implementations

impl<'d, T: Instance, W: Word> Sai<'d, T, W>

pub fn new_asynchronous_with_mclk<S: SubBlockInstance>( peri: SubBlock<'d, T, S>, sck: impl Peripheral<P = impl SckPin<T, S>> + 'd, sd: impl Peripheral<P = impl SdPin<T, S>> + 'd, fs: impl Peripheral<P = impl FsPin<T, S>> + 'd, mclk: impl Peripheral<P = impl MclkPin<T, S>> + 'd, dma: impl Peripheral<P = impl Channel + Dma<T, S>> + 'd, dma_buf: &'d mut [W], config: Config, ) -> Self

Create a new SAI driver in asynchronous mode with MCLK.

You can obtain the SubBlock with split_subblocks.

pub fn new_asynchronous<S: SubBlockInstance>( peri: SubBlock<'d, T, S>, sck: impl Peripheral<P = impl SckPin<T, S>> + 'd, sd: impl Peripheral<P = impl SdPin<T, S>> + 'd, fs: impl Peripheral<P = impl FsPin<T, S>> + 'd, dma: impl Peripheral<P = impl Channel + Dma<T, S>> + 'd, dma_buf: &'d mut [W], config: Config, ) -> Self

Create a new SAI driver in asynchronous mode without MCLK.

You can obtain the SubBlock with split_subblocks.

pub fn new_synchronous<S: SubBlockInstance>( peri: SubBlock<'d, T, S>, sd: impl Peripheral<P = impl SdPin<T, S>> + 'd, dma: impl Peripheral<P = impl Channel + Dma<T, S>> + 'd, dma_buf: &'d mut [W], config: Config, ) -> Self

Create a new SAI driver in synchronous mode.

You can obtain the SubBlock with split_subblocks.

pub fn start(&mut self) -> Result<(), Error>

Start the SAI driver.

Only receivers can be started. Transmitters are started on the first writing operation.

pub fn reset()

Reset SAI operation.

pub fn set_mute(&mut self, value: bool)

Enable or disable mute.

pub fn is_muted(&self) -> Result<bool, Error>

Determine the mute state of the receiver.

Clears the mute state flag in the status register.

pub async fn wait_write_error(&mut self) -> Result<(), Error>

Wait until any SAI write error occurs.

One useful application for this is stopping playback as soon as the SAI experiences an overrun of the ring buffer. Then, instead of letting the SAI peripheral play the last written buffer over and over again, SAI can be muted or dropped instead.

pub async fn write(&mut self, data: &[W]) -> Result<(), Error>

Write data to the SAI ringbuffer.

The first write starts the DMA after filling the ring buffer with the provided data. This ensures that the DMA does not run before data is available in the ring buffer.

This appends the data to the buffer and returns immediately. The data will be transmitted in the background.

If there’s no space in the buffer, this waits until there is.

pub async fn read(&mut self, data: &mut [W]) -> Result<(), Error>

Read data from the SAI ringbuffer.

SAI is always receiving data in the background. This function pops already-received data from the buffer.

If there’s less than data.len() data in the buffer, this waits until there is.

Trait Implementations

impl<'d, T: Instance, W: Word> Drop for Sai<'d, T, W>

fn drop(&mut self)

Executes the destructor for this type.