drivers/usb/serial/ftdi_sio.c

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