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