git.oblomov.eu Git - linux-2.6/blob - drivers/usb/serial/ftdi_sio.c

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