drivers/usb/serial/ftdi_sio.c

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