reqmgmt: Rework Timer requirements

Merge requirements when possible
Rename status to number of times expired

Fixes #65
Signed-off-by: Stephane Parenti <[email protected]>

Author: parphane

docs/software_requirements/timers.sdoc

@@ -15,9 +15,9 @@ UID: ZEP-SRS-4-1
 STATUS: Draft
 TYPE: Functional
 COMPONENT: Timers
-TITLE: Timer definition at run time
+TITLE: Timer definition at compile time
 STATEMENT: >>>
-The Zephyr RTOS shall provide a mechanism to define and initialize timers at run time.
+The Zephyr RTOS shall provide a mechanism to define and statically (i.e. compile time) initialize timers.
 <<<
 RELATIONS:
 - TYPE: Parent
@@ -28,9 +28,9 @@ UID: ZEP-SRS-4-2
 STATUS: Draft
 TYPE: Functional
 COMPONENT: Timers
-TITLE: Timer definition at compile time
+TITLE: Timer expiry function
 STATEMENT: >>>
-The Zephyr RTOS shall provide a mechanism to define and static initialize timers (compile time).
+When initializing a timer, the Zephyr RTOS shall support setting a function that gets called when the timer expires.
 <<<
 RELATIONS:
 - TYPE: Parent
@@ -39,11 +39,11 @@ RELATIONS:
 [REQUIREMENT]
 UID: ZEP-SRS-4-3
 STATUS: Draft
-TYPE: Non-Functional
+TYPE: Functional
 COMPONENT: Timers
-TITLE: Timer status
+TITLE: Timer stop function
 STATEMENT: >>>
-A Zephyr RTOS timer shall have a status which indicates the expiration of the timer.
+When initializing a timer, the Zephyr RTOS shall support setting a function that gets called when a running timer is stopped.
 <<<
 RELATIONS:
 - TYPE: Parent
@@ -54,9 +54,9 @@ UID: ZEP-SRS-4-4
 STATUS: Draft
 TYPE: Functional
 COMPONENT: Timers
-TITLE: Timer period
+TITLE: Timer definition at run time
 STATEMENT: >>>
-A Zephyr RTOS timer shall support repeated expiration of the timer given by a timer-specific time period.
+The Zephyr RTOS shall provide a mechanism to define and initialize timers at run time.
 <<<
 RELATIONS:
 - TYPE: Parent
@@ -67,9 +67,9 @@ UID: ZEP-SRS-4-5
 STATUS: Draft
 TYPE: Functional
 COMPONENT: Timers
-TITLE: Timer duration
+TITLE: Timer start
 STATEMENT: >>>
-A Zephyr RTOS timer shall have a duration which indicates when the timer expires for the first time.
+The Zephyr RTOS shall provide a mechanism to start a timer for a specific duration and periodicity.
 <<<
 RELATIONS:
 - TYPE: Parent
@@ -80,9 +80,9 @@ UID: ZEP-SRS-4-6
 STATUS: Draft
 TYPE: Functional
 COMPONENT: Timers
-TITLE: Timer expiry function
+TITLE: Timer stop
 STATEMENT: >>>
-A Zephyr RTOS timer shall support a user-settable expiry function that gets called whenever the timer expires.
+The Zephyr RTOS shall provide a mechanism to stop a running timer.
 <<<
 RELATIONS:
 - TYPE: Parent
@@ -91,11 +91,11 @@ RELATIONS:
 [REQUIREMENT]
 UID: ZEP-SRS-4-7
 STATUS: Draft
-TYPE: Functional
+TYPE: Non-Functional
 COMPONENT: Timers
-TITLE: Timer stop function
+TITLE: Timer status
 STATEMENT: >>>
-A Zephyr RTOS timer shall support a user-settable stop function that gets called when the timer is stopped while running.
+The Zephyr RTOS shall provide a mechanism to read the number of times a timer has expired and then reset this number to 0.
 <<<
 RELATIONS:
 - TYPE: Parent
@@ -104,11 +104,11 @@ RELATIONS:
 [REQUIREMENT]
 UID: ZEP-SRS-4-8
 STATUS: Draft
-TYPE: Functional
+TYPE: Non-Functional
 COMPONENT: Timers
-TITLE: Initialialization with expiry function
+TITLE: Timer status reinitialization
 STATEMENT: >>>
-When initializing a Zephyr RTOS timer, the expiry function a timer can have shall be settable.
+When a timer is initialized, started or synchronized to a thread, the Zephyr RTOS shall reset the timer number of times it has expired to 0.
 <<<
 RELATIONS:
 - TYPE: Parent
@@ -119,9 +119,11 @@ UID: ZEP-SRS-4-9
 STATUS: Draft
 TYPE: Functional
 COMPONENT: Timers
-TITLE: Initialialization with stop function
+TITLE: Timer thread synchronization
 STATEMENT: >>>
-When initializing a Zephyr RTOS timer, the stop function a timer can have shall be settable.
+The Zephyr RTOS shall provide a mechanism to synchronize a thread to a timer and then block the thread execution until any of the following conditions is satisfied:
+- The timer is stopped
+- The timer number of times it has expired is superior to 0
 <<<
 RELATIONS:
 - TYPE: Parent
@@ -132,9 +134,9 @@ UID: ZEP-SRS-4-10
 STATUS: Draft
 TYPE: Functional
 COMPONENT: Timers
-TITLE: Timer start
+TITLE: Timer next expiration time in system ticks
 STATEMENT: >>>
-The Zephyr RTOS shall provide a mechanism to start a defined and initialized timer.
+The Zephyr RTOS shall provide a mechanism to get a timer's next expiration time in system ticks.
 <<<
 RELATIONS:
 - TYPE: Parent
@@ -145,9 +147,9 @@ UID: ZEP-SRS-4-11
 STATUS: Draft
 TYPE: Functional
 COMPONENT: Timers
-TITLE: Start timer status reset
+TITLE: Timer remaining time until expiration in system ticks
 STATEMENT: >>>
-Whenever a not running timer is started the timer's status shall be reset to zero.
+The Zephyr RTOS shall provide a mechanism to get a timer's remaining time until its next expiry in system ticks.
 <<<
 RELATIONS:
 - TYPE: Parent
@@ -158,124 +160,7 @@ UID: ZEP-SRS-4-12
 STATUS: Draft
 TYPE: Functional
 COMPONENT: Timers
-TITLE: Start timer counting values
-STATEMENT: >>>
-Whenever a Zephyr RTOS timer is started, the timer shall start running with the duration and period values provided during timer initialization.
-<<<
-RELATIONS:
-- TYPE: Parent
-  VALUE: ZEP-SYRS-18
-
-[REQUIREMENT]
-UID: ZEP-SRS-4-13
-STATUS: Draft
-TYPE: Functional
-COMPONENT: Timers
-TITLE: Timer stop
-STATEMENT: >>>
-A Zephyr RTOS timer that is running shall be stoppable
-<<<
-RELATIONS:
-- TYPE: Parent
-  VALUE: ZEP-SYRS-18
-
-[REQUIREMENT]
-UID: ZEP-SRS-4-14
-STATUS: Draft
-TYPE: Functional
-COMPONENT: Timers
-TITLE: Timer status read
-STATEMENT: >>>
-The Zephyr RTOS shall provide a mechanism to read the number of times a timer that is running has already expired.
-<<<
-RELATIONS:
-- TYPE: Parent
-  VALUE: ZEP-SYRS-18
-
-[REQUIREMENT]
-UID: ZEP-SRS-4-15
-STATUS: Draft
-TYPE: Functional
-COMPONENT: Timers
-TITLE: Timer status read reset
-STATEMENT: >>>
-When the timer is read via the timer status read mechanism, the status shall be reset.
-<<<
-RELATIONS:
-- TYPE: Parent
-  VALUE: ZEP-SYRS-18
-
-[REQUIREMENT]
-UID: ZEP-SRS-4-16
-STATUS: Draft
-TYPE: Functional
-COMPONENT: Timers
-TITLE: Timer thread synchronization
-STATEMENT: >>>
-The Zephyr RTOS shall provide a mechanism to synchronize a thread with a defined and initialized timer.
-<<<
-RELATIONS:
-- TYPE: Parent
-  VALUE: ZEP-SYRS-18
-
-[REQUIREMENT]
-UID: ZEP-SRS-4-17
-STATUS: Draft
-TYPE: Functional
-COMPONENT: Timers
-TITLE: Synchronized thread blocks until timer has expired
-STATEMENT: >>>
-When the thread synchronization mechanism is used, the thread shall be blocked until the timer expires.
-<<<
-RELATIONS:
-- TYPE: Parent
-  VALUE: ZEP-SYRS-18
-
-[REQUIREMENT]
-UID: ZEP-SRS-4-18
-STATUS: Draft
-TYPE: Functional
-COMPONENT: Timers
-TITLE: Synchronized thread is unblocked when timer is stopped.
-STATEMENT: >>>
-When the thread synchronization mechanism is used, the synchronized thread shall be unblocked when the timer is stopped.
-<<<
-RELATIONS:
-- TYPE: Parent
-  VALUE: ZEP-SYRS-18
-
-[REQUIREMENT]
-UID: ZEP-SRS-4-19
-STATUS: Draft
-TYPE: Functional
-COMPONENT: Timers
-TITLE: Timer thread synchronization status reset
-STATEMENT: >>>
-When the thread synchronization mechanism is used, the status of the timer shall be reset.
-<<<
-RELATIONS:
-- TYPE: Parent
-  VALUE: ZEP-SYRS-18
-
-[REQUIREMENT]
-UID: ZEP-SRS-4-20
-STATUS: Draft
-TYPE: Functional
-COMPONENT: Timers
-TITLE: Provide timer remaining expiration time in units of system ticks
-STATEMENT: >>>
-The Zephyr RTOS shall provide a mechanism to get the timer's remaining time until its next expiry in system ticks.
-<<<
-RELATIONS:
-- TYPE: Parent
-  VALUE: ZEP-SYRS-18
-
-[REQUIREMENT]
-UID: ZEP-SRS-4-21
-STATUS: Draft
-TYPE: Functional
-COMPONENT: Timers
-TITLE: Provide timer remaining expiration time in milliseconds
+TITLE: Timer remaining time until expiration in milliseconds
 STATEMENT: >>>
 The Zephyr RTOS shall provide a mechanism to get the timer's remaining time until its next expiry in milliseconds.
 <<<
@@ -284,33 +169,33 @@ RELATIONS:
   VALUE: ZEP-SYRS-18
 
 [REQUIREMENT]
-UID: ZEP-SRS-4-22
+UID: ZEP-SRS-4-13
 STATUS: Draft
 TYPE: Functional
 COMPONENT: Timers
 TITLE: Timer set user data
 STATEMENT: >>>
-The Zephyr RTOS shall provide a mechanism to set user data to a timer.
+The Zephyr RTOS shall support adding user defined data to a timer.
 <<<
 RELATIONS:
 - TYPE: Parent
   VALUE: ZEP-SYRS-18
 
 [REQUIREMENT]
-UID: ZEP-SRS-4-23
+UID: ZEP-SRS-4-14
 STATUS: Draft
 TYPE: Functional
 COMPONENT: Timers
 TITLE: Timer get user data
 STATEMENT: >>>
-The Zephyr RTOS shall provide a mechanism to get user data from a timer.
+The Zephyr RTOS shall support retrieving user defined data from a timer.
 <<<
 RELATIONS:
 - TYPE: Parent
   VALUE: ZEP-SYRS-18
 
 [REQUIREMENT]
-UID: ZEP-SRS-4-24
+UID: ZEP-SRS-4-15
 STATUS: Draft
 TYPE: Functional
 COMPONENT: Timers
@@ -321,16 +206,3 @@ When the timer expiry function is defined, it shall be called in the interrupt c
 RELATIONS:
 - TYPE: Parent
   VALUE: ZEP-SYRS-18
-
-[REQUIREMENT]
-UID: ZEP-SRS-4-25
-STATUS: Draft
-TYPE: Functional
-COMPONENT: Timers
-TITLE: Provide timer next expiration time in units of system ticks
-STATEMENT: >>>
-The Zephyr RTOS shall provide a mechanism to get the timer's next time of expiration in system ticks.
-<<<
-RELATIONS:
-- TYPE: Parent
-  VALUE: ZEP-SYRS-18