drivers/usb/serial/ftdi_sio.c

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