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

/*
 * Remote Controller core raw events header
 *
 * Copyright (C) 2010 by Mauro Carvalho Chehab
 *
 * 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 */

	/* 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;
		bool is_rc5x;
	} 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 sanyo_dec {
		int state;
		unsigned count;
		u64 bits;
	} sanyo;
	struct sharp_dec {
		int state;
		unsigned count;
		u32 bits;
		unsigned int pulse_len;
	} sharp;
	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;
	struct xmp_dec {
		int state;
		unsigned count;
		u32 durations[16];
	} xmp;
};

/* 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-lirc-codec.c */
#ifdef CONFIG_IR_LIRC_CODEC_MODULE
#define load_lirc_codec()	request_module_nowait("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	*
37e59f87	4	* Copyright (C) 2010 by Mauro Carvalho Chehab
3f113e36 MCC	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 */
c216369e DH	42
	43	/* raw decoder state follows */
	44	struct ir_raw_event prev_ev;
4a702ebf	45	struct ir_raw_event this_ev;
c216369e DH	46	struct nec_dec {
	47	int state;
	48	unsigned count;
	49	u32 bits;
86ff071c ML	50	bool is_nec_x;
86ff071c ML	51	bool necx_repeat;
c216369e DH	52	} nec;
	53	struct rc5_dec {
	54	int state;
	55	u32 bits;
	56	unsigned count;
e87b540b	57	bool is_rc5x;
c216369e DH	58	} rc5;
	59	struct rc6_dec {
	60	int state;
	61	u8 header;
	62	u32 body;
	63	bool toggle;
	64	unsigned count;
	65	unsigned wanted_bits;
	66	} rc6;
	67	struct sony_dec {
	68	int state;
	69	u32 bits;
	70	unsigned count;
	71	} sony;
	72	struct jvc_dec {
	73	int state;
	74	u16 bits;
	75	u16 old_bits;
	76	unsigned count;
	77	bool first;
	78	bool toggle;
	79	} jvc;
b32e7243 MCC	80	struct sanyo_dec {
	81	int state;
	82	unsigned count;
	83	u64 bits;
	84	} sanyo;
1d184b0b JH	85	struct sharp_dec {
	86	int state;
	87	unsigned count;
	88	u32 bits;
	89	unsigned int pulse_len;
	90	} sharp;
f5f2cc64 JW	91	struct mce_kbd_dec {
	92	struct input_dev *idev;
	93	struct timer_list rx_timeout;
	94	char name[64];
	95	char phys[64];
	96	int state;
	97	u8 header;
	98	u32 body;
	99	unsigned count;
	100	unsigned wanted_bits;
	101	} mce_kbd;
ca414698	102	struct lirc_codec {
d8b4b582	103	struct rc_dev *dev;
ca414698	104	struct lirc_driver *drv;
e589333f	105	int carrier_low;
4651918a ML	106
	107	ktime_t gap_start;
	108	u64 gap_duration;
	109	bool gap;
	110	bool send_timeout_reports;
	111
ca414698	112	} lirc;
1dee9b59 MM	113	struct xmp_dec {
	114	int state;
	115	unsigned count;
	116	u32 durations[16];
	117	} xmp;
3f113e36 MCC	118	};
	119
	120	/* macros for IR decoders */
384f23e8 MCC	121	static inline bool geq_margin(unsigned d1, unsigned d2, unsigned margin)
384f23e8 MCC	122	{
e40b1127 DH	123	return d1 > (d2 - margin);
	124	}
	125
384f23e8 MCC	126	static inline bool eq_margin(unsigned d1, unsigned d2, unsigned margin)
384f23e8 MCC	127	{
e40b1127 DH	128	return ((d1 > (d2 - margin)) && (d1 < (d2 + margin)));
	129	}
	130
384f23e8 MCC	131	static inline bool is_transition(struct ir_raw_event x, struct ir_raw_event y)
384f23e8 MCC	132	{
e40b1127 DH	133	return x->pulse != y->pulse;
	134	}
	135
384f23e8 MCC	136	static inline void decrease_duration(struct ir_raw_event *ev, unsigned duration)
384f23e8 MCC	137	{
e40b1127 DH	138	if (duration > ev->duration)
	139	ev->duration = 0;
	140	else
	141	ev->duration -= duration;
	142	}
	143
4651918a ML	144	/* Returns true if event is normal pulse/space event */
	145	static inline bool is_timing_event(struct ir_raw_event ev)
	146	{
	147	return !ev.carrier_report && !ev.reset;
	148	}
	149
510fcb70	150	#define TO_US(duration) DIV_ROUND_CLOSEST((duration), 1000)
e40b1127	151	#define TO_STR(is_pulse) ((is_pulse) ? "pulse" : "space")
3f113e36 MCC	152
3f113e36 MCC	153	/*
d8b4b582	154	* Routines from rc-raw.c to be used internally and by decoders
3f113e36	155	*/
667c9ebe	156	u64 ir_raw_get_allowed_protocols(void);
d8b4b582 DH	157	int ir_raw_event_register(struct rc_dev *dev);
d8b4b582 DH	158	void ir_raw_event_unregister(struct rc_dev *dev);
3f113e36 MCC	159	int ir_raw_handler_register(struct ir_raw_handler *ir_raw_handler);
	160	void ir_raw_handler_unregister(struct ir_raw_handler *ir_raw_handler);
	161	void ir_raw_init(void);
	162
3f113e36 MCC	163	/*
	164	* Decoder initialization code
	165	*
	166	* Those load logic are called during ir-core init, and automatically
	167	* loads the compiled decoders for their usage with IR raw events
	168	*/
	169
ca414698 JW	170	/* from ir-lirc-codec.c */
ca414698 JW	171	#ifdef CONFIG_IR_LIRC_CODEC_MODULE
a4bb6f35	172	#define load_lirc_codec() request_module_nowait("ir-lirc-codec")
ca414698	173	#else
600836cc	174	static inline void load_lirc_codec(void) { }
ca414698 JW	175	#endif
ca414698 JW	176
829ba9fe	177	#endif /* _RC_CORE_PRIV */