Skip to main content

PARL_IO

Struct PARL_IO 

Source
#[non_exhaustive]
pub struct PARL_IO<'a> { /* private fields */ }
Available on crate feature unstable only.
Expand description

PARL_IO peripheral singleton

§Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Implementations§

Source§

impl PARL_IO<'_>

Source

pub unsafe fn steal() -> Self

Unsafely creates an instance of this peripheral out of thin air.

§Safety

The caller must ensure that only one instance of this type is used at a time.

Source

pub unsafe fn clone_unchecked(&self) -> Self

Unsafely clone this peripheral reference.

§Safety

The caller must ensure that only one instance of this type is used at a time.

Source

pub fn reborrow(&mut self) -> PARL_IO<'_>

Creates a new peripheral reference with a shorter lifetime.

Use this method to keep working with the peripheral after the driver that consumes it is dropped.

Source

pub fn bind_peri_interrupt(&self, handler: InterruptHandler)

Binds an interrupt handler to the corresponding interrupt for this peripheral, and enables the interrupt.

Very low-level interrupt API. Unless writing drivers, this is probably not the interrupt API to use.
§Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Source

pub fn enable_peri_interrupt(&self, priority: Priority)

Enables the PARL_IO peripheral interrupt on the given priority level.

Very low-level interrupt API. Unless writing drivers, this is probably not the interrupt API to use.

A suitable interrupt handler must be set up before the first interrupt is triggered; otherwise the default handler panics. To set up an interrupt handler, use Self::bind_peri_interrupt or create a function that has the same (non-mangled) name as the interrupt to handle.

§Examples
use esp_hal::interrupt::Priority;

#[unsafe(no_mangle)]
unsafe extern "C" fn PARL_IO() {
    // do something
}

peripherals.PARL_IO.enable_peri_interrupt(Priority::Priority1);
peripherals.PARL_IO.disable_peri_interrupt_on_all_cores();
Source

pub fn disable_peri_interrupt(&self)

Disables the PARL_IO peripheral interrupt handler on the current CPU core.

Very low-level interrupt API. Unless writing drivers, this is probably not the interrupt API to use.
# Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Source

pub fn disable_peri_interrupt_on_all_cores(&self)

Disables the PARL_IO peripheral interrupt handler on all cores.

Very low-level interrupt API. Unless writing drivers, this is probably not the interrupt API to use.
Source§

impl PARL_IO<'_>

Source

pub const PTR: *const <PARL_IO as Deref>::Target = pac::PARL_IO::PTR

Pointer to the register block

§Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Source

pub const fn ptr() -> *const <PARL_IO as Deref>::Target

Return the pointer to the register block

§Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Source

pub fn regs<'a>() -> &'a <PARL_IO as Deref>::Target

Return a reference to the register block

§Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Source

pub fn register_block(&self) -> &<PARL_IO as Deref>::Target

Return a reference to the register block

§Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Trait Implementations§

Source§

impl<'a> Debug for PARL_IO<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'d> DmaEligiblePeripheral<AhbGdmaChannel<'d>> for PARL_IO<'d>

Source§

fn dma_peripheral(&self) -> DmaPeripheral

Returns the DmaPeripheral ID for runtime compatibility checks.

Auto Trait Implementations§

§

impl<'a> !UnwindSafe for PARL_IO<'a>

§

impl<'a> Freeze for PARL_IO<'a>

§

impl<'a> RefUnwindSafe for PARL_IO<'a>

§

impl<'a> Send for PARL_IO<'a>

§

impl<'a> Sync for PARL_IO<'a>

§

impl<'a> Unpin for PARL_IO<'a>

§

impl<'a> UnsafeUnpin for PARL_IO<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.