espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-02 12:14:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add a note to specify that two calls to RingbufferReceive are required in wrap mode

Browse Source
This commit is contained in:
Wang Fang
2020-08-10 18:25:51 +08:00
parent cda9c595d7
commit ee135b8e28
2 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
components/esp_ringbuf/include/freertos/ringbuf.h
View File

@@ -255,6 +255,7 @@ void *xRingbufferReceive(RingbufHandle_t xRingbuffer, size_t *pxItemSize, TickTy
* *
* @note A call to vRingbufferReturnItemFromISR() is required after this to free the item retrieved. * @note A call to vRingbufferReturnItemFromISR() is required after this to free the item retrieved.
* @note Byte buffers do not allow multiple retrievals before returning an item * @note Byte buffers do not allow multiple retrievals before returning an item
* @note Two calls to RingbufferReceiveFromISR() are required if the bytes wrap around the end of the ring buffer.
* *
* @return * @return
* - Pointer to the retrieved item on success; *pxItemSize filled with the length of the item. * - Pointer to the retrieved item on success; *pxItemSize filled with the length of the item.
@@ -333,6 +334,7 @@ BaseType_t xRingbufferReceiveSplitFromISR(RingbufHandle_t xRingbuffer,
* @note A call to vRingbufferReturnItem() is required after this to free up the data retrieved. * @note A call to vRingbufferReturnItem() is required after this to free up the data retrieved.
* @note This function should only be called on byte buffers * @note This function should only be called on byte buffers
* @note Byte buffers do not allow multiple retrievals before returning an item * @note Byte buffers do not allow multiple retrievals before returning an item
* @note Two calls to RingbufferReceiveUpTo() are required if the bytes wrap around the end of the ring buffer.
* *
* @return * @return
* - Pointer to the retrieved item on success; *pxItemSize filled with * - Pointer to the retrieved item on success; *pxItemSize filled with

3
docs/en/api-reference/system/freertos_additions.rst
View File

@@ -210,6 +210,9 @@ using :cpp:func:`xRingbufferReceiveUpTo` and :cpp:func:`vRingbufferReturnItem`
For ISR safe versions of the functions used above, call :cpp:func:`xRingbufferSendFromISR`, :cpp:func:`xRingbufferReceiveFromISR`, For ISR safe versions of the functions used above, call :cpp:func:`xRingbufferSendFromISR`, :cpp:func:`xRingbufferReceiveFromISR`,
:cpp:func:`xRingbufferReceiveSplitFromISR`, :cpp:func:`xRingbufferReceiveUpToFromISR`, and :cpp:func:`vRingbufferReturnItemFromISR` :cpp:func:`xRingbufferReceiveSplitFromISR`, :cpp:func:`xRingbufferReceiveUpToFromISR`, and :cpp:func:`vRingbufferReturnItemFromISR`
.. note::
Two calls to RingbufferReceive[UpTo][FromISR]() are required if the bytes wraps around the end of the ring buffer.
Sending to Ring Buffer Sending to Ring Buffer
^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^