Merge pull request #326 from nasa/integration-candidate

psp Integration candidate: Caelum-rc4+dev4
nasa · Feb 25, 2022 · 609e076 · 609e076
2 parents 9a1af6c + e8bd706
commit 609e076
Show file tree

Hide file tree

Showing 91 changed files with 246 additions and 258 deletions.
diff --git a/README.md b/README.md
@@ -9,6 +9,12 @@ This is a collection of APIs abstracting platform specific functionality to be l
 
 ## Version History
 
+### Development Build: v1.6.0-rc4+dev14
+
+- Remove explicit filename doxygen comments
+- Apply header guard standard
+- See <https://github.com/nasa/PSP/pull/326> and <https://github.com/nasa/cFS/pull/432>
+
 
 ### Development Build: v1.6.0-rc4+dev6
 

diff --git a/fsw/inc/cfe_psp.h b/fsw/inc/cfe_psp.h
@@ -19,8 +19,6 @@
 */
 
 /*
-**  File Name:  cfe_psp.h
-**
 **  Author:  A. Cudmore
 **
 **  Purpose:  This file contains the cFE Platform Support Package(PSP)
@@ -33,8 +31,8 @@
 **
 */
 
-#ifndef _cfe_psp_
-#define _cfe_psp_
+#ifndef CFE_PSP_H
+#define CFE_PSP_H
 
 /*
 ** Include Files
@@ -490,4 +488,4 @@ void CFE_PSP_GetVersionNumber(uint8 VersionNumbers[4]);
  */
 uint32 CFE_PSP_GetBuildNumber(void);
 
-#endif /* _cfe_psp_ */
+#endif
diff --git a/fsw/mcp750-vxworks/inc/cfe_psp_config.h b/fsw/mcp750-vxworks/inc/cfe_psp_config.h
@@ -18,13 +18,8 @@
 **  limitations under the License.
 */
 
-/*
-** cfe_psp_config.h
-**
-*/
-
-#ifndef _cfe_psp_config_
-#define _cfe_psp_config_
+#ifndef CFE_PSP_CONFIG_H
+#define CFE_PSP_CONFIG_H
 
 #include "common_types.h"
 

diff --git a/fsw/mcp750-vxworks/inc/psp_version.h b/fsw/mcp750-vxworks/inc/psp_version.h
@@ -18,18 +18,18 @@
 **  limitations under the License.
 */
 
-/*! @file mcp750-vxworks/inc/psp_version.h
+/*! @file
  *  @brief Purpose:
  *  @details Provide version identifiers for the cFE Platform Support Packages (PSP).
  *  See @ref cfsversions for version and build number and description
  */
-#ifndef _psp_version_
-#define _psp_version_
+#ifndef PSP_VERSION_H
+#define PSP_VERSION_H
 
 /*
  * Development Build Macro Definitions
  */
-#define CFE_PSP_IMPL_BUILD_NUMBER   4
+#define CFE_PSP_IMPL_BUILD_NUMBER   14
 #define CFE_PSP_IMPL_BUILD_BASELINE "v1.6.0-rc1"
 
 /*
@@ -70,4 +70,4 @@
     " PSP DEVELOPMENT BUILD " CFE_PSP_IMPL_VERSION \
     ", Last Official Release: psp v1.4.0" /* For full support please use this version */
 
-#endif /* _psp_version_ */
+#endif
diff --git a/fsw/modules/eeprom_mmap_file/cfe_psp_eeprom_mmap_file.c b/fsw/modules/eeprom_mmap_file/cfe_psp_eeprom_mmap_file.c
@@ -19,7 +19,7 @@
 */
 
 /**
- * \file cfe_psp_eeprom_mmap_file.c
+ * \file
  *
  *  Created on: Jul 17, 2015
  *      Author: joseph.p.hickey@nasa.gov

diff --git a/fsw/modules/eeprom_notimpl/cfe_psp_eeprom_notimpl.c b/fsw/modules/eeprom_notimpl/cfe_psp_eeprom_notimpl.c
@@ -19,7 +19,7 @@
 */
 
 /**
- * \file cfe_psp_eeprom_notimpl.c
+ * \file
  *
  * A PSP module to satisfy the "EEPROM" API on systems which
  * do not have an EEPROM or otherwise cannot access it.

diff --git a/fsw/modules/port_direct/cfe_psp_port_direct.c b/fsw/modules/port_direct/cfe_psp_port_direct.c
@@ -19,7 +19,7 @@
 */
 
 /**
- * \file cfe_psp_port_direct.c
+ * \file
  *
  * A PSP module to satisfy the "PORT" API on systems which
  * can access I/O ports directly via memory mapped addresses.

diff --git a/fsw/modules/port_notimpl/cfe_psp_port_notimpl.c b/fsw/modules/port_notimpl/cfe_psp_port_notimpl.c
@@ -19,7 +19,7 @@
 */
 
 /**
- * \file cfe_psp_port_notimpl.c
+ * \file
  *
  * A PSP module to satisfy the "Port" API on systems which
  * do not have or otherwise cannot access I/O ports.

diff --git a/fsw/modules/ram_direct/cfe_psp_ram_direct.c b/fsw/modules/ram_direct/cfe_psp_ram_direct.c
@@ -19,7 +19,7 @@
 */
 
 /**
- * \file cfe_psp_ram_direct.c
+ * \file
  *
  * A PSP module to satisfy the "RAM" API on systems which
  * can access physical memory directly.

diff --git a/fsw/modules/ram_notimpl/cfe_psp_ram_notimpl.c b/fsw/modules/ram_notimpl/cfe_psp_ram_notimpl.c
@@ -19,7 +19,7 @@
 */
 
 /**
- * \file cfe_psp_ram_notimpl.c
+ * \file
  *
  * A PSP module to satisfy the "RAM" API on systems which
  * cannot access physical memory directly.

diff --git a/fsw/modules/soft_timebase/cfe_psp_soft_timebase.c b/fsw/modules/soft_timebase/cfe_psp_soft_timebase.c
@@ -19,7 +19,7 @@
 */
 
 /**
- * \file cfe_psp_soft_timebase.c
+ * \file
  *
  * A PSP module that instantiates an RTOS-backed OSAL timebase to provide
  * various timing services.  This in turn may be used to drive CFE TIME 1Hz

diff --git a/fsw/modules/timebase_posix_clock/cfe_psp_timebase_posix_clock.c b/fsw/modules/timebase_posix_clock/cfe_psp_timebase_posix_clock.c
@@ -19,7 +19,7 @@
 */
 
 /**
- * \file cfe_psp_timebase_posix_clock.c
+ * \file
  *
  * A PSP module to satisfy the PSP time API on systems which
  * do not have a hardware clock register, but do provide a POSIX

diff --git a/fsw/modules/timebase_vxworks/cfe_psp_timebase_vxworks.c b/fsw/modules/timebase_vxworks/cfe_psp_timebase_vxworks.c
@@ -19,7 +19,7 @@
 */
 
 /**
- * \file cfe_psp_timebase_vxworks.c
+ * \file
  *
  * A PSP module to implement the PSP time API via the VxWorks
  * vxTimeBaseGet() routine.  The VxWorks timebase is a 64 bit

diff --git a/fsw/pc-linux/inc/cfe_psp_config.h b/fsw/pc-linux/inc/cfe_psp_config.h
@@ -18,12 +18,8 @@
 **  limitations under the License.
 */
 
-/*
-** cfe_psp_config.h
-*/
-
-#ifndef _cfe_psp_config_
-#define _cfe_psp_config_
+#ifndef CFE_PSP_CONFIG_H
+#define CFE_PSP_CONFIG_H
 
 #include "common_types.h"
 

diff --git a/fsw/pc-linux/inc/psp_version.h b/fsw/pc-linux/inc/psp_version.h
@@ -18,18 +18,18 @@
 **  limitations under the License.
 */
 
-/*! @file pc-linux/inc/psp_version.h
+/*! @file
  *  @brief Purpose:
  *  @details Provide version identifiers for the cFE Platform Support Packages (PSP).
  *  See @ref cfsversions for version and build number and description
  */
-#ifndef _psp_version_
-#define _psp_version_
+#ifndef PSP_VERSION_H
+#define PSP_VERSION_H
 
 /*
  * Development Build Macro Definitions
  */
-#define CFE_PSP_IMPL_BUILD_NUMBER   4
+#define CFE_PSP_IMPL_BUILD_NUMBER   14
 #define CFE_PSP_IMPL_BUILD_BASELINE "v1.6.0-rc1"
 
 /*
@@ -70,4 +70,4 @@
     " PSP DEVELOPMENT BUILD " CFE_PSP_IMPL_VERSION \
     ", Last Official Release: psp v1.4.0" /* For full support please use this version */
 
-#endif /* _psp_version_ */
+#endif
diff --git a/fsw/pc-rtems/inc/cfe_psp_config.h b/fsw/pc-rtems/inc/cfe_psp_config.h
@@ -18,13 +18,8 @@
 **  limitations under the License.
 */
 
-/*
-** cfe_psp_config.h
-**
-*/
-
-#ifndef _cfe_psp_config_
-#define _cfe_psp_config_
+#ifndef CFE_PSP_CONFIG_H
+#define CFE_PSP_CONFIG_H
 
 #include "common_types.h"
 #include <rtems.h>

diff --git a/fsw/pc-rtems/inc/psp_version.h b/fsw/pc-rtems/inc/psp_version.h
@@ -18,18 +18,18 @@
 **  limitations under the License.
 */
 
-/*! @file pc-rtems/inc/psp_version.h
+/*! @file
  *  @brief Purpose:
  *  @details Provide version identifiers for the cFE Platform Support Packages (PSP).
  *  See @ref cfsversions for version and build number and description
  */
-#ifndef _psp_version_
-#define _psp_version_
+#ifndef PSP_VERSION_H
+#define PSP_VERSION_H
 
 /*
  * Development Build Macro Definitions
  */
-#define CFE_PSP_IMPL_BUILD_NUMBER   4
+#define CFE_PSP_IMPL_BUILD_NUMBER   14
 #define CFE_PSP_IMPL_BUILD_BASELINE "v1.6.0-rc1"
 
 /*
@@ -70,4 +70,4 @@
     " PSP DEVELOPMENT BUILD " CFE_PSP_IMPL_VERSION \
     ", Last Official Release: psp v1.4.0" /* For full support please use this version */
 
-#endif /* _psp_version_ */
+#endif
diff --git a/fsw/shared/inc/cfe_psp_exceptionstorage_api.h b/fsw/shared/inc/cfe_psp_exceptionstorage_api.h
@@ -19,7 +19,7 @@
 */
 
 /**
- * \file cfe_psp_exceptionstorage_api.h
+ * \file
  *
  * Provides a generic storage buffer ring for exceptions
  */

diff --git a/fsw/shared/inc/cfe_psp_exceptionstorage_types.h b/fsw/shared/inc/cfe_psp_exceptionstorage_types.h
@@ -19,7 +19,7 @@
 */
 
 /**
- * \file cfe_psp_exceptionstorage_types.h
+ * \file
  *
  * Provides a generic storage buffer ring for exceptions
  */

diff --git a/fsw/shared/inc/cfe_psp_memory.h b/fsw/shared/inc/cfe_psp_memory.h
@@ -19,8 +19,6 @@
 */
 
 /*
-**  File Name:  cfe_psp_memory.h
-**
 **  Author:  A. Cudmore
 **
 **  Purpose:  This file contains PSP support routine internal prototypes
@@ -31,8 +29,8 @@
 **
 */
 
-#ifndef _cfe_psp_memory_
-#define _cfe_psp_memory_
+#ifndef CFE_PSP_MEMORY_H
+#define CFE_PSP_MEMORY_H
 
 /*
 ** Include Files
@@ -120,4 +118,4 @@ extern void CFE_PSP_DeleteProcessorReservedMemory(void);
 */
 extern CFE_PSP_ReservedMemoryMap_t CFE_PSP_ReservedMemoryMap;
 
-#endif /* _cfe_psp_memory_ */
+#endif
diff --git a/fsw/shared/inc/cfe_psp_module.h b/fsw/shared/inc/cfe_psp_module.h
@@ -19,7 +19,7 @@
 */
 
 /**
- * \file cfe_psp_module.h
+ * \file
  *
  *  Created on: Jul 17, 2015
  *      Author: joseph.p.hickey@nasa.gov

diff --git a/fsw/shared/src/cfe_psp_module.c b/fsw/shared/src/cfe_psp_module.c
@@ -19,7 +19,7 @@
 */
 
 /**
- * \file cfe_psp_module.c
+ * \file
  *
  *  Created on: Jul 25, 2014
  *      Author: jphickey

diff --git a/fsw/shared/src/cfe_psp_version.c b/fsw/shared/src/cfe_psp_version.c
@@ -19,7 +19,7 @@
 */
 
 /**
- * \file cfe_psp_version.c
+ * \file
  *
  * Defines API that obtains the values of the various version identifiers
  */

diff --git a/unit-test-coverage/mcp750-vxworks/adaptors/inc/ut-adaptor-bootrec.h b/unit-test-coverage/mcp750-vxworks/adaptors/inc/ut-adaptor-bootrec.h
@@ -11,19 +11,19 @@
  */
 
 /**
- * \file     ut-adaptor-bootrec.h
+ * \file
  * \ingroup  adaptors
  * \author   joseph.p.hickey@nasa.gov
  *
  */
 
-#ifndef INCLUDE_UT_ADAPTOR_BOOTREC_H_
-#define INCLUDE_UT_ADAPTOR_BOOTREC_H_
+#ifndef UT_ADAPTOR_BOOTREC_H
+#define UT_ADAPTOR_BOOTREC_H
 
 #include "common_types.h"
 
 void   UT_Setup_ReservedMem_BootRec(void);
 uint32 UT_Get_ReservedMem_BootType(void);
 void   UT_Set_ReservedMem_BootType(uint32 reset_type);
 
-#endif /* INCLUDE_UT_ADAPTOR_BOOTREC_H_ */
+#endif
diff --git a/unit-test-coverage/mcp750-vxworks/adaptors/src/ut-adaptor-bootrec.c b/unit-test-coverage/mcp750-vxworks/adaptors/src/ut-adaptor-bootrec.c
@@ -11,7 +11,7 @@
  */
 
 /**
- * \file     ut-adaptor-bootrec.c
+ * \file
  * \ingroup  adaptors
  * \author   joseph.p.hickey@nasa.gov
  *

diff --git a/unit-test-coverage/mcp750-vxworks/src/coveragetest-cfe-psp-start.c b/unit-test-coverage/mcp750-vxworks/src/coveragetest-cfe-psp-start.c
@@ -11,7 +11,7 @@
  */
 
 /**
- * \file     coveragetest-binsem.c
+ * \file
  * \ingroup  vxworks
  * \author   joseph.p.hickey@nasa.gov
  *

diff --git a/unit-test-coverage/mcp750-vxworks/src/coveragetest-cfe-psp-support.c b/unit-test-coverage/mcp750-vxworks/src/coveragetest-cfe-psp-support.c
@@ -11,7 +11,7 @@
  */
 
 /**
- * \file     coveragetest-binsem.c
+ * \file
  * \ingroup  vxworks
  * \author   joseph.p.hickey@nasa.gov
  *

diff --git a/unit-test-coverage/mcp750-vxworks/src/coveragetest-psp-mcp750-vxworks.c b/unit-test-coverage/mcp750-vxworks/src/coveragetest-psp-mcp750-vxworks.c
@@ -11,7 +11,7 @@
  */
 
 /**
- * \file     coveragetest-binsem.c
+ * \file
  * \ingroup  vxworks
  * \author   joseph.p.hickey@nasa.gov
  *
-Original file line number
+Diff line change
@@ Expand Up / @@ -19,7 +19,7 @@ @@
     */
     /**
-     * \file cfe_psp_eeprom_mmap_file.c
+     * \file
      *
      *  Created on: Jul 17, 2015
      *      Author: joseph.p.hickey@nasa.gov
@@ Expand Down @@