Zephyr Project Requirements
Work Queues

1. Work Queue Management
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
  • ZEP-SYRS-15
    26.1. Thread support ZEP-SYRS-15

    The Zephyr RTOS shall support threads.
ZEP-SRS-38-1
1.1. Work queue initialization ZEP-SRS-38-1

The Zephyr RTOS shall provide a mechanism to initialize a work queue.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
  • ZEP-SYRS-15
    26.1. Thread support ZEP-SYRS-15

    The Zephyr RTOS shall support threads.
ZEP-SRS-38-29
1.2. Work queue start ZEP-SRS-38-29

The Zephyr RTOS shall provide a mechanism to start an initialized work queue, dedicating a thread to process its work items.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-41
1.3. Processing a work queue in the calling thread ZEP-SRS-38-41

The Zephyr RTOS shall provide a mechanism to process the work items of an initialized work queue that has not been started, in the context of the calling thread, returning only when the work queue is stopped.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-2
1.4. Work queue thread priority ZEP-SRS-38-2

When a work queue is started, the Zephyr RTOS shall allow the priority of its dedicated thread to be configured.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-30
1.5. Work queue thread naming ZEP-SRS-38-30

When a work queue is started, the Zephyr RTOS shall allow a name to be assigned to the work queue's dedicated thread.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-31
1.6. Work queue essential thread ZEP-SRS-38-31

When a work queue is started, the Zephyr RTOS shall allow the work queue's dedicated thread to be marked as essential to system operation.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-3
1.7. Work item processing order ZEP-SRS-38-3

The Zephyr RTOS shall process the work items of a work queue in the order in which they were submitted.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-4
1.8. Work queue thread yielding ZEP-SRS-38-4

While yielding between work items is enabled for a work queue, the Zephyr RTOS shall cause the work queue thread to yield to other ready threads between processing successive work items.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-44
1.9. Work queue thread yielding disabled ZEP-SRS-38-44

While yielding between work items is disabled for a work queue, the Zephyr RTOS shall not yield the work queue thread until no work items remain queued.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-5
1.10. Work queue draining ZEP-SRS-38-5

The Zephyr RTOS shall provide a mechanism to wait until all work items submitted to a work queue have been processed.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-32
1.11. Work item submission while draining ZEP-SRS-38-32

While a work queue is draining, the Zephyr RTOS shall reject submission of work items to that work queue unless the submission originates from the work queue's own thread.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-6
1.12. Work queue submission blocking on drain ZEP-SRS-38-6

When a drain operation is initiated with submission blocking enabled, the Zephyr RTOS shall continue to prevent submission of work items to the work queue after the drain completes, until submissions are explicitly re-enabled.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-7
1.13. Work queue submission unblocking ZEP-SRS-38-7

The Zephyr RTOS shall provide a mechanism to allow work items to be submitted again to a work queue whose submissions were previously blocked.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-8
1.14. Work queue stop ZEP-SRS-38-8

The Zephyr RTOS shall provide a mechanism to stop the dedicated thread of a work queue that has been drained and is blocking new submissions.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-45
1.15. Work queue stop timeout ZEP-SRS-38-45

When stopping a work queue, the Zephyr RTOS shall wait for the work queue thread to terminate for at most a caller-specified timeout.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-53
1.16. Work queue stop timeout expiry ZEP-SRS-38-53

If the work queue thread has not terminated when the stop timeout expires, then the Zephyr RTOS shall return an error indicating timeout and leave the work queue running.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-46
1.17. Work queue stop with an essential thread ZEP-SRS-38-46

If a stop is requested for a work queue whose dedicated thread is marked as essential to system operation, then the Zephyr RTOS shall reject the request and return an error indicating that the operation is not supported.

2. Work Item Submission and Processing
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-9
2.1. Work item initialization at run time ZEP-SRS-38-9

The Zephyr RTOS shall provide a mechanism to initialize a work item at run time, associating a handler function to be executed when the work item is processed.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-34
2.2. Work item definition at compile time ZEP-SRS-38-34

The Zephyr RTOS shall provide a mechanism to define and initialize a work item at compile time, associating a handler function to be executed when the work item is processed.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-33
2.3. System work queue ZEP-SRS-38-33

The Zephyr RTOS shall provide a system work queue that is started during kernel initialization and is available to application and kernel code.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-10
2.4. Work item submission to the system work queue ZEP-SRS-38-10

The Zephyr RTOS shall provide a mechanism to submit a work item to the system work queue.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-11
2.5. Work item submission to a specified work queue ZEP-SRS-38-11

The Zephyr RTOS shall provide a mechanism to submit a work item to a specified work queue.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-12
2.6. Work item submission from threads and interrupt service routines ZEP-SRS-38-12

The Zephyr RTOS shall allow a work item to be submitted from either a thread or an interrupt service routine.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-13
2.7. Work item handler invocation ZEP-SRS-38-13

When the work queue thread removes a work item from the queue, the Zephyr RTOS shall invoke that work item's handler function in the context of the work queue thread.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-14
2.8. Resubmission of an already queued work item ZEP-SRS-38-14

If a work item is submitted while it is already queued and has not yet started running, then the Zephyr RTOS shall retain the work item at its current position in the queue.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-47
2.9. Resubmission of a running work item ZEP-SRS-38-47

If a work item is submitted while its handler function is running, then the Zephyr RTOS shall queue the work item to be processed again after the running handler function completes.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-48
2.10. Resubmission of a running work item to a different work queue ZEP-SRS-38-48

If a work item is submitted to a work queue while its handler function is running on a different work queue, then the Zephyr RTOS shall queue the work item on the work queue that is running it.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-15
2.11. Waiting for a work item to complete ZEP-SRS-38-15

The Zephyr RTOS shall provide a mechanism to wait until a submitted work item's handler function has finished executing.

3. Work Item Status and Cancellation
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-16
3.1. Work item pending status ZEP-SRS-38-16

The Zephyr RTOS shall provide a mechanism to determine whether a work item is currently pending, where a work item is pending while it is waiting for its delay to elapse, queued to a work queue, running, being cancelled, or being flushed.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-17
3.2. Cancellation of a queued work item ZEP-SRS-38-17

The Zephyr RTOS shall provide a mechanism to cancel a work item that has been submitted but has not yet started running, so that its handler function is not invoked.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-18
3.3. Cancellation of a running work item handler ZEP-SRS-38-18

If a work item's handler function has already started running when the work item is cancelled, then the Zephyr RTOS shall not interrupt the execution of that handler function.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-19
3.4. Cancellation with wait for completion ZEP-SRS-38-19

The Zephyr RTOS shall provide a mechanism to cancel a work item and wait until the work item is no longer pending.

4. Delayable Work
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-20
4.1. Delayable work item initialization at run time ZEP-SRS-38-20

The Zephyr RTOS shall provide a mechanism to initialize a delayable work item at run time, associating a handler function to be executed when the work item is processed.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-35
4.2. Delayable work item definition at compile time ZEP-SRS-38-35

The Zephyr RTOS shall provide a mechanism to define and initialize a delayable work item at compile time, associating a handler function to be executed when the work item is processed.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-21
4.3. Scheduling a delayable work item on a specified work queue ZEP-SRS-38-21

The Zephyr RTOS shall provide a mechanism to schedule a delayable work item to be submitted to a specified work queue after a specified delay.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-36
4.4. Scheduling a delayable work item on the system work queue ZEP-SRS-38-36

The Zephyr RTOS shall provide a mechanism to schedule a delayable work item to be submitted to the system work queue after a specified delay.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-22
4.5. Submission of a delayable work item on delay expiry ZEP-SRS-38-22

When the scheduled delay of a delayable work item elapses, the Zephyr RTOS shall submit the work item to its work queue.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-23
4.6. Rescheduling a delayable work item ZEP-SRS-38-23

The Zephyr RTOS shall provide a mechanism to reschedule a delayable work item that is scheduled but not yet submitted, replacing the previously scheduled delay with the new delay.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-49
4.7. Rescheduling a queued or running delayable work item ZEP-SRS-38-49

If a delayable work item is rescheduled with a non-zero delay while it is queued or running, then the Zephyr RTOS shall leave that execution unaffected and schedule an additional submission of the work item after the new delay.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-24
4.8. Cancellation of a delayable work item ZEP-SRS-38-24

The Zephyr RTOS shall provide a mechanism to cancel a delayable work item that has been scheduled but not yet submitted to its work queue, so that it is not submitted.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-42
4.9. Waiting for a delayable work item to complete ZEP-SRS-38-42

The Zephyr RTOS shall provide a mechanism to wait until a delayable work item's handler function has finished executing.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-50
4.10. Waiting for a scheduled delayable work item to complete ZEP-SRS-38-50

When a wait for completion is requested for a delayable work item that is scheduled but not yet submitted, the Zephyr RTOS shall submit the work item to its work queue immediately before waiting.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-43
4.11. Cancellation of a delayable work item with wait for completion ZEP-SRS-38-43

The Zephyr RTOS shall provide a mechanism to cancel a delayable work item and wait until the work item is no longer pending.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-25
4.12. Querying the remaining delay of a delayable work item ZEP-SRS-38-25

The Zephyr RTOS shall provide a mechanism to query the time remaining until a scheduled delayable work item is submitted to its work queue.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-26
4.13. Work item timeout monitoring ZEP-SRS-38-26

Where workqueue work timeout monitoring is enabled, the Zephyr RTOS shall monitor the execution duration of each work item and, if a work item handler runs longer than the configured timeout, abort the work queue thread.

5. Triggered Work
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-51
5.1. Triggered work item initialization ZEP-SRS-38-51

The Zephyr RTOS shall provide a mechanism to initialize a triggered work item at run time, associating a handler function to be executed when the work item is processed.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-27
5.2. Submitting a triggered work item ZEP-SRS-38-27

The Zephyr RTOS shall provide a mechanism to submit a work item that is processed when any of a specified set of poll events becomes ready or when a specified timeout elapses, and to report the triggering outcome to the work item handler.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-52
5.3. Resubmission of a waiting triggered work item ZEP-SRS-38-52

If a triggered work item is submitted while it is still waiting for its poll events, then the Zephyr RTOS shall cancel the existing submission and resubmit the work item with the new set of poll events.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-28
5.4. Cancelling a triggered work item ZEP-SRS-38-28

The Zephyr RTOS shall provide a mechanism to cancel a submitted triggered work item before any of its poll events becomes ready.

6. User Mode Work Queues
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-37
6.1. User work item initialization at run time ZEP-SRS-38-37

The Zephyr RTOS shall provide a mechanism to initialize, at run time, a work item usable by user mode threads, associating a handler function to be executed when the work item is processed.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-38
6.2. User work item definition at compile time ZEP-SRS-38-38

The Zephyr RTOS shall provide a mechanism to define and initialize, at compile time, a work item usable by user mode threads, associating a handler function to be executed when the work item is processed.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-39
6.3. User work queue start ZEP-SRS-38-39

The Zephyr RTOS shall provide a mechanism to start a work queue whose dedicated thread runs in user mode.
  • ZEP-SYRS-37
    29.1. Work Queues ZEP-SYRS-37

    The Zephyr RTOS shall provide a framework to offload the processing of work items to a dedicated thread.
ZEP-SRS-38-40
6.4. User work item submission ZEP-SRS-38-40

The Zephyr RTOS shall provide a mechanism for user mode threads to submit a work item to a user mode work queue.