Enum bxcan::Interrupt

#[non_exhaustive]
pub enum Interrupt {
    TransmitMailboxEmpty,
    Fifo0MessagePending,
    Fifo0Full,
    Fifo0Overrun,
    Fifo1MessagePending,
    Fifo1Full,
    Fifo1Overrun,
    Error,
    Wakeup,
    Sleep,
}

bxCAN interrupt sources.

These can be individually enabled and disabled in the bxCAN peripheral. Note that the bxCAN peripheral only exposes 4 interrupts to the microcontroller:

• TX
• RX FIFO 1
• RX FIFO 2
• SCE (Status Change Error)

This means that some of the interrupts listed here will result in the same interrupt handler being invoked.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

TransmitMailboxEmpty

Fires the TX interrupt when one of the transmit mailboxes returns to empty state.

This usually happens because its message was either transmitted successfully, or transmission was aborted successfully.

The interrupt handler must clear the interrupt condition by calling Can::clear_request_completed_flag or Can::clear_tx_interrupt.

Fifo0MessagePending

Fires the RX FIFO 0 interrupt when FIFO 0 holds a message.

The interrupt handler must clear the interrupt condition by receiving all messages from the FIFO by calling Can::receive or Rx::receive.

Fifo0Full

Fires the RX FIFO 0 interrupt when FIFO 0 holds 3 incoming messages.

The interrupt handler must clear the interrupt condition by receiving at least one message from the FIFO (making it no longer “full”). This can be done by calling Can::receive or Rx::receive.

Fifo0Overrun

Fires the RX FIFO 0 interrupt when FIFO 0 drops an incoming message.

The interrupt handler must clear the interrupt condition by calling Can::receive or Rx::receive (which will return an error).

Fifo1MessagePending

Fires the RX FIFO 1 interrupt when FIFO 1 holds a message.

Behavior is otherwise identical to Self::Fifo0MessagePending.

Fifo1Full

Fires the RX FIFO 1 interrupt when FIFO 1 holds 3 incoming messages.

Behavior is otherwise identical to Self::Fifo0Full.

Fifo1Overrun

Fires the RX FIFO 1 interrupt when FIFO 1 drops an incoming message.

Behavior is otherwise identical to Self::Fifo0Overrun.

Error

Wakeup

Fires the SCE interrupt when an incoming CAN frame is detected while the peripheral is in sleep mode.

The interrupt handler must clear the interrupt condition by calling Can::clear_wakeup_interrupt.

Sleep

Fires the SCE interrupt when the peripheral enters sleep mode.

The interrupt handler must clear the interrupt condition by calling Can::clear_sleep_interrupt.

Trait Implementations

impl BitOrAssign<Interrupt> for Interrupts

Adds an interrupt to the interrupt set.

fn bitor_assign(&mut self, rhs: Interrupt)

Performs the |= operation.

impl Clone for Interrupt

fn clone(&self) -> Interrupt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Interrupt

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

Formats the value using the given formatter.

impl Format for Interrupt

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

Writes the defmt representation of self to fmt.

impl From<Interrupt> for Interrupts

fn from(i: Interrupt) -> Self

Performs the conversion.

impl PartialEq<Interrupt> for Interrupt

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

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

#[must_use]

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

This method tests for !=.

impl Copy for Interrupt

impl Eq for Interrupt

impl StructuralEq for Interrupt

impl StructuralPartialEq for Interrupt