1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * imon.c: input and display driver for SoundGraph iMON IR/VFD/LCD
5 * Copyright(C) 2010 Jarod Wilson <jarod@wilsonet.com>
6 * Portions based on the original lirc_imon driver,
7 * Copyright(C) 2004 Venky Raju(dev@venky.ws)
9 * Huge thanks to R. Geoff Newbury for invaluable debugging on the
10 * 0xffdc iMON devices, and for sending me one to hack on, without
11 * which the support for them wouldn't be nearly as good. Thanks
12 * also to the numerous 0xffdc device owners that tested auto-config
13 * support for me and provided debug dumps from their devices.
16 #define pr_fmt(fmt) KBUILD_MODNAME ":%s: " fmt, __func__
18 #include <linux/errno.h>
19 #include <linux/init.h>
20 #include <linux/kernel.h>
21 #include <linux/ktime.h>
22 #include <linux/module.h>
23 #include <linux/slab.h>
24 #include <linux/uaccess.h>
25 #include <linux/ratelimit.h>
27 #include <linux/input.h>
28 #include <linux/usb.h>
29 #include <linux/usb/input.h>
30 #include <media/rc-core.h>
32 #include <linux/timer.h>
34 #define MOD_AUTHOR "Jarod Wilson <jarod@wilsonet.com>"
35 #define MOD_DESC "Driver for SoundGraph iMON MultiMedia IR/Display"
36 #define MOD_NAME "imon"
37 #define MOD_VERSION "0.9.4"
39 #define DISPLAY_MINOR_BASE 144
40 #define DEVICE_NAME "lcd%d"
42 #define BUF_CHUNK_SIZE 8
45 #define BIT_DURATION 250 /* each bit received is 250us */
47 #define IMON_CLOCK_ENABLE_PACKETS 2
49 /*** P R O T O T Y P E S ***/
51 /* USB Callback prototypes */
52 static int imon_probe(struct usb_interface *interface,
53 const struct usb_device_id *id);
54 static void imon_disconnect(struct usb_interface *interface);
55 static void usb_rx_callback_intf0(struct urb *urb);
56 static void usb_rx_callback_intf1(struct urb *urb);
57 static void usb_tx_callback(struct urb *urb);
59 /* suspend/resume support */
60 static int imon_resume(struct usb_interface *intf);
61 static int imon_suspend(struct usb_interface *intf, pm_message_t message);
63 /* Display file_operations function prototypes */
64 static int display_open(struct inode *inode, struct file *file);
65 static int display_close(struct inode *inode, struct file *file);
67 /* VFD write operation */
68 static ssize_t vfd_write(struct file *file, const char __user *buf,
69 size_t n_bytes, loff_t *pos);
71 /* LCD file_operations override function prototypes */
72 static ssize_t lcd_write(struct file *file, const char __user *buf,
73 size_t n_bytes, loff_t *pos);
75 /*** G L O B A L S ***/
77 struct imon_panel_key_table {
82 struct imon_usb_dev_descr {
84 #define IMON_NO_FLAGS 0
85 #define IMON_NEED_20MS_PKT_DELAY 1
86 #define IMON_SUPPRESS_REPEATED_KEYS 2
87 struct imon_panel_key_table key_table[];
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;
113 unsigned char usb_rx_buf[8];
114 unsigned char usb_tx_buf[8];
115 unsigned int send_packet_delay;
118 unsigned char data_buf[35]; /* user data buffer */
119 struct completion finished; /* wait for write to finish */
120 bool busy; /* write in progress */
121 int status; /* status of tx completion */
124 u16 vendor; /* usb vendor ID */
125 u16 product; /* usb product ID */
127 struct rc_dev *rdev; /* rc-core device for remote */
128 struct input_dev *idev; /* input device for panel & IR mouse */
129 struct input_dev *touch; /* input device for touchscreen */
131 spinlock_t kc_lock; /* make sure we get keycodes right */
132 u32 kc; /* current input keycode */
133 u32 last_keycode; /* last reported input keycode */
134 u32 rc_scancode; /* the computed remote scancode */
135 u8 rc_toggle; /* the computed remote toggle bit */
136 u64 rc_proto; /* iMON or MCE (RC6) IR protocol? */
137 bool release_code; /* some keys send a release code */
139 u8 display_type; /* store the display type */
140 bool pad_mouse; /* toggle kbd(0)/mouse(1) mode */
142 char name_rdev[128]; /* rc input device name */
143 char phys_rdev[64]; /* rc input device phys path */
145 char name_idev[128]; /* input device name */
146 char phys_idev[64]; /* input device phys path */
148 char name_touch[128]; /* touch screen name */
149 char phys_touch[64]; /* touch screen phys path */
150 struct timer_list ttimer; /* touch screen timer */
151 int touch_x; /* x coordinate on touchscreen */
152 int touch_y; /* y coordinate on touchscreen */
153 const struct imon_usb_dev_descr *dev_descr;
154 /* device description with key */
155 /* table for front panels */
157 * Fields for deferring free_imon_context().
159 * Since reference to "struct imon_context" is stored into
160 * "struct file"->private_data, we need to remember
161 * how many file descriptors might access this "struct imon_context".
165 * Use a flag for telling display_open()/vfd_write()/lcd_write() that
166 * imon_disconnect() was already called.
170 * We need to wait for RCU grace period in order to allow
171 * display_open() to safely check ->disconnected and increment ->users.
176 #define TOUCH_TIMEOUT (HZ/30)
178 /* vfd character device file operations */
179 static const struct file_operations vfd_fops = {
180 .owner = THIS_MODULE,
181 .open = display_open,
183 .release = display_close,
184 .llseek = noop_llseek,
187 /* lcd character device file operations */
188 static const struct file_operations lcd_fops = {
189 .owner = THIS_MODULE,
190 .open = display_open,
192 .release = display_close,
193 .llseek = noop_llseek,
197 IMON_DISPLAY_TYPE_AUTO = 0,
198 IMON_DISPLAY_TYPE_VFD = 1,
199 IMON_DISPLAY_TYPE_LCD = 2,
200 IMON_DISPLAY_TYPE_VGA = 3,
201 IMON_DISPLAY_TYPE_NONE = 4,
210 static struct usb_class_driver imon_vfd_class = {
213 .minor_base = DISPLAY_MINOR_BASE,
216 static struct usb_class_driver imon_lcd_class = {
219 .minor_base = DISPLAY_MINOR_BASE,
222 /* imon receiver front panel/knob key table */
223 static const struct imon_usb_dev_descr imon_default_table = {
224 .flags = IMON_NO_FLAGS,
226 { 0x000000000f00ffeell, KEY_MEDIA }, /* Go */
227 { 0x000000001200ffeell, KEY_UP },
228 { 0x000000001300ffeell, KEY_DOWN },
229 { 0x000000001400ffeell, KEY_LEFT },
230 { 0x000000001500ffeell, KEY_RIGHT },
231 { 0x000000001600ffeell, KEY_ENTER },
232 { 0x000000001700ffeell, KEY_ESC },
233 { 0x000000001f00ffeell, KEY_AUDIO },
234 { 0x000000002000ffeell, KEY_VIDEO },
235 { 0x000000002100ffeell, KEY_CAMERA },
236 { 0x000000002700ffeell, KEY_DVD },
237 { 0x000000002300ffeell, KEY_TV },
238 { 0x000000002b00ffeell, KEY_EXIT },
239 { 0x000000002c00ffeell, KEY_SELECT },
240 { 0x000000002d00ffeell, KEY_MENU },
241 { 0x000000000500ffeell, KEY_PREVIOUS },
242 { 0x000000000700ffeell, KEY_REWIND },
243 { 0x000000000400ffeell, KEY_STOP },
244 { 0x000000003c00ffeell, KEY_PLAYPAUSE },
245 { 0x000000000800ffeell, KEY_FASTFORWARD },
246 { 0x000000000600ffeell, KEY_NEXT },
247 { 0x000000010000ffeell, KEY_RIGHT },
248 { 0x000001000000ffeell, KEY_LEFT },
249 { 0x000000003d00ffeell, KEY_SELECT },
250 { 0x000100000000ffeell, KEY_VOLUMEUP },
251 { 0x010000000000ffeell, KEY_VOLUMEDOWN },
252 { 0x000000000100ffeell, KEY_MUTE },
253 /* 0xffdc iMON MCE VFD */
254 { 0x00010000ffffffeell, KEY_VOLUMEUP },
255 { 0x01000000ffffffeell, KEY_VOLUMEDOWN },
256 { 0x00000001ffffffeell, KEY_MUTE },
257 { 0x0000000fffffffeell, KEY_MEDIA },
258 { 0x00000012ffffffeell, KEY_UP },
259 { 0x00000013ffffffeell, KEY_DOWN },
260 { 0x00000014ffffffeell, KEY_LEFT },
261 { 0x00000015ffffffeell, KEY_RIGHT },
262 { 0x00000016ffffffeell, KEY_ENTER },
263 { 0x00000017ffffffeell, KEY_ESC },
264 /* iMON Knob values */
265 { 0x000100ffffffffeell, KEY_VOLUMEUP },
266 { 0x010000ffffffffeell, KEY_VOLUMEDOWN },
267 { 0x000008ffffffffeell, KEY_MUTE },
272 static const struct imon_usb_dev_descr imon_OEM_VFD = {
273 .flags = IMON_NEED_20MS_PKT_DELAY,
275 { 0x000000000f00ffeell, KEY_MEDIA }, /* Go */
276 { 0x000000001200ffeell, KEY_UP },
277 { 0x000000001300ffeell, KEY_DOWN },
278 { 0x000000001400ffeell, KEY_LEFT },
279 { 0x000000001500ffeell, KEY_RIGHT },
280 { 0x000000001600ffeell, KEY_ENTER },
281 { 0x000000001700ffeell, KEY_ESC },
282 { 0x000000001f00ffeell, KEY_AUDIO },
283 { 0x000000002b00ffeell, KEY_EXIT },
284 { 0x000000002c00ffeell, KEY_SELECT },
285 { 0x000000002d00ffeell, KEY_MENU },
286 { 0x000000000500ffeell, KEY_PREVIOUS },
287 { 0x000000000700ffeell, KEY_REWIND },
288 { 0x000000000400ffeell, KEY_STOP },
289 { 0x000000003c00ffeell, KEY_PLAYPAUSE },
290 { 0x000000000800ffeell, KEY_FASTFORWARD },
291 { 0x000000000600ffeell, KEY_NEXT },
292 { 0x000000010000ffeell, KEY_RIGHT },
293 { 0x000001000000ffeell, KEY_LEFT },
294 { 0x000000003d00ffeell, KEY_SELECT },
295 { 0x000100000000ffeell, KEY_VOLUMEUP },
296 { 0x010000000000ffeell, KEY_VOLUMEDOWN },
297 { 0x000000000100ffeell, KEY_MUTE },
298 /* 0xffdc iMON MCE VFD */
299 { 0x00010000ffffffeell, KEY_VOLUMEUP },
300 { 0x01000000ffffffeell, KEY_VOLUMEDOWN },
301 { 0x00000001ffffffeell, KEY_MUTE },
302 { 0x0000000fffffffeell, KEY_MEDIA },
303 { 0x00000012ffffffeell, KEY_UP },
304 { 0x00000013ffffffeell, KEY_DOWN },
305 { 0x00000014ffffffeell, KEY_LEFT },
306 { 0x00000015ffffffeell, KEY_RIGHT },
307 { 0x00000016ffffffeell, KEY_ENTER },
308 { 0x00000017ffffffeell, KEY_ESC },
309 /* iMON Knob values */
310 { 0x000100ffffffffeell, KEY_VOLUMEUP },
311 { 0x010000ffffffffeell, KEY_VOLUMEDOWN },
312 { 0x000008ffffffffeell, KEY_MUTE },
317 /* imon receiver front panel/knob key table for DH102*/
318 static const struct imon_usb_dev_descr imon_DH102 = {
319 .flags = IMON_NO_FLAGS,
321 { 0x000100000000ffeell, KEY_VOLUMEUP },
322 { 0x010000000000ffeell, KEY_VOLUMEDOWN },
323 { 0x000000010000ffeell, KEY_MUTE },
324 { 0x0000000f0000ffeell, KEY_MEDIA },
325 { 0x000000120000ffeell, KEY_UP },
326 { 0x000000130000ffeell, KEY_DOWN },
327 { 0x000000140000ffeell, KEY_LEFT },
328 { 0x000000150000ffeell, KEY_RIGHT },
329 { 0x000000160000ffeell, KEY_ENTER },
330 { 0x000000170000ffeell, KEY_ESC },
331 { 0x0000002b0000ffeell, KEY_EXIT },
332 { 0x0000002c0000ffeell, KEY_SELECT },
333 { 0x0000002d0000ffeell, KEY_MENU },
338 /* imon ultrabay front panel key table */
339 static const struct imon_usb_dev_descr ultrabay_table = {
340 .flags = IMON_SUPPRESS_REPEATED_KEYS,
342 { 0x0000000f0000ffeell, KEY_MEDIA }, /* Go */
343 { 0x000000000100ffeell, KEY_UP },
344 { 0x000000000001ffeell, KEY_DOWN },
345 { 0x000000160000ffeell, KEY_ENTER },
346 { 0x0000001f0000ffeell, KEY_AUDIO }, /* Music */
347 { 0x000000200000ffeell, KEY_VIDEO }, /* Movie */
348 { 0x000000210000ffeell, KEY_CAMERA }, /* Photo */
349 { 0x000000270000ffeell, KEY_DVD }, /* DVD */
350 { 0x000000230000ffeell, KEY_TV }, /* TV */
351 { 0x000000050000ffeell, KEY_PREVIOUS }, /* Previous */
352 { 0x000000070000ffeell, KEY_REWIND },
353 { 0x000000040000ffeell, KEY_STOP },
354 { 0x000000020000ffeell, KEY_PLAYPAUSE },
355 { 0x000000080000ffeell, KEY_FASTFORWARD },
356 { 0x000000060000ffeell, KEY_NEXT }, /* Next */
357 { 0x000100000000ffeell, KEY_VOLUMEUP },
358 { 0x010000000000ffeell, KEY_VOLUMEDOWN },
359 { 0x000000010000ffeell, KEY_MUTE },
365 * USB Device ID for iMON USB Control Boards
367 * The Windows drivers contain 6 different inf files, more or less one for
368 * each new device until the 0x0034-0x0046 devices, which all use the same
369 * driver. Some of the devices in the 34-46 range haven't been definitively
370 * identified yet. Early devices have either a TriGem Computer, Inc. or a
371 * Samsung vendor ID (0x0aa8 and 0x04e8 respectively), while all later
372 * devices use the SoundGraph vendor ID (0x15c2). This driver only supports
373 * the ffdc and later devices, which do onboard decoding.
375 static const struct usb_device_id imon_usb_id_table[] = {
377 * Several devices with this same device ID, all use iMON_PAD.inf
378 * SoundGraph iMON PAD (IR & VFD)
379 * SoundGraph iMON PAD (IR & LCD)
380 * SoundGraph iMON Knob (IR only)
382 { USB_DEVICE(0x15c2, 0xffdc),
383 .driver_info = (unsigned long)&imon_default_table },
386 * Newer devices, all driven by the latest iMON Windows driver, full
387 * list of device IDs extracted via 'strings Setup/data1.hdr |grep 15c2'
388 * Need user input to fill in details on unknown devices.
390 /* SoundGraph iMON OEM Touch LCD (IR & 7" VGA LCD) */
391 { USB_DEVICE(0x15c2, 0x0034),
392 .driver_info = (unsigned long)&imon_DH102 },
393 /* SoundGraph iMON OEM Touch LCD (IR & 4.3" VGA LCD) */
394 { USB_DEVICE(0x15c2, 0x0035),
395 .driver_info = (unsigned long)&imon_default_table},
396 /* SoundGraph iMON OEM VFD (IR & VFD) */
397 { USB_DEVICE(0x15c2, 0x0036),
398 .driver_info = (unsigned long)&imon_OEM_VFD },
399 /* device specifics unknown */
400 { USB_DEVICE(0x15c2, 0x0037),
401 .driver_info = (unsigned long)&imon_default_table},
402 /* SoundGraph iMON OEM LCD (IR & LCD) */
403 { USB_DEVICE(0x15c2, 0x0038),
404 .driver_info = (unsigned long)&imon_default_table},
405 /* SoundGraph iMON UltraBay (IR & LCD) */
406 { USB_DEVICE(0x15c2, 0x0039),
407 .driver_info = (unsigned long)&imon_default_table},
408 /* device specifics unknown */
409 { USB_DEVICE(0x15c2, 0x003a),
410 .driver_info = (unsigned long)&imon_default_table},
411 /* device specifics unknown */
412 { USB_DEVICE(0x15c2, 0x003b),
413 .driver_info = (unsigned long)&imon_default_table},
414 /* SoundGraph iMON OEM Inside (IR only) */
415 { USB_DEVICE(0x15c2, 0x003c),
416 .driver_info = (unsigned long)&imon_default_table},
417 /* device specifics unknown */
418 { USB_DEVICE(0x15c2, 0x003d),
419 .driver_info = (unsigned long)&imon_default_table},
420 /* device specifics unknown */
421 { USB_DEVICE(0x15c2, 0x003e),
422 .driver_info = (unsigned long)&imon_default_table},
423 /* device specifics unknown */
424 { USB_DEVICE(0x15c2, 0x003f),
425 .driver_info = (unsigned long)&imon_default_table},
426 /* device specifics unknown */
427 { USB_DEVICE(0x15c2, 0x0040),
428 .driver_info = (unsigned long)&imon_default_table},
429 /* SoundGraph iMON MINI (IR only) */
430 { USB_DEVICE(0x15c2, 0x0041),
431 .driver_info = (unsigned long)&imon_default_table},
432 /* Antec Veris Multimedia Station EZ External (IR only) */
433 { USB_DEVICE(0x15c2, 0x0042),
434 .driver_info = (unsigned long)&imon_default_table},
435 /* Antec Veris Multimedia Station Basic Internal (IR only) */
436 { USB_DEVICE(0x15c2, 0x0043),
437 .driver_info = (unsigned long)&imon_default_table},
438 /* Antec Veris Multimedia Station Elite (IR & VFD) */
439 { USB_DEVICE(0x15c2, 0x0044),
440 .driver_info = (unsigned long)&imon_default_table},
441 /* Antec Veris Multimedia Station Premiere (IR & LCD) */
442 { USB_DEVICE(0x15c2, 0x0045),
443 .driver_info = (unsigned long)&imon_default_table},
444 /* device specifics unknown */
445 { USB_DEVICE(0x15c2, 0x0046),
446 .driver_info = (unsigned long)&imon_default_table},
450 /* USB Device data */
451 static struct usb_driver imon_driver = {
454 .disconnect = imon_disconnect,
455 .suspend = imon_suspend,
456 .resume = imon_resume,
457 .id_table = imon_usb_id_table,
460 /* Module bookkeeping bits */
461 MODULE_AUTHOR(MOD_AUTHOR);
462 MODULE_DESCRIPTION(MOD_DESC);
463 MODULE_VERSION(MOD_VERSION);
464 MODULE_LICENSE("GPL");
465 MODULE_DEVICE_TABLE(usb, imon_usb_id_table);
468 module_param(debug, bool, S_IRUGO | S_IWUSR);
469 MODULE_PARM_DESC(debug, "Debug messages: 0=no, 1=yes (default: no)");
471 /* lcd, vfd, vga or none? should be auto-detected, but can be overridden... */
472 static int display_type;
473 module_param(display_type, int, S_IRUGO);
474 MODULE_PARM_DESC(display_type, "Type of attached display. 0=autodetect, 1=vfd, 2=lcd, 3=vga, 4=none (default: autodetect)");
476 static int pad_stabilize = 1;
477 module_param(pad_stabilize, int, S_IRUGO | S_IWUSR);
478 MODULE_PARM_DESC(pad_stabilize, "Apply stabilization algorithm to iMON PAD presses in arrow key mode. 0=disable, 1=enable (default).");
481 * In certain use cases, mouse mode isn't really helpful, and could actually
482 * cause confusion, so allow disabling it when the IR device is open.
485 module_param(nomouse, bool, S_IRUGO | S_IWUSR);
486 MODULE_PARM_DESC(nomouse, "Disable mouse input device mode when IR device is open. 0=don't disable, 1=disable. (default: don't disable)");
488 /* threshold at which a pad push registers as an arrow key in kbd mode */
489 static int pad_thresh;
490 module_param(pad_thresh, int, S_IRUGO | S_IWUSR);
491 MODULE_PARM_DESC(pad_thresh, "Threshold at which a pad push registers as an arrow key in kbd mode (default: 28)");
494 static void free_imon_context(struct imon_context *ictx)
496 struct device *dev = ictx->dev;
498 usb_free_urb(ictx->tx_urb);
499 WARN_ON(ictx->dev_present_intf0);
500 usb_free_urb(ictx->rx_urb_intf0);
501 WARN_ON(ictx->dev_present_intf1);
502 usb_free_urb(ictx->rx_urb_intf1);
503 kfree_rcu(ictx, rcu);
505 dev_dbg(dev, "%s: iMON context freed\n", __func__);
509 * Called when the Display device (e.g. /dev/lcd0)
510 * is opened by the application.
512 static int display_open(struct inode *inode, struct file *file)
514 struct usb_interface *interface;
515 struct imon_context *ictx = NULL;
519 subminor = iminor(inode);
520 interface = usb_find_interface(&imon_driver, subminor);
522 pr_err("could not find interface for minor %d\n", subminor);
528 ictx = usb_get_intfdata(interface);
529 if (!ictx || ictx->disconnected || !refcount_inc_not_zero(&ictx->users)) {
531 pr_err("no context found for minor %d\n", subminor);
537 mutex_lock(&ictx->lock);
539 if (!ictx->display_supported) {
540 pr_err("display not supported by device\n");
542 } else if (ictx->display_isopen) {
543 pr_err("display port is already open\n");
546 ictx->display_isopen = true;
547 file->private_data = ictx;
548 dev_dbg(ictx->dev, "display port opened\n");
551 mutex_unlock(&ictx->lock);
553 if (retval && refcount_dec_and_test(&ictx->users))
554 free_imon_context(ictx);
561 * Called when the display device (e.g. /dev/lcd0)
562 * is closed by the application.
564 static int display_close(struct inode *inode, struct file *file)
566 struct imon_context *ictx = file->private_data;
569 mutex_lock(&ictx->lock);
571 if (!ictx->display_supported) {
572 pr_err("display not supported by device\n");
574 } else if (!ictx->display_isopen) {
575 pr_err("display is not open\n");
578 ictx->display_isopen = false;
579 dev_dbg(ictx->dev, "display port closed\n");
582 mutex_unlock(&ictx->lock);
583 if (refcount_dec_and_test(&ictx->users))
584 free_imon_context(ictx);
589 * Sends a packet to the device -- this function must be called with
590 * ictx->lock held, or its unlock/lock sequence while waiting for tx
591 * to complete can/will lead to a deadlock.
593 static int send_packet(struct imon_context *ictx)
596 unsigned long timeout;
599 struct usb_ctrlrequest *control_req = NULL;
601 /* Check if we need to use control or interrupt urb */
602 if (!ictx->tx_control) {
603 pipe = usb_sndintpipe(ictx->usbdev_intf0,
604 ictx->tx_endpoint->bEndpointAddress);
605 interval = ictx->tx_endpoint->bInterval;
607 usb_fill_int_urb(ictx->tx_urb, ictx->usbdev_intf0, pipe,
609 sizeof(ictx->usb_tx_buf),
610 usb_tx_callback, ictx, interval);
612 ictx->tx_urb->actual_length = 0;
614 /* fill request into kmalloc'ed space: */
615 control_req = kmalloc(sizeof(*control_req), GFP_KERNEL);
616 if (control_req == NULL)
619 /* setup packet is '21 09 0200 0001 0008' */
620 control_req->bRequestType = 0x21;
621 control_req->bRequest = 0x09;
622 control_req->wValue = cpu_to_le16(0x0200);
623 control_req->wIndex = cpu_to_le16(0x0001);
624 control_req->wLength = cpu_to_le16(0x0008);
626 /* control pipe is endpoint 0x00 */
627 pipe = usb_sndctrlpipe(ictx->usbdev_intf0, 0);
629 /* build the control urb */
630 usb_fill_control_urb(ictx->tx_urb, ictx->usbdev_intf0,
631 pipe, (unsigned char *)control_req,
633 sizeof(ictx->usb_tx_buf),
634 usb_tx_callback, ictx);
635 ictx->tx_urb->actual_length = 0;
638 reinit_completion(&ictx->tx.finished);
639 ictx->tx.busy = true;
640 smp_rmb(); /* ensure later readers know we're busy */
642 retval = usb_submit_urb(ictx->tx_urb, GFP_KERNEL);
644 ictx->tx.busy = false;
645 smp_rmb(); /* ensure later readers know we're not busy */
646 pr_err_ratelimited("error submitting urb(%d)\n", retval);
648 /* Wait for transmission to complete (or abort) */
649 retval = wait_for_completion_interruptible(
652 usb_kill_urb(ictx->tx_urb);
653 pr_err_ratelimited("task interrupted\n");
656 ictx->tx.busy = false;
657 retval = ictx->tx.status;
659 pr_err_ratelimited("packet tx failed (%d)\n", retval);
665 * Induce a mandatory delay before returning, as otherwise,
666 * send_packet can get called so rapidly as to overwhelm the device,
667 * particularly on faster systems and/or those with quirky usb.
669 timeout = msecs_to_jiffies(ictx->send_packet_delay);
670 set_current_state(TASK_INTERRUPTIBLE);
671 schedule_timeout(timeout);
677 * Sends an associate packet to the iMON 2.4G.
679 * This might not be such a good idea, since it has an id collision with
680 * some versions of the "IR & VFD" combo. The only way to determine if it
681 * is an RF version is to look at the product description string. (Which
682 * we currently do not fetch).
684 static int send_associate_24g(struct imon_context *ictx)
687 const unsigned char packet[8] = { 0x01, 0x00, 0x00, 0x00,
688 0x00, 0x00, 0x00, 0x20 };
691 pr_err("no context for device\n");
695 if (!ictx->dev_present_intf0) {
696 pr_err("no iMON device present\n");
700 memcpy(ictx->usb_tx_buf, packet, sizeof(packet));
701 retval = send_packet(ictx);
707 * Sends packets to setup and show clock on iMON display
709 * Arguments: year - last 2 digits of year, month - 1..12,
710 * day - 1..31, dow - day of the week (0-Sun...6-Sat),
711 * hour - 0..23, minute - 0..59, second - 0..59
713 static int send_set_imon_clock(struct imon_context *ictx,
714 unsigned int year, unsigned int month,
715 unsigned int day, unsigned int dow,
716 unsigned int hour, unsigned int minute,
719 unsigned char clock_enable_pkt[IMON_CLOCK_ENABLE_PACKETS][8];
724 pr_err("no context for device\n");
728 switch (ictx->display_type) {
729 case IMON_DISPLAY_TYPE_LCD:
730 clock_enable_pkt[0][0] = 0x80;
731 clock_enable_pkt[0][1] = year;
732 clock_enable_pkt[0][2] = month-1;
733 clock_enable_pkt[0][3] = day;
734 clock_enable_pkt[0][4] = hour;
735 clock_enable_pkt[0][5] = minute;
736 clock_enable_pkt[0][6] = second;
738 clock_enable_pkt[1][0] = 0x80;
739 clock_enable_pkt[1][1] = 0;
740 clock_enable_pkt[1][2] = 0;
741 clock_enable_pkt[1][3] = 0;
742 clock_enable_pkt[1][4] = 0;
743 clock_enable_pkt[1][5] = 0;
744 clock_enable_pkt[1][6] = 0;
746 if (ictx->product == 0xffdc) {
747 clock_enable_pkt[0][7] = 0x50;
748 clock_enable_pkt[1][7] = 0x51;
750 clock_enable_pkt[0][7] = 0x88;
751 clock_enable_pkt[1][7] = 0x8a;
756 case IMON_DISPLAY_TYPE_VFD:
757 clock_enable_pkt[0][0] = year;
758 clock_enable_pkt[0][1] = month-1;
759 clock_enable_pkt[0][2] = day;
760 clock_enable_pkt[0][3] = dow;
761 clock_enable_pkt[0][4] = hour;
762 clock_enable_pkt[0][5] = minute;
763 clock_enable_pkt[0][6] = second;
764 clock_enable_pkt[0][7] = 0x40;
766 clock_enable_pkt[1][0] = 0;
767 clock_enable_pkt[1][1] = 0;
768 clock_enable_pkt[1][2] = 1;
769 clock_enable_pkt[1][3] = 0;
770 clock_enable_pkt[1][4] = 0;
771 clock_enable_pkt[1][5] = 0;
772 clock_enable_pkt[1][6] = 0;
773 clock_enable_pkt[1][7] = 0x42;
781 for (i = 0; i < IMON_CLOCK_ENABLE_PACKETS; i++) {
782 memcpy(ictx->usb_tx_buf, clock_enable_pkt[i], 8);
783 retval = send_packet(ictx);
785 pr_err("send_packet failed for packet %d\n", i);
794 * These are the sysfs functions to handle the association on the iMON 2.4G LT.
796 static ssize_t show_associate_remote(struct device *d,
797 struct device_attribute *attr,
800 struct imon_context *ictx = dev_get_drvdata(d);
805 mutex_lock(&ictx->lock);
806 if (ictx->rf_isassociating)
807 strscpy(buf, "associating\n", PAGE_SIZE);
809 strscpy(buf, "closed\n", PAGE_SIZE);
811 dev_info(d, "Visit https://www.lirc.org/html/imon-24g.html for instructions on how to associate your iMON 2.4G DT/LT remote\n");
812 mutex_unlock(&ictx->lock);
816 static ssize_t store_associate_remote(struct device *d,
817 struct device_attribute *attr,
818 const char *buf, size_t count)
820 struct imon_context *ictx;
822 ictx = dev_get_drvdata(d);
827 mutex_lock(&ictx->lock);
828 ictx->rf_isassociating = true;
829 send_associate_24g(ictx);
830 mutex_unlock(&ictx->lock);
836 * sysfs functions to control internal imon clock
838 static ssize_t show_imon_clock(struct device *d,
839 struct device_attribute *attr, char *buf)
841 struct imon_context *ictx = dev_get_drvdata(d);
847 mutex_lock(&ictx->lock);
849 if (!ictx->display_supported) {
850 len = snprintf(buf, PAGE_SIZE, "Not supported.");
852 len = snprintf(buf, PAGE_SIZE,
853 "To set the clock on your iMON display:\n"
854 "# date \"+%%y %%m %%d %%w %%H %%M %%S\" > imon_clock\n"
855 "%s", ictx->display_isopen ?
856 "\nNOTE: imon device must be closed\n" : "");
859 mutex_unlock(&ictx->lock);
864 static ssize_t store_imon_clock(struct device *d,
865 struct device_attribute *attr,
866 const char *buf, size_t count)
868 struct imon_context *ictx = dev_get_drvdata(d);
870 unsigned int year, month, day, dow, hour, minute, second;
875 mutex_lock(&ictx->lock);
877 if (!ictx->display_supported) {
880 } else if (ictx->display_isopen) {
885 if (sscanf(buf, "%u %u %u %u %u %u %u", &year, &month, &day, &dow,
886 &hour, &minute, &second) != 7) {
891 if ((month < 1 || month > 12) ||
892 (day < 1 || day > 31) || (dow > 6) ||
893 (hour > 23) || (minute > 59) || (second > 59)) {
898 retval = send_set_imon_clock(ictx, year, month, day, dow,
899 hour, minute, second);
905 mutex_unlock(&ictx->lock);
911 static DEVICE_ATTR(imon_clock, S_IWUSR | S_IRUGO, show_imon_clock,
914 static DEVICE_ATTR(associate_remote, S_IWUSR | S_IRUGO, show_associate_remote,
915 store_associate_remote);
917 static struct attribute *imon_display_sysfs_entries[] = {
918 &dev_attr_imon_clock.attr,
922 static const struct attribute_group imon_display_attr_group = {
923 .attrs = imon_display_sysfs_entries
926 static struct attribute *imon_rf_sysfs_entries[] = {
927 &dev_attr_associate_remote.attr,
931 static const struct attribute_group imon_rf_attr_group = {
932 .attrs = imon_rf_sysfs_entries
936 * Writes data to the VFD. The iMON VFD is 2x16 characters
937 * and requires data in 5 consecutive USB interrupt packets,
938 * each packet but the last carrying 7 bytes.
940 * I don't know if the VFD board supports features such as
941 * scrolling, clearing rows, blanking, etc. so at
942 * the caller must provide a full screen of data. If fewer
943 * than 32 bytes are provided spaces will be appended to
944 * generate a full screen.
946 static ssize_t vfd_write(struct file *file, const char __user *buf,
947 size_t n_bytes, loff_t *pos)
953 struct imon_context *ictx = file->private_data;
954 static const unsigned char vfd_packet6[] = {
955 0x01, 0x00, 0x00, 0x00, 0x00, 0xFF, 0xFF };
957 if (ictx->disconnected)
960 if (mutex_lock_interruptible(&ictx->lock))
963 if (!ictx->dev_present_intf0) {
964 pr_err_ratelimited("no iMON device present\n");
969 if (n_bytes <= 0 || n_bytes > 32) {
970 pr_err_ratelimited("invalid payload size\n");
975 if (copy_from_user(ictx->tx.data_buf, buf, n_bytes)) {
980 /* Pad with spaces */
981 for (i = n_bytes; i < 32; ++i)
982 ictx->tx.data_buf[i] = ' ';
984 for (i = 32; i < 35; ++i)
985 ictx->tx.data_buf[i] = 0xFF;
991 memcpy(ictx->usb_tx_buf, ictx->tx.data_buf + offset, 7);
992 ictx->usb_tx_buf[7] = (unsigned char) seq;
994 retval = send_packet(ictx);
996 pr_err_ratelimited("send packet #%d failed\n", seq / 2);
1003 } while (offset < 35);
1005 /* Send packet #6 */
1006 memcpy(ictx->usb_tx_buf, &vfd_packet6, sizeof(vfd_packet6));
1007 ictx->usb_tx_buf[7] = (unsigned char) seq;
1008 retval = send_packet(ictx);
1010 pr_err_ratelimited("send packet #%d failed\n", seq / 2);
1013 mutex_unlock(&ictx->lock);
1015 return (!retval) ? n_bytes : retval;
1019 * Writes data to the LCD. The iMON OEM LCD screen expects 8-byte
1020 * packets. We accept data as 16 hexadecimal digits, followed by a
1021 * newline (to make it easy to drive the device from a command-line
1022 * -- even though the actual binary data is a bit complicated).
1024 * The device itself is not a "traditional" text-mode display. It's
1025 * actually a 16x96 pixel bitmap display. That means if you want to
1026 * display text, you've got to have your own "font" and translate the
1027 * text into bitmaps for display. This is really flexible (you can
1028 * display whatever diacritics you need, and so on), but it's also
1029 * a lot more complicated than most LCDs...
1031 static ssize_t lcd_write(struct file *file, const char __user *buf,
1032 size_t n_bytes, loff_t *pos)
1035 struct imon_context *ictx = file->private_data;
1037 if (ictx->disconnected)
1040 mutex_lock(&ictx->lock);
1042 if (!ictx->display_supported) {
1043 pr_err_ratelimited("no iMON display present\n");
1049 pr_err_ratelimited("invalid payload size: %d (expected 8)\n",
1055 if (copy_from_user(ictx->usb_tx_buf, buf, 8)) {
1060 retval = send_packet(ictx);
1062 pr_err_ratelimited("send packet failed!\n");
1065 dev_dbg(ictx->dev, "%s: write %d bytes to LCD\n",
1066 __func__, (int) n_bytes);
1069 mutex_unlock(&ictx->lock);
1070 return (!retval) ? n_bytes : retval;
1074 * Callback function for USB core API: transmit data
1076 static void usb_tx_callback(struct urb *urb)
1078 struct imon_context *ictx;
1082 ictx = (struct imon_context *)urb->context;
1086 ictx->tx.status = urb->status;
1088 /* notify waiters that write has finished */
1089 ictx->tx.busy = false;
1090 smp_rmb(); /* ensure later readers know we're not busy */
1091 complete(&ictx->tx.finished);
1095 * report touchscreen input
1097 static void imon_touch_display_timeout(struct timer_list *t)
1099 struct imon_context *ictx = from_timer(ictx, t, ttimer);
1101 if (ictx->display_type != IMON_DISPLAY_TYPE_VGA)
1104 input_report_abs(ictx->touch, ABS_X, ictx->touch_x);
1105 input_report_abs(ictx->touch, ABS_Y, ictx->touch_y);
1106 input_report_key(ictx->touch, BTN_TOUCH, 0x00);
1107 input_sync(ictx->touch);
1111 * iMON IR receivers support two different signal sets -- those used by
1112 * the iMON remotes, and those used by the Windows MCE remotes (which is
1113 * really just RC-6), but only one or the other at a time, as the signals
1114 * are decoded onboard the receiver.
1116 * This function gets called two different ways, one way is from
1117 * rc_register_device, for initial protocol selection/setup, and the other is
1118 * via a userspace-initiated protocol change request, either by direct sysfs
1119 * prodding or by something like ir-keytable. In the rc_register_device case,
1120 * the imon context lock is already held, but when initiated from userspace,
1121 * it is not, so we must acquire it prior to calling send_packet, which
1122 * requires that the lock is held.
1124 static int imon_ir_change_protocol(struct rc_dev *rc, u64 *rc_proto)
1127 struct imon_context *ictx = rc->priv;
1128 struct device *dev = ictx->dev;
1129 bool unlock = false;
1130 unsigned char ir_proto_packet[] = {
1131 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x86 };
1133 if (*rc_proto && !(*rc_proto & rc->allowed_protocols))
1134 dev_warn(dev, "Looks like you're trying to use an IR protocol this device does not support\n");
1136 if (*rc_proto & RC_PROTO_BIT_RC6_MCE) {
1137 dev_dbg(dev, "Configuring IR receiver for MCE protocol\n");
1138 ir_proto_packet[0] = 0x01;
1139 *rc_proto = RC_PROTO_BIT_RC6_MCE;
1140 } else if (*rc_proto & RC_PROTO_BIT_IMON) {
1141 dev_dbg(dev, "Configuring IR receiver for iMON protocol\n");
1143 dev_dbg(dev, "PAD stabilize functionality disabled\n");
1144 /* ir_proto_packet[0] = 0x00; // already the default */
1145 *rc_proto = RC_PROTO_BIT_IMON;
1147 dev_warn(dev, "Unsupported IR protocol specified, overriding to iMON IR protocol\n");
1149 dev_dbg(dev, "PAD stabilize functionality disabled\n");
1150 /* ir_proto_packet[0] = 0x00; // already the default */
1151 *rc_proto = RC_PROTO_BIT_IMON;
1154 memcpy(ictx->usb_tx_buf, &ir_proto_packet, sizeof(ir_proto_packet));
1156 if (!mutex_is_locked(&ictx->lock)) {
1158 mutex_lock(&ictx->lock);
1161 retval = send_packet(ictx);
1165 ictx->rc_proto = *rc_proto;
1166 ictx->pad_mouse = false;
1170 mutex_unlock(&ictx->lock);
1176 * The directional pad behaves a bit differently, depending on whether this is
1177 * one of the older ffdc devices or a newer device. Newer devices appear to
1178 * have a higher resolution matrix for more precise mouse movement, but it
1179 * makes things overly sensitive in keyboard mode, so we do some interesting
1180 * contortions to make it less touchy. Older devices run through the same
1181 * routine with shorter timeout and a smaller threshold.
1183 static int stabilize(int a, int b, u16 timeout, u16 threshold)
1186 static ktime_t prev_time;
1187 static ktime_t hit_time;
1188 static int x, y, prev_result, hits;
1190 long msec, msec_hit;
1193 msec = ktime_ms_delta(ct, prev_time);
1194 msec_hit = ktime_ms_delta(ct, hit_time);
1207 if (abs(x) > threshold || abs(y) > threshold) {
1208 if (abs(y) > abs(x))
1209 result = (y > 0) ? 0x7F : 0x80;
1211 result = (x > 0) ? 0x7F00 : 0x8000;
1216 if (result == prev_result) {
1222 y = 17 * threshold / 30;
1225 y -= 17 * threshold / 30;
1228 x = 17 * threshold / 30;
1231 x -= 17 * threshold / 30;
1236 if (hits == 2 && msec_hit < timeout) {
1241 prev_result = result;
1250 static u32 imon_remote_key_lookup(struct imon_context *ictx, u32 scancode)
1254 bool is_release_code = false;
1256 /* Look for the initial press of a button */
1257 keycode = rc_g_keycode_from_table(ictx->rdev, scancode);
1258 ictx->rc_toggle = 0x0;
1259 ictx->rc_scancode = scancode;
1261 /* Look for the release of a button */
1262 if (keycode == KEY_RESERVED) {
1263 release = scancode & ~0x4000;
1264 keycode = rc_g_keycode_from_table(ictx->rdev, release);
1265 if (keycode != KEY_RESERVED)
1266 is_release_code = true;
1269 ictx->release_code = is_release_code;
1274 static u32 imon_mce_key_lookup(struct imon_context *ictx, u32 scancode)
1278 #define MCE_KEY_MASK 0x7000
1279 #define MCE_TOGGLE_BIT 0x8000
1282 * On some receivers, mce keys decode to 0x8000f04xx and 0x8000f84xx
1283 * (the toggle bit flipping between alternating key presses), while
1284 * on other receivers, we see 0x8000f74xx and 0x8000ff4xx. To keep
1285 * the table trim, we always or in the bits to look up 0x8000ff4xx,
1286 * but we can't or them into all codes, as some keys are decoded in
1287 * a different way w/o the same use of the toggle bit...
1289 if (scancode & 0x80000000)
1290 scancode = scancode | MCE_KEY_MASK | MCE_TOGGLE_BIT;
1292 ictx->rc_scancode = scancode;
1293 keycode = rc_g_keycode_from_table(ictx->rdev, scancode);
1295 /* not used in mce mode, but make sure we know its false */
1296 ictx->release_code = false;
1301 static u32 imon_panel_key_lookup(struct imon_context *ictx, u64 code)
1303 const struct imon_panel_key_table *key_table;
1304 u32 keycode = KEY_RESERVED;
1307 key_table = ictx->dev_descr->key_table;
1309 for (i = 0; key_table[i].hw_code != 0; i++) {
1310 if (key_table[i].hw_code == (code | 0xffee)) {
1311 keycode = key_table[i].keycode;
1315 ictx->release_code = false;
1319 static bool imon_mouse_event(struct imon_context *ictx,
1320 unsigned char *buf, int len)
1322 signed char rel_x = 0x00, rel_y = 0x00;
1324 bool mouse_input = true;
1326 unsigned long flags;
1328 spin_lock_irqsave(&ictx->kc_lock, flags);
1330 /* newer iMON device PAD or mouse button */
1331 if (ictx->product != 0xffdc && (buf[0] & 0x01) && len == 5) {
1335 /* 0xffdc iMON PAD or mouse button input */
1336 } else if (ictx->product == 0xffdc && (buf[0] & 0x40) &&
1337 !((buf[1] & 0x01) || ((buf[1] >> 2) & 0x01))) {
1338 rel_x = (buf[1] & 0x08) | (buf[1] & 0x10) >> 2 |
1339 (buf[1] & 0x20) >> 4 | (buf[1] & 0x40) >> 6;
1342 rel_x = rel_x + rel_x / 2;
1343 rel_y = (buf[2] & 0x08) | (buf[2] & 0x10) >> 2 |
1344 (buf[2] & 0x20) >> 4 | (buf[2] & 0x40) >> 6;
1347 rel_y = rel_y + rel_y / 2;
1349 /* some ffdc devices decode mouse buttons differently... */
1350 } else if (ictx->product == 0xffdc && (buf[0] == 0x68)) {
1352 /* ch+/- buttons, which we use for an emulated scroll wheel */
1353 } else if (ictx->kc == KEY_CHANNELUP && (buf[2] & 0x40) != 0x40) {
1355 } else if (ictx->kc == KEY_CHANNELDOWN && (buf[2] & 0x40) != 0x40) {
1358 mouse_input = false;
1360 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1363 dev_dbg(ictx->dev, "sending mouse data via input subsystem\n");
1366 input_report_rel(ictx->idev, REL_WHEEL, dir);
1367 } else if (rel_x || rel_y) {
1368 input_report_rel(ictx->idev, REL_X, rel_x);
1369 input_report_rel(ictx->idev, REL_Y, rel_y);
1371 input_report_key(ictx->idev, BTN_LEFT, buf[1] & 0x1);
1372 input_report_key(ictx->idev, BTN_RIGHT,
1373 buf[1] >> right_shift & 0x1);
1375 input_sync(ictx->idev);
1376 spin_lock_irqsave(&ictx->kc_lock, flags);
1377 ictx->last_keycode = ictx->kc;
1378 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1384 static void imon_touch_event(struct imon_context *ictx, unsigned char *buf)
1386 mod_timer(&ictx->ttimer, jiffies + TOUCH_TIMEOUT);
1387 ictx->touch_x = (buf[0] << 4) | (buf[1] >> 4);
1388 ictx->touch_y = 0xfff - ((buf[2] << 4) | (buf[1] & 0xf));
1389 input_report_abs(ictx->touch, ABS_X, ictx->touch_x);
1390 input_report_abs(ictx->touch, ABS_Y, ictx->touch_y);
1391 input_report_key(ictx->touch, BTN_TOUCH, 0x01);
1392 input_sync(ictx->touch);
1395 static void imon_pad_to_keys(struct imon_context *ictx, unsigned char *buf)
1398 signed char rel_x = 0x00, rel_y = 0x00;
1399 u16 timeout, threshold;
1400 u32 scancode = KEY_RESERVED;
1401 unsigned long flags;
1404 * The imon directional pad functions more like a touchpad. Bytes 3 & 4
1405 * contain a position coordinate (x,y), with each component ranging
1406 * from -14 to 14. We want to down-sample this to only 4 discrete values
1407 * for up/down/left/right arrow keys. Also, when you get too close to
1408 * diagonals, it has a tendency to jump back and forth, so lets try to
1409 * ignore when they get too close.
1411 if (ictx->product != 0xffdc) {
1412 /* first, pad to 8 bytes so it conforms with everything else */
1413 buf[5] = buf[6] = buf[7] = 0;
1414 timeout = 500; /* in msecs */
1415 /* (2*threshold) x (2*threshold) square */
1416 threshold = pad_thresh ? pad_thresh : 28;
1420 if (ictx->rc_proto == RC_PROTO_BIT_IMON && pad_stabilize) {
1421 if ((buf[1] == 0) && ((rel_x != 0) || (rel_y != 0))) {
1422 dir = stabilize((int)rel_x, (int)rel_y,
1423 timeout, threshold);
1425 spin_lock_irqsave(&ictx->kc_lock,
1427 ictx->kc = KEY_UNKNOWN;
1428 spin_unlock_irqrestore(&ictx->kc_lock,
1432 buf[2] = dir & 0xFF;
1433 buf[3] = (dir >> 8) & 0xFF;
1434 scancode = be32_to_cpu(*((__be32 *)buf));
1438 * Hack alert: instead of using keycodes, we have
1439 * to use hard-coded scancodes here...
1441 if (abs(rel_y) > abs(rel_x)) {
1442 buf[2] = (rel_y > 0) ? 0x7F : 0x80;
1445 scancode = 0x01007f00; /* KEY_DOWN */
1447 scancode = 0x01008000; /* KEY_UP */
1450 buf[3] = (rel_x > 0) ? 0x7F : 0x80;
1452 scancode = 0x0100007f; /* KEY_RIGHT */
1454 scancode = 0x01000080; /* KEY_LEFT */
1459 * Handle on-board decoded pad events for e.g. older VFD/iMON-Pad
1460 * device (15c2:ffdc). The remote generates various codes from
1461 * 0x68nnnnB7 to 0x6AnnnnB7, the left mouse button generates
1462 * 0x688301b7 and the right one 0x688481b7. All other keys generate
1463 * 0x2nnnnnnn. Position coordinate is encoded in buf[1] and buf[2] with
1464 * reversed endianness. Extract direction from buffer, rotate endianness,
1465 * adjust sign and feed the values into stabilize(). The resulting codes
1466 * will be 0x01008000, 0x01007F00, which match the newer devices.
1469 timeout = 10; /* in msecs */
1470 /* (2*threshold) x (2*threshold) square */
1471 threshold = pad_thresh ? pad_thresh : 15;
1474 rel_x = (buf[1] & 0x08) | (buf[1] & 0x10) >> 2 |
1475 (buf[1] & 0x20) >> 4 | (buf[1] & 0x40) >> 6;
1479 rel_y = (buf[2] & 0x08) | (buf[2] & 0x10) >> 2 |
1480 (buf[2] & 0x20) >> 4 | (buf[2] & 0x40) >> 6;
1485 buf[1] = buf[4] = buf[5] = buf[6] = buf[7] = 0;
1487 if (ictx->rc_proto == RC_PROTO_BIT_IMON && pad_stabilize) {
1488 dir = stabilize((int)rel_x, (int)rel_y,
1489 timeout, threshold);
1491 spin_lock_irqsave(&ictx->kc_lock, flags);
1492 ictx->kc = KEY_UNKNOWN;
1493 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1496 buf[2] = dir & 0xFF;
1497 buf[3] = (dir >> 8) & 0xFF;
1498 scancode = be32_to_cpu(*((__be32 *)buf));
1501 * Hack alert: instead of using keycodes, we have
1502 * to use hard-coded scancodes here...
1504 if (abs(rel_y) > abs(rel_x)) {
1505 buf[2] = (rel_y > 0) ? 0x7F : 0x80;
1508 scancode = 0x01007f00; /* KEY_DOWN */
1510 scancode = 0x01008000; /* KEY_UP */
1513 buf[3] = (rel_x > 0) ? 0x7F : 0x80;
1515 scancode = 0x0100007f; /* KEY_RIGHT */
1517 scancode = 0x01000080; /* KEY_LEFT */
1523 spin_lock_irqsave(&ictx->kc_lock, flags);
1524 ictx->kc = imon_remote_key_lookup(ictx, scancode);
1525 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1530 * figure out if these is a press or a release. We don't actually
1531 * care about repeats, as those will be auto-generated within the IR
1532 * subsystem for repeating scancodes.
1534 static int imon_parse_press_type(struct imon_context *ictx,
1535 unsigned char *buf, u8 ktype)
1538 unsigned long flags;
1540 spin_lock_irqsave(&ictx->kc_lock, flags);
1542 /* key release of 0x02XXXXXX key */
1543 if (ictx->kc == KEY_RESERVED && buf[0] == 0x02 && buf[3] == 0x00)
1544 ictx->kc = ictx->last_keycode;
1546 /* mouse button release on (some) 0xffdc devices */
1547 else if (ictx->kc == KEY_RESERVED && buf[0] == 0x68 && buf[1] == 0x82 &&
1548 buf[2] == 0x81 && buf[3] == 0xb7)
1549 ictx->kc = ictx->last_keycode;
1551 /* mouse button release on (some other) 0xffdc devices */
1552 else if (ictx->kc == KEY_RESERVED && buf[0] == 0x01 && buf[1] == 0x00 &&
1553 buf[2] == 0x81 && buf[3] == 0xb7)
1554 ictx->kc = ictx->last_keycode;
1556 /* mce-specific button handling, no keyup events */
1557 else if (ktype == IMON_KEY_MCE) {
1558 ictx->rc_toggle = buf[2];
1561 /* incoherent or irrelevant data */
1562 } else if (ictx->kc == KEY_RESERVED)
1563 press_type = -EINVAL;
1565 /* key release of 0xXXXXXXb7 key */
1566 else if (ictx->release_code)
1569 /* this is a button press */
1573 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1579 * Process the incoming packet
1581 static void imon_incoming_packet(struct imon_context *ictx,
1582 struct urb *urb, int intf)
1584 int len = urb->actual_length;
1585 unsigned char *buf = urb->transfer_buffer;
1586 struct device *dev = ictx->dev;
1587 unsigned long flags;
1592 static ktime_t prev_time;
1595 /* filter out junk data on the older 0xffdc imon devices */
1596 if ((buf[0] == 0xff) && (buf[1] == 0xff) && (buf[2] == 0xff))
1599 /* Figure out what key was pressed */
1600 if (len == 8 && buf[7] == 0xee) {
1601 scancode = be64_to_cpu(*((__be64 *)buf));
1602 ktype = IMON_KEY_PANEL;
1603 kc = imon_panel_key_lookup(ictx, scancode);
1604 ictx->release_code = false;
1606 scancode = be32_to_cpu(*((__be32 *)buf));
1607 if (ictx->rc_proto == RC_PROTO_BIT_RC6_MCE) {
1608 ktype = IMON_KEY_IMON;
1610 ktype = IMON_KEY_MCE;
1611 kc = imon_mce_key_lookup(ictx, scancode);
1613 ktype = IMON_KEY_IMON;
1614 kc = imon_remote_key_lookup(ictx, scancode);
1618 spin_lock_irqsave(&ictx->kc_lock, flags);
1619 /* keyboard/mouse mode toggle button */
1620 if (kc == KEY_KEYBOARD && !ictx->release_code) {
1621 ictx->last_keycode = kc;
1623 ictx->pad_mouse = !ictx->pad_mouse;
1624 dev_dbg(dev, "toggling to %s mode\n",
1625 ictx->pad_mouse ? "mouse" : "keyboard");
1626 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1629 ictx->pad_mouse = false;
1630 dev_dbg(dev, "mouse mode disabled, passing key value\n");
1635 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1637 /* send touchscreen events through input subsystem if touchpad data */
1638 if (ictx->touch && len == 8 && buf[7] == 0x86) {
1639 imon_touch_event(ictx, buf);
1642 /* look for mouse events with pad in mouse mode */
1643 } else if (ictx->pad_mouse) {
1644 if (imon_mouse_event(ictx, buf, len))
1648 /* Now for some special handling to convert pad input to arrow keys */
1649 if (((len == 5) && (buf[0] == 0x01) && (buf[4] == 0x00)) ||
1650 ((len == 8) && (buf[0] & 0x40) &&
1651 !(buf[1] & 0x1 || buf[1] >> 2 & 0x1))) {
1653 imon_pad_to_keys(ictx, buf);
1657 printk(KERN_INFO "intf%d decoded packet: %*ph\n",
1661 press_type = imon_parse_press_type(ictx, buf, ktype);
1663 goto not_input_data;
1665 if (ktype != IMON_KEY_PANEL) {
1666 if (press_type == 0)
1667 rc_keyup(ictx->rdev);
1669 enum rc_proto proto;
1671 if (ictx->rc_proto == RC_PROTO_BIT_RC6_MCE)
1672 proto = RC_PROTO_RC6_MCE;
1673 else if (ictx->rc_proto == RC_PROTO_BIT_IMON)
1674 proto = RC_PROTO_IMON;
1678 rc_keydown(ictx->rdev, proto, ictx->rc_scancode,
1681 spin_lock_irqsave(&ictx->kc_lock, flags);
1682 ictx->last_keycode = ictx->kc;
1683 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1688 /* Only panel type events left to process now */
1689 spin_lock_irqsave(&ictx->kc_lock, flags);
1692 /* KEY repeats from knob and panel that need to be suppressed */
1693 if (ictx->kc == KEY_MUTE ||
1694 ictx->dev_descr->flags & IMON_SUPPRESS_REPEATED_KEYS) {
1695 if (ictx->kc == ictx->last_keycode &&
1696 ktime_ms_delta(t, prev_time) < ictx->idev->rep[REP_DELAY]) {
1697 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1705 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1707 input_report_key(ictx->idev, kc, press_type);
1708 input_sync(ictx->idev);
1710 /* panel keys don't generate a release */
1711 input_report_key(ictx->idev, kc, 0);
1712 input_sync(ictx->idev);
1714 spin_lock_irqsave(&ictx->kc_lock, flags);
1715 ictx->last_keycode = kc;
1716 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1722 dev_warn(dev, "imon %s: invalid incoming packet size (len = %d, intf%d)\n",
1723 __func__, len, intf);
1727 /* iMON 2.4G associate frame */
1728 if (buf[0] == 0x00 &&
1729 buf[2] == 0xFF && /* REFID */
1732 buf[5] == 0xFF && /* iMON 2.4G */
1733 ((buf[6] == 0x4E && buf[7] == 0xDF) || /* LT */
1734 (buf[6] == 0x5E && buf[7] == 0xDF))) { /* DT */
1735 dev_warn(dev, "%s: remote associated refid=%02X\n",
1737 ictx->rf_isassociating = false;
1742 * Callback function for USB core API: receive data
1744 static void usb_rx_callback_intf0(struct urb *urb)
1746 struct imon_context *ictx;
1752 ictx = (struct imon_context *)urb->context;
1757 * if we get a callback before we're done configuring the hardware, we
1758 * can't yet process the data, as there's nowhere to send it, but we
1759 * still need to submit a new rx URB to avoid wedging the hardware
1761 if (!ictx->dev_present_intf0)
1764 switch (urb->status) {
1765 case -ENOENT: /* usbcore unlink successful! */
1768 case -ESHUTDOWN: /* transport endpoint was shut down */
1772 imon_incoming_packet(ictx, urb, intfnum);
1776 dev_warn(ictx->dev, "imon %s: status(%d): ignored\n",
1777 __func__, urb->status);
1782 usb_submit_urb(ictx->rx_urb_intf0, GFP_ATOMIC);
1785 static void usb_rx_callback_intf1(struct urb *urb)
1787 struct imon_context *ictx;
1793 ictx = (struct imon_context *)urb->context;
1798 * if we get a callback before we're done configuring the hardware, we
1799 * can't yet process the data, as there's nowhere to send it, but we
1800 * still need to submit a new rx URB to avoid wedging the hardware
1802 if (!ictx->dev_present_intf1)
1805 switch (urb->status) {
1806 case -ENOENT: /* usbcore unlink successful! */
1809 case -ESHUTDOWN: /* transport endpoint was shut down */
1813 imon_incoming_packet(ictx, urb, intfnum);
1817 dev_warn(ictx->dev, "imon %s: status(%d): ignored\n",
1818 __func__, urb->status);
1823 usb_submit_urb(ictx->rx_urb_intf1, GFP_ATOMIC);
1827 * The 0x15c2:0xffdc device ID was used for umpteen different imon
1828 * devices, and all of them constantly spew interrupts, even when there
1829 * is no actual data to report. However, byte 6 of this buffer looks like
1830 * its unique across device variants, so we're trying to key off that to
1831 * figure out which display type (if any) and what IR protocol the device
1832 * actually supports. These devices have their IR protocol hard-coded into
1833 * their firmware, they can't be changed on the fly like the newer hardware.
1835 static void imon_get_ffdc_type(struct imon_context *ictx)
1837 u8 ffdc_cfg_byte = ictx->usb_rx_buf[6];
1838 u8 detected_display_type = IMON_DISPLAY_TYPE_NONE;
1839 u64 allowed_protos = RC_PROTO_BIT_IMON;
1841 switch (ffdc_cfg_byte) {
1842 /* iMON Knob, no display, iMON IR + vol knob */
1844 dev_info(ictx->dev, "0xffdc iMON Knob, iMON IR");
1845 ictx->display_supported = false;
1847 /* iMON 2.4G LT (usb stick), no display, iMON RF */
1849 dev_info(ictx->dev, "0xffdc iMON 2.4G LT, iMON RF");
1850 ictx->display_supported = false;
1851 ictx->rf_device = true;
1853 /* iMON VFD, no IR (does have vol knob tho) */
1855 dev_info(ictx->dev, "0xffdc iMON VFD + knob, no IR");
1856 detected_display_type = IMON_DISPLAY_TYPE_VFD;
1858 /* iMON VFD, iMON IR */
1862 dev_info(ictx->dev, "0xffdc iMON VFD, iMON IR");
1863 detected_display_type = IMON_DISPLAY_TYPE_VFD;
1865 /* iMON VFD, MCE IR */
1868 dev_info(ictx->dev, "0xffdc iMON VFD, MCE IR");
1869 detected_display_type = IMON_DISPLAY_TYPE_VFD;
1870 allowed_protos = RC_PROTO_BIT_RC6_MCE;
1872 /* iMON VFD, iMON or MCE IR */
1874 dev_info(ictx->dev, "0xffdc iMON VFD, iMON or MCE IR");
1875 detected_display_type = IMON_DISPLAY_TYPE_VFD;
1876 allowed_protos |= RC_PROTO_BIT_RC6_MCE;
1878 /* iMON LCD, MCE IR */
1880 dev_info(ictx->dev, "0xffdc iMON LCD, MCE IR");
1881 detected_display_type = IMON_DISPLAY_TYPE_LCD;
1882 allowed_protos = RC_PROTO_BIT_RC6_MCE;
1884 /* no display, iMON IR */
1886 dev_info(ictx->dev, "0xffdc iMON Inside, iMON IR");
1887 ictx->display_supported = false;
1889 /* Soundgraph iMON UltraBay */
1891 dev_info(ictx->dev, "0xffdc iMON UltraBay, LCD + IR");
1892 detected_display_type = IMON_DISPLAY_TYPE_LCD;
1893 allowed_protos = RC_PROTO_BIT_IMON | RC_PROTO_BIT_RC6_MCE;
1894 ictx->dev_descr = &ultrabay_table;
1898 dev_info(ictx->dev, "Unknown 0xffdc device, defaulting to VFD and iMON IR");
1899 detected_display_type = IMON_DISPLAY_TYPE_VFD;
1901 * We don't know which one it is, allow user to set the
1902 * RC6 one from userspace if IMON wasn't correct.
1904 allowed_protos |= RC_PROTO_BIT_RC6_MCE;
1908 printk(KERN_CONT " (id 0x%02x)\n", ffdc_cfg_byte);
1910 ictx->display_type = detected_display_type;
1911 ictx->rc_proto = allowed_protos;
1914 static void imon_set_display_type(struct imon_context *ictx)
1916 u8 configured_display_type = IMON_DISPLAY_TYPE_VFD;
1919 * Try to auto-detect the type of display if the user hasn't set
1920 * it by hand via the display_type modparam. Default is VFD.
1923 if (display_type == IMON_DISPLAY_TYPE_AUTO) {
1924 switch (ictx->product) {
1926 /* set in imon_get_ffdc_type() */
1927 configured_display_type = ictx->display_type;
1931 configured_display_type = IMON_DISPLAY_TYPE_VGA;
1936 configured_display_type = IMON_DISPLAY_TYPE_LCD;
1942 configured_display_type = IMON_DISPLAY_TYPE_NONE;
1943 ictx->display_supported = false;
1948 configured_display_type = IMON_DISPLAY_TYPE_VFD;
1952 configured_display_type = display_type;
1953 if (display_type == IMON_DISPLAY_TYPE_NONE)
1954 ictx->display_supported = false;
1956 ictx->display_supported = true;
1957 dev_info(ictx->dev, "%s: overriding display type to %d via modparam\n",
1958 __func__, display_type);
1961 ictx->display_type = configured_display_type;
1964 static struct rc_dev *imon_init_rdev(struct imon_context *ictx)
1966 struct rc_dev *rdev;
1968 static const unsigned char fp_packet[] = {
1969 0x40, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x88 };
1971 rdev = rc_allocate_device(RC_DRIVER_SCANCODE);
1973 dev_err(ictx->dev, "remote control dev allocation failed\n");
1977 snprintf(ictx->name_rdev, sizeof(ictx->name_rdev),
1978 "iMON Remote (%04x:%04x)", ictx->vendor, ictx->product);
1979 usb_make_path(ictx->usbdev_intf0, ictx->phys_rdev,
1980 sizeof(ictx->phys_rdev));
1981 strlcat(ictx->phys_rdev, "/input0", sizeof(ictx->phys_rdev));
1983 rdev->device_name = ictx->name_rdev;
1984 rdev->input_phys = ictx->phys_rdev;
1985 usb_to_input_id(ictx->usbdev_intf0, &rdev->input_id);
1986 rdev->dev.parent = ictx->dev;
1989 /* iMON PAD or MCE */
1990 rdev->allowed_protocols = RC_PROTO_BIT_IMON | RC_PROTO_BIT_RC6_MCE;
1991 rdev->change_protocol = imon_ir_change_protocol;
1992 rdev->driver_name = MOD_NAME;
1994 /* Enable front-panel buttons and/or knobs */
1995 memcpy(ictx->usb_tx_buf, &fp_packet, sizeof(fp_packet));
1996 ret = send_packet(ictx);
1997 /* Not fatal, but warn about it */
1999 dev_info(ictx->dev, "panel buttons/knobs setup failed\n");
2001 if (ictx->product == 0xffdc) {
2002 imon_get_ffdc_type(ictx);
2003 rdev->allowed_protocols = ictx->rc_proto;
2006 imon_set_display_type(ictx);
2008 if (ictx->rc_proto == RC_PROTO_BIT_RC6_MCE)
2009 rdev->map_name = RC_MAP_IMON_MCE;
2011 rdev->map_name = RC_MAP_IMON_PAD;
2013 ret = rc_register_device(rdev);
2015 dev_err(ictx->dev, "remote input dev register failed\n");
2022 rc_free_device(rdev);
2026 static struct input_dev *imon_init_idev(struct imon_context *ictx)
2028 const struct imon_panel_key_table *key_table;
2029 struct input_dev *idev;
2032 key_table = ictx->dev_descr->key_table;
2034 idev = input_allocate_device();
2038 snprintf(ictx->name_idev, sizeof(ictx->name_idev),
2039 "iMON Panel, Knob and Mouse(%04x:%04x)",
2040 ictx->vendor, ictx->product);
2041 idev->name = ictx->name_idev;
2043 usb_make_path(ictx->usbdev_intf0, ictx->phys_idev,
2044 sizeof(ictx->phys_idev));
2045 strlcat(ictx->phys_idev, "/input1", sizeof(ictx->phys_idev));
2046 idev->phys = ictx->phys_idev;
2048 idev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP) | BIT_MASK(EV_REL);
2050 idev->keybit[BIT_WORD(BTN_MOUSE)] =
2051 BIT_MASK(BTN_LEFT) | BIT_MASK(BTN_RIGHT);
2052 idev->relbit[0] = BIT_MASK(REL_X) | BIT_MASK(REL_Y) |
2053 BIT_MASK(REL_WHEEL);
2055 /* panel and/or knob code support */
2056 for (i = 0; key_table[i].hw_code != 0; i++) {
2057 u32 kc = key_table[i].keycode;
2058 __set_bit(kc, idev->keybit);
2061 usb_to_input_id(ictx->usbdev_intf0, &idev->id);
2062 idev->dev.parent = ictx->dev;
2063 input_set_drvdata(idev, ictx);
2065 ret = input_register_device(idev);
2067 dev_err(ictx->dev, "input dev register failed\n");
2074 input_free_device(idev);
2078 static struct input_dev *imon_init_touch(struct imon_context *ictx)
2080 struct input_dev *touch;
2083 touch = input_allocate_device();
2085 goto touch_alloc_failed;
2087 snprintf(ictx->name_touch, sizeof(ictx->name_touch),
2088 "iMON USB Touchscreen (%04x:%04x)",
2089 ictx->vendor, ictx->product);
2090 touch->name = ictx->name_touch;
2092 usb_make_path(ictx->usbdev_intf1, ictx->phys_touch,
2093 sizeof(ictx->phys_touch));
2094 strlcat(ictx->phys_touch, "/input2", sizeof(ictx->phys_touch));
2095 touch->phys = ictx->phys_touch;
2098 BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
2099 touch->keybit[BIT_WORD(BTN_TOUCH)] =
2100 BIT_MASK(BTN_TOUCH);
2101 input_set_abs_params(touch, ABS_X,
2103 input_set_abs_params(touch, ABS_Y,
2106 input_set_drvdata(touch, ictx);
2108 usb_to_input_id(ictx->usbdev_intf1, &touch->id);
2109 touch->dev.parent = ictx->dev;
2110 ret = input_register_device(touch);
2112 dev_info(ictx->dev, "touchscreen input dev register failed\n");
2113 goto touch_register_failed;
2118 touch_register_failed:
2119 input_free_device(touch);
2125 static bool imon_find_endpoints(struct imon_context *ictx,
2126 struct usb_host_interface *iface_desc)
2128 struct usb_endpoint_descriptor *ep;
2129 struct usb_endpoint_descriptor *rx_endpoint = NULL;
2130 struct usb_endpoint_descriptor *tx_endpoint = NULL;
2131 int ifnum = iface_desc->desc.bInterfaceNumber;
2132 int num_endpts = iface_desc->desc.bNumEndpoints;
2133 int i, ep_dir, ep_type;
2134 bool ir_ep_found = false;
2135 bool display_ep_found = false;
2136 bool tx_control = false;
2139 * Scan the endpoint list and set:
2140 * first input endpoint = IR endpoint
2141 * first output endpoint = display endpoint
2143 for (i = 0; i < num_endpts && !(ir_ep_found && display_ep_found); ++i) {
2144 ep = &iface_desc->endpoint[i].desc;
2145 ep_dir = ep->bEndpointAddress & USB_ENDPOINT_DIR_MASK;
2146 ep_type = usb_endpoint_type(ep);
2148 if (!ir_ep_found && ep_dir == USB_DIR_IN &&
2149 ep_type == USB_ENDPOINT_XFER_INT) {
2153 dev_dbg(ictx->dev, "%s: found IR endpoint\n", __func__);
2155 } else if (!display_ep_found && ep_dir == USB_DIR_OUT &&
2156 ep_type == USB_ENDPOINT_XFER_INT) {
2158 display_ep_found = true;
2159 dev_dbg(ictx->dev, "%s: found display endpoint\n", __func__);
2164 ictx->rx_endpoint_intf0 = rx_endpoint;
2166 * tx is used to send characters to lcd/vfd, associate RF
2167 * remotes, set IR protocol, and maybe more...
2169 ictx->tx_endpoint = tx_endpoint;
2171 ictx->rx_endpoint_intf1 = rx_endpoint;
2175 * If we didn't find a display endpoint, this is probably one of the
2176 * newer iMON devices that use control urb instead of interrupt
2178 if (!display_ep_found) {
2180 display_ep_found = true;
2181 dev_dbg(ictx->dev, "%s: device uses control endpoint, not interface OUT endpoint\n",
2186 * Some iMON receivers have no display. Unfortunately, it seems
2187 * that SoundGraph recycles device IDs between devices both with
2190 if (ictx->display_type == IMON_DISPLAY_TYPE_NONE) {
2191 display_ep_found = false;
2192 dev_dbg(ictx->dev, "%s: device has no display\n", __func__);
2196 * iMON Touch devices have a VGA touchscreen, but no "display", as
2197 * that refers to e.g. /dev/lcd0 (a character device LCD or VFD).
2199 if (ictx->display_type == IMON_DISPLAY_TYPE_VGA) {
2200 display_ep_found = false;
2201 dev_dbg(ictx->dev, "%s: iMON Touch device found\n", __func__);
2204 /* Input endpoint is mandatory */
2206 pr_err("no valid input (IR) endpoint found\n");
2208 ictx->tx_control = tx_control;
2210 if (display_ep_found)
2211 ictx->display_supported = true;
2217 static struct imon_context *imon_init_intf0(struct usb_interface *intf,
2218 const struct usb_device_id *id)
2220 struct imon_context *ictx;
2223 struct device *dev = &intf->dev;
2224 struct usb_host_interface *iface_desc;
2227 ictx = kzalloc(sizeof(*ictx), GFP_KERNEL);
2231 rx_urb = usb_alloc_urb(0, GFP_KERNEL);
2233 goto rx_urb_alloc_failed;
2234 tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2236 goto tx_urb_alloc_failed;
2238 mutex_init(&ictx->lock);
2239 spin_lock_init(&ictx->kc_lock);
2241 mutex_lock(&ictx->lock);
2244 ictx->usbdev_intf0 = usb_get_dev(interface_to_usbdev(intf));
2245 ictx->rx_urb_intf0 = rx_urb;
2246 ictx->tx_urb = tx_urb;
2247 ictx->rf_device = false;
2249 init_completion(&ictx->tx.finished);
2251 ictx->vendor = le16_to_cpu(ictx->usbdev_intf0->descriptor.idVendor);
2252 ictx->product = le16_to_cpu(ictx->usbdev_intf0->descriptor.idProduct);
2254 /* save drive info for later accessing the panel/knob key table */
2255 ictx->dev_descr = (struct imon_usb_dev_descr *)id->driver_info;
2256 /* default send_packet delay is 5ms but some devices need more */
2257 ictx->send_packet_delay = ictx->dev_descr->flags &
2258 IMON_NEED_20MS_PKT_DELAY ? 20 : 5;
2261 iface_desc = intf->cur_altsetting;
2262 if (!imon_find_endpoints(ictx, iface_desc)) {
2263 goto find_endpoint_failed;
2266 usb_fill_int_urb(ictx->rx_urb_intf0, ictx->usbdev_intf0,
2267 usb_rcvintpipe(ictx->usbdev_intf0,
2268 ictx->rx_endpoint_intf0->bEndpointAddress),
2269 ictx->usb_rx_buf, sizeof(ictx->usb_rx_buf),
2270 usb_rx_callback_intf0, ictx,
2271 ictx->rx_endpoint_intf0->bInterval);
2273 ret = usb_submit_urb(ictx->rx_urb_intf0, GFP_KERNEL);
2275 pr_err("usb_submit_urb failed for intf0 (%d)\n", ret);
2276 goto urb_submit_failed;
2279 ictx->idev = imon_init_idev(ictx);
2281 dev_err(dev, "%s: input device setup failed\n", __func__);
2282 goto idev_setup_failed;
2285 ictx->rdev = imon_init_rdev(ictx);
2287 dev_err(dev, "%s: rc device setup failed\n", __func__);
2288 goto rdev_setup_failed;
2291 ictx->dev_present_intf0 = true;
2293 mutex_unlock(&ictx->lock);
2297 input_unregister_device(ictx->idev);
2299 usb_kill_urb(ictx->rx_urb_intf0);
2301 find_endpoint_failed:
2302 usb_put_dev(ictx->usbdev_intf0);
2303 mutex_unlock(&ictx->lock);
2304 usb_free_urb(tx_urb);
2305 tx_urb_alloc_failed:
2306 usb_free_urb(rx_urb);
2307 rx_urb_alloc_failed:
2310 dev_err(dev, "unable to initialize intf0, err %d\n", ret);
2315 static struct imon_context *imon_init_intf1(struct usb_interface *intf,
2316 struct imon_context *ictx)
2319 struct usb_host_interface *iface_desc;
2322 rx_urb = usb_alloc_urb(0, GFP_KERNEL);
2324 goto rx_urb_alloc_failed;
2326 mutex_lock(&ictx->lock);
2328 if (ictx->display_type == IMON_DISPLAY_TYPE_VGA) {
2329 timer_setup(&ictx->ttimer, imon_touch_display_timeout, 0);
2332 ictx->usbdev_intf1 = usb_get_dev(interface_to_usbdev(intf));
2333 ictx->rx_urb_intf1 = rx_urb;
2336 iface_desc = intf->cur_altsetting;
2337 if (!imon_find_endpoints(ictx, iface_desc))
2338 goto find_endpoint_failed;
2340 if (ictx->display_type == IMON_DISPLAY_TYPE_VGA) {
2341 ictx->touch = imon_init_touch(ictx);
2343 goto touch_setup_failed;
2347 usb_fill_int_urb(ictx->rx_urb_intf1, ictx->usbdev_intf1,
2348 usb_rcvintpipe(ictx->usbdev_intf1,
2349 ictx->rx_endpoint_intf1->bEndpointAddress),
2350 ictx->usb_rx_buf, sizeof(ictx->usb_rx_buf),
2351 usb_rx_callback_intf1, ictx,
2352 ictx->rx_endpoint_intf1->bInterval);
2354 ret = usb_submit_urb(ictx->rx_urb_intf1, GFP_KERNEL);
2357 pr_err("usb_submit_urb failed for intf1 (%d)\n", ret);
2358 goto urb_submit_failed;
2361 ictx->dev_present_intf1 = true;
2363 mutex_unlock(&ictx->lock);
2368 input_unregister_device(ictx->touch);
2370 find_endpoint_failed:
2371 usb_put_dev(ictx->usbdev_intf1);
2372 mutex_unlock(&ictx->lock);
2373 usb_free_urb(rx_urb);
2374 rx_urb_alloc_failed:
2375 dev_err(ictx->dev, "unable to initialize intf1, err %d\n", ret);
2380 static void imon_init_display(struct imon_context *ictx,
2381 struct usb_interface *intf)
2385 dev_dbg(ictx->dev, "Registering iMON display with sysfs\n");
2387 /* set up sysfs entry for built-in clock */
2388 ret = sysfs_create_group(&intf->dev.kobj, &imon_display_attr_group);
2390 dev_err(ictx->dev, "Could not create display sysfs entries(%d)",
2393 if (ictx->display_type == IMON_DISPLAY_TYPE_LCD)
2394 ret = usb_register_dev(intf, &imon_lcd_class);
2396 ret = usb_register_dev(intf, &imon_vfd_class);
2398 /* Not a fatal error, so ignore */
2399 dev_info(ictx->dev, "could not get a minor number for display\n");
2404 * Callback function for USB core API: Probe
2406 static int imon_probe(struct usb_interface *interface,
2407 const struct usb_device_id *id)
2409 struct usb_device *usbdev = NULL;
2410 struct usb_host_interface *iface_desc = NULL;
2411 struct usb_interface *first_if;
2412 struct device *dev = &interface->dev;
2413 int ifnum, sysfs_err;
2415 struct imon_context *ictx = NULL;
2416 u16 vendor, product;
2418 usbdev = usb_get_dev(interface_to_usbdev(interface));
2419 iface_desc = interface->cur_altsetting;
2420 ifnum = iface_desc->desc.bInterfaceNumber;
2421 vendor = le16_to_cpu(usbdev->descriptor.idVendor);
2422 product = le16_to_cpu(usbdev->descriptor.idProduct);
2424 dev_dbg(dev, "%s: found iMON device (%04x:%04x, intf%d)\n",
2425 __func__, vendor, product, ifnum);
2427 first_if = usb_ifnum_to_if(usbdev, 0);
2433 if (first_if->dev.driver != interface->dev.driver) {
2434 dev_err(&interface->dev, "inconsistent driver matching\n");
2440 ictx = imon_init_intf0(interface, id);
2442 pr_err("failed to initialize context!\n");
2446 refcount_set(&ictx->users, 1);
2449 /* this is the secondary interface on the device */
2450 struct imon_context *first_if_ctx = usb_get_intfdata(first_if);
2452 /* fail early if first intf failed to register */
2453 if (!first_if_ctx) {
2458 ictx = imon_init_intf1(interface, first_if_ctx);
2460 pr_err("failed to attach to context!\n");
2464 refcount_inc(&ictx->users);
2468 usb_set_intfdata(interface, ictx);
2471 if (product == 0xffdc && ictx->rf_device) {
2472 sysfs_err = sysfs_create_group(&interface->dev.kobj,
2473 &imon_rf_attr_group);
2475 pr_err("Could not create RF sysfs entries(%d)\n",
2479 if (ictx->display_supported)
2480 imon_init_display(ictx, interface);
2483 dev_info(dev, "iMON device (%04x:%04x, intf%d) on usb<%d:%d> initialized\n",
2484 vendor, product, ifnum,
2485 usbdev->bus->busnum, usbdev->devnum);
2487 usb_put_dev(usbdev);
2492 usb_put_dev(usbdev);
2493 dev_err(dev, "unable to register, err %d\n", ret);
2499 * Callback function for USB core API: disconnect
2501 static void imon_disconnect(struct usb_interface *interface)
2503 struct imon_context *ictx;
2507 ictx = usb_get_intfdata(interface);
2508 ictx->disconnected = true;
2510 ifnum = interface->cur_altsetting->desc.bInterfaceNumber;
2513 * sysfs_remove_group is safe to call even if sysfs_create_group
2514 * hasn't been called
2516 sysfs_remove_group(&interface->dev.kobj, &imon_display_attr_group);
2517 sysfs_remove_group(&interface->dev.kobj, &imon_rf_attr_group);
2519 usb_set_intfdata(interface, NULL);
2521 /* Abort ongoing write */
2522 if (ictx->tx.busy) {
2523 usb_kill_urb(ictx->tx_urb);
2524 complete(&ictx->tx.finished);
2528 ictx->dev_present_intf0 = false;
2529 usb_kill_urb(ictx->rx_urb_intf0);
2530 usb_put_dev(ictx->usbdev_intf0);
2531 input_unregister_device(ictx->idev);
2532 rc_unregister_device(ictx->rdev);
2533 if (ictx->display_supported) {
2534 if (ictx->display_type == IMON_DISPLAY_TYPE_LCD)
2535 usb_deregister_dev(interface, &imon_lcd_class);
2536 else if (ictx->display_type == IMON_DISPLAY_TYPE_VFD)
2537 usb_deregister_dev(interface, &imon_vfd_class);
2540 ictx->dev_present_intf1 = false;
2541 usb_kill_urb(ictx->rx_urb_intf1);
2542 usb_put_dev(ictx->usbdev_intf1);
2543 if (ictx->display_type == IMON_DISPLAY_TYPE_VGA) {
2544 input_unregister_device(ictx->touch);
2545 del_timer_sync(&ictx->ttimer);
2549 if (refcount_dec_and_test(&ictx->users))
2550 free_imon_context(ictx);
2552 dev_dbg(dev, "%s: iMON device (intf%d) disconnected\n",
2556 static int imon_suspend(struct usb_interface *intf, pm_message_t message)
2558 struct imon_context *ictx = usb_get_intfdata(intf);
2559 int ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
2562 usb_kill_urb(ictx->rx_urb_intf0);
2564 usb_kill_urb(ictx->rx_urb_intf1);
2569 static int imon_resume(struct usb_interface *intf)
2572 struct imon_context *ictx = usb_get_intfdata(intf);
2573 int ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
2576 usb_fill_int_urb(ictx->rx_urb_intf0, ictx->usbdev_intf0,
2577 usb_rcvintpipe(ictx->usbdev_intf0,
2578 ictx->rx_endpoint_intf0->bEndpointAddress),
2579 ictx->usb_rx_buf, sizeof(ictx->usb_rx_buf),
2580 usb_rx_callback_intf0, ictx,
2581 ictx->rx_endpoint_intf0->bInterval);
2583 rc = usb_submit_urb(ictx->rx_urb_intf0, GFP_ATOMIC);
2586 usb_fill_int_urb(ictx->rx_urb_intf1, ictx->usbdev_intf1,
2587 usb_rcvintpipe(ictx->usbdev_intf1,
2588 ictx->rx_endpoint_intf1->bEndpointAddress),
2589 ictx->usb_rx_buf, sizeof(ictx->usb_rx_buf),
2590 usb_rx_callback_intf1, ictx,
2591 ictx->rx_endpoint_intf1->bInterval);
2593 rc = usb_submit_urb(ictx->rx_urb_intf1, GFP_ATOMIC);
2599 module_usb_driver(imon_driver);