Skip to content

Commit

Permalink
Post CCB review changes, Add new title for MOVEFILES variable
Browse files Browse the repository at this point in the history
  • Loading branch information
jdfiguer authored and jdfiguer committed Feb 29, 2024
1 parent 621a2fa commit e9124f2
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 31 deletions.
8 changes: 3 additions & 5 deletions docs/dox_src/cfs_ds.dox
Original file line number Diff line number Diff line change
Expand Up @@ -147,12 +147,10 @@
the platform.

<h2>Move File Capability</h2>
If the DS_MOVE_FILES configuration parameter is set to a non-empty string, the telemetry
If the DS_MOVEFILES_DESTDIR configuration parameter is set to a non-empty string, the telemetry
database, Destination File table load images and the File Table display page
require changes. The Destination File Table rdl file uses the DS_MOVE_FILES
definition in the ds_platform_cfg.h file. However, in order to get the
required parameter included in telemetry, this configuration parameter must be
set to 1 rather than TRUE. The table images must include this parameter in
require changes. The Destination File Table rdl file uses the DS_MOVEFILES_DESTDIR
definition in the ds_platform_cfg.h file. The table images must include this parameter in
order to load successfully and the display page must be modified to display
this parameter.
**/
Expand Down
34 changes: 17 additions & 17 deletions fsw/inc/ds_platform_cfg.h
Original file line number Diff line number Diff line change
Expand Up @@ -427,6 +427,22 @@
*/
#define DS_FILE_HEADER_TYPE 1

/**
* \brief Application Per Packet Pipe Limit
*
* \par Description:
* This parameter defines the per packet pipe limit. This is
* the max number of packets with the same Message ID that may
* be in the DS input pipe at any one time. This value should
* be large enough to accommodate a burst of packets (usually
* event packets) plus a suitable margin.
*
* \par Limits:
* The value must be greater than zero and cannot exceed the
* definition of #DS_APP_PIPE_DEPTH.
*/
#define DS_PER_PACKET_PIPE_LIMIT 45

/**
* \brief Move Files to Downlink Directory After Close Selection
*
Expand All @@ -444,23 +460,7 @@
* non-empty string = add move pathname field to Destination File Table
* empty string = do not add move pathname to Destination File Table
*/
#define DS_MOVE_FILES "Move to downlink directory"

/**
* \brief Application Per Packet Pipe Limit
*
* \par Description:
* This parameter defines the per packet pipe limit. This is
* the max number of packets with the same Message ID that may
* be in the DS input pipe at any one time. This value should
* be large enough to accommodate a burst of packets (usually
* event packets) plus a suitable margin.
*
* \par Limits:
* The value must be greater than zero and cannot exceed the
* definition of #DS_APP_PIPE_DEPTH.
*/
#define DS_PER_PACKET_PIPE_LIMIT 45
#define DS_MOVEFILES_DESTDIR "Move to downlink directory"

/**\}*/

Expand Down
2 changes: 1 addition & 1 deletion fsw/src/ds_file.c
Original file line number Diff line number Diff line change
Expand Up @@ -811,7 +811,7 @@ void DS_FileCloseDest(int32 FileIndex)
*/
OS_close(FileStatus->FileHandle);

if (strlen(DS_MOVE_FILES) > 0)
if (strlen(DS_MOVEFILES_DESTDIR) > 0)
{
/*
** Move file only if table has a downlink directory name...
Expand Down
8 changes: 4 additions & 4 deletions fsw/src/ds_verify.h
Original file line number Diff line number Diff line change
Expand Up @@ -190,10 +190,6 @@
#error DS_FILE_HEADER_TYPE must be 0 or 1!
#endif

#ifndef DS_MOVE_FILES
#error "DS_MOVE_FILES must be defined!"
#endif

#ifndef DS_PER_PACKET_PIPE_LIMIT
#error DS_PER_PACKET_PIPE_LIMIT must be defined!
#elif (DS_PER_PACKET_PIPE_LIMIT < 1)
Expand All @@ -202,4 +198,8 @@
#error DS_PER_PACKET_PIPE_LIMIT cannot be greater than DS_APP_PIPE_DEPTH!
#endif

#ifndef DS_MOVEFILES_DESTDIR
#error "DS_MOVEFILES_DESTDIR must be defined!"
#endif

#endif
2 changes: 1 addition & 1 deletion unit-test/ds_cmds_tests.c
Original file line number Diff line number Diff line change
Expand Up @@ -1276,7 +1276,7 @@ void DS_CloseAllCmd_Test_Nominal(void)
DS_AppData.FileStatus[i].FileHandle = OS_OBJECT_ID_UNDEFINED;
}

if (strlen(DS_MOVE_FILES) > 0)
if (strlen(DS_MOVEFILES_DESTDIR) > 0)
{
strncpy(DS_AppData.DestFileTblPtr->File[0].Movename, "", DS_PATHNAME_BUFSIZE);
}
Expand Down
6 changes: 3 additions & 3 deletions unit-test/ds_file_tests.c
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ void DS_FileSetupWrite_Test_MaxFileSizeExceeded(void)
strncpy(DS_AppData.FileStatus[FileIndex].FileName, "directory1/",
sizeof(DS_AppData.FileStatus[FileIndex].FileName));

if (strlen(DS_MOVE_FILES) > 0)
if (strlen(DS_MOVEFILES_DESTDIR) > 0)
{
strncpy(DS_AppData.DestFileTblPtr->File[FileIndex].Movename, "directory2/movename/",
sizeof(DS_AppData.DestFileTblPtr->File[FileIndex].Movename));
Expand Down Expand Up @@ -572,7 +572,7 @@ void DS_FileCreateDest_Test_ClosedFileHandle(void)
DS_AppData.DestFileTblPtr->File[FileIndex].FileNameType = DS_BY_COUNT;
DS_AppData.FileStatus[FileIndex].FileCount = 1;

if (strlen(DS_MOVE_FILES) > 0)
if (strlen(DS_MOVEFILES_DESTDIR) > 0)
{
DS_AppData.DestFileTblPtr->File[FileIndex].Movename[0] = '\0';
}
Expand Down Expand Up @@ -1304,7 +1304,7 @@ void UtTest_Setup(void)
UT_DS_TEST_ADD(DS_FileUpdateHeader_Test_PlatformConfigCFE_SeekError);
}

if (strlen(DS_MOVE_FILES) > 0)
if (strlen(DS_MOVEFILES_DESTDIR) > 0)
{
UT_DS_TEST_ADD(DS_FileCloseDest_Test_PlatformConfigMoveFiles_Nominal);
UT_DS_TEST_ADD(DS_FileCloseDest_Test_PlatformConfigMoveFiles_MoveError);
Expand Down

0 comments on commit e9124f2

Please sign in to comment.