Struct serpente::sercom::v2::spi::Spi

impl<C, A> Spi<C, A>where C: ValidConfig, A: Capability,

pub fn reconfigure( &mut self, update: impl FnOnce(&mut Config<<C as AnyConfig>::Pads, <C as AnyConfig>::OpMode, <C as AnyConfig>::Size>) )

Update the SPI configuration.

Calling this method will temporarily disable the SERCOM peripheral, as some registers are enable-protected. This may interrupt any ongoing transactions.

pub fn enable_interrupts(&mut self, flags: Flags)

Enable interrupts for the specified flags

pub fn disable_interrupts(&mut self, flags: Flags)

Disable interrupts for the specified flags

pub fn read_flags(&self) -> Flags

Read the interrupt flags

pub fn clear_flags(&mut self, flags: Flags)

Clear the corresponding interrupt flags

Only the ERROR, SSL and TXC flags can be cleared.

Note: The implementation of of serial::Write::flush waits on and clears the TXC flag. Manually clearing this flag could cause it to hang indefinitely.

pub fn read_status(&self) -> Status

Read the error status flags

pub fn clear_status(&mut self, status: Status)

Clear the corresponding error status flags

pub fn read_flags_errors(&self) -> Result<Flags, Error>

Try to read the interrupt flags, but first check the error status flags.

pub unsafe fn read_data(&mut self) -> u16

Read from the DATA register

Reading from the data register directly is unsafe, because it will clear the RXC flag, which could break assumptions made elsewhere in this module.

pub unsafe fn write_data(&mut self, data: u16)

Write to the DATA register

Writing to the data register directly is unsafe, because it will clear the DRE flag, which could break assumptions made elsewhere in this module.

pub fn disable(self) -> C

Disable the SPI peripheral and return the Config struct

Trait Implementations§

fn as_mut(&mut self) -> &mut Spi<C, A>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<C, A> AsRef<Config<<C as AnyConfig>::Pads, <C as AnyConfig>::OpMode, <C as AnyConfig>::Size>> for Spi<C, A>where C: ValidConfig, A: Capability,

Get a shared reference to the underlying Config struct

This can be used to call the various get_* functions on Config

fn as_ref( &self ) -> &Config<<C as AnyConfig>::Pads, <C as AnyConfig>::OpMode, <C as AnyConfig>::Size>

Converts this type into a shared reference of the (usually inferred) input type.

impl<C, A> AsRef<Spi<C, A>> for Spi<C, A>where C: ValidConfig, A: Capability,

fn as_ref(&self) -> &Spi<C, A>

Converts this type into a shared reference of the (usually inferred) input type.

impl<C> FullDuplex<<C as AnyConfig>::Word> for Spi<C, Duplex>where C: ValidConfig, <C as AnyConfig>::Word: PrimInt + AsPrimitive<u16>, u16: AsPrimitive<<C as AnyConfig>::Word>,

Implement spi::FullDuplex for Spi structs with AtomicSize

spi::FullDuplex is only implemented when the Spi struct has Duplex Capability. The Word size used in the implementation depends on the corresponding CharSize.

fn read(&mut self) -> Result<<C as AnyConfig>::Word, Error<Error>>

Reads the word stored in the shift register Read more

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

Sends a word to the slave

impl<P, M, C> Read<<C as CharSize>::Word> for Spi<Config<P, M, C>, Rx>where Config<P, M, C>: ValidConfig, P: ValidPads, M: MasterMode, C: CharSize, <C as CharSize>::Word: PrimInt, u16: AsPrimitive<<C as CharSize>::Word>,

Implement serial::Read for Rx Spi structs in a MasterMode

serial::Read is only implemented for Spi structs with Rx Capability. In a MasterMode, Read has to initiate transactions, so it keeps track of the transaction state. If a transaction is in progress, it will wait on RXC. If not, it will wait on DRE, and then send 0.

type Error = Error

Read error

fn read(&mut self) -> Result<<C as CharSize>::Word, Error<Error>>

Reads a single word from the serial interface

impl<P, C> Read<<C as CharSize>::Word> for Spi<Config<P, Slave, C>, Rx>where Config<P, Slave, C>: ValidConfig, P: ValidPads, C: CharSize, <C as CharSize>::Word: PrimInt, u16: AsPrimitive<<C as CharSize>::Word>,

Implement serial::Read for Rx Spi structs in Slave OpMode

serial::Read is only implemented for Spi structs with Rx Capability. In Slave OpMode, Read does not have to initiate transactions, so it does not have to store any internal state. It only has to wait on RXC.

fn read(&mut self) -> Result<<C as CharSize>::Word, Error<Error>>

Wait for an RXC flag, then read the word

type Error = Error

Read error

impl<P, M, A> Transfer<<EightBit as CharSize>::Word> for Spi<Config<P, M, EightBit>, A>where Config<P, M, EightBit>: ValidConfig, P: ValidPads, M: OpMode, A: Receive,

Implement Transfer for Spi structs that can Receive

The transfer accepts a slice of primitive integers, depending on the CharSize (u8 or u16).

type Error = Error

Error type

fn transfer<'w>( &mut self, words: &'w mut [<EightBit as CharSize>::Word] ) -> Result<&'w [<EightBit as CharSize>::Word], Error>

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

impl<P, M, A> Transfer<<NineBit as CharSize>::Word> for Spi<Config<P, M, NineBit>, A>where Config<P, M, NineBit>: ValidConfig, P: ValidPads, M: OpMode, A: Receive,

Implement Transfer for Spi structs that can Receive

The transfer accepts a slice of primitive integers, depending on the CharSize (u8 or u16).

type Error = Error

Error type

fn transfer<'w>( &mut self, words: &'w mut [<NineBit as CharSize>::Word] ) -> Result<&'w [<NineBit as CharSize>::Word], Error>

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

impl<C> Write<<C as AnyConfig>::Word> for Spi<C, Tx>where C: ValidConfig, <C as AnyConfig>::Word: PrimInt + AsPrimitive<u16>,

Implement serial::Write for Tx Spi structs

serial::Write is only implemented for Spi structs with Tx Capability. Because the Capability is Tx, this implementation never reads the DATA register and ignores all buffer overflow errors.