Message-Id: <20250422-sip_svc_upstream-v1-3-088059190f31@altera.com>
Date: Tue, 22 Apr 2025 12:07:10 +0800
From: Mahesh Rao via B4 Relay <devnull+mahesh.rao.altera.com@...nel.org>
To: Dinh Nguyen <dinguyen@...nel.org>, Rob Herring <robh@...nel.org>, 
 Krzysztof Kozlowski <krzk+dt@...nel.org>, 
 Conor Dooley <conor+dt@...nel.org>, Mahesh Rao <mahesh.rao@...era.com>
Cc: linux-kernel@...r.kernel.org, devicetree@...r.kernel.org, 
 Matthew Gerlach <matthew.gerlach@...era.com>
Subject: [PATCH 3/7] firmware: stratix10-svc: Add initial support for
 asynchronous communication with Stratix 10 service channel

From: Mahesh Rao <mahesh.rao@...era.com>

This commit adds support for asynchronous communication
with the Stratix 10 service channel. It introduces
new definitions to enable asynchronous messaging to
the Secure Device Manager (SDM). The changes include
the adding/removing of asynchronous support to existing
channels, initializing/exit-cleanup of the new asynchronous
framework and sending/polling of messages to SDM.

The new public functions added are:
- stratix10_svc_add_async_client: Adds an client
        to the service channel.
- stratix10_svc_remove_async_client: Removes an
        asynchronous client from the service channel.
- stratix10_svc_async_send: Sends an asynchronous
        message to the SDM mailbox in EL3 secure firmware.
- stratix10_svc_async_poll: Polls the status of an
        asynchronous service request in EL3 secure firmware.
- stratix10_svc_async_done: Marks an asynchronous
        transaction as complete and free's up the
        resources.

These changes enhance the functionality of the
Stratix 10 service channel by allowing for more
efficient and flexible communication with the firmware.

Signed-off-by: Mahesh Rao <mahesh.rao@...era.com>
Reviewed-by: Matthew Gerlach <matthew.gerlach@...era.com>
---
 drivers/firmware/stratix10-svc.c                   | 646 ++++++++++++++++++++-
 include/linux/firmware/intel/stratix10-smc.h       |  24 +
 .../linux/firmware/intel/stratix10-svc-client.h    |  88 +++
 3 files changed, 755 insertions(+), 3 deletions(-)

diff --git a/drivers/firmware/stratix10-svc.c b/drivers/firmware/stratix10-svc.c
index f487b6a7ef7b7cf7fdb4b4132d7a92b601803d8a..e25493db074930dcc16964fbb427be7168a841e6 100644
--- a/drivers/firmware/stratix10-svc.c
+++ b/drivers/firmware/stratix10-svc.c
@@ -4,9 +4,11 @@
  * Copyright (C) 2025, Altera Corporation
  */
 
+#include <linux/atomic.h>
 #include <linux/completion.h>
 #include <linux/delay.h>
 #include <linux/genalloc.h>
+#include <linux/hashtable.h>
 #include <linux/io.h>
 #include <linux/kfifo.h>
 #include <linux/kthread.h>
@@ -44,6 +46,35 @@
 #define STRATIX10_RSU				"stratix10-rsu"
 #define INTEL_FCS				"intel-fcs"
 
+/*Maximum number of SDM client IDs.*/
+#define MAX_SDM_CLIENT_IDS 16
+/*Client ID for SIP Service Version 1.*/
+#define SIP_SVC_V1_CLIENT_ID 0x1
+/*Maximum number of SDM job IDs.*/
+#define MAX_SDM_JOB_IDS 16
+/*Number of bits used for asynchronous transaction hashing.*/
+#define ASYNC_TRX_HASH_BITS 3
+/*Total number of transactions-id's which is a combination of client id and job id.*/
+#define TOTAL_TRANSACTION_IDS (MAX_SDM_CLIENT_IDS * MAX_SDM_JOB_IDS)
+
+/*Minimum major version of the ATF for Asynchronous transactions.*/
+#define ASYNC_ATF_MINIMUM_MAJOR_VERSION 0x3
+/*Minimum minor version of the ATF for Asynchronous transactions.*/
+#define ASYNC_ATF_MINIMUM_MINOR_VERSION 0x0
+
+/*Macro to extract the job ID from a transaction ID.*/
+#define STRATIX10_GET_JOBID(transaction_id) ((transaction_id) & 0xf)
+/*Macro to set a transaction ID using a client ID and a transaction ID.*/
+#define STRATIX10_SET_TRANSACTIONID(clientid, transaction_id) \
+	((((clientid) & 0xf) << 4) | ((transaction_id) & 0xf))
+
+/* Macro to set a transaction ID for SIP SMC using the lower 8 bits of the transaction ID.*/
+#define STRATIX10_SIP_SMC_SET_TRANSACTIONID_X1(transaction_id) \
+	((transaction_id) & 0xff)
+
+/* Macro to get the SDM mailbox error status */
+#define STRATIX10_GET_SDM_STATUS_CODE(status) ((status) & 0x3ff)
+
 typedef void (svc_invoke_fn)(unsigned long, unsigned long, unsigned long,
 			     unsigned long, unsigned long, unsigned long,
 			     unsigned long, unsigned long,
@@ -64,7 +95,7 @@ struct stratix10_svc {
  * @sync_complete: state for a completion
  * @addr: physical address of shared memory block
  * @size: size of shared memory block
- * @invoke_fn: function to issue secure monitor or hypervisor call
+ * @invoke_fn: service clients to handle secure monitor or hypervisor calls
  *
  * This struct is used to save physical address and size of shared memory
  * block. The shared memory blocked is allocated by secure monitor software
@@ -122,6 +153,64 @@ struct stratix10_svc_data {
 	u64 arg[3];
 };
 
+/**
+ * struct stratix10_svc_async_handler - Asynchronous handler for Stratix 10 service layer
+ * @transaction_id: Unique identifier for the transaction
+ * @achan: Pointer to the asynchronous channel structure
+ * @cb_arg: Argument to be passed to the callback function
+ * @cb: Callback function to be called upon completion
+ * @msg: Pointer to the client message structure
+ * @next: Node in the hash list
+ *
+ * This structure is used to handle asynchronous transactions in the
+ * Stratix 10 service layer. It maintains the necessary information
+ * for processing and completing asynchronous requests.
+ */
+
+struct stratix10_svc_async_handler {
+	u8 transaction_id;
+	struct stratix10_async_chan *achan;
+	void *cb_arg;
+	async_callback_t cb;
+	struct stratix10_svc_client_msg *msg;
+	struct hlist_node next;
+	struct arm_smccc_1_2_regs res;
+};
+
+/**
+ * struct stratix10_async_chan - Structure representing an asynchronous channel
+ * @async_client_id: Unique client identifier for the asynchronous operation
+ * @job_id_pool: Pointer to the job ID pool associated with this channel
+ */
+
+struct stratix10_async_chan {
+	unsigned long async_client_id;
+	struct stratix10_sip_id_pool *job_id_pool;
+};
+
+/**
+ * struct stratix10_async_ctrl - Control structure for Stratix 10 asynchronous operations
+ * @initialized: Flag indicating whether the control structure has been initialized
+ * @invoke_fn: Function pointer for invoking Stratix 10 service calls to EL3 secure firmware
+ * @async_id_pool: Pointer to the ID pool used for asynchronous operations
+ * @common_achan_refcount: Atomic reference count for the common asynchronous channel usage
+ * @common_async_chan: Pointer to the common asynchronous channel structure
+ * @trx_list_wr_lock: Spinlock for protecting the transaction list write operations
+ * @trx_list: Hash table for managing asynchronous transactions
+ */
+
+struct stratix10_async_ctrl {
+	bool initialized;
+	void (*invoke_fn)(struct stratix10_async_ctrl *actrl,
+			  const struct arm_smccc_1_2_regs *args, struct arm_smccc_1_2_regs *res);
+	struct stratix10_sip_id_pool *async_id_pool;
+	atomic_t common_achan_refcount;
+	struct stratix10_async_chan *common_async_chan;
+	/* spinlock to protect the writes to trx_list hash table */
+	spinlock_t trx_list_wr_lock;
+	DECLARE_HASHTABLE(trx_list, ASYNC_TRX_HASH_BITS);
+};
+
 /**
  * struct stratix10_svc_controller - service controller
  * @dev: device
@@ -135,6 +224,7 @@ struct stratix10_svc_data {
  * @complete_status: state for completion
  * @svc_fifo_lock: protect access to service message data queue
  * @invoke_fn: function to issue secure monitor call or hypervisor call
+ * @actrl: async control structure
  *
  * This struct is used to create communication channels for service clients, to
  * handle secure monitor or hypervisor call.
@@ -151,6 +241,7 @@ struct stratix10_svc_controller {
 	struct completion complete_status;
 	spinlock_t svc_fifo_lock;
 	svc_invoke_fn *invoke_fn;
+	struct stratix10_async_ctrl actrl;
 };
 
 /**
@@ -159,15 +250,17 @@ struct stratix10_svc_controller {
  * @scl: pointer to service client which owns the channel
  * @name: service client name associated with the channel
  * @lock: protect access to the channel
+ * @async_chan: reference to asynchronous channel object for this channel
  *
- * This struct is used by service client to communicate with service layer, each
- * service client has its own channel created by service controller.
+ * This struct is used by service client to communicate with service layer.
+ * Each service client has its own channel created by service controller.
  */
 struct stratix10_svc_chan {
 	struct stratix10_svc_controller *ctrl;
 	struct stratix10_svc_client *scl;
 	char *name;
 	spinlock_t lock;
+	struct stratix10_async_chan *async_chan;
 };
 
 /**
@@ -1118,6 +1211,546 @@ struct stratix10_svc_chan *stratix10_svc_request_channel_byname(
 }
 EXPORT_SYMBOL_GPL(stratix10_svc_request_channel_byname);
 
+/**
+ * stratix10_svc_add_async_client - Add an asynchronous client to the Stratix10 service channel.
+ * @chan: Pointer to the Stratix10 service channel structure.
+ * @use_unique_clientid: Boolean flag indicating whether to use a unique client ID.
+ *
+ * This function adds an asynchronous client to the specified Stratix10 service channel.
+ * If the `use_unique_clientid` flag is set to true, a unique client ID is allocated for
+ * the asynchronous channel. Otherwise, a common asynchronous channel is used.
+ *
+ * Return: 0 on success, or a negative error code on failure:
+ *         -EINVAL if the channel is NULL or the async controller is not initialized.
+ *         -EALREADY if the async channel is already allocated.
+ *         -ENOMEM if memory allocation fails.
+ *         Other negative values if ID allocation fails.
+ */
+int stratix10_svc_add_async_client(struct stratix10_svc_chan *chan,
+				   bool use_unique_clientid)
+{
+	int ret = 0;
+	struct stratix10_async_chan *achan;
+
+	if (!chan)
+		return -EINVAL;
+
+	struct stratix10_svc_controller *ctrl = chan->ctrl;
+	struct stratix10_async_ctrl *actrl = &ctrl->actrl;
+
+	if (!actrl->initialized) {
+		dev_err(ctrl->dev, "Async controller not initialized\n");
+		return -EINVAL;
+	}
+
+	if (chan->async_chan) {
+		dev_err(ctrl->dev, "async channel already allocated\n");
+		return -EALREADY;
+	}
+
+	if (use_unique_clientid) {
+		achan = kzalloc(sizeof(*achan), GFP_KERNEL);
+		if (!achan)
+			return -ENOMEM;
+
+		achan->job_id_pool = stratix10_id_pool_create(MAX_SDM_JOB_IDS);
+		if (!achan->job_id_pool) {
+			dev_err(ctrl->dev, "Failed to create job id pool\n");
+			kfree(achan);
+			return -ENOMEM;
+		}
+
+		ret = stratix10_allocate_id(actrl->async_id_pool);
+		if (ret < 0) {
+			dev_err(ctrl->dev,
+				"Failed to allocate async client id\n");
+			stratix10_id_pool_destroy(achan->job_id_pool);
+			kfree(achan);
+			return ret;
+		}
+		achan->async_client_id = ret;
+		chan->async_chan = achan;
+	} else {
+		if (atomic_read(&actrl->common_achan_refcount) == 0) {
+			achan = kzalloc(sizeof(*achan), GFP_KERNEL);
+			if (!achan)
+				return -ENOMEM;
+
+			achan->job_id_pool =
+				stratix10_id_pool_create(MAX_SDM_JOB_IDS);
+			if (!achan->job_id_pool) {
+				dev_err(ctrl->dev,
+					"Failed to create job id pool\n");
+				kfree(achan);
+				return -ENOMEM;
+			}
+
+			ret = stratix10_allocate_id(actrl->async_id_pool);
+			if (ret < 0) {
+				dev_err(ctrl->dev,
+					"Failed to allocate async client id\n");
+				stratix10_id_pool_destroy(achan->job_id_pool);
+				kfree(achan);
+				return ret;
+			}
+			achan->async_client_id = ret;
+			actrl->common_async_chan = achan;
+			dev_info(ctrl->dev,
+				 "Common async channel allocated with id %ld\n",
+				 achan->async_client_id);
+		}
+		chan->async_chan = actrl->common_async_chan;
+		atomic_inc(&actrl->common_achan_refcount);
+	}
+
+	return 0;
+}
+EXPORT_SYMBOL_GPL(stratix10_svc_add_async_client);
+
+/**
+ * stratix10_svc_remove_async_client - Remove an asynchronous client from
+ *                                     the Stratix10 service channel.
+ * @chan: Pointer to the Stratix10 service channel structure.
+ *
+ * This function removes an asynchronous client associated with the given service channel.
+ * It checks if the channel and the asynchronous channel are valid, and then proceeds to
+ * decrement the reference count for the common asynchronous channel if applicable. If the
+ * reference count reaches zero, it destroys the job ID pool and deallocates the asynchronous
+ * client ID. For non-common asynchronous channels, it directly destroys the job ID pool,
+ * deallocates the asynchronous client ID, and frees the memory allocated for the asynchronous
+ * channel.
+ *
+ * Return: 0 on success, -EINVAL if the channel or asynchronous channel is invalid.
+ */
+int stratix10_svc_remove_async_client(struct stratix10_svc_chan *chan)
+{
+	if (!chan)
+		return -EINVAL;
+
+	struct stratix10_svc_controller *ctrl = chan->ctrl;
+	struct stratix10_async_ctrl *actrl = &ctrl->actrl;
+	struct stratix10_async_chan *achan = chan->async_chan;
+
+	if (!achan) {
+		dev_err(ctrl->dev, "async channel not allocated\n");
+		return -EINVAL;
+	}
+
+	if (achan == actrl->common_async_chan) {
+		atomic_dec(&actrl->common_achan_refcount);
+		if (atomic_read(&actrl->common_achan_refcount) == 0) {
+			stratix10_id_pool_destroy(achan->job_id_pool);
+			stratix10_deallocate_id(actrl->async_id_pool, achan->async_client_id);
+		}
+	} else {
+		stratix10_id_pool_destroy(achan->job_id_pool);
+		stratix10_deallocate_id(actrl->async_id_pool, achan->async_client_id);
+		kfree(achan);
+	}
+	chan->async_chan = NULL;
+
+	return 0;
+}
+EXPORT_SYMBOL_GPL(stratix10_svc_remove_async_client);
+
+/**
+ * stratix10_svc_async_send - Send an asynchronous message to the Stratix10 service
+ * @chan: Pointer to the service channel structure
+ * @msg: Pointer to the message to be sent
+ * @handler: Pointer to the handler for the asynchronous message used by caller for later reference.
+ * @cb: Callback function to be called upon completion
+ * @cb_arg: Argument to be passed to the callback function
+ *
+ * This function sends an asynchronous message to the SDM mailbox in EL3 secure
+ * firmware. It performs various checks and setups, including allocating a job ID,
+ * setting up the transaction ID and packaging it to El3 firmware.
+ * The function handles different commands by setting up the appropriate
+ * arguments for the SMC call. If the SMC call is successful, the handler
+ * is set up and the function returns 0. If the SMC call fails, appropriate
+ * error handling is performed along with cleanup of resources.
+ *
+ * Return: 0 on success,-EINVAL for invalid argument,-ENOMEM if memory is not available,
+ *         -EAGAIN if EL3 firmware is busy, -EBADF if the message is rejected
+ *         by EL3 firmware and -EIO on ther errors from EL3 firmware.
+ */
+int stratix10_svc_async_send(struct stratix10_svc_chan *chan, void *msg, void **handler,
+			     async_callback_t cb, void *cb_arg)
+{
+	struct stratix10_svc_client_msg *p_msg = (struct stratix10_svc_client_msg *)msg;
+	struct arm_smccc_1_2_regs args = { 0 }, res = { 0 };
+	struct stratix10_svc_async_handler *handle = NULL;
+	int ret = 0;
+
+	if (!chan || !msg || !handler)
+		return -EINVAL;
+
+	struct stratix10_async_chan *achan = chan->async_chan;
+	struct stratix10_svc_controller *ctrl = chan->ctrl;
+	struct stratix10_async_ctrl *actrl = &ctrl->actrl;
+
+	if (!actrl->initialized) {
+		dev_err(ctrl->dev, "Async controller not initialized\n");
+		return -EINVAL;
+	}
+
+	if (!achan) {
+		dev_err(ctrl->dev, "Async channel not allocated\n");
+		return -EINVAL;
+	}
+
+	handle =
+		kzalloc(sizeof(struct stratix10_svc_async_handler), GFP_KERNEL);
+	if (!handle)
+		return -ENOMEM;
+
+	ret = stratix10_allocate_id(achan->job_id_pool);
+	if (ret < 0) {
+		dev_err(ctrl->dev, "Failed to allocate job id\n");
+		kfree(handle);
+		return -ENOMEM;
+	}
+
+	handle->transaction_id =
+		STRATIX10_SET_TRANSACTIONID(achan->async_client_id, ret);
+	handle->cb = cb;
+	handle->msg = p_msg;
+	handle->cb_arg = cb_arg;
+	handle->achan = achan;
+
+	/*set the transaction jobid in args.a1*/
+	args.a1 =
+		STRATIX10_SIP_SMC_SET_TRANSACTIONID_X1(handle->transaction_id);
+
+	switch (p_msg->command) {
+	default:
+		dev_err(ctrl->dev, "Invalid command ,%d\n", p_msg->command);
+		ret = -EINVAL;
+		goto deallocate_id;
+	}
+
+	/**
+	 * There is a chance that during the execution of async_send() in one core,
+	 * an interrupt might be received in another core; to mitigate this we are
+	 * adding the handle to the DB and then send the smc call. If the smc call
+	 * is rejected or busy then we will deallocate the handle for the client
+	 * to retry again.
+	 */
+	spin_lock(&actrl->trx_list_wr_lock);
+	hash_add_rcu(actrl->trx_list, &handle->next, handle->transaction_id);
+	spin_unlock(&actrl->trx_list_wr_lock);
+	synchronize_rcu();
+
+	actrl->invoke_fn(actrl, &args, &res);
+
+	switch (res.a0) {
+	case INTEL_SIP_SMC_STATUS_OK:
+		dev_dbg(ctrl->dev,
+			"Async message sent with transaction_id 0x%02x\n",
+			handle->transaction_id);
+			*handler = handle;
+		return 0;
+	case INTEL_SIP_SMC_STATUS_BUSY:
+		dev_warn(ctrl->dev, "Mailbox is busy, try after some time\n");
+		ret = -EAGAIN;
+		break;
+	case INTEL_SIP_SMC_STATUS_REJECTED:
+		dev_err(ctrl->dev, "Async message rejected\n");
+		ret = -EBADF;
+		break;
+	default:
+		dev_err(ctrl->dev,
+			"Failed to send async message ,got status as %ld\n",
+			res.a0);
+		ret = -EIO;
+	}
+
+	spin_lock(&actrl->trx_list_wr_lock);
+	hash_del_rcu(&handle->next);
+	spin_unlock(&actrl->trx_list_wr_lock);
+	synchronize_rcu();
+
+deallocate_id:
+	stratix10_deallocate_id(achan->job_id_pool,
+				STRATIX10_GET_JOBID(handle->transaction_id));
+	kfree(handle);
+	return ret;
+}
+EXPORT_SYMBOL_GPL(stratix10_svc_async_send);
+
+/**
+ * stratix10_svc_async_prepare_response - Prepare the response data for an asynchronous transaction.
+ * @chan: Pointer to the service channel structure.
+ * @handle: Pointer to the asynchronous handler structure.
+ * @data: Pointer to the callback data structure.
+ *
+ * This function prepares the response data for an asynchronous transaction. It
+ * extracts the response data from the SMC response structure and stores it in
+ * the callback data structure. The function also logs the completion of the
+ * asynchronous transaction.
+ *
+ * Return: 0 on success, -ENOENT if the command is invalid
+ */
+static int stratix10_svc_async_prepare_response(struct stratix10_svc_chan *chan,
+						struct stratix10_svc_async_handler *handle,
+						struct stratix10_svc_cb_data *data)
+{
+	struct stratix10_svc_client_msg *p_msg =
+		(struct stratix10_svc_client_msg *)handle->msg;
+	struct stratix10_svc_controller *ctrl = chan->ctrl;
+
+	data->status = STRATIX10_GET_SDM_STATUS_CODE(handle->res.a1);
+
+	switch (p_msg->command) {
+	default:
+		dev_alert(ctrl->dev, "Invalid command\n ,%d", p_msg->command);
+		return -ENOENT;
+	}
+	dev_dbg(ctrl->dev, "Async message completed transaction_id 0x%02x\n",
+		handle->transaction_id);
+	return 0;
+}
+
+/**
+ * stratix10_svc_async_poll - Polls the status of an asynchronous transaction.
+ * @chan: Pointer to the service channel structure.
+ * @tx_handle: Handle to the transaction being polled.
+ * @data: Pointer to the callback data structure.
+ *
+ * This function polls the status of an asynchronous transaction identified by the
+ * given transaction handle. It ensures that the necessary structures are initialized
+ * and valid before proceeding with the poll operation. The function sets up the
+ * necessary arguments for the SMC call, invokes the call, and prepares the response
+ * data if the call is successful. If the call fails, the function returns
+ * the error mapped the SVC status error.
+ *
+ * Return: 0 on success, -EINVAL if any input parameter is invalid, -EAGAIN if the
+ *         transaction is still in progress,-EPERM if the command is invalid.
+ *         or other negative error codes on failure.
+ */
+int stratix10_svc_async_poll(struct stratix10_svc_chan *chan, void *tx_handle,
+			     struct stratix10_svc_cb_data *data)
+{
+	int ret;
+	struct arm_smccc_1_2_regs args = { 0 };
+
+	if (!chan || !tx_handle || !data)
+		return -EINVAL;
+
+	struct stratix10_svc_controller *ctrl = chan->ctrl;
+	struct stratix10_async_ctrl *actrl = &ctrl->actrl;
+	struct stratix10_async_chan *achan = chan->async_chan;
+
+	if (!achan) {
+		dev_err(ctrl->dev, "Async channel not allocated\n");
+		return -EINVAL;
+	}
+
+	struct stratix10_svc_async_handler *handle =
+		(struct stratix10_svc_async_handler *)tx_handle;
+	if (!hash_hashed(&handle->next)) {
+		dev_err(ctrl->dev, "Invalid transaction handler\n");
+		return -EINVAL;
+	}
+
+	args.a0 = INTEL_SIP_SMC_ASYNC_POLL;
+	args.a1 =
+		STRATIX10_SIP_SMC_SET_TRANSACTIONID_X1(handle->transaction_id);
+
+	actrl->invoke_fn(actrl, &args, &handle->res);
+
+	data->status = 0;
+	if (handle->res.a0 == INTEL_SIP_SMC_STATUS_OK) {
+		ret = stratix10_svc_async_prepare_response(chan, handle, data);
+		if (ret) {
+			dev_err(ctrl->dev, "Error in preparation of response,%d\n", ret);
+			WARN_ON_ONCE(1);
+		}
+		return 0;
+	} else if (handle->res.a0 == INTEL_SIP_SMC_STATUS_BUSY) {
+		dev_dbg(ctrl->dev, "async message is still in progress\n");
+		return -EAGAIN;
+	}
+
+	dev_err(ctrl->dev,
+		"Failed to poll async message ,got status as %ld\n",
+		handle->res.a0);
+	return -EINVAL;
+}
+EXPORT_SYMBOL_GPL(stratix10_svc_async_poll);
+
+/**
+ * stratix10_svc_async_done - Completes an asynchronous transaction.
+ * @chan: Pointer to the service channel structure.
+ * @tx_handle: Handle to the transaction being completed.
+ *
+ * This function completes an asynchronous transaction identified by the given
+ * transaction handle. It ensures that the necessary structures are initialized
+ * and valid before proceeding with the completion operation. The function
+ * deallocates the transaction ID, frees the memory allocated for the handler,
+ * and removes the handler from the transaction list.
+ *
+ * Return: 0 on success, -EINVAL if any input parameter is invalid, or other
+ *         negative error codes on failure.
+ */
+int stratix10_svc_async_done(struct stratix10_svc_chan *chan, void *tx_handle)
+{
+	if (!chan || !tx_handle)
+		return -EINVAL;
+
+	struct stratix10_svc_controller *ctrl = chan->ctrl;
+	struct stratix10_async_chan *achan = chan->async_chan;
+
+	if (!achan) {
+		dev_err(ctrl->dev, "async channel not allocated\n");
+		return -EINVAL;
+	}
+
+	struct stratix10_svc_async_handler *handle =
+		(struct stratix10_svc_async_handler *)tx_handle;
+	if (!hash_hashed(&handle->next)) {
+		dev_err(ctrl->dev, "Invalid transaction handle\n");
+		return -EINVAL;
+	}
+
+	struct stratix10_async_ctrl *actrl = &ctrl->actrl;
+
+	spin_lock(&actrl->trx_list_wr_lock);
+	hash_del_rcu(&handle->next);
+	spin_unlock(&actrl->trx_list_wr_lock);
+	synchronize_rcu();
+	stratix10_deallocate_id(achan->job_id_pool,
+				STRATIX10_GET_JOBID(handle->transaction_id));
+	kfree(handle);
+	return 0;
+}
+EXPORT_SYMBOL_GPL(stratix10_svc_async_done);
+
+static inline void stratix10_smc_1_2(struct stratix10_async_ctrl *actrl,
+				     const struct arm_smccc_1_2_regs *args,
+				     struct arm_smccc_1_2_regs *res)
+{
+	arm_smccc_1_2_smc(args, res);
+}
+
+/**
+ * stratix10_svc_async_init - Initialize the Stratix 10 service controller
+ *                            for asynchronous operations.
+ * @controller: Pointer to the Stratix 10 service controller structure.
+ *
+ * This function initializes the asynchronous service controller by setting up
+ * the necessary data structures, initializing the transaction list, and
+ *
+ * Return: 0 on success, -EINVAL if the controller is NULL or already initialized,
+ *         -ENOMEM if memory allocation fails, -EADDRINUSE if the client ID is already
+ *         reserved, or other negative error codes on failure.
+ */
+static int stratix10_svc_async_init(struct stratix10_svc_controller *controller)
+{
+	int ret;
+	struct arm_smccc_res res;
+
+	if (!controller)
+		return -EINVAL;
+
+	struct stratix10_async_ctrl *actrl = &controller->actrl;
+
+	if (actrl->initialized)
+		return -EINVAL;
+
+	struct device *dev = controller->dev;
+
+	controller->invoke_fn(INTEL_SIP_SMC_SVC_VERSION, 0, 0, 0, 0, 0, 0, 0, &res);
+	if (res.a0 != INTEL_SIP_SMC_STATUS_OK &&
+	    !(res.a1 > ASYNC_ATF_MINIMUM_MAJOR_VERSION ||
+	      (res.a1 == ASYNC_ATF_MINIMUM_MAJOR_VERSION &&
+	       res.a2 >= ASYNC_ATF_MINIMUM_MINOR_VERSION))) {
+		dev_err(dev,
+			"Intel Service Layer Driver: ATF version is not compatible for async operation\n");
+		return -EINVAL;
+	}
+
+	actrl->invoke_fn = stratix10_smc_1_2;
+
+	actrl->async_id_pool = stratix10_id_pool_create(MAX_SDM_CLIENT_IDS);
+	if (!actrl->async_id_pool)
+		return -ENOMEM;
+
+	/**
+	 * SIP_SVC_V1_CLIENT_ID is used by V1 clients/stratix10_svc_send()
+	 * for communicating with SDM synchronously. We need to restrict this
+	 * in V3 usage to distinguish the V1 and V3 messages in El3 firmware.
+	 */
+	ret = stratix10_reserve_id(actrl->async_id_pool, SIP_SVC_V1_CLIENT_ID);
+	if (ret < 0) {
+		dev_err(dev,
+			"Intel Service Layer Driver: Error on reserving SIP_SVC_V1_CLIENT_ID\n");
+		stratix10_id_pool_destroy(actrl->async_id_pool);
+		actrl->invoke_fn = NULL;
+		return -EADDRINUSE;
+	}
+
+	spin_lock_init(&actrl->trx_list_wr_lock);
+	hash_init(actrl->trx_list);
+	atomic_set(&actrl->common_achan_refcount, 0);
+
+	actrl->initialized = true;
+	return 0;
+}
+
+/**
+ * stratix10_svc_async_exit - Clean up and exit the asynchronous service controller
+ * @ctrl: Pointer to the stratix10_svc_controller structure
+ *
+ * This function performs the necessary cleanup for the asynchronous service
+ * controller. It checks if the controller is valid and if it has been
+ * initialized. If the controller has an IRQ assigned, it frees the IRQ and
+ * flushes any pending asynchronous work. It then locks the transaction list
+ * and safely removes and deallocates each handler in the list. The function
+ * also removes any asynchronous clients associated with the controller's
+ * channels and destroys the asynchronous ID pool. Finally, it resets the
+ * asynchronous ID pool and invoke function pointers to NULL.
+ *
+ * Return: 0 on success, -EINVAL if the controller is invalid or not initialized.
+ */
+static int stratix10_svc_async_exit(struct stratix10_svc_controller *ctrl)
+{
+	int i;
+	struct hlist_node *tmp;
+	struct stratix10_svc_async_handler *handler;
+
+	if (!ctrl)
+		return -EINVAL;
+
+	struct stratix10_async_ctrl *actrl = &ctrl->actrl;
+
+	if (!actrl->initialized)
+		return -EINVAL;
+
+	actrl->initialized = false;
+
+	spin_lock(&actrl->trx_list_wr_lock);
+	hash_for_each_safe(actrl->trx_list, i, tmp, handler, next) {
+		stratix10_deallocate_id(handler->achan->job_id_pool,
+					STRATIX10_GET_JOBID(handler->transaction_id));
+		hash_del_rcu(&handler->next);
+		kfree(handler);
+	}
+	spin_unlock(&actrl->trx_list_wr_lock);
+
+	for (i = 0; i < SVC_NUM_CHANNEL; i++) {
+		if (ctrl->chans[i].async_chan) {
+			stratix10_svc_remove_async_client(&ctrl->chans[i]);
+			ctrl->chans[i].async_chan = NULL;
+		}
+	}
+
+	stratix10_id_pool_destroy(actrl->async_id_pool);
+	actrl->async_id_pool = NULL;
+	actrl->invoke_fn = NULL;
+
+	return 0;
+}
+
 /**
  * stratix10_svc_free_channel() - free service channel
  * @chan: service channel to be freed
@@ -1380,6 +2013,11 @@ static int stratix10_svc_drv_probe(struct platform_device *pdev)
 	controller->invoke_fn = invoke_fn;
 	init_completion(&controller->complete_status);
 
+	ret = stratix10_svc_async_init(controller);
+	if (ret)
+		dev_dbg(dev, "Intel Service Layer Driver: Error on stratix10_svc_async_init %d\n",
+			ret);
+
 	fifo_size = sizeof(struct stratix10_svc_data) * SVC_NUM_DATA_IN_FIFO;
 	ret = kfifo_alloc(&controller->svc_fifo, fifo_size, GFP_KERNEL);
 	if (ret) {
@@ -1465,6 +2103,8 @@ static void stratix10_svc_drv_remove(struct platform_device *pdev)
 	struct stratix10_svc *svc = dev_get_drvdata(&pdev->dev);
 	struct stratix10_svc_controller *ctrl = platform_get_drvdata(pdev);
 
+	stratix10_svc_async_exit(ctrl);
+
 	of_platform_depopulate(ctrl->dev);
 
 	platform_device_unregister(svc->intel_svc_fcs);
diff --git a/include/linux/firmware/intel/stratix10-smc.h b/include/linux/firmware/intel/stratix10-smc.h
index ee80ca4bb0d0c6d3aa99aeeca6a4980a315dcc43..c98ed992d23bed5aa344868ca0c77a2d19d94c06 100644
--- a/include/linux/firmware/intel/stratix10-smc.h
+++ b/include/linux/firmware/intel/stratix10-smc.h
@@ -1,6 +1,7 @@
 /* SPDX-License-Identifier: GPL-2.0 */
 /*
  * Copyright (C) 2017-2018, Intel Corporation
+ * Copyright (C) 2025, Altera Corporation
  */
 
 #ifndef __STRATIX10_SMC_H
@@ -47,6 +48,10 @@
 	ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, ARM_SMCCC_SMC_64, \
 	ARM_SMCCC_OWNER_SIP, (func_num))
 
+#define INTEL_SIP_SMC_ASYNC_VAL(func_name)	\
+	ARM_SMCCC_CALL_VAL(ARM_SMCCC_STD_CALL, ARM_SMCCC_SMC_64, \
+	ARM_SMCCC_OWNER_SIP, (func_name))
+
 /**
  * Return values in INTEL_SIP_SMC_* call
  *
@@ -620,4 +625,23 @@ INTEL_SIP_SMC_FAST_CALL_VAL(INTEL_SIP_SMC_FUNCID_FPGA_CONFIG_COMPLETED_WRITE)
 #define INTEL_SIP_SMC_FCS_GET_PROVISION_DATA \
 	INTEL_SIP_SMC_FAST_CALL_VAL(INTEL_SIP_SMC_FUNCID_FCS_GET_PROVISION_DATA)
 
+/**
+ * Request INTEL_SIP_SMC_ASYNC_POLL
+ * Async call used by service driver at EL1 to query mailbox response from SDM.
+ *
+ * Call register usage:
+ * a0 INTEL_SIP_SMC_ASYNC_POLL
+ * a1 transaction job id
+ * a2-17 will be used to return the response data
+ *
+ * Return status
+ * a0 INTEL_SIP_SMC_STATUS_OK
+ * a1-17 will contain the response values from mailbox for the previous send transaction
+ * Or
+ * a0 INTEL_SIP_SMC_STATUS_NO_RESPONSE
+ * a1-17 not used
+ */
+#define INTEL_SIP_SMC_ASYNC_FUNC_ID_POLL (0xC8)
+#define INTEL_SIP_SMC_ASYNC_POLL \
+	INTEL_SIP_SMC_ASYNC_VAL(INTEL_SIP_SMC_ASYNC_FUNC_ID_POLL)
 #endif
diff --git a/include/linux/firmware/intel/stratix10-svc-client.h b/include/linux/firmware/intel/stratix10-svc-client.h
index 60ed82112680e3674b6b7e9852d315922ffff33e..bda837815bae35fbf4df6280dba5bc02d747426e 100644
--- a/include/linux/firmware/intel/stratix10-svc-client.h
+++ b/include/linux/firmware/intel/stratix10-svc-client.h
@@ -1,6 +1,7 @@
 /* SPDX-License-Identifier: GPL-2.0 */
 /*
  * Copyright (C) 2017-2018, Intel Corporation
+ * Copyright (C) 2025, Altera Corporation
  */
 
 #ifndef __STRATIX10_SVC_CLIENT_H
@@ -284,5 +285,92 @@ int stratix10_svc_send(struct stratix10_svc_chan *chan, void *msg);
  * request process.
  */
 void stratix10_svc_done(struct stratix10_svc_chan *chan);
+
+/**
+ * typedef async_callback_t - A type definition for an asynchronous callback function.
+ *
+ * This type defines a function pointer for an asynchronous callback.
+ * The callback function takes a single argument, which is a pointer to
+ * user-defined data.
+ *
+ * @param cb_arg A pointer to user-defined data passed to the callback function.
+ */
+typedef void (*async_callback_t)(void *cb_arg);
+
+/**
+ * stratix10_svc_add_async_client - Add an asynchronous client to a Stratix 10
+ *                                  service channel.
+ * @chan: Pointer to the Stratix 10 service channel structure.
+ * @use_unique_clientid: Boolean flag indicating whether to use a unique client ID.
+ *
+ * This function registers an asynchronous client with the specified Stratix 10
+ * service channel. If the use_unique_clientid flag is set to true, a unique client
+ * ID will be assigned to the client.
+ *
+ * Return: 0 on success, or a negative error code on failure:
+ *         -EINVAL if the channel is NULL or the async controller is not initialized.
+ *         -EALREADY if the async channel is already allocated.
+ *         -ENOMEM if memory allocation fails.
+ *         Other negative values if ID allocation fails
+ */
+int stratix10_svc_add_async_client(struct stratix10_svc_chan *chan, bool use_unique_clientid);
+
+/**
+ * stratix10_svc_remove_async_client - Remove an asynchronous client from the Stratix 10
+ *                                     service channel.
+ * @chan: Pointer to the Stratix 10 service channel structure.
+ *
+ * This function removes an asynchronous client from the specified Stratix 10 service channel.
+ * It is typically used to clean up and release resources associated with the client.
+ *
+ * Return: 0 on success, -EINVAL if the channel or asynchronous channel is invalid.
+ */
+int stratix10_svc_remove_async_client(struct stratix10_svc_chan *chan);
+
+/**
+ * stratix10_svc_async_send - Send an asynchronous message to the SDM mailbox
+ *                            in EL3 secure firmware.
+ * @chan: Pointer to the service channel structure.
+ * @msg: Pointer to the message to be sent.
+ * @handler: Pointer to the handler object used by caller to track the transaction.
+ * @cb: Callback function to be called upon completion.
+ * @cb_arg: Argument to be passed to the callback function.
+ *
+ * This function sends a message asynchronously to the SDM mailbox in EL3 secure firmware.
+ * and registers a callback function to be invoked when the operation completes.
+ *
+ * Return: 0 on success,and negative error codes on failure.
+ */
+int stratix10_svc_async_send(struct stratix10_svc_chan *chan, void *msg, void **handler,
+			     async_callback_t cb, void *cb_arg);
+
+/**
+ * stratix10_svc_async_poll - Polls the status of an asynchronous service request.
+ * @chan: Pointer to the service channel structure.
+ * @tx_handle: Handle to the transaction being polled.
+ * @data: Pointer to the callback data structure to be filled with the result.
+ *
+ * This function checks the status of an asynchronous service request
+ * and fills the provided callback data structure with the result.
+ *
+ * Return: 0 on success, -EINVAL if any input parameter is invalid or if the
+ *         async controller is not initialized, -EAGAIN if the transaction is
+ *         still in progress, or other negative error codes on failure.
+ */
+int stratix10_svc_async_poll(struct stratix10_svc_chan *chan, void *tx_handle,
+			     struct stratix10_svc_cb_data *data);
+
+/**
+ * stratix10_svc_async_done - Complete an asynchronous transaction
+ * @chan: Pointer to the service channel structure
+ * @tx_handle: Pointer to the transaction handle
+ *
+ * This function completes an asynchronous transaction by removing the
+ * transaction from the hash table and deallocating the associated resources.
+ *
+ * Return: 0 on success, -EINVAL on invalid input or errors.
+ */
+int stratix10_svc_async_done(struct stratix10_svc_chan *chan, void *tx_handle);
+
 #endif
 

-- 
2.35.3

Powered by blists - more mailing lists