net: openthread: rpc: implement otInstanceFactoryReset

Add RPC serialization of the otInstanceFactoryReset() API.

By default, the RPC server simply calls the same API from
the OpenThread stack upon receiving this RPC call.
However, if CONFIG_OPENTHREAD_RPC_ERASE_SETTINGS Kconfig
option is enabled, the RPC server erases the entire settings
partition instead.

Signed-off-by: Damian Krolik <[email protected]>

Author: Damian-Nordic

samples/nrf_rpc/protocols_serialization/client/src/ot_shell.c

@@ -1908,6 +1908,18 @@ static int cmd_rloc16(const struct shell *sh, size_t argc, char *argv[])
 	return ot_cli_command_exec(cmd_rloc16_impl, sh, argc, argv);
 }
 
+static otError cmd_factoryreset_impl(const struct shell *sh, size_t argc, char *argv[])
+{
+	otInstanceFactoryReset(NULL);
+
+	return OT_ERROR_NONE;
+}
+
+static int cmd_factoryreset(const struct shell *sh, size_t argc, char *argv[])
+{
+	return ot_cli_command_exec(cmd_factoryreset_impl, sh, argc, argv);
+}
+
 static void handle_udp_receive(void *context, otMessage *msg, const otMessageInfo *msg_info)
 {
 	uint16_t offset;
@@ -2089,6 +2101,7 @@ SHELL_STATIC_SUBCMD_SET_CREATE(
 	SHELL_CMD_ARG(eui64, NULL, "EUI64 configuration", cmd_eui64, 1, 1),
 	SHELL_CMD_ARG(rloc16, NULL, "Get RLOC16", cmd_rloc16, 1, 0),
 	SHELL_CMD_ARG(udp, &udp_cmds, "UDP subcommands", NULL, 1, 0),
+	SHELL_CMD_ARG(factoryreset, NULL, "Factory reset", cmd_factoryreset, 1, 0),
 	SHELL_CMD_ARG(test_message, NULL, "Test message API", cmd_test_message, 1, 0),
 	SHELL_CMD_ARG(test_net_data, NULL, "Test netdata API", cmd_test_net_data, 1, 0),
 	SHELL_CMD_ARG(test_net_data_mesh_prefix, NULL, "Test netdata msh prefix API",

samples/nrf_rpc/protocols_serialization/server/sample.yaml

@@ -31,3 +31,4 @@ tests:
       SNIPPET="ble;openthread;debug;coex;log_rpc;ci-shell"
     extra_configs:
       - CONFIG_NRF_RPC_UTILS_CRASH_GEN=y
+      - CONFIG_OPENTHREAD_RPC_ERASE_SETTINGS=y

subsys/net/openthread/rpc/Kconfig

@@ -77,7 +77,7 @@ config OPENTHREAD_RPC_CLIENT_RADIO_TIME_REFRESH_PERIOD
 
 endmenu # "OpenThread over RPC client configuration"
 
-menu "OpenThread over RPC client configuration"
+menu "OpenThread over RPC server configuration"
 	depends on OPENTHREAD_RPC_SERVER
 
 config OPENTHREAD_RPC_MESSAGE_POOL
@@ -87,7 +87,14 @@ config OPENTHREAD_RPC_MESSAGE_POOL
 	  Defines maximum number of messages key indentifiers that can be allocated on server at
 	  the same time.
 
-endmenu
+config OPENTHREAD_RPC_ERASE_SETTINGS
+	bool "Erase settings partition on factory reset"
+	depends on SETTINGS_NVS || SETTINGS_ZMS
+	help
+	  Erase the entire settings partition when otInstanceFactoryReset() is invoked
+	  using a remote procedure call.
+
+endmenu # "OpenThread over RPC server configuration"
 
 config OPENTHREAD_RPC_INITIALIZE_NRF_RPC
 	bool "Automatically initialize nRF RPC library"

subsys/net/openthread/rpc/client/ot_rpc_instance.c

@@ -80,6 +80,17 @@ otError otInstanceErasePersistentInfo(otInstance *aInstance)
 	return error;
 }
 
+void otInstanceFactoryReset(otInstance *aInstance)
+{
+	struct nrf_rpc_cbor_ctx ctx;
+
+	ARG_UNUSED(aInstance);
+
+	NRF_RPC_CBOR_ALLOC(&ot_group, ctx, 0);
+	nrf_rpc_cbor_cmd_no_err(&ot_group, OT_RPC_CMD_INSTANCE_FACTORY_RESET, &ctx,
+				nrf_rpc_rsp_decode_void, NULL);
+}
+
 otError otSetStateChangedCallback(otInstance *aInstance, otStateChangedCallback aCallback,
 				  void *aContext)
 {

subsys/net/openthread/rpc/common/ot_rpc_ids.h

@@ -37,6 +37,7 @@ enum ot_rpc_cmd_server {
 	OT_RPC_CMD_INSTANCE_IS_INITIALIZED,
 	OT_RPC_CMD_INSTANCE_FINALIZE,
 	OT_RPC_CMD_INSTANCE_ERASE_PERSISTENT_INFO,
+	OT_RPC_CMD_INSTANCE_FACTORY_RESET,
 	OT_RPC_CMD_IP6_GET_UNICAST_ADDRESSES,
 	OT_RPC_CMD_IP6_GET_MULTICAST_ADDRESSES,
 	OT_RPC_CMD_SET_STATE_CHANGED_CALLBACK,

subsys/net/openthread/rpc/server/ot_rpc_instance.c

@@ -12,8 +12,14 @@
 #include <nrf_rpc_cbor.h>
 
 #include <openthread/instance.h>
+#include <openthread/platform/misc.h>
+#include <openthread/thread.h>
 
+#include <zephyr/fs/nvs.h>
+#include <zephyr/fs/zms.h>
 #include <zephyr/net/openthread.h>
+#include <zephyr/settings/settings.h>
+#include <zephyr/sys/__assert.h>
 
 /* TODO: move to common */
 typedef struct ot_rpc_callback {
@@ -198,6 +204,52 @@ NRF_RPC_CBOR_CMD_DECODER(ot_group, ot_rpc_cmd_instance_erase_persistent_info,
 			 OT_RPC_CMD_INSTANCE_ERASE_PERSISTENT_INFO,
 			 ot_rpc_cmd_instance_erase_persistent_info, NULL);
 
+static void ot_rpc_cmd_instance_factory_reset(const struct nrf_rpc_group *group,
+					      struct nrf_rpc_cbor_ctx *ctx, void *handler_data)
+{
+	struct otInstance *inst;
+
+	nrf_rpc_cbor_decoding_done(group, ctx);
+
+	/*
+	 * The factory reset procedure involves rebooting the device, so send the response before it
+	 * begins, until there is still a chance.
+	 */
+	nrf_rpc_rsp_send_void(group);
+
+	inst = openthread_get_default_instance();
+
+	if (IS_ENABLED(CONFIG_OPENTHREAD_RPC_ERASE_SETTINGS)) {
+		int rc;
+		void *storage;
+
+		/*
+		 * Lock the system scheduler to assure that no setting is written after the storage
+		 * has been cleared and before the device is reset.
+		 */
+		k_sched_lock();
+		rc = settings_storage_get(&storage);
+		__ASSERT_NO_MSG(rc == 0);
+
+		if (IS_ENABLED(CONFIG_SETTINGS_NVS)) {
+			nvs_clear(storage);
+		} else {
+			zms_clear(storage);
+		}
+
+		otPlatReset(inst);
+		k_sched_unlock();
+	} else {
+		ot_rpc_mutex_lock();
+		otInstanceFactoryReset(inst);
+		ot_rpc_mutex_unlock();
+	}
+}
+
+NRF_RPC_CBOR_CMD_DECODER(ot_group, ot_rpc_cmd_instance_factory_reset,
+			 OT_RPC_CMD_INSTANCE_FACTORY_RESET, ot_rpc_cmd_instance_factory_reset,
+			 NULL);
+
 static void ot_state_changed_callback(otChangedFlags aFlags, void *aContext)
 {
 	struct nrf_rpc_cbor_ctx ctx;

tests/subsys/net/openthread/rpc/client/src/instance_suite.c

@@ -152,6 +152,14 @@ ZTEST(ot_rpc_instance, test_otInstanceErasePersistentInfo_error)
 	zassert_equal(error, OT_ERROR_INVALID_STATE);
 }
 
+/* Test serialization of otInstanceFactoryReset() */
+ZTEST(ot_rpc_instance, test_otInstanceFactoryReset)
+{
+	mock_nrf_rpc_tr_expect_add(RPC_CMD(OT_RPC_CMD_INSTANCE_FACTORY_RESET), RPC_RSP());
+	otInstanceFactoryReset(NULL);
+	mock_nrf_rpc_tr_expect_done();
+}
+
 /* Test serialization of otGetVersionString() */
 ZTEST(ot_rpc_instance, test_otGetVersionString)
 {

tests/subsys/net/openthread/rpc/server/src/instance_suite.c

@@ -22,6 +22,7 @@ FAKE_VALUE_FUNC(uint32_t, otInstanceGetId, otInstance *);
 FAKE_VALUE_FUNC(bool, otInstanceIsInitialized, otInstance *);
 FAKE_VOID_FUNC(otInstanceFinalize, otInstance *);
 FAKE_VALUE_FUNC(otError, otInstanceErasePersistentInfo, otInstance *);
+FAKE_VOID_FUNC(otInstanceFactoryReset, otInstance *);
 FAKE_VALUE_FUNC(const char *, otGetVersionString);
 FAKE_VALUE_FUNC(otError, otSetStateChangedCallback, otInstance *, otStateChangedCallback, void *);
 FAKE_VOID_FUNC(otRemoveStateChangeCallback, otInstance *, otStateChangedCallback, void *);
@@ -205,6 +206,21 @@ ZTEST(ot_rpc_instance, test_otInstanceErasePersistentInfo_error)
 	zassert_equal(otInstanceErasePersistentInfo_fake.arg0_val, (otInstance *)instance);
 }
 
+/*
+ * Test reception of otInstanceFactoryReset() command.
+ */
+ZTEST(ot_rpc_instance, test_otInstanceFactoryReset)
+{
+	uintptr_t instance = (uintptr_t)openthread_get_default_instance();
+
+	mock_nrf_rpc_tr_expect_add(RPC_RSP(), NO_RSP);
+	mock_nrf_rpc_tr_receive(RPC_CMD(OT_RPC_CMD_INSTANCE_FACTORY_RESET));
+	mock_nrf_rpc_tr_expect_done();
+
+	zassert_equal(otInstanceFactoryReset_fake.call_count, 1);
+	zassert_equal(otInstanceFactoryReset_fake.arg0_val, (otInstance *)instance);
+}
+
 /*
  * Test reception of otGetVersionString() command.
  */