samples: ipc: icsmg: Clean up the sample

Make the sample exchange the data between cores
for predefined time. Clean up logging messages
and do not print transfer speed on each side.

This sample is now used to demonstrate functionalities
of ipc service with icmsg backend.

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

Author: Emil Obalski

samples/subsys/ipc/ipc_service/icmsg/CMakeLists.txt

@@ -17,6 +17,8 @@ endif()
 find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
 project(ipc_service_host)
 
+target_include_directories(app PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/common)
+
 target_sources(app PRIVATE src/main.c)
 
 include(ExternalProject)

samples/subsys/ipc/ipc_service/icmsg/common/common.h

@@ -0,0 +1,20 @@
+/*
+ * Copyright (c) 2022 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef __COMMON_H__
+#define __COMMON_H__
+
+#define PACKET_SIZE_START	(40)
+#define DATA_SIZE		(100)
+#define SENDING_TIME_MS		(1000)
+
+struct data_packet {
+	unsigned long cnt;
+	unsigned long size;
+	unsigned char data[DATA_SIZE];
+};
+
+#endif /* __COMMON_H__ */

samples/subsys/ipc/ipc_service/icmsg/prj.conf

@@ -5,3 +5,4 @@ CONFIG_IPC_SERVICE_BACKEND_ICMSG=y
 CONFIG_MBOX=y
 
 CONFIG_LOG=y
+CONFIG_ASSERT=y

samples/subsys/ipc/ipc_service/icmsg/remote/CMakeLists.txt

@@ -9,4 +9,6 @@ cmake_minimum_required(VERSION 3.20.0)
 find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
 project(ipc_service_remote)
 
+target_include_directories(app PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/../common)
+
 target_sources(app PRIVATE src/main.c)

samples/subsys/ipc/ipc_service/icmsg/remote/prj.conf

@@ -5,3 +5,4 @@ CONFIG_IPC_SERVICE_BACKEND_ICMSG=y
 CONFIG_MBOX=y
 
 CONFIG_LOG=y
+CONFIG_ASSERT=y

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

@@ -9,16 +9,11 @@
 
 #include <zephyr/ipc/ipc_service.h>
 
+#include "common.h"
+
 #include <zephyr/logging/log.h>
 LOG_MODULE_REGISTER(remote, LOG_LEVEL_INF);
 
-#define MLEN_0 40
-
-struct data_packet {
-	unsigned char message;
-	unsigned char data[100];
-};
-
 
 K_SEM_DEFINE(bound_sem, 0, 1);
 
@@ -30,51 +25,66 @@ static void ep_bound(void *priv)
 
 static void ep_recv(const void *data, size_t len, void *priv)
 {
-	char received_data = *((char *)data);
-	static char expected_message = 'a';
-	static uint16_t expected_len = MLEN_0;
+	struct data_packet *packet = (struct data_packet *)data;
+	static unsigned char expected_message = 'a';
+	static size_t expected_len = PACKET_SIZE_START;
 
-	static unsigned long long cnt;
-	static unsigned int stats_every;
-	static uint32_t start;
-	static unsigned int err;
+	__ASSERT(packet->data[0] == expected_message, "Unexpected message. Expected %c, got %c",
+		expected_message, packet->data[0]);
+	__ASSERT(len == expected_len, "Unexpected length. Expected %zu, got %zu",
+		expected_len, len);
 
-	if (start == 0) {
-		start = k_uptime_get_32();
-	}
+	expected_message++;
+	expected_len++;
 
-	if (received_data != expected_message) {
-		err++;
+	if (expected_message > 'z') {
+		expected_message = 'a';
 	}
 
-	if (len != expected_len) {
-		err++;
+	if (expected_len > sizeof(struct data_packet)) {
+		expected_len = PACKET_SIZE_START;
 	}
+}
 
-	expected_message++;
-	expected_len++;
+static int send_for_time(struct ipc_ept *ep, const int64_t sending_time_ms)
+{
+	struct data_packet msg = {.data[0] = 'A'};
+	size_t mlen = PACKET_SIZE_START;
+	size_t bytes_sent = 0;
+	int ret = 0;
 
-	cnt += len;
+	LOG_INF("Perform sends for %lld [ms]", sending_time_ms);
 
-	if (expected_message > 'z') {
-		if (stats_every++ > 50) {
-			/* Print throuhput [Bytes/s]. Use printk not to overload CPU with logger.
-			 * Sample never reaches lower priority thread because of high throughput
-			 * (100% cpu load) so logging would not be able to handle messages in
-			 * deferred mode (immediate mode would be heavier than printk).
-			 */
-			printk("%llu\n", (1000*cnt)/(k_uptime_get_32() - start));
-			stats_every = 0;
+	int64_t start = k_uptime_get();
+
+	while ((k_uptime_get() - start) < sending_time_ms) {
+		ret = ipc_service_send(ep, &msg, mlen);
+		if (ret == -ENOMEM) {
+			/* No space in the buffer. Retry. */
+			continue;
+		} else if (ret < 0) {
+			LOG_ERR("Failed to send (%c) failed with ret %d", msg.data[0], ret);
+			break;
 		}
-		if (err) {
-			printk("Unexpected message\n");
+
+		msg.data[0]++;
+		if (msg.data[0] > 'Z') {
+			msg.data[0] = 'A';
 		}
-		expected_message = 'a';
-	}
 
-	if (expected_len > sizeof(struct data_packet)) {
-		expected_len = MLEN_0;
+		bytes_sent += mlen;
+		mlen++;
+
+		if (mlen > sizeof(struct data_packet)) {
+			mlen = PACKET_SIZE_START;
+		}
+
+		k_usleep(1);
 	}
+
+	LOG_INF("Sent %zu [Bytes] over %lld [ms]", bytes_sent, sending_time_ms);
+
+	return ret;
 }
 
 static struct ipc_ept_cfg ep_cfg = {
@@ -87,7 +97,6 @@ static struct ipc_ept_cfg ep_cfg = {
 int main(void)
 {
 	const struct device *ipc0_instance;
-	struct data_packet msg = {.message = 'A'};
 	struct ipc_ept ep;
 	int ret;
 
@@ -97,48 +106,25 @@ int main(void)
 
 	ret = ipc_service_open_instance(ipc0_instance);
 	if ((ret < 0) && (ret != -EALREADY)) {
-		LOG_INF("ipc_service_open_instance() failure");
+		LOG_ERR("ipc_service_open_instance() failure");
 		return ret;
 	}
 
 	ret = ipc_service_register_endpoint(ipc0_instance, &ep, &ep_cfg);
-	if (ret < 0) {
-		printf("ipc_service_register_endpoint() failure");
+	if (ret != 0) {
+		LOG_ERR("ipc_service_register_endpoint() failure");
 		return ret;
 	}
 
 	k_sem_take(&bound_sem, K_FOREVER);
 
-	uint16_t mlen = MLEN_0;
-
-	while (true) {
-		ret = ipc_service_send(&ep, &msg, mlen);
-		if (ret == -ENOMEM) {
-			/* No space in the buffer. Retry. */
-			continue;
-		} else if (ret < 0) {
-			LOG_ERR("send_message(%d) failed with ret %d", msg.message, ret);
-			break;
-		}
-
-		msg.message++;
-		if (msg.message > 'Z') {
-			msg.message = 'A';
-		}
-
-		mlen++;
-		if (mlen > sizeof(struct data_packet)) {
-			mlen = MLEN_0;
-		}
-
-		/* Quasi minimal busy wait time which allows to continuosly send
-		 * data without -ENOMEM error code. The purpose is to test max
-		 * throughput. Determined experimentally.
-		 */
-		k_busy_wait(50);
+	ret = send_for_time(&ep, SENDING_TIME_MS);
+	if (ret < 0) {
+		LOG_ERR("send_for_time() failure");
+		return ret;
 	}
 
-	LOG_INF("IPC-service REMOTE demo ended.");
+	LOG_INF("IPC-service REMOTE demo ended");
 
 	return 0;
 }