Twincpu: Add multi-core topology mailbox data types and APIs
Add NSPE and SPE data types, NSPE mailbox APIs and SPE mailbox APIs
declarations.
The implementations are based on design document [1].
[1]: https://developer.trustedfirmware.org/w/tf_m/design/twin-cpu/general_mailbox_design/
Change-Id: I4678ec669a8054a8834faecbd9be0397f04f5812
Signed-off-by: David Hu <david.hu@arm.com>
diff --git a/interface/include/tfm_ns_mailbox.h b/interface/include/tfm_ns_mailbox.h
new file mode 100644
index 0000000..9beb509
--- /dev/null
+++ b/interface/include/tfm_ns_mailbox.h
@@ -0,0 +1,96 @@
+/*
+ * Copyright (c) 2019, Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ */
+
+/* API definitions in NSPE mailbox library */
+
+#ifndef __TFM_NS_MAILBOX_H__
+#define __TFM_NS_MAILBOX_H__
+
+#include <stdbool.h>
+#include "tfm_mailbox.h"
+
+/**
+ * \brief Prepare and send PSA client call request to SPE via mailbox.
+ *
+ * \param[in] call_type PSA client call type
+ * \param[in] params Parmaters used for PSA client call
+ * \param[in] client_id Optional client ID of non-secure caller.
+ * It is required to identify the non-secure caller
+ * when NSPE OS enforces non-secure task isolation.
+ *
+ * \retval >= 0 The handle to the mailbox message assigned.
+ * \retval < 0 Operation failed with an error code.
+ */
+mailbox_msg_handle_t mailbox_tx_client_call_req(uint32_t call_type,
+ const struct psa_client_params_t *params,
+ int32_t client_id);
+
+/**
+ * \brief Fetch PSA client call return result.
+ *
+ * \param[in] handle The handle to the mailbox message
+ * \param[out] reply The address to be written with return result.
+ *
+ * \retval MAILBOX_SUCCESS Successfully get PSA client call return result.
+ * \retval Other return code Operation failed with an error code.
+ */
+int32_t mailbox_rx_client_call_reply(mailbox_msg_handle_t handle,
+ int32_t *reply);
+
+/**
+ * \brief Check whether a specific mailbox message has been replied.
+ *
+ * \param[in] handle The handle to the mailbox message
+ *
+ * \retval true The PSA client call return value is replied.
+ * \retval false The PSA client call return value is not
+ * replied yet.
+ */
+bool mailbox_is_msg_replied(mailbox_msg_handle_t handle);
+
+/**
+ * \brief Notify SPE to deal with the PSA client call sent via mailbox
+ *
+ * \retval MAILBOX_SUCCESS Operation succeeded.
+ * \retval Other return code Operation failed with an error code.
+ */
+int32_t mailbox_notify_peer(void);
+
+/**
+ * \brief NSPE mailbox initialization
+ *
+ * \param[in] queue The base address of NSPE mailbox queue to be
+ * initialized.
+ *
+ * \retval MAILBOX_SUCCESS Operation succeeded.
+ * \retval Other return code Operation failed with an error code.
+ */
+int32_t mailbox_init(struct ns_mailbox_queue_t *queue);
+
+/**
+ * \brief Platform specific NSPE mailbox initialization.
+ * Invoked by \ref mailbox_init().
+ *
+ * \param[in] queue The base address of NSPE mailbox queue to be
+ * initialized.
+ *
+ * \retval MAILBOX_SUCCESS Operation succeeded.
+ * \retval Other return code Operation failed with an error code.
+ */
+int32_t mailbox_hal_init(struct ns_mailbox_queue_t *queue);
+
+/**
+ * \brief Enter critical section of NSPE mailbox
+ */
+void mailbox_enter_critical(void);
+
+/**
+ * \brief Exit critical section of NSPE mailbox
+ */
+void mailbox_exit_critical(void);
+
+#endif /* __TFM_NS_MAILBOX_H__ */