summaryrefslogtreecommitdiff
path: root/nuttx/arch/arm/src/dm320/dm320_allocateheap.c
diff options
context:
space:
mode:
Diffstat (limited to 'nuttx/arch/arm/src/dm320/dm320_allocateheap.c')
-rw-r--r--nuttx/arch/arm/src/dm320/dm320_allocateheap.c17
1 files changed, 12 insertions, 5 deletions
diff --git a/nuttx/arch/arm/src/dm320/dm320_allocateheap.c b/nuttx/arch/arm/src/dm320/dm320_allocateheap.c
index 5d4b90093..1383b93da 100644
--- a/nuttx/arch/arm/src/dm320/dm320_allocateheap.c
+++ b/nuttx/arch/arm/src/dm320/dm320_allocateheap.c
@@ -1,7 +1,7 @@
/************************************************************
* dm320/dm320_allocateheap.c
*
- * Copyright (C) 2007 Gregory Nutt. All rights reserved.
+ * Copyright (C) 2007, 2013 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Redistribution and use in source and binary forms, with or without
@@ -68,10 +68,17 @@
* Name: up_allocate_heap
*
* Description:
- * The heap may be statically allocated by
- * defining CONFIG_HEAP_BASE and CONFIG_HEAP_SIZE. If these
- * are not defined, then this function will be called to
- * dynamically set aside the heap region.
+ * This function will be called to dynamically set aside
+ * the heap region.
+ *
+ * For the kernel build (CONFIG_NUTTX_KERNEL=y) with both
+ * kernel- and user-space heaps (CONFIG_MM_KERNEL_HEAP=y),
+ * this function provides the size of the unprotected,
+ * user-space heap.
+ *
+ * If a protected kernel-space heap is provided, the kernel
+ * heap must be allocated (and protected) by an analogous
+ * up_allocate_kheap().
*
************************************************************/