SAFE public projects git trees. - safe/jmp/linux-2.6/blob - drivers/usb/serial/ftdi_sio.c

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