diff options
Diffstat (limited to '')
| -rw-r--r-- | cpukit/score/inline/rtems/score/coresem.inl | 61 |
1 files changed, 33 insertions, 28 deletions
diff --git a/cpukit/score/inline/rtems/score/coresem.inl b/cpukit/score/inline/rtems/score/coresem.inl index f504798f31..91f4aa17f1 100644 --- a/cpukit/score/inline/rtems/score/coresem.inl +++ b/cpukit/score/inline/rtems/score/coresem.inl @@ -1,8 +1,10 @@ -/** - * @file rtems/score/coresem.inl +/** + * @file + * + * @brief Inlined Routines Associated with the SuperCore Semaphore * - * This include file contains all of the inlined routines associated - * with the SuperCore semaphore. + * This include file contains all of the inlined routines associated + * with the SuperCore semaphore. */ /* @@ -22,19 +24,21 @@ #define _RTEMS_SCORE_CORESEM_INL /** - * @addtogroup ScoreSemaphore - * @{ + * @addtogroup ScoreSemaphore + * + * @{ */ #include <rtems/score/thread.h> #include <rtems/score/threadq.h> /** - * This function returns true if the priority attribute is - * enabled in the @a attribute_set and false otherwise. + * This function returns true if the priority attribute is + * enabled in the @a attribute_set and false otherwise. + * + * @param[in] the_attribute is the attribute set to test * - * @param[in] the_attribute is the attribute set to test - * @return true if the priority attribute is enabled + * @return true if the priority attribute is enabled */ RTEMS_INLINE_ROUTINE bool _CORE_semaphore_Is_priority( CORE_semaphore_Attributes *the_attribute @@ -44,10 +48,11 @@ RTEMS_INLINE_ROUTINE bool _CORE_semaphore_Is_priority( } /** - * This routine returns the current count associated with the semaphore. + * This routine returns the current count associated with the semaphore. * - * @param[in] the_semaphore is the semaphore to obtain the count of - * @return the current count of this semaphore + * @param[in] the_semaphore is the semaphore to obtain the count of + * + * @return the current count of this semaphore */ RTEMS_INLINE_ROUTINE uint32_t _CORE_semaphore_Get_count( CORE_semaphore_Control *the_semaphore @@ -57,19 +62,19 @@ RTEMS_INLINE_ROUTINE uint32_t _CORE_semaphore_Get_count( } /** - * This routine attempts to receive a unit from the_semaphore. - * If a unit is available or if the wait flag is false, then the routine - * returns. Otherwise, the calling task is blocked until a unit becomes - * available. + * This routine attempts to receive a unit from the_semaphore. + * If a unit is available or if the wait flag is false, then the routine + * returns. Otherwise, the calling task is blocked until a unit becomes + * available. * - * @param[in] the_semaphore is the semaphore to obtain - * @param[in] id is the Id of the owning API level Semaphore object - * @param[in] wait is true if the thread is willing to wait - * @param[in] timeout is the maximum number of ticks to block - * @param[in] level_p is a temporary variable used to contain the ISR - * disable level cookie + * @param[in] the_semaphore is the semaphore to obtain + * @param[in] id is the Id of the owning API level Semaphore object + * @param[in] wait is true if the thread is willing to wait + * @param[in] timeout is the maximum number of ticks to block + * @param[in] level_p is a temporary variable used to contain the ISR + * disable level cookie * - * @note There is currently no MACRO version of this routine. + * @note There is currently no MACRO version of this routine. */ RTEMS_INLINE_ROUTINE void _CORE_semaphore_Seize_isr_disable( CORE_semaphore_Control *the_semaphore, @@ -77,12 +82,12 @@ RTEMS_INLINE_ROUTINE void _CORE_semaphore_Seize_isr_disable( bool wait, Watchdog_Interval timeout, ISR_Level *level_p -) -{ +) +{ Thread_Control *executing; /* disabled when you get here */ - + executing = _Thread_Executing; executing->Wait.return_code = CORE_SEMAPHORE_STATUS_SUCCESSFUL; if ( the_semaphore->count != 0 ) { @@ -107,7 +112,7 @@ RTEMS_INLINE_ROUTINE void _CORE_semaphore_Seize_isr_disable( _Thread_Enable_dispatch(); } -/**@}*/ +/** @} */ #endif /* end of include file */ |