Bulk update for 2.5.0 release, see VDD for change summary

CMakeLists.txt

@@ -9,3 +9,11 @@ aux_source_directory(fsw/src APP_SRC_FILES)
 
 # Create the app module
 add_cfe_app(mm ${APP_SRC_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

@@ -1,17 +1,57 @@
-# Memory Manager
+core Flight System (cFS) Memory Manager Application (MM)
+======================================================
 
-NASA core Flight System Memory Manager Application
+Open Source Release Readme
+==========================
 
-## Description
+MM Release 2.5.0
 
-The Memory Manager application (MM) is a core Flight System (cFS) application that is a plug in to the Core Flight Executive (cFE) component of the cFS.
+Date: 9/2/2021
 
-The cFS is a platform and project independent reusable software framework and set of reusable applications developed by NASA Goddard Space Flight Center. This framework is used as the basis for the flight software for satellite data systems and instruments, but can be used on other embedded systems. More information on the cFS can be found at [http://cfs.gsfc.nasa.gov](http://cfs.gsfc.nasa.gov)
+Introduction
+-------------
+  The Memory Manager application (MM) is a core Flight System (cFS) application 
+  that is a plug in to the Core Flight Executive (cFE) component of the cFS.  
+
+  The MM application is used for the loading and dumping system memory. MM 
+  provides an operator interface to the memory manipulation functions contained
+  in the PSP (Platform Support Package) and OSAL (Operating System Abstraction 
+  Layer) components of the cFS. MM provides the ability to load and dump memory 
+  via command parameters, as well as, from files. If the operating system 
+  supports symbolic addressing, MM allows specifying the memory address using a 
+  symbolic address.   
 
-The MM application is used for the loading and dumping system memory. MM provides an operator interface to the memory manipulation functions contained in the PSP (Platform Support Package) and OSAL (Operating System Abstraction Layer) components of the cFS. MM provides the ability to load and dump memory via command parameters, as well as, from files. Supports symbolic addressing.
+  The MM application is written in C and depends on the cFS Operating System
+  Abstraction Layer (OSAL) and cFE components.  There is additional MM application
+  specific configuration information contained in the application user's guide.
 
-MM requires use of the [cFS application library](https://github.com/nasa/cfs_lib).
+  Developer's guide information can be generated using Doxygen:
+  doxygen mm_doxygen_config.txt
 
-## License
+  This software is licensed under the NASA Open Source Agreement.
+  http://ti.arc.nasa.gov/opensource/nosa
 
-This software is licensed under the NASA Open Source Agreement. http://ti.arc.nasa.gov/opensource/nosa
+
+Software Included
+------------------
+
+  Memory Manager application (MM) 2.5.0
+
+
+Software Required
+------------------
+
+ cFS Caelum
+
+ Note: An integrated bundle including the cFE, OSAL, and PSP can
+ be obtained at https://github.com/nasa/cfs
+
+About cFS
+----------
+  The cFS is a platform and project independent reusable software framework and
+  set of reusable applications developed by NASA Goddard Space Flight Center.
+  This framework is used as the basis for the flight software for satellite data
+  systems and instruments, but can be used on other embedded systems.  More
+  information on the cFS can be found at http://cfs.gsfc.nasa.gov
+
+EOF

docs/dox_src/users_guide/cfs_mm.dox

@@ -40,6 +40,8 @@
   Member added to project c:/MKSDATA/MKS-REPOSITORY/CFS-REPOSITORY/mm/docs/dox_src/users_guide/project.pj
   \endverbatim
 
+
+  Next: \ref cfsmmintro <BR>
 **/
 
 /**
@@ -113,8 +115,9 @@
   <TR><TD WIDTH="20%"> UTC     </TD> <TD WIDTH="40%"> Universal time code                             </TD>
   </TABLE>
 
-  Prev: \ref cfsmmrevhist <BR>
-  Next: \ref cfsmmovr
+
+  Next: \ref cfsmmovr <BR>
+  Prev: \ref cfsmmrevhist 
 **/
 
 /**
@@ -151,8 +154,9 @@
   <LI> \subpage cfsmmugsymbols
   </UL>
   <BR><BR>
-  Prev: \ref cfsmmintro <BR>
-  Next: \ref cfsmmopr
+
+  Next: \ref cfsmmopr <BR>
+  Prev: \ref cfsmmintro 
 **/
 
 /**
@@ -208,7 +212,11 @@
   The MM secondary header defined by the #MM_LoadDumpFileHeader_t data type.
 
   A variable size block of binary data that holds the memory contents dumped or the data to be loaded.
-
+
+  On some operating systems, MM also provides the ability to dump the symbol
+  table to a file.  The resulting symbol table file does not include the
+  standard cFE file header.
+
   Next: \ref cfsmmugsymbols <BR>
   Prev: \ref cfsmmugmemtypes <BR>
   Up To: \ref cfsmmovr
@@ -457,7 +465,10 @@
   #MM_MISSION_REV defines the mission-level revision number.  The default value is 0.  This value is appended
   to the major version, minor version, and revision numbers.  It should be an integer value greater than 
   or equal to 0.
-
+
+  Next: \ref cfsmmcmds <BR>
+  Prev: \ref cfsmmreq
+
 **/
 
 /**
@@ -470,6 +481,11 @@
   </TABLE>
 
   The following is a list of commands that are processed by the CFS Memory Manager Application. 
+
+  Next: \ref cfsmmtlm <BR>
+  Prev: \ref cfsmmdg
+
+
 **/
 
 /**
@@ -482,6 +498,11 @@
   </TABLE>
 
   The following are telemetry packets generated by the CFS Memory Manager Application.
+
+  Next: \ref cfsmmtbl <BR>
+  Prev: \ref cfsmmcmds
+
+
 **/
 
 /**
@@ -494,6 +515,11 @@
   </TABLE>
 
   The CFS Memory Manager application does not utilize or manage any software tables.
+
+  Next: \ref cfsmmcfg <BR>
+  Prev: \ref cfsmmtlm
+
+
 **/
 
 /**
@@ -507,15 +533,27 @@
 
   The following are configuration parameters used to configure the CFS Memory Manager Application
   either for each platform or for a mission as a whole.
+
+  Next: \ref cfsmmcons <BR>
+  Prev: \ref cfsmmtbl
+
+
 **/
 
 /**
   \page cfsmmcons CFS Memory Manager Operational Constraints
 
-  No unique operational constraints have been identified for the MM application.
+  When loading memory from a file, it is the responsibility of the operators to
+  ensure that newly loaded symbol data fits within old symbol space.  There is
+  currently no ability in MM to unload a symbol and load it back or dynamically 
+  check for dependencies for the new code.  
+
+
+  The Dump Symbol Table to File command does not work on the Linux operating
+  system. 
 
   Next: \ref cfsmmfaqs <BR>
-  Prev: \ref cfsmmtbl
+  Prev: \ref cfsmmcfg
 **/
 
 /**
@@ -564,4 +602,4 @@
   </I>
 
   Prev: \ref cfsmmcons
-**/
+**/