mailbox.c 9.13 KB
Newer Older
1
2
3
/*
 * OMAP mailbox driver
 *
4
 * Copyright (C) 2006-2009 Nokia Corporation. All rights reserved.
5
 *
6
 * Contact: Hiroshi DOYU <Hiroshi.DOYU@nokia.com>
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * version 2 as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */

#include <linux/interrupt.h>
25
26
#include <linux/spinlock.h>
#include <linux/mutex.h>
27
#include <linux/delay.h>
28
#include <linux/slab.h>
29
30
#include <linux/kfifo.h>
#include <linux/err.h>
31
#include <linux/notifier.h>
32
#include <linux/module.h>
33

34
#include <plat/mailbox.h>
35

36
static struct omap_mbox **mboxes;
37

38
static int mbox_configured;
39
static DEFINE_MUTEX(mbox_configured_lock);
40

41
42
43
44
static unsigned int mbox_kfifo_size = CONFIG_OMAP_MBOX_KFIFO_SIZE;
module_param(mbox_kfifo_size, uint, S_IRUGO);
MODULE_PARM_DESC(mbox_kfifo_size, "Size of omap's mailbox kfifo (bytes)");

45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
/* Mailbox FIFO handle functions */
static inline mbox_msg_t mbox_fifo_read(struct omap_mbox *mbox)
{
	return mbox->ops->fifo_read(mbox);
}
static inline void mbox_fifo_write(struct omap_mbox *mbox, mbox_msg_t msg)
{
	mbox->ops->fifo_write(mbox, msg);
}
static inline int mbox_fifo_empty(struct omap_mbox *mbox)
{
	return mbox->ops->fifo_empty(mbox);
}
static inline int mbox_fifo_full(struct omap_mbox *mbox)
{
	return mbox->ops->fifo_full(mbox);
}

/* Mailbox IRQ handle functions */
static inline void ack_mbox_irq(struct omap_mbox *mbox, omap_mbox_irq_t irq)
{
	if (mbox->ops->ack_irq)
		mbox->ops->ack_irq(mbox, irq);
}
static inline int is_mbox_irq(struct omap_mbox *mbox, omap_mbox_irq_t irq)
{
	return mbox->ops->is_irq(mbox, irq);
}

74
75
76
/*
 * message sender
 */
77
static int __mbox_poll_for_space(struct omap_mbox *mbox)
78
79
80
81
82
83
84
85
86
87
88
89
90
{
	int ret = 0, i = 1000;

	while (mbox_fifo_full(mbox)) {
		if (mbox->ops->type == OMAP_MBOX_TYPE2)
			return -1;
		if (--i == 0)
			return -1;
		udelay(1);
	}
	return ret;
}

91
int omap_mbox_msg_send(struct omap_mbox *mbox, mbox_msg_t msg)
92
{
93
94
	struct omap_mbox_queue *mq = mbox->txq;
	int ret = 0, len;
95

96
	spin_lock_bh(&mq->lock);
Tejun Heo's avatar
Tejun Heo committed
97

98
99
100
101
102
	if (kfifo_avail(&mq->fifo) < sizeof(msg)) {
		ret = -ENOMEM;
		goto out;
	}

103
104
105
106
107
	if (kfifo_is_empty(&mq->fifo) && !__mbox_poll_for_space(mbox)) {
		mbox_fifo_write(mbox, msg);
		goto out;
	}

108
109
	len = kfifo_in(&mq->fifo, (unsigned char *)&msg, sizeof(msg));
	WARN_ON(len != sizeof(msg));
110

111
	tasklet_schedule(&mbox->txq->tasklet);
112

113
out:
114
	spin_unlock_bh(&mq->lock);
115
	return ret;
116
117
118
}
EXPORT_SYMBOL(omap_mbox_msg_send);

119
static void mbox_tx_tasklet(unsigned long tx_data)
120
{
121
	struct omap_mbox *mbox = (struct omap_mbox *)tx_data;
122
123
124
	struct omap_mbox_queue *mq = mbox->txq;
	mbox_msg_t msg;
	int ret;
125

126
127
	while (kfifo_len(&mq->fifo)) {
		if (__mbox_poll_for_space(mbox)) {
128
			omap_mbox_enable_irq(mbox, IRQ_TX);
129
			break;
130
		}
131
132
133
134
135
136

		ret = kfifo_out(&mq->fifo, (unsigned char *)&msg,
								sizeof(msg));
		WARN_ON(ret != sizeof(msg));

		mbox_fifo_write(mbox, msg);
137
138
139
140
141
142
143
144
145
146
147
	}
}

/*
 * Message receiver(workqueue)
 */
static void mbox_rx_work(struct work_struct *work)
{
	struct omap_mbox_queue *mq =
			container_of(work, struct omap_mbox_queue, work);
	mbox_msg_t msg;
148
149
150
151
152
	int len;

	while (kfifo_len(&mq->fifo) >= sizeof(msg)) {
		len = kfifo_out(&mq->fifo, (unsigned char *)&msg, sizeof(msg));
		WARN_ON(len != sizeof(msg));
153

154
155
		blocking_notifier_call_chain(&mq->mbox->notifier, len,
								(void *)msg);
156
157
158
159
160
161
		spin_lock_irq(&mq->lock);
		if (mq->full) {
			mq->full = false;
			omap_mbox_enable_irq(mq->mbox, IRQ_RX);
		}
		spin_unlock_irq(&mq->lock);
162
163
164
165
166
167
168
169
	}
}

/*
 * Mailbox interrupt handler
 */
static void __mbox_tx_interrupt(struct omap_mbox *mbox)
{
170
	omap_mbox_disable_irq(mbox, IRQ_TX);
171
	ack_mbox_irq(mbox, IRQ_TX);
172
	tasklet_schedule(&mbox->txq->tasklet);
173
174
175
176
}

static void __mbox_rx_interrupt(struct omap_mbox *mbox)
{
177
	struct omap_mbox_queue *mq = mbox->rxq;
178
	mbox_msg_t msg;
179
	int len;
180
181

	while (!mbox_fifo_empty(mbox)) {
182
		if (unlikely(kfifo_avail(&mq->fifo) < sizeof(msg))) {
183
			omap_mbox_disable_irq(mbox, IRQ_RX);
184
			mq->full = true;
185
			goto nomem;
186
		}
187
188
189

		msg = mbox_fifo_read(mbox);

190
191
		len = kfifo_in(&mq->fifo, (unsigned char *)&msg, sizeof(msg));
		WARN_ON(len != sizeof(msg));
192
193
194
195
196
197
198

		if (mbox->ops->type == OMAP_MBOX_TYPE1)
			break;
	}

	/* no more messages in the fifo. clear IRQ source. */
	ack_mbox_irq(mbox, IRQ_RX);
199
nomem:
Tejun Heo's avatar
Tejun Heo committed
200
	schedule_work(&mbox->rxq->work);
201
202
203
204
}

static irqreturn_t mbox_interrupt(int irq, void *p)
{
205
	struct omap_mbox *mbox = p;
206
207
208
209
210
211
212
213
214
215
216

	if (is_mbox_irq(mbox, IRQ_TX))
		__mbox_tx_interrupt(mbox);

	if (is_mbox_irq(mbox, IRQ_RX))
		__mbox_rx_interrupt(mbox);

	return IRQ_HANDLED;
}

static struct omap_mbox_queue *mbox_queue_alloc(struct omap_mbox *mbox,
217
218
					void (*work) (struct work_struct *),
					void (*tasklet)(unsigned long))
219
220
221
222
223
224
225
226
227
{
	struct omap_mbox_queue *mq;

	mq = kzalloc(sizeof(struct omap_mbox_queue), GFP_KERNEL);
	if (!mq)
		return NULL;

	spin_lock_init(&mq->lock);

228
	if (kfifo_alloc(&mq->fifo, mbox_kfifo_size, GFP_KERNEL))
229
230
		goto error;

231
232
	if (work)
		INIT_WORK(&mq->work, work);
233

234
235
	if (tasklet)
		tasklet_init(&mq->tasklet, tasklet, (unsigned long)mbox);
236
237
238
239
240
241
242
243
	return mq;
error:
	kfree(mq);
	return NULL;
}

static void mbox_queue_free(struct omap_mbox_queue *q)
{
244
	kfifo_free(&q->fifo);
245
246
247
	kfree(q);
}

248
static int omap_mbox_startup(struct omap_mbox *mbox)
249
{
250
	int ret = 0;
251
252
	struct omap_mbox_queue *mq;

253
254
255
	mutex_lock(&mbox_configured_lock);
	if (!mbox_configured++) {
		if (likely(mbox->ops->startup)) {
256
			ret = mbox->ops->startup(mbox);
257
258
259
260
			if (unlikely(ret))
				goto fail_startup;
		} else
			goto fail_startup;
261
262
	}

263
264
265
266
267
268
269
270
271
272
273
274
275
276
	if (!mbox->use_count++) {
		ret = request_irq(mbox->irq, mbox_interrupt, IRQF_SHARED,
							mbox->name, mbox);
		if (unlikely(ret)) {
			pr_err("failed to register mailbox interrupt:%d\n",
									ret);
			goto fail_request_irq;
		}
		mq = mbox_queue_alloc(mbox, NULL, mbox_tx_tasklet);
		if (!mq) {
			ret = -ENOMEM;
			goto fail_alloc_txq;
		}
		mbox->txq = mq;
277

278
279
280
281
282
283
284
		mq = mbox_queue_alloc(mbox, mbox_rx_work, NULL);
		if (!mq) {
			ret = -ENOMEM;
			goto fail_alloc_rxq;
		}
		mbox->rxq = mq;
		mq->mbox = mbox;
285
	}
286
	mutex_unlock(&mbox_configured_lock);
287
288
	return 0;

289
fail_alloc_rxq:
290
	mbox_queue_free(mbox->txq);
291
fail_alloc_txq:
292
	free_irq(mbox->irq, mbox);
293
fail_request_irq:
294
	if (mbox->ops->shutdown)
295
		mbox->ops->shutdown(mbox);
296
297
298
299
	mbox->use_count--;
fail_startup:
	mbox_configured--;
	mutex_unlock(&mbox_configured_lock);
300
301
302
303
304
	return ret;
}

static void omap_mbox_fini(struct omap_mbox *mbox)
{
305
306
307
308
309
	mutex_lock(&mbox_configured_lock);

	if (!--mbox->use_count) {
		free_irq(mbox->irq, mbox);
		tasklet_kill(&mbox->txq->tasklet);
Tejun Heo's avatar
Tejun Heo committed
310
	flush_work_sync(&mbox->rxq->work);
311
312
313
		mbox_queue_free(mbox->txq);
		mbox_queue_free(mbox->rxq);
	}
314

315
316
	if (likely(mbox->ops->shutdown)) {
		if (!--mbox_configured)
317
318
			mbox->ops->shutdown(mbox);
	}
319
320

	mutex_unlock(&mbox_configured_lock);
321
322
}

323
struct omap_mbox *omap_mbox_get(const char *name, struct notifier_block *nb)
324
{
325
326
	struct omap_mbox *_mbox, *mbox = NULL;
	int i, ret;
327

328
329
	if (!mboxes)
		return ERR_PTR(-EINVAL);
330

331
332
333
	for (i = 0; (_mbox = mboxes[i]); i++) {
		if (!strcmp(_mbox->name, name)) {
			mbox = _mbox;
334
			break;
335
336
		}
	}
337
338
339

	if (!mbox)
		return ERR_PTR(-ENOENT);
340

341
	ret = omap_mbox_startup(mbox);
342
343
344
	if (ret)
		return ERR_PTR(-ENODEV);

345
346
347
	if (nb)
		blocking_notifier_chain_register(&mbox->notifier, nb);

348
349
350
351
	return mbox;
}
EXPORT_SYMBOL(omap_mbox_get);

352
void omap_mbox_put(struct omap_mbox *mbox, struct notifier_block *nb)
353
{
354
	blocking_notifier_chain_unregister(&mbox->notifier, nb);
355
356
357
358
	omap_mbox_fini(mbox);
}
EXPORT_SYMBOL(omap_mbox_put);

359
360
static struct class omap_mbox_class = { .name = "mbox", };

361
int omap_mbox_register(struct device *parent, struct omap_mbox **list)
362
{
363
364
	int ret;
	int i;
365

366
367
	mboxes = list;
	if (!mboxes)
368
369
		return -EINVAL;

370
371
372
373
374
375
376
377
	for (i = 0; mboxes[i]; i++) {
		struct omap_mbox *mbox = mboxes[i];
		mbox->dev = device_create(&omap_mbox_class,
				parent, 0, mbox, "%s", mbox->name);
		if (IS_ERR(mbox->dev)) {
			ret = PTR_ERR(mbox->dev);
			goto err_out;
		}
378
379

		BLOCKING_INIT_NOTIFIER_HEAD(&mbox->notifier);
380
	}
381
382
	return 0;

383
384
385
err_out:
	while (i--)
		device_unregister(mboxes[i]->dev);
386
387
388
389
	return ret;
}
EXPORT_SYMBOL(omap_mbox_register);

390
int omap_mbox_unregister(void)
391
{
392
	int i;
393

394
395
396
397
398
399
400
	if (!mboxes)
		return -EINVAL;

	for (i = 0; mboxes[i]; i++)
		device_unregister(mboxes[i]->dev);
	mboxes = NULL;
	return 0;
401
402
403
}
EXPORT_SYMBOL(omap_mbox_unregister);

404
static int __init omap_mbox_init(void)
405
{
406
407
408
409
410
411
	int err;

	err = class_register(&omap_mbox_class);
	if (err)
		return err;

412
413
	/* kfifo size sanity check: alignment and minimal size */
	mbox_kfifo_size = ALIGN(mbox_kfifo_size, sizeof(mbox_msg_t));
414
415
	mbox_kfifo_size = max_t(unsigned int, mbox_kfifo_size,
							sizeof(mbox_msg_t));
416

417
	return 0;
418
}
419
subsys_initcall(omap_mbox_init);
420

421
static void __exit omap_mbox_exit(void)
422
{
423
	class_unregister(&omap_mbox_class);
424
}
425
module_exit(omap_mbox_exit);
426

427
428
MODULE_LICENSE("GPL v2");
MODULE_DESCRIPTION("omap mailbox: interrupt driven messaging");
429
430
MODULE_AUTHOR("Toshihiro Kobayashi");
MODULE_AUTHOR("Hiroshi DOYU");