michaelh/zephyr
1
0
Fork 0
Code Releases Activity

kernel/sched.c: add k_usleep() API function

Browse source 
Add k_usleep() API, analogous to k_sleep(), excepting that the argument
is in microseconds rather than milliseconds.

Signed-off-by: Charles E. Youse <charles.youse@intel.com>
This commit is contained in:
Charles E. Youse 2019-05-09 16:46:46 -07:00 • committed by Anas Nashif
commit a567831bed
3 changed files with 69 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

24
include/kernel.h
View file

@ -790,16 +790,30 @@ void k_thread_system_pool_assign(struct k_thread *thread);
/**
* @brief Put the current thread to sleep.
*
* This routine puts the current thread to sleep for @a duration
* milliseconds.
* This routine puts the current thread to sleep for @a duration milliseconds.
*
* @param duration Number of milliseconds to sleep.
* @param ms Number of milliseconds to sleep.
*
* @return Zero if the requested time has elapsed or the number of milliseconds
* left to sleep, if thread was woken up by \ref k_wakeup call.
*
*/
__syscall s32_t k_sleep(s32_t duration);
__syscall s32_t k_sleep(s32_t ms);
/**
* @brief Put the current thread to sleep with microsecond resolution.
*
* This function is unlikely to work as expected without kernel tuning.
* In particular, because the lower bound on the duration of a sleep is
* the duration of a tick, CONFIG_SYS_CLOCK_TICKS_PER_SEC must be adjusted
* to achieve the resolution desired. The implications of doing this must
* be understood before attempting to use k_usleep(). Use with caution.
*
* @param us Number of microseconds to sleep.
*
* @return Zero if the requested time has elapsed or the number of microseconds
* left to sleep, if thread was woken up by \ref k_wakeup call.
*/
__syscall s32_t k_usleep(s32_t us);
/**
* @brief Cause the current thread to busy wait.