xref: /aosp_15_r20/external/pigweed/pw_malloc_freertos/docs.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1*61c4878aSAndroid Build Coastguard Worker.. _module-pw_malloc_freertos:
2*61c4878aSAndroid Build Coastguard Worker
3*61c4878aSAndroid Build Coastguard Worker------------------
4*61c4878aSAndroid Build Coastguard Workerpw_malloc_freertos
5*61c4878aSAndroid Build Coastguard Worker------------------
6*61c4878aSAndroid Build Coastguard Worker
7*61c4878aSAndroid Build Coastguard Worker``pw_malloc_freertos`` implements the ``pw_malloc`` facade using the FreeRTOS
8*61c4878aSAndroid Build Coastguard Workerheap functions.
9*61c4878aSAndroid Build Coastguard Worker
10*61c4878aSAndroid Build Coastguard Worker- It implements an :ref:`module-pw_allocator-api-allocator` using the
11*61c4878aSAndroid Build Coastguard Worker  ``pvPortMalloc`` and ``vPortFree`` heap functions from
12*61c4878aSAndroid Build Coastguard Worker  `FreeRTOS <https://www.freertos.org/a00111.html>`_.
13*61c4878aSAndroid Build Coastguard Worker- It implements a :ref:`module-pw_malloc` backend using its ``Allocator``.
14*61c4878aSAndroid Build Coastguard Worker
15*61c4878aSAndroid Build Coastguard Worker  - The ``pw::malloc::InitSystemAllocator`` method is trivally empty as FreeRTOS
16*61c4878aSAndroid Build Coastguard Worker    defines its own heap variable storage.
17