[net-next-2.6.git] / drivers / media / IR / ir-sony-decoder.c

/* ir-sony-decoder.c - handle Sony IR Pulse/Space protocol
 *
 * Copyright (C) 2010 by David Härdeman <david@hardeman.nu>
 *
 * 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.
 */

#include <linux/bitrev.h>
#include "ir-core-priv.h"

#define SONY_UNIT		600000 /* ns */
#define SONY_HEADER_PULSE	(4 * SONY_UNIT)
#define	SONY_HEADER_SPACE	(1 * SONY_UNIT)
#define SONY_BIT_0_PULSE	(1 * SONY_UNIT)
#define SONY_BIT_1_PULSE	(2 * SONY_UNIT)
#define SONY_BIT_SPACE		(1 * SONY_UNIT)
#define SONY_TRAILER_SPACE	(10 * SONY_UNIT) /* minimum */

enum sony_state {
	STATE_INACTIVE,
	STATE_HEADER_SPACE,
	STATE_BIT_PULSE,
	STATE_BIT_SPACE,
	STATE_FINISHED,
};

/**
 * ir_sony_decode() - Decode one Sony pulse or space
 * @input_dev:	the struct input_dev descriptor of the device
 * @ev:         the struct ir_raw_event descriptor of the pulse/space
 *
 * This function returns -EINVAL if the pulse violates the state machine
 */
static int ir_sony_decode(struct input_dev *input_dev, struct ir_raw_event ev)
{
	struct ir_input_dev *ir_dev = input_get_drvdata(input_dev);
	struct sony_dec *data = &ir_dev->raw->sony;
	u32 scancode;
	u8 device, subdevice, function;

	if (!(ir_dev->raw->enabled_protocols & IR_TYPE_SONY))
		return 0;

	if (!is_timing_event(ev)) {
		if (ev.reset)
			data->state = STATE_INACTIVE;
		return 0;
	}

	if (!geq_margin(ev.duration, SONY_UNIT, SONY_UNIT / 2))
		goto out;

	IR_dprintk(2, "Sony decode started at state %d (%uus %s)\n",
		   data->state, TO_US(ev.duration), TO_STR(ev.pulse));

	switch (data->state) {

	case STATE_INACTIVE:
		if (!ev.pulse)
			break;

		if (!eq_margin(ev.duration, SONY_HEADER_PULSE, SONY_UNIT / 2))
			break;

		data->count = 0;
		data->state = STATE_HEADER_SPACE;
		return 0;

	case STATE_HEADER_SPACE:
		if (ev.pulse)
			break;

		if (!eq_margin(ev.duration, SONY_HEADER_SPACE, SONY_UNIT / 2))
			break;

		data->state = STATE_BIT_PULSE;
		return 0;

	case STATE_BIT_PULSE:
		if (!ev.pulse)
			break;

		data->bits <<= 1;
		if (eq_margin(ev.duration, SONY_BIT_1_PULSE, SONY_UNIT / 2))
			data->bits |= 1;
		else if (!eq_margin(ev.duration, SONY_BIT_0_PULSE, SONY_UNIT / 2))
			break;

		data->count++;
		data->state = STATE_BIT_SPACE;
		return 0;

	case STATE_BIT_SPACE:
		if (ev.pulse)
			break;

		if (!geq_margin(ev.duration, SONY_BIT_SPACE, SONY_UNIT / 2))
			break;

		decrease_duration(&ev, SONY_BIT_SPACE);

		if (!geq_margin(ev.duration, SONY_UNIT, SONY_UNIT / 2)) {
			data->state = STATE_BIT_PULSE;
			return 0;
		}

		data->state = STATE_FINISHED;
		/* Fall through */

	case STATE_FINISHED:
		if (ev.pulse)
			break;

		if (!geq_margin(ev.duration, SONY_TRAILER_SPACE, SONY_UNIT / 2))
			break;

		switch (data->count) {
		case 12:
			device    = bitrev8((data->bits <<  3) & 0xF8);
			subdevice = 0;
			function  = bitrev8((data->bits >>  4) & 0xFE);
			break;
		case 15:
			device    = bitrev8((data->bits >>  0) & 0xFF);
			subdevice = 0;
			function  = bitrev8((data->bits >>  7) & 0xFD);
			break;
		case 20:
			device    = bitrev8((data->bits >>  5) & 0xF8);
			subdevice = bitrev8((data->bits >>  0) & 0xFF);
			function  = bitrev8((data->bits >> 12) & 0xFE);
			break;
		default:
			IR_dprintk(1, "Sony invalid bitcount %u\n", data->count);
			goto out;
		}

		scancode = device << 16 | subdevice << 8 | function;
		IR_dprintk(1, "Sony(%u) scancode 0x%05x\n", data->count, scancode);
		ir_keydown(input_dev, scancode, 0);
		data->state = STATE_INACTIVE;
		return 0;
	}

out:
	IR_dprintk(1, "Sony decode failed at state %d (%uus %s)\n",
		   data->state, TO_US(ev.duration), TO_STR(ev.pulse));
	data->state = STATE_INACTIVE;
	return -EINVAL;
}

static struct ir_raw_handler sony_handler = {
	.protocols	= IR_TYPE_SONY,
	.decode		= ir_sony_decode,
};

static int __init ir_sony_decode_init(void)
{
	ir_raw_handler_register(&sony_handler);

	printk(KERN_INFO "IR Sony protocol handler initialized\n");
	return 0;
}

static void __exit ir_sony_decode_exit(void)
{
	ir_raw_handler_unregister(&sony_handler);
}

module_init(ir_sony_decode_init);
module_exit(ir_sony_decode_exit);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("David Härdeman <david@hardeman.nu>");
MODULE_DESCRIPTION("Sony IR protocol decoder");
Commit	Line	Data
3fe29c89 DH	1	/* ir-sony-decoder.c - handle Sony IR Pulse/Space protocol
	2	*
	3	* Copyright (C) 2010 by David Härdeman <david@hardeman.nu>
	4	*
	5	* This program is free software; you can redistribute it and/or modify
	6	* it under the terms of the GNU General Public License as published by
	7	* the Free Software Foundation version 2 of the License.
	8	*
	9	* This program is distributed in the hope that it will be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU General Public License for more details.
	13	*/
	14
	15	#include <linux/bitrev.h>
	16	#include "ir-core-priv.h"
	17
	18	#define SONY_UNIT 600000 /* ns */
	19	#define SONY_HEADER_PULSE (4 * SONY_UNIT)
	20	#define SONY_HEADER_SPACE (1 * SONY_UNIT)
	21	#define SONY_BIT_0_PULSE (1 * SONY_UNIT)
	22	#define SONY_BIT_1_PULSE (2 * SONY_UNIT)
	23	#define SONY_BIT_SPACE (1 * SONY_UNIT)
	24	#define SONY_TRAILER_SPACE (10 * SONY_UNIT) /* minimum */
	25
3fe29c89 DH	26	enum sony_state {
	27	STATE_INACTIVE,
	28	STATE_HEADER_SPACE,
	29	STATE_BIT_PULSE,
	30	STATE_BIT_SPACE,
	31	STATE_FINISHED,
	32	};
	33
3fe29c89 DH	34	/**
	35	* ir_sony_decode() - Decode one Sony pulse or space
	36	* @input_dev: the struct input_dev descriptor of the device
	37	* @ev: the struct ir_raw_event descriptor of the pulse/space
	38	*
	39	* This function returns -EINVAL if the pulse violates the state machine
	40	*/
	41	static int ir_sony_decode(struct input_dev *input_dev, struct ir_raw_event ev)
	42	{
3fe29c89	43	struct ir_input_dev *ir_dev = input_get_drvdata(input_dev);
c216369e	44	struct sony_dec *data = &ir_dev->raw->sony;
3fe29c89 DH	45	u32 scancode;
	46	u8 device, subdevice, function;
	47
667c9ebe	48	if (!(ir_dev->raw->enabled_protocols & IR_TYPE_SONY))
3fe29c89 DH	49	return 0;
3fe29c89 DH	50
4651918a ML	51	if (!is_timing_event(ev)) {
	52	if (ev.reset)
	53	data->state = STATE_INACTIVE;
3fe29c89 DH	54	return 0;
	55	}
	56
	57	if (!geq_margin(ev.duration, SONY_UNIT, SONY_UNIT / 2))
	58	goto out;
	59
	60	IR_dprintk(2, "Sony decode started at state %d (%uus %s)\n",
	61	data->state, TO_US(ev.duration), TO_STR(ev.pulse));
	62
	63	switch (data->state) {
	64
	65	case STATE_INACTIVE:
	66	if (!ev.pulse)
	67	break;
	68
	69	if (!eq_margin(ev.duration, SONY_HEADER_PULSE, SONY_UNIT / 2))
	70	break;
	71
	72	data->count = 0;
	73	data->state = STATE_HEADER_SPACE;
	74	return 0;
	75
	76	case STATE_HEADER_SPACE:
	77	if (ev.pulse)
	78	break;
	79
	80	if (!eq_margin(ev.duration, SONY_HEADER_SPACE, SONY_UNIT / 2))
	81	break;
	82
	83	data->state = STATE_BIT_PULSE;
	84	return 0;
	85
	86	case STATE_BIT_PULSE:
	87	if (!ev.pulse)
	88	break;
	89
c216369e	90	data->bits <<= 1;
3fe29c89	91	if (eq_margin(ev.duration, SONY_BIT_1_PULSE, SONY_UNIT / 2))
c216369e	92	data->bits \|= 1;
3fe29c89 DH	93	else if (!eq_margin(ev.duration, SONY_BIT_0_PULSE, SONY_UNIT / 2))
	94	break;
	95
	96	data->count++;
	97	data->state = STATE_BIT_SPACE;
	98	return 0;
	99
	100	case STATE_BIT_SPACE:
	101	if (ev.pulse)
	102	break;
	103
	104	if (!geq_margin(ev.duration, SONY_BIT_SPACE, SONY_UNIT / 2))
	105	break;
	106
	107	decrease_duration(&ev, SONY_BIT_SPACE);
	108
	109	if (!geq_margin(ev.duration, SONY_UNIT, SONY_UNIT / 2)) {
	110	data->state = STATE_BIT_PULSE;
	111	return 0;
	112	}
	113
	114	data->state = STATE_FINISHED;
	115	/* Fall through */
	116
	117	case STATE_FINISHED:
	118	if (ev.pulse)
	119	break;
	120
	121	if (!geq_margin(ev.duration, SONY_TRAILER_SPACE, SONY_UNIT / 2))
	122	break;
	123
	124	switch (data->count) {
	125	case 12:
c216369e	126	device = bitrev8((data->bits << 3) & 0xF8);
3fe29c89	127	subdevice = 0;
c216369e	128	function = bitrev8((data->bits >> 4) & 0xFE);
3fe29c89 DH	129	break;
3fe29c89 DH	130	case 15:
c216369e	131	device = bitrev8((data->bits >> 0) & 0xFF);
3fe29c89	132	subdevice = 0;
c216369e	133	function = bitrev8((data->bits >> 7) & 0xFD);
3fe29c89 DH	134	break;
3fe29c89 DH	135	case 20:
c216369e DH	136	device = bitrev8((data->bits >> 5) & 0xF8);
	137	subdevice = bitrev8((data->bits >> 0) & 0xFF);
	138	function = bitrev8((data->bits >> 12) & 0xFE);
3fe29c89 DH	139	break;
	140	default:
	141	IR_dprintk(1, "Sony invalid bitcount %u\n", data->count);
	142	goto out;
	143	}
	144
	145	scancode = device << 16 \| subdevice << 8 \| function;
	146	IR_dprintk(1, "Sony(%u) scancode 0x%05x\n", data->count, scancode);
	147	ir_keydown(input_dev, scancode, 0);
	148	data->state = STATE_INACTIVE;
	149	return 0;
	150	}
	151
	152	out:
	153	IR_dprintk(1, "Sony decode failed at state %d (%uus %s)\n",
	154	data->state, TO_US(ev.duration), TO_STR(ev.pulse));
	155	data->state = STATE_INACTIVE;
	156	return -EINVAL;
	157	}
	158
3fe29c89	159	static struct ir_raw_handler sony_handler = {
667c9ebe	160	.protocols = IR_TYPE_SONY,
3fe29c89	161	.decode = ir_sony_decode,
3fe29c89 DH	162	};
	163
	164	static int __init ir_sony_decode_init(void)
	165	{
	166	ir_raw_handler_register(&sony_handler);
	167
	168	printk(KERN_INFO "IR Sony protocol handler initialized\n");
	169	return 0;
	170	}
	171
	172	static void __exit ir_sony_decode_exit(void)
	173	{
	174	ir_raw_handler_unregister(&sony_handler);
	175	}
	176
	177	module_init(ir_sony_decode_init);
	178	module_exit(ir_sony_decode_exit);
	179
	180	MODULE_LICENSE("GPL");
	181	MODULE_AUTHOR("David Härdeman <david@hardeman.nu>");
	182	MODULE_DESCRIPTION("Sony IR protocol decoder");