1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (c) 2015, Sony Mobile Communications AB.
4 * Copyright (c) 2012-2013, The Linux Foundation. All rights reserved.
7 #include <linux/interrupt.h>
9 #include <linux/mailbox_client.h>
10 #include <linux/mfd/syscon.h>
11 #include <linux/module.h>
12 #include <linux/of_irq.h>
13 #include <linux/of_platform.h>
14 #include <linux/platform_device.h>
15 #include <linux/regmap.h>
16 #include <linux/sched.h>
17 #include <linux/sizes.h>
18 #include <linux/slab.h>
19 #include <linux/soc/qcom/smem.h>
20 #include <linux/wait.h>
21 #include <linux/rpmsg.h>
22 #include <linux/rpmsg/qcom_smd.h>
24 #include "rpmsg_internal.h"
27 * The Qualcomm Shared Memory communication solution provides point-to-point
28 * channels for clients to send and receive streaming or packet based data.
30 * Each channel consists of a control item (channel info) and a ring buffer
31 * pair. The channel info carry information related to channel state, flow
32 * control and the offsets within the ring buffer.
34 * All allocated channels are listed in an allocation table, identifying the
35 * pair of items by name, type and remote processor.
37 * Upon creating a new channel the remote processor allocates channel info and
38 * ring buffer items from the smem heap and populate the allocation table. An
39 * interrupt is sent to the other end of the channel and a scan for new
40 * channels should be done. A channel never goes away, it will only change
43 * The remote processor signals it intent for bring up the communication
44 * channel by setting the state of its end of the channel to "opening" and
45 * sends out an interrupt. We detect this change and register a smd device to
46 * consume the channel. Upon finding a consumer we finish the handshake and the
49 * Upon closing a channel, the remote processor will update the state of its
50 * end of the channel and signal us, we will then unregister any attached
51 * device and close our end of the channel.
53 * Devices attached to a channel can use the qcom_smd_send function to push
54 * data to the channel, this is done by copying the data into the tx ring
55 * buffer, updating the pointers in the channel info and signaling the remote
58 * The remote processor does the equivalent when it transfer data and upon
59 * receiving the interrupt we check the channel info for new data and delivers
60 * this to the attached device. If the device is not ready to receive the data
61 * we leave it in the ring buffer for now.
64 struct smd_channel_info
;
65 struct smd_channel_info_pair
;
66 struct smd_channel_info_word
;
67 struct smd_channel_info_word_pair
;
69 static const struct rpmsg_endpoint_ops qcom_smd_endpoint_ops
;
71 #define SMD_ALLOC_TBL_COUNT 2
72 #define SMD_ALLOC_TBL_SIZE 64
75 * This lists the various smem heap items relevant for the allocation table and
76 * smd channel entries.
79 unsigned alloc_tbl_id
;
80 unsigned info_base_id
;
81 unsigned fifo_base_id
;
82 } smem_items
[SMD_ALLOC_TBL_COUNT
] = {
96 * struct qcom_smd_edge - representing a remote processor
97 * @dev: device associated with this edge
98 * @name: name of this edge
99 * @of_node: of_node handle for information related to this edge
100 * @edge_id: identifier of this edge
101 * @remote_pid: identifier of remote processor
102 * @irq: interrupt for signals on this edge
103 * @ipc_regmap: regmap handle holding the outgoing ipc register
104 * @ipc_offset: offset within @ipc_regmap of the register for ipc
105 * @ipc_bit: bit in the register at @ipc_offset of @ipc_regmap
106 * @mbox_client: mailbox client handle
107 * @mbox_chan: apcs ipc mailbox channel handle
108 * @channels: list of all channels detected on this edge
109 * @channels_lock: guard for modifications of @channels
110 * @allocated: array of bitmaps representing already allocated channels
111 * @smem_available: last available amount of smem triggering a channel scan
112 * @new_channel_event: wait queue for new channel events
113 * @scan_work: work item for discovering new channels
114 * @state_work: work item for edge state changes
116 struct qcom_smd_edge
{
121 struct device_node
*of_node
;
127 struct regmap
*ipc_regmap
;
131 struct mbox_client mbox_client
;
132 struct mbox_chan
*mbox_chan
;
134 struct list_head channels
;
135 spinlock_t channels_lock
;
137 DECLARE_BITMAP(allocated
[SMD_ALLOC_TBL_COUNT
], SMD_ALLOC_TBL_SIZE
);
139 unsigned smem_available
;
141 wait_queue_head_t new_channel_event
;
143 struct work_struct scan_work
;
144 struct work_struct state_work
;
148 * SMD channel states.
150 enum smd_channel_state
{
154 SMD_CHANNEL_FLUSHING
,
157 SMD_CHANNEL_RESET_OPENING
160 struct qcom_smd_device
{
161 struct rpmsg_device rpdev
;
163 struct qcom_smd_edge
*edge
;
166 struct qcom_smd_endpoint
{
167 struct rpmsg_endpoint ept
;
169 struct qcom_smd_channel
*qsch
;
172 #define to_smd_device(r) container_of(r, struct qcom_smd_device, rpdev)
173 #define to_smd_edge(d) container_of(d, struct qcom_smd_edge, dev)
174 #define to_smd_endpoint(e) container_of(e, struct qcom_smd_endpoint, ept)
177 * struct qcom_smd_channel - smd channel struct
178 * @edge: qcom_smd_edge this channel is living on
179 * @qsept: reference to a associated smd endpoint
180 * @registered: flag to indicate if the channel is registered
181 * @name: name of the channel
182 * @state: local state of the channel
183 * @remote_state: remote state of the channel
184 * @state_change_event: state change event
185 * @info: byte aligned outgoing/incoming channel info
186 * @info_word: word aligned outgoing/incoming channel info
187 * @tx_lock: lock to make writes to the channel mutually exclusive
188 * @fblockread_event: wakeup event tied to tx fBLOCKREADINTR
189 * @tx_fifo: pointer to the outgoing ring buffer
190 * @rx_fifo: pointer to the incoming ring buffer
191 * @fifo_size: size of each ring buffer
192 * @bounce_buffer: bounce buffer for reading wrapped packets
193 * @cb: callback function registered for this channel
194 * @recv_lock: guard for rx info modifications and cb pointer
195 * @pkt_size: size of the currently handled packet
196 * @drvdata: driver private data
197 * @list: lite entry for @channels in qcom_smd_edge
199 struct qcom_smd_channel
{
200 struct qcom_smd_edge
*edge
;
202 struct qcom_smd_endpoint
*qsept
;
206 enum smd_channel_state state
;
207 enum smd_channel_state remote_state
;
208 wait_queue_head_t state_change_event
;
210 struct smd_channel_info_pair
*info
;
211 struct smd_channel_info_word_pair
*info_word
;
214 wait_queue_head_t fblockread_event
;
222 spinlock_t recv_lock
;
228 struct list_head list
;
232 * Format of the smd_info smem items, for byte aligned channels.
234 struct smd_channel_info
{
248 struct smd_channel_info_pair
{
249 struct smd_channel_info tx
;
250 struct smd_channel_info rx
;
254 * Format of the smd_info smem items, for word aligned channels.
256 struct smd_channel_info_word
{
265 __le32 fBLOCKREADINTR
;
270 struct smd_channel_info_word_pair
{
271 struct smd_channel_info_word tx
;
272 struct smd_channel_info_word rx
;
275 #define GET_RX_CHANNEL_FLAG(channel, param) \
277 BUILD_BUG_ON(sizeof(channel->info->rx.param) != sizeof(u8)); \
278 channel->info_word ? \
279 le32_to_cpu(channel->info_word->rx.param) : \
280 channel->info->rx.param; \
283 #define GET_RX_CHANNEL_INFO(channel, param) \
285 BUILD_BUG_ON(sizeof(channel->info->rx.param) != sizeof(u32)); \
286 le32_to_cpu(channel->info_word ? \
287 channel->info_word->rx.param : \
288 channel->info->rx.param); \
291 #define SET_RX_CHANNEL_FLAG(channel, param, value) \
293 BUILD_BUG_ON(sizeof(channel->info->rx.param) != sizeof(u8)); \
294 if (channel->info_word) \
295 channel->info_word->rx.param = cpu_to_le32(value); \
297 channel->info->rx.param = value; \
300 #define SET_RX_CHANNEL_INFO(channel, param, value) \
302 BUILD_BUG_ON(sizeof(channel->info->rx.param) != sizeof(u32)); \
303 if (channel->info_word) \
304 channel->info_word->rx.param = cpu_to_le32(value); \
306 channel->info->rx.param = cpu_to_le32(value); \
309 #define GET_TX_CHANNEL_FLAG(channel, param) \
311 BUILD_BUG_ON(sizeof(channel->info->tx.param) != sizeof(u8)); \
312 channel->info_word ? \
313 le32_to_cpu(channel->info_word->tx.param) : \
314 channel->info->tx.param; \
317 #define GET_TX_CHANNEL_INFO(channel, param) \
319 BUILD_BUG_ON(sizeof(channel->info->tx.param) != sizeof(u32)); \
320 le32_to_cpu(channel->info_word ? \
321 channel->info_word->tx.param : \
322 channel->info->tx.param); \
325 #define SET_TX_CHANNEL_FLAG(channel, param, value) \
327 BUILD_BUG_ON(sizeof(channel->info->tx.param) != sizeof(u8)); \
328 if (channel->info_word) \
329 channel->info_word->tx.param = cpu_to_le32(value); \
331 channel->info->tx.param = value; \
334 #define SET_TX_CHANNEL_INFO(channel, param, value) \
336 BUILD_BUG_ON(sizeof(channel->info->tx.param) != sizeof(u32)); \
337 if (channel->info_word) \
338 channel->info_word->tx.param = cpu_to_le32(value); \
340 channel->info->tx.param = cpu_to_le32(value); \
344 * struct qcom_smd_alloc_entry - channel allocation entry
345 * @name: channel name
346 * @cid: channel index
347 * @flags: channel flags and edge id
348 * @ref_count: reference count of the channel
350 struct qcom_smd_alloc_entry
{
357 #define SMD_CHANNEL_FLAGS_EDGE_MASK 0xff
358 #define SMD_CHANNEL_FLAGS_STREAM BIT(8)
359 #define SMD_CHANNEL_FLAGS_PACKET BIT(9)
362 * Each smd packet contains a 20 byte header, with the first 4 being the length
365 #define SMD_PACKET_HEADER_LEN 20
368 * Signal the remote processor associated with 'channel'.
370 static void qcom_smd_signal_channel(struct qcom_smd_channel
*channel
)
372 struct qcom_smd_edge
*edge
= channel
->edge
;
374 if (edge
->mbox_chan
) {
376 * We can ignore a failing mbox_send_message() as the only
377 * possible cause is that the FIFO in the framework is full of
378 * other writes to the same bit.
380 mbox_send_message(edge
->mbox_chan
, NULL
);
381 mbox_client_txdone(edge
->mbox_chan
, 0);
383 regmap_write(edge
->ipc_regmap
, edge
->ipc_offset
, BIT(edge
->ipc_bit
));
388 * Initialize the tx channel info
390 static void qcom_smd_channel_reset(struct qcom_smd_channel
*channel
)
392 SET_TX_CHANNEL_INFO(channel
, state
, SMD_CHANNEL_CLOSED
);
393 SET_TX_CHANNEL_FLAG(channel
, fDSR
, 0);
394 SET_TX_CHANNEL_FLAG(channel
, fCTS
, 0);
395 SET_TX_CHANNEL_FLAG(channel
, fCD
, 0);
396 SET_TX_CHANNEL_FLAG(channel
, fRI
, 0);
397 SET_TX_CHANNEL_FLAG(channel
, fHEAD
, 0);
398 SET_TX_CHANNEL_FLAG(channel
, fTAIL
, 0);
399 SET_TX_CHANNEL_FLAG(channel
, fSTATE
, 1);
400 SET_TX_CHANNEL_FLAG(channel
, fBLOCKREADINTR
, 1);
401 SET_TX_CHANNEL_INFO(channel
, head
, 0);
402 SET_RX_CHANNEL_INFO(channel
, tail
, 0);
404 qcom_smd_signal_channel(channel
);
406 channel
->state
= SMD_CHANNEL_CLOSED
;
407 channel
->pkt_size
= 0;
411 * Set the callback for a channel, with appropriate locking
413 static void qcom_smd_channel_set_callback(struct qcom_smd_channel
*channel
,
416 struct rpmsg_endpoint
*ept
= &channel
->qsept
->ept
;
419 spin_lock_irqsave(&channel
->recv_lock
, flags
);
421 spin_unlock_irqrestore(&channel
->recv_lock
, flags
);
425 * Calculate the amount of data available in the rx fifo
427 static size_t qcom_smd_channel_get_rx_avail(struct qcom_smd_channel
*channel
)
432 head
= GET_RX_CHANNEL_INFO(channel
, head
);
433 tail
= GET_RX_CHANNEL_INFO(channel
, tail
);
435 return (head
- tail
) & (channel
->fifo_size
- 1);
439 * Set tx channel state and inform the remote processor
441 static void qcom_smd_channel_set_state(struct qcom_smd_channel
*channel
,
444 struct qcom_smd_edge
*edge
= channel
->edge
;
445 bool is_open
= state
== SMD_CHANNEL_OPENED
;
447 if (channel
->state
== state
)
450 dev_dbg(&edge
->dev
, "set_state(%s, %d)\n", channel
->name
, state
);
452 SET_TX_CHANNEL_FLAG(channel
, fDSR
, is_open
);
453 SET_TX_CHANNEL_FLAG(channel
, fCTS
, is_open
);
454 SET_TX_CHANNEL_FLAG(channel
, fCD
, is_open
);
456 SET_TX_CHANNEL_INFO(channel
, state
, state
);
457 SET_TX_CHANNEL_FLAG(channel
, fSTATE
, 1);
459 channel
->state
= state
;
460 qcom_smd_signal_channel(channel
);
464 * Copy count bytes of data using 32bit accesses, if that's required.
466 static void smd_copy_to_fifo(void __iomem
*dst
,
472 __iowrite32_copy(dst
, src
, count
/ sizeof(u32
));
474 memcpy_toio(dst
, src
, count
);
479 * Copy count bytes of data using 32bit accesses, if that is required.
481 static void smd_copy_from_fifo(void *dst
,
482 const void __iomem
*src
,
487 __ioread32_copy(dst
, src
, count
/ sizeof(u32
));
489 memcpy_fromio(dst
, src
, count
);
494 * Read count bytes of data from the rx fifo into buf, but don't advance the
497 static size_t qcom_smd_channel_peek(struct qcom_smd_channel
*channel
,
498 void *buf
, size_t count
)
504 word_aligned
= channel
->info_word
;
505 tail
= GET_RX_CHANNEL_INFO(channel
, tail
);
507 len
= min_t(size_t, count
, channel
->fifo_size
- tail
);
509 smd_copy_from_fifo(buf
,
510 channel
->rx_fifo
+ tail
,
516 smd_copy_from_fifo(buf
+ len
,
526 * Advance the rx tail by count bytes.
528 static void qcom_smd_channel_advance(struct qcom_smd_channel
*channel
,
533 tail
= GET_RX_CHANNEL_INFO(channel
, tail
);
535 tail
&= (channel
->fifo_size
- 1);
536 SET_RX_CHANNEL_INFO(channel
, tail
, tail
);
540 * Read out a single packet from the rx fifo and deliver it to the device
542 static int qcom_smd_channel_recv_single(struct qcom_smd_channel
*channel
)
544 struct rpmsg_endpoint
*ept
= &channel
->qsept
->ept
;
550 tail
= GET_RX_CHANNEL_INFO(channel
, tail
);
552 /* Use bounce buffer if the data wraps */
553 if (tail
+ channel
->pkt_size
>= channel
->fifo_size
) {
554 ptr
= channel
->bounce_buffer
;
555 len
= qcom_smd_channel_peek(channel
, ptr
, channel
->pkt_size
);
557 ptr
= channel
->rx_fifo
+ tail
;
558 len
= channel
->pkt_size
;
561 ret
= ept
->cb(ept
->rpdev
, ptr
, len
, ept
->priv
, RPMSG_ADDR_ANY
);
565 /* Only forward the tail if the client consumed the data */
566 qcom_smd_channel_advance(channel
, len
);
568 channel
->pkt_size
= 0;
574 * Per channel interrupt handling
576 static bool qcom_smd_channel_intr(struct qcom_smd_channel
*channel
)
578 bool need_state_scan
= false;
584 /* Handle state changes */
585 remote_state
= GET_RX_CHANNEL_INFO(channel
, state
);
586 if (remote_state
!= channel
->remote_state
) {
587 channel
->remote_state
= remote_state
;
588 need_state_scan
= true;
590 wake_up_interruptible_all(&channel
->state_change_event
);
592 /* Indicate that we have seen any state change */
593 SET_RX_CHANNEL_FLAG(channel
, fSTATE
, 0);
595 /* Signal waiting qcom_smd_send() about the interrupt */
596 if (!GET_TX_CHANNEL_FLAG(channel
, fBLOCKREADINTR
))
597 wake_up_interruptible_all(&channel
->fblockread_event
);
599 /* Don't consume any data until we've opened the channel */
600 if (channel
->state
!= SMD_CHANNEL_OPENED
)
603 /* Indicate that we've seen the new data */
604 SET_RX_CHANNEL_FLAG(channel
, fHEAD
, 0);
608 avail
= qcom_smd_channel_get_rx_avail(channel
);
610 if (!channel
->pkt_size
&& avail
>= SMD_PACKET_HEADER_LEN
) {
611 qcom_smd_channel_peek(channel
, &pktlen
, sizeof(pktlen
));
612 qcom_smd_channel_advance(channel
, SMD_PACKET_HEADER_LEN
);
613 channel
->pkt_size
= le32_to_cpu(pktlen
);
614 } else if (channel
->pkt_size
&& avail
>= channel
->pkt_size
) {
615 ret
= qcom_smd_channel_recv_single(channel
);
623 /* Indicate that we have seen and updated tail */
624 SET_RX_CHANNEL_FLAG(channel
, fTAIL
, 1);
626 /* Signal the remote that we've consumed the data (if requested) */
627 if (!GET_RX_CHANNEL_FLAG(channel
, fBLOCKREADINTR
)) {
628 /* Ensure ordering of channel info updates */
631 qcom_smd_signal_channel(channel
);
635 return need_state_scan
;
639 * The edge interrupts are triggered by the remote processor on state changes,
640 * channel info updates or when new channels are created.
642 static irqreturn_t
qcom_smd_edge_intr(int irq
, void *data
)
644 struct qcom_smd_edge
*edge
= data
;
645 struct qcom_smd_channel
*channel
;
647 bool kick_scanner
= false;
648 bool kick_state
= false;
651 * Handle state changes or data on each of the channels on this edge
653 spin_lock(&edge
->channels_lock
);
654 list_for_each_entry(channel
, &edge
->channels
, list
) {
655 spin_lock(&channel
->recv_lock
);
656 kick_state
|= qcom_smd_channel_intr(channel
);
657 spin_unlock(&channel
->recv_lock
);
659 spin_unlock(&edge
->channels_lock
);
662 * Creating a new channel requires allocating an smem entry, so we only
663 * have to scan if the amount of available space in smem have changed
666 available
= qcom_smem_get_free_space(edge
->remote_pid
);
667 if (available
!= edge
->smem_available
) {
668 edge
->smem_available
= available
;
673 schedule_work(&edge
->scan_work
);
675 schedule_work(&edge
->state_work
);
681 * Calculate how much space is available in the tx fifo.
683 static size_t qcom_smd_get_tx_avail(struct qcom_smd_channel
*channel
)
687 unsigned mask
= channel
->fifo_size
- 1;
689 head
= GET_TX_CHANNEL_INFO(channel
, head
);
690 tail
= GET_TX_CHANNEL_INFO(channel
, tail
);
692 return mask
- ((head
- tail
) & mask
);
696 * Write count bytes of data into channel, possibly wrapping in the ring buffer
698 static int qcom_smd_write_fifo(struct qcom_smd_channel
*channel
,
706 word_aligned
= channel
->info_word
;
707 head
= GET_TX_CHANNEL_INFO(channel
, head
);
709 len
= min_t(size_t, count
, channel
->fifo_size
- head
);
711 smd_copy_to_fifo(channel
->tx_fifo
+ head
,
718 smd_copy_to_fifo(channel
->tx_fifo
,
725 head
&= (channel
->fifo_size
- 1);
726 SET_TX_CHANNEL_INFO(channel
, head
, head
);
732 * qcom_smd_send - write data to smd channel
733 * @channel: channel handle
734 * @data: buffer of data to write
735 * @len: number of bytes to write
736 * @wait: flag to indicate if write has ca wait
738 * This is a blocking write of len bytes into the channel's tx ring buffer and
739 * signal the remote end. It will sleep until there is enough space available
740 * in the tx buffer, utilizing the fBLOCKREADINTR signaling mechanism to avoid
743 static int __qcom_smd_send(struct qcom_smd_channel
*channel
, const void *data
,
746 __le32 hdr
[5] = { cpu_to_le32(len
), };
747 int tlen
= sizeof(hdr
) + len
;
751 /* Word aligned channels only accept word size aligned data */
752 if (channel
->info_word
&& len
% 4)
755 /* Reject packets that are too big */
756 if (tlen
>= channel
->fifo_size
)
759 /* Highlight the fact that if we enter the loop below we might sleep */
763 spin_lock_irqsave(&channel
->tx_lock
, flags
);
765 while (qcom_smd_get_tx_avail(channel
) < tlen
&&
766 channel
->state
== SMD_CHANNEL_OPENED
) {
772 SET_TX_CHANNEL_FLAG(channel
, fBLOCKREADINTR
, 0);
774 /* Wait without holding the tx_lock */
775 spin_unlock_irqrestore(&channel
->tx_lock
, flags
);
777 ret
= wait_event_interruptible(channel
->fblockread_event
,
778 qcom_smd_get_tx_avail(channel
) >= tlen
||
779 channel
->state
!= SMD_CHANNEL_OPENED
);
783 spin_lock_irqsave(&channel
->tx_lock
, flags
);
785 SET_TX_CHANNEL_FLAG(channel
, fBLOCKREADINTR
, 1);
788 /* Fail if the channel was closed */
789 if (channel
->state
!= SMD_CHANNEL_OPENED
) {
794 SET_TX_CHANNEL_FLAG(channel
, fTAIL
, 0);
796 qcom_smd_write_fifo(channel
, hdr
, sizeof(hdr
));
797 qcom_smd_write_fifo(channel
, data
, len
);
799 SET_TX_CHANNEL_FLAG(channel
, fHEAD
, 1);
801 /* Ensure ordering of channel info updates */
804 qcom_smd_signal_channel(channel
);
807 spin_unlock_irqrestore(&channel
->tx_lock
, flags
);
813 * Helper for opening a channel
815 static int qcom_smd_channel_open(struct qcom_smd_channel
*channel
,
818 struct qcom_smd_edge
*edge
= channel
->edge
;
823 * Packets are maximum 4k, but reduce if the fifo is smaller
825 bb_size
= min(channel
->fifo_size
, SZ_4K
);
826 channel
->bounce_buffer
= kmalloc(bb_size
, GFP_KERNEL
);
827 if (!channel
->bounce_buffer
)
830 qcom_smd_channel_set_callback(channel
, cb
);
831 qcom_smd_channel_set_state(channel
, SMD_CHANNEL_OPENING
);
833 /* Wait for remote to enter opening or opened */
834 ret
= wait_event_interruptible_timeout(channel
->state_change_event
,
835 channel
->remote_state
== SMD_CHANNEL_OPENING
||
836 channel
->remote_state
== SMD_CHANNEL_OPENED
,
839 dev_err(&edge
->dev
, "remote side did not enter opening state\n");
840 goto out_close_timeout
;
843 qcom_smd_channel_set_state(channel
, SMD_CHANNEL_OPENED
);
845 /* Wait for remote to enter opened */
846 ret
= wait_event_interruptible_timeout(channel
->state_change_event
,
847 channel
->remote_state
== SMD_CHANNEL_OPENED
,
850 dev_err(&edge
->dev
, "remote side did not enter open state\n");
851 goto out_close_timeout
;
857 qcom_smd_channel_set_state(channel
, SMD_CHANNEL_CLOSED
);
862 * Helper for closing and resetting a channel
864 static void qcom_smd_channel_close(struct qcom_smd_channel
*channel
)
866 qcom_smd_channel_set_callback(channel
, NULL
);
868 kfree(channel
->bounce_buffer
);
869 channel
->bounce_buffer
= NULL
;
871 qcom_smd_channel_set_state(channel
, SMD_CHANNEL_CLOSED
);
872 qcom_smd_channel_reset(channel
);
875 static struct qcom_smd_channel
*
876 qcom_smd_find_channel(struct qcom_smd_edge
*edge
, const char *name
)
878 struct qcom_smd_channel
*channel
;
879 struct qcom_smd_channel
*ret
= NULL
;
882 spin_lock_irqsave(&edge
->channels_lock
, flags
);
883 list_for_each_entry(channel
, &edge
->channels
, list
) {
884 if (!strcmp(channel
->name
, name
)) {
889 spin_unlock_irqrestore(&edge
->channels_lock
, flags
);
894 static void __ept_release(struct kref
*kref
)
896 struct rpmsg_endpoint
*ept
= container_of(kref
, struct rpmsg_endpoint
,
898 kfree(to_smd_endpoint(ept
));
901 static struct rpmsg_endpoint
*qcom_smd_create_ept(struct rpmsg_device
*rpdev
,
902 rpmsg_rx_cb_t cb
, void *priv
,
903 struct rpmsg_channel_info chinfo
)
905 struct qcom_smd_endpoint
*qsept
;
906 struct qcom_smd_channel
*channel
;
907 struct qcom_smd_device
*qsdev
= to_smd_device(rpdev
);
908 struct qcom_smd_edge
*edge
= qsdev
->edge
;
909 struct rpmsg_endpoint
*ept
;
910 const char *name
= chinfo
.name
;
913 /* Wait up to HZ for the channel to appear */
914 ret
= wait_event_interruptible_timeout(edge
->new_channel_event
,
915 (channel
= qcom_smd_find_channel(edge
, name
)) != NULL
,
920 if (channel
->state
!= SMD_CHANNEL_CLOSED
) {
921 dev_err(&rpdev
->dev
, "channel %s is busy\n", channel
->name
);
925 qsept
= kzalloc(sizeof(*qsept
), GFP_KERNEL
);
931 kref_init(&ept
->refcount
);
936 ept
->ops
= &qcom_smd_endpoint_ops
;
938 channel
->qsept
= qsept
;
939 qsept
->qsch
= channel
;
941 ret
= qcom_smd_channel_open(channel
, cb
);
948 channel
->qsept
= NULL
;
949 kref_put(&ept
->refcount
, __ept_release
);
953 static void qcom_smd_destroy_ept(struct rpmsg_endpoint
*ept
)
955 struct qcom_smd_endpoint
*qsept
= to_smd_endpoint(ept
);
956 struct qcom_smd_channel
*ch
= qsept
->qsch
;
958 qcom_smd_channel_close(ch
);
960 kref_put(&ept
->refcount
, __ept_release
);
963 static int qcom_smd_send(struct rpmsg_endpoint
*ept
, void *data
, int len
)
965 struct qcom_smd_endpoint
*qsept
= to_smd_endpoint(ept
);
967 return __qcom_smd_send(qsept
->qsch
, data
, len
, true);
970 static int qcom_smd_trysend(struct rpmsg_endpoint
*ept
, void *data
, int len
)
972 struct qcom_smd_endpoint
*qsept
= to_smd_endpoint(ept
);
974 return __qcom_smd_send(qsept
->qsch
, data
, len
, false);
977 static __poll_t
qcom_smd_poll(struct rpmsg_endpoint
*ept
,
978 struct file
*filp
, poll_table
*wait
)
980 struct qcom_smd_endpoint
*qsept
= to_smd_endpoint(ept
);
981 struct qcom_smd_channel
*channel
= qsept
->qsch
;
984 poll_wait(filp
, &channel
->fblockread_event
, wait
);
986 if (qcom_smd_get_tx_avail(channel
) > 20)
987 mask
|= EPOLLOUT
| EPOLLWRNORM
;
993 * Finds the device_node for the smd child interested in this channel.
995 static struct device_node
*qcom_smd_match_channel(struct device_node
*edge_node
,
998 struct device_node
*child
;
1003 for_each_available_child_of_node(edge_node
, child
) {
1004 key
= "qcom,smd-channels";
1005 ret
= of_property_read_string(child
, key
, &name
);
1009 if (strcmp(name
, channel
) == 0)
1016 static int qcom_smd_announce_create(struct rpmsg_device
*rpdev
)
1018 struct qcom_smd_endpoint
*qept
= to_smd_endpoint(rpdev
->ept
);
1019 struct qcom_smd_channel
*channel
= qept
->qsch
;
1020 unsigned long flags
;
1023 spin_lock_irqsave(&channel
->recv_lock
, flags
);
1024 kick_state
= qcom_smd_channel_intr(channel
);
1025 spin_unlock_irqrestore(&channel
->recv_lock
, flags
);
1028 schedule_work(&channel
->edge
->state_work
);
1033 static const struct rpmsg_device_ops qcom_smd_device_ops
= {
1034 .create_ept
= qcom_smd_create_ept
,
1035 .announce_create
= qcom_smd_announce_create
,
1038 static const struct rpmsg_endpoint_ops qcom_smd_endpoint_ops
= {
1039 .destroy_ept
= qcom_smd_destroy_ept
,
1040 .send
= qcom_smd_send
,
1041 .trysend
= qcom_smd_trysend
,
1042 .poll
= qcom_smd_poll
,
1045 static void qcom_smd_release_device(struct device
*dev
)
1047 struct rpmsg_device
*rpdev
= to_rpmsg_device(dev
);
1048 struct qcom_smd_device
*qsdev
= to_smd_device(rpdev
);
1054 * Create a smd client device for channel that is being opened.
1056 static int qcom_smd_create_device(struct qcom_smd_channel
*channel
)
1058 struct qcom_smd_device
*qsdev
;
1059 struct rpmsg_device
*rpdev
;
1060 struct qcom_smd_edge
*edge
= channel
->edge
;
1062 dev_dbg(&edge
->dev
, "registering '%s'\n", channel
->name
);
1064 qsdev
= kzalloc(sizeof(*qsdev
), GFP_KERNEL
);
1068 /* Link qsdev to our SMD edge */
1071 /* Assign callbacks for rpmsg_device */
1072 qsdev
->rpdev
.ops
= &qcom_smd_device_ops
;
1074 /* Assign public information to the rpmsg_device */
1075 rpdev
= &qsdev
->rpdev
;
1076 strncpy(rpdev
->id
.name
, channel
->name
, RPMSG_NAME_SIZE
);
1077 rpdev
->src
= RPMSG_ADDR_ANY
;
1078 rpdev
->dst
= RPMSG_ADDR_ANY
;
1080 rpdev
->dev
.of_node
= qcom_smd_match_channel(edge
->of_node
, channel
->name
);
1081 rpdev
->dev
.parent
= &edge
->dev
;
1082 rpdev
->dev
.release
= qcom_smd_release_device
;
1084 return rpmsg_register_device(rpdev
);
1087 static int qcom_smd_create_chrdev(struct qcom_smd_edge
*edge
)
1089 struct qcom_smd_device
*qsdev
;
1091 qsdev
= kzalloc(sizeof(*qsdev
), GFP_KERNEL
);
1096 qsdev
->rpdev
.ops
= &qcom_smd_device_ops
;
1097 qsdev
->rpdev
.dev
.parent
= &edge
->dev
;
1098 qsdev
->rpdev
.dev
.release
= qcom_smd_release_device
;
1100 return rpmsg_chrdev_register_device(&qsdev
->rpdev
);
1104 * Allocate the qcom_smd_channel object for a newly found smd channel,
1105 * retrieving and validating the smem items involved.
1107 static struct qcom_smd_channel
*qcom_smd_create_channel(struct qcom_smd_edge
*edge
,
1108 unsigned smem_info_item
,
1109 unsigned smem_fifo_item
,
1112 struct qcom_smd_channel
*channel
;
1119 channel
= kzalloc(sizeof(*channel
), GFP_KERNEL
);
1121 return ERR_PTR(-ENOMEM
);
1123 channel
->edge
= edge
;
1124 channel
->name
= kstrdup(name
, GFP_KERNEL
);
1126 return ERR_PTR(-ENOMEM
);
1128 spin_lock_init(&channel
->tx_lock
);
1129 spin_lock_init(&channel
->recv_lock
);
1130 init_waitqueue_head(&channel
->fblockread_event
);
1131 init_waitqueue_head(&channel
->state_change_event
);
1133 info
= qcom_smem_get(edge
->remote_pid
, smem_info_item
, &info_size
);
1135 ret
= PTR_ERR(info
);
1136 goto free_name_and_channel
;
1140 * Use the size of the item to figure out which channel info struct to
1143 if (info_size
== 2 * sizeof(struct smd_channel_info_word
)) {
1144 channel
->info_word
= info
;
1145 } else if (info_size
== 2 * sizeof(struct smd_channel_info
)) {
1146 channel
->info
= info
;
1149 "channel info of size %zu not supported\n", info_size
);
1151 goto free_name_and_channel
;
1154 fifo_base
= qcom_smem_get(edge
->remote_pid
, smem_fifo_item
, &fifo_size
);
1155 if (IS_ERR(fifo_base
)) {
1156 ret
= PTR_ERR(fifo_base
);
1157 goto free_name_and_channel
;
1160 /* The channel consist of a rx and tx fifo of equal size */
1163 dev_dbg(&edge
->dev
, "new channel '%s' info-size: %zu fifo-size: %zu\n",
1164 name
, info_size
, fifo_size
);
1166 channel
->tx_fifo
= fifo_base
;
1167 channel
->rx_fifo
= fifo_base
+ fifo_size
;
1168 channel
->fifo_size
= fifo_size
;
1170 qcom_smd_channel_reset(channel
);
1174 free_name_and_channel
:
1175 kfree(channel
->name
);
1178 return ERR_PTR(ret
);
1182 * Scans the allocation table for any newly allocated channels, calls
1183 * qcom_smd_create_channel() to create representations of these and add
1184 * them to the edge's list of channels.
1186 static void qcom_channel_scan_worker(struct work_struct
*work
)
1188 struct qcom_smd_edge
*edge
= container_of(work
, struct qcom_smd_edge
, scan_work
);
1189 struct qcom_smd_alloc_entry
*alloc_tbl
;
1190 struct qcom_smd_alloc_entry
*entry
;
1191 struct qcom_smd_channel
*channel
;
1192 unsigned long flags
;
1199 for (tbl
= 0; tbl
< SMD_ALLOC_TBL_COUNT
; tbl
++) {
1200 alloc_tbl
= qcom_smem_get(edge
->remote_pid
,
1201 smem_items
[tbl
].alloc_tbl_id
, NULL
);
1202 if (IS_ERR(alloc_tbl
))
1205 for (i
= 0; i
< SMD_ALLOC_TBL_SIZE
; i
++) {
1206 entry
= &alloc_tbl
[i
];
1207 eflags
= le32_to_cpu(entry
->flags
);
1208 if (test_bit(i
, edge
->allocated
[tbl
]))
1211 if (entry
->ref_count
== 0)
1214 if (!entry
->name
[0])
1217 if (!(eflags
& SMD_CHANNEL_FLAGS_PACKET
))
1220 if ((eflags
& SMD_CHANNEL_FLAGS_EDGE_MASK
) != edge
->edge_id
)
1223 cid
= le32_to_cpu(entry
->cid
);
1224 info_id
= smem_items
[tbl
].info_base_id
+ cid
;
1225 fifo_id
= smem_items
[tbl
].fifo_base_id
+ cid
;
1227 channel
= qcom_smd_create_channel(edge
, info_id
, fifo_id
, entry
->name
);
1228 if (IS_ERR(channel
))
1231 spin_lock_irqsave(&edge
->channels_lock
, flags
);
1232 list_add(&channel
->list
, &edge
->channels
);
1233 spin_unlock_irqrestore(&edge
->channels_lock
, flags
);
1235 dev_dbg(&edge
->dev
, "new channel found: '%s'\n", channel
->name
);
1236 set_bit(i
, edge
->allocated
[tbl
]);
1238 wake_up_interruptible_all(&edge
->new_channel_event
);
1242 schedule_work(&edge
->state_work
);
1246 * This per edge worker scans smem for any new channels and register these. It
1247 * then scans all registered channels for state changes that should be handled
1248 * by creating or destroying smd client devices for the registered channels.
1250 * LOCKING: edge->channels_lock only needs to cover the list operations, as the
1251 * worker is killed before any channels are deallocated
1253 static void qcom_channel_state_worker(struct work_struct
*work
)
1255 struct qcom_smd_channel
*channel
;
1256 struct qcom_smd_edge
*edge
= container_of(work
,
1257 struct qcom_smd_edge
,
1259 struct rpmsg_channel_info chinfo
;
1260 unsigned remote_state
;
1261 unsigned long flags
;
1264 * Register a device for any closed channel where the remote processor
1265 * is showing interest in opening the channel.
1267 spin_lock_irqsave(&edge
->channels_lock
, flags
);
1268 list_for_each_entry(channel
, &edge
->channels
, list
) {
1269 if (channel
->state
!= SMD_CHANNEL_CLOSED
)
1272 remote_state
= GET_RX_CHANNEL_INFO(channel
, state
);
1273 if (remote_state
!= SMD_CHANNEL_OPENING
&&
1274 remote_state
!= SMD_CHANNEL_OPENED
)
1277 if (channel
->registered
)
1280 spin_unlock_irqrestore(&edge
->channels_lock
, flags
);
1281 qcom_smd_create_device(channel
);
1282 channel
->registered
= true;
1283 spin_lock_irqsave(&edge
->channels_lock
, flags
);
1285 channel
->registered
= true;
1289 * Unregister the device for any channel that is opened where the
1290 * remote processor is closing the channel.
1292 list_for_each_entry(channel
, &edge
->channels
, list
) {
1293 if (channel
->state
!= SMD_CHANNEL_OPENING
&&
1294 channel
->state
!= SMD_CHANNEL_OPENED
)
1297 remote_state
= GET_RX_CHANNEL_INFO(channel
, state
);
1298 if (remote_state
== SMD_CHANNEL_OPENING
||
1299 remote_state
== SMD_CHANNEL_OPENED
)
1302 spin_unlock_irqrestore(&edge
->channels_lock
, flags
);
1304 strncpy(chinfo
.name
, channel
->name
, sizeof(chinfo
.name
));
1305 chinfo
.src
= RPMSG_ADDR_ANY
;
1306 chinfo
.dst
= RPMSG_ADDR_ANY
;
1307 rpmsg_unregister_device(&edge
->dev
, &chinfo
);
1308 channel
->registered
= false;
1309 spin_lock_irqsave(&edge
->channels_lock
, flags
);
1311 spin_unlock_irqrestore(&edge
->channels_lock
, flags
);
1315 * Parses an of_node describing an edge.
1317 static int qcom_smd_parse_edge(struct device
*dev
,
1318 struct device_node
*node
,
1319 struct qcom_smd_edge
*edge
)
1321 struct device_node
*syscon_np
;
1326 INIT_LIST_HEAD(&edge
->channels
);
1327 spin_lock_init(&edge
->channels_lock
);
1329 INIT_WORK(&edge
->scan_work
, qcom_channel_scan_worker
);
1330 INIT_WORK(&edge
->state_work
, qcom_channel_state_worker
);
1332 edge
->of_node
= of_node_get(node
);
1334 key
= "qcom,smd-edge";
1335 ret
= of_property_read_u32(node
, key
, &edge
->edge_id
);
1337 dev_err(dev
, "edge missing %s property\n", key
);
1341 edge
->remote_pid
= QCOM_SMEM_HOST_ANY
;
1342 key
= "qcom,remote-pid";
1343 of_property_read_u32(node
, key
, &edge
->remote_pid
);
1345 edge
->mbox_client
.dev
= dev
;
1346 edge
->mbox_client
.knows_txdone
= true;
1347 edge
->mbox_chan
= mbox_request_channel(&edge
->mbox_client
, 0);
1348 if (IS_ERR(edge
->mbox_chan
)) {
1349 if (PTR_ERR(edge
->mbox_chan
) != -ENODEV
)
1350 return PTR_ERR(edge
->mbox_chan
);
1352 edge
->mbox_chan
= NULL
;
1354 syscon_np
= of_parse_phandle(node
, "qcom,ipc", 0);
1356 dev_err(dev
, "no qcom,ipc node\n");
1360 edge
->ipc_regmap
= syscon_node_to_regmap(syscon_np
);
1361 if (IS_ERR(edge
->ipc_regmap
))
1362 return PTR_ERR(edge
->ipc_regmap
);
1365 ret
= of_property_read_u32_index(node
, key
, 1, &edge
->ipc_offset
);
1367 dev_err(dev
, "no offset in %s\n", key
);
1371 ret
= of_property_read_u32_index(node
, key
, 2, &edge
->ipc_bit
);
1373 dev_err(dev
, "no bit in %s\n", key
);
1378 ret
= of_property_read_string(node
, "label", &edge
->name
);
1380 edge
->name
= node
->name
;
1382 irq
= irq_of_parse_and_map(node
, 0);
1384 dev_err(dev
, "required smd interrupt missing\n");
1388 ret
= devm_request_irq(dev
, irq
,
1389 qcom_smd_edge_intr
, IRQF_TRIGGER_RISING
,
1392 dev_err(dev
, "failed to request smd irq\n");
1402 * Release function for an edge.
1403 * Reset the state of each associated channel and free the edge context.
1405 static void qcom_smd_edge_release(struct device
*dev
)
1407 struct qcom_smd_channel
*channel
, *tmp
;
1408 struct qcom_smd_edge
*edge
= to_smd_edge(dev
);
1410 list_for_each_entry_safe(channel
, tmp
, &edge
->channels
, list
) {
1411 list_del(&channel
->list
);
1412 kfree(channel
->name
);
1419 static ssize_t
rpmsg_name_show(struct device
*dev
,
1420 struct device_attribute
*attr
, char *buf
)
1422 struct qcom_smd_edge
*edge
= to_smd_edge(dev
);
1424 return sprintf(buf
, "%s\n", edge
->name
);
1426 static DEVICE_ATTR_RO(rpmsg_name
);
1428 static struct attribute
*qcom_smd_edge_attrs
[] = {
1429 &dev_attr_rpmsg_name
.attr
,
1432 ATTRIBUTE_GROUPS(qcom_smd_edge
);
1435 * qcom_smd_register_edge() - register an edge based on an device_node
1436 * @parent: parent device for the edge
1437 * @node: device_node describing the edge
1439 * Returns an edge reference, or negative ERR_PTR() on failure.
1441 struct qcom_smd_edge
*qcom_smd_register_edge(struct device
*parent
,
1442 struct device_node
*node
)
1444 struct qcom_smd_edge
*edge
;
1447 edge
= kzalloc(sizeof(*edge
), GFP_KERNEL
);
1449 return ERR_PTR(-ENOMEM
);
1451 init_waitqueue_head(&edge
->new_channel_event
);
1453 edge
->dev
.parent
= parent
;
1454 edge
->dev
.release
= qcom_smd_edge_release
;
1455 edge
->dev
.of_node
= node
;
1456 edge
->dev
.groups
= qcom_smd_edge_groups
;
1457 dev_set_name(&edge
->dev
, "%s:%s", dev_name(parent
), node
->name
);
1458 ret
= device_register(&edge
->dev
);
1460 pr_err("failed to register smd edge\n");
1461 put_device(&edge
->dev
);
1462 return ERR_PTR(ret
);
1465 ret
= qcom_smd_parse_edge(&edge
->dev
, node
, edge
);
1467 dev_err(&edge
->dev
, "failed to parse smd edge\n");
1468 goto unregister_dev
;
1471 ret
= qcom_smd_create_chrdev(edge
);
1473 dev_err(&edge
->dev
, "failed to register chrdev for edge\n");
1474 goto unregister_dev
;
1477 schedule_work(&edge
->scan_work
);
1482 if (!IS_ERR_OR_NULL(edge
->mbox_chan
))
1483 mbox_free_channel(edge
->mbox_chan
);
1485 device_unregister(&edge
->dev
);
1486 return ERR_PTR(ret
);
1488 EXPORT_SYMBOL(qcom_smd_register_edge
);
1490 static int qcom_smd_remove_device(struct device
*dev
, void *data
)
1492 device_unregister(dev
);
1498 * qcom_smd_unregister_edge() - release an edge and its children
1499 * @edge: edge reference acquired from qcom_smd_register_edge
1501 int qcom_smd_unregister_edge(struct qcom_smd_edge
*edge
)
1505 disable_irq(edge
->irq
);
1506 cancel_work_sync(&edge
->scan_work
);
1507 cancel_work_sync(&edge
->state_work
);
1509 ret
= device_for_each_child(&edge
->dev
, NULL
, qcom_smd_remove_device
);
1511 dev_warn(&edge
->dev
, "can't remove smd device: %d\n", ret
);
1513 mbox_free_channel(edge
->mbox_chan
);
1514 device_unregister(&edge
->dev
);
1518 EXPORT_SYMBOL(qcom_smd_unregister_edge
);
1520 static int qcom_smd_probe(struct platform_device
*pdev
)
1522 struct device_node
*node
;
1526 p
= qcom_smem_get(QCOM_SMEM_HOST_ANY
, smem_items
[0].alloc_tbl_id
, NULL
);
1527 if (PTR_ERR(p
) == -EPROBE_DEFER
)
1530 for_each_available_child_of_node(pdev
->dev
.of_node
, node
)
1531 qcom_smd_register_edge(&pdev
->dev
, node
);
1536 static int qcom_smd_remove_edge(struct device
*dev
, void *data
)
1538 struct qcom_smd_edge
*edge
= to_smd_edge(dev
);
1540 return qcom_smd_unregister_edge(edge
);
1544 * Shut down all smd clients by making sure that each edge stops processing
1545 * events and scanning for new channels, then call destroy on the devices.
1547 static int qcom_smd_remove(struct platform_device
*pdev
)
1551 ret
= device_for_each_child(&pdev
->dev
, NULL
, qcom_smd_remove_edge
);
1553 dev_warn(&pdev
->dev
, "can't remove smd device: %d\n", ret
);
1558 static const struct of_device_id qcom_smd_of_match
[] = {
1559 { .compatible
= "qcom,smd" },
1562 MODULE_DEVICE_TABLE(of
, qcom_smd_of_match
);
1564 static struct platform_driver qcom_smd_driver
= {
1565 .probe
= qcom_smd_probe
,
1566 .remove
= qcom_smd_remove
,
1569 .of_match_table
= qcom_smd_of_match
,
1573 static int __init
qcom_smd_init(void)
1575 return platform_driver_register(&qcom_smd_driver
);
1577 subsys_initcall(qcom_smd_init
);
1579 static void __exit
qcom_smd_exit(void)
1581 platform_driver_unregister(&qcom_smd_driver
);
1583 module_exit(qcom_smd_exit
);
1585 MODULE_AUTHOR("Bjorn Andersson <bjorn.andersson@sonymobile.com>");
1586 MODULE_DESCRIPTION("Qualcomm Shared Memory Driver");
1587 MODULE_LICENSE("GPL v2");