Update sdd.md

Author: moisesmata

FprimeZephyrReference/Components/Watchdog/Watchdog.cpp

@@ -29,10 +29,7 @@ void Watchdog ::run_handler(FwIndexType portNum, U32 context) {
         this->m_transitions++;
         this->tlmWrite_WatchdogTransitions(this->m_transitions);
 
-        // Port may not be connected, so check before sending output
-        if (this->isConnected_gpioSet_OutputPort(0)) {
-            this->gpioSet_out(0, (Fw::On::ON == this->m_state) ? Fw::Logic::HIGH : Fw::Logic::LOW);
-        }
+        this->gpioSet_out(0, (Fw::On::ON == this->m_state) ? Fw::Logic::HIGH : Fw::Logic::LOW);
 
         this->log_ACTIVITY_LO_WatchdogState(this->m_state);
     }
@@ -47,10 +44,12 @@ void Watchdog ::stop_handler(FwIndexType portNum) {
 // Handler implementations for commands
 // ----------------------------------------------------------------------
 
+//test
 void Watchdog ::STOP_WATCHDOG_cmdHandler(FwOpcodeType opCode, U32 cmdSeq) {
     // Set the stop flag to stop watchdog petting
     this->m_stopRequested = true;
 
+    //rather, call stop handler here and emit event`
     // Provide command response
     this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
 }

FprimeZephyrReference/Components/Watchdog/Watchdog.fpp

@@ -6,12 +6,15 @@ module Components {
         sync command STOP_WATCHDOG(
         )
 
+        # get rid
         @ Telemetry channel to report watchdog petter state.
         telemetry WatchdogState: Fw.On
 
+        # keep but make it U32
         @ Telemetry channel counting watchdog petter transitions
         telemetry WatchdogTransitions: U64
 
+        # get rid of all events except the stop watchdog event
         @ Reports the state we set for the watchdog petter.
         event SetWatchdogState($state: Fw.On) \
             severity activity high \
@@ -22,11 +25,6 @@ module Components {
             severity activity low \
             format "Watchdog is {}"
 
-        @ Event logged when the watchdog petter blink interval is updated
-        event WatchdogIntervalSet(interval: U32) \
-            severity activity high \
-            format "Watchdog blink interval set to {}"
-
         @ Port receiving calls from the rate group
         sync input port run: Svc.Sched
 

FprimeZephyrReference/Components/Watchdog/Watchdog.hpp

@@ -50,13 +50,17 @@ class Watchdog : public WatchdogComponentBase {
         // Handler implementations for commands
         // ----------------------------------------------------------------------
 
+        // test prefix
         void STOP_WATCHDOG_cmdHandler(FwOpcodeType opCode, U32 cmdSeq) override;
 
 
 
     Fw::On m_state = Fw::On::OFF;  //! Keeps track if LED is on or off
+    //U32
     U64 m_transitions = 0;         //! The number of on/off transitions that have occurred
                                    //! from FSW boot up
+
+    // this should be an atomic (std::atomic)
     bool m_stopRequested = false;  //! Flag to stop the watchdog petting
 };
 

FprimeZephyrReference/Components/Watchdog/docs/img/diagram.svg

@@ -0,0 +1,3 @@
+[ZoneTransfer]
+ZoneId=3
+HostUrl=vscode-webview://06sutmqocciejudt1q6dk9i4j0ftrdfegqfv7aiu1ujtv9um6nfr/

FprimeZephyrReference/Components/Watchdog/docs/img/diagram.svg:Zone.Identifier

@@ -0,0 +1,58 @@
+# Components::Watchdog Component
+
+## 1. Introduction
+
+The `Components::Watchdog` component provides the mechanism to "pet" the physical watchdog circuit on the PROVES FC Board and provides a visual indicator by blinking an LED at a fixed interval. The component is driven by a rate group and oscillates the watchdog GPIO every rategroup tick. 
+
+## 2. Requirements
+
+The requirements for `Components::Watchdog` are as follows:
+
+Requirement | Description | Verification Method
+----------- | ----------- | -------------------
+WD-001 | The `Components::Watchdog` component shall activate upon startup. | Unit Test
+WD-002 | The `Components::Watchdog` component shall oscillate the watchdog GPIO pin (24) on/off on each rategroup tick. | Unit Test
+WD-003 | The `Components::Watchdog` component shall provide telemetry for watchdog transition count. | Unit Test
+WD-004 | The `Components::Watchdog` component shall respond to stop signals to halt the watchdog petting. | Unit Test
+WD-005 | The `Components::Watchdog` component shall provide a test command to stop the watchdog petting. | Unit Test
+WD-006 | The `Components::Watchdog` component shall emit an event when the watchdog petting stops. | Unit Test
+
+## 3. Design
+
+### 3.1 Context
+
+#### 3.1.1 Component Diagram
+
+The `Components::Watchdog` component has the following component diagram:
+
+![`Components::Watchdog` Diagram](img/diagram.svg)
+
+#### 3.1.2 Ports
+
+Port Data Type | Name | Direction | Kind | Usage
+-------------- | ---- | --------- | ---- | -----
+[`Svc::Sched`]| run | Input | Synchronous | Receive periodic calls from rate group
+[`Fw::Signal`]| stop | Input | Synchronous | Receive stop signal to stop watchdog petter
+[`Drv::GpioWrite`]| gpioSet | Output | n/a | Control GPIO state through driver
+
+#### 3.1.3 Commands
+
+Name | Kind | Description 
+---- | ---- | -----
+TEST_STOP_WATCHDOG | Synchronous | calls the port `stop_runhandler` to stop the watchdog petter. 
+
+#### 3.1.4 Events
+
+Name | Description 
+---- | -----
+WatchdogStop | Emits once the watchdog petting has stopped. . 
+
+#### 3.1.5 Telemetry 
+
+Name | Type | Description 
+---- | ---- | -----
+WatchdogTransitions | U32 | Number of times the GPIO has oscillated from on/off during watchdog petting
+
+## 4. Unit Testing
+
+TODO