2 * keyspan_remote: USB driver for the Keyspan DMR
4 * Copyright (C) 2005 Zymeta Corporation - Michael Downey (downey@zymeta.com)
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.
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.
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>
19 #include <linux/moduleparam.h>
20 #include <linux/usb/input.h>
22 #define DRIVER_VERSION "v0.1"
23 #define DRIVER_AUTHOR "Michael Downey <downey@zymeta.com>"
24 #define DRIVER_DESC "Driver for the USB Keyspan remote control."
25 #define DRIVER_LICENSE "GPL"
27 /* Parameters that can be passed to the driver. */
29 module_param(debug, int, 0444);
30 MODULE_PARM_DESC(debug, "Enable extra debug messages and information");
32 /* Vendor and product ids */
33 #define USB_KEYSPAN_VENDOR_ID 0x06CD
34 #define USB_KEYSPAN_PRODUCT_UIA11 0x0202
36 /* Defines for converting the data from the remote. */
38 #define ZERO_MASK 0x1F /* 5 bits for a 0 */
40 #define ONE_MASK 0x3F /* 6 bits for a 1 */
42 #define SYNC_MASK 0x3FFF /* 14 bits for a SYNC sequence */
44 #define STOP_MASK 0x1F /* 5 bits for the STOP sequence */
47 #define RECV_SIZE 8 /* The UIA-11 type have a 8 byte limit. */
50 * Table that maps the 31 possible keycodes to input keys.
51 * Currently there are 15 and 17 button models so RESERVED codes
52 * are blank areas in the mapping.
54 static const unsigned short keyspan_key_table[] = {
55 KEY_RESERVED, /* 0 is just a place holder. */
89 /* table of devices that work with this driver */
90 static struct usb_device_id keyspan_table[] = {
91 { USB_DEVICE(USB_KEYSPAN_VENDOR_ID, USB_KEYSPAN_PRODUCT_UIA11) },
92 { } /* Terminating entry */
95 /* Structure to store all the real stuff that a remote sends to us. */
96 struct keyspan_message {
102 /* Structure used for all the bit testing magic needed to be done. */
111 /* Structure to hold all of our driver specific stuff */
115 unsigned short keymap[ARRAY_SIZE(keyspan_key_table)];
116 struct usb_device *udev;
117 struct input_dev *input;
118 struct usb_interface *interface;
119 struct usb_endpoint_descriptor *in_endpoint;
123 unsigned char *in_buffer;
125 /* variables used to parse messages from remote. */
126 struct bit_tester data;
131 static struct usb_driver keyspan_driver;
134 * Debug routine that prints out what we've received from the remote.
136 static void keyspan_print(struct usb_keyspan* dev) /*unsigned char* data)*/
138 char codes[4 * RECV_SIZE];
141 for (i = 0; i < RECV_SIZE; i++)
142 snprintf(codes + i * 3, 4, "%02x ", dev->in_buffer[i]);
144 dev_info(&dev->udev->dev, "%s\n", codes);
148 * Routine that manages the bit_tester structure. It makes sure that there are
149 * at least bits_needed bits loaded into the tester.
151 static int keyspan_load_tester(struct usb_keyspan* dev, int bits_needed)
153 if (dev->data.bits_left >= bits_needed)
157 * Somehow we've missed the last message. The message will be repeated
158 * though so it's not too big a deal
160 if (dev->data.pos >= dev->data.len) {
161 dev_dbg(&dev->udev->dev,
162 "%s - Error ran out of data. pos: %d, len: %d\n",
163 __FUNCTION__, dev->data.pos, dev->data.len);
167 /* Load as much as we can into the tester. */
168 while ((dev->data.bits_left + 7 < (sizeof(dev->data.tester) * 8)) &&
169 (dev->data.pos < dev->data.len)) {
170 dev->data.tester += (dev->data.buffer[dev->data.pos++] << dev->data.bits_left);
171 dev->data.bits_left += 8;
177 static void keyspan_report_button(struct usb_keyspan *remote, int button, int press)
179 struct input_dev *input = remote->input;
181 input_event(input, EV_MSC, MSC_SCAN, button);
182 input_report_key(input, remote->keymap[button], press);
187 * Routine that handles all the logic needed to parse out the message from the remote.
189 static void keyspan_check_data(struct usb_keyspan *remote)
193 struct keyspan_message message;
195 switch(remote->stage) {
198 * In stage 0 we want to find the start of a message. The remote sends a 0xFF as filler.
199 * So the first byte that isn't a FF should be the start of a new message.
201 for (i = 0; i < RECV_SIZE && remote->in_buffer[i] == GAP; ++i);
204 memcpy(remote->data.buffer, remote->in_buffer, RECV_SIZE);
205 remote->data.len = RECV_SIZE;
206 remote->data.pos = 0;
207 remote->data.tester = 0;
208 remote->data.bits_left = 0;
215 * Stage 1 we should have 16 bytes and should be able to detect a
216 * SYNC. The SYNC is 14 bits, 7 0's and then 7 1's.
218 memcpy(remote->data.buffer + remote->data.len, remote->in_buffer, RECV_SIZE);
219 remote->data.len += RECV_SIZE;
222 while ((remote->data.bits_left >= 14 || remote->data.pos < remote->data.len) && !found) {
223 for (i = 0; i < 8; ++i) {
224 if (keyspan_load_tester(remote, 14) != 0) {
229 if ((remote->data.tester & SYNC_MASK) == SYNC) {
230 remote->data.tester = remote->data.tester >> 14;
231 remote->data.bits_left -= 14;
235 remote->data.tester = remote->data.tester >> 1;
236 --remote->data.bits_left;
243 remote->data.len = 0;
251 * Stage 2 we should have 24 bytes which will be enough for a full
252 * message. We need to parse out the system code, button code,
253 * toggle code, and stop.
255 memcpy(remote->data.buffer + remote->data.len, remote->in_buffer, RECV_SIZE);
256 remote->data.len += RECV_SIZE;
259 for (i = 0; i < 9; i++) {
260 keyspan_load_tester(remote, 6);
262 if ((remote->data.tester & ZERO_MASK) == ZERO) {
263 message.system = message.system << 1;
264 remote->data.tester = remote->data.tester >> 5;
265 remote->data.bits_left -= 5;
266 } else if ((remote->data.tester & ONE_MASK) == ONE) {
267 message.system = (message.system << 1) + 1;
268 remote->data.tester = remote->data.tester >> 6;
269 remote->data.bits_left -= 6;
271 err("%s - Unknown sequence found in system data.\n", __FUNCTION__);
278 for (i = 0; i < 5; i++) {
279 keyspan_load_tester(remote, 6);
281 if ((remote->data.tester & ZERO_MASK) == ZERO) {
282 message.button = message.button << 1;
283 remote->data.tester = remote->data.tester >> 5;
284 remote->data.bits_left -= 5;
285 } else if ((remote->data.tester & ONE_MASK) == ONE) {
286 message.button = (message.button << 1) + 1;
287 remote->data.tester = remote->data.tester >> 6;
288 remote->data.bits_left -= 6;
290 err("%s - Unknown sequence found in button data.\n", __FUNCTION__);
296 keyspan_load_tester(remote, 6);
297 if ((remote->data.tester & ZERO_MASK) == ZERO) {
299 remote->data.tester = remote->data.tester >> 5;
300 remote->data.bits_left -= 5;
301 } else if ((remote->data.tester & ONE_MASK) == ONE) {
303 remote->data.tester = remote->data.tester >> 6;
304 remote->data.bits_left -= 6;
306 err("%s - Error in message, invalid toggle.\n", __FUNCTION__);
311 keyspan_load_tester(remote, 5);
312 if ((remote->data.tester & STOP_MASK) == STOP) {
313 remote->data.tester = remote->data.tester >> 5;
314 remote->data.bits_left -= 5;
316 err("Bad message recieved, no stop bit found.\n");
319 dev_dbg(&remote->udev->dev,
320 "%s found valid message: system: %d, button: %d, toggle: %d\n",
321 __FUNCTION__, message.system, message.button, message.toggle);
323 if (message.toggle != remote->toggle) {
324 keyspan_report_button(remote, message.button, 1);
325 keyspan_report_button(remote, message.button, 0);
326 remote->toggle = message.toggle;
335 * Routine for sending all the initialization messages to the remote.
337 static int keyspan_setup(struct usb_device* dev)
341 retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
342 0x11, 0x40, 0x5601, 0x0, NULL, 0, 0);
344 dev_dbg(&dev->dev, "%s - failed to set bit rate due to error: %d\n",
345 __FUNCTION__, retval);
349 retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
350 0x44, 0x40, 0x0, 0x0, NULL, 0, 0);
352 dev_dbg(&dev->dev, "%s - failed to set resume sensitivity due to error: %d\n",
353 __FUNCTION__, retval);
357 retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
358 0x22, 0x40, 0x0, 0x0, NULL, 0, 0);
360 dev_dbg(&dev->dev, "%s - failed to turn receive on due to error: %d\n",
361 __FUNCTION__, retval);
365 dev_dbg(&dev->dev, "%s - Setup complete.\n", __FUNCTION__);
370 * Routine used to handle a new message that has come in.
372 static void keyspan_irq_recv(struct urb *urb)
374 struct usb_keyspan *dev = urb->context;
377 /* Check our status in case we need to bail out early. */
378 switch (urb->status) {
382 /* Device went away so don't keep trying to read from it. */
396 keyspan_check_data(dev);
399 retval = usb_submit_urb(urb, GFP_ATOMIC);
401 err ("%s - usb_submit_urb failed with result: %d", __FUNCTION__, retval);
404 static int keyspan_open(struct input_dev *dev)
406 struct usb_keyspan *remote = input_get_drvdata(dev);
408 remote->irq_urb->dev = remote->udev;
409 if (usb_submit_urb(remote->irq_urb, GFP_KERNEL))
415 static void keyspan_close(struct input_dev *dev)
417 struct usb_keyspan *remote = input_get_drvdata(dev);
419 usb_kill_urb(remote->irq_urb);
422 static struct usb_endpoint_descriptor *keyspan_get_in_endpoint(struct usb_host_interface *iface)
425 struct usb_endpoint_descriptor *endpoint;
428 for (i = 0; i < iface->desc.bNumEndpoints; ++i) {
429 endpoint = &iface->endpoint[i].desc;
431 if (usb_endpoint_is_int_in(endpoint)) {
432 /* we found our interrupt in endpoint */
441 * Routine that sets up the driver to handle a specific USB device detected on the bus.
443 static int keyspan_probe(struct usb_interface *interface, const struct usb_device_id *id)
445 struct usb_device *udev = interface_to_usbdev(interface);
446 struct usb_endpoint_descriptor *endpoint;
447 struct usb_keyspan *remote;
448 struct input_dev *input_dev;
451 endpoint = keyspan_get_in_endpoint(interface->cur_altsetting);
455 remote = kzalloc(sizeof(*remote), GFP_KERNEL);
456 input_dev = input_allocate_device();
457 if (!remote || !input_dev) {
463 remote->input = input_dev;
464 remote->interface = interface;
465 remote->in_endpoint = endpoint;
466 remote->toggle = -1; /* Set to -1 so we will always not match the toggle from the first remote message. */
468 remote->in_buffer = usb_buffer_alloc(udev, RECV_SIZE, GFP_ATOMIC, &remote->in_dma);
469 if (!remote->in_buffer) {
474 remote->irq_urb = usb_alloc_urb(0, GFP_KERNEL);
475 if (!remote->irq_urb) {
480 error = keyspan_setup(udev);
486 if (udev->manufacturer)
487 strlcpy(remote->name, udev->manufacturer, sizeof(remote->name));
490 if (udev->manufacturer)
491 strlcat(remote->name, " ", sizeof(remote->name));
492 strlcat(remote->name, udev->product, sizeof(remote->name));
495 if (!strlen(remote->name))
496 snprintf(remote->name, sizeof(remote->name),
497 "USB Keyspan Remote %04x:%04x",
498 le16_to_cpu(udev->descriptor.idVendor),
499 le16_to_cpu(udev->descriptor.idProduct));
501 usb_make_path(udev, remote->phys, sizeof(remote->phys));
502 strlcat(remote->phys, "/input0", sizeof(remote->phys));
503 memcpy(remote->keymap, keyspan_key_table, sizeof(remote->keymap));
505 input_dev->name = remote->name;
506 input_dev->phys = remote->phys;
507 usb_to_input_id(udev, &input_dev->id);
508 input_dev->dev.parent = &interface->dev;
509 input_dev->keycode = remote->keymap;
510 input_dev->keycodesize = sizeof(unsigned short);
511 input_dev->keycodemax = ARRAY_SIZE(remote->keymap);
513 input_set_capability(input_dev, EV_MSC, MSC_SCAN);
514 __set_bit(EV_KEY, input_dev->evbit);
515 for (i = 0; i < ARRAY_SIZE(keyspan_key_table); i++)
516 __set_bit(keyspan_key_table[i], input_dev->keybit);
517 __clear_bit(KEY_RESERVED, input_dev->keybit);
519 input_set_drvdata(input_dev, remote);
521 input_dev->open = keyspan_open;
522 input_dev->close = keyspan_close;
525 * Initialize the URB to access the device.
526 * The urb gets sent to the device in keyspan_open()
528 usb_fill_int_urb(remote->irq_urb,
530 usb_rcvintpipe(remote->udev, endpoint->bEndpointAddress),
531 remote->in_buffer, RECV_SIZE, keyspan_irq_recv, remote,
532 endpoint->bInterval);
533 remote->irq_urb->transfer_dma = remote->in_dma;
534 remote->irq_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
536 /* we can register the device now, as it is ready */
537 error = input_register_device(remote->input);
541 /* save our data pointer in this interface device */
542 usb_set_intfdata(interface, remote);
546 fail3: usb_free_urb(remote->irq_urb);
547 fail2: usb_buffer_free(udev, RECV_SIZE, remote->in_buffer, remote->in_dma);
548 fail1: kfree(remote);
549 input_free_device(input_dev);
555 * Routine called when a device is disconnected from the USB.
557 static void keyspan_disconnect(struct usb_interface *interface)
559 struct usb_keyspan *remote;
561 remote = usb_get_intfdata(interface);
562 usb_set_intfdata(interface, NULL);
564 if (remote) { /* We have a valid driver structure so clean up everything we allocated. */
565 input_unregister_device(remote->input);
566 usb_kill_urb(remote->irq_urb);
567 usb_free_urb(remote->irq_urb);
568 usb_buffer_free(remote->udev, RECV_SIZE, remote->in_buffer, remote->in_dma);
574 * Standard driver set up sections
576 static struct usb_driver keyspan_driver =
578 .name = "keyspan_remote",
579 .probe = keyspan_probe,
580 .disconnect = keyspan_disconnect,
581 .id_table = keyspan_table
584 static int __init usb_keyspan_init(void)
588 /* register this driver with the USB subsystem */
589 result = usb_register(&keyspan_driver);
591 err("usb_register failed. Error number %d\n", result);
596 static void __exit usb_keyspan_exit(void)
598 /* deregister this driver with the USB subsystem */
599 usb_deregister(&keyspan_driver);
602 module_init(usb_keyspan_init);
603 module_exit(usb_keyspan_exit);
605 MODULE_DEVICE_TABLE(usb, keyspan_table);
606 MODULE_AUTHOR(DRIVER_AUTHOR);
607 MODULE_DESCRIPTION(DRIVER_DESC);
608 MODULE_LICENSE(DRIVER_LICENSE);