drivers/input/misc/keyspan_remote.c

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