Struct stm32f4xx_hal::i2s::I2s

pub struct I2s<I, PINS> { /* fields omitted */ }

An I2s wrapper around an SPI object and pins

Implementations

impl<SPI, WS, CK, MCLK, SD, const WSA: u8, const CKA: u8, const MCLKA: u8, const SDA: u8> I2s<SPI, (WS, CK, MCLK, SD)> where
    SPI: I2sFreq + Enable + Reset,
    WS: PinWs<SPI, A = Const<WSA>> + SetAlternate<WSA>,
    CK: PinCk<SPI, A = Const<CKA>> + SetAlternate<CKA>,
    MCLK: PinMck<SPI, A = Const<MCLKA>> + SetAlternate<MCLKA>,
    SD: PinSd<SPI, A = Const<SDA>> + SetAlternate<SDA>, 

pub fn new(spi: SPI, pins: (WS, CK, MCLK, 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::Instance, 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.

impl<WS, CK, MCLK, SD, const WSA: u8, const CKA: u8, const MCLKA: u8, const SDA: u8> I2s<SPI2, (WS, CK, MCLK, SD)> where
    WS: PinWs<SPI2, A = Const<WSA>> + SetAlternate<WSA>,
    CK: PinCk<SPI2, A = Const<CKA>> + SetAlternate<CKA>,
    MCLK: PinMck<SPI2, A = Const<MCLKA>> + SetAlternate<MCLKA>,
    SD: PinSd<SPI2, A = Const<SDA>> + SetAlternate<SDA>, 

pub fn i2s2(spi: SPI2, pins: (WS, CK, MCLK, SD), clocks: Clocks) -> Self

👎 Deprecated since 0.10.0:

Please use new instead

impl<WS, CK, MCLK, SD, const WSA: u8, const CKA: u8, const MCLKA: u8, const SDA: u8> I2s<SPI3, (WS, CK, MCLK, SD)> where
    WS: PinWs<SPI3, A = Const<WSA>> + SetAlternate<WSA>,
    CK: PinCk<SPI3, A = Const<CKA>> + SetAlternate<CKA>,
    MCLK: PinMck<SPI3, A = Const<MCLKA>> + SetAlternate<MCLKA>,
    SD: PinSd<SPI3, A = Const<SDA>> + SetAlternate<SDA>, 

pub fn i2s3(spi: SPI3, pins: (WS, CK, MCLK, SD), clocks: Clocks) -> Self

👎 Deprecated since 0.10.0:

Please use new instead

impl<I, PINS> I2s<I, PINS>

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<PINS> Instance for I2s<SPI2, PINS>

const REGISTERS: *mut RegisterBlock

Pointer to the SPI register block

impl<PINS> Instance for I2s<SPI3, PINS>

const REGISTERS: *mut RegisterBlock

Pointer to the SPI register block