Struct w5500_ll::Interrupt

source ·

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

Expand description

Interrupt and interrupt mask register (IR and IMR).

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:

Implementations§

source §

impl Interrupt

source

pub const RESET: u8 = 0u8

Interrupt and interrupt mask reset value.

source

pub const DEFAULT: Self = _

Default value.

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

Example

use w5500_ll::Interrupt;

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

source

pub const CONFLICT_OFFSET: u8 = 7u8

Bit offset for the CONFLICT field.

source

pub const UNREACH_OFFSET: u8 = 6u8

Bit offset for the UNREACH field.

source

pub const PPPOE_OFFSET: u8 = 5u8

Bit offset for the PPPoE field.

source

pub const MP_OFFSET: u8 = 4u8

Bit offset for the MP field.

source

pub const CONFLICT_MASK: u8 = 128u8

Bit mask for the CONFLICT field.

source

pub const UNREACH_MASK: u8 = 64u8

Bit mask for the UNREACH field.

source

pub const PPPOE_MASK: u8 = 32u8

Bit mask for the PPPoE field.

source

pub const MP_MASK: u8 = 16u8

Bit mask for the MP field.

source

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

use w5500_ll::Interrupt;

let ir: Interrupt = Interrupt::DEFAULT;
assert!(!ir.conflict());
let ir: Interrupt = ir.set_conflict();
assert!(ir.conflict());
let ir: Interrupt = ir.clear_conflict();
assert!(!ir.conflict());

source

pub const fn set_conflict(self) -> Self

Set the IP conflict bit.

source

pub const fn clear_conflict(self) -> Self

Clear the IP conflict bit.

source

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 and UPORTR registers.

Example

use w5500_ll::Interrupt;

let ir: Interrupt = Interrupt::DEFAULT;
assert!(!ir.unreach());
let ir: Interrupt = ir.set_unreach();
assert!(ir.unreach());
let ir: Interrupt = ir.clear_unreach();
assert!(!ir.unreach());

source

pub const fn set_unreach(self) -> Self

Set the destination unreachable bit.

source

pub const fn clear_unreach(self) -> Self

Clear the destination unreachable bit.

source

pub const fn pppoe(&self) -> bool

Get the PPPoE connection close interrupt.

This interrupt is set when PPPoE is disconnected during PPPoE.

Example

use w5500_ll::Interrupt;

let ir: Interrupt = Interrupt::DEFAULT;
assert!(!ir.pppoe());
let ir: Interrupt = ir.set_pppoe();
assert!(ir.pppoe());
let ir: Interrupt = ir.clear_pppoe();
assert!(!ir.pppoe());

source

pub const fn set_pppoe(self) -> Self

Set the PPPoE connection close bit.

source

pub const fn clear_pppoe(self) -> Self

Clear the PPPoE connection close bit.

source

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

use w5500_ll::Interrupt;

let ir: Interrupt = Interrupt::DEFAULT;
assert!(!ir.mp());
let ir: Interrupt = ir.set_mp();
assert!(ir.mp());
let ir: Interrupt = ir.clear_mp();
assert!(!ir.mp());

source