Symbols

loading (4/5)...

Files

loading (4/5)...

Summary Syntax Arguments References Call Tree Data Use

SourceVuESP-IDF Framework and ExamplesESP-IDFi2c_cmd_link_create_static()

i2c_cmd_link_create_static() function

Create and initialize an I2C commands list with a given buffer. All the allocations for data or signals (START, STOP, ACK, ...) will be performed within this buffer. This buffer must be valid during the whole transaction. After finishing the I2C transactions, it is required to call `i2c_cmd_link_delete_static()`.

Syntax

Show:

Summary

Declaration

Definition

i2c_cmd_handle_t i2c_cmd_link_create_static(uint8_t* buffer, uint32_t size);

Implemented in i2c.c:1147

Arguments

Argument

Description

buffer

Buffer to use for commands allocations

size

Size in bytes of the buffer

Return value

Handle to the I2C command link or NULL if the buffer provided is too small, please use `I2C_LINK_RECOMMENDED_SIZE` macro to get the recommended size for the buffer.

Notes

It is **highly** advised to not allocate this buffer on the stack. The size of the data used underneath may increase in the future, resulting in a possible stack overflow as the macro `I2C_LINK_RECOMMENDED_SIZE` would also return a bigger value. A better option is to use a buffer allocated statically or dynamically (with `malloc`).

References

Code

Location

Referrer

i2c_cmd_handle_t i2c_cmd_link_create_static(uint8_t* buffer, uint32_t size)

i2c_cmd_handle_t i2c_cmd_link_create_static(uint8_t* buffer, uint32_t size);

i2c_cmd_handle_t cmd_link = i2c_cmd_link_create_static(i2c_panel_io->cmdlink_buffer, CMD_HANDLER_BUFFER_SIZE);

esp_lcd_panel_io_i2c_v1.c:117

panel_io_i2c_rx_buffer()

i2c_cmd_handle_t cmd_link = i2c_cmd_link_create_static(i2c_panel_io->cmdlink_buffer, CMD_HANDLER_BUFFER_SIZE);

esp_lcd_panel_io_i2c_v1.c:158

panel_io_i2c_tx_buffer()

i2c_cmd_handle_t handle = i2c_cmd_link_create_static(buffer, sizeof(buffer));

i2c_master_write_to_device()

i2c_cmd_handle_t handle = i2c_cmd_link_create_static(buffer, sizeof(buffer));

i2c_master_read_from_device()

i2c_cmd_handle_t handle = i2c_cmd_link_create_static(buffer, sizeof(buffer));

i2c_master_write_read_device()

Call Tree

i2c_cmd_link_create_static() is called by 5 functions:

i2c_master_write_to_device()

i2c_master_read_from_device()

i2c_master_write_read_device()

panel_io_i2c_rx_buffer()

panel_io_i2c_tx_buffer()

i2c_cmd_link_create_static()

Data Use

i2c_cmd_link_create_static() writes 5 variables:

i2c_cmd_link_create_static()

i2c_cmd_desc_t::head

i2c_cmd_desc_t::cur

i2c_cmd_desc_t::free

i2c_cmd_desc_t::free_buffer

i2c_cmd_desc_t::free_size

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

Lifecycle

All items filtered out

All items filtered out