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