omap: mailbox: Add support for AM33XX SoC
[sitara-epos/sitara-epos-kernel.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  */
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/pm_runtime.h>
19 #include <plat/mailbox.h>
20 #include <mach/irqs.h>
22 #define MAILBOX_REVISION                0x000
23 #define MAILBOX_MESSAGE(m)              (0x040 + 0x4 * (m))
24 #define MAILBOX_FIFOSTATUS(m)           (0x080 + 0x4 * (m))
25 #define MAILBOX_MSGSTATUS(m)            (0x0c0 + 0x4 * (m))
26 #define MAILBOX_IRQSTATUS(u)            (0x100 + 0x8 * (u))
27 #define MAILBOX_IRQENABLE(u)            (0x104 + 0x8 * (u))
29 #define OMAP4_MAILBOX_IRQSTATUS(u)      (0x104 + 0x10 * (u))
30 #define OMAP4_MAILBOX_IRQENABLE(u)      (0x108 + 0x10 * (u))
31 #define OMAP4_MAILBOX_IRQENABLE_CLR(u)  (0x10c + 0x10 * (u))
33 #define MAILBOX_IRQ_NEWMSG(m)           (1 << (2 * (m)))
34 #define MAILBOX_IRQ_NOTFULL(m)          (1 << (2 * (m) + 1))
36 /* TODO: This can and should be based on #users and #sub-modules */
37 #define MBOX_REG_SIZE                   0x120
39 #define OMAP4_MBOX_REG_SIZE             0x130
41 #define AM33XX_MBOX_REG_SIZE            0x140
43 #define MBOX_NR_REGS                    (MBOX_REG_SIZE / sizeof(u32))
44 #define OMAP4_MBOX_NR_REGS              (OMAP4_MBOX_REG_SIZE / sizeof(u32))
45 #define AM33XX_MBOX_NR_REGS             (AM33XX_MBOX_REG_SIZE / sizeof(u32))
47 static void __iomem *mbox_base;
49 struct omap_mbox2_fifo {
50         unsigned long msg;
51         unsigned long fifo_stat;
52         unsigned long msg_stat;
53 };
55 struct omap_mbox2_priv {
56         struct omap_mbox2_fifo tx_fifo;
57         struct omap_mbox2_fifo rx_fifo;
58         unsigned long irqenable;
59         unsigned long irqstatus;
60         u32 newmsg_bit;
61         u32 notfull_bit;
62         u32 ctx[OMAP4_MBOX_NR_REGS];
63         unsigned long irqdisable;
64 };
66 static void omap2_mbox_enable_irq(struct omap_mbox *mbox,
67                                   omap_mbox_type_t irq);
69 static inline unsigned int mbox_read_reg(size_t ofs)
70 {
71         return __raw_readl(mbox_base + ofs);
72 }
74 static inline void mbox_write_reg(u32 val, size_t ofs)
75 {
76         __raw_writel(val, mbox_base + ofs);
77 }
79 /* Mailbox H/W preparations */
80 static int omap2_mbox_startup(struct omap_mbox *mbox)
81 {
82         u32 l;
84         pm_runtime_enable(mbox->dev->parent);
85         pm_runtime_get_sync(mbox->dev->parent);
87         l = mbox_read_reg(MAILBOX_REVISION);
88         pr_debug("omap mailbox rev %d.%d\n", (l & 0xf0) >> 4, (l & 0x0f));
90         omap2_mbox_enable_irq(mbox, IRQ_RX);
92         return 0;
93 }
95 static void omap2_mbox_shutdown(struct omap_mbox *mbox)
96 {
97         pm_runtime_put_sync(mbox->dev->parent);
98         pm_runtime_disable(mbox->dev->parent);
99 }
101 /* Mailbox FIFO handle functions */
102 static mbox_msg_t omap2_mbox_fifo_read(struct omap_mbox *mbox)
104         struct omap_mbox2_fifo *fifo =
105                 &((struct omap_mbox2_priv *)mbox->priv)->rx_fifo;
106         return (mbox_msg_t) mbox_read_reg(fifo->msg);
109 static void omap2_mbox_fifo_write(struct omap_mbox *mbox, mbox_msg_t msg)
111         struct omap_mbox2_fifo *fifo =
112                 &((struct omap_mbox2_priv *)mbox->priv)->tx_fifo;
113         mbox_write_reg(msg, fifo->msg);
116 static int omap2_mbox_fifo_empty(struct omap_mbox *mbox)
118         struct omap_mbox2_fifo *fifo =
119                 &((struct omap_mbox2_priv *)mbox->priv)->rx_fifo;
120         return (mbox_read_reg(fifo->msg_stat) == 0);
123 static int omap2_mbox_fifo_full(struct omap_mbox *mbox)
125         struct omap_mbox2_fifo *fifo =
126                 &((struct omap_mbox2_priv *)mbox->priv)->tx_fifo;
127         return mbox_read_reg(fifo->fifo_stat);
130 /* Mailbox IRQ handle functions */
131 static void omap2_mbox_enable_irq(struct omap_mbox *mbox,
132                 omap_mbox_type_t irq)
134         struct omap_mbox2_priv *p = mbox->priv;
135         u32 l, bit = (irq == IRQ_TX) ? p->notfull_bit : p->newmsg_bit;
137         l = mbox_read_reg(p->irqenable);
138         l |= bit;
139         mbox_write_reg(l, p->irqenable);
142 static void omap2_mbox_disable_irq(struct omap_mbox *mbox,
143                 omap_mbox_type_t irq)
145         struct omap_mbox2_priv *p = mbox->priv;
146         u32 bit = (irq == IRQ_TX) ? p->notfull_bit : p->newmsg_bit;
148         if (!cpu_is_omap44xx() && !cpu_is_am33xx())
149                 bit = mbox_read_reg(p->irqdisable) & ~bit;
151         mbox_write_reg(bit, p->irqdisable);
154 static void omap2_mbox_ack_irq(struct omap_mbox *mbox,
155                 omap_mbox_type_t irq)
157         struct omap_mbox2_priv *p = mbox->priv;
158         u32 bit = (irq == IRQ_TX) ? p->notfull_bit : p->newmsg_bit;
160         mbox_write_reg(bit, p->irqstatus);
162         /* Flush posted write for irq status to avoid spurious interrupts */
163         mbox_read_reg(p->irqstatus);
166 static int omap2_mbox_is_irq(struct omap_mbox *mbox,
167                 omap_mbox_type_t irq)
169         struct omap_mbox2_priv *p = mbox->priv;
170         u32 bit = (irq == IRQ_TX) ? p->notfull_bit : p->newmsg_bit;
171         u32 enable = mbox_read_reg(p->irqenable);
172         u32 status = mbox_read_reg(p->irqstatus);
174         return (int)(enable & status & bit);
177 static void omap2_mbox_save_ctx(struct omap_mbox *mbox)
179         int i;
180         struct omap_mbox2_priv *p = mbox->priv;
181         int nr_regs;
182         if (cpu_is_omap44xx())
183                 nr_regs = OMAP4_MBOX_NR_REGS;
184         else
185                 nr_regs = MBOX_NR_REGS;
186         for (i = 0; i < nr_regs; i++) {
187                 p->ctx[i] = mbox_read_reg(i * sizeof(u32));
189                 dev_dbg(mbox->dev, "%s: [%02x] %08x\n", __func__,
190                         i, p->ctx[i]);
191         }
194 static void omap2_mbox_restore_ctx(struct omap_mbox *mbox)
196         int i;
197         struct omap_mbox2_priv *p = mbox->priv;
198         int nr_regs;
199         if (cpu_is_omap44xx())
200                 nr_regs = OMAP4_MBOX_NR_REGS;
201         else
202                 nr_regs = MBOX_NR_REGS;
203         for (i = 0; i < nr_regs; i++) {
204                 mbox_write_reg(p->ctx[i], i * sizeof(u32));
206                 dev_dbg(mbox->dev, "%s: [%02x] %08x\n", __func__,
207                         i, p->ctx[i]);
208         }
211 static struct omap_mbox_ops omap2_mbox_ops = {
212         .type           = OMAP_MBOX_TYPE2,
213         .startup        = omap2_mbox_startup,
214         .shutdown       = omap2_mbox_shutdown,
215         .fifo_read      = omap2_mbox_fifo_read,
216         .fifo_write     = omap2_mbox_fifo_write,
217         .fifo_empty     = omap2_mbox_fifo_empty,
218         .fifo_full      = omap2_mbox_fifo_full,
219         .enable_irq     = omap2_mbox_enable_irq,
220         .disable_irq    = omap2_mbox_disable_irq,
221         .ack_irq        = omap2_mbox_ack_irq,
222         .is_irq         = omap2_mbox_is_irq,
223         .save_ctx       = omap2_mbox_save_ctx,
224         .restore_ctx    = omap2_mbox_restore_ctx,
225 };
227 /*
228  * MAILBOX 0: ARM -> DSP,
229  * MAILBOX 1: ARM <- DSP.
230  * MAILBOX 2: ARM -> IVA,
231  * MAILBOX 3: ARM <- IVA.
232  */
234 /* FIXME: the following structs should be filled automatically by the user id */
236 /* DSP */
237 static struct omap_mbox2_priv omap2_mbox_dsp_priv = {
238         .tx_fifo = {
239                 .msg            = MAILBOX_MESSAGE(0),
240                 .fifo_stat      = MAILBOX_FIFOSTATUS(0),
241         },
242         .rx_fifo = {
243                 .msg            = MAILBOX_MESSAGE(1),
244                 .msg_stat       = MAILBOX_MSGSTATUS(1),
245         },
246         .irqenable      = MAILBOX_IRQENABLE(0),
247         .irqstatus      = MAILBOX_IRQSTATUS(0),
248         .notfull_bit    = MAILBOX_IRQ_NOTFULL(0),
249         .newmsg_bit     = MAILBOX_IRQ_NEWMSG(1),
250         .irqdisable     = MAILBOX_IRQENABLE(0),
251 };
253 struct omap_mbox mbox_dsp_info = {
254         .name   = "dsp",
255         .ops    = &omap2_mbox_ops,
256         .priv   = &omap2_mbox_dsp_priv,
257 };
259 struct omap_mbox *omap3_mboxes[] = { &mbox_dsp_info, NULL };
261 /* IVA */
262 static struct omap_mbox2_priv omap2_mbox_iva_priv = {
263         .tx_fifo = {
264                 .msg            = MAILBOX_MESSAGE(2),
265                 .fifo_stat      = MAILBOX_FIFOSTATUS(2),
266         },
267         .rx_fifo = {
268                 .msg            = MAILBOX_MESSAGE(3),
269                 .msg_stat       = MAILBOX_MSGSTATUS(3),
270         },
271         .irqenable      = MAILBOX_IRQENABLE(3),
272         .irqstatus      = MAILBOX_IRQSTATUS(3),
273         .notfull_bit    = MAILBOX_IRQ_NOTFULL(2),
274         .newmsg_bit     = MAILBOX_IRQ_NEWMSG(3),
275         .irqdisable     = MAILBOX_IRQENABLE(3),
276 };
278 static struct omap_mbox mbox_iva_info = {
279         .name   = "iva",
280         .ops    = &omap2_mbox_ops,
281         .priv   = &omap2_mbox_iva_priv,
282 };
284 struct omap_mbox *omap2_mboxes[] = { &mbox_dsp_info, &mbox_iva_info, NULL };
286 /* A8 -> Wakeup-M3 */
287 static struct omap_mbox2_priv omap2_mbox_m3_priv = {
288         .tx_fifo = {
289                 .msg            = MAILBOX_MESSAGE(0),
290                 .fifo_stat      = MAILBOX_FIFOSTATUS(0),
291                 .msg_stat       = MAILBOX_MSGSTATUS(0),
292         },
293         /* TODO: No M3->A8 so this needs to be removed */
294         .rx_fifo = {
295                 .msg            = MAILBOX_MESSAGE(1),
296                 .msg_stat       = MAILBOX_MSGSTATUS(1),
297         },
298         .irqenable      = OMAP4_MAILBOX_IRQENABLE(3),
299         .irqstatus      = OMAP4_MAILBOX_IRQSTATUS(3),
300         .notfull_bit    = MAILBOX_IRQ_NOTFULL(0),
301         .newmsg_bit     = MAILBOX_IRQ_NEWMSG(0),
302         .irqdisable     = OMAP4_MAILBOX_IRQENABLE_CLR(3),
303 };
305 struct omap_mbox wkup_m3_info = {
306         .name   = "wkup_m3",
307         .ops    = &omap2_mbox_ops,
308         .priv   = &omap2_mbox_m3_priv,
309 };
311 struct omap_mbox *am33xx_mboxes[] = { &wkup_m3_info, NULL };
313 /* OMAP4 */
314 static struct omap_mbox2_priv omap2_mbox_1_priv = {
315         .tx_fifo = {
316                 .msg            = MAILBOX_MESSAGE(0),
317                 .fifo_stat      = MAILBOX_FIFOSTATUS(0),
318         },
319         .rx_fifo = {
320                 .msg            = MAILBOX_MESSAGE(1),
321                 .msg_stat       = MAILBOX_MSGSTATUS(1),
322         },
323         .irqenable      = OMAP4_MAILBOX_IRQENABLE(0),
324         .irqstatus      = OMAP4_MAILBOX_IRQSTATUS(0),
325         .notfull_bit    = MAILBOX_IRQ_NOTFULL(0),
326         .newmsg_bit     = MAILBOX_IRQ_NEWMSG(1),
327         .irqdisable     = OMAP4_MAILBOX_IRQENABLE_CLR(0),
328 };
330 struct omap_mbox mbox_1_info = {
331         .name   = "mailbox-1",
332         .ops    = &omap2_mbox_ops,
333         .priv   = &omap2_mbox_1_priv,
334 };
336 static struct omap_mbox2_priv omap2_mbox_2_priv = {
337         .tx_fifo = {
338                 .msg            = MAILBOX_MESSAGE(3),
339                 .fifo_stat      = MAILBOX_FIFOSTATUS(3),
340         },
341         .rx_fifo = {
342                 .msg            = MAILBOX_MESSAGE(2),
343                 .msg_stat       = MAILBOX_MSGSTATUS(2),
344         },
345         .irqenable      = OMAP4_MAILBOX_IRQENABLE(0),
346         .irqstatus      = OMAP4_MAILBOX_IRQSTATUS(0),
347         .notfull_bit    = MAILBOX_IRQ_NOTFULL(3),
348         .newmsg_bit     = MAILBOX_IRQ_NEWMSG(2),
349         .irqdisable     = OMAP4_MAILBOX_IRQENABLE_CLR(0),
350 };
352 struct omap_mbox mbox_2_info = {
353         .name   = "mailbox-2",
354         .ops    = &omap2_mbox_ops,
355         .priv   = &omap2_mbox_2_priv,
356 };
358 struct omap_mbox *omap4_mboxes[] = { &mbox_1_info, &mbox_2_info, NULL };
360 static int __devinit omap2_mbox_probe(struct platform_device *pdev)
362         struct resource *mem;
363         int ret;
364         struct omap_mbox **list;
366         if (false)
367                 ;
368         else if (cpu_is_omap34xx() && !cpu_is_am33xx()) {
369                 list = omap3_mboxes;
371                 list[0]->irq = platform_get_irq(pdev, 0);
372         } else if (cpu_is_am33xx()) {
373                 list = am33xx_mboxes;
375                 list[0]->irq = platform_get_irq(pdev, 0);
376         }
377         else if (cpu_is_omap2430()) {
378                 list = omap2_mboxes;
380                 list[0]->irq = platform_get_irq(pdev, 0);
381         } else if (cpu_is_omap2420()) {
382                 list = omap2_mboxes;
384                 list[0]->irq = platform_get_irq_byname(pdev, "dsp");
385                 list[1]->irq = platform_get_irq_byname(pdev, "iva");
386         }
387         else if (cpu_is_omap44xx()) {
388                 list = omap4_mboxes;
390                 list[0]->irq = list[1]->irq = platform_get_irq(pdev, 0);
391         }
392         else {
393                 pr_err("%s: platform not supported\n", __func__);
394                 return -ENODEV;
395         }
397         mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
398         mbox_base = ioremap(mem->start, resource_size(mem));
399         if (!mbox_base)
400                 return -ENOMEM;
402         ret = omap_mbox_register(&pdev->dev, list);
403         if (ret) {
404                 iounmap(mbox_base);
405                 return ret;
406         }
408         return 0;
411 static int __devexit omap2_mbox_remove(struct platform_device *pdev)
413         omap_mbox_unregister();
414         iounmap(mbox_base);
415         return 0;
418 static struct platform_driver omap2_mbox_driver = {
419         .probe = omap2_mbox_probe,
420         .remove = __devexit_p(omap2_mbox_remove),
421         .driver = {
422                 .name = "omap-mailbox",
423         },
424 };
426 static int __init omap2_mbox_init(void)
428         return platform_driver_register(&omap2_mbox_driver);
431 static void __exit omap2_mbox_exit(void)
433         platform_driver_unregister(&omap2_mbox_driver);
436 module_init(omap2_mbox_init);
437 module_exit(omap2_mbox_exit);
439 MODULE_LICENSE("GPL v2");
440 MODULE_DESCRIPTION("omap mailbox: omap2/3/4 architecture specific functions");
441 MODULE_AUTHOR("Hiroshi DOYU <Hiroshi.DOYU@nokia.com>");
442 MODULE_AUTHOR("Paul Mundt");
443 MODULE_ALIAS("platform:omap2-mailbox");