fs_mgmt.h File Reference

Go to the source code of this file.

Macros
#define	FS_MGMT_ID_FILE   0
#define	FS_MGMT_ID_STAT   1
#define	FS_MGMT_ID_HASH_CHECKSUM   2
#define	FS_MGMT_ID_SUPPORTED_HASH_CHECKSUM   3
#define	FS_MGMT_ID_OPENED_FILE   4

Enumerations
enum	fs_mgmt_ret_code_t {   FS_MGMT_RET_RC_OK = 0 , FS_MGMT_RET_RC_UNKNOWN , FS_MGMT_RET_RC_FILE_INVALID_NAME , FS_MGMT_RET_RC_FILE_NOT_FOUND ,   FS_MGMT_RET_RC_FILE_IS_DIRECTORY , FS_MGMT_RET_RC_FILE_OPEN_FAILED , FS_MGMT_RET_RC_FILE_SEEK_FAILED , FS_MGMT_RET_RC_FILE_READ_FAILED ,   FS_MGMT_RET_RC_FILE_TRUNCATE_FAILED , FS_MGMT_RET_RC_FILE_DELETE_FAILED , FS_MGMT_RET_RC_FILE_WRITE_FAILED , FS_MGMT_RET_RC_FILE_OFFSET_NOT_VALID ,   FS_MGMT_RET_RC_FILE_OFFSET_LARGER_THAN_FILE , FS_MGMT_RET_RC_CHECKSUM_HASH_NOT_FOUND }

Macro Definition Documentation

FS_MGMT_ID_FILE

#define FS_MGMT_ID_FILE   0

Command IDs for file system management group.

FS_MGMT_ID_HASH_CHECKSUM

#define FS_MGMT_ID_HASH_CHECKSUM   2

FS_MGMT_ID_OPENED_FILE

#define FS_MGMT_ID_OPENED_FILE   4

FS_MGMT_ID_STAT

#define FS_MGMT_ID_STAT   1

FS_MGMT_ID_SUPPORTED_HASH_CHECKSUM

#define FS_MGMT_ID_SUPPORTED_HASH_CHECKSUM   3

Enumeration Type Documentation

fs_mgmt_ret_code_t

enum fs_mgmt_ret_code_t

Command result codes for file system management group.

Enumerator
FS_MGMT_RET_RC_OK	No error, this is implied if there is no ret value in the response
FS_MGMT_RET_RC_UNKNOWN	Unknown error occurred.
FS_MGMT_RET_RC_FILE_INVALID_NAME	The specified file name is not valid.
FS_MGMT_RET_RC_FILE_NOT_FOUND	The specified file does not exist.
FS_MGMT_RET_RC_FILE_IS_DIRECTORY	The specified file is a directory, not a file.
FS_MGMT_RET_RC_FILE_OPEN_FAILED	Error occurred whilst attempting to open a file.
FS_MGMT_RET_RC_FILE_SEEK_FAILED	Error occurred whilst attempting to seek to an offset in a file.
FS_MGMT_RET_RC_FILE_READ_FAILED	Error occurred whilst attempting to read data from a file.
FS_MGMT_RET_RC_FILE_TRUNCATE_FAILED	Error occurred whilst trying to truncate file.
FS_MGMT_RET_RC_FILE_DELETE_FAILED	Error occurred whilst trying to delete file.
FS_MGMT_RET_RC_FILE_WRITE_FAILED	Error occurred whilst attempting to write data to a file.
FS_MGMT_RET_RC_FILE_OFFSET_NOT_VALID	The specified data offset is not valid, this could indicate that the file on the device has changed since the previous command. The length of the current file on the device is returned as "len", the user application needs to decide how to handle this (e.g. the hash of the file could be requested and compared with the hash of the length of the file being uploaded to see if they match or not).
FS_MGMT_RET_RC_FILE_OFFSET_LARGER_THAN_FILE	The requested offset is larger than the size of the file on the device.
FS_MGMT_RET_RC_CHECKSUM_HASH_NOT_FOUND	The requested checksum or hash type was not found or is not supported by this build.