[net-next-2.6.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 */
};

/**
 * 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
 * @timeout: optional time after which device stops sending data
 * @min_timeout: minimum timeout supported by device
 * @max_timeout: maximum timeout supported by device
 * @rx_resolution : resolution (in ns) of input sampler
 * @tx_resolution: resolution (in ns) of output sampler
 * @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.
 * @s_tx_mask: set transmitter mask (for devices with multiple tx outputs)
 * @s_tx_carrier: set transmit carrier frequency
 * @s_tx_duty_cycle: set transmit duty cycle (0% - 100%)
 * @s_rx_carrier: inform driver about carrier it is expected to handle
 * @tx_ir: transmit IR
 * @s_idle: optional: enable/disable hardware idle mode, upon which,
	device doesn't interrupt host until it sees IR pulses
 * @s_learning_mode: enable wide band receiver used for learning
 * @s_carrier_report: enable carrier reports
 */
struct ir_dev_props {
	enum rc_driver_type	driver_type;
	unsigned long		allowed_protos;
	u32			scanmask;

	u32			timeout;
	u32			min_timeout;
	u32			max_timeout;

	u32			rx_resolution;
	u32			tx_resolution;

	void			*priv;
	int			(*change_protocol)(void *priv, u64 ir_type);
	int			(*open)(void *priv);
	void			(*close)(void *priv);
	int			(*s_tx_mask)(void *priv, u32 mask);
	int			(*s_tx_carrier)(void *priv, u32 carrier);
	int			(*s_tx_duty_cycle)(void *priv, u32 duty_cycle);
	int			(*s_rx_carrier_range)(void *priv, u32 min, u32 max);
	int			(*tx_ir)(void *priv, int *txbuf, u32 n);
	void			(*s_idle)(void *priv, bool enable);
	int			(*s_learning_mode)(void *priv, int enable);
	int			(*s_carrier_report) (void *priv, int enable);
};

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 */
	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 */
	bool				idle;

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

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

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

/* From ir-keytable.c */
int __ir_input_register(struct input_dev *dev,
		      const struct ir_scancode_table *ir_codes,
		      struct ir_dev_props *props,
		      const char *driver_name);

static inline int ir_input_register(struct input_dev *dev,
		      const char *map_name,
		      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) {
		ir_codes = get_rc_map(RC_MAP_EMPTY);

		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);

void ir_repeat(struct input_dev *dev);
void ir_keydown(struct input_dev *dev, int scancode, u8 toggle);
void ir_keyup(struct ir_input_dev *ir);
u32 ir_g_keycode_from_table(struct input_dev *input_dev, u32 scancode);

/* From ir-raw-event.c */

struct ir_raw_event {
	union {
		u32             duration;

		struct {
			u32     carrier;
			u8      duty_cycle;
		};
	};

	unsigned                pulse:1;
	unsigned                reset:1;
	unsigned                timeout:1;
	unsigned                carrier_report:1;
};

#define DEFINE_IR_RAW_EVENT(event) \
	struct ir_raw_event event = { \
		{ .duration = 0 } , \
		.pulse = 0, \
		.reset = 0, \
		.timeout = 0, \
		.carrier_report = 0 }

static inline void init_ir_raw_event(struct ir_raw_event *ev)
{
	memset(ev, 0, sizeof(*ev));
}

#define IR_MAX_DURATION         0xFFFFFFFF      /* a bit more than 4 seconds */

void ir_raw_event_handle(struct input_dev *input_dev);
int ir_raw_event_store(struct input_dev *input_dev, struct ir_raw_event *ev);
int ir_raw_event_store_edge(struct input_dev *input_dev, enum raw_event_type type);
int ir_raw_event_store_with_filter(struct input_dev *input_dev,
				struct ir_raw_event *ev);
void ir_raw_event_set_idle(struct input_dev *input_dev, bool idle);

static inline void ir_raw_event_reset(struct input_dev *input_dev)
{
	DEFINE_IR_RAW_EVENT(ev);
	ev.reset = true;

	ir_raw_event_store(input_dev, &ev);
	ir_raw_event_handle(input_dev);
}

#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
9dfe4e83 MCC	34	/**
9dfe4e83 MCC	35	* struct ir_dev_props - Allow caller drivers to set special properties
626cf697 MCC	36	* @driver_type: specifies if the driver or hardware have already a decoder,
626cf697 MCC	37	* or if it needs to use the IR raw event decoders to produce a scancode
9dfe4e83 MCC	38	* @allowed_protos: bitmask with the supported IR_TYPE_* protocols
	39	* @scanmask: some hardware decoders are not capable of providing the full
	40	* scancode to the application. As this is a hardware limit, we can't do
	41	* anything with it. Yet, as the same keycode table can be used with other
	42	* devices, a mask is provided to allow its usage. Drivers should generally
	43	* leave this field in blank
4a702ebf ML	44	* @timeout: optional time after which device stops sending data
	45	* @min_timeout: minimum timeout supported by device
	46	* @max_timeout: maximum timeout supported by device
e589333f ML	47	* @rx_resolution : resolution (in ns) of input sampler
e589333f ML	48	* @tx_resolution: resolution (in ns) of output sampler
9dfe4e83 MCC	49	* @priv: driver-specific data, to be used on the callbacks
	50	* @change_protocol: allow changing the protocol used on hardware decoders
	51	* @open: callback to allow drivers to enable polling/irq when IR input device
	52	* is opened.
	53	* @close: callback to allow drivers to disable polling/irq when IR input device
	54	* is opened.
9b7c54d9 JW	55	* @s_tx_mask: set transmitter mask (for devices with multiple tx outputs)
9b7c54d9 JW	56	* @s_tx_carrier: set transmit carrier frequency
e589333f ML	57	* @s_tx_duty_cycle: set transmit duty cycle (0% - 100%)
e589333f ML	58	* @s_rx_carrier: inform driver about carrier it is expected to handle
9b7c54d9	59	* @tx_ir: transmit IR
4a702ebf	60	* @s_idle: optional: enable/disable hardware idle mode, upon which,
e589333f ML	61	device doesn't interrupt host until it sees IR pulses
e589333f ML	62	* @s_learning_mode: enable wide band receiver used for learning
4651918a	63	* @s_carrier_report: enable carrier reports
9dfe4e83	64	*/
e93854da	65	struct ir_dev_props {
626cf697 MCC	66	enum rc_driver_type driver_type;
	67	unsigned long allowed_protos;
	68	u32 scanmask;
4a702ebf ML	69
	70	u32 timeout;
	71	u32 min_timeout;
	72	u32 max_timeout;
	73
e589333f ML	74	u32 rx_resolution;
e589333f ML	75	u32 tx_resolution;
4a702ebf	76
9b7c54d9	77	void *priv;
626cf697 MCC	78	int (change_protocol)(void priv, u64 ir_type);
	79	int (open)(void priv);
	80	void (close)(void priv);
9b7c54d9 JW	81	int (s_tx_mask)(void priv, u32 mask);
9b7c54d9 JW	82	int (s_tx_carrier)(void priv, u32 carrier);
e589333f ML	83	int (s_tx_duty_cycle)(void priv, u32 duty_cycle);
e589333f ML	84	int (s_rx_carrier_range)(void priv, u32 min, u32 max);
30eb1be7	85	int (tx_ir)(void priv, int *txbuf, u32 n);
4651918a	86	void (s_idle)(void priv, bool enable);
e589333f	87	int (s_learning_mode)(void priv, int enable);
4651918a	88	int (s_carrier_report) (void priv, int enable);
e93854da MCC	89	};
e93854da MCC	90
75543cce	91	struct ir_input_dev {
945cdfa2	92	struct device dev; /* device */
727e625c	93	char driver_name; / Name of the driver module */
4714eda8 MCC	94	struct ir_scancode_table rc_tab; /* scan/key table */
4714eda8 MCC	95	unsigned long devno; /* device number */
4a702ebf	96	struct ir_dev_props props; / Device properties */
a3572c34	97	struct ir_raw_event_ctrl raw; / for raw pulse/space events */
a374fef4	98	struct input_dev input_dev; / the input device associated with this device */
4a702ebf	99	bool idle;
6660de56 MCC	100
6660de56 MCC	101	/* key info - needed by IR keycode handlers */
a374fef4 DH	102	spinlock_t keylock; /* protects the below members */
	103	bool keypressed; /* current state */
	104	unsigned long keyup_jiffies; /* when should the current keypress be released? */
	105	struct timer_list timer_keyup; /* timer for releasing a keypress */
	106	u32 last_keycode; /* keycode of last command */
	107	u32 last_scancode; /* scancode of last command */
	108	u8 last_toggle; /* toggle of last command */
75543cce	109	};
a3572c34	110
3f113e36 MCC	111	enum raw_event_type {
	112	IR_SPACE = (1 << 0),
	113	IR_PULSE = (1 << 1),
	114	IR_START_EVENT = (1 << 2),
	115	IR_STOP_EVENT = (1 << 3),
995187be MCC	116	};
995187be MCC	117
53f87022	118	#define to_ir_input_dev(_attr) container_of(_attr, struct ir_input_dev, attr)
75543cce	119
3f113e36	120	/* From ir-keytable.c */
b2245ba1	121	int __ir_input_register(struct input_dev *dev,
e93854da	122	const struct ir_scancode_table *ir_codes,
4a702ebf	123	struct ir_dev_props *props,
727e625c	124	const char *driver_name);
446e4a64	125
b2245ba1 MCC	126	static inline int ir_input_register(struct input_dev *dev,
b2245ba1 MCC	127	const char *map_name,
4a702ebf	128	struct ir_dev_props *props,
b2245ba1 MCC	129	const char *driver_name) {
b2245ba1 MCC	130	struct ir_scancode_table *ir_codes;
02858eed MCC	131	struct ir_input_dev *ir_dev;
	132	int rc;
	133
	134	if (!map_name)
	135	return -EINVAL;
9ce50c1a	136
b2245ba1	137	ir_codes = get_rc_map(map_name);
b378f43f ML	138	if (!ir_codes) {
	139	ir_codes = get_rc_map(RC_MAP_EMPTY);
	140
	141	if (!ir_codes)
	142	return -EINVAL;
	143	}
b2245ba1	144
02858eed MCC	145	rc = __ir_input_register(dev, ir_codes, props, driver_name);
	146	if (rc < 0)
	147	return -EINVAL;
	148
	149	ir_dev = input_get_drvdata(dev);
	150
	151	if (!rc && ir_dev->props && ir_dev->props->change_protocol)
	152	rc = ir_dev->props->change_protocol(ir_dev->props->priv,
	153	ir_codes->ir_type);
	154
	155	return rc;
b2245ba1 MCC	156	}
b2245ba1 MCC	157
02858eed	158	void ir_input_unregister(struct input_dev *input_dev);
9ce50c1a	159
3f113e36 MCC	160	void ir_repeat(struct input_dev *dev);
3f113e36 MCC	161	void ir_keydown(struct input_dev *dev, int scancode, u8 toggle);
ee089405	162	void ir_keyup(struct ir_input_dev *ir);
1c0e0ee5	163	u32 ir_g_keycode_from_table(struct input_dev *input_dev, u32 scancode);
4714eda8	164
3f113e36	165	/* From ir-raw-event.c */
4714eda8	166
e40b1127	167	struct ir_raw_event {
4651918a ML	168	union {
	169	u32 duration;
	170
	171	struct {
	172	u32 carrier;
	173	u8 duty_cycle;
	174	};
	175	};
	176
	177	unsigned pulse:1;
	178	unsigned reset:1;
	179	unsigned timeout:1;
	180	unsigned carrier_report:1;
e40b1127 DH	181	};
e40b1127 DH	182
4651918a ML	183	#define DEFINE_IR_RAW_EVENT(event) \
	184	struct ir_raw_event event = { \
	185	{ .duration = 0 } , \
	186	.pulse = 0, \
	187	.reset = 0, \
	188	.timeout = 0, \
	189	.carrier_report = 0 }
	190
	191	static inline void init_ir_raw_event(struct ir_raw_event *ev)
	192	{
	193	memset(ev, 0, sizeof(*ev));
	194	}
	195
	196	#define IR_MAX_DURATION 0xFFFFFFFF /* a bit more than 4 seconds */
e40b1127	197
724e2495	198	void ir_raw_event_handle(struct input_dev *input_dev);
e40b1127	199	int ir_raw_event_store(struct input_dev input_dev, struct ir_raw_event ev);
724e2495	200	int ir_raw_event_store_edge(struct input_dev *input_dev, enum raw_event_type type);
4a702ebf ML	201	int ir_raw_event_store_with_filter(struct input_dev *input_dev,
4a702ebf ML	202	struct ir_raw_event *ev);
4651918a	203	void ir_raw_event_set_idle(struct input_dev *input_dev, bool idle);
4a702ebf	204
e40b1127 DH	205	static inline void ir_raw_event_reset(struct input_dev *input_dev)
e40b1127 DH	206	{
4651918a ML	207	DEFINE_IR_RAW_EVENT(ev);
	208	ev.reset = true;
	209
e40b1127 DH	210	ir_raw_event_store(input_dev, &ev);
	211	ir_raw_event_handle(input_dev);
	212	}
724e2495	213
995187be	214	#endif /* _IR_CORE */