mirrors/linux
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git synced 2025-12-27 12:21:22 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge tag 'socfpga_firmware_updates_for_v6.19' of ssh://gitolite.kernel.org/pub/scm/linux/kernel/git/dinguyen/linux into char-misc-next

Browse Source 
Dinh writes:

SoCFPGA firmware updates for v6.19
- Add support for voltage and temperature sensor
- Add a mutex to memory operations on Stratix10 service driver
- Add support for asynchronous communications in the service driver
- Replace scnprintf() with sysfs_emit()

* tag 'socfpga_firmware_updates_for_v6.19' of ssh://gitolite.kernel.org/pub/scm/linux/kernel/git/dinguyen/linux:
  firmware: stratix10-rsu: replace scnprintf() with sysfs_emit() in *_show() functions
  firmware: stratix10-rsu: Migrate RSU driver to use stratix10 asynchronous framework.
  firmware: stratix10-svc: Add support for RSU commands in asynchronous framework
  firmware: stratix10-svc: Add support for async communication
  firmware: stratix10-svc: Add mutex in stratix10 memory management
  firmware: stratix10-svc: Add definition for voltage and temperature sensor
This commit is contained in:
Greg Kroah-Hartman
2025-11-13 17:55:05 -05:00
parent e3d63f4ef3 4f7ffdfb99
commit 41289b4834
4 changed files with 1108 additions and 140 deletions
Download Patch File Download Diff File Expand all files Collapse all files

277
drivers/firmware/stratix10-rsu.c
View File

@@ -1,6 +1,7 @@
// SPDX-License-Identifier: GPL-2.0
/*
* Copyright (C) 2018-2019, Intel Corporation
* Copyright (C) 2025, Altera Corporation
*/
#include <linux/arm-smccc.h>
@@ -14,11 +15,9 @@
#include <linux/firmware/intel/stratix10-svc-client.h>
#include <linux/string.h>
#include <linux/sysfs.h>
#include <linux/delay.h>
#define RSU_STATE_MASK GENMASK_ULL(31, 0)
#define RSU_VERSION_MASK GENMASK_ULL(63, 32)
#define RSU_ERROR_LOCATION_MASK GENMASK_ULL(31, 0)
#define RSU_ERROR_DETAIL_MASK GENMASK_ULL(63, 32)
#define RSU_ERASE_SIZE_MASK GENMASK_ULL(63, 32)
#define RSU_DCMF0_MASK GENMASK_ULL(31, 0)
#define RSU_DCMF1_MASK GENMASK_ULL(63, 32)
#define RSU_DCMF2_MASK GENMASK_ULL(31, 0)
@@ -35,7 +34,8 @@
#define INVALID_DCMF_STATUS 0xFFFFFFFF
#define INVALID_SPT_ADDRESS 0x0
#define RSU_GET_SPT_CMD 0x5A
#define RSU_RETRY_SLEEP_MS (1U)
#define RSU_ASYNC_MSG_RETRY (3U)
#define RSU_GET_SPT_RESP_LEN (4 * sizeof(unsigned int))
typedef void (*rsu_callback)(struct stratix10_svc_client *client,
@@ -64,7 +64,6 @@ typedef void (*rsu_callback)(struct stratix10_svc_client *client,
* @max_retry: the preset max retry value
* @spt0_address: address of spt0
* @spt1_address: address of spt1
* @get_spt_response_buf: response from sdm for get_spt command
*/
struct stratix10_rsu_priv {
struct stratix10_svc_chan *chan;
@@ -99,47 +98,32 @@ struct stratix10_rsu_priv {
unsigned long spt0_address;
unsigned long spt1_address;
unsigned int *get_spt_response_buf;
};
typedef void (*rsu_async_callback)(struct device *dev,
struct stratix10_rsu_priv *priv, struct stratix10_svc_cb_data *data);
/**
* rsu_status_callback() - Status callback from Intel Service Layer
* @client: pointer to service client
* rsu_async_status_callback() - Status callback from rsu_async_send()
* @dev: pointer to device object
* @priv: pointer to priv object
* @data: pointer to callback data structure
*
* Callback from Intel service layer for RSU status request. Status is
* only updated after a system reboot, so a get updated status call is
* made during driver probe.
* Callback from rsu_async_send() to get the system rsu error status.
*/
static void rsu_status_callback(struct stratix10_svc_client *client,
struct stratix10_svc_cb_data *data)
static void rsu_async_status_callback(struct device *dev,
struct stratix10_rsu_priv *priv,
struct stratix10_svc_cb_data *data)
{
struct stratix10_rsu_priv *priv = client->priv;
struct arm_smccc_res *res = (struct arm_smccc_res *)data->kaddr1;
struct arm_smccc_1_2_regs *res = (struct arm_smccc_1_2_regs *)data->kaddr1;
if (data->status == BIT(SVC_STATUS_OK)) {
priv->status.version = FIELD_GET(RSU_VERSION_MASK,
res->a2);
priv->status.state = FIELD_GET(RSU_STATE_MASK, res->a2);
priv->status.fail_image = res->a1;
priv->status.current_image = res->a0;
priv->status.error_location =
FIELD_GET(RSU_ERROR_LOCATION_MASK, res->a3);
priv->status.error_details =
FIELD_GET(RSU_ERROR_DETAIL_MASK, res->a3);
} else {
dev_err(client->dev, "COMMAND_RSU_STATUS returned 0x%lX\n",
res->a0);
priv->status.version = 0;
priv->status.state = 0;
priv->status.fail_image = 0;
priv->status.current_image = 0;
priv->status.error_location = 0;
priv->status.error_details = 0;
}
complete(&priv->completion);
priv->status.current_image = res->a2;
priv->status.fail_image = res->a3;
priv->status.state = res->a4;
priv->status.version = res->a5;
priv->status.error_location = res->a7;
priv->status.error_details = res->a8;
priv->retry_counter = res->a9;
}
/**
@@ -163,32 +147,6 @@ static void rsu_command_callback(struct stratix10_svc_client *client,
complete(&priv->completion);
}
/**
* rsu_retry_callback() - Callback from Intel service layer for getting
* the current image's retry counter from the firmware
* @client: pointer to client
* @data: pointer to callback data structure
*
* Callback from Intel service layer for retry counter, which is used by
* user to know how many times the images is still allowed to reload
* itself before giving up and starting RSU fail-over flow.
*/
static void rsu_retry_callback(struct stratix10_svc_client *client,
struct stratix10_svc_cb_data *data)
{
struct stratix10_rsu_priv *priv = client->priv;
unsigned int *counter = (unsigned int *)data->kaddr1;
if (data->status == BIT(SVC_STATUS_OK))
priv->retry_counter = *counter;
else if (data->status == BIT(SVC_STATUS_NO_SUPPORT))
dev_warn(client->dev, "Secure FW doesn't support retry\n");
else
dev_err(client->dev, "Failed to get retry counter %lu\n",
BIT(data->status));
complete(&priv->completion);
}
/**
* rsu_max_retry_callback() - Callback from Intel service layer for getting
@@ -270,34 +228,19 @@ static void rsu_dcmf_status_callback(struct stratix10_svc_client *client,
complete(&priv->completion);
}
static void rsu_get_spt_callback(struct stratix10_svc_client *client,
struct stratix10_svc_cb_data *data)
/**
* rsu_async_get_spt_table_callback() - Callback to be used by the rsu_async_send()
* to retrieve the SPT table information.
* @dev: pointer to device object
* @priv: pointer to priv object
* @data: pointer to callback data structure
*/
static void rsu_async_get_spt_table_callback(struct device *dev,
struct stratix10_rsu_priv *priv,
struct stratix10_svc_cb_data *data)
{
struct stratix10_rsu_priv *priv = client->priv;
unsigned long *mbox_err = (unsigned long *)data->kaddr1;
unsigned long *resp_len = (unsigned long *)data->kaddr2;
if (data->status != BIT(SVC_STATUS_OK) || (*mbox_err) ||
(*resp_len != RSU_GET_SPT_RESP_LEN))
goto error;
priv->spt0_address = priv->get_spt_response_buf[0];
priv->spt0_address <<= 32;
priv->spt0_address |= priv->get_spt_response_buf[1];
priv->spt1_address = priv->get_spt_response_buf[2];
priv->spt1_address <<= 32;
priv->spt1_address |= priv->get_spt_response_buf[3];
goto complete;
error:
dev_err(client->dev, "failed to get SPTs\n");
complete:
stratix10_svc_free_memory(priv->chan, priv->get_spt_response_buf);
priv->get_spt_response_buf = NULL;
complete(&priv->completion);
priv->spt0_address = *((unsigned long *)data->kaddr1);
priv->spt1_address = *((unsigned long *)data->kaddr2);
}
/**
@@ -329,14 +272,6 @@ static int rsu_send_msg(struct stratix10_rsu_priv *priv,
if (arg)
msg.arg[0] = arg;
if (command == COMMAND_MBOX_SEND_CMD) {
msg.arg[1] = 0;
msg.payload = NULL;
msg.payload_length = 0;
msg.payload_output = priv->get_spt_response_buf;
msg.payload_length_output = RSU_GET_SPT_RESP_LEN;
}
ret = stratix10_svc_send(priv->chan, &msg);
if (ret < 0)
goto status_done;
@@ -362,6 +297,95 @@ static int rsu_send_msg(struct stratix10_rsu_priv *priv,
return ret;
}
/**
* soc64_async_callback() - Callback from Intel service layer for async requests
* @ptr: pointer to the completion object
*/
static void soc64_async_callback(void *ptr)
{
if (ptr)
complete(ptr);
}
/**
* rsu_send_async_msg() - send an async message to Intel service layer
* @dev: pointer to device object
* @priv: pointer to rsu private data
* @command: RSU status or update command
* @arg: the request argument, notify status
* @callback: function pointer for the callback (status or update)
*/
static int rsu_send_async_msg(struct device *dev, struct stratix10_rsu_priv *priv,
enum stratix10_svc_command_code command,
unsigned long arg,
rsu_async_callback callback)
{
struct stratix10_svc_client_msg msg = {0};
struct stratix10_svc_cb_data data = {0};
struct completion completion;
int status, index, ret;
void *handle = NULL;
msg.command = command;
msg.arg[0] = arg;
init_completion(&completion);
for (index = 0; index < RSU_ASYNC_MSG_RETRY; index++) {
status = stratix10_svc_async_send(priv->chan, &msg,
&handle, soc64_async_callback,
&completion);
if (status == 0)
break;
dev_warn(dev, "Failed to send async message\n");
msleep(RSU_RETRY_SLEEP_MS);
}
if (status && !handle) {
dev_err(dev, "Failed to send async message\n");
return -ETIMEDOUT;
}
ret = wait_for_completion_io_timeout(&completion, RSU_TIMEOUT);
if (ret > 0)
dev_dbg(dev, "Received async interrupt\n");
else if (ret == 0)
dev_dbg(dev, "Timeout occurred. Trying to poll the response\n");
for (index = 0; index < RSU_ASYNC_MSG_RETRY; index++) {
status = stratix10_svc_async_poll(priv->chan, handle, &data);
if (status == -EAGAIN) {
dev_dbg(dev, "Async message is still in progress\n");
} else if (status < 0) {
dev_alert(dev, "Failed to poll async message\n");
ret = -ETIMEDOUT;
} else if (status == 0) {
ret = 0;
break;
}
msleep(RSU_RETRY_SLEEP_MS);
}
if (ret) {
dev_err(dev, "Failed to get async response\n");
goto status_done;
}
if (data.status == 0) {
ret = 0;
if (callback)
callback(dev, priv, &data);
} else {
dev_err(dev, "%s returned 0x%x from SDM\n", __func__,
data.status);
ret = -EFAULT;
}
status_done:
stratix10_svc_async_done(priv->chan, handle);
return ret;
}
/*
* This driver exposes some optional features of the Intel Stratix 10 SoC FPGA.
* The sysfs interfaces exposed here are FPGA Remote System Update (RSU)
@@ -454,8 +478,7 @@ static ssize_t max_retry_show(struct device *dev,
if (!priv)
return -ENODEV;
return scnprintf(buf, sizeof(priv->max_retry),
"0x%08x\n", priv->max_retry);
return sysfs_emit(buf, "0x%08x\n", priv->max_retry);
}
static ssize_t dcmf0_show(struct device *dev,
@@ -597,27 +620,20 @@ static ssize_t notify_store(struct device *dev,
if (ret)
return ret;
ret = rsu_send_msg(priv, COMMAND_RSU_NOTIFY,
status, rsu_command_callback);
ret = rsu_send_async_msg(dev, priv, COMMAND_RSU_NOTIFY, status, NULL);
if (ret) {
dev_err(dev, "Error, RSU notify returned %i\n", ret);
return ret;
}
/* to get the updated state */
ret = rsu_send_msg(priv, COMMAND_RSU_STATUS,
0, rsu_status_callback);
ret = rsu_send_async_msg(dev, priv, COMMAND_RSU_STATUS, 0,
rsu_async_status_callback);
if (ret) {
dev_err(dev, "Error, getting RSU status %i\n", ret);
return ret;
}
ret = rsu_send_msg(priv, COMMAND_RSU_RETRY, 0, rsu_retry_callback);
if (ret) {
dev_err(dev, "Error, getting RSU retry %i\n", ret);
return ret;
}
return count;
}
@@ -632,7 +648,7 @@ static ssize_t spt0_address_show(struct device *dev,
if (priv->spt0_address == INVALID_SPT_ADDRESS)
return -EIO;
return scnprintf(buf, PAGE_SIZE, "0x%08lx\n", priv->spt0_address);
return sysfs_emit(buf, "0x%08lx\n", priv->spt0_address);
}
static ssize_t spt1_address_show(struct device *dev,
@@ -646,7 +662,7 @@ static ssize_t spt1_address_show(struct device *dev,
if (priv->spt1_address == INVALID_SPT_ADDRESS)
return -EIO;
return scnprintf(buf, PAGE_SIZE, "0x%08lx\n", priv->spt1_address);
return sysfs_emit(buf, "0x%08lx\n", priv->spt1_address);
}
static DEVICE_ATTR_RO(current_image);
@@ -737,12 +753,19 @@ static int stratix10_rsu_probe(struct platform_device *pdev)
return PTR_ERR(priv->chan);
}
ret = stratix10_svc_add_async_client(priv->chan, false);
if (ret) {
dev_err(dev, "failed to add async client\n");
stratix10_svc_free_channel(priv->chan);
return ret;
}
init_completion(&priv->completion);
platform_set_drvdata(pdev, priv);
/* get the initial state from firmware */
ret = rsu_send_msg(priv, COMMAND_RSU_STATUS,
0, rsu_status_callback);
ret = rsu_send_async_msg(dev, priv, COMMAND_RSU_STATUS, 0,
rsu_async_status_callback);
if (ret) {
dev_err(dev, "Error, getting RSU status %i\n", ret);
stratix10_svc_free_channel(priv->chan);
@@ -763,12 +786,6 @@ static int stratix10_rsu_probe(struct platform_device *pdev)
stratix10_svc_free_channel(priv->chan);
}
ret = rsu_send_msg(priv, COMMAND_RSU_RETRY, 0, rsu_retry_callback);
if (ret) {
dev_err(dev, "Error, getting RSU retry %i\n", ret);
stratix10_svc_free_channel(priv->chan);
}
ret = rsu_send_msg(priv, COMMAND_RSU_MAX_RETRY, 0,
rsu_max_retry_callback);
if (ret) {
@@ -776,18 +793,12 @@ static int stratix10_rsu_probe(struct platform_device *pdev)
stratix10_svc_free_channel(priv->chan);
}
priv->get_spt_response_buf =
stratix10_svc_allocate_memory(priv->chan, RSU_GET_SPT_RESP_LEN);
if (IS_ERR(priv->get_spt_response_buf)) {
dev_err(dev, "failed to allocate get spt buffer\n");
} else {
ret = rsu_send_msg(priv, COMMAND_MBOX_SEND_CMD,
RSU_GET_SPT_CMD, rsu_get_spt_callback);
if (ret) {
dev_err(dev, "Error, getting SPT table %i\n", ret);
stratix10_svc_free_channel(priv->chan);
}
ret = rsu_send_async_msg(dev, priv, COMMAND_RSU_GET_SPT_TABLE, 0,
rsu_async_get_spt_table_callback);
if (ret) {
dev_err(dev, "Error, getting SPT table %i\n", ret);
stratix10_svc_free_channel(priv->chan);
}
return ret;

760
drivers/firmware/stratix10-svc.c
View File

@@ -1,11 +1,15 @@
// SPDX-License-Identifier: GPL-2.0
/*
* Copyright (C) 2017-2018, Intel Corporation
* 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/idr.h>
#include <linux/io.h>
#include <linux/kfifo.h>
#include <linux/kthread.h>
@@ -34,7 +38,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
@@ -43,6 +47,55 @@
#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 transaction IDs, 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
/* Job ID field in the transaction ID */
#define STRATIX10_JOB_FIELD GENMASK(3, 0)
/* Client ID field in the transaction ID */
#define STRATIX10_CLIENT_FIELD GENMASK(7, 4)
/* Transaction ID mask for Stratix10 service layer */
#define STRATIX10_TRANS_ID_FIELD GENMASK(7, 0)
/* Macro to extract the job ID from a transaction ID. */
#define STRATIX10_GET_JOBID(transaction_id) \
(FIELD_GET(STRATIX10_JOB_FIELD, transaction_id))
/* Macro to set the job ID in a transaction ID. */
#define STRATIX10_SET_JOBID(jobid) \
(FIELD_PREP(STRATIX10_JOB_FIELD, jobid))
/* Macro to set the client ID in a transaction ID. */
#define STRATIX10_SET_CLIENTID(clientid) \
(FIELD_PREP(STRATIX10_CLIENT_FIELD, clientid))
/* Macro to set a transaction ID using a client ID and a job ID. */
#define STRATIX10_SET_TRANSACTIONID(clientid, jobid) \
(STRATIX10_SET_CLIENTID(clientid) | STRATIX10_SET_JOBID(jobid))
/* Macro to set a transaction ID for SIP SMC Async transactions */
#define STRATIX10_SIP_SMC_SET_TRANSACTIONID_X1(transaction_id) \
(FIELD_PREP(STRATIX10_TRANS_ID_FIELD, transaction_id))
/* 10-bit mask for extracting the SDM status code */
#define STRATIX10_SDM_STATUS_MASK GENMASK(9, 0)
/* Macro to get the SDM mailbox error status */
#define STRATIX10_GET_SDM_STATUS_CODE(status) \
(FIELD_GET(STRATIX10_SDM_STATUS_MASK, status))
typedef void (svc_invoke_fn)(unsigned long, unsigned long, unsigned long,
unsigned long, unsigned long, unsigned long,
unsigned long, unsigned long,
@@ -63,7 +116,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
@@ -121,6 +174,74 @@ struct stratix10_svc_data {
u64 arg[3];
};
/**
* struct stratix10_svc_async_handler - Asynchronous handler for Stratix10
* 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
* @res: Response structure to store result from the secure firmware
*
* This structure is used to handle asynchronous transactions in the
* Stratix10 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 ida job_id_pool;
};
/**
* struct stratix10_async_ctrl - Control structure for Stratix10
* asynchronous operations
* @initialized: Flag indicating whether the control structure has
* been initialized
* @invoke_fn: Function pointer for invoking Stratix10 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_lock: Spinlock for protecting the transaction list
* 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 ida async_id_pool;
atomic_t common_achan_refcount;
struct stratix10_async_chan *common_async_chan;
/* spinlock to protect trx_list hash table */
spinlock_t trx_list_lock;
DECLARE_HASHTABLE(trx_list, ASYNC_TRX_HASH_BITS);
};
/**
* struct stratix10_svc_controller - service controller
* @dev: device
@@ -134,6 +255,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.
@@ -150,6 +272,7 @@ struct stratix10_svc_controller {
struct completion complete_status;
spinlock_t svc_fifo_lock;
svc_invoke_fn *invoke_fn;
struct stratix10_async_ctrl actrl;
};
/**
@@ -158,20 +281,28 @@ 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;
};
static LIST_HEAD(svc_ctrl);
static LIST_HEAD(svc_data_mem);
/**
* svc_mem_lock protects access to the svc_data_mem list for
* concurrent multi-client operations
*/
static DEFINE_MUTEX(svc_mem_lock);
/**
* svc_pa_to_va() - translate physical address to virtual address
* @addr: to be translated physical address
@@ -184,6 +315,7 @@ static void *svc_pa_to_va(unsigned long addr)
struct stratix10_svc_data_mem *pmem;
pr_debug("claim back P-addr=0x%016x\n", (unsigned int)addr);
guard(mutex)(&svc_mem_lock);
list_for_each_entry(pmem, &svc_data_mem, node)
if (pmem->paddr == addr)
return pmem->vaddr;
@@ -341,6 +473,8 @@ static void svc_thread_recv_status_ok(struct stratix10_svc_data *p_data,
case COMMAND_RSU_MAX_RETRY:
case COMMAND_RSU_DCMF_STATUS:
case COMMAND_FIRMWARE_VERSION:
case COMMAND_HWMON_READTEMP:
case COMMAND_HWMON_READVOLT:
cb_data->status = BIT(SVC_STATUS_OK);
cb_data->kaddr1 = &res.a1;
break;
@@ -525,7 +659,17 @@ static int svc_normal_to_secure_thread(void *data)
a1 = (unsigned long)pdata->paddr;
a2 = 0;
break;
/* for HWMON */
case COMMAND_HWMON_READTEMP:
a0 = INTEL_SIP_SMC_HWMON_READTEMP;
a1 = pdata->arg[0];
a2 = 0;
break;
case COMMAND_HWMON_READVOLT:
a0 = INTEL_SIP_SMC_HWMON_READVOLT;
a1 = pdata->arg[0];
a2 = 0;
break;
/* for polling */
case COMMAND_POLL_SERVICE_STATUS:
a0 = INTEL_SIP_SMC_SERVICE_COMPLETED;
@@ -922,6 +1066,591 @@ 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)
{
struct stratix10_svc_controller *ctrl;
struct stratix10_async_ctrl *actrl;
struct stratix10_async_chan *achan;
int ret = 0;
if (!chan)
return -EINVAL;
ctrl = chan->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 &&
atomic_read(&actrl->common_achan_refcount) > 0) {
chan->async_chan = actrl->common_async_chan;
atomic_inc(&actrl->common_achan_refcount);
return 0;
}
achan = kzalloc(sizeof(*achan), GFP_KERNEL);
if (!achan)
return -ENOMEM;
ida_init(&achan->job_id_pool);
ret = ida_alloc_max(&actrl->async_id_pool, MAX_SDM_CLIENT_IDS,
GFP_KERNEL);
if (ret < 0) {
dev_err(ctrl->dev,
"Failed to allocate async client id\n");
ida_destroy(&achan->job_id_pool);
kfree(achan);
return ret;
}
achan->async_client_id = ret;
chan->async_chan = achan;
if (use_unique_clientid &&
atomic_read(&actrl->common_achan_refcount) == 0) {
actrl->common_async_chan = achan;
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)
{
struct stratix10_svc_controller *ctrl;
struct stratix10_async_ctrl *actrl;
struct stratix10_async_chan *achan;
if (!chan)
return -EINVAL;
ctrl = chan->ctrl;
actrl = &ctrl->actrl;
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) {
ida_destroy(&achan->job_id_pool);
ida_free(&actrl->async_id_pool,
achan->async_client_id);
kfree(achan);
actrl->common_async_chan = NULL;
}
} else {
ida_destroy(&achan->job_id_pool);
ida_free(&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 other
* 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 arm_smccc_1_2_regs args = { 0 }, res = { 0 };
struct stratix10_svc_async_handler *handle = NULL;
struct stratix10_svc_client_msg *p_msg =
(struct stratix10_svc_client_msg *)msg;
struct stratix10_svc_controller *ctrl;
struct stratix10_async_ctrl *actrl;
struct stratix10_async_chan *achan;
int ret = 0;
if (!chan || !msg || !handler)
return -EINVAL;
achan = chan->async_chan;
ctrl = chan->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(*handle), GFP_KERNEL);
if (!handle)
return -ENOMEM;
ret = ida_alloc_max(&achan->job_id_pool, MAX_SDM_JOB_IDS,
GFP_KERNEL);
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) {
case COMMAND_RSU_GET_SPT_TABLE:
args.a0 = INTEL_SIP_SMC_ASYNC_RSU_GET_SPT;
break;
case COMMAND_RSU_STATUS:
args.a0 = INTEL_SIP_SMC_ASYNC_RSU_GET_ERROR_STATUS;
break;
case COMMAND_RSU_NOTIFY:
args.a0 = INTEL_SIP_SMC_ASYNC_RSU_NOTIFY;
args.a2 = p_msg->arg[0];
break;
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.
*/
scoped_guard(spinlock_bh, &actrl->trx_list_lock) {
hash_add(actrl->trx_list, &handle->next,
handle->transaction_id);
}
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;
}
scoped_guard(spinlock_bh, &actrl->trx_list_lock) {
hash_del(&handle->next);
}
deallocate_id:
ida_free(&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) {
case COMMAND_RSU_NOTIFY:
break;
case COMMAND_RSU_GET_SPT_TABLE:
data->kaddr1 = (void *)&handle->res.a2;
data->kaddr2 = (void *)&handle->res.a3;
break;
case COMMAND_RSU_STATUS:
/* COMMAND_RSU_STATUS has more elements than the cb_data
* can acomodate, so passing the response structure to the
* response function to be handled before done command is
* executed by the client.
*/
data->kaddr1 = (void *)&handle->res;
break;
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 to 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)
{
struct stratix10_svc_async_handler *handle;
struct arm_smccc_1_2_regs args = { 0 };
struct stratix10_svc_controller *ctrl;
struct stratix10_async_ctrl *actrl;
struct stratix10_async_chan *achan;
int ret;
if (!chan || !tx_handle || !data)
return -EINVAL;
ctrl = chan->ctrl;
actrl = &ctrl->actrl;
achan = chan->async_chan;
if (!achan) {
dev_err(ctrl->dev, "Async channel not allocated\n");
return -EINVAL;
}
handle = (struct stratix10_svc_async_handler *)tx_handle;
scoped_guard(spinlock_bh, &actrl->trx_list_lock) {
if (!hash_hashed(&handle->next)) {
dev_err(ctrl->dev, "Invalid transaction handler");
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);
/*clear data for response*/
memset(data, 0, sizeof(*data));
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)
{
struct stratix10_svc_async_handler *handle;
struct stratix10_svc_controller *ctrl;
struct stratix10_async_chan *achan;
struct stratix10_async_ctrl *actrl;
if (!chan || !tx_handle)
return -EINVAL;
ctrl = chan->ctrl;
achan = chan->async_chan;
actrl = &ctrl->actrl;
if (!achan) {
dev_err(ctrl->dev, "async channel not allocated\n");
return -EINVAL;
}
handle = (struct stratix10_svc_async_handler *)tx_handle;
scoped_guard(spinlock_bh, &actrl->trx_list_lock) {
if (!hash_hashed(&handle->next)) {
dev_err(ctrl->dev, "Invalid transaction handle");
return -EINVAL;
}
hash_del(&handle->next);
}
ida_free(&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 Stratix10 service
* controller for asynchronous operations.
* @controller: Pointer to the Stratix10 service controller structure.
*
* This function initializes the asynchronous service controller by
* setting up the necessary data structures and initializing the
* transaction list.
*
* 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)
{
struct stratix10_async_ctrl *actrl;
struct arm_smccc_res res;
struct device *dev;
int ret;
if (!controller)
return -EINVAL;
actrl = &controller->actrl;
if (actrl->initialized)
return -EINVAL;
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;
ida_init(&actrl->async_id_pool);
/**
* SIP_SVC_V1_CLIENT_ID is used by V1/stratix10_svc_send() clients
* for communicating with SDM synchronously. We need to restrict
* this in V3/stratix10_svc_async_send() usage to distinguish
* between V1 and V3 messages in El3 firmware.
*/
ret = ida_alloc_range(&actrl->async_id_pool, SIP_SVC_V1_CLIENT_ID,
SIP_SVC_V1_CLIENT_ID, GFP_KERNEL);
if (ret < 0) {
dev_err(dev,
"Intel Service Layer Driver: Error on reserving SIP_SVC_V1_CLIENT_ID\n");
ida_destroy(&actrl->async_id_pool);
actrl->invoke_fn = NULL;
return -EADDRINUSE;
}
spin_lock_init(&actrl->trx_list_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. 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)
{
struct stratix10_svc_async_handler *handler;
struct stratix10_async_ctrl *actrl;
struct hlist_node *tmp;
int i;
if (!ctrl)
return -EINVAL;
actrl = &ctrl->actrl;
if (!actrl->initialized)
return -EINVAL;
actrl->initialized = false;
scoped_guard(spinlock_bh, &actrl->trx_list_lock) {
hash_for_each_safe(actrl->trx_list, i, tmp, handler, next) {
ida_free(&handler->achan->job_id_pool,
STRATIX10_GET_JOBID(handler->transaction_id));
hash_del(&handler->next);
kfree(handler);
}
}
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;
}
}
ida_destroy(&actrl->async_id_pool);
actrl->invoke_fn = NULL;
return 0;
}
/**
* stratix10_svc_free_channel() - free service channel
* @chan: service channel to be freed
@@ -990,6 +1719,7 @@ int stratix10_svc_send(struct stratix10_svc_chan *chan, void *msg)
p_data->flag = ct->flags;
}
} else {
guard(mutex)(&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;
@@ -1072,6 +1802,7 @@ void *stratix10_svc_allocate_memory(struct stratix10_svc_chan *chan,
if (!pmem)
return ERR_PTR(-ENOMEM);
guard(mutex)(&svc_mem_lock);
va = gen_pool_alloc(genpool, s);
if (!va)
return ERR_PTR(-ENOMEM);
@@ -1100,6 +1831,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;
guard(mutex)(&svc_mem_lock);
list_for_each_entry(pmem, &svc_data_mem, node)
if (pmem->vaddr == kaddr) {
@@ -1174,11 +1906,18 @@ 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);
goto err_destroy_pool;
}
fifo_size = sizeof(struct stratix10_svc_data) * SVC_NUM_DATA_IN_FIFO;
ret = kfifo_alloc(&controller->svc_fifo, fifo_size, GFP_KERNEL);
if (ret) {
dev_err(dev, "failed to allocate FIFO\n");
goto err_destroy_pool;
goto err_async_exit;
}
spin_lock_init(&controller->svc_fifo_lock);
@@ -1197,6 +1936,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);
@@ -1249,6 +1993,8 @@ static int stratix10_svc_drv_probe(struct platform_device *pdev)
platform_device_unregister(svc->stratix10_svc_rsu);
err_free_kfifo:
kfifo_free(&controller->svc_fifo);
err_async_exit:
stratix10_svc_async_exit(controller);
err_destroy_pool:
gen_pool_destroy(genpool);
return ret;
@@ -1259,6 +2005,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);

111
include/linux/firmware/intel/stratix10-smc.h
View File

@@ -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,110 @@ 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_HWMON_READTEMP
* Sync call to request temperature
*
* Call register usage:
* a0 Temperature Channel
* a1-a7 not used
*
* Return status
* a0 INTEL_SIP_SMC_STATUS_OK
* a1 Temperature Value
* a2-a3 not used
*/
#define INTEL_SIP_SMC_FUNCID_HWMON_READTEMP 32
#define INTEL_SIP_SMC_HWMON_READTEMP \
INTEL_SIP_SMC_FAST_CALL_VAL(INTEL_SIP_SMC_FUNCID_HWMON_READTEMP)
/**
* Request INTEL_SIP_SMC_HWMON_READVOLT
* Sync call to request voltage
*
* Call register usage:
* a0 Voltage Channel
* a1-a7 not used
*
* Return status
* a0 INTEL_SIP_SMC_STATUS_OK
* a1 Voltage Value
* a2-a3 not used
*/
#define INTEL_SIP_SMC_FUNCID_HWMON_READVOLT 33
#define INTEL_SIP_SMC_HWMON_READVOLT \
INTEL_SIP_SMC_FAST_CALL_VAL(INTEL_SIP_SMC_FUNCID_HWMON_READVOLT)
/**
* 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)
/**
* Request INTEL_SIP_SMC_ASYNC_RSU_GET_SPT
* Async call to get RSU SPT from SDM.
* Call register usage:
* a0 INTEL_SIP_SMC_ASYNC_RSU_GET_SPT
* a1 transaction job id
* a2-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_FUNC_ID_RSU_GET_SPT (0xEA)
#define INTEL_SIP_SMC_ASYNC_RSU_GET_SPT \
INTEL_SIP_SMC_ASYNC_VAL(INTEL_SIP_SMC_ASYNC_FUNC_ID_RSU_GET_SPT)
/**
* Request INTEL_SIP_SMC_ASYNC_RSU_GET_ERROR_STATUS
* Async call to get RSU error status from SDM.
* Call register usage:
* a0 INTEL_SIP_SMC_ASYNC_RSU_GET_ERROR_STATUS
* a1 transaction job id
* a2-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_FUNC_ID_RSU_GET_ERROR_STATUS (0xEB)
#define INTEL_SIP_SMC_ASYNC_RSU_GET_ERROR_STATUS \
INTEL_SIP_SMC_ASYNC_VAL(INTEL_SIP_SMC_ASYNC_FUNC_ID_RSU_GET_ERROR_STATUS)
/**
* Request INTEL_SIP_SMC_ASYNC_RSU_NOTIFY
* Async call to send NOTIFY value to SDM.
* Call register usage:
* a0 INTEL_SIP_SMC_ASYNC_RSU_NOTIFY
* a1 transaction job id
* a2 notify value
* 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_FUNC_ID_RSU_NOTIFY (0xEC)
#define INTEL_SIP_SMC_ASYNC_RSU_NOTIFY \
INTEL_SIP_SMC_ASYNC_VAL(INTEL_SIP_SMC_ASYNC_FUNC_ID_RSU_NOTIFY)
#endif

100
include/linux/firmware/intel/stratix10-svc-client.h
View File

@@ -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
@@ -11,12 +12,14 @@
*
* fpga: for FPGA configuration
* rsu: for remote status update
* hwmon: for hardware monitoring (voltage and temperature)
*/
#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
*
* SVC_STATUS_OK:
@@ -70,6 +73,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 300
struct stratix10_svc_chan;
@@ -124,6 +128,9 @@ struct stratix10_svc_chan;
* @COMMAND_RSU_DCMF_STATUS: query firmware for the DCMF status
* return status is SVC_STATUS_OK or SVC_STATUS_ERROR
*
* @COMMAND_RSU_GET_SPT_TABLE: query firmware for SPT table
* return status is SVC_STATUS_OK or SVC_STATUS_ERROR
*
* @COMMAND_FCS_REQUEST_SERVICE: request validation of image from firmware,
* return status is SVC_STATUS_OK, SVC_STATUS_INVALID_PARAM
*
@@ -158,6 +165,7 @@ enum stratix10_svc_command_code {
COMMAND_RSU_DCMF_VERSION,
COMMAND_RSU_DCMF_STATUS,
COMMAND_FIRMWARE_VERSION,
COMMAND_RSU_GET_SPT_TABLE,
/* for FCS */
COMMAND_FCS_REQUEST_SERVICE = 20,
COMMAND_FCS_SEND_CERTIFICATE,
@@ -171,6 +179,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
};
/**
@@ -284,5 +295,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