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