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