diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2010-03-16 19:36:21 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2010-03-16 19:36:21 +0000 |
| commit | ad3d21e81592481539a56e93234f5bf1fa2c0504 (patch) | |
| tree | 0e78278235ac7c8324aa3c3a7e7b0193bbd30dc6 /os/kernel/src/chheap.c | |
| parent | 0eed163a696d4b6daab19fd8daf05b980058f5f3 (diff) | |
| download | ChibiOS-ad3d21e81592481539a56e93234f5bf1fa2c0504.tar.gz ChibiOS-ad3d21e81592481539a56e93234f5bf1fa2c0504.tar.bz2 ChibiOS-ad3d21e81592481539a56e93234f5bf1fa2c0504.zip | |
Documentation reorganization. Moved the description from kernel.dox into the source code for ease of editing and reference.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1746 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/kernel/src/chheap.c')
| -rw-r--r-- | os/kernel/src/chheap.c | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/os/kernel/src/chheap.c b/os/kernel/src/chheap.c index ce8ce385b..ede326b59 100644 --- a/os/kernel/src/chheap.c +++ b/os/kernel/src/chheap.c @@ -22,6 +22,18 @@ * @brief Heaps code.
*
* @addtogroup heaps
+ * @details Heap Allocator related APIs.
+ * <h2>Operation mode</h2>
+ * The heap allocator implements a first-fit strategy and its APIs
+ * are functionally equivalent to the usual @p malloc() and @p free()
+ * library functions. The main difference is that the OS heap APIs
+ * are guaranteed to be thread safe.<br>
+ * By enabling the @p CH_USE_MALLOC_HEAP option the heap manager
+ * will use the runtime-provided @p malloc() and @p free() as
+ * backend for the heap APIs instead of the system provided
+ * allocator.<br>
+ * In order to use the heap APIs the @p CH_USE_HEAP option must
+ * be enabled in @p chconf.h.
* @{
*/
|