[mirror_ubuntu-zesty-kernel.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>

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 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);
void ir_input_unregister(struct input_dev *input_dev);

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

/* 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>
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
971e8298 MCC	29	#define IR_TYPE_UNKNOWN 0
	30	#define IR_TYPE_RC5 (1 << 0) /* Philips RC5 protocol */
	31	#define IR_TYPE_PD (1 << 1) /* Pulse distance encoded IR */
	32	#define IR_TYPE_NEC (1 << 2)
	33	#define IR_TYPE_OTHER (((u64)1) << 63l)
446e4a64	34
a3572c34 MCC	35	enum raw_event_type {
	36	IR_SPACE = (1 << 0),
	37	IR_PULSE = (1 << 1),
	38	IR_START_EVENT = (1 << 2),
	39	IR_STOP_EVENT = (1 << 3),
	40	};
	41
446e4a64 MCC	42	struct ir_scancode {
	43	u16 scancode;
	44	u32 keycode;
	45	};
	46
	47	struct ir_scancode_table {
	48	struct ir_scancode *scan;
	49	int size;
2915e5ef MCC	50	u64 ir_type;
2915e5ef MCC	51	char *name;
446e4a64 MCC	52	spinlock_t lock;
	53	};
	54
9ce50c1a MCC	55	struct rc_keymap {
	56	struct list_head list;
	57	struct ir_scancode_table map;
	58	};
	59
e93854da MCC	60	struct ir_dev_props {
	61	unsigned long allowed_protos;
	62	void *priv;
971e8298	63	int (change_protocol)(void priv, u64 ir_type);
716aab44 MCC	64	int (open)(void priv);
716aab44 MCC	65	void (close)(void priv);
e93854da MCC	66	};
e93854da MCC	67
a3572c34 MCC	68	struct ir_raw_event {
	69	struct timespec delta; /* Time spent before event */
	70	enum raw_event_type type; /* event type */
	71	};
	72
	73	struct ir_raw_event_ctrl {
	74	struct kfifo kfifo; /* fifo for the pulse/space events */
	75	struct timespec last_event; /* when last event occurred */
9f154782	76	struct timer_list timer_keyup; /* timer for key release */
a3572c34	77	};
53f87022	78
75543cce	79	struct ir_input_dev {
945cdfa2	80	struct device dev; /* device */
727e625c	81	char driver_name; / Name of the driver module */
4714eda8 MCC	82	struct ir_scancode_table rc_tab; /* scan/key table */
4714eda8 MCC	83	unsigned long devno; /* device number */
e93854da	84	const struct ir_dev_props props; / Device properties */
a3572c34	85	struct ir_raw_event_ctrl raw; / for raw pulse/space events */
6660de56 MCC	86
	87	/* key info - needed by IR keycode handlers */
	88	u32 keycode; /* linux key code */
	89	int keypressed; /* current state */
75543cce	90	};
a3572c34	91
995187be MCC	92	struct ir_raw_handler {
	93	struct list_head list;
	94
	95	int (decode)(struct input_dev input_dev,
	96	struct ir_raw_event *evs,
	97	int len);
93c312ff MCC	98	int (raw_register)(struct input_dev input_dev);
93c312ff MCC	99	int (raw_unregister)(struct input_dev input_dev);
995187be MCC	100	};
995187be MCC	101
53f87022	102	#define to_ir_input_dev(_attr) container_of(_attr, struct ir_input_dev, attr)
75543cce	103
77b7422d MCC	104	#define IR_KEYTABLE(a) \
	105	ir_codes_ ## a ## _table
	106
	107	#define DECLARE_IR_KEYTABLE(a) \
	108	extern struct ir_scancode_table IR_KEYTABLE(a)
	109
	110	#define DEFINE_IR_KEYTABLE(tabname, type) \
	111	struct ir_scancode_table IR_KEYTABLE(tabname) = { \
	112	.scan = tabname, \
	113	.size = ARRAY_SIZE(tabname), \
	114	.ir_type = type, \
	115	.name = #tabname, \
	116	}; \
	117	EXPORT_SYMBOL_GPL(IR_KEYTABLE(tabname))
	118
	119	#define DEFINE_LEGACY_IR_KEYTABLE(tabname) \
	120	DEFINE_IR_KEYTABLE(tabname, IR_TYPE_UNKNOWN)
	121
446e4a64 MCC	122	/* Routines from ir-keytable.c */
	123
	124	u32 ir_g_keycode_from_table(struct input_dev *input_dev,
	125	u32 scancode);
ada39630 MCC	126	void ir_keyup(struct input_dev *dev);
ada39630 MCC	127	void ir_keydown(struct input_dev *dev, int scancode);
75543cce	128	int ir_input_register(struct input_dev *dev,
e93854da	129	const struct ir_scancode_table *ir_codes,
727e625c MCC	130	const struct ir_dev_props *props,
727e625c MCC	131	const char *driver_name);
38ef6aa8	132	void ir_input_unregister(struct input_dev *input_dev);
446e4a64	133
9ce50c1a MCC	134	/* Routines from rc-map.c */
	135
	136	int ir_register_map(struct rc_keymap *map);
	137	void ir_unregister_map(struct rc_keymap *map);
	138	struct ir_scancode_table get_rc_map(const char name);
	139
4714eda8 MCC	140	/* Routines from ir-sysfs.c */
	141
	142	int ir_register_class(struct input_dev *input_dev);
	143	void ir_unregister_class(struct input_dev *input_dev);
	144
a3572c34 MCC	145	/* Routines from ir-raw-event.c */
	146	int ir_raw_event_register(struct input_dev *input_dev);
	147	void ir_raw_event_unregister(struct input_dev *input_dev);
	148	int ir_raw_event_store(struct input_dev *input_dev, enum raw_event_type type);
	149	int ir_raw_event_handle(struct input_dev *input_dev);
995187be MCC	150	int ir_raw_handler_register(struct ir_raw_handler *ir_raw_handler);
995187be MCC	151	void ir_raw_handler_unregister(struct ir_raw_handler *ir_raw_handler);
995187be	152	void ir_raw_init(void);
a3572c34	153
995187be MCC	154	/* from ir-nec-decoder.c */
	155	#ifdef CONFIG_IR_NEC_DECODER_MODULE
	156	#define load_nec_decode() request_module("ir-nec-decoder")
	157	#else
	158	#define load_nec_decode() 0
446e4a64	159	#endif
995187be MCC	160
995187be MCC	161	#endif /* _IR_CORE */