Struct stm32l4xx_hal::spi::Spi

source · [−]

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

Expand description

SPI peripheral operating in full duplex master mode

Implementations

source

impl<SCK, MISO, MOSI> Spi<SPI1, (SCK, MISO, MOSI)>

source

pub fn spi1(
 spi: SPI1,
 pins: (SCK, MISO, MOSI),
 mode: Mode,
 freq: Hertz,
 clocks: Clocks,
 apb2: &mut <SPI1 as RccBus>::Bus
) -> Self where
 SCK: SckPin<SPI1>,
 MISO: MisoPin<SPI1>,
 MOSI: MosiPin<SPI1>,

Configures the SPI peripheral to operate in full duplex master mode

source

pub fn spi1_slave(
 spi: SPI1,
 pins: (SCK, MISO, MOSI),
 mode: Mode,
 apb2: &mut <SPI1 as RccBus>::Bus
) -> Self where
 SCK: SckPin<SPI1>,
 MISO: MisoPin<SPI1>,
 MOSI: MosiPin<SPI1>,

source

pub fn clear_overrun(&mut self)

source

pub fn reclock(&mut self, freq: Hertz, clocks: Clocks)

Change the baud rate of the SPI

source

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

Releases the SPI peripheral and associated pins

source

impl<SCK, MISO, MOSI> Spi<SPI3, (SCK, MISO, MOSI)>

source

pub fn spi3(
 spi: SPI3,
 pins: (SCK, MISO, MOSI),
 mode: Mode,
 freq: Hertz,
 clocks: Clocks,
 apb2: &mut <SPI3 as RccBus>::Bus
) -> Self where
 SCK: SckPin<SPI3>,
 MISO: MisoPin<SPI3>,
 MOSI: MosiPin<SPI3>,

Configures the SPI peripheral to operate in full duplex master mode

source

pub fn spi3_slave(
 spi: SPI3,
 pins: (SCK, MISO, MOSI),
 mode: Mode,
 apb2: &mut <SPI3 as RccBus>::Bus
) -> Self where
 SCK: SckPin<SPI3>,
 MISO: MisoPin<SPI3>,
 MOSI: MosiPin<SPI3>,

source

pub fn clear_overrun(&mut self)

source

pub fn reclock(&mut self, freq: Hertz, clocks: Clocks)

Change the baud rate of the SPI

source

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

Releases the SPI peripheral and associated pins

source

impl<SCK, MISO, MOSI> Spi<SPI2, (SCK, MISO, MOSI)>

source

pub fn spi2(
 spi: SPI2,
 pins: (SCK, MISO, MOSI),
 mode: Mode,
 freq: Hertz,
 clocks: Clocks,
 apb2: &mut <SPI2 as RccBus>::Bus
) -> Self where
 SCK: SckPin<SPI2>,
 MISO: MisoPin<SPI2>,
 MOSI: MosiPin<SPI2>,

Configures the SPI peripheral to operate in full duplex master mode

source

pub fn spi2_slave(
 spi: SPI2,
 pins: (SCK, MISO, MOSI),
 mode: Mode,
 apb2: &mut <SPI2 as RccBus>::Bus
) -> Self where
 SCK: SckPin<SPI2>,
 MISO: MisoPin<SPI2>,
 MOSI: MosiPin<SPI2>,

source

pub fn clear_overrun(&mut self)

source

pub fn reclock(&mut self, freq: Hertz, clocks: Clocks)

Change the baud rate of the SPI

source

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

Releases the SPI peripheral and associated pins

source

pub fn with_rxtx_dma(
 self,
 rx_channel: C2,
 tx_channel: C3
) -> SpiRxTxDma<SPI1, PINS, C2, C3>

source

impl<PINS> Spi<SPI3, PINS>

source

pub fn with_rx_dma(self, channel: C1) -> SpiRxDma<SPI3, PINS, C1>

source

pub fn with_tx_dma(self, channel: C2) -> SpiTxDma<SPI3, PINS, C2>

source

pub fn with_rxtx_dma(
 self,
 rx_channel: C1,
 tx_channel: C2
) -> SpiRxTxDma<SPI3, PINS, C1, C2>

Trait Implementations

source

impl<PINS> FullDuplex<u8> for Spi<SPI1, PINS>

type Error = Error

An enumeration of SPI errors

source

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

Reads the word stored in the shift register Read more

source

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

Sends a word to the slave

source

impl<PINS> FullDuplex<u8> for Spi<SPI3, PINS>

type Error = Error

An enumeration of SPI errors

source

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

Reads the word stored in the shift register Read more

source

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

Sends a word to the slave

source

impl<PINS> FullDuplex<u8> for Spi<SPI2, PINS>

type Error = Error

An enumeration of SPI errors

source

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

Reads the word stored in the shift register Read more

source

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

Sends a word to the slave

source

impl<PINS> Default<u8> for Spi<SPI1, PINS>

source

impl<PINS> Default<u8> for Spi<SPI1, PINS>

source

impl<PINS> Default<u8> for Spi<SPI3, PINS>

source

impl<PINS> Default<u8> for Spi<SPI3, PINS>

source

impl<PINS> Default<u8> for Spi<SPI2, PINS>

source

impl<PINS> Default<u8> for Spi<SPI2, PINS>

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<W, S> Transfer<W> for S where
S: Default<W>,
W: Clone,

type Error = <S as FullDuplex<W>>::Error

Error type

source

fn transfer(
&mut self,
words: &'w mut [W]
) -> Result<&'w [W], <S as FullDuplex<W>>::Error>

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

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<W, S> Write<W> for S where
S: Default<W>,
W: Clone,

type Error = <S as FullDuplex<W>>::Error

Error type

source

fn write(&mut self, words: &[W]) -> Result<(), <S as FullDuplex<W>>::Error>

Sends words to the slave, ignoring all the incoming words

Struct stm32l4xx_hal::spi::Spi

Implementations

impl<SCK, MISO, MOSI> Spi<SPI1, (SCK, MISO, MOSI)>

pub fn spi1( spi: SPI1, pins: (SCK, MISO, MOSI), mode: Mode, freq: Hertz, clocks: Clocks, apb2: &mut <SPI1 as RccBus>::Bus) -> Self where SCK: SckPin<SPI1>, MISO: MisoPin<SPI1>, MOSI: MosiPin<SPI1>,

pub fn spi1_slave( spi: SPI1, pins: (SCK, MISO, MOSI), mode: Mode, apb2: &mut <SPI1 as RccBus>::Bus) -> Self where SCK: SckPin<SPI1>, MISO: MisoPin<SPI1>, MOSI: MosiPin<SPI1>,

pub fn clear_overrun(&mut self)

pub fn reclock(&mut self, freq: Hertz, clocks: Clocks)

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

impl<SCK, MISO, MOSI> Spi<SPI3, (SCK, MISO, MOSI)>

pub fn spi3( spi: SPI3, pins: (SCK, MISO, MOSI), mode: Mode, freq: Hertz, clocks: Clocks, apb2: &mut <SPI3 as RccBus>::Bus) -> Self where SCK: SckPin<SPI3>, MISO: MisoPin<SPI3>, MOSI: MosiPin<SPI3>,

pub fn spi3_slave( spi: SPI3, pins: (SCK, MISO, MOSI), mode: Mode, apb2: &mut <SPI3 as RccBus>::Bus) -> Self where SCK: SckPin<SPI3>, MISO: MisoPin<SPI3>, MOSI: MosiPin<SPI3>,

pub fn clear_overrun(&mut self)

pub fn reclock(&mut self, freq: Hertz, clocks: Clocks)

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

impl<SCK, MISO, MOSI> Spi<SPI2, (SCK, MISO, MOSI)>

pub fn spi2( spi: SPI2, pins: (SCK, MISO, MOSI), mode: Mode, freq: Hertz, clocks: Clocks, apb2: &mut <SPI2 as RccBus>::Bus) -> Self where SCK: SckPin<SPI2>, MISO: MisoPin<SPI2>, MOSI: MosiPin<SPI2>,

pub fn spi2_slave( spi: SPI2, pins: (SCK, MISO, MOSI), mode: Mode, apb2: &mut <SPI2 as RccBus>::Bus) -> Self where SCK: SckPin<SPI2>, MISO: MisoPin<SPI2>, MOSI: MosiPin<SPI2>,

pub fn clear_overrun(&mut self)

pub fn reclock(&mut self, freq: Hertz, clocks: Clocks)

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

impl<PINS> Spi<SPI1, PINS>

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

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

pub fn with_rxtx_dma( self, rx_channel: C2, tx_channel: C3) -> SpiRxTxDma<SPI1, PINS, C2, C3>

impl<PINS> Spi<SPI3, PINS>

pub fn with_rx_dma(self, channel: C1) -> SpiRxDma<SPI3, PINS, C1>

pub fn with_tx_dma(self, channel: C2) -> SpiTxDma<SPI3, PINS, C2>

pub fn with_rxtx_dma( self, rx_channel: C1, tx_channel: C2) -> SpiRxTxDma<SPI3, PINS, C1, C2>

Trait Implementations

impl<PINS> FullDuplex<u8> for Spi<SPI1, PINS>

type Error = Error

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

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

impl<PINS> FullDuplex<u8> for Spi<SPI3, PINS>

type Error = Error

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

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

impl<PINS> FullDuplex<u8> for Spi<SPI2, PINS>

type Error = Error

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

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

impl<PINS> Default<u8> for Spi<SPI1, PINS>

impl<PINS> Default<u8> for Spi<SPI1, PINS>

impl<PINS> Default<u8> for Spi<SPI3, PINS>

impl<PINS> Default<u8> for Spi<SPI3, PINS>

impl<PINS> Default<u8> for Spi<SPI2, PINS>

impl<PINS> Default<u8> for Spi<SPI2, PINS>

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<W, S> Transfer<W> for S where S: Default<W>, W: Clone,

type Error = <S as FullDuplex<W>>::Error

fn transfer( &mut self, words: &'w mut [W]) -> Result<&'w [W], <S as FullDuplex<W>>::Error>

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<W, S> Write<W> for S where S: Default<W>, W: Clone,

type Error = <S as FullDuplex<W>>::Error

fn write(&mut self, words: &[W]) -> Result<(), <S as FullDuplex<W>>::Error>

pub fn spi1(
spi: SPI1,
pins: (SCK, MISO, MOSI),
mode: Mode,
freq: Hertz,
clocks: Clocks,
apb2: &mut <SPI1 as RccBus>::Bus
) -> Self where
SCK: SckPin<SPI1>,
MISO: MisoPin<SPI1>,
MOSI: MosiPin<SPI1>,

pub fn spi1_slave(
spi: SPI1,
pins: (SCK, MISO, MOSI),
mode: Mode,
apb2: &mut <SPI1 as RccBus>::Bus
) -> Self where
SCK: SckPin<SPI1>,
MISO: MisoPin<SPI1>,
MOSI: MosiPin<SPI1>,

pub fn spi3(
spi: SPI3,
pins: (SCK, MISO, MOSI),
mode: Mode,
freq: Hertz,
clocks: Clocks,
apb2: &mut <SPI3 as RccBus>::Bus
) -> Self where
SCK: SckPin<SPI3>,
MISO: MisoPin<SPI3>,
MOSI: MosiPin<SPI3>,

pub fn spi3_slave(
spi: SPI3,
pins: (SCK, MISO, MOSI),
mode: Mode,
apb2: &mut <SPI3 as RccBus>::Bus
) -> Self where
SCK: SckPin<SPI3>,
MISO: MisoPin<SPI3>,
MOSI: MosiPin<SPI3>,

pub fn spi2(
spi: SPI2,
pins: (SCK, MISO, MOSI),
mode: Mode,
freq: Hertz,
clocks: Clocks,
apb2: &mut <SPI2 as RccBus>::Bus
) -> Self where
SCK: SckPin<SPI2>,
MISO: MisoPin<SPI2>,
MOSI: MosiPin<SPI2>,

pub fn spi2_slave(
spi: SPI2,
pins: (SCK, MISO, MOSI),
mode: Mode,
apb2: &mut <SPI2 as RccBus>::Bus
) -> Self where
SCK: SckPin<SPI2>,
MISO: MisoPin<SPI2>,
MOSI: MosiPin<SPI2>,

pub fn with_rxtx_dma(
self,
rx_channel: C2,
tx_channel: C3
) -> SpiRxTxDma<SPI1, PINS, C2, C3>

pub fn with_rxtx_dma(
self,
rx_channel: C1,
tx_channel: C2
) -> SpiRxTxDma<SPI3, PINS, C1, C2>

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

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

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<W, S> Transfer<W> for S where
S: Default<W>,
W: Clone,

fn transfer(
&mut self,
words: &'w mut [W]
) -> Result<&'w [W], <S as FullDuplex<W>>::Error>

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<W, S> Write<W> for S where
S: Default<W>,
W: Clone,