[PATCH v2 12/18] firmware: arm_scmi: refactor in preparation to support per-protocol channels

From: Sudeep Holla
Date: Fri Aug 04 2017 - 10:32:42 EST


In order to support per-protocol channels if available, we need to
factor out all the mailbox channel information(Tx/Rx payload and
channel handle) out of the main SCMI instance information structure.

This patch refactors the existing channel information into a separate
chan_info structure.

Cc: Arnd Bergmann <arnd@xxxxxxxx>
Signed-off-by: Sudeep Holla <sudeep.holla@xxxxxxx>
---
drivers/firmware/arm_scmi/driver.c | 93 +++++++++++++++++++++++---------------
1 file changed, 57 insertions(+), 36 deletions(-)

diff --git a/drivers/firmware/arm_scmi/driver.c b/drivers/firmware/arm_scmi/driver.c
index 8257315cf3eb..3eaf619858bb 100644
--- a/drivers/firmware/arm_scmi/driver.c
+++ b/drivers/firmware/arm_scmi/driver.c
@@ -104,6 +104,25 @@ struct scmi_desc {
};

/**
+ * struct scmi_chan_info - Structure representing a SCMI channel informfation
+ *
+ * @cl: Mailbox Client
+ * @tx_chan: Transmit mailbox channel
+ * @rx_chan: Receive mailbox channel
+ * @tx_payload: Transmit mailbox channel payload area
+ * @rx_payload: Receive mailbox channel payload area
+ * @info: Reference to SCMI instance corresponding to this channel
+ */
+struct scmi_chan_info {
+ struct mbox_client cl;
+ struct mbox_chan *tx_chan;
+ struct mbox_chan *rx_chan;
+ void __iomem *tx_payload;
+ void __iomem *rx_payload;
+ struct scmi_info *info;
+};
+
+/**
* struct scmi_info - Structure representing a SCMI instance
*
* @dev: Device pointer
@@ -111,12 +130,8 @@ struct scmi_desc {
* @handle: Instance of SCMI handle to send to clients
* @version: SCMI revision information containing protocol version,
* implementation version and (sub-)vendor identification.
- * @cl: Mailbox Client
- * @tx_chan: Transmit mailbox channel
- * @rx_chan: Receive mailbox channel
- * @tx_payload: Transmit mailbox channel payload area
- * @rx_payload: Receive mailbox channel payload area
* @minfo: Message info
+ * @cinfo: Reference to SCMI channel information
* @protocols_imp: list of protocols implemented
* @node: list head
* @users: Number of users of this instance
@@ -126,18 +141,14 @@ struct scmi_info {
const struct scmi_desc *desc;
struct scmi_revision_info version;
struct scmi_handle handle;
- struct mbox_client cl;
- struct mbox_chan *tx_chan;
- struct mbox_chan *rx_chan;
- void __iomem *tx_payload;
- void __iomem *rx_payload;
struct scmi_xfers_info minfo;
+ struct scmi_chan_info *cinfo;
u8 *protocols_imp;
struct list_head node;
int users;
};

-#define client_to_scmi_info(c) container_of(c, struct scmi_info, cl)
+#define client_to_scmi_chan_info(c) container_of(c, struct scmi_chan_info, cl)
#define handle_to_scmi_info(h) container_of(h, struct scmi_info, handle)

/*
@@ -226,10 +237,11 @@ static void scmi_rx_callback(struct mbox_client *cl, void *m)
{
u16 xfer_id;
struct scmi_xfer *xfer;
- struct scmi_info *info = client_to_scmi_info(cl);
+ struct scmi_chan_info *cinfo = client_to_scmi_chan_info(cl);
+ struct scmi_info *info = cinfo->info;
struct scmi_xfers_info *minfo = &info->minfo;
struct device *dev = info->dev;
- struct scmi_shared_mem *mem = info->tx_payload;
+ struct scmi_shared_mem *mem = cinfo->tx_payload;

xfer_id = MSG_XTRACT_TOKEN(mem->msg_header);

@@ -280,8 +292,8 @@ static inline u32 pack_scmi_header(struct scmi_msg_hdr *hdr)
static void scmi_tx_prepare(struct mbox_client *cl, void *m)
{
struct scmi_xfer *t = m;
- struct scmi_info *info = client_to_scmi_info(cl);
- struct scmi_shared_mem *mem = info->tx_payload;
+ struct scmi_chan_info *cinfo = client_to_scmi_chan_info(cl);
+ struct scmi_shared_mem *mem = cinfo->tx_payload;

mem->channel_status = 0x0; /* Mark channel busy + clear error */
mem->flags = t->hdr.poll_completion ? 0 : SCMI_SHMEM_FLAG_INTR_ENABLED;
@@ -372,9 +384,9 @@ void scmi_one_xfer_put(const struct scmi_handle *handle, struct scmi_xfer *xfer)
}

static bool
-scmi_xfer_poll_done(const struct scmi_info *info, struct scmi_xfer *xfer)
+scmi_xfer_poll_done(const struct scmi_chan_info *cinfo, struct scmi_xfer *xfer)
{
- struct scmi_shared_mem *mem = info->tx_payload;
+ struct scmi_shared_mem *mem = cinfo->tx_payload;
u16 xfer_id = MSG_XTRACT_TOKEN(mem->msg_header);

if (xfer->hdr.seq != xfer_id)
@@ -400,8 +412,9 @@ int scmi_do_xfer(const struct scmi_handle *handle, struct scmi_xfer *xfer)
int timeout;
struct scmi_info *info = handle_to_scmi_info(handle);
struct device *dev = info->dev;
+ struct scmi_chan_info *cinfo = info->cinfo;

- ret = mbox_send_message(info->tx_chan, xfer);
+ ret = mbox_send_message(cinfo->tx_chan, xfer);
if (ret < 0) {
dev_dbg(dev, "mbox send fail %d\n", ret);
return ret;
@@ -412,10 +425,10 @@ int scmi_do_xfer(const struct scmi_handle *handle, struct scmi_xfer *xfer)

if (xfer->hdr.poll_completion) {
timeout = info->desc->max_rx_timeout_ms * 100;
- while (!scmi_xfer_poll_done(info, xfer) && timeout--)
+ while (!scmi_xfer_poll_done(cinfo, xfer) && timeout--)
udelay(10);
if (timeout)
- scmi_fetch_response(xfer, info->tx_payload);
+ scmi_fetch_response(xfer, cinfo->tx_payload);
else
ret = -ETIMEDOUT;
} else {
@@ -435,7 +448,7 @@ int scmi_do_xfer(const struct scmi_handle *handle, struct scmi_xfer *xfer)
* Unfortunately, we have to kick the mailbox framework after we have
* received our message.
*/
- mbox_client_txdone(info->tx_chan, ret);
+ mbox_client_txdone(cinfo->tx_chan, ret);

return ret;
}
@@ -759,15 +772,15 @@ static int scmi_mailbox_check(struct device_node *np)
return of_parse_phandle_with_args(np, "mboxes", "#mbox-cells", 0, &arg);
}

-static int scmi_mbox_free_channel(struct scmi_info *info)
+static int scmi_mbox_free_channel(struct scmi_chan_info *cinfo)
{
- if (!IS_ERR_OR_NULL(info->tx_chan)) {
- mbox_free_channel(info->tx_chan);
- info->tx_chan = NULL;
+ if (!IS_ERR_OR_NULL(cinfo->tx_chan)) {
+ mbox_free_channel(cinfo->tx_chan);
+ cinfo->tx_chan = NULL;
}
- if (!IS_ERR_OR_NULL(info->rx_chan)) {
- mbox_free_channel(info->rx_chan);
- info->rx_chan = NULL;
+ if (!IS_ERR_OR_NULL(cinfo->rx_chan)) {
+ mbox_free_channel(cinfo->rx_chan);
+ cinfo->rx_chan = NULL;
}

return 0;
@@ -789,7 +802,7 @@ static int scmi_remove(struct platform_device *pdev)

if (!ret)
/* Safe to free channels since no more users */
- return scmi_mbox_free_channel(info);
+ return scmi_mbox_free_channel(info->cinfo);

return ret;
}
@@ -801,9 +814,17 @@ static inline int scmi_mbox_chan_setup(struct scmi_info *info)
resource_size_t size;
struct device *dev = info->dev;
struct device_node *shmem, *np = dev->of_node;
+ struct scmi_chan_info *cinfo;
struct mbox_client *cl;

- cl = &info->cl;
+ cinfo = devm_kzalloc(info->dev, sizeof(*cinfo), GFP_KERNEL);
+ if (!cinfo)
+ return -ENOMEM;
+
+ info->cinfo = cinfo;
+ cinfo->info = info;
+
+ cl = &cinfo->cl;
cl->dev = dev;
cl->rx_callback = scmi_rx_callback;
cl->tx_prepare = scmi_tx_prepare;
@@ -819,15 +840,15 @@ static inline int scmi_mbox_chan_setup(struct scmi_info *info)
}

size = resource_size(&res);
- info->tx_payload = devm_ioremap(dev, res.start, size);
- if (!info->tx_payload) {
+ cinfo->tx_payload = devm_ioremap(info->dev, res.start, size);
+ if (!cinfo->tx_payload) {
dev_err(dev, "failed to ioremap SCMI Tx payload\n");
return -EADDRNOTAVAIL;
}

- info->tx_chan = mbox_request_channel_byname(cl, "tx");
- if (IS_ERR(info->tx_chan)) {
- ret = PTR_ERR(info->tx_chan);
+ cinfo->tx_chan = mbox_request_channel_byname(cl, "tx");
+ if (IS_ERR(cinfo->tx_chan)) {
+ ret = PTR_ERR(cinfo->tx_chan);
if (ret != -EPROBE_DEFER)
dev_err(dev, "failed to request SCMI Tx mailbox\n");
return ret;
@@ -878,7 +899,7 @@ static int scmi_probe(struct platform_device *pdev)
ret = scmi_base_protocol_init(handle);
if (ret) {
dev_err(dev, "unable to communicate with SCMI(%d)\n", ret);
- scmi_mbox_free_channel(info);
+ scmi_mbox_free_channel(info->cinfo);
return ret;
}

--
2.7.4