michaelh/zephyr
1
0
Fork 0
Code Releases Activity

kernel: document k_sleep with K_FOREVER

Browse source 
When calling k_sleep with K_FOREVER as the timeout value, we consider
this as a suspend call.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2020-10-17 07:52:17 -04:00
commit d2c71796af
2 changed files with 3 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
include/kernel.h
View file

@ -644,6 +644,8 @@ __syscall int k_thread_join(struct k_thread *thread, k_timeout_t timeout);
* This routine puts the current thread to sleep for @a duration,
* specified as a k_timeout_t object.
*
* @note if @a timeout is set to K_FOREVER then the thread is suspended.
*
* @param timeout Desired duration of sleep.
*
* @return Zero if the requested time has elapsed or the number of milliseconds