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);
225 if (!channel->name) {
227 return ERR_PTR(-ENOMEM);
230 init_completion(&channel->open_req);
231 init_completion(&channel->open_ack);
232 init_completion(&channel->intent_req_comp);
234 INIT_LIST_HEAD(&channel->done_intents);
235 INIT_WORK(&channel->intent_work, qcom_glink_rx_done_work);
237 idr_init(&channel->liids);
238 idr_init(&channel->riids);
239 kref_init(&channel->refcount);
244 static void qcom_glink_channel_release(struct kref *ref)
246 struct glink_channel *channel = container_of(ref, struct glink_channel,
248 struct glink_core_rx_intent *intent;
249 struct glink_core_rx_intent *tmp;
253 /* cancel pending rx_done work */
254 cancel_work_sync(&channel->intent_work);
256 spin_lock_irqsave(&channel->intent_lock, flags);
257 /* Free all non-reuse intents pending rx_done work */
258 list_for_each_entry_safe(intent, tmp, &channel->done_intents, node) {
259 if (!intent->reuse) {
265 idr_for_each_entry(&channel->liids, tmp, iid) {
269 idr_destroy(&channel->liids);
271 idr_for_each_entry(&channel->riids, tmp, iid)
273 idr_destroy(&channel->riids);
274 spin_unlock_irqrestore(&channel->intent_lock, flags);
276 kfree(channel->name);
280 static size_t qcom_glink_rx_avail(struct qcom_glink *glink)
282 return glink->rx_pipe->avail(glink->rx_pipe);
285 static void qcom_glink_rx_peak(struct qcom_glink *glink,
286 void *data, unsigned int offset, size_t count)
288 glink->rx_pipe->peak(glink->rx_pipe, data, offset, count);
291 static void qcom_glink_rx_advance(struct qcom_glink *glink, size_t count)
293 glink->rx_pipe->advance(glink->rx_pipe, count);
296 static size_t qcom_glink_tx_avail(struct qcom_glink *glink)
298 return glink->tx_pipe->avail(glink->tx_pipe);
301 static void qcom_glink_tx_write(struct qcom_glink *glink,
302 const void *hdr, size_t hlen,
303 const void *data, size_t dlen)
305 glink->tx_pipe->write(glink->tx_pipe, hdr, hlen, data, dlen);
308 static int qcom_glink_tx(struct qcom_glink *glink,
309 const void *hdr, size_t hlen,
310 const void *data, size_t dlen, bool wait)
312 unsigned int tlen = hlen + dlen;
316 /* Reject packets that are too big */
317 if (tlen >= glink->tx_pipe->length)
320 spin_lock_irqsave(&glink->tx_lock, flags);
322 while (qcom_glink_tx_avail(glink) < tlen) {
328 /* Wait without holding the tx_lock */
329 spin_unlock_irqrestore(&glink->tx_lock, flags);
331 usleep_range(10000, 15000);
333 spin_lock_irqsave(&glink->tx_lock, flags);
336 qcom_glink_tx_write(glink, hdr, hlen, data, dlen);
338 mbox_send_message(glink->mbox_chan, NULL);
339 mbox_client_txdone(glink->mbox_chan, 0);
342 spin_unlock_irqrestore(&glink->tx_lock, flags);
347 static int qcom_glink_send_version(struct qcom_glink *glink)
349 struct glink_msg msg;
351 msg.cmd = cpu_to_le16(RPM_CMD_VERSION);
352 msg.param1 = cpu_to_le16(GLINK_VERSION_1);
353 msg.param2 = cpu_to_le32(glink->features);
355 return qcom_glink_tx(glink, &msg, sizeof(msg), NULL, 0, true);
358 static void qcom_glink_send_version_ack(struct qcom_glink *glink)
360 struct glink_msg msg;
362 msg.cmd = cpu_to_le16(RPM_CMD_VERSION_ACK);
363 msg.param1 = cpu_to_le16(GLINK_VERSION_1);
364 msg.param2 = cpu_to_le32(glink->features);
366 qcom_glink_tx(glink, &msg, sizeof(msg), NULL, 0, true);
369 static void qcom_glink_send_open_ack(struct qcom_glink *glink,
370 struct glink_channel *channel)
372 struct glink_msg msg;
374 msg.cmd = cpu_to_le16(RPM_CMD_OPEN_ACK);
375 msg.param1 = cpu_to_le16(channel->rcid);
376 msg.param2 = cpu_to_le32(0);
378 qcom_glink_tx(glink, &msg, sizeof(msg), NULL, 0, true);
381 static void qcom_glink_handle_intent_req_ack(struct qcom_glink *glink,
382 unsigned int cid, bool granted)
384 struct glink_channel *channel;
387 spin_lock_irqsave(&glink->idr_lock, flags);
388 channel = idr_find(&glink->rcids, cid);
389 spin_unlock_irqrestore(&glink->idr_lock, flags);
391 dev_err(glink->dev, "unable to find channel\n");
395 channel->intent_req_result = granted;
396 complete(&channel->intent_req_comp);
400 * qcom_glink_send_open_req() - send a RPM_CMD_OPEN request to the remote
401 * @glink: Ptr to the glink edge
402 * @channel: Ptr to the channel that the open req is sent
404 * Allocates a local channel id and sends a RPM_CMD_OPEN message to the remote.
405 * Will return with refcount held, regardless of outcome.
407 * Returns 0 on success, negative errno otherwise.
409 static int qcom_glink_send_open_req(struct qcom_glink *glink,
410 struct glink_channel *channel)
413 struct glink_msg msg;
414 u8 name[GLINK_NAME_SIZE];
416 int name_len = strlen(channel->name) + 1;
417 int req_len = ALIGN(sizeof(req.msg) + name_len, 8);
421 kref_get(&channel->refcount);
423 spin_lock_irqsave(&glink->idr_lock, flags);
424 ret = idr_alloc_cyclic(&glink->lcids, channel,
425 RPM_GLINK_CID_MIN, RPM_GLINK_CID_MAX,
427 spin_unlock_irqrestore(&glink->idr_lock, flags);
433 req.msg.cmd = cpu_to_le16(RPM_CMD_OPEN);
434 req.msg.param1 = cpu_to_le16(channel->lcid);
435 req.msg.param2 = cpu_to_le32(name_len);
436 strcpy(req.name, channel->name);
438 ret = qcom_glink_tx(glink, &req, req_len, NULL, 0, true);
445 spin_lock_irqsave(&glink->idr_lock, flags);
446 idr_remove(&glink->lcids, channel->lcid);
448 spin_unlock_irqrestore(&glink->idr_lock, flags);
453 static void qcom_glink_send_close_req(struct qcom_glink *glink,
454 struct glink_channel *channel)
456 struct glink_msg req;
458 req.cmd = cpu_to_le16(RPM_CMD_CLOSE);
459 req.param1 = cpu_to_le16(channel->lcid);
462 qcom_glink_tx(glink, &req, sizeof(req), NULL, 0, true);
465 static void qcom_glink_send_close_ack(struct qcom_glink *glink,
468 struct glink_msg req;
470 req.cmd = cpu_to_le16(RPM_CMD_CLOSE_ACK);
471 req.param1 = cpu_to_le16(rcid);
474 qcom_glink_tx(glink, &req, sizeof(req), NULL, 0, true);
477 static void qcom_glink_rx_done_work(struct work_struct *work)
479 struct glink_channel *channel = container_of(work, struct glink_channel,
481 struct qcom_glink *glink = channel->glink;
482 struct glink_core_rx_intent *intent, *tmp;
489 unsigned int cid = channel->lcid;
494 spin_lock_irqsave(&channel->intent_lock, flags);
495 list_for_each_entry_safe(intent, tmp, &channel->done_intents, node) {
496 list_del(&intent->node);
497 spin_unlock_irqrestore(&channel->intent_lock, flags);
499 reuse = intent->reuse;
501 cmd.id = reuse ? RPM_CMD_RX_DONE_W_REUSE : RPM_CMD_RX_DONE;
505 qcom_glink_tx(glink, &cmd, sizeof(cmd), NULL, 0, true);
510 spin_lock_irqsave(&channel->intent_lock, flags);
512 spin_unlock_irqrestore(&channel->intent_lock, flags);
515 static void qcom_glink_rx_done(struct qcom_glink *glink,
516 struct glink_channel *channel,
517 struct glink_core_rx_intent *intent)
519 /* We don't send RX_DONE to intentless systems */
520 if (glink->intentless) {
526 /* Take it off the tree of receive intents */
527 if (!intent->reuse) {
528 spin_lock(&channel->intent_lock);
529 idr_remove(&channel->liids, intent->id);
530 spin_unlock(&channel->intent_lock);
533 /* Schedule the sending of a rx_done indication */
534 spin_lock(&channel->intent_lock);
535 list_add_tail(&intent->node, &channel->done_intents);
536 spin_unlock(&channel->intent_lock);
538 schedule_work(&channel->intent_work);
542 * qcom_glink_receive_version() - receive version/features from remote system
544 * @glink: pointer to transport interface
545 * @version: remote version
546 * @features: remote features
548 * This function is called in response to a remote-initiated version/feature
549 * negotiation sequence.
551 static void qcom_glink_receive_version(struct qcom_glink *glink,
558 case GLINK_VERSION_1:
559 glink->features &= features;
562 qcom_glink_send_version_ack(glink);
568 * qcom_glink_receive_version_ack() - receive negotiation ack from remote system
570 * @glink: pointer to transport interface
571 * @version: remote version response
572 * @features: remote features response
574 * This function is called in response to a local-initiated version/feature
575 * negotiation sequence and is the counter-offer from the remote side based
576 * upon the initial version and feature set requested.
578 static void qcom_glink_receive_version_ack(struct qcom_glink *glink,
584 /* Version negotiation failed */
586 case GLINK_VERSION_1:
587 if (features == glink->features)
590 glink->features &= features;
593 qcom_glink_send_version(glink);
599 * qcom_glink_send_intent_req_ack() - convert an rx intent request ack cmd to
600 * wire format and transmit
601 * @glink: The transport to transmit on.
602 * @channel: The glink channel
603 * @granted: The request response to encode.
605 * Return: 0 on success or standard Linux error code.
607 static int qcom_glink_send_intent_req_ack(struct qcom_glink *glink,
608 struct glink_channel *channel,
611 struct glink_msg msg;
613 msg.cmd = cpu_to_le16(RPM_CMD_RX_INTENT_REQ_ACK);
614 msg.param1 = cpu_to_le16(channel->lcid);
615 msg.param2 = cpu_to_le32(granted);
617 qcom_glink_tx(glink, &msg, sizeof(msg), NULL, 0, true);
623 * qcom_glink_advertise_intent - convert an rx intent cmd to wire format and
625 * @glink: The transport to transmit on.
626 * @channel: The local channel
627 * @intent: The intent to pass on to remote.
629 * Return: 0 on success or standard Linux error code.
631 static int qcom_glink_advertise_intent(struct qcom_glink *glink,
632 struct glink_channel *channel,
633 struct glink_core_rx_intent *intent)
644 cmd.id = cpu_to_le16(RPM_CMD_INTENT);
645 cmd.lcid = cpu_to_le16(channel->lcid);
646 cmd.count = cpu_to_le32(1);
647 cmd.size = cpu_to_le32(intent->size);
648 cmd.liid = cpu_to_le32(intent->id);
650 qcom_glink_tx(glink, &cmd, sizeof(cmd), NULL, 0, true);
655 static struct glink_core_rx_intent *
656 qcom_glink_alloc_intent(struct qcom_glink *glink,
657 struct glink_channel *channel,
661 struct glink_core_rx_intent *intent;
665 intent = kzalloc(sizeof(*intent), GFP_KERNEL);
669 intent->data = kzalloc(size, GFP_KERNEL);
673 spin_lock_irqsave(&channel->intent_lock, flags);
674 ret = idr_alloc_cyclic(&channel->liids, intent, 1, -1, GFP_ATOMIC);
676 spin_unlock_irqrestore(&channel->intent_lock, flags);
679 spin_unlock_irqrestore(&channel->intent_lock, flags);
683 intent->reuse = reuseable;
694 static void qcom_glink_handle_rx_done(struct qcom_glink *glink,
695 u32 cid, uint32_t iid,
698 struct glink_core_rx_intent *intent;
699 struct glink_channel *channel;
702 spin_lock_irqsave(&glink->idr_lock, flags);
703 channel = idr_find(&glink->rcids, cid);
704 spin_unlock_irqrestore(&glink->idr_lock, flags);
706 dev_err(glink->dev, "invalid channel id received\n");
710 spin_lock_irqsave(&channel->intent_lock, flags);
711 intent = idr_find(&channel->riids, iid);
714 spin_unlock_irqrestore(&channel->intent_lock, flags);
715 dev_err(glink->dev, "invalid intent id received\n");
719 intent->in_use = false;
722 idr_remove(&channel->riids, intent->id);
725 spin_unlock_irqrestore(&channel->intent_lock, flags);
729 * qcom_glink_handle_intent_req() - Receive a request for rx_intent
731 * @glink: Pointer to the transport interface
732 * @cid: Remote channel ID
733 * @size: size of the intent
735 * The function searches for the local channel to which the request for
736 * rx_intent has arrived and allocates and notifies the remote back
738 static void qcom_glink_handle_intent_req(struct qcom_glink *glink,
739 u32 cid, size_t size)
741 struct glink_core_rx_intent *intent;
742 struct glink_channel *channel;
745 spin_lock_irqsave(&glink->idr_lock, flags);
746 channel = idr_find(&glink->rcids, cid);
747 spin_unlock_irqrestore(&glink->idr_lock, flags);
750 pr_err("%s channel not found for cid %d\n", __func__, cid);
754 intent = qcom_glink_alloc_intent(glink, channel, size, false);
756 qcom_glink_advertise_intent(glink, channel, intent);
758 qcom_glink_send_intent_req_ack(glink, channel, !!intent);
761 static int qcom_glink_rx_defer(struct qcom_glink *glink, size_t extra)
763 struct glink_defer_cmd *dcmd;
765 extra = ALIGN(extra, 8);
767 if (qcom_glink_rx_avail(glink) < sizeof(struct glink_msg) + extra) {
768 dev_dbg(glink->dev, "Insufficient data in rx fifo");
772 dcmd = kzalloc(sizeof(*dcmd) + extra, GFP_ATOMIC);
776 INIT_LIST_HEAD(&dcmd->node);
778 qcom_glink_rx_peak(glink, &dcmd->msg, 0, sizeof(dcmd->msg) + extra);
780 spin_lock(&glink->rx_lock);
781 list_add_tail(&dcmd->node, &glink->rx_queue);
782 spin_unlock(&glink->rx_lock);
784 schedule_work(&glink->rx_work);
785 qcom_glink_rx_advance(glink, sizeof(dcmd->msg) + extra);
790 static int qcom_glink_rx_data(struct qcom_glink *glink, size_t avail)
792 struct glink_core_rx_intent *intent;
793 struct glink_channel *channel;
795 struct glink_msg msg;
799 unsigned int chunk_size;
800 unsigned int left_size;
806 if (avail < sizeof(hdr)) {
807 dev_dbg(glink->dev, "Not enough data in fifo\n");
811 qcom_glink_rx_peak(glink, &hdr, 0, sizeof(hdr));
812 chunk_size = le32_to_cpu(hdr.chunk_size);
813 left_size = le32_to_cpu(hdr.left_size);
815 if (avail < sizeof(hdr) + chunk_size) {
816 dev_dbg(glink->dev, "Payload not yet in fifo\n");
820 rcid = le16_to_cpu(hdr.msg.param1);
821 spin_lock_irqsave(&glink->idr_lock, flags);
822 channel = idr_find(&glink->rcids, rcid);
823 spin_unlock_irqrestore(&glink->idr_lock, flags);
825 dev_dbg(glink->dev, "Data on non-existing channel\n");
827 /* Drop the message */
831 if (glink->intentless) {
832 /* Might have an ongoing, fragmented, message to append */
834 intent = kzalloc(sizeof(*intent), GFP_ATOMIC);
838 intent->data = kmalloc(chunk_size + left_size,
845 intent->id = 0xbabababa;
846 intent->size = chunk_size + left_size;
849 channel->buf = intent;
851 intent = channel->buf;
854 liid = le32_to_cpu(hdr.msg.param2);
856 spin_lock_irqsave(&channel->intent_lock, flags);
857 intent = idr_find(&channel->liids, liid);
858 spin_unlock_irqrestore(&channel->intent_lock, flags);
862 "no intent found for channel %s intent %d",
863 channel->name, liid);
869 if (intent->size - intent->offset < chunk_size) {
870 dev_err(glink->dev, "Insufficient space in intent\n");
872 /* The packet header lied, drop payload */
876 qcom_glink_rx_peak(glink, intent->data + intent->offset,
877 sizeof(hdr), chunk_size);
878 intent->offset += chunk_size;
880 /* Handle message when no fragments remain to be received */
882 spin_lock(&channel->recv_lock);
883 if (channel->ept.cb) {
884 channel->ept.cb(channel->ept.rpdev,
890 spin_unlock(&channel->recv_lock);
895 qcom_glink_rx_done(glink, channel, intent);
899 qcom_glink_rx_advance(glink, ALIGN(sizeof(hdr) + chunk_size, 8));
904 static void qcom_glink_handle_intent(struct qcom_glink *glink,
909 struct glink_core_rx_intent *intent;
910 struct glink_channel *channel;
917 struct glink_msg msg;
918 struct intent_pair intents[];
921 const size_t msglen = struct_size(msg, intents, count);
926 if (avail < msglen) {
927 dev_dbg(glink->dev, "Not enough data in fifo\n");
931 spin_lock_irqsave(&glink->idr_lock, flags);
932 channel = idr_find(&glink->rcids, cid);
933 spin_unlock_irqrestore(&glink->idr_lock, flags);
935 dev_err(glink->dev, "intents for non-existing channel\n");
936 qcom_glink_rx_advance(glink, ALIGN(msglen, 8));
940 msg = kmalloc(msglen, GFP_ATOMIC);
944 qcom_glink_rx_peak(glink, msg, 0, msglen);
946 for (i = 0; i < count; ++i) {
947 intent = kzalloc(sizeof(*intent), GFP_ATOMIC);
951 intent->id = le32_to_cpu(msg->intents[i].iid);
952 intent->size = le32_to_cpu(msg->intents[i].size);
954 spin_lock_irqsave(&channel->intent_lock, flags);
955 ret = idr_alloc(&channel->riids, intent,
956 intent->id, intent->id + 1, GFP_ATOMIC);
957 spin_unlock_irqrestore(&channel->intent_lock, flags);
960 dev_err(glink->dev, "failed to store remote intent\n");
964 qcom_glink_rx_advance(glink, ALIGN(msglen, 8));
967 static int qcom_glink_rx_open_ack(struct qcom_glink *glink, unsigned int lcid)
969 struct glink_channel *channel;
971 spin_lock(&glink->idr_lock);
972 channel = idr_find(&glink->lcids, lcid);
973 spin_unlock(&glink->idr_lock);
975 dev_err(glink->dev, "Invalid open ack packet\n");
979 complete_all(&channel->open_ack);
984 static irqreturn_t qcom_glink_native_intr(int irq, void *data)
986 struct qcom_glink *glink = data;
987 struct glink_msg msg;
995 avail = qcom_glink_rx_avail(glink);
996 if (avail < sizeof(msg))
999 qcom_glink_rx_peak(glink, &msg, 0, sizeof(msg));
1001 cmd = le16_to_cpu(msg.cmd);
1002 param1 = le16_to_cpu(msg.param1);
1003 param2 = le32_to_cpu(msg.param2);
1006 case RPM_CMD_VERSION:
1007 case RPM_CMD_VERSION_ACK:
1009 case RPM_CMD_CLOSE_ACK:
1010 case RPM_CMD_RX_INTENT_REQ:
1011 ret = qcom_glink_rx_defer(glink, 0);
1013 case RPM_CMD_OPEN_ACK:
1014 ret = qcom_glink_rx_open_ack(glink, param1);
1015 qcom_glink_rx_advance(glink, ALIGN(sizeof(msg), 8));
1018 ret = qcom_glink_rx_defer(glink, param2);
1020 case RPM_CMD_TX_DATA:
1021 case RPM_CMD_TX_DATA_CONT:
1022 ret = qcom_glink_rx_data(glink, avail);
1024 case RPM_CMD_READ_NOTIF:
1025 qcom_glink_rx_advance(glink, ALIGN(sizeof(msg), 8));
1027 mbox_send_message(glink->mbox_chan, NULL);
1028 mbox_client_txdone(glink->mbox_chan, 0);
1030 case RPM_CMD_INTENT:
1031 qcom_glink_handle_intent(glink, param1, param2, avail);
1033 case RPM_CMD_RX_DONE:
1034 qcom_glink_handle_rx_done(glink, param1, param2, false);
1035 qcom_glink_rx_advance(glink, ALIGN(sizeof(msg), 8));
1037 case RPM_CMD_RX_DONE_W_REUSE:
1038 qcom_glink_handle_rx_done(glink, param1, param2, true);
1039 qcom_glink_rx_advance(glink, ALIGN(sizeof(msg), 8));
1041 case RPM_CMD_RX_INTENT_REQ_ACK:
1042 qcom_glink_handle_intent_req_ack(glink, param1, param2);
1043 qcom_glink_rx_advance(glink, ALIGN(sizeof(msg), 8));
1046 dev_err(glink->dev, "unhandled rx cmd: %d\n", cmd);
1058 /* Locally initiated rpmsg_create_ept */
1059 static struct glink_channel *qcom_glink_create_local(struct qcom_glink *glink,
1062 struct glink_channel *channel;
1064 unsigned long flags;
1066 channel = qcom_glink_alloc_channel(glink, name);
1067 if (IS_ERR(channel))
1068 return ERR_CAST(channel);
1070 ret = qcom_glink_send_open_req(glink, channel);
1072 goto release_channel;
1074 ret = wait_for_completion_timeout(&channel->open_ack, 5 * HZ);
1078 ret = wait_for_completion_timeout(&channel->open_req, 5 * HZ);
1082 qcom_glink_send_open_ack(glink, channel);
1087 /* qcom_glink_send_open_req() did register the channel in lcids*/
1088 spin_lock_irqsave(&glink->idr_lock, flags);
1089 idr_remove(&glink->lcids, channel->lcid);
1090 spin_unlock_irqrestore(&glink->idr_lock, flags);
1093 /* Release qcom_glink_send_open_req() reference */
1094 kref_put(&channel->refcount, qcom_glink_channel_release);
1095 /* Release qcom_glink_alloc_channel() reference */
1096 kref_put(&channel->refcount, qcom_glink_channel_release);
1098 return ERR_PTR(-ETIMEDOUT);
1101 /* Remote initiated rpmsg_create_ept */
1102 static int qcom_glink_create_remote(struct qcom_glink *glink,
1103 struct glink_channel *channel)
1107 qcom_glink_send_open_ack(glink, channel);
1109 ret = qcom_glink_send_open_req(glink, channel);
1113 ret = wait_for_completion_timeout(&channel->open_ack, 5 * HZ);
1123 * Send a close request to "undo" our open-ack. The close-ack will
1124 * release qcom_glink_send_open_req() reference and the last reference
1125 * will be relesed after receiving remote_close or transport unregister
1126 * by calling qcom_glink_native_remove().
1128 qcom_glink_send_close_req(glink, channel);
1133 static struct rpmsg_endpoint *qcom_glink_create_ept(struct rpmsg_device *rpdev,
1136 struct rpmsg_channel_info
1139 struct glink_channel *parent = to_glink_channel(rpdev->ept);
1140 struct glink_channel *channel;
1141 struct qcom_glink *glink = parent->glink;
1142 struct rpmsg_endpoint *ept;
1143 const char *name = chinfo.name;
1146 unsigned long flags;
1148 spin_lock_irqsave(&glink->idr_lock, flags);
1149 idr_for_each_entry(&glink->rcids, channel, cid) {
1150 if (!strcmp(channel->name, name))
1153 spin_unlock_irqrestore(&glink->idr_lock, flags);
1156 channel = qcom_glink_create_local(glink, name);
1157 if (IS_ERR(channel))
1160 ret = qcom_glink_create_remote(glink, channel);
1165 ept = &channel->ept;
1169 ept->ops = &glink_endpoint_ops;
1174 static int qcom_glink_announce_create(struct rpmsg_device *rpdev)
1176 struct glink_channel *channel = to_glink_channel(rpdev->ept);
1177 struct device_node *np = rpdev->dev.of_node;
1178 struct qcom_glink *glink = channel->glink;
1179 struct glink_core_rx_intent *intent;
1180 const struct property *prop = NULL;
1181 __be32 defaults[] = { cpu_to_be32(SZ_1K), cpu_to_be32(5) };
1184 __be32 *val = defaults;
1187 if (glink->intentless || !completion_done(&channel->open_ack))
1190 prop = of_find_property(np, "qcom,intents", NULL);
1193 num_groups = prop->length / sizeof(u32) / 2;
1196 /* Channel is now open, advertise base set of intents */
1197 while (num_groups--) {
1198 size = be32_to_cpup(val++);
1199 num_intents = be32_to_cpup(val++);
1200 while (num_intents--) {
1201 intent = qcom_glink_alloc_intent(glink, channel, size,
1206 qcom_glink_advertise_intent(glink, channel, intent);
1212 static void qcom_glink_destroy_ept(struct rpmsg_endpoint *ept)
1214 struct glink_channel *channel = to_glink_channel(ept);
1215 struct qcom_glink *glink = channel->glink;
1216 unsigned long flags;
1218 spin_lock_irqsave(&channel->recv_lock, flags);
1219 channel->ept.cb = NULL;
1220 spin_unlock_irqrestore(&channel->recv_lock, flags);
1222 /* Decouple the potential rpdev from the channel */
1223 channel->rpdev = NULL;
1225 qcom_glink_send_close_req(glink, channel);
1228 static int qcom_glink_request_intent(struct qcom_glink *glink,
1229 struct glink_channel *channel,
1240 mutex_lock(&channel->intent_req_lock);
1242 reinit_completion(&channel->intent_req_comp);
1244 cmd.id = RPM_CMD_RX_INTENT_REQ;
1245 cmd.cid = channel->lcid;
1248 ret = qcom_glink_tx(glink, &cmd, sizeof(cmd), NULL, 0, true);
1252 ret = wait_for_completion_timeout(&channel->intent_req_comp, 10 * HZ);
1254 dev_err(glink->dev, "intent request timed out\n");
1257 ret = channel->intent_req_result ? 0 : -ECANCELED;
1261 mutex_unlock(&channel->intent_req_lock);
1265 static int __qcom_glink_send(struct glink_channel *channel,
1266 void *data, int len, bool wait)
1268 struct qcom_glink *glink = channel->glink;
1269 struct glink_core_rx_intent *intent = NULL;
1270 struct glink_core_rx_intent *tmp;
1273 struct glink_msg msg;
1278 unsigned long flags;
1280 if (!glink->intentless) {
1282 spin_lock_irqsave(&channel->intent_lock, flags);
1283 idr_for_each_entry(&channel->riids, tmp, iid) {
1284 if (tmp->size >= len && !tmp->in_use) {
1287 else if (intent->size > tmp->size)
1289 if (intent->size == len)
1294 intent->in_use = true;
1295 spin_unlock_irqrestore(&channel->intent_lock, flags);
1297 /* We found an available intent */
1304 ret = qcom_glink_request_intent(glink, channel, len);
1312 req.msg.cmd = cpu_to_le16(RPM_CMD_TX_DATA);
1313 req.msg.param1 = cpu_to_le16(channel->lcid);
1314 req.msg.param2 = cpu_to_le32(iid);
1315 req.chunk_size = cpu_to_le32(len);
1316 req.left_size = cpu_to_le32(0);
1318 ret = qcom_glink_tx(glink, &req, sizeof(req), data, len, wait);
1320 /* Mark intent available if we failed */
1322 intent->in_use = false;
1327 static int qcom_glink_send(struct rpmsg_endpoint *ept, void *data, int len)
1329 struct glink_channel *channel = to_glink_channel(ept);
1331 return __qcom_glink_send(channel, data, len, true);
1334 static int qcom_glink_trysend(struct rpmsg_endpoint *ept, void *data, int len)
1336 struct glink_channel *channel = to_glink_channel(ept);
1338 return __qcom_glink_send(channel, data, len, false);
1342 * Finds the device_node for the glink child interested in this channel.
1344 static struct device_node *qcom_glink_match_channel(struct device_node *node,
1345 const char *channel)
1347 struct device_node *child;
1352 for_each_available_child_of_node(node, child) {
1353 key = "qcom,glink-channels";
1354 ret = of_property_read_string(child, key, &name);
1358 if (strcmp(name, channel) == 0)
1365 static const struct rpmsg_device_ops glink_device_ops = {
1366 .create_ept = qcom_glink_create_ept,
1367 .announce_create = qcom_glink_announce_create,
1370 static const struct rpmsg_endpoint_ops glink_endpoint_ops = {
1371 .destroy_ept = qcom_glink_destroy_ept,
1372 .send = qcom_glink_send,
1373 .trysend = qcom_glink_trysend,
1376 static void qcom_glink_rpdev_release(struct device *dev)
1378 struct rpmsg_device *rpdev = to_rpmsg_device(dev);
1379 struct glink_channel *channel = to_glink_channel(rpdev->ept);
1381 channel->rpdev = NULL;
1382 kfree(rpdev->driver_override);
1386 static int qcom_glink_rx_open(struct qcom_glink *glink, unsigned int rcid,
1389 struct glink_channel *channel;
1390 struct rpmsg_device *rpdev;
1391 bool create_device = false;
1392 struct device_node *node;
1395 unsigned long flags;
1397 spin_lock_irqsave(&glink->idr_lock, flags);
1398 idr_for_each_entry(&glink->lcids, channel, lcid) {
1399 if (!strcmp(channel->name, name))
1402 spin_unlock_irqrestore(&glink->idr_lock, flags);
1405 channel = qcom_glink_alloc_channel(glink, name);
1406 if (IS_ERR(channel))
1407 return PTR_ERR(channel);
1409 /* The opening dance was initiated by the remote */
1410 create_device = true;
1413 spin_lock_irqsave(&glink->idr_lock, flags);
1414 ret = idr_alloc(&glink->rcids, channel, rcid, rcid + 1, GFP_ATOMIC);
1416 dev_err(glink->dev, "Unable to insert channel into rcid list\n");
1417 spin_unlock_irqrestore(&glink->idr_lock, flags);
1420 channel->rcid = ret;
1421 spin_unlock_irqrestore(&glink->idr_lock, flags);
1423 complete_all(&channel->open_req);
1425 if (create_device) {
1426 rpdev = kzalloc(sizeof(*rpdev), GFP_KERNEL);
1432 rpdev->ept = &channel->ept;
1433 strncpy(rpdev->id.name, name, RPMSG_NAME_SIZE);
1434 rpdev->src = RPMSG_ADDR_ANY;
1435 rpdev->dst = RPMSG_ADDR_ANY;
1436 rpdev->ops = &glink_device_ops;
1438 node = qcom_glink_match_channel(glink->dev->of_node, name);
1439 rpdev->dev.of_node = node;
1440 rpdev->dev.parent = glink->dev;
1441 rpdev->dev.release = qcom_glink_rpdev_release;
1443 ret = rpmsg_register_device(rpdev);
1447 channel->rpdev = rpdev;
1453 spin_lock_irqsave(&glink->idr_lock, flags);
1454 idr_remove(&glink->rcids, channel->rcid);
1456 spin_unlock_irqrestore(&glink->idr_lock, flags);
1458 /* Release the reference, iff we took it */
1460 kref_put(&channel->refcount, qcom_glink_channel_release);
1465 static void qcom_glink_rx_close(struct qcom_glink *glink, unsigned int rcid)
1467 struct rpmsg_channel_info chinfo;
1468 struct glink_channel *channel;
1469 unsigned long flags;
1471 spin_lock_irqsave(&glink->idr_lock, flags);
1472 channel = idr_find(&glink->rcids, rcid);
1473 spin_unlock_irqrestore(&glink->idr_lock, flags);
1474 if (WARN(!channel, "close request on unknown channel\n"))
1477 /* cancel pending rx_done work */
1478 cancel_work_sync(&channel->intent_work);
1480 if (channel->rpdev) {
1481 strscpy_pad(chinfo.name, channel->name, sizeof(chinfo.name));
1482 chinfo.src = RPMSG_ADDR_ANY;
1483 chinfo.dst = RPMSG_ADDR_ANY;
1485 rpmsg_unregister_device(glink->dev, &chinfo);
1488 qcom_glink_send_close_ack(glink, channel->rcid);
1490 spin_lock_irqsave(&glink->idr_lock, flags);
1491 idr_remove(&glink->rcids, channel->rcid);
1493 spin_unlock_irqrestore(&glink->idr_lock, flags);
1495 kref_put(&channel->refcount, qcom_glink_channel_release);
1498 static void qcom_glink_rx_close_ack(struct qcom_glink *glink, unsigned int lcid)
1500 struct glink_channel *channel;
1501 unsigned long flags;
1503 spin_lock_irqsave(&glink->idr_lock, flags);
1504 channel = idr_find(&glink->lcids, lcid);
1505 if (WARN(!channel, "close ack on unknown channel\n")) {
1506 spin_unlock_irqrestore(&glink->idr_lock, flags);
1510 idr_remove(&glink->lcids, channel->lcid);
1512 spin_unlock_irqrestore(&glink->idr_lock, flags);
1514 kref_put(&channel->refcount, qcom_glink_channel_release);
1517 static void qcom_glink_work(struct work_struct *work)
1519 struct qcom_glink *glink = container_of(work, struct qcom_glink,
1521 struct glink_defer_cmd *dcmd;
1522 struct glink_msg *msg;
1523 unsigned long flags;
1524 unsigned int param1;
1525 unsigned int param2;
1529 spin_lock_irqsave(&glink->rx_lock, flags);
1530 if (list_empty(&glink->rx_queue)) {
1531 spin_unlock_irqrestore(&glink->rx_lock, flags);
1534 dcmd = list_first_entry(&glink->rx_queue,
1535 struct glink_defer_cmd, node);
1536 list_del(&dcmd->node);
1537 spin_unlock_irqrestore(&glink->rx_lock, flags);
1540 cmd = le16_to_cpu(msg->cmd);
1541 param1 = le16_to_cpu(msg->param1);
1542 param2 = le32_to_cpu(msg->param2);
1545 case RPM_CMD_VERSION:
1546 qcom_glink_receive_version(glink, param1, param2);
1548 case RPM_CMD_VERSION_ACK:
1549 qcom_glink_receive_version_ack(glink, param1, param2);
1552 qcom_glink_rx_open(glink, param1, msg->data);
1555 qcom_glink_rx_close(glink, param1);
1557 case RPM_CMD_CLOSE_ACK:
1558 qcom_glink_rx_close_ack(glink, param1);
1560 case RPM_CMD_RX_INTENT_REQ:
1561 qcom_glink_handle_intent_req(glink, param1, param2);
1564 WARN(1, "Unknown defer object %d\n", cmd);
1572 static void qcom_glink_cancel_rx_work(struct qcom_glink *glink)
1574 struct glink_defer_cmd *dcmd;
1575 struct glink_defer_cmd *tmp;
1577 /* cancel any pending deferred rx_work */
1578 cancel_work_sync(&glink->rx_work);
1580 list_for_each_entry_safe(dcmd, tmp, &glink->rx_queue, node)
1584 static ssize_t rpmsg_name_show(struct device *dev,
1585 struct device_attribute *attr, char *buf)
1590 ret = of_property_read_string(dev->of_node, "label", &name);
1592 name = dev->of_node->name;
1594 return snprintf(buf, RPMSG_NAME_SIZE, "%s\n", name);
1596 static DEVICE_ATTR_RO(rpmsg_name);
1598 static struct attribute *qcom_glink_attrs[] = {
1599 &dev_attr_rpmsg_name.attr,
1602 ATTRIBUTE_GROUPS(qcom_glink);
1604 static void qcom_glink_device_release(struct device *dev)
1606 struct rpmsg_device *rpdev = to_rpmsg_device(dev);
1607 struct glink_channel *channel = to_glink_channel(rpdev->ept);
1609 /* Release qcom_glink_alloc_channel() reference */
1610 kref_put(&channel->refcount, qcom_glink_channel_release);
1611 kfree(rpdev->driver_override);
1615 static int qcom_glink_create_chrdev(struct qcom_glink *glink)
1617 struct rpmsg_device *rpdev;
1618 struct glink_channel *channel;
1620 rpdev = kzalloc(sizeof(*rpdev), GFP_KERNEL);
1624 channel = qcom_glink_alloc_channel(glink, "rpmsg_chrdev");
1625 if (IS_ERR(channel)) {
1627 return PTR_ERR(channel);
1629 channel->rpdev = rpdev;
1631 rpdev->ept = &channel->ept;
1632 rpdev->ops = &glink_device_ops;
1633 rpdev->dev.parent = glink->dev;
1634 rpdev->dev.release = qcom_glink_device_release;
1636 return rpmsg_chrdev_register_device(rpdev);
1639 struct qcom_glink *qcom_glink_native_probe(struct device *dev,
1640 unsigned long features,
1641 struct qcom_glink_pipe *rx,
1642 struct qcom_glink_pipe *tx,
1647 struct qcom_glink *glink;
1649 glink = devm_kzalloc(dev, sizeof(*glink), GFP_KERNEL);
1651 return ERR_PTR(-ENOMEM);
1654 glink->tx_pipe = tx;
1655 glink->rx_pipe = rx;
1657 glink->features = features;
1658 glink->intentless = intentless;
1660 spin_lock_init(&glink->tx_lock);
1661 spin_lock_init(&glink->rx_lock);
1662 INIT_LIST_HEAD(&glink->rx_queue);
1663 INIT_WORK(&glink->rx_work, qcom_glink_work);
1665 spin_lock_init(&glink->idr_lock);
1666 idr_init(&glink->lcids);
1667 idr_init(&glink->rcids);
1669 glink->dev->groups = qcom_glink_groups;
1671 ret = device_add_groups(dev, qcom_glink_groups);
1673 dev_err(dev, "failed to add groups\n");
1675 ret = of_property_read_string(dev->of_node, "label", &glink->name);
1677 glink->name = dev->of_node->name;
1679 glink->mbox_client.dev = dev;
1680 glink->mbox_client.knows_txdone = true;
1681 glink->mbox_chan = mbox_request_channel(&glink->mbox_client, 0);
1682 if (IS_ERR(glink->mbox_chan)) {
1683 if (PTR_ERR(glink->mbox_chan) != -EPROBE_DEFER)
1684 dev_err(dev, "failed to acquire IPC channel\n");
1685 return ERR_CAST(glink->mbox_chan);
1688 irq = of_irq_get(dev->of_node, 0);
1689 ret = devm_request_irq(dev, irq,
1690 qcom_glink_native_intr,
1691 IRQF_NO_SUSPEND | IRQF_SHARED,
1692 "glink-native", glink);
1694 dev_err(dev, "failed to request IRQ\n");
1695 return ERR_PTR(ret);
1700 ret = qcom_glink_send_version(glink);
1702 return ERR_PTR(ret);
1704 ret = qcom_glink_create_chrdev(glink);
1706 dev_err(glink->dev, "failed to register chrdev\n");
1710 EXPORT_SYMBOL_GPL(qcom_glink_native_probe);
1712 static int qcom_glink_remove_device(struct device *dev, void *data)
1714 device_unregister(dev);
1719 void qcom_glink_native_remove(struct qcom_glink *glink)
1721 struct glink_channel *channel;
1725 disable_irq(glink->irq);
1726 qcom_glink_cancel_rx_work(glink);
1728 ret = device_for_each_child(glink->dev, NULL, qcom_glink_remove_device);
1730 dev_warn(glink->dev, "Can't remove GLINK devices: %d\n", ret);
1732 /* Release any defunct local channels, waiting for close-ack */
1733 idr_for_each_entry(&glink->lcids, channel, cid)
1734 kref_put(&channel->refcount, qcom_glink_channel_release);
1736 /* Release any defunct local channels, waiting for close-req */
1737 idr_for_each_entry(&glink->rcids, channel, cid)
1738 kref_put(&channel->refcount, qcom_glink_channel_release);
1740 idr_destroy(&glink->lcids);
1741 idr_destroy(&glink->rcids);
1742 mbox_free_channel(glink->mbox_chan);
1744 EXPORT_SYMBOL_GPL(qcom_glink_native_remove);
1746 void qcom_glink_native_unregister(struct qcom_glink *glink)
1748 device_unregister(glink->dev);
1750 EXPORT_SYMBOL_GPL(qcom_glink_native_unregister);
1752 MODULE_DESCRIPTION("Qualcomm GLINK driver");
1753 MODULE_LICENSE("GPL v2");