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