Struct I2s

pub struct I2s<I: Instance> { /* private fields */ }

An I2s wrapper around an SPI object and pins

Implementations

impl<SPI: Instance> I2s<SPI>

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

Creates an I2s object around an SPI peripheral and pins

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

The returned I2s object implements stm32_i2s_v12x::I2sPeripheral, 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::Ws, SPI::Ck, SPI::Mck, SPI::Sd))

impl<SPI: Instance> I2s<SPI>

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

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

impl<I: Instance> I2s<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 I2sPeripheral for I2s<SPI2>

where SPI2: Reset,

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

Pointer to the SPI 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 operations through writes to the bit band region.

impl I2sPeripheral for I2s<SPI3>

where SPI3: Reset,

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

Pointer to the SPI 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 operations through writes to the bit band region.

impl I2sPeripheral for I2s<SPI4>

where SPI4: Reset,

const REGISTERS: *const () = {0x40013400 as *const ()}

Pointer to the SPI 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 operations through writes to the bit band region.

impl I2sPeripheral for I2s<SPI5>

where SPI5: Reset,

const REGISTERS: *const () = {0x40015000 as *const ()}

Pointer to the SPI 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 operations through writes to the bit band region.