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 const 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(*control_req
), GFP_KERNEL
);
606 if (control_req
== NULL
)
609 /* setup packet is '21 09 0200 0001 0008' */
610 control_req
->bRequestType
= 0x21;
611 control_req
->bRequest
= 0x09;
612 control_req
->wValue
= cpu_to_le16(0x0200);
613 control_req
->wIndex
= cpu_to_le16(0x0001);
614 control_req
->wLength
= cpu_to_le16(0x0008);
616 /* control pipe is endpoint 0x00 */
617 pipe
= usb_sndctrlpipe(ictx
->usbdev_intf0
, 0);
619 /* build the control urb */
620 usb_fill_control_urb(ictx
->tx_urb
, ictx
->usbdev_intf0
,
621 pipe
, (unsigned char *)control_req
,
623 sizeof(ictx
->usb_tx_buf
),
624 usb_tx_callback
, ictx
);
625 ictx
->tx_urb
->actual_length
= 0;
628 reinit_completion(&ictx
->tx
.finished
);
629 ictx
->tx
.busy
= true;
630 smp_rmb(); /* ensure later readers know we're busy */
632 retval
= usb_submit_urb(ictx
->tx_urb
, GFP_KERNEL
);
634 ictx
->tx
.busy
= false;
635 smp_rmb(); /* ensure later readers know we're not busy */
636 pr_err_ratelimited("error submitting urb(%d)\n", retval
);
638 /* Wait for transmission to complete (or abort) */
639 mutex_unlock(&ictx
->lock
);
640 retval
= wait_for_completion_interruptible(
643 usb_kill_urb(ictx
->tx_urb
);
644 pr_err_ratelimited("task interrupted\n");
646 mutex_lock(&ictx
->lock
);
648 retval
= ictx
->tx
.status
;
650 pr_err_ratelimited("packet tx failed (%d)\n", retval
);
656 * Induce a mandatory delay before returning, as otherwise,
657 * send_packet can get called so rapidly as to overwhelm the device,
658 * particularly on faster systems and/or those with quirky usb.
660 timeout
= msecs_to_jiffies(ictx
->send_packet_delay
);
661 set_current_state(TASK_INTERRUPTIBLE
);
662 schedule_timeout(timeout
);
668 * Sends an associate packet to the iMON 2.4G.
670 * This might not be such a good idea, since it has an id collision with
671 * some versions of the "IR & VFD" combo. The only way to determine if it
672 * is an RF version is to look at the product description string. (Which
673 * we currently do not fetch).
675 static int send_associate_24g(struct imon_context
*ictx
)
678 const unsigned char packet
[8] = { 0x01, 0x00, 0x00, 0x00,
679 0x00, 0x00, 0x00, 0x20 };
682 pr_err("no context for device\n");
686 if (!ictx
->dev_present_intf0
) {
687 pr_err("no iMON device present\n");
691 memcpy(ictx
->usb_tx_buf
, packet
, sizeof(packet
));
692 retval
= send_packet(ictx
);
698 * Sends packets to setup and show clock on iMON display
700 * Arguments: year - last 2 digits of year, month - 1..12,
701 * day - 1..31, dow - day of the week (0-Sun...6-Sat),
702 * hour - 0..23, minute - 0..59, second - 0..59
704 static int send_set_imon_clock(struct imon_context
*ictx
,
705 unsigned int year
, unsigned int month
,
706 unsigned int day
, unsigned int dow
,
707 unsigned int hour
, unsigned int minute
,
710 unsigned char clock_enable_pkt
[IMON_CLOCK_ENABLE_PACKETS
][8];
715 pr_err("no context for device\n");
719 switch (ictx
->display_type
) {
720 case IMON_DISPLAY_TYPE_LCD
:
721 clock_enable_pkt
[0][0] = 0x80;
722 clock_enable_pkt
[0][1] = year
;
723 clock_enable_pkt
[0][2] = month
-1;
724 clock_enable_pkt
[0][3] = day
;
725 clock_enable_pkt
[0][4] = hour
;
726 clock_enable_pkt
[0][5] = minute
;
727 clock_enable_pkt
[0][6] = second
;
729 clock_enable_pkt
[1][0] = 0x80;
730 clock_enable_pkt
[1][1] = 0;
731 clock_enable_pkt
[1][2] = 0;
732 clock_enable_pkt
[1][3] = 0;
733 clock_enable_pkt
[1][4] = 0;
734 clock_enable_pkt
[1][5] = 0;
735 clock_enable_pkt
[1][6] = 0;
737 if (ictx
->product
== 0xffdc) {
738 clock_enable_pkt
[0][7] = 0x50;
739 clock_enable_pkt
[1][7] = 0x51;
741 clock_enable_pkt
[0][7] = 0x88;
742 clock_enable_pkt
[1][7] = 0x8a;
747 case IMON_DISPLAY_TYPE_VFD
:
748 clock_enable_pkt
[0][0] = year
;
749 clock_enable_pkt
[0][1] = month
-1;
750 clock_enable_pkt
[0][2] = day
;
751 clock_enable_pkt
[0][3] = dow
;
752 clock_enable_pkt
[0][4] = hour
;
753 clock_enable_pkt
[0][5] = minute
;
754 clock_enable_pkt
[0][6] = second
;
755 clock_enable_pkt
[0][7] = 0x40;
757 clock_enable_pkt
[1][0] = 0;
758 clock_enable_pkt
[1][1] = 0;
759 clock_enable_pkt
[1][2] = 1;
760 clock_enable_pkt
[1][3] = 0;
761 clock_enable_pkt
[1][4] = 0;
762 clock_enable_pkt
[1][5] = 0;
763 clock_enable_pkt
[1][6] = 0;
764 clock_enable_pkt
[1][7] = 0x42;
772 for (i
= 0; i
< IMON_CLOCK_ENABLE_PACKETS
; i
++) {
773 memcpy(ictx
->usb_tx_buf
, clock_enable_pkt
[i
], 8);
774 retval
= send_packet(ictx
);
776 pr_err("send_packet failed for packet %d\n", i
);
785 * These are the sysfs functions to handle the association on the iMON 2.4G LT.
787 static ssize_t
show_associate_remote(struct device
*d
,
788 struct device_attribute
*attr
,
791 struct imon_context
*ictx
= dev_get_drvdata(d
);
796 mutex_lock(&ictx
->lock
);
797 if (ictx
->rf_isassociating
)
798 strcpy(buf
, "associating\n");
800 strcpy(buf
, "closed\n");
802 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");
803 mutex_unlock(&ictx
->lock
);
807 static ssize_t
store_associate_remote(struct device
*d
,
808 struct device_attribute
*attr
,
809 const char *buf
, size_t count
)
811 struct imon_context
*ictx
;
813 ictx
= dev_get_drvdata(d
);
818 mutex_lock(&ictx
->lock
);
819 ictx
->rf_isassociating
= true;
820 send_associate_24g(ictx
);
821 mutex_unlock(&ictx
->lock
);
827 * sysfs functions to control internal imon clock
829 static ssize_t
show_imon_clock(struct device
*d
,
830 struct device_attribute
*attr
, char *buf
)
832 struct imon_context
*ictx
= dev_get_drvdata(d
);
838 mutex_lock(&ictx
->lock
);
840 if (!ictx
->display_supported
) {
841 len
= snprintf(buf
, PAGE_SIZE
, "Not supported.");
843 len
= snprintf(buf
, PAGE_SIZE
,
844 "To set the clock on your iMON display:\n"
845 "# date \"+%%y %%m %%d %%w %%H %%M %%S\" > imon_clock\n"
846 "%s", ictx
->display_isopen
?
847 "\nNOTE: imon device must be closed\n" : "");
850 mutex_unlock(&ictx
->lock
);
855 static ssize_t
store_imon_clock(struct device
*d
,
856 struct device_attribute
*attr
,
857 const char *buf
, size_t count
)
859 struct imon_context
*ictx
= dev_get_drvdata(d
);
861 unsigned int year
, month
, day
, dow
, hour
, minute
, second
;
866 mutex_lock(&ictx
->lock
);
868 if (!ictx
->display_supported
) {
871 } else if (ictx
->display_isopen
) {
876 if (sscanf(buf
, "%u %u %u %u %u %u %u", &year
, &month
, &day
, &dow
,
877 &hour
, &minute
, &second
) != 7) {
882 if ((month
< 1 || month
> 12) ||
883 (day
< 1 || day
> 31) || (dow
> 6) ||
884 (hour
> 23) || (minute
> 59) || (second
> 59)) {
889 retval
= send_set_imon_clock(ictx
, year
, month
, day
, dow
,
890 hour
, minute
, second
);
896 mutex_unlock(&ictx
->lock
);
902 static DEVICE_ATTR(imon_clock
, S_IWUSR
| S_IRUGO
, show_imon_clock
,
905 static DEVICE_ATTR(associate_remote
, S_IWUSR
| S_IRUGO
, show_associate_remote
,
906 store_associate_remote
);
908 static struct attribute
*imon_display_sysfs_entries
[] = {
909 &dev_attr_imon_clock
.attr
,
913 static const struct attribute_group imon_display_attr_group
= {
914 .attrs
= imon_display_sysfs_entries
917 static struct attribute
*imon_rf_sysfs_entries
[] = {
918 &dev_attr_associate_remote
.attr
,
922 static const struct attribute_group imon_rf_attr_group
= {
923 .attrs
= imon_rf_sysfs_entries
927 * Writes data to the VFD. The iMON VFD is 2x16 characters
928 * and requires data in 5 consecutive USB interrupt packets,
929 * each packet but the last carrying 7 bytes.
931 * I don't know if the VFD board supports features such as
932 * scrolling, clearing rows, blanking, etc. so at
933 * the caller must provide a full screen of data. If fewer
934 * than 32 bytes are provided spaces will be appended to
935 * generate a full screen.
937 static ssize_t
vfd_write(struct file
*file
, const char __user
*buf
,
938 size_t n_bytes
, loff_t
*pos
)
944 struct imon_context
*ictx
;
945 static const unsigned char vfd_packet6
[] = {
946 0x01, 0x00, 0x00, 0x00, 0x00, 0xFF, 0xFF };
948 ictx
= file
->private_data
;
950 pr_err_ratelimited("no context for device\n");
954 mutex_lock(&ictx
->lock
);
956 if (!ictx
->dev_present_intf0
) {
957 pr_err_ratelimited("no iMON device present\n");
962 if (n_bytes
<= 0 || n_bytes
> 32) {
963 pr_err_ratelimited("invalid payload size\n");
968 if (copy_from_user(ictx
->tx
.data_buf
, buf
, n_bytes
)) {
973 /* Pad with spaces */
974 for (i
= n_bytes
; i
< 32; ++i
)
975 ictx
->tx
.data_buf
[i
] = ' ';
977 for (i
= 32; i
< 35; ++i
)
978 ictx
->tx
.data_buf
[i
] = 0xFF;
984 memcpy(ictx
->usb_tx_buf
, ictx
->tx
.data_buf
+ offset
, 7);
985 ictx
->usb_tx_buf
[7] = (unsigned char) seq
;
987 retval
= send_packet(ictx
);
989 pr_err_ratelimited("send packet #%d failed\n", seq
/ 2);
996 } while (offset
< 35);
999 memcpy(ictx
->usb_tx_buf
, &vfd_packet6
, sizeof(vfd_packet6
));
1000 ictx
->usb_tx_buf
[7] = (unsigned char) seq
;
1001 retval
= send_packet(ictx
);
1003 pr_err_ratelimited("send packet #%d failed\n", seq
/ 2);
1006 mutex_unlock(&ictx
->lock
);
1008 return (!retval
) ? n_bytes
: retval
;
1012 * Writes data to the LCD. The iMON OEM LCD screen expects 8-byte
1013 * packets. We accept data as 16 hexadecimal digits, followed by a
1014 * newline (to make it easy to drive the device from a command-line
1015 * -- even though the actual binary data is a bit complicated).
1017 * The device itself is not a "traditional" text-mode display. It's
1018 * actually a 16x96 pixel bitmap display. That means if you want to
1019 * display text, you've got to have your own "font" and translate the
1020 * text into bitmaps for display. This is really flexible (you can
1021 * display whatever diacritics you need, and so on), but it's also
1022 * a lot more complicated than most LCDs...
1024 static ssize_t
lcd_write(struct file
*file
, const char __user
*buf
,
1025 size_t n_bytes
, loff_t
*pos
)
1028 struct imon_context
*ictx
;
1030 ictx
= file
->private_data
;
1032 pr_err_ratelimited("no context for device\n");
1036 mutex_lock(&ictx
->lock
);
1038 if (!ictx
->display_supported
) {
1039 pr_err_ratelimited("no iMON display present\n");
1045 pr_err_ratelimited("invalid payload size: %d (expected 8)\n",
1051 if (copy_from_user(ictx
->usb_tx_buf
, buf
, 8)) {
1056 retval
= send_packet(ictx
);
1058 pr_err_ratelimited("send packet failed!\n");
1061 dev_dbg(ictx
->dev
, "%s: write %d bytes to LCD\n",
1062 __func__
, (int) n_bytes
);
1065 mutex_unlock(&ictx
->lock
);
1066 return (!retval
) ? n_bytes
: retval
;
1070 * Callback function for USB core API: transmit data
1072 static void usb_tx_callback(struct urb
*urb
)
1074 struct imon_context
*ictx
;
1078 ictx
= (struct imon_context
*)urb
->context
;
1082 ictx
->tx
.status
= urb
->status
;
1084 /* notify waiters that write has finished */
1085 ictx
->tx
.busy
= false;
1086 smp_rmb(); /* ensure later readers know we're not busy */
1087 complete(&ictx
->tx
.finished
);
1091 * report touchscreen input
1093 static void imon_touch_display_timeout(struct timer_list
*t
)
1095 struct imon_context
*ictx
= from_timer(ictx
, t
, ttimer
);
1097 if (ictx
->display_type
!= IMON_DISPLAY_TYPE_VGA
)
1100 input_report_abs(ictx
->touch
, ABS_X
, ictx
->touch_x
);
1101 input_report_abs(ictx
->touch
, ABS_Y
, ictx
->touch_y
);
1102 input_report_key(ictx
->touch
, BTN_TOUCH
, 0x00);
1103 input_sync(ictx
->touch
);
1107 * iMON IR receivers support two different signal sets -- those used by
1108 * the iMON remotes, and those used by the Windows MCE remotes (which is
1109 * really just RC-6), but only one or the other at a time, as the signals
1110 * are decoded onboard the receiver.
1112 * This function gets called two different ways, one way is from
1113 * rc_register_device, for initial protocol selection/setup, and the other is
1114 * via a userspace-initiated protocol change request, either by direct sysfs
1115 * prodding or by something like ir-keytable. In the rc_register_device case,
1116 * the imon context lock is already held, but when initiated from userspace,
1117 * it is not, so we must acquire it prior to calling send_packet, which
1118 * requires that the lock is held.
1120 static int imon_ir_change_protocol(struct rc_dev
*rc
, u64
*rc_proto
)
1123 struct imon_context
*ictx
= rc
->priv
;
1124 struct device
*dev
= ictx
->dev
;
1125 bool unlock
= false;
1126 unsigned char ir_proto_packet
[] = {
1127 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x86 };
1129 if (*rc_proto
&& !(*rc_proto
& rc
->allowed_protocols
))
1130 dev_warn(dev
, "Looks like you're trying to use an IR protocol this device does not support\n");
1132 if (*rc_proto
& RC_PROTO_BIT_RC6_MCE
) {
1133 dev_dbg(dev
, "Configuring IR receiver for MCE protocol\n");
1134 ir_proto_packet
[0] = 0x01;
1135 *rc_proto
= RC_PROTO_BIT_RC6_MCE
;
1136 } else if (*rc_proto
& RC_PROTO_BIT_OTHER
) {
1137 dev_dbg(dev
, "Configuring IR receiver for iMON protocol\n");
1139 dev_dbg(dev
, "PAD stabilize functionality disabled\n");
1140 /* ir_proto_packet[0] = 0x00; // already the default */
1141 *rc_proto
= RC_PROTO_BIT_OTHER
;
1143 dev_warn(dev
, "Unsupported IR protocol specified, overriding to iMON IR protocol\n");
1145 dev_dbg(dev
, "PAD stabilize functionality disabled\n");
1146 /* ir_proto_packet[0] = 0x00; // already the default */
1147 *rc_proto
= RC_PROTO_BIT_OTHER
;
1150 memcpy(ictx
->usb_tx_buf
, &ir_proto_packet
, sizeof(ir_proto_packet
));
1152 if (!mutex_is_locked(&ictx
->lock
)) {
1154 mutex_lock(&ictx
->lock
);
1157 retval
= send_packet(ictx
);
1161 ictx
->rc_proto
= *rc_proto
;
1162 ictx
->pad_mouse
= false;
1166 mutex_unlock(&ictx
->lock
);
1171 static inline int tv2int(const struct timeval
*a
, const struct timeval
*b
)
1176 if (b
->tv_usec
> a
->tv_usec
) {
1181 usecs
+= a
->tv_usec
- b
->tv_usec
;
1183 sec
+= a
->tv_sec
- b
->tv_sec
;
1195 * The directional pad behaves a bit differently, depending on whether this is
1196 * one of the older ffdc devices or a newer device. Newer devices appear to
1197 * have a higher resolution matrix for more precise mouse movement, but it
1198 * makes things overly sensitive in keyboard mode, so we do some interesting
1199 * contortions to make it less touchy. Older devices run through the same
1200 * routine with shorter timeout and a smaller threshold.
1202 static int stabilize(int a
, int b
, u16 timeout
, u16 threshold
)
1205 static struct timeval prev_time
= {0, 0};
1206 static struct timeval hit_time
= {0, 0};
1207 static int x
, y
, prev_result
, hits
;
1211 do_gettimeofday(&ct
);
1212 msec
= tv2int(&ct
, &prev_time
);
1213 msec_hit
= tv2int(&ct
, &hit_time
);
1226 if (abs(x
) > threshold
|| abs(y
) > threshold
) {
1227 if (abs(y
) > abs(x
))
1228 result
= (y
> 0) ? 0x7F : 0x80;
1230 result
= (x
> 0) ? 0x7F00 : 0x8000;
1235 if (result
== prev_result
) {
1241 y
= 17 * threshold
/ 30;
1244 y
-= 17 * threshold
/ 30;
1247 x
= 17 * threshold
/ 30;
1250 x
-= 17 * threshold
/ 30;
1255 if (hits
== 2 && msec_hit
< timeout
) {
1260 prev_result
= result
;
1269 static u32
imon_remote_key_lookup(struct imon_context
*ictx
, u32 scancode
)
1273 bool is_release_code
= false;
1275 /* Look for the initial press of a button */
1276 keycode
= rc_g_keycode_from_table(ictx
->rdev
, scancode
);
1277 ictx
->rc_toggle
= 0x0;
1278 ictx
->rc_scancode
= scancode
;
1280 /* Look for the release of a button */
1281 if (keycode
== KEY_RESERVED
) {
1282 release
= scancode
& ~0x4000;
1283 keycode
= rc_g_keycode_from_table(ictx
->rdev
, release
);
1284 if (keycode
!= KEY_RESERVED
)
1285 is_release_code
= true;
1288 ictx
->release_code
= is_release_code
;
1293 static u32
imon_mce_key_lookup(struct imon_context
*ictx
, u32 scancode
)
1297 #define MCE_KEY_MASK 0x7000
1298 #define MCE_TOGGLE_BIT 0x8000
1301 * On some receivers, mce keys decode to 0x8000f04xx and 0x8000f84xx
1302 * (the toggle bit flipping between alternating key presses), while
1303 * on other receivers, we see 0x8000f74xx and 0x8000ff4xx. To keep
1304 * the table trim, we always or in the bits to look up 0x8000ff4xx,
1305 * but we can't or them into all codes, as some keys are decoded in
1306 * a different way w/o the same use of the toggle bit...
1308 if (scancode
& 0x80000000)
1309 scancode
= scancode
| MCE_KEY_MASK
| MCE_TOGGLE_BIT
;
1311 ictx
->rc_scancode
= scancode
;
1312 keycode
= rc_g_keycode_from_table(ictx
->rdev
, scancode
);
1314 /* not used in mce mode, but make sure we know its false */
1315 ictx
->release_code
= false;
1320 static u32
imon_panel_key_lookup(struct imon_context
*ictx
, u64 code
)
1323 u32 keycode
= KEY_RESERVED
;
1324 struct imon_panel_key_table
*key_table
= ictx
->dev_descr
->key_table
;
1326 for (i
= 0; key_table
[i
].hw_code
!= 0; i
++) {
1327 if (key_table
[i
].hw_code
== (code
| 0xffee)) {
1328 keycode
= key_table
[i
].keycode
;
1332 ictx
->release_code
= false;
1336 static bool imon_mouse_event(struct imon_context
*ictx
,
1337 unsigned char *buf
, int len
)
1339 signed char rel_x
= 0x00, rel_y
= 0x00;
1341 bool mouse_input
= true;
1343 unsigned long flags
;
1345 spin_lock_irqsave(&ictx
->kc_lock
, flags
);
1347 /* newer iMON device PAD or mouse button */
1348 if (ictx
->product
!= 0xffdc && (buf
[0] & 0x01) && len
== 5) {
1352 /* 0xffdc iMON PAD or mouse button input */
1353 } else if (ictx
->product
== 0xffdc && (buf
[0] & 0x40) &&
1354 !((buf
[1] & 0x01) || ((buf
[1] >> 2) & 0x01))) {
1355 rel_x
= (buf
[1] & 0x08) | (buf
[1] & 0x10) >> 2 |
1356 (buf
[1] & 0x20) >> 4 | (buf
[1] & 0x40) >> 6;
1359 rel_x
= rel_x
+ rel_x
/ 2;
1360 rel_y
= (buf
[2] & 0x08) | (buf
[2] & 0x10) >> 2 |
1361 (buf
[2] & 0x20) >> 4 | (buf
[2] & 0x40) >> 6;
1364 rel_y
= rel_y
+ rel_y
/ 2;
1366 /* some ffdc devices decode mouse buttons differently... */
1367 } else if (ictx
->product
== 0xffdc && (buf
[0] == 0x68)) {
1369 /* ch+/- buttons, which we use for an emulated scroll wheel */
1370 } else if (ictx
->kc
== KEY_CHANNELUP
&& (buf
[2] & 0x40) != 0x40) {
1372 } else if (ictx
->kc
== KEY_CHANNELDOWN
&& (buf
[2] & 0x40) != 0x40) {
1375 mouse_input
= false;
1377 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1380 dev_dbg(ictx
->dev
, "sending mouse data via input subsystem\n");
1383 input_report_rel(ictx
->idev
, REL_WHEEL
, dir
);
1384 } else if (rel_x
|| rel_y
) {
1385 input_report_rel(ictx
->idev
, REL_X
, rel_x
);
1386 input_report_rel(ictx
->idev
, REL_Y
, rel_y
);
1388 input_report_key(ictx
->idev
, BTN_LEFT
, buf
[1] & 0x1);
1389 input_report_key(ictx
->idev
, BTN_RIGHT
,
1390 buf
[1] >> right_shift
& 0x1);
1392 input_sync(ictx
->idev
);
1393 spin_lock_irqsave(&ictx
->kc_lock
, flags
);
1394 ictx
->last_keycode
= ictx
->kc
;
1395 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1401 static void imon_touch_event(struct imon_context
*ictx
, unsigned char *buf
)
1403 mod_timer(&ictx
->ttimer
, jiffies
+ TOUCH_TIMEOUT
);
1404 ictx
->touch_x
= (buf
[0] << 4) | (buf
[1] >> 4);
1405 ictx
->touch_y
= 0xfff - ((buf
[2] << 4) | (buf
[1] & 0xf));
1406 input_report_abs(ictx
->touch
, ABS_X
, ictx
->touch_x
);
1407 input_report_abs(ictx
->touch
, ABS_Y
, ictx
->touch_y
);
1408 input_report_key(ictx
->touch
, BTN_TOUCH
, 0x01);
1409 input_sync(ictx
->touch
);
1412 static void imon_pad_to_keys(struct imon_context
*ictx
, unsigned char *buf
)
1415 signed char rel_x
= 0x00, rel_y
= 0x00;
1416 u16 timeout
, threshold
;
1417 u32 scancode
= KEY_RESERVED
;
1418 unsigned long flags
;
1421 * The imon directional pad functions more like a touchpad. Bytes 3 & 4
1422 * contain a position coordinate (x,y), with each component ranging
1423 * from -14 to 14. We want to down-sample this to only 4 discrete values
1424 * for up/down/left/right arrow keys. Also, when you get too close to
1425 * diagonals, it has a tendency to jump back and forth, so lets try to
1426 * ignore when they get too close.
1428 if (ictx
->product
!= 0xffdc) {
1429 /* first, pad to 8 bytes so it conforms with everything else */
1430 buf
[5] = buf
[6] = buf
[7] = 0;
1431 timeout
= 500; /* in msecs */
1432 /* (2*threshold) x (2*threshold) square */
1433 threshold
= pad_thresh
? pad_thresh
: 28;
1437 if (ictx
->rc_proto
== RC_PROTO_BIT_OTHER
&& pad_stabilize
) {
1438 if ((buf
[1] == 0) && ((rel_x
!= 0) || (rel_y
!= 0))) {
1439 dir
= stabilize((int)rel_x
, (int)rel_y
,
1440 timeout
, threshold
);
1442 spin_lock_irqsave(&ictx
->kc_lock
,
1444 ictx
->kc
= KEY_UNKNOWN
;
1445 spin_unlock_irqrestore(&ictx
->kc_lock
,
1449 buf
[2] = dir
& 0xFF;
1450 buf
[3] = (dir
>> 8) & 0xFF;
1451 scancode
= be32_to_cpu(*((__be32
*)buf
));
1455 * Hack alert: instead of using keycodes, we have
1456 * to use hard-coded scancodes here...
1458 if (abs(rel_y
) > abs(rel_x
)) {
1459 buf
[2] = (rel_y
> 0) ? 0x7F : 0x80;
1462 scancode
= 0x01007f00; /* KEY_DOWN */
1464 scancode
= 0x01008000; /* KEY_UP */
1467 buf
[3] = (rel_x
> 0) ? 0x7F : 0x80;
1469 scancode
= 0x0100007f; /* KEY_RIGHT */
1471 scancode
= 0x01000080; /* KEY_LEFT */
1476 * Handle on-board decoded pad events for e.g. older VFD/iMON-Pad
1477 * device (15c2:ffdc). The remote generates various codes from
1478 * 0x68nnnnB7 to 0x6AnnnnB7, the left mouse button generates
1479 * 0x688301b7 and the right one 0x688481b7. All other keys generate
1480 * 0x2nnnnnnn. Position coordinate is encoded in buf[1] and buf[2] with
1481 * reversed endianness. Extract direction from buffer, rotate endianness,
1482 * adjust sign and feed the values into stabilize(). The resulting codes
1483 * will be 0x01008000, 0x01007F00, which match the newer devices.
1486 timeout
= 10; /* in msecs */
1487 /* (2*threshold) x (2*threshold) square */
1488 threshold
= pad_thresh
? pad_thresh
: 15;
1491 rel_x
= (buf
[1] & 0x08) | (buf
[1] & 0x10) >> 2 |
1492 (buf
[1] & 0x20) >> 4 | (buf
[1] & 0x40) >> 6;
1496 rel_y
= (buf
[2] & 0x08) | (buf
[2] & 0x10) >> 2 |
1497 (buf
[2] & 0x20) >> 4 | (buf
[2] & 0x40) >> 6;
1502 buf
[1] = buf
[4] = buf
[5] = buf
[6] = buf
[7] = 0;
1504 if (ictx
->rc_proto
== RC_PROTO_BIT_OTHER
&& pad_stabilize
) {
1505 dir
= stabilize((int)rel_x
, (int)rel_y
,
1506 timeout
, threshold
);
1508 spin_lock_irqsave(&ictx
->kc_lock
, flags
);
1509 ictx
->kc
= KEY_UNKNOWN
;
1510 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1513 buf
[2] = dir
& 0xFF;
1514 buf
[3] = (dir
>> 8) & 0xFF;
1515 scancode
= be32_to_cpu(*((__be32
*)buf
));
1518 * Hack alert: instead of using keycodes, we have
1519 * to use hard-coded scancodes here...
1521 if (abs(rel_y
) > abs(rel_x
)) {
1522 buf
[2] = (rel_y
> 0) ? 0x7F : 0x80;
1525 scancode
= 0x01007f00; /* KEY_DOWN */
1527 scancode
= 0x01008000; /* KEY_UP */
1530 buf
[3] = (rel_x
> 0) ? 0x7F : 0x80;
1532 scancode
= 0x0100007f; /* KEY_RIGHT */
1534 scancode
= 0x01000080; /* KEY_LEFT */
1540 spin_lock_irqsave(&ictx
->kc_lock
, flags
);
1541 ictx
->kc
= imon_remote_key_lookup(ictx
, scancode
);
1542 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1547 * figure out if these is a press or a release. We don't actually
1548 * care about repeats, as those will be auto-generated within the IR
1549 * subsystem for repeating scancodes.
1551 static int imon_parse_press_type(struct imon_context
*ictx
,
1552 unsigned char *buf
, u8 ktype
)
1555 unsigned long flags
;
1557 spin_lock_irqsave(&ictx
->kc_lock
, flags
);
1559 /* key release of 0x02XXXXXX key */
1560 if (ictx
->kc
== KEY_RESERVED
&& buf
[0] == 0x02 && buf
[3] == 0x00)
1561 ictx
->kc
= ictx
->last_keycode
;
1563 /* mouse button release on (some) 0xffdc devices */
1564 else if (ictx
->kc
== KEY_RESERVED
&& buf
[0] == 0x68 && buf
[1] == 0x82 &&
1565 buf
[2] == 0x81 && buf
[3] == 0xb7)
1566 ictx
->kc
= ictx
->last_keycode
;
1568 /* mouse button release on (some other) 0xffdc devices */
1569 else if (ictx
->kc
== KEY_RESERVED
&& buf
[0] == 0x01 && buf
[1] == 0x00 &&
1570 buf
[2] == 0x81 && buf
[3] == 0xb7)
1571 ictx
->kc
= ictx
->last_keycode
;
1573 /* mce-specific button handling, no keyup events */
1574 else if (ktype
== IMON_KEY_MCE
) {
1575 ictx
->rc_toggle
= buf
[2];
1578 /* incoherent or irrelevant data */
1579 } else if (ictx
->kc
== KEY_RESERVED
)
1580 press_type
= -EINVAL
;
1582 /* key release of 0xXXXXXXb7 key */
1583 else if (ictx
->release_code
)
1586 /* this is a button press */
1590 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1596 * Process the incoming packet
1599 * Convert bit count to time duration (in us) and submit
1600 * the value to lirc_dev.
1602 static void submit_data(struct imon_context
*context
)
1604 DEFINE_IR_RAW_EVENT(ev
);
1606 ev
.pulse
= context
->rx
.prev_bit
;
1607 ev
.duration
= US_TO_NS(context
->rx
.count
* BIT_DURATION
);
1608 ir_raw_event_store_with_filter(context
->rdev
, &ev
);
1612 * Process the incoming packet
1614 static void imon_incoming_ir_raw(struct imon_context
*context
,
1615 struct urb
*urb
, int intf
)
1617 int len
= urb
->actual_length
;
1618 unsigned char *buf
= urb
->transfer_buffer
;
1619 struct device
*dev
= context
->dev
;
1624 dev_warn(dev
, "imon %s: invalid incoming packet size (len = %d, intf%d)\n",
1625 __func__
, len
, intf
);
1630 dev_info(dev
, "raw packet: %*ph\n", len
, buf
);
1632 * Translate received data to pulse and space lengths.
1633 * Received data is active low, i.e. pulses are 0 and
1636 * My original algorithm was essentially similar to
1637 * Changwoo Ryu's with the exception that he switched
1638 * the incoming bits to active high and also fed an
1639 * initial space to LIRC at the start of a new sequence
1640 * if the previous bit was a pulse.
1642 * I've decided to adopt his algorithm.
1645 if (buf
[7] == 1 && context
->rx
.initial_space
) {
1646 /* LIRC requires a leading space */
1647 context
->rx
.prev_bit
= 0;
1648 context
->rx
.count
= 4;
1649 submit_data(context
);
1650 context
->rx
.count
= 0;
1653 for (octet
= 0; octet
< 5; ++octet
) {
1655 for (bit
= 0; bit
< 8; ++bit
) {
1656 int curr_bit
= !(buf
[octet
] & mask
);
1658 if (curr_bit
!= context
->rx
.prev_bit
) {
1659 if (context
->rx
.count
) {
1660 submit_data(context
);
1661 context
->rx
.count
= 0;
1663 context
->rx
.prev_bit
= curr_bit
;
1665 ++context
->rx
.count
;
1671 if (context
->rx
.count
) {
1672 submit_data(context
);
1673 context
->rx
.count
= 0;
1675 context
->rx
.initial_space
= context
->rx
.prev_bit
;
1678 ir_raw_event_handle(context
->rdev
);
1681 static void imon_incoming_scancode(struct imon_context
*ictx
,
1682 struct urb
*urb
, int intf
)
1684 int len
= urb
->actual_length
;
1685 unsigned char *buf
= urb
->transfer_buffer
;
1686 struct device
*dev
= ictx
->dev
;
1687 unsigned long flags
;
1693 static struct timeval prev_time
= { 0, 0 };
1696 /* filter out junk data on the older 0xffdc imon devices */
1697 if ((buf
[0] == 0xff) && (buf
[1] == 0xff) && (buf
[2] == 0xff))
1700 /* Figure out what key was pressed */
1701 if (len
== 8 && buf
[7] == 0xee) {
1702 scancode
= be64_to_cpu(*((__be64
*)buf
));
1703 ktype
= IMON_KEY_PANEL
;
1704 kc
= imon_panel_key_lookup(ictx
, scancode
);
1705 ictx
->release_code
= false;
1707 scancode
= be32_to_cpu(*((__be32
*)buf
));
1708 if (ictx
->rc_proto
== RC_PROTO_BIT_RC6_MCE
) {
1709 ktype
= IMON_KEY_IMON
;
1711 ktype
= IMON_KEY_MCE
;
1712 kc
= imon_mce_key_lookup(ictx
, scancode
);
1714 ktype
= IMON_KEY_IMON
;
1715 kc
= imon_remote_key_lookup(ictx
, scancode
);
1719 spin_lock_irqsave(&ictx
->kc_lock
, flags
);
1720 /* keyboard/mouse mode toggle button */
1721 if (kc
== KEY_KEYBOARD
&& !ictx
->release_code
) {
1722 ictx
->last_keycode
= kc
;
1724 ictx
->pad_mouse
= !ictx
->pad_mouse
;
1725 dev_dbg(dev
, "toggling to %s mode\n",
1726 ictx
->pad_mouse
? "mouse" : "keyboard");
1727 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1730 ictx
->pad_mouse
= false;
1731 dev_dbg(dev
, "mouse mode disabled, passing key value\n");
1736 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1738 /* send touchscreen events through input subsystem if touchpad data */
1739 if (ictx
->display_type
== IMON_DISPLAY_TYPE_VGA
&& len
== 8 &&
1741 imon_touch_event(ictx
, buf
);
1744 /* look for mouse events with pad in mouse mode */
1745 } else if (ictx
->pad_mouse
) {
1746 if (imon_mouse_event(ictx
, buf
, len
))
1750 /* Now for some special handling to convert pad input to arrow keys */
1751 if (((len
== 5) && (buf
[0] == 0x01) && (buf
[4] == 0x00)) ||
1752 ((len
== 8) && (buf
[0] & 0x40) &&
1753 !(buf
[1] & 0x1 || buf
[1] >> 2 & 0x1))) {
1755 imon_pad_to_keys(ictx
, buf
);
1759 printk(KERN_INFO
"intf%d decoded packet: %*ph\n",
1763 press_type
= imon_parse_press_type(ictx
, buf
, ktype
);
1765 goto not_input_data
;
1767 if (ktype
!= IMON_KEY_PANEL
) {
1768 if (press_type
== 0)
1769 rc_keyup(ictx
->rdev
);
1771 if (ictx
->rc_proto
== RC_PROTO_BIT_RC6_MCE
||
1772 ictx
->rc_proto
== RC_PROTO_BIT_OTHER
)
1773 rc_keydown(ictx
->rdev
,
1774 ictx
->rc_proto
== RC_PROTO_BIT_RC6_MCE
? RC_PROTO_RC6_MCE
: RC_PROTO_OTHER
,
1775 ictx
->rc_scancode
, ictx
->rc_toggle
);
1776 spin_lock_irqsave(&ictx
->kc_lock
, flags
);
1777 ictx
->last_keycode
= ictx
->kc
;
1778 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1783 /* Only panel type events left to process now */
1784 spin_lock_irqsave(&ictx
->kc_lock
, flags
);
1786 do_gettimeofday(&t
);
1787 /* KEY_MUTE repeats from knob need to be suppressed */
1788 if (ictx
->kc
== KEY_MUTE
&& ictx
->kc
== ictx
->last_keycode
) {
1789 msec
= tv2int(&t
, &prev_time
);
1790 if (msec
< ictx
->idev
->rep
[REP_DELAY
]) {
1791 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1798 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1800 input_report_key(ictx
->idev
, kc
, press_type
);
1801 input_sync(ictx
->idev
);
1803 /* panel keys don't generate a release */
1804 input_report_key(ictx
->idev
, kc
, 0);
1805 input_sync(ictx
->idev
);
1807 spin_lock_irqsave(&ictx
->kc_lock
, flags
);
1808 ictx
->last_keycode
= kc
;
1809 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1815 dev_warn(dev
, "imon %s: invalid incoming packet size (len = %d, intf%d)\n",
1816 __func__
, len
, intf
);
1820 /* iMON 2.4G associate frame */
1821 if (buf
[0] == 0x00 &&
1822 buf
[2] == 0xFF && /* REFID */
1825 buf
[5] == 0xFF && /* iMON 2.4G */
1826 ((buf
[6] == 0x4E && buf
[7] == 0xDF) || /* LT */
1827 (buf
[6] == 0x5E && buf
[7] == 0xDF))) { /* DT */
1828 dev_warn(dev
, "%s: remote associated refid=%02X\n",
1830 ictx
->rf_isassociating
= false;
1835 * Callback function for USB core API: receive data
1837 static void usb_rx_callback_intf0(struct urb
*urb
)
1839 struct imon_context
*ictx
;
1845 ictx
= (struct imon_context
*)urb
->context
;
1850 * if we get a callback before we're done configuring the hardware, we
1851 * can't yet process the data, as there's nowhere to send it, but we
1852 * still need to submit a new rx URB to avoid wedging the hardware
1854 if (!ictx
->dev_present_intf0
)
1857 switch (urb
->status
) {
1858 case -ENOENT
: /* usbcore unlink successful! */
1861 case -ESHUTDOWN
: /* transport endpoint was shut down */
1865 if (ictx
->rdev
->driver_type
== RC_DRIVER_IR_RAW
)
1866 imon_incoming_ir_raw(ictx
, urb
, intfnum
);
1868 imon_incoming_scancode(ictx
, urb
, intfnum
);
1872 dev_warn(ictx
->dev
, "imon %s: status(%d): ignored\n",
1873 __func__
, urb
->status
);
1878 usb_submit_urb(ictx
->rx_urb_intf0
, GFP_ATOMIC
);
1881 static void usb_rx_callback_intf1(struct urb
*urb
)
1883 struct imon_context
*ictx
;
1889 ictx
= (struct imon_context
*)urb
->context
;
1894 * if we get a callback before we're done configuring the hardware, we
1895 * can't yet process the data, as there's nowhere to send it, but we
1896 * still need to submit a new rx URB to avoid wedging the hardware
1898 if (!ictx
->dev_present_intf1
)
1901 switch (urb
->status
) {
1902 case -ENOENT
: /* usbcore unlink successful! */
1905 case -ESHUTDOWN
: /* transport endpoint was shut down */
1909 if (ictx
->rdev
->driver_type
== RC_DRIVER_IR_RAW
)
1910 imon_incoming_ir_raw(ictx
, urb
, intfnum
);
1912 imon_incoming_scancode(ictx
, urb
, intfnum
);
1916 dev_warn(ictx
->dev
, "imon %s: status(%d): ignored\n",
1917 __func__
, urb
->status
);
1922 usb_submit_urb(ictx
->rx_urb_intf1
, GFP_ATOMIC
);
1926 * The 0x15c2:0xffdc device ID was used for umpteen different imon
1927 * devices, and all of them constantly spew interrupts, even when there
1928 * is no actual data to report. However, byte 6 of this buffer looks like
1929 * its unique across device variants, so we're trying to key off that to
1930 * figure out which display type (if any) and what IR protocol the device
1931 * actually supports. These devices have their IR protocol hard-coded into
1932 * their firmware, they can't be changed on the fly like the newer hardware.
1934 static void imon_get_ffdc_type(struct imon_context
*ictx
)
1936 u8 ffdc_cfg_byte
= ictx
->usb_rx_buf
[6];
1937 u8 detected_display_type
= IMON_DISPLAY_TYPE_NONE
;
1938 u64 allowed_protos
= RC_PROTO_BIT_OTHER
;
1940 switch (ffdc_cfg_byte
) {
1941 /* iMON Knob, no display, iMON IR + vol knob */
1943 dev_info(ictx
->dev
, "0xffdc iMON Knob, iMON IR");
1944 ictx
->display_supported
= false;
1946 /* iMON 2.4G LT (usb stick), no display, iMON RF */
1948 dev_info(ictx
->dev
, "0xffdc iMON 2.4G LT, iMON RF");
1949 ictx
->display_supported
= false;
1950 ictx
->rf_device
= true;
1952 /* iMON VFD, no IR (does have vol knob tho) */
1954 dev_info(ictx
->dev
, "0xffdc iMON VFD + knob, no IR");
1955 detected_display_type
= IMON_DISPLAY_TYPE_VFD
;
1957 /* iMON VFD, iMON IR */
1960 dev_info(ictx
->dev
, "0xffdc iMON VFD, iMON IR");
1961 detected_display_type
= IMON_DISPLAY_TYPE_VFD
;
1963 /* iMON VFD, MCE IR */
1967 dev_info(ictx
->dev
, "0xffdc iMON VFD, MCE IR");
1968 detected_display_type
= IMON_DISPLAY_TYPE_VFD
;
1969 allowed_protos
= RC_PROTO_BIT_RC6_MCE
;
1971 /* iMON LCD, MCE IR */
1973 dev_info(ictx
->dev
, "0xffdc iMON LCD, MCE IR");
1974 detected_display_type
= IMON_DISPLAY_TYPE_LCD
;
1975 allowed_protos
= RC_PROTO_BIT_RC6_MCE
;
1978 dev_info(ictx
->dev
, "Unknown 0xffdc device, defaulting to VFD and iMON IR");
1979 detected_display_type
= IMON_DISPLAY_TYPE_VFD
;
1980 /* We don't know which one it is, allow user to set the
1981 * RC6 one from userspace if OTHER wasn't correct. */
1982 allowed_protos
|= RC_PROTO_BIT_RC6_MCE
;
1986 printk(KERN_CONT
" (id 0x%02x)\n", ffdc_cfg_byte
);
1988 ictx
->display_type
= detected_display_type
;
1989 ictx
->rc_proto
= allowed_protos
;
1992 static void imon_set_display_type(struct imon_context
*ictx
)
1994 u8 configured_display_type
= IMON_DISPLAY_TYPE_VFD
;
1997 * Try to auto-detect the type of display if the user hasn't set
1998 * it by hand via the display_type modparam. Default is VFD.
2001 if (display_type
== IMON_DISPLAY_TYPE_AUTO
) {
2002 switch (ictx
->product
) {
2004 /* set in imon_get_ffdc_type() */
2005 configured_display_type
= ictx
->display_type
;
2009 configured_display_type
= IMON_DISPLAY_TYPE_VGA
;
2014 configured_display_type
= IMON_DISPLAY_TYPE_LCD
;
2022 configured_display_type
= IMON_DISPLAY_TYPE_NONE
;
2023 ictx
->display_supported
= false;
2029 configured_display_type
= IMON_DISPLAY_TYPE_VFD
;
2033 configured_display_type
= display_type
;
2034 if (display_type
== IMON_DISPLAY_TYPE_NONE
)
2035 ictx
->display_supported
= false;
2037 ictx
->display_supported
= true;
2038 dev_info(ictx
->dev
, "%s: overriding display type to %d via modparam\n",
2039 __func__
, display_type
);
2042 ictx
->display_type
= configured_display_type
;
2045 static struct rc_dev
*imon_init_rdev(struct imon_context
*ictx
)
2047 struct rc_dev
*rdev
;
2049 static const unsigned char fp_packet
[] = {
2050 0x40, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x88 };
2052 rdev
= rc_allocate_device(ictx
->dev_descr
->flags
& IMON_IR_RAW
?
2053 RC_DRIVER_IR_RAW
: RC_DRIVER_SCANCODE
);
2055 dev_err(ictx
->dev
, "remote control dev allocation failed\n");
2059 snprintf(ictx
->name_rdev
, sizeof(ictx
->name_rdev
),
2060 "iMON Remote (%04x:%04x)", ictx
->vendor
, ictx
->product
);
2061 usb_make_path(ictx
->usbdev_intf0
, ictx
->phys_rdev
,
2062 sizeof(ictx
->phys_rdev
));
2063 strlcat(ictx
->phys_rdev
, "/input0", sizeof(ictx
->phys_rdev
));
2065 rdev
->device_name
= ictx
->name_rdev
;
2066 rdev
->input_phys
= ictx
->phys_rdev
;
2067 usb_to_input_id(ictx
->usbdev_intf0
, &rdev
->input_id
);
2068 rdev
->dev
.parent
= ictx
->dev
;
2071 if (ictx
->dev_descr
->flags
& IMON_IR_RAW
)
2072 rdev
->allowed_protocols
= RC_PROTO_BIT_ALL_IR_DECODER
;
2074 /* iMON PAD or MCE */
2075 rdev
->allowed_protocols
= RC_PROTO_BIT_OTHER
|
2076 RC_PROTO_BIT_RC6_MCE
;
2077 rdev
->change_protocol
= imon_ir_change_protocol
;
2078 rdev
->driver_name
= MOD_NAME
;
2080 /* Enable front-panel buttons and/or knobs */
2081 memcpy(ictx
->usb_tx_buf
, &fp_packet
, sizeof(fp_packet
));
2082 ret
= send_packet(ictx
);
2083 /* Not fatal, but warn about it */
2085 dev_info(ictx
->dev
, "panel buttons/knobs setup failed\n");
2087 if (ictx
->product
== 0xffdc) {
2088 imon_get_ffdc_type(ictx
);
2089 rdev
->allowed_protocols
= ictx
->rc_proto
;
2092 imon_set_display_type(ictx
);
2094 if (ictx
->rc_proto
== RC_PROTO_BIT_RC6_MCE
||
2095 ictx
->dev_descr
->flags
& IMON_IR_RAW
)
2096 rdev
->map_name
= RC_MAP_IMON_MCE
;
2098 rdev
->map_name
= RC_MAP_IMON_PAD
;
2100 ret
= rc_register_device(rdev
);
2102 dev_err(ictx
->dev
, "remote input dev register failed\n");
2109 rc_free_device(rdev
);
2113 static struct input_dev
*imon_init_idev(struct imon_context
*ictx
)
2115 struct imon_panel_key_table
*key_table
= ictx
->dev_descr
->key_table
;
2116 struct input_dev
*idev
;
2119 idev
= input_allocate_device();
2123 snprintf(ictx
->name_idev
, sizeof(ictx
->name_idev
),
2124 "iMON Panel, Knob and Mouse(%04x:%04x)",
2125 ictx
->vendor
, ictx
->product
);
2126 idev
->name
= ictx
->name_idev
;
2128 usb_make_path(ictx
->usbdev_intf0
, ictx
->phys_idev
,
2129 sizeof(ictx
->phys_idev
));
2130 strlcat(ictx
->phys_idev
, "/input1", sizeof(ictx
->phys_idev
));
2131 idev
->phys
= ictx
->phys_idev
;
2133 idev
->evbit
[0] = BIT_MASK(EV_KEY
) | BIT_MASK(EV_REP
) | BIT_MASK(EV_REL
);
2135 idev
->keybit
[BIT_WORD(BTN_MOUSE
)] =
2136 BIT_MASK(BTN_LEFT
) | BIT_MASK(BTN_RIGHT
);
2137 idev
->relbit
[0] = BIT_MASK(REL_X
) | BIT_MASK(REL_Y
) |
2138 BIT_MASK(REL_WHEEL
);
2140 /* panel and/or knob code support */
2141 for (i
= 0; key_table
[i
].hw_code
!= 0; i
++) {
2142 u32 kc
= key_table
[i
].keycode
;
2143 __set_bit(kc
, idev
->keybit
);
2146 usb_to_input_id(ictx
->usbdev_intf0
, &idev
->id
);
2147 idev
->dev
.parent
= ictx
->dev
;
2148 input_set_drvdata(idev
, ictx
);
2150 ret
= input_register_device(idev
);
2152 dev_err(ictx
->dev
, "input dev register failed\n");
2159 input_free_device(idev
);
2163 static struct input_dev
*imon_init_touch(struct imon_context
*ictx
)
2165 struct input_dev
*touch
;
2168 touch
= input_allocate_device();
2170 goto touch_alloc_failed
;
2172 snprintf(ictx
->name_touch
, sizeof(ictx
->name_touch
),
2173 "iMON USB Touchscreen (%04x:%04x)",
2174 ictx
->vendor
, ictx
->product
);
2175 touch
->name
= ictx
->name_touch
;
2177 usb_make_path(ictx
->usbdev_intf1
, ictx
->phys_touch
,
2178 sizeof(ictx
->phys_touch
));
2179 strlcat(ictx
->phys_touch
, "/input2", sizeof(ictx
->phys_touch
));
2180 touch
->phys
= ictx
->phys_touch
;
2183 BIT_MASK(EV_KEY
) | BIT_MASK(EV_ABS
);
2184 touch
->keybit
[BIT_WORD(BTN_TOUCH
)] =
2185 BIT_MASK(BTN_TOUCH
);
2186 input_set_abs_params(touch
, ABS_X
,
2188 input_set_abs_params(touch
, ABS_Y
,
2191 input_set_drvdata(touch
, ictx
);
2193 usb_to_input_id(ictx
->usbdev_intf1
, &touch
->id
);
2194 touch
->dev
.parent
= ictx
->dev
;
2195 ret
= input_register_device(touch
);
2197 dev_info(ictx
->dev
, "touchscreen input dev register failed\n");
2198 goto touch_register_failed
;
2203 touch_register_failed
:
2204 input_free_device(touch
);
2210 static bool imon_find_endpoints(struct imon_context
*ictx
,
2211 struct usb_host_interface
*iface_desc
)
2213 struct usb_endpoint_descriptor
*ep
;
2214 struct usb_endpoint_descriptor
*rx_endpoint
= NULL
;
2215 struct usb_endpoint_descriptor
*tx_endpoint
= NULL
;
2216 int ifnum
= iface_desc
->desc
.bInterfaceNumber
;
2217 int num_endpts
= iface_desc
->desc
.bNumEndpoints
;
2218 int i
, ep_dir
, ep_type
;
2219 bool ir_ep_found
= false;
2220 bool display_ep_found
= false;
2221 bool tx_control
= false;
2224 * Scan the endpoint list and set:
2225 * first input endpoint = IR endpoint
2226 * first output endpoint = display endpoint
2228 for (i
= 0; i
< num_endpts
&& !(ir_ep_found
&& display_ep_found
); ++i
) {
2229 ep
= &iface_desc
->endpoint
[i
].desc
;
2230 ep_dir
= ep
->bEndpointAddress
& USB_ENDPOINT_DIR_MASK
;
2231 ep_type
= usb_endpoint_type(ep
);
2233 if (!ir_ep_found
&& ep_dir
== USB_DIR_IN
&&
2234 ep_type
== USB_ENDPOINT_XFER_INT
) {
2238 dev_dbg(ictx
->dev
, "%s: found IR endpoint\n", __func__
);
2240 } else if (!display_ep_found
&& ep_dir
== USB_DIR_OUT
&&
2241 ep_type
== USB_ENDPOINT_XFER_INT
) {
2243 display_ep_found
= true;
2244 dev_dbg(ictx
->dev
, "%s: found display endpoint\n", __func__
);
2249 ictx
->rx_endpoint_intf0
= rx_endpoint
;
2251 * tx is used to send characters to lcd/vfd, associate RF
2252 * remotes, set IR protocol, and maybe more...
2254 ictx
->tx_endpoint
= tx_endpoint
;
2256 ictx
->rx_endpoint_intf1
= rx_endpoint
;
2260 * If we didn't find a display endpoint, this is probably one of the
2261 * newer iMON devices that use control urb instead of interrupt
2263 if (!display_ep_found
) {
2265 display_ep_found
= true;
2266 dev_dbg(ictx
->dev
, "%s: device uses control endpoint, not interface OUT endpoint\n",
2271 * Some iMON receivers have no display. Unfortunately, it seems
2272 * that SoundGraph recycles device IDs between devices both with
2275 if (ictx
->display_type
== IMON_DISPLAY_TYPE_NONE
) {
2276 display_ep_found
= false;
2277 dev_dbg(ictx
->dev
, "%s: device has no display\n", __func__
);
2281 * iMON Touch devices have a VGA touchscreen, but no "display", as
2282 * that refers to e.g. /dev/lcd0 (a character device LCD or VFD).
2284 if (ictx
->display_type
== IMON_DISPLAY_TYPE_VGA
) {
2285 display_ep_found
= false;
2286 dev_dbg(ictx
->dev
, "%s: iMON Touch device found\n", __func__
);
2289 /* Input endpoint is mandatory */
2291 pr_err("no valid input (IR) endpoint found\n");
2293 ictx
->tx_control
= tx_control
;
2295 if (display_ep_found
)
2296 ictx
->display_supported
= true;
2302 static struct imon_context
*imon_init_intf0(struct usb_interface
*intf
,
2303 const struct usb_device_id
*id
)
2305 struct imon_context
*ictx
;
2308 struct device
*dev
= &intf
->dev
;
2309 struct usb_host_interface
*iface_desc
;
2312 ictx
= kzalloc(sizeof(*ictx
), GFP_KERNEL
);
2316 rx_urb
= usb_alloc_urb(0, GFP_KERNEL
);
2318 goto rx_urb_alloc_failed
;
2319 tx_urb
= usb_alloc_urb(0, GFP_KERNEL
);
2321 goto tx_urb_alloc_failed
;
2323 mutex_init(&ictx
->lock
);
2324 spin_lock_init(&ictx
->kc_lock
);
2326 mutex_lock(&ictx
->lock
);
2329 ictx
->usbdev_intf0
= usb_get_dev(interface_to_usbdev(intf
));
2330 ictx
->rx_urb_intf0
= rx_urb
;
2331 ictx
->tx_urb
= tx_urb
;
2332 ictx
->rf_device
= false;
2334 init_completion(&ictx
->tx
.finished
);
2336 ictx
->vendor
= le16_to_cpu(ictx
->usbdev_intf0
->descriptor
.idVendor
);
2337 ictx
->product
= le16_to_cpu(ictx
->usbdev_intf0
->descriptor
.idProduct
);
2339 /* save drive info for later accessing the panel/knob key table */
2340 ictx
->dev_descr
= (struct imon_usb_dev_descr
*)id
->driver_info
;
2341 /* default send_packet delay is 5ms but some devices need more */
2342 ictx
->send_packet_delay
= ictx
->dev_descr
->flags
&
2343 IMON_NEED_20MS_PKT_DELAY
? 20 : 5;
2346 iface_desc
= intf
->cur_altsetting
;
2347 if (!imon_find_endpoints(ictx
, iface_desc
)) {
2348 goto find_endpoint_failed
;
2351 usb_fill_int_urb(ictx
->rx_urb_intf0
, ictx
->usbdev_intf0
,
2352 usb_rcvintpipe(ictx
->usbdev_intf0
,
2353 ictx
->rx_endpoint_intf0
->bEndpointAddress
),
2354 ictx
->usb_rx_buf
, sizeof(ictx
->usb_rx_buf
),
2355 usb_rx_callback_intf0
, ictx
,
2356 ictx
->rx_endpoint_intf0
->bInterval
);
2358 ret
= usb_submit_urb(ictx
->rx_urb_intf0
, GFP_KERNEL
);
2360 pr_err("usb_submit_urb failed for intf0 (%d)\n", ret
);
2361 goto urb_submit_failed
;
2364 ictx
->idev
= imon_init_idev(ictx
);
2366 dev_err(dev
, "%s: input device setup failed\n", __func__
);
2367 goto idev_setup_failed
;
2370 ictx
->rdev
= imon_init_rdev(ictx
);
2372 dev_err(dev
, "%s: rc device setup failed\n", __func__
);
2373 goto rdev_setup_failed
;
2376 ictx
->dev_present_intf0
= true;
2378 mutex_unlock(&ictx
->lock
);
2382 input_unregister_device(ictx
->idev
);
2384 usb_kill_urb(ictx
->rx_urb_intf0
);
2386 find_endpoint_failed
:
2387 usb_put_dev(ictx
->usbdev_intf0
);
2388 mutex_unlock(&ictx
->lock
);
2389 usb_free_urb(tx_urb
);
2390 tx_urb_alloc_failed
:
2391 usb_free_urb(rx_urb
);
2392 rx_urb_alloc_failed
:
2395 dev_err(dev
, "unable to initialize intf0, err %d\n", ret
);
2400 static struct imon_context
*imon_init_intf1(struct usb_interface
*intf
,
2401 struct imon_context
*ictx
)
2404 struct usb_host_interface
*iface_desc
;
2407 rx_urb
= usb_alloc_urb(0, GFP_KERNEL
);
2409 goto rx_urb_alloc_failed
;
2411 mutex_lock(&ictx
->lock
);
2413 if (ictx
->display_type
== IMON_DISPLAY_TYPE_VGA
) {
2414 timer_setup(&ictx
->ttimer
, imon_touch_display_timeout
, 0);
2417 ictx
->usbdev_intf1
= usb_get_dev(interface_to_usbdev(intf
));
2418 ictx
->rx_urb_intf1
= rx_urb
;
2421 iface_desc
= intf
->cur_altsetting
;
2422 if (!imon_find_endpoints(ictx
, iface_desc
))
2423 goto find_endpoint_failed
;
2425 if (ictx
->display_type
== IMON_DISPLAY_TYPE_VGA
) {
2426 ictx
->touch
= imon_init_touch(ictx
);
2428 goto touch_setup_failed
;
2432 usb_fill_int_urb(ictx
->rx_urb_intf1
, ictx
->usbdev_intf1
,
2433 usb_rcvintpipe(ictx
->usbdev_intf1
,
2434 ictx
->rx_endpoint_intf1
->bEndpointAddress
),
2435 ictx
->usb_rx_buf
, sizeof(ictx
->usb_rx_buf
),
2436 usb_rx_callback_intf1
, ictx
,
2437 ictx
->rx_endpoint_intf1
->bInterval
);
2439 ret
= usb_submit_urb(ictx
->rx_urb_intf1
, GFP_KERNEL
);
2442 pr_err("usb_submit_urb failed for intf1 (%d)\n", ret
);
2443 goto urb_submit_failed
;
2446 ictx
->dev_present_intf1
= true;
2448 mutex_unlock(&ictx
->lock
);
2453 input_unregister_device(ictx
->touch
);
2455 find_endpoint_failed
:
2456 usb_put_dev(ictx
->usbdev_intf1
);
2457 mutex_unlock(&ictx
->lock
);
2458 usb_free_urb(rx_urb
);
2459 rx_urb_alloc_failed
:
2460 dev_err(ictx
->dev
, "unable to initialize intf1, err %d\n", ret
);
2465 static void imon_init_display(struct imon_context
*ictx
,
2466 struct usb_interface
*intf
)
2470 dev_dbg(ictx
->dev
, "Registering iMON display with sysfs\n");
2472 /* set up sysfs entry for built-in clock */
2473 ret
= sysfs_create_group(&intf
->dev
.kobj
, &imon_display_attr_group
);
2475 dev_err(ictx
->dev
, "Could not create display sysfs entries(%d)",
2478 if (ictx
->display_type
== IMON_DISPLAY_TYPE_LCD
)
2479 ret
= usb_register_dev(intf
, &imon_lcd_class
);
2481 ret
= usb_register_dev(intf
, &imon_vfd_class
);
2483 /* Not a fatal error, so ignore */
2484 dev_info(ictx
->dev
, "could not get a minor number for display\n");
2489 * Callback function for USB core API: Probe
2491 static int imon_probe(struct usb_interface
*interface
,
2492 const struct usb_device_id
*id
)
2494 struct usb_device
*usbdev
= NULL
;
2495 struct usb_host_interface
*iface_desc
= NULL
;
2496 struct usb_interface
*first_if
;
2497 struct device
*dev
= &interface
->dev
;
2498 int ifnum
, sysfs_err
;
2500 struct imon_context
*ictx
= NULL
;
2501 struct imon_context
*first_if_ctx
= NULL
;
2502 u16 vendor
, product
;
2504 usbdev
= usb_get_dev(interface_to_usbdev(interface
));
2505 iface_desc
= interface
->cur_altsetting
;
2506 ifnum
= iface_desc
->desc
.bInterfaceNumber
;
2507 vendor
= le16_to_cpu(usbdev
->descriptor
.idVendor
);
2508 product
= le16_to_cpu(usbdev
->descriptor
.idProduct
);
2510 dev_dbg(dev
, "%s: found iMON device (%04x:%04x, intf%d)\n",
2511 __func__
, vendor
, product
, ifnum
);
2513 /* prevent races probing devices w/multiple interfaces */
2514 mutex_lock(&driver_lock
);
2516 first_if
= usb_ifnum_to_if(usbdev
, 0);
2522 first_if_ctx
= usb_get_intfdata(first_if
);
2525 ictx
= imon_init_intf0(interface
, id
);
2527 pr_err("failed to initialize context!\n");
2533 /* this is the secondary interface on the device */
2535 /* fail early if first intf failed to register */
2536 if (!first_if_ctx
) {
2541 ictx
= imon_init_intf1(interface
, first_if_ctx
);
2543 pr_err("failed to attach to context!\n");
2550 usb_set_intfdata(interface
, ictx
);
2553 mutex_lock(&ictx
->lock
);
2555 if (product
== 0xffdc && ictx
->rf_device
) {
2556 sysfs_err
= sysfs_create_group(&interface
->dev
.kobj
,
2557 &imon_rf_attr_group
);
2559 pr_err("Could not create RF sysfs entries(%d)\n",
2563 if (ictx
->display_supported
)
2564 imon_init_display(ictx
, interface
);
2566 mutex_unlock(&ictx
->lock
);
2569 dev_info(dev
, "iMON device (%04x:%04x, intf%d) on usb<%d:%d> initialized\n",
2570 vendor
, product
, ifnum
,
2571 usbdev
->bus
->busnum
, usbdev
->devnum
);
2573 mutex_unlock(&driver_lock
);
2574 usb_put_dev(usbdev
);
2579 mutex_unlock(&driver_lock
);
2580 usb_put_dev(usbdev
);
2581 dev_err(dev
, "unable to register, err %d\n", ret
);
2587 * Callback function for USB core API: disconnect
2589 static void imon_disconnect(struct usb_interface
*interface
)
2591 struct imon_context
*ictx
;
2595 /* prevent races with multi-interface device probing and display_open */
2596 mutex_lock(&driver_lock
);
2598 ictx
= usb_get_intfdata(interface
);
2600 ifnum
= interface
->cur_altsetting
->desc
.bInterfaceNumber
;
2603 * sysfs_remove_group is safe to call even if sysfs_create_group
2604 * hasn't been called
2606 sysfs_remove_group(&interface
->dev
.kobj
, &imon_display_attr_group
);
2607 sysfs_remove_group(&interface
->dev
.kobj
, &imon_rf_attr_group
);
2609 usb_set_intfdata(interface
, NULL
);
2611 /* Abort ongoing write */
2612 if (ictx
->tx
.busy
) {
2613 usb_kill_urb(ictx
->tx_urb
);
2614 complete(&ictx
->tx
.finished
);
2618 ictx
->dev_present_intf0
= false;
2619 usb_kill_urb(ictx
->rx_urb_intf0
);
2620 usb_put_dev(ictx
->usbdev_intf0
);
2621 input_unregister_device(ictx
->idev
);
2622 rc_unregister_device(ictx
->rdev
);
2623 if (ictx
->display_supported
) {
2624 if (ictx
->display_type
== IMON_DISPLAY_TYPE_LCD
)
2625 usb_deregister_dev(interface
, &imon_lcd_class
);
2626 else if (ictx
->display_type
== IMON_DISPLAY_TYPE_VFD
)
2627 usb_deregister_dev(interface
, &imon_vfd_class
);
2630 ictx
->dev_present_intf1
= false;
2631 usb_kill_urb(ictx
->rx_urb_intf1
);
2632 usb_put_dev(ictx
->usbdev_intf1
);
2633 if (ictx
->display_type
== IMON_DISPLAY_TYPE_VGA
) {
2634 input_unregister_device(ictx
->touch
);
2635 del_timer_sync(&ictx
->ttimer
);
2639 if (!ictx
->dev_present_intf0
&& !ictx
->dev_present_intf1
)
2640 free_imon_context(ictx
);
2642 mutex_unlock(&driver_lock
);
2644 dev_dbg(dev
, "%s: iMON device (intf%d) disconnected\n",
2648 static int imon_suspend(struct usb_interface
*intf
, pm_message_t message
)
2650 struct imon_context
*ictx
= usb_get_intfdata(intf
);
2651 int ifnum
= intf
->cur_altsetting
->desc
.bInterfaceNumber
;
2654 usb_kill_urb(ictx
->rx_urb_intf0
);
2656 usb_kill_urb(ictx
->rx_urb_intf1
);
2661 static int imon_resume(struct usb_interface
*intf
)
2664 struct imon_context
*ictx
= usb_get_intfdata(intf
);
2665 int ifnum
= intf
->cur_altsetting
->desc
.bInterfaceNumber
;
2668 usb_fill_int_urb(ictx
->rx_urb_intf0
, ictx
->usbdev_intf0
,
2669 usb_rcvintpipe(ictx
->usbdev_intf0
,
2670 ictx
->rx_endpoint_intf0
->bEndpointAddress
),
2671 ictx
->usb_rx_buf
, sizeof(ictx
->usb_rx_buf
),
2672 usb_rx_callback_intf0
, ictx
,
2673 ictx
->rx_endpoint_intf0
->bInterval
);
2675 rc
= usb_submit_urb(ictx
->rx_urb_intf0
, GFP_ATOMIC
);
2678 usb_fill_int_urb(ictx
->rx_urb_intf1
, ictx
->usbdev_intf1
,
2679 usb_rcvintpipe(ictx
->usbdev_intf1
,
2680 ictx
->rx_endpoint_intf1
->bEndpointAddress
),
2681 ictx
->usb_rx_buf
, sizeof(ictx
->usb_rx_buf
),
2682 usb_rx_callback_intf1
, ictx
,
2683 ictx
->rx_endpoint_intf1
->bInterval
);
2685 rc
= usb_submit_urb(ictx
->rx_urb_intf1
, GFP_ATOMIC
);
2691 module_usb_driver(imon_driver
);