ChangeSet 1.842.46.12, 2002/11/26 15:33:15-08:00, greg@kroah.com [PATCH] USB serial: split the generic functions out into their own file diff -Nru a/drivers/usb/serial/Makefile b/drivers/usb/serial/Makefile --- a/drivers/usb/serial/Makefile Wed Nov 27 12:50:47 2002 +++ b/drivers/usb/serial/Makefile Wed Nov 27 12:50:47 2002 @@ -32,7 +32,7 @@ # Objects that export symbols. export-objs := usb-serial.o ezusb.o -usbserial-objs := usb-serial.o $(usbserial-obj-y) +usbserial-objs := usb-serial.o generic.o $(usbserial-obj-y) include $(TOPDIR)/Rules.make diff -Nru a/drivers/usb/serial/generic.c b/drivers/usb/serial/generic.c --- /dev/null Wed Dec 31 16:00:00 1969 +++ b/drivers/usb/serial/generic.c Wed Nov 27 12:50:47 2002 @@ -0,0 +1,304 @@ +/* + * USB Serial Converter Generic functions + * + * Copyright (C) 1999 - 2002 Greg Kroah-Hartman (greg@kroah.com) + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License version + * 2 as published by the Free Software Foundation. + * + */ + +#include +#include +#include +#include +#include +#include +#include +#include + +#ifdef CONFIG_USB_SERIAL_DEBUG + static int debug = 1; +#else + static int debug; +#endif + +#include "usb-serial.h" + + +#ifdef CONFIG_USB_SERIAL_GENERIC +static __u16 vendor = 0x05f9; +static __u16 product = 0xffff; + +MODULE_PARM(vendor, "h"); +MODULE_PARM_DESC(vendor, "User specified USB idVendor"); + +MODULE_PARM(product, "h"); +MODULE_PARM_DESC(product, "User specified USB idProduct"); + +static struct usb_device_id generic_device_ids[2]; /* Initially all zeroes. */ + +/* All of the device info needed for the Generic Serial Converter */ +struct usb_serial_device_type usb_serial_generic_device = { + .owner = THIS_MODULE, + .name = "Generic", + .id_table = generic_device_ids, + .num_interrupt_in = NUM_DONT_CARE, + .num_bulk_in = NUM_DONT_CARE, + .num_bulk_out = NUM_DONT_CARE, + .num_ports = 1, + .shutdown = usb_serial_generic_shutdown, +}; +#endif + +int usb_serial_generic_register (int _debug) +{ + int retval = 0; + + debug = _debug; +#ifdef CONFIG_USB_SERIAL_GENERIC + generic_device_ids[0].idVendor = vendor; + generic_device_ids[0].idProduct = product; + generic_device_ids[0].match_flags = USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT; + + /* register our generic driver with ourselves */ + retval = usb_serial_register (&usb_serial_generic_device); +#endif + return retval; +} + +void usb_serial_generic_deregister (void) +{ +#ifdef CONFIG_USB_SERIAL_GENERIC + /* remove our generic driver */ + usb_serial_deregister (&usb_serial_generic_device); +#endif +} + +int usb_serial_generic_open (struct usb_serial_port *port, struct file *filp) +{ + struct usb_serial *serial = port->serial; + int result = 0; + + if (port_paranoia_check (port, __FUNCTION__)) + return -ENODEV; + + dbg("%s - port %d", __FUNCTION__, port->number); + + /* force low_latency on so that our tty_push actually forces the data through, + otherwise it is scheduled, and with high data rates (like with OHCI) data + can get lost. */ + if (port->tty) + port->tty->low_latency = 1; + + /* if we have a bulk interrupt, start reading from it */ + if (serial->num_bulk_in) { + /* Start reading from the device */ + usb_fill_bulk_urb (port->read_urb, serial->dev, + usb_rcvbulkpipe(serial->dev, port->bulk_in_endpointAddress), + port->read_urb->transfer_buffer, + port->read_urb->transfer_buffer_length, + ((serial->type->read_bulk_callback) ? + serial->type->read_bulk_callback : + usb_serial_generic_read_bulk_callback), + port); + result = usb_submit_urb(port->read_urb, GFP_KERNEL); + if (result) + err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result); + } + + return result; +} + +static void generic_cleanup (struct usb_serial_port *port) +{ + struct usb_serial *serial = port->serial; + + dbg("%s - port %d", __FUNCTION__, port->number); + + if (serial->dev) { + /* shutdown any bulk reads that might be going on */ + if (serial->num_bulk_out) + usb_unlink_urb (port->write_urb); + if (serial->num_bulk_in) + usb_unlink_urb (port->read_urb); + } +} + +void usb_serial_generic_close (struct usb_serial_port *port, struct file * filp) +{ + dbg("%s - port %d", __FUNCTION__, port->number); + generic_cleanup (port); +} + +int usb_serial_generic_write (struct usb_serial_port *port, int from_user, const unsigned char *buf, int count) +{ + struct usb_serial *serial = port->serial; + int result; + + dbg("%s - port %d", __FUNCTION__, port->number); + + if (count == 0) { + dbg("%s - write request of 0 bytes", __FUNCTION__); + return (0); + } + + /* only do something if we have a bulk out endpoint */ + if (serial->num_bulk_out) { + if (port->write_urb->status == -EINPROGRESS) { + dbg("%s - already writing", __FUNCTION__); + return (0); + } + + count = (count > port->bulk_out_size) ? port->bulk_out_size : count; + + if (from_user) { + if (copy_from_user(port->write_urb->transfer_buffer, buf, count)) + return -EFAULT; + } + else { + memcpy (port->write_urb->transfer_buffer, buf, count); + } + + usb_serial_debug_data (__FILE__, __FUNCTION__, count, port->write_urb->transfer_buffer); + + /* set up our urb */ + usb_fill_bulk_urb (port->write_urb, serial->dev, + usb_sndbulkpipe (serial->dev, + port->bulk_out_endpointAddress), + port->write_urb->transfer_buffer, count, + ((serial->type->write_bulk_callback) ? + serial->type->write_bulk_callback : + usb_serial_generic_write_bulk_callback), port); + + /* send the data out the bulk port */ + result = usb_submit_urb(port->write_urb, GFP_ATOMIC); + if (result) + err("%s - failed submitting write urb, error %d", __FUNCTION__, result); + else + result = count; + + return result; + } + + /* no bulk out, so return 0 bytes written */ + return (0); +} + +int usb_serial_generic_write_room (struct usb_serial_port *port) +{ + struct usb_serial *serial = port->serial; + int room = 0; + + dbg("%s - port %d", __FUNCTION__, port->number); + + if (serial->num_bulk_out) { + if (port->write_urb->status != -EINPROGRESS) + room = port->bulk_out_size; + } + + dbg("%s - returns %d", __FUNCTION__, room); + return (room); +} + +int usb_serial_generic_chars_in_buffer (struct usb_serial_port *port) +{ + struct usb_serial *serial = port->serial; + int chars = 0; + + dbg("%s - port %d", __FUNCTION__, port->number); + + if (serial->num_bulk_out) { + if (port->write_urb->status == -EINPROGRESS) + chars = port->write_urb->transfer_buffer_length; + } + + dbg("%s - returns %d", __FUNCTION__, chars); + return (chars); +} + +void usb_serial_generic_read_bulk_callback (struct urb *urb) +{ + struct usb_serial_port *port = (struct usb_serial_port *)urb->context; + struct usb_serial *serial = get_usb_serial (port, __FUNCTION__); + struct tty_struct *tty; + unsigned char *data = urb->transfer_buffer; + int i; + int result; + + dbg("%s - port %d", __FUNCTION__, port->number); + + if (!serial) { + dbg("%s - bad serial pointer, exiting", __FUNCTION__); + return; + } + + if (urb->status) { + dbg("%s - nonzero read bulk status received: %d", __FUNCTION__, urb->status); + return; + } + + usb_serial_debug_data (__FILE__, __FUNCTION__, urb->actual_length, data); + + tty = port->tty; + if (tty && urb->actual_length) { + for (i = 0; i < urb->actual_length ; ++i) { + /* if we insert more than TTY_FLIPBUF_SIZE characters, we drop them. */ + if(tty->flip.count >= TTY_FLIPBUF_SIZE) { + tty_flip_buffer_push(tty); + } + /* this doesn't actually push the data through unless tty->low_latency is set */ + tty_insert_flip_char(tty, data[i], 0); + } + tty_flip_buffer_push(tty); + } + + /* Continue trying to always read */ + usb_fill_bulk_urb (port->read_urb, serial->dev, + usb_rcvbulkpipe (serial->dev, + port->bulk_in_endpointAddress), + port->read_urb->transfer_buffer, + port->read_urb->transfer_buffer_length, + ((serial->type->read_bulk_callback) ? + serial->type->read_bulk_callback : + usb_serial_generic_read_bulk_callback), port); + result = usb_submit_urb(port->read_urb, GFP_ATOMIC); + if (result) + err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result); +} + +void usb_serial_generic_write_bulk_callback (struct urb *urb) +{ + struct usb_serial_port *port = (struct usb_serial_port *)urb->context; + struct usb_serial *serial = get_usb_serial (port, __FUNCTION__); + + dbg("%s - port %d", __FUNCTION__, port->number); + + if (!serial) { + dbg("%s - bad serial pointer, exiting", __FUNCTION__); + return; + } + + if (urb->status) { + dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status); + return; + } + + usb_serial_port_softint((void *)port); + + schedule_work(&port->work); +} + +void usb_serial_generic_shutdown (struct usb_serial *serial) +{ + int i; + + dbg("%s", __FUNCTION__); + + /* stop reads and writes on all ports */ + for (i=0; i < serial->num_ports; ++i) { + generic_cleanup (&serial->port[i]); + } +} + diff -Nru a/drivers/usb/serial/usb-serial.c b/drivers/usb/serial/usb-serial.c --- a/drivers/usb/serial/usb-serial.c Wed Nov 27 12:50:47 2002 +++ b/drivers/usb/serial/usb-serial.c Wed Nov 27 12:50:47 2002 @@ -345,41 +345,12 @@ /* * Version Information */ -#define DRIVER_VERSION "v1.7" +#define DRIVER_VERSION "v1.8" #define DRIVER_AUTHOR "Greg Kroah-Hartman, greg@kroah.com, http://www.kroah.com/linux/" #define DRIVER_DESC "USB Serial Driver core" -/* function prototypes for a "generic" type serial converter (no flow control, not all endpoints needed) */ -/* need to always compile these in, as some of the other devices use these functions as their own. */ -/* if a driver does not provide a function pointer, the generic function will be called. */ -int usb_serial_generic_open (struct usb_serial_port *port, struct file *filp); -int usb_serial_generic_write (struct usb_serial_port *port, int from_user, const unsigned char *buf, int count); -static void generic_close (struct usb_serial_port *port, struct file *filp); -static int generic_write_room (struct usb_serial_port *port); -static int generic_chars_in_buffer (struct usb_serial_port *port); -static void generic_read_bulk_callback (struct urb *urb); -static void generic_write_bulk_callback (struct urb *urb); -static void generic_shutdown (struct usb_serial *serial); - #ifdef CONFIG_USB_SERIAL_GENERIC -static __u16 vendor = 0x05f9; -static __u16 product = 0xffff; - -static struct usb_device_id generic_device_ids[2]; /* Initially all zeroes. */ - -/* All of the device info needed for the Generic Serial Converter */ -static struct usb_serial_device_type generic_device = { - .owner = THIS_MODULE, - .name = "Generic", - .id_table = generic_device_ids, - .num_interrupt_in = NUM_DONT_CARE, - .num_bulk_in = NUM_DONT_CARE, - .num_bulk_out = NUM_DONT_CARE, - .num_ports = 1, - .shutdown = generic_shutdown, -}; - /* we want to look at all devices, as the vendor/product id can change * depending on the command line argument */ static struct usb_device_id generic_serial_ids[] = { @@ -387,27 +358,6 @@ {} }; -static int generic_register (void) -{ - generic_device_ids[0].idVendor = vendor; - generic_device_ids[0].idProduct = product; - generic_device_ids[0].match_flags = USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT; - - /* register our generic driver with ourselves */ - return usb_serial_register (&generic_device); -} - -static void generic_deregister (void) -{ - /* remove our generic driver */ - usb_serial_deregister (&generic_device); -} - -#else - -static inline int generic_register (void) { return 0; } -static inline void generic_deregister (void) { } - #endif /* CONFIG_USB_SERIAL_GENERIC */ /* Driver structure we register with the USB core */ @@ -554,7 +504,7 @@ if (port->serial->type->close) port->serial->type->close(port, filp); else - generic_close(port, filp); + usb_serial_generic_close(port, filp); port->open_count = 0; } @@ -633,7 +583,7 @@ if (serial->type->write_room) retval = serial->type->write_room(port); else - retval = generic_write_room(port); + retval = usb_serial_generic_write_room(port); exit: up (&port->sem); @@ -662,7 +612,7 @@ if (serial->type->chars_in_buffer) retval = serial->type->chars_in_buffer(port); else - retval = generic_chars_in_buffer(port); + retval = usb_serial_generic_chars_in_buffer(port); exit: up (&port->sem); @@ -805,7 +755,7 @@ if (serial->type->shutdown) serial->type->shutdown(serial); else - generic_shutdown(serial); + usb_serial_generic_shutdown(serial); } static int serial_read_proc (char *page, char **start, off_t off, int count, int *eof, void *data) @@ -850,235 +800,6 @@ return ((count < begin+length-off) ? count : begin+length-off); } -/***************************************************************************** - * generic devices specific driver functions - *****************************************************************************/ -int usb_serial_generic_open (struct usb_serial_port *port, struct file *filp) -{ - struct usb_serial *serial = port->serial; - int result = 0; - - if (port_paranoia_check (port, __FUNCTION__)) - return -ENODEV; - - dbg("%s - port %d", __FUNCTION__, port->number); - - /* force low_latency on so that our tty_push actually forces the data through, - otherwise it is scheduled, and with high data rates (like with OHCI) data - can get lost. */ - if (port->tty) - port->tty->low_latency = 1; - - /* if we have a bulk interrupt, start reading from it */ - if (serial->num_bulk_in) { - /* Start reading from the device */ - usb_fill_bulk_urb (port->read_urb, serial->dev, - usb_rcvbulkpipe(serial->dev, port->bulk_in_endpointAddress), - port->read_urb->transfer_buffer, - port->read_urb->transfer_buffer_length, - ((serial->type->read_bulk_callback) ? - serial->type->read_bulk_callback : - generic_read_bulk_callback), - port); - result = usb_submit_urb(port->read_urb, GFP_KERNEL); - if (result) - err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result); - } - - return result; -} - -static void generic_cleanup (struct usb_serial_port *port) -{ - struct usb_serial *serial = port->serial; - - dbg("%s - port %d", __FUNCTION__, port->number); - - if (serial->dev) { - /* shutdown any bulk reads that might be going on */ - if (serial->num_bulk_out) - usb_unlink_urb (port->write_urb); - if (serial->num_bulk_in) - usb_unlink_urb (port->read_urb); - } -} - -static void generic_close (struct usb_serial_port *port, struct file * filp) -{ - dbg("%s - port %d", __FUNCTION__, port->number); - generic_cleanup (port); -} - -int usb_serial_generic_write (struct usb_serial_port *port, int from_user, const unsigned char *buf, int count) -{ - struct usb_serial *serial = port->serial; - int result; - - dbg("%s - port %d", __FUNCTION__, port->number); - - if (count == 0) { - dbg("%s - write request of 0 bytes", __FUNCTION__); - return (0); - } - - /* only do something if we have a bulk out endpoint */ - if (serial->num_bulk_out) { - if (port->write_urb->status == -EINPROGRESS) { - dbg("%s - already writing", __FUNCTION__); - return (0); - } - - count = (count > port->bulk_out_size) ? port->bulk_out_size : count; - - if (from_user) { - if (copy_from_user(port->write_urb->transfer_buffer, buf, count)) - return -EFAULT; - } - else { - memcpy (port->write_urb->transfer_buffer, buf, count); - } - - usb_serial_debug_data (__FILE__, __FUNCTION__, count, port->write_urb->transfer_buffer); - - /* set up our urb */ - usb_fill_bulk_urb (port->write_urb, serial->dev, - usb_sndbulkpipe (serial->dev, - port->bulk_out_endpointAddress), - port->write_urb->transfer_buffer, count, - ((serial->type->write_bulk_callback) ? - serial->type->write_bulk_callback : - generic_write_bulk_callback), port); - - /* send the data out the bulk port */ - result = usb_submit_urb(port->write_urb, GFP_ATOMIC); - if (result) - err("%s - failed submitting write urb, error %d", __FUNCTION__, result); - else - result = count; - - return result; - } - - /* no bulk out, so return 0 bytes written */ - return (0); -} - -static int generic_write_room (struct usb_serial_port *port) -{ - struct usb_serial *serial = port->serial; - int room = 0; - - dbg("%s - port %d", __FUNCTION__, port->number); - - if (serial->num_bulk_out) { - if (port->write_urb->status != -EINPROGRESS) - room = port->bulk_out_size; - } - - dbg("%s - returns %d", __FUNCTION__, room); - return (room); -} - -static int generic_chars_in_buffer (struct usb_serial_port *port) -{ - struct usb_serial *serial = port->serial; - int chars = 0; - - dbg("%s - port %d", __FUNCTION__, port->number); - - if (serial->num_bulk_out) { - if (port->write_urb->status == -EINPROGRESS) - chars = port->write_urb->transfer_buffer_length; - } - - dbg("%s - returns %d", __FUNCTION__, chars); - return (chars); -} - -static void generic_read_bulk_callback (struct urb *urb) -{ - struct usb_serial_port *port = (struct usb_serial_port *)urb->context; - struct usb_serial *serial = get_usb_serial (port, __FUNCTION__); - struct tty_struct *tty; - unsigned char *data = urb->transfer_buffer; - int i; - int result; - - dbg("%s - port %d", __FUNCTION__, port->number); - - if (!serial) { - dbg("%s - bad serial pointer, exiting", __FUNCTION__); - return; - } - - if (urb->status) { - dbg("%s - nonzero read bulk status received: %d", __FUNCTION__, urb->status); - return; - } - - usb_serial_debug_data (__FILE__, __FUNCTION__, urb->actual_length, data); - - tty = port->tty; - if (tty && urb->actual_length) { - for (i = 0; i < urb->actual_length ; ++i) { - /* if we insert more than TTY_FLIPBUF_SIZE characters, we drop them. */ - if(tty->flip.count >= TTY_FLIPBUF_SIZE) { - tty_flip_buffer_push(tty); - } - /* this doesn't actually push the data through unless tty->low_latency is set */ - tty_insert_flip_char(tty, data[i], 0); - } - tty_flip_buffer_push(tty); - } - - /* Continue trying to always read */ - usb_fill_bulk_urb (port->read_urb, serial->dev, - usb_rcvbulkpipe (serial->dev, - port->bulk_in_endpointAddress), - port->read_urb->transfer_buffer, - port->read_urb->transfer_buffer_length, - ((serial->type->read_bulk_callback) ? - serial->type->read_bulk_callback : - generic_read_bulk_callback), port); - result = usb_submit_urb(port->read_urb, GFP_ATOMIC); - if (result) - err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result); -} - -static void generic_write_bulk_callback (struct urb *urb) -{ - struct usb_serial_port *port = (struct usb_serial_port *)urb->context; - struct usb_serial *serial = get_usb_serial (port, __FUNCTION__); - - dbg("%s - port %d", __FUNCTION__, port->number); - - if (!serial) { - dbg("%s - bad serial pointer, exiting", __FUNCTION__); - return; - } - - if (urb->status) { - dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status); - return; - } - - usb_serial_port_softint((void *)port); - - schedule_work(&port->work); -} - -static void generic_shutdown (struct usb_serial *serial) -{ - int i; - - dbg("%s", __FUNCTION__); - - /* stop reads and writes on all ports */ - for (i=0; i < serial->num_ports; ++i) { - generic_cleanup (&serial->port[i]); - } -} - void usb_serial_port_softint(void *private) { struct usb_serial_port *port = (struct usb_serial_port *)private; @@ -1229,7 +950,6 @@ (dev->descriptor.idProduct == PL2303_PRODUCT_ID)) || ((dev->descriptor.idVendor == ATEN_VENDOR_ID) && (dev->descriptor.idProduct == ATEN_PRODUCT_ID))) { - //if (ifnum == 1) { if (interface != &dev->actconfig->interface[0]) { /* check out the endpoints of the other interface*/ //interface = &dev->actconfig->interface[ifnum ^ 1]; @@ -1264,7 +984,7 @@ info("%s converter detected", type->name); #ifdef CONFIG_USB_SERIAL_GENERIC - if (type == &generic_device) { + if (type == &usb_serial_generic_device) { num_ports = num_bulk_out; if (num_ports == 0) { err("Generic device with no bulk out, not allowed."); @@ -1320,7 +1040,7 @@ port->bulk_in_buffer, buffer_size, ((serial->type->read_bulk_callback) ? serial->type->read_bulk_callback : - generic_read_bulk_callback), + usb_serial_generic_read_bulk_callback), port); } @@ -1346,7 +1066,7 @@ port->bulk_out_buffer, buffer_size, ((serial->type->write_bulk_callback) ? serial->type->write_bulk_callback : - generic_write_bulk_callback), + usb_serial_generic_write_bulk_callback), port); } @@ -1568,7 +1288,7 @@ } /* register the generic driver, if we should */ - result = generic_register(); + result = usb_serial_generic_register(debug); if (result < 0) { err("%s - registering generic driver failed", __FUNCTION__); goto exit; @@ -1598,7 +1318,7 @@ tty_unregister_driver(&serial_tty_driver); exit_generic: - generic_deregister(); + usb_serial_generic_deregister(); exit: err ("%s - returning with error %d", __FUNCTION__, result); @@ -1610,7 +1330,7 @@ { usb_serial_console_exit(); - generic_deregister(); + usb_serial_generic_deregister(); usb_deregister(&usb_serial_driver); tty_unregister_driver(&serial_tty_driver); @@ -1669,11 +1389,3 @@ MODULE_PARM(debug, "i"); MODULE_PARM_DESC(debug, "Debug enabled or not"); - -#ifdef CONFIG_USB_SERIAL_GENERIC -MODULE_PARM(vendor, "h"); -MODULE_PARM_DESC(vendor, "User specified USB idVendor"); - -MODULE_PARM(product, "h"); -MODULE_PARM_DESC(product, "User specified USB idProduct"); -#endif diff -Nru a/drivers/usb/serial/usb-serial.h b/drivers/usb/serial/usb-serial.h --- a/drivers/usb/serial/usb-serial.h Wed Nov 27 12:50:47 2002 +++ b/drivers/usb/serial/usb-serial.h Wed Nov 27 12:50:47 2002 @@ -249,10 +249,20 @@ static inline void usb_serial_console_exit (void) { } #endif -/* Functions needed by the usb serial console code */ +/* Functions needed by other parts of the usbserial core */ extern struct usb_serial *usb_serial_get_by_minor (unsigned int minor); extern int usb_serial_generic_open (struct usb_serial_port *port, struct file *filp); extern int usb_serial_generic_write (struct usb_serial_port *port, int from_user, const unsigned char *buf, int count); +extern void usb_serial_generic_close (struct usb_serial_port *port, struct file *filp); +extern int usb_serial_generic_write_room (struct usb_serial_port *port); +extern int usb_serial_generic_chars_in_buffer (struct usb_serial_port *port); +extern void usb_serial_generic_read_bulk_callback (struct urb *urb); +extern void usb_serial_generic_write_bulk_callback (struct urb *urb); +extern void usb_serial_generic_shutdown (struct usb_serial *serial); +extern int usb_serial_generic_register (int debug); +extern void usb_serial_generic_deregister (void); + +extern struct usb_serial_device_type usb_serial_generic_device; /* Inline functions to check the sanity of a pointer that is passed to us */ static inline int serial_paranoia_check (struct usb_serial *serial, const char *function)