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 */ 39ea65370dSGreg Kroah-Hartman struct usb_serial_driver usb_serial_generic_device = { 4018fcac35SGreg Kroah-Hartman .driver = { 411da177e4SLinus Torvalds .owner = THIS_MODULE, 42269bda1cSGreg Kroah-Hartman .name = "generic", 4318fcac35SGreg Kroah-Hartman }, 441da177e4SLinus Torvalds .id_table = generic_device_ids, 451da177e4SLinus Torvalds .num_interrupt_in = NUM_DONT_CARE, 461da177e4SLinus Torvalds .num_bulk_in = NUM_DONT_CARE, 471da177e4SLinus Torvalds .num_bulk_out = NUM_DONT_CARE, 481da177e4SLinus Torvalds .num_ports = 1, 491da177e4SLinus Torvalds .shutdown = usb_serial_generic_shutdown, 501da177e4SLinus Torvalds }; 511da177e4SLinus Torvalds 521da177e4SLinus Torvalds /* we want to look at all devices, as the vendor/product id can change 531da177e4SLinus Torvalds * depending on the command line argument */ 541da177e4SLinus Torvalds static struct usb_device_id generic_serial_ids[] = { 551da177e4SLinus Torvalds {.driver_info = 42}, 561da177e4SLinus Torvalds {} 571da177e4SLinus Torvalds }; 581da177e4SLinus Torvalds 591da177e4SLinus Torvalds static int generic_probe(struct usb_interface *interface, 601da177e4SLinus Torvalds const struct usb_device_id *id) 611da177e4SLinus Torvalds { 621da177e4SLinus Torvalds const struct usb_device_id *id_pattern; 631da177e4SLinus Torvalds 641da177e4SLinus Torvalds id_pattern = usb_match_id(interface, generic_device_ids); 651da177e4SLinus Torvalds if (id_pattern != NULL) 661da177e4SLinus Torvalds return usb_serial_probe(interface, id); 671da177e4SLinus Torvalds return -ENODEV; 681da177e4SLinus Torvalds } 691da177e4SLinus Torvalds 701da177e4SLinus Torvalds static struct usb_driver generic_driver = { 711da177e4SLinus Torvalds .owner = THIS_MODULE, 721da177e4SLinus Torvalds .name = "usbserial_generic", 731da177e4SLinus Torvalds .probe = generic_probe, 741da177e4SLinus Torvalds .disconnect = usb_serial_disconnect, 751da177e4SLinus Torvalds .id_table = generic_serial_ids, 761da177e4SLinus Torvalds }; 771da177e4SLinus Torvalds #endif 781da177e4SLinus Torvalds 791da177e4SLinus Torvalds int usb_serial_generic_register (int _debug) 801da177e4SLinus Torvalds { 811da177e4SLinus Torvalds int retval = 0; 821da177e4SLinus Torvalds 831da177e4SLinus Torvalds debug = _debug; 841da177e4SLinus Torvalds #ifdef CONFIG_USB_SERIAL_GENERIC 851da177e4SLinus Torvalds generic_device_ids[0].idVendor = vendor; 861da177e4SLinus Torvalds generic_device_ids[0].idProduct = product; 871da177e4SLinus Torvalds generic_device_ids[0].match_flags = USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT; 881da177e4SLinus Torvalds 891da177e4SLinus Torvalds /* register our generic driver with ourselves */ 901da177e4SLinus Torvalds retval = usb_serial_register (&usb_serial_generic_device); 911da177e4SLinus Torvalds if (retval) 921da177e4SLinus Torvalds goto exit; 931da177e4SLinus Torvalds retval = usb_register(&generic_driver); 941da177e4SLinus Torvalds if (retval) 951da177e4SLinus Torvalds usb_serial_deregister(&usb_serial_generic_device); 961da177e4SLinus Torvalds exit: 971da177e4SLinus Torvalds #endif 981da177e4SLinus Torvalds return retval; 991da177e4SLinus Torvalds } 1001da177e4SLinus Torvalds 1011da177e4SLinus Torvalds void usb_serial_generic_deregister (void) 1021da177e4SLinus Torvalds { 1031da177e4SLinus Torvalds #ifdef CONFIG_USB_SERIAL_GENERIC 1041da177e4SLinus Torvalds /* remove our generic driver */ 1051da177e4SLinus Torvalds usb_deregister(&generic_driver); 1061da177e4SLinus Torvalds usb_serial_deregister (&usb_serial_generic_device); 1071da177e4SLinus Torvalds #endif 1081da177e4SLinus Torvalds } 1091da177e4SLinus Torvalds 1101da177e4SLinus Torvalds int usb_serial_generic_open (struct usb_serial_port *port, struct file *filp) 1111da177e4SLinus Torvalds { 1121da177e4SLinus Torvalds struct usb_serial *serial = port->serial; 1131da177e4SLinus Torvalds int result = 0; 1141da177e4SLinus Torvalds 1151da177e4SLinus Torvalds dbg("%s - port %d", __FUNCTION__, port->number); 1161da177e4SLinus Torvalds 1171da177e4SLinus Torvalds /* force low_latency on so that our tty_push actually forces the data through, 1181da177e4SLinus Torvalds otherwise it is scheduled, and with high data rates (like with OHCI) data 1191da177e4SLinus Torvalds can get lost. */ 1201da177e4SLinus Torvalds if (port->tty) 1211da177e4SLinus Torvalds port->tty->low_latency = 1; 1221da177e4SLinus Torvalds 1231da177e4SLinus Torvalds /* if we have a bulk interrupt, start reading from it */ 1241da177e4SLinus Torvalds if (serial->num_bulk_in) { 1251da177e4SLinus Torvalds /* Start reading from the device */ 1261da177e4SLinus Torvalds usb_fill_bulk_urb (port->read_urb, serial->dev, 1271da177e4SLinus Torvalds usb_rcvbulkpipe(serial->dev, port->bulk_in_endpointAddress), 1281da177e4SLinus Torvalds port->read_urb->transfer_buffer, 1291da177e4SLinus Torvalds port->read_urb->transfer_buffer_length, 1301da177e4SLinus Torvalds ((serial->type->read_bulk_callback) ? 1311da177e4SLinus Torvalds serial->type->read_bulk_callback : 1321da177e4SLinus Torvalds usb_serial_generic_read_bulk_callback), 1331da177e4SLinus Torvalds port); 1341da177e4SLinus Torvalds result = usb_submit_urb(port->read_urb, GFP_KERNEL); 1351da177e4SLinus Torvalds if (result) 1361da177e4SLinus Torvalds dev_err(&port->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result); 1371da177e4SLinus Torvalds } 1381da177e4SLinus Torvalds 1391da177e4SLinus Torvalds return result; 1401da177e4SLinus Torvalds } 1411da177e4SLinus Torvalds 1421da177e4SLinus Torvalds static void generic_cleanup (struct usb_serial_port *port) 1431da177e4SLinus Torvalds { 1441da177e4SLinus Torvalds struct usb_serial *serial = port->serial; 1451da177e4SLinus Torvalds 1461da177e4SLinus Torvalds dbg("%s - port %d", __FUNCTION__, port->number); 1471da177e4SLinus Torvalds 1481da177e4SLinus Torvalds if (serial->dev) { 1491da177e4SLinus Torvalds /* shutdown any bulk reads that might be going on */ 1501da177e4SLinus Torvalds if (serial->num_bulk_out) 1511da177e4SLinus Torvalds usb_kill_urb(port->write_urb); 1521da177e4SLinus Torvalds if (serial->num_bulk_in) 1531da177e4SLinus Torvalds usb_kill_urb(port->read_urb); 1541da177e4SLinus Torvalds } 1551da177e4SLinus Torvalds } 1561da177e4SLinus Torvalds 1571da177e4SLinus Torvalds void usb_serial_generic_close (struct usb_serial_port *port, struct file * filp) 1581da177e4SLinus Torvalds { 1591da177e4SLinus Torvalds dbg("%s - port %d", __FUNCTION__, port->number); 1601da177e4SLinus Torvalds generic_cleanup (port); 1611da177e4SLinus Torvalds } 1621da177e4SLinus Torvalds 1631da177e4SLinus Torvalds int usb_serial_generic_write(struct usb_serial_port *port, const unsigned char *buf, int count) 1641da177e4SLinus Torvalds { 1651da177e4SLinus Torvalds struct usb_serial *serial = port->serial; 1661da177e4SLinus Torvalds int result; 1671da177e4SLinus Torvalds unsigned char *data; 1681da177e4SLinus Torvalds 1691da177e4SLinus Torvalds dbg("%s - port %d", __FUNCTION__, port->number); 1701da177e4SLinus Torvalds 1711da177e4SLinus Torvalds if (count == 0) { 1721da177e4SLinus Torvalds dbg("%s - write request of 0 bytes", __FUNCTION__); 1731da177e4SLinus Torvalds return (0); 1741da177e4SLinus Torvalds } 1751da177e4SLinus Torvalds 1761da177e4SLinus Torvalds /* only do something if we have a bulk out endpoint */ 1771da177e4SLinus Torvalds if (serial->num_bulk_out) { 178507ca9bcSGreg Kroah-Hartman spin_lock(&port->lock); 179507ca9bcSGreg Kroah-Hartman if (port->write_urb_busy) { 180507ca9bcSGreg Kroah-Hartman spin_unlock(&port->lock); 1811da177e4SLinus Torvalds dbg("%s - already writing", __FUNCTION__); 182507ca9bcSGreg Kroah-Hartman return 0; 1831da177e4SLinus Torvalds } 184507ca9bcSGreg Kroah-Hartman port->write_urb_busy = 1; 185507ca9bcSGreg Kroah-Hartman spin_unlock(&port->lock); 1861da177e4SLinus Torvalds 1871da177e4SLinus Torvalds count = (count > port->bulk_out_size) ? port->bulk_out_size : count; 1881da177e4SLinus Torvalds 1891da177e4SLinus Torvalds memcpy (port->write_urb->transfer_buffer, buf, count); 1901da177e4SLinus Torvalds data = port->write_urb->transfer_buffer; 1911da177e4SLinus Torvalds usb_serial_debug_data(debug, &port->dev, __FUNCTION__, count, data); 1921da177e4SLinus Torvalds 1931da177e4SLinus Torvalds /* set up our urb */ 1941da177e4SLinus Torvalds usb_fill_bulk_urb (port->write_urb, serial->dev, 1951da177e4SLinus Torvalds usb_sndbulkpipe (serial->dev, 1961da177e4SLinus Torvalds port->bulk_out_endpointAddress), 1971da177e4SLinus Torvalds port->write_urb->transfer_buffer, count, 1981da177e4SLinus Torvalds ((serial->type->write_bulk_callback) ? 1991da177e4SLinus Torvalds serial->type->write_bulk_callback : 2001da177e4SLinus Torvalds usb_serial_generic_write_bulk_callback), port); 2011da177e4SLinus Torvalds 2021da177e4SLinus Torvalds /* send the data out the bulk port */ 203507ca9bcSGreg Kroah-Hartman port->write_urb_busy = 1; 2041da177e4SLinus Torvalds result = usb_submit_urb(port->write_urb, GFP_ATOMIC); 205507ca9bcSGreg Kroah-Hartman if (result) { 2061da177e4SLinus Torvalds dev_err(&port->dev, "%s - failed submitting write urb, error %d\n", __FUNCTION__, result); 207507ca9bcSGreg Kroah-Hartman /* don't have to grab the lock here, as we will retry if != 0 */ 208507ca9bcSGreg Kroah-Hartman port->write_urb_busy = 0; 209507ca9bcSGreg Kroah-Hartman } else 2101da177e4SLinus Torvalds result = count; 2111da177e4SLinus Torvalds 2121da177e4SLinus Torvalds return result; 2131da177e4SLinus Torvalds } 2141da177e4SLinus Torvalds 2151da177e4SLinus Torvalds /* no bulk out, so return 0 bytes written */ 216507ca9bcSGreg Kroah-Hartman return 0; 2171da177e4SLinus Torvalds } 2181da177e4SLinus Torvalds 2191da177e4SLinus Torvalds int usb_serial_generic_write_room (struct usb_serial_port *port) 2201da177e4SLinus Torvalds { 2211da177e4SLinus Torvalds struct usb_serial *serial = port->serial; 2221da177e4SLinus Torvalds int room = 0; 2231da177e4SLinus Torvalds 2241da177e4SLinus Torvalds dbg("%s - port %d", __FUNCTION__, port->number); 2251da177e4SLinus Torvalds 2261da177e4SLinus Torvalds if (serial->num_bulk_out) { 2277a3ca7d2SRandall Nortman if (!(port->write_urb_busy)) 2281da177e4SLinus Torvalds room = port->bulk_out_size; 2291da177e4SLinus Torvalds } 2301da177e4SLinus Torvalds 2311da177e4SLinus Torvalds dbg("%s - returns %d", __FUNCTION__, room); 2321da177e4SLinus Torvalds return (room); 2331da177e4SLinus Torvalds } 2341da177e4SLinus Torvalds 2351da177e4SLinus Torvalds int usb_serial_generic_chars_in_buffer (struct usb_serial_port *port) 2361da177e4SLinus Torvalds { 2371da177e4SLinus Torvalds struct usb_serial *serial = port->serial; 2381da177e4SLinus Torvalds int chars = 0; 2391da177e4SLinus Torvalds 2401da177e4SLinus Torvalds dbg("%s - port %d", __FUNCTION__, port->number); 2411da177e4SLinus Torvalds 2421da177e4SLinus Torvalds if (serial->num_bulk_out) { 243507ca9bcSGreg Kroah-Hartman if (port->write_urb_busy) 2441da177e4SLinus Torvalds chars = port->write_urb->transfer_buffer_length; 2451da177e4SLinus Torvalds } 2461da177e4SLinus Torvalds 2471da177e4SLinus Torvalds dbg("%s - returns %d", __FUNCTION__, chars); 2481da177e4SLinus Torvalds return (chars); 2491da177e4SLinus Torvalds } 2501da177e4SLinus Torvalds 2511da177e4SLinus Torvalds void usb_serial_generic_read_bulk_callback (struct urb *urb, struct pt_regs *regs) 2521da177e4SLinus Torvalds { 2531da177e4SLinus Torvalds struct usb_serial_port *port = (struct usb_serial_port *)urb->context; 2541da177e4SLinus Torvalds struct usb_serial *serial = port->serial; 2551da177e4SLinus Torvalds struct tty_struct *tty; 2561da177e4SLinus Torvalds unsigned char *data = urb->transfer_buffer; 2571da177e4SLinus Torvalds int i; 2581da177e4SLinus Torvalds int result; 2591da177e4SLinus Torvalds 2601da177e4SLinus Torvalds dbg("%s - port %d", __FUNCTION__, port->number); 2611da177e4SLinus Torvalds 2621da177e4SLinus Torvalds if (urb->status) { 2631da177e4SLinus Torvalds dbg("%s - nonzero read bulk status received: %d", __FUNCTION__, urb->status); 2641da177e4SLinus Torvalds return; 2651da177e4SLinus Torvalds } 2661da177e4SLinus Torvalds 2671da177e4SLinus Torvalds usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data); 2681da177e4SLinus Torvalds 2691da177e4SLinus Torvalds tty = port->tty; 2701da177e4SLinus Torvalds if (tty && urb->actual_length) { 2711da177e4SLinus Torvalds for (i = 0; i < urb->actual_length ; ++i) { 2721da177e4SLinus Torvalds /* if we insert more than TTY_FLIPBUF_SIZE characters, we drop them. */ 2731da177e4SLinus Torvalds if(tty->flip.count >= TTY_FLIPBUF_SIZE) { 2741da177e4SLinus Torvalds tty_flip_buffer_push(tty); 2751da177e4SLinus Torvalds } 2761da177e4SLinus Torvalds /* this doesn't actually push the data through unless tty->low_latency is set */ 2771da177e4SLinus Torvalds tty_insert_flip_char(tty, data[i], 0); 2781da177e4SLinus Torvalds } 2791da177e4SLinus Torvalds tty_flip_buffer_push(tty); 2801da177e4SLinus Torvalds } 2811da177e4SLinus Torvalds 2821da177e4SLinus Torvalds /* Continue trying to always read */ 2831da177e4SLinus Torvalds usb_fill_bulk_urb (port->read_urb, serial->dev, 2841da177e4SLinus Torvalds usb_rcvbulkpipe (serial->dev, 2851da177e4SLinus Torvalds port->bulk_in_endpointAddress), 2861da177e4SLinus Torvalds port->read_urb->transfer_buffer, 2871da177e4SLinus Torvalds port->read_urb->transfer_buffer_length, 2881da177e4SLinus Torvalds ((serial->type->read_bulk_callback) ? 2891da177e4SLinus Torvalds serial->type->read_bulk_callback : 2901da177e4SLinus Torvalds usb_serial_generic_read_bulk_callback), port); 2911da177e4SLinus Torvalds result = usb_submit_urb(port->read_urb, GFP_ATOMIC); 2921da177e4SLinus Torvalds if (result) 2931da177e4SLinus Torvalds dev_err(&port->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result); 2941da177e4SLinus Torvalds } 2951da177e4SLinus Torvalds 2961da177e4SLinus Torvalds void usb_serial_generic_write_bulk_callback (struct urb *urb, struct pt_regs *regs) 2971da177e4SLinus Torvalds { 2981da177e4SLinus Torvalds struct usb_serial_port *port = (struct usb_serial_port *)urb->context; 2991da177e4SLinus Torvalds 3001da177e4SLinus Torvalds dbg("%s - port %d", __FUNCTION__, port->number); 3011da177e4SLinus Torvalds 302507ca9bcSGreg Kroah-Hartman port->write_urb_busy = 0; 3031da177e4SLinus Torvalds if (urb->status) { 3041da177e4SLinus Torvalds dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status); 3051da177e4SLinus Torvalds return; 3061da177e4SLinus Torvalds } 3071da177e4SLinus Torvalds 3081da177e4SLinus Torvalds usb_serial_port_softint((void *)port); 3091da177e4SLinus Torvalds 3101da177e4SLinus Torvalds schedule_work(&port->work); 3111da177e4SLinus Torvalds } 3121da177e4SLinus Torvalds 3131da177e4SLinus Torvalds void usb_serial_generic_shutdown (struct usb_serial *serial) 3141da177e4SLinus Torvalds { 3151da177e4SLinus Torvalds int i; 3161da177e4SLinus Torvalds 3171da177e4SLinus Torvalds dbg("%s", __FUNCTION__); 3181da177e4SLinus Torvalds 3191da177e4SLinus Torvalds /* stop reads and writes on all ports */ 3201da177e4SLinus Torvalds for (i=0; i < serial->num_ports; ++i) { 3211da177e4SLinus Torvalds generic_cleanup(serial->port[i]); 3221da177e4SLinus Torvalds } 3231da177e4SLinus Torvalds } 3241da177e4SLinus Torvalds 325