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