Mirrors/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2026-10-01 18:50:34 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs(esp_ringbuf): update ringbuf create API notes

Browse Source
This commit is contained in:
Renz Bagaporo
2026-08-27 09:16:14 +08:00
committed by BOT
parent 430ed1f671
commit 3d5fb897b5
1 changed files with 10 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
components/esp_ringbuf/include/freertos/ringbuf.h
+10 -1
View File
@@ -73,6 +73,7 @@ typedef struct xSTATIC_RINGBUFFER {
* @param[in] xBufferType Type of ring buffer, see documentation.
*
* @note xBufferSize of no-split/allow-split buffers will be rounded up to the nearest 32-bit aligned size.
* The aligned size must be large enough to hold two item headers.
*
* @return A handle to the created ring buffer, or NULL in case of error.
*/
@@ -87,6 +88,9 @@ RingbufHandle_t xRingbufferCreate(size_t xBufferSize, RingbufferType_t xBufferTy
* @param[in] xItemSize Size of each item to be put into the ring buffer
* @param[in] xItemNum Maximum number of items the buffer needs to hold simultaneously
*
* @note Returns NULL if xItemNum is 0, the calculated buffer size overflows,
* or the resulting buffer is too small to hold two item headers.
*
* @return A RingbufHandle_t handle to the created ring buffer, or NULL in case of error.
*/
RingbufHandle_t xRingbufferCreateNoSplit(size_t xItemSize, size_t xItemNum);
@@ -102,8 +106,9 @@ RingbufHandle_t xRingbufferCreateNoSplit(size_t xItemSize, size_t xItemNum);
* which will be used to hold the ring buffer's data structure
*
* @note xBufferSize of no-split/allow-split buffers MUST be 32-bit aligned.
* The aligned size must be large enough to hold two item headers.
*
* @return A handle to the created ring buffer
* @return A handle to the created ring buffer, or NULL in case of error.
*/
RingbufHandle_t xRingbufferCreateStatic(size_t xBufferSize,
RingbufferType_t xBufferType,
@@ -538,6 +543,10 @@ BaseType_t xRingbufferGetStaticBuffer(RingbufHandle_t xRingbuffer, uint8_t **ppu
*
* @note A queue created using this function must only be deleted using
* vRingbufferDeleteWithCaps()
* @note xBufferSize of no-split/allow-split buffers will be rounded up to the
* nearest 32-bit aligned size. The aligned size must be large enough to hold
* two item headers.
*
* @param[in] xBufferSize Size of the buffer in bytes
* @param[in] xBufferType Type of ring buffer, see documentation.
* @param[in] uxMemoryCaps Memory capabilities of the queue's memory (see