arch/arm/plat-omap/include/plat/mailbox.h

   1 /* mailbox.h */
   2
   3 #ifndef MAILBOX_H
   4 #define MAILBOX_H
   5
   6 #include <linux/wait.h>
   7 #include <linux/workqueue.h>
   8 #include <linux/interrupt.h>
   9 #include <linux/kfifo.h>
  10
  11 typedef u32 mbox_msg_t;
  12 struct omap_mbox;
  13
  14 typedef int __bitwise omap_mbox_irq_t;
  15 #define IRQ_TX ((__force omap_mbox_irq_t) 1)
  16 #define IRQ_RX ((__force omap_mbox_irq_t) 2)
  17
  18 typedef int __bitwise omap_mbox_type_t;
  19 #define OMAP_MBOX_TYPE1 ((__force omap_mbox_type_t) 1)
  20 #define OMAP_MBOX_TYPE2 ((__force omap_mbox_type_t) 2)
  21
  22 struct omap_mbox_ops {
  23         omap_mbox_type_t        type;
  24         int             (*startup)(struct omap_mbox *mbox);
  25         void            (*shutdown)(struct omap_mbox *mbox);
  26         /* fifo */
  27         mbox_msg_t      (*fifo_read)(struct omap_mbox *mbox);
  28         void            (*fifo_write)(struct omap_mbox *mbox, mbox_msg_t msg);
  29         int             (*fifo_empty)(struct omap_mbox *mbox);
  30         int             (*fifo_full)(struct omap_mbox *mbox);
  31         /* irq */
  32         void            (*enable_irq)(struct omap_mbox *mbox,
  33                                                 omap_mbox_irq_t irq);
  34         void            (*disable_irq)(struct omap_mbox *mbox,
  35                                                 omap_mbox_irq_t irq);
  36         void            (*ack_irq)(struct omap_mbox *mbox, omap_mbox_irq_t irq);
  37         int             (*is_irq)(struct omap_mbox *mbox, omap_mbox_irq_t irq);
  38         /* ctx */
  39         void            (*save_ctx)(struct omap_mbox *mbox);
  40         void            (*restore_ctx)(struct omap_mbox *mbox);
  41 };
  42
  43 struct omap_mbox_queue {
  44         spinlock_t              lock;
  45         struct kfifo            fifo;
  46         struct work_struct      work;
  47         struct tasklet_struct   tasklet;
  48         int     (*callback)(void *);
  49         struct omap_mbox        *mbox;
  50 };
  51
  52 struct omap_mbox {
  53         char                    *name;
  54         unsigned int            irq;
  55         struct omap_mbox_queue  *txq, *rxq;
  56         struct omap_mbox_ops    *ops;
  57         struct device           *dev;
  58         void                    *priv;
  59 };
  60
  61 int omap_mbox_msg_send(struct omap_mbox *, mbox_msg_t msg);
  62 void omap_mbox_init_seq(struct omap_mbox *);
  63
  64 struct omap_mbox *omap_mbox_get(const char *);
  65 void omap_mbox_put(struct omap_mbox *);
  66
  67 int omap_mbox_register(struct device *parent, struct omap_mbox **);
  68 int omap_mbox_unregister(void);
  69
  70 static inline void omap_mbox_save_ctx(struct omap_mbox *mbox)
  71 {
  72         if (!mbox->ops->save_ctx) {
  73                 dev_err(mbox->dev, "%s:\tno save\n", __func__);
  74                 return;
  75         }
  76
  77         mbox->ops->save_ctx(mbox);
  78 }
  79
  80 static inline void omap_mbox_restore_ctx(struct omap_mbox *mbox)
  81 {
  82         if (!mbox->ops->restore_ctx) {
  83                 dev_err(mbox->dev, "%s:\tno restore\n", __func__);
  84                 return;
  85         }
  86
  87         mbox->ops->restore_ctx(mbox);
  88 }
  89
  90 static inline void omap_mbox_enable_irq(struct omap_mbox *mbox,
  91                                         omap_mbox_irq_t irq)
  92 {
  93         mbox->ops->enable_irq(mbox, irq);
  94 }
  95
  96 static inline void omap_mbox_disable_irq(struct omap_mbox *mbox,
  97                                          omap_mbox_irq_t irq)
  98 {
  99         mbox->ops->disable_irq(mbox, irq);
 100 }
 101
 102 #endif /* MAILBOX_H */