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