Merge pull request nasa#919 from CDKnightNASA/fix-888-return_code

Fix nasa#888, Add typedef for function return status codes
jphickey · Oct 2, 2020 · 5d5cfac · 5d5cfac
2 parents 7e755c3 + 3715b61
commit 5d5cfac
Show file tree

Hide file tree

Showing 8 changed files with 153 additions and 161 deletions.
diff --git a/fsw/cfe-core/src/inc/cfe_error.h b/fsw/cfe-core/src/inc/cfe_error.h
@@ -42,6 +42,12 @@
 /* Include Files */
 #include "osapi.h"
 
+/*
+ * Define a type for readability.
+ */
+
+typedef int32 CFE_Status_t;
+
 /*
 **  Status Codes are 32 bit values formatted as follows:
 **

diff --git a/fsw/cfe-core/src/inc/cfe_es.h b/fsw/cfe-core/src/inc/cfe_es.h
diff --git a/fsw/cfe-core/src/inc/cfe_evs.h b/fsw/cfe-core/src/inc/cfe_evs.h
@@ -37,6 +37,7 @@
 
 /********************************** Include Files  ************************************/
 #include "cfe_evs_extern_typedefs.h"
+#include "cfe_error.h"
 #include "common_types.h"    /* Basic data types */
 #include "cfe_time.h"        /* Time library function definitions */
 #include "cfe_evs_msg.h"        /* EVS command codes and data structures*/
@@ -139,7 +140,7 @@ typedef struct CFE_EVS_BinFilter {
 ** \sa #CFE_EVS_Unregister
 **
 **/
-int32 CFE_EVS_Register (void                 *Filters,           /* Pointer to an array of filters */
+CFE_Status_t CFE_EVS_Register (void              *Filters,           /* Pointer to an array of filters */
                         uint16               NumFilteredEvents,  /* How many elements in the array? */
                         uint16               FilterScheme);      /* Filtering Algorithm to be implemented */
 
@@ -163,7 +164,7 @@ int32 CFE_EVS_Register (void                 *Filters,           /* Pointer to a
 ** \sa #CFE_EVS_Register
 **
 **/
-int32 CFE_EVS_Unregister( void );
+CFE_Status_t CFE_EVS_Unregister( void );
 /**@}*/
 
 /** @defgroup CFEAPIEVSSend cFE Send Event APIs
@@ -212,9 +213,9 @@ int32 CFE_EVS_Unregister( void );
 ** \sa #CFE_EVS_SendEventWithAppID, #CFE_EVS_SendTimedEvent
 **
 **/
-int32 CFE_EVS_SendEvent (uint16 EventID,
-                         uint16 EventType,
-                         const char *Spec, ... )  OS_PRINTF(3,4);
+CFE_Status_t CFE_EVS_SendEvent (uint16 EventID,
+                            uint16 EventType,
+                            const char *Spec, ... )  OS_PRINTF(3,4);
 
 
 /** 
@@ -263,10 +264,10 @@ int32 CFE_EVS_SendEvent (uint16 EventID,
 ** \sa #CFE_EVS_SendEvent, #CFE_EVS_SendTimedEvent
 **
 **/
-int32 CFE_EVS_SendEventWithAppID (uint16 EventID,
-                                  uint16 EventType,
-                                  CFE_ES_ResourceID_t AppID,
-                                  const char *Spec, ... ) OS_PRINTF(4,5);
+CFE_Status_t CFE_EVS_SendEventWithAppID (uint16 EventID,
+                                         uint16 EventType,
+                                         CFE_ES_ResourceID_t AppID,
+                                         const char *Spec, ... ) OS_PRINTF(4,5);
 
 
 /** 
@@ -315,10 +316,10 @@ int32 CFE_EVS_SendEventWithAppID (uint16 EventID,
 ** \sa #CFE_EVS_SendEvent, #CFE_EVS_SendEventWithAppID
 **
 **/
-int32 CFE_EVS_SendTimedEvent (CFE_TIME_SysTime_t Time,
-                              uint16 EventID,
-                              uint16 EventType,
-                              const char *Spec, ... ) OS_PRINTF(4,5);
+CFE_Status_t CFE_EVS_SendTimedEvent (CFE_TIME_SysTime_t Time,
+                                 uint16 EventID,
+                                 uint16 EventType,
+                                 const char *Spec, ... ) OS_PRINTF(4,5);
 /**@}*/
 
 /** @defgroup CFEAPIEVSResetFilter cFE Reset Event Filter APIs
@@ -346,7 +347,7 @@ int32 CFE_EVS_SendTimedEvent (CFE_TIME_SysTime_t Time,
 ** \sa #CFE_EVS_ResetAllFilters
 **
 **/
-int32 CFE_EVS_ResetFilter (int16 EventID);
+CFE_Status_t CFE_EVS_ResetFilter (int16 EventID);
 
 
 /** 
@@ -367,7 +368,7 @@ int32 CFE_EVS_ResetFilter (int16 EventID);
 ** \sa #CFE_EVS_ResetFilter
 **
 **/
-int32 CFE_EVS_ResetAllFilters ( void );
+CFE_Status_t CFE_EVS_ResetAllFilters ( void );
 /**@}*/
 
 

diff --git a/fsw/cfe-core/src/inc/cfe_fs.h b/fsw/cfe-core/src/inc/cfe_fs.h
@@ -38,6 +38,7 @@
 ** Required header files...
 */
 #include "cfe_fs_extern_typedefs.h"
+#include "cfe_error.h"
 #include "common_types.h"
 #include "cfe_time.h"
 
@@ -70,7 +71,7 @@
 ** \sa #CFE_FS_WriteHeader
 **
 ******************************************************************************/
-int32 CFE_FS_ReadHeader(CFE_FS_Header_t *Hdr, osal_id_t FileDes);
+CFE_Status_t CFE_FS_ReadHeader(CFE_FS_Header_t *Hdr, osal_id_t FileDes);
 
 /*****************************************************************************/
 /**
@@ -128,7 +129,7 @@ void CFE_FS_InitHeader(CFE_FS_Header_t *Hdr, const char *Description, uint32 Sub
 ** \sa #CFE_FS_ReadHeader
 **
 ******************************************************************************/
-int32 CFE_FS_WriteHeader(osal_id_t FileDes, CFE_FS_Header_t *Hdr);
+CFE_Status_t CFE_FS_WriteHeader(osal_id_t FileDes, CFE_FS_Header_t *Hdr);
 
 /*****************************************************************************/
 /**
@@ -153,7 +154,7 @@ int32 CFE_FS_WriteHeader(osal_id_t FileDes, CFE_FS_Header_t *Hdr);
 ** \return Execution status, see \ref CFEReturnCodes
 **               
 ******************************************************************************/
-int32 CFE_FS_SetTimestamp(osal_id_t FileDes, CFE_TIME_SysTime_t NewTimestamp);
+CFE_Status_t CFE_FS_SetTimestamp(osal_id_t FileDes, CFE_TIME_SysTime_t NewTimestamp);
 /**@}*/
 
 
@@ -181,7 +182,7 @@ int32 CFE_FS_SetTimestamp(osal_id_t FileDes, CFE_TIME_SysTime_t NewTimestamp);
 ** \return Execution status, see \ref CFEReturnCodes
 **
 ******************************************************************************/
-int32 CFE_FS_ExtractFilenameFromPath(const char *OriginalPath, char *FileNameOnly);
+CFE_Status_t CFE_FS_ExtractFilenameFromPath(const char *OriginalPath, char *FileNameOnly);
 /**@}*/
 
 #endif /* _cfe_fs_ */