drivers/usb/serial/ftdi_sio.c

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