drivers/usb/serial/ftdi_sio.c

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