[deliverable/linux.git] / include / media / rc-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 _RC_CORE
#define _RC_CORE

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

extern int rc_core_debug;
#define IR_dprintk(level, fmt, ...)				\
do {								\
	if (rc_core_debug >= level)				\
		pr_debug("%s: " fmt, __func__, ##__VA_ARGS__);	\
} while (0)

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 rc_scancode_filter - Filter scan codes.
 * @data:	Scancode data to match.
 * @mask:	Mask of bits of scancode to compare.
 */
struct rc_scancode_filter {
	u32 data;
	u32 mask;
};

/**
 * enum rc_filter_type - Filter type constants.
 * @RC_FILTER_NORMAL:	Filter for normal operation.
 * @RC_FILTER_WAKEUP:	Filter for waking from suspend.
 * @RC_FILTER_MAX:	Number of filter types.
 */
enum rc_filter_type {
	RC_FILTER_NORMAL = 0,
	RC_FILTER_WAKEUP,

	RC_FILTER_MAX
};

/**
 * struct rc_dev - represents a remote control device
 * @dev: driver model's view of this device
 * @input_name: name of the input child device
 * @input_phys: physical path to the input child device
 * @input_id: id of the input child device (struct input_id)
 * @driver_name: name of the hardware driver which registered this device
 * @map_name: name of the default keymap
 * @rc_map: current scan/key table
 * @lock: used to ensure we've filled in all protocol details before
 *	anyone can call show_protocols or store_protocols
 * @devno: unique remote control device number
 * @raw: additional data for raw pulse/space devices
 * @input_dev: the input child device used to communicate events to userspace
 * @driver_type: specifies if protocol decoding is done in hardware or software
 * @idle: used to keep track of RX state
 * @allowed_protos: bitmask with the supported RC_BIT_* protocols
 * @enabled_protocols: bitmask with the enabled RC_BIT_* 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
 * @keylock: protects the remaining members of the struct
 * @keypressed: whether a key is currently pressed
 * @keyup_jiffies: time (in jiffies) when the current keypress should be released
 * @timer_keyup: timer for releasing a keypress
 * @last_keycode: keycode of last keypress
 * @last_scancode: scancode of last keypress
 * @last_toggle: toggle value of last command
 * @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
 * @scancode_filters: scancode filters (indexed by enum rc_filter_type)
 * @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: 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
 * @s_filter: set the scancode filter of a given type
 */
struct rc_dev {
	struct device			dev;
	const char			*input_name;
	const char			*input_phys;
	struct input_id			input_id;
	char				*driver_name;
	const char			*map_name;
	struct rc_map			rc_map;
	struct mutex			lock;
	unsigned long			devno;
	struct ir_raw_event_ctrl	*raw;
	struct input_dev		*input_dev;
	enum rc_driver_type		driver_type;
	bool				idle;
	u64				allowed_protos;
	u64				enabled_protocols;
	u32				users;
	u32				scanmask;
	void				*priv;
	spinlock_t			keylock;
	bool				keypressed;
	unsigned long			keyup_jiffies;
	struct timer_list		timer_keyup;
	u32				last_keycode;
	u32				last_scancode;
	u8				last_toggle;
	u32				timeout;
	u32				min_timeout;
	u32				max_timeout;
	u32				rx_resolution;
	u32				tx_resolution;
	struct rc_scancode_filter	scancode_filters[RC_FILTER_MAX];
	int				(*change_protocol)(struct rc_dev *dev, u64 *rc_type);
	int				(*open)(struct rc_dev *dev);
	void				(*close)(struct rc_dev *dev);
	int				(*s_tx_mask)(struct rc_dev *dev, u32 mask);
	int				(*s_tx_carrier)(struct rc_dev *dev, u32 carrier);
	int				(*s_tx_duty_cycle)(struct rc_dev *dev, u32 duty_cycle);
	int				(*s_rx_carrier_range)(struct rc_dev *dev, u32 min, u32 max);
	int				(*tx_ir)(struct rc_dev *dev, unsigned *txbuf, unsigned n);
	void				(*s_idle)(struct rc_dev *dev, bool enable);
	int				(*s_learning_mode)(struct rc_dev *dev, int enable);
	int				(*s_carrier_report) (struct rc_dev *dev, int enable);
	int				(*s_filter)(struct rc_dev *dev,
						    enum rc_filter_type type,
						    struct rc_scancode_filter *filter);
};

#define to_rc_dev(d) container_of(d, struct rc_dev, dev)

/*
 * From rc-main.c
 * Those functions can be used on any type of Remote Controller. They
 * basically creates an input_dev and properly reports the device as a
 * Remote Controller, at sys/class/rc.
 */

struct rc_dev *rc_allocate_device(void);
void rc_free_device(struct rc_dev *dev);
int rc_register_device(struct rc_dev *dev);
void rc_unregister_device(struct rc_dev *dev);

int rc_open(struct rc_dev *rdev);
void rc_close(struct rc_dev *rdev);

void rc_repeat(struct rc_dev *dev);
void rc_keydown(struct rc_dev *dev, int scancode, u8 toggle);
void rc_keydown_notimeout(struct rc_dev *dev, int scancode, u8 toggle);
void rc_keyup(struct rc_dev *dev);
u32 rc_g_keycode_from_table(struct rc_dev *dev, u32 scancode);

/*
 * From rc-raw.c
 * The Raw interface is specific to InfraRed. It may be a good idea to
 * split it later into a separate header.
 */

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

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 */
#define US_TO_NS(usec)		((usec) * 1000)
#define MS_TO_US(msec)		((msec) * 1000)
#define MS_TO_NS(msec)		((msec) * 1000 * 1000)

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

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

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

/* extract mask bits out of data and pack them into the result */
static inline u32 ir_extract_bits(u32 data, u32 mask)
{
	u32 vbit = 1, value = 0;

	do {
		if (mask & 1) {
			if (data & 1)
				value |= vbit;
			vbit <<= 1;
		}
		data >>= 1;
	} while (mask >>= 1);

	return value;
}

#endif /* _RC_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
ca86674b MCC	16	#ifndef _RC_CORE
ca86674b MCC	17	#define _RC_CORE
446e4a64	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	24
6bda9644	25	extern int rc_core_debug;
86b0dbef JP	26	#define IR_dprintk(level, fmt, ...) \
	27	do { \
	28	if (rc_core_debug >= level) \
	29	pr_debug("%s: " fmt, __func__, ##__VA_ARGS__); \
	30	} while (0)
446e4a64	31
626cf697 MCC	32	enum rc_driver_type {
	33	RC_DRIVER_SCANCODE = 0, /* Driver or hardware generates a scancode */
	34	RC_DRIVER_IR_RAW, /* Needs a Infra-Red pulse/space decoder */
	35	};
	36
00942d1a JH	37	/**
	38	* struct rc_scancode_filter - Filter scan codes.
	39	* @data: Scancode data to match.
	40	* @mask: Mask of bits of scancode to compare.
	41	*/
	42	struct rc_scancode_filter {
	43	u32 data;
	44	u32 mask;
	45	};
	46
	47	/**
	48	* enum rc_filter_type - Filter type constants.
	49	* @RC_FILTER_NORMAL: Filter for normal operation.
	50	* @RC_FILTER_WAKEUP: Filter for waking from suspend.
	51	* @RC_FILTER_MAX: Number of filter types.
	52	*/
	53	enum rc_filter_type {
	54	RC_FILTER_NORMAL = 0,
	55	RC_FILTER_WAKEUP,
	56
	57	RC_FILTER_MAX
	58	};
	59
9dfe4e83	60	/**
d8b4b582 DH	61	* struct rc_dev - represents a remote control device
	62	* @dev: driver model's view of this device
	63	* @input_name: name of the input child device
	64	* @input_phys: physical path to the input child device
	65	* @input_id: id of the input child device (struct input_id)
	66	* @driver_name: name of the hardware driver which registered this device
	67	* @map_name: name of the default keymap
b088ba65	68	* @rc_map: current scan/key table
08aeb7c9 JW	69	* @lock: used to ensure we've filled in all protocol details before
08aeb7c9 JW	70	* anyone can call show_protocols or store_protocols
d8b4b582 DH	71	* @devno: unique remote control device number
	72	* @raw: additional data for raw pulse/space devices
	73	* @input_dev: the input child device used to communicate events to userspace
08aeb7c9	74	* @driver_type: specifies if protocol decoding is done in hardware or software
d8b4b582	75	* @idle: used to keep track of RX state
c003ab1b	76	* @allowed_protos: bitmask with the supported RC_BIT_* protocols
9719afae	77	* @enabled_protocols: bitmask with the enabled RC_BIT_* protocols
9dfe4e83 MCC	78	* @scanmask: some hardware decoders are not capable of providing the full
	79	* scancode to the application. As this is a hardware limit, we can't do
	80	* anything with it. Yet, as the same keycode table can be used with other
	81	* devices, a mask is provided to allow its usage. Drivers should generally
	82	* leave this field in blank
d8b4b582 DH	83	* @priv: driver-specific data
	84	* @keylock: protects the remaining members of the struct
	85	* @keypressed: whether a key is currently pressed
	86	* @keyup_jiffies: time (in jiffies) when the current keypress should be released
	87	* @timer_keyup: timer for releasing a keypress
	88	* @last_keycode: keycode of last keypress
	89	* @last_scancode: scancode of last keypress
	90	* @last_toggle: toggle value of last command
4a702ebf ML	91	* @timeout: optional time after which device stops sending data
	92	* @min_timeout: minimum timeout supported by device
	93	* @max_timeout: maximum timeout supported by device
e589333f ML	94	* @rx_resolution : resolution (in ns) of input sampler
e589333f ML	95	* @tx_resolution: resolution (in ns) of output sampler
00942d1a	96	* @scancode_filters: scancode filters (indexed by enum rc_filter_type)
9dfe4e83 MCC	97	* @change_protocol: allow changing the protocol used on hardware decoders
	98	* @open: callback to allow drivers to enable polling/irq when IR input device
	99	* is opened.
	100	* @close: callback to allow drivers to disable polling/irq when IR input device
	101	* is opened.
9b7c54d9 JW	102	* @s_tx_mask: set transmitter mask (for devices with multiple tx outputs)
9b7c54d9 JW	103	* @s_tx_carrier: set transmit carrier frequency
e589333f ML	104	* @s_tx_duty_cycle: set transmit duty cycle (0% - 100%)
e589333f ML	105	* @s_rx_carrier: inform driver about carrier it is expected to handle
9b7c54d9	106	* @tx_ir: transmit IR
d8b4b582 DH	107	* @s_idle: enable/disable hardware idle mode, upon which,
d8b4b582 DH	108	* device doesn't interrupt host until it sees IR pulses
e589333f	109	* @s_learning_mode: enable wide band receiver used for learning
4651918a	110	* @s_carrier_report: enable carrier reports
00942d1a	111	* @s_filter: set the scancode filter of a given type
9dfe4e83	112	*/
d8b4b582 DH	113	struct rc_dev {
	114	struct device dev;
	115	const char *input_name;
	116	const char *input_phys;
	117	struct input_id input_id;
	118	char *driver_name;
	119	const char *map_name;
08aeb7c9 JW	120	struct rc_map rc_map;
08aeb7c9 JW	121	struct mutex lock;
d8b4b582 DH	122	unsigned long devno;
	123	struct ir_raw_event_ctrl *raw;
	124	struct input_dev *input_dev;
	125	enum rc_driver_type driver_type;
4a702ebf	126	bool idle;
d8b4b582	127	u64 allowed_protos;
9719afae	128	u64 enabled_protocols;
8b2ff320	129	u32 users;
d8b4b582 DH	130	u32 scanmask;
	131	void *priv;
	132	spinlock_t keylock;
	133	bool keypressed;
	134	unsigned long keyup_jiffies;
	135	struct timer_list timer_keyup;
	136	u32 last_keycode;
	137	u32 last_scancode;
	138	u8 last_toggle;
	139	u32 timeout;
	140	u32 min_timeout;
	141	u32 max_timeout;
	142	u32 rx_resolution;
	143	u32 tx_resolution;
00942d1a	144	struct rc_scancode_filter scancode_filters[RC_FILTER_MAX];
c003ab1b	145	int (change_protocol)(struct rc_dev dev, u64 *rc_type);
d8b4b582 DH	146	int (open)(struct rc_dev dev);
	147	void (close)(struct rc_dev dev);
	148	int (s_tx_mask)(struct rc_dev dev, u32 mask);
	149	int (s_tx_carrier)(struct rc_dev dev, u32 carrier);
	150	int (s_tx_duty_cycle)(struct rc_dev dev, u32 duty_cycle);
	151	int (s_rx_carrier_range)(struct rc_dev dev, u32 min, u32 max);
5588dc2b	152	int (tx_ir)(struct rc_dev dev, unsigned *txbuf, unsigned n);
d8b4b582 DH	153	void (s_idle)(struct rc_dev dev, bool enable);
	154	int (s_learning_mode)(struct rc_dev dev, int enable);
	155	int (s_carrier_report) (struct rc_dev dev, int enable);
00942d1a JH	156	int (s_filter)(struct rc_dev dev,
	157	enum rc_filter_type type,
	158	struct rc_scancode_filter *filter);
75543cce	159	};
a3572c34	160
ca86674b MCC	161	#define to_rc_dev(d) container_of(d, struct rc_dev, dev)
	162
	163	/*
	164	* From rc-main.c
	165	* Those functions can be used on any type of Remote Controller. They
	166	* basically creates an input_dev and properly reports the device as a
	167	* Remote Controller, at sys/class/rc.
	168	*/
	169
	170	struct rc_dev *rc_allocate_device(void);
	171	void rc_free_device(struct rc_dev *dev);
	172	int rc_register_device(struct rc_dev *dev);
	173	void rc_unregister_device(struct rc_dev *dev);
	174
8b2ff320 SK	175	int rc_open(struct rc_dev *rdev);
	176	void rc_close(struct rc_dev *rdev);
	177
ca86674b MCC	178	void rc_repeat(struct rc_dev *dev);
	179	void rc_keydown(struct rc_dev *dev, int scancode, u8 toggle);
	180	void rc_keydown_notimeout(struct rc_dev *dev, int scancode, u8 toggle);
	181	void rc_keyup(struct rc_dev *dev);
	182	u32 rc_g_keycode_from_table(struct rc_dev *dev, u32 scancode);
	183
	184	/*
	185	* From rc-raw.c
	186	* The Raw interface is specific to InfraRed. It may be a good idea to
	187	* split it later into a separate header.
	188	*/
	189
3f113e36 MCC	190	enum raw_event_type {
	191	IR_SPACE = (1 << 0),
	192	IR_PULSE = (1 << 1),
	193	IR_START_EVENT = (1 << 2),
	194	IR_STOP_EVENT = (1 << 3),
995187be MCC	195	};
995187be MCC	196
e40b1127	197	struct ir_raw_event {
4651918a ML	198	union {
	199	u32 duration;
	200
	201	struct {
	202	u32 carrier;
	203	u8 duty_cycle;
	204	};
	205	};
	206
	207	unsigned pulse:1;
	208	unsigned reset:1;
	209	unsigned timeout:1;
	210	unsigned carrier_report:1;
e40b1127 DH	211	};
e40b1127 DH	212
4651918a ML	213	#define DEFINE_IR_RAW_EVENT(event) \
	214	struct ir_raw_event event = { \
	215	{ .duration = 0 } , \
	216	.pulse = 0, \
	217	.reset = 0, \
	218	.timeout = 0, \
	219	.carrier_report = 0 }
	220
	221	static inline void init_ir_raw_event(struct ir_raw_event *ev)
	222	{
	223	memset(ev, 0, sizeof(*ev));
	224	}
	225
	226	#define IR_MAX_DURATION 0xFFFFFFFF /* a bit more than 4 seconds */
5aad7242 JW	227	#define US_TO_NS(usec) ((usec) * 1000)
	228	#define MS_TO_US(msec) ((msec) * 1000)
	229	#define MS_TO_NS(msec) ((msec) * 1000 * 1000)
e40b1127	230
d8b4b582 DH	231	void ir_raw_event_handle(struct rc_dev *dev);
	232	int ir_raw_event_store(struct rc_dev dev, struct ir_raw_event ev);
	233	int ir_raw_event_store_edge(struct rc_dev *dev, enum raw_event_type type);
	234	int ir_raw_event_store_with_filter(struct rc_dev *dev,
4a702ebf	235	struct ir_raw_event *ev);
d8b4b582	236	void ir_raw_event_set_idle(struct rc_dev *dev, bool idle);
4a702ebf	237
d8b4b582	238	static inline void ir_raw_event_reset(struct rc_dev *dev)
e40b1127	239	{
4651918a ML	240	DEFINE_IR_RAW_EVENT(ev);
	241	ev.reset = true;
	242
d8b4b582 DH	243	ir_raw_event_store(dev, &ev);
d8b4b582 DH	244	ir_raw_event_handle(dev);
e40b1127	245	}
724e2495	246
3ffea498 DH	247	/* extract mask bits out of data and pack them into the result */
	248	static inline u32 ir_extract_bits(u32 data, u32 mask)
	249	{
	250	u32 vbit = 1, value = 0;
	251
	252	do {
829ba9fe DH	253	if (mask & 1) {
	254	if (data & 1)
	255	value \|= vbit;
	256	vbit <<= 1;
	257	}
	258	data >>= 1;
3ffea498 DH	259	} while (mask >>= 1);
	260
	261	return value;
	262	}
	263
ca86674b	264	#endif /* _RC_CORE */