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