FM v2.5.3 release

nasa · Jun 26, 2020 · b3ea3d1 · b3ea3d1
1 parent a1ebbc8
commit b3ea3d1
Show file tree

Hide file tree

Showing 39 changed files with 4,322 additions and 1,613 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -9,3 +9,7 @@ aux_source_directory(fsw/src APP_SRC_FILES)
 
 # Create the app module
 add_cfe_app(fm ${APP_SRC_FILES})
+
+include_directories(fsw/src)
+aux_source_directory(fsw/tables APP_TABLE_FILES)
+add_cfe_tables(fm ${APP_TABLE_FILES})
diff --git a/GSC-18475-1_Apache_2_0_license_.pdf b/GSC-18475-1_Apache_2_0_license_.pdf
diff --git a/README.md b/README.md
@@ -1,17 +1,61 @@
-# File Manager
-
-NASA core Flight System File Manager Application
-
-## Description
-
-The File Manager application (FM) is a core Flight System (cFS) application that is a plug in to the Core Flight Executive (cFE) component of the 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](http://cfs.gsfc.nasa.gov)
-
-The FM application provides onboard file system management services by processing ground commands for copying, moving, and renaming files, decompressing files, creating directories, deleting files and directories, providing file and directory informational telemetry messages, and providing open file and directory listings.
-
-FM requires use of the [cFS application library](https://github.com/nasa/cfs_lib).
-
-## License
-
-This software is licensed under the NASA Open Source Agreement. http://ti.arc.nasa.gov/opensource/nosa
+core Flight System (cFS) File Manager Application (FM) 
+======================================================
+
+Open Source Release Readme
+==========================
+
+FM Release 2.5.3
+
+Date: 
+3/19/2020
+
+Introduction
+---------------
+
+  The File Manager application (FM) is a core Flight System (cFS) application 
+  that is a plug-in to the Core Flight Executive (cFE) component of the cFS.  
+
+  The FM application provides onboard file system management services by 
+  processing ground commands for copying, moving, and renaming files, 
+  decompressing files, creating directories, deleting files and directories, 
+  providing file and directory informational telemetry messages, and providing 
+  open file and directory listings.
+
+  The FM application is written in C and depends on the cFS Operating System 
+  Abstraction Layer (OSAL) and cFE components. There is additional FM application 
+  specific configuration information contained in the application user's guide
+  available in https://github.com/nasa/FM/tree/master/docs/users_guide
+
+  This software is licensed under the NASA Open Source Agreement. 
+  http://ti.arc.nasa.gov/opensource/nosa
+
+
+Software Included
+--------------------
+
+  File Manager application (FM) 2.5.3
+
+
+Software Required
+--------------------
+
+  Operating System Abstraction Layer 5.0 or higher can be 
+  obtained at https://github.com/nasa/osal
+
+  core Flight Executive 6.7.0 or higher can be obtained at
+  https://github.com/nasa/cfe
+
+  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                       
diff --git a/cfs-fm-app-OSS-readme.txt b/cfs-fm-app-OSS-readme.txt
diff --git a/docs/FM_v2.5.3_VersionDescriptionDocument.pdf b/docs/FM_v2.5.3_VersionDescriptionDocument.pdf
diff --git a/docs/dox_src/users_guide/cfs_fm.dox b/docs/dox_src/users_guide/cfs_fm.dox
@@ -44,11 +44,17 @@
 
   <H1> Scope </H1>
 
-  This document provides a complete specification for the commands and telemetry associated
-  with the CFS File Manager (FM) 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 
-  configuring the FM application software for a mission flight software build environment. 
+  This Doxygen-based User's Guide provides a complete reference for the
+  cFS File Manager (FM) application.  The Guide is intended primarily for
+  users of the software (operations personnel, test engineers, and 
+  maintenance personnel) who prefer a developer-focused document and direct
+  references to the source code.  The "deployment guide" section is intended
+  for mission developers when deploying and configuring the FM application 
+  software for a mission flight software build environment.
+
+  A separate user's guide for non-developers integrates information from this 
+  guide with other items, such as flow charts and heritage information, into 
+  a single document. 
 
   <H1> Applicable Documents </H1>
 
@@ -103,7 +109,7 @@
   <TR><TD WIDTH="20%"> TBD     </TD> <TD WIDTH="40%"> To Be Determined                                </TD>
   <TR><TD WIDTH="20%"> TBL     </TD> <TD WIDTH="40%"> Table                                           </TD>
   <TR><TD WIDTH="20%"> TLM     </TD> <TD WIDTH="40%"> Telemetry                                       </TD>
-  <TR><TD WIDTH="20%"> UTC     </TD> <TD WIDTH="40%"> Universal time code                             </TD>
+  <TR><TD WIDTH="20%"> UTC     </TD> <TD WIDTH="40%"> Coordinated Universal Time                      </TD>
   </TABLE>
 
   Next: \ref cfsfmovr <BR>
@@ -127,7 +133,8 @@
   processing ground commands.  The FM application interfaces with the 
   <A HREF="../sch/index.html">Scheduler (SCH) Application</A> for 
   receiving periodic housekeeping requests.  Upon receipt of a housekeeping request, FM will send its 
-  housekeeping telemetry packets on the Software Bus.  Housekeeping telemetry packets are subscribed to 
+  housekeeping telemetry packets on the Software Bus.  Housekeeping telemetry
+  packets are typically subscribed to 
   by the Housekeeping (HK), Telemetry Output (TO), and Data Storage applications.  See page 
   \ref cfsfmtlm for a detailed description of the contents of the FM housekeeping telemetry packet. <BR>
 
@@ -154,9 +161,10 @@
   The CFS FM application is a command and telemetry driven application.  FM waits in a command loop 
   infinitely until the software receives a scheduled housekeeping request, ground command, or stored 
   command.  Command packets (including housekeeping requests) are processed as they are received.  The 
-  application sends an FM housekeeping telemetry message to the ground upon receipt of a scheduled 
+  application sends an FM housekeeping telemetry message on the cFE Software Bus upon receipt of a scheduled 
   housekeeping request produced by the SCH application.  This request is typically performed every 
-  4-5 seconds. <BR>  
+  4-5 seconds and these housekeeping messages are usually sent to the ground
+  (though this depends on the configuration of the rest of the system). <BR>  
 
   Various FM ground commands produce telemetry messages as a result of processing the command.  These 
   telemetry messages include a directory listing telemetry message, file information telemetry message, 
@@ -273,7 +281,7 @@
 
   The table contains #FM_TABLE_ENTRY_COUNT entries of the following structure:<BR>
       <ul><li>State - An integer value ranging from 0 to 2 indicating the state of this entry. The values correspond to "Unused", "Enabled", and "Disabled" <BR>
-      <li>Name  - The full path specification of the file system. I.e., "/ram"
+      <li>Name  - The full path specification of the file system. E.g., "/ram"
       </ul>
 **/
 

diff --git a/fsw/mission_inc/fm_perfids.h b/fsw/mission_inc/fm_perfids.h
@@ -1,14 +1,23 @@
 /*
-** $Id: fm_perfids.h 1.2.1.2 2017/01/23 21:53:06EST sstrege Exp  $
+** Filename: fm_perfids.h
 **
-**  Copyright (c) 2007-2014 United States Government as represented by the 
-**  Administrator of the National Aeronautics and Space Administration. 
-**  All Other Rights Reserved.  
+** NASA Docket No. GSC-18,475-1, identified as “Core Flight Software System (CFS)
+** File Manager Application Version 2.5.3
 **
-**  This software was created at NASA's Goddard Space Flight Center.
-**  This software is governed by the NASA Open Source Agreement and may be 
-**  used, distributed and modified only pursuant to the terms of that 
-**  agreement.
+** Copyright © 2020 United States Government as represented by the Administrator of
+** the National Aeronautics and Space Administration. All Rights Reserved. 
+**
+** Licensed under the Apache License, Version 2.0 (the "License"); 
+** you may not use this file except in compliance with the License. 
+**  
+** You may obtain a copy of the License at 
+** http://www.apache.org/licenses/LICENSE-2.0 
+**
+** Unless required by applicable law or agreed to in writing, software 
+** distributed under the License is distributed on an "AS IS" BASIS, 
+** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
+** See the License for the specific language governing permissions and 
+** limitations under the License. 
 **
 ** Title: CFS File Manager (FM) Application Performance IDs
 **

diff --git a/fsw/platform_inc/fm_msgids.h b/fsw/platform_inc/fm_msgids.h
@@ -1,22 +1,29 @@
 /*
-** $Id: fm_msgids.h 1.2.1.2 2017/01/23 21:53:14EST sstrege Exp  $
+** Filename: fm_msgids.h 
 **
-**  Copyright (c) 2007-2014 United States Government as represented by the 
-**  Administrator of the National Aeronautics and Space Administration. 
-**  All Other Rights Reserved.  
+** NASA Docket No. GSC-18,475-1, identified as “Core Flight Software System (CFS)
+** File Manager Application Version 2.5.3
 **
-**  This software was created at NASA's Goddard Space Flight Center.
-**  This software is governed by the NASA Open Source Agreement and may be 
-**  used, distributed and modified only pursuant to the terms of that 
-**  agreement.
+** Copyright © 2020 United States Government as represented by the Administrator of
+** the National Aeronautics and Space Administration. All Rights Reserved. 
+**
+** Licensed under the Apache License, Version 2.0 (the "License"); 
+** you may not use this file except in compliance with the License. 
+**  
+** You may obtain a copy of the License at 
+** http://www.apache.org/licenses/LICENSE-2.0 
+**
+** Unless required by applicable law or agreed to in writing, software 
+** distributed under the License is distributed on an "AS IS" BASIS, 
+** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
+** See the License for the specific language governing permissions and 
+** limitations under the License. 
 **
 ** Title: File Manager (FM) Message ID Header File
 **
 ** Purpose: Specification for the CFS FM application software bus
 **          message identifiers
 **
-** Author: Susanne L. Strege, Code 582 NASA GSFC
-**
 ** Notes:
 **
 ** References: