Symbols

loading (4/5)...

Files

loading (4/5)...

Summary Syntax Arguments Examples References Call Tree Data Use Lifecycle

SourceVuESP-IDF Framework and ExamplesESP-IDFxRingbufferCreate()

xRingbufferCreate() function

Create a ring buffer

Syntax

Show:

Summary

Declaration

Definition

from ringbuf.h:79

RingbufHandle_t xRingbufferCreate(size_t xBufferSize, RingbufferType_t xBufferType);

Implemented in ringbuf.c:934

Arguments

Argument

Description

xBufferSize

Size of the buffer in bytes. Note that items require space for a header in no-split/allow-split buffers

xBufferType

Type of ring buffer, see documentation.

Return value

A handle to the created ring buffer, or NULL in case of error.

Notes

xBufferSize of no-split/allow-split buffers will be rounded up to the nearest 32-bit aligned size.

Examples

xRingbufferCreate() is referenced by 2 libraries and example projects:

a2dp_sink sample

a2dp_gatts_coex sample

References

from 0/2 examples

Code

Location

Referrer

RingbufHandle_t xRingbufferCreate(size_t xBufferSize, RingbufferType_t xBufferType)

ringbuf.c:934

RingbufHandle_t xRingbufferCreate(size_t xBufferSize, RingbufferType_t xBufferType);

ringbuf.h:79

s_adc_digi_ctx->ringbuf_hdl = xRingbufferCreate(init_config->max_store_buf_size, RINGBUF_TYPE_BYTEBUF);

adc_dma_legacy.c:240

adc_digi_initialize()

if (((*slot)->ringbuf_write = xRingbufferCreate(spp_local_param.tx_buffer_size, RINGBUF_TYPE_BYTEBUF)) == NULL) {

btc_spp.c:171

spp_malloc_slot()

p_i2c->rx_ring_buf = xRingbufferCreate(slv_rx_buf_len, RINGBUF_TYPE_BYTEBUF);

i2c.c:345

i2c_driver_install()

p_i2c->tx_ring_buf = xRingbufferCreate(slv_tx_buf_len, RINGBUF_TYPE_BYTEBUF);

i2c.c:356

i2c_driver_install()

return xRingbufferCreate((rbALIGN_SIZE(xItemSize) + rbHEADER_SIZE) * xItemNum, RINGBUF_TYPE_NOSPLIT);

ringbuf.c:961

xRingbufferCreateNoSplit()

p_rmt_obj[channel]->rx_buf = xRingbufferCreate(rx_buf_size, RINGBUF_TYPE_NOSPLIT);

rmt_legacy.c:1070

rmt_driver_install()

Call Tree

from 0/2 examples

xRingbufferCreate() is called by 5 functions and calls 5 functions:

xRingbufferCreateNoSplit()

spp_malloc_slot()

adc_digi_initialize()

xRingbufferCreate()

prvInitializeNewRingbuffer()

Data Use

from 0/2 examples

xRingbufferCreate() reads 2 variables:

RingbufferType_t::RINGBUF_TYPE_BYTEBUF

RingbufferType_t::RINGBUF_TYPE_MAX

xRingbufferCreate()

Class Tree

from 0/2 examples

All items filtered out

Override Tree

from 0/2 examples

All items filtered out

Implementations

from 0/2 examples

All items filtered out

Instances

from 0/2 examples

Lifecycle

from 0/2 examples

xRingbufferCreate() allocates 1 types and frees 1 types:

RingbufferDefinition

xRingbufferCreate()

RingbufferDefinition