[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>
#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 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)

/* 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;
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 */
9f154782	79	struct timer_list timer_keyup; /* timer for key release */
a3572c34	80	};
53f87022	81
75543cce	82	struct ir_input_dev {
945cdfa2	83	struct device dev; /* device */
727e625c	84	char driver_name; / Name of the driver module */
4714eda8 MCC	85	struct ir_scancode_table rc_tab; /* scan/key table */
4714eda8 MCC	86	unsigned long devno; /* device number */
e93854da	87	const struct ir_dev_props props; / Device properties */
a3572c34	88	struct ir_raw_event_ctrl raw; / for raw pulse/space events */
6660de56 MCC	89
	90	/* key info - needed by IR keycode handlers */
	91	u32 keycode; /* linux key code */
	92	int keypressed; /* current state */
75543cce	93	};
a3572c34	94
995187be MCC	95	struct ir_raw_handler {
	96	struct list_head list;
	97
	98	int (decode)(struct input_dev input_dev,
	99	struct ir_raw_event *evs,
	100	int len);
93c312ff MCC	101	int (raw_register)(struct input_dev input_dev);
93c312ff MCC	102	int (raw_unregister)(struct input_dev input_dev);
995187be MCC	103	};
995187be MCC	104
53f87022	105	#define to_ir_input_dev(_attr) container_of(_attr, struct ir_input_dev, attr)
75543cce	106
b2245ba1 MCC	107	/* Routines from rc-map.c */
	108
	109	int ir_register_map(struct rc_keymap *map);
	110	void ir_unregister_map(struct rc_keymap *map);
	111	struct ir_scancode_table get_rc_map(const char name);
02858eed	112	void rc_map_init(void);
b2245ba1	113
446e4a64 MCC	114	/* Routines from ir-keytable.c */
	115
	116	u32 ir_g_keycode_from_table(struct input_dev *input_dev,
	117	u32 scancode);
ada39630 MCC	118	void ir_keyup(struct input_dev *dev);
ada39630 MCC	119	void ir_keydown(struct input_dev *dev, int scancode);
b2245ba1	120	int __ir_input_register(struct input_dev *dev,
e93854da	121	const struct ir_scancode_table *ir_codes,
727e625c MCC	122	const struct ir_dev_props *props,
727e625c MCC	123	const char *driver_name);
446e4a64	124
b2245ba1 MCC	125	static inline int ir_input_register(struct input_dev *dev,
	126	const char *map_name,
	127	const struct ir_dev_props *props,
	128	const char *driver_name) {
	129	struct ir_scancode_table *ir_codes;
02858eed MCC	130	struct ir_input_dev *ir_dev;
	131	int rc;
	132
	133	if (!map_name)
	134	return -EINVAL;
9ce50c1a	135
b2245ba1 MCC	136	ir_codes = get_rc_map(map_name);
	137	if (!ir_codes)
	138	return -EINVAL;
	139
02858eed MCC	140	rc = __ir_input_register(dev, ir_codes, props, driver_name);
	141	if (rc < 0)
	142	return -EINVAL;
	143
	144	ir_dev = input_get_drvdata(dev);
	145
	146	if (!rc && ir_dev->props && ir_dev->props->change_protocol)
	147	rc = ir_dev->props->change_protocol(ir_dev->props->priv,
	148	ir_codes->ir_type);
	149
	150	return rc;
b2245ba1 MCC	151	}
b2245ba1 MCC	152
02858eed	153	void ir_input_unregister(struct input_dev *input_dev);
9ce50c1a	154
4714eda8 MCC	155	/* Routines from ir-sysfs.c */
	156
	157	int ir_register_class(struct input_dev *input_dev);
	158	void ir_unregister_class(struct input_dev *input_dev);
	159
a3572c34 MCC	160	/* Routines from ir-raw-event.c */
	161	int ir_raw_event_register(struct input_dev *input_dev);
	162	void ir_raw_event_unregister(struct input_dev *input_dev);
	163	int ir_raw_event_store(struct input_dev *input_dev, enum raw_event_type type);
	164	int ir_raw_event_handle(struct input_dev *input_dev);
995187be MCC	165	int ir_raw_handler_register(struct ir_raw_handler *ir_raw_handler);
995187be MCC	166	void ir_raw_handler_unregister(struct ir_raw_handler *ir_raw_handler);
995187be	167	void ir_raw_init(void);
a3572c34	168
995187be MCC	169	/* from ir-nec-decoder.c */
	170	#ifdef CONFIG_IR_NEC_DECODER_MODULE
	171	#define load_nec_decode() request_module("ir-nec-decoder")
	172	#else
	173	#define load_nec_decode() 0
446e4a64	174	#endif
995187be MCC	175
995187be MCC	176	#endif /* _IR_CORE */