summaryrefslogtreecommitdiffstats
path: root/cpukit/posix/include
diff options
context:
space:
mode:
Diffstat (limited to 'cpukit/posix/include')
-rw-r--r--cpukit/posix/include/aio.h20
-rw-r--r--cpukit/posix/include/rtems/posix/mqueue.h21
-rw-r--r--cpukit/posix/include/rtems/posix/psignalimpl.h6
-rw-r--r--cpukit/posix/include/rtems/posix/ptimer.h12
-rw-r--r--cpukit/posix/include/rtems/posix/semaphore.h9
-rw-r--r--cpukit/posix/include/rtems/posix/spinlock.h10
-rw-r--r--cpukit/posix/include/semaphore.h5
7 files changed, 69 insertions, 14 deletions
diff --git a/cpukit/posix/include/aio.h b/cpukit/posix/include/aio.h
index de0bdd5603..f4f824ab69 100644
--- a/cpukit/posix/include/aio.h
+++ b/cpukit/posix/include/aio.h
@@ -23,6 +23,14 @@
extern "C" {
#endif
+/**
+ * @defgroup POSIX_AIO POSIX Asynchronous I/O Support
+ *
+ * @ingroup POSIX
+ *
+ * @brief POSIX Asynchronous Input and Output
+ */
+
#if defined(_POSIX_ASYNCHRONOUS_IO)
/*
@@ -126,10 +134,18 @@ ssize_t aio_return(
const struct aiocb *aiocbp
);
-/*
+/**
+ * @brief Cancel Asynchronous I/O Operation
+ *
* 6.7.7 Cancel Asynchronous I/O Operation, P1003.1b-1993, p. 163
+ *
+ * @param[in] filedes is the file descriptor
+ * @param[in] aiocbp is the asynchronous I/O control block
+ *
+ * @return This method returns AIO_CANCELED if the requested operation(s)
+ * were canceled. Otherwise, AIO_NOTCANCELED is returned indicating
+ * that at least one of the requested operation(s) cannot be canceled
*/
-
int aio_cancel(
int filedes,
struct aiocb *aiocbp
diff --git a/cpukit/posix/include/rtems/posix/mqueue.h b/cpukit/posix/include/rtems/posix/mqueue.h
index ea94669e71..9226d6f86e 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.
*/
/*
@@ -27,6 +39,10 @@
extern "C" {
#endif
+/**
+ * @ingroup POSIX_MQUEUE
+ */
+
/*
* Data Structure used to manage a POSIX message queue
*/
@@ -84,15 +100,14 @@ 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
);
diff --git a/cpukit/posix/include/rtems/posix/psignalimpl.h b/cpukit/posix/include/rtems/posix/psignalimpl.h
index d9ba88427a..b8e5e1e0ea 100644
--- a/cpukit/posix/include/rtems/posix/psignalimpl.h
+++ b/cpukit/posix/include/rtems/posix/psignalimpl.h
@@ -71,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)
@@ -107,6 +110,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/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/semaphore.h b/cpukit/posix/include/rtems/posix/semaphore.h
index 08df44be4f..378b284c42 100644
--- a/cpukit/posix/include/rtems/posix/semaphore.h
+++ b/cpukit/posix/include/rtems/posix/semaphore.h
@@ -21,6 +21,10 @@
extern "C" {
#endif
+/**
+ * @ingroup POSIX_SEMAPHORE
+ */
+
#include <semaphore.h>
#include <rtems/score/coresem.h>
#include <rtems/posix/posixapi.h>
@@ -134,14 +138,13 @@ 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
);
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.
diff --git a/cpukit/posix/include/semaphore.h b/cpukit/posix/include/semaphore.h
index 1dc82bedef..17c583240c 100644
--- a/cpukit/posix/include/semaphore.h
+++ b/cpukit/posix/include/semaphore.h
@@ -99,6 +99,11 @@ int sem_wait(
sem_t *sem
);
+/**
+ * @brief Lock a Semaphore
+ *
+ * @see sem_wait()
+ */
int sem_trywait(
sem_t *sem
);