drivers/usb/serial/ftdi_sio.c

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