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