1 /* arch/arm/mach-msm/smd.c
3 * Copyright (C) 2007 Google, Inc.
4 * Author: Brian Swetland <swetland@google.com>
6 * This software is licensed under the terms of the GNU General Public
7 * License version 2, as published by the Free Software Foundation, and
8 * may be copied, distributed, and modified under those terms.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
17 #include <linux/platform_device.h>
18 #include <linux/module.h>
20 #include <linux/cdev.h>
21 #include <linux/device.h>
22 #include <linux/wait.h>
23 #include <linux/interrupt.h>
24 #include <linux/irq.h>
25 #include <linux/list.h>
26 #include <linux/slab.h>
27 #include <linux/debugfs.h>
28 #include <linux/delay.h>
30 #include <mach/msm_smd.h>
31 #include <mach/system.h>
33 #include "smd_private.h"
34 #include "proc_comm.h"
36 #if defined(CONFIG_ARCH_QSD8X50)
37 #define CONFIG_QDSP6 1
40 void (*msm_hw_reset_hook)(void);
42 #define MODULE_NAME "msm_smd"
45 MSM_SMD_DEBUG = 1U << 0,
46 MSM_SMSM_DEBUG = 1U << 0,
49 static int msm_smd_debug_mask;
56 static unsigned dummy_state[SMSM_STATE_COUNT];
58 static struct shared_info smd_info = {
59 .state = (unsigned) &dummy_state,
62 module_param_named(debug_mask, msm_smd_debug_mask,
63 int, S_IRUGO | S_IWUSR | S_IWGRP);
65 static unsigned last_heap_free = 0xffffffff;
67 static inline void notify_other_smsm(void)
75 static inline void notify_modem_smd(void)
80 static inline void notify_dsp_smd(void)
85 static void smd_diag(void)
89 x = smem_find(ID_DIAG_ERR_MSG, SZ_DIAG_ERR_MSG);
91 x[SZ_DIAG_ERR_MSG - 1] = 0;
92 pr_info("smem: DIAG '%s'\n", x);
96 /* call when SMSM_RESET flag is set in the A9's smsm_state */
97 static void handle_modem_crash(void)
99 pr_err("ARM9 has CRASHED\n");
102 /* hard reboot if possible */
103 if (msm_hw_reset_hook)
106 /* in this case the modem or watchdog should reboot us */
111 uint32_t raw_smsm_get_state(enum smsm_state_item item)
113 return readl(smd_info.state + item * 4);
116 static int check_for_modem_crash(void)
118 if (raw_smsm_get_state(SMSM_STATE_MODEM) & SMSM_RESET) {
119 handle_modem_crash();
125 /* the spinlock is used to synchronize between the
126 * irq handler and code that mutates the channel
127 * list or fiddles with channel state
129 DEFINE_SPINLOCK(smd_lock);
130 DEFINE_SPINLOCK(smem_lock);
132 /* the mutex is used during open() and close()
133 * operations to avoid races while creating or
134 * destroying smd_channel structures
136 static DEFINE_MUTEX(smd_creation_mutex);
138 static int smd_initialized;
140 LIST_HEAD(smd_ch_closed_list);
141 LIST_HEAD(smd_ch_list_modem);
142 LIST_HEAD(smd_ch_list_dsp);
144 static unsigned char smd_ch_allocated[64];
145 static struct work_struct probe_work;
147 /* how many bytes are available for reading */
148 static int smd_stream_read_avail(struct smd_channel *ch)
150 return (ch->recv->head - ch->recv->tail) & ch->fifo_mask;
153 /* how many bytes we are free to write */
154 static int smd_stream_write_avail(struct smd_channel *ch)
156 return ch->fifo_mask -
157 ((ch->send->head - ch->send->tail) & ch->fifo_mask);
160 static int smd_packet_read_avail(struct smd_channel *ch)
162 if (ch->current_packet) {
163 int n = smd_stream_read_avail(ch);
164 if (n > ch->current_packet)
165 n = ch->current_packet;
172 static int smd_packet_write_avail(struct smd_channel *ch)
174 int n = smd_stream_write_avail(ch);
175 return n > SMD_HEADER_SIZE ? n - SMD_HEADER_SIZE : 0;
178 static int ch_is_open(struct smd_channel *ch)
180 return (ch->recv->state == SMD_SS_OPENED) &&
181 (ch->send->state == SMD_SS_OPENED);
184 /* provide a pointer and length to readable data in the fifo */
185 static unsigned ch_read_buffer(struct smd_channel *ch, void **ptr)
187 unsigned head = ch->recv->head;
188 unsigned tail = ch->recv->tail;
189 *ptr = (void *) (ch->recv_data + tail);
194 return ch->fifo_size - tail;
197 /* advance the fifo read pointer after data from ch_read_buffer is consumed */
198 static void ch_read_done(struct smd_channel *ch, unsigned count)
200 BUG_ON(count > smd_stream_read_avail(ch));
201 ch->recv->tail = (ch->recv->tail + count) & ch->fifo_mask;
205 /* basic read interface to ch_read_{buffer,done} used
206 * by smd_*_read() and update_packet_state()
207 * will read-and-discard if the _data pointer is null
209 static int ch_read(struct smd_channel *ch, void *_data, int len)
213 unsigned char *data = _data;
217 n = ch_read_buffer(ch, &ptr);
224 memcpy(data, ptr, n);
231 return orig_len - len;
234 static void update_stream_state(struct smd_channel *ch)
236 /* streams have no special state requiring updating */
239 static void update_packet_state(struct smd_channel *ch)
244 /* can't do anything if we're in the middle of a packet */
245 if (ch->current_packet != 0)
248 /* don't bother unless we can get the full header */
249 if (smd_stream_read_avail(ch) < SMD_HEADER_SIZE)
252 r = ch_read(ch, hdr, SMD_HEADER_SIZE);
253 BUG_ON(r != SMD_HEADER_SIZE);
255 ch->current_packet = hdr[0];
258 /* provide a pointer and length to next free space in the fifo */
259 static unsigned ch_write_buffer(struct smd_channel *ch, void **ptr)
261 unsigned head = ch->send->head;
262 unsigned tail = ch->send->tail;
263 *ptr = (void *) (ch->send_data + head);
266 return tail - head - 1;
269 return ch->fifo_size - head - 1;
271 return ch->fifo_size - head;
275 /* advace the fifo write pointer after freespace
276 * from ch_write_buffer is filled
278 static void ch_write_done(struct smd_channel *ch, unsigned count)
280 BUG_ON(count > smd_stream_write_avail(ch));
281 ch->send->head = (ch->send->head + count) & ch->fifo_mask;
285 static void ch_set_state(struct smd_channel *ch, unsigned n)
287 if (n == SMD_SS_OPENED) {
297 ch->send->fSTATE = 1;
298 ch->notify_other_cpu();
301 static void do_smd_probe(void)
303 struct smem_shared *shared = (void *) MSM_SHARED_RAM_BASE;
304 if (shared->heap_info.free_offset != last_heap_free) {
305 last_heap_free = shared->heap_info.free_offset;
306 schedule_work(&probe_work);
310 static void smd_state_change(struct smd_channel *ch,
311 unsigned last, unsigned next)
313 ch->last_state = next;
315 pr_info("SMD: ch %d %d -> %d\n", ch->n, last, next);
321 if (ch->send->state != SMD_SS_OPENED)
322 ch_set_state(ch, SMD_SS_OPENED);
323 ch->notify(ch->priv, SMD_EVENT_OPEN);
325 case SMD_SS_FLUSHING:
327 /* we should force them to close? */
329 ch->notify(ch->priv, SMD_EVENT_CLOSE);
333 static void handle_smd_irq(struct list_head *list, void (*notify)(void))
336 struct smd_channel *ch;
341 spin_lock_irqsave(&smd_lock, flags);
342 list_for_each_entry(ch, list, ch_list) {
344 if (ch_is_open(ch)) {
345 if (ch->recv->fHEAD) {
350 if (ch->recv->fTAIL) {
355 if (ch->recv->fSTATE) {
356 ch->recv->fSTATE = 0;
361 tmp = ch->recv->state;
362 if (tmp != ch->last_state)
363 smd_state_change(ch, ch->last_state, tmp);
365 ch->update_state(ch);
366 ch->notify(ch->priv, SMD_EVENT_DATA);
371 spin_unlock_irqrestore(&smd_lock, flags);
375 static irqreturn_t smd_modem_irq_handler(int irq, void *data)
377 handle_smd_irq(&smd_ch_list_modem, notify_modem_smd);
381 #if defined(CONFIG_QDSP6)
382 static irqreturn_t smd_dsp_irq_handler(int irq, void *data)
384 handle_smd_irq(&smd_ch_list_dsp, notify_dsp_smd);
389 static void smd_fake_irq_handler(unsigned long arg)
391 handle_smd_irq(&smd_ch_list_modem, notify_modem_smd);
392 handle_smd_irq(&smd_ch_list_dsp, notify_dsp_smd);
395 static DECLARE_TASKLET(smd_fake_irq_tasklet, smd_fake_irq_handler, 0);
397 static inline int smd_need_int(struct smd_channel *ch)
399 if (ch_is_open(ch)) {
400 if (ch->recv->fHEAD || ch->recv->fTAIL || ch->recv->fSTATE)
402 if (ch->recv->state != ch->last_state)
408 void smd_sleep_exit(void)
411 struct smd_channel *ch;
414 spin_lock_irqsave(&smd_lock, flags);
415 list_for_each_entry(ch, &smd_ch_list_modem, ch_list) {
416 if (smd_need_int(ch)) {
421 list_for_each_entry(ch, &smd_ch_list_dsp, ch_list) {
422 if (smd_need_int(ch)) {
427 spin_unlock_irqrestore(&smd_lock, flags);
431 if (msm_smd_debug_mask & MSM_SMD_DEBUG)
432 pr_info("smd_sleep_exit need interrupt\n");
433 tasklet_schedule(&smd_fake_irq_tasklet);
438 void smd_kick(smd_channel_t *ch)
443 spin_lock_irqsave(&smd_lock, flags);
444 ch->update_state(ch);
445 tmp = ch->recv->state;
446 if (tmp != ch->last_state) {
447 ch->last_state = tmp;
448 if (tmp == SMD_SS_OPENED)
449 ch->notify(ch->priv, SMD_EVENT_OPEN);
451 ch->notify(ch->priv, SMD_EVENT_CLOSE);
453 ch->notify(ch->priv, SMD_EVENT_DATA);
454 ch->notify_other_cpu();
455 spin_unlock_irqrestore(&smd_lock, flags);
458 static int smd_is_packet(int chn, unsigned type)
460 type &= SMD_KIND_MASK;
461 if (type == SMD_KIND_PACKET)
463 if (type == SMD_KIND_STREAM)
466 /* older AMSS reports SMD_KIND_UNKNOWN always */
467 if ((chn > 4) || (chn == 1))
473 static int smd_stream_write(smd_channel_t *ch, const void *_data, int len)
476 const unsigned char *buf = _data;
483 while ((xfer = ch_write_buffer(ch, &ptr)) != 0) {
488 memcpy(ptr, buf, xfer);
489 ch_write_done(ch, xfer);
496 ch->notify_other_cpu();
498 return orig_len - len;
501 static int smd_packet_write(smd_channel_t *ch, const void *_data, int len)
508 if (smd_stream_write_avail(ch) < (len + SMD_HEADER_SIZE))
512 hdr[1] = hdr[2] = hdr[3] = hdr[4] = 0;
514 smd_stream_write(ch, hdr, sizeof(hdr));
515 smd_stream_write(ch, _data, len);
520 static int smd_stream_read(smd_channel_t *ch, void *data, int len)
527 r = ch_read(ch, data, len);
529 ch->notify_other_cpu();
534 static int smd_packet_read(smd_channel_t *ch, void *data, int len)
542 if (len > ch->current_packet)
543 len = ch->current_packet;
545 r = ch_read(ch, data, len);
547 ch->notify_other_cpu();
549 spin_lock_irqsave(&smd_lock, flags);
550 ch->current_packet -= r;
551 update_packet_state(ch);
552 spin_unlock_irqrestore(&smd_lock, flags);
557 static int smd_alloc_channel(const char *name, uint32_t cid, uint32_t type)
559 struct smd_channel *ch;
561 ch = kzalloc(sizeof(struct smd_channel), GFP_KERNEL);
563 pr_err("smd_alloc_channel() out of memory\n");
568 if (_smd_alloc_channel(ch)) {
573 ch->fifo_mask = ch->fifo_size - 1;
576 if ((type & SMD_TYPE_MASK) == SMD_TYPE_APPS_MODEM)
577 ch->notify_other_cpu = notify_modem_smd;
579 ch->notify_other_cpu = notify_dsp_smd;
581 if (smd_is_packet(cid, type)) {
582 ch->read = smd_packet_read;
583 ch->write = smd_packet_write;
584 ch->read_avail = smd_packet_read_avail;
585 ch->write_avail = smd_packet_write_avail;
586 ch->update_state = update_packet_state;
588 ch->read = smd_stream_read;
589 ch->write = smd_stream_write;
590 ch->read_avail = smd_stream_read_avail;
591 ch->write_avail = smd_stream_write_avail;
592 ch->update_state = update_stream_state;
595 if ((type & 0xff) == 0)
596 memcpy(ch->name, "SMD_", 4);
598 memcpy(ch->name, "DSP_", 4);
599 memcpy(ch->name + 4, name, 20);
601 ch->pdev.name = ch->name;
604 pr_info("smd_alloc_channel() cid=%02d size=%05d '%s'\n",
605 ch->n, ch->fifo_size, ch->name);
607 mutex_lock(&smd_creation_mutex);
608 list_add(&ch->ch_list, &smd_ch_closed_list);
609 mutex_unlock(&smd_creation_mutex);
611 platform_device_register(&ch->pdev);
615 static void smd_channel_probe_worker(struct work_struct *work)
617 struct smd_alloc_elm *shared;
622 shared = smem_find(ID_CH_ALLOC_TBL, sizeof(*shared) * 64);
624 pr_err("smd: cannot find allocation table\n");
627 for (n = 0; n < 64; n++) {
628 if (smd_ch_allocated[n])
630 if (!shared[n].ref_count)
632 if (!shared[n].name[0])
634 ctype = shared[n].ctype;
635 type = ctype & SMD_TYPE_MASK;
637 /* DAL channels are stream but neither the modem,
638 * nor the DSP correctly indicate this. Fixup manually.
640 if (!memcmp(shared[n].name, "DAL", 3))
641 ctype = (ctype & (~SMD_KIND_MASK)) | SMD_KIND_STREAM;
643 type = shared[n].ctype & SMD_TYPE_MASK;
644 if ((type == SMD_TYPE_APPS_MODEM) ||
645 (type == SMD_TYPE_APPS_DSP))
646 if (!smd_alloc_channel(shared[n].name, shared[n].cid, ctype))
647 smd_ch_allocated[n] = 1;
651 static void do_nothing_notify(void *priv, unsigned flags)
655 struct smd_channel *smd_get_channel(const char *name)
657 struct smd_channel *ch;
659 mutex_lock(&smd_creation_mutex);
660 list_for_each_entry(ch, &smd_ch_closed_list, ch_list) {
661 if (!strcmp(name, ch->name)) {
662 list_del(&ch->ch_list);
663 mutex_unlock(&smd_creation_mutex);
667 mutex_unlock(&smd_creation_mutex);
672 int smd_open(const char *name, smd_channel_t **_ch,
673 void *priv, void (*notify)(void *, unsigned))
675 struct smd_channel *ch;
678 if (smd_initialized == 0) {
679 pr_info("smd_open() before smd_init()\n");
683 ch = smd_get_channel(name);
688 notify = do_nothing_notify;
691 ch->current_packet = 0;
692 ch->last_state = SMD_SS_CLOSED;
697 spin_lock_irqsave(&smd_lock, flags);
699 if ((ch->type & SMD_TYPE_MASK) == SMD_TYPE_APPS_MODEM)
700 list_add(&ch->ch_list, &smd_ch_list_modem);
702 list_add(&ch->ch_list, &smd_ch_list_dsp);
704 /* If the remote side is CLOSING, we need to get it to
705 * move to OPENING (which we'll do by moving from CLOSED to
706 * OPENING) and then get it to move from OPENING to
707 * OPENED (by doing the same state change ourselves).
709 * Otherwise, it should be OPENING and we can move directly
710 * to OPENED so that it will follow.
712 if (ch->recv->state == SMD_SS_CLOSING) {
714 ch_set_state(ch, SMD_SS_OPENING);
716 ch_set_state(ch, SMD_SS_OPENED);
718 spin_unlock_irqrestore(&smd_lock, flags);
724 int smd_close(smd_channel_t *ch)
728 pr_info("smd_close(%p)\n", ch);
733 spin_lock_irqsave(&smd_lock, flags);
734 ch->notify = do_nothing_notify;
735 list_del(&ch->ch_list);
736 ch_set_state(ch, SMD_SS_CLOSED);
737 spin_unlock_irqrestore(&smd_lock, flags);
739 mutex_lock(&smd_creation_mutex);
740 list_add(&ch->ch_list, &smd_ch_closed_list);
741 mutex_unlock(&smd_creation_mutex);
746 int smd_read(smd_channel_t *ch, void *data, int len)
748 return ch->read(ch, data, len);
751 int smd_write(smd_channel_t *ch, const void *data, int len)
753 return ch->write(ch, data, len);
756 int smd_write_atomic(smd_channel_t *ch, const void *data, int len)
760 spin_lock_irqsave(&smd_lock, flags);
761 res = ch->write(ch, data, len);
762 spin_unlock_irqrestore(&smd_lock, flags);
766 int smd_read_avail(smd_channel_t *ch)
768 return ch->read_avail(ch);
771 int smd_write_avail(smd_channel_t *ch)
773 return ch->write_avail(ch);
776 int smd_wait_until_readable(smd_channel_t *ch, int bytes)
781 int smd_wait_until_writable(smd_channel_t *ch, int bytes)
786 int smd_cur_packet_size(smd_channel_t *ch)
788 return ch->current_packet;
792 /* ------------------------------------------------------------------------- */
794 void *smem_alloc(unsigned id, unsigned size)
796 return smem_find(id, size);
799 void *smem_item(unsigned id, unsigned *size)
801 struct smem_shared *shared = (void *) MSM_SHARED_RAM_BASE;
802 struct smem_heap_entry *toc = shared->heap_toc;
804 if (id >= SMEM_NUM_ITEMS)
807 if (toc[id].allocated) {
808 *size = toc[id].size;
809 return (void *) (MSM_SHARED_RAM_BASE + toc[id].offset);
817 void *smem_find(unsigned id, unsigned size_in)
822 ptr = smem_item(id, &size);
826 size_in = ALIGN(size_in, 8);
827 if (size_in != size) {
828 pr_err("smem_find(%d, %d): wrong size %d\n",
836 static irqreturn_t smsm_irq_handler(int irq, void *data)
841 spin_lock_irqsave(&smem_lock, flags);
843 apps = raw_smsm_get_state(SMSM_STATE_APPS);
844 modm = raw_smsm_get_state(SMSM_STATE_MODEM);
846 if (msm_smd_debug_mask & MSM_SMSM_DEBUG)
847 pr_info("<SM %08x %08x>\n", apps, modm);
848 if (modm & SMSM_RESET)
849 handle_modem_crash();
853 spin_unlock_irqrestore(&smem_lock, flags);
857 int smsm_change_state(enum smsm_state_item item,
858 uint32_t clear_mask, uint32_t set_mask)
860 unsigned long addr = smd_info.state + item * 4;
867 spin_lock_irqsave(&smem_lock, flags);
869 if (raw_smsm_get_state(SMSM_STATE_MODEM) & SMSM_RESET)
870 handle_modem_crash();
872 state = (readl(addr) & ~clear_mask) | set_mask;
875 if (msm_smd_debug_mask & MSM_SMSM_DEBUG)
876 pr_info("smsm_change_state %d %x\n", item, state);
879 spin_unlock_irqrestore(&smem_lock, flags);
884 uint32_t smsm_get_state(enum smsm_state_item item)
889 spin_lock_irqsave(&smem_lock, flags);
891 rv = readl(smd_info.state + item * 4);
893 if (item == SMSM_STATE_MODEM && (rv & SMSM_RESET))
894 handle_modem_crash();
896 spin_unlock_irqrestore(&smem_lock, flags);
901 #ifdef CONFIG_ARCH_MSM_SCORPION
903 int smsm_set_sleep_duration(uint32_t delay)
905 struct msm_dem_slave_data *ptr;
907 ptr = smem_find(SMEM_APPS_DEM_SLAVE_DATA, sizeof(*ptr));
909 pr_err("smsm_set_sleep_duration <SM NO APPS_DEM_SLAVE_DATA>\n");
912 if (msm_smd_debug_mask & MSM_SMSM_DEBUG)
913 pr_info("smsm_set_sleep_duration %d -> %d\n",
914 ptr->sleep_time, delay);
915 ptr->sleep_time = delay;
921 int smsm_set_sleep_duration(uint32_t delay)
925 ptr = smem_find(SMEM_SMSM_SLEEP_DELAY, sizeof(*ptr));
927 pr_err("smsm_set_sleep_duration <SM NO SLEEP_DELAY>\n");
930 if (msm_smd_debug_mask & MSM_SMSM_DEBUG)
931 pr_info("smsm_set_sleep_duration %d -> %d\n",
939 int smd_core_init(void)
942 pr_info("smd_core_init()\n");
944 /* wait for essential items to be initialized */
948 state = smem_item(SMEM_SMSM_SHARED_STATE, &size);
949 if (size == SMSM_V1_SIZE || size == SMSM_V2_SIZE) {
950 smd_info.state = (unsigned)state;
957 r = request_irq(INT_A9_M2A_0, smd_modem_irq_handler,
958 IRQF_TRIGGER_RISING, "smd_dev", 0);
961 r = enable_irq_wake(INT_A9_M2A_0);
963 pr_err("smd_core_init: enable_irq_wake failed for A9_M2A_0\n");
965 r = request_irq(INT_A9_M2A_5, smsm_irq_handler,
966 IRQF_TRIGGER_RISING, "smsm_dev", 0);
968 free_irq(INT_A9_M2A_0, 0);
971 r = enable_irq_wake(INT_A9_M2A_5);
973 pr_err("smd_core_init: enable_irq_wake failed for A9_M2A_5\n");
975 #if defined(CONFIG_QDSP6)
976 r = request_irq(INT_ADSP_A11, smd_dsp_irq_handler,
977 IRQF_TRIGGER_RISING, "smd_dsp", 0);
979 free_irq(INT_A9_M2A_0, 0);
980 free_irq(INT_A9_M2A_5, 0);
985 /* check for any SMD channels that may already exist */
988 /* indicate that we're up and running */
989 smsm_change_state(SMSM_STATE_APPS,
990 ~0, SMSM_INIT | SMSM_SMDINIT | SMSM_RPCINIT | SMSM_RUN);
991 #ifdef CONFIG_ARCH_MSM_SCORPION
992 smsm_change_state(SMSM_STATE_APPS_DEM, ~0, 0);
995 pr_info("smd_core_init() done\n");
1000 static int __devinit msm_smd_probe(struct platform_device *pdev)
1002 pr_info("smd_init()\n");
1005 * If we haven't waited for the ARM9 to boot up till now,
1006 * then we need to wait here. Otherwise this should just
1007 * return immediately.
1009 proc_comm_boot_wait();
1011 INIT_WORK(&probe_work, smd_channel_probe_worker);
1013 if (smd_core_init()) {
1014 pr_err("smd_core_init() failed\n");
1020 msm_check_for_modem_crash = check_for_modem_crash;
1022 msm_init_last_radio_log(THIS_MODULE);
1024 smd_initialized = 1;
1029 static struct platform_driver msm_smd_driver = {
1030 .probe = msm_smd_probe,
1032 .name = MODULE_NAME,
1033 .owner = THIS_MODULE,
1037 static int __init msm_smd_init(void)
1039 return platform_driver_register(&msm_smd_driver);
1042 module_init(msm_smd_init);
1044 MODULE_DESCRIPTION("MSM Shared Memory Core");
1045 MODULE_AUTHOR("Brian Swetland <swetland@google.com>");
1046 MODULE_LICENSE("GPL");