2 * imon.c: input and display driver for SoundGraph iMON IR/VFD/LCD
4 * Copyright(C) 2010 Jarod Wilson <jarod@wilsonet.com>
5 * Portions based on the original lirc_imon driver,
6 * Copyright(C) 2004 Venky Raju(dev@venky.ws)
8 * Huge thanks to R. Geoff Newbury for invaluable debugging on the
9 * 0xffdc iMON devices, and for sending me one to hack on, without
10 * which the support for them wouldn't be nearly as good. Thanks
11 * also to the numerous 0xffdc device owners that tested auto-config
12 * support for me and provided debug dumps from their devices.
14 * imon is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software
26 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
29 #define pr_fmt(fmt) KBUILD_MODNAME ":%s: " fmt, __func__
31 #include <linux/errno.h>
32 #include <linux/init.h>
33 #include <linux/kernel.h>
34 #include <linux/module.h>
35 #include <linux/slab.h>
36 #include <linux/uaccess.h>
37 #include <linux/ratelimit.h>
39 #include <linux/input.h>
40 #include <linux/usb.h>
41 #include <linux/usb/input.h>
42 #include <media/rc-core.h>
44 #include <linux/time.h>
45 #include <linux/timer.h>
47 #define MOD_AUTHOR "Jarod Wilson <jarod@wilsonet.com>"
48 #define MOD_DESC "Driver for SoundGraph iMON MultiMedia IR/Display"
49 #define MOD_NAME "imon"
50 #define MOD_VERSION "0.9.4"
52 #define DISPLAY_MINOR_BASE 144
53 #define DEVICE_NAME "lcd%d"
55 #define BUF_CHUNK_SIZE 8
58 #define BIT_DURATION 250 /* each bit received is 250us */
60 #define IMON_CLOCK_ENABLE_PACKETS 2
62 /*** P R O T O T Y P E S ***/
64 /* USB Callback prototypes */
65 static int imon_probe(struct usb_interface
*interface
,
66 const struct usb_device_id
*id
);
67 static void imon_disconnect(struct usb_interface
*interface
);
68 static void usb_rx_callback_intf0(struct urb
*urb
);
69 static void usb_rx_callback_intf1(struct urb
*urb
);
70 static void usb_tx_callback(struct urb
*urb
);
72 /* suspend/resume support */
73 static int imon_resume(struct usb_interface
*intf
);
74 static int imon_suspend(struct usb_interface
*intf
, pm_message_t message
);
76 /* Display file_operations function prototypes */
77 static int display_open(struct inode
*inode
, struct file
*file
);
78 static int display_close(struct inode
*inode
, struct file
*file
);
80 /* VFD write operation */
81 static ssize_t
vfd_write(struct file
*file
, const char __user
*buf
,
82 size_t n_bytes
, loff_t
*pos
);
84 /* LCD file_operations override function prototypes */
85 static ssize_t
lcd_write(struct file
*file
, const char __user
*buf
,
86 size_t n_bytes
, loff_t
*pos
);
88 /*** G L O B A L S ***/
90 struct imon_panel_key_table
{
95 struct imon_usb_dev_descr
{
97 #define IMON_NO_FLAGS 0
98 #define IMON_NEED_20MS_PKT_DELAY 1
99 struct imon_panel_key_table key_table
[];
102 struct imon_context
{
104 /* Newer devices have two interfaces */
105 struct usb_device
*usbdev_intf0
;
106 struct usb_device
*usbdev_intf1
;
108 bool display_supported
; /* not all controllers do */
109 bool display_isopen
; /* display port has been opened */
110 bool rf_device
; /* true if iMON 2.4G LT/DT RF device */
111 bool rf_isassociating
; /* RF remote associating */
112 bool dev_present_intf0
; /* USB device presence, interface 0 */
113 bool dev_present_intf1
; /* USB device presence, interface 1 */
115 struct mutex lock
; /* to lock this object */
116 wait_queue_head_t remove_ok
; /* For unexpected USB disconnects */
118 struct usb_endpoint_descriptor
*rx_endpoint_intf0
;
119 struct usb_endpoint_descriptor
*rx_endpoint_intf1
;
120 struct usb_endpoint_descriptor
*tx_endpoint
;
121 struct urb
*rx_urb_intf0
;
122 struct urb
*rx_urb_intf1
;
125 unsigned char usb_rx_buf
[8];
126 unsigned char usb_tx_buf
[8];
127 unsigned int send_packet_delay
;
130 unsigned char data_buf
[35]; /* user data buffer */
131 struct completion finished
; /* wait for write to finish */
132 bool busy
; /* write in progress */
133 int status
; /* status of tx completion */
136 u16 vendor
; /* usb vendor ID */
137 u16 product
; /* usb product ID */
139 struct rc_dev
*rdev
; /* rc-core device for remote */
140 struct input_dev
*idev
; /* input device for panel & IR mouse */
141 struct input_dev
*touch
; /* input device for touchscreen */
143 spinlock_t kc_lock
; /* make sure we get keycodes right */
144 u32 kc
; /* current input keycode */
145 u32 last_keycode
; /* last reported input keycode */
146 u32 rc_scancode
; /* the computed remote scancode */
147 u8 rc_toggle
; /* the computed remote toggle bit */
148 u64 rc_type
; /* iMON or MCE (RC6) IR protocol? */
149 bool release_code
; /* some keys send a release code */
151 u8 display_type
; /* store the display type */
152 bool pad_mouse
; /* toggle kbd(0)/mouse(1) mode */
154 char name_rdev
[128]; /* rc input device name */
155 char phys_rdev
[64]; /* rc input device phys path */
157 char name_idev
[128]; /* input device name */
158 char phys_idev
[64]; /* input device phys path */
160 char name_touch
[128]; /* touch screen name */
161 char phys_touch
[64]; /* touch screen phys path */
162 struct timer_list ttimer
; /* touch screen timer */
163 int touch_x
; /* x coordinate on touchscreen */
164 int touch_y
; /* y coordinate on touchscreen */
165 struct imon_usb_dev_descr
*dev_descr
; /* device description with key
166 table for front panels */
169 #define TOUCH_TIMEOUT (HZ/30)
171 /* vfd character device file operations */
172 static const struct file_operations vfd_fops
= {
173 .owner
= THIS_MODULE
,
174 .open
= &display_open
,
176 .release
= &display_close
,
177 .llseek
= noop_llseek
,
180 /* lcd character device file operations */
181 static const struct file_operations lcd_fops
= {
182 .owner
= THIS_MODULE
,
183 .open
= &display_open
,
185 .release
= &display_close
,
186 .llseek
= noop_llseek
,
190 IMON_DISPLAY_TYPE_AUTO
= 0,
191 IMON_DISPLAY_TYPE_VFD
= 1,
192 IMON_DISPLAY_TYPE_LCD
= 2,
193 IMON_DISPLAY_TYPE_VGA
= 3,
194 IMON_DISPLAY_TYPE_NONE
= 4,
203 static struct usb_class_driver imon_vfd_class
= {
206 .minor_base
= DISPLAY_MINOR_BASE
,
209 static struct usb_class_driver imon_lcd_class
= {
212 .minor_base
= DISPLAY_MINOR_BASE
,
215 /* imon receiver front panel/knob key table */
216 static const struct imon_usb_dev_descr imon_default_table
= {
217 .flags
= IMON_NO_FLAGS
,
219 { 0x000000000f00ffeell
, KEY_MEDIA
}, /* Go */
220 { 0x000000001200ffeell
, KEY_UP
},
221 { 0x000000001300ffeell
, KEY_DOWN
},
222 { 0x000000001400ffeell
, KEY_LEFT
},
223 { 0x000000001500ffeell
, KEY_RIGHT
},
224 { 0x000000001600ffeell
, KEY_ENTER
},
225 { 0x000000001700ffeell
, KEY_ESC
},
226 { 0x000000001f00ffeell
, KEY_AUDIO
},
227 { 0x000000002000ffeell
, KEY_VIDEO
},
228 { 0x000000002100ffeell
, KEY_CAMERA
},
229 { 0x000000002700ffeell
, KEY_DVD
},
230 { 0x000000002300ffeell
, KEY_TV
},
231 { 0x000000002b00ffeell
, KEY_EXIT
},
232 { 0x000000002c00ffeell
, KEY_SELECT
},
233 { 0x000000002d00ffeell
, KEY_MENU
},
234 { 0x000000000500ffeell
, KEY_PREVIOUS
},
235 { 0x000000000700ffeell
, KEY_REWIND
},
236 { 0x000000000400ffeell
, KEY_STOP
},
237 { 0x000000003c00ffeell
, KEY_PLAYPAUSE
},
238 { 0x000000000800ffeell
, KEY_FASTFORWARD
},
239 { 0x000000000600ffeell
, KEY_NEXT
},
240 { 0x000000010000ffeell
, KEY_RIGHT
},
241 { 0x000001000000ffeell
, KEY_LEFT
},
242 { 0x000000003d00ffeell
, KEY_SELECT
},
243 { 0x000100000000ffeell
, KEY_VOLUMEUP
},
244 { 0x010000000000ffeell
, KEY_VOLUMEDOWN
},
245 { 0x000000000100ffeell
, KEY_MUTE
},
246 /* 0xffdc iMON MCE VFD */
247 { 0x00010000ffffffeell
, KEY_VOLUMEUP
},
248 { 0x01000000ffffffeell
, KEY_VOLUMEDOWN
},
249 { 0x00000001ffffffeell
, KEY_MUTE
},
250 { 0x0000000fffffffeell
, KEY_MEDIA
},
251 { 0x00000012ffffffeell
, KEY_UP
},
252 { 0x00000013ffffffeell
, KEY_DOWN
},
253 { 0x00000014ffffffeell
, KEY_LEFT
},
254 { 0x00000015ffffffeell
, KEY_RIGHT
},
255 { 0x00000016ffffffeell
, KEY_ENTER
},
256 { 0x00000017ffffffeell
, KEY_ESC
},
257 /* iMON Knob values */
258 { 0x000100ffffffffeell
, KEY_VOLUMEUP
},
259 { 0x010000ffffffffeell
, KEY_VOLUMEDOWN
},
260 { 0x000008ffffffffeell
, KEY_MUTE
},
265 static const struct imon_usb_dev_descr imon_OEM_VFD
= {
266 .flags
= IMON_NEED_20MS_PKT_DELAY
,
268 { 0x000000000f00ffeell
, KEY_MEDIA
}, /* Go */
269 { 0x000000001200ffeell
, KEY_UP
},
270 { 0x000000001300ffeell
, KEY_DOWN
},
271 { 0x000000001400ffeell
, KEY_LEFT
},
272 { 0x000000001500ffeell
, KEY_RIGHT
},
273 { 0x000000001600ffeell
, KEY_ENTER
},
274 { 0x000000001700ffeell
, KEY_ESC
},
275 { 0x000000001f00ffeell
, KEY_AUDIO
},
276 { 0x000000002b00ffeell
, KEY_EXIT
},
277 { 0x000000002c00ffeell
, KEY_SELECT
},
278 { 0x000000002d00ffeell
, KEY_MENU
},
279 { 0x000000000500ffeell
, KEY_PREVIOUS
},
280 { 0x000000000700ffeell
, KEY_REWIND
},
281 { 0x000000000400ffeell
, KEY_STOP
},
282 { 0x000000003c00ffeell
, KEY_PLAYPAUSE
},
283 { 0x000000000800ffeell
, KEY_FASTFORWARD
},
284 { 0x000000000600ffeell
, KEY_NEXT
},
285 { 0x000000010000ffeell
, KEY_RIGHT
},
286 { 0x000001000000ffeell
, KEY_LEFT
},
287 { 0x000000003d00ffeell
, KEY_SELECT
},
288 { 0x000100000000ffeell
, KEY_VOLUMEUP
},
289 { 0x010000000000ffeell
, KEY_VOLUMEDOWN
},
290 { 0x000000000100ffeell
, KEY_MUTE
},
291 /* 0xffdc iMON MCE VFD */
292 { 0x00010000ffffffeell
, KEY_VOLUMEUP
},
293 { 0x01000000ffffffeell
, KEY_VOLUMEDOWN
},
294 { 0x00000001ffffffeell
, KEY_MUTE
},
295 { 0x0000000fffffffeell
, KEY_MEDIA
},
296 { 0x00000012ffffffeell
, KEY_UP
},
297 { 0x00000013ffffffeell
, KEY_DOWN
},
298 { 0x00000014ffffffeell
, KEY_LEFT
},
299 { 0x00000015ffffffeell
, KEY_RIGHT
},
300 { 0x00000016ffffffeell
, KEY_ENTER
},
301 { 0x00000017ffffffeell
, KEY_ESC
},
302 /* iMON Knob values */
303 { 0x000100ffffffffeell
, KEY_VOLUMEUP
},
304 { 0x010000ffffffffeell
, KEY_VOLUMEDOWN
},
305 { 0x000008ffffffffeell
, KEY_MUTE
},
310 /* imon receiver front panel/knob key table for DH102*/
311 static const struct imon_usb_dev_descr imon_DH102
= {
312 .flags
= IMON_NO_FLAGS
,
314 { 0x000100000000ffeell
, KEY_VOLUMEUP
},
315 { 0x010000000000ffeell
, KEY_VOLUMEDOWN
},
316 { 0x000000010000ffeell
, KEY_MUTE
},
317 { 0x0000000f0000ffeell
, KEY_MEDIA
},
318 { 0x000000120000ffeell
, KEY_UP
},
319 { 0x000000130000ffeell
, KEY_DOWN
},
320 { 0x000000140000ffeell
, KEY_LEFT
},
321 { 0x000000150000ffeell
, KEY_RIGHT
},
322 { 0x000000160000ffeell
, KEY_ENTER
},
323 { 0x000000170000ffeell
, KEY_ESC
},
324 { 0x0000002b0000ffeell
, KEY_EXIT
},
325 { 0x0000002c0000ffeell
, KEY_SELECT
},
326 { 0x0000002d0000ffeell
, KEY_MENU
},
332 * USB Device ID for iMON USB Control Boards
334 * The Windows drivers contain 6 different inf files, more or less one for
335 * each new device until the 0x0034-0x0046 devices, which all use the same
336 * driver. Some of the devices in the 34-46 range haven't been definitively
337 * identified yet. Early devices have either a TriGem Computer, Inc. or a
338 * Samsung vendor ID (0x0aa8 and 0x04e8 respectively), while all later
339 * devices use the SoundGraph vendor ID (0x15c2). This driver only supports
340 * the ffdc and later devices, which do onboard decoding.
342 static struct usb_device_id imon_usb_id_table
[] = {
344 * Several devices with this same device ID, all use iMON_PAD.inf
345 * SoundGraph iMON PAD (IR & VFD)
346 * SoundGraph iMON PAD (IR & LCD)
347 * SoundGraph iMON Knob (IR only)
349 { USB_DEVICE(0x15c2, 0xffdc),
350 .driver_info
= (unsigned long)&imon_default_table
},
353 * Newer devices, all driven by the latest iMON Windows driver, full
354 * list of device IDs extracted via 'strings Setup/data1.hdr |grep 15c2'
355 * Need user input to fill in details on unknown devices.
357 /* SoundGraph iMON OEM Touch LCD (IR & 7" VGA LCD) */
358 { USB_DEVICE(0x15c2, 0x0034),
359 .driver_info
= (unsigned long)&imon_DH102
},
360 /* SoundGraph iMON OEM Touch LCD (IR & 4.3" VGA LCD) */
361 { USB_DEVICE(0x15c2, 0x0035),
362 .driver_info
= (unsigned long)&imon_default_table
},
363 /* SoundGraph iMON OEM VFD (IR & VFD) */
364 { USB_DEVICE(0x15c2, 0x0036),
365 .driver_info
= (unsigned long)&imon_OEM_VFD
},
366 /* device specifics unknown */
367 { USB_DEVICE(0x15c2, 0x0037),
368 .driver_info
= (unsigned long)&imon_default_table
},
369 /* SoundGraph iMON OEM LCD (IR & LCD) */
370 { USB_DEVICE(0x15c2, 0x0038),
371 .driver_info
= (unsigned long)&imon_default_table
},
372 /* SoundGraph iMON UltraBay (IR & LCD) */
373 { USB_DEVICE(0x15c2, 0x0039),
374 .driver_info
= (unsigned long)&imon_default_table
},
375 /* device specifics unknown */
376 { USB_DEVICE(0x15c2, 0x003a),
377 .driver_info
= (unsigned long)&imon_default_table
},
378 /* device specifics unknown */
379 { USB_DEVICE(0x15c2, 0x003b),
380 .driver_info
= (unsigned long)&imon_default_table
},
381 /* SoundGraph iMON OEM Inside (IR only) */
382 { USB_DEVICE(0x15c2, 0x003c),
383 .driver_info
= (unsigned long)&imon_default_table
},
384 /* device specifics unknown */
385 { USB_DEVICE(0x15c2, 0x003d),
386 .driver_info
= (unsigned long)&imon_default_table
},
387 /* device specifics unknown */
388 { USB_DEVICE(0x15c2, 0x003e),
389 .driver_info
= (unsigned long)&imon_default_table
},
390 /* device specifics unknown */
391 { USB_DEVICE(0x15c2, 0x003f),
392 .driver_info
= (unsigned long)&imon_default_table
},
393 /* device specifics unknown */
394 { USB_DEVICE(0x15c2, 0x0040),
395 .driver_info
= (unsigned long)&imon_default_table
},
396 /* SoundGraph iMON MINI (IR only) */
397 { USB_DEVICE(0x15c2, 0x0041),
398 .driver_info
= (unsigned long)&imon_default_table
},
399 /* Antec Veris Multimedia Station EZ External (IR only) */
400 { USB_DEVICE(0x15c2, 0x0042),
401 .driver_info
= (unsigned long)&imon_default_table
},
402 /* Antec Veris Multimedia Station Basic Internal (IR only) */
403 { USB_DEVICE(0x15c2, 0x0043),
404 .driver_info
= (unsigned long)&imon_default_table
},
405 /* Antec Veris Multimedia Station Elite (IR & VFD) */
406 { USB_DEVICE(0x15c2, 0x0044),
407 .driver_info
= (unsigned long)&imon_default_table
},
408 /* Antec Veris Multimedia Station Premiere (IR & LCD) */
409 { USB_DEVICE(0x15c2, 0x0045),
410 .driver_info
= (unsigned long)&imon_default_table
},
411 /* device specifics unknown */
412 { USB_DEVICE(0x15c2, 0x0046),
413 .driver_info
= (unsigned long)&imon_default_table
},
417 /* USB Device data */
418 static struct usb_driver imon_driver
= {
421 .disconnect
= imon_disconnect
,
422 .suspend
= imon_suspend
,
423 .resume
= imon_resume
,
424 .id_table
= imon_usb_id_table
,
427 /* to prevent races between open() and disconnect(), probing, etc */
428 static DEFINE_MUTEX(driver_lock
);
430 /* Module bookkeeping bits */
431 MODULE_AUTHOR(MOD_AUTHOR
);
432 MODULE_DESCRIPTION(MOD_DESC
);
433 MODULE_VERSION(MOD_VERSION
);
434 MODULE_LICENSE("GPL");
435 MODULE_DEVICE_TABLE(usb
, imon_usb_id_table
);
438 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
439 MODULE_PARM_DESC(debug
, "Debug messages: 0=no, 1=yes (default: no)");
441 /* lcd, vfd, vga or none? should be auto-detected, but can be overridden... */
442 static int display_type
;
443 module_param(display_type
, int, S_IRUGO
);
444 MODULE_PARM_DESC(display_type
, "Type of attached display. 0=autodetect, "
445 "1=vfd, 2=lcd, 3=vga, 4=none (default: autodetect)");
447 static int pad_stabilize
= 1;
448 module_param(pad_stabilize
, int, S_IRUGO
| S_IWUSR
);
449 MODULE_PARM_DESC(pad_stabilize
, "Apply stabilization algorithm to iMON PAD "
450 "presses in arrow key mode. 0=disable, 1=enable (default).");
453 * In certain use cases, mouse mode isn't really helpful, and could actually
454 * cause confusion, so allow disabling it when the IR device is open.
457 module_param(nomouse
, bool, S_IRUGO
| S_IWUSR
);
458 MODULE_PARM_DESC(nomouse
, "Disable mouse input device mode when IR device is "
459 "open. 0=don't disable, 1=disable. (default: don't disable)");
461 /* threshold at which a pad push registers as an arrow key in kbd mode */
462 static int pad_thresh
;
463 module_param(pad_thresh
, int, S_IRUGO
| S_IWUSR
);
464 MODULE_PARM_DESC(pad_thresh
, "Threshold at which a pad push registers as an "
465 "arrow key in kbd mode (default: 28)");
468 static void free_imon_context(struct imon_context
*ictx
)
470 struct device
*dev
= ictx
->dev
;
472 usb_free_urb(ictx
->tx_urb
);
473 usb_free_urb(ictx
->rx_urb_intf0
);
474 usb_free_urb(ictx
->rx_urb_intf1
);
477 dev_dbg(dev
, "%s: iMON context freed\n", __func__
);
481 * Called when the Display device (e.g. /dev/lcd0)
482 * is opened by the application.
484 static int display_open(struct inode
*inode
, struct file
*file
)
486 struct usb_interface
*interface
;
487 struct imon_context
*ictx
= NULL
;
491 /* prevent races with disconnect */
492 mutex_lock(&driver_lock
);
494 subminor
= iminor(inode
);
495 interface
= usb_find_interface(&imon_driver
, subminor
);
497 pr_err("could not find interface for minor %d\n", subminor
);
501 ictx
= usb_get_intfdata(interface
);
504 pr_err("no context found for minor %d\n", subminor
);
509 mutex_lock(&ictx
->lock
);
511 if (!ictx
->display_supported
) {
512 pr_err("display not supported by device\n");
514 } else if (ictx
->display_isopen
) {
515 pr_err("display port is already open\n");
518 ictx
->display_isopen
= true;
519 file
->private_data
= ictx
;
520 dev_dbg(ictx
->dev
, "display port opened\n");
523 mutex_unlock(&ictx
->lock
);
526 mutex_unlock(&driver_lock
);
531 * Called when the display device (e.g. /dev/lcd0)
532 * is closed by the application.
534 static int display_close(struct inode
*inode
, struct file
*file
)
536 struct imon_context
*ictx
= NULL
;
539 ictx
= file
->private_data
;
542 pr_err("no context for device\n");
546 mutex_lock(&ictx
->lock
);
548 if (!ictx
->display_supported
) {
549 pr_err("display not supported by device\n");
551 } else if (!ictx
->display_isopen
) {
552 pr_err("display is not open\n");
555 ictx
->display_isopen
= false;
556 dev_dbg(ictx
->dev
, "display port closed\n");
559 mutex_unlock(&ictx
->lock
);
564 * Sends a packet to the device -- this function must be called with
565 * ictx->lock held, or its unlock/lock sequence while waiting for tx
566 * to complete can/will lead to a deadlock.
568 static int send_packet(struct imon_context
*ictx
)
571 unsigned long timeout
;
574 struct usb_ctrlrequest
*control_req
= NULL
;
576 /* Check if we need to use control or interrupt urb */
577 if (!ictx
->tx_control
) {
578 pipe
= usb_sndintpipe(ictx
->usbdev_intf0
,
579 ictx
->tx_endpoint
->bEndpointAddress
);
580 interval
= ictx
->tx_endpoint
->bInterval
;
582 usb_fill_int_urb(ictx
->tx_urb
, ictx
->usbdev_intf0
, pipe
,
584 sizeof(ictx
->usb_tx_buf
),
585 usb_tx_callback
, ictx
, interval
);
587 ictx
->tx_urb
->actual_length
= 0;
589 /* fill request into kmalloc'ed space: */
590 control_req
= kmalloc(sizeof(struct usb_ctrlrequest
),
592 if (control_req
== NULL
)
595 /* setup packet is '21 09 0200 0001 0008' */
596 control_req
->bRequestType
= 0x21;
597 control_req
->bRequest
= 0x09;
598 control_req
->wValue
= cpu_to_le16(0x0200);
599 control_req
->wIndex
= cpu_to_le16(0x0001);
600 control_req
->wLength
= cpu_to_le16(0x0008);
602 /* control pipe is endpoint 0x00 */
603 pipe
= usb_sndctrlpipe(ictx
->usbdev_intf0
, 0);
605 /* build the control urb */
606 usb_fill_control_urb(ictx
->tx_urb
, ictx
->usbdev_intf0
,
607 pipe
, (unsigned char *)control_req
,
609 sizeof(ictx
->usb_tx_buf
),
610 usb_tx_callback
, ictx
);
611 ictx
->tx_urb
->actual_length
= 0;
614 init_completion(&ictx
->tx
.finished
);
615 ictx
->tx
.busy
= true;
616 smp_rmb(); /* ensure later readers know we're busy */
618 retval
= usb_submit_urb(ictx
->tx_urb
, GFP_KERNEL
);
620 ictx
->tx
.busy
= false;
621 smp_rmb(); /* ensure later readers know we're not busy */
622 pr_err_ratelimited("error submitting urb(%d)\n", retval
);
624 /* Wait for transmission to complete (or abort) */
625 mutex_unlock(&ictx
->lock
);
626 retval
= wait_for_completion_interruptible(
629 usb_kill_urb(ictx
->tx_urb
);
630 pr_err_ratelimited("task interrupted\n");
632 mutex_lock(&ictx
->lock
);
634 retval
= ictx
->tx
.status
;
636 pr_err_ratelimited("packet tx failed (%d)\n", retval
);
642 * Induce a mandatory delay before returning, as otherwise,
643 * send_packet can get called so rapidly as to overwhelm the device,
644 * particularly on faster systems and/or those with quirky usb.
646 timeout
= msecs_to_jiffies(ictx
->send_packet_delay
);
647 set_current_state(TASK_INTERRUPTIBLE
);
648 schedule_timeout(timeout
);
654 * Sends an associate packet to the iMON 2.4G.
656 * This might not be such a good idea, since it has an id collision with
657 * some versions of the "IR & VFD" combo. The only way to determine if it
658 * is an RF version is to look at the product description string. (Which
659 * we currently do not fetch).
661 static int send_associate_24g(struct imon_context
*ictx
)
664 const unsigned char packet
[8] = { 0x01, 0x00, 0x00, 0x00,
665 0x00, 0x00, 0x00, 0x20 };
668 pr_err("no context for device\n");
672 if (!ictx
->dev_present_intf0
) {
673 pr_err("no iMON device present\n");
677 memcpy(ictx
->usb_tx_buf
, packet
, sizeof(packet
));
678 retval
= send_packet(ictx
);
684 * Sends packets to setup and show clock on iMON display
686 * Arguments: year - last 2 digits of year, month - 1..12,
687 * day - 1..31, dow - day of the week (0-Sun...6-Sat),
688 * hour - 0..23, minute - 0..59, second - 0..59
690 static int send_set_imon_clock(struct imon_context
*ictx
,
691 unsigned int year
, unsigned int month
,
692 unsigned int day
, unsigned int dow
,
693 unsigned int hour
, unsigned int minute
,
696 unsigned char clock_enable_pkt
[IMON_CLOCK_ENABLE_PACKETS
][8];
701 pr_err("no context for device\n");
705 switch (ictx
->display_type
) {
706 case IMON_DISPLAY_TYPE_LCD
:
707 clock_enable_pkt
[0][0] = 0x80;
708 clock_enable_pkt
[0][1] = year
;
709 clock_enable_pkt
[0][2] = month
-1;
710 clock_enable_pkt
[0][3] = day
;
711 clock_enable_pkt
[0][4] = hour
;
712 clock_enable_pkt
[0][5] = minute
;
713 clock_enable_pkt
[0][6] = second
;
715 clock_enable_pkt
[1][0] = 0x80;
716 clock_enable_pkt
[1][1] = 0;
717 clock_enable_pkt
[1][2] = 0;
718 clock_enable_pkt
[1][3] = 0;
719 clock_enable_pkt
[1][4] = 0;
720 clock_enable_pkt
[1][5] = 0;
721 clock_enable_pkt
[1][6] = 0;
723 if (ictx
->product
== 0xffdc) {
724 clock_enable_pkt
[0][7] = 0x50;
725 clock_enable_pkt
[1][7] = 0x51;
727 clock_enable_pkt
[0][7] = 0x88;
728 clock_enable_pkt
[1][7] = 0x8a;
733 case IMON_DISPLAY_TYPE_VFD
:
734 clock_enable_pkt
[0][0] = year
;
735 clock_enable_pkt
[0][1] = month
-1;
736 clock_enable_pkt
[0][2] = day
;
737 clock_enable_pkt
[0][3] = dow
;
738 clock_enable_pkt
[0][4] = hour
;
739 clock_enable_pkt
[0][5] = minute
;
740 clock_enable_pkt
[0][6] = second
;
741 clock_enable_pkt
[0][7] = 0x40;
743 clock_enable_pkt
[1][0] = 0;
744 clock_enable_pkt
[1][1] = 0;
745 clock_enable_pkt
[1][2] = 1;
746 clock_enable_pkt
[1][3] = 0;
747 clock_enable_pkt
[1][4] = 0;
748 clock_enable_pkt
[1][5] = 0;
749 clock_enable_pkt
[1][6] = 0;
750 clock_enable_pkt
[1][7] = 0x42;
758 for (i
= 0; i
< IMON_CLOCK_ENABLE_PACKETS
; i
++) {
759 memcpy(ictx
->usb_tx_buf
, clock_enable_pkt
[i
], 8);
760 retval
= send_packet(ictx
);
762 pr_err("send_packet failed for packet %d\n", i
);
771 * These are the sysfs functions to handle the association on the iMON 2.4G LT.
773 static ssize_t
show_associate_remote(struct device
*d
,
774 struct device_attribute
*attr
,
777 struct imon_context
*ictx
= dev_get_drvdata(d
);
782 mutex_lock(&ictx
->lock
);
783 if (ictx
->rf_isassociating
)
784 strcpy(buf
, "associating\n");
786 strcpy(buf
, "closed\n");
788 dev_info(d
, "Visit http://www.lirc.org/html/imon-24g.html for "
789 "instructions on how to associate your iMON 2.4G DT/LT "
791 mutex_unlock(&ictx
->lock
);
795 static ssize_t
store_associate_remote(struct device
*d
,
796 struct device_attribute
*attr
,
797 const char *buf
, size_t count
)
799 struct imon_context
*ictx
;
801 ictx
= dev_get_drvdata(d
);
806 mutex_lock(&ictx
->lock
);
807 ictx
->rf_isassociating
= true;
808 send_associate_24g(ictx
);
809 mutex_unlock(&ictx
->lock
);
815 * sysfs functions to control internal imon clock
817 static ssize_t
show_imon_clock(struct device
*d
,
818 struct device_attribute
*attr
, char *buf
)
820 struct imon_context
*ictx
= dev_get_drvdata(d
);
826 mutex_lock(&ictx
->lock
);
828 if (!ictx
->display_supported
) {
829 len
= snprintf(buf
, PAGE_SIZE
, "Not supported.");
831 len
= snprintf(buf
, PAGE_SIZE
,
832 "To set the clock on your iMON display:\n"
833 "# date \"+%%y %%m %%d %%w %%H %%M %%S\" > imon_clock\n"
834 "%s", ictx
->display_isopen
?
835 "\nNOTE: imon device must be closed\n" : "");
838 mutex_unlock(&ictx
->lock
);
843 static ssize_t
store_imon_clock(struct device
*d
,
844 struct device_attribute
*attr
,
845 const char *buf
, size_t count
)
847 struct imon_context
*ictx
= dev_get_drvdata(d
);
849 unsigned int year
, month
, day
, dow
, hour
, minute
, second
;
854 mutex_lock(&ictx
->lock
);
856 if (!ictx
->display_supported
) {
859 } else if (ictx
->display_isopen
) {
864 if (sscanf(buf
, "%u %u %u %u %u %u %u", &year
, &month
, &day
, &dow
,
865 &hour
, &minute
, &second
) != 7) {
870 if ((month
< 1 || month
> 12) ||
871 (day
< 1 || day
> 31) || (dow
> 6) ||
872 (hour
> 23) || (minute
> 59) || (second
> 59)) {
877 retval
= send_set_imon_clock(ictx
, year
, month
, day
, dow
,
878 hour
, minute
, second
);
884 mutex_unlock(&ictx
->lock
);
890 static DEVICE_ATTR(imon_clock
, S_IWUSR
| S_IRUGO
, show_imon_clock
,
893 static DEVICE_ATTR(associate_remote
, S_IWUSR
| S_IRUGO
, show_associate_remote
,
894 store_associate_remote
);
896 static struct attribute
*imon_display_sysfs_entries
[] = {
897 &dev_attr_imon_clock
.attr
,
901 static struct attribute_group imon_display_attr_group
= {
902 .attrs
= imon_display_sysfs_entries
905 static struct attribute
*imon_rf_sysfs_entries
[] = {
906 &dev_attr_associate_remote
.attr
,
910 static struct attribute_group imon_rf_attr_group
= {
911 .attrs
= imon_rf_sysfs_entries
915 * Writes data to the VFD. The iMON VFD is 2x16 characters
916 * and requires data in 5 consecutive USB interrupt packets,
917 * each packet but the last carrying 7 bytes.
919 * I don't know if the VFD board supports features such as
920 * scrolling, clearing rows, blanking, etc. so at
921 * the caller must provide a full screen of data. If fewer
922 * than 32 bytes are provided spaces will be appended to
923 * generate a full screen.
925 static ssize_t
vfd_write(struct file
*file
, const char __user
*buf
,
926 size_t n_bytes
, loff_t
*pos
)
932 struct imon_context
*ictx
;
933 const unsigned char vfd_packet6
[] = {
934 0x01, 0x00, 0x00, 0x00, 0x00, 0xFF, 0xFF };
936 ictx
= file
->private_data
;
938 pr_err_ratelimited("no context for device\n");
942 mutex_lock(&ictx
->lock
);
944 if (!ictx
->dev_present_intf0
) {
945 pr_err_ratelimited("no iMON device present\n");
950 if (n_bytes
<= 0 || n_bytes
> 32) {
951 pr_err_ratelimited("invalid payload size\n");
956 if (copy_from_user(ictx
->tx
.data_buf
, buf
, n_bytes
)) {
961 /* Pad with spaces */
962 for (i
= n_bytes
; i
< 32; ++i
)
963 ictx
->tx
.data_buf
[i
] = ' ';
965 for (i
= 32; i
< 35; ++i
)
966 ictx
->tx
.data_buf
[i
] = 0xFF;
972 memcpy(ictx
->usb_tx_buf
, ictx
->tx
.data_buf
+ offset
, 7);
973 ictx
->usb_tx_buf
[7] = (unsigned char) seq
;
975 retval
= send_packet(ictx
);
977 pr_err_ratelimited("send packet #%d failed\n", seq
/ 2);
984 } while (offset
< 35);
987 memcpy(ictx
->usb_tx_buf
, &vfd_packet6
, sizeof(vfd_packet6
));
988 ictx
->usb_tx_buf
[7] = (unsigned char) seq
;
989 retval
= send_packet(ictx
);
991 pr_err_ratelimited("send packet #%d failed\n", seq
/ 2);
994 mutex_unlock(&ictx
->lock
);
996 return (!retval
) ? n_bytes
: retval
;
1000 * Writes data to the LCD. The iMON OEM LCD screen expects 8-byte
1001 * packets. We accept data as 16 hexadecimal digits, followed by a
1002 * newline (to make it easy to drive the device from a command-line
1003 * -- even though the actual binary data is a bit complicated).
1005 * The device itself is not a "traditional" text-mode display. It's
1006 * actually a 16x96 pixel bitmap display. That means if you want to
1007 * display text, you've got to have your own "font" and translate the
1008 * text into bitmaps for display. This is really flexible (you can
1009 * display whatever diacritics you need, and so on), but it's also
1010 * a lot more complicated than most LCDs...
1012 static ssize_t
lcd_write(struct file
*file
, const char __user
*buf
,
1013 size_t n_bytes
, loff_t
*pos
)
1016 struct imon_context
*ictx
;
1018 ictx
= file
->private_data
;
1020 pr_err_ratelimited("no context for device\n");
1024 mutex_lock(&ictx
->lock
);
1026 if (!ictx
->display_supported
) {
1027 pr_err_ratelimited("no iMON display present\n");
1033 pr_err_ratelimited("invalid payload size: %d (expected 8)\n",
1039 if (copy_from_user(ictx
->usb_tx_buf
, buf
, 8)) {
1044 retval
= send_packet(ictx
);
1046 pr_err_ratelimited("send packet failed!\n");
1049 dev_dbg(ictx
->dev
, "%s: write %d bytes to LCD\n",
1050 __func__
, (int) n_bytes
);
1053 mutex_unlock(&ictx
->lock
);
1054 return (!retval
) ? n_bytes
: retval
;
1058 * Callback function for USB core API: transmit data
1060 static void usb_tx_callback(struct urb
*urb
)
1062 struct imon_context
*ictx
;
1066 ictx
= (struct imon_context
*)urb
->context
;
1070 ictx
->tx
.status
= urb
->status
;
1072 /* notify waiters that write has finished */
1073 ictx
->tx
.busy
= false;
1074 smp_rmb(); /* ensure later readers know we're not busy */
1075 complete(&ictx
->tx
.finished
);
1079 * report touchscreen input
1081 static void imon_touch_display_timeout(unsigned long data
)
1083 struct imon_context
*ictx
= (struct imon_context
*)data
;
1085 if (ictx
->display_type
!= IMON_DISPLAY_TYPE_VGA
)
1088 input_report_abs(ictx
->touch
, ABS_X
, ictx
->touch_x
);
1089 input_report_abs(ictx
->touch
, ABS_Y
, ictx
->touch_y
);
1090 input_report_key(ictx
->touch
, BTN_TOUCH
, 0x00);
1091 input_sync(ictx
->touch
);
1095 * iMON IR receivers support two different signal sets -- those used by
1096 * the iMON remotes, and those used by the Windows MCE remotes (which is
1097 * really just RC-6), but only one or the other at a time, as the signals
1098 * are decoded onboard the receiver.
1100 * This function gets called two different ways, one way is from
1101 * rc_register_device, for initial protocol selection/setup, and the other is
1102 * via a userspace-initiated protocol change request, either by direct sysfs
1103 * prodding or by something like ir-keytable. In the rc_register_device case,
1104 * the imon context lock is already held, but when initiated from userspace,
1105 * it is not, so we must acquire it prior to calling send_packet, which
1106 * requires that the lock is held.
1108 static int imon_ir_change_protocol(struct rc_dev
*rc
, u64
*rc_type
)
1111 struct imon_context
*ictx
= rc
->priv
;
1112 struct device
*dev
= ictx
->dev
;
1113 bool unlock
= false;
1114 unsigned char ir_proto_packet
[] = {
1115 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x86 };
1117 if (*rc_type
&& !(*rc_type
& rc
->allowed_protocols
))
1118 dev_warn(dev
, "Looks like you're trying to use an IR protocol "
1119 "this device does not support\n");
1121 if (*rc_type
& RC_BIT_RC6_MCE
) {
1122 dev_dbg(dev
, "Configuring IR receiver for MCE protocol\n");
1123 ir_proto_packet
[0] = 0x01;
1124 *rc_type
= RC_BIT_RC6_MCE
;
1125 } else if (*rc_type
& RC_BIT_OTHER
) {
1126 dev_dbg(dev
, "Configuring IR receiver for iMON protocol\n");
1128 dev_dbg(dev
, "PAD stabilize functionality disabled\n");
1129 /* ir_proto_packet[0] = 0x00; // already the default */
1130 *rc_type
= RC_BIT_OTHER
;
1132 dev_warn(dev
, "Unsupported IR protocol specified, overriding "
1133 "to iMON IR protocol\n");
1135 dev_dbg(dev
, "PAD stabilize functionality disabled\n");
1136 /* ir_proto_packet[0] = 0x00; // already the default */
1137 *rc_type
= RC_BIT_OTHER
;
1140 memcpy(ictx
->usb_tx_buf
, &ir_proto_packet
, sizeof(ir_proto_packet
));
1142 if (!mutex_is_locked(&ictx
->lock
)) {
1144 mutex_lock(&ictx
->lock
);
1147 retval
= send_packet(ictx
);
1151 ictx
->rc_type
= *rc_type
;
1152 ictx
->pad_mouse
= false;
1156 mutex_unlock(&ictx
->lock
);
1161 static inline int tv2int(const struct timeval
*a
, const struct timeval
*b
)
1166 if (b
->tv_usec
> a
->tv_usec
) {
1171 usecs
+= a
->tv_usec
- b
->tv_usec
;
1173 sec
+= a
->tv_sec
- b
->tv_sec
;
1185 * The directional pad behaves a bit differently, depending on whether this is
1186 * one of the older ffdc devices or a newer device. Newer devices appear to
1187 * have a higher resolution matrix for more precise mouse movement, but it
1188 * makes things overly sensitive in keyboard mode, so we do some interesting
1189 * contortions to make it less touchy. Older devices run through the same
1190 * routine with shorter timeout and a smaller threshold.
1192 static int stabilize(int a
, int b
, u16 timeout
, u16 threshold
)
1195 static struct timeval prev_time
= {0, 0};
1196 static struct timeval hit_time
= {0, 0};
1197 static int x
, y
, prev_result
, hits
;
1201 do_gettimeofday(&ct
);
1202 msec
= tv2int(&ct
, &prev_time
);
1203 msec_hit
= tv2int(&ct
, &hit_time
);
1216 if (abs(x
) > threshold
|| abs(y
) > threshold
) {
1217 if (abs(y
) > abs(x
))
1218 result
= (y
> 0) ? 0x7F : 0x80;
1220 result
= (x
> 0) ? 0x7F00 : 0x8000;
1225 if (result
== prev_result
) {
1231 y
= 17 * threshold
/ 30;
1234 y
-= 17 * threshold
/ 30;
1237 x
= 17 * threshold
/ 30;
1240 x
-= 17 * threshold
/ 30;
1245 if (hits
== 2 && msec_hit
< timeout
) {
1250 prev_result
= result
;
1259 static u32
imon_remote_key_lookup(struct imon_context
*ictx
, u32 scancode
)
1263 bool is_release_code
= false;
1265 /* Look for the initial press of a button */
1266 keycode
= rc_g_keycode_from_table(ictx
->rdev
, scancode
);
1267 ictx
->rc_toggle
= 0x0;
1268 ictx
->rc_scancode
= scancode
;
1270 /* Look for the release of a button */
1271 if (keycode
== KEY_RESERVED
) {
1272 release
= scancode
& ~0x4000;
1273 keycode
= rc_g_keycode_from_table(ictx
->rdev
, release
);
1274 if (keycode
!= KEY_RESERVED
)
1275 is_release_code
= true;
1278 ictx
->release_code
= is_release_code
;
1283 static u32
imon_mce_key_lookup(struct imon_context
*ictx
, u32 scancode
)
1287 #define MCE_KEY_MASK 0x7000
1288 #define MCE_TOGGLE_BIT 0x8000
1291 * On some receivers, mce keys decode to 0x8000f04xx and 0x8000f84xx
1292 * (the toggle bit flipping between alternating key presses), while
1293 * on other receivers, we see 0x8000f74xx and 0x8000ff4xx. To keep
1294 * the table trim, we always or in the bits to look up 0x8000ff4xx,
1295 * but we can't or them into all codes, as some keys are decoded in
1296 * a different way w/o the same use of the toggle bit...
1298 if (scancode
& 0x80000000)
1299 scancode
= scancode
| MCE_KEY_MASK
| MCE_TOGGLE_BIT
;
1301 ictx
->rc_scancode
= scancode
;
1302 keycode
= rc_g_keycode_from_table(ictx
->rdev
, scancode
);
1304 /* not used in mce mode, but make sure we know its false */
1305 ictx
->release_code
= false;
1310 static u32
imon_panel_key_lookup(struct imon_context
*ictx
, u64 code
)
1313 u32 keycode
= KEY_RESERVED
;
1314 struct imon_panel_key_table
*key_table
= ictx
->dev_descr
->key_table
;
1316 for (i
= 0; key_table
[i
].hw_code
!= 0; i
++) {
1317 if (key_table
[i
].hw_code
== (code
| 0xffee)) {
1318 keycode
= key_table
[i
].keycode
;
1322 ictx
->release_code
= false;
1326 static bool imon_mouse_event(struct imon_context
*ictx
,
1327 unsigned char *buf
, int len
)
1329 signed char rel_x
= 0x00, rel_y
= 0x00;
1331 bool mouse_input
= true;
1333 unsigned long flags
;
1335 spin_lock_irqsave(&ictx
->kc_lock
, flags
);
1337 /* newer iMON device PAD or mouse button */
1338 if (ictx
->product
!= 0xffdc && (buf
[0] & 0x01) && len
== 5) {
1342 /* 0xffdc iMON PAD or mouse button input */
1343 } else if (ictx
->product
== 0xffdc && (buf
[0] & 0x40) &&
1344 !((buf
[1] & 0x01) || ((buf
[1] >> 2) & 0x01))) {
1345 rel_x
= (buf
[1] & 0x08) | (buf
[1] & 0x10) >> 2 |
1346 (buf
[1] & 0x20) >> 4 | (buf
[1] & 0x40) >> 6;
1349 rel_x
= rel_x
+ rel_x
/ 2;
1350 rel_y
= (buf
[2] & 0x08) | (buf
[2] & 0x10) >> 2 |
1351 (buf
[2] & 0x20) >> 4 | (buf
[2] & 0x40) >> 6;
1354 rel_y
= rel_y
+ rel_y
/ 2;
1356 /* some ffdc devices decode mouse buttons differently... */
1357 } else if (ictx
->product
== 0xffdc && (buf
[0] == 0x68)) {
1359 /* ch+/- buttons, which we use for an emulated scroll wheel */
1360 } else if (ictx
->kc
== KEY_CHANNELUP
&& (buf
[2] & 0x40) != 0x40) {
1362 } else if (ictx
->kc
== KEY_CHANNELDOWN
&& (buf
[2] & 0x40) != 0x40) {
1365 mouse_input
= false;
1367 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1370 dev_dbg(ictx
->dev
, "sending mouse data via input subsystem\n");
1373 input_report_rel(ictx
->idev
, REL_WHEEL
, dir
);
1374 } else if (rel_x
|| rel_y
) {
1375 input_report_rel(ictx
->idev
, REL_X
, rel_x
);
1376 input_report_rel(ictx
->idev
, REL_Y
, rel_y
);
1378 input_report_key(ictx
->idev
, BTN_LEFT
, buf
[1] & 0x1);
1379 input_report_key(ictx
->idev
, BTN_RIGHT
,
1380 buf
[1] >> right_shift
& 0x1);
1382 input_sync(ictx
->idev
);
1383 spin_lock_irqsave(&ictx
->kc_lock
, flags
);
1384 ictx
->last_keycode
= ictx
->kc
;
1385 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1391 static void imon_touch_event(struct imon_context
*ictx
, unsigned char *buf
)
1393 mod_timer(&ictx
->ttimer
, jiffies
+ TOUCH_TIMEOUT
);
1394 ictx
->touch_x
= (buf
[0] << 4) | (buf
[1] >> 4);
1395 ictx
->touch_y
= 0xfff - ((buf
[2] << 4) | (buf
[1] & 0xf));
1396 input_report_abs(ictx
->touch
, ABS_X
, ictx
->touch_x
);
1397 input_report_abs(ictx
->touch
, ABS_Y
, ictx
->touch_y
);
1398 input_report_key(ictx
->touch
, BTN_TOUCH
, 0x01);
1399 input_sync(ictx
->touch
);
1402 static void imon_pad_to_keys(struct imon_context
*ictx
, unsigned char *buf
)
1405 signed char rel_x
= 0x00, rel_y
= 0x00;
1406 u16 timeout
, threshold
;
1407 u32 scancode
= KEY_RESERVED
;
1408 unsigned long flags
;
1411 * The imon directional pad functions more like a touchpad. Bytes 3 & 4
1412 * contain a position coordinate (x,y), with each component ranging
1413 * from -14 to 14. We want to down-sample this to only 4 discrete values
1414 * for up/down/left/right arrow keys. Also, when you get too close to
1415 * diagonals, it has a tendency to jump back and forth, so lets try to
1416 * ignore when they get too close.
1418 if (ictx
->product
!= 0xffdc) {
1419 /* first, pad to 8 bytes so it conforms with everything else */
1420 buf
[5] = buf
[6] = buf
[7] = 0;
1421 timeout
= 500; /* in msecs */
1422 /* (2*threshold) x (2*threshold) square */
1423 threshold
= pad_thresh
? pad_thresh
: 28;
1427 if (ictx
->rc_type
== RC_BIT_OTHER
&& pad_stabilize
) {
1428 if ((buf
[1] == 0) && ((rel_x
!= 0) || (rel_y
!= 0))) {
1429 dir
= stabilize((int)rel_x
, (int)rel_y
,
1430 timeout
, threshold
);
1432 spin_lock_irqsave(&ictx
->kc_lock
,
1434 ictx
->kc
= KEY_UNKNOWN
;
1435 spin_unlock_irqrestore(&ictx
->kc_lock
,
1439 buf
[2] = dir
& 0xFF;
1440 buf
[3] = (dir
>> 8) & 0xFF;
1441 scancode
= be32_to_cpu(*((__be32
*)buf
));
1445 * Hack alert: instead of using keycodes, we have
1446 * to use hard-coded scancodes here...
1448 if (abs(rel_y
) > abs(rel_x
)) {
1449 buf
[2] = (rel_y
> 0) ? 0x7F : 0x80;
1452 scancode
= 0x01007f00; /* KEY_DOWN */
1454 scancode
= 0x01008000; /* KEY_UP */
1457 buf
[3] = (rel_x
> 0) ? 0x7F : 0x80;
1459 scancode
= 0x0100007f; /* KEY_RIGHT */
1461 scancode
= 0x01000080; /* KEY_LEFT */
1466 * Handle on-board decoded pad events for e.g. older VFD/iMON-Pad
1467 * device (15c2:ffdc). The remote generates various codes from
1468 * 0x68nnnnB7 to 0x6AnnnnB7, the left mouse button generates
1469 * 0x688301b7 and the right one 0x688481b7. All other keys generate
1470 * 0x2nnnnnnn. Position coordinate is encoded in buf[1] and buf[2] with
1471 * reversed endianness. Extract direction from buffer, rotate endianness,
1472 * adjust sign and feed the values into stabilize(). The resulting codes
1473 * will be 0x01008000, 0x01007F00, which match the newer devices.
1476 timeout
= 10; /* in msecs */
1477 /* (2*threshold) x (2*threshold) square */
1478 threshold
= pad_thresh
? pad_thresh
: 15;
1481 rel_x
= (buf
[1] & 0x08) | (buf
[1] & 0x10) >> 2 |
1482 (buf
[1] & 0x20) >> 4 | (buf
[1] & 0x40) >> 6;
1486 rel_y
= (buf
[2] & 0x08) | (buf
[2] & 0x10) >> 2 |
1487 (buf
[2] & 0x20) >> 4 | (buf
[2] & 0x40) >> 6;
1492 buf
[1] = buf
[4] = buf
[5] = buf
[6] = buf
[7] = 0;
1494 if (ictx
->rc_type
== RC_BIT_OTHER
&& pad_stabilize
) {
1495 dir
= stabilize((int)rel_x
, (int)rel_y
,
1496 timeout
, threshold
);
1498 spin_lock_irqsave(&ictx
->kc_lock
, flags
);
1499 ictx
->kc
= KEY_UNKNOWN
;
1500 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1503 buf
[2] = dir
& 0xFF;
1504 buf
[3] = (dir
>> 8) & 0xFF;
1505 scancode
= be32_to_cpu(*((__be32
*)buf
));
1508 * Hack alert: instead of using keycodes, we have
1509 * to use hard-coded scancodes here...
1511 if (abs(rel_y
) > abs(rel_x
)) {
1512 buf
[2] = (rel_y
> 0) ? 0x7F : 0x80;
1515 scancode
= 0x01007f00; /* KEY_DOWN */
1517 scancode
= 0x01008000; /* KEY_UP */
1520 buf
[3] = (rel_x
> 0) ? 0x7F : 0x80;
1522 scancode
= 0x0100007f; /* KEY_RIGHT */
1524 scancode
= 0x01000080; /* KEY_LEFT */
1530 spin_lock_irqsave(&ictx
->kc_lock
, flags
);
1531 ictx
->kc
= imon_remote_key_lookup(ictx
, scancode
);
1532 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1537 * figure out if these is a press or a release. We don't actually
1538 * care about repeats, as those will be auto-generated within the IR
1539 * subsystem for repeating scancodes.
1541 static int imon_parse_press_type(struct imon_context
*ictx
,
1542 unsigned char *buf
, u8 ktype
)
1545 unsigned long flags
;
1547 spin_lock_irqsave(&ictx
->kc_lock
, flags
);
1549 /* key release of 0x02XXXXXX key */
1550 if (ictx
->kc
== KEY_RESERVED
&& buf
[0] == 0x02 && buf
[3] == 0x00)
1551 ictx
->kc
= ictx
->last_keycode
;
1553 /* mouse button release on (some) 0xffdc devices */
1554 else if (ictx
->kc
== KEY_RESERVED
&& buf
[0] == 0x68 && buf
[1] == 0x82 &&
1555 buf
[2] == 0x81 && buf
[3] == 0xb7)
1556 ictx
->kc
= ictx
->last_keycode
;
1558 /* mouse button release on (some other) 0xffdc devices */
1559 else if (ictx
->kc
== KEY_RESERVED
&& buf
[0] == 0x01 && buf
[1] == 0x00 &&
1560 buf
[2] == 0x81 && buf
[3] == 0xb7)
1561 ictx
->kc
= ictx
->last_keycode
;
1563 /* mce-specific button handling, no keyup events */
1564 else if (ktype
== IMON_KEY_MCE
) {
1565 ictx
->rc_toggle
= buf
[2];
1568 /* incoherent or irrelevant data */
1569 } else if (ictx
->kc
== KEY_RESERVED
)
1570 press_type
= -EINVAL
;
1572 /* key release of 0xXXXXXXb7 key */
1573 else if (ictx
->release_code
)
1576 /* this is a button press */
1580 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1586 * Process the incoming packet
1588 static void imon_incoming_packet(struct imon_context
*ictx
,
1589 struct urb
*urb
, int intf
)
1591 int len
= urb
->actual_length
;
1592 unsigned char *buf
= urb
->transfer_buffer
;
1593 struct device
*dev
= ictx
->dev
;
1594 unsigned long flags
;
1601 static struct timeval prev_time
= { 0, 0 };
1604 /* filter out junk data on the older 0xffdc imon devices */
1605 if ((buf
[0] == 0xff) && (buf
[1] == 0xff) && (buf
[2] == 0xff))
1608 /* Figure out what key was pressed */
1609 if (len
== 8 && buf
[7] == 0xee) {
1610 scancode
= be64_to_cpu(*((__be64
*)buf
));
1611 ktype
= IMON_KEY_PANEL
;
1612 kc
= imon_panel_key_lookup(ictx
, scancode
);
1613 ictx
->release_code
= false;
1615 scancode
= be32_to_cpu(*((__be32
*)buf
));
1616 if (ictx
->rc_type
== RC_BIT_RC6_MCE
) {
1617 ktype
= IMON_KEY_IMON
;
1619 ktype
= IMON_KEY_MCE
;
1620 kc
= imon_mce_key_lookup(ictx
, scancode
);
1622 ktype
= IMON_KEY_IMON
;
1623 kc
= imon_remote_key_lookup(ictx
, scancode
);
1627 spin_lock_irqsave(&ictx
->kc_lock
, flags
);
1628 /* keyboard/mouse mode toggle button */
1629 if (kc
== KEY_KEYBOARD
&& !ictx
->release_code
) {
1630 ictx
->last_keycode
= kc
;
1632 ictx
->pad_mouse
= ~(ictx
->pad_mouse
) & 0x1;
1633 dev_dbg(dev
, "toggling to %s mode\n",
1634 ictx
->pad_mouse
? "mouse" : "keyboard");
1635 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1638 ictx
->pad_mouse
= false;
1639 dev_dbg(dev
, "mouse mode disabled, passing key value\n");
1644 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1646 /* send touchscreen events through input subsystem if touchpad data */
1647 if (ictx
->display_type
== IMON_DISPLAY_TYPE_VGA
&& len
== 8 &&
1649 imon_touch_event(ictx
, buf
);
1652 /* look for mouse events with pad in mouse mode */
1653 } else if (ictx
->pad_mouse
) {
1654 if (imon_mouse_event(ictx
, buf
, len
))
1658 /* Now for some special handling to convert pad input to arrow keys */
1659 if (((len
== 5) && (buf
[0] == 0x01) && (buf
[4] == 0x00)) ||
1660 ((len
== 8) && (buf
[0] & 0x40) &&
1661 !(buf
[1] & 0x1 || buf
[1] >> 2 & 0x1))) {
1663 imon_pad_to_keys(ictx
, buf
);
1667 printk(KERN_INFO
"intf%d decoded packet: ", intf
);
1668 for (i
= 0; i
< len
; ++i
)
1669 printk("%02x ", buf
[i
]);
1673 press_type
= imon_parse_press_type(ictx
, buf
, ktype
);
1675 goto not_input_data
;
1677 if (ktype
!= IMON_KEY_PANEL
) {
1678 if (press_type
== 0)
1679 rc_keyup(ictx
->rdev
);
1681 if (ictx
->rc_type
== RC_BIT_RC6_MCE
||
1682 ictx
->rc_type
== RC_BIT_OTHER
)
1683 rc_keydown(ictx
->rdev
,
1684 ictx
->rc_type
== RC_BIT_RC6_MCE
? RC_TYPE_RC6_MCE
: RC_TYPE_OTHER
,
1685 ictx
->rc_scancode
, ictx
->rc_toggle
);
1686 spin_lock_irqsave(&ictx
->kc_lock
, flags
);
1687 ictx
->last_keycode
= ictx
->kc
;
1688 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1693 /* Only panel type events left to process now */
1694 spin_lock_irqsave(&ictx
->kc_lock
, flags
);
1696 do_gettimeofday(&t
);
1697 /* KEY_MUTE repeats from knob need to be suppressed */
1698 if (ictx
->kc
== KEY_MUTE
&& ictx
->kc
== ictx
->last_keycode
) {
1699 msec
= tv2int(&t
, &prev_time
);
1700 if (msec
< ictx
->idev
->rep
[REP_DELAY
]) {
1701 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1708 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1710 input_report_key(ictx
->idev
, kc
, press_type
);
1711 input_sync(ictx
->idev
);
1713 /* panel keys don't generate a release */
1714 input_report_key(ictx
->idev
, kc
, 0);
1715 input_sync(ictx
->idev
);
1717 spin_lock_irqsave(&ictx
->kc_lock
, flags
);
1718 ictx
->last_keycode
= kc
;
1719 spin_unlock_irqrestore(&ictx
->kc_lock
, flags
);
1725 dev_warn(dev
, "imon %s: invalid incoming packet "
1726 "size (len = %d, intf%d)\n", __func__
, len
, intf
);
1730 /* iMON 2.4G associate frame */
1731 if (buf
[0] == 0x00 &&
1732 buf
[2] == 0xFF && /* REFID */
1735 buf
[5] == 0xFF && /* iMON 2.4G */
1736 ((buf
[6] == 0x4E && buf
[7] == 0xDF) || /* LT */
1737 (buf
[6] == 0x5E && buf
[7] == 0xDF))) { /* DT */
1738 dev_warn(dev
, "%s: remote associated refid=%02X\n",
1740 ictx
->rf_isassociating
= false;
1745 * Callback function for USB core API: receive data
1747 static void usb_rx_callback_intf0(struct urb
*urb
)
1749 struct imon_context
*ictx
;
1755 ictx
= (struct imon_context
*)urb
->context
;
1760 * if we get a callback before we're done configuring the hardware, we
1761 * can't yet process the data, as there's nowhere to send it, but we
1762 * still need to submit a new rx URB to avoid wedging the hardware
1764 if (!ictx
->dev_present_intf0
)
1767 switch (urb
->status
) {
1768 case -ENOENT
: /* usbcore unlink successful! */
1771 case -ESHUTDOWN
: /* transport endpoint was shut down */
1775 imon_incoming_packet(ictx
, urb
, intfnum
);
1779 dev_warn(ictx
->dev
, "imon %s: status(%d): ignored\n",
1780 __func__
, urb
->status
);
1785 usb_submit_urb(ictx
->rx_urb_intf0
, GFP_ATOMIC
);
1788 static void usb_rx_callback_intf1(struct urb
*urb
)
1790 struct imon_context
*ictx
;
1796 ictx
= (struct imon_context
*)urb
->context
;
1801 * if we get a callback before we're done configuring the hardware, we
1802 * can't yet process the data, as there's nowhere to send it, but we
1803 * still need to submit a new rx URB to avoid wedging the hardware
1805 if (!ictx
->dev_present_intf1
)
1808 switch (urb
->status
) {
1809 case -ENOENT
: /* usbcore unlink successful! */
1812 case -ESHUTDOWN
: /* transport endpoint was shut down */
1816 imon_incoming_packet(ictx
, urb
, intfnum
);
1820 dev_warn(ictx
->dev
, "imon %s: status(%d): ignored\n",
1821 __func__
, urb
->status
);
1826 usb_submit_urb(ictx
->rx_urb_intf1
, GFP_ATOMIC
);
1830 * The 0x15c2:0xffdc device ID was used for umpteen different imon
1831 * devices, and all of them constantly spew interrupts, even when there
1832 * is no actual data to report. However, byte 6 of this buffer looks like
1833 * its unique across device variants, so we're trying to key off that to
1834 * figure out which display type (if any) and what IR protocol the device
1835 * actually supports. These devices have their IR protocol hard-coded into
1836 * their firmware, they can't be changed on the fly like the newer hardware.
1838 static void imon_get_ffdc_type(struct imon_context
*ictx
)
1840 u8 ffdc_cfg_byte
= ictx
->usb_rx_buf
[6];
1841 u8 detected_display_type
= IMON_DISPLAY_TYPE_NONE
;
1842 u64 allowed_protos
= RC_BIT_OTHER
;
1844 switch (ffdc_cfg_byte
) {
1845 /* iMON Knob, no display, iMON IR + vol knob */
1847 dev_info(ictx
->dev
, "0xffdc iMON Knob, iMON IR");
1848 ictx
->display_supported
= false;
1850 /* iMON 2.4G LT (usb stick), no display, iMON RF */
1852 dev_info(ictx
->dev
, "0xffdc iMON 2.4G LT, iMON RF");
1853 ictx
->display_supported
= false;
1854 ictx
->rf_device
= true;
1856 /* iMON VFD, no IR (does have vol knob tho) */
1858 dev_info(ictx
->dev
, "0xffdc iMON VFD + knob, no IR");
1859 detected_display_type
= IMON_DISPLAY_TYPE_VFD
;
1861 /* iMON VFD, iMON IR */
1864 dev_info(ictx
->dev
, "0xffdc iMON VFD, iMON IR");
1865 detected_display_type
= IMON_DISPLAY_TYPE_VFD
;
1867 /* iMON VFD, MCE IR */
1871 dev_info(ictx
->dev
, "0xffdc iMON VFD, MCE IR");
1872 detected_display_type
= IMON_DISPLAY_TYPE_VFD
;
1873 allowed_protos
= RC_BIT_RC6_MCE
;
1875 /* iMON LCD, MCE IR */
1877 dev_info(ictx
->dev
, "0xffdc iMON LCD, MCE IR");
1878 detected_display_type
= IMON_DISPLAY_TYPE_LCD
;
1879 allowed_protos
= RC_BIT_RC6_MCE
;
1882 dev_info(ictx
->dev
, "Unknown 0xffdc device, "
1883 "defaulting to VFD and iMON IR");
1884 detected_display_type
= IMON_DISPLAY_TYPE_VFD
;
1885 /* We don't know which one it is, allow user to set the
1886 * RC6 one from userspace if OTHER wasn't correct. */
1887 allowed_protos
|= RC_BIT_RC6_MCE
;
1891 printk(KERN_CONT
" (id 0x%02x)\n", ffdc_cfg_byte
);
1893 ictx
->display_type
= detected_display_type
;
1894 ictx
->rc_type
= allowed_protos
;
1897 static void imon_set_display_type(struct imon_context
*ictx
)
1899 u8 configured_display_type
= IMON_DISPLAY_TYPE_VFD
;
1902 * Try to auto-detect the type of display if the user hasn't set
1903 * it by hand via the display_type modparam. Default is VFD.
1906 if (display_type
== IMON_DISPLAY_TYPE_AUTO
) {
1907 switch (ictx
->product
) {
1909 /* set in imon_get_ffdc_type() */
1910 configured_display_type
= ictx
->display_type
;
1914 configured_display_type
= IMON_DISPLAY_TYPE_VGA
;
1919 configured_display_type
= IMON_DISPLAY_TYPE_LCD
;
1925 configured_display_type
= IMON_DISPLAY_TYPE_NONE
;
1926 ictx
->display_supported
= false;
1931 configured_display_type
= IMON_DISPLAY_TYPE_VFD
;
1935 configured_display_type
= display_type
;
1936 if (display_type
== IMON_DISPLAY_TYPE_NONE
)
1937 ictx
->display_supported
= false;
1939 ictx
->display_supported
= true;
1940 dev_info(ictx
->dev
, "%s: overriding display type to %d via "
1941 "modparam\n", __func__
, display_type
);
1944 ictx
->display_type
= configured_display_type
;
1947 static struct rc_dev
*imon_init_rdev(struct imon_context
*ictx
)
1949 struct rc_dev
*rdev
;
1951 const unsigned char fp_packet
[] = { 0x40, 0x00, 0x00, 0x00,
1952 0x00, 0x00, 0x00, 0x88 };
1954 rdev
= rc_allocate_device();
1956 dev_err(ictx
->dev
, "remote control dev allocation failed\n");
1960 snprintf(ictx
->name_rdev
, sizeof(ictx
->name_rdev
),
1961 "iMON Remote (%04x:%04x)", ictx
->vendor
, ictx
->product
);
1962 usb_make_path(ictx
->usbdev_intf0
, ictx
->phys_rdev
,
1963 sizeof(ictx
->phys_rdev
));
1964 strlcat(ictx
->phys_rdev
, "/input0", sizeof(ictx
->phys_rdev
));
1966 rdev
->input_name
= ictx
->name_rdev
;
1967 rdev
->input_phys
= ictx
->phys_rdev
;
1968 usb_to_input_id(ictx
->usbdev_intf0
, &rdev
->input_id
);
1969 rdev
->dev
.parent
= ictx
->dev
;
1972 rdev
->driver_type
= RC_DRIVER_SCANCODE
;
1973 rdev
->allowed_protocols
= RC_BIT_OTHER
| RC_BIT_RC6_MCE
; /* iMON PAD or MCE */
1974 rdev
->change_protocol
= imon_ir_change_protocol
;
1975 rdev
->driver_name
= MOD_NAME
;
1977 /* Enable front-panel buttons and/or knobs */
1978 memcpy(ictx
->usb_tx_buf
, &fp_packet
, sizeof(fp_packet
));
1979 ret
= send_packet(ictx
);
1980 /* Not fatal, but warn about it */
1982 dev_info(ictx
->dev
, "panel buttons/knobs setup failed\n");
1984 if (ictx
->product
== 0xffdc) {
1985 imon_get_ffdc_type(ictx
);
1986 rdev
->allowed_protocols
= ictx
->rc_type
;
1989 imon_set_display_type(ictx
);
1991 if (ictx
->rc_type
== RC_BIT_RC6_MCE
)
1992 rdev
->map_name
= RC_MAP_IMON_MCE
;
1994 rdev
->map_name
= RC_MAP_IMON_PAD
;
1996 ret
= rc_register_device(rdev
);
1998 dev_err(ictx
->dev
, "remote input dev register failed\n");
2005 rc_free_device(rdev
);
2009 static struct input_dev
*imon_init_idev(struct imon_context
*ictx
)
2011 struct imon_panel_key_table
*key_table
= ictx
->dev_descr
->key_table
;
2012 struct input_dev
*idev
;
2015 idev
= input_allocate_device();
2019 snprintf(ictx
->name_idev
, sizeof(ictx
->name_idev
),
2020 "iMON Panel, Knob and Mouse(%04x:%04x)",
2021 ictx
->vendor
, ictx
->product
);
2022 idev
->name
= ictx
->name_idev
;
2024 usb_make_path(ictx
->usbdev_intf0
, ictx
->phys_idev
,
2025 sizeof(ictx
->phys_idev
));
2026 strlcat(ictx
->phys_idev
, "/input1", sizeof(ictx
->phys_idev
));
2027 idev
->phys
= ictx
->phys_idev
;
2029 idev
->evbit
[0] = BIT_MASK(EV_KEY
) | BIT_MASK(EV_REP
) | BIT_MASK(EV_REL
);
2031 idev
->keybit
[BIT_WORD(BTN_MOUSE
)] =
2032 BIT_MASK(BTN_LEFT
) | BIT_MASK(BTN_RIGHT
);
2033 idev
->relbit
[0] = BIT_MASK(REL_X
) | BIT_MASK(REL_Y
) |
2034 BIT_MASK(REL_WHEEL
);
2036 /* panel and/or knob code support */
2037 for (i
= 0; key_table
[i
].hw_code
!= 0; i
++) {
2038 u32 kc
= key_table
[i
].keycode
;
2039 __set_bit(kc
, idev
->keybit
);
2042 usb_to_input_id(ictx
->usbdev_intf0
, &idev
->id
);
2043 idev
->dev
.parent
= ictx
->dev
;
2044 input_set_drvdata(idev
, ictx
);
2046 ret
= input_register_device(idev
);
2048 dev_err(ictx
->dev
, "input dev register failed\n");
2055 input_free_device(idev
);
2059 static struct input_dev
*imon_init_touch(struct imon_context
*ictx
)
2061 struct input_dev
*touch
;
2064 touch
= input_allocate_device();
2066 goto touch_alloc_failed
;
2068 snprintf(ictx
->name_touch
, sizeof(ictx
->name_touch
),
2069 "iMON USB Touchscreen (%04x:%04x)",
2070 ictx
->vendor
, ictx
->product
);
2071 touch
->name
= ictx
->name_touch
;
2073 usb_make_path(ictx
->usbdev_intf1
, ictx
->phys_touch
,
2074 sizeof(ictx
->phys_touch
));
2075 strlcat(ictx
->phys_touch
, "/input2", sizeof(ictx
->phys_touch
));
2076 touch
->phys
= ictx
->phys_touch
;
2079 BIT_MASK(EV_KEY
) | BIT_MASK(EV_ABS
);
2080 touch
->keybit
[BIT_WORD(BTN_TOUCH
)] =
2081 BIT_MASK(BTN_TOUCH
);
2082 input_set_abs_params(touch
, ABS_X
,
2084 input_set_abs_params(touch
, ABS_Y
,
2087 input_set_drvdata(touch
, ictx
);
2089 usb_to_input_id(ictx
->usbdev_intf1
, &touch
->id
);
2090 touch
->dev
.parent
= ictx
->dev
;
2091 ret
= input_register_device(touch
);
2093 dev_info(ictx
->dev
, "touchscreen input dev register failed\n");
2094 goto touch_register_failed
;
2099 touch_register_failed
:
2100 input_free_device(touch
);
2106 static bool imon_find_endpoints(struct imon_context
*ictx
,
2107 struct usb_host_interface
*iface_desc
)
2109 struct usb_endpoint_descriptor
*ep
;
2110 struct usb_endpoint_descriptor
*rx_endpoint
= NULL
;
2111 struct usb_endpoint_descriptor
*tx_endpoint
= NULL
;
2112 int ifnum
= iface_desc
->desc
.bInterfaceNumber
;
2113 int num_endpts
= iface_desc
->desc
.bNumEndpoints
;
2114 int i
, ep_dir
, ep_type
;
2115 bool ir_ep_found
= false;
2116 bool display_ep_found
= false;
2117 bool tx_control
= false;
2120 * Scan the endpoint list and set:
2121 * first input endpoint = IR endpoint
2122 * first output endpoint = display endpoint
2124 for (i
= 0; i
< num_endpts
&& !(ir_ep_found
&& display_ep_found
); ++i
) {
2125 ep
= &iface_desc
->endpoint
[i
].desc
;
2126 ep_dir
= ep
->bEndpointAddress
& USB_ENDPOINT_DIR_MASK
;
2127 ep_type
= usb_endpoint_type(ep
);
2129 if (!ir_ep_found
&& ep_dir
== USB_DIR_IN
&&
2130 ep_type
== USB_ENDPOINT_XFER_INT
) {
2134 dev_dbg(ictx
->dev
, "%s: found IR endpoint\n", __func__
);
2136 } else if (!display_ep_found
&& ep_dir
== USB_DIR_OUT
&&
2137 ep_type
== USB_ENDPOINT_XFER_INT
) {
2139 display_ep_found
= true;
2140 dev_dbg(ictx
->dev
, "%s: found display endpoint\n", __func__
);
2145 ictx
->rx_endpoint_intf0
= rx_endpoint
;
2147 * tx is used to send characters to lcd/vfd, associate RF
2148 * remotes, set IR protocol, and maybe more...
2150 ictx
->tx_endpoint
= tx_endpoint
;
2152 ictx
->rx_endpoint_intf1
= rx_endpoint
;
2156 * If we didn't find a display endpoint, this is probably one of the
2157 * newer iMON devices that use control urb instead of interrupt
2159 if (!display_ep_found
) {
2161 display_ep_found
= true;
2162 dev_dbg(ictx
->dev
, "%s: device uses control endpoint, not "
2163 "interface OUT endpoint\n", __func__
);
2167 * Some iMON receivers have no display. Unfortunately, it seems
2168 * that SoundGraph recycles device IDs between devices both with
2171 if (ictx
->display_type
== IMON_DISPLAY_TYPE_NONE
) {
2172 display_ep_found
= false;
2173 dev_dbg(ictx
->dev
, "%s: device has no display\n", __func__
);
2177 * iMON Touch devices have a VGA touchscreen, but no "display", as
2178 * that refers to e.g. /dev/lcd0 (a character device LCD or VFD).
2180 if (ictx
->display_type
== IMON_DISPLAY_TYPE_VGA
) {
2181 display_ep_found
= false;
2182 dev_dbg(ictx
->dev
, "%s: iMON Touch device found\n", __func__
);
2185 /* Input endpoint is mandatory */
2187 pr_err("no valid input (IR) endpoint found\n");
2189 ictx
->tx_control
= tx_control
;
2191 if (display_ep_found
)
2192 ictx
->display_supported
= true;
2198 static struct imon_context
*imon_init_intf0(struct usb_interface
*intf
,
2199 const struct usb_device_id
*id
)
2201 struct imon_context
*ictx
;
2204 struct device
*dev
= &intf
->dev
;
2205 struct usb_host_interface
*iface_desc
;
2208 ictx
= kzalloc(sizeof(struct imon_context
), GFP_KERNEL
);
2210 dev_err(dev
, "%s: kzalloc failed for context", __func__
);
2213 rx_urb
= usb_alloc_urb(0, GFP_KERNEL
);
2215 dev_err(dev
, "%s: usb_alloc_urb failed for IR urb", __func__
);
2216 goto rx_urb_alloc_failed
;
2218 tx_urb
= usb_alloc_urb(0, GFP_KERNEL
);
2220 dev_err(dev
, "%s: usb_alloc_urb failed for display urb",
2222 goto tx_urb_alloc_failed
;
2225 mutex_init(&ictx
->lock
);
2226 spin_lock_init(&ictx
->kc_lock
);
2228 mutex_lock(&ictx
->lock
);
2231 ictx
->usbdev_intf0
= usb_get_dev(interface_to_usbdev(intf
));
2232 ictx
->rx_urb_intf0
= rx_urb
;
2233 ictx
->tx_urb
= tx_urb
;
2234 ictx
->rf_device
= false;
2236 ictx
->vendor
= le16_to_cpu(ictx
->usbdev_intf0
->descriptor
.idVendor
);
2237 ictx
->product
= le16_to_cpu(ictx
->usbdev_intf0
->descriptor
.idProduct
);
2239 /* save drive info for later accessing the panel/knob key table */
2240 ictx
->dev_descr
= (struct imon_usb_dev_descr
*)id
->driver_info
;
2241 /* default send_packet delay is 5ms but some devices need more */
2242 ictx
->send_packet_delay
= ictx
->dev_descr
->flags
&
2243 IMON_NEED_20MS_PKT_DELAY
? 20 : 5;
2246 iface_desc
= intf
->cur_altsetting
;
2247 if (!imon_find_endpoints(ictx
, iface_desc
)) {
2248 goto find_endpoint_failed
;
2251 usb_fill_int_urb(ictx
->rx_urb_intf0
, ictx
->usbdev_intf0
,
2252 usb_rcvintpipe(ictx
->usbdev_intf0
,
2253 ictx
->rx_endpoint_intf0
->bEndpointAddress
),
2254 ictx
->usb_rx_buf
, sizeof(ictx
->usb_rx_buf
),
2255 usb_rx_callback_intf0
, ictx
,
2256 ictx
->rx_endpoint_intf0
->bInterval
);
2258 ret
= usb_submit_urb(ictx
->rx_urb_intf0
, GFP_KERNEL
);
2260 pr_err("usb_submit_urb failed for intf0 (%d)\n", ret
);
2261 goto urb_submit_failed
;
2264 ictx
->idev
= imon_init_idev(ictx
);
2266 dev_err(dev
, "%s: input device setup failed\n", __func__
);
2267 goto idev_setup_failed
;
2270 ictx
->rdev
= imon_init_rdev(ictx
);
2272 dev_err(dev
, "%s: rc device setup failed\n", __func__
);
2273 goto rdev_setup_failed
;
2276 ictx
->dev_present_intf0
= true;
2278 mutex_unlock(&ictx
->lock
);
2282 input_unregister_device(ictx
->idev
);
2284 usb_kill_urb(ictx
->rx_urb_intf0
);
2286 find_endpoint_failed
:
2287 usb_put_dev(ictx
->usbdev_intf0
);
2288 mutex_unlock(&ictx
->lock
);
2289 usb_free_urb(tx_urb
);
2290 tx_urb_alloc_failed
:
2291 usb_free_urb(rx_urb
);
2292 rx_urb_alloc_failed
:
2295 dev_err(dev
, "unable to initialize intf0, err %d\n", ret
);
2300 static struct imon_context
*imon_init_intf1(struct usb_interface
*intf
,
2301 struct imon_context
*ictx
)
2304 struct usb_host_interface
*iface_desc
;
2307 rx_urb
= usb_alloc_urb(0, GFP_KERNEL
);
2309 pr_err("usb_alloc_urb failed for IR urb\n");
2310 goto rx_urb_alloc_failed
;
2313 mutex_lock(&ictx
->lock
);
2315 if (ictx
->display_type
== IMON_DISPLAY_TYPE_VGA
) {
2316 init_timer(&ictx
->ttimer
);
2317 ictx
->ttimer
.data
= (unsigned long)ictx
;
2318 ictx
->ttimer
.function
= imon_touch_display_timeout
;
2321 ictx
->usbdev_intf1
= usb_get_dev(interface_to_usbdev(intf
));
2322 ictx
->rx_urb_intf1
= rx_urb
;
2325 iface_desc
= intf
->cur_altsetting
;
2326 if (!imon_find_endpoints(ictx
, iface_desc
))
2327 goto find_endpoint_failed
;
2329 if (ictx
->display_type
== IMON_DISPLAY_TYPE_VGA
) {
2330 ictx
->touch
= imon_init_touch(ictx
);
2332 goto touch_setup_failed
;
2336 usb_fill_int_urb(ictx
->rx_urb_intf1
, ictx
->usbdev_intf1
,
2337 usb_rcvintpipe(ictx
->usbdev_intf1
,
2338 ictx
->rx_endpoint_intf1
->bEndpointAddress
),
2339 ictx
->usb_rx_buf
, sizeof(ictx
->usb_rx_buf
),
2340 usb_rx_callback_intf1
, ictx
,
2341 ictx
->rx_endpoint_intf1
->bInterval
);
2343 ret
= usb_submit_urb(ictx
->rx_urb_intf1
, GFP_KERNEL
);
2346 pr_err("usb_submit_urb failed for intf1 (%d)\n", ret
);
2347 goto urb_submit_failed
;
2350 ictx
->dev_present_intf1
= true;
2352 mutex_unlock(&ictx
->lock
);
2357 input_unregister_device(ictx
->touch
);
2359 find_endpoint_failed
:
2360 usb_put_dev(ictx
->usbdev_intf1
);
2361 mutex_unlock(&ictx
->lock
);
2362 usb_free_urb(rx_urb
);
2363 rx_urb_alloc_failed
:
2364 dev_err(ictx
->dev
, "unable to initialize intf1, err %d\n", ret
);
2369 static void imon_init_display(struct imon_context
*ictx
,
2370 struct usb_interface
*intf
)
2374 dev_dbg(ictx
->dev
, "Registering iMON display with sysfs\n");
2376 /* set up sysfs entry for built-in clock */
2377 ret
= sysfs_create_group(&intf
->dev
.kobj
, &imon_display_attr_group
);
2379 dev_err(ictx
->dev
, "Could not create display sysfs "
2380 "entries(%d)", ret
);
2382 if (ictx
->display_type
== IMON_DISPLAY_TYPE_LCD
)
2383 ret
= usb_register_dev(intf
, &imon_lcd_class
);
2385 ret
= usb_register_dev(intf
, &imon_vfd_class
);
2387 /* Not a fatal error, so ignore */
2388 dev_info(ictx
->dev
, "could not get a minor number for "
2394 * Callback function for USB core API: Probe
2396 static int imon_probe(struct usb_interface
*interface
,
2397 const struct usb_device_id
*id
)
2399 struct usb_device
*usbdev
= NULL
;
2400 struct usb_host_interface
*iface_desc
= NULL
;
2401 struct usb_interface
*first_if
;
2402 struct device
*dev
= &interface
->dev
;
2403 int ifnum
, sysfs_err
;
2405 struct imon_context
*ictx
= NULL
;
2406 struct imon_context
*first_if_ctx
= NULL
;
2407 u16 vendor
, product
;
2409 usbdev
= usb_get_dev(interface_to_usbdev(interface
));
2410 iface_desc
= interface
->cur_altsetting
;
2411 ifnum
= iface_desc
->desc
.bInterfaceNumber
;
2412 vendor
= le16_to_cpu(usbdev
->descriptor
.idVendor
);
2413 product
= le16_to_cpu(usbdev
->descriptor
.idProduct
);
2415 dev_dbg(dev
, "%s: found iMON device (%04x:%04x, intf%d)\n",
2416 __func__
, vendor
, product
, ifnum
);
2418 /* prevent races probing devices w/multiple interfaces */
2419 mutex_lock(&driver_lock
);
2421 first_if
= usb_ifnum_to_if(usbdev
, 0);
2422 first_if_ctx
= usb_get_intfdata(first_if
);
2425 ictx
= imon_init_intf0(interface
, id
);
2427 pr_err("failed to initialize context!\n");
2433 /* this is the secondary interface on the device */
2435 /* fail early if first intf failed to register */
2436 if (!first_if_ctx
) {
2441 ictx
= imon_init_intf1(interface
, first_if_ctx
);
2443 pr_err("failed to attach to context!\n");
2450 usb_set_intfdata(interface
, ictx
);
2453 mutex_lock(&ictx
->lock
);
2455 if (product
== 0xffdc && ictx
->rf_device
) {
2456 sysfs_err
= sysfs_create_group(&interface
->dev
.kobj
,
2457 &imon_rf_attr_group
);
2459 pr_err("Could not create RF sysfs entries(%d)\n",
2463 if (ictx
->display_supported
)
2464 imon_init_display(ictx
, interface
);
2466 mutex_unlock(&ictx
->lock
);
2469 dev_info(dev
, "iMON device (%04x:%04x, intf%d) on "
2470 "usb<%d:%d> initialized\n", vendor
, product
, ifnum
,
2471 usbdev
->bus
->busnum
, usbdev
->devnum
);
2473 mutex_unlock(&driver_lock
);
2474 usb_put_dev(usbdev
);
2479 mutex_unlock(&driver_lock
);
2480 usb_put_dev(usbdev
);
2481 dev_err(dev
, "unable to register, err %d\n", ret
);
2487 * Callback function for USB core API: disconnect
2489 static void imon_disconnect(struct usb_interface
*interface
)
2491 struct imon_context
*ictx
;
2495 /* prevent races with multi-interface device probing and display_open */
2496 mutex_lock(&driver_lock
);
2498 ictx
= usb_get_intfdata(interface
);
2500 ifnum
= interface
->cur_altsetting
->desc
.bInterfaceNumber
;
2503 * sysfs_remove_group is safe to call even if sysfs_create_group
2504 * hasn't been called
2506 sysfs_remove_group(&interface
->dev
.kobj
, &imon_display_attr_group
);
2507 sysfs_remove_group(&interface
->dev
.kobj
, &imon_rf_attr_group
);
2509 usb_set_intfdata(interface
, NULL
);
2511 /* Abort ongoing write */
2512 if (ictx
->tx
.busy
) {
2513 usb_kill_urb(ictx
->tx_urb
);
2514 complete_all(&ictx
->tx
.finished
);
2518 ictx
->dev_present_intf0
= false;
2519 usb_kill_urb(ictx
->rx_urb_intf0
);
2520 usb_put_dev(ictx
->usbdev_intf0
);
2521 input_unregister_device(ictx
->idev
);
2522 rc_unregister_device(ictx
->rdev
);
2523 if (ictx
->display_supported
) {
2524 if (ictx
->display_type
== IMON_DISPLAY_TYPE_LCD
)
2525 usb_deregister_dev(interface
, &imon_lcd_class
);
2526 else if (ictx
->display_type
== IMON_DISPLAY_TYPE_VFD
)
2527 usb_deregister_dev(interface
, &imon_vfd_class
);
2530 ictx
->dev_present_intf1
= false;
2531 usb_kill_urb(ictx
->rx_urb_intf1
);
2532 usb_put_dev(ictx
->usbdev_intf1
);
2533 if (ictx
->display_type
== IMON_DISPLAY_TYPE_VGA
) {
2534 input_unregister_device(ictx
->touch
);
2535 del_timer_sync(&ictx
->ttimer
);
2539 if (!ictx
->dev_present_intf0
&& !ictx
->dev_present_intf1
)
2540 free_imon_context(ictx
);
2542 mutex_unlock(&driver_lock
);
2544 dev_dbg(dev
, "%s: iMON device (intf%d) disconnected\n",
2548 static int imon_suspend(struct usb_interface
*intf
, pm_message_t message
)
2550 struct imon_context
*ictx
= usb_get_intfdata(intf
);
2551 int ifnum
= intf
->cur_altsetting
->desc
.bInterfaceNumber
;
2554 usb_kill_urb(ictx
->rx_urb_intf0
);
2556 usb_kill_urb(ictx
->rx_urb_intf1
);
2561 static int imon_resume(struct usb_interface
*intf
)
2564 struct imon_context
*ictx
= usb_get_intfdata(intf
);
2565 int ifnum
= intf
->cur_altsetting
->desc
.bInterfaceNumber
;
2568 usb_fill_int_urb(ictx
->rx_urb_intf0
, ictx
->usbdev_intf0
,
2569 usb_rcvintpipe(ictx
->usbdev_intf0
,
2570 ictx
->rx_endpoint_intf0
->bEndpointAddress
),
2571 ictx
->usb_rx_buf
, sizeof(ictx
->usb_rx_buf
),
2572 usb_rx_callback_intf0
, ictx
,
2573 ictx
->rx_endpoint_intf0
->bInterval
);
2575 rc
= usb_submit_urb(ictx
->rx_urb_intf0
, GFP_ATOMIC
);
2578 usb_fill_int_urb(ictx
->rx_urb_intf1
, ictx
->usbdev_intf1
,
2579 usb_rcvintpipe(ictx
->usbdev_intf1
,
2580 ictx
->rx_endpoint_intf1
->bEndpointAddress
),
2581 ictx
->usb_rx_buf
, sizeof(ictx
->usb_rx_buf
),
2582 usb_rx_callback_intf1
, ictx
,
2583 ictx
->rx_endpoint_intf1
->bInterval
);
2585 rc
= usb_submit_urb(ictx
->rx_urb_intf1
, GFP_ATOMIC
);
2591 module_usb_driver(imon_driver
);