Fix #115, remove conditional compile on time ref

Define a SC_TimeAccessor_t object and select the correct value for it at compile time, as opposed to preprocessor #if blocks.
nasa · Oct 24, 2023 · d7f72d5 · d7f72d5
1 parent 05dd449
commit d7f72d5
Show file tree

Hide file tree

Showing 10 changed files with 202 additions and 104 deletions.
diff --git a/config/default_sc_internal_cfg.h b/config/default_sc_internal_cfg.h
@@ -345,8 +345,8 @@
  *       This parameter defines what type of time SC should use for sending uot its commands
  *
  *  \par Limits:
- *       Must be SC_USE_CFE_TIME, SC_USE_TAI, or SC_USE_UTC */
-#define SC_TIME_TO_USE SC_USE_CFE_TIME
+ *       Must be SC_TimeRef_USE_CFE_TIME, SC_TimeRef_USE_TAI, or SC_TimeRef_USE_UTC */
+#define SC_TIME_TO_USE SC_TimeRef_USE_CFE_TIME
 
 /**
  * \brief Autostart RTS ID after power on

diff --git a/config/default_sc_msgdefs.h b/config/default_sc_msgdefs.h
@@ -76,13 +76,28 @@
 /**\}*/
 
 /**
- * \name constants for config parameters for which TIME to use
+ * Enumeration of config parameters for which time reference to use
+ */
+enum SC_TimeRef
+{
+    SC_TimeRef_USE_CFE_TIME, /**< \brief Use cFE configured time */
+    SC_TimeRef_USE_TAI,      /**< \brief Use TAI Time */
+    SC_TimeRef_USE_UTC,      /**< \brief USE UTC Time */
+    SC_TimeRef_MAX
+};
+
+typedef uint8 SC_TimeRef_Enum_t;
+
+#ifndef SC_OMIT_DEPRECATED
+/**
+ * \name Old-style constants for config parameters for which TIME to use
  * \{
  */
-#define SC_USE_CFE_TIME 0 /**< \brief Use cFE configured time */
-#define SC_USE_TAI      1 /**< \brief Use TAI Time */
-#define SC_USE_UTC      2 /**< \brief USE UTC Time */
+#define SC_USE_CFE_TIME SC_TimeRef_USE_CFE_TIME
+#define SC_USE_TAI      SC_TimeRef_USE_TAI
+#define SC_USE_UTC      SC_TimeRef_USE_UTC
 /**\}*/
+#endif
 
 #define SC_INVALID_RTS_NUMBER 0 /**< \brief Invalid RTS number */
 

diff --git a/docs/dox_src/cfs_sc.dox b/docs/dox_src/cfs_sc.dox
diff --git a/fsw/src/sc_app.c b/fsw/src/sc_app.c
@@ -33,6 +33,7 @@
 
 #include "cfe.h"
 #include "sc_app.h"
+#include "sc_utils.h"
 #include "sc_dispatch.h"
 #include "sc_loads.h"
 #include "sc_events.h"
@@ -151,6 +152,9 @@ CFE_Status_t SC_AppInit(void)
 
     SC_AppData.EnableHeaderUpdate = SC_PLATFORM_ENABLE_HEADER_UPDATE;
 
+    /* assign the time ref accessor from the compile-time option */
+    SC_AppData.TimeRef = SC_LookupTimeAccessor(SC_TIME_TO_USE);
+
     /* Make sure nothing is running */
     SC_AppData.NextProcNumber      = SC_NONE;
     SC_AppData.NextCmdTime[SC_ATP] = SC_MAX_TIME;

diff --git a/fsw/src/sc_app.h b/fsw/src/sc_app.h
@@ -34,6 +34,19 @@
 #include "sc_msgdefs.h"
 #include "sc_msg.h"
 
+/**
+ * SC time accessor object
+ *
+ * Wrapper structure containing a method to get
+ * the current reference time.  This reference is
+ * used for evaluationg all time references in ATSs
+ * and RTSs.
+ */
+typedef struct SC_TimeAccessor
+{
+    CFE_TIME_SysTime_t (*GetTime)(void);
+} SC_TimeAccessor_t;
+
 /**
  *  \brief ATP Control Block Type
  */
@@ -330,6 +343,9 @@ typedef struct
          These offsets correspond to the addresses of ATS commands located in the ATS table.
          The index used is the ATS command index with values from 0 to SC_MAX_ATS_CMDS-1 */
 
+
+    SC_TimeAccessor_t TimeRef; /**< \brief Configured time reference */
+
     bool EnableHeaderUpdate; /**< \brief whether to update headers in outgoing messages */
 
     uint8           NextProcNumber;  /**< \brief the next command processor number */

diff --git a/fsw/src/sc_utils.c b/fsw/src/sc_utils.c
@@ -40,6 +40,25 @@
  **
  **************************************************************************/
 
+/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
+/*                                                                 */
+/* Look up the time accessor corresponding to the chosen reference */
+/*                                                                 */
+/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
+SC_TimeAccessor_t SC_LookupTimeAccessor(SC_TimeRef_Enum_t TimeRef)
+{
+    static const SC_TimeAccessor_t TIMEREF_LOOKUP[SC_TimeRef_MAX] = {[SC_TimeRef_USE_CFE_TIME] = {CFE_TIME_GetTime},
+                                                                     [SC_TimeRef_USE_TAI]      = {CFE_TIME_GetTAI},
+                                                                     [SC_TimeRef_USE_UTC]      = {CFE_TIME_GetUTC}};
+
+    if (TimeRef >= SC_TimeRef_MAX)
+    {
+        TimeRef = SC_TimeRef_USE_CFE_TIME;
+    }
+
+    return TIMEREF_LOOKUP[TimeRef];
+}
+
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 /*                                                                 */
 /* Get the Current time from CFE TIME                              */
@@ -49,15 +68,8 @@ void SC_GetCurrentTime(void)
 {
     CFE_TIME_SysTime_t TempTime;
 
-/* Use SC defined time */
-#if (SC_TIME_TO_USE == SC_USE_UTC)
-    TempTime = CFE_TIME_GetUTC();
-#elif (SC_TIME_TO_USE == SC_USE_TAI)
-    TempTime = CFE_TIME_GetTAI();
-#else
-    /* Use cFE configured time */
-    TempTime = CFE_TIME_GetTime();
-#endif
+    /* Use SC defined time */
+    TempTime = SC_AppData.TimeRef.GetTime();
 
     /* We don't care about subseconds */
     SC_AppData.CurrentTime = TempTime.Seconds;

diff --git a/fsw/src/sc_utils.h b/fsw/src/sc_utils.h
@@ -109,4 +109,15 @@ bool SC_CompareAbsTime(SC_AbsTimeTag_t AbsTime1, SC_AbsTimeTag_t AbsTime2);
  */
 uint16 SC_ToggleAtsIndex(void);
 
+/**
+ * \brief Finds the time accessor object associated with the given time ref
+ *
+ * \par Description
+ *      Translates the enumeration value into a time accessor
+ *
+ * \param TimeRef Selected time reference enumeration value
+ * \returns Time accessor object
+ */
+SC_TimeAccessor_t SC_LookupTimeAccessor(SC_TimeRef_Enum_t TimeRef);
+
 #endif
diff --git a/fsw/src/sc_verify.h b/fsw/src/sc_verify.h
@@ -195,10 +195,10 @@
 
 #ifndef SC_TIME_TO_USE
 #error SC_TIME_TO_USE must be defined!
-#elif (SC_TIME_TO_USE != SC_USE_CFE_TIME)
-#if (SC_TIME_TO_USE != SC_USE_TAI)
-#if (SC_TIME_TO_USE != SC_USE_UTC)
-#error SC_TIME_TO_USE must be either SC_USE_CFE_TIME, SC_USE_TAI or SC_USE_UTC!
+#elif (SC_TIME_TO_USE != SC_TimeRef_USE_CFE_TIME)
+#if (SC_TIME_TO_USE != SC_TimeRef_USE_TAI)
+#if (SC_TIME_TO_USE != SC_TimeRef_USE_UTC)
+#error SC_TIME_TO_USE must be either SC_TimeRef_USE_CFE_TIME, SC_TimeRef_USE_TAI or SC_TimeRef_USE_UTC!
 #endif
 #endif
 #endif

diff --git a/unit-test/sc_utils_tests.c b/unit-test/sc_utils_tests.c
@@ -30,15 +30,38 @@
 
 /* sc_utils_tests globals */
 
+static CFE_TIME_SysTime_t UT_TimeRefFunc(void)
+{
+    return (CFE_TIME_SysTime_t) {1234, 5678};
+}
+
+void SC_LookupTimeAccessor_Test(void)
+{
+    union
+    {
+        SC_TimeAccessor_t Obj;
+        void *            Addr;
+    } Accessor;
+
+    Accessor.Addr = NULL;
+    Accessor.Obj  = SC_LookupTimeAccessor(SC_TimeRef_USE_TAI);
+    UtAssert_NOT_NULL(Accessor.Addr);
+
+    Accessor.Addr = NULL;
+    Accessor.Obj  = SC_LookupTimeAccessor(SC_TimeRef_MAX);
+    UtAssert_NOT_NULL(Accessor.Addr);
+}
+
 void SC_GetCurrentTime_Test(void)
 {
+    SC_AppData.TimeRef     = (SC_TimeAccessor_t) {UT_TimeRefFunc};
     SC_AppData.CurrentTime = 0;
 
     /* Execute the function being tested */
     UtAssert_VOIDCALL(SC_GetCurrentTime());
 
     /* Verify results */
-    UtAssert_True(SC_AppData.CurrentTime != 0, "SC_AppData.CurrentTime != 0");
+    UtAssert_UINT32_EQ(SC_AppData.CurrentTime, 1234);
 }
 
 void SC_GetAtsEntryTime_Test(void)
@@ -95,6 +118,7 @@ void SC_ToggleAtsIndex_Test(void)
 
 void UtTest_Setup(void)
 {
+    UtTest_Add(SC_LookupTimeAccessor_Test, SC_Test_Setup, SC_Test_TearDown, "SC_LookupTimeAccessor_Test");
     UtTest_Add(SC_GetCurrentTime_Test, SC_Test_Setup, SC_Test_TearDown, "SC_GetCurrentTime_Test");
     UtTest_Add(SC_GetAtsEntryTime_Test, SC_Test_Setup, SC_Test_TearDown, "SC_GetAtsEntryTime_Test");
     UtTest_Add(SC_ComputeAbsTime_Test, SC_Test_Setup, SC_Test_TearDown, "SC_ComputeAbsTime_Test");

diff --git a/unit-test/stubs/sc_utils_stubs.c b/unit-test/stubs/sc_utils_stubs.c
@@ -86,6 +86,22 @@ void SC_GetCurrentTime(void)
     UT_GenStub_Execute(SC_GetCurrentTime, Basic, NULL);
 }
 
+/*
+ * ----------------------------------------------------
+ * Generated stub function for SC_LookupTimeAccessor()
+ * ----------------------------------------------------
+ */
+SC_TimeAccessor_t SC_LookupTimeAccessor(SC_TimeRef_Enum_t TimeRef)
+{
+    UT_GenStub_SetupReturnBuffer(SC_LookupTimeAccessor, SC_TimeAccessor_t);
+
+    UT_GenStub_AddParam(SC_LookupTimeAccessor, SC_TimeRef_Enum_t, TimeRef);
+
+    UT_GenStub_Execute(SC_LookupTimeAccessor, Basic, NULL);
+
+    return UT_GenStub_GetReturnValue(SC_LookupTimeAccessor, SC_TimeAccessor_t);
+}
+
 /*
  * ----------------------------------------------------
  * Generated stub function for SC_ToggleAtsIndex()