drivers/staging/media/lirc/lirc_sasem.c

   1 /*
   2  * lirc_sasem.c - USB remote support for LIRC
   3  * Version 0.5
   4  *
   5  * Copyright (C) 2004-2005 Oliver Stabel <oliver.stabel@gmx.de>
   6  *                       Tim Davies <tim@opensystems.net.au>
   7  *
   8  * This driver was derived from:
   9  *   Venky Raju <dev@venky.ws>
  10  *      "lirc_imon - "LIRC/VFD driver for Ahanix/Soundgraph IMON IR/VFD"
  11  *   Paul Miller <pmiller9@users.sourceforge.net>'s 2003-2004
  12  *      "lirc_atiusb - USB remote support for LIRC"
  13  *   Culver Consulting Services <henry@culcon.com>'s 2003
  14  *      "Sasem OnAir VFD/IR USB driver"
  15  *
  16  *
  17  * NOTE - The LCDproc iMon driver should work with this module.  More info at
  18  *      http://www.frogstorm.info/sasem
  19  */
  20
  21 /*
  22  *  This program is free software; you can redistribute it and/or modify
  23  *  it under the terms of the GNU General Public License as published by
  24  *  the Free Software Foundation; either version 2 of the License, or
  25  *  (at your option) any later version.
  26  *
  27  *  This program is distributed in the hope that it will be useful,
  28  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  29  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  30  *  GNU General Public License for more details.
  31  *
  32  *  You should have received a copy of the GNU General Public License
  33  *  along with this program; if not, write to the Free Software
  34  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  35  */
  36
  37 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  38
  39 #include <linux/errno.h>
  40 #include <linux/kernel.h>
  41 #include <linux/module.h>
  42 #include <linux/slab.h>
  43 #include <linux/uaccess.h>
  44 #include <linux/usb.h>
  45
  46 #include <media/lirc.h>
  47 #include <media/lirc_dev.h>
  48
  49
  50 #define MOD_AUTHOR      "Oliver Stabel <oliver.stabel@gmx.de>, " \
  51                         "Tim Davies <tim@opensystems.net.au>"
  52 #define MOD_DESC        "USB Driver for Sasem Remote Controller V1.1"
  53 #define MOD_NAME        "lirc_sasem"
  54 #define MOD_VERSION     "0.5"
  55
  56 #define VFD_MINOR_BASE  144     /* Same as LCD */
  57 #define DEVICE_NAME     "lcd%d"
  58
  59 #define BUF_CHUNK_SIZE  8
  60 #define BUF_SIZE        128
  61
  62 #define IOCTL_LCD_CONTRAST 1
  63
  64 /*** P R O T O T Y P E S ***/
  65
  66 /* USB Callback prototypes */
  67 static int sasem_probe(struct usb_interface *interface,
  68                         const struct usb_device_id *id);
  69 static void sasem_disconnect(struct usb_interface *interface);
  70 static void usb_rx_callback(struct urb *urb);
  71 static void usb_tx_callback(struct urb *urb);
  72
  73 /* VFD file_operations function prototypes */
  74 static int vfd_open(struct inode *inode, struct file *file);
  75 static long vfd_ioctl(struct file *file, unsigned cmd, unsigned long arg);
  76 static int vfd_close(struct inode *inode, struct file *file);
  77 static ssize_t vfd_write(struct file *file, const char __user *buf,
  78                                 size_t n_bytes, loff_t *pos);
  79
  80 /* LIRC driver function prototypes */
  81 static int ir_open(void *data);
  82 static void ir_close(void *data);
  83
  84 /*** G L O B A L S ***/
  85 #define SASEM_DATA_BUF_SZ       32
  86
  87 struct sasem_context {
  88
  89         struct usb_device *dev;
  90         int vfd_isopen;                 /* VFD port has been opened */
  91         unsigned int vfd_contrast;      /* VFD contrast */
  92         int ir_isopen;                  /* IR port has been opened */
  93         int dev_present;                /* USB device presence */
  94         struct mutex ctx_lock;          /* to lock this object */
  95         wait_queue_head_t remove_ok;    /* For unexpected USB disconnects */
  96
  97         struct lirc_driver *driver;
  98         struct usb_endpoint_descriptor *rx_endpoint;
  99         struct usb_endpoint_descriptor *tx_endpoint;
 100         struct urb *rx_urb;
 101         struct urb *tx_urb;
 102         unsigned char usb_rx_buf[8];
 103         unsigned char usb_tx_buf[8];
 104
 105         struct tx_t {
 106                 unsigned char data_buf[SASEM_DATA_BUF_SZ]; /* user data
 107                                                             * 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         /* for dealing with repeat codes (wish there was a toggle bit!) */
 114         struct timeval presstime;
 115         char lastcode[8];
 116         int codesaved;
 117 };
 118
 119 /* VFD file operations */
 120 static const struct file_operations vfd_fops = {
 121         .owner          = THIS_MODULE,
 122         .open           = &vfd_open,
 123         .write          = vfd_write,
 124         .unlocked_ioctl = &vfd_ioctl,
 125         .release        = &vfd_close,
 126         .llseek         = noop_llseek,
 127 };
 128
 129 /* USB Device ID for Sasem USB Control Board */
 130 static struct usb_device_id sasem_usb_id_table[] = {
 131         /* Sasem USB Control Board */
 132         { USB_DEVICE(0x11ba, 0x0101) },
 133         /* Terminating entry */
 134         {}
 135 };
 136
 137 /* USB Device data */
 138 static struct usb_driver sasem_driver = {
 139         .name           = MOD_NAME,
 140         .probe          = sasem_probe,
 141         .disconnect     = sasem_disconnect,
 142         .id_table       = sasem_usb_id_table,
 143 };
 144
 145 static struct usb_class_driver sasem_class = {
 146         .name           = DEVICE_NAME,
 147         .fops           = &vfd_fops,
 148         .minor_base     = VFD_MINOR_BASE,
 149 };
 150
 151 /* to prevent races between open() and disconnect() */
 152 static DEFINE_MUTEX(disconnect_lock);
 153
 154 static int debug;
 155
 156
 157 /*** M O D U L E   C O D E ***/
 158
 159 MODULE_AUTHOR(MOD_AUTHOR);
 160 MODULE_DESCRIPTION(MOD_DESC);
 161 MODULE_LICENSE("GPL");
 162 module_param(debug, int, S_IRUGO | S_IWUSR);
 163 MODULE_PARM_DESC(debug, "Debug messages: 0=no, 1=yes (default: no)");
 164
 165 static void delete_context(struct sasem_context *context)
 166 {
 167         usb_free_urb(context->tx_urb);  /* VFD */
 168         usb_free_urb(context->rx_urb);  /* IR */
 169         lirc_buffer_free(context->driver->rbuf);
 170         kfree(context->driver->rbuf);
 171         kfree(context->driver);
 172         kfree(context);
 173
 174         if (debug)
 175                 pr_info("%s: context deleted\n", __func__);
 176 }
 177
 178 static void deregister_from_lirc(struct sasem_context *context)
 179 {
 180         int retval;
 181         int minor = context->driver->minor;
 182
 183         retval = lirc_unregister_driver(minor);
 184         if (retval)
 185                 pr_err("%s: unable to deregister from lirc (%d)\n",
 186                        __func__, retval);
 187         else
 188                 pr_info("Deregistered Sasem driver (minor:%d)\n", minor);
 189
 190 }
 191
 192 /**
 193  * Called when the VFD device (e.g. /dev/usb/lcd)
 194  * is opened by the application.
 195  */
 196 static int vfd_open(struct inode *inode, struct file *file)
 197 {
 198         struct usb_interface *interface;
 199         struct sasem_context *context = NULL;
 200         int subminor;
 201         int retval = 0;
 202
 203         /* prevent races with disconnect */
 204         mutex_lock(&disconnect_lock);
 205
 206         subminor = iminor(inode);
 207         interface = usb_find_interface(&sasem_driver, subminor);
 208         if (!interface) {
 209                 pr_err("%s: could not find interface for minor %d\n",
 210                        __func__, subminor);
 211                 retval = -ENODEV;
 212                 goto exit;
 213         }
 214         context = usb_get_intfdata(interface);
 215
 216         if (!context) {
 217                 dev_err(&interface->dev,
 218                         "%s: no context found for minor %d\n",
 219                         __func__, subminor);
 220                 retval = -ENODEV;
 221                 goto exit;
 222         }
 223
 224         mutex_lock(&context->ctx_lock);
 225
 226         if (context->vfd_isopen) {
 227                 dev_err(&interface->dev,
 228                         "%s: VFD port is already open", __func__);
 229                 retval = -EBUSY;
 230         } else {
 231                 context->vfd_isopen = 1;
 232                 file->private_data = context;
 233                 dev_info(&interface->dev, "VFD port opened\n");
 234         }
 235
 236         mutex_unlock(&context->ctx_lock);
 237
 238 exit:
 239         mutex_unlock(&disconnect_lock);
 240         return retval;
 241 }
 242
 243 /**
 244  * Called when the VFD device (e.g. /dev/usb/lcd)
 245  * is closed by the application.
 246  */
 247 static long vfd_ioctl(struct file *file, unsigned cmd, unsigned long arg)
 248 {
 249         struct sasem_context *context = NULL;
 250
 251         context = (struct sasem_context *) file->private_data;
 252
 253         if (!context) {
 254                 pr_err("%s: no context for device\n", __func__);
 255                 return -ENODEV;
 256         }
 257
 258         mutex_lock(&context->ctx_lock);
 259
 260         switch (cmd) {
 261         case IOCTL_LCD_CONTRAST:
 262                 if (arg > 1000)
 263                         arg = 1000;
 264                 context->vfd_contrast = (unsigned int)arg;
 265                 break;
 266         default:
 267                 pr_info("Unknown IOCTL command\n");
 268                 mutex_unlock(&context->ctx_lock);
 269                 return -ENOIOCTLCMD;  /* not supported */
 270         }
 271
 272         mutex_unlock(&context->ctx_lock);
 273         return 0;
 274 }
 275
 276 /**
 277  * Called when the VFD device (e.g. /dev/usb/lcd)
 278  * is closed by the application.
 279  */
 280 static int vfd_close(struct inode *inode, struct file *file)
 281 {
 282         struct sasem_context *context = NULL;
 283         int retval = 0;
 284
 285         context = (struct sasem_context *) file->private_data;
 286
 287         if (!context) {
 288                 pr_err("%s: no context for device\n", __func__);
 289                 return -ENODEV;
 290         }
 291
 292         mutex_lock(&context->ctx_lock);
 293
 294         if (!context->vfd_isopen) {
 295                 dev_err(&context->dev->dev, "%s: VFD is not open\n", __func__);
 296                 retval = -EIO;
 297         } else {
 298                 context->vfd_isopen = 0;
 299                 dev_info(&context->dev->dev, "VFD port closed\n");
 300                 if (!context->dev_present && !context->ir_isopen) {
 301
 302                         /* Device disconnected before close and IR port is
 303                          * not open. If IR port is open, context will be
 304                          * deleted by ir_close. */
 305                         mutex_unlock(&context->ctx_lock);
 306                         delete_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 VFD.
 317  */
 318 static int send_packet(struct sasem_context *context)
 319 {
 320         unsigned int pipe;
 321         int interval = 0;
 322         int retval = 0;
 323
 324         pipe = usb_sndintpipe(context->dev,
 325                         context->tx_endpoint->bEndpointAddress);
 326         interval = context->tx_endpoint->bInterval;
 327
 328         usb_fill_int_urb(context->tx_urb, context->dev, pipe,
 329                 context->usb_tx_buf, sizeof(context->usb_tx_buf),
 330                 usb_tx_callback, context, interval);
 331
 332         context->tx_urb->actual_length = 0;
 333
 334         init_completion(&context->tx.finished);
 335         atomic_set(&(context->tx.busy), 1);
 336
 337         retval =  usb_submit_urb(context->tx_urb, GFP_KERNEL);
 338         if (retval) {
 339                 atomic_set(&(context->tx.busy), 0);
 340                 dev_err(&context->dev->dev, "%s: error submitting urb (%d)\n",
 341                         __func__, retval);
 342         } else {
 343                 /* Wait for transmission to complete (or abort) */
 344                 mutex_unlock(&context->ctx_lock);
 345                 wait_for_completion(&context->tx.finished);
 346                 mutex_lock(&context->ctx_lock);
 347
 348                 retval = context->tx.status;
 349                 if (retval)
 350                         dev_err(&context->dev->dev,
 351                                 "%s: packet tx failed (%d)\n",
 352                                 __func__, retval);
 353         }
 354
 355         return retval;
 356 }
 357
 358 /**
 359  * Writes data to the VFD.  The Sasem VFD is 2x16 characters
 360  * and requires data in 9 consecutive USB interrupt packets,
 361  * each packet carrying 8 bytes.
 362  */
 363 static ssize_t vfd_write(struct file *file, const char __user *buf,
 364                                 size_t n_bytes, loff_t *pos)
 365 {
 366         int i;
 367         int retval = 0;
 368         struct sasem_context *context;
 369         int *data_buf = NULL;
 370
 371         context = (struct sasem_context *) file->private_data;
 372         if (!context) {
 373                 pr_err("%s: no context for device\n", __func__);
 374                 return -ENODEV;
 375         }
 376
 377         mutex_lock(&context->ctx_lock);
 378
 379         if (!context->dev_present) {
 380                 pr_err("%s: no Sasem device present\n", __func__);
 381                 retval = -ENODEV;
 382                 goto exit;
 383         }
 384
 385         if (n_bytes <= 0 || n_bytes > SASEM_DATA_BUF_SZ) {
 386                 dev_err(&context->dev->dev, "%s: invalid payload size\n",
 387                         __func__);
 388                 retval = -EINVAL;
 389                 goto exit;
 390         }
 391
 392         data_buf = memdup_user((void const __user *)buf, n_bytes);
 393         if (IS_ERR(data_buf)) {
 394                 retval = PTR_ERR(data_buf);
 395                 goto exit;
 396         }
 397
 398         memcpy(context->tx.data_buf, data_buf, n_bytes);
 399
 400         /* Pad with spaces */
 401         for (i = n_bytes; i < SASEM_DATA_BUF_SZ; ++i)
 402                 context->tx.data_buf[i] = ' ';
 403
 404         /* Nine 8 byte packets to be sent */
 405         /* NOTE: "\x07\x01\0\0\0\0\0\0" or "\x0c\0\0\0\0\0\0\0"
 406          *       will clear the VFD */
 407         for (i = 0; i < 9; i++) {
 408                 switch (i) {
 409                 case 0:
 410                         memcpy(context->usb_tx_buf, "\x07\0\0\0\0\0\0\0", 8);
 411                         context->usb_tx_buf[1] = (context->vfd_contrast) ?
 412                                 (0x2B - (context->vfd_contrast - 1) / 250)
 413                                 : 0x2B;
 414                         break;
 415                 case 1:
 416                         memcpy(context->usb_tx_buf, "\x09\x01\0\0\0\0\0\0", 8);
 417                         break;
 418                 case 2:
 419                         memcpy(context->usb_tx_buf, "\x0b\x01\0\0\0\0\0\0", 8);
 420                         break;
 421                 case 3:
 422                         memcpy(context->usb_tx_buf, context->tx.data_buf, 8);
 423                         break;
 424                 case 4:
 425                         memcpy(context->usb_tx_buf,
 426                                context->tx.data_buf + 8, 8);
 427                         break;
 428                 case 5:
 429                         memcpy(context->usb_tx_buf, "\x09\x01\0\0\0\0\0\0", 8);
 430                         break;
 431                 case 6:
 432                         memcpy(context->usb_tx_buf, "\x0b\x02\0\0\0\0\0\0", 8);
 433                         break;
 434                 case 7:
 435                         memcpy(context->usb_tx_buf,
 436                                context->tx.data_buf + 16, 8);
 437                         break;
 438                 case 8:
 439                         memcpy(context->usb_tx_buf,
 440                                context->tx.data_buf + 24, 8);
 441                         break;
 442                 }
 443                 retval = send_packet(context);
 444                 if (retval) {
 445                         dev_err(&context->dev->dev,
 446                                 "%s: send packet failed for packet #%d\n",
 447                                 __func__, i);
 448                         goto exit;
 449                 }
 450         }
 451 exit:
 452
 453         mutex_unlock(&context->ctx_lock);
 454         kfree(data_buf);
 455
 456         return (!retval) ? n_bytes : retval;
 457 }
 458
 459 /**
 460  * Callback function for USB core API: transmit data
 461  */
 462 static void usb_tx_callback(struct urb *urb)
 463 {
 464         struct sasem_context *context;
 465
 466         if (!urb)
 467                 return;
 468         context = (struct sasem_context *) urb->context;
 469         if (!context)
 470                 return;
 471
 472         context->tx.status = urb->status;
 473
 474         /* notify waiters that write has finished */
 475         atomic_set(&context->tx.busy, 0);
 476         complete(&context->tx.finished);
 477 }
 478
 479 /**
 480  * Called by lirc_dev when the application opens /dev/lirc
 481  */
 482 static int ir_open(void *data)
 483 {
 484         int retval = 0;
 485         struct sasem_context *context;
 486
 487         /* prevent races with disconnect */
 488         mutex_lock(&disconnect_lock);
 489
 490         context = (struct sasem_context *) data;
 491
 492         mutex_lock(&context->ctx_lock);
 493
 494         if (context->ir_isopen) {
 495                 dev_err(&context->dev->dev, "%s: IR port is already open\n",
 496                         __func__);
 497                 retval = -EBUSY;
 498                 goto exit;
 499         }
 500
 501         usb_fill_int_urb(context->rx_urb, context->dev,
 502                 usb_rcvintpipe(context->dev,
 503                                 context->rx_endpoint->bEndpointAddress),
 504                 context->usb_rx_buf, sizeof(context->usb_rx_buf),
 505                 usb_rx_callback, context, context->rx_endpoint->bInterval);
 506
 507         retval = usb_submit_urb(context->rx_urb, GFP_KERNEL);
 508
 509         if (retval)
 510                 dev_err(&context->dev->dev,
 511                         "%s: usb_submit_urb failed for ir_open (%d)\n",
 512                         __func__, retval);
 513         else {
 514                 context->ir_isopen = 1;
 515                 dev_info(&context->dev->dev, "IR port opened\n");
 516         }
 517
 518 exit:
 519         mutex_unlock(&context->ctx_lock);
 520
 521         mutex_unlock(&disconnect_lock);
 522         return retval;
 523 }
 524
 525 /**
 526  * Called by lirc_dev when the application closes /dev/lirc
 527  */
 528 static void ir_close(void *data)
 529 {
 530         struct sasem_context *context;
 531
 532         context = (struct sasem_context *)data;
 533         if (!context) {
 534                 pr_err("%s: no context for device\n", __func__);
 535                 return;
 536         }
 537
 538         mutex_lock(&context->ctx_lock);
 539
 540         usb_kill_urb(context->rx_urb);
 541         context->ir_isopen = 0;
 542         pr_info("IR port closed\n");
 543
 544         if (!context->dev_present) {
 545
 546                 /*
 547                  * Device disconnected while IR port was
 548                  * still open. Driver was not deregistered
 549                  * at disconnect time, so do it now.
 550                  */
 551                 deregister_from_lirc(context);
 552
 553                 if (!context->vfd_isopen) {
 554
 555                         mutex_unlock(&context->ctx_lock);
 556                         delete_context(context);
 557                         return;
 558                 }
 559                 /* If VFD port is open, context will be deleted by vfd_close */
 560         }
 561
 562         mutex_unlock(&context->ctx_lock);
 563 }
 564
 565 /**
 566  * Process the incoming packet
 567  */
 568 static void incoming_packet(struct sasem_context *context,
 569                                    struct urb *urb)
 570 {
 571         int len = urb->actual_length;
 572         unsigned char *buf = urb->transfer_buffer;
 573         long ms;
 574         struct timeval tv;
 575         int i;
 576
 577         if (len != 8) {
 578                 dev_warn(&context->dev->dev,
 579                          "%s: invalid incoming packet size (%d)\n",
 580                          __func__, len);
 581                 return;
 582         }
 583
 584         if (debug) {
 585                 printk(KERN_INFO "Incoming data: ");
 586                 for (i = 0; i < 8; ++i)
 587                         printk(KERN_CONT "%02x ", buf[i]);
 588                 printk(KERN_CONT "\n");
 589         }
 590
 591         /*
 592          * Lirc could deal with the repeat code, but we really need to block it
 593          * if it arrives too late.  Otherwise we could repeat the wrong code.
 594          */
 595
 596         /* get the time since the last button press */
 597         do_gettimeofday(&tv);
 598         ms = (tv.tv_sec - context->presstime.tv_sec) * 1000 +
 599              (tv.tv_usec - context->presstime.tv_usec) / 1000;
 600
 601         if (memcmp(buf, "\x08\0\0\0\0\0\0\0", 8) == 0) {
 602                 /*
 603                  * the repeat code is being sent, so we copy
 604                  * the old code to LIRC
 605                  */
 606
 607                 /*
 608                  * NOTE: Only if the last code was less than 250ms ago
 609                  * - no one should be able to push another (undetected) button
 610                  *   in that time and then get a false repeat of the previous
 611                  *   press but it is long enough for a genuine repeat
 612                  */
 613                 if ((ms < 250) && (context->codesaved != 0)) {
 614                         memcpy(buf, &context->lastcode, 8);
 615                         context->presstime.tv_sec = tv.tv_sec;
 616                         context->presstime.tv_usec = tv.tv_usec;
 617                 }
 618         } else {
 619                 /* save the current valid code for repeats */
 620                 memcpy(&context->lastcode, buf, 8);
 621                 /*
 622                  * set flag to signal a valid code was save;
 623                  * just for safety reasons
 624                  */
 625                 context->codesaved = 1;
 626                 context->presstime.tv_sec = tv.tv_sec;
 627                 context->presstime.tv_usec = tv.tv_usec;
 628         }
 629
 630         lirc_buffer_write(context->driver->rbuf, buf);
 631         wake_up(&context->driver->rbuf->wait_poll);
 632 }
 633
 634 /**
 635  * Callback function for USB core API: receive data
 636  */
 637 static void usb_rx_callback(struct urb *urb)
 638 {
 639         struct sasem_context *context;
 640
 641         if (!urb)
 642                 return;
 643         context = (struct sasem_context *) urb->context;
 644         if (!context)
 645                 return;
 646
 647         switch (urb->status) {
 648
 649         case -ENOENT:           /* usbcore unlink successful! */
 650                 return;
 651
 652         case 0:
 653                 if (context->ir_isopen)
 654                         incoming_packet(context, urb);
 655                 break;
 656
 657         default:
 658                 dev_warn(&urb->dev->dev, "%s: status (%d): ignored",
 659                          __func__, urb->status);
 660                 break;
 661         }
 662
 663         usb_submit_urb(context->rx_urb, GFP_ATOMIC);
 664 }
 665
 666
 667
 668 /**
 669  * Callback function for USB core API: Probe
 670  */
 671 static int sasem_probe(struct usb_interface *interface,
 672                         const struct usb_device_id *id)
 673 {
 674         struct usb_device *dev = NULL;
 675         struct usb_host_interface *iface_desc = NULL;
 676         struct usb_endpoint_descriptor *rx_endpoint = NULL;
 677         struct usb_endpoint_descriptor *tx_endpoint = NULL;
 678         struct urb *rx_urb = NULL;
 679         struct urb *tx_urb = NULL;
 680         struct lirc_driver *driver = NULL;
 681         struct lirc_buffer *rbuf = NULL;
 682         int lirc_minor = 0;
 683         int num_endpoints;
 684         int retval = 0;
 685         int vfd_ep_found;
 686         int ir_ep_found;
 687         int alloc_status;
 688         struct sasem_context *context = NULL;
 689         int i;
 690
 691         dev_info(&interface->dev, "%s: found Sasem device\n", __func__);
 692
 693
 694         dev = usb_get_dev(interface_to_usbdev(interface));
 695         iface_desc = interface->cur_altsetting;
 696         num_endpoints = iface_desc->desc.bNumEndpoints;
 697
 698         /*
 699          * Scan the endpoint list and set:
 700          *      first input endpoint = IR endpoint
 701          *      first output endpoint = VFD endpoint
 702          */
 703
 704         ir_ep_found = 0;
 705         vfd_ep_found = 0;
 706
 707         for (i = 0; i < num_endpoints && !(ir_ep_found && vfd_ep_found); ++i) {
 708
 709                 struct usb_endpoint_descriptor *ep;
 710                 int ep_dir;
 711                 int ep_type;
 712                 ep = &iface_desc->endpoint [i].desc;
 713                 ep_dir = ep->bEndpointAddress & USB_ENDPOINT_DIR_MASK;
 714                 ep_type = ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
 715
 716                 if (!ir_ep_found &&
 717                         ep_dir == USB_DIR_IN &&
 718                         ep_type == USB_ENDPOINT_XFER_INT) {
 719
 720                         rx_endpoint = ep;
 721                         ir_ep_found = 1;
 722                         if (debug)
 723                                 dev_info(&interface->dev,
 724                                         "%s: found IR endpoint\n", __func__);
 725
 726                 } else if (!vfd_ep_found &&
 727                         ep_dir == USB_DIR_OUT &&
 728                         ep_type == USB_ENDPOINT_XFER_INT) {
 729
 730                         tx_endpoint = ep;
 731                         vfd_ep_found = 1;
 732                         if (debug)
 733                                 dev_info(&interface->dev,
 734                                         "%s: found VFD endpoint\n", __func__);
 735                 }
 736         }
 737
 738         /* Input endpoint is mandatory */
 739         if (!ir_ep_found) {
 740                 dev_err(&interface->dev,
 741                         "%s: no valid input (IR) endpoint found.\n", __func__);
 742                 retval = -ENODEV;
 743                 goto exit;
 744         }
 745
 746         if (!vfd_ep_found)
 747                 dev_info(&interface->dev,
 748                         "%s: no valid output (VFD) endpoint found.\n",
 749                         __func__);
 750
 751
 752         /* Allocate memory */
 753         alloc_status = 0;
 754
 755         context = kzalloc(sizeof(struct sasem_context), GFP_KERNEL);
 756         if (!context) {
 757                 alloc_status = 1;
 758                 goto alloc_status_switch;
 759         }
 760         driver = kzalloc(sizeof(struct lirc_driver), GFP_KERNEL);
 761         if (!driver) {
 762                 alloc_status = 2;
 763                 goto alloc_status_switch;
 764         }
 765         rbuf = kmalloc(sizeof(struct lirc_buffer), GFP_KERNEL);
 766         if (!rbuf) {
 767                 alloc_status = 3;
 768                 goto alloc_status_switch;
 769         }
 770         if (lirc_buffer_init(rbuf, BUF_CHUNK_SIZE, BUF_SIZE)) {
 771                 dev_err(&interface->dev,
 772                         "%s: lirc_buffer_init failed\n", __func__);
 773                 alloc_status = 4;
 774                 goto alloc_status_switch;
 775         }
 776         rx_urb = usb_alloc_urb(0, GFP_KERNEL);
 777         if (!rx_urb) {
 778                 dev_err(&interface->dev,
 779                         "%s: usb_alloc_urb failed for IR urb\n", __func__);
 780                 alloc_status = 5;
 781                 goto alloc_status_switch;
 782         }
 783         if (vfd_ep_found) {
 784                 tx_urb = usb_alloc_urb(0, GFP_KERNEL);
 785                 if (!tx_urb) {
 786                         dev_err(&interface->dev,
 787                                 "%s: usb_alloc_urb failed for VFD urb",
 788                                 __func__);
 789                         alloc_status = 6;
 790                         goto alloc_status_switch;
 791                 }
 792         }
 793
 794         mutex_init(&context->ctx_lock);
 795
 796         strcpy(driver->name, MOD_NAME);
 797         driver->minor = -1;
 798         driver->code_length = 64;
 799         driver->sample_rate = 0;
 800         driver->features = LIRC_CAN_REC_LIRCCODE;
 801         driver->data = context;
 802         driver->rbuf = rbuf;
 803         driver->set_use_inc = ir_open;
 804         driver->set_use_dec = ir_close;
 805         driver->dev   = &interface->dev;
 806         driver->owner = THIS_MODULE;
 807
 808         mutex_lock(&context->ctx_lock);
 809
 810         lirc_minor = lirc_register_driver(driver);
 811         if (lirc_minor < 0) {
 812                 dev_err(&interface->dev,
 813                         "%s: lirc_register_driver failed\n", __func__);
 814                 alloc_status = 7;
 815                 retval = lirc_minor;
 816                 goto unlock;
 817         } else
 818                 dev_info(&interface->dev,
 819                          "%s: Registered Sasem driver (minor:%d)\n",
 820                          __func__, lirc_minor);
 821
 822         /* Needed while unregistering! */
 823         driver->minor = lirc_minor;
 824
 825         context->dev = dev;
 826         context->dev_present = 1;
 827         context->rx_endpoint = rx_endpoint;
 828         context->rx_urb = rx_urb;
 829         if (vfd_ep_found) {
 830                 context->tx_endpoint = tx_endpoint;
 831                 context->tx_urb = tx_urb;
 832                 context->vfd_contrast = 1000;   /* range 0 - 1000 */
 833         }
 834         context->driver = driver;
 835
 836         usb_set_intfdata(interface, context);
 837
 838         if (vfd_ep_found) {
 839
 840                 if (debug)
 841                         dev_info(&interface->dev,
 842                                  "Registering VFD with sysfs\n");
 843                 if (usb_register_dev(interface, &sasem_class))
 844                         /* Not a fatal error, so ignore */
 845                         dev_info(&interface->dev,
 846                                  "%s: could not get a minor number for VFD\n",
 847                                  __func__);
 848         }
 849
 850         dev_info(&interface->dev,
 851                  "%s: Sasem device on usb<%d:%d> initialized\n",
 852                  __func__, dev->bus->busnum, dev->devnum);
 853 unlock:
 854         mutex_unlock(&context->ctx_lock);
 855
 856 alloc_status_switch:
 857         switch (alloc_status) {
 858
 859         case 7:
 860                 if (vfd_ep_found)
 861                         usb_free_urb(tx_urb);
 862         case 6:
 863                 usb_free_urb(rx_urb);
 864                 /* fall-through */
 865         case 5:
 866                 lirc_buffer_free(rbuf);
 867                 /* fall-through */
 868         case 4:
 869                 kfree(rbuf);
 870                 /* fall-through */
 871         case 3:
 872                 kfree(driver);
 873                 /* fall-through */
 874         case 2:
 875                 kfree(context);
 876                 context = NULL;
 877                 /* fall-through */
 878         case 1:
 879                 if (retval == 0)
 880                         retval = -ENOMEM;
 881         }
 882
 883 exit:
 884         return retval;
 885 }
 886
 887 /**
 888  * Callback function for USB core API: disconnect
 889  */
 890 static void sasem_disconnect(struct usb_interface *interface)
 891 {
 892         struct sasem_context *context;
 893
 894         /* prevent races with ir_open()/vfd_open() */
 895         mutex_lock(&disconnect_lock);
 896
 897         context = usb_get_intfdata(interface);
 898         mutex_lock(&context->ctx_lock);
 899
 900         dev_info(&interface->dev, "%s: Sasem device disconnected\n",
 901                  __func__);
 902
 903         usb_set_intfdata(interface, NULL);
 904         context->dev_present = 0;
 905
 906         /* Stop reception */
 907         usb_kill_urb(context->rx_urb);
 908
 909         /* Abort ongoing write */
 910         if (atomic_read(&context->tx.busy)) {
 911
 912                 usb_kill_urb(context->tx_urb);
 913                 wait_for_completion(&context->tx.finished);
 914         }
 915
 916         /* De-register from lirc_dev if IR port is not open */
 917         if (!context->ir_isopen)
 918                 deregister_from_lirc(context);
 919
 920         usb_deregister_dev(interface, &sasem_class);
 921
 922         mutex_unlock(&context->ctx_lock);
 923
 924         if (!context->ir_isopen && !context->vfd_isopen)
 925                 delete_context(context);
 926
 927         mutex_unlock(&disconnect_lock);
 928 }
 929
 930 module_usb_driver(sasem_driver);