SAFE public projects git trees. - safe/jmp/linux-2.6/blob - drivers/usb/serial/ftdi_sio.c

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