[deliverable/linux.git] / include / media / ir-core.h

/*
 * Remote Controller core header
 *
 * Copyright (C) 2009-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_CORE
#define _IR_CORE

#include <linux/spinlock.h>
#include <linux/kfifo.h>
#include <linux/time.h>
#include <linux/timer.h>
#include <media/rc-map.h>

extern int ir_core_debug;
#define IR_dprintk(level, fmt, arg...)	if (ir_core_debug >= level) \
	printk(KERN_DEBUG "%s: " fmt , __func__, ## arg)

enum rc_driver_type {
	RC_DRIVER_SCANCODE = 0,	/* Driver or hardware generates a scancode */
	RC_DRIVER_IR_RAW,	/* Needs a Infra-Red pulse/space decoder */
};

enum raw_event_type {
	IR_SPACE	= (1 << 0),
	IR_PULSE	= (1 << 1),
	IR_START_EVENT	= (1 << 2),
	IR_STOP_EVENT	= (1 << 3),
};

/**
 * struct ir_dev_props - Allow caller drivers to set special properties
 * @driver_type: specifies if the driver or hardware have already a decoder,
 *	or if it needs to use the IR raw event decoders to produce a scancode
 * @allowed_protos: bitmask with the supported IR_TYPE_* protocols
 * @scanmask: some hardware decoders are not capable of providing the full
 *	scancode to the application. As this is a hardware limit, we can't do
 *	anything with it. Yet, as the same keycode table can be used with other
 *	devices, a mask is provided to allow its usage. Drivers should generally
 *	leave this field in blank
 * @priv: driver-specific data, to be used on the callbacks
 * @change_protocol: allow changing the protocol used on hardware decoders
 * @open: callback to allow drivers to enable polling/irq when IR input device
 *	is opened.
 * @close: callback to allow drivers to disable polling/irq when IR input device
 *	is opened.
 */
struct ir_dev_props {
	enum rc_driver_type	driver_type;
	unsigned long		allowed_protos;
	u32			scanmask;
	void 			*priv;
	int			(*change_protocol)(void *priv, u64 ir_type);
	int			(*open)(void *priv);
	void			(*close)(void *priv);
};

struct ir_raw_event_ctrl {
	struct work_struct		rx_work;	/* for the rx decoding workqueue */
	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 */
};

struct ir_input_dev {
	struct device			dev;		/* device */
	char				*driver_name;	/* Name of the driver module */
	struct ir_scancode_table	rc_tab;		/* scan/key table */
	unsigned long			devno;		/* device number */
	const struct ir_dev_props	*props;		/* Device properties */
	struct ir_raw_event_ctrl	*raw;		/* for raw pulse/space events */
	struct input_dev		*input_dev;	/* the input device associated with this device */

	/* key info - needed by IR keycode handlers */
	spinlock_t			keylock;	/* protects the below members */
	bool				keypressed;	/* current state */
	unsigned long			keyup_jiffies;	/* when should the current keypress be released? */
	struct timer_list		timer_keyup;	/* timer for releasing a keypress */
	u32				last_keycode;	/* keycode of last command */
	u32				last_scancode;	/* scancode of last command */
	u8				last_toggle;	/* toggle of last command */
};

struct ir_raw_handler {
	struct list_head list;

	int (*decode)(struct input_dev *input_dev, s64 duration);
	int (*raw_register)(struct input_dev *input_dev);
	int (*raw_unregister)(struct input_dev *input_dev);
};

#define to_ir_input_dev(_attr) container_of(_attr, struct ir_input_dev, attr)

/* Routines from ir-keytable.c */

u32 ir_g_keycode_from_table(struct input_dev *input_dev,
			    u32 scancode);
void ir_repeat(struct input_dev *dev);
void ir_keydown(struct input_dev *dev, int scancode, u8 toggle);
int __ir_input_register(struct input_dev *dev,
		      const struct ir_scancode_table *ir_codes,
		      const struct ir_dev_props *props,
		      const char *driver_name);

static inline int ir_input_register(struct input_dev *dev,
		      const char *map_name,
		      const struct ir_dev_props *props,
		      const char *driver_name) {
	struct ir_scancode_table *ir_codes;
	struct ir_input_dev *ir_dev;
	int rc;

	if (!map_name)
		return -EINVAL;

	ir_codes = get_rc_map(map_name);
	if (!ir_codes)
		return -EINVAL;

	rc = __ir_input_register(dev, ir_codes, props, driver_name);
	if (rc < 0)
		return -EINVAL;

	ir_dev = input_get_drvdata(dev);

	if (!rc && ir_dev->props && ir_dev->props->change_protocol)
		rc = ir_dev->props->change_protocol(ir_dev->props->priv,
						    ir_codes->ir_type);

	return rc;
}

void ir_input_unregister(struct input_dev *input_dev);

/* Routines from ir-sysfs.c */

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

/* Routines from ir-raw-event.c */
int ir_raw_event_register(struct input_dev *input_dev);
void ir_raw_event_unregister(struct input_dev *input_dev);
void ir_raw_event_handle(struct input_dev *input_dev);
int ir_raw_event_store(struct input_dev *input_dev, s64 duration);
int ir_raw_event_store_edge(struct input_dev *input_dev, enum raw_event_type type);
static inline void ir_raw_event_reset(struct input_dev *input_dev)
{
	ir_raw_event_store(input_dev, 0);
	ir_raw_event_handle(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);

/* 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

/* macros for ir decoders */
#define PULSE(units)				((units))
#define SPACE(units)				(-(units))
#define IS_RESET(duration)			((duration) == 0)
#define IS_PULSE(duration)			((duration) > 0)
#define IS_SPACE(duration)			((duration) < 0)
#define DURATION(duration)			(abs((duration)))
#define IS_TRANSITION(x, y)			((x) * (y) < 0)
#define DECREASE_DURATION(duration, amount)			\
	do {							\
		if (IS_SPACE(duration))				\
			duration += (amount);			\
		else if (IS_PULSE(duration))			\
			duration -= (amount);			\
	} while (0)

#define TO_UNITS(duration, unit_len)				\
	((int)((duration) > 0 ?					\
		DIV_ROUND_CLOSEST(abs((duration)), (unit_len)) :\
		-DIV_ROUND_CLOSEST(abs((duration)), (unit_len))))
#define TO_US(duration)		((int)TO_UNITS(duration, 1000))

#endif /* _IR_CORE */
Commit	Line	Data
446e4a64 MCC	1	/*
	2	* Remote Controller core header
	3	*
995187be MCC	4	* Copyright (C) 2009-2010 by Mauro Carvalho Chehab <mchehab@redhat.com>
995187be MCC	5	*
446e4a64 MCC	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_CORE
	17	#define _IR_CORE
	18
446e4a64	19	#include <linux/spinlock.h>
a3572c34 MCC	20	#include <linux/kfifo.h>
a3572c34 MCC	21	#include <linux/time.h>
9f154782	22	#include <linux/timer.h>
02858eed	23	#include <media/rc-map.h>
446e4a64 MCC	24
	25	extern int ir_core_debug;
	26	#define IR_dprintk(level, fmt, arg...) if (ir_core_debug >= level) \
	27	printk(KERN_DEBUG "%s: " fmt , __func__, ## arg)
	28
626cf697 MCC	29	enum rc_driver_type {
	30	RC_DRIVER_SCANCODE = 0, /* Driver or hardware generates a scancode */
	31	RC_DRIVER_IR_RAW, /* Needs a Infra-Red pulse/space decoder */
	32	};
	33
a3572c34 MCC	34	enum raw_event_type {
	35	IR_SPACE = (1 << 0),
	36	IR_PULSE = (1 << 1),
	37	IR_START_EVENT = (1 << 2),
	38	IR_STOP_EVENT = (1 << 3),
	39	};
	40
9dfe4e83 MCC	41	/**
9dfe4e83 MCC	42	* struct ir_dev_props - Allow caller drivers to set special properties
626cf697 MCC	43	* @driver_type: specifies if the driver or hardware have already a decoder,
626cf697 MCC	44	* or if it needs to use the IR raw event decoders to produce a scancode
9dfe4e83 MCC	45	* @allowed_protos: bitmask with the supported IR_TYPE_* protocols
	46	* @scanmask: some hardware decoders are not capable of providing the full
	47	* scancode to the application. As this is a hardware limit, we can't do
	48	* anything with it. Yet, as the same keycode table can be used with other
	49	* devices, a mask is provided to allow its usage. Drivers should generally
	50	* leave this field in blank
	51	* @priv: driver-specific data, to be used on the callbacks
	52	* @change_protocol: allow changing the protocol used on hardware decoders
	53	* @open: callback to allow drivers to enable polling/irq when IR input device
	54	* is opened.
	55	* @close: callback to allow drivers to disable polling/irq when IR input device
	56	* is opened.
	57	*/
e93854da	58	struct ir_dev_props {
626cf697 MCC	59	enum rc_driver_type driver_type;
	60	unsigned long allowed_protos;
	61	u32 scanmask;
	62	void *priv;
	63	int (change_protocol)(void priv, u64 ir_type);
	64	int (open)(void priv);
	65	void (close)(void priv);
e93854da MCC	66	};
e93854da MCC	67
a3572c34	68	struct ir_raw_event_ctrl {
724e2495 DH	69	struct work_struct rx_work; /* for the rx decoding workqueue */
	70	struct kfifo kfifo; /* fifo for the pulse/space durations */
	71	ktime_t last_event; /* when last event occurred */
	72	enum raw_event_type last_type; /* last event type */
	73	struct input_dev input_dev; / pointer to the parent input_dev */
a3572c34	74	};
53f87022	75
75543cce	76	struct ir_input_dev {
945cdfa2	77	struct device dev; /* device */
727e625c	78	char driver_name; / Name of the driver module */
4714eda8 MCC	79	struct ir_scancode_table rc_tab; /* scan/key table */
4714eda8 MCC	80	unsigned long devno; /* device number */
e93854da	81	const struct ir_dev_props props; / Device properties */
a3572c34	82	struct ir_raw_event_ctrl raw; / for raw pulse/space events */
a374fef4	83	struct input_dev input_dev; / the input device associated with this device */
6660de56 MCC	84
6660de56 MCC	85	/* key info - needed by IR keycode handlers */
a374fef4 DH	86	spinlock_t keylock; /* protects the below members */
	87	bool keypressed; /* current state */
	88	unsigned long keyup_jiffies; /* when should the current keypress be released? */
	89	struct timer_list timer_keyup; /* timer for releasing a keypress */
	90	u32 last_keycode; /* keycode of last command */
	91	u32 last_scancode; /* scancode of last command */
	92	u8 last_toggle; /* toggle of last command */
75543cce	93	};
a3572c34	94
995187be MCC	95	struct ir_raw_handler {
	96	struct list_head list;
	97
724e2495	98	int (decode)(struct input_dev input_dev, s64 duration);
93c312ff MCC	99	int (raw_register)(struct input_dev input_dev);
93c312ff MCC	100	int (raw_unregister)(struct input_dev input_dev);
995187be MCC	101	};
995187be MCC	102
53f87022	103	#define to_ir_input_dev(_attr) container_of(_attr, struct ir_input_dev, attr)
75543cce	104
446e4a64 MCC	105	/* Routines from ir-keytable.c */
	106
	107	u32 ir_g_keycode_from_table(struct input_dev *input_dev,
	108	u32 scancode);
a374fef4 DH	109	void ir_repeat(struct input_dev *dev);
a374fef4 DH	110	void ir_keydown(struct input_dev *dev, int scancode, u8 toggle);
b2245ba1	111	int __ir_input_register(struct input_dev *dev,
e93854da	112	const struct ir_scancode_table *ir_codes,
727e625c MCC	113	const struct ir_dev_props *props,
727e625c MCC	114	const char *driver_name);
446e4a64	115
b2245ba1 MCC	116	static inline int ir_input_register(struct input_dev *dev,
	117	const char *map_name,
	118	const struct ir_dev_props *props,
	119	const char *driver_name) {
	120	struct ir_scancode_table *ir_codes;
02858eed MCC	121	struct ir_input_dev *ir_dev;
	122	int rc;
	123
	124	if (!map_name)
	125	return -EINVAL;
9ce50c1a	126
b2245ba1 MCC	127	ir_codes = get_rc_map(map_name);
	128	if (!ir_codes)
	129	return -EINVAL;
	130
02858eed MCC	131	rc = __ir_input_register(dev, ir_codes, props, driver_name);
	132	if (rc < 0)
	133	return -EINVAL;
	134
	135	ir_dev = input_get_drvdata(dev);
	136
	137	if (!rc && ir_dev->props && ir_dev->props->change_protocol)
	138	rc = ir_dev->props->change_protocol(ir_dev->props->priv,
	139	ir_codes->ir_type);
	140
	141	return rc;
b2245ba1 MCC	142	}
b2245ba1 MCC	143
02858eed	144	void ir_input_unregister(struct input_dev *input_dev);
9ce50c1a	145
4714eda8 MCC	146	/* Routines from ir-sysfs.c */
	147
	148	int ir_register_class(struct input_dev *input_dev);
	149	void ir_unregister_class(struct input_dev *input_dev);
	150
a3572c34 MCC	151	/* Routines from ir-raw-event.c */
	152	int ir_raw_event_register(struct input_dev *input_dev);
	153	void ir_raw_event_unregister(struct input_dev *input_dev);
724e2495 DH	154	void ir_raw_event_handle(struct input_dev *input_dev);
	155	int ir_raw_event_store(struct input_dev *input_dev, s64 duration);
	156	int ir_raw_event_store_edge(struct input_dev *input_dev, enum raw_event_type type);
	157	static inline void ir_raw_event_reset(struct input_dev *input_dev)
	158	{
	159	ir_raw_event_store(input_dev, 0);
	160	ir_raw_event_handle(input_dev);
	161	}
995187be MCC	162	int ir_raw_handler_register(struct ir_raw_handler *ir_raw_handler);
995187be MCC	163	void ir_raw_handler_unregister(struct ir_raw_handler *ir_raw_handler);
995187be	164	void ir_raw_init(void);
a3572c34	165
995187be MCC	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
	170	#define load_nec_decode() 0
446e4a64	171	#endif
995187be	172
db1423a6 MCC	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
	177	#define load_rc5_decode() 0
	178	#endif
	179
724e2495 DH	180	/* macros for ir decoders */
	181	#define PULSE(units) ((units))
	182	#define SPACE(units) (-(units))
	183	#define IS_RESET(duration) ((duration) == 0)
	184	#define IS_PULSE(duration) ((duration) > 0)
	185	#define IS_SPACE(duration) ((duration) < 0)
	186	#define DURATION(duration) (abs((duration)))
	187	#define IS_TRANSITION(x, y) ((x) * (y) < 0)
	188	#define DECREASE_DURATION(duration, amount) \
	189	do { \
	190	if (IS_SPACE(duration)) \
	191	duration += (amount); \
	192	else if (IS_PULSE(duration)) \
	193	duration -= (amount); \
	194	} while (0)
	195
	196	#define TO_UNITS(duration, unit_len) \
	197	((int)((duration) > 0 ? \
	198	DIV_ROUND_CLOSEST(abs((duration)), (unit_len)) :\
	199	-DIV_ROUND_CLOSEST(abs((duration)), (unit_len))))
	200	#define TO_US(duration) ((int)TO_UNITS(duration, 1000))
	201
995187be	202	#endif /* _IR_CORE */