summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndreas Dachsberger <andreas.dachsberger@embedded-brains.de>2019-04-15 08:21:20 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2019-05-13 07:42:04 +0200
commitceff06f8fb8584bbbd8aa36e52c4133b5d27b495 (patch)
treed174cbdc30ab5fa9dac47c88fd1961d5986caf32
parentdoxygen: score: adjust doc in schedulersimplesmp.h to doxygen guidelines (diff)
downloadrtems-ceff06f8fb8584bbbd8aa36e52c4133b5d27b495.tar.bz2
doxygen: score: adjust doc in schedulersmp.h to doxygen guidelines
Update #3706.
-rw-r--r--cpukit/include/rtems/score/schedulersmp.h13
1 files changed, 11 insertions, 2 deletions
diff --git a/cpukit/include/rtems/score/schedulersmp.h b/cpukit/include/rtems/score/schedulersmp.h
index afc504bb83..268585f0be 100644
--- a/cpukit/include/rtems/score/schedulersmp.h
+++ b/cpukit/include/rtems/score/schedulersmp.h
@@ -1,9 +1,9 @@
/**
* @file
*
- * @brief SMP Scheduler API
- *
* @ingroup RTEMSScoreSchedulerSMP
+ *
+ * @brief SMP Scheduler API
*/
/*
@@ -35,6 +35,8 @@ extern "C" {
*
* @ingroup RTEMSScoreScheduler
*
+ * @brief SMP Scheduler
+ *
* @{
*/
@@ -112,6 +114,13 @@ typedef struct {
Priority_Control priority;
} Scheduler_SMP_Node;
+/**
+ * @brief Starts an idle thread on the specified cpu.
+ *
+ * @param scheduler The scheduler instance.
+ * @param[in, out] idle The idle thread to schedule.
+ * @param[out] cpu The cpu to run the idle thread on.
+ */
void _Scheduler_SMP_Start_idle(
const Scheduler_Control *scheduler,
Thread_Control *idle,