summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2014-05-07 08:13:44 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2014-05-07 08:14:37 +0200
commit07e7a7f8ce2f1f7570dc048d1e46fbfdeefb79ca (patch)
tree375b8c723ab46f28d61fe3f3ba7d4963ee60b164
parenttestsuites: Remove BSP_SMALL_MEMORY (diff)
downloadrtems-07e7a7f8ce2f1f7570dc048d1e46fbfdeefb79ca.tar.bz2
score: Documentation
-rw-r--r--cpukit/rtems/include/rtems/rtems/intr.h8
-rw-r--r--cpukit/score/include/rtems/score/isrlock.h8
2 files changed, 12 insertions, 4 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/intr.h b/cpukit/rtems/include/rtems/rtems/intr.h
index 7365227a54..57e8a96089 100644
--- a/cpukit/rtems/include/rtems/rtems/intr.h
+++ b/cpukit/rtems/include/rtems/rtems/intr.h
@@ -166,6 +166,9 @@ typedef ISR_lock_Context rtems_interrupt_lock_context;
/**
* @brief Initializer for static initialization of interrupt locks.
+ *
+ * @param _name The name for the interrupt lock. It must be a string. The
+ * name is only used if profiling is enabled.
*/
#define RTEMS_INTERRUPT_LOCK_INITIALIZER( _name ) ISR_LOCK_INITIALIZER( _name )
@@ -175,8 +178,9 @@ typedef ISR_lock_Context rtems_interrupt_lock_context;
* Concurrent initialization leads to unpredictable results.
*
* @param[in,out] _lock The interrupt lock.
- * @param[in] _name The name for the interrupt lock. This name must be
- * persistent throughout the life time of this lock.
+ * @param[in] _name The name for the interrupt lock. This name must be a
+ * string persistent throughout the life time of this lock. The name is only
+ * used if profiling is enabled.
*/
#define rtems_interrupt_lock_initialize( _lock, _name ) \
_ISR_lock_Initialize( _lock, _name )
diff --git a/cpukit/score/include/rtems/score/isrlock.h b/cpukit/score/include/rtems/score/isrlock.h
index d36b604047..80a8a0b38a 100644
--- a/cpukit/score/include/rtems/score/isrlock.h
+++ b/cpukit/score/include/rtems/score/isrlock.h
@@ -69,6 +69,9 @@ typedef struct {
/**
* @brief Initializer for static initialization of ISR locks.
+ *
+ * @param _name The name for the interrupt lock. It must be a string. The
+ * name is only used if profiling is enabled.
*/
#if defined( RTEMS_SMP )
#define ISR_LOCK_INITIALIZER( name ) \
@@ -84,8 +87,9 @@ typedef struct {
* Concurrent initialization leads to unpredictable results.
*
* @param[in,out] lock The ISR lock control.
- * @param[in] name The name for the ISR lock. This name must be persistent
- * throughout the life time of this lock.
+ * @param[in] _name The name for the ISR lock. This name must be a
+ * string persistent throughout the life time of this lock. The name is only
+ * used if profiling is enabled.
*/
static inline void _ISR_lock_Initialize(
ISR_lock_Control *lock,