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