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_SIO_PID) },
312 { USB_DEVICE(FTDI_VID, FTDI_8U232AM_PID) },
313 { USB_DEVICE(FTDI_VID, FTDI_8U232AM_ALT_PID) },
314 { USB_DEVICE(FTDI_VID, FTDI_8U2232C_PID) },
315 { USB_DEVICE(FTDI_VID, FTDI_RELAIS_PID) },
316 { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_IOBOARD_PID) },
317 { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_MINI_IOBOARD_PID) },
318 { USB_DEVICE(FTDI_VID, FTDI_XF_632_PID) },
319 { USB_DEVICE(FTDI_VID, FTDI_XF_634_PID) },
320 { USB_DEVICE(FTDI_VID, FTDI_XF_547_PID) },
321 { USB_DEVICE(FTDI_VID, FTDI_XF_633_PID) },
322 { USB_DEVICE(FTDI_VID, FTDI_XF_631_PID) },
323 { USB_DEVICE(FTDI_VID, FTDI_XF_635_PID) },
324 { USB_DEVICE(FTDI_VID, FTDI_XF_640_PID) },
325 { USB_DEVICE(FTDI_VID, FTDI_XF_642_PID) },
326 { USB_DEVICE(FTDI_VID, FTDI_DSS20_PID) },
327 { USB_DEVICE(FTDI_NF_RIC_VID, FTDI_NF_RIC_PID) },
328 { USB_DEVICE(FTDI_VID, FTDI_VNHCPCUSB_D_PID) },
329 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_0_PID) },
330 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_1_PID) },
331 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_2_PID) },
332 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_3_PID) },
333 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_4_PID) },
334 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_5_PID) },
335 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_6_PID) },
336 { USB_DEVICE(FTDI_VID, FTDI_PERLE_ULTRAPORT_PID) },
337 { USB_DEVICE(FTDI_VID, FTDI_PIEGROUP_PID) },
338 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2101_PID) },
339 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2102_PID) },
340 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2103_PID) },
341 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2104_PID) },
342 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_1_PID) },
343 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_2_PID) },
344 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_1_PID) },
345 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_2_PID) },
346 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_1_PID) },
347 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_2_PID) },
348 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_1_PID) },
349 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_2_PID) },
350 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_3_PID) },
351 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_4_PID) },
352 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_1_PID) },
353 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_2_PID) },
354 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_3_PID) },
355 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_4_PID) },
356 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_1_PID) },
357 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_2_PID) },
358 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_3_PID) },
359 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_4_PID) },
360 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_1_PID) },
361 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_2_PID) },
362 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_3_PID) },
363 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_4_PID) },
364 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_5_PID) },
365 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_6_PID) },
366 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_7_PID) },
367 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_8_PID) },
368 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_1_PID) },
369 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_2_PID) },
370 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_3_PID) },
371 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_4_PID) },
372 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_5_PID) },
373 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_6_PID) },
374 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_7_PID) },
375 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_8_PID) },
376 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_1_PID) },
377 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_2_PID) },
378 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_3_PID) },
379 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_4_PID) },
380 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_5_PID) },
381 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_6_PID) },
382 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_7_PID) },
383 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_8_PID) },
384 { USB_DEVICE(IDTECH_VID, IDTECH_IDT1221U_PID) },
385 { USB_DEVICE(OCT_VID, OCT_US101_PID) },
386 { USB_DEVICE(FTDI_VID, FTDI_HE_TIRA1_PID),
387 .driver_info = (kernel_ulong_t)&ftdi_HE_TIRA1_quirk },
388 { USB_DEVICE(FTDI_VID, FTDI_USB_UIRT_PID),
389 .driver_info = (kernel_ulong_t)&ftdi_USB_UIRT_quirk },
390 { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_1) },
391 { USB_DEVICE(FTDI_VID, PROTEGO_R2X0) },
392 { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_3) },
393 { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_4) },
394 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E808_PID) },
395 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E809_PID) },
396 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80A_PID) },
397 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80B_PID) },
398 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80C_PID) },
399 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80D_PID) },
400 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80E_PID) },
401 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80F_PID) },
402 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E888_PID) },
403 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E889_PID) },
404 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88A_PID) },
405 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88B_PID) },
406 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88C_PID) },
407 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88D_PID) },
408 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88E_PID) },
409 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88F_PID) },
410 { USB_DEVICE(FTDI_VID, FTDI_ELV_UO100_PID) },
411 { USB_DEVICE(FTDI_VID, FTDI_ELV_UM100_PID) },
412 { USB_DEVICE(FTDI_VID, FTDI_ELV_UR100_PID) },
413 { USB_DEVICE(FTDI_VID, FTDI_ELV_ALC8500_PID) },
414 { USB_DEVICE(FTDI_VID, FTDI_PYRAMID_PID) },
416 * These will probably use user-space drivers. Uncomment them if
417 * you need them or use the user-specified vendor/product module
418 * parameters (see ftdi_sio.h for the numbers). Make a fuss if
419 * you think the driver should recognize any of them by default.
421 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_CLI7000_PID) }, */
422 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_PPS7330_PID) }, */
423 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_TFM100_PID) }, */
424 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UDF77_PID) }, */
425 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UIO88_PID) }, */
426 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UAD8_PID) }, */
427 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UDA7_PID) }, */
428 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_USI2_PID) }, */
429 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_T1100_PID) }, */
430 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_PCD200_PID) }, */
431 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_ULA200_PID) }, */
432 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1000PC_PID) }, */
433 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_CSI8_PID) }, */
434 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_EM1000DL_PID) }, */
435 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_PCK100_PID) }, */
436 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_RFP500_PID) }, */
437 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_FS20SIG_PID) }, */
438 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_WS300PC_PID) }, */
439 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1300PC_PID) }, */
440 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_WS500_PID) }, */
441 { USB_DEVICE(FTDI_VID, LINX_SDMUSBQSS_PID) },
442 { USB_DEVICE(FTDI_VID, LINX_MASTERDEVEL2_PID) },
443 { USB_DEVICE(FTDI_VID, LINX_FUTURE_0_PID) },
444 { USB_DEVICE(FTDI_VID, LINX_FUTURE_1_PID) },
445 { USB_DEVICE(FTDI_VID, LINX_FUTURE_2_PID) },
446 { USB_DEVICE(FTDI_VID, FTDI_CCSICDU20_0_PID) },
447 { USB_DEVICE(FTDI_VID, FTDI_CCSICDU40_1_PID) },
448 { USB_DEVICE(FTDI_VID, INSIDE_ACCESSO) },
449 { USB_DEVICE(INTREPID_VID, INTREPID_VALUECAN_PID) },
450 { USB_DEVICE(INTREPID_VID, INTREPID_NEOVI_PID) },
451 { USB_DEVICE(FALCOM_VID, FALCOM_TWIST_PID) },
452 { USB_DEVICE(FALCOM_VID, FALCOM_SAMBA_PID) },
453 { USB_DEVICE(FTDI_VID, FTDI_SUUNTO_SPORTS_PID) },
454 { USB_DEVICE(FTDI_VID, FTDI_RM_CANVIEW_PID) },
455 { USB_DEVICE(BANDB_VID, BANDB_USOTL4_PID) },
456 { USB_DEVICE(BANDB_VID, BANDB_USTL4_PID) },
457 { USB_DEVICE(BANDB_VID, BANDB_USO9ML2_PID) },
458 { USB_DEVICE(FTDI_VID, EVER_ECO_PRO_CDS) },
459 { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_0_PID) },
460 { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_1_PID) },
461 { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_2_PID) },
462 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_0_PID) },
463 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_1_PID) },
464 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_2_PID) },
465 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_3_PID) },
466 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_4_PID) },
467 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_5_PID) },
468 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_6_PID) },
469 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_7_PID) },
470 { USB_DEVICE(MOBILITY_VID, MOBILITY_USB_SERIAL_PID) },
471 { USB_DEVICE(FTDI_VID, FTDI_ACTIVE_ROBOTS_PID) },
472 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y6_PID) },
473 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y8_PID) },
474 { USB_DEVICE(EVOLUTION_VID, EVOLUTION_ER1_PID) },
475 { USB_DEVICE(FTDI_VID, FTDI_ARTEMIS_PID) },
476 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16_PID) },
477 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HR_PID) },
478 { }, /* Optional parameter entry */
479 { } /* Terminating entry */
482 MODULE_DEVICE_TABLE (usb, id_table_combined);
484 static struct usb_driver ftdi_driver = {
486 .probe = usb_serial_probe,
487 .disconnect = usb_serial_disconnect,
488 .id_table = id_table_combined,
491 static char *ftdi_chip_name[] = {
492 [SIO] = "SIO", /* the serial part of FT8U100AX */
493 [FT8U232AM] = "FT8U232AM",
494 [FT232BM] = "FT232BM",
495 [FT2232C] = "FT2232C",
499 /* Constants for read urb and write urb */
504 #define THROTTLED 0x01
505 #define ACTUALLY_THROTTLED 0x02
507 struct ftdi_private {
508 ftdi_chip_type_t chip_type;
509 /* type of the device, either SIO or FT8U232AM */
510 int baud_base; /* baud base clock for divisor setting */
511 int custom_divisor; /* custom_divisor kludge, this is for baud_base (different from what goes to the chip!) */
512 __u16 last_set_data_urb_value ;
513 /* the last data state set - needed for doing a break */
514 int write_offset; /* This is the offset in the usb data block to write the serial data -
515 * it is different between devices
517 int flags; /* some ASYNC_xxxx flags are supported */
518 unsigned long last_dtr_rts; /* saved modem control outputs */
519 wait_queue_head_t delta_msr_wait; /* Used for TIOCMIWAIT */
520 char prev_status, diff_status; /* Used for TIOCMIWAIT */
521 __u8 rx_flags; /* receive state flags (throttling) */
522 spinlock_t rx_lock; /* spinlock for receive state */
523 struct work_struct rx_work;
526 __u16 interface; /* FT2232C port interface (0 for FT232/245) */
528 int force_baud; /* if non-zero, force the baud rate to this value */
529 int force_rtscts; /* if non-zero, force RTS-CTS to always be enabled */
532 /* Used for TIOCMIWAIT */
533 #define FTDI_STATUS_B0_MASK (FTDI_RS0_CTS | FTDI_RS0_DSR | FTDI_RS0_RI | FTDI_RS0_RLSD)
534 #define FTDI_STATUS_B1_MASK (FTDI_RS_BI)
537 #define FTDI_IMPL_ASYNC_FLAGS = ( ASYNC_SPD_HI | ASYNC_SPD_VHI \
538 ASYNC_SPD_CUST | ASYNC_SPD_SHI | ASYNC_SPD_WARP )
540 /* function prototypes for a FTDI serial converter */
541 static int ftdi_sio_probe (struct usb_serial *serial, const struct usb_device_id *id);
542 static int ftdi_sio_attach (struct usb_serial *serial);
543 static void ftdi_shutdown (struct usb_serial *serial);
544 static int ftdi_open (struct usb_serial_port *port, struct file *filp);
545 static void ftdi_close (struct usb_serial_port *port, struct file *filp);
546 static int ftdi_write (struct usb_serial_port *port, const unsigned char *buf, int count);
547 static int ftdi_write_room (struct usb_serial_port *port);
548 static int ftdi_chars_in_buffer (struct usb_serial_port *port);
549 static void ftdi_write_bulk_callback (struct urb *urb, struct pt_regs *regs);
550 static void ftdi_read_bulk_callback (struct urb *urb, struct pt_regs *regs);
551 static void ftdi_process_read (void *param);
552 static void ftdi_set_termios (struct usb_serial_port *port, struct termios * old);
553 static int ftdi_tiocmget (struct usb_serial_port *port, struct file *file);
554 static int ftdi_tiocmset (struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear);
555 static int ftdi_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg);
556 static void ftdi_break_ctl (struct usb_serial_port *port, int break_state );
557 static void ftdi_throttle (struct usb_serial_port *port);
558 static void ftdi_unthrottle (struct usb_serial_port *port);
560 static unsigned short int ftdi_232am_baud_base_to_divisor (int baud, int base);
561 static unsigned short int ftdi_232am_baud_to_divisor (int baud);
562 static __u32 ftdi_232bm_baud_base_to_divisor (int baud, int base);
563 static __u32 ftdi_232bm_baud_to_divisor (int baud);
565 static struct usb_serial_device_type ftdi_sio_device = {
566 .owner = THIS_MODULE,
567 .name = "FTDI USB Serial Device",
568 .short_name = "ftdi_sio",
569 .id_table = id_table_combined,
570 .num_interrupt_in = 0,
574 .probe = ftdi_sio_probe,
577 .throttle = ftdi_throttle,
578 .unthrottle = ftdi_unthrottle,
580 .write_room = ftdi_write_room,
581 .chars_in_buffer = ftdi_chars_in_buffer,
582 .read_bulk_callback = ftdi_read_bulk_callback,
583 .write_bulk_callback = ftdi_write_bulk_callback,
584 .tiocmget = ftdi_tiocmget,
585 .tiocmset = ftdi_tiocmset,
587 .set_termios = ftdi_set_termios,
588 .break_ctl = ftdi_break_ctl,
589 .attach = ftdi_sio_attach,
590 .shutdown = ftdi_shutdown,
594 #define WDR_TIMEOUT 5000 /* default urb timeout */
595 #define WDR_SHORT_TIMEOUT 1000 /* shorter urb timeout */
597 /* High and low are for DTR, RTS etc etc */
602 * ***************************************************************************
604 * ***************************************************************************
607 static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base)
609 unsigned short int divisor;
610 int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
611 if ((divisor3 & 0x7) == 7) divisor3 ++; // round x.7/8 up to x+1
612 divisor = divisor3 >> 3;
614 if (divisor3 == 1) divisor |= 0xc000; else // 0.125
615 if (divisor3 >= 4) divisor |= 0x4000; else // 0.5
616 if (divisor3 != 0) divisor |= 0x8000; // 0.25
617 if (divisor == 1) divisor = 0; /* special case for maximum baud rate */
621 static unsigned short int ftdi_232am_baud_to_divisor(int baud)
623 return(ftdi_232am_baud_base_to_divisor(baud, 48000000));
626 static __u32 ftdi_232bm_baud_base_to_divisor(int baud, int base)
628 static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
630 int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
631 divisor = divisor3 >> 3;
632 divisor |= (__u32)divfrac[divisor3 & 0x7] << 14;
633 /* Deal with special cases for highest baud rates. */
634 if (divisor == 1) divisor = 0; else // 1.0
635 if (divisor == 0x4001) divisor = 1; // 1.5
639 static __u32 ftdi_232bm_baud_to_divisor(int baud)
641 return(ftdi_232bm_baud_base_to_divisor(baud, 48000000));
644 #define set_mctrl(port, set) update_mctrl((port), (set), 0)
645 #define clear_mctrl(port, clear) update_mctrl((port), 0, (clear))
647 static int update_mctrl(struct usb_serial_port *port, unsigned int set, unsigned int clear)
649 struct ftdi_private *priv = usb_get_serial_port_data(port);
654 if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
655 dbg("%s - DTR|RTS not being set|cleared", __FUNCTION__);
656 return 0; /* no change */
659 buf = kmalloc(1, GFP_NOIO);
664 clear &= ~set; /* 'set' takes precedence over 'clear' */
666 if (clear & TIOCM_DTR)
667 urb_value |= FTDI_SIO_SET_DTR_LOW;
668 if (clear & TIOCM_RTS)
669 urb_value |= FTDI_SIO_SET_RTS_LOW;
671 urb_value |= FTDI_SIO_SET_DTR_HIGH;
673 urb_value |= FTDI_SIO_SET_RTS_HIGH;
674 rv = usb_control_msg(port->serial->dev,
675 usb_sndctrlpipe(port->serial->dev, 0),
676 FTDI_SIO_SET_MODEM_CTRL_REQUEST,
677 FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE,
678 urb_value, priv->interface,
679 buf, 0, WDR_TIMEOUT);
683 err("%s Error from MODEM_CTRL urb: DTR %s, RTS %s",
685 (set & TIOCM_DTR) ? "HIGH" :
686 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
687 (set & TIOCM_RTS) ? "HIGH" :
688 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
690 dbg("%s - DTR %s, RTS %s", __FUNCTION__,
691 (set & TIOCM_DTR) ? "HIGH" :
692 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
693 (set & TIOCM_RTS) ? "HIGH" :
694 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
695 priv->last_dtr_rts = (priv->last_dtr_rts & ~clear) | set;
701 static __u32 get_ftdi_divisor(struct usb_serial_port * port);
704 static int change_speed(struct usb_serial_port *port)
706 struct ftdi_private *priv = usb_get_serial_port_data(port);
710 __u32 urb_index_value;
713 buf = kmalloc(1, GFP_NOIO);
717 urb_index_value = get_ftdi_divisor(port);
718 urb_value = (__u16)urb_index_value;
719 urb_index = (__u16)(urb_index_value >> 16);
720 if (priv->interface) { /* FT2232C */
721 urb_index = (__u16)((urb_index << 8) | priv->interface);
724 rv = usb_control_msg(port->serial->dev,
725 usb_sndctrlpipe(port->serial->dev, 0),
726 FTDI_SIO_SET_BAUDRATE_REQUEST,
727 FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE,
728 urb_value, urb_index,
729 buf, 0, WDR_SHORT_TIMEOUT);
736 static __u32 get_ftdi_divisor(struct usb_serial_port * port)
737 { /* get_ftdi_divisor */
738 struct ftdi_private *priv = usb_get_serial_port_data(port);
744 * The logic involved in setting the baudrate can be cleanly split in 3 steps.
745 * Obtaining the actual baud rate is a little tricky since unix traditionally
746 * somehow ignored the possibility to set non-standard baud rates.
747 * 1. Standard baud rates are set in tty->termios->c_cflag
748 * 2. If these are not enough, you can set any speed using alt_speed as follows:
749 * - set tty->termios->c_cflag speed to B38400
750 * - set your real speed in tty->alt_speed; it gets ignored when
752 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
753 * flags & ASYNC_SPD_MASK == ASYNC_SPD_[HI, VHI, SHI, WARP], this just
754 * sets alt_speed to (HI: 57600, VHI: 115200, SHI: 230400, WARP: 460800)
755 * ** Steps 1, 2 are done courtesy of tty_get_baud_rate
756 * 3. You can also set baud rate by setting custom divisor as follows
757 * - set tty->termios->c_cflag speed to B38400
758 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
759 * o flags & ASYNC_SPD_MASK == ASYNC_SPD_CUST
760 * o custom_divisor set to baud_base / your_new_baudrate
761 * ** Step 3 is done courtesy of code borrowed from serial.c - I should really
762 * spend some time and separate+move this common code to serial.c, it is
763 * replicated in nearly every serial driver you see.
766 /* 1. Get the baud rate from the tty settings, this observes alt_speed hack */
768 baud = tty_get_baud_rate(port->tty);
769 dbg("%s - tty_get_baud_rate reports speed %d", __FUNCTION__, baud);
771 /* 2. Observe async-compatible custom_divisor hack, update baudrate if needed */
774 ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
775 (priv->custom_divisor)) {
776 baud = priv->baud_base / priv->custom_divisor;
777 dbg("%s - custom divisor %d sets baud rate to %d", __FUNCTION__, priv->custom_divisor, baud);
780 /* 3. Convert baudrate to device-specific divisor */
782 if (!baud) baud = 9600;
783 switch(priv->chip_type) {
784 case SIO: /* SIO chip */
786 case 300: div_value = ftdi_sio_b300; break;
787 case 600: div_value = ftdi_sio_b600; break;
788 case 1200: div_value = ftdi_sio_b1200; break;
789 case 2400: div_value = ftdi_sio_b2400; break;
790 case 4800: div_value = ftdi_sio_b4800; break;
791 case 9600: div_value = ftdi_sio_b9600; break;
792 case 19200: div_value = ftdi_sio_b19200; break;
793 case 38400: div_value = ftdi_sio_b38400; break;
794 case 57600: div_value = ftdi_sio_b57600; break;
795 case 115200: div_value = ftdi_sio_b115200; break;
797 if (div_value == 0) {
798 dbg("%s - Baudrate (%d) requested is not supported", __FUNCTION__, baud);
799 div_value = ftdi_sio_b9600;
803 case FT8U232AM: /* 8U232AM chip */
804 if (baud <= 3000000) {
805 div_value = ftdi_232am_baud_to_divisor(baud);
807 dbg("%s - Baud rate too high!", __FUNCTION__);
808 div_value = ftdi_232am_baud_to_divisor(9600);
812 case FT232BM: /* FT232BM chip */
813 case FT2232C: /* FT2232C chip */
814 if (baud <= 3000000) {
815 div_value = ftdi_232bm_baud_to_divisor(baud);
817 dbg("%s - Baud rate too high!", __FUNCTION__);
818 div_value = ftdi_232bm_baud_to_divisor(9600);
822 } /* priv->chip_type */
825 dbg("%s - Baud rate set to %d (divisor 0x%lX) on chip %s",
826 __FUNCTION__, baud, (unsigned long)div_value,
827 ftdi_chip_name[priv->chip_type]);
834 static int get_serial_info(struct usb_serial_port * port, struct serial_struct __user * retinfo)
836 struct ftdi_private *priv = usb_get_serial_port_data(port);
837 struct serial_struct tmp;
841 memset(&tmp, 0, sizeof(tmp));
842 tmp.flags = priv->flags;
843 tmp.baud_base = priv->baud_base;
844 tmp.custom_divisor = priv->custom_divisor;
845 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
848 } /* get_serial_info */
851 static int set_serial_info(struct usb_serial_port * port, struct serial_struct __user * newinfo)
852 { /* set_serial_info */
853 struct ftdi_private *priv = usb_get_serial_port_data(port);
854 struct serial_struct new_serial;
855 struct ftdi_private old_priv;
857 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
861 /* Do error checking and permission checking */
863 if (!capable(CAP_SYS_ADMIN)) {
864 if (((new_serial.flags & ~ASYNC_USR_MASK) !=
865 (priv->flags & ~ASYNC_USR_MASK)))
867 priv->flags = ((priv->flags & ~ASYNC_USR_MASK) |
868 (new_serial.flags & ASYNC_USR_MASK));
869 priv->custom_divisor = new_serial.custom_divisor;
873 if ((new_serial.baud_base != priv->baud_base) &&
874 (new_serial.baud_base < 9600))
877 /* Make the changes - these are privileged changes! */
879 priv->flags = ((priv->flags & ~ASYNC_FLAGS) |
880 (new_serial.flags & ASYNC_FLAGS));
881 priv->custom_divisor = new_serial.custom_divisor;
883 port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
886 if ((old_priv.flags & ASYNC_SPD_MASK) !=
887 (priv->flags & ASYNC_SPD_MASK)) {
888 if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_HI)
889 port->tty->alt_speed = 57600;
890 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_VHI)
891 port->tty->alt_speed = 115200;
892 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_SHI)
893 port->tty->alt_speed = 230400;
894 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_WARP)
895 port->tty->alt_speed = 460800;
897 port->tty->alt_speed = 0;
899 if (((old_priv.flags & ASYNC_SPD_MASK) !=
900 (priv->flags & ASYNC_SPD_MASK)) ||
901 (((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
902 (old_priv.custom_divisor != priv->custom_divisor))) {
908 } /* set_serial_info */
911 /* Determine type of FTDI chip based on USB config and descriptor. */
912 static void ftdi_determine_type(struct usb_serial_port *port)
914 struct ftdi_private *priv = usb_get_serial_port_data(port);
915 struct usb_serial *serial = port->serial;
916 struct usb_device *udev = serial->dev;
920 /* Assume it is not the original SIO device for now. */
921 priv->baud_base = 48000000 / 2;
922 priv->write_offset = 0;
924 version = le16_to_cpu(udev->descriptor.bcdDevice);
925 interfaces = udev->actconfig->desc.bNumInterfaces;
926 dbg("%s: bcdDevice = 0x%x, bNumInterfaces = %u", __FUNCTION__,
927 version, interfaces);
928 if (interfaces > 1) {
931 /* Multiple interfaces. Assume FT2232C. */
932 priv->chip_type = FT2232C;
933 /* Determine interface code. */
934 inter = serial->interface->altsetting->desc.bInterfaceNumber;
936 priv->interface = PIT_SIOA;
938 priv->interface = PIT_SIOB;
940 /* BM-type devices have a bug where bcdDevice gets set
941 * to 0x200 when iSerialNumber is 0. */
942 if (version < 0x500) {
943 dbg("%s: something fishy - bcdDevice too low for multi-interface device",
946 } else if (version < 0x200) {
947 /* Old device. Assume its the original SIO. */
948 priv->chip_type = SIO;
949 priv->baud_base = 12000000 / 16;
950 priv->write_offset = 1;
951 } else if (version < 0x400) {
952 /* Assume its an FT8U232AM (or FT8U245AM) */
953 /* (It might be a BM because of the iSerialNumber bug,
954 * but it will still work as an AM device.) */
955 priv->chip_type = FT8U232AM;
957 /* Assume its an FT232BM (or FT245BM) */
958 priv->chip_type = FT232BM;
960 info("Detected %s", ftdi_chip_name[priv->chip_type]);
965 * ***************************************************************************
967 * ***************************************************************************
970 static ssize_t show_latency_timer(struct device *dev, struct device_attribute *attr, char *buf)
972 struct usb_serial_port *port = to_usb_serial_port(dev);
973 struct ftdi_private *priv = usb_get_serial_port_data(port);
974 struct usb_device *udev;
975 unsigned short latency = 0;
978 udev = to_usb_device(dev);
980 dbg("%s",__FUNCTION__);
982 rv = usb_control_msg(udev,
983 usb_rcvctrlpipe(udev, 0),
984 FTDI_SIO_GET_LATENCY_TIMER_REQUEST,
985 FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE,
987 (char*) &latency, 1, WDR_TIMEOUT);
990 dev_err(dev, "Unable to read latency timer: %i", rv);
993 return sprintf(buf, "%i\n", latency);
996 /* Write a new value of the latency timer, in units of milliseconds. */
997 static ssize_t store_latency_timer(struct device *dev, struct device_attribute *attr, const char *valbuf,
1000 struct usb_serial_port *port = to_usb_serial_port(dev);
1001 struct ftdi_private *priv = usb_get_serial_port_data(port);
1002 struct usb_device *udev;
1004 int v = simple_strtoul(valbuf, NULL, 10);
1007 udev = to_usb_device(dev);
1009 dbg("%s: setting latency timer = %i", __FUNCTION__, v);
1011 rv = usb_control_msg(udev,
1012 usb_sndctrlpipe(udev, 0),
1013 FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
1014 FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
1016 buf, 0, WDR_TIMEOUT);
1019 dev_err(dev, "Unable to write latency timer: %i", rv);
1026 /* Write an event character directly to the FTDI register. The ASCII
1027 value is in the low 8 bits, with the enable bit in the 9th bit. */
1028 static ssize_t store_event_char(struct device *dev, struct device_attribute *attr, const char *valbuf,
1031 struct usb_serial_port *port = to_usb_serial_port(dev);
1032 struct ftdi_private *priv = usb_get_serial_port_data(port);
1033 struct usb_device *udev;
1035 int v = simple_strtoul(valbuf, NULL, 10);
1038 udev = to_usb_device(dev);
1040 dbg("%s: setting event char = %i", __FUNCTION__, v);
1042 rv = usb_control_msg(udev,
1043 usb_sndctrlpipe(udev, 0),
1044 FTDI_SIO_SET_EVENT_CHAR_REQUEST,
1045 FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE,
1047 buf, 0, WDR_TIMEOUT);
1050 dbg("Unable to write event character: %i", rv);
1057 static DEVICE_ATTR(latency_timer, S_IWUSR | S_IRUGO, show_latency_timer, store_latency_timer);
1058 static DEVICE_ATTR(event_char, S_IWUSR, NULL, store_event_char);
1060 static void create_sysfs_attrs(struct usb_serial *serial)
1062 struct ftdi_private *priv;
1063 struct usb_device *udev;
1065 dbg("%s",__FUNCTION__);
1067 priv = usb_get_serial_port_data(serial->port[0]);
1070 /* XXX I've no idea if the original SIO supports the event_char
1071 * sysfs parameter, so I'm playing it safe. */
1072 if (priv->chip_type != SIO) {
1073 dbg("sysfs attributes for %s", ftdi_chip_name[priv->chip_type]);
1074 device_create_file(&udev->dev, &dev_attr_event_char);
1075 if (priv->chip_type == FT232BM || priv->chip_type == FT2232C) {
1076 device_create_file(&udev->dev, &dev_attr_latency_timer);
1081 static void remove_sysfs_attrs(struct usb_serial *serial)
1083 struct ftdi_private *priv;
1084 struct usb_device *udev;
1086 dbg("%s",__FUNCTION__);
1088 priv = usb_get_serial_port_data(serial->port[0]);
1091 /* XXX see create_sysfs_attrs */
1092 if (priv->chip_type != SIO) {
1093 device_remove_file(&udev->dev, &dev_attr_event_char);
1094 if (priv->chip_type == FT232BM || priv->chip_type == FT2232C) {
1095 device_remove_file(&udev->dev, &dev_attr_latency_timer);
1102 * ***************************************************************************
1103 * FTDI driver specific functions
1104 * ***************************************************************************
1107 /* Probe function to check for special devices */
1108 static int ftdi_sio_probe (struct usb_serial *serial, const struct usb_device_id *id)
1110 usb_set_serial_data(serial, (void *)id->driver_info);
1115 /* attach subroutine */
1116 static int ftdi_sio_attach (struct usb_serial *serial)
1118 struct usb_serial_port *port = serial->port[0];
1119 struct ftdi_private *priv;
1120 struct ftdi_sio_quirk *quirk;
1122 dbg("%s",__FUNCTION__);
1124 priv = kmalloc(sizeof(struct ftdi_private), GFP_KERNEL);
1126 err("%s- kmalloc(%Zd) failed.", __FUNCTION__, sizeof(struct ftdi_private));
1129 memset(priv, 0, sizeof(*priv));
1131 spin_lock_init(&priv->rx_lock);
1132 init_waitqueue_head(&priv->delta_msr_wait);
1133 /* This will push the characters through immediately rather
1134 than queue a task to deliver them */
1135 priv->flags = ASYNC_LOW_LATENCY;
1137 /* Increase the size of read buffers */
1138 kfree(port->bulk_in_buffer);
1139 port->bulk_in_buffer = kmalloc (BUFSZ, GFP_KERNEL);
1140 if (!port->bulk_in_buffer) {
1144 if (port->read_urb) {
1145 port->read_urb->transfer_buffer = port->bulk_in_buffer;
1146 port->read_urb->transfer_buffer_length = BUFSZ;
1149 INIT_WORK(&priv->rx_work, ftdi_process_read, port);
1151 /* Free port's existing write urb and transfer buffer. */
1152 if (port->write_urb) {
1153 usb_free_urb (port->write_urb);
1154 port->write_urb = NULL;
1156 kfree(port->bulk_out_buffer);
1157 port->bulk_out_buffer = NULL;
1159 usb_set_serial_port_data(serial->port[0], priv);
1161 ftdi_determine_type (serial->port[0]);
1162 create_sysfs_attrs(serial);
1164 /* Check for device requiring special set up. */
1165 quirk = (struct ftdi_sio_quirk *)usb_get_serial_data(serial);
1166 if (quirk && quirk->setup) {
1167 quirk->setup(serial);
1171 } /* ftdi_sio_attach */
1174 /* Setup for the USB-UIRT device, which requires hardwired
1175 * baudrate (38400 gets mapped to 312500) */
1176 /* Called from usbserial:serial_probe */
1177 static void ftdi_USB_UIRT_setup (struct usb_serial *serial)
1179 struct ftdi_private *priv;
1181 dbg("%s",__FUNCTION__);
1183 priv = usb_get_serial_port_data(serial->port[0]);
1184 priv->flags |= ASYNC_SPD_CUST;
1185 priv->custom_divisor = 77;
1186 priv->force_baud = B38400;
1187 } /* ftdi_USB_UIRT_setup */
1189 /* Setup for the HE-TIRA1 device, which requires hardwired
1190 * baudrate (38400 gets mapped to 100000) and RTS-CTS enabled. */
1191 static void ftdi_HE_TIRA1_setup (struct usb_serial *serial)
1193 struct ftdi_private *priv;
1195 dbg("%s",__FUNCTION__);
1197 priv = usb_get_serial_port_data(serial->port[0]);
1198 priv->flags |= ASYNC_SPD_CUST;
1199 priv->custom_divisor = 240;
1200 priv->force_baud = B38400;
1201 priv->force_rtscts = 1;
1202 } /* ftdi_HE_TIRA1_setup */
1205 /* ftdi_shutdown is called from usbserial:usb_serial_disconnect
1206 * it is called when the usb device is disconnected
1208 * usbserial:usb_serial_disconnect
1209 * calls __serial_close for each open of the port
1210 * shutdown is called then (ie ftdi_shutdown)
1214 static void ftdi_shutdown (struct usb_serial *serial)
1215 { /* ftdi_shutdown */
1217 struct usb_serial_port *port = serial->port[0];
1218 struct ftdi_private *priv = usb_get_serial_port_data(port);
1220 dbg("%s", __FUNCTION__);
1222 remove_sysfs_attrs(serial);
1224 /* all open ports are closed at this point
1225 * (by usbserial.c:__serial_close, which calls ftdi_close)
1229 usb_set_serial_port_data(port, NULL);
1232 } /* ftdi_shutdown */
1235 static int ftdi_open (struct usb_serial_port *port, struct file *filp)
1237 struct termios tmp_termios;
1238 struct usb_device *dev = port->serial->dev;
1239 struct ftdi_private *priv = usb_get_serial_port_data(port);
1240 unsigned long flags;
1243 char buf[1]; /* Needed for the usb_control_msg I think */
1245 dbg("%s", __FUNCTION__);
1248 port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
1250 /* No error checking for this (will get errors later anyway) */
1251 /* See ftdi_sio.h for description of what is reset */
1252 usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1253 FTDI_SIO_RESET_REQUEST, FTDI_SIO_RESET_REQUEST_TYPE,
1255 priv->interface, buf, 0, WDR_TIMEOUT);
1257 /* Termios defaults are set by usb_serial_init. We don't change
1258 port->tty->termios - this would loose speed settings, etc.
1259 This is same behaviour as serial.c/rs_open() - Kuba */
1261 /* ftdi_set_termios will send usb control messages */
1262 ftdi_set_termios(port, &tmp_termios);
1264 /* FIXME: Flow control might be enabled, so it should be checked -
1265 we have no control of defaults! */
1266 /* Turn on RTS and DTR since we are not flow controlling by default */
1267 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1270 spin_lock_irqsave(&priv->rx_lock, flags);
1271 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
1272 spin_unlock_irqrestore(&priv->rx_lock, flags);
1274 /* Start reading from the device */
1275 priv->rx_processed = 0;
1276 usb_fill_bulk_urb(port->read_urb, dev,
1277 usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress),
1278 port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
1279 ftdi_read_bulk_callback, port);
1280 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
1282 err("%s - failed submitting read urb, error %d", __FUNCTION__, result);
1291 * usbserial:__serial_close only calls ftdi_close if the point is open
1293 * This only gets called when it is the last close
1298 static void ftdi_close (struct usb_serial_port *port, struct file *filp)
1300 unsigned int c_cflag = port->tty->termios->c_cflag;
1301 struct ftdi_private *priv = usb_get_serial_port_data(port);
1304 dbg("%s", __FUNCTION__);
1306 if (c_cflag & HUPCL){
1307 /* Disable flow control */
1308 if (usb_control_msg(port->serial->dev,
1309 usb_sndctrlpipe(port->serial->dev, 0),
1310 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1311 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1312 0, priv->interface, buf, 0,
1314 err("error from flowcontrol urb");
1317 /* drop RTS and DTR */
1318 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1319 } /* Note change no line if hupcl is off */
1321 /* cancel any scheduled reading */
1322 cancel_delayed_work(&priv->rx_work);
1323 flush_scheduled_work();
1325 /* shutdown our bulk read */
1327 usb_kill_urb(port->read_urb);
1332 /* The SIO requires the first byte to have:
1335 * B2..7 length of message excluding byte 0
1337 * The new devices do not require this byte
1339 static int ftdi_write (struct usb_serial_port *port,
1340 const unsigned char *buf, int count)
1342 struct ftdi_private *priv = usb_get_serial_port_data(port);
1344 unsigned char *buffer;
1345 int data_offset ; /* will be 1 for the SIO and 0 otherwise */
1349 dbg("%s port %d, %d bytes", __FUNCTION__, port->number, count);
1352 dbg("write request of 0 bytes");
1356 data_offset = priv->write_offset;
1357 dbg("data_offset set to %d",data_offset);
1359 /* Determine total transfer size */
1360 transfer_size = count;
1361 if (data_offset > 0) {
1362 /* Original sio needs control bytes too... */
1363 transfer_size += (data_offset *
1364 ((count + (PKTSZ - 1 - data_offset)) /
1365 (PKTSZ - data_offset)));
1368 buffer = kmalloc (transfer_size, GFP_ATOMIC);
1370 err("%s ran out of kernel memory for urb ...", __FUNCTION__);
1374 urb = usb_alloc_urb(0, GFP_ATOMIC);
1376 err("%s - no more free urbs", __FUNCTION__);
1382 if (data_offset > 0) {
1383 /* Original sio requires control byte at start of each packet. */
1384 int user_pktsz = PKTSZ - data_offset;
1386 unsigned char *first_byte = buffer;
1387 const unsigned char *current_position = buf;
1390 if (user_pktsz > todo) {
1393 /* Write the control byte at the front of the packet*/
1394 *first_byte = 1 | ((user_pktsz) << 2);
1395 /* Copy data for packet */
1396 memcpy (first_byte + data_offset,
1397 current_position, user_pktsz);
1398 first_byte += user_pktsz + data_offset;
1399 current_position += user_pktsz;
1403 /* No control byte required. */
1404 /* Copy in the data to send */
1405 memcpy (buffer, buf, count);
1408 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, transfer_size, buffer);
1410 /* fill the buffer and send it */
1411 usb_fill_bulk_urb(urb, port->serial->dev,
1412 usb_sndbulkpipe(port->serial->dev, port->bulk_out_endpointAddress),
1413 buffer, transfer_size,
1414 ftdi_write_bulk_callback, port);
1416 status = usb_submit_urb(urb, GFP_ATOMIC);
1418 err("%s - failed submitting write urb, error %d", __FUNCTION__, status);
1423 /* we are done with this urb, so let the host driver
1424 * really free it when it is finished with it */
1427 dbg("%s write returning: %d", __FUNCTION__, count);
1432 /* This function may get called when the device is closed */
1434 static void ftdi_write_bulk_callback (struct urb *urb, struct pt_regs *regs)
1436 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1438 /* free up the transfer buffer, as usb_free_urb() does not do this */
1439 kfree (urb->transfer_buffer);
1441 dbg("%s - port %d", __FUNCTION__, port->number);
1444 dbg("nonzero write bulk status received: %d", urb->status);
1448 schedule_work(&port->work);
1449 } /* ftdi_write_bulk_callback */
1452 static int ftdi_write_room( struct usb_serial_port *port )
1454 dbg("%s - port %d", __FUNCTION__, port->number);
1457 * We really can take anything the user throws at us
1458 * but let's pick a nice big number to tell the tty
1459 * layer that we have lots of free space
1462 } /* ftdi_write_room */
1465 static int ftdi_chars_in_buffer (struct usb_serial_port *port)
1466 { /* ftdi_chars_in_buffer */
1467 dbg("%s - port %d", __FUNCTION__, port->number);
1470 * We can't really account for how much data we
1471 * have sent out, but hasn't made it through to the
1472 * device, so just tell the tty layer that everything
1476 } /* ftdi_chars_in_buffer */
1480 static void ftdi_read_bulk_callback (struct urb *urb, struct pt_regs *regs)
1481 { /* ftdi_read_bulk_callback */
1482 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1483 struct tty_struct *tty;
1484 struct ftdi_private *priv;
1486 if (urb->number_of_packets > 0) {
1487 err("%s transfer_buffer_length %d actual_length %d number of packets %d",__FUNCTION__,
1488 urb->transfer_buffer_length, urb->actual_length, urb->number_of_packets );
1489 err("%s transfer_flags %x ", __FUNCTION__,urb->transfer_flags );
1492 dbg("%s - port %d", __FUNCTION__, port->number);
1494 if (port->open_count <= 0)
1499 dbg("%s - bad tty pointer - exiting",__FUNCTION__);
1503 priv = usb_get_serial_port_data(port);
1505 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1509 if (urb != port->read_urb) {
1510 err("%s - Not my urb!", __FUNCTION__);
1514 /* This will happen at close every time so it is a dbg not an err */
1515 dbg("(this is ok on close) nonzero read bulk status received: %d", urb->status);
1519 ftdi_process_read(port);
1521 } /* ftdi_read_bulk_callback */
1524 static void ftdi_process_read (void *param)
1525 { /* ftdi_process_read */
1526 struct usb_serial_port *port = (struct usb_serial_port*)param;
1528 struct tty_struct *tty;
1529 struct ftdi_private *priv;
1531 unsigned char *data;
1537 unsigned long flags;
1539 dbg("%s - port %d", __FUNCTION__, port->number);
1541 if (port->open_count <= 0)
1546 dbg("%s - bad tty pointer - exiting",__FUNCTION__);
1550 priv = usb_get_serial_port_data(port);
1552 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1556 urb = port->read_urb;
1558 dbg("%s - bad read_urb pointer - exiting", __FUNCTION__);
1562 data = urb->transfer_buffer;
1564 if (priv->rx_processed) {
1565 dbg("%s - already processed: %d bytes, %d remain", __FUNCTION__,
1567 urb->actual_length - priv->rx_processed);
1569 /* The first two bytes of every read packet are status */
1570 if (urb->actual_length > 2) {
1571 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
1573 dbg("Status only: %03oo %03oo",data[0],data[1]);
1578 /* TO DO -- check for hung up line and handle appropriately: */
1580 /* See acm.c - you do a tty_hangup - eg tty_hangup(tty) */
1581 /* if CD is dropped and the line is not CLOCAL then we should hangup */
1584 for (packet_offset = priv->rx_processed; packet_offset < urb->actual_length; packet_offset += PKTSZ) {
1587 /* Compare new line status to the old one, signal if different */
1588 /* N.B. packet may be processed more than once, but differences
1589 * are only processed once. */
1591 char new_status = data[packet_offset+0] & FTDI_STATUS_B0_MASK;
1592 if (new_status != priv->prev_status) {
1593 priv->diff_status |= new_status ^ priv->prev_status;
1594 wake_up_interruptible(&priv->delta_msr_wait);
1595 priv->prev_status = new_status;
1599 length = min(PKTSZ, urb->actual_length-packet_offset)-2;
1601 err("%s - bad packet length: %d", __FUNCTION__, length+2);
1605 /* have to make sure we don't overflow the buffer
1606 with tty_insert_flip_char's */
1607 if (tty->flip.count+length > TTY_FLIPBUF_SIZE) {
1608 tty_flip_buffer_push(tty);
1611 if (tty->flip.count != 0) {
1612 /* flip didn't work, this happens when ftdi_process_read() is
1613 * called from ftdi_unthrottle, because TTY_DONT_FLIP is set */
1614 dbg("%s - flip buffer push failed", __FUNCTION__);
1618 if (priv->rx_flags & THROTTLED) {
1619 dbg("%s - throttled", __FUNCTION__);
1622 if (tty->ldisc.receive_room(tty)-tty->flip.count < length) {
1623 /* break out & wait for throttling/unthrottling to happen */
1624 dbg("%s - receive room low", __FUNCTION__);
1628 /* Handle errors and break */
1629 error_flag = TTY_NORMAL;
1630 /* Although the device uses a bitmask and hence can have multiple */
1631 /* errors on a packet - the order here sets the priority the */
1632 /* error is returned to the tty layer */
1634 if ( data[packet_offset+1] & FTDI_RS_OE ) {
1635 error_flag = TTY_OVERRUN;
1636 dbg("OVERRRUN error");
1638 if ( data[packet_offset+1] & FTDI_RS_BI ) {
1639 error_flag = TTY_BREAK;
1640 dbg("BREAK received");
1642 if ( data[packet_offset+1] & FTDI_RS_PE ) {
1643 error_flag = TTY_PARITY;
1644 dbg("PARITY error");
1646 if ( data[packet_offset+1] & FTDI_RS_FE ) {
1647 error_flag = TTY_FRAME;
1648 dbg("FRAMING error");
1651 for (i = 2; i < length+2; i++) {
1652 /* Note that the error flag is duplicated for
1653 every character received since we don't know
1654 which character it applied to */
1655 tty_insert_flip_char(tty, data[packet_offset+i], error_flag);
1660 #ifdef NOT_CORRECT_BUT_KEEPING_IT_FOR_NOW
1661 /* if a parity error is detected you get status packets forever
1662 until a character is sent without a parity error.
1663 This doesn't work well since the application receives a never
1664 ending stream of bad data - even though new data hasn't been sent.
1665 Therefore I (bill) have taken this out.
1666 However - this might make sense for framing errors and so on
1667 so I am leaving the code in for now.
1670 if (error_flag != TTY_NORMAL){
1671 dbg("error_flag is not normal");
1672 /* In this case it is just status - if that is an error send a bad character */
1673 if(tty->flip.count >= TTY_FLIPBUF_SIZE) {
1674 tty_flip_buffer_push(tty);
1676 tty_insert_flip_char(tty, 0xff, error_flag);
1681 } /* "for(packet_offset=0..." */
1685 tty_flip_buffer_push(tty);
1688 if (packet_offset < urb->actual_length) {
1689 /* not completely processed - record progress */
1690 priv->rx_processed = packet_offset;
1691 dbg("%s - incomplete, %d bytes processed, %d remain",
1692 __FUNCTION__, packet_offset,
1693 urb->actual_length - packet_offset);
1694 /* check if we were throttled while processing */
1695 spin_lock_irqsave(&priv->rx_lock, flags);
1696 if (priv->rx_flags & THROTTLED) {
1697 priv->rx_flags |= ACTUALLY_THROTTLED;
1698 spin_unlock_irqrestore(&priv->rx_lock, flags);
1699 dbg("%s - deferring remainder until unthrottled",
1703 spin_unlock_irqrestore(&priv->rx_lock, flags);
1704 /* if the port is closed stop trying to read */
1705 if (port->open_count > 0){
1706 /* delay processing of remainder */
1707 schedule_delayed_work(&priv->rx_work, 1);
1709 dbg("%s - port is closed", __FUNCTION__);
1714 /* urb is completely processed */
1715 priv->rx_processed = 0;
1717 /* if the port is closed stop trying to read */
1718 if (port->open_count > 0){
1719 /* Continue trying to always read */
1720 usb_fill_bulk_urb(port->read_urb, port->serial->dev,
1721 usb_rcvbulkpipe(port->serial->dev, port->bulk_in_endpointAddress),
1722 port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
1723 ftdi_read_bulk_callback, port);
1725 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1727 err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
1731 } /* ftdi_process_read */
1734 static void ftdi_break_ctl( struct usb_serial_port *port, int break_state )
1736 struct ftdi_private *priv = usb_get_serial_port_data(port);
1737 __u16 urb_value = 0;
1740 /* break_state = -1 to turn on break, and 0 to turn off break */
1741 /* see drivers/char/tty_io.c to see it used */
1742 /* last_set_data_urb_value NEVER has the break bit set in it */
1745 urb_value = priv->last_set_data_urb_value | FTDI_SIO_SET_BREAK;
1747 urb_value = priv->last_set_data_urb_value;
1751 if (usb_control_msg(port->serial->dev, usb_sndctrlpipe(port->serial->dev, 0),
1752 FTDI_SIO_SET_DATA_REQUEST,
1753 FTDI_SIO_SET_DATA_REQUEST_TYPE,
1754 urb_value , priv->interface,
1755 buf, 0, WDR_TIMEOUT) < 0) {
1756 err("%s FAILED to enable/disable break state (state was %d)", __FUNCTION__,break_state);
1759 dbg("%s break state is %d - urb is %d", __FUNCTION__,break_state, urb_value);
1764 /* old_termios contains the original termios settings and tty->termios contains
1765 * the new setting to be used
1766 * WARNING: set_termios calls this with old_termios in kernel space
1769 static void ftdi_set_termios (struct usb_serial_port *port, struct termios *old_termios)
1770 { /* ftdi_termios */
1771 struct usb_device *dev = port->serial->dev;
1772 unsigned int cflag = port->tty->termios->c_cflag;
1773 struct ftdi_private *priv = usb_get_serial_port_data(port);
1774 __u16 urb_value; /* will hold the new flags */
1775 char buf[1]; /* Perhaps I should dynamically alloc this? */
1777 // Added for xon/xoff support
1778 unsigned int iflag = port->tty->termios->c_iflag;
1779 unsigned char vstop;
1780 unsigned char vstart;
1782 dbg("%s", __FUNCTION__);
1784 /* Force baud rate if this device requires it, unless it is set to B0. */
1785 if (priv->force_baud && ((port->tty->termios->c_cflag & CBAUD) != B0)) {
1786 dbg("%s: forcing baud rate for this device", __FUNCTION__);
1787 port->tty->termios->c_cflag &= ~CBAUD;
1788 port->tty->termios->c_cflag |= priv->force_baud;
1791 /* Force RTS-CTS if this device requires it. */
1792 if (priv->force_rtscts) {
1793 dbg("%s: forcing rtscts for this device", __FUNCTION__);
1794 port->tty->termios->c_cflag |= CRTSCTS;
1797 cflag = port->tty->termios->c_cflag;
1799 /* FIXME -For this cut I don't care if the line is really changing or
1800 not - so just do the change regardless - should be able to
1801 compare old_termios and tty->termios */
1802 /* NOTE These routines can get interrupted by
1803 ftdi_sio_read_bulk_callback - need to examine what this
1804 means - don't see any problems yet */
1806 /* Set number of data bits, parity, stop bits */
1809 urb_value |= (cflag & CSTOPB ? FTDI_SIO_SET_DATA_STOP_BITS_2 :
1810 FTDI_SIO_SET_DATA_STOP_BITS_1);
1811 urb_value |= (cflag & PARENB ?
1812 (cflag & PARODD ? FTDI_SIO_SET_DATA_PARITY_ODD :
1813 FTDI_SIO_SET_DATA_PARITY_EVEN) :
1814 FTDI_SIO_SET_DATA_PARITY_NONE);
1815 if (cflag & CSIZE) {
1816 switch (cflag & CSIZE) {
1817 case CS5: urb_value |= 5; dbg("Setting CS5"); break;
1818 case CS6: urb_value |= 6; dbg("Setting CS6"); break;
1819 case CS7: urb_value |= 7; dbg("Setting CS7"); break;
1820 case CS8: urb_value |= 8; dbg("Setting CS8"); break;
1822 err("CSIZE was set but not CS5-CS8");
1826 /* This is needed by the break command since it uses the same command - but is
1827 * or'ed with this value */
1828 priv->last_set_data_urb_value = urb_value;
1830 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1831 FTDI_SIO_SET_DATA_REQUEST,
1832 FTDI_SIO_SET_DATA_REQUEST_TYPE,
1833 urb_value , priv->interface,
1834 buf, 0, WDR_SHORT_TIMEOUT) < 0) {
1835 err("%s FAILED to set databits/stopbits/parity", __FUNCTION__);
1838 /* Now do the baudrate */
1839 if ((cflag & CBAUD) == B0 ) {
1840 /* Disable flow control */
1841 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1842 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1843 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1845 buf, 0, WDR_TIMEOUT) < 0) {
1846 err("%s error from disable flowcontrol urb", __FUNCTION__);
1848 /* Drop RTS and DTR */
1849 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1851 /* set the baudrate determined before */
1852 if (change_speed(port)) {
1853 err("%s urb failed to set baudrate", __FUNCTION__);
1855 /* Ensure RTS and DTR are raised when baudrate changed from 0 */
1856 if ((old_termios->c_cflag & CBAUD) == B0) {
1857 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1861 /* Set flow control */
1862 /* Note device also supports DTR/CD (ugh) and Xon/Xoff in hardware */
1863 if (cflag & CRTSCTS) {
1864 dbg("%s Setting to CRTSCTS flow control", __FUNCTION__);
1865 if (usb_control_msg(dev,
1866 usb_sndctrlpipe(dev, 0),
1867 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1868 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1869 0 , (FTDI_SIO_RTS_CTS_HS | priv->interface),
1870 buf, 0, WDR_TIMEOUT) < 0) {
1871 err("urb failed to set to rts/cts flow control");
1878 * Check the IXOFF status in the iflag component of the termios structure
1879 * if IXOFF is not set, the pre-xon/xoff code is executed.
1881 if (iflag & IXOFF) {
1882 dbg("%s request to enable xonxoff iflag=%04x",__FUNCTION__,iflag);
1883 // Try to enable the XON/XOFF on the ftdi_sio
1884 // Set the vstart and vstop -- could have been done up above where
1885 // a lot of other dereferencing is done but that would be very
1886 // inefficient as vstart and vstop are not always needed
1887 vstart=port->tty->termios->c_cc[VSTART];
1888 vstop=port->tty->termios->c_cc[VSTOP];
1889 urb_value=(vstop << 8) | (vstart);
1891 if (usb_control_msg(dev,
1892 usb_sndctrlpipe(dev, 0),
1893 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1894 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1895 urb_value , (FTDI_SIO_XON_XOFF_HS
1897 buf, 0, WDR_TIMEOUT) < 0) {
1898 err("urb failed to set to xon/xoff flow control");
1901 /* else clause to only run if cfag ! CRTSCTS and iflag ! XOFF */
1902 /* CHECKME Assuming XON/XOFF handled by tty stack - not by device */
1903 dbg("%s Turning off hardware flow control", __FUNCTION__);
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,
1909 buf, 0, WDR_TIMEOUT) < 0) {
1910 err("urb failed to clear flow control");
1916 } /* ftdi_termios */
1919 static int ftdi_tiocmget (struct usb_serial_port *port, struct file *file)
1921 struct ftdi_private *priv = usb_get_serial_port_data(port);
1922 unsigned char buf[2];
1925 dbg("%s TIOCMGET", __FUNCTION__);
1926 switch (priv->chip_type) {
1928 /* Request the status from the device */
1929 if ((ret = usb_control_msg(port->serial->dev,
1930 usb_rcvctrlpipe(port->serial->dev, 0),
1931 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
1932 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
1934 buf, 1, WDR_TIMEOUT)) < 0 ) {
1935 err("%s Could not get modem status of device - err: %d", __FUNCTION__,
1943 /* the 8U232AM returns a two byte value (the sio is a 1 byte value) - in the same
1944 format as the data returned from the in point */
1945 if ((ret = usb_control_msg(port->serial->dev,
1946 usb_rcvctrlpipe(port->serial->dev, 0),
1947 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
1948 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
1950 buf, 2, WDR_TIMEOUT)) < 0 ) {
1951 err("%s Could not get modem status of device - err: %d", __FUNCTION__,
1961 return (buf[0] & FTDI_SIO_DSR_MASK ? TIOCM_DSR : 0) |
1962 (buf[0] & FTDI_SIO_CTS_MASK ? TIOCM_CTS : 0) |
1963 (buf[0] & FTDI_SIO_RI_MASK ? TIOCM_RI : 0) |
1964 (buf[0] & FTDI_SIO_RLSD_MASK ? TIOCM_CD : 0) |
1968 static int ftdi_tiocmset(struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear)
1970 dbg("%s TIOCMSET", __FUNCTION__);
1971 return update_mctrl(port, set, clear);
1975 static int ftdi_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
1977 struct ftdi_private *priv = usb_get_serial_port_data(port);
1979 dbg("%s cmd 0x%04x", __FUNCTION__, cmd);
1981 /* Based on code from acm.c and others */
1984 case TIOCGSERIAL: /* gets serial port data */
1985 return get_serial_info(port, (struct serial_struct __user *) arg);
1987 case TIOCSSERIAL: /* sets serial port data */
1988 return set_serial_info(port, (struct serial_struct __user *) arg);
1991 * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1992 * - mask passed in arg for lines of interest
1993 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1994 * Caller should use TIOCGICOUNT to see which one it was.
1996 * This code is borrowed from linux/drivers/char/serial.c
1999 while (priv != NULL) {
2000 interruptible_sleep_on(&priv->delta_msr_wait);
2001 /* see if a signal did it */
2002 if (signal_pending(current))
2003 return -ERESTARTSYS;
2005 char diff = priv->diff_status;
2008 return -EIO; /* no change => error */
2011 /* Consume all events */
2012 priv->diff_status = 0;
2014 /* Return 0 if caller wanted to know about these bits */
2015 if ( ((arg & TIOCM_RNG) && (diff & FTDI_RS0_RI)) ||
2016 ((arg & TIOCM_DSR) && (diff & FTDI_RS0_DSR)) ||
2017 ((arg & TIOCM_CD) && (diff & FTDI_RS0_RLSD)) ||
2018 ((arg & TIOCM_CTS) && (diff & FTDI_RS0_CTS)) ) {
2022 * Otherwise caller can't care less about what happened,
2023 * and so we continue to wait for more events.
2035 /* This is not necessarily an error - turns out the higher layers will do
2036 * some ioctls itself (see comment above)
2038 dbg("%s arg not supported - it was 0x%04x - check /usr/include/asm/ioctls.h", __FUNCTION__, cmd);
2040 return(-ENOIOCTLCMD);
2044 static void ftdi_throttle (struct usb_serial_port *port)
2046 struct ftdi_private *priv = usb_get_serial_port_data(port);
2047 unsigned long flags;
2049 dbg("%s - port %d", __FUNCTION__, port->number);
2051 spin_lock_irqsave(&priv->rx_lock, flags);
2052 priv->rx_flags |= THROTTLED;
2053 spin_unlock_irqrestore(&priv->rx_lock, flags);
2057 static void ftdi_unthrottle (struct usb_serial_port *port)
2059 struct ftdi_private *priv = usb_get_serial_port_data(port);
2060 int actually_throttled;
2061 unsigned long flags;
2063 dbg("%s - port %d", __FUNCTION__, port->number);
2065 spin_lock_irqsave(&priv->rx_lock, flags);
2066 actually_throttled = priv->rx_flags & ACTUALLY_THROTTLED;
2067 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
2068 spin_unlock_irqrestore(&priv->rx_lock, flags);
2070 if (actually_throttled)
2071 schedule_work(&priv->rx_work);
2074 static int __init ftdi_init (void)
2078 dbg("%s", __FUNCTION__);
2079 if (vendor > 0 && product > 0) {
2080 /* Add user specified VID/PID to reserved element of table. */
2082 for (i = 0; id_table_combined[i].idVendor; i++)
2084 id_table_combined[i].match_flags = USB_DEVICE_ID_MATCH_DEVICE;
2085 id_table_combined[i].idVendor = vendor;
2086 id_table_combined[i].idProduct = product;
2088 retval = usb_serial_register(&ftdi_sio_device);
2090 goto failed_sio_register;
2091 retval = usb_register(&ftdi_driver);
2093 goto failed_usb_register;
2095 info(DRIVER_VERSION ":" DRIVER_DESC);
2097 failed_usb_register:
2098 usb_serial_deregister(&ftdi_sio_device);
2099 failed_sio_register:
2104 static void __exit ftdi_exit (void)
2107 dbg("%s", __FUNCTION__);
2109 usb_deregister (&ftdi_driver);
2110 usb_serial_deregister (&ftdi_sio_device);
2115 module_init(ftdi_init);
2116 module_exit(ftdi_exit);
2118 MODULE_AUTHOR( DRIVER_AUTHOR );
2119 MODULE_DESCRIPTION( DRIVER_DESC );
2120 MODULE_LICENSE("GPL");
2122 module_param(debug, bool, S_IRUGO | S_IWUSR);
2123 MODULE_PARM_DESC(debug, "Debug enabled or not");
2124 module_param(vendor, ushort, 0);
2125 MODULE_PARM_DESC(vendor, "User specified vendor ID (default="
2126 __MODULE_STRING(FTDI_VID)")");
2127 module_param(product, ushort, 0);
2128 MODULE_PARM_DESC(vendor, "User specified product ID");