diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-09-24 10:04:03 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-09-30 07:31:58 +0200 |
| commit | 99d5373b839ba5886f54cf255f6d800e9ea8688a (patch) | |
| tree | 14145f9616453bc8f7ac8c55fb0c55322c027e12 /cpukit | |
| parent | rtems: Adjust parameter names (diff) | |
| download | rtems-99d5373b839ba5886f54cf255f6d800e9ea8688a.tar.bz2 | |
score: Add Doxygen group for <sys/lock.h> mutexes
Diffstat (limited to 'cpukit')
| -rw-r--r-- | cpukit/score/src/mutex.c | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/cpukit/score/src/mutex.c b/cpukit/score/src/mutex.c index f7e35093b2..92bd614967 100644 --- a/cpukit/score/src/mutex.c +++ b/cpukit/score/src/mutex.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup RTEMSScore + * @ingroup RTEMSScoreSysLockMutex * * @brief This source file contains the implementation of * _Mutex_Acquire(), _Mutex_Acquire_timed(), _Mutex_Acquire_timed_ticks(), @@ -36,6 +36,20 @@ #include <rtems/score/threadimpl.h> #include <rtems/score/todimpl.h> +/** + * @defgroup RTEMSScoreSysLockMutex System Lock Mutex Handler + * + * @ingroup RTEMSScore + * + * @brief This group contains the System Lock Mutex Handler implementation. + * + * The interfaces are defined by Newlib in <sys/lock.h>. The system lock + * mutexes are used for Newlib internal locking, the C++ standard library + * provided by GCC, the OpenMP support provided by GCC, the self-contained + * objects API provided by RTEMS, and the SuperCore internal mutexes such as + * the objects allocator lock (see ::API_Mutex_Control). + */ + #define MUTEX_TQ_OPERATIONS &_Thread_queue_Operations_priority_inherit RTEMS_STATIC_ASSERT( |