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