i2s_driver_config_t struct

I2S driver configuration parameters

Syntax

Show:

Summary

Declaration

from i2s_types_legacy.h:214

typedef struct { i2s_mode_t mode; uint32_t sample_rate; i2s_bits_per_sample_t bits_per_sample; i2s_channel_fmt_t channel_format; i2s_comm_format_t communication_format; int intr_alloc_flags; union { int dma_desc_num; int dma_buf_count __attribute__((deprecated)); }; union { int dma_frame_num; int dma_buf_len __attribute__((deprecated)); }; bool use_apll; bool tx_desc_auto_clear; int fixed_mclk; i2s_mclk_multiple_t mclk_multiple; i2s_bits_per_chan_t bits_per_chan; #if SOC_I2S_SUPPORTS_TDM i2s_channel_t chan_mask; uint32_t total_chan; bool left_align; bool big_edin; bool bit_order_msb; bool skip_msk; #endif } i2s_driver_config_t;

Fields

Field

Declared as

Description

i2s_driver_config_t::mode

i2s_mode_t

I2S work mode.

i2s_driver_config_t::sample_rate

uint32_t

I2S sample rate.

i2s_driver_config_t::bits_per_sample

i2s_bits_per_sample_t

I2S sample bits in one channel.

i2s_driver_config_t::channel_format

i2s_channel_fmt_t

I2S channel format.

i2s_driver_config_t::communication_format

i2s_comm_format_t

I2S communication format.

i2s_driver_config_t::intr_alloc_flags

int

Flags used to allocate the interrupt. One or multiple (ORred) ESP_INTR_FLAG_* values. See esp_intr_alloc.h for more info.

i2s_driver_config_t::use_apll

bool

I2S using APLL as main I2S clock, enable it to get accurate clock.

i2s_driver_config_t::tx_desc_auto_clear

bool

I2S auto clear tx descriptor if there is underflow condition (helps in avoiding noise in case of data unavailability).

i2s_driver_config_t::fixed_mclk

int

I2S using fixed MCLK output. If use_apll = true and fixed_mclk > 0, then the clock output for i2s is fixed and equal to the fixed_mclk value. If fixed_mclk set, mclk_multiple won't take effect.

i2s_driver_config_t::mclk_multiple

i2s_mclk_multiple_t

The multiple of I2S master clock(MCLK) to sample rate.

i2s_driver_config_t::bits_per_chan

i2s_bits_per_chan_t

I2S total bits in one channel， only take effect when larger than 'bits_per_sample', default '0' means equal to 'bits_per_sample'.