summaryrefslogtreecommitdiffstats
path: root/cpukit/score/inline/rtems/score/prioritybitmap.inl
diff options
context:
space:
mode:
authorAlex Ivanov <alexivanov97@gmail.com>2013-01-09 11:20:58 -0500
committerGedare Bloom <gedare@rtems.org>2013-01-09 11:20:58 -0500
commitd8134178deaa9728013ccb858bb0784bce533663 (patch)
treeadf7a7b2d88e5f85ed9151430bd3fa86b36ea42e /cpukit/score/inline/rtems/score/prioritybitmap.inl
parentbsps/arm: Fix LPC Ethernet driver initialization (diff)
downloadrtems-d8134178deaa9728013ccb858bb0784bce533663.tar.bz2
score: Doxygen Clean Up Task #18
http://www.google-melange.com/gci/task/view/google/gci2012/8137204
Diffstat (limited to 'cpukit/score/inline/rtems/score/prioritybitmap.inl')
-rw-r--r--cpukit/score/inline/rtems/score/prioritybitmap.inl67
1 files changed, 35 insertions, 32 deletions
diff --git a/cpukit/score/inline/rtems/score/prioritybitmap.inl b/cpukit/score/inline/rtems/score/prioritybitmap.inl
index 76bb1a1c83..01fa32686e 100644
--- a/cpukit/score/inline/rtems/score/prioritybitmap.inl
+++ b/cpukit/score/inline/rtems/score/prioritybitmap.inl
@@ -1,8 +1,10 @@
-/**
- * @file rtems/score/prioritybitmap.inl
+/**
+ * @file
+ *
+ * @brief Inlined Routines in the Priority Handler Bit Map Implementation
*
- * This file contains the static inline implementation of all inlined
- * routines in the Priority Handler bit map implementation
+ * This file contains the static inline implementation of all inlined
+ * routines in the Priority Handler bit map implementation
*/
/*
@@ -22,14 +24,15 @@
#define _RTEMS_SCORE_PRIORITYBITMAP_INL
/**
- * @addtogroup ScorePriority
- * @{
+ * @addtogroup ScorePriority
+ *
+ * @{
*/
#include <rtems/score/bitfield.h>
/**
- * This function returns the major portion of the_priority.
+ * This function returns the major portion of the_priority.
*/
RTEMS_INLINE_ROUTINE Priority_bit_map_Control _Priority_Major (
@@ -40,7 +43,7 @@ RTEMS_INLINE_ROUTINE Priority_bit_map_Control _Priority_Major (
}
/**
- * This function returns the minor portion of the_priority.
+ * This function returns the minor portion of the_priority.
*/
RTEMS_INLINE_ROUTINE Priority_bit_map_Control _Priority_Minor (
@@ -51,23 +54,23 @@ RTEMS_INLINE_ROUTINE Priority_bit_map_Control _Priority_Minor (
}
#if ( CPU_USE_GENERIC_BITFIELD_CODE == TRUE )
-
+
/**
- * This function returns the mask associated with the major or minor
- * number passed to it.
+ * This function returns the mask associated with the major or minor
+ * number passed to it.
*/
-
+
RTEMS_INLINE_ROUTINE Priority_bit_map_Control _Priority_Mask (
uint32_t bit_number
)
{
return (Priority_bit_map_Control)(0x8000u >> bit_number);
}
-
+
/**
- * This function returns the mask bit inverted.
+ * This function returns the mask bit inverted.
*/
-
+
RTEMS_INLINE_ROUTINE Priority_bit_map_Control _Priority_Mask_invert (
uint32_t mask
)
@@ -75,13 +78,13 @@ RTEMS_INLINE_ROUTINE Priority_bit_map_Control _Priority_Mask_invert (
return (Priority_bit_map_Control)(~mask);
}
-
+
/**
- * This function translates the bit numbers returned by the bit scan
- * of a priority bit field into something suitable for use as
- * a major or minor component of a priority.
+ * This function translates the bit numbers returned by the bit scan
+ * of a priority bit field into something suitable for use as
+ * a major or minor component of a priority.
*/
-
+
RTEMS_INLINE_ROUTINE uint32_t _Priority_Bits_index (
uint32_t bit_number
)
@@ -96,7 +99,7 @@ RTEMS_INLINE_ROUTINE uint32_t _Priority_Bits_index (
*/
/**
- * This routine performs the initialization necessary for this handler.
+ * This routine performs the initialization necessary for this handler.
*/
RTEMS_INLINE_ROUTINE void _Priority_bit_map_Handler_initialization( void )
@@ -109,8 +112,8 @@ RTEMS_INLINE_ROUTINE void _Priority_bit_map_Handler_initialization( void )
}
/**
- * This routine uses the_priority_map to update the priority
- * bit maps to indicate that a thread has been readied.
+ * This routine uses the_priority_map to update the priority
+ * bit maps to indicate that a thread has been readied.
*/
RTEMS_INLINE_ROUTINE void _Priority_bit_map_Add (
@@ -122,9 +125,9 @@ RTEMS_INLINE_ROUTINE void _Priority_bit_map_Add (
}
/**
- * This routine uses the_priority_map to update the priority
- * bit maps to indicate that a thread has been removed from the
- * ready state.
+ * This routine uses the_priority_map to update the priority
+ * bit maps to indicate that a thread has been removed from the
+ * ready state.
*/
RTEMS_INLINE_ROUTINE void _Priority_bit_map_Remove (
@@ -137,8 +140,8 @@ RTEMS_INLINE_ROUTINE void _Priority_bit_map_Remove (
}
/**
- * This function returns the priority of the highest priority
- * ready thread.
+ * This function returns the priority of the highest priority
+ * ready thread.
*/
RTEMS_INLINE_ROUTINE Priority_Control _Priority_bit_map_Get_highest( void )
@@ -154,9 +157,9 @@ RTEMS_INLINE_ROUTINE Priority_Control _Priority_bit_map_Get_highest( void )
}
/**
- * This routine initializes the_priority_map so that it
- * contains the information necessary to manage a thread
- * at new_priority.
+ * This routine initializes the_priority_map so that it
+ * contains the information necessary to manage a thread
+ * at new_priority.
*/
RTEMS_INLINE_ROUTINE void _Priority_bit_map_Initialize_information(
@@ -185,7 +188,7 @@ RTEMS_INLINE_ROUTINE void _Priority_bit_map_Initialize_information(
the_priority_map->block_minor = (Priority_bit_map_Control)(~((uint32_t)mask));
}
-/**@}*/
+/** @} */
#endif
/* end of include file */