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