Skip to content

Commit

Permalink
software: Add condition variables software reqs
Browse files Browse the repository at this point in the history
Add new software requirements for condition variables
and update the index.sdoc file to include the new requirements file
for the software requirements.

Signed-off-by: Simon Hein <[email protected]>
  • Loading branch information
simhein committed Jul 23, 2024
1 parent fb4e9ee commit 3ef3b48
Show file tree
Hide file tree
Showing 2 changed files with 100 additions and 0 deletions.
97 changes: 97 additions & 0 deletions docs/software_requirements/condition_variables.sdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
[DOCUMENT]
TITLE: Condition Variables
REQ_PREFIX: ZEP-SRS-21-

[GRAMMAR]
IMPORT_FROM_FILE: software_requirements.sgra

[REQUIREMENT]
UID: ZEP-SRS-21-1
STATUS: Draft
TYPE: Functional
COMPONENT: Condition Variables
TITLE: Dynamic initialization of condition variables
STATEMENT: >>>
The Zephyr RTOS shall provide a mechanism to define and initialize a condition variable dynamically (at runtime).
<<<
RELATIONS:
- TYPE: Parent
VALUE: ZEP-SYRS-20

[REQUIREMENT]
UID: ZEP-SRS-21-2
STATUS: Draft
TYPE: Functional
COMPONENT: Condition Variables
TITLE: Static initialization of condition variables
STATEMENT: >>>
The Zephyr RTOS shall provide a mechanism to define and initialize a condition variable statically (at compile time).
<<<
RELATIONS:
- TYPE: Parent
VALUE: ZEP-SYRS-20

[REQUIREMENT]
UID: ZEP-SRS-21-3
STATUS: Draft
TYPE: Functional
COMPONENT: Condition Variables
TITLE: Signal one waiting thread
STATEMENT: >>>
The Zephyr RTOS shall provide a mechanism to signal one waiting thread when a condition is met.
<<<
RELATIONS:
- TYPE: Parent
VALUE: ZEP-SYRS-20

[REQUIREMENT]
UID: ZEP-SRS-21-4
STATUS: Draft
TYPE: Functional
COMPONENT: Condition Variables
TITLE: Signal multiple waiting threads
STATEMENT: >>>
The Zephyr RTOS shall provide a mechanism to signal all waiting threads when a condition is met.
<<<
RELATIONS:
- TYPE: Parent
VALUE: ZEP-SYRS-20

[REQUIREMENT]
UID: ZEP-SRS-21-5
STATUS: Draft
TYPE: Functional
COMPONENT: Condition Variables
TITLE: Wait on a condition variable
STATEMENT: >>>
The Zephyr RTOS shall provide a mechanism for a thread to wait on a condition variable.
<<<
RELATIONS:
- TYPE: Parent
VALUE: ZEP-SYRS-20

[REQUIREMENT]
UID: ZEP-SRS-21-6
STATUS: Draft
TYPE: Functional
COMPONENT: Condition Variables
TITLE: Release mutex on wait
STATEMENT: >>>
While waiting on a condition variable the thread shall release the current owned mutex.
<<<
RELATIONS:
- TYPE: Parent
VALUE: ZEP-SYRS-20

[REQUIREMENT]
UID: ZEP-SRS-21-7
STATUS: Draft
TYPE: Functional
COMPONENT: Condition Variables
TITLE: Unblock a waiting thread
STATEMENT: >>>
A waiting thread shall only be unblocked if a signal is sent to the condition variable.
<<<
RELATIONS:
- TYPE: Parent
VALUE: ZEP-SYRS-20
3 changes: 3 additions & 0 deletions docs/software_requirements/index.sdoc
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,6 @@ FILE: timers.sdoc

[DOCUMENT_FROM_FILE]
FILE: tracing.sdoc

[DOCUMENT_FROM_FILE]
FILE: condition_variables.sdoc

0 comments on commit 3ef3b48

Please sign in to comment.