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

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