michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: clarify behavior of k_poll_signal_raise on error

Browse source 
k_poll_signal_raise() returns an error code to indicate that the raise
was too late to notify an expiring poll.  Make clear that this does not
mean that the signal was lost: a subsequent poll will find it and expire
immediately.

Signed-off-by: Peter A. Bigot <pab@pabigot.com>
This commit is contained in:
Peter A. Bigot 2019-04-30 07:06:39 -05:00 • committed by Anas Nashif
commit 773bd98c73
1 changed files with 4 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

4
include/kernel.h
View file

@ -4429,6 +4429,10 @@ __syscall void k_poll_signal_check(struct k_poll_signal *signal,
* passed again to k_poll() or k_poll() will consider it being signaled, and * passed again to k_poll() or k_poll() will consider it being signaled, and
* will return immediately. * will return immediately.
* *
* @note The result is stored and the 'signaled' field is set even if
* this function returns an error indicating that an expiring poll was
* not notified. The next k_poll() will detect the missed raise.
*
* @param signal A poll signal. * @param signal A poll signal.
* @param result The value to store in the result field of the signal. * @param result The value to store in the result field of the signal.
* *