1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (c) 2016-2017, Linaro Ltd
7 #include <linux/interrupt.h>
9 #include <linux/list.h>
10 #include <linux/mfd/syscon.h>
11 #include <linux/module.h>
13 #include <linux/of_address.h>
14 #include <linux/of_irq.h>
15 #include <linux/platform_device.h>
16 #include <linux/regmap.h>
17 #include <linux/rpmsg.h>
18 #include <linux/sizes.h>
19 #include <linux/slab.h>
20 #include <linux/workqueue.h>
21 #include <linux/mailbox_client.h>
23 #include "rpmsg_internal.h"
24 #include "qcom_glink_native.h"
26 #define GLINK_NAME_SIZE 32
27 #define GLINK_VERSION_1 1
29 #define RPM_GLINK_CID_MIN 1
30 #define RPM_GLINK_CID_MAX 65536
40 * struct glink_defer_cmd - deferred incoming control message
42 * @msg: message header
43 * @data: payload of the message
45 * Copy of a received control message, to be added to @rx_queue and processed
46 * by @rx_work of @qcom_glink.
48 struct glink_defer_cmd
{
49 struct list_head node
;
56 * struct glink_core_rx_intent - RX intent
59 * @data: pointer to the data (may be NULL for zero-copy)
60 * @id: remote or local intent ID
61 * @size: size of the original intent (do not modify)
62 * @reuse: To mark if the intent can be reused after first use
63 * @in_use: To mark if intent is already in use for the channel
64 * @offset: next write offset (initially 0)
67 struct glink_core_rx_intent
{
75 struct list_head node
;
79 * struct qcom_glink - driver context, relates to one remote subsystem
80 * @dev: reference to the associated struct device
81 * @mbox_client: mailbox client
82 * @mbox_chan: mailbox channel
83 * @rx_pipe: pipe object for receive FIFO
84 * @tx_pipe: pipe object for transmit FIFO
85 * @irq: IRQ for signaling incoming events
86 * @rx_work: worker for handling received control messages
87 * @rx_lock: protects the @rx_queue
88 * @rx_queue: queue of received control messages to be processed in @rx_work
89 * @tx_lock: synchronizes operations on the tx fifo
90 * @idr_lock: synchronizes @lcids and @rcids modifications
91 * @lcids: idr of all channels with a known local channel id
92 * @rcids: idr of all channels with a known remote channel id
93 * @features: remote features
94 * @intentless: flag to indicate that there is no intent
101 struct mbox_client mbox_client
;
102 struct mbox_chan
*mbox_chan
;
104 struct qcom_glink_pipe
*rx_pipe
;
105 struct qcom_glink_pipe
*tx_pipe
;
109 struct work_struct rx_work
;
111 struct list_head rx_queue
;
118 unsigned long features
;
131 * struct glink_channel - internal representation of a channel
132 * @rpdev: rpdev reference, only used for primary endpoints
133 * @ept: rpmsg endpoint this channel is associated with
134 * @glink: qcom_glink context handle
135 * @refcount: refcount for the channel object
136 * @recv_lock: guard for @ept.cb
137 * @name: unique channel name/identifier
138 * @lcid: channel id, in local space
139 * @rcid: channel id, in remote space
140 * @intent_lock: lock for protection of @liids, @riids
141 * @liids: idr of all local intents
142 * @riids: idr of all remote intents
143 * @intent_work: worker responsible for transmitting rx_done packets
144 * @done_intents: list of intents that needs to be announced rx_done
145 * @buf: receive buffer, for gathering fragments
146 * @buf_offset: write offset in @buf
147 * @buf_size: size of current @buf
148 * @open_ack: completed once remote has acked the open-request
149 * @open_req: completed once open-request has been received
150 * @intent_req_lock: Synchronises multiple intent requests
151 * @intent_req_result: Result of intent request
152 * @intent_req_comp: Completion for intent_req signalling
154 struct glink_channel
{
155 struct rpmsg_endpoint ept
;
157 struct rpmsg_device
*rpdev
;
158 struct qcom_glink
*glink
;
160 struct kref refcount
;
162 spinlock_t recv_lock
;
168 spinlock_t intent_lock
;
171 struct work_struct intent_work
;
172 struct list_head done_intents
;
174 struct glink_core_rx_intent
*buf
;
178 struct completion open_ack
;
179 struct completion open_req
;
181 struct mutex intent_req_lock
;
182 bool intent_req_result
;
183 struct completion intent_req_comp
;
186 #define to_glink_channel(_ept) container_of(_ept, struct glink_channel, ept)
188 static const struct rpmsg_endpoint_ops glink_endpoint_ops
;
190 #define RPM_CMD_VERSION 0
191 #define RPM_CMD_VERSION_ACK 1
192 #define RPM_CMD_OPEN 2
193 #define RPM_CMD_CLOSE 3
194 #define RPM_CMD_OPEN_ACK 4
195 #define RPM_CMD_INTENT 5
196 #define RPM_CMD_RX_DONE 6
197 #define RPM_CMD_RX_INTENT_REQ 7
198 #define RPM_CMD_RX_INTENT_REQ_ACK 8
199 #define RPM_CMD_TX_DATA 9
200 #define RPM_CMD_CLOSE_ACK 11
201 #define RPM_CMD_TX_DATA_CONT 12
202 #define RPM_CMD_READ_NOTIF 13
203 #define RPM_CMD_RX_DONE_W_REUSE 14
205 #define GLINK_FEATURE_INTENTLESS BIT(1)
207 static void qcom_glink_rx_done_work(struct work_struct
*work
);
209 static struct glink_channel
*qcom_glink_alloc_channel(struct qcom_glink
*glink
,
212 struct glink_channel
*channel
;
214 channel
= kzalloc(sizeof(*channel
), GFP_KERNEL
);
216 return ERR_PTR(-ENOMEM
);
218 /* Setup glink internal glink_channel data */
219 spin_lock_init(&channel
->recv_lock
);
220 spin_lock_init(&channel
->intent_lock
);
221 mutex_init(&channel
->intent_req_lock
);
223 channel
->glink
= glink
;
224 channel
->name
= kstrdup(name
, GFP_KERNEL
);
226 init_completion(&channel
->open_req
);
227 init_completion(&channel
->open_ack
);
228 init_completion(&channel
->intent_req_comp
);
230 INIT_LIST_HEAD(&channel
->done_intents
);
231 INIT_WORK(&channel
->intent_work
, qcom_glink_rx_done_work
);
233 idr_init(&channel
->liids
);
234 idr_init(&channel
->riids
);
235 kref_init(&channel
->refcount
);
240 static void qcom_glink_channel_release(struct kref
*ref
)
242 struct glink_channel
*channel
= container_of(ref
, struct glink_channel
,
246 spin_lock_irqsave(&channel
->intent_lock
, flags
);
247 idr_destroy(&channel
->liids
);
248 idr_destroy(&channel
->riids
);
249 spin_unlock_irqrestore(&channel
->intent_lock
, flags
);
251 kfree(channel
->name
);
255 static size_t qcom_glink_rx_avail(struct qcom_glink
*glink
)
257 return glink
->rx_pipe
->avail(glink
->rx_pipe
);
260 static void qcom_glink_rx_peak(struct qcom_glink
*glink
,
261 void *data
, unsigned int offset
, size_t count
)
263 glink
->rx_pipe
->peak(glink
->rx_pipe
, data
, offset
, count
);
266 static void qcom_glink_rx_advance(struct qcom_glink
*glink
, size_t count
)
268 glink
->rx_pipe
->advance(glink
->rx_pipe
, count
);
271 static size_t qcom_glink_tx_avail(struct qcom_glink
*glink
)
273 return glink
->tx_pipe
->avail(glink
->tx_pipe
);
276 static void qcom_glink_tx_write(struct qcom_glink
*glink
,
277 const void *hdr
, size_t hlen
,
278 const void *data
, size_t dlen
)
280 glink
->tx_pipe
->write(glink
->tx_pipe
, hdr
, hlen
, data
, dlen
);
283 static int qcom_glink_tx(struct qcom_glink
*glink
,
284 const void *hdr
, size_t hlen
,
285 const void *data
, size_t dlen
, bool wait
)
287 unsigned int tlen
= hlen
+ dlen
;
291 /* Reject packets that are too big */
292 if (tlen
>= glink
->tx_pipe
->length
)
295 spin_lock_irqsave(&glink
->tx_lock
, flags
);
297 while (qcom_glink_tx_avail(glink
) < tlen
) {
303 /* Wait without holding the tx_lock */
304 spin_unlock_irqrestore(&glink
->tx_lock
, flags
);
306 usleep_range(10000, 15000);
308 spin_lock_irqsave(&glink
->tx_lock
, flags
);
311 qcom_glink_tx_write(glink
, hdr
, hlen
, data
, dlen
);
313 mbox_send_message(glink
->mbox_chan
, NULL
);
314 mbox_client_txdone(glink
->mbox_chan
, 0);
317 spin_unlock_irqrestore(&glink
->tx_lock
, flags
);
322 static int qcom_glink_send_version(struct qcom_glink
*glink
)
324 struct glink_msg msg
;
326 msg
.cmd
= cpu_to_le16(RPM_CMD_VERSION
);
327 msg
.param1
= cpu_to_le16(GLINK_VERSION_1
);
328 msg
.param2
= cpu_to_le32(glink
->features
);
330 return qcom_glink_tx(glink
, &msg
, sizeof(msg
), NULL
, 0, true);
333 static void qcom_glink_send_version_ack(struct qcom_glink
*glink
)
335 struct glink_msg msg
;
337 msg
.cmd
= cpu_to_le16(RPM_CMD_VERSION_ACK
);
338 msg
.param1
= cpu_to_le16(GLINK_VERSION_1
);
339 msg
.param2
= cpu_to_le32(glink
->features
);
341 qcom_glink_tx(glink
, &msg
, sizeof(msg
), NULL
, 0, true);
344 static void qcom_glink_send_open_ack(struct qcom_glink
*glink
,
345 struct glink_channel
*channel
)
347 struct glink_msg msg
;
349 msg
.cmd
= cpu_to_le16(RPM_CMD_OPEN_ACK
);
350 msg
.param1
= cpu_to_le16(channel
->rcid
);
351 msg
.param2
= cpu_to_le32(0);
353 qcom_glink_tx(glink
, &msg
, sizeof(msg
), NULL
, 0, true);
356 static void qcom_glink_handle_intent_req_ack(struct qcom_glink
*glink
,
357 unsigned int cid
, bool granted
)
359 struct glink_channel
*channel
;
362 spin_lock_irqsave(&glink
->idr_lock
, flags
);
363 channel
= idr_find(&glink
->rcids
, cid
);
364 spin_unlock_irqrestore(&glink
->idr_lock
, flags
);
366 dev_err(glink
->dev
, "unable to find channel\n");
370 channel
->intent_req_result
= granted
;
371 complete(&channel
->intent_req_comp
);
375 * qcom_glink_send_open_req() - send a RPM_CMD_OPEN request to the remote
376 * @glink: Ptr to the glink edge
377 * @channel: Ptr to the channel that the open req is sent
379 * Allocates a local channel id and sends a RPM_CMD_OPEN message to the remote.
380 * Will return with refcount held, regardless of outcome.
382 * Returns 0 on success, negative errno otherwise.
384 static int qcom_glink_send_open_req(struct qcom_glink
*glink
,
385 struct glink_channel
*channel
)
388 struct glink_msg msg
;
389 u8 name
[GLINK_NAME_SIZE
];
391 int name_len
= strlen(channel
->name
) + 1;
392 int req_len
= ALIGN(sizeof(req
.msg
) + name_len
, 8);
396 kref_get(&channel
->refcount
);
398 spin_lock_irqsave(&glink
->idr_lock
, flags
);
399 ret
= idr_alloc_cyclic(&glink
->lcids
, channel
,
400 RPM_GLINK_CID_MIN
, RPM_GLINK_CID_MAX
,
402 spin_unlock_irqrestore(&glink
->idr_lock
, flags
);
408 req
.msg
.cmd
= cpu_to_le16(RPM_CMD_OPEN
);
409 req
.msg
.param1
= cpu_to_le16(channel
->lcid
);
410 req
.msg
.param2
= cpu_to_le32(name_len
);
411 strcpy(req
.name
, channel
->name
);
413 ret
= qcom_glink_tx(glink
, &req
, req_len
, NULL
, 0, true);
420 spin_lock_irqsave(&glink
->idr_lock
, flags
);
421 idr_remove(&glink
->lcids
, channel
->lcid
);
423 spin_unlock_irqrestore(&glink
->idr_lock
, flags
);
428 static void qcom_glink_send_close_req(struct qcom_glink
*glink
,
429 struct glink_channel
*channel
)
431 struct glink_msg req
;
433 req
.cmd
= cpu_to_le16(RPM_CMD_CLOSE
);
434 req
.param1
= cpu_to_le16(channel
->lcid
);
437 qcom_glink_tx(glink
, &req
, sizeof(req
), NULL
, 0, true);
440 static void qcom_glink_send_close_ack(struct qcom_glink
*glink
,
443 struct glink_msg req
;
445 req
.cmd
= cpu_to_le16(RPM_CMD_CLOSE_ACK
);
446 req
.param1
= cpu_to_le16(rcid
);
449 qcom_glink_tx(glink
, &req
, sizeof(req
), NULL
, 0, true);
452 static void qcom_glink_rx_done_work(struct work_struct
*work
)
454 struct glink_channel
*channel
= container_of(work
, struct glink_channel
,
456 struct qcom_glink
*glink
= channel
->glink
;
457 struct glink_core_rx_intent
*intent
, *tmp
;
464 unsigned int cid
= channel
->lcid
;
469 spin_lock_irqsave(&channel
->intent_lock
, flags
);
470 list_for_each_entry_safe(intent
, tmp
, &channel
->done_intents
, node
) {
471 list_del(&intent
->node
);
472 spin_unlock_irqrestore(&channel
->intent_lock
, flags
);
474 reuse
= intent
->reuse
;
476 cmd
.id
= reuse
? RPM_CMD_RX_DONE_W_REUSE
: RPM_CMD_RX_DONE
;
480 qcom_glink_tx(glink
, &cmd
, sizeof(cmd
), NULL
, 0, true);
485 spin_lock_irqsave(&channel
->intent_lock
, flags
);
487 spin_unlock_irqrestore(&channel
->intent_lock
, flags
);
490 static void qcom_glink_rx_done(struct qcom_glink
*glink
,
491 struct glink_channel
*channel
,
492 struct glink_core_rx_intent
*intent
)
494 /* We don't send RX_DONE to intentless systems */
495 if (glink
->intentless
) {
501 /* Take it off the tree of receive intents */
502 if (!intent
->reuse
) {
503 spin_lock(&channel
->intent_lock
);
504 idr_remove(&channel
->liids
, intent
->id
);
505 spin_unlock(&channel
->intent_lock
);
508 /* Schedule the sending of a rx_done indication */
509 spin_lock(&channel
->intent_lock
);
510 list_add_tail(&intent
->node
, &channel
->done_intents
);
511 spin_unlock(&channel
->intent_lock
);
513 schedule_work(&channel
->intent_work
);
517 * qcom_glink_receive_version() - receive version/features from remote system
519 * @glink: pointer to transport interface
520 * @version: remote version
521 * @features: remote features
523 * This function is called in response to a remote-initiated version/feature
524 * negotiation sequence.
526 static void qcom_glink_receive_version(struct qcom_glink
*glink
,
533 case GLINK_VERSION_1
:
534 glink
->features
&= features
;
537 qcom_glink_send_version_ack(glink
);
543 * qcom_glink_receive_version_ack() - receive negotiation ack from remote system
545 * @glink: pointer to transport interface
546 * @version: remote version response
547 * @features: remote features response
549 * This function is called in response to a local-initiated version/feature
550 * negotiation sequence and is the counter-offer from the remote side based
551 * upon the initial version and feature set requested.
553 static void qcom_glink_receive_version_ack(struct qcom_glink
*glink
,
559 /* Version negotiation failed */
561 case GLINK_VERSION_1
:
562 if (features
== glink
->features
)
565 glink
->features
&= features
;
568 qcom_glink_send_version(glink
);
574 * qcom_glink_send_intent_req_ack() - convert an rx intent request ack cmd to
575 * wire format and transmit
576 * @glink: The transport to transmit on.
577 * @channel: The glink channel
578 * @granted: The request response to encode.
580 * Return: 0 on success or standard Linux error code.
582 static int qcom_glink_send_intent_req_ack(struct qcom_glink
*glink
,
583 struct glink_channel
*channel
,
586 struct glink_msg msg
;
588 msg
.cmd
= cpu_to_le16(RPM_CMD_RX_INTENT_REQ_ACK
);
589 msg
.param1
= cpu_to_le16(channel
->lcid
);
590 msg
.param2
= cpu_to_le32(granted
);
592 qcom_glink_tx(glink
, &msg
, sizeof(msg
), NULL
, 0, true);
598 * qcom_glink_advertise_intent - convert an rx intent cmd to wire format and
600 * @glink: The transport to transmit on.
601 * @channel: The local channel
602 * @intent: The intent to pass on to remote.
604 * Return: 0 on success or standard Linux error code.
606 static int qcom_glink_advertise_intent(struct qcom_glink
*glink
,
607 struct glink_channel
*channel
,
608 struct glink_core_rx_intent
*intent
)
619 cmd
.id
= cpu_to_le16(RPM_CMD_INTENT
);
620 cmd
.lcid
= cpu_to_le16(channel
->lcid
);
621 cmd
.count
= cpu_to_le32(1);
622 cmd
.size
= cpu_to_le32(intent
->size
);
623 cmd
.liid
= cpu_to_le32(intent
->id
);
625 qcom_glink_tx(glink
, &cmd
, sizeof(cmd
), NULL
, 0, true);
630 static struct glink_core_rx_intent
*
631 qcom_glink_alloc_intent(struct qcom_glink
*glink
,
632 struct glink_channel
*channel
,
636 struct glink_core_rx_intent
*intent
;
640 intent
= kzalloc(sizeof(*intent
), GFP_KERNEL
);
644 intent
->data
= kzalloc(size
, GFP_KERNEL
);
648 spin_lock_irqsave(&channel
->intent_lock
, flags
);
649 ret
= idr_alloc_cyclic(&channel
->liids
, intent
, 1, -1, GFP_ATOMIC
);
651 spin_unlock_irqrestore(&channel
->intent_lock
, flags
);
654 spin_unlock_irqrestore(&channel
->intent_lock
, flags
);
658 intent
->reuse
= reuseable
;
669 static void qcom_glink_handle_rx_done(struct qcom_glink
*glink
,
670 u32 cid
, uint32_t iid
,
673 struct glink_core_rx_intent
*intent
;
674 struct glink_channel
*channel
;
677 spin_lock_irqsave(&glink
->idr_lock
, flags
);
678 channel
= idr_find(&glink
->rcids
, cid
);
679 spin_unlock_irqrestore(&glink
->idr_lock
, flags
);
681 dev_err(glink
->dev
, "invalid channel id received\n");
685 spin_lock_irqsave(&channel
->intent_lock
, flags
);
686 intent
= idr_find(&channel
->riids
, iid
);
689 spin_unlock_irqrestore(&channel
->intent_lock
, flags
);
690 dev_err(glink
->dev
, "invalid intent id received\n");
694 intent
->in_use
= false;
697 idr_remove(&channel
->riids
, intent
->id
);
700 spin_unlock_irqrestore(&channel
->intent_lock
, flags
);
704 * qcom_glink_handle_intent_req() - Receive a request for rx_intent
706 * @glink: Pointer to the transport interface
707 * @cid: Remote channel ID
708 * @size: size of the intent
710 * The function searches for the local channel to which the request for
711 * rx_intent has arrived and allocates and notifies the remote back
713 static void qcom_glink_handle_intent_req(struct qcom_glink
*glink
,
714 u32 cid
, size_t size
)
716 struct glink_core_rx_intent
*intent
;
717 struct glink_channel
*channel
;
720 spin_lock_irqsave(&glink
->idr_lock
, flags
);
721 channel
= idr_find(&glink
->rcids
, cid
);
722 spin_unlock_irqrestore(&glink
->idr_lock
, flags
);
725 pr_err("%s channel not found for cid %d\n", __func__
, cid
);
729 intent
= qcom_glink_alloc_intent(glink
, channel
, size
, false);
731 qcom_glink_advertise_intent(glink
, channel
, intent
);
733 qcom_glink_send_intent_req_ack(glink
, channel
, !!intent
);
736 static int qcom_glink_rx_defer(struct qcom_glink
*glink
, size_t extra
)
738 struct glink_defer_cmd
*dcmd
;
740 extra
= ALIGN(extra
, 8);
742 if (qcom_glink_rx_avail(glink
) < sizeof(struct glink_msg
) + extra
) {
743 dev_dbg(glink
->dev
, "Insufficient data in rx fifo");
747 dcmd
= kzalloc(sizeof(*dcmd
) + extra
, GFP_ATOMIC
);
751 INIT_LIST_HEAD(&dcmd
->node
);
753 qcom_glink_rx_peak(glink
, &dcmd
->msg
, 0, sizeof(dcmd
->msg
) + extra
);
755 spin_lock(&glink
->rx_lock
);
756 list_add_tail(&dcmd
->node
, &glink
->rx_queue
);
757 spin_unlock(&glink
->rx_lock
);
759 schedule_work(&glink
->rx_work
);
760 qcom_glink_rx_advance(glink
, sizeof(dcmd
->msg
) + extra
);
765 static int qcom_glink_rx_data(struct qcom_glink
*glink
, size_t avail
)
767 struct glink_core_rx_intent
*intent
;
768 struct glink_channel
*channel
;
770 struct glink_msg msg
;
774 unsigned int chunk_size
;
775 unsigned int left_size
;
781 if (avail
< sizeof(hdr
)) {
782 dev_dbg(glink
->dev
, "Not enough data in fifo\n");
786 qcom_glink_rx_peak(glink
, &hdr
, 0, sizeof(hdr
));
787 chunk_size
= le32_to_cpu(hdr
.chunk_size
);
788 left_size
= le32_to_cpu(hdr
.left_size
);
790 if (avail
< sizeof(hdr
) + chunk_size
) {
791 dev_dbg(glink
->dev
, "Payload not yet in fifo\n");
795 if (WARN(chunk_size
% 4, "Incoming data must be word aligned\n"))
798 rcid
= le16_to_cpu(hdr
.msg
.param1
);
799 spin_lock_irqsave(&glink
->idr_lock
, flags
);
800 channel
= idr_find(&glink
->rcids
, rcid
);
801 spin_unlock_irqrestore(&glink
->idr_lock
, flags
);
803 dev_dbg(glink
->dev
, "Data on non-existing channel\n");
805 /* Drop the message */
809 if (glink
->intentless
) {
810 /* Might have an ongoing, fragmented, message to append */
812 intent
= kzalloc(sizeof(*intent
), GFP_ATOMIC
);
816 intent
->data
= kmalloc(chunk_size
+ left_size
,
823 intent
->id
= 0xbabababa;
824 intent
->size
= chunk_size
+ left_size
;
827 channel
->buf
= intent
;
829 intent
= channel
->buf
;
832 liid
= le32_to_cpu(hdr
.msg
.param2
);
834 spin_lock_irqsave(&channel
->intent_lock
, flags
);
835 intent
= idr_find(&channel
->liids
, liid
);
836 spin_unlock_irqrestore(&channel
->intent_lock
, flags
);
840 "no intent found for channel %s intent %d",
841 channel
->name
, liid
);
846 if (intent
->size
- intent
->offset
< chunk_size
) {
847 dev_err(glink
->dev
, "Insufficient space in intent\n");
849 /* The packet header lied, drop payload */
853 qcom_glink_rx_peak(glink
, intent
->data
+ intent
->offset
,
854 sizeof(hdr
), chunk_size
);
855 intent
->offset
+= chunk_size
;
857 /* Handle message when no fragments remain to be received */
859 spin_lock(&channel
->recv_lock
);
860 if (channel
->ept
.cb
) {
861 channel
->ept
.cb(channel
->ept
.rpdev
,
867 spin_unlock(&channel
->recv_lock
);
872 qcom_glink_rx_done(glink
, channel
, intent
);
876 qcom_glink_rx_advance(glink
, ALIGN(sizeof(hdr
) + chunk_size
, 8));
881 static void qcom_glink_handle_intent(struct qcom_glink
*glink
,
886 struct glink_core_rx_intent
*intent
;
887 struct glink_channel
*channel
;
894 struct glink_msg msg
;
895 struct intent_pair intents
[];
898 const size_t msglen
= sizeof(*msg
) + sizeof(struct intent_pair
) * count
;
903 if (avail
< msglen
) {
904 dev_dbg(glink
->dev
, "Not enough data in fifo\n");
908 spin_lock_irqsave(&glink
->idr_lock
, flags
);
909 channel
= idr_find(&glink
->rcids
, cid
);
910 spin_unlock_irqrestore(&glink
->idr_lock
, flags
);
912 dev_err(glink
->dev
, "intents for non-existing channel\n");
916 msg
= kmalloc(msglen
, GFP_ATOMIC
);
920 qcom_glink_rx_peak(glink
, msg
, 0, msglen
);
922 for (i
= 0; i
< count
; ++i
) {
923 intent
= kzalloc(sizeof(*intent
), GFP_ATOMIC
);
927 intent
->id
= le32_to_cpu(msg
->intents
[i
].iid
);
928 intent
->size
= le32_to_cpu(msg
->intents
[i
].size
);
930 spin_lock_irqsave(&channel
->intent_lock
, flags
);
931 ret
= idr_alloc(&channel
->riids
, intent
,
932 intent
->id
, intent
->id
+ 1, GFP_ATOMIC
);
933 spin_unlock_irqrestore(&channel
->intent_lock
, flags
);
936 dev_err(glink
->dev
, "failed to store remote intent\n");
940 qcom_glink_rx_advance(glink
, ALIGN(msglen
, 8));
943 static int qcom_glink_rx_open_ack(struct qcom_glink
*glink
, unsigned int lcid
)
945 struct glink_channel
*channel
;
947 spin_lock(&glink
->idr_lock
);
948 channel
= idr_find(&glink
->lcids
, lcid
);
949 spin_unlock(&glink
->idr_lock
);
951 dev_err(glink
->dev
, "Invalid open ack packet\n");
955 complete(&channel
->open_ack
);
960 static irqreturn_t
qcom_glink_native_intr(int irq
, void *data
)
962 struct qcom_glink
*glink
= data
;
963 struct glink_msg msg
;
971 avail
= qcom_glink_rx_avail(glink
);
972 if (avail
< sizeof(msg
))
975 qcom_glink_rx_peak(glink
, &msg
, 0, sizeof(msg
));
977 cmd
= le16_to_cpu(msg
.cmd
);
978 param1
= le16_to_cpu(msg
.param1
);
979 param2
= le32_to_cpu(msg
.param2
);
982 case RPM_CMD_VERSION
:
983 case RPM_CMD_VERSION_ACK
:
985 case RPM_CMD_CLOSE_ACK
:
986 case RPM_CMD_RX_INTENT_REQ
:
987 ret
= qcom_glink_rx_defer(glink
, 0);
989 case RPM_CMD_OPEN_ACK
:
990 ret
= qcom_glink_rx_open_ack(glink
, param1
);
991 qcom_glink_rx_advance(glink
, ALIGN(sizeof(msg
), 8));
994 ret
= qcom_glink_rx_defer(glink
, param2
);
996 case RPM_CMD_TX_DATA
:
997 case RPM_CMD_TX_DATA_CONT
:
998 ret
= qcom_glink_rx_data(glink
, avail
);
1000 case RPM_CMD_READ_NOTIF
:
1001 qcom_glink_rx_advance(glink
, ALIGN(sizeof(msg
), 8));
1003 mbox_send_message(glink
->mbox_chan
, NULL
);
1004 mbox_client_txdone(glink
->mbox_chan
, 0);
1006 case RPM_CMD_INTENT
:
1007 qcom_glink_handle_intent(glink
, param1
, param2
, avail
);
1009 case RPM_CMD_RX_DONE
:
1010 qcom_glink_handle_rx_done(glink
, param1
, param2
, false);
1011 qcom_glink_rx_advance(glink
, ALIGN(sizeof(msg
), 8));
1013 case RPM_CMD_RX_DONE_W_REUSE
:
1014 qcom_glink_handle_rx_done(glink
, param1
, param2
, true);
1015 qcom_glink_rx_advance(glink
, ALIGN(sizeof(msg
), 8));
1017 case RPM_CMD_RX_INTENT_REQ_ACK
:
1018 qcom_glink_handle_intent_req_ack(glink
, param1
, param2
);
1019 qcom_glink_rx_advance(glink
, ALIGN(sizeof(msg
), 8));
1022 dev_err(glink
->dev
, "unhandled rx cmd: %d\n", cmd
);
1034 /* Locally initiated rpmsg_create_ept */
1035 static struct glink_channel
*qcom_glink_create_local(struct qcom_glink
*glink
,
1038 struct glink_channel
*channel
;
1040 unsigned long flags
;
1042 channel
= qcom_glink_alloc_channel(glink
, name
);
1043 if (IS_ERR(channel
))
1044 return ERR_CAST(channel
);
1046 ret
= qcom_glink_send_open_req(glink
, channel
);
1048 goto release_channel
;
1050 ret
= wait_for_completion_timeout(&channel
->open_ack
, 5 * HZ
);
1054 ret
= wait_for_completion_timeout(&channel
->open_req
, 5 * HZ
);
1058 qcom_glink_send_open_ack(glink
, channel
);
1063 /* qcom_glink_send_open_req() did register the channel in lcids*/
1064 spin_lock_irqsave(&glink
->idr_lock
, flags
);
1065 idr_remove(&glink
->lcids
, channel
->lcid
);
1066 spin_unlock_irqrestore(&glink
->idr_lock
, flags
);
1069 /* Release qcom_glink_send_open_req() reference */
1070 kref_put(&channel
->refcount
, qcom_glink_channel_release
);
1071 /* Release qcom_glink_alloc_channel() reference */
1072 kref_put(&channel
->refcount
, qcom_glink_channel_release
);
1074 return ERR_PTR(-ETIMEDOUT
);
1077 /* Remote initiated rpmsg_create_ept */
1078 static int qcom_glink_create_remote(struct qcom_glink
*glink
,
1079 struct glink_channel
*channel
)
1083 qcom_glink_send_open_ack(glink
, channel
);
1085 ret
= qcom_glink_send_open_req(glink
, channel
);
1089 ret
= wait_for_completion_timeout(&channel
->open_ack
, 5 * HZ
);
1099 * Send a close request to "undo" our open-ack. The close-ack will
1100 * release the last reference.
1102 qcom_glink_send_close_req(glink
, channel
);
1104 /* Release qcom_glink_send_open_req() reference */
1105 kref_put(&channel
->refcount
, qcom_glink_channel_release
);
1110 static struct rpmsg_endpoint
*qcom_glink_create_ept(struct rpmsg_device
*rpdev
,
1113 struct rpmsg_channel_info
1116 struct glink_channel
*parent
= to_glink_channel(rpdev
->ept
);
1117 struct glink_channel
*channel
;
1118 struct qcom_glink
*glink
= parent
->glink
;
1119 struct rpmsg_endpoint
*ept
;
1120 const char *name
= chinfo
.name
;
1123 unsigned long flags
;
1125 spin_lock_irqsave(&glink
->idr_lock
, flags
);
1126 idr_for_each_entry(&glink
->rcids
, channel
, cid
) {
1127 if (!strcmp(channel
->name
, name
))
1130 spin_unlock_irqrestore(&glink
->idr_lock
, flags
);
1133 channel
= qcom_glink_create_local(glink
, name
);
1134 if (IS_ERR(channel
))
1137 ret
= qcom_glink_create_remote(glink
, channel
);
1142 ept
= &channel
->ept
;
1146 ept
->ops
= &glink_endpoint_ops
;
1151 static int qcom_glink_announce_create(struct rpmsg_device
*rpdev
)
1153 struct glink_channel
*channel
= to_glink_channel(rpdev
->ept
);
1154 struct device_node
*np
= rpdev
->dev
.of_node
;
1155 struct qcom_glink
*glink
= channel
->glink
;
1156 struct glink_core_rx_intent
*intent
;
1157 const struct property
*prop
= NULL
;
1158 __be32 defaults
[] = { cpu_to_be32(SZ_1K
), cpu_to_be32(5) };
1161 __be32
*val
= defaults
;
1164 if (glink
->intentless
)
1167 prop
= of_find_property(np
, "qcom,intents", NULL
);
1170 num_groups
= prop
->length
/ sizeof(u32
) / 2;
1173 /* Channel is now open, advertise base set of intents */
1174 while (num_groups
--) {
1175 size
= be32_to_cpup(val
++);
1176 num_intents
= be32_to_cpup(val
++);
1177 while (num_intents
--) {
1178 intent
= qcom_glink_alloc_intent(glink
, channel
, size
,
1183 qcom_glink_advertise_intent(glink
, channel
, intent
);
1189 static void qcom_glink_destroy_ept(struct rpmsg_endpoint
*ept
)
1191 struct glink_channel
*channel
= to_glink_channel(ept
);
1192 struct qcom_glink
*glink
= channel
->glink
;
1193 unsigned long flags
;
1195 spin_lock_irqsave(&channel
->recv_lock
, flags
);
1196 channel
->ept
.cb
= NULL
;
1197 spin_unlock_irqrestore(&channel
->recv_lock
, flags
);
1199 /* Decouple the potential rpdev from the channel */
1200 channel
->rpdev
= NULL
;
1202 qcom_glink_send_close_req(glink
, channel
);
1205 static int qcom_glink_request_intent(struct qcom_glink
*glink
,
1206 struct glink_channel
*channel
,
1217 mutex_lock(&channel
->intent_req_lock
);
1219 reinit_completion(&channel
->intent_req_comp
);
1221 cmd
.id
= RPM_CMD_RX_INTENT_REQ
;
1222 cmd
.cid
= channel
->lcid
;
1225 ret
= qcom_glink_tx(glink
, &cmd
, sizeof(cmd
), NULL
, 0, true);
1229 ret
= wait_for_completion_timeout(&channel
->intent_req_comp
, 10 * HZ
);
1231 dev_err(glink
->dev
, "intent request timed out\n");
1234 ret
= channel
->intent_req_result
? 0 : -ECANCELED
;
1238 mutex_unlock(&channel
->intent_req_lock
);
1242 static int __qcom_glink_send(struct glink_channel
*channel
,
1243 void *data
, int len
, bool wait
)
1245 struct qcom_glink
*glink
= channel
->glink
;
1246 struct glink_core_rx_intent
*intent
= NULL
;
1247 struct glink_core_rx_intent
*tmp
;
1250 struct glink_msg msg
;
1255 unsigned long flags
;
1257 if (!glink
->intentless
) {
1259 spin_lock_irqsave(&channel
->intent_lock
, flags
);
1260 idr_for_each_entry(&channel
->riids
, tmp
, iid
) {
1261 if (tmp
->size
>= len
&& !tmp
->in_use
) {
1264 else if (intent
->size
> tmp
->size
)
1266 if (intent
->size
== len
)
1271 intent
->in_use
= true;
1272 spin_unlock_irqrestore(&channel
->intent_lock
, flags
);
1274 /* We found an available intent */
1281 ret
= qcom_glink_request_intent(glink
, channel
, len
);
1289 req
.msg
.cmd
= cpu_to_le16(RPM_CMD_TX_DATA
);
1290 req
.msg
.param1
= cpu_to_le16(channel
->lcid
);
1291 req
.msg
.param2
= cpu_to_le32(iid
);
1292 req
.chunk_size
= cpu_to_le32(len
);
1293 req
.left_size
= cpu_to_le32(0);
1295 ret
= qcom_glink_tx(glink
, &req
, sizeof(req
), data
, len
, wait
);
1297 /* Mark intent available if we failed */
1299 intent
->in_use
= false;
1304 static int qcom_glink_send(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
, true);
1311 static int qcom_glink_trysend(struct rpmsg_endpoint
*ept
, void *data
, int len
)
1313 struct glink_channel
*channel
= to_glink_channel(ept
);
1315 return __qcom_glink_send(channel
, data
, len
, false);
1319 * Finds the device_node for the glink child interested in this channel.
1321 static struct device_node
*qcom_glink_match_channel(struct device_node
*node
,
1322 const char *channel
)
1324 struct device_node
*child
;
1329 for_each_available_child_of_node(node
, child
) {
1330 key
= "qcom,glink-channels";
1331 ret
= of_property_read_string(child
, key
, &name
);
1335 if (strcmp(name
, channel
) == 0)
1342 static const struct rpmsg_device_ops glink_device_ops
= {
1343 .create_ept
= qcom_glink_create_ept
,
1344 .announce_create
= qcom_glink_announce_create
,
1347 static const struct rpmsg_endpoint_ops glink_endpoint_ops
= {
1348 .destroy_ept
= qcom_glink_destroy_ept
,
1349 .send
= qcom_glink_send
,
1350 .trysend
= qcom_glink_trysend
,
1353 static void qcom_glink_rpdev_release(struct device
*dev
)
1355 struct rpmsg_device
*rpdev
= to_rpmsg_device(dev
);
1356 struct glink_channel
*channel
= to_glink_channel(rpdev
->ept
);
1358 channel
->rpdev
= NULL
;
1362 static int qcom_glink_rx_open(struct qcom_glink
*glink
, unsigned int rcid
,
1365 struct glink_channel
*channel
;
1366 struct rpmsg_device
*rpdev
;
1367 bool create_device
= false;
1368 struct device_node
*node
;
1371 unsigned long flags
;
1373 spin_lock_irqsave(&glink
->idr_lock
, flags
);
1374 idr_for_each_entry(&glink
->lcids
, channel
, lcid
) {
1375 if (!strcmp(channel
->name
, name
))
1378 spin_unlock_irqrestore(&glink
->idr_lock
, flags
);
1381 channel
= qcom_glink_alloc_channel(glink
, name
);
1382 if (IS_ERR(channel
))
1383 return PTR_ERR(channel
);
1385 /* The opening dance was initiated by the remote */
1386 create_device
= true;
1389 spin_lock_irqsave(&glink
->idr_lock
, flags
);
1390 ret
= idr_alloc(&glink
->rcids
, channel
, rcid
, rcid
+ 1, GFP_ATOMIC
);
1392 dev_err(glink
->dev
, "Unable to insert channel into rcid list\n");
1393 spin_unlock_irqrestore(&glink
->idr_lock
, flags
);
1396 channel
->rcid
= ret
;
1397 spin_unlock_irqrestore(&glink
->idr_lock
, flags
);
1399 complete(&channel
->open_req
);
1401 if (create_device
) {
1402 rpdev
= kzalloc(sizeof(*rpdev
), GFP_KERNEL
);
1408 rpdev
->ept
= &channel
->ept
;
1409 strncpy(rpdev
->id
.name
, name
, RPMSG_NAME_SIZE
);
1410 rpdev
->src
= RPMSG_ADDR_ANY
;
1411 rpdev
->dst
= RPMSG_ADDR_ANY
;
1412 rpdev
->ops
= &glink_device_ops
;
1414 node
= qcom_glink_match_channel(glink
->dev
->of_node
, name
);
1415 rpdev
->dev
.of_node
= node
;
1416 rpdev
->dev
.parent
= glink
->dev
;
1417 rpdev
->dev
.release
= qcom_glink_rpdev_release
;
1419 ret
= rpmsg_register_device(rpdev
);
1423 channel
->rpdev
= rpdev
;
1431 spin_lock_irqsave(&glink
->idr_lock
, flags
);
1432 idr_remove(&glink
->rcids
, channel
->rcid
);
1434 spin_unlock_irqrestore(&glink
->idr_lock
, flags
);
1436 /* Release the reference, iff we took it */
1438 kref_put(&channel
->refcount
, qcom_glink_channel_release
);
1443 static void qcom_glink_rx_close(struct qcom_glink
*glink
, unsigned int rcid
)
1445 struct rpmsg_channel_info chinfo
;
1446 struct glink_channel
*channel
;
1447 unsigned long flags
;
1449 spin_lock_irqsave(&glink
->idr_lock
, flags
);
1450 channel
= idr_find(&glink
->rcids
, rcid
);
1451 spin_unlock_irqrestore(&glink
->idr_lock
, flags
);
1452 if (WARN(!channel
, "close request on unknown channel\n"))
1455 /* cancel pending rx_done work */
1456 cancel_work_sync(&channel
->intent_work
);
1458 if (channel
->rpdev
) {
1459 strncpy(chinfo
.name
, channel
->name
, sizeof(chinfo
.name
));
1460 chinfo
.src
= RPMSG_ADDR_ANY
;
1461 chinfo
.dst
= RPMSG_ADDR_ANY
;
1463 rpmsg_unregister_device(glink
->dev
, &chinfo
);
1466 qcom_glink_send_close_ack(glink
, channel
->rcid
);
1468 spin_lock_irqsave(&glink
->idr_lock
, flags
);
1469 idr_remove(&glink
->rcids
, channel
->rcid
);
1471 spin_unlock_irqrestore(&glink
->idr_lock
, flags
);
1473 kref_put(&channel
->refcount
, qcom_glink_channel_release
);
1476 static void qcom_glink_rx_close_ack(struct qcom_glink
*glink
, unsigned int lcid
)
1478 struct glink_channel
*channel
;
1479 unsigned long flags
;
1481 spin_lock_irqsave(&glink
->idr_lock
, flags
);
1482 channel
= idr_find(&glink
->lcids
, lcid
);
1483 if (WARN(!channel
, "close ack on unknown channel\n")) {
1484 spin_unlock_irqrestore(&glink
->idr_lock
, flags
);
1488 idr_remove(&glink
->lcids
, channel
->lcid
);
1490 spin_unlock_irqrestore(&glink
->idr_lock
, flags
);
1492 kref_put(&channel
->refcount
, qcom_glink_channel_release
);
1495 static void qcom_glink_work(struct work_struct
*work
)
1497 struct qcom_glink
*glink
= container_of(work
, struct qcom_glink
,
1499 struct glink_defer_cmd
*dcmd
;
1500 struct glink_msg
*msg
;
1501 unsigned long flags
;
1502 unsigned int param1
;
1503 unsigned int param2
;
1507 spin_lock_irqsave(&glink
->rx_lock
, flags
);
1508 if (list_empty(&glink
->rx_queue
)) {
1509 spin_unlock_irqrestore(&glink
->rx_lock
, flags
);
1512 dcmd
= list_first_entry(&glink
->rx_queue
,
1513 struct glink_defer_cmd
, node
);
1514 list_del(&dcmd
->node
);
1515 spin_unlock_irqrestore(&glink
->rx_lock
, flags
);
1518 cmd
= le16_to_cpu(msg
->cmd
);
1519 param1
= le16_to_cpu(msg
->param1
);
1520 param2
= le32_to_cpu(msg
->param2
);
1523 case RPM_CMD_VERSION
:
1524 qcom_glink_receive_version(glink
, param1
, param2
);
1526 case RPM_CMD_VERSION_ACK
:
1527 qcom_glink_receive_version_ack(glink
, param1
, param2
);
1530 qcom_glink_rx_open(glink
, param1
, msg
->data
);
1533 qcom_glink_rx_close(glink
, param1
);
1535 case RPM_CMD_CLOSE_ACK
:
1536 qcom_glink_rx_close_ack(glink
, param1
);
1538 case RPM_CMD_RX_INTENT_REQ
:
1539 qcom_glink_handle_intent_req(glink
, param1
, param2
);
1542 WARN(1, "Unknown defer object %d\n", cmd
);
1550 struct qcom_glink
*qcom_glink_native_probe(struct device
*dev
,
1551 unsigned long features
,
1552 struct qcom_glink_pipe
*rx
,
1553 struct qcom_glink_pipe
*tx
,
1558 struct qcom_glink
*glink
;
1560 glink
= devm_kzalloc(dev
, sizeof(*glink
), GFP_KERNEL
);
1562 return ERR_PTR(-ENOMEM
);
1565 glink
->tx_pipe
= tx
;
1566 glink
->rx_pipe
= rx
;
1568 glink
->features
= features
;
1569 glink
->intentless
= intentless
;
1571 spin_lock_init(&glink
->tx_lock
);
1572 spin_lock_init(&glink
->rx_lock
);
1573 INIT_LIST_HEAD(&glink
->rx_queue
);
1574 INIT_WORK(&glink
->rx_work
, qcom_glink_work
);
1576 spin_lock_init(&glink
->idr_lock
);
1577 idr_init(&glink
->lcids
);
1578 idr_init(&glink
->rcids
);
1580 ret
= of_property_read_string(dev
->of_node
, "label", &glink
->name
);
1582 glink
->name
= dev
->of_node
->name
;
1584 glink
->mbox_client
.dev
= dev
;
1585 glink
->mbox_client
.knows_txdone
= true;
1586 glink
->mbox_chan
= mbox_request_channel(&glink
->mbox_client
, 0);
1587 if (IS_ERR(glink
->mbox_chan
)) {
1588 if (PTR_ERR(glink
->mbox_chan
) != -EPROBE_DEFER
)
1589 dev_err(dev
, "failed to acquire IPC channel\n");
1590 return ERR_CAST(glink
->mbox_chan
);
1593 irq
= of_irq_get(dev
->of_node
, 0);
1594 ret
= devm_request_irq(dev
, irq
,
1595 qcom_glink_native_intr
,
1596 IRQF_NO_SUSPEND
| IRQF_SHARED
,
1597 "glink-native", glink
);
1599 dev_err(dev
, "failed to request IRQ\n");
1600 return ERR_PTR(ret
);
1605 ret
= qcom_glink_send_version(glink
);
1607 return ERR_PTR(ret
);
1611 EXPORT_SYMBOL_GPL(qcom_glink_native_probe
);
1613 static int qcom_glink_remove_device(struct device
*dev
, void *data
)
1615 device_unregister(dev
);
1620 void qcom_glink_native_remove(struct qcom_glink
*glink
)
1622 struct glink_channel
*channel
;
1625 unsigned long flags
;
1627 disable_irq(glink
->irq
);
1628 cancel_work_sync(&glink
->rx_work
);
1630 ret
= device_for_each_child(glink
->dev
, NULL
, qcom_glink_remove_device
);
1632 dev_warn(glink
->dev
, "Can't remove GLINK devices: %d\n", ret
);
1634 spin_lock_irqsave(&glink
->idr_lock
, flags
);
1635 /* Release any defunct local channels, waiting for close-ack */
1636 idr_for_each_entry(&glink
->lcids
, channel
, cid
)
1637 kref_put(&channel
->refcount
, qcom_glink_channel_release
);
1639 idr_destroy(&glink
->lcids
);
1640 idr_destroy(&glink
->rcids
);
1641 spin_unlock_irqrestore(&glink
->idr_lock
, flags
);
1642 mbox_free_channel(glink
->mbox_chan
);
1644 EXPORT_SYMBOL_GPL(qcom_glink_native_remove
);
1646 void qcom_glink_native_unregister(struct qcom_glink
*glink
)
1648 device_unregister(glink
->dev
);
1650 EXPORT_SYMBOL_GPL(qcom_glink_native_unregister
);
1652 MODULE_DESCRIPTION("Qualcomm GLINK driver");
1653 MODULE_LICENSE("GPL v2");