ipc: rework Zephyr IPC interface

This reworks the Zephyr IPC interface to utilize the generic
IPC service and backend. So we no longer have to maintain
a SoC specific IPC driver.

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

@@ -250,4 +250,12 @@ void ipc_complete_cmd(struct ipc *ipc);
 /* GDB stub: should enter GDB after completing the IPC processing */
 extern bool ipc_enter_gdb;
 
+/**
+ * \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

@@ -13,7 +13,6 @@
 
 #include <zephyr/kernel.h>
 
-#include <intel_adsp_ipc.h>
 #include <sof/ipc/common.h>
 
 #include <sof/ipc/schedule.h>
@@ -45,6 +44,11 @@
 #include <stddef.h>
 #include <stdint.h>
 
+#ifdef CONFIG_INTEL_ADSP_IPC_OLD_INTERFACE
+#include <intel_adsp_ipc.h>
+#endif
+#include <zephyr/ipc/backends/intel_adsp_host_ipc.h>
+
 SOF_DEFINE_REG_UUID(zipc_task);
 
 LOG_MODULE_DECLARE(ipc, CONFIG_SOF_LOG_LEVEL);
@@ -59,33 +63,88 @@ LOG_MODULE_DECLARE(ipc, CONFIG_SOF_LOG_LEVEL);
  */
 static uint32_t g_last_data, g_last_ext_data;
 
+struct k_sem *wait_ack_sem;
+
 /**
- * @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 void ipc_receive_cb(const void *data, size_t len, void *priv)
 {
-	struct ipc *ipc = (struct ipc *)arg;
+	struct intel_adsp_ipc_ept_priv_data *priv_data = priv;
+
+	if (len == INTEL_ADSP_IPC_CB_MSG) {
+		const struct intel_adsp_ipc_msg *msg = data;
 
-	k_spinlock_key_t key;
+		struct ipc *ipc = priv_data->priv;
 
-	key = k_spin_lock(&ipc->lock);
+		k_spinlock_key_t key;
 
-	g_last_data = data;
-	g_last_ext_data = ext_data;
+		key = k_spin_lock(&ipc->lock);
+
+		g_last_data = msg->data;
+		g_last_ext_data = msg->ext_data;
 
 #if CONFIG_DEBUG_IPC_COUNTERS
-	increment_ipc_received_counter();
+		increment_ipc_received_counter();
 #endif
-	ipc_schedule_process(ipc);
+		ipc_schedule_process(ipc);
 
-	k_spin_unlock(&ipc->lock, key);
+		k_spin_unlock(&ipc->lock, key);
 
-	return false;
+		priv_data->cb_ret = -1;
+	} else if (len == INTEL_ADSP_IPC_CB_DONE) {
+		if (wait_ack_sem)
+			k_sem_give(wait_ack_sem);
+
+		priv_data->cb_ret = INTEL_ADSP_IPC_CB_RET_OKAY;
+	}
+}
+
+static struct ipc_ept ipc_ept;
+static struct intel_adsp_ipc_ept_priv_data ipc_ept_priv_data;
+static struct ipc_ept_cfg ipc_ept_cfg = {
+	.name = "sof_ipc",
+	.cb = {
+		.received = ipc_receive_cb,
+	},
+	.priv = &ipc_ept_priv_data,
+};
+
+static void ipc_ept_init(struct ipc *ipc)
+{
+	const struct device *ipc_dev = INTEL_ADSP_IPC_HOST_DEV;
+
+	ipc_ept_priv_data.priv = ipc;
+
+	ipc_service_register_endpoint(ipc_dev, &ipc_ept, &ipc_ept_cfg);
+}
+
+static void ipc_complete(void)
+{
+	ipc_service_send(&ipc_ept, NULL, INTEL_ADSP_IPC_SEND_DONE);
+}
+
+static bool ipc_is_complete(void)
+{
+	return ipc_service_send(&ipc_ept, NULL, INTEL_ADSP_IPC_SEND_IS_COMPLETE) == 0;
+}
+
+static int ipc_send_message(uint32_t data, uint32_t ext_data)
+{
+	struct intel_adsp_ipc_msg msg = {.data = data, .ext_data = ext_data};
+
+	return ipc_service_send(&ipc_ept, &msg, INTEL_ADSP_IPC_SEND_MSG);
+}
+
+void ipc_send_message_emergency(uint32_t data, uint32_t ext_data)
+{
+	struct intel_adsp_ipc_msg msg = {.data = data, .ext_data = ext_data};
+
+	ipc_service_send(&ipc_ept, &msg, INTEL_ADSP_IPC_SEND_MSG_EMERGENCY);
 }
 
 #ifdef CONFIG_PM_DEVICE
@@ -159,8 +218,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
@@ -254,7 +313,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();
@@ -263,26 +322,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)
@@ -300,8 +359,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);
@@ -312,22 +372,32 @@ int platform_ipc_init(struct ipc *ipc)
 	return 0;
 }
 
+#ifdef CONFIG_INTEL_ADSP_IPC_OLD_INTERFACE
 static bool ipc_wait_complete(const struct device *dev, void *arg)
 {
 	k_sem_give(arg);
 	return false;
 }
+#endif
 
 void ipc_platform_wait_ack(struct ipc *ipc)
 {
 	static struct k_sem ipc_wait_sem;
 
 	k_sem_init(&ipc_wait_sem, 0, 1);
 
+#ifdef CONFIG_INTEL_ADSP_IPC_OLD_INTERFACE
 	intel_adsp_ipc_set_done_handler(INTEL_ADSP_IPC_HOST_DEV, ipc_wait_complete, &ipc_wait_sem);
+#else
+	wait_ack_sem = &ipc_wait_sem;
+#endif
 
 	if (k_sem_take(&ipc_wait_sem, Z_TIMEOUT_MS(10)) == -EAGAIN)
 		tr_err(&ipc_tr, "Timeout waiting for host ack!");
 
+#ifdef CONFIG_INTEL_ADSP_IPC_OLD_INTERFACE
 	intel_adsp_ipc_set_done_handler(INTEL_ADSP_IPC_HOST_DEV, NULL, NULL);
+#else
+	wait_ack_sem = NULL;
+#endif
 }

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)