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