[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 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
 * @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 {
	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 {
	struct timespec		delta;	/* Time spent before event */
	enum raw_event_type	type;	/* event type */
};

struct ir_raw_event_ctrl {
	struct kfifo			kfifo;		/* fifo for the pulse/space events */
	struct timespec			last_event;	/* when last event occurred */
};

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,
		      struct ir_raw_event *ev);
	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);
int ir_raw_event_store(struct input_dev *input_dev, enum raw_event_type type);
int ir_raw_event_handle(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);

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

#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
a3572c34 MCC	29	enum raw_event_type {
	30	IR_SPACE = (1 << 0),
	31	IR_PULSE = (1 << 1),
	32	IR_START_EVENT = (1 << 2),
	33	IR_STOP_EVENT = (1 << 3),
	34	};
	35
9dfe4e83 MCC	36	/**
	37	* struct ir_dev_props - Allow caller drivers to set special properties
	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
	44	* @priv: driver-specific data, to be used on the callbacks
	45	* @change_protocol: allow changing the protocol used on hardware decoders
	46	* @open: callback to allow drivers to enable polling/irq when IR input device
	47	* is opened.
	48	* @close: callback to allow drivers to disable polling/irq when IR input device
	49	* is opened.
	50	*/
e93854da	51	struct ir_dev_props {
9dfe4e83 MCC	52	unsigned long allowed_protos;
9dfe4e83 MCC	53	u32 scanmask;
e93854da	54	void *priv;
9dfe4e83 MCC	55	int (change_protocol)(void priv, u64 ir_type);
	56	int (open)(void priv);
	57	void (close)(void priv);
e93854da MCC	58	};
e93854da MCC	59
a3572c34 MCC	60	struct ir_raw_event {
	61	struct timespec delta; /* Time spent before event */
	62	enum raw_event_type type; /* event type */
	63	};
	64
	65	struct ir_raw_event_ctrl {
	66	struct kfifo kfifo; /* fifo for the pulse/space events */
	67	struct timespec last_event; /* when last event occurred */
	68	};
53f87022	69
75543cce	70	struct ir_input_dev {
945cdfa2	71	struct device dev; /* device */
727e625c	72	char driver_name; / Name of the driver module */
4714eda8 MCC	73	struct ir_scancode_table rc_tab; /* scan/key table */
4714eda8 MCC	74	unsigned long devno; /* device number */
e93854da	75	const struct ir_dev_props props; / Device properties */
a3572c34	76	struct ir_raw_event_ctrl raw; / for raw pulse/space events */
a374fef4	77	struct input_dev input_dev; / the input device associated with this device */
6660de56 MCC	78
6660de56 MCC	79	/* key info - needed by IR keycode handlers */
a374fef4 DH	80	spinlock_t keylock; /* protects the below members */
	81	bool keypressed; /* current state */
	82	unsigned long keyup_jiffies; /* when should the current keypress be released? */
	83	struct timer_list timer_keyup; /* timer for releasing a keypress */
	84	u32 last_keycode; /* keycode of last command */
	85	u32 last_scancode; /* scancode of last command */
	86	u8 last_toggle; /* toggle of last command */
75543cce	87	};
a3572c34	88
995187be MCC	89	struct ir_raw_handler {
	90	struct list_head list;
	91
	92	int (decode)(struct input_dev input_dev,
587835a4	93	struct ir_raw_event *ev);
93c312ff MCC	94	int (raw_register)(struct input_dev input_dev);
93c312ff MCC	95	int (raw_unregister)(struct input_dev input_dev);
995187be MCC	96	};
995187be MCC	97
53f87022	98	#define to_ir_input_dev(_attr) container_of(_attr, struct ir_input_dev, attr)
75543cce	99
446e4a64 MCC	100	/* Routines from ir-keytable.c */
	101
	102	u32 ir_g_keycode_from_table(struct input_dev *input_dev,
	103	u32 scancode);
a374fef4 DH	104	void ir_repeat(struct input_dev *dev);
a374fef4 DH	105	void ir_keydown(struct input_dev *dev, int scancode, u8 toggle);
b2245ba1	106	int __ir_input_register(struct input_dev *dev,
e93854da	107	const struct ir_scancode_table *ir_codes,
727e625c MCC	108	const struct ir_dev_props *props,
727e625c MCC	109	const char *driver_name);
446e4a64	110
b2245ba1 MCC	111	static inline int ir_input_register(struct input_dev *dev,
	112	const char *map_name,
	113	const struct ir_dev_props *props,
	114	const char *driver_name) {
	115	struct ir_scancode_table *ir_codes;
02858eed MCC	116	struct ir_input_dev *ir_dev;
	117	int rc;
	118
	119	if (!map_name)
	120	return -EINVAL;
9ce50c1a	121
b2245ba1 MCC	122	ir_codes = get_rc_map(map_name);
	123	if (!ir_codes)
	124	return -EINVAL;
	125
02858eed MCC	126	rc = __ir_input_register(dev, ir_codes, props, driver_name);
	127	if (rc < 0)
	128	return -EINVAL;
	129
	130	ir_dev = input_get_drvdata(dev);
	131
	132	if (!rc && ir_dev->props && ir_dev->props->change_protocol)
	133	rc = ir_dev->props->change_protocol(ir_dev->props->priv,
	134	ir_codes->ir_type);
	135
	136	return rc;
b2245ba1 MCC	137	}
b2245ba1 MCC	138
02858eed	139	void ir_input_unregister(struct input_dev *input_dev);
9ce50c1a	140
4714eda8 MCC	141	/* Routines from ir-sysfs.c */
	142
	143	int ir_register_class(struct input_dev *input_dev);
	144	void ir_unregister_class(struct input_dev *input_dev);
	145
a3572c34 MCC	146	/* Routines from ir-raw-event.c */
	147	int ir_raw_event_register(struct input_dev *input_dev);
	148	void ir_raw_event_unregister(struct input_dev *input_dev);
	149	int ir_raw_event_store(struct input_dev *input_dev, enum raw_event_type type);
	150	int ir_raw_event_handle(struct input_dev *input_dev);
995187be MCC	151	int ir_raw_handler_register(struct ir_raw_handler *ir_raw_handler);
995187be MCC	152	void ir_raw_handler_unregister(struct ir_raw_handler *ir_raw_handler);
995187be	153	void ir_raw_init(void);
a3572c34	154
995187be MCC	155	/* from ir-nec-decoder.c */
	156	#ifdef CONFIG_IR_NEC_DECODER_MODULE
	157	#define load_nec_decode() request_module("ir-nec-decoder")
	158	#else
	159	#define load_nec_decode() 0
446e4a64	160	#endif
995187be	161
db1423a6 MCC	162	/* from ir-rc5-decoder.c */
	163	#ifdef CONFIG_IR_RC5_DECODER_MODULE
	164	#define load_rc5_decode() request_module("ir-rc5-decoder")
	165	#else
	166	#define load_rc5_decode() 0
	167	#endif
	168
995187be	169	#endif /* _IR_CORE */