Fix errors in documentation and comments related to the Tickless OS. From Vijay Kumar

This commit is contained in:
Gregory Nutt
2014-08-09 06:41:38 -06:00
parent 868d7b8e0b
commit da0de3284e
3 changed files with 16 additions and 14 deletions
+6 -5
View File
@@ -1034,8 +1034,8 @@ int up_timer_gettime(FAR struct timespec *ts);
* Description:
* Cancel the interval timer and return the time remaining on the timer.
* These two steps need to be as nearly atomic as possible.
* up_timer_expiration() will not be called unless the timer is restarted
* with up_timer_start().
* sched_timer_expiration() will not be called unless the timer is
* restarted with up_timer_start().
*
* If, as a race condition, the timer has already expired when this
* function is called, then that pending interrupt must be cleared so
@@ -1067,14 +1067,15 @@ int up_timer_cancel(FAR struct timespec *ts);
* Name: up_timer_start
*
* Description:
* Start the interval timer. up_timer_expiration() will be called at the
* completion of the timeout (unless up_timer_cancel is called to stop
* Start the interval timer. sched_timer_expiration() will be called at
* the completion of the timeout (unless up_timer_cancel is called to stop
* the timing.
*
* Provided by platform-specific code and called from the RTOS base code.
*
* Input Parameters:
* ts - Provides the time interval until up_timer_expiration() is called.
* ts - Provides the time interval until sched_timer_expiration() is
* called.
*
* Returned Value:
* Zero (OK) is returned on success; a negated errno value is returned on