usb_serial: API all change

USB serial likes to use port->tty back pointers for the real work it does and
to do so without any actual locking. Unfortunately when you consider hangup
events, hangup/parallel reopen or even worse hangup followed by parallel close
events the tty->port and port->tty pointers are not guaranteed to be the same
as port->tty is the active tty while tty->port is the port the tty may or
may not still be attached to.

So rework the entire API to pass the tty struct. For console cases we need
to pass both for now. This shows up multiple drivers that immediately crash
with USB console some of which have been fixed in the process.

Longer term we need a proper tty as console abstraction

Signed-off-by: Alan Cox <alan@redhat.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

1 files changed, 355 insertions, 0 deletions

diff --git a/drivers/usb/serial/airprime.c b/drivers/usb/serial/airprime.c
new file mode 100644
index 000000000000..b3f1d1e82468
--- /dev/null
+++ b/drivers/usb/serial/airprime.c
@@ -0,0 +1,355 @@
+/*
+ * AirPrime CDMA Wireless Serial USB driver
+ *
+ * Copyright (C) 2005-2006 Greg Kroah-Hartman <gregkh@suse.de>
+ *
+ *      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 <linux/kernel.h>
+#include <linux/init.h>
+#include <linux/tty.h>
+#include <linux/tty_flip.h>
+#include <linux/module.h>
+#include <linux/usb.h>
+#include <linux/usb/serial.h>
+
+static struct usb_device_id id_table [] = {
+        { USB_DEVICE(0x0c88, 0x17da) }, /* Kyocera Wireless KPC650/Passport */
+        { },
+};
+MODULE_DEVICE_TABLE(usb, id_table);
+
+#define URB_TRANSFER_BUFFER_SIZE        4096
+#define NUM_READ_URBS                   4
+#define NUM_WRITE_URBS                  4
+#define NUM_BULK_EPS                    3
+#define MAX_BULK_EPS                    6
+
+/* if overridden by the user, then use their value for the size of the
+ * read and write urbs, and the number of endpoints */
+static int buffer_size = URB_TRANSFER_BUFFER_SIZE;
+static int endpoints = NUM_BULK_EPS;
+static int debug;
+struct airprime_private {
+        spinlock_t lock;
+        int outstanding_urbs;
+        int throttled;
+        struct urb *read_urbp[NUM_READ_URBS];
+
+        /* Settings for the port */
+        int rts_state;  /* Handshaking pins (outputs) */
+        int dtr_state;
+        int cts_state;  /* Handshaking pins (inputs) */
+        int dsr_state;
+        int dcd_state;
+        int ri_state;
+};
+
+static int airprime_send_setup(struct usb_serial_port *port)
+{
+        struct usb_serial *serial = port->serial;
+        struct airprime_private *priv;
+
+        dbg("%s", __func__);
+
+        if (port->number != 0)
+                return 0;
+
+        priv = usb_get_serial_port_data(port);
+
+        if (port->port.tty) {
+                int val = 0;
+                if (priv->dtr_state)
+                        val |= 0x01;
+                if (priv->rts_state)
+                        val |= 0x02;
+
+                return usb_control_msg(serial->dev,
+                                        usb_rcvctrlpipe(serial->dev, 0),
+                                        0x22, 0x21, val, 0, NULL, 0,
+                                        USB_CTRL_SET_TIMEOUT);
+        }
+
+        return 0;
+}
+
+static void airprime_read_bulk_callback(struct urb *urb)
+{
+        struct usb_serial_port *port = urb->context;
+        unsigned char *data = urb->transfer_buffer;
+        struct tty_struct *tty;
+        int result;
+        int status = urb->status;
+
+        dbg("%s - port %d", __func__, port->number);
+
+        if (status) {
+                dbg("%s - nonzero read bulk status received: %d",
+                    __func__, status);
+                return;
+        }
+        usb_serial_debug_data(debug, &port->dev, __func__,
+                                                urb->actual_length, data);
+
+        tty = port->port.tty;
+        if (tty && urb->actual_length) {
+                tty_insert_flip_string(tty, data, urb->actual_length);
+                tty_flip_buffer_push(tty);
+        }
+
+        result = usb_submit_urb(urb, GFP_ATOMIC);
+        if (result)
+                dev_err(&port->dev,
+                        "%s - failed resubmitting read urb, error %d\n",
+                        __func__, result);
+        return;
+}
+
+static void airprime_write_bulk_callback(struct urb *urb)
+{
+        struct usb_serial_port *port = urb->context;
+        struct airprime_private *priv = usb_get_serial_port_data(port);
+        int status = urb->status;
+        unsigned long flags;
+
+        dbg("%s - port %d", __func__, port->number);
+
+        /* free up the transfer buffer, as usb_free_urb() does not do this */
+        kfree(urb->transfer_buffer);
+
+        if (status)
+                dbg("%s - nonzero write bulk status received: %d",
+                    __func__, status);
+        spin_lock_irqsave(&priv->lock, flags);
+        --priv->outstanding_urbs;
+        spin_unlock_irqrestore(&priv->lock, flags);
+
+        usb_serial_port_softint(port);
+}
+
+static int airprime_open(struct tty_struct *tty, struct usb_serial_port *port,
+                                                        struct file *filp)
+{
+        struct airprime_private *priv = usb_get_serial_port_data(port);
+        struct usb_serial *serial = port->serial;
+        struct urb *urb;
+        char *buffer = NULL;
+        int i;
+        int result = 0;
+
+        dbg("%s - port %d", __func__, port->number);
+
+        /* initialize our private data structure if it isn't already created */
+        if (!priv) {
+                priv = kzalloc(sizeof(*priv), GFP_KERNEL);
+                if (!priv) {
+                        result = -ENOMEM;
+                        goto out;
+                }
+                spin_lock_init(&priv->lock);
+                usb_set_serial_port_data(port, priv);
+        }
+
+        /* Set some sane defaults */
+        priv->rts_state = 1;
+        priv->dtr_state = 1;
+
+        for (i = 0; i < NUM_READ_URBS; ++i) {
+                buffer = kmalloc(buffer_size, GFP_KERNEL);
+                if (!buffer) {
+                        dev_err(&port->dev, "%s - out of memory.\n",
+                                __func__);
+                        result = -ENOMEM;
+                        goto errout;
+                }
+                urb = usb_alloc_urb(0, GFP_KERNEL);
+                if (!urb) {
+                        kfree(buffer);
+                        dev_err(&port->dev, "%s - no more urbs?\n",
+                                __func__);
+                        result = -ENOMEM;
+                        goto errout;
+                }
+                usb_fill_bulk_urb(urb, serial->dev,
+                                  usb_rcvbulkpipe(serial->dev,
+                                          port->bulk_out_endpointAddress),
+                                  buffer, buffer_size,
+                                  airprime_read_bulk_callback, port);
+                result = usb_submit_urb(urb, GFP_KERNEL);
+                if (result) {
+                        usb_free_urb(urb);
+                        kfree(buffer);
+                        dev_err(&port->dev,
+                                "%s - failed submitting read urb %d for port %d, error %d\n",
+                                __func__, i, port->number, result);
+                        goto errout;
+                }
+                /* remember this urb so we can kill it when the
+                   port is closed */
+                priv->read_urbp[i] = urb;
+        }
+
+        airprime_send_setup(port);
+
+        goto out;
+
+ errout:
+        /* some error happened, cancel any submitted urbs and clean up
+           anything that got allocated successfully */
+
+        while (i-- != 0) {
+                urb = priv->read_urbp[i];
+                buffer = urb->transfer_buffer;
+                usb_kill_urb(urb);
+                usb_free_urb(urb);
+                kfree(buffer);
+        }
+
+ out:
+        return result;
+}
+
+static void airprime_close(struct tty_struct *tty,
+                        struct usb_serial_port *port, struct file *filp)
+{
+        struct airprime_private *priv = usb_get_serial_port_data(port);
+        int i;
+
+        dbg("%s - port %d", __func__, port->number);
+
+        priv->rts_state = 0;
+        priv->dtr_state = 0;
+
+        mutex_lock(&port->serial->disc_mutex);
+        if (!port->serial->disconnected)
+                airprime_send_setup(port);
+        mutex_unlock(&port->serial->disc_mutex);
+
+        for (i = 0; i < NUM_READ_URBS; ++i) {
+                usb_kill_urb(priv->read_urbp[i]);
+                kfree(priv->read_urbp[i]->transfer_buffer);
+                usb_free_urb(priv->read_urbp[i]);
+        }
+
+        /* free up private structure */
+        kfree(priv);
+        usb_set_serial_port_data(port, NULL);
+}
+
+static int airprime_write(struct tty_struct *tty, struct usb_serial_port *port,
+                          const unsigned char *buf, int count)
+{
+        struct airprime_private *priv = usb_get_serial_port_data(port);
+        struct usb_serial *serial = port->serial;
+        struct urb *urb;
+        unsigned char *buffer;
+        unsigned long flags;
+        int status;
+        dbg("%s - port %d", __func__, port->number);
+
+        spin_lock_irqsave(&priv->lock, flags);
+        if (priv->outstanding_urbs > NUM_WRITE_URBS) {
+                spin_unlock_irqrestore(&priv->lock, flags);
+                dbg("%s - write limit hit\n", __func__);
+                return 0;
+        }
+        spin_unlock_irqrestore(&priv->lock, flags);
+        buffer = kmalloc(count, GFP_ATOMIC);
+        if (!buffer) {
+                dev_err(&port->dev, "out of memory\n");
+                return -ENOMEM;
+        }
+        urb = usb_alloc_urb(0, GFP_ATOMIC);
+        if (!urb) {
+                dev_err(&port->dev, "no more free urbs\n");
+                kfree(buffer);
+                return -ENOMEM;
+        }
+        memcpy(buffer, buf, count);
+
+        usb_serial_debug_data(debug, &port->dev, __func__, count, buffer);
+
+        usb_fill_bulk_urb(urb, serial->dev,
+                          usb_sndbulkpipe(serial->dev,
+                                          port->bulk_out_endpointAddress),
+                          buffer, count,
+                          airprime_write_bulk_callback, port);
+
+        /* send it down the pipe */
+        status = usb_submit_urb(urb, GFP_ATOMIC);
+        if (status) {
+                dev_err(&port->dev,
+                        "%s - usb_submit_urb(write bulk) failed with status = %d\n",
+                        __func__, status);
+                count = status;
+                kfree(buffer);
+        } else {
+                spin_lock_irqsave(&priv->lock, flags);
+                ++priv->outstanding_urbs;
+                spin_unlock_irqrestore(&priv->lock, flags);
+        }
+        /* we are done with this urb, so let the host driver
+         * really free it when it is finished with it */
+        usb_free_urb(urb);
+        return count;
+}
+
+static struct usb_driver airprime_driver = {
+        .name =         "airprime",
+        .probe =        usb_serial_probe,
+        .disconnect =   usb_serial_disconnect,
+        .id_table =     id_table,
+        .no_dynamic_id =        1,
+};
+
+static struct usb_serial_driver airprime_device = {
+        .driver = {
+                .owner =        THIS_MODULE,
+                .name =         "airprime",
+        },
+        .usb_driver =           &airprime_driver,
+        .id_table =             id_table,
+        .open =                 airprime_open,
+        .close =                airprime_close,
+        .write =                airprime_write,
+};
+
+static int __init airprime_init(void)
+{
+        int retval;
+
+        airprime_device.num_ports = endpoints;
+        if (endpoints < 0 || endpoints >= MAX_BULK_EPS)
+                airprime_device.num_ports = NUM_BULK_EPS;
+
+        retval = usb_serial_register(&airprime_device);
+        if (retval)
+                return retval;
+        retval = usb_register(&airprime_driver);
+        if (retval)
+                usb_serial_deregister(&airprime_device);
+        return retval;
+}
+
+static void __exit airprime_exit(void)
+{
+        dbg("%s", __func__);
+
+        usb_deregister(&airprime_driver);
+        usb_serial_deregister(&airprime_device);
+}
+
+module_init(airprime_init);
+module_exit(airprime_exit);
+MODULE_LICENSE("GPL");
+
+module_param(debug, bool, S_IRUGO | S_IWUSR);
+MODULE_PARM_DESC(debug, "Debug enabled");
+module_param(buffer_size, int, 0);
+MODULE_PARM_DESC(buffer_size,
+                "Size of the transfer buffers in bytes (default 4096)");
+module_param(endpoints, int, 0);
+MODULE_PARM_DESC(endpoints, "Number of bulk EPs to configure (default 3)");