git.maemo.org Git - h-e-n/blob - drivers/usb/serial/ftdi_sio.c

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