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

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