drivers/usb/serial/ftdi_sio.c

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