Skip to main content

DMA_COPY

Struct DMA_COPY 

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

DMA_COPY 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 DMA_COPY<'_>

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

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_dma_interrupt(&self, handler: InterruptHandler)

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

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

peripherals.DMA_COPY.enable_dma_interrupt(Priority::Priority1);
peripherals.DMA_COPY.disable_dma_interrupt_on_all_cores();
Source

pub fn disable_dma_interrupt(&self)

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

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

Source

pub const PTR: *const <COPY_DMA as Deref>::Target = pac::COPY_DMA::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 <COPY_DMA 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 <COPY_DMA 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) -> &<COPY_DMA 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 DMA_COPY<'a>

Source§

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

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

impl<'d> DmaChannel for DMA_COPY<'d>

Source§

type Rx = CopyDmaRxChannel<'d>

A description of the RX half of a DMA Channel.
Source§

type Tx = CopyDmaTxChannel<'d>

A description of the TX half of a DMA Channel.
Source§

unsafe fn split_internal(self, _: Internal) -> (Self::Rx, Self::Tx)

Splits the DMA channel into its RX and TX halves. Read more
Source§

impl<'d> From<DMA_COPY<'d>> for CopyDmaRxChannel<'d>

Source§

fn from(this: DMA_COPY<'d>) -> CopyDmaRxChannel<'d>

Converts to this type from the input type.
Source§

impl<'d> From<DMA_COPY<'d>> for CopyDmaTxChannel<'d>

Source§

fn from(this: DMA_COPY<'d>) -> CopyDmaTxChannel<'d>

Converts to this type from the input type.
Source§

impl<'d> Mem2MemCapableChannel<'d> for DMA_COPY<'d>

Source§

fn mem2mem_id(&self) -> DmaPeripheral

Peripheral selector programmed for memory-to-memory on this channel.

Auto Trait Implementations§

§

impl<'a> Freeze for DMA_COPY<'a>

§

impl<'a> RefUnwindSafe for DMA_COPY<'a>

§

impl<'a> Send for DMA_COPY<'a>

§

impl<'a> Sync for DMA_COPY<'a>

§

impl<'a> Unpin for DMA_COPY<'a>

§

impl<'a> UnsafeUnpin for DMA_COPY<'a>

§

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

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

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
§

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

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

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

§

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

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

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

Performs the conversion.