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