[linux-2.6-block.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/input.h>
#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)

#define IR_TYPE_UNKNOWN	0
#define IR_TYPE_RC5	(1  << 0)	/* Philips RC5 protocol */
#define IR_TYPE_PD	(1  << 1)	/* Pulse distance encoded IR */
#define IR_TYPE_NEC	(1  << 2)
#define IR_TYPE_OTHER	(((u64)1) << 63l)

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

struct ir_scancode {
	u16	scancode;
	u32	keycode;
};

struct ir_scancode_table {
	struct ir_scancode	*scan;
	unsigned int		size;	/* Max number of entries */
	unsigned int		len;	/* Used number of entries */
	unsigned int		alloc;	/* Size of *scan in bytes */
	u64			ir_type;
	char			*name;
	spinlock_t		lock;
};

struct rc_keymap {
	struct list_head	 list;
	struct ir_scancode_table map;
};

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 *evs,
		      int len);
	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 rc-map.c */

int ir_register_map(struct rc_keymap *map);
void ir_unregister_map(struct rc_keymap *map);
struct ir_scancode_table *get_rc_map(const char *name);
void rc_map_init(void);

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

#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
	19	#include <linux/input.h>
	20	#include <linux/spinlock.h>
a3572c34 MCC	21	#include <linux/kfifo.h>
a3572c34 MCC	22	#include <linux/time.h>
9f154782	23	#include <linux/timer.h>
02858eed	24	#include <media/rc-map.h>
446e4a64 MCC	25
	26	extern int ir_core_debug;
	27	#define IR_dprintk(level, fmt, arg...) if (ir_core_debug >= level) \
	28	printk(KERN_DEBUG "%s: " fmt , __func__, ## arg)
	29
971e8298 MCC	30	#define IR_TYPE_UNKNOWN 0
	31	#define IR_TYPE_RC5 (1 << 0) /* Philips RC5 protocol */
	32	#define IR_TYPE_PD (1 << 1) /* Pulse distance encoded IR */
	33	#define IR_TYPE_NEC (1 << 2)
	34	#define IR_TYPE_OTHER (((u64)1) << 63l)
446e4a64	35
a3572c34 MCC	36	enum raw_event_type {
	37	IR_SPACE = (1 << 0),
	38	IR_PULSE = (1 << 1),
	39	IR_START_EVENT = (1 << 2),
	40	IR_STOP_EVENT = (1 << 3),
	41	};
	42
446e4a64 MCC	43	struct ir_scancode {
	44	u16 scancode;
	45	u32 keycode;
	46	};
	47
	48	struct ir_scancode_table {
	49	struct ir_scancode *scan;
b3074c0a DH	50	unsigned int size; /* Max number of entries */
	51	unsigned int len; /* Used number of entries */
	52	unsigned int alloc; /* Size of scan in bytes /
2915e5ef MCC	53	u64 ir_type;
2915e5ef MCC	54	char *name;
446e4a64 MCC	55	spinlock_t lock;
	56	};
	57
9ce50c1a MCC	58	struct rc_keymap {
	59	struct list_head list;
	60	struct ir_scancode_table map;
	61	};
	62
e93854da MCC	63	struct ir_dev_props {
	64	unsigned long allowed_protos;
	65	void *priv;
971e8298	66	int (change_protocol)(void priv, u64 ir_type);
716aab44 MCC	67	int (open)(void priv);
716aab44 MCC	68	void (close)(void priv);
e93854da MCC	69	};
e93854da MCC	70
a3572c34 MCC	71	struct ir_raw_event {
	72	struct timespec delta; /* Time spent before event */
	73	enum raw_event_type type; /* event type */
	74	};
	75
	76	struct ir_raw_event_ctrl {
	77	struct kfifo kfifo; /* fifo for the pulse/space events */
	78	struct timespec last_event; /* when last event occurred */
	79	};
53f87022	80
75543cce	81	struct ir_input_dev {
945cdfa2	82	struct device dev; /* device */
727e625c	83	char driver_name; / Name of the driver module */
4714eda8 MCC	84	struct ir_scancode_table rc_tab; /* scan/key table */
4714eda8 MCC	85	unsigned long devno; /* device number */
e93854da	86	const struct ir_dev_props props; / Device properties */
a3572c34	87	struct ir_raw_event_ctrl raw; / for raw pulse/space events */
a374fef4	88	struct input_dev input_dev; / the input device associated with this device */
6660de56 MCC	89
6660de56 MCC	90	/* key info - needed by IR keycode handlers */
a374fef4 DH	91	spinlock_t keylock; /* protects the below members */
	92	bool keypressed; /* current state */
	93	unsigned long keyup_jiffies; /* when should the current keypress be released? */
	94	struct timer_list timer_keyup; /* timer for releasing a keypress */
	95	u32 last_keycode; /* keycode of last command */
	96	u32 last_scancode; /* scancode of last command */
	97	u8 last_toggle; /* toggle of last command */
75543cce	98	};
a3572c34	99
995187be MCC	100	struct ir_raw_handler {
	101	struct list_head list;
	102
	103	int (decode)(struct input_dev input_dev,
	104	struct ir_raw_event *evs,
	105	int len);
93c312ff MCC	106	int (raw_register)(struct input_dev input_dev);
93c312ff MCC	107	int (raw_unregister)(struct input_dev input_dev);
995187be MCC	108	};
995187be MCC	109
53f87022	110	#define to_ir_input_dev(_attr) container_of(_attr, struct ir_input_dev, attr)
75543cce	111
b2245ba1 MCC	112	/* Routines from rc-map.c */
	113
	114	int ir_register_map(struct rc_keymap *map);
	115	void ir_unregister_map(struct rc_keymap *map);
	116	struct ir_scancode_table get_rc_map(const char name);
02858eed	117	void rc_map_init(void);
b2245ba1	118
446e4a64 MCC	119	/* Routines from ir-keytable.c */
	120
	121	u32 ir_g_keycode_from_table(struct input_dev *input_dev,
	122	u32 scancode);
a374fef4 DH	123	void ir_repeat(struct input_dev *dev);
a374fef4 DH	124	void ir_keydown(struct input_dev *dev, int scancode, u8 toggle);
b2245ba1	125	int __ir_input_register(struct input_dev *dev,
e93854da	126	const struct ir_scancode_table *ir_codes,
727e625c MCC	127	const struct ir_dev_props *props,
727e625c MCC	128	const char *driver_name);
446e4a64	129
b2245ba1 MCC	130	static inline int ir_input_register(struct input_dev *dev,
	131	const char *map_name,
	132	const struct ir_dev_props *props,
	133	const char *driver_name) {
	134	struct ir_scancode_table *ir_codes;
02858eed MCC	135	struct ir_input_dev *ir_dev;
	136	int rc;
	137
	138	if (!map_name)
	139	return -EINVAL;
9ce50c1a	140
b2245ba1 MCC	141	ir_codes = get_rc_map(map_name);
	142	if (!ir_codes)
	143	return -EINVAL;
	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
4714eda8 MCC	160	/* Routines from ir-sysfs.c */
	161
	162	int ir_register_class(struct input_dev *input_dev);
	163	void ir_unregister_class(struct input_dev *input_dev);
	164
a3572c34 MCC	165	/* Routines from ir-raw-event.c */
	166	int ir_raw_event_register(struct input_dev *input_dev);
	167	void ir_raw_event_unregister(struct input_dev *input_dev);
	168	int ir_raw_event_store(struct input_dev *input_dev, enum raw_event_type type);
	169	int ir_raw_event_handle(struct input_dev *input_dev);
995187be MCC	170	int ir_raw_handler_register(struct ir_raw_handler *ir_raw_handler);
995187be MCC	171	void ir_raw_handler_unregister(struct ir_raw_handler *ir_raw_handler);
995187be	172	void ir_raw_init(void);
a3572c34	173
995187be MCC	174	/* from ir-nec-decoder.c */
	175	#ifdef CONFIG_IR_NEC_DECODER_MODULE
	176	#define load_nec_decode() request_module("ir-nec-decoder")
	177	#else
	178	#define load_nec_decode() 0
446e4a64	179	#endif
995187be MCC	180
995187be MCC	181	#endif /* _IR_CORE */