Struct SPI3

Source

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

Expand description

SPI3 peripheral singleton

Implementations§

Source §

impl SPI3<'_>

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) -> SPI3<'_>

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_dma_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.

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_dma_interrupt(&self, priority: Priority)

Enables the SPI3_DMA peripheral interrupt on the given priority level.

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

The interrupt handler will be enabled on the core that calls this function.

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_dma_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 SPI3_DMA() {
    // do something
}

peripherals.SPI3.enable_dma_interrupt(Priority::Priority1);
peripherals.SPI3.disable_dma_interrupt_on_all_cores();

Source

pub fn disable_dma_interrupt(&self)

Available on crate feature unstable only.

Disables the SPI3_DMA 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_dma_interrupt_on_all_cores(&self)

Disables the SPI3_DMA peripheral interrupt handler on all cores.

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

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.

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 SPI3 peripheral interrupt on the given priority level.

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

The interrupt handler will be enabled on the core that calls this function.

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 SPI3() {
    // do something
}

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

Source

pub fn disable_peri_interrupt(&self)

Available on crate feature unstable only.

Disables the SPI3 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 SPI3 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 SPI3<'_>

Source

pub const PTR: *const <SPI3 as Deref>::Target = pac::SPI3::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 <SPI3 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 fn regs<'a>() -> &'a <SPI3 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) -> &<SPI3 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.