Changeset 07a3aa9d in rtems


Ignore:
Timestamp:
Dec 9, 2013, 7:29:41 PM (6 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.11, master
Children:
849b98e8
Parents:
71f2a83d
git-author:
Joel Sherrill <joel.sherrill@…> (12/09/13 19:29:41)
git-committer:
Joel Sherrill <joel.sherrill@…> (12/10/13 01:50:55)
Message:

condimpl.h: Comment clean up

File:
1 edited

Legend:

Unmodified
Added
Removed
  • cpukit/posix/include/rtems/posix/condimpl.h

    r71f2a83d r07a3aa9d  
    11/**
    2  * @file rtems/posix/cond.inl
     2 * @file
    33 *
    44 * This include file contains the static inline implementation of the private
     
    77
    88/*
    9  *  COPYRIGHT (c) 1989-2011.
     9 *  COPYRIGHT (c) 1989-2013.
    1010 *  On-Line Applications Research Corporation (OAR).
    1111 *
     
    2626#endif
    2727
    28 /*
     28/**
    2929 *  Constant to indicate condition variable does not currently have
    3030 *  a mutex assigned to it.
    3131 */
    32 
    3332#define POSIX_CONDITION_VARIABLES_NO_MUTEX 0
    3433
    35 /*
     34/**
    3635 *  The following defines the information control block used to manage
    3736 *  this class of objects.
    3837 */
    39 
    4038POSIX_EXTERN Objects_Information  _POSIX_Condition_variables_Information;
    4139
    42 /*
     40/**
    4341 *  The default condition variable attributes structure.
    4442 */
    45 
    4643extern const pthread_condattr_t _POSIX_Condition_variables_Default_attributes;
    4744
    48 /*
    49  * @brief Initialization Necessary for this Manager
    50  *
    51  *  _POSIX_Condition_variables_Manager_initialization
    52  *
    53  *  DESCRIPTION:
     45/**
     46 *  @brief POSIX Condition Variable Manager Initialization
    5447 *
    5548 *  This routine performs the initialization necessary for this manager.
    5649 */
    57 
    5850void _POSIX_Condition_variables_Manager_initialization(void);
    5951
    60 /*
    61  *  _POSIX_Condition_variables_Allocate
    62  *
    63  *  DESCRIPTION:
     52/**
     53 *  @brief POSIX Condition Variable Allocate
    6454 *
    6555 *  This function allocates a condition variable control block from
    6656 *  the inactive chain of free condition variable control blocks.
    6757 */
     58RTEMS_INLINE_ROUTINE POSIX_Condition_variables_Control *
     59  _POSIX_Condition_variables_Allocate( void )
     60{
     61  return (POSIX_Condition_variables_Control *)
     62    _Objects_Allocate( &_POSIX_Condition_variables_Information );
     63}
    6864
    69 RTEMS_INLINE_ROUTINE POSIX_Condition_variables_Control *
    70   _POSIX_Condition_variables_Allocate( void );
    71 
    72 /*
    73  *  _POSIX_Condition_variables_Free
    74  *
    75  *  DESCRIPTION:
     65/**
     66 *  @brief POSIX Condition Variable Free
    7667 *
    7768 *  This routine frees a condition variable control block to the
    7869 *  inactive chain of free condition variable control blocks.
    7970 */
    80 
    8171RTEMS_INLINE_ROUTINE void _POSIX_Condition_variables_Free (
    8272  POSIX_Condition_variables_Control *the_condition_variable
    83 );
     73)
     74{
     75  _Objects_Free(
     76    &_POSIX_Condition_variables_Information,
     77    &the_condition_variable->Object
     78  );
     79}
    8480
    85 /*
    86  *  _POSIX_Condition_variables_Get
    87  *
    88  *  DESCRIPTION:
     81/**
     82 *  @brief POSIX Condition Variable Get
    8983 *
    9084 *  This function maps condition variable IDs to condition variable control
     
    9690 *  to OBJECTS_ERROR and the_condition variable is undefined.
    9791 */
    98 
    99 #if 0
    100 RTEMS_INLINE_ROUTINE POSIX_Condition_variables_Control *_POSIX_Condition_variables_Get (
    101   Objects_Id        *id,
     92POSIX_Condition_variables_Control *_POSIX_Condition_variables_Get (
     93  pthread_cond_t    *cond,
    10294  Objects_Locations *location
    10395);
    104 #endif
    10596
    106 /*
    107  *  _POSIX_Condition_variables_Is_null
     97/**
     98 *  @brief POSIX Condition Variable Is NULL
    10899 *
    109  *  DESCRIPTION:
    110  *
    111  *  This function returns TRUE if the_condition variable is NULL
     100 *  This function returns TRUE if @a the_condition variable is NULL
    112101 *  and FALSE otherwise.
    113102 */
    114 
    115103RTEMS_INLINE_ROUTINE bool _POSIX_Condition_variables_Is_null (
    116104  POSIX_Condition_variables_Control *the_condition_variable
    117 );
     105)
     106{
     107  return !the_condition_variable;
     108}
     109
    118110
    119111/**
    120112 * @brief Implements wake up version of the "signal" operation.
    121113 *
    122  * DESCRIPTION:
    123  *
    124114 * A support routine which implements guts of the broadcast and single task
    125115 * wake up version of the "signal" operation.
     
    133123 * @brief POSIX condition variables wait support.
    134124 *
    135  * DESCRIPTION:
    136  *
    137125 * A support routine which implements guts of the blocking, non-blocking, and
    138126 * timed wait version of condition variable wait routines.
     
    145133);
    146134
    147 /*
    148  *  _POSIX_Condition_variables_Get
    149  *
    150  *  DESCRIPTION:
    151  *
    152  *  A support routine which translates the condition variable id into
    153  *  a local pointer.  As a side-effect, it may create the condition
    154  *  variable.
    155  */
    156 
    157 POSIX_Condition_variables_Control *_POSIX_Condition_variables_Get (
    158   pthread_cond_t    *cond,
    159   Objects_Locations *location
    160 );
    161 
    162 /*
    163  *  _POSIX_Condition_variables_Allocate
    164  */
    165  
    166 RTEMS_INLINE_ROUTINE POSIX_Condition_variables_Control
    167   *_POSIX_Condition_variables_Allocate( void )
    168 {
    169   return (POSIX_Condition_variables_Control *)
    170     _Objects_Allocate( &_POSIX_Condition_variables_Information );
    171 }
    172  
    173 /*
    174  *  _POSIX_Condition_variables_Free
    175  */
    176  
    177 RTEMS_INLINE_ROUTINE void _POSIX_Condition_variables_Free (
    178   POSIX_Condition_variables_Control *the_condition_variable
    179 )
    180 {
    181   _Objects_Free(
    182     &_POSIX_Condition_variables_Information,
    183     &the_condition_variable->Object
    184   );
    185 }
    186  
    187 /*
    188  *  _POSIX_Condition_variables_Is_null
    189  */
    190  
    191 RTEMS_INLINE_ROUTINE bool _POSIX_Condition_variables_Is_null (
    192   POSIX_Condition_variables_Control *the_condition_variable
    193 )
    194 {
    195   return !the_condition_variable;
    196 }
    197 
    198135#ifdef __cplusplus
    199136}
Note: See TracChangeset for help on using the changeset viewer.