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/kernel.h>
  14 #include <linux/clk.h>
  15 #include <linux/err.h>
  16 #include <linux/platform_device.h>
  17 #include <linux/io.h>
  18 #include <plat/mailbox.h>
  19 #include <mach/irqs.h>
  20
  21 #define DRV_NAME "omap2-mailbox"
  22
  23 #define MAILBOX_REVISION                0x000
  24 #define MAILBOX_SYSCONFIG               0x010
  25 #define MAILBOX_SYSSTATUS               0x014
  26 #define MAILBOX_MESSAGE(m)              (0x040 + 4 * (m))
  27 #define MAILBOX_FIFOSTATUS(m)           (0x080 + 4 * (m))
  28 #define MAILBOX_MSGSTATUS(m)            (0x0c0 + 4 * (m))
  29 #define MAILBOX_IRQSTATUS(u)            (0x100 + 8 * (u))
  30 #define MAILBOX_IRQENABLE(u)            (0x104 + 8 * (u))
  31
  32 #define OMAP4_MAILBOX_IRQSTATUS(u)      (0x104 + 10 * (u))
  33 #define OMAP4_MAILBOX_IRQENABLE(u)      (0x108 + 10 * (u))
  34 #define OMAP4_MAILBOX_IRQENABLE_CLR(u)  (0x10c + 10 * (u))
  35
  36 #define MAILBOX_IRQ_NEWMSG(m)           (1 << (2 * (m)))
  37 #define MAILBOX_IRQ_NOTFULL(m)          (1 << (2 * (m) + 1))
  38
  39 /* SYSCONFIG: register bit definition */
  40 #define AUTOIDLE        (1 << 0)
  41 #define SOFTRESET       (1 << 1)
  42 #define SMARTIDLE       (2 << 3)
  43 #define OMAP4_SOFTRESET (1 << 0)
  44 #define OMAP4_NOIDLE    (1 << 2)
  45 #define OMAP4_SMARTIDLE (2 << 2)
  46
  47 /* SYSSTATUS: register bit definition */
  48 #define RESETDONE       (1 << 0)
  49
  50 #define MBOX_REG_SIZE                   0x120
  51
  52 #define OMAP4_MBOX_REG_SIZE             0x130
  53
  54 #define MBOX_NR_REGS                    (MBOX_REG_SIZE / sizeof(u32))
  55 #define OMAP4_MBOX_NR_REGS              (OMAP4_MBOX_REG_SIZE / sizeof(u32))
  56
  57 static void __iomem *mbox_base;
  58
  59 struct omap_mbox2_fifo {
  60         unsigned long msg;
  61         unsigned long fifo_stat;
  62         unsigned long msg_stat;
  63 };
  64
  65 struct omap_mbox2_priv {
  66         struct omap_mbox2_fifo tx_fifo;
  67         struct omap_mbox2_fifo rx_fifo;
  68         unsigned long irqenable;
  69         unsigned long irqstatus;
  70         u32 newmsg_bit;
  71         u32 notfull_bit;
  72         u32 ctx[OMAP4_MBOX_NR_REGS];
  73         unsigned long irqdisable;
  74 };
  75
  76 static struct clk *mbox_ick_handle;
  77
  78 static void omap2_mbox_enable_irq(struct omap_mbox *mbox,
  79                                   omap_mbox_type_t irq);
  80
  81 static inline unsigned int mbox_read_reg(size_t ofs)
  82 {
  83         return __raw_readl(mbox_base + ofs);
  84 }
  85
  86 static inline void mbox_write_reg(u32 val, size_t ofs)
  87 {
  88         __raw_writel(val, mbox_base + ofs);
  89 }
  90
  91 /* Mailbox H/W preparations */
  92 static int omap2_mbox_startup(struct omap_mbox *mbox)
  93 {
  94         u32 l;
  95         unsigned long timeout;
  96
  97         mbox_ick_handle = clk_get(NULL, "mailboxes_ick");
  98         if (IS_ERR(mbox_ick_handle)) {
  99                 printk(KERN_ERR "Could not get mailboxes_ick: %ld\n",
 100                         PTR_ERR(mbox_ick_handle));
 101                 return PTR_ERR(mbox_ick_handle);
 102         }
 103         clk_enable(mbox_ick_handle);
 104
 105         if (cpu_is_omap44xx()) {
 106                 mbox_write_reg(OMAP4_SOFTRESET, MAILBOX_SYSCONFIG);
 107                 timeout = jiffies + msecs_to_jiffies(20);
 108                 do {
 109                         l = mbox_read_reg(MAILBOX_SYSCONFIG);
 110                         if (!(l & OMAP4_SOFTRESET))
 111                                 break;
 112                 } while (!time_after(jiffies, timeout));
 113
 114                 if (l & OMAP4_SOFTRESET) {
 115                         pr_err("Can't take mailbox out of reset\n");
 116                         return -ENODEV;
 117                 }
 118         } else {
 119                 mbox_write_reg(SOFTRESET, MAILBOX_SYSCONFIG);
 120                 timeout = jiffies + msecs_to_jiffies(20);
 121                 do {
 122                         l = mbox_read_reg(MAILBOX_SYSSTATUS);
 123                         if (l & RESETDONE)
 124                                 break;
 125                 } while (!time_after(jiffies, timeout));
 126
 127                 if (!(l & RESETDONE)) {
 128                         pr_err("Can't take mailbox out of reset\n");
 129                         return -ENODEV;
 130                 }
 131         }
 132
 133         l = mbox_read_reg(MAILBOX_REVISION);
 134         pr_info("omap mailbox rev %d.%d\n", (l & 0xf0) >> 4, (l & 0x0f));
 135
 136         if (cpu_is_omap44xx())
 137                 l = OMAP4_SMARTIDLE;
 138         else
 139                 l = SMARTIDLE | AUTOIDLE;
 140         mbox_write_reg(l, MAILBOX_SYSCONFIG);
 141
 142         omap2_mbox_enable_irq(mbox, IRQ_RX);
 143
 144         return 0;
 145 }
 146
 147 static void omap2_mbox_shutdown(struct omap_mbox *mbox)
 148 {
 149         clk_disable(mbox_ick_handle);
 150         clk_put(mbox_ick_handle);
 151         mbox_ick_handle = NULL;
 152 }
 153
 154 /* Mailbox FIFO handle functions */
 155 static mbox_msg_t omap2_mbox_fifo_read(struct omap_mbox *mbox)
 156 {
 157         struct omap_mbox2_fifo *fifo =
 158                 &((struct omap_mbox2_priv *)mbox->priv)->rx_fifo;
 159         return (mbox_msg_t) mbox_read_reg(fifo->msg);
 160 }
 161
 162 static void omap2_mbox_fifo_write(struct omap_mbox *mbox, mbox_msg_t msg)
 163 {
 164         struct omap_mbox2_fifo *fifo =
 165                 &((struct omap_mbox2_priv *)mbox->priv)->tx_fifo;
 166         mbox_write_reg(msg, fifo->msg);
 167 }
 168
 169 static int omap2_mbox_fifo_empty(struct omap_mbox *mbox)
 170 {
 171         struct omap_mbox2_fifo *fifo =
 172                 &((struct omap_mbox2_priv *)mbox->priv)->rx_fifo;
 173         return (mbox_read_reg(fifo->msg_stat) == 0);
 174 }
 175
 176 static int omap2_mbox_fifo_full(struct omap_mbox *mbox)
 177 {
 178         struct omap_mbox2_fifo *fifo =
 179                 &((struct omap_mbox2_priv *)mbox->priv)->tx_fifo;
 180         return mbox_read_reg(fifo->fifo_stat);
 181 }
 182
 183 /* Mailbox IRQ handle functions */
 184 static void omap2_mbox_enable_irq(struct omap_mbox *mbox,
 185                 omap_mbox_type_t irq)
 186 {
 187         struct omap_mbox2_priv *p = (struct omap_mbox2_priv *)mbox->priv;
 188         u32 l, bit = (irq == IRQ_TX) ? p->notfull_bit : p->newmsg_bit;
 189
 190         l = mbox_read_reg(p->irqenable);
 191         l |= bit;
 192         mbox_write_reg(l, p->irqenable);
 193 }
 194
 195 static void omap2_mbox_disable_irq(struct omap_mbox *mbox,
 196                 omap_mbox_type_t irq)
 197 {
 198         struct omap_mbox2_priv *p = (struct omap_mbox2_priv *)mbox->priv;
 199         u32 l, bit = (irq == IRQ_TX) ? p->notfull_bit : p->newmsg_bit;
 200         l = mbox_read_reg(p->irqdisable);
 201         l &= ~bit;
 202         mbox_write_reg(l, p->irqdisable);
 203 }
 204
 205 static void omap2_mbox_ack_irq(struct omap_mbox *mbox,
 206                 omap_mbox_type_t irq)
 207 {
 208         struct omap_mbox2_priv *p = (struct omap_mbox2_priv *)mbox->priv;
 209         u32 bit = (irq == IRQ_TX) ? p->notfull_bit : p->newmsg_bit;
 210
 211         mbox_write_reg(bit, p->irqstatus);
 212
 213         /* Flush posted write for irq status to avoid spurious interrupts */
 214         mbox_read_reg(p->irqstatus);
 215 }
 216
 217 static int omap2_mbox_is_irq(struct omap_mbox *mbox,
 218                 omap_mbox_type_t irq)
 219 {
 220         struct omap_mbox2_priv *p = (struct omap_mbox2_priv *)mbox->priv;
 221         u32 bit = (irq == IRQ_TX) ? p->notfull_bit : p->newmsg_bit;
 222         u32 enable = mbox_read_reg(p->irqenable);
 223         u32 status = mbox_read_reg(p->irqstatus);
 224
 225         return (int)(enable & status & bit);
 226 }
 227
 228 static void omap2_mbox_save_ctx(struct omap_mbox *mbox)
 229 {
 230         int i;
 231         struct omap_mbox2_priv *p = mbox->priv;
 232         int nr_regs;
 233         if (cpu_is_omap44xx())
 234                 nr_regs = OMAP4_MBOX_NR_REGS;
 235         else
 236                 nr_regs = MBOX_NR_REGS;
 237         for (i = 0; i < nr_regs; i++) {
 238                 p->ctx[i] = mbox_read_reg(i * sizeof(u32));
 239
 240                 dev_dbg(mbox->dev, "%s: [%02x] %08x\n", __func__,
 241                         i, p->ctx[i]);
 242         }
 243 }
 244
 245 static void omap2_mbox_restore_ctx(struct omap_mbox *mbox)
 246 {
 247         int i;
 248         struct omap_mbox2_priv *p = mbox->priv;
 249         int nr_regs;
 250         if (cpu_is_omap44xx())
 251                 nr_regs = OMAP4_MBOX_NR_REGS;
 252         else
 253                 nr_regs = MBOX_NR_REGS;
 254         for (i = 0; i < nr_regs; i++) {
 255                 mbox_write_reg(p->ctx[i], i * sizeof(u32));
 256
 257                 dev_dbg(mbox->dev, "%s: [%02x] %08x\n", __func__,
 258                         i, p->ctx[i]);
 259         }
 260 }
 261
 262 static struct omap_mbox_ops omap2_mbox_ops = {
 263         .type           = OMAP_MBOX_TYPE2,
 264         .startup        = omap2_mbox_startup,
 265         .shutdown       = omap2_mbox_shutdown,
 266         .fifo_read      = omap2_mbox_fifo_read,
 267         .fifo_write     = omap2_mbox_fifo_write,
 268         .fifo_empty     = omap2_mbox_fifo_empty,
 269         .fifo_full      = omap2_mbox_fifo_full,
 270         .enable_irq     = omap2_mbox_enable_irq,
 271         .disable_irq    = omap2_mbox_disable_irq,
 272         .ack_irq        = omap2_mbox_ack_irq,
 273         .is_irq         = omap2_mbox_is_irq,
 274         .save_ctx       = omap2_mbox_save_ctx,
 275         .restore_ctx    = omap2_mbox_restore_ctx,
 276 };
 277
 278 /*
 279  * MAILBOX 0: ARM -> DSP,
 280  * MAILBOX 1: ARM <- DSP.
 281  * MAILBOX 2: ARM -> IVA,
 282  * MAILBOX 3: ARM <- IVA.
 283  */
 284
 285 /* FIXME: the following structs should be filled automatically by the user id */
 286 /* DSP */
 287 static struct omap_mbox2_priv omap2_mbox_dsp_priv = {
 288         .tx_fifo = {
 289                 .msg            = MAILBOX_MESSAGE(0),
 290                 .fifo_stat      = MAILBOX_FIFOSTATUS(0),
 291         },
 292         .rx_fifo = {
 293                 .msg            = MAILBOX_MESSAGE(1),
 294                 .msg_stat       = MAILBOX_MSGSTATUS(1),
 295         },
 296         .irqenable      = MAILBOX_IRQENABLE(0),
 297         .irqstatus      = MAILBOX_IRQSTATUS(0),
 298         .notfull_bit    = MAILBOX_IRQ_NOTFULL(0),
 299         .newmsg_bit     = MAILBOX_IRQ_NEWMSG(1),
 300         .irqdisable     = MAILBOX_IRQENABLE(0),
 301 };
 302
 303
 304
 305 /* OMAP4 specific data structure. Use the cpu_is_omap4xxx()
 306 to use this*/
 307 static struct omap_mbox2_priv omap2_mbox_1_priv = {
 308         .tx_fifo = {
 309                 .msg            = MAILBOX_MESSAGE(0),
 310                 .fifo_stat      = MAILBOX_FIFOSTATUS(0),
 311         },
 312         .rx_fifo = {
 313                 .msg            = MAILBOX_MESSAGE(1),
 314                 .msg_stat       = MAILBOX_MSGSTATUS(1),
 315         },
 316         .irqenable      = OMAP4_MAILBOX_IRQENABLE(0),
 317         .irqstatus      = OMAP4_MAILBOX_IRQSTATUS(0),
 318         .notfull_bit    = MAILBOX_IRQ_NOTFULL(0),
 319         .newmsg_bit     = MAILBOX_IRQ_NEWMSG(1),
 320         .irqdisable     = OMAP4_MAILBOX_IRQENABLE_CLR(0),
 321 };
 322
 323 struct omap_mbox mbox_1_info = {
 324         .name   = "mailbox-1",
 325         .ops    = &omap2_mbox_ops,
 326         .priv   = &omap2_mbox_1_priv,
 327 };
 328 EXPORT_SYMBOL(mbox_1_info);
 329
 330 struct omap_mbox mbox_dsp_info = {
 331         .name   = "dsp",
 332         .ops    = &omap2_mbox_ops,
 333         .priv   = &omap2_mbox_dsp_priv,
 334 };
 335 EXPORT_SYMBOL(mbox_dsp_info);
 336
 337 static struct omap_mbox2_priv omap2_mbox_2_priv = {
 338         .tx_fifo = {
 339                 .msg            = MAILBOX_MESSAGE(3),
 340                 .fifo_stat      = MAILBOX_FIFOSTATUS(3),
 341         },
 342         .rx_fifo = {
 343                 .msg            = MAILBOX_MESSAGE(2),
 344                 .msg_stat       = MAILBOX_MSGSTATUS(2),
 345         },
 346         .irqenable      = OMAP4_MAILBOX_IRQENABLE(0),
 347         .irqstatus      = OMAP4_MAILBOX_IRQSTATUS(0),
 348         .notfull_bit    = MAILBOX_IRQ_NOTFULL(3),
 349         .newmsg_bit     = MAILBOX_IRQ_NEWMSG(2),
 350         .irqdisable     = OMAP4_MAILBOX_IRQENABLE_CLR(0),
 351 };
 352
 353 struct omap_mbox mbox_2_info = {
 354         .name   = "mailbox-2",
 355         .ops    = &omap2_mbox_ops,
 356         .priv   = &omap2_mbox_2_priv,
 357 };
 358 EXPORT_SYMBOL(mbox_2_info);
 359
 360
 361 #if defined(CONFIG_ARCH_OMAP2420) /* IVA */
 362 static struct omap_mbox2_priv omap2_mbox_iva_priv = {
 363         .tx_fifo = {
 364                 .msg            = MAILBOX_MESSAGE(2),
 365                 .fifo_stat      = MAILBOX_FIFOSTATUS(2),
 366         },
 367         .rx_fifo = {
 368                 .msg            = MAILBOX_MESSAGE(3),
 369                 .msg_stat       = MAILBOX_MSGSTATUS(3),
 370         },
 371         .irqenable      = MAILBOX_IRQENABLE(3),
 372         .irqstatus      = MAILBOX_IRQSTATUS(3),
 373         .notfull_bit    = MAILBOX_IRQ_NOTFULL(2),
 374         .newmsg_bit     = MAILBOX_IRQ_NEWMSG(3),
 375         .irqdisable     = MAILBOX_IRQENABLE(3),
 376 };
 377
 378 static struct omap_mbox mbox_iva_info = {
 379         .name   = "iva",
 380         .ops    = &omap2_mbox_ops,
 381         .priv   = &omap2_mbox_iva_priv,
 382 };
 383 #endif
 384
 385 static int __devinit omap2_mbox_probe(struct platform_device *pdev)
 386 {
 387         struct resource *res;
 388         int ret;
 389
 390         /* MBOX base */
 391         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 392         if (unlikely(!res)) {
 393                 dev_err(&pdev->dev, "invalid mem resource\n");
 394                 return -ENODEV;
 395         }
 396         mbox_base = ioremap(res->start, resource_size(res));
 397         if (!mbox_base)
 398                 return -ENOMEM;
 399
 400         /* DSP or IVA2 IRQ */
 401         res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
 402
 403         if (unlikely(!res)) {
 404                 dev_err(&pdev->dev, "invalid irq resource\n");
 405                 ret = -ENODEV;
 406                 goto err_dsp;
 407         }
 408         if (cpu_is_omap44xx()) {
 409                 mbox_1_info.irq = res->start;
 410                 ret = omap_mbox_register(&pdev->dev, &mbox_1_info);
 411         } else {
 412                 mbox_dsp_info.irq = res->start;
 413                 ret = omap_mbox_register(&pdev->dev, &mbox_dsp_info);
 414         }
 415         if (ret)
 416                 goto err_dsp;
 417
 418         if (cpu_is_omap44xx()) {
 419                 mbox_2_info.irq = res->start;
 420                 ret = omap_mbox_register(&pdev->dev, &mbox_2_info);
 421                 if (ret) {
 422                         omap_mbox_unregister(&mbox_1_info);
 423                         goto err_dsp;
 424                 }
 425         }
 426 #if defined(CONFIG_ARCH_OMAP2420) /* IVA */
 427         if (cpu_is_omap2420()) {
 428                 /* IVA IRQ */
 429                 res = platform_get_resource(pdev, IORESOURCE_IRQ, 1);
 430                 if (unlikely(!res)) {
 431                         dev_err(&pdev->dev, "invalid irq resource\n");
 432                         ret = -ENODEV;
 433                         omap_mbox_unregister(&mbox_dsp_info);
 434                         goto err_dsp;
 435                 }
 436                 mbox_iva_info.irq = res->start;
 437                 ret = omap_mbox_register(&pdev->dev, &mbox_iva_info);
 438                 if (ret) {
 439                         omap_mbox_unregister(&mbox_dsp_info);
 440                         goto err_dsp;
 441                 }
 442         }
 443 #endif
 444         return 0;
 445
 446 err_dsp:
 447         iounmap(mbox_base);
 448         return ret;
 449 }
 450
 451 static int __devexit omap2_mbox_remove(struct platform_device *pdev)
 452 {
 453 #if defined(CONFIG_ARCH_OMAP2420)
 454         omap_mbox_unregister(&mbox_iva_info);
 455 #endif
 456
 457         if (cpu_is_omap44xx()) {
 458                 omap_mbox_unregister(&mbox_2_info);
 459                 omap_mbox_unregister(&mbox_1_info);
 460         } else
 461                 omap_mbox_unregister(&mbox_dsp_info);
 462         iounmap(mbox_base);
 463         return 0;
 464 }
 465
 466 static struct platform_driver omap2_mbox_driver = {
 467         .probe = omap2_mbox_probe,
 468         .remove = __devexit_p(omap2_mbox_remove),
 469         .driver = {
 470                 .name = DRV_NAME,
 471         },
 472 };
 473
 474 static int __init omap2_mbox_init(void)
 475 {
 476         return platform_driver_register(&omap2_mbox_driver);
 477 }
 478
 479 static void __exit omap2_mbox_exit(void)
 480 {
 481         platform_driver_unregister(&omap2_mbox_driver);
 482 }
 483
 484 module_init(omap2_mbox_init);
 485 module_exit(omap2_mbox_exit);
 486
 487 MODULE_LICENSE("GPL v2");
 488 MODULE_DESCRIPTION("omap mailbox: omap2/3/4 architecture specific functions");
 489 MODULE_AUTHOR("Hiroshi DOYU <Hiroshi.DOYU@nokia.com>, Paul Mundt");
 490 MODULE_ALIAS("platform:"DRV_NAME);