Changeset 610825b1 in rtems


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

semaphoreimpl.h: Comment clean up

File:
1 edited

Legend:

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

    r849b98e8 r610825b1  
    99
    1010/*
    11  *  COPYRIGHT (c) 1989-2011.
     11 *  COPYRIGHT (c) 1989-2013.
    1212 *  On-Line Applications Research Corporation (OAR).
    1313 *
     
    3030#endif
    3131
    32 /*
    33  *  The following defines the information control block used to manage
     32/**
     33 *  This defines the information control block used to manage
    3434 *  this class of objects.
    3535 */
    36 
    3736POSIX_EXTERN Objects_Information  _POSIX_Semaphore_Information;
    3837
     38/**
     39 *  This defines the mapping from Score status codes to POSIX return codes.
     40 */
    3941extern const int
    4042  _POSIX_Semaphore_Return_codes[CORE_SEMAPHORE_STATUS_LAST + 1];
    4143
    42 /*
    43  *  _POSIX_Semaphore_Manager_initialization
    44  *
    45  *  DESCRIPTION:
     44/**
     45 *  @brief POSIX Semaphore Manager Initialization
    4646 *
    4747 *  This routine performs the initialization necessary for this manager.
    4848 */
    49 
    5049void _POSIX_Semaphore_Manager_initialization(void);
    5150
    52 /*
    53  *  _POSIX_Semaphore_Allocate
    54  *
    55  *  DESCRIPTION:
     51/**
     52 *  @brief POSIX Semaphore Allocate
    5653 *
    5754 *  This function allocates a semaphore control block from
     
    5956 */
    6057
    61 RTEMS_INLINE_ROUTINE POSIX_Semaphore_Control *_POSIX_Semaphore_Allocate( void );
     58RTEMS_INLINE_ROUTINE POSIX_Semaphore_Control *_POSIX_Semaphore_Allocate( void )
     59{
     60  return (POSIX_Semaphore_Control *)
     61    _Objects_Allocate( &_POSIX_Semaphore_Information );
     62}
    6263
    63 /*
    64  *  _POSIX_Semaphore_Free
    65  *
    66  *  DESCRIPTION:
     64
     65/**
     66 *  @brief POSIX Semaphore Free
    6767 *
    6868 *  This routine frees a semaphore control block to the
    6969 *  inactive chain of free semaphore control blocks.
    7070 */
    71 
    7271RTEMS_INLINE_ROUTINE void _POSIX_Semaphore_Free (
    7372  POSIX_Semaphore_Control *the_semaphore
    74 );
     73)
     74{
     75  _Objects_Free( &_POSIX_Semaphore_Information, &the_semaphore->Object );
     76}
    7577
    76 /*
    77  *  _POSIX_Semaphore_Get
    78  *
    79  *  DESCRIPTION:
     78/**
     79 *  @brief POSIX Semaphore Get
    8080 *
    8181 *  This function maps semaphore IDs to semaphore control blocks.
     
    8787 *  to OBJECTS_ERROR and the_semaphore is undefined.
    8888 */
     89RTEMS_INLINE_ROUTINE POSIX_Semaphore_Control *_POSIX_Semaphore_Get (
     90  sem_t             *id,
     91  Objects_Locations *location
     92)
     93{
     94  return (POSIX_Semaphore_Control *)
     95    _Objects_Get( &_POSIX_Semaphore_Information, (Objects_Id)*id, location );
     96}
    8997
    90 RTEMS_INLINE_ROUTINE POSIX_Semaphore_Control *_POSIX_Semaphore_Get (
    91   sem_t        *id,
    92   Objects_Locations *location
    93 );
    9498
    95 /*
    96  *  _POSIX_Semaphore_Create_support
    97  *
    98  *  DESCRIPTION:
     99/**
     100 *  @brief POSIX Semaphore Create Support
    99101 *
    100102 *  This routine supports the sem_init and sem_open routines.
     
    110112
    111113/**
    112  * @brief POSIX delete a semaphore.
    113  *
    114  * DESCRIPTION:
     114 *  @brief POSIX Semaphore Delete
    115115 *
    116116 * This routine supports the sem_close and sem_unlink routines.
     
    123123 * @brief POSIX semaphore wait support.
    124124 *
    125  * DESCRIPTION:
    126  *
    127125 * This routine supports the sem_wait, sem_trywait, and sem_timedwait
    128126 * services.
     
    134132);
    135133
    136 /*
    137  *  _POSIX_Semaphore_Translate_core_semaphore_return_code
    138  *
    139  *  DESCRIPTION:
     134/**
     135 *  @brief POSIX Semaphore Translate Score to POSIX Return Codes
    140136 *
    141137 *  A support routine which converts core semaphore status codes into the
    142138 *  appropriate POSIX status values.
    143139 */
    144 
    145140RTEMS_INLINE_ROUTINE int
    146141_POSIX_Semaphore_Translate_core_semaphore_return_code(
     
    158153}
    159154 
    160 /*
    161  *  _POSIX_Semaphore_Allocate
     155/**
     156 *  @brief POSIX Semaphore Namespace Remove
    162157 */
    163  
    164 RTEMS_INLINE_ROUTINE POSIX_Semaphore_Control *_POSIX_Semaphore_Allocate( void )
    165 {
    166   return (POSIX_Semaphore_Control *)
    167     _Objects_Allocate( &_POSIX_Semaphore_Information );
    168 }
    169  
    170 /*
    171  *  _POSIX_Semaphore_Free
    172  */
    173  
    174 RTEMS_INLINE_ROUTINE void _POSIX_Semaphore_Free (
    175   POSIX_Semaphore_Control *the_semaphore
    176 )
    177 {
    178   _Objects_Free( &_POSIX_Semaphore_Information, &the_semaphore->Object );
    179 }
    180  
    181 /*
    182  *  _POSIX_Semaphore_Namespace_remove
    183  */
    184  
    185158RTEMS_INLINE_ROUTINE void _POSIX_Semaphore_Namespace_remove (
    186159  POSIX_Semaphore_Control *the_semaphore
     
    191164}
    192165 
    193 
    194 
    195 /*
    196  *  _POSIX_Semaphore_Get
    197  */
    198 RTEMS_INLINE_ROUTINE POSIX_Semaphore_Control *_POSIX_Semaphore_Get (
    199   sem_t             *id,
    200   Objects_Locations *location
    201 )
    202 {
    203   return (POSIX_Semaphore_Control *)
    204     _Objects_Get( &_POSIX_Semaphore_Information, (Objects_Id)*id, location );
    205 }
    206 
    207166/**
    208167 * @see _POSIX_Name_to_id().
Note: See TracChangeset for help on using the changeset viewer.