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