ref(drivers/mailbox): flatten mbox APIs to support protocol agnosticism

Signed-off-by: puranikvinit <kvp933.vinit@gmail.com>

Author: puranikvinit

src/platform/drivers/mailbox/inc/drivers/k3_sec_proxy.h

@@ -67,15 +67,6 @@ typedef enum {
 #define MBOX_K3_SEC_PROXY_DATA_START_OFFSET (0x4U)
 #define MBOX_K3_SEC_PROXY_DATA_END_OFFSET (0x3CU) /* completion trigger offset */
 
-/**
- * @brief Structure representing a message to be sent or received via Secure
- * Proxy.
- */
-typedef struct {
-    size_t len;       /**< Length of the message in bytes */
-    uint32_t *buffer; /**< Pointer to the message data buffer */
-} mbox_k3_sec_proxy_msg;
-
 /**
  * @brief Hardware configuration for a Secure Proxy instance.
  */
@@ -167,21 +158,27 @@ typedef struct {
 extern mbox_k3_sec_proxy_desc sec_proxy_desc;
 
 /**
- * @brief Verifies the status and configuration of a Secure Proxy thread.
+ * @brief Verifies the status and configuration of a Secure Proxy thread before
+ * a transaction.
+ *
+ * @desc This function checks for thread corruption, validates the thread's
+ * configured direction (read/write) against its intended usage, and ensures the
+ * message queue is not empty if reading.
  *
  * @param thread_id The ID of the thread to verify.
  * @param msg_drxn Expected message direction (MSG_DRXN_READ or MSG_DRXN_WRITE).
  *
- * @return int32_t STATUS_CODE_NO_ERROR on success, or respective error codes
- * on failure.
+ * @return int32_t STATUS_CODE_NO_ERROR if the thread is valid and ready,
+ * otherwise respective error codes.
  */
 int32_t mbox_k3_sec_proxy_verify_thread(uint8_t thread_id, uint8_t msg_drxn);
 
 /**
  * @brief Reads a message from a specific Secure Proxy thread.
  *
  * @param thread_id The ID of the thread to read from.
- * @param msg Pointer to the structure where the read message will be stored.
+ * @param buffer Pointer to the buffer where the read message will be stored.
+ * @param len Length of the message to read in bytes.
  *
  * @return int32_t STATUS_CODE_NO_ERROR on success, or respective error codes
  * on failure.
@@ -191,13 +188,14 @@ int32_t mbox_k3_sec_proxy_verify_thread(uint8_t thread_id, uint8_t msg_drxn);
  * for little-endian.
  * - byte-ordering logic for trailing bytes assumes LSB-first memory layout.
  */
-int32_t mbox_k3_sec_proxy_read(uint8_t thread_id, mbox_k3_sec_proxy_msg *msg);
+int32_t mbox_k3_sec_proxy_read(uint8_t thread_id, void* buffer, size_t len);
 
 /**
  * @brief Writes a message to a specific Secure Proxy thread.
  *
  * @param thread_id The ID of the thread to write to.
- * @param msg Pointer to the structure containing the message to send.
+ * @param buffer Pointer to the buffer containing the message to send.
+ * @param len Length of the message to send in bytes.
  *
  * @return int32_t STATUS_CODE_NO_ERROR on success, or an error code on
  * failure.
@@ -207,7 +205,7 @@ int32_t mbox_k3_sec_proxy_read(uint8_t thread_id, mbox_k3_sec_proxy_msg *msg);
  * for little-endian.
  * - byte-ordering logic for trailing bytes assumes LSB-first memory layout.
  */
-int32_t mbox_k3_sec_proxy_write(uint8_t thread_id, mbox_k3_sec_proxy_msg *msg);
+int32_t mbox_k3_sec_proxy_write(uint8_t thread_id, void* buffer, size_t len);
 
 /**
  * @brief Clears all pending messages from a Secure Proxy thread.

src/platform/drivers/mailbox/k3_sec_proxy.c

@@ -30,20 +30,6 @@ static inline void write_reg(paddr_t addr, paddr_t offset, uint32_t value)
     *((volatile uint32_t*)((paddr_t)(addr + offset))) = value;
 }
 
-/**
- * @brief Verifies the status and configuration of a Secure Proxy thread before
- * a transaction.
- *
- * @desc This function checks for thread corruption, validates the thread's
- * configured direction (read/write) against its intended usage, and ensures the
- * message queue is not empty if reading.
- *
- * @param thread_id The ID of the thread to verify.
- * @param msg_drxn Expected message direction (MSG_DRXN_READ or MSG_DRXN_WRITE).
- *
- * @return int32_t STATUS_CODE_NO_ERROR if the thread is valid and ready,
- * otherwise respective error codes.
- */
 int32_t mbox_k3_sec_proxy_verify_thread(uint8_t thread_id, uint8_t msg_drxn)
 {
     paddr_t thread_rt_base =
@@ -108,7 +94,7 @@ int32_t mbox_k3_sec_proxy_verify_thread(uint8_t thread_id, uint8_t msg_drxn)
  * |    not reached yet      |       +------------------------------------+
  * +-------------------------+
  */
-int32_t mbox_k3_sec_proxy_read(uint8_t thread_id, mbox_k3_sec_proxy_msg* msg)
+int32_t mbox_k3_sec_proxy_read(uint8_t thread_id, void* buffer, size_t len)
 {
     /* verify thread status */
     int32_t read_status = mbox_k3_sec_proxy_verify_thread(thread_id, MSG_DRXN_READ);
@@ -123,20 +109,19 @@ int32_t mbox_k3_sec_proxy_read(uint8_t thread_id, mbox_k3_sec_proxy_msg* msg)
 
     /* read whole words first */
     uint32_t word_iterator;
-    size_t num_words = msg->len / sizeof(uint32_t);
+    size_t num_words = len / sizeof(uint32_t);
     for (word_iterator = 0; word_iterator < num_words; word_iterator++) {
-        ((uint32_t*)msg->buffer)[word_iterator] =
-            read_reg(data_reg, word_iterator * sizeof(uint32_t));
+        ((uint32_t*)buffer)[word_iterator] = read_reg(data_reg, word_iterator * sizeof(uint32_t));
     }
 
     /* read remaining bytes */
-    uint32_t trail_bytes = msg->len % sizeof(uint32_t);
+    uint32_t trail_bytes = len % sizeof(uint32_t);
     if (0 != trail_bytes) {
         uint32_t data_trail = read_reg(data_reg, word_iterator++ * sizeof(uint32_t));
 
-        size_t trail_iterator = msg->len - trail_bytes;
+        size_t trail_iterator = len - trail_bytes;
         while (trail_bytes--) {
-            ((uint8_t*)msg->buffer)[trail_iterator++] = (uint8_t)(data_trail & 0xFFU);
+            ((uint8_t*)buffer)[trail_iterator++] = (uint8_t)(data_trail & 0xFFU);
             data_trail >>= 8;
         }
     }
@@ -183,7 +168,7 @@ int32_t mbox_k3_sec_proxy_read(uint8_t thread_id, mbox_k3_sec_proxy_msg* msg)
  * |    end offset (trigger) |       +------------------------------------+
  * +-------------------------+
  */
-int32_t mbox_k3_sec_proxy_write(uint8_t thread_id, mbox_k3_sec_proxy_msg* msg)
+int32_t mbox_k3_sec_proxy_write(uint8_t thread_id, void* buffer, size_t len)
 {
     /* verify thread status */
     int32_t write_status = mbox_k3_sec_proxy_verify_thread(thread_id, MSG_DRXN_WRITE);
@@ -193,7 +178,7 @@ int32_t mbox_k3_sec_proxy_write(uint8_t thread_id, mbox_k3_sec_proxy_msg* msg)
     }
 
     /* msg len check */
-    if (msg->len > sec_proxy_desc.thread_inst.max_msg_size) {
+    if (len > sec_proxy_desc.thread_inst.max_msg_size) {
         ERROR("secure_proxy_thread_%d msg len exceeds limit", thread_id);
         return STATUS_CODE_INVALID_MSG_LEN;
     }
@@ -204,20 +189,19 @@ int32_t mbox_k3_sec_proxy_write(uint8_t thread_id, mbox_k3_sec_proxy_msg* msg)
 
     /* write whole words first */
     uint32_t word_iterator;
-    size_t num_words = msg->len / sizeof(uint32_t);
+    size_t num_words = len / sizeof(uint32_t);
     for (word_iterator = 0; word_iterator < num_words; word_iterator++) {
-        write_reg(data_reg, word_iterator * sizeof(uint32_t),
-            ((uint32_t*)msg->buffer)[word_iterator]);
+        write_reg(data_reg, word_iterator * sizeof(uint32_t), ((uint32_t*)buffer)[word_iterator]);
     }
 
     /* write remaining bytes */
-    uint32_t trail_bytes = msg->len % sizeof(uint32_t);
+    uint32_t trail_bytes = len % sizeof(uint32_t);
     if (0 != trail_bytes) {
         uint32_t data_trail = 0;
 
-        size_t trail_iterator = msg->len - trail_bytes;
+        size_t trail_iterator = len - trail_bytes;
         for (uint32_t i = 0; i < trail_bytes; i++) {
-            data_trail |= (uint32_t)((uint8_t*)msg->buffer)[trail_iterator++] << (i * 8);
+            data_trail |= (uint32_t)((uint8_t*)buffer)[trail_iterator++] << (i * 8);
         }
 
         write_reg(data_reg, word_iterator++ * sizeof(uint32_t), data_trail);
@@ -273,9 +257,6 @@ int32_t mbox_k3_sec_proxy_probe(uint8_t thread_id)
         sec_proxy_desc.thread_inst.scfg_base + MBOX_K3_SEC_PROXY_THREAD_OFFSET(thread_id);
     uint32_t config = read_reg(thread_scfg_base, MBOX_K3_SEC_PROXY_SCFG_THREAD_CTRL_OFFSET);
 
-    paddr_t thread_rt_base =
-        sec_proxy_desc.thread_inst.rt_base + MBOX_K3_SEC_PROXY_THREAD_OFFSET(thread_id);
-
     uint8_t hw_host = (config >> 8) & 0xFF;
     uint8_t expected_host = sec_proxy_desc.sec_proxy_thread_desc[thread_id].host_id;
 
@@ -287,19 +268,25 @@ int32_t mbox_k3_sec_proxy_probe(uint8_t thread_id)
     }
 
     /* [step-2] verify if thread is clean */
-    int32_t probe_status = mbox_k3_sec_proxy_verify_thread(thread_id, MSG_DRXN_WRITE);
-    if (STATUS_CODE_NO_ERROR != probe_status) {
-        INFO("sec_proxy_thread_%d probe failed (error_id=%d)", thread_id, probe_status);
-        return probe_status;
-    }
+    int32_t probe_status = mbox_k3_sec_proxy_verify_thread(thread_id,
+        sec_proxy_desc.sec_proxy_thread_desc[thread_id].msg_drxn);
 
-    if (0 !=
-        (read_reg(thread_rt_base, MBOX_K3_SEC_PROXY_RT_THREAD_STATUS_OFFSET) &
-            MBOX_K3_SEC_PROXY_RT_STATUS_CUR_CNT_MASK)) {
+    if (MSG_DRXN_READ == sec_proxy_desc.sec_proxy_thread_desc[thread_id].msg_drxn &&
+        STATUS_CODE_NO_ERROR == probe_status) {
         ERROR("secure_proxy_thread_%d probe failed (message queue not clean)", thread_id);
         return STATUS_CODE_DIRTY_HANDOFF;
     }
 
+    if (MSG_DRXN_READ == sec_proxy_desc.sec_proxy_thread_desc[thread_id].msg_drxn &&
+        STATUS_CODE_NO_DATA == probe_status) {
+        probe_status = STATUS_CODE_NO_ERROR;
+    }
+
+    if (STATUS_CODE_NO_ERROR != probe_status) {
+        INFO("sec_proxy_thread_%d probe failed (error_id=%d)", thread_id, probe_status);
+        return probe_status;
+    }
+
     /* [step-3] check pipeline health by pinging sysfw
      *
      * @notes