blob: 4066a468118ab778b045dd2a3379ec27213920cc [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * USB FTDI SIO driver
3 *
David Brownell5c09d142006-10-13 15:57:58 -07004 * Copyright (C) 1999 - 2001
5 * Greg Kroah-Hartman (greg@kroah.com)
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 * Bill Ryder (bryder@sgi.com)
7 * Copyright (C) 2002
8 * Kuba Ober (kuba@mareimbrium.org)
9 *
David Brownell5c09d142006-10-13 15:57:58 -070010 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070014 *
15 * See Documentation/usb/usb-serial.txt for more information on using this driver
16 *
17 * See http://ftdi-usb-sio.sourceforge.net for upto date testing info
18 * and extra documentation
19 *
20 * (21/Jul/2004) Ian Abbott
21 * Incorporated Steven Turner's code to add support for the FT2232C chip.
22 * The prelimilary port to the 2.6 kernel was by Rus V. Brushkoff. I have
23 * fixed a couple of things.
24 *
25 * (27/May/2004) Ian Abbott
26 * Improved throttling code, mostly stolen from the WhiteHEAT driver.
27 *
28 * (26/Mar/2004) Jan Capek
29 * Added PID's for ICD-U20/ICD-U40 - incircuit PIC debuggers from CCS Inc.
30 *
31 * (09/Feb/2004) Ian Abbott
32 * Changed full name of USB-UIRT device to avoid "/" character.
33 * Added FTDI's alternate PID (0x6006) for FT232/245 devices.
34 * Added PID for "ELV USB Module UO100" from Stefan Frings.
David Brownell5c09d142006-10-13 15:57:58 -070035 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070036 * (21/Oct/2003) Ian Abbott
37 * Renamed some VID/PID macros for Matrix Orbital and Perle Systems
38 * devices. Removed Matrix Orbital and Perle Systems devices from the
39 * 8U232AM device table, but left them in the FT232BM table, as they are
40 * known to use only FT232BM.
41 *
42 * (17/Oct/2003) Scott Allen
43 * Added vid/pid for Perle Systems UltraPort USB serial converters
44 *
45 * (21/Sep/2003) Ian Abbott
46 * Added VID/PID for Omnidirectional Control Technology US101 USB to
47 * RS-232 adapter (also rebadged as Dick Smith Electronics XH6381).
48 * VID/PID supplied by Donald Gordon.
49 *
50 * (19/Aug/2003) Ian Abbott
51 * Freed urb's transfer buffer in write bulk callback.
52 * Omitted some paranoid checks in write bulk callback that don't matter.
53 * Scheduled work in write bulk callback regardless of port's open count.
54 *
55 * (05/Aug/2003) Ian Abbott
56 * Added VID/PID for ID TECH IDT1221U USB to RS-232 adapter.
57 * VID/PID provided by Steve Briggs.
58 *
59 * (23/Jul/2003) Ian Abbott
60 * Added PIDs for CrystalFontz 547, 633, 631, 635, 640 and 640 from
61 * Wayne Wylupski.
62 *
63 * (10/Jul/2003) David Glance
64 * Added PID for DSS-20 SyncStation cradle for Sony-Ericsson P800.
65 *
66 * (27/Jun/2003) Ian Abbott
67 * Reworked the urb handling logic. We have no more pool, but dynamically
68 * allocate the urb and the transfer buffer on the fly. In testing this
69 * does not incure any measurable overhead. This also relies on the fact
70 * that we have proper reference counting logic for urbs. I nicked this
71 * from Greg KH's Visor driver.
David Brownell5c09d142006-10-13 15:57:58 -070072 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 * (23/Jun/2003) Ian Abbott
74 * Reduced flip buffer pushes and corrected a data length test in
75 * ftdi_read_bulk_callback.
76 * Defererence pointers after any paranoid checks, not before.
77 *
78 * (21/Jun/2003) Erik Nygren
Steven Cole093cf722005-05-03 19:07:24 -060079 * Added support for Home Electronics Tira-1 IR transceiver using FT232BM chip.
David Brownell5c09d142006-10-13 15:57:58 -070080 * See <http://www.home-electro.com/tira1.htm>. Only operates properly
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 * at 100000 and RTS-CTS, so set custom divisor mode on startup.
82 * Also force the Tira-1 and USB-UIRT to only use their custom baud rates.
83 *
84 * (18/Jun/2003) Ian Abbott
85 * Added Device ID of the USB relais from Rudolf Gugler (backported from
86 * Philipp Gühring's patch for 2.5.x kernel).
87 * Moved read transfer buffer reallocation into startup function.
88 * Free existing write urb and transfer buffer in startup function.
89 * Only use urbs in write urb pool that were successfully allocated.
90 * Moved some constant macros out of functions.
91 * Minor whitespace and comment changes.
92 *
93 * (12/Jun/2003) David Norwood
Steven Cole093cf722005-05-03 19:07:24 -060094 * Added support for USB-UIRT IR transceiver using 8U232AM chip.
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 * See <http://home.earthlink.net/~jrhees/USBUIRT/index.htm>. Only
96 * operates properly at 312500, so set custom divisor mode on startup.
97 *
98 * (12/Jun/2003) Ian Abbott
99 * Added Sealevel SeaLINK+ 210x, 220x, 240x, 280x vid/pids from Tuan Hoang
100 * - I've eliminated some that don't seem to exist!
101 * Added Home Electronics Tira-1 IR transceiver pid from Chris Horn
102 * Some whitespace/coding-style cleanups
103 *
104 * (11/Jun/2003) Ian Abbott
105 * Fixed unsafe spinlock usage in ftdi_write
106 *
107 * (24/Feb/2003) Richard Shooter
108 * Increase read buffer size to improve read speeds at higher baud rates
109 * (specifically tested with up to 1Mb/sec at 1.5M baud)
110 *
111 * (23/Feb/2003) John Wilkins
112 * Added Xon/xoff flow control (activating support in the ftdi device)
113 * Added vid/pid for Videonetworks/Homechoice (UK ISP)
114 *
115 * (23/Feb/2003) Bill Ryder
116 * Added matrix orb device vid/pids from Wayne Wylupski
117 *
118 * (19/Feb/2003) Ian Abbott
119 * For TIOCSSERIAL, set alt_speed to 0 when ASYNC_SPD_MASK value has
120 * changed to something other than ASYNC_SPD_HI, ASYNC_SPD_VHI,
121 * ASYNC_SPD_SHI or ASYNC_SPD_WARP. Also, unless ASYNC_SPD_CUST is in
122 * force, don't bother changing baud rate when custom_divisor has changed.
123 *
124 * (18/Feb/2003) Ian Abbott
125 * Fixed TIOCMGET handling to include state of DTR and RTS, the state
126 * of which are now saved by set_dtr() and set_rts().
127 * Fixed improper storage class for buf in set_dtr() and set_rts().
128 * Added FT232BM chip type and support for its extra baud rates (compared
129 * to FT8U232AM).
130 * Took account of special case divisor values for highest baud rates of
131 * FT8U232AM and FT232BM.
132 * For TIOCSSERIAL, forced alt_speed to 0 when ASYNC_SPD_CUST kludge used,
133 * as previous alt_speed setting is now stale.
134 * Moved startup code common between the startup routines for the
135 * different chip types into a common subroutine.
136 *
137 * (17/Feb/2003) Bill Ryder
138 * Added write urb buffer pool on a per device basis
139 * Added more checking for open file on callbacks (fixed OOPS)
David Brownell5c09d142006-10-13 15:57:58 -0700140 * Added CrystalFontz 632 and 634 PIDs
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 * (thanx to CrystalFontz for the sample devices - they flushed out
142 * some driver bugs)
143 * Minor debugging message changes
144 * Added throttle, unthrottle and chars_in_buffer functions
145 * Fixed FTDI_SIO (the original device) bug
146 * Fixed some shutdown handling
David Brownell5c09d142006-10-13 15:57:58 -0700147 *
148 *
149 *
150 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 * (07/Jun/2002) Kuba Ober
152 * Changed FTDI_SIO_BASE_BAUD_TO_DIVISOR macro into ftdi_baud_to_divisor
153 * function. It was getting too complex.
154 * Fix the divisor calculation logic which was setting divisor of 0.125
155 * instead of 0.5 for fractional parts of divisor equal to 5/8, 6/8, 7/8.
156 * Also make it bump up the divisor to next integer in case of 7/8 - it's
157 * a better approximation.
158 *
159 * (25/Jul/2002) Bill Ryder inserted Dmitri's TIOCMIWAIT patch
160 * Not tested by me but it doesn't break anything I use.
David Brownell5c09d142006-10-13 15:57:58 -0700161 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 * (04/Jan/2002) Kuba Ober
163 * Implemented 38400 baudrate kludge, where it can be substituted with other
164 * values. That's the only way to set custom baudrates.
165 * Implemented TIOCSSERIAL, TIOCGSERIAL ioctl's so that setserial is happy.
166 * FIXME: both baudrate things should eventually go to usbserial.c as other
167 * devices may need that functionality too. Actually, it can probably be
168 * merged in serial.c somehow - too many drivers repeat this code over
169 * and over.
170 * Fixed baudrate forgetfulness - open() used to reset baudrate to 9600 every time.
171 * Divisors for baudrates are calculated by a macro.
172 * Small code cleanups. Ugly whitespace changes for Plato's sake only ;-].
173 *
174 * (04/Nov/2001) Bill Ryder
175 * Fixed bug in read_bulk_callback where incorrect urb buffer was used.
176 * Cleaned up write offset calculation
177 * Added write_room since default values can be incorrect for sio
178 * Changed write_bulk_callback to use same queue_task as other drivers
179 * (the previous version caused panics)
180 * Removed port iteration code since the device only has one I/O port and it
181 * was wrong anyway.
David Brownell5c09d142006-10-13 15:57:58 -0700182 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 * (31/May/2001) gkh
184 * Switched from using spinlock to a semaphore, which fixes lots of problems.
185 *
186 * (23/May/2001) Bill Ryder
187 * Added runtime debug patch (thanx Tyson D Sawyer).
188 * Cleaned up comments for 8U232
189 * Added parity, framing and overrun error handling
190 * Added receive break handling.
David Brownell5c09d142006-10-13 15:57:58 -0700191 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 * (04/08/2001) gb
193 * Identify version on module load.
David Brownell5c09d142006-10-13 15:57:58 -0700194 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 * (18/March/2001) Bill Ryder
196 * (Not released)
197 * Added send break handling. (requires kernel patch too)
198 * Fixed 8U232AM hardware RTS/CTS etc status reporting.
199 * Added flipbuf fix copied from generic device
David Brownell5c09d142006-10-13 15:57:58 -0700200 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 * (12/3/2000) Bill Ryder
202 * Added support for 8U232AM device.
203 * Moved PID and VIDs into header file only.
204 * Turned on low-latency for the tty (device will do high baudrates)
205 * Added shutdown routine to close files when device removed.
206 * More debug and error message cleanups.
207 *
208 * (11/13/2000) Bill Ryder
209 * Added spinlock protected open code and close code.
210 * Multiple opens work (sort of - see webpage mentioned above).
211 * Cleaned up comments. Removed multiple PID/VID definitions.
212 * Factorised cts/dtr code
213 * Made use of __FUNCTION__ in dbg's
David Brownell5c09d142006-10-13 15:57:58 -0700214 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 * (11/01/2000) Adam J. Richter
216 * usb_device_id table support
David Brownell5c09d142006-10-13 15:57:58 -0700217 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 * (10/05/2000) gkh
219 * Fixed bug with urb->dev not being set properly, now that the usb
220 * core needs it.
David Brownell5c09d142006-10-13 15:57:58 -0700221 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 * (09/11/2000) gkh
223 * Removed DEBUG #ifdefs with call to usb_serial_debug_data
224 *
225 * (07/19/2000) gkh
226 * Added module_init and module_exit functions to handle the fact that this
227 * driver is a loadable module now.
228 *
David Brownell5c09d142006-10-13 15:57:58 -0700229 * (04/04/2000) Bill Ryder
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 * Fixed bugs in TCGET/TCSET ioctls (by removing them - they are
231 * handled elsewhere in the tty io driver chain).
232 *
David Brownell5c09d142006-10-13 15:57:58 -0700233 * (03/30/2000) Bill Ryder
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 * Implemented lots of ioctls
235 * Fixed a race condition in write
236 * Changed some dbg's to errs
237 *
238 * (03/26/2000) gkh
239 * Split driver up into device specific pieces.
240 *
241 */
242
243/* Bill Ryder - bryder@sgi.com - wrote the FTDI_SIO implementation */
244/* Thanx to FTDI for so kindly providing details of the protocol required */
245/* to talk to the device */
246/* Thanx to gkh and the rest of the usb dev group for all code I have assimilated :-) */
247
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248#include <linux/kernel.h>
249#include <linux/errno.h>
250#include <linux/init.h>
251#include <linux/slab.h>
252#include <linux/tty.h>
253#include <linux/tty_driver.h>
254#include <linux/tty_flip.h>
255#include <linux/module.h>
256#include <linux/spinlock.h>
257#include <asm/uaccess.h>
258#include <linux/usb.h>
259#include <linux/serial.h>
Greg Kroah-Hartmana9698882006-07-11 21:22:58 -0700260#include <linux/usb/serial.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261#include "ftdi_sio.h"
262
263/*
264 * Version Information
265 */
Ian Abbott8f977e42005-06-20 16:45:42 +0100266#define DRIVER_VERSION "v1.4.3"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267#define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>, Bill Ryder <bryder@sgi.com>, Kuba Ober <kuba@mareimbrium.org>"
268#define DRIVER_DESC "USB FTDI Serial Converters Driver"
269
270static int debug;
Ian Abbottfdcb0a02005-07-28 18:40:32 +0100271static __u16 vendor = FTDI_VID;
272static __u16 product;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273
Ian Abbott8f977e42005-06-20 16:45:42 +0100274/* struct ftdi_sio_quirk is used by devices requiring special attention. */
275struct ftdi_sio_quirk {
Tony Lindgrenfa91d432007-05-04 18:23:24 -0700276 int (*probe)(struct usb_serial *);
Ian Abbott8f977e42005-06-20 16:45:42 +0100277 void (*setup)(struct usb_serial *); /* Special settings during startup. */
278};
279
Tony Lindgrenfa91d432007-05-04 18:23:24 -0700280static int ftdi_olimex_probe (struct usb_serial *serial);
Ian Abbott8f977e42005-06-20 16:45:42 +0100281static void ftdi_USB_UIRT_setup (struct usb_serial *serial);
282static void ftdi_HE_TIRA1_setup (struct usb_serial *serial);
283
Tony Lindgrenfa91d432007-05-04 18:23:24 -0700284static struct ftdi_sio_quirk ftdi_olimex_quirk = {
285 .probe = ftdi_olimex_probe,
286};
287
Ian Abbott8f977e42005-06-20 16:45:42 +0100288static struct ftdi_sio_quirk ftdi_USB_UIRT_quirk = {
289 .setup = ftdi_USB_UIRT_setup,
290};
291
292static struct ftdi_sio_quirk ftdi_HE_TIRA1_quirk = {
293 .setup = ftdi_HE_TIRA1_setup,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294};
295
296/*
297 * The 8U232AM has the same API as the sio except for:
298 * - it can support MUCH higher baudrates; up to:
299 * o 921600 for RS232 and 2000000 for RS422/485 at 48MHz
300 * o 230400 at 12MHz
301 * so .. 8U232AM's baudrate setting codes are different
302 * - it has a two byte status code.
303 * - it returns characters every 16ms (the FTDI does it every 40ms)
304 *
305 * the bcdDevice value is used to differentiate FT232BM and FT245BM from
306 * the earlier FT8U232AM and FT8U232BM. For now, include all known VID/PID
307 * combinations in both tables.
Ian Abbott8f977e42005-06-20 16:45:42 +0100308 * FIXME: perhaps bcdDevice can also identify 12MHz FT8U232AM devices,
309 * but I don't know if those ever went into mass production. [Ian Abbott]
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 */
311
312
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
314static struct usb_device_id id_table_combined [] = {
Jonathan Davies2011e922006-08-09 10:48:03 +0100315 { USB_DEVICE(FTDI_VID, FTDI_AMC232_PID) },
316 { USB_DEVICE(FTDI_VID, FTDI_CANUSB_PID) },
Razvan Gavril72a9f952006-05-04 11:35:49 +0300317 { USB_DEVICE(FTDI_VID, FTDI_ACTZWAVE_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318 { USB_DEVICE(FTDI_VID, FTDI_IRTRANS_PID) },
Luiz Fernando N. Capitulino69737df2006-04-11 15:52:41 -0300319 { USB_DEVICE(FTDI_VID, FTDI_IPLUS_PID) },
Luiz Fernando N. Capitulinod0993212007-06-21 22:34:23 -0300320 { USB_DEVICE(FTDI_VID, FTDI_IPLUS2_PID) },
Frank Sievertsenfad14a02006-10-20 09:43:53 +0200321 { USB_DEVICE(FTDI_VID, FTDI_DMX4ALL) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 { USB_DEVICE(FTDI_VID, FTDI_SIO_PID) },
323 { USB_DEVICE(FTDI_VID, FTDI_8U232AM_PID) },
324 { USB_DEVICE(FTDI_VID, FTDI_8U232AM_ALT_PID) },
Gard Spreemannd8b21602007-03-05 00:03:26 +0100325 { USB_DEVICE(FTDI_VID, FTDI_232RL_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 { USB_DEVICE(FTDI_VID, FTDI_8U2232C_PID) },
Christophe Mariacc0f8d562006-06-23 17:36:21 +0200327 { USB_DEVICE(FTDI_VID, FTDI_MICRO_CHAMELEON_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 { USB_DEVICE(FTDI_VID, FTDI_RELAIS_PID) },
Guido Scholz2adb80e2007-05-08 19:52:41 +0200329 { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_IOBOARD_PID) },
331 { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_MINI_IOBOARD_PID) },
332 { USB_DEVICE(FTDI_VID, FTDI_XF_632_PID) },
333 { USB_DEVICE(FTDI_VID, FTDI_XF_634_PID) },
334 { USB_DEVICE(FTDI_VID, FTDI_XF_547_PID) },
335 { USB_DEVICE(FTDI_VID, FTDI_XF_633_PID) },
336 { USB_DEVICE(FTDI_VID, FTDI_XF_631_PID) },
337 { USB_DEVICE(FTDI_VID, FTDI_XF_635_PID) },
338 { USB_DEVICE(FTDI_VID, FTDI_XF_640_PID) },
339 { USB_DEVICE(FTDI_VID, FTDI_XF_642_PID) },
340 { USB_DEVICE(FTDI_VID, FTDI_DSS20_PID) },
341 { USB_DEVICE(FTDI_NF_RIC_VID, FTDI_NF_RIC_PID) },
342 { USB_DEVICE(FTDI_VID, FTDI_VNHCPCUSB_D_PID) },
Ian Abbott8f977e42005-06-20 16:45:42 +0100343 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_0_PID) },
344 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_1_PID) },
345 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_2_PID) },
346 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_3_PID) },
347 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_4_PID) },
348 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_5_PID) },
349 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_6_PID) },
350 { USB_DEVICE(FTDI_VID, FTDI_PERLE_ULTRAPORT_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 { USB_DEVICE(FTDI_VID, FTDI_PIEGROUP_PID) },
Dave Platt274a4bb2006-07-18 21:26:54 -0700352 { USB_DEVICE(FTDI_VID, FTDI_TNC_X_PID) },
Jelle Foks868e4402007-03-25 21:08:35 -0400353 { USB_DEVICE(FTDI_VID, FTDI_USBX_707_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2101_PID) },
355 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2102_PID) },
356 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2103_PID) },
357 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2104_PID) },
Justin Carlsona1484822006-09-24 11:52:12 +0300358 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2106_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_1_PID) },
360 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_2_PID) },
361 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_1_PID) },
362 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_2_PID) },
363 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_1_PID) },
364 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_2_PID) },
365 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_1_PID) },
366 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_2_PID) },
367 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_3_PID) },
368 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_4_PID) },
369 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_1_PID) },
370 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_2_PID) },
371 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_3_PID) },
372 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_4_PID) },
373 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_1_PID) },
374 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_2_PID) },
375 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_3_PID) },
376 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_4_PID) },
377 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_1_PID) },
378 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_2_PID) },
379 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_3_PID) },
380 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_4_PID) },
381 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_5_PID) },
382 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_6_PID) },
383 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_7_PID) },
384 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_8_PID) },
385 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_1_PID) },
386 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_2_PID) },
387 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_3_PID) },
388 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_4_PID) },
389 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_5_PID) },
390 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_6_PID) },
391 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_7_PID) },
392 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_8_PID) },
393 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_1_PID) },
394 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_2_PID) },
395 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_3_PID) },
396 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_4_PID) },
397 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_5_PID) },
398 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_6_PID) },
399 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_7_PID) },
400 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_8_PID) },
401 { USB_DEVICE(IDTECH_VID, IDTECH_IDT1221U_PID) },
402 { USB_DEVICE(OCT_VID, OCT_US101_PID) },
Ian Abbott8f977e42005-06-20 16:45:42 +0100403 { USB_DEVICE(FTDI_VID, FTDI_HE_TIRA1_PID),
404 .driver_info = (kernel_ulong_t)&ftdi_HE_TIRA1_quirk },
405 { USB_DEVICE(FTDI_VID, FTDI_USB_UIRT_PID),
406 .driver_info = (kernel_ulong_t)&ftdi_USB_UIRT_quirk },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_1) },
408 { USB_DEVICE(FTDI_VID, PROTEGO_R2X0) },
409 { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_3) },
410 { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_4) },
Ian Abbott8f977e42005-06-20 16:45:42 +0100411 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E808_PID) },
412 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E809_PID) },
413 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80A_PID) },
414 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80B_PID) },
415 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80C_PID) },
416 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80D_PID) },
417 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80E_PID) },
418 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80F_PID) },
419 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E888_PID) },
420 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E889_PID) },
421 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88A_PID) },
422 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88B_PID) },
423 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88C_PID) },
424 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88D_PID) },
425 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88E_PID) },
426 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88F_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 { USB_DEVICE(FTDI_VID, FTDI_ELV_UO100_PID) },
Ian Abbott47900742005-05-17 15:12:13 +0100428 { USB_DEVICE(FTDI_VID, FTDI_ELV_UM100_PID) },
Ian Abbotte6ac4a42005-08-02 14:01:27 +0100429 { USB_DEVICE(FTDI_VID, FTDI_ELV_UR100_PID) },
430 { USB_DEVICE(FTDI_VID, FTDI_ELV_ALC8500_PID) },
Thomas Riewe207c47e2005-09-29 14:57:29 +0200431 { USB_DEVICE(FTDI_VID, FTDI_PYRAMID_PID) },
Martin Hagelinbde62182005-10-26 21:10:41 +0200432 { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1000PC_PID) },
Thomas Schleusener4eaf60e2007-02-28 22:50:52 +0100433 { USB_DEVICE(FTDI_VID, FTDI_IBS_US485_PID) },
434 { USB_DEVICE(FTDI_VID, FTDI_IBS_PICPRO_PID) },
435 { USB_DEVICE(FTDI_VID, FTDI_IBS_PCMCIA_PID) },
436 { USB_DEVICE(FTDI_VID, FTDI_IBS_PK1_PID) },
437 { USB_DEVICE(FTDI_VID, FTDI_IBS_RS232MON_PID) },
438 { USB_DEVICE(FTDI_VID, FTDI_IBS_APP70_PID) },
439 { USB_DEVICE(FTDI_VID, FTDI_IBS_PEDO_PID) },
440 { USB_DEVICE(FTDI_VID, FTDI_IBS_PROD_PID) },
Ian Abbotte6ac4a42005-08-02 14:01:27 +0100441 /*
442 * These will probably use user-space drivers. Uncomment them if
443 * you need them or use the user-specified vendor/product module
444 * parameters (see ftdi_sio.h for the numbers). Make a fuss if
445 * you think the driver should recognize any of them by default.
446 */
447 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_CLI7000_PID) }, */
448 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_PPS7330_PID) }, */
449 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_TFM100_PID) }, */
450 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UDF77_PID) }, */
451 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UIO88_PID) }, */
452 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UAD8_PID) }, */
453 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UDA7_PID) }, */
454 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_USI2_PID) }, */
455 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_T1100_PID) }, */
456 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_PCD200_PID) }, */
457 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_ULA200_PID) }, */
Ian Abbotte6ac4a42005-08-02 14:01:27 +0100458 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_CSI8_PID) }, */
459 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_EM1000DL_PID) }, */
460 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_PCK100_PID) }, */
461 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_RFP500_PID) }, */
462 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_FS20SIG_PID) }, */
463 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_WS300PC_PID) }, */
464 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1300PC_PID) }, */
465 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_WS500_PID) }, */
David Brownell5c09d142006-10-13 15:57:58 -0700466 { USB_DEVICE(FTDI_VID, LINX_SDMUSBQSS_PID) },
467 { USB_DEVICE(FTDI_VID, LINX_MASTERDEVEL2_PID) },
468 { USB_DEVICE(FTDI_VID, LINX_FUTURE_0_PID) },
469 { USB_DEVICE(FTDI_VID, LINX_FUTURE_1_PID) },
470 { USB_DEVICE(FTDI_VID, LINX_FUTURE_2_PID) },
471 { USB_DEVICE(FTDI_VID, FTDI_CCSICDU20_0_PID) },
472 { USB_DEVICE(FTDI_VID, FTDI_CCSICDU40_1_PID) },
Jan Capekec434e92006-11-28 22:35:12 +0100473 { USB_DEVICE(FTDI_VID, FTDI_CCSMACHX_2_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 { USB_DEVICE(FTDI_VID, INSIDE_ACCESSO) },
475 { USB_DEVICE(INTREPID_VID, INTREPID_VALUECAN_PID) },
476 { USB_DEVICE(INTREPID_VID, INTREPID_NEOVI_PID) },
477 { USB_DEVICE(FALCOM_VID, FALCOM_TWIST_PID) },
Ian Abbotte6ac4a42005-08-02 14:01:27 +0100478 { USB_DEVICE(FALCOM_VID, FALCOM_SAMBA_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 { USB_DEVICE(FTDI_VID, FTDI_SUUNTO_SPORTS_PID) },
Michael Olbergef31fec2007-02-27 12:57:12 +0100480 { USB_DEVICE(TTI_VID, TTI_QL355P_PID) },
Ian Abbott6f928722005-04-29 16:06:14 +0100481 { USB_DEVICE(FTDI_VID, FTDI_RM_CANVIEW_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 { USB_DEVICE(BANDB_VID, BANDB_USOTL4_PID) },
483 { USB_DEVICE(BANDB_VID, BANDB_USTL4_PID) },
484 { USB_DEVICE(BANDB_VID, BANDB_USO9ML2_PID) },
485 { USB_DEVICE(FTDI_VID, EVER_ECO_PRO_CDS) },
Ian Abbott6f928722005-04-29 16:06:14 +0100486 { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_1_PID) },
487 { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_2_PID) },
Ian Abbotte6ac4a42005-08-02 14:01:27 +0100488 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_0_PID) },
489 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_1_PID) },
490 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_2_PID) },
491 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_3_PID) },
492 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_4_PID) },
493 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_5_PID) },
494 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_6_PID) },
495 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_7_PID) },
Ian Abbott6f928722005-04-29 16:06:14 +0100496 { USB_DEVICE(MOBILITY_VID, MOBILITY_USB_SERIAL_PID) },
Ian Abbott8f977e42005-06-20 16:45:42 +0100497 { USB_DEVICE(FTDI_VID, FTDI_ACTIVE_ROBOTS_PID) },
Ian Abbott34d1a8a2006-02-27 14:05:32 +0000498 { USB_DEVICE(FTDI_VID, FTDI_MHAM_KW_PID) },
499 { USB_DEVICE(FTDI_VID, FTDI_MHAM_YS_PID) },
Ian Abbott9b1513d2005-07-29 12:16:31 -0700500 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y6_PID) },
501 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y8_PID) },
Ian Abbott34d1a8a2006-02-27 14:05:32 +0000502 { USB_DEVICE(FTDI_VID, FTDI_MHAM_IC_PID) },
503 { USB_DEVICE(FTDI_VID, FTDI_MHAM_DB9_PID) },
504 { USB_DEVICE(FTDI_VID, FTDI_MHAM_RS232_PID) },
505 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y9_PID) },
Ian Abbott740a42822005-12-13 16:18:47 +0000506 { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_VCP_PID) },
507 { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_D2XX_PID) },
Ian Abbott9b1513d2005-07-29 12:16:31 -0700508 { USB_DEVICE(EVOLUTION_VID, EVOLUTION_ER1_PID) },
Rui Santosc9c77462005-09-23 20:06:50 +0100509 { USB_DEVICE(FTDI_VID, FTDI_ARTEMIS_PID) },
510 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16_PID) },
Rui Santos09c280a2006-01-09 13:12:40 +0000511 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16C_PID) },
Rui Santosc9c77462005-09-23 20:06:50 +0100512 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HR_PID) },
Rui Santos09c280a2006-01-09 13:12:40 +0000513 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HRC_PID) },
Ian Abbottb4723ae2005-11-23 15:45:23 -0800514 { USB_DEVICE(KOBIL_VID, KOBIL_CONV_B1_PID) },
515 { USB_DEVICE(KOBIL_VID, KOBIL_CONV_KAAN_PID) },
Pavel Fedineffac8b2005-12-09 09:30:59 +0300516 { USB_DEVICE(POSIFLEX_VID, POSIFLEX_PP7000_PID) },
Louis Nyffenegger641adaa2006-01-05 17:20:37 +0100517 { USB_DEVICE(FTDI_VID, FTDI_TTUSB_PID) },
Ian Abbott7e1c0b82006-03-21 14:55:20 +0000518 { USB_DEVICE(FTDI_VID, FTDI_ECLO_COM_1WIRE_PID) },
Ian Abbotta94b52a2006-01-09 17:11:40 +0000519 { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_777_PID) },
520 { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_8900F_PID) },
Wouter Paesence40d292006-01-03 14:30:31 +0100521 { USB_DEVICE(FTDI_VID, FTDI_PCDJ_DAC2_PID) },
Nathan Bronsoncdd3b152006-04-10 00:05:09 -0400522 { USB_DEVICE(FTDI_VID, FTDI_RRCIRKITS_LOCOBUFFER_PID) },
Ian Abbott7e0258f2006-04-12 15:20:35 +0100523 { USB_DEVICE(FTDI_VID, FTDI_ASK_RDR400_PID) },
A. Maitland Bottomsbf58fbd2006-03-14 18:44:23 -0500524 { USB_DEVICE(ICOM_ID1_VID, ICOM_ID1_PID) },
Folkert van Heusden62a13db2006-03-28 20:41:26 +0900525 { USB_DEVICE(PAPOUCH_VID, PAPOUCH_TMU_PID) },
Ian Abbott20a0f472006-05-04 11:34:25 +0100526 { USB_DEVICE(FTDI_VID, FTDI_ACG_HFDUAL_PID) },
Ian Abbotteb79b4f2006-05-30 12:36:30 +0100527 { USB_DEVICE(FTDI_VID, FTDI_YEI_SERVOCENTER31_PID) },
D. Peter Siddons48437482006-06-17 18:09:15 -0400528 { USB_DEVICE(FTDI_VID, FTDI_THORLABS_PID) },
Colin Leroye1979fe2006-07-11 11:36:43 +0200529 { USB_DEVICE(TESTO_VID, TESTO_USB_INTERFACE_PID) },
Ralf Schlatterbeckeaede2c2006-09-06 12:15:02 +0200530 { USB_DEVICE(FTDI_VID, FTDI_GAMMA_SCOUT_PID) },
Ian Abbott9978f9e2006-09-25 14:19:19 +0100531 { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13M_PID) },
532 { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13S_PID) },
533 { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13U_PID) },
Kjell Myksvoll40c36092006-10-22 23:26:42 +0200534 { USB_DEVICE(ELEKTOR_VID, ELEKTOR_FT323R_PID) },
Micke Prag822c7ef2007-02-04 23:39:11 +0100535 { USB_DEVICE(TELLDUS_VID, TELLDUS_TELLSTICK_PID) },
Neil \"Superna\" ARMSTRONG762e92f2007-04-25 20:34:28 +0200536 { USB_DEVICE(FTDI_VID, FTDI_MAXSTREAM_PID) },
Tony Lindgrenfa91d432007-05-04 18:23:24 -0700537 { USB_DEVICE(OLIMEX_VID, OLIMEX_ARM_USB_OCD_PID),
538 .driver_info = (kernel_ulong_t)&ftdi_olimex_quirk },
Ian Abbottfdcb0a02005-07-28 18:40:32 +0100539 { }, /* Optional parameter entry */
540 { } /* Terminating entry */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541};
542
543MODULE_DEVICE_TABLE (usb, id_table_combined);
544
545static struct usb_driver ftdi_driver = {
546 .name = "ftdi_sio",
547 .probe = usb_serial_probe,
548 .disconnect = usb_serial_disconnect,
549 .id_table = id_table_combined,
David Brownell5c09d142006-10-13 15:57:58 -0700550 .no_dynamic_id = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551};
552
Arjan van de Ven4c4c9432005-11-29 09:43:42 +0100553static const char *ftdi_chip_name[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 [SIO] = "SIO", /* the serial part of FT8U100AX */
555 [FT8U232AM] = "FT8U232AM",
556 [FT232BM] = "FT232BM",
557 [FT2232C] = "FT2232C",
Gard Spreemannd8b21602007-03-05 00:03:26 +0100558 [FT232RL] = "FT232RL",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559};
560
561
562/* Constants for read urb and write urb */
563#define BUFSZ 512
564#define PKTSZ 64
565
566/* rx_flags */
567#define THROTTLED 0x01
568#define ACTUALLY_THROTTLED 0x02
569
570struct ftdi_private {
571 ftdi_chip_type_t chip_type;
572 /* type of the device, either SIO or FT8U232AM */
573 int baud_base; /* baud base clock for divisor setting */
574 int custom_divisor; /* custom_divisor kludge, this is for baud_base (different from what goes to the chip!) */
575 __u16 last_set_data_urb_value ;
576 /* the last data state set - needed for doing a break */
David Brownell5c09d142006-10-13 15:57:58 -0700577 int write_offset; /* This is the offset in the usb data block to write the serial data -
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 * it is different between devices
579 */
580 int flags; /* some ASYNC_xxxx flags are supported */
581 unsigned long last_dtr_rts; /* saved modem control outputs */
582 wait_queue_head_t delta_msr_wait; /* Used for TIOCMIWAIT */
David Brownell5c09d142006-10-13 15:57:58 -0700583 char prev_status, diff_status; /* Used for TIOCMIWAIT */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 __u8 rx_flags; /* receive state flags (throttling) */
585 spinlock_t rx_lock; /* spinlock for receive state */
David Howellsc4028952006-11-22 14:57:56 +0000586 struct delayed_work rx_work;
587 struct usb_serial_port *port;
Ian Abbott76854ce2005-06-02 10:34:11 +0100588 int rx_processed;
Ian Abbott22465402006-06-26 12:59:17 +0100589 unsigned long rx_bytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590
591 __u16 interface; /* FT2232C port interface (0 for FT232/245) */
592
593 int force_baud; /* if non-zero, force the baud rate to this value */
594 int force_rtscts; /* if non-zero, force RTS-CTS to always be enabled */
Ian Abbott22465402006-06-26 12:59:17 +0100595
596 spinlock_t tx_lock; /* spinlock for transmit state */
597 unsigned long tx_bytes;
598 unsigned long tx_outstanding_bytes;
599 unsigned long tx_outstanding_urbs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600};
601
602/* Used for TIOCMIWAIT */
603#define FTDI_STATUS_B0_MASK (FTDI_RS0_CTS | FTDI_RS0_DSR | FTDI_RS0_RI | FTDI_RS0_RLSD)
604#define FTDI_STATUS_B1_MASK (FTDI_RS_BI)
605/* End TIOCMIWAIT */
606
607#define FTDI_IMPL_ASYNC_FLAGS = ( ASYNC_SPD_HI | ASYNC_SPD_VHI \
608 ASYNC_SPD_CUST | ASYNC_SPD_SHI | ASYNC_SPD_WARP )
609
610/* function prototypes for a FTDI serial converter */
Ian Abbott8f977e42005-06-20 16:45:42 +0100611static int ftdi_sio_probe (struct usb_serial *serial, const struct usb_device_id *id);
612static int ftdi_sio_attach (struct usb_serial *serial);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613static void ftdi_shutdown (struct usb_serial *serial);
Jim Radford12bdbe02007-02-28 10:10:50 -0800614static int ftdi_sio_port_probe (struct usb_serial_port *port);
615static int ftdi_sio_port_remove (struct usb_serial_port *port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616static int ftdi_open (struct usb_serial_port *port, struct file *filp);
617static void ftdi_close (struct usb_serial_port *port, struct file *filp);
618static int ftdi_write (struct usb_serial_port *port, const unsigned char *buf, int count);
619static int ftdi_write_room (struct usb_serial_port *port);
620static int ftdi_chars_in_buffer (struct usb_serial_port *port);
David Howells7d12e782006-10-05 14:55:46 +0100621static void ftdi_write_bulk_callback (struct urb *urb);
622static void ftdi_read_bulk_callback (struct urb *urb);
David Howellsc4028952006-11-22 14:57:56 +0000623static void ftdi_process_read (struct work_struct *work);
Alan Cox606d0992006-12-08 02:38:45 -0800624static void ftdi_set_termios (struct usb_serial_port *port, struct ktermios * old);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625static int ftdi_tiocmget (struct usb_serial_port *port, struct file *file);
626static int ftdi_tiocmset (struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear);
627static int ftdi_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg);
628static void ftdi_break_ctl (struct usb_serial_port *port, int break_state );
629static void ftdi_throttle (struct usb_serial_port *port);
630static void ftdi_unthrottle (struct usb_serial_port *port);
631
632static unsigned short int ftdi_232am_baud_base_to_divisor (int baud, int base);
633static unsigned short int ftdi_232am_baud_to_divisor (int baud);
634static __u32 ftdi_232bm_baud_base_to_divisor (int baud, int base);
635static __u32 ftdi_232bm_baud_to_divisor (int baud);
636
Greg Kroah-Hartmanea653702005-06-20 21:15:16 -0700637static struct usb_serial_driver ftdi_sio_device = {
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700638 .driver = {
639 .owner = THIS_MODULE,
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700640 .name = "ftdi_sio",
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700641 },
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700642 .description = "FTDI USB Serial Device",
Johannes Hölzld9b1b782006-12-17 21:50:24 +0100643 .usb_driver = &ftdi_driver ,
Ian Abbott8f977e42005-06-20 16:45:42 +0100644 .id_table = id_table_combined,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 .num_interrupt_in = 0,
646 .num_bulk_in = 1,
647 .num_bulk_out = 1,
648 .num_ports = 1,
Ian Abbott8f977e42005-06-20 16:45:42 +0100649 .probe = ftdi_sio_probe,
Jim Radford12bdbe02007-02-28 10:10:50 -0800650 .port_probe = ftdi_sio_port_probe,
651 .port_remove = ftdi_sio_port_remove,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 .open = ftdi_open,
653 .close = ftdi_close,
654 .throttle = ftdi_throttle,
655 .unthrottle = ftdi_unthrottle,
656 .write = ftdi_write,
657 .write_room = ftdi_write_room,
658 .chars_in_buffer = ftdi_chars_in_buffer,
659 .read_bulk_callback = ftdi_read_bulk_callback,
660 .write_bulk_callback = ftdi_write_bulk_callback,
661 .tiocmget = ftdi_tiocmget,
662 .tiocmset = ftdi_tiocmset,
663 .ioctl = ftdi_ioctl,
664 .set_termios = ftdi_set_termios,
665 .break_ctl = ftdi_break_ctl,
Ian Abbott8f977e42005-06-20 16:45:42 +0100666 .attach = ftdi_sio_attach,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 .shutdown = ftdi_shutdown,
668};
669
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670
671#define WDR_TIMEOUT 5000 /* default urb timeout */
Ian Abbott279e1542005-07-29 12:16:52 -0700672#define WDR_SHORT_TIMEOUT 1000 /* shorter urb timeout */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673
674/* High and low are for DTR, RTS etc etc */
675#define HIGH 1
676#define LOW 0
677
Ian Abbott22465402006-06-26 12:59:17 +0100678/* number of outstanding urbs to prevent userspace DoS from happening */
679#define URB_UPPER_LIMIT 42
680
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681/*
682 * ***************************************************************************
Tony Lindgrenfa91d432007-05-04 18:23:24 -0700683 * Utility functions
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 * ***************************************************************************
685 */
686
687static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base)
688{
689 unsigned short int divisor;
690 int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
691 if ((divisor3 & 0x7) == 7) divisor3 ++; // round x.7/8 up to x+1
692 divisor = divisor3 >> 3;
693 divisor3 &= 0x7;
694 if (divisor3 == 1) divisor |= 0xc000; else // 0.125
695 if (divisor3 >= 4) divisor |= 0x4000; else // 0.5
696 if (divisor3 != 0) divisor |= 0x8000; // 0.25
697 if (divisor == 1) divisor = 0; /* special case for maximum baud rate */
698 return divisor;
699}
700
701static unsigned short int ftdi_232am_baud_to_divisor(int baud)
702{
703 return(ftdi_232am_baud_base_to_divisor(baud, 48000000));
704}
705
706static __u32 ftdi_232bm_baud_base_to_divisor(int baud, int base)
707{
708 static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
709 __u32 divisor;
710 int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
711 divisor = divisor3 >> 3;
712 divisor |= (__u32)divfrac[divisor3 & 0x7] << 14;
713 /* Deal with special cases for highest baud rates. */
714 if (divisor == 1) divisor = 0; else // 1.0
715 if (divisor == 0x4001) divisor = 1; // 1.5
716 return divisor;
717}
718
719static __u32 ftdi_232bm_baud_to_divisor(int baud)
720{
721 return(ftdi_232bm_baud_base_to_divisor(baud, 48000000));
722}
723
Ian Abbott74ede0f2005-07-29 12:16:41 -0700724#define set_mctrl(port, set) update_mctrl((port), (set), 0)
725#define clear_mctrl(port, clear) update_mctrl((port), 0, (clear))
726
727static int update_mctrl(struct usb_serial_port *port, unsigned int set, unsigned int clear)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728{
729 struct ftdi_private *priv = usb_get_serial_port_data(port);
730 char *buf;
Ian Abbott74ede0f2005-07-29 12:16:41 -0700731 unsigned urb_value;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 int rv;
Ian Abbott74ede0f2005-07-29 12:16:41 -0700733
734 if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
735 dbg("%s - DTR|RTS not being set|cleared", __FUNCTION__);
736 return 0; /* no change */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 }
Ian Abbott74ede0f2005-07-29 12:16:41 -0700738
739 buf = kmalloc(1, GFP_NOIO);
740 if (!buf) {
741 return -ENOMEM;
742 }
743
744 clear &= ~set; /* 'set' takes precedence over 'clear' */
745 urb_value = 0;
746 if (clear & TIOCM_DTR)
747 urb_value |= FTDI_SIO_SET_DTR_LOW;
748 if (clear & TIOCM_RTS)
749 urb_value |= FTDI_SIO_SET_RTS_LOW;
750 if (set & TIOCM_DTR)
751 urb_value |= FTDI_SIO_SET_DTR_HIGH;
752 if (set & TIOCM_RTS)
753 urb_value |= FTDI_SIO_SET_RTS_HIGH;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754 rv = usb_control_msg(port->serial->dev,
755 usb_sndctrlpipe(port->serial->dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -0700756 FTDI_SIO_SET_MODEM_CTRL_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE,
Ian Abbott74ede0f2005-07-29 12:16:41 -0700758 urb_value, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 buf, 0, WDR_TIMEOUT);
760
761 kfree(buf);
Ian Abbott74ede0f2005-07-29 12:16:41 -0700762 if (rv < 0) {
763 err("%s Error from MODEM_CTRL urb: DTR %s, RTS %s",
764 __FUNCTION__,
765 (set & TIOCM_DTR) ? "HIGH" :
766 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
767 (set & TIOCM_RTS) ? "HIGH" :
768 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 } else {
Ian Abbott74ede0f2005-07-29 12:16:41 -0700770 dbg("%s - DTR %s, RTS %s", __FUNCTION__,
771 (set & TIOCM_DTR) ? "HIGH" :
772 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
773 (set & TIOCM_RTS) ? "HIGH" :
774 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
775 priv->last_dtr_rts = (priv->last_dtr_rts & ~clear) | set;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 return rv;
778}
779
780
781static __u32 get_ftdi_divisor(struct usb_serial_port * port);
782
783
784static int change_speed(struct usb_serial_port *port)
785{
786 struct ftdi_private *priv = usb_get_serial_port_data(port);
787 char *buf;
788 __u16 urb_value;
789 __u16 urb_index;
790 __u32 urb_index_value;
791 int rv;
792
793 buf = kmalloc(1, GFP_NOIO);
794 if (!buf)
795 return -ENOMEM;
796
797 urb_index_value = get_ftdi_divisor(port);
798 urb_value = (__u16)urb_index_value;
799 urb_index = (__u16)(urb_index_value >> 16);
800 if (priv->interface) { /* FT2232C */
801 urb_index = (__u16)((urb_index << 8) | priv->interface);
802 }
David Brownell5c09d142006-10-13 15:57:58 -0700803
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 rv = usb_control_msg(port->serial->dev,
805 usb_sndctrlpipe(port->serial->dev, 0),
806 FTDI_SIO_SET_BAUDRATE_REQUEST,
807 FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE,
808 urb_value, urb_index,
Ian Abbott279e1542005-07-29 12:16:52 -0700809 buf, 0, WDR_SHORT_TIMEOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810
811 kfree(buf);
812 return rv;
813}
814
815
816static __u32 get_ftdi_divisor(struct usb_serial_port * port)
817{ /* get_ftdi_divisor */
818 struct ftdi_private *priv = usb_get_serial_port_data(port);
819 __u32 div_value = 0;
820 int div_okay = 1;
821 int baud;
822
823 /*
824 * The logic involved in setting the baudrate can be cleanly split in 3 steps.
825 * Obtaining the actual baud rate is a little tricky since unix traditionally
826 * somehow ignored the possibility to set non-standard baud rates.
827 * 1. Standard baud rates are set in tty->termios->c_cflag
828 * 2. If these are not enough, you can set any speed using alt_speed as follows:
829 * - set tty->termios->c_cflag speed to B38400
830 * - set your real speed in tty->alt_speed; it gets ignored when
831 * alt_speed==0, (or)
832 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
833 * flags & ASYNC_SPD_MASK == ASYNC_SPD_[HI, VHI, SHI, WARP], this just
834 * sets alt_speed to (HI: 57600, VHI: 115200, SHI: 230400, WARP: 460800)
835 * ** Steps 1, 2 are done courtesy of tty_get_baud_rate
836 * 3. You can also set baud rate by setting custom divisor as follows
837 * - set tty->termios->c_cflag speed to B38400
838 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
839 * o flags & ASYNC_SPD_MASK == ASYNC_SPD_CUST
840 * o custom_divisor set to baud_base / your_new_baudrate
841 * ** Step 3 is done courtesy of code borrowed from serial.c - I should really
842 * spend some time and separate+move this common code to serial.c, it is
843 * replicated in nearly every serial driver you see.
844 */
845
846 /* 1. Get the baud rate from the tty settings, this observes alt_speed hack */
847
848 baud = tty_get_baud_rate(port->tty);
849 dbg("%s - tty_get_baud_rate reports speed %d", __FUNCTION__, baud);
850
851 /* 2. Observe async-compatible custom_divisor hack, update baudrate if needed */
852
853 if (baud == 38400 &&
854 ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
855 (priv->custom_divisor)) {
856 baud = priv->baud_base / priv->custom_divisor;
857 dbg("%s - custom divisor %d sets baud rate to %d", __FUNCTION__, priv->custom_divisor, baud);
858 }
859
860 /* 3. Convert baudrate to device-specific divisor */
861
David Brownell5c09d142006-10-13 15:57:58 -0700862 if (!baud) baud = 9600;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 switch(priv->chip_type) {
864 case SIO: /* SIO chip */
865 switch(baud) {
866 case 300: div_value = ftdi_sio_b300; break;
867 case 600: div_value = ftdi_sio_b600; break;
868 case 1200: div_value = ftdi_sio_b1200; break;
869 case 2400: div_value = ftdi_sio_b2400; break;
870 case 4800: div_value = ftdi_sio_b4800; break;
871 case 9600: div_value = ftdi_sio_b9600; break;
872 case 19200: div_value = ftdi_sio_b19200; break;
873 case 38400: div_value = ftdi_sio_b38400; break;
874 case 57600: div_value = ftdi_sio_b57600; break;
875 case 115200: div_value = ftdi_sio_b115200; break;
876 } /* baud */
877 if (div_value == 0) {
David Brownell5c09d142006-10-13 15:57:58 -0700878 dbg("%s - Baudrate (%d) requested is not supported", __FUNCTION__, baud);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879 div_value = ftdi_sio_b9600;
880 div_okay = 0;
881 }
882 break;
883 case FT8U232AM: /* 8U232AM chip */
884 if (baud <= 3000000) {
885 div_value = ftdi_232am_baud_to_divisor(baud);
886 } else {
887 dbg("%s - Baud rate too high!", __FUNCTION__);
888 div_value = ftdi_232am_baud_to_divisor(9600);
889 div_okay = 0;
890 }
891 break;
892 case FT232BM: /* FT232BM chip */
893 case FT2232C: /* FT2232C chip */
David Brownell3b009c62007-03-23 12:54:27 -0700894 case FT232RL:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 if (baud <= 3000000) {
896 div_value = ftdi_232bm_baud_to_divisor(baud);
897 } else {
898 dbg("%s - Baud rate too high!", __FUNCTION__);
899 div_value = ftdi_232bm_baud_to_divisor(9600);
900 div_okay = 0;
901 }
902 break;
903 } /* priv->chip_type */
904
905 if (div_okay) {
906 dbg("%s - Baud rate set to %d (divisor 0x%lX) on chip %s",
907 __FUNCTION__, baud, (unsigned long)div_value,
908 ftdi_chip_name[priv->chip_type]);
909 }
910
911 return(div_value);
912}
913
914
915static int get_serial_info(struct usb_serial_port * port, struct serial_struct __user * retinfo)
916{
917 struct ftdi_private *priv = usb_get_serial_port_data(port);
918 struct serial_struct tmp;
919
920 if (!retinfo)
921 return -EFAULT;
922 memset(&tmp, 0, sizeof(tmp));
923 tmp.flags = priv->flags;
924 tmp.baud_base = priv->baud_base;
925 tmp.custom_divisor = priv->custom_divisor;
926 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
927 return -EFAULT;
928 return 0;
929} /* get_serial_info */
930
931
932static int set_serial_info(struct usb_serial_port * port, struct serial_struct __user * newinfo)
933{ /* set_serial_info */
934 struct ftdi_private *priv = usb_get_serial_port_data(port);
935 struct serial_struct new_serial;
936 struct ftdi_private old_priv;
937
938 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
939 return -EFAULT;
940 old_priv = * priv;
941
942 /* Do error checking and permission checking */
943
944 if (!capable(CAP_SYS_ADMIN)) {
945 if (((new_serial.flags & ~ASYNC_USR_MASK) !=
946 (priv->flags & ~ASYNC_USR_MASK)))
947 return -EPERM;
948 priv->flags = ((priv->flags & ~ASYNC_USR_MASK) |
949 (new_serial.flags & ASYNC_USR_MASK));
950 priv->custom_divisor = new_serial.custom_divisor;
951 goto check_and_exit;
952 }
953
954 if ((new_serial.baud_base != priv->baud_base) &&
955 (new_serial.baud_base < 9600))
956 return -EINVAL;
957
958 /* Make the changes - these are privileged changes! */
959
960 priv->flags = ((priv->flags & ~ASYNC_FLAGS) |
David Brownell5c09d142006-10-13 15:57:58 -0700961 (new_serial.flags & ASYNC_FLAGS));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 priv->custom_divisor = new_serial.custom_divisor;
963
964 port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
965
966check_and_exit:
967 if ((old_priv.flags & ASYNC_SPD_MASK) !=
968 (priv->flags & ASYNC_SPD_MASK)) {
969 if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_HI)
970 port->tty->alt_speed = 57600;
971 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_VHI)
972 port->tty->alt_speed = 115200;
973 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_SHI)
974 port->tty->alt_speed = 230400;
975 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_WARP)
976 port->tty->alt_speed = 460800;
977 else
978 port->tty->alt_speed = 0;
979 }
980 if (((old_priv.flags & ASYNC_SPD_MASK) !=
981 (priv->flags & ASYNC_SPD_MASK)) ||
982 (((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
983 (old_priv.custom_divisor != priv->custom_divisor))) {
984 change_speed(port);
985 }
David Brownell5c09d142006-10-13 15:57:58 -0700986
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987 return (0);
988
989} /* set_serial_info */
990
991
Ian Abbott8f977e42005-06-20 16:45:42 +0100992/* Determine type of FTDI chip based on USB config and descriptor. */
993static void ftdi_determine_type(struct usb_serial_port *port)
994{
995 struct ftdi_private *priv = usb_get_serial_port_data(port);
996 struct usb_serial *serial = port->serial;
997 struct usb_device *udev = serial->dev;
998 unsigned version;
999 unsigned interfaces;
1000
1001 /* Assume it is not the original SIO device for now. */
Ian Abbottf5e09b72005-09-12 12:23:25 +01001002 priv->baud_base = 48000000 / 2;
Ian Abbott8f977e42005-06-20 16:45:42 +01001003 priv->write_offset = 0;
1004
1005 version = le16_to_cpu(udev->descriptor.bcdDevice);
1006 interfaces = udev->actconfig->desc.bNumInterfaces;
1007 dbg("%s: bcdDevice = 0x%x, bNumInterfaces = %u", __FUNCTION__,
1008 version, interfaces);
1009 if (interfaces > 1) {
1010 int inter;
1011
1012 /* Multiple interfaces. Assume FT2232C. */
1013 priv->chip_type = FT2232C;
1014 /* Determine interface code. */
1015 inter = serial->interface->altsetting->desc.bInterfaceNumber;
1016 if (inter == 0) {
1017 priv->interface = PIT_SIOA;
1018 } else {
1019 priv->interface = PIT_SIOB;
1020 }
1021 /* BM-type devices have a bug where bcdDevice gets set
1022 * to 0x200 when iSerialNumber is 0. */
1023 if (version < 0x500) {
1024 dbg("%s: something fishy - bcdDevice too low for multi-interface device",
1025 __FUNCTION__);
1026 }
1027 } else if (version < 0x200) {
1028 /* Old device. Assume its the original SIO. */
1029 priv->chip_type = SIO;
1030 priv->baud_base = 12000000 / 16;
1031 priv->write_offset = 1;
1032 } else if (version < 0x400) {
1033 /* Assume its an FT8U232AM (or FT8U245AM) */
1034 /* (It might be a BM because of the iSerialNumber bug,
1035 * but it will still work as an AM device.) */
1036 priv->chip_type = FT8U232AM;
David Brownell3b009c62007-03-23 12:54:27 -07001037 } else if (version < 0x600) {
Ian Abbott8f977e42005-06-20 16:45:42 +01001038 /* Assume its an FT232BM (or FT245BM) */
1039 priv->chip_type = FT232BM;
David Brownell3b009c62007-03-23 12:54:27 -07001040 } else {
1041 /* Assume its an FT232R */
1042 priv->chip_type = FT232RL;
Ian Abbott8f977e42005-06-20 16:45:42 +01001043 }
1044 info("Detected %s", ftdi_chip_name[priv->chip_type]);
1045}
1046
1047
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048/*
1049 * ***************************************************************************
1050 * Sysfs Attribute
1051 * ***************************************************************************
1052 */
1053
Yani Ioannou060b8842005-05-17 06:44:04 -04001054static ssize_t show_latency_timer(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055{
1056 struct usb_serial_port *port = to_usb_serial_port(dev);
1057 struct ftdi_private *priv = usb_get_serial_port_data(port);
Jim Radford12bdbe02007-02-28 10:10:50 -08001058 struct usb_device *udev = port->serial->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059 unsigned short latency = 0;
1060 int rv = 0;
David Brownell5c09d142006-10-13 15:57:58 -07001061
David Brownell5c09d142006-10-13 15:57:58 -07001062
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063 dbg("%s",__FUNCTION__);
David Brownell5c09d142006-10-13 15:57:58 -07001064
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065 rv = usb_control_msg(udev,
1066 usb_rcvctrlpipe(udev, 0),
1067 FTDI_SIO_GET_LATENCY_TIMER_REQUEST,
1068 FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07001069 0, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070 (char*) &latency, 1, WDR_TIMEOUT);
David Brownell5c09d142006-10-13 15:57:58 -07001071
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 if (rv < 0) {
1073 dev_err(dev, "Unable to read latency timer: %i", rv);
1074 return -EIO;
1075 }
1076 return sprintf(buf, "%i\n", latency);
1077}
1078
1079/* Write a new value of the latency timer, in units of milliseconds. */
Yani Ioannou060b8842005-05-17 06:44:04 -04001080static ssize_t store_latency_timer(struct device *dev, struct device_attribute *attr, const char *valbuf,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081 size_t count)
1082{
1083 struct usb_serial_port *port = to_usb_serial_port(dev);
1084 struct ftdi_private *priv = usb_get_serial_port_data(port);
Jim Radford12bdbe02007-02-28 10:10:50 -08001085 struct usb_device *udev = port->serial->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086 char buf[1];
1087 int v = simple_strtoul(valbuf, NULL, 10);
1088 int rv = 0;
David Brownell5c09d142006-10-13 15:57:58 -07001089
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090 dbg("%s: setting latency timer = %i", __FUNCTION__, v);
David Brownell5c09d142006-10-13 15:57:58 -07001091
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092 rv = usb_control_msg(udev,
1093 usb_sndctrlpipe(udev, 0),
1094 FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
1095 FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07001096 v, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 buf, 0, WDR_TIMEOUT);
David Brownell5c09d142006-10-13 15:57:58 -07001098
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099 if (rv < 0) {
1100 dev_err(dev, "Unable to write latency timer: %i", rv);
1101 return -EIO;
1102 }
David Brownell5c09d142006-10-13 15:57:58 -07001103
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104 return count;
1105}
1106
1107/* Write an event character directly to the FTDI register. The ASCII
1108 value is in the low 8 bits, with the enable bit in the 9th bit. */
Yani Ioannou060b8842005-05-17 06:44:04 -04001109static ssize_t store_event_char(struct device *dev, struct device_attribute *attr, const char *valbuf,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110 size_t count)
1111{
1112 struct usb_serial_port *port = to_usb_serial_port(dev);
1113 struct ftdi_private *priv = usb_get_serial_port_data(port);
Jim Radford12bdbe02007-02-28 10:10:50 -08001114 struct usb_device *udev = port->serial->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115 char buf[1];
1116 int v = simple_strtoul(valbuf, NULL, 10);
1117 int rv = 0;
David Brownell5c09d142006-10-13 15:57:58 -07001118
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119 dbg("%s: setting event char = %i", __FUNCTION__, v);
David Brownell5c09d142006-10-13 15:57:58 -07001120
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121 rv = usb_control_msg(udev,
1122 usb_sndctrlpipe(udev, 0),
1123 FTDI_SIO_SET_EVENT_CHAR_REQUEST,
1124 FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07001125 v, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126 buf, 0, WDR_TIMEOUT);
David Brownell5c09d142006-10-13 15:57:58 -07001127
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128 if (rv < 0) {
1129 dbg("Unable to write event character: %i", rv);
1130 return -EIO;
1131 }
David Brownell5c09d142006-10-13 15:57:58 -07001132
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133 return count;
1134}
1135
1136static DEVICE_ATTR(latency_timer, S_IWUSR | S_IRUGO, show_latency_timer, store_latency_timer);
1137static DEVICE_ATTR(event_char, S_IWUSR, NULL, store_event_char);
1138
Jim Radford12bdbe02007-02-28 10:10:50 -08001139static int create_sysfs_attrs(struct usb_serial_port *port)
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001140{
Jim Radford12bdbe02007-02-28 10:10:50 -08001141 struct ftdi_private *priv = usb_get_serial_port_data(port);
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001142 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143
1144 dbg("%s",__FUNCTION__);
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001145
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146 /* XXX I've no idea if the original SIO supports the event_char
1147 * sysfs parameter, so I'm playing it safe. */
1148 if (priv->chip_type != SIO) {
1149 dbg("sysfs attributes for %s", ftdi_chip_name[priv->chip_type]);
Jim Radford12bdbe02007-02-28 10:10:50 -08001150 retval = device_create_file(&port->dev, &dev_attr_event_char);
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001151 if ((!retval) &&
Stepan Moskovchenko97cd49e2007-05-09 14:53:04 -04001152 (priv->chip_type == FT232BM ||
1153 priv->chip_type == FT2232C ||
1154 priv->chip_type == FT232RL)) {
Jim Radford12bdbe02007-02-28 10:10:50 -08001155 retval = device_create_file(&port->dev,
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001156 &dev_attr_latency_timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157 }
1158 }
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001159 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160}
1161
Jim Radford12bdbe02007-02-28 10:10:50 -08001162static void remove_sysfs_attrs(struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163{
Jim Radford12bdbe02007-02-28 10:10:50 -08001164 struct ftdi_private *priv = usb_get_serial_port_data(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165
David Brownell5c09d142006-10-13 15:57:58 -07001166 dbg("%s",__FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168 /* XXX see create_sysfs_attrs */
1169 if (priv->chip_type != SIO) {
Jim Radford12bdbe02007-02-28 10:10:50 -08001170 device_remove_file(&port->dev, &dev_attr_event_char);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171 if (priv->chip_type == FT232BM || priv->chip_type == FT2232C) {
Jim Radford12bdbe02007-02-28 10:10:50 -08001172 device_remove_file(&port->dev, &dev_attr_latency_timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 }
1174 }
David Brownell5c09d142006-10-13 15:57:58 -07001175
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176}
1177
1178/*
1179 * ***************************************************************************
1180 * FTDI driver specific functions
1181 * ***************************************************************************
1182 */
1183
Ian Abbott8f977e42005-06-20 16:45:42 +01001184/* Probe function to check for special devices */
1185static int ftdi_sio_probe (struct usb_serial *serial, const struct usb_device_id *id)
1186{
Tony Lindgrenfa91d432007-05-04 18:23:24 -07001187 struct ftdi_sio_quirk *quirk = (struct ftdi_sio_quirk *)id->driver_info;
1188
1189 if (quirk && quirk->probe) {
1190 int ret = quirk->probe(serial);
1191 if (ret != 0)
1192 return ret;
1193 }
1194
Ian Abbott8f977e42005-06-20 16:45:42 +01001195 usb_set_serial_data(serial, (void *)id->driver_info);
1196
Tony Lindgrenfa91d432007-05-04 18:23:24 -07001197 return 0;
Ian Abbott8f977e42005-06-20 16:45:42 +01001198}
1199
Jim Radford12bdbe02007-02-28 10:10:50 -08001200static int ftdi_sio_port_probe(struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202 struct ftdi_private *priv;
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001203
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204 dbg("%s",__FUNCTION__);
1205
Eric Sesterhenn80b6ca42006-02-27 21:29:43 +01001206 priv = kzalloc(sizeof(struct ftdi_private), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207 if (!priv){
1208 err("%s- kmalloc(%Zd) failed.", __FUNCTION__, sizeof(struct ftdi_private));
1209 return -ENOMEM;
1210 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211
1212 spin_lock_init(&priv->rx_lock);
Ian Abbott22465402006-06-26 12:59:17 +01001213 spin_lock_init(&priv->tx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214 init_waitqueue_head(&priv->delta_msr_wait);
1215 /* This will push the characters through immediately rather
1216 than queue a task to deliver them */
1217 priv->flags = ASYNC_LOW_LATENCY;
1218
1219 /* Increase the size of read buffers */
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07001220 kfree(port->bulk_in_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221 port->bulk_in_buffer = kmalloc (BUFSZ, GFP_KERNEL);
1222 if (!port->bulk_in_buffer) {
1223 kfree (priv);
1224 return -ENOMEM;
1225 }
1226 if (port->read_urb) {
1227 port->read_urb->transfer_buffer = port->bulk_in_buffer;
1228 port->read_urb->transfer_buffer_length = BUFSZ;
1229 }
1230
David Howellsc4028952006-11-22 14:57:56 +00001231 INIT_DELAYED_WORK(&priv->rx_work, ftdi_process_read);
1232 priv->port = port;
Ian Abbott76854ce2005-06-02 10:34:11 +01001233
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234 /* Free port's existing write urb and transfer buffer. */
1235 if (port->write_urb) {
1236 usb_free_urb (port->write_urb);
1237 port->write_urb = NULL;
1238 }
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07001239 kfree(port->bulk_out_buffer);
1240 port->bulk_out_buffer = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241
Jim Radford12bdbe02007-02-28 10:10:50 -08001242 usb_set_serial_port_data(port, priv);
Ian Abbott8f977e42005-06-20 16:45:42 +01001243
Jim Radford12bdbe02007-02-28 10:10:50 -08001244 ftdi_determine_type (port);
1245 create_sysfs_attrs(port);
1246 return 0;
1247}
Ian Abbott8f977e42005-06-20 16:45:42 +01001248
Jim Radford12bdbe02007-02-28 10:10:50 -08001249/* attach subroutine */
1250static int ftdi_sio_attach (struct usb_serial *serial)
1251{
Ian Abbott8f977e42005-06-20 16:45:42 +01001252 /* Check for device requiring special set up. */
Jim Radford12bdbe02007-02-28 10:10:50 -08001253 struct ftdi_sio_quirk *quirk = usb_get_serial_data(serial);
1254
1255 if (quirk && quirk->setup)
Ian Abbott8f977e42005-06-20 16:45:42 +01001256 quirk->setup(serial);
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001257
1258 return 0;
Ian Abbott8f977e42005-06-20 16:45:42 +01001259} /* ftdi_sio_attach */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260
1261
Ian Abbott8f977e42005-06-20 16:45:42 +01001262/* Setup for the USB-UIRT device, which requires hardwired
1263 * baudrate (38400 gets mapped to 312500) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264/* Called from usbserial:serial_probe */
Ian Abbott8f977e42005-06-20 16:45:42 +01001265static void ftdi_USB_UIRT_setup (struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266{
1267 struct ftdi_private *priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268
1269 dbg("%s",__FUNCTION__);
1270
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271 priv = usb_get_serial_port_data(serial->port[0]);
1272 priv->flags |= ASYNC_SPD_CUST;
1273 priv->custom_divisor = 77;
1274 priv->force_baud = B38400;
Ian Abbott8f977e42005-06-20 16:45:42 +01001275} /* ftdi_USB_UIRT_setup */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276
Ian Abbott8f977e42005-06-20 16:45:42 +01001277/* Setup for the HE-TIRA1 device, which requires hardwired
1278 * baudrate (38400 gets mapped to 100000) and RTS-CTS enabled. */
1279static void ftdi_HE_TIRA1_setup (struct usb_serial *serial)
1280{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281 struct ftdi_private *priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282
1283 dbg("%s",__FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284
1285 priv = usb_get_serial_port_data(serial->port[0]);
1286 priv->flags |= ASYNC_SPD_CUST;
1287 priv->custom_divisor = 240;
1288 priv->force_baud = B38400;
1289 priv->force_rtscts = 1;
Ian Abbott8f977e42005-06-20 16:45:42 +01001290} /* ftdi_HE_TIRA1_setup */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291
Tony Lindgrenfa91d432007-05-04 18:23:24 -07001292/*
1293 * First port on Olimex arm-usb-ocd is reserved for JTAG interface
1294 * and can be accessed from userspace using openocd.
1295 */
1296static int ftdi_olimex_probe(struct usb_serial *serial)
1297{
1298 struct usb_device *udev = serial->dev;
1299 struct usb_interface *interface = serial->interface;
1300
1301 dbg("%s",__FUNCTION__);
1302
1303 if (interface == udev->actconfig->interface[0]) {
1304 info("Ignoring reserved serial port on Olimex arm-usb-ocd\n");
1305 return -ENODEV;
1306 }
1307
1308 return 0;
1309}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310
David Brownell5c09d142006-10-13 15:57:58 -07001311/* ftdi_shutdown is called from usbserial:usb_serial_disconnect
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312 * it is called when the usb device is disconnected
1313 *
1314 * usbserial:usb_serial_disconnect
1315 * calls __serial_close for each open of the port
1316 * shutdown is called then (ie ftdi_shutdown)
1317 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318static void ftdi_shutdown (struct usb_serial *serial)
Jim Radford12bdbe02007-02-28 10:10:50 -08001319{
1320 dbg("%s", __FUNCTION__);
1321}
David Brownell5c09d142006-10-13 15:57:58 -07001322
Jim Radford12bdbe02007-02-28 10:10:50 -08001323static int ftdi_sio_port_remove(struct usb_serial_port *port)
1324{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 struct ftdi_private *priv = usb_get_serial_port_data(port);
1326
1327 dbg("%s", __FUNCTION__);
1328
Jim Radford12bdbe02007-02-28 10:10:50 -08001329 remove_sysfs_attrs(port);
David Brownell5c09d142006-10-13 15:57:58 -07001330
1331 /* all open ports are closed at this point
1332 * (by usbserial.c:__serial_close, which calls ftdi_close)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 */
1334
1335 if (priv) {
1336 usb_set_serial_port_data(port, NULL);
1337 kfree(priv);
1338 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339
Jim Radford12bdbe02007-02-28 10:10:50 -08001340 return 0;
1341}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342
1343static int ftdi_open (struct usb_serial_port *port, struct file *filp)
1344{ /* ftdi_open */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345 struct usb_device *dev = port->serial->dev;
1346 struct ftdi_private *priv = usb_get_serial_port_data(port);
1347 unsigned long flags;
David Brownell5c09d142006-10-13 15:57:58 -07001348
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349 int result = 0;
1350 char buf[1]; /* Needed for the usb_control_msg I think */
1351
1352 dbg("%s", __FUNCTION__);
1353
Ian Abbott22465402006-06-26 12:59:17 +01001354 spin_lock_irqsave(&priv->tx_lock, flags);
1355 priv->tx_bytes = 0;
1356 spin_unlock_irqrestore(&priv->tx_lock, flags);
1357 spin_lock_irqsave(&priv->rx_lock, flags);
1358 priv->rx_bytes = 0;
1359 spin_unlock_irqrestore(&priv->rx_lock, flags);
1360
Guennadi Liakhovetski57845bd2006-04-13 22:27:12 +02001361 if (port->tty)
1362 port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363
1364 /* No error checking for this (will get errors later anyway) */
1365 /* See ftdi_sio.h for description of what is reset */
1366 usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07001367 FTDI_SIO_RESET_REQUEST, FTDI_SIO_RESET_REQUEST_TYPE,
1368 FTDI_SIO_RESET_SIO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 priv->interface, buf, 0, WDR_TIMEOUT);
1370
1371 /* Termios defaults are set by usb_serial_init. We don't change
1372 port->tty->termios - this would loose speed settings, etc.
1373 This is same behaviour as serial.c/rs_open() - Kuba */
1374
1375 /* ftdi_set_termios will send usb control messages */
Guennadi Liakhovetski57845bd2006-04-13 22:27:12 +02001376 if (port->tty)
1377 ftdi_set_termios(port, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378
1379 /* FIXME: Flow control might be enabled, so it should be checked -
1380 we have no control of defaults! */
1381 /* Turn on RTS and DTR since we are not flow controlling by default */
Ian Abbott74ede0f2005-07-29 12:16:41 -07001382 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383
1384 /* Not throttled */
1385 spin_lock_irqsave(&priv->rx_lock, flags);
1386 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
1387 spin_unlock_irqrestore(&priv->rx_lock, flags);
1388
1389 /* Start reading from the device */
Ian Abbott76854ce2005-06-02 10:34:11 +01001390 priv->rx_processed = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391 usb_fill_bulk_urb(port->read_urb, dev,
1392 usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress),
1393 port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
1394 ftdi_read_bulk_callback, port);
1395 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
1396 if (result)
1397 err("%s - failed submitting read urb, error %d", __FUNCTION__, result);
1398
1399
1400 return result;
1401} /* ftdi_open */
1402
1403
1404
David Brownell5c09d142006-10-13 15:57:58 -07001405/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406 * usbserial:__serial_close only calls ftdi_close if the point is open
1407 *
1408 * This only gets called when it is the last close
David Brownell5c09d142006-10-13 15:57:58 -07001409 *
1410 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411 */
1412
1413static void ftdi_close (struct usb_serial_port *port, struct file *filp)
1414{ /* ftdi_close */
1415 unsigned int c_cflag = port->tty->termios->c_cflag;
1416 struct ftdi_private *priv = usb_get_serial_port_data(port);
1417 char buf[1];
1418
1419 dbg("%s", __FUNCTION__);
1420
1421 if (c_cflag & HUPCL){
1422 /* Disable flow control */
David Brownell5c09d142006-10-13 15:57:58 -07001423 if (usb_control_msg(port->serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424 usb_sndctrlpipe(port->serial->dev, 0),
1425 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1426 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1427 0, priv->interface, buf, 0,
1428 WDR_TIMEOUT) < 0) {
1429 err("error from flowcontrol urb");
David Brownell5c09d142006-10-13 15:57:58 -07001430 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431
Ian Abbott74ede0f2005-07-29 12:16:41 -07001432 /* drop RTS and DTR */
1433 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434 } /* Note change no line if hupcl is off */
Ian Abbott76854ce2005-06-02 10:34:11 +01001435
1436 /* cancel any scheduled reading */
1437 cancel_delayed_work(&priv->rx_work);
1438 flush_scheduled_work();
David Brownell5c09d142006-10-13 15:57:58 -07001439
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440 /* shutdown our bulk read */
Mariusz Kozlowski794c9442006-11-08 15:36:25 +01001441 usb_kill_urb(port->read_urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442} /* ftdi_close */
1443
1444
David Brownell5c09d142006-10-13 15:57:58 -07001445
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446/* The SIO requires the first byte to have:
1447 * B0 1
1448 * B1 0
1449 * B2..7 length of message excluding byte 0
1450 *
1451 * The new devices do not require this byte
1452 */
1453static int ftdi_write (struct usb_serial_port *port,
1454 const unsigned char *buf, int count)
1455{ /* ftdi_write */
1456 struct ftdi_private *priv = usb_get_serial_port_data(port);
1457 struct urb *urb;
1458 unsigned char *buffer;
1459 int data_offset ; /* will be 1 for the SIO and 0 otherwise */
1460 int status;
1461 int transfer_size;
Ian Abbott22465402006-06-26 12:59:17 +01001462 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463
1464 dbg("%s port %d, %d bytes", __FUNCTION__, port->number, count);
1465
1466 if (count == 0) {
1467 dbg("write request of 0 bytes");
1468 return 0;
1469 }
Ian Abbott22465402006-06-26 12:59:17 +01001470 spin_lock_irqsave(&priv->tx_lock, flags);
1471 if (priv->tx_outstanding_urbs > URB_UPPER_LIMIT) {
1472 spin_unlock_irqrestore(&priv->tx_lock, flags);
1473 dbg("%s - write limit hit\n", __FUNCTION__);
1474 return 0;
1475 }
Oliver Neukum62127a52007-03-23 14:30:16 +01001476 priv->tx_outstanding_urbs++;
Ian Abbott22465402006-06-26 12:59:17 +01001477 spin_unlock_irqrestore(&priv->tx_lock, flags);
David Brownell5c09d142006-10-13 15:57:58 -07001478
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479 data_offset = priv->write_offset;
1480 dbg("data_offset set to %d",data_offset);
1481
1482 /* Determine total transfer size */
1483 transfer_size = count;
1484 if (data_offset > 0) {
1485 /* Original sio needs control bytes too... */
1486 transfer_size += (data_offset *
1487 ((count + (PKTSZ - 1 - data_offset)) /
1488 (PKTSZ - data_offset)));
1489 }
1490
1491 buffer = kmalloc (transfer_size, GFP_ATOMIC);
1492 if (!buffer) {
1493 err("%s ran out of kernel memory for urb ...", __FUNCTION__);
Oliver Neukum62127a52007-03-23 14:30:16 +01001494 count = -ENOMEM;
1495 goto error_no_buffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496 }
1497
1498 urb = usb_alloc_urb(0, GFP_ATOMIC);
1499 if (!urb) {
1500 err("%s - no more free urbs", __FUNCTION__);
Oliver Neukum62127a52007-03-23 14:30:16 +01001501 count = -ENOMEM;
1502 goto error_no_urb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503 }
1504
1505 /* Copy data */
1506 if (data_offset > 0) {
1507 /* Original sio requires control byte at start of each packet. */
1508 int user_pktsz = PKTSZ - data_offset;
1509 int todo = count;
1510 unsigned char *first_byte = buffer;
1511 const unsigned char *current_position = buf;
1512
1513 while (todo > 0) {
1514 if (user_pktsz > todo) {
1515 user_pktsz = todo;
1516 }
1517 /* Write the control byte at the front of the packet*/
David Brownell5c09d142006-10-13 15:57:58 -07001518 *first_byte = 1 | ((user_pktsz) << 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519 /* Copy data for packet */
1520 memcpy (first_byte + data_offset,
1521 current_position, user_pktsz);
1522 first_byte += user_pktsz + data_offset;
1523 current_position += user_pktsz;
1524 todo -= user_pktsz;
1525 }
1526 } else {
1527 /* No control byte required. */
1528 /* Copy in the data to send */
1529 memcpy (buffer, buf, count);
1530 }
1531
1532 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, transfer_size, buffer);
1533
1534 /* fill the buffer and send it */
David Brownell5c09d142006-10-13 15:57:58 -07001535 usb_fill_bulk_urb(urb, port->serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536 usb_sndbulkpipe(port->serial->dev, port->bulk_out_endpointAddress),
1537 buffer, transfer_size,
1538 ftdi_write_bulk_callback, port);
1539
1540 status = usb_submit_urb(urb, GFP_ATOMIC);
1541 if (status) {
1542 err("%s - failed submitting write urb, error %d", __FUNCTION__, status);
1543 count = status;
Oliver Neukum62127a52007-03-23 14:30:16 +01001544 goto error;
Ian Abbott22465402006-06-26 12:59:17 +01001545 } else {
1546 spin_lock_irqsave(&priv->tx_lock, flags);
Ian Abbott22465402006-06-26 12:59:17 +01001547 priv->tx_outstanding_bytes += count;
1548 priv->tx_bytes += count;
1549 spin_unlock_irqrestore(&priv->tx_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550 }
1551
1552 /* we are done with this urb, so let the host driver
1553 * really free it when it is finished with it */
Oliver Neukum62127a52007-03-23 14:30:16 +01001554 usb_free_urb(urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555
1556 dbg("%s write returning: %d", __FUNCTION__, count);
1557 return count;
Oliver Neukum62127a52007-03-23 14:30:16 +01001558error:
1559 usb_free_urb(urb);
1560error_no_urb:
1561 kfree (buffer);
1562error_no_buffer:
1563 spin_lock_irqsave(&priv->tx_lock, flags);
1564 priv->tx_outstanding_urbs--;
1565 spin_unlock_irqrestore(&priv->tx_lock, flags);
1566 return count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567} /* ftdi_write */
1568
1569
1570/* This function may get called when the device is closed */
1571
David Howells7d12e782006-10-05 14:55:46 +01001572static void ftdi_write_bulk_callback (struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573{
Ian Abbott22465402006-06-26 12:59:17 +01001574 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
Ian Abbott22465402006-06-26 12:59:17 +01001576 struct ftdi_private *priv;
1577 int data_offset; /* will be 1 for the SIO and 0 otherwise */
1578 unsigned long countback;
Greg Kroah-Hartman0fb0aa12007-06-15 15:44:13 -07001579 int status = urb->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580
1581 /* free up the transfer buffer, as usb_free_urb() does not do this */
1582 kfree (urb->transfer_buffer);
1583
1584 dbg("%s - port %d", __FUNCTION__, port->number);
David Brownell5c09d142006-10-13 15:57:58 -07001585
Greg Kroah-Hartman0fb0aa12007-06-15 15:44:13 -07001586 if (status) {
1587 dbg("nonzero write bulk status received: %d", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 return;
1589 }
1590
Ian Abbott22465402006-06-26 12:59:17 +01001591 priv = usb_get_serial_port_data(port);
1592 if (!priv) {
1593 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1594 return;
1595 }
1596 /* account for transferred data */
1597 countback = urb->actual_length;
1598 data_offset = priv->write_offset;
1599 if (data_offset > 0) {
1600 /* Subtract the control bytes */
1601 countback -= (data_offset * ((countback + (PKTSZ - 1)) / PKTSZ));
1602 }
1603 spin_lock_irqsave(&priv->tx_lock, flags);
1604 --priv->tx_outstanding_urbs;
1605 priv->tx_outstanding_bytes -= countback;
1606 spin_unlock_irqrestore(&priv->tx_lock, flags);
1607
Pete Zaitcevcf2c7482006-05-22 21:58:49 -07001608 usb_serial_port_softint(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609} /* ftdi_write_bulk_callback */
1610
1611
1612static int ftdi_write_room( struct usb_serial_port *port )
1613{
Ian Abbott22465402006-06-26 12:59:17 +01001614 struct ftdi_private *priv = usb_get_serial_port_data(port);
1615 int room;
1616 unsigned long flags;
1617
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 dbg("%s - port %d", __FUNCTION__, port->number);
1619
Ian Abbott22465402006-06-26 12:59:17 +01001620 spin_lock_irqsave(&priv->tx_lock, flags);
1621 if (priv->tx_outstanding_urbs < URB_UPPER_LIMIT) {
1622 /*
1623 * We really can take anything the user throws at us
1624 * but let's pick a nice big number to tell the tty
1625 * layer that we have lots of free space
1626 */
1627 room = 2048;
1628 } else {
1629 room = 0;
1630 }
1631 spin_unlock_irqrestore(&priv->tx_lock, flags);
1632 return room;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633} /* ftdi_write_room */
1634
1635
1636static int ftdi_chars_in_buffer (struct usb_serial_port *port)
1637{ /* ftdi_chars_in_buffer */
Ian Abbott22465402006-06-26 12:59:17 +01001638 struct ftdi_private *priv = usb_get_serial_port_data(port);
1639 int buffered;
1640 unsigned long flags;
1641
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642 dbg("%s - port %d", __FUNCTION__, port->number);
1643
Ian Abbott22465402006-06-26 12:59:17 +01001644 spin_lock_irqsave(&priv->tx_lock, flags);
1645 buffered = (int)priv->tx_outstanding_bytes;
1646 spin_unlock_irqrestore(&priv->tx_lock, flags);
1647 if (buffered < 0) {
1648 err("%s outstanding tx bytes is negative!", __FUNCTION__);
1649 buffered = 0;
1650 }
1651 return buffered;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652} /* ftdi_chars_in_buffer */
1653
1654
1655
David Howells7d12e782006-10-05 14:55:46 +01001656static void ftdi_read_bulk_callback (struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657{ /* ftdi_read_bulk_callback */
1658 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1659 struct tty_struct *tty;
1660 struct ftdi_private *priv;
Ian Abbott22465402006-06-26 12:59:17 +01001661 unsigned long countread;
1662 unsigned long flags;
Greg Kroah-Hartman0fb0aa12007-06-15 15:44:13 -07001663 int status = urb->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664
1665 if (urb->number_of_packets > 0) {
1666 err("%s transfer_buffer_length %d actual_length %d number of packets %d",__FUNCTION__,
1667 urb->transfer_buffer_length, urb->actual_length, urb->number_of_packets );
1668 err("%s transfer_flags %x ", __FUNCTION__,urb->transfer_flags );
1669 }
1670
1671 dbg("%s - port %d", __FUNCTION__, port->number);
1672
1673 if (port->open_count <= 0)
1674 return;
1675
1676 tty = port->tty;
1677 if (!tty) {
1678 dbg("%s - bad tty pointer - exiting",__FUNCTION__);
1679 return;
1680 }
1681
1682 priv = usb_get_serial_port_data(port);
1683 if (!priv) {
1684 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1685 return;
1686 }
1687
1688 if (urb != port->read_urb) {
1689 err("%s - Not my urb!", __FUNCTION__);
1690 }
1691
Greg Kroah-Hartman0fb0aa12007-06-15 15:44:13 -07001692 if (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693 /* This will happen at close every time so it is a dbg not an err */
Greg Kroah-Hartman0fb0aa12007-06-15 15:44:13 -07001694 dbg("(this is ok on close) nonzero read bulk status received: "
1695 "%d", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696 return;
1697 }
1698
Ian Abbott22465402006-06-26 12:59:17 +01001699 /* count data bytes, but not status bytes */
1700 countread = urb->actual_length;
1701 countread -= 2 * ((countread + (PKTSZ - 1)) / PKTSZ);
1702 spin_lock_irqsave(&priv->rx_lock, flags);
1703 priv->rx_bytes += countread;
1704 spin_unlock_irqrestore(&priv->rx_lock, flags);
1705
David Howellsc4028952006-11-22 14:57:56 +00001706 ftdi_process_read(&priv->rx_work.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707
1708} /* ftdi_read_bulk_callback */
1709
1710
David Howellsc4028952006-11-22 14:57:56 +00001711static void ftdi_process_read (struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712{ /* ftdi_process_read */
David Howellsc4028952006-11-22 14:57:56 +00001713 struct ftdi_private *priv =
1714 container_of(work, struct ftdi_private, rx_work.work);
1715 struct usb_serial_port *port = priv->port;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716 struct urb *urb;
1717 struct tty_struct *tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001718 char error_flag;
David Brownell5c09d142006-10-13 15:57:58 -07001719 unsigned char *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720
1721 int i;
1722 int result;
1723 int need_flip;
1724 int packet_offset;
Ian Abbott76854ce2005-06-02 10:34:11 +01001725 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726
1727 dbg("%s - port %d", __FUNCTION__, port->number);
1728
1729 if (port->open_count <= 0)
1730 return;
1731
1732 tty = port->tty;
1733 if (!tty) {
1734 dbg("%s - bad tty pointer - exiting",__FUNCTION__);
1735 return;
1736 }
1737
1738 priv = usb_get_serial_port_data(port);
1739 if (!priv) {
1740 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1741 return;
1742 }
1743
1744 urb = port->read_urb;
1745 if (!urb) {
1746 dbg("%s - bad read_urb pointer - exiting", __FUNCTION__);
1747 return;
1748 }
1749
1750 data = urb->transfer_buffer;
1751
Ian Abbott76854ce2005-06-02 10:34:11 +01001752 if (priv->rx_processed) {
1753 dbg("%s - already processed: %d bytes, %d remain", __FUNCTION__,
1754 priv->rx_processed,
1755 urb->actual_length - priv->rx_processed);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756 } else {
Ian Abbott76854ce2005-06-02 10:34:11 +01001757 /* The first two bytes of every read packet are status */
1758 if (urb->actual_length > 2) {
1759 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
1760 } else {
1761 dbg("Status only: %03oo %03oo",data[0],data[1]);
1762 }
1763 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764
1765
1766 /* TO DO -- check for hung up line and handle appropriately: */
1767 /* send hangup */
1768 /* See acm.c - you do a tty_hangup - eg tty_hangup(tty) */
1769 /* if CD is dropped and the line is not CLOCAL then we should hangup */
1770
1771 need_flip = 0;
Ian Abbott76854ce2005-06-02 10:34:11 +01001772 for (packet_offset = priv->rx_processed; packet_offset < urb->actual_length; packet_offset += PKTSZ) {
1773 int length;
1774
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775 /* Compare new line status to the old one, signal if different */
Ian Abbott76854ce2005-06-02 10:34:11 +01001776 /* N.B. packet may be processed more than once, but differences
1777 * are only processed once. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778 if (priv != NULL) {
1779 char new_status = data[packet_offset+0] & FTDI_STATUS_B0_MASK;
1780 if (new_status != priv->prev_status) {
1781 priv->diff_status |= new_status ^ priv->prev_status;
1782 wake_up_interruptible(&priv->delta_msr_wait);
1783 priv->prev_status = new_status;
1784 }
1785 }
1786
Ian Abbott76854ce2005-06-02 10:34:11 +01001787 length = min(PKTSZ, urb->actual_length-packet_offset)-2;
1788 if (length < 0) {
1789 err("%s - bad packet length: %d", __FUNCTION__, length+2);
1790 length = 0;
1791 }
1792
Ian Abbott76854ce2005-06-02 10:34:11 +01001793 if (priv->rx_flags & THROTTLED) {
1794 dbg("%s - throttled", __FUNCTION__);
1795 break;
1796 }
Alan Cox33f0f882006-01-09 20:54:13 -08001797 if (tty_buffer_request_room(tty, length) < length) {
Ian Abbott76854ce2005-06-02 10:34:11 +01001798 /* break out & wait for throttling/unthrottling to happen */
1799 dbg("%s - receive room low", __FUNCTION__);
1800 break;
1801 }
1802
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803 /* Handle errors and break */
1804 error_flag = TTY_NORMAL;
1805 /* Although the device uses a bitmask and hence can have multiple */
1806 /* errors on a packet - the order here sets the priority the */
1807 /* error is returned to the tty layer */
1808
1809 if ( data[packet_offset+1] & FTDI_RS_OE ) {
1810 error_flag = TTY_OVERRUN;
1811 dbg("OVERRRUN error");
1812 }
1813 if ( data[packet_offset+1] & FTDI_RS_BI ) {
1814 error_flag = TTY_BREAK;
1815 dbg("BREAK received");
1816 }
1817 if ( data[packet_offset+1] & FTDI_RS_PE ) {
1818 error_flag = TTY_PARITY;
1819 dbg("PARITY error");
1820 }
1821 if ( data[packet_offset+1] & FTDI_RS_FE ) {
1822 error_flag = TTY_FRAME;
1823 dbg("FRAMING error");
1824 }
Ian Abbott76854ce2005-06-02 10:34:11 +01001825 if (length > 0) {
1826 for (i = 2; i < length+2; i++) {
David Brownell5c09d142006-10-13 15:57:58 -07001827 /* Note that the error flag is duplicated for
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828 every character received since we don't know
1829 which character it applied to */
1830 tty_insert_flip_char(tty, data[packet_offset+i], error_flag);
1831 }
1832 need_flip = 1;
1833 }
1834
1835#ifdef NOT_CORRECT_BUT_KEEPING_IT_FOR_NOW
1836 /* if a parity error is detected you get status packets forever
1837 until a character is sent without a parity error.
1838 This doesn't work well since the application receives a never
1839 ending stream of bad data - even though new data hasn't been sent.
1840 Therefore I (bill) have taken this out.
David Brownell5c09d142006-10-13 15:57:58 -07001841 However - this might make sense for framing errors and so on
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842 so I am leaving the code in for now.
1843 */
1844 else {
1845 if (error_flag != TTY_NORMAL){
1846 dbg("error_flag is not normal");
1847 /* In this case it is just status - if that is an error send a bad character */
1848 if(tty->flip.count >= TTY_FLIPBUF_SIZE) {
1849 tty_flip_buffer_push(tty);
1850 }
1851 tty_insert_flip_char(tty, 0xff, error_flag);
1852 need_flip = 1;
1853 }
1854 }
1855#endif
1856 } /* "for(packet_offset=0..." */
1857
1858 /* Low latency */
1859 if (need_flip) {
1860 tty_flip_buffer_push(tty);
1861 }
1862
Ian Abbott76854ce2005-06-02 10:34:11 +01001863 if (packet_offset < urb->actual_length) {
1864 /* not completely processed - record progress */
1865 priv->rx_processed = packet_offset;
1866 dbg("%s - incomplete, %d bytes processed, %d remain",
1867 __FUNCTION__, packet_offset,
1868 urb->actual_length - packet_offset);
1869 /* check if we were throttled while processing */
1870 spin_lock_irqsave(&priv->rx_lock, flags);
1871 if (priv->rx_flags & THROTTLED) {
1872 priv->rx_flags |= ACTUALLY_THROTTLED;
1873 spin_unlock_irqrestore(&priv->rx_lock, flags);
1874 dbg("%s - deferring remainder until unthrottled",
1875 __FUNCTION__);
1876 return;
1877 }
1878 spin_unlock_irqrestore(&priv->rx_lock, flags);
1879 /* if the port is closed stop trying to read */
1880 if (port->open_count > 0){
1881 /* delay processing of remainder */
1882 schedule_delayed_work(&priv->rx_work, 1);
1883 } else {
1884 dbg("%s - port is closed", __FUNCTION__);
1885 }
1886 return;
1887 }
1888
1889 /* urb is completely processed */
1890 priv->rx_processed = 0;
1891
Linus Torvalds1da177e2005-04-16 15:20:36 -07001892 /* if the port is closed stop trying to read */
1893 if (port->open_count > 0){
1894 /* Continue trying to always read */
David Brownell5c09d142006-10-13 15:57:58 -07001895 usb_fill_bulk_urb(port->read_urb, port->serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001896 usb_rcvbulkpipe(port->serial->dev, port->bulk_in_endpointAddress),
1897 port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
1898 ftdi_read_bulk_callback, port);
1899
1900 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1901 if (result)
1902 err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
1903 }
1904
1905 return;
1906} /* ftdi_process_read */
1907
1908
1909static void ftdi_break_ctl( struct usb_serial_port *port, int break_state )
1910{
1911 struct ftdi_private *priv = usb_get_serial_port_data(port);
David Brownell5c09d142006-10-13 15:57:58 -07001912 __u16 urb_value = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913 char buf[1];
David Brownell5c09d142006-10-13 15:57:58 -07001914
Linus Torvalds1da177e2005-04-16 15:20:36 -07001915 /* break_state = -1 to turn on break, and 0 to turn off break */
1916 /* see drivers/char/tty_io.c to see it used */
1917 /* last_set_data_urb_value NEVER has the break bit set in it */
1918
1919 if (break_state) {
1920 urb_value = priv->last_set_data_urb_value | FTDI_SIO_SET_BREAK;
1921 } else {
David Brownell5c09d142006-10-13 15:57:58 -07001922 urb_value = priv->last_set_data_urb_value;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923 }
1924
David Brownell5c09d142006-10-13 15:57:58 -07001925
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926 if (usb_control_msg(port->serial->dev, usb_sndctrlpipe(port->serial->dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07001927 FTDI_SIO_SET_DATA_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928 FTDI_SIO_SET_DATA_REQUEST_TYPE,
1929 urb_value , priv->interface,
1930 buf, 0, WDR_TIMEOUT) < 0) {
1931 err("%s FAILED to enable/disable break state (state was %d)", __FUNCTION__,break_state);
David Brownell5c09d142006-10-13 15:57:58 -07001932 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933
1934 dbg("%s break state is %d - urb is %d", __FUNCTION__,break_state, urb_value);
David Brownell5c09d142006-10-13 15:57:58 -07001935
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936}
1937
1938
1939/* old_termios contains the original termios settings and tty->termios contains
1940 * the new setting to be used
1941 * WARNING: set_termios calls this with old_termios in kernel space
1942 */
1943
Alan Cox606d0992006-12-08 02:38:45 -08001944static void ftdi_set_termios (struct usb_serial_port *port, struct ktermios *old_termios)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001945{ /* ftdi_termios */
1946 struct usb_device *dev = port->serial->dev;
1947 unsigned int cflag = port->tty->termios->c_cflag;
1948 struct ftdi_private *priv = usb_get_serial_port_data(port);
1949 __u16 urb_value; /* will hold the new flags */
1950 char buf[1]; /* Perhaps I should dynamically alloc this? */
David Brownell5c09d142006-10-13 15:57:58 -07001951
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 // Added for xon/xoff support
1953 unsigned int iflag = port->tty->termios->c_iflag;
1954 unsigned char vstop;
1955 unsigned char vstart;
David Brownell5c09d142006-10-13 15:57:58 -07001956
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957 dbg("%s", __FUNCTION__);
1958
1959 /* Force baud rate if this device requires it, unless it is set to B0. */
1960 if (priv->force_baud && ((port->tty->termios->c_cflag & CBAUD) != B0)) {
1961 dbg("%s: forcing baud rate for this device", __FUNCTION__);
1962 port->tty->termios->c_cflag &= ~CBAUD;
1963 port->tty->termios->c_cflag |= priv->force_baud;
1964 }
1965
1966 /* Force RTS-CTS if this device requires it. */
1967 if (priv->force_rtscts) {
1968 dbg("%s: forcing rtscts for this device", __FUNCTION__);
1969 port->tty->termios->c_cflag |= CRTSCTS;
1970 }
1971
1972 cflag = port->tty->termios->c_cflag;
1973
David Brownell5c09d142006-10-13 15:57:58 -07001974 /* FIXME -For this cut I don't care if the line is really changing or
1975 not - so just do the change regardless - should be able to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001976 compare old_termios and tty->termios */
David Brownell5c09d142006-10-13 15:57:58 -07001977 /* NOTE These routines can get interrupted by
1978 ftdi_sio_read_bulk_callback - need to examine what this
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979 means - don't see any problems yet */
David Brownell5c09d142006-10-13 15:57:58 -07001980
Linus Torvalds1da177e2005-04-16 15:20:36 -07001981 /* Set number of data bits, parity, stop bits */
David Brownell5c09d142006-10-13 15:57:58 -07001982
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983 urb_value = 0;
1984 urb_value |= (cflag & CSTOPB ? FTDI_SIO_SET_DATA_STOP_BITS_2 :
1985 FTDI_SIO_SET_DATA_STOP_BITS_1);
David Brownell5c09d142006-10-13 15:57:58 -07001986 urb_value |= (cflag & PARENB ?
1987 (cflag & PARODD ? FTDI_SIO_SET_DATA_PARITY_ODD :
Linus Torvalds1da177e2005-04-16 15:20:36 -07001988 FTDI_SIO_SET_DATA_PARITY_EVEN) :
1989 FTDI_SIO_SET_DATA_PARITY_NONE);
1990 if (cflag & CSIZE) {
1991 switch (cflag & CSIZE) {
1992 case CS5: urb_value |= 5; dbg("Setting CS5"); break;
1993 case CS6: urb_value |= 6; dbg("Setting CS6"); break;
1994 case CS7: urb_value |= 7; dbg("Setting CS7"); break;
1995 case CS8: urb_value |= 8; dbg("Setting CS8"); break;
1996 default:
1997 err("CSIZE was set but not CS5-CS8");
1998 }
1999 }
2000
2001 /* This is needed by the break command since it uses the same command - but is
2002 * or'ed with this value */
2003 priv->last_set_data_urb_value = urb_value;
David Brownell5c09d142006-10-13 15:57:58 -07002004
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002006 FTDI_SIO_SET_DATA_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002007 FTDI_SIO_SET_DATA_REQUEST_TYPE,
2008 urb_value , priv->interface,
Ian Abbott279e1542005-07-29 12:16:52 -07002009 buf, 0, WDR_SHORT_TIMEOUT) < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002010 err("%s FAILED to set databits/stopbits/parity", __FUNCTION__);
David Brownell5c09d142006-10-13 15:57:58 -07002011 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002012
2013 /* Now do the baudrate */
2014 if ((cflag & CBAUD) == B0 ) {
2015 /* Disable flow control */
2016 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002017 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07002019 0, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002020 buf, 0, WDR_TIMEOUT) < 0) {
2021 err("%s error from disable flowcontrol urb", __FUNCTION__);
David Brownell5c09d142006-10-13 15:57:58 -07002022 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002023 /* Drop RTS and DTR */
Ian Abbott74ede0f2005-07-29 12:16:41 -07002024 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025 } else {
2026 /* set the baudrate determined before */
2027 if (change_speed(port)) {
Peter Favrholdt72a755f2005-09-22 00:48:49 -07002028 err("%s urb failed to set baudrate", __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029 }
Peter Favrholdt72a755f2005-09-22 00:48:49 -07002030 /* Ensure RTS and DTR are raised when baudrate changed from 0 */
Guennadi Liakhovetski57845bd2006-04-13 22:27:12 +02002031 if (!old_termios || (old_termios->c_cflag & CBAUD) == B0) {
Peter Favrholdt72a755f2005-09-22 00:48:49 -07002032 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2033 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034 }
2035
2036 /* Set flow control */
2037 /* Note device also supports DTR/CD (ugh) and Xon/Xoff in hardware */
2038 if (cflag & CRTSCTS) {
2039 dbg("%s Setting to CRTSCTS flow control", __FUNCTION__);
David Brownell5c09d142006-10-13 15:57:58 -07002040 if (usb_control_msg(dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041 usb_sndctrlpipe(dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002042 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2044 0 , (FTDI_SIO_RTS_CTS_HS | priv->interface),
2045 buf, 0, WDR_TIMEOUT) < 0) {
2046 err("urb failed to set to rts/cts flow control");
David Brownell5c09d142006-10-13 15:57:58 -07002047 }
2048
2049 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002050 /*
2051 * Xon/Xoff code
2052 *
2053 * Check the IXOFF status in the iflag component of the termios structure
2054 * if IXOFF is not set, the pre-xon/xoff code is executed.
2055 */
2056 if (iflag & IXOFF) {
2057 dbg("%s request to enable xonxoff iflag=%04x",__FUNCTION__,iflag);
2058 // Try to enable the XON/XOFF on the ftdi_sio
2059 // Set the vstart and vstop -- could have been done up above where
2060 // a lot of other dereferencing is done but that would be very
2061 // inefficient as vstart and vstop are not always needed
2062 vstart=port->tty->termios->c_cc[VSTART];
2063 vstop=port->tty->termios->c_cc[VSTOP];
2064 urb_value=(vstop << 8) | (vstart);
2065
2066 if (usb_control_msg(dev,
2067 usb_sndctrlpipe(dev, 0),
2068 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2069 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2070 urb_value , (FTDI_SIO_XON_XOFF_HS
2071 | priv->interface),
2072 buf, 0, WDR_TIMEOUT) < 0) {
2073 err("urb failed to set to xon/xoff flow control");
2074 }
2075 } else {
2076 /* else clause to only run if cfag ! CRTSCTS and iflag ! XOFF */
2077 /* CHECKME Assuming XON/XOFF handled by tty stack - not by device */
2078 dbg("%s Turning off hardware flow control", __FUNCTION__);
David Brownell5c09d142006-10-13 15:57:58 -07002079 if (usb_control_msg(dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002080 usb_sndctrlpipe(dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002081 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07002083 0, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084 buf, 0, WDR_TIMEOUT) < 0) {
2085 err("urb failed to clear flow control");
David Brownell5c09d142006-10-13 15:57:58 -07002086 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087 }
David Brownell5c09d142006-10-13 15:57:58 -07002088
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089 }
2090 return;
2091} /* ftdi_termios */
2092
2093
2094static int ftdi_tiocmget (struct usb_serial_port *port, struct file *file)
2095{
2096 struct ftdi_private *priv = usb_get_serial_port_data(port);
2097 unsigned char buf[2];
2098 int ret;
2099
2100 dbg("%s TIOCMGET", __FUNCTION__);
2101 switch (priv->chip_type) {
2102 case SIO:
2103 /* Request the status from the device */
David Brownell5c09d142006-10-13 15:57:58 -07002104 if ((ret = usb_control_msg(port->serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105 usb_rcvctrlpipe(port->serial->dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002106 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07002108 0, 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 buf, 1, WDR_TIMEOUT)) < 0 ) {
2110 err("%s Could not get modem status of device - err: %d", __FUNCTION__,
2111 ret);
2112 return(ret);
2113 }
2114 break;
2115 case FT8U232AM:
2116 case FT232BM:
2117 case FT2232C:
2118 /* the 8U232AM returns a two byte value (the sio is a 1 byte value) - in the same
2119 format as the data returned from the in point */
David Brownell5c09d142006-10-13 15:57:58 -07002120 if ((ret = usb_control_msg(port->serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121 usb_rcvctrlpipe(port->serial->dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002122 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07002124 0, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125 buf, 2, WDR_TIMEOUT)) < 0 ) {
2126 err("%s Could not get modem status of device - err: %d", __FUNCTION__,
2127 ret);
2128 return(ret);
2129 }
2130 break;
2131 default:
2132 return -EFAULT;
2133 break;
2134 }
David Brownell5c09d142006-10-13 15:57:58 -07002135
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136 return (buf[0] & FTDI_SIO_DSR_MASK ? TIOCM_DSR : 0) |
2137 (buf[0] & FTDI_SIO_CTS_MASK ? TIOCM_CTS : 0) |
2138 (buf[0] & FTDI_SIO_RI_MASK ? TIOCM_RI : 0) |
2139 (buf[0] & FTDI_SIO_RLSD_MASK ? TIOCM_CD : 0) |
David Brownell5c09d142006-10-13 15:57:58 -07002140 priv->last_dtr_rts;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141}
2142
2143static int ftdi_tiocmset(struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear)
2144{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002145 dbg("%s TIOCMSET", __FUNCTION__);
Ian Abbott74ede0f2005-07-29 12:16:41 -07002146 return update_mctrl(port, set, clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147}
2148
2149
2150static int ftdi_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
2151{
2152 struct ftdi_private *priv = usb_get_serial_port_data(port);
2153
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 dbg("%s cmd 0x%04x", __FUNCTION__, cmd);
2155
2156 /* Based on code from acm.c and others */
2157 switch (cmd) {
2158
Linus Torvalds1da177e2005-04-16 15:20:36 -07002159 case TIOCGSERIAL: /* gets serial port data */
2160 return get_serial_info(port, (struct serial_struct __user *) arg);
2161
2162 case TIOCSSERIAL: /* sets serial port data */
2163 return set_serial_info(port, (struct serial_struct __user *) arg);
2164
2165 /*
2166 * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
2167 * - mask passed in arg for lines of interest
2168 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
2169 * Caller should use TIOCGICOUNT to see which one it was.
2170 *
2171 * This code is borrowed from linux/drivers/char/serial.c
2172 */
2173 case TIOCMIWAIT:
2174 while (priv != NULL) {
2175 interruptible_sleep_on(&priv->delta_msr_wait);
2176 /* see if a signal did it */
2177 if (signal_pending(current))
2178 return -ERESTARTSYS;
2179 else {
2180 char diff = priv->diff_status;
2181
2182 if (diff == 0) {
2183 return -EIO; /* no change => error */
2184 }
2185
2186 /* Consume all events */
2187 priv->diff_status = 0;
2188
2189 /* Return 0 if caller wanted to know about these bits */
2190 if ( ((arg & TIOCM_RNG) && (diff & FTDI_RS0_RI)) ||
2191 ((arg & TIOCM_DSR) && (diff & FTDI_RS0_DSR)) ||
2192 ((arg & TIOCM_CD) && (diff & FTDI_RS0_RLSD)) ||
2193 ((arg & TIOCM_CTS) && (diff & FTDI_RS0_CTS)) ) {
2194 return 0;
2195 }
2196 /*
2197 * Otherwise caller can't care less about what happened,
2198 * and so we continue to wait for more events.
2199 */
2200 }
2201 }
2202 return(0);
2203 break;
2204 default:
2205 break;
David Brownell5c09d142006-10-13 15:57:58 -07002206
Linus Torvalds1da177e2005-04-16 15:20:36 -07002207 }
2208
2209
David Brownell5c09d142006-10-13 15:57:58 -07002210 /* This is not necessarily an error - turns out the higher layers will do
Linus Torvalds1da177e2005-04-16 15:20:36 -07002211 * some ioctls itself (see comment above)
2212 */
2213 dbg("%s arg not supported - it was 0x%04x - check /usr/include/asm/ioctls.h", __FUNCTION__, cmd);
2214
2215 return(-ENOIOCTLCMD);
2216} /* ftdi_ioctl */
2217
2218
2219static void ftdi_throttle (struct usb_serial_port *port)
2220{
2221 struct ftdi_private *priv = usb_get_serial_port_data(port);
2222 unsigned long flags;
2223
2224 dbg("%s - port %d", __FUNCTION__, port->number);
2225
2226 spin_lock_irqsave(&priv->rx_lock, flags);
2227 priv->rx_flags |= THROTTLED;
2228 spin_unlock_irqrestore(&priv->rx_lock, flags);
2229}
2230
2231
2232static void ftdi_unthrottle (struct usb_serial_port *port)
2233{
2234 struct ftdi_private *priv = usb_get_serial_port_data(port);
2235 int actually_throttled;
2236 unsigned long flags;
2237
2238 dbg("%s - port %d", __FUNCTION__, port->number);
2239
2240 spin_lock_irqsave(&priv->rx_lock, flags);
2241 actually_throttled = priv->rx_flags & ACTUALLY_THROTTLED;
2242 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
2243 spin_unlock_irqrestore(&priv->rx_lock, flags);
2244
2245 if (actually_throttled)
David Howellsc4028952006-11-22 14:57:56 +00002246 schedule_delayed_work(&priv->rx_work, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002247}
2248
2249static int __init ftdi_init (void)
2250{
2251 int retval;
2252
2253 dbg("%s", __FUNCTION__);
Ian Abbottfdcb0a02005-07-28 18:40:32 +01002254 if (vendor > 0 && product > 0) {
2255 /* Add user specified VID/PID to reserved element of table. */
2256 int i;
2257 for (i = 0; id_table_combined[i].idVendor; i++)
2258 ;
2259 id_table_combined[i].match_flags = USB_DEVICE_ID_MATCH_DEVICE;
2260 id_table_combined[i].idVendor = vendor;
2261 id_table_combined[i].idProduct = product;
2262 }
Ian Abbott8f977e42005-06-20 16:45:42 +01002263 retval = usb_serial_register(&ftdi_sio_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264 if (retval)
Ian Abbott8f977e42005-06-20 16:45:42 +01002265 goto failed_sio_register;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266 retval = usb_register(&ftdi_driver);
David Brownell5c09d142006-10-13 15:57:58 -07002267 if (retval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002268 goto failed_usb_register;
2269
2270 info(DRIVER_VERSION ":" DRIVER_DESC);
2271 return 0;
2272failed_usb_register:
Ian Abbott8f977e42005-06-20 16:45:42 +01002273 usb_serial_deregister(&ftdi_sio_device);
2274failed_sio_register:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275 return retval;
2276}
2277
2278
2279static void __exit ftdi_exit (void)
2280{
2281
2282 dbg("%s", __FUNCTION__);
2283
2284 usb_deregister (&ftdi_driver);
Ian Abbott8f977e42005-06-20 16:45:42 +01002285 usb_serial_deregister (&ftdi_sio_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002286
2287}
2288
2289
2290module_init(ftdi_init);
2291module_exit(ftdi_exit);
2292
2293MODULE_AUTHOR( DRIVER_AUTHOR );
2294MODULE_DESCRIPTION( DRIVER_DESC );
2295MODULE_LICENSE("GPL");
2296
2297module_param(debug, bool, S_IRUGO | S_IWUSR);
2298MODULE_PARM_DESC(debug, "Debug enabled or not");
Ian Abbottfdcb0a02005-07-28 18:40:32 +01002299module_param(vendor, ushort, 0);
2300MODULE_PARM_DESC(vendor, "User specified vendor ID (default="
2301 __MODULE_STRING(FTDI_VID)")");
2302module_param(product, ushort, 0);
2303MODULE_PARM_DESC(vendor, "User specified product ID");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304