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