SAFE public projects git trees. - safe/jmp/linux-2.6/blob - drivers/usb/serial/ftdi_sio.c

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