tests: ipc_service: Test restarting session in different scenarios

This commit adds a test that checks if disconnecting
and restarting the IPC session works correctly. The
test is also focused on the "unbound" callback.

Signed-off-by: Dominik Kilian <[email protected]>
Co-authored-by: Radoslaw Koppel <[email protected]>

Author: 2 people

scripts/ci/check_compliance.py

@@ -990,7 +990,9 @@ def check_no_undef_outside_kconfig(self, kconf):
         "FOO_SETTING_1",
         "FOO_SETTING_2",
         "HEAP_MEM_POOL_ADD_SIZE_", # Used as an option matching prefix
-        "LSM6DSO_INT_PIN",
+        "HUGETLBFS",          # Linux, in boards/xtensa/intel_adsp_cavs25/doc
+        "IPC_SERVICE_ICMSG_BOND_NOTIFY_REPEAT_TO_MS", # Used in ICMsg tests for intercompatibility
+                                                      # with older versions of the ICMsg.
         "LIBGCC_RTLIB",
         "LLVM_USE_LD",   # Both LLVM_USE_* are in cmake/toolchain/llvm/Kconfig
         "LLVM_USE_LLD",  # which are only included if LLVM is selected but

tests/subsys/ipc/ipc_sessions/CMakeLists.txt

@@ -0,0 +1,16 @@
+# Copyright 2021 Google LLC
+# SPDX-License-Identifier: Apache-2.0
+
+cmake_minimum_required(VERSION 3.20.0)
+
+find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
+project(ipc_service)
+
+zephyr_include_directories(./common)
+
+FILE(GLOB app_sources src/*.c)
+target_sources(app PRIVATE ${app_sources})
+
+zephyr_sources_ifdef(CONFIG_IPC_SERVICE_ICMSG_V1		interoperability/icmsg_v1.c)
+zephyr_sources_ifdef(CONFIG_PBUF_V1				interoperability/pbuf_v1.c)
+zephyr_sources_ifdef(CONFIG_IPC_SERVICE_BACKEND_ICMSG_V1	interoperability/ipc_icmsg_v1.c)

tests/subsys/ipc/ipc_sessions/Kconfig

@@ -0,0 +1,37 @@
+#
+# Copyright (c) 2024 Nordic Semiconductor ASA
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+
+rsource "interoperability/Kconfig"
+
+menu "Zephyr"
+source "Kconfig.zephyr"
+endmenu
+
+config IPC_TEST_MSG_HEAP_SIZE
+	int "The heap to copy processed messages"
+	default 512
+	help
+		Internal heap where all the message data would be copied to be processed
+		linearry in tests.
+
+config IPC_TEST_SKIP_CORE_RESET
+	bool "Skip the tests that includes core resetting"
+	help
+		Some of the cores cannot be safely restarted.
+		Skip the tests that require it in such a cases.
+
+config IPC_TEST_BLOCK_SIZE
+	int "Block size for multiple transfers test"
+	default 32
+
+config IPC_TEST_BLOCK_CNT
+	int "Number of blocks for multiple transfers test"
+	default 8000
+
+config IPC_TEST_SKIP_UNBOUND
+	bool "Skip unbound tests"
+	help
+		Whether to skip tests that requires unbound callback functionality.

tests/subsys/ipc/ipc_sessions/Kconfig.sysbuild

@@ -0,0 +1,13 @@
+#
+# Copyright (c) 2024 Nordic Semiconductor ASA
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+
+source "${ZEPHYR_BASE}/share/sysbuild/Kconfig"
+
+config REMOTE_BOARD
+	string "The board used for remote target"
+	default "nrf5340dk/nrf5340/cpunet" if BOARD_NRF5340DK_NRF5340_CPUAPP
+	default "nrf5340dk/nrf5340/cpunet" if BOARD_NRF5340DK_NRF5340_CPUAPP_NS
+	default "nrf54h20dk/nrf54h20/cpurad" if BOARD_NRF54H20DK_NRF54H20_CPUAPP

tests/subsys/ipc/ipc_sessions/boards/nrf5340dk_nrf5340_cpuapp.conf

@@ -0,0 +1,7 @@
+#
+# Copyright (c) 2024 Nordic Semiconductor ASA
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+
+CONFIG_SOC_NRF53_CPUNET_ENABLE=y

tests/subsys/ipc/ipc_sessions/boards/nrf5340dk_nrf5340_cpuapp.overlay

@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) 2022 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/delete-node/ &ipc0;
+
+/ {
+	chosen {
+		/delete-property/ zephyr,ipc_shm;
+		/delete-property/ zephyr,bt-hci;
+	};
+
+	reserved-memory {
+		/delete-node/ memory@20070000;
+
+		sram_tx: memory@20070000 {
+			reg = <0x20070000 0x8000>;
+		};
+
+		sram_rx: memory@20078000 {
+			reg = <0x20078000 0x8000>;
+		};
+	};
+
+	ipc0: ipc0 {
+		compatible = "zephyr,ipc-icmsg";
+		tx-region = <&sram_tx>;
+		rx-region = <&sram_rx>;
+		mboxes = <&mbox 0>, <&mbox 1>;
+		mbox-names = "tx", "rx";
+		dcache-alignment = <8>;
+		unbound = "detect";
+		status = "okay";
+	};
+};

tests/subsys/ipc/ipc_sessions/boards/nrf54h20dk_nrf54h20_cpuapp.overlay

@@ -0,0 +1,12 @@
+/*
+ * Copyright (c) 2024 Nordic Semiconductor ASA
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/* Replace default ipc0 instance */
+&ipc0 {
+	compatible = "zephyr,ipc-icmsg";
+	/delete-property/ tx-blocks;
+	/delete-property/ rx-blocks;
+	unbound = "enable";
+};

tests/subsys/ipc/ipc_sessions/boards/nrf54h20dk_nrf54h20_cpuapp_cpuppr.overlay

@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) 2024 Nordic Semiconductor ASA
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/* Replace default ipc0 instance */
+/delete-node/ &ipc0;
+
+ipc0: &cpuapp_cpuppr_ipc {
+	status = "okay";
+	unbound = "detect";
+};
+
+&cpuppr_vevif {
+	status = "okay";
+};
+
+&cpuapp_bellboard {
+	status = "okay";
+};
+
+/ {
+	chosen {
+		/delete-property/ zephyr,bt-hci;
+	};
+};

tests/subsys/ipc/ipc_sessions/common/test_commands.h

@@ -0,0 +1,81 @@
+/*
+ * Copyright (c) 2024 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+#ifndef TEST_COMMANDS_H
+#include <stdint.h>
+
+/**
+ * @brief Test commands executable by remote
+ */
+enum ipc_test_commands {
+	IPC_TEST_CMD_NONE,     /**< Command to be ingored */
+	IPC_TEST_CMD_PING,     /**< Respond with the @ref IPC_TEST_CMD_PONG message */
+	IPC_TEST_CMD_PONG,     /**< Expected response to IPC_TEST_CMD_PING */
+	IPC_TEST_CMD_ECHO,     /**< Respond with the same data */
+	IPC_TEST_CMD_ECHO_RSP, /**< Echo respond */
+	IPC_TEST_CMD_REBOND,   /**< Unbond and rebond back whole interface */
+	IPC_TEST_CMD_REBOOT,   /**< Restart remote CPU after a given delay */
+	/* Commands used for data transfer test */
+	IPC_TEST_CMD_RXSTART,  /**< Start receiving data */
+	IPC_TEST_CMD_TXSTART,  /**< Start sending data */
+	IPC_TEST_CMD_RXGET,    /**< Get rx status */
+	IPC_TEST_CMD_TXGET,    /**< Get tx status */
+	IPC_TEST_CMD_XSTAT,    /**< rx/tx status response */
+	IPC_TEST_CMD_XDATA,    /**< Transfer data block */
+	/* End of commands used for data transfer test */
+};
+
+/**
+ * @brief Base command structure
+ */
+struct ipc_test_cmd {
+	uint32_t cmd;   /**< The command of @ref ipc_test_command type */
+	uint8_t data[]; /**< Command data depending on the command itself */
+};
+
+/**
+ * @brief Rebond command structure
+ */
+struct ipc_test_cmd_rebond {
+	struct ipc_test_cmd base;
+	uint32_t timeout_ms;
+};
+
+/**
+ * @brief Reboot command structure
+ */
+struct ipc_test_cmd_reboot {
+	struct ipc_test_cmd base;
+	uint32_t timeout_ms;
+};
+
+/**
+ * @brief Start the rx or tx transfer
+ */
+struct ipc_test_cmd_xstart {
+	struct ipc_test_cmd base;
+	uint32_t blk_size;
+	uint32_t blk_cnt;
+	uint32_t seed;
+};
+
+/**
+ * @brief Get the status of rx or tx transfer
+ */
+struct ipc_test_cmd_xstat {
+	struct ipc_test_cmd base;
+	uint32_t blk_cnt; /**< Transfers left */
+	int32_t  result;  /**< Current result */
+};
+
+/**
+ * @brief The result of rx or tx transfer
+ */
+struct ipc_test_cmd_xrsp {
+	struct ipc_test_cmd base;
+	int32_t result;
+};
+
+#endif /* TEST_COMMANDS_H */

tests/subsys/ipc/ipc_sessions/interoperability/Kconfig

@@ -0,0 +1,29 @@
+#
+# Copyright (c) 2024 Nordic Semiconductor ASA
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+
+config IPC_SERVICE_BACKEND_ICMSG
+	default n if IPC_SERVICE_BACKEND_ICMSG_V1
+
+config IPC_SERVICE_ICMSG
+	default n if IPC_SERVICE_ICMSG_V1
+
+config IPC_SERVICE_BACKEND_ICMSG_V1
+	bool "ICMSG backend with SPSC packet buffer (old implementation)"
+	depends on MBOX
+	select IPC_SERVICE_ICMSG_V1
+	help
+	  Chosing this backend results in single endpoint implementation based
+	  on circular packet buffer.
+
+menuconfig IPC_SERVICE_ICMSG_V1
+	bool "icmsg IPC library (old implementation)"
+	select PBUF_V1
+	help
+	  Icmsg library
+
+if IPC_SERVICE_ICMSG_V1
+	rsource "Kconfig.icmsg_v1"
+endif