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