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