drivers/usb/serial/ftdi_sio.c

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