drivers/usb/serial/ftdi_sio.c

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