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 #include <linux/wait.h>
  98
  99 /*
 100  * Module and Version Information, Module Parameters
 101  */
 102
 103 #define ATI_REMOTE_VENDOR_ID    0x0bc7
 104 #define ATI_REMOTE_PRODUCT_ID   0x004
 105 #define LOLA_REMOTE_PRODUCT_ID  0x002
 106 #define MEDION_REMOTE_PRODUCT_ID 0x006
 107
 108 #define DRIVER_VERSION          "2.2.1"
 109 #define DRIVER_AUTHOR           "Torrey Hoffman <thoffman@arnor.net>"
 110 #define DRIVER_DESC             "ATI/X10 RF USB Remote Control"
 111
 112 #define NAME_BUFSIZE      80    /* size of product name, path buffers */
 113 #define DATA_BUFSIZE      63    /* size of URB data buffers */
 114 #define ATI_INPUTNUM      1     /* Which input device to register as */
 115
 116 static unsigned long channel_mask;
 117 module_param(channel_mask, ulong, 0444);
 118 MODULE_PARM_DESC(channel_mask, "Bitmask of remote control channels to ignore");
 119
 120 static int debug;
 121 module_param(debug, int, 0444);
 122 MODULE_PARM_DESC(debug, "Enable extra debug messages and information");
 123
 124 #define dbginfo(dev, format, arg...) do { if (debug) dev_info(dev , format , ## arg); } while (0)
 125 #undef err
 126 #define err(format, arg...) printk(KERN_ERR format , ## arg)
 127
 128 static struct usb_device_id ati_remote_table[] = {
 129         { USB_DEVICE(ATI_REMOTE_VENDOR_ID, ATI_REMOTE_PRODUCT_ID) },
 130         { USB_DEVICE(ATI_REMOTE_VENDOR_ID, LOLA_REMOTE_PRODUCT_ID) },
 131         { USB_DEVICE(ATI_REMOTE_VENDOR_ID, MEDION_REMOTE_PRODUCT_ID) },
 132         {}      /* Terminating entry */
 133 };
 134
 135 MODULE_DEVICE_TABLE(usb, ati_remote_table);
 136
 137 /* Get hi and low bytes of a 16-bits int */
 138 #define HI(a)   ((unsigned char)((a) >> 8))
 139 #define LO(a)   ((unsigned char)((a) & 0xff))
 140
 141 #define SEND_FLAG_IN_PROGRESS   1
 142 #define SEND_FLAG_COMPLETE      2
 143
 144 /* Device initialization strings */
 145 static char init1[] = { 0x01, 0x00, 0x20, 0x14 };
 146 static char init2[] = { 0x01, 0x00, 0x20, 0x14, 0x20, 0x20, 0x20 };
 147
 148 /* Acceleration curve for directional control pad */
 149 static char accel[] = { 1, 2, 4, 6, 9, 13, 20 };
 150
 151 /* Duplicate event filtering time.
 152  * Sequential, identical KIND_FILTERED inputs with less than
 153  * FILTER_TIME jiffies between them are considered as repeat
 154  * events. The hardware generates 5 events for the first keypress
 155  * and we have to take this into account for an accurate repeat
 156  * behaviour.
 157  * (HZ / 20) == 50 ms and works well for me.
 158  */
 159 #define FILTER_TIME (HZ / 20)
 160
 161 static DECLARE_MUTEX(disconnect_sem);
 162
 163 struct ati_remote {
 164         struct input_dev idev;
 165         struct usb_device *udev;
 166         struct usb_interface *interface;
 167
 168         struct urb *irq_urb;
 169         struct urb *out_urb;
 170         struct usb_endpoint_descriptor *endpoint_in;
 171         struct usb_endpoint_descriptor *endpoint_out;
 172         unsigned char *inbuf;
 173         unsigned char *outbuf;
 174         dma_addr_t inbuf_dma;
 175         dma_addr_t outbuf_dma;
 176
 177         unsigned char old_data[2];  /* Detect duplicate events */
 178         unsigned long old_jiffies;
 179         unsigned long acc_jiffies;  /* handle acceleration */
 180         unsigned int repeat_count;
 181
 182         char name[NAME_BUFSIZE];
 183         char phys[NAME_BUFSIZE];
 184
 185         wait_queue_head_t wait;
 186         int send_flags;
 187 };
 188
 189 /* "Kinds" of messages sent from the hardware to the driver. */
 190 #define KIND_END        0
 191 #define KIND_LITERAL    1   /* Simply pass to input system */
 192 #define KIND_FILTERED   2   /* Add artificial key-up events, drop keyrepeats */
 193 #define KIND_LU         3   /* Directional keypad diagonals - left up, */
 194 #define KIND_RU         4   /*   right up,  */
 195 #define KIND_LD         5   /*   left down, */
 196 #define KIND_RD         6   /*   right down */
 197 #define KIND_ACCEL      7   /* Directional keypad - left, right, up, down.*/
 198
 199 /* Translation table from hardware messages to input events. */
 200 static struct
 201 {
 202         short kind;
 203         unsigned char data1, data2;
 204         int type;
 205         unsigned int code;
 206         int value;
 207 }  ati_remote_tbl[] =
 208 {
 209         /* Directional control pad axes */
 210         {KIND_ACCEL,   0x35, 0x70, EV_REL, REL_X, -1},   /* left */
 211         {KIND_ACCEL,   0x36, 0x71, EV_REL, REL_X, 1},    /* right */
 212         {KIND_ACCEL,   0x37, 0x72, EV_REL, REL_Y, -1},   /* up */
 213         {KIND_ACCEL,   0x38, 0x73, EV_REL, REL_Y, 1},    /* down */
 214         /* Directional control pad diagonals */
 215         {KIND_LU,      0x39, 0x74, EV_REL, 0, 0},        /* left up */
 216         {KIND_RU,      0x3a, 0x75, EV_REL, 0, 0},        /* right up */
 217         {KIND_LD,      0x3c, 0x77, EV_REL, 0, 0},        /* left down */
 218         {KIND_RD,      0x3b, 0x76, EV_REL, 0, 0},        /* right down */
 219
 220         /* "Mouse button" buttons */
 221         {KIND_LITERAL, 0x3d, 0x78, EV_KEY, BTN_LEFT, 1}, /* left btn down */
 222         {KIND_LITERAL, 0x3e, 0x79, EV_KEY, BTN_LEFT, 0}, /* left btn up */
 223         {KIND_LITERAL, 0x41, 0x7c, EV_KEY, BTN_RIGHT, 1},/* right btn down */
 224         {KIND_LITERAL, 0x42, 0x7d, EV_KEY, BTN_RIGHT, 0},/* right btn up */
 225
 226         /* Artificial "doubleclick" events are generated by the hardware.
 227          * They are mapped to the "side" and "extra" mouse buttons here. */
 228         {KIND_FILTERED, 0x3f, 0x7a, EV_KEY, BTN_SIDE, 1}, /* left dblclick */
 229         {KIND_FILTERED, 0x43, 0x7e, EV_KEY, BTN_EXTRA, 1},/* right dblclick */
 230
 231         /* keyboard. */
 232         {KIND_FILTERED, 0xd2, 0x0d, EV_KEY, KEY_1, 1},
 233         {KIND_FILTERED, 0xd3, 0x0e, EV_KEY, KEY_2, 1},
 234         {KIND_FILTERED, 0xd4, 0x0f, EV_KEY, KEY_3, 1},
 235         {KIND_FILTERED, 0xd5, 0x10, EV_KEY, KEY_4, 1},
 236         {KIND_FILTERED, 0xd6, 0x11, EV_KEY, KEY_5, 1},
 237         {KIND_FILTERED, 0xd7, 0x12, EV_KEY, KEY_6, 1},
 238         {KIND_FILTERED, 0xd8, 0x13, EV_KEY, KEY_7, 1},
 239         {KIND_FILTERED, 0xd9, 0x14, EV_KEY, KEY_8, 1},
 240         {KIND_FILTERED, 0xda, 0x15, EV_KEY, KEY_9, 1},
 241         {KIND_FILTERED, 0xdc, 0x17, EV_KEY, KEY_0, 1},
 242         {KIND_FILTERED, 0xc5, 0x00, EV_KEY, KEY_A, 1},
 243         {KIND_FILTERED, 0xc6, 0x01, EV_KEY, KEY_B, 1},
 244         {KIND_FILTERED, 0xde, 0x19, EV_KEY, KEY_C, 1},
 245         {KIND_FILTERED, 0xe0, 0x1b, EV_KEY, KEY_D, 1},
 246         {KIND_FILTERED, 0xe6, 0x21, EV_KEY, KEY_E, 1},
 247         {KIND_FILTERED, 0xe8, 0x23, EV_KEY, KEY_F, 1},
 248
 249         /* "special" keys */
 250         {KIND_FILTERED, 0xdd, 0x18, EV_KEY, KEY_KPENTER, 1},    /* "check" */
 251         {KIND_FILTERED, 0xdb, 0x16, EV_KEY, KEY_MENU, 1},       /* "menu" */
 252         {KIND_FILTERED, 0xc7, 0x02, EV_KEY, KEY_POWER, 1},      /* Power */
 253         {KIND_FILTERED, 0xc8, 0x03, EV_KEY, KEY_TV, 1},         /* TV */
 254         {KIND_FILTERED, 0xc9, 0x04, EV_KEY, KEY_DVD, 1},        /* DVD */
 255         {KIND_FILTERED, 0xca, 0x05, EV_KEY, KEY_WWW, 1},        /* WEB */
 256         {KIND_FILTERED, 0xcb, 0x06, EV_KEY, KEY_BOOKMARKS, 1},  /* "book" */
 257         {KIND_FILTERED, 0xcc, 0x07, EV_KEY, KEY_EDIT, 1},       /* "hand" */
 258         {KIND_FILTERED, 0xe1, 0x1c, EV_KEY, KEY_COFFEE, 1},     /* "timer" */
 259         {KIND_FILTERED, 0xe5, 0x20, EV_KEY, KEY_FRONT, 1},      /* "max" */
 260         {KIND_FILTERED, 0xe2, 0x1d, EV_KEY, KEY_LEFT, 1},       /* left */
 261         {KIND_FILTERED, 0xe4, 0x1f, EV_KEY, KEY_RIGHT, 1},      /* right */
 262         {KIND_FILTERED, 0xe7, 0x22, EV_KEY, KEY_DOWN, 1},       /* down */
 263         {KIND_FILTERED, 0xdf, 0x1a, EV_KEY, KEY_UP, 1},         /* up */
 264         {KIND_FILTERED, 0xe3, 0x1e, EV_KEY, KEY_OK, 1},         /* "OK" */
 265         {KIND_FILTERED, 0xce, 0x09, EV_KEY, KEY_VOLUMEDOWN, 1}, /* VOL + */
 266         {KIND_FILTERED, 0xcd, 0x08, EV_KEY, KEY_VOLUMEUP, 1},   /* VOL - */
 267         {KIND_FILTERED, 0xcf, 0x0a, EV_KEY, KEY_MUTE, 1},       /* MUTE  */
 268         {KIND_FILTERED, 0xd0, 0x0b, EV_KEY, KEY_CHANNELUP, 1},  /* CH + */
 269         {KIND_FILTERED, 0xd1, 0x0c, EV_KEY, KEY_CHANNELDOWN, 1},/* CH - */
 270         {KIND_FILTERED, 0xec, 0x27, EV_KEY, KEY_RECORD, 1},     /* ( o) red */
 271         {KIND_FILTERED, 0xea, 0x25, EV_KEY, KEY_PLAY, 1},       /* ( >) */
 272         {KIND_FILTERED, 0xe9, 0x24, EV_KEY, KEY_REWIND, 1},     /* (<<) */
 273         {KIND_FILTERED, 0xeb, 0x26, EV_KEY, KEY_FORWARD, 1},    /* (>>) */
 274         {KIND_FILTERED, 0xed, 0x28, EV_KEY, KEY_STOP, 1},       /* ([]) */
 275         {KIND_FILTERED, 0xee, 0x29, EV_KEY, KEY_PAUSE, 1},      /* ('') */
 276         {KIND_FILTERED, 0xf0, 0x2b, EV_KEY, KEY_PREVIOUS, 1},   /* (<-) */
 277         {KIND_FILTERED, 0xef, 0x2a, EV_KEY, KEY_NEXT, 1},       /* (>+) */
 278         {KIND_FILTERED, 0xf2, 0x2D, EV_KEY, KEY_INFO, 1},       /* PLAYING */
 279         {KIND_FILTERED, 0xf3, 0x2E, EV_KEY, KEY_HOME, 1},       /* TOP */
 280         {KIND_FILTERED, 0xf4, 0x2F, EV_KEY, KEY_END, 1},        /* END */
 281         {KIND_FILTERED, 0xf5, 0x30, EV_KEY, KEY_SELECT, 1},     /* SELECT */
 282
 283         {KIND_END, 0x00, 0x00, EV_MAX + 1, 0, 0}
 284 };
 285
 286 /* Local function prototypes */
 287 static void ati_remote_dump             (unsigned char *data, unsigned int actual_length);
 288 static void ati_remote_delete           (struct ati_remote *dev);
 289 static int ati_remote_open              (struct input_dev *inputdev);
 290 static void ati_remote_close            (struct input_dev *inputdev);
 291 static int ati_remote_sendpacket        (struct ati_remote *ati_remote, u16 cmd, unsigned char *data);
 292 static void ati_remote_irq_out          (struct urb *urb, struct pt_regs *regs);
 293 static void ati_remote_irq_in           (struct urb *urb, struct pt_regs *regs);
 294 static void ati_remote_input_report     (struct urb *urb, struct pt_regs *regs);
 295 static int ati_remote_initialize        (struct ati_remote *ati_remote);
 296 static int ati_remote_probe             (struct usb_interface *interface, const struct usb_device_id *id);
 297 static void ati_remote_disconnect       (struct usb_interface *interface);
 298
 299 /* usb specific object to register with the usb subsystem */
 300 static struct usb_driver ati_remote_driver = {
 301         .owner        = THIS_MODULE,
 302         .name         = "ati_remote",
 303         .probe        = ati_remote_probe,
 304         .disconnect   = ati_remote_disconnect,
 305         .id_table     = ati_remote_table,
 306 };
 307
 308 /*
 309  *      ati_remote_dump_input
 310  */
 311 static void ati_remote_dump(unsigned char *data, unsigned int len)
 312 {
 313         if ((len == 1) && (data[0] != (unsigned char)0xff) && (data[0] != 0x00))
 314                 warn("Weird byte 0x%02x", data[0]);
 315         else if (len == 4)
 316                 warn("Weird key %02x %02x %02x %02x",
 317                      data[0], data[1], data[2], data[3]);
 318         else
 319                 warn("Weird data, len=%d %02x %02x %02x %02x %02x %02x ...",
 320                      len, data[0], data[1], data[2], data[3], data[4], data[5]);
 321 }
 322
 323 /*
 324  *      ati_remote_open
 325  */
 326 static int ati_remote_open(struct input_dev *inputdev)
 327 {
 328         struct ati_remote *ati_remote = inputdev->private;
 329
 330         /* On first open, submit the read urb which was set up previously. */
 331         ati_remote->irq_urb->dev = ati_remote->udev;
 332         if (usb_submit_urb(ati_remote->irq_urb, GFP_KERNEL)) {
 333                 dev_err(&ati_remote->interface->dev,
 334                         "%s: usb_submit_urb failed!\n", __FUNCTION__);
 335                 return -EIO;
 336         }
 337
 338         return 0;
 339 }
 340
 341 /*
 342  *      ati_remote_close
 343  */
 344 static void ati_remote_close(struct input_dev *inputdev)
 345 {
 346         struct ati_remote *ati_remote = inputdev->private;
 347
 348         usb_kill_urb(ati_remote->irq_urb);
 349 }
 350
 351 /*
 352  *              ati_remote_irq_out
 353  */
 354 static void ati_remote_irq_out(struct urb *urb, struct pt_regs *regs)
 355 {
 356         struct ati_remote *ati_remote = urb->context;
 357
 358         if (urb->status) {
 359                 dev_dbg(&ati_remote->interface->dev, "%s: status %d\n",
 360                         __FUNCTION__, urb->status);
 361                 return;
 362         }
 363
 364         ati_remote->send_flags |= SEND_FLAG_COMPLETE;
 365         wmb();
 366         wake_up(&ati_remote->wait);
 367 }
 368
 369 /*
 370  *      ati_remote_sendpacket
 371  *
 372  *      Used to send device initialization strings
 373  */
 374 static int ati_remote_sendpacket(struct ati_remote *ati_remote, u16 cmd, unsigned char *data)
 375 {
 376         int retval = 0;
 377
 378         /* Set up out_urb */
 379         memcpy(ati_remote->out_urb->transfer_buffer + 1, data, LO(cmd));
 380         ((char *) ati_remote->out_urb->transfer_buffer)[0] = HI(cmd);
 381
 382         ati_remote->out_urb->transfer_buffer_length = LO(cmd) + 1;
 383         ati_remote->out_urb->dev = ati_remote->udev;
 384         ati_remote->send_flags = SEND_FLAG_IN_PROGRESS;
 385
 386         retval = usb_submit_urb(ati_remote->out_urb, GFP_ATOMIC);
 387         if (retval) {
 388                 dev_dbg(&ati_remote->interface->dev,
 389                          "sendpacket: usb_submit_urb failed: %d\n", retval);
 390                 return retval;
 391         }
 392
 393         wait_event_timeout(ati_remote->wait,
 394                 ((ati_remote->out_urb->status != -EINPROGRESS) ||
 395                         (ati_remote->send_flags & SEND_FLAG_COMPLETE)),
 396                 HZ);
 397         usb_kill_urb(ati_remote->out_urb);
 398
 399         return retval;
 400 }
 401
 402 /*
 403  *      ati_remote_event_lookup
 404  */
 405 static int ati_remote_event_lookup(int rem, unsigned char d1, unsigned char d2)
 406 {
 407         int i;
 408
 409         for (i = 0; ati_remote_tbl[i].kind != KIND_END; i++) {
 410                 /*
 411                  * Decide if the table entry matches the remote input.
 412                  */
 413                 if ((((ati_remote_tbl[i].data1 & 0x0f) == (d1 & 0x0f))) &&
 414                     ((((ati_remote_tbl[i].data1 >> 4) -
 415                        (d1 >> 4) + rem) & 0x0f) == 0x0f) &&
 416                     (ati_remote_tbl[i].data2 == d2))
 417                         return i;
 418
 419         }
 420         return -1;
 421 }
 422
 423 /*
 424  *      ati_remote_report_input
 425  */
 426 static void ati_remote_input_report(struct urb *urb, struct pt_regs *regs)
 427 {
 428         struct ati_remote *ati_remote = urb->context;
 429         unsigned char *data= ati_remote->inbuf;
 430         struct input_dev *dev = &ati_remote->idev;
 431         int index, acc;
 432         int remote_num;
 433
 434         /* Deal with strange looking inputs */
 435         if ( (urb->actual_length != 4) || (data[0] != 0x14) ||
 436                 ((data[3] & 0x0f) != 0x00) ) {
 437                 ati_remote_dump(data, urb->actual_length);
 438                 return;
 439         }
 440
 441         /* Mask unwanted remote channels.  */
 442         /* note: remote_num is 0-based, channel 1 on remote == 0 here */
 443         remote_num = (data[3] >> 4) & 0x0f;
 444         if (channel_mask & (1 << (remote_num + 1))) {
 445                 dbginfo(&ati_remote->interface->dev,
 446                         "Masked input from channel 0x%02x: data %02x,%02x, mask= 0x%02lx\n",
 447                         remote_num, data[1], data[2], channel_mask);
 448                 return;
 449         }
 450
 451         /* Look up event code index in translation table */
 452         index = ati_remote_event_lookup(remote_num, data[1], data[2]);
 453         if (index < 0) {
 454                 dev_warn(&ati_remote->interface->dev,
 455                          "Unknown input from channel 0x%02x: data %02x,%02x\n",
 456                          remote_num, data[1], data[2]);
 457                 return;
 458         }
 459         dbginfo(&ati_remote->interface->dev,
 460                 "channel 0x%02x; data %02x,%02x; index %d; keycode %d\n",
 461                 remote_num, data[1], data[2], index, ati_remote_tbl[index].code);
 462
 463         if (ati_remote_tbl[index].kind == KIND_LITERAL) {
 464                 input_regs(dev, regs);
 465                 input_event(dev, ati_remote_tbl[index].type,
 466                         ati_remote_tbl[index].code,
 467                         ati_remote_tbl[index].value);
 468                 input_sync(dev);
 469
 470                 ati_remote->old_jiffies = jiffies;
 471                 return;
 472         }
 473
 474         if (ati_remote_tbl[index].kind == KIND_FILTERED) {
 475                 /* Filter duplicate events which happen "too close" together. */
 476                 if ((ati_remote->old_data[0] == data[1]) &&
 477                         (ati_remote->old_data[1] == data[2]) &&
 478                         ((ati_remote->old_jiffies + FILTER_TIME) > jiffies)) {
 479                         ati_remote->repeat_count++;
 480                 } else {
 481                         ati_remote->repeat_count = 0;
 482                 }
 483
 484                 ati_remote->old_data[0] = data[1];
 485                 ati_remote->old_data[1] = data[2];
 486                 ati_remote->old_jiffies = jiffies;
 487
 488                 if ((ati_remote->repeat_count > 0)
 489                     && (ati_remote->repeat_count < 5))
 490                         return;
 491
 492
 493                 input_regs(dev, regs);
 494                 input_event(dev, ati_remote_tbl[index].type,
 495                         ati_remote_tbl[index].code, 1);
 496                 input_event(dev, ati_remote_tbl[index].type,
 497                         ati_remote_tbl[index].code, 0);
 498                 input_sync(dev);
 499
 500                 return;
 501         }
 502
 503         /*
 504          * Other event kinds are from the directional control pad, and have an
 505          * acceleration factor applied to them.  Without this acceleration, the
 506          * control pad is mostly unusable.
 507          *
 508          * If elapsed time since last event is > 1/4 second, user "stopped",
 509          * so reset acceleration. Otherwise, user is probably holding the control
 510          * pad down, so we increase acceleration, ramping up over two seconds to
 511          * a maximum speed.  The acceleration curve is #defined above.
 512          */
 513         if ((jiffies - ati_remote->old_jiffies) > (HZ >> 2)) {
 514                 acc = 1;
 515                 ati_remote->acc_jiffies = jiffies;
 516         }
 517         else if ((jiffies - ati_remote->acc_jiffies) < (HZ >> 3))  acc = accel[0];
 518         else if ((jiffies - ati_remote->acc_jiffies) < (HZ >> 2))  acc = accel[1];
 519         else if ((jiffies - ati_remote->acc_jiffies) < (HZ >> 1))  acc = accel[2];
 520         else if ((jiffies - ati_remote->acc_jiffies) < HZ )        acc = accel[3];
 521         else if ((jiffies - ati_remote->acc_jiffies) < HZ+(HZ>>1)) acc = accel[4];
 522         else if ((jiffies - ati_remote->acc_jiffies) < (HZ << 1))  acc = accel[5];
 523         else acc = accel[6];
 524
 525         input_regs(dev, regs);
 526         switch (ati_remote_tbl[index].kind) {
 527         case KIND_ACCEL:
 528                 input_event(dev, ati_remote_tbl[index].type,
 529                         ati_remote_tbl[index].code,
 530                         ati_remote_tbl[index].value * acc);
 531                 break;
 532         case KIND_LU:
 533                 input_report_rel(dev, REL_X, -acc);
 534                 input_report_rel(dev, REL_Y, -acc);
 535                 break;
 536         case KIND_RU:
 537                 input_report_rel(dev, REL_X, acc);
 538                 input_report_rel(dev, REL_Y, -acc);
 539                 break;
 540         case KIND_LD:
 541                 input_report_rel(dev, REL_X, -acc);
 542                 input_report_rel(dev, REL_Y, acc);
 543                 break;
 544         case KIND_RD:
 545                 input_report_rel(dev, REL_X, acc);
 546                 input_report_rel(dev, REL_Y, acc);
 547                 break;
 548         default:
 549                 dev_dbg(&ati_remote->interface->dev, "ati_remote kind=%d\n",
 550                         ati_remote_tbl[index].kind);
 551         }
 552         input_sync(dev);
 553
 554         ati_remote->old_jiffies = jiffies;
 555         ati_remote->old_data[0] = data[1];
 556         ati_remote->old_data[1] = data[2];
 557 }
 558
 559 /*
 560  *      ati_remote_irq_in
 561  */
 562 static void ati_remote_irq_in(struct urb *urb, struct pt_regs *regs)
 563 {
 564         struct ati_remote *ati_remote = urb->context;
 565         int retval;
 566
 567         switch (urb->status) {
 568         case 0:                 /* success */
 569                 ati_remote_input_report(urb, regs);
 570                 break;
 571         case -ECONNRESET:       /* unlink */
 572         case -ENOENT:
 573         case -ESHUTDOWN:
 574                 dev_dbg(&ati_remote->interface->dev, "%s: urb error status, unlink? \n",
 575                         __FUNCTION__);
 576                 return;
 577         default:                /* error */
 578                 dev_dbg(&ati_remote->interface->dev, "%s: Nonzero urb status %d\n",
 579                         __FUNCTION__, urb->status);
 580         }
 581
 582         retval = usb_submit_urb(urb, SLAB_ATOMIC);
 583         if (retval)
 584                 dev_err(&ati_remote->interface->dev, "%s: usb_submit_urb()=%d\n",
 585                         __FUNCTION__, retval);
 586 }
 587
 588 /*
 589  *      ati_remote_delete
 590  */
 591 static void ati_remote_delete(struct ati_remote *ati_remote)
 592 {
 593         if (ati_remote->irq_urb)
 594                 usb_kill_urb(ati_remote->irq_urb);
 595
 596         if (ati_remote->out_urb)
 597                 usb_kill_urb(ati_remote->out_urb);
 598
 599         input_unregister_device(&ati_remote->idev);
 600
 601         if (ati_remote->inbuf)
 602                 usb_buffer_free(ati_remote->udev, DATA_BUFSIZE,
 603                                 ati_remote->inbuf, ati_remote->inbuf_dma);
 604
 605         if (ati_remote->outbuf)
 606                 usb_buffer_free(ati_remote->udev, DATA_BUFSIZE,
 607                                 ati_remote->outbuf, ati_remote->outbuf_dma);
 608
 609         if (ati_remote->irq_urb)
 610                 usb_free_urb(ati_remote->irq_urb);
 611
 612         if (ati_remote->out_urb)
 613                 usb_free_urb(ati_remote->out_urb);
 614
 615         kfree(ati_remote);
 616 }
 617
 618 static void ati_remote_input_init(struct ati_remote *ati_remote)
 619 {
 620         struct input_dev *idev = &(ati_remote->idev);
 621         int i;
 622
 623         idev->evbit[0] = BIT(EV_KEY) | BIT(EV_REL);
 624         idev->keybit[LONG(BTN_MOUSE)] = ( BIT(BTN_LEFT) | BIT(BTN_RIGHT) |
 625                                           BIT(BTN_SIDE) | BIT(BTN_EXTRA) );
 626         idev->relbit[0] = BIT(REL_X) | BIT(REL_Y);
 627         for (i = 0; ati_remote_tbl[i].kind != KIND_END; i++)
 628                 if (ati_remote_tbl[i].type == EV_KEY)
 629                         set_bit(ati_remote_tbl[i].code, idev->keybit);
 630
 631         idev->private = ati_remote;
 632         idev->open = ati_remote_open;
 633         idev->close = ati_remote_close;
 634
 635         idev->name = ati_remote->name;
 636         idev->phys = ati_remote->phys;
 637
 638         idev->id.bustype = BUS_USB;
 639         idev->id.vendor = le16_to_cpu(ati_remote->udev->descriptor.idVendor);
 640         idev->id.product = le16_to_cpu(ati_remote->udev->descriptor.idProduct);
 641         idev->id.version = le16_to_cpu(ati_remote->udev->descriptor.bcdDevice);
 642         idev->dev = &(ati_remote->udev->dev);
 643 }
 644
 645 static int ati_remote_initialize(struct ati_remote *ati_remote)
 646 {
 647         struct usb_device *udev = ati_remote->udev;
 648         int pipe, maxp;
 649
 650         init_waitqueue_head(&ati_remote->wait);
 651
 652         /* Set up irq_urb */
 653         pipe = usb_rcvintpipe(udev, ati_remote->endpoint_in->bEndpointAddress);
 654         maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe));
 655         maxp = (maxp > DATA_BUFSIZE) ? DATA_BUFSIZE : maxp;
 656
 657         usb_fill_int_urb(ati_remote->irq_urb, udev, pipe, ati_remote->inbuf,
 658                          maxp, ati_remote_irq_in, ati_remote,
 659                          ati_remote->endpoint_in->bInterval);
 660         ati_remote->irq_urb->transfer_dma = ati_remote->inbuf_dma;
 661         ati_remote->irq_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 662
 663         /* Set up out_urb */
 664         pipe = usb_sndintpipe(udev, ati_remote->endpoint_out->bEndpointAddress);
 665         maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe));
 666         maxp = (maxp > DATA_BUFSIZE) ? DATA_BUFSIZE : maxp;
 667
 668         usb_fill_int_urb(ati_remote->out_urb, udev, pipe, ati_remote->outbuf,
 669                          maxp, ati_remote_irq_out, ati_remote,
 670                          ati_remote->endpoint_out->bInterval);
 671         ati_remote->out_urb->transfer_dma = ati_remote->outbuf_dma;
 672         ati_remote->out_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 673
 674         /* send initialization strings */
 675         if ((ati_remote_sendpacket(ati_remote, 0x8004, init1)) ||
 676             (ati_remote_sendpacket(ati_remote, 0x8007, init2))) {
 677                 dev_err(&ati_remote->interface->dev,
 678                          "Initializing ati_remote hardware failed.\n");
 679                 return 1;
 680         }
 681
 682         return 0;
 683 }
 684
 685 /*
 686  *      ati_remote_probe
 687  */
 688 static int ati_remote_probe(struct usb_interface *interface, const struct usb_device_id *id)
 689 {
 690         struct usb_device *udev = interface_to_usbdev(interface);
 691         struct ati_remote *ati_remote = NULL;
 692         struct usb_host_interface *iface_host;
 693         int retval = -ENOMEM;
 694         char path[64];
 695
 696         /* Allocate and clear an ati_remote struct */
 697         if (!(ati_remote = kmalloc(sizeof (struct ati_remote), GFP_KERNEL)))
 698                 return -ENOMEM;
 699         memset(ati_remote, 0x00, sizeof (struct ati_remote));
 700
 701         iface_host = interface->cur_altsetting;
 702         if (iface_host->desc.bNumEndpoints != 2) {
 703                 err("%s: Unexpected desc.bNumEndpoints\n", __FUNCTION__);
 704                 retval = -ENODEV;
 705                 goto error;
 706         }
 707
 708         ati_remote->endpoint_in = &(iface_host->endpoint[0].desc);
 709         ati_remote->endpoint_out = &(iface_host->endpoint[1].desc);
 710         ati_remote->udev = udev;
 711         ati_remote->interface = interface;
 712
 713         if (!(ati_remote->endpoint_in->bEndpointAddress & 0x80)) {
 714                 err("%s: Unexpected endpoint_in->bEndpointAddress\n", __FUNCTION__);
 715                 retval = -ENODEV;
 716                 goto error;
 717         }
 718         if ((ati_remote->endpoint_in->bmAttributes & 3) != 3) {
 719                 err("%s: Unexpected endpoint_in->bmAttributes\n", __FUNCTION__);
 720                 retval = -ENODEV;
 721                 goto error;
 722         }
 723         if (le16_to_cpu(ati_remote->endpoint_in->wMaxPacketSize) == 0) {
 724                 err("%s: endpoint_in message size==0? \n", __FUNCTION__);
 725                 retval = -ENODEV;
 726                 goto error;
 727         }
 728
 729         /* Allocate URB buffers, URBs */
 730         ati_remote->inbuf = usb_buffer_alloc(udev, DATA_BUFSIZE, SLAB_ATOMIC,
 731                                              &ati_remote->inbuf_dma);
 732         if (!ati_remote->inbuf)
 733                 goto error;
 734
 735         ati_remote->outbuf = usb_buffer_alloc(udev, DATA_BUFSIZE, SLAB_ATOMIC,
 736                                               &ati_remote->outbuf_dma);
 737         if (!ati_remote->outbuf)
 738                 goto error;
 739
 740         ati_remote->irq_urb = usb_alloc_urb(0, GFP_KERNEL);
 741         if (!ati_remote->irq_urb)
 742                 goto error;
 743
 744         ati_remote->out_urb = usb_alloc_urb(0, GFP_KERNEL);
 745         if (!ati_remote->out_urb)
 746                 goto error;
 747
 748         usb_make_path(udev, path, NAME_BUFSIZE);
 749         sprintf(ati_remote->phys, "%s/input%d", path, ATI_INPUTNUM);
 750         if (udev->manufacturer)
 751                 strcat(ati_remote->name, udev->manufacturer);
 752
 753         if (udev->product)
 754                 sprintf(ati_remote->name, "%s %s", ati_remote->name, udev->product);
 755
 756         if (!strlen(ati_remote->name))
 757                 sprintf(ati_remote->name, DRIVER_DESC "(%04x,%04x)",
 758                         le16_to_cpu(ati_remote->udev->descriptor.idVendor),
 759                         le16_to_cpu(ati_remote->udev->descriptor.idProduct));
 760
 761         /* Device Hardware Initialization - fills in ati_remote->idev from udev. */
 762         retval = ati_remote_initialize(ati_remote);
 763         if (retval)
 764                 goto error;
 765
 766         /* Set up and register input device */
 767         ati_remote_input_init(ati_remote);
 768         input_register_device(&ati_remote->idev);
 769
 770         dev_info(&ati_remote->interface->dev, "Input registered: %s on %s\n",
 771                  ati_remote->name, path);
 772
 773         usb_set_intfdata(interface, ati_remote);
 774
 775 error:
 776         if (retval)
 777                 ati_remote_delete(ati_remote);
 778
 779         return retval;
 780 }
 781
 782 /*
 783  *      ati_remote_disconnect
 784  */
 785 static void ati_remote_disconnect(struct usb_interface *interface)
 786 {
 787         struct ati_remote *ati_remote;
 788
 789         ati_remote = usb_get_intfdata(interface);
 790         usb_set_intfdata(interface, NULL);
 791         if (!ati_remote) {
 792                 warn("%s - null device?\n", __FUNCTION__);
 793                 return;
 794         }
 795
 796         ati_remote_delete(ati_remote);
 797 }
 798
 799 /*
 800  *      ati_remote_init
 801  */
 802 static int __init ati_remote_init(void)
 803 {
 804         int result;
 805
 806         result = usb_register(&ati_remote_driver);
 807         if (result)
 808                 err("usb_register error #%d\n", result);
 809         else
 810                 info("Registered USB driver " DRIVER_DESC " v. " DRIVER_VERSION);
 811
 812         return result;
 813 }
 814
 815 /*
 816  *      ati_remote_exit
 817  */
 818 static void __exit ati_remote_exit(void)
 819 {
 820         usb_deregister(&ati_remote_driver);
 821 }
 822
 823 /*
 824  *      module specification
 825  */
 826
 827 module_init(ati_remote_init);
 828 module_exit(ati_remote_exit);
 829
 830 MODULE_AUTHOR(DRIVER_AUTHOR);
 831 MODULE_DESCRIPTION(DRIVER_DESC);
 832 MODULE_LICENSE("GPL");