4 * Copyright (C) 1999 - 2001
5 * Greg Kroah-Hartman (greg@kroah.com)
6 * Bill Ryder (bryder@sgi.com)
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
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
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
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
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
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.
193 * Identify version on module load.
195 * (18/March/2001) Bill Ryder
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
219 * Fixed bug with urb->dev not being set properly, now that the usb
223 * Removed DEBUG #ifdefs with call to usb_serial_debug_data
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
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/config.h>
249 #include <linux/kernel.h>
250 #include <linux/errno.h>
251 #include <linux/init.h>
252 #include <linux/slab.h>
253 #include <linux/tty.h>
254 #include <linux/tty_driver.h>
255 #include <linux/tty_flip.h>
256 #include <linux/module.h>
257 #include <linux/spinlock.h>
258 #include <asm/uaccess.h>
259 #include <linux/usb.h>
260 #include <linux/serial.h>
261 #include "usb-serial.h"
262 #include "ftdi_sio.h"
265 * Version Information
267 #define DRIVER_VERSION "v1.4.3"
268 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>, Bill Ryder <bryder@sgi.com>, Kuba Ober <kuba@mareimbrium.org>"
269 #define DRIVER_DESC "USB FTDI Serial Converters Driver"
272 static __u16 vendor = FTDI_VID;
273 static __u16 product;
275 /* struct ftdi_sio_quirk is used by devices requiring special attention. */
276 struct ftdi_sio_quirk {
277 void (*setup)(struct usb_serial *); /* Special settings during startup. */
280 static void ftdi_USB_UIRT_setup (struct usb_serial *serial);
281 static void ftdi_HE_TIRA1_setup (struct usb_serial *serial);
283 static struct ftdi_sio_quirk ftdi_USB_UIRT_quirk = {
284 .setup = ftdi_USB_UIRT_setup,
287 static struct ftdi_sio_quirk ftdi_HE_TIRA1_quirk = {
288 .setup = ftdi_HE_TIRA1_setup,
292 * The 8U232AM has the same API as the sio except for:
293 * - it can support MUCH higher baudrates; up to:
294 * o 921600 for RS232 and 2000000 for RS422/485 at 48MHz
296 * so .. 8U232AM's baudrate setting codes are different
297 * - it has a two byte status code.
298 * - it returns characters every 16ms (the FTDI does it every 40ms)
300 * the bcdDevice value is used to differentiate FT232BM and FT245BM from
301 * the earlier FT8U232AM and FT8U232BM. For now, include all known VID/PID
302 * combinations in both tables.
303 * FIXME: perhaps bcdDevice can also identify 12MHz FT8U232AM devices,
304 * but I don't know if those ever went into mass production. [Ian Abbott]
309 static struct usb_device_id id_table_combined [] = {
310 { USB_DEVICE(FTDI_VID, FTDI_IRTRANS_PID) },
311 { USB_DEVICE(FTDI_VID, FTDI_IPLUS_PID) },
312 { USB_DEVICE(FTDI_VID, FTDI_SIO_PID) },
313 { USB_DEVICE(FTDI_VID, FTDI_8U232AM_PID) },
314 { USB_DEVICE(FTDI_VID, FTDI_8U232AM_ALT_PID) },
315 { USB_DEVICE(FTDI_VID, FTDI_8U2232C_PID) },
316 { USB_DEVICE(FTDI_VID, FTDI_RELAIS_PID) },
317 { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_IOBOARD_PID) },
318 { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_MINI_IOBOARD_PID) },
319 { USB_DEVICE(FTDI_VID, FTDI_XF_632_PID) },
320 { USB_DEVICE(FTDI_VID, FTDI_XF_634_PID) },
321 { USB_DEVICE(FTDI_VID, FTDI_XF_547_PID) },
322 { USB_DEVICE(FTDI_VID, FTDI_XF_633_PID) },
323 { USB_DEVICE(FTDI_VID, FTDI_XF_631_PID) },
324 { USB_DEVICE(FTDI_VID, FTDI_XF_635_PID) },
325 { USB_DEVICE(FTDI_VID, FTDI_XF_640_PID) },
326 { USB_DEVICE(FTDI_VID, FTDI_XF_642_PID) },
327 { USB_DEVICE(FTDI_VID, FTDI_DSS20_PID) },
328 { USB_DEVICE(FTDI_NF_RIC_VID, FTDI_NF_RIC_PID) },
329 { USB_DEVICE(FTDI_VID, FTDI_VNHCPCUSB_D_PID) },
330 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_0_PID) },
331 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_1_PID) },
332 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_2_PID) },
333 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_3_PID) },
334 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_4_PID) },
335 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_5_PID) },
336 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_6_PID) },
337 { USB_DEVICE(FTDI_VID, FTDI_PERLE_ULTRAPORT_PID) },
338 { USB_DEVICE(FTDI_VID, FTDI_PIEGROUP_PID) },
339 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2101_PID) },
340 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2102_PID) },
341 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2103_PID) },
342 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2104_PID) },
343 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_1_PID) },
344 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_2_PID) },
345 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_1_PID) },
346 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_2_PID) },
347 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_1_PID) },
348 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_2_PID) },
349 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_1_PID) },
350 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_2_PID) },
351 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_3_PID) },
352 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_4_PID) },
353 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_1_PID) },
354 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_2_PID) },
355 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_3_PID) },
356 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_4_PID) },
357 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_1_PID) },
358 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_2_PID) },
359 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_3_PID) },
360 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_4_PID) },
361 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_1_PID) },
362 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_2_PID) },
363 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_3_PID) },
364 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_4_PID) },
365 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_5_PID) },
366 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_6_PID) },
367 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_7_PID) },
368 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_8_PID) },
369 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_1_PID) },
370 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_2_PID) },
371 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_3_PID) },
372 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_4_PID) },
373 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_5_PID) },
374 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_6_PID) },
375 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_7_PID) },
376 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_8_PID) },
377 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_1_PID) },
378 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_2_PID) },
379 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_3_PID) },
380 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_4_PID) },
381 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_5_PID) },
382 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_6_PID) },
383 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_7_PID) },
384 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_8_PID) },
385 { USB_DEVICE(IDTECH_VID, IDTECH_IDT1221U_PID) },
386 { USB_DEVICE(OCT_VID, OCT_US101_PID) },
387 { USB_DEVICE(FTDI_VID, FTDI_HE_TIRA1_PID),
388 .driver_info = (kernel_ulong_t)&ftdi_HE_TIRA1_quirk },
389 { USB_DEVICE(FTDI_VID, FTDI_USB_UIRT_PID),
390 .driver_info = (kernel_ulong_t)&ftdi_USB_UIRT_quirk },
391 { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_1) },
392 { USB_DEVICE(FTDI_VID, PROTEGO_R2X0) },
393 { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_3) },
394 { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_4) },
395 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E808_PID) },
396 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E809_PID) },
397 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80A_PID) },
398 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80B_PID) },
399 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80C_PID) },
400 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80D_PID) },
401 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80E_PID) },
402 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80F_PID) },
403 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E888_PID) },
404 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E889_PID) },
405 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88A_PID) },
406 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88B_PID) },
407 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88C_PID) },
408 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88D_PID) },
409 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88E_PID) },
410 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88F_PID) },
411 { USB_DEVICE(FTDI_VID, FTDI_ELV_UO100_PID) },
412 { USB_DEVICE(FTDI_VID, FTDI_ELV_UM100_PID) },
413 { USB_DEVICE(FTDI_VID, FTDI_ELV_UR100_PID) },
414 { USB_DEVICE(FTDI_VID, FTDI_ELV_ALC8500_PID) },
415 { USB_DEVICE(FTDI_VID, FTDI_PYRAMID_PID) },
416 { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1000PC_PID) },
418 * These will probably use user-space drivers. Uncomment them if
419 * you need them or use the user-specified vendor/product module
420 * parameters (see ftdi_sio.h for the numbers). Make a fuss if
421 * you think the driver should recognize any of them by default.
423 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_CLI7000_PID) }, */
424 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_PPS7330_PID) }, */
425 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_TFM100_PID) }, */
426 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UDF77_PID) }, */
427 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UIO88_PID) }, */
428 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UAD8_PID) }, */
429 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UDA7_PID) }, */
430 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_USI2_PID) }, */
431 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_T1100_PID) }, */
432 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_PCD200_PID) }, */
433 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_ULA200_PID) }, */
434 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_CSI8_PID) }, */
435 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_EM1000DL_PID) }, */
436 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_PCK100_PID) }, */
437 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_RFP500_PID) }, */
438 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_FS20SIG_PID) }, */
439 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_WS300PC_PID) }, */
440 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1300PC_PID) }, */
441 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_WS500_PID) }, */
442 { USB_DEVICE(FTDI_VID, LINX_SDMUSBQSS_PID) },
443 { USB_DEVICE(FTDI_VID, LINX_MASTERDEVEL2_PID) },
444 { USB_DEVICE(FTDI_VID, LINX_FUTURE_0_PID) },
445 { USB_DEVICE(FTDI_VID, LINX_FUTURE_1_PID) },
446 { USB_DEVICE(FTDI_VID, LINX_FUTURE_2_PID) },
447 { USB_DEVICE(FTDI_VID, FTDI_CCSICDU20_0_PID) },
448 { USB_DEVICE(FTDI_VID, FTDI_CCSICDU40_1_PID) },
449 { USB_DEVICE(FTDI_VID, INSIDE_ACCESSO) },
450 { USB_DEVICE(INTREPID_VID, INTREPID_VALUECAN_PID) },
451 { USB_DEVICE(INTREPID_VID, INTREPID_NEOVI_PID) },
452 { USB_DEVICE(FALCOM_VID, FALCOM_TWIST_PID) },
453 { USB_DEVICE(FALCOM_VID, FALCOM_SAMBA_PID) },
454 { USB_DEVICE(FTDI_VID, FTDI_SUUNTO_SPORTS_PID) },
455 { USB_DEVICE(FTDI_VID, FTDI_RM_CANVIEW_PID) },
456 { USB_DEVICE(BANDB_VID, BANDB_USOTL4_PID) },
457 { USB_DEVICE(BANDB_VID, BANDB_USTL4_PID) },
458 { USB_DEVICE(BANDB_VID, BANDB_USO9ML2_PID) },
459 { USB_DEVICE(FTDI_VID, EVER_ECO_PRO_CDS) },
460 { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_0_PID) },
461 { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_1_PID) },
462 { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_2_PID) },
463 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_0_PID) },
464 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_1_PID) },
465 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_2_PID) },
466 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_3_PID) },
467 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_4_PID) },
468 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_5_PID) },
469 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_6_PID) },
470 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_7_PID) },
471 { USB_DEVICE(MOBILITY_VID, MOBILITY_USB_SERIAL_PID) },
472 { USB_DEVICE(FTDI_VID, FTDI_ACTIVE_ROBOTS_PID) },
473 { USB_DEVICE(FTDI_VID, FTDI_MHAM_KW_PID) },
474 { USB_DEVICE(FTDI_VID, FTDI_MHAM_YS_PID) },
475 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y6_PID) },
476 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y8_PID) },
477 { USB_DEVICE(FTDI_VID, FTDI_MHAM_IC_PID) },
478 { USB_DEVICE(FTDI_VID, FTDI_MHAM_DB9_PID) },
479 { USB_DEVICE(FTDI_VID, FTDI_MHAM_RS232_PID) },
480 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y9_PID) },
481 { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_VCP_PID) },
482 { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_D2XX_PID) },
483 { USB_DEVICE(EVOLUTION_VID, EVOLUTION_ER1_PID) },
484 { USB_DEVICE(FTDI_VID, FTDI_ARTEMIS_PID) },
485 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16_PID) },
486 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16C_PID) },
487 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HR_PID) },
488 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HRC_PID) },
489 { USB_DEVICE(KOBIL_VID, KOBIL_CONV_B1_PID) },
490 { USB_DEVICE(KOBIL_VID, KOBIL_CONV_KAAN_PID) },
491 { USB_DEVICE(POSIFLEX_VID, POSIFLEX_PP7000_PID) },
492 { USB_DEVICE(FTDI_VID, FTDI_TTUSB_PID) },
493 { USB_DEVICE(FTDI_VID, FTDI_ECLO_COM_1WIRE_PID) },
494 { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_777_PID) },
495 { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_8900F_PID) },
496 { USB_DEVICE(FTDI_VID, FTDI_PCDJ_DAC2_PID) },
497 { USB_DEVICE(FTDI_VID, FTDI_RRCIRKITS_LOCOBUFFER_PID) },
498 { USB_DEVICE(FTDI_VID, FTDI_ASK_RDR400_PID) },
499 { USB_DEVICE(ICOM_ID1_VID, ICOM_ID1_PID) },
500 { USB_DEVICE(PAPOUCH_VID, PAPOUCH_TMU_PID) },
501 { USB_DEVICE(FTDI_VID, FTDI_ACG_HFDUAL_PID) },
502 { }, /* Optional parameter entry */
503 { } /* Terminating entry */
506 MODULE_DEVICE_TABLE (usb, id_table_combined);
508 static struct usb_driver ftdi_driver = {
510 .probe = usb_serial_probe,
511 .disconnect = usb_serial_disconnect,
512 .id_table = id_table_combined,
516 static const char *ftdi_chip_name[] = {
517 [SIO] = "SIO", /* the serial part of FT8U100AX */
518 [FT8U232AM] = "FT8U232AM",
519 [FT232BM] = "FT232BM",
520 [FT2232C] = "FT2232C",
524 /* Constants for read urb and write urb */
529 #define THROTTLED 0x01
530 #define ACTUALLY_THROTTLED 0x02
532 struct ftdi_private {
533 ftdi_chip_type_t chip_type;
534 /* type of the device, either SIO or FT8U232AM */
535 int baud_base; /* baud base clock for divisor setting */
536 int custom_divisor; /* custom_divisor kludge, this is for baud_base (different from what goes to the chip!) */
537 __u16 last_set_data_urb_value ;
538 /* the last data state set - needed for doing a break */
539 int write_offset; /* This is the offset in the usb data block to write the serial data -
540 * it is different between devices
542 int flags; /* some ASYNC_xxxx flags are supported */
543 unsigned long last_dtr_rts; /* saved modem control outputs */
544 wait_queue_head_t delta_msr_wait; /* Used for TIOCMIWAIT */
545 char prev_status, diff_status; /* Used for TIOCMIWAIT */
546 __u8 rx_flags; /* receive state flags (throttling) */
547 spinlock_t rx_lock; /* spinlock for receive state */
548 struct work_struct rx_work;
551 __u16 interface; /* FT2232C port interface (0 for FT232/245) */
553 int force_baud; /* if non-zero, force the baud rate to this value */
554 int force_rtscts; /* if non-zero, force RTS-CTS to always be enabled */
557 /* Used for TIOCMIWAIT */
558 #define FTDI_STATUS_B0_MASK (FTDI_RS0_CTS | FTDI_RS0_DSR | FTDI_RS0_RI | FTDI_RS0_RLSD)
559 #define FTDI_STATUS_B1_MASK (FTDI_RS_BI)
562 #define FTDI_IMPL_ASYNC_FLAGS = ( ASYNC_SPD_HI | ASYNC_SPD_VHI \
563 ASYNC_SPD_CUST | ASYNC_SPD_SHI | ASYNC_SPD_WARP )
565 /* function prototypes for a FTDI serial converter */
566 static int ftdi_sio_probe (struct usb_serial *serial, const struct usb_device_id *id);
567 static int ftdi_sio_attach (struct usb_serial *serial);
568 static void ftdi_shutdown (struct usb_serial *serial);
569 static int ftdi_open (struct usb_serial_port *port, struct file *filp);
570 static void ftdi_close (struct usb_serial_port *port, struct file *filp);
571 static int ftdi_write (struct usb_serial_port *port, const unsigned char *buf, int count);
572 static int ftdi_write_room (struct usb_serial_port *port);
573 static int ftdi_chars_in_buffer (struct usb_serial_port *port);
574 static void ftdi_write_bulk_callback (struct urb *urb, struct pt_regs *regs);
575 static void ftdi_read_bulk_callback (struct urb *urb, struct pt_regs *regs);
576 static void ftdi_process_read (void *param);
577 static void ftdi_set_termios (struct usb_serial_port *port, struct termios * old);
578 static int ftdi_tiocmget (struct usb_serial_port *port, struct file *file);
579 static int ftdi_tiocmset (struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear);
580 static int ftdi_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg);
581 static void ftdi_break_ctl (struct usb_serial_port *port, int break_state );
582 static void ftdi_throttle (struct usb_serial_port *port);
583 static void ftdi_unthrottle (struct usb_serial_port *port);
585 static unsigned short int ftdi_232am_baud_base_to_divisor (int baud, int base);
586 static unsigned short int ftdi_232am_baud_to_divisor (int baud);
587 static __u32 ftdi_232bm_baud_base_to_divisor (int baud, int base);
588 static __u32 ftdi_232bm_baud_to_divisor (int baud);
590 static struct usb_serial_driver ftdi_sio_device = {
592 .owner = THIS_MODULE,
595 .description = "FTDI USB Serial Device",
596 .id_table = id_table_combined,
597 .num_interrupt_in = 0,
601 .probe = ftdi_sio_probe,
604 .throttle = ftdi_throttle,
605 .unthrottle = ftdi_unthrottle,
607 .write_room = ftdi_write_room,
608 .chars_in_buffer = ftdi_chars_in_buffer,
609 .read_bulk_callback = ftdi_read_bulk_callback,
610 .write_bulk_callback = ftdi_write_bulk_callback,
611 .tiocmget = ftdi_tiocmget,
612 .tiocmset = ftdi_tiocmset,
614 .set_termios = ftdi_set_termios,
615 .break_ctl = ftdi_break_ctl,
616 .attach = ftdi_sio_attach,
617 .shutdown = ftdi_shutdown,
621 #define WDR_TIMEOUT 5000 /* default urb timeout */
622 #define WDR_SHORT_TIMEOUT 1000 /* shorter urb timeout */
624 /* High and low are for DTR, RTS etc etc */
629 * ***************************************************************************
631 * ***************************************************************************
634 static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base)
636 unsigned short int divisor;
637 int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
638 if ((divisor3 & 0x7) == 7) divisor3 ++; // round x.7/8 up to x+1
639 divisor = divisor3 >> 3;
641 if (divisor3 == 1) divisor |= 0xc000; else // 0.125
642 if (divisor3 >= 4) divisor |= 0x4000; else // 0.5
643 if (divisor3 != 0) divisor |= 0x8000; // 0.25
644 if (divisor == 1) divisor = 0; /* special case for maximum baud rate */
648 static unsigned short int ftdi_232am_baud_to_divisor(int baud)
650 return(ftdi_232am_baud_base_to_divisor(baud, 48000000));
653 static __u32 ftdi_232bm_baud_base_to_divisor(int baud, int base)
655 static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
657 int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
658 divisor = divisor3 >> 3;
659 divisor |= (__u32)divfrac[divisor3 & 0x7] << 14;
660 /* Deal with special cases for highest baud rates. */
661 if (divisor == 1) divisor = 0; else // 1.0
662 if (divisor == 0x4001) divisor = 1; // 1.5
666 static __u32 ftdi_232bm_baud_to_divisor(int baud)
668 return(ftdi_232bm_baud_base_to_divisor(baud, 48000000));
671 #define set_mctrl(port, set) update_mctrl((port), (set), 0)
672 #define clear_mctrl(port, clear) update_mctrl((port), 0, (clear))
674 static int update_mctrl(struct usb_serial_port *port, unsigned int set, unsigned int clear)
676 struct ftdi_private *priv = usb_get_serial_port_data(port);
681 if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
682 dbg("%s - DTR|RTS not being set|cleared", __FUNCTION__);
683 return 0; /* no change */
686 buf = kmalloc(1, GFP_NOIO);
691 clear &= ~set; /* 'set' takes precedence over 'clear' */
693 if (clear & TIOCM_DTR)
694 urb_value |= FTDI_SIO_SET_DTR_LOW;
695 if (clear & TIOCM_RTS)
696 urb_value |= FTDI_SIO_SET_RTS_LOW;
698 urb_value |= FTDI_SIO_SET_DTR_HIGH;
700 urb_value |= FTDI_SIO_SET_RTS_HIGH;
701 rv = usb_control_msg(port->serial->dev,
702 usb_sndctrlpipe(port->serial->dev, 0),
703 FTDI_SIO_SET_MODEM_CTRL_REQUEST,
704 FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE,
705 urb_value, priv->interface,
706 buf, 0, WDR_TIMEOUT);
710 err("%s Error from MODEM_CTRL urb: DTR %s, RTS %s",
712 (set & TIOCM_DTR) ? "HIGH" :
713 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
714 (set & TIOCM_RTS) ? "HIGH" :
715 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
717 dbg("%s - DTR %s, RTS %s", __FUNCTION__,
718 (set & TIOCM_DTR) ? "HIGH" :
719 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
720 (set & TIOCM_RTS) ? "HIGH" :
721 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
722 priv->last_dtr_rts = (priv->last_dtr_rts & ~clear) | set;
728 static __u32 get_ftdi_divisor(struct usb_serial_port * port);
731 static int change_speed(struct usb_serial_port *port)
733 struct ftdi_private *priv = usb_get_serial_port_data(port);
737 __u32 urb_index_value;
740 buf = kmalloc(1, GFP_NOIO);
744 urb_index_value = get_ftdi_divisor(port);
745 urb_value = (__u16)urb_index_value;
746 urb_index = (__u16)(urb_index_value >> 16);
747 if (priv->interface) { /* FT2232C */
748 urb_index = (__u16)((urb_index << 8) | priv->interface);
751 rv = usb_control_msg(port->serial->dev,
752 usb_sndctrlpipe(port->serial->dev, 0),
753 FTDI_SIO_SET_BAUDRATE_REQUEST,
754 FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE,
755 urb_value, urb_index,
756 buf, 0, WDR_SHORT_TIMEOUT);
763 static __u32 get_ftdi_divisor(struct usb_serial_port * port)
764 { /* get_ftdi_divisor */
765 struct ftdi_private *priv = usb_get_serial_port_data(port);
771 * The logic involved in setting the baudrate can be cleanly split in 3 steps.
772 * Obtaining the actual baud rate is a little tricky since unix traditionally
773 * somehow ignored the possibility to set non-standard baud rates.
774 * 1. Standard baud rates are set in tty->termios->c_cflag
775 * 2. If these are not enough, you can set any speed using alt_speed as follows:
776 * - set tty->termios->c_cflag speed to B38400
777 * - set your real speed in tty->alt_speed; it gets ignored when
779 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
780 * flags & ASYNC_SPD_MASK == ASYNC_SPD_[HI, VHI, SHI, WARP], this just
781 * sets alt_speed to (HI: 57600, VHI: 115200, SHI: 230400, WARP: 460800)
782 * ** Steps 1, 2 are done courtesy of tty_get_baud_rate
783 * 3. You can also set baud rate by setting custom divisor as follows
784 * - set tty->termios->c_cflag speed to B38400
785 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
786 * o flags & ASYNC_SPD_MASK == ASYNC_SPD_CUST
787 * o custom_divisor set to baud_base / your_new_baudrate
788 * ** Step 3 is done courtesy of code borrowed from serial.c - I should really
789 * spend some time and separate+move this common code to serial.c, it is
790 * replicated in nearly every serial driver you see.
793 /* 1. Get the baud rate from the tty settings, this observes alt_speed hack */
795 baud = tty_get_baud_rate(port->tty);
796 dbg("%s - tty_get_baud_rate reports speed %d", __FUNCTION__, baud);
798 /* 2. Observe async-compatible custom_divisor hack, update baudrate if needed */
801 ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
802 (priv->custom_divisor)) {
803 baud = priv->baud_base / priv->custom_divisor;
804 dbg("%s - custom divisor %d sets baud rate to %d", __FUNCTION__, priv->custom_divisor, baud);
807 /* 3. Convert baudrate to device-specific divisor */
809 if (!baud) baud = 9600;
810 switch(priv->chip_type) {
811 case SIO: /* SIO chip */
813 case 300: div_value = ftdi_sio_b300; break;
814 case 600: div_value = ftdi_sio_b600; break;
815 case 1200: div_value = ftdi_sio_b1200; break;
816 case 2400: div_value = ftdi_sio_b2400; break;
817 case 4800: div_value = ftdi_sio_b4800; break;
818 case 9600: div_value = ftdi_sio_b9600; break;
819 case 19200: div_value = ftdi_sio_b19200; break;
820 case 38400: div_value = ftdi_sio_b38400; break;
821 case 57600: div_value = ftdi_sio_b57600; break;
822 case 115200: div_value = ftdi_sio_b115200; break;
824 if (div_value == 0) {
825 dbg("%s - Baudrate (%d) requested is not supported", __FUNCTION__, baud);
826 div_value = ftdi_sio_b9600;
830 case FT8U232AM: /* 8U232AM chip */
831 if (baud <= 3000000) {
832 div_value = ftdi_232am_baud_to_divisor(baud);
834 dbg("%s - Baud rate too high!", __FUNCTION__);
835 div_value = ftdi_232am_baud_to_divisor(9600);
839 case FT232BM: /* FT232BM chip */
840 case FT2232C: /* FT2232C chip */
841 if (baud <= 3000000) {
842 div_value = ftdi_232bm_baud_to_divisor(baud);
844 dbg("%s - Baud rate too high!", __FUNCTION__);
845 div_value = ftdi_232bm_baud_to_divisor(9600);
849 } /* priv->chip_type */
852 dbg("%s - Baud rate set to %d (divisor 0x%lX) on chip %s",
853 __FUNCTION__, baud, (unsigned long)div_value,
854 ftdi_chip_name[priv->chip_type]);
861 static int get_serial_info(struct usb_serial_port * port, struct serial_struct __user * retinfo)
863 struct ftdi_private *priv = usb_get_serial_port_data(port);
864 struct serial_struct tmp;
868 memset(&tmp, 0, sizeof(tmp));
869 tmp.flags = priv->flags;
870 tmp.baud_base = priv->baud_base;
871 tmp.custom_divisor = priv->custom_divisor;
872 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
875 } /* get_serial_info */
878 static int set_serial_info(struct usb_serial_port * port, struct serial_struct __user * newinfo)
879 { /* set_serial_info */
880 struct ftdi_private *priv = usb_get_serial_port_data(port);
881 struct serial_struct new_serial;
882 struct ftdi_private old_priv;
884 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
888 /* Do error checking and permission checking */
890 if (!capable(CAP_SYS_ADMIN)) {
891 if (((new_serial.flags & ~ASYNC_USR_MASK) !=
892 (priv->flags & ~ASYNC_USR_MASK)))
894 priv->flags = ((priv->flags & ~ASYNC_USR_MASK) |
895 (new_serial.flags & ASYNC_USR_MASK));
896 priv->custom_divisor = new_serial.custom_divisor;
900 if ((new_serial.baud_base != priv->baud_base) &&
901 (new_serial.baud_base < 9600))
904 /* Make the changes - these are privileged changes! */
906 priv->flags = ((priv->flags & ~ASYNC_FLAGS) |
907 (new_serial.flags & ASYNC_FLAGS));
908 priv->custom_divisor = new_serial.custom_divisor;
910 port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
913 if ((old_priv.flags & ASYNC_SPD_MASK) !=
914 (priv->flags & ASYNC_SPD_MASK)) {
915 if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_HI)
916 port->tty->alt_speed = 57600;
917 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_VHI)
918 port->tty->alt_speed = 115200;
919 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_SHI)
920 port->tty->alt_speed = 230400;
921 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_WARP)
922 port->tty->alt_speed = 460800;
924 port->tty->alt_speed = 0;
926 if (((old_priv.flags & ASYNC_SPD_MASK) !=
927 (priv->flags & ASYNC_SPD_MASK)) ||
928 (((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
929 (old_priv.custom_divisor != priv->custom_divisor))) {
935 } /* set_serial_info */
938 /* Determine type of FTDI chip based on USB config and descriptor. */
939 static void ftdi_determine_type(struct usb_serial_port *port)
941 struct ftdi_private *priv = usb_get_serial_port_data(port);
942 struct usb_serial *serial = port->serial;
943 struct usb_device *udev = serial->dev;
947 /* Assume it is not the original SIO device for now. */
948 priv->baud_base = 48000000 / 2;
949 priv->write_offset = 0;
951 version = le16_to_cpu(udev->descriptor.bcdDevice);
952 interfaces = udev->actconfig->desc.bNumInterfaces;
953 dbg("%s: bcdDevice = 0x%x, bNumInterfaces = %u", __FUNCTION__,
954 version, interfaces);
955 if (interfaces > 1) {
958 /* Multiple interfaces. Assume FT2232C. */
959 priv->chip_type = FT2232C;
960 /* Determine interface code. */
961 inter = serial->interface->altsetting->desc.bInterfaceNumber;
963 priv->interface = PIT_SIOA;
965 priv->interface = PIT_SIOB;
967 /* BM-type devices have a bug where bcdDevice gets set
968 * to 0x200 when iSerialNumber is 0. */
969 if (version < 0x500) {
970 dbg("%s: something fishy - bcdDevice too low for multi-interface device",
973 } else if (version < 0x200) {
974 /* Old device. Assume its the original SIO. */
975 priv->chip_type = SIO;
976 priv->baud_base = 12000000 / 16;
977 priv->write_offset = 1;
978 } else if (version < 0x400) {
979 /* Assume its an FT8U232AM (or FT8U245AM) */
980 /* (It might be a BM because of the iSerialNumber bug,
981 * but it will still work as an AM device.) */
982 priv->chip_type = FT8U232AM;
984 /* Assume its an FT232BM (or FT245BM) */
985 priv->chip_type = FT232BM;
987 info("Detected %s", ftdi_chip_name[priv->chip_type]);
992 * ***************************************************************************
994 * ***************************************************************************
997 static ssize_t show_latency_timer(struct device *dev, struct device_attribute *attr, char *buf)
999 struct usb_serial_port *port = to_usb_serial_port(dev);
1000 struct ftdi_private *priv = usb_get_serial_port_data(port);
1001 struct usb_device *udev;
1002 unsigned short latency = 0;
1005 udev = to_usb_device(dev);
1007 dbg("%s",__FUNCTION__);
1009 rv = usb_control_msg(udev,
1010 usb_rcvctrlpipe(udev, 0),
1011 FTDI_SIO_GET_LATENCY_TIMER_REQUEST,
1012 FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE,
1014 (char*) &latency, 1, WDR_TIMEOUT);
1017 dev_err(dev, "Unable to read latency timer: %i", rv);
1020 return sprintf(buf, "%i\n", latency);
1023 /* Write a new value of the latency timer, in units of milliseconds. */
1024 static ssize_t store_latency_timer(struct device *dev, struct device_attribute *attr, const char *valbuf,
1027 struct usb_serial_port *port = to_usb_serial_port(dev);
1028 struct ftdi_private *priv = usb_get_serial_port_data(port);
1029 struct usb_device *udev;
1031 int v = simple_strtoul(valbuf, NULL, 10);
1034 udev = to_usb_device(dev);
1036 dbg("%s: setting latency timer = %i", __FUNCTION__, v);
1038 rv = usb_control_msg(udev,
1039 usb_sndctrlpipe(udev, 0),
1040 FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
1041 FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
1043 buf, 0, WDR_TIMEOUT);
1046 dev_err(dev, "Unable to write latency timer: %i", rv);
1053 /* Write an event character directly to the FTDI register. The ASCII
1054 value is in the low 8 bits, with the enable bit in the 9th bit. */
1055 static ssize_t store_event_char(struct device *dev, struct device_attribute *attr, const char *valbuf,
1058 struct usb_serial_port *port = to_usb_serial_port(dev);
1059 struct ftdi_private *priv = usb_get_serial_port_data(port);
1060 struct usb_device *udev;
1062 int v = simple_strtoul(valbuf, NULL, 10);
1065 udev = to_usb_device(dev);
1067 dbg("%s: setting event char = %i", __FUNCTION__, v);
1069 rv = usb_control_msg(udev,
1070 usb_sndctrlpipe(udev, 0),
1071 FTDI_SIO_SET_EVENT_CHAR_REQUEST,
1072 FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE,
1074 buf, 0, WDR_TIMEOUT);
1077 dbg("Unable to write event character: %i", rv);
1084 static DEVICE_ATTR(latency_timer, S_IWUSR | S_IRUGO, show_latency_timer, store_latency_timer);
1085 static DEVICE_ATTR(event_char, S_IWUSR, NULL, store_event_char);
1087 static void create_sysfs_attrs(struct usb_serial *serial)
1089 struct ftdi_private *priv;
1090 struct usb_device *udev;
1092 dbg("%s",__FUNCTION__);
1094 priv = usb_get_serial_port_data(serial->port[0]);
1097 /* XXX I've no idea if the original SIO supports the event_char
1098 * sysfs parameter, so I'm playing it safe. */
1099 if (priv->chip_type != SIO) {
1100 dbg("sysfs attributes for %s", ftdi_chip_name[priv->chip_type]);
1101 device_create_file(&udev->dev, &dev_attr_event_char);
1102 if (priv->chip_type == FT232BM || priv->chip_type == FT2232C) {
1103 device_create_file(&udev->dev, &dev_attr_latency_timer);
1108 static void remove_sysfs_attrs(struct usb_serial *serial)
1110 struct ftdi_private *priv;
1111 struct usb_device *udev;
1113 dbg("%s",__FUNCTION__);
1115 priv = usb_get_serial_port_data(serial->port[0]);
1118 /* XXX see create_sysfs_attrs */
1119 if (priv->chip_type != SIO) {
1120 device_remove_file(&udev->dev, &dev_attr_event_char);
1121 if (priv->chip_type == FT232BM || priv->chip_type == FT2232C) {
1122 device_remove_file(&udev->dev, &dev_attr_latency_timer);
1129 * ***************************************************************************
1130 * FTDI driver specific functions
1131 * ***************************************************************************
1134 /* Probe function to check for special devices */
1135 static int ftdi_sio_probe (struct usb_serial *serial, const struct usb_device_id *id)
1137 usb_set_serial_data(serial, (void *)id->driver_info);
1142 /* attach subroutine */
1143 static int ftdi_sio_attach (struct usb_serial *serial)
1145 struct usb_serial_port *port = serial->port[0];
1146 struct ftdi_private *priv;
1147 struct ftdi_sio_quirk *quirk;
1149 dbg("%s",__FUNCTION__);
1151 priv = kzalloc(sizeof(struct ftdi_private), GFP_KERNEL);
1153 err("%s- kmalloc(%Zd) failed.", __FUNCTION__, sizeof(struct ftdi_private));
1157 spin_lock_init(&priv->rx_lock);
1158 init_waitqueue_head(&priv->delta_msr_wait);
1159 /* This will push the characters through immediately rather
1160 than queue a task to deliver them */
1161 priv->flags = ASYNC_LOW_LATENCY;
1163 /* Increase the size of read buffers */
1164 kfree(port->bulk_in_buffer);
1165 port->bulk_in_buffer = kmalloc (BUFSZ, GFP_KERNEL);
1166 if (!port->bulk_in_buffer) {
1170 if (port->read_urb) {
1171 port->read_urb->transfer_buffer = port->bulk_in_buffer;
1172 port->read_urb->transfer_buffer_length = BUFSZ;
1175 INIT_WORK(&priv->rx_work, ftdi_process_read, port);
1177 /* Free port's existing write urb and transfer buffer. */
1178 if (port->write_urb) {
1179 usb_free_urb (port->write_urb);
1180 port->write_urb = NULL;
1182 kfree(port->bulk_out_buffer);
1183 port->bulk_out_buffer = NULL;
1185 usb_set_serial_port_data(serial->port[0], priv);
1187 ftdi_determine_type (serial->port[0]);
1188 create_sysfs_attrs(serial);
1190 /* Check for device requiring special set up. */
1191 quirk = (struct ftdi_sio_quirk *)usb_get_serial_data(serial);
1192 if (quirk && quirk->setup) {
1193 quirk->setup(serial);
1197 } /* ftdi_sio_attach */
1200 /* Setup for the USB-UIRT device, which requires hardwired
1201 * baudrate (38400 gets mapped to 312500) */
1202 /* Called from usbserial:serial_probe */
1203 static void ftdi_USB_UIRT_setup (struct usb_serial *serial)
1205 struct ftdi_private *priv;
1207 dbg("%s",__FUNCTION__);
1209 priv = usb_get_serial_port_data(serial->port[0]);
1210 priv->flags |= ASYNC_SPD_CUST;
1211 priv->custom_divisor = 77;
1212 priv->force_baud = B38400;
1213 } /* ftdi_USB_UIRT_setup */
1215 /* Setup for the HE-TIRA1 device, which requires hardwired
1216 * baudrate (38400 gets mapped to 100000) and RTS-CTS enabled. */
1217 static void ftdi_HE_TIRA1_setup (struct usb_serial *serial)
1219 struct ftdi_private *priv;
1221 dbg("%s",__FUNCTION__);
1223 priv = usb_get_serial_port_data(serial->port[0]);
1224 priv->flags |= ASYNC_SPD_CUST;
1225 priv->custom_divisor = 240;
1226 priv->force_baud = B38400;
1227 priv->force_rtscts = 1;
1228 } /* ftdi_HE_TIRA1_setup */
1231 /* ftdi_shutdown is called from usbserial:usb_serial_disconnect
1232 * it is called when the usb device is disconnected
1234 * usbserial:usb_serial_disconnect
1235 * calls __serial_close for each open of the port
1236 * shutdown is called then (ie ftdi_shutdown)
1240 static void ftdi_shutdown (struct usb_serial *serial)
1241 { /* ftdi_shutdown */
1243 struct usb_serial_port *port = serial->port[0];
1244 struct ftdi_private *priv = usb_get_serial_port_data(port);
1246 dbg("%s", __FUNCTION__);
1248 remove_sysfs_attrs(serial);
1250 /* all open ports are closed at this point
1251 * (by usbserial.c:__serial_close, which calls ftdi_close)
1255 usb_set_serial_port_data(port, NULL);
1258 } /* ftdi_shutdown */
1261 static int ftdi_open (struct usb_serial_port *port, struct file *filp)
1263 struct termios tmp_termios;
1264 struct usb_device *dev = port->serial->dev;
1265 struct ftdi_private *priv = usb_get_serial_port_data(port);
1266 unsigned long flags;
1269 char buf[1]; /* Needed for the usb_control_msg I think */
1271 dbg("%s", __FUNCTION__);
1274 port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
1276 /* No error checking for this (will get errors later anyway) */
1277 /* See ftdi_sio.h for description of what is reset */
1278 usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1279 FTDI_SIO_RESET_REQUEST, FTDI_SIO_RESET_REQUEST_TYPE,
1281 priv->interface, buf, 0, WDR_TIMEOUT);
1283 /* Termios defaults are set by usb_serial_init. We don't change
1284 port->tty->termios - this would loose speed settings, etc.
1285 This is same behaviour as serial.c/rs_open() - Kuba */
1287 /* ftdi_set_termios will send usb control messages */
1288 ftdi_set_termios(port, &tmp_termios);
1290 /* FIXME: Flow control might be enabled, so it should be checked -
1291 we have no control of defaults! */
1292 /* Turn on RTS and DTR since we are not flow controlling by default */
1293 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1296 spin_lock_irqsave(&priv->rx_lock, flags);
1297 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
1298 spin_unlock_irqrestore(&priv->rx_lock, flags);
1300 /* Start reading from the device */
1301 priv->rx_processed = 0;
1302 usb_fill_bulk_urb(port->read_urb, dev,
1303 usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress),
1304 port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
1305 ftdi_read_bulk_callback, port);
1306 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
1308 err("%s - failed submitting read urb, error %d", __FUNCTION__, result);
1317 * usbserial:__serial_close only calls ftdi_close if the point is open
1319 * This only gets called when it is the last close
1324 static void ftdi_close (struct usb_serial_port *port, struct file *filp)
1326 unsigned int c_cflag = port->tty->termios->c_cflag;
1327 struct ftdi_private *priv = usb_get_serial_port_data(port);
1330 dbg("%s", __FUNCTION__);
1332 if (c_cflag & HUPCL){
1333 /* Disable flow control */
1334 if (usb_control_msg(port->serial->dev,
1335 usb_sndctrlpipe(port->serial->dev, 0),
1336 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1337 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1338 0, priv->interface, buf, 0,
1340 err("error from flowcontrol urb");
1343 /* drop RTS and DTR */
1344 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1345 } /* Note change no line if hupcl is off */
1347 /* cancel any scheduled reading */
1348 cancel_delayed_work(&priv->rx_work);
1349 flush_scheduled_work();
1351 /* shutdown our bulk read */
1353 usb_kill_urb(port->read_urb);
1358 /* The SIO requires the first byte to have:
1361 * B2..7 length of message excluding byte 0
1363 * The new devices do not require this byte
1365 static int ftdi_write (struct usb_serial_port *port,
1366 const unsigned char *buf, int count)
1368 struct ftdi_private *priv = usb_get_serial_port_data(port);
1370 unsigned char *buffer;
1371 int data_offset ; /* will be 1 for the SIO and 0 otherwise */
1375 dbg("%s port %d, %d bytes", __FUNCTION__, port->number, count);
1378 dbg("write request of 0 bytes");
1382 data_offset = priv->write_offset;
1383 dbg("data_offset set to %d",data_offset);
1385 /* Determine total transfer size */
1386 transfer_size = count;
1387 if (data_offset > 0) {
1388 /* Original sio needs control bytes too... */
1389 transfer_size += (data_offset *
1390 ((count + (PKTSZ - 1 - data_offset)) /
1391 (PKTSZ - data_offset)));
1394 buffer = kmalloc (transfer_size, GFP_ATOMIC);
1396 err("%s ran out of kernel memory for urb ...", __FUNCTION__);
1400 urb = usb_alloc_urb(0, GFP_ATOMIC);
1402 err("%s - no more free urbs", __FUNCTION__);
1408 if (data_offset > 0) {
1409 /* Original sio requires control byte at start of each packet. */
1410 int user_pktsz = PKTSZ - data_offset;
1412 unsigned char *first_byte = buffer;
1413 const unsigned char *current_position = buf;
1416 if (user_pktsz > todo) {
1419 /* Write the control byte at the front of the packet*/
1420 *first_byte = 1 | ((user_pktsz) << 2);
1421 /* Copy data for packet */
1422 memcpy (first_byte + data_offset,
1423 current_position, user_pktsz);
1424 first_byte += user_pktsz + data_offset;
1425 current_position += user_pktsz;
1429 /* No control byte required. */
1430 /* Copy in the data to send */
1431 memcpy (buffer, buf, count);
1434 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, transfer_size, buffer);
1436 /* fill the buffer and send it */
1437 usb_fill_bulk_urb(urb, port->serial->dev,
1438 usb_sndbulkpipe(port->serial->dev, port->bulk_out_endpointAddress),
1439 buffer, transfer_size,
1440 ftdi_write_bulk_callback, port);
1442 status = usb_submit_urb(urb, GFP_ATOMIC);
1444 err("%s - failed submitting write urb, error %d", __FUNCTION__, status);
1449 /* we are done with this urb, so let the host driver
1450 * really free it when it is finished with it */
1453 dbg("%s write returning: %d", __FUNCTION__, count);
1458 /* This function may get called when the device is closed */
1460 static void ftdi_write_bulk_callback (struct urb *urb, struct pt_regs *regs)
1462 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1464 /* free up the transfer buffer, as usb_free_urb() does not do this */
1465 kfree (urb->transfer_buffer);
1467 dbg("%s - port %d", __FUNCTION__, port->number);
1470 dbg("nonzero write bulk status received: %d", urb->status);
1474 schedule_work(&port->work);
1475 } /* ftdi_write_bulk_callback */
1478 static int ftdi_write_room( struct usb_serial_port *port )
1480 dbg("%s - port %d", __FUNCTION__, port->number);
1483 * We really can take anything the user throws at us
1484 * but let's pick a nice big number to tell the tty
1485 * layer that we have lots of free space
1488 } /* ftdi_write_room */
1491 static int ftdi_chars_in_buffer (struct usb_serial_port *port)
1492 { /* ftdi_chars_in_buffer */
1493 dbg("%s - port %d", __FUNCTION__, port->number);
1496 * We can't really account for how much data we
1497 * have sent out, but hasn't made it through to the
1498 * device, so just tell the tty layer that everything
1502 } /* ftdi_chars_in_buffer */
1506 static void ftdi_read_bulk_callback (struct urb *urb, struct pt_regs *regs)
1507 { /* ftdi_read_bulk_callback */
1508 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1509 struct tty_struct *tty;
1510 struct ftdi_private *priv;
1512 if (urb->number_of_packets > 0) {
1513 err("%s transfer_buffer_length %d actual_length %d number of packets %d",__FUNCTION__,
1514 urb->transfer_buffer_length, urb->actual_length, urb->number_of_packets );
1515 err("%s transfer_flags %x ", __FUNCTION__,urb->transfer_flags );
1518 dbg("%s - port %d", __FUNCTION__, port->number);
1520 if (port->open_count <= 0)
1525 dbg("%s - bad tty pointer - exiting",__FUNCTION__);
1529 priv = usb_get_serial_port_data(port);
1531 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1535 if (urb != port->read_urb) {
1536 err("%s - Not my urb!", __FUNCTION__);
1540 /* This will happen at close every time so it is a dbg not an err */
1541 dbg("(this is ok on close) nonzero read bulk status received: %d", urb->status);
1545 ftdi_process_read(port);
1547 } /* ftdi_read_bulk_callback */
1550 static void ftdi_process_read (void *param)
1551 { /* ftdi_process_read */
1552 struct usb_serial_port *port = (struct usb_serial_port*)param;
1554 struct tty_struct *tty;
1555 struct ftdi_private *priv;
1557 unsigned char *data;
1563 unsigned long flags;
1565 dbg("%s - port %d", __FUNCTION__, port->number);
1567 if (port->open_count <= 0)
1572 dbg("%s - bad tty pointer - exiting",__FUNCTION__);
1576 priv = usb_get_serial_port_data(port);
1578 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1582 urb = port->read_urb;
1584 dbg("%s - bad read_urb pointer - exiting", __FUNCTION__);
1588 data = urb->transfer_buffer;
1590 if (priv->rx_processed) {
1591 dbg("%s - already processed: %d bytes, %d remain", __FUNCTION__,
1593 urb->actual_length - priv->rx_processed);
1595 /* The first two bytes of every read packet are status */
1596 if (urb->actual_length > 2) {
1597 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
1599 dbg("Status only: %03oo %03oo",data[0],data[1]);
1604 /* TO DO -- check for hung up line and handle appropriately: */
1606 /* See acm.c - you do a tty_hangup - eg tty_hangup(tty) */
1607 /* if CD is dropped and the line is not CLOCAL then we should hangup */
1610 for (packet_offset = priv->rx_processed; packet_offset < urb->actual_length; packet_offset += PKTSZ) {
1613 /* Compare new line status to the old one, signal if different */
1614 /* N.B. packet may be processed more than once, but differences
1615 * are only processed once. */
1617 char new_status = data[packet_offset+0] & FTDI_STATUS_B0_MASK;
1618 if (new_status != priv->prev_status) {
1619 priv->diff_status |= new_status ^ priv->prev_status;
1620 wake_up_interruptible(&priv->delta_msr_wait);
1621 priv->prev_status = new_status;
1625 length = min(PKTSZ, urb->actual_length-packet_offset)-2;
1627 err("%s - bad packet length: %d", __FUNCTION__, length+2);
1631 if (priv->rx_flags & THROTTLED) {
1632 dbg("%s - throttled", __FUNCTION__);
1635 if (tty_buffer_request_room(tty, length) < length) {
1636 /* break out & wait for throttling/unthrottling to happen */
1637 dbg("%s - receive room low", __FUNCTION__);
1641 /* Handle errors and break */
1642 error_flag = TTY_NORMAL;
1643 /* Although the device uses a bitmask and hence can have multiple */
1644 /* errors on a packet - the order here sets the priority the */
1645 /* error is returned to the tty layer */
1647 if ( data[packet_offset+1] & FTDI_RS_OE ) {
1648 error_flag = TTY_OVERRUN;
1649 dbg("OVERRRUN error");
1651 if ( data[packet_offset+1] & FTDI_RS_BI ) {
1652 error_flag = TTY_BREAK;
1653 dbg("BREAK received");
1655 if ( data[packet_offset+1] & FTDI_RS_PE ) {
1656 error_flag = TTY_PARITY;
1657 dbg("PARITY error");
1659 if ( data[packet_offset+1] & FTDI_RS_FE ) {
1660 error_flag = TTY_FRAME;
1661 dbg("FRAMING error");
1664 for (i = 2; i < length+2; i++) {
1665 /* Note that the error flag is duplicated for
1666 every character received since we don't know
1667 which character it applied to */
1668 tty_insert_flip_char(tty, data[packet_offset+i], error_flag);
1673 #ifdef NOT_CORRECT_BUT_KEEPING_IT_FOR_NOW
1674 /* if a parity error is detected you get status packets forever
1675 until a character is sent without a parity error.
1676 This doesn't work well since the application receives a never
1677 ending stream of bad data - even though new data hasn't been sent.
1678 Therefore I (bill) have taken this out.
1679 However - this might make sense for framing errors and so on
1680 so I am leaving the code in for now.
1683 if (error_flag != TTY_NORMAL){
1684 dbg("error_flag is not normal");
1685 /* In this case it is just status - if that is an error send a bad character */
1686 if(tty->flip.count >= TTY_FLIPBUF_SIZE) {
1687 tty_flip_buffer_push(tty);
1689 tty_insert_flip_char(tty, 0xff, error_flag);
1694 } /* "for(packet_offset=0..." */
1698 tty_flip_buffer_push(tty);
1701 if (packet_offset < urb->actual_length) {
1702 /* not completely processed - record progress */
1703 priv->rx_processed = packet_offset;
1704 dbg("%s - incomplete, %d bytes processed, %d remain",
1705 __FUNCTION__, packet_offset,
1706 urb->actual_length - packet_offset);
1707 /* check if we were throttled while processing */
1708 spin_lock_irqsave(&priv->rx_lock, flags);
1709 if (priv->rx_flags & THROTTLED) {
1710 priv->rx_flags |= ACTUALLY_THROTTLED;
1711 spin_unlock_irqrestore(&priv->rx_lock, flags);
1712 dbg("%s - deferring remainder until unthrottled",
1716 spin_unlock_irqrestore(&priv->rx_lock, flags);
1717 /* if the port is closed stop trying to read */
1718 if (port->open_count > 0){
1719 /* delay processing of remainder */
1720 schedule_delayed_work(&priv->rx_work, 1);
1722 dbg("%s - port is closed", __FUNCTION__);
1727 /* urb is completely processed */
1728 priv->rx_processed = 0;
1730 /* if the port is closed stop trying to read */
1731 if (port->open_count > 0){
1732 /* Continue trying to always read */
1733 usb_fill_bulk_urb(port->read_urb, port->serial->dev,
1734 usb_rcvbulkpipe(port->serial->dev, port->bulk_in_endpointAddress),
1735 port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
1736 ftdi_read_bulk_callback, port);
1738 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1740 err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
1744 } /* ftdi_process_read */
1747 static void ftdi_break_ctl( struct usb_serial_port *port, int break_state )
1749 struct ftdi_private *priv = usb_get_serial_port_data(port);
1750 __u16 urb_value = 0;
1753 /* break_state = -1 to turn on break, and 0 to turn off break */
1754 /* see drivers/char/tty_io.c to see it used */
1755 /* last_set_data_urb_value NEVER has the break bit set in it */
1758 urb_value = priv->last_set_data_urb_value | FTDI_SIO_SET_BREAK;
1760 urb_value = priv->last_set_data_urb_value;
1764 if (usb_control_msg(port->serial->dev, usb_sndctrlpipe(port->serial->dev, 0),
1765 FTDI_SIO_SET_DATA_REQUEST,
1766 FTDI_SIO_SET_DATA_REQUEST_TYPE,
1767 urb_value , priv->interface,
1768 buf, 0, WDR_TIMEOUT) < 0) {
1769 err("%s FAILED to enable/disable break state (state was %d)", __FUNCTION__,break_state);
1772 dbg("%s break state is %d - urb is %d", __FUNCTION__,break_state, urb_value);
1777 /* old_termios contains the original termios settings and tty->termios contains
1778 * the new setting to be used
1779 * WARNING: set_termios calls this with old_termios in kernel space
1782 static void ftdi_set_termios (struct usb_serial_port *port, struct termios *old_termios)
1783 { /* ftdi_termios */
1784 struct usb_device *dev = port->serial->dev;
1785 unsigned int cflag = port->tty->termios->c_cflag;
1786 struct ftdi_private *priv = usb_get_serial_port_data(port);
1787 __u16 urb_value; /* will hold the new flags */
1788 char buf[1]; /* Perhaps I should dynamically alloc this? */
1790 // Added for xon/xoff support
1791 unsigned int iflag = port->tty->termios->c_iflag;
1792 unsigned char vstop;
1793 unsigned char vstart;
1795 dbg("%s", __FUNCTION__);
1797 /* Force baud rate if this device requires it, unless it is set to B0. */
1798 if (priv->force_baud && ((port->tty->termios->c_cflag & CBAUD) != B0)) {
1799 dbg("%s: forcing baud rate for this device", __FUNCTION__);
1800 port->tty->termios->c_cflag &= ~CBAUD;
1801 port->tty->termios->c_cflag |= priv->force_baud;
1804 /* Force RTS-CTS if this device requires it. */
1805 if (priv->force_rtscts) {
1806 dbg("%s: forcing rtscts for this device", __FUNCTION__);
1807 port->tty->termios->c_cflag |= CRTSCTS;
1810 cflag = port->tty->termios->c_cflag;
1812 /* FIXME -For this cut I don't care if the line is really changing or
1813 not - so just do the change regardless - should be able to
1814 compare old_termios and tty->termios */
1815 /* NOTE These routines can get interrupted by
1816 ftdi_sio_read_bulk_callback - need to examine what this
1817 means - don't see any problems yet */
1819 /* Set number of data bits, parity, stop bits */
1822 urb_value |= (cflag & CSTOPB ? FTDI_SIO_SET_DATA_STOP_BITS_2 :
1823 FTDI_SIO_SET_DATA_STOP_BITS_1);
1824 urb_value |= (cflag & PARENB ?
1825 (cflag & PARODD ? FTDI_SIO_SET_DATA_PARITY_ODD :
1826 FTDI_SIO_SET_DATA_PARITY_EVEN) :
1827 FTDI_SIO_SET_DATA_PARITY_NONE);
1828 if (cflag & CSIZE) {
1829 switch (cflag & CSIZE) {
1830 case CS5: urb_value |= 5; dbg("Setting CS5"); break;
1831 case CS6: urb_value |= 6; dbg("Setting CS6"); break;
1832 case CS7: urb_value |= 7; dbg("Setting CS7"); break;
1833 case CS8: urb_value |= 8; dbg("Setting CS8"); break;
1835 err("CSIZE was set but not CS5-CS8");
1839 /* This is needed by the break command since it uses the same command - but is
1840 * or'ed with this value */
1841 priv->last_set_data_urb_value = urb_value;
1843 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1844 FTDI_SIO_SET_DATA_REQUEST,
1845 FTDI_SIO_SET_DATA_REQUEST_TYPE,
1846 urb_value , priv->interface,
1847 buf, 0, WDR_SHORT_TIMEOUT) < 0) {
1848 err("%s FAILED to set databits/stopbits/parity", __FUNCTION__);
1851 /* Now do the baudrate */
1852 if ((cflag & CBAUD) == B0 ) {
1853 /* Disable flow control */
1854 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1855 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1856 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1858 buf, 0, WDR_TIMEOUT) < 0) {
1859 err("%s error from disable flowcontrol urb", __FUNCTION__);
1861 /* Drop RTS and DTR */
1862 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1864 /* set the baudrate determined before */
1865 if (change_speed(port)) {
1866 err("%s urb failed to set baudrate", __FUNCTION__);
1868 /* Ensure RTS and DTR are raised when baudrate changed from 0 */
1869 if ((old_termios->c_cflag & CBAUD) == B0) {
1870 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1874 /* Set flow control */
1875 /* Note device also supports DTR/CD (ugh) and Xon/Xoff in hardware */
1876 if (cflag & CRTSCTS) {
1877 dbg("%s Setting to CRTSCTS flow control", __FUNCTION__);
1878 if (usb_control_msg(dev,
1879 usb_sndctrlpipe(dev, 0),
1880 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1881 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1882 0 , (FTDI_SIO_RTS_CTS_HS | priv->interface),
1883 buf, 0, WDR_TIMEOUT) < 0) {
1884 err("urb failed to set to rts/cts flow control");
1891 * Check the IXOFF status in the iflag component of the termios structure
1892 * if IXOFF is not set, the pre-xon/xoff code is executed.
1894 if (iflag & IXOFF) {
1895 dbg("%s request to enable xonxoff iflag=%04x",__FUNCTION__,iflag);
1896 // Try to enable the XON/XOFF on the ftdi_sio
1897 // Set the vstart and vstop -- could have been done up above where
1898 // a lot of other dereferencing is done but that would be very
1899 // inefficient as vstart and vstop are not always needed
1900 vstart=port->tty->termios->c_cc[VSTART];
1901 vstop=port->tty->termios->c_cc[VSTOP];
1902 urb_value=(vstop << 8) | (vstart);
1904 if (usb_control_msg(dev,
1905 usb_sndctrlpipe(dev, 0),
1906 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1907 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1908 urb_value , (FTDI_SIO_XON_XOFF_HS
1910 buf, 0, WDR_TIMEOUT) < 0) {
1911 err("urb failed to set to xon/xoff flow control");
1914 /* else clause to only run if cfag ! CRTSCTS and iflag ! XOFF */
1915 /* CHECKME Assuming XON/XOFF handled by tty stack - not by device */
1916 dbg("%s Turning off hardware flow control", __FUNCTION__);
1917 if (usb_control_msg(dev,
1918 usb_sndctrlpipe(dev, 0),
1919 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1920 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1922 buf, 0, WDR_TIMEOUT) < 0) {
1923 err("urb failed to clear flow control");
1929 } /* ftdi_termios */
1932 static int ftdi_tiocmget (struct usb_serial_port *port, struct file *file)
1934 struct ftdi_private *priv = usb_get_serial_port_data(port);
1935 unsigned char buf[2];
1938 dbg("%s TIOCMGET", __FUNCTION__);
1939 switch (priv->chip_type) {
1941 /* Request the status from the device */
1942 if ((ret = usb_control_msg(port->serial->dev,
1943 usb_rcvctrlpipe(port->serial->dev, 0),
1944 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
1945 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
1947 buf, 1, WDR_TIMEOUT)) < 0 ) {
1948 err("%s Could not get modem status of device - err: %d", __FUNCTION__,
1956 /* the 8U232AM returns a two byte value (the sio is a 1 byte value) - in the same
1957 format as the data returned from the in point */
1958 if ((ret = usb_control_msg(port->serial->dev,
1959 usb_rcvctrlpipe(port->serial->dev, 0),
1960 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
1961 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
1963 buf, 2, WDR_TIMEOUT)) < 0 ) {
1964 err("%s Could not get modem status of device - err: %d", __FUNCTION__,
1974 return (buf[0] & FTDI_SIO_DSR_MASK ? TIOCM_DSR : 0) |
1975 (buf[0] & FTDI_SIO_CTS_MASK ? TIOCM_CTS : 0) |
1976 (buf[0] & FTDI_SIO_RI_MASK ? TIOCM_RI : 0) |
1977 (buf[0] & FTDI_SIO_RLSD_MASK ? TIOCM_CD : 0) |
1981 static int ftdi_tiocmset(struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear)
1983 dbg("%s TIOCMSET", __FUNCTION__);
1984 return update_mctrl(port, set, clear);
1988 static int ftdi_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
1990 struct ftdi_private *priv = usb_get_serial_port_data(port);
1992 dbg("%s cmd 0x%04x", __FUNCTION__, cmd);
1994 /* Based on code from acm.c and others */
1997 case TIOCGSERIAL: /* gets serial port data */
1998 return get_serial_info(port, (struct serial_struct __user *) arg);
2000 case TIOCSSERIAL: /* sets serial port data */
2001 return set_serial_info(port, (struct serial_struct __user *) arg);
2004 * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
2005 * - mask passed in arg for lines of interest
2006 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
2007 * Caller should use TIOCGICOUNT to see which one it was.
2009 * This code is borrowed from linux/drivers/char/serial.c
2012 while (priv != NULL) {
2013 interruptible_sleep_on(&priv->delta_msr_wait);
2014 /* see if a signal did it */
2015 if (signal_pending(current))
2016 return -ERESTARTSYS;
2018 char diff = priv->diff_status;
2021 return -EIO; /* no change => error */
2024 /* Consume all events */
2025 priv->diff_status = 0;
2027 /* Return 0 if caller wanted to know about these bits */
2028 if ( ((arg & TIOCM_RNG) && (diff & FTDI_RS0_RI)) ||
2029 ((arg & TIOCM_DSR) && (diff & FTDI_RS0_DSR)) ||
2030 ((arg & TIOCM_CD) && (diff & FTDI_RS0_RLSD)) ||
2031 ((arg & TIOCM_CTS) && (diff & FTDI_RS0_CTS)) ) {
2035 * Otherwise caller can't care less about what happened,
2036 * and so we continue to wait for more events.
2048 /* This is not necessarily an error - turns out the higher layers will do
2049 * some ioctls itself (see comment above)
2051 dbg("%s arg not supported - it was 0x%04x - check /usr/include/asm/ioctls.h", __FUNCTION__, cmd);
2053 return(-ENOIOCTLCMD);
2057 static void ftdi_throttle (struct usb_serial_port *port)
2059 struct ftdi_private *priv = usb_get_serial_port_data(port);
2060 unsigned long flags;
2062 dbg("%s - port %d", __FUNCTION__, port->number);
2064 spin_lock_irqsave(&priv->rx_lock, flags);
2065 priv->rx_flags |= THROTTLED;
2066 spin_unlock_irqrestore(&priv->rx_lock, flags);
2070 static void ftdi_unthrottle (struct usb_serial_port *port)
2072 struct ftdi_private *priv = usb_get_serial_port_data(port);
2073 int actually_throttled;
2074 unsigned long flags;
2076 dbg("%s - port %d", __FUNCTION__, port->number);
2078 spin_lock_irqsave(&priv->rx_lock, flags);
2079 actually_throttled = priv->rx_flags & ACTUALLY_THROTTLED;
2080 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
2081 spin_unlock_irqrestore(&priv->rx_lock, flags);
2083 if (actually_throttled)
2084 schedule_work(&priv->rx_work);
2087 static int __init ftdi_init (void)
2091 dbg("%s", __FUNCTION__);
2092 if (vendor > 0 && product > 0) {
2093 /* Add user specified VID/PID to reserved element of table. */
2095 for (i = 0; id_table_combined[i].idVendor; i++)
2097 id_table_combined[i].match_flags = USB_DEVICE_ID_MATCH_DEVICE;
2098 id_table_combined[i].idVendor = vendor;
2099 id_table_combined[i].idProduct = product;
2101 retval = usb_serial_register(&ftdi_sio_device);
2103 goto failed_sio_register;
2104 retval = usb_register(&ftdi_driver);
2106 goto failed_usb_register;
2108 info(DRIVER_VERSION ":" DRIVER_DESC);
2110 failed_usb_register:
2111 usb_serial_deregister(&ftdi_sio_device);
2112 failed_sio_register:
2117 static void __exit ftdi_exit (void)
2120 dbg("%s", __FUNCTION__);
2122 usb_deregister (&ftdi_driver);
2123 usb_serial_deregister (&ftdi_sio_device);
2128 module_init(ftdi_init);
2129 module_exit(ftdi_exit);
2131 MODULE_AUTHOR( DRIVER_AUTHOR );
2132 MODULE_DESCRIPTION( DRIVER_DESC );
2133 MODULE_LICENSE("GPL");
2135 module_param(debug, bool, S_IRUGO | S_IWUSR);
2136 MODULE_PARM_DESC(debug, "Debug enabled or not");
2137 module_param(vendor, ushort, 0);
2138 MODULE_PARM_DESC(vendor, "User specified vendor ID (default="
2139 __MODULE_STRING(FTDI_VID)")");
2140 module_param(product, ushort, 0);
2141 MODULE_PARM_DESC(vendor, "User specified product ID");