diff options
Diffstat (limited to 'src/chvt.c')
-rw-r--r-- | src/chvt.c | 17 |
1 files changed, 10 insertions, 7 deletions
diff --git a/src/chvt.c b/src/chvt.c index 0071b1733..7f63437ad 100644 --- a/src/chvt.c +++ b/src/chvt.c @@ -27,7 +27,8 @@ VTList vtlist;
/**
- * Virtual Timers initialization.
+ * @brief Virtual Timers initialization.
+ *
* @note Internal use only.
*/
void chVTInit(void) {
@@ -38,15 +39,16 @@ void chVTInit(void) { }
/**
- * Enables a virtual timer.
+ * @brief Enables a virtual timer.
+ *
* @param vtp the @p VirtualTimer structure pointer
* @param time the number of time ticks, the value zero is not allowed
* @param vtfunc the timer callback function. After invoking the callback
* the timer is disabled and the structure can be disposed or
* reused.
* @param par a parameter that will be passed to the callback function
- * @note Must be called with the interrupts disabled.
- * @note The associated function is invoked by an interrupt handler.
+ * @note The associated function is invoked by an interrupt handler within
+ * the I-Locked state, see @ref system_states.
*/
void chVTSetI(VirtualTimer *vtp, systime_t time, vtfunc_t vtfunc, void *par) {
VirtualTimer *p;
@@ -69,9 +71,9 @@ void chVTSetI(VirtualTimer *vtp, systime_t time, vtfunc_t vtfunc, void *par) { }
/**
- * Disables a Virtual Timer.
+ * @brief Disables a Virtual Timer.
+ *
* @param vtp the @p VirtualTimer structure pointer
- * @note It must be called with the interrupts disabled.
* @note The timer MUST be active when this function is invoked.
*/
void chVTResetI(VirtualTimer *vtp) {
@@ -84,7 +86,8 @@ void chVTResetI(VirtualTimer *vtp) { }
/**
- * Checks if the current system time is within the specified time window.
+ * @brief Checks if the current system time is within the specified time window.
+ *
* @param start the start of the time window (inclusive)
* @param end the end of the time window (non inclusive)
*/
|