Skip to content

Commit

Permalink
Fix #1032, Send->Write name update for SB write cmds
Browse files Browse the repository at this point in the history
  • Loading branch information
skliper committed Jan 22, 2021
1 parent c7363c8 commit 84dd36d
Show file tree
Hide file tree
Showing 6 changed files with 172 additions and 219 deletions.
2 changes: 1 addition & 1 deletion docs/src/cfe_sb.dox
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@
The Pipe IDs are specific to a particular processor (that is, the same ID number
may refer to a different pipe on each processor). The pipe information for all
pipes that have been created, may be requested at anytime by sending the
\link #CFE_SB_SEND_PIPE_INFO_CC 'Send Pipe Info' SB command \endlink. The software
\link #CFE_SB_WRITE_PIPE_INFO_CC 'Write Pipe Info' SB command \endlink. The software
bus also provides a set of figures regarding capacity, current utilization and high
water marks relevant to pipes. This information may be requested by sending the
command to \link #CFE_SB_SEND_SB_STATS_CC dump the SB statistics packet \endlink.
Expand Down
6 changes: 3 additions & 3 deletions fsw/cfe-core/src/inc/cfe_fs_extern_typedefs.h
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ enum CFE_FS_SubType
*
*
* Software Bus Pipe Data Dump File which is generated in response to a
* \link #CFE_SB_SEND_PIPE_INFO_CC \SB_WRITEPIPE2FILE \endlink
* \link #CFE_SB_WRITE_PIPE_INFO_CC \SB_WRITEPIPE2FILE \endlink
* command.
*
*/
Expand All @@ -178,7 +178,7 @@ enum CFE_FS_SubType
*
*
* Software Bus Message Routing Data Dump File which is generated in response to a
* \link #CFE_SB_SEND_ROUTING_INFO_CC \SB_WRITEROUTING2FILE \endlink
* \link #CFE_SB_WRITE_ROUTING_INFO_CC \SB_WRITEROUTING2FILE \endlink
* command.
*
*/
Expand All @@ -189,7 +189,7 @@ enum CFE_FS_SubType
*
*
* Software Bus Message Mapping Data Dump File which is generated in response to a
* \link #CFE_SB_SEND_MAP_INFO_CC \SB_WRITEMAP2FILE \endlink
* \link #CFE_SB_WRITE_MAP_INFO_CC \SB_WRITEMAP2FILE \endlink
* command.
*
*/
Expand Down
41 changes: 14 additions & 27 deletions fsw/cfe-core/src/inc/cfe_sb_msg.h
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@
** \cfecmdmnemonic \SB_WRITEROUTING2FILE
**
** \par Command Structure
** #CFE_SB_SendRoutingInfoCmd_t
** #CFE_SB_WriteRoutingInfoCmd_t
**
** \par Command Verification
** Successful execution of this command may be verified with the
Expand All @@ -188,10 +188,8 @@
** This command is not inherently dangerous. It will create a new
** file in the file system and could, if performed repeatedly without
** sufficient file management by the operator, fill the file system.
**
** \sa #CFE_SB_SEND_PIPE_INFO_CC, #CFE_SB_SEND_MAP_INFO_CC, #CFE_SB_WriteFileInfoCmd_t
*/
#define CFE_SB_SEND_ROUTING_INFO_CC 3
#define CFE_SB_WRITE_ROUTING_INFO_CC 3

/** \cfesbcmd Enable Software Bus Route
**
Expand All @@ -211,7 +209,7 @@
** Successful execution of this command may be verified with the
** following telemetry:
** - \b \c \SB_CMDPC - command execution counter will increment
** - View routing information #CFE_SB_SEND_ROUTING_INFO_CC to verify
** - View routing information #CFE_SB_WRITE_ROUTING_INFO_CC to verify
** enable/disable state change
** - The #CFE_SB_ENBL_RTE2_EID debug event message will be generated. All
** debug events are filtered by default.
Expand All @@ -228,8 +226,6 @@
**
** \par Criticality
** This command is not inherently dangerous.
**
** \sa #CFE_SB_SEND_ROUTING_INFO_CC, #CFE_SB_DISABLE_ROUTE_CC, #CFE_SB_RouteCmd_t
*/
#define CFE_SB_ENABLE_ROUTE_CC 4

Expand All @@ -249,7 +245,7 @@
** Successful execution of this command may be verified with the
** following telemetry:
** - \b \c \SB_CMDPC - command execution counter will increment
** - View routing information #CFE_SB_SEND_ROUTING_INFO_CC to verify
** - View routing information #CFE_SB_WRITE_ROUTING_INFO_CC to verify
** enable/disable state change
** - The #CFE_SB_DSBL_RTE2_EID debug event message will be generated. All
** debug events are filtered by default.
Expand All @@ -271,8 +267,6 @@
** with #CFE_SB_CMD_MID and the SB_Cmd_Pipe would inhibit any ground
** commanding to the software bus until the processor was reset. There
** are similar problems that may occur when using this command.
**
** \sa #CFE_SB_SEND_ROUTING_INFO_CC, #CFE_SB_ENABLE_ROUTE_CC, #CFE_SB_RouteCmd_t
*/
#define CFE_SB_DISABLE_ROUTE_CC 5

Expand All @@ -291,7 +285,7 @@
** \cfecmdmnemonic \SB_WRITEPIPE2FILE
**
** \par Command Structure
** #CFE_SB_SendPipeInfoCmd_t
** #CFE_SB_WritePipeInfoCmd_t
**
** \par Command Verification
** Successful execution of this command may be verified with the
Expand All @@ -315,10 +309,8 @@
** This command is not inherently dangerous. It will create a new
** file in the file system and could, if performed repeatedly without
** sufficient file management by the operator, fill the file system.
**
** \sa #CFE_SB_SEND_ROUTING_INFO_CC, #CFE_SB_SEND_MAP_INFO_CC
*/
#define CFE_SB_SEND_PIPE_INFO_CC 7
#define CFE_SB_WRITE_PIPE_INFO_CC 7

/** \cfesbcmd Write Map Info to a File
**
Expand All @@ -336,7 +328,7 @@
** \cfecmdmnemonic \SB_WRITEMAP2FILE
**
** \par Command Structure
** #CFE_SB_SendMapInfoCmd_t
** #CFE_SB_WriteMapInfoCmd_t
**
** \par Command Verification
** Successful execution of this command may be verified with the
Expand All @@ -360,10 +352,8 @@
** This command is not inherently dangerous. It will create a new
** file in the file system and could, if performed repeatedly without
** sufficient file management by the operator, fill the file system.
**
** \sa #CFE_SB_SEND_ROUTING_INFO_CC, #CFE_SB_SEND_PIPE_INFO_CC
*/
#define CFE_SB_SEND_MAP_INFO_CC 8
#define CFE_SB_WRITE_MAP_INFO_CC 8

/** \cfesbcmd Enable Subscription Reporting Command
**
Expand Down Expand Up @@ -486,10 +476,7 @@ typedef CFE_MSG_CommandHeader_t CFE_SB_SendPrevSubsCmd_t;
/**
** \brief Write File Info Command Payload
**
** This structure contains a generic definition used by three SB commands,
** 'Write Routing Info to File' #CFE_SB_SEND_ROUTING_INFO_CC,
** 'Write Pipe Info to File' #CFE_SB_SEND_PIPE_INFO_CC and
** 'Write Map Info to File' #CFE_SB_SEND_MAP_INFO_CC.
** This structure contains a generic definition used by SB commands that write to a file
*/
typedef struct CFE_SB_WriteFileInfoCmd_Payload {
char Filename[CFE_MISSION_MAX_PATH_LEN];/**< \brief Path and Filename of data to be loaded */
Expand All @@ -506,9 +493,9 @@ typedef struct CFE_SB_WriteFileInfoCmd {
/*
* Create a unique typedef for each of the commands that share this format.
*/
typedef CFE_SB_WriteFileInfoCmd_t CFE_SB_SendRoutingInfoCmd_t;
typedef CFE_SB_WriteFileInfoCmd_t CFE_SB_SendPipeInfoCmd_t;
typedef CFE_SB_WriteFileInfoCmd_t CFE_SB_SendMapInfoCmd_t;
typedef CFE_SB_WriteFileInfoCmd_t CFE_SB_WriteRoutingInfoCmd_t;
typedef CFE_SB_WriteFileInfoCmd_t CFE_SB_WritePipeInfoCmd_t;
typedef CFE_SB_WriteFileInfoCmd_t CFE_SB_WriteMapInfoCmd_t;

/**
** \brief Enable/Disable Route Command Payload
Expand Down Expand Up @@ -671,7 +658,7 @@ typedef struct CFE_SB_StatsTlm {
/**
** \brief SB Routing File Entry
**
** Structure of one element of the routing information in response to #CFE_SB_SEND_ROUTING_INFO_CC
** Structure of one element of the routing information in response to #CFE_SB_WRITE_ROUTING_INFO_CC
*/
typedef struct CFE_SB_RoutingFileEntry {
CFE_SB_MsgId_t MsgId;/**< \brief Message Id portion of the route */
Expand All @@ -686,7 +673,7 @@ typedef struct CFE_SB_RoutingFileEntry {
/**
** \brief SB Map File Entry
**
** Structure of one element of the map information in response to #CFE_SB_SEND_MAP_INFO_CC
** Structure of one element of the map information in response to #CFE_SB_WRITE_MAP_INFO_CC
*/
typedef struct CFE_SB_MsgMapFileEntry {
CFE_SB_MsgId_t MsgId;/**< \brief Message Id which has been subscribed to */
Expand Down
12 changes: 6 additions & 6 deletions fsw/cfe-core/src/sb/cfe_sb_priv.h
Original file line number Diff line number Diff line change
Expand Up @@ -272,9 +272,9 @@ int32 CFE_SB_TransmitMsgValidate(CFE_MSG_Message_t *MsgPtr,
CFE_SB_MsgId_t *MsgIdPtr,
CFE_MSG_Size_t *SizePtr,
CFE_SBR_RouteId_t *RouteIdPtr);
int32 CFE_SB_SendRtgInfo(const char *Filename);
int32 CFE_SB_SendPipeInfo(const char *Filename);
int32 CFE_SB_SendMapInfo(const char *Filename);
int32 CFE_SB_WriteRtgInfo(const char *Filename);
int32 CFE_SB_WritePipeInfo(const char *Filename);
int32 CFE_SB_WriteMapInfo(const char *Filename);
int32 CFE_SB_ZeroCopyReleaseDesc(CFE_SB_Buffer_t *Ptr2Release, CFE_SB_ZeroCopyHandle_t BufferHandle);
int32 CFE_SB_ZeroCopyReleaseAppId(CFE_ES_ResourceID_t AppId);
int32 CFE_SB_DecrBufUseCnt(CFE_SB_BufferD_t *bd);
Expand Down Expand Up @@ -375,9 +375,9 @@ int32 CFE_SB_SendHKTlmCmd(const CFE_MSG_CommandHeader_t *data);
int32 CFE_SB_EnableRouteCmd(const CFE_SB_EnableRouteCmd_t *data);
int32 CFE_SB_DisableRouteCmd(const CFE_SB_DisableRouteCmd_t *data);
int32 CFE_SB_SendStatsCmd(const CFE_SB_SendSbStatsCmd_t *data);
int32 CFE_SB_SendRoutingInfoCmd(const CFE_SB_SendRoutingInfoCmd_t *data);
int32 CFE_SB_SendPipeInfoCmd(const CFE_SB_SendPipeInfoCmd_t *data);
int32 CFE_SB_SendMapInfoCmd(const CFE_SB_SendMapInfoCmd_t *data);
int32 CFE_SB_WriteRoutingInfoCmd(const CFE_SB_WriteRoutingInfoCmd_t *data);
int32 CFE_SB_WritePipeInfoCmd(const CFE_SB_WritePipeInfoCmd_t *data);
int32 CFE_SB_WriteMapInfoCmd(const CFE_SB_WriteMapInfoCmd_t *data);
int32 CFE_SB_SendPrevSubsCmd(const CFE_SB_SendPrevSubsCmd_t *data);


Expand Down
Loading

0 comments on commit 84dd36d

Please sign in to comment.