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