blob: c44fde30c7c1cc8241db6dec24b8e74e7624775f [file] [log] [blame]
Hiroshi DOYU340a6142006-12-07 15:43:59 -08001/* mailbox.h */
2
3#ifndef MAILBOX_H
4#define MAILBOX_H
5
6#include <linux/wait.h>
7#include <linux/workqueue.h>
C A Subramaniam5ed8d322009-11-22 10:11:24 -08008#include <linux/interrupt.h>
Ohad Ben-Cohenb5bebe42010-05-05 15:33:09 +00009#include <linux/kfifo.h>
Hiroshi DOYU340a6142006-12-07 15:43:59 -080010
11typedef u32 mbox_msg_t;
Hiroshi DOYU340a6142006-12-07 15:43:59 -080012struct omap_mbox;
13
14typedef 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
18typedef 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
22struct 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 */
C A Subramaniam5ed8d322009-11-22 10:11:24 -080032 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);
Hiroshi DOYU340a6142006-12-07 15:43:59 -080036 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);
Hiroshi DOYUc75ee752009-03-23 18:07:26 -070038 /* ctx */
39 void (*save_ctx)(struct omap_mbox *mbox);
40 void (*restore_ctx)(struct omap_mbox *mbox);
Hiroshi DOYU340a6142006-12-07 15:43:59 -080041};
42
43struct omap_mbox_queue {
44 spinlock_t lock;
Ohad Ben-Cohenb5bebe42010-05-05 15:33:09 +000045 struct kfifo fifo;
Hiroshi DOYU340a6142006-12-07 15:43:59 -080046 struct work_struct work;
C A Subramaniam5ed8d322009-11-22 10:11:24 -080047 struct tasklet_struct tasklet;
Hiroshi DOYU340a6142006-12-07 15:43:59 -080048 int (*callback)(void *);
49 struct omap_mbox *mbox;
50};
51
52struct omap_mbox {
53 char *name;
54 unsigned int irq;
Hiroshi DOYU340a6142006-12-07 15:43:59 -080055 struct omap_mbox_queue *txq, *rxq;
Hiroshi DOYU340a6142006-12-07 15:43:59 -080056 struct omap_mbox_ops *ops;
Hiroshi DOYUf48cca82009-03-23 18:07:24 -070057 struct device *dev;
Hiroshi DOYU340a6142006-12-07 15:43:59 -080058 void *priv;
Hiroshi DOYU340a6142006-12-07 15:43:59 -080059};
60
C A Subramaniamb2b63622009-11-22 10:11:20 -080061int omap_mbox_msg_send(struct omap_mbox *, mbox_msg_t msg);
Hiroshi DOYU340a6142006-12-07 15:43:59 -080062void omap_mbox_init_seq(struct omap_mbox *);
63
64struct omap_mbox *omap_mbox_get(const char *);
65void omap_mbox_put(struct omap_mbox *);
66
Felipe Contreras9c80c8c2010-06-11 15:51:46 +000067int omap_mbox_register(struct device *parent, struct omap_mbox **);
68int omap_mbox_unregister(void);
Hiroshi DOYU340a6142006-12-07 15:43:59 -080069
Hiroshi DOYUc75ee752009-03-23 18:07:26 -070070static 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
80static 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
Hiroshi DOYUeb188582009-11-22 10:11:22 -080090static 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
96static 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
Hiroshi DOYU340a6142006-12-07 15:43:59 -0800102#endif /* MAILBOX_H */