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