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