11da177e4SLinus Torvalds /* 21da177e4SLinus Torvalds * USB Serial Converter Generic functions 31da177e4SLinus Torvalds * 41da177e4SLinus Torvalds * Copyright (C) 1999 - 2002 Greg Kroah-Hartman (greg@kroah.com) 51da177e4SLinus Torvalds * 61da177e4SLinus Torvalds * This program is free software; you can redistribute it and/or 71da177e4SLinus Torvalds * modify it under the terms of the GNU General Public License version 81da177e4SLinus Torvalds * 2 as published by the Free Software Foundation. 91da177e4SLinus Torvalds * 101da177e4SLinus Torvalds */ 111da177e4SLinus Torvalds 121da177e4SLinus Torvalds #include <linux/config.h> 131da177e4SLinus Torvalds #include <linux/kernel.h> 141da177e4SLinus Torvalds #include <linux/errno.h> 151da177e4SLinus Torvalds #include <linux/slab.h> 161da177e4SLinus Torvalds #include <linux/tty.h> 171da177e4SLinus Torvalds #include <linux/tty_flip.h> 181da177e4SLinus Torvalds #include <linux/module.h> 191da177e4SLinus Torvalds #include <linux/moduleparam.h> 201da177e4SLinus Torvalds #include <linux/usb.h> 211da177e4SLinus Torvalds #include <asm/uaccess.h> 221da177e4SLinus Torvalds #include "usb-serial.h" 231da177e4SLinus Torvalds 241da177e4SLinus Torvalds static int debug; 251da177e4SLinus Torvalds 261da177e4SLinus Torvalds #ifdef CONFIG_USB_SERIAL_GENERIC 271da177e4SLinus Torvalds static __u16 vendor = 0x05f9; 281da177e4SLinus Torvalds static __u16 product = 0xffff; 291da177e4SLinus Torvalds 301da177e4SLinus Torvalds module_param(vendor, ushort, 0); 311da177e4SLinus Torvalds MODULE_PARM_DESC(vendor, "User specified USB idVendor"); 321da177e4SLinus Torvalds 331da177e4SLinus Torvalds module_param(product, ushort, 0); 341da177e4SLinus Torvalds MODULE_PARM_DESC(product, "User specified USB idProduct"); 351da177e4SLinus Torvalds 361da177e4SLinus Torvalds static struct usb_device_id generic_device_ids[2]; /* Initially all zeroes. */ 371da177e4SLinus Torvalds 381da177e4SLinus Torvalds /* All of the device info needed for the Generic Serial Converter */ 391da177e4SLinus Torvalds struct usb_serial_device_type usb_serial_generic_device = { 401da177e4SLinus Torvalds .owner = THIS_MODULE, 411da177e4SLinus Torvalds .name = "Generic", 421da177e4SLinus Torvalds .short_name = "generic", 431da177e4SLinus Torvalds .id_table = generic_device_ids, 441da177e4SLinus Torvalds .num_interrupt_in = NUM_DONT_CARE, 451da177e4SLinus Torvalds .num_bulk_in = NUM_DONT_CARE, 461da177e4SLinus Torvalds .num_bulk_out = NUM_DONT_CARE, 471da177e4SLinus Torvalds .num_ports = 1, 481da177e4SLinus Torvalds .shutdown = usb_serial_generic_shutdown, 491da177e4SLinus Torvalds }; 501da177e4SLinus Torvalds 511da177e4SLinus Torvalds /* we want to look at all devices, as the vendor/product id can change 521da177e4SLinus Torvalds * depending on the command line argument */ 531da177e4SLinus Torvalds static struct usb_device_id generic_serial_ids[] = { 541da177e4SLinus Torvalds {.driver_info = 42}, 551da177e4SLinus Torvalds {} 561da177e4SLinus Torvalds }; 571da177e4SLinus Torvalds 581da177e4SLinus Torvalds static int generic_probe(struct usb_interface *interface, 591da177e4SLinus Torvalds const struct usb_device_id *id) 601da177e4SLinus Torvalds { 611da177e4SLinus Torvalds const struct usb_device_id *id_pattern; 621da177e4SLinus Torvalds 631da177e4SLinus Torvalds id_pattern = usb_match_id(interface, generic_device_ids); 641da177e4SLinus Torvalds if (id_pattern != NULL) 651da177e4SLinus Torvalds return usb_serial_probe(interface, id); 661da177e4SLinus Torvalds return -ENODEV; 671da177e4SLinus Torvalds } 681da177e4SLinus Torvalds 691da177e4SLinus Torvalds static struct usb_driver generic_driver = { 701da177e4SLinus Torvalds .owner = THIS_MODULE, 711da177e4SLinus Torvalds .name = "usbserial_generic", 721da177e4SLinus Torvalds .probe = generic_probe, 731da177e4SLinus Torvalds .disconnect = usb_serial_disconnect, 741da177e4SLinus Torvalds .id_table = generic_serial_ids, 751da177e4SLinus Torvalds }; 761da177e4SLinus Torvalds #endif 771da177e4SLinus Torvalds 781da177e4SLinus Torvalds int usb_serial_generic_register (int _debug) 791da177e4SLinus Torvalds { 801da177e4SLinus Torvalds int retval = 0; 811da177e4SLinus Torvalds 821da177e4SLinus Torvalds debug = _debug; 831da177e4SLinus Torvalds #ifdef CONFIG_USB_SERIAL_GENERIC 841da177e4SLinus Torvalds generic_device_ids[0].idVendor = vendor; 851da177e4SLinus Torvalds generic_device_ids[0].idProduct = product; 861da177e4SLinus Torvalds generic_device_ids[0].match_flags = USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT; 871da177e4SLinus Torvalds 881da177e4SLinus Torvalds /* register our generic driver with ourselves */ 891da177e4SLinus Torvalds retval = usb_serial_register (&usb_serial_generic_device); 901da177e4SLinus Torvalds if (retval) 911da177e4SLinus Torvalds goto exit; 921da177e4SLinus Torvalds retval = usb_register(&generic_driver); 931da177e4SLinus Torvalds if (retval) 941da177e4SLinus Torvalds usb_serial_deregister(&usb_serial_generic_device); 951da177e4SLinus Torvalds exit: 961da177e4SLinus Torvalds #endif 971da177e4SLinus Torvalds return retval; 981da177e4SLinus Torvalds } 991da177e4SLinus Torvalds 1001da177e4SLinus Torvalds void usb_serial_generic_deregister (void) 1011da177e4SLinus Torvalds { 1021da177e4SLinus Torvalds #ifdef CONFIG_USB_SERIAL_GENERIC 1031da177e4SLinus Torvalds /* remove our generic driver */ 1041da177e4SLinus Torvalds usb_deregister(&generic_driver); 1051da177e4SLinus Torvalds usb_serial_deregister (&usb_serial_generic_device); 1061da177e4SLinus Torvalds #endif 1071da177e4SLinus Torvalds } 1081da177e4SLinus Torvalds 1091da177e4SLinus Torvalds int usb_serial_generic_open (struct usb_serial_port *port, struct file *filp) 1101da177e4SLinus Torvalds { 1111da177e4SLinus Torvalds struct usb_serial *serial = port->serial; 1121da177e4SLinus Torvalds int result = 0; 1131da177e4SLinus Torvalds 1141da177e4SLinus Torvalds dbg("%s - port %d", __FUNCTION__, port->number); 1151da177e4SLinus Torvalds 1161da177e4SLinus Torvalds /* force low_latency on so that our tty_push actually forces the data through, 1171da177e4SLinus Torvalds otherwise it is scheduled, and with high data rates (like with OHCI) data 1181da177e4SLinus Torvalds can get lost. */ 1191da177e4SLinus Torvalds if (port->tty) 1201da177e4SLinus Torvalds port->tty->low_latency = 1; 1211da177e4SLinus Torvalds 1221da177e4SLinus Torvalds /* if we have a bulk interrupt, start reading from it */ 1231da177e4SLinus Torvalds if (serial->num_bulk_in) { 1241da177e4SLinus Torvalds /* Start reading from the device */ 1251da177e4SLinus Torvalds usb_fill_bulk_urb (port->read_urb, serial->dev, 1261da177e4SLinus Torvalds usb_rcvbulkpipe(serial->dev, port->bulk_in_endpointAddress), 1271da177e4SLinus Torvalds port->read_urb->transfer_buffer, 1281da177e4SLinus Torvalds port->read_urb->transfer_buffer_length, 1291da177e4SLinus Torvalds ((serial->type->read_bulk_callback) ? 1301da177e4SLinus Torvalds serial->type->read_bulk_callback : 1311da177e4SLinus Torvalds usb_serial_generic_read_bulk_callback), 1321da177e4SLinus Torvalds port); 1331da177e4SLinus Torvalds result = usb_submit_urb(port->read_urb, GFP_KERNEL); 1341da177e4SLinus Torvalds if (result) 1351da177e4SLinus Torvalds dev_err(&port->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result); 1361da177e4SLinus Torvalds } 1371da177e4SLinus Torvalds 1381da177e4SLinus Torvalds return result; 1391da177e4SLinus Torvalds } 1401da177e4SLinus Torvalds 1411da177e4SLinus Torvalds static void generic_cleanup (struct usb_serial_port *port) 1421da177e4SLinus Torvalds { 1431da177e4SLinus Torvalds struct usb_serial *serial = port->serial; 1441da177e4SLinus Torvalds 1451da177e4SLinus Torvalds dbg("%s - port %d", __FUNCTION__, port->number); 1461da177e4SLinus Torvalds 1471da177e4SLinus Torvalds if (serial->dev) { 1481da177e4SLinus Torvalds /* shutdown any bulk reads that might be going on */ 1491da177e4SLinus Torvalds if (serial->num_bulk_out) 1501da177e4SLinus Torvalds usb_kill_urb(port->write_urb); 1511da177e4SLinus Torvalds if (serial->num_bulk_in) 1521da177e4SLinus Torvalds usb_kill_urb(port->read_urb); 1531da177e4SLinus Torvalds } 1541da177e4SLinus Torvalds } 1551da177e4SLinus Torvalds 1561da177e4SLinus Torvalds void usb_serial_generic_close (struct usb_serial_port *port, struct file * filp) 1571da177e4SLinus Torvalds { 1581da177e4SLinus Torvalds dbg("%s - port %d", __FUNCTION__, port->number); 1591da177e4SLinus Torvalds generic_cleanup (port); 1601da177e4SLinus Torvalds } 1611da177e4SLinus Torvalds 1621da177e4SLinus Torvalds int usb_serial_generic_write(struct usb_serial_port *port, const unsigned char *buf, int count) 1631da177e4SLinus Torvalds { 1641da177e4SLinus Torvalds struct usb_serial *serial = port->serial; 1651da177e4SLinus Torvalds int result; 1661da177e4SLinus Torvalds unsigned char *data; 1671da177e4SLinus Torvalds 1681da177e4SLinus Torvalds dbg("%s - port %d", __FUNCTION__, port->number); 1691da177e4SLinus Torvalds 1701da177e4SLinus Torvalds if (count == 0) { 1711da177e4SLinus Torvalds dbg("%s - write request of 0 bytes", __FUNCTION__); 1721da177e4SLinus Torvalds return (0); 1731da177e4SLinus Torvalds } 1741da177e4SLinus Torvalds 1751da177e4SLinus Torvalds /* only do something if we have a bulk out endpoint */ 1761da177e4SLinus Torvalds if (serial->num_bulk_out) { 177507ca9bcSGreg Kroah-Hartman spin_lock(&port->lock); 178507ca9bcSGreg Kroah-Hartman if (port->write_urb_busy) { 179507ca9bcSGreg Kroah-Hartman spin_unlock(&port->lock); 1801da177e4SLinus Torvalds dbg("%s - already writing", __FUNCTION__); 181507ca9bcSGreg Kroah-Hartman return 0; 1821da177e4SLinus Torvalds } 183507ca9bcSGreg Kroah-Hartman port->write_urb_busy = 1; 184507ca9bcSGreg Kroah-Hartman spin_unlock(&port->lock); 1851da177e4SLinus Torvalds 1861da177e4SLinus Torvalds count = (count > port->bulk_out_size) ? port->bulk_out_size : count; 1871da177e4SLinus Torvalds 1881da177e4SLinus Torvalds memcpy (port->write_urb->transfer_buffer, buf, count); 1891da177e4SLinus Torvalds data = port->write_urb->transfer_buffer; 1901da177e4SLinus Torvalds usb_serial_debug_data(debug, &port->dev, __FUNCTION__, count, data); 1911da177e4SLinus Torvalds 1921da177e4SLinus Torvalds /* set up our urb */ 1931da177e4SLinus Torvalds usb_fill_bulk_urb (port->write_urb, serial->dev, 1941da177e4SLinus Torvalds usb_sndbulkpipe (serial->dev, 1951da177e4SLinus Torvalds port->bulk_out_endpointAddress), 1961da177e4SLinus Torvalds port->write_urb->transfer_buffer, count, 1971da177e4SLinus Torvalds ((serial->type->write_bulk_callback) ? 1981da177e4SLinus Torvalds serial->type->write_bulk_callback : 1991da177e4SLinus Torvalds usb_serial_generic_write_bulk_callback), port); 2001da177e4SLinus Torvalds 2011da177e4SLinus Torvalds /* send the data out the bulk port */ 202507ca9bcSGreg Kroah-Hartman port->write_urb_busy = 1; 2031da177e4SLinus Torvalds result = usb_submit_urb(port->write_urb, GFP_ATOMIC); 204507ca9bcSGreg Kroah-Hartman if (result) { 2051da177e4SLinus Torvalds dev_err(&port->dev, "%s - failed submitting write urb, error %d\n", __FUNCTION__, result); 206507ca9bcSGreg Kroah-Hartman /* don't have to grab the lock here, as we will retry if != 0 */ 207507ca9bcSGreg Kroah-Hartman port->write_urb_busy = 0; 208507ca9bcSGreg Kroah-Hartman } else 2091da177e4SLinus Torvalds result = count; 2101da177e4SLinus Torvalds 2111da177e4SLinus Torvalds return result; 2121da177e4SLinus Torvalds } 2131da177e4SLinus Torvalds 2141da177e4SLinus Torvalds /* no bulk out, so return 0 bytes written */ 215507ca9bcSGreg Kroah-Hartman return 0; 2161da177e4SLinus Torvalds } 2171da177e4SLinus Torvalds 2181da177e4SLinus Torvalds int usb_serial_generic_write_room (struct usb_serial_port *port) 2191da177e4SLinus Torvalds { 2201da177e4SLinus Torvalds struct usb_serial *serial = port->serial; 2211da177e4SLinus Torvalds int room = 0; 2221da177e4SLinus Torvalds 2231da177e4SLinus Torvalds dbg("%s - port %d", __FUNCTION__, port->number); 2241da177e4SLinus Torvalds 2251da177e4SLinus Torvalds if (serial->num_bulk_out) { 2267a3ca7d2SRandall Nortman if (!(port->write_urb_busy)) 2271da177e4SLinus Torvalds room = port->bulk_out_size; 2281da177e4SLinus Torvalds } 2291da177e4SLinus Torvalds 2301da177e4SLinus Torvalds dbg("%s - returns %d", __FUNCTION__, room); 2311da177e4SLinus Torvalds return (room); 2321da177e4SLinus Torvalds } 2331da177e4SLinus Torvalds 2341da177e4SLinus Torvalds int usb_serial_generic_chars_in_buffer (struct usb_serial_port *port) 2351da177e4SLinus Torvalds { 2361da177e4SLinus Torvalds struct usb_serial *serial = port->serial; 2371da177e4SLinus Torvalds int chars = 0; 2381da177e4SLinus Torvalds 2391da177e4SLinus Torvalds dbg("%s - port %d", __FUNCTION__, port->number); 2401da177e4SLinus Torvalds 2411da177e4SLinus Torvalds if (serial->num_bulk_out) { 242507ca9bcSGreg Kroah-Hartman if (port->write_urb_busy) 2431da177e4SLinus Torvalds chars = port->write_urb->transfer_buffer_length; 2441da177e4SLinus Torvalds } 2451da177e4SLinus Torvalds 2461da177e4SLinus Torvalds dbg("%s - returns %d", __FUNCTION__, chars); 2471da177e4SLinus Torvalds return (chars); 2481da177e4SLinus Torvalds } 2491da177e4SLinus Torvalds 2501da177e4SLinus Torvalds void usb_serial_generic_read_bulk_callback (struct urb *urb, struct pt_regs *regs) 2511da177e4SLinus Torvalds { 2521da177e4SLinus Torvalds struct usb_serial_port *port = (struct usb_serial_port *)urb->context; 2531da177e4SLinus Torvalds struct usb_serial *serial = port->serial; 2541da177e4SLinus Torvalds struct tty_struct *tty; 2551da177e4SLinus Torvalds unsigned char *data = urb->transfer_buffer; 2561da177e4SLinus Torvalds int i; 2571da177e4SLinus Torvalds int result; 2581da177e4SLinus Torvalds 2591da177e4SLinus Torvalds dbg("%s - port %d", __FUNCTION__, port->number); 2601da177e4SLinus Torvalds 2611da177e4SLinus Torvalds if (urb->status) { 2621da177e4SLinus Torvalds dbg("%s - nonzero read bulk status received: %d", __FUNCTION__, urb->status); 2631da177e4SLinus Torvalds return; 2641da177e4SLinus Torvalds } 2651da177e4SLinus Torvalds 2661da177e4SLinus Torvalds usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data); 2671da177e4SLinus Torvalds 2681da177e4SLinus Torvalds tty = port->tty; 2691da177e4SLinus Torvalds if (tty && urb->actual_length) { 2701da177e4SLinus Torvalds for (i = 0; i < urb->actual_length ; ++i) { 2711da177e4SLinus Torvalds /* if we insert more than TTY_FLIPBUF_SIZE characters, we drop them. */ 2721da177e4SLinus Torvalds if(tty->flip.count >= TTY_FLIPBUF_SIZE) { 2731da177e4SLinus Torvalds tty_flip_buffer_push(tty); 2741da177e4SLinus Torvalds } 2751da177e4SLinus Torvalds /* this doesn't actually push the data through unless tty->low_latency is set */ 2761da177e4SLinus Torvalds tty_insert_flip_char(tty, data[i], 0); 2771da177e4SLinus Torvalds } 2781da177e4SLinus Torvalds tty_flip_buffer_push(tty); 2791da177e4SLinus Torvalds } 2801da177e4SLinus Torvalds 2811da177e4SLinus Torvalds /* Continue trying to always read */ 2821da177e4SLinus Torvalds usb_fill_bulk_urb (port->read_urb, serial->dev, 2831da177e4SLinus Torvalds usb_rcvbulkpipe (serial->dev, 2841da177e4SLinus Torvalds port->bulk_in_endpointAddress), 2851da177e4SLinus Torvalds port->read_urb->transfer_buffer, 2861da177e4SLinus Torvalds port->read_urb->transfer_buffer_length, 2871da177e4SLinus Torvalds ((serial->type->read_bulk_callback) ? 2881da177e4SLinus Torvalds serial->type->read_bulk_callback : 2891da177e4SLinus Torvalds usb_serial_generic_read_bulk_callback), port); 2901da177e4SLinus Torvalds result = usb_submit_urb(port->read_urb, GFP_ATOMIC); 2911da177e4SLinus Torvalds if (result) 2921da177e4SLinus Torvalds dev_err(&port->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result); 2931da177e4SLinus Torvalds } 2941da177e4SLinus Torvalds 2951da177e4SLinus Torvalds void usb_serial_generic_write_bulk_callback (struct urb *urb, struct pt_regs *regs) 2961da177e4SLinus Torvalds { 2971da177e4SLinus Torvalds struct usb_serial_port *port = (struct usb_serial_port *)urb->context; 2981da177e4SLinus Torvalds 2991da177e4SLinus Torvalds dbg("%s - port %d", __FUNCTION__, port->number); 3001da177e4SLinus Torvalds 301507ca9bcSGreg Kroah-Hartman port->write_urb_busy = 0; 3021da177e4SLinus Torvalds if (urb->status) { 3031da177e4SLinus Torvalds dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status); 3041da177e4SLinus Torvalds return; 3051da177e4SLinus Torvalds } 3061da177e4SLinus Torvalds 3071da177e4SLinus Torvalds usb_serial_port_softint((void *)port); 3081da177e4SLinus Torvalds 3091da177e4SLinus Torvalds schedule_work(&port->work); 3101da177e4SLinus Torvalds } 3111da177e4SLinus Torvalds 3121da177e4SLinus Torvalds void usb_serial_generic_shutdown (struct usb_serial *serial) 3131da177e4SLinus Torvalds { 3141da177e4SLinus Torvalds int i; 3151da177e4SLinus Torvalds 3161da177e4SLinus Torvalds dbg("%s", __FUNCTION__); 3171da177e4SLinus Torvalds 3181da177e4SLinus Torvalds /* stop reads and writes on all ports */ 3191da177e4SLinus Torvalds for (i=0; i < serial->num_ports; ++i) { 3201da177e4SLinus Torvalds generic_cleanup(serial->port[i]); 3211da177e4SLinus Torvalds } 3221da177e4SLinus Torvalds } 3231da177e4SLinus Torvalds 324