Avoid beyond bounds copy while caching ACL
[zen-stable.git] / drivers / media / rc / ati_remote.c
blobbaf907b3ce764added4954d40408e84bd16fa2e3
1 /*
2 * USB ATI Remote support
4 * Copyright (c) 2011 Anssi Hannula <anssi.hannula@iki.fi>
5 * Version 2.2.0 Copyright (c) 2004 Torrey Hoffman <thoffman@arnor.net>
6 * Version 2.1.1 Copyright (c) 2002 Vladimir Dergachev
8 * This 2.2.0 version is a rewrite / cleanup of the 2.1.1 driver, including
9 * porting to the 2.6 kernel interfaces, along with other modification
10 * to better match the style of the existing usb/input drivers. However, the
11 * protocol and hardware handling is essentially unchanged from 2.1.1.
13 * The 2.1.1 driver was derived from the usbati_remote and usbkbd drivers by
14 * Vojtech Pavlik.
16 * Changes:
18 * Feb 2004: Torrey Hoffman <thoffman@arnor.net>
19 * Version 2.2.0
20 * Jun 2004: Torrey Hoffman <thoffman@arnor.net>
21 * Version 2.2.1
22 * Added key repeat support contributed by:
23 * Vincent Vanackere <vanackere@lif.univ-mrs.fr>
24 * Added support for the "Lola" remote contributed by:
25 * Seth Cohn <sethcohn@yahoo.com>
27 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
29 * This program is free software; you can redistribute it and/or modify
30 * it under the terms of the GNU General Public License as published by
31 * the Free Software Foundation; either version 2 of the License, or
32 * (at your option) any later version.
34 * This program is distributed in the hope that it will be useful,
35 * but WITHOUT ANY WARRANTY; without even the implied warranty of
36 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
37 * GNU General Public License for more details.
39 * You should have received a copy of the GNU General Public License
40 * along with this program; if not, write to the Free Software
41 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
43 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
45 * Hardware & software notes
47 * These remote controls are distributed by ATI as part of their
48 * "All-In-Wonder" video card packages. The receiver self-identifies as a
49 * "USB Receiver" with manufacturer "X10 Wireless Technology Inc".
51 * The "Lola" remote is available from X10. See:
52 * http://www.x10.com/products/lola_sg1.htm
53 * The Lola is similar to the ATI remote but has no mouse support, and slightly
54 * different keys.
56 * It is possible to use multiple receivers and remotes on multiple computers
57 * simultaneously by configuring them to use specific channels.
59 * The RF protocol used by the remote supports 16 distinct channels, 1 to 16.
60 * Actually, it may even support more, at least in some revisions of the
61 * hardware.
63 * Each remote can be configured to transmit on one channel as follows:
64 * - Press and hold the "hand icon" button.
65 * - When the red LED starts to blink, let go of the "hand icon" button.
66 * - When it stops blinking, input the channel code as two digits, from 01
67 * to 16, and press the hand icon again.
69 * The timing can be a little tricky. Try loading the module with debug=1
70 * to have the kernel print out messages about the remote control number
71 * and mask. Note: debugging prints remote numbers as zero-based hexadecimal.
73 * The driver has a "channel_mask" parameter. This bitmask specifies which
74 * channels will be ignored by the module. To mask out channels, just add
75 * all the 2^channel_number values together.
77 * For instance, set channel_mask = 2^4 = 16 (binary 10000) to make ati_remote
78 * ignore signals coming from remote controls transmitting on channel 4, but
79 * accept all other channels.
81 * Or, set channel_mask = 65533, (0xFFFD), and all channels except 1 will be
82 * ignored.
84 * The default is 0 (respond to all channels). Bit 0 and bits 17-32 of this
85 * parameter are unused.
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/mutex.h>
95 #include <linux/usb/input.h>
96 #include <linux/wait.h>
97 #include <linux/jiffies.h>
98 #include <media/rc-core.h>
101 * Module and Version Information, Module Parameters
104 #define ATI_REMOTE_VENDOR_ID 0x0bc7
105 #define LOLA_REMOTE_PRODUCT_ID 0x0002
106 #define LOLA2_REMOTE_PRODUCT_ID 0x0003
107 #define ATI_REMOTE_PRODUCT_ID 0x0004
108 #define NVIDIA_REMOTE_PRODUCT_ID 0x0005
109 #define MEDION_REMOTE_PRODUCT_ID 0x0006
110 #define FIREFLY_REMOTE_PRODUCT_ID 0x0008
112 #define DRIVER_VERSION "2.2.1"
113 #define DRIVER_AUTHOR "Torrey Hoffman <thoffman@arnor.net>"
114 #define DRIVER_DESC "ATI/X10 RF USB Remote Control"
116 #define NAME_BUFSIZE 80 /* size of product name, path buffers */
117 #define DATA_BUFSIZE 63 /* size of URB data buffers */
120 * Duplicate event filtering time.
121 * Sequential, identical KIND_FILTERED inputs with less than
122 * FILTER_TIME milliseconds between them are considered as repeat
123 * events. The hardware generates 5 events for the first keypress
124 * and we have to take this into account for an accurate repeat
125 * behaviour.
127 #define FILTER_TIME 60 /* msec */
128 #define REPEAT_DELAY 500 /* msec */
130 static unsigned long channel_mask;
131 module_param(channel_mask, ulong, 0644);
132 MODULE_PARM_DESC(channel_mask, "Bitmask of remote control channels to ignore");
134 static int debug;
135 module_param(debug, int, 0644);
136 MODULE_PARM_DESC(debug, "Enable extra debug messages and information");
138 static int repeat_filter = FILTER_TIME;
139 module_param(repeat_filter, int, 0644);
140 MODULE_PARM_DESC(repeat_filter, "Repeat filter time, default = 60 msec");
142 static int repeat_delay = REPEAT_DELAY;
143 module_param(repeat_delay, int, 0644);
144 MODULE_PARM_DESC(repeat_delay, "Delay before sending repeats, default = 500 msec");
146 static bool mouse = true;
147 module_param(mouse, bool, 0444);
148 MODULE_PARM_DESC(mouse, "Enable mouse device, default = yes");
150 #define dbginfo(dev, format, arg...) do { if (debug) dev_info(dev , format , ## arg); } while (0)
151 #undef err
152 #define err(format, arg...) printk(KERN_ERR format , ## arg)
154 static struct usb_device_id ati_remote_table[] = {
155 { USB_DEVICE(ATI_REMOTE_VENDOR_ID, LOLA_REMOTE_PRODUCT_ID), .driver_info = (unsigned long)RC_MAP_ATI_X10 },
156 { USB_DEVICE(ATI_REMOTE_VENDOR_ID, LOLA2_REMOTE_PRODUCT_ID), .driver_info = (unsigned long)RC_MAP_ATI_X10 },
157 { USB_DEVICE(ATI_REMOTE_VENDOR_ID, ATI_REMOTE_PRODUCT_ID), .driver_info = (unsigned long)RC_MAP_ATI_X10 },
158 { USB_DEVICE(ATI_REMOTE_VENDOR_ID, NVIDIA_REMOTE_PRODUCT_ID), .driver_info = (unsigned long)RC_MAP_ATI_X10 },
159 { USB_DEVICE(ATI_REMOTE_VENDOR_ID, MEDION_REMOTE_PRODUCT_ID), .driver_info = (unsigned long)RC_MAP_MEDION_X10 },
160 { USB_DEVICE(ATI_REMOTE_VENDOR_ID, FIREFLY_REMOTE_PRODUCT_ID), .driver_info = (unsigned long)RC_MAP_SNAPSTREAM_FIREFLY },
161 {} /* Terminating entry */
164 MODULE_DEVICE_TABLE(usb, ati_remote_table);
166 /* Get hi and low bytes of a 16-bits int */
167 #define HI(a) ((unsigned char)((a) >> 8))
168 #define LO(a) ((unsigned char)((a) & 0xff))
170 #define SEND_FLAG_IN_PROGRESS 1
171 #define SEND_FLAG_COMPLETE 2
173 /* Device initialization strings */
174 static char init1[] = { 0x01, 0x00, 0x20, 0x14 };
175 static char init2[] = { 0x01, 0x00, 0x20, 0x14, 0x20, 0x20, 0x20 };
177 struct ati_remote {
178 struct input_dev *idev;
179 struct rc_dev *rdev;
180 struct usb_device *udev;
181 struct usb_interface *interface;
183 struct urb *irq_urb;
184 struct urb *out_urb;
185 struct usb_endpoint_descriptor *endpoint_in;
186 struct usb_endpoint_descriptor *endpoint_out;
187 unsigned char *inbuf;
188 unsigned char *outbuf;
189 dma_addr_t inbuf_dma;
190 dma_addr_t outbuf_dma;
192 unsigned char old_data; /* Detect duplicate events */
193 unsigned long old_jiffies;
194 unsigned long acc_jiffies; /* handle acceleration */
195 unsigned long first_jiffies;
197 unsigned int repeat_count;
199 char rc_name[NAME_BUFSIZE];
200 char rc_phys[NAME_BUFSIZE];
201 char mouse_name[NAME_BUFSIZE];
202 char mouse_phys[NAME_BUFSIZE];
204 wait_queue_head_t wait;
205 int send_flags;
207 int users; /* 0-2, users are rc and input */
208 struct mutex open_mutex;
211 /* "Kinds" of messages sent from the hardware to the driver. */
212 #define KIND_END 0
213 #define KIND_LITERAL 1 /* Simply pass to input system */
214 #define KIND_FILTERED 2 /* Add artificial key-up events, drop keyrepeats */
215 #define KIND_LU 3 /* Directional keypad diagonals - left up, */
216 #define KIND_RU 4 /* right up, */
217 #define KIND_LD 5 /* left down, */
218 #define KIND_RD 6 /* right down */
219 #define KIND_ACCEL 7 /* Directional keypad - left, right, up, down.*/
221 /* Translation table from hardware messages to input events. */
222 static const struct {
223 short kind;
224 unsigned char data;
225 int type;
226 unsigned int code;
227 int value;
228 } ati_remote_tbl[] = {
229 /* Directional control pad axes */
230 {KIND_ACCEL, 0x70, EV_REL, REL_X, -1}, /* left */
231 {KIND_ACCEL, 0x71, EV_REL, REL_X, 1}, /* right */
232 {KIND_ACCEL, 0x72, EV_REL, REL_Y, -1}, /* up */
233 {KIND_ACCEL, 0x73, EV_REL, REL_Y, 1}, /* down */
234 /* Directional control pad diagonals */
235 {KIND_LU, 0x74, EV_REL, 0, 0}, /* left up */
236 {KIND_RU, 0x75, EV_REL, 0, 0}, /* right up */
237 {KIND_LD, 0x77, EV_REL, 0, 0}, /* left down */
238 {KIND_RD, 0x76, EV_REL, 0, 0}, /* right down */
240 /* "Mouse button" buttons */
241 {KIND_LITERAL, 0x78, EV_KEY, BTN_LEFT, 1}, /* left btn down */
242 {KIND_LITERAL, 0x79, EV_KEY, BTN_LEFT, 0}, /* left btn up */
243 {KIND_LITERAL, 0x7c, EV_KEY, BTN_RIGHT, 1},/* right btn down */
244 {KIND_LITERAL, 0x7d, EV_KEY, BTN_RIGHT, 0},/* right btn up */
246 /* Artificial "doubleclick" events are generated by the hardware.
247 * They are mapped to the "side" and "extra" mouse buttons here. */
248 {KIND_FILTERED, 0x7a, EV_KEY, BTN_SIDE, 1}, /* left dblclick */
249 {KIND_FILTERED, 0x7e, EV_KEY, BTN_EXTRA, 1},/* right dblclick */
251 /* Non-mouse events are handled by rc-core */
252 {KIND_END, 0x00, EV_MAX + 1, 0, 0}
255 /* Local function prototypes */
256 static int ati_remote_sendpacket (struct ati_remote *ati_remote, u16 cmd, unsigned char *data);
257 static void ati_remote_irq_out (struct urb *urb);
258 static void ati_remote_irq_in (struct urb *urb);
259 static void ati_remote_input_report (struct urb *urb);
260 static int ati_remote_initialize (struct ati_remote *ati_remote);
261 static int ati_remote_probe (struct usb_interface *interface, const struct usb_device_id *id);
262 static void ati_remote_disconnect (struct usb_interface *interface);
264 /* usb specific object to register with the usb subsystem */
265 static struct usb_driver ati_remote_driver = {
266 .name = "ati_remote",
267 .probe = ati_remote_probe,
268 .disconnect = ati_remote_disconnect,
269 .id_table = ati_remote_table,
273 * ati_remote_dump_input
275 static void ati_remote_dump(struct device *dev, unsigned char *data,
276 unsigned int len)
278 if (len == 1) {
279 if (data[0] != (unsigned char)0xff && data[0] != 0x00)
280 dev_warn(dev, "Weird byte 0x%02x\n", data[0]);
281 } else if (len == 4)
282 dev_warn(dev, "Weird key %02x %02x %02x %02x\n",
283 data[0], data[1], data[2], data[3]);
284 else
285 dev_warn(dev, "Weird data, len=%d %02x %02x %02x %02x %02x %02x ...\n",
286 len, data[0], data[1], data[2], data[3], data[4], data[5]);
290 * ati_remote_open
292 static int ati_remote_open(struct ati_remote *ati_remote)
294 int err = 0;
296 mutex_lock(&ati_remote->open_mutex);
298 if (ati_remote->users++ != 0)
299 goto out; /* one was already active */
301 /* On first open, submit the read urb which was set up previously. */
302 ati_remote->irq_urb->dev = ati_remote->udev;
303 if (usb_submit_urb(ati_remote->irq_urb, GFP_KERNEL)) {
304 dev_err(&ati_remote->interface->dev,
305 "%s: usb_submit_urb failed!\n", __func__);
306 err = -EIO;
309 out: mutex_unlock(&ati_remote->open_mutex);
310 return err;
314 * ati_remote_close
316 static void ati_remote_close(struct ati_remote *ati_remote)
318 mutex_lock(&ati_remote->open_mutex);
319 if (--ati_remote->users == 0)
320 usb_kill_urb(ati_remote->irq_urb);
321 mutex_unlock(&ati_remote->open_mutex);
324 static int ati_remote_input_open(struct input_dev *inputdev)
326 struct ati_remote *ati_remote = input_get_drvdata(inputdev);
327 return ati_remote_open(ati_remote);
330 static void ati_remote_input_close(struct input_dev *inputdev)
332 struct ati_remote *ati_remote = input_get_drvdata(inputdev);
333 ati_remote_close(ati_remote);
336 static int ati_remote_rc_open(struct rc_dev *rdev)
338 struct ati_remote *ati_remote = rdev->priv;
339 return ati_remote_open(ati_remote);
342 static void ati_remote_rc_close(struct rc_dev *rdev)
344 struct ati_remote *ati_remote = rdev->priv;
345 ati_remote_close(ati_remote);
349 * ati_remote_irq_out
351 static void ati_remote_irq_out(struct urb *urb)
353 struct ati_remote *ati_remote = urb->context;
355 if (urb->status) {
356 dev_dbg(&ati_remote->interface->dev, "%s: status %d\n",
357 __func__, urb->status);
358 return;
361 ati_remote->send_flags |= SEND_FLAG_COMPLETE;
362 wmb();
363 wake_up(&ati_remote->wait);
367 * ati_remote_sendpacket
369 * Used to send device initialization strings
371 static int ati_remote_sendpacket(struct ati_remote *ati_remote, u16 cmd, unsigned char *data)
373 int retval = 0;
375 /* Set up out_urb */
376 memcpy(ati_remote->out_urb->transfer_buffer + 1, data, LO(cmd));
377 ((char *) ati_remote->out_urb->transfer_buffer)[0] = HI(cmd);
379 ati_remote->out_urb->transfer_buffer_length = LO(cmd) + 1;
380 ati_remote->out_urb->dev = ati_remote->udev;
381 ati_remote->send_flags = SEND_FLAG_IN_PROGRESS;
383 retval = usb_submit_urb(ati_remote->out_urb, GFP_ATOMIC);
384 if (retval) {
385 dev_dbg(&ati_remote->interface->dev,
386 "sendpacket: usb_submit_urb failed: %d\n", retval);
387 return retval;
390 wait_event_timeout(ati_remote->wait,
391 ((ati_remote->out_urb->status != -EINPROGRESS) ||
392 (ati_remote->send_flags & SEND_FLAG_COMPLETE)),
393 HZ);
394 usb_kill_urb(ati_remote->out_urb);
396 return retval;
400 * ati_remote_compute_accel
402 * Implements acceleration curve for directional control pad
403 * If elapsed time since last event is > 1/4 second, user "stopped",
404 * so reset acceleration. Otherwise, user is probably holding the control
405 * pad down, so we increase acceleration, ramping up over two seconds to
406 * a maximum speed.
408 static int ati_remote_compute_accel(struct ati_remote *ati_remote)
410 static const char accel[] = { 1, 2, 4, 6, 9, 13, 20 };
411 unsigned long now = jiffies;
412 int acc;
414 if (time_after(now, ati_remote->old_jiffies + msecs_to_jiffies(250))) {
415 acc = 1;
416 ati_remote->acc_jiffies = now;
418 else if (time_before(now, ati_remote->acc_jiffies + msecs_to_jiffies(125)))
419 acc = accel[0];
420 else if (time_before(now, ati_remote->acc_jiffies + msecs_to_jiffies(250)))
421 acc = accel[1];
422 else if (time_before(now, ati_remote->acc_jiffies + msecs_to_jiffies(500)))
423 acc = accel[2];
424 else if (time_before(now, ati_remote->acc_jiffies + msecs_to_jiffies(1000)))
425 acc = accel[3];
426 else if (time_before(now, ati_remote->acc_jiffies + msecs_to_jiffies(1500)))
427 acc = accel[4];
428 else if (time_before(now, ati_remote->acc_jiffies + msecs_to_jiffies(2000)))
429 acc = accel[5];
430 else
431 acc = accel[6];
433 return acc;
437 * ati_remote_report_input
439 static void ati_remote_input_report(struct urb *urb)
441 struct ati_remote *ati_remote = urb->context;
442 unsigned char *data= ati_remote->inbuf;
443 struct input_dev *dev = ati_remote->idev;
444 int index = -1;
445 int acc;
446 int remote_num;
447 unsigned char scancode;
448 int i;
451 * data[0] = 0x14
452 * data[1] = data[2] + data[3] + 0xd5 (a checksum byte)
453 * data[2] = the key code (with toggle bit in MSB with some models)
454 * data[3] = channel << 4 (the low 4 bits must be zero)
457 /* Deal with strange looking inputs */
458 if ( (urb->actual_length != 4) || (data[0] != 0x14) ||
459 ((data[3] & 0x0f) != 0x00) ) {
460 ati_remote_dump(&urb->dev->dev, data, urb->actual_length);
461 return;
464 if (data[1] != ((data[2] + data[3] + 0xd5) & 0xff)) {
465 dbginfo(&ati_remote->interface->dev,
466 "wrong checksum in input: %02x %02x %02x %02x\n",
467 data[0], data[1], data[2], data[3]);
468 return;
471 /* Mask unwanted remote channels. */
472 /* note: remote_num is 0-based, channel 1 on remote == 0 here */
473 remote_num = (data[3] >> 4) & 0x0f;
474 if (channel_mask & (1 << (remote_num + 1))) {
475 dbginfo(&ati_remote->interface->dev,
476 "Masked input from channel 0x%02x: data %02x,%02x, mask= 0x%02lx\n",
477 remote_num, data[1], data[2], channel_mask);
478 return;
482 * MSB is a toggle code, though only used by some devices
483 * (e.g. SnapStream Firefly)
485 scancode = data[2] & 0x7f;
487 /* Look up event code index in the mouse translation table. */
488 for (i = 0; ati_remote_tbl[i].kind != KIND_END; i++) {
489 if (scancode == ati_remote_tbl[i].data) {
490 index = i;
491 break;
495 if (index >= 0) {
496 dbginfo(&ati_remote->interface->dev,
497 "channel 0x%02x; mouse data %02x; index %d; keycode %d\n",
498 remote_num, data[2], index, ati_remote_tbl[index].code);
499 if (!dev)
500 return; /* no mouse device */
501 } else
502 dbginfo(&ati_remote->interface->dev,
503 "channel 0x%02x; key data %02x, scancode %02x\n",
504 remote_num, data[2], scancode);
507 if (index >= 0 && ati_remote_tbl[index].kind == KIND_LITERAL) {
508 input_event(dev, ati_remote_tbl[index].type,
509 ati_remote_tbl[index].code,
510 ati_remote_tbl[index].value);
511 input_sync(dev);
513 ati_remote->old_jiffies = jiffies;
514 return;
517 if (index < 0 || ati_remote_tbl[index].kind == KIND_FILTERED) {
518 unsigned long now = jiffies;
520 /* Filter duplicate events which happen "too close" together. */
521 if (ati_remote->old_data == data[2] &&
522 time_before(now, ati_remote->old_jiffies +
523 msecs_to_jiffies(repeat_filter))) {
524 ati_remote->repeat_count++;
525 } else {
526 ati_remote->repeat_count = 0;
527 ati_remote->first_jiffies = now;
530 ati_remote->old_data = data[2];
531 ati_remote->old_jiffies = now;
533 /* Ensure we skip at least the 4 first duplicate events (generated
534 * by a single keypress), and continue skipping until repeat_delay
535 * msecs have passed
537 if (ati_remote->repeat_count > 0 &&
538 (ati_remote->repeat_count < 5 ||
539 time_before(now, ati_remote->first_jiffies +
540 msecs_to_jiffies(repeat_delay))))
541 return;
543 if (index < 0) {
544 /* Not a mouse event, hand it to rc-core. */
547 * We don't use the rc-core repeat handling yet as
548 * it would cause ghost repeats which would be a
549 * regression for this driver.
551 rc_keydown_notimeout(ati_remote->rdev, scancode,
552 data[2]);
553 rc_keyup(ati_remote->rdev);
554 return;
557 input_event(dev, ati_remote_tbl[index].type,
558 ati_remote_tbl[index].code, 1);
559 input_sync(dev);
560 input_event(dev, ati_remote_tbl[index].type,
561 ati_remote_tbl[index].code, 0);
562 input_sync(dev);
564 } else {
567 * Other event kinds are from the directional control pad, and have an
568 * acceleration factor applied to them. Without this acceleration, the
569 * control pad is mostly unusable.
571 acc = ati_remote_compute_accel(ati_remote);
573 switch (ati_remote_tbl[index].kind) {
574 case KIND_ACCEL:
575 input_event(dev, ati_remote_tbl[index].type,
576 ati_remote_tbl[index].code,
577 ati_remote_tbl[index].value * acc);
578 break;
579 case KIND_LU:
580 input_report_rel(dev, REL_X, -acc);
581 input_report_rel(dev, REL_Y, -acc);
582 break;
583 case KIND_RU:
584 input_report_rel(dev, REL_X, acc);
585 input_report_rel(dev, REL_Y, -acc);
586 break;
587 case KIND_LD:
588 input_report_rel(dev, REL_X, -acc);
589 input_report_rel(dev, REL_Y, acc);
590 break;
591 case KIND_RD:
592 input_report_rel(dev, REL_X, acc);
593 input_report_rel(dev, REL_Y, acc);
594 break;
595 default:
596 dev_dbg(&ati_remote->interface->dev, "ati_remote kind=%d\n",
597 ati_remote_tbl[index].kind);
599 input_sync(dev);
601 ati_remote->old_jiffies = jiffies;
602 ati_remote->old_data = data[2];
607 * ati_remote_irq_in
609 static void ati_remote_irq_in(struct urb *urb)
611 struct ati_remote *ati_remote = urb->context;
612 int retval;
614 switch (urb->status) {
615 case 0: /* success */
616 ati_remote_input_report(urb);
617 break;
618 case -ECONNRESET: /* unlink */
619 case -ENOENT:
620 case -ESHUTDOWN:
621 dev_dbg(&ati_remote->interface->dev, "%s: urb error status, unlink? \n",
622 __func__);
623 return;
624 default: /* error */
625 dev_dbg(&ati_remote->interface->dev, "%s: Nonzero urb status %d\n",
626 __func__, urb->status);
629 retval = usb_submit_urb(urb, GFP_ATOMIC);
630 if (retval)
631 dev_err(&ati_remote->interface->dev, "%s: usb_submit_urb()=%d\n",
632 __func__, retval);
636 * ati_remote_alloc_buffers
638 static int ati_remote_alloc_buffers(struct usb_device *udev,
639 struct ati_remote *ati_remote)
641 ati_remote->inbuf = usb_alloc_coherent(udev, DATA_BUFSIZE, GFP_ATOMIC,
642 &ati_remote->inbuf_dma);
643 if (!ati_remote->inbuf)
644 return -1;
646 ati_remote->outbuf = usb_alloc_coherent(udev, DATA_BUFSIZE, GFP_ATOMIC,
647 &ati_remote->outbuf_dma);
648 if (!ati_remote->outbuf)
649 return -1;
651 ati_remote->irq_urb = usb_alloc_urb(0, GFP_KERNEL);
652 if (!ati_remote->irq_urb)
653 return -1;
655 ati_remote->out_urb = usb_alloc_urb(0, GFP_KERNEL);
656 if (!ati_remote->out_urb)
657 return -1;
659 return 0;
663 * ati_remote_free_buffers
665 static void ati_remote_free_buffers(struct ati_remote *ati_remote)
667 usb_free_urb(ati_remote->irq_urb);
668 usb_free_urb(ati_remote->out_urb);
670 usb_free_coherent(ati_remote->udev, DATA_BUFSIZE,
671 ati_remote->inbuf, ati_remote->inbuf_dma);
673 usb_free_coherent(ati_remote->udev, DATA_BUFSIZE,
674 ati_remote->outbuf, ati_remote->outbuf_dma);
677 static void ati_remote_input_init(struct ati_remote *ati_remote)
679 struct input_dev *idev = ati_remote->idev;
680 int i;
682 idev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REL);
683 idev->keybit[BIT_WORD(BTN_MOUSE)] = BIT_MASK(BTN_LEFT) |
684 BIT_MASK(BTN_RIGHT) | BIT_MASK(BTN_SIDE) | BIT_MASK(BTN_EXTRA);
685 idev->relbit[0] = BIT_MASK(REL_X) | BIT_MASK(REL_Y);
686 for (i = 0; ati_remote_tbl[i].kind != KIND_END; i++)
687 if (ati_remote_tbl[i].type == EV_KEY)
688 set_bit(ati_remote_tbl[i].code, idev->keybit);
690 input_set_drvdata(idev, ati_remote);
692 idev->open = ati_remote_input_open;
693 idev->close = ati_remote_input_close;
695 idev->name = ati_remote->mouse_name;
696 idev->phys = ati_remote->mouse_phys;
698 usb_to_input_id(ati_remote->udev, &idev->id);
699 idev->dev.parent = &ati_remote->interface->dev;
702 static void ati_remote_rc_init(struct ati_remote *ati_remote)
704 struct rc_dev *rdev = ati_remote->rdev;
706 rdev->priv = ati_remote;
707 rdev->driver_type = RC_DRIVER_SCANCODE;
708 rdev->allowed_protos = RC_TYPE_OTHER;
709 rdev->driver_name = "ati_remote";
711 rdev->open = ati_remote_rc_open;
712 rdev->close = ati_remote_rc_close;
714 rdev->input_name = ati_remote->rc_name;
715 rdev->input_phys = ati_remote->rc_phys;
717 usb_to_input_id(ati_remote->udev, &rdev->input_id);
718 rdev->dev.parent = &ati_remote->interface->dev;
721 static int ati_remote_initialize(struct ati_remote *ati_remote)
723 struct usb_device *udev = ati_remote->udev;
724 int pipe, maxp;
726 init_waitqueue_head(&ati_remote->wait);
728 /* Set up irq_urb */
729 pipe = usb_rcvintpipe(udev, ati_remote->endpoint_in->bEndpointAddress);
730 maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe));
731 maxp = (maxp > DATA_BUFSIZE) ? DATA_BUFSIZE : maxp;
733 usb_fill_int_urb(ati_remote->irq_urb, udev, pipe, ati_remote->inbuf,
734 maxp, ati_remote_irq_in, ati_remote,
735 ati_remote->endpoint_in->bInterval);
736 ati_remote->irq_urb->transfer_dma = ati_remote->inbuf_dma;
737 ati_remote->irq_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
739 /* Set up out_urb */
740 pipe = usb_sndintpipe(udev, ati_remote->endpoint_out->bEndpointAddress);
741 maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe));
742 maxp = (maxp > DATA_BUFSIZE) ? DATA_BUFSIZE : maxp;
744 usb_fill_int_urb(ati_remote->out_urb, udev, pipe, ati_remote->outbuf,
745 maxp, ati_remote_irq_out, ati_remote,
746 ati_remote->endpoint_out->bInterval);
747 ati_remote->out_urb->transfer_dma = ati_remote->outbuf_dma;
748 ati_remote->out_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
750 /* send initialization strings */
751 if ((ati_remote_sendpacket(ati_remote, 0x8004, init1)) ||
752 (ati_remote_sendpacket(ati_remote, 0x8007, init2))) {
753 dev_err(&ati_remote->interface->dev,
754 "Initializing ati_remote hardware failed.\n");
755 return -EIO;
758 return 0;
762 * ati_remote_probe
764 static int ati_remote_probe(struct usb_interface *interface, const struct usb_device_id *id)
766 struct usb_device *udev = interface_to_usbdev(interface);
767 struct usb_host_interface *iface_host = interface->cur_altsetting;
768 struct usb_endpoint_descriptor *endpoint_in, *endpoint_out;
769 struct ati_remote *ati_remote;
770 struct input_dev *input_dev;
771 struct rc_dev *rc_dev;
772 int err = -ENOMEM;
774 if (iface_host->desc.bNumEndpoints != 2) {
775 err("%s: Unexpected desc.bNumEndpoints\n", __func__);
776 return -ENODEV;
779 endpoint_in = &iface_host->endpoint[0].desc;
780 endpoint_out = &iface_host->endpoint[1].desc;
782 if (!usb_endpoint_is_int_in(endpoint_in)) {
783 err("%s: Unexpected endpoint_in\n", __func__);
784 return -ENODEV;
786 if (le16_to_cpu(endpoint_in->wMaxPacketSize) == 0) {
787 err("%s: endpoint_in message size==0? \n", __func__);
788 return -ENODEV;
791 ati_remote = kzalloc(sizeof (struct ati_remote), GFP_KERNEL);
792 rc_dev = rc_allocate_device();
793 if (!ati_remote || !rc_dev)
794 goto fail1;
796 /* Allocate URB buffers, URBs */
797 if (ati_remote_alloc_buffers(udev, ati_remote))
798 goto fail2;
800 ati_remote->endpoint_in = endpoint_in;
801 ati_remote->endpoint_out = endpoint_out;
802 ati_remote->udev = udev;
803 ati_remote->rdev = rc_dev;
804 ati_remote->interface = interface;
806 usb_make_path(udev, ati_remote->rc_phys, sizeof(ati_remote->rc_phys));
807 strlcpy(ati_remote->mouse_phys, ati_remote->rc_phys,
808 sizeof(ati_remote->mouse_phys));
810 strlcat(ati_remote->rc_phys, "/input0", sizeof(ati_remote->rc_phys));
811 strlcat(ati_remote->mouse_phys, "/input1", sizeof(ati_remote->mouse_phys));
813 if (udev->manufacturer)
814 strlcpy(ati_remote->rc_name, udev->manufacturer,
815 sizeof(ati_remote->rc_name));
817 if (udev->product)
818 snprintf(ati_remote->rc_name, sizeof(ati_remote->rc_name),
819 "%s %s", ati_remote->rc_name, udev->product);
821 if (!strlen(ati_remote->rc_name))
822 snprintf(ati_remote->rc_name, sizeof(ati_remote->rc_name),
823 DRIVER_DESC "(%04x,%04x)",
824 le16_to_cpu(ati_remote->udev->descriptor.idVendor),
825 le16_to_cpu(ati_remote->udev->descriptor.idProduct));
827 snprintf(ati_remote->mouse_name, sizeof(ati_remote->mouse_name),
828 "%s mouse", ati_remote->rc_name);
830 if (id->driver_info)
831 rc_dev->map_name = (const char *)id->driver_info;
832 else
833 rc_dev->map_name = RC_MAP_ATI_X10;
835 ati_remote_rc_init(ati_remote);
836 mutex_init(&ati_remote->open_mutex);
838 /* Device Hardware Initialization - fills in ati_remote->idev from udev. */
839 err = ati_remote_initialize(ati_remote);
840 if (err)
841 goto fail3;
843 /* Set up and register rc device */
844 err = rc_register_device(ati_remote->rdev);
845 if (err)
846 goto fail3;
848 /* use our delay for rc_dev */
849 ati_remote->rdev->input_dev->rep[REP_DELAY] = repeat_delay;
851 /* Set up and register mouse input device */
852 if (mouse) {
853 input_dev = input_allocate_device();
854 if (!input_dev)
855 goto fail4;
857 ati_remote->idev = input_dev;
858 ati_remote_input_init(ati_remote);
859 err = input_register_device(input_dev);
861 if (err)
862 goto fail5;
865 usb_set_intfdata(interface, ati_remote);
866 return 0;
868 fail5: input_free_device(input_dev);
869 fail4: rc_unregister_device(rc_dev);
870 rc_dev = NULL;
871 fail3: usb_kill_urb(ati_remote->irq_urb);
872 usb_kill_urb(ati_remote->out_urb);
873 fail2: ati_remote_free_buffers(ati_remote);
874 fail1: rc_free_device(rc_dev);
875 kfree(ati_remote);
876 return err;
880 * ati_remote_disconnect
882 static void ati_remote_disconnect(struct usb_interface *interface)
884 struct ati_remote *ati_remote;
886 ati_remote = usb_get_intfdata(interface);
887 usb_set_intfdata(interface, NULL);
888 if (!ati_remote) {
889 dev_warn(&interface->dev, "%s - null device?\n", __func__);
890 return;
893 usb_kill_urb(ati_remote->irq_urb);
894 usb_kill_urb(ati_remote->out_urb);
895 if (ati_remote->idev)
896 input_unregister_device(ati_remote->idev);
897 rc_unregister_device(ati_remote->rdev);
898 ati_remote_free_buffers(ati_remote);
899 kfree(ati_remote);
902 module_usb_driver(ati_remote_driver);
904 MODULE_AUTHOR(DRIVER_AUTHOR);
905 MODULE_DESCRIPTION(DRIVER_DESC);
906 MODULE_LICENSE("GPL");