drivers/usb/serial/generic.c

   1 /*
   2  * USB Serial Converter Generic functions
   3  *
   4  * Copyright (C) 1999 - 2002 Greg Kroah-Hartman (greg@kroah.com)
   5  *
   6  *      This program is free software; you can redistribute it and/or
   7  *      modify it under the terms of the GNU General Public License version
   8  *      2 as published by the Free Software Foundation.
   9  *
  10  */
  11
  12 #include <linux/kernel.h>
  13 #include <linux/errno.h>
  14 #include <linux/slab.h>
  15 #include <linux/tty.h>
  16 #include <linux/tty_flip.h>
  17 #include <linux/module.h>
  18 #include <linux/moduleparam.h>
  19 #include <linux/usb.h>
  20 #include <linux/usb/serial.h>
  21 #include <linux/uaccess.h>
  22 #include <linux/kfifo.h>
  23 #include <linux/serial.h>
  24
  25 static int debug;
  26
  27 #ifdef CONFIG_USB_SERIAL_GENERIC
  28
  29 static int generic_probe(struct usb_interface *interface,
  30                          const struct usb_device_id *id);
  31
  32 static __u16 vendor  = 0x05f9;
  33 static __u16 product = 0xffff;
  34
  35 module_param(vendor, ushort, 0);
  36 MODULE_PARM_DESC(vendor, "User specified USB idVendor");
  37
  38 module_param(product, ushort, 0);
  39 MODULE_PARM_DESC(product, "User specified USB idProduct");
  40
  41 static struct usb_device_id generic_device_ids[2]; /* Initially all zeroes. */
  42
  43 /* we want to look at all devices, as the vendor/product id can change
  44  * depending on the command line argument */
  45 static const struct usb_device_id generic_serial_ids[] = {
  46         {.driver_info = 42},
  47         {}
  48 };
  49
  50 static struct usb_driver generic_driver = {
  51         .name =         "usbserial_generic",
  52         .probe =        generic_probe,
  53         .disconnect =   usb_serial_disconnect,
  54         .id_table =     generic_serial_ids,
  55         .no_dynamic_id =        1,
  56 };
  57
  58 /* All of the device info needed for the Generic Serial Converter */
  59 struct usb_serial_driver usb_serial_generic_device = {
  60         .driver = {
  61                 .owner =        THIS_MODULE,
  62                 .name =         "generic",
  63         },
  64         .id_table =             generic_device_ids,
  65         .usb_driver =           &generic_driver,
  66         .num_ports =            1,
  67         .disconnect =           usb_serial_generic_disconnect,
  68         .release =              usb_serial_generic_release,
  69         .throttle =             usb_serial_generic_throttle,
  70         .unthrottle =           usb_serial_generic_unthrottle,
  71         .resume =               usb_serial_generic_resume,
  72 };
  73
  74 static int generic_probe(struct usb_interface *interface,
  75                                const struct usb_device_id *id)
  76 {
  77         const struct usb_device_id *id_pattern;
  78
  79         id_pattern = usb_match_id(interface, generic_device_ids);
  80         if (id_pattern != NULL)
  81                 return usb_serial_probe(interface, id);
  82         return -ENODEV;
  83 }
  84 #endif
  85
  86 int usb_serial_generic_register(int _debug)
  87 {
  88         int retval = 0;
  89
  90         debug = _debug;
  91 #ifdef CONFIG_USB_SERIAL_GENERIC
  92         generic_device_ids[0].idVendor = vendor;
  93         generic_device_ids[0].idProduct = product;
  94         generic_device_ids[0].match_flags =
  95                 USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT;
  96
  97         /* register our generic driver with ourselves */
  98         retval = usb_serial_register(&usb_serial_generic_device);
  99         if (retval)
 100                 goto exit;
 101         retval = usb_register(&generic_driver);
 102         if (retval)
 103                 usb_serial_deregister(&usb_serial_generic_device);
 104 exit:
 105 #endif
 106         return retval;
 107 }
 108
 109 void usb_serial_generic_deregister(void)
 110 {
 111 #ifdef CONFIG_USB_SERIAL_GENERIC
 112         /* remove our generic driver */
 113         usb_deregister(&generic_driver);
 114         usb_serial_deregister(&usb_serial_generic_device);
 115 #endif
 116 }
 117
 118 int usb_serial_generic_open(struct tty_struct *tty, struct usb_serial_port *port)
 119 {
 120         struct usb_serial *serial = port->serial;
 121         int result = 0;
 122         unsigned long flags;
 123
 124         dbg("%s - port %d", __func__, port->number);
 125
 126         /* clear the throttle flags */
 127         spin_lock_irqsave(&port->lock, flags);
 128         port->throttled = 0;
 129         port->throttle_req = 0;
 130         spin_unlock_irqrestore(&port->lock, flags);
 131
 132         /* if we have a bulk endpoint, start reading from it */
 133         if (serial->num_bulk_in) {
 134                 /* Start reading from the device */
 135                 usb_fill_bulk_urb(port->read_urb, serial->dev,
 136                                    usb_rcvbulkpipe(serial->dev,
 137                                                 port->bulk_in_endpointAddress),
 138                                    port->read_urb->transfer_buffer,
 139                                    port->read_urb->transfer_buffer_length,
 140                                    ((serial->type->read_bulk_callback) ?
 141                                      serial->type->read_bulk_callback :
 142                                      usb_serial_generic_read_bulk_callback),
 143                                    port);
 144                 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
 145                 if (result)
 146                         dev_err(&port->dev,
 147                             "%s - failed resubmitting read urb, error %d\n",
 148                                                         __func__, result);
 149         }
 150
 151         return result;
 152 }
 153 EXPORT_SYMBOL_GPL(usb_serial_generic_open);
 154
 155 static void generic_cleanup(struct usb_serial_port *port)
 156 {
 157         struct usb_serial *serial = port->serial;
 158
 159         dbg("%s - port %d", __func__, port->number);
 160
 161         if (serial->dev) {
 162                 /* shutdown any bulk reads that might be going on */
 163                 if (serial->num_bulk_out)
 164                         usb_kill_urb(port->write_urb);
 165                 if (serial->num_bulk_in)
 166                         usb_kill_urb(port->read_urb);
 167         }
 168 }
 169
 170 void usb_serial_generic_close(struct usb_serial_port *port)
 171 {
 172         dbg("%s - port %d", __func__, port->number);
 173         generic_cleanup(port);
 174 }
 175
 176 static int usb_serial_multi_urb_write(struct tty_struct *tty,
 177         struct usb_serial_port *port, const unsigned char *buf, int count)
 178 {
 179         unsigned long flags;
 180         struct urb *urb;
 181         unsigned char *buffer;
 182         int status;
 183         int towrite;
 184         int bwrite = 0;
 185
 186         dbg("%s - port %d", __func__, port->number);
 187
 188         if (count == 0)
 189                 dbg("%s - write request of 0 bytes", __func__);
 190
 191         while (count > 0) {
 192                 towrite = (count > port->bulk_out_size) ?
 193                         port->bulk_out_size : count;
 194                 spin_lock_irqsave(&port->lock, flags);
 195                 if (port->urbs_in_flight >
 196                     port->serial->type->max_in_flight_urbs) {
 197                         spin_unlock_irqrestore(&port->lock, flags);
 198                         dbg("%s - write limit hit", __func__);
 199                         return bwrite;
 200                 }
 201                 port->tx_bytes_flight += towrite;
 202                 port->urbs_in_flight++;
 203                 spin_unlock_irqrestore(&port->lock, flags);
 204
 205                 buffer = kmalloc(towrite, GFP_ATOMIC);
 206                 if (!buffer) {
 207                         dev_err(&port->dev,
 208                         "%s ran out of kernel memory for urb ...\n", __func__);
 209                         goto error_no_buffer;
 210                 }
 211
 212                 urb = usb_alloc_urb(0, GFP_ATOMIC);
 213                 if (!urb) {
 214                         dev_err(&port->dev, "%s - no more free urbs\n",
 215                                 __func__);
 216                         goto error_no_urb;
 217                 }
 218
 219                 /* Copy data */
 220                 memcpy(buffer, buf + bwrite, towrite);
 221                 usb_serial_debug_data(debug, &port->dev, __func__,
 222                                       towrite, buffer);
 223                 /* fill the buffer and send it */
 224                 usb_fill_bulk_urb(urb, port->serial->dev,
 225                         usb_sndbulkpipe(port->serial->dev,
 226                                         port->bulk_out_endpointAddress),
 227                         buffer, towrite,
 228                         usb_serial_generic_write_bulk_callback, port);
 229
 230                 status = usb_submit_urb(urb, GFP_ATOMIC);
 231                 if (status) {
 232                         dev_err(&port->dev,
 233                                 "%s - failed submitting write urb, error %d\n",
 234                                 __func__, status);
 235                         goto error;
 236                 }
 237
 238                 /* This urb is the responsibility of the host driver now */
 239                 usb_free_urb(urb);
 240                 dbg("%s write: %d", __func__, towrite);
 241                 count -= towrite;
 242                 bwrite += towrite;
 243         }
 244         return bwrite;
 245
 246 error:
 247         usb_free_urb(urb);
 248 error_no_urb:
 249         kfree(buffer);
 250 error_no_buffer:
 251         spin_lock_irqsave(&port->lock, flags);
 252         port->urbs_in_flight--;
 253         port->tx_bytes_flight -= towrite;
 254         spin_unlock_irqrestore(&port->lock, flags);
 255         return bwrite;
 256 }
 257
 258 /**
 259  * usb_serial_generic_write_start - kick off an URB write
 260  * @port:       Pointer to the &struct usb_serial_port data
 261  *
 262  * Returns the number of bytes queued on success. This will be zero if there
 263  * was nothing to send. Otherwise, it returns a negative errno value
 264  */
 265 static int usb_serial_generic_write_start(struct usb_serial_port *port)
 266 {
 267         struct usb_serial *serial = port->serial;
 268         unsigned char *data;
 269         int result;
 270         int count;
 271         unsigned long flags;
 272         bool start_io;
 273
 274         /* Atomically determine whether we can and need to start a USB
 275          * operation. */
 276         spin_lock_irqsave(&port->lock, flags);
 277         if (port->write_urb_busy)
 278                 start_io = false;
 279         else {
 280                 start_io = (kfifo_len(&port->write_fifo) != 0);
 281                 port->write_urb_busy = start_io;
 282         }
 283         spin_unlock_irqrestore(&port->lock, flags);
 284
 285         if (!start_io)
 286                 return 0;
 287
 288         data = port->write_urb->transfer_buffer;
 289         count = kfifo_out_locked(&port->write_fifo, data, port->bulk_out_size, &port->lock);
 290         usb_serial_debug_data(debug, &port->dev, __func__, count, data);
 291
 292         /* set up our urb */
 293         usb_fill_bulk_urb(port->write_urb, serial->dev,
 294                            usb_sndbulkpipe(serial->dev,
 295                                 port->bulk_out_endpointAddress),
 296                            port->write_urb->transfer_buffer, count,
 297                            ((serial->type->write_bulk_callback) ?
 298                              serial->type->write_bulk_callback :
 299                              usb_serial_generic_write_bulk_callback),
 300                            port);
 301
 302         /* send the data out the bulk port */
 303         result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
 304         if (result) {
 305                 dev_err(&port->dev,
 306                         "%s - failed submitting write urb, error %d\n",
 307                                                 __func__, result);
 308                 /* don't have to grab the lock here, as we will
 309                    retry if != 0 */
 310                 port->write_urb_busy = 0;
 311         } else
 312                 result = count;
 313
 314         return result;
 315 }
 316
 317 /**
 318  * usb_serial_generic_write - generic write function for serial USB devices
 319  * @tty:        Pointer to &struct tty_struct for the device
 320  * @port:       Pointer to the &usb_serial_port structure for the device
 321  * @buf:        Pointer to the data to write
 322  * @count:      Number of bytes to write
 323  *
 324  * Returns the number of characters actually written, which may be anything
 325  * from zero to @count. If an error occurs, it returns the negative errno
 326  * value.
 327  */
 328 int usb_serial_generic_write(struct tty_struct *tty,
 329         struct usb_serial_port *port, const unsigned char *buf, int count)
 330 {
 331         struct usb_serial *serial = port->serial;
 332         int result;
 333
 334         dbg("%s - port %d", __func__, port->number);
 335
 336         if (count == 0) {
 337                 dbg("%s - write request of 0 bytes", __func__);
 338                 return 0;
 339         }
 340
 341         /* only do something if we have a bulk out endpoint */
 342         if (!serial->num_bulk_out)
 343                 return 0;
 344
 345         if (serial->type->max_in_flight_urbs)
 346                 return usb_serial_multi_urb_write(tty, port,
 347                                                   buf, count);
 348
 349         count = kfifo_in_locked(&port->write_fifo, buf, count, &port->lock);
 350         result = usb_serial_generic_write_start(port);
 351
 352         if (result >= 0)
 353                 result = count;
 354
 355         return result;
 356 }
 357 EXPORT_SYMBOL_GPL(usb_serial_generic_write);
 358
 359 int usb_serial_generic_write_room(struct tty_struct *tty)
 360 {
 361         struct usb_serial_port *port = tty->driver_data;
 362         struct usb_serial *serial = port->serial;
 363         unsigned long flags;
 364         int room = 0;
 365
 366         dbg("%s - port %d", __func__, port->number);
 367         spin_lock_irqsave(&port->lock, flags);
 368         if (serial->type->max_in_flight_urbs) {
 369                 if (port->urbs_in_flight < serial->type->max_in_flight_urbs)
 370                         room = port->bulk_out_size *
 371                                 (serial->type->max_in_flight_urbs -
 372                                  port->urbs_in_flight);
 373         } else if (serial->num_bulk_out)
 374                 room = kfifo_avail(&port->write_fifo);
 375         spin_unlock_irqrestore(&port->lock, flags);
 376
 377         dbg("%s - returns %d", __func__, room);
 378         return room;
 379 }
 380
 381 int usb_serial_generic_chars_in_buffer(struct tty_struct *tty)
 382 {
 383         struct usb_serial_port *port = tty->driver_data;
 384         struct usb_serial *serial = port->serial;
 385         int chars = 0;
 386         unsigned long flags;
 387
 388         dbg("%s - port %d", __func__, port->number);
 389
 390         spin_lock_irqsave(&port->lock, flags);
 391         if (serial->type->max_in_flight_urbs)
 392                 chars = port->tx_bytes_flight;
 393         else if (serial->num_bulk_out)
 394                 chars = kfifo_len(&port->write_fifo);
 395         spin_unlock_irqrestore(&port->lock, flags);
 396
 397         dbg("%s - returns %d", __func__, chars);
 398         return chars;
 399 }
 400
 401
 402 void usb_serial_generic_resubmit_read_urb(struct usb_serial_port *port,
 403                         gfp_t mem_flags)
 404 {
 405         struct urb *urb = port->read_urb;
 406         struct usb_serial *serial = port->serial;
 407         int result;
 408
 409         /* Continue reading from device */
 410         usb_fill_bulk_urb(urb, serial->dev,
 411                            usb_rcvbulkpipe(serial->dev,
 412                                         port->bulk_in_endpointAddress),
 413                            urb->transfer_buffer,
 414                            urb->transfer_buffer_length,
 415                            ((serial->type->read_bulk_callback) ?
 416                              serial->type->read_bulk_callback :
 417                              usb_serial_generic_read_bulk_callback), port);
 418
 419         result = usb_submit_urb(urb, mem_flags);
 420         if (result && result != -EPERM) {
 421                 dev_err(&port->dev,
 422                         "%s - failed resubmitting read urb, error %d\n",
 423                                                         __func__, result);
 424         }
 425 }
 426 EXPORT_SYMBOL_GPL(usb_serial_generic_resubmit_read_urb);
 427
 428 /* Push data to tty layer and resubmit the bulk read URB */
 429 static void flush_and_resubmit_read_urb(struct usb_serial_port *port)
 430 {
 431         struct urb *urb = port->read_urb;
 432         struct tty_struct *tty = tty_port_tty_get(&port->port);
 433         char *ch = (char *)urb->transfer_buffer;
 434         int i;
 435
 436         if (!tty)
 437                 goto done;
 438
 439         /* The per character mucking around with sysrq path it too slow for
 440            stuff like 3G modems, so shortcircuit it in the 99.9999999% of cases
 441            where the USB serial is not a console anyway */
 442         if (!port->console || !port->sysrq)
 443                 tty_insert_flip_string(tty, ch, urb->actual_length);
 444         else {
 445                 /* Push data to tty */
 446                 for (i = 0; i < urb->actual_length; i++, ch++) {
 447                         if (!usb_serial_handle_sysrq_char(tty, port, *ch))
 448                                 tty_insert_flip_char(tty, *ch, TTY_NORMAL);
 449                 }
 450         }
 451         tty_flip_buffer_push(tty);
 452         tty_kref_put(tty);
 453 done:
 454         usb_serial_generic_resubmit_read_urb(port, GFP_ATOMIC);
 455 }
 456
 457 void usb_serial_generic_read_bulk_callback(struct urb *urb)
 458 {
 459         struct usb_serial_port *port = urb->context;
 460         unsigned char *data = urb->transfer_buffer;
 461         int status = urb->status;
 462         unsigned long flags;
 463
 464         dbg("%s - port %d", __func__, port->number);
 465
 466         if (unlikely(status != 0)) {
 467                 dbg("%s - nonzero read bulk status received: %d",
 468                     __func__, status);
 469                 return;
 470         }
 471
 472         usb_serial_debug_data(debug, &port->dev, __func__,
 473                                                 urb->actual_length, data);
 474
 475         /* Throttle the device if requested by tty */
 476         spin_lock_irqsave(&port->lock, flags);
 477         port->throttled = port->throttle_req;
 478         if (!port->throttled) {
 479                 spin_unlock_irqrestore(&port->lock, flags);
 480                 flush_and_resubmit_read_urb(port);
 481         } else
 482                 spin_unlock_irqrestore(&port->lock, flags);
 483 }
 484 EXPORT_SYMBOL_GPL(usb_serial_generic_read_bulk_callback);
 485
 486 void usb_serial_generic_write_bulk_callback(struct urb *urb)
 487 {
 488         unsigned long flags;
 489         struct usb_serial_port *port = urb->context;
 490         int status = urb->status;
 491
 492         dbg("%s - port %d", __func__, port->number);
 493
 494         if (port->serial->type->max_in_flight_urbs) {
 495                 kfree(urb->transfer_buffer);
 496
 497                 spin_lock_irqsave(&port->lock, flags);
 498                 --port->urbs_in_flight;
 499                 port->tx_bytes_flight -= urb->transfer_buffer_length;
 500                 if (port->urbs_in_flight < 0)
 501                         port->urbs_in_flight = 0;
 502                 spin_unlock_irqrestore(&port->lock, flags);
 503
 504                 if (status) {
 505                         dbg("%s - nonzero multi-urb write bulk status "
 506                                 "received: %d", __func__, status);
 507                         return;
 508                 }
 509         } else {
 510                 port->write_urb_busy = 0;
 511
 512                 if (status) {
 513                         dbg("%s - nonzero multi-urb write bulk status "
 514                                 "received: %d", __func__, status);
 515                         kfifo_reset_out(&port->write_fifo);
 516                 } else
 517                         usb_serial_generic_write_start(port);
 518         }
 519
 520         usb_serial_port_softint(port);
 521 }
 522 EXPORT_SYMBOL_GPL(usb_serial_generic_write_bulk_callback);
 523
 524 void usb_serial_generic_throttle(struct tty_struct *tty)
 525 {
 526         struct usb_serial_port *port = tty->driver_data;
 527         unsigned long flags;
 528
 529         dbg("%s - port %d", __func__, port->number);
 530
 531         /* Set the throttle request flag. It will be picked up
 532          * by usb_serial_generic_read_bulk_callback(). */
 533         spin_lock_irqsave(&port->lock, flags);
 534         port->throttle_req = 1;
 535         spin_unlock_irqrestore(&port->lock, flags);
 536 }
 537
 538 void usb_serial_generic_unthrottle(struct tty_struct *tty)
 539 {
 540         struct usb_serial_port *port = tty->driver_data;
 541         int was_throttled;
 542         unsigned long flags;
 543
 544         dbg("%s - port %d", __func__, port->number);
 545
 546         /* Clear the throttle flags */
 547         spin_lock_irqsave(&port->lock, flags);
 548         was_throttled = port->throttled;
 549         port->throttled = port->throttle_req = 0;
 550         spin_unlock_irqrestore(&port->lock, flags);
 551
 552         if (was_throttled) {
 553                 /* Resume reading from device */
 554                 flush_and_resubmit_read_urb(port);
 555         }
 556 }
 557
 558 int usb_serial_handle_sysrq_char(struct tty_struct *tty,
 559                         struct usb_serial_port *port, unsigned int ch)
 560 {
 561         if (port->sysrq && port->console) {
 562                 if (ch && time_before(jiffies, port->sysrq)) {
 563                         handle_sysrq(ch, tty);
 564                         port->sysrq = 0;
 565                         return 1;
 566                 }
 567                 port->sysrq = 0;
 568         }
 569         return 0;
 570 }
 571 EXPORT_SYMBOL_GPL(usb_serial_handle_sysrq_char);
 572
 573 int usb_serial_handle_break(struct usb_serial_port *port)
 574 {
 575         if (!port->sysrq) {
 576                 port->sysrq = jiffies + HZ*5;
 577                 return 1;
 578         }
 579         port->sysrq = 0;
 580         return 0;
 581 }
 582 EXPORT_SYMBOL_GPL(usb_serial_handle_break);
 583
 584 int usb_serial_generic_resume(struct usb_serial *serial)
 585 {
 586         struct usb_serial_port *port;
 587         int i, c = 0, r;
 588
 589         for (i = 0; i < serial->num_ports; i++) {
 590                 port = serial->port[i];
 591                 if (!test_bit(ASYNCB_INITIALIZED, &port->port.flags))
 592                         continue;
 593
 594                 if (port->read_urb) {
 595                         r = usb_submit_urb(port->read_urb, GFP_NOIO);
 596                         if (r < 0)
 597                                 c++;
 598                 }
 599
 600                 if (port->write_urb) {
 601                         r = usb_serial_generic_write_start(port);
 602                         if (r < 0)
 603                                 c++;
 604                 }
 605         }
 606
 607         return c ? -EIO : 0;
 608 }
 609 EXPORT_SYMBOL_GPL(usb_serial_generic_resume);
 610
 611 void usb_serial_generic_disconnect(struct usb_serial *serial)
 612 {
 613         int i;
 614
 615         dbg("%s", __func__);
 616
 617         /* stop reads and writes on all ports */
 618         for (i = 0; i < serial->num_ports; ++i)
 619                 generic_cleanup(serial->port[i]);
 620 }
 621
 622 void usb_serial_generic_release(struct usb_serial *serial)
 623 {
 624         dbg("%s", __func__);
 625 }