Struct w5500_ll::SocketMode

pub struct SocketMode(_);

Socket Mode Register (Sn_MR).

This is used by the Registers::sn_mr and Registers::set_sn_mr methods.

Implementations

impl SocketMode

pub const RESET: u8

Reset value of the socket mode register.

pub const DEFAULT: Self

Default value.

This is the same as default, but as a const value.

Example

use w5500_ll::SocketMode;

assert_eq!(SocketMode::DEFAULT, SocketMode::default());

pub const MULTI_OFFSET: u8

Bit offset for the MULTI field.

pub const MFEN_OFFSET: u8

Bit offset for the MFEN field.

pub const BCASTB_OFFSET: u8

Bit offset for the BCASTB field.

pub const ND_OFFSET: u8

Bit offset for the ND field.

pub const MC_OFFSET: u8

Bit offset for the MC field.

pub const MMB_OFFSET: u8

Bit offset for the MMB field.

pub const UCASTB_OFFSET: u8

Bit offset for the UCASTB field.

pub const MIP6B_OFFSET: u8

Bit offset for the MIP6B field.

pub const MULTI_MASK: u8

Bit mask for the MULTI field.

pub const MFEN_MASK: u8

Bit mask for the MFEN field.

pub const BCASTB_MASK: u8

Bit mask for the BCASTB field.

pub const ND_MASK: u8

Bit mask for the ND field.

pub const MC_MASK: u8

Bit mask for the MC field.

pub const MMB_MASK: u8

Bit mask for the MMB field.

pub const UCASTB_MASK: u8

Bit mask for the UCASTB field.

pub const MIP6B_MASK: u8

Bit mask for the MIP6B field.

pub const PROTOCOL_MASK: u8

Bit mask for the PROTOCOL field.

pub const fn protocol(&self) -> Result<Protocol, u8>

Get the protocol.

This returns an Err(u8) with the protocol bits if the protocol bits do not match a valid protocol.

Example

use w5500_ll::{Protocol, SocketMode};

let sn_mr: SocketMode = SocketMode::DEFAULT;
assert_eq!(sn_mr.protocol(), Ok(Protocol::Closed));

pub const fn set_protocol(self, protocol: Protocol) -> Self

Set the protocol.

Example

use w5500_ll::{Protocol, SocketMode};

const SN_MR: SocketMode = SocketMode::DEFAULT.set_protocol(Protocol::Tcp);
assert_eq!(SN_MR.protocol(), Ok(Protocol::Tcp));

pub const fn multi_enabled(&self) -> bool

Multicasting.

This applies only for a socket with the UDP protocol.

To use multicasting Registers::sn_dipr and Registers::sn_dport should be configured with the multicast group IP and port number before the socket is opened.

Example

use w5500_ll::SocketMode;

let sn_mr: SocketMode = SocketMode::DEFAULT;
assert!(!sn_mr.multi_enabled());
let sn_mr: SocketMode = sn_mr.enable_multi();
assert!(sn_mr.multi_enabled());
let sn_mr: SocketMode = sn_mr.disable_multi();
assert!(!sn_mr.multi_enabled());

pub const fn enable_multi(self) -> Self

Enable multicasting.

pub const fn disable_multi(self) -> Self

Disable multicasting.

pub const fn mfen_enabled(&self) -> bool

MAC filter.

This applies only for a socket with the MACRAW protocol.

When enabled the W5500 can only receive broadcasting packets sent to itself. When disabled the W5500 can receive all packets. If you want to implement a hybrid TCP/IP stack it is recommended that this is enabled for reducing host overhead to process all the received packets.

Example

use w5500_ll::SocketMode;

let sn_mr: SocketMode = SocketMode::DEFAULT;
assert!(!sn_mr.mfen_enabled());
let sn_mr: SocketMode = sn_mr.enable_mfen();
assert!(sn_mr.mfen_enabled());
let sn_mr: SocketMode = sn_mr.disable_mfen();
assert!(!sn_mr.mfen_enabled());

pub const fn enable_mfen(self) -> Self

Enable MAC filter.

pub const fn disable_mfen(self) -> Self

Disable MAC filter.

pub const fn bcastb_enabled(&self) -> bool

Broadcast blocking.

This applies only for a socket with the MACRAW or UDP protocol.

Example

use w5500_ll::SocketMode;

let sn_mr: SocketMode = SocketMode::DEFAULT;
assert!(!sn_mr.bcastb_enabled());
let sn_mr: SocketMode = sn_mr.enable_bcastb();
assert!(sn_mr.bcastb_enabled());
let sn_mr: SocketMode = sn_mr.disable_bcastb();
assert!(!sn_mr.bcastb_enabled());

pub const fn enable_bcastb(self) -> Self

Enable broadcast blocking.

pub const fn disable_bcastb(self) -> Self

Disable broadcast blocking.

pub const fn nd_enabled(&self) -> bool

Use no delayed ACK.

This applies only for a socket with the TCP protocol.

When enabled the ACK packet is sent without delay as soon as a data packet is received from a peer. When disabled the ACK packet is sent after waiting for the time configured by rtr.

Example

use w5500_ll::SocketMode;

let sn_mr: SocketMode = SocketMode::DEFAULT;
assert!(!sn_mr.nd_enabled());
let sn_mr: SocketMode = sn_mr.enable_nd();
assert!(sn_mr.nd_enabled());
let sn_mr: SocketMode = sn_mr.disable_nd();
assert!(!sn_mr.nd_enabled());

pub const fn disable_nd(self) -> Self

Disable no delayed ACK.

pub const fn enable_nd(self) -> Self

Enable no delayed ACK.

pub const fn mc(&self) -> bool

Multicast IGMP version.

This applies only for a socket with the UDP protocol.

This field configures the version for IGMP messages (join/leave/report).

• false IGMP version 2
• true IGMP version 1

Example

use w5500_ll::SocketMode;

let sn_mr: SocketMode = SocketMode::DEFAULT;
assert!(!sn_mr.mc());
let sn_mr: SocketMode = sn_mr.set_igmp_v1();
assert!(sn_mr.mc());
let sn_mr: SocketMode = sn_mr.set_igmp_v2();
assert!(!sn_mr.mc());

pub const fn set_igmp_v1(self) -> Self

Set IGMP version 1.

pub const fn set_igmp_v2(self) -> Self

Set IGMP version 2.

pub const fn mmb_enabled(&self) -> bool

Multicast blocking.

This applies only for a socket with the MACRAW protocol.

Example

use w5500_ll::SocketMode;

let sn_mr: SocketMode = SocketMode::DEFAULT;
assert!(!sn_mr.mmb_enabled());
let sn_mr: SocketMode = sn_mr.enable_mmb();
assert!(sn_mr.mmb_enabled());
let sn_mr: SocketMode = sn_mr.disable_mmb();
assert!(!sn_mr.mmb_enabled());

pub const fn enable_mmb(self) -> Self

Enable multicast blocking.

pub const fn disable_mmb(self) -> Self

Disable multicast blocking.

pub const fn ucastb_enabled(&self) -> bool

Unicast blocking enabled.

This applies only for a socket with the UDP protocol.

Example

use w5500_ll::SocketMode;

let sn_mr: SocketMode = SocketMode::DEFAULT;
assert!(!sn_mr.ucastb_enabled());
let sn_mr: SocketMode = sn_mr.enable_ucastb();
assert!(sn_mr.ucastb_enabled());
let sn_mr: SocketMode = sn_mr.disable_ucastb();
assert!(!sn_mr.ucastb_enabled());

pub const fn enable_ucastb(self) -> Self

Enable unicast blocking.

pub const fn disable_ucastb(self) -> Self

Disable unicast blocking.

pub const fn mip6b_enabled(&self) -> bool

IPV6 packet blocking.

This applies only for a socket with the MACRAW protocol.

Example

use w5500_ll::SocketMode;

let sn_mr: SocketMode = SocketMode::DEFAULT;
assert!(!sn_mr.mip6b_enabled());
let sn_mr: SocketMode = sn_mr.enable_mip6b();
assert!(sn_mr.mip6b_enabled());
let sn_mr: SocketMode = sn_mr.disable_mip6b();
assert!(!sn_mr.mip6b_enabled());

pub const fn enable_mip6b(self) -> Self

Enable IPV6 packet blocking.

pub const fn disable_mip6b(self) -> Self

Disable IPV6 packet blocking.

Trait Implementations

impl Clone for SocketMode

fn clone(&self) -> SocketMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SocketMode

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

Formats the value using the given formatter.

impl Default for SocketMode

fn default() -> Self

Returns the “default value” for a type.

impl Display for SocketMode

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

Formats the value using the given formatter.

impl From<SocketMode> for u8

fn from(val: SocketMode) -> u8

Performs the conversion.

impl From<u8> for SocketMode

fn from(val: u8) -> Self

Performs the conversion.

impl PartialEq<SocketMode> for SocketMode

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

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

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

This method tests for !=.

impl Copy for SocketMode

impl Eq for SocketMode

impl StructuralEq for SocketMode

impl StructuralPartialEq for SocketMode