Struct r3_core::kernel::interrupt::InterruptLine

pub struct InterruptLine<System: KernelInterruptLine>(_, _);

Refers to an interrupt line in a system.

Implementations

impl<System: KernelInterruptLine> InterruptLine<System>

pub const fn from_num(num: InterruptNum) -> Self

Construct a InterruptLine from InterruptNum.

pub const fn num(self) -> InterruptNum

Get the raw InterruptNum value representing this interrupt line.

impl<System: KernelInterruptLine> InterruptLine<System>

pub const fn define() -> InterruptLineDefiner<System>

Construct a InterruptLineDefiner to define an interrupt line in a configuration function.

pub fn set_priority(
    self,
    value: InterruptPriority
) -> Result<(), SetInterruptLinePriorityError>

Set the priority of the interrupt line. The new priority must fall within a managed range.

Turning a managed interrupt handler into an unmanaged one is unsafe because the behavior of system calls is undefined inside an unmanaged interrupt handler. This method checks the new priority to prevent this from happening and returns SetInterruptLinePriorityError::BadParam if the operation is unsafe.

pub unsafe fn set_priority_unchecked(
    self,
    value: InterruptPriority
) -> Result<(), SetInterruptLinePriorityError>

Set the priority of the interrupt line without checking if the new priority falls within a managed range.

Safety

If a non-unmanaged-safe interrupt handler is attached to the interrupt line, changing the priority of the interrupt line to outside of the managed range (thus turning the handler into an unmanaged handler) may allow the interrupt handler to invoke an undefined behavior, for example, by making system calls, which are disallowed in an unmanaged interrupt handler.

pub fn enable(self) -> Result<(), EnableInterruptLineError>

Enable the interrupt line.

pub fn disable(self) -> Result<(), EnableInterruptLineError>

Disable the interrupt line.

pub fn pend(self) -> Result<(), PendInterruptLineError>

Set the pending flag of the interrupt line.

pub fn clear(self) -> Result<(), ClearInterruptLineError>

Clear the pending flag of the interrupt line.

pub fn is_pending(self) -> Result<bool, QueryInterruptLineError>

Read the pending flag of the interrupt line.

Trait Implementations

impl<System: KernelInterruptLine> Clone for InterruptLine<System>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<System: KernelInterruptLine> Debug for InterruptLine<System>

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

Formats the value using the given formatter.

impl<System: KernelInterruptLine> Hash for InterruptLine<System>

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

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<System: KernelInterruptLine> PartialEq<InterruptLine<System>> for InterruptLine<System>

fn eq(&self, other: &Self) -> 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<System: KernelInterruptLine> Copy for InterruptLine<System>

impl<System: KernelInterruptLine> Eq for InterruptLine<System>