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