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