Commit b6b7c77c authored by Cristian Marussi's avatar Cristian Marussi Committed by Sudeep Holla
Browse files

firmware: arm_scmi: Introduce packet handling helpers 



Introduce a pair of structures initialized to contain all the existing
packet handling helpers, both for transports based on shared memory
and messages.

No functional change.

Signed-off-by: default avatarCristian Marussi <cristian.marussi@arm.com>
Tested-by: Peng Fan <peng.fan@nxp.com>  #i.MX95 19x19 EVK
Tested-by: default avatarFlorian Fainelli <florian.fainelli@broadcom.com>
Message-Id: <20240812173340.3912830-4-cristian.marussi@arm.com>
Signed-off-by: default avatarSudeep Holla <sudeep.holla@arm.com>
parent 1ebc28e9

drivers/firmware/arm_scmi/common.h

+56 −22
Original line number Diff line number Diff line
@@ -4,7 +4,7 @@ 
 * driver common header file containing some definitions, structures

 * and function prototypes used in all the different SCMI protocols.

 *

 * Copyright (C) 2018-2022 ARM Ltd.

 * Copyright (C) 2018-2024 ARM Ltd.

 */

#ifndef _SCMI_COMMON_H

#define _SCMI_COMMON_H
@@ -339,20 +339,39 @@ void scmi_bad_message_trace(struct scmi_chan_info *cinfo, u32 msg_hdr, 
/* shmem related declarations */

struct scmi_shared_mem;



void shmem_tx_prepare(struct scmi_shared_mem __iomem *shmem,

		      struct scmi_xfer *xfer, struct scmi_chan_info *cinfo);

u32 shmem_read_header(struct scmi_shared_mem __iomem *shmem);

void shmem_fetch_response(struct scmi_shared_mem __iomem *shmem,

/**

 * struct scmi_shared_mem_operations  - Transport core operations for

 * Shared Memory

 *

 * @tx_prepare: Prepare the @xfer message for transmission on the chosen @shmem

 * @read_header: Read header of the message currently hold in @shmem

 * @fetch_response: Copy the message response from @shmem into @xfer

 * @fetch_notification: Copy the message notification from @shmem into @xfer

 * @clear_channel: Clear the @shmem channel busy flag

 * @poll_done: Check if poll has completed for @xfer on @shmem

 * @channel_free: Check if @shmem channel is marked as free

 * @channel_intr_enabled: Check is @shmem channel has requested a completion irq

 * @setup_iomap: Setup IO shared memory for channel @cinfo

 */

struct scmi_shared_mem_operations {

	void (*tx_prepare)(struct scmi_shared_mem __iomem *shmem,

			   struct scmi_xfer *xfer,

			   struct scmi_chan_info *cinfo);

	u32 (*read_header)(struct scmi_shared_mem __iomem *shmem);



	void (*fetch_response)(struct scmi_shared_mem __iomem *shmem,

			       struct scmi_xfer *xfer);

void shmem_fetch_notification(struct scmi_shared_mem __iomem *shmem,

	void (*fetch_notification)(struct scmi_shared_mem __iomem *shmem,

				   size_t max_len, struct scmi_xfer *xfer);

void shmem_clear_channel(struct scmi_shared_mem __iomem *shmem);

bool shmem_poll_done(struct scmi_shared_mem __iomem *shmem,

	void (*clear_channel)(struct scmi_shared_mem __iomem *shmem);

	bool (*poll_done)(struct scmi_shared_mem __iomem *shmem,

			  struct scmi_xfer *xfer);

bool shmem_channel_free(struct scmi_shared_mem __iomem *shmem);

bool shmem_channel_intr_enabled(struct scmi_shared_mem __iomem *shmem);

void __iomem *setup_shmem_iomap(struct scmi_chan_info *cinfo, struct device *dev,

	bool (*channel_free)(struct scmi_shared_mem __iomem *shmem);

	bool (*channel_intr_enabled)(struct scmi_shared_mem __iomem *shmem);

	void __iomem *(*setup_iomap)(struct scmi_chan_info *cinfo,

				     struct device *dev,

				     bool tx, struct resource *res);

};



/* declarations for message passing transports */

struct scmi_msg_payld;
@@ -360,14 +379,29 @@ struct scmi_msg_payld; 
/* Maximum overhead of message w.r.t. struct scmi_desc.max_msg_size */

#define SCMI_MSG_MAX_PROT_OVERHEAD (2 * sizeof(__le32))



size_t msg_response_size(struct scmi_xfer *xfer);

size_t msg_command_size(struct scmi_xfer *xfer);

void msg_tx_prepare(struct scmi_msg_payld *msg, struct scmi_xfer *xfer);

u32 msg_read_header(struct scmi_msg_payld *msg);

void msg_fetch_response(struct scmi_msg_payld *msg, size_t len,

/**

 * struct scmi_message_operations  - Transport core operations for Message

 *

 * @response_size: Get calculated response size for @xfer

 * @command_size: Get calculated command size for @xfer

 * @tx_prepare: Prepare the @xfer message for transmission on the provided @msg

 * @read_header: Read header of the message currently hold in @msg

 * @fetch_response: Copy the message response from @msg into @xfer

 * @fetch_notification: Copy the message notification from @msg into @xfer

 */

struct scmi_message_operations {

	size_t (*response_size)(struct scmi_xfer *xfer);

	size_t (*command_size)(struct scmi_xfer *xfer);

	void (*tx_prepare)(struct scmi_msg_payld *msg, struct scmi_xfer *xfer);

	u32 (*read_header)(struct scmi_msg_payld *msg);

	void (*fetch_response)(struct scmi_msg_payld *msg, size_t len,

			       struct scmi_xfer *xfer);

void msg_fetch_notification(struct scmi_msg_payld *msg, size_t len,

	void (*fetch_notification)(struct scmi_msg_payld *msg, size_t len,

				   size_t max_len, struct scmi_xfer *xfer);

};



extern const struct scmi_shared_mem_operations scmi_shmem_ops;

extern const struct scmi_message_operations scmi_msg_ops;



void scmi_notification_instance_data_set(const struct scmi_handle *handle,

					 void *priv);

drivers/firmware/arm_scmi/mailbox.c

+10 −10
Original line number Diff line number Diff line
@@ -40,7 +40,7 @@ static void tx_prepare(struct mbox_client *cl, void *m) 
{

	struct scmi_mailbox *smbox = client_to_scmi_mailbox(cl);



	shmem_tx_prepare(smbox->shmem, m, smbox->cinfo);

	scmi_shmem_ops.tx_prepare(smbox->shmem, m, smbox->cinfo);

}



static void rx_callback(struct mbox_client *cl, void *m)
@@ -56,15 +56,15 @@ static void rx_callback(struct mbox_client *cl, void *m) 
	 * a previous timed-out reply which arrived late could be wrongly

	 * associated with the next pending transaction.

	 */

	if (cl->knows_txdone && !shmem_channel_free(smbox->shmem)) {

	if (cl->knows_txdone && !scmi_shmem_ops.channel_free(smbox->shmem)) {

		dev_warn(smbox->cinfo->dev, "Ignoring spurious A2P IRQ !\n");

		scmi_bad_message_trace(smbox->cinfo,

				       shmem_read_header(smbox->shmem),

				       scmi_shmem_ops.read_header(smbox->shmem),

				       MSG_MBOX_SPURIOUS);

		return;

	}



	scmi_rx_callback(smbox->cinfo, shmem_read_header(smbox->shmem), NULL);

	scmi_rx_callback(smbox->cinfo, scmi_shmem_ops.read_header(smbox->shmem), NULL);

}



static bool mailbox_chan_available(struct device_node *of_node, int idx)
@@ -192,7 +192,7 @@ static int mailbox_chan_setup(struct scmi_chan_info *cinfo, struct device *dev, 
	if (!smbox)

		return -ENOMEM;



	smbox->shmem = setup_shmem_iomap(cinfo, dev, tx, NULL);

	smbox->shmem = scmi_shmem_ops.setup_iomap(cinfo, dev, tx, NULL);

	if (IS_ERR(smbox->shmem))

		return PTR_ERR(smbox->shmem);
@@ -293,7 +293,7 @@ static void mailbox_fetch_response(struct scmi_chan_info *cinfo, 
{

	struct scmi_mailbox *smbox = cinfo->transport_info;



	shmem_fetch_response(smbox->shmem, xfer);

	scmi_shmem_ops.fetch_response(smbox->shmem, xfer);

}



static void mailbox_fetch_notification(struct scmi_chan_info *cinfo,
@@ -301,7 +301,7 @@ static void mailbox_fetch_notification(struct scmi_chan_info *cinfo, 
{

	struct scmi_mailbox *smbox = cinfo->transport_info;



	shmem_fetch_notification(smbox->shmem, max_len, xfer);

	scmi_shmem_ops.fetch_notification(smbox->shmem, max_len, xfer);

}



static void mailbox_clear_channel(struct scmi_chan_info *cinfo)
@@ -310,9 +310,9 @@ static void mailbox_clear_channel(struct scmi_chan_info *cinfo) 
	struct mbox_chan *intr_chan;

	int ret;



	shmem_clear_channel(smbox->shmem);

	scmi_shmem_ops.clear_channel(smbox->shmem);



	if (!shmem_channel_intr_enabled(smbox->shmem))

	if (!scmi_shmem_ops.channel_intr_enabled(smbox->shmem))

		return;



	if (smbox->chan_platform_receiver)
@@ -335,7 +335,7 @@ mailbox_poll_done(struct scmi_chan_info *cinfo, struct scmi_xfer *xfer) 
{

	struct scmi_mailbox *smbox = cinfo->transport_info;



	return shmem_poll_done(smbox->shmem, xfer);

	return scmi_shmem_ops.poll_done(smbox->shmem, xfer);

}



static const struct scmi_transport_ops scmi_mailbox_ops = {

drivers/firmware/arm_scmi/msg.c

+18 −9
Original line number Diff line number Diff line
@@ -4,7 +4,7 @@ 
 *

 * Derived from shm.c.

 *

 * Copyright (C) 2019-2021 ARM Ltd.

 * Copyright (C) 2019-2024 ARM Ltd.

 * Copyright (C) 2020-2021 OpenSynergy GmbH

 */
@@ -30,7 +30,7 @@ struct scmi_msg_payld { 
 *

 * Return: transport SDU size.

 */

size_t msg_command_size(struct scmi_xfer *xfer)

static size_t msg_command_size(struct scmi_xfer *xfer)

{

	return sizeof(struct scmi_msg_payld) + xfer->tx.len;

}
@@ -42,7 +42,7 @@ size_t msg_command_size(struct scmi_xfer *xfer) 
 *

 * Return: transport SDU size.

 */

size_t msg_response_size(struct scmi_xfer *xfer)

static size_t msg_response_size(struct scmi_xfer *xfer)

{

	return sizeof(struct scmi_msg_payld) + sizeof(__le32) + xfer->rx.len;

}
@@ -53,7 +53,7 @@ size_t msg_response_size(struct scmi_xfer *xfer) 
 * @msg: transport SDU for command

 * @xfer: message which is being sent

 */

void msg_tx_prepare(struct scmi_msg_payld *msg, struct scmi_xfer *xfer)

static void msg_tx_prepare(struct scmi_msg_payld *msg, struct scmi_xfer *xfer)

{

	msg->msg_header = cpu_to_le32(pack_scmi_header(&xfer->hdr));

	if (xfer->tx.buf)
@@ -67,7 +67,7 @@ void msg_tx_prepare(struct scmi_msg_payld *msg, struct scmi_xfer *xfer) 
 *

 * Return: SCMI header

 */

u32 msg_read_header(struct scmi_msg_payld *msg)

static u32 msg_read_header(struct scmi_msg_payld *msg)

{

	return le32_to_cpu(msg->msg_header);

}
@@ -79,8 +79,8 @@ u32 msg_read_header(struct scmi_msg_payld *msg) 
 * @len: transport SDU size

 * @xfer: message being responded to

 */

void msg_fetch_response(struct scmi_msg_payld *msg, size_t len,

			struct scmi_xfer *xfer)

static void msg_fetch_response(struct scmi_msg_payld *msg,

			       size_t len, struct scmi_xfer *xfer)

{

	size_t prefix_len = sizeof(*msg) + sizeof(msg->msg_payload[0]);
@@ -100,7 +100,7 @@ void msg_fetch_response(struct scmi_msg_payld *msg, size_t len, 
 * @max_len: maximum SCMI payload size to fetch

 * @xfer: notification message

 */

void msg_fetch_notification(struct scmi_msg_payld *msg, size_t len,

static void msg_fetch_notification(struct scmi_msg_payld *msg, size_t len,

				   size_t max_len, struct scmi_xfer *xfer)

{

	xfer->rx.len = min_t(size_t, max_len,
@@ -109,3 +109,12 @@ void msg_fetch_notification(struct scmi_msg_payld *msg, size_t len, 
	/* Take a copy to the rx buffer.. */

	memcpy(xfer->rx.buf, msg->msg_payload, xfer->rx.len);

}



const struct scmi_message_operations scmi_msg_ops = {

	.tx_prepare = msg_tx_prepare,

	.command_size = msg_command_size,

	.response_size = msg_response_size,

	.read_header = msg_read_header,

	.fetch_response = msg_fetch_response,

	.fetch_notification = msg_fetch_notification,

};

drivers/firmware/arm_scmi/optee.c

+7 −7
Original line number Diff line number Diff line
@@ -343,7 +343,7 @@ static void scmi_optee_clear_channel(struct scmi_chan_info *cinfo) 
	struct scmi_optee_channel *channel = cinfo->transport_info;



	if (!channel->tee_shm)

		shmem_clear_channel(channel->req.shmem);

		scmi_shmem_ops.clear_channel(channel->req.shmem);

}



static int setup_dynamic_shmem(struct device *dev, struct scmi_optee_channel *channel)
@@ -368,7 +368,7 @@ static int setup_dynamic_shmem(struct device *dev, struct scmi_optee_channel *ch 
static int setup_static_shmem(struct device *dev, struct scmi_chan_info *cinfo,

			      struct scmi_optee_channel *channel)

{

	channel->req.shmem = setup_shmem_iomap(cinfo, dev, true, NULL);

	channel->req.shmem = scmi_shmem_ops.setup_iomap(cinfo, dev, true, NULL);

	if (IS_ERR(channel->req.shmem))

		return PTR_ERR(channel->req.shmem);
@@ -479,10 +479,10 @@ static int scmi_optee_send_message(struct scmi_chan_info *cinfo, 
	mutex_lock(&channel->mu);



	if (channel->tee_shm) {

		msg_tx_prepare(channel->req.msg, xfer);

		ret = invoke_process_msg_channel(channel, msg_command_size(xfer));

		scmi_msg_ops.tx_prepare(channel->req.msg, xfer);

		ret = invoke_process_msg_channel(channel, scmi_msg_ops.command_size(xfer));

	} else {

		shmem_tx_prepare(channel->req.shmem, xfer, cinfo);

		scmi_shmem_ops.tx_prepare(channel->req.shmem, xfer, cinfo);

		ret = invoke_process_smt_channel(channel);

	}
@@ -498,9 +498,9 @@ static void scmi_optee_fetch_response(struct scmi_chan_info *cinfo, 
	struct scmi_optee_channel *channel = cinfo->transport_info;



	if (channel->tee_shm)

		msg_fetch_response(channel->req.msg, channel->rx_len, xfer);

		scmi_msg_ops.fetch_response(channel->req.msg, channel->rx_len, xfer);

	else

		shmem_fetch_response(channel->req.shmem, xfer);

		scmi_shmem_ops.fetch_response(channel->req.shmem, xfer);

}



static void scmi_optee_mark_txdone(struct scmi_chan_info *cinfo, int ret,

drivers/firmware/arm_scmi/shmem.c

+29 −16
Original line number Diff line number Diff line
@@ -2,7 +2,7 @@ 
/*

 * For transport using shared mem structure.

 *

 * Copyright (C) 2019 ARM Ltd.

 * Copyright (C) 2019-2024 ARM Ltd.

 */



#include <linux/ktime.h>
@@ -34,8 +34,9 @@ struct scmi_shared_mem { 
	u8 msg_payload[];

};



void shmem_tx_prepare(struct scmi_shared_mem __iomem *shmem,

		      struct scmi_xfer *xfer, struct scmi_chan_info *cinfo)

static void shmem_tx_prepare(struct scmi_shared_mem __iomem *shmem,

			     struct scmi_xfer *xfer,

			     struct scmi_chan_info *cinfo)

{

	ktime_t stop;
@@ -75,12 +76,12 @@ void shmem_tx_prepare(struct scmi_shared_mem __iomem *shmem, 
		memcpy_toio(shmem->msg_payload, xfer->tx.buf, xfer->tx.len);

}



u32 shmem_read_header(struct scmi_shared_mem __iomem *shmem)

static u32 shmem_read_header(struct scmi_shared_mem __iomem *shmem)

{

	return ioread32(&shmem->msg_header);

}



void shmem_fetch_response(struct scmi_shared_mem __iomem *shmem,

static void shmem_fetch_response(struct scmi_shared_mem __iomem *shmem,

				 struct scmi_xfer *xfer)

{

	size_t len = ioread32(&shmem->length);
@@ -93,7 +94,7 @@ void shmem_fetch_response(struct scmi_shared_mem __iomem *shmem, 
	memcpy_fromio(xfer->rx.buf, shmem->msg_payload + 4, xfer->rx.len);

}



void shmem_fetch_notification(struct scmi_shared_mem __iomem *shmem,

static void shmem_fetch_notification(struct scmi_shared_mem __iomem *shmem,

				     size_t max_len, struct scmi_xfer *xfer)

{

	size_t len = ioread32(&shmem->length);
@@ -105,12 +106,12 @@ void shmem_fetch_notification(struct scmi_shared_mem __iomem *shmem, 
	memcpy_fromio(xfer->rx.buf, shmem->msg_payload, xfer->rx.len);

}



void shmem_clear_channel(struct scmi_shared_mem __iomem *shmem)

static void shmem_clear_channel(struct scmi_shared_mem __iomem *shmem)

{

	iowrite32(SCMI_SHMEM_CHAN_STAT_CHANNEL_FREE, &shmem->channel_status);

}



bool shmem_poll_done(struct scmi_shared_mem __iomem *shmem,

static bool shmem_poll_done(struct scmi_shared_mem __iomem *shmem,

			    struct scmi_xfer *xfer)

{

	u16 xfer_id;
@@ -125,18 +126,18 @@ bool shmem_poll_done(struct scmi_shared_mem __iomem *shmem, 
		 SCMI_SHMEM_CHAN_STAT_CHANNEL_FREE);

}



bool shmem_channel_free(struct scmi_shared_mem __iomem *shmem)

static bool shmem_channel_free(struct scmi_shared_mem __iomem *shmem)

{

	return (ioread32(&shmem->channel_status) &

			SCMI_SHMEM_CHAN_STAT_CHANNEL_FREE);

}



bool shmem_channel_intr_enabled(struct scmi_shared_mem __iomem *shmem)

static bool shmem_channel_intr_enabled(struct scmi_shared_mem __iomem *shmem)

{

	return ioread32(&shmem->flags) & SCMI_SHMEM_FLAG_INTR_ENABLED;

}



void __iomem *setup_shmem_iomap(struct scmi_chan_info *cinfo,

static void __iomem *shmem_setup_iomap(struct scmi_chan_info *cinfo,

				       struct device *dev, bool tx,

				       struct resource *res)

{
@@ -174,3 +175,15 @@ void __iomem *setup_shmem_iomap(struct scmi_chan_info *cinfo, 


	return addr;

}



const struct scmi_shared_mem_operations scmi_shmem_ops = {

	.tx_prepare = shmem_tx_prepare,

	.read_header = shmem_read_header,

	.fetch_response = shmem_fetch_response,

	.fetch_notification = shmem_fetch_notification,

	.clear_channel = shmem_clear_channel,

	.poll_done = shmem_poll_done,

	.channel_free = shmem_channel_free,

	.channel_intr_enabled = shmem_channel_intr_enabled,

	.setup_iomap = shmem_setup_iomap,

};