summaryrefslogtreecommitdiffstats
path: root/cpukit/score/include/rtems/score/apimutex.h
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>2011-06-24 17:50:31 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>2011-06-24 17:50:31 +0000
commit27a1a6a19b3feb3b04c16a82134a6aec1cef93d7 (patch)
tree44d94495f675b98c38d03af52d33ecc5088c8c4e /cpukit/score/include/rtems/score/apimutex.h
parent2011-06-24 Joel Sherrill <joel.sherrill@oarcorp.com> (diff)
downloadrtems-27a1a6a19b3feb3b04c16a82134a6aec1cef93d7.tar.bz2
2011-06-24 Joel Sherrill <joel.sherrill@oarcorp.com>
* Doxyfile.in, score/include/rtems/score/apimutex.h, score/include/rtems/score/basedefs.h, score/include/rtems/score/coremsg.h, score/include/rtems/score/object.h: Fix some Doxygen warnings.
Diffstat (limited to '')
-rw-r--r--cpukit/score/include/rtems/score/apimutex.h16
1 files changed, 16 insertions, 0 deletions
diff --git a/cpukit/score/include/rtems/score/apimutex.h b/cpukit/score/include/rtems/score/apimutex.h
index 691f60b709..8a0ad124e7 100644
--- a/cpukit/score/include/rtems/score/apimutex.h
+++ b/cpukit/score/include/rtems/score/apimutex.h
@@ -98,11 +98,27 @@ void _API_Mutex_Unlock( API_Mutex_Control *mutex );
* @{
*/
+/**
+ * @brief Memory Allocation Mutex
+ *
+ * This points to the API Mutex instance used to ensure that only
+ * one thread at a time is allocating or freeing memory.
+ */
SCORE_EXTERN API_Mutex_Control *_RTEMS_Allocator_Mutex;
+/**
+ * @brief Macro to Ease Locking the Allocator Mutex
+ *
+ * This macro makes it explicit that one is locking the allocator mutex.
+ */
#define _RTEMS_Lock_allocator() \
_API_Mutex_Lock( _RTEMS_Allocator_Mutex )
+/**
+ * @brief Macro to Ease Unlocking the Allocator Mutex
+ *
+ * This macro makes it explicit that one is unlocking the allocator mutex.
+ */
#define _RTEMS_Unlock_allocator() \
_API_Mutex_Unlock( _RTEMS_Allocator_Mutex )