mirror of
https://gitlab.rtems.org/rtems/rtos/rtems.git
synced 2026-09-24 04:16:05 +08:00
posix: Doxygen Clean Up Task #2
This commit is contained in:
Alex Ivanov
committed by
Jennifer Averett
Jennifer Averett
parent
61b8e9f65c
commit
436f86e142
@@ -1,5 +1,7 @@
|
||||
/**
|
||||
* @file rtems/posix/mutex.h
|
||||
* @file
|
||||
*
|
||||
* @brief POSIX MUTEX Support
|
||||
*
|
||||
* This include file contains all the private support information for
|
||||
* POSIX mutex's.
|
||||
@@ -27,6 +29,8 @@ extern "C" {
|
||||
* @ingroup POSIX
|
||||
*
|
||||
* @brief Private Support Information for POSIX Mutex
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#include <rtems/score/coremutex.h>
|
||||
@@ -138,16 +142,28 @@ int _POSIX_Mutex_Lock_support(
|
||||
);
|
||||
|
||||
/**
|
||||
* @brief POSIX Mutex Translate Core Mutex Return Code
|
||||
* @brief Convert core mutex status codes into the appropriate POSIX status
|
||||
* values.
|
||||
*
|
||||
* DESCRIPTION:
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* A support routine which converts core mutex status codes into the
|
||||
* appropriate POSIX status values.
|
||||
* A support routine which converts core mutex status codes into the
|
||||
* appropriate POSIX status values.
|
||||
*
|
||||
* @param[in] the_mutex_status is the mutex status code to translate
|
||||
* @param[in] the_mutex_status is the mutex status code to translate
|
||||
*
|
||||
* @return the translated POSIX status code
|
||||
* @retval 0 Mutex status code indicates the operation completed successfully.
|
||||
* @retval EBUSY Mutex status code indicates that the operation unable to
|
||||
* complete immediately because the resource was unavailable.
|
||||
* @retval EDEADLK Mutex status code indicates that an attempt was made to
|
||||
* relock a mutex for which nesting is not configured.
|
||||
* @retval EPERM Mutex status code indicates that an attempt was made to
|
||||
* release a mutex by a thread other than the thread which locked it.
|
||||
* @retval EINVAL Mutex status code indicates that the thread was blocked
|
||||
* waiting for an operation to complete and the mutex was deleted.
|
||||
* @retval ETIMEDOUT Mutex status code indicates that the calling task was
|
||||
* willing to block but the operation was unable to complete within the time
|
||||
* allotted because the resource never became available.
|
||||
*/
|
||||
|
||||
int _POSIX_Mutex_Translate_core_mutex_return_code(
|
||||
@@ -198,5 +214,7 @@ POSIX_Mutex_Control *_POSIX_Mutex_Get_interrupt_disable (
|
||||
}
|
||||
#endif
|
||||
|
||||
/** @} */
|
||||
|
||||
#endif
|
||||
/* end of include file */
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
/**
|
||||
* @file rtems/posix/posixapi.h
|
||||
* @file
|
||||
*
|
||||
* @brief POSIX API Implementation
|
||||
*
|
||||
* This include file defines the top level interface to the POSIX API
|
||||
* implementation in RTEMS.
|
||||
@@ -29,27 +31,27 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief Initialize POSIX API
|
||||
* @brief Initialize POSIX API.
|
||||
*
|
||||
* This method is responsible for initializing each of the POSIX
|
||||
* API managers.
|
||||
* This method is responsible for initializing each of the POSIX
|
||||
* API managers.
|
||||
*/
|
||||
void _POSIX_API_Initialize(void);
|
||||
|
||||
/**
|
||||
* @brief Queries the object identifier @a id for a @a name.
|
||||
* @brief Queries the object identifier @a id for a @a name.
|
||||
*
|
||||
* @param[in] information Object information.
|
||||
* @param[in] name Zero terminated name string to look up.
|
||||
* @param[out] id Pointer for identifier. The pointer must be valid.
|
||||
* @param[out] len Pointer for string length. The pointer must be valid.
|
||||
* @param[in] information Object information.
|
||||
* @param[in] name Zero terminated name string to look up.
|
||||
* @param[out] id Pointer for identifier. The pointer must be valid.
|
||||
* @param[out] len Pointer for string length. The pointer must be valid.
|
||||
*
|
||||
* @retval 0 Successful operation.
|
||||
* @retval EINVAL The @a name pointer is @c NULL or the @a name string has
|
||||
* zero length.
|
||||
* @retval ENAMETOOLONG The @a name string length is greater than or equal to
|
||||
* @c NAME_MAX.
|
||||
* @retval ENOENT Found no corresponding identifier.
|
||||
* @retval 0 Successful operation.
|
||||
* @retval EINVAL The @a name pointer is @c NULL or the @a name string has
|
||||
* zero length.
|
||||
* @retval ENAMETOOLONG The @a name string length is greater than or equal to
|
||||
* @c NAME_MAX.
|
||||
* @retval ENOENT Found no corresponding identifier.
|
||||
*/
|
||||
int _POSIX_Name_to_id(
|
||||
Objects_Information *information,
|
||||
@@ -58,7 +60,7 @@ int _POSIX_Name_to_id(
|
||||
size_t *len
|
||||
);
|
||||
|
||||
/**@}*/
|
||||
/** @} */
|
||||
|
||||
#endif
|
||||
/* end of include file */
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/**
|
||||
* @file rtems/posix/semaphore.h
|
||||
* @file
|
||||
*
|
||||
* @brief Private Support Information for POSIX Semaphores
|
||||
*
|
||||
@@ -20,19 +20,14 @@
|
||||
#define _RTEMS_POSIX_SEMAPHORE_H
|
||||
|
||||
/**
|
||||
* @defgroup POSIX_SEMAPHORES Semaphore
|
||||
*
|
||||
* @ingroup POSIX
|
||||
* @addtogroup POSIX_SEMAPHORES
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
/**@{*/
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @ingroup POSIX_SEMAPHORE
|
||||
*/
|
||||
|
||||
#include <semaphore.h>
|
||||
#include <rtems/score/coresem.h>
|
||||
#include <rtems/posix/posixapi.h>
|
||||
@@ -147,25 +142,24 @@ int _POSIX_Semaphore_Create_support(
|
||||
);
|
||||
|
||||
/**
|
||||
* @brief POSIX Delete Semaphore
|
||||
* @brief POSIX delete a semaphore.
|
||||
*
|
||||
* DESCRIPTION:
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This routine supports the sem_close and sem_unlink routines.
|
||||
* This routine supports the sem_close and sem_unlink routines.
|
||||
*/
|
||||
void _POSIX_Semaphore_Delete(
|
||||
POSIX_Semaphore_Control *the_semaphore
|
||||
);
|
||||
|
||||
/*
|
||||
* @brief POSIX Semaphore Wait Support
|
||||
/**
|
||||
* @brief POSIX semaphore wait support.
|
||||
*
|
||||
* DESCRIPTION:
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This routine supports the sem_wait, sem_trywait, and sem_timedwait
|
||||
* services.
|
||||
* This routine supports the sem_wait, sem_trywait, and sem_timedwait
|
||||
* services.
|
||||
*/
|
||||
|
||||
int _POSIX_Semaphore_Wait_support(
|
||||
sem_t *sem,
|
||||
bool blocking,
|
||||
@@ -191,7 +185,7 @@ int _POSIX_Semaphore_Translate_core_semaphore_return_code(
|
||||
}
|
||||
#endif
|
||||
|
||||
/**@}*/
|
||||
/** @} */
|
||||
|
||||
#endif
|
||||
/* end of include file */
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
/**
|
||||
* @file semaphore.h
|
||||
* @file
|
||||
*
|
||||
* @brief Private Support Information for POSIX Semaphores
|
||||
*
|
||||
* This file contains definitions that are internal to the RTEMS
|
||||
* implementation of POSIX Semaphores.
|
||||
@@ -55,9 +57,9 @@ int sem_init(
|
||||
);
|
||||
|
||||
/**
|
||||
* @brief Destroy an Unnamed Semaphore
|
||||
* @brief Destroy an unnamed semaphore.
|
||||
*
|
||||
* 11.2.2 Destroy an Unnamed Semaphore, P1003.1b-1993, p.220
|
||||
* 11.2.2 Destroy an Unnamed Semaphore, P1003.1b-1993, p.220
|
||||
*/
|
||||
int sem_destroy(
|
||||
sem_t *sem
|
||||
@@ -75,7 +77,7 @@ sem_t *sem_open(
|
||||
);
|
||||
|
||||
/**
|
||||
* @brief Close a Named Semaphore
|
||||
* @brief Close a named semaphore.
|
||||
*
|
||||
* Routine to close a semaphore that has been opened or initialized.
|
||||
*
|
||||
@@ -86,7 +88,7 @@ int sem_close(
|
||||
);
|
||||
|
||||
/**
|
||||
* @brief Remove a Named Semaphore
|
||||
* @brief Remove a named semaphore.
|
||||
*
|
||||
* Unlinks a named semaphore, sem_close must also be called to remove
|
||||
* the semaphore.
|
||||
@@ -98,20 +100,20 @@ int sem_unlink(
|
||||
);
|
||||
|
||||
/**
|
||||
* @brief Lock a Semaphore
|
||||
* @brief Lock a semaphore.
|
||||
*
|
||||
* 11.2.6 Lock a Semaphore, P1003.1b-1993, p.226
|
||||
* 11.2.6 Lock a Semaphore, P1003.1b-1993, p.226
|
||||
*
|
||||
* @note P1003.4b/D8 adds sem_timedwait(), p. 27
|
||||
* NOTE: P1003.4b/D8 adds sem_timedwait(), p. 27
|
||||
*/
|
||||
int sem_wait(
|
||||
sem_t *sem
|
||||
);
|
||||
|
||||
/**
|
||||
* @brief Lock a Semaphore
|
||||
* @brief Lock a semaphore.
|
||||
*
|
||||
* @see sem_wait()
|
||||
* @see sem_wait()
|
||||
*/
|
||||
int sem_trywait(
|
||||
sem_t *sem
|
||||
@@ -119,7 +121,7 @@ int sem_trywait(
|
||||
|
||||
#if defined(_POSIX_TIMEOUTS)
|
||||
/**
|
||||
* @brief Lock a Semaphore
|
||||
* @brief Lock a semaphore.
|
||||
*/
|
||||
int sem_timedwait(
|
||||
sem_t *sem,
|
||||
@@ -128,16 +130,16 @@ int sem_timedwait(
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @brief Unlock a Semaphore
|
||||
* @brief Unlock a semaphore.
|
||||
*
|
||||
* 11.2.7 Unlock a Semaphore, P1003.1b-1993, p.227
|
||||
* 11.2.7 Unlock a Semaphore, P1003.1b-1993, p.227
|
||||
*/
|
||||
int sem_post(
|
||||
sem_t *sem
|
||||
);
|
||||
|
||||
/**
|
||||
* @brief Get the Value of a Semaphore
|
||||
* @brief Get the value of a semaphore.
|
||||
*
|
||||
* 11.2.8 Get the Value of a Semaphore, P1003.1b-1993, p.229
|
||||
*/
|
||||
|
||||
@@ -1,8 +1,10 @@
|
||||
/**
|
||||
* @file rtems/posix/barrier.inl
|
||||
* @file
|
||||
*
|
||||
* @brief Inlined Routines from the POSIX Barrier Manager
|
||||
*
|
||||
* This file contains the static inlin implementation of the inlined
|
||||
* routines from the POSIX Barrier Manager.
|
||||
* This file contains the static inlin implementation of the inlined
|
||||
* routines from the POSIX Barrier Manager.
|
||||
*/
|
||||
|
||||
/*
|
||||
@@ -24,10 +26,10 @@
|
||||
#include <pthread.h>
|
||||
|
||||
/**
|
||||
* @brief _POSIX_Barrier_Allocate
|
||||
* @brief Allocate a barrier control block.
|
||||
*
|
||||
* This function allocates a barrier control block from
|
||||
* the inactive chain of free barrier control blocks.
|
||||
* This function allocates a barrier control block from
|
||||
* the inactive chain of free barrier control blocks.
|
||||
*/
|
||||
RTEMS_INLINE_ROUTINE POSIX_Barrier_Control *_POSIX_Barrier_Allocate( void )
|
||||
{
|
||||
@@ -36,10 +38,10 @@ RTEMS_INLINE_ROUTINE POSIX_Barrier_Control *_POSIX_Barrier_Allocate( void )
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief _POSIX_Barrier_Free
|
||||
* @brief Free a barrier control block.
|
||||
*
|
||||
* This routine frees a barrier control block to the
|
||||
* inactive chain of free barrier control blocks.
|
||||
* This routine frees a barrier control block to the
|
||||
* inactive chain of free barrier control blocks.
|
||||
*/
|
||||
RTEMS_INLINE_ROUTINE void _POSIX_Barrier_Free (
|
||||
POSIX_Barrier_Control *the_barrier
|
||||
@@ -49,15 +51,15 @@ RTEMS_INLINE_ROUTINE void _POSIX_Barrier_Free (
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief _POSIX_Barrier_Get
|
||||
* @brief Get a barrier control block.
|
||||
*
|
||||
* This function maps barrier IDs to barrier control blocks.
|
||||
* If ID corresponds to a local barrier, then it returns
|
||||
* the_barrier control pointer which maps to ID and location
|
||||
* is set to OBJECTS_LOCAL. if the barrier ID is global and
|
||||
* resides on a remote node, then location is set to OBJECTS_REMOTE,
|
||||
* and the_barrier is undefined. Otherwise, location is set
|
||||
* to OBJECTS_ERROR and the_barrier is undefined.
|
||||
* This function maps barrier IDs to barrier control blocks.
|
||||
* If ID corresponds to a local barrier, then it returns
|
||||
* the_barrier control pointer which maps to ID and location
|
||||
* is set to OBJECTS_LOCAL. if the barrier ID is global and
|
||||
* resides on a remote node, then location is set to OBJECTS_REMOTE,
|
||||
* and the_barrier is undefined. Otherwise, location is set
|
||||
* to OBJECTS_ERROR and the_barrier is undefined.
|
||||
*/
|
||||
RTEMS_INLINE_ROUTINE POSIX_Barrier_Control *_POSIX_Barrier_Get (
|
||||
pthread_barrier_t *barrier,
|
||||
@@ -72,9 +74,16 @@ RTEMS_INLINE_ROUTINE POSIX_Barrier_Control *_POSIX_Barrier_Get (
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief _POSIX_Barrier_Is_null
|
||||
* @brief Check if a barrier control block is NULL.
|
||||
*
|
||||
* This function returns TRUE if the_barrier is NULL and FALSE otherwise.
|
||||
* This function returns @c TRUE if the_barrier is @c NULL and @c FALSE
|
||||
* otherwise.
|
||||
*
|
||||
* @param[in] the_barrier is the pointer to the barrier control block
|
||||
* to be checked.
|
||||
*
|
||||
* @retval TRUE The barrier control block is @c NULL.
|
||||
* @retval FALSE The barrier control block is not @c NULL.
|
||||
*/
|
||||
RTEMS_INLINE_ROUTINE bool _POSIX_Barrier_Is_null (
|
||||
POSIX_Barrier_Control *the_barrier
|
||||
|
||||
@@ -1,8 +1,10 @@
|
||||
/**
|
||||
* @file rtems/posix/key.inl
|
||||
* @file
|
||||
*
|
||||
* @brief Private Inlined Routines for POSIX Key's
|
||||
*
|
||||
* This include file contains the static inline implementation of the private
|
||||
* inlined routines for POSIX key's.
|
||||
* This include file contains the static inline implementation of the private
|
||||
* inlined routines for POSIX key's.
|
||||
*/
|
||||
|
||||
/*
|
||||
@@ -22,10 +24,10 @@
|
||||
#define _RTEMS_POSIX_KEY_INL
|
||||
|
||||
/**
|
||||
* @brief _POSIX_Keys_Allocate
|
||||
* @brief Allocate a keys control block.
|
||||
*
|
||||
* This function allocates a keys control block from
|
||||
* the inactive chain of free keys control blocks.
|
||||
* This function allocates a keys control block from
|
||||
* the inactive chain of free keys control blocks.
|
||||
*/
|
||||
|
||||
RTEMS_INLINE_ROUTINE POSIX_Keys_Control *_POSIX_Keys_Allocate( void )
|
||||
@@ -34,10 +36,10 @@ RTEMS_INLINE_ROUTINE POSIX_Keys_Control *_POSIX_Keys_Allocate( void )
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief _POSIX_Keys_Free
|
||||
* @brief Free a keys control block.
|
||||
*
|
||||
* This routine frees a keys control block to the
|
||||
* inactive chain of free keys control blocks.
|
||||
* This routine frees a keys control block to the
|
||||
* inactive chain of free keys control blocks.
|
||||
*/
|
||||
RTEMS_INLINE_ROUTINE void _POSIX_Keys_Free (
|
||||
POSIX_Keys_Control *the_key
|
||||
@@ -47,15 +49,15 @@ RTEMS_INLINE_ROUTINE void _POSIX_Keys_Free (
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief _POSIX_Keys_Get
|
||||
* @brief Get a keys control block.
|
||||
*
|
||||
* This function maps key IDs to key control blocks.
|
||||
* If ID corresponds to a local keys, then it returns
|
||||
* the_key control pointer which maps to ID and location
|
||||
* is set to OBJECTS_LOCAL. if the keys ID is global and
|
||||
* resides on a remote node, then location is set to OBJECTS_REMOTE,
|
||||
* and the_key is undefined. Otherwise, location is set
|
||||
* to OBJECTS_ERROR and the_key is undefined.
|
||||
* This function maps key IDs to key control blocks.
|
||||
* If ID corresponds to a local keys, then it returns
|
||||
* the_key control pointer which maps to ID and location
|
||||
* is set to OBJECTS_LOCAL. if the keys ID is global and
|
||||
* resides on a remote node, then location is set to OBJECTS_REMOTE,
|
||||
* and the_key is undefined. Otherwise, location is set
|
||||
* to OBJECTS_ERROR and the_key is undefined.
|
||||
*/
|
||||
|
||||
RTEMS_INLINE_ROUTINE POSIX_Keys_Control *_POSIX_Keys_Get (
|
||||
@@ -68,9 +70,15 @@ RTEMS_INLINE_ROUTINE POSIX_Keys_Control *_POSIX_Keys_Get (
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief _POSIX_Keys_Is_null
|
||||
* @brief Check if a keys control block is NULL.
|
||||
*
|
||||
* This function returns TRUE if the_key is NULL and FALSE otherwise.
|
||||
* This function returns @c TRUE if the_key is @c NULL and @c FALSE
|
||||
* otherwise.
|
||||
*
|
||||
* @param[in] the_key is the pointer to the key control block to be checked.
|
||||
*
|
||||
* @retval TRUE The key control block is @c NULL.
|
||||
* @retval FALSE The key control block is not @c NULL.
|
||||
*/
|
||||
RTEMS_INLINE_ROUTINE bool _POSIX_Keys_Is_null (
|
||||
POSIX_Keys_Control *the_key
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
/**
|
||||
* @file rtems/posix/mqueue.inl
|
||||
* @file
|
||||
*
|
||||
* @brief Private Inlined Routines for POSIX Message Queue
|
||||
*
|
||||
* This include file contains the static inline implementation of the private
|
||||
* inlined routines for POSIX Message Queue.
|
||||
*/
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
/**
|
||||
* @file rtems/posix/mutex.inl
|
||||
* @file
|
||||
*
|
||||
* @brief Private Inlined Routines for POSIX Mutex's.
|
||||
*
|
||||
* This include file contains the static inline implementation of the private
|
||||
* inlined routines for POSIX mutex's.
|
||||
*/
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
/**
|
||||
* @file rtems/posix/priority.inl
|
||||
* @file
|
||||
*
|
||||
* @brief Inline Methods Related to POSIX Priority Management
|
||||
*
|
||||
* This defines the static inline methods related to POSIX priority management.
|
||||
*/
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
/**
|
||||
* @file rtems/posix/pthread.inl
|
||||
* @file
|
||||
*
|
||||
* @brief Private Inlined Routines for POSIX Threads
|
||||
*
|
||||
* This include file contains the static inline implementation of the private
|
||||
* inlined routines for POSIX threads.
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
/**
|
||||
* @file rtems/posix/rwlock.inl
|
||||
* @file
|
||||
*
|
||||
* @brief Inlined Routines from the POSIX RWLock Manager
|
||||
*
|
||||
* This file contains the static inlin implementation of the inlined
|
||||
* routines from the POSIX RWLock Manager.
|
||||
@@ -24,10 +26,10 @@
|
||||
#include <pthread.h>
|
||||
|
||||
/**
|
||||
* @brief _POSIX_RWLock_Allocate
|
||||
* @brief Allocate a RWLock control block.
|
||||
*
|
||||
* This function allocates a RWLock control block from
|
||||
* the inactive chain of free RWLock control blocks.
|
||||
* This function allocates a RWLock control block from
|
||||
* the inactive chain of free RWLock control blocks.
|
||||
*/
|
||||
RTEMS_INLINE_ROUTINE POSIX_RWLock_Control *_POSIX_RWLock_Allocate( void )
|
||||
{
|
||||
@@ -36,10 +38,10 @@ RTEMS_INLINE_ROUTINE POSIX_RWLock_Control *_POSIX_RWLock_Allocate( void )
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief _POSIX_RWLock_Free
|
||||
* @brief Free a RWLock control block.
|
||||
*
|
||||
* This routine frees a RWLock control block to the
|
||||
* inactive chain of free RWLock control blocks.
|
||||
* This routine frees a RWLock control block to the
|
||||
* inactive chain of free RWLock control blocks.
|
||||
*/
|
||||
RTEMS_INLINE_ROUTINE void _POSIX_RWLock_Free (
|
||||
POSIX_RWLock_Control *the_RWLock
|
||||
@@ -49,15 +51,15 @@ RTEMS_INLINE_ROUTINE void _POSIX_RWLock_Free (
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief _POSIX_RWLock_Get
|
||||
* @brief Get a RWLock control block.
|
||||
*
|
||||
* This function maps RWLock IDs to RWLock control blocks.
|
||||
* If ID corresponds to a local RWLock, then it returns
|
||||
* the_RWLock control pointer which maps to ID and location
|
||||
* is set to OBJECTS_LOCAL. if the RWLock ID is global and
|
||||
* resides on a remote node, then location is set to OBJECTS_REMOTE,
|
||||
* and the_RWLock is undefined. Otherwise, location is set
|
||||
* to OBJECTS_ERROR and the_RWLock is undefined.
|
||||
* This function maps RWLock IDs to RWLock control blocks.
|
||||
* If ID corresponds to a local RWLock, then it returns
|
||||
* the_RWLock control pointer which maps to ID and location
|
||||
* is set to OBJECTS_LOCAL. if the RWLock ID is global and
|
||||
* resides on a remote node, then location is set to OBJECTS_REMOTE,
|
||||
* and the_RWLock is undefined. Otherwise, location is set
|
||||
* to OBJECTS_ERROR and the_RWLock is undefined.
|
||||
*/
|
||||
RTEMS_INLINE_ROUTINE POSIX_RWLock_Control *_POSIX_RWLock_Get (
|
||||
pthread_rwlock_t *RWLock,
|
||||
@@ -72,9 +74,16 @@ RTEMS_INLINE_ROUTINE POSIX_RWLock_Control *_POSIX_RWLock_Get (
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief _POSIX_RWLock_Is_null
|
||||
* @brief Check if a RWLock control block is NULL.
|
||||
*
|
||||
* This function returns TRUE if the_RWLock is NULL and FALSE otherwise.
|
||||
* This function returns @c TRUE if the_RWLock is @c NULL and @c FALSE
|
||||
* otherwise.
|
||||
*
|
||||
* @param[in] the_RWLock is the pointer to the RWLock control block
|
||||
* to be checked.
|
||||
*
|
||||
* @retval TRUE The RWLock control block is @c NULL.
|
||||
* @retval FALSE The RWLock control block is not @c NULL.
|
||||
*/
|
||||
RTEMS_INLINE_ROUTINE bool _POSIX_RWLock_Is_null (
|
||||
POSIX_RWLock_Control *the_RWLock
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
/**
|
||||
* @file rtems/posix/semaphore.inl
|
||||
* @file
|
||||
*
|
||||
* @brief Private Inlined Routines for POSIX Semaphores
|
||||
*
|
||||
* This include file contains the static inline implementation of the private
|
||||
* inlined routines for POSIX Semaphores.
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
/**
|
||||
* @file rtems/posix/spinlock.inl
|
||||
* @file
|
||||
*
|
||||
* @brief Inlined Routines from the POSIX Spinlock Manager
|
||||
*
|
||||
* This file contains the static inlin implementation of the inlined
|
||||
* routines from the POSIX Spinlock Manager.
|
||||
@@ -24,10 +26,10 @@
|
||||
#include <pthread.h>
|
||||
|
||||
/**
|
||||
* @brief _POSIX_Spinlock_Allocate
|
||||
* @brief Allocate a spinlock control block.
|
||||
*
|
||||
* This function allocates a spinlock control block from
|
||||
* the inactive chain of free spinlock control blocks.
|
||||
* This function allocates a spinlock control block from
|
||||
* the inactive chain of free spinlock control blocks.
|
||||
*/
|
||||
RTEMS_INLINE_ROUTINE POSIX_Spinlock_Control *_POSIX_Spinlock_Allocate( void )
|
||||
{
|
||||
@@ -36,10 +38,10 @@ RTEMS_INLINE_ROUTINE POSIX_Spinlock_Control *_POSIX_Spinlock_Allocate( void )
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief _POSIX_Spinlock_Free
|
||||
* @brief Free a spinlock control block.
|
||||
*
|
||||
* This routine frees a spinlock control block to the
|
||||
* inactive chain of free spinlock control blocks.
|
||||
* This routine frees a spinlock control block to the
|
||||
* inactive chain of free spinlock control blocks.
|
||||
*/
|
||||
RTEMS_INLINE_ROUTINE void _POSIX_Spinlock_Free (
|
||||
POSIX_Spinlock_Control *the_spinlock
|
||||
@@ -49,15 +51,15 @@ RTEMS_INLINE_ROUTINE void _POSIX_Spinlock_Free (
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief _POSIX_Spinlock_Get
|
||||
* @brief Get a spinlock control block.
|
||||
*
|
||||
* This function maps spinlock IDs to spinlock control blocks.
|
||||
* If ID corresponds to a local spinlock, then it returns
|
||||
* the_spinlock control pointer which maps to ID and location
|
||||
* is set to OBJECTS_LOCAL. if the spinlock ID is global and
|
||||
* resides on a remote node, then location is set to OBJECTS_REMOTE,
|
||||
* and the_spinlock is undefined. Otherwise, location is set
|
||||
* to OBJECTS_ERROR and the_spinlock is undefined.
|
||||
* This function maps spinlock IDs to spinlock control blocks.
|
||||
* If ID corresponds to a local spinlock, then it returns
|
||||
* the_spinlock control pointer which maps to ID and location
|
||||
* is set to OBJECTS_LOCAL. if the spinlock ID is global and
|
||||
* resides on a remote node, then location is set to OBJECTS_REMOTE,
|
||||
* and the_spinlock is undefined. Otherwise, location is set
|
||||
* to OBJECTS_ERROR and the_spinlock is undefined.
|
||||
*/
|
||||
RTEMS_INLINE_ROUTINE POSIX_Spinlock_Control *_POSIX_Spinlock_Get (
|
||||
pthread_spinlock_t *spinlock,
|
||||
@@ -72,9 +74,16 @@ RTEMS_INLINE_ROUTINE POSIX_Spinlock_Control *_POSIX_Spinlock_Get (
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief _POSIX_Spinlock_Is_null
|
||||
* @brief Check if a spinlock control block is NULL.
|
||||
*
|
||||
* This function returns TRUE if the_spinlock is NULL and FALSE otherwise.
|
||||
* This function returns @c TRUE if the_spinlock is @c NULL and @c FALSE
|
||||
* otherwise.
|
||||
*
|
||||
* @param[in] the_spinlock is the pointer to the spinlock control block
|
||||
* to be checked.
|
||||
*
|
||||
* @retval TRUE The spinlock control block is @c NULL.
|
||||
* @retval FALSE The spinlock control block is not @c NULL.
|
||||
*/
|
||||
RTEMS_INLINE_ROUTINE bool _POSIX_Spinlock_Is_null (
|
||||
POSIX_Spinlock_Control *the_spinlock
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
/**
|
||||
* @file rtems/posix/timer.inl
|
||||
* @file
|
||||
*
|
||||
* @brief Inlined Routines from the POSIX Timer Manager
|
||||
*
|
||||
* This file contains the static inline implementation of the inlined routines
|
||||
* from the POSIX Timer Manager.
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user