drivers/staging/media/lirc/lirc_imon.c

   1 /*
   2  *   lirc_imon.c:  LIRC/VFD/LCD driver for SoundGraph iMON IR/VFD/LCD
   3  *                 including the iMON PAD model
   4  *
   5  *   Copyright(C) 2004  Venky Raju(dev@venky.ws)
   6  *   Copyright(C) 2009  Jarod Wilson <jarod@wilsonet.com>
   7  *
   8  *   lirc_imon is free software; you can redistribute it and/or modify
   9  *   it under the terms of the GNU General Public License as published by
  10  *   the Free Software Foundation; either version 2 of the License, or
  11  *   (at your option) any later version.
  12  *
  13  *   This program is distributed in the hope that it will be useful,
  14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *   GNU General Public License for more details.
  17  *
  18  *   You should have received a copy of the GNU General Public License
  19  *   along with this program; if not, write to the Free Software
  20  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21  */
  22
  23 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  24
  25 #include <linux/errno.h>
  26 #include <linux/kernel.h>
  27 #include <linux/module.h>
  28 #include <linux/slab.h>
  29 #include <linux/uaccess.h>
  30 #include <linux/usb.h>
  31
  32 #include <media/lirc.h>
  33 #include <media/lirc_dev.h>
  34
  35
  36 #define MOD_AUTHOR      "Venky Raju <dev@venky.ws>"
  37 #define MOD_DESC        "Driver for SoundGraph iMON MultiMedia IR/Display"
  38 #define MOD_NAME        "lirc_imon"
  39 #define MOD_VERSION     "0.8"
  40
  41 #define DISPLAY_MINOR_BASE      144
  42 #define DEVICE_NAME     "lcd%d"
  43
  44 #define BUF_CHUNK_SIZE  4
  45 #define BUF_SIZE        128
  46
  47 #define BIT_DURATION    250     /* each bit received is 250us */
  48
  49 /*** P R O T O T Y P E S ***/
  50
  51 /* USB Callback prototypes */
  52 static int imon_probe(struct usb_interface *interface,
  53                       const struct usb_device_id *id);
  54 static void imon_disconnect(struct usb_interface *interface);
  55 static void usb_rx_callback(struct urb *urb);
  56 static void usb_tx_callback(struct urb *urb);
  57
  58 /* suspend/resume support */
  59 static int imon_resume(struct usb_interface *intf);
  60 static int imon_suspend(struct usb_interface *intf, pm_message_t message);
  61
  62 /* Display file_operations function prototypes */
  63 static int display_open(struct inode *inode, struct file *file);
  64 static int display_close(struct inode *inode, struct file *file);
  65
  66 /* VFD write operation */
  67 static ssize_t vfd_write(struct file *file, const char __user *buf,
  68                          size_t n_bytes, loff_t *pos);
  69
  70 /* LIRC driver function prototypes */
  71 static int ir_open(void *data);
  72 static void ir_close(void *data);
  73
  74 /*** G L O B A L S ***/
  75 #define IMON_DATA_BUF_SZ        35
  76
  77 struct imon_context {
  78         struct usb_device *usbdev;
  79         /* Newer devices have two interfaces */
  80         int display;                    /* not all controllers do */
  81         int display_isopen;             /* display port has been opened */
  82         int ir_isopen;                  /* IR port open */
  83         int dev_present;                /* USB device presence */
  84         struct mutex ctx_lock;          /* to lock this object */
  85         wait_queue_head_t remove_ok;    /* For unexpected USB disconnects */
  86
  87         int vfd_proto_6p;               /* some VFD require a 6th packet */
  88
  89         struct lirc_driver *driver;
  90         struct usb_endpoint_descriptor *rx_endpoint;
  91         struct usb_endpoint_descriptor *tx_endpoint;
  92         struct urb *rx_urb;
  93         struct urb *tx_urb;
  94         unsigned char usb_rx_buf[8];
  95         unsigned char usb_tx_buf[8];
  96
  97         struct rx_data {
  98                 int count;              /* length of 0 or 1 sequence */
  99                 int prev_bit;           /* logic level of sequence */
 100                 int initial_space;      /* initial space flag */
 101         } rx;
 102
 103         struct tx_t {
 104                 unsigned char data_buf[IMON_DATA_BUF_SZ]; /* user data buffer */
 105                 struct completion finished;     /* wait for write to finish */
 106                 atomic_t busy;                  /* write in progress */
 107                 int status;                     /* status of tx completion */
 108         } tx;
 109 };
 110
 111 static const struct file_operations display_fops = {
 112         .owner          = THIS_MODULE,
 113         .open           = &display_open,
 114         .write          = &vfd_write,
 115         .release        = &display_close,
 116         .llseek         = noop_llseek,
 117 };
 118
 119 /*
 120  * USB Device ID for iMON USB Control Boards
 121  *
 122  * The Windows drivers contain 6 different inf files, more or less one for
 123  * each new device until the 0x0034-0x0046 devices, which all use the same
 124  * driver. Some of the devices in the 34-46 range haven't been definitively
 125  * identified yet. Early devices have either a TriGem Computer, Inc. or a
 126  * Samsung vendor ID (0x0aa8 and 0x04e8 respectively), while all later
 127  * devices use the SoundGraph vendor ID (0x15c2).
 128  */
 129 static struct usb_device_id imon_usb_id_table[] = {
 130         /* TriGem iMON (IR only) -- TG_iMON.inf */
 131         { USB_DEVICE(0x0aa8, 0x8001) },
 132
 133         /* SoundGraph iMON (IR only) -- sg_imon.inf */
 134         { USB_DEVICE(0x04e8, 0xff30) },
 135
 136         /* SoundGraph iMON VFD (IR & VFD) -- iMON_VFD.inf */
 137         { USB_DEVICE(0x0aa8, 0xffda) },
 138
 139         /* SoundGraph iMON SS (IR & VFD) -- iMON_SS.inf */
 140         { USB_DEVICE(0x15c2, 0xffda) },
 141
 142         {}
 143 };
 144
 145 /* Some iMON VFD models requires a 6th packet for VFD writes */
 146 static struct usb_device_id vfd_proto_6p_list[] = {
 147         { USB_DEVICE(0x15c2, 0xffda) },
 148         {}
 149 };
 150
 151 /* Some iMON devices have no lcd/vfd, don't set one up */
 152 static struct usb_device_id ir_only_list[] = {
 153         { USB_DEVICE(0x0aa8, 0x8001) },
 154         { USB_DEVICE(0x04e8, 0xff30) },
 155         {}
 156 };
 157
 158 /* USB Device data */
 159 static struct usb_driver imon_driver = {
 160         .name           = MOD_NAME,
 161         .probe          = imon_probe,
 162         .disconnect     = imon_disconnect,
 163         .suspend        = imon_suspend,
 164         .resume         = imon_resume,
 165         .id_table       = imon_usb_id_table,
 166 };
 167
 168 static struct usb_class_driver imon_class = {
 169         .name           = DEVICE_NAME,
 170         .fops           = &display_fops,
 171         .minor_base     = DISPLAY_MINOR_BASE,
 172 };
 173
 174 /* to prevent races between open() and disconnect(), probing, etc */
 175 static DEFINE_MUTEX(driver_lock);
 176
 177 static int debug;
 178
 179 /***  M O D U L E   C O D E ***/
 180
 181 MODULE_AUTHOR(MOD_AUTHOR);
 182 MODULE_DESCRIPTION(MOD_DESC);
 183 MODULE_VERSION(MOD_VERSION);
 184 MODULE_LICENSE("GPL");
 185 MODULE_DEVICE_TABLE(usb, imon_usb_id_table);
 186 module_param(debug, int, S_IRUGO | S_IWUSR);
 187 MODULE_PARM_DESC(debug, "Debug messages: 0=no, 1=yes(default: no)");
 188
 189 static void free_imon_context(struct imon_context *context)
 190 {
 191         struct device *dev = context->driver->dev;
 192
 193         usb_free_urb(context->tx_urb);
 194         usb_free_urb(context->rx_urb);
 195         lirc_buffer_free(context->driver->rbuf);
 196         kfree(context->driver->rbuf);
 197         kfree(context->driver);
 198         kfree(context);
 199
 200         dev_dbg(dev, "%s: iMON context freed\n", __func__);
 201 }
 202
 203 static void deregister_from_lirc(struct imon_context *context)
 204 {
 205         int retval;
 206         int minor = context->driver->minor;
 207
 208         retval = lirc_unregister_driver(minor);
 209         if (retval)
 210                 dev_err(&context->usbdev->dev,
 211                         ": %s: unable to deregister from lirc(%d)",
 212                         __func__, retval);
 213         else
 214                 dev_info(&context->usbdev->dev,
 215                          "Deregistered iMON driver (minor:%d)\n", minor);
 216
 217 }
 218
 219 /**
 220  * Called when the Display device (e.g. /dev/lcd0)
 221  * is opened by the application.
 222  */
 223 static int display_open(struct inode *inode, struct file *file)
 224 {
 225         struct usb_interface *interface;
 226         struct imon_context *context = NULL;
 227         int subminor;
 228         int retval = 0;
 229
 230         /* prevent races with disconnect */
 231         mutex_lock(&driver_lock);
 232
 233         subminor = iminor(inode);
 234         interface = usb_find_interface(&imon_driver, subminor);
 235         if (!interface) {
 236                 pr_err("%s: could not find interface for minor %d\n",
 237                        __func__, subminor);
 238                 retval = -ENODEV;
 239                 goto exit;
 240         }
 241         context = usb_get_intfdata(interface);
 242
 243         if (!context) {
 244                 dev_err(&interface->dev,
 245                         "%s: no context found for minor %d\n",
 246                         __func__, subminor);
 247                 retval = -ENODEV;
 248                 goto exit;
 249         }
 250
 251         mutex_lock(&context->ctx_lock);
 252
 253         if (!context->display) {
 254                 dev_err(&interface->dev,
 255                         "%s: display not supported by device\n", __func__);
 256                 retval = -ENODEV;
 257         } else if (context->display_isopen) {
 258                 dev_err(&interface->dev,
 259                         "%s: display port is already open\n", __func__);
 260                 retval = -EBUSY;
 261         } else {
 262                 context->display_isopen = 1;
 263                 file->private_data = context;
 264                 dev_info(context->driver->dev, "display port opened\n");
 265         }
 266
 267         mutex_unlock(&context->ctx_lock);
 268
 269 exit:
 270         mutex_unlock(&driver_lock);
 271         return retval;
 272 }
 273
 274 /**
 275  * Called when the display device (e.g. /dev/lcd0)
 276  * is closed by the application.
 277  */
 278 static int display_close(struct inode *inode, struct file *file)
 279 {
 280         struct imon_context *context = NULL;
 281         int retval = 0;
 282
 283         context = file->private_data;
 284
 285         if (!context) {
 286                 pr_err("%s: no context for device\n", __func__);
 287                 return -ENODEV;
 288         }
 289
 290         mutex_lock(&context->ctx_lock);
 291
 292         if (!context->display) {
 293                 dev_err(&context->usbdev->dev,
 294                         "%s: display not supported by device\n", __func__);
 295                 retval = -ENODEV;
 296         } else if (!context->display_isopen) {
 297                 dev_err(&context->usbdev->dev,
 298                         "%s: display is not open\n", __func__);
 299                 retval = -EIO;
 300         } else {
 301                 context->display_isopen = 0;
 302                 dev_info(context->driver->dev, "display port closed\n");
 303                 if (!context->dev_present && !context->ir_isopen) {
 304                         /*
 305                          * Device disconnected before close and IR port is not
 306                          * open. If IR port is open, context will be deleted by
 307                          * ir_close.
 308                          */
 309                         mutex_unlock(&context->ctx_lock);
 310                         free_imon_context(context);
 311                         return retval;
 312                 }
 313         }
 314
 315         mutex_unlock(&context->ctx_lock);
 316         return retval;
 317 }
 318
 319 /**
 320  * Sends a packet to the device -- this function must be called
 321  * with context->ctx_lock held.
 322  */
 323 static int send_packet(struct imon_context *context)
 324 {
 325         unsigned int pipe;
 326         int interval = 0;
 327         int retval = 0;
 328
 329         /* Check if we need to use control or interrupt urb */
 330         pipe = usb_sndintpipe(context->usbdev,
 331                               context->tx_endpoint->bEndpointAddress);
 332         interval = context->tx_endpoint->bInterval;
 333
 334         usb_fill_int_urb(context->tx_urb, context->usbdev, pipe,
 335                          context->usb_tx_buf,
 336                          sizeof(context->usb_tx_buf),
 337                          usb_tx_callback, context, interval);
 338
 339         context->tx_urb->actual_length = 0;
 340
 341         init_completion(&context->tx.finished);
 342         atomic_set(&(context->tx.busy), 1);
 343
 344         retval = usb_submit_urb(context->tx_urb, GFP_KERNEL);
 345         if (retval) {
 346                 atomic_set(&(context->tx.busy), 0);
 347                 dev_err(&context->usbdev->dev,
 348                         "%s: error submitting urb(%d)\n", __func__, retval);
 349         } else {
 350                 /* Wait for transmission to complete (or abort) */
 351                 mutex_unlock(&context->ctx_lock);
 352                 retval = wait_for_completion_interruptible(
 353                                 &context->tx.finished);
 354                 if (retval)
 355                         dev_err(&context->usbdev->dev,
 356                                 "%s: task interrupted\n", __func__);
 357                 mutex_lock(&context->ctx_lock);
 358
 359                 retval = context->tx.status;
 360                 if (retval)
 361                         dev_err(&context->usbdev->dev,
 362                                 "%s: packet tx failed (%d)\n",
 363                                 __func__, retval);
 364         }
 365
 366         return retval;
 367 }
 368
 369 /**
 370  * Writes data to the VFD.  The iMON VFD is 2x16 characters
 371  * and requires data in 5 consecutive USB interrupt packets,
 372  * each packet but the last carrying 7 bytes.
 373  *
 374  * I don't know if the VFD board supports features such as
 375  * scrolling, clearing rows, blanking, etc. so at
 376  * the caller must provide a full screen of data.  If fewer
 377  * than 32 bytes are provided spaces will be appended to
 378  * generate a full screen.
 379  */
 380 static ssize_t vfd_write(struct file *file, const char __user *buf,
 381                          size_t n_bytes, loff_t *pos)
 382 {
 383         int i;
 384         int offset;
 385         int seq;
 386         int retval = 0;
 387         struct imon_context *context;
 388         const unsigned char vfd_packet6[] = {
 389                 0x01, 0x00, 0x00, 0x00, 0x00, 0xFF, 0xFF };
 390         int *data_buf = NULL;
 391
 392         context = file->private_data;
 393         if (!context) {
 394                 pr_err("%s: no context for device\n", __func__);
 395                 return -ENODEV;
 396         }
 397
 398         mutex_lock(&context->ctx_lock);
 399
 400         if (!context->dev_present) {
 401                 dev_err(&context->usbdev->dev,
 402                         "%s: no iMON device present\n", __func__);
 403                 retval = -ENODEV;
 404                 goto exit;
 405         }
 406
 407         if (n_bytes <= 0 || n_bytes > IMON_DATA_BUF_SZ - 3) {
 408                 dev_err(&context->usbdev->dev,
 409                         "%s: invalid payload size\n", __func__);
 410                 retval = -EINVAL;
 411                 goto exit;
 412         }
 413
 414         data_buf = memdup_user(buf, n_bytes);
 415         if (IS_ERR(data_buf)) {
 416                 retval = PTR_ERR(data_buf);
 417                 goto exit;
 418         }
 419
 420         memcpy(context->tx.data_buf, data_buf, n_bytes);
 421
 422         /* Pad with spaces */
 423         for (i = n_bytes; i < IMON_DATA_BUF_SZ - 3; ++i)
 424                 context->tx.data_buf[i] = ' ';
 425
 426         for (i = IMON_DATA_BUF_SZ - 3; i < IMON_DATA_BUF_SZ; ++i)
 427                 context->tx.data_buf[i] = 0xFF;
 428
 429         offset = 0;
 430         seq = 0;
 431
 432         do {
 433                 memcpy(context->usb_tx_buf, context->tx.data_buf + offset, 7);
 434                 context->usb_tx_buf[7] = (unsigned char) seq;
 435
 436                 retval = send_packet(context);
 437                 if (retval) {
 438                         dev_err(&context->usbdev->dev,
 439                                 "%s: send packet failed for packet #%d\n",
 440                                 __func__, seq/2);
 441                         goto exit;
 442                 } else {
 443                         seq += 2;
 444                         offset += 7;
 445                 }
 446
 447         } while (offset < IMON_DATA_BUF_SZ);
 448
 449         if (context->vfd_proto_6p) {
 450                 /* Send packet #6 */
 451                 memcpy(context->usb_tx_buf, &vfd_packet6, sizeof(vfd_packet6));
 452                 context->usb_tx_buf[7] = (unsigned char) seq;
 453                 retval = send_packet(context);
 454                 if (retval)
 455                         dev_err(&context->usbdev->dev,
 456                                 "%s: send packet failed for packet #%d\n",
 457                                         __func__, seq/2);
 458         }
 459
 460 exit:
 461         mutex_unlock(&context->ctx_lock);
 462         kfree(data_buf);
 463
 464         return (!retval) ? n_bytes : retval;
 465 }
 466
 467 /**
 468  * Callback function for USB core API: transmit data
 469  */
 470 static void usb_tx_callback(struct urb *urb)
 471 {
 472         struct imon_context *context;
 473
 474         if (!urb)
 475                 return;
 476         context = (struct imon_context *)urb->context;
 477         if (!context)
 478                 return;
 479
 480         context->tx.status = urb->status;
 481
 482         /* notify waiters that write has finished */
 483         atomic_set(&context->tx.busy, 0);
 484         complete(&context->tx.finished);
 485 }
 486
 487 /**
 488  * Called by lirc_dev when the application opens /dev/lirc
 489  */
 490 static int ir_open(void *data)
 491 {
 492         struct imon_context *context;
 493
 494         /* prevent races with disconnect */
 495         mutex_lock(&driver_lock);
 496
 497         context = (struct imon_context *)data;
 498
 499         /* initial IR protocol decode variables */
 500         context->rx.count = 0;
 501         context->rx.initial_space = 1;
 502         context->rx.prev_bit = 0;
 503
 504         context->ir_isopen = 1;
 505         dev_info(context->driver->dev, "IR port opened\n");
 506
 507         mutex_unlock(&driver_lock);
 508         return 0;
 509 }
 510
 511 /**
 512  * Called by lirc_dev when the application closes /dev/lirc
 513  */
 514 static void ir_close(void *data)
 515 {
 516         struct imon_context *context;
 517
 518         context = (struct imon_context *)data;
 519         if (!context) {
 520                 pr_err("%s: no context for device\n", __func__);
 521                 return;
 522         }
 523
 524         mutex_lock(&context->ctx_lock);
 525
 526         context->ir_isopen = 0;
 527         dev_info(context->driver->dev, "IR port closed\n");
 528
 529         if (!context->dev_present) {
 530                 /*
 531                  * Device disconnected while IR port was still open. Driver
 532                  * was not deregistered at disconnect time, so do it now.
 533                  */
 534                 deregister_from_lirc(context);
 535
 536                 if (!context->display_isopen) {
 537                         mutex_unlock(&context->ctx_lock);
 538                         free_imon_context(context);
 539                         return;
 540                 }
 541                 /*
 542                  * If display port is open, context will be deleted by
 543                  * display_close
 544                  */
 545         }
 546
 547         mutex_unlock(&context->ctx_lock);
 548 }
 549
 550 /**
 551  * Convert bit count to time duration (in us) and submit
 552  * the value to lirc_dev.
 553  */
 554 static void submit_data(struct imon_context *context)
 555 {
 556         unsigned char buf[4];
 557         int value = context->rx.count;
 558         int i;
 559
 560         dev_dbg(context->driver->dev, "submitting data to LIRC\n");
 561
 562         value *= BIT_DURATION;
 563         value &= PULSE_MASK;
 564         if (context->rx.prev_bit)
 565                 value |= PULSE_BIT;
 566
 567         for (i = 0; i < 4; ++i)
 568                 buf[i] = value>>(i*8);
 569
 570         lirc_buffer_write(context->driver->rbuf, buf);
 571         wake_up(&context->driver->rbuf->wait_poll);
 572 }
 573
 574 static inline int tv2int(const struct timeval *a, const struct timeval *b)
 575 {
 576         int usecs = 0;
 577         int sec   = 0;
 578
 579         if (b->tv_usec > a->tv_usec) {
 580                 usecs = 1000000;
 581                 sec--;
 582         }
 583
 584         usecs += a->tv_usec - b->tv_usec;
 585
 586         sec += a->tv_sec - b->tv_sec;
 587         sec *= 1000;
 588         usecs /= 1000;
 589         sec += usecs;
 590
 591         if (sec < 0)
 592                 sec = 1000;
 593
 594         return sec;
 595 }
 596
 597 /**
 598  * Process the incoming packet
 599  */
 600 static void imon_incoming_packet(struct imon_context *context,
 601                                  struct urb *urb, int intf)
 602 {
 603         int len = urb->actual_length;
 604         unsigned char *buf = urb->transfer_buffer;
 605         struct device *dev = context->driver->dev;
 606         int octet, bit;
 607         unsigned char mask;
 608         int i;
 609
 610         /*
 611          * just bail out if no listening IR client
 612          */
 613         if (!context->ir_isopen)
 614                 return;
 615
 616         if (len != 8) {
 617                 dev_warn(dev, "imon %s: invalid incoming packet size (len = %d, intf%d)\n",
 618                         __func__, len, intf);
 619                 return;
 620         }
 621
 622         if (debug) {
 623                 dev_info(dev, "raw packet: ");
 624                 for (i = 0; i < len; ++i)
 625                         printk("%02x ", buf[i]);
 626                 printk("\n");
 627         }
 628
 629         /*
 630          * Translate received data to pulse and space lengths.
 631          * Received data is active low, i.e. pulses are 0 and
 632          * spaces are 1.
 633          *
 634          * My original algorithm was essentially similar to
 635          * Changwoo Ryu's with the exception that he switched
 636          * the incoming bits to active high and also fed an
 637          * initial space to LIRC at the start of a new sequence
 638          * if the previous bit was a pulse.
 639          *
 640          * I've decided to adopt his algorithm.
 641          */
 642
 643         if (buf[7] == 1 && context->rx.initial_space) {
 644                 /* LIRC requires a leading space */
 645                 context->rx.prev_bit = 0;
 646                 context->rx.count = 4;
 647                 submit_data(context);
 648                 context->rx.count = 0;
 649         }
 650
 651         for (octet = 0; octet < 5; ++octet) {
 652                 mask = 0x80;
 653                 for (bit = 0; bit < 8; ++bit) {
 654                         int curr_bit = !(buf[octet] & mask);
 655
 656                         if (curr_bit != context->rx.prev_bit) {
 657                                 if (context->rx.count) {
 658                                         submit_data(context);
 659                                         context->rx.count = 0;
 660                                 }
 661                                 context->rx.prev_bit = curr_bit;
 662                         }
 663                         ++context->rx.count;
 664                         mask >>= 1;
 665                 }
 666         }
 667
 668         if (buf[7] == 10) {
 669                 if (context->rx.count) {
 670                         submit_data(context);
 671                         context->rx.count = 0;
 672                 }
 673                 context->rx.initial_space = context->rx.prev_bit;
 674         }
 675 }
 676
 677 /**
 678  * Callback function for USB core API: receive data
 679  */
 680 static void usb_rx_callback(struct urb *urb)
 681 {
 682         struct imon_context *context;
 683         int intfnum = 0;
 684
 685         if (!urb)
 686                 return;
 687
 688         context = (struct imon_context *)urb->context;
 689         if (!context)
 690                 return;
 691
 692         switch (urb->status) {
 693         case -ENOENT:           /* usbcore unlink successful! */
 694                 return;
 695
 696         case 0:
 697                 imon_incoming_packet(context, urb, intfnum);
 698                 break;
 699
 700         default:
 701                 dev_warn(context->driver->dev, "imon %s: status(%d): ignored\n",
 702                          __func__, urb->status);
 703                 break;
 704         }
 705
 706         usb_submit_urb(context->rx_urb, GFP_ATOMIC);
 707 }
 708
 709 /**
 710  * Callback function for USB core API: Probe
 711  */
 712 static int imon_probe(struct usb_interface *interface,
 713                       const struct usb_device_id *id)
 714 {
 715         struct usb_device *usbdev = NULL;
 716         struct usb_host_interface *iface_desc = NULL;
 717         struct usb_endpoint_descriptor *rx_endpoint = NULL;
 718         struct usb_endpoint_descriptor *tx_endpoint = NULL;
 719         struct urb *rx_urb = NULL;
 720         struct urb *tx_urb = NULL;
 721         struct lirc_driver *driver = NULL;
 722         struct lirc_buffer *rbuf = NULL;
 723         struct device *dev = &interface->dev;
 724         int ifnum;
 725         int lirc_minor = 0;
 726         int num_endpts;
 727         int retval = 0;
 728         int display_ep_found = 0;
 729         int ir_ep_found = 0;
 730         int alloc_status = 0;
 731         int vfd_proto_6p = 0;
 732         struct imon_context *context = NULL;
 733         int i;
 734         u16 vendor, product;
 735
 736         /* prevent races probing devices w/multiple interfaces */
 737         mutex_lock(&driver_lock);
 738
 739         context = kzalloc(sizeof(struct imon_context), GFP_KERNEL);
 740         if (!context) {
 741                 alloc_status = 1;
 742                 goto alloc_status_switch;
 743         }
 744
 745         /*
 746          * Try to auto-detect the type of display if the user hasn't set
 747          * it by hand via the display_type modparam. Default is VFD.
 748          */
 749         if (usb_match_id(interface, ir_only_list))
 750                 context->display = 0;
 751         else
 752                 context->display = 1;
 753
 754         usbdev     = usb_get_dev(interface_to_usbdev(interface));
 755         iface_desc = interface->cur_altsetting;
 756         num_endpts = iface_desc->desc.bNumEndpoints;
 757         ifnum      = iface_desc->desc.bInterfaceNumber;
 758         vendor     = le16_to_cpu(usbdev->descriptor.idVendor);
 759         product    = le16_to_cpu(usbdev->descriptor.idProduct);
 760
 761         dev_dbg(dev, "%s: found iMON device (%04x:%04x, intf%d)\n",
 762                 __func__, vendor, product, ifnum);
 763
 764         /*
 765          * Scan the endpoint list and set:
 766          *      first input endpoint = IR endpoint
 767          *      first output endpoint = display endpoint
 768          */
 769         for (i = 0; i < num_endpts && !(ir_ep_found && display_ep_found); ++i) {
 770                 struct usb_endpoint_descriptor *ep;
 771                 int ep_dir;
 772                 int ep_type;
 773
 774                 ep = &iface_desc->endpoint[i].desc;
 775                 ep_dir = ep->bEndpointAddress & USB_ENDPOINT_DIR_MASK;
 776                 ep_type = ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
 777
 778                 if (!ir_ep_found &&
 779                         ep_dir == USB_DIR_IN &&
 780                         ep_type == USB_ENDPOINT_XFER_INT) {
 781
 782                         rx_endpoint = ep;
 783                         ir_ep_found = 1;
 784                         dev_dbg(dev, "%s: found IR endpoint\n", __func__);
 785
 786                 } else if (!display_ep_found && ep_dir == USB_DIR_OUT &&
 787                            ep_type == USB_ENDPOINT_XFER_INT) {
 788                         tx_endpoint = ep;
 789                         display_ep_found = 1;
 790                         dev_dbg(dev, "%s: found display endpoint\n", __func__);
 791                 }
 792         }
 793
 794         /*
 795          * Some iMON receivers have no display. Unfortunately, it seems
 796          * that SoundGraph recycles device IDs between devices both with
 797          * and without... :\
 798          */
 799         if (context->display == 0) {
 800                 display_ep_found = 0;
 801                 dev_dbg(dev, "%s: device has no display\n", __func__);
 802         }
 803
 804         /* Input endpoint is mandatory */
 805         if (!ir_ep_found) {
 806                 dev_err(dev, "%s: no valid input (IR) endpoint found.\n",
 807                         __func__);
 808                 retval = -ENODEV;
 809                 alloc_status = 2;
 810                 goto alloc_status_switch;
 811         }
 812
 813         /* Determine if display requires 6 packets */
 814         if (display_ep_found) {
 815                 if (usb_match_id(interface, vfd_proto_6p_list))
 816                         vfd_proto_6p = 1;
 817
 818                 dev_dbg(dev, "%s: vfd_proto_6p: %d\n",
 819                         __func__, vfd_proto_6p);
 820         }
 821
 822         driver = kzalloc(sizeof(struct lirc_driver), GFP_KERNEL);
 823         if (!driver) {
 824                 alloc_status = 2;
 825                 goto alloc_status_switch;
 826         }
 827         rbuf = kmalloc(sizeof(struct lirc_buffer), GFP_KERNEL);
 828         if (!rbuf) {
 829                 alloc_status = 3;
 830                 goto alloc_status_switch;
 831         }
 832         if (lirc_buffer_init(rbuf, BUF_CHUNK_SIZE, BUF_SIZE)) {
 833                 dev_err(dev, "%s: lirc_buffer_init failed\n", __func__);
 834                 alloc_status = 4;
 835                 goto alloc_status_switch;
 836         }
 837         rx_urb = usb_alloc_urb(0, GFP_KERNEL);
 838         if (!rx_urb) {
 839                 dev_err(dev, "%s: usb_alloc_urb failed for IR urb\n", __func__);
 840                 alloc_status = 5;
 841                 goto alloc_status_switch;
 842         }
 843         tx_urb = usb_alloc_urb(0, GFP_KERNEL);
 844         if (!tx_urb) {
 845                 dev_err(dev, "%s: usb_alloc_urb failed for display urb\n",
 846                     __func__);
 847                 alloc_status = 6;
 848                 goto alloc_status_switch;
 849         }
 850
 851         mutex_init(&context->ctx_lock);
 852         context->vfd_proto_6p = vfd_proto_6p;
 853
 854         strcpy(driver->name, MOD_NAME);
 855         driver->minor = -1;
 856         driver->code_length = BUF_CHUNK_SIZE * 8;
 857         driver->sample_rate = 0;
 858         driver->features = LIRC_CAN_REC_MODE2;
 859         driver->data = context;
 860         driver->rbuf = rbuf;
 861         driver->set_use_inc = ir_open;
 862         driver->set_use_dec = ir_close;
 863         driver->dev = &interface->dev;
 864         driver->owner = THIS_MODULE;
 865
 866         mutex_lock(&context->ctx_lock);
 867
 868         context->driver = driver;
 869         /* start out in keyboard mode */
 870
 871         lirc_minor = lirc_register_driver(driver);
 872         if (lirc_minor < 0) {
 873                 dev_err(dev, "%s: lirc_register_driver failed\n", __func__);
 874                 alloc_status = 7;
 875                 goto unlock;
 876         } else
 877                 dev_info(dev, "Registered iMON driver (lirc minor: %d)\n",
 878                          lirc_minor);
 879
 880         /* Needed while unregistering! */
 881         driver->minor = lirc_minor;
 882
 883         context->usbdev = usbdev;
 884         context->dev_present = 1;
 885         context->rx_endpoint = rx_endpoint;
 886         context->rx_urb = rx_urb;
 887
 888         /*
 889          * tx is used to send characters to lcd/vfd, associate RF
 890          * remotes, set IR protocol, and maybe more...
 891          */
 892         context->tx_endpoint = tx_endpoint;
 893         context->tx_urb = tx_urb;
 894
 895         if (display_ep_found)
 896                 context->display = 1;
 897
 898         usb_fill_int_urb(context->rx_urb, context->usbdev,
 899                 usb_rcvintpipe(context->usbdev,
 900                         context->rx_endpoint->bEndpointAddress),
 901                 context->usb_rx_buf, sizeof(context->usb_rx_buf),
 902                 usb_rx_callback, context,
 903                 context->rx_endpoint->bInterval);
 904
 905         retval = usb_submit_urb(context->rx_urb, GFP_KERNEL);
 906
 907         if (retval) {
 908                 dev_err(dev, "%s: usb_submit_urb failed for intf0 (%d)\n",
 909                         __func__, retval);
 910                 alloc_status = 8;
 911                 goto unlock;
 912         }
 913
 914         usb_set_intfdata(interface, context);
 915
 916         if (context->display && ifnum == 0) {
 917                 dev_dbg(dev, "%s: Registering iMON display with sysfs\n",
 918                         __func__);
 919
 920                 if (usb_register_dev(interface, &imon_class)) {
 921                         /* Not a fatal error, so ignore */
 922                         dev_info(dev, "%s: could not get a minor number for display\n",
 923                                  __func__);
 924                 }
 925         }
 926
 927         dev_info(dev, "iMON device (%04x:%04x, intf%d) on usb<%d:%d> initialized\n",
 928                 vendor, product, ifnum, usbdev->bus->busnum, usbdev->devnum);
 929
 930 unlock:
 931         mutex_unlock(&context->ctx_lock);
 932 alloc_status_switch:
 933
 934         switch (alloc_status) {
 935         case 8:
 936                 lirc_unregister_driver(driver->minor);
 937         case 7:
 938                 usb_free_urb(tx_urb);
 939         case 6:
 940                 usb_free_urb(rx_urb);
 941                 /* fall-through */
 942         case 5:
 943                 if (rbuf)
 944                         lirc_buffer_free(rbuf);
 945                 /* fall-through */
 946         case 4:
 947                 kfree(rbuf);
 948                 /* fall-through */
 949         case 3:
 950                 kfree(driver);
 951                 /* fall-through */
 952         case 2:
 953                 kfree(context);
 954                 context = NULL;
 955         case 1:
 956                 if (retval != -ENODEV)
 957                         retval = -ENOMEM;
 958                 break;
 959         case 0:
 960                 retval = 0;
 961         }
 962
 963         mutex_unlock(&driver_lock);
 964
 965         return retval;
 966 }
 967
 968 /**
 969  * Callback function for USB core API: disconnect
 970  */
 971 static void imon_disconnect(struct usb_interface *interface)
 972 {
 973         struct imon_context *context;
 974         int ifnum;
 975
 976         /* prevent races with ir_open()/display_open() */
 977         mutex_lock(&driver_lock);
 978
 979         context = usb_get_intfdata(interface);
 980         ifnum = interface->cur_altsetting->desc.bInterfaceNumber;
 981
 982         mutex_lock(&context->ctx_lock);
 983
 984         usb_set_intfdata(interface, NULL);
 985
 986         /* Abort ongoing write */
 987         if (atomic_read(&context->tx.busy)) {
 988                 usb_kill_urb(context->tx_urb);
 989                 complete_all(&context->tx.finished);
 990         }
 991
 992         context->dev_present = 0;
 993         usb_kill_urb(context->rx_urb);
 994         if (context->display)
 995                 usb_deregister_dev(interface, &imon_class);
 996
 997         if (!context->ir_isopen && !context->dev_present) {
 998                 deregister_from_lirc(context);
 999                 mutex_unlock(&context->ctx_lock);
1000                 if (!context->display_isopen)
1001                         free_imon_context(context);
1002         } else
1003                 mutex_unlock(&context->ctx_lock);
1004
1005         mutex_unlock(&driver_lock);
1006
1007         dev_info(&interface->dev, "%s: iMON device (intf%d) disconnected\n",
1008                  __func__, ifnum);
1009 }
1010
1011 static int imon_suspend(struct usb_interface *intf, pm_message_t message)
1012 {
1013         struct imon_context *context = usb_get_intfdata(intf);
1014
1015         usb_kill_urb(context->rx_urb);
1016
1017         return 0;
1018 }
1019
1020 static int imon_resume(struct usb_interface *intf)
1021 {
1022         struct imon_context *context = usb_get_intfdata(intf);
1023
1024         usb_fill_int_urb(context->rx_urb, context->usbdev,
1025                 usb_rcvintpipe(context->usbdev,
1026                         context->rx_endpoint->bEndpointAddress),
1027                 context->usb_rx_buf, sizeof(context->usb_rx_buf),
1028                 usb_rx_callback, context,
1029                 context->rx_endpoint->bInterval);
1030
1031         return usb_submit_urb(context->rx_urb, GFP_ATOMIC);
1032 }
1033
1034 module_usb_driver(imon_driver);