OMAP: mailbox: support save/restore context using runtime PM
[rpmsg:rpmsg.git] / arch / arm / mach-omap2 / mailbox.c
1 /*
2  * Mailbox reservation modules for OMAP2/3
3  *
4  * Copyright (C) 2006-2009 Nokia Corporation
5  * Written by: Hiroshi DOYU <Hiroshi.DOYU@nokia.com>
6  *        and  Paul Mundt
7  *
8  * This file is subject to the terms and conditions of the GNU General Public
9  * License.  See the file "COPYING" in the main directory of this archive
10  * for more details.
11  */
12
13 #include <linux/module.h>
14 #include <linux/clk.h>
15 #include <linux/err.h>
16 #include <linux/platform_device.h>
17 #include <linux/io.h>
18 #include <linux/slab.h>
19 #include <linux/delay.h>
20 #include <linux/pm_runtime.h>
21 #include <plat/mailbox.h>
22 #include <mach/irqs.h>
23
24 #define MAILBOX_REVISION                0x000
25 #define MAILBOX_SYSCONFIG               0x10
26 #define MAILBOX_MESSAGE(m)              (0x040 + 0x4 * (m))
27 #define MAILBOX_FIFOSTATUS(m)           (0x080 + 0x4 * (m))
28 #define MAILBOX_MSGSTATUS(m)            (0x0c0 + 0x4 * (m))
29 #define MAILBOX_IRQSTATUS(u)            (0x100 + 0x8 * (u))
30 #define MAILBOX_IRQENABLE(u)            (0x104 + 0x8 * (u))
31
32 /* These are valid for OMAP4 and OMAP5 as well */
33 #define OMAP4_MAILBOX_IRQSTATUS(u)      (0x104 + 0x10 * (u))
34 #define OMAP4_MAILBOX_IRQENABLE(u)      (0x108 + 0x10 * (u))
35 #define OMAP4_MAILBOX_IRQENABLE_CLR(u)  (0x10c + 0x10 * (u))
36
37 #define MAILBOX_IRQ_NEWMSG(m)           (1 << (2 * (m)))
38 #define MAILBOX_IRQ_NOTFULL(m)          (1 << (2 * (m) + 1))
39 #define MAILBOX_SOFTRESET               1
40
41 #define MBOX_NUM_USER                  2
42 #define MBOX_NR_REGS                   2
43
44 /* These are valid for OMAP4 and OMAP5 as well */
45 #define OMAP4_MBOX_NUM_USER            3
46 #define OMAP4_MBOX_NR_REGS             3
47
48 static void __iomem *mbox_base;
49
50 static u32 *mbox_ctx;
51 static int nr_mbox_users;
52 static bool context_saved;
53
54 struct omap_mbox2_fifo {
55         unsigned long msg;
56         unsigned long fifo_stat;
57         unsigned long msg_stat;
58 };
59
60 struct omap_mbox2_priv {
61         struct omap_mbox2_fifo tx_fifo;
62         struct omap_mbox2_fifo rx_fifo;
63         unsigned long irqenable;
64         unsigned long irqstatus;
65         u32 newmsg_bit;
66         u32 notfull_bit;
67         unsigned long irqdisable;
68 };
69
70 static void omap2_mbox_enable_irq(struct omap_mbox *mbox,
71                                   omap_mbox_type_t irq);
72
73 static inline unsigned int mbox_read_reg(size_t ofs)
74 {
75         return __raw_readl(mbox_base + ofs);
76 }
77
78 static inline void mbox_write_reg(u32 val, size_t ofs)
79 {
80         __raw_writel(val, mbox_base + ofs);
81 }
82
83 static void omap2_mbox_save_ctx(struct omap_mbox *mbox)
84 {
85         int i, max_iter = 100;
86
87         if (context_saved)
88                 return;
89
90         /* Save irqs per user */
91         for (i = 0; i < nr_mbox_users; i++) {
92                 if (cpu_is_omap44xx() || cpu_is_omap54xx())
93                         mbox_ctx[i] = mbox_read_reg(OMAP4_MAILBOX_IRQENABLE(i));
94                 else
95                         mbox_ctx[i] = mbox_read_reg(MAILBOX_IRQENABLE(i));
96
97                 dev_dbg(mbox->dev, "%s: [%02x] %08x\n", __func__,
98                                                         i, mbox_ctx[i]);
99         }
100
101         context_saved = true;
102
103         /*
104          * Softreset sequence supposedly fixes user's recovery issues,
105          * given that there might be pending messages (IRQs) that were
106          * not serviced.
107          *
108          * Care must be taken given that this could override any previous
109          * setting (e.g.: hwmod).
110          */
111         mbox_write_reg(MAILBOX_SOFTRESET, MAILBOX_SYSCONFIG);
112         while (mbox_read_reg(MAILBOX_SYSCONFIG) & MAILBOX_SOFTRESET) {
113                 if (WARN_ON(!max_iter--))
114                         break;
115                 udelay(1);
116         }
117 }
118
119 static void omap2_mbox_restore_ctx(struct omap_mbox *mbox)
120 {
121         int i;
122
123         if (!context_saved)
124                 return;
125
126         /* Restore irqs per user */
127         for (i = 0; i < nr_mbox_users; i++) {
128                 if (cpu_is_omap44xx() || cpu_is_omap54xx())
129                         mbox_write_reg(mbox_ctx[i], OMAP4_MAILBOX_IRQENABLE(i));
130                 else
131                         mbox_write_reg(mbox_ctx[i], MAILBOX_IRQENABLE(i));
132
133                 dev_dbg(mbox->dev, "%s: [%02x] %08x\n", __func__,
134                                                         i, mbox_ctx[i]);
135         }
136
137         context_saved = false;
138 }
139
140 /* Mailbox H/W preparations */
141 static int omap2_mbox_startup(struct omap_mbox *mbox)
142 {
143         u32 l;
144
145         pm_runtime_enable(mbox->dev->parent);
146         pm_runtime_get_sync(mbox->dev->parent);
147
148         l = mbox_read_reg(MAILBOX_REVISION);
149         pr_debug("omap mailbox rev %d.%d\n", (l & 0xf0) >> 4, (l & 0x0f));
150
151         omap2_mbox_enable_irq(mbox, IRQ_RX);
152
153         return 0;
154 }
155
156 static void omap2_mbox_shutdown(struct omap_mbox *mbox)
157 {
158         pm_runtime_put_sync(mbox->dev->parent);
159         pm_runtime_disable(mbox->dev->parent);
160 }
161
162 /* Mailbox FIFO handle functions */
163 static mbox_msg_t omap2_mbox_fifo_read(struct omap_mbox *mbox)
164 {
165         struct omap_mbox2_fifo *fifo =
166                 &((struct omap_mbox2_priv *)mbox->priv)->rx_fifo;
167         return (mbox_msg_t) mbox_read_reg(fifo->msg);
168 }
169
170 static void omap2_mbox_fifo_write(struct omap_mbox *mbox, mbox_msg_t msg)
171 {
172         struct omap_mbox2_fifo *fifo =
173                 &((struct omap_mbox2_priv *)mbox->priv)->tx_fifo;
174         mbox_write_reg(msg, fifo->msg);
175 }
176
177 static int omap2_mbox_fifo_empty(struct omap_mbox *mbox)
178 {
179         struct omap_mbox2_fifo *fifo =
180                 &((struct omap_mbox2_priv *)mbox->priv)->rx_fifo;
181         return (mbox_read_reg(fifo->msg_stat) == 0);
182 }
183
184 static int omap2_mbox_fifo_full(struct omap_mbox *mbox)
185 {
186         struct omap_mbox2_fifo *fifo =
187                 &((struct omap_mbox2_priv *)mbox->priv)->tx_fifo;
188         return mbox_read_reg(fifo->fifo_stat);
189 }
190
191 /* Mailbox IRQ handle functions */
192 static void omap2_mbox_enable_irq(struct omap_mbox *mbox,
193                 omap_mbox_type_t irq)
194 {
195         struct omap_mbox2_priv *p = mbox->priv;
196         u32 l, bit = (irq == IRQ_TX) ? p->notfull_bit : p->newmsg_bit;
197
198         l = mbox_read_reg(p->irqenable);
199         l |= bit;
200         mbox_write_reg(l, p->irqenable);
201 }
202
203 static void omap2_mbox_disable_irq(struct omap_mbox *mbox,
204                 omap_mbox_type_t irq)
205 {
206         struct omap_mbox2_priv *p = mbox->priv;
207         u32 bit = (irq == IRQ_TX) ? p->notfull_bit : p->newmsg_bit;
208
209         if (!(cpu_is_omap44xx() || cpu_is_omap54xx()))
210                 bit = mbox_read_reg(p->irqdisable) & ~bit;
211
212         mbox_write_reg(bit, p->irqdisable);
213 }
214
215 static void omap2_mbox_ack_irq(struct omap_mbox *mbox,
216                 omap_mbox_type_t irq)
217 {
218         struct omap_mbox2_priv *p = mbox->priv;
219         u32 bit = (irq == IRQ_TX) ? p->notfull_bit : p->newmsg_bit;
220
221         mbox_write_reg(bit, p->irqstatus);
222
223         /* Flush posted write for irq status to avoid spurious interrupts */
224         mbox_read_reg(p->irqstatus);
225 }
226
227 static int omap2_mbox_is_irq(struct omap_mbox *mbox,
228                 omap_mbox_type_t irq)
229 {
230         struct omap_mbox2_priv *p = mbox->priv;
231         u32 bit = (irq == IRQ_TX) ? p->notfull_bit : p->newmsg_bit;
232         u32 enable = mbox_read_reg(p->irqenable);
233         u32 status = mbox_read_reg(p->irqstatus);
234
235         return (int)(enable & status & bit);
236 }
237
238 static struct omap_mbox_ops omap2_mbox_ops = {
239         .type           = OMAP_MBOX_TYPE2,
240         .startup        = omap2_mbox_startup,
241         .shutdown       = omap2_mbox_shutdown,
242         .fifo_read      = omap2_mbox_fifo_read,
243         .fifo_write     = omap2_mbox_fifo_write,
244         .fifo_empty     = omap2_mbox_fifo_empty,
245         .fifo_full      = omap2_mbox_fifo_full,
246         .enable_irq     = omap2_mbox_enable_irq,
247         .disable_irq    = omap2_mbox_disable_irq,
248         .ack_irq        = omap2_mbox_ack_irq,
249         .is_irq         = omap2_mbox_is_irq,
250         .save_ctx       = omap2_mbox_save_ctx,
251         .restore_ctx    = omap2_mbox_restore_ctx,
252 };
253
254 /*
255  * MAILBOX 0: ARM -> DSP,
256  * MAILBOX 1: ARM <- DSP.
257  * MAILBOX 2: ARM -> IVA,
258  * MAILBOX 3: ARM <- IVA.
259  */
260
261 /* FIXME: the following structs should be filled automatically by the user id */
262
263 #if defined(CONFIG_ARCH_OMAP3) || defined(CONFIG_ARCH_OMAP2)
264 /* DSP */
265 static struct omap_mbox2_priv omap2_mbox_dsp_priv = {
266         .tx_fifo = {
267                 .msg            = MAILBOX_MESSAGE(0),
268                 .fifo_stat      = MAILBOX_FIFOSTATUS(0),
269         },
270         .rx_fifo = {
271                 .msg            = MAILBOX_MESSAGE(1),
272                 .msg_stat       = MAILBOX_MSGSTATUS(1),
273         },
274         .irqenable      = MAILBOX_IRQENABLE(0),
275         .irqstatus      = MAILBOX_IRQSTATUS(0),
276         .notfull_bit    = MAILBOX_IRQ_NOTFULL(0),
277         .newmsg_bit     = MAILBOX_IRQ_NEWMSG(1),
278         .irqdisable     = MAILBOX_IRQENABLE(0),
279 };
280
281 struct omap_mbox mbox_dsp_info = {
282         .name   = "dsp",
283         .ops    = &omap2_mbox_ops,
284         .priv   = &omap2_mbox_dsp_priv,
285 };
286 #endif
287
288 #if defined(CONFIG_ARCH_OMAP3)
289 struct omap_mbox *omap3_mboxes[] = { &mbox_dsp_info, NULL };
290 #endif
291
292 #if defined(CONFIG_SOC_OMAP2420)
293 /* IVA */
294 static struct omap_mbox2_priv omap2_mbox_iva_priv = {
295         .tx_fifo = {
296                 .msg            = MAILBOX_MESSAGE(2),
297                 .fifo_stat      = MAILBOX_FIFOSTATUS(2),
298         },
299         .rx_fifo = {
300                 .msg            = MAILBOX_MESSAGE(3),
301                 .msg_stat       = MAILBOX_MSGSTATUS(3),
302         },
303         .irqenable      = MAILBOX_IRQENABLE(3),
304         .irqstatus      = MAILBOX_IRQSTATUS(3),
305         .notfull_bit    = MAILBOX_IRQ_NOTFULL(2),
306         .newmsg_bit     = MAILBOX_IRQ_NEWMSG(3),
307         .irqdisable     = MAILBOX_IRQENABLE(3),
308 };
309
310 static struct omap_mbox mbox_iva_info = {
311         .name   = "iva",
312         .ops    = &omap2_mbox_ops,
313         .priv   = &omap2_mbox_iva_priv,
314 };
315 #endif
316
317 #ifdef CONFIG_ARCH_OMAP2
318 struct omap_mbox *omap2_mboxes[] = {
319         &mbox_dsp_info,
320 #ifdef CONFIG_SOC_OMAP2420
321         &mbox_iva_info,
322 #endif
323         NULL
324 };
325 #endif
326
327 #if defined(CONFIG_ARCH_OMAP4) || defined(CONFIG_ARCH_OMAP5)
328 /* OMAP4 */
329 static struct omap_mbox2_priv omap2_mbox_1_priv = {
330         .tx_fifo = {
331                 .msg            = MAILBOX_MESSAGE(0),
332                 .fifo_stat      = MAILBOX_FIFOSTATUS(0),
333         },
334         .rx_fifo = {
335                 .msg            = MAILBOX_MESSAGE(1),
336                 .msg_stat       = MAILBOX_MSGSTATUS(1),
337         },
338         .irqenable      = OMAP4_MAILBOX_IRQENABLE(0),
339         .irqstatus      = OMAP4_MAILBOX_IRQSTATUS(0),
340         .notfull_bit    = MAILBOX_IRQ_NOTFULL(0),
341         .newmsg_bit     = MAILBOX_IRQ_NEWMSG(1),
342         .irqdisable     = OMAP4_MAILBOX_IRQENABLE_CLR(0),
343 };
344
345 struct omap_mbox mbox_1_info = {
346         .name   = "mailbox-1",
347         .ops    = &omap2_mbox_ops,
348         .priv   = &omap2_mbox_1_priv,
349 };
350
351 static struct omap_mbox2_priv omap2_mbox_2_priv = {
352         .tx_fifo = {
353                 .msg            = MAILBOX_MESSAGE(3),
354                 .fifo_stat      = MAILBOX_FIFOSTATUS(3),
355         },
356         .rx_fifo = {
357                 .msg            = MAILBOX_MESSAGE(2),
358                 .msg_stat       = MAILBOX_MSGSTATUS(2),
359         },
360         .irqenable      = OMAP4_MAILBOX_IRQENABLE(0),
361         .irqstatus      = OMAP4_MAILBOX_IRQSTATUS(0),
362         .notfull_bit    = MAILBOX_IRQ_NOTFULL(3),
363         .newmsg_bit     = MAILBOX_IRQ_NEWMSG(2),
364         .irqdisable     = OMAP4_MAILBOX_IRQENABLE_CLR(0),
365 };
366
367 struct omap_mbox mbox_2_info = {
368         .name   = "mailbox-2",
369         .ops    = &omap2_mbox_ops,
370         .priv   = &omap2_mbox_2_priv,
371 };
372
373 struct omap_mbox *omap4_mboxes[] = { &mbox_1_info, &mbox_2_info, NULL };
374 #endif
375
376 static int __devinit omap2_mbox_probe(struct platform_device *pdev)
377 {
378         struct resource *mem;
379         int ret;
380         struct omap_mbox **list;
381
382         if (false)
383                 ;
384 #if defined(CONFIG_ARCH_OMAP3)
385         else if (cpu_is_omap34xx()) {
386                 list = omap3_mboxes;
387
388                 list[0]->irq = platform_get_irq(pdev, 0);
389         }
390 #endif
391 #if defined(CONFIG_ARCH_OMAP2)
392         else if (cpu_is_omap2430()) {
393                 list = omap2_mboxes;
394
395                 list[0]->irq = platform_get_irq(pdev, 0);
396         } else if (cpu_is_omap2420()) {
397                 list = omap2_mboxes;
398
399                 list[0]->irq = platform_get_irq_byname(pdev, "dsp");
400                 list[1]->irq = platform_get_irq_byname(pdev, "iva");
401         }
402 #endif
403 #if defined(CONFIG_ARCH_OMAP4) || defined(CONFIG_ARCH_OMAP5)
404         else if (cpu_is_omap44xx() || cpu_is_omap54xx()) {
405                 list = omap4_mboxes;
406
407                 list[0]->irq = list[1]->irq = platform_get_irq(pdev, 0);
408         }
409 #endif
410         else {
411                 pr_err("%s: platform not supported\n", __func__);
412                 return -ENODEV;
413         }
414
415         mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
416         if (!mem)
417                 return -ENODEV;
418
419         mbox_base = ioremap(mem->start, resource_size(mem));
420         if (!mbox_base)
421                 return -ENOMEM;
422
423         nr_mbox_users = (cpu_is_omap44xx() || cpu_is_omap54xx()) ?
424                                         OMAP4_MBOX_NUM_USER : MBOX_NUM_USER;
425         mbox_ctx = kzalloc(sizeof(u32) * nr_mbox_users, GFP_KERNEL);
426         if (!mbox_ctx) {
427                 ret = -ENOMEM;
428                 goto unmap_base;
429         }
430
431         ret = omap_mbox_register(&pdev->dev, list);
432         if (ret)
433                 goto free_ctx;
434
435         return 0;
436
437 free_ctx:
438         kfree(mbox_ctx);
439 unmap_base:
440         iounmap(mbox_base);
441         return ret;
442 }
443
444 static int __devexit omap2_mbox_remove(struct platform_device *pdev)
445 {
446         omap_mbox_unregister();
447         iounmap(mbox_base);
448         return 0;
449 }
450
451 static struct platform_driver omap2_mbox_driver = {
452         .probe = omap2_mbox_probe,
453         .remove = __devexit_p(omap2_mbox_remove),
454         .driver = {
455                 .name = "omap-mailbox",
456                 .pm = &mbox_pm_ops,
457         },
458 };
459
460 static int __init omap2_mbox_init(void)
461 {
462         return platform_driver_register(&omap2_mbox_driver);
463 }
464
465 static void __exit omap2_mbox_exit(void)
466 {
467         platform_driver_unregister(&omap2_mbox_driver);
468 }
469
470 module_init(omap2_mbox_init);
471 module_exit(omap2_mbox_exit);
472
473 MODULE_LICENSE("GPL v2");
474 MODULE_DESCRIPTION("omap mailbox: omap2/3/4 architecture specific functions");
475 MODULE_AUTHOR("Hiroshi DOYU <Hiroshi.DOYU@nokia.com>");
476 MODULE_AUTHOR("Paul Mundt");
477 MODULE_ALIAS("platform:omap2-mailbox");