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

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