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