Struct I2S0 

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

Available on crate feature unstable only.

I2S0 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

impl I2S0<'_>

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.

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.

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

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.

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.

pub fn enable_peri_interrupt(&self, priority: Priority)

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

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

pub fn disable_peri_interrupt(&self)

Disables the I2S0 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.

pub fn disable_peri_interrupt_on_all_cores(&self)

Disables the I2S0 peripheral interrupt handler on all cores.

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

impl I2S0<'_>

pub const PTR: *const <I2S0 as Deref>::Target = pac::I2S0::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.

pub const fn ptr() -> *const <I2S0 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.

pub fn regs<'a>() -> &'a <I2S0 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.

pub fn register_block(&self) -> &<I2S0 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

impl<'a> Debug for I2S0<'a>

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

Formats the value using the given formatter.

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

fn dma_peripheral(&self) -> DmaPeripheral

Returns the DmaPeripheral ID for runtime compatibility checks.

impl<'d> From<I2S0<'d>> for AnyI2s<'d>

fn from(inner: I2S0<'d>) -> Self

Converts to this type from the input type.

impl<'d> I2sMasterDmaChannel<'d, I2S0<'d>> for DMA_CH0<'d>

impl<'d> I2sMasterDmaChannel<'d, I2S0<'d>> for DMA_CH1<'d>

impl<'d> I2sMasterDmaChannel<'d, I2S0<'d>> for DMA_CH2<'d>

impl<'d> I2sMasterDmaChannel<'d, I2S0<'d>> for AhbGdmaChannel<'d>

impl Instance for I2S0<'_>

impl PdmInstance for I2S0<'_>

impl<'d> TryFrom<AnyI2s<'d>> for I2S0<'d>

type Error = AnyI2s<'d>

The type returned in the event of a conversion error.

fn try_from(any: AnyI2s<'d>) -> Result<Self, AnyI2s<'d>>

Performs the conversion.