drivers/usb/input/ati_remote.c

   1 /*
   2  *  USB ATI Remote support
   3  *
   4  *  Version 2.2.0 Copyright (c) 2004 Torrey Hoffman <thoffman@arnor.net>
   5  *  Version 2.1.1 Copyright (c) 2002 Vladimir Dergachev
   6  *
   7  *  This 2.2.0 version is a rewrite / cleanup of the 2.1.1 driver, including
   8  *  porting to the 2.6 kernel interfaces, along with other modification
   9  *  to better match the style of the existing usb/input drivers.  However, the
  10  *  protocol and hardware handling is essentially unchanged from 2.1.1.
  11  *
  12  *  The 2.1.1 driver was derived from the usbati_remote and usbkbd drivers by
  13  *  Vojtech Pavlik.
  14  *
  15  *  Changes:
  16  *
  17  *  Feb 2004: Torrey Hoffman <thoffman@arnor.net>
  18  *            Version 2.2.0
  19  *  Jun 2004: Torrey Hoffman <thoffman@arnor.net>
  20  *            Version 2.2.1
  21  *            Added key repeat support contributed by:
  22  *                Vincent Vanackere <vanackere@lif.univ-mrs.fr>
  23  *            Added support for the "Lola" remote contributed by:
  24  *                Seth Cohn <sethcohn@yahoo.com>
  25  *
  26  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  27  *
  28  * This program is free software; you can redistribute it and/or modify
  29  * it under the terms of the GNU General Public License as published by
  30  * the Free Software Foundation; either version 2 of the License, or
  31  * (at your option) any later version.
  32  *
  33  * This program is distributed in the hope that it will be useful,
  34  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  35  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  36  * GNU General Public License for more details.
  37  *
  38  * You should have received a copy of the GNU General Public License
  39  * along with this program; if not, write to the Free Software
  40  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  41  *
  42  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  43  *
  44  * Hardware & software notes
  45  *
  46  * These remote controls are distributed by ATI as part of their
  47  * "All-In-Wonder" video card packages.  The receiver self-identifies as a
  48  * "USB Receiver" with manufacturer "X10 Wireless Technology Inc".
  49  *
  50  * The "Lola" remote is available from X10.  See:
  51  *    http://www.x10.com/products/lola_sg1.htm
  52  * The Lola is similar to the ATI remote but has no mouse support, and slightly
  53  * different keys.
  54  *
  55  * It is possible to use multiple receivers and remotes on multiple computers
  56  * simultaneously by configuring them to use specific channels.
  57  *
  58  * The RF protocol used by the remote supports 16 distinct channels, 1 to 16.
  59  * Actually, it may even support more, at least in some revisions of the
  60  * hardware.
  61  *
  62  * Each remote can be configured to transmit on one channel as follows:
  63  *   - Press and hold the "hand icon" button.
  64  *   - When the red LED starts to blink, let go of the "hand icon" button.
  65  *   - When it stops blinking, input the channel code as two digits, from 01
  66  *     to 16, and press the hand icon again.
  67  *
  68  * The timing can be a little tricky.  Try loading the module with debug=1
  69  * to have the kernel print out messages about the remote control number
  70  * and mask.  Note: debugging prints remote numbers as zero-based hexadecimal.
  71  *
  72  * The driver has a "channel_mask" parameter. This bitmask specifies which
  73  * channels will be ignored by the module.  To mask out channels, just add
  74  * all the 2^channel_number values together.
  75  *
  76  * For instance, set channel_mask = 2^4 = 16 (binary 10000) to make ati_remote
  77  * ignore signals coming from remote controls transmitting on channel 4, but
  78  * accept all other channels.
  79  *
  80  * Or, set channel_mask = 65533, (0xFFFD), and all channels except 1 will be
  81  * ignored.
  82  *
  83  * The default is 0 (respond to all channels). Bit 0 and bits 17-32 of this
  84  * parameter are unused.
  85  *
  86  */
  87
  88 #include <linux/config.h>
  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/moduleparam.h>
  95 #include <linux/input.h>
  96 #include <linux/usb.h>
  97
  98 /*
  99  * Module and Version Information, Module Parameters
 100  */
 101
 102 #define ATI_REMOTE_VENDOR_ID    0x0bc7
 103 #define ATI_REMOTE_PRODUCT_ID   0x004
 104 #define LOLA_REMOTE_PRODUCT_ID  0x002
 105 #define MEDION_REMOTE_PRODUCT_ID 0x006
 106
 107 #define DRIVER_VERSION          "2.2.1"
 108 #define DRIVER_AUTHOR           "Torrey Hoffman <thoffman@arnor.net>"
 109 #define DRIVER_DESC             "ATI/X10 RF USB Remote Control"
 110
 111 #define NAME_BUFSIZE      80    /* size of product name, path buffers */
 112 #define DATA_BUFSIZE      63    /* size of URB data buffers */
 113 #define ATI_INPUTNUM      1     /* Which input device to register as */
 114
 115 static unsigned long channel_mask = 0;
 116 module_param(channel_mask, ulong, 0444);
 117 MODULE_PARM_DESC(channel_mask, "Bitmask of remote control channels to ignore");
 118
 119 static int debug = 0;
 120 module_param(debug, int, 0444);
 121 MODULE_PARM_DESC(debug, "Enable extra debug messages and information");
 122
 123 #define dbginfo(dev, format, arg...) do { if (debug) dev_info(dev , format , ## arg); } while (0)
 124 #undef err
 125 #define err(format, arg...) printk(KERN_ERR format , ## arg)
 126
 127 static struct usb_device_id ati_remote_table[] = {
 128         { USB_DEVICE(ATI_REMOTE_VENDOR_ID, ATI_REMOTE_PRODUCT_ID) },
 129         { USB_DEVICE(ATI_REMOTE_VENDOR_ID, LOLA_REMOTE_PRODUCT_ID) },
 130         { USB_DEVICE(ATI_REMOTE_VENDOR_ID, MEDION_REMOTE_PRODUCT_ID) },
 131         {}      /* Terminating entry */
 132 };
 133
 134 MODULE_DEVICE_TABLE(usb, ati_remote_table);
 135
 136 /* Get hi and low bytes of a 16-bits int */
 137 #define HI(a)   ((unsigned char)((a) >> 8))
 138 #define LO(a)   ((unsigned char)((a) & 0xff))
 139
 140 #define SEND_FLAG_IN_PROGRESS   1
 141 #define SEND_FLAG_COMPLETE      2
 142
 143 /* Device initialization strings */
 144 static char init1[] = { 0x01, 0x00, 0x20, 0x14 };
 145 static char init2[] = { 0x01, 0x00, 0x20, 0x14, 0x20, 0x20, 0x20 };
 146
 147 /* Acceleration curve for directional control pad */
 148 static char accel[] = { 1, 2, 4, 6, 9, 13, 20 };
 149
 150 /* Duplicate event filtering time.
 151  * Sequential, identical KIND_FILTERED inputs with less than
 152  * FILTER_TIME jiffies between them are considered as repeat
 153  * events. The hardware generates 5 events for the first keypress
 154  * and we have to take this into account for an accurate repeat
 155  * behaviour.
 156  * (HZ / 20) == 50 ms and works well for me.
 157  */
 158 #define FILTER_TIME (HZ / 20)
 159
 160 static DECLARE_MUTEX(disconnect_sem);
 161
 162 struct ati_remote {
 163         struct input_dev idev;
 164         struct usb_device *udev;
 165         struct usb_interface *interface;
 166
 167         struct urb *irq_urb;
 168         struct urb *out_urb;
 169         struct usb_endpoint_descriptor *endpoint_in;
 170         struct usb_endpoint_descriptor *endpoint_out;
 171         unsigned char *inbuf;
 172         unsigned char *outbuf;
 173         dma_addr_t inbuf_dma;
 174         dma_addr_t outbuf_dma;
 175
 176         int open;                   /* open counter */
 177         int present;                /* device plugged in? */
 178
 179         unsigned char old_data[2];  /* Detect duplicate events */
 180         unsigned long old_jiffies;
 181         unsigned long acc_jiffies;  /* handle acceleration */
 182         unsigned int repeat_count;
 183
 184         char name[NAME_BUFSIZE];
 185         char phys[NAME_BUFSIZE];
 186
 187         wait_queue_head_t wait;
 188         int send_flags;
 189 };
 190
 191 /* "Kinds" of messages sent from the hardware to the driver. */
 192 #define KIND_END        0
 193 #define KIND_LITERAL    1   /* Simply pass to input system */
 194 #define KIND_FILTERED   2   /* Add artificial key-up events, drop keyrepeats */
 195 #define KIND_LU         3   /* Directional keypad diagonals - left up, */
 196 #define KIND_RU         4   /*   right up,  */
 197 #define KIND_LD         5   /*   left down, */
 198 #define KIND_RD         6   /*   right down */
 199 #define KIND_ACCEL      7   /* Directional keypad - left, right, up, down.*/
 200
 201 /* Translation table from hardware messages to input events. */
 202 static struct
 203 {
 204         short kind;
 205         unsigned char data1, data2;
 206         int type;
 207         unsigned int code;
 208         int value;
 209 }  ati_remote_tbl[] =
 210 {
 211         /* Directional control pad axes */
 212         {KIND_ACCEL,   0x35, 0x70, EV_REL, REL_X, -1},   /* left */
 213         {KIND_ACCEL,   0x36, 0x71, EV_REL, REL_X, 1},    /* right */
 214         {KIND_ACCEL,   0x37, 0x72, EV_REL, REL_Y, -1},   /* up */
 215         {KIND_ACCEL,   0x38, 0x73, EV_REL, REL_Y, 1},    /* down */
 216         /* Directional control pad diagonals */
 217         {KIND_LU,      0x39, 0x74, EV_REL, 0, 0},        /* left up */
 218         {KIND_RU,      0x3a, 0x75, EV_REL, 0, 0},        /* right up */
 219         {KIND_LD,      0x3c, 0x77, EV_REL, 0, 0},        /* left down */
 220         {KIND_RD,      0x3b, 0x76, EV_REL, 0, 0},        /* right down */
 221
 222         /* "Mouse button" buttons */
 223         {KIND_LITERAL, 0x3d, 0x78, EV_KEY, BTN_LEFT, 1}, /* left btn down */
 224         {KIND_LITERAL, 0x3e, 0x79, EV_KEY, BTN_LEFT, 0}, /* left btn up */
 225         {KIND_LITERAL, 0x41, 0x7c, EV_KEY, BTN_RIGHT, 1},/* right btn down */
 226         {KIND_LITERAL, 0x42, 0x7d, EV_KEY, BTN_RIGHT, 0},/* right btn up */
 227
 228         /* Artificial "doubleclick" events are generated by the hardware.
 229          * They are mapped to the "side" and "extra" mouse buttons here. */
 230         {KIND_FILTERED, 0x3f, 0x7a, EV_KEY, BTN_SIDE, 1}, /* left dblclick */
 231         {KIND_FILTERED, 0x43, 0x7e, EV_KEY, BTN_EXTRA, 1},/* right dblclick */
 232
 233         /* keyboard. */
 234         {KIND_FILTERED, 0xd2, 0x0d, EV_KEY, KEY_1, 1},
 235         {KIND_FILTERED, 0xd3, 0x0e, EV_KEY, KEY_2, 1},
 236         {KIND_FILTERED, 0xd4, 0x0f, EV_KEY, KEY_3, 1},
 237         {KIND_FILTERED, 0xd5, 0x10, EV_KEY, KEY_4, 1},
 238         {KIND_FILTERED, 0xd6, 0x11, EV_KEY, KEY_5, 1},
 239         {KIND_FILTERED, 0xd7, 0x12, EV_KEY, KEY_6, 1},
 240         {KIND_FILTERED, 0xd8, 0x13, EV_KEY, KEY_7, 1},
 241         {KIND_FILTERED, 0xd9, 0x14, EV_KEY, KEY_8, 1},
 242         {KIND_FILTERED, 0xda, 0x15, EV_KEY, KEY_9, 1},
 243         {KIND_FILTERED, 0xdc, 0x17, EV_KEY, KEY_0, 1},
 244         {KIND_FILTERED, 0xc5, 0x00, EV_KEY, KEY_A, 1},
 245         {KIND_FILTERED, 0xc6, 0x01, EV_KEY, KEY_B, 1},
 246         {KIND_FILTERED, 0xde, 0x19, EV_KEY, KEY_C, 1},
 247         {KIND_FILTERED, 0xe0, 0x1b, EV_KEY, KEY_D, 1},
 248         {KIND_FILTERED, 0xe6, 0x21, EV_KEY, KEY_E, 1},
 249         {KIND_FILTERED, 0xe8, 0x23, EV_KEY, KEY_F, 1},
 250
 251         /* "special" keys */
 252         {KIND_FILTERED, 0xdd, 0x18, EV_KEY, KEY_KPENTER, 1},    /* "check" */
 253         {KIND_FILTERED, 0xdb, 0x16, EV_KEY, KEY_MENU, 1},       /* "menu" */
 254         {KIND_FILTERED, 0xc7, 0x02, EV_KEY, KEY_POWER, 1},      /* Power */
 255         {KIND_FILTERED, 0xc8, 0x03, EV_KEY, KEY_PROG1, 1},      /* TV */
 256         {KIND_FILTERED, 0xc9, 0x04, EV_KEY, KEY_PROG2, 1},      /* DVD */
 257         {KIND_FILTERED, 0xca, 0x05, EV_KEY, KEY_WWW, 1},        /* WEB */
 258         {KIND_FILTERED, 0xcb, 0x06, EV_KEY, KEY_BOOKMARKS, 1},  /* "book" */
 259         {KIND_FILTERED, 0xcc, 0x07, EV_KEY, KEY_EDIT, 1},       /* "hand" */
 260         {KIND_FILTERED, 0xe1, 0x1c, EV_KEY, KEY_COFFEE, 1},     /* "timer" */
 261         {KIND_FILTERED, 0xe5, 0x20, EV_KEY, KEY_FRONT, 1},      /* "max" */
 262         {KIND_FILTERED, 0xe2, 0x1d, EV_KEY, KEY_LEFT, 1},       /* left */
 263         {KIND_FILTERED, 0xe4, 0x1f, EV_KEY, KEY_RIGHT, 1},      /* right */
 264         {KIND_FILTERED, 0xe7, 0x22, EV_KEY, KEY_DOWN, 1},       /* down */
 265         {KIND_FILTERED, 0xdf, 0x1a, EV_KEY, KEY_UP, 1},         /* up */
 266         {KIND_FILTERED, 0xe3, 0x1e, EV_KEY, KEY_ENTER, 1},      /* "OK" */
 267         {KIND_FILTERED, 0xce, 0x09, EV_KEY, KEY_VOLUMEDOWN, 1}, /* VOL + */
 268         {KIND_FILTERED, 0xcd, 0x08, EV_KEY, KEY_VOLUMEUP, 1},   /* VOL - */
 269         {KIND_FILTERED, 0xcf, 0x0a, EV_KEY, KEY_MUTE, 1},       /* MUTE  */
 270         {KIND_FILTERED, 0xd1, 0x0c, EV_KEY, KEY_CHANNELUP, 1},  /* CH + */
 271         {KIND_FILTERED, 0xd0, 0x0b, EV_KEY, KEY_CHANNELDOWN, 1},/* CH - */
 272         {KIND_FILTERED, 0xec, 0x27, EV_KEY, KEY_RECORD, 1},     /* ( o) red */
 273         {KIND_FILTERED, 0xea, 0x25, EV_KEY, KEY_PLAYCD, 1},     /* ( >) */
 274         {KIND_FILTERED, 0xe9, 0x24, EV_KEY, KEY_REWIND, 1},     /* (<<) */
 275         {KIND_FILTERED, 0xeb, 0x26, EV_KEY, KEY_FORWARD, 1},    /* (>>) */
 276         {KIND_FILTERED, 0xed, 0x28, EV_KEY, KEY_STOP, 1},       /* ([]) */
 277         {KIND_FILTERED, 0xee, 0x29, EV_KEY, KEY_PAUSE, 1},      /* ('') */
 278         {KIND_FILTERED, 0xf0, 0x2b, EV_KEY, KEY_PREVIOUS, 1},   /* (<-) */
 279         {KIND_FILTERED, 0xef, 0x2a, EV_KEY, KEY_NEXT, 1},       /* (>+) */
 280         {KIND_FILTERED, 0xf2, 0x2D, EV_KEY, KEY_INFO, 1},       /* PLAYING */
 281         {KIND_FILTERED, 0xf3, 0x2E, EV_KEY, KEY_HOME, 1},       /* TOP */
 282         {KIND_FILTERED, 0xf4, 0x2F, EV_KEY, KEY_END, 1},        /* END */
 283         {KIND_FILTERED, 0xf5, 0x30, EV_KEY, KEY_SELECT, 1},     /* SELECT */
 284
 285         {KIND_END, 0x00, 0x00, EV_MAX + 1, 0, 0}
 286 };
 287
 288 /* Local function prototypes */
 289 static void ati_remote_dump             (unsigned char *data, unsigned int actual_length);
 290 static void ati_remote_delete           (struct ati_remote *dev);
 291 static int ati_remote_open              (struct input_dev *inputdev);
 292 static void ati_remote_close            (struct input_dev *inputdev);
 293 static int ati_remote_sendpacket        (struct ati_remote *ati_remote, u16 cmd, unsigned char *data);
 294 static void ati_remote_irq_out          (struct urb *urb, struct pt_regs *regs);
 295 static void ati_remote_irq_in           (struct urb *urb, struct pt_regs *regs);
 296 static void ati_remote_input_report     (struct urb *urb, struct pt_regs *regs);
 297 static int ati_remote_initialize        (struct ati_remote *ati_remote);
 298 static int ati_remote_probe             (struct usb_interface *interface, const struct usb_device_id *id);
 299 static void ati_remote_disconnect       (struct usb_interface *interface);
 300
 301 /* usb specific object to register with the usb subsystem */
 302 static struct usb_driver ati_remote_driver = {
 303         .owner        = THIS_MODULE,
 304         .name         = "ati_remote",
 305         .probe        = ati_remote_probe,
 306         .disconnect   = ati_remote_disconnect,
 307         .id_table     = ati_remote_table,
 308 };
 309
 310 /*
 311  *      ati_remote_dump_input
 312  */
 313 static void ati_remote_dump(unsigned char *data, unsigned int len)
 314 {
 315         if ((len == 1) && (data[0] != (unsigned char)0xff) && (data[0] != 0x00))
 316                 warn("Weird byte 0x%02x", data[0]);
 317         else if (len == 4)
 318                 warn("Weird key %02x %02x %02x %02x",
 319                      data[0], data[1], data[2], data[3]);
 320         else
 321                 warn("Weird data, len=%d %02x %02x %02x %02x %02x %02x ...",
 322                      len, data[0], data[1], data[2], data[3], data[4], data[5]);
 323 }
 324
 325 /*
 326  *      ati_remote_open
 327  */
 328 static int ati_remote_open(struct input_dev *inputdev)
 329 {
 330         struct ati_remote *ati_remote = inputdev->private;
 331         int retval = 0;
 332
 333         down(&disconnect_sem);
 334
 335         if (ati_remote->open++)
 336                 goto exit;
 337
 338         /* On first open, submit the read urb which was set up previously. */
 339         ati_remote->irq_urb->dev = ati_remote->udev;
 340         if (usb_submit_urb(ati_remote->irq_urb, GFP_KERNEL)) {
 341                 dev_err(&ati_remote->interface->dev,
 342                         "%s: usb_submit_urb failed!\n", __FUNCTION__);
 343                 ati_remote->open--;
 344                 retval = -EIO;
 345         }
 346
 347 exit:
 348         up(&disconnect_sem);
 349         return retval;
 350 }
 351
 352 /*
 353  *      ati_remote_close
 354  */
 355 static void ati_remote_close(struct input_dev *inputdev)
 356 {
 357         struct ati_remote *ati_remote = inputdev->private;
 358
 359         if (ati_remote == NULL) {
 360                 err("ati_remote: %s: object is NULL!\n", __FUNCTION__);
 361                 return;
 362         }
 363
 364         if (ati_remote->open <= 0)
 365                 dev_dbg(&ati_remote->interface->dev, "%s: Not open.\n", __FUNCTION__);
 366         else
 367                 --ati_remote->open;
 368
 369         /* If still present, disconnect will call delete. */
 370         if (!ati_remote->present && !ati_remote->open)
 371                 ati_remote_delete(ati_remote);
 372 }
 373
 374 /*
 375  *              ati_remote_irq_out
 376  */
 377 static void ati_remote_irq_out(struct urb *urb, struct pt_regs *regs)
 378 {
 379         struct ati_remote *ati_remote = urb->context;
 380
 381         if (urb->status) {
 382                 dev_dbg(&ati_remote->interface->dev, "%s: status %d\n",
 383                         __FUNCTION__, urb->status);
 384                 return;
 385         }
 386
 387         ati_remote->send_flags |= SEND_FLAG_COMPLETE;
 388         wmb();
 389         wake_up(&ati_remote->wait);
 390 }
 391
 392 /*
 393  *      ati_remote_sendpacket
 394  *
 395  *      Used to send device initialization strings
 396  */
 397 static int ati_remote_sendpacket(struct ati_remote *ati_remote, u16 cmd, unsigned char *data)
 398 {
 399         DECLARE_WAITQUEUE(wait, current);
 400         int timeout = HZ;       /* 1 second */
 401         int retval = 0;
 402
 403         /* Set up out_urb */
 404         memcpy(ati_remote->out_urb->transfer_buffer + 1, data, LO(cmd));
 405         ((char *) ati_remote->out_urb->transfer_buffer)[0] = HI(cmd);
 406
 407         ati_remote->out_urb->transfer_buffer_length = LO(cmd) + 1;
 408         ati_remote->out_urb->dev = ati_remote->udev;
 409         ati_remote->send_flags = SEND_FLAG_IN_PROGRESS;
 410
 411         retval = usb_submit_urb(ati_remote->out_urb, GFP_ATOMIC);
 412         if (retval) {
 413                 dev_dbg(&ati_remote->interface->dev,
 414                          "sendpacket: usb_submit_urb failed: %d\n", retval);
 415                 return retval;
 416         }
 417
 418         set_current_state(TASK_INTERRUPTIBLE);
 419         add_wait_queue(&ati_remote->wait, &wait);
 420
 421         while (timeout && (ati_remote->out_urb->status == -EINPROGRESS)
 422                && !(ati_remote->send_flags & SEND_FLAG_COMPLETE)) {
 423                 set_current_state(TASK_INTERRUPTIBLE);
 424                 timeout = schedule_timeout(timeout);
 425                 rmb();
 426         }
 427
 428         set_current_state(TASK_RUNNING);
 429         remove_wait_queue(&ati_remote->wait, &wait);
 430         usb_kill_urb(ati_remote->out_urb);
 431
 432         return retval;
 433 }
 434
 435 /*
 436  *      ati_remote_event_lookup
 437  */
 438 static int ati_remote_event_lookup(int rem, unsigned char d1, unsigned char d2)
 439 {
 440         int i;
 441
 442         for (i = 0; ati_remote_tbl[i].kind != KIND_END; i++) {
 443                 /*
 444                  * Decide if the table entry matches the remote input.
 445                  */
 446                 if ((((ati_remote_tbl[i].data1 & 0x0f) == (d1 & 0x0f))) &&
 447                     ((((ati_remote_tbl[i].data1 >> 4) -
 448                        (d1 >> 4) + rem) & 0x0f) == 0x0f) &&
 449                     (ati_remote_tbl[i].data2 == d2))
 450                         return i;
 451
 452         }
 453         return -1;
 454 }
 455
 456 /*
 457  *      ati_remote_report_input
 458  */
 459 static void ati_remote_input_report(struct urb *urb, struct pt_regs *regs)
 460 {
 461         struct ati_remote *ati_remote = urb->context;
 462         unsigned char *data= ati_remote->inbuf;
 463         struct input_dev *dev = &ati_remote->idev;
 464         int index, acc;
 465         int remote_num;
 466
 467         /* Deal with strange looking inputs */
 468         if ( (urb->actual_length != 4) || (data[0] != 0x14) ||
 469                 ((data[3] & 0x0f) != 0x00) ) {
 470                 ati_remote_dump(data, urb->actual_length);
 471                 return;
 472         }
 473
 474         /* Mask unwanted remote channels.  */
 475         /* note: remote_num is 0-based, channel 1 on remote == 0 here */
 476         remote_num = (data[3] >> 4) & 0x0f;
 477         if (channel_mask & (1 << (remote_num + 1))) {
 478                 dbginfo(&ati_remote->interface->dev,
 479                         "Masked input from channel 0x%02x: data %02x,%02x, mask= 0x%02lx\n",
 480                         remote_num, data[1], data[2], channel_mask);
 481                 return;
 482         }
 483
 484         /* Look up event code index in translation table */
 485         index = ati_remote_event_lookup(remote_num, data[1], data[2]);
 486         if (index < 0) {
 487                 dev_warn(&ati_remote->interface->dev,
 488                          "Unknown input from channel 0x%02x: data %02x,%02x\n",
 489                          remote_num, data[1], data[2]);
 490                 return;
 491         }
 492         dbginfo(&ati_remote->interface->dev,
 493                 "channel 0x%02x; data %02x,%02x; index %d; keycode %d\n",
 494                 remote_num, data[1], data[2], index, ati_remote_tbl[index].code);
 495
 496         if (ati_remote_tbl[index].kind == KIND_LITERAL) {
 497                 input_regs(dev, regs);
 498                 input_event(dev, ati_remote_tbl[index].type,
 499                         ati_remote_tbl[index].code,
 500                         ati_remote_tbl[index].value);
 501                 input_sync(dev);
 502
 503                 ati_remote->old_jiffies = jiffies;
 504                 return;
 505         }
 506
 507         if (ati_remote_tbl[index].kind == KIND_FILTERED) {
 508                 /* Filter duplicate events which happen "too close" together. */
 509                 if ((ati_remote->old_data[0] == data[1]) &&
 510                         (ati_remote->old_data[1] == data[2]) &&
 511                         ((ati_remote->old_jiffies + FILTER_TIME) > jiffies)) {
 512                         ati_remote->repeat_count++;
 513                 }
 514                 else {
 515                         ati_remote->repeat_count = 0;
 516                 }
 517
 518                 ati_remote->old_data[0] = data[1];
 519                 ati_remote->old_data[1] = data[2];
 520                 ati_remote->old_jiffies = jiffies;
 521
 522                 if ((ati_remote->repeat_count > 0)
 523                     && (ati_remote->repeat_count < 5))
 524                         return;
 525
 526
 527                 input_regs(dev, regs);
 528                 input_event(dev, ati_remote_tbl[index].type,
 529                         ati_remote_tbl[index].code, 1);
 530                 input_event(dev, ati_remote_tbl[index].type,
 531                         ati_remote_tbl[index].code, 0);
 532                 input_sync(dev);
 533
 534                 return;
 535         }
 536
 537         /*
 538          * Other event kinds are from the directional control pad, and have an
 539          * acceleration factor applied to them.  Without this acceleration, the
 540          * control pad is mostly unusable.
 541          *
 542          * If elapsed time since last event is > 1/4 second, user "stopped",
 543          * so reset acceleration. Otherwise, user is probably holding the control
 544          * pad down, so we increase acceleration, ramping up over two seconds to
 545          * a maximum speed.  The acceleration curve is #defined above.
 546          */
 547         if ((jiffies - ati_remote->old_jiffies) > (HZ >> 2)) {
 548                 acc = 1;
 549                 ati_remote->acc_jiffies = jiffies;
 550         }
 551         else if ((jiffies - ati_remote->acc_jiffies) < (HZ >> 3))  acc = accel[0];
 552         else if ((jiffies - ati_remote->acc_jiffies) < (HZ >> 2))  acc = accel[1];
 553         else if ((jiffies - ati_remote->acc_jiffies) < (HZ >> 1))  acc = accel[2];
 554         else if ((jiffies - ati_remote->acc_jiffies) < HZ )        acc = accel[3];
 555         else if ((jiffies - ati_remote->acc_jiffies) < HZ+(HZ>>1)) acc = accel[4];
 556         else if ((jiffies - ati_remote->acc_jiffies) < (HZ << 1))  acc = accel[5];
 557         else acc = accel[6];
 558
 559         input_regs(dev, regs);
 560         switch (ati_remote_tbl[index].kind) {
 561         case KIND_ACCEL:
 562                 input_event(dev, ati_remote_tbl[index].type,
 563                         ati_remote_tbl[index].code,
 564                         ati_remote_tbl[index].value * acc);
 565                 break;
 566         case KIND_LU:
 567                 input_report_rel(dev, REL_X, -acc);
 568                 input_report_rel(dev, REL_Y, -acc);
 569                 break;
 570         case KIND_RU:
 571                 input_report_rel(dev, REL_X, acc);
 572                 input_report_rel(dev, REL_Y, -acc);
 573                 break;
 574         case KIND_LD:
 575                 input_report_rel(dev, REL_X, -acc);
 576                 input_report_rel(dev, REL_Y, acc);
 577                 break;
 578         case KIND_RD:
 579                 input_report_rel(dev, REL_X, acc);
 580                 input_report_rel(dev, REL_Y, acc);
 581                 break;
 582         default:
 583                 dev_dbg(&ati_remote->interface->dev, "ati_remote kind=%d\n",
 584                         ati_remote_tbl[index].kind);
 585         }
 586         input_sync(dev);
 587
 588         ati_remote->old_jiffies = jiffies;
 589         ati_remote->old_data[0] = data[1];
 590         ati_remote->old_data[1] = data[2];
 591 }
 592
 593 /*
 594  *      ati_remote_irq_in
 595  */
 596 static void ati_remote_irq_in(struct urb *urb, struct pt_regs *regs)
 597 {
 598         struct ati_remote *ati_remote = urb->context;
 599         int retval;
 600
 601         switch (urb->status) {
 602         case 0:                 /* success */
 603                 ati_remote_input_report(urb, regs);
 604                 break;
 605         case -ECONNRESET:       /* unlink */
 606         case -ENOENT:
 607         case -ESHUTDOWN:
 608                 dev_dbg(&ati_remote->interface->dev, "%s: urb error status, unlink? \n",
 609                         __FUNCTION__);
 610                 return;
 611         default:                /* error */
 612                 dev_dbg(&ati_remote->interface->dev, "%s: Nonzero urb status %d\n",
 613                         __FUNCTION__, urb->status);
 614         }
 615
 616         retval = usb_submit_urb(urb, SLAB_ATOMIC);
 617         if (retval)
 618                 dev_err(&ati_remote->interface->dev, "%s: usb_submit_urb()=%d\n",
 619                         __FUNCTION__, retval);
 620 }
 621
 622 /*
 623  *      ati_remote_delete
 624  */
 625 static void ati_remote_delete(struct ati_remote *ati_remote)
 626 {
 627         if (!ati_remote) return;
 628
 629         if (ati_remote->irq_urb)
 630                 usb_kill_urb(ati_remote->irq_urb);
 631
 632         if (ati_remote->out_urb)
 633                 usb_kill_urb(ati_remote->out_urb);
 634
 635         input_unregister_device(&ati_remote->idev);
 636
 637         if (ati_remote->inbuf)
 638                 usb_buffer_free(ati_remote->udev, DATA_BUFSIZE,
 639                                 ati_remote->inbuf, ati_remote->inbuf_dma);
 640
 641         if (ati_remote->outbuf)
 642                 usb_buffer_free(ati_remote->udev, DATA_BUFSIZE,
 643                                 ati_remote->inbuf, ati_remote->outbuf_dma);
 644
 645         if (ati_remote->irq_urb)
 646                 usb_free_urb(ati_remote->irq_urb);
 647
 648         if (ati_remote->out_urb)
 649                 usb_free_urb(ati_remote->out_urb);
 650
 651         kfree(ati_remote);
 652 }
 653
 654 static void ati_remote_input_init(struct ati_remote *ati_remote)
 655 {
 656         struct input_dev *idev = &(ati_remote->idev);
 657         int i;
 658
 659         idev->evbit[0] = BIT(EV_KEY) | BIT(EV_REL);
 660         idev->keybit[LONG(BTN_MOUSE)] = ( BIT(BTN_LEFT) | BIT(BTN_RIGHT) |
 661                                           BIT(BTN_SIDE) | BIT(BTN_EXTRA) );
 662         idev->relbit[0] = BIT(REL_X) | BIT(REL_Y);
 663         for (i = 0; ati_remote_tbl[i].kind != KIND_END; i++)
 664                 if (ati_remote_tbl[i].type == EV_KEY)
 665                         set_bit(ati_remote_tbl[i].code, idev->keybit);
 666
 667         idev->private = ati_remote;
 668         idev->open = ati_remote_open;
 669         idev->close = ati_remote_close;
 670
 671         idev->name = ati_remote->name;
 672         idev->phys = ati_remote->phys;
 673
 674         idev->id.bustype = BUS_USB;
 675         idev->id.vendor = le16_to_cpu(ati_remote->udev->descriptor.idVendor);
 676         idev->id.product = le16_to_cpu(ati_remote->udev->descriptor.idProduct);
 677         idev->id.version = le16_to_cpu(ati_remote->udev->descriptor.bcdDevice);
 678 }
 679
 680 static int ati_remote_initialize(struct ati_remote *ati_remote)
 681 {
 682         struct usb_device *udev = ati_remote->udev;
 683         int pipe, maxp;
 684
 685         init_waitqueue_head(&ati_remote->wait);
 686
 687         /* Set up irq_urb */
 688         pipe = usb_rcvintpipe(udev, ati_remote->endpoint_in->bEndpointAddress);
 689         maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe));
 690         maxp = (maxp > DATA_BUFSIZE) ? DATA_BUFSIZE : maxp;
 691
 692         usb_fill_int_urb(ati_remote->irq_urb, udev, pipe, ati_remote->inbuf,
 693                          maxp, ati_remote_irq_in, ati_remote,
 694                          ati_remote->endpoint_in->bInterval);
 695         ati_remote->irq_urb->transfer_dma = ati_remote->inbuf_dma;
 696         ati_remote->irq_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 697
 698         /* Set up out_urb */
 699         pipe = usb_sndintpipe(udev, ati_remote->endpoint_out->bEndpointAddress);
 700         maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe));
 701         maxp = (maxp > DATA_BUFSIZE) ? DATA_BUFSIZE : maxp;
 702
 703         usb_fill_int_urb(ati_remote->out_urb, udev, pipe, ati_remote->outbuf,
 704                          maxp, ati_remote_irq_out, ati_remote,
 705                          ati_remote->endpoint_out->bInterval);
 706         ati_remote->out_urb->transfer_dma = ati_remote->outbuf_dma;
 707         ati_remote->out_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 708
 709         /* send initialization strings */
 710         if ((ati_remote_sendpacket(ati_remote, 0x8004, init1)) ||
 711             (ati_remote_sendpacket(ati_remote, 0x8007, init2))) {
 712                 dev_err(&ati_remote->interface->dev,
 713                          "Initializing ati_remote hardware failed.\n");
 714                 return 1;
 715         }
 716
 717         return 0;
 718 }
 719
 720 /*
 721  *      ati_remote_probe
 722  */
 723 static int ati_remote_probe(struct usb_interface *interface, const struct usb_device_id *id)
 724 {
 725         struct usb_device *udev = interface_to_usbdev(interface);
 726         struct ati_remote *ati_remote = NULL;
 727         struct usb_host_interface *iface_host;
 728         int retval = -ENOMEM;
 729         char path[64];
 730         char *buf = NULL;
 731
 732         /* Allocate and clear an ati_remote struct */
 733         if (!(ati_remote = kmalloc(sizeof (struct ati_remote), GFP_KERNEL)))
 734                 return -ENOMEM;
 735         memset(ati_remote, 0x00, sizeof (struct ati_remote));
 736
 737         iface_host = interface->cur_altsetting;
 738         if (iface_host->desc.bNumEndpoints != 2) {
 739                 err("%s: Unexpected desc.bNumEndpoints\n", __FUNCTION__);
 740                 retval = -ENODEV;
 741                 goto error;
 742         }
 743
 744         ati_remote->endpoint_in = &(iface_host->endpoint[0].desc);
 745         ati_remote->endpoint_out = &(iface_host->endpoint[1].desc);
 746         ati_remote->udev = udev;
 747         ati_remote->interface = interface;
 748
 749         if (!(ati_remote->endpoint_in->bEndpointAddress & 0x80)) {
 750                 err("%s: Unexpected endpoint_in->bEndpointAddress\n", __FUNCTION__);
 751                 retval = -ENODEV;
 752                 goto error;
 753         }
 754         if ((ati_remote->endpoint_in->bmAttributes & 3) != 3) {
 755                 err("%s: Unexpected endpoint_in->bmAttributes\n", __FUNCTION__);
 756                 retval = -ENODEV;
 757                 goto error;
 758         }
 759         if (le16_to_cpu(ati_remote->endpoint_in->wMaxPacketSize) == 0) {
 760                 err("%s: endpoint_in message size==0? \n", __FUNCTION__);
 761                 retval = -ENODEV;
 762                 goto error;
 763         }
 764         if (!(buf = kmalloc(NAME_BUFSIZE, GFP_KERNEL)))
 765                 goto error;
 766
 767         /* Allocate URB buffers, URBs */
 768         ati_remote->inbuf = usb_buffer_alloc(udev, DATA_BUFSIZE, SLAB_ATOMIC,
 769                                              &ati_remote->inbuf_dma);
 770         if (!ati_remote->inbuf)
 771                 goto error;
 772
 773         ati_remote->outbuf = usb_buffer_alloc(udev, DATA_BUFSIZE, SLAB_ATOMIC,
 774                                               &ati_remote->outbuf_dma);
 775         if (!ati_remote->outbuf)
 776                 goto error;
 777
 778         ati_remote->irq_urb = usb_alloc_urb(0, GFP_KERNEL);
 779         if (!ati_remote->irq_urb)
 780                 goto error;
 781
 782         ati_remote->out_urb = usb_alloc_urb(0, GFP_KERNEL);
 783         if (!ati_remote->out_urb)
 784                 goto error;
 785
 786         usb_make_path(udev, path, NAME_BUFSIZE);
 787         sprintf(ati_remote->phys, "%s/input%d", path, ATI_INPUTNUM);
 788         if (udev->descriptor.iManufacturer &&
 789             (usb_string(udev, udev->descriptor.iManufacturer, buf,
 790                         NAME_BUFSIZE) > 0))
 791                 strcat(ati_remote->name, buf);
 792
 793         if (udev->descriptor.iProduct &&
 794             (usb_string(udev, udev->descriptor.iProduct, buf, NAME_BUFSIZE) > 0))
 795                 sprintf(ati_remote->name, "%s %s", ati_remote->name, buf);
 796
 797         if (!strlen(ati_remote->name))
 798                 sprintf(ati_remote->name, DRIVER_DESC "(%04x,%04x)",
 799                         le16_to_cpu(ati_remote->udev->descriptor.idVendor),
 800                         le16_to_cpu(ati_remote->udev->descriptor.idProduct));
 801
 802         /* Device Hardware Initialization - fills in ati_remote->idev from udev. */
 803         retval = ati_remote_initialize(ati_remote);
 804         if (retval)
 805                 goto error;
 806
 807         /* Set up and register input device */
 808         ati_remote_input_init(ati_remote);
 809         input_register_device(&ati_remote->idev);
 810
 811         dev_info(&ati_remote->interface->dev, "Input registered: %s on %s\n",
 812                  ati_remote->name, path);
 813
 814         usb_set_intfdata(interface, ati_remote);
 815         ati_remote->present = 1;
 816
 817 error:
 818         if (buf)
 819                 kfree(buf);
 820
 821         if (retval)
 822                 ati_remote_delete(ati_remote);
 823
 824         return retval;
 825 }
 826
 827 /*
 828  *      ati_remote_disconnect
 829  */
 830 static void ati_remote_disconnect(struct usb_interface *interface)
 831 {
 832         struct ati_remote *ati_remote;
 833
 834         down(&disconnect_sem);
 835
 836         ati_remote = usb_get_intfdata(interface);
 837         usb_set_intfdata(interface, NULL);
 838         if (!ati_remote) {
 839                 warn("%s - null device?\n", __FUNCTION__);
 840                 return;
 841         }
 842
 843         /* Mark device as unplugged */
 844         ati_remote->present = 0;
 845
 846         /* If device is still open, ati_remote_close will call delete. */
 847         if (!ati_remote->open)
 848                 ati_remote_delete(ati_remote);
 849
 850         up(&disconnect_sem);
 851 }
 852
 853 /*
 854  *      ati_remote_init
 855  */
 856 static int __init ati_remote_init(void)
 857 {
 858         int result;
 859
 860         result = usb_register(&ati_remote_driver);
 861         if (result)
 862                 err("usb_register error #%d\n", result);
 863         else
 864                 info("Registered USB driver " DRIVER_DESC " v. " DRIVER_VERSION);
 865
 866         return result;
 867 }
 868
 869 /*
 870  *      ati_remote_exit
 871  */
 872 static void __exit ati_remote_exit(void)
 873 {
 874         usb_deregister(&ati_remote_driver);
 875 }
 876
 877 /*
 878  *      module specification
 879  */
 880
 881 module_init(ati_remote_init);
 882 module_exit(ati_remote_exit);
 883
 884 MODULE_AUTHOR(DRIVER_AUTHOR);
 885 MODULE_DESCRIPTION(DRIVER_DESC);
 886 MODULE_LICENSE("GPL");