diff options
author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2009-10-17 09:21:59 +0000 |
---|---|---|
committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2009-10-17 09:21:59 +0000 |
commit | 34fd822f84d409fa649934251fae01994de7888b (patch) | |
tree | 095f9c11f7aa2e5f2c0b451c1ba15b08d76f5c47 /os/kernel/kernel.dox | |
parent | a7cfbdaf10a03aa10236958bdba38479b301fc4f (diff) | |
download | ChibiOS-34fd822f84d409fa649934251fae01994de7888b.tar.gz ChibiOS-34fd822f84d409fa649934251fae01994de7888b.tar.bz2 ChibiOS-34fd822f84d409fa649934251fae01994de7888b.zip |
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1226 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/kernel/kernel.dox')
-rw-r--r-- | os/kernel/kernel.dox | 23 |
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
|