Struct trellis_m4::sercom::SPIMaster1

pub struct SPIMaster1<MISO, MOSI, SCK> { /* fields omitted */ }

SPIMasterX represents the corresponding SERCOMX instance configured to act in the role of an SPI Master. Objects of this type implement the HAL FullDuplex and blocking SPI traits.

This type is generic over any valid pad mapping where there is a defined "data in pin out data out pin out" implementation.

Implementations

impl<MISO, MOSI, SCK> SPIMaster1<MISO, MOSI, SCK>

pub fn new<F, T>(
    clock: &Sercom1CoreClock,
    freq: F,
    mode: Mode,
    sercom: SERCOM1,
    mclk: &mut MCLK,
    padout: T
) -> SPIMaster1<MISO, MOSI, SCK> where
    F: Into<Hertz>,
    T: Into<SPIMaster1Padout<MISO, MOSI, SCK>>,
    SPIMaster1Padout<MISO, MOSI, SCK>: DipoDopo, 

Power on and configure SERCOMX to work as an SPI Master operating with the specified frequency and SPI Mode. The pinout specifies which pins are bound to the MISO, MOSI, SCK functions.

pub fn set_baud<F>(&mut self, freq: F, clock: &Sercom1CoreClock) where
    F: Into<Hertz>, 

Set the baud rate

pub fn free(self) -> (SPIMaster1Padout<MISO, MOSI, SCK>, SERCOM1)

Tear down the SPI instance and yield the constituent pins and SERCOM instance. No explicit de-initialization is performed.

Trait Implementations

impl<MISO, MOSI, SCK> CommonSpi for SPIMaster1<MISO, MOSI, SCK>

pub fn spi(&self) -> &SPIM

Helper for accessing the spi member of the sercom instance

pub fn spi_mut(&mut self) -> &SPIM

Helper for accessing the spi member of the sercom instance

pub fn disable(&mut self)

Disable the SPI

pub fn enable(&mut self)

Enable the SPI

pub fn set_mode(&mut self, mode: Mode)

Set the polarity (CPOL) and phase (CPHA) of the SPI

pub fn freq<F>(&self, src_clock_freq: Hertz) -> Hertz where
    F: Into<Hertz>, 

Method for calculating the output frequency given our baud settings.

pub fn calculate_baud<F>(freq: F, src_clock_freq: Hertz) -> u8 where
    F: Into<Hertz>, 

Helper for calculating our baudrate register

impl<MISO, MOSI, SCK> Default<u8> for SPIMaster1<MISO, MOSI, SCK>

impl<MISO, MOSI, SCK> Default<u8> for SPIMaster1<MISO, MOSI, SCK>

impl<MISO, MOSI, SCK> Default<u8> for SPIMaster1<MISO, MOSI, SCK>

impl<MISO, MOSI, SCK> FullDuplex<u8> for SPIMaster1<MISO, MOSI, SCK>

type Error = Error

An enumeration of SPI errors

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

Reads the word stored in the shift register

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

Sends a word to the slave