summaryrefslogtreecommitdiffstats
path: root/cpukit/posix/include/rtems/posix/priority.h
diff options
context:
space:
mode:
Diffstat (limited to 'cpukit/posix/include/rtems/posix/priority.h')
-rw-r--r--cpukit/posix/include/rtems/posix/priority.h64
1 files changed, 35 insertions, 29 deletions
diff --git a/cpukit/posix/include/rtems/posix/priority.h b/cpukit/posix/include/rtems/posix/priority.h
index a6a3c289da..e9ee2f900b 100644
--- a/cpukit/posix/include/rtems/posix/priority.h
+++ b/cpukit/posix/include/rtems/posix/priority.h
@@ -1,5 +1,7 @@
/**
- * @file rtems/posix/priority.h
+ * @file
+ *
+ * @brief POSIX Priority Support
*
* This include file defines the interface to the POSIX priority
* implementation.
@@ -20,28 +22,30 @@
/**
* @defgroup POSIX_PRIORITY POSIX Priority Support
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @brief Interface to the POSIX Priority Implementation
+ *
*/
+/**@{**/
#include <rtems/score/priority.h>
/**
- * 1003.1b-1993,2.2.2.80 definition of priority, p. 19
+ * 1003.1b-1993,2.2.2.80 definition of priority, p. 19
*
- * "Numerically higher values represent higher priorities."
+ * "Numerically higher values represent higher priorities."
*
- * Thus, RTEMS Core has priorities run in the opposite sense of the POSIX API.
+ * Thus, RTEMS Core has priorities run in the opposite sense of the POSIX API.
*
- * There are only 254 posix priority levels since a task at priority level
- * 255 would never run because of the RTEMS idle task. This is necessary
- * because GNAT maps the lowest Ada task priority to the lowest thread
- * priority. The lowest priority Ada task should get to run, so there is
- * a fundamental conflict with having 255 priorities.
+ * There are only 254 posix priority levels since a task at priority level
+ * 255 would never run because of the RTEMS idle task. This is necessary
+ * because GNAT maps the lowest Ada task priority to the lowest thread
+ * priority. The lowest priority Ada task should get to run, so there is
+ * a fundamental conflict with having 255 priorities.
*
- * But since RTEMS can be configured with fewer than 256 priorities,
- * we use the internal constant.
+ * But since RTEMS can be configured with fewer than 256 priorities,
+ * we use the internal constant.
*/
#define POSIX_SCHEDULER_MAXIMUM_PRIORITY (PRIORITY_MAXIMUM - 1)
@@ -52,46 +56,46 @@
#define POSIX_SCHEDULER_MINIMUM_PRIORITY (1)
/**
- * @brief POSIX Is Priority Valid
+ * @brief Check if POSIX priority is valid.
*
- * 1003.1b-1993,2.2.2.80 definition of priority, p. 19
+ * 1003.1b-1993,2.2.2.80 definition of priority, p. 19
*
- * "Numerically higher values represent higher priorities."
+ * "Numerically higher values represent higher priorities."
*
- * Thus, RTEMS Core has priorities run in the opposite sense of the POSIX API.
+ * Thus, RTEMS Core has priorities run in the opposite sense of the POSIX API.
*
- * @param[in] priority is the priority to test
+ * @param[in] priority is the priority to test
*
- * @return This method returns true if the priority is valid and
- * false otherwise.
+ * @retval TRUE The priority is valid.
+ * @retval FALSE The priority is invalid.
*/
bool _POSIX_Priority_Is_valid(
int priority
);
/**
- * @brief Convert POSIX Priority To SuperCore Priority
+ * @brief Convert POSIX priority to SuperCore priority.
*
- * This method converts a POSIX API priority into onto the corresponding
- * SuperCore value.
+ * This method converts a POSIX API priority into onto the corresponding
+ * SuperCore value.
*
- * @param[in] priority is the POSIX API priority.
+ * @param[in] priority is the POSIX API priority.
*
- * @return This method returns the corresponding SuperCore priority.
+ * @return This method returns the corresponding SuperCore priority.
*/
RTEMS_INLINE_ROUTINE Priority_Control _POSIX_Priority_To_core(
int priority
);
/**
- * @brief Convert SuperCore Priority To POSIX Priority
+ * @brief Convert SuperCore priority To POSIX priority.
*
- * This method converts a SuperCore priority into onto the corresponding
- * POSIX API value.
+ * This method converts a SuperCore priority into onto the corresponding
+ * POSIX API value.
*
- * @param[in] priority is the POSIX API priority.
+ * @param[in] priority is the POSIX API priority.
*
- * @return This method returns the corresponding POSIX priority.
+ * @return This method returns the corresponding POSIX priority.
*/
RTEMS_INLINE_ROUTINE int _POSIX_Priority_From_core(
Priority_Control priority
@@ -99,4 +103,6 @@ RTEMS_INLINE_ROUTINE int _POSIX_Priority_From_core(
#include <rtems/posix/priority.inl>
+/** @} */
+
#endif