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