aboutsummaryrefslogtreecommitdiffstats
path: root/src/chsys.c
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-01-20 16:26:48 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-01-20 16:26:48 +0000
commit22e22db0161126d1c58a07e2323662efc18d6c86 (patch)
treee59efd65935cdb9d1358a598925a0a3fa5ace5fd /src/chsys.c
parentb1d77bf4bc7fb6e89b5280d99f401caa50c8a0d8 (diff)
downloadChibiOS-22e22db0161126d1c58a07e2323662efc18d6c86.tar.gz
ChibiOS-22e22db0161126d1c58a07e2323662efc18d6c86.tar.bz2
ChibiOS-22e22db0161126d1c58a07e2323662efc18d6c86.zip
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@649 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'src/chsys.c')
-rw-r--r--src/chsys.c20
1 files changed, 12 insertions, 8 deletions
diff --git a/src/chsys.c b/src/chsys.c
index 71eb59d98..1629796dd 100644
--- a/src/chsys.c
+++ b/src/chsys.c
@@ -27,10 +27,12 @@
static WORKING_AREA(idle_thread_wa, IDLE_THREAD_STACK_SIZE);
/**
- * This function implements the idle thread infinite loop. The function should
- * put the processor in the lowest power mode capable to serve interrupts.
+ * @brief This function implements the idle thread infinite loop.
+ * @details The function puts the processor in the lowest power mode capable
+ * to serve interrupts.<br>
* The priority is internally set to the minimum system value so that this
* thread is executed only if there are no other ready threads in the system.
+ *
* @param p the thread parameter, unused in this scenario
* @note Implementation should declare this function as a weak symbol in order
* to allow applications to re-implement it.
@@ -43,8 +45,10 @@ static void idle_thread(void *p) {
}
/**
- * ChibiOS/RT initialization. After executing this function the current
- * instructions stream becomes the main thread.
+ * @brief ChibiOS/RT initialization.
+ * @details After executing this function the current instructions stream
+ * becomes the main thread.
+ *
* @note Interrupts should be still disabled when @p chSysInit() is invoked
* and are internally enabled.
* @note The main thread is created with priority @p NORMALPRIO.
@@ -77,10 +81,10 @@ void chSysInit(void) {
}
/**
- * Handles time ticks for round robin preemption and timer increments.
- * Decrements the remaining time quantum of the running thread and preempts
- * it when the quantum is used up. Increments system time and manages the
- * timers.
+ * @brief Handles time ticks for round robin preemption and timer increments.
+ * @details Decrements the remaining time quantum of the running thread
+ * and preempts it when the quantum is used up. Increments system time and
+ * manages the timers.
* @note The frequency of the timer determines the system tick granularity and,
* together with the @p CH_TIME_QUANTUM macro, the round robin interval.
*/