[linux.git] / drivers / input / misc / keyspan_remote.c

/*
 * keyspan_remote: USB driver for the Keyspan DMR
 *
 * Copyright (C) 2005 Zymeta Corporation - Michael Downey ([email protected])
 *
 *	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.
 *
 * This driver has been put together with the support of Innosys, Inc.
 * and Keyspan, Inc the manufacturers of the Keyspan USB DMR product.
 */

#include <linux/kernel.h>
#include <linux/errno.h>
#include <linux/init.h>
#include <linux/slab.h>
#include <linux/module.h>
#include <linux/usb/input.h>

#define DRIVER_VERSION	"v0.1"
#define DRIVER_AUTHOR	"Michael Downey <[email protected]>"
#define DRIVER_DESC	"Driver for the USB Keyspan remote control."
#define DRIVER_LICENSE	"GPL"

/* Parameters that can be passed to the driver. */
static int debug;
module_param(debug, int, 0444);
MODULE_PARM_DESC(debug, "Enable extra debug messages and information");

/* Vendor and product ids */
#define USB_KEYSPAN_VENDOR_ID		0x06CD
#define USB_KEYSPAN_PRODUCT_UIA11	0x0202

/* Defines for converting the data from the remote. */
#define ZERO		0x18
#define ZERO_MASK	0x1F	/* 5 bits for a 0 */
#define ONE		0x3C
#define ONE_MASK	0x3F	/* 6 bits for a 1 */
#define SYNC		0x3F80
#define SYNC_MASK	0x3FFF	/* 14 bits for a SYNC sequence */
#define STOP		0x00
#define STOP_MASK	0x1F	/* 5 bits for the STOP sequence */
#define GAP		0xFF

#define RECV_SIZE	8	/* The UIA-11 type have a 8 byte limit. */

/*
 * Table that maps the 31 possible keycodes to input keys.
 * Currently there are 15 and 17 button models so RESERVED codes
 * are blank areas in the mapping.
 */
static const unsigned short keyspan_key_table[] = {
	KEY_RESERVED,		/* 0 is just a place holder. */
	KEY_RESERVED,
	KEY_STOP,
	KEY_PLAYCD,
	KEY_RESERVED,
	KEY_PREVIOUSSONG,
	KEY_REWIND,
	KEY_FORWARD,
	KEY_NEXTSONG,
	KEY_RESERVED,
	KEY_RESERVED,
	KEY_RESERVED,
	KEY_PAUSE,
	KEY_VOLUMEUP,
	KEY_RESERVED,
	KEY_RESERVED,
	KEY_RESERVED,
	KEY_VOLUMEDOWN,
	KEY_RESERVED,
	KEY_UP,
	KEY_RESERVED,
	KEY_MUTE,
	KEY_LEFT,
	KEY_ENTER,
	KEY_RIGHT,
	KEY_RESERVED,
	KEY_RESERVED,
	KEY_DOWN,
	KEY_RESERVED,
	KEY_KPASTERISK,
	KEY_RESERVED,
	KEY_MENU
};

/* table of devices that work with this driver */
static struct usb_device_id keyspan_table[] = {
	{ USB_DEVICE(USB_KEYSPAN_VENDOR_ID, USB_KEYSPAN_PRODUCT_UIA11) },
	{ }					/* Terminating entry */
};

/* Structure to store all the real stuff that a remote sends to us. */
struct keyspan_message {
	u16	system;
	u8	button;
	u8	toggle;
};

/* Structure used for all the bit testing magic needed to be done. */
struct bit_tester {
	u32	tester;
	int	len;
	int	pos;
	int	bits_left;
	u8	buffer[32];
};

/* Structure to hold all of our driver specific stuff */
struct usb_keyspan {
	char				name[128];
	char				phys[64];
	unsigned short			keymap[ARRAY_SIZE(keyspan_key_table)];
	struct usb_device		*udev;
	struct input_dev		*input;
	struct usb_interface		*interface;
	struct usb_endpoint_descriptor	*in_endpoint;
	struct urb*			irq_urb;
	int				open;
	dma_addr_t			in_dma;
	unsigned char			*in_buffer;

	/* variables used to parse messages from remote. */
	struct bit_tester		data;
	int				stage;
	int				toggle;
};

static struct usb_driver keyspan_driver;

/*
 * Debug routine that prints out what we've received from the remote.
 */
static void keyspan_print(struct usb_keyspan* dev) /*unsigned char* data)*/
{
	char codes[4 * RECV_SIZE];
	int i;

	for (i = 0; i < RECV_SIZE; i++)
		snprintf(codes + i * 3, 4, "%02x ", dev->in_buffer[i]);

	dev_info(&dev->udev->dev, "%s\n", codes);
}

/*
 * Routine that manages the bit_tester structure.  It makes sure that there are
 * at least bits_needed bits loaded into the tester.
 */
static int keyspan_load_tester(struct usb_keyspan* dev, int bits_needed)
{
	if (dev->data.bits_left >= bits_needed)
		return 0;

	/*
	 * Somehow we've missed the last message. The message will be repeated
	 * though so it's not too big a deal
	 */
	if (dev->data.pos >= dev->data.len) {
		dev_dbg(&dev->udev->dev,
			"%s - Error ran out of data. pos: %d, len: %d\n",
			__func__, dev->data.pos, dev->data.len);
		return -1;
	}

	/* Load as much as we can into the tester. */
	while ((dev->data.bits_left + 7 < (sizeof(dev->data.tester) * 8)) &&
	       (dev->data.pos < dev->data.len)) {
		dev->data.tester += (dev->data.buffer[dev->data.pos++] << dev->data.bits_left);
		dev->data.bits_left += 8;
	}

	return 0;
}

static void keyspan_report_button(struct usb_keyspan *remote, int button, int press)
{
	struct input_dev *input = remote->input;

	input_event(input, EV_MSC, MSC_SCAN, button);
	input_report_key(input, remote->keymap[button], press);
	input_sync(input);
}

/*
 * Routine that handles all the logic needed to parse out the message from the remote.
 */
static void keyspan_check_data(struct usb_keyspan *remote)
{
	int i;
	int found = 0;
	struct keyspan_message message;

	switch(remote->stage) {
	case 0:
		/*
		 * In stage 0 we want to find the start of a message.  The remote sends a 0xFF as filler.
		 * So the first byte that isn't a FF should be the start of a new message.
		 */
		for (i = 0; i < RECV_SIZE && remote->in_buffer[i] == GAP; ++i);

		if (i < RECV_SIZE) {
			memcpy(remote->data.buffer, remote->in_buffer, RECV_SIZE);
			remote->data.len = RECV_SIZE;
			remote->data.pos = 0;
			remote->data.tester = 0;
			remote->data.bits_left = 0;
			remote->stage = 1;
		}
		break;

	case 1:
		/*
		 * Stage 1 we should have 16 bytes and should be able to detect a
		 * SYNC.  The SYNC is 14 bits, 7 0's and then 7 1's.
		 */
		memcpy(remote->data.buffer + remote->data.len, remote->in_buffer, RECV_SIZE);
		remote->data.len += RECV_SIZE;

		found = 0;
		while ((remote->data.bits_left >= 14 || remote->data.pos < remote->data.len) && !found) {
			for (i = 0; i < 8; ++i) {
				if (keyspan_load_tester(remote, 14) != 0) {
					remote->stage = 0;
					return;
				}

				if ((remote->data.tester & SYNC_MASK) == SYNC) {
					remote->data.tester = remote->data.tester >> 14;
					remote->data.bits_left -= 14;
					found = 1;
					break;
				} else {
					remote->data.tester = remote->data.tester >> 1;
					--remote->data.bits_left;
				}
			}
		}

		if (!found) {
			remote->stage = 0;
			remote->data.len = 0;
		} else {
			remote->stage = 2;
		}
		break;

	case 2:
		/*
		 * Stage 2 we should have 24 bytes which will be enough for a full
		 * message.  We need to parse out the system code, button code,
		 * toggle code, and stop.
		 */
		memcpy(remote->data.buffer + remote->data.len, remote->in_buffer, RECV_SIZE);
		remote->data.len += RECV_SIZE;

		message.system = 0;
		for (i = 0; i < 9; i++) {
			keyspan_load_tester(remote, 6);

			if ((remote->data.tester & ZERO_MASK) == ZERO) {
				message.system = message.system << 1;
				remote->data.tester = remote->data.tester >> 5;
				remote->data.bits_left -= 5;
			} else if ((remote->data.tester & ONE_MASK) == ONE) {
				message.system = (message.system << 1) + 1;
				remote->data.tester = remote->data.tester >> 6;
				remote->data.bits_left -= 6;
			} else {
				err("%s - Unknown sequence found in system data.\n", __func__);
				remote->stage = 0;
				return;
			}
		}

		message.button = 0;
		for (i = 0; i < 5; i++) {
			keyspan_load_tester(remote, 6);

			if ((remote->data.tester & ZERO_MASK) == ZERO) {
				message.button = message.button << 1;
				remote->data.tester = remote->data.tester >> 5;
				remote->data.bits_left -= 5;
			} else if ((remote->data.tester & ONE_MASK) == ONE) {
				message.button = (message.button << 1) + 1;
				remote->data.tester = remote->data.tester >> 6;
				remote->data.bits_left -= 6;
			} else {
				err("%s - Unknown sequence found in button data.\n", __func__);
				remote->stage = 0;
				return;
			}
		}

		keyspan_load_tester(remote, 6);
		if ((remote->data.tester & ZERO_MASK) == ZERO) {
			message.toggle = 0;
			remote->data.tester = remote->data.tester >> 5;
			remote->data.bits_left -= 5;
		} else if ((remote->data.tester & ONE_MASK) == ONE) {
			message.toggle = 1;
			remote->data.tester = remote->data.tester >> 6;
			remote->data.bits_left -= 6;
		} else {
			err("%s - Error in message, invalid toggle.\n", __func__);
			remote->stage = 0;
			return;
		}

		keyspan_load_tester(remote, 5);
		if ((remote->data.tester & STOP_MASK) == STOP) {
			remote->data.tester = remote->data.tester >> 5;
			remote->data.bits_left -= 5;
		} else {
			err("Bad message recieved, no stop bit found.\n");
		}

		dev_dbg(&remote->udev->dev,
			"%s found valid message: system: %d, button: %d, toggle: %d\n",
			__func__, message.system, message.button, message.toggle);

		if (message.toggle != remote->toggle) {
			keyspan_report_button(remote, message.button, 1);
			keyspan_report_button(remote, message.button, 0);
			remote->toggle = message.toggle;
		}

		remote->stage = 0;
		break;
	}
}

/*
 * Routine for sending all the initialization messages to the remote.
 */
static int keyspan_setup(struct usb_device* dev)
{
	int retval = 0;

	retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
				 0x11, 0x40, 0x5601, 0x0, NULL, 0, 0);
	if (retval) {
		dev_dbg(&dev->dev, "%s - failed to set bit rate due to error: %d\n",
			__func__, retval);
		return(retval);
	}

	retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
				 0x44, 0x40, 0x0, 0x0, NULL, 0, 0);
	if (retval) {
		dev_dbg(&dev->dev, "%s - failed to set resume sensitivity due to error: %d\n",
			__func__, retval);
		return(retval);
	}

	retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
				 0x22, 0x40, 0x0, 0x0, NULL, 0, 0);
	if (retval) {
		dev_dbg(&dev->dev, "%s - failed to turn receive on due to error: %d\n",
			__func__, retval);
		return(retval);
	}

	dev_dbg(&dev->dev, "%s - Setup complete.\n", __func__);
	return(retval);
}

/*
 * Routine used to handle a new message that has come in.
 */
static void keyspan_irq_recv(struct urb *urb)
{
	struct usb_keyspan *dev = urb->context;
	int retval;

	/* Check our status in case we need to bail out early. */
	switch (urb->status) {
	case 0:
		break;

	/* Device went away so don't keep trying to read from it. */
	case -ECONNRESET:
	case -ENOENT:
	case -ESHUTDOWN:
		return;

	default:
		goto resubmit;
		break;
	}

	if (debug)
		keyspan_print(dev);

	keyspan_check_data(dev);

resubmit:
	retval = usb_submit_urb(urb, GFP_ATOMIC);
	if (retval)
		err ("%s - usb_submit_urb failed with result: %d", __func__, retval);
}

static int keyspan_open(struct input_dev *dev)
{
	struct usb_keyspan *remote = input_get_drvdata(dev);

	remote->irq_urb->dev = remote->udev;
	if (usb_submit_urb(remote->irq_urb, GFP_KERNEL))
		return -EIO;

	return 0;
}

static void keyspan_close(struct input_dev *dev)
{
	struct usb_keyspan *remote = input_get_drvdata(dev);

	usb_kill_urb(remote->irq_urb);
}

static struct usb_endpoint_descriptor *keyspan_get_in_endpoint(struct usb_host_interface *iface)
{

	struct usb_endpoint_descriptor *endpoint;
	int i;

	for (i = 0; i < iface->desc.bNumEndpoints; ++i) {
		endpoint = &iface->endpoint[i].desc;

		if (usb_endpoint_is_int_in(endpoint)) {
			/* we found our interrupt in endpoint */
			return endpoint;
		}
	}

	return NULL;
}

/*
 * Routine that sets up the driver to handle a specific USB device detected on the bus.
 */
static int keyspan_probe(struct usb_interface *interface, const struct usb_device_id *id)
{
	struct usb_device *udev = interface_to_usbdev(interface);
	struct usb_endpoint_descriptor *endpoint;
	struct usb_keyspan *remote;
	struct input_dev *input_dev;
	int i, error;

	endpoint = keyspan_get_in_endpoint(interface->cur_altsetting);
	if (!endpoint)
		return -ENODEV;

	remote = kzalloc(sizeof(*remote), GFP_KERNEL);
	input_dev = input_allocate_device();
	if (!remote || !input_dev) {
		error = -ENOMEM;
		goto fail1;
	}

	remote->udev = udev;
	remote->input = input_dev;
	remote->interface = interface;
	remote->in_endpoint = endpoint;
	remote->toggle = -1;	/* Set to -1 so we will always not match the toggle from the first remote message. */

	remote->in_buffer = usb_buffer_alloc(udev, RECV_SIZE, GFP_ATOMIC, &remote->in_dma);
	if (!remote->in_buffer) {
		error = -ENOMEM;
		goto fail1;
	}

	remote->irq_urb = usb_alloc_urb(0, GFP_KERNEL);
	if (!remote->irq_urb) {
		error = -ENOMEM;
		goto fail2;
	}

	error = keyspan_setup(udev);
	if (error) {
		error = -ENODEV;
		goto fail3;
	}

	if (udev->manufacturer)
		strlcpy(remote->name, udev->manufacturer, sizeof(remote->name));

	if (udev->product) {
		if (udev->manufacturer)
			strlcat(remote->name, " ", sizeof(remote->name));
		strlcat(remote->name, udev->product, sizeof(remote->name));
	}

	if (!strlen(remote->name))
		snprintf(remote->name, sizeof(remote->name),
			 "USB Keyspan Remote %04x:%04x",
			 le16_to_cpu(udev->descriptor.idVendor),
			 le16_to_cpu(udev->descriptor.idProduct));

	usb_make_path(udev, remote->phys, sizeof(remote->phys));
	strlcat(remote->phys, "/input0", sizeof(remote->phys));
	memcpy(remote->keymap, keyspan_key_table, sizeof(remote->keymap));

	input_dev->name = remote->name;
	input_dev->phys = remote->phys;
	usb_to_input_id(udev, &input_dev->id);
	input_dev->dev.parent = &interface->dev;
	input_dev->keycode = remote->keymap;
	input_dev->keycodesize = sizeof(unsigned short);
	input_dev->keycodemax = ARRAY_SIZE(remote->keymap);

	input_set_capability(input_dev, EV_MSC, MSC_SCAN);
	__set_bit(EV_KEY, input_dev->evbit);
	for (i = 0; i < ARRAY_SIZE(keyspan_key_table); i++)
		__set_bit(keyspan_key_table[i], input_dev->keybit);
	__clear_bit(KEY_RESERVED, input_dev->keybit);

	input_set_drvdata(input_dev, remote);

	input_dev->open = keyspan_open;
	input_dev->close = keyspan_close;

	/*
	 * Initialize the URB to access the device.
	 * The urb gets sent to the device in keyspan_open()
	 */
	usb_fill_int_urb(remote->irq_urb,
			 remote->udev,
			 usb_rcvintpipe(remote->udev, endpoint->bEndpointAddress),
			 remote->in_buffer, RECV_SIZE, keyspan_irq_recv, remote,
			 endpoint->bInterval);
	remote->irq_urb->transfer_dma = remote->in_dma;
	remote->irq_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;

	/* we can register the device now, as it is ready */
	error = input_register_device(remote->input);
	if (error)
		goto fail3;

	/* save our data pointer in this interface device */
	usb_set_intfdata(interface, remote);

	return 0;

 fail3:	usb_free_urb(remote->irq_urb);
 fail2:	usb_buffer_free(udev, RECV_SIZE, remote->in_buffer, remote->in_dma);
 fail1:	kfree(remote);
	input_free_device(input_dev);

	return error;
}

/*
 * Routine called when a device is disconnected from the USB.
 */
static void keyspan_disconnect(struct usb_interface *interface)
{
	struct usb_keyspan *remote;

	remote = usb_get_intfdata(interface);
	usb_set_intfdata(interface, NULL);

	if (remote) {	/* We have a valid driver structure so clean up everything we allocated. */
		input_unregister_device(remote->input);
		usb_kill_urb(remote->irq_urb);
		usb_free_urb(remote->irq_urb);
		usb_buffer_free(remote->udev, RECV_SIZE, remote->in_buffer, remote->in_dma);
		kfree(remote);
	}
}

/*
 * Standard driver set up sections
 */
static struct usb_driver keyspan_driver =
{
	.name =		"keyspan_remote",
	.probe =	keyspan_probe,
	.disconnect =	keyspan_disconnect,
	.id_table =	keyspan_table
};

static int __init usb_keyspan_init(void)
{
	int result;

	/* register this driver with the USB subsystem */
	result = usb_register(&keyspan_driver);
	if (result)
		err("usb_register failed. Error number %d\n", result);

	return result;
}

static void __exit usb_keyspan_exit(void)
{
	/* deregister this driver with the USB subsystem */
	usb_deregister(&keyspan_driver);
}

module_init(usb_keyspan_init);
module_exit(usb_keyspan_exit);

MODULE_DEVICE_TABLE(usb, keyspan_table);
MODULE_AUTHOR(DRIVER_AUTHOR);
MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_LICENSE(DRIVER_LICENSE);
Commit	Line	Data
99f83c9c MD	1	/*
	2	* keyspan_remote: USB driver for the Keyspan DMR
	3	*
	4	* Copyright (C) 2005 Zymeta Corporation - Michael Downey ([email protected])
	5	*
	6	* This program is free software; you can redistribute it and/or
	7	* modify it under the terms of the GNU General Public License as
	8	* published by the Free Software Foundation, version 2.
	9	*
	10	* This driver has been put together with the support of Innosys, Inc.
	11	* and Keyspan, Inc the manufacturers of the Keyspan USB DMR product.
	12	*/
	13
99f83c9c MD	14	#include <linux/kernel.h>
	15	#include <linux/errno.h>
	16	#include <linux/init.h>
	17	#include <linux/slab.h>
	18	#include <linux/module.h>
ae0dadcf	19	#include <linux/usb/input.h>
99f83c9c MD	20
	21	#define DRIVER_VERSION "v0.1"
	22	#define DRIVER_AUTHOR "Michael Downey <[email protected]>"
	23	#define DRIVER_DESC "Driver for the USB Keyspan remote control."
	24	#define DRIVER_LICENSE "GPL"
	25
	26	/* Parameters that can be passed to the driver. */
	27	static int debug;
	28	module_param(debug, int, 0444);
	29	MODULE_PARM_DESC(debug, "Enable extra debug messages and information");
	30
	31	/* Vendor and product ids */
	32	#define USB_KEYSPAN_VENDOR_ID 0x06CD
	33	#define USB_KEYSPAN_PRODUCT_UIA11 0x0202
	34
	35	/* Defines for converting the data from the remote. */
	36	#define ZERO 0x18
	37	#define ZERO_MASK 0x1F /* 5 bits for a 0 */
	38	#define ONE 0x3C
	39	#define ONE_MASK 0x3F /* 6 bits for a 1 */
	40	#define SYNC 0x3F80
	41	#define SYNC_MASK 0x3FFF /* 14 bits for a SYNC sequence */
	42	#define STOP 0x00
	43	#define STOP_MASK 0x1F /* 5 bits for the STOP sequence */
	44	#define GAP 0xFF
	45
	46	#define RECV_SIZE 8 /* The UIA-11 type have a 8 byte limit. */
	47
99f83c9c MD	48	/*
	49	* Table that maps the 31 possible keycodes to input keys.
	50	* Currently there are 15 and 17 button models so RESERVED codes
	51	* are blank areas in the mapping.
	52	*/
1953ea2d	53	static const unsigned short keyspan_key_table[] = {
99f83c9c MD	54	KEY_RESERVED, /* 0 is just a place holder. */
	55	KEY_RESERVED,
	56	KEY_STOP,
	57	KEY_PLAYCD,
	58	KEY_RESERVED,
	59	KEY_PREVIOUSSONG,
	60	KEY_REWIND,
	61	KEY_FORWARD,
	62	KEY_NEXTSONG,
	63	KEY_RESERVED,
	64	KEY_RESERVED,
	65	KEY_RESERVED,
	66	KEY_PAUSE,
	67	KEY_VOLUMEUP,
	68	KEY_RESERVED,
	69	KEY_RESERVED,
	70	KEY_RESERVED,
	71	KEY_VOLUMEDOWN,
	72	KEY_RESERVED,
	73	KEY_UP,
	74	KEY_RESERVED,
	75	KEY_MUTE,
	76	KEY_LEFT,
	77	KEY_ENTER,
	78	KEY_RIGHT,
	79	KEY_RESERVED,
	80	KEY_RESERVED,
	81	KEY_DOWN,
	82	KEY_RESERVED,
	83	KEY_KPASTERISK,
	84	KEY_RESERVED,
	85	KEY_MENU
	86	};
	87
1953ea2d DT	88	/* table of devices that work with this driver */
	89	static struct usb_device_id keyspan_table[] = {
	90	{ USB_DEVICE(USB_KEYSPAN_VENDOR_ID, USB_KEYSPAN_PRODUCT_UIA11) },
	91	{ } /* Terminating entry */
	92	};
	93
	94	/* Structure to store all the real stuff that a remote sends to us. */
	95	struct keyspan_message {
	96	u16 system;
	97	u8 button;
	98	u8 toggle;
	99	};
	100
	101	/* Structure used for all the bit testing magic needed to be done. */
	102	struct bit_tester {
	103	u32 tester;
	104	int len;
	105	int pos;
	106	int bits_left;
	107	u8 buffer[32];
	108	};
	109
	110	/* Structure to hold all of our driver specific stuff */
	111	struct usb_keyspan {
	112	char name[128];
	113	char phys[64];
	114	unsigned short keymap[ARRAY_SIZE(keyspan_key_table)];
	115	struct usb_device *udev;
	116	struct input_dev *input;
	117	struct usb_interface *interface;
	118	struct usb_endpoint_descriptor *in_endpoint;
	119	struct urb* irq_urb;
	120	int open;
	121	dma_addr_t in_dma;
	122	unsigned char *in_buffer;
	123
	124	/* variables used to parse messages from remote. */
	125	struct bit_tester data;
	126	int stage;
	127	int toggle;
	128	};
	129
99f83c9c MD	130	static struct usb_driver keyspan_driver;
	131
	132	/*
	133	* Debug routine that prints out what we've received from the remote.
	134	*/
	135	static void keyspan_print(struct usb_keyspan* dev) /unsigned char data)*/
	136	{
c5b7c7c3	137	char codes[4 * RECV_SIZE];
99f83c9c MD	138	int i;
99f83c9c MD	139
c5b7c7c3 DT	140	for (i = 0; i < RECV_SIZE; i++)
c5b7c7c3 DT	141	snprintf(codes + i * 3, 4, "%02x ", dev->in_buffer[i]);
99f83c9c MD	142
	143	dev_info(&dev->udev->dev, "%s\n", codes);
	144	}
	145
	146	/*
	147	* Routine that manages the bit_tester structure. It makes sure that there are
	148	* at least bits_needed bits loaded into the tester.
	149	*/
	150	static int keyspan_load_tester(struct usb_keyspan* dev, int bits_needed)
	151	{
	152	if (dev->data.bits_left >= bits_needed)
c5b7c7c3	153	return 0;
99f83c9c MD	154
	155	/*
	156	* Somehow we've missed the last message. The message will be repeated
	157	* though so it's not too big a deal
	158	*/
	159	if (dev->data.pos >= dev->data.len) {
654f3118 GKH	160	dev_dbg(&dev->udev->dev,
654f3118 GKH	161	"%s - Error ran out of data. pos: %d, len: %d\n",
ea3e6c59	162	__func__, dev->data.pos, dev->data.len);
c5b7c7c3	163	return -1;
99f83c9c MD	164	}
	165
	166	/* Load as much as we can into the tester. */
	167	while ((dev->data.bits_left + 7 < (sizeof(dev->data.tester) * 8)) &&
	168	(dev->data.pos < dev->data.len)) {
	169	dev->data.tester += (dev->data.buffer[dev->data.pos++] << dev->data.bits_left);
	170	dev->data.bits_left += 8;
	171	}
	172
c5b7c7c3	173	return 0;
99f83c9c MD	174	}
99f83c9c MD	175
1953ea2d DT	176	static void keyspan_report_button(struct usb_keyspan *remote, int button, int press)
	177	{
	178	struct input_dev *input = remote->input;
	179
	180	input_event(input, EV_MSC, MSC_SCAN, button);
	181	input_report_key(input, remote->keymap[button], press);
	182	input_sync(input);
	183	}
	184
99f83c9c MD	185	/*
	186	* Routine that handles all the logic needed to parse out the message from the remote.
	187	*/
7d12e780	188	static void keyspan_check_data(struct usb_keyspan *remote)
99f83c9c MD	189	{
	190	int i;
	191	int found = 0;
	192	struct keyspan_message message;
	193
	194	switch(remote->stage) {
	195	case 0:
	196	/*
	197	* In stage 0 we want to find the start of a message. The remote sends a 0xFF as filler.
	198	* So the first byte that isn't a FF should be the start of a new message.
	199	*/
	200	for (i = 0; i < RECV_SIZE && remote->in_buffer[i] == GAP; ++i);
	201
	202	if (i < RECV_SIZE) {
	203	memcpy(remote->data.buffer, remote->in_buffer, RECV_SIZE);
	204	remote->data.len = RECV_SIZE;
	205	remote->data.pos = 0;
	206	remote->data.tester = 0;
	207	remote->data.bits_left = 0;
	208	remote->stage = 1;
	209	}
	210	break;
	211
	212	case 1:
	213	/*
	214	* Stage 1 we should have 16 bytes and should be able to detect a
	215	* SYNC. The SYNC is 14 bits, 7 0's and then 7 1's.
	216	*/
	217	memcpy(remote->data.buffer + remote->data.len, remote->in_buffer, RECV_SIZE);
	218	remote->data.len += RECV_SIZE;
	219
	220	found = 0;
	221	while ((remote->data.bits_left >= 14 \|\| remote->data.pos < remote->data.len) && !found) {
	222	for (i = 0; i < 8; ++i) {
	223	if (keyspan_load_tester(remote, 14) != 0) {
	224	remote->stage = 0;
	225	return;
	226	}
	227
	228	if ((remote->data.tester & SYNC_MASK) == SYNC) {
	229	remote->data.tester = remote->data.tester >> 14;
	230	remote->data.bits_left -= 14;
	231	found = 1;
	232	break;
	233	} else {
	234	remote->data.tester = remote->data.tester >> 1;
	235	--remote->data.bits_left;
	236	}
	237	}
	238	}
	239
	240	if (!found) {
	241	remote->stage = 0;
	242	remote->data.len = 0;
	243	} else {
	244	remote->stage = 2;
	245	}
	246	break;
	247
	248	case 2:
	249	/*
	250	* Stage 2 we should have 24 bytes which will be enough for a full
	251	* message. We need to parse out the system code, button code,
	252	* toggle code, and stop.
253	*/
254	memcpy(remote->data.buffer + remote->data.len, remote->in_buffer, RECV_SIZE);
255	remote->data.len += RECV_SIZE;
256
257	message.system = 0;
258	for (i = 0; i < 9; i++) {
259	keyspan_load_tester(remote, 6);
260
261	if ((remote->data.tester & ZERO_MASK) == ZERO) {
262	message.system = message.system << 1;
263	remote->data.tester = remote->data.tester >> 5;
264	remote->data.bits_left -= 5;
265	} else if ((remote->data.tester & ONE_MASK) == ONE) {
266	message.system = (message.system << 1) + 1;
267	remote->data.tester = remote->data.tester >> 6;
268	remote->data.bits_left -= 6;
269	} else {
ea3e6c59	270	err("%s - Unknown sequence found in system data.\n", __func__);
99f83c9c MD	271	remote->stage = 0;
	272	return;
	273	}
	274	}
	275
	276	message.button = 0;
	277	for (i = 0; i < 5; i++) {
	278	keyspan_load_tester(remote, 6);
	279
	280	if ((remote->data.tester & ZERO_MASK) == ZERO) {
	281	message.button = message.button << 1;
	282	remote->data.tester = remote->data.tester >> 5;
	283	remote->data.bits_left -= 5;
	284	} else if ((remote->data.tester & ONE_MASK) == ONE) {
	285	message.button = (message.button << 1) + 1;
	286	remote->data.tester = remote->data.tester >> 6;
	287	remote->data.bits_left -= 6;
	288	} else {
ea3e6c59	289	err("%s - Unknown sequence found in button data.\n", __func__);
99f83c9c MD	290	remote->stage = 0;
	291	return;
	292	}
	293	}
	294
	295	keyspan_load_tester(remote, 6);
	296	if ((remote->data.tester & ZERO_MASK) == ZERO) {
	297	message.toggle = 0;
	298	remote->data.tester = remote->data.tester >> 5;
	299	remote->data.bits_left -= 5;
	300	} else if ((remote->data.tester & ONE_MASK) == ONE) {
	301	message.toggle = 1;
	302	remote->data.tester = remote->data.tester >> 6;
	303	remote->data.bits_left -= 6;
	304	} else {
ea3e6c59	305	err("%s - Error in message, invalid toggle.\n", __func__);
01e89506 MD	306	remote->stage = 0;
01e89506 MD	307	return;
99f83c9c MD	308	}
	309
	310	keyspan_load_tester(remote, 5);
	311	if ((remote->data.tester & STOP_MASK) == STOP) {
	312	remote->data.tester = remote->data.tester >> 5;
	313	remote->data.bits_left -= 5;
	314	} else {
	315	err("Bad message recieved, no stop bit found.\n");
	316	}
	317
654f3118	318	dev_dbg(&remote->udev->dev,
99f83c9c	319	"%s found valid message: system: %d, button: %d, toggle: %d\n",
ea3e6c59	320	__func__, message.system, message.button, message.toggle);
99f83c9c MD	321
99f83c9c MD	322	if (message.toggle != remote->toggle) {
1953ea2d DT	323	keyspan_report_button(remote, message.button, 1);
1953ea2d DT	324	keyspan_report_button(remote, message.button, 0);
99f83c9c MD	325	remote->toggle = message.toggle;
	326	}
	327
	328	remote->stage = 0;
	329	break;
	330	}
	331	}
	332
	333	/*
	334	* Routine for sending all the initialization messages to the remote.
	335	*/
	336	static int keyspan_setup(struct usb_device* dev)
	337	{
	338	int retval = 0;
	339
	340	retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
	341	0x11, 0x40, 0x5601, 0x0, NULL, 0, 0);
	342	if (retval) {
	343	dev_dbg(&dev->dev, "%s - failed to set bit rate due to error: %d\n",
ea3e6c59	344	__func__, retval);
99f83c9c MD	345	return(retval);
	346	}
	347
	348	retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
	349	0x44, 0x40, 0x0, 0x0, NULL, 0, 0);
	350	if (retval) {
	351	dev_dbg(&dev->dev, "%s - failed to set resume sensitivity due to error: %d\n",
ea3e6c59	352	__func__, retval);
99f83c9c MD	353	return(retval);
	354	}
	355
	356	retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
	357	0x22, 0x40, 0x0, 0x0, NULL, 0, 0);
	358	if (retval) {
	359	dev_dbg(&dev->dev, "%s - failed to turn receive on due to error: %d\n",
ea3e6c59	360	__func__, retval);
99f83c9c MD	361	return(retval);
	362	}
	363
ea3e6c59	364	dev_dbg(&dev->dev, "%s - Setup complete.\n", __func__);
99f83c9c MD	365	return(retval);
	366	}
	367
	368	/*
	369	* Routine used to handle a new message that has come in.
	370	*/
7d12e780	371	static void keyspan_irq_recv(struct urb *urb)
99f83c9c MD	372	{
	373	struct usb_keyspan *dev = urb->context;
	374	int retval;
	375
	376	/* Check our status in case we need to bail out early. */
	377	switch (urb->status) {
	378	case 0:
	379	break;
	380
	381	/* Device went away so don't keep trying to read from it. */
	382	case -ECONNRESET:
	383	case -ENOENT:
	384	case -ESHUTDOWN:
	385	return;
	386
	387	default:
	388	goto resubmit;
	389	break;
	390	}
	391
	392	if (debug)
	393	keyspan_print(dev);
	394
7d12e780	395	keyspan_check_data(dev);
99f83c9c MD	396
	397	resubmit:
	398	retval = usb_submit_urb(urb, GFP_ATOMIC);
	399	if (retval)
ea3e6c59	400	err ("%s - usb_submit_urb failed with result: %d", __func__, retval);
99f83c9c MD	401	}
	402
	403	static int keyspan_open(struct input_dev *dev)
	404	{
7791bdae	405	struct usb_keyspan *remote = input_get_drvdata(dev);
99f83c9c	406
99f83c9c	407	remote->irq_urb->dev = remote->udev;
c5b7c7c3	408	if (usb_submit_urb(remote->irq_urb, GFP_KERNEL))
99f83c9c	409	return -EIO;
99f83c9c MD	410
	411	return 0;
	412	}
	413
	414	static void keyspan_close(struct input_dev *dev)
	415	{
7791bdae	416	struct usb_keyspan *remote = input_get_drvdata(dev);
99f83c9c	417
c5b7c7c3 DT	418	usb_kill_urb(remote->irq_urb);
	419	}
	420
	421	static struct usb_endpoint_descriptor keyspan_get_in_endpoint(struct usb_host_interface iface)
	422	{
	423
	424	struct usb_endpoint_descriptor *endpoint;
	425	int i;
	426
	427	for (i = 0; i < iface->desc.bNumEndpoints; ++i) {
	428	endpoint = &iface->endpoint[i].desc;
	429
96723199	430	if (usb_endpoint_is_int_in(endpoint)) {
c5b7c7c3 DT	431	/* we found our interrupt in endpoint */
	432	return endpoint;
	433	}
	434	}
	435
	436	return NULL;
99f83c9c MD	437	}
	438
	439	/*
	440	* Routine that sets up the driver to handle a specific USB device detected on the bus.
	441	*/
	442	static int keyspan_probe(struct usb_interface interface, const struct usb_device_id id)
	443	{
c5b7c7c3	444	struct usb_device *udev = interface_to_usbdev(interface);
99f83c9c	445	struct usb_endpoint_descriptor *endpoint;
c5b7c7c3 DT	446	struct usb_keyspan *remote;
c5b7c7c3 DT	447	struct input_dev *input_dev;
5014186d	448	int i, error;
99f83c9c	449
c5b7c7c3 DT	450	endpoint = keyspan_get_in_endpoint(interface->cur_altsetting);
	451	if (!endpoint)
	452	return -ENODEV;
	453
	454	remote = kzalloc(sizeof(*remote), GFP_KERNEL);
	455	input_dev = input_allocate_device();
	456	if (!remote \|\| !input_dev) {
5014186d	457	error = -ENOMEM;
c5b7c7c3	458	goto fail1;
99f83c9c	459	}
99f83c9c MD	460
99f83c9c MD	461	remote->udev = udev;
c5b7c7c3	462	remote->input = input_dev;
99f83c9c	463	remote->interface = interface;
c5b7c7c3	464	remote->in_endpoint = endpoint;
99f83c9c MD	465	remote->toggle = -1; /* Set to -1 so we will always not match the toggle from the first remote message. */
99f83c9c MD	466
54e6ecb2	467	remote->in_buffer = usb_buffer_alloc(udev, RECV_SIZE, GFP_ATOMIC, &remote->in_dma);
c5b7c7c3	468	if (!remote->in_buffer) {
5014186d	469	error = -ENOMEM;
c5b7c7c3	470	goto fail1;
99f83c9c MD	471	}
	472
	473	remote->irq_urb = usb_alloc_urb(0, GFP_KERNEL);
	474	if (!remote->irq_urb) {
5014186d	475	error = -ENOMEM;
c5b7c7c3	476	goto fail2;
99f83c9c MD	477	}
99f83c9c MD	478
5014186d DT	479	error = keyspan_setup(udev);
	480	if (error) {
	481	error = -ENODEV;
c5b7c7c3	482	goto fail3;
99f83c9c MD	483	}
99f83c9c MD	484
c5b7c7c3 DT	485	if (udev->manufacturer)
c5b7c7c3 DT	486	strlcpy(remote->name, udev->manufacturer, sizeof(remote->name));
99f83c9c	487
c5b7c7c3 DT	488	if (udev->product) {
	489	if (udev->manufacturer)
	490	strlcat(remote->name, " ", sizeof(remote->name));
	491	strlcat(remote->name, udev->product, sizeof(remote->name));
99f83c9c MD	492	}
99f83c9c MD	493
c5b7c7c3 DT	494	if (!strlen(remote->name))
	495	snprintf(remote->name, sizeof(remote->name),
	496	"USB Keyspan Remote %04x:%04x",
	497	le16_to_cpu(udev->descriptor.idVendor),
	498	le16_to_cpu(udev->descriptor.idProduct));
99f83c9c	499
c5b7c7c3 DT	500	usb_make_path(udev, remote->phys, sizeof(remote->phys));
c5b7c7c3 DT	501	strlcat(remote->phys, "/input0", sizeof(remote->phys));
1953ea2d	502	memcpy(remote->keymap, keyspan_key_table, sizeof(remote->keymap));
99f83c9c	503
c5b7c7c3 DT	504	input_dev->name = remote->name;
	505	input_dev->phys = remote->phys;
	506	usb_to_input_id(udev, &input_dev->id);
c0f82d57	507	input_dev->dev.parent = &interface->dev;
1953ea2d DT	508	input_dev->keycode = remote->keymap;
	509	input_dev->keycodesize = sizeof(unsigned short);
	510	input_dev->keycodemax = ARRAY_SIZE(remote->keymap);
99f83c9c	511
1953ea2d DT	512	input_set_capability(input_dev, EV_MSC, MSC_SCAN);
1953ea2d DT	513	__set_bit(EV_KEY, input_dev->evbit);
c5b7c7c3	514	for (i = 0; i < ARRAY_SIZE(keyspan_key_table); i++)
1953ea2d DT	515	__set_bit(keyspan_key_table[i], input_dev->keybit);
1953ea2d DT	516	__clear_bit(KEY_RESERVED, input_dev->keybit);
c5b7c7c3	517
7791bdae DT	518	input_set_drvdata(input_dev, remote);
7791bdae DT	519
c5b7c7c3 DT	520	input_dev->open = keyspan_open;
c5b7c7c3 DT	521	input_dev->close = keyspan_close;
99f83c9c MD	522
99f83c9c MD	523	/*
1953ea2d DT	524	* Initialize the URB to access the device.
1953ea2d DT	525	* The urb gets sent to the device in keyspan_open()
99f83c9c MD	526	*/
99f83c9c MD	527	usb_fill_int_urb(remote->irq_urb,
1953ea2d DT	528	remote->udev,
1953ea2d DT	529	usb_rcvintpipe(remote->udev, endpoint->bEndpointAddress),
99f83c9c	530	remote->in_buffer, RECV_SIZE, keyspan_irq_recv, remote,
1953ea2d	531	endpoint->bInterval);
99f83c9c MD	532	remote->irq_urb->transfer_dma = remote->in_dma;
	533	remote->irq_urb->transfer_flags \|= URB_NO_TRANSFER_DMA_MAP;
	534
	535	/* we can register the device now, as it is ready */
5014186d DT	536	error = input_register_device(remote->input);
	537	if (error)
	538	goto fail3;
99f83c9c MD	539
	540	/* save our data pointer in this interface device */
	541	usb_set_intfdata(interface, remote);
	542
99f83c9c MD	543	return 0;
99f83c9c MD	544
c5b7c7c3 DT	545	fail3: usb_free_urb(remote->irq_urb);
	546	fail2: usb_buffer_free(udev, RECV_SIZE, remote->in_buffer, remote->in_dma);
	547	fail1: kfree(remote);
	548	input_free_device(input_dev);
99f83c9c	549
5014186d	550	return error;
99f83c9c MD	551	}
	552
	553	/*
	554	* Routine called when a device is disconnected from the USB.
	555	*/
	556	static void keyspan_disconnect(struct usb_interface *interface)
	557	{
	558	struct usb_keyspan *remote;
	559
99f83c9c MD	560	remote = usb_get_intfdata(interface);
	561	usb_set_intfdata(interface, NULL);
	562
	563	if (remote) { /* We have a valid driver structure so clean up everything we allocated. */
c5b7c7c3	564	input_unregister_device(remote->input);
99f83c9c MD	565	usb_kill_urb(remote->irq_urb);
99f83c9c MD	566	usb_free_urb(remote->irq_urb);
c5b7c7c3	567	usb_buffer_free(remote->udev, RECV_SIZE, remote->in_buffer, remote->in_dma);
99f83c9c MD	568	kfree(remote);
99f83c9c MD	569	}
99f83c9c MD	570	}
	571
	572	/*
	573	* Standard driver set up sections
	574	*/
	575	static struct usb_driver keyspan_driver =
	576	{
99f83c9c MD	577	.name = "keyspan_remote",
	578	.probe = keyspan_probe,
	579	.disconnect = keyspan_disconnect,
	580	.id_table = keyspan_table
	581	};
	582
	583	static int __init usb_keyspan_init(void)
	584	{
	585	int result;
	586
	587	/* register this driver with the USB subsystem */
	588	result = usb_register(&keyspan_driver);
	589	if (result)
	590	err("usb_register failed. Error number %d\n", result);
	591
	592	return result;
	593	}
	594
	595	static void __exit usb_keyspan_exit(void)
	596	{
	597	/* deregister this driver with the USB subsystem */
	598	usb_deregister(&keyspan_driver);
	599	}
	600
	601	module_init(usb_keyspan_init);
	602	module_exit(usb_keyspan_exit);
	603
	604	MODULE_DEVICE_TABLE(usb, keyspan_table);
	605	MODULE_AUTHOR(DRIVER_AUTHOR);
	606	MODULE_DESCRIPTION(DRIVER_DESC);
	607	MODULE_LICENSE(DRIVER_LICENSE);