blob: 2353679f601ebbc618b1d4647f792cf410dc2d23 [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) },
Frank Sievertsenfad14a02006-10-20 09:43:53 +0200320 { USB_DEVICE(FTDI_VID, FTDI_DMX4ALL) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 { USB_DEVICE(FTDI_VID, FTDI_SIO_PID) },
322 { USB_DEVICE(FTDI_VID, FTDI_8U232AM_PID) },
323 { USB_DEVICE(FTDI_VID, FTDI_8U232AM_ALT_PID) },
Gard Spreemannd8b21602007-03-05 00:03:26 +0100324 { USB_DEVICE(FTDI_VID, FTDI_232RL_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 { USB_DEVICE(FTDI_VID, FTDI_8U2232C_PID) },
Christophe Mariacc0f8d562006-06-23 17:36:21 +0200326 { USB_DEVICE(FTDI_VID, FTDI_MICRO_CHAMELEON_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 { USB_DEVICE(FTDI_VID, FTDI_RELAIS_PID) },
Guido Scholz2adb80e2007-05-08 19:52:41 +0200328 { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_IOBOARD_PID) },
330 { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_MINI_IOBOARD_PID) },
331 { USB_DEVICE(FTDI_VID, FTDI_XF_632_PID) },
332 { USB_DEVICE(FTDI_VID, FTDI_XF_634_PID) },
333 { USB_DEVICE(FTDI_VID, FTDI_XF_547_PID) },
334 { USB_DEVICE(FTDI_VID, FTDI_XF_633_PID) },
335 { USB_DEVICE(FTDI_VID, FTDI_XF_631_PID) },
336 { USB_DEVICE(FTDI_VID, FTDI_XF_635_PID) },
337 { USB_DEVICE(FTDI_VID, FTDI_XF_640_PID) },
338 { USB_DEVICE(FTDI_VID, FTDI_XF_642_PID) },
339 { USB_DEVICE(FTDI_VID, FTDI_DSS20_PID) },
340 { USB_DEVICE(FTDI_NF_RIC_VID, FTDI_NF_RIC_PID) },
341 { USB_DEVICE(FTDI_VID, FTDI_VNHCPCUSB_D_PID) },
Ian Abbott8f977e42005-06-20 16:45:42 +0100342 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_0_PID) },
343 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_1_PID) },
344 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_2_PID) },
345 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_3_PID) },
346 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_4_PID) },
347 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_5_PID) },
348 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_6_PID) },
349 { USB_DEVICE(FTDI_VID, FTDI_PERLE_ULTRAPORT_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 { USB_DEVICE(FTDI_VID, FTDI_PIEGROUP_PID) },
Dave Platt274a4bb2006-07-18 21:26:54 -0700351 { USB_DEVICE(FTDI_VID, FTDI_TNC_X_PID) },
Jelle Foks868e4402007-03-25 21:08:35 -0400352 { USB_DEVICE(FTDI_VID, FTDI_USBX_707_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2101_PID) },
354 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2102_PID) },
355 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2103_PID) },
356 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2104_PID) },
Justin Carlsona1484822006-09-24 11:52:12 +0300357 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2106_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_1_PID) },
359 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_2_PID) },
360 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_1_PID) },
361 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_2_PID) },
362 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_1_PID) },
363 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_2_PID) },
364 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_1_PID) },
365 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_2_PID) },
366 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_3_PID) },
367 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_4_PID) },
368 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_1_PID) },
369 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_2_PID) },
370 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_3_PID) },
371 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_4_PID) },
372 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_1_PID) },
373 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_2_PID) },
374 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_3_PID) },
375 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_4_PID) },
376 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_1_PID) },
377 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_2_PID) },
378 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_3_PID) },
379 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_4_PID) },
380 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_5_PID) },
381 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_6_PID) },
382 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_7_PID) },
383 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_8_PID) },
384 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_1_PID) },
385 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_2_PID) },
386 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_3_PID) },
387 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_4_PID) },
388 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_5_PID) },
389 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_6_PID) },
390 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_7_PID) },
391 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_8_PID) },
392 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_1_PID) },
393 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_2_PID) },
394 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_3_PID) },
395 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_4_PID) },
396 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_5_PID) },
397 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_6_PID) },
398 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_7_PID) },
399 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_8_PID) },
400 { USB_DEVICE(IDTECH_VID, IDTECH_IDT1221U_PID) },
401 { USB_DEVICE(OCT_VID, OCT_US101_PID) },
Ian Abbott8f977e42005-06-20 16:45:42 +0100402 { USB_DEVICE(FTDI_VID, FTDI_HE_TIRA1_PID),
403 .driver_info = (kernel_ulong_t)&ftdi_HE_TIRA1_quirk },
404 { USB_DEVICE(FTDI_VID, FTDI_USB_UIRT_PID),
405 .driver_info = (kernel_ulong_t)&ftdi_USB_UIRT_quirk },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_1) },
407 { USB_DEVICE(FTDI_VID, PROTEGO_R2X0) },
408 { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_3) },
409 { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_4) },
Ian Abbott8f977e42005-06-20 16:45:42 +0100410 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E808_PID) },
411 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E809_PID) },
412 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80A_PID) },
413 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80B_PID) },
414 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80C_PID) },
415 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80D_PID) },
416 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80E_PID) },
417 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80F_PID) },
418 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E888_PID) },
419 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E889_PID) },
420 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88A_PID) },
421 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88B_PID) },
422 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88C_PID) },
423 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88D_PID) },
424 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88E_PID) },
425 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88F_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 { USB_DEVICE(FTDI_VID, FTDI_ELV_UO100_PID) },
Ian Abbott47900742005-05-17 15:12:13 +0100427 { USB_DEVICE(FTDI_VID, FTDI_ELV_UM100_PID) },
Ian Abbotte6ac4a42005-08-02 14:01:27 +0100428 { USB_DEVICE(FTDI_VID, FTDI_ELV_UR100_PID) },
429 { USB_DEVICE(FTDI_VID, FTDI_ELV_ALC8500_PID) },
Thomas Riewe207c47e2005-09-29 14:57:29 +0200430 { USB_DEVICE(FTDI_VID, FTDI_PYRAMID_PID) },
Martin Hagelinbde62182005-10-26 21:10:41 +0200431 { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1000PC_PID) },
Thomas Schleusener4eaf60e2007-02-28 22:50:52 +0100432 { USB_DEVICE(FTDI_VID, FTDI_IBS_US485_PID) },
433 { USB_DEVICE(FTDI_VID, FTDI_IBS_PICPRO_PID) },
434 { USB_DEVICE(FTDI_VID, FTDI_IBS_PCMCIA_PID) },
435 { USB_DEVICE(FTDI_VID, FTDI_IBS_PK1_PID) },
436 { USB_DEVICE(FTDI_VID, FTDI_IBS_RS232MON_PID) },
437 { USB_DEVICE(FTDI_VID, FTDI_IBS_APP70_PID) },
438 { USB_DEVICE(FTDI_VID, FTDI_IBS_PEDO_PID) },
439 { USB_DEVICE(FTDI_VID, FTDI_IBS_PROD_PID) },
Ian Abbotte6ac4a42005-08-02 14:01:27 +0100440 /*
441 * These will probably use user-space drivers. Uncomment them if
442 * you need them or use the user-specified vendor/product module
443 * parameters (see ftdi_sio.h for the numbers). Make a fuss if
444 * you think the driver should recognize any of them by default.
445 */
446 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_CLI7000_PID) }, */
447 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_PPS7330_PID) }, */
448 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_TFM100_PID) }, */
449 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UDF77_PID) }, */
450 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UIO88_PID) }, */
451 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UAD8_PID) }, */
452 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UDA7_PID) }, */
453 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_USI2_PID) }, */
454 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_T1100_PID) }, */
455 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_PCD200_PID) }, */
456 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_ULA200_PID) }, */
Ian Abbotte6ac4a42005-08-02 14:01:27 +0100457 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_CSI8_PID) }, */
458 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_EM1000DL_PID) }, */
459 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_PCK100_PID) }, */
460 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_RFP500_PID) }, */
461 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_FS20SIG_PID) }, */
462 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_WS300PC_PID) }, */
463 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1300PC_PID) }, */
464 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_WS500_PID) }, */
David Brownell5c09d142006-10-13 15:57:58 -0700465 { USB_DEVICE(FTDI_VID, LINX_SDMUSBQSS_PID) },
466 { USB_DEVICE(FTDI_VID, LINX_MASTERDEVEL2_PID) },
467 { USB_DEVICE(FTDI_VID, LINX_FUTURE_0_PID) },
468 { USB_DEVICE(FTDI_VID, LINX_FUTURE_1_PID) },
469 { USB_DEVICE(FTDI_VID, LINX_FUTURE_2_PID) },
470 { USB_DEVICE(FTDI_VID, FTDI_CCSICDU20_0_PID) },
471 { USB_DEVICE(FTDI_VID, FTDI_CCSICDU40_1_PID) },
Jan Capekec434e92006-11-28 22:35:12 +0100472 { USB_DEVICE(FTDI_VID, FTDI_CCSMACHX_2_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 { USB_DEVICE(FTDI_VID, INSIDE_ACCESSO) },
474 { USB_DEVICE(INTREPID_VID, INTREPID_VALUECAN_PID) },
475 { USB_DEVICE(INTREPID_VID, INTREPID_NEOVI_PID) },
476 { USB_DEVICE(FALCOM_VID, FALCOM_TWIST_PID) },
Ian Abbotte6ac4a42005-08-02 14:01:27 +0100477 { USB_DEVICE(FALCOM_VID, FALCOM_SAMBA_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 { USB_DEVICE(FTDI_VID, FTDI_SUUNTO_SPORTS_PID) },
Michael Olbergef31fec2007-02-27 12:57:12 +0100479 { USB_DEVICE(TTI_VID, TTI_QL355P_PID) },
Ian Abbott6f928722005-04-29 16:06:14 +0100480 { USB_DEVICE(FTDI_VID, FTDI_RM_CANVIEW_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 { USB_DEVICE(BANDB_VID, BANDB_USOTL4_PID) },
482 { USB_DEVICE(BANDB_VID, BANDB_USTL4_PID) },
483 { USB_DEVICE(BANDB_VID, BANDB_USO9ML2_PID) },
484 { USB_DEVICE(FTDI_VID, EVER_ECO_PRO_CDS) },
Ian Abbott6f928722005-04-29 16:06:14 +0100485 { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_1_PID) },
486 { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_2_PID) },
Ian Abbotte6ac4a42005-08-02 14:01:27 +0100487 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_0_PID) },
488 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_1_PID) },
489 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_2_PID) },
490 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_3_PID) },
491 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_4_PID) },
492 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_5_PID) },
493 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_6_PID) },
494 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_7_PID) },
Ian Abbott6f928722005-04-29 16:06:14 +0100495 { USB_DEVICE(MOBILITY_VID, MOBILITY_USB_SERIAL_PID) },
Ian Abbott8f977e42005-06-20 16:45:42 +0100496 { USB_DEVICE(FTDI_VID, FTDI_ACTIVE_ROBOTS_PID) },
Ian Abbott34d1a8a2006-02-27 14:05:32 +0000497 { USB_DEVICE(FTDI_VID, FTDI_MHAM_KW_PID) },
498 { USB_DEVICE(FTDI_VID, FTDI_MHAM_YS_PID) },
Ian Abbott9b1513d2005-07-29 12:16:31 -0700499 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y6_PID) },
500 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y8_PID) },
Ian Abbott34d1a8a2006-02-27 14:05:32 +0000501 { USB_DEVICE(FTDI_VID, FTDI_MHAM_IC_PID) },
502 { USB_DEVICE(FTDI_VID, FTDI_MHAM_DB9_PID) },
503 { USB_DEVICE(FTDI_VID, FTDI_MHAM_RS232_PID) },
504 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y9_PID) },
Ian Abbott740a4282005-12-13 16:18:47 +0000505 { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_VCP_PID) },
506 { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_D2XX_PID) },
Ian Abbott9b1513d2005-07-29 12:16:31 -0700507 { USB_DEVICE(EVOLUTION_VID, EVOLUTION_ER1_PID) },
Rui Santosc9c77462005-09-23 20:06:50 +0100508 { USB_DEVICE(FTDI_VID, FTDI_ARTEMIS_PID) },
509 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16_PID) },
Rui Santos09c280a2006-01-09 13:12:40 +0000510 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16C_PID) },
Rui Santosc9c77462005-09-23 20:06:50 +0100511 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HR_PID) },
Rui Santos09c280a2006-01-09 13:12:40 +0000512 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HRC_PID) },
Ian Abbottb4723ae2005-11-23 15:45:23 -0800513 { USB_DEVICE(KOBIL_VID, KOBIL_CONV_B1_PID) },
514 { USB_DEVICE(KOBIL_VID, KOBIL_CONV_KAAN_PID) },
Pavel Fedineffac8b2005-12-09 09:30:59 +0300515 { USB_DEVICE(POSIFLEX_VID, POSIFLEX_PP7000_PID) },
Louis Nyffenegger641adaa2006-01-05 17:20:37 +0100516 { USB_DEVICE(FTDI_VID, FTDI_TTUSB_PID) },
Ian Abbott7e1c0b82006-03-21 14:55:20 +0000517 { USB_DEVICE(FTDI_VID, FTDI_ECLO_COM_1WIRE_PID) },
Ian Abbotta94b52a2006-01-09 17:11:40 +0000518 { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_777_PID) },
519 { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_8900F_PID) },
Wouter Paesence40d292006-01-03 14:30:31 +0100520 { USB_DEVICE(FTDI_VID, FTDI_PCDJ_DAC2_PID) },
Nathan Bronsoncdd3b152006-04-10 00:05:09 -0400521 { USB_DEVICE(FTDI_VID, FTDI_RRCIRKITS_LOCOBUFFER_PID) },
Ian Abbott7e0258f2006-04-12 15:20:35 +0100522 { USB_DEVICE(FTDI_VID, FTDI_ASK_RDR400_PID) },
A. Maitland Bottomsbf58fbd2006-03-14 18:44:23 -0500523 { USB_DEVICE(ICOM_ID1_VID, ICOM_ID1_PID) },
Folkert van Heusden62a13db2006-03-28 20:41:26 +0900524 { USB_DEVICE(PAPOUCH_VID, PAPOUCH_TMU_PID) },
Ian Abbott20a0f472006-05-04 11:34:25 +0100525 { USB_DEVICE(FTDI_VID, FTDI_ACG_HFDUAL_PID) },
Ian Abbotteb79b4f2006-05-30 12:36:30 +0100526 { USB_DEVICE(FTDI_VID, FTDI_YEI_SERVOCENTER31_PID) },
D. Peter Siddons48437482006-06-17 18:09:15 -0400527 { USB_DEVICE(FTDI_VID, FTDI_THORLABS_PID) },
Colin Leroye1979fe2006-07-11 11:36:43 +0200528 { USB_DEVICE(TESTO_VID, TESTO_USB_INTERFACE_PID) },
Ralf Schlatterbeckeaede2c2006-09-06 12:15:02 +0200529 { USB_DEVICE(FTDI_VID, FTDI_GAMMA_SCOUT_PID) },
Ian Abbott9978f9e2006-09-25 14:19:19 +0100530 { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13M_PID) },
531 { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13S_PID) },
532 { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13U_PID) },
Kjell Myksvoll40c36092006-10-22 23:26:42 +0200533 { USB_DEVICE(ELEKTOR_VID, ELEKTOR_FT323R_PID) },
Micke Prag822c7ef2007-02-04 23:39:11 +0100534 { USB_DEVICE(TELLDUS_VID, TELLDUS_TELLSTICK_PID) },
Neil \"Superna\" ARMSTRONG762e92f2007-04-25 20:34:28 +0200535 { USB_DEVICE(FTDI_VID, FTDI_MAXSTREAM_PID) },
Tony Lindgrenfa91d432007-05-04 18:23:24 -0700536 { USB_DEVICE(OLIMEX_VID, OLIMEX_ARM_USB_OCD_PID),
537 .driver_info = (kernel_ulong_t)&ftdi_olimex_quirk },
Ian Abbottfdcb0a02005-07-28 18:40:32 +0100538 { }, /* Optional parameter entry */
539 { } /* Terminating entry */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540};
541
542MODULE_DEVICE_TABLE (usb, id_table_combined);
543
544static struct usb_driver ftdi_driver = {
545 .name = "ftdi_sio",
546 .probe = usb_serial_probe,
547 .disconnect = usb_serial_disconnect,
548 .id_table = id_table_combined,
David Brownell5c09d142006-10-13 15:57:58 -0700549 .no_dynamic_id = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550};
551
Arjan van de Ven4c4c9432005-11-29 09:43:42 +0100552static const char *ftdi_chip_name[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 [SIO] = "SIO", /* the serial part of FT8U100AX */
554 [FT8U232AM] = "FT8U232AM",
555 [FT232BM] = "FT232BM",
556 [FT2232C] = "FT2232C",
Gard Spreemannd8b21602007-03-05 00:03:26 +0100557 [FT232RL] = "FT232RL",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558};
559
560
561/* Constants for read urb and write urb */
562#define BUFSZ 512
563#define PKTSZ 64
564
565/* rx_flags */
566#define THROTTLED 0x01
567#define ACTUALLY_THROTTLED 0x02
568
569struct ftdi_private {
570 ftdi_chip_type_t chip_type;
571 /* type of the device, either SIO or FT8U232AM */
572 int baud_base; /* baud base clock for divisor setting */
573 int custom_divisor; /* custom_divisor kludge, this is for baud_base (different from what goes to the chip!) */
574 __u16 last_set_data_urb_value ;
575 /* the last data state set - needed for doing a break */
David Brownell5c09d142006-10-13 15:57:58 -0700576 int write_offset; /* This is the offset in the usb data block to write the serial data -
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 * it is different between devices
578 */
579 int flags; /* some ASYNC_xxxx flags are supported */
580 unsigned long last_dtr_rts; /* saved modem control outputs */
581 wait_queue_head_t delta_msr_wait; /* Used for TIOCMIWAIT */
David Brownell5c09d142006-10-13 15:57:58 -0700582 char prev_status, diff_status; /* Used for TIOCMIWAIT */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 __u8 rx_flags; /* receive state flags (throttling) */
584 spinlock_t rx_lock; /* spinlock for receive state */
David Howellsc4028952006-11-22 14:57:56 +0000585 struct delayed_work rx_work;
586 struct usb_serial_port *port;
Ian Abbott76854ce2005-06-02 10:34:11 +0100587 int rx_processed;
Ian Abbott22465402006-06-26 12:59:17 +0100588 unsigned long rx_bytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589
590 __u16 interface; /* FT2232C port interface (0 for FT232/245) */
591
592 int force_baud; /* if non-zero, force the baud rate to this value */
593 int force_rtscts; /* if non-zero, force RTS-CTS to always be enabled */
Ian Abbott22465402006-06-26 12:59:17 +0100594
595 spinlock_t tx_lock; /* spinlock for transmit state */
596 unsigned long tx_bytes;
597 unsigned long tx_outstanding_bytes;
598 unsigned long tx_outstanding_urbs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599};
600
601/* Used for TIOCMIWAIT */
602#define FTDI_STATUS_B0_MASK (FTDI_RS0_CTS | FTDI_RS0_DSR | FTDI_RS0_RI | FTDI_RS0_RLSD)
603#define FTDI_STATUS_B1_MASK (FTDI_RS_BI)
604/* End TIOCMIWAIT */
605
606#define FTDI_IMPL_ASYNC_FLAGS = ( ASYNC_SPD_HI | ASYNC_SPD_VHI \
607 ASYNC_SPD_CUST | ASYNC_SPD_SHI | ASYNC_SPD_WARP )
608
609/* function prototypes for a FTDI serial converter */
Ian Abbott8f977e42005-06-20 16:45:42 +0100610static int ftdi_sio_probe (struct usb_serial *serial, const struct usb_device_id *id);
611static int ftdi_sio_attach (struct usb_serial *serial);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612static void ftdi_shutdown (struct usb_serial *serial);
Jim Radford12bdbe02007-02-28 10:10:50 -0800613static int ftdi_sio_port_probe (struct usb_serial_port *port);
614static int ftdi_sio_port_remove (struct usb_serial_port *port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615static int ftdi_open (struct usb_serial_port *port, struct file *filp);
616static void ftdi_close (struct usb_serial_port *port, struct file *filp);
617static int ftdi_write (struct usb_serial_port *port, const unsigned char *buf, int count);
618static int ftdi_write_room (struct usb_serial_port *port);
619static int ftdi_chars_in_buffer (struct usb_serial_port *port);
David Howells7d12e782006-10-05 14:55:46 +0100620static void ftdi_write_bulk_callback (struct urb *urb);
621static void ftdi_read_bulk_callback (struct urb *urb);
David Howellsc4028952006-11-22 14:57:56 +0000622static void ftdi_process_read (struct work_struct *work);
Alan Cox606d0992006-12-08 02:38:45 -0800623static void ftdi_set_termios (struct usb_serial_port *port, struct ktermios * old);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624static int ftdi_tiocmget (struct usb_serial_port *port, struct file *file);
625static int ftdi_tiocmset (struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear);
626static int ftdi_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg);
627static void ftdi_break_ctl (struct usb_serial_port *port, int break_state );
628static void ftdi_throttle (struct usb_serial_port *port);
629static void ftdi_unthrottle (struct usb_serial_port *port);
630
631static unsigned short int ftdi_232am_baud_base_to_divisor (int baud, int base);
632static unsigned short int ftdi_232am_baud_to_divisor (int baud);
633static __u32 ftdi_232bm_baud_base_to_divisor (int baud, int base);
634static __u32 ftdi_232bm_baud_to_divisor (int baud);
635
Greg Kroah-Hartmanea653702005-06-20 21:15:16 -0700636static struct usb_serial_driver ftdi_sio_device = {
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700637 .driver = {
638 .owner = THIS_MODULE,
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700639 .name = "ftdi_sio",
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700640 },
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700641 .description = "FTDI USB Serial Device",
Johannes Hölzld9b1b782006-12-17 21:50:24 +0100642 .usb_driver = &ftdi_driver ,
Ian Abbott8f977e42005-06-20 16:45:42 +0100643 .id_table = id_table_combined,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 .num_interrupt_in = 0,
645 .num_bulk_in = 1,
646 .num_bulk_out = 1,
647 .num_ports = 1,
Ian Abbott8f977e42005-06-20 16:45:42 +0100648 .probe = ftdi_sio_probe,
Jim Radford12bdbe02007-02-28 10:10:50 -0800649 .port_probe = ftdi_sio_port_probe,
650 .port_remove = ftdi_sio_port_remove,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 .open = ftdi_open,
652 .close = ftdi_close,
653 .throttle = ftdi_throttle,
654 .unthrottle = ftdi_unthrottle,
655 .write = ftdi_write,
656 .write_room = ftdi_write_room,
657 .chars_in_buffer = ftdi_chars_in_buffer,
658 .read_bulk_callback = ftdi_read_bulk_callback,
659 .write_bulk_callback = ftdi_write_bulk_callback,
660 .tiocmget = ftdi_tiocmget,
661 .tiocmset = ftdi_tiocmset,
662 .ioctl = ftdi_ioctl,
663 .set_termios = ftdi_set_termios,
664 .break_ctl = ftdi_break_ctl,
Ian Abbott8f977e42005-06-20 16:45:42 +0100665 .attach = ftdi_sio_attach,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 .shutdown = ftdi_shutdown,
667};
668
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669
670#define WDR_TIMEOUT 5000 /* default urb timeout */
Ian Abbott279e1542005-07-29 12:16:52 -0700671#define WDR_SHORT_TIMEOUT 1000 /* shorter urb timeout */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672
673/* High and low are for DTR, RTS etc etc */
674#define HIGH 1
675#define LOW 0
676
Ian Abbott22465402006-06-26 12:59:17 +0100677/* number of outstanding urbs to prevent userspace DoS from happening */
678#define URB_UPPER_LIMIT 42
679
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680/*
681 * ***************************************************************************
Tony Lindgrenfa91d432007-05-04 18:23:24 -0700682 * Utility functions
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 * ***************************************************************************
684 */
685
686static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base)
687{
688 unsigned short int divisor;
689 int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
690 if ((divisor3 & 0x7) == 7) divisor3 ++; // round x.7/8 up to x+1
691 divisor = divisor3 >> 3;
692 divisor3 &= 0x7;
693 if (divisor3 == 1) divisor |= 0xc000; else // 0.125
694 if (divisor3 >= 4) divisor |= 0x4000; else // 0.5
695 if (divisor3 != 0) divisor |= 0x8000; // 0.25
696 if (divisor == 1) divisor = 0; /* special case for maximum baud rate */
697 return divisor;
698}
699
700static unsigned short int ftdi_232am_baud_to_divisor(int baud)
701{
702 return(ftdi_232am_baud_base_to_divisor(baud, 48000000));
703}
704
705static __u32 ftdi_232bm_baud_base_to_divisor(int baud, int base)
706{
707 static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
708 __u32 divisor;
709 int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
710 divisor = divisor3 >> 3;
711 divisor |= (__u32)divfrac[divisor3 & 0x7] << 14;
712 /* Deal with special cases for highest baud rates. */
713 if (divisor == 1) divisor = 0; else // 1.0
714 if (divisor == 0x4001) divisor = 1; // 1.5
715 return divisor;
716}
717
718static __u32 ftdi_232bm_baud_to_divisor(int baud)
719{
720 return(ftdi_232bm_baud_base_to_divisor(baud, 48000000));
721}
722
Ian Abbott74ede0f2005-07-29 12:16:41 -0700723#define set_mctrl(port, set) update_mctrl((port), (set), 0)
724#define clear_mctrl(port, clear) update_mctrl((port), 0, (clear))
725
726static int update_mctrl(struct usb_serial_port *port, unsigned int set, unsigned int clear)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727{
728 struct ftdi_private *priv = usb_get_serial_port_data(port);
729 char *buf;
Ian Abbott74ede0f2005-07-29 12:16:41 -0700730 unsigned urb_value;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 int rv;
Ian Abbott74ede0f2005-07-29 12:16:41 -0700732
733 if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
734 dbg("%s - DTR|RTS not being set|cleared", __FUNCTION__);
735 return 0; /* no change */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 }
Ian Abbott74ede0f2005-07-29 12:16:41 -0700737
738 buf = kmalloc(1, GFP_NOIO);
739 if (!buf) {
740 return -ENOMEM;
741 }
742
743 clear &= ~set; /* 'set' takes precedence over 'clear' */
744 urb_value = 0;
745 if (clear & TIOCM_DTR)
746 urb_value |= FTDI_SIO_SET_DTR_LOW;
747 if (clear & TIOCM_RTS)
748 urb_value |= FTDI_SIO_SET_RTS_LOW;
749 if (set & TIOCM_DTR)
750 urb_value |= FTDI_SIO_SET_DTR_HIGH;
751 if (set & TIOCM_RTS)
752 urb_value |= FTDI_SIO_SET_RTS_HIGH;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753 rv = usb_control_msg(port->serial->dev,
754 usb_sndctrlpipe(port->serial->dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -0700755 FTDI_SIO_SET_MODEM_CTRL_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE,
Ian Abbott74ede0f2005-07-29 12:16:41 -0700757 urb_value, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 buf, 0, WDR_TIMEOUT);
759
760 kfree(buf);
Ian Abbott74ede0f2005-07-29 12:16:41 -0700761 if (rv < 0) {
762 err("%s Error from MODEM_CTRL urb: DTR %s, RTS %s",
763 __FUNCTION__,
764 (set & TIOCM_DTR) ? "HIGH" :
765 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
766 (set & TIOCM_RTS) ? "HIGH" :
767 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 } else {
Ian Abbott74ede0f2005-07-29 12:16:41 -0700769 dbg("%s - DTR %s, RTS %s", __FUNCTION__,
770 (set & TIOCM_DTR) ? "HIGH" :
771 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
772 (set & TIOCM_RTS) ? "HIGH" :
773 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
774 priv->last_dtr_rts = (priv->last_dtr_rts & ~clear) | set;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 return rv;
777}
778
779
780static __u32 get_ftdi_divisor(struct usb_serial_port * port);
781
782
783static int change_speed(struct usb_serial_port *port)
784{
785 struct ftdi_private *priv = usb_get_serial_port_data(port);
786 char *buf;
787 __u16 urb_value;
788 __u16 urb_index;
789 __u32 urb_index_value;
790 int rv;
791
792 buf = kmalloc(1, GFP_NOIO);
793 if (!buf)
794 return -ENOMEM;
795
796 urb_index_value = get_ftdi_divisor(port);
797 urb_value = (__u16)urb_index_value;
798 urb_index = (__u16)(urb_index_value >> 16);
799 if (priv->interface) { /* FT2232C */
800 urb_index = (__u16)((urb_index << 8) | priv->interface);
801 }
David Brownell5c09d142006-10-13 15:57:58 -0700802
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803 rv = usb_control_msg(port->serial->dev,
804 usb_sndctrlpipe(port->serial->dev, 0),
805 FTDI_SIO_SET_BAUDRATE_REQUEST,
806 FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE,
807 urb_value, urb_index,
Ian Abbott279e1542005-07-29 12:16:52 -0700808 buf, 0, WDR_SHORT_TIMEOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809
810 kfree(buf);
811 return rv;
812}
813
814
815static __u32 get_ftdi_divisor(struct usb_serial_port * port)
816{ /* get_ftdi_divisor */
817 struct ftdi_private *priv = usb_get_serial_port_data(port);
818 __u32 div_value = 0;
819 int div_okay = 1;
820 int baud;
821
822 /*
823 * The logic involved in setting the baudrate can be cleanly split in 3 steps.
824 * Obtaining the actual baud rate is a little tricky since unix traditionally
825 * somehow ignored the possibility to set non-standard baud rates.
826 * 1. Standard baud rates are set in tty->termios->c_cflag
827 * 2. If these are not enough, you can set any speed using alt_speed as follows:
828 * - set tty->termios->c_cflag speed to B38400
829 * - set your real speed in tty->alt_speed; it gets ignored when
830 * alt_speed==0, (or)
831 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
832 * flags & ASYNC_SPD_MASK == ASYNC_SPD_[HI, VHI, SHI, WARP], this just
833 * sets alt_speed to (HI: 57600, VHI: 115200, SHI: 230400, WARP: 460800)
834 * ** Steps 1, 2 are done courtesy of tty_get_baud_rate
835 * 3. You can also set baud rate by setting custom divisor as follows
836 * - set tty->termios->c_cflag speed to B38400
837 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
838 * o flags & ASYNC_SPD_MASK == ASYNC_SPD_CUST
839 * o custom_divisor set to baud_base / your_new_baudrate
840 * ** Step 3 is done courtesy of code borrowed from serial.c - I should really
841 * spend some time and separate+move this common code to serial.c, it is
842 * replicated in nearly every serial driver you see.
843 */
844
845 /* 1. Get the baud rate from the tty settings, this observes alt_speed hack */
846
847 baud = tty_get_baud_rate(port->tty);
848 dbg("%s - tty_get_baud_rate reports speed %d", __FUNCTION__, baud);
849
850 /* 2. Observe async-compatible custom_divisor hack, update baudrate if needed */
851
852 if (baud == 38400 &&
853 ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
854 (priv->custom_divisor)) {
855 baud = priv->baud_base / priv->custom_divisor;
856 dbg("%s - custom divisor %d sets baud rate to %d", __FUNCTION__, priv->custom_divisor, baud);
857 }
858
859 /* 3. Convert baudrate to device-specific divisor */
860
David Brownell5c09d142006-10-13 15:57:58 -0700861 if (!baud) baud = 9600;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 switch(priv->chip_type) {
863 case SIO: /* SIO chip */
864 switch(baud) {
865 case 300: div_value = ftdi_sio_b300; break;
866 case 600: div_value = ftdi_sio_b600; break;
867 case 1200: div_value = ftdi_sio_b1200; break;
868 case 2400: div_value = ftdi_sio_b2400; break;
869 case 4800: div_value = ftdi_sio_b4800; break;
870 case 9600: div_value = ftdi_sio_b9600; break;
871 case 19200: div_value = ftdi_sio_b19200; break;
872 case 38400: div_value = ftdi_sio_b38400; break;
873 case 57600: div_value = ftdi_sio_b57600; break;
874 case 115200: div_value = ftdi_sio_b115200; break;
875 } /* baud */
876 if (div_value == 0) {
David Brownell5c09d142006-10-13 15:57:58 -0700877 dbg("%s - Baudrate (%d) requested is not supported", __FUNCTION__, baud);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878 div_value = ftdi_sio_b9600;
879 div_okay = 0;
880 }
881 break;
882 case FT8U232AM: /* 8U232AM chip */
883 if (baud <= 3000000) {
884 div_value = ftdi_232am_baud_to_divisor(baud);
885 } else {
886 dbg("%s - Baud rate too high!", __FUNCTION__);
887 div_value = ftdi_232am_baud_to_divisor(9600);
888 div_okay = 0;
889 }
890 break;
891 case FT232BM: /* FT232BM chip */
892 case FT2232C: /* FT2232C chip */
David Brownell3b009c62007-03-23 12:54:27 -0700893 case FT232RL:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894 if (baud <= 3000000) {
895 div_value = ftdi_232bm_baud_to_divisor(baud);
896 } else {
897 dbg("%s - Baud rate too high!", __FUNCTION__);
898 div_value = ftdi_232bm_baud_to_divisor(9600);
899 div_okay = 0;
900 }
901 break;
902 } /* priv->chip_type */
903
904 if (div_okay) {
905 dbg("%s - Baud rate set to %d (divisor 0x%lX) on chip %s",
906 __FUNCTION__, baud, (unsigned long)div_value,
907 ftdi_chip_name[priv->chip_type]);
908 }
909
910 return(div_value);
911}
912
913
914static int get_serial_info(struct usb_serial_port * port, struct serial_struct __user * retinfo)
915{
916 struct ftdi_private *priv = usb_get_serial_port_data(port);
917 struct serial_struct tmp;
918
919 if (!retinfo)
920 return -EFAULT;
921 memset(&tmp, 0, sizeof(tmp));
922 tmp.flags = priv->flags;
923 tmp.baud_base = priv->baud_base;
924 tmp.custom_divisor = priv->custom_divisor;
925 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
926 return -EFAULT;
927 return 0;
928} /* get_serial_info */
929
930
931static int set_serial_info(struct usb_serial_port * port, struct serial_struct __user * newinfo)
932{ /* set_serial_info */
933 struct ftdi_private *priv = usb_get_serial_port_data(port);
934 struct serial_struct new_serial;
935 struct ftdi_private old_priv;
936
937 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
938 return -EFAULT;
939 old_priv = * priv;
940
941 /* Do error checking and permission checking */
942
943 if (!capable(CAP_SYS_ADMIN)) {
944 if (((new_serial.flags & ~ASYNC_USR_MASK) !=
945 (priv->flags & ~ASYNC_USR_MASK)))
946 return -EPERM;
947 priv->flags = ((priv->flags & ~ASYNC_USR_MASK) |
948 (new_serial.flags & ASYNC_USR_MASK));
949 priv->custom_divisor = new_serial.custom_divisor;
950 goto check_and_exit;
951 }
952
953 if ((new_serial.baud_base != priv->baud_base) &&
954 (new_serial.baud_base < 9600))
955 return -EINVAL;
956
957 /* Make the changes - these are privileged changes! */
958
959 priv->flags = ((priv->flags & ~ASYNC_FLAGS) |
David Brownell5c09d142006-10-13 15:57:58 -0700960 (new_serial.flags & ASYNC_FLAGS));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961 priv->custom_divisor = new_serial.custom_divisor;
962
963 port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
964
965check_and_exit:
966 if ((old_priv.flags & ASYNC_SPD_MASK) !=
967 (priv->flags & ASYNC_SPD_MASK)) {
968 if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_HI)
969 port->tty->alt_speed = 57600;
970 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_VHI)
971 port->tty->alt_speed = 115200;
972 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_SHI)
973 port->tty->alt_speed = 230400;
974 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_WARP)
975 port->tty->alt_speed = 460800;
976 else
977 port->tty->alt_speed = 0;
978 }
979 if (((old_priv.flags & ASYNC_SPD_MASK) !=
980 (priv->flags & ASYNC_SPD_MASK)) ||
981 (((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
982 (old_priv.custom_divisor != priv->custom_divisor))) {
983 change_speed(port);
984 }
David Brownell5c09d142006-10-13 15:57:58 -0700985
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 return (0);
987
988} /* set_serial_info */
989
990
Ian Abbott8f977e42005-06-20 16:45:42 +0100991/* Determine type of FTDI chip based on USB config and descriptor. */
992static void ftdi_determine_type(struct usb_serial_port *port)
993{
994 struct ftdi_private *priv = usb_get_serial_port_data(port);
995 struct usb_serial *serial = port->serial;
996 struct usb_device *udev = serial->dev;
997 unsigned version;
998 unsigned interfaces;
999
1000 /* Assume it is not the original SIO device for now. */
Ian Abbottf5e09b72005-09-12 12:23:25 +01001001 priv->baud_base = 48000000 / 2;
Ian Abbott8f977e42005-06-20 16:45:42 +01001002 priv->write_offset = 0;
1003
1004 version = le16_to_cpu(udev->descriptor.bcdDevice);
1005 interfaces = udev->actconfig->desc.bNumInterfaces;
1006 dbg("%s: bcdDevice = 0x%x, bNumInterfaces = %u", __FUNCTION__,
1007 version, interfaces);
1008 if (interfaces > 1) {
1009 int inter;
1010
1011 /* Multiple interfaces. Assume FT2232C. */
1012 priv->chip_type = FT2232C;
1013 /* Determine interface code. */
1014 inter = serial->interface->altsetting->desc.bInterfaceNumber;
1015 if (inter == 0) {
1016 priv->interface = PIT_SIOA;
1017 } else {
1018 priv->interface = PIT_SIOB;
1019 }
1020 /* BM-type devices have a bug where bcdDevice gets set
1021 * to 0x200 when iSerialNumber is 0. */
1022 if (version < 0x500) {
1023 dbg("%s: something fishy - bcdDevice too low for multi-interface device",
1024 __FUNCTION__);
1025 }
1026 } else if (version < 0x200) {
1027 /* Old device. Assume its the original SIO. */
1028 priv->chip_type = SIO;
1029 priv->baud_base = 12000000 / 16;
1030 priv->write_offset = 1;
1031 } else if (version < 0x400) {
1032 /* Assume its an FT8U232AM (or FT8U245AM) */
1033 /* (It might be a BM because of the iSerialNumber bug,
1034 * but it will still work as an AM device.) */
1035 priv->chip_type = FT8U232AM;
David Brownell3b009c62007-03-23 12:54:27 -07001036 } else if (version < 0x600) {
Ian Abbott8f977e42005-06-20 16:45:42 +01001037 /* Assume its an FT232BM (or FT245BM) */
1038 priv->chip_type = FT232BM;
David Brownell3b009c62007-03-23 12:54:27 -07001039 } else {
1040 /* Assume its an FT232R */
1041 priv->chip_type = FT232RL;
Ian Abbott8f977e42005-06-20 16:45:42 +01001042 }
1043 info("Detected %s", ftdi_chip_name[priv->chip_type]);
1044}
1045
1046
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047/*
1048 * ***************************************************************************
1049 * Sysfs Attribute
1050 * ***************************************************************************
1051 */
1052
Yani Ioannou060b8842005-05-17 06:44:04 -04001053static ssize_t show_latency_timer(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054{
1055 struct usb_serial_port *port = to_usb_serial_port(dev);
1056 struct ftdi_private *priv = usb_get_serial_port_data(port);
Jim Radford12bdbe02007-02-28 10:10:50 -08001057 struct usb_device *udev = port->serial->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058 unsigned short latency = 0;
1059 int rv = 0;
David Brownell5c09d142006-10-13 15:57:58 -07001060
David Brownell5c09d142006-10-13 15:57:58 -07001061
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062 dbg("%s",__FUNCTION__);
David Brownell5c09d142006-10-13 15:57:58 -07001063
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064 rv = usb_control_msg(udev,
1065 usb_rcvctrlpipe(udev, 0),
1066 FTDI_SIO_GET_LATENCY_TIMER_REQUEST,
1067 FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07001068 0, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 (char*) &latency, 1, WDR_TIMEOUT);
David Brownell5c09d142006-10-13 15:57:58 -07001070
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071 if (rv < 0) {
1072 dev_err(dev, "Unable to read latency timer: %i", rv);
1073 return -EIO;
1074 }
1075 return sprintf(buf, "%i\n", latency);
1076}
1077
1078/* Write a new value of the latency timer, in units of milliseconds. */
Yani Ioannou060b8842005-05-17 06:44:04 -04001079static ssize_t store_latency_timer(struct device *dev, struct device_attribute *attr, const char *valbuf,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 size_t count)
1081{
1082 struct usb_serial_port *port = to_usb_serial_port(dev);
1083 struct ftdi_private *priv = usb_get_serial_port_data(port);
Jim Radford12bdbe02007-02-28 10:10:50 -08001084 struct usb_device *udev = port->serial->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 char buf[1];
1086 int v = simple_strtoul(valbuf, NULL, 10);
1087 int rv = 0;
David Brownell5c09d142006-10-13 15:57:58 -07001088
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089 dbg("%s: setting latency timer = %i", __FUNCTION__, v);
David Brownell5c09d142006-10-13 15:57:58 -07001090
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091 rv = usb_control_msg(udev,
1092 usb_sndctrlpipe(udev, 0),
1093 FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
1094 FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07001095 v, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096 buf, 0, WDR_TIMEOUT);
David Brownell5c09d142006-10-13 15:57:58 -07001097
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098 if (rv < 0) {
1099 dev_err(dev, "Unable to write latency timer: %i", rv);
1100 return -EIO;
1101 }
David Brownell5c09d142006-10-13 15:57:58 -07001102
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103 return count;
1104}
1105
1106/* Write an event character directly to the FTDI register. The ASCII
1107 value is in the low 8 bits, with the enable bit in the 9th bit. */
Yani Ioannou060b8842005-05-17 06:44:04 -04001108static ssize_t store_event_char(struct device *dev, struct device_attribute *attr, const char *valbuf,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109 size_t count)
1110{
1111 struct usb_serial_port *port = to_usb_serial_port(dev);
1112 struct ftdi_private *priv = usb_get_serial_port_data(port);
Jim Radford12bdbe02007-02-28 10:10:50 -08001113 struct usb_device *udev = port->serial->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114 char buf[1];
1115 int v = simple_strtoul(valbuf, NULL, 10);
1116 int rv = 0;
David Brownell5c09d142006-10-13 15:57:58 -07001117
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118 dbg("%s: setting event char = %i", __FUNCTION__, v);
David Brownell5c09d142006-10-13 15:57:58 -07001119
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120 rv = usb_control_msg(udev,
1121 usb_sndctrlpipe(udev, 0),
1122 FTDI_SIO_SET_EVENT_CHAR_REQUEST,
1123 FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07001124 v, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125 buf, 0, WDR_TIMEOUT);
David Brownell5c09d142006-10-13 15:57:58 -07001126
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 if (rv < 0) {
1128 dbg("Unable to write event character: %i", rv);
1129 return -EIO;
1130 }
David Brownell5c09d142006-10-13 15:57:58 -07001131
Linus Torvalds1da177e2005-04-16 15:20:36 -07001132 return count;
1133}
1134
1135static DEVICE_ATTR(latency_timer, S_IWUSR | S_IRUGO, show_latency_timer, store_latency_timer);
1136static DEVICE_ATTR(event_char, S_IWUSR, NULL, store_event_char);
1137
Jim Radford12bdbe02007-02-28 10:10:50 -08001138static int create_sysfs_attrs(struct usb_serial_port *port)
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001139{
Jim Radford12bdbe02007-02-28 10:10:50 -08001140 struct ftdi_private *priv = usb_get_serial_port_data(port);
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001141 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142
1143 dbg("%s",__FUNCTION__);
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001144
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145 /* XXX I've no idea if the original SIO supports the event_char
1146 * sysfs parameter, so I'm playing it safe. */
1147 if (priv->chip_type != SIO) {
1148 dbg("sysfs attributes for %s", ftdi_chip_name[priv->chip_type]);
Jim Radford12bdbe02007-02-28 10:10:50 -08001149 retval = device_create_file(&port->dev, &dev_attr_event_char);
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001150 if ((!retval) &&
1151 (priv->chip_type == FT232BM || priv->chip_type == FT2232C)) {
Jim Radford12bdbe02007-02-28 10:10:50 -08001152 retval = device_create_file(&port->dev,
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001153 &dev_attr_latency_timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 }
1155 }
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001156 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157}
1158
Jim Radford12bdbe02007-02-28 10:10:50 -08001159static void remove_sysfs_attrs(struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160{
Jim Radford12bdbe02007-02-28 10:10:50 -08001161 struct ftdi_private *priv = usb_get_serial_port_data(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162
David Brownell5c09d142006-10-13 15:57:58 -07001163 dbg("%s",__FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165 /* XXX see create_sysfs_attrs */
1166 if (priv->chip_type != SIO) {
Jim Radford12bdbe02007-02-28 10:10:50 -08001167 device_remove_file(&port->dev, &dev_attr_event_char);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168 if (priv->chip_type == FT232BM || priv->chip_type == FT2232C) {
Jim Radford12bdbe02007-02-28 10:10:50 -08001169 device_remove_file(&port->dev, &dev_attr_latency_timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170 }
1171 }
David Brownell5c09d142006-10-13 15:57:58 -07001172
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173}
1174
1175/*
1176 * ***************************************************************************
1177 * FTDI driver specific functions
1178 * ***************************************************************************
1179 */
1180
Ian Abbott8f977e42005-06-20 16:45:42 +01001181/* Probe function to check for special devices */
1182static int ftdi_sio_probe (struct usb_serial *serial, const struct usb_device_id *id)
1183{
Tony Lindgrenfa91d432007-05-04 18:23:24 -07001184 struct ftdi_sio_quirk *quirk = (struct ftdi_sio_quirk *)id->driver_info;
1185
1186 if (quirk && quirk->probe) {
1187 int ret = quirk->probe(serial);
1188 if (ret != 0)
1189 return ret;
1190 }
1191
Ian Abbott8f977e42005-06-20 16:45:42 +01001192 usb_set_serial_data(serial, (void *)id->driver_info);
1193
Tony Lindgrenfa91d432007-05-04 18:23:24 -07001194 return 0;
Ian Abbott8f977e42005-06-20 16:45:42 +01001195}
1196
Jim Radford12bdbe02007-02-28 10:10:50 -08001197static int ftdi_sio_port_probe(struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199 struct ftdi_private *priv;
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001200
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201 dbg("%s",__FUNCTION__);
1202
Eric Sesterhenn80b6ca42006-02-27 21:29:43 +01001203 priv = kzalloc(sizeof(struct ftdi_private), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204 if (!priv){
1205 err("%s- kmalloc(%Zd) failed.", __FUNCTION__, sizeof(struct ftdi_private));
1206 return -ENOMEM;
1207 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208
1209 spin_lock_init(&priv->rx_lock);
Ian Abbott22465402006-06-26 12:59:17 +01001210 spin_lock_init(&priv->tx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211 init_waitqueue_head(&priv->delta_msr_wait);
1212 /* This will push the characters through immediately rather
1213 than queue a task to deliver them */
1214 priv->flags = ASYNC_LOW_LATENCY;
1215
1216 /* Increase the size of read buffers */
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07001217 kfree(port->bulk_in_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218 port->bulk_in_buffer = kmalloc (BUFSZ, GFP_KERNEL);
1219 if (!port->bulk_in_buffer) {
1220 kfree (priv);
1221 return -ENOMEM;
1222 }
1223 if (port->read_urb) {
1224 port->read_urb->transfer_buffer = port->bulk_in_buffer;
1225 port->read_urb->transfer_buffer_length = BUFSZ;
1226 }
1227
David Howellsc4028952006-11-22 14:57:56 +00001228 INIT_DELAYED_WORK(&priv->rx_work, ftdi_process_read);
1229 priv->port = port;
Ian Abbott76854ce2005-06-02 10:34:11 +01001230
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231 /* Free port's existing write urb and transfer buffer. */
1232 if (port->write_urb) {
1233 usb_free_urb (port->write_urb);
1234 port->write_urb = NULL;
1235 }
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07001236 kfree(port->bulk_out_buffer);
1237 port->bulk_out_buffer = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238
Jim Radford12bdbe02007-02-28 10:10:50 -08001239 usb_set_serial_port_data(port, priv);
Ian Abbott8f977e42005-06-20 16:45:42 +01001240
Jim Radford12bdbe02007-02-28 10:10:50 -08001241 ftdi_determine_type (port);
1242 create_sysfs_attrs(port);
1243 return 0;
1244}
Ian Abbott8f977e42005-06-20 16:45:42 +01001245
Jim Radford12bdbe02007-02-28 10:10:50 -08001246/* attach subroutine */
1247static int ftdi_sio_attach (struct usb_serial *serial)
1248{
Ian Abbott8f977e42005-06-20 16:45:42 +01001249 /* Check for device requiring special set up. */
Jim Radford12bdbe02007-02-28 10:10:50 -08001250 struct ftdi_sio_quirk *quirk = usb_get_serial_data(serial);
1251
1252 if (quirk && quirk->setup)
Ian Abbott8f977e42005-06-20 16:45:42 +01001253 quirk->setup(serial);
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001254
1255 return 0;
Ian Abbott8f977e42005-06-20 16:45:42 +01001256} /* ftdi_sio_attach */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257
1258
Ian Abbott8f977e42005-06-20 16:45:42 +01001259/* Setup for the USB-UIRT device, which requires hardwired
1260 * baudrate (38400 gets mapped to 312500) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261/* Called from usbserial:serial_probe */
Ian Abbott8f977e42005-06-20 16:45:42 +01001262static void ftdi_USB_UIRT_setup (struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263{
1264 struct ftdi_private *priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265
1266 dbg("%s",__FUNCTION__);
1267
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268 priv = usb_get_serial_port_data(serial->port[0]);
1269 priv->flags |= ASYNC_SPD_CUST;
1270 priv->custom_divisor = 77;
1271 priv->force_baud = B38400;
Ian Abbott8f977e42005-06-20 16:45:42 +01001272} /* ftdi_USB_UIRT_setup */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273
Ian Abbott8f977e42005-06-20 16:45:42 +01001274/* Setup for the HE-TIRA1 device, which requires hardwired
1275 * baudrate (38400 gets mapped to 100000) and RTS-CTS enabled. */
1276static void ftdi_HE_TIRA1_setup (struct usb_serial *serial)
1277{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278 struct ftdi_private *priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279
1280 dbg("%s",__FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281
1282 priv = usb_get_serial_port_data(serial->port[0]);
1283 priv->flags |= ASYNC_SPD_CUST;
1284 priv->custom_divisor = 240;
1285 priv->force_baud = B38400;
1286 priv->force_rtscts = 1;
Ian Abbott8f977e42005-06-20 16:45:42 +01001287} /* ftdi_HE_TIRA1_setup */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288
Tony Lindgrenfa91d432007-05-04 18:23:24 -07001289/*
1290 * First port on Olimex arm-usb-ocd is reserved for JTAG interface
1291 * and can be accessed from userspace using openocd.
1292 */
1293static int ftdi_olimex_probe(struct usb_serial *serial)
1294{
1295 struct usb_device *udev = serial->dev;
1296 struct usb_interface *interface = serial->interface;
1297
1298 dbg("%s",__FUNCTION__);
1299
1300 if (interface == udev->actconfig->interface[0]) {
1301 info("Ignoring reserved serial port on Olimex arm-usb-ocd\n");
1302 return -ENODEV;
1303 }
1304
1305 return 0;
1306}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307
David Brownell5c09d142006-10-13 15:57:58 -07001308/* ftdi_shutdown is called from usbserial:usb_serial_disconnect
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309 * it is called when the usb device is disconnected
1310 *
1311 * usbserial:usb_serial_disconnect
1312 * calls __serial_close for each open of the port
1313 * shutdown is called then (ie ftdi_shutdown)
1314 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315static void ftdi_shutdown (struct usb_serial *serial)
Jim Radford12bdbe02007-02-28 10:10:50 -08001316{
1317 dbg("%s", __FUNCTION__);
1318}
David Brownell5c09d142006-10-13 15:57:58 -07001319
Jim Radford12bdbe02007-02-28 10:10:50 -08001320static int ftdi_sio_port_remove(struct usb_serial_port *port)
1321{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 struct ftdi_private *priv = usb_get_serial_port_data(port);
1323
1324 dbg("%s", __FUNCTION__);
1325
Jim Radford12bdbe02007-02-28 10:10:50 -08001326 remove_sysfs_attrs(port);
David Brownell5c09d142006-10-13 15:57:58 -07001327
1328 /* all open ports are closed at this point
1329 * (by usbserial.c:__serial_close, which calls ftdi_close)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330 */
1331
1332 if (priv) {
1333 usb_set_serial_port_data(port, NULL);
1334 kfree(priv);
1335 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336
Jim Radford12bdbe02007-02-28 10:10:50 -08001337 return 0;
1338}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339
1340static int ftdi_open (struct usb_serial_port *port, struct file *filp)
1341{ /* ftdi_open */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342 struct usb_device *dev = port->serial->dev;
1343 struct ftdi_private *priv = usb_get_serial_port_data(port);
1344 unsigned long flags;
David Brownell5c09d142006-10-13 15:57:58 -07001345
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346 int result = 0;
1347 char buf[1]; /* Needed for the usb_control_msg I think */
1348
1349 dbg("%s", __FUNCTION__);
1350
Ian Abbott22465402006-06-26 12:59:17 +01001351 spin_lock_irqsave(&priv->tx_lock, flags);
1352 priv->tx_bytes = 0;
1353 spin_unlock_irqrestore(&priv->tx_lock, flags);
1354 spin_lock_irqsave(&priv->rx_lock, flags);
1355 priv->rx_bytes = 0;
1356 spin_unlock_irqrestore(&priv->rx_lock, flags);
1357
Guennadi Liakhovetski57845bd2006-04-13 22:27:12 +02001358 if (port->tty)
1359 port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360
1361 /* No error checking for this (will get errors later anyway) */
1362 /* See ftdi_sio.h for description of what is reset */
1363 usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07001364 FTDI_SIO_RESET_REQUEST, FTDI_SIO_RESET_REQUEST_TYPE,
1365 FTDI_SIO_RESET_SIO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 priv->interface, buf, 0, WDR_TIMEOUT);
1367
1368 /* Termios defaults are set by usb_serial_init. We don't change
1369 port->tty->termios - this would loose speed settings, etc.
1370 This is same behaviour as serial.c/rs_open() - Kuba */
1371
1372 /* ftdi_set_termios will send usb control messages */
Guennadi Liakhovetski57845bd2006-04-13 22:27:12 +02001373 if (port->tty)
1374 ftdi_set_termios(port, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375
1376 /* FIXME: Flow control might be enabled, so it should be checked -
1377 we have no control of defaults! */
1378 /* Turn on RTS and DTR since we are not flow controlling by default */
Ian Abbott74ede0f2005-07-29 12:16:41 -07001379 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380
1381 /* Not throttled */
1382 spin_lock_irqsave(&priv->rx_lock, flags);
1383 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
1384 spin_unlock_irqrestore(&priv->rx_lock, flags);
1385
1386 /* Start reading from the device */
Ian Abbott76854ce2005-06-02 10:34:11 +01001387 priv->rx_processed = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 usb_fill_bulk_urb(port->read_urb, dev,
1389 usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress),
1390 port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
1391 ftdi_read_bulk_callback, port);
1392 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
1393 if (result)
1394 err("%s - failed submitting read urb, error %d", __FUNCTION__, result);
1395
1396
1397 return result;
1398} /* ftdi_open */
1399
1400
1401
David Brownell5c09d142006-10-13 15:57:58 -07001402/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 * usbserial:__serial_close only calls ftdi_close if the point is open
1404 *
1405 * This only gets called when it is the last close
David Brownell5c09d142006-10-13 15:57:58 -07001406 *
1407 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408 */
1409
1410static void ftdi_close (struct usb_serial_port *port, struct file *filp)
1411{ /* ftdi_close */
1412 unsigned int c_cflag = port->tty->termios->c_cflag;
1413 struct ftdi_private *priv = usb_get_serial_port_data(port);
1414 char buf[1];
1415
1416 dbg("%s", __FUNCTION__);
1417
1418 if (c_cflag & HUPCL){
1419 /* Disable flow control */
David Brownell5c09d142006-10-13 15:57:58 -07001420 if (usb_control_msg(port->serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 usb_sndctrlpipe(port->serial->dev, 0),
1422 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1423 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1424 0, priv->interface, buf, 0,
1425 WDR_TIMEOUT) < 0) {
1426 err("error from flowcontrol urb");
David Brownell5c09d142006-10-13 15:57:58 -07001427 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428
Ian Abbott74ede0f2005-07-29 12:16:41 -07001429 /* drop RTS and DTR */
1430 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431 } /* Note change no line if hupcl is off */
Ian Abbott76854ce2005-06-02 10:34:11 +01001432
1433 /* cancel any scheduled reading */
1434 cancel_delayed_work(&priv->rx_work);
1435 flush_scheduled_work();
David Brownell5c09d142006-10-13 15:57:58 -07001436
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437 /* shutdown our bulk read */
Mariusz Kozlowski794c9442006-11-08 15:36:25 +01001438 usb_kill_urb(port->read_urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439} /* ftdi_close */
1440
1441
David Brownell5c09d142006-10-13 15:57:58 -07001442
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443/* The SIO requires the first byte to have:
1444 * B0 1
1445 * B1 0
1446 * B2..7 length of message excluding byte 0
1447 *
1448 * The new devices do not require this byte
1449 */
1450static int ftdi_write (struct usb_serial_port *port,
1451 const unsigned char *buf, int count)
1452{ /* ftdi_write */
1453 struct ftdi_private *priv = usb_get_serial_port_data(port);
1454 struct urb *urb;
1455 unsigned char *buffer;
1456 int data_offset ; /* will be 1 for the SIO and 0 otherwise */
1457 int status;
1458 int transfer_size;
Ian Abbott22465402006-06-26 12:59:17 +01001459 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460
1461 dbg("%s port %d, %d bytes", __FUNCTION__, port->number, count);
1462
1463 if (count == 0) {
1464 dbg("write request of 0 bytes");
1465 return 0;
1466 }
Ian Abbott22465402006-06-26 12:59:17 +01001467 spin_lock_irqsave(&priv->tx_lock, flags);
1468 if (priv->tx_outstanding_urbs > URB_UPPER_LIMIT) {
1469 spin_unlock_irqrestore(&priv->tx_lock, flags);
1470 dbg("%s - write limit hit\n", __FUNCTION__);
1471 return 0;
1472 }
Oliver Neukum62127a52007-03-23 14:30:16 +01001473 priv->tx_outstanding_urbs++;
Ian Abbott22465402006-06-26 12:59:17 +01001474 spin_unlock_irqrestore(&priv->tx_lock, flags);
David Brownell5c09d142006-10-13 15:57:58 -07001475
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476 data_offset = priv->write_offset;
1477 dbg("data_offset set to %d",data_offset);
1478
1479 /* Determine total transfer size */
1480 transfer_size = count;
1481 if (data_offset > 0) {
1482 /* Original sio needs control bytes too... */
1483 transfer_size += (data_offset *
1484 ((count + (PKTSZ - 1 - data_offset)) /
1485 (PKTSZ - data_offset)));
1486 }
1487
1488 buffer = kmalloc (transfer_size, GFP_ATOMIC);
1489 if (!buffer) {
1490 err("%s ran out of kernel memory for urb ...", __FUNCTION__);
Oliver Neukum62127a52007-03-23 14:30:16 +01001491 count = -ENOMEM;
1492 goto error_no_buffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493 }
1494
1495 urb = usb_alloc_urb(0, GFP_ATOMIC);
1496 if (!urb) {
1497 err("%s - no more free urbs", __FUNCTION__);
Oliver Neukum62127a52007-03-23 14:30:16 +01001498 count = -ENOMEM;
1499 goto error_no_urb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500 }
1501
1502 /* Copy data */
1503 if (data_offset > 0) {
1504 /* Original sio requires control byte at start of each packet. */
1505 int user_pktsz = PKTSZ - data_offset;
1506 int todo = count;
1507 unsigned char *first_byte = buffer;
1508 const unsigned char *current_position = buf;
1509
1510 while (todo > 0) {
1511 if (user_pktsz > todo) {
1512 user_pktsz = todo;
1513 }
1514 /* Write the control byte at the front of the packet*/
David Brownell5c09d142006-10-13 15:57:58 -07001515 *first_byte = 1 | ((user_pktsz) << 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516 /* Copy data for packet */
1517 memcpy (first_byte + data_offset,
1518 current_position, user_pktsz);
1519 first_byte += user_pktsz + data_offset;
1520 current_position += user_pktsz;
1521 todo -= user_pktsz;
1522 }
1523 } else {
1524 /* No control byte required. */
1525 /* Copy in the data to send */
1526 memcpy (buffer, buf, count);
1527 }
1528
1529 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, transfer_size, buffer);
1530
1531 /* fill the buffer and send it */
David Brownell5c09d142006-10-13 15:57:58 -07001532 usb_fill_bulk_urb(urb, port->serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533 usb_sndbulkpipe(port->serial->dev, port->bulk_out_endpointAddress),
1534 buffer, transfer_size,
1535 ftdi_write_bulk_callback, port);
1536
1537 status = usb_submit_urb(urb, GFP_ATOMIC);
1538 if (status) {
1539 err("%s - failed submitting write urb, error %d", __FUNCTION__, status);
1540 count = status;
Oliver Neukum62127a52007-03-23 14:30:16 +01001541 goto error;
Ian Abbott22465402006-06-26 12:59:17 +01001542 } else {
1543 spin_lock_irqsave(&priv->tx_lock, flags);
Ian Abbott22465402006-06-26 12:59:17 +01001544 priv->tx_outstanding_bytes += count;
1545 priv->tx_bytes += count;
1546 spin_unlock_irqrestore(&priv->tx_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547 }
1548
1549 /* we are done with this urb, so let the host driver
1550 * really free it when it is finished with it */
Oliver Neukum62127a52007-03-23 14:30:16 +01001551 usb_free_urb(urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552
1553 dbg("%s write returning: %d", __FUNCTION__, count);
1554 return count;
Oliver Neukum62127a52007-03-23 14:30:16 +01001555error:
1556 usb_free_urb(urb);
1557error_no_urb:
1558 kfree (buffer);
1559error_no_buffer:
1560 spin_lock_irqsave(&priv->tx_lock, flags);
1561 priv->tx_outstanding_urbs--;
1562 spin_unlock_irqrestore(&priv->tx_lock, flags);
1563 return count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564} /* ftdi_write */
1565
1566
1567/* This function may get called when the device is closed */
1568
David Howells7d12e782006-10-05 14:55:46 +01001569static void ftdi_write_bulk_callback (struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570{
Ian Abbott22465402006-06-26 12:59:17 +01001571 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
Ian Abbott22465402006-06-26 12:59:17 +01001573 struct ftdi_private *priv;
1574 int data_offset; /* will be 1 for the SIO and 0 otherwise */
1575 unsigned long countback;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576
1577 /* free up the transfer buffer, as usb_free_urb() does not do this */
1578 kfree (urb->transfer_buffer);
1579
1580 dbg("%s - port %d", __FUNCTION__, port->number);
David Brownell5c09d142006-10-13 15:57:58 -07001581
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582 if (urb->status) {
1583 dbg("nonzero write bulk status received: %d", urb->status);
1584 return;
1585 }
1586
Ian Abbott22465402006-06-26 12:59:17 +01001587 priv = usb_get_serial_port_data(port);
1588 if (!priv) {
1589 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1590 return;
1591 }
1592 /* account for transferred data */
1593 countback = urb->actual_length;
1594 data_offset = priv->write_offset;
1595 if (data_offset > 0) {
1596 /* Subtract the control bytes */
1597 countback -= (data_offset * ((countback + (PKTSZ - 1)) / PKTSZ));
1598 }
1599 spin_lock_irqsave(&priv->tx_lock, flags);
1600 --priv->tx_outstanding_urbs;
1601 priv->tx_outstanding_bytes -= countback;
1602 spin_unlock_irqrestore(&priv->tx_lock, flags);
1603
Pete Zaitcevcf2c7482006-05-22 21:58:49 -07001604 usb_serial_port_softint(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605} /* ftdi_write_bulk_callback */
1606
1607
1608static int ftdi_write_room( struct usb_serial_port *port )
1609{
Ian Abbott22465402006-06-26 12:59:17 +01001610 struct ftdi_private *priv = usb_get_serial_port_data(port);
1611 int room;
1612 unsigned long flags;
1613
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614 dbg("%s - port %d", __FUNCTION__, port->number);
1615
Ian Abbott22465402006-06-26 12:59:17 +01001616 spin_lock_irqsave(&priv->tx_lock, flags);
1617 if (priv->tx_outstanding_urbs < URB_UPPER_LIMIT) {
1618 /*
1619 * We really can take anything the user throws at us
1620 * but let's pick a nice big number to tell the tty
1621 * layer that we have lots of free space
1622 */
1623 room = 2048;
1624 } else {
1625 room = 0;
1626 }
1627 spin_unlock_irqrestore(&priv->tx_lock, flags);
1628 return room;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629} /* ftdi_write_room */
1630
1631
1632static int ftdi_chars_in_buffer (struct usb_serial_port *port)
1633{ /* ftdi_chars_in_buffer */
Ian Abbott22465402006-06-26 12:59:17 +01001634 struct ftdi_private *priv = usb_get_serial_port_data(port);
1635 int buffered;
1636 unsigned long flags;
1637
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 dbg("%s - port %d", __FUNCTION__, port->number);
1639
Ian Abbott22465402006-06-26 12:59:17 +01001640 spin_lock_irqsave(&priv->tx_lock, flags);
1641 buffered = (int)priv->tx_outstanding_bytes;
1642 spin_unlock_irqrestore(&priv->tx_lock, flags);
1643 if (buffered < 0) {
1644 err("%s outstanding tx bytes is negative!", __FUNCTION__);
1645 buffered = 0;
1646 }
1647 return buffered;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648} /* ftdi_chars_in_buffer */
1649
1650
1651
David Howells7d12e782006-10-05 14:55:46 +01001652static void ftdi_read_bulk_callback (struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653{ /* ftdi_read_bulk_callback */
1654 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1655 struct tty_struct *tty;
1656 struct ftdi_private *priv;
Ian Abbott22465402006-06-26 12:59:17 +01001657 unsigned long countread;
1658 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659
1660 if (urb->number_of_packets > 0) {
1661 err("%s transfer_buffer_length %d actual_length %d number of packets %d",__FUNCTION__,
1662 urb->transfer_buffer_length, urb->actual_length, urb->number_of_packets );
1663 err("%s transfer_flags %x ", __FUNCTION__,urb->transfer_flags );
1664 }
1665
1666 dbg("%s - port %d", __FUNCTION__, port->number);
1667
1668 if (port->open_count <= 0)
1669 return;
1670
1671 tty = port->tty;
1672 if (!tty) {
1673 dbg("%s - bad tty pointer - exiting",__FUNCTION__);
1674 return;
1675 }
1676
1677 priv = usb_get_serial_port_data(port);
1678 if (!priv) {
1679 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1680 return;
1681 }
1682
1683 if (urb != port->read_urb) {
1684 err("%s - Not my urb!", __FUNCTION__);
1685 }
1686
1687 if (urb->status) {
1688 /* This will happen at close every time so it is a dbg not an err */
1689 dbg("(this is ok on close) nonzero read bulk status received: %d", urb->status);
1690 return;
1691 }
1692
Ian Abbott22465402006-06-26 12:59:17 +01001693 /* count data bytes, but not status bytes */
1694 countread = urb->actual_length;
1695 countread -= 2 * ((countread + (PKTSZ - 1)) / PKTSZ);
1696 spin_lock_irqsave(&priv->rx_lock, flags);
1697 priv->rx_bytes += countread;
1698 spin_unlock_irqrestore(&priv->rx_lock, flags);
1699
David Howellsc4028952006-11-22 14:57:56 +00001700 ftdi_process_read(&priv->rx_work.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701
1702} /* ftdi_read_bulk_callback */
1703
1704
David Howellsc4028952006-11-22 14:57:56 +00001705static void ftdi_process_read (struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706{ /* ftdi_process_read */
David Howellsc4028952006-11-22 14:57:56 +00001707 struct ftdi_private *priv =
1708 container_of(work, struct ftdi_private, rx_work.work);
1709 struct usb_serial_port *port = priv->port;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710 struct urb *urb;
1711 struct tty_struct *tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712 char error_flag;
David Brownell5c09d142006-10-13 15:57:58 -07001713 unsigned char *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714
1715 int i;
1716 int result;
1717 int need_flip;
1718 int packet_offset;
Ian Abbott76854ce2005-06-02 10:34:11 +01001719 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720
1721 dbg("%s - port %d", __FUNCTION__, port->number);
1722
1723 if (port->open_count <= 0)
1724 return;
1725
1726 tty = port->tty;
1727 if (!tty) {
1728 dbg("%s - bad tty pointer - exiting",__FUNCTION__);
1729 return;
1730 }
1731
1732 priv = usb_get_serial_port_data(port);
1733 if (!priv) {
1734 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1735 return;
1736 }
1737
1738 urb = port->read_urb;
1739 if (!urb) {
1740 dbg("%s - bad read_urb pointer - exiting", __FUNCTION__);
1741 return;
1742 }
1743
1744 data = urb->transfer_buffer;
1745
Ian Abbott76854ce2005-06-02 10:34:11 +01001746 if (priv->rx_processed) {
1747 dbg("%s - already processed: %d bytes, %d remain", __FUNCTION__,
1748 priv->rx_processed,
1749 urb->actual_length - priv->rx_processed);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750 } else {
Ian Abbott76854ce2005-06-02 10:34:11 +01001751 /* The first two bytes of every read packet are status */
1752 if (urb->actual_length > 2) {
1753 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
1754 } else {
1755 dbg("Status only: %03oo %03oo",data[0],data[1]);
1756 }
1757 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758
1759
1760 /* TO DO -- check for hung up line and handle appropriately: */
1761 /* send hangup */
1762 /* See acm.c - you do a tty_hangup - eg tty_hangup(tty) */
1763 /* if CD is dropped and the line is not CLOCAL then we should hangup */
1764
1765 need_flip = 0;
Ian Abbott76854ce2005-06-02 10:34:11 +01001766 for (packet_offset = priv->rx_processed; packet_offset < urb->actual_length; packet_offset += PKTSZ) {
1767 int length;
1768
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769 /* Compare new line status to the old one, signal if different */
Ian Abbott76854ce2005-06-02 10:34:11 +01001770 /* N.B. packet may be processed more than once, but differences
1771 * are only processed once. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772 if (priv != NULL) {
1773 char new_status = data[packet_offset+0] & FTDI_STATUS_B0_MASK;
1774 if (new_status != priv->prev_status) {
1775 priv->diff_status |= new_status ^ priv->prev_status;
1776 wake_up_interruptible(&priv->delta_msr_wait);
1777 priv->prev_status = new_status;
1778 }
1779 }
1780
Ian Abbott76854ce2005-06-02 10:34:11 +01001781 length = min(PKTSZ, urb->actual_length-packet_offset)-2;
1782 if (length < 0) {
1783 err("%s - bad packet length: %d", __FUNCTION__, length+2);
1784 length = 0;
1785 }
1786
Ian Abbott76854ce2005-06-02 10:34:11 +01001787 if (priv->rx_flags & THROTTLED) {
1788 dbg("%s - throttled", __FUNCTION__);
1789 break;
1790 }
Alan Cox33f0f882006-01-09 20:54:13 -08001791 if (tty_buffer_request_room(tty, length) < length) {
Ian Abbott76854ce2005-06-02 10:34:11 +01001792 /* break out & wait for throttling/unthrottling to happen */
1793 dbg("%s - receive room low", __FUNCTION__);
1794 break;
1795 }
1796
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797 /* Handle errors and break */
1798 error_flag = TTY_NORMAL;
1799 /* Although the device uses a bitmask and hence can have multiple */
1800 /* errors on a packet - the order here sets the priority the */
1801 /* error is returned to the tty layer */
1802
1803 if ( data[packet_offset+1] & FTDI_RS_OE ) {
1804 error_flag = TTY_OVERRUN;
1805 dbg("OVERRRUN error");
1806 }
1807 if ( data[packet_offset+1] & FTDI_RS_BI ) {
1808 error_flag = TTY_BREAK;
1809 dbg("BREAK received");
1810 }
1811 if ( data[packet_offset+1] & FTDI_RS_PE ) {
1812 error_flag = TTY_PARITY;
1813 dbg("PARITY error");
1814 }
1815 if ( data[packet_offset+1] & FTDI_RS_FE ) {
1816 error_flag = TTY_FRAME;
1817 dbg("FRAMING error");
1818 }
Ian Abbott76854ce2005-06-02 10:34:11 +01001819 if (length > 0) {
1820 for (i = 2; i < length+2; i++) {
David Brownell5c09d142006-10-13 15:57:58 -07001821 /* Note that the error flag is duplicated for
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822 every character received since we don't know
1823 which character it applied to */
1824 tty_insert_flip_char(tty, data[packet_offset+i], error_flag);
1825 }
1826 need_flip = 1;
1827 }
1828
1829#ifdef NOT_CORRECT_BUT_KEEPING_IT_FOR_NOW
1830 /* if a parity error is detected you get status packets forever
1831 until a character is sent without a parity error.
1832 This doesn't work well since the application receives a never
1833 ending stream of bad data - even though new data hasn't been sent.
1834 Therefore I (bill) have taken this out.
David Brownell5c09d142006-10-13 15:57:58 -07001835 However - this might make sense for framing errors and so on
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836 so I am leaving the code in for now.
1837 */
1838 else {
1839 if (error_flag != TTY_NORMAL){
1840 dbg("error_flag is not normal");
1841 /* In this case it is just status - if that is an error send a bad character */
1842 if(tty->flip.count >= TTY_FLIPBUF_SIZE) {
1843 tty_flip_buffer_push(tty);
1844 }
1845 tty_insert_flip_char(tty, 0xff, error_flag);
1846 need_flip = 1;
1847 }
1848 }
1849#endif
1850 } /* "for(packet_offset=0..." */
1851
1852 /* Low latency */
1853 if (need_flip) {
1854 tty_flip_buffer_push(tty);
1855 }
1856
Ian Abbott76854ce2005-06-02 10:34:11 +01001857 if (packet_offset < urb->actual_length) {
1858 /* not completely processed - record progress */
1859 priv->rx_processed = packet_offset;
1860 dbg("%s - incomplete, %d bytes processed, %d remain",
1861 __FUNCTION__, packet_offset,
1862 urb->actual_length - packet_offset);
1863 /* check if we were throttled while processing */
1864 spin_lock_irqsave(&priv->rx_lock, flags);
1865 if (priv->rx_flags & THROTTLED) {
1866 priv->rx_flags |= ACTUALLY_THROTTLED;
1867 spin_unlock_irqrestore(&priv->rx_lock, flags);
1868 dbg("%s - deferring remainder until unthrottled",
1869 __FUNCTION__);
1870 return;
1871 }
1872 spin_unlock_irqrestore(&priv->rx_lock, flags);
1873 /* if the port is closed stop trying to read */
1874 if (port->open_count > 0){
1875 /* delay processing of remainder */
1876 schedule_delayed_work(&priv->rx_work, 1);
1877 } else {
1878 dbg("%s - port is closed", __FUNCTION__);
1879 }
1880 return;
1881 }
1882
1883 /* urb is completely processed */
1884 priv->rx_processed = 0;
1885
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886 /* if the port is closed stop trying to read */
1887 if (port->open_count > 0){
1888 /* Continue trying to always read */
David Brownell5c09d142006-10-13 15:57:58 -07001889 usb_fill_bulk_urb(port->read_urb, port->serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890 usb_rcvbulkpipe(port->serial->dev, port->bulk_in_endpointAddress),
1891 port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
1892 ftdi_read_bulk_callback, port);
1893
1894 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1895 if (result)
1896 err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
1897 }
1898
1899 return;
1900} /* ftdi_process_read */
1901
1902
1903static void ftdi_break_ctl( struct usb_serial_port *port, int break_state )
1904{
1905 struct ftdi_private *priv = usb_get_serial_port_data(port);
David Brownell5c09d142006-10-13 15:57:58 -07001906 __u16 urb_value = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001907 char buf[1];
David Brownell5c09d142006-10-13 15:57:58 -07001908
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909 /* break_state = -1 to turn on break, and 0 to turn off break */
1910 /* see drivers/char/tty_io.c to see it used */
1911 /* last_set_data_urb_value NEVER has the break bit set in it */
1912
1913 if (break_state) {
1914 urb_value = priv->last_set_data_urb_value | FTDI_SIO_SET_BREAK;
1915 } else {
David Brownell5c09d142006-10-13 15:57:58 -07001916 urb_value = priv->last_set_data_urb_value;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001917 }
1918
David Brownell5c09d142006-10-13 15:57:58 -07001919
Linus Torvalds1da177e2005-04-16 15:20:36 -07001920 if (usb_control_msg(port->serial->dev, usb_sndctrlpipe(port->serial->dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07001921 FTDI_SIO_SET_DATA_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922 FTDI_SIO_SET_DATA_REQUEST_TYPE,
1923 urb_value , priv->interface,
1924 buf, 0, WDR_TIMEOUT) < 0) {
1925 err("%s FAILED to enable/disable break state (state was %d)", __FUNCTION__,break_state);
David Brownell5c09d142006-10-13 15:57:58 -07001926 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001927
1928 dbg("%s break state is %d - urb is %d", __FUNCTION__,break_state, urb_value);
David Brownell5c09d142006-10-13 15:57:58 -07001929
Linus Torvalds1da177e2005-04-16 15:20:36 -07001930}
1931
1932
1933/* old_termios contains the original termios settings and tty->termios contains
1934 * the new setting to be used
1935 * WARNING: set_termios calls this with old_termios in kernel space
1936 */
1937
Alan Cox606d0992006-12-08 02:38:45 -08001938static void ftdi_set_termios (struct usb_serial_port *port, struct ktermios *old_termios)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939{ /* ftdi_termios */
1940 struct usb_device *dev = port->serial->dev;
1941 unsigned int cflag = port->tty->termios->c_cflag;
1942 struct ftdi_private *priv = usb_get_serial_port_data(port);
1943 __u16 urb_value; /* will hold the new flags */
1944 char buf[1]; /* Perhaps I should dynamically alloc this? */
David Brownell5c09d142006-10-13 15:57:58 -07001945
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946 // Added for xon/xoff support
1947 unsigned int iflag = port->tty->termios->c_iflag;
1948 unsigned char vstop;
1949 unsigned char vstart;
David Brownell5c09d142006-10-13 15:57:58 -07001950
Linus Torvalds1da177e2005-04-16 15:20:36 -07001951 dbg("%s", __FUNCTION__);
1952
1953 /* Force baud rate if this device requires it, unless it is set to B0. */
1954 if (priv->force_baud && ((port->tty->termios->c_cflag & CBAUD) != B0)) {
1955 dbg("%s: forcing baud rate for this device", __FUNCTION__);
1956 port->tty->termios->c_cflag &= ~CBAUD;
1957 port->tty->termios->c_cflag |= priv->force_baud;
1958 }
1959
1960 /* Force RTS-CTS if this device requires it. */
1961 if (priv->force_rtscts) {
1962 dbg("%s: forcing rtscts for this device", __FUNCTION__);
1963 port->tty->termios->c_cflag |= CRTSCTS;
1964 }
1965
1966 cflag = port->tty->termios->c_cflag;
1967
David Brownell5c09d142006-10-13 15:57:58 -07001968 /* FIXME -For this cut I don't care if the line is really changing or
1969 not - so just do the change regardless - should be able to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970 compare old_termios and tty->termios */
David Brownell5c09d142006-10-13 15:57:58 -07001971 /* NOTE These routines can get interrupted by
1972 ftdi_sio_read_bulk_callback - need to examine what this
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973 means - don't see any problems yet */
David Brownell5c09d142006-10-13 15:57:58 -07001974
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975 /* Set number of data bits, parity, stop bits */
David Brownell5c09d142006-10-13 15:57:58 -07001976
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977 urb_value = 0;
1978 urb_value |= (cflag & CSTOPB ? FTDI_SIO_SET_DATA_STOP_BITS_2 :
1979 FTDI_SIO_SET_DATA_STOP_BITS_1);
David Brownell5c09d142006-10-13 15:57:58 -07001980 urb_value |= (cflag & PARENB ?
1981 (cflag & PARODD ? FTDI_SIO_SET_DATA_PARITY_ODD :
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982 FTDI_SIO_SET_DATA_PARITY_EVEN) :
1983 FTDI_SIO_SET_DATA_PARITY_NONE);
1984 if (cflag & CSIZE) {
1985 switch (cflag & CSIZE) {
1986 case CS5: urb_value |= 5; dbg("Setting CS5"); break;
1987 case CS6: urb_value |= 6; dbg("Setting CS6"); break;
1988 case CS7: urb_value |= 7; dbg("Setting CS7"); break;
1989 case CS8: urb_value |= 8; dbg("Setting CS8"); break;
1990 default:
1991 err("CSIZE was set but not CS5-CS8");
1992 }
1993 }
1994
1995 /* This is needed by the break command since it uses the same command - but is
1996 * or'ed with this value */
1997 priv->last_set_data_urb_value = urb_value;
David Brownell5c09d142006-10-13 15:57:58 -07001998
Linus Torvalds1da177e2005-04-16 15:20:36 -07001999 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002000 FTDI_SIO_SET_DATA_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001 FTDI_SIO_SET_DATA_REQUEST_TYPE,
2002 urb_value , priv->interface,
Ian Abbott279e1542005-07-29 12:16:52 -07002003 buf, 0, WDR_SHORT_TIMEOUT) < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002004 err("%s FAILED to set databits/stopbits/parity", __FUNCTION__);
David Brownell5c09d142006-10-13 15:57:58 -07002005 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006
2007 /* Now do the baudrate */
2008 if ((cflag & CBAUD) == B0 ) {
2009 /* Disable flow control */
2010 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002011 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002012 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07002013 0, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014 buf, 0, WDR_TIMEOUT) < 0) {
2015 err("%s error from disable flowcontrol urb", __FUNCTION__);
David Brownell5c09d142006-10-13 15:57:58 -07002016 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002017 /* Drop RTS and DTR */
Ian Abbott74ede0f2005-07-29 12:16:41 -07002018 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019 } else {
2020 /* set the baudrate determined before */
2021 if (change_speed(port)) {
Peter Favrholdt72a755f2005-09-22 00:48:49 -07002022 err("%s urb failed to set baudrate", __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002023 }
Peter Favrholdt72a755f2005-09-22 00:48:49 -07002024 /* Ensure RTS and DTR are raised when baudrate changed from 0 */
Guennadi Liakhovetski57845bd2006-04-13 22:27:12 +02002025 if (!old_termios || (old_termios->c_cflag & CBAUD) == B0) {
Peter Favrholdt72a755f2005-09-22 00:48:49 -07002026 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2027 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028 }
2029
2030 /* Set flow control */
2031 /* Note device also supports DTR/CD (ugh) and Xon/Xoff in hardware */
2032 if (cflag & CRTSCTS) {
2033 dbg("%s Setting to CRTSCTS flow control", __FUNCTION__);
David Brownell5c09d142006-10-13 15:57:58 -07002034 if (usb_control_msg(dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035 usb_sndctrlpipe(dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002036 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2038 0 , (FTDI_SIO_RTS_CTS_HS | priv->interface),
2039 buf, 0, WDR_TIMEOUT) < 0) {
2040 err("urb failed to set to rts/cts flow control");
David Brownell5c09d142006-10-13 15:57:58 -07002041 }
2042
2043 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044 /*
2045 * Xon/Xoff code
2046 *
2047 * Check the IXOFF status in the iflag component of the termios structure
2048 * if IXOFF is not set, the pre-xon/xoff code is executed.
2049 */
2050 if (iflag & IXOFF) {
2051 dbg("%s request to enable xonxoff iflag=%04x",__FUNCTION__,iflag);
2052 // Try to enable the XON/XOFF on the ftdi_sio
2053 // Set the vstart and vstop -- could have been done up above where
2054 // a lot of other dereferencing is done but that would be very
2055 // inefficient as vstart and vstop are not always needed
2056 vstart=port->tty->termios->c_cc[VSTART];
2057 vstop=port->tty->termios->c_cc[VSTOP];
2058 urb_value=(vstop << 8) | (vstart);
2059
2060 if (usb_control_msg(dev,
2061 usb_sndctrlpipe(dev, 0),
2062 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2063 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2064 urb_value , (FTDI_SIO_XON_XOFF_HS
2065 | priv->interface),
2066 buf, 0, WDR_TIMEOUT) < 0) {
2067 err("urb failed to set to xon/xoff flow control");
2068 }
2069 } else {
2070 /* else clause to only run if cfag ! CRTSCTS and iflag ! XOFF */
2071 /* CHECKME Assuming XON/XOFF handled by tty stack - not by device */
2072 dbg("%s Turning off hardware flow control", __FUNCTION__);
David Brownell5c09d142006-10-13 15:57:58 -07002073 if (usb_control_msg(dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074 usb_sndctrlpipe(dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002075 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07002077 0, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078 buf, 0, WDR_TIMEOUT) < 0) {
2079 err("urb failed to clear flow control");
David Brownell5c09d142006-10-13 15:57:58 -07002080 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081 }
David Brownell5c09d142006-10-13 15:57:58 -07002082
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 }
2084 return;
2085} /* ftdi_termios */
2086
2087
2088static int ftdi_tiocmget (struct usb_serial_port *port, struct file *file)
2089{
2090 struct ftdi_private *priv = usb_get_serial_port_data(port);
2091 unsigned char buf[2];
2092 int ret;
2093
2094 dbg("%s TIOCMGET", __FUNCTION__);
2095 switch (priv->chip_type) {
2096 case SIO:
2097 /* Request the status from the device */
David Brownell5c09d142006-10-13 15:57:58 -07002098 if ((ret = usb_control_msg(port->serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099 usb_rcvctrlpipe(port->serial->dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002100 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07002102 0, 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103 buf, 1, WDR_TIMEOUT)) < 0 ) {
2104 err("%s Could not get modem status of device - err: %d", __FUNCTION__,
2105 ret);
2106 return(ret);
2107 }
2108 break;
2109 case FT8U232AM:
2110 case FT232BM:
2111 case FT2232C:
2112 /* the 8U232AM returns a two byte value (the sio is a 1 byte value) - in the same
2113 format as the data returned from the in point */
David Brownell5c09d142006-10-13 15:57:58 -07002114 if ((ret = usb_control_msg(port->serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115 usb_rcvctrlpipe(port->serial->dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002116 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07002118 0, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119 buf, 2, WDR_TIMEOUT)) < 0 ) {
2120 err("%s Could not get modem status of device - err: %d", __FUNCTION__,
2121 ret);
2122 return(ret);
2123 }
2124 break;
2125 default:
2126 return -EFAULT;
2127 break;
2128 }
David Brownell5c09d142006-10-13 15:57:58 -07002129
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130 return (buf[0] & FTDI_SIO_DSR_MASK ? TIOCM_DSR : 0) |
2131 (buf[0] & FTDI_SIO_CTS_MASK ? TIOCM_CTS : 0) |
2132 (buf[0] & FTDI_SIO_RI_MASK ? TIOCM_RI : 0) |
2133 (buf[0] & FTDI_SIO_RLSD_MASK ? TIOCM_CD : 0) |
David Brownell5c09d142006-10-13 15:57:58 -07002134 priv->last_dtr_rts;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135}
2136
2137static int ftdi_tiocmset(struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear)
2138{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002139 dbg("%s TIOCMSET", __FUNCTION__);
Ian Abbott74ede0f2005-07-29 12:16:41 -07002140 return update_mctrl(port, set, clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141}
2142
2143
2144static int ftdi_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
2145{
2146 struct ftdi_private *priv = usb_get_serial_port_data(port);
2147
Linus Torvalds1da177e2005-04-16 15:20:36 -07002148 dbg("%s cmd 0x%04x", __FUNCTION__, cmd);
2149
2150 /* Based on code from acm.c and others */
2151 switch (cmd) {
2152
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153 case TIOCGSERIAL: /* gets serial port data */
2154 return get_serial_info(port, (struct serial_struct __user *) arg);
2155
2156 case TIOCSSERIAL: /* sets serial port data */
2157 return set_serial_info(port, (struct serial_struct __user *) arg);
2158
2159 /*
2160 * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
2161 * - mask passed in arg for lines of interest
2162 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
2163 * Caller should use TIOCGICOUNT to see which one it was.
2164 *
2165 * This code is borrowed from linux/drivers/char/serial.c
2166 */
2167 case TIOCMIWAIT:
2168 while (priv != NULL) {
2169 interruptible_sleep_on(&priv->delta_msr_wait);
2170 /* see if a signal did it */
2171 if (signal_pending(current))
2172 return -ERESTARTSYS;
2173 else {
2174 char diff = priv->diff_status;
2175
2176 if (diff == 0) {
2177 return -EIO; /* no change => error */
2178 }
2179
2180 /* Consume all events */
2181 priv->diff_status = 0;
2182
2183 /* Return 0 if caller wanted to know about these bits */
2184 if ( ((arg & TIOCM_RNG) && (diff & FTDI_RS0_RI)) ||
2185 ((arg & TIOCM_DSR) && (diff & FTDI_RS0_DSR)) ||
2186 ((arg & TIOCM_CD) && (diff & FTDI_RS0_RLSD)) ||
2187 ((arg & TIOCM_CTS) && (diff & FTDI_RS0_CTS)) ) {
2188 return 0;
2189 }
2190 /*
2191 * Otherwise caller can't care less about what happened,
2192 * and so we continue to wait for more events.
2193 */
2194 }
2195 }
2196 return(0);
2197 break;
2198 default:
2199 break;
David Brownell5c09d142006-10-13 15:57:58 -07002200
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201 }
2202
2203
David Brownell5c09d142006-10-13 15:57:58 -07002204 /* This is not necessarily an error - turns out the higher layers will do
Linus Torvalds1da177e2005-04-16 15:20:36 -07002205 * some ioctls itself (see comment above)
2206 */
2207 dbg("%s arg not supported - it was 0x%04x - check /usr/include/asm/ioctls.h", __FUNCTION__, cmd);
2208
2209 return(-ENOIOCTLCMD);
2210} /* ftdi_ioctl */
2211
2212
2213static void ftdi_throttle (struct usb_serial_port *port)
2214{
2215 struct ftdi_private *priv = usb_get_serial_port_data(port);
2216 unsigned long flags;
2217
2218 dbg("%s - port %d", __FUNCTION__, port->number);
2219
2220 spin_lock_irqsave(&priv->rx_lock, flags);
2221 priv->rx_flags |= THROTTLED;
2222 spin_unlock_irqrestore(&priv->rx_lock, flags);
2223}
2224
2225
2226static void ftdi_unthrottle (struct usb_serial_port *port)
2227{
2228 struct ftdi_private *priv = usb_get_serial_port_data(port);
2229 int actually_throttled;
2230 unsigned long flags;
2231
2232 dbg("%s - port %d", __FUNCTION__, port->number);
2233
2234 spin_lock_irqsave(&priv->rx_lock, flags);
2235 actually_throttled = priv->rx_flags & ACTUALLY_THROTTLED;
2236 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
2237 spin_unlock_irqrestore(&priv->rx_lock, flags);
2238
2239 if (actually_throttled)
David Howellsc4028952006-11-22 14:57:56 +00002240 schedule_delayed_work(&priv->rx_work, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241}
2242
2243static int __init ftdi_init (void)
2244{
2245 int retval;
2246
2247 dbg("%s", __FUNCTION__);
Ian Abbottfdcb0a02005-07-28 18:40:32 +01002248 if (vendor > 0 && product > 0) {
2249 /* Add user specified VID/PID to reserved element of table. */
2250 int i;
2251 for (i = 0; id_table_combined[i].idVendor; i++)
2252 ;
2253 id_table_combined[i].match_flags = USB_DEVICE_ID_MATCH_DEVICE;
2254 id_table_combined[i].idVendor = vendor;
2255 id_table_combined[i].idProduct = product;
2256 }
Ian Abbott8f977e42005-06-20 16:45:42 +01002257 retval = usb_serial_register(&ftdi_sio_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258 if (retval)
Ian Abbott8f977e42005-06-20 16:45:42 +01002259 goto failed_sio_register;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260 retval = usb_register(&ftdi_driver);
David Brownell5c09d142006-10-13 15:57:58 -07002261 if (retval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002262 goto failed_usb_register;
2263
2264 info(DRIVER_VERSION ":" DRIVER_DESC);
2265 return 0;
2266failed_usb_register:
Ian Abbott8f977e42005-06-20 16:45:42 +01002267 usb_serial_deregister(&ftdi_sio_device);
2268failed_sio_register:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002269 return retval;
2270}
2271
2272
2273static void __exit ftdi_exit (void)
2274{
2275
2276 dbg("%s", __FUNCTION__);
2277
2278 usb_deregister (&ftdi_driver);
Ian Abbott8f977e42005-06-20 16:45:42 +01002279 usb_serial_deregister (&ftdi_sio_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002280
2281}
2282
2283
2284module_init(ftdi_init);
2285module_exit(ftdi_exit);
2286
2287MODULE_AUTHOR( DRIVER_AUTHOR );
2288MODULE_DESCRIPTION( DRIVER_DESC );
2289MODULE_LICENSE("GPL");
2290
2291module_param(debug, bool, S_IRUGO | S_IWUSR);
2292MODULE_PARM_DESC(debug, "Debug enabled or not");
Ian Abbottfdcb0a02005-07-28 18:40:32 +01002293module_param(vendor, ushort, 0);
2294MODULE_PARM_DESC(vendor, "User specified vendor ID (default="
2295 __MODULE_STRING(FTDI_VID)")");
2296module_param(product, ushort, 0);
2297MODULE_PARM_DESC(vendor, "User specified product ID");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002298