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