Symbols

loading...

Files

loading (1/5)...

Summary Syntax Related References Instances Lifecycle

SourceVuESP-IDF Framework and ExamplesESP-IDFi2s_dma_t

i2s_dma_t struct

i2s channel level configurations

Syntax

Show:

Summary

Declaration

from i2s_private.h:111

typedef struct { #if SOC_GDMA_SUPPORTED gdma_channel_handle_t dma_chan; #else intr_handle_t dma_chan; #endif uint32_t desc_num; uint32_t frame_num; uint32_t buf_size; bool auto_clear_after_cb; bool auto_clear_before_cb; uint32_t rw_pos; void *curr_ptr; void *curr_desc; lldesc_t **desc; uint8_t **bufs; } i2s_dma_t;

Fields

Field

Declared as

Description

i2s_dma_t::dma_chan

interrupt channel handle.

i2s_dma_t::desc_num

uint32_t

I2S DMA buffer number, it is also the number of DMA descriptor.

i2s_dma_t::frame_num

uint32_t

I2S frame number in one DMA buffer. One frame means one-time sample data in all slots.

i2s_dma_t::buf_size

uint32_t

dma buffer size.

i2s_dma_t::auto_clear_after_cb

bool

Set to auto clear DMA TX descriptor after callback, i2s will always send zero automatically if no data to send.

i2s_dma_t::auto_clear_before_cb

bool

Set to auto clear DMA TX descriptor before callback, i2s will always send zero automatically if no data to send.

i2s_dma_t::rw_pos

uint32_t

reading/writing pointer position.

i2s_dma_t::curr_ptr

void *

Pointer to current dma buffer.

i2s_dma_t::curr_desc

void *

Pointer to current dma descriptor used for pre-load.

i2s_dma_t::desc

dma descriptor array.

i2s_dma_t::bufs

uint8_t **

dma buffer array.

References

Code

Location

Scope

Referrer

typedef struct {

i2s_legacy.c:120

i2s_legacy.c:128

typedef struct {

i2s_private.h:111

i2s_private.h:127

i2s_legacy.c:128

i2s_dma_t *tx; /*!< DMA Tx buffer*/

i2s_legacy.c:139

i2s_dma_t *rx; /*!< DMA Rx buffer*/

i2s_legacy.c:140

static esp_err_t i2s_delete_dma_buffer(i2s_port_t i2s_num, i2s_dma_t *dma_obj)

i2s_legacy.c:559

i2s_delete_dma_buffer()

i2s_delete_dma_buffer()::dma_obj

static esp_err_t i2s_alloc_dma_buffer(i2s_port_t i2s_num, i2s_dma_t *dma_obj)

i2s_legacy.c:577

i2s_alloc_dma_buffer()

i2s_alloc_dma_buffer()::dma_obj

static esp_err_t i2s_realloc_dma_buffer(i2s_port_t i2s_num, i2s_dma_t *dma_obj)

i2s_legacy.c:623

i2s_realloc_dma_buffer()

i2s_realloc_dma_buffer()::dma_obj

static esp_err_t i2s_destroy_dma_object(i2s_port_t i2s_num, i2s_dma_t **dma)

i2s_legacy.c:635

i2s_destroy_dma_object()

i2s_destroy_dma_object()::dma

i2s_legacy.c:659

i2s_destroy_dma_object()

static esp_err_t i2s_create_dma_object(i2s_port_t i2s_num, i2s_dma_t **dma)

i2s_legacy.c:665

i2s_create_dma_object()

i2s_create_dma_object()::dma

*dma = (i2s_dma_t *) calloc(1, sizeof(i2s_dma_t));

i2s_legacy.c:671

i2s_create_dma_object()

i2s_private.h:127

i2s_dma_t dma; /*!< i2s dma object */

i2s_private.h:157

i2s_channel_obj_t

i2s_channel_obj_t::dma

Call Tree

All items filtered out

All items filtered out

Data Use

All items filtered out

All items filtered out

Class Tree

All items filtered out

All items filtered out

Override Tree

All items filtered out

All items filtered out

Implementations

All items filtered out

All items filtered out

Lifecycle

i2s_dma_t is allocated by 1 symbol and is freed by 1 symbol:

i2s_create_dma_object()

i2s_dma_t

i2s_destroy_dma_object()