drivers/usb/serial/ftdi_sio.c

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