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.
25 #define pr_fmt(fmt) KBUILD_MODNAME ":%s: " fmt, __func__
27 #include <linux/errno.h>
28 #include <linux/init.h>
29 #include <linux/kernel.h>
30 #include <linux/module.h>
31 #include <linux/slab.h>
32 #include <linux/uaccess.h>
33 #include <linux/ratelimit.h>
35 #include <linux/input.h>
36 #include <linux/usb.h>
37 #include <linux/usb/input.h>
38 #include <media/rc-core.h>
40 #include <linux/time.h>
41 #include <linux/timer.h>
43 #define MOD_AUTHOR "Jarod Wilson <jarod@wilsonet.com>"
44 #define MOD_DESC "Driver for SoundGraph iMON MultiMedia IR/Display"
45 #define MOD_NAME "imon"
46 #define MOD_VERSION "0.9.4"
48 #define DISPLAY_MINOR_BASE 144
49 #define DEVICE_NAME "lcd%d"
51 #define BUF_CHUNK_SIZE 8
54 #define BIT_DURATION 250 /* each bit received is 250us */
56 #define IMON_CLOCK_ENABLE_PACKETS 2
58 /*** P R O T O T Y P E S ***/
60 /* USB Callback prototypes */
61 static int imon_probe(struct usb_interface
*interface
,
62 const struct usb_device_id
*id
);
63 static void imon_disconnect(struct usb_interface
*interface
);
64 static void usb_rx_callback_intf0(struct urb
*urb
);
65 static void usb_rx_callback_intf1(struct urb
*urb
);
66 static void usb_tx_callback(struct urb
*urb
);
68 /* suspend/resume support */
69 static int imon_resume(struct usb_interface
*intf
);
70 static int imon_suspend(struct usb_interface
*intf
, pm_message_t message
);
72 /* Display file_operations function prototypes */
73 static int display_open(struct inode
*inode
, struct file
*file
);
74 static int display_close(struct inode
*inode
, struct file
*file
);
76 /* VFD write operation */
77 static ssize_t
vfd_write(struct file
*file
, const char __user
*buf
,
78 size_t n_bytes
, loff_t
*pos
);
80 /* LCD file_operations override function prototypes */
81 static ssize_t
lcd_write(struct file
*file
, const char __user
*buf
,
82 size_t n_bytes
, loff_t
*pos
);
84 /*** G L O B A L S ***/
86 struct imon_panel_key_table
{
91 struct imon_usb_dev_descr
{
93 #define IMON_NO_FLAGS 0
94 #define IMON_NEED_20MS_PKT_DELAY 1
96 struct imon_panel_key_table key_table
[];
101 /* Newer devices have two interfaces */
102 struct usb_device
*usbdev_intf0
;
103 struct usb_device
*usbdev_intf1
;
105 bool display_supported
; /* not all controllers do */
106 bool display_isopen
; /* display port has been opened */
107 bool rf_device
; /* true if iMON 2.4G LT/DT RF device */
108 bool rf_isassociating
; /* RF remote associating */
109 bool dev_present_intf0
; /* USB device presence, interface 0 */
110 bool dev_present_intf1
; /* USB device presence, interface 1 */
112 struct mutex lock
; /* to lock this object */
113 wait_queue_head_t remove_ok
; /* For unexpected USB disconnects */
115 struct usb_endpoint_descriptor
*rx_endpoint_intf0
;
116 struct usb_endpoint_descriptor
*rx_endpoint_intf1
;
117 struct usb_endpoint_descriptor
*tx_endpoint
;
118 struct urb
*rx_urb_intf0
;
119 struct urb
*rx_urb_intf1
;
122 unsigned char usb_rx_buf
[8];
123 unsigned char usb_tx_buf
[8];
124 unsigned int send_packet_delay
;
127 int count
; /* length of 0 or 1 sequence */
128 int prev_bit
; /* logic level of sequence */
129 int initial_space
; /* initial space flag */
133 unsigned char data_buf
[35]; /* user data buffer */
134 struct completion finished
; /* wait for write to finish */
135 bool busy
; /* write in progress */
136 int status
; /* status of tx completion */
139 u16 vendor
; /* usb vendor ID */
140 u16 product
; /* usb product ID */
142 struct rc_dev
*rdev
; /* rc-core device for remote */
143 struct input_dev
*idev
; /* input device for panel & IR mouse */
144 struct input_dev
*touch
; /* input device for touchscreen */
146 spinlock_t kc_lock
; /* make sure we get keycodes right */
147 u32 kc
; /* current input keycode */
148 u32 last_keycode
; /* last reported input keycode */
149 u32 rc_scancode
; /* the computed remote scancode */
150 u8 rc_toggle
; /* the computed remote toggle bit */
151 u64 rc_proto
; /* iMON or MCE (RC6) IR protocol? */
152 bool release_code
; /* some keys send a release code */
154 u8 display_type
; /* store the display type */
155 bool pad_mouse
; /* toggle kbd(0)/mouse(1) mode */
157 char name_rdev
[128]; /* rc input device name */
158 char phys_rdev
[64]; /* rc input device phys path */
160 char name_idev
[128]; /* input device name */
161 char phys_idev
[64]; /* input device phys path */
163 char name_touch
[128]; /* touch screen name */
164 char phys_touch
[64]; /* touch screen phys path */
165 struct timer_list ttimer
; /* touch screen timer */
166 int touch_x
; /* x coordinate on touchscreen */
167 int touch_y
; /* y coordinate on touchscreen */
168 struct imon_usb_dev_descr
*dev_descr
; /* device description with key
169 table for front panels */
172 #define TOUCH_TIMEOUT (HZ/30)
174 /* vfd character device file operations */
175 static const struct file_operations vfd_fops
= {
176 .owner
= THIS_MODULE
,
177 .open
= &display_open
,
179 .release
= &display_close
,
180 .llseek
= noop_llseek
,
183 /* lcd character device file operations */
184 static const struct file_operations lcd_fops
= {
185 .owner
= THIS_MODULE
,
186 .open
= &display_open
,
188 .release
= &display_close
,
189 .llseek
= noop_llseek
,
193 IMON_DISPLAY_TYPE_AUTO
= 0,
194 IMON_DISPLAY_TYPE_VFD
= 1,
195 IMON_DISPLAY_TYPE_LCD
= 2,
196 IMON_DISPLAY_TYPE_VGA
= 3,
197 IMON_DISPLAY_TYPE_NONE
= 4,
206 static struct usb_class_driver imon_vfd_class
= {
209 .minor_base
= DISPLAY_MINOR_BASE
,
212 static struct usb_class_driver imon_lcd_class
= {
215 .minor_base
= DISPLAY_MINOR_BASE
,
218 /* imon receiver front panel/knob key table */
219 static const struct imon_usb_dev_descr imon_default_table
= {
220 .flags
= IMON_NO_FLAGS
,
222 { 0x000000000f00ffeell
, KEY_MEDIA
}, /* Go */
223 { 0x000000001200ffeell
, KEY_UP
},
224 { 0x000000001300ffeell
, KEY_DOWN
},
225 { 0x000000001400ffeell
, KEY_LEFT
},
226 { 0x000000001500ffeell
, KEY_RIGHT
},
227 { 0x000000001600ffeell
, KEY_ENTER
},
228 { 0x000000001700ffeell
, KEY_ESC
},
229 { 0x000000001f00ffeell
, KEY_AUDIO
},
230 { 0x000000002000ffeell
, KEY_VIDEO
},
231 { 0x000000002100ffeell
, KEY_CAMERA
},
232 { 0x000000002700ffeell
, KEY_DVD
},
233 { 0x000000002300ffeell
, KEY_TV
},
234 { 0x000000002b00ffeell
, KEY_EXIT
},
235 { 0x000000002c00ffeell
, KEY_SELECT
},
236 { 0x000000002d00ffeell
, KEY_MENU
},
237 { 0x000000000500ffeell
, KEY_PREVIOUS
},
238 { 0x000000000700ffeell
, KEY_REWIND
},
239 { 0x000000000400ffeell
, KEY_STOP
},
240 { 0x000000003c00ffeell
, KEY_PLAYPAUSE
},
241 { 0x000000000800ffeell
, KEY_FASTFORWARD
},
242 { 0x000000000600ffeell
, KEY_NEXT
},
243 { 0x000000010000ffeell
, KEY_RIGHT
},
244 { 0x000001000000ffeell
, KEY_LEFT
},
245 { 0x000000003d00ffeell
, KEY_SELECT
},
246 { 0x000100000000ffeell
, KEY_VOLUMEUP
},
247 { 0x010000000000ffeell
, KEY_VOLUMEDOWN
},
248 { 0x000000000100ffeell
, KEY_MUTE
},
249 /* 0xffdc iMON MCE VFD */
250 { 0x00010000ffffffeell
, KEY_VOLUMEUP
},
251 { 0x01000000ffffffeell
, KEY_VOLUMEDOWN
},
252 { 0x00000001ffffffeell
, KEY_MUTE
},
253 { 0x0000000fffffffeell
, KEY_MEDIA
},
254 { 0x00000012ffffffeell
, KEY_UP
},
255 { 0x00000013ffffffeell
, KEY_DOWN
},
256 { 0x00000014ffffffeell
, KEY_LEFT
},
257 { 0x00000015ffffffeell
, KEY_RIGHT
},
258 { 0x00000016ffffffeell
, KEY_ENTER
},
259 { 0x00000017ffffffeell
, KEY_ESC
},
260 /* iMON Knob values */
261 { 0x000100ffffffffeell
, KEY_VOLUMEUP
},
262 { 0x010000ffffffffeell
, KEY_VOLUMEDOWN
},
263 { 0x000008ffffffffeell
, KEY_MUTE
},
268 static const struct imon_usb_dev_descr imon_OEM_VFD
= {
269 .flags
= IMON_NEED_20MS_PKT_DELAY
,
271 { 0x000000000f00ffeell
, KEY_MEDIA
}, /* Go */
272 { 0x000000001200ffeell
, KEY_UP
},
273 { 0x000000001300ffeell
, KEY_DOWN
},
274 { 0x000000001400ffeell
, KEY_LEFT
},
275 { 0x000000001500ffeell
, KEY_RIGHT
},
276 { 0x000000001600ffeell
, KEY_ENTER
},
277 { 0x000000001700ffeell
, KEY_ESC
},
278 { 0x000000001f00ffeell
, KEY_AUDIO
},
279 { 0x000000002b00ffeell
, KEY_EXIT
},
280 { 0x000000002c00ffeell
, KEY_SELECT
},
281 { 0x000000002d00ffeell
, KEY_MENU
},
282 { 0x000000000500ffeell
, KEY_PREVIOUS
},
283 { 0x000000000700ffeell
, KEY_REWIND
},
284 { 0x000000000400ffeell
, KEY_STOP
},
285 { 0x000000003c00ffeell
, KEY_PLAYPAUSE
},
286 { 0x000000000800ffeell
, KEY_FASTFORWARD
},
287 { 0x000000000600ffeell
, KEY_NEXT
},
288 { 0x000000010000ffeell
, KEY_RIGHT
},
289 { 0x000001000000ffeell
, KEY_LEFT
},
290 { 0x000000003d00ffeell
, KEY_SELECT
},
291 { 0x000100000000ffeell
, KEY_VOLUMEUP
},
292 { 0x010000000000ffeell
, KEY_VOLUMEDOWN
},
293 { 0x000000000100ffeell
, KEY_MUTE
},
294 /* 0xffdc iMON MCE VFD */
295 { 0x00010000ffffffeell
, KEY_VOLUMEUP
},
296 { 0x01000000ffffffeell
, KEY_VOLUMEDOWN
},
297 { 0x00000001ffffffeell
, KEY_MUTE
},
298 { 0x0000000fffffffeell
, KEY_MEDIA
},
299 { 0x00000012ffffffeell
, KEY_UP
},
300 { 0x00000013ffffffeell
, KEY_DOWN
},
301 { 0x00000014ffffffeell
, KEY_LEFT
},
302 { 0x00000015ffffffeell
, KEY_RIGHT
},
303 { 0x00000016ffffffeell
, KEY_ENTER
},
304 { 0x00000017ffffffeell
, KEY_ESC
},
305 /* iMON Knob values */
306 { 0x000100ffffffffeell
, KEY_VOLUMEUP
},
307 { 0x010000ffffffffeell
, KEY_VOLUMEDOWN
},
308 { 0x000008ffffffffeell
, KEY_MUTE
},
313 /* imon receiver front panel/knob key table for DH102*/
314 static const struct imon_usb_dev_descr imon_DH102
= {
315 .flags
= IMON_NO_FLAGS
,
317 { 0x000100000000ffeell
, KEY_VOLUMEUP
},
318 { 0x010000000000ffeell
, KEY_VOLUMEDOWN
},
319 { 0x000000010000ffeell
, KEY_MUTE
},
320 { 0x0000000f0000ffeell
, KEY_MEDIA
},
321 { 0x000000120000ffeell
, KEY_UP
},
322 { 0x000000130000ffeell
, KEY_DOWN
},
323 { 0x000000140000ffeell
, KEY_LEFT
},
324 { 0x000000150000ffeell
, KEY_RIGHT
},
325 { 0x000000160000ffeell
, KEY_ENTER
},
326 { 0x000000170000ffeell
, KEY_ESC
},
327 { 0x0000002b0000ffeell
, KEY_EXIT
},
328 { 0x0000002c0000ffeell
, KEY_SELECT
},
329 { 0x0000002d0000ffeell
, KEY_MENU
},
334 static const struct imon_usb_dev_descr imon_ir_raw
= {
335 .flags
= IMON_IR_RAW
,
339 * USB Device ID for iMON USB Control Boards
341 * The Windows drivers contain 6 different inf files, more or less one for
342 * each new device until the 0x0034-0x0046 devices, which all use the same
343 * driver. Some of the devices in the 34-46 range haven't been definitively
344 * identified yet. Early devices have either a TriGem Computer, Inc. or a
345 * Samsung vendor ID (0x0aa8 and 0x04e8 respectively), while all later
346 * devices use the SoundGraph vendor ID (0x15c2). This driver only supports
347 * the ffdc and later devices, which do onboard decoding.
349 static struct usb_device_id imon_usb_id_table
[] = {
351 * Several devices with this same device ID, all use iMON_PAD.inf
352 * SoundGraph iMON PAD (IR & VFD)
353 * SoundGraph iMON PAD (IR & LCD)
354 * SoundGraph iMON Knob (IR only)
356 { USB_DEVICE(0x15c2, 0xffdc),
357 .driver_info
= (unsigned long)&imon_default_table
},
360 * Newer devices, all driven by the latest iMON Windows driver, full
361 * list of device IDs extracted via 'strings Setup/data1.hdr |grep 15c2'
362 * Need user input to fill in details on unknown devices.
364 /* SoundGraph iMON OEM Touch LCD (IR & 7" VGA LCD) */
365 { USB_DEVICE(0x15c2, 0x0034),
366 .driver_info
= (unsigned long)&imon_DH102
},
367 /* SoundGraph iMON OEM Touch LCD (IR & 4.3" VGA LCD) */
368 { USB_DEVICE(0x15c2, 0x0035),
369 .driver_info
= (unsigned long)&imon_default_table
},
370 /* SoundGraph iMON OEM VFD (IR & VFD) */
371 { USB_DEVICE(0x15c2, 0x0036),
372 .driver_info
= (unsigned long)&imon_OEM_VFD
},
373 /* device specifics unknown */
374 { USB_DEVICE(0x15c2, 0x0037),
375 .driver_info
= (unsigned long)&imon_default_table
},
376 /* SoundGraph iMON OEM LCD (IR & LCD) */
377 { USB_DEVICE(0x15c2, 0x0038),
378 .driver_info
= (unsigned long)&imon_default_table
},
379 /* SoundGraph iMON UltraBay (IR & LCD) */
380 { USB_DEVICE(0x15c2, 0x0039),
381 .driver_info
= (unsigned long)&imon_default_table
},
382 /* device specifics unknown */
383 { USB_DEVICE(0x15c2, 0x003a),
384 .driver_info
= (unsigned long)&imon_default_table
},
385 /* device specifics unknown */
386 { USB_DEVICE(0x15c2, 0x003b),
387 .driver_info
= (unsigned long)&imon_default_table
},
388 /* SoundGraph iMON OEM Inside (IR only) */
389 { USB_DEVICE(0x15c2, 0x003c),
390 .driver_info
= (unsigned long)&imon_default_table
},
391 /* device specifics unknown */
392 { USB_DEVICE(0x15c2, 0x003d),
393 .driver_info
= (unsigned long)&imon_default_table
},
394 /* device specifics unknown */
395 { USB_DEVICE(0x15c2, 0x003e),
396 .driver_info
= (unsigned long)&imon_default_table
},
397 /* device specifics unknown */
398 { USB_DEVICE(0x15c2, 0x003f),
399 .driver_info
= (unsigned long)&imon_default_table
},
400 /* device specifics unknown */
401 { USB_DEVICE(0x15c2, 0x0040),
402 .driver_info
= (unsigned long)&imon_default_table
},
403 /* SoundGraph iMON MINI (IR only) */
404 { USB_DEVICE(0x15c2, 0x0041),
405 .driver_info
= (unsigned long)&imon_default_table
},
406 /* Antec Veris Multimedia Station EZ External (IR only) */
407 { USB_DEVICE(0x15c2, 0x0042),
408 .driver_info
= (unsigned long)&imon_default_table
},
409 /* Antec Veris Multimedia Station Basic Internal (IR only) */
410 { USB_DEVICE(0x15c2, 0x0043),
411 .driver_info
= (unsigned long)&imon_default_table
},
412 /* Antec Veris Multimedia Station Elite (IR & VFD) */
413 { USB_DEVICE(0x15c2, 0x0044),
414 .driver_info
= (unsigned long)&imon_default_table
},
415 /* Antec Veris Multimedia Station Premiere (IR & LCD) */
416 { USB_DEVICE(0x15c2, 0x0045),
417 .driver_info
= (unsigned long)&imon_default_table
},
418 /* device specifics unknown */
419 { USB_DEVICE(0x15c2, 0x0046),
420 .driver_info
= (unsigned long)&imon_default_table
},
421 /* TriGem iMON (IR only) -- TG_iMON.inf */
422 { USB_DEVICE(0x0aa8, 0x8001),
423 .driver_info
= (unsigned long)&imon_ir_raw
},
424 /* SoundGraph iMON (IR only) -- sg_imon.inf */
425 { USB_DEVICE(0x04e8, 0xff30),
426 .driver_info
= (unsigned long)&imon_ir_raw
},
427 /* SoundGraph iMON VFD (IR & VFD) -- iMON_VFD.inf */
428 { USB_DEVICE(0x0aa8, 0xffda),
429 .driver_info
= (unsigned long)&imon_ir_raw
},
430 /* SoundGraph iMON SS (IR & VFD) -- iMON_SS.inf */
431 { USB_DEVICE(0x15c2, 0xffda),
432 .driver_info
= (unsigned long)&imon_ir_raw
},
436 /* USB Device data */
437 static struct usb_driver imon_driver
= {
440 .disconnect
= imon_disconnect
,
441 .suspend
= imon_suspend
,
442 .resume
= imon_resume
,
443 .id_table
= imon_usb_id_table
,
446 /* to prevent races between open() and disconnect(), probing, etc */
447 static DEFINE_MUTEX(driver_lock
);
449 /* Module bookkeeping bits */
450 MODULE_AUTHOR(MOD_AUTHOR
);
451 MODULE_DESCRIPTION(MOD_DESC
);
452 MODULE_VERSION(MOD_VERSION
);
453 MODULE_LICENSE("GPL");
454 MODULE_DEVICE_TABLE(usb
, imon_usb_id_table
);
457 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
458 MODULE_PARM_DESC(debug
, "Debug messages: 0=no, 1=yes (default: no)");
460 /* lcd, vfd, vga or none? should be auto-detected, but can be overridden... */
461 static int display_type
;
462 module_param(display_type
, int, S_IRUGO
);
463 MODULE_PARM_DESC(display_type
, "Type of attached display. 0=autodetect, 1=vfd, 2=lcd, 3=vga, 4=none (default: autodetect)");
465 static int pad_stabilize
= 1;
466 module_param(pad_stabilize
, int, S_IRUGO
| S_IWUSR
);
467 MODULE_PARM_DESC(pad_stabilize
, "Apply stabilization algorithm to iMON PAD presses in arrow key mode. 0=disable, 1=enable (default).");
470 * In certain use cases, mouse mode isn't really helpful, and could actually
471 * cause confusion, so allow disabling it when the IR device is open.
474 module_param(nomouse
, bool, S_IRUGO
| S_IWUSR
);
475 MODULE_PARM_DESC(nomouse
, "Disable mouse input device mode when IR device is open. 0=don't disable, 1=disable. (default: don't disable)");
477 /* threshold at which a pad push registers as an arrow key in kbd mode */
478 static int pad_thresh
;
479 module_param(pad_thresh
, int, S_IRUGO
| S_IWUSR
);
480 MODULE_PARM_DESC(pad_thresh
, "Threshold at which a pad push registers as an arrow key in kbd mode (default: 28)");
483 static void free_imon_context(struct imon_context
*ictx
)
485 struct device
*dev
= ictx
->dev
;
487 usb_free_urb(ictx
->tx_urb
);
488 usb_free_urb(ictx
->rx_urb_intf0
);
489 usb_free_urb(ictx
->rx_urb_intf1
);
492 dev_dbg(dev
, "%s: iMON context freed\n", __func__
);
496 * Called when the Display device (e.g. /dev/lcd0)
497 * is opened by the application.
499 static int display_open(struct inode
*inode
, struct file
*file
)
501 struct usb_interface
*interface
;
502 struct imon_context
*ictx
= NULL
;
506 /* prevent races with disconnect */
507 mutex_lock(&driver_lock
);
509 subminor
= iminor(inode
);
510 interface
= usb_find_interface(&imon_driver
, subminor
);
512 pr_err("could not find interface for minor %d\n", subminor
);
516 ictx
= usb_get_intfdata(interface
);
519 pr_err("no context found for minor %d\n", subminor
);
524 mutex_lock(&ictx
->lock
);
526 if (!ictx
->display_supported
) {
527 pr_err("display not supported by device\n");
529 } else if (ictx
->display_isopen
) {
530 pr_err("display port is already open\n");
533 ictx
->display_isopen
= true;
534 file
->private_data
= ictx
;
535 dev_dbg(ictx
->dev
, "display port opened\n");
538 mutex_unlock(&ictx
->lock
);
541 mutex_unlock(&driver_lock
);
546 * Called when the display device (e.g. /dev/lcd0)
547 * is closed by the application.
549 static int display_close(struct inode
*inode
, struct file
*file
)
551 struct imon_context
*ictx
= NULL
;
554 ictx
= file
->private_data
;
557 pr_err("no context for device\n");
561 mutex_lock(&ictx
->lock
);
563 if (!ictx
->display_supported
) {
564 pr_err("display not supported by device\n");
566 } else if (!ictx
->display_isopen
) {
567 pr_err("display is not open\n");
570 ictx
->display_isopen
= false;
571 dev_dbg(ictx
->dev
, "display port closed\n");
574 mutex_unlock(&ictx
->lock
);
579 * Sends a packet to the device -- this function must be called with
580 * ictx->lock held, or its unlock/lock sequence while waiting for tx
581 * to complete can/will lead to a deadlock.
583 static int send_packet(struct imon_context
*ictx
)
586 unsigned long timeout
;
589 struct usb_ctrlrequest
*control_req
= NULL
;
591 /* Check if we need to use control or interrupt urb */
592 if (!ictx
->tx_control
) {
593 pipe
= usb_sndintpipe(ictx
->usbdev_intf0
,
594 ictx
->tx_endpoint
->bEndpointAddress
);
595 interval
= ictx
->tx_endpoint
->bInterval
;
597 usb_fill_int_urb(ictx
->tx_urb
, ictx
->usbdev_intf0
, pipe
,
599 sizeof(ictx
->usb_tx_buf
),
600 usb_tx_callback
, ictx
, interval
);
602 ictx
->tx_urb
->actual_length
= 0;
604 /* fill request into kmalloc'ed space: */
605 control_req
= kmalloc(sizeof(struct usb_ctrlrequest
),
607 if (control_req
== NULL
)
610 /* setup packet is '21 09 0200 0001 0008' */
611 control_req
->bRequestType
= 0x21;
612 control_req
->bRequest
= 0x09;
613 control_req
->wValue
= cpu_to_le16(0x0200);
614 control_req
->wIndex
= cpu_to_le16(0x0001);
615 control_req
->wLength
= cpu_to_le16(0x0008);
617 /* control pipe is endpoint 0x00 */
618 pipe
= usb_sndctrlpipe(ictx
->usbdev_intf0
, 0);
620 /* build the control urb */
621 usb_fill_control_urb(ictx
->tx_urb
, ictx
->usbdev_intf0
,
622 pipe
, (unsigned char *)control_req
,
624 sizeof(ictx
->usb_tx_buf
),
625 usb_tx_callback
, ictx
);
626 ictx
->tx_urb
->actual_length
= 0;
629 reinit_completion(&ictx
->tx
.finished
);
630 ictx
->tx
.busy
= true;
631 smp_rmb(); /* ensure later readers know we're busy */
633 retval
= usb_submit_urb(ictx
->tx_urb
, GFP_KERNEL
);
635 ictx
->tx
.busy
= false;
636 smp_rmb(); /* ensure later readers know we're not busy */
637 pr_err_ratelimited("error submitting urb(%d)\n", retval
);
639 /* Wait for transmission to complete (or abort) */
640 mutex_unlock(&ictx
->lock
);
641 retval
= wait_for_completion_interruptible(
644 usb_kill_urb(ictx
->tx_urb
);
645 pr_err_ratelimited("task interrupted\n");
647 mutex_lock(&ictx
->lock
);
649 retval
= ictx
->tx
.status
;
651 pr_err_ratelimited("packet tx failed (%d)\n", retval
);
657 * Induce a mandatory delay before returning, as otherwise,
658 * send_packet can get called so rapidly as to overwhelm the device,
659 * particularly on faster systems and/or those with quirky usb.
661 timeout
= msecs_to_jiffies(ictx
->send_packet_delay
);
662 set_current_state(TASK_INTERRUPTIBLE
);
663 schedule_timeout(timeout
);
669 * Sends an associate packet to the iMON 2.4G.
671 * This might not be such a good idea, since it has an id collision with
672 * some versions of the "IR & VFD" combo. The only way to determine if it
673 * is an RF version is to look at the product description string. (Which
674 * we currently do not fetch).
676 static int send_associate_24g(struct imon_context
*ictx
)
679 const unsigned char packet
[8] = { 0x01, 0x00, 0x00, 0x00,
680 0x00, 0x00, 0x00, 0x20 };
683 pr_err("no context for device\n");
687 if (!ictx
->dev_present_intf0
) {
688 pr_err("no iMON device present\n");
692 memcpy(ictx
->usb_tx_buf
, packet
, sizeof(packet
));
693 retval
= send_packet(ictx
);
699 * Sends packets to setup and show clock on iMON display
701 * Arguments: year - last 2 digits of year, month - 1..12,
702 * day - 1..31, dow - day of the week (0-Sun...6-Sat),
703 * hour - 0..23, minute - 0..59, second - 0..59
705 static int send_set_imon_clock(struct imon_context
*ictx
,
706 unsigned int year
, unsigned int month
,
707 unsigned int day
, unsigned int dow
,
708 unsigned int hour
, unsigned int minute
,
711 unsigned char clock_enable_pkt
[IMON_CLOCK_ENABLE_PACKETS
][8];
716 pr_err("no context for device\n");
720 switch (ictx
->display_type
) {
721 case IMON_DISPLAY_TYPE_LCD
:
722 clock_enable_pkt
[0][0] = 0x80;
723 clock_enable_pkt
[0][1] = year
;
724 clock_enable_pkt
[0][2] = month
-1;
725 clock_enable_pkt
[0][3] = day
;
726 clock_enable_pkt
[0][4] = hour
;
727 clock_enable_pkt
[0][5] = minute
;
728 clock_enable_pkt
[0][6] = second
;
730 clock_enable_pkt
[1][0] = 0x80;
731 clock_enable_pkt
[1][1] = 0;
732 clock_enable_pkt
[1][2] = 0;
733 clock_enable_pkt
[1][3] = 0;
734 clock_enable_pkt
[1][4] = 0;
735 clock_enable_pkt
[1][5] = 0;
736 clock_enable_pkt
[1][6] = 0;
738 if (ictx
->product
== 0xffdc) {
739 clock_enable_pkt
[0][7] = 0x50;
740 clock_enable_pkt
[1][7] = 0x51;
742 clock_enable_pkt
[0][7] = 0x88;
743 clock_enable_pkt
[1][7] = 0x8a;
748 case IMON_DISPLAY_TYPE_VFD
:
749 clock_enable_pkt
[0][0] = year
;
750 clock_enable_pkt
[0][1] = month
-1;
751 clock_enable_pkt
[0][2] = day
;
752 clock_enable_pkt
[0][3] = dow
;
753 clock_enable_pkt
[0][4] = hour
;
754 clock_enable_pkt
[0][5] = minute
;
755 clock_enable_pkt
[0][6] = second
;
756 clock_enable_pkt
[0][7] = 0x40;
758 clock_enable_pkt
[1][0] = 0;
759 clock_enable_pkt
[1][1] = 0;
760 clock_enable_pkt
[1][2] = 1;
761 clock_enable_pkt
[1][3] = 0;
762 clock_enable_pkt
[1][4] = 0;
763 clock_enable_pkt
[1][5] = 0;
764 clock_enable_pkt
[1][6] = 0;
765 clock_enable_pkt
[1][7] = 0x42;
773 for (i
= 0; i
< IMON_CLOCK_ENABLE_PACKETS
; i
++) {
774 memcpy(ictx
->usb_tx_buf
, clock_enable_pkt
[i
], 8);
775 retval
= send_packet(ictx
);
777 pr_err("send_packet failed for packet %d\n", i
);
786 * These are the sysfs functions to handle the association on the iMON 2.4G LT.
788 static ssize_t
show_associate_remote(struct device
*d
,
789 struct device_attribute
*attr
,
792 struct imon_context
*ictx
= dev_get_drvdata(d
);
797 mutex_lock(&ictx
->lock
);
798 if (ictx
->rf_isassociating
)
799 strcpy(buf
, "associating\n");
801 strcpy(buf
, "closed\n");
803 dev_info(d
, "Visit http://www.lirc.org/html/imon-24g.html for instructions on how to associate your iMON 2.4G DT/LT remote\n");
804 mutex_unlock(&ictx
->lock
);
808 static ssize_t
store_associate_remote(struct device
*d
,
809 struct device_attribute
*attr
,
810 const char *buf
, size_t count
)
812 struct imon_context
*ictx
;
814 ictx
= dev_get_drvdata(d
);
819 mutex_lock(&ictx
->lock
);
820 ictx
->rf_isassociating
= true;
821 send_associate_24g(ictx
);
822 mutex_unlock(&ictx
->lock
);
828 * sysfs functions to control internal imon clock
830 static ssize_t
show_imon_clock(struct device
*d
,
831 struct device_attribute
*attr
, char *buf
)
833 struct imon_context
*ictx
= dev_get_drvdata(d
);
839 mutex_lock(&ictx
->lock
);
841 if (!ictx
->display_supported
) {
842 len
= snprintf(buf
, PAGE_SIZE
, "Not supported.");
844 len
= snprintf(buf
, PAGE_SIZE
,
845 "To set the clock on your iMON display:\n"
846 "# date \"+%%y %%m %%d %%w %%H %%M %%S\" > imon_clock\n"
847 "%s", ictx
->display_isopen
?
848 "\nNOTE: imon device must be closed\n" : "");
851 mutex_unlock(&ictx
->lock
);
856 static ssize_t
store_imon_clock(struct device
*d
,
857 struct device_attribute
*attr
,
858 const char *buf
, size_t count
)
860 struct imon_context
*ictx
= dev_get_drvdata(d
);
862 unsigned int year
, month
, day
, dow
, hour
, minute
, second
;
867 mutex_lock(&ictx
->lock
);
869 if (!ictx
->display_supported
) {
872 } else if (ictx
->display_isopen
) {
877 if (sscanf(buf
, "%u %u %u %u %u %u %u", &year
, &month
, &day
, &dow
,
878 &hour
, &minute
, &second
) != 7) {
883 if ((month
< 1 || month
> 12) ||
884 (day
< 1 || day
> 31) || (dow
> 6) ||
885 (hour
> 23) || (minute
> 59) || (second
> 59)) {
890 retval
= send_set_imon_clock(ictx
, year
, month
, day
, dow
,
891 hour
, minute
, second
);
897 mutex_unlock(&ictx
->lock
);
903 static DEVICE_ATTR(imon_clock
, S_IWUSR
| S_IRUGO
, show_imon_clock
,
906 static DEVICE_ATTR(associate_remote
, S_IWUSR
| S_IRUGO
, show_associate_remote
,
907 store_associate_remote
);
909 static struct attribute
*imon_display_sysfs_entries
[] = {
910 &dev_attr_imon_clock
.attr
,
914 static const struct attribute_group imon_display_attr_group
= {
915 .attrs
= imon_display_sysfs_entries
918 static struct attribute
*imon_rf_sysfs_entries
[] = {
919 &dev_attr_associate_remote
.attr
,
923 static const struct attribute_group imon_rf_attr_group
= {
924 .attrs
= imon_rf_sysfs_entries
928 * Writes data to the VFD. The iMON VFD is 2x16 characters
929 * and requires data in 5 consecutive USB interrupt packets,
930 * each packet but the last carrying 7 bytes.
932 * I don't know if the VFD board supports features such as
933 * scrolling, clearing rows, blanking, etc. so at
934 * the caller must provide a full screen of data. If fewer
935 * than 32 bytes are provided spaces will be appended to
936 * generate a full screen.
938 static ssize_t
vfd_write(struct file
*file
, const char __user
*buf
,
939 size_t n_bytes
, loff_t
*pos
)
945 struct imon_context
*ictx
;
946 const unsigned char vfd_packet6
[] = {
947 0x01, 0x00, 0x00, 0x00, 0x00, 0xFF, 0xFF };
949 ictx
= file
->private_data
;
951 pr_err_ratelimited("no context for device\n");
955 mutex_lock(&ictx
->lock
);
957 if (!ictx
->dev_present_intf0
) {
958 pr_err_ratelimited("no iMON device present\n");
963 if (n_bytes
<= 0 || n_bytes
> 32) {
964 pr_err_ratelimited("invalid payload size\n");
969 if (copy_from_user(ictx
->tx
.data_buf
, buf
, n_bytes
)) {
974 /* Pad with spaces */
975 for (i
= n_bytes
; i
< 32; ++i
)
976 ictx
->tx
.data_buf
[i
] = ' ';
978 for (i
= 32; i
< 35; ++i
)
979 ictx
->tx
.data_buf
[i
] = 0xFF;
985 memcpy(ictx
->usb_tx_buf
, ictx
->tx
.data_buf
+ offset
, 7);
986 ictx
->usb_tx_buf
[7] = (unsigned char) seq
;
988 retval
= send_packet(ictx
);
990 pr_err_ratelimited("send packet #%d failed\n", seq
/ 2);
997 } while (offset
< 35);
1000 memcpy(ictx
->usb_tx_buf
, &vfd_packet6
, sizeof(vfd_packet6
));
1001 ictx
->usb_tx_buf
[7] = (unsigned char) seq
;
1002 retval
= send_packet(ictx
);
1004 pr_err_ratelimited("send packet #%d failed\n", seq
/ 2);
1007 mutex_unlock(&ictx
->lock
);
1009 return (!retval
) ? n_bytes
: retval
;
1013 * Writes data to the LCD. The iMON OEM LCD screen expects 8-byte
1014 * packets. We accept data as 16 hexadecimal digits, followed by a
1015 * newline (to make it easy to drive the device from a command-line
1016 * -- even though the actual binary data is a bit complicated).
1018 * The device itself is not a "traditional" text-mode display. It's
1019 * actually a 16x96 pixel bitmap display. That means if you want to
1020 * display text, you've got to have your own "font" and translate the
1021 * text into bitmaps for display. This is really flexible (you can
1022 * display whatever diacritics you need, and so on), but it's also
1023 * a lot more complicated than most LCDs...
1025 static ssize_t
lcd_write(struct file
*file
, const char __user
*buf
,
1026 size_t n_bytes
, loff_t
*pos
)
1029 struct imon_context
*ictx
;
1031 ictx
= file
->private_data
;
1033 pr_err_ratelimited("no context for device\n");
1037 mutex_lock(&ictx
->lock
);
1039 if (!ictx
->display_supported
) {
1040 pr_err_ratelimited("no iMON display present\n");
1046 pr_err_ratelimited("invalid payload size: %d (expected 8)\n",
1052 if (copy_from_user(ictx
->usb_tx_buf
, buf
, 8)) {
1057 retval
= send_packet(ictx
);
1059 pr_err_ratelimited("send packet failed!\n");
1062 dev_dbg(ictx
->dev
, "%s: write %d bytes to LCD\n",
1063 __func__
, (int) n_bytes
);
1066 mutex_unlock(&ictx
->lock
);
1067 return (!retval
) ? n_bytes
: retval
;
1071 * Callback function for USB core API: transmit data
1073 static void usb_tx_callback(struct urb
*urb
)
1075 struct imon_context
*ictx
;
1079 ictx
= (struct imon_context
*)urb
->context
;
1083 ictx
->tx
.status
= urb
->status
;
1085 /* notify waiters that write has finished */
1086 ictx
->tx
.busy
= false;
1087 smp_rmb(); /* ensure later readers know we're not busy */
1088 complete(&ictx
->tx
.finished
);
1092 * report touchscreen input
1094 static void imon_touch_display_timeout(unsigned long data
)
1096 struct imon_context
*ictx
= (struct imon_context
*)data
;
1098 if (ictx
->display_type
!= IMON_DISPLAY_TYPE_VGA
)
1101 input_report_abs(ictx
->touch
, ABS_X
, ictx
->touch_x
);
1102 input_report_abs(ictx
->touch
, ABS_Y
, ictx
->touch_y
);
1103 input_report_key(ictx
->touch
, BTN_TOUCH
, 0x00);
1104 input_sync(ictx
->touch
);
1108 * iMON IR receivers support two different signal sets -- those used by
1109 * the iMON remotes, and those used by the Windows MCE remotes (which is
1110 * really just RC-6), but only one or the other at a time, as the signals
1111 * are decoded onboard the receiver.
1113 * This function gets called two different ways, one way is from
1114 * rc_register_device, for initial protocol selection/setup, and the other is
1115 * via a userspace-initiated protocol change request, either by direct sysfs
1116 * prodding or by something like ir-keytable. In the rc_register_device case,
1117 * the imon context lock is already held, but when initiated from userspace,
1118 * it is not, so we must acquire it prior to calling send_packet, which
1119 * requires that the lock is held.
1121 static int imon_ir_change_protocol(struct rc_dev
*rc
, u64
*rc_proto
)
1124 struct imon_context
*ictx
= rc
->priv
;
1125 struct device
*dev
= ictx
->dev
;
1126 bool unlock
= false;
1127 unsigned char ir_proto_packet
[] = {
1128 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x86 };
1130 if (*rc_proto
&& !(*rc_proto
& rc
->allowed_protocols
))
1131 dev_warn(dev
, "Looks like you're trying to use an IR protocol this device does not support\n");
1133 if (*rc_proto
& RC_PROTO_BIT_RC6_MCE
) {
1134 dev_dbg(dev
, "Configuring IR receiver for MCE protocol\n");
1135 ir_proto_packet
[0] = 0x01;
1136 *rc_proto
= RC_PROTO_BIT_RC6_MCE
;
1137 } else if (*rc_proto
& RC_PROTO_BIT_OTHER
) {
1138 dev_dbg(dev
, "Configuring IR receiver for iMON protocol\n");
1140 dev_dbg(dev
, "PAD stabilize functionality disabled\n");
1141 /* ir_proto_packet[0] = 0x00; // already the default */
1142 *rc_proto
= RC_PROTO_BIT_OTHER
;
1144 dev_warn(dev
, "Unsupported IR protocol specified, overriding to iMON IR protocol\n");
1146 dev_dbg(dev
, "PAD stabilize functionality disabled\n");
1147 /* ir_proto_packet[0] = 0x00; // already the default */
1148 *rc_proto
= RC_PROTO_BIT_OTHER
;
1151 memcpy(ictx
->usb_tx_buf
, &ir_proto_packet
, sizeof(ir_proto_packet
));
1153 if (!mutex_is_locked(&ictx
->lock
)) {
1155 mutex_lock(&ictx
->lock
);
1158 retval
= send_packet(ictx
);
1162 ictx
->rc_proto
= *rc_proto
;
1163 ictx
->pad_mouse
= false;
1167 mutex_unlock(&ictx
->lock
);
1172 static inline int tv2int(const struct timeval
*a
, const struct timeval
*b
)
1177 if (b
->tv_usec
> a
->tv_usec
) {
1182 usecs
+= a
->tv_usec
- b
->tv_usec
;
1184 sec
+= a
->tv_sec
- b
->tv_sec
;
1196 * The directional pad behaves a bit differently, depending on whether this is
1197 * one of the older ffdc devices or a newer device. Newer devices appear to
1198 * have a higher resolution matrix for more precise mouse movement, but it
1199 * makes things overly sensitive in keyboard mode, so we do some interesting
1200 * contortions to make it less touchy. Older devices run through the same
1201 * routine with shorter timeout and a smaller threshold.
1203 static int stabilize(int a
, int b
, u16 timeout
, u16 threshold
)
1206 static struct timeval prev_time
= {0, 0};
1207 static struct timeval hit_time
= {0, 0};
1208 static int x
, y
, prev_result
, hits
;
1212 do_gettimeofday(&ct
);
1213 msec
= tv2int(&ct
, &prev_time
);
1214 msec_hit
= tv2int(&ct
, &hit_time
);
1227 if (abs(x
) > threshold
|| abs(y
) > threshold
) {
1228 if (abs(y
) > abs(x
))
1229 result
= (y
> 0) ? 0x7F : 0x80;
1231 result
= (x
> 0) ? 0x7F00 : 0x8000;
1236 if (result
== prev_result
) {
1242 y
= 17 * threshold
/ 30;
1245 y
-= 17 * threshold
/ 30;
1248 x
= 17 * threshold
/ 30;
1251 x
-= 17 * threshold
/ 30;
1256 if (hits
== 2 && msec_hit
< timeout
) {
1261 prev_result
= result
;
1270 static u32
imon_remote_key_lookup(struct imon_context
*ictx
, u32 scancode
)
1274 bool is_release_code
= false;
1276 /* Look for the initial press of a button */
1277 keycode
= rc_g_keycode_from_table(ictx
->rdev
, scancode
);
1278 ictx
->rc_toggle
= 0x0;
1279 ictx
->rc_scancode
= scancode
;
1281 /* Look for the release of a button */
1282 if (keycode
== KEY_RESERVED
) {
1283 release
= scancode
& ~0x4000;
1284 keycode
= rc_g_keycode_from_table(ictx
->rdev
, release
);
1285 if (keycode
!= KEY_RESERVED
)
1286 is_release_code
= true;
1289 ictx
->release_code
= is_release_code
;
1294 static u32
imon_mce_key_lookup(struct imon_context
*ictx
, u32 scancode
)
1298 #define MCE_KEY_MASK 0x7000
1299 #define MCE_TOGGLE_BIT 0x8000
1302 * On some receivers, mce keys decode to 0x8000f04xx and 0x8000f84xx
1303 * (the toggle bit flipping between alternating key presses), while
1304 * on other receivers, we see 0x8000f74xx and 0x8000ff4xx. To keep
1305 * the table trim, we always or in the bits to look up 0x8000ff4xx,
1306 * but we can't or them into all codes, as some keys are decoded in
1307 * a different way w/o the same use of the toggle bit...
1309 if (scancode
& 0x80000000)
1310 scancode
= scancode
| MCE_KEY_MASK
| MCE_TOGGLE_BIT
;
1312 ictx
->rc_scancode
= scancode
;
1313 keycode
= rc_g_keycode_from_table(ictx
->rdev
, scancode
);
1315 /* not used in mce mode, but make sure we know its false */
1316 ictx
->release_code
= false;
1321 static u32
imon_panel_key_lookup(struct imon_context
*ictx
, u64 code
)
1324 u32 keycode
= KEY_RESERVED
;
1325 struct imon_panel_key_table
*key_table
= ictx
->dev_descr
->key_table
;
1327 for (i
= 0; key_table
[i
].hw_code
!= 0; i
++) {
1328 if (key_table
[i
].hw_code
== (code
| 0xffee)) {
1329 keycode
= key_table
[i
].keycode
;
1333 ictx
->release_code
= false;
1337 static bool imon_mouse_event(struct imon_context
*ictx
,
1338 unsigned char *buf
, int len
)
1340 signed char rel_x
= 0x00, rel_y
= 0x00;
1342 bool mouse_input
= true;
1344 unsigned long flags
;
1346 spin_lock_irqsave(&ictx
->kc_lock
, flags
);
1348 /* newer iMON device PAD or mouse button */
1349 if (ictx
->product
!= 0xffdc && (buf
[0] & 0x01) && len
== 5) {
1353 /* 0xffdc iMON PAD or mouse button input */
1354 } else if (ictx
->product
== 0xffdc && (buf
[0] & 0x40) &&
1355 !((buf
[1] & 0x01) || ((buf
[1] >> 2) & 0x01))) {
1356 rel_x
= (buf
[1] & 0x08) | (buf
[1] & 0x10) >> 2 |
1357 (buf
[1] & 0x20) >> 4 | (buf
[1] & 0x40) >> 6;
1360 rel_x
= rel_x
+ rel_x
/ 2;
1361 rel_y
= (buf
[2] & 0x08) | (buf
[2] & 0x10) >> 2 |
1362 (buf
[2] & 0x20) >> 4 | (buf
[2] & 0x40) >> 6;
1365 rel_y
= rel_y
+ rel_y
/ 2;
1367 /* some ffdc devices decode mouse buttons differently... */
1368 } else if (ictx
->product
== 0xffdc && (buf
[0] == 0x68)) {
1370 /* ch+/- buttons, which we use for an emulated scroll wheel */
1371 } else if (ictx
->kc
== KEY_CHANNELUP
&& (buf
[2] & 0x40) != 0x40) {
1373 } else if (ictx
->kc
== KEY_CHANNELDOWN
&& (buf
[2] & 0x40) != 0x40) {
1376 mouse_input
= false;
1378 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1381 dev_dbg(ictx
->dev
, "sending mouse data via input subsystem\n");
1384 input_report_rel(ictx
->idev
, REL_WHEEL
, dir
);
1385 } else if (rel_x
|| rel_y
) {
1386 input_report_rel(ictx
->idev
, REL_X
, rel_x
);
1387 input_report_rel(ictx
->idev
, REL_Y
, rel_y
);
1389 input_report_key(ictx
->idev
, BTN_LEFT
, buf
[1] & 0x1);
1390 input_report_key(ictx
->idev
, BTN_RIGHT
,
1391 buf
[1] >> right_shift
& 0x1);
1393 input_sync(ictx
->idev
);
1394 spin_lock_irqsave(&ictx
->kc_lock
, flags
);
1395 ictx
->last_keycode
= ictx
->kc
;
1396 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1402 static void imon_touch_event(struct imon_context
*ictx
, unsigned char *buf
)
1404 mod_timer(&ictx
->ttimer
, jiffies
+ TOUCH_TIMEOUT
);
1405 ictx
->touch_x
= (buf
[0] << 4) | (buf
[1] >> 4);
1406 ictx
->touch_y
= 0xfff - ((buf
[2] << 4) | (buf
[1] & 0xf));
1407 input_report_abs(ictx
->touch
, ABS_X
, ictx
->touch_x
);
1408 input_report_abs(ictx
->touch
, ABS_Y
, ictx
->touch_y
);
1409 input_report_key(ictx
->touch
, BTN_TOUCH
, 0x01);
1410 input_sync(ictx
->touch
);
1413 static void imon_pad_to_keys(struct imon_context
*ictx
, unsigned char *buf
)
1416 signed char rel_x
= 0x00, rel_y
= 0x00;
1417 u16 timeout
, threshold
;
1418 u32 scancode
= KEY_RESERVED
;
1419 unsigned long flags
;
1422 * The imon directional pad functions more like a touchpad. Bytes 3 & 4
1423 * contain a position coordinate (x,y), with each component ranging
1424 * from -14 to 14. We want to down-sample this to only 4 discrete values
1425 * for up/down/left/right arrow keys. Also, when you get too close to
1426 * diagonals, it has a tendency to jump back and forth, so lets try to
1427 * ignore when they get too close.
1429 if (ictx
->product
!= 0xffdc) {
1430 /* first, pad to 8 bytes so it conforms with everything else */
1431 buf
[5] = buf
[6] = buf
[7] = 0;
1432 timeout
= 500; /* in msecs */
1433 /* (2*threshold) x (2*threshold) square */
1434 threshold
= pad_thresh
? pad_thresh
: 28;
1438 if (ictx
->rc_proto
== RC_PROTO_BIT_OTHER
&& pad_stabilize
) {
1439 if ((buf
[1] == 0) && ((rel_x
!= 0) || (rel_y
!= 0))) {
1440 dir
= stabilize((int)rel_x
, (int)rel_y
,
1441 timeout
, threshold
);
1443 spin_lock_irqsave(&ictx
->kc_lock
,
1445 ictx
->kc
= KEY_UNKNOWN
;
1446 spin_unlock_irqrestore(&ictx
->kc_lock
,
1450 buf
[2] = dir
& 0xFF;
1451 buf
[3] = (dir
>> 8) & 0xFF;
1452 scancode
= be32_to_cpu(*((__be32
*)buf
));
1456 * Hack alert: instead of using keycodes, we have
1457 * to use hard-coded scancodes here...
1459 if (abs(rel_y
) > abs(rel_x
)) {
1460 buf
[2] = (rel_y
> 0) ? 0x7F : 0x80;
1463 scancode
= 0x01007f00; /* KEY_DOWN */
1465 scancode
= 0x01008000; /* KEY_UP */
1468 buf
[3] = (rel_x
> 0) ? 0x7F : 0x80;
1470 scancode
= 0x0100007f; /* KEY_RIGHT */
1472 scancode
= 0x01000080; /* KEY_LEFT */
1477 * Handle on-board decoded pad events for e.g. older VFD/iMON-Pad
1478 * device (15c2:ffdc). The remote generates various codes from
1479 * 0x68nnnnB7 to 0x6AnnnnB7, the left mouse button generates
1480 * 0x688301b7 and the right one 0x688481b7. All other keys generate
1481 * 0x2nnnnnnn. Position coordinate is encoded in buf[1] and buf[2] with
1482 * reversed endianness. Extract direction from buffer, rotate endianness,
1483 * adjust sign and feed the values into stabilize(). The resulting codes
1484 * will be 0x01008000, 0x01007F00, which match the newer devices.
1487 timeout
= 10; /* in msecs */
1488 /* (2*threshold) x (2*threshold) square */
1489 threshold
= pad_thresh
? pad_thresh
: 15;
1492 rel_x
= (buf
[1] & 0x08) | (buf
[1] & 0x10) >> 2 |
1493 (buf
[1] & 0x20) >> 4 | (buf
[1] & 0x40) >> 6;
1497 rel_y
= (buf
[2] & 0x08) | (buf
[2] & 0x10) >> 2 |
1498 (buf
[2] & 0x20) >> 4 | (buf
[2] & 0x40) >> 6;
1503 buf
[1] = buf
[4] = buf
[5] = buf
[6] = buf
[7] = 0;
1505 if (ictx
->rc_proto
== RC_PROTO_BIT_OTHER
&& pad_stabilize
) {
1506 dir
= stabilize((int)rel_x
, (int)rel_y
,
1507 timeout
, threshold
);
1509 spin_lock_irqsave(&ictx
->kc_lock
, flags
);
1510 ictx
->kc
= KEY_UNKNOWN
;
1511 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1514 buf
[2] = dir
& 0xFF;
1515 buf
[3] = (dir
>> 8) & 0xFF;
1516 scancode
= be32_to_cpu(*((__be32
*)buf
));
1519 * Hack alert: instead of using keycodes, we have
1520 * to use hard-coded scancodes here...
1522 if (abs(rel_y
) > abs(rel_x
)) {
1523 buf
[2] = (rel_y
> 0) ? 0x7F : 0x80;
1526 scancode
= 0x01007f00; /* KEY_DOWN */
1528 scancode
= 0x01008000; /* KEY_UP */
1531 buf
[3] = (rel_x
> 0) ? 0x7F : 0x80;
1533 scancode
= 0x0100007f; /* KEY_RIGHT */
1535 scancode
= 0x01000080; /* KEY_LEFT */
1541 spin_lock_irqsave(&ictx
->kc_lock
, flags
);
1542 ictx
->kc
= imon_remote_key_lookup(ictx
, scancode
);
1543 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1548 * figure out if these is a press or a release. We don't actually
1549 * care about repeats, as those will be auto-generated within the IR
1550 * subsystem for repeating scancodes.
1552 static int imon_parse_press_type(struct imon_context
*ictx
,
1553 unsigned char *buf
, u8 ktype
)
1556 unsigned long flags
;
1558 spin_lock_irqsave(&ictx
->kc_lock
, flags
);
1560 /* key release of 0x02XXXXXX key */
1561 if (ictx
->kc
== KEY_RESERVED
&& buf
[0] == 0x02 && buf
[3] == 0x00)
1562 ictx
->kc
= ictx
->last_keycode
;
1564 /* mouse button release on (some) 0xffdc devices */
1565 else if (ictx
->kc
== KEY_RESERVED
&& buf
[0] == 0x68 && buf
[1] == 0x82 &&
1566 buf
[2] == 0x81 && buf
[3] == 0xb7)
1567 ictx
->kc
= ictx
->last_keycode
;
1569 /* mouse button release on (some other) 0xffdc devices */
1570 else if (ictx
->kc
== KEY_RESERVED
&& buf
[0] == 0x01 && buf
[1] == 0x00 &&
1571 buf
[2] == 0x81 && buf
[3] == 0xb7)
1572 ictx
->kc
= ictx
->last_keycode
;
1574 /* mce-specific button handling, no keyup events */
1575 else if (ktype
== IMON_KEY_MCE
) {
1576 ictx
->rc_toggle
= buf
[2];
1579 /* incoherent or irrelevant data */
1580 } else if (ictx
->kc
== KEY_RESERVED
)
1581 press_type
= -EINVAL
;
1583 /* key release of 0xXXXXXXb7 key */
1584 else if (ictx
->release_code
)
1587 /* this is a button press */
1591 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1597 * Process the incoming packet
1600 * Convert bit count to time duration (in us) and submit
1601 * the value to lirc_dev.
1603 static void submit_data(struct imon_context
*context
)
1605 DEFINE_IR_RAW_EVENT(ev
);
1607 ev
.pulse
= context
->rx
.prev_bit
;
1608 ev
.duration
= US_TO_NS(context
->rx
.count
* BIT_DURATION
);
1609 ir_raw_event_store_with_filter(context
->rdev
, &ev
);
1613 * Process the incoming packet
1615 static void imon_incoming_ir_raw(struct imon_context
*context
,
1616 struct urb
*urb
, int intf
)
1618 int len
= urb
->actual_length
;
1619 unsigned char *buf
= urb
->transfer_buffer
;
1620 struct device
*dev
= context
->dev
;
1625 dev_warn(dev
, "imon %s: invalid incoming packet size (len = %d, intf%d)\n",
1626 __func__
, len
, intf
);
1631 dev_info(dev
, "raw packet: %*ph\n", len
, buf
);
1633 * Translate received data to pulse and space lengths.
1634 * Received data is active low, i.e. pulses are 0 and
1637 * My original algorithm was essentially similar to
1638 * Changwoo Ryu's with the exception that he switched
1639 * the incoming bits to active high and also fed an
1640 * initial space to LIRC at the start of a new sequence
1641 * if the previous bit was a pulse.
1643 * I've decided to adopt his algorithm.
1646 if (buf
[7] == 1 && context
->rx
.initial_space
) {
1647 /* LIRC requires a leading space */
1648 context
->rx
.prev_bit
= 0;
1649 context
->rx
.count
= 4;
1650 submit_data(context
);
1651 context
->rx
.count
= 0;
1654 for (octet
= 0; octet
< 5; ++octet
) {
1656 for (bit
= 0; bit
< 8; ++bit
) {
1657 int curr_bit
= !(buf
[octet
] & mask
);
1659 if (curr_bit
!= context
->rx
.prev_bit
) {
1660 if (context
->rx
.count
) {
1661 submit_data(context
);
1662 context
->rx
.count
= 0;
1664 context
->rx
.prev_bit
= curr_bit
;
1666 ++context
->rx
.count
;
1672 if (context
->rx
.count
) {
1673 submit_data(context
);
1674 context
->rx
.count
= 0;
1676 context
->rx
.initial_space
= context
->rx
.prev_bit
;
1679 ir_raw_event_handle(context
->rdev
);
1682 static void imon_incoming_scancode(struct imon_context
*ictx
,
1683 struct urb
*urb
, int intf
)
1685 int len
= urb
->actual_length
;
1686 unsigned char *buf
= urb
->transfer_buffer
;
1687 struct device
*dev
= ictx
->dev
;
1688 unsigned long flags
;
1694 static struct timeval prev_time
= { 0, 0 };
1697 /* filter out junk data on the older 0xffdc imon devices */
1698 if ((buf
[0] == 0xff) && (buf
[1] == 0xff) && (buf
[2] == 0xff))
1701 /* Figure out what key was pressed */
1702 if (len
== 8 && buf
[7] == 0xee) {
1703 scancode
= be64_to_cpu(*((__be64
*)buf
));
1704 ktype
= IMON_KEY_PANEL
;
1705 kc
= imon_panel_key_lookup(ictx
, scancode
);
1706 ictx
->release_code
= false;
1708 scancode
= be32_to_cpu(*((__be32
*)buf
));
1709 if (ictx
->rc_proto
== RC_PROTO_BIT_RC6_MCE
) {
1710 ktype
= IMON_KEY_IMON
;
1712 ktype
= IMON_KEY_MCE
;
1713 kc
= imon_mce_key_lookup(ictx
, scancode
);
1715 ktype
= IMON_KEY_IMON
;
1716 kc
= imon_remote_key_lookup(ictx
, scancode
);
1720 spin_lock_irqsave(&ictx
->kc_lock
, flags
);
1721 /* keyboard/mouse mode toggle button */
1722 if (kc
== KEY_KEYBOARD
&& !ictx
->release_code
) {
1723 ictx
->last_keycode
= kc
;
1725 ictx
->pad_mouse
= !ictx
->pad_mouse
;
1726 dev_dbg(dev
, "toggling to %s mode\n",
1727 ictx
->pad_mouse
? "mouse" : "keyboard");
1728 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1731 ictx
->pad_mouse
= false;
1732 dev_dbg(dev
, "mouse mode disabled, passing key value\n");
1737 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1739 /* send touchscreen events through input subsystem if touchpad data */
1740 if (ictx
->display_type
== IMON_DISPLAY_TYPE_VGA
&& len
== 8 &&
1742 imon_touch_event(ictx
, buf
);
1745 /* look for mouse events with pad in mouse mode */
1746 } else if (ictx
->pad_mouse
) {
1747 if (imon_mouse_event(ictx
, buf
, len
))
1751 /* Now for some special handling to convert pad input to arrow keys */
1752 if (((len
== 5) && (buf
[0] == 0x01) && (buf
[4] == 0x00)) ||
1753 ((len
== 8) && (buf
[0] & 0x40) &&
1754 !(buf
[1] & 0x1 || buf
[1] >> 2 & 0x1))) {
1756 imon_pad_to_keys(ictx
, buf
);
1760 printk(KERN_INFO
"intf%d decoded packet: %*ph\n",
1764 press_type
= imon_parse_press_type(ictx
, buf
, ktype
);
1766 goto not_input_data
;
1768 if (ktype
!= IMON_KEY_PANEL
) {
1769 if (press_type
== 0)
1770 rc_keyup(ictx
->rdev
);
1772 if (ictx
->rc_proto
== RC_PROTO_BIT_RC6_MCE
||
1773 ictx
->rc_proto
== RC_PROTO_BIT_OTHER
)
1774 rc_keydown(ictx
->rdev
,
1775 ictx
->rc_proto
== RC_PROTO_BIT_RC6_MCE
? RC_PROTO_RC6_MCE
: RC_PROTO_OTHER
,
1776 ictx
->rc_scancode
, ictx
->rc_toggle
);
1777 spin_lock_irqsave(&ictx
->kc_lock
, flags
);
1778 ictx
->last_keycode
= ictx
->kc
;
1779 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1784 /* Only panel type events left to process now */
1785 spin_lock_irqsave(&ictx
->kc_lock
, flags
);
1787 do_gettimeofday(&t
);
1788 /* KEY_MUTE repeats from knob need to be suppressed */
1789 if (ictx
->kc
== KEY_MUTE
&& ictx
->kc
== ictx
->last_keycode
) {
1790 msec
= tv2int(&t
, &prev_time
);
1791 if (msec
< ictx
->idev
->rep
[REP_DELAY
]) {
1792 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1799 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1801 input_report_key(ictx
->idev
, kc
, press_type
);
1802 input_sync(ictx
->idev
);
1804 /* panel keys don't generate a release */
1805 input_report_key(ictx
->idev
, kc
, 0);
1806 input_sync(ictx
->idev
);
1808 spin_lock_irqsave(&ictx
->kc_lock
, flags
);
1809 ictx
->last_keycode
= kc
;
1810 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1816 dev_warn(dev
, "imon %s: invalid incoming packet size (len = %d, intf%d)\n",
1817 __func__
, len
, intf
);
1821 /* iMON 2.4G associate frame */
1822 if (buf
[0] == 0x00 &&
1823 buf
[2] == 0xFF && /* REFID */
1826 buf
[5] == 0xFF && /* iMON 2.4G */
1827 ((buf
[6] == 0x4E && buf
[7] == 0xDF) || /* LT */
1828 (buf
[6] == 0x5E && buf
[7] == 0xDF))) { /* DT */
1829 dev_warn(dev
, "%s: remote associated refid=%02X\n",
1831 ictx
->rf_isassociating
= false;
1836 * Callback function for USB core API: receive data
1838 static void usb_rx_callback_intf0(struct urb
*urb
)
1840 struct imon_context
*ictx
;
1846 ictx
= (struct imon_context
*)urb
->context
;
1851 * if we get a callback before we're done configuring the hardware, we
1852 * can't yet process the data, as there's nowhere to send it, but we
1853 * still need to submit a new rx URB to avoid wedging the hardware
1855 if (!ictx
->dev_present_intf0
)
1858 switch (urb
->status
) {
1859 case -ENOENT
: /* usbcore unlink successful! */
1862 case -ESHUTDOWN
: /* transport endpoint was shut down */
1866 if (ictx
->rdev
->driver_type
== RC_DRIVER_IR_RAW
)
1867 imon_incoming_ir_raw(ictx
, urb
, intfnum
);
1869 imon_incoming_scancode(ictx
, urb
, intfnum
);
1873 dev_warn(ictx
->dev
, "imon %s: status(%d): ignored\n",
1874 __func__
, urb
->status
);
1879 usb_submit_urb(ictx
->rx_urb_intf0
, GFP_ATOMIC
);
1882 static void usb_rx_callback_intf1(struct urb
*urb
)
1884 struct imon_context
*ictx
;
1890 ictx
= (struct imon_context
*)urb
->context
;
1895 * if we get a callback before we're done configuring the hardware, we
1896 * can't yet process the data, as there's nowhere to send it, but we
1897 * still need to submit a new rx URB to avoid wedging the hardware
1899 if (!ictx
->dev_present_intf1
)
1902 switch (urb
->status
) {
1903 case -ENOENT
: /* usbcore unlink successful! */
1906 case -ESHUTDOWN
: /* transport endpoint was shut down */
1910 if (ictx
->rdev
->driver_type
== RC_DRIVER_IR_RAW
)
1911 imon_incoming_ir_raw(ictx
, urb
, intfnum
);
1913 imon_incoming_scancode(ictx
, urb
, intfnum
);
1917 dev_warn(ictx
->dev
, "imon %s: status(%d): ignored\n",
1918 __func__
, urb
->status
);
1923 usb_submit_urb(ictx
->rx_urb_intf1
, GFP_ATOMIC
);
1927 * The 0x15c2:0xffdc device ID was used for umpteen different imon
1928 * devices, and all of them constantly spew interrupts, even when there
1929 * is no actual data to report. However, byte 6 of this buffer looks like
1930 * its unique across device variants, so we're trying to key off that to
1931 * figure out which display type (if any) and what IR protocol the device
1932 * actually supports. These devices have their IR protocol hard-coded into
1933 * their firmware, they can't be changed on the fly like the newer hardware.
1935 static void imon_get_ffdc_type(struct imon_context
*ictx
)
1937 u8 ffdc_cfg_byte
= ictx
->usb_rx_buf
[6];
1938 u8 detected_display_type
= IMON_DISPLAY_TYPE_NONE
;
1939 u64 allowed_protos
= RC_PROTO_BIT_OTHER
;
1941 switch (ffdc_cfg_byte
) {
1942 /* iMON Knob, no display, iMON IR + vol knob */
1944 dev_info(ictx
->dev
, "0xffdc iMON Knob, iMON IR");
1945 ictx
->display_supported
= false;
1947 /* iMON 2.4G LT (usb stick), no display, iMON RF */
1949 dev_info(ictx
->dev
, "0xffdc iMON 2.4G LT, iMON RF");
1950 ictx
->display_supported
= false;
1951 ictx
->rf_device
= true;
1953 /* iMON VFD, no IR (does have vol knob tho) */
1955 dev_info(ictx
->dev
, "0xffdc iMON VFD + knob, no IR");
1956 detected_display_type
= IMON_DISPLAY_TYPE_VFD
;
1958 /* iMON VFD, iMON IR */
1961 dev_info(ictx
->dev
, "0xffdc iMON VFD, iMON IR");
1962 detected_display_type
= IMON_DISPLAY_TYPE_VFD
;
1964 /* iMON VFD, MCE IR */
1968 dev_info(ictx
->dev
, "0xffdc iMON VFD, MCE IR");
1969 detected_display_type
= IMON_DISPLAY_TYPE_VFD
;
1970 allowed_protos
= RC_PROTO_BIT_RC6_MCE
;
1972 /* iMON LCD, MCE IR */
1974 dev_info(ictx
->dev
, "0xffdc iMON LCD, MCE IR");
1975 detected_display_type
= IMON_DISPLAY_TYPE_LCD
;
1976 allowed_protos
= RC_PROTO_BIT_RC6_MCE
;
1979 dev_info(ictx
->dev
, "Unknown 0xffdc device, defaulting to VFD and iMON IR");
1980 detected_display_type
= IMON_DISPLAY_TYPE_VFD
;
1981 /* We don't know which one it is, allow user to set the
1982 * RC6 one from userspace if OTHER wasn't correct. */
1983 allowed_protos
|= RC_PROTO_BIT_RC6_MCE
;
1987 printk(KERN_CONT
" (id 0x%02x)\n", ffdc_cfg_byte
);
1989 ictx
->display_type
= detected_display_type
;
1990 ictx
->rc_proto
= allowed_protos
;
1993 static void imon_set_display_type(struct imon_context
*ictx
)
1995 u8 configured_display_type
= IMON_DISPLAY_TYPE_VFD
;
1998 * Try to auto-detect the type of display if the user hasn't set
1999 * it by hand via the display_type modparam. Default is VFD.
2002 if (display_type
== IMON_DISPLAY_TYPE_AUTO
) {
2003 switch (ictx
->product
) {
2005 /* set in imon_get_ffdc_type() */
2006 configured_display_type
= ictx
->display_type
;
2010 configured_display_type
= IMON_DISPLAY_TYPE_VGA
;
2015 configured_display_type
= IMON_DISPLAY_TYPE_LCD
;
2023 configured_display_type
= IMON_DISPLAY_TYPE_NONE
;
2024 ictx
->display_supported
= false;
2030 configured_display_type
= IMON_DISPLAY_TYPE_VFD
;
2034 configured_display_type
= display_type
;
2035 if (display_type
== IMON_DISPLAY_TYPE_NONE
)
2036 ictx
->display_supported
= false;
2038 ictx
->display_supported
= true;
2039 dev_info(ictx
->dev
, "%s: overriding display type to %d via modparam\n",
2040 __func__
, display_type
);
2043 ictx
->display_type
= configured_display_type
;
2046 static struct rc_dev
*imon_init_rdev(struct imon_context
*ictx
)
2048 struct rc_dev
*rdev
;
2050 const unsigned char fp_packet
[] = { 0x40, 0x00, 0x00, 0x00,
2051 0x00, 0x00, 0x00, 0x88 };
2053 rdev
= rc_allocate_device(ictx
->dev_descr
->flags
& IMON_IR_RAW
?
2054 RC_DRIVER_IR_RAW
: RC_DRIVER_SCANCODE
);
2056 dev_err(ictx
->dev
, "remote control dev allocation failed\n");
2060 snprintf(ictx
->name_rdev
, sizeof(ictx
->name_rdev
),
2061 "iMON Remote (%04x:%04x)", ictx
->vendor
, ictx
->product
);
2062 usb_make_path(ictx
->usbdev_intf0
, ictx
->phys_rdev
,
2063 sizeof(ictx
->phys_rdev
));
2064 strlcat(ictx
->phys_rdev
, "/input0", sizeof(ictx
->phys_rdev
));
2066 rdev
->device_name
= ictx
->name_rdev
;
2067 rdev
->input_phys
= ictx
->phys_rdev
;
2068 usb_to_input_id(ictx
->usbdev_intf0
, &rdev
->input_id
);
2069 rdev
->dev
.parent
= ictx
->dev
;
2072 if (ictx
->dev_descr
->flags
& IMON_IR_RAW
)
2073 rdev
->allowed_protocols
= RC_PROTO_BIT_ALL_IR_DECODER
;
2075 /* iMON PAD or MCE */
2076 rdev
->allowed_protocols
= RC_PROTO_BIT_OTHER
|
2077 RC_PROTO_BIT_RC6_MCE
;
2078 rdev
->change_protocol
= imon_ir_change_protocol
;
2079 rdev
->driver_name
= MOD_NAME
;
2081 /* Enable front-panel buttons and/or knobs */
2082 memcpy(ictx
->usb_tx_buf
, &fp_packet
, sizeof(fp_packet
));
2083 ret
= send_packet(ictx
);
2084 /* Not fatal, but warn about it */
2086 dev_info(ictx
->dev
, "panel buttons/knobs setup failed\n");
2088 if (ictx
->product
== 0xffdc) {
2089 imon_get_ffdc_type(ictx
);
2090 rdev
->allowed_protocols
= ictx
->rc_proto
;
2093 imon_set_display_type(ictx
);
2095 if (ictx
->rc_proto
== RC_PROTO_BIT_RC6_MCE
||
2096 ictx
->dev_descr
->flags
& IMON_IR_RAW
)
2097 rdev
->map_name
= RC_MAP_IMON_MCE
;
2099 rdev
->map_name
= RC_MAP_IMON_PAD
;
2101 ret
= rc_register_device(rdev
);
2103 dev_err(ictx
->dev
, "remote input dev register failed\n");
2110 rc_free_device(rdev
);
2114 static struct input_dev
*imon_init_idev(struct imon_context
*ictx
)
2116 struct imon_panel_key_table
*key_table
= ictx
->dev_descr
->key_table
;
2117 struct input_dev
*idev
;
2120 idev
= input_allocate_device();
2124 snprintf(ictx
->name_idev
, sizeof(ictx
->name_idev
),
2125 "iMON Panel, Knob and Mouse(%04x:%04x)",
2126 ictx
->vendor
, ictx
->product
);
2127 idev
->name
= ictx
->name_idev
;
2129 usb_make_path(ictx
->usbdev_intf0
, ictx
->phys_idev
,
2130 sizeof(ictx
->phys_idev
));
2131 strlcat(ictx
->phys_idev
, "/input1", sizeof(ictx
->phys_idev
));
2132 idev
->phys
= ictx
->phys_idev
;
2134 idev
->evbit
[0] = BIT_MASK(EV_KEY
) | BIT_MASK(EV_REP
) | BIT_MASK(EV_REL
);
2136 idev
->keybit
[BIT_WORD(BTN_MOUSE
)] =
2137 BIT_MASK(BTN_LEFT
) | BIT_MASK(BTN_RIGHT
);
2138 idev
->relbit
[0] = BIT_MASK(REL_X
) | BIT_MASK(REL_Y
) |
2139 BIT_MASK(REL_WHEEL
);
2141 /* panel and/or knob code support */
2142 for (i
= 0; key_table
[i
].hw_code
!= 0; i
++) {
2143 u32 kc
= key_table
[i
].keycode
;
2144 __set_bit(kc
, idev
->keybit
);
2147 usb_to_input_id(ictx
->usbdev_intf0
, &idev
->id
);
2148 idev
->dev
.parent
= ictx
->dev
;
2149 input_set_drvdata(idev
, ictx
);
2151 ret
= input_register_device(idev
);
2153 dev_err(ictx
->dev
, "input dev register failed\n");
2160 input_free_device(idev
);
2164 static struct input_dev
*imon_init_touch(struct imon_context
*ictx
)
2166 struct input_dev
*touch
;
2169 touch
= input_allocate_device();
2171 goto touch_alloc_failed
;
2173 snprintf(ictx
->name_touch
, sizeof(ictx
->name_touch
),
2174 "iMON USB Touchscreen (%04x:%04x)",
2175 ictx
->vendor
, ictx
->product
);
2176 touch
->name
= ictx
->name_touch
;
2178 usb_make_path(ictx
->usbdev_intf1
, ictx
->phys_touch
,
2179 sizeof(ictx
->phys_touch
));
2180 strlcat(ictx
->phys_touch
, "/input2", sizeof(ictx
->phys_touch
));
2181 touch
->phys
= ictx
->phys_touch
;
2184 BIT_MASK(EV_KEY
) | BIT_MASK(EV_ABS
);
2185 touch
->keybit
[BIT_WORD(BTN_TOUCH
)] =
2186 BIT_MASK(BTN_TOUCH
);
2187 input_set_abs_params(touch
, ABS_X
,
2189 input_set_abs_params(touch
, ABS_Y
,
2192 input_set_drvdata(touch
, ictx
);
2194 usb_to_input_id(ictx
->usbdev_intf1
, &touch
->id
);
2195 touch
->dev
.parent
= ictx
->dev
;
2196 ret
= input_register_device(touch
);
2198 dev_info(ictx
->dev
, "touchscreen input dev register failed\n");
2199 goto touch_register_failed
;
2204 touch_register_failed
:
2205 input_free_device(touch
);
2211 static bool imon_find_endpoints(struct imon_context
*ictx
,
2212 struct usb_host_interface
*iface_desc
)
2214 struct usb_endpoint_descriptor
*ep
;
2215 struct usb_endpoint_descriptor
*rx_endpoint
= NULL
;
2216 struct usb_endpoint_descriptor
*tx_endpoint
= NULL
;
2217 int ifnum
= iface_desc
->desc
.bInterfaceNumber
;
2218 int num_endpts
= iface_desc
->desc
.bNumEndpoints
;
2219 int i
, ep_dir
, ep_type
;
2220 bool ir_ep_found
= false;
2221 bool display_ep_found
= false;
2222 bool tx_control
= false;
2225 * Scan the endpoint list and set:
2226 * first input endpoint = IR endpoint
2227 * first output endpoint = display endpoint
2229 for (i
= 0; i
< num_endpts
&& !(ir_ep_found
&& display_ep_found
); ++i
) {
2230 ep
= &iface_desc
->endpoint
[i
].desc
;
2231 ep_dir
= ep
->bEndpointAddress
& USB_ENDPOINT_DIR_MASK
;
2232 ep_type
= usb_endpoint_type(ep
);
2234 if (!ir_ep_found
&& ep_dir
== USB_DIR_IN
&&
2235 ep_type
== USB_ENDPOINT_XFER_INT
) {
2239 dev_dbg(ictx
->dev
, "%s: found IR endpoint\n", __func__
);
2241 } else if (!display_ep_found
&& ep_dir
== USB_DIR_OUT
&&
2242 ep_type
== USB_ENDPOINT_XFER_INT
) {
2244 display_ep_found
= true;
2245 dev_dbg(ictx
->dev
, "%s: found display endpoint\n", __func__
);
2250 ictx
->rx_endpoint_intf0
= rx_endpoint
;
2252 * tx is used to send characters to lcd/vfd, associate RF
2253 * remotes, set IR protocol, and maybe more...
2255 ictx
->tx_endpoint
= tx_endpoint
;
2257 ictx
->rx_endpoint_intf1
= rx_endpoint
;
2261 * If we didn't find a display endpoint, this is probably one of the
2262 * newer iMON devices that use control urb instead of interrupt
2264 if (!display_ep_found
) {
2266 display_ep_found
= true;
2267 dev_dbg(ictx
->dev
, "%s: device uses control endpoint, not interface OUT endpoint\n",
2272 * Some iMON receivers have no display. Unfortunately, it seems
2273 * that SoundGraph recycles device IDs between devices both with
2276 if (ictx
->display_type
== IMON_DISPLAY_TYPE_NONE
) {
2277 display_ep_found
= false;
2278 dev_dbg(ictx
->dev
, "%s: device has no display\n", __func__
);
2282 * iMON Touch devices have a VGA touchscreen, but no "display", as
2283 * that refers to e.g. /dev/lcd0 (a character device LCD or VFD).
2285 if (ictx
->display_type
== IMON_DISPLAY_TYPE_VGA
) {
2286 display_ep_found
= false;
2287 dev_dbg(ictx
->dev
, "%s: iMON Touch device found\n", __func__
);
2290 /* Input endpoint is mandatory */
2292 pr_err("no valid input (IR) endpoint found\n");
2294 ictx
->tx_control
= tx_control
;
2296 if (display_ep_found
)
2297 ictx
->display_supported
= true;
2303 static struct imon_context
*imon_init_intf0(struct usb_interface
*intf
,
2304 const struct usb_device_id
*id
)
2306 struct imon_context
*ictx
;
2309 struct device
*dev
= &intf
->dev
;
2310 struct usb_host_interface
*iface_desc
;
2313 ictx
= kzalloc(sizeof(struct imon_context
), GFP_KERNEL
);
2315 dev_err(dev
, "%s: kzalloc failed for context", __func__
);
2318 rx_urb
= usb_alloc_urb(0, GFP_KERNEL
);
2320 goto rx_urb_alloc_failed
;
2321 tx_urb
= usb_alloc_urb(0, GFP_KERNEL
);
2323 goto tx_urb_alloc_failed
;
2325 mutex_init(&ictx
->lock
);
2326 spin_lock_init(&ictx
->kc_lock
);
2328 mutex_lock(&ictx
->lock
);
2331 ictx
->usbdev_intf0
= usb_get_dev(interface_to_usbdev(intf
));
2332 ictx
->rx_urb_intf0
= rx_urb
;
2333 ictx
->tx_urb
= tx_urb
;
2334 ictx
->rf_device
= false;
2336 init_completion(&ictx
->tx
.finished
);
2338 ictx
->vendor
= le16_to_cpu(ictx
->usbdev_intf0
->descriptor
.idVendor
);
2339 ictx
->product
= le16_to_cpu(ictx
->usbdev_intf0
->descriptor
.idProduct
);
2341 /* save drive info for later accessing the panel/knob key table */
2342 ictx
->dev_descr
= (struct imon_usb_dev_descr
*)id
->driver_info
;
2343 /* default send_packet delay is 5ms but some devices need more */
2344 ictx
->send_packet_delay
= ictx
->dev_descr
->flags
&
2345 IMON_NEED_20MS_PKT_DELAY
? 20 : 5;
2348 iface_desc
= intf
->cur_altsetting
;
2349 if (!imon_find_endpoints(ictx
, iface_desc
)) {
2350 goto find_endpoint_failed
;
2353 usb_fill_int_urb(ictx
->rx_urb_intf0
, ictx
->usbdev_intf0
,
2354 usb_rcvintpipe(ictx
->usbdev_intf0
,
2355 ictx
->rx_endpoint_intf0
->bEndpointAddress
),
2356 ictx
->usb_rx_buf
, sizeof(ictx
->usb_rx_buf
),
2357 usb_rx_callback_intf0
, ictx
,
2358 ictx
->rx_endpoint_intf0
->bInterval
);
2360 ret
= usb_submit_urb(ictx
->rx_urb_intf0
, GFP_KERNEL
);
2362 pr_err("usb_submit_urb failed for intf0 (%d)\n", ret
);
2363 goto urb_submit_failed
;
2366 ictx
->idev
= imon_init_idev(ictx
);
2368 dev_err(dev
, "%s: input device setup failed\n", __func__
);
2369 goto idev_setup_failed
;
2372 ictx
->rdev
= imon_init_rdev(ictx
);
2374 dev_err(dev
, "%s: rc device setup failed\n", __func__
);
2375 goto rdev_setup_failed
;
2378 ictx
->dev_present_intf0
= true;
2380 mutex_unlock(&ictx
->lock
);
2384 input_unregister_device(ictx
->idev
);
2386 usb_kill_urb(ictx
->rx_urb_intf0
);
2388 find_endpoint_failed
:
2389 usb_put_dev(ictx
->usbdev_intf0
);
2390 mutex_unlock(&ictx
->lock
);
2391 usb_free_urb(tx_urb
);
2392 tx_urb_alloc_failed
:
2393 usb_free_urb(rx_urb
);
2394 rx_urb_alloc_failed
:
2397 dev_err(dev
, "unable to initialize intf0, err %d\n", ret
);
2402 static struct imon_context
*imon_init_intf1(struct usb_interface
*intf
,
2403 struct imon_context
*ictx
)
2406 struct usb_host_interface
*iface_desc
;
2409 rx_urb
= usb_alloc_urb(0, GFP_KERNEL
);
2411 goto rx_urb_alloc_failed
;
2413 mutex_lock(&ictx
->lock
);
2415 if (ictx
->display_type
== IMON_DISPLAY_TYPE_VGA
) {
2416 setup_timer(&ictx
->ttimer
, imon_touch_display_timeout
,
2417 (unsigned long)ictx
);
2420 ictx
->usbdev_intf1
= usb_get_dev(interface_to_usbdev(intf
));
2421 ictx
->rx_urb_intf1
= rx_urb
;
2424 iface_desc
= intf
->cur_altsetting
;
2425 if (!imon_find_endpoints(ictx
, iface_desc
))
2426 goto find_endpoint_failed
;
2428 if (ictx
->display_type
== IMON_DISPLAY_TYPE_VGA
) {
2429 ictx
->touch
= imon_init_touch(ictx
);
2431 goto touch_setup_failed
;
2435 usb_fill_int_urb(ictx
->rx_urb_intf1
, ictx
->usbdev_intf1
,
2436 usb_rcvintpipe(ictx
->usbdev_intf1
,
2437 ictx
->rx_endpoint_intf1
->bEndpointAddress
),
2438 ictx
->usb_rx_buf
, sizeof(ictx
->usb_rx_buf
),
2439 usb_rx_callback_intf1
, ictx
,
2440 ictx
->rx_endpoint_intf1
->bInterval
);
2442 ret
= usb_submit_urb(ictx
->rx_urb_intf1
, GFP_KERNEL
);
2445 pr_err("usb_submit_urb failed for intf1 (%d)\n", ret
);
2446 goto urb_submit_failed
;
2449 ictx
->dev_present_intf1
= true;
2451 mutex_unlock(&ictx
->lock
);
2456 input_unregister_device(ictx
->touch
);
2458 find_endpoint_failed
:
2459 usb_put_dev(ictx
->usbdev_intf1
);
2460 mutex_unlock(&ictx
->lock
);
2461 usb_free_urb(rx_urb
);
2462 rx_urb_alloc_failed
:
2463 dev_err(ictx
->dev
, "unable to initialize intf1, err %d\n", ret
);
2468 static void imon_init_display(struct imon_context
*ictx
,
2469 struct usb_interface
*intf
)
2473 dev_dbg(ictx
->dev
, "Registering iMON display with sysfs\n");
2475 /* set up sysfs entry for built-in clock */
2476 ret
= sysfs_create_group(&intf
->dev
.kobj
, &imon_display_attr_group
);
2478 dev_err(ictx
->dev
, "Could not create display sysfs entries(%d)",
2481 if (ictx
->display_type
== IMON_DISPLAY_TYPE_LCD
)
2482 ret
= usb_register_dev(intf
, &imon_lcd_class
);
2484 ret
= usb_register_dev(intf
, &imon_vfd_class
);
2486 /* Not a fatal error, so ignore */
2487 dev_info(ictx
->dev
, "could not get a minor number for display\n");
2492 * Callback function for USB core API: Probe
2494 static int imon_probe(struct usb_interface
*interface
,
2495 const struct usb_device_id
*id
)
2497 struct usb_device
*usbdev
= NULL
;
2498 struct usb_host_interface
*iface_desc
= NULL
;
2499 struct usb_interface
*first_if
;
2500 struct device
*dev
= &interface
->dev
;
2501 int ifnum
, sysfs_err
;
2503 struct imon_context
*ictx
= NULL
;
2504 struct imon_context
*first_if_ctx
= NULL
;
2505 u16 vendor
, product
;
2507 usbdev
= usb_get_dev(interface_to_usbdev(interface
));
2508 iface_desc
= interface
->cur_altsetting
;
2509 ifnum
= iface_desc
->desc
.bInterfaceNumber
;
2510 vendor
= le16_to_cpu(usbdev
->descriptor
.idVendor
);
2511 product
= le16_to_cpu(usbdev
->descriptor
.idProduct
);
2513 dev_dbg(dev
, "%s: found iMON device (%04x:%04x, intf%d)\n",
2514 __func__
, vendor
, product
, ifnum
);
2516 /* prevent races probing devices w/multiple interfaces */
2517 mutex_lock(&driver_lock
);
2519 first_if
= usb_ifnum_to_if(usbdev
, 0);
2525 first_if_ctx
= usb_get_intfdata(first_if
);
2528 ictx
= imon_init_intf0(interface
, id
);
2530 pr_err("failed to initialize context!\n");
2536 /* this is the secondary interface on the device */
2538 /* fail early if first intf failed to register */
2539 if (!first_if_ctx
) {
2544 ictx
= imon_init_intf1(interface
, first_if_ctx
);
2546 pr_err("failed to attach to context!\n");
2553 usb_set_intfdata(interface
, ictx
);
2556 mutex_lock(&ictx
->lock
);
2558 if (product
== 0xffdc && ictx
->rf_device
) {
2559 sysfs_err
= sysfs_create_group(&interface
->dev
.kobj
,
2560 &imon_rf_attr_group
);
2562 pr_err("Could not create RF sysfs entries(%d)\n",
2566 if (ictx
->display_supported
)
2567 imon_init_display(ictx
, interface
);
2569 mutex_unlock(&ictx
->lock
);
2572 dev_info(dev
, "iMON device (%04x:%04x, intf%d) on usb<%d:%d> initialized\n",
2573 vendor
, product
, ifnum
,
2574 usbdev
->bus
->busnum
, usbdev
->devnum
);
2576 mutex_unlock(&driver_lock
);
2577 usb_put_dev(usbdev
);
2582 mutex_unlock(&driver_lock
);
2583 usb_put_dev(usbdev
);
2584 dev_err(dev
, "unable to register, err %d\n", ret
);
2590 * Callback function for USB core API: disconnect
2592 static void imon_disconnect(struct usb_interface
*interface
)
2594 struct imon_context
*ictx
;
2598 /* prevent races with multi-interface device probing and display_open */
2599 mutex_lock(&driver_lock
);
2601 ictx
= usb_get_intfdata(interface
);
2603 ifnum
= interface
->cur_altsetting
->desc
.bInterfaceNumber
;
2606 * sysfs_remove_group is safe to call even if sysfs_create_group
2607 * hasn't been called
2609 sysfs_remove_group(&interface
->dev
.kobj
, &imon_display_attr_group
);
2610 sysfs_remove_group(&interface
->dev
.kobj
, &imon_rf_attr_group
);
2612 usb_set_intfdata(interface
, NULL
);
2614 /* Abort ongoing write */
2615 if (ictx
->tx
.busy
) {
2616 usb_kill_urb(ictx
->tx_urb
);
2617 complete(&ictx
->tx
.finished
);
2621 ictx
->dev_present_intf0
= false;
2622 usb_kill_urb(ictx
->rx_urb_intf0
);
2623 usb_put_dev(ictx
->usbdev_intf0
);
2624 input_unregister_device(ictx
->idev
);
2625 rc_unregister_device(ictx
->rdev
);
2626 if (ictx
->display_supported
) {
2627 if (ictx
->display_type
== IMON_DISPLAY_TYPE_LCD
)
2628 usb_deregister_dev(interface
, &imon_lcd_class
);
2629 else if (ictx
->display_type
== IMON_DISPLAY_TYPE_VFD
)
2630 usb_deregister_dev(interface
, &imon_vfd_class
);
2633 ictx
->dev_present_intf1
= false;
2634 usb_kill_urb(ictx
->rx_urb_intf1
);
2635 usb_put_dev(ictx
->usbdev_intf1
);
2636 if (ictx
->display_type
== IMON_DISPLAY_TYPE_VGA
) {
2637 input_unregister_device(ictx
->touch
);
2638 del_timer_sync(&ictx
->ttimer
);
2642 if (!ictx
->dev_present_intf0
&& !ictx
->dev_present_intf1
)
2643 free_imon_context(ictx
);
2645 mutex_unlock(&driver_lock
);
2647 dev_dbg(dev
, "%s: iMON device (intf%d) disconnected\n",
2651 static int imon_suspend(struct usb_interface
*intf
, pm_message_t message
)
2653 struct imon_context
*ictx
= usb_get_intfdata(intf
);
2654 int ifnum
= intf
->cur_altsetting
->desc
.bInterfaceNumber
;
2657 usb_kill_urb(ictx
->rx_urb_intf0
);
2659 usb_kill_urb(ictx
->rx_urb_intf1
);
2664 static int imon_resume(struct usb_interface
*intf
)
2667 struct imon_context
*ictx
= usb_get_intfdata(intf
);
2668 int ifnum
= intf
->cur_altsetting
->desc
.bInterfaceNumber
;
2671 usb_fill_int_urb(ictx
->rx_urb_intf0
, ictx
->usbdev_intf0
,
2672 usb_rcvintpipe(ictx
->usbdev_intf0
,
2673 ictx
->rx_endpoint_intf0
->bEndpointAddress
),
2674 ictx
->usb_rx_buf
, sizeof(ictx
->usb_rx_buf
),
2675 usb_rx_callback_intf0
, ictx
,
2676 ictx
->rx_endpoint_intf0
->bInterval
);
2678 rc
= usb_submit_urb(ictx
->rx_urb_intf0
, GFP_ATOMIC
);
2681 usb_fill_int_urb(ictx
->rx_urb_intf1
, ictx
->usbdev_intf1
,
2682 usb_rcvintpipe(ictx
->usbdev_intf1
,
2683 ictx
->rx_endpoint_intf1
->bEndpointAddress
),
2684 ictx
->usb_rx_buf
, sizeof(ictx
->usb_rx_buf
),
2685 usb_rx_callback_intf1
, ictx
,
2686 ictx
->rx_endpoint_intf1
->bInterval
);
2688 rc
= usb_submit_urb(ictx
->rx_urb_intf1
, GFP_ATOMIC
);
2694 module_usb_driver(imon_driver
);