[rtems commit] posix/config.h: Comment clean up
Joel Sherrill
joel at rtems.org
Tue Dec 10 01:46:24 UTC 2013
Module: rtems
Branch: master
Commit: 01d43180dde474a2a67e9771dbe614a48e46e895
Changeset: http://git.rtems.org/rtems/commit/?id=01d43180dde474a2a67e9771dbe614a48e46e895
Author: Joel Sherrill <joel.sherrill at oarcorp.com>
Date: Mon Dec 9 15:04:40 2013 -0600
posix/config.h: Comment clean up
---
cpukit/posix/include/rtems/posix/config.h | 112 ++++++++++++++++++++++++++---
1 files changed, 102 insertions(+), 10 deletions(-)
diff --git a/cpukit/posix/include/rtems/posix/config.h b/cpukit/posix/include/rtems/posix/config.h
index a842f7a..83bd1de 100644
--- a/cpukit/posix/include/rtems/posix/config.h
+++ b/cpukit/posix/include/rtems/posix/config.h
@@ -8,7 +8,7 @@
*/
/*
- * COPYRIGHT (c) 1989-2008.
+ * COPYRIGHT (c) 1989-2013.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -25,42 +25,133 @@
extern "C" {
#endif
-/*
- * XXX
+/**
+ * @defgroup ClassicConfig Configuration
*
- * The following records define the Configuration Table. The
- * information contained in this table is required in all
- * RTEMS systems, whether single or multiprocessor. This
- * table primarily defines the following:
+ * @ingroup ClassicRTEMS
*
- * + required number of each object type
+ * This encapsulates functionality related to the application's configuration
+ * of the Classic API including the maximum number of each class of objects.
*/
+/**@{*/
-/*
+/**
* For now, we are only allowing the user to specify the entry point
* and stack size for POSIX initialization threads.
*/
-
typedef struct {
+ /** This is the entry point for a POSIX initialization thread. */
void *(*thread_entry)(void *);
+ /** This is the stack size for a POSIX initialization thread. */
int stack_size;
} posix_initialization_threads_table;
+/**
+ * The following records define the POSIX Configuration Table.
+ * The information contained in this table is required in all
+ * RTEMS systems which include POSIX threads support, whether
+ * single or multiprocessor. This table primarily defines the
+ * following:
+ *
+ * + required number of each object type
+ */
typedef struct {
+ /**
+ * This field contains the maximum number of POSIX API
+ * threads which are configured for this application.
+ */
uint32_t maximum_threads;
+
+ /**
+ * This field contains the maximum number of POSIX API
+ * mutexes which are configured for this application.
+ */
uint32_t maximum_mutexes;
+
+ /**
+ * This field contains the maximum number of POSIX API
+ * condition variables which are configured for this application.
+ */
uint32_t maximum_condition_variables;
+
+ /**
+ * This field contains the maximum number of POSIX API
+ * keys which are configured for this application.
+ */
uint32_t maximum_keys;
+
+ /**
+ * This field contains the maximum number of POSIX API
+ * key value pairs which are configured for this application.
+ *
+ * @note There can be potentially be a key/value pair for
+ * every thread to use every key. But normally this
+ * many are not needed in a system.
+ */
uint32_t maximum_key_value_pairs;
+
+ /**
+ * This field contains the maximum number of POSIX API
+ * timers which are configured for this application.
+ */
uint32_t maximum_timers;
+
+ /**
+ * This field contains the maximum number of POSIX API
+ * queued signals which are configured for this application.
+ */
uint32_t maximum_queued_signals;
+
+ /**
+ * This field contains the maximum number of POSIX API
+ * message queues which are configured for this application.
+ */
uint32_t maximum_message_queues;
+
+ /**
+ * This field contains the maximum number of POSIX API
+ * message queue file descriptors which are configured
+ * for this application.
+ *
+ * @note There can be one or more file descriptors used with
+ * each message queue. This value should be greater than
+ * or equal to the number of message queues.
+ */
uint32_t maximum_message_queue_descriptors;
+
+ /**
+ * This field contains the maximum number of POSIX API
+ * semaphores which are configured for this application.
+ */
uint32_t maximum_semaphores;
+
+ /**
+ * This field contains the maximum number of POSIX API
+ * barriers which are configured for this application.
+ */
uint32_t maximum_barriers;
+
+ /**
+ * This field contains the maximum number of POSIX API
+ * read/write locks which are configured for this application.
+ */
uint32_t maximum_rwlocks;
+
+ /**
+ * This field contains the maximum number of POSIX API
+ * spinlocks which are configured for this application.
+ */
uint32_t maximum_spinlocks;
+
+ /**
+ * This field contains the number of POSIX API Initialization
+ * threads listed in @a User_initialization_thread_table.
+ */
uint32_t number_of_initialization_threads;
+
+ /**
+ * This field contains the list of POSIX API Initialization threads.
+ */
posix_initialization_threads_table *User_initialization_threads_table;
} posix_api_configuration_table;
@@ -72,6 +163,7 @@ typedef struct {
*/
extern posix_api_configuration_table Configuration_POSIX_API;
+/**@}*/
#ifdef __cplusplus
}
#endif
More information about the vc
mailing list