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