1 /*
2 * USB ATI Remote support
3 *
4 * Version 2.2.0 Copyright (c) 2004 Torrey Hoffman <thoffman@arnor.net>
5 * Version 2.1.1 Copyright (c) 2002 Vladimir Dergachev
6 *
7 * This 2.2.0 version is a rewrite / cleanup of the 2.1.1 driver, including
8 * porting to the 2.6 kernel interfaces, along with other modification
9 * to better match the style of the existing usb/input drivers. However, the
10 * protocol and hardware handling is essentially unchanged from 2.1.1.
11 *
12 * The 2.1.1 driver was derived from the usbati_remote and usbkbd drivers by
13 * Vojtech Pavlik.
14 *
15 * Changes:
16 *
17 * Feb 2004: Torrey Hoffman <thoffman@arnor.net>
18 * Version 2.2.0
19 * Jun 2004: Torrey Hoffman <thoffman@arnor.net>
20 * Version 2.2.1
21 * Added key repeat support contributed by:
22 * Vincent Vanackere <vanackere@lif.univ-mrs.fr>
23 * Added support for the "Lola" remote contributed by:
24 * Seth Cohn <sethcohn@yahoo.com>
25 *
26 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
27 *
28 * This program is free software; you can redistribute it and/or modify
29 * it under the terms of the GNU General Public License as published by
30 * the Free Software Foundation; either version 2 of the License, or
31 * (at your option) any later version.
32 *
33 * This program is distributed in the hope that it will be useful,
34 * but WITHOUT ANY WARRANTY; without even the implied warranty of
35 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
36 * GNU General Public License for more details.
37 *
38 * You should have received a copy of the GNU General Public License
39 * along with this program; if not, write to the Free Software
40 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
41 *
42 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
43 *
44 * Hardware & software notes
45 *
46 * These remote controls are distributed by ATI as part of their
47 * "All-In-Wonder" video card packages. The receiver self-identifies as a
48 * "USB Receiver" with manufacturer "X10 Wireless Technology Inc".
49 *
50 * The "Lola" remote is available from X10. See:
51 * http://www.x10.com/products/lola_sg1.htm
52 * The Lola is similar to the ATI remote but has no mouse support, and slightly
53 * different keys.
54 *
55 * It is possible to use multiple receivers and remotes on multiple computers
56 * simultaneously by configuring them to use specific channels.
57 *
58 * The RF protocol used by the remote supports 16 distinct channels, 1 to 16.
59 * Actually, it may even support more, at least in some revisions of the
60 * hardware.
61 *
62 * Each remote can be configured to transmit on one channel as follows:
63 * - Press and hold the "hand icon" button.
64 * - When the red LED starts to blink, let go of the "hand icon" button.
65 * - When it stops blinking, input the channel code as two digits, from 01
66 * to 16, and press the hand icon again.
67 *
68 * The timing can be a little tricky. Try loading the module with debug=1
69 * to have the kernel print out messages about the remote control number
70 * and mask. Note: debugging prints remote numbers as zero-based hexadecimal.
71 *
72 * The driver has a "channel_mask" parameter. This bitmask specifies which
73 * channels will be ignored by the module. To mask out channels, just add
74 * all the 2^channel_number values together.
75 *
76 * For instance, set channel_mask = 2^4 = 16 (binary 10000) to make ati_remote
77 * ignore signals coming from remote controls transmitting on channel 4, but
78 * accept all other channels.
79 *
80 * Or, set channel_mask = 65533, (0xFFFD), and all channels except 1 will be
81 * ignored.
82 *
83 * The default is 0 (respond to all channels). Bit 0 and bits 17-32 of this
84 * parameter are unused.
85 *
86 */
87
88 #include <linux/kernel.h>
89 #include <linux/errno.h>
90 #include <linux/init.h>
91 #include <linux/slab.h>
92 #include <linux/module.h>
93 #include <linux/usb/input.h>
94 #include <linux/wait.h>
95 #include <linux/jiffies.h>
96
97 /*
98 * Module and Version Information, Module Parameters
99 */
100
101 #define ATI_REMOTE_VENDOR_ID 0x0bc7
102 #define ATI_REMOTE_PRODUCT_ID 0x004
103 #define LOLA_REMOTE_PRODUCT_ID 0x002
104 #define MEDION_REMOTE_PRODUCT_ID 0x006
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
113 /*
114 * Duplicate event filtering time.
115 * Sequential, identical KIND_FILTERED inputs with less than
116 * FILTER_TIME milliseconds between them are considered as repeat
117 * events. The hardware generates 5 events for the first keypress
118 * and we have to take this into account for an accurate repeat
119 * behaviour.
120 */
121 #define FILTER_TIME 60 /* msec */
122 #define REPEAT_DELAY 500 /* msec */
123
124 static unsigned long channel_mask;
125 module_param(channel_mask, ulong, 0644);
126 MODULE_PARM_DESC(channel_mask, "Bitmask of remote control channels to ignore");
127
128 static int debug;
129 module_param(debug, int, 0644);
130 MODULE_PARM_DESC(debug, "Enable extra debug messages and information");
131
132 static int repeat_filter = FILTER_TIME;
133 module_param(repeat_filter, int, 0644);
134 MODULE_PARM_DESC(repeat_filter, "Repeat filter time, default = 60 msec");
135
136 static int repeat_delay = REPEAT_DELAY;
137 module_param(repeat_delay, int, 0644);
138 MODULE_PARM_DESC(repeat_delay, "Delay before sending repeats, default = 500 msec");
139
140 #define dbginfo(dev, format, arg...) do { if (debug) dev_info(dev , format , ## arg); } while (0)
141 #undef err
142 #define err(format, arg...) printk(KERN_ERR format , ## arg)
143
144 static struct usb_device_id ati_remote_table[] = {
145 { USB_DEVICE(ATI_REMOTE_VENDOR_ID, ATI_REMOTE_PRODUCT_ID) },
146 { USB_DEVICE(ATI_REMOTE_VENDOR_ID, LOLA_REMOTE_PRODUCT_ID) },
147 { USB_DEVICE(ATI_REMOTE_VENDOR_ID, MEDION_REMOTE_PRODUCT_ID) },
148 {} /* Terminating entry */
149 };
150
151 MODULE_DEVICE_TABLE(usb, ati_remote_table);
152
153 /* Get hi and low bytes of a 16-bits int */
154 #define HI(a) ((unsigned char)((a) >> 8))
155 #define LO(a) ((unsigned char)((a) & 0xff))
156
157 #define SEND_FLAG_IN_PROGRESS 1
158 #define SEND_FLAG_COMPLETE 2
159
160 /* Device initialization strings */
161 static char init1[] = { 0x01, 0x00, 0x20, 0x14 };
162 static char init2[] = { 0x01, 0x00, 0x20, 0x14, 0x20, 0x20, 0x20 };
163
164 struct ati_remote {
165 struct input_dev *idev;
166 struct usb_device *udev;
167 struct usb_interface *interface;
168
169 struct urb *irq_urb;
170 struct urb *out_urb;
171 struct usb_endpoint_descriptor *endpoint_in;
172 struct usb_endpoint_descriptor *endpoint_out;
173 unsigned char *inbuf;
174 unsigned char *outbuf;
175 dma_addr_t inbuf_dma;
176 dma_addr_t outbuf_dma;
177
178 unsigned char old_data[2]; /* Detect duplicate events */
179 unsigned long old_jiffies;
180 unsigned long acc_jiffies; /* handle acceleration */
181 unsigned long first_jiffies;
182
183 unsigned int repeat_count;
184
185 char name[NAME_BUFSIZE];
186 char phys[NAME_BUFSIZE];
187
188 wait_queue_head_t wait;
189 int send_flags;
190 };
191
192 /* "Kinds" of messages sent from the hardware to the driver. */
193 #define KIND_END 0
194 #define KIND_LITERAL 1 /* Simply pass to input system */
195 #define KIND_FILTERED 2 /* Add artificial key-up events, drop keyrepeats */
196 #define KIND_LU 3 /* Directional keypad diagonals - left up, */
197 #define KIND_RU 4 /* right up, */
198 #define KIND_LD 5 /* left down, */
199 #define KIND_RD 6 /* right down */
200 #define KIND_ACCEL 7 /* Directional keypad - left, right, up, down.*/
201
202 /* Translation table from hardware messages to input events. */
203 static const struct {
204 short kind;
205 unsigned char data1, data2;
206 int type;
207 unsigned int code;
208 int value;
209 } ati_remote_tbl[] = {
210 /* Directional control pad axes */
211 {KIND_ACCEL, 0x35, 0x70, EV_REL, REL_X, -1}, /* left */
212 {KIND_ACCEL, 0x36, 0x71, EV_REL, REL_X, 1}, /* right */
213 {KIND_ACCEL, 0x37, 0x72, EV_REL, REL_Y, -1}, /* up */
214 {KIND_ACCEL, 0x38, 0x73, EV_REL, REL_Y, 1}, /* down */
215 /* Directional control pad diagonals */
216 {KIND_LU, 0x39, 0x74, EV_REL, 0, 0}, /* left up */
217 {KIND_RU, 0x3a, 0x75, EV_REL, 0, 0}, /* right up */
218 {KIND_LD, 0x3c, 0x77, EV_REL, 0, 0}, /* left down */
219 {KIND_RD, 0x3b, 0x76, EV_REL, 0, 0}, /* right down */
220
221 /* "Mouse button" buttons */
222 {KIND_LITERAL, 0x3d, 0x78, EV_KEY, BTN_LEFT, 1}, /* left btn down */
223 {KIND_LITERAL, 0x3e, 0x79, EV_KEY, BTN_LEFT, 0}, /* left btn up */
224 {KIND_LITERAL, 0x41, 0x7c, EV_KEY, BTN_RIGHT, 1},/* right btn down */
225 {KIND_LITERAL, 0x42, 0x7d, EV_KEY, BTN_RIGHT, 0},/* right btn up */
226
227 /* Artificial "doubleclick" events are generated by the hardware.
228 * They are mapped to the "side" and "extra" mouse buttons here. */
229 {KIND_FILTERED, 0x3f, 0x7a, EV_KEY, BTN_SIDE, 1}, /* left dblclick */
230 {KIND_FILTERED, 0x43, 0x7e, EV_KEY, BTN_EXTRA, 1},/* right dblclick */
231
232 /* keyboard. */
233 {KIND_FILTERED, 0xd2, 0x0d, EV_KEY, KEY_1, 1},
234 {KIND_FILTERED, 0xd3, 0x0e, EV_KEY, KEY_2, 1},
235 {KIND_FILTERED, 0xd4, 0x0f, EV_KEY, KEY_3, 1},
236 {KIND_FILTERED, 0xd5, 0x10, EV_KEY, KEY_4, 1},
237 {KIND_FILTERED, 0xd6, 0x11, EV_KEY, KEY_5, 1},
238 {KIND_FILTERED, 0xd7, 0x12, EV_KEY, KEY_6, 1},
239 {KIND_FILTERED, 0xd8, 0x13, EV_KEY, KEY_7, 1},
240 {KIND_FILTERED, 0xd9, 0x14, EV_KEY, KEY_8, 1},
241 {KIND_FILTERED, 0xda, 0x15, EV_KEY, KEY_9, 1},
242 {KIND_FILTERED, 0xdc, 0x17, EV_KEY, KEY_0, 1},
243 {KIND_FILTERED, 0xc5, 0x00, EV_KEY, KEY_A, 1},
244 {KIND_FILTERED, 0xc6, 0x01, EV_KEY, KEY_B, 1},
245 {KIND_FILTERED, 0xde, 0x19, EV_KEY, KEY_C, 1},
246 {KIND_FILTERED, 0xe0, 0x1b, EV_KEY, KEY_D, 1},
247 {KIND_FILTERED, 0xe6, 0x21, EV_KEY, KEY_E, 1},
248 {KIND_FILTERED, 0xe8, 0x23, EV_KEY, KEY_F, 1},
249
250 /* "special" keys */
251 {KIND_FILTERED, 0xdd, 0x18, EV_KEY, KEY_KPENTER, 1}, /* "check" */
252 {KIND_FILTERED, 0xdb, 0x16, EV_KEY, KEY_MENU, 1}, /* "menu" */
253 {KIND_FILTERED, 0xc7, 0x02, EV_KEY, KEY_POWER, 1}, /* Power */
254 {KIND_FILTERED, 0xc8, 0x03, EV_KEY, KEY_TV, 1}, /* TV */
255 {KIND_FILTERED, 0xc9, 0x04, EV_KEY, KEY_DVD, 1}, /* DVD */
256 {KIND_FILTERED, 0xca, 0x05, EV_KEY, KEY_WWW, 1}, /* WEB */
257 {KIND_FILTERED, 0xcb, 0x06, EV_KEY, KEY_BOOKMARKS, 1}, /* "book" */
258 {KIND_FILTERED, 0xcc, 0x07, EV_KEY, KEY_EDIT, 1}, /* "hand" */
259 {KIND_FILTERED, 0xe1, 0x1c, EV_KEY, KEY_COFFEE, 1}, /* "timer" */
260 {KIND_FILTERED, 0xe5, 0x20, EV_KEY, KEY_FRONT, 1}, /* "max" */
261 {KIND_FILTERED, 0xe2, 0x1d, EV_KEY, KEY_LEFT, 1}, /* left */
262 {KIND_FILTERED, 0xe4, 0x1f, EV_KEY, KEY_RIGHT, 1}, /* right */
263 {KIND_FILTERED, 0xe7, 0x22, EV_KEY, KEY_DOWN, 1}, /* down */
264 {KIND_FILTERED, 0xdf, 0x1a, EV_KEY, KEY_UP, 1}, /* up */
265 {KIND_FILTERED, 0xe3, 0x1e, EV_KEY, KEY_OK, 1}, /* "OK" */
266 {KIND_FILTERED, 0xce, 0x09, EV_KEY, KEY_VOLUMEDOWN, 1}, /* VOL + */
267 {KIND_FILTERED, 0xcd, 0x08, EV_KEY, KEY_VOLUMEUP, 1}, /* VOL - */
268 {KIND_FILTERED, 0xcf, 0x0a, EV_KEY, KEY_MUTE, 1}, /* MUTE */
269 {KIND_FILTERED, 0xd0, 0x0b, EV_KEY, KEY_CHANNELUP, 1}, /* CH + */
270 {KIND_FILTERED, 0xd1, 0x0c, EV_KEY, KEY_CHANNELDOWN, 1},/* CH - */
271 {KIND_FILTERED, 0xec, 0x27, EV_KEY, KEY_RECORD, 1}, /* ( o) red */
272 {KIND_FILTERED, 0xea, 0x25, EV_KEY, KEY_PLAY, 1}, /* ( >) */
273 {KIND_FILTERED, 0xe9, 0x24, EV_KEY, KEY_REWIND, 1}, /* (<<) */
274 {KIND_FILTERED, 0xeb, 0x26, EV_KEY, KEY_FORWARD, 1}, /* (>>) */
275 {KIND_FILTERED, 0xed, 0x28, EV_KEY, KEY_STOP, 1}, /* ([]) */
276 {KIND_FILTERED, 0xee, 0x29, EV_KEY, KEY_PAUSE, 1}, /* ('') */
277 {KIND_FILTERED, 0xf0, 0x2b, EV_KEY, KEY_PREVIOUS, 1}, /* (<-) */
278 {KIND_FILTERED, 0xef, 0x2a, EV_KEY, KEY_NEXT, 1}, /* (>+) */
279 {KIND_FILTERED, 0xf2, 0x2D, EV_KEY, KEY_INFO, 1}, /* PLAYING */
280 {KIND_FILTERED, 0xf3, 0x2E, EV_KEY, KEY_HOME, 1}, /* TOP */
281 {KIND_FILTERED, 0xf4, 0x2F, EV_KEY, KEY_END, 1}, /* END */
282 {KIND_FILTERED, 0xf5, 0x30, EV_KEY, KEY_SELECT, 1}, /* SELECT */
283
284 {KIND_END, 0x00, 0x00, EV_MAX + 1, 0, 0}
285 };
286
287 /* Local function prototypes */
288 static int ati_remote_open (struct input_dev *inputdev);
289 static void ati_remote_close (struct input_dev *inputdev);
290 static int ati_remote_sendpacket (struct ati_remote *ati_remote, u16 cmd, unsigned char *data);
291 static void ati_remote_irq_out (struct urb *urb);
292 static void ati_remote_irq_in (struct urb *urb);
293 static void ati_remote_input_report (struct urb *urb);
294 static int ati_remote_initialize (struct ati_remote *ati_remote);
295 static int ati_remote_probe (struct usb_interface *interface, const struct usb_device_id *id);
296 static void ati_remote_disconnect (struct usb_interface *interface);
297
298 /* usb specific object to register with the usb subsystem */
299 static struct usb_driver ati_remote_driver = {
300 .name = "ati_remote",
301 .probe = ati_remote_probe,
302 .disconnect = ati_remote_disconnect,
303 .id_table = ati_remote_table,
304 };
305
306 /*
307 * ati_remote_dump_input
308 */
ati_remote_dump(struct device * dev,unsigned char * data,unsigned int len)309 static void ati_remote_dump(struct device *dev, unsigned char *data,
310 unsigned int len)
311 {
312 if ((len == 1) && (data[0] != (unsigned char)0xff) && (data[0] != 0x00))
313 dev_warn(dev, "Weird byte 0x%02x\n", data[0]);
314 else if (len == 4)
315 dev_warn(dev, "Weird key %02x %02x %02x %02x\n",
316 data[0], data[1], data[2], data[3]);
317 else
318 dev_warn(dev, "Weird data, len=%d %02x %02x %02x %02x %02x %02x ...\n",
319 len, data[0], data[1], data[2], data[3], data[4], data[5]);
320 }
321
322 /*
323 * ati_remote_open
324 */
ati_remote_open(struct input_dev * inputdev)325 static int ati_remote_open(struct input_dev *inputdev)
326 {
327 struct ati_remote *ati_remote = input_get_drvdata(inputdev);
328
329 /* On first open, submit the read urb which was set up previously. */
330 ati_remote->irq_urb->dev = ati_remote->udev;
331 if (usb_submit_urb(ati_remote->irq_urb, GFP_KERNEL)) {
332 dev_err(&ati_remote->interface->dev,
333 "%s: usb_submit_urb failed!\n", __func__);
334 return -EIO;
335 }
336
337 return 0;
338 }
339
340 /*
341 * ati_remote_close
342 */
ati_remote_close(struct input_dev * inputdev)343 static void ati_remote_close(struct input_dev *inputdev)
344 {
345 struct ati_remote *ati_remote = input_get_drvdata(inputdev);
346
347 usb_kill_urb(ati_remote->irq_urb);
348 }
349
350 /*
351 * ati_remote_irq_out
352 */
ati_remote_irq_out(struct urb * urb)353 static void ati_remote_irq_out(struct urb *urb)
354 {
355 struct ati_remote *ati_remote = urb->context;
356
357 if (urb->status) {
358 dev_dbg(&ati_remote->interface->dev, "%s: status %d\n",
359 __func__, urb->status);
360 return;
361 }
362
363 ati_remote->send_flags |= SEND_FLAG_COMPLETE;
364 wmb();
365 wake_up(&ati_remote->wait);
366 }
367
368 /*
369 * ati_remote_sendpacket
370 *
371 * Used to send device initialization strings
372 */
ati_remote_sendpacket(struct ati_remote * ati_remote,u16 cmd,unsigned char * data)373 static int ati_remote_sendpacket(struct ati_remote *ati_remote, u16 cmd, unsigned char *data)
374 {
375 int retval = 0;
376
377 /* Set up out_urb */
378 memcpy(ati_remote->out_urb->transfer_buffer + 1, data, LO(cmd));
379 ((char *) ati_remote->out_urb->transfer_buffer)[0] = HI(cmd);
380
381 ati_remote->out_urb->transfer_buffer_length = LO(cmd) + 1;
382 ati_remote->out_urb->dev = ati_remote->udev;
383 ati_remote->send_flags = SEND_FLAG_IN_PROGRESS;
384
385 retval = usb_submit_urb(ati_remote->out_urb, GFP_ATOMIC);
386 if (retval) {
387 dev_dbg(&ati_remote->interface->dev,
388 "sendpacket: usb_submit_urb failed: %d\n", retval);
389 return retval;
390 }
391
392 wait_event_timeout(ati_remote->wait,
393 ((ati_remote->out_urb->status != -EINPROGRESS) ||
394 (ati_remote->send_flags & SEND_FLAG_COMPLETE)),
395 HZ);
396 usb_kill_urb(ati_remote->out_urb);
397
398 return retval;
399 }
400
401 /*
402 * ati_remote_event_lookup
403 */
ati_remote_event_lookup(int rem,unsigned char d1,unsigned char d2)404 static int ati_remote_event_lookup(int rem, unsigned char d1, unsigned char d2)
405 {
406 int i;
407
408 for (i = 0; ati_remote_tbl[i].kind != KIND_END; i++) {
409 /*
410 * Decide if the table entry matches the remote input.
411 */
412 if ((((ati_remote_tbl[i].data1 & 0x0f) == (d1 & 0x0f))) &&
413 ((((ati_remote_tbl[i].data1 >> 4) -
414 (d1 >> 4) + rem) & 0x0f) == 0x0f) &&
415 (ati_remote_tbl[i].data2 == d2))
416 return i;
417
418 }
419 return -1;
420 }
421
422 /*
423 * ati_remote_compute_accel
424 *
425 * Implements acceleration curve for directional control pad
426 * If elapsed time since last event is > 1/4 second, user "stopped",
427 * so reset acceleration. Otherwise, user is probably holding the control
428 * pad down, so we increase acceleration, ramping up over two seconds to
429 * a maximum speed.
430 */
ati_remote_compute_accel(struct ati_remote * ati_remote)431 static int ati_remote_compute_accel(struct ati_remote *ati_remote)
432 {
433 static const char accel[] = { 1, 2, 4, 6, 9, 13, 20 };
434 unsigned long now = jiffies;
435 int acc;
436
437 if (time_after(now, ati_remote->old_jiffies + msecs_to_jiffies(250))) {
438 acc = 1;
439 ati_remote->acc_jiffies = now;
440 }
441 else if (time_before(now, ati_remote->acc_jiffies + msecs_to_jiffies(125)))
442 acc = accel[0];
443 else if (time_before(now, ati_remote->acc_jiffies + msecs_to_jiffies(250)))
444 acc = accel[1];
445 else if (time_before(now, ati_remote->acc_jiffies + msecs_to_jiffies(500)))
446 acc = accel[2];
447 else if (time_before(now, ati_remote->acc_jiffies + msecs_to_jiffies(1000)))
448 acc = accel[3];
449 else if (time_before(now, ati_remote->acc_jiffies + msecs_to_jiffies(1500)))
450 acc = accel[4];
451 else if (time_before(now, ati_remote->acc_jiffies + msecs_to_jiffies(2000)))
452 acc = accel[5];
453 else
454 acc = accel[6];
455
456 return acc;
457 }
458
459 /*
460 * ati_remote_report_input
461 */
ati_remote_input_report(struct urb * urb)462 static void ati_remote_input_report(struct urb *urb)
463 {
464 struct ati_remote *ati_remote = urb->context;
465 unsigned char *data= ati_remote->inbuf;
466 struct input_dev *dev = ati_remote->idev;
467 int index, acc;
468 int remote_num;
469
470 /* Deal with strange looking inputs */
471 if ( (urb->actual_length != 4) || (data[0] != 0x14) ||
472 ((data[3] & 0x0f) != 0x00) ) {
473 ati_remote_dump(&urb->dev->dev, data, urb->actual_length);
474 return;
475 }
476
477 /* Mask unwanted remote channels. */
478 /* note: remote_num is 0-based, channel 1 on remote == 0 here */
479 remote_num = (data[3] >> 4) & 0x0f;
480 if (channel_mask & (1 << (remote_num + 1))) {
481 dbginfo(&ati_remote->interface->dev,
482 "Masked input from channel 0x%02x: data %02x,%02x, mask= 0x%02lx\n",
483 remote_num, data[1], data[2], channel_mask);
484 return;
485 }
486
487 /* Look up event code index in translation table */
488 index = ati_remote_event_lookup(remote_num, data[1], data[2]);
489 if (index < 0) {
490 dev_warn(&ati_remote->interface->dev,
491 "Unknown input from channel 0x%02x: data %02x,%02x\n",
492 remote_num, data[1], data[2]);
493 return;
494 }
495 dbginfo(&ati_remote->interface->dev,
496 "channel 0x%02x; data %02x,%02x; index %d; keycode %d\n",
497 remote_num, data[1], data[2], index, ati_remote_tbl[index].code);
498
499 if (ati_remote_tbl[index].kind == KIND_LITERAL) {
500 input_event(dev, ati_remote_tbl[index].type,
501 ati_remote_tbl[index].code,
502 ati_remote_tbl[index].value);
503 input_sync(dev);
504
505 ati_remote->old_jiffies = jiffies;
506 return;
507 }
508
509 if (ati_remote_tbl[index].kind == KIND_FILTERED) {
510 unsigned long now = jiffies;
511
512 /* Filter duplicate events which happen "too close" together. */
513 if (ati_remote->old_data[0] == data[1] &&
514 ati_remote->old_data[1] == data[2] &&
515 time_before(now, ati_remote->old_jiffies +
516 msecs_to_jiffies(repeat_filter))) {
517 ati_remote->repeat_count++;
518 } else {
519 ati_remote->repeat_count = 0;
520 ati_remote->first_jiffies = now;
521 }
522
523 ati_remote->old_data[0] = data[1];
524 ati_remote->old_data[1] = data[2];
525 ati_remote->old_jiffies = now;
526
527 /* Ensure we skip at least the 4 first duplicate events (generated
528 * by a single keypress), and continue skipping until repeat_delay
529 * msecs have passed
530 */
531 if (ati_remote->repeat_count > 0 &&
532 (ati_remote->repeat_count < 5 ||
533 time_before(now, ati_remote->first_jiffies +
534 msecs_to_jiffies(repeat_delay))))
535 return;
536
537
538 input_event(dev, ati_remote_tbl[index].type,
539 ati_remote_tbl[index].code, 1);
540 input_sync(dev);
541 input_event(dev, ati_remote_tbl[index].type,
542 ati_remote_tbl[index].code, 0);
543 input_sync(dev);
544
545 } else {
546
547 /*
548 * Other event kinds are from the directional control pad, and have an
549 * acceleration factor applied to them. Without this acceleration, the
550 * control pad is mostly unusable.
551 */
552 acc = ati_remote_compute_accel(ati_remote);
553
554 switch (ati_remote_tbl[index].kind) {
555 case KIND_ACCEL:
556 input_event(dev, ati_remote_tbl[index].type,
557 ati_remote_tbl[index].code,
558 ati_remote_tbl[index].value * acc);
559 break;
560 case KIND_LU:
561 input_report_rel(dev, REL_X, -acc);
562 input_report_rel(dev, REL_Y, -acc);
563 break;
564 case KIND_RU:
565 input_report_rel(dev, REL_X, acc);
566 input_report_rel(dev, REL_Y, -acc);
567 break;
568 case KIND_LD:
569 input_report_rel(dev, REL_X, -acc);
570 input_report_rel(dev, REL_Y, acc);
571 break;
572 case KIND_RD:
573 input_report_rel(dev, REL_X, acc);
574 input_report_rel(dev, REL_Y, acc);
575 break;
576 default:
577 dev_dbg(&ati_remote->interface->dev, "ati_remote kind=%d\n",
578 ati_remote_tbl[index].kind);
579 }
580 input_sync(dev);
581
582 ati_remote->old_jiffies = jiffies;
583 ati_remote->old_data[0] = data[1];
584 ati_remote->old_data[1] = data[2];
585 }
586 }
587
588 /*
589 * ati_remote_irq_in
590 */
ati_remote_irq_in(struct urb * urb)591 static void ati_remote_irq_in(struct urb *urb)
592 {
593 struct ati_remote *ati_remote = urb->context;
594 int retval;
595
596 switch (urb->status) {
597 case 0: /* success */
598 ati_remote_input_report(urb);
599 break;
600 case -ECONNRESET: /* unlink */
601 case -ENOENT:
602 case -ESHUTDOWN:
603 dev_dbg(&ati_remote->interface->dev, "%s: urb error status, unlink? \n",
604 __func__);
605 return;
606 default: /* error */
607 dev_dbg(&ati_remote->interface->dev, "%s: Nonzero urb status %d\n",
608 __func__, urb->status);
609 }
610
611 retval = usb_submit_urb(urb, GFP_ATOMIC);
612 if (retval)
613 dev_err(&ati_remote->interface->dev, "%s: usb_submit_urb()=%d\n",
614 __func__, retval);
615 }
616
617 /*
618 * ati_remote_alloc_buffers
619 */
ati_remote_alloc_buffers(struct usb_device * udev,struct ati_remote * ati_remote)620 static int ati_remote_alloc_buffers(struct usb_device *udev,
621 struct ati_remote *ati_remote)
622 {
623 ati_remote->inbuf = usb_buffer_alloc(udev, DATA_BUFSIZE, GFP_ATOMIC,
624 &ati_remote->inbuf_dma);
625 if (!ati_remote->inbuf)
626 return -1;
627
628 ati_remote->outbuf = usb_buffer_alloc(udev, DATA_BUFSIZE, GFP_ATOMIC,
629 &ati_remote->outbuf_dma);
630 if (!ati_remote->outbuf)
631 return -1;
632
633 ati_remote->irq_urb = usb_alloc_urb(0, GFP_KERNEL);
634 if (!ati_remote->irq_urb)
635 return -1;
636
637 ati_remote->out_urb = usb_alloc_urb(0, GFP_KERNEL);
638 if (!ati_remote->out_urb)
639 return -1;
640
641 return 0;
642 }
643
644 /*
645 * ati_remote_free_buffers
646 */
ati_remote_free_buffers(struct ati_remote * ati_remote)647 static void ati_remote_free_buffers(struct ati_remote *ati_remote)
648 {
649 usb_free_urb(ati_remote->irq_urb);
650 usb_free_urb(ati_remote->out_urb);
651
652 usb_buffer_free(ati_remote->udev, DATA_BUFSIZE,
653 ati_remote->inbuf, ati_remote->inbuf_dma);
654
655 usb_buffer_free(ati_remote->udev, DATA_BUFSIZE,
656 ati_remote->outbuf, ati_remote->outbuf_dma);
657 }
658
ati_remote_input_init(struct ati_remote * ati_remote)659 static void ati_remote_input_init(struct ati_remote *ati_remote)
660 {
661 struct input_dev *idev = ati_remote->idev;
662 int i;
663
664 idev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REL);
665 idev->keybit[BIT_WORD(BTN_MOUSE)] = BIT_MASK(BTN_LEFT) |
666 BIT_MASK(BTN_RIGHT) | BIT_MASK(BTN_SIDE) | BIT_MASK(BTN_EXTRA);
667 idev->relbit[0] = BIT_MASK(REL_X) | BIT_MASK(REL_Y);
668 for (i = 0; ati_remote_tbl[i].kind != KIND_END; i++)
669 if (ati_remote_tbl[i].type == EV_KEY)
670 set_bit(ati_remote_tbl[i].code, idev->keybit);
671
672 input_set_drvdata(idev, ati_remote);
673
674 idev->open = ati_remote_open;
675 idev->close = ati_remote_close;
676
677 idev->name = ati_remote->name;
678 idev->phys = ati_remote->phys;
679
680 usb_to_input_id(ati_remote->udev, &idev->id);
681 idev->dev.parent = &ati_remote->udev->dev;
682 }
683
ati_remote_initialize(struct ati_remote * ati_remote)684 static int ati_remote_initialize(struct ati_remote *ati_remote)
685 {
686 struct usb_device *udev = ati_remote->udev;
687 int pipe, maxp;
688
689 init_waitqueue_head(&ati_remote->wait);
690
691 /* Set up irq_urb */
692 pipe = usb_rcvintpipe(udev, ati_remote->endpoint_in->bEndpointAddress);
693 maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe));
694 maxp = (maxp > DATA_BUFSIZE) ? DATA_BUFSIZE : maxp;
695
696 usb_fill_int_urb(ati_remote->irq_urb, udev, pipe, ati_remote->inbuf,
697 maxp, ati_remote_irq_in, ati_remote,
698 ati_remote->endpoint_in->bInterval);
699 ati_remote->irq_urb->transfer_dma = ati_remote->inbuf_dma;
700 ati_remote->irq_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
701
702 /* Set up out_urb */
703 pipe = usb_sndintpipe(udev, ati_remote->endpoint_out->bEndpointAddress);
704 maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe));
705 maxp = (maxp > DATA_BUFSIZE) ? DATA_BUFSIZE : maxp;
706
707 usb_fill_int_urb(ati_remote->out_urb, udev, pipe, ati_remote->outbuf,
708 maxp, ati_remote_irq_out, ati_remote,
709 ati_remote->endpoint_out->bInterval);
710 ati_remote->out_urb->transfer_dma = ati_remote->outbuf_dma;
711 ati_remote->out_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
712
713 /* send initialization strings */
714 if ((ati_remote_sendpacket(ati_remote, 0x8004, init1)) ||
715 (ati_remote_sendpacket(ati_remote, 0x8007, init2))) {
716 dev_err(&ati_remote->interface->dev,
717 "Initializing ati_remote hardware failed.\n");
718 return -EIO;
719 }
720
721 return 0;
722 }
723
724 /*
725 * ati_remote_probe
726 */
ati_remote_probe(struct usb_interface * interface,const struct usb_device_id * id)727 static int ati_remote_probe(struct usb_interface *interface, const struct usb_device_id *id)
728 {
729 struct usb_device *udev = interface_to_usbdev(interface);
730 struct usb_host_interface *iface_host = interface->cur_altsetting;
731 struct usb_endpoint_descriptor *endpoint_in, *endpoint_out;
732 struct ati_remote *ati_remote;
733 struct input_dev *input_dev;
734 int err = -ENOMEM;
735
736 if (iface_host->desc.bNumEndpoints != 2) {
737 err("%s: Unexpected desc.bNumEndpoints\n", __func__);
738 return -ENODEV;
739 }
740
741 endpoint_in = &iface_host->endpoint[0].desc;
742 endpoint_out = &iface_host->endpoint[1].desc;
743
744 if (!usb_endpoint_is_int_in(endpoint_in)) {
745 err("%s: Unexpected endpoint_in\n", __func__);
746 return -ENODEV;
747 }
748 if (le16_to_cpu(endpoint_in->wMaxPacketSize) == 0) {
749 err("%s: endpoint_in message size==0? \n", __func__);
750 return -ENODEV;
751 }
752
753 ati_remote = kzalloc(sizeof (struct ati_remote), GFP_KERNEL);
754 input_dev = input_allocate_device();
755 if (!ati_remote || !input_dev)
756 goto fail1;
757
758 /* Allocate URB buffers, URBs */
759 if (ati_remote_alloc_buffers(udev, ati_remote))
760 goto fail2;
761
762 ati_remote->endpoint_in = endpoint_in;
763 ati_remote->endpoint_out = endpoint_out;
764 ati_remote->udev = udev;
765 ati_remote->idev = input_dev;
766 ati_remote->interface = interface;
767
768 usb_make_path(udev, ati_remote->phys, sizeof(ati_remote->phys));
769 strlcpy(ati_remote->phys, "/input0", sizeof(ati_remote->phys));
770
771 if (udev->manufacturer)
772 strlcpy(ati_remote->name, udev->manufacturer, sizeof(ati_remote->name));
773
774 if (udev->product)
775 snprintf(ati_remote->name, sizeof(ati_remote->name),
776 "%s %s", ati_remote->name, udev->product);
777
778 if (!strlen(ati_remote->name))
779 snprintf(ati_remote->name, sizeof(ati_remote->name),
780 DRIVER_DESC "(%04x,%04x)",
781 le16_to_cpu(ati_remote->udev->descriptor.idVendor),
782 le16_to_cpu(ati_remote->udev->descriptor.idProduct));
783
784 ati_remote_input_init(ati_remote);
785
786 /* Device Hardware Initialization - fills in ati_remote->idev from udev. */
787 err = ati_remote_initialize(ati_remote);
788 if (err)
789 goto fail3;
790
791 /* Set up and register input device */
792 err = input_register_device(ati_remote->idev);
793 if (err)
794 goto fail3;
795
796 usb_set_intfdata(interface, ati_remote);
797 return 0;
798
799 fail3: usb_kill_urb(ati_remote->irq_urb);
800 usb_kill_urb(ati_remote->out_urb);
801 fail2: ati_remote_free_buffers(ati_remote);
802 fail1: input_free_device(input_dev);
803 kfree(ati_remote);
804 return err;
805 }
806
807 /*
808 * ati_remote_disconnect
809 */
ati_remote_disconnect(struct usb_interface * interface)810 static void ati_remote_disconnect(struct usb_interface *interface)
811 {
812 struct ati_remote *ati_remote;
813
814 ati_remote = usb_get_intfdata(interface);
815 usb_set_intfdata(interface, NULL);
816 if (!ati_remote) {
817 dev_warn(&interface->dev, "%s - null device?\n", __func__);
818 return;
819 }
820
821 usb_kill_urb(ati_remote->irq_urb);
822 usb_kill_urb(ati_remote->out_urb);
823 input_unregister_device(ati_remote->idev);
824 ati_remote_free_buffers(ati_remote);
825 kfree(ati_remote);
826 }
827
828 /*
829 * ati_remote_init
830 */
ati_remote_init(void)831 static int __init ati_remote_init(void)
832 {
833 int result;
834
835 result = usb_register(&ati_remote_driver);
836 if (result)
837 printk(KERN_ERR KBUILD_MODNAME
838 ": usb_register error #%d\n", result);
839 else
840 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
841 DRIVER_DESC "\n");
842
843 return result;
844 }
845
846 /*
847 * ati_remote_exit
848 */
ati_remote_exit(void)849 static void __exit ati_remote_exit(void)
850 {
851 usb_deregister(&ati_remote_driver);
852 }
853
854 /*
855 * module specification
856 */
857
858 module_init(ati_remote_init);
859 module_exit(ati_remote_exit);
860
861 MODULE_AUTHOR(DRIVER_AUTHOR);
862 MODULE_DESCRIPTION(DRIVER_DESC);
863 MODULE_LICENSE("GPL");
864