git.oblomov.eu Git - linux-2.6/blob - drivers/usb/serial/ftdi_sio.c

   1 /*
   2  * USB FTDI SIO driver
   3  *
   4  *      Copyright (C) 1999 - 2001
   5  *          Greg Kroah-Hartman (greg@kroah.com)
   6  *          Bill Ryder (bryder@sgi.com)
   7  *      Copyright (C) 2002
   8  *          Kuba Ober (kuba@mareimbrium.org)
   9  *
  10  *      This program is free software; you can redistribute it and/or modify
  11  *      it under the terms of the GNU General Public License as published by
  12  *      the Free Software Foundation; either version 2 of the License, or
  13  *      (at your option) any later version.
  14  *
  15  * See Documentation/usb/usb-serial.txt for more information on using this
  16  * driver
  17  *
  18  * See http://ftdi-usb-sio.sourceforge.net for upto date testing info
  19  *      and extra documentation
  20  *
  21  * Change entries from 2004 and earlier can be found in versions of this
  22  * file in kernel versions prior to the 2.6.24 release.
  23  *
  24  */
  25
  26 /* Bill Ryder - bryder@sgi.com - wrote the FTDI_SIO implementation */
  27 /* Thanx to FTDI for so kindly providing details of the protocol required */
  28 /*   to talk to the device */
  29 /* Thanx to gkh and the rest of the usb dev group for all code I have
  30    assimilated :-) */
  31
  32 #include <linux/kernel.h>
  33 #include <linux/errno.h>
  34 #include <linux/init.h>
  35 #include <linux/slab.h>
  36 #include <linux/tty.h>
  37 #include <linux/tty_driver.h>
  38 #include <linux/tty_flip.h>
  39 #include <linux/module.h>
  40 #include <linux/spinlock.h>
  41 #include <linux/uaccess.h>
  42 #include <linux/usb.h>
  43 #include <linux/serial.h>
  44 #include <linux/usb/serial.h>
  45 #include "ftdi_sio.h"
  46
  47 /*
  48  * Version Information
  49  */
  50 #define DRIVER_VERSION "v1.4.3"
  51 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>, Bill Ryder <bryder@sgi.com>, Kuba Ober <kuba@mareimbrium.org>"
  52 #define DRIVER_DESC "USB FTDI Serial Converters Driver"
  53
  54 static int debug;
  55 static __u16 vendor = FTDI_VID;
  56 static __u16 product;
  57
  58 struct ftdi_private {
  59         ftdi_chip_type_t chip_type;
  60                                 /* type of device, either SIO or FT8U232AM */
  61         int baud_base;          /* baud base clock for divisor setting */
  62         int custom_divisor;     /* custom_divisor kludge, this is for
  63                                    baud_base (different from what goes to the
  64                                    chip!) */
  65         __u16 last_set_data_urb_value ;
  66                                 /* the last data state set - needed for doing
  67                                  * a break
  68                                  */
  69         int write_offset;       /* This is the offset in the usb data block to
  70                                  * write the serial data - it varies between
  71                                  * devices
  72                                  */
  73         int flags;              /* some ASYNC_xxxx flags are supported */
  74         unsigned long last_dtr_rts;     /* saved modem control outputs */
  75         wait_queue_head_t delta_msr_wait; /* Used for TIOCMIWAIT */
  76         char prev_status, diff_status;        /* Used for TIOCMIWAIT */
  77         __u8 rx_flags;          /* receive state flags (throttling) */
  78         spinlock_t rx_lock;     /* spinlock for receive state */
  79         struct delayed_work rx_work;
  80         struct usb_serial_port *port;
  81         int rx_processed;
  82         unsigned long rx_bytes;
  83
  84         __u16 interface;        /* FT2232C port interface (0 for FT232/245) */
  85
  86         speed_t force_baud;     /* if non-zero, force the baud rate to
  87                                    this value */
  88         int force_rtscts;       /* if non-zero, force RTS-CTS to always
  89                                    be enabled */
  90
  91         spinlock_t tx_lock;     /* spinlock for transmit state */
  92         unsigned long tx_bytes;
  93         unsigned long tx_outstanding_bytes;
  94         unsigned long tx_outstanding_urbs;
  95 };
  96
  97 /* struct ftdi_sio_quirk is used by devices requiring special attention. */
  98 struct ftdi_sio_quirk {
  99         int (*probe)(struct usb_serial *);
 100         /* Special settings for probed ports. */
 101         void (*port_probe)(struct ftdi_private *);
 102 };
 103
 104 static int   ftdi_jtag_probe(struct usb_serial *serial);
 105 static int   ftdi_mtxorb_hack_setup(struct usb_serial *serial);
 106 static void  ftdi_USB_UIRT_setup(struct ftdi_private *priv);
 107 static void  ftdi_HE_TIRA1_setup(struct ftdi_private *priv);
 108
 109 static struct ftdi_sio_quirk ftdi_jtag_quirk = {
 110         .probe  = ftdi_jtag_probe,
 111 };
 112
 113 static struct ftdi_sio_quirk ftdi_mtxorb_hack_quirk = {
 114         .probe  = ftdi_mtxorb_hack_setup,
 115 };
 116
 117 static struct ftdi_sio_quirk ftdi_USB_UIRT_quirk = {
 118         .port_probe = ftdi_USB_UIRT_setup,
 119 };
 120
 121 static struct ftdi_sio_quirk ftdi_HE_TIRA1_quirk = {
 122         .port_probe = ftdi_HE_TIRA1_setup,
 123 };
 124
 125 /*
 126  * The 8U232AM has the same API as the sio except for:
 127  * - it can support MUCH higher baudrates; up to:
 128  *   o 921600 for RS232 and 2000000 for RS422/485 at 48MHz
 129  *   o 230400 at 12MHz
 130  *   so .. 8U232AM's baudrate setting codes are different
 131  * - it has a two byte status code.
 132  * - it returns characters every 16ms (the FTDI does it every 40ms)
 133  *
 134  * the bcdDevice value is used to differentiate FT232BM and FT245BM from
 135  * the earlier FT8U232AM and FT8U232BM.  For now, include all known VID/PID
 136  * combinations in both tables.
 137  * FIXME: perhaps bcdDevice can also identify 12MHz FT8U232AM devices,
 138  * but I don't know if those ever went into mass production. [Ian Abbott]
 139  */
 140
 141
 142
 143 static struct usb_device_id id_table_combined [] = {
 144         { USB_DEVICE(FTDI_VID, FTDI_AMC232_PID) },
 145         { USB_DEVICE(FTDI_VID, FTDI_CANUSB_PID) },
 146         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_0_PID) },
 147         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_1_PID) },
 148         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_2_PID) },
 149         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_3_PID) },
 150         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_4_PID) },
 151         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_5_PID) },
 152         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_6_PID) },
 153         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_7_PID) },
 154         { USB_DEVICE(FTDI_VID, FTDI_ACTZWAVE_PID) },
 155         { USB_DEVICE(FTDI_VID, FTDI_IRTRANS_PID) },
 156         { USB_DEVICE(FTDI_VID, FTDI_IPLUS_PID) },
 157         { USB_DEVICE(FTDI_VID, FTDI_IPLUS2_PID) },
 158         { USB_DEVICE(FTDI_VID, FTDI_DMX4ALL) },
 159         { USB_DEVICE(FTDI_VID, FTDI_SIO_PID) },
 160         { USB_DEVICE(FTDI_VID, FTDI_8U232AM_PID) },
 161         { USB_DEVICE(FTDI_VID, FTDI_8U232AM_ALT_PID) },
 162         { USB_DEVICE(FTDI_VID, FTDI_232RL_PID) },
 163         { USB_DEVICE(FTDI_VID, FTDI_8U2232C_PID) },
 164         { USB_DEVICE(FTDI_VID, FTDI_MICRO_CHAMELEON_PID) },
 165         { USB_DEVICE(FTDI_VID, FTDI_RELAIS_PID) },
 166         { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_PID) },
 167         { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_IOBOARD_PID) },
 168         { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_MINI_IOBOARD_PID) },
 169         { USB_DEVICE(FTDI_VID, FTDI_XF_632_PID) },
 170         { USB_DEVICE(FTDI_VID, FTDI_XF_634_PID) },
 171         { USB_DEVICE(FTDI_VID, FTDI_XF_547_PID) },
 172         { USB_DEVICE(FTDI_VID, FTDI_XF_633_PID) },
 173         { USB_DEVICE(FTDI_VID, FTDI_XF_631_PID) },
 174         { USB_DEVICE(FTDI_VID, FTDI_XF_635_PID) },
 175         { USB_DEVICE(FTDI_VID, FTDI_XF_640_PID) },
 176         { USB_DEVICE(FTDI_VID, FTDI_XF_642_PID) },
 177         { USB_DEVICE(FTDI_VID, FTDI_DSS20_PID) },
 178         { USB_DEVICE(FTDI_NF_RIC_VID, FTDI_NF_RIC_PID) },
 179         { USB_DEVICE(FTDI_VID, FTDI_VNHCPCUSB_D_PID) },
 180         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_0_PID) },
 181         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_1_PID) },
 182         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_2_PID) },
 183         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_3_PID) },
 184         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_4_PID) },
 185         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_5_PID) },
 186         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_6_PID) },
 187         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0100_PID) },
 188         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0101_PID) },
 189         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0102_PID) },
 190         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0103_PID) },
 191         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0104_PID) },
 192         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0105_PID) },
 193         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0106_PID) },
 194         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0107_PID) },
 195         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0108_PID) },
 196         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0109_PID) },
 197         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010A_PID) },
 198         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010B_PID) },
 199         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010C_PID) },
 200         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010D_PID) },
 201         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010E_PID) },
 202         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010F_PID) },
 203         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0110_PID) },
 204         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0111_PID) },
 205         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0112_PID) },
 206         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0113_PID) },
 207         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0114_PID) },
 208         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0115_PID) },
 209         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0116_PID) },
 210         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0117_PID) },
 211         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0118_PID) },
 212         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0119_PID) },
 213         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011A_PID) },
 214         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011B_PID) },
 215         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011C_PID) },
 216         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011D_PID) },
 217         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011E_PID) },
 218         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011F_PID) },
 219         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0120_PID) },
 220         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0121_PID) },
 221         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0122_PID) },
 222         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0123_PID) },
 223         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0124_PID) },
 224         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0125_PID) },
 225         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0126_PID) },
 226         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0127_PID),
 227                 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
 228         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0128_PID) },
 229         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0129_PID) },
 230         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012A_PID) },
 231         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012B_PID) },
 232         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012C_PID),
 233                 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
 234         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012D_PID) },
 235         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012E_PID) },
 236         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012F_PID) },
 237         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0130_PID) },
 238         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0131_PID) },
 239         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0132_PID) },
 240         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0133_PID) },
 241         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0134_PID) },
 242         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0135_PID) },
 243         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0136_PID) },
 244         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0137_PID) },
 245         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0138_PID) },
 246         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0139_PID) },
 247         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013A_PID) },
 248         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013B_PID) },
 249         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013C_PID) },
 250         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013D_PID) },
 251         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013E_PID) },
 252         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013F_PID) },
 253         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0140_PID) },
 254         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0141_PID) },
 255         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0142_PID) },
 256         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0143_PID) },
 257         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0144_PID) },
 258         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0145_PID) },
 259         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0146_PID) },
 260         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0147_PID) },
 261         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0148_PID) },
 262         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0149_PID) },
 263         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014A_PID) },
 264         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014B_PID) },
 265         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014C_PID) },
 266         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014D_PID) },
 267         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014E_PID) },
 268         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014F_PID) },
 269         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0150_PID) },
 270         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0151_PID) },
 271         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0152_PID) },
 272         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0153_PID),
 273                 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
 274         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0154_PID),
 275                 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
 276         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0155_PID),
 277                 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
 278         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0156_PID),
 279                 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
 280         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0157_PID),
 281                 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
 282         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0158_PID),
 283                 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
 284         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0159_PID) },
 285         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015A_PID) },
 286         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015B_PID) },
 287         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015C_PID) },
 288         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015D_PID) },
 289         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015E_PID) },
 290         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015F_PID) },
 291         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0160_PID) },
 292         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0161_PID) },
 293         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0162_PID) },
 294         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0163_PID) },
 295         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0164_PID) },
 296         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0165_PID) },
 297         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0166_PID) },
 298         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0167_PID) },
 299         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0168_PID) },
 300         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0169_PID) },
 301         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016A_PID) },
 302         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016B_PID) },
 303         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016C_PID) },
 304         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016D_PID) },
 305         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016E_PID) },
 306         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016F_PID) },
 307         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0170_PID) },
 308         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0171_PID) },
 309         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0172_PID) },
 310         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0173_PID) },
 311         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0174_PID) },
 312         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0175_PID) },
 313         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0176_PID) },
 314         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0177_PID) },
 315         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0178_PID) },
 316         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0179_PID) },
 317         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017A_PID) },
 318         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017B_PID) },
 319         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017C_PID) },
 320         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017D_PID) },
 321         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017E_PID) },
 322         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017F_PID) },
 323         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0180_PID) },
 324         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0181_PID) },
 325         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0182_PID) },
 326         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0183_PID) },
 327         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0184_PID) },
 328         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0185_PID) },
 329         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0186_PID) },
 330         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0187_PID) },
 331         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0188_PID) },
 332         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0189_PID) },
 333         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018A_PID) },
 334         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018B_PID) },
 335         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018C_PID) },
 336         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018D_PID) },
 337         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018E_PID) },
 338         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018F_PID) },
 339         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0190_PID) },
 340         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0191_PID) },
 341         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0192_PID) },
 342         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0193_PID) },
 343         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0194_PID) },
 344         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0195_PID) },
 345         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0196_PID) },
 346         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0197_PID) },
 347         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0198_PID) },
 348         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0199_PID) },
 349         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019A_PID) },
 350         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019B_PID) },
 351         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019C_PID) },
 352         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019D_PID) },
 353         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019E_PID) },
 354         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019F_PID) },
 355         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A0_PID) },
 356         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A1_PID) },
 357         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A2_PID) },
 358         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A3_PID) },
 359         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A4_PID) },
 360         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A5_PID) },
 361         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A6_PID) },
 362         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A7_PID) },
 363         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A8_PID) },
 364         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A9_PID) },
 365         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AA_PID) },
 366         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AB_PID) },
 367         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AC_PID) },
 368         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AD_PID) },
 369         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AE_PID) },
 370         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AF_PID) },
 371         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B0_PID) },
 372         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B1_PID) },
 373         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B2_PID) },
 374         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B3_PID) },
 375         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B4_PID) },
 376         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B5_PID) },
 377         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B6_PID) },
 378         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B7_PID) },
 379         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B8_PID) },
 380         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B9_PID) },
 381         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BA_PID) },
 382         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BB_PID) },
 383         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BC_PID) },
 384         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BD_PID) },
 385         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BE_PID) },
 386         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BF_PID) },
 387         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C0_PID) },
 388         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C1_PID) },
 389         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C2_PID) },
 390         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C3_PID) },
 391         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C4_PID) },
 392         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C5_PID) },
 393         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C6_PID) },
 394         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C7_PID) },
 395         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C8_PID) },
 396         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C9_PID) },
 397         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CA_PID) },
 398         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CB_PID) },
 399         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CC_PID) },
 400         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CD_PID) },
 401         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CE_PID) },
 402         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CF_PID) },
 403         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D0_PID) },
 404         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D1_PID) },
 405         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D2_PID) },
 406         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D3_PID) },
 407         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D4_PID) },
 408         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D5_PID) },
 409         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D6_PID) },
 410         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D7_PID) },
 411         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D8_PID) },
 412         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D9_PID) },
 413         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DA_PID) },
 414         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DB_PID) },
 415         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DC_PID) },
 416         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DD_PID) },
 417         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DE_PID) },
 418         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DF_PID) },
 419         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E0_PID) },
 420         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E1_PID) },
 421         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E2_PID) },
 422         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E3_PID) },
 423         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E4_PID) },
 424         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E5_PID) },
 425         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E6_PID) },
 426         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E7_PID) },
 427         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E8_PID) },
 428         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E9_PID) },
 429         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EA_PID) },
 430         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EB_PID) },
 431         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EC_PID) },
 432         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01ED_PID) },
 433         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EE_PID) },
 434         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EF_PID) },
 435         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F0_PID) },
 436         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F1_PID) },
 437         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F2_PID) },
 438         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F3_PID) },
 439         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F4_PID) },
 440         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F5_PID) },
 441         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F6_PID) },
 442         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F7_PID) },
 443         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F8_PID) },
 444         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F9_PID) },
 445         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FA_PID) },
 446         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FB_PID) },
 447         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FC_PID) },
 448         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FD_PID) },
 449         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FE_PID) },
 450         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FF_PID) },
 451         { USB_DEVICE(FTDI_VID, FTDI_PERLE_ULTRAPORT_PID) },
 452         { USB_DEVICE(FTDI_VID, FTDI_PIEGROUP_PID) },
 453         { USB_DEVICE(FTDI_VID, FTDI_TNC_X_PID) },
 454         { USB_DEVICE(FTDI_VID, FTDI_USBX_707_PID) },
 455         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2101_PID) },
 456         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2102_PID) },
 457         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2103_PID) },
 458         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2104_PID) },
 459         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2106_PID) },
 460         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_1_PID) },
 461         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_2_PID) },
 462         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_1_PID) },
 463         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_2_PID) },
 464         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_1_PID) },
 465         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_2_PID) },
 466         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_1_PID) },
 467         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_2_PID) },
 468         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_3_PID) },
 469         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_4_PID) },
 470         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_1_PID) },
 471         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_2_PID) },
 472         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_3_PID) },
 473         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_4_PID) },
 474         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_1_PID) },
 475         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_2_PID) },
 476         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_3_PID) },
 477         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_4_PID) },
 478         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_1_PID) },
 479         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_2_PID) },
 480         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_3_PID) },
 481         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_4_PID) },
 482         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_5_PID) },
 483         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_6_PID) },
 484         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_7_PID) },
 485         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_8_PID) },
 486         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_1_PID) },
 487         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_2_PID) },
 488         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_3_PID) },
 489         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_4_PID) },
 490         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_5_PID) },
 491         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_6_PID) },
 492         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_7_PID) },
 493         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_8_PID) },
 494         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_1_PID) },
 495         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_2_PID) },
 496         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_3_PID) },
 497         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_4_PID) },
 498         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_5_PID) },
 499         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_6_PID) },
 500         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_7_PID) },
 501         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_8_PID) },
 502         { USB_DEVICE(IDTECH_VID, IDTECH_IDT1221U_PID) },
 503         { USB_DEVICE(OCT_VID, OCT_US101_PID) },
 504         { USB_DEVICE(FTDI_VID, FTDI_HE_TIRA1_PID),
 505                 .driver_info = (kernel_ulong_t)&ftdi_HE_TIRA1_quirk },
 506         { USB_DEVICE(FTDI_VID, FTDI_USB_UIRT_PID),
 507                 .driver_info = (kernel_ulong_t)&ftdi_USB_UIRT_quirk },
 508         { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_1) },
 509         { USB_DEVICE(FTDI_VID, PROTEGO_R2X0) },
 510         { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_3) },
 511         { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_4) },
 512         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E808_PID) },
 513         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E809_PID) },
 514         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80A_PID) },
 515         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80B_PID) },
 516         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80C_PID) },
 517         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80D_PID) },
 518         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80E_PID) },
 519         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80F_PID) },
 520         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E888_PID) },
 521         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E889_PID) },
 522         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88A_PID) },
 523         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88B_PID) },
 524         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88C_PID) },
 525         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88D_PID) },
 526         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88E_PID) },
 527         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88F_PID) },
 528         { USB_DEVICE(FTDI_VID, FTDI_ELV_UO100_PID) },
 529         { USB_DEVICE(FTDI_VID, FTDI_ELV_UM100_PID) },
 530         { USB_DEVICE(FTDI_VID, FTDI_ELV_UR100_PID) },
 531         { USB_DEVICE(FTDI_VID, FTDI_ELV_ALC8500_PID) },
 532         { USB_DEVICE(FTDI_VID, FTDI_PYRAMID_PID) },
 533         { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1000PC_PID) },
 534         { USB_DEVICE(FTDI_VID, FTDI_IBS_US485_PID) },
 535         { USB_DEVICE(FTDI_VID, FTDI_IBS_PICPRO_PID) },
 536         { USB_DEVICE(FTDI_VID, FTDI_IBS_PCMCIA_PID) },
 537         { USB_DEVICE(FTDI_VID, FTDI_IBS_PK1_PID) },
 538         { USB_DEVICE(FTDI_VID, FTDI_IBS_RS232MON_PID) },
 539         { USB_DEVICE(FTDI_VID, FTDI_IBS_APP70_PID) },
 540         { USB_DEVICE(FTDI_VID, FTDI_IBS_PEDO_PID) },
 541         { USB_DEVICE(FTDI_VID, FTDI_IBS_PROD_PID) },
 542         /*
 543          * Due to many user requests for multiple ELV devices we enable
 544          * them by default.
 545          */
 546         { USB_DEVICE(FTDI_VID, FTDI_ELV_CLI7000_PID) },
 547         { USB_DEVICE(FTDI_VID, FTDI_ELV_PPS7330_PID) },
 548         { USB_DEVICE(FTDI_VID, FTDI_ELV_TFM100_PID) },
 549         { USB_DEVICE(FTDI_VID, FTDI_ELV_UDF77_PID) },
 550         { USB_DEVICE(FTDI_VID, FTDI_ELV_UIO88_PID) },
 551         { USB_DEVICE(FTDI_VID, FTDI_ELV_UAD8_PID) },
 552         { USB_DEVICE(FTDI_VID, FTDI_ELV_UDA7_PID) },
 553         { USB_DEVICE(FTDI_VID, FTDI_ELV_USI2_PID) },
 554         { USB_DEVICE(FTDI_VID, FTDI_ELV_T1100_PID) },
 555         { USB_DEVICE(FTDI_VID, FTDI_ELV_PCD200_PID) },
 556         { USB_DEVICE(FTDI_VID, FTDI_ELV_ULA200_PID) },
 557         { USB_DEVICE(FTDI_VID, FTDI_ELV_CSI8_PID) },
 558         { USB_DEVICE(FTDI_VID, FTDI_ELV_EM1000DL_PID) },
 559         { USB_DEVICE(FTDI_VID, FTDI_ELV_PCK100_PID) },
 560         { USB_DEVICE(FTDI_VID, FTDI_ELV_RFP500_PID) },
 561         { USB_DEVICE(FTDI_VID, FTDI_ELV_FS20SIG_PID) },
 562         { USB_DEVICE(FTDI_VID, FTDI_ELV_WS300PC_PID) },
 563         { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1300PC_PID) },
 564         { USB_DEVICE(FTDI_VID, FTDI_ELV_EM1010PC_PID) },
 565         { USB_DEVICE(FTDI_VID, FTDI_ELV_WS500_PID) },
 566         { USB_DEVICE(FTDI_VID, LINX_SDMUSBQSS_PID) },
 567         { USB_DEVICE(FTDI_VID, LINX_MASTERDEVEL2_PID) },
 568         { USB_DEVICE(FTDI_VID, LINX_FUTURE_0_PID) },
 569         { USB_DEVICE(FTDI_VID, LINX_FUTURE_1_PID) },
 570         { USB_DEVICE(FTDI_VID, LINX_FUTURE_2_PID) },
 571         { USB_DEVICE(FTDI_VID, FTDI_CCSICDU20_0_PID) },
 572         { USB_DEVICE(FTDI_VID, FTDI_CCSICDU40_1_PID) },
 573         { USB_DEVICE(FTDI_VID, FTDI_CCSMACHX_2_PID) },
 574         { USB_DEVICE(FTDI_VID, INSIDE_ACCESSO) },
 575         { USB_DEVICE(INTREPID_VID, INTREPID_VALUECAN_PID) },
 576         { USB_DEVICE(INTREPID_VID, INTREPID_NEOVI_PID) },
 577         { USB_DEVICE(FALCOM_VID, FALCOM_TWIST_PID) },
 578         { USB_DEVICE(FALCOM_VID, FALCOM_SAMBA_PID) },
 579         { USB_DEVICE(FTDI_VID, FTDI_SUUNTO_SPORTS_PID) },
 580         { USB_DEVICE(TTI_VID, TTI_QL355P_PID) },
 581         { USB_DEVICE(FTDI_VID, FTDI_RM_CANVIEW_PID) },
 582         { USB_DEVICE(BANDB_VID, BANDB_USOTL4_PID) },
 583         { USB_DEVICE(BANDB_VID, BANDB_USTL4_PID) },
 584         { USB_DEVICE(BANDB_VID, BANDB_USO9ML2_PID) },
 585         { USB_DEVICE(FTDI_VID, EVER_ECO_PRO_CDS) },
 586         { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_1_PID) },
 587         { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_2_PID) },
 588         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_0_PID) },
 589         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_1_PID) },
 590         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_2_PID) },
 591         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_3_PID) },
 592         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_4_PID) },
 593         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_5_PID) },
 594         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_6_PID) },
 595         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_7_PID) },
 596         { USB_DEVICE(MOBILITY_VID, MOBILITY_USB_SERIAL_PID) },
 597         { USB_DEVICE(FTDI_VID, FTDI_ACTIVE_ROBOTS_PID) },
 598         { USB_DEVICE(FTDI_VID, FTDI_MHAM_KW_PID) },
 599         { USB_DEVICE(FTDI_VID, FTDI_MHAM_YS_PID) },
 600         { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y6_PID) },
 601         { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y8_PID) },
 602         { USB_DEVICE(FTDI_VID, FTDI_MHAM_IC_PID) },
 603         { USB_DEVICE(FTDI_VID, FTDI_MHAM_DB9_PID) },
 604         { USB_DEVICE(FTDI_VID, FTDI_MHAM_RS232_PID) },
 605         { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y9_PID) },
 606         { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_VCP_PID) },
 607         { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_D2XX_PID) },
 608         { USB_DEVICE(EVOLUTION_VID, EVOLUTION_ER1_PID) },
 609         { USB_DEVICE(EVOLUTION_VID, EVO_HYBRID_PID) },
 610         { USB_DEVICE(EVOLUTION_VID, EVO_RCM4_PID) },
 611         { USB_DEVICE(FTDI_VID, FTDI_ARTEMIS_PID) },
 612         { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16_PID) },
 613         { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16C_PID) },
 614         { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HR_PID) },
 615         { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HRC_PID) },
 616         { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16IC_PID) },
 617         { USB_DEVICE(KOBIL_VID, KOBIL_CONV_B1_PID) },
 618         { USB_DEVICE(KOBIL_VID, KOBIL_CONV_KAAN_PID) },
 619         { USB_DEVICE(POSIFLEX_VID, POSIFLEX_PP7000_PID) },
 620         { USB_DEVICE(FTDI_VID, FTDI_TTUSB_PID) },
 621         { USB_DEVICE(FTDI_VID, FTDI_ECLO_COM_1WIRE_PID) },
 622         { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_777_PID) },
 623         { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_8900F_PID) },
 624         { USB_DEVICE(FTDI_VID, FTDI_PCDJ_DAC2_PID) },
 625         { USB_DEVICE(FTDI_VID, FTDI_RRCIRKITS_LOCOBUFFER_PID) },
 626         { USB_DEVICE(FTDI_VID, FTDI_ASK_RDR400_PID) },
 627         { USB_DEVICE(ICOM_ID1_VID, ICOM_ID1_PID) },
 628         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_TMU_PID) },
 629         { USB_DEVICE(FTDI_VID, FTDI_ACG_HFDUAL_PID) },
 630         { USB_DEVICE(FTDI_VID, FTDI_YEI_SERVOCENTER31_PID) },
 631         { USB_DEVICE(FTDI_VID, FTDI_THORLABS_PID) },
 632         { USB_DEVICE(TESTO_VID, TESTO_USB_INTERFACE_PID) },
 633         { USB_DEVICE(FTDI_VID, FTDI_GAMMA_SCOUT_PID) },
 634         { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13M_PID) },
 635         { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13S_PID) },
 636         { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13U_PID) },
 637         { USB_DEVICE(ELEKTOR_VID, ELEKTOR_FT323R_PID) },
 638         { USB_DEVICE(TELLDUS_VID, TELLDUS_TELLSTICK_PID) },
 639         { USB_DEVICE(FTDI_VID, FTDI_MAXSTREAM_PID) },
 640         { USB_DEVICE(TML_VID, TML_USB_SERIAL_PID) },
 641         { USB_DEVICE(FTDI_VID, FTDI_ELSTER_UNICOM_PID) },
 642         { USB_DEVICE(FTDI_VID, FTDI_PROPOX_JTAGCABLEII_PID) },
 643         { USB_DEVICE(OLIMEX_VID, OLIMEX_ARM_USB_OCD_PID),
 644                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
 645         { USB_DEVICE(FIC_VID, FIC_NEO1973_DEBUG_PID),
 646                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
 647         { USB_DEVICE(FTDI_VID, FTDI_OOCDLINK_PID),
 648                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
 649         { USB_DEVICE(RATOC_VENDOR_ID, RATOC_PRODUCT_ID_USB60F) },
 650         { USB_DEVICE(FTDI_VID, FTDI_REU_TINY_PID) },
 651         { },                                    /* Optional parameter entry */
 652         { }                                     /* Terminating entry */
 653 };
 654
 655 MODULE_DEVICE_TABLE(usb, id_table_combined);
 656
 657 static struct usb_driver ftdi_driver = {
 658         .name =         "ftdi_sio",
 659         .probe =        usb_serial_probe,
 660         .disconnect =   usb_serial_disconnect,
 661         .id_table =     id_table_combined,
 662         .no_dynamic_id =        1,
 663 };
 664
 665 static const char *ftdi_chip_name[] = {
 666         [SIO] = "SIO",  /* the serial part of FT8U100AX */
 667         [FT8U232AM] = "FT8U232AM",
 668         [FT232BM] = "FT232BM",
 669         [FT2232C] = "FT2232C",
 670         [FT232RL] = "FT232RL",
 671 };
 672
 673
 674 /* Constants for read urb and write urb */
 675 #define BUFSZ 512
 676 #define PKTSZ 64
 677
 678 /* rx_flags */
 679 #define THROTTLED               0x01
 680 #define ACTUALLY_THROTTLED      0x02
 681
 682 /* Used for TIOCMIWAIT */
 683 #define FTDI_STATUS_B0_MASK     (FTDI_RS0_CTS | FTDI_RS0_DSR | FTDI_RS0_RI | FTDI_RS0_RLSD)
 684 #define FTDI_STATUS_B1_MASK     (FTDI_RS_BI)
 685 /* End TIOCMIWAIT */
 686
 687 #define FTDI_IMPL_ASYNC_FLAGS = (ASYNC_SPD_HI | ASYNC_SPD_VHI \
 688  | ASYNC_SPD_CUST | ASYNC_SPD_SHI | ASYNC_SPD_WARP)
 689
 690 /* function prototypes for a FTDI serial converter */
 691 static int  ftdi_sio_probe(struct usb_serial *serial,
 692                                         const struct usb_device_id *id);
 693 static void ftdi_shutdown(struct usb_serial *serial);
 694 static int  ftdi_sio_port_probe(struct usb_serial_port *port);
 695 static int  ftdi_sio_port_remove(struct usb_serial_port *port);
 696 static int  ftdi_open(struct tty_struct *tty,
 697                         struct usb_serial_port *port, struct file *filp);
 698 static void ftdi_close(struct tty_struct *tty,
 699                         struct usb_serial_port *port, struct file *filp);
 700 static int  ftdi_write(struct tty_struct *tty, struct usb_serial_port *port,
 701                         const unsigned char *buf, int count);
 702 static int  ftdi_write_room(struct tty_struct *tty);
 703 static int  ftdi_chars_in_buffer(struct tty_struct *tty);
 704 static void ftdi_write_bulk_callback(struct urb *urb);
 705 static void ftdi_read_bulk_callback(struct urb *urb);
 706 static void ftdi_process_read(struct work_struct *work);
 707 static void ftdi_set_termios(struct tty_struct *tty,
 708                         struct usb_serial_port *port, struct ktermios *old);
 709 static int  ftdi_tiocmget(struct tty_struct *tty, struct file *file);
 710 static int  ftdi_tiocmset(struct tty_struct *tty, struct file *file,
 711                         unsigned int set, unsigned int clear);
 712 static int  ftdi_ioctl(struct tty_struct *tty, struct file *file,
 713                         unsigned int cmd, unsigned long arg);
 714 static void ftdi_break_ctl(struct tty_struct *tty, int break_state);
 715 static void ftdi_throttle(struct tty_struct *tty);
 716 static void ftdi_unthrottle(struct tty_struct *tty);
 717
 718 static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base);
 719 static unsigned short int ftdi_232am_baud_to_divisor(int baud);
 720 static __u32 ftdi_232bm_baud_base_to_divisor(int baud, int base);
 721 static __u32 ftdi_232bm_baud_to_divisor(int baud);
 722
 723 static struct usb_serial_driver ftdi_sio_device = {
 724         .driver = {
 725                 .owner =        THIS_MODULE,
 726                 .name =         "ftdi_sio",
 727         },
 728         .description =          "FTDI USB Serial Device",
 729         .usb_driver =           &ftdi_driver ,
 730         .id_table =             id_table_combined,
 731         .num_ports =            1,
 732         .probe =                ftdi_sio_probe,
 733         .port_probe =           ftdi_sio_port_probe,
 734         .port_remove =          ftdi_sio_port_remove,
 735         .open =                 ftdi_open,
 736         .close =                ftdi_close,
 737         .throttle =             ftdi_throttle,
 738         .unthrottle =           ftdi_unthrottle,
 739         .write =                ftdi_write,
 740         .write_room =           ftdi_write_room,
 741         .chars_in_buffer =      ftdi_chars_in_buffer,
 742         .read_bulk_callback =   ftdi_read_bulk_callback,
 743         .write_bulk_callback =  ftdi_write_bulk_callback,
 744         .tiocmget =             ftdi_tiocmget,
 745         .tiocmset =             ftdi_tiocmset,
 746         .ioctl =                ftdi_ioctl,
 747         .set_termios =          ftdi_set_termios,
 748         .break_ctl =            ftdi_break_ctl,
 749         .shutdown =             ftdi_shutdown,
 750 };
 751
 752
 753 #define WDR_TIMEOUT 5000 /* default urb timeout */
 754 #define WDR_SHORT_TIMEOUT 1000  /* shorter urb timeout */
 755
 756 /* High and low are for DTR, RTS etc etc */
 757 #define HIGH 1
 758 #define LOW 0
 759
 760 /* number of outstanding urbs to prevent userspace DoS from happening */
 761 #define URB_UPPER_LIMIT 42
 762
 763 /*
 764  * ***************************************************************************
 765  * Utility functions
 766  * ***************************************************************************
 767  */
 768
 769 static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base)
 770 {
 771         unsigned short int divisor;
 772         /* divisor shifted 3 bits to the left */
 773         int divisor3 = base / 2 / baud;
 774         if ((divisor3 & 0x7) == 7)
 775                 divisor3++; /* round x.7/8 up to x+1 */
 776         divisor = divisor3 >> 3;
 777         divisor3 &= 0x7;
 778         if (divisor3 == 1)
 779                 divisor |= 0xc000;
 780         else if (divisor3 >= 4)
 781                 divisor |= 0x4000;
 782         else if (divisor3 != 0)
 783                 divisor |= 0x8000;
 784         else if (divisor == 1)
 785                 divisor = 0;    /* special case for maximum baud rate */
 786         return divisor;
 787 }
 788
 789 static unsigned short int ftdi_232am_baud_to_divisor(int baud)
 790 {
 791          return ftdi_232am_baud_base_to_divisor(baud, 48000000);
 792 }
 793
 794 static __u32 ftdi_232bm_baud_base_to_divisor(int baud, int base)
 795 {
 796         static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
 797         __u32 divisor;
 798         /* divisor shifted 3 bits to the left */
 799         int divisor3 = base / 2 / baud;
 800         divisor = divisor3 >> 3;
 801         divisor |= (__u32)divfrac[divisor3 & 0x7] << 14;
 802         /* Deal with special cases for highest baud rates. */
 803         if (divisor == 1)
 804                 divisor = 0;
 805         else if (divisor == 0x4001)
 806                 divisor = 1;
 807         return divisor;
 808 }
 809
 810 static __u32 ftdi_232bm_baud_to_divisor(int baud)
 811 {
 812          return ftdi_232bm_baud_base_to_divisor(baud, 48000000);
 813 }
 814
 815 #define set_mctrl(port, set)            update_mctrl((port), (set), 0)
 816 #define clear_mctrl(port, clear)        update_mctrl((port), 0, (clear))
 817
 818 static int update_mctrl(struct usb_serial_port *port, unsigned int set,
 819                                                         unsigned int clear)
 820 {
 821         struct ftdi_private *priv = usb_get_serial_port_data(port);
 822         char *buf;
 823         unsigned urb_value;
 824         int rv;
 825
 826         if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
 827                 dbg("%s - DTR|RTS not being set|cleared", __func__);
 828                 return 0;       /* no change */
 829         }
 830
 831         buf = kmalloc(1, GFP_NOIO);
 832         if (!buf)
 833                 return -ENOMEM;
 834
 835         clear &= ~set;  /* 'set' takes precedence over 'clear' */
 836         urb_value = 0;
 837         if (clear & TIOCM_DTR)
 838                 urb_value |= FTDI_SIO_SET_DTR_LOW;
 839         if (clear & TIOCM_RTS)
 840                 urb_value |= FTDI_SIO_SET_RTS_LOW;
 841         if (set & TIOCM_DTR)
 842                 urb_value |= FTDI_SIO_SET_DTR_HIGH;
 843         if (set & TIOCM_RTS)
 844                 urb_value |= FTDI_SIO_SET_RTS_HIGH;
 845         rv = usb_control_msg(port->serial->dev,
 846                                usb_sndctrlpipe(port->serial->dev, 0),
 847                                FTDI_SIO_SET_MODEM_CTRL_REQUEST,
 848                                FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE,
 849                                urb_value, priv->interface,
 850                                buf, 0, WDR_TIMEOUT);
 851
 852         kfree(buf);
 853         if (rv < 0) {
 854                 err("%s Error from MODEM_CTRL urb: DTR %s, RTS %s",
 855                                 __func__,
 856                                 (set & TIOCM_DTR) ? "HIGH" :
 857                                 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
 858                                 (set & TIOCM_RTS) ? "HIGH" :
 859                                 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
 860         } else {
 861                 dbg("%s - DTR %s, RTS %s", __func__,
 862                                 (set & TIOCM_DTR) ? "HIGH" :
 863                                 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
 864                                 (set & TIOCM_RTS) ? "HIGH" :
 865                                 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
 866                 /* FIXME: locking on last_dtr_rts */
 867                 priv->last_dtr_rts = (priv->last_dtr_rts & ~clear) | set;
 868         }
 869         return rv;
 870 }
 871
 872
 873 static __u32 get_ftdi_divisor(struct tty_struct *tty,
 874                                                 struct usb_serial_port *port)
 875 { /* get_ftdi_divisor */
 876         struct ftdi_private *priv = usb_get_serial_port_data(port);
 877         __u32 div_value = 0;
 878         int div_okay = 1;
 879         int baud;
 880
 881         /*
 882          * The logic involved in setting the baudrate can be cleanly split into
 883          * 3 steps.
 884          * 1. Standard baud rates are set in tty->termios->c_cflag
 885          * 2. If these are not enough, you can set any speed using alt_speed as
 886          * follows:
 887          *    - set tty->termios->c_cflag speed to B38400
 888          *    - set your real speed in tty->alt_speed; it gets ignored when
 889          *      alt_speed==0, (or)
 890          *    - call TIOCSSERIAL ioctl with (struct serial_struct) set as
 891          *      follows:
 892          *      flags & ASYNC_SPD_MASK == ASYNC_SPD_[HI, VHI, SHI, WARP],
 893          *      this just sets alt_speed to (HI: 57600, VHI: 115200,
 894          *      SHI: 230400, WARP: 460800)
 895          * ** Steps 1, 2 are done courtesy of tty_get_baud_rate
 896          * 3. You can also set baud rate by setting custom divisor as follows
 897          *    - set tty->termios->c_cflag speed to B38400
 898          *    - call TIOCSSERIAL ioctl with (struct serial_struct) set as
 899          *      follows:
 900          *      o flags & ASYNC_SPD_MASK == ASYNC_SPD_CUST
 901          *      o custom_divisor set to baud_base / your_new_baudrate
 902          * ** Step 3 is done courtesy of code borrowed from serial.c
 903          *    I should really spend some time and separate + move this common
 904          *    code to serial.c, it is replicated in nearly every serial driver
 905          *    you see.
 906          */
 907
 908         /* 1. Get the baud rate from the tty settings, this observes
 909               alt_speed hack */
 910
 911         baud = tty_get_baud_rate(tty);
 912         dbg("%s - tty_get_baud_rate reports speed %d", __func__, baud);
 913
 914         /* 2. Observe async-compatible custom_divisor hack, update baudrate
 915            if needed */
 916
 917         if (baud == 38400 &&
 918             ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
 919              (priv->custom_divisor)) {
 920                 baud = priv->baud_base / priv->custom_divisor;
 921                 dbg("%s - custom divisor %d sets baud rate to %d",
 922                                 __func__, priv->custom_divisor, baud);
 923         }
 924
 925         /* 3. Convert baudrate to device-specific divisor */
 926
 927         if (!baud)
 928                 baud = 9600;
 929         switch (priv->chip_type) {
 930         case SIO: /* SIO chip */
 931                 switch (baud) {
 932                 case 300: div_value = ftdi_sio_b300; break;
 933                 case 600: div_value = ftdi_sio_b600; break;
 934                 case 1200: div_value = ftdi_sio_b1200; break;
 935                 case 2400: div_value = ftdi_sio_b2400; break;
 936                 case 4800: div_value = ftdi_sio_b4800; break;
 937                 case 9600: div_value = ftdi_sio_b9600; break;
 938                 case 19200: div_value = ftdi_sio_b19200; break;
 939                 case 38400: div_value = ftdi_sio_b38400; break;
 940                 case 57600: div_value = ftdi_sio_b57600;  break;
 941                 case 115200: div_value = ftdi_sio_b115200; break;
 942                 } /* baud */
 943                 if (div_value == 0) {
 944                         dbg("%s - Baudrate (%d) requested is not supported",
 945                                                         __func__,  baud);
 946                         div_value = ftdi_sio_b9600;
 947                         baud = 9600;
 948                         div_okay = 0;
 949                 }
 950                 break;
 951         case FT8U232AM: /* 8U232AM chip */
 952                 if (baud <= 3000000) {
 953                         div_value = ftdi_232am_baud_to_divisor(baud);
 954                 } else {
 955                         dbg("%s - Baud rate too high!", __func__);
 956                         baud = 9600;
 957                         div_value = ftdi_232am_baud_to_divisor(9600);
 958                         div_okay = 0;
 959                 }
 960                 break;
 961         case FT232BM: /* FT232BM chip */
 962         case FT2232C: /* FT2232C chip */
 963         case FT232RL:
 964                 if (baud <= 3000000) {
 965                         div_value = ftdi_232bm_baud_to_divisor(baud);
 966                 } else {
 967                         dbg("%s - Baud rate too high!", __func__);
 968                         div_value = ftdi_232bm_baud_to_divisor(9600);
 969                         div_okay = 0;
 970                         baud = 9600;
 971                 }
 972                 break;
 973         } /* priv->chip_type */
 974
 975         if (div_okay) {
 976                 dbg("%s - Baud rate set to %d (divisor 0x%lX) on chip %s",
 977                         __func__, baud, (unsigned long)div_value,
 978                         ftdi_chip_name[priv->chip_type]);
 979         }
 980
 981         tty_encode_baud_rate(tty, baud, baud);
 982         return div_value;
 983 }
 984
 985 static int change_speed(struct tty_struct *tty, struct usb_serial_port *port)
 986 {
 987         struct ftdi_private *priv = usb_get_serial_port_data(port);
 988         char *buf;
 989         __u16 urb_value;
 990         __u16 urb_index;
 991         __u32 urb_index_value;
 992         int rv;
 993
 994         buf = kmalloc(1, GFP_NOIO);
 995         if (!buf)
 996                 return -ENOMEM;
 997
 998         urb_index_value = get_ftdi_divisor(tty, port);
 999         urb_value = (__u16)urb_index_value;
1000         urb_index = (__u16)(urb_index_value >> 16);
1001         if (priv->interface) {  /* FT2232C */
1002                 urb_index = (__u16)((urb_index << 8) | priv->interface);
1003         }
1004
1005         rv = usb_control_msg(port->serial->dev,
1006                             usb_sndctrlpipe(port->serial->dev, 0),
1007                             FTDI_SIO_SET_BAUDRATE_REQUEST,
1008                             FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE,
1009                             urb_value, urb_index,
1010                             buf, 0, WDR_SHORT_TIMEOUT);
1011
1012         kfree(buf);
1013         return rv;
1014 }
1015
1016
1017
1018 static int get_serial_info(struct usb_serial_port *port,
1019                                 struct serial_struct __user *retinfo)
1020 {
1021         struct ftdi_private *priv = usb_get_serial_port_data(port);
1022         struct serial_struct tmp;
1023
1024         if (!retinfo)
1025                 return -EFAULT;
1026         memset(&tmp, 0, sizeof(tmp));
1027         tmp.flags = priv->flags;
1028         tmp.baud_base = priv->baud_base;
1029         tmp.custom_divisor = priv->custom_divisor;
1030         if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
1031                 return -EFAULT;
1032         return 0;
1033 } /* get_serial_info */
1034
1035
1036 static int set_serial_info(struct tty_struct *tty,
1037         struct usb_serial_port *port, struct serial_struct __user *newinfo)
1038 { /* set_serial_info */
1039         struct ftdi_private *priv = usb_get_serial_port_data(port);
1040         struct serial_struct new_serial;
1041         struct ftdi_private old_priv;
1042
1043         if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
1044                 return -EFAULT;
1045         old_priv = *priv;
1046
1047         /* Do error checking and permission checking */
1048
1049         if (!capable(CAP_SYS_ADMIN)) {
1050                 if (((new_serial.flags & ~ASYNC_USR_MASK) !=
1051                      (priv->flags & ~ASYNC_USR_MASK)))
1052                         return -EPERM;
1053                 priv->flags = ((priv->flags & ~ASYNC_USR_MASK) |
1054                                (new_serial.flags & ASYNC_USR_MASK));
1055                 priv->custom_divisor = new_serial.custom_divisor;
1056                 goto check_and_exit;
1057         }
1058
1059         if ((new_serial.baud_base != priv->baud_base) &&
1060             (new_serial.baud_base < 9600))
1061                 return -EINVAL;
1062
1063         /* Make the changes - these are privileged changes! */
1064
1065         priv->flags = ((priv->flags & ~ASYNC_FLAGS) |
1066                                         (new_serial.flags & ASYNC_FLAGS));
1067         priv->custom_divisor = new_serial.custom_divisor;
1068
1069         tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
1070
1071 check_and_exit:
1072         if ((old_priv.flags & ASYNC_SPD_MASK) !=
1073              (priv->flags & ASYNC_SPD_MASK)) {
1074                 if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_HI)
1075                         tty->alt_speed = 57600;
1076                 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_VHI)
1077                         tty->alt_speed = 115200;
1078                 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_SHI)
1079                         tty->alt_speed = 230400;
1080                 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_WARP)
1081                         tty->alt_speed = 460800;
1082                 else
1083                         tty->alt_speed = 0;
1084         }
1085         if (((old_priv.flags & ASYNC_SPD_MASK) !=
1086              (priv->flags & ASYNC_SPD_MASK)) ||
1087             (((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
1088              (old_priv.custom_divisor != priv->custom_divisor))) {
1089                 change_speed(tty, port);
1090         }
1091         return 0;
1092
1093 } /* set_serial_info */
1094
1095
1096 /* Determine type of FTDI chip based on USB config and descriptor. */
1097 static void ftdi_determine_type(struct usb_serial_port *port)
1098 {
1099         struct ftdi_private *priv = usb_get_serial_port_data(port);
1100         struct usb_serial *serial = port->serial;
1101         struct usb_device *udev = serial->dev;
1102         unsigned version;
1103         unsigned interfaces;
1104
1105         /* Assume it is not the original SIO device for now. */
1106         priv->baud_base = 48000000 / 2;
1107         priv->write_offset = 0;
1108
1109         version = le16_to_cpu(udev->descriptor.bcdDevice);
1110         interfaces = udev->actconfig->desc.bNumInterfaces;
1111         dbg("%s: bcdDevice = 0x%x, bNumInterfaces = %u", __func__,
1112                         version, interfaces);
1113         if (interfaces > 1) {
1114                 int inter;
1115
1116                 /* Multiple interfaces.  Assume FT2232C. */
1117                 priv->chip_type = FT2232C;
1118                 /* Determine interface code. */
1119                 inter = serial->interface->altsetting->desc.bInterfaceNumber;
1120                 if (inter == 0)
1121                         priv->interface = PIT_SIOA;
1122                 else
1123                         priv->interface = PIT_SIOB;
1124                 /* BM-type devices have a bug where bcdDevice gets set
1125                  * to 0x200 when iSerialNumber is 0.  */
1126                 if (version < 0x500) {
1127                         dbg("%s: something fishy - bcdDevice too low for multi-interface device",
1128                                         __func__);
1129                 }
1130         } else if (version < 0x200) {
1131                 /* Old device.  Assume its the original SIO. */
1132                 priv->chip_type = SIO;
1133                 priv->baud_base = 12000000 / 16;
1134                 priv->write_offset = 1;
1135         } else if (version < 0x400) {
1136                 /* Assume its an FT8U232AM (or FT8U245AM) */
1137                 /* (It might be a BM because of the iSerialNumber bug,
1138                  * but it will still work as an AM device.) */
1139                 priv->chip_type = FT8U232AM;
1140         } else if (version < 0x600) {
1141                 /* Assume its an FT232BM (or FT245BM) */
1142                 priv->chip_type = FT232BM;
1143         } else {
1144                 /* Assume its an FT232R  */
1145                 priv->chip_type = FT232RL;
1146         }
1147         info("Detected %s", ftdi_chip_name[priv->chip_type]);
1148 }
1149
1150
1151 /*
1152  * ***************************************************************************
1153  * Sysfs Attribute
1154  * ***************************************************************************
1155  */
1156
1157 static ssize_t show_latency_timer(struct device *dev,
1158                                 struct device_attribute *attr, char *buf)
1159 {
1160         struct usb_serial_port *port = to_usb_serial_port(dev);
1161         struct ftdi_private *priv = usb_get_serial_port_data(port);
1162         struct usb_device *udev = port->serial->dev;
1163         unsigned short latency = 0;
1164         int rv = 0;
1165
1166
1167         dbg("%s", __func__);
1168
1169         rv = usb_control_msg(udev,
1170                              usb_rcvctrlpipe(udev, 0),
1171                              FTDI_SIO_GET_LATENCY_TIMER_REQUEST,
1172                              FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE,
1173                              0, priv->interface,
1174                              (char *) &latency, 1, WDR_TIMEOUT);
1175
1176         if (rv < 0) {
1177                 dev_err(dev, "Unable to read latency timer: %i\n", rv);
1178                 return -EIO;
1179         }
1180         return sprintf(buf, "%i\n", latency);
1181 }
1182
1183 /* Write a new value of the latency timer, in units of milliseconds. */
1184 static ssize_t store_latency_timer(struct device *dev,
1185                         struct device_attribute *attr, const char *valbuf,
1186                         size_t count)
1187 {
1188         struct usb_serial_port *port = to_usb_serial_port(dev);
1189         struct ftdi_private *priv = usb_get_serial_port_data(port);
1190         struct usb_device *udev = port->serial->dev;
1191         char buf[1];
1192         int v = simple_strtoul(valbuf, NULL, 10);
1193         int rv = 0;
1194
1195         dbg("%s: setting latency timer = %i", __func__, v);
1196
1197         rv = usb_control_msg(udev,
1198                              usb_sndctrlpipe(udev, 0),
1199                              FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
1200                              FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
1201                              v, priv->interface,
1202                              buf, 0, WDR_TIMEOUT);
1203
1204         if (rv < 0) {
1205                 dev_err(dev, "Unable to write latency timer: %i\n", rv);
1206                 return -EIO;
1207         }
1208
1209         return count;
1210 }
1211
1212 /* Write an event character directly to the FTDI register.  The ASCII
1213    value is in the low 8 bits, with the enable bit in the 9th bit. */
1214 static ssize_t store_event_char(struct device *dev,
1215         struct device_attribute *attr, const char *valbuf, size_t count)
1216 {
1217         struct usb_serial_port *port = to_usb_serial_port(dev);
1218         struct ftdi_private *priv = usb_get_serial_port_data(port);
1219         struct usb_device *udev = port->serial->dev;
1220         char buf[1];
1221         int v = simple_strtoul(valbuf, NULL, 10);
1222         int rv = 0;
1223
1224         dbg("%s: setting event char = %i", __func__, v);
1225
1226         rv = usb_control_msg(udev,
1227                              usb_sndctrlpipe(udev, 0),
1228                              FTDI_SIO_SET_EVENT_CHAR_REQUEST,
1229                              FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE,
1230                              v, priv->interface,
1231                              buf, 0, WDR_TIMEOUT);
1232
1233         if (rv < 0) {
1234                 dbg("Unable to write event character: %i", rv);
1235                 return -EIO;
1236         }
1237
1238         return count;
1239 }
1240
1241 static DEVICE_ATTR(latency_timer, S_IWUSR | S_IRUGO, show_latency_timer,
1242                                                         store_latency_timer);
1243 static DEVICE_ATTR(event_char, S_IWUSR, NULL, store_event_char);
1244
1245 static int create_sysfs_attrs(struct usb_serial_port *port)
1246 {
1247         struct ftdi_private *priv = usb_get_serial_port_data(port);
1248         int retval = 0;
1249
1250         dbg("%s", __func__);
1251
1252         /* XXX I've no idea if the original SIO supports the event_char
1253          * sysfs parameter, so I'm playing it safe.  */
1254         if (priv->chip_type != SIO) {
1255                 dbg("sysfs attributes for %s", ftdi_chip_name[priv->chip_type]);
1256                 retval = device_create_file(&port->dev, &dev_attr_event_char);
1257                 if ((!retval) &&
1258                     (priv->chip_type == FT232BM ||
1259                      priv->chip_type == FT2232C ||
1260                      priv->chip_type == FT232RL)) {
1261                         retval = device_create_file(&port->dev,
1262                                                     &dev_attr_latency_timer);
1263                 }
1264         }
1265         return retval;
1266 }
1267
1268 static void remove_sysfs_attrs(struct usb_serial_port *port)
1269 {
1270         struct ftdi_private *priv = usb_get_serial_port_data(port);
1271
1272         dbg("%s", __func__);
1273
1274         /* XXX see create_sysfs_attrs */
1275         if (priv->chip_type != SIO) {
1276                 device_remove_file(&port->dev, &dev_attr_event_char);
1277                 if (priv->chip_type == FT232BM ||
1278                     priv->chip_type == FT2232C ||
1279                     priv->chip_type == FT232RL) {
1280                         device_remove_file(&port->dev, &dev_attr_latency_timer);
1281                 }
1282         }
1283
1284 }
1285
1286 /*
1287  * ***************************************************************************
1288  * FTDI driver specific functions
1289  * ***************************************************************************
1290  */
1291
1292 /* Probe function to check for special devices */
1293 static int ftdi_sio_probe(struct usb_serial *serial,
1294                                         const struct usb_device_id *id)
1295 {
1296         struct ftdi_sio_quirk *quirk =
1297                                 (struct ftdi_sio_quirk *)id->driver_info;
1298
1299         if (quirk && quirk->probe) {
1300                 int ret = quirk->probe(serial);
1301                 if (ret != 0)
1302                         return ret;
1303         }
1304
1305         usb_set_serial_data(serial, (void *)id->driver_info);
1306
1307         return 0;
1308 }
1309
1310 static int ftdi_sio_port_probe(struct usb_serial_port *port)
1311 {
1312         struct ftdi_private *priv;
1313         struct ftdi_sio_quirk *quirk = usb_get_serial_data(port->serial);
1314
1315
1316         dbg("%s", __func__);
1317
1318         priv = kzalloc(sizeof(struct ftdi_private), GFP_KERNEL);
1319         if (!priv) {
1320                 err("%s- kmalloc(%Zd) failed.", __func__,
1321                                         sizeof(struct ftdi_private));
1322                 return -ENOMEM;
1323         }
1324
1325         spin_lock_init(&priv->rx_lock);
1326         spin_lock_init(&priv->tx_lock);
1327         init_waitqueue_head(&priv->delta_msr_wait);
1328         /* This will push the characters through immediately rather
1329            than queue a task to deliver them */
1330         priv->flags = ASYNC_LOW_LATENCY;
1331
1332         if (quirk && quirk->port_probe)
1333                 quirk->port_probe(priv);
1334
1335         /* Increase the size of read buffers */
1336         kfree(port->bulk_in_buffer);
1337         port->bulk_in_buffer = kmalloc(BUFSZ, GFP_KERNEL);
1338         if (!port->bulk_in_buffer) {
1339                 kfree(priv);
1340                 return -ENOMEM;
1341         }
1342         if (port->read_urb) {
1343                 port->read_urb->transfer_buffer = port->bulk_in_buffer;
1344                 port->read_urb->transfer_buffer_length = BUFSZ;
1345         }
1346
1347         INIT_DELAYED_WORK(&priv->rx_work, ftdi_process_read);
1348         priv->port = port;
1349
1350         /* Free port's existing write urb and transfer buffer. */
1351         if (port->write_urb) {
1352                 usb_free_urb(port->write_urb);
1353                 port->write_urb = NULL;
1354         }
1355         kfree(port->bulk_out_buffer);
1356         port->bulk_out_buffer = NULL;
1357
1358         usb_set_serial_port_data(port, priv);
1359
1360         ftdi_determine_type(port);
1361         create_sysfs_attrs(port);
1362         return 0;
1363 }
1364
1365 /* Setup for the USB-UIRT device, which requires hardwired
1366  * baudrate (38400 gets mapped to 312500) */
1367 /* Called from usbserial:serial_probe */
1368 static void ftdi_USB_UIRT_setup(struct ftdi_private *priv)
1369 {
1370         dbg("%s", __func__);
1371
1372         priv->flags |= ASYNC_SPD_CUST;
1373         priv->custom_divisor = 77;
1374         priv->force_baud = 38400;
1375 } /* ftdi_USB_UIRT_setup */
1376
1377 /* Setup for the HE-TIRA1 device, which requires hardwired
1378  * baudrate (38400 gets mapped to 100000) and RTS-CTS enabled.  */
1379
1380 static void ftdi_HE_TIRA1_setup(struct ftdi_private *priv)
1381 {
1382         dbg("%s", __func__);
1383
1384         priv->flags |= ASYNC_SPD_CUST;
1385         priv->custom_divisor = 240;
1386         priv->force_baud = 38400;
1387         priv->force_rtscts = 1;
1388 } /* ftdi_HE_TIRA1_setup */
1389
1390 /*
1391  * First port on JTAG adaptors such as Olimex arm-usb-ocd or the FIC/OpenMoko
1392  * Neo1973 Debug Board is reserved for JTAG interface and can be accessed from
1393  * userspace using openocd.
1394  */
1395 static int ftdi_jtag_probe(struct usb_serial *serial)
1396 {
1397         struct usb_device *udev = serial->dev;
1398         struct usb_interface *interface = serial->interface;
1399
1400         dbg("%s", __func__);
1401
1402         if (interface == udev->actconfig->interface[0]) {
1403                 info("Ignoring serial port reserved for JTAG");
1404                 return -ENODEV;
1405         }
1406
1407         return 0;
1408 }
1409
1410 /*
1411  * The Matrix Orbital VK204-25-USB has an invalid IN endpoint.
1412  * We have to correct it if we want to read from it.
1413  */
1414 static int ftdi_mtxorb_hack_setup(struct usb_serial *serial)
1415 {
1416         struct usb_host_endpoint *ep = serial->dev->ep_in[1];
1417         struct usb_endpoint_descriptor *ep_desc = &ep->desc;
1418
1419         if (ep->enabled && ep_desc->wMaxPacketSize == 0) {
1420                 ep_desc->wMaxPacketSize = cpu_to_le16(0x40);
1421                 info("Fixing invalid wMaxPacketSize on read pipe");
1422         }
1423
1424         return 0;
1425 }
1426
1427 /* ftdi_shutdown is called from usbserial:usb_serial_disconnect
1428  *   it is called when the usb device is disconnected
1429  *
1430  *   usbserial:usb_serial_disconnect
1431  *      calls __serial_close for each open of the port
1432  *      shutdown is called then (ie ftdi_shutdown)
1433  */
1434 static void ftdi_shutdown(struct usb_serial *serial)
1435 {
1436         dbg("%s", __func__);
1437 }
1438
1439 static int ftdi_sio_port_remove(struct usb_serial_port *port)
1440 {
1441         struct ftdi_private *priv = usb_get_serial_port_data(port);
1442
1443         dbg("%s", __func__);
1444
1445         remove_sysfs_attrs(port);
1446
1447         /* all open ports are closed at this point
1448          *    (by usbserial.c:__serial_close, which calls ftdi_close)
1449          */
1450
1451         if (priv) {
1452                 usb_set_serial_port_data(port, NULL);
1453                 kfree(priv);
1454         }
1455
1456         return 0;
1457 }
1458
1459 static int ftdi_open(struct tty_struct *tty,
1460                         struct usb_serial_port *port, struct file *filp)
1461 { /* ftdi_open */
1462         struct usb_device *dev = port->serial->dev;
1463         struct ftdi_private *priv = usb_get_serial_port_data(port);
1464         unsigned long flags;
1465
1466         int result = 0;
1467         char buf[1]; /* Needed for the usb_control_msg I think */
1468
1469         dbg("%s", __func__);
1470
1471         spin_lock_irqsave(&priv->tx_lock, flags);
1472         priv->tx_bytes = 0;
1473         spin_unlock_irqrestore(&priv->tx_lock, flags);
1474         spin_lock_irqsave(&priv->rx_lock, flags);
1475         priv->rx_bytes = 0;
1476         spin_unlock_irqrestore(&priv->rx_lock, flags);
1477
1478         if (tty)
1479                 tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
1480
1481         /* No error checking for this (will get errors later anyway) */
1482         /* See ftdi_sio.h for description of what is reset */
1483         usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1484                         FTDI_SIO_RESET_REQUEST, FTDI_SIO_RESET_REQUEST_TYPE,
1485                         FTDI_SIO_RESET_SIO,
1486                         priv->interface, buf, 0, WDR_TIMEOUT);
1487
1488         /* Termios defaults are set by usb_serial_init. We don't change
1489            port->tty->termios - this would loose speed settings, etc.
1490            This is same behaviour as serial.c/rs_open() - Kuba */
1491
1492         /* ftdi_set_termios  will send usb control messages */
1493         if (tty)
1494                 ftdi_set_termios(tty, port, tty->termios);
1495
1496         /* FIXME: Flow control might be enabled, so it should be checked -
1497            we have no control of defaults! */
1498         /* Turn on RTS and DTR since we are not flow controlling by default */
1499         set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1500
1501         /* Not throttled */
1502         spin_lock_irqsave(&priv->rx_lock, flags);
1503         priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
1504         spin_unlock_irqrestore(&priv->rx_lock, flags);
1505
1506         /* Start reading from the device */
1507         priv->rx_processed = 0;
1508         usb_fill_bulk_urb(port->read_urb, dev,
1509                         usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress),
1510                         port->read_urb->transfer_buffer,
1511                                 port->read_urb->transfer_buffer_length,
1512                         ftdi_read_bulk_callback, port);
1513         result = usb_submit_urb(port->read_urb, GFP_KERNEL);
1514         if (result)
1515                 err("%s - failed submitting read urb, error %d",
1516                                                         __func__, result);
1517
1518
1519         return result;
1520 } /* ftdi_open */
1521
1522
1523
1524 /*
1525  * usbserial:__serial_close  only calls ftdi_close if the point is open
1526  *
1527  *   This only gets called when it is the last close
1528  *
1529  *
1530  */
1531
1532 static void ftdi_close(struct tty_struct *tty,
1533                         struct usb_serial_port *port, struct file *filp)
1534 { /* ftdi_close */
1535         unsigned int c_cflag = tty->termios->c_cflag;
1536         struct ftdi_private *priv = usb_get_serial_port_data(port);
1537         char buf[1];
1538
1539         dbg("%s", __func__);
1540
1541         mutex_lock(&port->serial->disc_mutex);
1542         if (c_cflag & HUPCL && !port->serial->disconnected) {
1543                 /* Disable flow control */
1544                 if (usb_control_msg(port->serial->dev,
1545                                     usb_sndctrlpipe(port->serial->dev, 0),
1546                                     FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1547                                     FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1548                                     0, priv->interface, buf, 0,
1549                                     WDR_TIMEOUT) < 0) {
1550                         err("error from flowcontrol urb");
1551                 }
1552
1553                 /* drop RTS and DTR */
1554                 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1555         } /* Note change no line if hupcl is off */
1556         mutex_unlock(&port->serial->disc_mutex);
1557
1558         /* cancel any scheduled reading */
1559         cancel_delayed_work(&priv->rx_work);
1560         flush_scheduled_work();
1561
1562         /* shutdown our bulk read */
1563         usb_kill_urb(port->read_urb);
1564 } /* ftdi_close */
1565
1566
1567
1568 /* The SIO requires the first byte to have:
1569  *  B0 1
1570  *  B1 0
1571  *  B2..7 length of message excluding byte 0
1572  *
1573  * The new devices do not require this byte
1574  */
1575 static int ftdi_write(struct tty_struct *tty, struct usb_serial_port *port,
1576                            const unsigned char *buf, int count)
1577 { /* ftdi_write */
1578         struct ftdi_private *priv = usb_get_serial_port_data(port);
1579         struct urb *urb;
1580         unsigned char *buffer;
1581         int data_offset ;       /* will be 1 for the SIO and 0 otherwise */
1582         int status;
1583         int transfer_size;
1584         unsigned long flags;
1585
1586         dbg("%s port %d, %d bytes", __func__, port->number, count);
1587
1588         if (count == 0) {
1589                 dbg("write request of 0 bytes");
1590                 return 0;
1591         }
1592         spin_lock_irqsave(&priv->tx_lock, flags);
1593         if (priv->tx_outstanding_urbs > URB_UPPER_LIMIT) {
1594                 spin_unlock_irqrestore(&priv->tx_lock, flags);
1595                 dbg("%s - write limit hit\n", __func__);
1596                 return 0;
1597         }
1598         priv->tx_outstanding_urbs++;
1599         spin_unlock_irqrestore(&priv->tx_lock, flags);
1600
1601         data_offset = priv->write_offset;
1602         dbg("data_offset set to %d", data_offset);
1603
1604         /* Determine total transfer size */
1605         transfer_size = count;
1606         if (data_offset > 0) {
1607                 /* Original sio needs control bytes too... */
1608                 transfer_size += (data_offset *
1609                                 ((count + (PKTSZ - 1 - data_offset)) /
1610                                  (PKTSZ - data_offset)));
1611         }
1612
1613         buffer = kmalloc(transfer_size, GFP_ATOMIC);
1614         if (!buffer) {
1615                 err("%s ran out of kernel memory for urb ...", __func__);
1616                 count = -ENOMEM;
1617                 goto error_no_buffer;
1618         }
1619
1620         urb = usb_alloc_urb(0, GFP_ATOMIC);
1621         if (!urb) {
1622                 err("%s - no more free urbs", __func__);
1623                 count = -ENOMEM;
1624                 goto error_no_urb;
1625         }
1626
1627         /* Copy data */
1628         if (data_offset > 0) {
1629                 /* Original sio requires control byte at start of
1630                    each packet. */
1631                 int user_pktsz = PKTSZ - data_offset;
1632                 int todo = count;
1633                 unsigned char *first_byte = buffer;
1634                 const unsigned char *current_position = buf;
1635
1636                 while (todo > 0) {
1637                         if (user_pktsz > todo)
1638                                 user_pktsz = todo;
1639                         /* Write the control byte at the front of the packet*/
1640                         *first_byte = 1 | ((user_pktsz) << 2);
1641                         /* Copy data for packet */
1642                         memcpy(first_byte + data_offset,
1643                                 current_position, user_pktsz);
1644                         first_byte += user_pktsz + data_offset;
1645                         current_position += user_pktsz;
1646                         todo -= user_pktsz;
1647                 }
1648         } else {
1649                 /* No control byte required. */
1650                 /* Copy in the data to send */
1651                 memcpy(buffer, buf, count);
1652         }
1653
1654         usb_serial_debug_data(debug, &port->dev, __func__,
1655                                                 transfer_size, buffer);
1656
1657         /* fill the buffer and send it */
1658         usb_fill_bulk_urb(urb, port->serial->dev,
1659                         usb_sndbulkpipe(port->serial->dev,
1660                                         port->bulk_out_endpointAddress),
1661                         buffer, transfer_size,
1662                         ftdi_write_bulk_callback, port);
1663
1664         status = usb_submit_urb(urb, GFP_ATOMIC);
1665         if (status) {
1666                 err("%s - failed submitting write urb, error %d",
1667                                                         __func__, status);
1668                 count = status;
1669                 goto error;
1670         } else {
1671                 spin_lock_irqsave(&priv->tx_lock, flags);
1672                 priv->tx_outstanding_bytes += count;
1673                 priv->tx_bytes += count;
1674                 spin_unlock_irqrestore(&priv->tx_lock, flags);
1675         }
1676
1677         /* we are done with this urb, so let the host driver
1678          * really free it when it is finished with it */
1679         usb_free_urb(urb);
1680
1681         dbg("%s write returning: %d", __func__, count);
1682         return count;
1683 error:
1684         usb_free_urb(urb);
1685 error_no_urb:
1686         kfree(buffer);
1687 error_no_buffer:
1688         spin_lock_irqsave(&priv->tx_lock, flags);
1689         priv->tx_outstanding_urbs--;
1690         spin_unlock_irqrestore(&priv->tx_lock, flags);
1691         return count;
1692 } /* ftdi_write */
1693
1694
1695 /* This function may get called when the device is closed */
1696
1697 static void ftdi_write_bulk_callback(struct urb *urb)
1698 {
1699         unsigned long flags;
1700         struct usb_serial_port *port = urb->context;
1701         struct ftdi_private *priv;
1702         int data_offset;       /* will be 1 for the SIO and 0 otherwise */
1703         unsigned long countback;
1704         int status = urb->status;
1705
1706         /* free up the transfer buffer, as usb_free_urb() does not do this */
1707         kfree(urb->transfer_buffer);
1708
1709         dbg("%s - port %d", __func__, port->number);
1710
1711         if (status) {
1712                 dbg("nonzero write bulk status received: %d", status);
1713                 return;
1714         }
1715
1716         priv = usb_get_serial_port_data(port);
1717         if (!priv) {
1718                 dbg("%s - bad port private data pointer - exiting", __func__);
1719                 return;
1720         }
1721         /* account for transferred data */
1722         countback = urb->actual_length;
1723         data_offset = priv->write_offset;
1724         if (data_offset > 0) {
1725                 /* Subtract the control bytes */
1726                 countback -= (data_offset * DIV_ROUND_UP(countback, PKTSZ));
1727         }
1728         spin_lock_irqsave(&priv->tx_lock, flags);
1729         --priv->tx_outstanding_urbs;
1730         priv->tx_outstanding_bytes -= countback;
1731         spin_unlock_irqrestore(&priv->tx_lock, flags);
1732
1733         usb_serial_port_softint(port);
1734 } /* ftdi_write_bulk_callback */
1735
1736
1737 static int ftdi_write_room(struct tty_struct *tty)
1738 {
1739         struct usb_serial_port *port = tty->driver_data;
1740         struct ftdi_private *priv = usb_get_serial_port_data(port);
1741         int room;
1742         unsigned long flags;
1743
1744         dbg("%s - port %d", __func__, port->number);
1745
1746         spin_lock_irqsave(&priv->tx_lock, flags);
1747         if (priv->tx_outstanding_urbs < URB_UPPER_LIMIT) {
1748                 /*
1749                  * We really can take anything the user throws at us
1750                  * but let's pick a nice big number to tell the tty
1751                  * layer that we have lots of free space
1752                  */
1753                 room = 2048;
1754         } else {
1755                 room = 0;
1756         }
1757         spin_unlock_irqrestore(&priv->tx_lock, flags);
1758         return room;
1759 }
1760
1761 static int ftdi_chars_in_buffer(struct tty_struct *tty)
1762 {
1763         struct usb_serial_port *port = tty->driver_data;
1764         struct ftdi_private *priv = usb_get_serial_port_data(port);
1765         int buffered;
1766         unsigned long flags;
1767
1768         dbg("%s - port %d", __func__, port->number);
1769
1770         spin_lock_irqsave(&priv->tx_lock, flags);
1771         buffered = (int)priv->tx_outstanding_bytes;
1772         spin_unlock_irqrestore(&priv->tx_lock, flags);
1773         if (buffered < 0) {
1774                 err("%s outstanding tx bytes is negative!", __func__);
1775                 buffered = 0;
1776         }
1777         return buffered;
1778 }
1779
1780 static void ftdi_read_bulk_callback(struct urb *urb)
1781 {
1782         struct usb_serial_port *port = urb->context;
1783         struct tty_struct *tty;
1784         struct ftdi_private *priv;
1785         unsigned long countread;
1786         unsigned long flags;
1787         int status = urb->status;
1788
1789         if (urb->number_of_packets > 0) {
1790                 err("%s transfer_buffer_length %d actual_length %d number of packets %d",
1791                                 __func__,
1792                                 urb->transfer_buffer_length,
1793                                 urb->actual_length, urb->number_of_packets);
1794                 err("%s transfer_flags %x ", __func__, urb->transfer_flags);
1795         }
1796
1797         dbg("%s - port %d", __func__, port->number);
1798
1799         if (port->port.count <= 0)
1800                 return;
1801
1802         tty = port->port.tty;
1803         if (!tty) {
1804                 dbg("%s - bad tty pointer - exiting", __func__);
1805                 return;
1806         }
1807
1808         priv = usb_get_serial_port_data(port);
1809         if (!priv) {
1810                 dbg("%s - bad port private data pointer - exiting", __func__);
1811                 return;
1812         }
1813
1814         if (urb != port->read_urb)
1815                 err("%s - Not my urb!", __func__);
1816
1817         if (status) {
1818                 /* This will happen at close every time so it is a dbg not an
1819                    err */
1820                 dbg("(this is ok on close) nonzero read bulk status received: %d", status);
1821                 return;
1822         }
1823
1824         /* count data bytes, but not status bytes */
1825         countread = urb->actual_length;
1826         countread -= 2 * DIV_ROUND_UP(countread, PKTSZ);
1827         spin_lock_irqsave(&priv->rx_lock, flags);
1828         priv->rx_bytes += countread;
1829         spin_unlock_irqrestore(&priv->rx_lock, flags);
1830
1831         ftdi_process_read(&priv->rx_work.work);
1832
1833 } /* ftdi_read_bulk_callback */
1834
1835
1836 static void ftdi_process_read(struct work_struct *work)
1837 { /* ftdi_process_read */
1838         struct ftdi_private *priv =
1839                 container_of(work, struct ftdi_private, rx_work.work);
1840         struct usb_serial_port *port = priv->port;
1841         struct urb *urb;
1842         struct tty_struct *tty;
1843         char error_flag;
1844         unsigned char *data;
1845
1846         int i;
1847         int result;
1848         int need_flip;
1849         int packet_offset;
1850         unsigned long flags;
1851
1852         dbg("%s - port %d", __func__, port->number);
1853
1854         if (port->port.count <= 0)
1855                 return;
1856
1857         tty = port->port.tty;
1858         if (!tty) {
1859                 dbg("%s - bad tty pointer - exiting", __func__);
1860                 return;
1861         }
1862
1863         priv = usb_get_serial_port_data(port);
1864         if (!priv) {
1865                 dbg("%s - bad port private data pointer - exiting", __func__);
1866                 return;
1867         }
1868
1869         urb = port->read_urb;
1870         if (!urb) {
1871                 dbg("%s - bad read_urb pointer - exiting", __func__);
1872                 return;
1873         }
1874
1875         data = urb->transfer_buffer;
1876
1877         if (priv->rx_processed) {
1878                 dbg("%s - already processed: %d bytes, %d remain", __func__,
1879                                 priv->rx_processed,
1880                                 urb->actual_length - priv->rx_processed);
1881         } else {
1882                 /* The first two bytes of every read packet are status */
1883                 if (urb->actual_length > 2)
1884                         usb_serial_debug_data(debug, &port->dev, __func__,
1885                                                 urb->actual_length, data);
1886                 else
1887                         dbg("Status only: %03oo %03oo", data[0], data[1]);
1888         }
1889
1890
1891         /* TO DO -- check for hung up line and handle appropriately: */
1892         /*   send hangup  */
1893         /* See acm.c - you do a tty_hangup  - eg tty_hangup(tty) */
1894         /* if CD is dropped and the line is not CLOCAL then we should hangup */
1895
1896         need_flip = 0;
1897         for (packet_offset = priv->rx_processed;
1898                 packet_offset < urb->actual_length; packet_offset += PKTSZ) {
1899                 int length;
1900
1901                 /* Compare new line status to the old one, signal if different/
1902                    N.B. packet may be processed more than once, but differences
1903                    are only processed once.  */
1904                 if (priv != NULL) {
1905                         char new_status = data[packet_offset + 0] &
1906                                                         FTDI_STATUS_B0_MASK;
1907                         if (new_status != priv->prev_status) {
1908                                 priv->diff_status |=
1909                                         new_status ^ priv->prev_status;
1910                                 wake_up_interruptible(&priv->delta_msr_wait);
1911                                 priv->prev_status = new_status;
1912                         }
1913                 }
1914
1915                 length = min(PKTSZ, urb->actual_length-packet_offset)-2;
1916                 if (length < 0) {
1917                         err("%s - bad packet length: %d", __func__, length+2);
1918                         length = 0;
1919                 }
1920
1921                 if (priv->rx_flags & THROTTLED) {
1922                         dbg("%s - throttled", __func__);
1923                         break;
1924                 }
1925                 if (tty_buffer_request_room(tty, length) < length) {
1926                         /* break out & wait for throttling/unthrottling to
1927                            happen */
1928                         dbg("%s - receive room low", __func__);
1929                         break;
1930                 }
1931
1932                 /* Handle errors and break */
1933                 error_flag = TTY_NORMAL;
1934                 /* Although the device uses a bitmask and hence can have
1935                    multiple errors on a packet - the order here sets the
1936                    priority the error is returned to the tty layer  */
1937
1938                 if (data[packet_offset+1] & FTDI_RS_OE) {
1939                         error_flag = TTY_OVERRUN;
1940                         dbg("OVERRRUN error");
1941                 }
1942                 if (data[packet_offset+1] & FTDI_RS_BI) {
1943                         error_flag = TTY_BREAK;
1944                         dbg("BREAK received");
1945                 }
1946                 if (data[packet_offset+1] & FTDI_RS_PE) {
1947                         error_flag = TTY_PARITY;
1948                         dbg("PARITY error");
1949                 }
1950                 if (data[packet_offset+1] & FTDI_RS_FE) {
1951                         error_flag = TTY_FRAME;
1952                         dbg("FRAMING error");
1953                 }
1954                 if (length > 0) {
1955                         for (i = 2; i < length+2; i++) {
1956                                 /* Note that the error flag is duplicated for
1957                                    every character received since we don't know
1958                                    which character it applied to */
1959                                 tty_insert_flip_char(tty,
1960                                         data[packet_offset + i], error_flag);
1961                         }
1962                         need_flip = 1;
1963                 }
1964
1965 #ifdef NOT_CORRECT_BUT_KEEPING_IT_FOR_NOW
1966                 /* if a parity error is detected you get status packets forever
1967                    until a character is sent without a parity error.
1968                    This doesn't work well since the application receives a
1969                    never ending stream of bad data - even though new data
1970                    hasn't been sent. Therefore I (bill) have taken this out.
1971                    However - this might make sense for framing errors and so on
1972                    so I am leaving the code in for now.
1973                 */
1974                 else {
1975                         if (error_flag != TTY_NORMAL) {
1976                                 dbg("error_flag is not normal");
1977                                 /* In this case it is just status - if that is
1978                                    an error send a bad character */
1979                                 if (tty->flip.count >= TTY_FLIPBUF_SIZE)
1980                                         tty_flip_buffer_push(tty);
1981                                 tty_insert_flip_char(tty, 0xff, error_flag);
1982                                 need_flip = 1;
1983                         }
1984                 }
1985 #endif
1986         } /* "for(packet_offset=0..." */
1987
1988         /* Low latency */
1989         if (need_flip)
1990                 tty_flip_buffer_push(tty);
1991
1992         if (packet_offset < urb->actual_length) {
1993                 /* not completely processed - record progress */
1994                 priv->rx_processed = packet_offset;
1995                 dbg("%s - incomplete, %d bytes processed, %d remain",
1996                                 __func__, packet_offset,
1997                                 urb->actual_length - packet_offset);
1998                 /* check if we were throttled while processing */
1999                 spin_lock_irqsave(&priv->rx_lock, flags);
2000                 if (priv->rx_flags & THROTTLED) {
2001                         priv->rx_flags |= ACTUALLY_THROTTLED;
2002                         spin_unlock_irqrestore(&priv->rx_lock, flags);
2003                         dbg("%s - deferring remainder until unthrottled",
2004                                         __func__);
2005                         return;
2006                 }
2007                 spin_unlock_irqrestore(&priv->rx_lock, flags);
2008                 /* if the port is closed stop trying to read */
2009                 if (port->port.count > 0)
2010                         /* delay processing of remainder */
2011                         schedule_delayed_work(&priv->rx_work, 1);
2012                 else
2013                         dbg("%s - port is closed", __func__);
2014                 return;
2015         }
2016
2017         /* urb is completely processed */
2018         priv->rx_processed = 0;
2019
2020         /* if the port is closed stop trying to read */
2021         if (port->port.count > 0) {
2022                 /* Continue trying to always read  */
2023                 usb_fill_bulk_urb(port->read_urb, port->serial->dev,
2024                         usb_rcvbulkpipe(port->serial->dev,
2025                                         port->bulk_in_endpointAddress),
2026                         port->read_urb->transfer_buffer,
2027                         port->read_urb->transfer_buffer_length,
2028                         ftdi_read_bulk_callback, port);
2029
2030                 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
2031                 if (result)
2032                         err("%s - failed resubmitting read urb, error %d",
2033                                                         __func__, result);
2034         }
2035 } /* ftdi_process_read */
2036
2037
2038 static void ftdi_break_ctl(struct tty_struct *tty, int break_state)
2039 {
2040         struct usb_serial_port *port = tty->driver_data;
2041         struct ftdi_private *priv = usb_get_serial_port_data(port);
2042         __u16 urb_value = 0;
2043         char buf[1];
2044
2045         /* break_state = -1 to turn on break, and 0 to turn off break */
2046         /* see drivers/char/tty_io.c to see it used */
2047         /* last_set_data_urb_value NEVER has the break bit set in it */
2048
2049         if (break_state)
2050                 urb_value = priv->last_set_data_urb_value | FTDI_SIO_SET_BREAK;
2051         else
2052                 urb_value = priv->last_set_data_urb_value;
2053
2054         if (usb_control_msg(port->serial->dev,
2055                         usb_sndctrlpipe(port->serial->dev, 0),
2056                         FTDI_SIO_SET_DATA_REQUEST,
2057                         FTDI_SIO_SET_DATA_REQUEST_TYPE,
2058                         urb_value , priv->interface,
2059                         buf, 0, WDR_TIMEOUT) < 0) {
2060                 err("%s FAILED to enable/disable break state (state was %d)",
2061                                                         __func__, break_state);
2062         }
2063
2064         dbg("%s break state is %d - urb is %d", __func__,
2065                                                 break_state, urb_value);
2066
2067 }
2068
2069
2070 /* old_termios contains the original termios settings and tty->termios contains
2071  * the new setting to be used
2072  * WARNING: set_termios calls this with old_termios in kernel space
2073  */
2074
2075 static void ftdi_set_termios(struct tty_struct *tty,
2076                 struct usb_serial_port *port, struct ktermios *old_termios)
2077 { /* ftdi_termios */
2078         struct usb_device *dev = port->serial->dev;
2079         struct ftdi_private *priv = usb_get_serial_port_data(port);
2080         struct ktermios *termios = tty->termios;
2081         unsigned int cflag = termios->c_cflag;
2082         __u16 urb_value; /* will hold the new flags */
2083         char buf[1]; /* Perhaps I should dynamically alloc this? */
2084
2085         /* Added for xon/xoff support */
2086         unsigned int iflag = termios->c_iflag;
2087         unsigned char vstop;
2088         unsigned char vstart;
2089
2090         dbg("%s", __func__);
2091
2092         /* Force baud rate if this device requires it, unless it is set to
2093            B0. */
2094         if (priv->force_baud && ((termios->c_cflag & CBAUD) != B0)) {
2095                 dbg("%s: forcing baud rate for this device", __func__);
2096                 tty_encode_baud_rate(tty, priv->force_baud,
2097                                         priv->force_baud);
2098         }
2099
2100         /* Force RTS-CTS if this device requires it. */
2101         if (priv->force_rtscts) {
2102                 dbg("%s: forcing rtscts for this device", __func__);
2103                 termios->c_cflag |= CRTSCTS;
2104         }
2105
2106         cflag = termios->c_cflag;
2107
2108         /* FIXME -For this cut I don't care if the line is really changing or
2109            not  - so just do the change regardless  - should be able to
2110            compare old_termios and tty->termios */
2111         /* NOTE These routines can get interrupted by
2112            ftdi_sio_read_bulk_callback  - need to examine what this means -
2113            don't see any problems yet */
2114
2115         /* Set number of data bits, parity, stop bits */
2116
2117         termios->c_cflag &= ~CMSPAR;
2118
2119         urb_value = 0;
2120         urb_value |= (cflag & CSTOPB ? FTDI_SIO_SET_DATA_STOP_BITS_2 :
2121                       FTDI_SIO_SET_DATA_STOP_BITS_1);
2122         urb_value |= (cflag & PARENB ?
2123                       (cflag & PARODD ? FTDI_SIO_SET_DATA_PARITY_ODD :
2124                        FTDI_SIO_SET_DATA_PARITY_EVEN) :
2125                       FTDI_SIO_SET_DATA_PARITY_NONE);
2126         if (cflag & CSIZE) {
2127                 switch (cflag & CSIZE) {
2128                 case CS5: urb_value |= 5; dbg("Setting CS5"); break;
2129                 case CS6: urb_value |= 6; dbg("Setting CS6"); break;
2130                 case CS7: urb_value |= 7; dbg("Setting CS7"); break;
2131                 case CS8: urb_value |= 8; dbg("Setting CS8"); break;
2132                 default:
2133                         err("CSIZE was set but not CS5-CS8");
2134                 }
2135         }
2136
2137         /* This is needed by the break command since it uses the same command
2138            - but is or'ed with this value  */
2139         priv->last_set_data_urb_value = urb_value;
2140
2141         if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2142                             FTDI_SIO_SET_DATA_REQUEST,
2143                             FTDI_SIO_SET_DATA_REQUEST_TYPE,
2144                             urb_value , priv->interface,
2145                             buf, 0, WDR_SHORT_TIMEOUT) < 0) {
2146                 err("%s FAILED to set databits/stopbits/parity", __func__);
2147         }
2148
2149         /* Now do the baudrate */
2150         if ((cflag & CBAUD) == B0) {
2151                 /* Disable flow control */
2152                 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2153                                     FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2154                                     FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2155                                     0, priv->interface,
2156                                     buf, 0, WDR_TIMEOUT) < 0) {
2157                         err("%s error from disable flowcontrol urb", __func__);
2158                 }
2159                 /* Drop RTS and DTR */
2160                 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2161         } else {
2162                 /* set the baudrate determined before */
2163                 if (change_speed(tty, port))
2164                         err("%s urb failed to set baudrate", __func__);
2165                 /* Ensure RTS and DTR are raised when baudrate changed from 0 */
2166                 if (!old_termios || (old_termios->c_cflag & CBAUD) == B0)
2167                         set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2168         }
2169
2170         /* Set flow control */
2171         /* Note device also supports DTR/CD (ugh) and Xon/Xoff in hardware */
2172         if (cflag & CRTSCTS) {
2173                 dbg("%s Setting to CRTSCTS flow control", __func__);
2174                 if (usb_control_msg(dev,
2175                                     usb_sndctrlpipe(dev, 0),
2176                                     FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2177                                     FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2178                                     0 , (FTDI_SIO_RTS_CTS_HS | priv->interface),
2179                                     buf, 0, WDR_TIMEOUT) < 0) {
2180                         err("urb failed to set to rts/cts flow control");
2181                 }
2182
2183         } else {
2184                 /*
2185                  * Xon/Xoff code
2186                  *
2187                  * Check the IXOFF status in the iflag component of the
2188                  * termios structure. If IXOFF is not set, the pre-xon/xoff
2189                  * code is executed.
2190                  */
2191                 if (iflag & IXOFF) {
2192                         dbg("%s  request to enable xonxoff iflag=%04x",
2193                                                         __func__, iflag);
2194                         /* Try to enable the XON/XOFF on the ftdi_sio
2195                          * Set the vstart and vstop -- could have been done up
2196                          * above where a lot of other dereferencing is done but
2197                          * that would be very inefficient as vstart and vstop
2198                          * are not always needed.
2199                          */
2200                         vstart = termios->c_cc[VSTART];
2201                         vstop = termios->c_cc[VSTOP];
2202                         urb_value = (vstop << 8) | (vstart);
2203
2204                         if (usb_control_msg(dev,
2205                                             usb_sndctrlpipe(dev, 0),
2206                                             FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2207                                             FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2208                                             urb_value , (FTDI_SIO_XON_XOFF_HS
2209                                                          | priv->interface),
2210                                             buf, 0, WDR_TIMEOUT) < 0) {
2211                                 err("urb failed to set to xon/xoff flow control");
2212                         }
2213                 } else {
2214                         /* else clause to only run if cflag ! CRTSCTS and iflag
2215                          * ! XOFF. CHECKME Assuming XON/XOFF handled by tty
2216                          * stack - not by device */
2217                         dbg("%s Turning off hardware flow control", __func__);
2218                         if (usb_control_msg(dev,
2219                                             usb_sndctrlpipe(dev, 0),
2220                                             FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2221                                             FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2222                                             0, priv->interface,
2223                                             buf, 0, WDR_TIMEOUT) < 0) {
2224                                 err("urb failed to clear flow control");
2225                         }
2226                 }
2227
2228         }
2229         return;
2230 }
2231
2232 static int ftdi_tiocmget(struct tty_struct *tty, struct file *file)
2233 {
2234         struct usb_serial_port *port = tty->driver_data;
2235         struct ftdi_private *priv = usb_get_serial_port_data(port);
2236         unsigned char buf[2];
2237         int ret;
2238
2239         dbg("%s TIOCMGET", __func__);
2240         switch (priv->chip_type) {
2241         case SIO:
2242                 /* Request the status from the device */
2243                 ret = usb_control_msg(port->serial->dev,
2244                            usb_rcvctrlpipe(port->serial->dev, 0),
2245                            FTDI_SIO_GET_MODEM_STATUS_REQUEST,
2246                            FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
2247                            0, 0,
2248                            buf, 1, WDR_TIMEOUT);
2249                 if (ret < 0) {
2250                         err("%s Could not get modem status of device - err: %d", __func__,
2251                             ret);
2252                         return ret;
2253                 }
2254                 break;
2255         case FT8U232AM:
2256         case FT232BM:
2257         case FT2232C:
2258         case FT232RL:
2259                 /* the 8U232AM returns a two byte value (the sio is a 1 byte
2260                    value) - in the same format as the data returned from the in
2261                    point */
2262                 ret = usb_control_msg(port->serial->dev,
2263                                    usb_rcvctrlpipe(port->serial->dev, 0),
2264                                    FTDI_SIO_GET_MODEM_STATUS_REQUEST,
2265                                    FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
2266                                    0, priv->interface,
2267                                    buf, 2, WDR_TIMEOUT);
2268                 if (ret < 0) {
2269                         err("%s Could not get modem status of device - err: %d", __func__,
2270                             ret);
2271                         return ret;
2272                 }
2273                 break;
2274         default:
2275                 return -EFAULT;
2276                 break;
2277         }
2278
2279         return  (buf[0] & FTDI_SIO_DSR_MASK ? TIOCM_DSR : 0) |
2280                 (buf[0] & FTDI_SIO_CTS_MASK ? TIOCM_CTS : 0) |
2281                 (buf[0]  & FTDI_SIO_RI_MASK  ? TIOCM_RI  : 0) |
2282                 (buf[0]  & FTDI_SIO_RLSD_MASK ? TIOCM_CD  : 0) |
2283                 priv->last_dtr_rts;
2284 }
2285
2286 static int ftdi_tiocmset(struct tty_struct *tty, struct file *file,
2287                         unsigned int set, unsigned int clear)
2288 {
2289         struct usb_serial_port *port = tty->driver_data;
2290         dbg("%s TIOCMSET", __func__);
2291         return update_mctrl(port, set, clear);
2292 }
2293
2294
2295 static int ftdi_ioctl(struct tty_struct *tty, struct file *file,
2296                                         unsigned int cmd, unsigned long arg)
2297 {
2298         struct usb_serial_port *port = tty->driver_data;
2299         struct ftdi_private *priv = usb_get_serial_port_data(port);
2300
2301         dbg("%s cmd 0x%04x", __func__, cmd);
2302
2303         /* Based on code from acm.c and others */
2304         switch (cmd) {
2305
2306         case TIOCGSERIAL: /* gets serial port data */
2307                 return get_serial_info(port,
2308                                         (struct serial_struct __user *) arg);
2309
2310         case TIOCSSERIAL: /* sets serial port data */
2311                 return set_serial_info(tty, port,
2312                                         (struct serial_struct __user *) arg);
2313
2314         /*
2315          * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
2316          * - mask passed in arg for lines of interest
2317          *   (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
2318          * Caller should use TIOCGICOUNT to see which one it was.
2319          *
2320          * This code is borrowed from linux/drivers/char/serial.c
2321          */
2322         case TIOCMIWAIT:
2323                 while (priv != NULL) {
2324                         interruptible_sleep_on(&priv->delta_msr_wait);
2325                         /* see if a signal did it */
2326                         if (signal_pending(current))
2327                                 return -ERESTARTSYS;
2328                         else {
2329                                 char diff = priv->diff_status;
2330
2331                                 if (diff == 0)
2332                                         return -EIO; /* no change => error */
2333
2334                                 /* Consume all events */
2335                                 priv->diff_status = 0;
2336
2337                                 /* Return 0 if caller wanted to know about
2338                                    these bits */
2339                                 if (((arg & TIOCM_RNG) && (diff & FTDI_RS0_RI)) ||
2340                                     ((arg & TIOCM_DSR) && (diff & FTDI_RS0_DSR)) ||
2341                                     ((arg & TIOCM_CD)  && (diff & FTDI_RS0_RLSD)) ||
2342                                     ((arg & TIOCM_CTS) && (diff & FTDI_RS0_CTS))) {
2343                                         return 0;
2344                                 }
2345                                 /*
2346                                  * Otherwise caller can't care less about what
2347                                  * happened,and so we continue to wait for more
2348                                  * events.
2349                                  */
2350                         }
2351                 }
2352                 return 0;
2353         default:
2354                 break;
2355         }
2356         /* This is not necessarily an error - turns out the higher layers
2357          * will do some ioctls themselves (see comment above)
2358          */
2359         dbg("%s arg not supported - it was 0x%04x - check /usr/include/asm/ioctls.h", __func__, cmd);
2360         return -ENOIOCTLCMD;
2361 }
2362
2363 static void ftdi_throttle(struct tty_struct *tty)
2364 {
2365         struct usb_serial_port *port = tty->driver_data;
2366         struct ftdi_private *priv = usb_get_serial_port_data(port);
2367         unsigned long flags;
2368
2369         dbg("%s - port %d", __func__, port->number);
2370
2371         spin_lock_irqsave(&priv->rx_lock, flags);
2372         priv->rx_flags |= THROTTLED;
2373         spin_unlock_irqrestore(&priv->rx_lock, flags);
2374 }
2375
2376
2377 static void ftdi_unthrottle(struct tty_struct *tty)
2378 {
2379         struct usb_serial_port *port = tty->driver_data;
2380         struct ftdi_private *priv = usb_get_serial_port_data(port);
2381         int actually_throttled;
2382         unsigned long flags;
2383
2384         dbg("%s - port %d", __func__, port->number);
2385
2386         spin_lock_irqsave(&priv->rx_lock, flags);
2387         actually_throttled = priv->rx_flags & ACTUALLY_THROTTLED;
2388         priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
2389         spin_unlock_irqrestore(&priv->rx_lock, flags);
2390
2391         if (actually_throttled)
2392                 schedule_delayed_work(&priv->rx_work, 0);
2393 }
2394
2395 static int __init ftdi_init(void)
2396 {
2397         int retval;
2398
2399         dbg("%s", __func__);
2400         if (vendor > 0 && product > 0) {
2401                 /* Add user specified VID/PID to reserved element of table. */
2402                 int i;
2403                 for (i = 0; id_table_combined[i].idVendor; i++)
2404                         ;
2405                 id_table_combined[i].match_flags = USB_DEVICE_ID_MATCH_DEVICE;
2406                 id_table_combined[i].idVendor = vendor;
2407                 id_table_combined[i].idProduct = product;
2408         }
2409         retval = usb_serial_register(&ftdi_sio_device);
2410         if (retval)
2411                 goto failed_sio_register;
2412         retval = usb_register(&ftdi_driver);
2413         if (retval)
2414                 goto failed_usb_register;
2415
2416         info(DRIVER_VERSION ":" DRIVER_DESC);
2417         return 0;
2418 failed_usb_register:
2419         usb_serial_deregister(&ftdi_sio_device);
2420 failed_sio_register:
2421         return retval;
2422 }
2423
2424
2425 static void __exit ftdi_exit(void)
2426 {
2427
2428         dbg("%s", __func__);
2429
2430         usb_deregister(&ftdi_driver);
2431         usb_serial_deregister(&ftdi_sio_device);
2432
2433 }
2434
2435
2436 module_init(ftdi_init);
2437 module_exit(ftdi_exit);
2438
2439 MODULE_AUTHOR(DRIVER_AUTHOR);
2440 MODULE_DESCRIPTION(DRIVER_DESC);
2441 MODULE_LICENSE("GPL");
2442
2443 module_param(debug, bool, S_IRUGO | S_IWUSR);
2444 MODULE_PARM_DESC(debug, "Debug enabled or not");
2445 module_param(vendor, ushort, 0);
2446 MODULE_PARM_DESC(vendor, "User specified vendor ID (default="
2447                 __MODULE_STRING(FTDI_VID)")");
2448 module_param(product, ushort, 0);
2449 MODULE_PARM_DESC(vendor, "User specified product ID");
2450