blob: da1c6f7f82b8123aba7e089c4133b5f7beace4f0 [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 Abbott740a4282005-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) &&
1152 (priv->chip_type == FT232BM || priv->chip_type == FT2232C)) {
Jim Radford12bdbe02007-02-28 10:10:50 -08001153 retval = device_create_file(&port->dev,
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001154 &dev_attr_latency_timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155 }
1156 }
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001157 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158}
1159
Jim Radford12bdbe02007-02-28 10:10:50 -08001160static void remove_sysfs_attrs(struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161{
Jim Radford12bdbe02007-02-28 10:10:50 -08001162 struct ftdi_private *priv = usb_get_serial_port_data(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163
David Brownell5c09d142006-10-13 15:57:58 -07001164 dbg("%s",__FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166 /* XXX see create_sysfs_attrs */
1167 if (priv->chip_type != SIO) {
Jim Radford12bdbe02007-02-28 10:10:50 -08001168 device_remove_file(&port->dev, &dev_attr_event_char);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169 if (priv->chip_type == FT232BM || priv->chip_type == FT2232C) {
Jim Radford12bdbe02007-02-28 10:10:50 -08001170 device_remove_file(&port->dev, &dev_attr_latency_timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171 }
1172 }
David Brownell5c09d142006-10-13 15:57:58 -07001173
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174}
1175
1176/*
1177 * ***************************************************************************
1178 * FTDI driver specific functions
1179 * ***************************************************************************
1180 */
1181
Ian Abbott8f977e42005-06-20 16:45:42 +01001182/* Probe function to check for special devices */
1183static int ftdi_sio_probe (struct usb_serial *serial, const struct usb_device_id *id)
1184{
Tony Lindgrenfa91d432007-05-04 18:23:24 -07001185 struct ftdi_sio_quirk *quirk = (struct ftdi_sio_quirk *)id->driver_info;
1186
1187 if (quirk && quirk->probe) {
1188 int ret = quirk->probe(serial);
1189 if (ret != 0)
1190 return ret;
1191 }
1192
Ian Abbott8f977e42005-06-20 16:45:42 +01001193 usb_set_serial_data(serial, (void *)id->driver_info);
1194
Tony Lindgrenfa91d432007-05-04 18:23:24 -07001195 return 0;
Ian Abbott8f977e42005-06-20 16:45:42 +01001196}
1197
Jim Radford12bdbe02007-02-28 10:10:50 -08001198static int ftdi_sio_port_probe(struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200 struct ftdi_private *priv;
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001201
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202 dbg("%s",__FUNCTION__);
1203
Eric Sesterhenn80b6ca42006-02-27 21:29:43 +01001204 priv = kzalloc(sizeof(struct ftdi_private), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205 if (!priv){
1206 err("%s- kmalloc(%Zd) failed.", __FUNCTION__, sizeof(struct ftdi_private));
1207 return -ENOMEM;
1208 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209
1210 spin_lock_init(&priv->rx_lock);
Ian Abbott22465402006-06-26 12:59:17 +01001211 spin_lock_init(&priv->tx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212 init_waitqueue_head(&priv->delta_msr_wait);
1213 /* This will push the characters through immediately rather
1214 than queue a task to deliver them */
1215 priv->flags = ASYNC_LOW_LATENCY;
1216
1217 /* Increase the size of read buffers */
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07001218 kfree(port->bulk_in_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219 port->bulk_in_buffer = kmalloc (BUFSZ, GFP_KERNEL);
1220 if (!port->bulk_in_buffer) {
1221 kfree (priv);
1222 return -ENOMEM;
1223 }
1224 if (port->read_urb) {
1225 port->read_urb->transfer_buffer = port->bulk_in_buffer;
1226 port->read_urb->transfer_buffer_length = BUFSZ;
1227 }
1228
David Howellsc4028952006-11-22 14:57:56 +00001229 INIT_DELAYED_WORK(&priv->rx_work, ftdi_process_read);
1230 priv->port = port;
Ian Abbott76854ce2005-06-02 10:34:11 +01001231
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232 /* Free port's existing write urb and transfer buffer. */
1233 if (port->write_urb) {
1234 usb_free_urb (port->write_urb);
1235 port->write_urb = NULL;
1236 }
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07001237 kfree(port->bulk_out_buffer);
1238 port->bulk_out_buffer = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239
Jim Radford12bdbe02007-02-28 10:10:50 -08001240 usb_set_serial_port_data(port, priv);
Ian Abbott8f977e42005-06-20 16:45:42 +01001241
Jim Radford12bdbe02007-02-28 10:10:50 -08001242 ftdi_determine_type (port);
1243 create_sysfs_attrs(port);
1244 return 0;
1245}
Ian Abbott8f977e42005-06-20 16:45:42 +01001246
Jim Radford12bdbe02007-02-28 10:10:50 -08001247/* attach subroutine */
1248static int ftdi_sio_attach (struct usb_serial *serial)
1249{
Ian Abbott8f977e42005-06-20 16:45:42 +01001250 /* Check for device requiring special set up. */
Jim Radford12bdbe02007-02-28 10:10:50 -08001251 struct ftdi_sio_quirk *quirk = usb_get_serial_data(serial);
1252
1253 if (quirk && quirk->setup)
Ian Abbott8f977e42005-06-20 16:45:42 +01001254 quirk->setup(serial);
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001255
1256 return 0;
Ian Abbott8f977e42005-06-20 16:45:42 +01001257} /* ftdi_sio_attach */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258
1259
Ian Abbott8f977e42005-06-20 16:45:42 +01001260/* Setup for the USB-UIRT device, which requires hardwired
1261 * baudrate (38400 gets mapped to 312500) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262/* Called from usbserial:serial_probe */
Ian Abbott8f977e42005-06-20 16:45:42 +01001263static void ftdi_USB_UIRT_setup (struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264{
1265 struct ftdi_private *priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266
1267 dbg("%s",__FUNCTION__);
1268
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 priv = usb_get_serial_port_data(serial->port[0]);
1270 priv->flags |= ASYNC_SPD_CUST;
1271 priv->custom_divisor = 77;
1272 priv->force_baud = B38400;
Ian Abbott8f977e42005-06-20 16:45:42 +01001273} /* ftdi_USB_UIRT_setup */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274
Ian Abbott8f977e42005-06-20 16:45:42 +01001275/* Setup for the HE-TIRA1 device, which requires hardwired
1276 * baudrate (38400 gets mapped to 100000) and RTS-CTS enabled. */
1277static void ftdi_HE_TIRA1_setup (struct usb_serial *serial)
1278{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279 struct ftdi_private *priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280
1281 dbg("%s",__FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282
1283 priv = usb_get_serial_port_data(serial->port[0]);
1284 priv->flags |= ASYNC_SPD_CUST;
1285 priv->custom_divisor = 240;
1286 priv->force_baud = B38400;
1287 priv->force_rtscts = 1;
Ian Abbott8f977e42005-06-20 16:45:42 +01001288} /* ftdi_HE_TIRA1_setup */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289
Tony Lindgrenfa91d432007-05-04 18:23:24 -07001290/*
1291 * First port on Olimex arm-usb-ocd is reserved for JTAG interface
1292 * and can be accessed from userspace using openocd.
1293 */
1294static int ftdi_olimex_probe(struct usb_serial *serial)
1295{
1296 struct usb_device *udev = serial->dev;
1297 struct usb_interface *interface = serial->interface;
1298
1299 dbg("%s",__FUNCTION__);
1300
1301 if (interface == udev->actconfig->interface[0]) {
1302 info("Ignoring reserved serial port on Olimex arm-usb-ocd\n");
1303 return -ENODEV;
1304 }
1305
1306 return 0;
1307}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308
David Brownell5c09d142006-10-13 15:57:58 -07001309/* ftdi_shutdown is called from usbserial:usb_serial_disconnect
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310 * it is called when the usb device is disconnected
1311 *
1312 * usbserial:usb_serial_disconnect
1313 * calls __serial_close for each open of the port
1314 * shutdown is called then (ie ftdi_shutdown)
1315 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316static void ftdi_shutdown (struct usb_serial *serial)
Jim Radford12bdbe02007-02-28 10:10:50 -08001317{
1318 dbg("%s", __FUNCTION__);
1319}
David Brownell5c09d142006-10-13 15:57:58 -07001320
Jim Radford12bdbe02007-02-28 10:10:50 -08001321static int ftdi_sio_port_remove(struct usb_serial_port *port)
1322{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323 struct ftdi_private *priv = usb_get_serial_port_data(port);
1324
1325 dbg("%s", __FUNCTION__);
1326
Jim Radford12bdbe02007-02-28 10:10:50 -08001327 remove_sysfs_attrs(port);
David Brownell5c09d142006-10-13 15:57:58 -07001328
1329 /* all open ports are closed at this point
1330 * (by usbserial.c:__serial_close, which calls ftdi_close)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 */
1332
1333 if (priv) {
1334 usb_set_serial_port_data(port, NULL);
1335 kfree(priv);
1336 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337
Jim Radford12bdbe02007-02-28 10:10:50 -08001338 return 0;
1339}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340
1341static int ftdi_open (struct usb_serial_port *port, struct file *filp)
1342{ /* ftdi_open */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343 struct usb_device *dev = port->serial->dev;
1344 struct ftdi_private *priv = usb_get_serial_port_data(port);
1345 unsigned long flags;
David Brownell5c09d142006-10-13 15:57:58 -07001346
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347 int result = 0;
1348 char buf[1]; /* Needed for the usb_control_msg I think */
1349
1350 dbg("%s", __FUNCTION__);
1351
Ian Abbott22465402006-06-26 12:59:17 +01001352 spin_lock_irqsave(&priv->tx_lock, flags);
1353 priv->tx_bytes = 0;
1354 spin_unlock_irqrestore(&priv->tx_lock, flags);
1355 spin_lock_irqsave(&priv->rx_lock, flags);
1356 priv->rx_bytes = 0;
1357 spin_unlock_irqrestore(&priv->rx_lock, flags);
1358
Guennadi Liakhovetski57845bd2006-04-13 22:27:12 +02001359 if (port->tty)
1360 port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361
1362 /* No error checking for this (will get errors later anyway) */
1363 /* See ftdi_sio.h for description of what is reset */
1364 usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07001365 FTDI_SIO_RESET_REQUEST, FTDI_SIO_RESET_REQUEST_TYPE,
1366 FTDI_SIO_RESET_SIO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367 priv->interface, buf, 0, WDR_TIMEOUT);
1368
1369 /* Termios defaults are set by usb_serial_init. We don't change
1370 port->tty->termios - this would loose speed settings, etc.
1371 This is same behaviour as serial.c/rs_open() - Kuba */
1372
1373 /* ftdi_set_termios will send usb control messages */
Guennadi Liakhovetski57845bd2006-04-13 22:27:12 +02001374 if (port->tty)
1375 ftdi_set_termios(port, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376
1377 /* FIXME: Flow control might be enabled, so it should be checked -
1378 we have no control of defaults! */
1379 /* Turn on RTS and DTR since we are not flow controlling by default */
Ian Abbott74ede0f2005-07-29 12:16:41 -07001380 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381
1382 /* Not throttled */
1383 spin_lock_irqsave(&priv->rx_lock, flags);
1384 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
1385 spin_unlock_irqrestore(&priv->rx_lock, flags);
1386
1387 /* Start reading from the device */
Ian Abbott76854ce2005-06-02 10:34:11 +01001388 priv->rx_processed = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389 usb_fill_bulk_urb(port->read_urb, dev,
1390 usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress),
1391 port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
1392 ftdi_read_bulk_callback, port);
1393 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
1394 if (result)
1395 err("%s - failed submitting read urb, error %d", __FUNCTION__, result);
1396
1397
1398 return result;
1399} /* ftdi_open */
1400
1401
1402
David Brownell5c09d142006-10-13 15:57:58 -07001403/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 * usbserial:__serial_close only calls ftdi_close if the point is open
1405 *
1406 * This only gets called when it is the last close
David Brownell5c09d142006-10-13 15:57:58 -07001407 *
1408 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409 */
1410
1411static void ftdi_close (struct usb_serial_port *port, struct file *filp)
1412{ /* ftdi_close */
1413 unsigned int c_cflag = port->tty->termios->c_cflag;
1414 struct ftdi_private *priv = usb_get_serial_port_data(port);
1415 char buf[1];
1416
1417 dbg("%s", __FUNCTION__);
1418
1419 if (c_cflag & HUPCL){
1420 /* Disable flow control */
David Brownell5c09d142006-10-13 15:57:58 -07001421 if (usb_control_msg(port->serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 usb_sndctrlpipe(port->serial->dev, 0),
1423 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1424 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1425 0, priv->interface, buf, 0,
1426 WDR_TIMEOUT) < 0) {
1427 err("error from flowcontrol urb");
David Brownell5c09d142006-10-13 15:57:58 -07001428 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429
Ian Abbott74ede0f2005-07-29 12:16:41 -07001430 /* drop RTS and DTR */
1431 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432 } /* Note change no line if hupcl is off */
Ian Abbott76854ce2005-06-02 10:34:11 +01001433
1434 /* cancel any scheduled reading */
1435 cancel_delayed_work(&priv->rx_work);
1436 flush_scheduled_work();
David Brownell5c09d142006-10-13 15:57:58 -07001437
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438 /* shutdown our bulk read */
Mariusz Kozlowski794c9442006-11-08 15:36:25 +01001439 usb_kill_urb(port->read_urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440} /* ftdi_close */
1441
1442
David Brownell5c09d142006-10-13 15:57:58 -07001443
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444/* The SIO requires the first byte to have:
1445 * B0 1
1446 * B1 0
1447 * B2..7 length of message excluding byte 0
1448 *
1449 * The new devices do not require this byte
1450 */
1451static int ftdi_write (struct usb_serial_port *port,
1452 const unsigned char *buf, int count)
1453{ /* ftdi_write */
1454 struct ftdi_private *priv = usb_get_serial_port_data(port);
1455 struct urb *urb;
1456 unsigned char *buffer;
1457 int data_offset ; /* will be 1 for the SIO and 0 otherwise */
1458 int status;
1459 int transfer_size;
Ian Abbott22465402006-06-26 12:59:17 +01001460 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461
1462 dbg("%s port %d, %d bytes", __FUNCTION__, port->number, count);
1463
1464 if (count == 0) {
1465 dbg("write request of 0 bytes");
1466 return 0;
1467 }
Ian Abbott22465402006-06-26 12:59:17 +01001468 spin_lock_irqsave(&priv->tx_lock, flags);
1469 if (priv->tx_outstanding_urbs > URB_UPPER_LIMIT) {
1470 spin_unlock_irqrestore(&priv->tx_lock, flags);
1471 dbg("%s - write limit hit\n", __FUNCTION__);
1472 return 0;
1473 }
Oliver Neukum62127a52007-03-23 14:30:16 +01001474 priv->tx_outstanding_urbs++;
Ian Abbott22465402006-06-26 12:59:17 +01001475 spin_unlock_irqrestore(&priv->tx_lock, flags);
David Brownell5c09d142006-10-13 15:57:58 -07001476
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477 data_offset = priv->write_offset;
1478 dbg("data_offset set to %d",data_offset);
1479
1480 /* Determine total transfer size */
1481 transfer_size = count;
1482 if (data_offset > 0) {
1483 /* Original sio needs control bytes too... */
1484 transfer_size += (data_offset *
1485 ((count + (PKTSZ - 1 - data_offset)) /
1486 (PKTSZ - data_offset)));
1487 }
1488
1489 buffer = kmalloc (transfer_size, GFP_ATOMIC);
1490 if (!buffer) {
1491 err("%s ran out of kernel memory for urb ...", __FUNCTION__);
Oliver Neukum62127a52007-03-23 14:30:16 +01001492 count = -ENOMEM;
1493 goto error_no_buffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494 }
1495
1496 urb = usb_alloc_urb(0, GFP_ATOMIC);
1497 if (!urb) {
1498 err("%s - no more free urbs", __FUNCTION__);
Oliver Neukum62127a52007-03-23 14:30:16 +01001499 count = -ENOMEM;
1500 goto error_no_urb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501 }
1502
1503 /* Copy data */
1504 if (data_offset > 0) {
1505 /* Original sio requires control byte at start of each packet. */
1506 int user_pktsz = PKTSZ - data_offset;
1507 int todo = count;
1508 unsigned char *first_byte = buffer;
1509 const unsigned char *current_position = buf;
1510
1511 while (todo > 0) {
1512 if (user_pktsz > todo) {
1513 user_pktsz = todo;
1514 }
1515 /* Write the control byte at the front of the packet*/
David Brownell5c09d142006-10-13 15:57:58 -07001516 *first_byte = 1 | ((user_pktsz) << 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517 /* Copy data for packet */
1518 memcpy (first_byte + data_offset,
1519 current_position, user_pktsz);
1520 first_byte += user_pktsz + data_offset;
1521 current_position += user_pktsz;
1522 todo -= user_pktsz;
1523 }
1524 } else {
1525 /* No control byte required. */
1526 /* Copy in the data to send */
1527 memcpy (buffer, buf, count);
1528 }
1529
1530 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, transfer_size, buffer);
1531
1532 /* fill the buffer and send it */
David Brownell5c09d142006-10-13 15:57:58 -07001533 usb_fill_bulk_urb(urb, port->serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534 usb_sndbulkpipe(port->serial->dev, port->bulk_out_endpointAddress),
1535 buffer, transfer_size,
1536 ftdi_write_bulk_callback, port);
1537
1538 status = usb_submit_urb(urb, GFP_ATOMIC);
1539 if (status) {
1540 err("%s - failed submitting write urb, error %d", __FUNCTION__, status);
1541 count = status;
Oliver Neukum62127a52007-03-23 14:30:16 +01001542 goto error;
Ian Abbott22465402006-06-26 12:59:17 +01001543 } else {
1544 spin_lock_irqsave(&priv->tx_lock, flags);
Ian Abbott22465402006-06-26 12:59:17 +01001545 priv->tx_outstanding_bytes += count;
1546 priv->tx_bytes += count;
1547 spin_unlock_irqrestore(&priv->tx_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548 }
1549
1550 /* we are done with this urb, so let the host driver
1551 * really free it when it is finished with it */
Oliver Neukum62127a52007-03-23 14:30:16 +01001552 usb_free_urb(urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553
1554 dbg("%s write returning: %d", __FUNCTION__, count);
1555 return count;
Oliver Neukum62127a52007-03-23 14:30:16 +01001556error:
1557 usb_free_urb(urb);
1558error_no_urb:
1559 kfree (buffer);
1560error_no_buffer:
1561 spin_lock_irqsave(&priv->tx_lock, flags);
1562 priv->tx_outstanding_urbs--;
1563 spin_unlock_irqrestore(&priv->tx_lock, flags);
1564 return count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565} /* ftdi_write */
1566
1567
1568/* This function may get called when the device is closed */
1569
David Howells7d12e782006-10-05 14:55:46 +01001570static void ftdi_write_bulk_callback (struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571{
Ian Abbott22465402006-06-26 12:59:17 +01001572 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
Ian Abbott22465402006-06-26 12:59:17 +01001574 struct ftdi_private *priv;
1575 int data_offset; /* will be 1 for the SIO and 0 otherwise */
1576 unsigned long countback;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577
1578 /* free up the transfer buffer, as usb_free_urb() does not do this */
1579 kfree (urb->transfer_buffer);
1580
1581 dbg("%s - port %d", __FUNCTION__, port->number);
David Brownell5c09d142006-10-13 15:57:58 -07001582
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583 if (urb->status) {
1584 dbg("nonzero write bulk status received: %d", urb->status);
1585 return;
1586 }
1587
Ian Abbott22465402006-06-26 12:59:17 +01001588 priv = usb_get_serial_port_data(port);
1589 if (!priv) {
1590 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1591 return;
1592 }
1593 /* account for transferred data */
1594 countback = urb->actual_length;
1595 data_offset = priv->write_offset;
1596 if (data_offset > 0) {
1597 /* Subtract the control bytes */
1598 countback -= (data_offset * ((countback + (PKTSZ - 1)) / PKTSZ));
1599 }
1600 spin_lock_irqsave(&priv->tx_lock, flags);
1601 --priv->tx_outstanding_urbs;
1602 priv->tx_outstanding_bytes -= countback;
1603 spin_unlock_irqrestore(&priv->tx_lock, flags);
1604
Pete Zaitcevcf2c7482006-05-22 21:58:49 -07001605 usb_serial_port_softint(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606} /* ftdi_write_bulk_callback */
1607
1608
1609static int ftdi_write_room( struct usb_serial_port *port )
1610{
Ian Abbott22465402006-06-26 12:59:17 +01001611 struct ftdi_private *priv = usb_get_serial_port_data(port);
1612 int room;
1613 unsigned long flags;
1614
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615 dbg("%s - port %d", __FUNCTION__, port->number);
1616
Ian Abbott22465402006-06-26 12:59:17 +01001617 spin_lock_irqsave(&priv->tx_lock, flags);
1618 if (priv->tx_outstanding_urbs < URB_UPPER_LIMIT) {
1619 /*
1620 * We really can take anything the user throws at us
1621 * but let's pick a nice big number to tell the tty
1622 * layer that we have lots of free space
1623 */
1624 room = 2048;
1625 } else {
1626 room = 0;
1627 }
1628 spin_unlock_irqrestore(&priv->tx_lock, flags);
1629 return room;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630} /* ftdi_write_room */
1631
1632
1633static int ftdi_chars_in_buffer (struct usb_serial_port *port)
1634{ /* ftdi_chars_in_buffer */
Ian Abbott22465402006-06-26 12:59:17 +01001635 struct ftdi_private *priv = usb_get_serial_port_data(port);
1636 int buffered;
1637 unsigned long flags;
1638
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639 dbg("%s - port %d", __FUNCTION__, port->number);
1640
Ian Abbott22465402006-06-26 12:59:17 +01001641 spin_lock_irqsave(&priv->tx_lock, flags);
1642 buffered = (int)priv->tx_outstanding_bytes;
1643 spin_unlock_irqrestore(&priv->tx_lock, flags);
1644 if (buffered < 0) {
1645 err("%s outstanding tx bytes is negative!", __FUNCTION__);
1646 buffered = 0;
1647 }
1648 return buffered;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649} /* ftdi_chars_in_buffer */
1650
1651
1652
David Howells7d12e782006-10-05 14:55:46 +01001653static void ftdi_read_bulk_callback (struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654{ /* ftdi_read_bulk_callback */
1655 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1656 struct tty_struct *tty;
1657 struct ftdi_private *priv;
Ian Abbott22465402006-06-26 12:59:17 +01001658 unsigned long countread;
1659 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660
1661 if (urb->number_of_packets > 0) {
1662 err("%s transfer_buffer_length %d actual_length %d number of packets %d",__FUNCTION__,
1663 urb->transfer_buffer_length, urb->actual_length, urb->number_of_packets );
1664 err("%s transfer_flags %x ", __FUNCTION__,urb->transfer_flags );
1665 }
1666
1667 dbg("%s - port %d", __FUNCTION__, port->number);
1668
1669 if (port->open_count <= 0)
1670 return;
1671
1672 tty = port->tty;
1673 if (!tty) {
1674 dbg("%s - bad tty pointer - exiting",__FUNCTION__);
1675 return;
1676 }
1677
1678 priv = usb_get_serial_port_data(port);
1679 if (!priv) {
1680 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1681 return;
1682 }
1683
1684 if (urb != port->read_urb) {
1685 err("%s - Not my urb!", __FUNCTION__);
1686 }
1687
1688 if (urb->status) {
1689 /* This will happen at close every time so it is a dbg not an err */
1690 dbg("(this is ok on close) nonzero read bulk status received: %d", urb->status);
1691 return;
1692 }
1693
Ian Abbott22465402006-06-26 12:59:17 +01001694 /* count data bytes, but not status bytes */
1695 countread = urb->actual_length;
1696 countread -= 2 * ((countread + (PKTSZ - 1)) / PKTSZ);
1697 spin_lock_irqsave(&priv->rx_lock, flags);
1698 priv->rx_bytes += countread;
1699 spin_unlock_irqrestore(&priv->rx_lock, flags);
1700
David Howellsc4028952006-11-22 14:57:56 +00001701 ftdi_process_read(&priv->rx_work.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702
1703} /* ftdi_read_bulk_callback */
1704
1705
David Howellsc4028952006-11-22 14:57:56 +00001706static void ftdi_process_read (struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707{ /* ftdi_process_read */
David Howellsc4028952006-11-22 14:57:56 +00001708 struct ftdi_private *priv =
1709 container_of(work, struct ftdi_private, rx_work.work);
1710 struct usb_serial_port *port = priv->port;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001711 struct urb *urb;
1712 struct tty_struct *tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713 char error_flag;
David Brownell5c09d142006-10-13 15:57:58 -07001714 unsigned char *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001715
1716 int i;
1717 int result;
1718 int need_flip;
1719 int packet_offset;
Ian Abbott76854ce2005-06-02 10:34:11 +01001720 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001721
1722 dbg("%s - port %d", __FUNCTION__, port->number);
1723
1724 if (port->open_count <= 0)
1725 return;
1726
1727 tty = port->tty;
1728 if (!tty) {
1729 dbg("%s - bad tty pointer - exiting",__FUNCTION__);
1730 return;
1731 }
1732
1733 priv = usb_get_serial_port_data(port);
1734 if (!priv) {
1735 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1736 return;
1737 }
1738
1739 urb = port->read_urb;
1740 if (!urb) {
1741 dbg("%s - bad read_urb pointer - exiting", __FUNCTION__);
1742 return;
1743 }
1744
1745 data = urb->transfer_buffer;
1746
Ian Abbott76854ce2005-06-02 10:34:11 +01001747 if (priv->rx_processed) {
1748 dbg("%s - already processed: %d bytes, %d remain", __FUNCTION__,
1749 priv->rx_processed,
1750 urb->actual_length - priv->rx_processed);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751 } else {
Ian Abbott76854ce2005-06-02 10:34:11 +01001752 /* The first two bytes of every read packet are status */
1753 if (urb->actual_length > 2) {
1754 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
1755 } else {
1756 dbg("Status only: %03oo %03oo",data[0],data[1]);
1757 }
1758 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759
1760
1761 /* TO DO -- check for hung up line and handle appropriately: */
1762 /* send hangup */
1763 /* See acm.c - you do a tty_hangup - eg tty_hangup(tty) */
1764 /* if CD is dropped and the line is not CLOCAL then we should hangup */
1765
1766 need_flip = 0;
Ian Abbott76854ce2005-06-02 10:34:11 +01001767 for (packet_offset = priv->rx_processed; packet_offset < urb->actual_length; packet_offset += PKTSZ) {
1768 int length;
1769
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770 /* Compare new line status to the old one, signal if different */
Ian Abbott76854ce2005-06-02 10:34:11 +01001771 /* N.B. packet may be processed more than once, but differences
1772 * are only processed once. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773 if (priv != NULL) {
1774 char new_status = data[packet_offset+0] & FTDI_STATUS_B0_MASK;
1775 if (new_status != priv->prev_status) {
1776 priv->diff_status |= new_status ^ priv->prev_status;
1777 wake_up_interruptible(&priv->delta_msr_wait);
1778 priv->prev_status = new_status;
1779 }
1780 }
1781
Ian Abbott76854ce2005-06-02 10:34:11 +01001782 length = min(PKTSZ, urb->actual_length-packet_offset)-2;
1783 if (length < 0) {
1784 err("%s - bad packet length: %d", __FUNCTION__, length+2);
1785 length = 0;
1786 }
1787
Ian Abbott76854ce2005-06-02 10:34:11 +01001788 if (priv->rx_flags & THROTTLED) {
1789 dbg("%s - throttled", __FUNCTION__);
1790 break;
1791 }
Alan Cox33f0f882006-01-09 20:54:13 -08001792 if (tty_buffer_request_room(tty, length) < length) {
Ian Abbott76854ce2005-06-02 10:34:11 +01001793 /* break out & wait for throttling/unthrottling to happen */
1794 dbg("%s - receive room low", __FUNCTION__);
1795 break;
1796 }
1797
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798 /* Handle errors and break */
1799 error_flag = TTY_NORMAL;
1800 /* Although the device uses a bitmask and hence can have multiple */
1801 /* errors on a packet - the order here sets the priority the */
1802 /* error is returned to the tty layer */
1803
1804 if ( data[packet_offset+1] & FTDI_RS_OE ) {
1805 error_flag = TTY_OVERRUN;
1806 dbg("OVERRRUN error");
1807 }
1808 if ( data[packet_offset+1] & FTDI_RS_BI ) {
1809 error_flag = TTY_BREAK;
1810 dbg("BREAK received");
1811 }
1812 if ( data[packet_offset+1] & FTDI_RS_PE ) {
1813 error_flag = TTY_PARITY;
1814 dbg("PARITY error");
1815 }
1816 if ( data[packet_offset+1] & FTDI_RS_FE ) {
1817 error_flag = TTY_FRAME;
1818 dbg("FRAMING error");
1819 }
Ian Abbott76854ce2005-06-02 10:34:11 +01001820 if (length > 0) {
1821 for (i = 2; i < length+2; i++) {
David Brownell5c09d142006-10-13 15:57:58 -07001822 /* Note that the error flag is duplicated for
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823 every character received since we don't know
1824 which character it applied to */
1825 tty_insert_flip_char(tty, data[packet_offset+i], error_flag);
1826 }
1827 need_flip = 1;
1828 }
1829
1830#ifdef NOT_CORRECT_BUT_KEEPING_IT_FOR_NOW
1831 /* if a parity error is detected you get status packets forever
1832 until a character is sent without a parity error.
1833 This doesn't work well since the application receives a never
1834 ending stream of bad data - even though new data hasn't been sent.
1835 Therefore I (bill) have taken this out.
David Brownell5c09d142006-10-13 15:57:58 -07001836 However - this might make sense for framing errors and so on
Linus Torvalds1da177e2005-04-16 15:20:36 -07001837 so I am leaving the code in for now.
1838 */
1839 else {
1840 if (error_flag != TTY_NORMAL){
1841 dbg("error_flag is not normal");
1842 /* In this case it is just status - if that is an error send a bad character */
1843 if(tty->flip.count >= TTY_FLIPBUF_SIZE) {
1844 tty_flip_buffer_push(tty);
1845 }
1846 tty_insert_flip_char(tty, 0xff, error_flag);
1847 need_flip = 1;
1848 }
1849 }
1850#endif
1851 } /* "for(packet_offset=0..." */
1852
1853 /* Low latency */
1854 if (need_flip) {
1855 tty_flip_buffer_push(tty);
1856 }
1857
Ian Abbott76854ce2005-06-02 10:34:11 +01001858 if (packet_offset < urb->actual_length) {
1859 /* not completely processed - record progress */
1860 priv->rx_processed = packet_offset;
1861 dbg("%s - incomplete, %d bytes processed, %d remain",
1862 __FUNCTION__, packet_offset,
1863 urb->actual_length - packet_offset);
1864 /* check if we were throttled while processing */
1865 spin_lock_irqsave(&priv->rx_lock, flags);
1866 if (priv->rx_flags & THROTTLED) {
1867 priv->rx_flags |= ACTUALLY_THROTTLED;
1868 spin_unlock_irqrestore(&priv->rx_lock, flags);
1869 dbg("%s - deferring remainder until unthrottled",
1870 __FUNCTION__);
1871 return;
1872 }
1873 spin_unlock_irqrestore(&priv->rx_lock, flags);
1874 /* if the port is closed stop trying to read */
1875 if (port->open_count > 0){
1876 /* delay processing of remainder */
1877 schedule_delayed_work(&priv->rx_work, 1);
1878 } else {
1879 dbg("%s - port is closed", __FUNCTION__);
1880 }
1881 return;
1882 }
1883
1884 /* urb is completely processed */
1885 priv->rx_processed = 0;
1886
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887 /* if the port is closed stop trying to read */
1888 if (port->open_count > 0){
1889 /* Continue trying to always read */
David Brownell5c09d142006-10-13 15:57:58 -07001890 usb_fill_bulk_urb(port->read_urb, port->serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891 usb_rcvbulkpipe(port->serial->dev, port->bulk_in_endpointAddress),
1892 port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
1893 ftdi_read_bulk_callback, port);
1894
1895 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1896 if (result)
1897 err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
1898 }
1899
1900 return;
1901} /* ftdi_process_read */
1902
1903
1904static void ftdi_break_ctl( struct usb_serial_port *port, int break_state )
1905{
1906 struct ftdi_private *priv = usb_get_serial_port_data(port);
David Brownell5c09d142006-10-13 15:57:58 -07001907 __u16 urb_value = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908 char buf[1];
David Brownell5c09d142006-10-13 15:57:58 -07001909
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910 /* break_state = -1 to turn on break, and 0 to turn off break */
1911 /* see drivers/char/tty_io.c to see it used */
1912 /* last_set_data_urb_value NEVER has the break bit set in it */
1913
1914 if (break_state) {
1915 urb_value = priv->last_set_data_urb_value | FTDI_SIO_SET_BREAK;
1916 } else {
David Brownell5c09d142006-10-13 15:57:58 -07001917 urb_value = priv->last_set_data_urb_value;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918 }
1919
David Brownell5c09d142006-10-13 15:57:58 -07001920
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921 if (usb_control_msg(port->serial->dev, usb_sndctrlpipe(port->serial->dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07001922 FTDI_SIO_SET_DATA_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923 FTDI_SIO_SET_DATA_REQUEST_TYPE,
1924 urb_value , priv->interface,
1925 buf, 0, WDR_TIMEOUT) < 0) {
1926 err("%s FAILED to enable/disable break state (state was %d)", __FUNCTION__,break_state);
David Brownell5c09d142006-10-13 15:57:58 -07001927 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928
1929 dbg("%s break state is %d - urb is %d", __FUNCTION__,break_state, urb_value);
David Brownell5c09d142006-10-13 15:57:58 -07001930
Linus Torvalds1da177e2005-04-16 15:20:36 -07001931}
1932
1933
1934/* old_termios contains the original termios settings and tty->termios contains
1935 * the new setting to be used
1936 * WARNING: set_termios calls this with old_termios in kernel space
1937 */
1938
Alan Cox606d0992006-12-08 02:38:45 -08001939static void ftdi_set_termios (struct usb_serial_port *port, struct ktermios *old_termios)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940{ /* ftdi_termios */
1941 struct usb_device *dev = port->serial->dev;
1942 unsigned int cflag = port->tty->termios->c_cflag;
1943 struct ftdi_private *priv = usb_get_serial_port_data(port);
1944 __u16 urb_value; /* will hold the new flags */
1945 char buf[1]; /* Perhaps I should dynamically alloc this? */
David Brownell5c09d142006-10-13 15:57:58 -07001946
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947 // Added for xon/xoff support
1948 unsigned int iflag = port->tty->termios->c_iflag;
1949 unsigned char vstop;
1950 unsigned char vstart;
David Brownell5c09d142006-10-13 15:57:58 -07001951
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 dbg("%s", __FUNCTION__);
1953
1954 /* Force baud rate if this device requires it, unless it is set to B0. */
1955 if (priv->force_baud && ((port->tty->termios->c_cflag & CBAUD) != B0)) {
1956 dbg("%s: forcing baud rate for this device", __FUNCTION__);
1957 port->tty->termios->c_cflag &= ~CBAUD;
1958 port->tty->termios->c_cflag |= priv->force_baud;
1959 }
1960
1961 /* Force RTS-CTS if this device requires it. */
1962 if (priv->force_rtscts) {
1963 dbg("%s: forcing rtscts for this device", __FUNCTION__);
1964 port->tty->termios->c_cflag |= CRTSCTS;
1965 }
1966
1967 cflag = port->tty->termios->c_cflag;
1968
David Brownell5c09d142006-10-13 15:57:58 -07001969 /* FIXME -For this cut I don't care if the line is really changing or
1970 not - so just do the change regardless - should be able to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971 compare old_termios and tty->termios */
David Brownell5c09d142006-10-13 15:57:58 -07001972 /* NOTE These routines can get interrupted by
1973 ftdi_sio_read_bulk_callback - need to examine what this
Linus Torvalds1da177e2005-04-16 15:20:36 -07001974 means - don't see any problems yet */
David Brownell5c09d142006-10-13 15:57:58 -07001975
Linus Torvalds1da177e2005-04-16 15:20:36 -07001976 /* Set number of data bits, parity, stop bits */
David Brownell5c09d142006-10-13 15:57:58 -07001977
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978 urb_value = 0;
1979 urb_value |= (cflag & CSTOPB ? FTDI_SIO_SET_DATA_STOP_BITS_2 :
1980 FTDI_SIO_SET_DATA_STOP_BITS_1);
David Brownell5c09d142006-10-13 15:57:58 -07001981 urb_value |= (cflag & PARENB ?
1982 (cflag & PARODD ? FTDI_SIO_SET_DATA_PARITY_ODD :
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983 FTDI_SIO_SET_DATA_PARITY_EVEN) :
1984 FTDI_SIO_SET_DATA_PARITY_NONE);
1985 if (cflag & CSIZE) {
1986 switch (cflag & CSIZE) {
1987 case CS5: urb_value |= 5; dbg("Setting CS5"); break;
1988 case CS6: urb_value |= 6; dbg("Setting CS6"); break;
1989 case CS7: urb_value |= 7; dbg("Setting CS7"); break;
1990 case CS8: urb_value |= 8; dbg("Setting CS8"); break;
1991 default:
1992 err("CSIZE was set but not CS5-CS8");
1993 }
1994 }
1995
1996 /* This is needed by the break command since it uses the same command - but is
1997 * or'ed with this value */
1998 priv->last_set_data_urb_value = urb_value;
David Brownell5c09d142006-10-13 15:57:58 -07001999
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002001 FTDI_SIO_SET_DATA_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002002 FTDI_SIO_SET_DATA_REQUEST_TYPE,
2003 urb_value , priv->interface,
Ian Abbott279e1542005-07-29 12:16:52 -07002004 buf, 0, WDR_SHORT_TIMEOUT) < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005 err("%s FAILED to set databits/stopbits/parity", __FUNCTION__);
David Brownell5c09d142006-10-13 15:57:58 -07002006 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002007
2008 /* Now do the baudrate */
2009 if ((cflag & CBAUD) == B0 ) {
2010 /* Disable flow control */
2011 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002012 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002013 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07002014 0, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015 buf, 0, WDR_TIMEOUT) < 0) {
2016 err("%s error from disable flowcontrol urb", __FUNCTION__);
David Brownell5c09d142006-10-13 15:57:58 -07002017 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018 /* Drop RTS and DTR */
Ian Abbott74ede0f2005-07-29 12:16:41 -07002019 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002020 } else {
2021 /* set the baudrate determined before */
2022 if (change_speed(port)) {
Peter Favrholdt72a755f2005-09-22 00:48:49 -07002023 err("%s urb failed to set baudrate", __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024 }
Peter Favrholdt72a755f2005-09-22 00:48:49 -07002025 /* Ensure RTS and DTR are raised when baudrate changed from 0 */
Guennadi Liakhovetski57845bd2006-04-13 22:27:12 +02002026 if (!old_termios || (old_termios->c_cflag & CBAUD) == B0) {
Peter Favrholdt72a755f2005-09-22 00:48:49 -07002027 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2028 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029 }
2030
2031 /* Set flow control */
2032 /* Note device also supports DTR/CD (ugh) and Xon/Xoff in hardware */
2033 if (cflag & CRTSCTS) {
2034 dbg("%s Setting to CRTSCTS flow control", __FUNCTION__);
David Brownell5c09d142006-10-13 15:57:58 -07002035 if (usb_control_msg(dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002036 usb_sndctrlpipe(dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002037 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2039 0 , (FTDI_SIO_RTS_CTS_HS | priv->interface),
2040 buf, 0, WDR_TIMEOUT) < 0) {
2041 err("urb failed to set to rts/cts flow control");
David Brownell5c09d142006-10-13 15:57:58 -07002042 }
2043
2044 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045 /*
2046 * Xon/Xoff code
2047 *
2048 * Check the IXOFF status in the iflag component of the termios structure
2049 * if IXOFF is not set, the pre-xon/xoff code is executed.
2050 */
2051 if (iflag & IXOFF) {
2052 dbg("%s request to enable xonxoff iflag=%04x",__FUNCTION__,iflag);
2053 // Try to enable the XON/XOFF on the ftdi_sio
2054 // Set the vstart and vstop -- could have been done up above where
2055 // a lot of other dereferencing is done but that would be very
2056 // inefficient as vstart and vstop are not always needed
2057 vstart=port->tty->termios->c_cc[VSTART];
2058 vstop=port->tty->termios->c_cc[VSTOP];
2059 urb_value=(vstop << 8) | (vstart);
2060
2061 if (usb_control_msg(dev,
2062 usb_sndctrlpipe(dev, 0),
2063 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2064 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2065 urb_value , (FTDI_SIO_XON_XOFF_HS
2066 | priv->interface),
2067 buf, 0, WDR_TIMEOUT) < 0) {
2068 err("urb failed to set to xon/xoff flow control");
2069 }
2070 } else {
2071 /* else clause to only run if cfag ! CRTSCTS and iflag ! XOFF */
2072 /* CHECKME Assuming XON/XOFF handled by tty stack - not by device */
2073 dbg("%s Turning off hardware flow control", __FUNCTION__);
David Brownell5c09d142006-10-13 15:57:58 -07002074 if (usb_control_msg(dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075 usb_sndctrlpipe(dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002076 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07002078 0, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079 buf, 0, WDR_TIMEOUT) < 0) {
2080 err("urb failed to clear flow control");
David Brownell5c09d142006-10-13 15:57:58 -07002081 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082 }
David Brownell5c09d142006-10-13 15:57:58 -07002083
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084 }
2085 return;
2086} /* ftdi_termios */
2087
2088
2089static int ftdi_tiocmget (struct usb_serial_port *port, struct file *file)
2090{
2091 struct ftdi_private *priv = usb_get_serial_port_data(port);
2092 unsigned char buf[2];
2093 int ret;
2094
2095 dbg("%s TIOCMGET", __FUNCTION__);
2096 switch (priv->chip_type) {
2097 case SIO:
2098 /* Request the status from the device */
David Brownell5c09d142006-10-13 15:57:58 -07002099 if ((ret = usb_control_msg(port->serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100 usb_rcvctrlpipe(port->serial->dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002101 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07002103 0, 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104 buf, 1, WDR_TIMEOUT)) < 0 ) {
2105 err("%s Could not get modem status of device - err: %d", __FUNCTION__,
2106 ret);
2107 return(ret);
2108 }
2109 break;
2110 case FT8U232AM:
2111 case FT232BM:
2112 case FT2232C:
2113 /* the 8U232AM returns a two byte value (the sio is a 1 byte value) - in the same
2114 format as the data returned from the in point */
David Brownell5c09d142006-10-13 15:57:58 -07002115 if ((ret = usb_control_msg(port->serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116 usb_rcvctrlpipe(port->serial->dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002117 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002118 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07002119 0, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120 buf, 2, WDR_TIMEOUT)) < 0 ) {
2121 err("%s Could not get modem status of device - err: %d", __FUNCTION__,
2122 ret);
2123 return(ret);
2124 }
2125 break;
2126 default:
2127 return -EFAULT;
2128 break;
2129 }
David Brownell5c09d142006-10-13 15:57:58 -07002130
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131 return (buf[0] & FTDI_SIO_DSR_MASK ? TIOCM_DSR : 0) |
2132 (buf[0] & FTDI_SIO_CTS_MASK ? TIOCM_CTS : 0) |
2133 (buf[0] & FTDI_SIO_RI_MASK ? TIOCM_RI : 0) |
2134 (buf[0] & FTDI_SIO_RLSD_MASK ? TIOCM_CD : 0) |
David Brownell5c09d142006-10-13 15:57:58 -07002135 priv->last_dtr_rts;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136}
2137
2138static int ftdi_tiocmset(struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear)
2139{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002140 dbg("%s TIOCMSET", __FUNCTION__);
Ian Abbott74ede0f2005-07-29 12:16:41 -07002141 return update_mctrl(port, set, clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142}
2143
2144
2145static int ftdi_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
2146{
2147 struct ftdi_private *priv = usb_get_serial_port_data(port);
2148
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149 dbg("%s cmd 0x%04x", __FUNCTION__, cmd);
2150
2151 /* Based on code from acm.c and others */
2152 switch (cmd) {
2153
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 case TIOCGSERIAL: /* gets serial port data */
2155 return get_serial_info(port, (struct serial_struct __user *) arg);
2156
2157 case TIOCSSERIAL: /* sets serial port data */
2158 return set_serial_info(port, (struct serial_struct __user *) arg);
2159
2160 /*
2161 * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
2162 * - mask passed in arg for lines of interest
2163 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
2164 * Caller should use TIOCGICOUNT to see which one it was.
2165 *
2166 * This code is borrowed from linux/drivers/char/serial.c
2167 */
2168 case TIOCMIWAIT:
2169 while (priv != NULL) {
2170 interruptible_sleep_on(&priv->delta_msr_wait);
2171 /* see if a signal did it */
2172 if (signal_pending(current))
2173 return -ERESTARTSYS;
2174 else {
2175 char diff = priv->diff_status;
2176
2177 if (diff == 0) {
2178 return -EIO; /* no change => error */
2179 }
2180
2181 /* Consume all events */
2182 priv->diff_status = 0;
2183
2184 /* Return 0 if caller wanted to know about these bits */
2185 if ( ((arg & TIOCM_RNG) && (diff & FTDI_RS0_RI)) ||
2186 ((arg & TIOCM_DSR) && (diff & FTDI_RS0_DSR)) ||
2187 ((arg & TIOCM_CD) && (diff & FTDI_RS0_RLSD)) ||
2188 ((arg & TIOCM_CTS) && (diff & FTDI_RS0_CTS)) ) {
2189 return 0;
2190 }
2191 /*
2192 * Otherwise caller can't care less about what happened,
2193 * and so we continue to wait for more events.
2194 */
2195 }
2196 }
2197 return(0);
2198 break;
2199 default:
2200 break;
David Brownell5c09d142006-10-13 15:57:58 -07002201
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202 }
2203
2204
David Brownell5c09d142006-10-13 15:57:58 -07002205 /* This is not necessarily an error - turns out the higher layers will do
Linus Torvalds1da177e2005-04-16 15:20:36 -07002206 * some ioctls itself (see comment above)
2207 */
2208 dbg("%s arg not supported - it was 0x%04x - check /usr/include/asm/ioctls.h", __FUNCTION__, cmd);
2209
2210 return(-ENOIOCTLCMD);
2211} /* ftdi_ioctl */
2212
2213
2214static void ftdi_throttle (struct usb_serial_port *port)
2215{
2216 struct ftdi_private *priv = usb_get_serial_port_data(port);
2217 unsigned long flags;
2218
2219 dbg("%s - port %d", __FUNCTION__, port->number);
2220
2221 spin_lock_irqsave(&priv->rx_lock, flags);
2222 priv->rx_flags |= THROTTLED;
2223 spin_unlock_irqrestore(&priv->rx_lock, flags);
2224}
2225
2226
2227static void ftdi_unthrottle (struct usb_serial_port *port)
2228{
2229 struct ftdi_private *priv = usb_get_serial_port_data(port);
2230 int actually_throttled;
2231 unsigned long flags;
2232
2233 dbg("%s - port %d", __FUNCTION__, port->number);
2234
2235 spin_lock_irqsave(&priv->rx_lock, flags);
2236 actually_throttled = priv->rx_flags & ACTUALLY_THROTTLED;
2237 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
2238 spin_unlock_irqrestore(&priv->rx_lock, flags);
2239
2240 if (actually_throttled)
David Howellsc4028952006-11-22 14:57:56 +00002241 schedule_delayed_work(&priv->rx_work, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242}
2243
2244static int __init ftdi_init (void)
2245{
2246 int retval;
2247
2248 dbg("%s", __FUNCTION__);
Ian Abbottfdcb0a02005-07-28 18:40:32 +01002249 if (vendor > 0 && product > 0) {
2250 /* Add user specified VID/PID to reserved element of table. */
2251 int i;
2252 for (i = 0; id_table_combined[i].idVendor; i++)
2253 ;
2254 id_table_combined[i].match_flags = USB_DEVICE_ID_MATCH_DEVICE;
2255 id_table_combined[i].idVendor = vendor;
2256 id_table_combined[i].idProduct = product;
2257 }
Ian Abbott8f977e42005-06-20 16:45:42 +01002258 retval = usb_serial_register(&ftdi_sio_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002259 if (retval)
Ian Abbott8f977e42005-06-20 16:45:42 +01002260 goto failed_sio_register;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261 retval = usb_register(&ftdi_driver);
David Brownell5c09d142006-10-13 15:57:58 -07002262 if (retval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263 goto failed_usb_register;
2264
2265 info(DRIVER_VERSION ":" DRIVER_DESC);
2266 return 0;
2267failed_usb_register:
Ian Abbott8f977e42005-06-20 16:45:42 +01002268 usb_serial_deregister(&ftdi_sio_device);
2269failed_sio_register:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002270 return retval;
2271}
2272
2273
2274static void __exit ftdi_exit (void)
2275{
2276
2277 dbg("%s", __FUNCTION__);
2278
2279 usb_deregister (&ftdi_driver);
Ian Abbott8f977e42005-06-20 16:45:42 +01002280 usb_serial_deregister (&ftdi_sio_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002281
2282}
2283
2284
2285module_init(ftdi_init);
2286module_exit(ftdi_exit);
2287
2288MODULE_AUTHOR( DRIVER_AUTHOR );
2289MODULE_DESCRIPTION( DRIVER_DESC );
2290MODULE_LICENSE("GPL");
2291
2292module_param(debug, bool, S_IRUGO | S_IWUSR);
2293MODULE_PARM_DESC(debug, "Debug enabled or not");
Ian Abbottfdcb0a02005-07-28 18:40:32 +01002294module_param(vendor, ushort, 0);
2295MODULE_PARM_DESC(vendor, "User specified vendor ID (default="
2296 __MODULE_STRING(FTDI_VID)")");
2297module_param(product, ushort, 0);
2298MODULE_PARM_DESC(vendor, "User specified product ID");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299