[media] media: info leak in media_device_enum_entities()
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / media / rc / imon.c
... / ...
CommitLineData
1/*
2 * imon.c: input and display driver for SoundGraph iMON IR/VFD/LCD
3 *
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)
7 *
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.
13 *
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.
18 *
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.
23 *
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.
27 */
28
29#define pr_fmt(fmt) KBUILD_MODNAME ":%s: " fmt, __func__
30
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>
38
39#include <linux/input.h>
40#include <linux/usb.h>
41#include <linux/usb/input.h>
42#include <media/rc-core.h>
43
44#include <linux/time.h>
45#include <linux/timer.h>
46
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"
51
52#define DISPLAY_MINOR_BASE 144
53#define DEVICE_NAME "lcd%d"
54
55#define BUF_CHUNK_SIZE 8
56#define BUF_SIZE 128
57
58#define BIT_DURATION 250 /* each bit received is 250us */
59
60#define IMON_CLOCK_ENABLE_PACKETS 2
61
62/*** P R O T O T Y P E S ***/
63
64/* USB Callback prototypes */
65static int imon_probe(struct usb_interface *interface,
66 const struct usb_device_id *id);
67static void imon_disconnect(struct usb_interface *interface);
68static void usb_rx_callback_intf0(struct urb *urb);
69static void usb_rx_callback_intf1(struct urb *urb);
70static void usb_tx_callback(struct urb *urb);
71
72/* suspend/resume support */
73static int imon_resume(struct usb_interface *intf);
74static int imon_suspend(struct usb_interface *intf, pm_message_t message);
75
76/* Display file_operations function prototypes */
77static int display_open(struct inode *inode, struct file *file);
78static int display_close(struct inode *inode, struct file *file);
79
80/* VFD write operation */
81static ssize_t vfd_write(struct file *file, const char *buf,
82 size_t n_bytes, loff_t *pos);
83
84/* LCD file_operations override function prototypes */
85static ssize_t lcd_write(struct file *file, const char *buf,
86 size_t n_bytes, loff_t *pos);
87
88/*** G L O B A L S ***/
89
90struct imon_context {
91 struct device *dev;
92 /* Newer devices have two interfaces */
93 struct usb_device *usbdev_intf0;
94 struct usb_device *usbdev_intf1;
95
96 bool display_supported; /* not all controllers do */
97 bool display_isopen; /* display port has been opened */
98 bool rf_device; /* true if iMON 2.4G LT/DT RF device */
99 bool rf_isassociating; /* RF remote associating */
100 bool dev_present_intf0; /* USB device presence, interface 0 */
101 bool dev_present_intf1; /* USB device presence, interface 1 */
102
103 struct mutex lock; /* to lock this object */
104 wait_queue_head_t remove_ok; /* For unexpected USB disconnects */
105
106 struct usb_endpoint_descriptor *rx_endpoint_intf0;
107 struct usb_endpoint_descriptor *rx_endpoint_intf1;
108 struct usb_endpoint_descriptor *tx_endpoint;
109 struct urb *rx_urb_intf0;
110 struct urb *rx_urb_intf1;
111 struct urb *tx_urb;
112 bool tx_control;
113 unsigned char usb_rx_buf[8];
114 unsigned char usb_tx_buf[8];
115 unsigned int send_packet_delay;
116
117 struct tx_t {
118 unsigned char data_buf[35]; /* user data buffer */
119 struct completion finished; /* wait for write to finish */
120 bool busy; /* write in progress */
121 int status; /* status of tx completion */
122 } tx;
123
124 u16 vendor; /* usb vendor ID */
125 u16 product; /* usb product ID */
126
127 struct rc_dev *rdev; /* rc-core device for remote */
128 struct input_dev *idev; /* input device for panel & IR mouse */
129 struct input_dev *touch; /* input device for touchscreen */
130
131 spinlock_t kc_lock; /* make sure we get keycodes right */
132 u32 kc; /* current input keycode */
133 u32 last_keycode; /* last reported input keycode */
134 u32 rc_scancode; /* the computed remote scancode */
135 u8 rc_toggle; /* the computed remote toggle bit */
136 u64 rc_type; /* iMON or MCE (RC6) IR protocol? */
137 bool release_code; /* some keys send a release code */
138
139 u8 display_type; /* store the display type */
140 bool pad_mouse; /* toggle kbd(0)/mouse(1) mode */
141
142 char name_rdev[128]; /* rc input device name */
143 char phys_rdev[64]; /* rc input device phys path */
144
145 char name_idev[128]; /* input device name */
146 char phys_idev[64]; /* input device phys path */
147
148 char name_touch[128]; /* touch screen name */
149 char phys_touch[64]; /* touch screen phys path */
150 struct timer_list ttimer; /* touch screen timer */
151 int touch_x; /* x coordinate on touchscreen */
152 int touch_y; /* y coordinate on touchscreen */
153};
154
155#define TOUCH_TIMEOUT (HZ/30)
156
157/* vfd character device file operations */
158static const struct file_operations vfd_fops = {
159 .owner = THIS_MODULE,
160 .open = &display_open,
161 .write = &vfd_write,
162 .release = &display_close,
163 .llseek = noop_llseek,
164};
165
166/* lcd character device file operations */
167static const struct file_operations lcd_fops = {
168 .owner = THIS_MODULE,
169 .open = &display_open,
170 .write = &lcd_write,
171 .release = &display_close,
172 .llseek = noop_llseek,
173};
174
175enum {
176 IMON_DISPLAY_TYPE_AUTO = 0,
177 IMON_DISPLAY_TYPE_VFD = 1,
178 IMON_DISPLAY_TYPE_LCD = 2,
179 IMON_DISPLAY_TYPE_VGA = 3,
180 IMON_DISPLAY_TYPE_NONE = 4,
181};
182
183enum {
184 IMON_KEY_IMON = 0,
185 IMON_KEY_MCE = 1,
186 IMON_KEY_PANEL = 2,
187};
188
189enum {
190 IMON_NEED_20MS_PKT_DELAY = 1
191};
192
193/*
194 * USB Device ID for iMON USB Control Boards
195 *
196 * The Windows drivers contain 6 different inf files, more or less one for
197 * each new device until the 0x0034-0x0046 devices, which all use the same
198 * driver. Some of the devices in the 34-46 range haven't been definitively
199 * identified yet. Early devices have either a TriGem Computer, Inc. or a
200 * Samsung vendor ID (0x0aa8 and 0x04e8 respectively), while all later
201 * devices use the SoundGraph vendor ID (0x15c2). This driver only supports
202 * the ffdc and later devices, which do onboard decoding.
203 */
204static struct usb_device_id imon_usb_id_table[] = {
205 /*
206 * Several devices with this same device ID, all use iMON_PAD.inf
207 * SoundGraph iMON PAD (IR & VFD)
208 * SoundGraph iMON PAD (IR & LCD)
209 * SoundGraph iMON Knob (IR only)
210 */
211 { USB_DEVICE(0x15c2, 0xffdc) },
212
213 /*
214 * Newer devices, all driven by the latest iMON Windows driver, full
215 * list of device IDs extracted via 'strings Setup/data1.hdr |grep 15c2'
216 * Need user input to fill in details on unknown devices.
217 */
218 /* SoundGraph iMON OEM Touch LCD (IR & 7" VGA LCD) */
219 { USB_DEVICE(0x15c2, 0x0034) },
220 /* SoundGraph iMON OEM Touch LCD (IR & 4.3" VGA LCD) */
221 { USB_DEVICE(0x15c2, 0x0035) },
222 /* SoundGraph iMON OEM VFD (IR & VFD) */
223 { USB_DEVICE(0x15c2, 0x0036), .driver_info = IMON_NEED_20MS_PKT_DELAY },
224 /* device specifics unknown */
225 { USB_DEVICE(0x15c2, 0x0037) },
226 /* SoundGraph iMON OEM LCD (IR & LCD) */
227 { USB_DEVICE(0x15c2, 0x0038) },
228 /* SoundGraph iMON UltraBay (IR & LCD) */
229 { USB_DEVICE(0x15c2, 0x0039) },
230 /* device specifics unknown */
231 { USB_DEVICE(0x15c2, 0x003a) },
232 /* device specifics unknown */
233 { USB_DEVICE(0x15c2, 0x003b) },
234 /* SoundGraph iMON OEM Inside (IR only) */
235 { USB_DEVICE(0x15c2, 0x003c) },
236 /* device specifics unknown */
237 { USB_DEVICE(0x15c2, 0x003d) },
238 /* device specifics unknown */
239 { USB_DEVICE(0x15c2, 0x003e) },
240 /* device specifics unknown */
241 { USB_DEVICE(0x15c2, 0x003f) },
242 /* device specifics unknown */
243 { USB_DEVICE(0x15c2, 0x0040) },
244 /* SoundGraph iMON MINI (IR only) */
245 { USB_DEVICE(0x15c2, 0x0041) },
246 /* Antec Veris Multimedia Station EZ External (IR only) */
247 { USB_DEVICE(0x15c2, 0x0042) },
248 /* Antec Veris Multimedia Station Basic Internal (IR only) */
249 { USB_DEVICE(0x15c2, 0x0043) },
250 /* Antec Veris Multimedia Station Elite (IR & VFD) */
251 { USB_DEVICE(0x15c2, 0x0044) },
252 /* Antec Veris Multimedia Station Premiere (IR & LCD) */
253 { USB_DEVICE(0x15c2, 0x0045) },
254 /* device specifics unknown */
255 { USB_DEVICE(0x15c2, 0x0046) },
256 {}
257};
258
259/* USB Device data */
260static struct usb_driver imon_driver = {
261 .name = MOD_NAME,
262 .probe = imon_probe,
263 .disconnect = imon_disconnect,
264 .suspend = imon_suspend,
265 .resume = imon_resume,
266 .id_table = imon_usb_id_table,
267};
268
269static struct usb_class_driver imon_vfd_class = {
270 .name = DEVICE_NAME,
271 .fops = &vfd_fops,
272 .minor_base = DISPLAY_MINOR_BASE,
273};
274
275static struct usb_class_driver imon_lcd_class = {
276 .name = DEVICE_NAME,
277 .fops = &lcd_fops,
278 .minor_base = DISPLAY_MINOR_BASE,
279};
280
281/* imon receiver front panel/knob key table */
282static const struct {
283 u64 hw_code;
284 u32 keycode;
285} imon_panel_key_table[] = {
286 { 0x000000000f00ffeell, KEY_MEDIA }, /* Go */
287 { 0x000000001200ffeell, KEY_UP },
288 { 0x000000001300ffeell, KEY_DOWN },
289 { 0x000000001400ffeell, KEY_LEFT },
290 { 0x000000001500ffeell, KEY_RIGHT },
291 { 0x000000001600ffeell, KEY_ENTER },
292 { 0x000000001700ffeell, KEY_ESC },
293 { 0x000000001f00ffeell, KEY_AUDIO },
294 { 0x000000002000ffeell, KEY_VIDEO },
295 { 0x000000002100ffeell, KEY_CAMERA },
296 { 0x000000002700ffeell, KEY_DVD },
297 { 0x000000002300ffeell, KEY_TV },
298 { 0x000000002b00ffeell, KEY_EXIT },
299 { 0x000000002c00ffeell, KEY_SELECT },
300 { 0x000000002d00ffeell, KEY_MENU },
301 { 0x000000000500ffeell, KEY_PREVIOUS },
302 { 0x000000000700ffeell, KEY_REWIND },
303 { 0x000000000400ffeell, KEY_STOP },
304 { 0x000000003c00ffeell, KEY_PLAYPAUSE },
305 { 0x000000000800ffeell, KEY_FASTFORWARD },
306 { 0x000000000600ffeell, KEY_NEXT },
307 { 0x000000010000ffeell, KEY_RIGHT },
308 { 0x000001000000ffeell, KEY_LEFT },
309 { 0x000000003d00ffeell, KEY_SELECT },
310 { 0x000100000000ffeell, KEY_VOLUMEUP },
311 { 0x010000000000ffeell, KEY_VOLUMEDOWN },
312 { 0x000000000100ffeell, KEY_MUTE },
313 /* 0xffdc iMON MCE VFD */
314 { 0x00010000ffffffeell, KEY_VOLUMEUP },
315 { 0x01000000ffffffeell, KEY_VOLUMEDOWN },
316 { 0x00000001ffffffeell, KEY_MUTE },
317 { 0x0000000fffffffeell, KEY_MEDIA },
318 { 0x00000012ffffffeell, KEY_UP },
319 { 0x00000013ffffffeell, KEY_DOWN },
320 { 0x00000014ffffffeell, KEY_LEFT },
321 { 0x00000015ffffffeell, KEY_RIGHT },
322 { 0x00000016ffffffeell, KEY_ENTER },
323 { 0x00000017ffffffeell, KEY_ESC },
324 /* iMON Knob values */
325 { 0x000100ffffffffeell, KEY_VOLUMEUP },
326 { 0x010000ffffffffeell, KEY_VOLUMEDOWN },
327 { 0x000008ffffffffeell, KEY_MUTE },
328};
329
330/* to prevent races between open() and disconnect(), probing, etc */
331static DEFINE_MUTEX(driver_lock);
332
333/* Module bookkeeping bits */
334MODULE_AUTHOR(MOD_AUTHOR);
335MODULE_DESCRIPTION(MOD_DESC);
336MODULE_VERSION(MOD_VERSION);
337MODULE_LICENSE("GPL");
338MODULE_DEVICE_TABLE(usb, imon_usb_id_table);
339
340static bool debug;
341module_param(debug, bool, S_IRUGO | S_IWUSR);
342MODULE_PARM_DESC(debug, "Debug messages: 0=no, 1=yes (default: no)");
343
344/* lcd, vfd, vga or none? should be auto-detected, but can be overridden... */
345static int display_type;
346module_param(display_type, int, S_IRUGO);
347MODULE_PARM_DESC(display_type, "Type of attached display. 0=autodetect, "
348 "1=vfd, 2=lcd, 3=vga, 4=none (default: autodetect)");
349
350static int pad_stabilize = 1;
351module_param(pad_stabilize, int, S_IRUGO | S_IWUSR);
352MODULE_PARM_DESC(pad_stabilize, "Apply stabilization algorithm to iMON PAD "
353 "presses in arrow key mode. 0=disable, 1=enable (default).");
354
355/*
356 * In certain use cases, mouse mode isn't really helpful, and could actually
357 * cause confusion, so allow disabling it when the IR device is open.
358 */
359static bool nomouse;
360module_param(nomouse, bool, S_IRUGO | S_IWUSR);
361MODULE_PARM_DESC(nomouse, "Disable mouse input device mode when IR device is "
362 "open. 0=don't disable, 1=disable. (default: don't disable)");
363
364/* threshold at which a pad push registers as an arrow key in kbd mode */
365static int pad_thresh;
366module_param(pad_thresh, int, S_IRUGO | S_IWUSR);
367MODULE_PARM_DESC(pad_thresh, "Threshold at which a pad push registers as an "
368 "arrow key in kbd mode (default: 28)");
369
370
371static void free_imon_context(struct imon_context *ictx)
372{
373 struct device *dev = ictx->dev;
374
375 usb_free_urb(ictx->tx_urb);
376 usb_free_urb(ictx->rx_urb_intf0);
377 usb_free_urb(ictx->rx_urb_intf1);
378 kfree(ictx);
379
380 dev_dbg(dev, "%s: iMON context freed\n", __func__);
381}
382
383/**
384 * Called when the Display device (e.g. /dev/lcd0)
385 * is opened by the application.
386 */
387static int display_open(struct inode *inode, struct file *file)
388{
389 struct usb_interface *interface;
390 struct imon_context *ictx = NULL;
391 int subminor;
392 int retval = 0;
393
394 /* prevent races with disconnect */
395 mutex_lock(&driver_lock);
396
397 subminor = iminor(inode);
398 interface = usb_find_interface(&imon_driver, subminor);
399 if (!interface) {
400 pr_err("could not find interface for minor %d\n", subminor);
401 retval = -ENODEV;
402 goto exit;
403 }
404 ictx = usb_get_intfdata(interface);
405
406 if (!ictx) {
407 pr_err("no context found for minor %d\n", subminor);
408 retval = -ENODEV;
409 goto exit;
410 }
411
412 mutex_lock(&ictx->lock);
413
414 if (!ictx->display_supported) {
415 pr_err("display not supported by device\n");
416 retval = -ENODEV;
417 } else if (ictx->display_isopen) {
418 pr_err("display port is already open\n");
419 retval = -EBUSY;
420 } else {
421 ictx->display_isopen = true;
422 file->private_data = ictx;
423 dev_dbg(ictx->dev, "display port opened\n");
424 }
425
426 mutex_unlock(&ictx->lock);
427
428exit:
429 mutex_unlock(&driver_lock);
430 return retval;
431}
432
433/**
434 * Called when the display device (e.g. /dev/lcd0)
435 * is closed by the application.
436 */
437static int display_close(struct inode *inode, struct file *file)
438{
439 struct imon_context *ictx = NULL;
440 int retval = 0;
441
442 ictx = file->private_data;
443
444 if (!ictx) {
445 pr_err("no context for device\n");
446 return -ENODEV;
447 }
448
449 mutex_lock(&ictx->lock);
450
451 if (!ictx->display_supported) {
452 pr_err("display not supported by device\n");
453 retval = -ENODEV;
454 } else if (!ictx->display_isopen) {
455 pr_err("display is not open\n");
456 retval = -EIO;
457 } else {
458 ictx->display_isopen = false;
459 dev_dbg(ictx->dev, "display port closed\n");
460 }
461
462 mutex_unlock(&ictx->lock);
463 return retval;
464}
465
466/**
467 * Sends a packet to the device -- this function must be called with
468 * ictx->lock held, or its unlock/lock sequence while waiting for tx
469 * to complete can/will lead to a deadlock.
470 */
471static int send_packet(struct imon_context *ictx)
472{
473 unsigned int pipe;
474 unsigned long timeout;
475 int interval = 0;
476 int retval = 0;
477 struct usb_ctrlrequest *control_req = NULL;
478
479 /* Check if we need to use control or interrupt urb */
480 if (!ictx->tx_control) {
481 pipe = usb_sndintpipe(ictx->usbdev_intf0,
482 ictx->tx_endpoint->bEndpointAddress);
483 interval = ictx->tx_endpoint->bInterval;
484
485 usb_fill_int_urb(ictx->tx_urb, ictx->usbdev_intf0, pipe,
486 ictx->usb_tx_buf,
487 sizeof(ictx->usb_tx_buf),
488 usb_tx_callback, ictx, interval);
489
490 ictx->tx_urb->actual_length = 0;
491 } else {
492 /* fill request into kmalloc'ed space: */
493 control_req = kmalloc(sizeof(struct usb_ctrlrequest),
494 GFP_KERNEL);
495 if (control_req == NULL)
496 return -ENOMEM;
497
498 /* setup packet is '21 09 0200 0001 0008' */
499 control_req->bRequestType = 0x21;
500 control_req->bRequest = 0x09;
501 control_req->wValue = cpu_to_le16(0x0200);
502 control_req->wIndex = cpu_to_le16(0x0001);
503 control_req->wLength = cpu_to_le16(0x0008);
504
505 /* control pipe is endpoint 0x00 */
506 pipe = usb_sndctrlpipe(ictx->usbdev_intf0, 0);
507
508 /* build the control urb */
509 usb_fill_control_urb(ictx->tx_urb, ictx->usbdev_intf0,
510 pipe, (unsigned char *)control_req,
511 ictx->usb_tx_buf,
512 sizeof(ictx->usb_tx_buf),
513 usb_tx_callback, ictx);
514 ictx->tx_urb->actual_length = 0;
515 }
516
517 init_completion(&ictx->tx.finished);
518 ictx->tx.busy = true;
519 smp_rmb(); /* ensure later readers know we're busy */
520
521 retval = usb_submit_urb(ictx->tx_urb, GFP_KERNEL);
522 if (retval) {
523 ictx->tx.busy = false;
524 smp_rmb(); /* ensure later readers know we're not busy */
525 pr_err_ratelimited("error submitting urb(%d)\n", retval);
526 } else {
527 /* Wait for transmission to complete (or abort) */
528 mutex_unlock(&ictx->lock);
529 retval = wait_for_completion_interruptible(
530 &ictx->tx.finished);
531 if (retval)
532 pr_err_ratelimited("task interrupted\n");
533 mutex_lock(&ictx->lock);
534
535 retval = ictx->tx.status;
536 if (retval)
537 pr_err_ratelimited("packet tx failed (%d)\n", retval);
538 }
539
540 kfree(control_req);
541
542 /*
543 * Induce a mandatory delay before returning, as otherwise,
544 * send_packet can get called so rapidly as to overwhelm the device,
545 * particularly on faster systems and/or those with quirky usb.
546 */
547 timeout = msecs_to_jiffies(ictx->send_packet_delay);
548 set_current_state(TASK_INTERRUPTIBLE);
549 schedule_timeout(timeout);
550
551 return retval;
552}
553
554/**
555 * Sends an associate packet to the iMON 2.4G.
556 *
557 * This might not be such a good idea, since it has an id collision with
558 * some versions of the "IR & VFD" combo. The only way to determine if it
559 * is an RF version is to look at the product description string. (Which
560 * we currently do not fetch).
561 */
562static int send_associate_24g(struct imon_context *ictx)
563{
564 int retval;
565 const unsigned char packet[8] = { 0x01, 0x00, 0x00, 0x00,
566 0x00, 0x00, 0x00, 0x20 };
567
568 if (!ictx) {
569 pr_err("no context for device\n");
570 return -ENODEV;
571 }
572
573 if (!ictx->dev_present_intf0) {
574 pr_err("no iMON device present\n");
575 return -ENODEV;
576 }
577
578 memcpy(ictx->usb_tx_buf, packet, sizeof(packet));
579 retval = send_packet(ictx);
580
581 return retval;
582}
583
584/**
585 * Sends packets to setup and show clock on iMON display
586 *
587 * Arguments: year - last 2 digits of year, month - 1..12,
588 * day - 1..31, dow - day of the week (0-Sun...6-Sat),
589 * hour - 0..23, minute - 0..59, second - 0..59
590 */
591static int send_set_imon_clock(struct imon_context *ictx,
592 unsigned int year, unsigned int month,
593 unsigned int day, unsigned int dow,
594 unsigned int hour, unsigned int minute,
595 unsigned int second)
596{
597 unsigned char clock_enable_pkt[IMON_CLOCK_ENABLE_PACKETS][8];
598 int retval = 0;
599 int i;
600
601 if (!ictx) {
602 pr_err("no context for device\n");
603 return -ENODEV;
604 }
605
606 switch (ictx->display_type) {
607 case IMON_DISPLAY_TYPE_LCD:
608 clock_enable_pkt[0][0] = 0x80;
609 clock_enable_pkt[0][1] = year;
610 clock_enable_pkt[0][2] = month-1;
611 clock_enable_pkt[0][3] = day;
612 clock_enable_pkt[0][4] = hour;
613 clock_enable_pkt[0][5] = minute;
614 clock_enable_pkt[0][6] = second;
615
616 clock_enable_pkt[1][0] = 0x80;
617 clock_enable_pkt[1][1] = 0;
618 clock_enable_pkt[1][2] = 0;
619 clock_enable_pkt[1][3] = 0;
620 clock_enable_pkt[1][4] = 0;
621 clock_enable_pkt[1][5] = 0;
622 clock_enable_pkt[1][6] = 0;
623
624 if (ictx->product == 0xffdc) {
625 clock_enable_pkt[0][7] = 0x50;
626 clock_enable_pkt[1][7] = 0x51;
627 } else {
628 clock_enable_pkt[0][7] = 0x88;
629 clock_enable_pkt[1][7] = 0x8a;
630 }
631
632 break;
633
634 case IMON_DISPLAY_TYPE_VFD:
635 clock_enable_pkt[0][0] = year;
636 clock_enable_pkt[0][1] = month-1;
637 clock_enable_pkt[0][2] = day;
638 clock_enable_pkt[0][3] = dow;
639 clock_enable_pkt[0][4] = hour;
640 clock_enable_pkt[0][5] = minute;
641 clock_enable_pkt[0][6] = second;
642 clock_enable_pkt[0][7] = 0x40;
643
644 clock_enable_pkt[1][0] = 0;
645 clock_enable_pkt[1][1] = 0;
646 clock_enable_pkt[1][2] = 1;
647 clock_enable_pkt[1][3] = 0;
648 clock_enable_pkt[1][4] = 0;
649 clock_enable_pkt[1][5] = 0;
650 clock_enable_pkt[1][6] = 0;
651 clock_enable_pkt[1][7] = 0x42;
652
653 break;
654
655 default:
656 return -ENODEV;
657 }
658
659 for (i = 0; i < IMON_CLOCK_ENABLE_PACKETS; i++) {
660 memcpy(ictx->usb_tx_buf, clock_enable_pkt[i], 8);
661 retval = send_packet(ictx);
662 if (retval) {
663 pr_err("send_packet failed for packet %d\n", i);
664 break;
665 }
666 }
667
668 return retval;
669}
670
671/**
672 * These are the sysfs functions to handle the association on the iMON 2.4G LT.
673 */
674static ssize_t show_associate_remote(struct device *d,
675 struct device_attribute *attr,
676 char *buf)
677{
678 struct imon_context *ictx = dev_get_drvdata(d);
679
680 if (!ictx)
681 return -ENODEV;
682
683 mutex_lock(&ictx->lock);
684 if (ictx->rf_isassociating)
685 strcpy(buf, "associating\n");
686 else
687 strcpy(buf, "closed\n");
688
689 dev_info(d, "Visit http://www.lirc.org/html/imon-24g.html for "
690 "instructions on how to associate your iMON 2.4G DT/LT "
691 "remote\n");
692 mutex_unlock(&ictx->lock);
693 return strlen(buf);
694}
695
696static ssize_t store_associate_remote(struct device *d,
697 struct device_attribute *attr,
698 const char *buf, size_t count)
699{
700 struct imon_context *ictx;
701
702 ictx = dev_get_drvdata(d);
703
704 if (!ictx)
705 return -ENODEV;
706
707 mutex_lock(&ictx->lock);
708 ictx->rf_isassociating = true;
709 send_associate_24g(ictx);
710 mutex_unlock(&ictx->lock);
711
712 return count;
713}
714
715/**
716 * sysfs functions to control internal imon clock
717 */
718static ssize_t show_imon_clock(struct device *d,
719 struct device_attribute *attr, char *buf)
720{
721 struct imon_context *ictx = dev_get_drvdata(d);
722 size_t len;
723
724 if (!ictx)
725 return -ENODEV;
726
727 mutex_lock(&ictx->lock);
728
729 if (!ictx->display_supported) {
730 len = snprintf(buf, PAGE_SIZE, "Not supported.");
731 } else {
732 len = snprintf(buf, PAGE_SIZE,
733 "To set the clock on your iMON display:\n"
734 "# date \"+%%y %%m %%d %%w %%H %%M %%S\" > imon_clock\n"
735 "%s", ictx->display_isopen ?
736 "\nNOTE: imon device must be closed\n" : "");
737 }
738
739 mutex_unlock(&ictx->lock);
740
741 return len;
742}
743
744static ssize_t store_imon_clock(struct device *d,
745 struct device_attribute *attr,
746 const char *buf, size_t count)
747{
748 struct imon_context *ictx = dev_get_drvdata(d);
749 ssize_t retval;
750 unsigned int year, month, day, dow, hour, minute, second;
751
752 if (!ictx)
753 return -ENODEV;
754
755 mutex_lock(&ictx->lock);
756
757 if (!ictx->display_supported) {
758 retval = -ENODEV;
759 goto exit;
760 } else if (ictx->display_isopen) {
761 retval = -EBUSY;
762 goto exit;
763 }
764
765 if (sscanf(buf, "%u %u %u %u %u %u %u", &year, &month, &day, &dow,
766 &hour, &minute, &second) != 7) {
767 retval = -EINVAL;
768 goto exit;
769 }
770
771 if ((month < 1 || month > 12) ||
772 (day < 1 || day > 31) || (dow > 6) ||
773 (hour > 23) || (minute > 59) || (second > 59)) {
774 retval = -EINVAL;
775 goto exit;
776 }
777
778 retval = send_set_imon_clock(ictx, year, month, day, dow,
779 hour, minute, second);
780 if (retval)
781 goto exit;
782
783 retval = count;
784exit:
785 mutex_unlock(&ictx->lock);
786
787 return retval;
788}
789
790
791static DEVICE_ATTR(imon_clock, S_IWUSR | S_IRUGO, show_imon_clock,
792 store_imon_clock);
793
794static DEVICE_ATTR(associate_remote, S_IWUSR | S_IRUGO, show_associate_remote,
795 store_associate_remote);
796
797static struct attribute *imon_display_sysfs_entries[] = {
798 &dev_attr_imon_clock.attr,
799 NULL
800};
801
802static struct attribute_group imon_display_attr_group = {
803 .attrs = imon_display_sysfs_entries
804};
805
806static struct attribute *imon_rf_sysfs_entries[] = {
807 &dev_attr_associate_remote.attr,
808 NULL
809};
810
811static struct attribute_group imon_rf_attr_group = {
812 .attrs = imon_rf_sysfs_entries
813};
814
815/**
816 * Writes data to the VFD. The iMON VFD is 2x16 characters
817 * and requires data in 5 consecutive USB interrupt packets,
818 * each packet but the last carrying 7 bytes.
819 *
820 * I don't know if the VFD board supports features such as
821 * scrolling, clearing rows, blanking, etc. so at
822 * the caller must provide a full screen of data. If fewer
823 * than 32 bytes are provided spaces will be appended to
824 * generate a full screen.
825 */
826static ssize_t vfd_write(struct file *file, const char *buf,
827 size_t n_bytes, loff_t *pos)
828{
829 int i;
830 int offset;
831 int seq;
832 int retval = 0;
833 struct imon_context *ictx;
834 const unsigned char vfd_packet6[] = {
835 0x01, 0x00, 0x00, 0x00, 0x00, 0xFF, 0xFF };
836
837 ictx = file->private_data;
838 if (!ictx) {
839 pr_err_ratelimited("no context for device\n");
840 return -ENODEV;
841 }
842
843 mutex_lock(&ictx->lock);
844
845 if (!ictx->dev_present_intf0) {
846 pr_err_ratelimited("no iMON device present\n");
847 retval = -ENODEV;
848 goto exit;
849 }
850
851 if (n_bytes <= 0 || n_bytes > 32) {
852 pr_err_ratelimited("invalid payload size\n");
853 retval = -EINVAL;
854 goto exit;
855 }
856
857 if (copy_from_user(ictx->tx.data_buf, buf, n_bytes)) {
858 retval = -EFAULT;
859 goto exit;
860 }
861
862 /* Pad with spaces */
863 for (i = n_bytes; i < 32; ++i)
864 ictx->tx.data_buf[i] = ' ';
865
866 for (i = 32; i < 35; ++i)
867 ictx->tx.data_buf[i] = 0xFF;
868
869 offset = 0;
870 seq = 0;
871
872 do {
873 memcpy(ictx->usb_tx_buf, ictx->tx.data_buf + offset, 7);
874 ictx->usb_tx_buf[7] = (unsigned char) seq;
875
876 retval = send_packet(ictx);
877 if (retval) {
878 pr_err_ratelimited("send packet #%d failed\n", seq / 2);
879 goto exit;
880 } else {
881 seq += 2;
882 offset += 7;
883 }
884
885 } while (offset < 35);
886
887 /* Send packet #6 */
888 memcpy(ictx->usb_tx_buf, &vfd_packet6, sizeof(vfd_packet6));
889 ictx->usb_tx_buf[7] = (unsigned char) seq;
890 retval = send_packet(ictx);
891 if (retval)
892 pr_err_ratelimited("send packet #%d failed\n", seq / 2);
893
894exit:
895 mutex_unlock(&ictx->lock);
896
897 return (!retval) ? n_bytes : retval;
898}
899
900/**
901 * Writes data to the LCD. The iMON OEM LCD screen expects 8-byte
902 * packets. We accept data as 16 hexadecimal digits, followed by a
903 * newline (to make it easy to drive the device from a command-line
904 * -- even though the actual binary data is a bit complicated).
905 *
906 * The device itself is not a "traditional" text-mode display. It's
907 * actually a 16x96 pixel bitmap display. That means if you want to
908 * display text, you've got to have your own "font" and translate the
909 * text into bitmaps for display. This is really flexible (you can
910 * display whatever diacritics you need, and so on), but it's also
911 * a lot more complicated than most LCDs...
912 */
913static ssize_t lcd_write(struct file *file, const char *buf,
914 size_t n_bytes, loff_t *pos)
915{
916 int retval = 0;
917 struct imon_context *ictx;
918
919 ictx = file->private_data;
920 if (!ictx) {
921 pr_err_ratelimited("no context for device\n");
922 return -ENODEV;
923 }
924
925 mutex_lock(&ictx->lock);
926
927 if (!ictx->display_supported) {
928 pr_err_ratelimited("no iMON display present\n");
929 retval = -ENODEV;
930 goto exit;
931 }
932
933 if (n_bytes != 8) {
934 pr_err_ratelimited("invalid payload size: %d (expected 8)\n",
935 (int)n_bytes);
936 retval = -EINVAL;
937 goto exit;
938 }
939
940 if (copy_from_user(ictx->usb_tx_buf, buf, 8)) {
941 retval = -EFAULT;
942 goto exit;
943 }
944
945 retval = send_packet(ictx);
946 if (retval) {
947 pr_err_ratelimited("send packet failed!\n");
948 goto exit;
949 } else {
950 dev_dbg(ictx->dev, "%s: write %d bytes to LCD\n",
951 __func__, (int) n_bytes);
952 }
953exit:
954 mutex_unlock(&ictx->lock);
955 return (!retval) ? n_bytes : retval;
956}
957
958/**
959 * Callback function for USB core API: transmit data
960 */
961static void usb_tx_callback(struct urb *urb)
962{
963 struct imon_context *ictx;
964
965 if (!urb)
966 return;
967 ictx = (struct imon_context *)urb->context;
968 if (!ictx)
969 return;
970
971 ictx->tx.status = urb->status;
972
973 /* notify waiters that write has finished */
974 ictx->tx.busy = false;
975 smp_rmb(); /* ensure later readers know we're not busy */
976 complete(&ictx->tx.finished);
977}
978
979/**
980 * report touchscreen input
981 */
982static void imon_touch_display_timeout(unsigned long data)
983{
984 struct imon_context *ictx = (struct imon_context *)data;
985
986 if (ictx->display_type != IMON_DISPLAY_TYPE_VGA)
987 return;
988
989 input_report_abs(ictx->touch, ABS_X, ictx->touch_x);
990 input_report_abs(ictx->touch, ABS_Y, ictx->touch_y);
991 input_report_key(ictx->touch, BTN_TOUCH, 0x00);
992 input_sync(ictx->touch);
993}
994
995/**
996 * iMON IR receivers support two different signal sets -- those used by
997 * the iMON remotes, and those used by the Windows MCE remotes (which is
998 * really just RC-6), but only one or the other at a time, as the signals
999 * are decoded onboard the receiver.
1000 *
1001 * This function gets called two different ways, one way is from
1002 * rc_register_device, for initial protocol selection/setup, and the other is
1003 * via a userspace-initiated protocol change request, either by direct sysfs
1004 * prodding or by something like ir-keytable. In the rc_register_device case,
1005 * the imon context lock is already held, but when initiated from userspace,
1006 * it is not, so we must acquire it prior to calling send_packet, which
1007 * requires that the lock is held.
1008 */
1009static int imon_ir_change_protocol(struct rc_dev *rc, u64 *rc_type)
1010{
1011 int retval;
1012 struct imon_context *ictx = rc->priv;
1013 struct device *dev = ictx->dev;
1014 bool unlock = false;
1015 unsigned char ir_proto_packet[] = {
1016 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x86 };
1017
1018 if (*rc_type && !(*rc_type & rc->allowed_protos))
1019 dev_warn(dev, "Looks like you're trying to use an IR protocol "
1020 "this device does not support\n");
1021
1022 if (*rc_type & RC_BIT_RC6_MCE) {
1023 dev_dbg(dev, "Configuring IR receiver for MCE protocol\n");
1024 ir_proto_packet[0] = 0x01;
1025 *rc_type = RC_BIT_RC6_MCE;
1026 } else if (*rc_type & RC_BIT_OTHER) {
1027 dev_dbg(dev, "Configuring IR receiver for iMON protocol\n");
1028 if (!pad_stabilize)
1029 dev_dbg(dev, "PAD stabilize functionality disabled\n");
1030 /* ir_proto_packet[0] = 0x00; // already the default */
1031 *rc_type = RC_BIT_OTHER;
1032 } else {
1033 dev_warn(dev, "Unsupported IR protocol specified, overriding "
1034 "to iMON IR protocol\n");
1035 if (!pad_stabilize)
1036 dev_dbg(dev, "PAD stabilize functionality disabled\n");
1037 /* ir_proto_packet[0] = 0x00; // already the default */
1038 *rc_type = RC_BIT_OTHER;
1039 }
1040
1041 memcpy(ictx->usb_tx_buf, &ir_proto_packet, sizeof(ir_proto_packet));
1042
1043 if (!mutex_is_locked(&ictx->lock)) {
1044 unlock = true;
1045 mutex_lock(&ictx->lock);
1046 }
1047
1048 retval = send_packet(ictx);
1049 if (retval)
1050 goto out;
1051
1052 ictx->rc_type = *rc_type;
1053 ictx->pad_mouse = false;
1054
1055out:
1056 if (unlock)
1057 mutex_unlock(&ictx->lock);
1058
1059 return retval;
1060}
1061
1062static inline int tv2int(const struct timeval *a, const struct timeval *b)
1063{
1064 int usecs = 0;
1065 int sec = 0;
1066
1067 if (b->tv_usec > a->tv_usec) {
1068 usecs = 1000000;
1069 sec--;
1070 }
1071
1072 usecs += a->tv_usec - b->tv_usec;
1073
1074 sec += a->tv_sec - b->tv_sec;
1075 sec *= 1000;
1076 usecs /= 1000;
1077 sec += usecs;
1078
1079 if (sec < 0)
1080 sec = 1000;
1081
1082 return sec;
1083}
1084
1085/**
1086 * The directional pad behaves a bit differently, depending on whether this is
1087 * one of the older ffdc devices or a newer device. Newer devices appear to
1088 * have a higher resolution matrix for more precise mouse movement, but it
1089 * makes things overly sensitive in keyboard mode, so we do some interesting
1090 * contortions to make it less touchy. Older devices run through the same
1091 * routine with shorter timeout and a smaller threshold.
1092 */
1093static int stabilize(int a, int b, u16 timeout, u16 threshold)
1094{
1095 struct timeval ct;
1096 static struct timeval prev_time = {0, 0};
1097 static struct timeval hit_time = {0, 0};
1098 static int x, y, prev_result, hits;
1099 int result = 0;
1100 int msec, msec_hit;
1101
1102 do_gettimeofday(&ct);
1103 msec = tv2int(&ct, &prev_time);
1104 msec_hit = tv2int(&ct, &hit_time);
1105
1106 if (msec > 100) {
1107 x = 0;
1108 y = 0;
1109 hits = 0;
1110 }
1111
1112 x += a;
1113 y += b;
1114
1115 prev_time = ct;
1116
1117 if (abs(x) > threshold || abs(y) > threshold) {
1118 if (abs(y) > abs(x))
1119 result = (y > 0) ? 0x7F : 0x80;
1120 else
1121 result = (x > 0) ? 0x7F00 : 0x8000;
1122
1123 x = 0;
1124 y = 0;
1125
1126 if (result == prev_result) {
1127 hits++;
1128
1129 if (hits > 3) {
1130 switch (result) {
1131 case 0x7F:
1132 y = 17 * threshold / 30;
1133 break;
1134 case 0x80:
1135 y -= 17 * threshold / 30;
1136 break;
1137 case 0x7F00:
1138 x = 17 * threshold / 30;
1139 break;
1140 case 0x8000:
1141 x -= 17 * threshold / 30;
1142 break;
1143 }
1144 }
1145
1146 if (hits == 2 && msec_hit < timeout) {
1147 result = 0;
1148 hits = 1;
1149 }
1150 } else {
1151 prev_result = result;
1152 hits = 1;
1153 hit_time = ct;
1154 }
1155 }
1156
1157 return result;
1158}
1159
1160static u32 imon_remote_key_lookup(struct imon_context *ictx, u32 scancode)
1161{
1162 u32 keycode;
1163 u32 release;
1164 bool is_release_code = false;
1165
1166 /* Look for the initial press of a button */
1167 keycode = rc_g_keycode_from_table(ictx->rdev, scancode);
1168 ictx->rc_toggle = 0x0;
1169 ictx->rc_scancode = scancode;
1170
1171 /* Look for the release of a button */
1172 if (keycode == KEY_RESERVED) {
1173 release = scancode & ~0x4000;
1174 keycode = rc_g_keycode_from_table(ictx->rdev, release);
1175 if (keycode != KEY_RESERVED)
1176 is_release_code = true;
1177 }
1178
1179 ictx->release_code = is_release_code;
1180
1181 return keycode;
1182}
1183
1184static u32 imon_mce_key_lookup(struct imon_context *ictx, u32 scancode)
1185{
1186 u32 keycode;
1187
1188#define MCE_KEY_MASK 0x7000
1189#define MCE_TOGGLE_BIT 0x8000
1190
1191 /*
1192 * On some receivers, mce keys decode to 0x8000f04xx and 0x8000f84xx
1193 * (the toggle bit flipping between alternating key presses), while
1194 * on other receivers, we see 0x8000f74xx and 0x8000ff4xx. To keep
1195 * the table trim, we always or in the bits to look up 0x8000ff4xx,
1196 * but we can't or them into all codes, as some keys are decoded in
1197 * a different way w/o the same use of the toggle bit...
1198 */
1199 if (scancode & 0x80000000)
1200 scancode = scancode | MCE_KEY_MASK | MCE_TOGGLE_BIT;
1201
1202 ictx->rc_scancode = scancode;
1203 keycode = rc_g_keycode_from_table(ictx->rdev, scancode);
1204
1205 /* not used in mce mode, but make sure we know its false */
1206 ictx->release_code = false;
1207
1208 return keycode;
1209}
1210
1211static u32 imon_panel_key_lookup(u64 code)
1212{
1213 int i;
1214 u32 keycode = KEY_RESERVED;
1215
1216 for (i = 0; i < ARRAY_SIZE(imon_panel_key_table); i++) {
1217 if (imon_panel_key_table[i].hw_code == (code | 0xffee)) {
1218 keycode = imon_panel_key_table[i].keycode;
1219 break;
1220 }
1221 }
1222
1223 return keycode;
1224}
1225
1226static bool imon_mouse_event(struct imon_context *ictx,
1227 unsigned char *buf, int len)
1228{
1229 signed char rel_x = 0x00, rel_y = 0x00;
1230 u8 right_shift = 1;
1231 bool mouse_input = true;
1232 int dir = 0;
1233 unsigned long flags;
1234
1235 spin_lock_irqsave(&ictx->kc_lock, flags);
1236
1237 /* newer iMON device PAD or mouse button */
1238 if (ictx->product != 0xffdc && (buf[0] & 0x01) && len == 5) {
1239 rel_x = buf[2];
1240 rel_y = buf[3];
1241 right_shift = 1;
1242 /* 0xffdc iMON PAD or mouse button input */
1243 } else if (ictx->product == 0xffdc && (buf[0] & 0x40) &&
1244 !((buf[1] & 0x01) || ((buf[1] >> 2) & 0x01))) {
1245 rel_x = (buf[1] & 0x08) | (buf[1] & 0x10) >> 2 |
1246 (buf[1] & 0x20) >> 4 | (buf[1] & 0x40) >> 6;
1247 if (buf[0] & 0x02)
1248 rel_x |= ~0x0f;
1249 rel_x = rel_x + rel_x / 2;
1250 rel_y = (buf[2] & 0x08) | (buf[2] & 0x10) >> 2 |
1251 (buf[2] & 0x20) >> 4 | (buf[2] & 0x40) >> 6;
1252 if (buf[0] & 0x01)
1253 rel_y |= ~0x0f;
1254 rel_y = rel_y + rel_y / 2;
1255 right_shift = 2;
1256 /* some ffdc devices decode mouse buttons differently... */
1257 } else if (ictx->product == 0xffdc && (buf[0] == 0x68)) {
1258 right_shift = 2;
1259 /* ch+/- buttons, which we use for an emulated scroll wheel */
1260 } else if (ictx->kc == KEY_CHANNELUP && (buf[2] & 0x40) != 0x40) {
1261 dir = 1;
1262 } else if (ictx->kc == KEY_CHANNELDOWN && (buf[2] & 0x40) != 0x40) {
1263 dir = -1;
1264 } else
1265 mouse_input = false;
1266
1267 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1268
1269 if (mouse_input) {
1270 dev_dbg(ictx->dev, "sending mouse data via input subsystem\n");
1271
1272 if (dir) {
1273 input_report_rel(ictx->idev, REL_WHEEL, dir);
1274 } else if (rel_x || rel_y) {
1275 input_report_rel(ictx->idev, REL_X, rel_x);
1276 input_report_rel(ictx->idev, REL_Y, rel_y);
1277 } else {
1278 input_report_key(ictx->idev, BTN_LEFT, buf[1] & 0x1);
1279 input_report_key(ictx->idev, BTN_RIGHT,
1280 buf[1] >> right_shift & 0x1);
1281 }
1282 input_sync(ictx->idev);
1283 spin_lock_irqsave(&ictx->kc_lock, flags);
1284 ictx->last_keycode = ictx->kc;
1285 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1286 }
1287
1288 return mouse_input;
1289}
1290
1291static void imon_touch_event(struct imon_context *ictx, unsigned char *buf)
1292{
1293 mod_timer(&ictx->ttimer, jiffies + TOUCH_TIMEOUT);
1294 ictx->touch_x = (buf[0] << 4) | (buf[1] >> 4);
1295 ictx->touch_y = 0xfff - ((buf[2] << 4) | (buf[1] & 0xf));
1296 input_report_abs(ictx->touch, ABS_X, ictx->touch_x);
1297 input_report_abs(ictx->touch, ABS_Y, ictx->touch_y);
1298 input_report_key(ictx->touch, BTN_TOUCH, 0x01);
1299 input_sync(ictx->touch);
1300}
1301
1302static void imon_pad_to_keys(struct imon_context *ictx, unsigned char *buf)
1303{
1304 int dir = 0;
1305 signed char rel_x = 0x00, rel_y = 0x00;
1306 u16 timeout, threshold;
1307 u32 scancode = KEY_RESERVED;
1308 unsigned long flags;
1309
1310 /*
1311 * The imon directional pad functions more like a touchpad. Bytes 3 & 4
1312 * contain a position coordinate (x,y), with each component ranging
1313 * from -14 to 14. We want to down-sample this to only 4 discrete values
1314 * for up/down/left/right arrow keys. Also, when you get too close to
1315 * diagonals, it has a tendency to jump back and forth, so lets try to
1316 * ignore when they get too close.
1317 */
1318 if (ictx->product != 0xffdc) {
1319 /* first, pad to 8 bytes so it conforms with everything else */
1320 buf[5] = buf[6] = buf[7] = 0;
1321 timeout = 500; /* in msecs */
1322 /* (2*threshold) x (2*threshold) square */
1323 threshold = pad_thresh ? pad_thresh : 28;
1324 rel_x = buf[2];
1325 rel_y = buf[3];
1326
1327 if (ictx->rc_type == RC_BIT_OTHER && pad_stabilize) {
1328 if ((buf[1] == 0) && ((rel_x != 0) || (rel_y != 0))) {
1329 dir = stabilize((int)rel_x, (int)rel_y,
1330 timeout, threshold);
1331 if (!dir) {
1332 spin_lock_irqsave(&ictx->kc_lock,
1333 flags);
1334 ictx->kc = KEY_UNKNOWN;
1335 spin_unlock_irqrestore(&ictx->kc_lock,
1336 flags);
1337 return;
1338 }
1339 buf[2] = dir & 0xFF;
1340 buf[3] = (dir >> 8) & 0xFF;
1341 scancode = be32_to_cpu(*((u32 *)buf));
1342 }
1343 } else {
1344 /*
1345 * Hack alert: instead of using keycodes, we have
1346 * to use hard-coded scancodes here...
1347 */
1348 if (abs(rel_y) > abs(rel_x)) {
1349 buf[2] = (rel_y > 0) ? 0x7F : 0x80;
1350 buf[3] = 0;
1351 if (rel_y > 0)
1352 scancode = 0x01007f00; /* KEY_DOWN */
1353 else
1354 scancode = 0x01008000; /* KEY_UP */
1355 } else {
1356 buf[2] = 0;
1357 buf[3] = (rel_x > 0) ? 0x7F : 0x80;
1358 if (rel_x > 0)
1359 scancode = 0x0100007f; /* KEY_RIGHT */
1360 else
1361 scancode = 0x01000080; /* KEY_LEFT */
1362 }
1363 }
1364
1365 /*
1366 * Handle on-board decoded pad events for e.g. older VFD/iMON-Pad
1367 * device (15c2:ffdc). The remote generates various codes from
1368 * 0x68nnnnB7 to 0x6AnnnnB7, the left mouse button generates
1369 * 0x688301b7 and the right one 0x688481b7. All other keys generate
1370 * 0x2nnnnnnn. Position coordinate is encoded in buf[1] and buf[2] with
1371 * reversed endianess. Extract direction from buffer, rotate endianess,
1372 * adjust sign and feed the values into stabilize(). The resulting codes
1373 * will be 0x01008000, 0x01007F00, which match the newer devices.
1374 */
1375 } else {
1376 timeout = 10; /* in msecs */
1377 /* (2*threshold) x (2*threshold) square */
1378 threshold = pad_thresh ? pad_thresh : 15;
1379
1380 /* buf[1] is x */
1381 rel_x = (buf[1] & 0x08) | (buf[1] & 0x10) >> 2 |
1382 (buf[1] & 0x20) >> 4 | (buf[1] & 0x40) >> 6;
1383 if (buf[0] & 0x02)
1384 rel_x |= ~0x10+1;
1385 /* buf[2] is y */
1386 rel_y = (buf[2] & 0x08) | (buf[2] & 0x10) >> 2 |
1387 (buf[2] & 0x20) >> 4 | (buf[2] & 0x40) >> 6;
1388 if (buf[0] & 0x01)
1389 rel_y |= ~0x10+1;
1390
1391 buf[0] = 0x01;
1392 buf[1] = buf[4] = buf[5] = buf[6] = buf[7] = 0;
1393
1394 if (ictx->rc_type == RC_BIT_OTHER && pad_stabilize) {
1395 dir = stabilize((int)rel_x, (int)rel_y,
1396 timeout, threshold);
1397 if (!dir) {
1398 spin_lock_irqsave(&ictx->kc_lock, flags);
1399 ictx->kc = KEY_UNKNOWN;
1400 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1401 return;
1402 }
1403 buf[2] = dir & 0xFF;
1404 buf[3] = (dir >> 8) & 0xFF;
1405 scancode = be32_to_cpu(*((u32 *)buf));
1406 } else {
1407 /*
1408 * Hack alert: instead of using keycodes, we have
1409 * to use hard-coded scancodes here...
1410 */
1411 if (abs(rel_y) > abs(rel_x)) {
1412 buf[2] = (rel_y > 0) ? 0x7F : 0x80;
1413 buf[3] = 0;
1414 if (rel_y > 0)
1415 scancode = 0x01007f00; /* KEY_DOWN */
1416 else
1417 scancode = 0x01008000; /* KEY_UP */
1418 } else {
1419 buf[2] = 0;
1420 buf[3] = (rel_x > 0) ? 0x7F : 0x80;
1421 if (rel_x > 0)
1422 scancode = 0x0100007f; /* KEY_RIGHT */
1423 else
1424 scancode = 0x01000080; /* KEY_LEFT */
1425 }
1426 }
1427 }
1428
1429 if (scancode) {
1430 spin_lock_irqsave(&ictx->kc_lock, flags);
1431 ictx->kc = imon_remote_key_lookup(ictx, scancode);
1432 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1433 }
1434}
1435
1436/**
1437 * figure out if these is a press or a release. We don't actually
1438 * care about repeats, as those will be auto-generated within the IR
1439 * subsystem for repeating scancodes.
1440 */
1441static int imon_parse_press_type(struct imon_context *ictx,
1442 unsigned char *buf, u8 ktype)
1443{
1444 int press_type = 0;
1445 unsigned long flags;
1446
1447 spin_lock_irqsave(&ictx->kc_lock, flags);
1448
1449 /* key release of 0x02XXXXXX key */
1450 if (ictx->kc == KEY_RESERVED && buf[0] == 0x02 && buf[3] == 0x00)
1451 ictx->kc = ictx->last_keycode;
1452
1453 /* mouse button release on (some) 0xffdc devices */
1454 else if (ictx->kc == KEY_RESERVED && buf[0] == 0x68 && buf[1] == 0x82 &&
1455 buf[2] == 0x81 && buf[3] == 0xb7)
1456 ictx->kc = ictx->last_keycode;
1457
1458 /* mouse button release on (some other) 0xffdc devices */
1459 else if (ictx->kc == KEY_RESERVED && buf[0] == 0x01 && buf[1] == 0x00 &&
1460 buf[2] == 0x81 && buf[3] == 0xb7)
1461 ictx->kc = ictx->last_keycode;
1462
1463 /* mce-specific button handling, no keyup events */
1464 else if (ktype == IMON_KEY_MCE) {
1465 ictx->rc_toggle = buf[2];
1466 press_type = 1;
1467
1468 /* incoherent or irrelevant data */
1469 } else if (ictx->kc == KEY_RESERVED)
1470 press_type = -EINVAL;
1471
1472 /* key release of 0xXXXXXXb7 key */
1473 else if (ictx->release_code)
1474 press_type = 0;
1475
1476 /* this is a button press */
1477 else
1478 press_type = 1;
1479
1480 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1481
1482 return press_type;
1483}
1484
1485/**
1486 * Process the incoming packet
1487 */
1488static void imon_incoming_packet(struct imon_context *ictx,
1489 struct urb *urb, int intf)
1490{
1491 int len = urb->actual_length;
1492 unsigned char *buf = urb->transfer_buffer;
1493 struct device *dev = ictx->dev;
1494 unsigned long flags;
1495 u32 kc;
1496 int i;
1497 u64 scancode;
1498 int press_type = 0;
1499 int msec;
1500 struct timeval t;
1501 static struct timeval prev_time = { 0, 0 };
1502 u8 ktype;
1503
1504 /* filter out junk data on the older 0xffdc imon devices */
1505 if ((buf[0] == 0xff) && (buf[1] == 0xff) && (buf[2] == 0xff))
1506 return;
1507
1508 /* Figure out what key was pressed */
1509 if (len == 8 && buf[7] == 0xee) {
1510 scancode = be64_to_cpu(*((u64 *)buf));
1511 ktype = IMON_KEY_PANEL;
1512 kc = imon_panel_key_lookup(scancode);
1513 } else {
1514 scancode = be32_to_cpu(*((u32 *)buf));
1515 if (ictx->rc_type == RC_BIT_RC6_MCE) {
1516 ktype = IMON_KEY_IMON;
1517 if (buf[0] == 0x80)
1518 ktype = IMON_KEY_MCE;
1519 kc = imon_mce_key_lookup(ictx, scancode);
1520 } else {
1521 ktype = IMON_KEY_IMON;
1522 kc = imon_remote_key_lookup(ictx, scancode);
1523 }
1524 }
1525
1526 spin_lock_irqsave(&ictx->kc_lock, flags);
1527 /* keyboard/mouse mode toggle button */
1528 if (kc == KEY_KEYBOARD && !ictx->release_code) {
1529 ictx->last_keycode = kc;
1530 if (!nomouse) {
1531 ictx->pad_mouse = ~(ictx->pad_mouse) & 0x1;
1532 dev_dbg(dev, "toggling to %s mode\n",
1533 ictx->pad_mouse ? "mouse" : "keyboard");
1534 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1535 return;
1536 } else {
1537 ictx->pad_mouse = false;
1538 dev_dbg(dev, "mouse mode disabled, passing key value\n");
1539 }
1540 }
1541
1542 ictx->kc = kc;
1543 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1544
1545 /* send touchscreen events through input subsystem if touchpad data */
1546 if (ictx->display_type == IMON_DISPLAY_TYPE_VGA && len == 8 &&
1547 buf[7] == 0x86) {
1548 imon_touch_event(ictx, buf);
1549 return;
1550
1551 /* look for mouse events with pad in mouse mode */
1552 } else if (ictx->pad_mouse) {
1553 if (imon_mouse_event(ictx, buf, len))
1554 return;
1555 }
1556
1557 /* Now for some special handling to convert pad input to arrow keys */
1558 if (((len == 5) && (buf[0] == 0x01) && (buf[4] == 0x00)) ||
1559 ((len == 8) && (buf[0] & 0x40) &&
1560 !(buf[1] & 0x1 || buf[1] >> 2 & 0x1))) {
1561 len = 8;
1562 imon_pad_to_keys(ictx, buf);
1563 }
1564
1565 if (debug) {
1566 printk(KERN_INFO "intf%d decoded packet: ", intf);
1567 for (i = 0; i < len; ++i)
1568 printk("%02x ", buf[i]);
1569 printk("\n");
1570 }
1571
1572 press_type = imon_parse_press_type(ictx, buf, ktype);
1573 if (press_type < 0)
1574 goto not_input_data;
1575
1576 if (ktype != IMON_KEY_PANEL) {
1577 if (press_type == 0)
1578 rc_keyup(ictx->rdev);
1579 else {
1580 rc_keydown(ictx->rdev, ictx->rc_scancode, ictx->rc_toggle);
1581 spin_lock_irqsave(&ictx->kc_lock, flags);
1582 ictx->last_keycode = ictx->kc;
1583 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1584 }
1585 return;
1586 }
1587
1588 /* Only panel type events left to process now */
1589 spin_lock_irqsave(&ictx->kc_lock, flags);
1590
1591 do_gettimeofday(&t);
1592 /* KEY_MUTE repeats from knob need to be suppressed */
1593 if (ictx->kc == KEY_MUTE && ictx->kc == ictx->last_keycode) {
1594 msec = tv2int(&t, &prev_time);
1595 if (msec < ictx->idev->rep[REP_DELAY]) {
1596 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1597 return;
1598 }
1599 }
1600 prev_time = t;
1601 kc = ictx->kc;
1602
1603 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1604
1605 input_report_key(ictx->idev, kc, press_type);
1606 input_sync(ictx->idev);
1607
1608 /* panel keys don't generate a release */
1609 input_report_key(ictx->idev, kc, 0);
1610 input_sync(ictx->idev);
1611
1612 spin_lock_irqsave(&ictx->kc_lock, flags);
1613 ictx->last_keycode = kc;
1614 spin_unlock_irqrestore(&ictx->kc_lock, flags);
1615
1616 return;
1617
1618not_input_data:
1619 if (len != 8) {
1620 dev_warn(dev, "imon %s: invalid incoming packet "
1621 "size (len = %d, intf%d)\n", __func__, len, intf);
1622 return;
1623 }
1624
1625 /* iMON 2.4G associate frame */
1626 if (buf[0] == 0x00 &&
1627 buf[2] == 0xFF && /* REFID */
1628 buf[3] == 0xFF &&
1629 buf[4] == 0xFF &&
1630 buf[5] == 0xFF && /* iMON 2.4G */
1631 ((buf[6] == 0x4E && buf[7] == 0xDF) || /* LT */
1632 (buf[6] == 0x5E && buf[7] == 0xDF))) { /* DT */
1633 dev_warn(dev, "%s: remote associated refid=%02X\n",
1634 __func__, buf[1]);
1635 ictx->rf_isassociating = false;
1636 }
1637}
1638
1639/**
1640 * Callback function for USB core API: receive data
1641 */
1642static void usb_rx_callback_intf0(struct urb *urb)
1643{
1644 struct imon_context *ictx;
1645 int intfnum = 0;
1646
1647 if (!urb)
1648 return;
1649
1650 ictx = (struct imon_context *)urb->context;
1651 if (!ictx)
1652 return;
1653
1654 /*
1655 * if we get a callback before we're done configuring the hardware, we
1656 * can't yet process the data, as there's nowhere to send it, but we
1657 * still need to submit a new rx URB to avoid wedging the hardware
1658 */
1659 if (!ictx->dev_present_intf0)
1660 goto out;
1661
1662 switch (urb->status) {
1663 case -ENOENT: /* usbcore unlink successful! */
1664 return;
1665
1666 case -ESHUTDOWN: /* transport endpoint was shut down */
1667 break;
1668
1669 case 0:
1670 imon_incoming_packet(ictx, urb, intfnum);
1671 break;
1672
1673 default:
1674 dev_warn(ictx->dev, "imon %s: status(%d): ignored\n",
1675 __func__, urb->status);
1676 break;
1677 }
1678
1679out:
1680 usb_submit_urb(ictx->rx_urb_intf0, GFP_ATOMIC);
1681}
1682
1683static void usb_rx_callback_intf1(struct urb *urb)
1684{
1685 struct imon_context *ictx;
1686 int intfnum = 1;
1687
1688 if (!urb)
1689 return;
1690
1691 ictx = (struct imon_context *)urb->context;
1692 if (!ictx)
1693 return;
1694
1695 /*
1696 * if we get a callback before we're done configuring the hardware, we
1697 * can't yet process the data, as there's nowhere to send it, but we
1698 * still need to submit a new rx URB to avoid wedging the hardware
1699 */
1700 if (!ictx->dev_present_intf1)
1701 goto out;
1702
1703 switch (urb->status) {
1704 case -ENOENT: /* usbcore unlink successful! */
1705 return;
1706
1707 case -ESHUTDOWN: /* transport endpoint was shut down */
1708 break;
1709
1710 case 0:
1711 imon_incoming_packet(ictx, urb, intfnum);
1712 break;
1713
1714 default:
1715 dev_warn(ictx->dev, "imon %s: status(%d): ignored\n",
1716 __func__, urb->status);
1717 break;
1718 }
1719
1720out:
1721 usb_submit_urb(ictx->rx_urb_intf1, GFP_ATOMIC);
1722}
1723
1724/*
1725 * The 0x15c2:0xffdc device ID was used for umpteen different imon
1726 * devices, and all of them constantly spew interrupts, even when there
1727 * is no actual data to report. However, byte 6 of this buffer looks like
1728 * its unique across device variants, so we're trying to key off that to
1729 * figure out which display type (if any) and what IR protocol the device
1730 * actually supports. These devices have their IR protocol hard-coded into
1731 * their firmware, they can't be changed on the fly like the newer hardware.
1732 */
1733static void imon_get_ffdc_type(struct imon_context *ictx)
1734{
1735 u8 ffdc_cfg_byte = ictx->usb_rx_buf[6];
1736 u8 detected_display_type = IMON_DISPLAY_TYPE_NONE;
1737 u64 allowed_protos = RC_BIT_OTHER;
1738
1739 switch (ffdc_cfg_byte) {
1740 /* iMON Knob, no display, iMON IR + vol knob */
1741 case 0x21:
1742 dev_info(ictx->dev, "0xffdc iMON Knob, iMON IR");
1743 ictx->display_supported = false;
1744 break;
1745 /* iMON 2.4G LT (usb stick), no display, iMON RF */
1746 case 0x4e:
1747 dev_info(ictx->dev, "0xffdc iMON 2.4G LT, iMON RF");
1748 ictx->display_supported = false;
1749 ictx->rf_device = true;
1750 break;
1751 /* iMON VFD, no IR (does have vol knob tho) */
1752 case 0x35:
1753 dev_info(ictx->dev, "0xffdc iMON VFD + knob, no IR");
1754 detected_display_type = IMON_DISPLAY_TYPE_VFD;
1755 break;
1756 /* iMON VFD, iMON IR */
1757 case 0x24:
1758 case 0x85:
1759 dev_info(ictx->dev, "0xffdc iMON VFD, iMON IR");
1760 detected_display_type = IMON_DISPLAY_TYPE_VFD;
1761 break;
1762 /* iMON VFD, MCE IR */
1763 case 0x46:
1764 case 0x7e:
1765 case 0x9e:
1766 dev_info(ictx->dev, "0xffdc iMON VFD, MCE IR");
1767 detected_display_type = IMON_DISPLAY_TYPE_VFD;
1768 allowed_protos = RC_BIT_RC6_MCE;
1769 break;
1770 /* iMON LCD, MCE IR */
1771 case 0x9f:
1772 dev_info(ictx->dev, "0xffdc iMON LCD, MCE IR");
1773 detected_display_type = IMON_DISPLAY_TYPE_LCD;
1774 allowed_protos = RC_BIT_RC6_MCE;
1775 break;
1776 default:
1777 dev_info(ictx->dev, "Unknown 0xffdc device, "
1778 "defaulting to VFD and iMON IR");
1779 detected_display_type = IMON_DISPLAY_TYPE_VFD;
1780 /* We don't know which one it is, allow user to set the
1781 * RC6 one from userspace if OTHER wasn't correct. */
1782 allowed_protos |= RC_BIT_RC6_MCE;
1783 break;
1784 }
1785
1786 printk(KERN_CONT " (id 0x%02x)\n", ffdc_cfg_byte);
1787
1788 ictx->display_type = detected_display_type;
1789 ictx->rc_type = allowed_protos;
1790}
1791
1792static void imon_set_display_type(struct imon_context *ictx)
1793{
1794 u8 configured_display_type = IMON_DISPLAY_TYPE_VFD;
1795
1796 /*
1797 * Try to auto-detect the type of display if the user hasn't set
1798 * it by hand via the display_type modparam. Default is VFD.
1799 */
1800
1801 if (display_type == IMON_DISPLAY_TYPE_AUTO) {
1802 switch (ictx->product) {
1803 case 0xffdc:
1804 /* set in imon_get_ffdc_type() */
1805 configured_display_type = ictx->display_type;
1806 break;
1807 case 0x0034:
1808 case 0x0035:
1809 configured_display_type = IMON_DISPLAY_TYPE_VGA;
1810 break;
1811 case 0x0038:
1812 case 0x0039:
1813 case 0x0045:
1814 configured_display_type = IMON_DISPLAY_TYPE_LCD;
1815 break;
1816 case 0x003c:
1817 case 0x0041:
1818 case 0x0042:
1819 case 0x0043:
1820 configured_display_type = IMON_DISPLAY_TYPE_NONE;
1821 ictx->display_supported = false;
1822 break;
1823 case 0x0036:
1824 case 0x0044:
1825 default:
1826 configured_display_type = IMON_DISPLAY_TYPE_VFD;
1827 break;
1828 }
1829 } else {
1830 configured_display_type = display_type;
1831 if (display_type == IMON_DISPLAY_TYPE_NONE)
1832 ictx->display_supported = false;
1833 else
1834 ictx->display_supported = true;
1835 dev_info(ictx->dev, "%s: overriding display type to %d via "
1836 "modparam\n", __func__, display_type);
1837 }
1838
1839 ictx->display_type = configured_display_type;
1840}
1841
1842static struct rc_dev *imon_init_rdev(struct imon_context *ictx)
1843{
1844 struct rc_dev *rdev;
1845 int ret;
1846 const unsigned char fp_packet[] = { 0x40, 0x00, 0x00, 0x00,
1847 0x00, 0x00, 0x00, 0x88 };
1848
1849 rdev = rc_allocate_device();
1850 if (!rdev) {
1851 dev_err(ictx->dev, "remote control dev allocation failed\n");
1852 goto out;
1853 }
1854
1855 snprintf(ictx->name_rdev, sizeof(ictx->name_rdev),
1856 "iMON Remote (%04x:%04x)", ictx->vendor, ictx->product);
1857 usb_make_path(ictx->usbdev_intf0, ictx->phys_rdev,
1858 sizeof(ictx->phys_rdev));
1859 strlcat(ictx->phys_rdev, "/input0", sizeof(ictx->phys_rdev));
1860
1861 rdev->input_name = ictx->name_rdev;
1862 rdev->input_phys = ictx->phys_rdev;
1863 usb_to_input_id(ictx->usbdev_intf0, &rdev->input_id);
1864 rdev->dev.parent = ictx->dev;
1865
1866 rdev->priv = ictx;
1867 rdev->driver_type = RC_DRIVER_SCANCODE;
1868 rdev->allowed_protos = RC_BIT_OTHER | RC_BIT_RC6_MCE; /* iMON PAD or MCE */
1869 rdev->change_protocol = imon_ir_change_protocol;
1870 rdev->driver_name = MOD_NAME;
1871
1872 /* Enable front-panel buttons and/or knobs */
1873 memcpy(ictx->usb_tx_buf, &fp_packet, sizeof(fp_packet));
1874 ret = send_packet(ictx);
1875 /* Not fatal, but warn about it */
1876 if (ret)
1877 dev_info(ictx->dev, "panel buttons/knobs setup failed\n");
1878
1879 if (ictx->product == 0xffdc) {
1880 imon_get_ffdc_type(ictx);
1881 rdev->allowed_protos = ictx->rc_type;
1882 }
1883
1884 imon_set_display_type(ictx);
1885
1886 if (ictx->rc_type == RC_BIT_RC6_MCE)
1887 rdev->map_name = RC_MAP_IMON_MCE;
1888 else
1889 rdev->map_name = RC_MAP_IMON_PAD;
1890
1891 ret = rc_register_device(rdev);
1892 if (ret < 0) {
1893 dev_err(ictx->dev, "remote input dev register failed\n");
1894 goto out;
1895 }
1896
1897 return rdev;
1898
1899out:
1900 rc_free_device(rdev);
1901 return NULL;
1902}
1903
1904static struct input_dev *imon_init_idev(struct imon_context *ictx)
1905{
1906 struct input_dev *idev;
1907 int ret, i;
1908
1909 idev = input_allocate_device();
1910 if (!idev) {
1911 dev_err(ictx->dev, "input dev allocation failed\n");
1912 goto out;
1913 }
1914
1915 snprintf(ictx->name_idev, sizeof(ictx->name_idev),
1916 "iMON Panel, Knob and Mouse(%04x:%04x)",
1917 ictx->vendor, ictx->product);
1918 idev->name = ictx->name_idev;
1919
1920 usb_make_path(ictx->usbdev_intf0, ictx->phys_idev,
1921 sizeof(ictx->phys_idev));
1922 strlcat(ictx->phys_idev, "/input1", sizeof(ictx->phys_idev));
1923 idev->phys = ictx->phys_idev;
1924
1925 idev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP) | BIT_MASK(EV_REL);
1926
1927 idev->keybit[BIT_WORD(BTN_MOUSE)] =
1928 BIT_MASK(BTN_LEFT) | BIT_MASK(BTN_RIGHT);
1929 idev->relbit[0] = BIT_MASK(REL_X) | BIT_MASK(REL_Y) |
1930 BIT_MASK(REL_WHEEL);
1931
1932 /* panel and/or knob code support */
1933 for (i = 0; i < ARRAY_SIZE(imon_panel_key_table); i++) {
1934 u32 kc = imon_panel_key_table[i].keycode;
1935 __set_bit(kc, idev->keybit);
1936 }
1937
1938 usb_to_input_id(ictx->usbdev_intf0, &idev->id);
1939 idev->dev.parent = ictx->dev;
1940 input_set_drvdata(idev, ictx);
1941
1942 ret = input_register_device(idev);
1943 if (ret < 0) {
1944 dev_err(ictx->dev, "input dev register failed\n");
1945 goto out;
1946 }
1947
1948 return idev;
1949
1950out:
1951 input_free_device(idev);
1952 return NULL;
1953}
1954
1955static struct input_dev *imon_init_touch(struct imon_context *ictx)
1956{
1957 struct input_dev *touch;
1958 int ret;
1959
1960 touch = input_allocate_device();
1961 if (!touch) {
1962 dev_err(ictx->dev, "touchscreen input dev allocation failed\n");
1963 goto touch_alloc_failed;
1964 }
1965
1966 snprintf(ictx->name_touch, sizeof(ictx->name_touch),
1967 "iMON USB Touchscreen (%04x:%04x)",
1968 ictx->vendor, ictx->product);
1969 touch->name = ictx->name_touch;
1970
1971 usb_make_path(ictx->usbdev_intf1, ictx->phys_touch,
1972 sizeof(ictx->phys_touch));
1973 strlcat(ictx->phys_touch, "/input2", sizeof(ictx->phys_touch));
1974 touch->phys = ictx->phys_touch;
1975
1976 touch->evbit[0] =
1977 BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
1978 touch->keybit[BIT_WORD(BTN_TOUCH)] =
1979 BIT_MASK(BTN_TOUCH);
1980 input_set_abs_params(touch, ABS_X,
1981 0x00, 0xfff, 0, 0);
1982 input_set_abs_params(touch, ABS_Y,
1983 0x00, 0xfff, 0, 0);
1984
1985 input_set_drvdata(touch, ictx);
1986
1987 usb_to_input_id(ictx->usbdev_intf1, &touch->id);
1988 touch->dev.parent = ictx->dev;
1989 ret = input_register_device(touch);
1990 if (ret < 0) {
1991 dev_info(ictx->dev, "touchscreen input dev register failed\n");
1992 goto touch_register_failed;
1993 }
1994
1995 return touch;
1996
1997touch_register_failed:
1998 input_free_device(touch);
1999
2000touch_alloc_failed:
2001 return NULL;
2002}
2003
2004static bool imon_find_endpoints(struct imon_context *ictx,
2005 struct usb_host_interface *iface_desc)
2006{
2007 struct usb_endpoint_descriptor *ep;
2008 struct usb_endpoint_descriptor *rx_endpoint = NULL;
2009 struct usb_endpoint_descriptor *tx_endpoint = NULL;
2010 int ifnum = iface_desc->desc.bInterfaceNumber;
2011 int num_endpts = iface_desc->desc.bNumEndpoints;
2012 int i, ep_dir, ep_type;
2013 bool ir_ep_found = false;
2014 bool display_ep_found = false;
2015 bool tx_control = false;
2016
2017 /*
2018 * Scan the endpoint list and set:
2019 * first input endpoint = IR endpoint
2020 * first output endpoint = display endpoint
2021 */
2022 for (i = 0; i < num_endpts && !(ir_ep_found && display_ep_found); ++i) {
2023 ep = &iface_desc->endpoint[i].desc;
2024 ep_dir = ep->bEndpointAddress & USB_ENDPOINT_DIR_MASK;
2025 ep_type = ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
2026
2027 if (!ir_ep_found && ep_dir == USB_DIR_IN &&
2028 ep_type == USB_ENDPOINT_XFER_INT) {
2029
2030 rx_endpoint = ep;
2031 ir_ep_found = true;
2032 dev_dbg(ictx->dev, "%s: found IR endpoint\n", __func__);
2033
2034 } else if (!display_ep_found && ep_dir == USB_DIR_OUT &&
2035 ep_type == USB_ENDPOINT_XFER_INT) {
2036 tx_endpoint = ep;
2037 display_ep_found = true;
2038 dev_dbg(ictx->dev, "%s: found display endpoint\n", __func__);
2039 }
2040 }
2041
2042 if (ifnum == 0) {
2043 ictx->rx_endpoint_intf0 = rx_endpoint;
2044 /*
2045 * tx is used to send characters to lcd/vfd, associate RF
2046 * remotes, set IR protocol, and maybe more...
2047 */
2048 ictx->tx_endpoint = tx_endpoint;
2049 } else {
2050 ictx->rx_endpoint_intf1 = rx_endpoint;
2051 }
2052
2053 /*
2054 * If we didn't find a display endpoint, this is probably one of the
2055 * newer iMON devices that use control urb instead of interrupt
2056 */
2057 if (!display_ep_found) {
2058 tx_control = true;
2059 display_ep_found = true;
2060 dev_dbg(ictx->dev, "%s: device uses control endpoint, not "
2061 "interface OUT endpoint\n", __func__);
2062 }
2063
2064 /*
2065 * Some iMON receivers have no display. Unfortunately, it seems
2066 * that SoundGraph recycles device IDs between devices both with
2067 * and without... :\
2068 */
2069 if (ictx->display_type == IMON_DISPLAY_TYPE_NONE) {
2070 display_ep_found = false;
2071 dev_dbg(ictx->dev, "%s: device has no display\n", __func__);
2072 }
2073
2074 /*
2075 * iMON Touch devices have a VGA touchscreen, but no "display", as
2076 * that refers to e.g. /dev/lcd0 (a character device LCD or VFD).
2077 */
2078 if (ictx->display_type == IMON_DISPLAY_TYPE_VGA) {
2079 display_ep_found = false;
2080 dev_dbg(ictx->dev, "%s: iMON Touch device found\n", __func__);
2081 }
2082
2083 /* Input endpoint is mandatory */
2084 if (!ir_ep_found)
2085 pr_err("no valid input (IR) endpoint found\n");
2086
2087 ictx->tx_control = tx_control;
2088
2089 if (display_ep_found)
2090 ictx->display_supported = true;
2091
2092 return ir_ep_found;
2093
2094}
2095
2096static struct imon_context *imon_init_intf0(struct usb_interface *intf)
2097{
2098 struct imon_context *ictx;
2099 struct urb *rx_urb;
2100 struct urb *tx_urb;
2101 struct device *dev = &intf->dev;
2102 struct usb_host_interface *iface_desc;
2103 int ret = -ENOMEM;
2104
2105 ictx = kzalloc(sizeof(struct imon_context), GFP_KERNEL);
2106 if (!ictx) {
2107 dev_err(dev, "%s: kzalloc failed for context", __func__);
2108 goto exit;
2109 }
2110 rx_urb = usb_alloc_urb(0, GFP_KERNEL);
2111 if (!rx_urb) {
2112 dev_err(dev, "%s: usb_alloc_urb failed for IR urb", __func__);
2113 goto rx_urb_alloc_failed;
2114 }
2115 tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2116 if (!tx_urb) {
2117 dev_err(dev, "%s: usb_alloc_urb failed for display urb",
2118 __func__);
2119 goto tx_urb_alloc_failed;
2120 }
2121
2122 mutex_init(&ictx->lock);
2123 spin_lock_init(&ictx->kc_lock);
2124
2125 mutex_lock(&ictx->lock);
2126
2127 ictx->dev = dev;
2128 ictx->usbdev_intf0 = usb_get_dev(interface_to_usbdev(intf));
2129 ictx->rx_urb_intf0 = rx_urb;
2130 ictx->tx_urb = tx_urb;
2131 ictx->rf_device = false;
2132
2133 ictx->vendor = le16_to_cpu(ictx->usbdev_intf0->descriptor.idVendor);
2134 ictx->product = le16_to_cpu(ictx->usbdev_intf0->descriptor.idProduct);
2135
2136 ret = -ENODEV;
2137 iface_desc = intf->cur_altsetting;
2138 if (!imon_find_endpoints(ictx, iface_desc)) {
2139 goto find_endpoint_failed;
2140 }
2141
2142 usb_fill_int_urb(ictx->rx_urb_intf0, ictx->usbdev_intf0,
2143 usb_rcvintpipe(ictx->usbdev_intf0,
2144 ictx->rx_endpoint_intf0->bEndpointAddress),
2145 ictx->usb_rx_buf, sizeof(ictx->usb_rx_buf),
2146 usb_rx_callback_intf0, ictx,
2147 ictx->rx_endpoint_intf0->bInterval);
2148
2149 ret = usb_submit_urb(ictx->rx_urb_intf0, GFP_KERNEL);
2150 if (ret) {
2151 pr_err("usb_submit_urb failed for intf0 (%d)\n", ret);
2152 goto urb_submit_failed;
2153 }
2154
2155 ictx->idev = imon_init_idev(ictx);
2156 if (!ictx->idev) {
2157 dev_err(dev, "%s: input device setup failed\n", __func__);
2158 goto idev_setup_failed;
2159 }
2160
2161 ictx->rdev = imon_init_rdev(ictx);
2162 if (!ictx->rdev) {
2163 dev_err(dev, "%s: rc device setup failed\n", __func__);
2164 goto rdev_setup_failed;
2165 }
2166
2167 ictx->dev_present_intf0 = true;
2168
2169 mutex_unlock(&ictx->lock);
2170 return ictx;
2171
2172rdev_setup_failed:
2173 input_unregister_device(ictx->idev);
2174idev_setup_failed:
2175 usb_kill_urb(ictx->rx_urb_intf0);
2176urb_submit_failed:
2177find_endpoint_failed:
2178 mutex_unlock(&ictx->lock);
2179 usb_free_urb(tx_urb);
2180tx_urb_alloc_failed:
2181 usb_free_urb(rx_urb);
2182rx_urb_alloc_failed:
2183 kfree(ictx);
2184exit:
2185 dev_err(dev, "unable to initialize intf0, err %d\n", ret);
2186
2187 return NULL;
2188}
2189
2190static struct imon_context *imon_init_intf1(struct usb_interface *intf,
2191 struct imon_context *ictx)
2192{
2193 struct urb *rx_urb;
2194 struct usb_host_interface *iface_desc;
2195 int ret = -ENOMEM;
2196
2197 rx_urb = usb_alloc_urb(0, GFP_KERNEL);
2198 if (!rx_urb) {
2199 pr_err("usb_alloc_urb failed for IR urb\n");
2200 goto rx_urb_alloc_failed;
2201 }
2202
2203 mutex_lock(&ictx->lock);
2204
2205 if (ictx->display_type == IMON_DISPLAY_TYPE_VGA) {
2206 init_timer(&ictx->ttimer);
2207 ictx->ttimer.data = (unsigned long)ictx;
2208 ictx->ttimer.function = imon_touch_display_timeout;
2209 }
2210
2211 ictx->usbdev_intf1 = usb_get_dev(interface_to_usbdev(intf));
2212 ictx->rx_urb_intf1 = rx_urb;
2213
2214 ret = -ENODEV;
2215 iface_desc = intf->cur_altsetting;
2216 if (!imon_find_endpoints(ictx, iface_desc))
2217 goto find_endpoint_failed;
2218
2219 if (ictx->display_type == IMON_DISPLAY_TYPE_VGA) {
2220 ictx->touch = imon_init_touch(ictx);
2221 if (!ictx->touch)
2222 goto touch_setup_failed;
2223 } else
2224 ictx->touch = NULL;
2225
2226 usb_fill_int_urb(ictx->rx_urb_intf1, ictx->usbdev_intf1,
2227 usb_rcvintpipe(ictx->usbdev_intf1,
2228 ictx->rx_endpoint_intf1->bEndpointAddress),
2229 ictx->usb_rx_buf, sizeof(ictx->usb_rx_buf),
2230 usb_rx_callback_intf1, ictx,
2231 ictx->rx_endpoint_intf1->bInterval);
2232
2233 ret = usb_submit_urb(ictx->rx_urb_intf1, GFP_KERNEL);
2234
2235 if (ret) {
2236 pr_err("usb_submit_urb failed for intf1 (%d)\n", ret);
2237 goto urb_submit_failed;
2238 }
2239
2240 ictx->dev_present_intf1 = true;
2241
2242 mutex_unlock(&ictx->lock);
2243 return ictx;
2244
2245urb_submit_failed:
2246 if (ictx->touch)
2247 input_unregister_device(ictx->touch);
2248touch_setup_failed:
2249find_endpoint_failed:
2250 mutex_unlock(&ictx->lock);
2251 usb_free_urb(rx_urb);
2252rx_urb_alloc_failed:
2253 dev_err(ictx->dev, "unable to initialize intf1, err %d\n", ret);
2254
2255 return NULL;
2256}
2257
2258static void imon_init_display(struct imon_context *ictx,
2259 struct usb_interface *intf)
2260{
2261 int ret;
2262
2263 dev_dbg(ictx->dev, "Registering iMON display with sysfs\n");
2264
2265 /* set up sysfs entry for built-in clock */
2266 ret = sysfs_create_group(&intf->dev.kobj, &imon_display_attr_group);
2267 if (ret)
2268 dev_err(ictx->dev, "Could not create display sysfs "
2269 "entries(%d)", ret);
2270
2271 if (ictx->display_type == IMON_DISPLAY_TYPE_LCD)
2272 ret = usb_register_dev(intf, &imon_lcd_class);
2273 else
2274 ret = usb_register_dev(intf, &imon_vfd_class);
2275 if (ret)
2276 /* Not a fatal error, so ignore */
2277 dev_info(ictx->dev, "could not get a minor number for "
2278 "display\n");
2279
2280}
2281
2282/**
2283 * Callback function for USB core API: Probe
2284 */
2285static int imon_probe(struct usb_interface *interface,
2286 const struct usb_device_id *id)
2287{
2288 struct usb_device *usbdev = NULL;
2289 struct usb_host_interface *iface_desc = NULL;
2290 struct usb_interface *first_if;
2291 struct device *dev = &interface->dev;
2292 int ifnum, sysfs_err;
2293 int ret = 0;
2294 struct imon_context *ictx = NULL;
2295 struct imon_context *first_if_ctx = NULL;
2296 u16 vendor, product;
2297
2298 usbdev = usb_get_dev(interface_to_usbdev(interface));
2299 iface_desc = interface->cur_altsetting;
2300 ifnum = iface_desc->desc.bInterfaceNumber;
2301 vendor = le16_to_cpu(usbdev->descriptor.idVendor);
2302 product = le16_to_cpu(usbdev->descriptor.idProduct);
2303
2304 dev_dbg(dev, "%s: found iMON device (%04x:%04x, intf%d)\n",
2305 __func__, vendor, product, ifnum);
2306
2307 /* prevent races probing devices w/multiple interfaces */
2308 mutex_lock(&driver_lock);
2309
2310 first_if = usb_ifnum_to_if(usbdev, 0);
2311 first_if_ctx = usb_get_intfdata(first_if);
2312
2313 if (ifnum == 0) {
2314 ictx = imon_init_intf0(interface);
2315 if (!ictx) {
2316 pr_err("failed to initialize context!\n");
2317 ret = -ENODEV;
2318 goto fail;
2319 }
2320
2321 } else {
2322 /* this is the secondary interface on the device */
2323 ictx = imon_init_intf1(interface, first_if_ctx);
2324 if (!ictx) {
2325 pr_err("failed to attach to context!\n");
2326 ret = -ENODEV;
2327 goto fail;
2328 }
2329
2330 }
2331
2332 /* default send_packet delay is 5ms but some devices need more */
2333 ictx->send_packet_delay = id->driver_info & IMON_NEED_20MS_PKT_DELAY ?
2334 20 : 5;
2335
2336 usb_set_intfdata(interface, ictx);
2337
2338 if (ifnum == 0) {
2339 mutex_lock(&ictx->lock);
2340
2341 if (product == 0xffdc && ictx->rf_device) {
2342 sysfs_err = sysfs_create_group(&interface->dev.kobj,
2343 &imon_rf_attr_group);
2344 if (sysfs_err)
2345 pr_err("Could not create RF sysfs entries(%d)\n",
2346 sysfs_err);
2347 }
2348
2349 if (ictx->display_supported)
2350 imon_init_display(ictx, interface);
2351
2352 mutex_unlock(&ictx->lock);
2353 }
2354
2355 dev_info(dev, "iMON device (%04x:%04x, intf%d) on "
2356 "usb<%d:%d> initialized\n", vendor, product, ifnum,
2357 usbdev->bus->busnum, usbdev->devnum);
2358
2359 mutex_unlock(&driver_lock);
2360
2361 return 0;
2362
2363fail:
2364 mutex_unlock(&driver_lock);
2365 dev_err(dev, "unable to register, err %d\n", ret);
2366
2367 return ret;
2368}
2369
2370/**
2371 * Callback function for USB core API: disconnect
2372 */
2373static void imon_disconnect(struct usb_interface *interface)
2374{
2375 struct imon_context *ictx;
2376 struct device *dev;
2377 int ifnum;
2378
2379 /* prevent races with multi-interface device probing and display_open */
2380 mutex_lock(&driver_lock);
2381
2382 ictx = usb_get_intfdata(interface);
2383 dev = ictx->dev;
2384 ifnum = interface->cur_altsetting->desc.bInterfaceNumber;
2385
2386 /*
2387 * sysfs_remove_group is safe to call even if sysfs_create_group
2388 * hasn't been called
2389 */
2390 sysfs_remove_group(&interface->dev.kobj, &imon_display_attr_group);
2391 sysfs_remove_group(&interface->dev.kobj, &imon_rf_attr_group);
2392
2393 usb_set_intfdata(interface, NULL);
2394
2395 /* Abort ongoing write */
2396 if (ictx->tx.busy) {
2397 usb_kill_urb(ictx->tx_urb);
2398 complete_all(&ictx->tx.finished);
2399 }
2400
2401 if (ifnum == 0) {
2402 ictx->dev_present_intf0 = false;
2403 usb_kill_urb(ictx->rx_urb_intf0);
2404 input_unregister_device(ictx->idev);
2405 rc_unregister_device(ictx->rdev);
2406 if (ictx->display_supported) {
2407 if (ictx->display_type == IMON_DISPLAY_TYPE_LCD)
2408 usb_deregister_dev(interface, &imon_lcd_class);
2409 else if (ictx->display_type == IMON_DISPLAY_TYPE_VFD)
2410 usb_deregister_dev(interface, &imon_vfd_class);
2411 }
2412 } else {
2413 ictx->dev_present_intf1 = false;
2414 usb_kill_urb(ictx->rx_urb_intf1);
2415 if (ictx->display_type == IMON_DISPLAY_TYPE_VGA) {
2416 input_unregister_device(ictx->touch);
2417 del_timer_sync(&ictx->ttimer);
2418 }
2419 }
2420
2421 if (!ictx->dev_present_intf0 && !ictx->dev_present_intf1)
2422 free_imon_context(ictx);
2423
2424 mutex_unlock(&driver_lock);
2425
2426 dev_dbg(dev, "%s: iMON device (intf%d) disconnected\n",
2427 __func__, ifnum);
2428}
2429
2430static int imon_suspend(struct usb_interface *intf, pm_message_t message)
2431{
2432 struct imon_context *ictx = usb_get_intfdata(intf);
2433 int ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
2434
2435 if (ifnum == 0)
2436 usb_kill_urb(ictx->rx_urb_intf0);
2437 else
2438 usb_kill_urb(ictx->rx_urb_intf1);
2439
2440 return 0;
2441}
2442
2443static int imon_resume(struct usb_interface *intf)
2444{
2445 int rc = 0;
2446 struct imon_context *ictx = usb_get_intfdata(intf);
2447 int ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
2448
2449 if (ifnum == 0) {
2450 usb_fill_int_urb(ictx->rx_urb_intf0, ictx->usbdev_intf0,
2451 usb_rcvintpipe(ictx->usbdev_intf0,
2452 ictx->rx_endpoint_intf0->bEndpointAddress),
2453 ictx->usb_rx_buf, sizeof(ictx->usb_rx_buf),
2454 usb_rx_callback_intf0, ictx,
2455 ictx->rx_endpoint_intf0->bInterval);
2456
2457 rc = usb_submit_urb(ictx->rx_urb_intf0, GFP_ATOMIC);
2458
2459 } else {
2460 usb_fill_int_urb(ictx->rx_urb_intf1, ictx->usbdev_intf1,
2461 usb_rcvintpipe(ictx->usbdev_intf1,
2462 ictx->rx_endpoint_intf1->bEndpointAddress),
2463 ictx->usb_rx_buf, sizeof(ictx->usb_rx_buf),
2464 usb_rx_callback_intf1, ictx,
2465 ictx->rx_endpoint_intf1->bInterval);
2466
2467 rc = usb_submit_urb(ictx->rx_urb_intf1, GFP_ATOMIC);
2468 }
2469
2470 return rc;
2471}
2472
2473module_usb_driver(imon_driver);