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