Symbols

loading (1/5)...

Files

loading (3/5)...

Summary Syntax Arguments References Call Tree Data Use

SourceVuESP-IDF Framework and ExamplesESP-IDFxRingbufferReceiveUpToFromISR()

xRingbufferReceiveUpToFromISR() function

Retrieve bytes from a byte buffer, specifying the maximum amount of bytes to retrieve. Call this from an ISR. Attempt to retrieve bytes from a byte buffer whilst specifying a maximum number of bytes to retrieve. This function will return immediately if there is no data available for retrieval.

Syntax

Show:

Summary

Declaration

Definition

from ringbuf.h:363

void *xRingbufferReceiveUpToFromISR(RingbufHandle_t xRingbuffer, size_t *pxItemSize, size_t xMaxSize);

Implemented in ringbuf.c:1187

Arguments

Argument

Declared as

Description

xRingbuffer

RingbufHandle_t

Ring buffer to retrieve the item from

pxItemSize

size_t *

Pointer to a variable to which the size of the retrieved item will be written.

xMaxSize

size_t

Maximum number of bytes to return. Size of 0 simply returns NULL.

Return value

- Pointer to the retrieved item on success; *pxItemSize filled with the length of the item. - NULL when the ring buffer is empty, *pxItemSize is untouched in that case.

Notes

A call to vRingbufferReturnItemFromISR() is required after this to free up the data received. This function should only be called on byte buffers Byte buffers do not allow multiple retrievals before returning an item

References

Code

Location

Referrer

void *xRingbufferReceiveUpToFromISR(RingbufHandle_t xRingbuffer, size_t *pxItemSize, size_t xMaxSize)

ringbuf.c:1187

void *xRingbufferReceiveUpToFromISR(RingbufHandle_t xRingbuffer, size_t *pxItemSize, size_t xMaxSize);

ringbuf.h:363

uint8_t *old_data = xRingbufferReceiveUpToFromISR(adc_digi_ctx->ringbuf_hdl, &actual_size, adc_digi_ctx->ringbuf_size);

adc_continuous.c:98

adc_dma_intr()

uint8_t *data = (uint8_t *) xRingbufferReceiveUpToFromISR(p_i2c->tx_ring_buf, &size, tx_fifo_rem);

i2c.c:617

i2c_isr_handler_default()

uint8_t *data = (uint8_t *) xRingbufferReceiveUpToFromISR(i2c_slave->tx_ring_buf, &size, tx_fifo_rem);

i2c_slave.c:98

s_i2c_handle_tx_fifo_wm()

rx_data = (uint8_t *)xRingbufferReceiveUpToFromISR(i2c_slave->rx_ring_buf, &actual_size, read_size);

i2c_slave_v2.c:51

i2c_slave_read_rx()

data = xRingbufferReceiveUpToFromISR(i2c_slave->tx_ring_buf, &actual_get_len, fifo_len);

i2c_slave_v2.c:75

i2c_slave_handle_tx_fifo()

Call Tree

xRingbufferReceiveUpToFromISR() is called by 5 functions and calls 2 functions:

i2c_isr_handler_default()

adc_dma_intr()

s_i2c_handle_tx_fifo_wm()

i2c_slave_read_rx()

i2c_slave_handle_tx_fifo()

xRingbufferReceiveUpToFromISR()

__assert_func()

prvReceiveGenericFromISR()

Data Use

xRingbufferReceiveUpToFromISR() reads 1 variable:

RingbufferDefinition::uxRingbufferFlags

xRingbufferReceiveUpToFromISR()

Class Tree

All items filtered out

Override Tree

All items filtered out

Implementations

All items filtered out

Instances

Lifecycle

All items filtered out