samples: ipc: icmsg: Add usage of endpoint deregister

Expand the sample to show deregister functionality
for IPC service with icmsg backend.

Signed-off-by: Emil Obalski <[email protected]>

Author: Emil Obalski

samples/subsys/ipc/ipc_service/icmsg/README.rst

@@ -0,0 +1,63 @@
+.. _ipc_icmsg_sample:
+
+IPC Service - icmsg - Sample Application
+########################################
+
+Overview
+********
+
+This application demonstrates how to use IPC Service and the icmsg backend with
+Zephyr. It is designed to demonstrate how to integrate it with Zephyr both
+from a build perspective and code.
+
+Building the application for nrf5340dk_nrf5340_cpuapp
+*****************************************************
+
+.. zephyr-app-commands::
+   :zephyr-app: samples/subsys/ipc/ipc_service/icmsg
+   :board: nrf5340dk_nrf5340_cpuapp
+   :goals: debug
+
+Open a serial terminal (minicom, putty, etc.) and connect the board with the
+following settings:
+
+- Speed: 115200
+- Data: 8 bits
+- Parity: None
+- Stop bits: 1
+
+Reset the board and the following message will appear on the corresponding
+serial port, one is host another is remote:
+
+.. code-block:: console
+
+   *** Booting Zephyr OS build zephyr-v3.2.0-323-g468d4ae383c1  ***
+   [00:00:00.415,985] <inf> host: IPC-service HOST demo started
+   [00:00:00.417,816] <inf> host: Ep bounded
+   [00:00:00.417,877] <inf> host: Perform sends for 1000 [ms]
+   [00:00:01.417,114] <inf> host: Sent 488385 [Bytes] over 1000 [ms]
+   [00:00:01.417,175] <inf> host: Wait 500ms. Let net core finish its sends
+   [00:00:01.917,266] <inf> host: Stop network core
+   [00:00:01.917,297] <inf> host: Reset IPC service
+   [00:00:01.917,327] <inf> host: Run network core
+   [00:00:01.924,865] <inf> host: Ep bounded
+   [00:00:01.924,896] <inf> host: Perform sends for 1000 [ms]
+   [00:00:02.924,194] <inf> host: Sent 489340 [Bytes] over 1000 [ms]
+   [00:00:02.924,224] <inf> host: IPC-service HOST demo ended
+
+
+.. code-block:: console
+
+   *** Booting Zephyr OS build zephyr-v3.2.0-323-g468d4ae383c1  ***
+   [00:00:00.006,256] <inf> remote: IPC-service REMOTE demo started
+   [00:00:00.006,378] <inf> remote: Ep bounded
+   [00:00:00.006,439] <inf> remote: Perform sends for 1000 [ms]
+   [00:00:00.833,160] <inf> sync_rtc: Updated timestamp to synchronized RTC by 1)
+   [00:00:01.417,572] <inf> remote: Sent 235527 [Bytes] over 1000 [ms]
+   [00:00:01.417,602] <inf> remote: IPC-service REMOTE demo ended
+   *** Booting Zephyr OS build zephyr-v3.2.0-323-g468d4ae383c1  ***
+   [00:00:00.006,256] <inf> remote: IPC-service REMOTE demo started
+   [00:00:00.006,347] <inf> remote: Ep bounded
+   [00:00:00.006,378] <inf> remote: Perform sends for 1000 [ms]
+   [00:00:01.006,164] <inf> remote: Sent 236797 [Bytes] over 1000 [ms]
+   [00:00:01.006,195] <inf> remote: IPC-service REMOTE demo ended

samples/subsys/ipc/ipc_service/icmsg/src/main.c

@@ -8,14 +8,20 @@
 #include <zephyr/device.h>
 
 #include <zephyr/ipc/ipc_service.h>
+#include <hal/nrf_reset.h>
+#include <string.h>
 
 #include "common.h"
 
 #include <zephyr/logging/log.h>
 LOG_MODULE_REGISTER(host, LOG_LEVEL_INF);
 
 
+#define DT_DRV_COMPAT	zephyr_ipc_icmsg
+
 K_SEM_DEFINE(bound_sem, 0, 1);
+static unsigned char expected_message = 'A';
+static size_t expected_len = PACKET_SIZE_START;
 
 static void ep_bound(void *priv)
 {
@@ -26,8 +32,6 @@ static void ep_bound(void *priv)
 static void ep_recv(const void *data, size_t len, void *priv)
 {
 	struct data_packet *packet = (struct data_packet *)data;
-	static unsigned char expected_message = 'A';
-	static size_t expected_len = PACKET_SIZE_START;
 
 	__ASSERT(packet->data[0] == expected_message, "Unexpected message. Expected %c, got %c",
 		expected_message, packet->data[0]);
@@ -124,6 +128,58 @@ int main(void)
 		return ret;
 	}
 
+	LOG_INF("Wait 500ms. Let net core finish its sends");
+	k_msleep(500);
+
+	LOG_INF("Stop network core");
+	nrf_reset_network_force_off(NRF_RESET, true);
+
+	LOG_INF("Reset IPC service");
+
+	ret = ipc_service_deregister_endpoint(&ep);
+	if (ret != 0) {
+		LOG_ERR("ipc_service_register_endpoint() failure");
+		return ret;
+	}
+
+	/* Reset message and expected message value and len. */
+	expected_message = 'A';
+	expected_len = PACKET_SIZE_START;
+
+	/* Reset bound sem. */
+	ret = k_sem_init(&bound_sem, 0, 1);
+	if (ret != 0) {
+		LOG_ERR("k_sem_init() failure");
+		return ret;
+	}
+
+	uintptr_t tx_shm_size = DT_REG_SIZE(DT_INST_PHANDLE(0, tx_region));
+	uintptr_t tx_shm_addr = DT_REG_ADDR(DT_INST_PHANDLE(0, tx_region));
+	uintptr_t rx_shm_size = DT_REG_SIZE(DT_INST_PHANDLE(0, rx_region));
+	uintptr_t rx_shm_addr = DT_REG_ADDR(DT_INST_PHANDLE(0, rx_region));
+
+	LOG_INF("Clean shared memory");
+
+	memset((void *)tx_shm_addr, 0, tx_shm_size);
+	memset((void *)rx_shm_addr, 0, rx_shm_size);
+
+	ret = ipc_service_register_endpoint(ipc0_instance, &ep, &ep_cfg);
+	if (ret != 0) {
+		LOG_INF("ipc_service_register_endpoint() failure");
+		return ret;
+	}
+
+	LOG_INF("Run network core");
+	nrf_reset_network_force_off(NRF_RESET, false);
+
+	k_sem_take(&bound_sem, K_FOREVER);
+
+	ret = send_for_time(&ep, SENDING_TIME_MS);
+	if (ret < 0) {
+		LOG_ERR("send_for_time() failure");
+		return ret;
+	}
+
 	LOG_INF("IPC-service HOST demo ended");
 
 	return 0;