Struct I2S

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

I2S driver.

Implementations

impl<'d, W: Word> I2S<'d, W>

pub fn new_txonly<T: Instance>( peri: impl Peripheral<P = T> + 'd, sd: impl Peripheral<P = impl MosiPin<T>> + 'd, ws: impl Peripheral<P = impl WsPin<T>> + 'd, ck: impl Peripheral<P = impl CkPin<T>> + 'd, mck: impl Peripheral<P = impl MckPin<T>> + 'd, txdma: impl Peripheral<P = impl TxDma<T>> + 'd, txdma_buf: &'d mut [W], freq: Hertz, config: Config, ) -> Self

Create a transmitter driver.

pub fn new_txonly_nomck<T: Instance>( peri: impl Peripheral<P = T> + 'd, sd: impl Peripheral<P = impl MosiPin<T>> + 'd, ws: impl Peripheral<P = impl WsPin<T>> + 'd, ck: impl Peripheral<P = impl CkPin<T>> + 'd, txdma: impl Peripheral<P = impl TxDma<T>> + 'd, txdma_buf: &'d mut [W], freq: Hertz, config: Config, ) -> Self

Create a transmitter driver without a master clock pin.

pub fn new_rxonly<T: Instance>( peri: impl Peripheral<P = T> + 'd, sd: impl Peripheral<P = impl MisoPin<T>> + 'd, ws: impl Peripheral<P = impl WsPin<T>> + 'd, ck: impl Peripheral<P = impl CkPin<T>> + 'd, mck: impl Peripheral<P = impl MckPin<T>> + 'd, rxdma: impl Peripheral<P = impl RxDma<T>> + 'd, rxdma_buf: &'d mut [W], freq: Hertz, config: Config, ) -> Self

Create a receiver driver.

pub fn new_full_duplex<T: Instance>( peri: impl Peripheral<P = T> + 'd, txsd: impl Peripheral<P = impl MosiPin<T>> + 'd, rxsd: impl Peripheral<P = impl MisoPin<T>> + 'd, ws: impl Peripheral<P = impl WsPin<T>> + 'd, ck: impl Peripheral<P = impl CkPin<T>> + 'd, mck: impl Peripheral<P = impl MckPin<T>> + 'd, txdma: impl Peripheral<P = impl TxDma<T>> + 'd, txdma_buf: &'d mut [W], rxdma: impl Peripheral<P = impl RxDma<T>> + 'd, rxdma_buf: &'d mut [W], freq: Hertz, config: Config, ) -> Self

Create a full duplex driver.

pub fn start(&mut self)

Start I2S driver.

pub fn clear(&mut self)

Reset the ring buffer to its initial state. Can be used to recover from overrun.

pub async fn stop(&mut self)

Stop I2S driver.

pub fn split<'s>( &'s mut self, ) -> Result<(Reader<'s, 'd, W>, Writer<'s, 'd, W>), Error>

Split the driver into a Reader/Writer pair. Useful for splitting the reader/writer functionality across tasks or for calling the read/write methods in parallel.

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

Read data from the I2S 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.

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

Write data to the I2S ringbuffer. This appends the data to the buffer and returns immediately. The data will be transmitted in the background. If thfre’s no space in the buffer, this waits until there is.

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

Write data directly to the raw I2S ringbuffer. This can be used to fill the buffer before starting the DMA transfer.

Trait Implementations

impl<'d, W: Word> Drop for I2S<'d, W>

fn drop(&mut self)

Executes the destructor for this type.