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