git.oblomov.eu Git - linux-2.6/blob - drivers/usb/serial/ftdi_sio.c

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