xref: /openbmc/linux/drivers/usb/serial/ftdi_sio.c (revision 97cd49eb)
11da177e4SLinus Torvalds /*
21da177e4SLinus Torvalds  * USB FTDI SIO driver
31da177e4SLinus Torvalds  *
41da177e4SLinus Torvalds  *	Copyright (C) 1999 - 2001
51da177e4SLinus Torvalds  *	    Greg Kroah-Hartman (greg@kroah.com)
61da177e4SLinus Torvalds  *          Bill Ryder (bryder@sgi.com)
71da177e4SLinus Torvalds  *	Copyright (C) 2002
81da177e4SLinus Torvalds  *	    Kuba Ober (kuba@mareimbrium.org)
91da177e4SLinus Torvalds  *
101da177e4SLinus Torvalds  *	This program is free software; you can redistribute it and/or modify
111da177e4SLinus Torvalds  *	it under the terms of the GNU General Public License as published by
121da177e4SLinus Torvalds  *	the Free Software Foundation; either version 2 of the License, or
131da177e4SLinus Torvalds  *	(at your option) any later version.
141da177e4SLinus Torvalds  *
151da177e4SLinus Torvalds  * See Documentation/usb/usb-serial.txt for more information on using this driver
161da177e4SLinus Torvalds  *
171da177e4SLinus Torvalds  * See http://ftdi-usb-sio.sourceforge.net for upto date testing info
181da177e4SLinus Torvalds  *	and extra documentation
191da177e4SLinus Torvalds  *
201da177e4SLinus Torvalds  * (21/Jul/2004) Ian Abbott
211da177e4SLinus Torvalds  *      Incorporated Steven Turner's code to add support for the FT2232C chip.
221da177e4SLinus Torvalds  *      The prelimilary port to the 2.6 kernel was by Rus V. Brushkoff.  I have
231da177e4SLinus Torvalds  *      fixed a couple of things.
241da177e4SLinus Torvalds  *
251da177e4SLinus Torvalds  * (27/May/2004) Ian Abbott
261da177e4SLinus Torvalds  *      Improved throttling code, mostly stolen from the WhiteHEAT driver.
271da177e4SLinus Torvalds  *
281da177e4SLinus Torvalds  * (26/Mar/2004) Jan Capek
291da177e4SLinus Torvalds  *      Added PID's for ICD-U20/ICD-U40 - incircuit PIC debuggers from CCS Inc.
301da177e4SLinus Torvalds  *
311da177e4SLinus Torvalds  * (09/Feb/2004) Ian Abbott
321da177e4SLinus Torvalds  *      Changed full name of USB-UIRT device to avoid "/" character.
331da177e4SLinus Torvalds  *      Added FTDI's alternate PID (0x6006) for FT232/245 devices.
341da177e4SLinus Torvalds  *      Added PID for "ELV USB Module UO100" from Stefan Frings.
351da177e4SLinus Torvalds  *
361da177e4SLinus Torvalds  * (21/Oct/2003) Ian Abbott
371da177e4SLinus Torvalds  *      Renamed some VID/PID macros for Matrix Orbital and Perle Systems
381da177e4SLinus Torvalds  *      devices.  Removed Matrix Orbital and Perle Systems devices from the
391da177e4SLinus Torvalds  *      8U232AM device table, but left them in the FT232BM table, as they are
401da177e4SLinus Torvalds  *      known to use only FT232BM.
411da177e4SLinus Torvalds  *
421da177e4SLinus Torvalds  * (17/Oct/2003) Scott Allen
431da177e4SLinus Torvalds  *      Added vid/pid for Perle Systems UltraPort USB serial converters
441da177e4SLinus Torvalds  *
451da177e4SLinus Torvalds  * (21/Sep/2003) Ian Abbott
461da177e4SLinus Torvalds  *      Added VID/PID for Omnidirectional Control Technology US101 USB to
471da177e4SLinus Torvalds  *      RS-232 adapter (also rebadged as Dick Smith Electronics XH6381).
481da177e4SLinus Torvalds  *      VID/PID supplied by Donald Gordon.
491da177e4SLinus Torvalds  *
501da177e4SLinus Torvalds  * (19/Aug/2003) Ian Abbott
511da177e4SLinus Torvalds  *      Freed urb's transfer buffer in write bulk callback.
521da177e4SLinus Torvalds  *      Omitted some paranoid checks in write bulk callback that don't matter.
531da177e4SLinus Torvalds  *      Scheduled work in write bulk callback regardless of port's open count.
541da177e4SLinus Torvalds  *
551da177e4SLinus Torvalds  * (05/Aug/2003) Ian Abbott
561da177e4SLinus Torvalds  *      Added VID/PID for ID TECH IDT1221U USB to RS-232 adapter.
571da177e4SLinus Torvalds  *      VID/PID provided by Steve Briggs.
581da177e4SLinus Torvalds  *
591da177e4SLinus Torvalds  * (23/Jul/2003) Ian Abbott
601da177e4SLinus Torvalds  *      Added PIDs for CrystalFontz 547, 633, 631, 635, 640 and 640 from
611da177e4SLinus Torvalds  *      Wayne Wylupski.
621da177e4SLinus Torvalds  *
631da177e4SLinus Torvalds  * (10/Jul/2003) David Glance
641da177e4SLinus Torvalds  *      Added PID for DSS-20 SyncStation cradle for Sony-Ericsson P800.
651da177e4SLinus Torvalds  *
661da177e4SLinus Torvalds  * (27/Jun/2003) Ian Abbott
671da177e4SLinus Torvalds  *	Reworked the urb handling logic.  We have no more pool, but dynamically
681da177e4SLinus Torvalds  *	allocate the urb and the transfer buffer on the fly.  In testing this
691da177e4SLinus Torvalds  *	does not incure any measurable overhead.  This also relies on the fact
701da177e4SLinus Torvalds  *	that we have proper reference counting logic for urbs.  I nicked this
711da177e4SLinus Torvalds  *	from Greg KH's Visor driver.
721da177e4SLinus Torvalds  *
731da177e4SLinus Torvalds  * (23/Jun/2003) Ian Abbott
741da177e4SLinus Torvalds  *      Reduced flip buffer pushes and corrected a data length test in
751da177e4SLinus Torvalds  *      ftdi_read_bulk_callback.
761da177e4SLinus Torvalds  *      Defererence pointers after any paranoid checks, not before.
771da177e4SLinus Torvalds  *
781da177e4SLinus Torvalds  * (21/Jun/2003) Erik Nygren
79093cf723SSteven Cole  *      Added support for Home Electronics Tira-1 IR transceiver using FT232BM chip.
801da177e4SLinus Torvalds  *      See <http://www.home-electro.com/tira1.htm>.  Only operates properly
811da177e4SLinus Torvalds  *      at 100000 and RTS-CTS, so set custom divisor mode on startup.
821da177e4SLinus Torvalds  *      Also force the Tira-1 and USB-UIRT to only use their custom baud rates.
831da177e4SLinus Torvalds  *
841da177e4SLinus Torvalds  * (18/Jun/2003) Ian Abbott
851da177e4SLinus Torvalds  *      Added Device ID of the USB relais from Rudolf Gugler (backported from
861da177e4SLinus Torvalds  *      Philipp G�hring's patch for 2.5.x kernel).
871da177e4SLinus Torvalds  *      Moved read transfer buffer reallocation into startup function.
881da177e4SLinus Torvalds  *      Free existing write urb and transfer buffer in startup function.
891da177e4SLinus Torvalds  *      Only use urbs in write urb pool that were successfully allocated.
901da177e4SLinus Torvalds  *      Moved some constant macros out of functions.
911da177e4SLinus Torvalds  *      Minor whitespace and comment changes.
921da177e4SLinus Torvalds  *
931da177e4SLinus Torvalds  * (12/Jun/2003) David Norwood
94093cf723SSteven Cole  *      Added support for USB-UIRT IR transceiver using 8U232AM chip.
951da177e4SLinus Torvalds  *      See <http://home.earthlink.net/~jrhees/USBUIRT/index.htm>.  Only
961da177e4SLinus Torvalds  *      operates properly at 312500, so set custom divisor mode on startup.
971da177e4SLinus Torvalds  *
981da177e4SLinus Torvalds  * (12/Jun/2003) Ian Abbott
991da177e4SLinus Torvalds  *      Added Sealevel SeaLINK+ 210x, 220x, 240x, 280x vid/pids from Tuan Hoang
1001da177e4SLinus Torvalds  *      - I've eliminated some that don't seem to exist!
1011da177e4SLinus Torvalds  *      Added Home Electronics Tira-1 IR transceiver pid from Chris Horn
1021da177e4SLinus Torvalds  *      Some whitespace/coding-style cleanups
1031da177e4SLinus Torvalds  *
1041da177e4SLinus Torvalds  * (11/Jun/2003) Ian Abbott
1051da177e4SLinus Torvalds  *      Fixed unsafe spinlock usage in ftdi_write
1061da177e4SLinus Torvalds  *
1071da177e4SLinus Torvalds  * (24/Feb/2003) Richard Shooter
1081da177e4SLinus Torvalds  *      Increase read buffer size to improve read speeds at higher baud rates
1091da177e4SLinus Torvalds  *      (specifically tested with up to 1Mb/sec at 1.5M baud)
1101da177e4SLinus Torvalds  *
1111da177e4SLinus Torvalds  * (23/Feb/2003) John Wilkins
1121da177e4SLinus Torvalds  *      Added Xon/xoff flow control (activating support in the ftdi device)
1131da177e4SLinus Torvalds  *      Added vid/pid for Videonetworks/Homechoice (UK ISP)
1141da177e4SLinus Torvalds  *
1151da177e4SLinus Torvalds  * (23/Feb/2003) Bill Ryder
1161da177e4SLinus Torvalds  *      Added matrix orb device vid/pids from Wayne Wylupski
1171da177e4SLinus Torvalds  *
1181da177e4SLinus Torvalds  * (19/Feb/2003) Ian Abbott
1191da177e4SLinus Torvalds  *      For TIOCSSERIAL, set alt_speed to 0 when ASYNC_SPD_MASK value has
1201da177e4SLinus Torvalds  *      changed to something other than ASYNC_SPD_HI, ASYNC_SPD_VHI,
1211da177e4SLinus Torvalds  *      ASYNC_SPD_SHI or ASYNC_SPD_WARP.  Also, unless ASYNC_SPD_CUST is in
1221da177e4SLinus Torvalds  *      force, don't bother changing baud rate when custom_divisor has changed.
1231da177e4SLinus Torvalds  *
1241da177e4SLinus Torvalds  * (18/Feb/2003) Ian Abbott
1251da177e4SLinus Torvalds  *      Fixed TIOCMGET handling to include state of DTR and RTS, the state
1261da177e4SLinus Torvalds  *      of which are now saved by set_dtr() and set_rts().
1271da177e4SLinus Torvalds  *      Fixed improper storage class for buf in set_dtr() and set_rts().
1281da177e4SLinus Torvalds  *      Added FT232BM chip type and support for its extra baud rates (compared
1291da177e4SLinus Torvalds  *      to FT8U232AM).
1301da177e4SLinus Torvalds  *      Took account of special case divisor values for highest baud rates of
1311da177e4SLinus Torvalds  *      FT8U232AM and FT232BM.
1321da177e4SLinus Torvalds  *      For TIOCSSERIAL, forced alt_speed to 0 when ASYNC_SPD_CUST kludge used,
1331da177e4SLinus Torvalds  *      as previous alt_speed setting is now stale.
1341da177e4SLinus Torvalds  *      Moved startup code common between the startup routines for the
1351da177e4SLinus Torvalds  *      different chip types into a common subroutine.
1361da177e4SLinus Torvalds  *
1371da177e4SLinus Torvalds  * (17/Feb/2003) Bill Ryder
1381da177e4SLinus Torvalds  *      Added write urb buffer pool on a per device basis
1391da177e4SLinus Torvalds  *      Added more checking for open file on callbacks (fixed OOPS)
1401da177e4SLinus Torvalds  *      Added CrystalFontz 632 and 634 PIDs
1411da177e4SLinus Torvalds  *         (thanx to CrystalFontz for the sample devices - they flushed out
1421da177e4SLinus Torvalds  *           some driver bugs)
1431da177e4SLinus Torvalds  *      Minor debugging message changes
1441da177e4SLinus Torvalds  *      Added throttle, unthrottle and chars_in_buffer functions
1451da177e4SLinus Torvalds  *      Fixed FTDI_SIO (the original device) bug
1461da177e4SLinus Torvalds  *      Fixed some shutdown handling
1471da177e4SLinus Torvalds  *
1481da177e4SLinus Torvalds  *
1491da177e4SLinus Torvalds  *
1501da177e4SLinus Torvalds  *
1511da177e4SLinus Torvalds  * (07/Jun/2002) Kuba Ober
1521da177e4SLinus Torvalds  *	Changed FTDI_SIO_BASE_BAUD_TO_DIVISOR macro into ftdi_baud_to_divisor
1531da177e4SLinus Torvalds  *	function. It was getting too complex.
1541da177e4SLinus Torvalds  *	Fix the divisor calculation logic which was setting divisor of 0.125
1551da177e4SLinus Torvalds  *	instead of 0.5 for fractional parts of divisor equal to 5/8, 6/8, 7/8.
1561da177e4SLinus Torvalds  *	Also make it bump up the divisor to next integer in case of 7/8 - it's
1571da177e4SLinus Torvalds  *	a better approximation.
1581da177e4SLinus Torvalds  *
1591da177e4SLinus Torvalds  * (25/Jul/2002) Bill Ryder inserted Dmitri's TIOCMIWAIT patch
1601da177e4SLinus Torvalds  *      Not tested by me but it doesn't break anything I use.
1611da177e4SLinus Torvalds  *
1621da177e4SLinus Torvalds  * (04/Jan/2002) Kuba Ober
1631da177e4SLinus Torvalds  *	Implemented 38400 baudrate kludge, where it can be substituted with other
1641da177e4SLinus Torvalds  *	  values. That's the only way to set custom baudrates.
1651da177e4SLinus Torvalds  *	Implemented TIOCSSERIAL, TIOCGSERIAL ioctl's so that setserial is happy.
1661da177e4SLinus Torvalds  *	FIXME: both baudrate things should eventually go to usbserial.c as other
1671da177e4SLinus Torvalds  *	  devices may need that functionality too. Actually, it can probably be
1681da177e4SLinus Torvalds  *	  merged in serial.c somehow - too many drivers repeat this code over
1691da177e4SLinus Torvalds  *	  and over.
1701da177e4SLinus Torvalds  *	Fixed baudrate forgetfulness - open() used to reset baudrate to 9600 every time.
1711da177e4SLinus Torvalds  *	Divisors for baudrates are calculated by a macro.
1721da177e4SLinus Torvalds  *	Small code cleanups. Ugly whitespace changes for Plato's sake only ;-].
1731da177e4SLinus Torvalds  *
1741da177e4SLinus Torvalds  * (04/Nov/2001) Bill Ryder
1751da177e4SLinus Torvalds  *	Fixed bug in read_bulk_callback where incorrect urb buffer was used.
1761da177e4SLinus Torvalds  *	Cleaned up write offset calculation
1771da177e4SLinus Torvalds  *	Added write_room since default values can be incorrect for sio
1781da177e4SLinus Torvalds  *	Changed write_bulk_callback to use same queue_task as other drivers
1791da177e4SLinus Torvalds  *        (the previous version caused panics)
1801da177e4SLinus Torvalds  *	Removed port iteration code since the device only has one I/O port and it
1811da177e4SLinus Torvalds  *	  was wrong anyway.
1821da177e4SLinus Torvalds  *
1831da177e4SLinus Torvalds  * (31/May/2001) gkh
1841da177e4SLinus Torvalds  *	Switched from using spinlock to a semaphore, which fixes lots of problems.
1851da177e4SLinus Torvalds  *
1861da177e4SLinus Torvalds  * (23/May/2001)   Bill Ryder
1871da177e4SLinus Torvalds  *	Added runtime debug patch (thanx Tyson D Sawyer).
1881da177e4SLinus Torvalds  *	Cleaned up comments for 8U232
1891da177e4SLinus Torvalds  *	Added parity, framing and overrun error handling
1901da177e4SLinus Torvalds  *	Added receive break handling.
1911da177e4SLinus Torvalds  *
1921da177e4SLinus Torvalds  * (04/08/2001) gb
1931da177e4SLinus Torvalds  *	Identify version on module load.
1941da177e4SLinus Torvalds  *
1951da177e4SLinus Torvalds  * (18/March/2001) Bill Ryder
1961da177e4SLinus Torvalds  *	(Not released)
1971da177e4SLinus Torvalds  *	Added send break handling. (requires kernel patch too)
1981da177e4SLinus Torvalds  *	Fixed 8U232AM hardware RTS/CTS etc status reporting.
1991da177e4SLinus Torvalds  *	Added flipbuf fix copied from generic device
2001da177e4SLinus Torvalds  *
2011da177e4SLinus Torvalds  * (12/3/2000) Bill Ryder
2021da177e4SLinus Torvalds  *	Added support for 8U232AM device.
2031da177e4SLinus Torvalds  *	Moved PID and VIDs into header file only.
2041da177e4SLinus Torvalds  *	Turned on low-latency for the tty (device will do high baudrates)
2051da177e4SLinus Torvalds  *	Added shutdown routine to close files when device removed.
2061da177e4SLinus Torvalds  *	More debug and error message cleanups.
2071da177e4SLinus Torvalds  *
2081da177e4SLinus Torvalds  * (11/13/2000) Bill Ryder
2091da177e4SLinus Torvalds  *	Added spinlock protected open code and close code.
2101da177e4SLinus Torvalds  *	Multiple opens work (sort of - see webpage mentioned above).
2111da177e4SLinus Torvalds  *	Cleaned up comments. Removed multiple PID/VID definitions.
2121da177e4SLinus Torvalds  *	Factorised cts/dtr code
2131da177e4SLinus Torvalds  *	Made use of __FUNCTION__ in dbg's
2141da177e4SLinus Torvalds  *
2151da177e4SLinus Torvalds  * (11/01/2000) Adam J. Richter
2161da177e4SLinus Torvalds  *	usb_device_id table support
2171da177e4SLinus Torvalds  *
2181da177e4SLinus Torvalds  * (10/05/2000) gkh
2191da177e4SLinus Torvalds  *	Fixed bug with urb->dev not being set properly, now that the usb
2201da177e4SLinus Torvalds  *	core needs it.
2211da177e4SLinus Torvalds  *
2221da177e4SLinus Torvalds  * (09/11/2000) gkh
2231da177e4SLinus Torvalds  *	Removed DEBUG #ifdefs with call to usb_serial_debug_data
2241da177e4SLinus Torvalds  *
2251da177e4SLinus Torvalds  * (07/19/2000) gkh
2261da177e4SLinus Torvalds  *	Added module_init and module_exit functions to handle the fact that this
2271da177e4SLinus Torvalds  *	driver is a loadable module now.
2281da177e4SLinus Torvalds  *
2291da177e4SLinus Torvalds  * (04/04/2000) Bill Ryder
2301da177e4SLinus Torvalds  *	Fixed bugs in TCGET/TCSET ioctls (by removing them - they are
2311da177e4SLinus Torvalds  *        handled elsewhere in the tty io driver chain).
2321da177e4SLinus Torvalds  *
2331da177e4SLinus Torvalds  * (03/30/2000) Bill Ryder
2341da177e4SLinus Torvalds  *	Implemented lots of ioctls
2351da177e4SLinus Torvalds  *	Fixed a race condition in write
2361da177e4SLinus Torvalds  *	Changed some dbg's to errs
2371da177e4SLinus Torvalds  *
2381da177e4SLinus Torvalds  * (03/26/2000) gkh
2391da177e4SLinus Torvalds  *	Split driver up into device specific pieces.
2401da177e4SLinus Torvalds  *
2411da177e4SLinus Torvalds  */
2421da177e4SLinus Torvalds 
2431da177e4SLinus Torvalds /* Bill Ryder - bryder@sgi.com - wrote the FTDI_SIO implementation */
2441da177e4SLinus Torvalds /* Thanx to FTDI for so kindly providing details of the protocol required */
2451da177e4SLinus Torvalds /*   to talk to the device */
2461da177e4SLinus Torvalds /* Thanx to gkh and the rest of the usb dev group for all code I have assimilated :-) */
2471da177e4SLinus Torvalds 
2481da177e4SLinus Torvalds #include <linux/kernel.h>
2491da177e4SLinus Torvalds #include <linux/errno.h>
2501da177e4SLinus Torvalds #include <linux/init.h>
2511da177e4SLinus Torvalds #include <linux/slab.h>
2521da177e4SLinus Torvalds #include <linux/tty.h>
2531da177e4SLinus Torvalds #include <linux/tty_driver.h>
2541da177e4SLinus Torvalds #include <linux/tty_flip.h>
2551da177e4SLinus Torvalds #include <linux/module.h>
2561da177e4SLinus Torvalds #include <linux/spinlock.h>
2571da177e4SLinus Torvalds #include <asm/uaccess.h>
2581da177e4SLinus Torvalds #include <linux/usb.h>
2591da177e4SLinus Torvalds #include <linux/serial.h>
260a969888cSGreg Kroah-Hartman #include <linux/usb/serial.h>
2611da177e4SLinus Torvalds #include "ftdi_sio.h"
2621da177e4SLinus Torvalds 
2631da177e4SLinus Torvalds /*
2641da177e4SLinus Torvalds  * Version Information
2651da177e4SLinus Torvalds  */
2668f977e42SIan Abbott #define DRIVER_VERSION "v1.4.3"
2671da177e4SLinus Torvalds #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>, Bill Ryder <bryder@sgi.com>, Kuba Ober <kuba@mareimbrium.org>"
2681da177e4SLinus Torvalds #define DRIVER_DESC "USB FTDI Serial Converters Driver"
2691da177e4SLinus Torvalds 
2701da177e4SLinus Torvalds static int debug;
271fdcb0a0fSIan Abbott static __u16 vendor = FTDI_VID;
272fdcb0a0fSIan Abbott static __u16 product;
2731da177e4SLinus Torvalds 
2748f977e42SIan Abbott /* struct ftdi_sio_quirk is used by devices requiring special attention. */
2758f977e42SIan Abbott struct ftdi_sio_quirk {
276fa91d43bSTony Lindgren 	int (*probe)(struct usb_serial *);
2778f977e42SIan Abbott 	void (*setup)(struct usb_serial *); /* Special settings during startup. */
2788f977e42SIan Abbott };
2798f977e42SIan Abbott 
280fa91d43bSTony Lindgren static int   ftdi_olimex_probe		(struct usb_serial *serial);
2818f977e42SIan Abbott static void  ftdi_USB_UIRT_setup	(struct usb_serial *serial);
2828f977e42SIan Abbott static void  ftdi_HE_TIRA1_setup	(struct usb_serial *serial);
2838f977e42SIan Abbott 
284fa91d43bSTony Lindgren static struct ftdi_sio_quirk ftdi_olimex_quirk = {
285fa91d43bSTony Lindgren 	.probe	= ftdi_olimex_probe,
286fa91d43bSTony Lindgren };
287fa91d43bSTony Lindgren 
2888f977e42SIan Abbott static struct ftdi_sio_quirk ftdi_USB_UIRT_quirk = {
2898f977e42SIan Abbott 	.setup = ftdi_USB_UIRT_setup,
2908f977e42SIan Abbott };
2918f977e42SIan Abbott 
2928f977e42SIan Abbott static struct ftdi_sio_quirk ftdi_HE_TIRA1_quirk = {
2938f977e42SIan Abbott 	.setup = ftdi_HE_TIRA1_setup,
2941da177e4SLinus Torvalds };
2951da177e4SLinus Torvalds 
2961da177e4SLinus Torvalds /*
2971da177e4SLinus Torvalds  * The 8U232AM has the same API as the sio except for:
2981da177e4SLinus Torvalds  * - it can support MUCH higher baudrates; up to:
2991da177e4SLinus Torvalds  *   o 921600 for RS232 and 2000000 for RS422/485 at 48MHz
3001da177e4SLinus Torvalds  *   o 230400 at 12MHz
3011da177e4SLinus Torvalds  *   so .. 8U232AM's baudrate setting codes are different
3021da177e4SLinus Torvalds  * - it has a two byte status code.
3031da177e4SLinus Torvalds  * - it returns characters every 16ms (the FTDI does it every 40ms)
3041da177e4SLinus Torvalds  *
3051da177e4SLinus Torvalds  * the bcdDevice value is used to differentiate FT232BM and FT245BM from
3061da177e4SLinus Torvalds  * the earlier FT8U232AM and FT8U232BM.  For now, include all known VID/PID
3071da177e4SLinus Torvalds  * combinations in both tables.
3088f977e42SIan Abbott  * FIXME: perhaps bcdDevice can also identify 12MHz FT8U232AM devices,
3098f977e42SIan Abbott  * but I don't know if those ever went into mass production. [Ian Abbott]
3101da177e4SLinus Torvalds  */
3111da177e4SLinus Torvalds 
3121da177e4SLinus Torvalds 
3131da177e4SLinus Torvalds 
3141da177e4SLinus Torvalds static struct usb_device_id id_table_combined [] = {
3152011e924SJonathan Davies 	{ USB_DEVICE(FTDI_VID, FTDI_AMC232_PID) },
3162011e924SJonathan Davies 	{ USB_DEVICE(FTDI_VID, FTDI_CANUSB_PID) },
31772a9f958SRazvan Gavril 	{ USB_DEVICE(FTDI_VID, FTDI_ACTZWAVE_PID) },
3181da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_VID, FTDI_IRTRANS_PID) },
31969737dfaSLuiz Fernando N. Capitulino 	{ USB_DEVICE(FTDI_VID, FTDI_IPLUS_PID) },
320d099321bSLuiz Fernando N. Capitulino 	{ USB_DEVICE(FTDI_VID, FTDI_IPLUS2_PID) },
321fad14a0dSFrank Sievertsen 	{ USB_DEVICE(FTDI_VID, FTDI_DMX4ALL) },
3221da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_VID, FTDI_SIO_PID) },
3231da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_VID, FTDI_8U232AM_PID) },
3241da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_VID, FTDI_8U232AM_ALT_PID) },
325d8b21606SGard Spreemann 	{ USB_DEVICE(FTDI_VID, FTDI_232RL_PID) },
3261da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_VID, FTDI_8U2232C_PID) },
327c0f8d561SChristophe Mariac 	{ USB_DEVICE(FTDI_VID, FTDI_MICRO_CHAMELEON_PID) },
3281da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_VID, FTDI_RELAIS_PID) },
3292adb80e9SGuido Scholz 	{ USB_DEVICE(FTDI_VID, FTDI_OPENDCC_PID) },
3301da177e4SLinus Torvalds 	{ USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_IOBOARD_PID) },
3311da177e4SLinus Torvalds 	{ USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_MINI_IOBOARD_PID) },
3321da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_VID, FTDI_XF_632_PID) },
3331da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_VID, FTDI_XF_634_PID) },
3341da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_VID, FTDI_XF_547_PID) },
3351da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_VID, FTDI_XF_633_PID) },
3361da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_VID, FTDI_XF_631_PID) },
3371da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_VID, FTDI_XF_635_PID) },
3381da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_VID, FTDI_XF_640_PID) },
3391da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_VID, FTDI_XF_642_PID) },
3401da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_VID, FTDI_DSS20_PID) },
3411da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_NF_RIC_VID, FTDI_NF_RIC_PID) },
3421da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_VID, FTDI_VNHCPCUSB_D_PID) },
3438f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_MTXORB_0_PID) },
3448f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_MTXORB_1_PID) },
3458f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_MTXORB_2_PID) },
3468f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_MTXORB_3_PID) },
3478f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_MTXORB_4_PID) },
3488f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_MTXORB_5_PID) },
3498f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_MTXORB_6_PID) },
3508f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_PERLE_ULTRAPORT_PID) },
3511da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_VID, FTDI_PIEGROUP_PID) },
352274a4bbcSDave Platt 	{ USB_DEVICE(FTDI_VID, FTDI_TNC_X_PID) },
353868e440dSJelle Foks 	{ USB_DEVICE(FTDI_VID, FTDI_USBX_707_PID) },
3541da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2101_PID) },
3551da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2102_PID) },
3561da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2103_PID) },
3571da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2104_PID) },
358a1484827SJustin Carlson 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2106_PID) },
3591da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_1_PID) },
3601da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_2_PID) },
3611da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_1_PID) },
3621da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_2_PID) },
3631da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_1_PID) },
3641da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_2_PID) },
3651da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_1_PID) },
3661da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_2_PID) },
3671da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_3_PID) },
3681da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_4_PID) },
3691da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_1_PID) },
3701da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_2_PID) },
3711da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_3_PID) },
3721da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_4_PID) },
3731da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_1_PID) },
3741da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_2_PID) },
3751da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_3_PID) },
3761da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_4_PID) },
3771da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_1_PID) },
3781da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_2_PID) },
3791da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_3_PID) },
3801da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_4_PID) },
3811da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_5_PID) },
3821da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_6_PID) },
3831da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_7_PID) },
3841da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_8_PID) },
3851da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_1_PID) },
3861da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_2_PID) },
3871da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_3_PID) },
3881da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_4_PID) },
3891da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_5_PID) },
3901da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_6_PID) },
3911da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_7_PID) },
3921da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_8_PID) },
3931da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_1_PID) },
3941da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_2_PID) },
3951da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_3_PID) },
3961da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_4_PID) },
3971da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_5_PID) },
3981da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_6_PID) },
3991da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_7_PID) },
4001da177e4SLinus Torvalds 	{ USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_8_PID) },
4011da177e4SLinus Torvalds 	{ USB_DEVICE(IDTECH_VID, IDTECH_IDT1221U_PID) },
4021da177e4SLinus Torvalds 	{ USB_DEVICE(OCT_VID, OCT_US101_PID) },
4038f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_HE_TIRA1_PID),
4048f977e42SIan Abbott 		.driver_info = (kernel_ulong_t)&ftdi_HE_TIRA1_quirk },
4058f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_USB_UIRT_PID),
4068f977e42SIan Abbott 		.driver_info = (kernel_ulong_t)&ftdi_USB_UIRT_quirk },
4071da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_1) },
4081da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_VID, PROTEGO_R2X0) },
4091da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_3) },
4101da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_4) },
4118f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E808_PID) },
4128f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E809_PID) },
4138f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80A_PID) },
4148f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80B_PID) },
4158f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80C_PID) },
4168f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80D_PID) },
4178f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80E_PID) },
4188f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80F_PID) },
4198f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E888_PID) },
4208f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E889_PID) },
4218f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88A_PID) },
4228f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88B_PID) },
4238f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88C_PID) },
4248f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88D_PID) },
4258f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88E_PID) },
4268f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88F_PID) },
4271da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_VID, FTDI_ELV_UO100_PID) },
42847900743SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_ELV_UM100_PID) },
429e6ac4a40SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_ELV_UR100_PID) },
430e6ac4a40SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_ELV_ALC8500_PID) },
431207c47e1SThomas Riewe 	{ USB_DEVICE(FTDI_VID, FTDI_PYRAMID_PID) },
432bde62185SMartin Hagelin 	{ USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1000PC_PID) },
4334eaf60e0SThomas Schleusener 	{ USB_DEVICE(FTDI_VID, FTDI_IBS_US485_PID) },
4344eaf60e0SThomas Schleusener 	{ USB_DEVICE(FTDI_VID, FTDI_IBS_PICPRO_PID) },
4354eaf60e0SThomas Schleusener 	{ USB_DEVICE(FTDI_VID, FTDI_IBS_PCMCIA_PID) },
4364eaf60e0SThomas Schleusener 	{ USB_DEVICE(FTDI_VID, FTDI_IBS_PK1_PID) },
4374eaf60e0SThomas Schleusener 	{ USB_DEVICE(FTDI_VID, FTDI_IBS_RS232MON_PID) },
4384eaf60e0SThomas Schleusener 	{ USB_DEVICE(FTDI_VID, FTDI_IBS_APP70_PID) },
4394eaf60e0SThomas Schleusener 	{ USB_DEVICE(FTDI_VID, FTDI_IBS_PEDO_PID) },
4404eaf60e0SThomas Schleusener 	{ USB_DEVICE(FTDI_VID, FTDI_IBS_PROD_PID) },
441e6ac4a40SIan Abbott 	/*
442e6ac4a40SIan Abbott 	 * These will probably use user-space drivers.  Uncomment them if
443e6ac4a40SIan Abbott 	 * you need them or use the user-specified vendor/product module
444e6ac4a40SIan Abbott 	 * parameters (see ftdi_sio.h for the numbers).  Make a fuss if
445e6ac4a40SIan Abbott 	 * you think the driver should recognize any of them by default.
446e6ac4a40SIan Abbott 	 */
447e6ac4a40SIan Abbott 	/* { USB_DEVICE(FTDI_VID, FTDI_ELV_CLI7000_PID) }, */
448e6ac4a40SIan Abbott 	/* { USB_DEVICE(FTDI_VID, FTDI_ELV_PPS7330_PID) }, */
449e6ac4a40SIan Abbott 	/* { USB_DEVICE(FTDI_VID, FTDI_ELV_TFM100_PID) }, */
450e6ac4a40SIan Abbott 	/* { USB_DEVICE(FTDI_VID, FTDI_ELV_UDF77_PID) }, */
451e6ac4a40SIan Abbott 	/* { USB_DEVICE(FTDI_VID, FTDI_ELV_UIO88_PID) }, */
452e6ac4a40SIan Abbott 	/* { USB_DEVICE(FTDI_VID, FTDI_ELV_UAD8_PID) }, */
453e6ac4a40SIan Abbott 	/* { USB_DEVICE(FTDI_VID, FTDI_ELV_UDA7_PID) }, */
454e6ac4a40SIan Abbott 	/* { USB_DEVICE(FTDI_VID, FTDI_ELV_USI2_PID) }, */
455e6ac4a40SIan Abbott 	/* { USB_DEVICE(FTDI_VID, FTDI_ELV_T1100_PID) }, */
456e6ac4a40SIan Abbott 	/* { USB_DEVICE(FTDI_VID, FTDI_ELV_PCD200_PID) }, */
457e6ac4a40SIan Abbott 	/* { USB_DEVICE(FTDI_VID, FTDI_ELV_ULA200_PID) }, */
458e6ac4a40SIan Abbott 	/* { USB_DEVICE(FTDI_VID, FTDI_ELV_CSI8_PID) }, */
459e6ac4a40SIan Abbott 	/* { USB_DEVICE(FTDI_VID, FTDI_ELV_EM1000DL_PID) }, */
460e6ac4a40SIan Abbott 	/* { USB_DEVICE(FTDI_VID, FTDI_ELV_PCK100_PID) }, */
461e6ac4a40SIan Abbott 	/* { USB_DEVICE(FTDI_VID, FTDI_ELV_RFP500_PID) }, */
462e6ac4a40SIan Abbott 	/* { USB_DEVICE(FTDI_VID, FTDI_ELV_FS20SIG_PID) }, */
463e6ac4a40SIan Abbott 	/* { USB_DEVICE(FTDI_VID, FTDI_ELV_WS300PC_PID) }, */
464e6ac4a40SIan Abbott 	/* { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1300PC_PID) }, */
465e6ac4a40SIan Abbott 	/* { USB_DEVICE(FTDI_VID, FTDI_ELV_WS500_PID) }, */
4668f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, LINX_SDMUSBQSS_PID) },
4678f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, LINX_MASTERDEVEL2_PID) },
4688f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, LINX_FUTURE_0_PID) },
4698f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, LINX_FUTURE_1_PID) },
4708f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, LINX_FUTURE_2_PID) },
4711da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_VID, FTDI_CCSICDU20_0_PID) },
4721da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_VID, FTDI_CCSICDU40_1_PID) },
473ec434e9bSJan Capek 	{ USB_DEVICE(FTDI_VID, FTDI_CCSMACHX_2_PID) },
4741da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_VID, INSIDE_ACCESSO) },
4751da177e4SLinus Torvalds 	{ USB_DEVICE(INTREPID_VID, INTREPID_VALUECAN_PID) },
4761da177e4SLinus Torvalds 	{ USB_DEVICE(INTREPID_VID, INTREPID_NEOVI_PID) },
4771da177e4SLinus Torvalds 	{ USB_DEVICE(FALCOM_VID, FALCOM_TWIST_PID) },
478e6ac4a40SIan Abbott 	{ USB_DEVICE(FALCOM_VID, FALCOM_SAMBA_PID) },
4791da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_VID, FTDI_SUUNTO_SPORTS_PID) },
480ef31fec0SMichael Olberg 	{ USB_DEVICE(TTI_VID, TTI_QL355P_PID) },
4816f92872cSIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_RM_CANVIEW_PID) },
4821da177e4SLinus Torvalds 	{ USB_DEVICE(BANDB_VID, BANDB_USOTL4_PID) },
4831da177e4SLinus Torvalds 	{ USB_DEVICE(BANDB_VID, BANDB_USTL4_PID) },
4841da177e4SLinus Torvalds 	{ USB_DEVICE(BANDB_VID, BANDB_USO9ML2_PID) },
4851da177e4SLinus Torvalds 	{ USB_DEVICE(FTDI_VID, EVER_ECO_PRO_CDS) },
4866f92872cSIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_1_PID) },
4876f92872cSIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_2_PID) },
488e6ac4a40SIan Abbott 	{ USB_DEVICE(FTDI_VID, XSENS_CONVERTER_0_PID) },
489e6ac4a40SIan Abbott 	{ USB_DEVICE(FTDI_VID, XSENS_CONVERTER_1_PID) },
490e6ac4a40SIan Abbott 	{ USB_DEVICE(FTDI_VID, XSENS_CONVERTER_2_PID) },
491e6ac4a40SIan Abbott 	{ USB_DEVICE(FTDI_VID, XSENS_CONVERTER_3_PID) },
492e6ac4a40SIan Abbott 	{ USB_DEVICE(FTDI_VID, XSENS_CONVERTER_4_PID) },
493e6ac4a40SIan Abbott 	{ USB_DEVICE(FTDI_VID, XSENS_CONVERTER_5_PID) },
494e6ac4a40SIan Abbott 	{ USB_DEVICE(FTDI_VID, XSENS_CONVERTER_6_PID) },
495e6ac4a40SIan Abbott 	{ USB_DEVICE(FTDI_VID, XSENS_CONVERTER_7_PID) },
4966f92872cSIan Abbott 	{ USB_DEVICE(MOBILITY_VID, MOBILITY_USB_SERIAL_PID) },
4978f977e42SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_ACTIVE_ROBOTS_PID) },
49834d1a8aaSIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_MHAM_KW_PID) },
49934d1a8aaSIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_MHAM_YS_PID) },
5009b1513d9SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_MHAM_Y6_PID) },
5019b1513d9SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_MHAM_Y8_PID) },
50234d1a8aaSIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_MHAM_IC_PID) },
50334d1a8aaSIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_MHAM_DB9_PID) },
50434d1a8aaSIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_MHAM_RS232_PID) },
50534d1a8aaSIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_MHAM_Y9_PID) },
506740a4282SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_VCP_PID) },
507740a4282SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_D2XX_PID) },
5089b1513d9SIan Abbott 	{ USB_DEVICE(EVOLUTION_VID, EVOLUTION_ER1_PID) },
509c9c7746dSRui Santos 	{ USB_DEVICE(FTDI_VID, FTDI_ARTEMIS_PID) },
510c9c7746dSRui Santos 	{ USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16_PID) },
51109c280a2SRui Santos 	{ USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16C_PID) },
512c9c7746dSRui Santos 	{ USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HR_PID) },
51309c280a2SRui Santos 	{ USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HRC_PID) },
514b4723ae3SIan Abbott 	{ USB_DEVICE(KOBIL_VID, KOBIL_CONV_B1_PID) },
515b4723ae3SIan Abbott 	{ USB_DEVICE(KOBIL_VID, KOBIL_CONV_KAAN_PID) },
516effac8beSPavel Fedin 	{ USB_DEVICE(POSIFLEX_VID, POSIFLEX_PP7000_PID) },
517641adaaeSLouis Nyffenegger 	{ USB_DEVICE(FTDI_VID, FTDI_TTUSB_PID) },
5187e1c0b86SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_ECLO_COM_1WIRE_PID) },
519a94b52acSIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_777_PID) },
520a94b52acSIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_8900F_PID) },
521ce40d290SWouter Paesen 	{ USB_DEVICE(FTDI_VID, FTDI_PCDJ_DAC2_PID) },
522cdd3b156SNathan Bronson 	{ USB_DEVICE(FTDI_VID, FTDI_RRCIRKITS_LOCOBUFFER_PID) },
5237e0258fdSIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_ASK_RDR400_PID) },
524bf58fbd5SA. Maitland Bottoms 	{ USB_DEVICE(ICOM_ID1_VID, ICOM_ID1_PID) },
52562a13db3SFolkert van Heusden 	{ USB_DEVICE(PAPOUCH_VID, PAPOUCH_TMU_PID) },
52620a0f47eSIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_ACG_HFDUAL_PID) },
527eb79b4fdSIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_YEI_SERVOCENTER31_PID) },
52848437486SD. Peter Siddons 	{ USB_DEVICE(FTDI_VID, FTDI_THORLABS_PID) },
529e1979fefSColin Leroy 	{ USB_DEVICE(TESTO_VID, TESTO_USB_INTERFACE_PID) },
530eaede2cbSRalf Schlatterbeck 	{ USB_DEVICE(FTDI_VID, FTDI_GAMMA_SCOUT_PID) },
5319978f9e1SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13M_PID) },
5329978f9e1SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13S_PID) },
5339978f9e1SIan Abbott 	{ USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13U_PID) },
53440c36092SKjell Myksvoll 	{ USB_DEVICE(ELEKTOR_VID, ELEKTOR_FT323R_PID) },
535822c7ef4SMicke Prag 	{ USB_DEVICE(TELLDUS_VID, TELLDUS_TELLSTICK_PID) },
536762e92faSNeil \"Superna\" ARMSTRONG 	{ USB_DEVICE(FTDI_VID, FTDI_MAXSTREAM_PID) },
537fa91d43bSTony Lindgren 	{ USB_DEVICE(OLIMEX_VID, OLIMEX_ARM_USB_OCD_PID),
538fa91d43bSTony Lindgren 		.driver_info = (kernel_ulong_t)&ftdi_olimex_quirk },
539fdcb0a0fSIan Abbott 	{ },					/* Optional parameter entry */
5401da177e4SLinus Torvalds 	{ }					/* Terminating entry */
5411da177e4SLinus Torvalds };
5421da177e4SLinus Torvalds 
5431da177e4SLinus Torvalds MODULE_DEVICE_TABLE (usb, id_table_combined);
5441da177e4SLinus Torvalds 
5451da177e4SLinus Torvalds static struct usb_driver ftdi_driver = {
5461da177e4SLinus Torvalds 	.name =		"ftdi_sio",
5471da177e4SLinus Torvalds 	.probe =	usb_serial_probe,
5481da177e4SLinus Torvalds 	.disconnect =	usb_serial_disconnect,
5491da177e4SLinus Torvalds 	.id_table =	id_table_combined,
550ba9dc657SGreg Kroah-Hartman 	.no_dynamic_id =	1,
5511da177e4SLinus Torvalds };
5521da177e4SLinus Torvalds 
5534c4c9432SArjan van de Ven static const char *ftdi_chip_name[] = {
5541da177e4SLinus Torvalds 	[SIO] = "SIO",	/* the serial part of FT8U100AX */
5551da177e4SLinus Torvalds 	[FT8U232AM] = "FT8U232AM",
5561da177e4SLinus Torvalds 	[FT232BM] = "FT232BM",
5571da177e4SLinus Torvalds 	[FT2232C] = "FT2232C",
558d8b21606SGard Spreemann 	[FT232RL] = "FT232RL",
5591da177e4SLinus Torvalds };
5601da177e4SLinus Torvalds 
5611da177e4SLinus Torvalds 
5621da177e4SLinus Torvalds /* Constants for read urb and write urb */
5631da177e4SLinus Torvalds #define BUFSZ 512
5641da177e4SLinus Torvalds #define PKTSZ 64
5651da177e4SLinus Torvalds 
5661da177e4SLinus Torvalds /* rx_flags */
5671da177e4SLinus Torvalds #define THROTTLED		0x01
5681da177e4SLinus Torvalds #define ACTUALLY_THROTTLED	0x02
5691da177e4SLinus Torvalds 
5701da177e4SLinus Torvalds struct ftdi_private {
5711da177e4SLinus Torvalds 	ftdi_chip_type_t chip_type;
5721da177e4SLinus Torvalds 				/* type of the device, either SIO or FT8U232AM */
5731da177e4SLinus Torvalds 	int baud_base;		/* baud base clock for divisor setting */
5741da177e4SLinus Torvalds 	int custom_divisor;	/* custom_divisor kludge, this is for baud_base (different from what goes to the chip!) */
5751da177e4SLinus Torvalds 	__u16 last_set_data_urb_value ;
5761da177e4SLinus Torvalds 				/* the last data state set - needed for doing a break */
5771da177e4SLinus Torvalds         int write_offset;       /* This is the offset in the usb data block to write the serial data -
5781da177e4SLinus Torvalds 				 * it is different between devices
5791da177e4SLinus Torvalds 				 */
5801da177e4SLinus Torvalds 	int flags;		/* some ASYNC_xxxx flags are supported */
5811da177e4SLinus Torvalds 	unsigned long last_dtr_rts;	/* saved modem control outputs */
5821da177e4SLinus Torvalds         wait_queue_head_t delta_msr_wait; /* Used for TIOCMIWAIT */
5831da177e4SLinus Torvalds 	char prev_status, diff_status;        /* Used for TIOCMIWAIT */
5841da177e4SLinus Torvalds 	__u8 rx_flags;		/* receive state flags (throttling) */
5851da177e4SLinus Torvalds 	spinlock_t rx_lock;	/* spinlock for receive state */
586c4028958SDavid Howells 	struct delayed_work rx_work;
587c4028958SDavid Howells 	struct usb_serial_port *port;
58876854ceaSIan Abbott 	int rx_processed;
58922465400SIan Abbott 	unsigned long rx_bytes;
5901da177e4SLinus Torvalds 
5911da177e4SLinus Torvalds 	__u16 interface;	/* FT2232C port interface (0 for FT232/245) */
5921da177e4SLinus Torvalds 
5931da177e4SLinus Torvalds 	int force_baud;		/* if non-zero, force the baud rate to this value */
5941da177e4SLinus Torvalds 	int force_rtscts;	/* if non-zero, force RTS-CTS to always be enabled */
59522465400SIan Abbott 
59622465400SIan Abbott 	spinlock_t tx_lock;	/* spinlock for transmit state */
59722465400SIan Abbott 	unsigned long tx_bytes;
59822465400SIan Abbott 	unsigned long tx_outstanding_bytes;
59922465400SIan Abbott 	unsigned long tx_outstanding_urbs;
6001da177e4SLinus Torvalds };
6011da177e4SLinus Torvalds 
6021da177e4SLinus Torvalds /* Used for TIOCMIWAIT */
6031da177e4SLinus Torvalds #define FTDI_STATUS_B0_MASK	(FTDI_RS0_CTS | FTDI_RS0_DSR | FTDI_RS0_RI | FTDI_RS0_RLSD)
6041da177e4SLinus Torvalds #define FTDI_STATUS_B1_MASK	(FTDI_RS_BI)
6051da177e4SLinus Torvalds /* End TIOCMIWAIT */
6061da177e4SLinus Torvalds 
6071da177e4SLinus Torvalds #define FTDI_IMPL_ASYNC_FLAGS = ( ASYNC_SPD_HI | ASYNC_SPD_VHI \
6081da177e4SLinus Torvalds  ASYNC_SPD_CUST | ASYNC_SPD_SHI | ASYNC_SPD_WARP )
6091da177e4SLinus Torvalds 
6101da177e4SLinus Torvalds /* function prototypes for a FTDI serial converter */
6118f977e42SIan Abbott static int  ftdi_sio_probe	(struct usb_serial *serial, const struct usb_device_id *id);
6128f977e42SIan Abbott static int  ftdi_sio_attach		(struct usb_serial *serial);
6131da177e4SLinus Torvalds static void ftdi_shutdown		(struct usb_serial *serial);
61412bdbe03SJim Radford static int  ftdi_sio_port_probe	(struct usb_serial_port *port);
61512bdbe03SJim Radford static int  ftdi_sio_port_remove	(struct usb_serial_port *port);
6161da177e4SLinus Torvalds static int  ftdi_open			(struct usb_serial_port *port, struct file *filp);
6171da177e4SLinus Torvalds static void ftdi_close			(struct usb_serial_port *port, struct file *filp);
6181da177e4SLinus Torvalds static int  ftdi_write			(struct usb_serial_port *port, const unsigned char *buf, int count);
6191da177e4SLinus Torvalds static int  ftdi_write_room		(struct usb_serial_port *port);
6201da177e4SLinus Torvalds static int  ftdi_chars_in_buffer	(struct usb_serial_port *port);
6217d12e780SDavid Howells static void ftdi_write_bulk_callback	(struct urb *urb);
6227d12e780SDavid Howells static void ftdi_read_bulk_callback	(struct urb *urb);
623c4028958SDavid Howells static void ftdi_process_read		(struct work_struct *work);
624606d099cSAlan Cox static void ftdi_set_termios		(struct usb_serial_port *port, struct ktermios * old);
6251da177e4SLinus Torvalds static int  ftdi_tiocmget               (struct usb_serial_port *port, struct file *file);
6261da177e4SLinus Torvalds static int  ftdi_tiocmset		(struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear);
6271da177e4SLinus Torvalds static int  ftdi_ioctl			(struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg);
6281da177e4SLinus Torvalds static void ftdi_break_ctl		(struct usb_serial_port *port, int break_state );
6291da177e4SLinus Torvalds static void ftdi_throttle		(struct usb_serial_port *port);
6301da177e4SLinus Torvalds static void ftdi_unthrottle		(struct usb_serial_port *port);
6311da177e4SLinus Torvalds 
6321da177e4SLinus Torvalds static unsigned short int ftdi_232am_baud_base_to_divisor (int baud, int base);
6331da177e4SLinus Torvalds static unsigned short int ftdi_232am_baud_to_divisor (int baud);
6341da177e4SLinus Torvalds static __u32 ftdi_232bm_baud_base_to_divisor (int baud, int base);
6351da177e4SLinus Torvalds static __u32 ftdi_232bm_baud_to_divisor (int baud);
6361da177e4SLinus Torvalds 
637ea65370dSGreg Kroah-Hartman static struct usb_serial_driver ftdi_sio_device = {
63818fcac35SGreg Kroah-Hartman 	.driver = {
6391da177e4SLinus Torvalds 		.owner =	THIS_MODULE,
640269bda1cSGreg Kroah-Hartman 		.name =		"ftdi_sio",
64118fcac35SGreg Kroah-Hartman 	},
642269bda1cSGreg Kroah-Hartman 	.description =		"FTDI USB Serial Device",
643d9b1b787SJohannes Hölzl 	.usb_driver = 		&ftdi_driver ,
6448f977e42SIan Abbott 	.id_table =		id_table_combined,
6451da177e4SLinus Torvalds 	.num_interrupt_in =	0,
6461da177e4SLinus Torvalds 	.num_bulk_in =		1,
6471da177e4SLinus Torvalds 	.num_bulk_out =		1,
6481da177e4SLinus Torvalds 	.num_ports =		1,
6498f977e42SIan Abbott 	.probe =		ftdi_sio_probe,
65012bdbe03SJim Radford 	.port_probe =		ftdi_sio_port_probe,
65112bdbe03SJim Radford 	.port_remove =		ftdi_sio_port_remove,
6521da177e4SLinus Torvalds 	.open =			ftdi_open,
6531da177e4SLinus Torvalds 	.close =		ftdi_close,
6541da177e4SLinus Torvalds 	.throttle =		ftdi_throttle,
6551da177e4SLinus Torvalds 	.unthrottle =		ftdi_unthrottle,
6561da177e4SLinus Torvalds 	.write =		ftdi_write,
6571da177e4SLinus Torvalds 	.write_room =		ftdi_write_room,
6581da177e4SLinus Torvalds 	.chars_in_buffer =	ftdi_chars_in_buffer,
6591da177e4SLinus Torvalds 	.read_bulk_callback =	ftdi_read_bulk_callback,
6601da177e4SLinus Torvalds 	.write_bulk_callback =	ftdi_write_bulk_callback,
6611da177e4SLinus Torvalds 	.tiocmget =             ftdi_tiocmget,
6621da177e4SLinus Torvalds 	.tiocmset =             ftdi_tiocmset,
6631da177e4SLinus Torvalds 	.ioctl =		ftdi_ioctl,
6641da177e4SLinus Torvalds 	.set_termios =		ftdi_set_termios,
6651da177e4SLinus Torvalds 	.break_ctl =		ftdi_break_ctl,
6668f977e42SIan Abbott 	.attach =		ftdi_sio_attach,
6671da177e4SLinus Torvalds 	.shutdown =		ftdi_shutdown,
6681da177e4SLinus Torvalds };
6691da177e4SLinus Torvalds 
6701da177e4SLinus Torvalds 
6711da177e4SLinus Torvalds #define WDR_TIMEOUT 5000 /* default urb timeout */
672279e1545SIan Abbott #define WDR_SHORT_TIMEOUT 1000	/* shorter urb timeout */
6731da177e4SLinus Torvalds 
6741da177e4SLinus Torvalds /* High and low are for DTR, RTS etc etc */
6751da177e4SLinus Torvalds #define HIGH 1
6761da177e4SLinus Torvalds #define LOW 0
6771da177e4SLinus Torvalds 
67822465400SIan Abbott /* number of outstanding urbs to prevent userspace DoS from happening */
67922465400SIan Abbott #define URB_UPPER_LIMIT	42
68022465400SIan Abbott 
6811da177e4SLinus Torvalds /*
6821da177e4SLinus Torvalds  * ***************************************************************************
683fa91d43bSTony Lindgren  * Utility functions
6841da177e4SLinus Torvalds  * ***************************************************************************
6851da177e4SLinus Torvalds  */
6861da177e4SLinus Torvalds 
6871da177e4SLinus Torvalds static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base)
6881da177e4SLinus Torvalds {
6891da177e4SLinus Torvalds 	unsigned short int divisor;
6901da177e4SLinus Torvalds 	int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
6911da177e4SLinus Torvalds 	if ((divisor3 & 0x7) == 7) divisor3 ++; // round x.7/8 up to x+1
6921da177e4SLinus Torvalds 	divisor = divisor3 >> 3;
6931da177e4SLinus Torvalds 	divisor3 &= 0x7;
6941da177e4SLinus Torvalds 	if (divisor3 == 1) divisor |= 0xc000; else // 0.125
6951da177e4SLinus Torvalds 	if (divisor3 >= 4) divisor |= 0x4000; else // 0.5
6961da177e4SLinus Torvalds 	if (divisor3 != 0) divisor |= 0x8000;      // 0.25
6971da177e4SLinus Torvalds 	if (divisor == 1) divisor = 0;	/* special case for maximum baud rate */
6981da177e4SLinus Torvalds 	return divisor;
6991da177e4SLinus Torvalds }
7001da177e4SLinus Torvalds 
7011da177e4SLinus Torvalds static unsigned short int ftdi_232am_baud_to_divisor(int baud)
7021da177e4SLinus Torvalds {
7031da177e4SLinus Torvalds 	 return(ftdi_232am_baud_base_to_divisor(baud, 48000000));
7041da177e4SLinus Torvalds }
7051da177e4SLinus Torvalds 
7061da177e4SLinus Torvalds static __u32 ftdi_232bm_baud_base_to_divisor(int baud, int base)
7071da177e4SLinus Torvalds {
7081da177e4SLinus Torvalds 	static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
7091da177e4SLinus Torvalds 	__u32 divisor;
7101da177e4SLinus Torvalds 	int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
7111da177e4SLinus Torvalds 	divisor = divisor3 >> 3;
7121da177e4SLinus Torvalds 	divisor |= (__u32)divfrac[divisor3 & 0x7] << 14;
7131da177e4SLinus Torvalds 	/* Deal with special cases for highest baud rates. */
7141da177e4SLinus Torvalds 	if (divisor == 1) divisor = 0; else	// 1.0
7151da177e4SLinus Torvalds 	if (divisor == 0x4001) divisor = 1;	// 1.5
7161da177e4SLinus Torvalds 	return divisor;
7171da177e4SLinus Torvalds }
7181da177e4SLinus Torvalds 
7191da177e4SLinus Torvalds static __u32 ftdi_232bm_baud_to_divisor(int baud)
7201da177e4SLinus Torvalds {
7211da177e4SLinus Torvalds 	 return(ftdi_232bm_baud_base_to_divisor(baud, 48000000));
7221da177e4SLinus Torvalds }
7231da177e4SLinus Torvalds 
72474ede0ffSIan Abbott #define set_mctrl(port, set)		update_mctrl((port), (set), 0)
72574ede0ffSIan Abbott #define clear_mctrl(port, clear)	update_mctrl((port), 0, (clear))
72674ede0ffSIan Abbott 
72774ede0ffSIan Abbott static int update_mctrl(struct usb_serial_port *port, unsigned int set, unsigned int clear)
7281da177e4SLinus Torvalds {
7291da177e4SLinus Torvalds 	struct ftdi_private *priv = usb_get_serial_port_data(port);
7301da177e4SLinus Torvalds 	char *buf;
73174ede0ffSIan Abbott 	unsigned urb_value;
7321da177e4SLinus Torvalds 	int rv;
7331da177e4SLinus Torvalds 
73474ede0ffSIan Abbott 	if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
73574ede0ffSIan Abbott 		dbg("%s - DTR|RTS not being set|cleared", __FUNCTION__);
73674ede0ffSIan Abbott 		return 0;	/* no change */
7371da177e4SLinus Torvalds 	}
73874ede0ffSIan Abbott 
73974ede0ffSIan Abbott 	buf = kmalloc(1, GFP_NOIO);
74074ede0ffSIan Abbott 	if (!buf) {
74174ede0ffSIan Abbott 		return -ENOMEM;
74274ede0ffSIan Abbott 	}
74374ede0ffSIan Abbott 
74474ede0ffSIan Abbott 	clear &= ~set;	/* 'set' takes precedence over 'clear' */
74574ede0ffSIan Abbott 	urb_value = 0;
74674ede0ffSIan Abbott 	if (clear & TIOCM_DTR)
74774ede0ffSIan Abbott 		urb_value |= FTDI_SIO_SET_DTR_LOW;
74874ede0ffSIan Abbott 	if (clear & TIOCM_RTS)
74974ede0ffSIan Abbott 		urb_value |= FTDI_SIO_SET_RTS_LOW;
75074ede0ffSIan Abbott 	if (set & TIOCM_DTR)
75174ede0ffSIan Abbott 		urb_value |= FTDI_SIO_SET_DTR_HIGH;
75274ede0ffSIan Abbott 	if (set & TIOCM_RTS)
75374ede0ffSIan Abbott 		urb_value |= FTDI_SIO_SET_RTS_HIGH;
7541da177e4SLinus Torvalds 	rv = usb_control_msg(port->serial->dev,
7551da177e4SLinus Torvalds 			       usb_sndctrlpipe(port->serial->dev, 0),
7561da177e4SLinus Torvalds 			       FTDI_SIO_SET_MODEM_CTRL_REQUEST,
7571da177e4SLinus Torvalds 			       FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE,
75874ede0ffSIan Abbott 			       urb_value, priv->interface,
7591da177e4SLinus Torvalds 			       buf, 0, WDR_TIMEOUT);
7601da177e4SLinus Torvalds 
7611da177e4SLinus Torvalds 	kfree(buf);
76274ede0ffSIan Abbott 	if (rv < 0) {
76374ede0ffSIan Abbott 		err("%s Error from MODEM_CTRL urb: DTR %s, RTS %s",
76474ede0ffSIan Abbott 				__FUNCTION__,
76574ede0ffSIan Abbott 				(set & TIOCM_DTR) ? "HIGH" :
76674ede0ffSIan Abbott 				(clear & TIOCM_DTR) ? "LOW" : "unchanged",
76774ede0ffSIan Abbott 				(set & TIOCM_RTS) ? "HIGH" :
76874ede0ffSIan Abbott 				(clear & TIOCM_RTS) ? "LOW" : "unchanged");
7691da177e4SLinus Torvalds 	} else {
77074ede0ffSIan Abbott 		dbg("%s - DTR %s, RTS %s", __FUNCTION__,
77174ede0ffSIan Abbott 				(set & TIOCM_DTR) ? "HIGH" :
77274ede0ffSIan Abbott 				(clear & TIOCM_DTR) ? "LOW" : "unchanged",
77374ede0ffSIan Abbott 				(set & TIOCM_RTS) ? "HIGH" :
77474ede0ffSIan Abbott 				(clear & TIOCM_RTS) ? "LOW" : "unchanged");
77574ede0ffSIan Abbott 		priv->last_dtr_rts = (priv->last_dtr_rts & ~clear) | set;
7761da177e4SLinus Torvalds 	}
7771da177e4SLinus Torvalds 	return rv;
7781da177e4SLinus Torvalds }
7791da177e4SLinus Torvalds 
7801da177e4SLinus Torvalds 
7811da177e4SLinus Torvalds static __u32 get_ftdi_divisor(struct usb_serial_port * port);
7821da177e4SLinus Torvalds 
7831da177e4SLinus Torvalds 
7841da177e4SLinus Torvalds static int change_speed(struct usb_serial_port *port)
7851da177e4SLinus Torvalds {
7861da177e4SLinus Torvalds 	struct ftdi_private *priv = usb_get_serial_port_data(port);
7871da177e4SLinus Torvalds 	char *buf;
7881da177e4SLinus Torvalds         __u16 urb_value;
7891da177e4SLinus Torvalds 	__u16 urb_index;
7901da177e4SLinus Torvalds 	__u32 urb_index_value;
7911da177e4SLinus Torvalds 	int rv;
7921da177e4SLinus Torvalds 
7931da177e4SLinus Torvalds 	buf = kmalloc(1, GFP_NOIO);
7941da177e4SLinus Torvalds 	if (!buf)
7951da177e4SLinus Torvalds 		return -ENOMEM;
7961da177e4SLinus Torvalds 
7971da177e4SLinus Torvalds 	urb_index_value = get_ftdi_divisor(port);
7981da177e4SLinus Torvalds 	urb_value = (__u16)urb_index_value;
7991da177e4SLinus Torvalds 	urb_index = (__u16)(urb_index_value >> 16);
8001da177e4SLinus Torvalds 	if (priv->interface) {	/* FT2232C */
8011da177e4SLinus Torvalds 		urb_index = (__u16)((urb_index << 8) | priv->interface);
8021da177e4SLinus Torvalds 	}
8031da177e4SLinus Torvalds 
8041da177e4SLinus Torvalds 	rv = usb_control_msg(port->serial->dev,
8051da177e4SLinus Torvalds 			    usb_sndctrlpipe(port->serial->dev, 0),
8061da177e4SLinus Torvalds 			    FTDI_SIO_SET_BAUDRATE_REQUEST,
8071da177e4SLinus Torvalds 			    FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE,
8081da177e4SLinus Torvalds 			    urb_value, urb_index,
809279e1545SIan Abbott 			    buf, 0, WDR_SHORT_TIMEOUT);
8101da177e4SLinus Torvalds 
8111da177e4SLinus Torvalds 	kfree(buf);
8121da177e4SLinus Torvalds 	return rv;
8131da177e4SLinus Torvalds }
8141da177e4SLinus Torvalds 
8151da177e4SLinus Torvalds 
8161da177e4SLinus Torvalds static __u32 get_ftdi_divisor(struct usb_serial_port * port)
8171da177e4SLinus Torvalds { /* get_ftdi_divisor */
8181da177e4SLinus Torvalds 	struct ftdi_private *priv = usb_get_serial_port_data(port);
8191da177e4SLinus Torvalds 	__u32 div_value = 0;
8201da177e4SLinus Torvalds 	int div_okay = 1;
8211da177e4SLinus Torvalds 	int baud;
8221da177e4SLinus Torvalds 
8231da177e4SLinus Torvalds 	/*
8241da177e4SLinus Torvalds 	 * The logic involved in setting the baudrate can be cleanly split in 3 steps.
8251da177e4SLinus Torvalds 	 * Obtaining the actual baud rate is a little tricky since unix traditionally
8261da177e4SLinus Torvalds 	 * somehow ignored the possibility to set non-standard baud rates.
8271da177e4SLinus Torvalds 	 * 1. Standard baud rates are set in tty->termios->c_cflag
8281da177e4SLinus Torvalds 	 * 2. If these are not enough, you can set any speed using alt_speed as follows:
8291da177e4SLinus Torvalds 	 *    - set tty->termios->c_cflag speed to B38400
8301da177e4SLinus Torvalds 	 *    - set your real speed in tty->alt_speed; it gets ignored when
8311da177e4SLinus Torvalds 	 *      alt_speed==0, (or)
8321da177e4SLinus Torvalds 	 *    - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
8331da177e4SLinus Torvalds 	 *      flags & ASYNC_SPD_MASK == ASYNC_SPD_[HI, VHI, SHI, WARP], this just
8341da177e4SLinus Torvalds 	 *      sets alt_speed to (HI: 57600, VHI: 115200, SHI: 230400, WARP: 460800)
8351da177e4SLinus Torvalds 	 * ** Steps 1, 2 are done courtesy of tty_get_baud_rate
8361da177e4SLinus Torvalds 	 * 3. You can also set baud rate by setting custom divisor as follows
8371da177e4SLinus Torvalds 	 *    - set tty->termios->c_cflag speed to B38400
8381da177e4SLinus Torvalds 	 *    - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
8391da177e4SLinus Torvalds 	 *      o flags & ASYNC_SPD_MASK == ASYNC_SPD_CUST
8401da177e4SLinus Torvalds 	 *      o custom_divisor set to baud_base / your_new_baudrate
8411da177e4SLinus Torvalds 	 * ** Step 3 is done courtesy of code borrowed from serial.c - I should really
8421da177e4SLinus Torvalds 	 *    spend some time and separate+move this common code to serial.c, it is
8431da177e4SLinus Torvalds 	 *    replicated in nearly every serial driver you see.
8441da177e4SLinus Torvalds 	 */
8451da177e4SLinus Torvalds 
8461da177e4SLinus Torvalds 	/* 1. Get the baud rate from the tty settings, this observes alt_speed hack */
8471da177e4SLinus Torvalds 
8481da177e4SLinus Torvalds 	baud = tty_get_baud_rate(port->tty);
8491da177e4SLinus Torvalds 	dbg("%s - tty_get_baud_rate reports speed %d", __FUNCTION__, baud);
8501da177e4SLinus Torvalds 
8511da177e4SLinus Torvalds 	/* 2. Observe async-compatible custom_divisor hack, update baudrate if needed */
8521da177e4SLinus Torvalds 
8531da177e4SLinus Torvalds 	if (baud == 38400 &&
8541da177e4SLinus Torvalds 	    ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
8551da177e4SLinus Torvalds 	     (priv->custom_divisor)) {
8561da177e4SLinus Torvalds 		baud = priv->baud_base / priv->custom_divisor;
8571da177e4SLinus Torvalds 		dbg("%s - custom divisor %d sets baud rate to %d", __FUNCTION__, priv->custom_divisor, baud);
8581da177e4SLinus Torvalds 	}
8591da177e4SLinus Torvalds 
8601da177e4SLinus Torvalds 	/* 3. Convert baudrate to device-specific divisor */
8611da177e4SLinus Torvalds 
8621da177e4SLinus Torvalds 	if (!baud) baud = 9600;
8631da177e4SLinus Torvalds 	switch(priv->chip_type) {
8641da177e4SLinus Torvalds 	case SIO: /* SIO chip */
8651da177e4SLinus Torvalds 		switch(baud) {
8661da177e4SLinus Torvalds 		case 300: div_value = ftdi_sio_b300; break;
8671da177e4SLinus Torvalds 		case 600: div_value = ftdi_sio_b600; break;
8681da177e4SLinus Torvalds 		case 1200: div_value = ftdi_sio_b1200; break;
8691da177e4SLinus Torvalds 		case 2400: div_value = ftdi_sio_b2400; break;
8701da177e4SLinus Torvalds 		case 4800: div_value = ftdi_sio_b4800; break;
8711da177e4SLinus Torvalds 		case 9600: div_value = ftdi_sio_b9600; break;
8721da177e4SLinus Torvalds 		case 19200: div_value = ftdi_sio_b19200; break;
8731da177e4SLinus Torvalds 		case 38400: div_value = ftdi_sio_b38400; break;
8741da177e4SLinus Torvalds 		case 57600: div_value = ftdi_sio_b57600;  break;
8751da177e4SLinus Torvalds 		case 115200: div_value = ftdi_sio_b115200; break;
8761da177e4SLinus Torvalds 		} /* baud */
8771da177e4SLinus Torvalds 		if (div_value == 0) {
8781da177e4SLinus Torvalds 			dbg("%s - Baudrate (%d) requested is not supported", __FUNCTION__,  baud);
8791da177e4SLinus Torvalds 			div_value = ftdi_sio_b9600;
8801da177e4SLinus Torvalds 			div_okay = 0;
8811da177e4SLinus Torvalds 		}
8821da177e4SLinus Torvalds 		break;
8831da177e4SLinus Torvalds 	case FT8U232AM: /* 8U232AM chip */
8841da177e4SLinus Torvalds 		if (baud <= 3000000) {
8851da177e4SLinus Torvalds 			div_value = ftdi_232am_baud_to_divisor(baud);
8861da177e4SLinus Torvalds 		} else {
8871da177e4SLinus Torvalds 	                dbg("%s - Baud rate too high!", __FUNCTION__);
8881da177e4SLinus Torvalds 			div_value = ftdi_232am_baud_to_divisor(9600);
8891da177e4SLinus Torvalds 			div_okay = 0;
8901da177e4SLinus Torvalds 		}
8911da177e4SLinus Torvalds 		break;
8921da177e4SLinus Torvalds 	case FT232BM: /* FT232BM chip */
8931da177e4SLinus Torvalds 	case FT2232C: /* FT2232C chip */
8943b009c63SDavid Brownell 	case FT232RL:
8951da177e4SLinus Torvalds 		if (baud <= 3000000) {
8961da177e4SLinus Torvalds 			div_value = ftdi_232bm_baud_to_divisor(baud);
8971da177e4SLinus Torvalds 		} else {
8981da177e4SLinus Torvalds 	                dbg("%s - Baud rate too high!", __FUNCTION__);
8991da177e4SLinus Torvalds 			div_value = ftdi_232bm_baud_to_divisor(9600);
9001da177e4SLinus Torvalds 			div_okay = 0;
9011da177e4SLinus Torvalds 		}
9021da177e4SLinus Torvalds 		break;
9031da177e4SLinus Torvalds 	} /* priv->chip_type */
9041da177e4SLinus Torvalds 
9051da177e4SLinus Torvalds 	if (div_okay) {
9061da177e4SLinus Torvalds 		dbg("%s - Baud rate set to %d (divisor 0x%lX) on chip %s",
9071da177e4SLinus Torvalds 			__FUNCTION__, baud, (unsigned long)div_value,
9081da177e4SLinus Torvalds 			ftdi_chip_name[priv->chip_type]);
9091da177e4SLinus Torvalds 	}
9101da177e4SLinus Torvalds 
9111da177e4SLinus Torvalds 	return(div_value);
9121da177e4SLinus Torvalds }
9131da177e4SLinus Torvalds 
9141da177e4SLinus Torvalds 
9151da177e4SLinus Torvalds static int get_serial_info(struct usb_serial_port * port, struct serial_struct __user * retinfo)
9161da177e4SLinus Torvalds {
9171da177e4SLinus Torvalds 	struct ftdi_private *priv = usb_get_serial_port_data(port);
9181da177e4SLinus Torvalds 	struct serial_struct tmp;
9191da177e4SLinus Torvalds 
9201da177e4SLinus Torvalds 	if (!retinfo)
9211da177e4SLinus Torvalds 		return -EFAULT;
9221da177e4SLinus Torvalds 	memset(&tmp, 0, sizeof(tmp));
9231da177e4SLinus Torvalds 	tmp.flags = priv->flags;
9241da177e4SLinus Torvalds 	tmp.baud_base = priv->baud_base;
9251da177e4SLinus Torvalds 	tmp.custom_divisor = priv->custom_divisor;
9261da177e4SLinus Torvalds 	if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
9271da177e4SLinus Torvalds 		return -EFAULT;
9281da177e4SLinus Torvalds 	return 0;
9291da177e4SLinus Torvalds } /* get_serial_info */
9301da177e4SLinus Torvalds 
9311da177e4SLinus Torvalds 
9321da177e4SLinus Torvalds static int set_serial_info(struct usb_serial_port * port, struct serial_struct __user * newinfo)
9331da177e4SLinus Torvalds { /* set_serial_info */
9341da177e4SLinus Torvalds 	struct ftdi_private *priv = usb_get_serial_port_data(port);
9351da177e4SLinus Torvalds 	struct serial_struct new_serial;
9361da177e4SLinus Torvalds 	struct ftdi_private old_priv;
9371da177e4SLinus Torvalds 
9381da177e4SLinus Torvalds 	if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
9391da177e4SLinus Torvalds 		return -EFAULT;
9401da177e4SLinus Torvalds 	old_priv = * priv;
9411da177e4SLinus Torvalds 
9421da177e4SLinus Torvalds 	/* Do error checking and permission checking */
9431da177e4SLinus Torvalds 
9441da177e4SLinus Torvalds 	if (!capable(CAP_SYS_ADMIN)) {
9451da177e4SLinus Torvalds 		if (((new_serial.flags & ~ASYNC_USR_MASK) !=
9461da177e4SLinus Torvalds 		     (priv->flags & ~ASYNC_USR_MASK)))
9471da177e4SLinus Torvalds 			return -EPERM;
9481da177e4SLinus Torvalds 		priv->flags = ((priv->flags & ~ASYNC_USR_MASK) |
9491da177e4SLinus Torvalds 			       (new_serial.flags & ASYNC_USR_MASK));
9501da177e4SLinus Torvalds 		priv->custom_divisor = new_serial.custom_divisor;
9511da177e4SLinus Torvalds 		goto check_and_exit;
9521da177e4SLinus Torvalds 	}
9531da177e4SLinus Torvalds 
9541da177e4SLinus Torvalds 	if ((new_serial.baud_base != priv->baud_base) &&
9551da177e4SLinus Torvalds 	    (new_serial.baud_base < 9600))
9561da177e4SLinus Torvalds 		return -EINVAL;
9571da177e4SLinus Torvalds 
9581da177e4SLinus Torvalds 	/* Make the changes - these are privileged changes! */
9591da177e4SLinus Torvalds 
9601da177e4SLinus Torvalds 	priv->flags = ((priv->flags & ~ASYNC_FLAGS) |
9611da177e4SLinus Torvalds 	               (new_serial.flags & ASYNC_FLAGS));
9621da177e4SLinus Torvalds 	priv->custom_divisor = new_serial.custom_divisor;
9631da177e4SLinus Torvalds 
9641da177e4SLinus Torvalds 	port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
9651da177e4SLinus Torvalds 
9661da177e4SLinus Torvalds check_and_exit:
9671da177e4SLinus Torvalds 	if ((old_priv.flags & ASYNC_SPD_MASK) !=
9681da177e4SLinus Torvalds 	     (priv->flags & ASYNC_SPD_MASK)) {
9691da177e4SLinus Torvalds 		if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_HI)
9701da177e4SLinus Torvalds 			port->tty->alt_speed = 57600;
9711da177e4SLinus Torvalds 		else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_VHI)
9721da177e4SLinus Torvalds 			port->tty->alt_speed = 115200;
9731da177e4SLinus Torvalds 		else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_SHI)
9741da177e4SLinus Torvalds 			port->tty->alt_speed = 230400;
9751da177e4SLinus Torvalds 		else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_WARP)
9761da177e4SLinus Torvalds 			port->tty->alt_speed = 460800;
9771da177e4SLinus Torvalds 		else
9781da177e4SLinus Torvalds 			port->tty->alt_speed = 0;
9791da177e4SLinus Torvalds 	}
9801da177e4SLinus Torvalds 	if (((old_priv.flags & ASYNC_SPD_MASK) !=
9811da177e4SLinus Torvalds 	     (priv->flags & ASYNC_SPD_MASK)) ||
9821da177e4SLinus Torvalds 	    (((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
9831da177e4SLinus Torvalds 	     (old_priv.custom_divisor != priv->custom_divisor))) {
9841da177e4SLinus Torvalds 		change_speed(port);
9851da177e4SLinus Torvalds 	}
9861da177e4SLinus Torvalds 
9871da177e4SLinus Torvalds 	return (0);
9881da177e4SLinus Torvalds 
9891da177e4SLinus Torvalds } /* set_serial_info */
9901da177e4SLinus Torvalds 
9911da177e4SLinus Torvalds 
9928f977e42SIan Abbott /* Determine type of FTDI chip based on USB config and descriptor. */
9938f977e42SIan Abbott static void ftdi_determine_type(struct usb_serial_port *port)
9948f977e42SIan Abbott {
9958f977e42SIan Abbott 	struct ftdi_private *priv = usb_get_serial_port_data(port);
9968f977e42SIan Abbott 	struct usb_serial *serial = port->serial;
9978f977e42SIan Abbott 	struct usb_device *udev = serial->dev;
9988f977e42SIan Abbott 	unsigned version;
9998f977e42SIan Abbott 	unsigned interfaces;
10008f977e42SIan Abbott 
10018f977e42SIan Abbott 	/* Assume it is not the original SIO device for now. */
1002f5e09b7cSIan Abbott 	priv->baud_base = 48000000 / 2;
10038f977e42SIan Abbott 	priv->write_offset = 0;
10048f977e42SIan Abbott 
10058f977e42SIan Abbott 	version = le16_to_cpu(udev->descriptor.bcdDevice);
10068f977e42SIan Abbott 	interfaces = udev->actconfig->desc.bNumInterfaces;
10078f977e42SIan Abbott 	dbg("%s: bcdDevice = 0x%x, bNumInterfaces = %u", __FUNCTION__,
10088f977e42SIan Abbott 			version, interfaces);
10098f977e42SIan Abbott 	if (interfaces > 1) {
10108f977e42SIan Abbott 		int inter;
10118f977e42SIan Abbott 
10128f977e42SIan Abbott 		/* Multiple interfaces.  Assume FT2232C. */
10138f977e42SIan Abbott 		priv->chip_type = FT2232C;
10148f977e42SIan Abbott 		/* Determine interface code. */
10158f977e42SIan Abbott 		inter = serial->interface->altsetting->desc.bInterfaceNumber;
10168f977e42SIan Abbott 		if (inter == 0) {
10178f977e42SIan Abbott 			priv->interface = PIT_SIOA;
10188f977e42SIan Abbott 		} else {
10198f977e42SIan Abbott 			priv->interface = PIT_SIOB;
10208f977e42SIan Abbott 		}
10218f977e42SIan Abbott 		/* BM-type devices have a bug where bcdDevice gets set
10228f977e42SIan Abbott 		 * to 0x200 when iSerialNumber is 0.  */
10238f977e42SIan Abbott 		if (version < 0x500) {
10248f977e42SIan Abbott 			dbg("%s: something fishy - bcdDevice too low for multi-interface device",
10258f977e42SIan Abbott 					__FUNCTION__);
10268f977e42SIan Abbott 		}
10278f977e42SIan Abbott 	} else if (version < 0x200) {
10288f977e42SIan Abbott 		/* Old device.  Assume its the original SIO. */
10298f977e42SIan Abbott 		priv->chip_type = SIO;
10308f977e42SIan Abbott 		priv->baud_base = 12000000 / 16;
10318f977e42SIan Abbott 		priv->write_offset = 1;
10328f977e42SIan Abbott 	} else if (version < 0x400) {
10338f977e42SIan Abbott 		/* Assume its an FT8U232AM (or FT8U245AM) */
10348f977e42SIan Abbott 		/* (It might be a BM because of the iSerialNumber bug,
10358f977e42SIan Abbott 		 * but it will still work as an AM device.) */
10368f977e42SIan Abbott 		priv->chip_type = FT8U232AM;
10373b009c63SDavid Brownell 	} else if (version < 0x600) {
10388f977e42SIan Abbott 		/* Assume its an FT232BM (or FT245BM) */
10398f977e42SIan Abbott 		priv->chip_type = FT232BM;
10403b009c63SDavid Brownell 	} else {
10413b009c63SDavid Brownell 		/* Assume its an FT232R  */
10423b009c63SDavid Brownell 		priv->chip_type = FT232RL;
10438f977e42SIan Abbott 	}
10448f977e42SIan Abbott 	info("Detected %s", ftdi_chip_name[priv->chip_type]);
10458f977e42SIan Abbott }
10468f977e42SIan Abbott 
10478f977e42SIan Abbott 
10481da177e4SLinus Torvalds /*
10491da177e4SLinus Torvalds  * ***************************************************************************
10501da177e4SLinus Torvalds  * Sysfs Attribute
10511da177e4SLinus Torvalds  * ***************************************************************************
10521da177e4SLinus Torvalds  */
10531da177e4SLinus Torvalds 
1054060b8845SYani Ioannou static ssize_t show_latency_timer(struct device *dev, struct device_attribute *attr, char *buf)
10551da177e4SLinus Torvalds {
10561da177e4SLinus Torvalds 	struct usb_serial_port *port = to_usb_serial_port(dev);
10571da177e4SLinus Torvalds 	struct ftdi_private *priv = usb_get_serial_port_data(port);
105812bdbe03SJim Radford 	struct usb_device *udev = port->serial->dev;
10591da177e4SLinus Torvalds 	unsigned short latency = 0;
10601da177e4SLinus Torvalds 	int rv = 0;
10611da177e4SLinus Torvalds 
10621da177e4SLinus Torvalds 
10631da177e4SLinus Torvalds 	dbg("%s",__FUNCTION__);
10641da177e4SLinus Torvalds 
10651da177e4SLinus Torvalds 	rv = usb_control_msg(udev,
10661da177e4SLinus Torvalds 			     usb_rcvctrlpipe(udev, 0),
10671da177e4SLinus Torvalds 			     FTDI_SIO_GET_LATENCY_TIMER_REQUEST,
10681da177e4SLinus Torvalds 			     FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE,
10691da177e4SLinus Torvalds 			     0, priv->interface,
10701da177e4SLinus Torvalds 			     (char*) &latency, 1, WDR_TIMEOUT);
10711da177e4SLinus Torvalds 
10721da177e4SLinus Torvalds 	if (rv < 0) {
10731da177e4SLinus Torvalds 		dev_err(dev, "Unable to read latency timer: %i", rv);
10741da177e4SLinus Torvalds 		return -EIO;
10751da177e4SLinus Torvalds 	}
10761da177e4SLinus Torvalds 	return sprintf(buf, "%i\n", latency);
10771da177e4SLinus Torvalds }
10781da177e4SLinus Torvalds 
10791da177e4SLinus Torvalds /* Write a new value of the latency timer, in units of milliseconds. */
1080060b8845SYani Ioannou static ssize_t store_latency_timer(struct device *dev, struct device_attribute *attr, const char *valbuf,
10811da177e4SLinus Torvalds 				   size_t count)
10821da177e4SLinus Torvalds {
10831da177e4SLinus Torvalds 	struct usb_serial_port *port = to_usb_serial_port(dev);
10841da177e4SLinus Torvalds 	struct ftdi_private *priv = usb_get_serial_port_data(port);
108512bdbe03SJim Radford 	struct usb_device *udev = port->serial->dev;
10861da177e4SLinus Torvalds 	char buf[1];
10871da177e4SLinus Torvalds 	int v = simple_strtoul(valbuf, NULL, 10);
10881da177e4SLinus Torvalds 	int rv = 0;
10891da177e4SLinus Torvalds 
10901da177e4SLinus Torvalds 	dbg("%s: setting latency timer = %i", __FUNCTION__, v);
10911da177e4SLinus Torvalds 
10921da177e4SLinus Torvalds 	rv = usb_control_msg(udev,
10931da177e4SLinus Torvalds 			     usb_sndctrlpipe(udev, 0),
10941da177e4SLinus Torvalds 			     FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
10951da177e4SLinus Torvalds 			     FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
10961da177e4SLinus Torvalds 			     v, priv->interface,
10971da177e4SLinus Torvalds 			     buf, 0, WDR_TIMEOUT);
10981da177e4SLinus Torvalds 
10991da177e4SLinus Torvalds 	if (rv < 0) {
11001da177e4SLinus Torvalds 		dev_err(dev, "Unable to write latency timer: %i", rv);
11011da177e4SLinus Torvalds 		return -EIO;
11021da177e4SLinus Torvalds 	}
11031da177e4SLinus Torvalds 
11041da177e4SLinus Torvalds 	return count;
11051da177e4SLinus Torvalds }
11061da177e4SLinus Torvalds 
11071da177e4SLinus Torvalds /* Write an event character directly to the FTDI register.  The ASCII
11081da177e4SLinus Torvalds    value is in the low 8 bits, with the enable bit in the 9th bit. */
1109060b8845SYani Ioannou static ssize_t store_event_char(struct device *dev, struct device_attribute *attr, const char *valbuf,
11101da177e4SLinus Torvalds 				size_t count)
11111da177e4SLinus Torvalds {
11121da177e4SLinus Torvalds 	struct usb_serial_port *port = to_usb_serial_port(dev);
11131da177e4SLinus Torvalds 	struct ftdi_private *priv = usb_get_serial_port_data(port);
111412bdbe03SJim Radford 	struct usb_device *udev = port->serial->dev;
11151da177e4SLinus Torvalds 	char buf[1];
11161da177e4SLinus Torvalds 	int v = simple_strtoul(valbuf, NULL, 10);
11171da177e4SLinus Torvalds 	int rv = 0;
11181da177e4SLinus Torvalds 
11191da177e4SLinus Torvalds 	dbg("%s: setting event char = %i", __FUNCTION__, v);
11201da177e4SLinus Torvalds 
11211da177e4SLinus Torvalds 	rv = usb_control_msg(udev,
11221da177e4SLinus Torvalds 			     usb_sndctrlpipe(udev, 0),
11231da177e4SLinus Torvalds 			     FTDI_SIO_SET_EVENT_CHAR_REQUEST,
11241da177e4SLinus Torvalds 			     FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE,
11251da177e4SLinus Torvalds 			     v, priv->interface,
11261da177e4SLinus Torvalds 			     buf, 0, WDR_TIMEOUT);
11271da177e4SLinus Torvalds 
11281da177e4SLinus Torvalds 	if (rv < 0) {
11291da177e4SLinus Torvalds 		dbg("Unable to write event character: %i", rv);
11301da177e4SLinus Torvalds 		return -EIO;
11311da177e4SLinus Torvalds 	}
11321da177e4SLinus Torvalds 
11331da177e4SLinus Torvalds 	return count;
11341da177e4SLinus Torvalds }
11351da177e4SLinus Torvalds 
11361da177e4SLinus Torvalds static DEVICE_ATTR(latency_timer, S_IWUSR | S_IRUGO, show_latency_timer, store_latency_timer);
11371da177e4SLinus Torvalds static DEVICE_ATTR(event_char, S_IWUSR, NULL, store_event_char);
11381da177e4SLinus Torvalds 
113912bdbe03SJim Radford static int create_sysfs_attrs(struct usb_serial_port *port)
11401da177e4SLinus Torvalds {
114112bdbe03SJim Radford 	struct ftdi_private *priv = usb_get_serial_port_data(port);
114213f4db9eSGreg Kroah-Hartman 	int retval = 0;
11431da177e4SLinus Torvalds 
11441da177e4SLinus Torvalds 	dbg("%s",__FUNCTION__);
11451da177e4SLinus Torvalds 
11461da177e4SLinus Torvalds 	/* XXX I've no idea if the original SIO supports the event_char
11471da177e4SLinus Torvalds 	 * sysfs parameter, so I'm playing it safe.  */
11481da177e4SLinus Torvalds 	if (priv->chip_type != SIO) {
11491da177e4SLinus Torvalds 		dbg("sysfs attributes for %s", ftdi_chip_name[priv->chip_type]);
115012bdbe03SJim Radford 		retval = device_create_file(&port->dev, &dev_attr_event_char);
115113f4db9eSGreg Kroah-Hartman 		if ((!retval) &&
115297cd49ebSStepan Moskovchenko 		    (priv->chip_type == FT232BM ||
115397cd49ebSStepan Moskovchenko 		     priv->chip_type == FT2232C ||
115497cd49ebSStepan Moskovchenko 		     priv->chip_type == FT232RL)) {
115512bdbe03SJim Radford 			retval = device_create_file(&port->dev,
115613f4db9eSGreg Kroah-Hartman 						    &dev_attr_latency_timer);
11571da177e4SLinus Torvalds 		}
11581da177e4SLinus Torvalds 	}
115913f4db9eSGreg Kroah-Hartman 	return retval;
11601da177e4SLinus Torvalds }
11611da177e4SLinus Torvalds 
116212bdbe03SJim Radford static void remove_sysfs_attrs(struct usb_serial_port *port)
11631da177e4SLinus Torvalds {
116412bdbe03SJim Radford 	struct ftdi_private *priv = usb_get_serial_port_data(port);
11651da177e4SLinus Torvalds 
11661da177e4SLinus Torvalds 	dbg("%s",__FUNCTION__);
11671da177e4SLinus Torvalds 
11681da177e4SLinus Torvalds 	/* XXX see create_sysfs_attrs */
11691da177e4SLinus Torvalds 	if (priv->chip_type != SIO) {
117012bdbe03SJim Radford 		device_remove_file(&port->dev, &dev_attr_event_char);
11711da177e4SLinus Torvalds 		if (priv->chip_type == FT232BM || priv->chip_type == FT2232C) {
117212bdbe03SJim Radford 			device_remove_file(&port->dev, &dev_attr_latency_timer);
11731da177e4SLinus Torvalds 		}
11741da177e4SLinus Torvalds 	}
11751da177e4SLinus Torvalds 
11761da177e4SLinus Torvalds }
11771da177e4SLinus Torvalds 
11781da177e4SLinus Torvalds /*
11791da177e4SLinus Torvalds  * ***************************************************************************
11801da177e4SLinus Torvalds  * FTDI driver specific functions
11811da177e4SLinus Torvalds  * ***************************************************************************
11821da177e4SLinus Torvalds  */
11831da177e4SLinus Torvalds 
11848f977e42SIan Abbott /* Probe function to check for special devices */
11858f977e42SIan Abbott static int ftdi_sio_probe (struct usb_serial *serial, const struct usb_device_id *id)
11868f977e42SIan Abbott {
1187fa91d43bSTony Lindgren 	struct ftdi_sio_quirk *quirk = (struct ftdi_sio_quirk *)id->driver_info;
1188fa91d43bSTony Lindgren 
1189fa91d43bSTony Lindgren 	if (quirk && quirk->probe) {
1190fa91d43bSTony Lindgren 		int ret = quirk->probe(serial);
1191fa91d43bSTony Lindgren 		if (ret != 0)
1192fa91d43bSTony Lindgren 			return ret;
1193fa91d43bSTony Lindgren 	}
1194fa91d43bSTony Lindgren 
11958f977e42SIan Abbott 	usb_set_serial_data(serial, (void *)id->driver_info);
11968f977e42SIan Abbott 
1197fa91d43bSTony Lindgren 	return 0;
11988f977e42SIan Abbott }
11998f977e42SIan Abbott 
120012bdbe03SJim Radford static int ftdi_sio_port_probe(struct usb_serial_port *port)
12011da177e4SLinus Torvalds {
12021da177e4SLinus Torvalds 	struct ftdi_private *priv;
12031da177e4SLinus Torvalds 
12041da177e4SLinus Torvalds 	dbg("%s",__FUNCTION__);
12051da177e4SLinus Torvalds 
120680b6ca48SEric Sesterhenn 	priv = kzalloc(sizeof(struct ftdi_private), GFP_KERNEL);
12071da177e4SLinus Torvalds 	if (!priv){
12081da177e4SLinus Torvalds 		err("%s- kmalloc(%Zd) failed.", __FUNCTION__, sizeof(struct ftdi_private));
12091da177e4SLinus Torvalds 		return -ENOMEM;
12101da177e4SLinus Torvalds 	}
12111da177e4SLinus Torvalds 
12121da177e4SLinus Torvalds 	spin_lock_init(&priv->rx_lock);
121322465400SIan Abbott 	spin_lock_init(&priv->tx_lock);
12141da177e4SLinus Torvalds         init_waitqueue_head(&priv->delta_msr_wait);
12151da177e4SLinus Torvalds 	/* This will push the characters through immediately rather
12161da177e4SLinus Torvalds 	   than queue a task to deliver them */
12171da177e4SLinus Torvalds 	priv->flags = ASYNC_LOW_LATENCY;
12181da177e4SLinus Torvalds 
12191da177e4SLinus Torvalds 	/* Increase the size of read buffers */
12201da177e4SLinus Torvalds 	kfree(port->bulk_in_buffer);
12211da177e4SLinus Torvalds 	port->bulk_in_buffer = kmalloc (BUFSZ, GFP_KERNEL);
12221da177e4SLinus Torvalds 	if (!port->bulk_in_buffer) {
12231da177e4SLinus Torvalds 		kfree (priv);
12241da177e4SLinus Torvalds 		return -ENOMEM;
12251da177e4SLinus Torvalds 	}
12261da177e4SLinus Torvalds 	if (port->read_urb) {
12271da177e4SLinus Torvalds 		port->read_urb->transfer_buffer = port->bulk_in_buffer;
12281da177e4SLinus Torvalds 		port->read_urb->transfer_buffer_length = BUFSZ;
12291da177e4SLinus Torvalds 	}
12301da177e4SLinus Torvalds 
1231c4028958SDavid Howells 	INIT_DELAYED_WORK(&priv->rx_work, ftdi_process_read);
1232c4028958SDavid Howells 	priv->port = port;
123376854ceaSIan Abbott 
12341da177e4SLinus Torvalds 	/* Free port's existing write urb and transfer buffer. */
12351da177e4SLinus Torvalds 	if (port->write_urb) {
12361da177e4SLinus Torvalds 		usb_free_urb (port->write_urb);
12371da177e4SLinus Torvalds 		port->write_urb = NULL;
12381da177e4SLinus Torvalds 	}
12391da177e4SLinus Torvalds 	kfree(port->bulk_out_buffer);
12401da177e4SLinus Torvalds 	port->bulk_out_buffer = NULL;
12411da177e4SLinus Torvalds 
124212bdbe03SJim Radford 	usb_set_serial_port_data(port, priv);
12431da177e4SLinus Torvalds 
124412bdbe03SJim Radford 	ftdi_determine_type (port);
124512bdbe03SJim Radford 	create_sysfs_attrs(port);
124612bdbe03SJim Radford 	return 0;
12471da177e4SLinus Torvalds }
12481da177e4SLinus Torvalds 
124912bdbe03SJim Radford /* attach subroutine */
125012bdbe03SJim Radford static int ftdi_sio_attach (struct usb_serial *serial)
125112bdbe03SJim Radford {
125212bdbe03SJim Radford 	/* Check for device requiring special set up. */
125312bdbe03SJim Radford 	struct ftdi_sio_quirk *quirk = usb_get_serial_data(serial);
125412bdbe03SJim Radford 
125512bdbe03SJim Radford 	if (quirk && quirk->setup)
125612bdbe03SJim Radford 		quirk->setup(serial);
125712bdbe03SJim Radford 
125813f4db9eSGreg Kroah-Hartman 	return 0;
12598f977e42SIan Abbott } /* ftdi_sio_attach */
12601da177e4SLinus Torvalds 
12618f977e42SIan Abbott 
12628f977e42SIan Abbott /* Setup for the USB-UIRT device, which requires hardwired
12638f977e42SIan Abbott  * baudrate (38400 gets mapped to 312500) */
12641da177e4SLinus Torvalds /* Called from usbserial:serial_probe */
12658f977e42SIan Abbott static void ftdi_USB_UIRT_setup (struct usb_serial *serial)
12661da177e4SLinus Torvalds {
12671da177e4SLinus Torvalds 	struct ftdi_private *priv;
12681da177e4SLinus Torvalds 
12691da177e4SLinus Torvalds 	dbg("%s",__FUNCTION__);
12701da177e4SLinus Torvalds 
12711da177e4SLinus Torvalds 	priv = usb_get_serial_port_data(serial->port[0]);
12721da177e4SLinus Torvalds 	priv->flags |= ASYNC_SPD_CUST;
12731da177e4SLinus Torvalds 	priv->custom_divisor = 77;
12741da177e4SLinus Torvalds 	priv->force_baud = B38400;
12758f977e42SIan Abbott } /* ftdi_USB_UIRT_setup */
12761da177e4SLinus Torvalds 
12778f977e42SIan Abbott /* Setup for the HE-TIRA1 device, which requires hardwired
12788f977e42SIan Abbott  * baudrate (38400 gets mapped to 100000) and RTS-CTS enabled.  */
12798f977e42SIan Abbott static void ftdi_HE_TIRA1_setup (struct usb_serial *serial)
12808f977e42SIan Abbott {
12811da177e4SLinus Torvalds 	struct ftdi_private *priv;
12821da177e4SLinus Torvalds 
12831da177e4SLinus Torvalds 	dbg("%s",__FUNCTION__);
12841da177e4SLinus Torvalds 
12851da177e4SLinus Torvalds 	priv = usb_get_serial_port_data(serial->port[0]);
12861da177e4SLinus Torvalds 	priv->flags |= ASYNC_SPD_CUST;
12871da177e4SLinus Torvalds 	priv->custom_divisor = 240;
12881da177e4SLinus Torvalds 	priv->force_baud = B38400;
12891da177e4SLinus Torvalds 	priv->force_rtscts = 1;
12908f977e42SIan Abbott } /* ftdi_HE_TIRA1_setup */
12911da177e4SLinus Torvalds 
1292fa91d43bSTony Lindgren /*
1293fa91d43bSTony Lindgren  * First port on Olimex arm-usb-ocd is reserved for JTAG interface
1294fa91d43bSTony Lindgren  * and can be accessed from userspace using openocd.
1295fa91d43bSTony Lindgren  */
1296fa91d43bSTony Lindgren static int ftdi_olimex_probe(struct usb_serial *serial)
1297fa91d43bSTony Lindgren {
1298fa91d43bSTony Lindgren 	struct usb_device *udev = serial->dev;
1299fa91d43bSTony Lindgren 	struct usb_interface *interface = serial->interface;
1300fa91d43bSTony Lindgren 
1301fa91d43bSTony Lindgren 	dbg("%s",__FUNCTION__);
1302fa91d43bSTony Lindgren 
1303fa91d43bSTony Lindgren 	if (interface == udev->actconfig->interface[0]) {
1304fa91d43bSTony Lindgren 		info("Ignoring reserved serial port on Olimex arm-usb-ocd\n");
1305fa91d43bSTony Lindgren 		return -ENODEV;
1306fa91d43bSTony Lindgren 	}
1307fa91d43bSTony Lindgren 
1308fa91d43bSTony Lindgren 	return 0;
1309fa91d43bSTony Lindgren }
13101da177e4SLinus Torvalds 
13111da177e4SLinus Torvalds /* ftdi_shutdown is called from usbserial:usb_serial_disconnect
13121da177e4SLinus Torvalds  *   it is called when the usb device is disconnected
13131da177e4SLinus Torvalds  *
13141da177e4SLinus Torvalds  *   usbserial:usb_serial_disconnect
13151da177e4SLinus Torvalds  *      calls __serial_close for each open of the port
13161da177e4SLinus Torvalds  *      shutdown is called then (ie ftdi_shutdown)
13171da177e4SLinus Torvalds  */
13181da177e4SLinus Torvalds static void ftdi_shutdown (struct usb_serial *serial)
131912bdbe03SJim Radford {
132012bdbe03SJim Radford 	dbg("%s", __FUNCTION__);
132112bdbe03SJim Radford }
13221da177e4SLinus Torvalds 
132312bdbe03SJim Radford static int ftdi_sio_port_remove(struct usb_serial_port *port)
132412bdbe03SJim Radford {
13251da177e4SLinus Torvalds 	struct ftdi_private *priv = usb_get_serial_port_data(port);
13261da177e4SLinus Torvalds 
13271da177e4SLinus Torvalds 	dbg("%s", __FUNCTION__);
13281da177e4SLinus Torvalds 
132912bdbe03SJim Radford 	remove_sysfs_attrs(port);
13301da177e4SLinus Torvalds 
13311da177e4SLinus Torvalds 	/* all open ports are closed at this point
13321da177e4SLinus Torvalds          *    (by usbserial.c:__serial_close, which calls ftdi_close)
13331da177e4SLinus Torvalds 	 */
13341da177e4SLinus Torvalds 
13351da177e4SLinus Torvalds 	if (priv) {
13361da177e4SLinus Torvalds 		usb_set_serial_port_data(port, NULL);
13371da177e4SLinus Torvalds 		kfree(priv);
13381da177e4SLinus Torvalds 	}
13391da177e4SLinus Torvalds 
134012bdbe03SJim Radford 	return 0;
134112bdbe03SJim Radford }
13421da177e4SLinus Torvalds 
13431da177e4SLinus Torvalds static int  ftdi_open (struct usb_serial_port *port, struct file *filp)
13441da177e4SLinus Torvalds { /* ftdi_open */
13451da177e4SLinus Torvalds 	struct usb_device *dev = port->serial->dev;
13461da177e4SLinus Torvalds 	struct ftdi_private *priv = usb_get_serial_port_data(port);
13471da177e4SLinus Torvalds 	unsigned long flags;
13481da177e4SLinus Torvalds 
13491da177e4SLinus Torvalds 	int result = 0;
13501da177e4SLinus Torvalds 	char buf[1]; /* Needed for the usb_control_msg I think */
13511da177e4SLinus Torvalds 
13521da177e4SLinus Torvalds 	dbg("%s", __FUNCTION__);
13531da177e4SLinus Torvalds 
135422465400SIan Abbott 	spin_lock_irqsave(&priv->tx_lock, flags);
135522465400SIan Abbott 	priv->tx_bytes = 0;
135622465400SIan Abbott 	spin_unlock_irqrestore(&priv->tx_lock, flags);
135722465400SIan Abbott 	spin_lock_irqsave(&priv->rx_lock, flags);
135822465400SIan Abbott 	priv->rx_bytes = 0;
135922465400SIan Abbott 	spin_unlock_irqrestore(&priv->rx_lock, flags);
136022465400SIan Abbott 
136157845bd1SGuennadi Liakhovetski 	if (port->tty)
13621da177e4SLinus Torvalds 		port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
13631da177e4SLinus Torvalds 
13641da177e4SLinus Torvalds 	/* No error checking for this (will get errors later anyway) */
13651da177e4SLinus Torvalds 	/* See ftdi_sio.h for description of what is reset */
13661da177e4SLinus Torvalds 	usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
13671da177e4SLinus Torvalds 			FTDI_SIO_RESET_REQUEST, FTDI_SIO_RESET_REQUEST_TYPE,
13681da177e4SLinus Torvalds 			FTDI_SIO_RESET_SIO,
13691da177e4SLinus Torvalds 			priv->interface, buf, 0, WDR_TIMEOUT);
13701da177e4SLinus Torvalds 
13711da177e4SLinus Torvalds 	/* Termios defaults are set by usb_serial_init. We don't change
13721da177e4SLinus Torvalds 	   port->tty->termios - this would loose speed settings, etc.
13731da177e4SLinus Torvalds 	   This is same behaviour as serial.c/rs_open() - Kuba */
13741da177e4SLinus Torvalds 
13751da177e4SLinus Torvalds 	/* ftdi_set_termios  will send usb control messages */
137657845bd1SGuennadi Liakhovetski 	if (port->tty)
137757845bd1SGuennadi Liakhovetski 		ftdi_set_termios(port, NULL);
13781da177e4SLinus Torvalds 
13791da177e4SLinus Torvalds 	/* FIXME: Flow control might be enabled, so it should be checked -
13801da177e4SLinus Torvalds 	   we have no control of defaults! */
13811da177e4SLinus Torvalds 	/* Turn on RTS and DTR since we are not flow controlling by default */
138274ede0ffSIan Abbott 	set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
13831da177e4SLinus Torvalds 
13841da177e4SLinus Torvalds 	/* Not throttled */
13851da177e4SLinus Torvalds 	spin_lock_irqsave(&priv->rx_lock, flags);
13861da177e4SLinus Torvalds 	priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
13871da177e4SLinus Torvalds 	spin_unlock_irqrestore(&priv->rx_lock, flags);
13881da177e4SLinus Torvalds 
13891da177e4SLinus Torvalds 	/* Start reading from the device */
139076854ceaSIan Abbott 	priv->rx_processed = 0;
13911da177e4SLinus Torvalds 	usb_fill_bulk_urb(port->read_urb, dev,
13921da177e4SLinus Torvalds 		      usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress),
13931da177e4SLinus Torvalds 		      port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
13941da177e4SLinus Torvalds 		      ftdi_read_bulk_callback, port);
13951da177e4SLinus Torvalds 	result = usb_submit_urb(port->read_urb, GFP_KERNEL);
13961da177e4SLinus Torvalds 	if (result)
13971da177e4SLinus Torvalds 		err("%s - failed submitting read urb, error %d", __FUNCTION__, result);
13981da177e4SLinus Torvalds 
13991da177e4SLinus Torvalds 
14001da177e4SLinus Torvalds 	return result;
14011da177e4SLinus Torvalds } /* ftdi_open */
14021da177e4SLinus Torvalds 
14031da177e4SLinus Torvalds 
14041da177e4SLinus Torvalds 
14051da177e4SLinus Torvalds /*
14061da177e4SLinus Torvalds  * usbserial:__serial_close  only calls ftdi_close if the point is open
14071da177e4SLinus Torvalds  *
14081da177e4SLinus Torvalds  *   This only gets called when it is the last close
14091da177e4SLinus Torvalds  *
14101da177e4SLinus Torvalds  *
14111da177e4SLinus Torvalds  */
14121da177e4SLinus Torvalds 
14131da177e4SLinus Torvalds static void ftdi_close (struct usb_serial_port *port, struct file *filp)
14141da177e4SLinus Torvalds { /* ftdi_close */
14151da177e4SLinus Torvalds 	unsigned int c_cflag = port->tty->termios->c_cflag;
14161da177e4SLinus Torvalds 	struct ftdi_private *priv = usb_get_serial_port_data(port);
14171da177e4SLinus Torvalds 	char buf[1];
14181da177e4SLinus Torvalds 
14191da177e4SLinus Torvalds 	dbg("%s", __FUNCTION__);
14201da177e4SLinus Torvalds 
14211da177e4SLinus Torvalds 	if (c_cflag & HUPCL){
14221da177e4SLinus Torvalds 		/* Disable flow control */
14231da177e4SLinus Torvalds 		if (usb_control_msg(port->serial->dev,
14241da177e4SLinus Torvalds 				    usb_sndctrlpipe(port->serial->dev, 0),
14251da177e4SLinus Torvalds 				    FTDI_SIO_SET_FLOW_CTRL_REQUEST,
14261da177e4SLinus Torvalds 				    FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
14271da177e4SLinus Torvalds 				    0, priv->interface, buf, 0,
14281da177e4SLinus Torvalds 				    WDR_TIMEOUT) < 0) {
14291da177e4SLinus Torvalds 			err("error from flowcontrol urb");
14301da177e4SLinus Torvalds 		}
14311da177e4SLinus Torvalds 
143274ede0ffSIan Abbott 		/* drop RTS and DTR */
143374ede0ffSIan Abbott 		clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
14341da177e4SLinus Torvalds 	} /* Note change no line if hupcl is off */
14351da177e4SLinus Torvalds 
143676854ceaSIan Abbott 	/* cancel any scheduled reading */
143776854ceaSIan Abbott 	cancel_delayed_work(&priv->rx_work);
143876854ceaSIan Abbott 	flush_scheduled_work();
143976854ceaSIan Abbott 
14401da177e4SLinus Torvalds 	/* shutdown our bulk read */
14411da177e4SLinus Torvalds 	usb_kill_urb(port->read_urb);
14421da177e4SLinus Torvalds } /* ftdi_close */
14431da177e4SLinus Torvalds 
14441da177e4SLinus Torvalds 
14451da177e4SLinus Torvalds 
14461da177e4SLinus Torvalds /* The SIO requires the first byte to have:
14471da177e4SLinus Torvalds  *  B0 1
14481da177e4SLinus Torvalds  *  B1 0
14491da177e4SLinus Torvalds  *  B2..7 length of message excluding byte 0
14501da177e4SLinus Torvalds  *
14511da177e4SLinus Torvalds  * The new devices do not require this byte
14521da177e4SLinus Torvalds  */
14531da177e4SLinus Torvalds static int ftdi_write (struct usb_serial_port *port,
14541da177e4SLinus Torvalds 			   const unsigned char *buf, int count)
14551da177e4SLinus Torvalds { /* ftdi_write */
14561da177e4SLinus Torvalds 	struct ftdi_private *priv = usb_get_serial_port_data(port);
14571da177e4SLinus Torvalds 	struct urb *urb;
14581da177e4SLinus Torvalds 	unsigned char *buffer;
14591da177e4SLinus Torvalds 	int data_offset ;       /* will be 1 for the SIO and 0 otherwise */
14601da177e4SLinus Torvalds 	int status;
14611da177e4SLinus Torvalds 	int transfer_size;
146222465400SIan Abbott 	unsigned long flags;
14631da177e4SLinus Torvalds 
14641da177e4SLinus Torvalds 	dbg("%s port %d, %d bytes", __FUNCTION__, port->number, count);
14651da177e4SLinus Torvalds 
14661da177e4SLinus Torvalds 	if (count == 0) {
14671da177e4SLinus Torvalds 		dbg("write request of 0 bytes");
14681da177e4SLinus Torvalds 		return 0;
14691da177e4SLinus Torvalds 	}
147022465400SIan Abbott 	spin_lock_irqsave(&priv->tx_lock, flags);
147122465400SIan Abbott 	if (priv->tx_outstanding_urbs > URB_UPPER_LIMIT) {
147222465400SIan Abbott 		spin_unlock_irqrestore(&priv->tx_lock, flags);
147322465400SIan Abbott 		dbg("%s - write limit hit\n", __FUNCTION__);
147422465400SIan Abbott 		return 0;
147522465400SIan Abbott 	}
147662127a58SOliver Neukum 	priv->tx_outstanding_urbs++;
147722465400SIan Abbott 	spin_unlock_irqrestore(&priv->tx_lock, flags);
14781da177e4SLinus Torvalds 
14791da177e4SLinus Torvalds 	data_offset = priv->write_offset;
14801da177e4SLinus Torvalds         dbg("data_offset set to %d",data_offset);
14811da177e4SLinus Torvalds 
14821da177e4SLinus Torvalds 	/* Determine total transfer size */
14831da177e4SLinus Torvalds 	transfer_size = count;
14841da177e4SLinus Torvalds 	if (data_offset > 0) {
14851da177e4SLinus Torvalds 		/* Original sio needs control bytes too... */
14861da177e4SLinus Torvalds 		transfer_size += (data_offset *
14871da177e4SLinus Torvalds 				((count + (PKTSZ - 1 - data_offset)) /
14881da177e4SLinus Torvalds 				 (PKTSZ - data_offset)));
14891da177e4SLinus Torvalds 	}
14901da177e4SLinus Torvalds 
14911da177e4SLinus Torvalds 	buffer = kmalloc (transfer_size, GFP_ATOMIC);
14921da177e4SLinus Torvalds 	if (!buffer) {
14931da177e4SLinus Torvalds 		err("%s ran out of kernel memory for urb ...", __FUNCTION__);
149462127a58SOliver Neukum 		count = -ENOMEM;
149562127a58SOliver Neukum 		goto error_no_buffer;
14961da177e4SLinus Torvalds 	}
14971da177e4SLinus Torvalds 
14981da177e4SLinus Torvalds 	urb = usb_alloc_urb(0, GFP_ATOMIC);
14991da177e4SLinus Torvalds 	if (!urb) {
15001da177e4SLinus Torvalds 		err("%s - no more free urbs", __FUNCTION__);
150162127a58SOliver Neukum 		count = -ENOMEM;
150262127a58SOliver Neukum 		goto error_no_urb;
15031da177e4SLinus Torvalds 	}
15041da177e4SLinus Torvalds 
15051da177e4SLinus Torvalds 	/* Copy data */
15061da177e4SLinus Torvalds 	if (data_offset > 0) {
15071da177e4SLinus Torvalds 		/* Original sio requires control byte at start of each packet. */
15081da177e4SLinus Torvalds 		int user_pktsz = PKTSZ - data_offset;
15091da177e4SLinus Torvalds 		int todo = count;
15101da177e4SLinus Torvalds 		unsigned char *first_byte = buffer;
15111da177e4SLinus Torvalds 		const unsigned char *current_position = buf;
15121da177e4SLinus Torvalds 
15131da177e4SLinus Torvalds 		while (todo > 0) {
15141da177e4SLinus Torvalds 			if (user_pktsz > todo) {
15151da177e4SLinus Torvalds 				user_pktsz = todo;
15161da177e4SLinus Torvalds 			}
15171da177e4SLinus Torvalds 			/* Write the control byte at the front of the packet*/
15181da177e4SLinus Torvalds 			*first_byte = 1 | ((user_pktsz) << 2);
15191da177e4SLinus Torvalds 			/* Copy data for packet */
15201da177e4SLinus Torvalds 			memcpy (first_byte + data_offset,
15211da177e4SLinus Torvalds 				current_position, user_pktsz);
15221da177e4SLinus Torvalds 			first_byte += user_pktsz + data_offset;
15231da177e4SLinus Torvalds 			current_position += user_pktsz;
15241da177e4SLinus Torvalds 			todo -= user_pktsz;
15251da177e4SLinus Torvalds 		}
15261da177e4SLinus Torvalds 	} else {
15271da177e4SLinus Torvalds 		/* No control byte required. */
15281da177e4SLinus Torvalds 		/* Copy in the data to send */
15291da177e4SLinus Torvalds 		memcpy (buffer, buf, count);
15301da177e4SLinus Torvalds 	}
15311da177e4SLinus Torvalds 
15321da177e4SLinus Torvalds 	usb_serial_debug_data(debug, &port->dev, __FUNCTION__, transfer_size, buffer);
15331da177e4SLinus Torvalds 
15341da177e4SLinus Torvalds 	/* fill the buffer and send it */
15351da177e4SLinus Torvalds 	usb_fill_bulk_urb(urb, port->serial->dev,
15361da177e4SLinus Torvalds 		      usb_sndbulkpipe(port->serial->dev, port->bulk_out_endpointAddress),
15371da177e4SLinus Torvalds 		      buffer, transfer_size,
15381da177e4SLinus Torvalds 		      ftdi_write_bulk_callback, port);
15391da177e4SLinus Torvalds 
15401da177e4SLinus Torvalds 	status = usb_submit_urb(urb, GFP_ATOMIC);
15411da177e4SLinus Torvalds 	if (status) {
15421da177e4SLinus Torvalds 		err("%s - failed submitting write urb, error %d", __FUNCTION__, status);
15431da177e4SLinus Torvalds 		count = status;
154462127a58SOliver Neukum 		goto error;
154522465400SIan Abbott 	} else {
154622465400SIan Abbott 		spin_lock_irqsave(&priv->tx_lock, flags);
154722465400SIan Abbott 		priv->tx_outstanding_bytes += count;
154822465400SIan Abbott 		priv->tx_bytes += count;
154922465400SIan Abbott 		spin_unlock_irqrestore(&priv->tx_lock, flags);
15501da177e4SLinus Torvalds 	}
15511da177e4SLinus Torvalds 
15521da177e4SLinus Torvalds 	/* we are done with this urb, so let the host driver
15531da177e4SLinus Torvalds 	 * really free it when it is finished with it */
15541da177e4SLinus Torvalds 	usb_free_urb(urb);
15551da177e4SLinus Torvalds 
15561da177e4SLinus Torvalds 	dbg("%s write returning: %d", __FUNCTION__, count);
15571da177e4SLinus Torvalds 	return count;
155862127a58SOliver Neukum error:
155962127a58SOliver Neukum 	usb_free_urb(urb);
156062127a58SOliver Neukum error_no_urb:
156162127a58SOliver Neukum 	kfree (buffer);
156262127a58SOliver Neukum error_no_buffer:
156362127a58SOliver Neukum 	spin_lock_irqsave(&priv->tx_lock, flags);
156462127a58SOliver Neukum 	priv->tx_outstanding_urbs--;
156562127a58SOliver Neukum 	spin_unlock_irqrestore(&priv->tx_lock, flags);
156662127a58SOliver Neukum 	return count;
15671da177e4SLinus Torvalds } /* ftdi_write */
15681da177e4SLinus Torvalds 
15691da177e4SLinus Torvalds 
15701da177e4SLinus Torvalds /* This function may get called when the device is closed */
15711da177e4SLinus Torvalds 
15727d12e780SDavid Howells static void ftdi_write_bulk_callback (struct urb *urb)
15731da177e4SLinus Torvalds {
157422465400SIan Abbott 	unsigned long flags;
15751da177e4SLinus Torvalds 	struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
157622465400SIan Abbott 	struct ftdi_private *priv;
157722465400SIan Abbott 	int data_offset;       /* will be 1 for the SIO and 0 otherwise */
157822465400SIan Abbott 	unsigned long countback;
15791da177e4SLinus Torvalds 
15801da177e4SLinus Torvalds 	/* free up the transfer buffer, as usb_free_urb() does not do this */
15811da177e4SLinus Torvalds 	kfree (urb->transfer_buffer);
15821da177e4SLinus Torvalds 
15831da177e4SLinus Torvalds 	dbg("%s - port %d", __FUNCTION__, port->number);
15841da177e4SLinus Torvalds 
15851da177e4SLinus Torvalds 	if (urb->status) {
15861da177e4SLinus Torvalds 		dbg("nonzero write bulk status received: %d", urb->status);
15871da177e4SLinus Torvalds 		return;
15881da177e4SLinus Torvalds 	}
15891da177e4SLinus Torvalds 
159022465400SIan Abbott 	priv = usb_get_serial_port_data(port);
159122465400SIan Abbott 	if (!priv) {
159222465400SIan Abbott 		dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
159322465400SIan Abbott 		return;
159422465400SIan Abbott 	}
159522465400SIan Abbott 	/* account for transferred data */
159622465400SIan Abbott 	countback = urb->actual_length;
159722465400SIan Abbott 	data_offset = priv->write_offset;
159822465400SIan Abbott 	if (data_offset > 0) {
159922465400SIan Abbott 		/* Subtract the control bytes */
160022465400SIan Abbott 		countback -= (data_offset * ((countback + (PKTSZ - 1)) / PKTSZ));
160122465400SIan Abbott 	}
160222465400SIan Abbott 	spin_lock_irqsave(&priv->tx_lock, flags);
160322465400SIan Abbott 	--priv->tx_outstanding_urbs;
160422465400SIan Abbott 	priv->tx_outstanding_bytes -= countback;
160522465400SIan Abbott 	spin_unlock_irqrestore(&priv->tx_lock, flags);
160622465400SIan Abbott 
1607cf2c7481SPete Zaitcev 	usb_serial_port_softint(port);
16081da177e4SLinus Torvalds } /* ftdi_write_bulk_callback */
16091da177e4SLinus Torvalds 
16101da177e4SLinus Torvalds 
16111da177e4SLinus Torvalds static int ftdi_write_room( struct usb_serial_port *port )
16121da177e4SLinus Torvalds {
161322465400SIan Abbott 	struct ftdi_private *priv = usb_get_serial_port_data(port);
161422465400SIan Abbott 	int room;
161522465400SIan Abbott 	unsigned long flags;
161622465400SIan Abbott 
16171da177e4SLinus Torvalds 	dbg("%s - port %d", __FUNCTION__, port->number);
16181da177e4SLinus Torvalds 
161922465400SIan Abbott 	spin_lock_irqsave(&priv->tx_lock, flags);
162022465400SIan Abbott 	if (priv->tx_outstanding_urbs < URB_UPPER_LIMIT) {
16211da177e4SLinus Torvalds 		/*
16221da177e4SLinus Torvalds 		 * We really can take anything the user throws at us
16231da177e4SLinus Torvalds 		 * but let's pick a nice big number to tell the tty
16241da177e4SLinus Torvalds 		 * layer that we have lots of free space
16251da177e4SLinus Torvalds 		 */
162622465400SIan Abbott 		room = 2048;
162722465400SIan Abbott 	} else {
162822465400SIan Abbott 		room = 0;
162922465400SIan Abbott 	}
163022465400SIan Abbott 	spin_unlock_irqrestore(&priv->tx_lock, flags);
163122465400SIan Abbott 	return room;
16321da177e4SLinus Torvalds } /* ftdi_write_room */
16331da177e4SLinus Torvalds 
16341da177e4SLinus Torvalds 
16351da177e4SLinus Torvalds static int ftdi_chars_in_buffer (struct usb_serial_port *port)
16361da177e4SLinus Torvalds { /* ftdi_chars_in_buffer */
163722465400SIan Abbott 	struct ftdi_private *priv = usb_get_serial_port_data(port);
163822465400SIan Abbott 	int buffered;
163922465400SIan Abbott 	unsigned long flags;
164022465400SIan Abbott 
16411da177e4SLinus Torvalds 	dbg("%s - port %d", __FUNCTION__, port->number);
16421da177e4SLinus Torvalds 
164322465400SIan Abbott 	spin_lock_irqsave(&priv->tx_lock, flags);
164422465400SIan Abbott 	buffered = (int)priv->tx_outstanding_bytes;
164522465400SIan Abbott 	spin_unlock_irqrestore(&priv->tx_lock, flags);
164622465400SIan Abbott 	if (buffered < 0) {
164722465400SIan Abbott 		err("%s outstanding tx bytes is negative!", __FUNCTION__);
164822465400SIan Abbott 		buffered = 0;
164922465400SIan Abbott 	}
165022465400SIan Abbott 	return buffered;
16511da177e4SLinus Torvalds } /* ftdi_chars_in_buffer */
16521da177e4SLinus Torvalds 
16531da177e4SLinus Torvalds 
16541da177e4SLinus Torvalds 
16557d12e780SDavid Howells static void ftdi_read_bulk_callback (struct urb *urb)
16561da177e4SLinus Torvalds { /* ftdi_read_bulk_callback */
16571da177e4SLinus Torvalds 	struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
16581da177e4SLinus Torvalds 	struct tty_struct *tty;
16591da177e4SLinus Torvalds 	struct ftdi_private *priv;
166022465400SIan Abbott 	unsigned long countread;
166122465400SIan Abbott 	unsigned long flags;
16621da177e4SLinus Torvalds 
16631da177e4SLinus Torvalds 	if (urb->number_of_packets > 0) {
16641da177e4SLinus Torvalds 		err("%s transfer_buffer_length %d actual_length %d number of packets %d",__FUNCTION__,
16651da177e4SLinus Torvalds 		    urb->transfer_buffer_length, urb->actual_length, urb->number_of_packets );
16661da177e4SLinus Torvalds 		err("%s transfer_flags %x ", __FUNCTION__,urb->transfer_flags );
16671da177e4SLinus Torvalds 	}
16681da177e4SLinus Torvalds 
16691da177e4SLinus Torvalds 	dbg("%s - port %d", __FUNCTION__, port->number);
16701da177e4SLinus Torvalds 
16711da177e4SLinus Torvalds 	if (port->open_count <= 0)
16721da177e4SLinus Torvalds 		return;
16731da177e4SLinus Torvalds 
16741da177e4SLinus Torvalds 	tty = port->tty;
16751da177e4SLinus Torvalds 	if (!tty) {
16761da177e4SLinus Torvalds 		dbg("%s - bad tty pointer - exiting",__FUNCTION__);
16771da177e4SLinus Torvalds 		return;
16781da177e4SLinus Torvalds 	}
16791da177e4SLinus Torvalds 
16801da177e4SLinus Torvalds 	priv = usb_get_serial_port_data(port);
16811da177e4SLinus Torvalds 	if (!priv) {
16821da177e4SLinus Torvalds 		dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
16831da177e4SLinus Torvalds 		return;
16841da177e4SLinus Torvalds 	}
16851da177e4SLinus Torvalds 
16861da177e4SLinus Torvalds 	if (urb != port->read_urb) {
16871da177e4SLinus Torvalds 		err("%s - Not my urb!", __FUNCTION__);
16881da177e4SLinus Torvalds 	}
16891da177e4SLinus Torvalds 
16901da177e4SLinus Torvalds 	if (urb->status) {
16911da177e4SLinus Torvalds 		/* This will happen at close every time so it is a dbg not an err */
16921da177e4SLinus Torvalds 		dbg("(this is ok on close) nonzero read bulk status received: %d", urb->status);
16931da177e4SLinus Torvalds 		return;
16941da177e4SLinus Torvalds 	}
16951da177e4SLinus Torvalds 
169622465400SIan Abbott 	/* count data bytes, but not status bytes */
169722465400SIan Abbott 	countread = urb->actual_length;
169822465400SIan Abbott 	countread -= 2 * ((countread + (PKTSZ - 1)) / PKTSZ);
169922465400SIan Abbott 	spin_lock_irqsave(&priv->rx_lock, flags);
170022465400SIan Abbott 	priv->rx_bytes += countread;
170122465400SIan Abbott 	spin_unlock_irqrestore(&priv->rx_lock, flags);
170222465400SIan Abbott 
1703c4028958SDavid Howells 	ftdi_process_read(&priv->rx_work.work);
17041da177e4SLinus Torvalds 
17051da177e4SLinus Torvalds } /* ftdi_read_bulk_callback */
17061da177e4SLinus Torvalds 
17071da177e4SLinus Torvalds 
1708c4028958SDavid Howells static void ftdi_process_read (struct work_struct *work)
17091da177e4SLinus Torvalds { /* ftdi_process_read */
1710c4028958SDavid Howells 	struct ftdi_private *priv =
1711c4028958SDavid Howells 		container_of(work, struct ftdi_private, rx_work.work);
1712c4028958SDavid Howells 	struct usb_serial_port *port = priv->port;
17131da177e4SLinus Torvalds 	struct urb *urb;
17141da177e4SLinus Torvalds 	struct tty_struct *tty;
17151da177e4SLinus Torvalds 	char error_flag;
17161da177e4SLinus Torvalds 	unsigned char *data;
17171da177e4SLinus Torvalds 
17181da177e4SLinus Torvalds 	int i;
17191da177e4SLinus Torvalds 	int result;
17201da177e4SLinus Torvalds 	int need_flip;
17211da177e4SLinus Torvalds 	int packet_offset;
172276854ceaSIan Abbott 	unsigned long flags;
17231da177e4SLinus Torvalds 
17241da177e4SLinus Torvalds 	dbg("%s - port %d", __FUNCTION__, port->number);
17251da177e4SLinus Torvalds 
17261da177e4SLinus Torvalds 	if (port->open_count <= 0)
17271da177e4SLinus Torvalds 		return;
17281da177e4SLinus Torvalds 
17291da177e4SLinus Torvalds 	tty = port->tty;
17301da177e4SLinus Torvalds 	if (!tty) {
17311da177e4SLinus Torvalds 		dbg("%s - bad tty pointer - exiting",__FUNCTION__);
17321da177e4SLinus Torvalds 		return;
17331da177e4SLinus Torvalds 	}
17341da177e4SLinus Torvalds 
17351da177e4SLinus Torvalds 	priv = usb_get_serial_port_data(port);
17361da177e4SLinus Torvalds 	if (!priv) {
17371da177e4SLinus Torvalds 		dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
17381da177e4SLinus Torvalds 		return;
17391da177e4SLinus Torvalds 	}
17401da177e4SLinus Torvalds 
17411da177e4SLinus Torvalds 	urb = port->read_urb;
17421da177e4SLinus Torvalds 	if (!urb) {
17431da177e4SLinus Torvalds 		dbg("%s - bad read_urb pointer - exiting", __FUNCTION__);
17441da177e4SLinus Torvalds 		return;
17451da177e4SLinus Torvalds 	}
17461da177e4SLinus Torvalds 
17471da177e4SLinus Torvalds 	data = urb->transfer_buffer;
17481da177e4SLinus Torvalds 
174976854ceaSIan Abbott 	if (priv->rx_processed) {
175076854ceaSIan Abbott 		dbg("%s - already processed: %d bytes, %d remain", __FUNCTION__,
175176854ceaSIan Abbott 				priv->rx_processed,
175276854ceaSIan Abbott 				urb->actual_length - priv->rx_processed);
175376854ceaSIan Abbott 	} else {
17541da177e4SLinus Torvalds 		/* The first two bytes of every read packet are status */
17551da177e4SLinus Torvalds 		if (urb->actual_length > 2) {
17561da177e4SLinus Torvalds 			usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
17571da177e4SLinus Torvalds 		} else {
17581da177e4SLinus Torvalds 			dbg("Status only: %03oo %03oo",data[0],data[1]);
17591da177e4SLinus Torvalds 		}
176076854ceaSIan Abbott 	}
17611da177e4SLinus Torvalds 
17621da177e4SLinus Torvalds 
17631da177e4SLinus Torvalds 	/* TO DO -- check for hung up line and handle appropriately: */
17641da177e4SLinus Torvalds 	/*   send hangup  */
17651da177e4SLinus Torvalds 	/* See acm.c - you do a tty_hangup  - eg tty_hangup(tty) */
17661da177e4SLinus Torvalds 	/* if CD is dropped and the line is not CLOCAL then we should hangup */
17671da177e4SLinus Torvalds 
17681da177e4SLinus Torvalds 	need_flip = 0;
176976854ceaSIan Abbott 	for (packet_offset = priv->rx_processed; packet_offset < urb->actual_length; packet_offset += PKTSZ) {
177076854ceaSIan Abbott 		int length;
177176854ceaSIan Abbott 
17721da177e4SLinus Torvalds 		/* Compare new line status to the old one, signal if different */
177376854ceaSIan Abbott 		/* N.B. packet may be processed more than once, but differences
177476854ceaSIan Abbott 		 * are only processed once.  */
17751da177e4SLinus Torvalds 		if (priv != NULL) {
17761da177e4SLinus Torvalds 			char new_status = data[packet_offset+0] & FTDI_STATUS_B0_MASK;
17771da177e4SLinus Torvalds 			if (new_status != priv->prev_status) {
17781da177e4SLinus Torvalds 				priv->diff_status |= new_status ^ priv->prev_status;
17791da177e4SLinus Torvalds 				wake_up_interruptible(&priv->delta_msr_wait);
17801da177e4SLinus Torvalds 				priv->prev_status = new_status;
17811da177e4SLinus Torvalds 			}
17821da177e4SLinus Torvalds 		}
17831da177e4SLinus Torvalds 
178476854ceaSIan Abbott 		length = min(PKTSZ, urb->actual_length-packet_offset)-2;
178576854ceaSIan Abbott 		if (length < 0) {
178676854ceaSIan Abbott 			err("%s - bad packet length: %d", __FUNCTION__, length+2);
178776854ceaSIan Abbott 			length = 0;
178876854ceaSIan Abbott 		}
178976854ceaSIan Abbott 
179076854ceaSIan Abbott 		if (priv->rx_flags & THROTTLED) {
179176854ceaSIan Abbott 			dbg("%s - throttled", __FUNCTION__);
179276854ceaSIan Abbott 			break;
179376854ceaSIan Abbott 		}
179433f0f88fSAlan Cox 		if (tty_buffer_request_room(tty, length) < length) {
179576854ceaSIan Abbott 			/* break out & wait for throttling/unthrottling to happen */
179676854ceaSIan Abbott 			dbg("%s - receive room low", __FUNCTION__);
179776854ceaSIan Abbott 			break;
179876854ceaSIan Abbott 		}
179976854ceaSIan Abbott 
18001da177e4SLinus Torvalds 		/* Handle errors and break */
18011da177e4SLinus Torvalds 		error_flag = TTY_NORMAL;
18021da177e4SLinus Torvalds 		/* Although the device uses a bitmask and hence can have multiple */
18031da177e4SLinus Torvalds 		/* errors on a packet - the order here sets the priority the */
18041da177e4SLinus Torvalds 		/* error is returned to the tty layer  */
18051da177e4SLinus Torvalds 
18061da177e4SLinus Torvalds 		if ( data[packet_offset+1] & FTDI_RS_OE ) {
18071da177e4SLinus Torvalds 			error_flag = TTY_OVERRUN;
18081da177e4SLinus Torvalds 			dbg("OVERRRUN error");
18091da177e4SLinus Torvalds 		}
18101da177e4SLinus Torvalds 		if ( data[packet_offset+1] & FTDI_RS_BI ) {
18111da177e4SLinus Torvalds 			error_flag = TTY_BREAK;
18121da177e4SLinus Torvalds 			dbg("BREAK received");
18131da177e4SLinus Torvalds 		}
18141da177e4SLinus Torvalds 		if ( data[packet_offset+1] & FTDI_RS_PE ) {
18151da177e4SLinus Torvalds 			error_flag = TTY_PARITY;
18161da177e4SLinus Torvalds 			dbg("PARITY error");
18171da177e4SLinus Torvalds 		}
18181da177e4SLinus Torvalds 		if ( data[packet_offset+1] & FTDI_RS_FE ) {
18191da177e4SLinus Torvalds 			error_flag = TTY_FRAME;
18201da177e4SLinus Torvalds 			dbg("FRAMING error");
18211da177e4SLinus Torvalds 		}
182276854ceaSIan Abbott 		if (length > 0) {
182376854ceaSIan Abbott 			for (i = 2; i < length+2; i++) {
18241da177e4SLinus Torvalds 				/* Note that the error flag is duplicated for
18251da177e4SLinus Torvalds 				   every character received since we don't know
18261da177e4SLinus Torvalds 				   which character it applied to */
18271da177e4SLinus Torvalds 				tty_insert_flip_char(tty, data[packet_offset+i], error_flag);
18281da177e4SLinus Torvalds 			}
18291da177e4SLinus Torvalds 			need_flip = 1;
18301da177e4SLinus Torvalds 		}
18311da177e4SLinus Torvalds 
18321da177e4SLinus Torvalds #ifdef NOT_CORRECT_BUT_KEEPING_IT_FOR_NOW
18331da177e4SLinus Torvalds 		/* if a parity error is detected you get status packets forever
18341da177e4SLinus Torvalds 		   until a character is sent without a parity error.
18351da177e4SLinus Torvalds 		   This doesn't work well since the application receives a never
18361da177e4SLinus Torvalds 		   ending stream of bad data - even though new data hasn't been sent.
18371da177e4SLinus Torvalds 		   Therefore I (bill) have taken this out.
18381da177e4SLinus Torvalds 		   However - this might make sense for framing errors and so on
18391da177e4SLinus Torvalds 		   so I am leaving the code in for now.
18401da177e4SLinus Torvalds 		*/
18411da177e4SLinus Torvalds 		else {
18421da177e4SLinus Torvalds 			if (error_flag != TTY_NORMAL){
18431da177e4SLinus Torvalds 				dbg("error_flag is not normal");
18441da177e4SLinus Torvalds 				/* In this case it is just status - if that is an error send a bad character */
18451da177e4SLinus Torvalds 				if(tty->flip.count >= TTY_FLIPBUF_SIZE) {
18461da177e4SLinus Torvalds 					tty_flip_buffer_push(tty);
18471da177e4SLinus Torvalds 				}
18481da177e4SLinus Torvalds 				tty_insert_flip_char(tty, 0xff, error_flag);
18491da177e4SLinus Torvalds 				need_flip = 1;
18501da177e4SLinus Torvalds 			}
18511da177e4SLinus Torvalds 		}
18521da177e4SLinus Torvalds #endif
18531da177e4SLinus Torvalds 	} /* "for(packet_offset=0..." */
18541da177e4SLinus Torvalds 
18551da177e4SLinus Torvalds 	/* Low latency */
18561da177e4SLinus Torvalds 	if (need_flip) {
18571da177e4SLinus Torvalds 		tty_flip_buffer_push(tty);
18581da177e4SLinus Torvalds 	}
18591da177e4SLinus Torvalds 
186076854ceaSIan Abbott 	if (packet_offset < urb->actual_length) {
186176854ceaSIan Abbott 		/* not completely processed - record progress */
186276854ceaSIan Abbott 		priv->rx_processed = packet_offset;
186376854ceaSIan Abbott 		dbg("%s - incomplete, %d bytes processed, %d remain",
186476854ceaSIan Abbott 				__FUNCTION__, packet_offset,
186576854ceaSIan Abbott 				urb->actual_length - packet_offset);
186676854ceaSIan Abbott 		/* check if we were throttled while processing */
186776854ceaSIan Abbott 		spin_lock_irqsave(&priv->rx_lock, flags);
186876854ceaSIan Abbott 		if (priv->rx_flags & THROTTLED) {
186976854ceaSIan Abbott 			priv->rx_flags |= ACTUALLY_THROTTLED;
187076854ceaSIan Abbott 			spin_unlock_irqrestore(&priv->rx_lock, flags);
187176854ceaSIan Abbott 			dbg("%s - deferring remainder until unthrottled",
187276854ceaSIan Abbott 					__FUNCTION__);
187376854ceaSIan Abbott 			return;
187476854ceaSIan Abbott 		}
187576854ceaSIan Abbott 		spin_unlock_irqrestore(&priv->rx_lock, flags);
187676854ceaSIan Abbott 		/* if the port is closed stop trying to read */
187776854ceaSIan Abbott 		if (port->open_count > 0){
187876854ceaSIan Abbott 			/* delay processing of remainder */
187976854ceaSIan Abbott 			schedule_delayed_work(&priv->rx_work, 1);
188076854ceaSIan Abbott 		} else {
188176854ceaSIan Abbott 			dbg("%s - port is closed", __FUNCTION__);
188276854ceaSIan Abbott 		}
188376854ceaSIan Abbott 		return;
188476854ceaSIan Abbott 	}
188576854ceaSIan Abbott 
188676854ceaSIan Abbott 	/* urb is completely processed */
188776854ceaSIan Abbott 	priv->rx_processed = 0;
188876854ceaSIan Abbott 
18891da177e4SLinus Torvalds 	/* if the port is closed stop trying to read */
18901da177e4SLinus Torvalds 	if (port->open_count > 0){
18911da177e4SLinus Torvalds 		/* Continue trying to always read  */
18921da177e4SLinus Torvalds 		usb_fill_bulk_urb(port->read_urb, port->serial->dev,
18931da177e4SLinus Torvalds 			      usb_rcvbulkpipe(port->serial->dev, port->bulk_in_endpointAddress),
18941da177e4SLinus Torvalds 			      port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
18951da177e4SLinus Torvalds 			      ftdi_read_bulk_callback, port);
18961da177e4SLinus Torvalds 
18971da177e4SLinus Torvalds 		result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
18981da177e4SLinus Torvalds 		if (result)
18991da177e4SLinus Torvalds 			err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
19001da177e4SLinus Torvalds 	}
19011da177e4SLinus Torvalds 
19021da177e4SLinus Torvalds 	return;
19031da177e4SLinus Torvalds } /* ftdi_process_read */
19041da177e4SLinus Torvalds 
19051da177e4SLinus Torvalds 
19061da177e4SLinus Torvalds static void ftdi_break_ctl( struct usb_serial_port *port, int break_state )
19071da177e4SLinus Torvalds {
19081da177e4SLinus Torvalds 	struct ftdi_private *priv = usb_get_serial_port_data(port);
19091da177e4SLinus Torvalds 	__u16 urb_value = 0;
19101da177e4SLinus Torvalds 	char buf[1];
19111da177e4SLinus Torvalds 
19121da177e4SLinus Torvalds 	/* break_state = -1 to turn on break, and 0 to turn off break */
19131da177e4SLinus Torvalds 	/* see drivers/char/tty_io.c to see it used */
19141da177e4SLinus Torvalds 	/* last_set_data_urb_value NEVER has the break bit set in it */
19151da177e4SLinus Torvalds 
19161da177e4SLinus Torvalds 	if (break_state) {
19171da177e4SLinus Torvalds 		urb_value = priv->last_set_data_urb_value | FTDI_SIO_SET_BREAK;
19181da177e4SLinus Torvalds 	} else {
19191da177e4SLinus Torvalds 		urb_value = priv->last_set_data_urb_value;
19201da177e4SLinus Torvalds 	}
19211da177e4SLinus Torvalds 
19221da177e4SLinus Torvalds 
19231da177e4SLinus Torvalds 	if (usb_control_msg(port->serial->dev, usb_sndctrlpipe(port->serial->dev, 0),
19241da177e4SLinus Torvalds 			    FTDI_SIO_SET_DATA_REQUEST,
19251da177e4SLinus Torvalds 			    FTDI_SIO_SET_DATA_REQUEST_TYPE,
19261da177e4SLinus Torvalds 			    urb_value , priv->interface,
19271da177e4SLinus Torvalds 			    buf, 0, WDR_TIMEOUT) < 0) {
19281da177e4SLinus Torvalds 		err("%s FAILED to enable/disable break state (state was %d)", __FUNCTION__,break_state);
19291da177e4SLinus Torvalds 	}
19301da177e4SLinus Torvalds 
19311da177e4SLinus Torvalds 	dbg("%s break state is %d - urb is %d", __FUNCTION__,break_state, urb_value);
19321da177e4SLinus Torvalds 
19331da177e4SLinus Torvalds }
19341da177e4SLinus Torvalds 
19351da177e4SLinus Torvalds 
19361da177e4SLinus Torvalds /* old_termios contains the original termios settings and tty->termios contains
19371da177e4SLinus Torvalds  * the new setting to be used
19381da177e4SLinus Torvalds  * WARNING: set_termios calls this with old_termios in kernel space
19391da177e4SLinus Torvalds  */
19401da177e4SLinus Torvalds 
1941606d099cSAlan Cox static void ftdi_set_termios (struct usb_serial_port *port, struct ktermios *old_termios)
19421da177e4SLinus Torvalds { /* ftdi_termios */
19431da177e4SLinus Torvalds 	struct usb_device *dev = port->serial->dev;
19441da177e4SLinus Torvalds 	unsigned int cflag = port->tty->termios->c_cflag;
19451da177e4SLinus Torvalds 	struct ftdi_private *priv = usb_get_serial_port_data(port);
19461da177e4SLinus Torvalds 	__u16 urb_value; /* will hold the new flags */
19471da177e4SLinus Torvalds 	char buf[1]; /* Perhaps I should dynamically alloc this? */
19481da177e4SLinus Torvalds 
19491da177e4SLinus Torvalds 	// Added for xon/xoff support
19501da177e4SLinus Torvalds 	unsigned int iflag = port->tty->termios->c_iflag;
19511da177e4SLinus Torvalds 	unsigned char vstop;
19521da177e4SLinus Torvalds 	unsigned char vstart;
19531da177e4SLinus Torvalds 
19541da177e4SLinus Torvalds 	dbg("%s", __FUNCTION__);
19551da177e4SLinus Torvalds 
19561da177e4SLinus Torvalds 	/* Force baud rate if this device requires it, unless it is set to B0. */
19571da177e4SLinus Torvalds 	if (priv->force_baud && ((port->tty->termios->c_cflag & CBAUD) != B0)) {
19581da177e4SLinus Torvalds 		dbg("%s: forcing baud rate for this device", __FUNCTION__);
19591da177e4SLinus Torvalds 		port->tty->termios->c_cflag &= ~CBAUD;
19601da177e4SLinus Torvalds 		port->tty->termios->c_cflag |= priv->force_baud;
19611da177e4SLinus Torvalds 	}
19621da177e4SLinus Torvalds 
19631da177e4SLinus Torvalds 	/* Force RTS-CTS if this device requires it. */
19641da177e4SLinus Torvalds 	if (priv->force_rtscts) {
19651da177e4SLinus Torvalds 		dbg("%s: forcing rtscts for this device", __FUNCTION__);
19661da177e4SLinus Torvalds 		port->tty->termios->c_cflag |= CRTSCTS;
19671da177e4SLinus Torvalds 	}
19681da177e4SLinus Torvalds 
19691da177e4SLinus Torvalds 	cflag = port->tty->termios->c_cflag;
19701da177e4SLinus Torvalds 
19711da177e4SLinus Torvalds 	/* FIXME -For this cut I don't care if the line is really changing or
19721da177e4SLinus Torvalds 	   not  - so just do the change regardless  - should be able to
19731da177e4SLinus Torvalds 	   compare old_termios and tty->termios */
19741da177e4SLinus Torvalds 	/* NOTE These routines can get interrupted by
19751da177e4SLinus Torvalds 	   ftdi_sio_read_bulk_callback  - need to examine what this
19761da177e4SLinus Torvalds            means - don't see any problems yet */
19771da177e4SLinus Torvalds 
19781da177e4SLinus Torvalds 	/* Set number of data bits, parity, stop bits */
19791da177e4SLinus Torvalds 
19801da177e4SLinus Torvalds 	urb_value = 0;
19811da177e4SLinus Torvalds 	urb_value |= (cflag & CSTOPB ? FTDI_SIO_SET_DATA_STOP_BITS_2 :
19821da177e4SLinus Torvalds 		      FTDI_SIO_SET_DATA_STOP_BITS_1);
19831da177e4SLinus Torvalds 	urb_value |= (cflag & PARENB ?
19841da177e4SLinus Torvalds 		      (cflag & PARODD ? FTDI_SIO_SET_DATA_PARITY_ODD :
19851da177e4SLinus Torvalds 		       FTDI_SIO_SET_DATA_PARITY_EVEN) :
19861da177e4SLinus Torvalds 		      FTDI_SIO_SET_DATA_PARITY_NONE);
19871da177e4SLinus Torvalds 	if (cflag & CSIZE) {
19881da177e4SLinus Torvalds 		switch (cflag & CSIZE) {
19891da177e4SLinus Torvalds 		case CS5: urb_value |= 5; dbg("Setting CS5"); break;
19901da177e4SLinus Torvalds 		case CS6: urb_value |= 6; dbg("Setting CS6"); break;
19911da177e4SLinus Torvalds 		case CS7: urb_value |= 7; dbg("Setting CS7"); break;
19921da177e4SLinus Torvalds 		case CS8: urb_value |= 8; dbg("Setting CS8"); break;
19931da177e4SLinus Torvalds 		default:
19941da177e4SLinus Torvalds 			err("CSIZE was set but not CS5-CS8");
19951da177e4SLinus Torvalds 		}
19961da177e4SLinus Torvalds 	}
19971da177e4SLinus Torvalds 
19981da177e4SLinus Torvalds 	/* This is needed by the break command since it uses the same command - but is
19991da177e4SLinus Torvalds 	 *  or'ed with this value  */
20001da177e4SLinus Torvalds 	priv->last_set_data_urb_value = urb_value;
20011da177e4SLinus Torvalds 
20021da177e4SLinus Torvalds 	if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
20031da177e4SLinus Torvalds 			    FTDI_SIO_SET_DATA_REQUEST,
20041da177e4SLinus Torvalds 			    FTDI_SIO_SET_DATA_REQUEST_TYPE,
20051da177e4SLinus Torvalds 			    urb_value , priv->interface,
2006279e1545SIan Abbott 			    buf, 0, WDR_SHORT_TIMEOUT) < 0) {
20071da177e4SLinus Torvalds 		err("%s FAILED to set databits/stopbits/parity", __FUNCTION__);
20081da177e4SLinus Torvalds 	}
20091da177e4SLinus Torvalds 
20101da177e4SLinus Torvalds 	/* Now do the baudrate */
20111da177e4SLinus Torvalds 	if ((cflag & CBAUD) == B0 ) {
20121da177e4SLinus Torvalds 		/* Disable flow control */
20131da177e4SLinus Torvalds 		if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
20141da177e4SLinus Torvalds 				    FTDI_SIO_SET_FLOW_CTRL_REQUEST,
20151da177e4SLinus Torvalds 				    FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
20161da177e4SLinus Torvalds 				    0, priv->interface,
20171da177e4SLinus Torvalds 				    buf, 0, WDR_TIMEOUT) < 0) {
20181da177e4SLinus Torvalds 			err("%s error from disable flowcontrol urb", __FUNCTION__);
20191da177e4SLinus Torvalds 		}
20201da177e4SLinus Torvalds 		/* Drop RTS and DTR */
202174ede0ffSIan Abbott 		clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
20221da177e4SLinus Torvalds 	} else {
20231da177e4SLinus Torvalds 		/* set the baudrate determined before */
20241da177e4SLinus Torvalds 		if (change_speed(port)) {
202572a755fcSPeter Favrholdt 			err("%s urb failed to set baudrate", __FUNCTION__);
20261da177e4SLinus Torvalds 		}
202772a755fcSPeter Favrholdt 		/* Ensure RTS and DTR are raised when baudrate changed from 0 */
202857845bd1SGuennadi Liakhovetski 		if (!old_termios || (old_termios->c_cflag & CBAUD) == B0) {
202974ede0ffSIan Abbott 			set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
20301da177e4SLinus Torvalds 		}
203172a755fcSPeter Favrholdt 	}
20321da177e4SLinus Torvalds 
20331da177e4SLinus Torvalds 	/* Set flow control */
20341da177e4SLinus Torvalds 	/* Note device also supports DTR/CD (ugh) and Xon/Xoff in hardware */
20351da177e4SLinus Torvalds 	if (cflag & CRTSCTS) {
20361da177e4SLinus Torvalds 		dbg("%s Setting to CRTSCTS flow control", __FUNCTION__);
20371da177e4SLinus Torvalds 		if (usb_control_msg(dev,
20381da177e4SLinus Torvalds 				    usb_sndctrlpipe(dev, 0),
20391da177e4SLinus Torvalds 				    FTDI_SIO_SET_FLOW_CTRL_REQUEST,
20401da177e4SLinus Torvalds 				    FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
20411da177e4SLinus Torvalds 				    0 , (FTDI_SIO_RTS_CTS_HS | priv->interface),
20421da177e4SLinus Torvalds 				    buf, 0, WDR_TIMEOUT) < 0) {
20431da177e4SLinus Torvalds 			err("urb failed to set to rts/cts flow control");
20441da177e4SLinus Torvalds 		}
20451da177e4SLinus Torvalds 
20461da177e4SLinus Torvalds 	} else {
20471da177e4SLinus Torvalds 		/*
20481da177e4SLinus Torvalds 		 * Xon/Xoff code
20491da177e4SLinus Torvalds 		 *
20501da177e4SLinus Torvalds 		 * Check the IXOFF status in the iflag component of the termios structure
20511da177e4SLinus Torvalds 		 * if IXOFF is not set, the pre-xon/xoff code is executed.
20521da177e4SLinus Torvalds 		*/
20531da177e4SLinus Torvalds 		if (iflag & IXOFF) {
20541da177e4SLinus Torvalds 			dbg("%s  request to enable xonxoff iflag=%04x",__FUNCTION__,iflag);
20551da177e4SLinus Torvalds 			// Try to enable the XON/XOFF on the ftdi_sio
20561da177e4SLinus Torvalds 			// Set the vstart and vstop -- could have been done up above where
20571da177e4SLinus Torvalds 			// a lot of other dereferencing is done but that would be very
20581da177e4SLinus Torvalds 			// inefficient as vstart and vstop are not always needed
20591da177e4SLinus Torvalds 			vstart=port->tty->termios->c_cc[VSTART];
20601da177e4SLinus Torvalds 			vstop=port->tty->termios->c_cc[VSTOP];
20611da177e4SLinus Torvalds 			urb_value=(vstop << 8) | (vstart);
20621da177e4SLinus Torvalds 
20631da177e4SLinus Torvalds 			if (usb_control_msg(dev,
20641da177e4SLinus Torvalds 					    usb_sndctrlpipe(dev, 0),
20651da177e4SLinus Torvalds 					    FTDI_SIO_SET_FLOW_CTRL_REQUEST,
20661da177e4SLinus Torvalds 					    FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
20671da177e4SLinus Torvalds 					    urb_value , (FTDI_SIO_XON_XOFF_HS
20681da177e4SLinus Torvalds 							 | priv->interface),
20691da177e4SLinus Torvalds 					    buf, 0, WDR_TIMEOUT) < 0) {
20701da177e4SLinus Torvalds 				err("urb failed to set to xon/xoff flow control");
20711da177e4SLinus Torvalds 			}
20721da177e4SLinus Torvalds 		} else {
20731da177e4SLinus Torvalds 			/* else clause to only run if cfag ! CRTSCTS and iflag ! XOFF */
20741da177e4SLinus Torvalds 			/* CHECKME Assuming XON/XOFF handled by tty stack - not by device */
20751da177e4SLinus Torvalds 			dbg("%s Turning off hardware flow control", __FUNCTION__);
20761da177e4SLinus Torvalds 			if (usb_control_msg(dev,
20771da177e4SLinus Torvalds 					    usb_sndctrlpipe(dev, 0),
20781da177e4SLinus Torvalds 					    FTDI_SIO_SET_FLOW_CTRL_REQUEST,
20791da177e4SLinus Torvalds 					    FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
20801da177e4SLinus Torvalds 					    0, priv->interface,
20811da177e4SLinus Torvalds 					    buf, 0, WDR_TIMEOUT) < 0) {
20821da177e4SLinus Torvalds 				err("urb failed to clear flow control");
20831da177e4SLinus Torvalds 			}
20841da177e4SLinus Torvalds 		}
20851da177e4SLinus Torvalds 
20861da177e4SLinus Torvalds 	}
20871da177e4SLinus Torvalds 	return;
20881da177e4SLinus Torvalds } /* ftdi_termios */
20891da177e4SLinus Torvalds 
20901da177e4SLinus Torvalds 
20911da177e4SLinus Torvalds static int ftdi_tiocmget (struct usb_serial_port *port, struct file *file)
20921da177e4SLinus Torvalds {
20931da177e4SLinus Torvalds 	struct ftdi_private *priv = usb_get_serial_port_data(port);
20941da177e4SLinus Torvalds 	unsigned char buf[2];
20951da177e4SLinus Torvalds 	int ret;
20961da177e4SLinus Torvalds 
20971da177e4SLinus Torvalds 	dbg("%s TIOCMGET", __FUNCTION__);
20981da177e4SLinus Torvalds 	switch (priv->chip_type) {
20991da177e4SLinus Torvalds 	case SIO:
21001da177e4SLinus Torvalds 		/* Request the status from the device */
21011da177e4SLinus Torvalds 		if ((ret = usb_control_msg(port->serial->dev,
21021da177e4SLinus Torvalds 					   usb_rcvctrlpipe(port->serial->dev, 0),
21031da177e4SLinus Torvalds 					   FTDI_SIO_GET_MODEM_STATUS_REQUEST,
21041da177e4SLinus Torvalds 					   FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
21051da177e4SLinus Torvalds 					   0, 0,
21061da177e4SLinus Torvalds 					   buf, 1, WDR_TIMEOUT)) < 0 ) {
21071da177e4SLinus Torvalds 			err("%s Could not get modem status of device - err: %d", __FUNCTION__,
21081da177e4SLinus Torvalds 			    ret);
21091da177e4SLinus Torvalds 			return(ret);
21101da177e4SLinus Torvalds 		}
21111da177e4SLinus Torvalds 		break;
21121da177e4SLinus Torvalds 	case FT8U232AM:
21131da177e4SLinus Torvalds 	case FT232BM:
21141da177e4SLinus Torvalds 	case FT2232C:
21151da177e4SLinus Torvalds 		/* the 8U232AM returns a two byte value (the sio is a 1 byte value) - in the same
21161da177e4SLinus Torvalds 		   format as the data returned from the in point */
21171da177e4SLinus Torvalds 		if ((ret = usb_control_msg(port->serial->dev,
21181da177e4SLinus Torvalds 					   usb_rcvctrlpipe(port->serial->dev, 0),
21191da177e4SLinus Torvalds 					   FTDI_SIO_GET_MODEM_STATUS_REQUEST,
21201da177e4SLinus Torvalds 					   FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
21211da177e4SLinus Torvalds 					   0, priv->interface,
21221da177e4SLinus Torvalds 					   buf, 2, WDR_TIMEOUT)) < 0 ) {
21231da177e4SLinus Torvalds 			err("%s Could not get modem status of device - err: %d", __FUNCTION__,
21241da177e4SLinus Torvalds 			    ret);
21251da177e4SLinus Torvalds 			return(ret);
21261da177e4SLinus Torvalds 		}
21271da177e4SLinus Torvalds 		break;
21281da177e4SLinus Torvalds 	default:
21291da177e4SLinus Torvalds 		return -EFAULT;
21301da177e4SLinus Torvalds 		break;
21311da177e4SLinus Torvalds 	}
21321da177e4SLinus Torvalds 
21331da177e4SLinus Torvalds 	return  (buf[0] & FTDI_SIO_DSR_MASK ? TIOCM_DSR : 0) |
21341da177e4SLinus Torvalds 		(buf[0] & FTDI_SIO_CTS_MASK ? TIOCM_CTS : 0) |
21351da177e4SLinus Torvalds 		(buf[0]  & FTDI_SIO_RI_MASK  ? TIOCM_RI  : 0) |
21361da177e4SLinus Torvalds 		(buf[0]  & FTDI_SIO_RLSD_MASK ? TIOCM_CD  : 0) |
21371da177e4SLinus Torvalds 		priv->last_dtr_rts;
21381da177e4SLinus Torvalds }
21391da177e4SLinus Torvalds 
21401da177e4SLinus Torvalds static int ftdi_tiocmset(struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear)
21411da177e4SLinus Torvalds {
21421da177e4SLinus Torvalds 	dbg("%s TIOCMSET", __FUNCTION__);
214374ede0ffSIan Abbott 	return update_mctrl(port, set, clear);
21441da177e4SLinus Torvalds }
21451da177e4SLinus Torvalds 
21461da177e4SLinus Torvalds 
21471da177e4SLinus Torvalds static int ftdi_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
21481da177e4SLinus Torvalds {
21491da177e4SLinus Torvalds 	struct ftdi_private *priv = usb_get_serial_port_data(port);
21501da177e4SLinus Torvalds 
21511da177e4SLinus Torvalds 	dbg("%s cmd 0x%04x", __FUNCTION__, cmd);
21521da177e4SLinus Torvalds 
21531da177e4SLinus Torvalds 	/* Based on code from acm.c and others */
21541da177e4SLinus Torvalds 	switch (cmd) {
21551da177e4SLinus Torvalds 
21561da177e4SLinus Torvalds 	case TIOCGSERIAL: /* gets serial port data */
21571da177e4SLinus Torvalds 		return get_serial_info(port, (struct serial_struct __user *) arg);
21581da177e4SLinus Torvalds 
21591da177e4SLinus Torvalds 	case TIOCSSERIAL: /* sets serial port data */
21601da177e4SLinus Torvalds 		return set_serial_info(port, (struct serial_struct __user *) arg);
21611da177e4SLinus Torvalds 
21621da177e4SLinus Torvalds 	/*
21631da177e4SLinus Torvalds 	 * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
21641da177e4SLinus Torvalds 	 * - mask passed in arg for lines of interest
21651da177e4SLinus Torvalds 	 *   (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
21661da177e4SLinus Torvalds 	 * Caller should use TIOCGICOUNT to see which one it was.
21671da177e4SLinus Torvalds 	 *
21681da177e4SLinus Torvalds 	 * This code is borrowed from linux/drivers/char/serial.c
21691da177e4SLinus Torvalds 	 */
21701da177e4SLinus Torvalds 	case TIOCMIWAIT:
21711da177e4SLinus Torvalds 		while (priv != NULL) {
21721da177e4SLinus Torvalds 			interruptible_sleep_on(&priv->delta_msr_wait);
21731da177e4SLinus Torvalds 			/* see if a signal did it */
21741da177e4SLinus Torvalds 			if (signal_pending(current))
21751da177e4SLinus Torvalds 				return -ERESTARTSYS;
21761da177e4SLinus Torvalds 			else {
21771da177e4SLinus Torvalds 				char diff = priv->diff_status;
21781da177e4SLinus Torvalds 
21791da177e4SLinus Torvalds 				if (diff == 0) {
21801da177e4SLinus Torvalds 					return -EIO; /* no change => error */
21811da177e4SLinus Torvalds 				}
21821da177e4SLinus Torvalds 
21831da177e4SLinus Torvalds 				/* Consume all events */
21841da177e4SLinus Torvalds 				priv->diff_status = 0;
21851da177e4SLinus Torvalds 
21861da177e4SLinus Torvalds 				/* Return 0 if caller wanted to know about these bits */
21871da177e4SLinus Torvalds 				if ( ((arg & TIOCM_RNG) && (diff & FTDI_RS0_RI)) ||
21881da177e4SLinus Torvalds 				     ((arg & TIOCM_DSR) && (diff & FTDI_RS0_DSR)) ||
21891da177e4SLinus Torvalds 				     ((arg & TIOCM_CD)  && (diff & FTDI_RS0_RLSD)) ||
21901da177e4SLinus Torvalds 				     ((arg & TIOCM_CTS) && (diff & FTDI_RS0_CTS)) ) {
21911da177e4SLinus Torvalds 					return 0;
21921da177e4SLinus Torvalds 				}
21931da177e4SLinus Torvalds 				/*
21941da177e4SLinus Torvalds 				 * Otherwise caller can't care less about what happened,
21951da177e4SLinus Torvalds 				 * and so we continue to wait for more events.
21961da177e4SLinus Torvalds 				 */
21971da177e4SLinus Torvalds 			}
21981da177e4SLinus Torvalds 		}
21991da177e4SLinus Torvalds 		return(0);
22001da177e4SLinus Torvalds 		break;
22011da177e4SLinus Torvalds 	default:
22021da177e4SLinus Torvalds 		break;
22031da177e4SLinus Torvalds 
22041da177e4SLinus Torvalds 	}
22051da177e4SLinus Torvalds 
22061da177e4SLinus Torvalds 
22071da177e4SLinus Torvalds 	/* This is not necessarily an error - turns out the higher layers will do
22081da177e4SLinus Torvalds 	 *  some ioctls itself (see comment above)
22091da177e4SLinus Torvalds 	 */
22101da177e4SLinus Torvalds 	dbg("%s arg not supported - it was 0x%04x - check /usr/include/asm/ioctls.h", __FUNCTION__, cmd);
22111da177e4SLinus Torvalds 
22121da177e4SLinus Torvalds 	return(-ENOIOCTLCMD);
22131da177e4SLinus Torvalds } /* ftdi_ioctl */
22141da177e4SLinus Torvalds 
22151da177e4SLinus Torvalds 
22161da177e4SLinus Torvalds static void ftdi_throttle (struct usb_serial_port *port)
22171da177e4SLinus Torvalds {
22181da177e4SLinus Torvalds 	struct ftdi_private *priv = usb_get_serial_port_data(port);
22191da177e4SLinus Torvalds 	unsigned long flags;
22201da177e4SLinus Torvalds 
22211da177e4SLinus Torvalds 	dbg("%s - port %d", __FUNCTION__, port->number);
22221da177e4SLinus Torvalds 
22231da177e4SLinus Torvalds 	spin_lock_irqsave(&priv->rx_lock, flags);
22241da177e4SLinus Torvalds 	priv->rx_flags |= THROTTLED;
22251da177e4SLinus Torvalds 	spin_unlock_irqrestore(&priv->rx_lock, flags);
22261da177e4SLinus Torvalds }
22271da177e4SLinus Torvalds 
22281da177e4SLinus Torvalds 
22291da177e4SLinus Torvalds static void ftdi_unthrottle (struct usb_serial_port *port)
22301da177e4SLinus Torvalds {
22311da177e4SLinus Torvalds 	struct ftdi_private *priv = usb_get_serial_port_data(port);
22321da177e4SLinus Torvalds 	int actually_throttled;
22331da177e4SLinus Torvalds 	unsigned long flags;
22341da177e4SLinus Torvalds 
22351da177e4SLinus Torvalds 	dbg("%s - port %d", __FUNCTION__, port->number);
22361da177e4SLinus Torvalds 
22371da177e4SLinus Torvalds 	spin_lock_irqsave(&priv->rx_lock, flags);
22381da177e4SLinus Torvalds 	actually_throttled = priv->rx_flags & ACTUALLY_THROTTLED;
22391da177e4SLinus Torvalds 	priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
22401da177e4SLinus Torvalds 	spin_unlock_irqrestore(&priv->rx_lock, flags);
22411da177e4SLinus Torvalds 
22421da177e4SLinus Torvalds 	if (actually_throttled)
2243c4028958SDavid Howells 		schedule_delayed_work(&priv->rx_work, 0);
22441da177e4SLinus Torvalds }
22451da177e4SLinus Torvalds 
22461da177e4SLinus Torvalds static int __init ftdi_init (void)
22471da177e4SLinus Torvalds {
22481da177e4SLinus Torvalds 	int retval;
22491da177e4SLinus Torvalds 
22501da177e4SLinus Torvalds 	dbg("%s", __FUNCTION__);
2251fdcb0a0fSIan Abbott 	if (vendor > 0 && product > 0) {
2252fdcb0a0fSIan Abbott 		/* Add user specified VID/PID to reserved element of table. */
2253fdcb0a0fSIan Abbott 		int i;
2254fdcb0a0fSIan Abbott 		for (i = 0; id_table_combined[i].idVendor; i++)
2255fdcb0a0fSIan Abbott 			;
2256fdcb0a0fSIan Abbott 		id_table_combined[i].match_flags = USB_DEVICE_ID_MATCH_DEVICE;
2257fdcb0a0fSIan Abbott 		id_table_combined[i].idVendor = vendor;
2258fdcb0a0fSIan Abbott 		id_table_combined[i].idProduct = product;
2259fdcb0a0fSIan Abbott 	}
22608f977e42SIan Abbott 	retval = usb_serial_register(&ftdi_sio_device);
22611da177e4SLinus Torvalds 	if (retval)
22628f977e42SIan Abbott 		goto failed_sio_register;
22631da177e4SLinus Torvalds 	retval = usb_register(&ftdi_driver);
22641da177e4SLinus Torvalds 	if (retval)
22651da177e4SLinus Torvalds 		goto failed_usb_register;
22661da177e4SLinus Torvalds 
22671da177e4SLinus Torvalds 	info(DRIVER_VERSION ":" DRIVER_DESC);
22681da177e4SLinus Torvalds 	return 0;
22691da177e4SLinus Torvalds failed_usb_register:
22708f977e42SIan Abbott 	usb_serial_deregister(&ftdi_sio_device);
22718f977e42SIan Abbott failed_sio_register:
22721da177e4SLinus Torvalds 	return retval;
22731da177e4SLinus Torvalds }
22741da177e4SLinus Torvalds 
22751da177e4SLinus Torvalds 
22761da177e4SLinus Torvalds static void __exit ftdi_exit (void)
22771da177e4SLinus Torvalds {
22781da177e4SLinus Torvalds 
22791da177e4SLinus Torvalds 	dbg("%s", __FUNCTION__);
22801da177e4SLinus Torvalds 
22811da177e4SLinus Torvalds 	usb_deregister (&ftdi_driver);
22828f977e42SIan Abbott 	usb_serial_deregister (&ftdi_sio_device);
22831da177e4SLinus Torvalds 
22841da177e4SLinus Torvalds }
22851da177e4SLinus Torvalds 
22861da177e4SLinus Torvalds 
22871da177e4SLinus Torvalds module_init(ftdi_init);
22881da177e4SLinus Torvalds module_exit(ftdi_exit);
22891da177e4SLinus Torvalds 
22901da177e4SLinus Torvalds MODULE_AUTHOR( DRIVER_AUTHOR );
22911da177e4SLinus Torvalds MODULE_DESCRIPTION( DRIVER_DESC );
22921da177e4SLinus Torvalds MODULE_LICENSE("GPL");
22931da177e4SLinus Torvalds 
22941da177e4SLinus Torvalds module_param(debug, bool, S_IRUGO | S_IWUSR);
22951da177e4SLinus Torvalds MODULE_PARM_DESC(debug, "Debug enabled or not");
2296fdcb0a0fSIan Abbott module_param(vendor, ushort, 0);
2297fdcb0a0fSIan Abbott MODULE_PARM_DESC(vendor, "User specified vendor ID (default="
2298fdcb0a0fSIan Abbott 		__MODULE_STRING(FTDI_VID)")");
2299fdcb0a0fSIan Abbott module_param(product, ushort, 0);
2300fdcb0a0fSIan Abbott MODULE_PARM_DESC(vendor, "User specified product ID");
23011da177e4SLinus Torvalds 
2302