Struct nrf52832_hal::i2s::I2S

source · [−]

pub struct I2S { /* private fields */ }

Implementations

impl I2S

pub fn new(i2s: I2S, pins: Pins) -> I2S

Takes ownership of the raw I2S peripheral, returning a safe wrapper in controller mode.

pub fn enable(&self) -> &I2S

Enables the I2S module.

pub fn disable(&self) -> &I2S

Disables the I2S module.

pub fn start(&self) -> &I2S

Starts I2S transfer.

pub fn stop(&self) -> &I2S

Stops the I2S transfer and waits until it has stopped.

pub fn set_tx_enabled(&self, enabled: bool) -> &I2S

Enables/disables I2S transmission (TX).

pub fn set_rx_enabled(&self, enabled: bool) -> &I2S

Enables/disables I2S reception (RX).

pub fn set_mck_frequency(&self, freq: MckFreq) -> &I2S

Sets MCK generator frequency.

pub fn set_ratio(&self, ratio: Ratio) -> &I2S

Sets MCK / LRCK ratio.

pub fn set_sample_width(&self, width: SampleWidth) -> &I2S

Sets sample width.

pub fn set_align(&self, align: Align) -> &I2S

Sets the sample alignment within a frame.

pub fn set_format(&self, format: Format) -> &I2S

Sets the frame format.

pub fn set_channels(&self, channels: Channels) -> &I2S

Sets the I2S channel configuration.

pub fn channels(&self) -> Channels

Returns the I2S channel configuration.

pub fn rx<W, B>(self, buffer: B) -> Result<Transfer<B>, Error> where
W: SupportedWordSize,
B: 'static + WriteBuffer<Word = W>,

Receives data into the given buffer until it’s filled. Buffer address must be 4 byte aligned and located in RAM. Returns a value that represents the in-progress DMA transfer.

pub fn transfer<W, TxB, RxB>(
    self,
    tx_buffer: TxB,
    rx_buffer: RxB
) -> Result<TransferFullDuplex<TxB, RxB>, Error> where
    W: SupportedWordSize,
    TxB: 'static + ReadBuffer<Word = W>,
    RxB: 'static + WriteBuffer<Word = W>,

Full duplex DMA transfer. Transmits the given tx_buffer while simultaneously receiving data into the given rx_buffer until it is filled. The buffers must be of equal size and their addresses must be 4 byte aligned and located in RAM. Returns a value that represents the in-progress DMA transfer.

pub fn tx<W, B>(self, buffer: B) -> Result<Transfer<B>, Error> where
W: SupportedWordSize,
B: 'static + ReadBuffer<Word = W>,

Transmits the given tx_buffer. Buffer address must be 4 byte aligned and located in RAM. Returns a value that represents the in-progress DMA transfer.

pub fn set_tx_ptr(&self, addr: u32) -> Result<(), Error>

Sets the transmit buffer RAM start address.

pub unsafe fn set_rx_ptr(&self, addr: u32) -> Result<(), Error>

Sets the receive buffer RAM start address.

pub unsafe fn set_buffersize(&self, n_32bit: u32) -> Result<(), Error>

Sets the size (in 32bit words) of the receive and transmit buffers.

pub fn is_event_triggered(&self, event: I2SEvent) -> bool

Checks if an event has been triggered.

pub fn reset_event(&self, event: I2SEvent)

Marks event as handled.

pub fn enable_interrupt(&self, event: I2SEvent) -> &I2S

Enables interrupt triggering on the specified event.

pub fn disable_interrupt(&self, event: I2SEvent) -> &I2S

Disables interrupt triggering on the specified event.

pub fn event_stopped(&self) -> &Reg<EVENTS_STOPPED_SPEC>

Returns reference to Stopped event endpoint for PPI.

pub fn event_rx_ptr_updated(&self) -> &Reg<EVENTS_RXPTRUPD_SPEC>

Returns reference to RxPtrUpdated event endpoint for PPI.

pub fn event_tx_ptr_updated(&self) -> &Reg<EVENTS_TXPTRUPD_SPEC>

Returns reference to TxPtrUpdated event endpoint for PPI.

pub fn task_start(&self) -> &Reg<TASKS_START_SPEC>

Returns reference to Start task endpoint for PPI.

pub fn task_stop(&self) -> &Reg<TASKS_STOP_SPEC>

Returns reference to Stop task endpoint for PPI.

pub fn free(self) -> (I2S, Pins )

Consumes self and returns back the raw peripheral.

Auto Trait Implementations

impl RefUnwindSafe for I2S

impl Send for I2S

impl !Sync for I2S

impl Unpin for I2S

impl UnwindSafe for I2S

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Az for T

pub fn az<Dst>(self) -> Dst where
T: Cast<Dst>,

Casts the value.

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<Src, Dst> CastFrom<Src> for Dst where
Src: Cast<Dst>,

pub fn cast_from(src: Src) -> Dst

Casts the value.

impl<T> CheckedAs for T

pub fn checked_as<Dst>(self) -> Option<Dst> where
T: CheckedCast<Dst>,

Casts the value.

impl<Src, Dst> CheckedCastFrom<Src> for Dst where
Src: CheckedCast<Dst>,

pub fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

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

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

impl<Src, Dst> LosslessTryInto<Dst> for Src where
Dst: LosslessTryFrom<Src>,

pub fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.

impl<Src, Dst> LossyInto<Dst> for Src where
Dst: LossyFrom<Src>,

pub fn lossy_into(self) -> Dst

Performs the conversion.

impl<T> OverflowingAs for T

pub fn overflowing_as<Dst>(self) -> (Dst, bool ) where
T: OverflowingCast<Dst>,

Casts the value.

impl<Src, Dst> OverflowingCastFrom<Src> for Dst where
Src: OverflowingCast<Dst>,

pub fn overflowing_cast_from(src: Src) -> (Dst, bool )

OverflowingCasts the value.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> SaturatingAs for T

pub fn saturating_as<Dst>(self) -> Dst where
T: SaturatingCast<Dst>,

Casts the value.

impl<Src, Dst> SaturatingCastFrom<Src> for Dst where
Src: SaturatingCast<Dst>,

pub fn saturating_cast_from(src: Src) -> Dst

Casts the value.

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

const: unstable · source

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

Performs the conversion.

impl<T> UnwrappedAs for T

pub fn unwrapped_as<Dst>(self) -> Dst where
T: UnwrappedCast<Dst>,

Casts the value.

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst where
Src: UnwrappedCast<Dst>,

pub fn unwrapped_cast_from(src: Src) -> Dst

UnwrappedCasts the value.

impl<T> WrappingAs for T

pub fn wrapping_as<Dst>(self) -> Dst where
T: WrappingCast<Dst>,

Casts the value.

impl<Src, Dst> WrappingCastFrom<Src> for Dst where
Src: WrappingCast<Dst>,

pub fn wrapping_cast_from(src: Src) -> Dst

WrappingCasts the value.