Struct w5500_ll::Interrupt

pub struct Interrupt(_);

Interrupt and interrupt mask register.

When used for interrupt masking:

• false = Interrupt is disabled.
• true = Interrupt is enabled.

When used for reading interrupt status:

• false = Interrupt is not raised.
• true = Interrupt is raised.

This is used by these methods:

• crate::Registers::ir
• crate::Registers::set_ir
• crate::Registers::imr
• crate::Registers::set_imr

Implementations

impl Interrupt

pub const RESET: u8

Interrupt and interrupt mask reset value.

pub const CONFLICT_OFFSET: u8

Bit offset for the CONFLICT field.

pub const UNREACH_OFFSET: u8

Bit offset for the UNREACH field.

pub const PPPOE_OFFSET: u8

Bit offset for the PPPoE field.

pub const MP_OFFSET: u8

Bit offset for the MP field.

pub const CONFLICT_MASK: u8

Bit mask for the CONFLICT field.

pub const UNREACH_MASK: u8

Bit mask for the UNREACH field.

pub const PPPOE_MASK: u8

Bit mask for the PPPoE field.

pub const MP_MASK: u8

Bit mask for the MP field.

pub const fn conflict(&self) -> bool

Get the value of the IP conflict interrupt.

This interrupt is set when our source IP is the same as the sender IP in the received ARP request.

Example

let mut ir = w5500_ll::Interrupt::default();
assert!(!ir.conflict());
ir.set_conflict();
assert!(ir.conflict());
ir.clear_conflict();
assert!(!ir.conflict());

pub fn set_conflict(&mut self)

Set the IP conflict bit.

pub fn clear_conflict(&mut self)

Clear the IP conflict bit.

pub const fn unreach(&self) -> bool

Get the destination unreachable interrupt.

This interrupt is set when receiving the ICMP (Destination port unreachable) packet.

When this interrupt is set destination information such as the IP address and port number may be checked with the corresponding UIPR & UPORTR.

Example

let mut ir = w5500_ll::Interrupt::default();
assert!(!ir.unreach());
ir.set_unreach();
assert!(ir.unreach());
ir.clear_unreach();
assert!(!ir.unreach());

pub fn set_unreach(&mut self)

Set the destination unreachable bit.

pub fn clear_unreach(&mut self)

Clear the destination unreachable bit.

pub const fn pppoe(&self) -> bool

Get the PPPoE connection close interrupt.

This interrupt is set when PPPoE is disconnected during PPPoE.

Example

let mut ir = w5500_ll::Interrupt::default();
assert!(!ir.pppoe());
ir.set_pppoe();
assert!(ir.pppoe());
ir.clear_pppoe();
assert!(!ir.pppoe());

pub fn set_pppoe(&mut self)

Set the PPPoE connection close bit.

pub fn clear_pppoe(&mut self)

Clear the PPPoE connection close bit.

pub const fn mp(&self) -> bool

Get the magic packet interrupt.

This interrupt is set when wake on LAN is enabled, and the magic packet is received.

Example

let mut ir = w5500_ll::Interrupt::default();
assert!(!ir.mp());
ir.set_mp();
assert!(ir.mp());
ir.clear_mp();
assert!(!ir.mp());

pub fn set_mp(&mut self)

Set the magic packet bit.

pub fn clear_mp(&mut self)

Clear the magic packet bit.

Trait Implementations

impl Clone for Interrupt

pub fn clone(&self) -> Interrupt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Interrupt

impl Debug for Interrupt

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

Formats the value using the given formatter.

impl Default for Interrupt

pub fn default() -> Self

Returns the "default value" for a type.

impl Eq for Interrupt

impl From<u8> for Interrupt

pub fn from(val: u8) -> Interrupt

Performs the conversion.

impl PartialEq<Interrupt> for Interrupt

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

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

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

This method tests for !=.

impl StructuralEq for Interrupt

impl StructuralPartialEq for Interrupt