perf(Other): Use FreeRTOS Heap Allocation Scheme 4, Allow Changing FreeRTOS Heap Allocation Scheme #1052
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…mmended by FreeRTOS as an updated alternate to heap_2 for avoiding heap fragmentation -Added FREERTOS_HEAP_TYPE compile time macro to select the heap allocation method. -Added an entry for FREERTOS_HEAP_TYPE in MAX78000's FreeRTOSDemo project.mk
Jake-Carter
suggested changes
Jun 25, 2024
| @@ -16,6 +16,11 @@ DEBUG=1 | |||
|
|
|||
| LIB_FREERTOS = 1 | |||
|
|
|||
| # Can provide a value for the FREERTOS heap allocation scheme | |||
There was a problem hiding this comment.
Instead of documenting this here, you can add some info to the UG.
See here for an example for the SDHC library.
The FreeRTOS lib hasn't had any options before, so I'd suggest adding a similar table
There was a problem hiding this comment.
Good idea! I'll update once this has been added.
There was a problem hiding this comment.
Should be good now 👍
Jake-Carter
approved these changes
Jul 1, 2024
Jake-Carter
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
FreeRTOS gives some flexibility in the memory allocation scheme used to allow optimizing size/speed/heap fragmentation risk. The FreeRTOS documentation indicates that heap_2.c is considered outdated, and that applications should at a minimum use heap_4 as an alternative. Heap 4 uses a smarter allocation algorithm for avoiding heap fragmentation (first-fit algorithm + aggregates free RAM segments).
Sources for info:
https://www.freertos.org/a00111.html
https://github.com/FreeRTOS/FreeRTOS-Kernel-Book/blob/main/ch03.md
Summary of Changes
This would (positively) affect the way FreeRTOS builds for all supported MCUs.
Tests
Tested library builds with all 5 different heap types using FreeRTOSDemo for MAX78000 as the test source code. Example builds with the appropriate heap files based on the new FREERTOS_HEAP_TYPE macro. If the macro is not defined in project.mk, the library builds with heap_4.c by default.
Checklist Before Requesting Review