Enum Mode 

pub enum Mode {
    Mode0,
    Mode1,
    Mode2,
    Mode3,
}

An SPI clock mode: the (CPOL, CPHA) pair a controller and peripheral must share.

The mode number is (CPOL << 1) | CPHA, so the four modes are:

Mode	CPOL	CPHA	Clock idles	Data sampled on
0	0	0	low	leading edge (rising)
1	0	1	low	trailing edge (falling)
2	1	0	high	leading edge (falling)
3	1	1	high	trailing edge (rising)

Examples

use pamoja_gpio::spi::Mode;

// An SD card and most LoRa radios use mode 0.
assert_eq!(Mode::Mode0.number(), 0);
assert_eq!(Mode::Mode0.cpol_cpha(), (false, false));
assert_eq!(Mode::from_number(3), Some(Mode::Mode3));
assert_eq!(Mode::from_cpol_cpha(true, false), Mode::Mode2);

Variants

Mode0

CPOL 0, CPHA 0: clock idles low, data sampled on the rising (leading) edge.

Mode1

CPOL 0, CPHA 1: clock idles low, data sampled on the falling (trailing) edge.

Mode2

CPOL 1, CPHA 0: clock idles high, data sampled on the falling (leading) edge.

Mode3

CPOL 1, CPHA 1: clock idles high, data sampled on the rising (trailing) edge.

Implementations

impl Mode

pub fn number(self) -> u8

Returns the mode number, 0..=3, as datasheets quote it.

Returns

The number (CPOL << 1) | CPHA.

pub fn from_number(number: u8) -> Option<Mode>

Returns the mode a number names, if it is in range.

Arguments

• number - a mode number.

Returns

The matching Mode, or None if number is above 3.

pub fn cpol_cpha(self) -> (bool, bool)

Returns the (CPOL, CPHA) pair for this mode.

Returns

(clock idles high, data sampled on the trailing edge).

pub fn from_cpol_cpha(cpol: bool, cpha: bool) -> Mode

Returns the mode for a (CPOL, CPHA) pair.

Arguments

• cpol - clock polarity: true if the clock idles high.
• cpha - clock phase: true if data is sampled on the trailing edge.

Returns

The matching Mode. Every pair maps to a mode, so this never fails.

pub fn clock_idles_high(self) -> bool

Returns true if the clock idles high (CPOL = 1), which is modes 2 and 3.

pub fn samples_on_trailing_edge(self) -> bool

Returns true if data is sampled on the trailing clock edge (CPHA = 1), which is modes 1 and 3.

Trait Implementations

impl Clone for Mode

fn clone(&self) -> Mode

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Mode

impl Debug for Mode

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

Formats the value using the given formatter.

impl Eq for Mode

impl PartialEq for Mode

fn eq(&self, other: &Mode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Mode