fs_mgmt.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018-2022 mcumgr authors
 * Copyright (c) 2022 Laird Connectivity
 * Copyright (c) 2022-2023 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef H_FS_MGMT_
#define H_FS_MGMT_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#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
 
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,
};
 
#ifdef CONFIG_MCUMGR_SMP_SUPPORT_ORIGINAL_PROTOCOL
/*
 * @brief       Translate FS mgmt group error code into MCUmgr error code
 *
 * @param ret   #fs_mgmt_ret_code_t error code
 *
 * @return      #mcumgr_err_t error code
 */
int fs_mgmt_translate_error_code(uint16_t ret);
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif