drivers/usb/serial/ftdi_sio.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * USB FTDI SIO driver
   4  *
   5  *      Copyright (C) 2009 - 2013
   6  *          Johan Hovold (jhovold@gmail.com)
   7  *      Copyright (C) 1999 - 2001
   8  *          Greg Kroah-Hartman (greg@kroah.com)
   9  *          Bill Ryder (bryder@sgi.com)
  10  *      Copyright (C) 2002
  11  *          Kuba Ober (kuba@mareimbrium.org)
  12  *
  13  * See Documentation/usb/usb-serial.rst for more information on using this
  14  * driver
  15  *
  16  * See http://ftdi-usb-sio.sourceforge.net for up to date testing info
  17  *      and extra documentation
  18  *
  19  * Change entries from 2004 and earlier can be found in versions of this
  20  * file in kernel versions prior to the 2.6.24 release.
  21  *
  22  */
  23
  24 /* Bill Ryder - bryder@sgi.com - wrote the FTDI_SIO implementation */
  25 /* Thanx to FTDI for so kindly providing details of the protocol required */
  26 /*   to talk to the device */
  27 /* Thanx to gkh and the rest of the usb dev group for all code I have
  28    assimilated :-) */
  29
  30 #include <linux/kernel.h>
  31 #include <linux/errno.h>
  32 #include <linux/slab.h>
  33 #include <linux/tty.h>
  34 #include <linux/tty_driver.h>
  35 #include <linux/tty_flip.h>
  36 #include <linux/module.h>
  37 #include <linux/spinlock.h>
  38 #include <linux/mutex.h>
  39 #include <linux/uaccess.h>
  40 #include <linux/usb.h>
  41 #include <linux/serial.h>
  42 #include <linux/gpio/driver.h>
  43 #include <linux/usb/serial.h>
  44 #include "ftdi_sio.h"
  45 #include "ftdi_sio_ids.h"
  46
  47 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>, Bill Ryder <bryder@sgi.com>, Kuba Ober <kuba@mareimbrium.org>, Andreas Mohr, Johan Hovold <jhovold@gmail.com>"
  48 #define DRIVER_DESC "USB FTDI Serial Converters Driver"
  49
  50
  51 struct ftdi_private {
  52         enum ftdi_chip_type chip_type;
  53                                 /* type of device, either SIO or FT8U232AM */
  54         int baud_base;          /* baud base clock for divisor setting */
  55         int custom_divisor;     /* custom_divisor kludge, this is for
  56                                    baud_base (different from what goes to the
  57                                    chip!) */
  58         u16 last_set_data_value; /* the last data state set - needed for doing
  59                                   * a break
  60                                   */
  61         int flags;              /* some ASYNC_xxxx flags are supported */
  62         unsigned long last_dtr_rts;     /* saved modem control outputs */
  63         char prev_status;        /* Used for TIOCMIWAIT */
  64         char transmit_empty;    /* If transmitter is empty or not */
  65         u16 interface;          /* FT2232C, FT2232H or FT4232H port interface
  66                                    (0 for FT232/245) */
  67
  68         speed_t force_baud;     /* if non-zero, force the baud rate to
  69                                    this value */
  70         int force_rtscts;       /* if non-zero, force RTS-CTS to always
  71                                    be enabled */
  72
  73         unsigned int latency;           /* latency setting in use */
  74         unsigned short max_packet_size;
  75         struct mutex cfg_lock; /* Avoid mess by parallel calls of config ioctl() and change_speed() */
  76 #ifdef CONFIG_GPIOLIB
  77         struct gpio_chip gc;
  78         struct mutex gpio_lock; /* protects GPIO state */
  79         bool gpio_registered;   /* is the gpiochip in kernel registered */
  80         bool gpio_used;         /* true if the user requested a gpio */
  81         u8 gpio_altfunc;        /* which pins are in gpio mode */
  82         u8 gpio_output;         /* pin directions cache */
  83         u8 gpio_value;          /* pin value for outputs */
  84 #endif
  85 };
  86
  87 /* struct ftdi_sio_quirk is used by devices requiring special attention. */
  88 struct ftdi_sio_quirk {
  89         int (*probe)(struct usb_serial *);
  90         /* Special settings for probed ports. */
  91         void (*port_probe)(struct ftdi_private *);
  92 };
  93
  94 static int   ftdi_jtag_probe(struct usb_serial *serial);
  95 static int   ftdi_NDI_device_setup(struct usb_serial *serial);
  96 static int   ftdi_stmclite_probe(struct usb_serial *serial);
  97 static int   ftdi_8u2232c_probe(struct usb_serial *serial);
  98 static void  ftdi_USB_UIRT_setup(struct ftdi_private *priv);
  99 static void  ftdi_HE_TIRA1_setup(struct ftdi_private *priv);
 100
 101 static const struct ftdi_sio_quirk ftdi_jtag_quirk = {
 102         .probe  = ftdi_jtag_probe,
 103 };
 104
 105 static const struct ftdi_sio_quirk ftdi_NDI_device_quirk = {
 106         .probe  = ftdi_NDI_device_setup,
 107 };
 108
 109 static const struct ftdi_sio_quirk ftdi_USB_UIRT_quirk = {
 110         .port_probe = ftdi_USB_UIRT_setup,
 111 };
 112
 113 static const struct ftdi_sio_quirk ftdi_HE_TIRA1_quirk = {
 114         .port_probe = ftdi_HE_TIRA1_setup,
 115 };
 116
 117 static const struct ftdi_sio_quirk ftdi_stmclite_quirk = {
 118         .probe  = ftdi_stmclite_probe,
 119 };
 120
 121 static const struct ftdi_sio_quirk ftdi_8u2232c_quirk = {
 122         .probe  = ftdi_8u2232c_probe,
 123 };
 124
 125 /*
 126  * The 8U232AM has the same API as the sio except for:
 127  * - it can support MUCH higher baudrates; up to:
 128  *   o 921600 for RS232 and 2000000 for RS422/485 at 48MHz
 129  *   o 230400 at 12MHz
 130  *   so .. 8U232AM's baudrate setting codes are different
 131  * - it has a two byte status code.
 132  * - it returns characters every 16ms (the FTDI does it every 40ms)
 133  *
 134  * the bcdDevice value is used to differentiate FT232BM and FT245BM from
 135  * the earlier FT8U232AM and FT8U232BM.  For now, include all known VID/PID
 136  * combinations in both tables.
 137  * FIXME: perhaps bcdDevice can also identify 12MHz FT8U232AM devices,
 138  * but I don't know if those ever went into mass production. [Ian Abbott]
 139  */
 140
 141
 142
 143 /*
 144  * Device ID not listed? Test it using
 145  * /sys/bus/usb-serial/drivers/ftdi_sio/new_id and send a patch or report.
 146  */
 147 static const struct usb_device_id id_table_combined[] = {
 148         { USB_DEVICE(FTDI_VID, FTDI_BRICK_PID) },
 149         { USB_DEVICE(FTDI_VID, FTDI_ZEITCONTROL_TAGTRACE_MIFARE_PID) },
 150         { USB_DEVICE(FTDI_VID, FTDI_CTI_MINI_PID) },
 151         { USB_DEVICE(FTDI_VID, FTDI_CTI_NANO_PID) },
 152         { USB_DEVICE(FTDI_VID, FTDI_AMC232_PID) },
 153         { USB_DEVICE(FTDI_VID, FTDI_CANUSB_PID) },
 154         { USB_DEVICE(FTDI_VID, FTDI_CANDAPTER_PID) },
 155         { USB_DEVICE(FTDI_VID, FTDI_BM_ATOM_NANO_PID) },
 156         { USB_DEVICE(FTDI_VID, FTDI_NXTCAM_PID) },
 157         { USB_DEVICE(FTDI_VID, FTDI_EV3CON_PID) },
 158         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_0_PID) },
 159         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_1_PID) },
 160         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_2_PID) },
 161         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_3_PID) },
 162         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_4_PID) },
 163         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_5_PID) },
 164         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_6_PID) },
 165         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_7_PID) },
 166         { USB_DEVICE(FTDI_VID, FTDI_USINT_CAT_PID) },
 167         { USB_DEVICE(FTDI_VID, FTDI_USINT_WKEY_PID) },
 168         { USB_DEVICE(FTDI_VID, FTDI_USINT_RS232_PID) },
 169         { USB_DEVICE(FTDI_VID, FTDI_ACTZWAVE_PID) },
 170         { USB_DEVICE(FTDI_VID, FTDI_IRTRANS_PID) },
 171         { USB_DEVICE(FTDI_VID, FTDI_IPLUS_PID) },
 172         { USB_DEVICE(FTDI_VID, FTDI_IPLUS2_PID) },
 173         { USB_DEVICE(FTDI_VID, FTDI_DMX4ALL) },
 174         { USB_DEVICE(FTDI_VID, FTDI_SIO_PID) },
 175         { USB_DEVICE(FTDI_VID, FTDI_8U232AM_PID) },
 176         { USB_DEVICE(FTDI_VID, FTDI_8U232AM_ALT_PID) },
 177         { USB_DEVICE(FTDI_VID, FTDI_232RL_PID) },
 178         { USB_DEVICE(FTDI_VID, FTDI_8U2232C_PID) ,
 179                 .driver_info = (kernel_ulong_t)&ftdi_8u2232c_quirk },
 180         { USB_DEVICE(FTDI_VID, FTDI_4232H_PID) },
 181         { USB_DEVICE(FTDI_VID, FTDI_232H_PID) },
 182         { USB_DEVICE(FTDI_VID, FTDI_FTX_PID) },
 183         { USB_DEVICE(FTDI_VID, FTDI_MICRO_CHAMELEON_PID) },
 184         { USB_DEVICE(FTDI_VID, FTDI_RELAIS_PID) },
 185         { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_PID) },
 186         { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_SNIFFER_PID) },
 187         { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_THROTTLE_PID) },
 188         { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_GATEWAY_PID) },
 189         { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_GBM_PID) },
 190         { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_GBM_BOOST_PID) },
 191         { USB_DEVICE(NEWPORT_VID, NEWPORT_AGILIS_PID) },
 192         { USB_DEVICE(NEWPORT_VID, NEWPORT_CONEX_CC_PID) },
 193         { USB_DEVICE(NEWPORT_VID, NEWPORT_CONEX_AGP_PID) },
 194         { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_IOBOARD_PID) },
 195         { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_MINI_IOBOARD_PID) },
 196         { USB_DEVICE(FTDI_VID, FTDI_SPROG_II) },
 197         { USB_DEVICE(FTDI_VID, FTDI_TAGSYS_LP101_PID) },
 198         { USB_DEVICE(FTDI_VID, FTDI_TAGSYS_P200X_PID) },
 199         { USB_DEVICE(FTDI_VID, FTDI_LENZ_LIUSB_PID) },
 200         { USB_DEVICE(FTDI_VID, FTDI_XF_632_PID) },
 201         { USB_DEVICE(FTDI_VID, FTDI_XF_634_PID) },
 202         { USB_DEVICE(FTDI_VID, FTDI_XF_547_PID) },
 203         { USB_DEVICE(FTDI_VID, FTDI_XF_633_PID) },
 204         { USB_DEVICE(FTDI_VID, FTDI_XF_631_PID) },
 205         { USB_DEVICE(FTDI_VID, FTDI_XF_635_PID) },
 206         { USB_DEVICE(FTDI_VID, FTDI_XF_640_PID) },
 207         { USB_DEVICE(FTDI_VID, FTDI_XF_642_PID) },
 208         { USB_DEVICE(FTDI_VID, FTDI_DSS20_PID) },
 209         { USB_DEVICE(FTDI_VID, FTDI_URBAN_0_PID) },
 210         { USB_DEVICE(FTDI_VID, FTDI_URBAN_1_PID) },
 211         { USB_DEVICE(FTDI_NF_RIC_VID, FTDI_NF_RIC_PID) },
 212         { USB_DEVICE(FTDI_VID, FTDI_VNHCPCUSB_D_PID) },
 213         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_0_PID) },
 214         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_1_PID) },
 215         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_2_PID) },
 216         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_3_PID) },
 217         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_4_PID) },
 218         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_5_PID) },
 219         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_6_PID) },
 220         { USB_DEVICE(FTDI_VID, FTDI_R2000KU_TRUE_RNG) },
 221         { USB_DEVICE(FTDI_VID, FTDI_VARDAAN_PID) },
 222         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0100_PID) },
 223         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0101_PID) },
 224         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0102_PID) },
 225         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0103_PID) },
 226         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0104_PID) },
 227         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0105_PID) },
 228         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0106_PID) },
 229         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0107_PID) },
 230         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0108_PID) },
 231         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0109_PID) },
 232         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010A_PID) },
 233         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010B_PID) },
 234         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010C_PID) },
 235         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010D_PID) },
 236         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010E_PID) },
 237         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010F_PID) },
 238         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0110_PID) },
 239         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0111_PID) },
 240         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0112_PID) },
 241         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0113_PID) },
 242         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0114_PID) },
 243         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0115_PID) },
 244         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0116_PID) },
 245         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0117_PID) },
 246         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0118_PID) },
 247         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0119_PID) },
 248         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011A_PID) },
 249         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011B_PID) },
 250         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011C_PID) },
 251         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011D_PID) },
 252         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011E_PID) },
 253         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011F_PID) },
 254         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0120_PID) },
 255         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0121_PID) },
 256         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0122_PID) },
 257         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0123_PID) },
 258         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0124_PID) },
 259         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0125_PID) },
 260         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0126_PID) },
 261         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0127_PID) },
 262         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0128_PID) },
 263         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0129_PID) },
 264         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012A_PID) },
 265         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012B_PID) },
 266         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012C_PID) },
 267         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012D_PID) },
 268         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012E_PID) },
 269         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012F_PID) },
 270         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0130_PID) },
 271         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0131_PID) },
 272         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0132_PID) },
 273         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0133_PID) },
 274         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0134_PID) },
 275         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0135_PID) },
 276         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0136_PID) },
 277         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0137_PID) },
 278         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0138_PID) },
 279         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0139_PID) },
 280         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013A_PID) },
 281         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013B_PID) },
 282         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013C_PID) },
 283         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013D_PID) },
 284         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013E_PID) },
 285         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013F_PID) },
 286         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0140_PID) },
 287         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0141_PID) },
 288         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0142_PID) },
 289         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0143_PID) },
 290         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0144_PID) },
 291         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0145_PID) },
 292         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0146_PID) },
 293         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0147_PID) },
 294         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0148_PID) },
 295         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0149_PID) },
 296         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014A_PID) },
 297         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014B_PID) },
 298         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014C_PID) },
 299         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014D_PID) },
 300         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014E_PID) },
 301         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014F_PID) },
 302         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0150_PID) },
 303         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0151_PID) },
 304         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0152_PID) },
 305         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0153_PID) },
 306         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0154_PID) },
 307         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0155_PID) },
 308         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0156_PID) },
 309         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0157_PID) },
 310         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0158_PID) },
 311         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0159_PID) },
 312         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015A_PID) },
 313         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015B_PID) },
 314         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015C_PID) },
 315         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015D_PID) },
 316         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015E_PID) },
 317         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015F_PID) },
 318         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0160_PID) },
 319         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0161_PID) },
 320         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0162_PID) },
 321         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0163_PID) },
 322         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0164_PID) },
 323         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0165_PID) },
 324         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0166_PID) },
 325         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0167_PID) },
 326         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0168_PID) },
 327         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0169_PID) },
 328         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016A_PID) },
 329         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016B_PID) },
 330         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016C_PID) },
 331         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016D_PID) },
 332         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016E_PID) },
 333         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016F_PID) },
 334         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0170_PID) },
 335         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0171_PID) },
 336         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0172_PID) },
 337         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0173_PID) },
 338         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0174_PID) },
 339         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0175_PID) },
 340         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0176_PID) },
 341         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0177_PID) },
 342         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0178_PID) },
 343         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0179_PID) },
 344         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017A_PID) },
 345         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017B_PID) },
 346         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017C_PID) },
 347         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017D_PID) },
 348         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017E_PID) },
 349         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017F_PID) },
 350         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0180_PID) },
 351         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0181_PID) },
 352         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0182_PID) },
 353         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0183_PID) },
 354         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0184_PID) },
 355         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0185_PID) },
 356         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0186_PID) },
 357         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0187_PID) },
 358         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0188_PID) },
 359         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0189_PID) },
 360         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018A_PID) },
 361         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018B_PID) },
 362         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018C_PID) },
 363         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018D_PID) },
 364         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018E_PID) },
 365         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018F_PID) },
 366         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0190_PID) },
 367         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0191_PID) },
 368         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0192_PID) },
 369         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0193_PID) },
 370         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0194_PID) },
 371         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0195_PID) },
 372         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0196_PID) },
 373         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0197_PID) },
 374         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0198_PID) },
 375         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0199_PID) },
 376         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019A_PID) },
 377         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019B_PID) },
 378         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019C_PID) },
 379         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019D_PID) },
 380         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019E_PID) },
 381         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019F_PID) },
 382         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A0_PID) },
 383         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A1_PID) },
 384         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A2_PID) },
 385         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A3_PID) },
 386         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A4_PID) },
 387         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A5_PID) },
 388         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A6_PID) },
 389         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A7_PID) },
 390         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A8_PID) },
 391         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A9_PID) },
 392         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AA_PID) },
 393         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AB_PID) },
 394         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AC_PID) },
 395         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AD_PID) },
 396         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AE_PID) },
 397         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AF_PID) },
 398         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B0_PID) },
 399         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B1_PID) },
 400         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B2_PID) },
 401         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B3_PID) },
 402         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B4_PID) },
 403         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B5_PID) },
 404         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B6_PID) },
 405         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B7_PID) },
 406         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B8_PID) },
 407         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B9_PID) },
 408         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BA_PID) },
 409         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BB_PID) },
 410         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BC_PID) },
 411         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BD_PID) },
 412         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BE_PID) },
 413         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BF_PID) },
 414         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C0_PID) },
 415         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C1_PID) },
 416         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C2_PID) },
 417         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C3_PID) },
 418         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C4_PID) },
 419         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C5_PID) },
 420         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C6_PID) },
 421         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C7_PID) },
 422         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C8_PID) },
 423         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C9_PID) },
 424         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CA_PID) },
 425         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CB_PID) },
 426         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CC_PID) },
 427         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CD_PID) },
 428         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CE_PID) },
 429         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CF_PID) },
 430         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D0_PID) },
 431         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D1_PID) },
 432         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D2_PID) },
 433         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D3_PID) },
 434         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D4_PID) },
 435         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D5_PID) },
 436         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D6_PID) },
 437         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D7_PID) },
 438         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D8_PID) },
 439         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D9_PID) },
 440         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DA_PID) },
 441         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DB_PID) },
 442         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DC_PID) },
 443         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DD_PID) },
 444         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DE_PID) },
 445         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DF_PID) },
 446         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E0_PID) },
 447         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E1_PID) },
 448         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E2_PID) },
 449         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E3_PID) },
 450         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E4_PID) },
 451         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E5_PID) },
 452         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E6_PID) },
 453         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E7_PID) },
 454         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E8_PID) },
 455         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E9_PID) },
 456         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EA_PID) },
 457         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EB_PID) },
 458         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EC_PID) },
 459         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01ED_PID) },
 460         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EE_PID) },
 461         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EF_PID) },
 462         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F0_PID) },
 463         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F1_PID) },
 464         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F2_PID) },
 465         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F3_PID) },
 466         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F4_PID) },
 467         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F5_PID) },
 468         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F6_PID) },
 469         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F7_PID) },
 470         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F8_PID) },
 471         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F9_PID) },
 472         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FA_PID) },
 473         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FB_PID) },
 474         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FC_PID) },
 475         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FD_PID) },
 476         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FE_PID) },
 477         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FF_PID) },
 478         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_4701_PID) },
 479         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9300_PID) },
 480         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9301_PID) },
 481         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9302_PID) },
 482         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9303_PID) },
 483         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9304_PID) },
 484         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9305_PID) },
 485         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9306_PID) },
 486         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9307_PID) },
 487         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9308_PID) },
 488         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9309_PID) },
 489         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_930A_PID) },
 490         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_930B_PID) },
 491         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_930C_PID) },
 492         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_930D_PID) },
 493         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_930E_PID) },
 494         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_930F_PID) },
 495         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9310_PID) },
 496         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9311_PID) },
 497         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9312_PID) },
 498         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9313_PID) },
 499         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9314_PID) },
 500         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9315_PID) },
 501         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9316_PID) },
 502         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9317_PID) },
 503         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9318_PID) },
 504         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9319_PID) },
 505         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_931A_PID) },
 506         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_931B_PID) },
 507         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_931C_PID) },
 508         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_931D_PID) },
 509         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_931E_PID) },
 510         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_931F_PID) },
 511         { USB_DEVICE(FTDI_VID, FTDI_PERLE_ULTRAPORT_PID) },
 512         { USB_DEVICE(FTDI_VID, FTDI_PIEGROUP_PID) },
 513         { USB_DEVICE(FTDI_VID, FTDI_TNC_X_PID) },
 514         { USB_DEVICE(FTDI_VID, FTDI_USBX_707_PID) },
 515         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2101_PID) },
 516         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2102_PID) },
 517         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2103_PID) },
 518         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2104_PID) },
 519         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2106_PID) },
 520         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_1_PID) },
 521         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_2_PID) },
 522         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_1_PID) },
 523         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_2_PID) },
 524         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_1_PID) },
 525         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_2_PID) },
 526         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_1_PID) },
 527         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_2_PID) },
 528         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_3_PID) },
 529         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_4_PID) },
 530         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_1_PID) },
 531         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_2_PID) },
 532         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_3_PID) },
 533         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_4_PID) },
 534         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_1_PID) },
 535         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_2_PID) },
 536         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_3_PID) },
 537         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_4_PID) },
 538         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_1_PID) },
 539         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_2_PID) },
 540         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_3_PID) },
 541         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_4_PID) },
 542         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_5_PID) },
 543         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_6_PID) },
 544         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_7_PID) },
 545         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_8_PID) },
 546         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_1_PID) },
 547         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_2_PID) },
 548         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_3_PID) },
 549         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_4_PID) },
 550         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_5_PID) },
 551         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_6_PID) },
 552         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_7_PID) },
 553         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_8_PID) },
 554         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_1_PID) },
 555         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_2_PID) },
 556         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_3_PID) },
 557         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_4_PID) },
 558         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_5_PID) },
 559         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_6_PID) },
 560         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_7_PID) },
 561         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_8_PID) },
 562         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803R_1_PID) },
 563         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803R_2_PID) },
 564         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803R_3_PID) },
 565         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803R_4_PID) },
 566         { USB_DEVICE(IDTECH_VID, IDTECH_IDT1221U_PID) },
 567         { USB_DEVICE(OCT_VID, OCT_US101_PID) },
 568         { USB_DEVICE(OCT_VID, OCT_DK201_PID) },
 569         { USB_DEVICE(FTDI_VID, FTDI_HE_TIRA1_PID),
 570                 .driver_info = (kernel_ulong_t)&ftdi_HE_TIRA1_quirk },
 571         { USB_DEVICE(FTDI_VID, FTDI_USB_UIRT_PID),
 572                 .driver_info = (kernel_ulong_t)&ftdi_USB_UIRT_quirk },
 573         { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_1) },
 574         { USB_DEVICE(FTDI_VID, PROTEGO_R2X0) },
 575         { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_3) },
 576         { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_4) },
 577         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E808_PID) },
 578         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E809_PID) },
 579         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80A_PID) },
 580         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80B_PID) },
 581         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80C_PID) },
 582         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80D_PID) },
 583         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80E_PID) },
 584         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80F_PID) },
 585         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E888_PID) },
 586         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E889_PID) },
 587         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88A_PID) },
 588         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88B_PID) },
 589         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88C_PID) },
 590         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88D_PID) },
 591         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88E_PID) },
 592         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88F_PID) },
 593         { USB_DEVICE(FTDI_VID, FTDI_ELV_UO100_PID) },
 594         { USB_DEVICE(FTDI_VID, FTDI_ELV_UM100_PID) },
 595         { USB_DEVICE(FTDI_VID, FTDI_ELV_UR100_PID) },
 596         { USB_DEVICE(FTDI_VID, FTDI_ELV_ALC8500_PID) },
 597         { USB_DEVICE(FTDI_VID, FTDI_PYRAMID_PID) },
 598         { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1000PC_PID) },
 599         { USB_DEVICE(FTDI_VID, FTDI_IBS_US485_PID) },
 600         { USB_DEVICE(FTDI_VID, FTDI_IBS_PICPRO_PID) },
 601         { USB_DEVICE(FTDI_VID, FTDI_IBS_PCMCIA_PID) },
 602         { USB_DEVICE(FTDI_VID, FTDI_IBS_PK1_PID) },
 603         { USB_DEVICE(FTDI_VID, FTDI_IBS_RS232MON_PID) },
 604         { USB_DEVICE(FTDI_VID, FTDI_IBS_APP70_PID) },
 605         { USB_DEVICE(FTDI_VID, FTDI_IBS_PEDO_PID) },
 606         { USB_DEVICE(FTDI_VID, FTDI_IBS_PROD_PID) },
 607         { USB_DEVICE(FTDI_VID, FTDI_TAVIR_STK500_PID) },
 608         { USB_DEVICE(FTDI_VID, FTDI_TIAO_UMPA_PID),
 609                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
 610         { USB_DEVICE(FTDI_VID, FTDI_NT_ORIONLXM_PID),
 611                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
 612         { USB_DEVICE(FTDI_VID, FTDI_NT_ORIONLX_PLUS_PID) },
 613         { USB_DEVICE(FTDI_VID, FTDI_NT_ORION_IO_PID) },
 614         { USB_DEVICE(FTDI_VID, FTDI_SYNAPSE_SS200_PID) },
 615         { USB_DEVICE(FTDI_VID, FTDI_CUSTOMWARE_MINIPLEX_PID) },
 616         { USB_DEVICE(FTDI_VID, FTDI_CUSTOMWARE_MINIPLEX2_PID) },
 617         { USB_DEVICE(FTDI_VID, FTDI_CUSTOMWARE_MINIPLEX2WI_PID) },
 618         { USB_DEVICE(FTDI_VID, FTDI_CUSTOMWARE_MINIPLEX3_PID) },
 619         /*
 620          * ELV devices:
 621          */
 622         { USB_DEVICE(FTDI_ELV_VID, FTDI_ELV_WS300_PID) },
 623         { USB_DEVICE(FTDI_VID, FTDI_ELV_USR_PID) },
 624         { USB_DEVICE(FTDI_VID, FTDI_ELV_MSM1_PID) },
 625         { USB_DEVICE(FTDI_VID, FTDI_ELV_KL100_PID) },
 626         { USB_DEVICE(FTDI_VID, FTDI_ELV_WS550_PID) },
 627         { USB_DEVICE(FTDI_VID, FTDI_ELV_EC3000_PID) },
 628         { USB_DEVICE(FTDI_VID, FTDI_ELV_WS888_PID) },
 629         { USB_DEVICE(FTDI_VID, FTDI_ELV_TWS550_PID) },
 630         { USB_DEVICE(FTDI_VID, FTDI_ELV_FEM_PID) },
 631         { USB_DEVICE(FTDI_VID, FTDI_ELV_CLI7000_PID) },
 632         { USB_DEVICE(FTDI_VID, FTDI_ELV_PPS7330_PID) },
 633         { USB_DEVICE(FTDI_VID, FTDI_ELV_TFM100_PID) },
 634         { USB_DEVICE(FTDI_VID, FTDI_ELV_UDF77_PID) },
 635         { USB_DEVICE(FTDI_VID, FTDI_ELV_UIO88_PID) },
 636         { USB_DEVICE(FTDI_VID, FTDI_ELV_UAD8_PID) },
 637         { USB_DEVICE(FTDI_VID, FTDI_ELV_UDA7_PID) },
 638         { USB_DEVICE(FTDI_VID, FTDI_ELV_USI2_PID) },
 639         { USB_DEVICE(FTDI_VID, FTDI_ELV_T1100_PID) },
 640         { USB_DEVICE(FTDI_VID, FTDI_ELV_PCD200_PID) },
 641         { USB_DEVICE(FTDI_VID, FTDI_ELV_ULA200_PID) },
 642         { USB_DEVICE(FTDI_VID, FTDI_ELV_CSI8_PID) },
 643         { USB_DEVICE(FTDI_VID, FTDI_ELV_EM1000DL_PID) },
 644         { USB_DEVICE(FTDI_VID, FTDI_ELV_PCK100_PID) },
 645         { USB_DEVICE(FTDI_VID, FTDI_ELV_RFP500_PID) },
 646         { USB_DEVICE(FTDI_VID, FTDI_ELV_FS20SIG_PID) },
 647         { USB_DEVICE(FTDI_VID, FTDI_ELV_UTP8_PID) },
 648         { USB_DEVICE(FTDI_VID, FTDI_ELV_WS300PC_PID) },
 649         { USB_DEVICE(FTDI_VID, FTDI_ELV_WS444PC_PID) },
 650         { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1300PC_PID) },
 651         { USB_DEVICE(FTDI_VID, FTDI_ELV_EM1010PC_PID) },
 652         { USB_DEVICE(FTDI_VID, FTDI_ELV_WS500_PID) },
 653         { USB_DEVICE(FTDI_VID, FTDI_ELV_HS485_PID) },
 654         { USB_DEVICE(FTDI_VID, FTDI_ELV_UMS100_PID) },
 655         { USB_DEVICE(FTDI_VID, FTDI_ELV_TFD128_PID) },
 656         { USB_DEVICE(FTDI_VID, FTDI_ELV_FM3RX_PID) },
 657         { USB_DEVICE(FTDI_VID, FTDI_ELV_WS777_PID) },
 658         { USB_DEVICE(FTDI_VID, FTDI_PALMSENS_PID) },
 659         { USB_DEVICE(FTDI_VID, FTDI_IVIUM_XSTAT_PID) },
 660         { USB_DEVICE(FTDI_VID, LINX_SDMUSBQSS_PID) },
 661         { USB_DEVICE(FTDI_VID, LINX_MASTERDEVEL2_PID) },
 662         { USB_DEVICE(FTDI_VID, LINX_FUTURE_0_PID) },
 663         { USB_DEVICE(FTDI_VID, LINX_FUTURE_1_PID) },
 664         { USB_DEVICE(FTDI_VID, LINX_FUTURE_2_PID) },
 665         { USB_DEVICE(FTDI_VID, FTDI_CCSICDU20_0_PID) },
 666         { USB_DEVICE(FTDI_VID, FTDI_CCSICDU40_1_PID) },
 667         { USB_DEVICE(FTDI_VID, FTDI_CCSMACHX_2_PID) },
 668         { USB_DEVICE(FTDI_VID, FTDI_CCSLOAD_N_GO_3_PID) },
 669         { USB_DEVICE(FTDI_VID, FTDI_CCSICDU64_4_PID) },
 670         { USB_DEVICE(FTDI_VID, FTDI_CCSPRIME8_5_PID) },
 671         { USB_DEVICE(FTDI_VID, INSIDE_ACCESSO) },
 672         { USB_DEVICE(INTREPID_VID, INTREPID_VALUECAN_PID) },
 673         { USB_DEVICE(INTREPID_VID, INTREPID_NEOVI_PID) },
 674         { USB_DEVICE(FALCOM_VID, FALCOM_TWIST_PID) },
 675         { USB_DEVICE(FALCOM_VID, FALCOM_SAMBA_PID) },
 676         { USB_DEVICE(FTDI_VID, FTDI_SUUNTO_SPORTS_PID) },
 677         { USB_DEVICE(FTDI_VID, FTDI_OCEANIC_PID) },
 678         { USB_DEVICE(TTI_VID, TTI_QL355P_PID) },
 679         { USB_DEVICE(FTDI_VID, FTDI_RM_CANVIEW_PID) },
 680         { USB_DEVICE(ACTON_VID, ACTON_SPECTRAPRO_PID) },
 681         { USB_DEVICE(CONTEC_VID, CONTEC_COM1USBH_PID) },
 682         { USB_DEVICE(MITSUBISHI_VID, MITSUBISHI_FXUSB_PID) },
 683         { USB_DEVICE(BANDB_VID, BANDB_USOTL4_PID) },
 684         { USB_DEVICE(BANDB_VID, BANDB_USTL4_PID) },
 685         { USB_DEVICE(BANDB_VID, BANDB_USO9ML2_PID) },
 686         { USB_DEVICE(BANDB_VID, BANDB_USOPTL4_PID) },
 687         { USB_DEVICE(BANDB_VID, BANDB_USPTL4_PID) },
 688         { USB_DEVICE(BANDB_VID, BANDB_USO9ML2DR_2_PID) },
 689         { USB_DEVICE(BANDB_VID, BANDB_USO9ML2DR_PID) },
 690         { USB_DEVICE(BANDB_VID, BANDB_USOPTL4DR2_PID) },
 691         { USB_DEVICE(BANDB_VID, BANDB_USOPTL4DR_PID) },
 692         { USB_DEVICE(BANDB_VID, BANDB_485USB9F_2W_PID) },
 693         { USB_DEVICE(BANDB_VID, BANDB_485USB9F_4W_PID) },
 694         { USB_DEVICE(BANDB_VID, BANDB_232USB9M_PID) },
 695         { USB_DEVICE(BANDB_VID, BANDB_485USBTB_2W_PID) },
 696         { USB_DEVICE(BANDB_VID, BANDB_485USBTB_4W_PID) },
 697         { USB_DEVICE(BANDB_VID, BANDB_TTL5USB9M_PID) },
 698         { USB_DEVICE(BANDB_VID, BANDB_TTL3USB9M_PID) },
 699         { USB_DEVICE(BANDB_VID, BANDB_ZZ_PROG1_USB_PID) },
 700         { USB_DEVICE(FTDI_VID, EVER_ECO_PRO_CDS) },
 701         { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_1_PID) },
 702         { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_2_PID) },
 703         { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_3_PID) },
 704         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_0_PID) },
 705         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_1_PID) },
 706         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_2_PID) },
 707         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_3_PID) },
 708         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_4_PID) },
 709         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_5_PID) },
 710         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_6_PID) },
 711         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_7_PID) },
 712         { USB_DEVICE(XSENS_VID, XSENS_AWINDA_DONGLE_PID) },
 713         { USB_DEVICE(XSENS_VID, XSENS_AWINDA_STATION_PID) },
 714         { USB_DEVICE(XSENS_VID, XSENS_CONVERTER_PID) },
 715         { USB_DEVICE(XSENS_VID, XSENS_MTDEVBOARD_PID) },
 716         { USB_DEVICE(XSENS_VID, XSENS_MTW_PID) },
 717         { USB_DEVICE(FTDI_VID, FTDI_OMNI1509) },
 718         { USB_DEVICE(MOBILITY_VID, MOBILITY_USB_SERIAL_PID) },
 719         { USB_DEVICE(FTDI_VID, FTDI_ACTIVE_ROBOTS_PID) },
 720         { USB_DEVICE(FTDI_VID, FTDI_MHAM_KW_PID) },
 721         { USB_DEVICE(FTDI_VID, FTDI_MHAM_YS_PID) },
 722         { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y6_PID) },
 723         { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y8_PID) },
 724         { USB_DEVICE(FTDI_VID, FTDI_MHAM_IC_PID) },
 725         { USB_DEVICE(FTDI_VID, FTDI_MHAM_DB9_PID) },
 726         { USB_DEVICE(FTDI_VID, FTDI_MHAM_RS232_PID) },
 727         { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y9_PID) },
 728         { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_VCP_PID) },
 729         { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_D2XX_PID) },
 730         { USB_DEVICE(EVOLUTION_VID, EVOLUTION_ER1_PID) },
 731         { USB_DEVICE(EVOLUTION_VID, EVO_HYBRID_PID) },
 732         { USB_DEVICE(EVOLUTION_VID, EVO_RCM4_PID) },
 733         { USB_DEVICE(FTDI_VID, FTDI_ARTEMIS_PID) },
 734         { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16_PID) },
 735         { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16C_PID) },
 736         { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HR_PID) },
 737         { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HRC_PID) },
 738         { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16IC_PID) },
 739         { USB_DEVICE(KOBIL_VID, KOBIL_CONV_B1_PID) },
 740         { USB_DEVICE(KOBIL_VID, KOBIL_CONV_KAAN_PID) },
 741         { USB_DEVICE(POSIFLEX_VID, POSIFLEX_PP7000_PID) },
 742         { USB_DEVICE(FTDI_VID, FTDI_TTUSB_PID) },
 743         { USB_DEVICE(FTDI_VID, FTDI_ECLO_COM_1WIRE_PID) },
 744         { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_777_PID) },
 745         { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_8900F_PID) },
 746         { USB_DEVICE(FTDI_VID, FTDI_PCDJ_DAC2_PID) },
 747         { USB_DEVICE(FTDI_VID, FTDI_RRCIRKITS_LOCOBUFFER_PID) },
 748         { USB_DEVICE(FTDI_VID, FTDI_ASK_RDR400_PID) },
 749         { USB_DEVICE(FTDI_VID, FTDI_NZR_SEM_USB_PID) },
 750         { USB_DEVICE(ICOM_VID, ICOM_ID_1_PID) },
 751         { USB_DEVICE(ICOM_VID, ICOM_OPC_U_UC_PID) },
 752         { USB_DEVICE(ICOM_VID, ICOM_ID_RP2C1_PID) },
 753         { USB_DEVICE(ICOM_VID, ICOM_ID_RP2C2_PID) },
 754         { USB_DEVICE(ICOM_VID, ICOM_ID_RP2D_PID) },
 755         { USB_DEVICE(ICOM_VID, ICOM_ID_RP2VT_PID) },
 756         { USB_DEVICE(ICOM_VID, ICOM_ID_RP2VR_PID) },
 757         { USB_DEVICE(ICOM_VID, ICOM_ID_RP4KVT_PID) },
 758         { USB_DEVICE(ICOM_VID, ICOM_ID_RP4KVR_PID) },
 759         { USB_DEVICE(ICOM_VID, ICOM_ID_RP2KVT_PID) },
 760         { USB_DEVICE(ICOM_VID, ICOM_ID_RP2KVR_PID) },
 761         { USB_DEVICE(FTDI_VID, FTDI_ACG_HFDUAL_PID) },
 762         { USB_DEVICE(FTDI_VID, FTDI_YEI_SERVOCENTER31_PID) },
 763         { USB_DEVICE(FTDI_VID, FTDI_THORLABS_PID) },
 764         { USB_DEVICE(TESTO_VID, TESTO_1_PID) },
 765         { USB_DEVICE(TESTO_VID, TESTO_3_PID) },
 766         { USB_DEVICE(FTDI_VID, FTDI_GAMMA_SCOUT_PID) },
 767         { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13M_PID) },
 768         { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13S_PID) },
 769         { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13U_PID) },
 770         { USB_DEVICE(ELEKTOR_VID, ELEKTOR_FT323R_PID) },
 771         { USB_DEVICE(FTDI_VID, FTDI_NDI_HUC_PID),
 772                 .driver_info = (kernel_ulong_t)&ftdi_NDI_device_quirk },
 773         { USB_DEVICE(FTDI_VID, FTDI_NDI_SPECTRA_SCU_PID),
 774                 .driver_info = (kernel_ulong_t)&ftdi_NDI_device_quirk },
 775         { USB_DEVICE(FTDI_VID, FTDI_NDI_FUTURE_2_PID),
 776                 .driver_info = (kernel_ulong_t)&ftdi_NDI_device_quirk },
 777         { USB_DEVICE(FTDI_VID, FTDI_NDI_FUTURE_3_PID),
 778                 .driver_info = (kernel_ulong_t)&ftdi_NDI_device_quirk },
 779         { USB_DEVICE(FTDI_VID, FTDI_NDI_AURORA_SCU_PID),
 780                 .driver_info = (kernel_ulong_t)&ftdi_NDI_device_quirk },
 781         { USB_DEVICE(TELLDUS_VID, TELLDUS_TELLSTICK_PID) },
 782         { USB_DEVICE(NOVITUS_VID, NOVITUS_BONO_E_PID) },
 783         { USB_DEVICE(FTDI_VID, RTSYSTEMS_USB_VX8_PID) },
 784         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_S03_PID) },
 785         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_59_PID) },
 786         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_57A_PID) },
 787         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_57B_PID) },
 788         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_29A_PID) },
 789         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_29B_PID) },
 790         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_29F_PID) },
 791         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_62B_PID) },
 792         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_S01_PID) },
 793         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_63_PID) },
 794         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_29C_PID) },
 795         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_81B_PID) },
 796         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_82B_PID) },
 797         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_K5D_PID) },
 798         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_K4Y_PID) },
 799         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_K5G_PID) },
 800         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_S05_PID) },
 801         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_60_PID) },
 802         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_61_PID) },
 803         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_62_PID) },
 804         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_63B_PID) },
 805         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_64_PID) },
 806         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_65_PID) },
 807         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_92_PID) },
 808         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_92D_PID) },
 809         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_W5R_PID) },
 810         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_A5R_PID) },
 811         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_PW1_PID) },
 812         { USB_DEVICE(FTDI_VID, FTDI_MAXSTREAM_PID) },
 813         { USB_DEVICE(FTDI_VID, FTDI_PHI_FISCO_PID) },
 814         { USB_DEVICE(TML_VID, TML_USB_SERIAL_PID) },
 815         { USB_DEVICE(FTDI_VID, FTDI_ELSTER_UNICOM_PID) },
 816         { USB_DEVICE(FTDI_VID, FTDI_PROPOX_JTAGCABLEII_PID) },
 817         { USB_DEVICE(FTDI_VID, FTDI_PROPOX_ISPCABLEIII_PID) },
 818         { USB_DEVICE(FTDI_VID, CYBER_CORTEX_AV_PID),
 819                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
 820         { USB_DEVICE_INTERFACE_NUMBER(OLIMEX_VID, OLIMEX_ARM_USB_OCD_PID, 1) },
 821         { USB_DEVICE_INTERFACE_NUMBER(OLIMEX_VID, OLIMEX_ARM_USB_OCD_H_PID, 1) },
 822         { USB_DEVICE_INTERFACE_NUMBER(OLIMEX_VID, OLIMEX_ARM_USB_TINY_PID, 1) },
 823         { USB_DEVICE_INTERFACE_NUMBER(OLIMEX_VID, OLIMEX_ARM_USB_TINY_H_PID, 1) },
 824         { USB_DEVICE(FIC_VID, FIC_NEO1973_DEBUG_PID),
 825                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
 826         { USB_DEVICE(FTDI_VID, FTDI_OOCDLINK_PID),
 827                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
 828         { USB_DEVICE(FTDI_VID, LMI_LM3S_DEVEL_BOARD_PID),
 829                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
 830         { USB_DEVICE(FTDI_VID, LMI_LM3S_EVAL_BOARD_PID),
 831                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
 832         { USB_DEVICE(FTDI_VID, LMI_LM3S_ICDI_BOARD_PID),
 833                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
 834         { USB_DEVICE(FTDI_VID, FTDI_TURTELIZER_PID),
 835                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
 836         { USB_DEVICE(RATOC_VENDOR_ID, RATOC_PRODUCT_ID_USB60F) },
 837         { USB_DEVICE(RATOC_VENDOR_ID, RATOC_PRODUCT_ID_SCU18) },
 838         { USB_DEVICE(FTDI_VID, FTDI_REU_TINY_PID) },
 839
 840         /* Papouch devices based on FTDI chip */
 841         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB485_PID) },
 842         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_AP485_PID) },
 843         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB422_PID) },
 844         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB485_2_PID) },
 845         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_AP485_2_PID) },
 846         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB422_2_PID) },
 847         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB485S_PID) },
 848         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB485C_PID) },
 849         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_LEC_PID) },
 850         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB232_PID) },
 851         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_TMU_PID) },
 852         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_IRAMP_PID) },
 853         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_DRAK5_PID) },
 854         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO8x8_PID) },
 855         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO4x4_PID) },
 856         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO2x2_PID) },
 857         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO10x1_PID) },
 858         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO30x3_PID) },
 859         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO60x3_PID) },
 860         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO2x16_PID) },
 861         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO3x32_PID) },
 862         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_DRAK6_PID) },
 863         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_UPSUSB_PID) },
 864         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_MU_PID) },
 865         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SIMUKEY_PID) },
 866         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_AD4USB_PID) },
 867         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_GMUX_PID) },
 868         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_GMSR_PID) },
 869
 870         { USB_DEVICE(FTDI_VID, FTDI_DOMINTELL_DGQG_PID) },
 871         { USB_DEVICE(FTDI_VID, FTDI_DOMINTELL_DUSB_PID) },
 872         { USB_DEVICE(ALTI2_VID, ALTI2_N3_PID) },
 873         { USB_DEVICE(FTDI_VID, DIEBOLD_BCS_SE923_PID) },
 874         { USB_DEVICE(ATMEL_VID, STK541_PID) },
 875         { USB_DEVICE(DE_VID, STB_PID) },
 876         { USB_DEVICE(DE_VID, WHT_PID) },
 877         { USB_DEVICE(ADI_VID, ADI_GNICE_PID),
 878                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
 879         { USB_DEVICE(ADI_VID, ADI_GNICEPLUS_PID),
 880                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
 881         { USB_DEVICE_AND_INTERFACE_INFO(MICROCHIP_VID, MICROCHIP_USB_BOARD_PID,
 882                                         USB_CLASS_VENDOR_SPEC,
 883                                         USB_SUBCLASS_VENDOR_SPEC, 0x00) },
 884         { USB_DEVICE_INTERFACE_NUMBER(ACTEL_VID, MICROSEMI_ARROW_SF2PLUS_BOARD_PID, 2) },
 885         { USB_DEVICE(JETI_VID, JETI_SPC1201_PID) },
 886         { USB_DEVICE(MARVELL_VID, MARVELL_SHEEVAPLUG_PID),
 887                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
 888         { USB_DEVICE(LARSENBRUSGAARD_VID, LB_ALTITRACK_PID) },
 889         { USB_DEVICE(GN_OTOMETRICS_VID, AURICAL_USB_PID) },
 890         { USB_DEVICE(FTDI_VID, PI_C865_PID) },
 891         { USB_DEVICE(FTDI_VID, PI_C857_PID) },
 892         { USB_DEVICE(PI_VID, PI_C866_PID) },
 893         { USB_DEVICE(PI_VID, PI_C663_PID) },
 894         { USB_DEVICE(PI_VID, PI_C725_PID) },
 895         { USB_DEVICE(PI_VID, PI_E517_PID) },
 896         { USB_DEVICE(PI_VID, PI_C863_PID) },
 897         { USB_DEVICE(PI_VID, PI_E861_PID) },
 898         { USB_DEVICE(PI_VID, PI_C867_PID) },
 899         { USB_DEVICE(PI_VID, PI_E609_PID) },
 900         { USB_DEVICE(PI_VID, PI_E709_PID) },
 901         { USB_DEVICE(PI_VID, PI_100F_PID) },
 902         { USB_DEVICE(PI_VID, PI_1011_PID) },
 903         { USB_DEVICE(PI_VID, PI_1012_PID) },
 904         { USB_DEVICE(PI_VID, PI_1013_PID) },
 905         { USB_DEVICE(PI_VID, PI_1014_PID) },
 906         { USB_DEVICE(PI_VID, PI_1015_PID) },
 907         { USB_DEVICE(PI_VID, PI_1016_PID) },
 908         { USB_DEVICE(KONDO_VID, KONDO_USB_SERIAL_PID) },
 909         { USB_DEVICE(BAYER_VID, BAYER_CONTOUR_CABLE_PID) },
 910         { USB_DEVICE(FTDI_VID, MARVELL_OPENRD_PID),
 911                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
 912         { USB_DEVICE(FTDI_VID, TI_XDS100V2_PID),
 913                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
 914         { USB_DEVICE(FTDI_VID, HAMEG_HO820_PID) },
 915         { USB_DEVICE(FTDI_VID, HAMEG_HO720_PID) },
 916         { USB_DEVICE(FTDI_VID, HAMEG_HO730_PID) },
 917         { USB_DEVICE(FTDI_VID, HAMEG_HO870_PID) },
 918         { USB_DEVICE(FTDI_VID, MJSG_GENERIC_PID) },
 919         { USB_DEVICE(FTDI_VID, MJSG_SR_RADIO_PID) },
 920         { USB_DEVICE(FTDI_VID, MJSG_HD_RADIO_PID) },
 921         { USB_DEVICE(FTDI_VID, MJSG_XM_RADIO_PID) },
 922         { USB_DEVICE(FTDI_VID, XVERVE_SIGNALYZER_ST_PID),
 923                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
 924         { USB_DEVICE(FTDI_VID, XVERVE_SIGNALYZER_SLITE_PID),
 925                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
 926         { USB_DEVICE(FTDI_VID, XVERVE_SIGNALYZER_SH2_PID),
 927                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
 928         { USB_DEVICE(FTDI_VID, XVERVE_SIGNALYZER_SH4_PID),
 929                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
 930         { USB_DEVICE(FTDI_VID, SEGWAY_RMP200_PID) },
 931         { USB_DEVICE(FTDI_VID, ACCESIO_COM4SM_PID) },
 932         { USB_DEVICE(IONICS_VID, IONICS_PLUGCOMPUTER_PID),
 933                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
 934         { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_24_MASTER_WING_PID) },
 935         { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_PC_WING_PID) },
 936         { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_USB_DMX_PID) },
 937         { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_MIDI_TIMECODE_PID) },
 938         { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_MINI_WING_PID) },
 939         { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_MAXI_WING_PID) },
 940         { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_MEDIA_WING_PID) },
 941         { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_WING_PID) },
 942         { USB_DEVICE(FTDI_VID, FTDI_SCIENCESCOPE_LOGBOOKML_PID) },
 943         { USB_DEVICE(FTDI_VID, FTDI_SCIENCESCOPE_LS_LOGBOOK_PID) },
 944         { USB_DEVICE(FTDI_VID, FTDI_SCIENCESCOPE_HS_LOGBOOK_PID) },
 945         { USB_DEVICE(FTDI_VID, FTDI_CINTERION_MC55I_PID) },
 946         { USB_DEVICE(FTDI_VID, FTDI_FHE_PID) },
 947         { USB_DEVICE(FTDI_VID, FTDI_DOTEC_PID) },
 948         { USB_DEVICE(QIHARDWARE_VID, MILKYMISTONE_JTAGSERIAL_PID),
 949                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
 950         { USB_DEVICE(ST_VID, ST_STMCLT_2232_PID),
 951                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
 952         { USB_DEVICE(ST_VID, ST_STMCLT_4232_PID),
 953                 .driver_info = (kernel_ulong_t)&ftdi_stmclite_quirk },
 954         { USB_DEVICE(FTDI_VID, FTDI_RF_R106) },
 955         { USB_DEVICE(FTDI_VID, FTDI_DISTORTEC_JTAG_LOCK_PICK_PID),
 956                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
 957         { USB_DEVICE(FTDI_VID, FTDI_LUMEL_PD12_PID) },
 958         /* Crucible Devices */
 959         { USB_DEVICE(FTDI_VID, FTDI_CT_COMET_PID) },
 960         { USB_DEVICE(FTDI_VID, FTDI_Z3X_PID) },
 961         /* Cressi Devices */
 962         { USB_DEVICE(FTDI_VID, FTDI_CRESSI_PID) },
 963         /* Brainboxes Devices */
 964         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_VX_001_PID) },
 965         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_VX_012_PID) },
 966         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_VX_023_PID) },
 967         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_VX_034_PID) },
 968         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_101_PID) },
 969         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_160_1_PID) },
 970         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_160_2_PID) },
 971         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_160_3_PID) },
 972         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_160_4_PID) },
 973         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_160_5_PID) },
 974         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_160_6_PID) },
 975         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_160_7_PID) },
 976         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_160_8_PID) },
 977         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_257_PID) },
 978         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_279_1_PID) },
 979         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_279_2_PID) },
 980         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_279_3_PID) },
 981         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_279_4_PID) },
 982         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_313_PID) },
 983         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_324_PID) },
 984         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_346_1_PID) },
 985         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_346_2_PID) },
 986         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_357_PID) },
 987         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_606_1_PID) },
 988         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_606_2_PID) },
 989         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_606_3_PID) },
 990         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_701_1_PID) },
 991         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_701_2_PID) },
 992         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_842_1_PID) },
 993         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_842_2_PID) },
 994         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_842_3_PID) },
 995         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_842_4_PID) },
 996         /* ekey Devices */
 997         { USB_DEVICE(FTDI_VID, FTDI_EKEY_CONV_USB_PID) },
 998         /* Infineon Devices */
 999         { USB_DEVICE_INTERFACE_NUMBER(INFINEON_VID, INFINEON_TRIBOARD_TC1798_PID, 1) },
1000         { USB_DEVICE_INTERFACE_NUMBER(INFINEON_VID, INFINEON_TRIBOARD_TC2X7_PID, 1) },
1001         /* GE Healthcare devices */
1002         { USB_DEVICE(GE_HEALTHCARE_VID, GE_HEALTHCARE_NEMO_TRACKER_PID) },
1003         /* Active Research (Actisense) devices */
1004         { USB_DEVICE(FTDI_VID, ACTISENSE_NDC_PID) },
1005         { USB_DEVICE(FTDI_VID, ACTISENSE_USG_PID) },
1006         { USB_DEVICE(FTDI_VID, ACTISENSE_NGT_PID) },
1007         { USB_DEVICE(FTDI_VID, ACTISENSE_NGW_PID) },
1008         { USB_DEVICE(FTDI_VID, ACTISENSE_D9AC_PID) },
1009         { USB_DEVICE(FTDI_VID, ACTISENSE_D9AD_PID) },
1010         { USB_DEVICE(FTDI_VID, ACTISENSE_D9AE_PID) },
1011         { USB_DEVICE(FTDI_VID, ACTISENSE_D9AF_PID) },
1012         { USB_DEVICE(FTDI_VID, CHETCO_SEAGAUGE_PID) },
1013         { USB_DEVICE(FTDI_VID, CHETCO_SEASWITCH_PID) },
1014         { USB_DEVICE(FTDI_VID, CHETCO_SEASMART_NMEA2000_PID) },
1015         { USB_DEVICE(FTDI_VID, CHETCO_SEASMART_ETHERNET_PID) },
1016         { USB_DEVICE(FTDI_VID, CHETCO_SEASMART_WIFI_PID) },
1017         { USB_DEVICE(FTDI_VID, CHETCO_SEASMART_DISPLAY_PID) },
1018         { USB_DEVICE(FTDI_VID, CHETCO_SEASMART_LITE_PID) },
1019         { USB_DEVICE(FTDI_VID, CHETCO_SEASMART_ANALOG_PID) },
1020         /* ICP DAS I-756xU devices */
1021         { USB_DEVICE(ICPDAS_VID, ICPDAS_I7560U_PID) },
1022         { USB_DEVICE(ICPDAS_VID, ICPDAS_I7561U_PID) },
1023         { USB_DEVICE(ICPDAS_VID, ICPDAS_I7563U_PID) },
1024         { USB_DEVICE(WICED_VID, WICED_USB20706V2_PID) },
1025         { USB_DEVICE(TI_VID, TI_CC3200_LAUNCHPAD_PID),
1026                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
1027         { USB_DEVICE(CYPRESS_VID, CYPRESS_WICED_BT_USB_PID) },
1028         { USB_DEVICE(CYPRESS_VID, CYPRESS_WICED_WL_USB_PID) },
1029         { USB_DEVICE(AIRBUS_DS_VID, AIRBUS_DS_P8GR) },
1030         /* EZPrototypes devices */
1031         { USB_DEVICE(EZPROTOTYPES_VID, HJELMSLUND_USB485_ISO_PID) },
1032         { USB_DEVICE_INTERFACE_NUMBER(UNJO_VID, UNJO_ISODEBUG_V1_PID, 1) },
1033         { }                                     /* Terminating entry */
1034 };
1035
1036 MODULE_DEVICE_TABLE(usb, id_table_combined);
1037
1038 static const char *ftdi_chip_name[] = {
1039         [SIO] = "SIO",  /* the serial part of FT8U100AX */
1040         [FT8U232AM] = "FT8U232AM",
1041         [FT232BM] = "FT232BM",
1042         [FT2232C] = "FT2232C",
1043         [FT232RL] = "FT232RL",
1044         [FT2232H] = "FT2232H",
1045         [FT4232H] = "FT4232H",
1046         [FT232H]  = "FT232H",
1047         [FTX]     = "FT-X"
1048 };
1049
1050
1051 /* Used for TIOCMIWAIT */
1052 #define FTDI_STATUS_B0_MASK     (FTDI_RS0_CTS | FTDI_RS0_DSR | FTDI_RS0_RI | FTDI_RS0_RLSD)
1053 #define FTDI_STATUS_B1_MASK     (FTDI_RS_BI)
1054 /* End TIOCMIWAIT */
1055
1056 /* function prototypes for a FTDI serial converter */
1057 static int  ftdi_sio_probe(struct usb_serial *serial,
1058                                         const struct usb_device_id *id);
1059 static int  ftdi_sio_port_probe(struct usb_serial_port *port);
1060 static int  ftdi_sio_port_remove(struct usb_serial_port *port);
1061 static int  ftdi_open(struct tty_struct *tty, struct usb_serial_port *port);
1062 static void ftdi_dtr_rts(struct usb_serial_port *port, int on);
1063 static void ftdi_process_read_urb(struct urb *urb);
1064 static int ftdi_prepare_write_buffer(struct usb_serial_port *port,
1065                                                 void *dest, size_t size);
1066 static void ftdi_set_termios(struct tty_struct *tty,
1067                         struct usb_serial_port *port, struct ktermios *old);
1068 static int  ftdi_tiocmget(struct tty_struct *tty);
1069 static int  ftdi_tiocmset(struct tty_struct *tty,
1070                         unsigned int set, unsigned int clear);
1071 static int  ftdi_ioctl(struct tty_struct *tty,
1072                         unsigned int cmd, unsigned long arg);
1073 static int get_serial_info(struct tty_struct *tty,
1074                                 struct serial_struct *ss);
1075 static int set_serial_info(struct tty_struct *tty,
1076                                 struct serial_struct *ss);
1077 static void ftdi_break_ctl(struct tty_struct *tty, int break_state);
1078 static bool ftdi_tx_empty(struct usb_serial_port *port);
1079 static int ftdi_get_modem_status(struct usb_serial_port *port,
1080                                                 unsigned char status[2]);
1081
1082 static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base);
1083 static unsigned short int ftdi_232am_baud_to_divisor(int baud);
1084 static u32 ftdi_232bm_baud_base_to_divisor(int baud, int base);
1085 static u32 ftdi_232bm_baud_to_divisor(int baud);
1086 static u32 ftdi_2232h_baud_base_to_divisor(int baud, int base);
1087 static u32 ftdi_2232h_baud_to_divisor(int baud);
1088
1089 static struct usb_serial_driver ftdi_sio_device = {
1090         .driver = {
1091                 .owner =        THIS_MODULE,
1092                 .name =         "ftdi_sio",
1093         },
1094         .description =          "FTDI USB Serial Device",
1095         .id_table =             id_table_combined,
1096         .num_ports =            1,
1097         .bulk_in_size =         512,
1098         .bulk_out_size =        256,
1099         .probe =                ftdi_sio_probe,
1100         .port_probe =           ftdi_sio_port_probe,
1101         .port_remove =          ftdi_sio_port_remove,
1102         .open =                 ftdi_open,
1103         .dtr_rts =              ftdi_dtr_rts,
1104         .throttle =             usb_serial_generic_throttle,
1105         .unthrottle =           usb_serial_generic_unthrottle,
1106         .process_read_urb =     ftdi_process_read_urb,
1107         .prepare_write_buffer = ftdi_prepare_write_buffer,
1108         .tiocmget =             ftdi_tiocmget,
1109         .tiocmset =             ftdi_tiocmset,
1110         .tiocmiwait =           usb_serial_generic_tiocmiwait,
1111         .get_icount =           usb_serial_generic_get_icount,
1112         .ioctl =                ftdi_ioctl,
1113         .get_serial =           get_serial_info,
1114         .set_serial =           set_serial_info,
1115         .set_termios =          ftdi_set_termios,
1116         .break_ctl =            ftdi_break_ctl,
1117         .tx_empty =             ftdi_tx_empty,
1118 };
1119
1120 static struct usb_serial_driver * const serial_drivers[] = {
1121         &ftdi_sio_device, NULL
1122 };
1123
1124
1125 #define WDR_TIMEOUT 5000 /* default urb timeout */
1126 #define WDR_SHORT_TIMEOUT 1000  /* shorter urb timeout */
1127
1128 /*
1129  * ***************************************************************************
1130  * Utility functions
1131  * ***************************************************************************
1132  */
1133
1134 static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base)
1135 {
1136         unsigned short int divisor;
1137         /* divisor shifted 3 bits to the left */
1138         int divisor3 = DIV_ROUND_CLOSEST(base, 2 * baud);
1139         if ((divisor3 & 0x7) == 7)
1140                 divisor3++; /* round x.7/8 up to x+1 */
1141         divisor = divisor3 >> 3;
1142         divisor3 &= 0x7;
1143         if (divisor3 == 1)
1144                 divisor |= 0xc000;
1145         else if (divisor3 >= 4)
1146                 divisor |= 0x4000;
1147         else if (divisor3 != 0)
1148                 divisor |= 0x8000;
1149         else if (divisor == 1)
1150                 divisor = 0;    /* special case for maximum baud rate */
1151         return divisor;
1152 }
1153
1154 static unsigned short int ftdi_232am_baud_to_divisor(int baud)
1155 {
1156          return ftdi_232am_baud_base_to_divisor(baud, 48000000);
1157 }
1158
1159 static u32 ftdi_232bm_baud_base_to_divisor(int baud, int base)
1160 {
1161         static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
1162         u32 divisor;
1163         /* divisor shifted 3 bits to the left */
1164         int divisor3 = DIV_ROUND_CLOSEST(base, 2 * baud);
1165         divisor = divisor3 >> 3;
1166         divisor |= (u32)divfrac[divisor3 & 0x7] << 14;
1167         /* Deal with special cases for highest baud rates. */
1168         if (divisor == 1)
1169                 divisor = 0;
1170         else if (divisor == 0x4001)
1171                 divisor = 1;
1172         return divisor;
1173 }
1174
1175 static u32 ftdi_232bm_baud_to_divisor(int baud)
1176 {
1177          return ftdi_232bm_baud_base_to_divisor(baud, 48000000);
1178 }
1179
1180 static u32 ftdi_2232h_baud_base_to_divisor(int baud, int base)
1181 {
1182         static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
1183         u32 divisor;
1184         int divisor3;
1185
1186         /* hi-speed baud rate is 10-bit sampling instead of 16-bit */
1187         divisor3 = DIV_ROUND_CLOSEST(8 * base, 10 * baud);
1188
1189         divisor = divisor3 >> 3;
1190         divisor |= (u32)divfrac[divisor3 & 0x7] << 14;
1191         /* Deal with special cases for highest baud rates. */
1192         if (divisor == 1)
1193                 divisor = 0;
1194         else if (divisor == 0x4001)
1195                 divisor = 1;
1196         /*
1197          * Set this bit to turn off a divide by 2.5 on baud rate generator
1198          * This enables baud rates up to 12Mbaud but cannot reach below 1200
1199          * baud with this bit set
1200          */
1201         divisor |= 0x00020000;
1202         return divisor;
1203 }
1204
1205 static u32 ftdi_2232h_baud_to_divisor(int baud)
1206 {
1207          return ftdi_2232h_baud_base_to_divisor(baud, 120000000);
1208 }
1209
1210 #define set_mctrl(port, set)            update_mctrl((port), (set), 0)
1211 #define clear_mctrl(port, clear)        update_mctrl((port), 0, (clear))
1212
1213 static int update_mctrl(struct usb_serial_port *port, unsigned int set,
1214                                                         unsigned int clear)
1215 {
1216         struct ftdi_private *priv = usb_get_serial_port_data(port);
1217         struct device *dev = &port->dev;
1218         unsigned value;
1219         int rv;
1220
1221         if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
1222                 dev_dbg(dev, "%s - DTR|RTS not being set|cleared\n", __func__);
1223                 return 0;       /* no change */
1224         }
1225
1226         clear &= ~set;  /* 'set' takes precedence over 'clear' */
1227         value = 0;
1228         if (clear & TIOCM_DTR)
1229                 value |= FTDI_SIO_SET_DTR_LOW;
1230         if (clear & TIOCM_RTS)
1231                 value |= FTDI_SIO_SET_RTS_LOW;
1232         if (set & TIOCM_DTR)
1233                 value |= FTDI_SIO_SET_DTR_HIGH;
1234         if (set & TIOCM_RTS)
1235                 value |= FTDI_SIO_SET_RTS_HIGH;
1236         rv = usb_control_msg(port->serial->dev,
1237                                usb_sndctrlpipe(port->serial->dev, 0),
1238                                FTDI_SIO_SET_MODEM_CTRL_REQUEST,
1239                                FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE,
1240                                value, priv->interface,
1241                                NULL, 0, WDR_TIMEOUT);
1242         if (rv < 0) {
1243                 dev_dbg(dev, "%s Error from MODEM_CTRL urb: DTR %s, RTS %s\n",
1244                         __func__,
1245                         (set & TIOCM_DTR) ? "HIGH" : (clear & TIOCM_DTR) ? "LOW" : "unchanged",
1246                         (set & TIOCM_RTS) ? "HIGH" : (clear & TIOCM_RTS) ? "LOW" : "unchanged");
1247                 rv = usb_translate_errors(rv);
1248         } else {
1249                 dev_dbg(dev, "%s - DTR %s, RTS %s\n", __func__,
1250                         (set & TIOCM_DTR) ? "HIGH" : (clear & TIOCM_DTR) ? "LOW" : "unchanged",
1251                         (set & TIOCM_RTS) ? "HIGH" : (clear & TIOCM_RTS) ? "LOW" : "unchanged");
1252                 /* FIXME: locking on last_dtr_rts */
1253                 priv->last_dtr_rts = (priv->last_dtr_rts & ~clear) | set;
1254         }
1255         return rv;
1256 }
1257
1258
1259 static u32 get_ftdi_divisor(struct tty_struct *tty,
1260                                                 struct usb_serial_port *port)
1261 {
1262         struct ftdi_private *priv = usb_get_serial_port_data(port);
1263         struct device *dev = &port->dev;
1264         u32 div_value = 0;
1265         int div_okay = 1;
1266         int baud;
1267
1268         baud = tty_get_baud_rate(tty);
1269         dev_dbg(dev, "%s - tty_get_baud_rate reports speed %d\n", __func__, baud);
1270
1271         /*
1272          * Observe deprecated async-compatible custom_divisor hack, update
1273          * baudrate if needed.
1274          */
1275         if (baud == 38400 &&
1276             ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
1277              (priv->custom_divisor)) {
1278                 baud = priv->baud_base / priv->custom_divisor;
1279                 dev_dbg(dev, "%s - custom divisor %d sets baud rate to %d\n",
1280                         __func__, priv->custom_divisor, baud);
1281         }
1282
1283         if (!baud)
1284                 baud = 9600;
1285         switch (priv->chip_type) {
1286         case SIO: /* SIO chip */
1287                 switch (baud) {
1288                 case 300: div_value = ftdi_sio_b300; break;
1289                 case 600: div_value = ftdi_sio_b600; break;
1290                 case 1200: div_value = ftdi_sio_b1200; break;
1291                 case 2400: div_value = ftdi_sio_b2400; break;
1292                 case 4800: div_value = ftdi_sio_b4800; break;
1293                 case 9600: div_value = ftdi_sio_b9600; break;
1294                 case 19200: div_value = ftdi_sio_b19200; break;
1295                 case 38400: div_value = ftdi_sio_b38400; break;
1296                 case 57600: div_value = ftdi_sio_b57600;  break;
1297                 case 115200: div_value = ftdi_sio_b115200; break;
1298                 } /* baud */
1299                 if (div_value == 0) {
1300                         dev_dbg(dev, "%s - Baudrate (%d) requested is not supported\n",
1301                                 __func__,  baud);
1302                         div_value = ftdi_sio_b9600;
1303                         baud = 9600;
1304                         div_okay = 0;
1305                 }
1306                 break;
1307         case FT8U232AM: /* 8U232AM chip */
1308                 if (baud <= 3000000) {
1309                         div_value = ftdi_232am_baud_to_divisor(baud);
1310                 } else {
1311                         dev_dbg(dev, "%s - Baud rate too high!\n", __func__);
1312                         baud = 9600;
1313                         div_value = ftdi_232am_baud_to_divisor(9600);
1314                         div_okay = 0;
1315                 }
1316                 break;
1317         case FT232BM: /* FT232BM chip */
1318         case FT2232C: /* FT2232C chip */
1319         case FT232RL: /* FT232RL chip */
1320         case FTX:     /* FT-X series */
1321                 if (baud <= 3000000) {
1322                         u16 product_id = le16_to_cpu(
1323                                 port->serial->dev->descriptor.idProduct);
1324                         if (((product_id == FTDI_NDI_HUC_PID)           ||
1325                              (product_id == FTDI_NDI_SPECTRA_SCU_PID)   ||
1326                              (product_id == FTDI_NDI_FUTURE_2_PID)      ||
1327                              (product_id == FTDI_NDI_FUTURE_3_PID)      ||
1328                              (product_id == FTDI_NDI_AURORA_SCU_PID))   &&
1329                             (baud == 19200)) {
1330                                 baud = 1200000;
1331                         }
1332                         div_value = ftdi_232bm_baud_to_divisor(baud);
1333                 } else {
1334                         dev_dbg(dev, "%s - Baud rate too high!\n", __func__);
1335                         div_value = ftdi_232bm_baud_to_divisor(9600);
1336                         div_okay = 0;
1337                         baud = 9600;
1338                 }
1339                 break;
1340         case FT2232H: /* FT2232H chip */
1341         case FT4232H: /* FT4232H chip */
1342         case FT232H:  /* FT232H chip */
1343                 if ((baud <= 12000000) && (baud >= 1200)) {
1344                         div_value = ftdi_2232h_baud_to_divisor(baud);
1345                 } else if (baud < 1200) {
1346                         div_value = ftdi_232bm_baud_to_divisor(baud);
1347                 } else {
1348                         dev_dbg(dev, "%s - Baud rate too high!\n", __func__);
1349                         div_value = ftdi_232bm_baud_to_divisor(9600);
1350                         div_okay = 0;
1351                         baud = 9600;
1352                 }
1353                 break;
1354         } /* priv->chip_type */
1355
1356         if (div_okay) {
1357                 dev_dbg(dev, "%s - Baud rate set to %d (divisor 0x%lX) on chip %s\n",
1358                         __func__, baud, (unsigned long)div_value,
1359                         ftdi_chip_name[priv->chip_type]);
1360         }
1361
1362         tty_encode_baud_rate(tty, baud, baud);
1363         return div_value;
1364 }
1365
1366 static int change_speed(struct tty_struct *tty, struct usb_serial_port *port)
1367 {
1368         struct ftdi_private *priv = usb_get_serial_port_data(port);
1369         u16 value;
1370         u16 index;
1371         u32 index_value;
1372         int rv;
1373
1374         index_value = get_ftdi_divisor(tty, port);
1375         value = (u16)index_value;
1376         index = (u16)(index_value >> 16);
1377         if ((priv->chip_type == FT2232C) || (priv->chip_type == FT2232H) ||
1378                 (priv->chip_type == FT4232H) || (priv->chip_type == FT232H)) {
1379                 /* Probably the BM type needs the MSB of the encoded fractional
1380                  * divider also moved like for the chips above. Any infos? */
1381                 index = (u16)((index << 8) | priv->interface);
1382         }
1383
1384         rv = usb_control_msg(port->serial->dev,
1385                             usb_sndctrlpipe(port->serial->dev, 0),
1386                             FTDI_SIO_SET_BAUDRATE_REQUEST,
1387                             FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE,
1388                             value, index,
1389                             NULL, 0, WDR_SHORT_TIMEOUT);
1390         return rv;
1391 }
1392
1393 static int write_latency_timer(struct usb_serial_port *port)
1394 {
1395         struct ftdi_private *priv = usb_get_serial_port_data(port);
1396         struct usb_device *udev = port->serial->dev;
1397         int rv;
1398         int l = priv->latency;
1399
1400         if (priv->chip_type == SIO || priv->chip_type == FT8U232AM)
1401                 return -EINVAL;
1402
1403         if (priv->flags & ASYNC_LOW_LATENCY)
1404                 l = 1;
1405
1406         dev_dbg(&port->dev, "%s: setting latency timer = %i\n", __func__, l);
1407
1408         rv = usb_control_msg(udev,
1409                              usb_sndctrlpipe(udev, 0),
1410                              FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
1411                              FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
1412                              l, priv->interface,
1413                              NULL, 0, WDR_TIMEOUT);
1414         if (rv < 0)
1415                 dev_err(&port->dev, "Unable to write latency timer: %i\n", rv);
1416         return rv;
1417 }
1418
1419 static int _read_latency_timer(struct usb_serial_port *port)
1420 {
1421         struct ftdi_private *priv = usb_get_serial_port_data(port);
1422         struct usb_device *udev = port->serial->dev;
1423         unsigned char *buf;
1424         int rv;
1425
1426         buf = kmalloc(1, GFP_KERNEL);
1427         if (!buf)
1428                 return -ENOMEM;
1429
1430         rv = usb_control_msg(udev,
1431                              usb_rcvctrlpipe(udev, 0),
1432                              FTDI_SIO_GET_LATENCY_TIMER_REQUEST,
1433                              FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE,
1434                              0, priv->interface,
1435                              buf, 1, WDR_TIMEOUT);
1436         if (rv < 1) {
1437                 if (rv >= 0)
1438                         rv = -EIO;
1439         } else {
1440                 rv = buf[0];
1441         }
1442
1443         kfree(buf);
1444
1445         return rv;
1446 }
1447
1448 static int read_latency_timer(struct usb_serial_port *port)
1449 {
1450         struct ftdi_private *priv = usb_get_serial_port_data(port);
1451         int rv;
1452
1453         if (priv->chip_type == SIO || priv->chip_type == FT8U232AM)
1454                 return -EINVAL;
1455
1456         rv = _read_latency_timer(port);
1457         if (rv < 0) {
1458                 dev_err(&port->dev, "Unable to read latency timer: %i\n", rv);
1459                 return rv;
1460         }
1461
1462         priv->latency = rv;
1463
1464         return 0;
1465 }
1466
1467 static int get_serial_info(struct tty_struct *tty,
1468                                 struct serial_struct *ss)
1469 {
1470         struct usb_serial_port *port = tty->driver_data;
1471         struct ftdi_private *priv = usb_get_serial_port_data(port);
1472
1473         ss->flags = priv->flags;
1474         ss->baud_base = priv->baud_base;
1475         ss->custom_divisor = priv->custom_divisor;
1476         return 0;
1477 }
1478
1479 static int set_serial_info(struct tty_struct *tty,
1480         struct serial_struct *ss)
1481 {
1482         struct usb_serial_port *port = tty->driver_data;
1483         struct ftdi_private *priv = usb_get_serial_port_data(port);
1484         struct ftdi_private old_priv;
1485
1486         mutex_lock(&priv->cfg_lock);
1487         old_priv = *priv;
1488
1489         /* Do error checking and permission checking */
1490
1491         if (!capable(CAP_SYS_ADMIN)) {
1492                 if ((ss->flags ^ priv->flags) & ~ASYNC_USR_MASK) {
1493                         mutex_unlock(&priv->cfg_lock);
1494                         return -EPERM;
1495                 }
1496                 priv->flags = ((priv->flags & ~ASYNC_USR_MASK) |
1497                                (ss->flags & ASYNC_USR_MASK));
1498                 priv->custom_divisor = ss->custom_divisor;
1499                 goto check_and_exit;
1500         }
1501
1502         if (ss->baud_base != priv->baud_base) {
1503                 mutex_unlock(&priv->cfg_lock);
1504                 return -EINVAL;
1505         }
1506
1507         /* Make the changes - these are privileged changes! */
1508
1509         priv->flags = ((priv->flags & ~ASYNC_FLAGS) |
1510                                         (ss->flags & ASYNC_FLAGS));
1511         priv->custom_divisor = ss->custom_divisor;
1512
1513 check_and_exit:
1514         write_latency_timer(port);
1515
1516         if ((priv->flags ^ old_priv.flags) & ASYNC_SPD_MASK ||
1517                         ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST &&
1518                          priv->custom_divisor != old_priv.custom_divisor)) {
1519
1520                 /* warn about deprecation unless clearing */
1521                 if (priv->flags & ASYNC_SPD_MASK)
1522                         dev_warn_ratelimited(&port->dev, "use of SPD flags is deprecated\n");
1523
1524                 change_speed(tty, port);
1525         }
1526         mutex_unlock(&priv->cfg_lock);
1527         return 0;
1528 }
1529
1530 static int get_lsr_info(struct usb_serial_port *port,
1531                         unsigned int __user *retinfo)
1532 {
1533         struct ftdi_private *priv = usb_get_serial_port_data(port);
1534         unsigned int result = 0;
1535
1536         if (priv->transmit_empty)
1537                 result = TIOCSER_TEMT;
1538
1539         if (copy_to_user(retinfo, &result, sizeof(unsigned int)))
1540                 return -EFAULT;
1541         return 0;
1542 }
1543
1544
1545 /* Determine type of FTDI chip based on USB config and descriptor. */
1546 static void ftdi_determine_type(struct usb_serial_port *port)
1547 {
1548         struct ftdi_private *priv = usb_get_serial_port_data(port);
1549         struct usb_serial *serial = port->serial;
1550         struct usb_device *udev = serial->dev;
1551         unsigned version;
1552         unsigned interfaces;
1553
1554         /* Assume it is not the original SIO device for now. */
1555         priv->baud_base = 48000000 / 2;
1556
1557         version = le16_to_cpu(udev->descriptor.bcdDevice);
1558         interfaces = udev->actconfig->desc.bNumInterfaces;
1559         dev_dbg(&port->dev, "%s: bcdDevice = 0x%x, bNumInterfaces = %u\n", __func__,
1560                 version, interfaces);
1561         if (interfaces > 1) {
1562                 int inter;
1563
1564                 /* Multiple interfaces.*/
1565                 if (version == 0x0800) {
1566                         priv->chip_type = FT4232H;
1567                         /* Hi-speed - baud clock runs at 120MHz */
1568                         priv->baud_base = 120000000 / 2;
1569                 } else if (version == 0x0700) {
1570                         priv->chip_type = FT2232H;
1571                         /* Hi-speed - baud clock runs at 120MHz */
1572                         priv->baud_base = 120000000 / 2;
1573                 } else
1574                         priv->chip_type = FT2232C;
1575
1576                 /* Determine interface code. */
1577                 inter = serial->interface->altsetting->desc.bInterfaceNumber;
1578                 if (inter == 0) {
1579                         priv->interface = INTERFACE_A;
1580                 } else  if (inter == 1) {
1581                         priv->interface = INTERFACE_B;
1582                 } else  if (inter == 2) {
1583                         priv->interface = INTERFACE_C;
1584                 } else  if (inter == 3) {
1585                         priv->interface = INTERFACE_D;
1586                 }
1587                 /* BM-type devices have a bug where bcdDevice gets set
1588                  * to 0x200 when iSerialNumber is 0.  */
1589                 if (version < 0x500) {
1590                         dev_dbg(&port->dev,
1591                                 "%s: something fishy - bcdDevice too low for multi-interface device\n",
1592                                 __func__);
1593                 }
1594         } else if (version < 0x200) {
1595                 /* Old device.  Assume it's the original SIO. */
1596                 priv->chip_type = SIO;
1597                 priv->baud_base = 12000000 / 16;
1598         } else if (version < 0x400) {
1599                 /* Assume it's an FT8U232AM (or FT8U245AM) */
1600                 priv->chip_type = FT8U232AM;
1601                 /*
1602                  * It might be a BM type because of the iSerialNumber bug.
1603                  * If iSerialNumber==0 and the latency timer is readable,
1604                  * assume it is BM type.
1605                  */
1606                 if (udev->descriptor.iSerialNumber == 0 &&
1607                                 _read_latency_timer(port) >= 0) {
1608                         dev_dbg(&port->dev,
1609                                 "%s: has latency timer so not an AM type\n",
1610                                 __func__);
1611                         priv->chip_type = FT232BM;
1612                 }
1613         } else if (version < 0x600) {
1614                 /* Assume it's an FT232BM (or FT245BM) */
1615                 priv->chip_type = FT232BM;
1616         } else if (version < 0x900) {
1617                 /* Assume it's an FT232RL */
1618                 priv->chip_type = FT232RL;
1619         } else if (version < 0x1000) {
1620                 /* Assume it's an FT232H */
1621                 priv->chip_type = FT232H;
1622         } else {
1623                 /* Assume it's an FT-X series device */
1624                 priv->chip_type = FTX;
1625         }
1626
1627         dev_info(&udev->dev, "Detected %s\n", ftdi_chip_name[priv->chip_type]);
1628 }
1629
1630
1631 /*
1632  * Determine the maximum packet size for the device. This depends on the chip
1633  * type and the USB host capabilities. The value should be obtained from the
1634  * device descriptor as the chip will use the appropriate values for the host.
1635  */
1636 static void ftdi_set_max_packet_size(struct usb_serial_port *port)
1637 {
1638         struct ftdi_private *priv = usb_get_serial_port_data(port);
1639         struct usb_interface *interface = port->serial->interface;
1640         struct usb_endpoint_descriptor *ep_desc;
1641         unsigned num_endpoints;
1642         unsigned i;
1643
1644         num_endpoints = interface->cur_altsetting->desc.bNumEndpoints;
1645         if (!num_endpoints)
1646                 return;
1647
1648         /*
1649          * NOTE: Some customers have programmed FT232R/FT245R devices
1650          * with an endpoint size of 0 - not good. In this case, we
1651          * want to override the endpoint descriptor setting and use a
1652          * value of 64 for wMaxPacketSize.
1653          */
1654         for (i = 0; i < num_endpoints; i++) {
1655                 ep_desc = &interface->cur_altsetting->endpoint[i].desc;
1656                 if (!ep_desc->wMaxPacketSize) {
1657                         ep_desc->wMaxPacketSize = cpu_to_le16(0x40);
1658                         dev_warn(&port->dev, "Overriding wMaxPacketSize on endpoint %d\n",
1659                                         usb_endpoint_num(ep_desc));
1660                 }
1661         }
1662
1663         /* Set max packet size based on last descriptor. */
1664         priv->max_packet_size = usb_endpoint_maxp(ep_desc);
1665 }
1666
1667
1668 /*
1669  * ***************************************************************************
1670  * Sysfs Attribute
1671  * ***************************************************************************
1672  */
1673
1674 static ssize_t latency_timer_show(struct device *dev,
1675                                   struct device_attribute *attr, char *buf)
1676 {
1677         struct usb_serial_port *port = to_usb_serial_port(dev);
1678         struct ftdi_private *priv = usb_get_serial_port_data(port);
1679         if (priv->flags & ASYNC_LOW_LATENCY)
1680                 return sprintf(buf, "1\n");
1681         else
1682                 return sprintf(buf, "%i\n", priv->latency);
1683 }
1684
1685 /* Write a new value of the latency timer, in units of milliseconds. */
1686 static ssize_t latency_timer_store(struct device *dev,
1687                                    struct device_attribute *attr,
1688                                    const char *valbuf, size_t count)
1689 {
1690         struct usb_serial_port *port = to_usb_serial_port(dev);
1691         struct ftdi_private *priv = usb_get_serial_port_data(port);
1692         u8 v;
1693         int rv;
1694
1695         if (kstrtou8(valbuf, 10, &v))
1696                 return -EINVAL;
1697
1698         priv->latency = v;
1699         rv = write_latency_timer(port);
1700         if (rv < 0)
1701                 return -EIO;
1702         return count;
1703 }
1704 static DEVICE_ATTR_RW(latency_timer);
1705
1706 /* Write an event character directly to the FTDI register.  The ASCII
1707    value is in the low 8 bits, with the enable bit in the 9th bit. */
1708 static ssize_t event_char_store(struct device *dev,
1709         struct device_attribute *attr, const char *valbuf, size_t count)
1710 {
1711         struct usb_serial_port *port = to_usb_serial_port(dev);
1712         struct ftdi_private *priv = usb_get_serial_port_data(port);
1713         struct usb_device *udev = port->serial->dev;
1714         unsigned int v;
1715         int rv;
1716
1717         if (kstrtouint(valbuf, 0, &v) || v >= 0x200)
1718                 return -EINVAL;
1719
1720         dev_dbg(&port->dev, "%s: setting event char = 0x%03x\n", __func__, v);
1721
1722         rv = usb_control_msg(udev,
1723                              usb_sndctrlpipe(udev, 0),
1724                              FTDI_SIO_SET_EVENT_CHAR_REQUEST,
1725                              FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE,
1726                              v, priv->interface,
1727                              NULL, 0, WDR_TIMEOUT);
1728         if (rv < 0) {
1729                 dev_dbg(&port->dev, "Unable to write event character: %i\n", rv);
1730                 return -EIO;
1731         }
1732
1733         return count;
1734 }
1735 static DEVICE_ATTR_WO(event_char);
1736
1737 static int create_sysfs_attrs(struct usb_serial_port *port)
1738 {
1739         struct ftdi_private *priv = usb_get_serial_port_data(port);
1740         int retval = 0;
1741
1742         /* XXX I've no idea if the original SIO supports the event_char
1743          * sysfs parameter, so I'm playing it safe.  */
1744         if (priv->chip_type != SIO) {
1745                 dev_dbg(&port->dev, "sysfs attributes for %s\n", ftdi_chip_name[priv->chip_type]);
1746                 retval = device_create_file(&port->dev, &dev_attr_event_char);
1747                 if ((!retval) &&
1748                     (priv->chip_type == FT232BM ||
1749                      priv->chip_type == FT2232C ||
1750                      priv->chip_type == FT232RL ||
1751                      priv->chip_type == FT2232H ||
1752                      priv->chip_type == FT4232H ||
1753                      priv->chip_type == FT232H ||
1754                      priv->chip_type == FTX)) {
1755                         retval = device_create_file(&port->dev,
1756                                                     &dev_attr_latency_timer);
1757                 }
1758         }
1759         return retval;
1760 }
1761
1762 static void remove_sysfs_attrs(struct usb_serial_port *port)
1763 {
1764         struct ftdi_private *priv = usb_get_serial_port_data(port);
1765
1766         /* XXX see create_sysfs_attrs */
1767         if (priv->chip_type != SIO) {
1768                 device_remove_file(&port->dev, &dev_attr_event_char);
1769                 if (priv->chip_type == FT232BM ||
1770                     priv->chip_type == FT2232C ||
1771                     priv->chip_type == FT232RL ||
1772                     priv->chip_type == FT2232H ||
1773                     priv->chip_type == FT4232H ||
1774                     priv->chip_type == FT232H ||
1775                     priv->chip_type == FTX) {
1776                         device_remove_file(&port->dev, &dev_attr_latency_timer);
1777                 }
1778         }
1779
1780 }
1781
1782 #ifdef CONFIG_GPIOLIB
1783
1784 static int ftdi_set_bitmode(struct usb_serial_port *port, u8 mode)
1785 {
1786         struct ftdi_private *priv = usb_get_serial_port_data(port);
1787         struct usb_serial *serial = port->serial;
1788         int result;
1789         u16 val;
1790
1791         result = usb_autopm_get_interface(serial->interface);
1792         if (result)
1793                 return result;
1794
1795         val = (mode << 8) | (priv->gpio_output << 4) | priv->gpio_value;
1796         result = usb_control_msg(serial->dev,
1797                                  usb_sndctrlpipe(serial->dev, 0),
1798                                  FTDI_SIO_SET_BITMODE_REQUEST,
1799                                  FTDI_SIO_SET_BITMODE_REQUEST_TYPE, val,
1800                                  priv->interface, NULL, 0, WDR_TIMEOUT);
1801         if (result < 0) {
1802                 dev_err(&serial->interface->dev,
1803                         "bitmode request failed for value 0x%04x: %d\n",
1804                         val, result);
1805         }
1806
1807         usb_autopm_put_interface(serial->interface);
1808
1809         return result;
1810 }
1811
1812 static int ftdi_set_cbus_pins(struct usb_serial_port *port)
1813 {
1814         return ftdi_set_bitmode(port, FTDI_SIO_BITMODE_CBUS);
1815 }
1816
1817 static int ftdi_exit_cbus_mode(struct usb_serial_port *port)
1818 {
1819         struct ftdi_private *priv = usb_get_serial_port_data(port);
1820
1821         priv->gpio_output = 0;
1822         priv->gpio_value = 0;
1823         return ftdi_set_bitmode(port, FTDI_SIO_BITMODE_RESET);
1824 }
1825
1826 static int ftdi_gpio_request(struct gpio_chip *gc, unsigned int offset)
1827 {
1828         struct usb_serial_port *port = gpiochip_get_data(gc);
1829         struct ftdi_private *priv = usb_get_serial_port_data(port);
1830         int result;
1831
1832         if (priv->gpio_altfunc & BIT(offset))
1833                 return -ENODEV;
1834
1835         mutex_lock(&priv->gpio_lock);
1836         if (!priv->gpio_used) {
1837                 /* Set default pin states, as we cannot get them from device */
1838                 priv->gpio_output = 0x00;
1839                 priv->gpio_value = 0x00;
1840                 result = ftdi_set_cbus_pins(port);
1841                 if (result) {
1842                         mutex_unlock(&priv->gpio_lock);
1843                         return result;
1844                 }
1845
1846                 priv->gpio_used = true;
1847         }
1848         mutex_unlock(&priv->gpio_lock);
1849
1850         return 0;
1851 }
1852
1853 static int ftdi_read_cbus_pins(struct usb_serial_port *port)
1854 {
1855         struct ftdi_private *priv = usb_get_serial_port_data(port);
1856         struct usb_serial *serial = port->serial;
1857         unsigned char *buf;
1858         int result;
1859
1860         result = usb_autopm_get_interface(serial->interface);
1861         if (result)
1862                 return result;
1863
1864         buf = kmalloc(1, GFP_KERNEL);
1865         if (!buf) {
1866                 usb_autopm_put_interface(serial->interface);
1867                 return -ENOMEM;
1868         }
1869
1870         result = usb_control_msg(serial->dev,
1871                                  usb_rcvctrlpipe(serial->dev, 0),
1872                                  FTDI_SIO_READ_PINS_REQUEST,
1873                                  FTDI_SIO_READ_PINS_REQUEST_TYPE, 0,
1874                                  priv->interface, buf, 1, WDR_TIMEOUT);
1875         if (result < 1) {
1876                 if (result >= 0)
1877                         result = -EIO;
1878         } else {
1879                 result = buf[0];
1880         }
1881
1882         kfree(buf);
1883         usb_autopm_put_interface(serial->interface);
1884
1885         return result;
1886 }
1887
1888 static int ftdi_gpio_get(struct gpio_chip *gc, unsigned int gpio)
1889 {
1890         struct usb_serial_port *port = gpiochip_get_data(gc);
1891         int result;
1892
1893         result = ftdi_read_cbus_pins(port);
1894         if (result < 0)
1895                 return result;
1896
1897         return !!(result & BIT(gpio));
1898 }
1899
1900 static void ftdi_gpio_set(struct gpio_chip *gc, unsigned int gpio, int value)
1901 {
1902         struct usb_serial_port *port = gpiochip_get_data(gc);
1903         struct ftdi_private *priv = usb_get_serial_port_data(port);
1904
1905         mutex_lock(&priv->gpio_lock);
1906
1907         if (value)
1908                 priv->gpio_value |= BIT(gpio);
1909         else
1910                 priv->gpio_value &= ~BIT(gpio);
1911
1912         ftdi_set_cbus_pins(port);
1913
1914         mutex_unlock(&priv->gpio_lock);
1915 }
1916
1917 static int ftdi_gpio_get_multiple(struct gpio_chip *gc, unsigned long *mask,
1918                                         unsigned long *bits)
1919 {
1920         struct usb_serial_port *port = gpiochip_get_data(gc);
1921         int result;
1922
1923         result = ftdi_read_cbus_pins(port);
1924         if (result < 0)
1925                 return result;
1926
1927         *bits = result & *mask;
1928
1929         return 0;
1930 }
1931
1932 static void ftdi_gpio_set_multiple(struct gpio_chip *gc, unsigned long *mask,
1933                                         unsigned long *bits)
1934 {
1935         struct usb_serial_port *port = gpiochip_get_data(gc);
1936         struct ftdi_private *priv = usb_get_serial_port_data(port);
1937
1938         mutex_lock(&priv->gpio_lock);
1939
1940         priv->gpio_value &= ~(*mask);
1941         priv->gpio_value |= *bits & *mask;
1942         ftdi_set_cbus_pins(port);
1943
1944         mutex_unlock(&priv->gpio_lock);
1945 }
1946
1947 static int ftdi_gpio_direction_get(struct gpio_chip *gc, unsigned int gpio)
1948 {
1949         struct usb_serial_port *port = gpiochip_get_data(gc);
1950         struct ftdi_private *priv = usb_get_serial_port_data(port);
1951
1952         return !(priv->gpio_output & BIT(gpio));
1953 }
1954
1955 static int ftdi_gpio_direction_input(struct gpio_chip *gc, unsigned int gpio)
1956 {
1957         struct usb_serial_port *port = gpiochip_get_data(gc);
1958         struct ftdi_private *priv = usb_get_serial_port_data(port);
1959         int result;
1960
1961         mutex_lock(&priv->gpio_lock);
1962
1963         priv->gpio_output &= ~BIT(gpio);
1964         result = ftdi_set_cbus_pins(port);
1965
1966         mutex_unlock(&priv->gpio_lock);
1967
1968         return result;
1969 }
1970
1971 static int ftdi_gpio_direction_output(struct gpio_chip *gc, unsigned int gpio,
1972                                         int value)
1973 {
1974         struct usb_serial_port *port = gpiochip_get_data(gc);
1975         struct ftdi_private *priv = usb_get_serial_port_data(port);
1976         int result;
1977
1978         mutex_lock(&priv->gpio_lock);
1979
1980         priv->gpio_output |= BIT(gpio);
1981         if (value)
1982                 priv->gpio_value |= BIT(gpio);
1983         else
1984                 priv->gpio_value &= ~BIT(gpio);
1985
1986         result = ftdi_set_cbus_pins(port);
1987
1988         mutex_unlock(&priv->gpio_lock);
1989
1990         return result;
1991 }
1992
1993 static int ftdi_read_eeprom(struct usb_serial *serial, void *dst, u16 addr,
1994                                 u16 nbytes)
1995 {
1996         int read = 0;
1997
1998         if (addr % 2 != 0)
1999                 return -EINVAL;
2000         if (nbytes % 2 != 0)
2001                 return -EINVAL;
2002
2003         /* Read EEPROM two bytes at a time */
2004         while (read < nbytes) {
2005                 int rv;
2006
2007                 rv = usb_control_msg(serial->dev,
2008                                      usb_rcvctrlpipe(serial->dev, 0),
2009                                      FTDI_SIO_READ_EEPROM_REQUEST,
2010                                      FTDI_SIO_READ_EEPROM_REQUEST_TYPE,
2011                                      0, (addr + read) / 2, dst + read, 2,
2012                                      WDR_TIMEOUT);
2013                 if (rv < 2) {
2014                         if (rv >= 0)
2015                                 return -EIO;
2016                         else
2017                                 return rv;
2018                 }
2019
2020                 read += rv;
2021         }
2022
2023         return 0;
2024 }
2025
2026 static int ftdi_gpio_init_ft232h(struct usb_serial_port *port)
2027 {
2028         struct ftdi_private *priv = usb_get_serial_port_data(port);
2029         u16 cbus_config;
2030         u8 *buf;
2031         int ret;
2032         int i;
2033
2034         buf = kmalloc(4, GFP_KERNEL);
2035         if (!buf)
2036                 return -ENOMEM;
2037
2038         ret = ftdi_read_eeprom(port->serial, buf, 0x1a, 4);
2039         if (ret < 0)
2040                 goto out_free;
2041
2042         /*
2043          * FT232H CBUS Memory Map
2044          *
2045          * 0x1a: X- (upper nibble -> AC5)
2046          * 0x1b: -X (lower nibble -> AC6)
2047          * 0x1c: XX (upper nibble -> AC9 | lower nibble -> AC8)
2048          */
2049         cbus_config = buf[2] << 8 | (buf[1] & 0xf) << 4 | (buf[0] & 0xf0) >> 4;
2050
2051         priv->gc.ngpio = 4;
2052         priv->gpio_altfunc = 0xff;
2053
2054         for (i = 0; i < priv->gc.ngpio; ++i) {
2055                 if ((cbus_config & 0xf) == FTDI_FTX_CBUS_MUX_GPIO)
2056                         priv->gpio_altfunc &= ~BIT(i);
2057                 cbus_config >>= 4;
2058         }
2059
2060 out_free:
2061         kfree(buf);
2062
2063         return ret;
2064 }
2065
2066 static int ftdi_gpio_init_ft232r(struct usb_serial_port *port)
2067 {
2068         struct ftdi_private *priv = usb_get_serial_port_data(port);
2069         u16 cbus_config;
2070         u8 *buf;
2071         int ret;
2072         int i;
2073
2074         buf = kmalloc(2, GFP_KERNEL);
2075         if (!buf)
2076                 return -ENOMEM;
2077
2078         ret = ftdi_read_eeprom(port->serial, buf, 0x14, 2);
2079         if (ret < 0)
2080                 goto out_free;
2081
2082         cbus_config = le16_to_cpup((__le16 *)buf);
2083         dev_dbg(&port->dev, "cbus_config = 0x%04x\n", cbus_config);
2084
2085         priv->gc.ngpio = 4;
2086
2087         priv->gpio_altfunc = 0xff;
2088         for (i = 0; i < priv->gc.ngpio; ++i) {
2089                 if ((cbus_config & 0xf) == FTDI_FT232R_CBUS_MUX_GPIO)
2090                         priv->gpio_altfunc &= ~BIT(i);
2091                 cbus_config >>= 4;
2092         }
2093 out_free:
2094         kfree(buf);
2095
2096         return ret;
2097 }
2098
2099 static int ftdi_gpio_init_ftx(struct usb_serial_port *port)
2100 {
2101         struct ftdi_private *priv = usb_get_serial_port_data(port);
2102         struct usb_serial *serial = port->serial;
2103         const u16 cbus_cfg_addr = 0x1a;
2104         const u16 cbus_cfg_size = 4;
2105         u8 *cbus_cfg_buf;
2106         int result;
2107         u8 i;
2108
2109         cbus_cfg_buf = kmalloc(cbus_cfg_size, GFP_KERNEL);
2110         if (!cbus_cfg_buf)
2111                 return -ENOMEM;
2112
2113         result = ftdi_read_eeprom(serial, cbus_cfg_buf,
2114                                   cbus_cfg_addr, cbus_cfg_size);
2115         if (result < 0)
2116                 goto out_free;
2117
2118         /* FIXME: FT234XD alone has 1 GPIO, but how to recognize this IC? */
2119         priv->gc.ngpio = 4;
2120
2121         /* Determine which pins are configured for CBUS bitbanging */
2122         priv->gpio_altfunc = 0xff;
2123         for (i = 0; i < priv->gc.ngpio; ++i) {
2124                 if (cbus_cfg_buf[i] == FTDI_FTX_CBUS_MUX_GPIO)
2125                         priv->gpio_altfunc &= ~BIT(i);
2126         }
2127
2128 out_free:
2129         kfree(cbus_cfg_buf);
2130
2131         return result;
2132 }
2133
2134 static int ftdi_gpio_init(struct usb_serial_port *port)
2135 {
2136         struct ftdi_private *priv = usb_get_serial_port_data(port);
2137         struct usb_serial *serial = port->serial;
2138         int result;
2139
2140         switch (priv->chip_type) {
2141         case FT232H:
2142                 result = ftdi_gpio_init_ft232h(port);
2143                 break;
2144         case FT232RL:
2145                 result = ftdi_gpio_init_ft232r(port);
2146                 break;
2147         case FTX:
2148                 result = ftdi_gpio_init_ftx(port);
2149                 break;
2150         default:
2151                 return 0;
2152         }
2153
2154         if (result < 0)
2155                 return result;
2156
2157         mutex_init(&priv->gpio_lock);
2158
2159         priv->gc.label = "ftdi-cbus";
2160         priv->gc.request = ftdi_gpio_request;
2161         priv->gc.get_direction = ftdi_gpio_direction_get;
2162         priv->gc.direction_input = ftdi_gpio_direction_input;
2163         priv->gc.direction_output = ftdi_gpio_direction_output;
2164         priv->gc.get = ftdi_gpio_get;
2165         priv->gc.set = ftdi_gpio_set;
2166         priv->gc.get_multiple = ftdi_gpio_get_multiple;
2167         priv->gc.set_multiple = ftdi_gpio_set_multiple;
2168         priv->gc.owner = THIS_MODULE;
2169         priv->gc.parent = &serial->interface->dev;
2170         priv->gc.base = -1;
2171         priv->gc.can_sleep = true;
2172
2173         result = gpiochip_add_data(&priv->gc, port);
2174         if (!result)
2175                 priv->gpio_registered = true;
2176
2177         return result;
2178 }
2179
2180 static void ftdi_gpio_remove(struct usb_serial_port *port)
2181 {
2182         struct ftdi_private *priv = usb_get_serial_port_data(port);
2183
2184         if (priv->gpio_registered) {
2185                 gpiochip_remove(&priv->gc);
2186                 priv->gpio_registered = false;
2187         }
2188
2189         if (priv->gpio_used) {
2190                 /* Exiting CBUS-mode does not reset pin states. */
2191                 ftdi_exit_cbus_mode(port);
2192                 priv->gpio_used = false;
2193         }
2194 }
2195
2196 #else
2197
2198 static int ftdi_gpio_init(struct usb_serial_port *port)
2199 {
2200         return 0;
2201 }
2202
2203 static void ftdi_gpio_remove(struct usb_serial_port *port) { }
2204
2205 #endif  /* CONFIG_GPIOLIB */
2206
2207 /*
2208  * ***************************************************************************
2209  * FTDI driver specific functions
2210  * ***************************************************************************
2211  */
2212
2213 /* Probe function to check for special devices */
2214 static int ftdi_sio_probe(struct usb_serial *serial,
2215                                         const struct usb_device_id *id)
2216 {
2217         const struct ftdi_sio_quirk *quirk =
2218                                 (struct ftdi_sio_quirk *)id->driver_info;
2219
2220         if (quirk && quirk->probe) {
2221                 int ret = quirk->probe(serial);
2222                 if (ret != 0)
2223                         return ret;
2224         }
2225
2226         usb_set_serial_data(serial, (void *)id->driver_info);
2227
2228         return 0;
2229 }
2230
2231 static int ftdi_sio_port_probe(struct usb_serial_port *port)
2232 {
2233         struct ftdi_private *priv;
2234         const struct ftdi_sio_quirk *quirk = usb_get_serial_data(port->serial);
2235         int result;
2236
2237         priv = kzalloc(sizeof(struct ftdi_private), GFP_KERNEL);
2238         if (!priv)
2239                 return -ENOMEM;
2240
2241         mutex_init(&priv->cfg_lock);
2242
2243         if (quirk && quirk->port_probe)
2244                 quirk->port_probe(priv);
2245
2246         usb_set_serial_port_data(port, priv);
2247
2248         ftdi_determine_type(port);
2249         ftdi_set_max_packet_size(port);
2250         if (read_latency_timer(port) < 0)
2251                 priv->latency = 16;
2252         write_latency_timer(port);
2253         create_sysfs_attrs(port);
2254
2255         result = ftdi_gpio_init(port);
2256         if (result < 0) {
2257                 dev_err(&port->serial->interface->dev,
2258                         "GPIO initialisation failed: %d\n",
2259                         result);
2260         }
2261
2262         return 0;
2263 }
2264
2265 /* Setup for the USB-UIRT device, which requires hardwired
2266  * baudrate (38400 gets mapped to 312500) */
2267 /* Called from usbserial:serial_probe */
2268 static void ftdi_USB_UIRT_setup(struct ftdi_private *priv)
2269 {
2270         priv->flags |= ASYNC_SPD_CUST;
2271         priv->custom_divisor = 77;
2272         priv->force_baud = 38400;
2273 }
2274
2275 /* Setup for the HE-TIRA1 device, which requires hardwired
2276  * baudrate (38400 gets mapped to 100000) and RTS-CTS enabled.  */
2277
2278 static void ftdi_HE_TIRA1_setup(struct ftdi_private *priv)
2279 {
2280         priv->flags |= ASYNC_SPD_CUST;
2281         priv->custom_divisor = 240;
2282         priv->force_baud = 38400;
2283         priv->force_rtscts = 1;
2284 }
2285
2286 /*
2287  * Module parameter to control latency timer for NDI FTDI-based USB devices.
2288  * If this value is not set in /etc/modprobe.d/ its value will be set
2289  * to 1ms.
2290  */
2291 static int ndi_latency_timer = 1;
2292
2293 /* Setup for the NDI FTDI-based USB devices, which requires hardwired
2294  * baudrate (19200 gets mapped to 1200000).
2295  *
2296  * Called from usbserial:serial_probe.
2297  */
2298 static int ftdi_NDI_device_setup(struct usb_serial *serial)
2299 {
2300         struct usb_device *udev = serial->dev;
2301         int latency = ndi_latency_timer;
2302
2303         if (latency == 0)
2304                 latency = 1;
2305         if (latency > 99)
2306                 latency = 99;
2307
2308         dev_dbg(&udev->dev, "%s setting NDI device latency to %d\n", __func__, latency);
2309         dev_info(&udev->dev, "NDI device with a latency value of %d\n", latency);
2310
2311         /* FIXME: errors are not returned */
2312         usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2313                                 FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
2314                                 FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
2315                                 latency, 0, NULL, 0, WDR_TIMEOUT);
2316         return 0;
2317 }
2318
2319 /*
2320  * First port on JTAG adaptors such as Olimex arm-usb-ocd or the FIC/OpenMoko
2321  * Neo1973 Debug Board is reserved for JTAG interface and can be accessed from
2322  * userspace using openocd.
2323  */
2324 static int ftdi_jtag_probe(struct usb_serial *serial)
2325 {
2326         struct usb_device *udev = serial->dev;
2327         struct usb_interface *interface = serial->interface;
2328
2329         if (interface == udev->actconfig->interface[0]) {
2330                 dev_info(&udev->dev,
2331                          "Ignoring serial port reserved for JTAG\n");
2332                 return -ENODEV;
2333         }
2334
2335         return 0;
2336 }
2337
2338 static int ftdi_8u2232c_probe(struct usb_serial *serial)
2339 {
2340         struct usb_device *udev = serial->dev;
2341
2342         if (udev->manufacturer && !strcmp(udev->manufacturer, "CALAO Systems"))
2343                 return ftdi_jtag_probe(serial);
2344
2345         if (udev->product &&
2346                 (!strcmp(udev->product, "Arrow USB Blaster") ||
2347                  !strcmp(udev->product, "BeagleBone/XDS100V2") ||
2348                  !strcmp(udev->product, "SNAP Connect E10")))
2349                 return ftdi_jtag_probe(serial);
2350
2351         return 0;
2352 }
2353
2354 /*
2355  * First two ports on JTAG adaptors using an FT4232 such as STMicroelectronics's
2356  * ST Micro Connect Lite are reserved for JTAG or other non-UART interfaces and
2357  * can be accessed from userspace.
2358  * The next two ports are enabled as UARTs by default, where port 2 is
2359  * a conventional RS-232 UART.
2360  */
2361 static int ftdi_stmclite_probe(struct usb_serial *serial)
2362 {
2363         struct usb_device *udev = serial->dev;
2364         struct usb_interface *interface = serial->interface;
2365
2366         if (interface == udev->actconfig->interface[0] ||
2367             interface == udev->actconfig->interface[1]) {
2368                 dev_info(&udev->dev, "Ignoring serial port reserved for JTAG\n");
2369                 return -ENODEV;
2370         }
2371
2372         return 0;
2373 }
2374
2375 static int ftdi_sio_port_remove(struct usb_serial_port *port)
2376 {
2377         struct ftdi_private *priv = usb_get_serial_port_data(port);
2378
2379         ftdi_gpio_remove(port);
2380
2381         remove_sysfs_attrs(port);
2382
2383         kfree(priv);
2384
2385         return 0;
2386 }
2387
2388 static int ftdi_open(struct tty_struct *tty, struct usb_serial_port *port)
2389 {
2390         struct usb_device *dev = port->serial->dev;
2391         struct ftdi_private *priv = usb_get_serial_port_data(port);
2392
2393         /* No error checking for this (will get errors later anyway) */
2394         /* See ftdi_sio.h for description of what is reset */
2395         usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2396                         FTDI_SIO_RESET_REQUEST, FTDI_SIO_RESET_REQUEST_TYPE,
2397                         FTDI_SIO_RESET_SIO,
2398                         priv->interface, NULL, 0, WDR_TIMEOUT);
2399
2400         /* Termios defaults are set by usb_serial_init. We don't change
2401            port->tty->termios - this would lose speed settings, etc.
2402            This is same behaviour as serial.c/rs_open() - Kuba */
2403
2404         /* ftdi_set_termios  will send usb control messages */
2405         if (tty)
2406                 ftdi_set_termios(tty, port, NULL);
2407
2408         return usb_serial_generic_open(tty, port);
2409 }
2410
2411 static void ftdi_dtr_rts(struct usb_serial_port *port, int on)
2412 {
2413         struct ftdi_private *priv = usb_get_serial_port_data(port);
2414
2415         /* Disable flow control */
2416         if (!on) {
2417                 if (usb_control_msg(port->serial->dev,
2418                             usb_sndctrlpipe(port->serial->dev, 0),
2419                             FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2420                             FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2421                             0, priv->interface, NULL, 0,
2422                             WDR_TIMEOUT) < 0) {
2423                         dev_err(&port->dev, "error from flowcontrol urb\n");
2424                 }
2425         }
2426         /* drop RTS and DTR */
2427         if (on)
2428                 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2429         else
2430                 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2431 }
2432
2433 /* The SIO requires the first byte to have:
2434  *  B0 1
2435  *  B1 0
2436  *  B2..7 length of message excluding byte 0
2437  *
2438  * The new devices do not require this byte
2439  */
2440 static int ftdi_prepare_write_buffer(struct usb_serial_port *port,
2441                                                 void *dest, size_t size)
2442 {
2443         struct ftdi_private *priv;
2444         int count;
2445         unsigned long flags;
2446
2447         priv = usb_get_serial_port_data(port);
2448
2449         if (priv->chip_type == SIO) {
2450                 unsigned char *buffer = dest;
2451                 int i, len, c;
2452
2453                 count = 0;
2454                 spin_lock_irqsave(&port->lock, flags);
2455                 for (i = 0; i < size - 1; i += priv->max_packet_size) {
2456                         len = min_t(int, size - i, priv->max_packet_size) - 1;
2457                         c = kfifo_out(&port->write_fifo, &buffer[i + 1], len);
2458                         if (!c)
2459                                 break;
2460                         port->icount.tx += c;
2461                         buffer[i] = (c << 2) + 1;
2462                         count += c + 1;
2463                 }
2464                 spin_unlock_irqrestore(&port->lock, flags);
2465         } else {
2466                 count = kfifo_out_locked(&port->write_fifo, dest, size,
2467                                                                 &port->lock);
2468                 port->icount.tx += count;
2469         }
2470
2471         return count;
2472 }
2473
2474 #define FTDI_RS_ERR_MASK (FTDI_RS_BI | FTDI_RS_PE | FTDI_RS_FE | FTDI_RS_OE)
2475
2476 static int ftdi_process_packet(struct usb_serial_port *port,
2477                 struct ftdi_private *priv, char *packet, int len)
2478 {
2479         int i;
2480         char status;
2481         char flag;
2482         char *ch;
2483
2484         if (len < 2) {
2485                 dev_dbg(&port->dev, "malformed packet\n");
2486                 return 0;
2487         }
2488
2489         /* Compare new line status to the old one, signal if different/
2490            N.B. packet may be processed more than once, but differences
2491            are only processed once.  */
2492         status = packet[0] & FTDI_STATUS_B0_MASK;
2493         if (status != priv->prev_status) {
2494                 char diff_status = status ^ priv->prev_status;
2495
2496                 if (diff_status & FTDI_RS0_CTS)
2497                         port->icount.cts++;
2498                 if (diff_status & FTDI_RS0_DSR)
2499                         port->icount.dsr++;
2500                 if (diff_status & FTDI_RS0_RI)
2501                         port->icount.rng++;
2502                 if (diff_status & FTDI_RS0_RLSD) {
2503                         struct tty_struct *tty;
2504
2505                         port->icount.dcd++;
2506                         tty = tty_port_tty_get(&port->port);
2507                         if (tty)
2508                                 usb_serial_handle_dcd_change(port, tty,
2509                                                 status & FTDI_RS0_RLSD);
2510                         tty_kref_put(tty);
2511                 }
2512
2513                 wake_up_interruptible(&port->port.delta_msr_wait);
2514                 priv->prev_status = status;
2515         }
2516
2517         /* save if the transmitter is empty or not */
2518         if (packet[1] & FTDI_RS_TEMT)
2519                 priv->transmit_empty = 1;
2520         else
2521                 priv->transmit_empty = 0;
2522
2523         len -= 2;
2524         if (!len)
2525                 return 0;       /* status only */
2526
2527         /*
2528          * Break and error status must only be processed for packets with
2529          * data payload to avoid over-reporting.
2530          */
2531         flag = TTY_NORMAL;
2532         if (packet[1] & FTDI_RS_ERR_MASK) {
2533                 /* Break takes precedence over parity, which takes precedence
2534                  * over framing errors */
2535                 if (packet[1] & FTDI_RS_BI) {
2536                         flag = TTY_BREAK;
2537                         port->icount.brk++;
2538                         usb_serial_handle_break(port);
2539                 } else if (packet[1] & FTDI_RS_PE) {
2540                         flag = TTY_PARITY;
2541                         port->icount.parity++;
2542                 } else if (packet[1] & FTDI_RS_FE) {
2543                         flag = TTY_FRAME;
2544                         port->icount.frame++;
2545                 }
2546                 /* Overrun is special, not associated with a char */
2547                 if (packet[1] & FTDI_RS_OE) {
2548                         port->icount.overrun++;
2549                         tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
2550                 }
2551         }
2552
2553         port->icount.rx += len;
2554         ch = packet + 2;
2555
2556         if (port->port.console && port->sysrq) {
2557                 for (i = 0; i < len; i++, ch++) {
2558                         if (!usb_serial_handle_sysrq_char(port, *ch))
2559                                 tty_insert_flip_char(&port->port, *ch, flag);
2560                 }
2561         } else {
2562                 tty_insert_flip_string_fixed_flag(&port->port, ch, flag, len);
2563         }
2564
2565         return len;
2566 }
2567
2568 static void ftdi_process_read_urb(struct urb *urb)
2569 {
2570         struct usb_serial_port *port = urb->context;
2571         struct ftdi_private *priv = usb_get_serial_port_data(port);
2572         char *data = (char *)urb->transfer_buffer;
2573         int i;
2574         int len;
2575         int count = 0;
2576
2577         for (i = 0; i < urb->actual_length; i += priv->max_packet_size) {
2578                 len = min_t(int, urb->actual_length - i, priv->max_packet_size);
2579                 count += ftdi_process_packet(port, priv, &data[i], len);
2580         }
2581
2582         if (count)
2583                 tty_flip_buffer_push(&port->port);
2584 }
2585
2586 static void ftdi_break_ctl(struct tty_struct *tty, int break_state)
2587 {
2588         struct usb_serial_port *port = tty->driver_data;
2589         struct ftdi_private *priv = usb_get_serial_port_data(port);
2590         u16 value;
2591
2592         /* break_state = -1 to turn on break, and 0 to turn off break */
2593         /* see drivers/char/tty_io.c to see it used */
2594         /* last_set_data_value NEVER has the break bit set in it */
2595
2596         if (break_state)
2597                 value = priv->last_set_data_value | FTDI_SIO_SET_BREAK;
2598         else
2599                 value = priv->last_set_data_value;
2600
2601         if (usb_control_msg(port->serial->dev,
2602                         usb_sndctrlpipe(port->serial->dev, 0),
2603                         FTDI_SIO_SET_DATA_REQUEST,
2604                         FTDI_SIO_SET_DATA_REQUEST_TYPE,
2605                         value , priv->interface,
2606                         NULL, 0, WDR_TIMEOUT) < 0) {
2607                 dev_err(&port->dev, "%s FAILED to enable/disable break state (state was %d)\n",
2608                         __func__, break_state);
2609         }
2610
2611         dev_dbg(&port->dev, "%s break state is %d - urb is %d\n", __func__,
2612                 break_state, value);
2613
2614 }
2615
2616 static bool ftdi_tx_empty(struct usb_serial_port *port)
2617 {
2618         unsigned char buf[2];
2619         int ret;
2620
2621         ret = ftdi_get_modem_status(port, buf);
2622         if (ret == 2) {
2623                 if (!(buf[1] & FTDI_RS_TEMT))
2624                         return false;
2625         }
2626
2627         return true;
2628 }
2629
2630 /* old_termios contains the original termios settings and tty->termios contains
2631  * the new setting to be used
2632  * WARNING: set_termios calls this with old_termios in kernel space
2633  */
2634 static void ftdi_set_termios(struct tty_struct *tty,
2635                 struct usb_serial_port *port, struct ktermios *old_termios)
2636 {
2637         struct usb_device *dev = port->serial->dev;
2638         struct device *ddev = &port->dev;
2639         struct ftdi_private *priv = usb_get_serial_port_data(port);
2640         struct ktermios *termios = &tty->termios;
2641         unsigned int cflag = termios->c_cflag;
2642         u16 value, index;
2643         int ret;
2644
2645         /* Force baud rate if this device requires it, unless it is set to
2646            B0. */
2647         if (priv->force_baud && ((termios->c_cflag & CBAUD) != B0)) {
2648                 dev_dbg(ddev, "%s: forcing baud rate for this device\n", __func__);
2649                 tty_encode_baud_rate(tty, priv->force_baud,
2650                                         priv->force_baud);
2651         }
2652
2653         /* Force RTS-CTS if this device requires it. */
2654         if (priv->force_rtscts) {
2655                 dev_dbg(ddev, "%s: forcing rtscts for this device\n", __func__);
2656                 termios->c_cflag |= CRTSCTS;
2657         }
2658
2659         /*
2660          * All FTDI UART chips are limited to CS7/8. We shouldn't pretend to
2661          * support CS5/6 and revert the CSIZE setting instead.
2662          *
2663          * CS5 however is used to control some smartcard readers which abuse
2664          * this limitation to switch modes. Original FTDI chips fall back to
2665          * eight data bits.
2666          *
2667          * TODO: Implement a quirk to only allow this with mentioned
2668          *       readers. One I know of (Argolis Smartreader V1)
2669          *       returns "USB smartcard server" as iInterface string.
2670          *       The vendor didn't bother with a custom VID/PID of
2671          *       course.
2672          */
2673         if (C_CSIZE(tty) == CS6) {
2674                 dev_warn(ddev, "requested CSIZE setting not supported\n");
2675
2676                 termios->c_cflag &= ~CSIZE;
2677                 if (old_termios)
2678                         termios->c_cflag |= old_termios->c_cflag & CSIZE;
2679                 else
2680                         termios->c_cflag |= CS8;
2681         }
2682
2683         cflag = termios->c_cflag;
2684
2685         if (!old_termios)
2686                 goto no_skip;
2687
2688         if (old_termios->c_cflag == termios->c_cflag
2689             && old_termios->c_ispeed == termios->c_ispeed
2690             && old_termios->c_ospeed == termios->c_ospeed)
2691                 goto no_c_cflag_changes;
2692
2693         /* NOTE These routines can get interrupted by
2694            ftdi_sio_read_bulk_callback  - need to examine what this means -
2695            don't see any problems yet */
2696
2697         if ((old_termios->c_cflag & (CSIZE|PARODD|PARENB|CMSPAR|CSTOPB)) ==
2698             (termios->c_cflag & (CSIZE|PARODD|PARENB|CMSPAR|CSTOPB)))
2699                 goto no_data_parity_stop_changes;
2700
2701 no_skip:
2702         /* Set number of data bits, parity, stop bits */
2703
2704         value = 0;
2705         value |= (cflag & CSTOPB ? FTDI_SIO_SET_DATA_STOP_BITS_2 :
2706                         FTDI_SIO_SET_DATA_STOP_BITS_1);
2707         if (cflag & PARENB) {
2708                 if (cflag & CMSPAR)
2709                         value |= cflag & PARODD ?
2710                                         FTDI_SIO_SET_DATA_PARITY_MARK :
2711                                         FTDI_SIO_SET_DATA_PARITY_SPACE;
2712                 else
2713                         value |= cflag & PARODD ?
2714                                         FTDI_SIO_SET_DATA_PARITY_ODD :
2715                                         FTDI_SIO_SET_DATA_PARITY_EVEN;
2716         } else {
2717                 value |= FTDI_SIO_SET_DATA_PARITY_NONE;
2718         }
2719         switch (cflag & CSIZE) {
2720         case CS5:
2721                 dev_dbg(ddev, "Setting CS5 quirk\n");
2722                 break;
2723         case CS7:
2724                 value |= 7;
2725                 dev_dbg(ddev, "Setting CS7\n");
2726                 break;
2727         default:
2728         case CS8:
2729                 value |= 8;
2730                 dev_dbg(ddev, "Setting CS8\n");
2731                 break;
2732         }
2733
2734         /* This is needed by the break command since it uses the same command
2735            - but is or'ed with this value  */
2736         priv->last_set_data_value = value;
2737
2738         if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2739                             FTDI_SIO_SET_DATA_REQUEST,
2740                             FTDI_SIO_SET_DATA_REQUEST_TYPE,
2741                             value , priv->interface,
2742                             NULL, 0, WDR_SHORT_TIMEOUT) < 0) {
2743                 dev_err(ddev, "%s FAILED to set databits/stopbits/parity\n",
2744                         __func__);
2745         }
2746
2747         /* Now do the baudrate */
2748 no_data_parity_stop_changes:
2749         if ((cflag & CBAUD) == B0) {
2750                 /* Disable flow control */
2751                 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2752                                     FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2753                                     FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2754                                     0, priv->interface,
2755                                     NULL, 0, WDR_TIMEOUT) < 0) {
2756                         dev_err(ddev, "%s error from disable flowcontrol urb\n",
2757                                 __func__);
2758                 }
2759                 /* Drop RTS and DTR */
2760                 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2761         } else {
2762                 /* set the baudrate determined before */
2763                 mutex_lock(&priv->cfg_lock);
2764                 if (change_speed(tty, port))
2765                         dev_err(ddev, "%s urb failed to set baudrate\n", __func__);
2766                 mutex_unlock(&priv->cfg_lock);
2767                 /* Ensure RTS and DTR are raised when baudrate changed from 0 */
2768                 if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
2769                         set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2770         }
2771
2772 no_c_cflag_changes:
2773         /* Set hardware-assisted flow control */
2774         value = 0;
2775
2776         if (C_CRTSCTS(tty)) {
2777                 dev_dbg(&port->dev, "enabling rts/cts flow control\n");
2778                 index = FTDI_SIO_RTS_CTS_HS;
2779         } else if (I_IXON(tty)) {
2780                 dev_dbg(&port->dev, "enabling xon/xoff flow control\n");
2781                 index = FTDI_SIO_XON_XOFF_HS;
2782                 value = STOP_CHAR(tty) << 8 | START_CHAR(tty);
2783         } else {
2784                 dev_dbg(&port->dev, "disabling flow control\n");
2785                 index = FTDI_SIO_DISABLE_FLOW_CTRL;
2786         }
2787
2788         index |= priv->interface;
2789
2790         ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2791                         FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2792                         FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2793                         value, index, NULL, 0, WDR_TIMEOUT);
2794         if (ret < 0)
2795                 dev_err(&port->dev, "failed to set flow control: %d\n", ret);
2796 }
2797
2798 /*
2799  * Get modem-control status.
2800  *
2801  * Returns the number of status bytes retrieved (device dependant), or
2802  * negative error code.
2803  */
2804 static int ftdi_get_modem_status(struct usb_serial_port *port,
2805                                                 unsigned char status[2])
2806 {
2807         struct ftdi_private *priv = usb_get_serial_port_data(port);
2808         unsigned char *buf;
2809         int len;
2810         int ret;
2811
2812         buf = kmalloc(2, GFP_KERNEL);
2813         if (!buf)
2814                 return -ENOMEM;
2815         /*
2816          * The 8U232AM returns a two byte value (the SIO a 1 byte value) in
2817          * the same format as the data returned from the in point.
2818          */
2819         switch (priv->chip_type) {
2820         case SIO:
2821                 len = 1;
2822                 break;
2823         case FT8U232AM:
2824         case FT232BM:
2825         case FT2232C:
2826         case FT232RL:
2827         case FT2232H:
2828         case FT4232H:
2829         case FT232H:
2830         case FTX:
2831                 len = 2;
2832                 break;
2833         default:
2834                 ret = -EFAULT;
2835                 goto out;
2836         }
2837
2838         ret = usb_control_msg(port->serial->dev,
2839                         usb_rcvctrlpipe(port->serial->dev, 0),
2840                         FTDI_SIO_GET_MODEM_STATUS_REQUEST,
2841                         FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
2842                         0, priv->interface,
2843                         buf, len, WDR_TIMEOUT);
2844
2845         /* NOTE: We allow short responses and handle that below. */
2846         if (ret < 1) {
2847                 dev_err(&port->dev, "failed to get modem status: %d\n", ret);
2848                 if (ret >= 0)
2849                         ret = -EIO;
2850                 ret = usb_translate_errors(ret);
2851                 goto out;
2852         }
2853
2854         status[0] = buf[0];
2855         if (ret > 1)
2856                 status[1] = buf[1];
2857         else
2858                 status[1] = 0;
2859
2860         dev_dbg(&port->dev, "%s - 0x%02x%02x\n", __func__, status[0],
2861                                                                 status[1]);
2862 out:
2863         kfree(buf);
2864
2865         return ret;
2866 }
2867
2868 static int ftdi_tiocmget(struct tty_struct *tty)
2869 {
2870         struct usb_serial_port *port = tty->driver_data;
2871         struct ftdi_private *priv = usb_get_serial_port_data(port);
2872         unsigned char buf[2];
2873         int ret;
2874
2875         ret = ftdi_get_modem_status(port, buf);
2876         if (ret < 0)
2877                 return ret;
2878
2879         ret =   (buf[0] & FTDI_SIO_DSR_MASK  ? TIOCM_DSR : 0) |
2880                 (buf[0] & FTDI_SIO_CTS_MASK  ? TIOCM_CTS : 0) |
2881                 (buf[0] & FTDI_SIO_RI_MASK   ? TIOCM_RI  : 0) |
2882                 (buf[0] & FTDI_SIO_RLSD_MASK ? TIOCM_CD  : 0) |
2883                 priv->last_dtr_rts;
2884
2885         return ret;
2886 }
2887
2888 static int ftdi_tiocmset(struct tty_struct *tty,
2889                         unsigned int set, unsigned int clear)
2890 {
2891         struct usb_serial_port *port = tty->driver_data;
2892
2893         return update_mctrl(port, set, clear);
2894 }
2895
2896 static int ftdi_ioctl(struct tty_struct *tty,
2897                                         unsigned int cmd, unsigned long arg)
2898 {
2899         struct usb_serial_port *port = tty->driver_data;
2900         void __user *argp = (void __user *)arg;
2901
2902         switch (cmd) {
2903         case TIOCSERGETLSR:
2904                 return get_lsr_info(port, argp);
2905         default:
2906                 break;
2907         }
2908
2909         return -ENOIOCTLCMD;
2910 }
2911
2912 module_usb_serial_driver(serial_drivers, id_table_combined);
2913
2914 MODULE_AUTHOR(DRIVER_AUTHOR);
2915 MODULE_DESCRIPTION(DRIVER_DESC);
2916 MODULE_LICENSE("GPL");
2917
2918 module_param(ndi_latency_timer, int, S_IRUGO | S_IWUSR);
2919 MODULE_PARM_DESC(ndi_latency_timer, "NDI device latency timer override");