[deliverable/linux.git] / drivers / media / IR / ir-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 _IR_RAW_EVENT
#define _IR_RAW_EVENT

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

struct ir_raw_handler {
	struct list_head list;

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

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

struct ir_raw_event_ctrl {
	struct list_head		list;		/* to keep track of raw clients */
	struct task_struct		*thread;
	struct kfifo			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 input_dev		*input_dev;	/* pointer to the parent input_dev */
	u64				enabled_protocols; /* enabled raw protocol decoders */

	/* raw decoder state follows */
	struct ir_raw_event prev_ev;
	struct nec_dec {
		int state;
		unsigned count;
		u32 bits;
	} 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 lirc_codec {
		struct ir_input_dev *ir_dev;
		struct lirc_driver *drv;
	} 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;
}

#define TO_US(duration)			DIV_ROUND_CLOSEST((duration), 1000)
#define TO_STR(is_pulse)		((is_pulse) ? "pulse" : "space")
#define IS_RESET(ev)			(ev.duration == 0)
/*
 * Routines from ir-sysfs.c - Meant to be called only internally inside
 * ir-core
 */

int ir_register_class(struct input_dev *input_dev);
void ir_unregister_class(struct input_dev *input_dev);

/*
 * Routines from ir-raw-event.c to be used internally and by decoders
 */
u64 ir_raw_get_allowed_protocols(void);
int ir_raw_event_register(struct input_dev *input_dev);
void ir_raw_event_unregister(struct input_dev *input_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
#define load_nec_decode()	0
#endif

/* from ir-rc5-decoder.c */
#ifdef CONFIG_IR_RC5_DECODER_MODULE
#define load_rc5_decode()	request_module("ir-rc5-decoder")
#else
#define load_rc5_decode()	0
#endif

/* from ir-rc6-decoder.c */
#ifdef CONFIG_IR_RC6_DECODER_MODULE
#define load_rc6_decode()	request_module("ir-rc6-decoder")
#else
#define load_rc6_decode()	0
#endif

/* from ir-jvc-decoder.c */
#ifdef CONFIG_IR_JVC_DECODER_MODULE
#define load_jvc_decode()	request_module("ir-jvc-decoder")
#else
#define load_jvc_decode()	0
#endif

/* from ir-sony-decoder.c */
#ifdef CONFIG_IR_SONY_DECODER_MODULE
#define load_sony_decode()	request_module("ir-sony-decoder")
#else
#define load_sony_decode()	0
#endif

/* from ir-lirc-codec.c */
#ifdef CONFIG_IR_LIRC_CODEC_MODULE
#define load_lirc_codec()	request_module("ir-lirc-codec")
#else
#define load_lirc_codec()	0
#endif


#endif /* _IR_RAW_EVENT */
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
	16	#ifndef _IR_RAW_EVENT
	17	#define _IR_RAW_EVENT
	18
	19	#include <linux/slab.h>
	20	#include <media/ir-core.h>
	21
	22	struct ir_raw_handler {
	23	struct list_head list;
	24
667c9ebe	25	u64 protocols; /* which are handled by this handler */
e40b1127	26	int (decode)(struct input_dev input_dev, struct ir_raw_event event);
c216369e DH	27
c216369e DH	28	/* These two should only be used by the lirc decoder */
3f113e36 MCC	29	int (raw_register)(struct input_dev input_dev);
	30	int (raw_unregister)(struct input_dev input_dev);
	31	};
	32
	33	struct ir_raw_event_ctrl {
c216369e	34	struct list_head list; /* to keep track of raw clients */
0d2cb1de	35	struct task_struct *thread;
3f113e36 MCC	36	struct kfifo kfifo; /* fifo for the pulse/space durations */
	37	ktime_t last_event; /* when last event occurred */
	38	enum raw_event_type last_type; /* last event type */
	39	struct input_dev input_dev; / pointer to the parent input_dev */
667c9ebe	40	u64 enabled_protocols; /* enabled raw protocol decoders */
c216369e DH	41
	42	/* raw decoder state follows */
	43	struct ir_raw_event prev_ev;
	44	struct nec_dec {
	45	int state;
	46	unsigned count;
	47	u32 bits;
	48	} nec;
	49	struct rc5_dec {
	50	int state;
	51	u32 bits;
	52	unsigned count;
	53	unsigned wanted_bits;
	54	} rc5;
	55	struct rc6_dec {
	56	int state;
	57	u8 header;
	58	u32 body;
	59	bool toggle;
	60	unsigned count;
	61	unsigned wanted_bits;
	62	} rc6;
	63	struct sony_dec {
	64	int state;
	65	u32 bits;
	66	unsigned count;
	67	} sony;
	68	struct jvc_dec {
	69	int state;
	70	u16 bits;
	71	u16 old_bits;
	72	unsigned count;
	73	bool first;
	74	bool toggle;
	75	} jvc;
ca414698 JW	76	struct lirc_codec {
	77	struct ir_input_dev *ir_dev;
	78	struct lirc_driver *drv;
ca414698	79	} lirc;
3f113e36 MCC	80	};
	81
	82	/* macros for IR decoders */
384f23e8 MCC	83	static inline bool geq_margin(unsigned d1, unsigned d2, unsigned margin)
384f23e8 MCC	84	{
e40b1127 DH	85	return d1 > (d2 - margin);
	86	}
	87
384f23e8 MCC	88	static inline bool eq_margin(unsigned d1, unsigned d2, unsigned margin)
384f23e8 MCC	89	{
e40b1127 DH	90	return ((d1 > (d2 - margin)) && (d1 < (d2 + margin)));
	91	}
	92
384f23e8 MCC	93	static inline bool is_transition(struct ir_raw_event x, struct ir_raw_event y)
384f23e8 MCC	94	{
e40b1127 DH	95	return x->pulse != y->pulse;
	96	}
	97
384f23e8 MCC	98	static inline void decrease_duration(struct ir_raw_event *ev, unsigned duration)
384f23e8 MCC	99	{
e40b1127 DH	100	if (duration > ev->duration)
	101	ev->duration = 0;
	102	else
	103	ev->duration -= duration;
	104	}
	105
510fcb70	106	#define TO_US(duration) DIV_ROUND_CLOSEST((duration), 1000)
e40b1127 DH	107	#define TO_STR(is_pulse) ((is_pulse) ? "pulse" : "space")
e40b1127 DH	108	#define IS_RESET(ev) (ev.duration == 0)
3f113e36 MCC	109	/*
	110	* Routines from ir-sysfs.c - Meant to be called only internally inside
	111	* ir-core
	112	*/
	113
	114	int ir_register_class(struct input_dev *input_dev);
	115	void ir_unregister_class(struct input_dev *input_dev);
	116
	117	/*
	118	* Routines from ir-raw-event.c to be used internally and by decoders
	119	*/
667c9ebe	120	u64 ir_raw_get_allowed_protocols(void);
3f113e36 MCC	121	int ir_raw_event_register(struct input_dev *input_dev);
3f113e36 MCC	122	void ir_raw_event_unregister(struct input_dev *input_dev);
3f113e36 MCC	123	int ir_raw_handler_register(struct ir_raw_handler *ir_raw_handler);
	124	void ir_raw_handler_unregister(struct ir_raw_handler *ir_raw_handler);
	125	void ir_raw_init(void);
	126
	127
	128	/*
	129	* Decoder initialization code
	130	*
	131	* Those load logic are called during ir-core init, and automatically
	132	* loads the compiled decoders for their usage with IR raw events
	133	*/
	134
	135	/* from ir-nec-decoder.c */
	136	#ifdef CONFIG_IR_NEC_DECODER_MODULE
	137	#define load_nec_decode() request_module("ir-nec-decoder")
	138	#else
	139	#define load_nec_decode() 0
	140	#endif
	141
	142	/* from ir-rc5-decoder.c */
	143	#ifdef CONFIG_IR_RC5_DECODER_MODULE
	144	#define load_rc5_decode() request_module("ir-rc5-decoder")
	145	#else
	146	#define load_rc5_decode() 0
	147	#endif
	148
784a4931	149	/* from ir-rc6-decoder.c */
f35473e6	150	#ifdef CONFIG_IR_RC6_DECODER_MODULE
784a4931 DH	151	#define load_rc6_decode() request_module("ir-rc6-decoder")
	152	#else
	153	#define load_rc6_decode() 0
	154	#endif
	155
bf670f64 DH	156	/* from ir-jvc-decoder.c */
	157	#ifdef CONFIG_IR_JVC_DECODER_MODULE
	158	#define load_jvc_decode() request_module("ir-jvc-decoder")
	159	#else
	160	#define load_jvc_decode() 0
	161	#endif
	162
3fe29c89 DH	163	/* from ir-sony-decoder.c */
	164	#ifdef CONFIG_IR_SONY_DECODER_MODULE
	165	#define load_sony_decode() request_module("ir-sony-decoder")
	166	#else
	167	#define load_sony_decode() 0
	168	#endif
	169
ca414698 JW	170	/* from ir-lirc-codec.c */
	171	#ifdef CONFIG_IR_LIRC_CODEC_MODULE
	172	#define load_lirc_codec() request_module("ir-lirc-codec")
	173	#else
	174	#define load_lirc_codec() 0
	175	#endif
	176
	177
3f113e36	178	#endif /* _IR_RAW_EVENT */