Struct r3::kernel::InterruptLine

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

Refers to an interrupt line in a system.

Implementations

impl<System: Port> InterruptLine<System>

pub const fn build() -> CfgInterruptLineBuilder<System>

Construct a CfgInterruptLineBuilder to configure an interrupt line in a configuration function.

It's allowed to call this for multiple times for the same interrupt line. However, each property (such as priority) cannot be specified more than once.

impl<System> 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: Kernel> InterruptLine<System>

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> Clone for InterruptLine<System>

pub fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<System> Copy for InterruptLine<System>

impl<System> Debug for InterruptLine<System>

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

Formats the value using the given formatter.

impl<System> Eq for InterruptLine<System>

impl<System> Hash for InterruptLine<System>

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

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<System> PartialEq<InterruptLine<System>> for InterruptLine<System>

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.