Symbols

loading...

Files

loading...

Summary Syntax Related References Instances Lifecycle

SourceVuESP-IDF Framework and ExamplesESP-IDFi2s_controller_t

i2s_controller_t struct

i2s controller level configurations

Syntax

Show:

Summary

Declaration

from i2s_private.h:133

typedef struct { i2s_port_t id; i2s_hal_context_t hal; uint32_t chan_occupancy; bool full_duplex; i2s_chan_handle_t tx_chan; i2s_chan_handle_t rx_chan; _lock_t mutex; #if SOC_I2S_SUPPORT_SLEEP_RETENTION sleep_retention_module_t slp_retention_mod; bool retention_link_created; #endif int mclk; #if CONFIG_IDF_TARGET_ESP32 esp_clock_output_mapping_handle_t mclk_out_hdl; #endif } i2s_controller_t;

Fields

Field

Declared as

Description

i2s_controller_t::id

i2s port id.

i2s_controller_t::hal

i2s_hal_context_t

hal context.

i2s_controller_t::chan_occupancy

uint32_t

channel occupancy (rx/tx).

i2s_controller_t::full_duplex

bool

is full_duplex.

i2s_controller_t::tx_chan

i2s_chan_handle_t

tx channel handler.

i2s_controller_t::rx_chan

i2s_chan_handle_t

rx channel handler.

i2s_controller_t::mutex

_lock_t

mutex for controller.

i2s_controller_t::mclk

int

MCK out pin, shared by tx/rx.

i2s_controller_t::mclk_out_hdl

esp_clock_output_mapping_handle_t

The handle of MCLK output signal.

References

Code

Location

Scope

Referrer

typedef struct {

i2s_private.h:133

} i2s_controller_t;

i2s_private.h:149

static esp_err_t i2s_destroy_controller_obj(i2s_controller_t **i2s_obj)

i2s_common.c:193

i2s_destroy_controller_obj()

i2s_destroy_controller_obj()::i2s_obj

free(*i2s_obj);

i2s_common.c:217

i2s_destroy_controller_obj()

static i2s_controller_t *i2s_acquire_controller_obj(int id)

i2s_common.c:232

i2s_acquire_controller_obj()

i2s_controller_t *pre_alloc = (i2s_controller_t *)heap_caps_calloc(1, sizeof(i2s_controller_t), I2S_MEM_ALLOC_CAPS);

i2s_common.c:238

i2s_acquire_controller_obj()

i2s_controller_t *i2s_obj = NULL;

i2s_common.c:249

i2s_acquire_controller_obj()

free(pre_alloc);

i2s_common.c:281

i2s_acquire_controller_obj()

static inline bool i2s_take_available_channel(i2s_controller_t *i2s_obj, uint8_t chan_search_mask)

i2s_common.c:295

i2s_take_available_channel()

i2s_take_available_channel()::i2s_obj

static esp_err_t i2s_register_channel(i2s_controller_t *i2s_obj, i2s_dir_t dir, uint32_t desc_num)

i2s_common.c:314

i2s_register_channel()

i2s_register_channel()::i2s_obj

i2s_controller_t *i2s_obj = NULL;

i2s_common.c:949

i2s_new_channel()

i2s_controller_t *i2s_obj = handle->controller;

i2s_common.c:1030

i2s_del_channel()

} i2s_controller_t;

i2s_private.h:149

i2s_controller_t

i2s_controller_t *controller; /*!< Parent pointer to controller object */

i2s_private.h:153

i2s_channel_obj_t

i2s_channel_obj_t::controller

i2s_controller_t *controller[SOC_I2S_NUM]; /*!< Controller object */

i2s_private.h:217

i2s_platform_t::controller

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

Instances

Instance

Scope

Location

Project

i2s_channel_obj_t::controller

i2s_channel_obj_t

i2s_private.h:153

i2s_platform_t::controller

i2s_private.h:217

i2s_destroy_controller_obj()::i2s_obj

i2s_destroy_controller_obj()

i2s_common.c:193

return

i2s_acquire_controller_obj()

i2s_common.c:232

i2s_take_available_channel()::i2s_obj

i2s_take_available_channel()

i2s_common.c:295

i2s_register_channel()::i2s_obj

i2s_register_channel()

i2s_common.c:314

Lifecycle

i2s_controller_t is freed by 2 symbols:

i2s_controller_t

i2s_destroy_controller_obj()

i2s_acquire_controller_obj()