Struct nucleo_f401re::spi::Spi

pub struct Spi<SPI, PINS> { /* fields omitted */ }

Methods

impl<PINS> Spi<SPI1, PINS>

pub fn spi1(
    spi: SPI1,
    pins: PINS,
    mode: Mode,
    freq: Hertz,
    clocks: Clocks
) -> Spi<SPI1, PINS> where
    PINS: Pins<SPI1>, 

impl<PINS> Spi<SPI2, PINS>

pub fn spi2(
    spi: SPI2,
    pins: PINS,
    mode: Mode,
    freq: Hertz,
    clocks: Clocks
) -> Spi<SPI2, PINS> where
    PINS: Pins<SPI2>, 

impl<PINS> Spi<SPI3, PINS>

pub fn spi3(
    spi: SPI3,
    pins: PINS,
    mode: Mode,
    freq: Hertz,
    clocks: Clocks
) -> Spi<SPI3, PINS> where
    PINS: Pins<SPI3>, 

impl<PINS> Spi<SPI4, PINS>

pub fn spi4(
    spi: SPI4,
    pins: PINS,
    mode: Mode,
    freq: Hertz,
    clocks: Clocks
) -> Spi<SPI4, PINS> where
    PINS: Pins<SPI4>, 

impl<SPI, PINS> Spi<SPI, PINS> where
    SPI: Deref<Target = RegisterBlock>, 

pub fn init(self, mode: Mode, freq: Hertz, clock: Hertz) -> Spi<SPI, PINS>

pub fn listen(&mut self, event: Event)

Enable interrupts for the given event:

• Received data ready to be read (RXNE)
• Transmit data register empty (TXE)
• Transfer error

pub fn unlisten(&mut self, event: Event)

Disable interrupts for the given event:

• Received data ready to be read (RXNE)
• Transmit data register empty (TXE)
• Transfer error

pub fn is_txe(&self) -> bool

Return true if the TXE flag is set, i.e. new data to transmit can be written to the SPI.

pub fn is_rxne(&self) -> bool

Return true if the RXNE flag is set, i.e. new data has been received and can be read from the SPI.

pub fn is_modf(&self) -> bool

Return true if the MODF flag is set, i.e. the SPI has experienced a Master Mode Fault. (see chapter 28.3.10 of the STM32F4 Reference Manual)

pub fn is_ovr(&self) -> bool

Return true if the OVR flag is set, i.e. new data has been received while the receive data register was already filled.

pub fn free(self) -> (SPI, PINS)

Trait Implementations

impl<SPI, PINS> Default<u8> for Spi<SPI, PINS> where
    SPI: Deref<Target = RegisterBlock>, 

impl<SPI, PINS> Default<u8> for Spi<SPI, PINS> where
    SPI: Deref<Target = RegisterBlock>, 

impl<SPI, PINS> Debug for Spi<SPI, PINS> where
    PINS: Debug,
    SPI: Debug, 

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl<SPI, PINS> FullDuplex<u8> for Spi<SPI, PINS> where
    SPI: Deref<Target = RegisterBlock>, 

type Error = Error

An enumeration of SPI errors

fn read(&mut self) -> Result<u8, Error<Error>>

Reads the word stored in the shift register

fn send(&mut self, byte: u8) -> Result<(), Error<Error>>

Sends a word to the slave