summaryrefslogtreecommitdiff
path: root/nuttx/sched/work_queue.c
diff options
context:
space:
mode:
Diffstat (limited to 'nuttx/sched/work_queue.c')
-rwxr-xr-xnuttx/sched/work_queue.c7
1 files changed, 7 insertions, 0 deletions
diff --git a/nuttx/sched/work_queue.c b/nuttx/sched/work_queue.c
index 46afdc1d8..144c32178 100755
--- a/nuttx/sched/work_queue.c
+++ b/nuttx/sched/work_queue.c
@@ -83,6 +83,13 @@
* Queue work to be performed at a later time. All queued work will be
* performed on the worker thread of of execution (not the caller's).
*
+ * The work structure is allocated by caller, but completely managed by
+ * the work queue logic. The caller should never modify the contents of
+ * the work queue structure; the caller should not call work_queue()
+ * again until either (1) the previous work has been performed and removed
+ * from the queue, or (2) work_cancel() has been called to cancel the work
+ * and remove it from the work queue.
+ *
* Input parameters:
* work - The work structure to queue
* worker - The worker callback to be invoked. The callback will invoked