zephyr/doc/kernel/memory_management/index.rst

.. _memory_management_api:

Memory Management
#################

The following contains various topics regarding memory management.

.. toctree::
   :maxdepth: 1

   heap.rst
   shared_multi_heap.rst
   slabs.rst
   sys_mem_blocks.rst
   demand_paging.rst
   virtual_memory.rst
doc: add some bits about demand paging This adds some information about demand paging in Zephyr. Signed-off-by: Daniel Leung <daniel.leung@intel.com> 2021-05-12 18:59:16 +02:00			`.. _memory_management_api:`

			`Memory Management`
			`#################`

			`The following contains various topics regarding memory management.`

			`.. toctree::`
			`:maxdepth: 1`

doc: kernel: Re-organise memory management API pages The kernel documentation listed the memory management API pages under two different sections: 'Kernel/Kernel Services' and 'Kernel/Memory Management' -- this creates unnecessary confusion and makes it hard to look up all supported kernel memory management APIs. This commit relocates the memory management API pages under 'Kernel/Kernel Services' to 'Kernel/Memory Management' so that all memory management APIs provided by the kernel are described in one unified section. The link to the 'Kernel/Memory Management' index page is still left in the 'Kernel Services' page because it may still be helpful to look at it as part of the services provided by the Zephyr kernel -- it is just more substantial than the rest and deserves more visibility. Signed-off-by: Stephanos Ioannidis <root@stephanos.io> 2022-05-31 05:44:44 +02:00			`heap.rst`
multi_heap: Introduce shared multi-heap memory pool manager The shared multi-heap memory pool manager uses the multi-heap allocator to manage a set of reserved memory regions with different capabilities / attributes (cacheable, non-cacheable, etc...) defined in the DT. The user can request allocation from the shared pool specifying the capability / attribute of interest for the memory (cacheable / non-cacheable memory, etc...) Signed-off-by: Carlo Caione <ccaione@baylibre.com> 2021-09-23 17:51:25 +02:00			`shared_multi_heap.rst`
doc: kernel: Re-organise memory management API pages The kernel documentation listed the memory management API pages under two different sections: 'Kernel/Kernel Services' and 'Kernel/Memory Management' -- this creates unnecessary confusion and makes it hard to look up all supported kernel memory management APIs. This commit relocates the memory management API pages under 'Kernel/Kernel Services' to 'Kernel/Memory Management' so that all memory management APIs provided by the kernel are described in one unified section. The link to the 'Kernel/Memory Management' index page is still left in the 'Kernel Services' page because it may still be helpful to look at it as part of the services provided by the Zephyr kernel -- it is just more substantial than the rest and deserves more visibility. Signed-off-by: Stephanos Ioannidis <root@stephanos.io> 2022-05-31 05:44:44 +02:00			`slabs.rst`
doc: add a page for the new memory blocks allocator This adds a page for the new memory blocks allocator, describing what it is and how to use it. Signed-off-by: Daniel Leung <daniel.leung@intel.com> 2021-11-24 22:15:30 +01:00			`sys_mem_blocks.rst`
doc: kernel: Re-organise memory management API pages The kernel documentation listed the memory management API pages under two different sections: 'Kernel/Kernel Services' and 'Kernel/Memory Management' -- this creates unnecessary confusion and makes it hard to look up all supported kernel memory management APIs. This commit relocates the memory management API pages under 'Kernel/Kernel Services' to 'Kernel/Memory Management' so that all memory management APIs provided by the kernel are described in one unified section. The link to the 'Kernel/Memory Management' index page is still left in the 'Kernel Services' page because it may still be helpful to look at it as part of the services provided by the Zephyr kernel -- it is just more substantial than the rest and deserves more visibility. Signed-off-by: Stephanos Ioannidis <root@stephanos.io> 2022-05-31 05:44:44 +02:00			`demand_paging.rst`
doc: kernel/mm: add a page about virtual memory This adds a page about virtual memory under kernel's memory management. Signed-off-by: Daniel Leung <daniel.leung@intel.com> 2023-11-22 01:09:00 +01:00			`virtual_memory.rst`