Struct SPI2

Source

#[non_exhaustive]
pub struct SPI2<'a> { /* private fields */ }

Expand description

SPI2 peripheral singleton

Implementations§

Source §

impl SPI2<'_>

Source

pub unsafe fn steal() -> Self

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

§Safety

You must ensure that you’re only using one instance of this type at a time.

Source

pub unsafe fn clone_unchecked(&self) -> Self

Unsafely clone this peripheral reference.

§Safety

You must ensure that you’re only using one instance of this type at a time.

Source

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

Creates a new peripheral reference with a shorter lifetime.

Use this method if you would like to keep working with the peripheral after you dropped the driver that consumes this.

Source

pub fn bind_peri_interrupt(&self, handler: InterruptHandler)

Available on crate feature unstable only.

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

This function is a very low-level way to work with interrupts. Unless you're writing drivers, this is probably not the interrupt API you want 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 SPI2 peripheral interrupt on the given priority level.

This function is a very low-level way to work with interrupts. Unless you're writing drivers, this is probably not the interrupt API you want to use.

Note that a suitable interrupt handler needs to be set up before the first interrupt is triggered, otherwise the default handler will panic. 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 you want to handle.

§Examples

use esp_hal::interrupt::Priority;

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

peripherals.SPI2.enable_peri_interrupt(Priority::Priority1);
peripherals.SPI2.disable_peri_interrupt_on_all_cores();

Source

pub fn disable_peri_interrupt(&self)

Available on crate feature unstable only.

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

This function is a very low-level way to work with interrupts. Unless you're writing drivers, this is probably not the interrupt API you want 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 SPI2 peripheral interrupt handler on all cores.

This function is a very low-level way to work with interrupts. Unless you're writing drivers, this is probably not the interrupt API you want to use.

Source §

impl SPI2<'_>

Source

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

Available on crate feature unstable only.

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 <SPI2 as Deref>::Target

Available on crate feature unstable only.

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 const fn regs<'a>() -> &'a <SPI2 as Deref>::Target

Available on crate feature unstable only.

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) -> &<SPI2 as Deref>::Target

Available on crate feature unstable only.

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.