score: Documentation

This commit is contained in:
Sebastian Huber
2014-05-07 08:13:44 +02:00
parent 3324383ce0
commit 07e7a7f8ce
2 changed files with 12 additions and 4 deletions

View File

@@ -166,6 +166,9 @@ typedef ISR_lock_Context rtems_interrupt_lock_context;
/** /**
* @brief Initializer for static initialization of interrupt locks. * @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 ) #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. * Concurrent initialization leads to unpredictable results.
* *
* @param[in,out] _lock The interrupt lock. * @param[in,out] _lock The interrupt lock.
* @param[in] _name The name for the interrupt lock. This name must be * @param[in] _name The name for the interrupt lock. This name must be a
* persistent throughout the life time of this lock. * 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 ) \ #define rtems_interrupt_lock_initialize( _lock, _name ) \
_ISR_lock_Initialize( _lock, _name ) _ISR_lock_Initialize( _lock, _name )

View File

@@ -69,6 +69,9 @@ typedef struct {
/** /**
* @brief Initializer for static initialization of ISR locks. * @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 ) #if defined( RTEMS_SMP )
#define ISR_LOCK_INITIALIZER( name ) \ #define ISR_LOCK_INITIALIZER( name ) \
@@ -84,8 +87,9 @@ typedef struct {
* Concurrent initialization leads to unpredictable results. * Concurrent initialization leads to unpredictable results.
* *
* @param[in,out] lock The ISR lock control. * @param[in,out] lock The ISR lock control.
* @param[in] name The name for the ISR lock. This name must be persistent * @param[in] _name The name for the ISR lock. This name must be a
* throughout the life time of this lock. * string persistent throughout the life time of this lock. The name is only
* used if profiling is enabled.
*/ */
static inline void _ISR_lock_Initialize( static inline void _ISR_lock_Initialize(
ISR_lock_Control *lock, ISR_lock_Control *lock,