[deliverable/linux.git] / drivers / media / rc / rc-core-priv.h

/*
 * Remote Controller core raw events header
 *
 * Copyright (C) 2010 by Mauro Carvalho Chehab <mchehab@redhat.com>
 *
 * This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation version 2 of the License.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 */

#ifndef _RC_CORE_PRIV
#define _RC_CORE_PRIV

#include <linux/slab.h>
#include <linux/spinlock.h>
#include <media/rc-core.h>

struct ir_raw_handler {
	struct list_head list;

	u64 protocols; /* which are handled by this handler */
	int (*decode)(struct rc_dev *dev, struct ir_raw_event event);

	/* These two should only be used by the lirc decoder */
	int (*raw_register)(struct rc_dev *dev);
	int (*raw_unregister)(struct rc_dev *dev);
};

struct ir_raw_event_ctrl {
	struct list_head		list;		/* to keep track of raw clients */
	struct task_struct		*thread;
	spinlock_t			lock;
	struct kfifo_rec_ptr_1		kfifo;		/* fifo for the pulse/space durations */
	ktime_t				last_event;	/* when last event occurred */
	enum raw_event_type		last_type;	/* last event type */
	struct rc_dev			*dev;		/* pointer to the parent rc_dev */
	u64				enabled_protocols; /* enabled raw protocol decoders */

	/* raw decoder state follows */
	struct ir_raw_event prev_ev;
	struct ir_raw_event this_ev;
	struct nec_dec {
		int state;
		unsigned count;
		u32 bits;
		bool is_nec_x;
		bool necx_repeat;
	} nec;
	struct rc5_dec {
		int state;
		u32 bits;
		unsigned count;
		unsigned wanted_bits;
	} rc5;
	struct rc6_dec {
		int state;
		u8 header;
		u32 body;
		bool toggle;
		unsigned count;
		unsigned wanted_bits;
	} rc6;
	struct sony_dec {
		int state;
		u32 bits;
		unsigned count;
	} sony;
	struct jvc_dec {
		int state;
		u16 bits;
		u16 old_bits;
		unsigned count;
		bool first;
		bool toggle;
	} jvc;
	struct rc5_sz_dec {
		int state;
		u32 bits;
		unsigned count;
		unsigned wanted_bits;
	} rc5_sz;
	struct sanyo_dec {
		int state;
		unsigned count;
		u64 bits;
	} sanyo;
	struct mce_kbd_dec {
		struct input_dev *idev;
		struct timer_list rx_timeout;
		char name[64];
		char phys[64];
		int state;
		u8 header;
		u32 body;
		unsigned count;
		unsigned wanted_bits;
	} mce_kbd;
	struct lirc_codec {
		struct rc_dev *dev;
		struct lirc_driver *drv;
		int carrier_low;

		ktime_t gap_start;
		u64 gap_duration;
		bool gap;
		bool send_timeout_reports;

	} lirc;
};

/* macros for IR decoders */
static inline bool geq_margin(unsigned d1, unsigned d2, unsigned margin)
{
	return d1 > (d2 - margin);
}

static inline bool eq_margin(unsigned d1, unsigned d2, unsigned margin)
{
	return ((d1 > (d2 - margin)) && (d1 < (d2 + margin)));
}

static inline bool is_transition(struct ir_raw_event *x, struct ir_raw_event *y)
{
	return x->pulse != y->pulse;
}

static inline void decrease_duration(struct ir_raw_event *ev, unsigned duration)
{
	if (duration > ev->duration)
		ev->duration = 0;
	else
		ev->duration -= duration;
}

/* Returns true if event is normal pulse/space event */
static inline bool is_timing_event(struct ir_raw_event ev)
{
	return !ev.carrier_report && !ev.reset;
}

#define TO_US(duration)			DIV_ROUND_CLOSEST((duration), 1000)
#define TO_STR(is_pulse)		((is_pulse) ? "pulse" : "space")

/*
 * Routines from rc-raw.c to be used internally and by decoders
 */
u64 ir_raw_get_allowed_protocols(void);
int ir_raw_event_register(struct rc_dev *dev);
void ir_raw_event_unregister(struct rc_dev *dev);
int ir_raw_handler_register(struct ir_raw_handler *ir_raw_handler);
void ir_raw_handler_unregister(struct ir_raw_handler *ir_raw_handler);
void ir_raw_init(void);

/*
 * Decoder initialization code
 *
 * Those load logic are called during ir-core init, and automatically
 * loads the compiled decoders for their usage with IR raw events
 */

/* from ir-nec-decoder.c */
#ifdef CONFIG_IR_NEC_DECODER_MODULE
#define load_nec_decode()	request_module("ir-nec-decoder")
#else
static inline void load_nec_decode(void) { }
#endif

/* from ir-rc5-decoder.c */
#ifdef CONFIG_IR_RC5_DECODER_MODULE
#define load_rc5_decode()	request_module("ir-rc5-decoder")
#else
static inline void load_rc5_decode(void) { }
#endif

/* from ir-rc6-decoder.c */
#ifdef CONFIG_IR_RC6_DECODER_MODULE
#define load_rc6_decode()	request_module("ir-rc6-decoder")
#else
static inline void load_rc6_decode(void) { }
#endif

/* from ir-jvc-decoder.c */
#ifdef CONFIG_IR_JVC_DECODER_MODULE
#define load_jvc_decode()	request_module("ir-jvc-decoder")
#else
static inline void load_jvc_decode(void) { }
#endif

/* from ir-sony-decoder.c */
#ifdef CONFIG_IR_SONY_DECODER_MODULE
#define load_sony_decode()	request_module("ir-sony-decoder")
#else
static inline void load_sony_decode(void) { }
#endif

/* from ir-sanyo-decoder.c */
#ifdef CONFIG_IR_SANYO_DECODER_MODULE
#define load_sanyo_decode()	request_module("ir-sanyo-decoder")
#else
static inline void load_sanyo_decode(void) { }
#endif

/* from ir-mce_kbd-decoder.c */
#ifdef CONFIG_IR_MCE_KBD_DECODER_MODULE
#define load_mce_kbd_decode()	request_module("ir-mce_kbd-decoder")
#else
static inline void load_mce_kbd_decode(void) { }
#endif

/* from ir-lirc-codec.c */
#ifdef CONFIG_IR_LIRC_CODEC_MODULE
#define load_lirc_codec()	request_module("ir-lirc-codec")
#else
static inline void load_lirc_codec(void) { }
#endif


#endif /* _RC_CORE_PRIV */
Commit	Line	Data
3f113e36 MCC	1	/*
	2	* Remote Controller core raw events header
	3	*
	4	* Copyright (C) 2010 by Mauro Carvalho Chehab <mchehab@redhat.com>
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation version 2 of the License.
	9	*
	10	* This program is distributed in the hope that it will be useful,
	11	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	* GNU General Public License for more details.
	14	*/
	15
829ba9fe DH	16	#ifndef _RC_CORE_PRIV
829ba9fe DH	17	#define _RC_CORE_PRIV
3f113e36 MCC	18
3f113e36 MCC	19	#include <linux/slab.h>
c6ef1e7f	20	#include <linux/spinlock.h>
6bda9644	21	#include <media/rc-core.h>
3f113e36 MCC	22
	23	struct ir_raw_handler {
	24	struct list_head list;
	25
667c9ebe	26	u64 protocols; /* which are handled by this handler */
d8b4b582	27	int (decode)(struct rc_dev dev, struct ir_raw_event event);
c216369e DH	28
c216369e DH	29	/* These two should only be used by the lirc decoder */
d8b4b582 DH	30	int (raw_register)(struct rc_dev dev);
d8b4b582 DH	31	int (raw_unregister)(struct rc_dev dev);
3f113e36 MCC	32	};
	33
	34	struct ir_raw_event_ctrl {
c216369e	35	struct list_head list; /* to keep track of raw clients */
0d2cb1de	36	struct task_struct *thread;
c6ef1e7f	37	spinlock_t lock;
df1caa58	38	struct kfifo_rec_ptr_1 kfifo; /* fifo for the pulse/space durations */
3f113e36 MCC	39	ktime_t last_event; /* when last event occurred */
3f113e36 MCC	40	enum raw_event_type last_type; /* last event type */
d8b4b582	41	struct rc_dev dev; / pointer to the parent rc_dev */
667c9ebe	42	u64 enabled_protocols; /* enabled raw protocol decoders */
c216369e DH	43
	44	/* raw decoder state follows */
	45	struct ir_raw_event prev_ev;
4a702ebf	46	struct ir_raw_event this_ev;
c216369e DH	47	struct nec_dec {
	48	int state;
	49	unsigned count;
	50	u32 bits;
86ff071c ML	51	bool is_nec_x;
86ff071c ML	52	bool necx_repeat;
c216369e DH	53	} nec;
	54	struct rc5_dec {
	55	int state;
	56	u32 bits;
	57	unsigned count;
	58	unsigned wanted_bits;
	59	} rc5;
	60	struct rc6_dec {
	61	int state;
	62	u8 header;
	63	u32 body;
	64	bool toggle;
	65	unsigned count;
	66	unsigned wanted_bits;
	67	} rc6;
	68	struct sony_dec {
	69	int state;
	70	u32 bits;
	71	unsigned count;
	72	} sony;
	73	struct jvc_dec {
	74	int state;
	75	u16 bits;
	76	u16 old_bits;
	77	unsigned count;
	78	bool first;
	79	bool toggle;
	80	} jvc;
7a569f52 JW	81	struct rc5_sz_dec {
	82	int state;
	83	u32 bits;
	84	unsigned count;
	85	unsigned wanted_bits;
	86	} rc5_sz;
b32e7243 MCC	87	struct sanyo_dec {
	88	int state;
	89	unsigned count;
	90	u64 bits;
	91	} sanyo;
f5f2cc64 JW	92	struct mce_kbd_dec {
	93	struct input_dev *idev;
	94	struct timer_list rx_timeout;
	95	char name[64];
	96	char phys[64];
	97	int state;
	98	u8 header;
	99	u32 body;
	100	unsigned count;
	101	unsigned wanted_bits;
	102	} mce_kbd;
ca414698	103	struct lirc_codec {
d8b4b582	104	struct rc_dev *dev;
ca414698	105	struct lirc_driver *drv;
e589333f	106	int carrier_low;
4651918a ML	107
	108	ktime_t gap_start;
	109	u64 gap_duration;
	110	bool gap;
	111	bool send_timeout_reports;
	112
ca414698	113	} lirc;
3f113e36 MCC	114	};
	115
	116	/* macros for IR decoders */
384f23e8 MCC	117	static inline bool geq_margin(unsigned d1, unsigned d2, unsigned margin)
384f23e8 MCC	118	{
e40b1127 DH	119	return d1 > (d2 - margin);
	120	}
	121
384f23e8 MCC	122	static inline bool eq_margin(unsigned d1, unsigned d2, unsigned margin)
384f23e8 MCC	123	{
e40b1127 DH	124	return ((d1 > (d2 - margin)) && (d1 < (d2 + margin)));
	125	}
	126
384f23e8 MCC	127	static inline bool is_transition(struct ir_raw_event x, struct ir_raw_event y)
384f23e8 MCC	128	{
e40b1127 DH	129	return x->pulse != y->pulse;
	130	}
	131
384f23e8 MCC	132	static inline void decrease_duration(struct ir_raw_event *ev, unsigned duration)
384f23e8 MCC	133	{
e40b1127 DH	134	if (duration > ev->duration)
	135	ev->duration = 0;
	136	else
	137	ev->duration -= duration;
	138	}
	139
4651918a ML	140	/* Returns true if event is normal pulse/space event */
	141	static inline bool is_timing_event(struct ir_raw_event ev)
	142	{
	143	return !ev.carrier_report && !ev.reset;
	144	}
	145
510fcb70	146	#define TO_US(duration) DIV_ROUND_CLOSEST((duration), 1000)
e40b1127	147	#define TO_STR(is_pulse) ((is_pulse) ? "pulse" : "space")
3f113e36 MCC	148
3f113e36 MCC	149	/*
d8b4b582	150	* Routines from rc-raw.c to be used internally and by decoders
3f113e36	151	*/
667c9ebe	152	u64 ir_raw_get_allowed_protocols(void);
d8b4b582 DH	153	int ir_raw_event_register(struct rc_dev *dev);
d8b4b582 DH	154	void ir_raw_event_unregister(struct rc_dev *dev);
3f113e36 MCC	155	int ir_raw_handler_register(struct ir_raw_handler *ir_raw_handler);
	156	void ir_raw_handler_unregister(struct ir_raw_handler *ir_raw_handler);
	157	void ir_raw_init(void);
	158
3f113e36 MCC	159	/*
	160	* Decoder initialization code
	161	*
	162	* Those load logic are called during ir-core init, and automatically
	163	* loads the compiled decoders for their usage with IR raw events
	164	*/
	165
	166	/* from ir-nec-decoder.c */
	167	#ifdef CONFIG_IR_NEC_DECODER_MODULE
	168	#define load_nec_decode() request_module("ir-nec-decoder")
	169	#else
600836cc	170	static inline void load_nec_decode(void) { }
3f113e36 MCC	171	#endif
	172
	173	/* from ir-rc5-decoder.c */
	174	#ifdef CONFIG_IR_RC5_DECODER_MODULE
	175	#define load_rc5_decode() request_module("ir-rc5-decoder")
	176	#else
600836cc	177	static inline void load_rc5_decode(void) { }
3f113e36 MCC	178	#endif
3f113e36 MCC	179
784a4931	180	/* from ir-rc6-decoder.c */
f35473e6	181	#ifdef CONFIG_IR_RC6_DECODER_MODULE
784a4931 DH	182	#define load_rc6_decode() request_module("ir-rc6-decoder")
784a4931 DH	183	#else
600836cc	184	static inline void load_rc6_decode(void) { }
784a4931 DH	185	#endif
784a4931 DH	186
bf670f64 DH	187	/* from ir-jvc-decoder.c */
	188	#ifdef CONFIG_IR_JVC_DECODER_MODULE
	189	#define load_jvc_decode() request_module("ir-jvc-decoder")
	190	#else
600836cc	191	static inline void load_jvc_decode(void) { }
bf670f64 DH	192	#endif
bf670f64 DH	193
3fe29c89 DH	194	/* from ir-sony-decoder.c */
	195	#ifdef CONFIG_IR_SONY_DECODER_MODULE
	196	#define load_sony_decode() request_module("ir-sony-decoder")
	197	#else
600836cc	198	static inline void load_sony_decode(void) { }
3fe29c89 DH	199	#endif
3fe29c89 DH	200
b32e7243 MCC	201	/* from ir-sanyo-decoder.c */
	202	#ifdef CONFIG_IR_SANYO_DECODER_MODULE
	203	#define load_sanyo_decode() request_module("ir-sanyo-decoder")
	204	#else
	205	static inline void load_sanyo_decode(void) { }
	206	#endif
	207
f5f2cc64 JW	208	/* from ir-mce_kbd-decoder.c */
	209	#ifdef CONFIG_IR_MCE_KBD_DECODER_MODULE
	210	#define load_mce_kbd_decode() request_module("ir-mce_kbd-decoder")
	211	#else
600836cc	212	static inline void load_mce_kbd_decode(void) { }
f5f2cc64 JW	213	#endif
f5f2cc64 JW	214
ca414698 JW	215	/* from ir-lirc-codec.c */
	216	#ifdef CONFIG_IR_LIRC_CODEC_MODULE
	217	#define load_lirc_codec() request_module("ir-lirc-codec")
	218	#else
600836cc	219	static inline void load_lirc_codec(void) { }
ca414698 JW	220	#endif
	221
	222
829ba9fe	223	#endif /* _RC_CORE_PRIV */