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