Struct DualI2s

pub struct DualI2s<I: DualInstance> { /* private fields */ }

A wrapper around a SPI and a I2SEXT object and pins for full duplex I2S operation

Implementations

impl<SPI: DualInstance> DualI2s<SPI>

pub fn new( spi: SPI, i2s_ext: SPI::I2sExtPeripheral, pins: (impl Into<SPI::Ws>, impl Into<SPI::Ck>, impl Into<SPI::Mck>, impl Into<SPI::Sd>, impl Into<SPI::ExtSd>), clocks: &Clocks, ) -> Self

Creates an DualI2s object around a SPI peripheral, it’s I2SEXT extension, and pins

This function enables and resets the SPI and I2SEXT peripheral, but does not configure it.

The returned DualI2s object implements stm32_i2s_v12x::DualI2sPeripheral, so it can be used to configure the peripheral and communicate.

Panics

This function panics if the I2S clock input (from the I2S PLL or similar) is not configured.

pub fn release( self, ) -> (SPI, SPI::I2sExtPeripheral, (SPI::Ws, SPI::Ck, SPI::Mck, SPI::Sd, SPI::ExtSd))

impl<SPI: DualInstance> DualI2s<SPI>

pub fn ws_pin(&self) -> &SPI::Ws

pub fn ws_pin_mut(&mut self) -> &mut SPI::Ws

impl<I: DualInstance> DualI2s<I>

pub fn input_clock(&self) -> Hertz

Returns the frequency of the clock signal that the SPI peripheral is receiving from the I2S PLL or similar source

Trait Implementations

impl DualI2sPeripheral for DualI2s<SPI2>

where SPI2: Reset,

const MAIN_REGISTERS: *const () = {0x40003800 as *const ()}

Pointer to the SPI register block

const EXT_REGISTERS: *const () = {0x40003400 as *const ()}

Pointer to the I2SEXT register block

type WsPin = Ws

fn i2s_freq(&self) -> u32

Get I2s clock source frequency from the I2s device.

fn ws_pin(&self) -> &Self::WsPin

Get a reference to WS pin.

fn ws_pin_mut(&mut self) -> &mut Self::WsPin

Get mutable reference to WS pin;

fn rcc_reset(&mut self)

Reset the peripheral through the rcc register. This must be implemented with atomic operation through write to bit band region.

impl DualI2sPeripheral for DualI2s<SPI3>

where SPI3: Reset,

const MAIN_REGISTERS: *const () = {0x40003c00 as *const ()}

Pointer to the SPI register block

const EXT_REGISTERS: *const () = {0x40004000 as *const ()}

Pointer to the I2SEXT register block

type WsPin = Ws

fn i2s_freq(&self) -> u32

Get I2s clock source frequency from the I2s device.

fn ws_pin(&self) -> &Self::WsPin

Get a reference to WS pin.

fn ws_pin_mut(&mut self) -> &mut Self::WsPin

Get mutable reference to WS pin;

fn rcc_reset(&mut self)

Reset the peripheral through the rcc register. This must be implemented with atomic operation through write to bit band region.