Changeset 4600bd7 in rtems


Ignore:
Timestamp:
Dec 9, 2013, 6:53:24 PM (6 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.11, master
Children:
71f2a83d
Parents:
1de916b4
git-author:
Joel Sherrill <joel.sherrill@…> (12/09/13 18:53:24)
git-committer:
Joel Sherrill <joel.sherrill@…> (12/10/13 01:50:55)
Message:

muteximpl.h: Comment clean up

File:
1 edited

Legend:

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

    r1de916b4 r4600bd7  
    88 */
    99
    10 /*  COPYRIGHT (c) 1989-2011.
     10/*  COPYRIGHT (c) 1989-2013.
    1111 *  On-Line Applications Research Corporation (OAR).
    1212 *
     
    2828#endif
    2929
    30 /*
     30/**
    3131 *  The following defines the information control block used to manage
    3232 *  this class of objects.
    3333 */
    34 
    3534POSIX_EXTERN Objects_Information  _POSIX_Mutex_Information;
    3635
    37 /*
     36/**
    3837 *  The default mutex attributes structure.
    3938 */
    40 
    4139POSIX_EXTERN pthread_mutexattr_t _POSIX_Mutex_Default_attributes;
    4240
     41/**
     42 *  This array contains a mapping from Score Mutex return codes to
     43 *  POSIX return codes.
     44 */
    4345extern const int _POSIX_Mutex_Return_codes[CORE_MUTEX_STATUS_LAST + 1];
    4446
    45 /*
     47/**
    4648 *  @brief POSIX Mutex Manager Initialization
    47  *
    48  *  DESCRIPTION:
    4949 *
    5050 *  This routine performs the initialization necessary for this manager.
    5151 */
    52 
    5352void _POSIX_Mutex_Manager_initialization(void);
    5453
    55 /*
    56  *  _POSIX_Mutex_Allocate
    57  *
    58  *  DESCRIPTION:
     54/**
     55 *  @brief POSIX Mutex Allocate
    5956 *
    6057 *  This function allocates a mutexes control block from
    6158 *  the inactive chain of free mutexes control blocks.
    6259 */
     60RTEMS_INLINE_ROUTINE POSIX_Mutex_Control *_POSIX_Mutex_Allocate( void )
     61{
     62  return (POSIX_Mutex_Control *) _Objects_Allocate( &_POSIX_Mutex_Information );
     63}
    6364
    64 RTEMS_INLINE_ROUTINE POSIX_Mutex_Control *_POSIX_Mutex_Allocate( void );
    65 
    66 /*
    67  *  _POSIX_Mutex_Free
    68  *
    69  *  DESCRIPTION:
     65/**
     66 *  @brief POSIX Mutex Free
    7067 *
    7168 *  This routine frees a mutexes control block to the
    7269 *  inactive chain of free mutexes control blocks.
    7370 */
     71RTEMS_INLINE_ROUTINE void _POSIX_Mutex_Free(
     72  POSIX_Mutex_Control *the_mutex
     73)
     74{
     75  _Objects_Free( &_POSIX_Mutex_Information, &the_mutex->Object );
     76}
    7477
    75 RTEMS_INLINE_ROUTINE void _POSIX_Mutex_Free (
    76   POSIX_Mutex_Control *the_mutex
    77 );
    7878
    79 #if 0
    80 /*
    81  *  _POSIX_Mutex_Get
    82  *
    83  *  DESCRIPTION:
    84  *
    85  *  This function maps mutexes IDs to mutexes control blocks.
    86  *  If ID corresponds to a local mutexes, then it returns
    87  *  the_mutex control pointer which maps to ID and location
    88  *  is set to OBJECTS_LOCAL.  if the mutexes ID is global and
    89  *  resides on a remote node, then location is set to OBJECTS_REMOTE,
    90  *  and the_mutex is undefined.  Otherwise, location is set
    91  *  to OBJECTS_ERROR and the_mutex is undefined.
    92  */
    93 
    94 RTEMS_INLINE_ROUTINE POSIX_Mutex_Control *_POSIX_Mutex_Get (
    95   Objects_Id        *id,
    96   Objects_Locations *location
    97 );
    98 
    99 /*
    100  *  _POSIX_Mutex_Is_null
    101  *
    102  *  DESCRIPTION:
    103  *
    104  *  This function returns TRUE if the_mutex is NULL and FALSE otherwise.
    105  */
    106 
    107 RTEMS_INLINE_ROUTINE bool    _POSIX_Mutex_Is_null (
    108   POSIX_Mutex_Control *the_mutex
    109 );
    110 #endif
    111 
    112 /*
    113  *  _POSIX_Mutex_Lock_support
    114  *
    115  *  DESCRIPTION:
     79/**
     80 *  @brief POSIX Mutex Lock Support Method
    11681 *
    11782 *  A support routine which implements guts of the blocking, non-blocking, and
    11883 *  timed wait version of mutex lock.
    11984 */
    120 
    12185int _POSIX_Mutex_Lock_support(
    12286  pthread_mutex_t           *mutex,
     
    12690
    12791/**
    128  * @brief Convert core mutex status codes into the appropriate POSIX status
    129  * values.
    130  *
    131  * DESCRIPTION:
     92 * @brief Convert Score mutex status codes into POSIX status values
    13293 *
    13394 * A support routine which converts core mutex status codes into the
     
    13899 * @retval 0 Mutex status code indicates the operation completed successfully.
    139100 * @retval EBUSY Mutex status code indicates that the operation unable to
    140  * complete immediately because the resource was unavailable.
     101 *         complete immediately because the resource was unavailable.
    141102 * @retval EDEADLK Mutex status code indicates that an attempt was made to
    142  * relock a mutex for which nesting is not configured.
     103 *         relock a mutex for which nesting is not configured.
    143104 * @retval EPERM Mutex status code indicates that an attempt was made to
    144  * release a mutex by a thread other than the thread which locked it.
     105 *         release a mutex by a thread other than the thread which locked it.
    145106 * @retval EINVAL Mutex status code indicates that the thread was blocked
    146  * waiting for an operation to complete and the mutex was deleted.
     107 *         waiting for an operation to complete and the mutex was deleted.
    147108 * @retval ETIMEDOUT Mutex status code indicates that the calling task was
    148  * willing to block but the operation was unable to complete within the time
    149  * allotted because the resource never became available.
     109 *         willing to block but the operation was unable to complete
     110 *         within the time allotted because the resource never became
     111 *         available.
    150112 */
    151113RTEMS_INLINE_ROUTINE int _POSIX_Mutex_Translate_core_mutex_return_code(
     
    163125}
    164126
    165 /*
    166  *  _POSIX_Mutex_Get
    167  *
    168  *  DESCRIPTION:
     127/**
     128 *  @brief POSIX Mutex Get (Thread Dispatch Disable)
    169129 *
    170130 *  A support routine which translates the mutex id into a local pointer.
    171131 *  As a side-effect, it may create the mutex.
    172132 *
    173  *  NOTE:
    174  *
    175  *  This version of the method uses a dispatching critical section.
     133 *  @note This version of the method uses a dispatching critical section.
    176134 */
    177 
    178135POSIX_Mutex_Control *_POSIX_Mutex_Get (
    179136  pthread_mutex_t   *mutex,
     
    181138);
    182139
    183 /*
    184  *  _POSIX_Mutex_Get
    185  *
    186  *  DESCRIPTION:
     140/**
     141 *  @brief POSIX Mutex Get (Interrupt Disable)
    187142 *
    188143 *  A support routine which translates the mutex id into a local pointer.
    189144 *  As a side-effect, it may create the mutex.
    190145 *
    191  *  NOTE:
    192  *
    193  *  This version of the method uses an interrupt critical section.
     146 *  @note: This version of the method uses an interrupt critical section.
    194147 */
    195 
    196148POSIX_Mutex_Control *_POSIX_Mutex_Get_interrupt_disable (
    197149  pthread_mutex_t   *mutex,
     
    200152);
    201153 
    202 /*
    203  *  _POSIX_Mutex_Allocate
     154/**
     155 *  @brief POSIX Mutex Is NULL
     156 *
     157 *  This method is used to determine if a pointer to a POSIX mutex is NULL.
     158 *
     159 *  @return This method returns TRUE if @a the_mutex is NULL and FALSE
     160 *          otherwise.
    204161 */
    205  
    206 RTEMS_INLINE_ROUTINE POSIX_Mutex_Control *_POSIX_Mutex_Allocate( void )
    207 {
    208   return (POSIX_Mutex_Control *) _Objects_Allocate( &_POSIX_Mutex_Information );
    209 }
    210  
    211 /*
    212  *  _POSIX_Mutex_Free
    213  */
    214  
    215 RTEMS_INLINE_ROUTINE void _POSIX_Mutex_Free (
    216   POSIX_Mutex_Control *the_mutex
    217 )
    218 {
    219   _Objects_Free( &_POSIX_Mutex_Information, &the_mutex->Object );
    220 }
    221  
    222 /*
    223  *  _POSIX_Mutex_Is_null
    224  */
    225  
    226162RTEMS_INLINE_ROUTINE bool _POSIX_Mutex_Is_null (
    227163  POSIX_Mutex_Control *the_mutex
Note: See TracChangeset for help on using the changeset viewer.