USB: convert drivers/media/* to use module_usb_driver()
[zen-stable.git] / drivers / media / rc / imon.c
blob3aeb29a7ce113205683f524d2f016c2121a2225c
1 /*
2 * imon.c: input and display driver for SoundGraph iMON IR/VFD/LCD
4 * Copyright(C) 2010 Jarod Wilson <jarod@wilsonet.com>
5 * Portions based on the original lirc_imon driver,
6 * Copyright(C) 2004 Venky Raju(dev@venky.ws)
8 * Huge thanks to R. Geoff Newbury for invaluable debugging on the
9 * 0xffdc iMON devices, and for sending me one to hack on, without
10 * which the support for them wouldn't be nearly as good. Thanks
11 * also to the numerous 0xffdc device owners that tested auto-config
12 * support for me and provided debug dumps from their devices.
14 * imon is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software
26 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
29 #define pr_fmt(fmt) KBUILD_MODNAME ":%s: " fmt, __func__
31 #include <linux/errno.h>
32 #include <linux/init.h>
33 #include <linux/kernel.h>
34 #include <linux/module.h>
35 #include <linux/slab.h>
36 #include <linux/uaccess.h>
37 #include <linux/ratelimit.h>
39 #include <linux/input.h>
40 #include <linux/usb.h>
41 #include <linux/usb/input.h>
42 #include <media/rc-core.h>
44 #include <linux/time.h>
45 #include <linux/timer.h>
47 #define MOD_AUTHOR "Jarod Wilson <jarod@wilsonet.com>"
48 #define MOD_DESC "Driver for SoundGraph iMON MultiMedia IR/Display"
49 #define MOD_NAME "imon"
50 #define MOD_VERSION "0.9.3"
52 #define DISPLAY_MINOR_BASE 144
53 #define DEVICE_NAME "lcd%d"
55 #define BUF_CHUNK_SIZE 8
56 #define BUF_SIZE 128
58 #define BIT_DURATION 250 /* each bit received is 250us */
60 #define IMON_CLOCK_ENABLE_PACKETS 2
62 /*** P R O T O T Y P E S ***/
64 /* USB Callback prototypes */
65 static int imon_probe(struct usb_interface *interface,
66 const struct usb_device_id *id);
67 static void imon_disconnect(struct usb_interface *interface);
68 static void usb_rx_callback_intf0(struct urb *urb);
69 static void usb_rx_callback_intf1(struct urb *urb);
70 static void usb_tx_callback(struct urb *urb);
72 /* suspend/resume support */
73 static int imon_resume(struct usb_interface *intf);
74 static int imon_suspend(struct usb_interface *intf, pm_message_t message);
76 /* Display file_operations function prototypes */
77 static int display_open(struct inode *inode, struct file *file);
78 static int display_close(struct inode *inode, struct file *file);
80 /* VFD write operation */
81 static ssize_t vfd_write(struct file *file, const char *buf,
82 size_t n_bytes, loff_t *pos);
84 /* LCD file_operations override function prototypes */
85 static ssize_t lcd_write(struct file *file, const char *buf,
86 size_t n_bytes, loff_t *pos);
88 /*** G L O B A L S ***/
90 struct imon_context {
91 struct device *dev;
92 /* Newer devices have two interfaces */
93 struct usb_device *usbdev_intf0;
94 struct usb_device *usbdev_intf1;
96 bool display_supported; /* not all controllers do */
97 bool display_isopen; /* display port has been opened */
98 bool rf_device; /* true if iMON 2.4G LT/DT RF device */
99 bool rf_isassociating; /* RF remote associating */
100 bool dev_present_intf0; /* USB device presence, interface 0 */
101 bool dev_present_intf1; /* USB device presence, interface 1 */
103 struct mutex lock; /* to lock this object */
104 wait_queue_head_t remove_ok; /* For unexpected USB disconnects */
106 struct usb_endpoint_descriptor *rx_endpoint_intf0;
107 struct usb_endpoint_descriptor *rx_endpoint_intf1;
108 struct usb_endpoint_descriptor *tx_endpoint;
109 struct urb *rx_urb_intf0;
110 struct urb *rx_urb_intf1;
111 struct urb *tx_urb;
112 bool tx_control;
113 unsigned char usb_rx_buf[8];
114 unsigned char usb_tx_buf[8];
116 struct tx_t {
117 unsigned char data_buf[35]; /* user data buffer */
118 struct completion finished; /* wait for write to finish */
119 bool busy; /* write in progress */
120 int status; /* status of tx completion */
121 } tx;
123 u16 vendor; /* usb vendor ID */
124 u16 product; /* usb product ID */
126 struct rc_dev *rdev; /* rc-core device for remote */
127 struct input_dev *idev; /* input device for panel & IR mouse */
128 struct input_dev *touch; /* input device for touchscreen */
130 spinlock_t kc_lock; /* make sure we get keycodes right */
131 u32 kc; /* current input keycode */
132 u32 last_keycode; /* last reported input keycode */
133 u32 rc_scancode; /* the computed remote scancode */
134 u8 rc_toggle; /* the computed remote toggle bit */
135 u64 rc_type; /* iMON or MCE (RC6) IR protocol? */
136 bool release_code; /* some keys send a release code */
138 u8 display_type; /* store the display type */
139 bool pad_mouse; /* toggle kbd(0)/mouse(1) mode */
141 char name_rdev[128]; /* rc input device name */
142 char phys_rdev[64]; /* rc input device phys path */
144 char name_idev[128]; /* input device name */
145 char phys_idev[64]; /* input device phys path */
147 char name_touch[128]; /* touch screen name */
148 char phys_touch[64]; /* touch screen phys path */
149 struct timer_list ttimer; /* touch screen timer */
150 int touch_x; /* x coordinate on touchscreen */
151 int touch_y; /* y coordinate on touchscreen */
154 #define TOUCH_TIMEOUT (HZ/30)
156 /* vfd character device file operations */
157 static const struct file_operations vfd_fops = {
158 .owner = THIS_MODULE,
159 .open = &display_open,
160 .write = &vfd_write,
161 .release = &display_close,
162 .llseek = noop_llseek,
165 /* lcd character device file operations */
166 static const struct file_operations lcd_fops = {
167 .owner = THIS_MODULE,
168 .open = &display_open,
169 .write = &lcd_write,
170 .release = &display_close,
171 .llseek = noop_llseek,
174 enum {
175 IMON_DISPLAY_TYPE_AUTO = 0,
176 IMON_DISPLAY_TYPE_VFD = 1,
177 IMON_DISPLAY_TYPE_LCD = 2,
178 IMON_DISPLAY_TYPE_VGA = 3,
179 IMON_DISPLAY_TYPE_NONE = 4,
182 enum {
183 IMON_KEY_IMON = 0,
184 IMON_KEY_MCE = 1,
185 IMON_KEY_PANEL = 2,
189 * USB Device ID for iMON USB Control Boards
191 * The Windows drivers contain 6 different inf files, more or less one for
192 * each new device until the 0x0034-0x0046 devices, which all use the same
193 * driver. Some of the devices in the 34-46 range haven't been definitively
194 * identified yet. Early devices have either a TriGem Computer, Inc. or a
195 * Samsung vendor ID (0x0aa8 and 0x04e8 respectively), while all later
196 * devices use the SoundGraph vendor ID (0x15c2). This driver only supports
197 * the ffdc and later devices, which do onboard decoding.
199 static struct usb_device_id imon_usb_id_table[] = {
201 * Several devices with this same device ID, all use iMON_PAD.inf
202 * SoundGraph iMON PAD (IR & VFD)
203 * SoundGraph iMON PAD (IR & LCD)
204 * SoundGraph iMON Knob (IR only)
206 { USB_DEVICE(0x15c2, 0xffdc) },
209 * Newer devices, all driven by the latest iMON Windows driver, full
210 * list of device IDs extracted via 'strings Setup/data1.hdr |grep 15c2'
211 * Need user input to fill in details on unknown devices.
213 /* SoundGraph iMON OEM Touch LCD (IR & 7" VGA LCD) */
214 { USB_DEVICE(0x15c2, 0x0034) },
215 /* SoundGraph iMON OEM Touch LCD (IR & 4.3" VGA LCD) */
216 { USB_DEVICE(0x15c2, 0x0035) },
217 /* SoundGraph iMON OEM VFD (IR & VFD) */
218 { USB_DEVICE(0x15c2, 0x0036) },
219 /* device specifics unknown */
220 { USB_DEVICE(0x15c2, 0x0037) },
221 /* SoundGraph iMON OEM LCD (IR & LCD) */
222 { USB_DEVICE(0x15c2, 0x0038) },
223 /* SoundGraph iMON UltraBay (IR & LCD) */
224 { USB_DEVICE(0x15c2, 0x0039) },
225 /* device specifics unknown */
226 { USB_DEVICE(0x15c2, 0x003a) },
227 /* device specifics unknown */
228 { USB_DEVICE(0x15c2, 0x003b) },
229 /* SoundGraph iMON OEM Inside (IR only) */
230 { USB_DEVICE(0x15c2, 0x003c) },
231 /* device specifics unknown */
232 { USB_DEVICE(0x15c2, 0x003d) },
233 /* device specifics unknown */
234 { USB_DEVICE(0x15c2, 0x003e) },
235 /* device specifics unknown */
236 { USB_DEVICE(0x15c2, 0x003f) },
237 /* device specifics unknown */
238 { USB_DEVICE(0x15c2, 0x0040) },
239 /* SoundGraph iMON MINI (IR only) */
240 { USB_DEVICE(0x15c2, 0x0041) },
241 /* Antec Veris Multimedia Station EZ External (IR only) */
242 { USB_DEVICE(0x15c2, 0x0042) },
243 /* Antec Veris Multimedia Station Basic Internal (IR only) */
244 { USB_DEVICE(0x15c2, 0x0043) },
245 /* Antec Veris Multimedia Station Elite (IR & VFD) */
246 { USB_DEVICE(0x15c2, 0x0044) },
247 /* Antec Veris Multimedia Station Premiere (IR & LCD) */
248 { USB_DEVICE(0x15c2, 0x0045) },
249 /* device specifics unknown */
250 { USB_DEVICE(0x15c2, 0x0046) },
254 /* USB Device data */
255 static struct usb_driver imon_driver = {
256 .name = MOD_NAME,
257 .probe = imon_probe,
258 .disconnect = imon_disconnect,
259 .suspend = imon_suspend,
260 .resume = imon_resume,
261 .id_table = imon_usb_id_table,
264 static struct usb_class_driver imon_vfd_class = {
265 .name = DEVICE_NAME,
266 .fops = &vfd_fops,
267 .minor_base = DISPLAY_MINOR_BASE,
270 static struct usb_class_driver imon_lcd_class = {
271 .name = DEVICE_NAME,
272 .fops = &lcd_fops,
273 .minor_base = DISPLAY_MINOR_BASE,
276 /* imon receiver front panel/knob key table */
277 static const struct {
278 u64 hw_code;
279 u32 keycode;
280 } imon_panel_key_table[] = {
281 { 0x000000000f00ffeell, KEY_MEDIA }, /* Go */
282 { 0x000000001200ffeell, KEY_UP },
283 { 0x000000001300ffeell, KEY_DOWN },
284 { 0x000000001400ffeell, KEY_LEFT },
285 { 0x000000001500ffeell, KEY_RIGHT },
286 { 0x000000001600ffeell, KEY_ENTER },
287 { 0x000000001700ffeell, KEY_ESC },
288 { 0x000000001f00ffeell, KEY_AUDIO },
289 { 0x000000002000ffeell, KEY_VIDEO },
290 { 0x000000002100ffeell, KEY_CAMERA },
291 { 0x000000002700ffeell, KEY_DVD },
292 { 0x000000002300ffeell, KEY_TV },
293 { 0x000000002b00ffeell, KEY_EXIT },
294 { 0x000000002c00ffeell, KEY_SELECT },
295 { 0x000000002d00ffeell, KEY_MENU },
296 { 0x000000000500ffeell, KEY_PREVIOUS },
297 { 0x000000000700ffeell, KEY_REWIND },
298 { 0x000000000400ffeell, KEY_STOP },
299 { 0x000000003c00ffeell, KEY_PLAYPAUSE },
300 { 0x000000000800ffeell, KEY_FASTFORWARD },
301 { 0x000000000600ffeell, KEY_NEXT },
302 { 0x000000010000ffeell, KEY_RIGHT },
303 { 0x000001000000ffeell, KEY_LEFT },
304 { 0x000000003d00ffeell, KEY_SELECT },
305 { 0x000100000000ffeell, KEY_VOLUMEUP },
306 { 0x010000000000ffeell, KEY_VOLUMEDOWN },
307 { 0x000000000100ffeell, KEY_MUTE },
308 /* 0xffdc iMON MCE VFD */
309 { 0x00010000ffffffeell, KEY_VOLUMEUP },
310 { 0x01000000ffffffeell, KEY_VOLUMEDOWN },
311 { 0x00000001ffffffeell, KEY_MUTE },
312 { 0x0000000fffffffeell, KEY_MEDIA },
313 { 0x00000012ffffffeell, KEY_UP },
314 { 0x00000013ffffffeell, KEY_DOWN },
315 { 0x00000014ffffffeell, KEY_LEFT },
316 { 0x00000015ffffffeell, KEY_RIGHT },
317 { 0x00000016ffffffeell, KEY_ENTER },
318 { 0x00000017ffffffeell, KEY_ESC },
319 /* iMON Knob values */
320 { 0x000100ffffffffeell, KEY_VOLUMEUP },
321 { 0x010000ffffffffeell, KEY_VOLUMEDOWN },
322 { 0x000008ffffffffeell, KEY_MUTE },
325 /* to prevent races between open() and disconnect(), probing, etc */
326 static DEFINE_MUTEX(driver_lock);
328 /* Module bookkeeping bits */
329 MODULE_AUTHOR(MOD_AUTHOR);
330 MODULE_DESCRIPTION(MOD_DESC);
331 MODULE_VERSION(MOD_VERSION);
332 MODULE_LICENSE("GPL");
333 MODULE_DEVICE_TABLE(usb, imon_usb_id_table);
335 static bool debug;
336 module_param(debug, bool, S_IRUGO | S_IWUSR);
337 MODULE_PARM_DESC(debug, "Debug messages: 0=no, 1=yes (default: no)");
339 /* lcd, vfd, vga or none? should be auto-detected, but can be overridden... */
340 static int display_type;
341 module_param(display_type, int, S_IRUGO);
342 MODULE_PARM_DESC(display_type, "Type of attached display. 0=autodetect, "
343 "1=vfd, 2=lcd, 3=vga, 4=none (default: autodetect)");
345 static int pad_stabilize = 1;
346 module_param(pad_stabilize, int, S_IRUGO | S_IWUSR);
347 MODULE_PARM_DESC(pad_stabilize, "Apply stabilization algorithm to iMON PAD "
348 "presses in arrow key mode. 0=disable, 1=enable (default).");
351 * In certain use cases, mouse mode isn't really helpful, and could actually
352 * cause confusion, so allow disabling it when the IR device is open.
354 static bool nomouse;
355 module_param(nomouse, bool, S_IRUGO | S_IWUSR);
356 MODULE_PARM_DESC(nomouse, "Disable mouse input device mode when IR device is "
357 "open. 0=don't disable, 1=disable. (default: don't disable)");
359 /* threshold at which a pad push registers as an arrow key in kbd mode */
360 static int pad_thresh;
361 module_param(pad_thresh, int, S_IRUGO | S_IWUSR);
362 MODULE_PARM_DESC(pad_thresh, "Threshold at which a pad push registers as an "
363 "arrow key in kbd mode (default: 28)");
366 static void free_imon_context(struct imon_context *ictx)
368 struct device *dev = ictx->dev;
370 usb_free_urb(ictx->tx_urb);
371 usb_free_urb(ictx->rx_urb_intf0);
372 usb_free_urb(ictx->rx_urb_intf1);
373 kfree(ictx);
375 dev_dbg(dev, "%s: iMON context freed\n", __func__);
379 * Called when the Display device (e.g. /dev/lcd0)
380 * is opened by the application.
382 static int display_open(struct inode *inode, struct file *file)
384 struct usb_interface *interface;
385 struct imon_context *ictx = NULL;
386 int subminor;
387 int retval = 0;
389 /* prevent races with disconnect */
390 mutex_lock(&driver_lock);
392 subminor = iminor(inode);
393 interface = usb_find_interface(&imon_driver, subminor);
394 if (!interface) {
395 pr_err("could not find interface for minor %d\n", subminor);
396 retval = -ENODEV;
397 goto exit;
399 ictx = usb_get_intfdata(interface);
401 if (!ictx) {
402 pr_err("no context found for minor %d\n", subminor);
403 retval = -ENODEV;
404 goto exit;
407 mutex_lock(&ictx->lock);
409 if (!ictx->display_supported) {
410 pr_err("display not supported by device\n");
411 retval = -ENODEV;
412 } else if (ictx->display_isopen) {
413 pr_err("display port is already open\n");
414 retval = -EBUSY;
415 } else {
416 ictx->display_isopen = true;
417 file->private_data = ictx;
418 dev_dbg(ictx->dev, "display port opened\n");
421 mutex_unlock(&ictx->lock);
423 exit:
424 mutex_unlock(&driver_lock);
425 return retval;
429 * Called when the display device (e.g. /dev/lcd0)
430 * is closed by the application.
432 static int display_close(struct inode *inode, struct file *file)
434 struct imon_context *ictx = NULL;
435 int retval = 0;
437 ictx = file->private_data;
439 if (!ictx) {
440 pr_err("no context for device\n");
441 return -ENODEV;
444 mutex_lock(&ictx->lock);
446 if (!ictx->display_supported) {
447 pr_err("display not supported by device\n");
448 retval = -ENODEV;
449 } else if (!ictx->display_isopen) {
450 pr_err("display is not open\n");
451 retval = -EIO;
452 } else {
453 ictx->display_isopen = false;
454 dev_dbg(ictx->dev, "display port closed\n");
457 mutex_unlock(&ictx->lock);
458 return retval;
462 * Sends a packet to the device -- this function must be called with
463 * ictx->lock held, or its unlock/lock sequence while waiting for tx
464 * to complete can/will lead to a deadlock.
466 static int send_packet(struct imon_context *ictx)
468 unsigned int pipe;
469 unsigned long timeout;
470 int interval = 0;
471 int retval = 0;
472 struct usb_ctrlrequest *control_req = NULL;
474 /* Check if we need to use control or interrupt urb */
475 if (!ictx->tx_control) {
476 pipe = usb_sndintpipe(ictx->usbdev_intf0,
477 ictx->tx_endpoint->bEndpointAddress);
478 interval = ictx->tx_endpoint->bInterval;
480 usb_fill_int_urb(ictx->tx_urb, ictx->usbdev_intf0, pipe,
481 ictx->usb_tx_buf,
482 sizeof(ictx->usb_tx_buf),
483 usb_tx_callback, ictx, interval);
485 ictx->tx_urb->actual_length = 0;
486 } else {
487 /* fill request into kmalloc'ed space: */
488 control_req = kmalloc(sizeof(struct usb_ctrlrequest),
489 GFP_KERNEL);
490 if (control_req == NULL)
491 return -ENOMEM;
493 /* setup packet is '21 09 0200 0001 0008' */
494 control_req->bRequestType = 0x21;
495 control_req->bRequest = 0x09;
496 control_req->wValue = cpu_to_le16(0x0200);
497 control_req->wIndex = cpu_to_le16(0x0001);
498 control_req->wLength = cpu_to_le16(0x0008);
500 /* control pipe is endpoint 0x00 */
501 pipe = usb_sndctrlpipe(ictx->usbdev_intf0, 0);
503 /* build the control urb */
504 usb_fill_control_urb(ictx->tx_urb, ictx->usbdev_intf0,
505 pipe, (unsigned char *)control_req,
506 ictx->usb_tx_buf,
507 sizeof(ictx->usb_tx_buf),
508 usb_tx_callback, ictx);
509 ictx->tx_urb->actual_length = 0;
512 init_completion(&ictx->tx.finished);
513 ictx->tx.busy = true;
514 smp_rmb(); /* ensure later readers know we're busy */
516 retval = usb_submit_urb(ictx->tx_urb, GFP_KERNEL);
517 if (retval) {
518 ictx->tx.busy = false;
519 smp_rmb(); /* ensure later readers know we're not busy */
520 pr_err_ratelimited("error submitting urb(%d)\n", retval);
521 } else {
522 /* Wait for transmission to complete (or abort) */
523 mutex_unlock(&ictx->lock);
524 retval = wait_for_completion_interruptible(
525 &ictx->tx.finished);
526 if (retval)
527 pr_err_ratelimited("task interrupted\n");
528 mutex_lock(&ictx->lock);
530 retval = ictx->tx.status;
531 if (retval)
532 pr_err_ratelimited("packet tx failed (%d)\n", retval);
535 kfree(control_req);
538 * Induce a mandatory 5ms delay before returning, as otherwise,
539 * send_packet can get called so rapidly as to overwhelm the device,
540 * particularly on faster systems and/or those with quirky usb.
542 timeout = msecs_to_jiffies(5);
543 set_current_state(TASK_UNINTERRUPTIBLE);
544 schedule_timeout(timeout);
546 return retval;
550 * Sends an associate packet to the iMON 2.4G.
552 * This might not be such a good idea, since it has an id collision with
553 * some versions of the "IR & VFD" combo. The only way to determine if it
554 * is an RF version is to look at the product description string. (Which
555 * we currently do not fetch).
557 static int send_associate_24g(struct imon_context *ictx)
559 int retval;
560 const unsigned char packet[8] = { 0x01, 0x00, 0x00, 0x00,
561 0x00, 0x00, 0x00, 0x20 };
563 if (!ictx) {
564 pr_err("no context for device\n");
565 return -ENODEV;
568 if (!ictx->dev_present_intf0) {
569 pr_err("no iMON device present\n");
570 return -ENODEV;
573 memcpy(ictx->usb_tx_buf, packet, sizeof(packet));
574 retval = send_packet(ictx);
576 return retval;
580 * Sends packets to setup and show clock on iMON display
582 * Arguments: year - last 2 digits of year, month - 1..12,
583 * day - 1..31, dow - day of the week (0-Sun...6-Sat),
584 * hour - 0..23, minute - 0..59, second - 0..59
586 static int send_set_imon_clock(struct imon_context *ictx,
587 unsigned int year, unsigned int month,
588 unsigned int day, unsigned int dow,
589 unsigned int hour, unsigned int minute,
590 unsigned int second)
592 unsigned char clock_enable_pkt[IMON_CLOCK_ENABLE_PACKETS][8];
593 int retval = 0;
594 int i;
596 if (!ictx) {
597 pr_err("no context for device\n");
598 return -ENODEV;
601 switch (ictx->display_type) {
602 case IMON_DISPLAY_TYPE_LCD:
603 clock_enable_pkt[0][0] = 0x80;
604 clock_enable_pkt[0][1] = year;
605 clock_enable_pkt[0][2] = month-1;
606 clock_enable_pkt[0][3] = day;
607 clock_enable_pkt[0][4] = hour;
608 clock_enable_pkt[0][5] = minute;
609 clock_enable_pkt[0][6] = second;
611 clock_enable_pkt[1][0] = 0x80;
612 clock_enable_pkt[1][1] = 0;
613 clock_enable_pkt[1][2] = 0;
614 clock_enable_pkt[1][3] = 0;
615 clock_enable_pkt[1][4] = 0;
616 clock_enable_pkt[1][5] = 0;
617 clock_enable_pkt[1][6] = 0;
619 if (ictx->product == 0xffdc) {
620 clock_enable_pkt[0][7] = 0x50;
621 clock_enable_pkt[1][7] = 0x51;
622 } else {
623 clock_enable_pkt[0][7] = 0x88;
624 clock_enable_pkt[1][7] = 0x8a;
627 break;
629 case IMON_DISPLAY_TYPE_VFD:
630 clock_enable_pkt[0][0] = year;
631 clock_enable_pkt[0][1] = month-1;
632 clock_enable_pkt[0][2] = day;
633 clock_enable_pkt[0][3] = dow;
634 clock_enable_pkt[0][4] = hour;
635 clock_enable_pkt[0][5] = minute;
636 clock_enable_pkt[0][6] = second;
637 clock_enable_pkt[0][7] = 0x40;
639 clock_enable_pkt[1][0] = 0;
640 clock_enable_pkt[1][1] = 0;
641 clock_enable_pkt[1][2] = 1;
642 clock_enable_pkt[1][3] = 0;
643 clock_enable_pkt[1][4] = 0;
644 clock_enable_pkt[1][5] = 0;
645 clock_enable_pkt[1][6] = 0;
646 clock_enable_pkt[1][7] = 0x42;
648 break;
650 default:
651 return -ENODEV;
654 for (i = 0; i < IMON_CLOCK_ENABLE_PACKETS; i++) {
655 memcpy(ictx->usb_tx_buf, clock_enable_pkt[i], 8);
656 retval = send_packet(ictx);
657 if (retval) {
658 pr_err("send_packet failed for packet %d\n", i);
659 break;
663 return retval;
667 * These are the sysfs functions to handle the association on the iMON 2.4G LT.
669 static ssize_t show_associate_remote(struct device *d,
670 struct device_attribute *attr,
671 char *buf)
673 struct imon_context *ictx = dev_get_drvdata(d);
675 if (!ictx)
676 return -ENODEV;
678 mutex_lock(&ictx->lock);
679 if (ictx->rf_isassociating)
680 strcpy(buf, "associating\n");
681 else
682 strcpy(buf, "closed\n");
684 dev_info(d, "Visit http://www.lirc.org/html/imon-24g.html for "
685 "instructions on how to associate your iMON 2.4G DT/LT "
686 "remote\n");
687 mutex_unlock(&ictx->lock);
688 return strlen(buf);
691 static ssize_t store_associate_remote(struct device *d,
692 struct device_attribute *attr,
693 const char *buf, size_t count)
695 struct imon_context *ictx;
697 ictx = dev_get_drvdata(d);
699 if (!ictx)
700 return -ENODEV;
702 mutex_lock(&ictx->lock);
703 ictx->rf_isassociating = true;
704 send_associate_24g(ictx);
705 mutex_unlock(&ictx->lock);
707 return count;
711 * sysfs functions to control internal imon clock
713 static ssize_t show_imon_clock(struct device *d,
714 struct device_attribute *attr, char *buf)
716 struct imon_context *ictx = dev_get_drvdata(d);
717 size_t len;
719 if (!ictx)
720 return -ENODEV;
722 mutex_lock(&ictx->lock);
724 if (!ictx->display_supported) {
725 len = snprintf(buf, PAGE_SIZE, "Not supported.");
726 } else {
727 len = snprintf(buf, PAGE_SIZE,
728 "To set the clock on your iMON display:\n"
729 "# date \"+%%y %%m %%d %%w %%H %%M %%S\" > imon_clock\n"
730 "%s", ictx->display_isopen ?
731 "\nNOTE: imon device must be closed\n" : "");
734 mutex_unlock(&ictx->lock);
736 return len;
739 static ssize_t store_imon_clock(struct device *d,
740 struct device_attribute *attr,
741 const char *buf, size_t count)
743 struct imon_context *ictx = dev_get_drvdata(d);
744 ssize_t retval;
745 unsigned int year, month, day, dow, hour, minute, second;
747 if (!ictx)
748 return -ENODEV;
750 mutex_lock(&ictx->lock);
752 if (!ictx->display_supported) {
753 retval = -ENODEV;
754 goto exit;
755 } else if (ictx->display_isopen) {
756 retval = -EBUSY;
757 goto exit;
760 if (sscanf(buf, "%u %u %u %u %u %u %u", &year, &month, &day, &dow,
761 &hour, &minute, &second) != 7) {
762 retval = -EINVAL;
763 goto exit;
766 if ((month < 1 || month > 12) ||
767 (day < 1 || day > 31) || (dow > 6) ||
768 (hour > 23) || (minute > 59) || (second > 59)) {
769 retval = -EINVAL;
770 goto exit;
773 retval = send_set_imon_clock(ictx, year, month, day, dow,
774 hour, minute, second);
775 if (retval)
776 goto exit;
778 retval = count;
779 exit:
780 mutex_unlock(&ictx->lock);
782 return retval;
786 static DEVICE_ATTR(imon_clock, S_IWUSR | S_IRUGO, show_imon_clock,
787 store_imon_clock);
789 static DEVICE_ATTR(associate_remote, S_IWUSR | S_IRUGO, show_associate_remote,
790 store_associate_remote);
792 static struct attribute *imon_display_sysfs_entries[] = {
793 &dev_attr_imon_clock.attr,
794 NULL
797 static struct attribute_group imon_display_attr_group = {
798 .attrs = imon_display_sysfs_entries
801 static struct attribute *imon_rf_sysfs_entries[] = {
802 &dev_attr_associate_remote.attr,
803 NULL
806 static struct attribute_group imon_rf_attr_group = {
807 .attrs = imon_rf_sysfs_entries
811 * Writes data to the VFD. The iMON VFD is 2x16 characters
812 * and requires data in 5 consecutive USB interrupt packets,
813 * each packet but the last carrying 7 bytes.
815 * I don't know if the VFD board supports features such as
816 * scrolling, clearing rows, blanking, etc. so at
817 * the caller must provide a full screen of data. If fewer
818 * than 32 bytes are provided spaces will be appended to
819 * generate a full screen.
821 static ssize_t vfd_write(struct file *file, const char *buf,
822 size_t n_bytes, loff_t *pos)
824 int i;
825 int offset;
826 int seq;
827 int retval = 0;
828 struct imon_context *ictx;
829 const unsigned char vfd_packet6[] = {
830 0x01, 0x00, 0x00, 0x00, 0x00, 0xFF, 0xFF };
832 ictx = file->private_data;
833 if (!ictx) {
834 pr_err_ratelimited("no context for device\n");
835 return -ENODEV;
838 mutex_lock(&ictx->lock);
840 if (!ictx->dev_present_intf0) {
841 pr_err_ratelimited("no iMON device present\n");
842 retval = -ENODEV;
843 goto exit;
846 if (n_bytes <= 0 || n_bytes > 32) {
847 pr_err_ratelimited("invalid payload size\n");
848 retval = -EINVAL;
849 goto exit;
852 if (copy_from_user(ictx->tx.data_buf, buf, n_bytes)) {
853 retval = -EFAULT;
854 goto exit;
857 /* Pad with spaces */
858 for (i = n_bytes; i < 32; ++i)
859 ictx->tx.data_buf[i] = ' ';
861 for (i = 32; i < 35; ++i)
862 ictx->tx.data_buf[i] = 0xFF;
864 offset = 0;
865 seq = 0;
867 do {
868 memcpy(ictx->usb_tx_buf, ictx->tx.data_buf + offset, 7);
869 ictx->usb_tx_buf[7] = (unsigned char) seq;
871 retval = send_packet(ictx);
872 if (retval) {
873 pr_err_ratelimited("send packet #%d failed\n", seq / 2);
874 goto exit;
875 } else {
876 seq += 2;
877 offset += 7;
880 } while (offset < 35);
882 /* Send packet #6 */
883 memcpy(ictx->usb_tx_buf, &vfd_packet6, sizeof(vfd_packet6));
884 ictx->usb_tx_buf[7] = (unsigned char) seq;
885 retval = send_packet(ictx);
886 if (retval)
887 pr_err_ratelimited("send packet #%d failed\n", seq / 2);
889 exit:
890 mutex_unlock(&ictx->lock);
892 return (!retval) ? n_bytes : retval;
896 * Writes data to the LCD. The iMON OEM LCD screen expects 8-byte
897 * packets. We accept data as 16 hexadecimal digits, followed by a
898 * newline (to make it easy to drive the device from a command-line
899 * -- even though the actual binary data is a bit complicated).
901 * The device itself is not a "traditional" text-mode display. It's
902 * actually a 16x96 pixel bitmap display. That means if you want to
903 * display text, you've got to have your own "font" and translate the
904 * text into bitmaps for display. This is really flexible (you can
905 * display whatever diacritics you need, and so on), but it's also
906 * a lot more complicated than most LCDs...
908 static ssize_t lcd_write(struct file *file, const char *buf,
909 size_t n_bytes, loff_t *pos)
911 int retval = 0;
912 struct imon_context *ictx;
914 ictx = file->private_data;
915 if (!ictx) {
916 pr_err_ratelimited("no context for device\n");
917 return -ENODEV;
920 mutex_lock(&ictx->lock);
922 if (!ictx->display_supported) {
923 pr_err_ratelimited("no iMON display present\n");
924 retval = -ENODEV;
925 goto exit;
928 if (n_bytes != 8) {
929 pr_err_ratelimited("invalid payload size: %d (expected 8)\n",
930 (int)n_bytes);
931 retval = -EINVAL;
932 goto exit;
935 if (copy_from_user(ictx->usb_tx_buf, buf, 8)) {
936 retval = -EFAULT;
937 goto exit;
940 retval = send_packet(ictx);
941 if (retval) {
942 pr_err_ratelimited("send packet failed!\n");
943 goto exit;
944 } else {
945 dev_dbg(ictx->dev, "%s: write %d bytes to LCD\n",
946 __func__, (int) n_bytes);
948 exit:
949 mutex_unlock(&ictx->lock);
950 return (!retval) ? n_bytes : retval;
954 * Callback function for USB core API: transmit data
956 static void usb_tx_callback(struct urb *urb)
958 struct imon_context *ictx;
960 if (!urb)
961 return;
962 ictx = (struct imon_context *)urb->context;
963 if (!ictx)
964 return;
966 ictx->tx.status = urb->status;
968 /* notify waiters that write has finished */
969 ictx->tx.busy = false;
970 smp_rmb(); /* ensure later readers know we're not busy */
971 complete(&ictx->tx.finished);
975 * report touchscreen input
977 static void imon_touch_display_timeout(unsigned long data)
979 struct imon_context *ictx = (struct imon_context *)data;
981 if (ictx->display_type != IMON_DISPLAY_TYPE_VGA)
982 return;
984 input_report_abs(ictx->touch, ABS_X, ictx->touch_x);
985 input_report_abs(ictx->touch, ABS_Y, ictx->touch_y);
986 input_report_key(ictx->touch, BTN_TOUCH, 0x00);
987 input_sync(ictx->touch);
991 * iMON IR receivers support two different signal sets -- those used by
992 * the iMON remotes, and those used by the Windows MCE remotes (which is
993 * really just RC-6), but only one or the other at a time, as the signals
994 * are decoded onboard the receiver.
996 * This function gets called two different ways, one way is from
997 * rc_register_device, for initial protocol selection/setup, and the other is
998 * via a userspace-initiated protocol change request, either by direct sysfs
999 * prodding or by something like ir-keytable. In the rc_register_device case,
1000 * the imon context lock is already held, but when initiated from userspace,
1001 * it is not, so we must acquire it prior to calling send_packet, which
1002 * requires that the lock is held.
1004 static int imon_ir_change_protocol(struct rc_dev *rc, u64 rc_type)
1006 int retval;
1007 struct imon_context *ictx = rc->priv;
1008 struct device *dev = ictx->dev;
1009 bool unlock = false;
1010 unsigned char ir_proto_packet[] = {
1011 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x86 };
1013 if (rc_type && !(rc_type & rc->allowed_protos))
1014 dev_warn(dev, "Looks like you're trying to use an IR protocol "
1015 "this device does not support\n");
1017 switch (rc_type) {
1018 case RC_TYPE_RC6:
1019 dev_dbg(dev, "Configuring IR receiver for MCE protocol\n");
1020 ir_proto_packet[0] = 0x01;
1021 break;
1022 case RC_TYPE_UNKNOWN:
1023 case RC_TYPE_OTHER:
1024 dev_dbg(dev, "Configuring IR receiver for iMON protocol\n");
1025 if (!pad_stabilize)
1026 dev_dbg(dev, "PAD stabilize functionality disabled\n");
1027 /* ir_proto_packet[0] = 0x00; // already the default */
1028 rc_type = RC_TYPE_OTHER;
1029 break;
1030 default:
1031 dev_warn(dev, "Unsupported IR protocol specified, overriding "
1032 "to iMON IR protocol\n");
1033 if (!pad_stabilize)
1034 dev_dbg(dev, "PAD stabilize functionality disabled\n");
1035 /* ir_proto_packet[0] = 0x00; // already the default */
1036 rc_type = RC_TYPE_OTHER;
1037 break;
1040 memcpy(ictx->usb_tx_buf, &ir_proto_packet, sizeof(ir_proto_packet));
1042 if (!mutex_is_locked(&ictx->lock)) {
1043 unlock = true;
1044 mutex_lock(&ictx->lock);
1047 retval = send_packet(ictx);
1048 if (retval)
1049 goto out;
1051 ictx->rc_type = rc_type;
1052 ictx->pad_mouse = false;
1054 out:
1055 if (unlock)
1056 mutex_unlock(&ictx->lock);
1058 return retval;
1061 static inline int tv2int(const struct timeval *a, const struct timeval *b)
1063 int usecs = 0;
1064 int sec = 0;
1066 if (b->tv_usec > a->tv_usec) {
1067 usecs = 1000000;
1068 sec--;
1071 usecs += a->tv_usec - b->tv_usec;
1073 sec += a->tv_sec - b->tv_sec;
1074 sec *= 1000;
1075 usecs /= 1000;
1076 sec += usecs;
1078 if (sec < 0)
1079 sec = 1000;
1081 return sec;
1085 * The directional pad behaves a bit differently, depending on whether this is
1086 * one of the older ffdc devices or a newer device. Newer devices appear to
1087 * have a higher resolution matrix for more precise mouse movement, but it
1088 * makes things overly sensitive in keyboard mode, so we do some interesting
1089 * contortions to make it less touchy. Older devices run through the same
1090 * routine with shorter timeout and a smaller threshold.
1092 static int stabilize(int a, int b, u16 timeout, u16 threshold)
1094 struct timeval ct;
1095 static struct timeval prev_time = {0, 0};
1096 static struct timeval hit_time = {0, 0};
1097 static int x, y, prev_result, hits;
1098 int result = 0;
1099 int msec, msec_hit;
1101 do_gettimeofday(&ct);
1102 msec = tv2int(&ct, &prev_time);
1103 msec_hit = tv2int(&ct, &hit_time);
1105 if (msec > 100) {
1106 x = 0;
1107 y = 0;
1108 hits = 0;
1111 x += a;
1112 y += b;
1114 prev_time = ct;
1116 if (abs(x) > threshold || abs(y) > threshold) {
1117 if (abs(y) > abs(x))
1118 result = (y > 0) ? 0x7F : 0x80;
1119 else
1120 result = (x > 0) ? 0x7F00 : 0x8000;
1122 x = 0;
1123 y = 0;
1125 if (result == prev_result) {
1126 hits++;
1128 if (hits > 3) {
1129 switch (result) {
1130 case 0x7F:
1131 y = 17 * threshold / 30;
1132 break;
1133 case 0x80:
1134 y -= 17 * threshold / 30;
1135 break;
1136 case 0x7F00:
1137 x = 17 * threshold / 30;
1138 break;
1139 case 0x8000:
1140 x -= 17 * threshold / 30;
1141 break;
1145 if (hits == 2 && msec_hit < timeout) {
1146 result = 0;
1147 hits = 1;
1149 } else {
1150 prev_result = result;
1151 hits = 1;
1152 hit_time = ct;
1156 return result;
1159 static u32 imon_remote_key_lookup(struct imon_context *ictx, u32 scancode)
1161 u32 keycode;
1162 u32 release;
1163 bool is_release_code = false;
1165 /* Look for the initial press of a button */
1166 keycode = rc_g_keycode_from_table(ictx->rdev, scancode);
1167 ictx->rc_toggle = 0x0;
1168 ictx->rc_scancode = scancode;
1170 /* Look for the release of a button */
1171 if (keycode == KEY_RESERVED) {
1172 release = scancode & ~0x4000;
1173 keycode = rc_g_keycode_from_table(ictx->rdev, release);
1174 if (keycode != KEY_RESERVED)
1175 is_release_code = true;
1178 ictx->release_code = is_release_code;
1180 return keycode;
1183 static u32 imon_mce_key_lookup(struct imon_context *ictx, u32 scancode)
1185 u32 keycode;
1187 #define MCE_KEY_MASK 0x7000
1188 #define MCE_TOGGLE_BIT 0x8000
1191 * On some receivers, mce keys decode to 0x8000f04xx and 0x8000f84xx
1192 * (the toggle bit flipping between alternating key presses), while
1193 * on other receivers, we see 0x8000f74xx and 0x8000ff4xx. To keep
1194 * the table trim, we always or in the bits to look up 0x8000ff4xx,
1195 * but we can't or them into all codes, as some keys are decoded in
1196 * a different way w/o the same use of the toggle bit...
1198 if (scancode & 0x80000000)
1199 scancode = scancode | MCE_KEY_MASK | MCE_TOGGLE_BIT;
1201 ictx->rc_scancode = scancode;
1202 keycode = rc_g_keycode_from_table(ictx->rdev, scancode);
1204 /* not used in mce mode, but make sure we know its false */
1205 ictx->release_code = false;
1207 return keycode;
1210 static u32 imon_panel_key_lookup(u64 code)
1212 int i;
1213 u32 keycode = KEY_RESERVED;
1215 for (i = 0; i < ARRAY_SIZE(imon_panel_key_table); i++) {
1216 if (imon_panel_key_table[i].hw_code == (code | 0xffee)) {
1217 keycode = imon_panel_key_table[i].keycode;
1218 break;
1222 return keycode;
1225 static bool imon_mouse_event(struct imon_context *ictx,
1226 unsigned char *buf, int len)
1228 char rel_x = 0x00, rel_y = 0x00;
1229 u8 right_shift = 1;
1230 bool mouse_input = true;
1231 int dir = 0;
1232 unsigned long flags;
1234 spin_lock_irqsave(&ictx->kc_lock, flags);
1236 /* newer iMON device PAD or mouse button */
1237 if (ictx->product != 0xffdc && (buf[0] & 0x01) && len == 5) {
1238 rel_x = buf[2];
1239 rel_y = buf[3];
1240 right_shift = 1;
1241 /* 0xffdc iMON PAD or mouse button input */
1242 } else if (ictx->product == 0xffdc && (buf[0] & 0x40) &&
1243 !((buf[1] & 0x01) || ((buf[1] >> 2) & 0x01))) {
1244 rel_x = (buf[1] & 0x08) | (buf[1] & 0x10) >> 2 |
1245 (buf[1] & 0x20) >> 4 | (buf[1] & 0x40) >> 6;
1246 if (buf[0] & 0x02)
1247 rel_x |= ~0x0f;
1248 rel_x = rel_x + rel_x / 2;
1249 rel_y = (buf[2] & 0x08) | (buf[2] & 0x10) >> 2 |
1250 (buf[2] & 0x20) >> 4 | (buf[2] & 0x40) >> 6;
1251 if (buf[0] & 0x01)
1252 rel_y |= ~0x0f;
1253 rel_y = rel_y + rel_y / 2;
1254 right_shift = 2;
1255 /* some ffdc devices decode mouse buttons differently... */
1256 } else if (ictx->product == 0xffdc && (buf[0] == 0x68)) {
1257 right_shift = 2;
1258 /* ch+/- buttons, which we use for an emulated scroll wheel */
1259 } else if (ictx->kc == KEY_CHANNELUP && (buf[2] & 0x40) != 0x40) {
1260 dir = 1;
1261 } else if (ictx->kc == KEY_CHANNELDOWN && (buf[2] & 0x40) != 0x40) {
1262 dir = -1;
1263 } else
1264 mouse_input = false;
1266 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1268 if (mouse_input) {
1269 dev_dbg(ictx->dev, "sending mouse data via input subsystem\n");
1271 if (dir) {
1272 input_report_rel(ictx->idev, REL_WHEEL, dir);
1273 } else if (rel_x || rel_y) {
1274 input_report_rel(ictx->idev, REL_X, rel_x);
1275 input_report_rel(ictx->idev, REL_Y, rel_y);
1276 } else {
1277 input_report_key(ictx->idev, BTN_LEFT, buf[1] & 0x1);
1278 input_report_key(ictx->idev, BTN_RIGHT,
1279 buf[1] >> right_shift & 0x1);
1281 input_sync(ictx->idev);
1282 spin_lock_irqsave(&ictx->kc_lock, flags);
1283 ictx->last_keycode = ictx->kc;
1284 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1287 return mouse_input;
1290 static void imon_touch_event(struct imon_context *ictx, unsigned char *buf)
1292 mod_timer(&ictx->ttimer, jiffies + TOUCH_TIMEOUT);
1293 ictx->touch_x = (buf[0] << 4) | (buf[1] >> 4);
1294 ictx->touch_y = 0xfff - ((buf[2] << 4) | (buf[1] & 0xf));
1295 input_report_abs(ictx->touch, ABS_X, ictx->touch_x);
1296 input_report_abs(ictx->touch, ABS_Y, ictx->touch_y);
1297 input_report_key(ictx->touch, BTN_TOUCH, 0x01);
1298 input_sync(ictx->touch);
1301 static void imon_pad_to_keys(struct imon_context *ictx, unsigned char *buf)
1303 int dir = 0;
1304 char rel_x = 0x00, rel_y = 0x00;
1305 u16 timeout, threshold;
1306 u32 scancode = KEY_RESERVED;
1307 unsigned long flags;
1310 * The imon directional pad functions more like a touchpad. Bytes 3 & 4
1311 * contain a position coordinate (x,y), with each component ranging
1312 * from -14 to 14. We want to down-sample this to only 4 discrete values
1313 * for up/down/left/right arrow keys. Also, when you get too close to
1314 * diagonals, it has a tendency to jump back and forth, so lets try to
1315 * ignore when they get too close.
1317 if (ictx->product != 0xffdc) {
1318 /* first, pad to 8 bytes so it conforms with everything else */
1319 buf[5] = buf[6] = buf[7] = 0;
1320 timeout = 500; /* in msecs */
1321 /* (2*threshold) x (2*threshold) square */
1322 threshold = pad_thresh ? pad_thresh : 28;
1323 rel_x = buf[2];
1324 rel_y = buf[3];
1326 if (ictx->rc_type == RC_TYPE_OTHER && pad_stabilize) {
1327 if ((buf[1] == 0) && ((rel_x != 0) || (rel_y != 0))) {
1328 dir = stabilize((int)rel_x, (int)rel_y,
1329 timeout, threshold);
1330 if (!dir) {
1331 spin_lock_irqsave(&ictx->kc_lock,
1332 flags);
1333 ictx->kc = KEY_UNKNOWN;
1334 spin_unlock_irqrestore(&ictx->kc_lock,
1335 flags);
1336 return;
1338 buf[2] = dir & 0xFF;
1339 buf[3] = (dir >> 8) & 0xFF;
1340 scancode = be32_to_cpu(*((u32 *)buf));
1342 } else {
1344 * Hack alert: instead of using keycodes, we have
1345 * to use hard-coded scancodes here...
1347 if (abs(rel_y) > abs(rel_x)) {
1348 buf[2] = (rel_y > 0) ? 0x7F : 0x80;
1349 buf[3] = 0;
1350 if (rel_y > 0)
1351 scancode = 0x01007f00; /* KEY_DOWN */
1352 else
1353 scancode = 0x01008000; /* KEY_UP */
1354 } else {
1355 buf[2] = 0;
1356 buf[3] = (rel_x > 0) ? 0x7F : 0x80;
1357 if (rel_x > 0)
1358 scancode = 0x0100007f; /* KEY_RIGHT */
1359 else
1360 scancode = 0x01000080; /* KEY_LEFT */
1365 * Handle on-board decoded pad events for e.g. older VFD/iMON-Pad
1366 * device (15c2:ffdc). The remote generates various codes from
1367 * 0x68nnnnB7 to 0x6AnnnnB7, the left mouse button generates
1368 * 0x688301b7 and the right one 0x688481b7. All other keys generate
1369 * 0x2nnnnnnn. Position coordinate is encoded in buf[1] and buf[2] with
1370 * reversed endianess. Extract direction from buffer, rotate endianess,
1371 * adjust sign and feed the values into stabilize(). The resulting codes
1372 * will be 0x01008000, 0x01007F00, which match the newer devices.
1374 } else {
1375 timeout = 10; /* in msecs */
1376 /* (2*threshold) x (2*threshold) square */
1377 threshold = pad_thresh ? pad_thresh : 15;
1379 /* buf[1] is x */
1380 rel_x = (buf[1] & 0x08) | (buf[1] & 0x10) >> 2 |
1381 (buf[1] & 0x20) >> 4 | (buf[1] & 0x40) >> 6;
1382 if (buf[0] & 0x02)
1383 rel_x |= ~0x10+1;
1384 /* buf[2] is y */
1385 rel_y = (buf[2] & 0x08) | (buf[2] & 0x10) >> 2 |
1386 (buf[2] & 0x20) >> 4 | (buf[2] & 0x40) >> 6;
1387 if (buf[0] & 0x01)
1388 rel_y |= ~0x10+1;
1390 buf[0] = 0x01;
1391 buf[1] = buf[4] = buf[5] = buf[6] = buf[7] = 0;
1393 if (ictx->rc_type == RC_TYPE_OTHER && pad_stabilize) {
1394 dir = stabilize((int)rel_x, (int)rel_y,
1395 timeout, threshold);
1396 if (!dir) {
1397 spin_lock_irqsave(&ictx->kc_lock, flags);
1398 ictx->kc = KEY_UNKNOWN;
1399 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1400 return;
1402 buf[2] = dir & 0xFF;
1403 buf[3] = (dir >> 8) & 0xFF;
1404 scancode = be32_to_cpu(*((u32 *)buf));
1405 } else {
1407 * Hack alert: instead of using keycodes, we have
1408 * to use hard-coded scancodes here...
1410 if (abs(rel_y) > abs(rel_x)) {
1411 buf[2] = (rel_y > 0) ? 0x7F : 0x80;
1412 buf[3] = 0;
1413 if (rel_y > 0)
1414 scancode = 0x01007f00; /* KEY_DOWN */
1415 else
1416 scancode = 0x01008000; /* KEY_UP */
1417 } else {
1418 buf[2] = 0;
1419 buf[3] = (rel_x > 0) ? 0x7F : 0x80;
1420 if (rel_x > 0)
1421 scancode = 0x0100007f; /* KEY_RIGHT */
1422 else
1423 scancode = 0x01000080; /* KEY_LEFT */
1428 if (scancode) {
1429 spin_lock_irqsave(&ictx->kc_lock, flags);
1430 ictx->kc = imon_remote_key_lookup(ictx, scancode);
1431 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1436 * figure out if these is a press or a release. We don't actually
1437 * care about repeats, as those will be auto-generated within the IR
1438 * subsystem for repeating scancodes.
1440 static int imon_parse_press_type(struct imon_context *ictx,
1441 unsigned char *buf, u8 ktype)
1443 int press_type = 0;
1444 unsigned long flags;
1446 spin_lock_irqsave(&ictx->kc_lock, flags);
1448 /* key release of 0x02XXXXXX key */
1449 if (ictx->kc == KEY_RESERVED && buf[0] == 0x02 && buf[3] == 0x00)
1450 ictx->kc = ictx->last_keycode;
1452 /* mouse button release on (some) 0xffdc devices */
1453 else if (ictx->kc == KEY_RESERVED && buf[0] == 0x68 && buf[1] == 0x82 &&
1454 buf[2] == 0x81 && buf[3] == 0xb7)
1455 ictx->kc = ictx->last_keycode;
1457 /* mouse button release on (some other) 0xffdc devices */
1458 else if (ictx->kc == KEY_RESERVED && buf[0] == 0x01 && buf[1] == 0x00 &&
1459 buf[2] == 0x81 && buf[3] == 0xb7)
1460 ictx->kc = ictx->last_keycode;
1462 /* mce-specific button handling, no keyup events */
1463 else if (ktype == IMON_KEY_MCE) {
1464 ictx->rc_toggle = buf[2];
1465 press_type = 1;
1467 /* incoherent or irrelevant data */
1468 } else if (ictx->kc == KEY_RESERVED)
1469 press_type = -EINVAL;
1471 /* key release of 0xXXXXXXb7 key */
1472 else if (ictx->release_code)
1473 press_type = 0;
1475 /* this is a button press */
1476 else
1477 press_type = 1;
1479 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1481 return press_type;
1485 * Process the incoming packet
1487 static void imon_incoming_packet(struct imon_context *ictx,
1488 struct urb *urb, int intf)
1490 int len = urb->actual_length;
1491 unsigned char *buf = urb->transfer_buffer;
1492 struct device *dev = ictx->dev;
1493 unsigned long flags;
1494 u32 kc;
1495 int i;
1496 u64 scancode;
1497 int press_type = 0;
1498 int msec;
1499 struct timeval t;
1500 static struct timeval prev_time = { 0, 0 };
1501 u8 ktype;
1503 /* filter out junk data on the older 0xffdc imon devices */
1504 if ((buf[0] == 0xff) && (buf[1] == 0xff) && (buf[2] == 0xff))
1505 return;
1507 /* Figure out what key was pressed */
1508 if (len == 8 && buf[7] == 0xee) {
1509 scancode = be64_to_cpu(*((u64 *)buf));
1510 ktype = IMON_KEY_PANEL;
1511 kc = imon_panel_key_lookup(scancode);
1512 } else {
1513 scancode = be32_to_cpu(*((u32 *)buf));
1514 if (ictx->rc_type == RC_TYPE_RC6) {
1515 ktype = IMON_KEY_IMON;
1516 if (buf[0] == 0x80)
1517 ktype = IMON_KEY_MCE;
1518 kc = imon_mce_key_lookup(ictx, scancode);
1519 } else {
1520 ktype = IMON_KEY_IMON;
1521 kc = imon_remote_key_lookup(ictx, scancode);
1525 spin_lock_irqsave(&ictx->kc_lock, flags);
1526 /* keyboard/mouse mode toggle button */
1527 if (kc == KEY_KEYBOARD && !ictx->release_code) {
1528 ictx->last_keycode = kc;
1529 if (!nomouse) {
1530 ictx->pad_mouse = ~(ictx->pad_mouse) & 0x1;
1531 dev_dbg(dev, "toggling to %s mode\n",
1532 ictx->pad_mouse ? "mouse" : "keyboard");
1533 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1534 return;
1535 } else {
1536 ictx->pad_mouse = false;
1537 dev_dbg(dev, "mouse mode disabled, passing key value\n");
1541 ictx->kc = kc;
1542 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1544 /* send touchscreen events through input subsystem if touchpad data */
1545 if (ictx->display_type == IMON_DISPLAY_TYPE_VGA && len == 8 &&
1546 buf[7] == 0x86) {
1547 imon_touch_event(ictx, buf);
1548 return;
1550 /* look for mouse events with pad in mouse mode */
1551 } else if (ictx->pad_mouse) {
1552 if (imon_mouse_event(ictx, buf, len))
1553 return;
1556 /* Now for some special handling to convert pad input to arrow keys */
1557 if (((len == 5) && (buf[0] == 0x01) && (buf[4] == 0x00)) ||
1558 ((len == 8) && (buf[0] & 0x40) &&
1559 !(buf[1] & 0x1 || buf[1] >> 2 & 0x1))) {
1560 len = 8;
1561 imon_pad_to_keys(ictx, buf);
1564 if (debug) {
1565 printk(KERN_INFO "intf%d decoded packet: ", intf);
1566 for (i = 0; i < len; ++i)
1567 printk("%02x ", buf[i]);
1568 printk("\n");
1571 press_type = imon_parse_press_type(ictx, buf, ktype);
1572 if (press_type < 0)
1573 goto not_input_data;
1575 spin_lock_irqsave(&ictx->kc_lock, flags);
1576 if (ictx->kc == KEY_UNKNOWN)
1577 goto unknown_key;
1578 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1580 if (ktype != IMON_KEY_PANEL) {
1581 if (press_type == 0)
1582 rc_keyup(ictx->rdev);
1583 else {
1584 rc_keydown(ictx->rdev, ictx->rc_scancode, ictx->rc_toggle);
1585 spin_lock_irqsave(&ictx->kc_lock, flags);
1586 ictx->last_keycode = ictx->kc;
1587 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1589 return;
1592 /* Only panel type events left to process now */
1593 spin_lock_irqsave(&ictx->kc_lock, flags);
1595 do_gettimeofday(&t);
1596 /* KEY_MUTE repeats from knob need to be suppressed */
1597 if (ictx->kc == KEY_MUTE && ictx->kc == ictx->last_keycode) {
1598 msec = tv2int(&t, &prev_time);
1599 if (msec < ictx->idev->rep[REP_DELAY]) {
1600 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1601 return;
1604 prev_time = t;
1605 kc = ictx->kc;
1607 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1609 input_report_key(ictx->idev, kc, press_type);
1610 input_sync(ictx->idev);
1612 /* panel keys don't generate a release */
1613 input_report_key(ictx->idev, kc, 0);
1614 input_sync(ictx->idev);
1616 spin_lock_irqsave(&ictx->kc_lock, flags);
1617 ictx->last_keycode = kc;
1618 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1620 return;
1622 unknown_key:
1623 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1624 dev_info(dev, "%s: unknown keypress, code 0x%llx\n", __func__,
1625 (long long)scancode);
1626 return;
1628 not_input_data:
1629 if (len != 8) {
1630 dev_warn(dev, "imon %s: invalid incoming packet "
1631 "size (len = %d, intf%d)\n", __func__, len, intf);
1632 return;
1635 /* iMON 2.4G associate frame */
1636 if (buf[0] == 0x00 &&
1637 buf[2] == 0xFF && /* REFID */
1638 buf[3] == 0xFF &&
1639 buf[4] == 0xFF &&
1640 buf[5] == 0xFF && /* iMON 2.4G */
1641 ((buf[6] == 0x4E && buf[7] == 0xDF) || /* LT */
1642 (buf[6] == 0x5E && buf[7] == 0xDF))) { /* DT */
1643 dev_warn(dev, "%s: remote associated refid=%02X\n",
1644 __func__, buf[1]);
1645 ictx->rf_isassociating = false;
1650 * Callback function for USB core API: receive data
1652 static void usb_rx_callback_intf0(struct urb *urb)
1654 struct imon_context *ictx;
1655 int intfnum = 0;
1657 if (!urb)
1658 return;
1660 ictx = (struct imon_context *)urb->context;
1661 if (!ictx || !ictx->dev_present_intf0)
1662 return;
1664 switch (urb->status) {
1665 case -ENOENT: /* usbcore unlink successful! */
1666 return;
1668 case -ESHUTDOWN: /* transport endpoint was shut down */
1669 break;
1671 case 0:
1672 imon_incoming_packet(ictx, urb, intfnum);
1673 break;
1675 default:
1676 dev_warn(ictx->dev, "imon %s: status(%d): ignored\n",
1677 __func__, urb->status);
1678 break;
1681 usb_submit_urb(ictx->rx_urb_intf0, GFP_ATOMIC);
1684 static void usb_rx_callback_intf1(struct urb *urb)
1686 struct imon_context *ictx;
1687 int intfnum = 1;
1689 if (!urb)
1690 return;
1692 ictx = (struct imon_context *)urb->context;
1693 if (!ictx || !ictx->dev_present_intf1)
1694 return;
1696 switch (urb->status) {
1697 case -ENOENT: /* usbcore unlink successful! */
1698 return;
1700 case -ESHUTDOWN: /* transport endpoint was shut down */
1701 break;
1703 case 0:
1704 imon_incoming_packet(ictx, urb, intfnum);
1705 break;
1707 default:
1708 dev_warn(ictx->dev, "imon %s: status(%d): ignored\n",
1709 __func__, urb->status);
1710 break;
1713 usb_submit_urb(ictx->rx_urb_intf1, GFP_ATOMIC);
1717 * The 0x15c2:0xffdc device ID was used for umpteen different imon
1718 * devices, and all of them constantly spew interrupts, even when there
1719 * is no actual data to report. However, byte 6 of this buffer looks like
1720 * its unique across device variants, so we're trying to key off that to
1721 * figure out which display type (if any) and what IR protocol the device
1722 * actually supports. These devices have their IR protocol hard-coded into
1723 * their firmware, they can't be changed on the fly like the newer hardware.
1725 static void imon_get_ffdc_type(struct imon_context *ictx)
1727 u8 ffdc_cfg_byte = ictx->usb_rx_buf[6];
1728 u8 detected_display_type = IMON_DISPLAY_TYPE_NONE;
1729 u64 allowed_protos = RC_TYPE_OTHER;
1731 switch (ffdc_cfg_byte) {
1732 /* iMON Knob, no display, iMON IR + vol knob */
1733 case 0x21:
1734 dev_info(ictx->dev, "0xffdc iMON Knob, iMON IR");
1735 ictx->display_supported = false;
1736 break;
1737 /* iMON 2.4G LT (usb stick), no display, iMON RF */
1738 case 0x4e:
1739 dev_info(ictx->dev, "0xffdc iMON 2.4G LT, iMON RF");
1740 ictx->display_supported = false;
1741 ictx->rf_device = true;
1742 break;
1743 /* iMON VFD, no IR (does have vol knob tho) */
1744 case 0x35:
1745 dev_info(ictx->dev, "0xffdc iMON VFD + knob, no IR");
1746 detected_display_type = IMON_DISPLAY_TYPE_VFD;
1747 break;
1748 /* iMON VFD, iMON IR */
1749 case 0x24:
1750 case 0x85:
1751 dev_info(ictx->dev, "0xffdc iMON VFD, iMON IR");
1752 detected_display_type = IMON_DISPLAY_TYPE_VFD;
1753 break;
1754 /* iMON VFD, MCE IR */
1755 case 0x46:
1756 case 0x7e:
1757 case 0x9e:
1758 dev_info(ictx->dev, "0xffdc iMON VFD, MCE IR");
1759 detected_display_type = IMON_DISPLAY_TYPE_VFD;
1760 allowed_protos = RC_TYPE_RC6;
1761 break;
1762 /* iMON LCD, MCE IR */
1763 case 0x9f:
1764 dev_info(ictx->dev, "0xffdc iMON LCD, MCE IR");
1765 detected_display_type = IMON_DISPLAY_TYPE_LCD;
1766 allowed_protos = RC_TYPE_RC6;
1767 break;
1768 default:
1769 dev_info(ictx->dev, "Unknown 0xffdc device, "
1770 "defaulting to VFD and iMON IR");
1771 detected_display_type = IMON_DISPLAY_TYPE_VFD;
1772 /* We don't know which one it is, allow user to set the
1773 * RC6 one from userspace if OTHER wasn't correct. */
1774 allowed_protos |= RC_TYPE_RC6;
1775 break;
1778 printk(KERN_CONT " (id 0x%02x)\n", ffdc_cfg_byte);
1780 ictx->display_type = detected_display_type;
1781 ictx->rc_type = allowed_protos;
1784 static void imon_set_display_type(struct imon_context *ictx)
1786 u8 configured_display_type = IMON_DISPLAY_TYPE_VFD;
1789 * Try to auto-detect the type of display if the user hasn't set
1790 * it by hand via the display_type modparam. Default is VFD.
1793 if (display_type == IMON_DISPLAY_TYPE_AUTO) {
1794 switch (ictx->product) {
1795 case 0xffdc:
1796 /* set in imon_get_ffdc_type() */
1797 configured_display_type = ictx->display_type;
1798 break;
1799 case 0x0034:
1800 case 0x0035:
1801 configured_display_type = IMON_DISPLAY_TYPE_VGA;
1802 break;
1803 case 0x0038:
1804 case 0x0039:
1805 case 0x0045:
1806 configured_display_type = IMON_DISPLAY_TYPE_LCD;
1807 break;
1808 case 0x003c:
1809 case 0x0041:
1810 case 0x0042:
1811 case 0x0043:
1812 configured_display_type = IMON_DISPLAY_TYPE_NONE;
1813 ictx->display_supported = false;
1814 break;
1815 case 0x0036:
1816 case 0x0044:
1817 default:
1818 configured_display_type = IMON_DISPLAY_TYPE_VFD;
1819 break;
1821 } else {
1822 configured_display_type = display_type;
1823 if (display_type == IMON_DISPLAY_TYPE_NONE)
1824 ictx->display_supported = false;
1825 else
1826 ictx->display_supported = true;
1827 dev_info(ictx->dev, "%s: overriding display type to %d via "
1828 "modparam\n", __func__, display_type);
1831 ictx->display_type = configured_display_type;
1834 static struct rc_dev *imon_init_rdev(struct imon_context *ictx)
1836 struct rc_dev *rdev;
1837 int ret;
1838 const unsigned char fp_packet[] = { 0x40, 0x00, 0x00, 0x00,
1839 0x00, 0x00, 0x00, 0x88 };
1841 rdev = rc_allocate_device();
1842 if (!rdev) {
1843 dev_err(ictx->dev, "remote control dev allocation failed\n");
1844 goto out;
1847 snprintf(ictx->name_rdev, sizeof(ictx->name_rdev),
1848 "iMON Remote (%04x:%04x)", ictx->vendor, ictx->product);
1849 usb_make_path(ictx->usbdev_intf0, ictx->phys_rdev,
1850 sizeof(ictx->phys_rdev));
1851 strlcat(ictx->phys_rdev, "/input0", sizeof(ictx->phys_rdev));
1853 rdev->input_name = ictx->name_rdev;
1854 rdev->input_phys = ictx->phys_rdev;
1855 usb_to_input_id(ictx->usbdev_intf0, &rdev->input_id);
1856 rdev->dev.parent = ictx->dev;
1858 rdev->priv = ictx;
1859 rdev->driver_type = RC_DRIVER_SCANCODE;
1860 rdev->allowed_protos = RC_TYPE_OTHER | RC_TYPE_RC6; /* iMON PAD or MCE */
1861 rdev->change_protocol = imon_ir_change_protocol;
1862 rdev->driver_name = MOD_NAME;
1864 /* Enable front-panel buttons and/or knobs */
1865 memcpy(ictx->usb_tx_buf, &fp_packet, sizeof(fp_packet));
1866 ret = send_packet(ictx);
1867 /* Not fatal, but warn about it */
1868 if (ret)
1869 dev_info(ictx->dev, "panel buttons/knobs setup failed\n");
1871 if (ictx->product == 0xffdc) {
1872 imon_get_ffdc_type(ictx);
1873 rdev->allowed_protos = ictx->rc_type;
1876 imon_set_display_type(ictx);
1878 if (ictx->rc_type == RC_TYPE_RC6)
1879 rdev->map_name = RC_MAP_IMON_MCE;
1880 else
1881 rdev->map_name = RC_MAP_IMON_PAD;
1883 ret = rc_register_device(rdev);
1884 if (ret < 0) {
1885 dev_err(ictx->dev, "remote input dev register failed\n");
1886 goto out;
1889 return rdev;
1891 out:
1892 rc_free_device(rdev);
1893 return NULL;
1896 static struct input_dev *imon_init_idev(struct imon_context *ictx)
1898 struct input_dev *idev;
1899 int ret, i;
1901 idev = input_allocate_device();
1902 if (!idev) {
1903 dev_err(ictx->dev, "input dev allocation failed\n");
1904 goto out;
1907 snprintf(ictx->name_idev, sizeof(ictx->name_idev),
1908 "iMON Panel, Knob and Mouse(%04x:%04x)",
1909 ictx->vendor, ictx->product);
1910 idev->name = ictx->name_idev;
1912 usb_make_path(ictx->usbdev_intf0, ictx->phys_idev,
1913 sizeof(ictx->phys_idev));
1914 strlcat(ictx->phys_idev, "/input1", sizeof(ictx->phys_idev));
1915 idev->phys = ictx->phys_idev;
1917 idev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP) | BIT_MASK(EV_REL);
1919 idev->keybit[BIT_WORD(BTN_MOUSE)] =
1920 BIT_MASK(BTN_LEFT) | BIT_MASK(BTN_RIGHT);
1921 idev->relbit[0] = BIT_MASK(REL_X) | BIT_MASK(REL_Y) |
1922 BIT_MASK(REL_WHEEL);
1924 /* panel and/or knob code support */
1925 for (i = 0; i < ARRAY_SIZE(imon_panel_key_table); i++) {
1926 u32 kc = imon_panel_key_table[i].keycode;
1927 __set_bit(kc, idev->keybit);
1930 usb_to_input_id(ictx->usbdev_intf0, &idev->id);
1931 idev->dev.parent = ictx->dev;
1932 input_set_drvdata(idev, ictx);
1934 ret = input_register_device(idev);
1935 if (ret < 0) {
1936 dev_err(ictx->dev, "input dev register failed\n");
1937 goto out;
1940 return idev;
1942 out:
1943 input_free_device(idev);
1944 return NULL;
1947 static struct input_dev *imon_init_touch(struct imon_context *ictx)
1949 struct input_dev *touch;
1950 int ret;
1952 touch = input_allocate_device();
1953 if (!touch) {
1954 dev_err(ictx->dev, "touchscreen input dev allocation failed\n");
1955 goto touch_alloc_failed;
1958 snprintf(ictx->name_touch, sizeof(ictx->name_touch),
1959 "iMON USB Touchscreen (%04x:%04x)",
1960 ictx->vendor, ictx->product);
1961 touch->name = ictx->name_touch;
1963 usb_make_path(ictx->usbdev_intf1, ictx->phys_touch,
1964 sizeof(ictx->phys_touch));
1965 strlcat(ictx->phys_touch, "/input2", sizeof(ictx->phys_touch));
1966 touch->phys = ictx->phys_touch;
1968 touch->evbit[0] =
1969 BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
1970 touch->keybit[BIT_WORD(BTN_TOUCH)] =
1971 BIT_MASK(BTN_TOUCH);
1972 input_set_abs_params(touch, ABS_X,
1973 0x00, 0xfff, 0, 0);
1974 input_set_abs_params(touch, ABS_Y,
1975 0x00, 0xfff, 0, 0);
1977 input_set_drvdata(touch, ictx);
1979 usb_to_input_id(ictx->usbdev_intf1, &touch->id);
1980 touch->dev.parent = ictx->dev;
1981 ret = input_register_device(touch);
1982 if (ret < 0) {
1983 dev_info(ictx->dev, "touchscreen input dev register failed\n");
1984 goto touch_register_failed;
1987 return touch;
1989 touch_register_failed:
1990 input_free_device(touch);
1992 touch_alloc_failed:
1993 return NULL;
1996 static bool imon_find_endpoints(struct imon_context *ictx,
1997 struct usb_host_interface *iface_desc)
1999 struct usb_endpoint_descriptor *ep;
2000 struct usb_endpoint_descriptor *rx_endpoint = NULL;
2001 struct usb_endpoint_descriptor *tx_endpoint = NULL;
2002 int ifnum = iface_desc->desc.bInterfaceNumber;
2003 int num_endpts = iface_desc->desc.bNumEndpoints;
2004 int i, ep_dir, ep_type;
2005 bool ir_ep_found = false;
2006 bool display_ep_found = false;
2007 bool tx_control = false;
2010 * Scan the endpoint list and set:
2011 * first input endpoint = IR endpoint
2012 * first output endpoint = display endpoint
2014 for (i = 0; i < num_endpts && !(ir_ep_found && display_ep_found); ++i) {
2015 ep = &iface_desc->endpoint[i].desc;
2016 ep_dir = ep->bEndpointAddress & USB_ENDPOINT_DIR_MASK;
2017 ep_type = ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
2019 if (!ir_ep_found && ep_dir == USB_DIR_IN &&
2020 ep_type == USB_ENDPOINT_XFER_INT) {
2022 rx_endpoint = ep;
2023 ir_ep_found = true;
2024 dev_dbg(ictx->dev, "%s: found IR endpoint\n", __func__);
2026 } else if (!display_ep_found && ep_dir == USB_DIR_OUT &&
2027 ep_type == USB_ENDPOINT_XFER_INT) {
2028 tx_endpoint = ep;
2029 display_ep_found = true;
2030 dev_dbg(ictx->dev, "%s: found display endpoint\n", __func__);
2034 if (ifnum == 0) {
2035 ictx->rx_endpoint_intf0 = rx_endpoint;
2037 * tx is used to send characters to lcd/vfd, associate RF
2038 * remotes, set IR protocol, and maybe more...
2040 ictx->tx_endpoint = tx_endpoint;
2041 } else {
2042 ictx->rx_endpoint_intf1 = rx_endpoint;
2046 * If we didn't find a display endpoint, this is probably one of the
2047 * newer iMON devices that use control urb instead of interrupt
2049 if (!display_ep_found) {
2050 tx_control = true;
2051 display_ep_found = true;
2052 dev_dbg(ictx->dev, "%s: device uses control endpoint, not "
2053 "interface OUT endpoint\n", __func__);
2057 * Some iMON receivers have no display. Unfortunately, it seems
2058 * that SoundGraph recycles device IDs between devices both with
2059 * and without... :\
2061 if (ictx->display_type == IMON_DISPLAY_TYPE_NONE) {
2062 display_ep_found = false;
2063 dev_dbg(ictx->dev, "%s: device has no display\n", __func__);
2067 * iMON Touch devices have a VGA touchscreen, but no "display", as
2068 * that refers to e.g. /dev/lcd0 (a character device LCD or VFD).
2070 if (ictx->display_type == IMON_DISPLAY_TYPE_VGA) {
2071 display_ep_found = false;
2072 dev_dbg(ictx->dev, "%s: iMON Touch device found\n", __func__);
2075 /* Input endpoint is mandatory */
2076 if (!ir_ep_found)
2077 pr_err("no valid input (IR) endpoint found\n");
2079 ictx->tx_control = tx_control;
2081 if (display_ep_found)
2082 ictx->display_supported = true;
2084 return ir_ep_found;
2088 static struct imon_context *imon_init_intf0(struct usb_interface *intf)
2090 struct imon_context *ictx;
2091 struct urb *rx_urb;
2092 struct urb *tx_urb;
2093 struct device *dev = &intf->dev;
2094 struct usb_host_interface *iface_desc;
2095 int ret = -ENOMEM;
2097 ictx = kzalloc(sizeof(struct imon_context), GFP_KERNEL);
2098 if (!ictx) {
2099 dev_err(dev, "%s: kzalloc failed for context", __func__);
2100 goto exit;
2102 rx_urb = usb_alloc_urb(0, GFP_KERNEL);
2103 if (!rx_urb) {
2104 dev_err(dev, "%s: usb_alloc_urb failed for IR urb", __func__);
2105 goto rx_urb_alloc_failed;
2107 tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2108 if (!tx_urb) {
2109 dev_err(dev, "%s: usb_alloc_urb failed for display urb",
2110 __func__);
2111 goto tx_urb_alloc_failed;
2114 mutex_init(&ictx->lock);
2115 spin_lock_init(&ictx->kc_lock);
2117 mutex_lock(&ictx->lock);
2119 ictx->dev = dev;
2120 ictx->usbdev_intf0 = usb_get_dev(interface_to_usbdev(intf));
2121 ictx->rx_urb_intf0 = rx_urb;
2122 ictx->tx_urb = tx_urb;
2123 ictx->rf_device = false;
2125 ictx->vendor = le16_to_cpu(ictx->usbdev_intf0->descriptor.idVendor);
2126 ictx->product = le16_to_cpu(ictx->usbdev_intf0->descriptor.idProduct);
2128 ret = -ENODEV;
2129 iface_desc = intf->cur_altsetting;
2130 if (!imon_find_endpoints(ictx, iface_desc)) {
2131 goto find_endpoint_failed;
2134 usb_fill_int_urb(ictx->rx_urb_intf0, ictx->usbdev_intf0,
2135 usb_rcvintpipe(ictx->usbdev_intf0,
2136 ictx->rx_endpoint_intf0->bEndpointAddress),
2137 ictx->usb_rx_buf, sizeof(ictx->usb_rx_buf),
2138 usb_rx_callback_intf0, ictx,
2139 ictx->rx_endpoint_intf0->bInterval);
2141 ret = usb_submit_urb(ictx->rx_urb_intf0, GFP_KERNEL);
2142 if (ret) {
2143 pr_err("usb_submit_urb failed for intf0 (%d)\n", ret);
2144 goto urb_submit_failed;
2147 ictx->idev = imon_init_idev(ictx);
2148 if (!ictx->idev) {
2149 dev_err(dev, "%s: input device setup failed\n", __func__);
2150 goto idev_setup_failed;
2153 ictx->rdev = imon_init_rdev(ictx);
2154 if (!ictx->rdev) {
2155 dev_err(dev, "%s: rc device setup failed\n", __func__);
2156 goto rdev_setup_failed;
2159 ictx->dev_present_intf0 = true;
2161 mutex_unlock(&ictx->lock);
2162 return ictx;
2164 rdev_setup_failed:
2165 input_unregister_device(ictx->idev);
2166 idev_setup_failed:
2167 usb_kill_urb(ictx->rx_urb_intf0);
2168 urb_submit_failed:
2169 find_endpoint_failed:
2170 mutex_unlock(&ictx->lock);
2171 usb_free_urb(tx_urb);
2172 tx_urb_alloc_failed:
2173 usb_free_urb(rx_urb);
2174 rx_urb_alloc_failed:
2175 kfree(ictx);
2176 exit:
2177 dev_err(dev, "unable to initialize intf0, err %d\n", ret);
2179 return NULL;
2182 static struct imon_context *imon_init_intf1(struct usb_interface *intf,
2183 struct imon_context *ictx)
2185 struct urb *rx_urb;
2186 struct usb_host_interface *iface_desc;
2187 int ret = -ENOMEM;
2189 rx_urb = usb_alloc_urb(0, GFP_KERNEL);
2190 if (!rx_urb) {
2191 pr_err("usb_alloc_urb failed for IR urb\n");
2192 goto rx_urb_alloc_failed;
2195 mutex_lock(&ictx->lock);
2197 if (ictx->display_type == IMON_DISPLAY_TYPE_VGA) {
2198 init_timer(&ictx->ttimer);
2199 ictx->ttimer.data = (unsigned long)ictx;
2200 ictx->ttimer.function = imon_touch_display_timeout;
2203 ictx->usbdev_intf1 = usb_get_dev(interface_to_usbdev(intf));
2204 ictx->rx_urb_intf1 = rx_urb;
2206 ret = -ENODEV;
2207 iface_desc = intf->cur_altsetting;
2208 if (!imon_find_endpoints(ictx, iface_desc))
2209 goto find_endpoint_failed;
2211 if (ictx->display_type == IMON_DISPLAY_TYPE_VGA) {
2212 ictx->touch = imon_init_touch(ictx);
2213 if (!ictx->touch)
2214 goto touch_setup_failed;
2215 } else
2216 ictx->touch = NULL;
2218 usb_fill_int_urb(ictx->rx_urb_intf1, ictx->usbdev_intf1,
2219 usb_rcvintpipe(ictx->usbdev_intf1,
2220 ictx->rx_endpoint_intf1->bEndpointAddress),
2221 ictx->usb_rx_buf, sizeof(ictx->usb_rx_buf),
2222 usb_rx_callback_intf1, ictx,
2223 ictx->rx_endpoint_intf1->bInterval);
2225 ret = usb_submit_urb(ictx->rx_urb_intf1, GFP_KERNEL);
2227 if (ret) {
2228 pr_err("usb_submit_urb failed for intf1 (%d)\n", ret);
2229 goto urb_submit_failed;
2232 ictx->dev_present_intf1 = true;
2234 mutex_unlock(&ictx->lock);
2235 return ictx;
2237 urb_submit_failed:
2238 if (ictx->touch)
2239 input_unregister_device(ictx->touch);
2240 touch_setup_failed:
2241 find_endpoint_failed:
2242 mutex_unlock(&ictx->lock);
2243 usb_free_urb(rx_urb);
2244 rx_urb_alloc_failed:
2245 dev_err(ictx->dev, "unable to initialize intf0, err %d\n", ret);
2247 return NULL;
2250 static void imon_init_display(struct imon_context *ictx,
2251 struct usb_interface *intf)
2253 int ret;
2255 dev_dbg(ictx->dev, "Registering iMON display with sysfs\n");
2257 /* set up sysfs entry for built-in clock */
2258 ret = sysfs_create_group(&intf->dev.kobj, &imon_display_attr_group);
2259 if (ret)
2260 dev_err(ictx->dev, "Could not create display sysfs "
2261 "entries(%d)", ret);
2263 if (ictx->display_type == IMON_DISPLAY_TYPE_LCD)
2264 ret = usb_register_dev(intf, &imon_lcd_class);
2265 else
2266 ret = usb_register_dev(intf, &imon_vfd_class);
2267 if (ret)
2268 /* Not a fatal error, so ignore */
2269 dev_info(ictx->dev, "could not get a minor number for "
2270 "display\n");
2275 * Callback function for USB core API: Probe
2277 static int __devinit imon_probe(struct usb_interface *interface,
2278 const struct usb_device_id *id)
2280 struct usb_device *usbdev = NULL;
2281 struct usb_host_interface *iface_desc = NULL;
2282 struct usb_interface *first_if;
2283 struct device *dev = &interface->dev;
2284 int ifnum, sysfs_err;
2285 int ret = 0;
2286 struct imon_context *ictx = NULL;
2287 struct imon_context *first_if_ctx = NULL;
2288 u16 vendor, product;
2290 usbdev = usb_get_dev(interface_to_usbdev(interface));
2291 iface_desc = interface->cur_altsetting;
2292 ifnum = iface_desc->desc.bInterfaceNumber;
2293 vendor = le16_to_cpu(usbdev->descriptor.idVendor);
2294 product = le16_to_cpu(usbdev->descriptor.idProduct);
2296 dev_dbg(dev, "%s: found iMON device (%04x:%04x, intf%d)\n",
2297 __func__, vendor, product, ifnum);
2299 /* prevent races probing devices w/multiple interfaces */
2300 mutex_lock(&driver_lock);
2302 first_if = usb_ifnum_to_if(usbdev, 0);
2303 first_if_ctx = usb_get_intfdata(first_if);
2305 if (ifnum == 0) {
2306 ictx = imon_init_intf0(interface);
2307 if (!ictx) {
2308 pr_err("failed to initialize context!\n");
2309 ret = -ENODEV;
2310 goto fail;
2313 } else {
2314 /* this is the secondary interface on the device */
2315 ictx = imon_init_intf1(interface, first_if_ctx);
2316 if (!ictx) {
2317 pr_err("failed to attach to context!\n");
2318 ret = -ENODEV;
2319 goto fail;
2324 usb_set_intfdata(interface, ictx);
2326 if (ifnum == 0) {
2327 mutex_lock(&ictx->lock);
2329 if (product == 0xffdc && ictx->rf_device) {
2330 sysfs_err = sysfs_create_group(&interface->dev.kobj,
2331 &imon_rf_attr_group);
2332 if (sysfs_err)
2333 pr_err("Could not create RF sysfs entries(%d)\n",
2334 sysfs_err);
2337 if (ictx->display_supported)
2338 imon_init_display(ictx, interface);
2340 mutex_unlock(&ictx->lock);
2343 dev_info(dev, "iMON device (%04x:%04x, intf%d) on "
2344 "usb<%d:%d> initialized\n", vendor, product, ifnum,
2345 usbdev->bus->busnum, usbdev->devnum);
2347 mutex_unlock(&driver_lock);
2349 return 0;
2351 fail:
2352 mutex_unlock(&driver_lock);
2353 dev_err(dev, "unable to register, err %d\n", ret);
2355 return ret;
2359 * Callback function for USB core API: disconnect
2361 static void __devexit imon_disconnect(struct usb_interface *interface)
2363 struct imon_context *ictx;
2364 struct device *dev;
2365 int ifnum;
2367 /* prevent races with multi-interface device probing and display_open */
2368 mutex_lock(&driver_lock);
2370 ictx = usb_get_intfdata(interface);
2371 dev = ictx->dev;
2372 ifnum = interface->cur_altsetting->desc.bInterfaceNumber;
2375 * sysfs_remove_group is safe to call even if sysfs_create_group
2376 * hasn't been called
2378 sysfs_remove_group(&interface->dev.kobj, &imon_display_attr_group);
2379 sysfs_remove_group(&interface->dev.kobj, &imon_rf_attr_group);
2381 usb_set_intfdata(interface, NULL);
2383 /* Abort ongoing write */
2384 if (ictx->tx.busy) {
2385 usb_kill_urb(ictx->tx_urb);
2386 complete_all(&ictx->tx.finished);
2389 if (ifnum == 0) {
2390 ictx->dev_present_intf0 = false;
2391 usb_kill_urb(ictx->rx_urb_intf0);
2392 input_unregister_device(ictx->idev);
2393 rc_unregister_device(ictx->rdev);
2394 if (ictx->display_supported) {
2395 if (ictx->display_type == IMON_DISPLAY_TYPE_LCD)
2396 usb_deregister_dev(interface, &imon_lcd_class);
2397 else if (ictx->display_type == IMON_DISPLAY_TYPE_VFD)
2398 usb_deregister_dev(interface, &imon_vfd_class);
2400 } else {
2401 ictx->dev_present_intf1 = false;
2402 usb_kill_urb(ictx->rx_urb_intf1);
2403 if (ictx->display_type == IMON_DISPLAY_TYPE_VGA) {
2404 input_unregister_device(ictx->touch);
2405 del_timer_sync(&ictx->ttimer);
2409 if (!ictx->dev_present_intf0 && !ictx->dev_present_intf1)
2410 free_imon_context(ictx);
2412 mutex_unlock(&driver_lock);
2414 dev_dbg(dev, "%s: iMON device (intf%d) disconnected\n",
2415 __func__, ifnum);
2418 static int imon_suspend(struct usb_interface *intf, pm_message_t message)
2420 struct imon_context *ictx = usb_get_intfdata(intf);
2421 int ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
2423 if (ifnum == 0)
2424 usb_kill_urb(ictx->rx_urb_intf0);
2425 else
2426 usb_kill_urb(ictx->rx_urb_intf1);
2428 return 0;
2431 static int imon_resume(struct usb_interface *intf)
2433 int rc = 0;
2434 struct imon_context *ictx = usb_get_intfdata(intf);
2435 int ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
2437 if (ifnum == 0) {
2438 usb_fill_int_urb(ictx->rx_urb_intf0, ictx->usbdev_intf0,
2439 usb_rcvintpipe(ictx->usbdev_intf0,
2440 ictx->rx_endpoint_intf0->bEndpointAddress),
2441 ictx->usb_rx_buf, sizeof(ictx->usb_rx_buf),
2442 usb_rx_callback_intf0, ictx,
2443 ictx->rx_endpoint_intf0->bInterval);
2445 rc = usb_submit_urb(ictx->rx_urb_intf0, GFP_ATOMIC);
2447 } else {
2448 usb_fill_int_urb(ictx->rx_urb_intf1, ictx->usbdev_intf1,
2449 usb_rcvintpipe(ictx->usbdev_intf1,
2450 ictx->rx_endpoint_intf1->bEndpointAddress),
2451 ictx->usb_rx_buf, sizeof(ictx->usb_rx_buf),
2452 usb_rx_callback_intf1, ictx,
2453 ictx->rx_endpoint_intf1->bInterval);
2455 rc = usb_submit_urb(ictx->rx_urb_intf1, GFP_ATOMIC);
2458 return rc;
2461 module_usb_driver(imon_driver);