Fix #16, Convert LC state macros to enums

nasa · Jun 1, 2023 · b4a92c1 · b4a92c1
1 parent feb5bf5
commit b4a92c1
Show file tree

Hide file tree

Showing 16 changed files with 386 additions and 374 deletions.
diff --git a/config/default_lc_fcncodes.h b/config/default_lc_fcncodes.h
@@ -27,7 +27,7 @@
 #define LC_FCNCODES_H
 
 /************************************************************************
- * Macro Definitions
+ * Type Definitions
  ************************************************************************/
 
 /**
@@ -152,8 +152,8 @@
  *       - Invalid actionpoint state specified in command message
  *       - Actionpoint number specified in command message is
  *         out of range
- *       - Actionpoint current state is either #LC_APSTATE_NOT_USED
- *         or #LC_APSTATE_PERMOFF
+ *       - Actionpoint current state is either #LC_ActionPoint_NOT_USED
+ *         or #LC_ActionPointState_PERMOFF
  *
  *  \par Evidence of failure may be found in the following telemetry:
  *       - #LC_HkTlm_Payload_t.CmdErrCount will increment
@@ -172,7 +172,7 @@
  * \brief Set AP Permanently Off
  *
  *  \par Description
- *       Set the specified actionpoint's state to #LC_APSTATE_PERMOFF
+ *       Set the specified actionpoint's state to #LC_ActionPointState_PERMOFF
  *
  *  \par Command Structure
  *       #LC_SetAPPermOffCmd_t
@@ -189,7 +189,7 @@
  *       - Command packet length not as expected
  *       - Actionpoint number specified in command message is
  *         out of range
- *       - Actionpoint current state is not #LC_APSTATE_DISABLED
+ *       - Actionpoint current state is not #LC_ActionPointState_DISABLED
  *
  *  \par Evidence of failure may be found in the following telemetry:
  *       - #LC_HkTlm_Payload_t.CmdErrCount will increment

diff --git a/config/default_lc_internal_cfg.h b/config/default_lc_internal_cfg.h
@@ -78,11 +78,11 @@
  *
  *  \par Limits:
  *       This parameter must be one of the following:
- *       #LC_STATE_ACTIVE
- *       #LC_STATE_PASSIVE
- *       #LC_STATE_DISABLED
+ *       #LC_AppState_ACTIVE
+ *       #LC_AppState_PASSIVE
+ *       #LC_AppState_DISABLED
  */
-#define LC_STATE_POWER_ON_RESET LC_STATE_DISABLED
+#define LC_STATE_POWER_ON_RESET LC_AppState_DISABLED
 
 /**
  * \brief Save data to CDS compiler switch
@@ -110,19 +110,19 @@
  *       is set to true, and provides a way to override any state LC
  *       may have been operating in prior to the reset occurring.
  *
- *       If this is set to LC_STATE_FROM_CDS and LC_SAVE_TO_CDS is set
+ *       If this is set to LC_AppState_FROM_CDS and LC_SAVE_TO_CDS is set
  *       to true, then the LC state will be preserved across resets and
- *       restored.  If this is not set to LC_STATE_FROM_CDS, the state
+ *       restored.  If this is not set to LC_AppState_FROM_CDS, the state
  *       saved in the CDS is overwritten by the state assigned here.
  *
  *  \par Limits:
  *       This parameter must be one of the following:
- *       #LC_STATE_ACTIVE
- *       #LC_STATE_PASSIVE
- *       #LC_STATE_DISABLED
- *       #LC_STATE_FROM_CDS
+ *       #LC_AppState_ACTIVE
+ *       #LC_AppState_PASSIVE
+ *       #LC_AppState_DISABLED
+ *       #LC_AppState_FROM_CDS
  */
-#define LC_STATE_WHEN_CDS_RESTORED LC_STATE_FROM_CDS
+#define LC_STATE_WHEN_CDS_RESTORED LC_AppState_FROM_CDS
 
 /**
  * \brief Watchpoint Definition Table (WDT) filename

diff --git a/config/default_lc_msgdefs.h b/config/default_lc_msgdefs.h
@@ -40,30 +40,40 @@
 #include "lc_fcncodes.h"
 
 /************************************************************************
- * Macro Definitions
+ * Type Definitions
  ************************************************************************/
 
 /**
  * \name LC Application States
  * \{
  */
-#define LC_STATE_ACTIVE   1 /**< \brief LC Application State Active */
-#define LC_STATE_PASSIVE  2 /**< \brief LC Application State Pasive */
-#define LC_STATE_DISABLED 3 /**< \brief LC Application State Disabled */
-#define LC_STATE_FROM_CDS 4 /**< \brief Used for reset processing, not valid state */
+typedef enum LC_AppState_Enum
+{
+    LC_AppState_ACTIVE = 1, /**< \brief LC Application State Active */
+    LC_AppState_PASSIVE,    /**< \brief LC Application State Pasive */
+    LC_AppState_DISABLED,   /**< \brief LC Application State Disabled */
+    LC_AppState_FROM_CDS    /**< \brief Used for reset processing, not valid state */
+} LC_AppState_Enum_t;
 /**\}*/
 
 /**
  * \name Actionpoint States
  * \{
  */
-#define LC_APSTATE_NOT_USED 0xFF /**< \brief Actionpoint unused, not valid command argument */
-#define LC_APSTATE_ACTIVE   1    /**< \brief Actionpoint state active */
-#define LC_APSTATE_PASSIVE  2    /**< \brief Actionpoint state passive */
-#define LC_APSTATE_DISABLED 3    /**< \brief Actionpoint state disabled */
-#define LC_APSTATE_PERMOFF  4    /**< \brief Actionpoint state permanently off, see #LC_SET_AP_PERM_OFF_CC */
+typedef enum LC_ActionPointState_Enum
+{
+    LC_ActionPointState_ACTIVE = 1, /**< \brief Actionpoint state active */
+    LC_ActionPointState_PASSIVE,    /**< \brief Actionpoint state passive */
+    LC_ActionPointState_DISABLED,   /**< \brief Actionpoint state disabled */
+    LC_ActionPointState_PERMOFF,    /**< \brief Actionpoint state permanently off, see #LC_SET_AP_PERM_OFF_CC */
+    LC_ActionPoint_NOT_USED = 255   /**< \brief Actionpoint unused, not valid command argument */
+} LC_ActionPointState_Enum_t;
 /**\}*/
 
+/************************************************************************
+ * Macro Definitions
+ ************************************************************************/
+
 /**
  * \name Special Values for Commands
  * \{
@@ -118,7 +128,8 @@
 /**\}*/
 
 #ifndef LC_OMIT_DEPRECATED
-#define LC_ACTION_NOT_USED LC_APSTATE_NOT_USED
+#define LC_SET_AP_PERMOFF_CC LC_SET_AP_PERM_OFF_CC
+#define LC_ACTION_NOT_USED   LC_ActionPoint_NOT_USED
 #endif
 
 #endif
diff --git a/config/default_lc_msgstruct.h b/config/default_lc_msgstruct.h
@@ -275,8 +275,8 @@ typedef struct
     uint8 APResults[LC_HKAR_NUM_BYTES]; /**< \brief Packed actionpoint results data, 4 bits per actionpoint */
 
     uint16 PassiveRTSExecCount; /**< \brief Total count of RTS sequences not initiated because the LC state is
-                                 *          set to #LC_STATE_PASSIVE or the state of the actionpoint that failed
-                                 *          is set to #LC_APSTATE_PASSIVE
+                                 *          set to #LC_AppState_PASSIVE or the state of the actionpoint that failed
+                                 *          is set to #LC_ActionPointState_PASSIVE
                                  */
 
     uint16 WPsInUse;  /**< \brief How many watchpoints are currently in effect */

diff --git a/docs/dox_src/cfs_lc.dox b/docs/dox_src/cfs_lc.dox
@@ -181,11 +181,11 @@
   commands as a response to this condition.
 
   Actionpoints can be individually enabled/disabled with the #LC_SET_AP_STATE_CC ground
-  command. The state of an actionpoint may be set to #LC_APSTATE_ACTIVE, #LC_APSTATE_PASSIVE,
-  or #LC_APSTATE_DISABLED. These states operate in the same way as the application operating
-  modes described above. #LC_APSTATE_PASSIVE will just disable RTS requests, while
-  #LC_APSTATE_DISABLED will stop evaluation of the actionpoint all together. An additional
-  state #LC_APSTATE_PERMOFF which functions the same as #LC_APSTATE_DISABLED but can only
+  command. The state of an actionpoint may be set to #LC_ActionPointState_ACTIVE, #LC_ActionPointState_PASSIVE,
+  or #LC_ActionPointState_DISABLED. These states operate in the same way as the application operating
+  modes described above. #LC_ActionPointState_PASSIVE will just disable RTS requests, while
+  #LC_ActionPointState_DISABLED will stop evaluation of the actionpoint all together. An additional
+  state #LC_ActionPointState_PERMOFF which functions the same as #LC_ActionPointState_DISABLED but can only
   be changed via table load, can be set using the #LC_SET_AP_PERM_OFF_CC ground command
   (see \ref cfslcfaqs).
 
@@ -259,7 +259,7 @@
   In the lc_platform_cfg.h file, there are configuration parameters that control use
   of the Critical Data Store (CDS) and the LC operation mode on application
   initialization. The default case is not to use the CDS and to set the application
-  state to #LC_STATE_DISABLED.
+  state to #LC_AppState_DISABLED.
 **/
 
 /**
@@ -302,7 +302,7 @@
   The entire ADT is processed any time a sample request is received that specifies an
   actionpoint equal to #LC_ALL_ACTIONPOINTS. For this reason, it is important that unused
   entries are properly marked by setting the ADT parameter DefaultState to
-  #LC_APSTATE_NOT_USED.
+  #LC_ActionPoint_NOT_USED.
 
   When either the WDT or ADT are updated, the corresponding results table (WRT or ART) is
   reset to initialization values. For each entry in the WRT, WatchResult is set to
@@ -523,7 +523,7 @@
      three possible conditions are true:
 
      1) The actionpoint is unused (the DefaultState in the ADT is set to
-        #LC_APSTATE_NOT_USED).
+        #LC_ActionPoint_NOT_USED).
 
      2) An actionpoint sample request (#LC_SAMPLE_AP_MID) targeting the AP has not
         yet been received by LC so the AP has not yet been evaluated.
@@ -551,27 +551,27 @@
   </I>
 
   <B> (Q)
-     How does the Actionpoint state #LC_APSTATE_PERMOFF differ from
-     #LC_APSTATE_DISABLED?
+     How does the Actionpoint state #LC_ActionPointState_PERMOFF differ from
+     #LC_ActionPointState_DISABLED?
   </B> <BR> <BR> <I>
-     The AP state #LC_APSTATE_PERMOFF is intended to provide a way to disable
+     The AP state #LC_ActionPointState_PERMOFF is intended to provide a way to disable
      an AP so it can not easily be turned back on by mistake. Such actionpoints
      may not be needed after a seperation sequence or only apply to certain
      mission phases.
 
      While the two states are treated the same way during actionpoint processing
      (the AP isn't evaluated), there are a few differences.
 
-     An AP can't be set to #LC_APSTATE_PERMOFF with the #LC_SET_AP_STATE_CC command,
+     An AP can't be set to #LC_ActionPointState_PERMOFF with the #LC_SET_AP_STATE_CC command,
      it must be done with the #LC_SET_AP_PERM_OFF_CC command.
 
-     To set an AP to #LC_APSTATE_PERMOFF with the #LC_SET_AP_PERM_OFF_CC command, the
-     current AP state must be #LC_APSTATE_DISABLED.
+     To set an AP to #LC_ActionPointState_PERMOFF with the #LC_SET_AP_PERM_OFF_CC command, the
+     current AP state must be #LC_ActionPointState_DISABLED.
 
      The #LC_SET_AP_PERM_OFF_CC command can only be issued for a single actionpoint,
      #LC_ALL_ACTIONPOINTS is not valid as an argument for this command.
 
-     Once an AP is set to #LC_APSTATE_PERMOFF, it can only be changed with a new ADT
+     Once an AP is set to #LC_ActionPointState_PERMOFF, it can only be changed with a new ADT
      table load.
   </I>
 
@@ -592,7 +592,7 @@
      #LC_HKAR_STATE_NOT_USED, #LC_HKAR_STATE_ACTIVE, #LC_HKAR_STATE_PASSIVE,
      #LC_HKAR_STATE_DISABLED
 
-     An actionpoint whose current state is #LC_APSTATE_PERMOFF will have it's
+     An actionpoint whose current state is #LC_ActionPointState_PERMOFF will have it's
      state reported in the APResults as #LC_HKAR_STATE_NOT_USED.
 
      The numerical 2 bit values for evaluation results are defined using the
@@ -614,9 +614,9 @@
      Will an RTS get requested more than once if an AP stays in the #LC_ACTION_FAIL
      state?
   </B> <BR> <BR> <I>
-     No. Assuming the current state of an actionpoint is #LC_APSTATE_ACTIVE, then
+     No. Assuming the current state of an actionpoint is #LC_ActionPointState_ACTIVE, then
      when the actionpoint fails enough times to trigger an RTS, the state is set
-     to #LC_APSTATE_PASSIVE.
+     to #LC_ActionPointState_PASSIVE.
 
      In the passive state, the AP will continue to be sampled and statistics
      updated, but no RTS requests will be initiated.

diff --git a/fsw/inc/lc_eventids.h b/fsw/inc/lc_eventids.h
@@ -448,7 +448,7 @@
  *
  *  This event message is issued when the #LC_SET_AP_STATE_CC command
  *  has been received and the current actionpoint state is either
- *  #LC_APSTATE_NOT_USED or #LC_APSTATE_PERMOFF which can only be changed
+ *  #LC_ActionPoint_NOT_USED or #LC_ActionPointState_PERMOFF which can only be changed
  *  with a table load.
  */
 #define LC_APSTATE_CURR_ERR_EID 31
@@ -498,7 +498,7 @@
  *
  *  This event message is issued when the #LC_SET_AP_PERM_OFF_CC command
  *  has been received and the current actionpoint state is not
- *  #LC_APSTATE_DISABLED
+ *  #LC_ActionPointState_DISABLED
  */
 #define LC_APOFF_CURR_ERR_EID 35
 
@@ -772,7 +772,7 @@
  *
  *  This event message is issued when the #LC_SAMPLE_AP_MID message
  *  has been received and the current state for the specified
- *  actionpoint state is either #LC_APSTATE_NOT_USED or #LC_APSTATE_PERMOFF.
+ *  actionpoint state is either #LC_ActionPoint_NOT_USED or #LC_ActionPointState_PERMOFF.
  */
 #define LC_APSAMPLE_CURR_ERR_EID 57
 
@@ -796,7 +796,7 @@
  *  \par Cause:
  *
  *  This event message is issued when an actionpoint fails evaluation while
- *  the LC task operating state is #LC_STATE_PASSIVE
+ *  the LC task operating state is #LC_AppState_PASSIVE
  */
 #define LC_PASSIVE_FAIL_DBG_EID 59
 
@@ -808,7 +808,7 @@
  *  \par Cause:
  *
  *  This event message is issued when an actionpoint fails evaluation while
- *  the actionpoint state is #LC_APSTATE_PASSIVE
+ *  the actionpoint state is #LC_ActionPointState_PASSIVE
  */
 #define LC_AP_PASSIVE_FAIL_INF_EID 60
 

diff --git a/fsw/src/lc_action.c b/fsw/src/lc_action.c
@@ -50,7 +50,7 @@ void LC_SampleAPs(uint16 StartIndex, uint16 EndIndex)
     */
     CurrentAPState = LC_OperData.ARTPtr[StartIndex].CurrentState;
 
-    if ((CurrentAPState != LC_ACTION_NOT_USED) && (CurrentAPState != LC_APSTATE_PERMOFF))
+    if ((CurrentAPState != LC_ActionPoint_NOT_USED) && (CurrentAPState != LC_ActionPointState_PERMOFF))
     {
         /*
          ** Sample selected actionpoints
@@ -91,7 +91,7 @@ void LC_SampleSingleAP(uint16 APNumber)
     */
     CurrentAPState = LC_OperData.ARTPtr[APNumber].CurrentState;
 
-    if ((CurrentAPState == LC_APSTATE_ACTIVE) || (CurrentAPState == LC_APSTATE_PASSIVE))
+    if ((CurrentAPState == LC_ActionPointState_ACTIVE) || (CurrentAPState == LC_ActionPointState_PASSIVE))
     {
         /*
         ** Evaluate the actionpoint and update the results
@@ -136,14 +136,14 @@ void LC_SampleSingleAP(uint16 APNumber)
                 /*
                 ** We have failed enough times to request the RTS
                 */
-                if (CurrentAPState == LC_APSTATE_ACTIVE)
+                if (CurrentAPState == LC_ActionPointState_ACTIVE)
                 {
                     /*
                     ** Actions go to passive after they've failed
                     */
-                    LC_OperData.ARTPtr[APNumber].CurrentState = LC_APSTATE_PASSIVE;
+                    LC_OperData.ARTPtr[APNumber].CurrentState = LC_ActionPointState_PASSIVE;
 
-                    if (LC_AppData.CurrentLCState == LC_STATE_ACTIVE)
+                    if (LC_AppData.CurrentLCState == LC_AppState_ACTIVE)
                     {
                         /*
                         ** If the LC application state is active, request the
@@ -501,15 +501,15 @@ int32 LC_ValidateADT(void *TableData)
         RPNPtr            = TableArray[TableIndex].RPNEquation;
         EventType         = TableArray[TableIndex].EventType;
 
-        if (DefaultState == LC_APSTATE_NOT_USED)
+        if (DefaultState == LC_ActionPoint_NOT_USED)
         {
             /*
             ** Unused table entry
             */
             UnusedCount++;
         }
-        else if ((DefaultState != LC_APSTATE_ACTIVE) && (DefaultState != LC_APSTATE_PASSIVE) &&
-                 (DefaultState != LC_APSTATE_DISABLED) && (DefaultState != LC_APSTATE_PERMOFF))
+        else if ((DefaultState != LC_ActionPointState_ACTIVE) && (DefaultState != LC_ActionPointState_PASSIVE) &&
+                 (DefaultState != LC_ActionPointState_DISABLED) && (DefaultState != LC_ActionPointState_PERMOFF))
         {
             /*
             ** Invalid default state

diff --git a/fsw/src/lc_app.c b/fsw/src/lc_app.c
@@ -837,7 +837,7 @@ CFE_Status_t LC_CreateTaskCDS(void)
             ** May need to override the restored application state
             */
 
-#if LC_STATE_WHEN_CDS_RESTORED != LC_STATE_FROM_CDS
+#if LC_STATE_WHEN_CDS_RESTORED != LC_AppState_FROM_CDS
             LC_AppData.CurrentLCState = LC_STATE_WHEN_CDS_RESTORED;
 #endif
         }

diff --git a/fsw/src/lc_app.h b/fsw/src/lc_app.h
@@ -191,9 +191,9 @@ typedef struct
     uint32 RTSExecCount;        /**< \brief Total count of RTS sequences initiated */
     uint16 PassiveRTSExecCount; /**< \brief Total count of RTS sequences not
                                             initiated because the LC state is
-                                            set to #LC_STATE_PASSIVE or the state
+                                            set to #LC_AppState_PASSIVE or the state
                                             of the actionpoint that failed is set to
-                                            #LC_APSTATE_PASSIVE                    */
+                                            #LC_ActionPointState_PASSIVE                    */
 
     uint16 CDSSavedOnExit; /**< \brief Variable that tells us if we exited clean or not */
     uint8  CurrentLCState; /**< \brief Current LC application operating state */