drivers/usb/serial/ftdi_sio.c

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