2 * Copyright (c) 2016-2017, Linaro Ltd
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 and
6 * only version 2 as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
14 #include <linux/idr.h>
15 #include <linux/interrupt.h>
17 #include <linux/list.h>
18 #include <linux/mfd/syscon.h>
19 #include <linux/module.h>
21 #include <linux/of_address.h>
22 #include <linux/of_irq.h>
23 #include <linux/platform_device.h>
24 #include <linux/regmap.h>
25 #include <linux/rpmsg.h>
26 #include <linux/sizes.h>
27 #include <linux/slab.h>
28 #include <linux/workqueue.h>
29 #include <linux/mailbox_client.h>
31 #include "rpmsg_internal.h"
32 #include "qcom_glink_native.h"
34 #define GLINK_NAME_SIZE 32
35 #define GLINK_VERSION_1 1
37 #define RPM_GLINK_CID_MIN 1
38 #define RPM_GLINK_CID_MAX 65536
48 * struct glink_defer_cmd - deferred incoming control message
50 * @msg: message header
51 * data: payload of the message
53 * Copy of a received control message, to be added to @rx_queue and processed
54 * by @rx_work of @qcom_glink.
56 struct glink_defer_cmd {
57 struct list_head node;
64 * struct glink_core_rx_intent - RX intent
67 * data: pointer to the data (may be NULL for zero-copy)
68 * id: remote or local intent ID
69 * size: size of the original intent (do not modify)
70 * reuse: To mark if the intent can be reused after first use
71 * in_use: To mark if intent is already in use for the channel
72 * offset: next write offset (initially 0)
74 struct glink_core_rx_intent {
82 struct list_head node;
86 * struct qcom_glink - driver context, relates to one remote subsystem
87 * @dev: reference to the associated struct device
88 * @mbox_client: mailbox client
89 * @mbox_chan: mailbox channel
90 * @rx_pipe: pipe object for receive FIFO
91 * @tx_pipe: pipe object for transmit FIFO
92 * @irq: IRQ for signaling incoming events
93 * @rx_work: worker for handling received control messages
94 * @rx_lock: protects the @rx_queue
95 * @rx_queue: queue of received control messages to be processed in @rx_work
96 * @tx_lock: synchronizes operations on the tx fifo
97 * @idr_lock: synchronizes @lcids and @rcids modifications
98 * @lcids: idr of all channels with a known local channel id
99 * @rcids: idr of all channels with a known remote channel id
104 struct mbox_client mbox_client;
105 struct mbox_chan *mbox_chan;
107 struct qcom_glink_pipe *rx_pipe;
108 struct qcom_glink_pipe *tx_pipe;
112 struct work_struct rx_work;
114 struct list_head rx_queue;
121 unsigned long features;
134 * struct glink_channel - internal representation of a channel
135 * @rpdev: rpdev reference, only used for primary endpoints
136 * @ept: rpmsg endpoint this channel is associated with
137 * @glink: qcom_glink context handle
138 * @refcount: refcount for the channel object
139 * @recv_lock: guard for @ept.cb
140 * @name: unique channel name/identifier
141 * @lcid: channel id, in local space
142 * @rcid: channel id, in remote space
143 * @intent_lock: lock for protection of @liids, @riids
144 * @liids: idr of all local intents
145 * @riids: idr of all remote intents
146 * @intent_work: worker responsible for transmitting rx_done packets
147 * @done_intents: list of intents that needs to be announced rx_done
148 * @buf: receive buffer, for gathering fragments
149 * @buf_offset: write offset in @buf
150 * @buf_size: size of current @buf
151 * @open_ack: completed once remote has acked the open-request
152 * @open_req: completed once open-request has been received
153 * @intent_req_lock: Synchronises multiple intent requests
154 * @intent_req_result: Result of intent request
155 * @intent_req_comp: Completion for intent_req signalling
157 struct glink_channel {
158 struct rpmsg_endpoint ept;
160 struct rpmsg_device *rpdev;
161 struct qcom_glink *glink;
163 struct kref refcount;
165 spinlock_t recv_lock;
171 spinlock_t intent_lock;
174 struct work_struct intent_work;
175 struct list_head done_intents;
177 struct glink_core_rx_intent *buf;
181 struct completion open_ack;
182 struct completion open_req;
184 struct mutex intent_req_lock;
185 bool intent_req_result;
186 struct completion intent_req_comp;
189 #define to_glink_channel(_ept) container_of(_ept, struct glink_channel, ept)
191 static const struct rpmsg_endpoint_ops glink_endpoint_ops;
193 #define RPM_CMD_VERSION 0
194 #define RPM_CMD_VERSION_ACK 1
195 #define RPM_CMD_OPEN 2
196 #define RPM_CMD_CLOSE 3
197 #define RPM_CMD_OPEN_ACK 4
198 #define RPM_CMD_INTENT 5
199 #define RPM_CMD_RX_DONE 6
200 #define RPM_CMD_RX_INTENT_REQ 7
201 #define RPM_CMD_RX_INTENT_REQ_ACK 8
202 #define RPM_CMD_TX_DATA 9
203 #define RPM_CMD_CLOSE_ACK 11
204 #define RPM_CMD_TX_DATA_CONT 12
205 #define RPM_CMD_READ_NOTIF 13
206 #define RPM_CMD_RX_DONE_W_REUSE 14
208 #define GLINK_FEATURE_INTENTLESS BIT(1)
210 static void qcom_glink_rx_done_work(struct work_struct *work);
212 static struct glink_channel *qcom_glink_alloc_channel(struct qcom_glink *glink,
215 struct glink_channel *channel;
217 channel = kzalloc(sizeof(*channel), GFP_KERNEL);
219 return ERR_PTR(-ENOMEM);
221 /* Setup glink internal glink_channel data */
222 spin_lock_init(&channel->recv_lock);
223 spin_lock_init(&channel->intent_lock);
224 mutex_init(&channel->intent_req_lock);
226 channel->glink = glink;
227 channel->name = kstrdup(name, GFP_KERNEL);
229 init_completion(&channel->open_req);
230 init_completion(&channel->open_ack);
231 init_completion(&channel->intent_req_comp);
233 INIT_LIST_HEAD(&channel->done_intents);
234 INIT_WORK(&channel->intent_work, qcom_glink_rx_done_work);
236 idr_init(&channel->liids);
237 idr_init(&channel->riids);
238 kref_init(&channel->refcount);
243 static void qcom_glink_channel_release(struct kref *ref)
245 struct glink_channel *channel = container_of(ref, struct glink_channel,
249 spin_lock_irqsave(&channel->intent_lock, flags);
250 idr_destroy(&channel->liids);
251 idr_destroy(&channel->riids);
252 spin_unlock_irqrestore(&channel->intent_lock, flags);
254 kfree(channel->name);
258 static size_t qcom_glink_rx_avail(struct qcom_glink *glink)
260 return glink->rx_pipe->avail(glink->rx_pipe);
263 static void qcom_glink_rx_peak(struct qcom_glink *glink,
264 void *data, unsigned int offset, size_t count)
266 glink->rx_pipe->peak(glink->rx_pipe, data, offset, count);
269 static void qcom_glink_rx_advance(struct qcom_glink *glink, size_t count)
271 glink->rx_pipe->advance(glink->rx_pipe, count);
274 static size_t qcom_glink_tx_avail(struct qcom_glink *glink)
276 return glink->tx_pipe->avail(glink->tx_pipe);
279 static void qcom_glink_tx_write(struct qcom_glink *glink,
280 const void *hdr, size_t hlen,
281 const void *data, size_t dlen)
283 glink->tx_pipe->write(glink->tx_pipe, hdr, hlen, data, dlen);
286 static int qcom_glink_tx(struct qcom_glink *glink,
287 const void *hdr, size_t hlen,
288 const void *data, size_t dlen, bool wait)
290 unsigned int tlen = hlen + dlen;
294 /* Reject packets that are too big */
295 if (tlen >= glink->tx_pipe->length)
298 spin_lock_irqsave(&glink->tx_lock, flags);
300 while (qcom_glink_tx_avail(glink) < tlen) {
306 /* Wait without holding the tx_lock */
307 spin_unlock_irqrestore(&glink->tx_lock, flags);
309 usleep_range(10000, 15000);
311 spin_lock_irqsave(&glink->tx_lock, flags);
314 qcom_glink_tx_write(glink, hdr, hlen, data, dlen);
316 mbox_send_message(glink->mbox_chan, NULL);
317 mbox_client_txdone(glink->mbox_chan, 0);
320 spin_unlock_irqrestore(&glink->tx_lock, flags);
325 static int qcom_glink_send_version(struct qcom_glink *glink)
327 struct glink_msg msg;
329 msg.cmd = cpu_to_le16(RPM_CMD_VERSION);
330 msg.param1 = cpu_to_le16(GLINK_VERSION_1);
331 msg.param2 = cpu_to_le32(glink->features);
333 return qcom_glink_tx(glink, &msg, sizeof(msg), NULL, 0, true);
336 static void qcom_glink_send_version_ack(struct qcom_glink *glink)
338 struct glink_msg msg;
340 msg.cmd = cpu_to_le16(RPM_CMD_VERSION_ACK);
341 msg.param1 = cpu_to_le16(GLINK_VERSION_1);
342 msg.param2 = cpu_to_le32(glink->features);
344 qcom_glink_tx(glink, &msg, sizeof(msg), NULL, 0, true);
347 static void qcom_glink_send_open_ack(struct qcom_glink *glink,
348 struct glink_channel *channel)
350 struct glink_msg msg;
352 msg.cmd = cpu_to_le16(RPM_CMD_OPEN_ACK);
353 msg.param1 = cpu_to_le16(channel->rcid);
354 msg.param2 = cpu_to_le32(0);
356 qcom_glink_tx(glink, &msg, sizeof(msg), NULL, 0, true);
359 static void qcom_glink_handle_intent_req_ack(struct qcom_glink *glink,
360 unsigned int cid, bool granted)
362 struct glink_channel *channel;
365 spin_lock_irqsave(&glink->idr_lock, flags);
366 channel = idr_find(&glink->rcids, cid);
367 spin_unlock_irqrestore(&glink->idr_lock, flags);
369 dev_err(glink->dev, "unable to find channel\n");
373 channel->intent_req_result = granted;
374 complete(&channel->intent_req_comp);
378 * qcom_glink_send_open_req() - send a RPM_CMD_OPEN request to the remote
379 * @glink: Ptr to the glink edge
380 * @channel: Ptr to the channel that the open req is sent
382 * Allocates a local channel id and sends a RPM_CMD_OPEN message to the remote.
383 * Will return with refcount held, regardless of outcome.
385 * Returns 0 on success, negative errno otherwise.
387 static int qcom_glink_send_open_req(struct qcom_glink *glink,
388 struct glink_channel *channel)
391 struct glink_msg msg;
392 u8 name[GLINK_NAME_SIZE];
394 int name_len = strlen(channel->name) + 1;
395 int req_len = ALIGN(sizeof(req.msg) + name_len, 8);
399 kref_get(&channel->refcount);
401 spin_lock_irqsave(&glink->idr_lock, flags);
402 ret = idr_alloc_cyclic(&glink->lcids, channel,
403 RPM_GLINK_CID_MIN, RPM_GLINK_CID_MAX,
405 spin_unlock_irqrestore(&glink->idr_lock, flags);
411 req.msg.cmd = cpu_to_le16(RPM_CMD_OPEN);
412 req.msg.param1 = cpu_to_le16(channel->lcid);
413 req.msg.param2 = cpu_to_le32(name_len);
414 strcpy(req.name, channel->name);
416 ret = qcom_glink_tx(glink, &req, req_len, NULL, 0, true);
423 spin_lock_irqsave(&glink->idr_lock, flags);
424 idr_remove(&glink->lcids, channel->lcid);
426 spin_unlock_irqrestore(&glink->idr_lock, flags);
431 static void qcom_glink_send_close_req(struct qcom_glink *glink,
432 struct glink_channel *channel)
434 struct glink_msg req;
436 req.cmd = cpu_to_le16(RPM_CMD_CLOSE);
437 req.param1 = cpu_to_le16(channel->lcid);
440 qcom_glink_tx(glink, &req, sizeof(req), NULL, 0, true);
443 static void qcom_glink_send_close_ack(struct qcom_glink *glink,
446 struct glink_msg req;
448 req.cmd = cpu_to_le16(RPM_CMD_CLOSE_ACK);
449 req.param1 = cpu_to_le16(rcid);
452 qcom_glink_tx(glink, &req, sizeof(req), NULL, 0, true);
455 static void qcom_glink_rx_done_work(struct work_struct *work)
457 struct glink_channel *channel = container_of(work, struct glink_channel,
459 struct qcom_glink *glink = channel->glink;
460 struct glink_core_rx_intent *intent, *tmp;
467 unsigned int cid = channel->lcid;
472 spin_lock_irqsave(&channel->intent_lock, flags);
473 list_for_each_entry_safe(intent, tmp, &channel->done_intents, node) {
474 list_del(&intent->node);
475 spin_unlock_irqrestore(&channel->intent_lock, flags);
477 reuse = intent->reuse;
479 cmd.id = reuse ? RPM_CMD_RX_DONE_W_REUSE : RPM_CMD_RX_DONE;
483 qcom_glink_tx(glink, &cmd, sizeof(cmd), NULL, 0, true);
488 spin_lock_irqsave(&channel->intent_lock, flags);
490 spin_unlock_irqrestore(&channel->intent_lock, flags);
493 static void qcom_glink_rx_done(struct qcom_glink *glink,
494 struct glink_channel *channel,
495 struct glink_core_rx_intent *intent)
497 /* We don't send RX_DONE to intentless systems */
498 if (glink->intentless) {
504 /* Take it off the tree of receive intents */
505 if (!intent->reuse) {
506 spin_lock(&channel->intent_lock);
507 idr_remove(&channel->liids, intent->id);
508 spin_unlock(&channel->intent_lock);
511 /* Schedule the sending of a rx_done indication */
512 spin_lock(&channel->intent_lock);
513 list_add_tail(&intent->node, &channel->done_intents);
514 spin_unlock(&channel->intent_lock);
516 schedule_work(&channel->intent_work);
520 * qcom_glink_receive_version() - receive version/features from remote system
522 * @glink: pointer to transport interface
523 * @r_version: remote version
524 * @r_features: remote features
526 * This function is called in response to a remote-initiated version/feature
527 * negotiation sequence.
529 static void qcom_glink_receive_version(struct qcom_glink *glink,
536 case GLINK_VERSION_1:
537 glink->features &= features;
540 qcom_glink_send_version_ack(glink);
546 * qcom_glink_receive_version_ack() - receive negotiation ack from remote system
548 * @glink: pointer to transport interface
549 * @r_version: remote version response
550 * @r_features: remote features response
552 * This function is called in response to a local-initiated version/feature
553 * negotiation sequence and is the counter-offer from the remote side based
554 * upon the initial version and feature set requested.
556 static void qcom_glink_receive_version_ack(struct qcom_glink *glink,
562 /* Version negotiation failed */
564 case GLINK_VERSION_1:
565 if (features == glink->features)
568 glink->features &= features;
571 qcom_glink_send_version(glink);
577 * qcom_glink_send_intent_req_ack() - convert an rx intent request ack cmd to
578 wire format and transmit
579 * @glink: The transport to transmit on.
580 * @channel: The glink channel
581 * @granted: The request response to encode.
583 * Return: 0 on success or standard Linux error code.
585 static int qcom_glink_send_intent_req_ack(struct qcom_glink *glink,
586 struct glink_channel *channel,
589 struct glink_msg msg;
591 msg.cmd = cpu_to_le16(RPM_CMD_RX_INTENT_REQ_ACK);
592 msg.param1 = cpu_to_le16(channel->lcid);
593 msg.param2 = cpu_to_le32(granted);
595 qcom_glink_tx(glink, &msg, sizeof(msg), NULL, 0, true);
601 * qcom_glink_advertise_intent - convert an rx intent cmd to wire format and
603 * @glink: The transport to transmit on.
604 * @channel: The local channel
605 * @size: The intent to pass on to remote.
607 * Return: 0 on success or standard Linux error code.
609 static int qcom_glink_advertise_intent(struct qcom_glink *glink,
610 struct glink_channel *channel,
611 struct glink_core_rx_intent *intent)
622 cmd.id = cpu_to_le16(RPM_CMD_INTENT);
623 cmd.lcid = cpu_to_le16(channel->lcid);
624 cmd.count = cpu_to_le32(1);
625 cmd.size = cpu_to_le32(intent->size);
626 cmd.liid = cpu_to_le32(intent->id);
628 qcom_glink_tx(glink, &cmd, sizeof(cmd), NULL, 0, true);
633 static struct glink_core_rx_intent *
634 qcom_glink_alloc_intent(struct qcom_glink *glink,
635 struct glink_channel *channel,
639 struct glink_core_rx_intent *intent;
643 intent = kzalloc(sizeof(*intent), GFP_KERNEL);
647 intent->data = kzalloc(size, GFP_KERNEL);
651 spin_lock_irqsave(&channel->intent_lock, flags);
652 ret = idr_alloc_cyclic(&channel->liids, intent, 1, -1, GFP_ATOMIC);
654 spin_unlock_irqrestore(&channel->intent_lock, flags);
657 spin_unlock_irqrestore(&channel->intent_lock, flags);
661 intent->reuse = reuseable;
672 static void qcom_glink_handle_rx_done(struct qcom_glink *glink,
673 u32 cid, uint32_t iid,
676 struct glink_core_rx_intent *intent;
677 struct glink_channel *channel;
680 spin_lock_irqsave(&glink->idr_lock, flags);
681 channel = idr_find(&glink->rcids, cid);
682 spin_unlock_irqrestore(&glink->idr_lock, flags);
684 dev_err(glink->dev, "invalid channel id received\n");
688 spin_lock_irqsave(&channel->intent_lock, flags);
689 intent = idr_find(&channel->riids, iid);
692 spin_unlock_irqrestore(&channel->intent_lock, flags);
693 dev_err(glink->dev, "invalid intent id received\n");
697 intent->in_use = false;
700 idr_remove(&channel->riids, intent->id);
703 spin_unlock_irqrestore(&channel->intent_lock, flags);
707 * qcom_glink_handle_intent_req() - Receive a request for rx_intent
709 * if_ptr: Pointer to the transport interface
710 * rcid: Remote channel ID
711 * size: size of the intent
713 * The function searches for the local channel to which the request for
714 * rx_intent has arrived and allocates and notifies the remote back
716 static void qcom_glink_handle_intent_req(struct qcom_glink *glink,
717 u32 cid, size_t size)
719 struct glink_core_rx_intent *intent;
720 struct glink_channel *channel;
723 spin_lock_irqsave(&glink->idr_lock, flags);
724 channel = idr_find(&glink->rcids, cid);
725 spin_unlock_irqrestore(&glink->idr_lock, flags);
728 pr_err("%s channel not found for cid %d\n", __func__, cid);
732 intent = qcom_glink_alloc_intent(glink, channel, size, false);
734 qcom_glink_advertise_intent(glink, channel, intent);
736 qcom_glink_send_intent_req_ack(glink, channel, !!intent);
739 static int qcom_glink_rx_defer(struct qcom_glink *glink, size_t extra)
741 struct glink_defer_cmd *dcmd;
743 extra = ALIGN(extra, 8);
745 if (qcom_glink_rx_avail(glink) < sizeof(struct glink_msg) + extra) {
746 dev_dbg(glink->dev, "Insufficient data in rx fifo");
750 dcmd = kzalloc(sizeof(*dcmd) + extra, GFP_ATOMIC);
754 INIT_LIST_HEAD(&dcmd->node);
756 qcom_glink_rx_peak(glink, &dcmd->msg, 0, sizeof(dcmd->msg) + extra);
758 spin_lock(&glink->rx_lock);
759 list_add_tail(&dcmd->node, &glink->rx_queue);
760 spin_unlock(&glink->rx_lock);
762 schedule_work(&glink->rx_work);
763 qcom_glink_rx_advance(glink, sizeof(dcmd->msg) + extra);
768 static int qcom_glink_rx_data(struct qcom_glink *glink, size_t avail)
770 struct glink_core_rx_intent *intent;
771 struct glink_channel *channel;
773 struct glink_msg msg;
777 unsigned int chunk_size;
778 unsigned int left_size;
784 if (avail < sizeof(hdr)) {
785 dev_dbg(glink->dev, "Not enough data in fifo\n");
789 qcom_glink_rx_peak(glink, &hdr, 0, sizeof(hdr));
790 chunk_size = le32_to_cpu(hdr.chunk_size);
791 left_size = le32_to_cpu(hdr.left_size);
793 if (avail < sizeof(hdr) + chunk_size) {
794 dev_dbg(glink->dev, "Payload not yet in fifo\n");
798 if (WARN(chunk_size % 4, "Incoming data must be word aligned\n"))
801 rcid = le16_to_cpu(hdr.msg.param1);
802 spin_lock_irqsave(&glink->idr_lock, flags);
803 channel = idr_find(&glink->rcids, rcid);
804 spin_unlock_irqrestore(&glink->idr_lock, flags);
806 dev_dbg(glink->dev, "Data on non-existing channel\n");
808 /* Drop the message */
812 if (glink->intentless) {
813 /* Might have an ongoing, fragmented, message to append */
815 intent = kzalloc(sizeof(*intent), GFP_ATOMIC);
819 intent->data = kmalloc(chunk_size + left_size,
826 intent->id = 0xbabababa;
827 intent->size = chunk_size + left_size;
830 channel->buf = intent;
832 intent = channel->buf;
835 liid = le32_to_cpu(hdr.msg.param2);
837 spin_lock_irqsave(&channel->intent_lock, flags);
838 intent = idr_find(&channel->liids, liid);
839 spin_unlock_irqrestore(&channel->intent_lock, flags);
843 "no intent found for channel %s intent %d",
844 channel->name, liid);
849 if (intent->size - intent->offset < chunk_size) {
850 dev_err(glink->dev, "Insufficient space in intent\n");
852 /* The packet header lied, drop payload */
856 qcom_glink_rx_peak(glink, intent->data + intent->offset,
857 sizeof(hdr), chunk_size);
858 intent->offset += chunk_size;
860 /* Handle message when no fragments remain to be received */
862 spin_lock(&channel->recv_lock);
863 if (channel->ept.cb) {
864 channel->ept.cb(channel->ept.rpdev,
870 spin_unlock(&channel->recv_lock);
875 qcom_glink_rx_done(glink, channel, intent);
879 qcom_glink_rx_advance(glink, ALIGN(sizeof(hdr) + chunk_size, 8));
884 static void qcom_glink_handle_intent(struct qcom_glink *glink,
889 struct glink_core_rx_intent *intent;
890 struct glink_channel *channel;
897 struct glink_msg msg;
898 struct intent_pair intents[];
901 const size_t msglen = sizeof(*msg) + sizeof(struct intent_pair) * count;
906 if (avail < msglen) {
907 dev_dbg(glink->dev, "Not enough data in fifo\n");
911 spin_lock_irqsave(&glink->idr_lock, flags);
912 channel = idr_find(&glink->rcids, cid);
913 spin_unlock_irqrestore(&glink->idr_lock, flags);
915 dev_err(glink->dev, "intents for non-existing channel\n");
919 msg = kmalloc(msglen, GFP_ATOMIC);
923 qcom_glink_rx_peak(glink, msg, 0, msglen);
925 for (i = 0; i < count; ++i) {
926 intent = kzalloc(sizeof(*intent), GFP_ATOMIC);
930 intent->id = le32_to_cpu(msg->intents[i].iid);
931 intent->size = le32_to_cpu(msg->intents[i].size);
933 spin_lock_irqsave(&channel->intent_lock, flags);
934 ret = idr_alloc(&channel->riids, intent,
935 intent->id, intent->id + 1, GFP_ATOMIC);
936 spin_unlock_irqrestore(&channel->intent_lock, flags);
939 dev_err(glink->dev, "failed to store remote intent\n");
943 qcom_glink_rx_advance(glink, ALIGN(msglen, 8));
946 static int qcom_glink_rx_open_ack(struct qcom_glink *glink, unsigned int lcid)
948 struct glink_channel *channel;
950 spin_lock(&glink->idr_lock);
951 channel = idr_find(&glink->lcids, lcid);
952 spin_unlock(&glink->idr_lock);
954 dev_err(glink->dev, "Invalid open ack packet\n");
958 complete(&channel->open_ack);
963 static irqreturn_t qcom_glink_native_intr(int irq, void *data)
965 struct qcom_glink *glink = data;
966 struct glink_msg msg;
974 avail = qcom_glink_rx_avail(glink);
975 if (avail < sizeof(msg))
978 qcom_glink_rx_peak(glink, &msg, 0, sizeof(msg));
980 cmd = le16_to_cpu(msg.cmd);
981 param1 = le16_to_cpu(msg.param1);
982 param2 = le32_to_cpu(msg.param2);
985 case RPM_CMD_VERSION:
986 case RPM_CMD_VERSION_ACK:
988 case RPM_CMD_CLOSE_ACK:
989 case RPM_CMD_RX_INTENT_REQ:
990 ret = qcom_glink_rx_defer(glink, 0);
992 case RPM_CMD_OPEN_ACK:
993 ret = qcom_glink_rx_open_ack(glink, param1);
994 qcom_glink_rx_advance(glink, ALIGN(sizeof(msg), 8));
997 ret = qcom_glink_rx_defer(glink, param2);
999 case RPM_CMD_TX_DATA:
1000 case RPM_CMD_TX_DATA_CONT:
1001 ret = qcom_glink_rx_data(glink, avail);
1003 case RPM_CMD_READ_NOTIF:
1004 qcom_glink_rx_advance(glink, ALIGN(sizeof(msg), 8));
1006 mbox_send_message(glink->mbox_chan, NULL);
1007 mbox_client_txdone(glink->mbox_chan, 0);
1009 case RPM_CMD_INTENT:
1010 qcom_glink_handle_intent(glink, param1, param2, avail);
1012 case RPM_CMD_RX_DONE:
1013 qcom_glink_handle_rx_done(glink, param1, param2, false);
1014 qcom_glink_rx_advance(glink, ALIGN(sizeof(msg), 8));
1016 case RPM_CMD_RX_DONE_W_REUSE:
1017 qcom_glink_handle_rx_done(glink, param1, param2, true);
1018 qcom_glink_rx_advance(glink, ALIGN(sizeof(msg), 8));
1020 case RPM_CMD_RX_INTENT_REQ_ACK:
1021 qcom_glink_handle_intent_req_ack(glink, param1, param2);
1022 qcom_glink_rx_advance(glink, ALIGN(sizeof(msg), 8));
1025 dev_err(glink->dev, "unhandled rx cmd: %d\n", cmd);
1037 /* Locally initiated rpmsg_create_ept */
1038 static struct glink_channel *qcom_glink_create_local(struct qcom_glink *glink,
1041 struct glink_channel *channel;
1043 unsigned long flags;
1045 channel = qcom_glink_alloc_channel(glink, name);
1046 if (IS_ERR(channel))
1047 return ERR_CAST(channel);
1049 ret = qcom_glink_send_open_req(glink, channel);
1051 goto release_channel;
1053 ret = wait_for_completion_timeout(&channel->open_ack, 5 * HZ);
1057 ret = wait_for_completion_timeout(&channel->open_req, 5 * HZ);
1061 qcom_glink_send_open_ack(glink, channel);
1066 /* qcom_glink_send_open_req() did register the channel in lcids*/
1067 spin_lock_irqsave(&glink->idr_lock, flags);
1068 idr_remove(&glink->lcids, channel->lcid);
1069 spin_unlock_irqrestore(&glink->idr_lock, flags);
1072 /* Release qcom_glink_send_open_req() reference */
1073 kref_put(&channel->refcount, qcom_glink_channel_release);
1074 /* Release qcom_glink_alloc_channel() reference */
1075 kref_put(&channel->refcount, qcom_glink_channel_release);
1077 return ERR_PTR(-ETIMEDOUT);
1080 /* Remote initiated rpmsg_create_ept */
1081 static int qcom_glink_create_remote(struct qcom_glink *glink,
1082 struct glink_channel *channel)
1086 qcom_glink_send_open_ack(glink, channel);
1088 ret = qcom_glink_send_open_req(glink, channel);
1092 ret = wait_for_completion_timeout(&channel->open_ack, 5 * HZ);
1102 * Send a close request to "undo" our open-ack. The close-ack will
1103 * release the last reference.
1105 qcom_glink_send_close_req(glink, channel);
1107 /* Release qcom_glink_send_open_req() reference */
1108 kref_put(&channel->refcount, qcom_glink_channel_release);
1113 static struct rpmsg_endpoint *qcom_glink_create_ept(struct rpmsg_device *rpdev,
1116 struct rpmsg_channel_info
1119 struct glink_channel *parent = to_glink_channel(rpdev->ept);
1120 struct glink_channel *channel;
1121 struct qcom_glink *glink = parent->glink;
1122 struct rpmsg_endpoint *ept;
1123 const char *name = chinfo.name;
1126 unsigned long flags;
1128 spin_lock_irqsave(&glink->idr_lock, flags);
1129 idr_for_each_entry(&glink->rcids, channel, cid) {
1130 if (!strcmp(channel->name, name))
1133 spin_unlock_irqrestore(&glink->idr_lock, flags);
1136 channel = qcom_glink_create_local(glink, name);
1137 if (IS_ERR(channel))
1140 ret = qcom_glink_create_remote(glink, channel);
1145 ept = &channel->ept;
1149 ept->ops = &glink_endpoint_ops;
1154 static int qcom_glink_announce_create(struct rpmsg_device *rpdev)
1156 struct glink_channel *channel = to_glink_channel(rpdev->ept);
1157 struct device_node *np = rpdev->dev.of_node;
1158 struct qcom_glink *glink = channel->glink;
1159 struct glink_core_rx_intent *intent;
1160 const struct property *prop = NULL;
1161 __be32 defaults[] = { cpu_to_be32(SZ_1K), cpu_to_be32(5) };
1164 __be32 *val = defaults;
1167 if (glink->intentless)
1170 prop = of_find_property(np, "qcom,intents", NULL);
1173 num_groups = prop->length / sizeof(u32) / 2;
1176 /* Channel is now open, advertise base set of intents */
1177 while (num_groups--) {
1178 size = be32_to_cpup(val++);
1179 num_intents = be32_to_cpup(val++);
1180 while (num_intents--) {
1181 intent = qcom_glink_alloc_intent(glink, channel, size,
1186 qcom_glink_advertise_intent(glink, channel, intent);
1192 static void qcom_glink_destroy_ept(struct rpmsg_endpoint *ept)
1194 struct glink_channel *channel = to_glink_channel(ept);
1195 struct qcom_glink *glink = channel->glink;
1196 unsigned long flags;
1198 spin_lock_irqsave(&channel->recv_lock, flags);
1199 channel->ept.cb = NULL;
1200 spin_unlock_irqrestore(&channel->recv_lock, flags);
1202 /* Decouple the potential rpdev from the channel */
1203 channel->rpdev = NULL;
1205 qcom_glink_send_close_req(glink, channel);
1208 static int qcom_glink_request_intent(struct qcom_glink *glink,
1209 struct glink_channel *channel,
1220 mutex_lock(&channel->intent_req_lock);
1222 reinit_completion(&channel->intent_req_comp);
1224 cmd.id = RPM_CMD_RX_INTENT_REQ;
1225 cmd.cid = channel->lcid;
1228 ret = qcom_glink_tx(glink, &cmd, sizeof(cmd), NULL, 0, true);
1232 ret = wait_for_completion_timeout(&channel->intent_req_comp, 10 * HZ);
1234 dev_err(glink->dev, "intent request timed out\n");
1237 ret = channel->intent_req_result ? 0 : -ECANCELED;
1241 mutex_unlock(&channel->intent_req_lock);
1245 static int __qcom_glink_send(struct glink_channel *channel,
1246 void *data, int len, bool wait)
1248 struct qcom_glink *glink = channel->glink;
1249 struct glink_core_rx_intent *intent = NULL;
1250 struct glink_core_rx_intent *tmp;
1253 struct glink_msg msg;
1258 unsigned long flags;
1260 if (!glink->intentless) {
1262 spin_lock_irqsave(&channel->intent_lock, flags);
1263 idr_for_each_entry(&channel->riids, tmp, iid) {
1264 if (tmp->size >= len && !tmp->in_use) {
1267 else if (intent->size > tmp->size)
1269 if (intent->size == len)
1274 intent->in_use = true;
1275 spin_unlock_irqrestore(&channel->intent_lock, flags);
1277 /* We found an available intent */
1284 ret = qcom_glink_request_intent(glink, channel, len);
1292 req.msg.cmd = cpu_to_le16(RPM_CMD_TX_DATA);
1293 req.msg.param1 = cpu_to_le16(channel->lcid);
1294 req.msg.param2 = cpu_to_le32(iid);
1295 req.chunk_size = cpu_to_le32(len);
1296 req.left_size = cpu_to_le32(0);
1298 ret = qcom_glink_tx(glink, &req, sizeof(req), data, len, wait);
1300 /* Mark intent available if we failed */
1302 intent->in_use = false;
1307 static int qcom_glink_send(struct rpmsg_endpoint *ept, void *data, int len)
1309 struct glink_channel *channel = to_glink_channel(ept);
1311 return __qcom_glink_send(channel, data, len, true);
1314 static int qcom_glink_trysend(struct rpmsg_endpoint *ept, void *data, int len)
1316 struct glink_channel *channel = to_glink_channel(ept);
1318 return __qcom_glink_send(channel, data, len, false);
1322 * Finds the device_node for the glink child interested in this channel.
1324 static struct device_node *qcom_glink_match_channel(struct device_node *node,
1325 const char *channel)
1327 struct device_node *child;
1332 for_each_available_child_of_node(node, child) {
1333 key = "qcom,glink-channels";
1334 ret = of_property_read_string(child, key, &name);
1338 if (strcmp(name, channel) == 0)
1345 static const struct rpmsg_device_ops glink_device_ops = {
1346 .create_ept = qcom_glink_create_ept,
1347 .announce_create = qcom_glink_announce_create,
1350 static const struct rpmsg_endpoint_ops glink_endpoint_ops = {
1351 .destroy_ept = qcom_glink_destroy_ept,
1352 .send = qcom_glink_send,
1353 .trysend = qcom_glink_trysend,
1356 static void qcom_glink_rpdev_release(struct device *dev)
1358 struct rpmsg_device *rpdev = to_rpmsg_device(dev);
1359 struct glink_channel *channel = to_glink_channel(rpdev->ept);
1361 channel->rpdev = NULL;
1365 static int qcom_glink_rx_open(struct qcom_glink *glink, unsigned int rcid,
1368 struct glink_channel *channel;
1369 struct rpmsg_device *rpdev;
1370 bool create_device = false;
1371 struct device_node *node;
1374 unsigned long flags;
1376 spin_lock_irqsave(&glink->idr_lock, flags);
1377 idr_for_each_entry(&glink->lcids, channel, lcid) {
1378 if (!strcmp(channel->name, name))
1381 spin_unlock_irqrestore(&glink->idr_lock, flags);
1384 channel = qcom_glink_alloc_channel(glink, name);
1385 if (IS_ERR(channel))
1386 return PTR_ERR(channel);
1388 /* The opening dance was initiated by the remote */
1389 create_device = true;
1392 spin_lock_irqsave(&glink->idr_lock, flags);
1393 ret = idr_alloc(&glink->rcids, channel, rcid, rcid + 1, GFP_ATOMIC);
1395 dev_err(glink->dev, "Unable to insert channel into rcid list\n");
1396 spin_unlock_irqrestore(&glink->idr_lock, flags);
1399 channel->rcid = ret;
1400 spin_unlock_irqrestore(&glink->idr_lock, flags);
1402 complete(&channel->open_req);
1404 if (create_device) {
1405 rpdev = kzalloc(sizeof(*rpdev), GFP_KERNEL);
1411 rpdev->ept = &channel->ept;
1412 strncpy(rpdev->id.name, name, RPMSG_NAME_SIZE);
1413 rpdev->src = RPMSG_ADDR_ANY;
1414 rpdev->dst = RPMSG_ADDR_ANY;
1415 rpdev->ops = &glink_device_ops;
1417 node = qcom_glink_match_channel(glink->dev->of_node, name);
1418 rpdev->dev.of_node = node;
1419 rpdev->dev.parent = glink->dev;
1420 rpdev->dev.release = qcom_glink_rpdev_release;
1422 ret = rpmsg_register_device(rpdev);
1426 channel->rpdev = rpdev;
1434 spin_lock_irqsave(&glink->idr_lock, flags);
1435 idr_remove(&glink->rcids, channel->rcid);
1437 spin_unlock_irqrestore(&glink->idr_lock, flags);
1439 /* Release the reference, iff we took it */
1441 kref_put(&channel->refcount, qcom_glink_channel_release);
1446 static void qcom_glink_rx_close(struct qcom_glink *glink, unsigned int rcid)
1448 struct rpmsg_channel_info chinfo;
1449 struct glink_channel *channel;
1450 unsigned long flags;
1452 spin_lock_irqsave(&glink->idr_lock, flags);
1453 channel = idr_find(&glink->rcids, rcid);
1454 spin_unlock_irqrestore(&glink->idr_lock, flags);
1455 if (WARN(!channel, "close request on unknown channel\n"))
1458 /* cancel pending rx_done work */
1459 cancel_work_sync(&channel->intent_work);
1461 if (channel->rpdev) {
1462 strncpy(chinfo.name, channel->name, sizeof(chinfo.name));
1463 chinfo.src = RPMSG_ADDR_ANY;
1464 chinfo.dst = RPMSG_ADDR_ANY;
1466 rpmsg_unregister_device(glink->dev, &chinfo);
1469 qcom_glink_send_close_ack(glink, channel->rcid);
1471 spin_lock_irqsave(&glink->idr_lock, flags);
1472 idr_remove(&glink->rcids, channel->rcid);
1474 spin_unlock_irqrestore(&glink->idr_lock, flags);
1476 kref_put(&channel->refcount, qcom_glink_channel_release);
1479 static void qcom_glink_rx_close_ack(struct qcom_glink *glink, unsigned int lcid)
1481 struct glink_channel *channel;
1482 unsigned long flags;
1484 spin_lock_irqsave(&glink->idr_lock, flags);
1485 channel = idr_find(&glink->lcids, lcid);
1486 if (WARN(!channel, "close ack on unknown channel\n")) {
1487 spin_unlock_irqrestore(&glink->idr_lock, flags);
1491 idr_remove(&glink->lcids, channel->lcid);
1493 spin_unlock_irqrestore(&glink->idr_lock, flags);
1495 kref_put(&channel->refcount, qcom_glink_channel_release);
1498 static void qcom_glink_work(struct work_struct *work)
1500 struct qcom_glink *glink = container_of(work, struct qcom_glink,
1502 struct glink_defer_cmd *dcmd;
1503 struct glink_msg *msg;
1504 unsigned long flags;
1505 unsigned int param1;
1506 unsigned int param2;
1510 spin_lock_irqsave(&glink->rx_lock, flags);
1511 if (list_empty(&glink->rx_queue)) {
1512 spin_unlock_irqrestore(&glink->rx_lock, flags);
1515 dcmd = list_first_entry(&glink->rx_queue,
1516 struct glink_defer_cmd, node);
1517 list_del(&dcmd->node);
1518 spin_unlock_irqrestore(&glink->rx_lock, flags);
1521 cmd = le16_to_cpu(msg->cmd);
1522 param1 = le16_to_cpu(msg->param1);
1523 param2 = le32_to_cpu(msg->param2);
1526 case RPM_CMD_VERSION:
1527 qcom_glink_receive_version(glink, param1, param2);
1529 case RPM_CMD_VERSION_ACK:
1530 qcom_glink_receive_version_ack(glink, param1, param2);
1533 qcom_glink_rx_open(glink, param1, msg->data);
1536 qcom_glink_rx_close(glink, param1);
1538 case RPM_CMD_CLOSE_ACK:
1539 qcom_glink_rx_close_ack(glink, param1);
1541 case RPM_CMD_RX_INTENT_REQ:
1542 qcom_glink_handle_intent_req(glink, param1, param2);
1545 WARN(1, "Unknown defer object %d\n", cmd);
1553 struct qcom_glink *qcom_glink_native_probe(struct device *dev,
1554 unsigned long features,
1555 struct qcom_glink_pipe *rx,
1556 struct qcom_glink_pipe *tx,
1561 struct qcom_glink *glink;
1563 glink = devm_kzalloc(dev, sizeof(*glink), GFP_KERNEL);
1565 return ERR_PTR(-ENOMEM);
1568 glink->tx_pipe = tx;
1569 glink->rx_pipe = rx;
1571 glink->features = features;
1572 glink->intentless = intentless;
1574 spin_lock_init(&glink->tx_lock);
1575 spin_lock_init(&glink->rx_lock);
1576 INIT_LIST_HEAD(&glink->rx_queue);
1577 INIT_WORK(&glink->rx_work, qcom_glink_work);
1579 spin_lock_init(&glink->idr_lock);
1580 idr_init(&glink->lcids);
1581 idr_init(&glink->rcids);
1583 glink->mbox_client.dev = dev;
1584 glink->mbox_client.knows_txdone = true;
1585 glink->mbox_chan = mbox_request_channel(&glink->mbox_client, 0);
1586 if (IS_ERR(glink->mbox_chan)) {
1587 if (PTR_ERR(glink->mbox_chan) != -EPROBE_DEFER)
1588 dev_err(dev, "failed to acquire IPC channel\n");
1589 return ERR_CAST(glink->mbox_chan);
1592 irq = of_irq_get(dev->of_node, 0);
1593 ret = devm_request_irq(dev, irq,
1594 qcom_glink_native_intr,
1595 IRQF_NO_SUSPEND | IRQF_SHARED,
1596 "glink-native", glink);
1598 dev_err(dev, "failed to request IRQ\n");
1599 return ERR_PTR(ret);
1604 ret = qcom_glink_send_version(glink);
1606 return ERR_PTR(ret);
1610 EXPORT_SYMBOL_GPL(qcom_glink_native_probe);
1612 static int qcom_glink_remove_device(struct device *dev, void *data)
1614 device_unregister(dev);
1619 void qcom_glink_native_remove(struct qcom_glink *glink)
1621 struct glink_channel *channel;
1624 unsigned long flags;
1626 disable_irq(glink->irq);
1627 cancel_work_sync(&glink->rx_work);
1629 ret = device_for_each_child(glink->dev, NULL, qcom_glink_remove_device);
1631 dev_warn(glink->dev, "Can't remove GLINK devices: %d\n", ret);
1633 spin_lock_irqsave(&glink->idr_lock, flags);
1634 /* Release any defunct local channels, waiting for close-ack */
1635 idr_for_each_entry(&glink->lcids, channel, cid)
1636 kref_put(&channel->refcount, qcom_glink_channel_release);
1638 idr_destroy(&glink->lcids);
1639 idr_destroy(&glink->rcids);
1640 spin_unlock_irqrestore(&glink->idr_lock, flags);
1641 mbox_free_channel(glink->mbox_chan);
1643 EXPORT_SYMBOL_GPL(qcom_glink_native_remove);
1645 void qcom_glink_native_unregister(struct qcom_glink *glink)
1647 device_unregister(glink->dev);
1649 EXPORT_SYMBOL_GPL(qcom_glink_native_unregister);
1651 MODULE_DESCRIPTION("Qualcomm GLINK driver");
1652 MODULE_LICENSE("GPL v2");