File System Management

MCUmgr File System Management API. More...

Topics
	File System Management Callbacks
	MCUmgr File System Management Callbacks API.

Enumerations
enum	fs_mgmt_err_code_t {   FS_MGMT_ERR_OK = 0 , FS_MGMT_ERR_UNKNOWN , FS_MGMT_ERR_FILE_INVALID_NAME , FS_MGMT_ERR_FILE_NOT_FOUND ,   FS_MGMT_ERR_FILE_IS_DIRECTORY , FS_MGMT_ERR_FILE_OPEN_FAILED , FS_MGMT_ERR_FILE_SEEK_FAILED , FS_MGMT_ERR_FILE_READ_FAILED ,   FS_MGMT_ERR_FILE_TRUNCATE_FAILED , FS_MGMT_ERR_FILE_DELETE_FAILED , FS_MGMT_ERR_FILE_WRITE_FAILED , FS_MGMT_ERR_FILE_OFFSET_NOT_VALID ,   FS_MGMT_ERR_FILE_OFFSET_LARGER_THAN_FILE , FS_MGMT_ERR_CHECKSUM_HASH_NOT_FOUND , FS_MGMT_ERR_MOUNT_POINT_NOT_FOUND , FS_MGMT_ERR_READ_ONLY_FILESYSTEM ,   FS_MGMT_ERR_FILE_EMPTY }
	Command result codes for file system management group. More...

Command IDs for File System Management group.
#define	FS_MGMT_ID_FILE   0
	File download/upload.
#define	FS_MGMT_ID_STAT   1
	File status.
#define	FS_MGMT_ID_HASH_CHECKSUM   2
	File hash/checksum.
#define	FS_MGMT_ID_SUPPORTED_HASH_CHECKSUM   3
	Supported file hash/checksum types.
#define	FS_MGMT_ID_OPENED_FILE   4
	File close.

Detailed Description

MCUmgr File System Management API.

Macro Definition Documentation

FS_MGMT_ID_FILE

#define FS_MGMT_ID_FILE   0

#include <zephyr/mgmt/mcumgr/grp/fs_mgmt/fs_mgmt.h>

File download/upload.

FS_MGMT_ID_HASH_CHECKSUM

#define FS_MGMT_ID_HASH_CHECKSUM   2

#include <zephyr/mgmt/mcumgr/grp/fs_mgmt/fs_mgmt.h>

File hash/checksum.

FS_MGMT_ID_OPENED_FILE

#define FS_MGMT_ID_OPENED_FILE   4

#include <zephyr/mgmt/mcumgr/grp/fs_mgmt/fs_mgmt.h>

File close.

FS_MGMT_ID_STAT

#define FS_MGMT_ID_STAT   1

#include <zephyr/mgmt/mcumgr/grp/fs_mgmt/fs_mgmt.h>

File status.

FS_MGMT_ID_SUPPORTED_HASH_CHECKSUM

#define FS_MGMT_ID_SUPPORTED_HASH_CHECKSUM   3

#include <zephyr/mgmt/mcumgr/grp/fs_mgmt/fs_mgmt.h>

Supported file hash/checksum types.

Enumeration Type Documentation

fs_mgmt_err_code_t

enum fs_mgmt_err_code_t

#include <zephyr/mgmt/mcumgr/grp/fs_mgmt/fs_mgmt.h>

Command result codes for file system management group.

Enumerator
FS_MGMT_ERR_OK	No error, this is implied if there is no ret value in the response.
FS_MGMT_ERR_UNKNOWN	Unknown error occurred.
FS_MGMT_ERR_FILE_INVALID_NAME	The specified file name is not valid.
FS_MGMT_ERR_FILE_NOT_FOUND	The specified file does not exist.
FS_MGMT_ERR_FILE_IS_DIRECTORY	The specified file is a directory, not a file.
FS_MGMT_ERR_FILE_OPEN_FAILED	Error occurred whilst attempting to open a file.
FS_MGMT_ERR_FILE_SEEK_FAILED	Error occurred whilst attempting to seek to an offset in a file.
FS_MGMT_ERR_FILE_READ_FAILED	Error occurred whilst attempting to read data from a file.
FS_MGMT_ERR_FILE_TRUNCATE_FAILED	Error occurred whilst trying to truncate file.
FS_MGMT_ERR_FILE_DELETE_FAILED	Error occurred whilst trying to delete file.
FS_MGMT_ERR_FILE_WRITE_FAILED	Error occurred whilst attempting to write data to a file.
FS_MGMT_ERR_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_ERR_FILE_OFFSET_LARGER_THAN_FILE	The requested offset is larger than the size of the file on the device.
FS_MGMT_ERR_CHECKSUM_HASH_NOT_FOUND	The requested checksum or hash type was not found or is not supported by this build.
FS_MGMT_ERR_MOUNT_POINT_NOT_FOUND	The specified mount point was not found or is not mounted.
FS_MGMT_ERR_READ_ONLY_FILESYSTEM	The specified mount point is that of a read-only filesystem.
FS_MGMT_ERR_FILE_EMPTY	The operation cannot be performed because the file is empty with no contents.