diff options
Diffstat (limited to 'cpukit/posix/include/rtems')
| -rw-r--r-- | cpukit/posix/include/rtems/posix/cond.h | 11 | ||||
| -rw-r--r-- | cpukit/posix/include/rtems/posix/key.h | 2 | ||||
| -rw-r--r-- | cpukit/posix/include/rtems/posix/mqueue.h | 58 | ||||
| -rw-r--r-- | cpukit/posix/include/rtems/posix/mutex.h | 18 | ||||
| -rw-r--r-- | cpukit/posix/include/rtems/posix/priority.h | 10 | ||||
| -rw-r--r-- | cpukit/posix/include/rtems/posix/psignalimpl.h | 25 | ||||
| -rw-r--r-- | cpukit/posix/include/rtems/posix/pthread.h | 23 | ||||
| -rw-r--r-- | cpukit/posix/include/rtems/posix/ptimer.h | 12 | ||||
| -rw-r--r-- | cpukit/posix/include/rtems/posix/rwlock.h | 10 | ||||
| -rw-r--r-- | cpukit/posix/include/rtems/posix/semaphore.h | 17 | ||||
| -rw-r--r-- | cpukit/posix/include/rtems/posix/spinlock.h | 10 |
11 files changed, 165 insertions, 31 deletions
diff --git a/cpukit/posix/include/rtems/posix/cond.h b/cpukit/posix/include/rtems/posix/cond.h index b089abe4a9..93b5b4cf2a 100644 --- a/cpukit/posix/include/rtems/posix/cond.h +++ b/cpukit/posix/include/rtems/posix/cond.h @@ -148,15 +148,14 @@ int _POSIX_Condition_variables_Signal_support( bool is_broadcast ); -/* - * _POSIX_Condition_variables_Wait_support +/** + * @brief POSIX Condition Variables Wait Support * - * DESCRIPTION: + * DESCRIPTION: * - * A support routine which implements guts of the blocking, non-blocking, and - * timed wait version of condition variable wait routines. + * A support routine which implements guts of the blocking, non-blocking, and + * timed wait version of condition variable wait routines. */ - int _POSIX_Condition_variables_Wait_support( pthread_cond_t *cond, pthread_mutex_t *mutex, diff --git a/cpukit/posix/include/rtems/posix/key.h b/cpukit/posix/include/rtems/posix/key.h index ce4f093b13..edcaa42685 100644 --- a/cpukit/posix/include/rtems/posix/key.h +++ b/cpukit/posix/include/rtems/posix/key.h @@ -58,7 +58,7 @@ POSIX_EXTERN Objects_Information _POSIX_Keys_Information; void _POSIX_Key_Manager_initialization(void); /** - * @brief _POSIX_Keys_Run_destructors + * @brief Thread-Specific Data Key Create * * This function executes all the destructors associated with the thread's * keys. This function will execute until all values have been set to NULL. diff --git a/cpukit/posix/include/rtems/posix/mqueue.h b/cpukit/posix/include/rtems/posix/mqueue.h index ea94669e71..582d5b73b2 100644 --- a/cpukit/posix/include/rtems/posix/mqueue.h +++ b/cpukit/posix/include/rtems/posix/mqueue.h @@ -3,6 +3,18 @@ * * This include file contains all the private support information for * POSIX Message Queues. + * + * The structure of the routines is identical to that of POSIX + * Message_queues to leave the option of having unnamed message + * queues at a future date. They are currently not part of the + * POSIX standard but unnamed message_queues are. This is also + * the reason for the apparently unnecessary tracking of + * the process_shared attribute. [In addition to the fact that + * it would be trivial to add pshared to the mq_attr structure + * and have process private message queues.] + * + * This code ignores the O_RDONLY/O_WRONLY/O_RDWR flag at open + * time. */ /* @@ -23,10 +35,20 @@ #include <rtems/score/object.h> #include <rtems/posix/posixapi.h> +/** + * @defgroup POSIX_MQUEUE_P Message Queues Private Support Information + * + * @ingroup POSIX + */ +/**@{*/ #ifdef __cplusplus extern "C" { #endif +/** + * @ingroup POSIX_MQUEUE + */ + /* * Data Structure used to manage a POSIX message queue */ @@ -57,11 +79,24 @@ POSIX_EXTERN Objects_Information _POSIX_Message_queue_Information; POSIX_EXTERN Objects_Information _POSIX_Message_queue_Information_fds; /* - * _POSIX_Message_queue_Manager_initialization + * @brief Initializes message_queue Manager Related Data Structures * * DESCRIPTION: * * This routine performs the initialization necessary for this manager. + * + * NOTE: The structure of the routines is identical to that of POSIX + * Message_queues to leave the option of having unnamed message + * queues at a future date. They are currently not part of the + * POSIX standard but unnamed message_queues are. This is also + * the reason for the apparently unnecessary tracking of + * the process_shared attribute. [In addition to the fact that + * it would be trivial to add pshared to the mq_attr structure + * and have process private message queues.] + * + * This code ignores the O_RDONLY/O_WRONLY/O_RDWR flag at open + * time. + * */ void _POSIX_Message_queue_Manager_initialization(void); @@ -84,25 +119,36 @@ int _POSIX_Message_queue_Create_support( POSIX_Message_queue_Control **message_queue ); -/* - * _POSIX_Message_queue_Delete +/** + * @brief POSIX Delete Message Queue * * DESCRIPTION: * * This routine supports the mq_unlink and mq_close routines by * doing most of the work involved with removing a message queue. */ - void _POSIX_Message_queue_Delete( POSIX_Message_queue_Control *the_mq ); /* - * _POSIX_Message_queue_Receive_support + * @brief POSIX Message Queue Receive Support * * DESCRIPTION: * * This routine supports the various flavors of receiving a message. + * + * NOTE: The structure of the routines is identical to that of POSIX + * Message_queues to leave the option of having unnamed message + * queues at a future date. They are currently not part of the + * POSIX standard but unnamed message_queues are. This is also + * the reason for the apparently unnecessary tracking of + * the process_shared attribute. [In addition to the fact that + * it would be trivial to add pshared to the mq_attr structure + * and have process private message queues.] + * + * This code ignores the O_RDONLY/O_WRONLY/O_RDWR flag at open + * time. */ ssize_t _POSIX_Message_queue_Receive_support( @@ -228,6 +274,6 @@ int _POSIX_Message_queue_Translate_core_message_queue_return_code( #ifdef __cplusplus } #endif - +/**@}*/ #endif /* end of include file */ diff --git a/cpukit/posix/include/rtems/posix/mutex.h b/cpukit/posix/include/rtems/posix/mutex.h index dc133d5421..727745ae67 100644 --- a/cpukit/posix/include/rtems/posix/mutex.h +++ b/cpukit/posix/include/rtems/posix/mutex.h @@ -21,6 +21,14 @@ extern "C" { #endif +/** + * @defgroup POSIX_MUTEX POSIX Mutex Support + * + * @ingroup POSIX + * + * @brief Private Support Information for POSIX Mutex + */ + #include <rtems/score/coremutex.h> #include <pthread.h> @@ -48,7 +56,7 @@ POSIX_EXTERN Objects_Information _POSIX_Mutex_Information; POSIX_EXTERN pthread_mutexattr_t _POSIX_Mutex_Default_attributes; /* - * _POSIX_Mutex_Manager_initialization + * @brief POSIX Mutex Manager Initialization * * DESCRIPTION: * @@ -129,13 +137,17 @@ int _POSIX_Mutex_Lock_support( Watchdog_Interval timeout ); -/* - * _POSIX_Mutex_Translate_core_mutex_return_code +/** + * @brief POSIX Mutex Translate Core Mutex Return Code * * DESCRIPTION: * * 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 + * + * @return the translated POSIX status code */ int _POSIX_Mutex_Translate_core_mutex_return_code( diff --git a/cpukit/posix/include/rtems/posix/priority.h b/cpukit/posix/include/rtems/posix/priority.h index 62ec9fbe2d..a6a3c289da 100644 --- a/cpukit/posix/include/rtems/posix/priority.h +++ b/cpukit/posix/include/rtems/posix/priority.h @@ -17,6 +17,14 @@ #ifndef _RTEMS_POSIX_PRIORITY_H #define _RTEMS_POSIX_PRIORITY_H +/** + * @defgroup POSIX_PRIORITY POSIX Priority Support + * + * @ingroup POSIX + * + * @brief Interface to the POSIX Priority Implementation + */ + #include <rtems/score/priority.h> /** @@ -44,6 +52,8 @@ #define POSIX_SCHEDULER_MINIMUM_PRIORITY (1) /** + * @brief POSIX Is Priority Valid + * * 1003.1b-1993,2.2.2.80 definition of priority, p. 19 * * "Numerically higher values represent higher priorities." diff --git a/cpukit/posix/include/rtems/posix/psignalimpl.h b/cpukit/posix/include/rtems/posix/psignalimpl.h index 6c46f3c49c..c416a7aa1b 100644 --- a/cpukit/posix/include/rtems/posix/psignalimpl.h +++ b/cpukit/posix/include/rtems/posix/psignalimpl.h @@ -16,6 +16,14 @@ #ifndef _RTEMS_POSIX_PSIGNALIMPL_H #define _RTEMS_POSIX_PSIGNALIMPL_H +/** + * @defgroup POSIX_SIGNALS POSIX Signals Support + * + * @ingroup POSIX + * + * @brief Internal Information about POSIX Signals + */ + #include <rtems/posix/psignal.h> #include <rtems/posix/pthread.h> #include <rtems/posix/sigset.h> @@ -63,6 +71,9 @@ extern API_extensions_Post_switch_control _POSIX_signals_Post_switch; * Internal routines */ +/** + * @brief POSIX Signals Manager Initialization + */ void _POSIX_signals_Manager_Initialization(void); static inline void _POSIX_signals_Add_post_switch_extension(void) @@ -70,18 +81,29 @@ static inline void _POSIX_signals_Add_post_switch_extension(void) _API_extensions_Add_post_switch( &_POSIX_signals_Post_switch ); } +/** + * @brief POSIX Signals Thread Unlock + * + * XXX this routine could probably be cleaned up + */ bool _POSIX_signals_Unblock_thread( Thread_Control *the_thread, int signo, siginfo_t *info ); +/** + * @brief POSIX Signals Check Signal + */ bool _POSIX_signals_Check_signal( POSIX_API_Control *api, int signo, bool is_global ); +/** + * @brief POSIX Signals Clear Signals + */ bool _POSIX_signals_Clear_signals( POSIX_API_Control *api, int signo, @@ -96,6 +118,9 @@ int killinfo( const union sigval *value ); +/** + * @brief POSIX Signals Set Process Signals + */ void _POSIX_signals_Set_process_signals( sigset_t mask ); diff --git a/cpukit/posix/include/rtems/posix/pthread.h b/cpukit/posix/include/rtems/posix/pthread.h index 52ad486337..5932d45a39 100644 --- a/cpukit/posix/include/rtems/posix/pthread.h +++ b/cpukit/posix/include/rtems/posix/pthread.h @@ -21,9 +21,24 @@ #include <rtems/posix/config.h> #include <rtems/posix/threadsup.h> +/** + * @defgroup POSIX_PTHREADS Private Threads + * + * @ingroup POSIX + */ +/**@{*/ #ifdef __cplusplus extern "C" { #endif + +/** + * @defgroup POSIX_PTHREAD POSIX Threads Support + * + * @ingroup POSIX + * + * @brief Private Support Information for POSIX Threads + */ + /** * The following sets the minimum stack size for POSIX threads. */ @@ -164,10 +179,10 @@ int _POSIX_Thread_Translate_sched_param( ); /** - * @brief _POSIX_Threads_Initialize_user_threads_body + * @brief POSIX Threads Initialize User Threads Body * - * This routine creates and starts all configured user - * initialization threads. + * This routine creates and starts all configured user + * initialization threads. */ extern void _POSIX_Threads_Initialize_user_threads_body(void); @@ -176,6 +191,6 @@ extern void _POSIX_Threads_Initialize_user_threads_body(void); #ifdef __cplusplus } #endif - +/**@}*/ #endif /* end of include file */ diff --git a/cpukit/posix/include/rtems/posix/ptimer.h b/cpukit/posix/include/rtems/posix/ptimer.h index a7c083711a..1b791cc915 100644 --- a/cpukit/posix/include/rtems/posix/ptimer.h +++ b/cpukit/posix/include/rtems/posix/ptimer.h @@ -88,13 +88,15 @@ int timer_gettime( struct itimerspec *value ); -/* +/** + * @brief Get Overrun Count for a POSIX Per-Process Timer + * + * The expiration of a timer must increase by one a counter. + * After the signal handler associated to the timer finishes + * its execution, _POSIX_Timer_TSR will have to set this counter to 0. + * * 14.2.4 Per-Process Timers, P1003.1b-1993, p. 267 - * - * timer_getoverrun - * */ - int timer_getoverrun( timer_t timerid ); diff --git a/cpukit/posix/include/rtems/posix/rwlock.h b/cpukit/posix/include/rtems/posix/rwlock.h index c4f2d7e146..411384c2c6 100644 --- a/cpukit/posix/include/rtems/posix/rwlock.h +++ b/cpukit/posix/include/rtems/posix/rwlock.h @@ -27,6 +27,14 @@ extern "C" { #endif +/** + * @defgroup POSIX_RWLOCK POSIX RWLock Manager + * + * @ingroup POSIX + * + * @brief Constants and Structures Associated with the POSIX RWLock Manager + */ + #include <rtems/score/object.h> #include <rtems/score/corerwlock.h> @@ -60,7 +68,7 @@ POSIX_EXTERN Objects_Information _POSIX_RWLock_Information; void _POSIX_RWLock_Manager_initialization(void); /** - * @brief _POSIX_RWLock_Translate_core_RWLock_return_code ( + * @brief POSIX RWLock Translate Core RWLock Return Code * * This routine translates SuperCore RWLock status codes into the * corresponding POSIX ones. diff --git a/cpukit/posix/include/rtems/posix/semaphore.h b/cpukit/posix/include/rtems/posix/semaphore.h index 08df44be4f..08ace7684f 100644 --- a/cpukit/posix/include/rtems/posix/semaphore.h +++ b/cpukit/posix/include/rtems/posix/semaphore.h @@ -17,10 +17,20 @@ #ifndef _RTEMS_POSIX_SEMAPHORE_H #define _RTEMS_POSIX_SEMAPHORE_H +/** + * @defgroup POSIX_SEMAPHORES Semaphore + * + * @ingroup POSIX + */ +/**@{*/ #ifdef __cplusplus extern "C" { #endif +/** + * @ingroup POSIX_SEMAPHORE + */ + #include <semaphore.h> #include <rtems/score/coresem.h> #include <rtems/posix/posixapi.h> @@ -134,20 +144,19 @@ int _POSIX_Semaphore_Create_support( POSIX_Semaphore_Control **the_sem ); -/* - * _POSIX_Semaphore_Delete +/** + * @brief POSIX Delete Semaphore * * DESCRIPTION: * * This routine supports the sem_close and sem_unlink routines. */ - void _POSIX_Semaphore_Delete( POSIX_Semaphore_Control *the_semaphore ); /* - * _POSIX_Semaphore_Wait_support + * @brief POSIX Semaphore Wait Support * * DESCRIPTION: * diff --git a/cpukit/posix/include/rtems/posix/spinlock.h b/cpukit/posix/include/rtems/posix/spinlock.h index 892040e8b8..44061bd42c 100644 --- a/cpukit/posix/include/rtems/posix/spinlock.h +++ b/cpukit/posix/include/rtems/posix/spinlock.h @@ -27,6 +27,14 @@ extern "C" { #endif +/** + * @defgroup POSIX_SPINLOCK POSIX Spinlock Support + * + * @ingroup POSIX + * + * @brief Constants and Structures Associated with the POSIX Spinlock Manager + */ + #include <rtems/score/object.h> #include <rtems/score/corespinlock.h> @@ -60,7 +68,7 @@ POSIX_EXTERN Objects_Information _POSIX_Spinlock_Information; void _POSIX_Spinlock_Manager_initialization(void); /** - * @brief _POSIX_Spinlock_Translate_core_spinlock_return_code ( + * @brief POSIX Spinlock Translate Core Spinlock Return Code * * This routine translates SuperCore Spinlock status codes into the * corresponding POSIX ones. |