Struct sodaq_one::sercom::SPIMaster1

source · [−]

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

👎 Deprecated since 0.13.0:

The sercom::v1::spi module is deprecated, and will be removed in a subsequent release. Please use the sercom::v2::spi module instead.

Expand description

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,
    pm: &mut PM,
    padout: T
) -> SPIMaster1<MISO, MOSI, SCK> where
    F: Into<Hertz>,
    T: Into<Padout<SERCOM1, MISO, MOSI, SCK>>,
    Padout<SERCOM1, MISO, MOSI, SCK>: DipoDopo,

👎 Deprecated since 0.13.0:

The sercom::v1::spi module is deprecated, and will be removed in a subsequent release. Please use the sercom::v2::spi module instead.

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

You can use a tuple of three SercomXPadY instances for which there exists a From implementation for SPIMasterXPadout.

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

👎 Deprecated since 0.13.0:

The sercom::v1::spi module is deprecated, and will be removed in a subsequent release. Please use the sercom::v2::spi module instead.

Set the baud rate

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

👎 Deprecated since 0.13.0:

The sercom::v1::spi module is deprecated, and will be removed in a subsequent release. Please use the sercom::v2::spi module instead.

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) -> &SPI

👎 Deprecated since 0.13.0:

The spi_common module is deprecated, and will be removed in a subsequent release. Please use the sercom::v2::spi::AnySpi trait instead.

Helper for accessing the spi member of the sercom instance

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

👎 Deprecated since 0.13.0:

The spi_common module is deprecated, and will be removed in a subsequent release. Please use the sercom::v2::spi::AnySpi trait instead.

Helper for accessing the spi member of the sercom instance

fn disable(&mut self)

👎 Deprecated since 0.13.0:

The spi_common module is deprecated, and will be removed in a subsequent release. Please use the sercom::v2::spi::AnySpi trait instead.

Disable the SPI

fn enable(&mut self)

👎 Deprecated since 0.13.0:

The spi_common module is deprecated, and will be removed in a subsequent release. Please use the sercom::v2::spi::AnySpi trait instead.

Enable the SPI

fn set_mode(&mut self, mode: Mode)

👎 Deprecated since 0.13.0:

The spi_common module is deprecated, and will be removed in a subsequent release. Please use the sercom::v2::spi::AnySpi trait instead.

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

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

👎 Deprecated since 0.13.0:

The spi_common module is deprecated, and will be removed in a subsequent release. Please use the sercom::v2::spi::AnySpi trait instead.

Method for calculating the output frequency given our baud settings. Read more

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

👎 Deprecated since 0.13.0:

The spi_common module is deprecated, and will be removed in a subsequent release. Please use the sercom::v2::spi::AnySpi trait instead.

Helper for calculating our baudrate register Read more

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 Read more

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

Sends a word to the slave

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

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

Auto Trait Implementations

impl<MISO, MOSI, SCK> RefUnwindSafe for SPIMaster1<MISO, MOSI, SCK> where
    MISO: RefUnwindSafe,
    MOSI: RefUnwindSafe,
    SCK: RefUnwindSafe,

impl<MISO, MOSI, SCK> Send for SPIMaster1<MISO, MOSI, SCK> where
    MISO: Send,
    MOSI: Send,
    SCK: Send,

impl<MISO, MOSI, SCK> !Sync for SPIMaster1<MISO, MOSI, SCK>

impl<MISO, MOSI, SCK> Unpin for SPIMaster1<MISO, MOSI, SCK> where
    MISO: Unpin,
    MOSI: Unpin,
    SCK: Unpin,

impl<MISO, MOSI, SCK> UnwindSafe for SPIMaster1<MISO, MOSI, SCK> where
    MISO: UnwindSafe,
    MOSI: UnwindSafe,
    SCK: UnwindSafe,

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

pub fn from(t: T) -> T

Performs the conversion.

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

pub fn into(self) -> U

Performs the conversion.

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

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

Error type

pub 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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

Error type

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

Sends words to the slave, ignoring all the incoming words