omap: mailbox: Fix the address calculation macros
[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 #define MBOX_REG_SIZE                   0x120
38 #define OMAP4_MBOX_REG_SIZE             0x130
40 #define MBOX_NR_REGS                    (MBOX_REG_SIZE / sizeof(u32))
41 #define OMAP4_MBOX_NR_REGS              (OMAP4_MBOX_REG_SIZE / sizeof(u32))
43 static void __iomem *mbox_base;
45 struct omap_mbox2_fifo {
46         unsigned long msg;
47         unsigned long fifo_stat;
48         unsigned long msg_stat;
49 };
51 struct omap_mbox2_priv {
52         struct omap_mbox2_fifo tx_fifo;
53         struct omap_mbox2_fifo rx_fifo;
54         unsigned long irqenable;
55         unsigned long irqstatus;
56         u32 newmsg_bit;
57         u32 notfull_bit;
58         u32 ctx[OMAP4_MBOX_NR_REGS];
59         unsigned long irqdisable;
60 };
62 static void omap2_mbox_enable_irq(struct omap_mbox *mbox,
63                                   omap_mbox_type_t irq);
65 static inline unsigned int mbox_read_reg(size_t ofs)
66 {
67         return __raw_readl(mbox_base + ofs);
68 }
70 static inline void mbox_write_reg(u32 val, size_t ofs)
71 {
72         __raw_writel(val, mbox_base + ofs);
73 }
75 /* Mailbox H/W preparations */
76 static int omap2_mbox_startup(struct omap_mbox *mbox)
77 {
78         u32 l;
80         pm_runtime_enable(mbox->dev->parent);
81         pm_runtime_get_sync(mbox->dev->parent);
83         l = mbox_read_reg(MAILBOX_REVISION);
84         pr_debug("omap mailbox rev %d.%d\n", (l & 0xf0) >> 4, (l & 0x0f));
86         omap2_mbox_enable_irq(mbox, IRQ_RX);
88         return 0;
89 }
91 static void omap2_mbox_shutdown(struct omap_mbox *mbox)
92 {
93         pm_runtime_put_sync(mbox->dev->parent);
94         pm_runtime_disable(mbox->dev->parent);
95 }
97 /* Mailbox FIFO handle functions */
98 static mbox_msg_t omap2_mbox_fifo_read(struct omap_mbox *mbox)
99 {
100         struct omap_mbox2_fifo *fifo =
101                 &((struct omap_mbox2_priv *)mbox->priv)->rx_fifo;
102         return (mbox_msg_t) mbox_read_reg(fifo->msg);
105 static void omap2_mbox_fifo_write(struct omap_mbox *mbox, mbox_msg_t msg)
107         struct omap_mbox2_fifo *fifo =
108                 &((struct omap_mbox2_priv *)mbox->priv)->tx_fifo;
109         mbox_write_reg(msg, fifo->msg);
112 static int omap2_mbox_fifo_empty(struct omap_mbox *mbox)
114         struct omap_mbox2_fifo *fifo =
115                 &((struct omap_mbox2_priv *)mbox->priv)->rx_fifo;
116         return (mbox_read_reg(fifo->msg_stat) == 0);
119 static int omap2_mbox_fifo_full(struct omap_mbox *mbox)
121         struct omap_mbox2_fifo *fifo =
122                 &((struct omap_mbox2_priv *)mbox->priv)->tx_fifo;
123         return mbox_read_reg(fifo->fifo_stat);
126 /* Mailbox IRQ handle functions */
127 static void omap2_mbox_enable_irq(struct omap_mbox *mbox,
128                 omap_mbox_type_t irq)
130         struct omap_mbox2_priv *p = mbox->priv;
131         u32 l, bit = (irq == IRQ_TX) ? p->notfull_bit : p->newmsg_bit;
133         l = mbox_read_reg(p->irqenable);
134         l |= bit;
135         mbox_write_reg(l, p->irqenable);
138 static void omap2_mbox_disable_irq(struct omap_mbox *mbox,
139                 omap_mbox_type_t irq)
141         struct omap_mbox2_priv *p = mbox->priv;
142         u32 bit = (irq == IRQ_TX) ? p->notfull_bit : p->newmsg_bit;
144         if (!cpu_is_omap44xx())
145                 bit = mbox_read_reg(p->irqdisable) & ~bit;
147         mbox_write_reg(bit, p->irqdisable);
150 static void omap2_mbox_ack_irq(struct omap_mbox *mbox,
151                 omap_mbox_type_t irq)
153         struct omap_mbox2_priv *p = mbox->priv;
154         u32 bit = (irq == IRQ_TX) ? p->notfull_bit : p->newmsg_bit;
156         mbox_write_reg(bit, p->irqstatus);
158         /* Flush posted write for irq status to avoid spurious interrupts */
159         mbox_read_reg(p->irqstatus);
162 static int omap2_mbox_is_irq(struct omap_mbox *mbox,
163                 omap_mbox_type_t irq)
165         struct omap_mbox2_priv *p = mbox->priv;
166         u32 bit = (irq == IRQ_TX) ? p->notfull_bit : p->newmsg_bit;
167         u32 enable = mbox_read_reg(p->irqenable);
168         u32 status = mbox_read_reg(p->irqstatus);
170         return (int)(enable & status & bit);
173 static void omap2_mbox_save_ctx(struct omap_mbox *mbox)
175         int i;
176         struct omap_mbox2_priv *p = mbox->priv;
177         int nr_regs;
178         if (cpu_is_omap44xx())
179                 nr_regs = OMAP4_MBOX_NR_REGS;
180         else
181                 nr_regs = MBOX_NR_REGS;
182         for (i = 0; i < nr_regs; i++) {
183                 p->ctx[i] = mbox_read_reg(i * sizeof(u32));
185                 dev_dbg(mbox->dev, "%s: [%02x] %08x\n", __func__,
186                         i, p->ctx[i]);
187         }
190 static void omap2_mbox_restore_ctx(struct omap_mbox *mbox)
192         int i;
193         struct omap_mbox2_priv *p = mbox->priv;
194         int nr_regs;
195         if (cpu_is_omap44xx())
196                 nr_regs = OMAP4_MBOX_NR_REGS;
197         else
198                 nr_regs = MBOX_NR_REGS;
199         for (i = 0; i < nr_regs; i++) {
200                 mbox_write_reg(p->ctx[i], i * sizeof(u32));
202                 dev_dbg(mbox->dev, "%s: [%02x] %08x\n", __func__,
203                         i, p->ctx[i]);
204         }
207 static struct omap_mbox_ops omap2_mbox_ops = {
208         .type           = OMAP_MBOX_TYPE2,
209         .startup        = omap2_mbox_startup,
210         .shutdown       = omap2_mbox_shutdown,
211         .fifo_read      = omap2_mbox_fifo_read,
212         .fifo_write     = omap2_mbox_fifo_write,
213         .fifo_empty     = omap2_mbox_fifo_empty,
214         .fifo_full      = omap2_mbox_fifo_full,
215         .enable_irq     = omap2_mbox_enable_irq,
216         .disable_irq    = omap2_mbox_disable_irq,
217         .ack_irq        = omap2_mbox_ack_irq,
218         .is_irq         = omap2_mbox_is_irq,
219         .save_ctx       = omap2_mbox_save_ctx,
220         .restore_ctx    = omap2_mbox_restore_ctx,
221 };
223 /*
224  * MAILBOX 0: ARM -> DSP,
225  * MAILBOX 1: ARM <- DSP.
226  * MAILBOX 2: ARM -> IVA,
227  * MAILBOX 3: ARM <- IVA.
228  */
230 /* FIXME: the following structs should be filled automatically by the user id */
232 #if defined(CONFIG_ARCH_OMAP3) || defined(CONFIG_ARCH_OMAP2)
233 /* DSP */
234 static struct omap_mbox2_priv omap2_mbox_dsp_priv = {
235         .tx_fifo = {
236                 .msg            = MAILBOX_MESSAGE(0),
237                 .fifo_stat      = MAILBOX_FIFOSTATUS(0),
238         },
239         .rx_fifo = {
240                 .msg            = MAILBOX_MESSAGE(1),
241                 .msg_stat       = MAILBOX_MSGSTATUS(1),
242         },
243         .irqenable      = MAILBOX_IRQENABLE(0),
244         .irqstatus      = MAILBOX_IRQSTATUS(0),
245         .notfull_bit    = MAILBOX_IRQ_NOTFULL(0),
246         .newmsg_bit     = MAILBOX_IRQ_NEWMSG(1),
247         .irqdisable     = MAILBOX_IRQENABLE(0),
248 };
250 struct omap_mbox mbox_dsp_info = {
251         .name   = "dsp",
252         .ops    = &omap2_mbox_ops,
253         .priv   = &omap2_mbox_dsp_priv,
254 };
255 #endif
257 #if defined(CONFIG_ARCH_OMAP3)
258 struct omap_mbox *omap3_mboxes[] = { &mbox_dsp_info, NULL };
259 #endif
261 #if defined(CONFIG_SOC_OMAP2420)
262 /* IVA */
263 static struct omap_mbox2_priv omap2_mbox_iva_priv = {
264         .tx_fifo = {
265                 .msg            = MAILBOX_MESSAGE(2),
266                 .fifo_stat      = MAILBOX_FIFOSTATUS(2),
267         },
268         .rx_fifo = {
269                 .msg            = MAILBOX_MESSAGE(3),
270                 .msg_stat       = MAILBOX_MSGSTATUS(3),
271         },
272         .irqenable      = MAILBOX_IRQENABLE(3),
273         .irqstatus      = MAILBOX_IRQSTATUS(3),
274         .notfull_bit    = MAILBOX_IRQ_NOTFULL(2),
275         .newmsg_bit     = MAILBOX_IRQ_NEWMSG(3),
276         .irqdisable     = MAILBOX_IRQENABLE(3),
277 };
279 static struct omap_mbox mbox_iva_info = {
280         .name   = "iva",
281         .ops    = &omap2_mbox_ops,
282         .priv   = &omap2_mbox_iva_priv,
283 };
285 struct omap_mbox *omap2_mboxes[] = { &mbox_dsp_info, &mbox_iva_info, NULL };
286 #endif
288 #if defined(CONFIG_ARCH_OMAP4)
289 /* OMAP4 */
290 static struct omap_mbox2_priv omap2_mbox_1_priv = {
291         .tx_fifo = {
292                 .msg            = MAILBOX_MESSAGE(0),
293                 .fifo_stat      = MAILBOX_FIFOSTATUS(0),
294         },
295         .rx_fifo = {
296                 .msg            = MAILBOX_MESSAGE(1),
297                 .msg_stat       = MAILBOX_MSGSTATUS(1),
298         },
299         .irqenable      = OMAP4_MAILBOX_IRQENABLE(0),
300         .irqstatus      = OMAP4_MAILBOX_IRQSTATUS(0),
301         .notfull_bit    = MAILBOX_IRQ_NOTFULL(0),
302         .newmsg_bit     = MAILBOX_IRQ_NEWMSG(1),
303         .irqdisable     = OMAP4_MAILBOX_IRQENABLE_CLR(0),
304 };
306 struct omap_mbox mbox_1_info = {
307         .name   = "mailbox-1",
308         .ops    = &omap2_mbox_ops,
309         .priv   = &omap2_mbox_1_priv,
310 };
312 static struct omap_mbox2_priv omap2_mbox_2_priv = {
313         .tx_fifo = {
314                 .msg            = MAILBOX_MESSAGE(3),
315                 .fifo_stat      = MAILBOX_FIFOSTATUS(3),
316         },
317         .rx_fifo = {
318                 .msg            = MAILBOX_MESSAGE(2),
319                 .msg_stat       = MAILBOX_MSGSTATUS(2),
320         },
321         .irqenable      = OMAP4_MAILBOX_IRQENABLE(0),
322         .irqstatus      = OMAP4_MAILBOX_IRQSTATUS(0),
323         .notfull_bit    = MAILBOX_IRQ_NOTFULL(3),
324         .newmsg_bit     = MAILBOX_IRQ_NEWMSG(2),
325         .irqdisable     = OMAP4_MAILBOX_IRQENABLE_CLR(0),
326 };
328 struct omap_mbox mbox_2_info = {
329         .name   = "mailbox-2",
330         .ops    = &omap2_mbox_ops,
331         .priv   = &omap2_mbox_2_priv,
332 };
334 struct omap_mbox *omap4_mboxes[] = { &mbox_1_info, &mbox_2_info, NULL };
335 #endif
337 static int __devinit omap2_mbox_probe(struct platform_device *pdev)
339         struct resource *mem;
340         int ret;
341         struct omap_mbox **list;
343         if (false)
344                 ;
345 #if defined(CONFIG_ARCH_OMAP3)
346         else if (cpu_is_omap34xx()) {
347                 list = omap3_mboxes;
349                 list[0]->irq = platform_get_irq(pdev, 0);
350         }
351 #endif
352 #if defined(CONFIG_ARCH_OMAP2)
353         else if (cpu_is_omap2430()) {
354                 list = omap2_mboxes;
356                 list[0]->irq = platform_get_irq(pdev, 0);
357         } else if (cpu_is_omap2420()) {
358                 list = omap2_mboxes;
360                 list[0]->irq = platform_get_irq_byname(pdev, "dsp");
361                 list[1]->irq = platform_get_irq_byname(pdev, "iva");
362         }
363 #endif
364 #if defined(CONFIG_ARCH_OMAP4)
365         else if (cpu_is_omap44xx()) {
366                 list = omap4_mboxes;
368                 list[0]->irq = list[1]->irq = platform_get_irq(pdev, 0);
369         }
370 #endif
371         else {
372                 pr_err("%s: platform not supported\n", __func__);
373                 return -ENODEV;
374         }
376         mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
377         mbox_base = ioremap(mem->start, resource_size(mem));
378         if (!mbox_base)
379                 return -ENOMEM;
381         ret = omap_mbox_register(&pdev->dev, list);
382         if (ret) {
383                 iounmap(mbox_base);
384                 return ret;
385         }
387         return 0;
390 static int __devexit omap2_mbox_remove(struct platform_device *pdev)
392         omap_mbox_unregister();
393         iounmap(mbox_base);
394         return 0;
397 static struct platform_driver omap2_mbox_driver = {
398         .probe = omap2_mbox_probe,
399         .remove = __devexit_p(omap2_mbox_remove),
400         .driver = {
401                 .name = "omap-mailbox",
402         },
403 };
405 static int __init omap2_mbox_init(void)
407         return platform_driver_register(&omap2_mbox_driver);
410 static void __exit omap2_mbox_exit(void)
412         platform_driver_unregister(&omap2_mbox_driver);
415 module_init(omap2_mbox_init);
416 module_exit(omap2_mbox_exit);
418 MODULE_LICENSE("GPL v2");
419 MODULE_DESCRIPTION("omap mailbox: omap2/3/4 architecture specific functions");
420 MODULE_AUTHOR("Hiroshi DOYU <Hiroshi.DOYU@nokia.com>");
421 MODULE_AUTHOR("Paul Mundt");
422 MODULE_ALIAS("platform:omap2-mailbox");