drivers/usb/serial/ftdi_sio.c

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