Struct Spi

pub struct Spi<SPI, Pins, Word = u8> { /* private fields */ }

SPI peripheral operating in full duplex master mode

Implementations

impl<SPI, Sck, Miso, Mosi, WORD> Spi<SPI, (Sck, Miso, Mosi), WORD>

pub fn new<Config>( spi: SPI, pins: (Sck, Miso, Mosi), config: Config, clocks: Clocks, apb: &mut <SPI as RccBus>::Bus, ) -> Self

where SPI: Instance, Sck: SckPin<SPI>, Miso: MisoPin<SPI>, Mosi: MosiPin<SPI>, WORD: Word, Config: Into<Config>,

Configures the SPI peripheral to operate in full duplex master mode.

The most convinient way to get a device is like that:

use stm32f3xx_hal::prelude::*;
use stm32f3xx_hal::spi::Spi;

// ...

let spi = Spi::new(dp.SPI1, (sck_pin, mosi_pin, miso_pin), 1.MHz, clocks, &mut dp.abp1);

To get a better example, look here.

pub unsafe fn peripheral(&mut self) -> &mut SPI

Get access to the underlying register block.

Safety

This function is not memory unsafe per se, but does not guarantee anything about assumptions of invariants made in this implementation.

Changing specific options can lead to un-expected behavior and nothing is guaranteed.

pub fn free(self) -> (SPI, (Sck, Miso, Mosi))

Releases the SPI peripheral and associated pins

impl<SPI, Pins, Word> Spi<SPI, Pins, Word>

where SPI: Instance,

pub fn reclock(&mut self, freq: impl Into<Generic<u32>>, clocks: Clocks)

Change the baud rate of the SPI

pub fn interrupt(&self) -> <SPI as InterruptNumber>::Interrupt

Obtain the associated interrupt number for the serial peripheral.

Used to unmask / enable the interrupt with cortex_m::peripheral::NVIC::unmask(). This is useful for all cortex_m::peripheral::INTERRUPT functions.

Trait Implementations

impl<Pins> Debug for Spi<SPI1, Pins>

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

Formats the value using the given formatter.

impl<Pins> Debug for Spi<SPI2, Pins>

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

Formats the value using the given formatter.

impl<Pins> Debug for Spi<SPI3, Pins>

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

Formats the value using the given formatter.

impl<SPI, Sck, Miso, Mosi, Word> FullDuplex<Word> for Spi<SPI, (Sck, Miso, Mosi), Word>

where SPI: Instance, Miso: MisoPin<SPI>, Mosi: MosiPin<SPI>, Word: PrimInt + Into<u32> + 'static, u32: AsPrimitive<Word>,

type Error = Error

An enumeration of SPI errors

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

Reads the word stored in the shift register

fn send(&mut self, word: Word) -> Result<(), Error>

Sends a word to the slave

impl<SPI, Sck, Miso, Mosi, Word> Default<Word> for Spi<SPI, (Sck, Miso, Mosi), Word>

where SPI: Instance, Miso: MisoPin<SPI>, Mosi: MosiPin<SPI>, Word: PrimInt + Into<u32> + 'static, u32: AsPrimitive<Word>,

impl<SPI, Sck, Miso, Mosi, Word> Default<Word> for Spi<SPI, (Sck, Miso, Mosi), Word>

where SPI: Instance, Miso: MisoPin<SPI>, Mosi: MosiPin<SPI>, Word: PrimInt + Into<u32> + 'static, u32: AsPrimitive<Word>,