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