arch/arm/mach-omap2/mailbox.c

   1 /*
   2  * Mailbox reservation modules for OMAP2/3
   3  *
   4  * Copyright (C) 2006-2008 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/kernel.h>
  14 #include <linux/clk.h>
  15 #include <linux/err.h>
  16 #include <linux/platform_device.h>
  17 #include <mach/mailbox.h>
  18 #include <mach/irqs.h>
  19 #include <asm/io.h>
  20
  21 #define MAILBOX_REVISION                0x000
  22 #define MAILBOX_SYSCONFIG               0x010
  23 #define MAILBOX_SYSSTATUS               0x014
  24 #define MAILBOX_MESSAGE(m)              (0x040 + 4 * (m))
  25 #define MAILBOX_FIFOSTATUS(m)           (0x080 + 4 * (m))
  26 #define MAILBOX_MSGSTATUS(m)            (0x0c0 + 4 * (m))
  27 #define MAILBOX_IRQSTATUS(u)            (0x100 + 8 * (u))
  28 #define MAILBOX_IRQENABLE(u)            (0x108 + 8 * (u))
  29
  30 #define MAILBOX_IRQ_NEWMSG(u)           (1 << (2 * (u)))
  31 #define MAILBOX_IRQ_NOTFULL(u)          (1 << (2 * (u) + 1))
  32
  33 static void __iomem *mbox_base;
  34
  35 struct omap_mbox2_fifo {
  36         unsigned long msg;
  37         unsigned long fifo_stat;
  38         unsigned long msg_stat;
  39 };
  40
  41 struct omap_mbox2_priv {
  42         struct omap_mbox2_fifo tx_fifo;
  43         struct omap_mbox2_fifo rx_fifo;
  44         unsigned long irqenable;
  45         unsigned long irqstatus;
  46         u32 newmsg_bit;
  47         u32 notfull_bit;
  48 };
  49
  50 static struct clk *mbox_ick_handle;
  51
  52 static void omap2_mbox_enable_irq(struct omap_mbox *mbox,
  53                                   omap_mbox_type_t irq);
  54
  55 static inline unsigned int mbox_read_reg(size_t ofs)
  56 {
  57         return __raw_readl(mbox_base + ofs);
  58 }
  59
  60 static inline void mbox_write_reg(u32 val, size_t ofs)
  61 {
  62         __raw_writel(val, mbox_base + ofs);
  63 }
  64
  65 /* Mailbox H/W preparations */
  66 static int omap2_mbox_startup(struct omap_mbox *mbox)
  67 {
  68         unsigned int l;
  69
  70         mbox_ick_handle = clk_get(NULL, "mailboxes_ick");
  71         if (IS_ERR(mbox_ick_handle)) {
  72                 printk("Could not get mailboxes_ick\n");
  73                 return -ENODEV;
  74         }
  75         clk_enable(mbox_ick_handle);
  76
  77         /* set smart-idle & autoidle */
  78         l = mbox_read_reg(MAILBOX_SYSCONFIG);
  79         l |= 0x00000011;
  80         mbox_write_reg(l, MAILBOX_SYSCONFIG);
  81
  82         omap2_mbox_enable_irq(mbox, IRQ_RX);
  83
  84         return 0;
  85 }
  86
  87 static void omap2_mbox_shutdown(struct omap_mbox *mbox)
  88 {
  89         clk_disable(mbox_ick_handle);
  90         clk_put(mbox_ick_handle);
  91 }
  92
  93 /* Mailbox FIFO handle functions */
  94 static mbox_msg_t omap2_mbox_fifo_read(struct omap_mbox *mbox)
  95 {
  96         struct omap_mbox2_fifo *fifo =
  97                 &((struct omap_mbox2_priv *)mbox->priv)->rx_fifo;
  98         return (mbox_msg_t) mbox_read_reg(fifo->msg);
  99 }
 100
 101 static void omap2_mbox_fifo_write(struct omap_mbox *mbox, mbox_msg_t msg)
 102 {
 103         struct omap_mbox2_fifo *fifo =
 104                 &((struct omap_mbox2_priv *)mbox->priv)->tx_fifo;
 105         mbox_write_reg(msg, fifo->msg);
 106 }
 107
 108 static int omap2_mbox_fifo_empty(struct omap_mbox *mbox)
 109 {
 110         struct omap_mbox2_fifo *fifo =
 111                 &((struct omap_mbox2_priv *)mbox->priv)->rx_fifo;
 112         return (mbox_read_reg(fifo->msg_stat) == 0);
 113 }
 114
 115 static int omap2_mbox_fifo_full(struct omap_mbox *mbox)
 116 {
 117         struct omap_mbox2_fifo *fifo =
 118                 &((struct omap_mbox2_priv *)mbox->priv)->tx_fifo;
 119         return (mbox_read_reg(fifo->fifo_stat));
 120 }
 121
 122 /* Mailbox IRQ handle functions */
 123 static void omap2_mbox_enable_irq(struct omap_mbox *mbox,
 124                 omap_mbox_type_t irq)
 125 {
 126         struct omap_mbox2_priv *p = (struct omap_mbox2_priv *)mbox->priv;
 127         u32 l, bit = (irq == IRQ_TX) ? p->notfull_bit : p->newmsg_bit;
 128
 129         l = mbox_read_reg(p->irqenable);
 130         l |= bit;
 131         mbox_write_reg(l, p->irqenable);
 132 }
 133
 134 static void omap2_mbox_disable_irq(struct omap_mbox *mbox,
 135                 omap_mbox_type_t irq)
 136 {
 137         struct omap_mbox2_priv *p = (struct omap_mbox2_priv *)mbox->priv;
 138         u32 l, bit = (irq == IRQ_TX) ? p->notfull_bit : p->newmsg_bit;
 139
 140         l = mbox_read_reg(p->irqenable);
 141         l &= ~bit;
 142         mbox_write_reg(l, p->irqenable);
 143 }
 144
 145 static void omap2_mbox_ack_irq(struct omap_mbox *mbox,
 146                 omap_mbox_type_t irq)
 147 {
 148         struct omap_mbox2_priv *p = (struct omap_mbox2_priv *)mbox->priv;
 149         u32 bit = (irq == IRQ_TX) ? p->notfull_bit : p->newmsg_bit;
 150
 151         mbox_write_reg(bit, p->irqstatus);
 152 }
 153
 154 static int omap2_mbox_is_irq(struct omap_mbox *mbox,
 155                 omap_mbox_type_t irq)
 156 {
 157         struct omap_mbox2_priv *p = (struct omap_mbox2_priv *)mbox->priv;
 158         u32 bit = (irq == IRQ_TX) ? p->notfull_bit : p->newmsg_bit;
 159         u32 enable = mbox_read_reg(p->irqenable);
 160         u32 status = mbox_read_reg(p->irqstatus);
 161
 162         return (enable & status & bit);
 163 }
 164
 165 static struct omap_mbox_ops omap2_mbox_ops = {
 166         .type           = OMAP_MBOX_TYPE2,
 167         .startup        = omap2_mbox_startup,
 168         .shutdown       = omap2_mbox_shutdown,
 169         .fifo_read      = omap2_mbox_fifo_read,
 170         .fifo_write     = omap2_mbox_fifo_write,
 171         .fifo_empty     = omap2_mbox_fifo_empty,
 172         .fifo_full      = omap2_mbox_fifo_full,
 173         .enable_irq     = omap2_mbox_enable_irq,
 174         .disable_irq    = omap2_mbox_disable_irq,
 175         .ack_irq        = omap2_mbox_ack_irq,
 176         .is_irq         = omap2_mbox_is_irq,
 177 };
 178
 179 /*
 180  * MAILBOX 0: ARM -> DSP,
 181  * MAILBOX 1: ARM <- DSP.
 182  * MAILBOX 2: ARM -> IVA,
 183  * MAILBOX 3: ARM <- IVA.
 184  */
 185
 186 /* FIXME: the following structs should be filled automatically by the user id */
 187
 188 /* DSP */
 189 static struct omap_mbox2_priv omap2_mbox_dsp_priv = {
 190         .tx_fifo = {
 191                 .msg            = MAILBOX_MESSAGE(0),
 192                 .fifo_stat      = MAILBOX_FIFOSTATUS(0),
 193         },
 194         .rx_fifo = {
 195                 .msg            = MAILBOX_MESSAGE(1),
 196                 .msg_stat       = MAILBOX_MSGSTATUS(1),
 197         },
 198         .irqenable      = MAILBOX_IRQENABLE(0),
 199         .irqstatus      = MAILBOX_IRQSTATUS(0),
 200         .notfull_bit    = MAILBOX_IRQ_NOTFULL(0),
 201         .newmsg_bit     = MAILBOX_IRQ_NEWMSG(1),
 202 };
 203
 204 struct omap_mbox mbox_dsp_info = {
 205         .name   = "dsp",
 206         .ops    = &omap2_mbox_ops,
 207         .priv   = &omap2_mbox_dsp_priv,
 208 };
 209 EXPORT_SYMBOL(mbox_dsp_info);
 210
 211 #if defined(CONFIG_ARCH_OMAP2420) /* IVA */
 212 static struct omap_mbox2_priv omap2_mbox_iva_priv = {
 213         .tx_fifo = {
 214                 .msg            = MAILBOX_MESSAGE(2),
 215                 .fifo_stat      = MAILBOX_FIFOSTATUS(2),
 216         },
 217         .rx_fifo = {
 218                 .msg            = MAILBOX_MESSAGE(3),
 219                 .msg_stat       = MAILBOX_MSGSTATUS(3),
 220         },
 221         .irqenable      = MAILBOX_IRQENABLE(3),
 222         .irqstatus      = MAILBOX_IRQSTATUS(3),
 223         .notfull_bit    = MAILBOX_IRQ_NOTFULL(2),
 224         .newmsg_bit     = MAILBOX_IRQ_NEWMSG(3),
 225 };
 226
 227 static struct omap_mbox mbox_iva_info = {
 228         .name   = "iva",
 229         .ops    = &omap2_mbox_ops,
 230         .priv   = &omap2_mbox_iva_priv,
 231 };
 232 #endif
 233
 234 static int __init omap2_mbox_probe(struct platform_device *pdev)
 235 {
 236         struct resource *res;
 237         int ret;
 238
 239         /* MBOX base */
 240         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 241         if (unlikely(!res)) {
 242                 dev_err(&pdev->dev, "invalid mem resource\n");
 243                 return -ENODEV;
 244         }
 245         mbox_base = ioremap(res->start, res->end - res->start);
 246         if (!mbox_base)
 247                 return -ENOMEM;
 248
 249         /* DSP or IVA2 IRQ */
 250         res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
 251         if (unlikely(!res)) {
 252                 dev_err(&pdev->dev, "invalid irq resource\n");
 253                 ret = -ENODEV;
 254                 goto err_dsp;
 255         }
 256         mbox_dsp_info.irq = res->start;
 257
 258         ret = omap_mbox_register(&mbox_dsp_info);
 259         if (ret)
 260                 goto err_dsp;
 261
 262 #if defined(CONFIG_ARCH_OMAP2420) /* IVA */
 263         if (cpu_is_omap2420()) {
 264                 /* IVA IRQ */
 265                 res = platform_get_resource(pdev, IORESOURCE_IRQ, 1);
 266                 if (unlikely(!res)) {
 267                         dev_err(&pdev->dev, "invalid irq resource\n");
 268                         ret = -ENODEV;
 269                         goto err_iva1;
 270                 }
 271                 mbox_iva_info.irq = res->start;
 272                 ret = omap_mbox_register(&mbox_iva_info);
 273                 if (ret)
 274                         goto err_iva1;
 275         }
 276 #endif
 277         return 0;
 278
 279 err_iva1:
 280         omap_mbox_unregister(&mbox_dsp_info);
 281 err_dsp:
 282         iounmap(mbox_base);
 283         return ret;
 284 }
 285
 286 static int omap2_mbox_remove(struct platform_device *pdev)
 287 {
 288 #if defined(CONFIG_ARCH_OMAP2420)
 289         omap_mbox_unregister(&mbox_iva_info);
 290 #endif
 291         omap_mbox_unregister(&mbox_dsp_info);
 292         iounmap(mbox_base);
 293         return 0;
 294 }
 295
 296 static struct platform_driver omap2_mbox_driver = {
 297         .probe = omap2_mbox_probe,
 298         .remove = omap2_mbox_remove,
 299         .driver = {
 300                 .name = "mailbox",
 301         },
 302 };
 303
 304 static int __init omap2_mbox_init(void)
 305 {
 306         return platform_driver_register(&omap2_mbox_driver);
 307 }
 308
 309 static void __exit omap2_mbox_exit(void)
 310 {
 311         platform_driver_unregister(&omap2_mbox_driver);
 312 }
 313
 314 module_init(omap2_mbox_init);
 315 module_exit(omap2_mbox_exit);
 316
 317 MODULE_LICENSE("GPL v2");
 318 MODULE_DESCRIPTION("omap mailbox: omap2/3 architecture specific functions");
 319 MODULE_AUTHOR("Hiroshi DOYU <Hiroshi.DOYU@nokia.com>, Paul Mundt");