mgmt: mcumgr: fs_mgmt: Switch to new event callback system

Switches to the new event callback system for the fs_mgmt
functionality and removes the old code.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>

Author: nordicjm

include/zephyr/mgmt/mcumgr/grp/fs_mgmt/fs_mgmt_callbacks.h

@@ -0,0 +1,48 @@
+/*
+ * Copyright (c) 2022 Laird Connectivity
+ * Copyright (c) 2022 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef H_MCUMGR_FS_MGMT_CALLBACKS_
+#define H_MCUMGR_FS_MGMT_CALLBACKS_
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @brief MCUmgr fs_mgmt callback API
+ * @defgroup mcumgr_callback_api_fs_mgmt MCUmgr fs_mgmt callback API
+ * @ingroup mcumgr_callback_api
+ * @{
+ */
+
+/**
+ * Structure provided in the MGMT_EVT_OP_FS_MGMT_FILE_ACCESS notification callback: This callback
+ * function is used to notify the application about a pending file read/write request and to
+ * authorise or deny it. Access will be allowed so long as all notification handlers return
+ * MGMT_ERR_EOK, if one returns an error then access will be denied.
+ */
+struct fs_mgmt_file_access {
+	/** True if the request is for uploading data to the file, otherwise false */
+	bool upload;
+
+	/**
+	 * Path and filename of file be accesses, note that this can be changed by handlers to
+	 * redirect file access if needed (as long as it does not exceed the maximum path string
+	 * size).
+	 */
+	char *filename;
+};
+
+/**
+ * @}
+ */
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif

include/zephyr/mgmt/mcumgr/mgmt/callbacks.h

@@ -11,6 +11,10 @@
 #include <zephyr/sys/slist.h>
 #include <mgmt/mgmt.h>
 
+#ifdef CONFIG_MCUMGR_CMD_FS_MGMT
+#include <zephyr/mgmt/mcumgr/grp/fs_mgmt/fs_mgmt_callbacks.h>
+#endif
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -66,6 +70,8 @@ typedef int32_t (*mgmt_cb)(uint32_t event, int32_t rc, bool *abort_more, void *d
 enum mgmt_cb_groups {
 	MGMT_EVT_GRP_ALL			= 0,
 	MGMT_EVT_GRP_SMP,
+	MGMT_EVT_GRP_IMG,
+	MGMT_EVT_GRP_FS,
 
 	MGMT_EVT_GRP_USER_CUSTOM_START		= MGMT_GROUP_ID_PERUSER,
 };
@@ -95,6 +101,40 @@ enum smp_group_events {
 	MGMT_EVT_OP_CMD_ALL			= MGMT_DEF_EVT_OP_ALL(MGMT_EVT_GRP_SMP),
 };
 
+/**
+ * MGMT event opcodes for filesystem management group.
+ */
+enum fs_mgmt_group_events {
+	/** Callback when a file has been accessed, data is fs_mgmt_file_access. */
+	MGMT_EVT_OP_FS_MGMT_FILE_ACCESS		= MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_FS, 0),
+
+	/** Used to enable all fs_mgmt_group events. */
+	MGMT_EVT_OP_FS_MGMT_ALL			= MGMT_DEF_EVT_OP_ALL(MGMT_EVT_GRP_FS),
+};
+
+/**
+ * MGMT event opcodes for image management group.
+ */
+enum img_mgmt_group_events {
+	/** Callback when a client sends a file upload chunk, data is img_mgmt_upload_check. */
+	MGMT_EVT_OP_IMG_MGMT_DFU_CHUNK		= MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_IMG, 0),
+
+	/** Callback when a DFU operation is stopped. */
+	MGMT_EVT_OP_IMG_MGMT_DFU_STOPPED	= MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_IMG, 1),
+
+	/** Callback when a DFU operation is started. */
+	MGMT_EVT_OP_IMG_MGMT_DFU_STARTED	= MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_IMG, 2),
+
+	/** Callback when a DFU operation has finished being transferred. */
+	MGMT_EVT_OP_IMG_MGMT_DFU_PENDING	= MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_IMG, 3),
+
+	/** Callback when an image has been confirmed. */
+	MGMT_EVT_OP_IMG_MGMT_DFU_CONFIRMED	= MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_IMG, 4),
+
+	/** Used to enable all img_mgmt_group events. */
+	MGMT_EVT_OP_IMG_MGMT_ALL		= MGMT_DEF_EVT_OP_ALL(MGMT_EVT_GRP_IMG),
+};
+
 /**
  * MGMT callback struct
  */

subsys/mgmt/mcumgr/lib/cmd/fs_mgmt/Kconfig

@@ -140,8 +140,9 @@ config FS_MGMT_PATH_SIZE
 	  of this size gets allocated on the stack during handling of file upload
 	  and download commands.
 
-config FS_MGMT_FILE_ACCESS_HOOK
+config MCUMGR_GRP_FS_FILE_ACCESS_HOOK
 	bool "File read/write access hook"
+	depends on MCUMGR_MGMT_NOTIFICATION_HOOKS
 	help
 	  Allows applications to control file read and write access by
 	  registering for a callback which is then triggered whenever a file

subsys/mgmt/mcumgr/lib/cmd/fs_mgmt/include/fs_mgmt/fs_mgmt.h

@@ -1,6 +1,7 @@
 /*
  * Copyright (c) 2018-2022 mcumgr authors
  * Copyright (c) 2022 Laird Connectivity
+ * Copyright (c) 2022 Nordic Semiconductor ASA
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -20,38 +21,11 @@ extern "C" {
 #define FS_MGMT_ID_HASH_CHECKSUM		2
 #define FS_MGMT_ID_SUPPORTED_HASH_CHECKSUM	3
 
-#ifdef CONFIG_FS_MGMT_FILE_ACCESS_HOOK
-/** @typedef fs_mgmt_on_evt_cb
- * @brief Function to be called on fs mgmt event.
- *
- * This callback function is used to notify the application about a pending file
- * read/write request and to authorise or deny it.
- *
- * @param write		True if write access is requested, false for read access
- * @param path		The path of the file to query.
- *
- * @note That the path can potentially be changed by the application code so
- *	 long as it does not exceed the maximum path string size.
- *
- * @return 0 to allow read/write, MGMT_ERR_[...] code to disallow read/write.
- */
-typedef int (*fs_mgmt_on_evt_cb)(bool write, char *path);
-#endif
-
 /**
  * @brief Registers the file system management command handler group.
  */
 void fs_mgmt_register_group(void);
 
-#ifdef CONFIG_FS_MGMT_FILE_ACCESS_HOOK
-/**
- * @brief Register file read/write access event callback function.
- *
- * @param cb Callback function or NULL to disable.
- */
-void fs_mgmt_register_evt_cb(fs_mgmt_on_evt_cb cb);
-#endif
-
 #ifdef __cplusplus
 }
 #endif

subsys/mgmt/mcumgr/lib/cmd/fs_mgmt/src/fs_mgmt.c

@@ -32,6 +32,10 @@
 #include "fs_mgmt/hash_checksum_sha256.h"
 #endif
 
+#if defined(CONFIG_MCUMGR_MGMT_NOTIFICATION_HOOKS)
+#include <zephyr/mgmt/mcumgr/mgmt/callbacks.h>
+#endif
+
 #ifdef CONFIG_FS_MGMT_CHECKSUM_HASH
 /* Define default hash/checksum */
 #if defined(CONFIG_FS_MGMT_CHECKSUM_IEEE_CRC32)
@@ -79,10 +83,6 @@ struct hash_checksum_iterator_info {
 };
 #endif
 
-#ifdef CONFIG_FS_MGMT_FILE_ACCESS_HOOK
-static fs_mgmt_on_evt_cb fs_evt_cb;
-#endif
-
 static int fs_mgmt_filelen(const char *path, size_t *out_len)
 {
 	struct fs_dirent dirent;
@@ -179,6 +179,13 @@ static int fs_mgmt_file_download(struct smp_streamer *ctxt)
 		ZCBOR_MAP_DECODE_KEY_VAL(name, zcbor_tstr_decode, &name),
 	};
 
+#if defined(CONFIG_MCUMGR_GRP_FS_FILE_ACCESS_HOOK)
+	struct fs_mgmt_file_access file_access_data = {
+		.upload = false,
+		.filename = path,
+	};
+#endif
+
 	ok = zcbor_map_decode_bulk(zsd, fs_download_decode,
 		ARRAY_SIZE(fs_download_decode), &decoded) == 0;
 
@@ -189,14 +196,13 @@ static int fs_mgmt_file_download(struct smp_streamer *ctxt)
 	memcpy(path, name.value, name.len);
 	path[name.len] = '\0';
 
-#ifdef CONFIG_FS_MGMT_FILE_ACCESS_HOOK
-	if (fs_evt_cb != NULL) {
-		/* Send request to application to check if access should be allowed or not */
-		rc = fs_evt_cb(false, path);
+#if defined(CONFIG_MCUMGR_GRP_FS_FILE_ACCESS_HOOK)
+	/* Send request to application to check if access should be allowed or not */
+	rc = mgmt_callback_notify(MGMT_EVT_OP_FS_MGMT_FILE_ACCESS, &file_access_data,
+				  sizeof(file_access_data));
 
-		if (rc != 0) {
-			return rc;
-		}
+	if (rc != MGMT_ERR_EOK) {
+		return rc;
 	}
 #endif
 
@@ -313,6 +319,13 @@ static int fs_mgmt_file_upload(struct smp_streamer *ctxt)
 		ZCBOR_MAP_DECODE_KEY_VAL(len, zcbor_uint64_decode, &len),
 	};
 
+#if defined(CONFIG_MCUMGR_GRP_FS_FILE_ACCESS_HOOK)
+	struct fs_mgmt_file_access file_access_data = {
+		.upload = false,
+		.filename = file_name,
+	};
+#endif
+
 	ok = zcbor_map_decode_bulk(zsd, fs_upload_decode,
 		ARRAY_SIZE(fs_upload_decode), &decoded) == 0;
 
@@ -324,14 +337,13 @@ static int fs_mgmt_file_upload(struct smp_streamer *ctxt)
 	memcpy(file_name, name.value, name.len);
 	file_name[name.len] = '\0';
 
-#ifdef CONFIG_FS_MGMT_FILE_ACCESS_HOOK
-	if (fs_evt_cb != NULL) {
-		/* Send request to application to check if access should be allowed or not */
-		rc = fs_evt_cb(true, file_name);
+#if defined(CONFIG_MCUMGR_GRP_FS_FILE_ACCESS_HOOK)
+	/* Send request to application to check if access should be allowed or not */
+	rc = mgmt_callback_notify(MGMT_EVT_OP_FS_MGMT_FILE_ACCESS, &file_access_data,
+				  sizeof(file_access_data));
 
-		if (rc != 0) {
-			return rc;
-		}
+	if (rc != MGMT_ERR_EOK) {
+		return rc;
 	}
 #endif
 
@@ -672,10 +684,3 @@ void fs_mgmt_register_group(void)
 #endif
 #endif
 }
-
-#ifdef CONFIG_FS_MGMT_FILE_ACCESS_HOOK
-void fs_mgmt_register_evt_cb(fs_mgmt_on_evt_cb cb)
-{
-	fs_evt_cb = cb;
-}
-#endif