drivers/media/rc/imon.c

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