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