drivers/usb/serial/ftdi_sio.c

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