2 * ati_remote2 - ATI/Philips USB RF remote driver
4 * Copyright (C) 2005-2008 Ville Syrjala <syrjala@sci.fi>
5 * Copyright (C) 2007-2008 Peter Stokes <linux@dadeos.co.uk>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2
9 * as published by the Free Software Foundation.
12 #include <linux/usb/input.h>
14 #define DRIVER_DESC "ATI/Philips USB RF remote driver"
15 #define DRIVER_VERSION "0.3"
17 MODULE_DESCRIPTION(DRIVER_DESC);
18 MODULE_VERSION(DRIVER_VERSION);
19 MODULE_AUTHOR("Ville Syrjala <syrjala@sci.fi>");
20 MODULE_LICENSE("GPL");
23 * ATI Remote Wonder II Channel Configuration
25 * The remote control can by assigned one of sixteen "channels" in order to facilitate
26 * the use of multiple remote controls within range of each other.
27 * A remote's "channel" may be altered by pressing and holding the "PC" button for
28 * approximately 3 seconds, after which the button will slowly flash the count of the
29 * currently configured "channel", using the numeric keypad enter a number between 1 and
30 * 16 and then press the "PC" button again, the button will slowly flash the count of the
31 * newly configured "channel".
34 static unsigned int channel_mask = 0xFFFF;
35 module_param(channel_mask, uint, 0644);
36 MODULE_PARM_DESC(channel_mask, "Bitmask of channels to accept <15:Channel16>...<1:Channel2><0:Channel1>");
38 static unsigned int mode_mask = 0x1F;
39 module_param(mode_mask, uint, 0644);
40 MODULE_PARM_DESC(mode_mask, "Bitmask of modes to accept <4:PC><3:AUX4><2:AUX3><1:AUX2><0:AUX1>");
42 static struct usb_device_id ati_remote2_id_table[] = {
43 { USB_DEVICE(0x0471, 0x0602) }, /* ATI Remote Wonder II */
46 MODULE_DEVICE_TABLE(usb, ati_remote2_id_table);
48 static DEFINE_MUTEX(ati_remote2_mutex);
51 ATI_REMOTE2_OPENED = 0x1,
52 ATI_REMOTE2_SUSPENDED = 0x2,
67 } ati_remote2_key_table[] = {
80 { 0x10, KEY_VOLUMEUP },
81 { 0x11, KEY_VOLUMEDOWN },
82 { 0x20, KEY_CHANNELUP },
83 { 0x21, KEY_CHANNELDOWN },
84 { 0x28, KEY_FORWARD },
92 { 0x3f, KEY_PROG1 }, /* AUX1-AUX4 and PC */
106 { 0x8e, KEY_VENDOR },
107 { 0x96, KEY_COFFEE },
110 { 0xbe, KEY_QUESTION },
117 struct input_dev *idev;
118 struct usb_device *udev;
120 struct usb_interface *intf[2];
121 struct usb_endpoint_descriptor *ep[2];
124 dma_addr_t buf_dma[2];
126 unsigned long jiffies;
132 /* Each mode (AUX1-AUX4 and PC) can have an independent keymap. */
133 u16 keycode[ATI_REMOTE2_MODES][ARRAY_SIZE(ati_remote2_key_table)];
138 static int ati_remote2_probe(struct usb_interface *interface, const struct usb_device_id *id);
139 static void ati_remote2_disconnect(struct usb_interface *interface);
140 static int ati_remote2_suspend(struct usb_interface *interface, pm_message_t message);
141 static int ati_remote2_resume(struct usb_interface *interface);
143 static struct usb_driver ati_remote2_driver = {
144 .name = "ati_remote2",
145 .probe = ati_remote2_probe,
146 .disconnect = ati_remote2_disconnect,
147 .id_table = ati_remote2_id_table,
148 .suspend = ati_remote2_suspend,
149 .resume = ati_remote2_resume,
150 .supports_autosuspend = 1,
153 static int ati_remote2_submit_urbs(struct ati_remote2 *ar2)
157 r = usb_submit_urb(ar2->urb[0], GFP_KERNEL);
159 dev_err(&ar2->intf[0]->dev,
160 "%s(): usb_submit_urb() = %d\n", __func__, r);
163 r = usb_submit_urb(ar2->urb[1], GFP_KERNEL);
165 usb_kill_urb(ar2->urb[0]);
166 dev_err(&ar2->intf[1]->dev,
167 "%s(): usb_submit_urb() = %d\n", __func__, r);
174 static void ati_remote2_kill_urbs(struct ati_remote2 *ar2)
176 usb_kill_urb(ar2->urb[1]);
177 usb_kill_urb(ar2->urb[0]);
180 static int ati_remote2_open(struct input_dev *idev)
182 struct ati_remote2 *ar2 = input_get_drvdata(idev);
185 dev_dbg(&ar2->intf[0]->dev, "%s()\n", __func__);
187 r = usb_autopm_get_interface(ar2->intf[0]);
189 dev_err(&ar2->intf[0]->dev,
190 "%s(): usb_autopm_get_interface() = %d\n", __func__, r);
194 mutex_lock(&ati_remote2_mutex);
196 if (!(ar2->flags & ATI_REMOTE2_SUSPENDED)) {
197 r = ati_remote2_submit_urbs(ar2);
202 ar2->flags |= ATI_REMOTE2_OPENED;
204 mutex_unlock(&ati_remote2_mutex);
206 usb_autopm_put_interface(ar2->intf[0]);
211 mutex_unlock(&ati_remote2_mutex);
212 usb_autopm_put_interface(ar2->intf[0]);
217 static void ati_remote2_close(struct input_dev *idev)
219 struct ati_remote2 *ar2 = input_get_drvdata(idev);
221 dev_dbg(&ar2->intf[0]->dev, "%s()\n", __func__);
223 mutex_lock(&ati_remote2_mutex);
225 if (!(ar2->flags & ATI_REMOTE2_SUSPENDED))
226 ati_remote2_kill_urbs(ar2);
228 ar2->flags &= ~ATI_REMOTE2_OPENED;
230 mutex_unlock(&ati_remote2_mutex);
233 static void ati_remote2_input_mouse(struct ati_remote2 *ar2)
235 struct input_dev *idev = ar2->idev;
236 u8 *data = ar2->buf[0];
239 channel = data[0] >> 4;
241 if (!((1 << channel) & channel_mask))
244 mode = data[0] & 0x0F;
246 if (mode > ATI_REMOTE2_PC) {
247 dev_err(&ar2->intf[0]->dev,
248 "Unknown mode byte (%02x %02x %02x %02x)\n",
249 data[3], data[2], data[1], data[0]);
253 if (!((1 << mode) & mode_mask))
256 input_event(idev, EV_REL, REL_X, (s8) data[1]);
257 input_event(idev, EV_REL, REL_Y, (s8) data[2]);
261 static int ati_remote2_lookup(unsigned int hw_code)
265 for (i = 0; i < ARRAY_SIZE(ati_remote2_key_table); i++)
266 if (ati_remote2_key_table[i].hw_code == hw_code)
272 static void ati_remote2_input_key(struct ati_remote2 *ar2)
274 struct input_dev *idev = ar2->idev;
275 u8 *data = ar2->buf[1];
276 int channel, mode, hw_code, index;
278 channel = data[0] >> 4;
280 if (!((1 << channel) & channel_mask))
283 mode = data[0] & 0x0F;
285 if (mode > ATI_REMOTE2_PC) {
286 dev_err(&ar2->intf[1]->dev,
287 "Unknown mode byte (%02x %02x %02x %02x)\n",
288 data[3], data[2], data[1], data[0]);
293 if (hw_code == 0x3f) {
295 * For some incomprehensible reason the mouse pad generates
296 * events which look identical to the events from the last
297 * pressed mode key. Naturally we don't want to generate key
298 * events for the mouse pad so we filter out any subsequent
299 * events from the same mode key.
301 if (ar2->mode == mode)
308 if (!((1 << mode) & mode_mask))
311 index = ati_remote2_lookup(hw_code);
313 dev_err(&ar2->intf[1]->dev,
314 "Unknown code byte (%02x %02x %02x %02x)\n",
315 data[3], data[2], data[1], data[0]);
320 case 0: /* release */
323 ar2->jiffies = jiffies + msecs_to_jiffies(idev->rep[REP_DELAY]);
327 /* No repeat for mouse buttons. */
328 if (ar2->keycode[mode][index] == BTN_LEFT ||
329 ar2->keycode[mode][index] == BTN_RIGHT)
332 if (!time_after_eq(jiffies, ar2->jiffies))
335 ar2->jiffies = jiffies + msecs_to_jiffies(idev->rep[REP_PERIOD]);
338 dev_err(&ar2->intf[1]->dev,
339 "Unknown state byte (%02x %02x %02x %02x)\n",
340 data[3], data[2], data[1], data[0]);
344 input_event(idev, EV_KEY, ar2->keycode[mode][index], data[1]);
348 static void ati_remote2_complete_mouse(struct urb *urb)
350 struct ati_remote2 *ar2 = urb->context;
353 switch (urb->status) {
355 usb_mark_last_busy(ar2->udev);
356 ati_remote2_input_mouse(ar2);
362 dev_dbg(&ar2->intf[0]->dev,
363 "%s(): urb status = %d\n", __func__, urb->status);
366 usb_mark_last_busy(ar2->udev);
367 dev_err(&ar2->intf[0]->dev,
368 "%s(): urb status = %d\n", __func__, urb->status);
371 r = usb_submit_urb(urb, GFP_ATOMIC);
373 dev_err(&ar2->intf[0]->dev,
374 "%s(): usb_submit_urb() = %d\n", __func__, r);
377 static void ati_remote2_complete_key(struct urb *urb)
379 struct ati_remote2 *ar2 = urb->context;
382 switch (urb->status) {
384 usb_mark_last_busy(ar2->udev);
385 ati_remote2_input_key(ar2);
391 dev_dbg(&ar2->intf[1]->dev,
392 "%s(): urb status = %d\n", __func__, urb->status);
395 usb_mark_last_busy(ar2->udev);
396 dev_err(&ar2->intf[1]->dev,
397 "%s(): urb status = %d\n", __func__, urb->status);
400 r = usb_submit_urb(urb, GFP_ATOMIC);
402 dev_err(&ar2->intf[1]->dev,
403 "%s(): usb_submit_urb() = %d\n", __func__, r);
406 static int ati_remote2_getkeycode(struct input_dev *idev,
407 int scancode, int *keycode)
409 struct ati_remote2 *ar2 = input_get_drvdata(idev);
412 mode = scancode >> 8;
413 if (mode > ATI_REMOTE2_PC || !((1 << mode) & mode_mask))
416 index = ati_remote2_lookup(scancode & 0xFF);
420 *keycode = ar2->keycode[mode][index];
424 static int ati_remote2_setkeycode(struct input_dev *idev, int scancode, int keycode)
426 struct ati_remote2 *ar2 = input_get_drvdata(idev);
427 int index, mode, old_keycode;
429 mode = scancode >> 8;
430 if (mode > ATI_REMOTE2_PC || !((1 << mode) & mode_mask))
433 index = ati_remote2_lookup(scancode & 0xFF);
437 if (keycode < KEY_RESERVED || keycode > KEY_MAX)
440 old_keycode = ar2->keycode[mode][index];
441 ar2->keycode[mode][index] = keycode;
442 set_bit(keycode, idev->keybit);
444 for (mode = 0; mode < ATI_REMOTE2_MODES; mode++) {
445 for (index = 0; index < ARRAY_SIZE(ati_remote2_key_table); index++) {
446 if (ar2->keycode[mode][index] == old_keycode)
451 clear_bit(old_keycode, idev->keybit);
456 static int ati_remote2_input_init(struct ati_remote2 *ar2)
458 struct input_dev *idev;
459 int index, mode, retval;
461 idev = input_allocate_device();
466 input_set_drvdata(idev, ar2);
468 idev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP) | BIT_MASK(EV_REL);
469 idev->keybit[BIT_WORD(BTN_MOUSE)] = BIT_MASK(BTN_LEFT) |
471 idev->relbit[0] = BIT_MASK(REL_X) | BIT_MASK(REL_Y);
473 for (mode = 0; mode < ATI_REMOTE2_MODES; mode++) {
474 for (index = 0; index < ARRAY_SIZE(ati_remote2_key_table); index++) {
475 ar2->keycode[mode][index] = ati_remote2_key_table[index].keycode;
476 set_bit(ar2->keycode[mode][index], idev->keybit);
480 /* AUX1-AUX4 and PC generate the same scancode. */
481 index = ati_remote2_lookup(0x3f);
482 ar2->keycode[ATI_REMOTE2_AUX1][index] = KEY_PROG1;
483 ar2->keycode[ATI_REMOTE2_AUX2][index] = KEY_PROG2;
484 ar2->keycode[ATI_REMOTE2_AUX3][index] = KEY_PROG3;
485 ar2->keycode[ATI_REMOTE2_AUX4][index] = KEY_PROG4;
486 ar2->keycode[ATI_REMOTE2_PC][index] = KEY_PC;
487 set_bit(KEY_PROG1, idev->keybit);
488 set_bit(KEY_PROG2, idev->keybit);
489 set_bit(KEY_PROG3, idev->keybit);
490 set_bit(KEY_PROG4, idev->keybit);
491 set_bit(KEY_PC, idev->keybit);
493 idev->rep[REP_DELAY] = 250;
494 idev->rep[REP_PERIOD] = 33;
496 idev->open = ati_remote2_open;
497 idev->close = ati_remote2_close;
499 idev->getkeycode = ati_remote2_getkeycode;
500 idev->setkeycode = ati_remote2_setkeycode;
502 idev->name = ar2->name;
503 idev->phys = ar2->phys;
505 usb_to_input_id(ar2->udev, &idev->id);
506 idev->dev.parent = &ar2->udev->dev;
508 retval = input_register_device(idev);
510 input_free_device(idev);
515 static int ati_remote2_urb_init(struct ati_remote2 *ar2)
517 struct usb_device *udev = ar2->udev;
520 for (i = 0; i < 2; i++) {
521 ar2->buf[i] = usb_buffer_alloc(udev, 4, GFP_KERNEL, &ar2->buf_dma[i]);
525 ar2->urb[i] = usb_alloc_urb(0, GFP_KERNEL);
529 pipe = usb_rcvintpipe(udev, ar2->ep[i]->bEndpointAddress);
530 maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe));
531 maxp = maxp > 4 ? 4 : maxp;
533 usb_fill_int_urb(ar2->urb[i], udev, pipe, ar2->buf[i], maxp,
534 i ? ati_remote2_complete_key : ati_remote2_complete_mouse,
535 ar2, ar2->ep[i]->bInterval);
536 ar2->urb[i]->transfer_dma = ar2->buf_dma[i];
537 ar2->urb[i]->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
543 static void ati_remote2_urb_cleanup(struct ati_remote2 *ar2)
547 for (i = 0; i < 2; i++) {
548 usb_free_urb(ar2->urb[i]);
549 usb_buffer_free(ar2->udev, 4, ar2->buf[i], ar2->buf_dma[i]);
553 static int ati_remote2_setup(struct ati_remote2 *ar2)
558 * Configure receiver to only accept input from remote "channel"
559 * channel == 0 -> Accept input from any remote channel
560 * channel == 1 -> Only accept input from remote channel 1
561 * channel == 2 -> Only accept input from remote channel 2
563 * channel == 16 -> Only accept input from remote channel 16
567 for (i = 0; i < 16; i++) {
568 if ((1 << i) & channel_mask) {
569 if (!(~(1 << i) & 0xFFFF & channel_mask))
575 r = usb_control_msg(ar2->udev, usb_sndctrlpipe(ar2->udev, 0),
577 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_INTERFACE,
578 channel, 0x0, NULL, 0, USB_CTRL_SET_TIMEOUT);
580 dev_err(&ar2->udev->dev, "%s - failed to set channel due to error: %d\n",
588 static int ati_remote2_probe(struct usb_interface *interface, const struct usb_device_id *id)
590 struct usb_device *udev = interface_to_usbdev(interface);
591 struct usb_host_interface *alt = interface->cur_altsetting;
592 struct ati_remote2 *ar2;
595 if (alt->desc.bInterfaceNumber)
598 ar2 = kzalloc(sizeof (struct ati_remote2), GFP_KERNEL);
604 ar2->intf[0] = interface;
605 ar2->ep[0] = &alt->endpoint[0].desc;
607 ar2->intf[1] = usb_ifnum_to_if(udev, 1);
608 r = usb_driver_claim_interface(&ati_remote2_driver, ar2->intf[1], ar2);
611 alt = ar2->intf[1]->cur_altsetting;
612 ar2->ep[1] = &alt->endpoint[0].desc;
614 r = ati_remote2_urb_init(ar2);
618 r = ati_remote2_setup(ar2);
622 usb_make_path(udev, ar2->phys, sizeof(ar2->phys));
623 strlcat(ar2->phys, "/input0", sizeof(ar2->phys));
625 strlcat(ar2->name, "ATI Remote Wonder II", sizeof(ar2->name));
627 r = ati_remote2_input_init(ar2);
631 usb_set_intfdata(interface, ar2);
633 interface->needs_remote_wakeup = 1;
638 ati_remote2_urb_cleanup(ar2);
640 usb_driver_release_interface(&ati_remote2_driver, ar2->intf[1]);
647 static void ati_remote2_disconnect(struct usb_interface *interface)
649 struct ati_remote2 *ar2;
650 struct usb_host_interface *alt = interface->cur_altsetting;
652 if (alt->desc.bInterfaceNumber)
655 ar2 = usb_get_intfdata(interface);
656 usb_set_intfdata(interface, NULL);
658 input_unregister_device(ar2->idev);
660 ati_remote2_urb_cleanup(ar2);
662 usb_driver_release_interface(&ati_remote2_driver, ar2->intf[1]);
667 static int ati_remote2_suspend(struct usb_interface *interface,
668 pm_message_t message)
670 struct ati_remote2 *ar2;
671 struct usb_host_interface *alt = interface->cur_altsetting;
673 if (alt->desc.bInterfaceNumber)
676 ar2 = usb_get_intfdata(interface);
678 dev_dbg(&ar2->intf[0]->dev, "%s()\n", __func__);
680 mutex_lock(&ati_remote2_mutex);
682 if (ar2->flags & ATI_REMOTE2_OPENED)
683 ati_remote2_kill_urbs(ar2);
685 ar2->flags |= ATI_REMOTE2_SUSPENDED;
687 mutex_unlock(&ati_remote2_mutex);
692 static int ati_remote2_resume(struct usb_interface *interface)
694 struct ati_remote2 *ar2;
695 struct usb_host_interface *alt = interface->cur_altsetting;
698 if (alt->desc.bInterfaceNumber)
701 ar2 = usb_get_intfdata(interface);
703 dev_dbg(&ar2->intf[0]->dev, "%s()\n", __func__);
705 mutex_lock(&ati_remote2_mutex);
707 if (ar2->flags & ATI_REMOTE2_OPENED)
708 r = ati_remote2_submit_urbs(ar2);
711 ar2->flags &= ~ATI_REMOTE2_SUSPENDED;
713 mutex_unlock(&ati_remote2_mutex);
718 static int __init ati_remote2_init(void)
722 r = usb_register(&ati_remote2_driver);
724 printk(KERN_ERR "ati_remote2: usb_register() = %d\n", r);
726 printk(KERN_INFO "ati_remote2: " DRIVER_DESC " " DRIVER_VERSION "\n");
731 static void __exit ati_remote2_exit(void)
733 usb_deregister(&ati_remote2_driver);
736 module_init(ati_remote2_init);
737 module_exit(ati_remote2_exit);