diff options
author | Joel Sherrill <joel.sherrill@oarcorp.com> | 2013-12-09 13:29:41 -0600 |
---|---|---|
committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2013-12-09 19:50:55 -0600 |
commit | 07a3aa9d70b0f24c5e2b3a964f31794216c764a8 (patch) | |
tree | 566e80384218e05c1d0aded3d5b06155254aeedc /cpukit/posix | |
parent | ptimer.h: Comment clean up (diff) | |
download | rtems-07a3aa9d70b0f24c5e2b3a964f31794216c764a8.tar.bz2 |
condimpl.h: Comment clean up
Diffstat (limited to 'cpukit/posix')
-rw-r--r-- | cpukit/posix/include/rtems/posix/condimpl.h | 133 |
1 files changed, 35 insertions, 98 deletions
diff --git a/cpukit/posix/include/rtems/posix/condimpl.h b/cpukit/posix/include/rtems/posix/condimpl.h index 029ff48b88..def0f3eddb 100644 --- a/cpukit/posix/include/rtems/posix/condimpl.h +++ b/cpukit/posix/include/rtems/posix/condimpl.h @@ -1,12 +1,12 @@ /** - * @file rtems/posix/cond.inl + * @file * * This include file contains the static inline implementation of the private * inlined routines for POSIX condition variables. */ /* - * COPYRIGHT (c) 1989-2011. + * COPYRIGHT (c) 1989-2013. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -25,67 +25,61 @@ extern "C" { #endif -/* +/** * Constant to indicate condition variable does not currently have * a mutex assigned to it. */ - #define POSIX_CONDITION_VARIABLES_NO_MUTEX 0 -/* +/** * The following defines the information control block used to manage * this class of objects. */ - POSIX_EXTERN Objects_Information _POSIX_Condition_variables_Information; -/* +/** * The default condition variable attributes structure. */ - extern const pthread_condattr_t _POSIX_Condition_variables_Default_attributes; -/* - * @brief Initialization Necessary for this Manager - * - * _POSIX_Condition_variables_Manager_initialization - * - * DESCRIPTION: +/** + * @brief POSIX Condition Variable Manager Initialization * * This routine performs the initialization necessary for this manager. */ - void _POSIX_Condition_variables_Manager_initialization(void); -/* - * _POSIX_Condition_variables_Allocate - * - * DESCRIPTION: +/** + * @brief POSIX Condition Variable Allocate * * This function allocates a condition variable control block from * the inactive chain of free condition variable control blocks. */ - RTEMS_INLINE_ROUTINE POSIX_Condition_variables_Control * - _POSIX_Condition_variables_Allocate( void ); + _POSIX_Condition_variables_Allocate( void ) +{ + return (POSIX_Condition_variables_Control *) + _Objects_Allocate( &_POSIX_Condition_variables_Information ); +} -/* - * _POSIX_Condition_variables_Free - * - * DESCRIPTION: +/** + * @brief POSIX Condition Variable Free * * This routine frees a condition variable control block to the * inactive chain of free condition variable control blocks. */ - RTEMS_INLINE_ROUTINE void _POSIX_Condition_variables_Free ( POSIX_Condition_variables_Control *the_condition_variable -); +) +{ + _Objects_Free( + &_POSIX_Condition_variables_Information, + &the_condition_variable->Object + ); +} -/* - * _POSIX_Condition_variables_Get - * - * DESCRIPTION: +/** + * @brief POSIX Condition Variable Get * * This function maps condition variable IDs to condition variable control * blocks. If ID corresponds to a local condition variable, then it returns @@ -95,32 +89,28 @@ RTEMS_INLINE_ROUTINE void _POSIX_Condition_variables_Free ( * and the_condition variable is undefined. Otherwise, location is set * to OBJECTS_ERROR and the_condition variable is undefined. */ - -#if 0 -RTEMS_INLINE_ROUTINE POSIX_Condition_variables_Control *_POSIX_Condition_variables_Get ( - Objects_Id *id, +POSIX_Condition_variables_Control *_POSIX_Condition_variables_Get ( + pthread_cond_t *cond, Objects_Locations *location ); -#endif -/* - * _POSIX_Condition_variables_Is_null - * - * DESCRIPTION: +/** + * @brief POSIX Condition Variable Is NULL * - * This function returns TRUE if the_condition variable is NULL + * This function returns TRUE if @a the_condition variable is NULL * and FALSE otherwise. */ - RTEMS_INLINE_ROUTINE bool _POSIX_Condition_variables_Is_null ( POSIX_Condition_variables_Control *the_condition_variable -); +) +{ + return !the_condition_variable; +} + /** * @brief Implements wake up version of the "signal" operation. * - * DESCRIPTION: - * * A support routine which implements guts of the broadcast and single task * wake up version of the "signal" operation. */ @@ -132,8 +122,6 @@ int _POSIX_Condition_variables_Signal_support( /** * @brief POSIX condition variables wait support. * - * DESCRIPTION: - * * A support routine which implements guts of the blocking, non-blocking, and * timed wait version of condition variable wait routines. */ @@ -144,57 +132,6 @@ int _POSIX_Condition_variables_Wait_support( bool already_timedout ); -/* - * _POSIX_Condition_variables_Get - * - * DESCRIPTION: - * - * A support routine which translates the condition variable id into - * a local pointer. As a side-effect, it may create the condition - * variable. - */ - -POSIX_Condition_variables_Control *_POSIX_Condition_variables_Get ( - pthread_cond_t *cond, - Objects_Locations *location -); - -/* - * _POSIX_Condition_variables_Allocate - */ - -RTEMS_INLINE_ROUTINE POSIX_Condition_variables_Control - *_POSIX_Condition_variables_Allocate( void ) -{ - return (POSIX_Condition_variables_Control *) - _Objects_Allocate( &_POSIX_Condition_variables_Information ); -} - -/* - * _POSIX_Condition_variables_Free - */ - -RTEMS_INLINE_ROUTINE void _POSIX_Condition_variables_Free ( - POSIX_Condition_variables_Control *the_condition_variable -) -{ - _Objects_Free( - &_POSIX_Condition_variables_Information, - &the_condition_variable->Object - ); -} - -/* - * _POSIX_Condition_variables_Is_null - */ - -RTEMS_INLINE_ROUTINE bool _POSIX_Condition_variables_Is_null ( - POSIX_Condition_variables_Control *the_condition_variable -) -{ - return !the_condition_variable; -} - #ifdef __cplusplus } #endif |