4bfa30967f
This fixes multiple bugs with ring buffers and re-factors the code. The public
API has not changed, however the underlying implementation have various private
functions have been changed. The following behavioral changes have been made
- Size of ring buffers for No-Split/Allow-Split buffers will not be rounded
up to the nearest 32-bit aligned size. This was done to simplify the
implementation
- Item size for No-Split/Allow-Split buffers will also be rounded up to the
nearest 32-bit aligned size.
The following bugs have been fixed
- In copyItemToRingbufAllowSplit(), when copying an item where the aligned
size is smaller than the remaining length, the function does not consider
the case where the true size of the item is less than 4 bytes.
- The copy functions will automatically wrap around the write pointers when
the remaining length of the buffer is not large enough to fit a header, but
does not consider if wrapping around will cause an overlap with the read
pointer. This will make a full buffer be mistaken for an empty buffer
closes #1711
- xRingbufferSend() can get stuck in a infinite loop when the size of the
free memory is larger than the needed_size, but too small to fit in the ring
buffer due to alignment and extra overhead of wrapping around.
closes #1846
- Fixed documentation with ring buffer queue set API
- Adding and removing from queue set does not consider the case where the
read/write semaphores actually hold a value.
The following functions have been deprecated
- xRingbufferIsNextItemWrapped() due to lack of thread safety
- xRingbufferAddToQueueSetWrite() and xRingbufferRemoveFromQueueSetWrite()
as adding the queue sets only work under receive operations.
The following functions have been added
- xRingbufferReceiveSplit() and xRingbufferReceiveSplitFromISR() as a thread
safe way to receive from allow-split buffers
- vRingbufferGetInfo()
Documentation for ring buffers has also been added.
40 lines
686 B
ReStructuredText
40 lines
686 B
ReStructuredText
FreeRTOS
|
|
========
|
|
|
|
Overview
|
|
--------
|
|
|
|
This section contains documentation of FreeRTOS types, functions, and macros. It is automatically generated from FreeRTOS header files.
|
|
|
|
For more information about FreeRTOS features specific to ESP-IDF, see :doc:`ESP-IDF FreeRTOS SMP Changes<../../api-guides/freertos-smp>`
|
|
and :doc:`ESP-IDF FreeRTOS Additions<freertos_additions>`.
|
|
|
|
|
|
Task API
|
|
--------
|
|
|
|
.. include:: /_build/inc/task.inc
|
|
|
|
Queue API
|
|
---------
|
|
|
|
.. include:: /_build/inc/queue.inc
|
|
|
|
Semaphore API
|
|
-------------
|
|
|
|
.. include:: /_build/inc/semphr.inc
|
|
|
|
Timer API
|
|
---------
|
|
|
|
.. include:: /_build/inc/timers.inc
|
|
|
|
|
|
Event Group API
|
|
---------------
|
|
|
|
.. include:: /_build/inc/event_groups.inc
|
|
|
|
|