* [PATCH v2 1/7] firmware: stratix10-svc: Add mutex lock and unlock in stratix10 memory allocation/free
2025-05-12 11:39 [PATCH v2 0/7] stratix10: Add framework for asynchronous communication with SDM Mahesh Rao via B4 Relay
@ 2025-05-12 11:39 ` Mahesh Rao via B4 Relay
2025-05-12 11:39 ` [PATCH v2 2/7] firmware: stratix10-svc: Implement ID pool management for asynchronous operations Mahesh Rao via B4 Relay
` (5 subsequent siblings)
6 siblings, 0 replies; 16+ messages in thread
From: Mahesh Rao via B4 Relay @ 2025-05-12 11:39 UTC (permalink / raw)
To: Dinh Nguyen, Rob Herring, Krzysztof Kozlowski, Conor Dooley,
Mahesh Rao
Cc: Matthew Gerlach, linux-kernel, devicetree
From: Mahesh Rao <mahesh.rao@altera.com>
This commit adds a mutex lock to stratix10_svc_allocate_memory
and stratix10_svc_free_memory functions to ensure
thread safety when allocating and freeing memory.
This prevents potential race conditions and ensures
synchronization.
Signed-off-by: Mahesh Rao <mahesh.rao@altera.com>
Reviewed-by: Matthew Gerlach <matthew.gerlach@altera.com>
---
drivers/firmware/stratix10-svc.c | 29 ++++++++++++++++++++++-------
1 file changed, 22 insertions(+), 7 deletions(-)
diff --git a/drivers/firmware/stratix10-svc.c b/drivers/firmware/stratix10-svc.c
index e3f990d888d71829f0ab22b8a59aa7af0316bea0..3d42d4b18b7299d0a9e5110159e06253dfeddf88 100644
--- a/drivers/firmware/stratix10-svc.c
+++ b/drivers/firmware/stratix10-svc.c
@@ -1,6 +1,7 @@
// SPDX-License-Identifier: GPL-2.0
/*
* Copyright (C) 2017-2018, Intel Corporation
+ * Copyright (C) 2025, Altera Corporation
*/
#include <linux/completion.h>
@@ -171,6 +172,7 @@ struct stratix10_svc_chan {
static LIST_HEAD(svc_ctrl);
static LIST_HEAD(svc_data_mem);
+static DEFINE_MUTEX(svc_mem_lock);
/**
* svc_pa_to_va() - translate physical address to virtual address
@@ -182,14 +184,17 @@ static LIST_HEAD(svc_data_mem);
static void *svc_pa_to_va(unsigned long addr)
{
struct stratix10_svc_data_mem *pmem;
+ void *ret = NULL;
pr_debug("claim back P-addr=0x%016x\n", (unsigned int)addr);
+ mutex_lock(&svc_mem_lock);
list_for_each_entry(pmem, &svc_data_mem, node)
- if (pmem->paddr == addr)
- return pmem->vaddr;
-
- /* physical address is not found */
- return NULL;
+ if (pmem->paddr == addr) {
+ /* physical address is found */
+ ret = pmem->vaddr;
+ }
+ mutex_unlock(&svc_mem_lock);
+ return ret;
}
/**
@@ -990,13 +995,16 @@ int stratix10_svc_send(struct stratix10_svc_chan *chan, void *msg)
p_data->flag = ct->flags;
}
} else {
+ mutex_lock(&svc_mem_lock);
list_for_each_entry(p_mem, &svc_data_mem, node)
if (p_mem->vaddr == p_msg->payload) {
p_data->paddr = p_mem->paddr;
p_data->size = p_msg->payload_length;
break;
}
+ mutex_unlock(&svc_mem_lock);
if (p_msg->payload_output) {
+ mutex_lock(&svc_mem_lock);
list_for_each_entry(p_mem, &svc_data_mem, node)
if (p_mem->vaddr == p_msg->payload_output) {
p_data->paddr_output =
@@ -1005,6 +1013,7 @@ int stratix10_svc_send(struct stratix10_svc_chan *chan, void *msg)
p_msg->payload_length_output;
break;
}
+ mutex_unlock(&svc_mem_lock);
}
}
@@ -1072,9 +1081,12 @@ void *stratix10_svc_allocate_memory(struct stratix10_svc_chan *chan,
if (!pmem)
return ERR_PTR(-ENOMEM);
+ mutex_lock(&svc_mem_lock);
va = gen_pool_alloc(genpool, s);
- if (!va)
+ if (!va) {
+ mutex_unlock(&svc_mem_lock);
return ERR_PTR(-ENOMEM);
+ }
memset((void *)va, 0, s);
pa = gen_pool_virt_to_phys(genpool, va);
@@ -1086,6 +1098,7 @@ void *stratix10_svc_allocate_memory(struct stratix10_svc_chan *chan,
pr_debug("%s: va=%p, pa=0x%016x\n", __func__,
pmem->vaddr, (unsigned int)pmem->paddr);
+ mutex_unlock(&svc_mem_lock);
return (void *)va;
}
EXPORT_SYMBOL_GPL(stratix10_svc_allocate_memory);
@@ -1100,6 +1113,7 @@ EXPORT_SYMBOL_GPL(stratix10_svc_allocate_memory);
void stratix10_svc_free_memory(struct stratix10_svc_chan *chan, void *kaddr)
{
struct stratix10_svc_data_mem *pmem;
+ mutex_lock(&svc_mem_lock);
list_for_each_entry(pmem, &svc_data_mem, node)
if (pmem->vaddr == kaddr) {
@@ -1107,9 +1121,10 @@ void stratix10_svc_free_memory(struct stratix10_svc_chan *chan, void *kaddr)
(unsigned long)kaddr, pmem->size);
pmem->vaddr = NULL;
list_del(&pmem->node);
+ mutex_unlock(&svc_mem_lock);
return;
}
-
+ mutex_unlock(&svc_mem_lock);
list_del(&svc_data_mem);
}
EXPORT_SYMBOL_GPL(stratix10_svc_free_memory);
--
2.35.3
^ permalink raw reply related [flat|nested] 16+ messages in thread* [PATCH v2 2/7] firmware: stratix10-svc: Implement ID pool management for asynchronous operations
2025-05-12 11:39 [PATCH v2 0/7] stratix10: Add framework for asynchronous communication with SDM Mahesh Rao via B4 Relay
2025-05-12 11:39 ` [PATCH v2 1/7] firmware: stratix10-svc: Add mutex lock and unlock in stratix10 memory allocation/free Mahesh Rao via B4 Relay
@ 2025-05-12 11:39 ` Mahesh Rao via B4 Relay
2025-05-12 11:39 ` [PATCH v2 3/7] firmware: stratix10-svc: Add initial support for asynchronous communication with Stratix 10 service channel Mahesh Rao via B4 Relay
` (4 subsequent siblings)
6 siblings, 0 replies; 16+ messages in thread
From: Mahesh Rao via B4 Relay @ 2025-05-12 11:39 UTC (permalink / raw)
To: Dinh Nguyen, Rob Herring, Krzysztof Kozlowski, Conor Dooley,
Mahesh Rao
Cc: Matthew Gerlach, linux-kernel, devicetree
From: Mahesh Rao <mahesh.rao@altera.com>
Implement ID pool management API's which will be
used for Stratix10 Asynchronous communication with
Secure Device Manager. These API's will be used
in subsequent patches for ID management in asynchronous
operations.
Signed-off-by: Mahesh Rao <mahesh.rao@altera.com>
Reviewed-by: Matthew Gerlach <matthew.gerlach@altera.com>
---
drivers/firmware/stratix10-svc.c | 191 +++++++++++++++++++++++++++++++++++++++
1 file changed, 191 insertions(+)
diff --git a/drivers/firmware/stratix10-svc.c b/drivers/firmware/stratix10-svc.c
index 3d42d4b18b7299d0a9e5110159e06253dfeddf88..f487b6a7ef7b7cf7fdb4b4132d7a92b601803d8a 100644
--- a/drivers/firmware/stratix10-svc.c
+++ b/drivers/firmware/stratix10-svc.c
@@ -170,10 +170,201 @@ struct stratix10_svc_chan {
spinlock_t lock;
};
+/**
+ * struct stratix10_sip_id_pool - Structure representing a pool of IDs for
+ * asynchronous operations.
+ * @head: The head index of the ID pool.
+ * @size: The total size of the ID pool.
+ * @id_mask: Pointer to an array representing the mask of allocated IDs.
+ * @lock: Mutex lock to protect access to the ID pool.
+ */
+struct stratix10_sip_id_pool {
+ unsigned long head;
+ unsigned long size;
+ unsigned long *id_mask;
+ struct mutex lock;
+};
+
static LIST_HEAD(svc_ctrl);
static LIST_HEAD(svc_data_mem);
static DEFINE_MUTEX(svc_mem_lock);
+/**
+ * stratix10_id_pool_create - Create a new ID pool for Stratix10 async operation
+ * @size: The size of the ID pool to create
+ *
+ * This function allocates and initializes a new ID pool structure for
+ * Stratix10 async operations. It allocates memory for the ID pool structure
+ * and the associated bitmaps for ID management.
+ *
+ * Return: Pointer to the newly created ID pool structure, or NULL on failure.
+ */
+static struct stratix10_sip_id_pool *stratix10_id_pool_create(unsigned long size)
+{
+ struct stratix10_sip_id_pool *id_pool = NULL;
+
+ if (size == 0)
+ return NULL;
+
+ id_pool = kzalloc(sizeof(*id_pool), GFP_KERNEL);
+ if (!id_pool)
+ return NULL;
+
+ id_pool->size = size;
+
+ id_pool->id_mask = bitmap_zalloc(size, GFP_KERNEL);
+ if (!id_pool->id_mask) {
+ kfree(id_pool);
+ return NULL;
+ }
+
+ id_pool->head = 0;
+
+ mutex_init(&id_pool->lock);
+
+ return id_pool;
+}
+
+/**
+ * stratix10_id_pool_destroy - Destroy an ID pool for Stratix10 async operation
+ * @id_pool: Pointer to the ID pool structure
+ *
+ * This function destroys an ID pool for Stratix10 async operations. It first
+ * checks if the ID pool is valid, then frees the associated bitmap and the
+ * ID pool structure itself.
+ *
+ * Return: 0 on success, -EINVAL if the ID pool is invalid.
+ */
+static int stratix10_id_pool_destroy(struct stratix10_sip_id_pool *id_pool)
+{
+ if (!id_pool)
+ return -EINVAL;
+
+ mutex_lock(&id_pool->lock);
+
+ if (id_pool->id_mask)
+ bitmap_free(id_pool->id_mask);
+
+ mutex_unlock(&id_pool->lock);
+ mutex_destroy(&id_pool->lock);
+
+ kfree(id_pool);
+
+ return 0;
+}
+
+/**
+ * stratix10_reserve_id - Reserve an ID in the ID pool
+ * @id_pool: Pointer to the ID pool structure
+ * @id: The ID to be reserved
+ *
+ * This function reserves an ID in the given ID pool. It first checks if the
+ * ID pool is valid and if the ID is within the valid range.
+ *
+ * Return:
+ * 0 on success,
+ * -EINVAL if the ID pool is invalid, the ID is out of range, or the ID is
+ * already reserved.
+ */
+static int stratix10_reserve_id(struct stratix10_sip_id_pool *id_pool, unsigned long id)
+{
+ if (!id_pool)
+ return -EINVAL;
+
+ if (id >= id_pool->size)
+ return -EINVAL;
+
+ mutex_lock(&id_pool->lock);
+
+ if (test_bit(id, id_pool->id_mask)) {
+ mutex_unlock(&id_pool->lock);
+ return -EINVAL;
+ }
+ set_bit(id, id_pool->id_mask);
+
+ mutex_unlock(&id_pool->lock);
+ return 0;
+}
+
+/**
+ * stratix10_allocate_id - Allocate an ID from the ID pool
+ * @id_pool: Pointer to the ID pool structure
+ *
+ * This function allocates an ID from the given ID pool. It searches for the
+ * next available ID in the pool, marks it as allocated, and returns it.
+ *
+ * Return:
+ * A non-negative integer representing the allocated ID on success
+ * -EINVAL if the id_pool is NULL
+ * -ENOMEM if no IDs are available in the pool
+ */
+static int stratix10_allocate_id(struct stratix10_sip_id_pool *id_pool)
+{
+ unsigned long tries = 0;
+ int id;
+
+ if (!id_pool)
+ return -EINVAL;
+
+ if (id_pool->head >= id_pool->size)
+ return -ENOMEM;
+
+ mutex_lock(&id_pool->lock);
+
+ do {
+ id_pool->head = find_next_zero_bit(id_pool->id_mask,
+ id_pool->size, id_pool->head);
+ if (id_pool->head >= id_pool->size) {
+ id_pool->head = 0;
+ tries++;
+ }
+ /* cycle through the whole bitmap at least once*/
+ } while (tries < 2 && test_bit(id_pool->head, id_pool->id_mask));
+
+ if (tries >= 2) {
+ mutex_unlock(&id_pool->lock);
+ return -ENOMEM;
+ }
+
+ set_bit(id_pool->head, id_pool->id_mask);
+ id = id_pool->head;
+ id_pool->head = (id_pool->head + 1) % id_pool->size;
+ mutex_unlock(&id_pool->lock);
+ return id;
+}
+
+/**
+ * stratix10_deallocate_id - Deallocate an ID in the ID pool
+ * @id_pool: Pointer to the ID pool structure
+ * @id: The ID to be deallocated
+ *
+ * This function deallocates an ID in the given ID pool. It first checks if the
+ * ID pool is valid and if the ID is within the valid range.
+ *
+ * Return:
+ * 0 on success,
+ * -EINVAL if the ID pool is invalid, the ID is out of range, or the ID is
+ * not set.
+ */
+static int stratix10_deallocate_id(struct stratix10_sip_id_pool *id_pool, unsigned long id)
+{
+ if (!id_pool)
+ return -EINVAL;
+
+ if (id >= id_pool->size)
+ return -EINVAL;
+
+ mutex_lock(&id_pool->lock);
+ if (!test_bit(id, id_pool->id_mask)) {
+ mutex_unlock(&id_pool->lock);
+ return -EINVAL;
+ }
+ clear_bit(id, id_pool->id_mask);
+ mutex_unlock(&id_pool->lock);
+
+ return 0;
+}
+
/**
* svc_pa_to_va() - translate physical address to virtual address
* @addr: to be translated physical address
--
2.35.3
^ permalink raw reply related [flat|nested] 16+ messages in thread* [PATCH v2 3/7] firmware: stratix10-svc: Add initial support for asynchronous communication with Stratix 10 service channel
2025-05-12 11:39 [PATCH v2 0/7] stratix10: Add framework for asynchronous communication with SDM Mahesh Rao via B4 Relay
2025-05-12 11:39 ` [PATCH v2 1/7] firmware: stratix10-svc: Add mutex lock and unlock in stratix10 memory allocation/free Mahesh Rao via B4 Relay
2025-05-12 11:39 ` [PATCH v2 2/7] firmware: stratix10-svc: Implement ID pool management for asynchronous operations Mahesh Rao via B4 Relay
@ 2025-05-12 11:39 ` Mahesh Rao via B4 Relay
2025-05-19 11:58 ` Dinh Nguyen
2025-05-12 11:39 ` [PATCH v2 4/7] dt-bindings: firmware: Add interrupt specification for Intel Stratix 10 Service Layer Mahesh Rao via B4 Relay
` (3 subsequent siblings)
6 siblings, 1 reply; 16+ messages in thread
From: Mahesh Rao via B4 Relay @ 2025-05-12 11:39 UTC (permalink / raw)
To: Dinh Nguyen, Rob Herring, Krzysztof Kozlowski, Conor Dooley,
Mahesh Rao
Cc: Matthew Gerlach, linux-kernel, devicetree
From: Mahesh Rao <mahesh.rao@altera.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@altera.com>
Reviewed-by: Matthew Gerlach <matthew.gerlach@altera.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
^ permalink raw reply related [flat|nested] 16+ messages in thread* Re: [PATCH v2 3/7] firmware: stratix10-svc: Add initial support for asynchronous communication with Stratix 10 service channel
2025-05-12 11:39 ` [PATCH v2 3/7] firmware: stratix10-svc: Add initial support for asynchronous communication with Stratix 10 service channel Mahesh Rao via B4 Relay
@ 2025-05-19 11:58 ` Dinh Nguyen
2025-05-21 8:42 ` Mahesh Rao
0 siblings, 1 reply; 16+ messages in thread
From: Dinh Nguyen @ 2025-05-19 11:58 UTC (permalink / raw)
To: mahesh.rao, Rob Herring, Krzysztof Kozlowski, Conor Dooley
Cc: Matthew Gerlach, linux-kernel, devicetree
On 5/12/25 06:39, Mahesh Rao via B4 Relay wrote:
> From: Mahesh Rao <mahesh.rao@altera.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
Be consistent, it should be Stratix10!
> efficient and flexible communication with the firmware. >
> Signed-off-by: Mahesh Rao <mahesh.rao@altera.com>
> Reviewed-by: Matthew Gerlach <matthew.gerlach@altera.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
s/Stratix 10/Stratix10
> + * @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 {
What's the purpose of a unique client ID again? It looks like the
if/else are doing very similar things. You can probably simplify it bit
better.
> + 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);
Won't you get this message printed all the time?
> + 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;
> + }
What is the above code doing?
> + 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);
You should also set async_id_pool to NULL.
^ permalink raw reply [flat|nested] 16+ messages in thread* Re: [PATCH v2 3/7] firmware: stratix10-svc: Add initial support for asynchronous communication with Stratix 10 service channel
2025-05-19 11:58 ` Dinh Nguyen
@ 2025-05-21 8:42 ` Mahesh Rao
2025-05-21 20:18 ` Dinh Nguyen
0 siblings, 1 reply; 16+ messages in thread
From: Mahesh Rao @ 2025-05-21 8:42 UTC (permalink / raw)
To: Dinh Nguyen, Rob Herring, Krzysztof Kozlowski, Conor Dooley
Cc: Matthew Gerlach, linux-kernel, devicetree
On 19-05-2025 05:28 pm, Dinh Nguyen wrote:
> On 5/12/25 06:39, Mahesh Rao via B4 Relay wrote:
>> From: Mahesh Rao <mahesh.rao@altera.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
>
> Be consistent, it should be Stratix10!
>
Will make the change.
>> efficient and flexible communication with the firmware. >
>> Signed-off-by: Mahesh Rao <mahesh.rao@altera.com>
>> Reviewed-by: Matthew Gerlach <matthew.gerlach@altera.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
>
> s/Stratix 10/Stratix10
will make the change.
>
>> + * @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 {
>
> What's the purpose of a unique client ID again? It looks like the if/
> else are doing very similar things. You can probably simplify it bit
> better.
>
Certain clients like fpga_manager and fcs might require unique client id
for transacting with Secure Device Manager(SDM), but others like RSU and
hwmon might not require this. so I am using use_unique_clientid to
distwinguish between them during async channel creation. This is also a
way to conserve client id usage in the system.
I will simplify the function and merge common code.
>
>> + 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);
>
> Won't you get this message printed all the time?
This patch contains the initial framework without any commands added.
The default case is for the negative scenario when a command is added
incorrectly. the last patch in the series adds command for hwmon which
shows the correct usage.
>
>> + 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;
>> + }
>
> What is the above code doing?
This function prepares the response for clients after retriving the
response from the Arm Trusted Firmware using the polling call. Currently
only the negative scenario is shown for incvalid command, the last patch
in series adds command for hwmon for the positive scenario.
>
>> + 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);
>
> You should also set async_id_pool to NULL.
>
>
will make the change.
^ permalink raw reply [flat|nested] 16+ messages in thread* Re: [PATCH v2 3/7] firmware: stratix10-svc: Add initial support for asynchronous communication with Stratix 10 service channel
2025-05-21 8:42 ` Mahesh Rao
@ 2025-05-21 20:18 ` Dinh Nguyen
2025-05-22 10:33 ` Mahesh Rao
0 siblings, 1 reply; 16+ messages in thread
From: Dinh Nguyen @ 2025-05-21 20:18 UTC (permalink / raw)
To: Mahesh Rao, Rob Herring, Krzysztof Kozlowski, Conor Dooley
Cc: Matthew Gerlach, linux-kernel, devicetree
On 5/21/25 03:42, Mahesh Rao wrote:
>
>
> On 19-05-2025 05:28 pm, Dinh Nguyen wrote:
>> On 5/12/25 06:39, Mahesh Rao via B4 Relay wrote:
>>> From: Mahesh Rao <mahesh.rao@altera.com>
>>>
<snip>
>>> +
>>> +/**
>>> + * 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;
>>> + }
>>
>> What is the above code doing?
>
> This function prepares the response for clients after retriving the
> response from the Arm Trusted Firmware using the polling call. Currently
> only the negative scenario is shown for incvalid command, the last patch
> in series adds command for hwmon for the positive scenario.
>
Okay, but this is confusing. Please just add this to the last patch then.
^ permalink raw reply [flat|nested] 16+ messages in thread* Re: [PATCH v2 3/7] firmware: stratix10-svc: Add initial support for asynchronous communication with Stratix 10 service channel
2025-05-21 20:18 ` Dinh Nguyen
@ 2025-05-22 10:33 ` Mahesh Rao
2025-05-22 18:47 ` Dinh Nguyen
0 siblings, 1 reply; 16+ messages in thread
From: Mahesh Rao @ 2025-05-22 10:33 UTC (permalink / raw)
To: Dinh Nguyen, Rob Herring, Krzysztof Kozlowski, Conor Dooley
Cc: Matthew Gerlach, linux-kernel, devicetree
On 22-05-2025 01:48 am, Dinh Nguyen wrote:
> On 5/21/25 03:42, Mahesh Rao wrote:
>>
>>
>> On 19-05-2025 05:28 pm, Dinh Nguyen wrote:
>>> On 5/12/25 06:39, Mahesh Rao via B4 Relay wrote:
>>>> From: Mahesh Rao <mahesh.rao@altera.com>
>>>>
>
> <snip>
>
>>>> +
>>>> +/**
>>>> + * 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;
>>>> + }
>>>
>>> What is the above code doing?
>>
>> This function prepares the response for clients after retriving the
>> response from the Arm Trusted Firmware using the polling call.
>> Currently only the negative scenario is shown for incvalid command,
>> the last patch in series adds command for hwmon for the positive
>> scenario.
>>
>
> Okay, but this is confusing. Please just add this to the last patch then.
>
Shall I combine the last patch for adding hwmon commands here so that
the framework has some command usage?.
^ permalink raw reply [flat|nested] 16+ messages in thread* Re: [PATCH v2 3/7] firmware: stratix10-svc: Add initial support for asynchronous communication with Stratix 10 service channel
2025-05-22 10:33 ` Mahesh Rao
@ 2025-05-22 18:47 ` Dinh Nguyen
2025-05-23 9:20 ` Mahesh Rao
0 siblings, 1 reply; 16+ messages in thread
From: Dinh Nguyen @ 2025-05-22 18:47 UTC (permalink / raw)
To: Mahesh Rao, Rob Herring, Krzysztof Kozlowski, Conor Dooley
Cc: Matthew Gerlach, linux-kernel, devicetree
On 5/22/25 05:33, Mahesh Rao wrote:
>
>
> On 22-05-2025 01:48 am, Dinh Nguyen wrote:
>> On 5/21/25 03:42, Mahesh Rao wrote:
>>>
>>>
>>> On 19-05-2025 05:28 pm, Dinh Nguyen wrote:
>>>> On 5/12/25 06:39, Mahesh Rao via B4 Relay wrote:
>>>>> From: Mahesh Rao <mahesh.rao@altera.com>
>>>>>
>>
>> <snip>
>>
>>>>> +
>>>>> +/**
>>>>> + * 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;
>>>>> + }
>>>>
>>>> What is the above code doing?
>>>
>>> This function prepares the response for clients after retriving the
>>> response from the Arm Trusted Firmware using the polling call.
>>> Currently only the negative scenario is shown for incvalid command,
>>> the last patch in series adds command for hwmon for the positive
>>> scenario.
>>>
>>
>> Okay, but this is confusing. Please just add this to the last patch then.
>>
>
> Shall I combine the last patch for adding hwmon commands here so that
> the framework has some command usage?.
>
I like the idea of splitting up the patches to be small, but I don't
think combining them is the right thing to do either. Each patch should
be able to stand on it's own as well. The HWMON commands are fine in
their own patch. You don't need to put the switch statements in this
patch, because nothing is being done.
^ permalink raw reply [flat|nested] 16+ messages in thread* Re: [PATCH v2 3/7] firmware: stratix10-svc: Add initial support for asynchronous communication with Stratix 10 service channel
2025-05-22 18:47 ` Dinh Nguyen
@ 2025-05-23 9:20 ` Mahesh Rao
0 siblings, 0 replies; 16+ messages in thread
From: Mahesh Rao @ 2025-05-23 9:20 UTC (permalink / raw)
To: Dinh Nguyen, Rob Herring, Krzysztof Kozlowski, Conor Dooley
Cc: Matthew Gerlach, linux-kernel, devicetree
On 23-05-2025 12:17 am, Dinh Nguyen wrote:
> On 5/22/25 05:33, Mahesh Rao wrote:
>>
>>
>> On 22-05-2025 01:48 am, Dinh Nguyen wrote:
>>> On 5/21/25 03:42, Mahesh Rao wrote:
>>>>
>>>>
>>>> On 19-05-2025 05:28 pm, Dinh Nguyen wrote:
>>>>> On 5/12/25 06:39, Mahesh Rao via B4 Relay wrote:
>>>>>> From: Mahesh Rao <mahesh.rao@altera.com>
>>>>>>
>>>
>>> <snip>
>>>
>>>>>> +
>>>>>> +/**
>>>>>> + * 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;
>>>>>> + }
>>>>>
>>>>> What is the above code doing?
>>>>
>>>> This function prepares the response for clients after retriving the
>>>> response from the Arm Trusted Firmware using the polling call.
>>>> Currently only the negative scenario is shown for incvalid command,
>>>> the last patch in series adds command for hwmon for the positive
>>>> scenario.
>>>>
>>>
>>> Okay, but this is confusing. Please just add this to the last patch
>>> then.
>>>
>>
>> Shall I combine the last patch for adding hwmon commands here so that
>> the framework has some command usage?.
>>
>
> I like the idea of splitting up the patches to be small, but I don't
> think combining them is the right thing to do either. Each patch should
> be able to stand on it's own as well. The HWMON commands are fine in
> their own patch. You don't need to put the switch statements in this
> patch, because nothing is being done.
>
ok sure will make the change
^ permalink raw reply [flat|nested] 16+ messages in thread
* [PATCH v2 4/7] dt-bindings: firmware: Add interrupt specification for Intel Stratix 10 Service Layer.
2025-05-12 11:39 [PATCH v2 0/7] stratix10: Add framework for asynchronous communication with SDM Mahesh Rao via B4 Relay
` (2 preceding siblings ...)
2025-05-12 11:39 ` [PATCH v2 3/7] firmware: stratix10-svc: Add initial support for asynchronous communication with Stratix 10 service channel Mahesh Rao via B4 Relay
@ 2025-05-12 11:39 ` Mahesh Rao via B4 Relay
2025-05-12 11:39 ` [PATCH v2 5/7] dts: agilex: Add support for SDM mailbox interrupt for Intel Agilex SoC FPGA Mahesh Rao via B4 Relay
` (2 subsequent siblings)
6 siblings, 0 replies; 16+ messages in thread
From: Mahesh Rao via B4 Relay @ 2025-05-12 11:39 UTC (permalink / raw)
To: Dinh Nguyen, Rob Herring, Krzysztof Kozlowski, Conor Dooley,
Mahesh Rao
Cc: Matthew Gerlach, linux-kernel, devicetree
From: Mahesh Rao <mahesh.rao@altera.com>
Add interrupt specification for Intel Stratix10 Service
layer for asynchronous communication.
Reviewed-by: Matthew Gerlach <matthew.gerlach@altera.com>
Reviewed-by: Rob Herring (Arm) <robh@kernel.org>
Signed-off-by: Mahesh Rao <mahesh.rao@altera.com>
---
.../devicetree/bindings/firmware/intel,stratix10-svc.yaml | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/Documentation/devicetree/bindings/firmware/intel,stratix10-svc.yaml b/Documentation/devicetree/bindings/firmware/intel,stratix10-svc.yaml
index fac1e955852e4f9b966c991dcfac56222c5f7315..656cc50fd08217f270f95ae39010152423315ed1 100644
--- a/Documentation/devicetree/bindings/firmware/intel,stratix10-svc.yaml
+++ b/Documentation/devicetree/bindings/firmware/intel,stratix10-svc.yaml
@@ -54,6 +54,12 @@ properties:
reserved memory region for the service layer driver to
communicate with the secure device manager.
+ interrupts:
+ maxItems: 1
+ description:
+ This interrupt is used by the Secure Device Manager (SDM) to signal
+ completion of an asynchronous operation to service layer driver.
+
fpga-mgr:
$ref: /schemas/fpga/intel,stratix10-soc-fpga-mgr.yaml
description: Optional child node for fpga manager to perform fabric configuration.
@@ -67,6 +73,8 @@ additionalProperties: false
examples:
- |
+ #include <dt-bindings/interrupt-controller/arm-gic.h>
+
reserved-memory {
#address-cells = <2>;
#size-cells = <2>;
@@ -84,6 +92,8 @@ examples:
compatible = "intel,stratix10-svc";
method = "smc";
memory-region = <&service_reserved>;
+ interrupts = <GIC_SPI 0 IRQ_TYPE_LEVEL_HIGH>;
+ interrupt-parent = <&intc0>;
fpga-mgr {
compatible = "intel,stratix10-soc-fpga-mgr";
--
2.35.3
^ permalink raw reply related [flat|nested] 16+ messages in thread* [PATCH v2 5/7] dts: agilex: Add support for SDM mailbox interrupt for Intel Agilex SoC FPGA.
2025-05-12 11:39 [PATCH v2 0/7] stratix10: Add framework for asynchronous communication with SDM Mahesh Rao via B4 Relay
` (3 preceding siblings ...)
2025-05-12 11:39 ` [PATCH v2 4/7] dt-bindings: firmware: Add interrupt specification for Intel Stratix 10 Service Layer Mahesh Rao via B4 Relay
@ 2025-05-12 11:39 ` Mahesh Rao via B4 Relay
2025-05-21 20:22 ` Dinh Nguyen
2025-05-12 11:39 ` [PATCH v2 6/7] firmware: stratix10-svc: Add for SDM mailbox doorbell interrupt Mahesh Rao via B4 Relay
2025-05-12 11:39 ` [PATCH v2 7/7] firmware: stratix10-svc: Add support for HWMON temperature and voltage read command Mahesh Rao via B4 Relay
6 siblings, 1 reply; 16+ messages in thread
From: Mahesh Rao via B4 Relay @ 2025-05-12 11:39 UTC (permalink / raw)
To: Dinh Nguyen, Rob Herring, Krzysztof Kozlowski, Conor Dooley,
Mahesh Rao
Cc: Matthew Gerlach, linux-kernel, devicetree
From: Mahesh Rao <mahesh.rao@altera.com>
Add support for Secure Device Manager (SDM) mailbox
doorbell interrupt on Agilex SoC FPGA for supporting
asynchronous transactions.
Signed-off-by: Mahesh Rao <mahesh.rao@altera.com>
Reviewed-by: Matthew Gerlach <matthew.gerlach@altera.com>
---
arch/arm64/boot/dts/intel/socfpga_agilex.dtsi | 2 ++
1 file changed, 2 insertions(+)
diff --git a/arch/arm64/boot/dts/intel/socfpga_agilex.dtsi b/arch/arm64/boot/dts/intel/socfpga_agilex.dtsi
index 1235ba5a9865a175001fd3ef2bad710842f93be4..bd8c386a2ee31b85d6ee9be2dff6176565a85077 100644
--- a/arch/arm64/boot/dts/intel/socfpga_agilex.dtsi
+++ b/arch/arm64/boot/dts/intel/socfpga_agilex.dtsi
@@ -65,6 +65,8 @@ svc {
compatible = "intel,agilex-svc";
method = "smc";
memory-region = <&service_reserved>;
+ interrupts = <GIC_SPI 0 IRQ_TYPE_LEVEL_HIGH>;
+ interrupt-parent = <&intc>;
fpga_mgr: fpga-mgr {
compatible = "intel,agilex-soc-fpga-mgr";
--
2.35.3
^ permalink raw reply related [flat|nested] 16+ messages in thread* Re: [PATCH v2 5/7] dts: agilex: Add support for SDM mailbox interrupt for Intel Agilex SoC FPGA.
2025-05-12 11:39 ` [PATCH v2 5/7] dts: agilex: Add support for SDM mailbox interrupt for Intel Agilex SoC FPGA Mahesh Rao via B4 Relay
@ 2025-05-21 20:22 ` Dinh Nguyen
2025-05-22 10:37 ` Mahesh Rao
0 siblings, 1 reply; 16+ messages in thread
From: Dinh Nguyen @ 2025-05-21 20:22 UTC (permalink / raw)
To: mahesh.rao, Rob Herring, Krzysztof Kozlowski, Conor Dooley
Cc: Matthew Gerlach, linux-kernel, devicetree
On 5/12/25 06:39, Mahesh Rao via B4 Relay wrote:
> From: Mahesh Rao <mahesh.rao@altera.com>
>
> Add support for Secure Device Manager (SDM) mailbox
> doorbell interrupt on Agilex SoC FPGA for supporting
> asynchronous transactions.
>
> Signed-off-by: Mahesh Rao <mahesh.rao@altera.com>
> Reviewed-by: Matthew Gerlach <matthew.gerlach@altera.com>
> ---
> arch/arm64/boot/dts/intel/socfpga_agilex.dtsi | 2 ++
I don't see how patch #4 and this patch will applies to this series?
Please send them separately. It helps with the confusion.
Thanks,
Dinh
^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [PATCH v2 5/7] dts: agilex: Add support for SDM mailbox interrupt for Intel Agilex SoC FPGA.
2025-05-21 20:22 ` Dinh Nguyen
@ 2025-05-22 10:37 ` Mahesh Rao
0 siblings, 0 replies; 16+ messages in thread
From: Mahesh Rao @ 2025-05-22 10:37 UTC (permalink / raw)
To: Dinh Nguyen, Rob Herring, Krzysztof Kozlowski, Conor Dooley
Cc: Matthew Gerlach, linux-kernel, devicetree
On 22-05-2025 01:52 am, Dinh Nguyen wrote:
> On 5/12/25 06:39, Mahesh Rao via B4 Relay wrote:
>> From: Mahesh Rao <mahesh.rao@altera.com>
>>
>> Add support for Secure Device Manager (SDM) mailbox
>> doorbell interrupt on Agilex SoC FPGA for supporting
>> asynchronous transactions.
>>
>> Signed-off-by: Mahesh Rao <mahesh.rao@altera.com>
>> Reviewed-by: Matthew Gerlach <matthew.gerlach@altera.com>
>> ---
>> arch/arm64/boot/dts/intel/socfpga_agilex.dtsi | 2 ++
>
> I don't see how patch #4 and this patch will applies to this series?
> Please send them separately. It helps with the confusion.
>
> Thanks,
> Dinh
>
OK, I will make patches 4,5 and 6 as a separate patch-set for adding
interrupt capability to async framework.
^ permalink raw reply [flat|nested] 16+ messages in thread
* [PATCH v2 6/7] firmware: stratix10-svc: Add for SDM mailbox doorbell interrupt
2025-05-12 11:39 [PATCH v2 0/7] stratix10: Add framework for asynchronous communication with SDM Mahesh Rao via B4 Relay
` (4 preceding siblings ...)
2025-05-12 11:39 ` [PATCH v2 5/7] dts: agilex: Add support for SDM mailbox interrupt for Intel Agilex SoC FPGA Mahesh Rao via B4 Relay
@ 2025-05-12 11:39 ` Mahesh Rao via B4 Relay
2025-05-12 11:39 ` [PATCH v2 7/7] firmware: stratix10-svc: Add support for HWMON temperature and voltage read command Mahesh Rao via B4 Relay
6 siblings, 0 replies; 16+ messages in thread
From: Mahesh Rao via B4 Relay @ 2025-05-12 11:39 UTC (permalink / raw)
To: Dinh Nguyen, Rob Herring, Krzysztof Kozlowski, Conor Dooley,
Mahesh Rao
Cc: Matthew Gerlach, linux-kernel, devicetree
From: Mahesh Rao <mahesh.rao@altera.com>
Add support for SDM (Secure Device Manager) mailbox
doorbell interrupt for async transactions. On interrupt,
a workqueue is triggered which polls the ATF for
pending responses and retrieves the bitmap of all
retrieved and unprocessed transaction ids of mailbox
responses from SDM. It then triggers the corresponding
registered callbacks.
Signed-off-by: Mahesh Rao <mahesh.rao@altera.com>
Reviewed-by: Matthew Gerlach <matthew.gerlach@altera.com>
---
drivers/firmware/stratix10-svc.c | 97 +++++++++++++++++++++++++++-
include/linux/firmware/intel/stratix10-smc.h | 22 +++++++
2 files changed, 118 insertions(+), 1 deletion(-)
diff --git a/drivers/firmware/stratix10-svc.c b/drivers/firmware/stratix10-svc.c
index e25493db074930dcc16964fbb427be7168a841e6..d60808cc077da6d88ca6cc1043f6da46df31ebad 100644
--- a/drivers/firmware/stratix10-svc.c
+++ b/drivers/firmware/stratix10-svc.c
@@ -9,12 +9,14 @@
#include <linux/delay.h>
#include <linux/genalloc.h>
#include <linux/hashtable.h>
+#include <linux/interrupt.h>
#include <linux/io.h>
#include <linux/kfifo.h>
#include <linux/kthread.h>
#include <linux/module.h>
#include <linux/mutex.h>
#include <linux/of.h>
+#include <linux/of_irq.h>
#include <linux/of_platform.h>
#include <linux/platform_device.h>
#include <linux/slab.h>
@@ -22,6 +24,7 @@
#include <linux/firmware/intel/stratix10-smc.h>
#include <linux/firmware/intel/stratix10-svc-client.h>
#include <linux/types.h>
+#include <linux/workqueue.h>
/**
* SVC_NUM_DATA_IN_FIFO - number of struct stratix10_svc_data in the FIFO
@@ -190,17 +193,20 @@ struct stratix10_async_chan {
/**
* struct stratix10_async_ctrl - Control structure for Stratix 10 asynchronous operations
+ * @irq: Interrupt request number associated with the asynchronous control
* @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
+ * @async_work: Work structure for scheduling asynchronous work
* @trx_list: Hash table for managing asynchronous transactions
*/
struct stratix10_async_ctrl {
bool initialized;
+ int irq;
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;
@@ -208,6 +214,7 @@ struct stratix10_async_ctrl {
struct stratix10_async_chan *common_async_chan;
/* spinlock to protect the writes to trx_list hash table */
spinlock_t trx_list_wr_lock;
+ struct work_struct async_work;
DECLARE_HASHTABLE(trx_list, ASYNC_TRX_HASH_BITS);
};
@@ -1632,6 +1639,71 @@ static inline void stratix10_smc_1_2(struct stratix10_async_ctrl *actrl,
arm_smccc_1_2_smc(args, res);
}
+static irqreturn_t stratix10_svc_async_irq_handler(int irq, void *dev_id)
+{
+ struct stratix10_svc_controller *ctrl = dev_id;
+ struct stratix10_async_ctrl *actrl = &ctrl->actrl;
+
+ queue_work(system_bh_wq, &actrl->async_work);
+ disable_irq_nosync(actrl->irq);
+ return IRQ_HANDLED;
+}
+
+/**
+ * stratix10_async_workqueue_handler - Handles asynchronous workqueue tasks
+ * @work: Pointer to the work_struct representing the work to be handled
+ *
+ * This function is the handler for the asynchronous workqueue. It performs
+ * the following tasks:
+ * - Invokes the asynchronous polling on interrupt supervisory call.
+ * - On success,it retrieves the bitmap of pending transactions from mailbox
+ * fifo in ATF.
+ * - It processes each pending transaction by calling the corresponding
+ * callback function.
+ *
+ * The function ensures that the IRQ is enabled after processing the transactions
+ * and logs the total time taken to handle the transactions along with the number
+ * of transactions handled and the CPU on which the handler ran.
+ */
+static void stratix10_async_workqueue_handler(struct work_struct *work)
+{
+ u64 bitmap_array[4];
+ unsigned long transaction_id = 0;
+ struct stratix10_svc_async_handler *handler;
+ DECLARE_BITMAP(pend_on_irq, TOTAL_TRANSACTION_IDS);
+ struct arm_smccc_1_2_regs args = { .a0 = INTEL_SIP_SMC_ASYNC_POLL_ON_IRQ }, res;
+ struct stratix10_async_ctrl *actrl =
+ container_of(work, struct stratix10_async_ctrl, async_work);
+
+ actrl->invoke_fn(actrl, &args, &res);
+ if (res.a0 == INTEL_SIP_SMC_STATUS_OK) {
+ bitmap_array[0] = res.a1;
+ bitmap_array[1] = res.a2;
+ bitmap_array[2] = res.a3;
+ bitmap_array[3] = res.a4;
+ bitmap_from_arr64(pend_on_irq, bitmap_array, TOTAL_TRANSACTION_IDS);
+ rcu_read_lock();
+ do {
+ transaction_id = find_next_bit(pend_on_irq,
+ TOTAL_TRANSACTION_IDS,
+ transaction_id);
+ if (transaction_id >= TOTAL_TRANSACTION_IDS)
+ break;
+ hash_for_each_possible_rcu_notrace(actrl->trx_list,
+ handler, next,
+ transaction_id) {
+ if (handler->transaction_id == transaction_id) {
+ handler->cb(handler->cb_arg);
+ break;
+ }
+ }
+ transaction_id++;
+ } while (transaction_id < TOTAL_TRANSACTION_IDS);
+ rcu_read_unlock();
+ }
+ enable_irq(actrl->irq);
+}
+
/**
* stratix10_svc_async_init - Initialize the Stratix 10 service controller
* for asynchronous operations.
@@ -1639,6 +1711,7 @@ static inline void stratix10_smc_1_2(struct stratix10_async_ctrl *actrl,
*
* This function initializes the asynchronous service controller by setting up
* the necessary data structures, initializing the transaction list, and
+ * registering the IRQ handler for asynchronous transactions.
*
* 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
@@ -1646,7 +1719,7 @@ static inline void stratix10_smc_1_2(struct stratix10_async_ctrl *actrl,
*/
static int stratix10_svc_async_init(struct stratix10_svc_controller *controller)
{
- int ret;
+ int ret, irq;
struct arm_smccc_res res;
if (!controller)
@@ -1693,6 +1766,22 @@ static int stratix10_svc_async_init(struct stratix10_svc_controller *controller)
hash_init(actrl->trx_list);
atomic_set(&actrl->common_achan_refcount, 0);
+ irq = of_irq_get(dev_of_node(dev), 0);
+ if (irq < 0) {
+ dev_warn(dev, "Failed to get IRQ, falling back to polling mode\n");
+ } else {
+ ret = devm_request_any_context_irq(dev, irq, stratix10_svc_async_irq_handler,
+ IRQF_NO_AUTOEN, "stratix10_svc", controller);
+ if (ret == 0) {
+ dev_alert(dev,
+ "Registered IRQ %d for sip async operations\n",
+ irq);
+ actrl->irq = irq;
+ INIT_WORK(&actrl->async_work, stratix10_async_workqueue_handler);
+ enable_irq(actrl->irq);
+ }
+ }
+
actrl->initialized = true;
return 0;
}
@@ -1728,6 +1817,12 @@ static int stratix10_svc_async_exit(struct stratix10_svc_controller *ctrl)
actrl->initialized = false;
+ if (actrl->irq > 0) {
+ free_irq(actrl->irq, ctrl);
+ flush_work(&actrl->async_work);
+ actrl->irq = 0;
+ }
+
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,
diff --git a/include/linux/firmware/intel/stratix10-smc.h b/include/linux/firmware/intel/stratix10-smc.h
index c98ed992d23bed5aa344868ca0c77a2d19d94c06..ee00f17ea9f6c7a1114fb617d4d6393f2c27e2a9 100644
--- a/include/linux/firmware/intel/stratix10-smc.h
+++ b/include/linux/firmware/intel/stratix10-smc.h
@@ -644,4 +644,26 @@ INTEL_SIP_SMC_FAST_CALL_VAL(INTEL_SIP_SMC_FUNCID_FPGA_CONFIG_COMPLETED_WRITE)
#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)
+
+/**
+ * Request INTEL_SIP_SMC_ASYNC_POLL_ON_IRQ
+ * Async call used by service driver at EL1 to read response from SDM mailbox and
+ * to retrieve the transaction id's of the read response's.
+ *
+ * Call register usage:
+ * a0 INTEL_SIP_SMC_ASYNC_POLL_ON_IRQ
+ * a1 transaction job id
+ * a2-7 will be used to return the response data
+ *
+ * Return status
+ * a0 INTEL_SIP_SMC_STATUS_OK
+ * a1-a4 will contain bitmap of available responses's transaction id as set bit position.
+ * a5-17 not used
+ * Or
+ * a0 INTEL_SIP_SMC_STATUS_NO_RESPONSE
+ * a1-17 not used
+ */
+#define INTEL_SIP_SMC_ASYNC_FUNC_ID_IRQ_POLL (0xC9)
+#define INTEL_SIP_SMC_ASYNC_POLL_ON_IRQ \
+ INTEL_SIP_SMC_ASYNC_VAL(INTEL_SIP_SMC_ASYNC_FUNC_ID_IRQ_POLL)
#endif
--
2.35.3
^ permalink raw reply related [flat|nested] 16+ messages in thread* [PATCH v2 7/7] firmware: stratix10-svc: Add support for HWMON temperature and voltage read command.
2025-05-12 11:39 [PATCH v2 0/7] stratix10: Add framework for asynchronous communication with SDM Mahesh Rao via B4 Relay
` (5 preceding siblings ...)
2025-05-12 11:39 ` [PATCH v2 6/7] firmware: stratix10-svc: Add for SDM mailbox doorbell interrupt Mahesh Rao via B4 Relay
@ 2025-05-12 11:39 ` Mahesh Rao via B4 Relay
6 siblings, 0 replies; 16+ messages in thread
From: Mahesh Rao via B4 Relay @ 2025-05-12 11:39 UTC (permalink / raw)
To: Dinh Nguyen, Rob Herring, Krzysztof Kozlowski, Conor Dooley,
Mahesh Rao
Cc: Matthew Gerlach, linux-kernel, devicetree
From: Mahesh Rao <mahesh.rao@altera.com>
Add support for HWMON commands in stratix10
Asynchronous communication
Signed-off-by: Mahesh Rao <mahesh.rao@altera.com>
Reviewed-by: Matthew Gerlach <matthew.gerlach@altera.com>
---
drivers/firmware/stratix10-svc.c | 20 +++++++++++-
include/linux/firmware/intel/stratix10-smc.h | 38 ++++++++++++++++++++++
.../linux/firmware/intel/stratix10-svc-client.h | 11 +++++++
3 files changed, 68 insertions(+), 1 deletion(-)
diff --git a/drivers/firmware/stratix10-svc.c b/drivers/firmware/stratix10-svc.c
index d60808cc077da6d88ca6cc1043f6da46df31ebad..4ee89980319dcde5198d7112d08708b543881f73 100644
--- a/drivers/firmware/stratix10-svc.c
+++ b/drivers/firmware/stratix10-svc.c
@@ -40,7 +40,7 @@
* timeout is set to 30 seconds (30 * 1000) at Intel Stratix10 SoC.
*/
#define SVC_NUM_DATA_IN_FIFO 32
-#define SVC_NUM_CHANNEL 3
+#define SVC_NUM_CHANNEL 4
#define FPGA_CONFIG_DATA_CLAIM_TIMEOUT_MS 200
#define FPGA_CONFIG_STATUS_TIMEOUT_SEC 30
#define BYTE_TO_WORD_SIZE 4
@@ -1429,6 +1429,14 @@ int stratix10_svc_async_send(struct stratix10_svc_chan *chan, void *msg, void **
STRATIX10_SIP_SMC_SET_TRANSACTIONID_X1(handle->transaction_id);
switch (p_msg->command) {
+ case COMMAND_HWMON_READTEMP:
+ args.a0 = INTEL_SIP_SMC_ASYNC_HWMON_READTEMP;
+ args.a2 = p_msg->arg[0];
+ break;
+ case COMMAND_HWMON_READVOLT:
+ args.a0 = INTEL_SIP_SMC_ASYNC_HWMON_READVOLT;
+ args.a2 = p_msg->arg[0];
+ break;
default:
dev_err(ctrl->dev, "Invalid command ,%d\n", p_msg->command);
ret = -EINVAL;
@@ -1508,6 +1516,11 @@ static int stratix10_svc_async_prepare_response(struct stratix10_svc_chan *chan,
data->status = STRATIX10_GET_SDM_STATUS_CODE(handle->res.a1);
switch (p_msg->command) {
+ case COMMAND_HWMON_READTEMP:
+ case COMMAND_HWMON_READVOLT:
+ data->kaddr1 = (void *)&handle->res.a2;
+ break;
+
default:
dev_alert(ctrl->dev, "Invalid command\n ,%d", p_msg->command);
return -ENOENT;
@@ -2136,6 +2149,11 @@ static int stratix10_svc_drv_probe(struct platform_device *pdev)
chans[2].name = SVC_CLIENT_FCS;
spin_lock_init(&chans[2].lock);
+ chans[3].scl = NULL;
+ chans[3].ctrl = controller;
+ chans[3].name = SVC_CLIENT_HWMON;
+ spin_lock_init(&chans[3].lock);
+
list_add_tail(&controller->node, &svc_ctrl);
platform_set_drvdata(pdev, controller);
diff --git a/include/linux/firmware/intel/stratix10-smc.h b/include/linux/firmware/intel/stratix10-smc.h
index ee00f17ea9f6c7a1114fb617d4d6393f2c27e2a9..78055b0234cee990515f01a509a75e1c8142c68b 100644
--- a/include/linux/firmware/intel/stratix10-smc.h
+++ b/include/linux/firmware/intel/stratix10-smc.h
@@ -625,6 +625,44 @@ 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_HWMON_READTEMP
+ * Async call to request temperature
+ *
+ * Call register usage:
+ * a0 INTEL_SIP_SMC_ASYNC_FUNCID_HWMON_READTEMP
+ * a1 transaction job id
+ * a2 Temperature Channel
+ * a3-a17 not used
+ *
+ * Return status
+ * a0 INTEL_SIP_SMC_STATUS_OK ,INTEL_SIP_SMC_STATUS_REJECTED
+ * or INTEL_SIP_SMC_STATUS_BUSY
+ * a1-a17 not used
+ */
+#define INTEL_SIP_SMC_ASYNC_FUNCID_HWMON_READTEMP (0xE8)
+#define INTEL_SIP_SMC_ASYNC_HWMON_READTEMP \
+ INTEL_SIP_SMC_ASYNC_VAL(INTEL_SIP_SMC_ASYNC_FUNCID_HWMON_READTEMP)
+
+/**
+ * Request INTEL_SIP_SMC_ASYNC_HWMON_READVOLT
+ * Async call to request voltage
+ *
+ * Call register usage:
+ * a0 INTEL_SIP_SMC_ASYNC_HWMON_READVOLT
+ * a1 transaction job id
+ * a2 Voltage Channel
+ * a3-a17 not used
+ *
+ * Return status
+ * a0 INTEL_SIP_SMC_STATUS_OK ,INTEL_SIP_SMC_STATUS_REJECTED
+ * or INTEL_SIP_SMC_STATUS_BUSY
+ * a1-17 not used
+ */
+#define INTEL_SIP_SMC_ASYNC_FUNCID_HWMON_READVOLT (0xE9)
+#define INTEL_SIP_SMC_ASYNC_HWMON_READVOLT \
+ INTEL_SIP_SMC_ASYNC_VAL(INTEL_SIP_SMC_ASYNC_FUNCID_HWMON_READVOLT)
+
/**
* Request INTEL_SIP_SMC_ASYNC_POLL
* Async call used by service driver at EL1 to query mailbox response from SDM.
diff --git a/include/linux/firmware/intel/stratix10-svc-client.h b/include/linux/firmware/intel/stratix10-svc-client.h
index bda837815bae35fbf4df6280dba5bc02d747426e..032e780c7b545e2e238f9dea712779d979e491d6 100644
--- a/include/linux/firmware/intel/stratix10-svc-client.h
+++ b/include/linux/firmware/intel/stratix10-svc-client.h
@@ -16,6 +16,7 @@
#define SVC_CLIENT_FPGA "fpga"
#define SVC_CLIENT_RSU "rsu"
#define SVC_CLIENT_FCS "fcs"
+#define SVC_CLIENT_HWMON "hwmon"
/*
* Status of the sent command, in bit number
@@ -71,6 +72,7 @@
#define SVC_RSU_REQUEST_TIMEOUT_MS 300
#define SVC_FCS_REQUEST_TIMEOUT_MS 2000
#define SVC_COMPLETED_TIMEOUT_MS 30000
+#define SVC_HWMON_REQUEST_TIMEOUT_MS 2000
struct stratix10_svc_chan;
@@ -142,6 +144,12 @@ struct stratix10_svc_chan;
*
* @COMMAND_FCS_RANDOM_NUMBER_GEN: generate a random number, return status
* is SVC_STATUS_OK, SVC_STATUS_ERROR
+ *
+ * @COMMAND_HWMON_READTEMP: read temperature from the hardware sensor connected
+ * to the FPGA, return status is SVC_STATUS_OK, SVC_STATUS_ERROR
+ *
+ * @COMMAND_HWMON_READVOLT: read voltage from the hardware sensor connected
+ * to the FPGA, return status is SVC_STATUS_OK, SVC_STATUS_ERROR
*/
enum stratix10_svc_command_code {
/* for FPGA */
@@ -172,6 +180,9 @@ enum stratix10_svc_command_code {
COMMAND_MBOX_SEND_CMD = 100,
/* Non-mailbox SMC Call */
COMMAND_SMC_SVC_VERSION = 200,
+ /* for HWMON */
+ COMMAND_HWMON_READTEMP,
+ COMMAND_HWMON_READVOLT
};
/**
--
2.35.3
^ permalink raw reply related [flat|nested] 16+ messages in thread