alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-07 20:00:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'docs/Specify_two_calls_to_RingbufferReceive_is_required_in_wrap_mode' into 'master'

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

Closes IDF-1980

See merge request espressif/esp-idf!9999
This commit is contained in:
Krzysztof Budzynski
2020-08-19 20:00:27 +08:00
parent 9e45dca650 ee135b8e28
commit 6c17e3a64c
2 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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`,
: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
^^^^^^^^^^^^^^^^^^^^^^