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;
116 struct mutex tx_lock;
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,
247 struct glink_core_rx_intent *intent;
248 struct glink_core_rx_intent *tmp;
252 /* cancel pending rx_done work */
253 cancel_work_sync(&channel->intent_work);
255 spin_lock_irqsave(&channel->intent_lock, flags);
256 /* Free all non-reuse intents pending rx_done work */
257 list_for_each_entry_safe(intent, tmp, &channel->done_intents, node) {
258 if (!intent->reuse) {
264 idr_for_each_entry(&channel->liids, tmp, iid) {
268 idr_destroy(&channel->liids);
270 idr_for_each_entry(&channel->riids, tmp, iid)
272 idr_destroy(&channel->riids);
273 spin_unlock_irqrestore(&channel->intent_lock, flags);
275 kfree(channel->name);
279 static size_t qcom_glink_rx_avail(struct qcom_glink *glink)
281 return glink->rx_pipe->avail(glink->rx_pipe);
284 static void qcom_glink_rx_peak(struct qcom_glink *glink,
285 void *data, unsigned int offset, size_t count)
287 glink->rx_pipe->peak(glink->rx_pipe, data, offset, count);
290 static void qcom_glink_rx_advance(struct qcom_glink *glink, size_t count)
292 glink->rx_pipe->advance(glink->rx_pipe, count);
295 static size_t qcom_glink_tx_avail(struct qcom_glink *glink)
297 return glink->tx_pipe->avail(glink->tx_pipe);
300 static void qcom_glink_tx_write(struct qcom_glink *glink,
301 const void *hdr, size_t hlen,
302 const void *data, size_t dlen)
304 glink->tx_pipe->write(glink->tx_pipe, hdr, hlen, data, dlen);
307 static int qcom_glink_tx(struct qcom_glink *glink,
308 const void *hdr, size_t hlen,
309 const void *data, size_t dlen, bool wait)
311 unsigned int tlen = hlen + dlen;
314 /* Reject packets that are too big */
315 if (tlen >= glink->tx_pipe->length)
318 ret = mutex_lock_interruptible(&glink->tx_lock);
322 while (qcom_glink_tx_avail(glink) < tlen) {
328 usleep_range(10000, 15000);
331 qcom_glink_tx_write(glink, hdr, hlen, data, dlen);
333 mbox_send_message(glink->mbox_chan, NULL);
334 mbox_client_txdone(glink->mbox_chan, 0);
337 mutex_unlock(&glink->tx_lock);
342 static int qcom_glink_send_version(struct qcom_glink *glink)
344 struct glink_msg msg;
346 msg.cmd = cpu_to_le16(RPM_CMD_VERSION);
347 msg.param1 = cpu_to_le16(GLINK_VERSION_1);
348 msg.param2 = cpu_to_le32(glink->features);
350 return qcom_glink_tx(glink, &msg, sizeof(msg), NULL, 0, true);
353 static void qcom_glink_send_version_ack(struct qcom_glink *glink)
355 struct glink_msg msg;
357 msg.cmd = cpu_to_le16(RPM_CMD_VERSION_ACK);
358 msg.param1 = cpu_to_le16(GLINK_VERSION_1);
359 msg.param2 = cpu_to_le32(glink->features);
361 qcom_glink_tx(glink, &msg, sizeof(msg), NULL, 0, true);
364 static void qcom_glink_send_open_ack(struct qcom_glink *glink,
365 struct glink_channel *channel)
367 struct glink_msg msg;
369 msg.cmd = cpu_to_le16(RPM_CMD_OPEN_ACK);
370 msg.param1 = cpu_to_le16(channel->rcid);
371 msg.param2 = cpu_to_le32(0);
373 qcom_glink_tx(glink, &msg, sizeof(msg), NULL, 0, true);
376 static void qcom_glink_handle_intent_req_ack(struct qcom_glink *glink,
377 unsigned int cid, bool granted)
379 struct glink_channel *channel;
382 spin_lock_irqsave(&glink->idr_lock, flags);
383 channel = idr_find(&glink->rcids, cid);
384 spin_unlock_irqrestore(&glink->idr_lock, flags);
386 dev_err(glink->dev, "unable to find channel\n");
390 channel->intent_req_result = granted;
391 complete(&channel->intent_req_comp);
395 * qcom_glink_send_open_req() - send a RPM_CMD_OPEN request to the remote
396 * @glink: Ptr to the glink edge
397 * @channel: Ptr to the channel that the open req is sent
399 * Allocates a local channel id and sends a RPM_CMD_OPEN message to the remote.
400 * Will return with refcount held, regardless of outcome.
402 * Returns 0 on success, negative errno otherwise.
404 static int qcom_glink_send_open_req(struct qcom_glink *glink,
405 struct glink_channel *channel)
408 struct glink_msg msg;
409 u8 name[GLINK_NAME_SIZE];
411 int name_len = strlen(channel->name) + 1;
412 int req_len = ALIGN(sizeof(req.msg) + name_len, 8);
416 kref_get(&channel->refcount);
418 spin_lock_irqsave(&glink->idr_lock, flags);
419 ret = idr_alloc_cyclic(&glink->lcids, channel,
420 RPM_GLINK_CID_MIN, RPM_GLINK_CID_MAX,
422 spin_unlock_irqrestore(&glink->idr_lock, flags);
428 req.msg.cmd = cpu_to_le16(RPM_CMD_OPEN);
429 req.msg.param1 = cpu_to_le16(channel->lcid);
430 req.msg.param2 = cpu_to_le32(name_len);
431 strcpy(req.name, channel->name);
433 ret = qcom_glink_tx(glink, &req, req_len, NULL, 0, true);
440 spin_lock_irqsave(&glink->idr_lock, flags);
441 idr_remove(&glink->lcids, channel->lcid);
443 spin_unlock_irqrestore(&glink->idr_lock, flags);
448 static void qcom_glink_send_close_req(struct qcom_glink *glink,
449 struct glink_channel *channel)
451 struct glink_msg req;
453 req.cmd = cpu_to_le16(RPM_CMD_CLOSE);
454 req.param1 = cpu_to_le16(channel->lcid);
457 qcom_glink_tx(glink, &req, sizeof(req), NULL, 0, true);
460 static void qcom_glink_send_close_ack(struct qcom_glink *glink,
463 struct glink_msg req;
465 req.cmd = cpu_to_le16(RPM_CMD_CLOSE_ACK);
466 req.param1 = cpu_to_le16(rcid);
469 qcom_glink_tx(glink, &req, sizeof(req), NULL, 0, true);
472 static void qcom_glink_rx_done_work(struct work_struct *work)
474 struct glink_channel *channel = container_of(work, struct glink_channel,
476 struct qcom_glink *glink = channel->glink;
477 struct glink_core_rx_intent *intent, *tmp;
484 unsigned int cid = channel->lcid;
489 spin_lock_irqsave(&channel->intent_lock, flags);
490 list_for_each_entry_safe(intent, tmp, &channel->done_intents, node) {
491 list_del(&intent->node);
492 spin_unlock_irqrestore(&channel->intent_lock, flags);
494 reuse = intent->reuse;
496 cmd.id = reuse ? RPM_CMD_RX_DONE_W_REUSE : RPM_CMD_RX_DONE;
500 qcom_glink_tx(glink, &cmd, sizeof(cmd), NULL, 0, true);
505 spin_lock_irqsave(&channel->intent_lock, flags);
507 spin_unlock_irqrestore(&channel->intent_lock, flags);
510 static void qcom_glink_rx_done(struct qcom_glink *glink,
511 struct glink_channel *channel,
512 struct glink_core_rx_intent *intent)
514 /* We don't send RX_DONE to intentless systems */
515 if (glink->intentless) {
521 /* Take it off the tree of receive intents */
522 if (!intent->reuse) {
523 spin_lock(&channel->intent_lock);
524 idr_remove(&channel->liids, intent->id);
525 spin_unlock(&channel->intent_lock);
528 /* Schedule the sending of a rx_done indication */
529 spin_lock(&channel->intent_lock);
530 list_add_tail(&intent->node, &channel->done_intents);
531 spin_unlock(&channel->intent_lock);
533 schedule_work(&channel->intent_work);
537 * qcom_glink_receive_version() - receive version/features from remote system
539 * @glink: pointer to transport interface
540 * @r_version: remote version
541 * @r_features: remote features
543 * This function is called in response to a remote-initiated version/feature
544 * negotiation sequence.
546 static void qcom_glink_receive_version(struct qcom_glink *glink,
553 case GLINK_VERSION_1:
554 glink->features &= features;
557 qcom_glink_send_version_ack(glink);
563 * qcom_glink_receive_version_ack() - receive negotiation ack from remote system
565 * @glink: pointer to transport interface
566 * @r_version: remote version response
567 * @r_features: remote features response
569 * This function is called in response to a local-initiated version/feature
570 * negotiation sequence and is the counter-offer from the remote side based
571 * upon the initial version and feature set requested.
573 static void qcom_glink_receive_version_ack(struct qcom_glink *glink,
579 /* Version negotiation failed */
581 case GLINK_VERSION_1:
582 if (features == glink->features)
585 glink->features &= features;
588 qcom_glink_send_version(glink);
594 * qcom_glink_send_intent_req_ack() - convert an rx intent request ack cmd to
595 wire format and transmit
596 * @glink: The transport to transmit on.
597 * @channel: The glink channel
598 * @granted: The request response to encode.
600 * Return: 0 on success or standard Linux error code.
602 static int qcom_glink_send_intent_req_ack(struct qcom_glink *glink,
603 struct glink_channel *channel,
606 struct glink_msg msg;
608 msg.cmd = cpu_to_le16(RPM_CMD_RX_INTENT_REQ_ACK);
609 msg.param1 = cpu_to_le16(channel->lcid);
610 msg.param2 = cpu_to_le32(granted);
612 qcom_glink_tx(glink, &msg, sizeof(msg), NULL, 0, true);
618 * qcom_glink_advertise_intent - convert an rx intent cmd to wire format and
620 * @glink: The transport to transmit on.
621 * @channel: The local channel
622 * @size: The intent to pass on to remote.
624 * Return: 0 on success or standard Linux error code.
626 static int qcom_glink_advertise_intent(struct qcom_glink *glink,
627 struct glink_channel *channel,
628 struct glink_core_rx_intent *intent)
639 cmd.id = cpu_to_le16(RPM_CMD_INTENT);
640 cmd.lcid = cpu_to_le16(channel->lcid);
641 cmd.count = cpu_to_le32(1);
642 cmd.size = cpu_to_le32(intent->size);
643 cmd.liid = cpu_to_le32(intent->id);
645 qcom_glink_tx(glink, &cmd, sizeof(cmd), NULL, 0, true);
650 static struct glink_core_rx_intent *
651 qcom_glink_alloc_intent(struct qcom_glink *glink,
652 struct glink_channel *channel,
656 struct glink_core_rx_intent *intent;
660 intent = kzalloc(sizeof(*intent), GFP_KERNEL);
664 intent->data = kzalloc(size, GFP_KERNEL);
668 spin_lock_irqsave(&channel->intent_lock, flags);
669 ret = idr_alloc_cyclic(&channel->liids, intent, 1, -1, GFP_ATOMIC);
671 spin_unlock_irqrestore(&channel->intent_lock, flags);
674 spin_unlock_irqrestore(&channel->intent_lock, flags);
678 intent->reuse = reuseable;
689 static void qcom_glink_handle_rx_done(struct qcom_glink *glink,
690 u32 cid, uint32_t iid,
693 struct glink_core_rx_intent *intent;
694 struct glink_channel *channel;
697 spin_lock_irqsave(&glink->idr_lock, flags);
698 channel = idr_find(&glink->rcids, cid);
699 spin_unlock_irqrestore(&glink->idr_lock, flags);
701 dev_err(glink->dev, "invalid channel id received\n");
705 spin_lock_irqsave(&channel->intent_lock, flags);
706 intent = idr_find(&channel->riids, iid);
709 spin_unlock_irqrestore(&channel->intent_lock, flags);
710 dev_err(glink->dev, "invalid intent id received\n");
714 intent->in_use = false;
717 idr_remove(&channel->riids, intent->id);
720 spin_unlock_irqrestore(&channel->intent_lock, flags);
724 * qcom_glink_handle_intent_req() - Receive a request for rx_intent
726 * if_ptr: Pointer to the transport interface
727 * rcid: Remote channel ID
728 * size: size of the intent
730 * The function searches for the local channel to which the request for
731 * rx_intent has arrived and allocates and notifies the remote back
733 static void qcom_glink_handle_intent_req(struct qcom_glink *glink,
734 u32 cid, size_t size)
736 struct glink_core_rx_intent *intent;
737 struct glink_channel *channel;
740 spin_lock_irqsave(&glink->idr_lock, flags);
741 channel = idr_find(&glink->rcids, cid);
742 spin_unlock_irqrestore(&glink->idr_lock, flags);
745 pr_err("%s channel not found for cid %d\n", __func__, cid);
749 intent = qcom_glink_alloc_intent(glink, channel, size, false);
751 qcom_glink_advertise_intent(glink, channel, intent);
753 qcom_glink_send_intent_req_ack(glink, channel, !!intent);
756 static int qcom_glink_rx_defer(struct qcom_glink *glink, size_t extra)
758 struct glink_defer_cmd *dcmd;
760 extra = ALIGN(extra, 8);
762 if (qcom_glink_rx_avail(glink) < sizeof(struct glink_msg) + extra) {
763 dev_dbg(glink->dev, "Insufficient data in rx fifo");
767 dcmd = kzalloc(sizeof(*dcmd) + extra, GFP_ATOMIC);
771 INIT_LIST_HEAD(&dcmd->node);
773 qcom_glink_rx_peak(glink, &dcmd->msg, 0, sizeof(dcmd->msg) + extra);
775 spin_lock(&glink->rx_lock);
776 list_add_tail(&dcmd->node, &glink->rx_queue);
777 spin_unlock(&glink->rx_lock);
779 schedule_work(&glink->rx_work);
780 qcom_glink_rx_advance(glink, sizeof(dcmd->msg) + extra);
785 static int qcom_glink_rx_data(struct qcom_glink *glink, size_t avail)
787 struct glink_core_rx_intent *intent;
788 struct glink_channel *channel;
790 struct glink_msg msg;
794 unsigned int chunk_size;
795 unsigned int left_size;
801 if (avail < sizeof(hdr)) {
802 dev_dbg(glink->dev, "Not enough data in fifo\n");
806 qcom_glink_rx_peak(glink, &hdr, 0, sizeof(hdr));
807 chunk_size = le32_to_cpu(hdr.chunk_size);
808 left_size = le32_to_cpu(hdr.left_size);
810 if (avail < sizeof(hdr) + chunk_size) {
811 dev_dbg(glink->dev, "Payload not yet in fifo\n");
815 rcid = le16_to_cpu(hdr.msg.param1);
816 spin_lock_irqsave(&glink->idr_lock, flags);
817 channel = idr_find(&glink->rcids, rcid);
818 spin_unlock_irqrestore(&glink->idr_lock, flags);
820 dev_dbg(glink->dev, "Data on non-existing channel\n");
822 /* Drop the message */
826 if (glink->intentless) {
827 /* Might have an ongoing, fragmented, message to append */
829 intent = kzalloc(sizeof(*intent), GFP_ATOMIC);
833 intent->data = kmalloc(chunk_size + left_size,
840 intent->id = 0xbabababa;
841 intent->size = chunk_size + left_size;
844 channel->buf = intent;
846 intent = channel->buf;
849 liid = le32_to_cpu(hdr.msg.param2);
851 spin_lock_irqsave(&channel->intent_lock, flags);
852 intent = idr_find(&channel->liids, liid);
853 spin_unlock_irqrestore(&channel->intent_lock, flags);
857 "no intent found for channel %s intent %d",
858 channel->name, liid);
864 if (intent->size - intent->offset < chunk_size) {
865 dev_err(glink->dev, "Insufficient space in intent\n");
867 /* The packet header lied, drop payload */
871 qcom_glink_rx_peak(glink, intent->data + intent->offset,
872 sizeof(hdr), chunk_size);
873 intent->offset += chunk_size;
875 /* Handle message when no fragments remain to be received */
877 spin_lock(&channel->recv_lock);
878 if (channel->ept.cb) {
879 channel->ept.cb(channel->ept.rpdev,
885 spin_unlock(&channel->recv_lock);
890 qcom_glink_rx_done(glink, channel, intent);
894 qcom_glink_rx_advance(glink, ALIGN(sizeof(hdr) + chunk_size, 8));
899 static void qcom_glink_handle_intent(struct qcom_glink *glink,
904 struct glink_core_rx_intent *intent;
905 struct glink_channel *channel;
912 struct glink_msg msg;
913 struct intent_pair intents[];
916 const size_t msglen = sizeof(*msg) + sizeof(struct intent_pair) * count;
921 if (avail < msglen) {
922 dev_dbg(glink->dev, "Not enough data in fifo\n");
926 spin_lock_irqsave(&glink->idr_lock, flags);
927 channel = idr_find(&glink->rcids, cid);
928 spin_unlock_irqrestore(&glink->idr_lock, flags);
930 dev_err(glink->dev, "intents for non-existing channel\n");
934 msg = kmalloc(msglen, GFP_ATOMIC);
938 qcom_glink_rx_peak(glink, msg, 0, msglen);
940 for (i = 0; i < count; ++i) {
941 intent = kzalloc(sizeof(*intent), GFP_ATOMIC);
945 intent->id = le32_to_cpu(msg->intents[i].iid);
946 intent->size = le32_to_cpu(msg->intents[i].size);
948 spin_lock_irqsave(&channel->intent_lock, flags);
949 ret = idr_alloc(&channel->riids, intent,
950 intent->id, intent->id + 1, GFP_ATOMIC);
951 spin_unlock_irqrestore(&channel->intent_lock, flags);
954 dev_err(glink->dev, "failed to store remote intent\n");
958 qcom_glink_rx_advance(glink, ALIGN(msglen, 8));
961 static int qcom_glink_rx_open_ack(struct qcom_glink *glink, unsigned int lcid)
963 struct glink_channel *channel;
965 spin_lock(&glink->idr_lock);
966 channel = idr_find(&glink->lcids, lcid);
967 spin_unlock(&glink->idr_lock);
969 dev_err(glink->dev, "Invalid open ack packet\n");
973 complete(&channel->open_ack);
978 static irqreturn_t qcom_glink_native_intr(int irq, void *data)
980 struct qcom_glink *glink = data;
981 struct glink_msg msg;
989 avail = qcom_glink_rx_avail(glink);
990 if (avail < sizeof(msg))
993 qcom_glink_rx_peak(glink, &msg, 0, sizeof(msg));
995 cmd = le16_to_cpu(msg.cmd);
996 param1 = le16_to_cpu(msg.param1);
997 param2 = le32_to_cpu(msg.param2);
1000 case RPM_CMD_VERSION:
1001 case RPM_CMD_VERSION_ACK:
1003 case RPM_CMD_CLOSE_ACK:
1004 case RPM_CMD_RX_INTENT_REQ:
1005 ret = qcom_glink_rx_defer(glink, 0);
1007 case RPM_CMD_OPEN_ACK:
1008 ret = qcom_glink_rx_open_ack(glink, param1);
1009 qcom_glink_rx_advance(glink, ALIGN(sizeof(msg), 8));
1012 ret = qcom_glink_rx_defer(glink, param2);
1014 case RPM_CMD_TX_DATA:
1015 case RPM_CMD_TX_DATA_CONT:
1016 ret = qcom_glink_rx_data(glink, avail);
1018 case RPM_CMD_READ_NOTIF:
1019 qcom_glink_rx_advance(glink, ALIGN(sizeof(msg), 8));
1021 mbox_send_message(glink->mbox_chan, NULL);
1022 mbox_client_txdone(glink->mbox_chan, 0);
1024 case RPM_CMD_INTENT:
1025 qcom_glink_handle_intent(glink, param1, param2, avail);
1027 case RPM_CMD_RX_DONE:
1028 qcom_glink_handle_rx_done(glink, param1, param2, false);
1029 qcom_glink_rx_advance(glink, ALIGN(sizeof(msg), 8));
1031 case RPM_CMD_RX_DONE_W_REUSE:
1032 qcom_glink_handle_rx_done(glink, param1, param2, true);
1033 qcom_glink_rx_advance(glink, ALIGN(sizeof(msg), 8));
1035 case RPM_CMD_RX_INTENT_REQ_ACK:
1036 qcom_glink_handle_intent_req_ack(glink, param1, param2);
1037 qcom_glink_rx_advance(glink, ALIGN(sizeof(msg), 8));
1040 dev_err(glink->dev, "unhandled rx cmd: %d\n", cmd);
1052 /* Locally initiated rpmsg_create_ept */
1053 static struct glink_channel *qcom_glink_create_local(struct qcom_glink *glink,
1056 struct glink_channel *channel;
1058 unsigned long flags;
1060 channel = qcom_glink_alloc_channel(glink, name);
1061 if (IS_ERR(channel))
1062 return ERR_CAST(channel);
1064 ret = qcom_glink_send_open_req(glink, channel);
1066 goto release_channel;
1068 ret = wait_for_completion_timeout(&channel->open_ack, 5 * HZ);
1072 ret = wait_for_completion_timeout(&channel->open_req, 5 * HZ);
1076 qcom_glink_send_open_ack(glink, channel);
1081 /* qcom_glink_send_open_req() did register the channel in lcids*/
1082 spin_lock_irqsave(&glink->idr_lock, flags);
1083 idr_remove(&glink->lcids, channel->lcid);
1084 spin_unlock_irqrestore(&glink->idr_lock, flags);
1087 /* Release qcom_glink_send_open_req() reference */
1088 kref_put(&channel->refcount, qcom_glink_channel_release);
1089 /* Release qcom_glink_alloc_channel() reference */
1090 kref_put(&channel->refcount, qcom_glink_channel_release);
1092 return ERR_PTR(-ETIMEDOUT);
1095 /* Remote initiated rpmsg_create_ept */
1096 static int qcom_glink_create_remote(struct qcom_glink *glink,
1097 struct glink_channel *channel)
1101 qcom_glink_send_open_ack(glink, channel);
1103 ret = qcom_glink_send_open_req(glink, channel);
1107 ret = wait_for_completion_timeout(&channel->open_ack, 5 * HZ);
1117 * Send a close request to "undo" our open-ack. The close-ack will
1118 * release qcom_glink_send_open_req() reference and the last reference
1119 * will be relesed after receiving remote_close or transport unregister
1120 * by calling qcom_glink_native_remove().
1122 qcom_glink_send_close_req(glink, channel);
1127 static struct rpmsg_endpoint *qcom_glink_create_ept(struct rpmsg_device *rpdev,
1130 struct rpmsg_channel_info
1133 struct glink_channel *parent = to_glink_channel(rpdev->ept);
1134 struct glink_channel *channel;
1135 struct qcom_glink *glink = parent->glink;
1136 struct rpmsg_endpoint *ept;
1137 const char *name = chinfo.name;
1140 unsigned long flags;
1142 spin_lock_irqsave(&glink->idr_lock, flags);
1143 idr_for_each_entry(&glink->rcids, channel, cid) {
1144 if (!strcmp(channel->name, name))
1147 spin_unlock_irqrestore(&glink->idr_lock, flags);
1150 channel = qcom_glink_create_local(glink, name);
1151 if (IS_ERR(channel))
1154 ret = qcom_glink_create_remote(glink, channel);
1159 ept = &channel->ept;
1163 ept->ops = &glink_endpoint_ops;
1168 static int qcom_glink_announce_create(struct rpmsg_device *rpdev)
1170 struct glink_channel *channel = to_glink_channel(rpdev->ept);
1171 struct glink_core_rx_intent *intent;
1172 struct qcom_glink *glink = channel->glink;
1173 int num_intents = glink->intentless ? 0 : 5;
1175 /* Channel is now open, advertise base set of intents */
1176 while (num_intents--) {
1177 intent = qcom_glink_alloc_intent(glink, channel, SZ_1K, true);
1181 qcom_glink_advertise_intent(glink, channel, intent);
1187 static void qcom_glink_destroy_ept(struct rpmsg_endpoint *ept)
1189 struct glink_channel *channel = to_glink_channel(ept);
1190 struct qcom_glink *glink = channel->glink;
1191 unsigned long flags;
1193 spin_lock_irqsave(&channel->recv_lock, flags);
1194 channel->ept.cb = NULL;
1195 spin_unlock_irqrestore(&channel->recv_lock, flags);
1197 /* Decouple the potential rpdev from the channel */
1198 channel->rpdev = NULL;
1200 qcom_glink_send_close_req(glink, channel);
1203 static int qcom_glink_request_intent(struct qcom_glink *glink,
1204 struct glink_channel *channel,
1215 mutex_lock(&channel->intent_req_lock);
1217 reinit_completion(&channel->intent_req_comp);
1219 cmd.id = RPM_CMD_RX_INTENT_REQ;
1220 cmd.cid = channel->lcid;
1223 ret = qcom_glink_tx(glink, &cmd, sizeof(cmd), NULL, 0, true);
1227 ret = wait_for_completion_timeout(&channel->intent_req_comp, 10 * HZ);
1229 dev_err(glink->dev, "intent request timed out\n");
1232 ret = channel->intent_req_result ? 0 : -ECANCELED;
1236 mutex_unlock(&channel->intent_req_lock);
1240 static int __qcom_glink_send(struct glink_channel *channel,
1241 void *data, int len, bool wait)
1243 struct qcom_glink *glink = channel->glink;
1244 struct glink_core_rx_intent *intent = NULL;
1245 struct glink_core_rx_intent *tmp;
1248 struct glink_msg msg;
1253 unsigned long flags;
1255 if (!glink->intentless) {
1257 spin_lock_irqsave(&channel->intent_lock, flags);
1258 idr_for_each_entry(&channel->riids, tmp, iid) {
1259 if (tmp->size >= len && !tmp->in_use) {
1265 spin_unlock_irqrestore(&channel->intent_lock, flags);
1267 /* We found an available intent */
1274 ret = qcom_glink_request_intent(glink, channel, len);
1282 req.msg.cmd = cpu_to_le16(RPM_CMD_TX_DATA);
1283 req.msg.param1 = cpu_to_le16(channel->lcid);
1284 req.msg.param2 = cpu_to_le32(iid);
1285 req.chunk_size = cpu_to_le32(len);
1286 req.left_size = cpu_to_le32(0);
1288 ret = qcom_glink_tx(glink, &req, sizeof(req), data, len, wait);
1290 /* Mark intent available if we failed */
1292 intent->in_use = false;
1297 static int qcom_glink_send(struct rpmsg_endpoint *ept, void *data, int len)
1299 struct glink_channel *channel = to_glink_channel(ept);
1301 return __qcom_glink_send(channel, data, len, true);
1304 static int qcom_glink_trysend(struct rpmsg_endpoint *ept, void *data, int len)
1306 struct glink_channel *channel = to_glink_channel(ept);
1308 return __qcom_glink_send(channel, data, len, false);
1312 * Finds the device_node for the glink child interested in this channel.
1314 static struct device_node *qcom_glink_match_channel(struct device_node *node,
1315 const char *channel)
1317 struct device_node *child;
1322 for_each_available_child_of_node(node, child) {
1323 key = "qcom,glink-channels";
1324 ret = of_property_read_string(child, key, &name);
1328 if (strcmp(name, channel) == 0)
1335 static const struct rpmsg_device_ops glink_device_ops = {
1336 .create_ept = qcom_glink_create_ept,
1337 .announce_create = qcom_glink_announce_create,
1340 static const struct rpmsg_endpoint_ops glink_endpoint_ops = {
1341 .destroy_ept = qcom_glink_destroy_ept,
1342 .send = qcom_glink_send,
1343 .trysend = qcom_glink_trysend,
1346 static void qcom_glink_rpdev_release(struct device *dev)
1348 struct rpmsg_device *rpdev = to_rpmsg_device(dev);
1349 struct glink_channel *channel = to_glink_channel(rpdev->ept);
1351 channel->rpdev = NULL;
1355 static int qcom_glink_rx_open(struct qcom_glink *glink, unsigned int rcid,
1358 struct glink_channel *channel;
1359 struct rpmsg_device *rpdev;
1360 bool create_device = false;
1361 struct device_node *node;
1364 unsigned long flags;
1366 spin_lock_irqsave(&glink->idr_lock, flags);
1367 idr_for_each_entry(&glink->lcids, channel, lcid) {
1368 if (!strcmp(channel->name, name))
1371 spin_unlock_irqrestore(&glink->idr_lock, flags);
1374 channel = qcom_glink_alloc_channel(glink, name);
1375 if (IS_ERR(channel))
1376 return PTR_ERR(channel);
1378 /* The opening dance was initiated by the remote */
1379 create_device = true;
1382 spin_lock_irqsave(&glink->idr_lock, flags);
1383 ret = idr_alloc(&glink->rcids, channel, rcid, rcid + 1, GFP_ATOMIC);
1385 dev_err(glink->dev, "Unable to insert channel into rcid list\n");
1386 spin_unlock_irqrestore(&glink->idr_lock, flags);
1389 channel->rcid = ret;
1390 spin_unlock_irqrestore(&glink->idr_lock, flags);
1392 complete(&channel->open_req);
1394 if (create_device) {
1395 rpdev = kzalloc(sizeof(*rpdev), GFP_KERNEL);
1401 rpdev->ept = &channel->ept;
1402 strncpy(rpdev->id.name, name, RPMSG_NAME_SIZE);
1403 rpdev->src = RPMSG_ADDR_ANY;
1404 rpdev->dst = RPMSG_ADDR_ANY;
1405 rpdev->ops = &glink_device_ops;
1407 node = qcom_glink_match_channel(glink->dev->of_node, name);
1408 rpdev->dev.of_node = node;
1409 rpdev->dev.parent = glink->dev;
1410 rpdev->dev.release = qcom_glink_rpdev_release;
1412 ret = rpmsg_register_device(rpdev);
1416 channel->rpdev = rpdev;
1422 spin_lock_irqsave(&glink->idr_lock, flags);
1423 idr_remove(&glink->rcids, channel->rcid);
1425 spin_unlock_irqrestore(&glink->idr_lock, flags);
1427 /* Release the reference, iff we took it */
1429 kref_put(&channel->refcount, qcom_glink_channel_release);
1434 static void qcom_glink_rx_close(struct qcom_glink *glink, unsigned int rcid)
1436 struct rpmsg_channel_info chinfo;
1437 struct glink_channel *channel;
1438 unsigned long flags;
1440 spin_lock_irqsave(&glink->idr_lock, flags);
1441 channel = idr_find(&glink->rcids, rcid);
1442 spin_unlock_irqrestore(&glink->idr_lock, flags);
1443 if (WARN(!channel, "close request on unknown channel\n"))
1446 /* cancel pending rx_done work */
1447 cancel_work_sync(&channel->intent_work);
1449 if (channel->rpdev) {
1450 strncpy(chinfo.name, channel->name, sizeof(chinfo.name));
1451 chinfo.src = RPMSG_ADDR_ANY;
1452 chinfo.dst = RPMSG_ADDR_ANY;
1454 rpmsg_unregister_device(glink->dev, &chinfo);
1457 qcom_glink_send_close_ack(glink, channel->rcid);
1459 spin_lock_irqsave(&glink->idr_lock, flags);
1460 idr_remove(&glink->rcids, channel->rcid);
1462 spin_unlock_irqrestore(&glink->idr_lock, flags);
1464 kref_put(&channel->refcount, qcom_glink_channel_release);
1467 static void qcom_glink_rx_close_ack(struct qcom_glink *glink, unsigned int lcid)
1469 struct glink_channel *channel;
1470 unsigned long flags;
1472 spin_lock_irqsave(&glink->idr_lock, flags);
1473 channel = idr_find(&glink->lcids, lcid);
1474 if (WARN(!channel, "close ack on unknown channel\n")) {
1475 spin_unlock_irqrestore(&glink->idr_lock, flags);
1479 idr_remove(&glink->lcids, channel->lcid);
1481 spin_unlock_irqrestore(&glink->idr_lock, flags);
1483 kref_put(&channel->refcount, qcom_glink_channel_release);
1486 static void qcom_glink_work(struct work_struct *work)
1488 struct qcom_glink *glink = container_of(work, struct qcom_glink,
1490 struct glink_defer_cmd *dcmd;
1491 struct glink_msg *msg;
1492 unsigned long flags;
1493 unsigned int param1;
1494 unsigned int param2;
1498 spin_lock_irqsave(&glink->rx_lock, flags);
1499 if (list_empty(&glink->rx_queue)) {
1500 spin_unlock_irqrestore(&glink->rx_lock, flags);
1503 dcmd = list_first_entry(&glink->rx_queue,
1504 struct glink_defer_cmd, node);
1505 list_del(&dcmd->node);
1506 spin_unlock_irqrestore(&glink->rx_lock, flags);
1509 cmd = le16_to_cpu(msg->cmd);
1510 param1 = le16_to_cpu(msg->param1);
1511 param2 = le32_to_cpu(msg->param2);
1514 case RPM_CMD_VERSION:
1515 qcom_glink_receive_version(glink, param1, param2);
1517 case RPM_CMD_VERSION_ACK:
1518 qcom_glink_receive_version_ack(glink, param1, param2);
1521 qcom_glink_rx_open(glink, param1, msg->data);
1524 qcom_glink_rx_close(glink, param1);
1526 case RPM_CMD_CLOSE_ACK:
1527 qcom_glink_rx_close_ack(glink, param1);
1529 case RPM_CMD_RX_INTENT_REQ:
1530 qcom_glink_handle_intent_req(glink, param1, param2);
1533 WARN(1, "Unknown defer object %d\n", cmd);
1541 static void qcom_glink_cancel_rx_work(struct qcom_glink *glink)
1543 struct glink_defer_cmd *dcmd;
1544 struct glink_defer_cmd *tmp;
1546 /* cancel any pending deferred rx_work */
1547 cancel_work_sync(&glink->rx_work);
1549 list_for_each_entry_safe(dcmd, tmp, &glink->rx_queue, node)
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 mutex_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_chan = mbox_request_channel(&glink->mbox_client, 0);
1585 if (IS_ERR(glink->mbox_chan)) {
1586 if (PTR_ERR(glink->mbox_chan) != -EPROBE_DEFER)
1587 dev_err(dev, "failed to acquire IPC channel\n");
1588 return ERR_CAST(glink->mbox_chan);
1591 irq = of_irq_get(dev->of_node, 0);
1592 ret = devm_request_irq(dev, irq,
1593 qcom_glink_native_intr,
1594 IRQF_NO_SUSPEND | IRQF_SHARED,
1595 "glink-native", glink);
1597 dev_err(dev, "failed to request IRQ\n");
1598 return ERR_PTR(ret);
1603 ret = qcom_glink_send_version(glink);
1605 return ERR_PTR(ret);
1609 EXPORT_SYMBOL_GPL(qcom_glink_native_probe);
1611 static int qcom_glink_remove_device(struct device *dev, void *data)
1613 device_unregister(dev);
1618 void qcom_glink_native_remove(struct qcom_glink *glink)
1620 struct glink_channel *channel;
1624 disable_irq(glink->irq);
1625 qcom_glink_cancel_rx_work(glink);
1627 ret = device_for_each_child(glink->dev, NULL, qcom_glink_remove_device);
1629 dev_warn(glink->dev, "Can't remove GLINK devices: %d\n", ret);
1631 /* Release any defunct local channels, waiting for close-ack */
1632 idr_for_each_entry(&glink->lcids, channel, cid)
1633 kref_put(&channel->refcount, qcom_glink_channel_release);
1635 /* Release any defunct local channels, waiting for close-req */
1636 idr_for_each_entry(&glink->rcids, channel, cid)
1637 kref_put(&channel->refcount, qcom_glink_channel_release);
1639 idr_destroy(&glink->lcids);
1640 idr_destroy(&glink->rcids);
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");