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