]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/usb/input/ati_remote.c
[PATCH] drivers/input/keyboard: convert to dynamic input_dev allocation
[mirror_ubuntu-bionic-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
LT
98#include <linux/wait.h>
99
100/*
101 * Module and Version Information, Module Parameters
102 */
05f091ab
DT
103
104#define ATI_REMOTE_VENDOR_ID 0x0bc7
105#define ATI_REMOTE_PRODUCT_ID 0x004
106#define LOLA_REMOTE_PRODUCT_ID 0x002
1da177e4
LT
107#define MEDION_REMOTE_PRODUCT_ID 0x006
108
05f091ab 109#define DRIVER_VERSION "2.2.1"
1da177e4
LT
110#define DRIVER_AUTHOR "Torrey Hoffman <thoffman@arnor.net>"
111#define DRIVER_DESC "ATI/X10 RF USB Remote Control"
112
113#define NAME_BUFSIZE 80 /* size of product name, path buffers */
114#define DATA_BUFSIZE 63 /* size of URB data buffers */
115#define ATI_INPUTNUM 1 /* Which input device to register as */
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 */
150static char accel[] = { 1, 2, 4, 6, 9, 13, 20 };
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
162static DECLARE_MUTEX(disconnect_sem);
163
164struct ati_remote {
05f091ab 165 struct input_dev idev;
1da177e4
LT
166 struct usb_device *udev;
167 struct usb_interface *interface;
05f091ab 168
1da177e4
LT
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
1da177e4
LT
178 unsigned char old_data[2]; /* Detect duplicate events */
179 unsigned long old_jiffies;
180 unsigned long acc_jiffies; /* handle acceleration */
181 unsigned int repeat_count;
05f091ab 182
1da177e4
LT
183 char name[NAME_BUFSIZE];
184 char phys[NAME_BUFSIZE];
185
186 wait_queue_head_t wait;
187 int send_flags;
188};
189
190/* "Kinds" of messages sent from the hardware to the driver. */
191#define KIND_END 0
192#define KIND_LITERAL 1 /* Simply pass to input system */
193#define KIND_FILTERED 2 /* Add artificial key-up events, drop keyrepeats */
194#define KIND_LU 3 /* Directional keypad diagonals - left up, */
195#define KIND_RU 4 /* right up, */
196#define KIND_LD 5 /* left down, */
197#define KIND_RD 6 /* right down */
198#define KIND_ACCEL 7 /* Directional keypad - left, right, up, down.*/
199
200/* Translation table from hardware messages to input events. */
201static struct
202{
203 short kind;
204 unsigned char data1, data2;
205 int type;
206 unsigned int code;
207 int value;
05f091ab 208} ati_remote_tbl[] =
1da177e4
LT
209{
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 */
05f091ab 215 /* Directional control pad diagonals */
1da177e4
LT
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
05f091ab 227 /* Artificial "doubleclick" events are generated by the hardware.
1da177e4
LT
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}, /* (>>) */
05f091ab 275 {KIND_FILTERED, 0xed, 0x28, EV_KEY, KEY_STOP, 1}, /* ([]) */
1da177e4
LT
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 */
05f091ab
DT
282 {KIND_FILTERED, 0xf5, 0x30, EV_KEY, KEY_SELECT, 1}, /* SELECT */
283
1da177e4
LT
284 {KIND_END, 0x00, 0x00, EV_MAX + 1, 0, 0}
285};
286
287/* Local function prototypes */
288static void ati_remote_dump (unsigned char *data, unsigned int actual_length);
289static void ati_remote_delete (struct ati_remote *dev);
290static int ati_remote_open (struct input_dev *inputdev);
291static void ati_remote_close (struct input_dev *inputdev);
292static int ati_remote_sendpacket (struct ati_remote *ati_remote, u16 cmd, unsigned char *data);
293static void ati_remote_irq_out (struct urb *urb, struct pt_regs *regs);
294static void ati_remote_irq_in (struct urb *urb, struct pt_regs *regs);
295static void ati_remote_input_report (struct urb *urb, struct pt_regs *regs);
296static int ati_remote_initialize (struct ati_remote *ati_remote);
297static int ati_remote_probe (struct usb_interface *interface, const struct usb_device_id *id);
298static void ati_remote_disconnect (struct usb_interface *interface);
299
300/* usb specific object to register with the usb subsystem */
301static struct usb_driver ati_remote_driver = {
302 .owner = THIS_MODULE,
303 .name = "ati_remote",
304 .probe = ati_remote_probe,
305 .disconnect = ati_remote_disconnect,
306 .id_table = ati_remote_table,
307};
308
309/*
310 * ati_remote_dump_input
311 */
312static void ati_remote_dump(unsigned char *data, unsigned int len)
313{
314 if ((len == 1) && (data[0] != (unsigned char)0xff) && (data[0] != 0x00))
315 warn("Weird byte 0x%02x", data[0]);
316 else if (len == 4)
05f091ab 317 warn("Weird key %02x %02x %02x %02x",
1da177e4
LT
318 data[0], data[1], data[2], data[3]);
319 else
320 warn("Weird data, len=%d %02x %02x %02x %02x %02x %02x ...",
321 len, data[0], data[1], data[2], data[3], data[4], data[5]);
322}
323
324/*
325 * ati_remote_open
326 */
327static int ati_remote_open(struct input_dev *inputdev)
328{
329 struct ati_remote *ati_remote = inputdev->private;
1da177e4
LT
330
331 /* On first open, submit the read urb which was set up previously. */
332 ati_remote->irq_urb->dev = ati_remote->udev;
333 if (usb_submit_urb(ati_remote->irq_urb, GFP_KERNEL)) {
05f091ab 334 dev_err(&ati_remote->interface->dev,
1da177e4 335 "%s: usb_submit_urb failed!\n", __FUNCTION__);
65cde54b 336 return -EIO;
1da177e4
LT
337 }
338
65cde54b 339 return 0;
1da177e4
LT
340}
341
342/*
343 * ati_remote_close
344 */
345static void ati_remote_close(struct input_dev *inputdev)
346{
347 struct ati_remote *ati_remote = inputdev->private;
05f091ab 348
65cde54b 349 usb_kill_urb(ati_remote->irq_urb);
1da177e4
LT
350}
351
352/*
353 * ati_remote_irq_out
354 */
355static void ati_remote_irq_out(struct urb *urb, struct pt_regs *regs)
356{
357 struct ati_remote *ati_remote = urb->context;
05f091ab 358
1da177e4
LT
359 if (urb->status) {
360 dev_dbg(&ati_remote->interface->dev, "%s: status %d\n",
361 __FUNCTION__, urb->status);
362 return;
363 }
05f091ab 364
1da177e4
LT
365 ati_remote->send_flags |= SEND_FLAG_COMPLETE;
366 wmb();
367 wake_up(&ati_remote->wait);
368}
369
370/*
371 * ati_remote_sendpacket
05f091ab 372 *
1da177e4
LT
373 * Used to send device initialization strings
374 */
375static int ati_remote_sendpacket(struct ati_remote *ati_remote, u16 cmd, unsigned char *data)
376{
377 int retval = 0;
05f091ab 378
1da177e4
LT
379 /* Set up out_urb */
380 memcpy(ati_remote->out_urb->transfer_buffer + 1, data, LO(cmd));
05f091ab 381 ((char *) ati_remote->out_urb->transfer_buffer)[0] = HI(cmd);
1da177e4
LT
382
383 ati_remote->out_urb->transfer_buffer_length = LO(cmd) + 1;
384 ati_remote->out_urb->dev = ati_remote->udev;
385 ati_remote->send_flags = SEND_FLAG_IN_PROGRESS;
386
387 retval = usb_submit_urb(ati_remote->out_urb, GFP_ATOMIC);
388 if (retval) {
05f091ab 389 dev_dbg(&ati_remote->interface->dev,
1da177e4
LT
390 "sendpacket: usb_submit_urb failed: %d\n", retval);
391 return retval;
392 }
393
394 wait_event_timeout(ati_remote->wait,
395 ((ati_remote->out_urb->status != -EINPROGRESS) ||
05f091ab 396 (ati_remote->send_flags & SEND_FLAG_COMPLETE)),
1da177e4
LT
397 HZ);
398 usb_kill_urb(ati_remote->out_urb);
05f091ab 399
1da177e4
LT
400 return retval;
401}
402
403/*
404 * ati_remote_event_lookup
405 */
406static int ati_remote_event_lookup(int rem, unsigned char d1, unsigned char d2)
407{
408 int i;
409
410 for (i = 0; ati_remote_tbl[i].kind != KIND_END; i++) {
05f091ab
DT
411 /*
412 * Decide if the table entry matches the remote input.
1da177e4
LT
413 */
414 if ((((ati_remote_tbl[i].data1 & 0x0f) == (d1 & 0x0f))) &&
05f091ab
DT
415 ((((ati_remote_tbl[i].data1 >> 4) -
416 (d1 >> 4) + rem) & 0x0f) == 0x0f) &&
1da177e4
LT
417 (ati_remote_tbl[i].data2 == d2))
418 return i;
05f091ab 419
1da177e4
LT
420 }
421 return -1;
422}
423
424/*
425 * ati_remote_report_input
426 */
05f091ab 427static void ati_remote_input_report(struct urb *urb, struct pt_regs *regs)
1da177e4
LT
428{
429 struct ati_remote *ati_remote = urb->context;
430 unsigned char *data= ati_remote->inbuf;
05f091ab 431 struct input_dev *dev = &ati_remote->idev;
1da177e4
LT
432 int index, acc;
433 int remote_num;
05f091ab 434
1da177e4 435 /* Deal with strange looking inputs */
05f091ab 436 if ( (urb->actual_length != 4) || (data[0] != 0x14) ||
1da177e4
LT
437 ((data[3] & 0x0f) != 0x00) ) {
438 ati_remote_dump(data, urb->actual_length);
439 return;
440 }
441
442 /* Mask unwanted remote channels. */
443 /* note: remote_num is 0-based, channel 1 on remote == 0 here */
444 remote_num = (data[3] >> 4) & 0x0f;
05f091ab 445 if (channel_mask & (1 << (remote_num + 1))) {
1da177e4
LT
446 dbginfo(&ati_remote->interface->dev,
447 "Masked input from channel 0x%02x: data %02x,%02x, mask= 0x%02lx\n",
448 remote_num, data[1], data[2], channel_mask);
449 return;
450 }
451
452 /* Look up event code index in translation table */
453 index = ati_remote_event_lookup(remote_num, data[1], data[2]);
454 if (index < 0) {
05f091ab
DT
455 dev_warn(&ati_remote->interface->dev,
456 "Unknown input from channel 0x%02x: data %02x,%02x\n",
1da177e4
LT
457 remote_num, data[1], data[2]);
458 return;
05f091ab
DT
459 }
460 dbginfo(&ati_remote->interface->dev,
1da177e4
LT
461 "channel 0x%02x; data %02x,%02x; index %d; keycode %d\n",
462 remote_num, data[1], data[2], index, ati_remote_tbl[index].code);
05f091ab 463
1da177e4
LT
464 if (ati_remote_tbl[index].kind == KIND_LITERAL) {
465 input_regs(dev, regs);
466 input_event(dev, ati_remote_tbl[index].type,
467 ati_remote_tbl[index].code,
468 ati_remote_tbl[index].value);
469 input_sync(dev);
05f091ab 470
1da177e4
LT
471 ati_remote->old_jiffies = jiffies;
472 return;
473 }
05f091ab 474
1da177e4
LT
475 if (ati_remote_tbl[index].kind == KIND_FILTERED) {
476 /* Filter duplicate events which happen "too close" together. */
05f091ab
DT
477 if ((ati_remote->old_data[0] == data[1]) &&
478 (ati_remote->old_data[1] == data[2]) &&
479 ((ati_remote->old_jiffies + FILTER_TIME) > jiffies)) {
1da177e4 480 ati_remote->repeat_count++;
05f091ab 481 } else {
1da177e4
LT
482 ati_remote->repeat_count = 0;
483 }
05f091ab 484
1da177e4
LT
485 ati_remote->old_data[0] = data[1];
486 ati_remote->old_data[1] = data[2];
487 ati_remote->old_jiffies = jiffies;
488
489 if ((ati_remote->repeat_count > 0)
490 && (ati_remote->repeat_count < 5))
491 return;
05f091ab 492
1da177e4
LT
493
494 input_regs(dev, regs);
495 input_event(dev, ati_remote_tbl[index].type,
496 ati_remote_tbl[index].code, 1);
497 input_event(dev, ati_remote_tbl[index].type,
498 ati_remote_tbl[index].code, 0);
499 input_sync(dev);
500
501 return;
05f091ab
DT
502 }
503
504 /*
1da177e4
LT
505 * Other event kinds are from the directional control pad, and have an
506 * acceleration factor applied to them. Without this acceleration, the
507 * control pad is mostly unusable.
05f091ab 508 *
1da177e4
LT
509 * If elapsed time since last event is > 1/4 second, user "stopped",
510 * so reset acceleration. Otherwise, user is probably holding the control
511 * pad down, so we increase acceleration, ramping up over two seconds to
512 * a maximum speed. The acceleration curve is #defined above.
513 */
514 if ((jiffies - ati_remote->old_jiffies) > (HZ >> 2)) {
515 acc = 1;
516 ati_remote->acc_jiffies = jiffies;
517 }
518 else if ((jiffies - ati_remote->acc_jiffies) < (HZ >> 3)) acc = accel[0];
519 else if ((jiffies - ati_remote->acc_jiffies) < (HZ >> 2)) acc = accel[1];
520 else if ((jiffies - ati_remote->acc_jiffies) < (HZ >> 1)) acc = accel[2];
521 else if ((jiffies - ati_remote->acc_jiffies) < HZ ) acc = accel[3];
522 else if ((jiffies - ati_remote->acc_jiffies) < HZ+(HZ>>1)) acc = accel[4];
523 else if ((jiffies - ati_remote->acc_jiffies) < (HZ << 1)) acc = accel[5];
524 else acc = accel[6];
525
526 input_regs(dev, regs);
527 switch (ati_remote_tbl[index].kind) {
528 case KIND_ACCEL:
529 input_event(dev, ati_remote_tbl[index].type,
530 ati_remote_tbl[index].code,
531 ati_remote_tbl[index].value * acc);
532 break;
533 case KIND_LU:
534 input_report_rel(dev, REL_X, -acc);
535 input_report_rel(dev, REL_Y, -acc);
536 break;
537 case KIND_RU:
538 input_report_rel(dev, REL_X, acc);
539 input_report_rel(dev, REL_Y, -acc);
540 break;
541 case KIND_LD:
542 input_report_rel(dev, REL_X, -acc);
543 input_report_rel(dev, REL_Y, acc);
544 break;
545 case KIND_RD:
546 input_report_rel(dev, REL_X, acc);
547 input_report_rel(dev, REL_Y, acc);
548 break;
549 default:
05f091ab 550 dev_dbg(&ati_remote->interface->dev, "ati_remote kind=%d\n",
1da177e4
LT
551 ati_remote_tbl[index].kind);
552 }
553 input_sync(dev);
554
555 ati_remote->old_jiffies = jiffies;
556 ati_remote->old_data[0] = data[1];
557 ati_remote->old_data[1] = data[2];
558}
559
560/*
561 * ati_remote_irq_in
562 */
563static void ati_remote_irq_in(struct urb *urb, struct pt_regs *regs)
564{
565 struct ati_remote *ati_remote = urb->context;
566 int retval;
567
568 switch (urb->status) {
569 case 0: /* success */
570 ati_remote_input_report(urb, regs);
571 break;
572 case -ECONNRESET: /* unlink */
573 case -ENOENT:
574 case -ESHUTDOWN:
575 dev_dbg(&ati_remote->interface->dev, "%s: urb error status, unlink? \n",
576 __FUNCTION__);
05f091ab 577 return;
1da177e4 578 default: /* error */
05f091ab 579 dev_dbg(&ati_remote->interface->dev, "%s: Nonzero urb status %d\n",
1da177e4
LT
580 __FUNCTION__, urb->status);
581 }
05f091ab 582
1da177e4
LT
583 retval = usb_submit_urb(urb, SLAB_ATOMIC);
584 if (retval)
585 dev_err(&ati_remote->interface->dev, "%s: usb_submit_urb()=%d\n",
586 __FUNCTION__, retval);
587}
588
589/*
590 * ati_remote_delete
591 */
592static void ati_remote_delete(struct ati_remote *ati_remote)
593{
1da177e4
LT
594 if (ati_remote->irq_urb)
595 usb_kill_urb(ati_remote->irq_urb);
596
597 if (ati_remote->out_urb)
598 usb_kill_urb(ati_remote->out_urb);
599
600 input_unregister_device(&ati_remote->idev);
601
602 if (ati_remote->inbuf)
05f091ab 603 usb_buffer_free(ati_remote->udev, DATA_BUFSIZE,
1da177e4 604 ati_remote->inbuf, ati_remote->inbuf_dma);
05f091ab 605
1da177e4 606 if (ati_remote->outbuf)
05f091ab 607 usb_buffer_free(ati_remote->udev, DATA_BUFSIZE,
9719b0c2 608 ati_remote->outbuf, ati_remote->outbuf_dma);
05f091ab 609
1da177e4
LT
610 if (ati_remote->irq_urb)
611 usb_free_urb(ati_remote->irq_urb);
05f091ab 612
1da177e4
LT
613 if (ati_remote->out_urb)
614 usb_free_urb(ati_remote->out_urb);
615
616 kfree(ati_remote);
617}
618
619static void ati_remote_input_init(struct ati_remote *ati_remote)
620{
621 struct input_dev *idev = &(ati_remote->idev);
622 int i;
623
624 idev->evbit[0] = BIT(EV_KEY) | BIT(EV_REL);
05f091ab 625 idev->keybit[LONG(BTN_MOUSE)] = ( BIT(BTN_LEFT) | BIT(BTN_RIGHT) |
1da177e4
LT
626 BIT(BTN_SIDE) | BIT(BTN_EXTRA) );
627 idev->relbit[0] = BIT(REL_X) | BIT(REL_Y);
628 for (i = 0; ati_remote_tbl[i].kind != KIND_END; i++)
629 if (ati_remote_tbl[i].type == EV_KEY)
630 set_bit(ati_remote_tbl[i].code, idev->keybit);
05f091ab 631
1da177e4
LT
632 idev->private = ati_remote;
633 idev->open = ati_remote_open;
634 idev->close = ati_remote_close;
05f091ab 635
1da177e4
LT
636 idev->name = ati_remote->name;
637 idev->phys = ati_remote->phys;
05f091ab 638
16a334c0
DT
639 usb_to_input_id(ati_remote->udev, &idev->id);
640 idev->dev = &ati_remote->udev->dev;
1da177e4
LT
641}
642
643static int ati_remote_initialize(struct ati_remote *ati_remote)
644{
645 struct usb_device *udev = ati_remote->udev;
646 int pipe, maxp;
05f091ab 647
1da177e4
LT
648 init_waitqueue_head(&ati_remote->wait);
649
650 /* Set up irq_urb */
651 pipe = usb_rcvintpipe(udev, ati_remote->endpoint_in->bEndpointAddress);
652 maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe));
653 maxp = (maxp > DATA_BUFSIZE) ? DATA_BUFSIZE : maxp;
05f091ab
DT
654
655 usb_fill_int_urb(ati_remote->irq_urb, udev, pipe, ati_remote->inbuf,
656 maxp, ati_remote_irq_in, ati_remote,
1da177e4
LT
657 ati_remote->endpoint_in->bInterval);
658 ati_remote->irq_urb->transfer_dma = ati_remote->inbuf_dma;
659 ati_remote->irq_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
05f091ab 660
1da177e4
LT
661 /* Set up out_urb */
662 pipe = usb_sndintpipe(udev, ati_remote->endpoint_out->bEndpointAddress);
663 maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe));
664 maxp = (maxp > DATA_BUFSIZE) ? DATA_BUFSIZE : maxp;
665
05f091ab
DT
666 usb_fill_int_urb(ati_remote->out_urb, udev, pipe, ati_remote->outbuf,
667 maxp, ati_remote_irq_out, ati_remote,
1da177e4
LT
668 ati_remote->endpoint_out->bInterval);
669 ati_remote->out_urb->transfer_dma = ati_remote->outbuf_dma;
670 ati_remote->out_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
671
672 /* send initialization strings */
673 if ((ati_remote_sendpacket(ati_remote, 0x8004, init1)) ||
674 (ati_remote_sendpacket(ati_remote, 0x8007, init2))) {
05f091ab 675 dev_err(&ati_remote->interface->dev,
1da177e4
LT
676 "Initializing ati_remote hardware failed.\n");
677 return 1;
678 }
05f091ab 679
1da177e4
LT
680 return 0;
681}
682
683/*
684 * ati_remote_probe
685 */
686static int ati_remote_probe(struct usb_interface *interface, const struct usb_device_id *id)
687{
688 struct usb_device *udev = interface_to_usbdev(interface);
689 struct ati_remote *ati_remote = NULL;
690 struct usb_host_interface *iface_host;
691 int retval = -ENOMEM;
692 char path[64];
693
694 /* Allocate and clear an ati_remote struct */
695 if (!(ati_remote = kmalloc(sizeof (struct ati_remote), GFP_KERNEL)))
696 return -ENOMEM;
697 memset(ati_remote, 0x00, sizeof (struct ati_remote));
698
699 iface_host = interface->cur_altsetting;
700 if (iface_host->desc.bNumEndpoints != 2) {
701 err("%s: Unexpected desc.bNumEndpoints\n", __FUNCTION__);
702 retval = -ENODEV;
703 goto error;
704 }
705
706 ati_remote->endpoint_in = &(iface_host->endpoint[0].desc);
707 ati_remote->endpoint_out = &(iface_host->endpoint[1].desc);
708 ati_remote->udev = udev;
709 ati_remote->interface = interface;
710
711 if (!(ati_remote->endpoint_in->bEndpointAddress & 0x80)) {
712 err("%s: Unexpected endpoint_in->bEndpointAddress\n", __FUNCTION__);
713 retval = -ENODEV;
714 goto error;
715 }
716 if ((ati_remote->endpoint_in->bmAttributes & 3) != 3) {
717 err("%s: Unexpected endpoint_in->bmAttributes\n", __FUNCTION__);
718 retval = -ENODEV;
719 goto error;
720 }
721 if (le16_to_cpu(ati_remote->endpoint_in->wMaxPacketSize) == 0) {
722 err("%s: endpoint_in message size==0? \n", __FUNCTION__);
723 retval = -ENODEV;
724 goto error;
725 }
726
727 /* Allocate URB buffers, URBs */
728 ati_remote->inbuf = usb_buffer_alloc(udev, DATA_BUFSIZE, SLAB_ATOMIC,
729 &ati_remote->inbuf_dma);
730 if (!ati_remote->inbuf)
731 goto error;
732
733 ati_remote->outbuf = usb_buffer_alloc(udev, DATA_BUFSIZE, SLAB_ATOMIC,
734 &ati_remote->outbuf_dma);
735 if (!ati_remote->outbuf)
736 goto error;
737
738 ati_remote->irq_urb = usb_alloc_urb(0, GFP_KERNEL);
739 if (!ati_remote->irq_urb)
740 goto error;
741
742 ati_remote->out_urb = usb_alloc_urb(0, GFP_KERNEL);
743 if (!ati_remote->out_urb)
744 goto error;
745
746 usb_make_path(udev, path, NAME_BUFSIZE);
747 sprintf(ati_remote->phys, "%s/input%d", path, ATI_INPUTNUM);
748 if (udev->manufacturer)
749 strcat(ati_remote->name, udev->manufacturer);
750
751 if (udev->product)
752 sprintf(ati_remote->name, "%s %s", ati_remote->name, udev->product);
753
754 if (!strlen(ati_remote->name))
755 sprintf(ati_remote->name, DRIVER_DESC "(%04x,%04x)",
05f091ab 756 le16_to_cpu(ati_remote->udev->descriptor.idVendor),
1da177e4
LT
757 le16_to_cpu(ati_remote->udev->descriptor.idProduct));
758
759 /* Device Hardware Initialization - fills in ati_remote->idev from udev. */
760 retval = ati_remote_initialize(ati_remote);
761 if (retval)
762 goto error;
763
764 /* Set up and register input device */
765 ati_remote_input_init(ati_remote);
766 input_register_device(&ati_remote->idev);
767
05f091ab 768 dev_info(&ati_remote->interface->dev, "Input registered: %s on %s\n",
1da177e4
LT
769 ati_remote->name, path);
770
771 usb_set_intfdata(interface, ati_remote);
05f091ab 772
1da177e4
LT
773error:
774 if (retval)
775 ati_remote_delete(ati_remote);
776
777 return retval;
778}
779
780/*
781 * ati_remote_disconnect
782 */
783static void ati_remote_disconnect(struct usb_interface *interface)
784{
785 struct ati_remote *ati_remote;
786
1da177e4
LT
787 ati_remote = usb_get_intfdata(interface);
788 usb_set_intfdata(interface, NULL);
789 if (!ati_remote) {
790 warn("%s - null device?\n", __FUNCTION__);
791 return;
792 }
05f091ab 793
1da177e4 794 ati_remote_delete(ati_remote);
1da177e4
LT
795}
796
797/*
798 * ati_remote_init
799 */
800static int __init ati_remote_init(void)
801{
802 int result;
05f091ab 803
1da177e4
LT
804 result = usb_register(&ati_remote_driver);
805 if (result)
806 err("usb_register error #%d\n", result);
807 else
808 info("Registered USB driver " DRIVER_DESC " v. " DRIVER_VERSION);
809
810 return result;
811}
812
813/*
814 * ati_remote_exit
815 */
816static void __exit ati_remote_exit(void)
817{
818 usb_deregister(&ati_remote_driver);
819}
820
05f091ab
DT
821/*
822 * module specification
1da177e4
LT
823 */
824
825module_init(ati_remote_init);
826module_exit(ati_remote_exit);
827
828MODULE_AUTHOR(DRIVER_AUTHOR);
829MODULE_DESCRIPTION(DRIVER_DESC);
830MODULE_LICENSE("GPL");