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