ipc: move IPC payload handling to IPC driver

Move responsibility to write and read the IPC message payload
to the Zephyr IPC driver.

This change allows to use SOF IPC client code with multiple hardware
backends and there's no assumption payload transport is a memory mapped
payload buffer is exposed via mailbox.h.

This depends on Zephyr commit TBD ("foo bar") that adds message
payload to the interface.

Signed-off-by: Kai Vehmanen <kai.vehmanen@linux.intel.com>

Author: kv2019i

src/ipc/ipc-zephyr.c

@@ -16,8 +16,8 @@
 #include <sof/ipc/common.h>
 
 #include <sof/ipc/schedule.h>
-#include <sof/lib/mailbox.h>
-#include <sof/lib/memory.h>
+#include <sof/lib/mailbox.h> /* for sw_regs with CONFIG_DEBUG_IPC_COUNTERS */
+#include <sof/lib/memory.h>  /* for sw_regs with CONFIG_DEBUG_IPC_COUNTERS */
 #if defined(CONFIG_PM)
 #include <sof/lib/cpu.h>
 #include <zephyr/pm/device.h>
@@ -61,7 +61,9 @@ LOG_MODULE_DECLARE(ipc, CONFIG_SOF_LOG_LEVEL);
  * Filled with content of TDR and TDD registers.
  * When IPC message is read fills ipc_cmd_hdr.
  */
-static uint32_t g_last_data, g_last_ext_data;
+static uint32_t g_last_data, g_last_ext_data, g_last_payload_length;
+
+static uint32_t *g_last_payload;
 
 struct k_sem *wait_ack_sem;
 
@@ -87,6 +89,8 @@ static void ipc_receive_cb(const void *data, size_t cb_type, void *priv)
 
 		g_last_data = msg->data;
 		g_last_ext_data = msg->ext_data;
+		g_last_payload = msg->payload;
+		g_last_payload_length = msg->payload_length;
 
 #if CONFIG_DEBUG_IPC_COUNTERS
 		increment_ipc_received_counter();
@@ -133,11 +137,9 @@ 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)
+static int ipc_send_message(struct intel_adsp_ipc_msg *msg)
 {
-	struct intel_adsp_ipc_msg msg = {.data = data, .ext_data = ext_data};
-
-	return ipc_service_send(&ipc_ept, &msg, INTEL_ADSP_IPC_SEND_MSG);
+	return ipc_service_send(&ipc_ept, msg, INTEL_ADSP_IPC_SEND_MSG);
 }
 
 void ipc_send_message_emergency(uint32_t data, uint32_t ext_data)
@@ -147,6 +149,11 @@ void ipc_send_message_emergency(uint32_t data, uint32_t ext_data)
 	ipc_service_send(&ipc_ept, &msg, INTEL_ADSP_IPC_SEND_MSG_EMERGENCY);
 }
 
+static void ipc_send_message_emergency_with_payload(struct intel_adsp_ipc_msg *msg)
+{
+	ipc_service_send(&ipc_ept, msg, INTEL_ADSP_IPC_SEND_MSG_EMERGENCY);
+}
+
 #ifdef CONFIG_PM_DEVICE
 /**
  * @brief IPC device suspend handler callback function.
@@ -325,43 +332,38 @@ int ipc_platform_send_msg(const struct ipc_msg *msg)
 	if (!ipc_is_complete())
 		return -EBUSY;
 
-	/* prepare the message and copy to mailbox */
 	struct ipc_cmd_hdr *hdr = ipc_prepare_to_send(msg);
-
-	if (msg->tx_size)
-		mailbox_dspbox_write(0, (uint32_t *)msg->tx_data, msg->tx_size);
-
-	return ipc_send_message(hdr->pri, hdr->ext);
+	struct intel_adsp_ipc_msg ipc_drv_msg = {
+		.data = hdr->pri,
+		.ext_data = hdr->ext,
+		.payload = (uintptr_t)msg->tx_data,
+		.payload_length = msg->tx_size
+	};
+
+	return ipc_send_message(&ipc_drv_msg);
 }
 
 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);
-
-	if (msg->tx_size)
-		mailbox_dspbox_write(0, (uint32_t *)msg->tx_data, msg->tx_size);
-
-	ipc_send_message_emergency(hdr->pri, hdr->ext);
+	struct intel_adsp_ipc_msg ipc_drv_msg = {
+		.data = hdr->pri,
+		.ext_data = hdr->ext,
+		.payload = (uintptr_t)msg->tx_data,
+		.payload_length = msg->tx_size
+	};
+
+	ipc_send_message_emergency_with_payload(&ipc_drv_msg);
 }
 
-uint32_t *ipc_access_msg_payload(size_t bytes)
+uint32_t *ipc_access_msg_payload(size_t __unused bytes)
 {
 	/*
-	 * TODO: intermediate step to put MAILBOX access here,
-	 *       this should be moved to Zephyr IPC driver
+	 * The IPC driver has flushed the
+	 * cache on payload buffer, so no action needed here.
 	 */
-	uint32_t *hostbox = (uint32_t*)MAILBOX_HOSTBOX_BASE;
-
-	/*
-	 * TODO: can we invalidate whole hostbox upon IPC reception
-	 *       and skip these calls doen when incrementally
-	 *       parsing the message until full length of payload
-	 *       is known
-	 */
-	dcache_invalidate_region((__sparse_force void __sparse_cache *)hostbox, bytes);
-
-	return hostbox;
+	return g_last_payload;
 }
 
 int ipc_platform_poll_is_host_ready(void)