[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/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;
	int			size;
	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 timer_list		timer_keyup;	/* timer for key release */
};

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

	/* key info - needed by IR keycode handlers */
	u32				keycode;	/* linux key code */
	int				keypressed;	/* current state */
};

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)

#define IR_KEYTABLE(a)					\
ir_codes_ ## a ## _table

#define DECLARE_IR_KEYTABLE(a)					\
extern struct ir_scancode_table IR_KEYTABLE(a)

#define DEFINE_IR_KEYTABLE(tabname, type)			\
struct ir_scancode_table IR_KEYTABLE(tabname) = {		\
	.scan = tabname,					\
	.size = ARRAY_SIZE(tabname),				\
	.ir_type = type,					\
	.name = #tabname,					\
};								\
EXPORT_SYMBOL_GPL(IR_KEYTABLE(tabname))

#define DEFINE_LEGACY_IR_KEYTABLE(tabname)			\
	DEFINE_IR_KEYTABLE(tabname, IR_TYPE_UNKNOWN)

/* 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_keyup(struct input_dev *dev);
void ir_keydown(struct input_dev *dev, int scancode);
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;
	50	int size;
2915e5ef MCC	51	u64 ir_type;
2915e5ef MCC	52	char *name;
446e4a64 MCC	53	spinlock_t lock;
	54	};
	55
9ce50c1a MCC	56	struct rc_keymap {
	57	struct list_head list;
	58	struct ir_scancode_table map;
	59	};
	60
e93854da MCC	61	struct ir_dev_props {
	62	unsigned long allowed_protos;
	63	void *priv;
971e8298	64	int (change_protocol)(void priv, u64 ir_type);
716aab44 MCC	65	int (open)(void priv);
716aab44 MCC	66	void (close)(void priv);
e93854da MCC	67	};
e93854da MCC	68
a3572c34 MCC	69	struct ir_raw_event {
	70	struct timespec delta; /* Time spent before event */
	71	enum raw_event_type type; /* event type */
	72	};
	73
	74	struct ir_raw_event_ctrl {
	75	struct kfifo kfifo; /* fifo for the pulse/space events */
	76	struct timespec last_event; /* when last event occurred */
9f154782	77	struct timer_list timer_keyup; /* timer for key release */
a3572c34	78	};
53f87022	79
75543cce	80	struct ir_input_dev {
945cdfa2	81	struct device dev; /* device */
727e625c	82	char driver_name; / Name of the driver module */
4714eda8 MCC	83	struct ir_scancode_table rc_tab; /* scan/key table */
4714eda8 MCC	84	unsigned long devno; /* device number */
e93854da	85	const struct ir_dev_props props; / Device properties */
a3572c34	86	struct ir_raw_event_ctrl raw; / for raw pulse/space events */
6660de56 MCC	87
	88	/* key info - needed by IR keycode handlers */
	89	u32 keycode; /* linux key code */
	90	int keypressed; /* current state */
75543cce	91	};
a3572c34	92
995187be MCC	93	struct ir_raw_handler {
	94	struct list_head list;
	95
	96	int (decode)(struct input_dev input_dev,
	97	struct ir_raw_event *evs,
	98	int len);
93c312ff MCC	99	int (raw_register)(struct input_dev input_dev);
93c312ff MCC	100	int (raw_unregister)(struct input_dev input_dev);
995187be MCC	101	};
995187be MCC	102
53f87022	103	#define to_ir_input_dev(_attr) container_of(_attr, struct ir_input_dev, attr)
75543cce	104
77b7422d MCC	105	#define IR_KEYTABLE(a) \
	106	ir_codes_ ## a ## _table
	107
	108	#define DECLARE_IR_KEYTABLE(a) \
	109	extern struct ir_scancode_table IR_KEYTABLE(a)
	110
	111	#define DEFINE_IR_KEYTABLE(tabname, type) \
	112	struct ir_scancode_table IR_KEYTABLE(tabname) = { \
	113	.scan = tabname, \
	114	.size = ARRAY_SIZE(tabname), \
	115	.ir_type = type, \
	116	.name = #tabname, \
	117	}; \
	118	EXPORT_SYMBOL_GPL(IR_KEYTABLE(tabname))
	119
	120	#define DEFINE_LEGACY_IR_KEYTABLE(tabname) \
	121	DEFINE_IR_KEYTABLE(tabname, IR_TYPE_UNKNOWN)
	122
b2245ba1 MCC	123	/* Routines from rc-map.c */
	124
	125	int ir_register_map(struct rc_keymap *map);
	126	void ir_unregister_map(struct rc_keymap *map);
	127	struct ir_scancode_table get_rc_map(const char name);
02858eed	128	void rc_map_init(void);
b2245ba1	129
446e4a64 MCC	130	/* Routines from ir-keytable.c */
	131
	132	u32 ir_g_keycode_from_table(struct input_dev *input_dev,
	133	u32 scancode);
ada39630 MCC	134	void ir_keyup(struct input_dev *dev);
ada39630 MCC	135	void ir_keydown(struct input_dev *dev, int scancode);
b2245ba1	136	int __ir_input_register(struct input_dev *dev,
e93854da	137	const struct ir_scancode_table *ir_codes,
727e625c MCC	138	const struct ir_dev_props *props,
727e625c MCC	139	const char *driver_name);
446e4a64	140
b2245ba1 MCC	141	static inline int ir_input_register(struct input_dev *dev,
	142	const char *map_name,
	143	const struct ir_dev_props *props,
	144	const char *driver_name) {
	145	struct ir_scancode_table *ir_codes;
02858eed MCC	146	struct ir_input_dev *ir_dev;
	147	int rc;
	148
	149	if (!map_name)
	150	return -EINVAL;
9ce50c1a	151
b2245ba1 MCC	152	ir_codes = get_rc_map(map_name);
	153	if (!ir_codes)
	154	return -EINVAL;
	155
02858eed MCC	156	rc = __ir_input_register(dev, ir_codes, props, driver_name);
	157	if (rc < 0)
	158	return -EINVAL;
	159
	160	ir_dev = input_get_drvdata(dev);
	161
	162	if (!rc && ir_dev->props && ir_dev->props->change_protocol)
	163	rc = ir_dev->props->change_protocol(ir_dev->props->priv,
	164	ir_codes->ir_type);
	165
	166	return rc;
b2245ba1 MCC	167	}
b2245ba1 MCC	168
02858eed	169	void ir_input_unregister(struct input_dev *input_dev);
9ce50c1a	170
4714eda8 MCC	171	/* Routines from ir-sysfs.c */
	172
	173	int ir_register_class(struct input_dev *input_dev);
	174	void ir_unregister_class(struct input_dev *input_dev);
	175
a3572c34 MCC	176	/* Routines from ir-raw-event.c */
	177	int ir_raw_event_register(struct input_dev *input_dev);
	178	void ir_raw_event_unregister(struct input_dev *input_dev);
	179	int ir_raw_event_store(struct input_dev *input_dev, enum raw_event_type type);
	180	int ir_raw_event_handle(struct input_dev *input_dev);
995187be MCC	181	int ir_raw_handler_register(struct ir_raw_handler *ir_raw_handler);
995187be MCC	182	void ir_raw_handler_unregister(struct ir_raw_handler *ir_raw_handler);
995187be	183	void ir_raw_init(void);
a3572c34	184
995187be MCC	185	/* from ir-nec-decoder.c */
	186	#ifdef CONFIG_IR_NEC_DECODER_MODULE
	187	#define load_nec_decode() request_module("ir-nec-decoder")
	188	#else
	189	#define load_nec_decode() 0
446e4a64	190	#endif
995187be MCC	191
995187be MCC	192	#endif /* _IR_CORE */