drivers/usb/serial/ftdi_sio.c

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