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