Work/dp catalog

Ref/SignalGen/Commands.fppi

@@ -15,9 +15,16 @@ async command SignalGen_Toggle \
 async command SignalGen_Skip \
   opcode 2
 
+enum DpReqType {
+    IMMEDIATE
+    ASYNC
+}
+
+
 @ Signal Generator Settings
 async command SignalGen_Dp(
-                                  records: U32
-                                ) \
+                   reqType: DpReqType
+                   records: U32
+                  ) \
   opcode 3
 

Ref/SignalGen/Events.fppi

@@ -36,3 +36,13 @@ event SignalGen_DpsNotConnected \
   severity warning high \
   id 4 \
   format "DP Ports not connected!"
+
+event SignalGen_DpMemoryFail \
+  severity warning high \
+  id 5 \
+  format "Failed to acquire a DP buffer"
+
+event SignalGen_InSufficientDpRecords \
+  severity warning high \
+  id 6 \
+  format "Need to request at least one record"

Ref/SignalGen/SignalGen.cpp

@@ -207,13 +207,20 @@ namespace Ref {
         this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
     }
 
-    void SignalGen ::
-        SignalGen_Dp_cmdHandler(
-            FwOpcodeType opCode,
-            U32 cmdSeq,
-            U32 records
-        )
+    void SignalGen::SignalGen_Dp_cmdHandler(
+        FwOpcodeType opCode,
+        U32 cmdSeq,
+        Ref::SignalGen_DpReqType reqType,
+        U32 records
+    )
     {
+        // at least one record
+        if (0 == records) {
+            this->log_WARNING_HI_SignalGen_InSufficientDpRecords();
+            this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::VALIDATION_ERROR);
+            return;
+        }
+
         // make sure DPs are available
         if (
             not this->isConnected_productGetOut_OutputPort(0)
@@ -223,18 +230,34 @@ namespace Ref {
             return;
         }
 
-        // get DP buffer
-        this->dpGet_DataContainer(records*SIZE_OF_DataRecord_RECORD,this->m_dpContainer);
-        this->m_dpInProgress = true;
+        // get DP buffer. Use sync or async request depending on 
+        // requested type
+        FwSizeType dpSize = records*(SignalInfo::SERIALIZED_SIZE + sizeof(FwDpIdType));
         this->m_numDps = records;
         this->m_currDp = 0;
-        this->log_ACTIVITY_LO_SignalGen_DpStarted(records);
-        this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
+        if (Ref::SignalGen_DpReqType::IMMEDIATE ==  reqType) {
+            Fw::Success stat = this->dpGet_DataContainer(dpSize,this->m_dpContainer);
+            // make sure we got the memory we wanted
+            if (Fw::Success::FAILURE == stat) {
+                this->log_WARNING_HI_SignalGen_DpMemoryFail();
+                this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::EXECUTION_ERROR);
+            } else {
+                this->m_dpInProgress = true;
+                this->log_ACTIVITY_LO_SignalGen_DpStarted(records);
+                this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
+            }
+        } else if (Ref::SignalGen_DpReqType::ASYNC == reqType) {
+            this->dpRequest_DataContainer(dpSize);
+        } else {
+            // should never get here
+            FW_ASSERT(0,reqType.e);
+        }
+
     }
 
     void SignalGen::cleanupAndSendDp() {
         this->dpSend(this->m_dpContainer);
-        this->m_dpInProgress = 0;
+        this->m_dpInProgress = false;
         this->m_dpBytes = 0;
         this->m_numDps = 0;
         this->m_currDp = 0;
@@ -252,8 +275,20 @@ namespace Ref {
             Fw::Success::T status
         )
     {
-        // TODO
-    }
 
+        // Make sure we got the buffer we wanted or quit
+        if (Fw::Success::SUCCESS == status) {
+            this->m_dpContainer = container;
+            this->m_dpInProgress = true;
+            this->log_ACTIVITY_LO_SignalGen_DpStarted(this->m_numDps);
+        } else {
+            this->log_WARNING_HI_SignalGen_DpMemoryFail();
+            // cleanup
+            this->m_dpInProgress = false;
+            this->m_dpBytes = 0;
+            this->m_numDps = 0;
+            this->m_currDp = 0;
+        }
+    }
 
 };

Ref/SignalGen/SignalGen.hpp

@@ -31,7 +31,7 @@ namespace Ref {
         void schedIn_handler(
             NATIVE_INT_TYPE portNum, /*!< The port number*/
             U32 context /*!< The call order*/
-        );
+        ) final;
 
         void SignalGen_Settings_cmdHandler(
             FwOpcodeType opCode, /*!< The opcode*/
@@ -46,6 +46,7 @@ namespace Ref {
             FwOpcodeType opCode, /*!< The opcode*/
             U32 cmdSeq /*!< The command sequence number*/
         ) final;
+
         void SignalGen_Skip_cmdHandler(
             FwOpcodeType opCode, /*!< The opcode*/
             U32 cmdSeq /*!< The command sequence number*/
@@ -55,10 +56,11 @@ namespace Ref {
         //!
         //! Signal Generator Settings
         void SignalGen_Dp_cmdHandler(
-            FwOpcodeType opCode, //!< The opcode
-            U32 cmdSeq, //!< The command sequence number
-            U32 records
-        ) final;
+           FwOpcodeType opCode, //!< The opcode
+           U32 cmdSeq, //!< The command sequence number
+           Ref::SignalGen_DpReqType reqType,
+           U32 records
+       ) final;
 
         // ----------------------------------------------------------------------
         // Handler implementations for data products

Ref/SignalGen/docs/sdd.md

@@ -3,15 +3,16 @@
 
 ## 1. Introduction
 
-The `Ref::SignalGen` is a demonstration component that receives data buffers from `Ref::SignalGen` ([SDD](../../SendBuffApp/docs/sdd.md)). It is a source for testing plots in the ground software.
+The `Ref::SignalGen` is a demonstration component that generates different waveforms. It is a source for testing plots in the ground software. It also provides a demonstration of data products.
 
 ## 2. Requirements
 
 The requirements for `Ref::SignalGen` are as follows:
 
 Requirement | Description | Verification Method
 ----------- | ----------- | -------------------
-ISF-SGN-001 | The `Ref::SignalGen` component shall generate telemetry with tunable waveforms | System test
+REF-SGN-001 | The `Ref::SignalGen` component shall generate telemetry with tunable waveforms | System test
+REF-SGN-002 | The `Ref::SignalGen` component shall store waveform data using data products | System test
 
 ## 3. Design
 
@@ -23,6 +24,12 @@ The `Ref::SignalGen` component has the following component diagram:
 
 ![`Ref::SignalGen` Diagram](img/SignalGenBDD.jpg "Ref::SignalGen")
 
+#### 3.1.2 Data Products
+
+The `Ref::SignalGen` component will generate data products using the `SignalGen_Dp` command.
+It will demonstrate the two different ways to request data product buffers and will generate
+a data product based on storing a commanded number of 
+
 ## 4. Dictionaries
 
 ## 5. Module Checklists
@@ -34,6 +41,7 @@ The `Ref::SignalGen` component has the following component diagram:
 Date | Description
 ---- | -----------
 4/20/2017 | Initial Version
+4/26/2024 | Added data product demonstration