Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
OVMS3-idf/docs/_static
History
Darian Leung 4bfa30967f freeRTOS/Re-factor ring buffers 
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.
2018-05-21 01:04:58 +00:00
..
diagrams/ring-buffer freeRTOS/Re-factor ring buffers 2018-05-21 01:04:58 +00:00
about-doc.png docs: Generate Doxygen directives for API documentation 2017-05-19 18:26:02 +02:00
adc-noise-graph.jpg esp_adc_cal/Add eFuse functionality 2018-02-13 21:22:48 +08:00
adc-vref-graph.jpg esp_adc_cal/Add eFuse functionality 2018-02-13 21:22:48 +08:00
api-guides.gif Getting started guides 2017-04-27 19:51:42 +02:00
api-reference.gif Getting started guides 2017-04-27 19:51:42 +02:00
app_trace-overview.jpg Trace collection command examples 2017-08-05 16:54:58 +02:00
contribute.gif Getting started guides 2017-04-27 19:51:42 +02:00
debug-perspective.jpg JTAG Debugging - revamping of Debugging documentation 2017-07-26 14:53:43 +08:00
debugging-memory-location-off.jpg JTAG Debugging - revamping of Debugging documentation 2017-07-26 14:53:43 +08:00
debugging-memory-location-on.jpg JTAG Debugging - revamping of Debugging documentation 2017-07-26 14:53:43 +08:00
debugging-navigate-through-the-stack.jpg JTAG Debugging - revamping of Debugging documentation 2017-07-26 14:53:43 +08:00
debugging-setting-breakpoint.jpg JTAG Debugging - revamping of Debugging documentation 2017-07-26 14:53:43 +08:00
debugging-setting-conditional-breakpoint.jpg JTAG Debugging - revamping of Debugging documentation 2017-07-26 14:53:43 +08:00
debugging-step-into.jpg JTAG Debugging - revamping of Debugging documentation 2017-07-26 14:53:43 +08:00
debugging-step-over.jpg JTAG Debugging - revamping of Debugging documentation 2017-07-26 14:53:43 +08:00
debugging-target-halted-manually.jpg JTAG Debugging - revamping of Debugging documentation 2017-07-26 14:53:43 +08:00
debugging-target-halted.jpg JTAG Debugging - revamping of Debugging documentation 2017-07-26 14:53:43 +08:00
debugging-three-breakpoints-set.jpg JTAG Debugging - revamping of Debugging documentation 2017-07-26 14:53:43 +08:00
debugging-watch-variable.jpg JTAG Debugging - revamping of Debugging documentation 2017-07-26 14:53:43 +08:00
DejaVuSans.license Implement ‘blockdiag - simple block-diagram image generator’ to illustrate documentation with block diagrams, sequence diagrams, activity diagrams and logical network diagrams 2017-11-07 18:17:53 +01:00
DejaVuSans.ttf Implement ‘blockdiag - simple block-diagram image generator’ to illustrate documentation with block diagrams, sequence diagrams, activity diagrams and logical network diagrams 2017-11-07 18:17:53 +01:00
doc-code-documentation-inline.png doc: Documenting Code clean up 2016-11-21 10:24:12 +08:00
doc-code-documentation-rendered.png Guide on documenting code 2016-11-01 01:21:18 +08:00
doc-code-function.png Guide on documenting code 2016-11-01 01:21:18 +08:00
doc-code-member.png Guide on documenting code 2016-11-01 01:21:18 +08:00
doc-code-void-function.png Getting started guides 2017-04-27 19:51:42 +02:00
esp-wrover-kit-v2-layout-back.png ESP-WROVER-KIT now integrates the ESP32-WROVER module by default. But it is still compatible with both ESP-WROOM-32 and ESP32-WROVER. The latest baseboard is still V3. The original 'ESP-WROVER-KIT' that integrates ESP-WROOM-32 is unlikely to be produced any longer, while the original 'ESP-WROVER-KIT-RVB' is renamed as “ESP-WROVER-KIT” and in mass production. 2017-08-19 21:16:00 +02:00
esp-wrover-kit-v2-layout-front.png ESP-WROVER-KIT now integrates the ESP32-WROVER module by default. But it is still compatible with both ESP-WROOM-32 and ESP32-WROVER. The latest baseboard is still V3. The original 'ESP-WROVER-KIT' that integrates ESP-WROOM-32 is unlikely to be produced any longer, while the original 'ESP-WROVER-KIT-RVB' is renamed as “ESP-WROVER-KIT” and in mass production. 2017-08-19 21:16:00 +02:00
esp32-devkitc-dimensions-back.jpg Docs for ESP32 DevKitC V4 2018-01-31 18:31:13 +01:00
esp32-devkitc-functional-overview.jpg Docs for ESP32 DevKitC V4 2018-01-31 18:31:13 +01:00
esp32-devkitc-in-device-manager.png Getting started guides 2017-04-27 19:51:42 +02:00
esp32-devkitc-v2-functional-overview.png Docs for ESP32 DevKitC V4 2018-01-31 18:31:13 +01:00
esp32-pico-kit-v3-layout.jpg ESP32-PICO-KIT V4 Getting Started Guide 2017-10-20 22:49:59 +02:00
esp32-pico-kit-v4-dimensions-back.jpg Pin descriptions, overview diagram and board dimensions carried over from ESP32-PICO-KIT_Datasheet_EN.pdf. The datasheet looks redundant and will not be used. 2017-12-05 22:03:38 +01:00
esp32-pico-kit-v4-dimensions-side.jpg Pin descriptions, overview diagram and board dimensions carried over from ESP32-PICO-KIT_Datasheet_EN.pdf. The datasheet looks redundant and will not be used. 2017-12-05 22:03:38 +01:00
esp32-pico-kit-v4-functional-block-diagram.png Pin descriptions, overview diagram and board dimensions carried over from ESP32-PICO-KIT_Datasheet_EN.pdf. The datasheet looks redundant and will not be used. 2017-12-05 22:03:38 +01:00
esp32-pico-kit-v4-layout.jpg Pin descriptions, overview diagram and board dimensions carried over from ESP32-PICO-KIT_Datasheet_EN.pdf. The datasheet looks redundant and will not be used. 2017-12-05 22:03:38 +01:00
esp32-wrover-kit-block-diagram.png Getting started guides 2017-04-27 19:51:42 +02:00
esp32-wrover-kit-in-device-manager.png Getting started guides 2017-04-27 19:51:42 +02:00
esp32-wrover-kit-layout-back.jpg Layout of esp-wrover-kit updated to v3 2017-07-05 21:21:54 +02:00
esp32-wrover-kit-layout-front.jpg Updated desription of ESP-WROVER-KIT features in getting started guide, changed link to JTAG Debugging 2017-08-02 06:57:28 +02:00
freertos-ready-task-list-smp-pxIndex.png docs: Added documentation for FreeRTOS SMP changes 2017-09-21 16:40:57 +08:00
freertos-ready-task-list-smp.png docs: Added documentation for FreeRTOS SMP changes 2017-09-21 16:40:57 +08:00
freertos-ready-task-list.png docs: Added documentation for FreeRTOS SMP changes 2017-09-21 16:40:57 +08:00
get-started.gif Getting started guides 2017-04-27 19:51:42 +02:00
hw-debugging-debugger-tab.jpg JTAG Debugging - revamping of Debugging documentation 2017-07-26 14:53:43 +08:00
hw-debugging-main-tab.jpg JTAG Debugging - revamping of Debugging documentation 2017-07-26 14:53:43 +08:00
hw-debugging-startup-tab.jpg JTAG Debugging - revamping of Debugging documentation 2017-07-26 14:53:43 +08:00
hw-reference.gif Getting started guides 2017-04-27 19:51:42 +02:00
jtag-debugging-overview.jpg JTAG Debugging - revamping of Debugging documentation 2017-07-26 14:53:43 +08:00
jtag-usb-configuration-zadig.jpg JTAG Debugging - revamping of Debugging documentation 2017-07-26 14:53:43 +08:00
ledc-api-settings.jpg Provided more meaningful parameter names by renaming 'bit_num' to 'duty_resolution' and 'div_num' to 'clock_divider' 2017-11-15 08:08:12 +01:00
linux-logo.png Getting started guides 2017-04-27 19:51:42 +02:00
macos-logo.png Getting started guides 2017-04-27 19:51:42 +02:00
mesh_events_delivery.png add mesh feature 2018-04-04 22:57:45 +08:00
mesh_network_architecture.png add mesh feature 2018-04-04 22:57:45 +08:00
mesh_network_topology.png add mesh feature 2018-04-04 22:57:45 +08:00
mesh_software_stack.png add mesh feature 2018-04-04 22:57:45 +08:00
msys2-terminal-window.png Updated get started instructions for windows following https://esp32.com/viewtopic.php?f=13&t=4232 2018-03-14 19:26:59 +01:00
project-configuration.png Getting started guides 2017-04-27 19:51:42 +02:00
putty-settings-linux.png Getting started guides 2017-04-27 19:51:42 +02:00
putty-settings-windows.png Getting started guides 2017-04-27 19:51:42 +02:00
resources.gif Getting started guides 2017-04-27 19:51:42 +02:00
rmt-carrier.png RMT transmitter and receiver overview pictures 2017-11-24 21:33:50 +01:00
rmt-waveform-modulated.png RMT transmitter and receiver overview pictures 2017-11-24 21:33:50 +01:00
rmt-waveform.png RMT transmitter and receiver overview pictures 2017-11-24 21:33:50 +01:00
theme_overrides.css ReadTheDocs theme has an annoying bug of text not being wrapped inside table cells. Each row is extended to fit the text as a single line. For a table with multiple columns and long sentences the table may get wide, with long scrollbar underneath and is not convenient to read. This MR makes the text wrap inside table cells. There is an open PR to fix this issue - https://github.com/rtfd/sphinx_rtd_theme/pull/432. 2018-04-09 05:47:36 +02:00
touch_pad-measurement-parameters.jpg Implemented 2 of 3 review comments 2017-09-05 08:28:44 +02:00
what-you-need.png Getting started guides 2017-04-27 19:51:42 +02:00
windows-logo.png Getting started guides 2017-04-27 19:51:42 +02:00
wrover-jp1-both.png Getting started guides 2017-04-27 19:51:42 +02:00
wrover-jp1-sd_io2.png Getting started guides 2017-04-27 19:51:42 +02:00
wrover-jp7-ext_5v.png Getting started guides 2017-04-27 19:51:42 +02:00
wrover-jp7-usb_5v.png Getting started guides 2017-04-27 19:51:42 +02:00
wrover-jp8.png JTAG Debugging - revamping of Debugging documentation 2017-07-26 14:53:43 +08:00
wrover-jp11-tx-rx.png Getting started guides 2017-04-27 19:51:42 +02:00
wrover-jp14.png Getting started guides 2017-04-27 19:51:42 +02:00