Code cleanup

Author: doki-nordic

doc/services/ipc/ipc_service/backends/ipc_service_icmsg.rst

@@ -83,8 +83,7 @@ connected through the IPC instance:
    memory.
 #. It then sends a signal to the other domain or CPU, informing that the data
    has been written. Sending the signal to the other domain or CPU is repeated
-   with timeout specified by
-   :kconfig:option:`CONFIG_IPC_SERVICE_ICMSG_BOND_NOTIFY_REPEAT_TO_MS` option.
+   with timeout.
 #. When the signal from the other domain or CPU is received, the magic number
    is read from ``rx-region``. If it is correct, the bonding process is finished
    and the backend informs the application by calling

dts/bindings/ipc/zephyr,ipc-icmsg.yaml

@@ -26,15 +26,15 @@ properties:
     enum:
       - disable
       - enable
-      - compatibility
+      - detect
     default: disable
     description: |
       Select unbound() callback mode. The callback can be enabled or disabled with the
       "enable" and "disable" option respectively. This functionality requires session
       number handshake procedure on both sides, so you cannot set "enable" on one side
-      and "disable" on the other. The "compatibility" mode detects if the remote side
+      and "disable" on the other. The "detect" mode detects if the remote side
       supports handshake procedure and adjusts its behavior accordingly. The
-      "compatibility" mode is possible only if "dcache-alignment" is at least 8 bytes.
+      "detect" mode is possible only if "dcache-alignment" is at least 8 bytes.
 
   dcache-alignment:
     type: int

include/zephyr/ipc/icmsg.h

@@ -27,21 +27,52 @@ extern "C" {
  */
 
 enum icmsg_state {
-	// TODO: rename as it was before
-	ICMSG_STATE_UNINITIALIZED, /**< Instance is not initialized yet. Sending will fail. Opening allowed. */
-	ICMSG_STATE_INITIALIZING_SID_DISABLED, /**< Instance is initializing - waiting for remote to acknowledge. Sending will fail. Opening allowed, session will change and remote may or may not get unbound() callback. */
-	ICMSG_STATE_INITIALIZING_SID_ENABLED, /**< Instance is initializing - waiting for remote to acknowledge. Sending will fail. Opening allowed, session will change and remote may or may not get unbound() callback. */
-	ICMSG_STATE_INITIALIZING_SID_COMPAT, /**< Instance is initializing - waiting for remote to acknowledge. Sending will fail. Opening allowed, session will change and remote may or may not get unbound() callback. */
-	ICMSG_STATE_DISCONNECTED, /**< Instance was connected, but get disconnected. Sending will be silently discarded, because it there may be old sends. Opening allowed. */
-	// Connected states must be at the end
-	ICMSG_STATE_CONNECTED_SID_DISABLED, /**< Instance is connected. Sending will be successful. Opening allowed, session will change and remote will get unbound() callback. */
-	ICMSG_STATE_CONNECTED_SID_ENABLED, /**< Instance is connected. Sending will be successful. Opening allowed, session will change and remote will get unbound() callback. */
+	/** Instance is not initialized yet. In this state: sending will fail, opening allowed.
+	 */
+	ICMSG_STATE_OFF,
+
+	/** Instance is initializing without session handshake. In this state: sending will fail,
+	 * opening will fail.
+	 */
+	ICMSG_STATE_INITIALIZING_SID_DISABLED,
+
+	/** Instance is initializing with session handshake. It is waiting for remote to acknowledge
+	 * local session id. In this state: sending will fail, opening is allowed (local session id
+	 * will change, so the remote may get unbound() callback).
+	 */
+	ICMSG_STATE_INITIALIZING_SID_ENABLED,
+
+	/** Instance is initializing with detection of session handshake support on remote side.
+	 * It is waiting for remote to acknowledge local session id or to send magic bytes.
+	 * In this state: sending will fail, opening is allowed (local session id
+	 * will change, so the remote may get unbound() callback if it supports it).
+	 */
+	ICMSG_STATE_INITIALIZING_SID_DETECT,
+
+	/** Instance was closed on remote side. The unbound() callback was send on local side.
+	 * In this state: sending will be silently discarded (there may be outdated sends),
+	 * opening is allowed.
+	 */
+	ICMSG_STATE_DISCONNECTED,
+
+	/* Connected states must be at the end. */
+
+	/** Instance is connected without session handshake support. In this state: sending will be
+	 * successful, opening will fail.
+	 */
+	ICMSG_STATE_CONNECTED_SID_DISABLED,
+
+	/** Instance is connected with session handshake support. In this state: sending will be
+	 * successful, opening is allowed (session will change and remote will get unbound()
+	 * callback).
+	 */
+	ICMSG_STATE_CONNECTED_SID_ENABLED,
 };
 
 enum icmsg_unbound_mode {
 	ICMSG_UNBOUND_MODE_DISABLE = ICMSG_STATE_INITIALIZING_SID_DISABLED,
 	ICMSG_UNBOUND_MODE_ENABLE = ICMSG_STATE_INITIALIZING_SID_ENABLED,
-	ICMSG_UNBOUND_MODE_COMPATIBILITY = ICMSG_STATE_INITIALIZING_SID_COMPAT,
+	ICMSG_UNBOUND_MODE_DETECT = ICMSG_STATE_INITIALIZING_SID_DETECT,
 };
 
 struct icmsg_config_t {
@@ -65,11 +96,10 @@ struct icmsg_data_t {
 	/* General */
 	const struct icmsg_config_t *cfg;
 #ifdef CONFIG_MULTITHREADING
-	struct k_work_delayable notify_work; // TODO: Not needed if no compatibility needed
 	struct k_work mbox_work;
 #endif
-	uint16_t remote_session;
-	uint16_t local_session;
+	uint16_t remote_sid;
+	uint16_t local_sid;
 	atomic_t state;
 };
 

subsys/ipc/ipc_service/backends/ipc_icmsg.c

@@ -68,13 +68,13 @@ static int backend_init(const struct device *instance)
 			DT_REG_SIZE(DT_INST_PHANDLE(i, tx_region)),	\
 			DT_INST_PROP_OR(i, dcache_alignment, 0),	\
 			UNBOUND_MODE(i) != ICMSG_UNBOUND_MODE_DISABLE,	\
-			UNBOUND_MODE(i) == ICMSG_UNBOUND_MODE_COMPATIBILITY);	\
+			UNBOUND_MODE(i) == ICMSG_UNBOUND_MODE_DETECT);	\
 	PBUF_DEFINE(rx_pb_##i,						\
 			DT_REG_ADDR(DT_INST_PHANDLE(i, rx_region)),	\
 			DT_REG_SIZE(DT_INST_PHANDLE(i, rx_region)),	\
 			DT_INST_PROP_OR(i, dcache_alignment, 0),	\
 			UNBOUND_MODE(i) != ICMSG_UNBOUND_MODE_DISABLE,	\
-			UNBOUND_MODE(i) == ICMSG_UNBOUND_MODE_COMPATIBILITY);	\
+			UNBOUND_MODE(i) == ICMSG_UNBOUND_MODE_DETECT);	\
 									\
 	static struct icmsg_data_t backend_data_##i = {			\
 		.tx_pb = &tx_pb_##i,					\

subsys/ipc/ipc_service/lib/Kconfig.icmsg

@@ -21,14 +21,6 @@ config IPC_SERVICE_ICMSG_SHMEM_ACCESS_TO_MS
 	  Maximum time to wait, in milliseconds, for access to send data with
 	  backends basing on icmsg library. This time should be relatively low.
 
-config IPC_SERVICE_ICMSG_BOND_NOTIFY_REPEAT_TO_MS
-	int "Bond notification timeout in miliseconds"
-	range 1 100
-	default 1
-	help
-	  Time to wait for remote bonding notification before the
-	  notification is repeated.
-
 config IPC_SERVICE_BACKEND_ICMSG_WQ_ENABLE
 	bool "Use dedicated workqueue"
 	depends on MULTITHREADING
@@ -68,6 +60,33 @@ config IPC_SERVICE_BACKEND_ICMSG_WQ_PRIORITY
 
 endif
 
+config IPC_SERVICE_ICMSG_UNBOUND_ENABLED_ALLOWED
+	bool "Instance is allowed to set unbound to enabled"
+	default y
+	help
+	  Controls whether the "enabled" value of the "unbound"
+	  property is allowed to be set in any of the ICMsg instances. You
+	  can set this option to "n", if you want to reduce code size and
+	  no instance of ICMsg is using unbound functionality.
+
+config IPC_SERVICE_ICMSG_UNBOUND_DISABLED_ALLOWED
+	bool "Instance is allowed to set unbound to disabled"
+	default y
+	help
+	  Controls whether the "disabled" value of the "unbound"
+	  property is allowed to be set in any of the ICMsg instances. You
+	  can set this option to "n", if you want to reduce code size and
+	  all instances of ICMsg are using unbound functionality.
+
+config IPC_SERVICE_ICMSG_UNBOUND_DETECT_ALLOWED
+	bool "Instance is allowed to set unbound to detect"
+	default y
+	help
+	  Controls whether the "detect" value of the "unbound"
+	  property is allowed to be set in any of the ICMsg instances. You
+	  can set this option to "n", if you want to reduce code size and
+	  all instances of ICMsg are using unbound detection functionality.
+
 # The Icmsg library in its simplicity requires the system workqueue to execute
 # at a cooperative priority.
 config SYSTEM_WORKQUEUE_PRIORITY