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