drivers/usb/serial/ir-usb.c

   1 /*
   2  * USB IR Dongle driver
   3  *
   4  *      Copyright (C) 2001-2002 Greg Kroah-Hartman (greg@kroah.com)
   5  *      Copyright (C) 2002      Gary Brubaker (xavyer@ix.netcom.com)
   6  *
   7  *      This program is free software; you can redistribute it and/or modify
   8  *      it under the terms of the GNU General Public License as published by
   9  *      the Free Software Foundation; either version 2 of the License, or
  10  *      (at your option) any later version.
  11  *
  12  * This driver allows a USB IrDA device to be used as a "dumb" serial device.
  13  * This can be useful if you do not have access to a full IrDA stack on the
  14  * other side of the connection.  If you do have an IrDA stack on both devices,
  15  * please use the usb-irda driver, as it contains the proper error checking and
  16  * other goodness of a full IrDA stack.
  17  *
  18  * Portions of this driver were taken from drivers/net/irda/irda-usb.c, which
  19  * was written by Roman Weissgaerber <weissg@vienna.at>, Dag Brattli
  20  * <dag@brattli.net>, and Jean Tourrilhes <jt@hpl.hp.com>
  21  *
  22  * See Documentation/usb/usb-serial.txt for more information on using this driver
  23  *
  24  * 2002_Mar_07  greg kh
  25  *      moved some needed structures and #define values from the
  26  *      net/irda/irda-usb.h file into our file, as we don't want to depend on
  27  *      that codebase compiling correctly :)
  28  *
  29  * 2002_Jan_14  gb
  30  *      Added module parameter to force specific number of XBOFs.
  31  *      Added ir_xbof_change().
  32  *      Reorganized read_bulk_callback error handling.
  33  *      Switched from FILL_BULK_URB() to usb_fill_bulk_urb().
  34  *
  35  * 2001_Nov_08  greg kh
  36  *      Changed the irda_usb_find_class_desc() function based on comments and
  37  *      code from Martin Diehl.
  38  *
  39  * 2001_Nov_01  greg kh
  40  *      Added support for more IrDA USB devices.
  41  *      Added support for zero packet.  Added buffer override paramater, so
  42  *      users can transfer larger packets at once if they wish.  Both patches
  43  *      came from Dag Brattli <dag@obexcode.com>.
  44  *
  45  * 2001_Oct_07  greg kh
  46  *      initial version released.
  47  */
  48
  49 #include <linux/config.h>
  50 #include <linux/kernel.h>
  51 #include <linux/errno.h>
  52 #include <linux/init.h>
  53 #include <linux/slab.h>
  54 #include <linux/tty.h>
  55 #include <linux/tty_driver.h>
  56 #include <linux/tty_flip.h>
  57 #include <linux/module.h>
  58 #include <linux/spinlock.h>
  59 #include <asm/uaccess.h>
  60 #include <linux/usb.h>
  61 #include "usb-serial.h"
  62
  63 /*
  64  * Version Information
  65  */
  66 #define DRIVER_VERSION "v0.4"
  67 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>"
  68 #define DRIVER_DESC "USB IR Dongle driver"
  69
  70 /* USB IrDA class spec information */
  71 #define USB_CLASS_IRDA          0x02
  72 #define USB_DT_IRDA             0x21
  73 #define IU_REQ_GET_CLASS_DESC   0x06
  74 #define SPEED_2400              0x01
  75 #define SPEED_9600              0x02
  76 #define SPEED_19200             0x03
  77 #define SPEED_38400             0x04
  78 #define SPEED_57600             0x05
  79 #define SPEED_115200            0x06
  80 #define SPEED_576000            0x07
  81 #define SPEED_1152000           0x08
  82 #define SPEED_4000000           0x09
  83
  84 struct irda_class_desc {
  85         u8      bLength;
  86         u8      bDescriptorType;
  87         u16     bcdSpecRevision;
  88         u8      bmDataSize;
  89         u8      bmWindowSize;
  90         u8      bmMinTurnaroundTime;
  91         u16     wBaudRate;
  92         u8      bmAdditionalBOFs;
  93         u8      bIrdaRateSniff;
  94         u8      bMaxUnicastList;
  95 } __attribute__ ((packed));
  96
  97 static int debug;
  98
  99 /* if overridden by the user, then use their value for the size of the read and
 100  * write urbs */
 101 static int buffer_size;
 102 /* if overridden by the user, then use the specified number of XBOFs */
 103 static int xbof = -1;
 104
 105 static int  ir_startup (struct usb_serial *serial);
 106 static int  ir_open (struct usb_serial_port *port, struct file *filep);
 107 static void ir_close (struct usb_serial_port *port, struct file *filep);
 108 static int  ir_write (struct usb_serial_port *port, const unsigned char *buf, int count);
 109 static void ir_write_bulk_callback (struct urb *urb, struct pt_regs *regs);
 110 static void ir_read_bulk_callback (struct urb *urb, struct pt_regs *regs);
 111 static void ir_set_termios (struct usb_serial_port *port, struct termios *old_termios);
 112
 113 static u8 ir_baud = 0;
 114 static u8 ir_xbof = 0;
 115 static u8 ir_add_bof = 0;
 116
 117 static struct usb_device_id id_table [] = {
 118         { USB_DEVICE(0x050f, 0x0180) },         /* KC Technology, KC-180 */
 119         { USB_DEVICE(0x08e9, 0x0100) },         /* XTNDAccess */
 120         { USB_DEVICE(0x09c4, 0x0011) },         /* ACTiSys ACT-IR2000U */
 121         { USB_INTERFACE_INFO (USB_CLASS_APP_SPEC, USB_CLASS_IRDA, 0) },
 122         { }                                     /* Terminating entry */
 123 };
 124
 125 MODULE_DEVICE_TABLE (usb, id_table);
 126
 127 static struct usb_driver ir_driver = {
 128         .owner =        THIS_MODULE,
 129         .name =         "ir-usb",
 130         .probe =        usb_serial_probe,
 131         .disconnect =   usb_serial_disconnect,
 132         .id_table =     id_table,
 133 };
 134
 135
 136 static struct usb_serial_device_type ir_device = {
 137         .owner =                THIS_MODULE,
 138         .name =                 "IR Dongle",
 139         .id_table =             id_table,
 140         .num_interrupt_in =     1,
 141         .num_bulk_in =          1,
 142         .num_bulk_out =         1,
 143         .num_ports =            1,
 144         .set_termios =          ir_set_termios,
 145         .attach =               ir_startup,
 146         .open =                 ir_open,
 147         .close =                ir_close,
 148         .write =                ir_write,
 149         .write_bulk_callback =  ir_write_bulk_callback,
 150         .read_bulk_callback =   ir_read_bulk_callback,
 151 };
 152
 153 static inline void irda_usb_dump_class_desc(struct irda_class_desc *desc)
 154 {
 155         dbg("bLength=%x", desc->bLength);
 156         dbg("bDescriptorType=%x", desc->bDescriptorType);
 157         dbg("bcdSpecRevision=%x", desc->bcdSpecRevision);
 158         dbg("bmDataSize=%x", desc->bmDataSize);
 159         dbg("bmWindowSize=%x", desc->bmWindowSize);
 160         dbg("bmMinTurnaroundTime=%d", desc->bmMinTurnaroundTime);
 161         dbg("wBaudRate=%x", desc->wBaudRate);
 162         dbg("bmAdditionalBOFs=%x", desc->bmAdditionalBOFs);
 163         dbg("bIrdaRateSniff=%x", desc->bIrdaRateSniff);
 164         dbg("bMaxUnicastList=%x", desc->bMaxUnicastList);
 165 }
 166
 167 /*------------------------------------------------------------------*/
 168 /*
 169  * Function irda_usb_find_class_desc(dev, ifnum)
 170  *
 171  *    Returns instance of IrDA class descriptor, or NULL if not found
 172  *
 173  * The class descriptor is some extra info that IrDA USB devices will
 174  * offer to us, describing their IrDA characteristics. We will use that in
 175  * irda_usb_init_qos()
 176  *
 177  * Based on the same function in drivers/net/irda/irda-usb.c
 178  */
 179 static struct irda_class_desc *irda_usb_find_class_desc(struct usb_device *dev, unsigned int ifnum)
 180 {
 181         struct irda_class_desc *desc;
 182         int ret;
 183
 184         desc = kmalloc(sizeof (struct irda_class_desc), GFP_KERNEL);
 185         if (desc == NULL)
 186                 return NULL;
 187         memset(desc, 0, sizeof(struct irda_class_desc));
 188
 189         ret = usb_control_msg(dev, usb_rcvctrlpipe(dev,0),
 190                         IU_REQ_GET_CLASS_DESC,
 191                         USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
 192                         0, ifnum, desc, sizeof(*desc), 1000);
 193
 194         dbg("%s -  ret=%d", __FUNCTION__, ret);
 195         if (ret < sizeof(*desc)) {
 196                 dbg("%s - class descriptor read %s (%d)",
 197                                 __FUNCTION__,
 198                                 (ret<0) ? "failed" : "too short",
 199                                 ret);
 200                 goto error;
 201         }
 202         if (desc->bDescriptorType != USB_DT_IRDA) {
 203                 dbg("%s - bad class descriptor type", __FUNCTION__);
 204                 goto error;
 205         }
 206
 207         irda_usb_dump_class_desc(desc);
 208         return desc;
 209 error:
 210         kfree(desc);
 211         return NULL;
 212 }
 213
 214
 215 static u8 ir_xbof_change(u8 xbof)
 216 {
 217         u8 result;
 218         /* reference irda-usb.c */
 219         switch(xbof) {
 220                 case 48: result = 0x10; break;
 221                 case 28:
 222                 case 24: result = 0x20; break;
 223                 default:
 224                 case 12: result = 0x30; break;
 225                 case  5:
 226                 case  6: result = 0x40; break;
 227                 case  3: result = 0x50; break;
 228                 case  2: result = 0x60; break;
 229                 case  1: result = 0x70; break;
 230                 case  0: result = 0x80; break;
 231         }
 232         return(result);
 233 }
 234
 235
 236 static int ir_startup (struct usb_serial *serial)
 237 {
 238         struct irda_class_desc *irda_desc;
 239
 240         irda_desc = irda_usb_find_class_desc (serial->dev, 0);
 241         if (irda_desc == NULL) {
 242                 dev_err (&serial->dev->dev, "IRDA class descriptor not found, device not bound\n");
 243                 return -ENODEV;
 244         }
 245
 246         dbg ("%s - Baud rates supported:%s%s%s%s%s%s%s%s%s",
 247                 __FUNCTION__,
 248                 (irda_desc->wBaudRate & 0x0001) ? " 2400"    : "",
 249                 (irda_desc->wBaudRate & 0x0002) ? " 9600"    : "",
 250                 (irda_desc->wBaudRate & 0x0004) ? " 19200"   : "",
 251                 (irda_desc->wBaudRate & 0x0008) ? " 38400"   : "",
 252                 (irda_desc->wBaudRate & 0x0010) ? " 57600"   : "",
 253                 (irda_desc->wBaudRate & 0x0020) ? " 115200"  : "",
 254                 (irda_desc->wBaudRate & 0x0040) ? " 576000"  : "",
 255                 (irda_desc->wBaudRate & 0x0080) ? " 1152000" : "",
 256                 (irda_desc->wBaudRate & 0x0100) ? " 4000000" : "");
 257
 258         switch( irda_desc->bmAdditionalBOFs ) {
 259                 case 0x01: ir_add_bof = 48; break;
 260                 case 0x02: ir_add_bof = 24; break;
 261                 case 0x04: ir_add_bof = 12; break;
 262                 case 0x08: ir_add_bof =  6; break;
 263                 case 0x10: ir_add_bof =  3; break;
 264                 case 0x20: ir_add_bof =  2; break;
 265                 case 0x40: ir_add_bof =  1; break;
 266                 case 0x80: ir_add_bof =  0; break;
 267                 default:;
 268         }
 269
 270         kfree (irda_desc);
 271
 272         return 0;
 273 }
 274
 275 static int ir_open (struct usb_serial_port *port, struct file *filp)
 276 {
 277         char *buffer;
 278         int result = 0;
 279
 280         dbg("%s - port %d", __FUNCTION__, port->number);
 281
 282         if (buffer_size) {
 283                 /* override the default buffer sizes */
 284                 buffer = kmalloc (buffer_size, GFP_KERNEL);
 285                 if (!buffer) {
 286                         dev_err (&port->dev, "%s - out of memory.\n", __FUNCTION__);
 287                         return -ENOMEM;
 288                 }
 289                 kfree (port->read_urb->transfer_buffer);
 290                 port->read_urb->transfer_buffer = buffer;
 291                 port->read_urb->transfer_buffer_length = buffer_size;
 292
 293                 buffer = kmalloc (buffer_size, GFP_KERNEL);
 294                 if (!buffer) {
 295                         dev_err (&port->dev, "%s - out of memory.\n", __FUNCTION__);
 296                         return -ENOMEM;
 297                 }
 298                 kfree (port->write_urb->transfer_buffer);
 299                 port->write_urb->transfer_buffer = buffer;
 300                 port->write_urb->transfer_buffer_length = buffer_size;
 301                 port->bulk_out_size = buffer_size;
 302         }
 303
 304         /* Start reading from the device */
 305         usb_fill_bulk_urb (
 306                 port->read_urb,
 307                 port->serial->dev,
 308                 usb_rcvbulkpipe(port->serial->dev, port->bulk_in_endpointAddress),
 309                 port->read_urb->transfer_buffer,
 310                 port->read_urb->transfer_buffer_length,
 311                 ir_read_bulk_callback,
 312                 port);
 313         result = usb_submit_urb(port->read_urb, GFP_KERNEL);
 314         if (result)
 315                 dev_err(&port->dev, "%s - failed submitting read urb, error %d\n", __FUNCTION__, result);
 316
 317         return result;
 318 }
 319
 320 static void ir_close (struct usb_serial_port *port, struct file * filp)
 321 {
 322         dbg("%s - port %d", __FUNCTION__, port->number);
 323
 324         /* shutdown our bulk read */
 325         usb_kill_urb(port->read_urb);
 326 }
 327
 328 static int ir_write (struct usb_serial_port *port, const unsigned char *buf, int count)
 329 {
 330         unsigned char *transfer_buffer;
 331         int result;
 332         int transfer_size;
 333
 334         dbg("%s - port = %d, count = %d", __FUNCTION__, port->number, count);
 335
 336         if (!port->tty) {
 337                 dev_err (&port->dev, "%s - no tty???\n", __FUNCTION__);
 338                 return 0;
 339         }
 340
 341         if (count == 0)
 342                 return 0;
 343
 344         if (port->write_urb->status == -EINPROGRESS) {
 345                 dbg ("%s - already writing", __FUNCTION__);
 346                 return 0;
 347         }
 348
 349         transfer_buffer = port->write_urb->transfer_buffer;
 350         transfer_size = min(count, port->bulk_out_size - 1);
 351
 352         /*
 353          * The first byte of the packet we send to the device contains an
 354          * inband header which indicates an additional number of BOFs and
 355          * a baud rate change.
 356          *
 357          * See section 5.4.2.2 of the USB IrDA spec.
 358          */
 359         *transfer_buffer = ir_xbof | ir_baud;
 360         ++transfer_buffer;
 361
 362         memcpy (transfer_buffer, buf, transfer_size);
 363
 364         usb_fill_bulk_urb (
 365                 port->write_urb,
 366                 port->serial->dev,
 367                 usb_sndbulkpipe(port->serial->dev,
 368                         port->bulk_out_endpointAddress),
 369                 port->write_urb->transfer_buffer,
 370                 transfer_size + 1,
 371                 ir_write_bulk_callback,
 372                 port);
 373
 374         port->write_urb->transfer_flags = URB_ZERO_PACKET;
 375
 376         result = usb_submit_urb (port->write_urb, GFP_ATOMIC);
 377         if (result)
 378                 dev_err(&port->dev, "%s - failed submitting write urb, error %d\n", __FUNCTION__, result);
 379         else
 380                 result = transfer_size;
 381
 382         return result;
 383 }
 384
 385 static void ir_write_bulk_callback (struct urb *urb, struct pt_regs *regs)
 386 {
 387         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
 388
 389         dbg("%s - port %d", __FUNCTION__, port->number);
 390
 391         if (urb->status) {
 392                 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status);
 393                 return;
 394         }
 395
 396         usb_serial_debug_data (
 397                 debug,
 398                 &port->dev,
 399                 __FUNCTION__,
 400                 urb->actual_length,
 401                 urb->transfer_buffer);
 402
 403         schedule_work(&port->work);
 404 }
 405
 406 static void ir_read_bulk_callback (struct urb *urb, struct pt_regs *regs)
 407 {
 408         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
 409         struct tty_struct *tty;
 410         unsigned char *data = urb->transfer_buffer;
 411         int result;
 412
 413         dbg("%s - port %d", __FUNCTION__, port->number);
 414
 415         if (!port->open_count) {
 416                 dbg("%s - port closed.", __FUNCTION__);
 417                 return;
 418         }
 419
 420         switch (urb->status) {
 421
 422                 case 0: /* Successful */
 423
 424                         /*
 425                          * The first byte of the packet we get from the device
 426                          * contains a busy indicator and baud rate change.
 427                          * See section 5.4.1.2 of the USB IrDA spec.
 428                          */
 429                         if ((*data & 0x0f) > 0)
 430                                 ir_baud = *data & 0x0f;
 431
 432                         usb_serial_debug_data (
 433                                 debug,
 434                                 &port->dev,
 435                                 __FUNCTION__,
 436                                 urb->actual_length,
 437                                 data);
 438
 439                         /*
 440                          * Bypass flip-buffers, and feed the ldisc directly
 441                          * due to our potentially large buffer size.  Since we
 442                          * used to set low_latency, this is exactly what the
 443                          * tty layer did anyway :)
 444                          */
 445                         tty = port->tty;
 446
 447                         /*
 448                          *      FIXME: must not do this in IRQ context,
 449                          *      must honour TTY_DONT_FLIP
 450                          */
 451                         tty->ldisc.receive_buf(
 452                                 tty,
 453                                 data+1,
 454                                 NULL,
 455                                 urb->actual_length-1);
 456
 457                         /*
 458                          * No break here.
 459                          * We want to resubmit the urb so we can read
 460                          * again.
 461                          */
 462
 463                 case -EPROTO: /* taking inspiration from pl2303.c */
 464
 465                         /* Continue trying to always read */
 466                         usb_fill_bulk_urb (
 467                                 port->read_urb,
 468                                 port->serial->dev,
 469                                 usb_rcvbulkpipe(port->serial->dev,
 470                                         port->bulk_in_endpointAddress),
 471                                 port->read_urb->transfer_buffer,
 472                                 port->read_urb->transfer_buffer_length,
 473                                 ir_read_bulk_callback,
 474                                 port);
 475
 476                         result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
 477                         if (result)
 478                                 dev_err(&port->dev, "%s - failed resubmitting read urb, error %d\n",
 479                                         __FUNCTION__, result);
 480
 481                         break ;
 482
 483                 default:
 484                         dbg("%s - nonzero read bulk status received: %d",
 485                                 __FUNCTION__,
 486                                 urb->status);
 487                         break ;
 488
 489         }
 490
 491         return;
 492 }
 493
 494 static void ir_set_termios (struct usb_serial_port *port, struct termios *old_termios)
 495 {
 496         unsigned char *transfer_buffer;
 497         unsigned int cflag;
 498         int result;
 499
 500         dbg("%s - port %d", __FUNCTION__, port->number);
 501
 502         if ((!port->tty) || (!port->tty->termios)) {
 503                 dbg("%s - no tty structures", __FUNCTION__);
 504                 return;
 505         }
 506
 507         cflag = port->tty->termios->c_cflag;
 508         /* check that they really want us to change something */
 509         if (old_termios) {
 510                 if ((cflag == old_termios->c_cflag) &&
 511                     (RELEVANT_IFLAG(port->tty->termios->c_iflag) == RELEVANT_IFLAG(old_termios->c_iflag))) {
 512                         dbg("%s - nothing to change...", __FUNCTION__);
 513                         return;
 514                 }
 515         }
 516
 517         /* All we can change is the baud rate */
 518         if (cflag & CBAUD) {
 519
 520                 dbg ("%s - asking for baud %d",
 521                         __FUNCTION__,
 522                         tty_get_baud_rate(port->tty));
 523
 524                 /*
 525                  * FIXME, we should compare the baud request against the
 526                  * capability stated in the IR header that we got in the
 527                  * startup function.
 528                  */
 529                 switch (cflag & CBAUD) {
 530                         case B2400:    ir_baud = SPEED_2400;    break;
 531                         default:
 532                         case B9600:    ir_baud = SPEED_9600;    break;
 533                         case B19200:   ir_baud = SPEED_19200;   break;
 534                         case B38400:   ir_baud = SPEED_38400;   break;
 535                         case B57600:   ir_baud = SPEED_57600;   break;
 536                         case B115200:  ir_baud = SPEED_115200;  break;
 537                         case B576000:  ir_baud = SPEED_576000;  break;
 538                         case B1152000: ir_baud = SPEED_1152000; break;
 539 #ifdef B4000000
 540                         case B4000000: ir_baud = SPEED_4000000; break;
 541 #endif
 542                 }
 543
 544                 if (xbof == -1) {
 545                         ir_xbof = ir_xbof_change(ir_add_bof);
 546                 } else {
 547                         ir_xbof = ir_xbof_change(xbof) ;
 548                 }
 549
 550                 /* Notify the tty driver that the termios have changed. */
 551                 port->tty->ldisc.set_termios(port->tty, NULL);
 552
 553                 /* FIXME need to check to see if our write urb is busy right
 554                  * now, or use a urb pool.
 555                  *
 556                  * send the baud change out on an "empty" data packet
 557                  */
 558                 transfer_buffer = port->write_urb->transfer_buffer;
 559                 *transfer_buffer = ir_xbof | ir_baud;
 560
 561                 usb_fill_bulk_urb (
 562                         port->write_urb,
 563                         port->serial->dev,
 564                         usb_sndbulkpipe(port->serial->dev,
 565                                 port->bulk_out_endpointAddress),
 566                         port->write_urb->transfer_buffer,
 567                         1,
 568                         ir_write_bulk_callback,
 569                         port);
 570
 571                 port->write_urb->transfer_flags = URB_ZERO_PACKET;
 572
 573                 result = usb_submit_urb (port->write_urb, GFP_KERNEL);
 574                 if (result)
 575                         dev_err(&port->dev, "%s - failed submitting write urb, error %d\n", __FUNCTION__, result);
 576         }
 577         return;
 578 }
 579
 580
 581 static int __init ir_init (void)
 582 {
 583         int retval;
 584         retval = usb_serial_register(&ir_device);
 585         if (retval)
 586                 goto failed_usb_serial_register;
 587         retval = usb_register(&ir_driver);
 588         if (retval)
 589                 goto failed_usb_register;
 590         info(DRIVER_DESC " " DRIVER_VERSION);
 591         return 0;
 592 failed_usb_register:
 593         usb_serial_deregister(&ir_device);
 594 failed_usb_serial_register:
 595         return retval;
 596 }
 597
 598
 599 static void __exit ir_exit (void)
 600 {
 601         usb_deregister (&ir_driver);
 602         usb_serial_deregister (&ir_device);
 603 }
 604
 605
 606 module_init(ir_init);
 607 module_exit(ir_exit);
 608
 609 MODULE_AUTHOR(DRIVER_AUTHOR);
 610 MODULE_DESCRIPTION(DRIVER_DESC);
 611 MODULE_LICENSE("GPL");
 612
 613 module_param(debug, bool, S_IRUGO | S_IWUSR);
 614 MODULE_PARM_DESC(debug, "Debug enabled or not");
 615 module_param(xbof, int, 0);
 616 MODULE_PARM_DESC(xbof, "Force specific number of XBOFs");
 617 module_param(buffer_size, int, 0);
 618 MODULE_PARM_DESC(buffer_size, "Size of the transfer buffers");
 619