Enum w5500_ll::Sn

#[repr(u8)]
pub enum Sn {
    Sn0,
    Sn1,
    Sn2,
    Sn3,
    Sn4,
    Sn5,
    Sn6,
    Sn7,
}

W5500 socket numbers.

Variants

Sn0

Socket 0.

This is the only socket that can be used in the Macraw mode.

Sn1

Socket 1.

Sn2

Socket 2.

Sn3

Socket 3.

Sn4

Socket 4.

Sn5

Socket 5.

Sn6

Socket 6.

Sn7

Socket 7.

Implementations

impl Sn

pub const fn block(self) -> u8

Get the socket register block select bits.

Example

use w5500_ll::Sn;

assert_eq!(Sn::Sn0.block(), 0b00001);
assert_eq!(Sn::Sn1.block(), 0b00101);
assert_eq!(Sn::Sn2.block(), 0b01001);
assert_eq!(Sn::Sn3.block(), 0b01101);
assert_eq!(Sn::Sn4.block(), 0b10001);
assert_eq!(Sn::Sn5.block(), 0b10101);
assert_eq!(Sn::Sn6.block(), 0b11001);
assert_eq!(Sn::Sn7.block(), 0b11101);

pub const fn tx_block(self) -> u8

Get the socket TX buffer block select bits.

Example

use w5500_ll::Sn;

assert_eq!(Sn::Sn0.tx_block(), 0b00010);
assert_eq!(Sn::Sn1.tx_block(), 0b00110);
assert_eq!(Sn::Sn2.tx_block(), 0b01010);
assert_eq!(Sn::Sn3.tx_block(), 0b01110);
assert_eq!(Sn::Sn4.tx_block(), 0b10010);
assert_eq!(Sn::Sn5.tx_block(), 0b10110);
assert_eq!(Sn::Sn6.tx_block(), 0b11010);
assert_eq!(Sn::Sn7.tx_block(), 0b11110);

pub const fn rx_block(self) -> u8

Get the socket RX buffer block select bits.

Example

use w5500_ll::Sn;

assert_eq!(Sn::Sn0.rx_block(), 0b00011);
assert_eq!(Sn::Sn1.rx_block(), 0b00111);
assert_eq!(Sn::Sn2.rx_block(), 0b01011);
assert_eq!(Sn::Sn3.rx_block(), 0b01111);
assert_eq!(Sn::Sn4.rx_block(), 0b10011);
assert_eq!(Sn::Sn5.rx_block(), 0b10111);
assert_eq!(Sn::Sn6.rx_block(), 0b11011);
assert_eq!(Sn::Sn7.rx_block(), 0b11111);

pub const fn bitmask(self) -> u8

Socket bitmask.

This is useful for masking socket interrupts with set_simr.

Examples

Demonstration:

use w5500_ll::Sn;

assert_eq!(Sn::Sn0.bitmask(), 0x01);
assert_eq!(Sn::Sn1.bitmask(), 0x02);
assert_eq!(Sn::Sn2.bitmask(), 0x04);
assert_eq!(Sn::Sn3.bitmask(), 0x08);
assert_eq!(Sn::Sn4.bitmask(), 0x10);
assert_eq!(Sn::Sn5.bitmask(), 0x20);
assert_eq!(Sn::Sn6.bitmask(), 0x40);
assert_eq!(Sn::Sn7.bitmask(), 0x80);

As an argument of set_simr:

use w5500_ll::{
    blocking::vdm::W5500,
    Registers,
    Sn::{Sn1, Sn3},
};

let mut w5500 = W5500::new(spi, pin);
// enable socket 1 and socket 3 interrupts
const SOCKET_INTERRUPT_MASK: u8 = Sn1.bitmask() | Sn3.bitmask();
w5500.set_simr(SOCKET_INTERRUPT_MASK)?;

Trait Implementations

impl Clone for Sn

fn clone(&self) -> Sn

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sn

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

Formats the value using the given formatter.

impl Format for Sn

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl From<Sn> for u8

fn from(s: Sn) -> Self

Performs the conversion.

impl From<Sn> for usize

fn from(s: Sn) -> Self

Performs the conversion.

impl Hash for Sn

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Sn

fn cmp(&self, other: &Sn) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Sn> for Sn

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Sn> for Sn

fn partial_cmp(&self, other: &Sn) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<u8> for Sn

type Error = u8

The type returned in the event of a conversion error.

fn try_from(val: u8) -> Result<Sn, u8>

Performs the conversion.

impl Copy for Sn

impl Eq for Sn

impl StructuralEq for Sn

impl StructuralPartialEq for Sn