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         char *buf;
 939         unsigned urb_value;
 940         int rv;
 941
 942         if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
 943                 dbg("%s - DTR|RTS not being set|cleared", __func__);
 944                 return 0;       /* no change */
 945         }
 946
 947         buf = kmalloc(1, GFP_NOIO);
 948         if (!buf)
 949                 return -ENOMEM;
 950
 951         clear &= ~set;  /* 'set' takes precedence over 'clear' */
 952         urb_value = 0;
 953         if (clear & TIOCM_DTR)
 954                 urb_value |= FTDI_SIO_SET_DTR_LOW;
 955         if (clear & TIOCM_RTS)
 956                 urb_value |= FTDI_SIO_SET_RTS_LOW;
 957         if (set & TIOCM_DTR)
 958                 urb_value |= FTDI_SIO_SET_DTR_HIGH;
 959         if (set & TIOCM_RTS)
 960                 urb_value |= FTDI_SIO_SET_RTS_HIGH;
 961         rv = usb_control_msg(port->serial->dev,
 962                                usb_sndctrlpipe(port->serial->dev, 0),
 963                                FTDI_SIO_SET_MODEM_CTRL_REQUEST,
 964                                FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE,
 965                                urb_value, priv->interface,
 966                                buf, 0, WDR_TIMEOUT);
 967
 968         kfree(buf);
 969         if (rv < 0) {
 970                 dbg("%s Error from MODEM_CTRL urb: DTR %s, RTS %s",
 971                                 __func__,
 972                                 (set & TIOCM_DTR) ? "HIGH" :
 973                                 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
 974                                 (set & TIOCM_RTS) ? "HIGH" :
 975                                 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
 976         } else {
 977                 dbg("%s - DTR %s, RTS %s", __func__,
 978                                 (set & TIOCM_DTR) ? "HIGH" :
 979                                 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
 980                                 (set & TIOCM_RTS) ? "HIGH" :
 981                                 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
 982                 /* FIXME: locking on last_dtr_rts */
 983                 priv->last_dtr_rts = (priv->last_dtr_rts & ~clear) | set;
 984         }
 985         return rv;
 986 }
 987
 988
 989 static __u32 get_ftdi_divisor(struct tty_struct *tty,
 990                                                 struct usb_serial_port *port)
 991 { /* get_ftdi_divisor */
 992         struct ftdi_private *priv = usb_get_serial_port_data(port);
 993         __u32 div_value = 0;
 994         int div_okay = 1;
 995         int baud;
 996
 997         /*
 998          * The logic involved in setting the baudrate can be cleanly split into
 999          * 3 steps.
1000          * 1. Standard baud rates are set in tty->termios->c_cflag
1001          * 2. If these are not enough, you can set any speed using alt_speed as
1002          * follows:
1003          *    - set tty->termios->c_cflag speed to B38400
1004          *    - set your real speed in tty->alt_speed; it gets ignored when
1005          *      alt_speed==0, (or)
1006          *    - call TIOCSSERIAL ioctl with (struct serial_struct) set as
1007          *      follows:
1008          *      flags & ASYNC_SPD_MASK == ASYNC_SPD_[HI, VHI, SHI, WARP],
1009          *      this just sets alt_speed to (HI: 57600, VHI: 115200,
1010          *      SHI: 230400, WARP: 460800)
1011          * ** Steps 1, 2 are done courtesy of tty_get_baud_rate
1012          * 3. You can also set baud rate by setting custom divisor as follows
1013          *    - set tty->termios->c_cflag speed to B38400
1014          *    - call TIOCSSERIAL ioctl with (struct serial_struct) set as
1015          *      follows:
1016          *      o flags & ASYNC_SPD_MASK == ASYNC_SPD_CUST
1017          *      o custom_divisor set to baud_base / your_new_baudrate
1018          * ** Step 3 is done courtesy of code borrowed from serial.c
1019          *    I should really spend some time and separate + move this common
1020          *    code to serial.c, it is replicated in nearly every serial driver
1021          *    you see.
1022          */
1023
1024         /* 1. Get the baud rate from the tty settings, this observes
1025               alt_speed hack */
1026
1027         baud = tty_get_baud_rate(tty);
1028         dbg("%s - tty_get_baud_rate reports speed %d", __func__, baud);
1029
1030         /* 2. Observe async-compatible custom_divisor hack, update baudrate
1031            if needed */
1032
1033         if (baud == 38400 &&
1034             ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
1035              (priv->custom_divisor)) {
1036                 baud = priv->baud_base / priv->custom_divisor;
1037                 dbg("%s - custom divisor %d sets baud rate to %d",
1038                                 __func__, priv->custom_divisor, baud);
1039         }
1040
1041         /* 3. Convert baudrate to device-specific divisor */
1042
1043         if (!baud)
1044                 baud = 9600;
1045         switch (priv->chip_type) {
1046         case SIO: /* SIO chip */
1047                 switch (baud) {
1048                 case 300: div_value = ftdi_sio_b300; break;
1049                 case 600: div_value = ftdi_sio_b600; break;
1050                 case 1200: div_value = ftdi_sio_b1200; break;
1051                 case 2400: div_value = ftdi_sio_b2400; break;
1052                 case 4800: div_value = ftdi_sio_b4800; break;
1053                 case 9600: div_value = ftdi_sio_b9600; break;
1054                 case 19200: div_value = ftdi_sio_b19200; break;
1055                 case 38400: div_value = ftdi_sio_b38400; break;
1056                 case 57600: div_value = ftdi_sio_b57600;  break;
1057                 case 115200: div_value = ftdi_sio_b115200; break;
1058                 } /* baud */
1059                 if (div_value == 0) {
1060                         dbg("%s - Baudrate (%d) requested is not supported",
1061                                                         __func__,  baud);
1062                         div_value = ftdi_sio_b9600;
1063                         baud = 9600;
1064                         div_okay = 0;
1065                 }
1066                 break;
1067         case FT8U232AM: /* 8U232AM chip */
1068                 if (baud <= 3000000) {
1069                         div_value = ftdi_232am_baud_to_divisor(baud);
1070                 } else {
1071                         dbg("%s - Baud rate too high!", __func__);
1072                         baud = 9600;
1073                         div_value = ftdi_232am_baud_to_divisor(9600);
1074                         div_okay = 0;
1075                 }
1076                 break;
1077         case FT232BM: /* FT232BM chip */
1078         case FT2232C: /* FT2232C chip */
1079         case FT232RL:
1080                 if (baud <= 3000000) {
1081                         __u16 product_id = le16_to_cpu(
1082                                 port->serial->dev->descriptor.idProduct);
1083                         if (((FTDI_NDI_HUC_PID == product_id) ||
1084                              (FTDI_NDI_SPECTRA_SCU_PID == product_id) ||
1085                              (FTDI_NDI_FUTURE_2_PID == product_id) ||
1086                              (FTDI_NDI_FUTURE_3_PID == product_id) ||
1087                              (FTDI_NDI_AURORA_SCU_PID == product_id)) &&
1088                             (baud == 19200)) {
1089                                 baud = 1200000;
1090                         }
1091                         div_value = ftdi_232bm_baud_to_divisor(baud);
1092                 } else {
1093                         dbg("%s - Baud rate too high!", __func__);
1094                         div_value = ftdi_232bm_baud_to_divisor(9600);
1095                         div_okay = 0;
1096                         baud = 9600;
1097                 }
1098                 break;
1099         case FT2232H: /* FT2232H chip */
1100         case FT4232H: /* FT4232H chip */
1101                 if ((baud <= 12000000) & (baud >= 1200)) {
1102                         div_value = ftdi_2232h_baud_to_divisor(baud);
1103                 } else if (baud < 1200) {
1104                         div_value = ftdi_232bm_baud_to_divisor(baud);
1105                 } else {
1106                         dbg("%s - Baud rate too high!", __func__);
1107                         div_value = ftdi_232bm_baud_to_divisor(9600);
1108                         div_okay = 0;
1109                         baud = 9600;
1110                 }
1111                 break;
1112         } /* priv->chip_type */
1113
1114         if (div_okay) {
1115                 dbg("%s - Baud rate set to %d (divisor 0x%lX) on chip %s",
1116                         __func__, baud, (unsigned long)div_value,
1117                         ftdi_chip_name[priv->chip_type]);
1118         }
1119
1120         tty_encode_baud_rate(tty, baud, baud);
1121         return div_value;
1122 }
1123
1124 static int change_speed(struct tty_struct *tty, struct usb_serial_port *port)
1125 {
1126         struct ftdi_private *priv = usb_get_serial_port_data(port);
1127         char *buf;
1128         __u16 urb_value;
1129         __u16 urb_index;
1130         __u32 urb_index_value;
1131         int rv;
1132
1133         buf = kmalloc(1, GFP_NOIO);
1134         if (!buf)
1135                 return -ENOMEM;
1136
1137         urb_index_value = get_ftdi_divisor(tty, port);
1138         urb_value = (__u16)urb_index_value;
1139         urb_index = (__u16)(urb_index_value >> 16);
1140         if (priv->interface) {  /* FT2232C */
1141                 urb_index = (__u16)((urb_index << 8) | priv->interface);
1142         }
1143
1144         rv = usb_control_msg(port->serial->dev,
1145                             usb_sndctrlpipe(port->serial->dev, 0),
1146                             FTDI_SIO_SET_BAUDRATE_REQUEST,
1147                             FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE,
1148                             urb_value, urb_index,
1149                             buf, 0, WDR_SHORT_TIMEOUT);
1150
1151         kfree(buf);
1152         return rv;
1153 }
1154
1155 static int write_latency_timer(struct usb_serial_port *port)
1156 {
1157         struct ftdi_private *priv = usb_get_serial_port_data(port);
1158         struct usb_device *udev = port->serial->dev;
1159         char buf[1];
1160         int rv = 0;
1161         int l = priv->latency;
1162
1163         if (priv->flags & ASYNC_LOW_LATENCY)
1164                 l = 1;
1165
1166         dbg("%s: setting latency timer = %i", __func__, l);
1167
1168         rv = usb_control_msg(udev,
1169                              usb_sndctrlpipe(udev, 0),
1170                              FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
1171                              FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
1172                              l, priv->interface,
1173                              buf, 0, WDR_TIMEOUT);
1174
1175         if (rv < 0)
1176                 dev_err(&port->dev, "Unable to write latency timer: %i\n", rv);
1177         return rv;
1178 }
1179
1180 static int read_latency_timer(struct usb_serial_port *port)
1181 {
1182         struct ftdi_private *priv = usb_get_serial_port_data(port);
1183         struct usb_device *udev = port->serial->dev;
1184         unsigned short latency = 0;
1185         int rv = 0;
1186
1187
1188         dbg("%s", __func__);
1189
1190         rv = usb_control_msg(udev,
1191                              usb_rcvctrlpipe(udev, 0),
1192                              FTDI_SIO_GET_LATENCY_TIMER_REQUEST,
1193                              FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE,
1194                              0, priv->interface,
1195                              (char *) &latency, 1, WDR_TIMEOUT);
1196
1197         if (rv < 0) {
1198                 dev_err(&port->dev, "Unable to read latency timer: %i\n", rv);
1199                 return -EIO;
1200         }
1201         return latency;
1202 }
1203
1204 static int get_serial_info(struct usb_serial_port *port,
1205                                 struct serial_struct __user *retinfo)
1206 {
1207         struct ftdi_private *priv = usb_get_serial_port_data(port);
1208         struct serial_struct tmp;
1209
1210         if (!retinfo)
1211                 return -EFAULT;
1212         memset(&tmp, 0, sizeof(tmp));
1213         tmp.flags = priv->flags;
1214         tmp.baud_base = priv->baud_base;
1215         tmp.custom_divisor = priv->custom_divisor;
1216         if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
1217                 return -EFAULT;
1218         return 0;
1219 } /* get_serial_info */
1220
1221
1222 static int set_serial_info(struct tty_struct *tty,
1223         struct usb_serial_port *port, struct serial_struct __user *newinfo)
1224 { /* set_serial_info */
1225         struct ftdi_private *priv = usb_get_serial_port_data(port);
1226         struct serial_struct new_serial;
1227         struct ftdi_private old_priv;
1228
1229         if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
1230                 return -EFAULT;
1231
1232         lock_kernel();
1233         old_priv = *priv;
1234
1235         /* Do error checking and permission checking */
1236
1237         if (!capable(CAP_SYS_ADMIN)) {
1238                 if (((new_serial.flags & ~ASYNC_USR_MASK) !=
1239                      (priv->flags & ~ASYNC_USR_MASK))) {
1240                         unlock_kernel();
1241                         return -EPERM;
1242                 }
1243                 priv->flags = ((priv->flags & ~ASYNC_USR_MASK) |
1244                                (new_serial.flags & ASYNC_USR_MASK));
1245                 priv->custom_divisor = new_serial.custom_divisor;
1246                 goto check_and_exit;
1247         }
1248
1249         if ((new_serial.baud_base != priv->baud_base) &&
1250             (new_serial.baud_base < 9600)) {
1251                 unlock_kernel();
1252                 return -EINVAL;
1253         }
1254
1255         /* Make the changes - these are privileged changes! */
1256
1257         priv->flags = ((priv->flags & ~ASYNC_FLAGS) |
1258                                         (new_serial.flags & ASYNC_FLAGS));
1259         priv->custom_divisor = new_serial.custom_divisor;
1260
1261         write_latency_timer(port);
1262
1263 check_and_exit:
1264         if ((old_priv.flags & ASYNC_SPD_MASK) !=
1265              (priv->flags & ASYNC_SPD_MASK)) {
1266                 if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_HI)
1267                         tty->alt_speed = 57600;
1268                 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_VHI)
1269                         tty->alt_speed = 115200;
1270                 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_SHI)
1271                         tty->alt_speed = 230400;
1272                 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_WARP)
1273                         tty->alt_speed = 460800;
1274                 else
1275                         tty->alt_speed = 0;
1276         }
1277         if (((old_priv.flags & ASYNC_SPD_MASK) !=
1278              (priv->flags & ASYNC_SPD_MASK)) ||
1279             (((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
1280              (old_priv.custom_divisor != priv->custom_divisor))) {
1281                 unlock_kernel();
1282                 change_speed(tty, port);
1283         }
1284         else
1285                 unlock_kernel();
1286         return 0;
1287
1288 } /* set_serial_info */
1289
1290
1291 /* Determine type of FTDI chip based on USB config and descriptor. */
1292 static void ftdi_determine_type(struct usb_serial_port *port)
1293 {
1294         struct ftdi_private *priv = usb_get_serial_port_data(port);
1295         struct usb_serial *serial = port->serial;
1296         struct usb_device *udev = serial->dev;
1297         unsigned version;
1298         unsigned interfaces;
1299
1300         /* Assume it is not the original SIO device for now. */
1301         priv->baud_base = 48000000 / 2;
1302         priv->write_offset = 0;
1303
1304         version = le16_to_cpu(udev->descriptor.bcdDevice);
1305         interfaces = udev->actconfig->desc.bNumInterfaces;
1306         dbg("%s: bcdDevice = 0x%x, bNumInterfaces = %u", __func__,
1307                         version, interfaces);
1308         if (interfaces > 1) {
1309                 int inter;
1310
1311                 /* Multiple interfaces.*/
1312                 if (version == 0x0800) {
1313                         priv->chip_type = FT4232H;
1314                         /* Hi-speed - baud clock runs at 120MHz */
1315                         priv->baud_base = 120000000 / 2;
1316                 } else if (version == 0x0700) {
1317                         priv->chip_type = FT2232H;
1318                         /* Hi-speed - baud clock runs at 120MHz */
1319                         priv->baud_base = 120000000 / 2;
1320                 } else
1321                         priv->chip_type = FT2232C;
1322
1323                 /* Determine interface code. */
1324                 inter = serial->interface->altsetting->desc.bInterfaceNumber;
1325                 if (inter == 0) {
1326                         priv->interface = INTERFACE_A;
1327                 } else  if (inter == 1) {
1328                         priv->interface = INTERFACE_B;
1329                 } else  if (inter == 2) {
1330                         priv->interface = INTERFACE_C;
1331                 } else  if (inter == 3) {
1332                         priv->interface = INTERFACE_D;
1333                 }
1334                 /* BM-type devices have a bug where bcdDevice gets set
1335                  * to 0x200 when iSerialNumber is 0.  */
1336                 if (version < 0x500) {
1337                         dbg("%s: something fishy - bcdDevice too low for multi-interface device",
1338                                         __func__);
1339                 }
1340         } else if (version < 0x200) {
1341                 /* Old device.  Assume its the original SIO. */
1342                 priv->chip_type = SIO;
1343                 priv->baud_base = 12000000 / 16;
1344                 priv->write_offset = 1;
1345         } else if (version < 0x400) {
1346                 /* Assume its an FT8U232AM (or FT8U245AM) */
1347                 /* (It might be a BM because of the iSerialNumber bug,
1348                  * but it will still work as an AM device.) */
1349                 priv->chip_type = FT8U232AM;
1350         } else if (version < 0x600) {
1351                 /* Assume its an FT232BM (or FT245BM) */
1352                 priv->chip_type = FT232BM;
1353         } else {
1354                 /* Assume its an FT232R  */
1355                 priv->chip_type = FT232RL;
1356         }
1357         dev_info(&udev->dev, "Detected %s\n", ftdi_chip_name[priv->chip_type]);
1358 }
1359
1360
1361 /* Determine the maximum packet size for the device.  This depends on the chip
1362  * type and the USB host capabilities.  The value should be obtained from the
1363  * device descriptor as the chip will use the appropriate values for the host.*/
1364 static void ftdi_set_max_packet_size(struct usb_serial_port *port)
1365 {
1366         struct ftdi_private *priv = usb_get_serial_port_data(port);
1367         struct usb_serial *serial = port->serial;
1368         struct usb_device *udev = serial->dev;
1369
1370         struct usb_interface *interface = serial->interface;
1371         struct usb_endpoint_descriptor *ep_desc = &interface->cur_altsetting->endpoint[1].desc;
1372
1373         unsigned num_endpoints;
1374         int i = 0;
1375
1376         num_endpoints = interface->cur_altsetting->desc.bNumEndpoints;
1377         dev_info(&udev->dev, "Number of endpoints %d\n", num_endpoints);
1378
1379         /* NOTE: some customers have programmed FT232R/FT245R devices
1380          * with an endpoint size of 0 - not good.  In this case, we
1381          * want to override the endpoint descriptor setting and use a
1382          * value of 64 for wMaxPacketSize */
1383         for (i = 0; i < num_endpoints; i++) {
1384                 dev_info(&udev->dev, "Endpoint %d MaxPacketSize %d\n", i+1,
1385                         interface->cur_altsetting->endpoint[i].desc.wMaxPacketSize);
1386                 ep_desc = &interface->cur_altsetting->endpoint[i].desc;
1387                 if (ep_desc->wMaxPacketSize == 0) {
1388                         ep_desc->wMaxPacketSize = cpu_to_le16(0x40);
1389                         dev_info(&udev->dev, "Overriding wMaxPacketSize on endpoint %d\n", i);
1390                 }
1391         }
1392
1393         /* set max packet size based on descriptor */
1394         priv->max_packet_size = ep_desc->wMaxPacketSize;
1395
1396         dev_info(&udev->dev, "Setting MaxPacketSize %d\n", priv->max_packet_size);
1397 }
1398
1399
1400 /*
1401  * ***************************************************************************
1402  * Sysfs Attribute
1403  * ***************************************************************************
1404  */
1405
1406 static ssize_t show_latency_timer(struct device *dev,
1407                                 struct device_attribute *attr, char *buf)
1408 {
1409         struct usb_serial_port *port = to_usb_serial_port(dev);
1410         struct ftdi_private *priv = usb_get_serial_port_data(port);
1411         if (priv->flags & ASYNC_LOW_LATENCY)
1412                 return sprintf(buf, "1\n");
1413         else
1414                 return sprintf(buf, "%i\n", priv->latency);
1415 }
1416
1417
1418 /* Write a new value of the latency timer, in units of milliseconds. */
1419 static ssize_t store_latency_timer(struct device *dev,
1420                         struct device_attribute *attr, const char *valbuf,
1421                         size_t count)
1422 {
1423         struct usb_serial_port *port = to_usb_serial_port(dev);
1424         struct ftdi_private *priv = usb_get_serial_port_data(port);
1425         int v = simple_strtoul(valbuf, NULL, 10);
1426         int rv = 0;
1427
1428         priv->latency = v;
1429         rv = write_latency_timer(port);
1430         if (rv < 0)
1431                 return -EIO;
1432         return count;
1433 }
1434
1435 /* Write an event character directly to the FTDI register.  The ASCII
1436    value is in the low 8 bits, with the enable bit in the 9th bit. */
1437 static ssize_t store_event_char(struct device *dev,
1438         struct device_attribute *attr, const char *valbuf, size_t count)
1439 {
1440         struct usb_serial_port *port = to_usb_serial_port(dev);
1441         struct ftdi_private *priv = usb_get_serial_port_data(port);
1442         struct usb_device *udev = port->serial->dev;
1443         char buf[1];
1444         int v = simple_strtoul(valbuf, NULL, 10);
1445         int rv = 0;
1446
1447         dbg("%s: setting event char = %i", __func__, v);
1448
1449         rv = usb_control_msg(udev,
1450                              usb_sndctrlpipe(udev, 0),
1451                              FTDI_SIO_SET_EVENT_CHAR_REQUEST,
1452                              FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE,
1453                              v, priv->interface,
1454                              buf, 0, WDR_TIMEOUT);
1455
1456         if (rv < 0) {
1457                 dbg("Unable to write event character: %i", rv);
1458                 return -EIO;
1459         }
1460
1461         return count;
1462 }
1463
1464 static DEVICE_ATTR(latency_timer, S_IWUSR | S_IRUGO, show_latency_timer,
1465                                                         store_latency_timer);
1466 static DEVICE_ATTR(event_char, S_IWUSR, NULL, store_event_char);
1467
1468 static int create_sysfs_attrs(struct usb_serial_port *port)
1469 {
1470         struct ftdi_private *priv = usb_get_serial_port_data(port);
1471         int retval = 0;
1472
1473         dbg("%s", __func__);
1474
1475         /* XXX I've no idea if the original SIO supports the event_char
1476          * sysfs parameter, so I'm playing it safe.  */
1477         if (priv->chip_type != SIO) {
1478                 dbg("sysfs attributes for %s", ftdi_chip_name[priv->chip_type]);
1479                 retval = device_create_file(&port->dev, &dev_attr_event_char);
1480                 if ((!retval) &&
1481                     (priv->chip_type == FT232BM ||
1482                      priv->chip_type == FT2232C ||
1483                      priv->chip_type == FT232RL ||
1484                      priv->chip_type == FT2232H ||
1485                      priv->chip_type == FT4232H)) {
1486                         retval = device_create_file(&port->dev,
1487                                                     &dev_attr_latency_timer);
1488                 }
1489         }
1490         return retval;
1491 }
1492
1493 static void remove_sysfs_attrs(struct usb_serial_port *port)
1494 {
1495         struct ftdi_private *priv = usb_get_serial_port_data(port);
1496
1497         dbg("%s", __func__);
1498
1499         /* XXX see create_sysfs_attrs */
1500         if (priv->chip_type != SIO) {
1501                 device_remove_file(&port->dev, &dev_attr_event_char);
1502                 if (priv->chip_type == FT232BM ||
1503                     priv->chip_type == FT2232C ||
1504                     priv->chip_type == FT232RL ||
1505                     priv->chip_type == FT2232H ||
1506                     priv->chip_type == FT4232H) {
1507                         device_remove_file(&port->dev, &dev_attr_latency_timer);
1508                 }
1509         }
1510
1511 }
1512
1513 /*
1514  * ***************************************************************************
1515  * FTDI driver specific functions
1516  * ***************************************************************************
1517  */
1518
1519 /* Probe function to check for special devices */
1520 static int ftdi_sio_probe(struct usb_serial *serial,
1521                                         const struct usb_device_id *id)
1522 {
1523         struct ftdi_sio_quirk *quirk =
1524                                 (struct ftdi_sio_quirk *)id->driver_info;
1525
1526         if (quirk && quirk->probe) {
1527                 int ret = quirk->probe(serial);
1528                 if (ret != 0)
1529                         return ret;
1530         }
1531
1532         usb_set_serial_data(serial, (void *)id->driver_info);
1533
1534         return 0;
1535 }
1536
1537 static int ftdi_sio_port_probe(struct usb_serial_port *port)
1538 {
1539         struct ftdi_private *priv;
1540         struct ftdi_sio_quirk *quirk = usb_get_serial_data(port->serial);
1541
1542
1543         dbg("%s", __func__);
1544
1545         priv = kzalloc(sizeof(struct ftdi_private), GFP_KERNEL);
1546         if (!priv) {
1547                 dev_err(&port->dev, "%s- kmalloc(%Zd) failed.\n", __func__,
1548                                         sizeof(struct ftdi_private));
1549                 return -ENOMEM;
1550         }
1551
1552         kref_init(&priv->kref);
1553         spin_lock_init(&priv->tx_lock);
1554         init_waitqueue_head(&priv->delta_msr_wait);
1555         /* This will push the characters through immediately rather
1556            than queue a task to deliver them */
1557         priv->flags = ASYNC_LOW_LATENCY;
1558
1559         if (quirk && quirk->port_probe)
1560                 quirk->port_probe(priv);
1561
1562         /* Increase the size of read buffers */
1563         kfree(port->bulk_in_buffer);
1564         port->bulk_in_buffer = kmalloc(BUFSZ, GFP_KERNEL);
1565         if (!port->bulk_in_buffer) {
1566                 kfree(priv);
1567                 return -ENOMEM;
1568         }
1569         if (port->read_urb) {
1570                 port->read_urb->transfer_buffer = port->bulk_in_buffer;
1571                 port->read_urb->transfer_buffer_length = BUFSZ;
1572         }
1573
1574         priv->port = port;
1575
1576         /* Free port's existing write urb and transfer buffer. */
1577         if (port->write_urb) {
1578                 usb_free_urb(port->write_urb);
1579                 port->write_urb = NULL;
1580         }
1581         kfree(port->bulk_out_buffer);
1582         port->bulk_out_buffer = NULL;
1583
1584         usb_set_serial_port_data(port, priv);
1585
1586         ftdi_determine_type(port);
1587         ftdi_set_max_packet_size(port);
1588         read_latency_timer(port);
1589         create_sysfs_attrs(port);
1590         return 0;
1591 }
1592
1593 /* Setup for the USB-UIRT device, which requires hardwired
1594  * baudrate (38400 gets mapped to 312500) */
1595 /* Called from usbserial:serial_probe */
1596 static void ftdi_USB_UIRT_setup(struct ftdi_private *priv)
1597 {
1598         dbg("%s", __func__);
1599
1600         priv->flags |= ASYNC_SPD_CUST;
1601         priv->custom_divisor = 77;
1602         priv->force_baud = 38400;
1603 } /* ftdi_USB_UIRT_setup */
1604
1605 /* Setup for the HE-TIRA1 device, which requires hardwired
1606  * baudrate (38400 gets mapped to 100000) and RTS-CTS enabled.  */
1607
1608 static void ftdi_HE_TIRA1_setup(struct ftdi_private *priv)
1609 {
1610         dbg("%s", __func__);
1611
1612         priv->flags |= ASYNC_SPD_CUST;
1613         priv->custom_divisor = 240;
1614         priv->force_baud = 38400;
1615         priv->force_rtscts = 1;
1616 } /* ftdi_HE_TIRA1_setup */
1617
1618 /*
1619  * Module parameter to control latency timer for NDI FTDI-based USB devices.
1620  * If this value is not set in modprobe.conf.local its value will be set to 1ms.
1621  */
1622 static int ndi_latency_timer = 1;
1623
1624 /* Setup for the NDI FTDI-based USB devices, which requires hardwired
1625  * baudrate (19200 gets mapped to 1200000).
1626  *
1627  * Called from usbserial:serial_probe.
1628  */
1629 static int ftdi_NDI_device_setup(struct usb_serial *serial)
1630 {
1631         struct usb_device *udev = serial->dev;
1632         int latency = ndi_latency_timer;
1633         int rv = 0;
1634         char buf[1];
1635
1636         if (latency == 0)
1637                 latency = 1;
1638         if (latency > 99)
1639                 latency = 99;
1640
1641         dbg("%s setting NDI device latency to %d", __func__, latency);
1642         dev_info(&udev->dev, "NDI device with a latency value of %d", latency);
1643
1644         rv = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1645                                 FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
1646                                 FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
1647                                 latency, 0, buf, 0, WDR_TIMEOUT);
1648         return 0;
1649 }
1650
1651 /*
1652  * First port on JTAG adaptors such as Olimex arm-usb-ocd or the FIC/OpenMoko
1653  * Neo1973 Debug Board is reserved for JTAG interface and can be accessed from
1654  * userspace using openocd.
1655  */
1656 static int ftdi_jtag_probe(struct usb_serial *serial)
1657 {
1658         struct usb_device *udev = serial->dev;
1659         struct usb_interface *interface = serial->interface;
1660
1661         dbg("%s", __func__);
1662
1663         if (interface == udev->actconfig->interface[0]) {
1664                 dev_info(&udev->dev,
1665                          "Ignoring serial port reserved for JTAG\n");
1666                 return -ENODEV;
1667         }
1668
1669         return 0;
1670 }
1671
1672 /*
1673  * The Matrix Orbital VK204-25-USB has an invalid IN endpoint.
1674  * We have to correct it if we want to read from it.
1675  */
1676 static int ftdi_mtxorb_hack_setup(struct usb_serial *serial)
1677 {
1678         struct usb_host_endpoint *ep = serial->dev->ep_in[1];
1679         struct usb_endpoint_descriptor *ep_desc = &ep->desc;
1680
1681         if (ep->enabled && ep_desc->wMaxPacketSize == 0) {
1682                 ep_desc->wMaxPacketSize = cpu_to_le16(0x40);
1683                 dev_info(&serial->dev->dev,
1684                          "Fixing invalid wMaxPacketSize on read pipe\n");
1685         }
1686
1687         return 0;
1688 }
1689
1690 static void ftdi_sio_priv_release(struct kref *k)
1691 {
1692         struct ftdi_private *priv = container_of(k, struct ftdi_private, kref);
1693
1694         kfree(priv);
1695 }
1696
1697 static int ftdi_sio_port_remove(struct usb_serial_port *port)
1698 {
1699         struct ftdi_private *priv = usb_get_serial_port_data(port);
1700
1701         dbg("%s", __func__);
1702
1703         remove_sysfs_attrs(port);
1704
1705         kref_put(&priv->kref, ftdi_sio_priv_release);
1706
1707         return 0;
1708 }
1709
1710 static int ftdi_submit_read_urb(struct usb_serial_port *port, gfp_t mem_flags)
1711 {
1712         struct urb *urb = port->read_urb;
1713         struct usb_serial *serial = port->serial;
1714         int result;
1715
1716         usb_fill_bulk_urb(urb, serial->dev,
1717                            usb_rcvbulkpipe(serial->dev,
1718                                         port->bulk_in_endpointAddress),
1719                            urb->transfer_buffer,
1720                            urb->transfer_buffer_length,
1721                            ftdi_read_bulk_callback, port);
1722         result = usb_submit_urb(urb, mem_flags);
1723         if (result)
1724                 dev_err(&port->dev,
1725                         "%s - failed submitting read urb, error %d\n",
1726                                                         __func__, result);
1727         return result;
1728 }
1729
1730 static int ftdi_open(struct tty_struct *tty, struct usb_serial_port *port)
1731 { /* ftdi_open */
1732         struct usb_device *dev = port->serial->dev;
1733         struct ftdi_private *priv = usb_get_serial_port_data(port);
1734         unsigned long flags;
1735
1736         int result = 0;
1737         char buf[1]; /* Needed for the usb_control_msg I think */
1738
1739         dbg("%s", __func__);
1740
1741         spin_lock_irqsave(&priv->tx_lock, flags);
1742         priv->tx_bytes = 0;
1743         spin_unlock_irqrestore(&priv->tx_lock, flags);
1744
1745         write_latency_timer(port);
1746
1747         /* No error checking for this (will get errors later anyway) */
1748         /* See ftdi_sio.h for description of what is reset */
1749         usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1750                         FTDI_SIO_RESET_REQUEST, FTDI_SIO_RESET_REQUEST_TYPE,
1751                         FTDI_SIO_RESET_SIO,
1752                         priv->interface, buf, 0, WDR_TIMEOUT);
1753
1754         /* Termios defaults are set by usb_serial_init. We don't change
1755            port->tty->termios - this would lose speed settings, etc.
1756            This is same behaviour as serial.c/rs_open() - Kuba */
1757
1758         /* ftdi_set_termios  will send usb control messages */
1759         if (tty)
1760                 ftdi_set_termios(tty, port, tty->termios);
1761
1762         /* Not throttled */
1763         spin_lock_irqsave(&port->lock, flags);
1764         port->throttled = 0;
1765         port->throttle_req = 0;
1766         spin_unlock_irqrestore(&port->lock, flags);
1767
1768         /* Start reading from the device */
1769         result = ftdi_submit_read_urb(port, GFP_KERNEL);
1770         if (!result)
1771                 kref_get(&priv->kref);
1772
1773         return result;
1774 } /* ftdi_open */
1775
1776
1777 static void ftdi_dtr_rts(struct usb_serial_port *port, int on)
1778 {
1779         struct ftdi_private *priv = usb_get_serial_port_data(port);
1780         char buf[1];
1781
1782         mutex_lock(&port->serial->disc_mutex);
1783         if (!port->serial->disconnected) {
1784                 /* Disable flow control */
1785                 if (!on && usb_control_msg(port->serial->dev,
1786                             usb_sndctrlpipe(port->serial->dev, 0),
1787                             FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1788                             FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1789                             0, priv->interface, buf, 0,
1790                             WDR_TIMEOUT) < 0) {
1791                             dev_err(&port->dev, "error from flowcontrol urb\n");
1792                 }
1793                 /* drop RTS and DTR */
1794                 if (on)
1795                         set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1796                 else
1797                         clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1798         }
1799         mutex_unlock(&port->serial->disc_mutex);
1800 }
1801
1802 /*
1803  * usbserial:__serial_close  only calls ftdi_close if the point is open
1804  *
1805  *   This only gets called when it is the last close
1806  *
1807  *
1808  */
1809
1810 static void ftdi_close(struct usb_serial_port *port)
1811 { /* ftdi_close */
1812         struct ftdi_private *priv = usb_get_serial_port_data(port);
1813
1814         dbg("%s", __func__);
1815
1816         /* shutdown our bulk read */
1817         usb_kill_urb(port->read_urb);
1818         kref_put(&priv->kref, ftdi_sio_priv_release);
1819 } /* ftdi_close */
1820
1821
1822
1823 /* The SIO requires the first byte to have:
1824  *  B0 1
1825  *  B1 0
1826  *  B2..7 length of message excluding byte 0
1827  *
1828  * The new devices do not require this byte
1829  */
1830 static int ftdi_write(struct tty_struct *tty, struct usb_serial_port *port,
1831                            const unsigned char *buf, int count)
1832 { /* ftdi_write */
1833         struct ftdi_private *priv = usb_get_serial_port_data(port);
1834         struct urb *urb;
1835         unsigned char *buffer;
1836         int data_offset ;       /* will be 1 for the SIO and 0 otherwise */
1837         int status;
1838         int transfer_size;
1839         unsigned long flags;
1840
1841         dbg("%s port %d, %d bytes", __func__, port->number, count);
1842
1843         if (count == 0) {
1844                 dbg("write request of 0 bytes");
1845                 return 0;
1846         }
1847         spin_lock_irqsave(&priv->tx_lock, flags);
1848         if (priv->tx_outstanding_urbs > URB_UPPER_LIMIT) {
1849                 spin_unlock_irqrestore(&priv->tx_lock, flags);
1850                 dbg("%s - write limit hit\n", __func__);
1851                 return 0;
1852         }
1853         priv->tx_outstanding_urbs++;
1854         spin_unlock_irqrestore(&priv->tx_lock, flags);
1855
1856         data_offset = priv->write_offset;
1857         dbg("data_offset set to %d", data_offset);
1858
1859         /* Determine total transfer size */
1860         transfer_size = count;
1861         if (data_offset > 0) {
1862                 /* Original sio needs control bytes too... */
1863                 transfer_size += (data_offset *
1864                                 ((count + (priv->max_packet_size - 1 - data_offset)) /
1865                                  (priv->max_packet_size - data_offset)));
1866         }
1867
1868         buffer = kmalloc(transfer_size, GFP_ATOMIC);
1869         if (!buffer) {
1870                 dev_err(&port->dev,
1871                         "%s ran out of kernel memory for urb ...\n", __func__);
1872                 count = -ENOMEM;
1873                 goto error_no_buffer;
1874         }
1875
1876         urb = usb_alloc_urb(0, GFP_ATOMIC);
1877         if (!urb) {
1878                 dev_err(&port->dev, "%s - no more free urbs\n", __func__);
1879                 count = -ENOMEM;
1880                 goto error_no_urb;
1881         }
1882
1883         /* Copy data */
1884         if (data_offset > 0) {
1885                 /* Original sio requires control byte at start of
1886                    each packet. */
1887                 int user_pktsz = priv->max_packet_size - data_offset;
1888                 int todo = count;
1889                 unsigned char *first_byte = buffer;
1890                 const unsigned char *current_position = buf;
1891
1892                 while (todo > 0) {
1893                         if (user_pktsz > todo)
1894                                 user_pktsz = todo;
1895                         /* Write the control byte at the front of the packet*/
1896                         *first_byte = 1 | ((user_pktsz) << 2);
1897                         /* Copy data for packet */
1898                         memcpy(first_byte + data_offset,
1899                                 current_position, user_pktsz);
1900                         first_byte += user_pktsz + data_offset;
1901                         current_position += user_pktsz;
1902                         todo -= user_pktsz;
1903                 }
1904         } else {
1905                 /* No control byte required. */
1906                 /* Copy in the data to send */
1907                 memcpy(buffer, buf, count);
1908         }
1909
1910         usb_serial_debug_data(debug, &port->dev, __func__,
1911                                                 transfer_size, buffer);
1912
1913         /* fill the buffer and send it */
1914         usb_fill_bulk_urb(urb, port->serial->dev,
1915                         usb_sndbulkpipe(port->serial->dev,
1916                                         port->bulk_out_endpointAddress),
1917                         buffer, transfer_size,
1918                         ftdi_write_bulk_callback, port);
1919
1920         status = usb_submit_urb(urb, GFP_ATOMIC);
1921         if (status) {
1922                 dev_err(&port->dev,
1923                         "%s - failed submitting write urb, error %d\n",
1924                         __func__, status);
1925                 count = status;
1926                 goto error;
1927         } else {
1928                 spin_lock_irqsave(&priv->tx_lock, flags);
1929                 priv->tx_outstanding_bytes += count;
1930                 priv->tx_bytes += count;
1931                 spin_unlock_irqrestore(&priv->tx_lock, flags);
1932         }
1933
1934         /* we are done with this urb, so let the host driver
1935          * really free it when it is finished with it */
1936         usb_free_urb(urb);
1937
1938         dbg("%s write returning: %d", __func__, count);
1939         return count;
1940 error:
1941         usb_free_urb(urb);
1942 error_no_urb:
1943         kfree(buffer);
1944 error_no_buffer:
1945         spin_lock_irqsave(&priv->tx_lock, flags);
1946         priv->tx_outstanding_urbs--;
1947         spin_unlock_irqrestore(&priv->tx_lock, flags);
1948         return count;
1949 } /* ftdi_write */
1950
1951
1952 /* This function may get called when the device is closed */
1953
1954 static void ftdi_write_bulk_callback(struct urb *urb)
1955 {
1956         unsigned long flags;
1957         struct usb_serial_port *port = urb->context;
1958         struct ftdi_private *priv;
1959         int data_offset;       /* will be 1 for the SIO and 0 otherwise */
1960         unsigned long countback;
1961         int status = urb->status;
1962
1963         /* free up the transfer buffer, as usb_free_urb() does not do this */
1964         kfree(urb->transfer_buffer);
1965
1966         dbg("%s - port %d", __func__, port->number);
1967
1968         priv = usb_get_serial_port_data(port);
1969         if (!priv) {
1970                 dbg("%s - bad port private data pointer - exiting", __func__);
1971                 return;
1972         }
1973         /* account for transferred data */
1974         countback = urb->transfer_buffer_length;
1975         data_offset = priv->write_offset;
1976         if (data_offset > 0) {
1977                 /* Subtract the control bytes */
1978                 countback -= (data_offset * DIV_ROUND_UP(countback, priv->max_packet_size));
1979         }
1980         spin_lock_irqsave(&priv->tx_lock, flags);
1981         --priv->tx_outstanding_urbs;
1982         priv->tx_outstanding_bytes -= countback;
1983         spin_unlock_irqrestore(&priv->tx_lock, flags);
1984
1985         if (status) {
1986                 dbg("nonzero write bulk status received: %d", status);
1987         }
1988
1989         usb_serial_port_softint(port);
1990 } /* ftdi_write_bulk_callback */
1991
1992
1993 static int ftdi_write_room(struct tty_struct *tty)
1994 {
1995         struct usb_serial_port *port = tty->driver_data;
1996         struct ftdi_private *priv = usb_get_serial_port_data(port);
1997         int room;
1998         unsigned long flags;
1999
2000         dbg("%s - port %d", __func__, port->number);
2001
2002         spin_lock_irqsave(&priv->tx_lock, flags);
2003         if (priv->tx_outstanding_urbs < URB_UPPER_LIMIT) {
2004                 /*
2005                  * We really can take anything the user throws at us
2006                  * but let's pick a nice big number to tell the tty
2007                  * layer that we have lots of free space
2008                  */
2009                 room = 2048;
2010         } else {
2011                 room = 0;
2012         }
2013         spin_unlock_irqrestore(&priv->tx_lock, flags);
2014         return room;
2015 }
2016
2017 static int ftdi_chars_in_buffer(struct tty_struct *tty)
2018 {
2019         struct usb_serial_port *port = tty->driver_data;
2020         struct ftdi_private *priv = usb_get_serial_port_data(port);
2021         int buffered;
2022         unsigned long flags;
2023
2024         dbg("%s - port %d", __func__, port->number);
2025
2026         spin_lock_irqsave(&priv->tx_lock, flags);
2027         buffered = (int)priv->tx_outstanding_bytes;
2028         spin_unlock_irqrestore(&priv->tx_lock, flags);
2029         if (buffered < 0) {
2030                 dev_err(&port->dev, "%s outstanding tx bytes is negative!\n",
2031                         __func__);
2032                 buffered = 0;
2033         }
2034         return buffered;
2035 }
2036
2037 static int ftdi_process_packet(struct tty_struct *tty,
2038                 struct usb_serial_port *port, struct ftdi_private *priv,
2039                 char *packet, int len)
2040 {
2041         int i;
2042         char status;
2043         char flag;
2044         char *ch;
2045
2046         dbg("%s - port %d", __func__, port->number);
2047
2048         if (len < 2) {
2049                 dbg("malformed packet");
2050                 return 0;
2051         }
2052
2053         /* Compare new line status to the old one, signal if different/
2054            N.B. packet may be processed more than once, but differences
2055            are only processed once.  */
2056         status = packet[0] & FTDI_STATUS_B0_MASK;
2057         if (status != priv->prev_status) {
2058                 priv->diff_status |= status ^ priv->prev_status;
2059                 wake_up_interruptible(&priv->delta_msr_wait);
2060                 priv->prev_status = status;
2061         }
2062
2063         /*
2064          * Although the device uses a bitmask and hence can have multiple
2065          * errors on a packet - the order here sets the priority the error is
2066          * returned to the tty layer.
2067          */
2068         flag = TTY_NORMAL;
2069         if (packet[1] & FTDI_RS_OE) {
2070                 flag = TTY_OVERRUN;
2071                 dbg("OVERRRUN error");
2072         }
2073         if (packet[1] & FTDI_RS_BI) {
2074                 flag = TTY_BREAK;
2075                 dbg("BREAK received");
2076                 usb_serial_handle_break(port);
2077         }
2078         if (packet[1] & FTDI_RS_PE) {
2079                 flag = TTY_PARITY;
2080                 dbg("PARITY error");
2081         }
2082         if (packet[1] & FTDI_RS_FE) {
2083                 flag = TTY_FRAME;
2084                 dbg("FRAMING error");
2085         }
2086
2087         len -= 2;
2088         if (!len)
2089                 return 0;       /* status only */
2090         ch = packet + 2;
2091
2092         if (!(port->console && port->sysrq) && flag == TTY_NORMAL)
2093                 tty_insert_flip_string(tty, ch, len);
2094         else {
2095                 for (i = 0; i < len; i++, ch++) {
2096                         if (!usb_serial_handle_sysrq_char(tty, port, *ch))
2097                                 tty_insert_flip_char(tty, *ch, flag);
2098                 }
2099         }
2100         return len;
2101 }
2102
2103 static void ftdi_process_read(struct usb_serial_port *port)
2104 {
2105         struct urb *urb = port->read_urb;
2106         struct tty_struct *tty;
2107         struct ftdi_private *priv = usb_get_serial_port_data(port);
2108         char *data = (char *)urb->transfer_buffer;
2109         int i;
2110         int len;
2111         int count = 0;
2112
2113         tty = tty_port_tty_get(&port->port);
2114         if (!tty)
2115                 return;
2116
2117         for (i = 0; i < urb->actual_length; i += priv->max_packet_size) {
2118                 len = min_t(int, urb->actual_length - i, priv->max_packet_size);
2119                 count += ftdi_process_packet(tty, port, priv, &data[i], len);
2120         }
2121
2122         if (count)
2123                 tty_flip_buffer_push(tty);
2124         tty_kref_put(tty);
2125 }
2126
2127 static void ftdi_read_bulk_callback(struct urb *urb)
2128 {
2129         struct usb_serial_port *port = urb->context;
2130         unsigned long flags;
2131
2132         dbg("%s - port %d", __func__, port->number);
2133
2134         if (urb->status) {
2135                 dbg("%s - nonzero read bulk status received: %d",
2136                                                 __func__, urb->status);
2137                 return;
2138         }
2139
2140         usb_serial_debug_data(debug, &port->dev, __func__,
2141                                 urb->actual_length, urb->transfer_buffer);
2142         ftdi_process_read(port);
2143
2144         spin_lock_irqsave(&port->lock, flags);
2145         port->throttled = port->throttle_req;
2146         if (!port->throttled) {
2147                 spin_unlock_irqrestore(&port->lock, flags);
2148                 ftdi_submit_read_urb(port, GFP_ATOMIC);
2149         } else
2150                 spin_unlock_irqrestore(&port->lock, flags);
2151 }
2152
2153 static void ftdi_break_ctl(struct tty_struct *tty, int break_state)
2154 {
2155         struct usb_serial_port *port = tty->driver_data;
2156         struct ftdi_private *priv = usb_get_serial_port_data(port);
2157         __u16 urb_value = 0;
2158         char buf[1];
2159
2160         /* break_state = -1 to turn on break, and 0 to turn off break */
2161         /* see drivers/char/tty_io.c to see it used */
2162         /* last_set_data_urb_value NEVER has the break bit set in it */
2163
2164         if (break_state)
2165                 urb_value = priv->last_set_data_urb_value | FTDI_SIO_SET_BREAK;
2166         else
2167                 urb_value = priv->last_set_data_urb_value;
2168
2169         if (usb_control_msg(port->serial->dev,
2170                         usb_sndctrlpipe(port->serial->dev, 0),
2171                         FTDI_SIO_SET_DATA_REQUEST,
2172                         FTDI_SIO_SET_DATA_REQUEST_TYPE,
2173                         urb_value , priv->interface,
2174                         buf, 0, WDR_TIMEOUT) < 0) {
2175                 dev_err(&port->dev, "%s FAILED to enable/disable break state "
2176                         "(state was %d)\n", __func__, break_state);
2177         }
2178
2179         dbg("%s break state is %d - urb is %d", __func__,
2180                                                 break_state, urb_value);
2181
2182 }
2183
2184
2185 /* old_termios contains the original termios settings and tty->termios contains
2186  * the new setting to be used
2187  * WARNING: set_termios calls this with old_termios in kernel space
2188  */
2189
2190 static void ftdi_set_termios(struct tty_struct *tty,
2191                 struct usb_serial_port *port, struct ktermios *old_termios)
2192 { /* ftdi_termios */
2193         struct usb_device *dev = port->serial->dev;
2194         struct ftdi_private *priv = usb_get_serial_port_data(port);
2195         struct ktermios *termios = tty->termios;
2196         unsigned int cflag = termios->c_cflag;
2197         __u16 urb_value; /* will hold the new flags */
2198         char buf[1]; /* Perhaps I should dynamically alloc this? */
2199
2200         /* Added for xon/xoff support */
2201         unsigned int iflag = termios->c_iflag;
2202         unsigned char vstop;
2203         unsigned char vstart;
2204
2205         dbg("%s", __func__);
2206
2207         /* Force baud rate if this device requires it, unless it is set to
2208            B0. */
2209         if (priv->force_baud && ((termios->c_cflag & CBAUD) != B0)) {
2210                 dbg("%s: forcing baud rate for this device", __func__);
2211                 tty_encode_baud_rate(tty, priv->force_baud,
2212                                         priv->force_baud);
2213         }
2214
2215         /* Force RTS-CTS if this device requires it. */
2216         if (priv->force_rtscts) {
2217                 dbg("%s: forcing rtscts for this device", __func__);
2218                 termios->c_cflag |= CRTSCTS;
2219         }
2220
2221         cflag = termios->c_cflag;
2222
2223         /* FIXME -For this cut I don't care if the line is really changing or
2224            not  - so just do the change regardless  - should be able to
2225            compare old_termios and tty->termios */
2226         /* NOTE These routines can get interrupted by
2227            ftdi_sio_read_bulk_callback  - need to examine what this means -
2228            don't see any problems yet */
2229
2230         /* Set number of data bits, parity, stop bits */
2231
2232         urb_value = 0;
2233         urb_value |= (cflag & CSTOPB ? FTDI_SIO_SET_DATA_STOP_BITS_2 :
2234                       FTDI_SIO_SET_DATA_STOP_BITS_1);
2235         if (cflag & PARENB) {
2236                 if (cflag & CMSPAR)
2237                         urb_value |= cflag & PARODD ?
2238                                      FTDI_SIO_SET_DATA_PARITY_MARK :
2239                                      FTDI_SIO_SET_DATA_PARITY_SPACE;
2240                 else
2241                         urb_value |= cflag & PARODD ?
2242                                      FTDI_SIO_SET_DATA_PARITY_ODD :
2243                                      FTDI_SIO_SET_DATA_PARITY_EVEN;
2244         } else {
2245                 urb_value |= FTDI_SIO_SET_DATA_PARITY_NONE;
2246         }
2247         if (cflag & CSIZE) {
2248                 switch (cflag & CSIZE) {
2249                 case CS5: urb_value |= 5; dbg("Setting CS5"); break;
2250                 case CS6: urb_value |= 6; dbg("Setting CS6"); break;
2251                 case CS7: urb_value |= 7; dbg("Setting CS7"); break;
2252                 case CS8: urb_value |= 8; dbg("Setting CS8"); break;
2253                 default:
2254                         dev_err(&port->dev, "CSIZE was set but not CS5-CS8\n");
2255                 }
2256         }
2257
2258         /* This is needed by the break command since it uses the same command
2259            - but is or'ed with this value  */
2260         priv->last_set_data_urb_value = urb_value;
2261
2262         if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2263                             FTDI_SIO_SET_DATA_REQUEST,
2264                             FTDI_SIO_SET_DATA_REQUEST_TYPE,
2265                             urb_value , priv->interface,
2266                             buf, 0, WDR_SHORT_TIMEOUT) < 0) {
2267                 dev_err(&port->dev, "%s FAILED to set "
2268                         "databits/stopbits/parity\n", __func__);
2269         }
2270
2271         /* Now do the baudrate */
2272         if ((cflag & CBAUD) == B0) {
2273                 /* Disable flow control */
2274                 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2275                                     FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2276                                     FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2277                                     0, priv->interface,
2278                                     buf, 0, WDR_TIMEOUT) < 0) {
2279                         dev_err(&port->dev,
2280                                 "%s error from disable flowcontrol urb\n",
2281                                 __func__);
2282                 }
2283                 /* Drop RTS and DTR */
2284                 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2285         } else {
2286                 /* set the baudrate determined before */
2287                 if (change_speed(tty, port))
2288                         dev_err(&port->dev, "%s urb failed to set baudrate\n",
2289                                 __func__);
2290                 /* Ensure RTS and DTR are raised when baudrate changed from 0 */
2291                 if (!old_termios || (old_termios->c_cflag & CBAUD) == B0)
2292                         set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2293         }
2294
2295         /* Set flow control */
2296         /* Note device also supports DTR/CD (ugh) and Xon/Xoff in hardware */
2297         if (cflag & CRTSCTS) {
2298                 dbg("%s Setting to CRTSCTS flow control", __func__);
2299                 if (usb_control_msg(dev,
2300                                     usb_sndctrlpipe(dev, 0),
2301                                     FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2302                                     FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2303                                     0 , (FTDI_SIO_RTS_CTS_HS | priv->interface),
2304                                     buf, 0, WDR_TIMEOUT) < 0) {
2305                         dev_err(&port->dev,
2306                                 "urb failed to set to rts/cts flow control\n");
2307                 }
2308
2309         } else {
2310                 /*
2311                  * Xon/Xoff code
2312                  *
2313                  * Check the IXOFF status in the iflag component of the
2314                  * termios structure. If IXOFF is not set, the pre-xon/xoff
2315                  * code is executed.
2316                  */
2317                 if (iflag & IXOFF) {
2318                         dbg("%s  request to enable xonxoff iflag=%04x",
2319                                                         __func__, iflag);
2320                         /* Try to enable the XON/XOFF on the ftdi_sio
2321                          * Set the vstart and vstop -- could have been done up
2322                          * above where a lot of other dereferencing is done but
2323                          * that would be very inefficient as vstart and vstop
2324                          * are not always needed.
2325                          */
2326                         vstart = termios->c_cc[VSTART];
2327                         vstop = termios->c_cc[VSTOP];
2328                         urb_value = (vstop << 8) | (vstart);
2329
2330                         if (usb_control_msg(dev,
2331                                             usb_sndctrlpipe(dev, 0),
2332                                             FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2333                                             FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2334                                             urb_value , (FTDI_SIO_XON_XOFF_HS
2335                                                          | priv->interface),
2336                                             buf, 0, WDR_TIMEOUT) < 0) {
2337                                 dev_err(&port->dev, "urb failed to set to "
2338                                         "xon/xoff flow control\n");
2339                         }
2340                 } else {
2341                         /* else clause to only run if cflag ! CRTSCTS and iflag
2342                          * ! XOFF. CHECKME Assuming XON/XOFF handled by tty
2343                          * stack - not by device */
2344                         dbg("%s Turning off hardware flow control", __func__);
2345                         if (usb_control_msg(dev,
2346                                             usb_sndctrlpipe(dev, 0),
2347                                             FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2348                                             FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2349                                             0, priv->interface,
2350                                             buf, 0, WDR_TIMEOUT) < 0) {
2351                                 dev_err(&port->dev,
2352                                         "urb failed to clear flow control\n");
2353                         }
2354                 }
2355
2356         }
2357         return;
2358 }
2359
2360 static int ftdi_tiocmget(struct tty_struct *tty, struct file *file)
2361 {
2362         struct usb_serial_port *port = tty->driver_data;
2363         struct ftdi_private *priv = usb_get_serial_port_data(port);
2364         unsigned char buf[2];
2365         int ret;
2366
2367         dbg("%s TIOCMGET", __func__);
2368         switch (priv->chip_type) {
2369         case SIO:
2370                 /* Request the status from the device */
2371                 ret = usb_control_msg(port->serial->dev,
2372                            usb_rcvctrlpipe(port->serial->dev, 0),
2373                            FTDI_SIO_GET_MODEM_STATUS_REQUEST,
2374                            FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
2375                            0, 0,
2376                            buf, 1, WDR_TIMEOUT);
2377                 if (ret < 0)
2378                         return ret;
2379                 break;
2380         case FT8U232AM:
2381         case FT232BM:
2382         case FT2232C:
2383         case FT232RL:
2384         case FT2232H:
2385         case FT4232H:
2386                 /* the 8U232AM returns a two byte value (the sio is a 1 byte
2387                    value) - in the same format as the data returned from the in
2388                    point */
2389                 ret = usb_control_msg(port->serial->dev,
2390                                    usb_rcvctrlpipe(port->serial->dev, 0),
2391                                    FTDI_SIO_GET_MODEM_STATUS_REQUEST,
2392                                    FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
2393                                    0, priv->interface,
2394                                    buf, 2, WDR_TIMEOUT);
2395                 if (ret < 0)
2396                         return ret;
2397                 break;
2398         default:
2399                 return -EFAULT;
2400         }
2401
2402         return  (buf[0] & FTDI_SIO_DSR_MASK ? TIOCM_DSR : 0) |
2403                 (buf[0] & FTDI_SIO_CTS_MASK ? TIOCM_CTS : 0) |
2404                 (buf[0]  & FTDI_SIO_RI_MASK  ? TIOCM_RI  : 0) |
2405                 (buf[0]  & FTDI_SIO_RLSD_MASK ? TIOCM_CD  : 0) |
2406                 priv->last_dtr_rts;
2407 }
2408
2409 static int ftdi_tiocmset(struct tty_struct *tty, struct file *file,
2410                         unsigned int set, unsigned int clear)
2411 {
2412         struct usb_serial_port *port = tty->driver_data;
2413         dbg("%s TIOCMSET", __func__);
2414         return update_mctrl(port, set, clear);
2415 }
2416
2417
2418 static int ftdi_ioctl(struct tty_struct *tty, struct file *file,
2419                                         unsigned int cmd, unsigned long arg)
2420 {
2421         struct usb_serial_port *port = tty->driver_data;
2422         struct ftdi_private *priv = usb_get_serial_port_data(port);
2423
2424         dbg("%s cmd 0x%04x", __func__, cmd);
2425
2426         /* Based on code from acm.c and others */
2427         switch (cmd) {
2428
2429         case TIOCGSERIAL: /* gets serial port data */
2430                 return get_serial_info(port,
2431                                         (struct serial_struct __user *) arg);
2432
2433         case TIOCSSERIAL: /* sets serial port data */
2434                 return set_serial_info(tty, port,
2435                                         (struct serial_struct __user *) arg);
2436
2437         /*
2438          * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
2439          * - mask passed in arg for lines of interest
2440          *   (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
2441          * Caller should use TIOCGICOUNT to see which one it was.
2442          *
2443          * This code is borrowed from linux/drivers/char/serial.c
2444          */
2445         case TIOCMIWAIT:
2446                 while (priv != NULL) {
2447                         interruptible_sleep_on(&priv->delta_msr_wait);
2448                         /* see if a signal did it */
2449                         if (signal_pending(current))
2450                                 return -ERESTARTSYS;
2451                         else {
2452                                 char diff = priv->diff_status;
2453
2454                                 if (diff == 0)
2455                                         return -EIO; /* no change => error */
2456
2457                                 /* Consume all events */
2458                                 priv->diff_status = 0;
2459
2460                                 /* Return 0 if caller wanted to know about
2461                                    these bits */
2462                                 if (((arg & TIOCM_RNG) && (diff & FTDI_RS0_RI)) ||
2463                                     ((arg & TIOCM_DSR) && (diff & FTDI_RS0_DSR)) ||
2464                                     ((arg & TIOCM_CD)  && (diff & FTDI_RS0_RLSD)) ||
2465                                     ((arg & TIOCM_CTS) && (diff & FTDI_RS0_CTS))) {
2466                                         return 0;
2467                                 }
2468                                 /*
2469                                  * Otherwise caller can't care less about what
2470                                  * happened,and so we continue to wait for more
2471                                  * events.
2472                                  */
2473                         }
2474                 }
2475                 return 0;
2476         default:
2477                 break;
2478         }
2479         /* This is not necessarily an error - turns out the higher layers
2480          * will do some ioctls themselves (see comment above)
2481          */
2482         dbg("%s arg not supported - it was 0x%04x - check /usr/include/asm/ioctls.h", __func__, cmd);
2483         return -ENOIOCTLCMD;
2484 }
2485
2486 static void ftdi_throttle(struct tty_struct *tty)
2487 {
2488         struct usb_serial_port *port = tty->driver_data;
2489         unsigned long flags;
2490
2491         dbg("%s - port %d", __func__, port->number);
2492
2493         spin_lock_irqsave(&port->lock, flags);
2494         port->throttle_req = 1;
2495         spin_unlock_irqrestore(&port->lock, flags);
2496 }
2497
2498 void ftdi_unthrottle(struct tty_struct *tty)
2499 {
2500         struct usb_serial_port *port = tty->driver_data;
2501         int was_throttled;
2502         unsigned long flags;
2503
2504         dbg("%s - port %d", __func__, port->number);
2505
2506         spin_lock_irqsave(&port->lock, flags);
2507         was_throttled = port->throttled;
2508         port->throttled = port->throttle_req = 0;
2509         spin_unlock_irqrestore(&port->lock, flags);
2510
2511         /* Resubmit urb if throttled and open. */
2512         if (was_throttled && test_bit(ASYNCB_INITIALIZED, &port->port.flags))
2513                 ftdi_submit_read_urb(port, GFP_KERNEL);
2514 }
2515
2516 static int __init ftdi_init(void)
2517 {
2518         int retval;
2519
2520         dbg("%s", __func__);
2521         if (vendor > 0 && product > 0) {
2522                 /* Add user specified VID/PID to reserved element of table. */
2523                 int i;
2524                 for (i = 0; id_table_combined[i].idVendor; i++)
2525                         ;
2526                 id_table_combined[i].match_flags = USB_DEVICE_ID_MATCH_DEVICE;
2527                 id_table_combined[i].idVendor = vendor;
2528                 id_table_combined[i].idProduct = product;
2529         }
2530         retval = usb_serial_register(&ftdi_sio_device);
2531         if (retval)
2532                 goto failed_sio_register;
2533         retval = usb_register(&ftdi_driver);
2534         if (retval)
2535                 goto failed_usb_register;
2536
2537         printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
2538                DRIVER_DESC "\n");
2539         return 0;
2540 failed_usb_register:
2541         usb_serial_deregister(&ftdi_sio_device);
2542 failed_sio_register:
2543         return retval;
2544 }
2545
2546
2547 static void __exit ftdi_exit(void)
2548 {
2549
2550         dbg("%s", __func__);
2551
2552         usb_deregister(&ftdi_driver);
2553         usb_serial_deregister(&ftdi_sio_device);
2554
2555 }
2556
2557
2558 module_init(ftdi_init);
2559 module_exit(ftdi_exit);
2560
2561 MODULE_AUTHOR(DRIVER_AUTHOR);
2562 MODULE_DESCRIPTION(DRIVER_DESC);
2563 MODULE_LICENSE("GPL");
2564
2565 module_param(debug, bool, S_IRUGO | S_IWUSR);
2566 MODULE_PARM_DESC(debug, "Debug enabled or not");
2567 module_param(vendor, ushort, 0);
2568 MODULE_PARM_DESC(vendor, "User specified vendor ID (default="
2569                 __MODULE_STRING(FTDI_VID)")");
2570 module_param(product, ushort, 0);
2571 MODULE_PARM_DESC(product, "User specified product ID");
2572
2573 module_param(ndi_latency_timer, int, S_IRUGO | S_IWUSR);
2574 MODULE_PARM_DESC(ndi_latency_timer, "NDI device latency timer override");