Struct stm32f4xx_hal::spi::Spi

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

Implementations

impl<SCK, MISO, MOSI, const SCKA: u8, const MISOA: u8, const MOSIA: u8> Spi<SPI1, (SCK, MISO, MOSI), TransferModeNormal> where
    SCK: PinSck<SPI1, A = Const<SCKA>> + SetAlternate<SCKA>,
    MISO: PinMiso<SPI1, A = Const<MISOA>> + SetAlternate<MISOA>,
    MOSI: PinMosi<SPI1, A = Const<MOSIA>> + SetAlternate<MOSIA>, 

pub fn spi1(
    spi: SPI1,
    pins: (SCK, MISO, MOSI),
    mode: Mode,
    freq: impl Into<Hertz>,
    clocks: Clocks
) -> Spi<SPI1, (SCK, MISO, MOSI), TransferModeNormal>

👎 Deprecated since 0.10.0:

Please use new instead

impl<SCK, MISO, MOSI, const SCKA: u8, const MISOA: u8, const MOSIA: u8> Spi<SPI2, (SCK, MISO, MOSI), TransferModeNormal> where
    SCK: PinSck<SPI2, A = Const<SCKA>> + SetAlternate<SCKA>,
    MISO: PinMiso<SPI2, A = Const<MISOA>> + SetAlternate<MISOA>,
    MOSI: PinMosi<SPI2, A = Const<MOSIA>> + SetAlternate<MOSIA>, 

pub fn spi2(
    spi: SPI2,
    pins: (SCK, MISO, MOSI),
    mode: Mode,
    freq: impl Into<Hertz>,
    clocks: Clocks
) -> Spi<SPI2, (SCK, MISO, MOSI), TransferModeNormal>

👎 Deprecated since 0.10.0:

Please use new instead

impl<SCK, MISO, MOSI, const SCKA: u8, const MISOA: u8, const MOSIA: u8> Spi<SPI3, (SCK, MISO, MOSI), TransferModeNormal> where
    SCK: PinSck<SPI3, A = Const<SCKA>> + SetAlternate<SCKA>,
    MISO: PinMiso<SPI3, A = Const<MISOA>> + SetAlternate<MISOA>,
    MOSI: PinMosi<SPI3, A = Const<MOSIA>> + SetAlternate<MOSIA>, 

pub fn spi3(
    spi: SPI3,
    pins: (SCK, MISO, MOSI),
    mode: Mode,
    freq: impl Into<Hertz>,
    clocks: Clocks
) -> Spi<SPI3, (SCK, MISO, MOSI), TransferModeNormal>

👎 Deprecated since 0.10.0:

Please use new instead

impl<SCK, MISO, MOSI, const SCKA: u8, const MISOA: u8, const MOSIA: u8> Spi<SPI4, (SCK, MISO, MOSI), TransferModeNormal> where
    SCK: PinSck<SPI4, A = Const<SCKA>> + SetAlternate<SCKA>,
    MISO: PinMiso<SPI4, A = Const<MISOA>> + SetAlternate<MISOA>,
    MOSI: PinMosi<SPI4, A = Const<MOSIA>> + SetAlternate<MOSIA>, 

pub fn spi4(
    spi: SPI4,
    pins: (SCK, MISO, MOSI),
    mode: Mode,
    freq: impl Into<Hertz>,
    clocks: Clocks
) -> Spi<SPI4, (SCK, MISO, MOSI), TransferModeNormal>

👎 Deprecated since 0.10.0:

Please use new instead

impl<SCK, MISO, MOSI, const SCKA: u8, const MISOA: u8, const MOSIA: u8> Spi<SPI5, (SCK, MISO, MOSI), TransferModeNormal> where
    SCK: PinSck<SPI5, A = Const<SCKA>> + SetAlternate<SCKA>,
    MISO: PinMiso<SPI5, A = Const<MISOA>> + SetAlternate<MISOA>,
    MOSI: PinMosi<SPI5, A = Const<MOSIA>> + SetAlternate<MOSIA>, 

pub fn spi5(
    spi: SPI5,
    pins: (SCK, MISO, MOSI),
    mode: Mode,
    freq: impl Into<Hertz>,
    clocks: Clocks
) -> Spi<SPI5, (SCK, MISO, MOSI), TransferModeNormal>

👎 Deprecated since 0.10.0:

Please use new instead

impl<SCK, MISO, MOSI, const SCKA: u8, const MISOA: u8, const MOSIA: u8> Spi<SPI6, (SCK, MISO, MOSI), TransferModeNormal> where
    SCK: PinSck<SPI6, A = Const<SCKA>> + SetAlternate<SCKA>,
    MISO: PinMiso<SPI6, A = Const<MISOA>> + SetAlternate<MISOA>,
    MOSI: PinMosi<SPI6, A = Const<MOSIA>> + SetAlternate<MOSIA>, 

pub fn spi6(
    spi: SPI6,
    pins: (SCK, MISO, MOSI),
    mode: Mode,
    freq: impl Into<Hertz>,
    clocks: Clocks
) -> Spi<SPI6, (SCK, MISO, MOSI), TransferModeNormal>

👎 Deprecated since 0.10.0:

Please use new instead

impl<SPI, SCK, MISO, MOSI, const SCKA: u8, const MISOA: u8, const MOSIA: u8> Spi<SPI, (SCK, MISO, MOSI), TransferModeNormal> where
    SPI: Instance,
    SCK: PinSck<SPI, A = Const<SCKA>> + SetAlternate<SCKA>,
    MISO: PinMiso<SPI, A = Const<MISOA>> + SetAlternate<MISOA>,
    MOSI: PinMosi<SPI, A = Const<MOSIA>> + SetAlternate<MOSIA>, 

pub fn new(
    spi: SPI,
    pins: (SCK, MISO, MOSI),
    mode: Mode,
    freq: impl Into<Hertz>,
    clocks: Clocks
) -> Self

pub fn to_bidi_transfer_mode(
    self
) -> Spi<SPI, (SCK, MISO, MOSI), TransferModeBidi>

impl<SPI, SCK, MISO, MOSI, const SCKA: u8, const MISOA: u8, const MOSIA: u8> Spi<SPI, (SCK, MISO, MOSI), TransferModeBidi> where
    SPI: Instance,
    SCK: PinSck<SPI, A = Const<SCKA>> + SetAlternate<SCKA>,
    MISO: PinMiso<SPI, A = Const<MISOA>> + SetAlternate<MISOA>,
    MOSI: PinMosi<SPI, A = Const<MOSIA>> + SetAlternate<MOSIA>, 

pub fn new_bidi(
    spi: SPI,
    pins: (SCK, MISO, MOSI),
    mode: Mode,
    freq: impl Into<Hertz>,
    clocks: Clocks
) -> Self

pub fn to_normal_transfer_mode(
    self
) -> Spi<SPI, (SCK, MISO, MOSI), TransferModeNormal>

impl<SPI, SCK, MISO, MOSI, TRANSFER_MODE, const SCKA: u8, const MISOA: u8, const MOSIA: u8> Spi<SPI, (SCK, MISO, MOSI), TRANSFER_MODE> where
    SPI: Instance,
    SCK: PinSck<SPI, A = Const<SCKA>> + SetAlternate<SCKA>,
    MISO: PinMiso<SPI, A = Const<MISOA>> + SetAlternate<MISOA>,
    MOSI: PinMosi<SPI, A = Const<MOSIA>> + SetAlternate<MOSIA>, 

pub fn release(self) -> (SPI, (SCK, MISO, MOSI))

pub fn free(self) -> (SPI, (SCK, MISO, MOSI))

👎 Deprecated since 0.10.0:

Please use release instead

impl<SPI, PINS> Spi<SPI, PINS, TransferModeNormal> where
    SPI: Instance, 

pub fn init(self) -> Self

impl<SPI, PINS> Spi<SPI, PINS, TransferModeBidi> where
    SPI: Instance, 

pub fn init(self) -> Self

impl<SPI, PINS, TRANSFER_MODE> Spi<SPI, PINS, TRANSFER_MODE> where
    SPI: Instance, 

pub fn enable(&mut self, enable: bool)

Enable/disable spi

pub fn pre_init(self, mode: Mode, freq: Hertz, clock: Hertz) -> Self

Pre initializing the SPI bus.

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.

Trait Implementations

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

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

Formats the value using the given formatter.

impl<SPI, PINS> FullDuplex<u8> for Spi<SPI, PINS, TransferModeNormal> where
    SPI: Instance, 

type Error = Error

An enumeration of SPI errors

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

Reads the word stored in the shift register

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

Sends a word to the slave

impl<SPI, PINS> FullDuplex<u8> for Spi<SPI, PINS, TransferModeBidi> where
    SPI: Instance, 

type Error = Error

An enumeration of SPI errors

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

Reads the word stored in the shift register

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

Sends a word to the slave

impl<SPI, PINS, TRANSFER_MODE, W: 'static> Transactional<W> for Spi<SPI, PINS, TRANSFER_MODE> where
    Self: Write<W, Error = Error> + Transfer<W, Error = Error>, 

type Error = Error

Associated error type

fn exec<'a>(&mut self, operations: &mut [Operation<'a, W>]) -> Result<(), Error>

Execute the provided transactions

impl<SPI, PINS, TRANSFER_MODE> Transfer<u8> for Spi<SPI, PINS, TRANSFER_MODE> where
    Self: FullDuplex<u8, Error = Error>,
    SPI: Instance, 

type Error = Error

Error type

fn transfer<'w>(&mut self, words: &'w mut [u8]) -> Result<&'w [u8], Self::Error>

Sends words to the slave. Returns the words received from the slave

impl<SPI, PINS> Write<u8> for Spi<SPI, PINS, TransferModeNormal> where
    Self: FullDuplex<u8, Error = Error>,
    SPI: Instance, 

type Error = Error

Error type

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

Sends words to the slave, ignoring all the incoming words

impl<SPI, PINS> Write<u8> for Spi<SPI, PINS, TransferModeBidi> where
    Self: FullDuplex<u8, Error = Error>,
    SPI: Instance, 

type Error = Error

Error type

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

Sends words to the slave, ignoring all the incoming words

impl<SPI, PINS> WriteIter<u8> for Spi<SPI, PINS, TransferModeNormal> where
    Self: FullDuplex<u8, Error = Error>,
    SPI: Instance, 

type Error = Error

Error type

fn write_iter<WI>(&mut self, words: WI) -> Result<(), Self::Error> where
    WI: IntoIterator<Item = u8>, 

Sends words to the slave, ignoring all the incoming words

impl<SPI, PINS> WriteIter<u8> for Spi<SPI, PINS, TransferModeBidi> where
    Self: FullDuplex<u8, Error = Error>,
    SPI: Instance, 

type Error = Error

Error type

fn write_iter<WI>(&mut self, words: WI) -> Result<(), Self::Error> where
    WI: IntoIterator<Item = u8>, 

Sends words to the slave, ignoring all the incoming words