aboutsummaryrefslogtreecommitdiffstats
path: root/os/kernel/kernel.dox
diff options
context:
space:
mode:
Diffstat (limited to 'os/kernel/kernel.dox')
-rw-r--r--os/kernel/kernel.dox23
1 files changed, 22 insertions, 1 deletions
diff --git a/os/kernel/kernel.dox b/os/kernel/kernel.dox
index d2936fa14..bd8870279 100644
--- a/os/kernel/kernel.dox
+++ b/os/kernel/kernel.dox
@@ -230,7 +230,28 @@
*/
/**
- * @defgroup heap Heap
+ * @defgroup memcore Core Memory Manager
+ * Core Memory Manager related APIs.
+ * <h2>Operation mode</h2>
+ * The core memory manager is a simplified allocator that only allows to
+ * allocate memory blocks without the possibility to free them.<br>
+ * This allocator is meant as a memory blocks provider for the other
+ * allocators such as:
+ * - C-Runtime allocator.
+ * - Heap allocator (see @ref heaps).
+ * - @ref Memory pools allocator (see @ref pools).
+ * .
+ * By having a centralized memory provider the various allocators can coexist
+ * and share the main memory.<br>
+ * This allocator, alone, is also useful for very simple applications that
+ * just require a simple way to get memory blocks.<br>
+ * In order to use the core memory manager APIs the @p CH_USE_MEMCORE option
+ * must be specified in @p chconf.h.
+ * @ingroup memory
+ */
+
+/**
+ * @defgroup heaps Heaps
* Heap Allocator related APIs.
* <h2>Operation mode</h2>
* The heap allocator implements a first-fit strategy and its APIs are