Symbols

Files

Summary Syntax Arguments References Call Tree Data Use

SourceVuESP-IDF Framework and ExamplesESP-IDFi2c_slave_read_buffer()

i2c_slave_read_buffer() function

Read bytes from I2C internal buffer. When the I2C bus receives data, the ISR will copy them from the hardware RX FIFO to the internal ringbuffer. Calling this function will then copy bytes from the internal ringbuffer to the `data` user buffer.

Syntax

Show:

Summary

Declaration

Definition

from i2c.h:449

int i2c_slave_read_buffer(i2c_port_t i2c_num, uint8_t *data, size_t max_size, TickType_t ticks_to_wait);

Implemented in i2c.c:1673

Arguments

Argument

Description

i2c_num

I2C port number

data

Buffer to fill with ringbuffer's bytes

max_size

Maximum bytes to read

ticks_to_wait

Maximum waiting ticks

Return value

- ESP_FAIL(-1) Parameter error - Others(>=0) The number of data bytes read from I2C slave buffer.

Notes

This function shall only be called in I2C slave mode.

References

Code

Location

int i2c_slave_read_buffer(i2c_port_t i2c_num, uint8_t *data, size_t max_size, TickType_t ticks_to_wait)

i2c.c:1673

int i2c_slave_read_buffer(i2c_port_t i2c_num, uint8_t *data, size_t max_size, TickType_t ticks_to_wait);

i2c.h:449

Call Tree

i2c_slave_read_buffer() calls 10 functions:

i2c_slave_read_buffer()

xQueueSemaphoreTake()

xRingbufferReceiveUpTo()

vRingbufferReturnItem()

i2c_ll_slave_enable_rx_it()

Data Use

i2c_slave_read_buffer() reads 16 variables:

esp_log_level_t::ESP_LOG_ERROR

esp_log_level_t::ESP_LOG_WARN

esp_log_level_t::ESP_LOG_INFO

esp_log_level_t::ESP_LOG_DEBUG

esp_log_level_t::ESP_LOG_VERBOSE

i2c_port_t::I2C_NUM_MAX

i2c_mode_t::I2C_MODE_SLAVE

i2c_hal_context_t::dev

I2C_TAG

i2c_obj_t::mode

i2c_obj_t::slv_rx_mux

i2c_obj_t::rx_ring_buf

i2c_context_t::hal

i2c_context_t::spinlock

i2c_context

p_i2c_obj

i2c_slave_read_buffer()

Class Tree

All items filtered out

Override Tree

All items filtered out

Implementations

All items filtered out

Instances

Lifecycle

All items filtered out