michaelh/zephyr
1
0
Fork 0
Code Releases Activity

kernel: work: document error returns for schedule operations

Browse source 
When a non-zero delay is used the schedule functions can't fail, but
if K_NO_WAIT is passed error conditions may be forwarded from
k_submit_to_queue.

Also add a missed error return from k_submit_to_queue.

Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
This commit is contained in:
Peter Bigot 2021-05-17 06:36:04 -05:00 • committed by Anas Nashif
commit 47435904ef
1 changed files with 13 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

13
include/kernel.h
View file

@ -2950,6 +2950,7 @@ static inline bool k_work_is_pending(const struct k_work *work);
* * @p queue is draining; or
* * @p queue is plugged.
* @retval -EINVAL if @p queue is null and the work item has never been run.
* @retval -ENODEV if @p queue has not been started.
*/
int k_work_submit_to_queue(struct k_work_q *queue,
struct k_work *work);
@ -3228,6 +3229,12 @@ static inline k_ticks_t k_work_delayable_remaining_get(
*
* @retval 0 if work was already scheduled or submitted.
* @retval 1 if work has been scheduled.
* @retval -EBUSY if @p delay is @c K_NO_WAIT and
* k_work_submit_to_queue() fails with this code.
* @retval -EINVAL if @p delay is @c K_NO_WAIT and
* k_work_submit_to_queue() fails with this code.
* @retval -ENODEV if @p delay is @c K_NO_WAIT and
* k_work_submit_to_queue() fails with this code.
*/
int k_work_schedule_for_queue(struct k_work_q *queue,
struct k_work_delayable *dwork,
@ -3277,6 +3284,12 @@ extern int k_work_schedule(struct k_work_delayable *dwork,
* * delay not @c K_NO_WAIT and work has been scheduled
* @retval 2 if delay is @c K_NO_WAIT and work was running and has been queued
* to the queue that was running it
* @retval -EBUSY if @p delay is @c K_NO_WAIT and
* k_work_submit_to_queue() fails with this code.
* @retval -EINVAL if @p delay is @c K_NO_WAIT and
* k_work_submit_to_queue() fails with this code.
* @retval -ENODEV if @p delay is @c K_NO_WAIT and
* k_work_submit_to_queue() fails with this code.
*/
int k_work_reschedule_for_queue(struct k_work_q *queue,
struct k_work_delayable *dwork,