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