^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) // SPDX-License-Identifier: GPL-2.0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * System Control and Management Interface (SCMI) Message Mailbox Transport
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) * driver.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) * Copyright (C) 2019 ARM Ltd.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) #include <linux/err.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) #include <linux/device.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) #include <linux/mailbox_client.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) #include <linux/of.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) #include <linux/of_address.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) #include <linux/slab.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) #include "common.h"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) * struct scmi_mailbox - Structure representing a SCMI mailbox transport
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) * @cl: Mailbox Client
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) * @chan: Transmit/Receive mailbox channel
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) * @cinfo: SCMI channel info
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) * @shmem: Transmit/Receive shared memory area
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) struct scmi_mailbox {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) struct mbox_client cl;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) struct mbox_chan *chan;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) struct scmi_chan_info *cinfo;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) struct scmi_shared_mem __iomem *shmem;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) #define client_to_scmi_mailbox(c) container_of(c, struct scmi_mailbox, cl)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) static void tx_prepare(struct mbox_client *cl, void *m)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) struct scmi_mailbox *smbox = client_to_scmi_mailbox(cl);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) shmem_tx_prepare(smbox->shmem, m);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) static void rx_callback(struct mbox_client *cl, void *m)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) struct scmi_mailbox *smbox = client_to_scmi_mailbox(cl);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) scmi_rx_callback(smbox->cinfo, shmem_read_header(smbox->shmem));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) static bool mailbox_chan_available(struct device *dev, int idx)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) return !of_parse_phandle_with_args(dev->of_node, "mboxes",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) "#mbox-cells", idx, NULL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) static int mailbox_chan_setup(struct scmi_chan_info *cinfo, struct device *dev,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) bool tx)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) const char *desc = tx ? "Tx" : "Rx";
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) struct device *cdev = cinfo->dev;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) struct scmi_mailbox *smbox;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) struct device_node *shmem;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) int ret, idx = tx ? 0 : 1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) struct mbox_client *cl;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) resource_size_t size;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) struct resource res;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) smbox = devm_kzalloc(dev, sizeof(*smbox), GFP_KERNEL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) if (!smbox)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) return -ENOMEM;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) shmem = of_parse_phandle(cdev->of_node, "shmem", idx);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) ret = of_address_to_resource(shmem, 0, &res);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) of_node_put(shmem);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) if (ret) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) dev_err(cdev, "failed to get SCMI %s shared memory\n", desc);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) return ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) size = resource_size(&res);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) smbox->shmem = devm_ioremap(dev, res.start, size);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) if (!smbox->shmem) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) dev_err(dev, "failed to ioremap SCMI %s shared memory\n", desc);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) return -EADDRNOTAVAIL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) cl = &smbox->cl;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) cl->dev = cdev;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) cl->tx_prepare = tx ? tx_prepare : NULL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) cl->rx_callback = rx_callback;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) cl->tx_block = false;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) cl->knows_txdone = tx;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) smbox->chan = mbox_request_channel(cl, tx ? 0 : 1);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) if (IS_ERR(smbox->chan)) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) ret = PTR_ERR(smbox->chan);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) if (ret != -EPROBE_DEFER)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) dev_err(cdev, "failed to request SCMI %s mailbox\n",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) tx ? "Tx" : "Rx");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) return ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) cinfo->transport_info = smbox;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) smbox->cinfo = cinfo;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) static int mailbox_chan_free(int id, void *p, void *data)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) struct scmi_chan_info *cinfo = p;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) struct scmi_mailbox *smbox = cinfo->transport_info;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) if (smbox && !IS_ERR(smbox->chan)) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) mbox_free_channel(smbox->chan);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) cinfo->transport_info = NULL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) smbox->chan = NULL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) smbox->cinfo = NULL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) scmi_free_channel(cinfo, data, id);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) static int mailbox_send_message(struct scmi_chan_info *cinfo,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) struct scmi_xfer *xfer)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) struct scmi_mailbox *smbox = cinfo->transport_info;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) int ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) ret = mbox_send_message(smbox->chan, xfer);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) /* mbox_send_message returns non-negative value on success, so reset */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) if (ret > 0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) ret = 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) return ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) static void mailbox_mark_txdone(struct scmi_chan_info *cinfo, int ret)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) struct scmi_mailbox *smbox = cinfo->transport_info;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) * NOTE: we might prefer not to need the mailbox ticker to manage the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) * transfer queueing since the protocol layer queues things by itself.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) * Unfortunately, we have to kick the mailbox framework after we have
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) * received our message.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) mbox_client_txdone(smbox->chan, ret);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) static void mailbox_fetch_response(struct scmi_chan_info *cinfo,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) struct scmi_xfer *xfer)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) struct scmi_mailbox *smbox = cinfo->transport_info;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) shmem_fetch_response(smbox->shmem, xfer);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) static void mailbox_fetch_notification(struct scmi_chan_info *cinfo,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) size_t max_len, struct scmi_xfer *xfer)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) struct scmi_mailbox *smbox = cinfo->transport_info;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) shmem_fetch_notification(smbox->shmem, max_len, xfer);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) static void mailbox_clear_channel(struct scmi_chan_info *cinfo)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) struct scmi_mailbox *smbox = cinfo->transport_info;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) shmem_clear_channel(smbox->shmem);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) static bool
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) mailbox_poll_done(struct scmi_chan_info *cinfo, struct scmi_xfer *xfer)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) struct scmi_mailbox *smbox = cinfo->transport_info;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181) return shmem_poll_done(smbox->shmem, xfer);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) static const struct scmi_transport_ops scmi_mailbox_ops = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) .chan_available = mailbox_chan_available,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) .chan_setup = mailbox_chan_setup,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) .chan_free = mailbox_chan_free,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) .send_message = mailbox_send_message,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) .mark_txdone = mailbox_mark_txdone,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) .fetch_response = mailbox_fetch_response,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191) .fetch_notification = mailbox_fetch_notification,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192) .clear_channel = mailbox_clear_channel,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193) .poll_done = mailbox_poll_done,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 196) const struct scmi_desc scmi_mailbox_desc = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 197) .ops = &scmi_mailbox_ops,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 198) .max_rx_timeout_ms = 30, /* We may increase this if required */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 199) .max_msg = 20, /* Limited by MBOX_TX_QUEUE_LEN */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 200) .max_msg_size = 128,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 201) };
Orange Pi5 kernel
Deprecated Linux kernel 5.10.110 for OrangePi 5/5B/5+ boards
3 Commits
0 Branches
0 Tags