drivers/firmware/stratix10-svc.c

// 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>
#include <linux/module.h>
#include <linux/mutex.h>
#include <linux/of.h>
#include <linux/of_platform.h>
#include <linux/platform_device.h>
#include <linux/slab.h>
#include <linux/spinlock.h>
#include <linux/string.h>
#include <linux/firmware/intel/stratix10-smc.h>
#include <linux/firmware/intel/stratix10-svc-client.h>
#include <linux/types.h>

/**
 * SVC_NUM_DATA_IN_FIFO - number of struct stratix10_svc_data in the FIFO
 *
 * SVC_NUM_CHANNEL - number of channel supported by service layer driver
 *
 * FPGA_CONFIG_DATA_CLAIM_TIMEOUT_MS - claim back the submitted buffer(s)
 * from the secure world for FPGA manager to reuse, or to free the buffer(s)
 * when all bit-stream data had be send.
 *
 * FPGA_CONFIG_STATUS_TIMEOUT_SEC - poll the FPGA configuration status,
 * service layer will return error to FPGA manager when timeout occurs,
 * timeout is set to 30 seconds (30 * 1000) at Intel Stratix10 SoC.
 */
#define SVC_NUM_DATA_IN_FIFO			8
#define SVC_NUM_CHANNEL				4
#define FPGA_CONFIG_DATA_CLAIM_TIMEOUT_MS	2000
#define FPGA_CONFIG_STATUS_TIMEOUT_SEC		30
#define BYTE_TO_WORD_SIZE              4

/* stratix10 service layer clients */
#define STRATIX10_RSU				"stratix10-rsu"
#define SOCFPGA_HWMON				"socfpga-hwmon"

/* 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,
			     struct arm_smccc_res *);
struct stratix10_svc_chan;

/**
 * struct stratix10_svc - svc private data
 * @stratix10_svc_rsu: pointer to stratix10 RSU device
 * @stratix10_svc_hwmon: pointer to stratix10 HWMON device
 */
struct stratix10_svc {
	struct platform_device *stratix10_svc_rsu;
	struct platform_device *stratix10_svc_hwmon;
};

/**
 * struct stratix10_svc_sh_memory - service shared memory structure
 * @sync_complete: state for a completion
 * @addr: physical address of shared memory block
 * @size: size of shared memory block
 * @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
 * at secure world.
 *
 * Service layer driver uses the physical address and size to create a memory
 * pool, then allocates data buffer from that memory pool for service client.
 */
struct stratix10_svc_sh_memory {
	struct completion sync_complete;
	unsigned long addr;
	unsigned long size;
	svc_invoke_fn *invoke_fn;
};

/**
 * struct stratix10_svc_data_mem - service memory structure
 * @vaddr: virtual address
 * @paddr: physical address
 * @size: size of memory
 * @node: link list head node
 *
 * This struct is used in a list that keeps track of buffers which have
 * been allocated or freed from the memory pool. Service layer driver also
 * uses this struct to transfer physical address to virtual address.
 */
struct stratix10_svc_data_mem {
	void *vaddr;
	phys_addr_t paddr;
	size_t size;
	struct list_head node;
};

/**
 * struct stratix10_svc_data - service data structure
 * @chan: service channel
 * @paddr: physical address of to be processed payload
 * @size: to be processed playload size
 * @paddr_output: physical address of processed payload
 * @size_output: processed payload size
 * @command: service command requested by client
 * @flag: configuration type (full or partial)
 * @arg: args to be passed via registers and not physically mapped buffers
 *
 * This struct is used in service FIFO for inter-process communication.
 */
struct stratix10_svc_data {
	struct stratix10_svc_chan *chan;
	phys_addr_t paddr;
	size_t size;
	phys_addr_t paddr_output;
	size_t size_output;
	u32 command;
	u32 flag;
	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
 * @supported: Flag indicating whether the system supports async 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 supported;
	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_chan - service communication channel
 * @ctrl: pointer to service controller which is the provider of this channel
 * @scl: pointer to service client which owns the channel
 * @name: service client name associated with the channel
 * @task: pointer to the thread task which handles SMC or HVC call
 * @svc_fifo: a queue for storing service message data (separate fifo for every channel)
 * @svc_fifo_lock: protect access to service message data queue (locking pending fifo)
 * @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.
 */
struct stratix10_svc_chan {
	struct stratix10_svc_controller *ctrl;
	struct stratix10_svc_client *scl;
	char *name;
	struct task_struct *task;
	struct kfifo svc_fifo;
	spinlock_t svc_fifo_lock;
	spinlock_t lock;
	struct stratix10_async_chan *async_chan;
};

/**
 * struct stratix10_svc_controller - service controller
 * @dev: device
 * @num_chans: number of channels in 'chans' array
 * @num_active_client: number of active service client
 * @node: list management
 * @genpool: memory pool pointing to the memory region
 * @complete_status: state for completion
 * @invoke_fn: function to issue secure monitor call or hypervisor call
 * @svc: manages the list of client svc drivers
 * @sdm_lock: only allows a single command single response to SDM
 * @actrl: async control structure
 * @chans: array of service channels
 *
 * This struct is used to create communication channels for service clients, to
 * handle secure monitor or hypervisor call.
 */
struct stratix10_svc_controller {
	struct device *dev;
	int num_chans;
	int num_active_client;
	struct list_head node;
	struct gen_pool *genpool;
	struct completion complete_status;
	svc_invoke_fn *invoke_fn;
	struct stratix10_svc *svc;
	struct mutex sdm_lock;
	struct stratix10_async_ctrl actrl;
	struct stratix10_svc_chan chans[] __counted_by(num_chans);
};

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
 *
 * Return: valid virtual address or NULL if the provided physical
 * address doesn't exist.
 */
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;

	/* physical address is not found */
	return NULL;
}

/**
 * svc_thread_cmd_data_claim() - claim back buffer from the secure world
 * @ctrl: pointer to service layer controller
 * @p_data: pointer to service data structure
 * @cb_data: pointer to callback data structure to service client
 *
 * Claim back the submitted buffers from the secure world and pass buffer
 * back to service client (FPGA manager, etc) for reuse.
 */
static void svc_thread_cmd_data_claim(struct stratix10_svc_controller *ctrl,
				      struct stratix10_svc_data *p_data,
				      struct stratix10_svc_cb_data *cb_data)
{
	struct arm_smccc_res res;
	unsigned long timeout;

	reinit_completion(&ctrl->complete_status);
	timeout = msecs_to_jiffies(FPGA_CONFIG_DATA_CLAIM_TIMEOUT_MS);

	pr_debug("%s: claim back the submitted buffer\n", __func__);
	do {
		ctrl->invoke_fn(INTEL_SIP_SMC_FPGA_CONFIG_COMPLETED_WRITE,
				0, 0, 0, 0, 0, 0, 0, &res);

		if (res.a0 == INTEL_SIP_SMC_STATUS_OK) {
			if (!res.a1) {
				complete(&ctrl->complete_status);
				break;
			}
			cb_data->status = BIT(SVC_STATUS_BUFFER_DONE);
			cb_data->kaddr1 = svc_pa_to_va(res.a1);
			cb_data->kaddr2 = (res.a2) ?
					  svc_pa_to_va(res.a2) : NULL;
			cb_data->kaddr3 = (res.a3) ?
					  svc_pa_to_va(res.a3) : NULL;
			p_data->chan->scl->receive_cb(p_data->chan->scl,
						      cb_data);
		} else {
			pr_debug("%s: secure world busy, polling again\n",
				 __func__);
		}
	} while (res.a0 == INTEL_SIP_SMC_STATUS_OK ||
		 res.a0 == INTEL_SIP_SMC_STATUS_BUSY ||
		 wait_for_completion_timeout(&ctrl->complete_status, timeout));
}

/**
 * svc_thread_cmd_config_status() - check configuration status
 * @ctrl: pointer to service layer controller
 * @p_data: pointer to service data structure
 * @cb_data: pointer to callback data structure to service client
 *
 * Check whether the secure firmware at secure world has finished the FPGA
 * configuration, and then inform FPGA manager the configuration status.
 */
static void svc_thread_cmd_config_status(struct stratix10_svc_controller *ctrl,
					 struct stratix10_svc_data *p_data,
					 struct stratix10_svc_cb_data *cb_data)
{
	struct arm_smccc_res res;
	int count_in_sec;
	unsigned long a0, a1, a2;

	cb_data->kaddr1 = NULL;
	cb_data->kaddr2 = NULL;
	cb_data->kaddr3 = NULL;
	cb_data->status = BIT(SVC_STATUS_ERROR);

	pr_debug("%s: polling config status\n", __func__);

	a0 = INTEL_SIP_SMC_FPGA_CONFIG_ISDONE;
	a1 = (unsigned long)p_data->paddr;
	a2 = (unsigned long)p_data->size;

	if (p_data->command == COMMAND_POLL_SERVICE_STATUS)
		a0 = INTEL_SIP_SMC_SERVICE_COMPLETED;

	count_in_sec = FPGA_CONFIG_STATUS_TIMEOUT_SEC;
	while (count_in_sec) {
		ctrl->invoke_fn(a0, a1, a2, 0, 0, 0, 0, 0, &res);
		if ((res.a0 == INTEL_SIP_SMC_STATUS_OK) ||
		    (res.a0 == INTEL_SIP_SMC_STATUS_ERROR) ||
		    (res.a0 == INTEL_SIP_SMC_STATUS_REJECTED))
			break;

		/*
		 * request is still in progress, wait one second then
		 * poll again
		 */
		msleep(1000);
		count_in_sec--;
	}

	if (!count_in_sec) {
		pr_err("%s: poll status timeout\n", __func__);
		cb_data->status = BIT(SVC_STATUS_BUSY);
	} else if (res.a0 == INTEL_SIP_SMC_STATUS_OK) {
		cb_data->status = BIT(SVC_STATUS_COMPLETED);
		cb_data->kaddr2 = (res.a2) ?
				  svc_pa_to_va(res.a2) : NULL;
		cb_data->kaddr3 = (res.a3) ? &res.a3 : NULL;
	} else {
		pr_err("%s: poll status error\n", __func__);
		cb_data->kaddr1 = &res.a1;
		cb_data->kaddr2 = (res.a2) ?
				  svc_pa_to_va(res.a2) : NULL;
		cb_data->kaddr3 = (res.a3) ? &res.a3 : NULL;
		cb_data->status = BIT(SVC_STATUS_ERROR);
	}

	p_data->chan->scl->receive_cb(p_data->chan->scl, cb_data);
}

/**
 * svc_thread_recv_status_ok() - handle the successful status
 * @p_data: pointer to service data structure
 * @cb_data: pointer to callback data structure to service client
 * @res: result from SMC or HVC call (a0-a3; used for routing and most commands)
 * @res12: full v1.2 result for %COMMAND_RSU_GET_DEVICE_INFO, else NULL
 *
 * Send back the correspond status to the service clients.
 */
static void svc_thread_recv_status_ok(struct stratix10_svc_data *p_data,
				      struct stratix10_svc_cb_data *cb_data,
				      struct arm_smccc_res res,
				      struct arm_smccc_1_2_regs *res12)
{
	cb_data->kaddr1 = NULL;
	cb_data->kaddr2 = NULL;
	cb_data->kaddr3 = NULL;

	switch (p_data->command) {
	case COMMAND_RECONFIG:
	case COMMAND_RSU_UPDATE:
	case COMMAND_RSU_NOTIFY:
	case COMMAND_FCS_REQUEST_SERVICE:
	case COMMAND_FCS_SEND_CERTIFICATE:
	case COMMAND_FCS_DATA_ENCRYPTION:
	case COMMAND_FCS_DATA_DECRYPTION:
	case COMMAND_FCS_GET_PROVISION_DATA:
		cb_data->status = BIT(SVC_STATUS_OK);
		break;
	case COMMAND_RECONFIG_DATA_SUBMIT:
		cb_data->status = BIT(SVC_STATUS_BUFFER_SUBMITTED);
		break;
	case COMMAND_RECONFIG_STATUS:
		cb_data->status = BIT(SVC_STATUS_COMPLETED);
		break;
	case COMMAND_RSU_RETRY:
	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;
	case COMMAND_SMC_SVC_VERSION:
		cb_data->status = BIT(SVC_STATUS_OK);
		cb_data->kaddr1 = &res.a1;
		cb_data->kaddr2 = &res.a2;
		break;
	case COMMAND_SMC_ATF_BUILD_VER:
		cb_data->status = BIT(SVC_STATUS_OK);
		cb_data->kaddr1 = &res.a1;
		cb_data->kaddr2 = &res.a2;
		cb_data->kaddr3 = &res.a3;
		break;
	case COMMAND_RSU_DCMF_VERSION:
		cb_data->status = BIT(SVC_STATUS_OK);
		cb_data->kaddr1 = &res.a1;
		cb_data->kaddr2 = &res.a2;
		break;
	case COMMAND_FCS_RANDOM_NUMBER_GEN:
	case COMMAND_POLL_SERVICE_STATUS:
		cb_data->status = BIT(SVC_STATUS_OK);
		cb_data->kaddr1 = &res.a1;
		cb_data->kaddr2 = svc_pa_to_va(res.a2);
		cb_data->kaddr3 = &res.a3;
		break;
	case COMMAND_MBOX_SEND_CMD:
		cb_data->status = BIT(SVC_STATUS_OK);
		cb_data->kaddr1 = &res.a1;
		/* SDM return size in u8. Convert size to u32 word */
		res.a2 = res.a2 * BYTE_TO_WORD_SIZE;
		cb_data->kaddr2 = &res.a2;
		break;
	case COMMAND_RSU_GET_DEVICE_INFO:
		if (WARN_ON(!res12)) {
			cb_data->status = BIT(SVC_STATUS_ERROR);
			break;
		}
		cb_data->status = BIT(SVC_STATUS_OK);
		cb_data->kaddr1 = res12;
		cb_data->kaddr2 = NULL;
		cb_data->kaddr3 = NULL;
		break;
	default:
		pr_warn("it shouldn't happen\n");
		break;
	}

	pr_debug("%s: call receive_cb\n", __func__);
	p_data->chan->scl->receive_cb(p_data->chan->scl, cb_data);
}

static void svc_smccc_1_2_full(struct stratix10_svc_controller *ctrl,
			       const struct arm_smccc_1_2_regs *args,
			       struct arm_smccc_1_2_regs *res);

/**
 * svc_normal_to_secure_thread() - the function to run in the kthread
 * @data: data pointer for kthread function
 *
 * Service layer driver creates stratix10_svc_smc_hvc_call kthread on CPU
 * node 0, its function stratix10_svc_secure_call_thread is used to handle
 * SMC or HVC calls between kernel driver and secure monitor software.
 *
 * Return: 0 for success or -ENOMEM on error.
 */
static int svc_normal_to_secure_thread(void *data)
{
	struct stratix10_svc_chan *chan = (struct stratix10_svc_chan *)data;
	struct stratix10_svc_controller *ctrl = chan->ctrl;
	struct stratix10_svc_data *pdata = NULL;
	struct stratix10_svc_cb_data *cbdata = NULL;
	struct arm_smccc_res res;
	struct arm_smccc_1_2_regs res12 = { 0 };
	unsigned long a0, a1, a2, a3, a4, a5, a6, a7;
	int ret_fifo = 0;

	pdata = kmalloc_obj(*pdata);
	if (!pdata)
		return -ENOMEM;

	cbdata = kmalloc_obj(*cbdata);
	if (!cbdata) {
		kfree(pdata);
		return -ENOMEM;
	}

	/* default set, to remove build warning */
	a0 = INTEL_SIP_SMC_FPGA_CONFIG_LOOPBACK;
	a1 = 0;
	a2 = 0;
	a3 = 0;
	a4 = 0;
	a5 = 0;
	a6 = 0;
	a7 = 0;

	pr_debug("%s: %s: Thread is running!\n", __func__, chan->name);

	while (!kthread_should_stop()) {
		ret_fifo = kfifo_out_spinlocked(&chan->svc_fifo,
						pdata, sizeof(*pdata),
						&chan->svc_fifo_lock);

		if (!ret_fifo)
			continue;

		pr_debug("get from FIFO pa=0x%016x, command=%u, size=%u\n",
			 (unsigned int)pdata->paddr, pdata->command,
			 (unsigned int)pdata->size);

		/* SDM can only process one command at a time */
		pr_debug("%s: %s: Thread is waiting for mutex!\n",
			 __func__, chan->name);
		if (mutex_lock_interruptible(&ctrl->sdm_lock)) {
			/* item already dequeued; notify client to unblock it */
			cbdata->status = BIT(SVC_STATUS_ERROR);
			cbdata->kaddr1 = NULL;
			cbdata->kaddr2 = NULL;
			cbdata->kaddr3 = NULL;
			if (pdata->chan->scl)
				pdata->chan->scl->receive_cb(pdata->chan->scl,
							     cbdata);
			break;
		}

		switch (pdata->command) {
		case COMMAND_RECONFIG_DATA_CLAIM:
			svc_thread_cmd_data_claim(ctrl, pdata, cbdata);
			mutex_unlock(&ctrl->sdm_lock);
			continue;
		case COMMAND_RECONFIG:
			a0 = INTEL_SIP_SMC_FPGA_CONFIG_START;
			pr_debug("conf_type=%u\n", (unsigned int)pdata->flag);
			a1 = pdata->flag;
			a2 = 0;
			break;
		case COMMAND_RECONFIG_DATA_SUBMIT:
			a0 = INTEL_SIP_SMC_FPGA_CONFIG_WRITE;
			a1 = (unsigned long)pdata->paddr;
			a2 = (unsigned long)pdata->size;
			break;
		case COMMAND_RECONFIG_STATUS:
			a0 = INTEL_SIP_SMC_FPGA_CONFIG_ISDONE;
			a1 = 0;
			a2 = 0;
			break;
		case COMMAND_RSU_STATUS:
			a0 = INTEL_SIP_SMC_RSU_STATUS;
			a1 = 0;
			a2 = 0;
			break;
		case COMMAND_RSU_UPDATE:
			a0 = INTEL_SIP_SMC_RSU_UPDATE;
			a1 = pdata->arg[0];
			a2 = 0;
			break;
		case COMMAND_RSU_NOTIFY:
			a0 = INTEL_SIP_SMC_RSU_NOTIFY;
			a1 = pdata->arg[0];
			a2 = 0;
			break;
		case COMMAND_RSU_RETRY:
			a0 = INTEL_SIP_SMC_RSU_RETRY_COUNTER;
			a1 = 0;
			a2 = 0;
			break;
		case COMMAND_RSU_MAX_RETRY:
			a0 = INTEL_SIP_SMC_RSU_MAX_RETRY;
			a1 = 0;
			a2 = 0;
			break;
		case COMMAND_RSU_DCMF_VERSION:
			a0 = INTEL_SIP_SMC_RSU_DCMF_VERSION;
			a1 = 0;
			a2 = 0;
			break;
		case COMMAND_FIRMWARE_VERSION:
			a0 = INTEL_SIP_SMC_FIRMWARE_VERSION;
			a1 = 0;
			a2 = 0;
			break;

		/* for FCS */
		case COMMAND_FCS_DATA_ENCRYPTION:
			a0 = INTEL_SIP_SMC_FCS_CRYPTION;
			a1 = 1;
			a2 = (unsigned long)pdata->paddr;
			a3 = (unsigned long)pdata->size;
			a4 = (unsigned long)pdata->paddr_output;
			a5 = (unsigned long)pdata->size_output;
			break;
		case COMMAND_FCS_DATA_DECRYPTION:
			a0 = INTEL_SIP_SMC_FCS_CRYPTION;
			a1 = 0;
			a2 = (unsigned long)pdata->paddr;
			a3 = (unsigned long)pdata->size;
			a4 = (unsigned long)pdata->paddr_output;
			a5 = (unsigned long)pdata->size_output;
			break;
		case COMMAND_FCS_RANDOM_NUMBER_GEN:
			a0 = INTEL_SIP_SMC_FCS_RANDOM_NUMBER;
			a1 = (unsigned long)pdata->paddr;
			a2 = 0;
			break;
		case COMMAND_FCS_REQUEST_SERVICE:
			a0 = INTEL_SIP_SMC_FCS_SERVICE_REQUEST;
			a1 = (unsigned long)pdata->paddr;
			a2 = (unsigned long)pdata->size;
			break;
		case COMMAND_FCS_SEND_CERTIFICATE:
			a0 = INTEL_SIP_SMC_FCS_SEND_CERTIFICATE;
			a1 = (unsigned long)pdata->paddr;
			a2 = (unsigned long)pdata->size;
			break;
		case COMMAND_FCS_GET_PROVISION_DATA:
			a0 = INTEL_SIP_SMC_FCS_GET_PROVISION_DATA;
			a1 = 0;
			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;
			a1 = (unsigned long)pdata->paddr;
			a2 = (unsigned long)pdata->size;
			break;
		case COMMAND_RSU_DCMF_STATUS:
			a0 = INTEL_SIP_SMC_RSU_DCMF_STATUS;
			a1 = 0;
			a2 = 0;
			break;
		case COMMAND_SMC_SVC_VERSION:
			a0 = INTEL_SIP_SMC_SVC_VERSION;
			a1 = 0;
			a2 = 0;
			break;
		case COMMAND_SMC_ATF_BUILD_VER:
			a0 = INTEL_SIP_SMC_ATF_BUILD_VER;
			a1 = 0;
			a2 = 0;
			a3 = 0;
			break;
		case COMMAND_MBOX_SEND_CMD:
			a0 = INTEL_SIP_SMC_MBOX_SEND_CMD;
			a1 = pdata->arg[0];
			a2 = (unsigned long)pdata->paddr;
			a3 = (unsigned long)pdata->size / BYTE_TO_WORD_SIZE;
			a4 = pdata->arg[1];
			a5 = (unsigned long)pdata->paddr_output;
			a6 = (unsigned long)pdata->size_output / BYTE_TO_WORD_SIZE;
			break;
		case COMMAND_RSU_GET_DEVICE_INFO:
			a0 = INTEL_SIP_SMC_RSU_GET_DEVICE_INFO;
			a1 = 0;
			a2 = 0;
			a3 = 0;
			a4 = 0;
			a5 = 0;
			a6 = 0;
			a7 = 0;
			break;
		default:
			pr_warn("it shouldn't happen\n");
			mutex_unlock(&ctrl->sdm_lock);
			continue;
		}
		pr_debug("%s: %s: before SMC call -- a0=0x%016x a1=0x%016x",
			 __func__, chan->name,
			 (unsigned int)a0,
			 (unsigned int)a1);
		pr_debug(" a2=0x%016x\n", (unsigned int)a2);
		pr_debug(" a3=0x%016x\n", (unsigned int)a3);
		pr_debug(" a4=0x%016x\n", (unsigned int)a4);
		pr_debug(" a5=0x%016x\n", (unsigned int)a5);
		if (pdata->command == COMMAND_RSU_GET_DEVICE_INFO) {
			struct arm_smccc_1_2_regs args12 = { 0 };

			args12.a0 = INTEL_SIP_SMC_RSU_GET_DEVICE_INFO;
			svc_smccc_1_2_full(ctrl, &args12, &res12);
			res.a0 = res12.a0;
			res.a1 = res12.a1;
			res.a2 = res12.a2;
			res.a3 = res12.a3;
		} else {
			ctrl->invoke_fn(a0, a1, a2, a3, a4, a5, a6, a7, &res);
		}

		pr_debug("%s: %s: after SMC call -- res.a0=0x%016x",
			 __func__, chan->name, (unsigned int)res.a0);
		pr_debug(" res.a1=0x%016x, res.a2=0x%016x",
			 (unsigned int)res.a1, (unsigned int)res.a2);
		pr_debug(" res.a3=0x%016x\n", (unsigned int)res.a3);

		if (pdata->command == COMMAND_RSU_STATUS) {
			if (res.a0 == INTEL_SIP_SMC_RSU_ERROR)
				cbdata->status = BIT(SVC_STATUS_ERROR);
			else
				cbdata->status = BIT(SVC_STATUS_OK);

			cbdata->kaddr1 = &res;
			cbdata->kaddr2 = NULL;
			cbdata->kaddr3 = NULL;
			pdata->chan->scl->receive_cb(pdata->chan->scl, cbdata);
			mutex_unlock(&ctrl->sdm_lock);
			continue;
		}

		switch (res.a0) {
		case INTEL_SIP_SMC_STATUS_OK: {
			struct arm_smccc_1_2_regs *devinfo_res =
				(pdata->command == COMMAND_RSU_GET_DEVICE_INFO) ?
				&res12 : NULL;

			svc_thread_recv_status_ok(pdata, cbdata, res,
						  devinfo_res);
			break;
		}
		case INTEL_SIP_SMC_STATUS_BUSY:
			switch (pdata->command) {
			case COMMAND_RECONFIG_DATA_SUBMIT:
				svc_thread_cmd_data_claim(ctrl,
							  pdata, cbdata);
				break;
			case COMMAND_RECONFIG_STATUS:
			case COMMAND_POLL_SERVICE_STATUS:
				svc_thread_cmd_config_status(ctrl,
							     pdata, cbdata);
				break;
			default:
				pr_warn("it shouldn't happen\n");
				break;
			}
			break;
		case INTEL_SIP_SMC_STATUS_REJECTED:
			pr_debug("%s: STATUS_REJECTED\n", __func__);
			/* for FCS */
			switch (pdata->command) {
			case COMMAND_FCS_REQUEST_SERVICE:
			case COMMAND_FCS_SEND_CERTIFICATE:
			case COMMAND_FCS_GET_PROVISION_DATA:
			case COMMAND_FCS_DATA_ENCRYPTION:
			case COMMAND_FCS_DATA_DECRYPTION:
			case COMMAND_FCS_RANDOM_NUMBER_GEN:
			case COMMAND_MBOX_SEND_CMD:
				cbdata->status = BIT(SVC_STATUS_INVALID_PARAM);
				cbdata->kaddr1 = NULL;
				cbdata->kaddr2 = NULL;
				cbdata->kaddr3 = NULL;
				pdata->chan->scl->receive_cb(pdata->chan->scl,
							     cbdata);
				break;
			}
			break;
		case INTEL_SIP_SMC_STATUS_ERROR:
		case INTEL_SIP_SMC_RSU_ERROR:
			pr_err("%s: STATUS_ERROR\n", __func__);
			cbdata->status = BIT(SVC_STATUS_ERROR);
			if (pdata->command == COMMAND_RSU_GET_DEVICE_INFO) {
				cbdata->kaddr1 = &res12;
				cbdata->kaddr2 = NULL;
				cbdata->kaddr3 = NULL;
			} else {
				cbdata->kaddr1 = &res.a1;
				cbdata->kaddr2 = (res.a2) ?
					svc_pa_to_va(res.a2) : NULL;
				cbdata->kaddr3 = (res.a3) ? &res.a3 : NULL;
			}
			pdata->chan->scl->receive_cb(pdata->chan->scl, cbdata);
			break;
		default:
			pr_warn("Secure firmware doesn't support...\n");

			/*
			 * be compatible with older version firmware which
			 * doesn't support newer RSU commands
			 */
			if ((pdata->command != COMMAND_RSU_UPDATE) &&
				(pdata->command != COMMAND_RSU_STATUS)) {
				cbdata->status =
					BIT(SVC_STATUS_NO_SUPPORT);
				cbdata->kaddr1 = NULL;
				cbdata->kaddr2 = NULL;
				cbdata->kaddr3 = NULL;
				pdata->chan->scl->receive_cb(
					pdata->chan->scl, cbdata);
			}
			break;

		}

		mutex_unlock(&ctrl->sdm_lock);
	}

	kfree(cbdata);
	kfree(pdata);

	return 0;
}

/**
 * svc_normal_to_secure_shm_thread() - the function to run in the kthread
 * @data: data pointer for kthread function
 *
 * Service layer driver creates stratix10_svc_smc_hvc_shm kthread on CPU
 * node 0, its function stratix10_svc_secure_shm_thread is used to query the
 * physical address of memory block reserved by secure monitor software at
 * secure world.
 *
 * svc_normal_to_secure_shm_thread() terminates directly since it is a
 * standlone thread for which no one will call kthread_stop() or return when
 * 'kthread_should_stop()' is true.
 */
static int svc_normal_to_secure_shm_thread(void *data)
{
	struct stratix10_svc_sh_memory
			*sh_mem = (struct stratix10_svc_sh_memory *)data;
	struct arm_smccc_res res;

	/* SMC or HVC call to get shared memory info from secure world */
	sh_mem->invoke_fn(INTEL_SIP_SMC_FPGA_CONFIG_GET_MEM,
			  0, 0, 0, 0, 0, 0, 0, &res);
	if (res.a0 == INTEL_SIP_SMC_STATUS_OK) {
		sh_mem->addr = res.a1;
		sh_mem->size = res.a2;
	} else {
		pr_err("%s: after SMC call -- res.a0=0x%016x",  __func__,
		       (unsigned int)res.a0);
		sh_mem->addr = 0;
		sh_mem->size = 0;
	}

	complete(&sh_mem->sync_complete);
	return 0;
}

/**
 * svc_get_sh_memory() - get memory block reserved by secure monitor SW
 * @pdev: pointer to service layer device
 * @sh_memory: pointer to service shared memory structure
 *
 * Return: zero for successfully getting the physical address of memory block
 * reserved by secure monitor software, or negative value on error.
 */
static int svc_get_sh_memory(struct platform_device *pdev,
				    struct stratix10_svc_sh_memory *sh_memory)
{
	struct device *dev = &pdev->dev;
	struct task_struct *sh_memory_task;
	unsigned int cpu = 0;

	init_completion(&sh_memory->sync_complete);

	/* smc or hvc call happens on cpu 0 bound kthread */
	sh_memory_task = kthread_create_on_node(svc_normal_to_secure_shm_thread,
					       (void *)sh_memory,
						cpu_to_node(cpu),
						"svc_smc_hvc_shm_thread");
	if (IS_ERR(sh_memory_task)) {
		dev_err(dev, "fail to create stratix10_svc_smc_shm_thread\n");
		return -EINVAL;
	}

	wake_up_process(sh_memory_task);

	if (!wait_for_completion_timeout(&sh_memory->sync_complete, 10 * HZ)) {
		dev_err(dev,
			"timeout to get sh-memory paras from secure world\n");
		return -ETIMEDOUT;
	}

	if (!sh_memory->addr || !sh_memory->size) {
		dev_err(dev,
			"failed to get shared memory info from secure world\n");
		return -ENOMEM;
	}

	dev_dbg(dev, "SM software provides paddr: 0x%016x, size: 0x%08x\n",
		(unsigned int)sh_memory->addr,
		(unsigned int)sh_memory->size);

	return 0;
}

/**
 * svc_create_memory_pool() - create a memory pool from reserved memory block
 * @pdev: pointer to service layer device
 * @sh_memory: pointer to service shared memory structure
 *
 * Return: pool allocated from reserved memory block or ERR_PTR() on error.
 */
static struct gen_pool *
svc_create_memory_pool(struct platform_device *pdev,
		       struct stratix10_svc_sh_memory *sh_memory)
{
	struct device *dev = &pdev->dev;
	struct gen_pool *genpool;
	unsigned long vaddr;
	phys_addr_t paddr;
	size_t size;
	phys_addr_t begin;
	phys_addr_t end;
	void *va;
	size_t page_mask = PAGE_SIZE - 1;
	int min_alloc_order = 3;
	int ret;

	begin = roundup(sh_memory->addr, PAGE_SIZE);
	end = rounddown(sh_memory->addr + sh_memory->size, PAGE_SIZE);
	paddr = begin;
	size = end - begin;
	va = devm_memremap(dev, paddr, size, MEMREMAP_WC);
	if (IS_ERR(va)) {
		dev_err(dev, "fail to remap shared memory\n");
		return ERR_PTR(-EINVAL);
	}
	vaddr = (unsigned long)va;
	dev_dbg(dev,
		"reserved memory vaddr: %p, paddr: 0x%16x size: 0x%8x\n",
		va, (unsigned int)paddr, (unsigned int)size);
	if ((vaddr & page_mask) || (paddr & page_mask) ||
	    (size & page_mask)) {
		dev_err(dev, "page is not aligned\n");
		return ERR_PTR(-EINVAL);
	}
	genpool = gen_pool_create(min_alloc_order, -1);
	if (!genpool) {
		dev_err(dev, "fail to create genpool\n");
		return ERR_PTR(-ENOMEM);
	}
	gen_pool_set_algo(genpool, gen_pool_best_fit, NULL);
	ret = gen_pool_add_virt(genpool, vaddr, paddr, size, -1);
	if (ret) {
		dev_err(dev, "fail to add memory chunk to the pool\n");
		gen_pool_destroy(genpool);
		return ERR_PTR(ret);
	}

	return genpool;
}

/**
 * svc_smccc_smc() - secure monitor call between normal and secure world
 * @a0: argument passed in registers 0
 * @a1: argument passed in registers 1
 * @a2: argument passed in registers 2
 * @a3: argument passed in registers 3
 * @a4: argument passed in registers 4
 * @a5: argument passed in registers 5
 * @a6: argument passed in registers 6
 * @a7: argument passed in registers 7
 * @res: result values from register 0 to 3
 */
static void svc_smccc_smc(unsigned long a0, unsigned long a1,
			  unsigned long a2, unsigned long a3,
			  unsigned long a4, unsigned long a5,
			  unsigned long a6, unsigned long a7,
			  struct arm_smccc_res *res)
{
	arm_smccc_smc(a0, a1, a2, a3, a4, a5, a6, a7, res);
}

/**
 * svc_smccc_hvc() - hypervisor call between normal and secure world
 * @a0: argument passed in registers 0
 * @a1: argument passed in registers 1
 * @a2: argument passed in registers 2
 * @a3: argument passed in registers 3
 * @a4: argument passed in registers 4
 * @a5: argument passed in registers 5
 * @a6: argument passed in registers 6
 * @a7: argument passed in registers 7
 * @res: result values from register 0 to 3
 */
static void svc_smccc_hvc(unsigned long a0, unsigned long a1,
			  unsigned long a2, unsigned long a3,
			  unsigned long a4, unsigned long a5,
			  unsigned long a6, unsigned long a7,
			  struct arm_smccc_res *res)
{
	arm_smccc_hvc(a0, a1, a2, a3, a4, a5, a6, a7, res);
}

/**
 * svc_smccc_1_2_full() - SMC/HVC v1.2 call matching the sync channel method
 * @ctrl: service controller (selects SMC vs HVC)
 * @args: arguments
 * @res: full register-file result (a0-a17)
 */
static void svc_smccc_1_2_full(struct stratix10_svc_controller *ctrl,
			       const struct arm_smccc_1_2_regs *args,
			       struct arm_smccc_1_2_regs *res)
{
	if (ctrl->invoke_fn == svc_smccc_smc) {
		arm_smccc_1_2_smc(args, res);
	} else if (ctrl->invoke_fn == svc_smccc_hvc) {
		arm_smccc_1_2_hvc(args, res);
	} else {
		WARN_ON_ONCE(1);
		/*
		 * INTEL_SIP_SMC_STATUS_OK is 0; zero-filled res would be misrouted
		 * as success. Force an error path and clear fabricated payload.
		 */
		memset(res, 0, sizeof(*res));
		res->a0 = INTEL_SIP_SMC_STATUS_ERROR;
	}
}

/**
 * get_invoke_func() - invoke SMC or HVC call
 * @dev: pointer to device
 *
 * Return: function pointer to svc_smccc_smc or svc_smccc_hvc.
 */
static svc_invoke_fn *get_invoke_func(struct device *dev)
{
	const char *method;

	if (of_property_read_string(dev->of_node, "method", &method)) {
		dev_warn(dev, "missing \"method\" property\n");
		return ERR_PTR(-ENXIO);
	}

	if (!strcmp(method, "smc"))
		return svc_smccc_smc;
	if (!strcmp(method, "hvc"))
		return svc_smccc_hvc;

	dev_warn(dev, "invalid \"method\" property: %s\n", method);

	return ERR_PTR(-EINVAL);
}

/**
 * stratix10_svc_request_channel_byname() - request a service channel
 * @client: pointer to service client
 * @name: service client name
 *
 * This function is used by service client to request a service channel.
 *
 * Return: a pointer to channel assigned to the client on success,
 * or ERR_PTR() on error.
 */
struct stratix10_svc_chan *stratix10_svc_request_channel_byname(
	struct stratix10_svc_client *client, const char *name)
{
	struct device *dev = client->dev;
	struct stratix10_svc_controller *controller;
	struct stratix10_svc_chan *chan = NULL;
	unsigned long flag;
	int i;

	/* if probe was called after client's, or error on probe */
	if (list_empty(&svc_ctrl))
		return ERR_PTR(-EPROBE_DEFER);

	controller = list_first_entry(&svc_ctrl,
				      struct stratix10_svc_controller, node);
	for (i = 0; i < SVC_NUM_CHANNEL; i++) {
		if (!strcmp(controller->chans[i].name, name)) {
			chan = &controller->chans[i];
			break;
		}
	}

	/* if there was no channel match */
	if (i == SVC_NUM_CHANNEL) {
		dev_err(dev, "%s: channel not allocated\n", __func__);
		return ERR_PTR(-EINVAL);
	}

	if (chan->scl || !try_module_get(controller->dev->driver->owner)) {
		dev_dbg(dev, "%s: svc not free\n", __func__);
		return ERR_PTR(-EBUSY);
	}

	spin_lock_irqsave(&chan->lock, flag);
	chan->scl = client;
	chan->ctrl->num_active_client++;
	spin_unlock_irqrestore(&chan->lock, flag);

	return chan;
}
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.
 *         -EOPNOTSUPP if async operations are not supported.
 *         -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->supported)
		return -EOPNOTSUPP;

	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_obj(*achan);
	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;
	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;
		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;
	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;
	}
	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 ||
		   handle->res.a0 == INTEL_SIP_SMC_STATUS_NO_RESPONSE) {
		dev_dbg(ctrl->dev, "async message is not ready yet\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.
 *         -EOPNOTSUPP if system doesn't support async operations.
 */
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_info(dev,
			 "Intel Service Layer Driver: ATF version is not compatible for async operation\n");
		actrl->supported = false;
		return -EOPNOTSUPP;
	}
	actrl->supported = true;

	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
 *
 * This function is used by service client to free a service channel.
 */
void stratix10_svc_free_channel(struct stratix10_svc_chan *chan)
{
	unsigned long flag;

	spin_lock_irqsave(&chan->lock, flag);
	chan->scl = NULL;
	chan->ctrl->num_active_client--;
	module_put(chan->ctrl->dev->driver->owner);
	spin_unlock_irqrestore(&chan->lock, flag);
}
EXPORT_SYMBOL_GPL(stratix10_svc_free_channel);

/**
 * stratix10_svc_send() - send a message data to the remote
 * @chan: service channel assigned to the client
 * @msg: message data to be sent, in the format of
 * "struct stratix10_svc_client_msg"
 *
 * This function is used by service client to add a message to the service
 * layer driver's queue for being sent to the secure world.
 *
 * Return: 0 for success, -ENOMEM or -ENOBUFS on error.
 */
int stratix10_svc_send(struct stratix10_svc_chan *chan, void *msg)
{
	struct stratix10_svc_client_msg
		*p_msg = (struct stratix10_svc_client_msg *)msg;
	struct stratix10_svc_data_mem *p_mem;
	struct stratix10_svc_data *p_data;
	int ret = 0;
	unsigned int cpu = 0;

	p_data = kzalloc_obj(*p_data);
	if (!p_data)
		return -ENOMEM;

	/* first caller creates the per-channel kthread */
	if (!chan->task) {
		struct task_struct *task;

		task = kthread_run_on_cpu(svc_normal_to_secure_thread,
					  (void *)chan,
					  cpu, "svc_smc_hvc_thread");
		if (IS_ERR(task)) {
			dev_err(chan->ctrl->dev,
				"failed to create svc_smc_hvc_thread\n");
			kfree(p_data);
			return -EINVAL;
		}

		spin_lock(&chan->lock);
		if (chan->task) {
			/* another caller won the race; discard our thread */
			spin_unlock(&chan->lock);
			kthread_stop(task);
		} else {
			chan->task = task;
			spin_unlock(&chan->lock);
		}
	}

	pr_debug("%s: %s: sent P-va=%p, P-com=%x, P-size=%u\n", __func__,
		 chan->name, p_msg->payload, p_msg->command,
		 (unsigned int)p_msg->payload_length);

	if (list_empty(&svc_data_mem)) {
		if (p_msg->command == COMMAND_RECONFIG) {
			struct stratix10_svc_command_config_type *ct =
				(struct stratix10_svc_command_config_type *)
				p_msg->payload;
			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;
				p_data->size = p_msg->payload_length;
				break;
			}
		if (p_msg->payload_output) {
			list_for_each_entry(p_mem, &svc_data_mem, node)
				if (p_mem->vaddr == p_msg->payload_output) {
					p_data->paddr_output =
						p_mem->paddr;
					p_data->size_output =
						p_msg->payload_length_output;
					break;
				}
		}
	}

	p_data->command = p_msg->command;
	p_data->arg[0] = p_msg->arg[0];
	p_data->arg[1] = p_msg->arg[1];
	p_data->arg[2] = p_msg->arg[2];
	p_data->size = p_msg->payload_length;
	p_data->chan = chan;
	pr_debug("%s: %s: put to FIFO pa=0x%016x, cmd=%x, size=%u\n",
		 __func__,
		 chan->name,
		 (unsigned int)p_data->paddr,
		 p_data->command,
		 (unsigned int)p_data->size);

	ret = kfifo_in_spinlocked(&chan->svc_fifo, p_data,
				  sizeof(*p_data),
				  &chan->svc_fifo_lock);

	kfree(p_data);

	if (!ret)
		return -ENOBUFS;

	return 0;
}
EXPORT_SYMBOL_GPL(stratix10_svc_send);

/**
 * stratix10_svc_done() - complete service request transactions
 * @chan: service channel assigned to the client
 *
 * This function should be called when client has finished its request
 * or there is an error in the request process. It allows the service layer
 * to stop the running thread to have maximize savings in kernel resources.
 */
void stratix10_svc_done(struct stratix10_svc_chan *chan)
{
	/* stop thread when thread is running */
	if (chan->task) {
		pr_debug("%s: %s: svc_smc_hvc_shm_thread is stopping\n",
			 __func__, chan->name);
		kthread_stop(chan->task);
		chan->task = NULL;
	}
}
EXPORT_SYMBOL_GPL(stratix10_svc_done);

/**
 * stratix10_svc_allocate_memory() - allocate memory
 * @chan: service channel assigned to the client
 * @size: memory size requested by a specific service client
 *
 * Service layer allocates the requested number of bytes buffer from the
 * memory pool, service client uses this function to get allocated buffers.
 *
 * Return: address of allocated memory on success, or ERR_PTR() on error.
 */
void *stratix10_svc_allocate_memory(struct stratix10_svc_chan *chan,
				    size_t size)
{
	struct stratix10_svc_data_mem *pmem;
	unsigned long va;
	phys_addr_t pa;
	struct gen_pool *genpool = chan->ctrl->genpool;
	size_t s = roundup(size, 1 << genpool->min_alloc_order);

	pmem = kzalloc_obj(*pmem);
	if (!pmem)
		return ERR_PTR(-ENOMEM);

	guard(mutex)(&svc_mem_lock);
	va = gen_pool_alloc(genpool, s);
	if (!va) {
		kfree(pmem);
		return ERR_PTR(-ENOMEM);
	}

	memset((void *)va, 0, s);
	pa = gen_pool_virt_to_phys(genpool, va);

	pmem->vaddr = (void *)va;
	pmem->paddr = pa;
	pmem->size = s;
	list_add_tail(&pmem->node, &svc_data_mem);
	pr_debug("%s: %s: va=%p, pa=0x%016x\n", __func__,
		 chan->name, pmem->vaddr, (unsigned int)pmem->paddr);

	return (void *)va;
}
EXPORT_SYMBOL_GPL(stratix10_svc_allocate_memory);

/**
 * stratix10_svc_free_memory() - free allocated memory
 * @chan: service channel assigned to the client
 * @kaddr: memory to be freed
 *
 * This function is used by service client to free allocated buffers.
 */
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) {
			gen_pool_free(chan->ctrl->genpool,
				       (unsigned long)kaddr, pmem->size);
			pmem->vaddr = NULL;
			list_del(&pmem->node);
			kfree(pmem);
			return;
		}
}
EXPORT_SYMBOL_GPL(stratix10_svc_free_memory);

static const struct of_device_id stratix10_svc_drv_match[] = {
	{.compatible = "intel,stratix10-svc"},
	{.compatible = "intel,agilex-svc"},
	{},
};

static const char * const chan_names[SVC_NUM_CHANNEL] = {
	SVC_CLIENT_FPGA,
	SVC_CLIENT_RSU,
	SVC_CLIENT_FCS,
	SVC_CLIENT_HWMON
};

static int stratix10_svc_drv_probe(struct platform_device *pdev)
{
	struct device *dev = &pdev->dev;
	struct stratix10_svc_controller *controller;
	struct gen_pool *genpool;
	struct stratix10_svc_sh_memory *sh_memory;
	struct stratix10_svc *svc = NULL;

	svc_invoke_fn *invoke_fn;
	size_t fifo_size;
	int ret, i = 0;

	/* get SMC or HVC function */
	invoke_fn = get_invoke_func(dev);
	if (IS_ERR(invoke_fn))
		return -EINVAL;

	sh_memory = devm_kzalloc(dev, sizeof(*sh_memory), GFP_KERNEL);
	if (!sh_memory)
		return -ENOMEM;

	sh_memory->invoke_fn = invoke_fn;
	ret = svc_get_sh_memory(pdev, sh_memory);
	if (ret)
		return ret;

	genpool = svc_create_memory_pool(pdev, sh_memory);
	if (IS_ERR(genpool))
		return PTR_ERR(genpool);

	/* allocate service controller and supporting channel */
	controller = devm_kzalloc(dev, struct_size(controller, chans, SVC_NUM_CHANNEL),
				GFP_KERNEL);
	if (!controller) {
		ret = -ENOMEM;
		goto err_destroy_pool;
	}

	controller->num_chans = SVC_NUM_CHANNEL;
	controller->dev = dev;
	controller->num_active_client = 0;
	controller->genpool = genpool;
	controller->invoke_fn = invoke_fn;
	INIT_LIST_HEAD(&controller->node);
	init_completion(&controller->complete_status);

	ret = stratix10_svc_async_init(controller);
	if (ret == -EOPNOTSUPP) {
		dev_info(dev, "Intel Service Layer Driver Initialized (sync-only mode)\n");
	} else if (ret) {
		dev_dbg(dev, "Intel Service Layer Driver: Error on stratix10_svc_async_init %d\n",
			ret);
		goto err_destroy_pool;
	} else {
		dev_info(dev, "Intel Service Layer Driver Initialized\n");
	}

	fifo_size = sizeof(struct stratix10_svc_data) * SVC_NUM_DATA_IN_FIFO;
	mutex_init(&controller->sdm_lock);

	for (i = 0; i < SVC_NUM_CHANNEL; i++) {
		controller->chans[i].scl = NULL;
		controller->chans[i].ctrl = controller;
		controller->chans[i].name = (char *)chan_names[i];
		spin_lock_init(&controller->chans[i].lock);
		ret = kfifo_alloc(&controller->chans[i].svc_fifo, fifo_size, GFP_KERNEL);
		if (ret) {
			dev_err(dev, "failed to allocate FIFO %d\n", i);
			goto err_free_fifos;
		}
		spin_lock_init(&controller->chans[i].svc_fifo_lock);
	}

	list_add_tail(&controller->node, &svc_ctrl);
	platform_set_drvdata(pdev, controller);

	/* add svc client device(s) */
	svc = devm_kzalloc(dev, sizeof(*svc), GFP_KERNEL);
	if (!svc) {
		ret = -ENOMEM;
		goto err_free_fifos;
	}
	controller->svc = svc;

	svc->stratix10_svc_rsu = platform_device_alloc(STRATIX10_RSU, 0);
	if (!svc->stratix10_svc_rsu) {
		dev_err(dev, "failed to allocate %s device\n", STRATIX10_RSU);
		ret = -ENOMEM;
		goto err_free_fifos;
	}

	ret = platform_device_add(svc->stratix10_svc_rsu);
	if (ret)
		goto err_put_device;

	if (IS_ENABLED(CONFIG_SENSORS_ALTERA_SOCFPGA_HWMON)) {
		svc->stratix10_svc_hwmon =
			platform_device_alloc(SOCFPGA_HWMON, 0);
		if (!svc->stratix10_svc_hwmon) {
			dev_err(dev, "failed to allocate %s device\n",
				SOCFPGA_HWMON);
		} else {
			svc->stratix10_svc_hwmon->dev.parent = dev;

			ret = platform_device_add(svc->stratix10_svc_hwmon);
			if (ret) {
				dev_err(dev, "failed to add %s device: %d\n",
					SOCFPGA_HWMON, ret);
				platform_device_put(svc->stratix10_svc_hwmon);
				svc->stratix10_svc_hwmon = NULL;
			}
		}
	}

	ret = of_platform_default_populate(dev_of_node(dev), NULL, dev);
	if (ret)
		goto err_unregister_clients;

	pr_info("Intel Service Layer Driver Initialized\n");

	return 0;

err_unregister_clients:
	if (svc->stratix10_svc_hwmon)
		platform_device_unregister(svc->stratix10_svc_hwmon);
	if (svc->stratix10_svc_rsu)
		platform_device_unregister(svc->stratix10_svc_rsu);
	goto err_free_fifos;
err_put_device:
	platform_device_put(svc->stratix10_svc_rsu);
err_free_fifos:
	/* only remove from list if list_add_tail() was reached */
	if (!list_empty(&controller->node))
		list_del(&controller->node);
	/* free only the FIFOs that were successfully allocated */
	while (i--)
		kfifo_free(&controller->chans[i].svc_fifo);
	stratix10_svc_async_exit(controller);
err_destroy_pool:
	gen_pool_destroy(genpool);

	return ret;
}

static void stratix10_svc_drv_remove(struct platform_device *pdev)
{
	int i;
	struct stratix10_svc_controller *ctrl = platform_get_drvdata(pdev);
	struct stratix10_svc *svc = ctrl->svc;

	platform_device_unregister(svc->stratix10_svc_rsu);
	if (svc->stratix10_svc_hwmon)
		platform_device_unregister(svc->stratix10_svc_hwmon);

	stratix10_svc_async_exit(ctrl);

	of_platform_depopulate(ctrl->dev);

	for (i = 0; i < SVC_NUM_CHANNEL; i++) {
		if (ctrl->chans[i].task) {
			kthread_stop(ctrl->chans[i].task);
			ctrl->chans[i].task = NULL;
		}
		kfifo_free(&ctrl->chans[i].svc_fifo);
	}

	if (ctrl->genpool)
		gen_pool_destroy(ctrl->genpool);
	list_del(&ctrl->node);
}

static struct platform_driver stratix10_svc_driver = {
	.probe = stratix10_svc_drv_probe,
	.remove = stratix10_svc_drv_remove,
	.driver = {
		.name = "stratix10-svc",
		.of_match_table = stratix10_svc_drv_match,
	},
};

static int __init stratix10_svc_init(void)
{
	struct device_node *fw_np;
	struct device_node *np;
	int ret;

	fw_np = of_find_node_by_name(NULL, "firmware");
	if (!fw_np)
		return -ENODEV;

	np = of_find_matching_node(fw_np, stratix10_svc_drv_match);
	if (!np)
		return -ENODEV;

	of_node_put(np);
	ret = of_platform_populate(fw_np, stratix10_svc_drv_match, NULL, NULL);
	if (ret)
		return ret;

	return platform_driver_register(&stratix10_svc_driver);
}

static void __exit stratix10_svc_exit(void)
{
	return platform_driver_unregister(&stratix10_svc_driver);
}

subsys_initcall(stratix10_svc_init);
module_exit(stratix10_svc_exit);

MODULE_LICENSE("GPL v2");
MODULE_DESCRIPTION("Intel Stratix10 Service Layer Driver");
MODULE_AUTHOR("Richard Gong <richard.gong@intel.com>");
MODULE_ALIAS("platform:stratix10-svc");