Skip to content

Commit 8dc68f3

Browse files
committed
DOC: sched: document the missing TASK_F_UEVT* flags
These are user-defined one-shot events that are application-specific and reset upon wakeup and were not documented. No backport is needed since these were added to 3.1.
1 parent e5ca72c commit 8dc68f3

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

doc/internals/api/scheduler.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,11 @@ state field before the call to ->process()
208208

209209
- TASK_WOKEN_OTHER any other application-defined wake-up reason.
210210

211+
- TASK_F_UEVT1 one-shot user-defined event type 1. This is application
212+
specific, and reset to 0 when the handler is called.
213+
214+
- TASK_F_UEVT2 one-shot user-defined event type 2. This is application
215+
specific, and reset to 0 when the handler is called.
211216

212217
In addition, a few persistent flags may be observed or manipulated by the
213218
application, both for tasks and tasklets:

0 commit comments

Comments
 (0)