SAFE public projects git trees. - safe/jmp/linux-2.6/blob - drivers/usb/serial/ftdi_sio.c

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