drivers/usb/serial/ir-usb.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * USB IR Dongle driver
   4  *
   5  *      Copyright (C) 2001-2002 Greg Kroah-Hartman (greg@kroah.com)
   6  *      Copyright (C) 2002      Gary Brubaker (xavyer@ix.netcom.com)
   7  *      Copyright (C) 2010      Johan Hovold (jhovold@gmail.com)
   8  *
   9  * This driver allows a USB IrDA device to be used as a "dumb" serial device.
  10  * This can be useful if you do not have access to a full IrDA stack on the
  11  * other side of the connection.  If you do have an IrDA stack on both devices,
  12  * please use the usb-irda driver, as it contains the proper error checking and
  13  * other goodness of a full IrDA stack.
  14  *
  15  * Portions of this driver were taken from drivers/net/irda/irda-usb.c, which
  16  * was written by Roman Weissgaerber <weissg@vienna.at>, Dag Brattli
  17  * <dag@brattli.net>, and Jean Tourrilhes <jt@hpl.hp.com>
  18  *
  19  * See Documentation/usb/usb-serial.txt for more information on using this
  20  * driver
  21  */
  22
  23 #include <linux/kernel.h>
  24 #include <linux/errno.h>
  25 #include <linux/init.h>
  26 #include <linux/slab.h>
  27 #include <linux/tty.h>
  28 #include <linux/tty_driver.h>
  29 #include <linux/tty_flip.h>
  30 #include <linux/module.h>
  31 #include <linux/spinlock.h>
  32 #include <linux/uaccess.h>
  33 #include <linux/usb.h>
  34 #include <linux/usb/serial.h>
  35 #include <linux/usb/irda.h>
  36
  37 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>, Johan Hovold <jhovold@gmail.com>"
  38 #define DRIVER_DESC "USB IR Dongle driver"
  39
  40 /* if overridden by the user, then use their value for the size of the read and
  41  * write urbs */
  42 static int buffer_size;
  43
  44 /* if overridden by the user, then use the specified number of XBOFs */
  45 static int xbof = -1;
  46
  47 static int  ir_startup (struct usb_serial *serial);
  48 static int  ir_open(struct tty_struct *tty, struct usb_serial_port *port);
  49 static int ir_prepare_write_buffer(struct usb_serial_port *port,
  50                                                 void *dest, size_t size);
  51 static void ir_process_read_urb(struct urb *urb);
  52 static void ir_set_termios(struct tty_struct *tty,
  53                 struct usb_serial_port *port, struct ktermios *old_termios);
  54
  55 /* Not that this lot means you can only have one per system */
  56 static u8 ir_baud;
  57 static u8 ir_xbof;
  58 static u8 ir_add_bof;
  59
  60 static const struct usb_device_id ir_id_table[] = {
  61         { USB_DEVICE(0x050f, 0x0180) },         /* KC Technology, KC-180 */
  62         { USB_DEVICE(0x08e9, 0x0100) },         /* XTNDAccess */
  63         { USB_DEVICE(0x09c4, 0x0011) },         /* ACTiSys ACT-IR2000U */
  64         { USB_INTERFACE_INFO(USB_CLASS_APP_SPEC, USB_SUBCLASS_IRDA, 0) },
  65         { }                                     /* Terminating entry */
  66 };
  67
  68 MODULE_DEVICE_TABLE(usb, ir_id_table);
  69
  70 static struct usb_serial_driver ir_device = {
  71         .driver = {
  72                 .owner  = THIS_MODULE,
  73                 .name   = "ir-usb",
  74         },
  75         .description            = "IR Dongle",
  76         .id_table               = ir_id_table,
  77         .num_ports              = 1,
  78         .set_termios            = ir_set_termios,
  79         .attach                 = ir_startup,
  80         .open                   = ir_open,
  81         .prepare_write_buffer   = ir_prepare_write_buffer,
  82         .process_read_urb       = ir_process_read_urb,
  83 };
  84
  85 static struct usb_serial_driver * const serial_drivers[] = {
  86         &ir_device, NULL
  87 };
  88
  89 static inline void irda_usb_dump_class_desc(struct usb_serial *serial,
  90                                             struct usb_irda_cs_descriptor *desc)
  91 {
  92         struct device *dev = &serial->dev->dev;
  93
  94         dev_dbg(dev, "bLength=%x\n", desc->bLength);
  95         dev_dbg(dev, "bDescriptorType=%x\n", desc->bDescriptorType);
  96         dev_dbg(dev, "bcdSpecRevision=%x\n", __le16_to_cpu(desc->bcdSpecRevision));
  97         dev_dbg(dev, "bmDataSize=%x\n", desc->bmDataSize);
  98         dev_dbg(dev, "bmWindowSize=%x\n", desc->bmWindowSize);
  99         dev_dbg(dev, "bmMinTurnaroundTime=%d\n", desc->bmMinTurnaroundTime);
 100         dev_dbg(dev, "wBaudRate=%x\n", __le16_to_cpu(desc->wBaudRate));
 101         dev_dbg(dev, "bmAdditionalBOFs=%x\n", desc->bmAdditionalBOFs);
 102         dev_dbg(dev, "bIrdaRateSniff=%x\n", desc->bIrdaRateSniff);
 103         dev_dbg(dev, "bMaxUnicastList=%x\n", desc->bMaxUnicastList);
 104 }
 105
 106 /*------------------------------------------------------------------*/
 107 /*
 108  * Function irda_usb_find_class_desc(dev, ifnum)
 109  *
 110  *    Returns instance of IrDA class descriptor, or NULL if not found
 111  *
 112  * The class descriptor is some extra info that IrDA USB devices will
 113  * offer to us, describing their IrDA characteristics. We will use that in
 114  * irda_usb_init_qos()
 115  *
 116  * Based on the same function in drivers/net/irda/irda-usb.c
 117  */
 118 static struct usb_irda_cs_descriptor *
 119 irda_usb_find_class_desc(struct usb_serial *serial, unsigned int ifnum)
 120 {
 121         struct usb_device *dev = serial->dev;
 122         struct usb_irda_cs_descriptor *desc;
 123         int ret;
 124
 125         desc = kzalloc(sizeof(*desc), GFP_KERNEL);
 126         if (!desc)
 127                 return NULL;
 128
 129         ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
 130                         USB_REQ_CS_IRDA_GET_CLASS_DESC,
 131                         USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
 132                         0, ifnum, desc, sizeof(*desc), 1000);
 133
 134         dev_dbg(&serial->dev->dev, "%s -  ret=%d\n", __func__, ret);
 135         if (ret < sizeof(*desc)) {
 136                 dev_dbg(&serial->dev->dev,
 137                         "%s - class descriptor read %s (%d)\n", __func__,
 138                         (ret < 0) ? "failed" : "too short", ret);
 139                 goto error;
 140         }
 141         if (desc->bDescriptorType != USB_DT_CS_IRDA) {
 142                 dev_dbg(&serial->dev->dev, "%s - bad class descriptor type\n",
 143                         __func__);
 144                 goto error;
 145         }
 146
 147         irda_usb_dump_class_desc(serial, desc);
 148         return desc;
 149
 150 error:
 151         kfree(desc);
 152         return NULL;
 153 }
 154
 155 static u8 ir_xbof_change(u8 xbof)
 156 {
 157         u8 result;
 158
 159         /* reference irda-usb.c */
 160         switch (xbof) {
 161         case 48:
 162                 result = 0x10;
 163                 break;
 164         case 28:
 165         case 24:
 166                 result = 0x20;
 167                 break;
 168         default:
 169         case 12:
 170                 result = 0x30;
 171                 break;
 172         case  5:
 173         case  6:
 174                 result = 0x40;
 175                 break;
 176         case  3:
 177                 result = 0x50;
 178                 break;
 179         case  2:
 180                 result = 0x60;
 181                 break;
 182         case  1:
 183                 result = 0x70;
 184                 break;
 185         case  0:
 186                 result = 0x80;
 187                 break;
 188         }
 189
 190         return(result);
 191 }
 192
 193 static int ir_startup(struct usb_serial *serial)
 194 {
 195         struct usb_irda_cs_descriptor *irda_desc;
 196         int rates;
 197
 198         if (serial->num_bulk_in < 1 || serial->num_bulk_out < 1)
 199                 return -ENODEV;
 200
 201         irda_desc = irda_usb_find_class_desc(serial, 0);
 202         if (!irda_desc) {
 203                 dev_err(&serial->dev->dev,
 204                         "IRDA class descriptor not found, device not bound\n");
 205                 return -ENODEV;
 206         }
 207
 208         rates = le16_to_cpu(irda_desc->wBaudRate);
 209
 210         dev_dbg(&serial->dev->dev,
 211                 "%s - Baud rates supported:%s%s%s%s%s%s%s%s%s\n",
 212                 __func__,
 213                 (rates & USB_IRDA_BR_2400) ? " 2400" : "",
 214                 (rates & USB_IRDA_BR_9600) ? " 9600" : "",
 215                 (rates & USB_IRDA_BR_19200) ? " 19200" : "",
 216                 (rates & USB_IRDA_BR_38400) ? " 38400" : "",
 217                 (rates & USB_IRDA_BR_57600) ? " 57600" : "",
 218                 (rates & USB_IRDA_BR_115200) ? " 115200" : "",
 219                 (rates & USB_IRDA_BR_576000) ? " 576000" : "",
 220                 (rates & USB_IRDA_BR_1152000) ? " 1152000" : "",
 221                 (rates & USB_IRDA_BR_4000000) ? " 4000000" : "");
 222
 223         switch (irda_desc->bmAdditionalBOFs) {
 224         case USB_IRDA_AB_48:
 225                 ir_add_bof = 48;
 226                 break;
 227         case USB_IRDA_AB_24:
 228                 ir_add_bof = 24;
 229                 break;
 230         case USB_IRDA_AB_12:
 231                 ir_add_bof = 12;
 232                 break;
 233         case USB_IRDA_AB_6:
 234                 ir_add_bof = 6;
 235                 break;
 236         case USB_IRDA_AB_3:
 237                 ir_add_bof = 3;
 238                 break;
 239         case USB_IRDA_AB_2:
 240                 ir_add_bof = 2;
 241                 break;
 242         case USB_IRDA_AB_1:
 243                 ir_add_bof = 1;
 244                 break;
 245         case USB_IRDA_AB_0:
 246                 ir_add_bof = 0;
 247                 break;
 248         default:
 249                 break;
 250         }
 251
 252         kfree(irda_desc);
 253
 254         return 0;
 255 }
 256
 257 static int ir_open(struct tty_struct *tty, struct usb_serial_port *port)
 258 {
 259         int i;
 260
 261         for (i = 0; i < ARRAY_SIZE(port->write_urbs); ++i)
 262                 port->write_urbs[i]->transfer_flags = URB_ZERO_PACKET;
 263
 264         /* Start reading from the device */
 265         return usb_serial_generic_open(tty, port);
 266 }
 267
 268 static int ir_prepare_write_buffer(struct usb_serial_port *port,
 269                                                 void *dest, size_t size)
 270 {
 271         unsigned char *buf = dest;
 272         int count;
 273
 274         /*
 275          * The first byte of the packet we send to the device contains an
 276          * inbound header which indicates an additional number of BOFs and
 277          * a baud rate change.
 278          *
 279          * See section 5.4.2.2 of the USB IrDA spec.
 280          */
 281         *buf = ir_xbof | ir_baud;
 282
 283         count = kfifo_out_locked(&port->write_fifo, buf + 1, size - 1,
 284                                                                 &port->lock);
 285         return count + 1;
 286 }
 287
 288 static void ir_process_read_urb(struct urb *urb)
 289 {
 290         struct usb_serial_port *port = urb->context;
 291         unsigned char *data = urb->transfer_buffer;
 292
 293         if (!urb->actual_length)
 294                 return;
 295         /*
 296          * The first byte of the packet we get from the device
 297          * contains a busy indicator and baud rate change.
 298          * See section 5.4.1.2 of the USB IrDA spec.
 299          */
 300         if (*data & 0x0f)
 301                 ir_baud = *data & 0x0f;
 302
 303         if (urb->actual_length == 1)
 304                 return;
 305
 306         tty_insert_flip_string(&port->port, data + 1, urb->actual_length - 1);
 307         tty_flip_buffer_push(&port->port);
 308 }
 309
 310 static void ir_set_termios_callback(struct urb *urb)
 311 {
 312         kfree(urb->transfer_buffer);
 313
 314         if (urb->status)
 315                 dev_dbg(&urb->dev->dev, "%s - non-zero urb status: %d\n",
 316                         __func__, urb->status);
 317 }
 318
 319 static void ir_set_termios(struct tty_struct *tty,
 320                 struct usb_serial_port *port, struct ktermios *old_termios)
 321 {
 322         struct urb *urb;
 323         unsigned char *transfer_buffer;
 324         int result;
 325         speed_t baud;
 326         int ir_baud;
 327
 328         baud = tty_get_baud_rate(tty);
 329
 330         /*
 331          * FIXME, we should compare the baud request against the
 332          * capability stated in the IR header that we got in the
 333          * startup function.
 334          */
 335
 336         switch (baud) {
 337         case 2400:
 338                 ir_baud = USB_IRDA_LS_2400;
 339                 break;
 340         case 9600:
 341                 ir_baud = USB_IRDA_LS_9600;
 342                 break;
 343         case 19200:
 344                 ir_baud = USB_IRDA_LS_19200;
 345                 break;
 346         case 38400:
 347                 ir_baud = USB_IRDA_LS_38400;
 348                 break;
 349         case 57600:
 350                 ir_baud = USB_IRDA_LS_57600;
 351                 break;
 352         case 115200:
 353                 ir_baud = USB_IRDA_LS_115200;
 354                 break;
 355         case 576000:
 356                 ir_baud = USB_IRDA_LS_576000;
 357                 break;
 358         case 1152000:
 359                 ir_baud = USB_IRDA_LS_1152000;
 360                 break;
 361         case 4000000:
 362                 ir_baud = USB_IRDA_LS_4000000;
 363                 break;
 364         default:
 365                 ir_baud = USB_IRDA_LS_9600;
 366                 baud = 9600;
 367         }
 368
 369         if (xbof == -1)
 370                 ir_xbof = ir_xbof_change(ir_add_bof);
 371         else
 372                 ir_xbof = ir_xbof_change(xbof) ;
 373
 374         /* Only speed changes are supported */
 375         tty_termios_copy_hw(&tty->termios, old_termios);
 376         tty_encode_baud_rate(tty, baud, baud);
 377
 378         /*
 379          * send the baud change out on an "empty" data packet
 380          */
 381         urb = usb_alloc_urb(0, GFP_KERNEL);
 382         if (!urb)
 383                 return;
 384
 385         transfer_buffer = kmalloc(1, GFP_KERNEL);
 386         if (!transfer_buffer)
 387                 goto err_buf;
 388
 389         *transfer_buffer = ir_xbof | ir_baud;
 390
 391         usb_fill_bulk_urb(
 392                 urb,
 393                 port->serial->dev,
 394                 usb_sndbulkpipe(port->serial->dev,
 395                         port->bulk_out_endpointAddress),
 396                 transfer_buffer,
 397                 1,
 398                 ir_set_termios_callback,
 399                 port);
 400
 401         urb->transfer_flags = URB_ZERO_PACKET;
 402
 403         result = usb_submit_urb(urb, GFP_KERNEL);
 404         if (result) {
 405                 dev_err(&port->dev, "%s - failed to submit urb: %d\n",
 406                                                         __func__, result);
 407                 goto err_subm;
 408         }
 409
 410         usb_free_urb(urb);
 411
 412         return;
 413 err_subm:
 414         kfree(transfer_buffer);
 415 err_buf:
 416         usb_free_urb(urb);
 417 }
 418
 419 static int __init ir_init(void)
 420 {
 421         if (buffer_size) {
 422                 ir_device.bulk_in_size = buffer_size;
 423                 ir_device.bulk_out_size = buffer_size;
 424         }
 425
 426         return usb_serial_register_drivers(serial_drivers, KBUILD_MODNAME, ir_id_table);
 427 }
 428
 429 static void __exit ir_exit(void)
 430 {
 431         usb_serial_deregister_drivers(serial_drivers);
 432 }
 433
 434
 435 module_init(ir_init);
 436 module_exit(ir_exit);
 437
 438 MODULE_AUTHOR(DRIVER_AUTHOR);
 439 MODULE_DESCRIPTION(DRIVER_DESC);
 440 MODULE_LICENSE("GPL");
 441
 442 module_param(xbof, int, 0);
 443 MODULE_PARM_DESC(xbof, "Force specific number of XBOFs");
 444 module_param(buffer_size, int, 0);
 445 MODULE_PARM_DESC(buffer_size, "Size of the transfer buffers");
 446