git.oblomov.eu Git - linux-2.6/blob - drivers/usb/serial/ftdi_sio.c

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