Struct atmega_hal::spi::ChipSelectPin

pub struct ChipSelectPin<CSPIN>(/* private fields */);

Wrapper for the CS pin

Used to contain the chip-select pin during operation to prevent its mode from being changed from Output. This is necessary because the SPI state machine would otherwise reset itself to SPI slave mode immediately. This wrapper can be used just like an output pin, because it implements all the same traits from embedded-hal.

Implementations

impl<CSPIN> ChipSelectPin<CSPIN>

where CSPIN: PinOps,

pub unsafe fn into_pin_unchecked(self) -> Pin<Output, CSPIN>

Convert this ChipSelectPin into the underlying “real” Pin<> object.

Safety

This function is unsafe because the underlying pin can be converted into a non-output mode which would break SPI functionality. The user must ensure the pin is only used in output modes after calling this function.

pub unsafe fn from_pin(pin: Pin<Output, CSPIN>) -> ChipSelectPin<CSPIN>

(Re)create a ChipSelectPin from a real Pin<> object.

This function is only meant to be used when the pin was previously moved out of the ChipSelectPin using ChipSelectPin::into_pin_unchecked().

Trait Implementations

impl<CSPIN> ErrorType for ChipSelectPin<CSPIN>

where CSPIN: PinOps,

type Error = Infallible

Error type

impl<CSPIN> OutputPin for ChipSelectPin<CSPIN>

where CSPIN: PinOps,

fn set_high(&mut self) -> Result<(), <ChipSelectPin<CSPIN> as ErrorType>::Error>

Drives the pin high.

fn set_low(&mut self) -> Result<(), <ChipSelectPin<CSPIN> as ErrorType>::Error>

Drives the pin low.

fn set_state(&mut self, state: PinState) -> Result<(), Self::Error>

Drives the pin high or low depending on the provided value.

impl<CSPIN> OutputPin for ChipSelectPin<CSPIN>

where CSPIN: PinOps,

type Error = Infallible

Error type

fn set_low(&mut self) -> Result<(), <ChipSelectPin<CSPIN> as OutputPin>::Error>

Drives the pin low

fn set_high(&mut self) -> Result<(), <ChipSelectPin<CSPIN> as OutputPin>::Error>

Drives the pin high

fn set_state(&mut self, state: PinState) -> Result<(), Self::Error>

Drives the pin high or low depending on the provided value

impl<CSPIN> StatefulOutputPin for ChipSelectPin<CSPIN>

where CSPIN: PinOps,

fn is_set_low(&self) -> Result<bool, <ChipSelectPin<CSPIN> as OutputPin>::Error>

Is the pin in drive low mode?

fn is_set_high( &self ) -> Result<bool, <ChipSelectPin<CSPIN> as OutputPin>::Error>

Is the pin in drive high mode?

impl<CSPIN> StatefulOutputPin for ChipSelectPin<CSPIN>

where CSPIN: PinOps,

fn is_set_high( &mut self ) -> Result<bool, <ChipSelectPin<CSPIN> as ErrorType>::Error>

Is the pin in drive high mode?

fn is_set_low( &mut self ) -> Result<bool, <ChipSelectPin<CSPIN> as ErrorType>::Error>

Is the pin in drive low mode?

fn toggle(&mut self) -> Result<(), Self::Error>

Toggle pin output.

impl<CSPIN> ToggleableOutputPin for ChipSelectPin<CSPIN>

where CSPIN: PinOps,

type Error = Infallible

Error type

fn toggle( &mut self ) -> Result<(), <ChipSelectPin<CSPIN> as ToggleableOutputPin>::Error>

Toggle pin output.