Bulk update for 2.5.0 release, see VDD for change summary

CMakeLists.txt

@@ -12,3 +12,11 @@ add_cfe_app(cs ${APP_SRC_FILES})
 include_directories(fsw/src)
 aux_source_directory(fsw/tables APP_TABLE_FILES)
 add_cfe_tables(cs ${APP_TABLE_FILES})
+
+# If UT is enabled, then add the tests from the subdirectory
+# Note that this is an app, and therefore does not provide
+# stub functions, as other entities would not typically make
+# direct function calls into this application.
+if (ENABLE_UNIT_TESTS)
+  add_subdirectory(unit-test)
+endif (ENABLE_UNIT_TESTS)

README.md

@@ -4,10 +4,10 @@ core Flight System (cFS) Checksum Application (CS)
 Open Source Release Readme
 ==========================
 
-CS Release 2.4.2
+CS Release 2.5.0
 
 Date: 
-10/07/2020
+9/24/2021
 
 Introduction
 -------------
@@ -23,28 +23,22 @@ Introduction
 
   The CS application is written in C and depends on the cFS Operating System 
   Abstraction Layer (OSAL) and cFE components. There is additional CS application 
-  specific configuration information contained in the application user's guide
-  available in https://github.com/nasa/CS/tree/master/docs/users_guide
+  specific configuration information contained in the application user's guide.
 
-  This software is licensed under the NASA Open Source Agreement. 
-  http://ti.arc.nasa.gov/opensource/nosa
+  Developer's guide information can be generated using Doxygen:
+  doxygen cs_doxygen_config.txt
 
 
 Software Included
 ------------------
-  Checksum application (CS) 2.4.2
+  Checksum application (CS) 2.5.0
 
 
 Software Required
 ------------------
+ cFS Caelum
 
- Operating System Abstraction Layer 5.0 or higher can be 
- obtained at https://github.com/nasa/osal
-
- core Flight Executive 6.8.0 or higher can be obtained at
- https://github.com/nasa/cfe
-
- Note: An integrated bundle including the cFE, OSAL, and PSP can 
+ Note: An integrated bundle including the cFE, OSAL, and PSP can
  be obtained at https://github.com/nasa/cfs
 
 About cFS

docs/dox_src/users_guide/cfs_cs.dox

@@ -1,7 +1,6 @@
 /**
   \mainpage
   <UL>
-      <LI> \subpage cfscsrevhist
       <LI> \subpage cfscsintro
       <LI> \subpage cfscsovr
       <LI> \subpage cfscsopr
@@ -17,45 +16,15 @@
   </UL>
 **/
 
-/**
-  \page cfscsrevhist CFS Checksum User's Guide Revision History
-
-  \verbatim  
-  $Log: cfs_cs.dox  $
-  Revision 1.3.1.1 2017/03/31 12:10:15EDT sstrege 
-  Updated overview section to make it clear that all checksum regions are now configurable.
-  Revision 1.3 2017/02/24 10:14:31EST mdeschu 
-  Update doxgyen user guide to reference the new options for cfe core and OS code segment checksumming
-  Revision 1.2 2017/02/13 14:51:48EST mdeschu 
-  Update doxygen User Guide to describe how the new way table enable/disable states are set at init
-  Revision 1.1 2015/07/24 19:10:04EDT rperera 
-  Initial revision
-  Member added to project /CFS-APPs-PROJECT/cs/docs/dox_src/users_guide/project.pj
-  Revision 1.5 2011/09/19 17:32:54EDT jmdagost 
-  Added text pointing out the risk of changing the default CRC algorithm.
-  Revision 1.4 2010/03/09 14:53:53EST jmdagost 
-  Made requested corrections and added tables discussion.
-  Revision 1.3 2010/03/09 14:47:23EST jmdagost 
-  Updated overview and deployment guide.
-  Revision 1.2 2009/04/18 12:12:42EDT dkobe 
-  Made User's Guide match standard format
-  Revision 1.1 2009/04/16 13:19:51EDT dkobe 
-  Initial revision
-  Member added to project c:/MKSDATA/MKS-REPOSITORY/CFS-REPOSITORY/cs/docs/dox_src/users_guide/project.pj
-  \endverbatim
-
-  Next: \ref cfscsintro
-**/
-
 /**
   \page cfscsintro CFS Checksum Introduction
 
   <H1> Scope </H1>
 
   This document provides a complete specification for the commands and telemetry associated
   with the CFS Checksum (CS) application software.  The document is intended primarily 
-  for users of the software (operations personal, test engineers, and maintenance personal).  
-  The deployment guide section, is intended for mission developers when deploying and 
+  for users of the software (operations personnel, test engineers, and maintenance personnel).  
+  The deployment guide section is intended for mission developers when deploying and 
   configuring the CS application software for a mission flight software build environment. 
 
   <H1> Applicable Documents </H1>
@@ -89,6 +58,7 @@
   <TR><TD WIDTH="20%"> Cmd     </TD> <TD WIDTH="40%"> Command                                         </TD>
   <TR><TD WIDTH="20%"> CPU     </TD> <TD WIDTH="40%"> Central Processing Unit                         </TD>
   <TR><TD WIDTH="20%"> EDAC    </TD> <TD WIDTH="40%"> Error Detection and Correction                  </TD>
+  <TR><TD WIDTH="20%"> EEPROM  </TD> <TD WIDTH="40%"> Electrically Erasable Programmable Read-Only Memory </TD>
   <TR><TD WIDTH="20%"> FDS     </TD> <TD WIDTH="40%"> Flight Data System                              </TD>
   <TR><TD WIDTH="20%"> FM      </TD> <TD WIDTH="40%"> File Manager                                    </TD>
   <TR><TD WIDTH="20%"> FSW     </TD> <TD WIDTH="40%"> Flight Software                                 </TD>
@@ -178,8 +148,8 @@
   default definition tables located in non-volatile memory.  Each table has
   a corresponding setting in the platform configuration of the enable/disabled
   state of each table, the OS code segments and cFE Core for checksumming. 
-  These values are used for at initialization for power-on reset or if CS is
-  not configured to preserve states on via the CDS they will also be used for 
+  These values are used at initialization for power-on reset or if CS is
+  not configured to preserve states via the CDS they will also be used for 
   processor-reset.  If CS is configured to preserve enable state of the tables 
   on a proc reset, states from CDS will be used upon processor reset.
 
@@ -195,6 +165,14 @@
   automatically sets up checksumming for those areas and enables them for 
   checksumming. 
 
+  <H2>CDS Usage</H2>
+  If the CS application is configured to preserve states across processor
+  resets, the enable/disable state of each individual checksum region will
+  be stored in the CDS.  The CDS is updated each time an Enable or Disable
+  ground command is processed for a specific checksum region.
+
+  CS also includes a ground command to enable or disable all checksumming.  This
+  overall setting is not saved to the CDS.  
 
   Next: \ref cfscsreq <BR>
   Prev: \ref cfscsovr

fsw/platform_inc/cs_platform_cfg.h

@@ -42,7 +42,7 @@
 **       The string length (including string terminator) cannot exceed
 **       #OS_MAX_PATH_LEN.  (limit is not verified)
 */
-#define CS_DEF_EEPROM_TABLE_FILENAME                "/cf/apps/cs_eepromtbl.tbl"
+#define CS_DEF_EEPROM_TABLE_FILENAME                "/cf/cs_eepromtbl.tbl"
 
 /**
 **  \cscfg Memory Address File Table -- default table filename
@@ -55,7 +55,7 @@
 **       The string length (including string terminator) cannot exceed
 **       #OS_MAX_PATH_LEN.  (limit is not verified)
 */
-#define CS_DEF_MEMORY_TABLE_FILENAME                "/cf/apps/cs_memorytbl.tbl"
+#define CS_DEF_MEMORY_TABLE_FILENAME                "/cf/cs_memorytbl.tbl"
 
 /**
 **  \cscfg Tables File Table -- default table filename
@@ -68,7 +68,7 @@
 **       The string length (including string terminator) cannot exceed
 **       #OS_MAX_PATH_LEN.  (limit is not verified)
 */
-#define CS_DEF_TABLES_TABLE_FILENAME                "/cf/apps/cs_tablestbl.tbl"
+#define CS_DEF_TABLES_TABLE_FILENAME                "/cf/cs_tablestbl.tbl"
 
 /**
 **  \cscfg Application File Table -- default table filename
@@ -81,7 +81,7 @@
 **       The string length (including string terminator) cannot exceed
 **       #OS_MAX_PATH_LEN.  (limit is not verified)
 */
-#define CS_DEF_APP_TABLE_FILENAME                   "/cf/apps/cs_apptbl.tbl"
+#define CS_DEF_APP_TABLE_FILENAME                   "/cf/cs_apptbl.tbl"
 
 /**
 **  \cscfg Application Pipe Depth 
@@ -97,7 +97,7 @@
 **		 The value must be greater than zero and cannot exceed the
 **       definition of #CFE_SB_MAX_PIPE_DEPTH.
 */
-#define CS_PIPE_DEPTH                   12
+#define CS_PIPE_DEPTH              (3 * CFE_PLATFORM_SB_DEFAULT_MSG_LIMIT)
 
 /** \cscfg  Maximum number of entries in the Eeprom table to checksum
  **  
@@ -170,8 +170,7 @@
  **        with 1 being the highest priority in the case of a child task.
  **
  **  \par Limits:
- **       Valid range for a child task is 1 to 255, but the priority cannot be 
- **       higher (lower number) than the CS App priority. 
+ **       Valid range for a child task is 1 to 255 
  **
  */
 #define CS_CHILD_TASK_PRIORITY              200
@@ -246,7 +245,7 @@
 */
 #define CS_EEPROM_TBL_POWERON_STATE CS_STATE_ENABLED
 
-/** \cscfg Desired state of the EEPROM table at power on
+/** \cscfg Desired state of the Memory table at power on
 **  
 **  \par Description:
 **       This determines the default state the Memory table should
@@ -288,7 +287,7 @@
 **  \par Limits:
 **       None
 */
-#define CS_PRESERVE_STATES_ON_PROCESSOR_RESET TRUE
+#define CS_PRESERVE_STATES_ON_PROCESSOR_RESET true
 
 
 /** \cscfg Name of the Critical Data Store Used for CS