Struct w5500_ll::Mode

pub struct Mode(/* private fields */);

Mode register (MR).

Used for software reset, and controlling modes of operation.

This is used by the Registers::mr and Registers::set_mr methods.

Implementations

impl Mode

pub const RESET: u8 = 0u8

Mode register reset value.

pub const DEFAULT: Self = _

Default value.

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

Example

use w5500_ll::Mode;

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

pub const RST_OFFSET: u8 = 7u8

Bit offset for the RST field.

pub const WOL_OFFSET: u8 = 5u8

Bit offset for the WOL field.

pub const PB_OFFSET: u8 = 4u8

Bit offset for the PB field.

pub const PPPOE_OFFSET: u8 = 3u8

Bit offset for the PPPoE field.

pub const FARP_OFFSET: u8 = 1u8

Bit offset for the FARP field.

pub const RST_MASK: u8 = 128u8

Bit mask for the RST field.

pub const WOL_MASK: u8 = 32u8

Bit mask for the WOL field.

pub const PB_MASK: u8 = 16u8

Bit mask for the PB field.

pub const PPPOE_MASK: u8 = 8u8

Bit mask for the PPPoE field.

pub const FARP_MASK: u8 = 2u8

Bit mask for the FARP field.

pub const fn rst(self) -> Self

Set the software reset bit to 1.

When reset all internal registers will be initialized.

pub const fn wol_enabled(&self) -> bool

Wake on LAN.

If WOL mode is enabled and the received magic packet over UDP has been normally processed, the interrupt pin (INTn) asserts to low.

Example

use w5500_ll::Mode;

let mr: Mode = Mode::DEFAULT;
assert!(!mr.wol_enabled());
let mr: Mode = mr.enable_wol();
assert!(mr.wol_enabled());
let mr: Mode = mr.disable_wol();
assert!(!mr.wol_enabled());

pub const fn enable_wol(self) -> Self

Enable wake on LAN.

pub const fn disable_wol(self) -> Self

Disable wake on LAN.

pub const fn pb_enabled(&self) -> bool

Ping block mode.

If enabled it blocks responses to ping requests.

Example

use w5500_ll::Mode;

let mr: Mode = Mode::DEFAULT;
assert!(!mr.pb_enabled());
let mr: Mode = mr.enable_pb();
assert!(mr.pb_enabled());
let mr: Mode = mr.disable_pb();
assert!(!mr.pb_enabled());

pub const fn enable_pb(self) -> Self

Enable ping block.

pub const fn disable_pb(self) -> Self

Disable ping block.

pub const fn pppoe_enabled(&self) -> bool

PPPoE mode.

If you use ADSL this should be enabled.

Example

use w5500_ll::Mode;

let mr: Mode = Mode::DEFAULT;
assert!(!mr.pppoe_enabled());
let mr: Mode = mr.enable_pppoe();
assert!(mr.pppoe_enabled());
let mr: Mode = mr.disable_pppoe();
assert!(!mr.pppoe_enabled());

pub const fn enable_pppoe(self) -> Self

Enable PPPoE mode.

pub const fn disable_pppoe(self) -> Self

Disable PPPoE mode.

pub const fn farp_enabled(&self) -> bool

Force ARP.

When enabled it forces sending ARP request whenever data is sent.

Example

use w5500_ll::Mode;

let mr: Mode = Mode::DEFAULT;
assert!(!mr.farp_enabled());
let mr: Mode = mr.enable_farp();
assert!(mr.farp_enabled());
let mr: Mode = mr.disable_farp();
assert!(!mr.farp_enabled());

pub const fn enable_farp(self) -> Self

Enable force ARP.

pub const fn disable_farp(self) -> Self

Disable force ARP.

Trait Implementations

impl Clone for Mode

fn clone(&self) -> Mode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Mode

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

Formats the value using the given formatter.

impl Default for Mode

fn default() -> Self

Returns the “default value” for a type.

impl Display for Mode

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

Formats the value using the given formatter.

impl Format for Mode

Available on crate feature defmt only.

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

Writes the defmt representation of self to fmt.

impl From<Mode> for u8

fn from(val: Mode) -> u8

Converts to this type from the input type.

impl From<u8> for Mode

fn from(val: u8) -> Self

Converts to this type from the input type.

impl Hash for Mode

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Mode

fn eq(&self, other: &Mode) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Mode

impl Eq for Mode

impl StructuralEq for Mode

impl StructuralPartialEq for Mode