Struct esp_idf_hal::i2s::config::StdSlotConfig

pub struct StdSlotConfig { /* private fields */ }

Standard mode channel slot configuration.

To create a slot configuration, use StdSlotConfig::philips_slot_default, StdSlotConfig::pcm_slot_default, or StdSlotConfig::msb_slot_default, then customize it as needed.

Note

The slot_mode and slot_mask cause the data to be interpreted in different ways, as noted below. WS is the “word select” signal, sometimes called LRCLK (left/right clock).

Transmit

Assuming the buffered data contains the following samples (where a sample may be 1, 2, 3, or 4 bytes, depending on data_bit_width):

d[0]	d[1]	d[2]	d[3]	d[4]	d[5]	d[6]	d[7]
11	12	13	14	15	16	17	18

The actual data on the line will be:

slot_mode	slot_mask	Transmitted Data
		WS Low	WS High	WS Low	WS High	WS Low	WS High	WS Low	WS High
Mono	Left	11	0	12	0	13	0	14	0
	Right	0	11	0	12	0	13	0	14
	Both	11	11	12	12	13	13	14	14
Stereo	Left	11	0	13	0	15	0	17	0
	Right	0	12	0	14	0	16	0	18
	Both	11	12	13	14	15	16	17	18

Receive

Assuming the received data contains the following samples (where a sample may be 8, 16, 24, or 32 bits, depending on data_bit_width):

WS Low	WS High	WS Low	WS High	WS Low	WS High	WS Low	WS High
11	12	13	14	15	16	17	18	…

The actual data in the buffer will be (1-4 bytes, depending on data_bit_width):

slot_mode	slot_mask	Buffer Contents
		d[0]	d[1]	d[2]	d[3]	d[4]	d[5]	d[6]	d[7]
Mono	Left	11	13	15	17	19	21	23	25
	Right	12	14	16	18	20	22	24	26
	Both	Unspecified behavior
Stereo	Any	11	12	13	14	15	16	17	18

For details, refer to the ESP-IDF Programming Guide details for your specific microcontroller:

• ESP32: STD Tx Mode / STD Rx Mode.
• ESP32-S2: STD Tx Mode / STD Rx Mode
• ESP32-S3: STD Tx Mode / STD Rx Mode
• ESP32-C3: STD Tx Mode / STD Rx Mode.
• ESP32-C6: STD Tx Mode / STD Rx Mode.
• ESP32-H2: STD Tx Mode / STD Rx Mode.

Implementations

impl StdSlotConfig

pub fn data_bit_width(self, data_bit_width: DataBitWidth) -> Self

Update the data bit width on this standard slot configuration.

pub fn slot_bit_width(self, slot_bit_width: SlotBitWidth) -> Self

Update the slot bit width on this standard slot configuration.

pub fn slot_mode_mask(self, slot_mode: SlotMode, slot_mask: StdSlotMask) -> Self

Update the slot mode and mask on this standard slot configuration.

pub fn ws_width(self, ws_width: u32) -> Self

Update the word select signal width on this standard slot configuration.

pub fn ws_polarity(self, ws_polarity: bool) -> Self

Update the word select signal polarity on this standard slot configuration.

pub fn bit_shift(self, bit_shift: bool) -> Self

Update the bit shift flag on this standard slot configuration.

pub fn left_align(self, left_align: bool) -> Self

Update the left-alignment flag on this standard slot configuration.

pub fn big_endian(self, big_endian: bool) -> Self

Update the big-endian flag on this standard slot configuration.

pub fn bit_order_lsb(self, bit_order_lsb: bool) -> Self

Update the LSB-first flag on this standard slot configuration.

pub fn philips_slot_default( bits_per_sample: DataBitWidth, slot_mode: SlotMode, ) -> Self

Configure in Philips format in 2 slots.

pub fn pcm_slot_default( bits_per_sample: DataBitWidth, slot_mode: SlotMode, ) -> Self

Configure in PCM (short) format in 2 slots.

pub fn msb_slot_default( bits_per_sample: DataBitWidth, slot_mode: SlotMode, ) -> Self

Configure in MSB format in 2 slots.

Trait Implementations

impl Clone for StdSlotConfig

fn clone(&self) -> StdSlotConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StdSlotConfig

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

Formats the value using the given formatter.

impl PartialEq for StdSlotConfig

fn eq(&self, other: &StdSlotConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for StdSlotConfig

impl Eq for StdSlotConfig

impl StructuralPartialEq for StdSlotConfig