2 * Copyright (c) 2015, Sony Mobile Communications AB.
3 * Copyright (c) 2012-2013, The Linux Foundation. All rights reserved.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 and
7 * only version 2 as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
15 #include <linux/interrupt.h>
17 #include <linux/mfd/syscon.h>
18 #include <linux/module.h>
19 #include <linux/of_irq.h>
20 #include <linux/of_platform.h>
21 #include <linux/platform_device.h>
22 #include <linux/regmap.h>
23 #include <linux/sched.h>
24 #include <linux/slab.h>
25 #include <linux/soc/qcom/smd.h>
26 #include <linux/soc/qcom/smem.h>
27 #include <linux/wait.h>
30 * The Qualcomm Shared Memory communication solution provides point-to-point
31 * channels for clients to send and receive streaming or packet based data.
33 * Each channel consists of a control item (channel info) and a ring buffer
34 * pair. The channel info carry information related to channel state, flow
35 * control and the offsets within the ring buffer.
37 * All allocated channels are listed in an allocation table, identifying the
38 * pair of items by name, type and remote processor.
40 * Upon creating a new channel the remote processor allocates channel info and
41 * ring buffer items from the smem heap and populate the allocation table. An
42 * interrupt is sent to the other end of the channel and a scan for new
43 * channels should be done. A channel never goes away, it will only change
46 * The remote processor signals it intent for bring up the communication
47 * channel by setting the state of its end of the channel to "opening" and
48 * sends out an interrupt. We detect this change and register a smd device to
49 * consume the channel. Upon finding a consumer we finish the handshake and the
52 * Upon closing a channel, the remote processor will update the state of its
53 * end of the channel and signal us, we will then unregister any attached
54 * device and close our end of the channel.
56 * Devices attached to a channel can use the qcom_smd_send function to push
57 * data to the channel, this is done by copying the data into the tx ring
58 * buffer, updating the pointers in the channel info and signaling the remote
61 * The remote processor does the equivalent when it transfer data and upon
62 * receiving the interrupt we check the channel info for new data and delivers
63 * this to the attached device. If the device is not ready to receive the data
64 * we leave it in the ring buffer for now.
67 struct smd_channel_info;
68 struct smd_channel_info_pair;
69 struct smd_channel_info_word;
70 struct smd_channel_info_word_pair;
72 #define SMD_ALLOC_TBL_COUNT 2
73 #define SMD_ALLOC_TBL_SIZE 64
76 * This lists the various smem heap items relevant for the allocation table and
77 * smd channel entries.
80 unsigned alloc_tbl_id;
81 unsigned info_base_id;
82 unsigned fifo_base_id;
83 } smem_items[SMD_ALLOC_TBL_COUNT] = {
97 * struct qcom_smd_edge - representing a remote processor
98 * @smd: handle to qcom_smd
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 * @channels: list of all channels detected on this edge
107 * @channels_lock: guard for modifications of @channels
108 * @allocated: array of bitmaps representing already allocated channels
109 * @smem_available: last available amount of smem triggering a channel scan
110 * @scan_work: work item for discovering new channels
111 * @state_work: work item for edge state changes
113 struct qcom_smd_edge {
114 struct qcom_smd *smd;
115 struct device_node *of_node;
121 struct regmap *ipc_regmap;
125 struct list_head channels;
126 rwlock_t channels_lock;
128 DECLARE_BITMAP(allocated[SMD_ALLOC_TBL_COUNT], SMD_ALLOC_TBL_SIZE);
130 unsigned smem_available;
132 wait_queue_head_t new_channel_event;
134 struct work_struct scan_work;
135 struct work_struct state_work;
140 * struct qcom_smd - smd struct
141 * @dev: device struct
142 * @num_edges: number of entries in @edges
143 * @edges: array of edges to be handled
149 struct qcom_smd_edge edges[0];
153 * Format of the smd_info smem items, for byte aligned channels.
155 struct smd_channel_info {
169 struct smd_channel_info_pair {
170 struct smd_channel_info tx;
171 struct smd_channel_info rx;
175 * Format of the smd_info smem items, for word aligned channels.
177 struct smd_channel_info_word {
186 __le32 fBLOCKREADINTR;
191 struct smd_channel_info_word_pair {
192 struct smd_channel_info_word tx;
193 struct smd_channel_info_word rx;
196 #define GET_RX_CHANNEL_FLAG(channel, param) \
198 BUILD_BUG_ON(sizeof(channel->info->rx.param) != sizeof(u8)); \
199 channel->info_word ? \
200 le32_to_cpu(channel->info_word->rx.param) : \
201 channel->info->rx.param; \
204 #define GET_RX_CHANNEL_INFO(channel, param) \
206 BUILD_BUG_ON(sizeof(channel->info->rx.param) != sizeof(u32)); \
207 le32_to_cpu(channel->info_word ? \
208 channel->info_word->rx.param : \
209 channel->info->rx.param); \
212 #define SET_RX_CHANNEL_FLAG(channel, param, value) \
214 BUILD_BUG_ON(sizeof(channel->info->rx.param) != sizeof(u8)); \
215 if (channel->info_word) \
216 channel->info_word->rx.param = cpu_to_le32(value); \
218 channel->info->rx.param = value; \
221 #define SET_RX_CHANNEL_INFO(channel, param, value) \
223 BUILD_BUG_ON(sizeof(channel->info->rx.param) != sizeof(u32)); \
224 if (channel->info_word) \
225 channel->info_word->rx.param = cpu_to_le32(value); \
227 channel->info->rx.param = cpu_to_le32(value); \
230 #define GET_TX_CHANNEL_FLAG(channel, param) \
232 BUILD_BUG_ON(sizeof(channel->info->tx.param) != sizeof(u8)); \
233 channel->info_word ? \
234 le32_to_cpu(channel->info_word->tx.param) : \
235 channel->info->tx.param; \
238 #define GET_TX_CHANNEL_INFO(channel, param) \
240 BUILD_BUG_ON(sizeof(channel->info->tx.param) != sizeof(u32)); \
241 le32_to_cpu(channel->info_word ? \
242 channel->info_word->tx.param : \
243 channel->info->tx.param); \
246 #define SET_TX_CHANNEL_FLAG(channel, param, value) \
248 BUILD_BUG_ON(sizeof(channel->info->tx.param) != sizeof(u8)); \
249 if (channel->info_word) \
250 channel->info_word->tx.param = cpu_to_le32(value); \
252 channel->info->tx.param = value; \
255 #define SET_TX_CHANNEL_INFO(channel, param, value) \
257 BUILD_BUG_ON(sizeof(channel->info->tx.param) != sizeof(u32)); \
258 if (channel->info_word) \
259 channel->info_word->tx.param = cpu_to_le32(value); \
261 channel->info->tx.param = cpu_to_le32(value); \
265 * struct qcom_smd_alloc_entry - channel allocation entry
266 * @name: channel name
267 * @cid: channel index
268 * @flags: channel flags and edge id
269 * @ref_count: reference count of the channel
271 struct qcom_smd_alloc_entry {
278 #define SMD_CHANNEL_FLAGS_EDGE_MASK 0xff
279 #define SMD_CHANNEL_FLAGS_STREAM BIT(8)
280 #define SMD_CHANNEL_FLAGS_PACKET BIT(9)
283 * Each smd packet contains a 20 byte header, with the first 4 being the length
286 #define SMD_PACKET_HEADER_LEN 20
289 * Signal the remote processor associated with 'channel'.
291 static void qcom_smd_signal_channel(struct qcom_smd_channel *channel)
293 struct qcom_smd_edge *edge = channel->edge;
295 regmap_write(edge->ipc_regmap, edge->ipc_offset, BIT(edge->ipc_bit));
299 * Initialize the tx channel info
301 static void qcom_smd_channel_reset(struct qcom_smd_channel *channel)
303 SET_TX_CHANNEL_INFO(channel, state, SMD_CHANNEL_CLOSED);
304 SET_TX_CHANNEL_FLAG(channel, fDSR, 0);
305 SET_TX_CHANNEL_FLAG(channel, fCTS, 0);
306 SET_TX_CHANNEL_FLAG(channel, fCD, 0);
307 SET_TX_CHANNEL_FLAG(channel, fRI, 0);
308 SET_TX_CHANNEL_FLAG(channel, fHEAD, 0);
309 SET_TX_CHANNEL_FLAG(channel, fTAIL, 0);
310 SET_TX_CHANNEL_FLAG(channel, fSTATE, 1);
311 SET_TX_CHANNEL_FLAG(channel, fBLOCKREADINTR, 1);
312 SET_TX_CHANNEL_INFO(channel, head, 0);
313 SET_TX_CHANNEL_INFO(channel, tail, 0);
315 qcom_smd_signal_channel(channel);
317 channel->state = SMD_CHANNEL_CLOSED;
318 channel->pkt_size = 0;
322 * Set the callback for a channel, with appropriate locking
324 static void qcom_smd_channel_set_callback(struct qcom_smd_channel *channel,
329 spin_lock_irqsave(&channel->recv_lock, flags);
331 spin_unlock_irqrestore(&channel->recv_lock, flags);
335 * Calculate the amount of data available in the rx fifo
337 static size_t qcom_smd_channel_get_rx_avail(struct qcom_smd_channel *channel)
342 head = GET_RX_CHANNEL_INFO(channel, head);
343 tail = GET_RX_CHANNEL_INFO(channel, tail);
345 return (head - tail) & (channel->fifo_size - 1);
349 * Set tx channel state and inform the remote processor
351 static void qcom_smd_channel_set_state(struct qcom_smd_channel *channel,
354 struct qcom_smd_edge *edge = channel->edge;
355 bool is_open = state == SMD_CHANNEL_OPENED;
357 if (channel->state == state)
360 dev_dbg(edge->smd->dev, "set_state(%s, %d)\n", channel->name, state);
362 SET_TX_CHANNEL_FLAG(channel, fDSR, is_open);
363 SET_TX_CHANNEL_FLAG(channel, fCTS, is_open);
364 SET_TX_CHANNEL_FLAG(channel, fCD, is_open);
366 SET_TX_CHANNEL_INFO(channel, state, state);
367 SET_TX_CHANNEL_FLAG(channel, fSTATE, 1);
369 channel->state = state;
370 qcom_smd_signal_channel(channel);
374 * Copy count bytes of data using 32bit accesses, if that's required.
376 static void smd_copy_to_fifo(void __iomem *dst,
382 __iowrite32_copy(dst, src, count / sizeof(u32));
384 memcpy_toio(dst, src, count);
389 * Copy count bytes of data using 32bit accesses, if that is required.
391 static void smd_copy_from_fifo(void *_dst, const void __iomem *_src, size_t count, bool word_aligned)
393 u32 *dst = (u32 *)_dst;
394 u32 *src = (u32 *)_src;
397 count /= sizeof(u32);
399 *dst++ = __raw_readl(src++);
401 memcpy_fromio(_dst, _src, count);
406 * Read count bytes of data from the rx fifo into buf, but don't advance the
409 static size_t qcom_smd_channel_peek(struct qcom_smd_channel *channel,
410 void *buf, size_t count)
416 word_aligned = channel->info_word;
417 tail = GET_RX_CHANNEL_INFO(channel, tail);
419 len = min_t(size_t, count, channel->fifo_size - tail);
421 smd_copy_from_fifo(buf,
422 channel->rx_fifo + tail,
428 smd_copy_from_fifo(buf + len,
438 * Advance the rx tail by count bytes.
440 static void qcom_smd_channel_advance(struct qcom_smd_channel *channel,
445 tail = GET_RX_CHANNEL_INFO(channel, tail);
447 tail &= (channel->fifo_size - 1);
448 SET_RX_CHANNEL_INFO(channel, tail, tail);
452 * Read out a single packet from the rx fifo and deliver it to the device
454 static int qcom_smd_channel_recv_single(struct qcom_smd_channel *channel)
456 struct qcom_smd_device *qsdev = channel->qsdev;
465 tail = GET_RX_CHANNEL_INFO(channel, tail);
467 /* Use bounce buffer if the data wraps */
468 if (tail + channel->pkt_size >= channel->fifo_size) {
469 ptr = channel->bounce_buffer;
470 len = qcom_smd_channel_peek(channel, ptr, channel->pkt_size);
472 ptr = channel->rx_fifo + tail;
473 len = channel->pkt_size;
476 ret = channel->cb(qsdev, ptr, len);
480 /* Only forward the tail if the client consumed the data */
481 qcom_smd_channel_advance(channel, len);
483 channel->pkt_size = 0;
489 * Per channel interrupt handling
491 static bool qcom_smd_channel_intr(struct qcom_smd_channel *channel)
493 bool need_state_scan = false;
499 /* Handle state changes */
500 remote_state = GET_RX_CHANNEL_INFO(channel, state);
501 if (remote_state != channel->remote_state) {
502 channel->remote_state = remote_state;
503 need_state_scan = true;
505 /* Indicate that we have seen any state change */
506 SET_RX_CHANNEL_FLAG(channel, fSTATE, 0);
508 /* Signal waiting qcom_smd_send() about the interrupt */
509 if (!GET_TX_CHANNEL_FLAG(channel, fBLOCKREADINTR))
510 wake_up_interruptible(&channel->fblockread_event);
512 /* Don't consume any data until we've opened the channel */
513 if (channel->state != SMD_CHANNEL_OPENED)
516 /* Indicate that we've seen the new data */
517 SET_RX_CHANNEL_FLAG(channel, fHEAD, 0);
521 avail = qcom_smd_channel_get_rx_avail(channel);
523 if (!channel->pkt_size && avail >= SMD_PACKET_HEADER_LEN) {
524 qcom_smd_channel_peek(channel, &pktlen, sizeof(pktlen));
525 qcom_smd_channel_advance(channel, SMD_PACKET_HEADER_LEN);
526 channel->pkt_size = le32_to_cpu(pktlen);
527 } else if (channel->pkt_size && avail >= channel->pkt_size) {
528 ret = qcom_smd_channel_recv_single(channel);
536 /* Indicate that we have seen and updated tail */
537 SET_RX_CHANNEL_FLAG(channel, fTAIL, 1);
539 /* Signal the remote that we've consumed the data (if requested) */
540 if (!GET_RX_CHANNEL_FLAG(channel, fBLOCKREADINTR)) {
541 /* Ensure ordering of channel info updates */
544 qcom_smd_signal_channel(channel);
548 return need_state_scan;
552 * The edge interrupts are triggered by the remote processor on state changes,
553 * channel info updates or when new channels are created.
555 static irqreturn_t qcom_smd_edge_intr(int irq, void *data)
557 struct qcom_smd_edge *edge = data;
558 struct qcom_smd_channel *channel;
560 bool kick_worker = false;
563 * Handle state changes or data on each of the channels on this edge
565 read_lock(&edge->channels_lock);
566 list_for_each_entry(channel, &edge->channels, list) {
567 spin_lock(&channel->recv_lock);
568 kick_worker |= qcom_smd_channel_intr(channel);
569 spin_unlock(&channel->recv_lock);
571 read_unlock(&edge->channels_lock);
574 * Creating a new channel requires allocating an smem entry, so we only
575 * have to scan if the amount of available space in smem have changed
578 available = qcom_smem_get_free_space(edge->remote_pid);
579 if (available != edge->smem_available) {
580 edge->smem_available = available;
585 schedule_work(&edge->scan_work);
591 * Delivers any outstanding packets in the rx fifo, can be used after probe of
592 * the clients to deliver any packets that wasn't delivered before the client
595 static void qcom_smd_channel_resume(struct qcom_smd_channel *channel)
599 spin_lock_irqsave(&channel->recv_lock, flags);
600 qcom_smd_channel_intr(channel);
601 spin_unlock_irqrestore(&channel->recv_lock, flags);
605 * Calculate how much space is available in the tx fifo.
607 static size_t qcom_smd_get_tx_avail(struct qcom_smd_channel *channel)
611 unsigned mask = channel->fifo_size - 1;
613 head = GET_TX_CHANNEL_INFO(channel, head);
614 tail = GET_TX_CHANNEL_INFO(channel, tail);
616 return mask - ((head - tail) & mask);
620 * Write count bytes of data into channel, possibly wrapping in the ring buffer
622 static int qcom_smd_write_fifo(struct qcom_smd_channel *channel,
630 word_aligned = channel->info_word;
631 head = GET_TX_CHANNEL_INFO(channel, head);
633 len = min_t(size_t, count, channel->fifo_size - head);
635 smd_copy_to_fifo(channel->tx_fifo + head,
642 smd_copy_to_fifo(channel->tx_fifo,
649 head &= (channel->fifo_size - 1);
650 SET_TX_CHANNEL_INFO(channel, head, head);
656 * qcom_smd_send - write data to smd channel
657 * @channel: channel handle
658 * @data: buffer of data to write
659 * @len: number of bytes to write
661 * This is a blocking write of len bytes into the channel's tx ring buffer and
662 * signal the remote end. It will sleep until there is enough space available
663 * in the tx buffer, utilizing the fBLOCKREADINTR signaling mechanism to avoid
666 int qcom_smd_send(struct qcom_smd_channel *channel, const void *data, int len)
668 __le32 hdr[5] = { cpu_to_le32(len), };
669 int tlen = sizeof(hdr) + len;
672 /* Word aligned channels only accept word size aligned data */
673 if (channel->info_word && len % 4)
676 /* Reject packets that are too big */
677 if (tlen >= channel->fifo_size)
680 length = qcom_smd_get_tx_avail(channel);
682 ret = mutex_lock_interruptible(&channel->tx_lock);
686 length = qcom_smd_get_tx_avail(channel);
687 while (qcom_smd_get_tx_avail(channel) < tlen) {
688 if (channel->state != SMD_CHANNEL_OPENED) {
693 SET_TX_CHANNEL_FLAG(channel, fBLOCKREADINTR, 0);
695 ret = wait_event_interruptible(channel->fblockread_event,
696 qcom_smd_get_tx_avail(channel) >= tlen ||
697 channel->state != SMD_CHANNEL_OPENED);
701 SET_TX_CHANNEL_FLAG(channel, fBLOCKREADINTR, 1);
704 SET_TX_CHANNEL_FLAG(channel, fTAIL, 0);
706 length = qcom_smd_get_tx_avail(channel);
707 qcom_smd_write_fifo(channel, hdr, sizeof(hdr));
708 qcom_smd_write_fifo(channel, data, len);
710 SET_TX_CHANNEL_FLAG(channel, fHEAD, 1);
712 /* Ensure ordering of channel info updates */
715 qcom_smd_signal_channel(channel);
718 mutex_unlock(&channel->tx_lock);
722 EXPORT_SYMBOL(qcom_smd_send);
724 static struct qcom_smd_device *to_smd_device(struct device *dev)
726 return container_of(dev, struct qcom_smd_device, dev);
729 static struct qcom_smd_driver *to_smd_driver(struct device *dev)
731 struct qcom_smd_device *qsdev = to_smd_device(dev);
733 return container_of(qsdev->dev.driver, struct qcom_smd_driver, driver);
736 static int qcom_smd_dev_match(struct device *dev, struct device_driver *drv)
738 struct qcom_smd_device *qsdev = to_smd_device(dev);
739 struct qcom_smd_driver *qsdrv = container_of(drv, struct qcom_smd_driver, driver);
740 const struct qcom_smd_id *match = qsdrv->smd_match_table;
741 const char *name = qsdev->channel->name;
744 while (match->name[0]) {
745 if (!strcmp(match->name, name))
751 return of_driver_match_device(dev, drv);
755 * Helper for opening a channel
757 static int qcom_smd_channel_open(struct qcom_smd_channel *channel,
763 * Packets are maximum 4k, but reduce if the fifo is smaller
765 bb_size = min(channel->fifo_size, SZ_4K);
766 channel->bounce_buffer = kmalloc(bb_size, GFP_KERNEL);
767 if (!channel->bounce_buffer)
770 qcom_smd_channel_set_callback(channel, cb);
771 qcom_smd_channel_set_state(channel, SMD_CHANNEL_OPENING);
772 qcom_smd_channel_set_state(channel, SMD_CHANNEL_OPENED);
778 * Helper for closing and resetting a channel
780 static void qcom_smd_channel_close(struct qcom_smd_channel *channel)
782 qcom_smd_channel_set_callback(channel, NULL);
784 kfree(channel->bounce_buffer);
785 channel->bounce_buffer = NULL;
787 qcom_smd_channel_set_state(channel, SMD_CHANNEL_CLOSED);
788 qcom_smd_channel_reset(channel);
792 * Probe the smd client.
794 * The remote side have indicated that it want the channel to be opened, so
795 * complete the state handshake and probe our client driver.
797 static int qcom_smd_dev_probe(struct device *dev)
799 struct qcom_smd_device *qsdev = to_smd_device(dev);
800 struct qcom_smd_driver *qsdrv = to_smd_driver(dev);
801 struct qcom_smd_channel *channel = qsdev->channel;
804 ret = qcom_smd_channel_open(channel, qsdrv->callback);
808 ret = qsdrv->probe(qsdev);
812 qcom_smd_channel_resume(channel);
817 dev_err(&qsdev->dev, "probe failed\n");
819 qcom_smd_channel_close(channel);
824 * Remove the smd client.
826 * The channel is going away, for some reason, so remove the smd client and
827 * reset the channel state.
829 static int qcom_smd_dev_remove(struct device *dev)
831 struct qcom_smd_device *qsdev = to_smd_device(dev);
832 struct qcom_smd_driver *qsdrv = to_smd_driver(dev);
833 struct qcom_smd_channel *channel = qsdev->channel;
834 struct qcom_smd_channel *tmp;
835 struct qcom_smd_channel *ch;
837 qcom_smd_channel_set_state(channel, SMD_CHANNEL_CLOSING);
840 * Make sure we don't race with the code receiving data.
842 qcom_smd_channel_set_callback(channel, NULL);
844 /* Wake up any sleepers in qcom_smd_send() */
845 wake_up_interruptible(&channel->fblockread_event);
848 * We expect that the client might block in remove() waiting for any
849 * outstanding calls to qcom_smd_send() to wake up and finish.
852 qsdrv->remove(qsdev);
855 * The client is now gone, close and release all channels associated
858 list_for_each_entry_safe(ch, tmp, &channel->dev_list, dev_list) {
859 qcom_smd_channel_close(ch);
860 list_del(&ch->dev_list);
867 static struct bus_type qcom_smd_bus = {
869 .match = qcom_smd_dev_match,
870 .probe = qcom_smd_dev_probe,
871 .remove = qcom_smd_dev_remove,
875 * Release function for the qcom_smd_device object.
877 static void qcom_smd_release_device(struct device *dev)
879 struct qcom_smd_device *qsdev = to_smd_device(dev);
885 * Finds the device_node for the smd child interested in this channel.
887 static struct device_node *qcom_smd_match_channel(struct device_node *edge_node,
890 struct device_node *child;
895 for_each_available_child_of_node(edge_node, child) {
896 key = "qcom,smd-channels";
897 ret = of_property_read_string(child, key, &name);
901 if (strcmp(name, channel) == 0)
909 * Create a smd client device for channel that is being opened.
911 static int qcom_smd_create_device(struct qcom_smd_channel *channel)
913 struct qcom_smd_device *qsdev;
914 struct qcom_smd_edge *edge = channel->edge;
915 struct device_node *node;
916 struct qcom_smd *smd = edge->smd;
922 dev_dbg(smd->dev, "registering '%s'\n", channel->name);
924 qsdev = kzalloc(sizeof(*qsdev), GFP_KERNEL);
928 node = qcom_smd_match_channel(edge->of_node, channel->name);
929 dev_set_name(&qsdev->dev, "%s.%s",
931 node ? node->name : channel->name);
933 qsdev->dev.parent = smd->dev;
934 qsdev->dev.bus = &qcom_smd_bus;
935 qsdev->dev.release = qcom_smd_release_device;
936 qsdev->dev.of_node = node;
938 qsdev->channel = channel;
940 channel->qsdev = qsdev;
942 ret = device_register(&qsdev->dev);
944 dev_err(smd->dev, "device_register failed: %d\n", ret);
945 put_device(&qsdev->dev);
952 * Destroy a smd client device for a channel that's going away.
954 static void qcom_smd_destroy_device(struct qcom_smd_channel *channel)
958 BUG_ON(!channel->qsdev);
960 dev = &channel->qsdev->dev;
962 device_unregister(dev);
963 of_node_put(dev->of_node);
968 * qcom_smd_driver_register - register a smd driver
969 * @qsdrv: qcom_smd_driver struct
971 int qcom_smd_driver_register(struct qcom_smd_driver *qsdrv)
973 qsdrv->driver.bus = &qcom_smd_bus;
974 return driver_register(&qsdrv->driver);
976 EXPORT_SYMBOL(qcom_smd_driver_register);
979 * qcom_smd_driver_unregister - unregister a smd driver
980 * @qsdrv: qcom_smd_driver struct
982 void qcom_smd_driver_unregister(struct qcom_smd_driver *qsdrv)
984 driver_unregister(&qsdrv->driver);
986 EXPORT_SYMBOL(qcom_smd_driver_unregister);
988 static struct qcom_smd_channel *
989 qcom_smd_find_channel(struct qcom_smd_edge *edge, const char *name)
991 struct qcom_smd_channel *channel;
992 struct qcom_smd_channel *ret = NULL;
995 read_lock(&edge->channels_lock);
996 list_for_each_entry(channel, &edge->channels, list) {
997 if (strcmp(channel->name, name))
1000 state = GET_RX_CHANNEL_INFO(channel, state);
1001 if (state != SMD_CHANNEL_OPENING &&
1002 state != SMD_CHANNEL_OPENED)
1008 read_unlock(&edge->channels_lock);
1014 * qcom_smd_open_channel() - claim additional channels on the same edge
1015 * @sdev: smd_device handle
1016 * @name: channel name
1017 * @cb: callback method to use for incoming data
1019 * Returns a channel handle on success, or -EPROBE_DEFER if the channel isn't
1022 struct qcom_smd_channel *qcom_smd_open_channel(struct qcom_smd_device *sdev,
1026 struct qcom_smd_channel *channel;
1027 struct qcom_smd_edge *edge = sdev->channel->edge;
1030 /* Wait up to HZ for the channel to appear */
1031 ret = wait_event_interruptible_timeout(edge->new_channel_event,
1032 (channel = qcom_smd_find_channel(edge, name)) != NULL,
1035 return ERR_PTR(-ETIMEDOUT);
1037 if (channel->state != SMD_CHANNEL_CLOSED) {
1038 dev_err(&sdev->dev, "channel %s is busy\n", channel->name);
1039 return ERR_PTR(-EBUSY);
1042 channel->qsdev = sdev;
1043 ret = qcom_smd_channel_open(channel, cb);
1045 channel->qsdev = NULL;
1046 return ERR_PTR(ret);
1050 * Append the list of channel to the channels associated with the sdev
1052 list_add_tail(&channel->dev_list, &sdev->channel->dev_list);
1056 EXPORT_SYMBOL(qcom_smd_open_channel);
1059 * Allocate the qcom_smd_channel object for a newly found smd channel,
1060 * retrieving and validating the smem items involved.
1062 static struct qcom_smd_channel *qcom_smd_create_channel(struct qcom_smd_edge *edge,
1063 unsigned smem_info_item,
1064 unsigned smem_fifo_item,
1067 struct qcom_smd_channel *channel;
1068 struct qcom_smd *smd = edge->smd;
1075 channel = devm_kzalloc(smd->dev, sizeof(*channel), GFP_KERNEL);
1077 return ERR_PTR(-ENOMEM);
1079 INIT_LIST_HEAD(&channel->dev_list);
1080 channel->edge = edge;
1081 channel->name = devm_kstrdup(smd->dev, name, GFP_KERNEL);
1083 return ERR_PTR(-ENOMEM);
1085 mutex_init(&channel->tx_lock);
1086 spin_lock_init(&channel->recv_lock);
1087 init_waitqueue_head(&channel->fblockread_event);
1089 info = qcom_smem_get(edge->remote_pid, smem_info_item, &info_size);
1091 ret = PTR_ERR(info);
1092 goto free_name_and_channel;
1096 * Use the size of the item to figure out which channel info struct to
1099 if (info_size == 2 * sizeof(struct smd_channel_info_word)) {
1100 channel->info_word = info;
1101 } else if (info_size == 2 * sizeof(struct smd_channel_info)) {
1102 channel->info = info;
1105 "channel info of size %zu not supported\n", info_size);
1107 goto free_name_and_channel;
1110 fifo_base = qcom_smem_get(edge->remote_pid, smem_fifo_item, &fifo_size);
1111 if (IS_ERR(fifo_base)) {
1112 ret = PTR_ERR(fifo_base);
1113 goto free_name_and_channel;
1116 /* The channel consist of a rx and tx fifo of equal size */
1119 dev_err(smd->dev, "new channel '%s' info-size: %zu fifo-size: %zu\n",
1120 name, info_size, fifo_size);
1122 channel->tx_fifo = fifo_base;
1123 channel->rx_fifo = fifo_base + fifo_size;
1124 channel->fifo_size = fifo_size;
1126 qcom_smd_channel_reset(channel);
1130 free_name_and_channel:
1131 devm_kfree(smd->dev, channel->name);
1132 devm_kfree(smd->dev, channel);
1134 return ERR_PTR(ret);
1138 * Scans the allocation table for any newly allocated channels, calls
1139 * qcom_smd_create_channel() to create representations of these and add
1140 * them to the edge's list of channels.
1142 static void qcom_channel_scan_worker(struct work_struct *work)
1144 struct qcom_smd_edge *edge = container_of(work, struct qcom_smd_edge, scan_work);
1145 struct qcom_smd_alloc_entry *alloc_tbl;
1146 struct qcom_smd_alloc_entry *entry;
1147 struct qcom_smd_channel *channel;
1148 struct qcom_smd *smd = edge->smd;
1149 unsigned long flags;
1156 for (tbl = 0; tbl < SMD_ALLOC_TBL_COUNT; tbl++) {
1157 alloc_tbl = qcom_smem_get(edge->remote_pid,
1158 smem_items[tbl].alloc_tbl_id, NULL);
1159 if (IS_ERR(alloc_tbl))
1162 for (i = 0; i < SMD_ALLOC_TBL_SIZE; i++) {
1163 entry = &alloc_tbl[i];
1164 eflags = le32_to_cpu(entry->flags);
1165 if (test_bit(i, edge->allocated[tbl]))
1168 if (entry->ref_count == 0)
1171 if (!entry->name[0])
1174 if (!(eflags & SMD_CHANNEL_FLAGS_PACKET))
1177 if ((eflags & SMD_CHANNEL_FLAGS_EDGE_MASK) != edge->edge_id)
1180 cid = le32_to_cpu(entry->cid);
1181 info_id = smem_items[tbl].info_base_id + cid;
1182 fifo_id = smem_items[tbl].fifo_base_id + cid;
1184 channel = qcom_smd_create_channel(edge, info_id, fifo_id, entry->name);
1185 if (IS_ERR(channel))
1188 write_lock_irqsave(&edge->channels_lock, flags);
1189 list_add(&channel->list, &edge->channels);
1190 write_unlock_irqrestore(&edge->channels_lock, flags);
1192 dev_dbg(smd->dev, "new channel found: '%s'\n", channel->name);
1193 set_bit(i, edge->allocated[tbl]);
1195 wake_up_interruptible(&edge->new_channel_event);
1199 schedule_work(&edge->state_work);
1203 * This per edge worker scans smem for any new channels and register these. It
1204 * then scans all registered channels for state changes that should be handled
1205 * by creating or destroying smd client devices for the registered channels.
1207 * LOCKING: edge->channels_lock only needs to cover the list operations, as the
1208 * worker is killed before any channels are deallocated
1210 static void qcom_channel_state_worker(struct work_struct *work)
1212 struct qcom_smd_channel *channel;
1213 struct qcom_smd_edge *edge = container_of(work,
1214 struct qcom_smd_edge,
1216 unsigned remote_state;
1219 * Register a device for any closed channel where the remote processor
1220 * is showing interest in opening the channel.
1222 read_lock(&edge->channels_lock);
1223 list_for_each_entry(channel, &edge->channels, list) {
1224 if (channel->state != SMD_CHANNEL_CLOSED)
1227 remote_state = GET_RX_CHANNEL_INFO(channel, state);
1228 if (remote_state != SMD_CHANNEL_OPENING &&
1229 remote_state != SMD_CHANNEL_OPENED)
1232 read_unlock(&edge->channels_lock);
1233 qcom_smd_create_device(channel);
1234 read_lock(&edge->channels_lock);
1238 * Unregister the device for any channel that is opened where the
1239 * remote processor is closing the channel.
1241 list_for_each_entry(channel, &edge->channels, list) {
1242 if (channel->state != SMD_CHANNEL_OPENING &&
1243 channel->state != SMD_CHANNEL_OPENED)
1246 remote_state = GET_RX_CHANNEL_INFO(channel, state);
1247 if (remote_state == SMD_CHANNEL_OPENING ||
1248 remote_state == SMD_CHANNEL_OPENED)
1251 read_unlock(&edge->channels_lock);
1252 qcom_smd_destroy_device(channel);
1253 read_lock(&edge->channels_lock);
1255 read_unlock(&edge->channels_lock);
1259 * Parses an of_node describing an edge.
1261 static int qcom_smd_parse_edge(struct device *dev,
1262 struct device_node *node,
1263 struct qcom_smd_edge *edge)
1265 struct device_node *syscon_np;
1270 INIT_LIST_HEAD(&edge->channels);
1271 rwlock_init(&edge->channels_lock);
1273 INIT_WORK(&edge->scan_work, qcom_channel_scan_worker);
1274 INIT_WORK(&edge->state_work, qcom_channel_state_worker);
1276 edge->of_node = of_node_get(node);
1278 irq = irq_of_parse_and_map(node, 0);
1280 dev_err(dev, "required smd interrupt missing\n");
1284 ret = devm_request_irq(dev, irq,
1285 qcom_smd_edge_intr, IRQF_TRIGGER_RISING,
1288 dev_err(dev, "failed to request smd irq\n");
1294 key = "qcom,smd-edge";
1295 ret = of_property_read_u32(node, key, &edge->edge_id);
1297 dev_err(dev, "edge missing %s property\n", key);
1301 edge->remote_pid = QCOM_SMEM_HOST_ANY;
1302 key = "qcom,remote-pid";
1303 ret = of_property_read_u32(node, key, &edge->remote_pid);
1305 dev_err(dev, "edge missing %s property\n", key);
1309 syscon_np = of_parse_phandle(node, "qcom,ipc", 0);
1311 dev_err(dev, "no qcom,ipc node\n");
1315 edge->ipc_regmap = syscon_node_to_regmap(syscon_np);
1316 if (IS_ERR(edge->ipc_regmap))
1317 return PTR_ERR(edge->ipc_regmap);
1320 ret = of_property_read_u32_index(node, key, 1, &edge->ipc_offset);
1322 dev_err(dev, "no offset in %s\n", key);
1326 ret = of_property_read_u32_index(node, key, 2, &edge->ipc_bit);
1328 dev_err(dev, "no bit in %s\n", key);
1335 static int qcom_smd_probe(struct platform_device *pdev)
1337 struct qcom_smd_edge *edge;
1338 struct device_node *node;
1339 struct qcom_smd *smd;
1347 p = qcom_smem_get(QCOM_SMEM_HOST_ANY, smem_items[0].alloc_tbl_id, NULL);
1348 if (PTR_ERR(p) == -EPROBE_DEFER)
1351 num_edges = of_get_available_child_count(pdev->dev.of_node);
1352 array_size = sizeof(*smd) + num_edges * sizeof(struct qcom_smd_edge);
1353 smd = devm_kzalloc(&pdev->dev, array_size, GFP_KERNEL);
1356 smd->dev = &pdev->dev;
1358 smd->num_edges = num_edges;
1359 for_each_available_child_of_node(pdev->dev.of_node, node) {
1360 edge = &smd->edges[i++];
1362 init_waitqueue_head(&edge->new_channel_event);
1364 ret = qcom_smd_parse_edge(&pdev->dev, node, edge);
1368 schedule_work(&edge->scan_work);
1371 platform_set_drvdata(pdev, smd);
1377 * Shut down all smd clients by making sure that each edge stops processing
1378 * events and scanning for new channels, then call destroy on the devices.
1380 static int qcom_smd_remove(struct platform_device *pdev)
1382 struct qcom_smd_channel *channel;
1383 struct qcom_smd_edge *edge;
1384 struct qcom_smd *smd = platform_get_drvdata(pdev);
1387 for (i = 0; i < smd->num_edges; i++) {
1388 edge = &smd->edges[i];
1390 disable_irq(edge->irq);
1391 cancel_work_sync(&edge->scan_work);
1392 cancel_work_sync(&edge->state_work);
1394 /* No need to lock here, because the writer is gone */
1395 list_for_each_entry(channel, &edge->channels, list) {
1396 if (!channel->qsdev)
1399 qcom_smd_destroy_device(channel);
1406 static const struct of_device_id qcom_smd_of_match[] = {
1407 { .compatible = "qcom,smd" },
1410 MODULE_DEVICE_TABLE(of, qcom_smd_of_match);
1412 static struct platform_driver qcom_smd_driver = {
1413 .probe = qcom_smd_probe,
1414 .remove = qcom_smd_remove,
1417 .of_match_table = qcom_smd_of_match,
1421 static int __init qcom_smd_init(void)
1425 ret = bus_register(&qcom_smd_bus);
1427 pr_err("failed to register smd bus: %d\n", ret);
1431 return platform_driver_register(&qcom_smd_driver);
1433 postcore_initcall(qcom_smd_init);
1435 static void __exit qcom_smd_exit(void)
1437 platform_driver_unregister(&qcom_smd_driver);
1438 bus_unregister(&qcom_smd_bus);
1440 module_exit(qcom_smd_exit);
1442 MODULE_AUTHOR("Bjorn Andersson <bjorn.andersson@sonymobile.com>");
1443 MODULE_DESCRIPTION("Qualcomm Shared Memory Driver");
1444 MODULE_LICENSE("GPL v2");