Backport FileDownlink timeout removal (#5287)

* Backport #4555 to v3.6.x
* Ignore returned buffers when in COOLDOWN mode, matching IDLE mode behavior
* Spelling fix

---------

Co-authored-by: M Starch <LeStarch@googlemail.com>

Author: nathancheek

Svc/FileDownlink/Events.fppi

@@ -33,15 +33,6 @@ event DownlinkCanceled(
   id 0x03 \
   format "Canceled downlink of file {} to file {}"
 
-@ The File Downlink component has detected a timeout. Downlink has been canceled.
-event DownlinkTimeout(
-                       sourceFileName: string size 100 @< The source filename
-                       destFileName: string size 100 @< The destination file name
-                     ) \
-  severity warning high \
-  id 0x04 \
-  format "Timeout occurred during downlink of file {} to file {}. Downlink has been canceled."
-
 @ The File Downlink component has detected a timeout. Downlink has been canceled.
 event DownlinkPartialWarning(
                               startOffset: U32 @< Starting file offset in bytes

Svc/FileDownlink/FileDownlink.cpp

@@ -45,13 +45,11 @@ namespace Svc {
 
   void FileDownlink ::
     configure(
-        U32 timeout,
         U32 cooldown,
         U32 cycleTime,
         U32 fileQueueDepth
     )
   {
-    this->m_timeout = timeout;
     this->m_cooldown = cooldown;
     this->m_cycleTime = cycleTime;
     this->m_configured = true;
@@ -121,15 +119,7 @@ namespace Svc {
         break;
       }
       case Mode::WAIT: {
-        //If current timeout is too-high and we are waiting for a packet, issue a timeout
-        if (this->m_curTimer >= this->m_timeout) {
-          this->m_curTimer = 0;
-          this->log_WARNING_HI_DownlinkTimeout(this->m_file.getSourceName(), this->m_file.getDestName());
-          this->enterCooldown();
-          this->sendResponse(FILEDOWNLINK_COMMAND_FAILURES_DISABLED ? SendFileStatus::STATUS_OK : SendFileStatus::STATUS_ERROR);
-        } else { //Otherwise update the current counter
-          this->m_curTimer += m_cycleTime;
-        }
+        this->m_curTimer += m_cycleTime;
         break;
       }
       default:
@@ -184,16 +174,17 @@ namespace Svc {
         Fw::Buffer &fwBuffer
     )
   {
-	  //If this is a stale buffer (old, timed-out, or both), then ignore its return.
-	  //File downlink actions only respond to the return of the most-recently-sent buffer.
-	  if (this->m_lastBufferId != fwBuffer.getContext() + 1 ||
-	      this->m_mode.get() == Mode::IDLE) {
-		  return;
-	  }
-	  //Non-ignored buffers cannot be returned in "DOWNLINK" and "IDLE" state.  Only in "WAIT", "CANCEL" state.
-	  FW_ASSERT(this->m_mode.get() == Mode::WAIT || this->m_mode.get() == Mode::CANCEL, this->m_mode.get());
+      //If this is a stale buffer (old, timed-out, or both), then ignore its return.
+      //File downlink actions only respond to the return of the most-recently-sent buffer.
+      if (this->m_lastBufferId != fwBuffer.getContext() + 1 ||
+          this->m_mode.get() == Mode::IDLE ||
+          this->m_mode.get() == Mode::COOLDOWN) {
+          return;
+      }
+      //Non-ignored buffers cannot be returned in "DOWNLINK", "IDLE", or "COOLDOWN" state.  Only in "WAIT", "CANCEL" state.
+      FW_ASSERT(this->m_mode.get() == Mode::WAIT || this->m_mode.get() == Mode::CANCEL, this->m_mode.get());
       //If the last packet has been sent (and is returning now) then finish the file
-	  if (this->m_lastCompletedType == Fw::FilePacket::T_END ||
+      if (this->m_lastCompletedType == Fw::FilePacket::T_END ||
           this->m_lastCompletedType == Fw::FilePacket::T_CANCEL) {
           finishHelper(this->m_lastCompletedType == Fw::FilePacket::T_CANCEL);
           return;
@@ -501,7 +492,7 @@ namespace Svc {
           this->sendCancelPacket();
           this->m_lastCompletedType = Fw::FilePacket::T_CANCEL;
       }
-      //If in downlink mode and currently downlinking data then continue with the next packer
+      //If in downlink mode and currently downlinking data then continue with the next packet
       else if (this->m_mode.get() == Mode::DOWNLINK && this->m_lastCompletedType == Fw::FilePacket::T_START) {
           //Send the next packet, or fail doing so
           const Os::File::Status status = this->sendDataPacket(this->m_byteOffset);

Svc/FileDownlink/FileDownlink.hpp

@@ -272,7 +272,6 @@ namespace Svc {
       //! Configure FileDownlink component
       //!
       void configure(
-          U32 timeout, //!< Timeout threshold (milliseconds) while in WAIT state
           U32 cooldown, //!< Cooldown (in ms) between finishing a downlink and starting the next file.
           U32 cycleTime, //!< Rate at which we are running
           U32 fileQueueDepth //!< Max number of items in file downlink queue

Svc/FileDownlink/docs/sdd.md

@@ -65,10 +65,8 @@ Name | Type | Kind | Purpose
 at component instantiation time:
 
 * *downlinkPacketSize*: The size of the packets to use on downlink.
-* *timeout*: Max amount of time in ms to wait for a buffer return before aborting downlink
 * *cooldown*: The amount of time in ms to wait in a cooldown state before starting next downlink.
-* *cycle time*: Frequency in ms of clock pulses sent to `Run` port, used for timing timeouts and
-  cooldown.
+* *cycle time*: Frequency in ms of clock pulses sent to `Run` port, used for cooldown.
 * *file queue depth*: The maximum number of files that can be held in the internal file downlink
   queue. Attempting to dispatch a SendFile command or port call while the queue is full will result
   in a busy error response.
@@ -123,7 +121,3 @@ Checklist |
 [Design](Checklist/design.xlsx) |
 [Code](Checklist/code.xlsx) |
 [Unit Test](Checklist/unit_test.xls) |
-
-## 6 Unit Testing
-
-TODO

Svc/FileDownlink/test/ut/FileDownlinkMain.cpp

@@ -29,11 +29,6 @@ TEST(FileDownlink, DownlinkPartial) {
   tester.downlinkPartial();
 }
 
-TEST(FileDownlink, DownlinkTimeout) {
-    Svc::FileDownlinkTester tester;
-    tester.timeout();
-}
-
 TEST(FileDownlink, SendFilePort) {
     Svc::FileDownlinkTester tester;
     tester.sendFilePort();

Svc/FileDownlink/test/ut/FileDownlinkTester.cpp

@@ -18,7 +18,6 @@
 #define CMD_SEQ 0
 #define QUEUE_DEPTH 10
 
-#define TIMEOUT_MS 1000
 #define COOLDOWN_MS 500
 #define CYCLE_MS 100
 #define MAX_ALLOCATED 100
@@ -34,7 +33,7 @@ namespace Svc {
       component("FileDownlink"),
       buffers_index(0)
   {
-    this->component.configure(TIMEOUT_MS, COOLDOWN_MS, CYCLE_MS, 10);
+    this->component.configure(COOLDOWN_MS, CYCLE_MS, 10);
     this->connectPorts();
     this->initComponents();
   }
@@ -270,60 +269,6 @@ namespace Svc {
 
   }
 
-    void FileDownlinkTester ::
-      timeout()
-    {
-        // Assert idle mode
-        ASSERT_EQ(FileDownlink::Mode::IDLE, this->component.m_mode.get());
-
-        // Create a file
-        const char *const sourceFileName = "source.bin";
-        const char *const destFileName = "dest.bin";
-        U8 data[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 };
-        FileBuffer fileBufferOut(data, sizeof(data));
-        fileBufferOut.write(sourceFileName);
-
-        Fw::CmdStringArg sourceCmdStringArg(sourceFileName);
-        Fw::CmdStringArg destCmdStringArg(destFileName);
-        this->sendCmd_SendFile(
-          INSTANCE,
-          CMD_SEQ,
-          sourceCmdStringArg,
-          destCmdStringArg
-        );
-        this->component.doDispatch(); // Dispatch sendfile command
-        this->component.Run_handler(0,0); // Pull file from queue
-
-        // Continue running the component without dispatching the responses
-        for (U32 i = 0; i < TIMEOUT_MS/CYCLE_MS; i++) {
-            this->component.Run_handler(0,0);
-            ASSERT_CMD_RESPONSE_SIZE(0);
-        }
-
-        this->component.Run_handler(0,0);
-        ASSERT_CMD_RESPONSE_SIZE(1);
-        Fw::CmdResponse expResp = FILEDOWNLINK_COMMAND_FAILURES_DISABLED ? Fw::CmdResponse::OK : Fw::CmdResponse::EXECUTION_ERROR;
-        ASSERT_CMD_RESPONSE(0, FileDownlink::OPCODE_SENDFILE, CMD_SEQ, expResp);
-
-        // Assert telemetry
-        ASSERT_TLM_SIZE(1);
-        ASSERT_TLM_PacketsSent_SIZE(1);
-
-        // Assert events
-        ASSERT_EVENTS_SIZE(2);
-        ASSERT_EVENTS_DownlinkTimeout_SIZE(1);
-        ASSERT_EVENTS_SendStarted_SIZE(1);
-//    printTextLogHistory(stdout);
-        ASSERT_EVENTS_SendStarted(0, 10, sourceFileName, destFileName);
-        ASSERT_EVENTS_DownlinkTimeout(0, sourceFileName, destFileName);
-
-        // Assert idle mode
-        ASSERT_EQ(FileDownlink::Mode::COOLDOWN, this->component.m_mode.get());
-
-        // Remove the outgoing file
-        this->removeFile(sourceFileName);
-    }
-
     void FileDownlinkTester ::
     sendFilePort()
   {

Svc/FileDownlink/test/ut/FileDownlinkTester.hpp

@@ -126,10 +126,6 @@ namespace Svc {
       //!
       void downlinkPartial();
 
-      //! Timeout
-      //!
-      void timeout();
-
       //! sendFilePort
       //! Test downlinking a file via a port
       //!