diff options
author | Mathew Kallada <matkallada@gmail.com> | 2013-01-04 09:01:21 -0600 |
---|---|---|
committer | Jennifer Averett <jennifer.averett@oarcorp.com> | 2013-01-04 09:01:21 -0600 |
commit | a1f9934a8f096489620362620ef610b52a3c4ae1 (patch) | |
tree | 8900752d54ec06326cfde1b783c2fc5ecb593170 /cpukit/score/include/rtems/score/schedulersimplesmp.h | |
parent | score: Doxygen Clean Up Task #9 (diff) | |
download | rtems-a1f9934a8f096489620362620ef610b52a3c4ae1.tar.bz2 |
score: Doxygen Clean Up Task #3
Diffstat (limited to 'cpukit/score/include/rtems/score/schedulersimplesmp.h')
-rw-r--r-- | cpukit/score/include/rtems/score/schedulersimplesmp.h | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/cpukit/score/include/rtems/score/schedulersimplesmp.h b/cpukit/score/include/rtems/score/schedulersimplesmp.h index e915993a52..86c7d9a900 100644 --- a/cpukit/score/include/rtems/score/schedulersimplesmp.h +++ b/cpukit/score/include/rtems/score/schedulersimplesmp.h @@ -1,6 +1,8 @@ /** * @file rtems/score/schedulersimplesmp.h * + * @brief Manipulation of Threads on a Simple-Priority-Based Ready Queue + * * This include file contains all the constants and structures associated * with the manipulation of threads on a simple-priority-based ready queue. * This implementation is SMP-aware and schedules across multiple cores. @@ -21,6 +23,10 @@ #define _RTEMS_SCORE_SCHEDULERSIMPLE_SMP_H /** + * @defgroup ScoreScheduler + * + * @ingroup Score + * * @addtogroup ScoreScheduler * * The Simple SMP Scheduler attempts to faithfully implement the @@ -62,7 +68,7 @@ extern "C" { } /** - * @brief Scheduler Simple SMP Schedule Method + * @brief Allocates ready SMP threads to individual cores in an SMP system. * * This routine allocates ready threads to individual cores in an SMP * system. If the allocation results in a new heir which requires @@ -71,7 +77,7 @@ extern "C" { void _Scheduler_simple_smp_Schedule( void ); /** - * @brief Scheduler Simple SMP Block Method + * @brief Remove SMP @a the_thread from the ready queue. * * This routine removes @a the_thread from the scheduling decision, * that is, removes it from the ready queue. It performs @@ -85,7 +91,8 @@ void _Scheduler_simple_smp_Block( ); /** - * @brief Scheduler Simple SMP Unblock Method + * @brief Adds SMP @a the_thread to the ready queue and updates any + * appropriate scheduling variables, for example the heir thread. * * This routine adds @a the_thread to the scheduling decision, * that is, adds it to the ready queue and updates any appropriate @@ -98,7 +105,7 @@ void _Scheduler_simple_smp_Unblock( ); /** - * @brief Scheduler Simple SMP Tick Method + * @brief Invoked as part of processing each SMP clock tick. * * This routine is invoked as part of processing each clock tick. * It is responsible for determining if the current thread allows @@ -113,4 +120,4 @@ void _Scheduler_simple_smp_Tick( void ); /**@}*/ #endif -/* end of include file */ +/* end of include file */
\ No newline at end of file |