drivers/usb/serial/ftdi_sio.c

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