drivers/usb/serial/generic.c

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