1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (c) 2016-2017, Linaro Ltd
7 #include <linux/interrupt.h>
9 #include <linux/list.h>
10 #include <linux/mfd/syscon.h>
11 #include <linux/module.h>
13 #include <linux/of_address.h>
14 #include <linux/of_irq.h>
15 #include <linux/platform_device.h>
16 #include <linux/regmap.h>
17 #include <linux/rpmsg.h>
18 #include <linux/sizes.h>
19 #include <linux/slab.h>
20 #include <linux/workqueue.h>
21 #include <linux/mailbox_client.h>
23 #include "rpmsg_internal.h"
24 #include "qcom_glink_native.h"
26 #define GLINK_NAME_SIZE 32
27 #define GLINK_VERSION_1 1
29 #define RPM_GLINK_CID_MIN 1
30 #define RPM_GLINK_CID_MAX 65536
40 * struct glink_defer_cmd - deferred incoming control message
42 * @msg: message header
43 * @data: payload of the message
45 * Copy of a received control message, to be added to @rx_queue and processed
46 * by @rx_work of @qcom_glink.
48 struct glink_defer_cmd {
49 struct list_head node;
56 * struct glink_core_rx_intent - RX intent
59 * @data: pointer to the data (may be NULL for zero-copy)
60 * @id: remote or local intent ID
61 * @size: size of the original intent (do not modify)
62 * @reuse: To mark if the intent can be reused after first use
63 * @in_use: To mark if intent is already in use for the channel
64 * @offset: next write offset (initially 0)
67 struct glink_core_rx_intent {
75 struct list_head node;
79 * struct qcom_glink - driver context, relates to one remote subsystem
80 * @dev: reference to the associated struct device
81 * @mbox_client: mailbox client
82 * @mbox_chan: mailbox channel
83 * @rx_pipe: pipe object for receive FIFO
84 * @tx_pipe: pipe object for transmit FIFO
85 * @irq: IRQ for signaling incoming events
86 * @rx_work: worker for handling received control messages
87 * @rx_lock: protects the @rx_queue
88 * @rx_queue: queue of received control messages to be processed in @rx_work
89 * @tx_lock: synchronizes operations on the tx fifo
90 * @idr_lock: synchronizes @lcids and @rcids modifications
91 * @lcids: idr of all channels with a known local channel id
92 * @rcids: idr of all channels with a known remote channel id
93 * @features: remote features
94 * @intentless: flag to indicate that there is no intent
101 struct mbox_client mbox_client;
102 struct mbox_chan *mbox_chan;
104 struct qcom_glink_pipe *rx_pipe;
105 struct qcom_glink_pipe *tx_pipe;
109 struct work_struct rx_work;
111 struct list_head rx_queue;
118 unsigned long features;
131 * struct glink_channel - internal representation of a channel
132 * @rpdev: rpdev reference, only used for primary endpoints
133 * @ept: rpmsg endpoint this channel is associated with
134 * @glink: qcom_glink context handle
135 * @refcount: refcount for the channel object
136 * @recv_lock: guard for @ept.cb
137 * @name: unique channel name/identifier
138 * @lcid: channel id, in local space
139 * @rcid: channel id, in remote space
140 * @intent_lock: lock for protection of @liids, @riids
141 * @liids: idr of all local intents
142 * @riids: idr of all remote intents
143 * @intent_work: worker responsible for transmitting rx_done packets
144 * @done_intents: list of intents that needs to be announced rx_done
145 * @buf: receive buffer, for gathering fragments
146 * @buf_offset: write offset in @buf
147 * @buf_size: size of current @buf
148 * @open_ack: completed once remote has acked the open-request
149 * @open_req: completed once open-request has been received
150 * @intent_req_lock: Synchronises multiple intent requests
151 * @intent_req_result: Result of intent request
152 * @intent_req_comp: Completion for intent_req signalling
154 struct glink_channel {
155 struct rpmsg_endpoint ept;
157 struct rpmsg_device *rpdev;
158 struct qcom_glink *glink;
160 struct kref refcount;
162 spinlock_t recv_lock;
168 spinlock_t intent_lock;
171 struct work_struct intent_work;
172 struct list_head done_intents;
174 struct glink_core_rx_intent *buf;
178 struct completion open_ack;
179 struct completion open_req;
181 struct mutex intent_req_lock;
182 bool intent_req_result;
183 struct completion intent_req_comp;
186 #define to_glink_channel(_ept) container_of(_ept, struct glink_channel, ept)
188 static const struct rpmsg_endpoint_ops glink_endpoint_ops;
190 #define RPM_CMD_VERSION 0
191 #define RPM_CMD_VERSION_ACK 1
192 #define RPM_CMD_OPEN 2
193 #define RPM_CMD_CLOSE 3
194 #define RPM_CMD_OPEN_ACK 4
195 #define RPM_CMD_INTENT 5
196 #define RPM_CMD_RX_DONE 6
197 #define RPM_CMD_RX_INTENT_REQ 7
198 #define RPM_CMD_RX_INTENT_REQ_ACK 8
199 #define RPM_CMD_TX_DATA 9
200 #define RPM_CMD_CLOSE_ACK 11
201 #define RPM_CMD_TX_DATA_CONT 12
202 #define RPM_CMD_READ_NOTIF 13
203 #define RPM_CMD_RX_DONE_W_REUSE 14
205 #define GLINK_FEATURE_INTENTLESS BIT(1)
207 static void qcom_glink_rx_done_work(struct work_struct *work);
209 static struct glink_channel *qcom_glink_alloc_channel(struct qcom_glink *glink,
212 struct glink_channel *channel;
214 channel = kzalloc(sizeof(*channel), GFP_KERNEL);
216 return ERR_PTR(-ENOMEM);
218 /* Setup glink internal glink_channel data */
219 spin_lock_init(&channel->recv_lock);
220 spin_lock_init(&channel->intent_lock);
221 mutex_init(&channel->intent_req_lock);
223 channel->glink = glink;
224 channel->name = kstrdup(name, GFP_KERNEL);
226 init_completion(&channel->open_req);
227 init_completion(&channel->open_ack);
228 init_completion(&channel->intent_req_comp);
230 INIT_LIST_HEAD(&channel->done_intents);
231 INIT_WORK(&channel->intent_work, qcom_glink_rx_done_work);
233 idr_init(&channel->liids);
234 idr_init(&channel->riids);
235 kref_init(&channel->refcount);
240 static void qcom_glink_channel_release(struct kref *ref)
242 struct glink_channel *channel = container_of(ref, struct glink_channel,
244 struct glink_core_rx_intent *tmp;
248 spin_lock_irqsave(&channel->intent_lock, flags);
249 idr_for_each_entry(&channel->liids, tmp, iid) {
253 idr_destroy(&channel->liids);
255 idr_for_each_entry(&channel->riids, tmp, iid)
257 idr_destroy(&channel->riids);
258 spin_unlock_irqrestore(&channel->intent_lock, flags);
260 kfree(channel->name);
264 static size_t qcom_glink_rx_avail(struct qcom_glink *glink)
266 return glink->rx_pipe->avail(glink->rx_pipe);
269 static void qcom_glink_rx_peak(struct qcom_glink *glink,
270 void *data, unsigned int offset, size_t count)
272 glink->rx_pipe->peak(glink->rx_pipe, data, offset, count);
275 static void qcom_glink_rx_advance(struct qcom_glink *glink, size_t count)
277 glink->rx_pipe->advance(glink->rx_pipe, count);
280 static size_t qcom_glink_tx_avail(struct qcom_glink *glink)
282 return glink->tx_pipe->avail(glink->tx_pipe);
285 static void qcom_glink_tx_write(struct qcom_glink *glink,
286 const void *hdr, size_t hlen,
287 const void *data, size_t dlen)
289 glink->tx_pipe->write(glink->tx_pipe, hdr, hlen, data, dlen);
292 static int qcom_glink_tx(struct qcom_glink *glink,
293 const void *hdr, size_t hlen,
294 const void *data, size_t dlen, bool wait)
296 unsigned int tlen = hlen + dlen;
300 /* Reject packets that are too big */
301 if (tlen >= glink->tx_pipe->length)
304 spin_lock_irqsave(&glink->tx_lock, flags);
306 while (qcom_glink_tx_avail(glink) < tlen) {
312 /* Wait without holding the tx_lock */
313 spin_unlock_irqrestore(&glink->tx_lock, flags);
315 usleep_range(10000, 15000);
317 spin_lock_irqsave(&glink->tx_lock, flags);
320 qcom_glink_tx_write(glink, hdr, hlen, data, dlen);
322 mbox_send_message(glink->mbox_chan, NULL);
323 mbox_client_txdone(glink->mbox_chan, 0);
326 spin_unlock_irqrestore(&glink->tx_lock, flags);
331 static int qcom_glink_send_version(struct qcom_glink *glink)
333 struct glink_msg msg;
335 msg.cmd = cpu_to_le16(RPM_CMD_VERSION);
336 msg.param1 = cpu_to_le16(GLINK_VERSION_1);
337 msg.param2 = cpu_to_le32(glink->features);
339 return qcom_glink_tx(glink, &msg, sizeof(msg), NULL, 0, true);
342 static void qcom_glink_send_version_ack(struct qcom_glink *glink)
344 struct glink_msg msg;
346 msg.cmd = cpu_to_le16(RPM_CMD_VERSION_ACK);
347 msg.param1 = cpu_to_le16(GLINK_VERSION_1);
348 msg.param2 = cpu_to_le32(glink->features);
350 qcom_glink_tx(glink, &msg, sizeof(msg), NULL, 0, true);
353 static void qcom_glink_send_open_ack(struct qcom_glink *glink,
354 struct glink_channel *channel)
356 struct glink_msg msg;
358 msg.cmd = cpu_to_le16(RPM_CMD_OPEN_ACK);
359 msg.param1 = cpu_to_le16(channel->rcid);
360 msg.param2 = cpu_to_le32(0);
362 qcom_glink_tx(glink, &msg, sizeof(msg), NULL, 0, true);
365 static void qcom_glink_handle_intent_req_ack(struct qcom_glink *glink,
366 unsigned int cid, bool granted)
368 struct glink_channel *channel;
371 spin_lock_irqsave(&glink->idr_lock, flags);
372 channel = idr_find(&glink->rcids, cid);
373 spin_unlock_irqrestore(&glink->idr_lock, flags);
375 dev_err(glink->dev, "unable to find channel\n");
379 channel->intent_req_result = granted;
380 complete(&channel->intent_req_comp);
384 * qcom_glink_send_open_req() - send a RPM_CMD_OPEN request to the remote
385 * @glink: Ptr to the glink edge
386 * @channel: Ptr to the channel that the open req is sent
388 * Allocates a local channel id and sends a RPM_CMD_OPEN message to the remote.
389 * Will return with refcount held, regardless of outcome.
391 * Returns 0 on success, negative errno otherwise.
393 static int qcom_glink_send_open_req(struct qcom_glink *glink,
394 struct glink_channel *channel)
397 struct glink_msg msg;
398 u8 name[GLINK_NAME_SIZE];
400 int name_len = strlen(channel->name) + 1;
401 int req_len = ALIGN(sizeof(req.msg) + name_len, 8);
405 kref_get(&channel->refcount);
407 spin_lock_irqsave(&glink->idr_lock, flags);
408 ret = idr_alloc_cyclic(&glink->lcids, channel,
409 RPM_GLINK_CID_MIN, RPM_GLINK_CID_MAX,
411 spin_unlock_irqrestore(&glink->idr_lock, flags);
417 req.msg.cmd = cpu_to_le16(RPM_CMD_OPEN);
418 req.msg.param1 = cpu_to_le16(channel->lcid);
419 req.msg.param2 = cpu_to_le32(name_len);
420 strcpy(req.name, channel->name);
422 ret = qcom_glink_tx(glink, &req, req_len, NULL, 0, true);
429 spin_lock_irqsave(&glink->idr_lock, flags);
430 idr_remove(&glink->lcids, channel->lcid);
432 spin_unlock_irqrestore(&glink->idr_lock, flags);
437 static void qcom_glink_send_close_req(struct qcom_glink *glink,
438 struct glink_channel *channel)
440 struct glink_msg req;
442 req.cmd = cpu_to_le16(RPM_CMD_CLOSE);
443 req.param1 = cpu_to_le16(channel->lcid);
446 qcom_glink_tx(glink, &req, sizeof(req), NULL, 0, true);
449 static void qcom_glink_send_close_ack(struct qcom_glink *glink,
452 struct glink_msg req;
454 req.cmd = cpu_to_le16(RPM_CMD_CLOSE_ACK);
455 req.param1 = cpu_to_le16(rcid);
458 qcom_glink_tx(glink, &req, sizeof(req), NULL, 0, true);
461 static void qcom_glink_rx_done_work(struct work_struct *work)
463 struct glink_channel *channel = container_of(work, struct glink_channel,
465 struct qcom_glink *glink = channel->glink;
466 struct glink_core_rx_intent *intent, *tmp;
473 unsigned int cid = channel->lcid;
478 spin_lock_irqsave(&channel->intent_lock, flags);
479 list_for_each_entry_safe(intent, tmp, &channel->done_intents, node) {
480 list_del(&intent->node);
481 spin_unlock_irqrestore(&channel->intent_lock, flags);
483 reuse = intent->reuse;
485 cmd.id = reuse ? RPM_CMD_RX_DONE_W_REUSE : RPM_CMD_RX_DONE;
489 qcom_glink_tx(glink, &cmd, sizeof(cmd), NULL, 0, true);
494 spin_lock_irqsave(&channel->intent_lock, flags);
496 spin_unlock_irqrestore(&channel->intent_lock, flags);
499 static void qcom_glink_rx_done(struct qcom_glink *glink,
500 struct glink_channel *channel,
501 struct glink_core_rx_intent *intent)
503 /* We don't send RX_DONE to intentless systems */
504 if (glink->intentless) {
510 /* Take it off the tree of receive intents */
511 if (!intent->reuse) {
512 spin_lock(&channel->intent_lock);
513 idr_remove(&channel->liids, intent->id);
514 spin_unlock(&channel->intent_lock);
517 /* Schedule the sending of a rx_done indication */
518 spin_lock(&channel->intent_lock);
519 list_add_tail(&intent->node, &channel->done_intents);
520 spin_unlock(&channel->intent_lock);
522 schedule_work(&channel->intent_work);
526 * qcom_glink_receive_version() - receive version/features from remote system
528 * @glink: pointer to transport interface
529 * @version: remote version
530 * @features: remote features
532 * This function is called in response to a remote-initiated version/feature
533 * negotiation sequence.
535 static void qcom_glink_receive_version(struct qcom_glink *glink,
542 case GLINK_VERSION_1:
543 glink->features &= features;
546 qcom_glink_send_version_ack(glink);
552 * qcom_glink_receive_version_ack() - receive negotiation ack from remote system
554 * @glink: pointer to transport interface
555 * @version: remote version response
556 * @features: remote features response
558 * This function is called in response to a local-initiated version/feature
559 * negotiation sequence and is the counter-offer from the remote side based
560 * upon the initial version and feature set requested.
562 static void qcom_glink_receive_version_ack(struct qcom_glink *glink,
568 /* Version negotiation failed */
570 case GLINK_VERSION_1:
571 if (features == glink->features)
574 glink->features &= features;
577 qcom_glink_send_version(glink);
583 * qcom_glink_send_intent_req_ack() - convert an rx intent request ack cmd to
584 * wire format and transmit
585 * @glink: The transport to transmit on.
586 * @channel: The glink channel
587 * @granted: The request response to encode.
589 * Return: 0 on success or standard Linux error code.
591 static int qcom_glink_send_intent_req_ack(struct qcom_glink *glink,
592 struct glink_channel *channel,
595 struct glink_msg msg;
597 msg.cmd = cpu_to_le16(RPM_CMD_RX_INTENT_REQ_ACK);
598 msg.param1 = cpu_to_le16(channel->lcid);
599 msg.param2 = cpu_to_le32(granted);
601 qcom_glink_tx(glink, &msg, sizeof(msg), NULL, 0, true);
607 * qcom_glink_advertise_intent - convert an rx intent cmd to wire format and
609 * @glink: The transport to transmit on.
610 * @channel: The local channel
611 * @intent: The intent to pass on to remote.
613 * Return: 0 on success or standard Linux error code.
615 static int qcom_glink_advertise_intent(struct qcom_glink *glink,
616 struct glink_channel *channel,
617 struct glink_core_rx_intent *intent)
628 cmd.id = cpu_to_le16(RPM_CMD_INTENT);
629 cmd.lcid = cpu_to_le16(channel->lcid);
630 cmd.count = cpu_to_le32(1);
631 cmd.size = cpu_to_le32(intent->size);
632 cmd.liid = cpu_to_le32(intent->id);
634 qcom_glink_tx(glink, &cmd, sizeof(cmd), NULL, 0, true);
639 static struct glink_core_rx_intent *
640 qcom_glink_alloc_intent(struct qcom_glink *glink,
641 struct glink_channel *channel,
645 struct glink_core_rx_intent *intent;
649 intent = kzalloc(sizeof(*intent), GFP_KERNEL);
653 intent->data = kzalloc(size, GFP_KERNEL);
657 spin_lock_irqsave(&channel->intent_lock, flags);
658 ret = idr_alloc_cyclic(&channel->liids, intent, 1, -1, GFP_ATOMIC);
660 spin_unlock_irqrestore(&channel->intent_lock, flags);
663 spin_unlock_irqrestore(&channel->intent_lock, flags);
667 intent->reuse = reuseable;
678 static void qcom_glink_handle_rx_done(struct qcom_glink *glink,
679 u32 cid, uint32_t iid,
682 struct glink_core_rx_intent *intent;
683 struct glink_channel *channel;
686 spin_lock_irqsave(&glink->idr_lock, flags);
687 channel = idr_find(&glink->rcids, cid);
688 spin_unlock_irqrestore(&glink->idr_lock, flags);
690 dev_err(glink->dev, "invalid channel id received\n");
694 spin_lock_irqsave(&channel->intent_lock, flags);
695 intent = idr_find(&channel->riids, iid);
698 spin_unlock_irqrestore(&channel->intent_lock, flags);
699 dev_err(glink->dev, "invalid intent id received\n");
703 intent->in_use = false;
706 idr_remove(&channel->riids, intent->id);
709 spin_unlock_irqrestore(&channel->intent_lock, flags);
713 * qcom_glink_handle_intent_req() - Receive a request for rx_intent
715 * @glink: Pointer to the transport interface
716 * @cid: Remote channel ID
717 * @size: size of the intent
719 * The function searches for the local channel to which the request for
720 * rx_intent has arrived and allocates and notifies the remote back
722 static void qcom_glink_handle_intent_req(struct qcom_glink *glink,
723 u32 cid, size_t size)
725 struct glink_core_rx_intent *intent;
726 struct glink_channel *channel;
729 spin_lock_irqsave(&glink->idr_lock, flags);
730 channel = idr_find(&glink->rcids, cid);
731 spin_unlock_irqrestore(&glink->idr_lock, flags);
734 pr_err("%s channel not found for cid %d\n", __func__, cid);
738 intent = qcom_glink_alloc_intent(glink, channel, size, false);
740 qcom_glink_advertise_intent(glink, channel, intent);
742 qcom_glink_send_intent_req_ack(glink, channel, !!intent);
745 static int qcom_glink_rx_defer(struct qcom_glink *glink, size_t extra)
747 struct glink_defer_cmd *dcmd;
749 extra = ALIGN(extra, 8);
751 if (qcom_glink_rx_avail(glink) < sizeof(struct glink_msg) + extra) {
752 dev_dbg(glink->dev, "Insufficient data in rx fifo");
756 dcmd = kzalloc(sizeof(*dcmd) + extra, GFP_ATOMIC);
760 INIT_LIST_HEAD(&dcmd->node);
762 qcom_glink_rx_peak(glink, &dcmd->msg, 0, sizeof(dcmd->msg) + extra);
764 spin_lock(&glink->rx_lock);
765 list_add_tail(&dcmd->node, &glink->rx_queue);
766 spin_unlock(&glink->rx_lock);
768 schedule_work(&glink->rx_work);
769 qcom_glink_rx_advance(glink, sizeof(dcmd->msg) + extra);
774 static int qcom_glink_rx_data(struct qcom_glink *glink, size_t avail)
776 struct glink_core_rx_intent *intent;
777 struct glink_channel *channel;
779 struct glink_msg msg;
783 unsigned int chunk_size;
784 unsigned int left_size;
790 if (avail < sizeof(hdr)) {
791 dev_dbg(glink->dev, "Not enough data in fifo\n");
795 qcom_glink_rx_peak(glink, &hdr, 0, sizeof(hdr));
796 chunk_size = le32_to_cpu(hdr.chunk_size);
797 left_size = le32_to_cpu(hdr.left_size);
799 if (avail < sizeof(hdr) + chunk_size) {
800 dev_dbg(glink->dev, "Payload not yet in fifo\n");
804 rcid = le16_to_cpu(hdr.msg.param1);
805 spin_lock_irqsave(&glink->idr_lock, flags);
806 channel = idr_find(&glink->rcids, rcid);
807 spin_unlock_irqrestore(&glink->idr_lock, flags);
809 dev_dbg(glink->dev, "Data on non-existing channel\n");
811 /* Drop the message */
815 if (glink->intentless) {
816 /* Might have an ongoing, fragmented, message to append */
818 intent = kzalloc(sizeof(*intent), GFP_ATOMIC);
822 intent->data = kmalloc(chunk_size + left_size,
829 intent->id = 0xbabababa;
830 intent->size = chunk_size + left_size;
833 channel->buf = intent;
835 intent = channel->buf;
838 liid = le32_to_cpu(hdr.msg.param2);
840 spin_lock_irqsave(&channel->intent_lock, flags);
841 intent = idr_find(&channel->liids, liid);
842 spin_unlock_irqrestore(&channel->intent_lock, flags);
846 "no intent found for channel %s intent %d",
847 channel->name, liid);
852 if (intent->size - intent->offset < chunk_size) {
853 dev_err(glink->dev, "Insufficient space in intent\n");
855 /* The packet header lied, drop payload */
859 qcom_glink_rx_peak(glink, intent->data + intent->offset,
860 sizeof(hdr), chunk_size);
861 intent->offset += chunk_size;
863 /* Handle message when no fragments remain to be received */
865 spin_lock(&channel->recv_lock);
866 if (channel->ept.cb) {
867 channel->ept.cb(channel->ept.rpdev,
873 spin_unlock(&channel->recv_lock);
878 qcom_glink_rx_done(glink, channel, intent);
882 qcom_glink_rx_advance(glink, ALIGN(sizeof(hdr) + chunk_size, 8));
887 static void qcom_glink_handle_intent(struct qcom_glink *glink,
892 struct glink_core_rx_intent *intent;
893 struct glink_channel *channel;
900 struct glink_msg msg;
901 struct intent_pair intents[];
904 const size_t msglen = struct_size(msg, intents, count);
909 if (avail < msglen) {
910 dev_dbg(glink->dev, "Not enough data in fifo\n");
914 spin_lock_irqsave(&glink->idr_lock, flags);
915 channel = idr_find(&glink->rcids, cid);
916 spin_unlock_irqrestore(&glink->idr_lock, flags);
918 dev_err(glink->dev, "intents for non-existing channel\n");
922 msg = kmalloc(msglen, GFP_ATOMIC);
926 qcom_glink_rx_peak(glink, msg, 0, msglen);
928 for (i = 0; i < count; ++i) {
929 intent = kzalloc(sizeof(*intent), GFP_ATOMIC);
933 intent->id = le32_to_cpu(msg->intents[i].iid);
934 intent->size = le32_to_cpu(msg->intents[i].size);
936 spin_lock_irqsave(&channel->intent_lock, flags);
937 ret = idr_alloc(&channel->riids, intent,
938 intent->id, intent->id + 1, GFP_ATOMIC);
939 spin_unlock_irqrestore(&channel->intent_lock, flags);
942 dev_err(glink->dev, "failed to store remote intent\n");
946 qcom_glink_rx_advance(glink, ALIGN(msglen, 8));
949 static int qcom_glink_rx_open_ack(struct qcom_glink *glink, unsigned int lcid)
951 struct glink_channel *channel;
953 spin_lock(&glink->idr_lock);
954 channel = idr_find(&glink->lcids, lcid);
955 spin_unlock(&glink->idr_lock);
957 dev_err(glink->dev, "Invalid open ack packet\n");
961 complete(&channel->open_ack);
966 static irqreturn_t qcom_glink_native_intr(int irq, void *data)
968 struct qcom_glink *glink = data;
969 struct glink_msg msg;
977 avail = qcom_glink_rx_avail(glink);
978 if (avail < sizeof(msg))
981 qcom_glink_rx_peak(glink, &msg, 0, sizeof(msg));
983 cmd = le16_to_cpu(msg.cmd);
984 param1 = le16_to_cpu(msg.param1);
985 param2 = le32_to_cpu(msg.param2);
988 case RPM_CMD_VERSION:
989 case RPM_CMD_VERSION_ACK:
991 case RPM_CMD_CLOSE_ACK:
992 case RPM_CMD_RX_INTENT_REQ:
993 ret = qcom_glink_rx_defer(glink, 0);
995 case RPM_CMD_OPEN_ACK:
996 ret = qcom_glink_rx_open_ack(glink, param1);
997 qcom_glink_rx_advance(glink, ALIGN(sizeof(msg), 8));
1000 ret = qcom_glink_rx_defer(glink, param2);
1002 case RPM_CMD_TX_DATA:
1003 case RPM_CMD_TX_DATA_CONT:
1004 ret = qcom_glink_rx_data(glink, avail);
1006 case RPM_CMD_READ_NOTIF:
1007 qcom_glink_rx_advance(glink, ALIGN(sizeof(msg), 8));
1009 mbox_send_message(glink->mbox_chan, NULL);
1010 mbox_client_txdone(glink->mbox_chan, 0);
1012 case RPM_CMD_INTENT:
1013 qcom_glink_handle_intent(glink, param1, param2, avail);
1015 case RPM_CMD_RX_DONE:
1016 qcom_glink_handle_rx_done(glink, param1, param2, false);
1017 qcom_glink_rx_advance(glink, ALIGN(sizeof(msg), 8));
1019 case RPM_CMD_RX_DONE_W_REUSE:
1020 qcom_glink_handle_rx_done(glink, param1, param2, true);
1021 qcom_glink_rx_advance(glink, ALIGN(sizeof(msg), 8));
1023 case RPM_CMD_RX_INTENT_REQ_ACK:
1024 qcom_glink_handle_intent_req_ack(glink, param1, param2);
1025 qcom_glink_rx_advance(glink, ALIGN(sizeof(msg), 8));
1028 dev_err(glink->dev, "unhandled rx cmd: %d\n", cmd);
1040 /* Locally initiated rpmsg_create_ept */
1041 static struct glink_channel *qcom_glink_create_local(struct qcom_glink *glink,
1044 struct glink_channel *channel;
1046 unsigned long flags;
1048 channel = qcom_glink_alloc_channel(glink, name);
1049 if (IS_ERR(channel))
1050 return ERR_CAST(channel);
1052 ret = qcom_glink_send_open_req(glink, channel);
1054 goto release_channel;
1056 ret = wait_for_completion_timeout(&channel->open_ack, 5 * HZ);
1060 ret = wait_for_completion_timeout(&channel->open_req, 5 * HZ);
1064 qcom_glink_send_open_ack(glink, channel);
1069 /* qcom_glink_send_open_req() did register the channel in lcids*/
1070 spin_lock_irqsave(&glink->idr_lock, flags);
1071 idr_remove(&glink->lcids, channel->lcid);
1072 spin_unlock_irqrestore(&glink->idr_lock, flags);
1075 /* Release qcom_glink_send_open_req() reference */
1076 kref_put(&channel->refcount, qcom_glink_channel_release);
1077 /* Release qcom_glink_alloc_channel() reference */
1078 kref_put(&channel->refcount, qcom_glink_channel_release);
1080 return ERR_PTR(-ETIMEDOUT);
1083 /* Remote initiated rpmsg_create_ept */
1084 static int qcom_glink_create_remote(struct qcom_glink *glink,
1085 struct glink_channel *channel)
1089 qcom_glink_send_open_ack(glink, channel);
1091 ret = qcom_glink_send_open_req(glink, channel);
1095 ret = wait_for_completion_timeout(&channel->open_ack, 5 * HZ);
1105 * Send a close request to "undo" our open-ack. The close-ack will
1106 * release qcom_glink_send_open_req() reference and the last reference
1107 * will be relesed after receiving remote_close or transport unregister
1108 * by calling qcom_glink_native_remove().
1110 qcom_glink_send_close_req(glink, channel);
1115 static struct rpmsg_endpoint *qcom_glink_create_ept(struct rpmsg_device *rpdev,
1118 struct rpmsg_channel_info
1121 struct glink_channel *parent = to_glink_channel(rpdev->ept);
1122 struct glink_channel *channel;
1123 struct qcom_glink *glink = parent->glink;
1124 struct rpmsg_endpoint *ept;
1125 const char *name = chinfo.name;
1128 unsigned long flags;
1130 spin_lock_irqsave(&glink->idr_lock, flags);
1131 idr_for_each_entry(&glink->rcids, channel, cid) {
1132 if (!strcmp(channel->name, name))
1135 spin_unlock_irqrestore(&glink->idr_lock, flags);
1138 channel = qcom_glink_create_local(glink, name);
1139 if (IS_ERR(channel))
1142 ret = qcom_glink_create_remote(glink, channel);
1147 ept = &channel->ept;
1151 ept->ops = &glink_endpoint_ops;
1156 static int qcom_glink_announce_create(struct rpmsg_device *rpdev)
1158 struct glink_channel *channel = to_glink_channel(rpdev->ept);
1159 struct device_node *np = rpdev->dev.of_node;
1160 struct qcom_glink *glink = channel->glink;
1161 struct glink_core_rx_intent *intent;
1162 const struct property *prop = NULL;
1163 __be32 defaults[] = { cpu_to_be32(SZ_1K), cpu_to_be32(5) };
1166 __be32 *val = defaults;
1169 if (glink->intentless)
1172 prop = of_find_property(np, "qcom,intents", NULL);
1175 num_groups = prop->length / sizeof(u32) / 2;
1178 /* Channel is now open, advertise base set of intents */
1179 while (num_groups--) {
1180 size = be32_to_cpup(val++);
1181 num_intents = be32_to_cpup(val++);
1182 while (num_intents--) {
1183 intent = qcom_glink_alloc_intent(glink, channel, size,
1188 qcom_glink_advertise_intent(glink, channel, intent);
1194 static void qcom_glink_destroy_ept(struct rpmsg_endpoint *ept)
1196 struct glink_channel *channel = to_glink_channel(ept);
1197 struct qcom_glink *glink = channel->glink;
1198 unsigned long flags;
1200 spin_lock_irqsave(&channel->recv_lock, flags);
1201 channel->ept.cb = NULL;
1202 spin_unlock_irqrestore(&channel->recv_lock, flags);
1204 /* Decouple the potential rpdev from the channel */
1205 channel->rpdev = NULL;
1207 qcom_glink_send_close_req(glink, channel);
1210 static int qcom_glink_request_intent(struct qcom_glink *glink,
1211 struct glink_channel *channel,
1222 mutex_lock(&channel->intent_req_lock);
1224 reinit_completion(&channel->intent_req_comp);
1226 cmd.id = RPM_CMD_RX_INTENT_REQ;
1227 cmd.cid = channel->lcid;
1230 ret = qcom_glink_tx(glink, &cmd, sizeof(cmd), NULL, 0, true);
1234 ret = wait_for_completion_timeout(&channel->intent_req_comp, 10 * HZ);
1236 dev_err(glink->dev, "intent request timed out\n");
1239 ret = channel->intent_req_result ? 0 : -ECANCELED;
1243 mutex_unlock(&channel->intent_req_lock);
1247 static int __qcom_glink_send(struct glink_channel *channel,
1248 void *data, int len, bool wait)
1250 struct qcom_glink *glink = channel->glink;
1251 struct glink_core_rx_intent *intent = NULL;
1252 struct glink_core_rx_intent *tmp;
1255 struct glink_msg msg;
1260 unsigned long flags;
1262 if (!glink->intentless) {
1264 spin_lock_irqsave(&channel->intent_lock, flags);
1265 idr_for_each_entry(&channel->riids, tmp, iid) {
1266 if (tmp->size >= len && !tmp->in_use) {
1269 else if (intent->size > tmp->size)
1271 if (intent->size == len)
1276 intent->in_use = true;
1277 spin_unlock_irqrestore(&channel->intent_lock, flags);
1279 /* We found an available intent */
1286 ret = qcom_glink_request_intent(glink, channel, len);
1294 req.msg.cmd = cpu_to_le16(RPM_CMD_TX_DATA);
1295 req.msg.param1 = cpu_to_le16(channel->lcid);
1296 req.msg.param2 = cpu_to_le32(iid);
1297 req.chunk_size = cpu_to_le32(len);
1298 req.left_size = cpu_to_le32(0);
1300 ret = qcom_glink_tx(glink, &req, sizeof(req), data, len, wait);
1302 /* Mark intent available if we failed */
1304 intent->in_use = false;
1309 static int qcom_glink_send(struct rpmsg_endpoint *ept, void *data, int len)
1311 struct glink_channel *channel = to_glink_channel(ept);
1313 return __qcom_glink_send(channel, data, len, true);
1316 static int qcom_glink_trysend(struct rpmsg_endpoint *ept, void *data, int len)
1318 struct glink_channel *channel = to_glink_channel(ept);
1320 return __qcom_glink_send(channel, data, len, false);
1324 * Finds the device_node for the glink child interested in this channel.
1326 static struct device_node *qcom_glink_match_channel(struct device_node *node,
1327 const char *channel)
1329 struct device_node *child;
1334 for_each_available_child_of_node(node, child) {
1335 key = "qcom,glink-channels";
1336 ret = of_property_read_string(child, key, &name);
1340 if (strcmp(name, channel) == 0)
1347 static const struct rpmsg_device_ops glink_device_ops = {
1348 .create_ept = qcom_glink_create_ept,
1349 .announce_create = qcom_glink_announce_create,
1352 static const struct rpmsg_endpoint_ops glink_endpoint_ops = {
1353 .destroy_ept = qcom_glink_destroy_ept,
1354 .send = qcom_glink_send,
1355 .trysend = qcom_glink_trysend,
1358 static void qcom_glink_rpdev_release(struct device *dev)
1360 struct rpmsg_device *rpdev = to_rpmsg_device(dev);
1361 struct glink_channel *channel = to_glink_channel(rpdev->ept);
1363 channel->rpdev = NULL;
1367 static int qcom_glink_rx_open(struct qcom_glink *glink, unsigned int rcid,
1370 struct glink_channel *channel;
1371 struct rpmsg_device *rpdev;
1372 bool create_device = false;
1373 struct device_node *node;
1376 unsigned long flags;
1378 spin_lock_irqsave(&glink->idr_lock, flags);
1379 idr_for_each_entry(&glink->lcids, channel, lcid) {
1380 if (!strcmp(channel->name, name))
1383 spin_unlock_irqrestore(&glink->idr_lock, flags);
1386 channel = qcom_glink_alloc_channel(glink, name);
1387 if (IS_ERR(channel))
1388 return PTR_ERR(channel);
1390 /* The opening dance was initiated by the remote */
1391 create_device = true;
1394 spin_lock_irqsave(&glink->idr_lock, flags);
1395 ret = idr_alloc(&glink->rcids, channel, rcid, rcid + 1, GFP_ATOMIC);
1397 dev_err(glink->dev, "Unable to insert channel into rcid list\n");
1398 spin_unlock_irqrestore(&glink->idr_lock, flags);
1401 channel->rcid = ret;
1402 spin_unlock_irqrestore(&glink->idr_lock, flags);
1404 complete(&channel->open_req);
1406 if (create_device) {
1407 rpdev = kzalloc(sizeof(*rpdev), GFP_KERNEL);
1413 rpdev->ept = &channel->ept;
1414 strncpy(rpdev->id.name, name, RPMSG_NAME_SIZE);
1415 rpdev->src = RPMSG_ADDR_ANY;
1416 rpdev->dst = RPMSG_ADDR_ANY;
1417 rpdev->ops = &glink_device_ops;
1419 node = qcom_glink_match_channel(glink->dev->of_node, name);
1420 rpdev->dev.of_node = node;
1421 rpdev->dev.parent = glink->dev;
1422 rpdev->dev.release = qcom_glink_rpdev_release;
1424 ret = rpmsg_register_device(rpdev);
1428 channel->rpdev = rpdev;
1436 spin_lock_irqsave(&glink->idr_lock, flags);
1437 idr_remove(&glink->rcids, channel->rcid);
1439 spin_unlock_irqrestore(&glink->idr_lock, flags);
1441 /* Release the reference, iff we took it */
1443 kref_put(&channel->refcount, qcom_glink_channel_release);
1448 static void qcom_glink_rx_close(struct qcom_glink *glink, unsigned int rcid)
1450 struct rpmsg_channel_info chinfo;
1451 struct glink_channel *channel;
1452 unsigned long flags;
1454 spin_lock_irqsave(&glink->idr_lock, flags);
1455 channel = idr_find(&glink->rcids, rcid);
1456 spin_unlock_irqrestore(&glink->idr_lock, flags);
1457 if (WARN(!channel, "close request on unknown channel\n"))
1460 /* cancel pending rx_done work */
1461 cancel_work_sync(&channel->intent_work);
1463 if (channel->rpdev) {
1464 strncpy(chinfo.name, channel->name, sizeof(chinfo.name));
1465 chinfo.src = RPMSG_ADDR_ANY;
1466 chinfo.dst = RPMSG_ADDR_ANY;
1468 rpmsg_unregister_device(glink->dev, &chinfo);
1471 qcom_glink_send_close_ack(glink, channel->rcid);
1473 spin_lock_irqsave(&glink->idr_lock, flags);
1474 idr_remove(&glink->rcids, channel->rcid);
1476 spin_unlock_irqrestore(&glink->idr_lock, flags);
1478 kref_put(&channel->refcount, qcom_glink_channel_release);
1481 static void qcom_glink_rx_close_ack(struct qcom_glink *glink, unsigned int lcid)
1483 struct glink_channel *channel;
1484 unsigned long flags;
1486 spin_lock_irqsave(&glink->idr_lock, flags);
1487 channel = idr_find(&glink->lcids, lcid);
1488 if (WARN(!channel, "close ack on unknown channel\n")) {
1489 spin_unlock_irqrestore(&glink->idr_lock, flags);
1493 idr_remove(&glink->lcids, channel->lcid);
1495 spin_unlock_irqrestore(&glink->idr_lock, flags);
1497 kref_put(&channel->refcount, qcom_glink_channel_release);
1500 static void qcom_glink_work(struct work_struct *work)
1502 struct qcom_glink *glink = container_of(work, struct qcom_glink,
1504 struct glink_defer_cmd *dcmd;
1505 struct glink_msg *msg;
1506 unsigned long flags;
1507 unsigned int param1;
1508 unsigned int param2;
1512 spin_lock_irqsave(&glink->rx_lock, flags);
1513 if (list_empty(&glink->rx_queue)) {
1514 spin_unlock_irqrestore(&glink->rx_lock, flags);
1517 dcmd = list_first_entry(&glink->rx_queue,
1518 struct glink_defer_cmd, node);
1519 list_del(&dcmd->node);
1520 spin_unlock_irqrestore(&glink->rx_lock, flags);
1523 cmd = le16_to_cpu(msg->cmd);
1524 param1 = le16_to_cpu(msg->param1);
1525 param2 = le32_to_cpu(msg->param2);
1528 case RPM_CMD_VERSION:
1529 qcom_glink_receive_version(glink, param1, param2);
1531 case RPM_CMD_VERSION_ACK:
1532 qcom_glink_receive_version_ack(glink, param1, param2);
1535 qcom_glink_rx_open(glink, param1, msg->data);
1538 qcom_glink_rx_close(glink, param1);
1540 case RPM_CMD_CLOSE_ACK:
1541 qcom_glink_rx_close_ack(glink, param1);
1543 case RPM_CMD_RX_INTENT_REQ:
1544 qcom_glink_handle_intent_req(glink, param1, param2);
1547 WARN(1, "Unknown defer object %d\n", cmd);
1555 struct qcom_glink *qcom_glink_native_probe(struct device *dev,
1556 unsigned long features,
1557 struct qcom_glink_pipe *rx,
1558 struct qcom_glink_pipe *tx,
1563 struct qcom_glink *glink;
1565 glink = devm_kzalloc(dev, sizeof(*glink), GFP_KERNEL);
1567 return ERR_PTR(-ENOMEM);
1570 glink->tx_pipe = tx;
1571 glink->rx_pipe = rx;
1573 glink->features = features;
1574 glink->intentless = intentless;
1576 spin_lock_init(&glink->tx_lock);
1577 spin_lock_init(&glink->rx_lock);
1578 INIT_LIST_HEAD(&glink->rx_queue);
1579 INIT_WORK(&glink->rx_work, qcom_glink_work);
1581 spin_lock_init(&glink->idr_lock);
1582 idr_init(&glink->lcids);
1583 idr_init(&glink->rcids);
1585 ret = of_property_read_string(dev->of_node, "label", &glink->name);
1587 glink->name = dev->of_node->name;
1589 glink->mbox_client.dev = dev;
1590 glink->mbox_client.knows_txdone = true;
1591 glink->mbox_chan = mbox_request_channel(&glink->mbox_client, 0);
1592 if (IS_ERR(glink->mbox_chan)) {
1593 if (PTR_ERR(glink->mbox_chan) != -EPROBE_DEFER)
1594 dev_err(dev, "failed to acquire IPC channel\n");
1595 return ERR_CAST(glink->mbox_chan);
1598 irq = of_irq_get(dev->of_node, 0);
1599 ret = devm_request_irq(dev, irq,
1600 qcom_glink_native_intr,
1601 IRQF_NO_SUSPEND | IRQF_SHARED,
1602 "glink-native", glink);
1604 dev_err(dev, "failed to request IRQ\n");
1605 return ERR_PTR(ret);
1610 ret = qcom_glink_send_version(glink);
1612 return ERR_PTR(ret);
1616 EXPORT_SYMBOL_GPL(qcom_glink_native_probe);
1618 static int qcom_glink_remove_device(struct device *dev, void *data)
1620 device_unregister(dev);
1625 void qcom_glink_native_remove(struct qcom_glink *glink)
1627 struct glink_channel *channel;
1630 unsigned long flags;
1632 disable_irq(glink->irq);
1633 cancel_work_sync(&glink->rx_work);
1635 ret = device_for_each_child(glink->dev, NULL, qcom_glink_remove_device);
1637 dev_warn(glink->dev, "Can't remove GLINK devices: %d\n", ret);
1639 spin_lock_irqsave(&glink->idr_lock, flags);
1640 /* Release any defunct local channels, waiting for close-ack */
1641 idr_for_each_entry(&glink->lcids, channel, cid)
1642 kref_put(&channel->refcount, qcom_glink_channel_release);
1644 /* Release any defunct local channels, waiting for close-req */
1645 idr_for_each_entry(&glink->rcids, channel, cid)
1646 kref_put(&channel->refcount, qcom_glink_channel_release);
1648 idr_destroy(&glink->lcids);
1649 idr_destroy(&glink->rcids);
1650 spin_unlock_irqrestore(&glink->idr_lock, flags);
1651 mbox_free_channel(glink->mbox_chan);
1653 EXPORT_SYMBOL_GPL(qcom_glink_native_remove);
1655 void qcom_glink_native_unregister(struct qcom_glink *glink)
1657 device_unregister(glink->dev);
1659 EXPORT_SYMBOL_GPL(qcom_glink_native_unregister);
1661 MODULE_DESCRIPTION("Qualcomm GLINK driver");
1662 MODULE_LICENSE("GPL v2");