Struct stm32f1xx_hal::spi::Spi

pub struct Spi<SPI, REMAP, PINS, FRAMESIZE, OPERATION = Master> { /* private fields */ }

Implementations

impl<REMAP, PINS> Spi<SPI1, REMAP, PINS, u8, Master>

pub fn spi1(
    spi: SPI1,
    pins: PINS,
    mapr: &mut MAPR,
    mode: Mode,
    freq: Hertz,
    clocks: Clocks
) -> Selfwhere
    REMAP: Remap<Periph = SPI1>,
    PINS: Pins<REMAP>,

Constructs an SPI instance using SPI1 in 8bit dataframe mode.

The pin parameter tuple (sck, miso, mosi) should be (PA5, PA6, PA7) or (PB3, PB4, PB5) configured as (Alternate<...>, Input<...>, Alternate<...>).

You can also use NoSck, NoMiso or NoMosi if you don’t want to use the pins

impl<REMAP, PINS> Spi<SPI1, REMAP, PINS, u8, Slave>

pub fn spi1_slave(spi: SPI1, pins: PINS, mapr: &mut MAPR, mode: Mode) -> Selfwhere
    REMAP: Remap<Periph = SPI1>,
    PINS: Pins<REMAP, Slave>,

Constructs an SPI instance using SPI1 in 8bit dataframe mode.

The pin parameter tuple (sck, miso, mosi) should be (PA5, PA6, PA7) or (PB3, PB4, PB5) configured as (Input<...>, Alternate<...>, Input<...>).

You can also use NoMiso or NoMosi if you don’t want to use the pins

impl<REMAP, PINS> Spi<SPI2, REMAP, PINS, u8, Master>

pub fn spi2(spi: SPI2, pins: PINS, mode: Mode, freq: Hertz, clocks: Clocks) -> Selfwhere
    REMAP: Remap<Periph = SPI2>,
    PINS: Pins<REMAP>,

Constructs an SPI instance using SPI2 in 8bit dataframe mode.

The pin parameter tuple (sck, miso, mosi) should be (PB13, PB14, PB15) configured as (Alternate<...>, Input<...>, Alternate<...>).

You can also use NoSck, NoMiso or NoMosi if you don’t want to use the pins

impl<REMAP, PINS> Spi<SPI2, REMAP, PINS, u8, Slave>

pub fn spi2_slave(spi: SPI2, pins: PINS, mode: Mode) -> Selfwhere
    REMAP: Remap<Periph = SPI2>,
    PINS: Pins<REMAP, Slave>,

Constructs an SPI instance using SPI2 in 8bit dataframe mode.

The pin parameter tuple (sck, miso, mosi) should be (PB13, PB14, PB15) configured as (Input<...>, Alternate<...>, Input<...>).

You can also use NoMiso or NoMosi if you don’t want to use the pins

impl<REMAP, PINS> Spi<SPI3, REMAP, PINS, u8, Master>

pub fn spi3(spi: SPI3, pins: PINS, mode: Mode, freq: Hertz, clocks: Clocks) -> Selfwhere
    REMAP: Remap<Periph = SPI3>,
    PINS: Pins<REMAP>,

Constructs an SPI instance using SPI3 in 8bit dataframe mode.

The pin parameter tuple (sck, miso, mosi) should be (PB3, PB4, PB5) configured as (Alternate<...>, Input<...>, Alternate<...>).

You can also use NoSck, NoMiso or NoMosi if you don’t want to use the pins

impl<REMAP, PINS> Spi<SPI3, REMAP, PINS, u8, Slave>

pub fn spi3_slave(spi: SPI3, pins: PINS, mode: Mode) -> Selfwhere
    REMAP: Remap<Periph = SPI3>,
    PINS: Pins<REMAP>,

Constructs an SPI instance using SPI3 in 8bit dataframe mode.

The pin parameter tuple (sck, miso, mosi) should be (PB3, PB4, PB5) configured as (Input<...>, Alternate<...>, Input<...>).

You can also use NoMiso or NoMosi if you don’t want to use the pins

impl<SPI, REMAP, PINS, FrameSize, OP> Spi<SPI, REMAP, PINS, FrameSize, OP>where
    SPI: Instance,
    FrameSize: Copy,

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

👎Deprecated since 0.6.0: Please use release instead

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

pub fn bit_format(&mut self, format: SpiBitFormat)

Select which frame format is used for data transfers

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

Starts listening to the SPI by enabling the Received data ready to be read (RXNE) interrupt and Transmit data register empty (TXE) interrupt

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

Stops listening to the SPI by disabling the Received data ready to be read (RXNE) interrupt and Transmit data register empty (TXE) interrupt

pub fn is_tx_empty(&self) -> bool

Returns true if the tx register is empty (and can accept data)

pub fn is_rx_not_empty(&self) -> bool

Returns true if the rx register is not empty (and can be read)

pub fn is_overrun(&self) -> bool

Returns true if data are received and the previous data have not yet been read from SPI_DR.

pub fn is_busy(&self) -> bool

impl<SPI, REMAP, PINS, OP> Spi<SPI, REMAP, PINS, u8, OP>where
    SPI: Instance,

pub fn frame_size_16bit(self) -> Spi<SPI, REMAP, PINS, u16>

Converts from 8bit dataframe to 16bit.

impl<SPI, REMAP, PINS, OP> Spi<SPI, REMAP, PINS, u16, OP>where
    SPI: Instance,

pub fn frame_size_8bit(self) -> Spi<SPI, REMAP, PINS, u8>

Converts from 16bit dataframe to 8bit.

impl<REMAP, PINS, OP> Spi<SPI1, REMAP, PINS, u8, OP>

pub fn with_tx_dma(self, channel: C3) -> SpiTxDma<SPI1, REMAP, PINS, OP, C3>

pub fn with_rx_dma(self, channel: C2) -> SpiRxDma<SPI1, REMAP, PINS, OP, C2>

pub fn with_rx_tx_dma(
    self,
    rxchannel: C2,
    txchannel: C3
) -> SpiRxTxDma<SPI1, REMAP, PINS, OP, C2, C3>

impl<REMAP, PINS, OP> Spi<SPI2, REMAP, PINS, u8, OP>

pub fn with_tx_dma(self, channel: C5) -> SpiTxDma<SPI2, REMAP, PINS, OP, C5>

pub fn with_rx_dma(self, channel: C4) -> SpiRxDma<SPI2, REMAP, PINS, OP, C4>

pub fn with_rx_tx_dma(
    self,
    rxchannel: C4,
    txchannel: C5
) -> SpiRxTxDma<SPI2, REMAP, PINS, OP, C4, C5>

Trait Implementations

impl<SPI, REMAP, PINS, FrameSize, OP> FullDuplex<FrameSize> for Spi<SPI, REMAP, PINS, FrameSize, OP>where
    SPI: Instance,
    FrameSize: Copy,

type Error = Error

An enumeration of SPI errors

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

Reads the word stored in the shift register

fn send(&mut self, data: FrameSize) -> Result<(), Error>

Sends a word to the slave

impl<SPI, REMAP, PINS, FrameSize, OP> SpiReadWrite<FrameSize> for Spi<SPI, REMAP, PINS, FrameSize, OP>where
    SPI: Instance,
    FrameSize: Copy,

fn read_data_reg(&mut self) -> FrameSize

fn write_data_reg(&mut self, data: FrameSize)

fn spi_write(&mut self, words: &[FrameSize]) -> Result<(), Error>

impl<SPI, REMAP, PINS, OP> Write<u16> for Spi<SPI, REMAP, PINS, u16, OP>where
    SPI: Instance,

type Error = Error

Error type

fn write(&mut self, words: &[u16]) -> Result<(), Error>

Sends words to the slave, ignoring all the incoming words

impl<SPI, REMAP, PINS, OP> Write<u8> for Spi<SPI, REMAP, PINS, u8, OP>where
    SPI: Instance,

type Error = Error

Error type

fn write(&mut self, words: &[u8]) -> Result<(), Error>

Sends words to the slave, ignoring all the incoming words

impl<SPI, REMAP, PINS, FrameSize, OP> Default<FrameSize> for Spi<SPI, REMAP, PINS, FrameSize, OP>where
    SPI: Instance,
    FrameSize: Copy,