drivers/usb/serial/ftdi_sio.c

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