1/* 2 * USB ATI Remote support 3 * 4 * Copyright (c) 2011, 2012 Anssi Hannula <anssi.hannula@iki.fi> 5 * Version 2.2.0 Copyright (c) 2004 Torrey Hoffman <thoffman@arnor.net> 6 * Version 2.1.1 Copyright (c) 2002 Vladimir Dergachev 7 * 8 * This 2.2.0 version is a rewrite / cleanup of the 2.1.1 driver, including 9 * porting to the 2.6 kernel interfaces, along with other modification 10 * to better match the style of the existing usb/input drivers. However, the 11 * protocol and hardware handling is essentially unchanged from 2.1.1. 12 * 13 * The 2.1.1 driver was derived from the usbati_remote and usbkbd drivers by 14 * Vojtech Pavlik. 15 * 16 * Changes: 17 * 18 * Feb 2004: Torrey Hoffman <thoffman@arnor.net> 19 * Version 2.2.0 20 * Jun 2004: Torrey Hoffman <thoffman@arnor.net> 21 * Version 2.2.1 22 * Added key repeat support contributed by: 23 * Vincent Vanackere <vanackere@lif.univ-mrs.fr> 24 * Added support for the "Lola" remote contributed by: 25 * Seth Cohn <sethcohn@yahoo.com> 26 * 27 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * 28 * 29 * This program is free software; you can redistribute it and/or modify 30 * it under the terms of the GNU General Public License as published by 31 * the Free Software Foundation; either version 2 of the License, or 32 * (at your option) any later version. 33 * 34 * This program is distributed in the hope that it will be useful, 35 * but WITHOUT ANY WARRANTY; without even the implied warranty of 36 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 37 * GNU General Public License for more details. 38 * 39 * You should have received a copy of the GNU General Public License 40 * along with this program; if not, write to the Free Software 41 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 42 * 43 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * 44 * 45 * Hardware & software notes 46 * 47 * These remote controls are distributed by ATI as part of their 48 * "All-In-Wonder" video card packages. The receiver self-identifies as a 49 * "USB Receiver" with manufacturer "X10 Wireless Technology Inc". 50 * 51 * The "Lola" remote is available from X10. See: 52 * http://www.x10.com/products/lola_sg1.htm 53 * The Lola is similar to the ATI remote but has no mouse support, and slightly 54 * different keys. 55 * 56 * It is possible to use multiple receivers and remotes on multiple computers 57 * simultaneously by configuring them to use specific channels. 58 * 59 * The RF protocol used by the remote supports 16 distinct channels, 1 to 16. 60 * Actually, it may even support more, at least in some revisions of the 61 * hardware. 62 * 63 * Each remote can be configured to transmit on one channel as follows: 64 * - Press and hold the "hand icon" button. 65 * - When the red LED starts to blink, let go of the "hand icon" button. 66 * - When it stops blinking, input the channel code as two digits, from 01 67 * to 16, and press the hand icon again. 68 * 69 * The timing can be a little tricky. Try loading the module with debug=1 70 * to have the kernel print out messages about the remote control number 71 * and mask. Note: debugging prints remote numbers as zero-based hexadecimal. 72 * 73 * The driver has a "channel_mask" parameter. This bitmask specifies which 74 * channels will be ignored by the module. To mask out channels, just add 75 * all the 2^channel_number values together. 76 * 77 * For instance, set channel_mask = 2^4 = 16 (binary 10000) to make ati_remote 78 * ignore signals coming from remote controls transmitting on channel 4, but 79 * accept all other channels. 80 * 81 * Or, set channel_mask = 65533, (0xFFFD), and all channels except 1 will be 82 * ignored. 83 * 84 * The default is 0 (respond to all channels). Bit 0 and bits 17-32 of this 85 * parameter are unused. 86 * 87 */ 88 89#include <linux/kernel.h> 90#include <linux/errno.h> 91#include <linux/init.h> 92#include <linux/slab.h> 93#include <linux/module.h> 94#include <linux/mutex.h> 95#include <linux/usb/input.h> 96#include <linux/wait.h> 97#include <linux/jiffies.h> 98#include <media/rc-core.h> 99 100/* 101 * Module and Version Information, Module Parameters 102 */ 103 104#define ATI_REMOTE_VENDOR_ID 0x0bc7 105#define LOLA_REMOTE_PRODUCT_ID 0x0002 106#define LOLA2_REMOTE_PRODUCT_ID 0x0003 107#define ATI_REMOTE_PRODUCT_ID 0x0004 108#define NVIDIA_REMOTE_PRODUCT_ID 0x0005 109#define MEDION_REMOTE_PRODUCT_ID 0x0006 110#define FIREFLY_REMOTE_PRODUCT_ID 0x0008 111 112#define DRIVER_VERSION "2.2.1" 113#define DRIVER_AUTHOR "Torrey Hoffman <thoffman@arnor.net>" 114#define DRIVER_DESC "ATI/X10 RF USB Remote Control" 115 116#define NAME_BUFSIZE 80 /* size of product name, path buffers */ 117#define DATA_BUFSIZE 63 /* size of URB data buffers */ 118 119/* 120 * Duplicate event filtering time. 121 * Sequential, identical KIND_FILTERED inputs with less than 122 * FILTER_TIME milliseconds between them are considered as repeat 123 * events. The hardware generates 5 events for the first keypress 124 * and we have to take this into account for an accurate repeat 125 * behaviour. 126 */ 127#define FILTER_TIME 60 /* msec */ 128#define REPEAT_DELAY 500 /* msec */ 129 130static unsigned long channel_mask; 131module_param(channel_mask, ulong, 0644); 132MODULE_PARM_DESC(channel_mask, "Bitmask of remote control channels to ignore"); 133 134static int debug; 135module_param(debug, int, 0644); 136MODULE_PARM_DESC(debug, "Enable extra debug messages and information"); 137 138static int repeat_filter = FILTER_TIME; 139module_param(repeat_filter, int, 0644); 140MODULE_PARM_DESC(repeat_filter, "Repeat filter time, default = 60 msec"); 141 142static int repeat_delay = REPEAT_DELAY; 143module_param(repeat_delay, int, 0644); 144MODULE_PARM_DESC(repeat_delay, "Delay before sending repeats, default = 500 msec"); 145 146static bool mouse = true; 147module_param(mouse, bool, 0444); 148MODULE_PARM_DESC(mouse, "Enable mouse device, default = yes"); 149 150#define dbginfo(dev, format, arg...) \ 151 do { if (debug) dev_info(dev , format , ## arg); } while (0) 152#undef err 153#define err(format, arg...) printk(KERN_ERR format , ## arg) 154 155struct ati_receiver_type { 156 /* either default_keymap or get_default_keymap should be set */ 157 const char *default_keymap; 158 const char *(*get_default_keymap)(struct usb_interface *interface); 159}; 160 161static const char *get_medion_keymap(struct usb_interface *interface) 162{ 163 struct usb_device *udev = interface_to_usbdev(interface); 164 165 /* 166 * There are many different Medion remotes shipped with a receiver 167 * with the same usb id, but the receivers have subtle differences 168 * in the USB descriptors allowing us to detect them. 169 */ 170 171 if (udev->manufacturer && udev->product) { 172 if (udev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_WAKEUP) { 173 174 if (!strcmp(udev->manufacturer, "X10 Wireless Technology Inc") 175 && !strcmp(udev->product, "USB Receiver")) 176 return RC_MAP_MEDION_X10_DIGITAINER; 177 178 if (!strcmp(udev->manufacturer, "X10 WTI") 179 && !strcmp(udev->product, "RF receiver")) 180 return RC_MAP_MEDION_X10_OR2X; 181 } else { 182 183 if (!strcmp(udev->manufacturer, "X10 Wireless Technology Inc") 184 && !strcmp(udev->product, "USB Receiver")) 185 return RC_MAP_MEDION_X10; 186 } 187 } 188 189 dev_info(&interface->dev, 190 "Unknown Medion X10 receiver, using default ati_remote Medion keymap\n"); 191 192 return RC_MAP_MEDION_X10; 193} 194 195static const struct ati_receiver_type type_ati = { 196 .default_keymap = RC_MAP_ATI_X10 197}; 198static const struct ati_receiver_type type_medion = { 199 .get_default_keymap = get_medion_keymap 200}; 201static const struct ati_receiver_type type_firefly = { 202 .default_keymap = RC_MAP_SNAPSTREAM_FIREFLY 203}; 204 205static struct usb_device_id ati_remote_table[] = { 206 { 207 USB_DEVICE(ATI_REMOTE_VENDOR_ID, LOLA_REMOTE_PRODUCT_ID), 208 .driver_info = (unsigned long)&type_ati 209 }, 210 { 211 USB_DEVICE(ATI_REMOTE_VENDOR_ID, LOLA2_REMOTE_PRODUCT_ID), 212 .driver_info = (unsigned long)&type_ati 213 }, 214 { 215 USB_DEVICE(ATI_REMOTE_VENDOR_ID, ATI_REMOTE_PRODUCT_ID), 216 .driver_info = (unsigned long)&type_ati 217 }, 218 { 219 USB_DEVICE(ATI_REMOTE_VENDOR_ID, NVIDIA_REMOTE_PRODUCT_ID), 220 .driver_info = (unsigned long)&type_ati 221 }, 222 { 223 USB_DEVICE(ATI_REMOTE_VENDOR_ID, MEDION_REMOTE_PRODUCT_ID), 224 .driver_info = (unsigned long)&type_medion 225 }, 226 { 227 USB_DEVICE(ATI_REMOTE_VENDOR_ID, FIREFLY_REMOTE_PRODUCT_ID), 228 .driver_info = (unsigned long)&type_firefly 229 }, 230 {} /* Terminating entry */ 231}; 232 233MODULE_DEVICE_TABLE(usb, ati_remote_table); 234 235/* Get hi and low bytes of a 16-bits int */ 236#define HI(a) ((unsigned char)((a) >> 8)) 237#define LO(a) ((unsigned char)((a) & 0xff)) 238 239#define SEND_FLAG_IN_PROGRESS 1 240#define SEND_FLAG_COMPLETE 2 241 242/* Device initialization strings */ 243static char init1[] = { 0x01, 0x00, 0x20, 0x14 }; 244static char init2[] = { 0x01, 0x00, 0x20, 0x14, 0x20, 0x20, 0x20 }; 245 246struct ati_remote { 247 struct input_dev *idev; 248 struct rc_dev *rdev; 249 struct usb_device *udev; 250 struct usb_interface *interface; 251 252 struct urb *irq_urb; 253 struct urb *out_urb; 254 struct usb_endpoint_descriptor *endpoint_in; 255 struct usb_endpoint_descriptor *endpoint_out; 256 unsigned char *inbuf; 257 unsigned char *outbuf; 258 dma_addr_t inbuf_dma; 259 dma_addr_t outbuf_dma; 260 261 unsigned char old_data; /* Detect duplicate events */ 262 unsigned long old_jiffies; 263 unsigned long acc_jiffies; /* handle acceleration */ 264 unsigned long first_jiffies; 265 266 unsigned int repeat_count; 267 268 char rc_name[NAME_BUFSIZE]; 269 char rc_phys[NAME_BUFSIZE]; 270 char mouse_name[NAME_BUFSIZE]; 271 char mouse_phys[NAME_BUFSIZE]; 272 273 wait_queue_head_t wait; 274 int send_flags; 275 276 int users; /* 0-2, users are rc and input */ 277 struct mutex open_mutex; 278}; 279 280/* "Kinds" of messages sent from the hardware to the driver. */ 281#define KIND_END 0 282#define KIND_LITERAL 1 /* Simply pass to input system as EV_KEY */ 283#define KIND_FILTERED 2 /* Add artificial key-up events, drop keyrepeats */ 284#define KIND_ACCEL 3 /* Translate to EV_REL mouse-move events */ 285 286/* Translation table from hardware messages to input events. */ 287static const struct { 288 unsigned char kind; 289 unsigned char data; /* Raw key code from remote */ 290 unsigned short code; /* Input layer translation */ 291} ati_remote_tbl[] = { 292 /* Directional control pad axes. Code is xxyy */ 293 {KIND_ACCEL, 0x70, 0xff00}, /* left */ 294 {KIND_ACCEL, 0x71, 0x0100}, /* right */ 295 {KIND_ACCEL, 0x72, 0x00ff}, /* up */ 296 {KIND_ACCEL, 0x73, 0x0001}, /* down */ 297 298 /* Directional control pad diagonals */ 299 {KIND_ACCEL, 0x74, 0xffff}, /* left up */ 300 {KIND_ACCEL, 0x75, 0x01ff}, /* right up */ 301 {KIND_ACCEL, 0x77, 0xff01}, /* left down */ 302 {KIND_ACCEL, 0x76, 0x0101}, /* right down */ 303 304 /* "Mouse button" buttons. The code below uses the fact that the 305 * lsbit of the raw code is a down/up indicator. */ 306 {KIND_LITERAL, 0x78, BTN_LEFT}, /* left btn down */ 307 {KIND_LITERAL, 0x79, BTN_LEFT}, /* left btn up */ 308 {KIND_LITERAL, 0x7c, BTN_RIGHT},/* right btn down */ 309 {KIND_LITERAL, 0x7d, BTN_RIGHT},/* right btn up */ 310 311 /* Artificial "doubleclick" events are generated by the hardware. 312 * They are mapped to the "side" and "extra" mouse buttons here. */ 313 {KIND_FILTERED, 0x7a, BTN_SIDE}, /* left dblclick */ 314 {KIND_FILTERED, 0x7e, BTN_EXTRA},/* right dblclick */ 315 316 /* Non-mouse events are handled by rc-core */ 317 {KIND_END, 0x00, 0} 318}; 319 320/* 321 * ati_remote_dump_input 322 */ 323static void ati_remote_dump(struct device *dev, unsigned char *data, 324 unsigned int len) 325{ 326 if (len == 1) { 327 if (data[0] != (unsigned char)0xff && data[0] != 0x00) 328 dev_warn(dev, "Weird byte 0x%02x\n", data[0]); 329 } else if (len == 4) 330 dev_warn(dev, "Weird key %*ph\n", 4, data); 331 else 332 dev_warn(dev, "Weird data, len=%d %*ph ...\n", len, 6, data); 333} 334 335/* 336 * ati_remote_open 337 */ 338static int ati_remote_open(struct ati_remote *ati_remote) 339{ 340 int err = 0; 341 342 mutex_lock(&ati_remote->open_mutex); 343 344 if (ati_remote->users++ != 0) 345 goto out; /* one was already active */ 346 347 /* On first open, submit the read urb which was set up previously. */ 348 ati_remote->irq_urb->dev = ati_remote->udev; 349 if (usb_submit_urb(ati_remote->irq_urb, GFP_KERNEL)) { 350 dev_err(&ati_remote->interface->dev, 351 "%s: usb_submit_urb failed!\n", __func__); 352 err = -EIO; 353 } 354 355out: mutex_unlock(&ati_remote->open_mutex); 356 return err; 357} 358 359/* 360 * ati_remote_close 361 */ 362static void ati_remote_close(struct ati_remote *ati_remote) 363{ 364 mutex_lock(&ati_remote->open_mutex); 365 if (--ati_remote->users == 0) 366 usb_kill_urb(ati_remote->irq_urb); 367 mutex_unlock(&ati_remote->open_mutex); 368} 369 370static int ati_remote_input_open(struct input_dev *inputdev) 371{ 372 struct ati_remote *ati_remote = input_get_drvdata(inputdev); 373 return ati_remote_open(ati_remote); 374} 375 376static void ati_remote_input_close(struct input_dev *inputdev) 377{ 378 struct ati_remote *ati_remote = input_get_drvdata(inputdev); 379 ati_remote_close(ati_remote); 380} 381 382static int ati_remote_rc_open(struct rc_dev *rdev) 383{ 384 struct ati_remote *ati_remote = rdev->priv; 385 return ati_remote_open(ati_remote); 386} 387 388static void ati_remote_rc_close(struct rc_dev *rdev) 389{ 390 struct ati_remote *ati_remote = rdev->priv; 391 ati_remote_close(ati_remote); 392} 393 394/* 395 * ati_remote_irq_out 396 */ 397static void ati_remote_irq_out(struct urb *urb) 398{ 399 struct ati_remote *ati_remote = urb->context; 400 401 if (urb->status) { 402 dev_dbg(&ati_remote->interface->dev, "%s: status %d\n", 403 __func__, urb->status); 404 return; 405 } 406 407 ati_remote->send_flags |= SEND_FLAG_COMPLETE; 408 wmb(); 409 wake_up(&ati_remote->wait); 410} 411 412/* 413 * ati_remote_sendpacket 414 * 415 * Used to send device initialization strings 416 */ 417static int ati_remote_sendpacket(struct ati_remote *ati_remote, u16 cmd, 418 unsigned char *data) 419{ 420 int retval = 0; 421 422 /* Set up out_urb */ 423 memcpy(ati_remote->out_urb->transfer_buffer + 1, data, LO(cmd)); 424 ((char *) ati_remote->out_urb->transfer_buffer)[0] = HI(cmd); 425 426 ati_remote->out_urb->transfer_buffer_length = LO(cmd) + 1; 427 ati_remote->out_urb->dev = ati_remote->udev; 428 ati_remote->send_flags = SEND_FLAG_IN_PROGRESS; 429 430 retval = usb_submit_urb(ati_remote->out_urb, GFP_ATOMIC); 431 if (retval) { 432 dev_dbg(&ati_remote->interface->dev, 433 "sendpacket: usb_submit_urb failed: %d\n", retval); 434 return retval; 435 } 436 437 wait_event_timeout(ati_remote->wait, 438 ((ati_remote->out_urb->status != -EINPROGRESS) || 439 (ati_remote->send_flags & SEND_FLAG_COMPLETE)), 440 HZ); 441 usb_kill_urb(ati_remote->out_urb); 442 443 return retval; 444} 445 446/* 447 * ati_remote_compute_accel 448 * 449 * Implements acceleration curve for directional control pad 450 * If elapsed time since last event is > 1/4 second, user "stopped", 451 * so reset acceleration. Otherwise, user is probably holding the control 452 * pad down, so we increase acceleration, ramping up over two seconds to 453 * a maximum speed. 454 */ 455static int ati_remote_compute_accel(struct ati_remote *ati_remote) 456{ 457 static const char accel[] = { 1, 2, 4, 6, 9, 13, 20 }; 458 unsigned long now = jiffies; 459 int acc; 460 461 if (time_after(now, ati_remote->old_jiffies + msecs_to_jiffies(250))) { 462 acc = 1; 463 ati_remote->acc_jiffies = now; 464 } 465 else if (time_before(now, ati_remote->acc_jiffies + msecs_to_jiffies(125))) 466 acc = accel[0]; 467 else if (time_before(now, ati_remote->acc_jiffies + msecs_to_jiffies(250))) 468 acc = accel[1]; 469 else if (time_before(now, ati_remote->acc_jiffies + msecs_to_jiffies(500))) 470 acc = accel[2]; 471 else if (time_before(now, ati_remote->acc_jiffies + msecs_to_jiffies(1000))) 472 acc = accel[3]; 473 else if (time_before(now, ati_remote->acc_jiffies + msecs_to_jiffies(1500))) 474 acc = accel[4]; 475 else if (time_before(now, ati_remote->acc_jiffies + msecs_to_jiffies(2000))) 476 acc = accel[5]; 477 else 478 acc = accel[6]; 479 480 return acc; 481} 482 483/* 484 * ati_remote_report_input 485 */ 486static void ati_remote_input_report(struct urb *urb) 487{ 488 struct ati_remote *ati_remote = urb->context; 489 unsigned char *data= ati_remote->inbuf; 490 struct input_dev *dev = ati_remote->idev; 491 int index = -1; 492 int remote_num; 493 unsigned char scancode; 494 u32 wheel_keycode = KEY_RESERVED; 495 int i; 496 497 /* 498 * data[0] = 0x14 499 * data[1] = data[2] + data[3] + 0xd5 (a checksum byte) 500 * data[2] = the key code (with toggle bit in MSB with some models) 501 * data[3] = channel << 4 (the low 4 bits must be zero) 502 */ 503 504 /* Deal with strange looking inputs */ 505 if ( urb->actual_length != 4 || data[0] != 0x14 || 506 data[1] != (unsigned char)(data[2] + data[3] + 0xD5) || 507 (data[3] & 0x0f) != 0x00) { 508 ati_remote_dump(&urb->dev->dev, data, urb->actual_length); 509 return; 510 } 511 512 if (data[1] != ((data[2] + data[3] + 0xd5) & 0xff)) { 513 dbginfo(&ati_remote->interface->dev, 514 "wrong checksum in input: %*ph\n", 4, data); 515 return; 516 } 517 518 /* Mask unwanted remote channels. */ 519 /* note: remote_num is 0-based, channel 1 on remote == 0 here */ 520 remote_num = (data[3] >> 4) & 0x0f; 521 if (channel_mask & (1 << (remote_num + 1))) { 522 dbginfo(&ati_remote->interface->dev, 523 "Masked input from channel 0x%02x: data %02x, " 524 "mask= 0x%02lx\n", 525 remote_num, data[2], channel_mask); 526 return; 527 } 528 529 /* 530 * MSB is a toggle code, though only used by some devices 531 * (e.g. SnapStream Firefly) 532 */ 533 scancode = data[2] & 0x7f; 534 535 dbginfo(&ati_remote->interface->dev, 536 "channel 0x%02x; key data %02x, scancode %02x\n", 537 remote_num, data[2], scancode); 538 539 if (scancode >= 0x70) { 540 /* 541 * This is either a mouse or scrollwheel event, depending on 542 * the remote/keymap. 543 * Get the keycode assigned to scancode 0x78/0x70. If it is 544 * set, assume this is a scrollwheel up/down event. 545 */ 546 wheel_keycode = rc_g_keycode_from_table(ati_remote->rdev, 547 scancode & 0x78); 548 549 if (wheel_keycode == KEY_RESERVED) { 550 /* scrollwheel was not mapped, assume mouse */ 551 552 /* Look up event code index in the mouse translation 553 * table. 554 */ 555 for (i = 0; ati_remote_tbl[i].kind != KIND_END; i++) { 556 if (scancode == ati_remote_tbl[i].data) { 557 index = i; 558 break; 559 } 560 } 561 } 562 } 563 564 if (index >= 0 && ati_remote_tbl[index].kind == KIND_LITERAL) { 565 /* 566 * The lsbit of the raw key code is a down/up flag. 567 * Invert it to match the input layer's conventions. 568 */ 569 input_event(dev, EV_KEY, ati_remote_tbl[index].code, 570 !(data[2] & 1)); 571 572 ati_remote->old_jiffies = jiffies; 573 574 } else if (index < 0 || ati_remote_tbl[index].kind == KIND_FILTERED) { 575 unsigned long now = jiffies; 576 577 /* Filter duplicate events which happen "too close" together. */ 578 if (ati_remote->old_data == data[2] && 579 time_before(now, ati_remote->old_jiffies + 580 msecs_to_jiffies(repeat_filter))) { 581 ati_remote->repeat_count++; 582 } else { 583 ati_remote->repeat_count = 0; 584 ati_remote->first_jiffies = now; 585 } 586 587 ati_remote->old_jiffies = now; 588 589 /* Ensure we skip at least the 4 first duplicate events 590 * (generated by a single keypress), and continue skipping 591 * until repeat_delay msecs have passed. 592 */ 593 if (ati_remote->repeat_count > 0 && 594 (ati_remote->repeat_count < 5 || 595 time_before(now, ati_remote->first_jiffies + 596 msecs_to_jiffies(repeat_delay)))) 597 return; 598 599 if (index >= 0) { 600 input_event(dev, EV_KEY, ati_remote_tbl[index].code, 1); 601 input_event(dev, EV_KEY, ati_remote_tbl[index].code, 0); 602 } else { 603 /* Not a mouse event, hand it to rc-core. */ 604 int count = 1; 605 606 if (wheel_keycode != KEY_RESERVED) { 607 /* 608 * This is a scrollwheel event, send the 609 * scroll up (0x78) / down (0x70) scancode 610 * repeatedly as many times as indicated by 611 * rest of the scancode. 612 */ 613 count = (scancode & 0x07) + 1; 614 scancode &= 0x78; 615 } 616 617 while (count--) { 618 /* 619 * We don't use the rc-core repeat handling yet as 620 * it would cause ghost repeats which would be a 621 * regression for this driver. 622 */ 623 rc_keydown_notimeout(ati_remote->rdev, RC_TYPE_OTHER, 624 scancode, data[2]); 625 rc_keyup(ati_remote->rdev); 626 } 627 goto nosync; 628 } 629 630 } else if (ati_remote_tbl[index].kind == KIND_ACCEL) { 631 signed char dx = ati_remote_tbl[index].code >> 8; 632 signed char dy = ati_remote_tbl[index].code & 255; 633 634 /* 635 * Other event kinds are from the directional control pad, and 636 * have an acceleration factor applied to them. Without this 637 * acceleration, the control pad is mostly unusable. 638 */ 639 int acc = ati_remote_compute_accel(ati_remote); 640 if (dx) 641 input_report_rel(dev, REL_X, dx * acc); 642 if (dy) 643 input_report_rel(dev, REL_Y, dy * acc); 644 ati_remote->old_jiffies = jiffies; 645 646 } else { 647 dev_dbg(&ati_remote->interface->dev, "ati_remote kind=%d\n", 648 ati_remote_tbl[index].kind); 649 return; 650 } 651 input_sync(dev); 652nosync: 653 ati_remote->old_data = data[2]; 654} 655 656/* 657 * ati_remote_irq_in 658 */ 659static void ati_remote_irq_in(struct urb *urb) 660{ 661 struct ati_remote *ati_remote = urb->context; 662 int retval; 663 664 switch (urb->status) { 665 case 0: /* success */ 666 ati_remote_input_report(urb); 667 break; 668 case -ECONNRESET: /* unlink */ 669 case -ENOENT: 670 case -ESHUTDOWN: 671 dev_dbg(&ati_remote->interface->dev, 672 "%s: urb error status, unlink?\n", 673 __func__); 674 return; 675 default: /* error */ 676 dev_dbg(&ati_remote->interface->dev, 677 "%s: Nonzero urb status %d\n", 678 __func__, urb->status); 679 } 680 681 retval = usb_submit_urb(urb, GFP_ATOMIC); 682 if (retval) 683 dev_err(&ati_remote->interface->dev, 684 "%s: usb_submit_urb()=%d\n", 685 __func__, retval); 686} 687 688/* 689 * ati_remote_alloc_buffers 690 */ 691static int ati_remote_alloc_buffers(struct usb_device *udev, 692 struct ati_remote *ati_remote) 693{ 694 ati_remote->inbuf = usb_alloc_coherent(udev, DATA_BUFSIZE, GFP_ATOMIC, 695 &ati_remote->inbuf_dma); 696 if (!ati_remote->inbuf) 697 return -1; 698 699 ati_remote->outbuf = usb_alloc_coherent(udev, DATA_BUFSIZE, GFP_ATOMIC, 700 &ati_remote->outbuf_dma); 701 if (!ati_remote->outbuf) 702 return -1; 703 704 ati_remote->irq_urb = usb_alloc_urb(0, GFP_KERNEL); 705 if (!ati_remote->irq_urb) 706 return -1; 707 708 ati_remote->out_urb = usb_alloc_urb(0, GFP_KERNEL); 709 if (!ati_remote->out_urb) 710 return -1; 711 712 return 0; 713} 714 715/* 716 * ati_remote_free_buffers 717 */ 718static void ati_remote_free_buffers(struct ati_remote *ati_remote) 719{ 720 usb_free_urb(ati_remote->irq_urb); 721 usb_free_urb(ati_remote->out_urb); 722 723 usb_free_coherent(ati_remote->udev, DATA_BUFSIZE, 724 ati_remote->inbuf, ati_remote->inbuf_dma); 725 726 usb_free_coherent(ati_remote->udev, DATA_BUFSIZE, 727 ati_remote->outbuf, ati_remote->outbuf_dma); 728} 729 730static void ati_remote_input_init(struct ati_remote *ati_remote) 731{ 732 struct input_dev *idev = ati_remote->idev; 733 int i; 734 735 idev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REL); 736 idev->keybit[BIT_WORD(BTN_MOUSE)] = BIT_MASK(BTN_LEFT) | 737 BIT_MASK(BTN_RIGHT) | BIT_MASK(BTN_SIDE) | BIT_MASK(BTN_EXTRA); 738 idev->relbit[0] = BIT_MASK(REL_X) | BIT_MASK(REL_Y); 739 for (i = 0; ati_remote_tbl[i].kind != KIND_END; i++) 740 if (ati_remote_tbl[i].kind == KIND_LITERAL || 741 ati_remote_tbl[i].kind == KIND_FILTERED) 742 __set_bit(ati_remote_tbl[i].code, idev->keybit); 743 744 input_set_drvdata(idev, ati_remote); 745 746 idev->open = ati_remote_input_open; 747 idev->close = ati_remote_input_close; 748 749 idev->name = ati_remote->mouse_name; 750 idev->phys = ati_remote->mouse_phys; 751 752 usb_to_input_id(ati_remote->udev, &idev->id); 753 idev->dev.parent = &ati_remote->interface->dev; 754} 755 756static void ati_remote_rc_init(struct ati_remote *ati_remote) 757{ 758 struct rc_dev *rdev = ati_remote->rdev; 759 760 rdev->priv = ati_remote; 761 rdev->driver_type = RC_DRIVER_SCANCODE; 762 rdev->allowed_protocols = RC_BIT_OTHER; 763 rdev->driver_name = "ati_remote"; 764 765 rdev->open = ati_remote_rc_open; 766 rdev->close = ati_remote_rc_close; 767 768 rdev->input_name = ati_remote->rc_name; 769 rdev->input_phys = ati_remote->rc_phys; 770 771 usb_to_input_id(ati_remote->udev, &rdev->input_id); 772 rdev->dev.parent = &ati_remote->interface->dev; 773} 774 775static int ati_remote_initialize(struct ati_remote *ati_remote) 776{ 777 struct usb_device *udev = ati_remote->udev; 778 int pipe, maxp; 779 780 init_waitqueue_head(&ati_remote->wait); 781 782 /* Set up irq_urb */ 783 pipe = usb_rcvintpipe(udev, ati_remote->endpoint_in->bEndpointAddress); 784 maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe)); 785 maxp = (maxp > DATA_BUFSIZE) ? DATA_BUFSIZE : maxp; 786 787 usb_fill_int_urb(ati_remote->irq_urb, udev, pipe, ati_remote->inbuf, 788 maxp, ati_remote_irq_in, ati_remote, 789 ati_remote->endpoint_in->bInterval); 790 ati_remote->irq_urb->transfer_dma = ati_remote->inbuf_dma; 791 ati_remote->irq_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP; 792 793 /* Set up out_urb */ 794 pipe = usb_sndintpipe(udev, ati_remote->endpoint_out->bEndpointAddress); 795 maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe)); 796 maxp = (maxp > DATA_BUFSIZE) ? DATA_BUFSIZE : maxp; 797 798 usb_fill_int_urb(ati_remote->out_urb, udev, pipe, ati_remote->outbuf, 799 maxp, ati_remote_irq_out, ati_remote, 800 ati_remote->endpoint_out->bInterval); 801 ati_remote->out_urb->transfer_dma = ati_remote->outbuf_dma; 802 ati_remote->out_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP; 803 804 /* send initialization strings */ 805 if ((ati_remote_sendpacket(ati_remote, 0x8004, init1)) || 806 (ati_remote_sendpacket(ati_remote, 0x8007, init2))) { 807 dev_err(&ati_remote->interface->dev, 808 "Initializing ati_remote hardware failed.\n"); 809 return -EIO; 810 } 811 812 return 0; 813} 814 815/* 816 * ati_remote_probe 817 */ 818static int ati_remote_probe(struct usb_interface *interface, 819 const struct usb_device_id *id) 820{ 821 struct usb_device *udev = interface_to_usbdev(interface); 822 struct usb_host_interface *iface_host = interface->cur_altsetting; 823 struct usb_endpoint_descriptor *endpoint_in, *endpoint_out; 824 struct ati_receiver_type *type = (struct ati_receiver_type *)id->driver_info; 825 struct ati_remote *ati_remote; 826 struct input_dev *input_dev; 827 struct rc_dev *rc_dev; 828 int err = -ENOMEM; 829 830 if (iface_host->desc.bNumEndpoints != 2) { 831 err("%s: Unexpected desc.bNumEndpoints\n", __func__); 832 return -ENODEV; 833 } 834 835 endpoint_in = &iface_host->endpoint[0].desc; 836 endpoint_out = &iface_host->endpoint[1].desc; 837 838 if (!usb_endpoint_is_int_in(endpoint_in)) { 839 err("%s: Unexpected endpoint_in\n", __func__); 840 return -ENODEV; 841 } 842 if (le16_to_cpu(endpoint_in->wMaxPacketSize) == 0) { 843 err("%s: endpoint_in message size==0? \n", __func__); 844 return -ENODEV; 845 } 846 847 ati_remote = kzalloc(sizeof (struct ati_remote), GFP_KERNEL); 848 rc_dev = rc_allocate_device(); 849 if (!ati_remote || !rc_dev) 850 goto exit_free_dev_rdev; 851 852 /* Allocate URB buffers, URBs */ 853 if (ati_remote_alloc_buffers(udev, ati_remote)) 854 goto exit_free_buffers; 855 856 ati_remote->endpoint_in = endpoint_in; 857 ati_remote->endpoint_out = endpoint_out; 858 ati_remote->udev = udev; 859 ati_remote->rdev = rc_dev; 860 ati_remote->interface = interface; 861 862 usb_make_path(udev, ati_remote->rc_phys, sizeof(ati_remote->rc_phys)); 863 strlcpy(ati_remote->mouse_phys, ati_remote->rc_phys, 864 sizeof(ati_remote->mouse_phys)); 865 866 strlcat(ati_remote->rc_phys, "/input0", sizeof(ati_remote->rc_phys)); 867 strlcat(ati_remote->mouse_phys, "/input1", sizeof(ati_remote->mouse_phys)); 868 869 if (udev->manufacturer) 870 strlcpy(ati_remote->rc_name, udev->manufacturer, 871 sizeof(ati_remote->rc_name)); 872 873 if (udev->product) 874 snprintf(ati_remote->rc_name, sizeof(ati_remote->rc_name), 875 "%s %s", ati_remote->rc_name, udev->product); 876 877 if (!strlen(ati_remote->rc_name)) 878 snprintf(ati_remote->rc_name, sizeof(ati_remote->rc_name), 879 DRIVER_DESC "(%04x,%04x)", 880 le16_to_cpu(ati_remote->udev->descriptor.idVendor), 881 le16_to_cpu(ati_remote->udev->descriptor.idProduct)); 882 883 snprintf(ati_remote->mouse_name, sizeof(ati_remote->mouse_name), 884 "%s mouse", ati_remote->rc_name); 885 886 rc_dev->map_name = RC_MAP_ATI_X10; /* default map */ 887 888 /* set default keymap according to receiver model */ 889 if (type) { 890 if (type->default_keymap) 891 rc_dev->map_name = type->default_keymap; 892 else if (type->get_default_keymap) 893 rc_dev->map_name = type->get_default_keymap(interface); 894 } 895 896 ati_remote_rc_init(ati_remote); 897 mutex_init(&ati_remote->open_mutex); 898 899 /* Device Hardware Initialization - fills in ati_remote->idev from udev. */ 900 err = ati_remote_initialize(ati_remote); 901 if (err) 902 goto exit_kill_urbs; 903 904 /* Set up and register rc device */ 905 err = rc_register_device(ati_remote->rdev); 906 if (err) 907 goto exit_kill_urbs; 908 909 /* use our delay for rc_dev */ 910 ati_remote->rdev->input_dev->rep[REP_DELAY] = repeat_delay; 911 912 /* Set up and register mouse input device */ 913 if (mouse) { 914 input_dev = input_allocate_device(); 915 if (!input_dev) { 916 err = -ENOMEM; 917 goto exit_unregister_device; 918 } 919 920 ati_remote->idev = input_dev; 921 ati_remote_input_init(ati_remote); 922 err = input_register_device(input_dev); 923 924 if (err) 925 goto exit_free_input_device; 926 } 927 928 usb_set_intfdata(interface, ati_remote); 929 return 0; 930 931 exit_free_input_device: 932 input_free_device(input_dev); 933 exit_unregister_device: 934 rc_unregister_device(rc_dev); 935 rc_dev = NULL; 936 exit_kill_urbs: 937 usb_kill_urb(ati_remote->irq_urb); 938 usb_kill_urb(ati_remote->out_urb); 939 exit_free_buffers: 940 ati_remote_free_buffers(ati_remote); 941 exit_free_dev_rdev: 942 rc_free_device(rc_dev); 943 kfree(ati_remote); 944 return err; 945} 946 947/* 948 * ati_remote_disconnect 949 */ 950static void ati_remote_disconnect(struct usb_interface *interface) 951{ 952 struct ati_remote *ati_remote; 953 954 ati_remote = usb_get_intfdata(interface); 955 usb_set_intfdata(interface, NULL); 956 if (!ati_remote) { 957 dev_warn(&interface->dev, "%s - null device?\n", __func__); 958 return; 959 } 960 961 usb_kill_urb(ati_remote->irq_urb); 962 usb_kill_urb(ati_remote->out_urb); 963 if (ati_remote->idev) 964 input_unregister_device(ati_remote->idev); 965 rc_unregister_device(ati_remote->rdev); 966 ati_remote_free_buffers(ati_remote); 967 kfree(ati_remote); 968} 969 970/* usb specific object to register with the usb subsystem */ 971static struct usb_driver ati_remote_driver = { 972 .name = "ati_remote", 973 .probe = ati_remote_probe, 974 .disconnect = ati_remote_disconnect, 975 .id_table = ati_remote_table, 976}; 977 978module_usb_driver(ati_remote_driver); 979 980MODULE_AUTHOR(DRIVER_AUTHOR); 981MODULE_DESCRIPTION(DRIVER_DESC); 982MODULE_LICENSE("GPL"); 983