ipc: rework Zephyr IPC interface

This reworks Zephyr IPC interface to utilize the newly
introduced IPC message service, which provides a more
generic IPC interface.

Signed-off-by: Daniel Leung <daniel.leung@intel.com>

Author: dcpleung

app/prj.conf

@@ -49,3 +49,6 @@ CONFIG_SCHED_CPU_MASK=y
 CONFIG_SYS_CLOCK_TICKS_PER_SEC=15000
 CONFIG_DAI=y
 CONFIG_HEAP_MEM_POOL_SIZE=2048
+
+# Use the new IPC message service in Zephyr
+CONFIG_INTEL_ADSP_IPC_OLD_INTERFACE=n

src/include/sof/ipc/common.h

@@ -243,4 +243,12 @@ void ipc_msg_reply(struct sof_ipc_reply *reply);
  */
 void ipc_complete_cmd(struct ipc *ipc);
 
+/**
+ * \brief Send emergency IPC message.
+ *
+ * @param[in] data IPC data to be sent.
+ * @param[in] ext_data Extended data to be sent.
+ */
+void ipc_send_message_emergency(uint32_t data, uint32_t ext_data);
+
 #endif /* __SOF_DRIVERS_IPC_H__ */

src/ipc/ipc-zephyr.c

@@ -11,7 +11,6 @@
 
 #include <autoconf.h>
 
-#include <intel_adsp_ipc.h>
 #include <sof/ipc/common.h>
 
 #include <sof/ipc/schedule.h>
@@ -43,6 +42,8 @@
 #include <stddef.h>
 #include <stdint.h>
 
+#include <zephyr/ipc/backends/ipc_msg_intel_adsp_ipc.h>
+
 SOF_DEFINE_REG_UUID(zipc_task);
 
 LOG_MODULE_DECLARE(ipc, CONFIG_SOF_LOG_LEVEL);
@@ -58,23 +59,27 @@ LOG_MODULE_DECLARE(ipc, CONFIG_SOF_LOG_LEVEL);
 static uint32_t g_last_data, g_last_ext_data;
 
 /**
- * @brief cAVS IPC Message Handler Callback function.
+ * @brief cAVS IPC Message Received Callback function.
  *
- * See @ref (*intel_adsp_ipc_handler_t) for function signature description.
- * @return false so BUSY on the other side will not be cleared immediately but
+ * @return -1 so BUSY on the other side will not be cleared immediately but
  * will remain set until message would have been processed by scheduled task, i.e.
  * until ipc_platform_complete_cmd() call.
  */
-static bool message_handler(const struct device *dev, void *arg, uint32_t data, uint32_t ext_data)
+static int ipc_receive_cb(uint8_t msg_type, const void *msg_data, void *priv)
 {
-	struct ipc *ipc = (struct ipc *)arg;
+	const struct intel_adsp_ipc_msg *msg = (const struct intel_adsp_ipc_msg *)msg_data;
+
+	if (msg_type != INTEL_ADSP_IPC_MSG)
+		return -EBADMSG;
+
+	struct ipc *ipc = (struct ipc *)priv;
 
 	k_spinlock_key_t key;
 
 	key = k_spin_lock(&ipc->lock);
 
-	g_last_data = data;
-	g_last_ext_data = ext_data;
+	g_last_data = msg->data;
+	g_last_ext_data = msg->extdata;
 
 #if CONFIG_DEBUG_IPC_COUNTERS
 	increment_ipc_received_counter();
@@ -83,7 +88,64 @@ static bool message_handler(const struct device *dev, void *arg, uint32_t data,
 
 	k_spin_unlock(&ipc->lock, key);
 
-	return false;
+	return -1;
+}
+
+static struct ipc_msg_ept ipc_ept;
+static struct ipc_msg_ept_cfg ipc_ept_cfg = {
+	.name = "sof_ipc",
+	.cb = {
+		.received = ipc_receive_cb,
+	},
+};
+
+static void ipc_ept_init(struct ipc *ipc)
+{
+	int ret;
+	const struct device *ipc_dev = INTEL_ADSP_IPC_HOST_DEV;
+
+	ipc_ept_cfg.priv = (void *)ipc;
+
+	ret = ipc_msg_service_register_endpoint(ipc_dev, &ipc_ept, &ipc_ept_cfg);
+	ARG_UNUSED(ret);
+}
+
+static void ipc_complete(void)
+{
+	int ret;
+
+	ret = ipc_msg_service_send(&ipc_ept, INTEL_ADSP_IPC_MSG_DONE, NULL);
+
+	ARG_UNUSED(ret);
+}
+
+static bool ipc_is_complete(void)
+{
+	int ret;
+
+	ret = ipc_msg_service_query(&ipc_ept, INTEL_ADSP_IPC_QUERY_IS_COMPLETE, NULL, NULL);
+
+	return ret == 0;
+}
+
+static int ipc_send_message(uint32_t data, uint32_t ext_data)
+{
+	struct intel_adsp_ipc_msg msg = {.data = data, .extdata = ext_data};
+	int ret;
+
+	ret = ipc_msg_service_send(&ipc_ept, INTEL_ADSP_IPC_MSG, &msg);
+
+	return ret;
+}
+
+void ipc_send_message_emergency(uint32_t data, uint32_t ext_data)
+{
+	struct intel_adsp_ipc_msg_emergency msg = {.data = data, .extdata = ext_data};
+	int ret;
+
+	ret = ipc_msg_service_send(&ipc_ept, INTEL_ADSP_IPC_MSG_EMERGENCY, &msg);
+
+	ARG_UNUSED(ret);
 }
 
 #ifdef CONFIG_PM_DEVICE
@@ -157,8 +219,8 @@ static int ipc_device_resume_handler(const struct device *dev, void *arg)
 	ipc->task_mask = 0;
 	ipc->pm_prepare_D3 = false;
 
-	/* attach handlers */
-	intel_adsp_ipc_set_message_handler(INTEL_ADSP_IPC_HOST_DEV, message_handler, ipc);
+	/* initialize IPC endpoint */
+	ipc_ept_init(ipc);
 
 	/* schedule task */
 #if CONFIG_TWB_IPC_TASK
@@ -252,7 +314,7 @@ enum task_state ipc_platform_do_cmd(struct ipc *ipc)
 void ipc_platform_complete_cmd(struct ipc *ipc)
 {
 	ARG_UNUSED(ipc);
-	intel_adsp_ipc_complete(INTEL_ADSP_IPC_HOST_DEV);
+	ipc_complete();
 
 #if CONFIG_DEBUG_IPC_COUNTERS
 	increment_ipc_processed_counter();
@@ -261,26 +323,26 @@ void ipc_platform_complete_cmd(struct ipc *ipc)
 
 int ipc_platform_send_msg(const struct ipc_msg *msg)
 {
-	if (!intel_adsp_ipc_is_complete(INTEL_ADSP_IPC_HOST_DEV))
+	if (!ipc_is_complete())
 		return -EBUSY;
 
 	/* prepare the message and copy to mailbox */
 	struct ipc_cmd_hdr *hdr = ipc_prepare_to_send(msg);
 
-	return intel_adsp_ipc_send_message(INTEL_ADSP_IPC_HOST_DEV, hdr->pri, hdr->ext);
+	return ipc_send_message(hdr->pri, hdr->ext);
 }
 
 void ipc_platform_send_msg_direct(const struct ipc_msg *msg)
 {
 	/* prepare the message and copy to mailbox */
 	struct ipc_cmd_hdr *hdr = ipc_prepare_to_send(msg);
 
-	intel_adsp_ipc_send_message_emergency(INTEL_ADSP_IPC_HOST_DEV, hdr->pri, hdr->ext);
+	ipc_send_message_emergency(hdr->pri, hdr->ext);
 }
 
 int ipc_platform_poll_is_host_ready(void)
 {
-	return intel_adsp_ipc_is_complete(INTEL_ADSP_IPC_HOST_DEV);
+	return ipc_is_complete();
 }
 
 int platform_ipc_init(struct ipc *ipc)
@@ -298,8 +360,9 @@ int platform_ipc_init(struct ipc *ipc)
 #endif
 	/* configure interrupt - work is done internally by Zephyr API */
 
-	/* attach handlers */
-	intel_adsp_ipc_set_message_handler(INTEL_ADSP_IPC_HOST_DEV, message_handler, ipc);
+	/* initialize IPC endpoint */
+	ipc_ept_init(ipc);
+
 #ifdef CONFIG_PM
 	intel_adsp_ipc_set_suspend_handler(INTEL_ADSP_IPC_HOST_DEV,
 					   ipc_device_suspend_handler, ipc);

src/platform/intel/ace/lib/watchdog.c

@@ -34,8 +34,7 @@ static void watchdog_primary_core_action_on_timeout(void)
 
 	/* Send Watchdog Timeout IPC notification */
 	ipc4_notification_watchdog_init(&notif, cpu_get_id(), true);
-	intel_adsp_ipc_send_message_emergency(INTEL_ADSP_IPC_HOST_DEV,
-					      notif.primary.dat, notif.extension.dat);
+	(void)ipc_send_message_emergency(notif.primary.dat, notif.extension.dat);
 }
 
 static void watchdog_secondary_core_action_on_timeout(void)