blob: c40e77dccf8ea91224b94841e1f74efb9533613d [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
Jan Engelhardt96de0e22007-10-19 23:21:04 +020086 * Philipp Gühring's patch for 2.5.x kernel).
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 * 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
Oliver Neukum0ffbbe22007-07-09 12:03:08 -0700274struct ftdi_private {
275 ftdi_chip_type_t chip_type;
276 /* type of the device, either SIO or FT8U232AM */
277 int baud_base; /* baud base clock for divisor setting */
278 int custom_divisor; /* custom_divisor kludge, this is for baud_base (different from what goes to the chip!) */
279 __u16 last_set_data_urb_value ;
280 /* the last data state set - needed for doing a break */
281 int write_offset; /* This is the offset in the usb data block to write the serial data -
282 * it is different between devices
283 */
284 int flags; /* some ASYNC_xxxx flags are supported */
285 unsigned long last_dtr_rts; /* saved modem control outputs */
286 wait_queue_head_t delta_msr_wait; /* Used for TIOCMIWAIT */
287 char prev_status, diff_status; /* Used for TIOCMIWAIT */
288 __u8 rx_flags; /* receive state flags (throttling) */
289 spinlock_t rx_lock; /* spinlock for receive state */
290 struct delayed_work rx_work;
291 struct usb_serial_port *port;
292 int rx_processed;
293 unsigned long rx_bytes;
294
295 __u16 interface; /* FT2232C port interface (0 for FT232/245) */
296
Alan Cox669a6db2007-10-18 01:24:24 -0700297 speed_t force_baud; /* if non-zero, force the baud rate to this value */
Oliver Neukum0ffbbe22007-07-09 12:03:08 -0700298 int force_rtscts; /* if non-zero, force RTS-CTS to always be enabled */
299
300 spinlock_t tx_lock; /* spinlock for transmit state */
301 unsigned long tx_bytes;
302 unsigned long tx_outstanding_bytes;
303 unsigned long tx_outstanding_urbs;
304};
305
Ian Abbott8f977e42005-06-20 16:45:42 +0100306/* struct ftdi_sio_quirk is used by devices requiring special attention. */
307struct ftdi_sio_quirk {
Tony Lindgrenfa91d432007-05-04 18:23:24 -0700308 int (*probe)(struct usb_serial *);
Oliver Neukum0ffbbe22007-07-09 12:03:08 -0700309 void (*port_probe)(struct ftdi_private *); /* Special settings for probed ports. */
Ian Abbott8f977e42005-06-20 16:45:42 +0100310};
311
Tony Lindgrenfa91d432007-05-04 18:23:24 -0700312static int ftdi_olimex_probe (struct usb_serial *serial);
Oliver Neukum0ffbbe22007-07-09 12:03:08 -0700313static void ftdi_USB_UIRT_setup (struct ftdi_private *priv);
314static void ftdi_HE_TIRA1_setup (struct ftdi_private *priv);
Ian Abbott8f977e42005-06-20 16:45:42 +0100315
Tony Lindgrenfa91d432007-05-04 18:23:24 -0700316static struct ftdi_sio_quirk ftdi_olimex_quirk = {
317 .probe = ftdi_olimex_probe,
318};
319
Ian Abbott8f977e42005-06-20 16:45:42 +0100320static struct ftdi_sio_quirk ftdi_USB_UIRT_quirk = {
Oliver Neukum0ffbbe22007-07-09 12:03:08 -0700321 .port_probe = ftdi_USB_UIRT_setup,
Ian Abbott8f977e42005-06-20 16:45:42 +0100322};
323
324static struct ftdi_sio_quirk ftdi_HE_TIRA1_quirk = {
Oliver Neukum0ffbbe22007-07-09 12:03:08 -0700325 .port_probe = ftdi_HE_TIRA1_setup,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326};
327
328/*
329 * The 8U232AM has the same API as the sio except for:
330 * - it can support MUCH higher baudrates; up to:
331 * o 921600 for RS232 and 2000000 for RS422/485 at 48MHz
332 * o 230400 at 12MHz
333 * so .. 8U232AM's baudrate setting codes are different
334 * - it has a two byte status code.
335 * - it returns characters every 16ms (the FTDI does it every 40ms)
336 *
337 * the bcdDevice value is used to differentiate FT232BM and FT245BM from
338 * the earlier FT8U232AM and FT8U232BM. For now, include all known VID/PID
339 * combinations in both tables.
Ian Abbott8f977e42005-06-20 16:45:42 +0100340 * FIXME: perhaps bcdDevice can also identify 12MHz FT8U232AM devices,
341 * but I don't know if those ever went into mass production. [Ian Abbott]
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 */
343
344
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345
346static struct usb_device_id id_table_combined [] = {
Jonathan Davies2011e922006-08-09 10:48:03 +0100347 { USB_DEVICE(FTDI_VID, FTDI_AMC232_PID) },
348 { USB_DEVICE(FTDI_VID, FTDI_CANUSB_PID) },
Razvan Gavril72a9f952006-05-04 11:35:49 +0300349 { USB_DEVICE(FTDI_VID, FTDI_ACTZWAVE_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 { USB_DEVICE(FTDI_VID, FTDI_IRTRANS_PID) },
Luiz Fernando N. Capitulino69737df2006-04-11 15:52:41 -0300351 { USB_DEVICE(FTDI_VID, FTDI_IPLUS_PID) },
Luiz Fernando N. Capitulinod0993212007-06-21 22:34:23 -0300352 { USB_DEVICE(FTDI_VID, FTDI_IPLUS2_PID) },
Frank Sievertsenfad14a02006-10-20 09:43:53 +0200353 { USB_DEVICE(FTDI_VID, FTDI_DMX4ALL) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 { USB_DEVICE(FTDI_VID, FTDI_SIO_PID) },
355 { USB_DEVICE(FTDI_VID, FTDI_8U232AM_PID) },
356 { USB_DEVICE(FTDI_VID, FTDI_8U232AM_ALT_PID) },
Gard Spreemannd8b21602007-03-05 00:03:26 +0100357 { USB_DEVICE(FTDI_VID, FTDI_232RL_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 { USB_DEVICE(FTDI_VID, FTDI_8U2232C_PID) },
Christophe Mariacc0f8d562006-06-23 17:36:21 +0200359 { USB_DEVICE(FTDI_VID, FTDI_MICRO_CHAMELEON_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 { USB_DEVICE(FTDI_VID, FTDI_RELAIS_PID) },
Guido Scholz2adb80e2007-05-08 19:52:41 +0200361 { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_IOBOARD_PID) },
363 { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_MINI_IOBOARD_PID) },
364 { USB_DEVICE(FTDI_VID, FTDI_XF_632_PID) },
365 { USB_DEVICE(FTDI_VID, FTDI_XF_634_PID) },
366 { USB_DEVICE(FTDI_VID, FTDI_XF_547_PID) },
367 { USB_DEVICE(FTDI_VID, FTDI_XF_633_PID) },
368 { USB_DEVICE(FTDI_VID, FTDI_XF_631_PID) },
369 { USB_DEVICE(FTDI_VID, FTDI_XF_635_PID) },
370 { USB_DEVICE(FTDI_VID, FTDI_XF_640_PID) },
371 { USB_DEVICE(FTDI_VID, FTDI_XF_642_PID) },
372 { USB_DEVICE(FTDI_VID, FTDI_DSS20_PID) },
373 { USB_DEVICE(FTDI_NF_RIC_VID, FTDI_NF_RIC_PID) },
374 { USB_DEVICE(FTDI_VID, FTDI_VNHCPCUSB_D_PID) },
Ian Abbott8f977e42005-06-20 16:45:42 +0100375 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_0_PID) },
376 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_1_PID) },
377 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_2_PID) },
378 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_3_PID) },
379 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_4_PID) },
380 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_5_PID) },
381 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_6_PID) },
382 { USB_DEVICE(FTDI_VID, FTDI_PERLE_ULTRAPORT_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 { USB_DEVICE(FTDI_VID, FTDI_PIEGROUP_PID) },
Dave Platt274a4bb2006-07-18 21:26:54 -0700384 { USB_DEVICE(FTDI_VID, FTDI_TNC_X_PID) },
Jelle Foks868e4402007-03-25 21:08:35 -0400385 { USB_DEVICE(FTDI_VID, FTDI_USBX_707_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2101_PID) },
387 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2102_PID) },
388 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2103_PID) },
389 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2104_PID) },
Justin Carlsona1484822006-09-24 11:52:12 +0300390 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2106_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_1_PID) },
392 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_2_PID) },
393 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_1_PID) },
394 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_2_PID) },
395 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_1_PID) },
396 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_2_PID) },
397 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_1_PID) },
398 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_2_PID) },
399 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_3_PID) },
400 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_4_PID) },
401 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_1_PID) },
402 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_2_PID) },
403 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_3_PID) },
404 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_4_PID) },
405 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_1_PID) },
406 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_2_PID) },
407 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_3_PID) },
408 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_4_PID) },
409 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_1_PID) },
410 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_2_PID) },
411 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_3_PID) },
412 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_4_PID) },
413 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_5_PID) },
414 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_6_PID) },
415 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_7_PID) },
416 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_8_PID) },
417 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_1_PID) },
418 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_2_PID) },
419 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_3_PID) },
420 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_4_PID) },
421 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_5_PID) },
422 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_6_PID) },
423 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_7_PID) },
424 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_8_PID) },
425 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_1_PID) },
426 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_2_PID) },
427 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_3_PID) },
428 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_4_PID) },
429 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_5_PID) },
430 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_6_PID) },
431 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_7_PID) },
432 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_8_PID) },
433 { USB_DEVICE(IDTECH_VID, IDTECH_IDT1221U_PID) },
434 { USB_DEVICE(OCT_VID, OCT_US101_PID) },
Ian Abbott8f977e42005-06-20 16:45:42 +0100435 { USB_DEVICE(FTDI_VID, FTDI_HE_TIRA1_PID),
436 .driver_info = (kernel_ulong_t)&ftdi_HE_TIRA1_quirk },
437 { USB_DEVICE(FTDI_VID, FTDI_USB_UIRT_PID),
438 .driver_info = (kernel_ulong_t)&ftdi_USB_UIRT_quirk },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_1) },
440 { USB_DEVICE(FTDI_VID, PROTEGO_R2X0) },
441 { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_3) },
442 { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_4) },
Ian Abbott8f977e42005-06-20 16:45:42 +0100443 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E808_PID) },
444 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E809_PID) },
445 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80A_PID) },
446 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80B_PID) },
447 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80C_PID) },
448 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80D_PID) },
449 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80E_PID) },
450 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80F_PID) },
451 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E888_PID) },
452 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E889_PID) },
453 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88A_PID) },
454 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88B_PID) },
455 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88C_PID) },
456 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88D_PID) },
457 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88E_PID) },
458 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88F_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 { USB_DEVICE(FTDI_VID, FTDI_ELV_UO100_PID) },
Ian Abbott47900742005-05-17 15:12:13 +0100460 { USB_DEVICE(FTDI_VID, FTDI_ELV_UM100_PID) },
Ian Abbotte6ac4a42005-08-02 14:01:27 +0100461 { USB_DEVICE(FTDI_VID, FTDI_ELV_UR100_PID) },
462 { USB_DEVICE(FTDI_VID, FTDI_ELV_ALC8500_PID) },
Thomas Riewe207c47e2005-09-29 14:57:29 +0200463 { USB_DEVICE(FTDI_VID, FTDI_PYRAMID_PID) },
Martin Hagelinbde62182005-10-26 21:10:41 +0200464 { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1000PC_PID) },
Thomas Schleusener4eaf60e2007-02-28 22:50:52 +0100465 { USB_DEVICE(FTDI_VID, FTDI_IBS_US485_PID) },
466 { USB_DEVICE(FTDI_VID, FTDI_IBS_PICPRO_PID) },
467 { USB_DEVICE(FTDI_VID, FTDI_IBS_PCMCIA_PID) },
468 { USB_DEVICE(FTDI_VID, FTDI_IBS_PK1_PID) },
469 { USB_DEVICE(FTDI_VID, FTDI_IBS_RS232MON_PID) },
470 { USB_DEVICE(FTDI_VID, FTDI_IBS_APP70_PID) },
471 { USB_DEVICE(FTDI_VID, FTDI_IBS_PEDO_PID) },
472 { USB_DEVICE(FTDI_VID, FTDI_IBS_PROD_PID) },
Ian Abbotte6ac4a42005-08-02 14:01:27 +0100473 /*
474 * These will probably use user-space drivers. Uncomment them if
475 * you need them or use the user-specified vendor/product module
476 * parameters (see ftdi_sio.h for the numbers). Make a fuss if
477 * you think the driver should recognize any of them by default.
478 */
479 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_CLI7000_PID) }, */
480 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_PPS7330_PID) }, */
481 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_TFM100_PID) }, */
482 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UDF77_PID) }, */
483 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UIO88_PID) }, */
484 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UAD8_PID) }, */
485 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UDA7_PID) }, */
486 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_USI2_PID) }, */
487 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_T1100_PID) }, */
488 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_PCD200_PID) }, */
489 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_ULA200_PID) }, */
Ian Abbotte6ac4a42005-08-02 14:01:27 +0100490 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_CSI8_PID) }, */
491 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_EM1000DL_PID) }, */
492 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_PCK100_PID) }, */
493 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_RFP500_PID) }, */
494 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_FS20SIG_PID) }, */
495 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_WS300PC_PID) }, */
496 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1300PC_PID) }, */
497 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_WS500_PID) }, */
David Brownell5c09d142006-10-13 15:57:58 -0700498 { USB_DEVICE(FTDI_VID, LINX_SDMUSBQSS_PID) },
499 { USB_DEVICE(FTDI_VID, LINX_MASTERDEVEL2_PID) },
500 { USB_DEVICE(FTDI_VID, LINX_FUTURE_0_PID) },
501 { USB_DEVICE(FTDI_VID, LINX_FUTURE_1_PID) },
502 { USB_DEVICE(FTDI_VID, LINX_FUTURE_2_PID) },
503 { USB_DEVICE(FTDI_VID, FTDI_CCSICDU20_0_PID) },
504 { USB_DEVICE(FTDI_VID, FTDI_CCSICDU40_1_PID) },
Jan Capekec434e92006-11-28 22:35:12 +0100505 { USB_DEVICE(FTDI_VID, FTDI_CCSMACHX_2_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 { USB_DEVICE(FTDI_VID, INSIDE_ACCESSO) },
507 { USB_DEVICE(INTREPID_VID, INTREPID_VALUECAN_PID) },
508 { USB_DEVICE(INTREPID_VID, INTREPID_NEOVI_PID) },
509 { USB_DEVICE(FALCOM_VID, FALCOM_TWIST_PID) },
Ian Abbotte6ac4a42005-08-02 14:01:27 +0100510 { USB_DEVICE(FALCOM_VID, FALCOM_SAMBA_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 { USB_DEVICE(FTDI_VID, FTDI_SUUNTO_SPORTS_PID) },
Michael Olbergef31fec2007-02-27 12:57:12 +0100512 { USB_DEVICE(TTI_VID, TTI_QL355P_PID) },
Ian Abbott6f928722005-04-29 16:06:14 +0100513 { USB_DEVICE(FTDI_VID, FTDI_RM_CANVIEW_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 { USB_DEVICE(BANDB_VID, BANDB_USOTL4_PID) },
515 { USB_DEVICE(BANDB_VID, BANDB_USTL4_PID) },
516 { USB_DEVICE(BANDB_VID, BANDB_USO9ML2_PID) },
517 { USB_DEVICE(FTDI_VID, EVER_ECO_PRO_CDS) },
Ian Abbott6f928722005-04-29 16:06:14 +0100518 { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_1_PID) },
519 { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_2_PID) },
Ian Abbotte6ac4a42005-08-02 14:01:27 +0100520 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_0_PID) },
521 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_1_PID) },
522 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_2_PID) },
523 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_3_PID) },
524 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_4_PID) },
525 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_5_PID) },
526 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_6_PID) },
527 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_7_PID) },
Ian Abbott6f928722005-04-29 16:06:14 +0100528 { USB_DEVICE(MOBILITY_VID, MOBILITY_USB_SERIAL_PID) },
Ian Abbott8f977e42005-06-20 16:45:42 +0100529 { USB_DEVICE(FTDI_VID, FTDI_ACTIVE_ROBOTS_PID) },
Ian Abbott34d1a8a2006-02-27 14:05:32 +0000530 { USB_DEVICE(FTDI_VID, FTDI_MHAM_KW_PID) },
531 { USB_DEVICE(FTDI_VID, FTDI_MHAM_YS_PID) },
Ian Abbott9b1513d2005-07-29 12:16:31 -0700532 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y6_PID) },
533 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y8_PID) },
Ian Abbott34d1a8a2006-02-27 14:05:32 +0000534 { USB_DEVICE(FTDI_VID, FTDI_MHAM_IC_PID) },
535 { USB_DEVICE(FTDI_VID, FTDI_MHAM_DB9_PID) },
536 { USB_DEVICE(FTDI_VID, FTDI_MHAM_RS232_PID) },
537 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y9_PID) },
Ian Abbott740a4282005-12-13 16:18:47 +0000538 { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_VCP_PID) },
539 { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_D2XX_PID) },
Ian Abbott9b1513d2005-07-29 12:16:31 -0700540 { USB_DEVICE(EVOLUTION_VID, EVOLUTION_ER1_PID) },
Søren Haubergc1f8ea72007-08-08 10:50:17 +0200541 { USB_DEVICE(EVOLUTION_VID, EVO_HYBRID_PID) },
542 { USB_DEVICE(EVOLUTION_VID, EVO_RCM4_PID) },
Rui Santosc9c77462005-09-23 20:06:50 +0100543 { USB_DEVICE(FTDI_VID, FTDI_ARTEMIS_PID) },
544 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16_PID) },
Rui Santos09c280a2006-01-09 13:12:40 +0000545 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16C_PID) },
Rui Santosc9c77462005-09-23 20:06:50 +0100546 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HR_PID) },
Rui Santos09c280a2006-01-09 13:12:40 +0000547 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HRC_PID) },
Ian Abbottb4723ae2005-11-23 15:45:23 -0800548 { USB_DEVICE(KOBIL_VID, KOBIL_CONV_B1_PID) },
549 { USB_DEVICE(KOBIL_VID, KOBIL_CONV_KAAN_PID) },
Pavel Fedineffac8b2005-12-09 09:30:59 +0300550 { USB_DEVICE(POSIFLEX_VID, POSIFLEX_PP7000_PID) },
Louis Nyffenegger641adaa2006-01-05 17:20:37 +0100551 { USB_DEVICE(FTDI_VID, FTDI_TTUSB_PID) },
Ian Abbott7e1c0b82006-03-21 14:55:20 +0000552 { USB_DEVICE(FTDI_VID, FTDI_ECLO_COM_1WIRE_PID) },
Ian Abbotta94b52a2006-01-09 17:11:40 +0000553 { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_777_PID) },
554 { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_8900F_PID) },
Wouter Paesence40d292006-01-03 14:30:31 +0100555 { USB_DEVICE(FTDI_VID, FTDI_PCDJ_DAC2_PID) },
Nathan Bronsoncdd3b152006-04-10 00:05:09 -0400556 { USB_DEVICE(FTDI_VID, FTDI_RRCIRKITS_LOCOBUFFER_PID) },
Ian Abbott7e0258f2006-04-12 15:20:35 +0100557 { USB_DEVICE(FTDI_VID, FTDI_ASK_RDR400_PID) },
A. Maitland Bottomsbf58fbd2006-03-14 18:44:23 -0500558 { USB_DEVICE(ICOM_ID1_VID, ICOM_ID1_PID) },
Folkert van Heusden62a13db2006-03-28 20:41:26 +0900559 { USB_DEVICE(PAPOUCH_VID, PAPOUCH_TMU_PID) },
Ian Abbott20a0f472006-05-04 11:34:25 +0100560 { USB_DEVICE(FTDI_VID, FTDI_ACG_HFDUAL_PID) },
Ian Abbotteb79b4f2006-05-30 12:36:30 +0100561 { USB_DEVICE(FTDI_VID, FTDI_YEI_SERVOCENTER31_PID) },
D. Peter Siddons48437482006-06-17 18:09:15 -0400562 { USB_DEVICE(FTDI_VID, FTDI_THORLABS_PID) },
Colin Leroye1979fe2006-07-11 11:36:43 +0200563 { USB_DEVICE(TESTO_VID, TESTO_USB_INTERFACE_PID) },
Ralf Schlatterbeckeaede2c2006-09-06 12:15:02 +0200564 { USB_DEVICE(FTDI_VID, FTDI_GAMMA_SCOUT_PID) },
Ian Abbott9978f9e2006-09-25 14:19:19 +0100565 { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13M_PID) },
566 { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13S_PID) },
567 { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13U_PID) },
Kjell Myksvoll40c36092006-10-22 23:26:42 +0200568 { USB_DEVICE(ELEKTOR_VID, ELEKTOR_FT323R_PID) },
Micke Prag822c7ef2007-02-04 23:39:11 +0100569 { USB_DEVICE(TELLDUS_VID, TELLDUS_TELLSTICK_PID) },
Neil \"Superna\" ARMSTRONG762e92f2007-04-25 20:34:28 +0200570 { USB_DEVICE(FTDI_VID, FTDI_MAXSTREAM_PID) },
Pierre Castellad7fde2d2007-09-06 22:34:39 +0200571 { USB_DEVICE(TML_VID, TML_USB_SERIAL_PID) },
Tony Lindgrenfa91d432007-05-04 18:23:24 -0700572 { USB_DEVICE(OLIMEX_VID, OLIMEX_ARM_USB_OCD_PID),
573 .driver_info = (kernel_ulong_t)&ftdi_olimex_quirk },
Ian Abbottfdcb0a02005-07-28 18:40:32 +0100574 { }, /* Optional parameter entry */
575 { } /* Terminating entry */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576};
577
578MODULE_DEVICE_TABLE (usb, id_table_combined);
579
580static struct usb_driver ftdi_driver = {
581 .name = "ftdi_sio",
582 .probe = usb_serial_probe,
583 .disconnect = usb_serial_disconnect,
584 .id_table = id_table_combined,
David Brownell5c09d142006-10-13 15:57:58 -0700585 .no_dynamic_id = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586};
587
Arjan van de Ven4c4c9432005-11-29 09:43:42 +0100588static const char *ftdi_chip_name[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 [SIO] = "SIO", /* the serial part of FT8U100AX */
590 [FT8U232AM] = "FT8U232AM",
591 [FT232BM] = "FT232BM",
592 [FT2232C] = "FT2232C",
Gard Spreemannd8b21602007-03-05 00:03:26 +0100593 [FT232RL] = "FT232RL",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594};
595
596
597/* Constants for read urb and write urb */
598#define BUFSZ 512
599#define PKTSZ 64
600
601/* rx_flags */
602#define THROTTLED 0x01
603#define ACTUALLY_THROTTLED 0x02
604
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605/* Used for TIOCMIWAIT */
606#define FTDI_STATUS_B0_MASK (FTDI_RS0_CTS | FTDI_RS0_DSR | FTDI_RS0_RI | FTDI_RS0_RLSD)
607#define FTDI_STATUS_B1_MASK (FTDI_RS_BI)
608/* End TIOCMIWAIT */
609
610#define FTDI_IMPL_ASYNC_FLAGS = ( ASYNC_SPD_HI | ASYNC_SPD_VHI \
611 ASYNC_SPD_CUST | ASYNC_SPD_SHI | ASYNC_SPD_WARP )
612
613/* function prototypes for a FTDI serial converter */
Ian Abbott8f977e42005-06-20 16:45:42 +0100614static int ftdi_sio_probe (struct usb_serial *serial, const struct usb_device_id *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615static void ftdi_shutdown (struct usb_serial *serial);
Jim Radford12bdbe02007-02-28 10:10:50 -0800616static int ftdi_sio_port_probe (struct usb_serial_port *port);
617static int ftdi_sio_port_remove (struct usb_serial_port *port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618static int ftdi_open (struct usb_serial_port *port, struct file *filp);
619static void ftdi_close (struct usb_serial_port *port, struct file *filp);
620static int ftdi_write (struct usb_serial_port *port, const unsigned char *buf, int count);
621static int ftdi_write_room (struct usb_serial_port *port);
622static int ftdi_chars_in_buffer (struct usb_serial_port *port);
David Howells7d12e782006-10-05 14:55:46 +0100623static void ftdi_write_bulk_callback (struct urb *urb);
624static void ftdi_read_bulk_callback (struct urb *urb);
David Howellsc4028952006-11-22 14:57:56 +0000625static void ftdi_process_read (struct work_struct *work);
Alan Cox606d0992006-12-08 02:38:45 -0800626static void ftdi_set_termios (struct usb_serial_port *port, struct ktermios * old);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627static int ftdi_tiocmget (struct usb_serial_port *port, struct file *file);
628static int ftdi_tiocmset (struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear);
629static int ftdi_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg);
630static void ftdi_break_ctl (struct usb_serial_port *port, int break_state );
631static void ftdi_throttle (struct usb_serial_port *port);
632static void ftdi_unthrottle (struct usb_serial_port *port);
633
634static unsigned short int ftdi_232am_baud_base_to_divisor (int baud, int base);
635static unsigned short int ftdi_232am_baud_to_divisor (int baud);
636static __u32 ftdi_232bm_baud_base_to_divisor (int baud, int base);
637static __u32 ftdi_232bm_baud_to_divisor (int baud);
638
Greg Kroah-Hartmanea653702005-06-20 21:15:16 -0700639static struct usb_serial_driver ftdi_sio_device = {
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700640 .driver = {
641 .owner = THIS_MODULE,
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700642 .name = "ftdi_sio",
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700643 },
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700644 .description = "FTDI USB Serial Device",
Johannes Hölzld9b1b782006-12-17 21:50:24 +0100645 .usb_driver = &ftdi_driver ,
Ian Abbott8f977e42005-06-20 16:45:42 +0100646 .id_table = id_table_combined,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 .num_interrupt_in = 0,
648 .num_bulk_in = 1,
649 .num_bulk_out = 1,
650 .num_ports = 1,
Ian Abbott8f977e42005-06-20 16:45:42 +0100651 .probe = ftdi_sio_probe,
Jim Radford12bdbe02007-02-28 10:10:50 -0800652 .port_probe = ftdi_sio_port_probe,
653 .port_remove = ftdi_sio_port_remove,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 .open = ftdi_open,
655 .close = ftdi_close,
656 .throttle = ftdi_throttle,
657 .unthrottle = ftdi_unthrottle,
658 .write = ftdi_write,
659 .write_room = ftdi_write_room,
660 .chars_in_buffer = ftdi_chars_in_buffer,
661 .read_bulk_callback = ftdi_read_bulk_callback,
662 .write_bulk_callback = ftdi_write_bulk_callback,
663 .tiocmget = ftdi_tiocmget,
664 .tiocmset = ftdi_tiocmset,
665 .ioctl = ftdi_ioctl,
666 .set_termios = ftdi_set_termios,
667 .break_ctl = ftdi_break_ctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 .shutdown = ftdi_shutdown,
669};
670
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671
672#define WDR_TIMEOUT 5000 /* default urb timeout */
Ian Abbott279e1542005-07-29 12:16:52 -0700673#define WDR_SHORT_TIMEOUT 1000 /* shorter urb timeout */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674
675/* High and low are for DTR, RTS etc etc */
676#define HIGH 1
677#define LOW 0
678
Ian Abbott22465402006-06-26 12:59:17 +0100679/* number of outstanding urbs to prevent userspace DoS from happening */
680#define URB_UPPER_LIMIT 42
681
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682/*
683 * ***************************************************************************
Tony Lindgrenfa91d432007-05-04 18:23:24 -0700684 * Utility functions
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 * ***************************************************************************
686 */
687
688static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base)
689{
690 unsigned short int divisor;
691 int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
692 if ((divisor3 & 0x7) == 7) divisor3 ++; // round x.7/8 up to x+1
693 divisor = divisor3 >> 3;
694 divisor3 &= 0x7;
695 if (divisor3 == 1) divisor |= 0xc000; else // 0.125
696 if (divisor3 >= 4) divisor |= 0x4000; else // 0.5
697 if (divisor3 != 0) divisor |= 0x8000; // 0.25
698 if (divisor == 1) divisor = 0; /* special case for maximum baud rate */
699 return divisor;
700}
701
702static unsigned short int ftdi_232am_baud_to_divisor(int baud)
703{
704 return(ftdi_232am_baud_base_to_divisor(baud, 48000000));
705}
706
707static __u32 ftdi_232bm_baud_base_to_divisor(int baud, int base)
708{
709 static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
710 __u32 divisor;
711 int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
712 divisor = divisor3 >> 3;
713 divisor |= (__u32)divfrac[divisor3 & 0x7] << 14;
714 /* Deal with special cases for highest baud rates. */
715 if (divisor == 1) divisor = 0; else // 1.0
716 if (divisor == 0x4001) divisor = 1; // 1.5
717 return divisor;
718}
719
720static __u32 ftdi_232bm_baud_to_divisor(int baud)
721{
722 return(ftdi_232bm_baud_base_to_divisor(baud, 48000000));
723}
724
Ian Abbott74ede0f2005-07-29 12:16:41 -0700725#define set_mctrl(port, set) update_mctrl((port), (set), 0)
726#define clear_mctrl(port, clear) update_mctrl((port), 0, (clear))
727
728static int update_mctrl(struct usb_serial_port *port, unsigned int set, unsigned int clear)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729{
730 struct ftdi_private *priv = usb_get_serial_port_data(port);
731 char *buf;
Ian Abbott74ede0f2005-07-29 12:16:41 -0700732 unsigned urb_value;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 int rv;
Ian Abbott74ede0f2005-07-29 12:16:41 -0700734
735 if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
736 dbg("%s - DTR|RTS not being set|cleared", __FUNCTION__);
737 return 0; /* no change */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 }
Ian Abbott74ede0f2005-07-29 12:16:41 -0700739
740 buf = kmalloc(1, GFP_NOIO);
741 if (!buf) {
742 return -ENOMEM;
743 }
744
745 clear &= ~set; /* 'set' takes precedence over 'clear' */
746 urb_value = 0;
747 if (clear & TIOCM_DTR)
748 urb_value |= FTDI_SIO_SET_DTR_LOW;
749 if (clear & TIOCM_RTS)
750 urb_value |= FTDI_SIO_SET_RTS_LOW;
751 if (set & TIOCM_DTR)
752 urb_value |= FTDI_SIO_SET_DTR_HIGH;
753 if (set & TIOCM_RTS)
754 urb_value |= FTDI_SIO_SET_RTS_HIGH;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 rv = usb_control_msg(port->serial->dev,
756 usb_sndctrlpipe(port->serial->dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -0700757 FTDI_SIO_SET_MODEM_CTRL_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE,
Ian Abbott74ede0f2005-07-29 12:16:41 -0700759 urb_value, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 buf, 0, WDR_TIMEOUT);
761
762 kfree(buf);
Ian Abbott74ede0f2005-07-29 12:16:41 -0700763 if (rv < 0) {
764 err("%s Error from MODEM_CTRL urb: DTR %s, RTS %s",
765 __FUNCTION__,
766 (set & TIOCM_DTR) ? "HIGH" :
767 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
768 (set & TIOCM_RTS) ? "HIGH" :
769 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 } else {
Ian Abbott74ede0f2005-07-29 12:16:41 -0700771 dbg("%s - DTR %s, RTS %s", __FUNCTION__,
772 (set & TIOCM_DTR) ? "HIGH" :
773 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
774 (set & TIOCM_RTS) ? "HIGH" :
775 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
776 priv->last_dtr_rts = (priv->last_dtr_rts & ~clear) | set;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 return rv;
779}
780
781
782static __u32 get_ftdi_divisor(struct usb_serial_port * port);
783
784
785static int change_speed(struct usb_serial_port *port)
786{
787 struct ftdi_private *priv = usb_get_serial_port_data(port);
788 char *buf;
789 __u16 urb_value;
790 __u16 urb_index;
791 __u32 urb_index_value;
792 int rv;
793
794 buf = kmalloc(1, GFP_NOIO);
795 if (!buf)
796 return -ENOMEM;
797
798 urb_index_value = get_ftdi_divisor(port);
799 urb_value = (__u16)urb_index_value;
800 urb_index = (__u16)(urb_index_value >> 16);
801 if (priv->interface) { /* FT2232C */
802 urb_index = (__u16)((urb_index << 8) | priv->interface);
803 }
David Brownell5c09d142006-10-13 15:57:58 -0700804
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 rv = usb_control_msg(port->serial->dev,
806 usb_sndctrlpipe(port->serial->dev, 0),
807 FTDI_SIO_SET_BAUDRATE_REQUEST,
808 FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE,
809 urb_value, urb_index,
Ian Abbott279e1542005-07-29 12:16:52 -0700810 buf, 0, WDR_SHORT_TIMEOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811
812 kfree(buf);
813 return rv;
814}
815
816
817static __u32 get_ftdi_divisor(struct usb_serial_port * port)
818{ /* get_ftdi_divisor */
819 struct ftdi_private *priv = usb_get_serial_port_data(port);
820 __u32 div_value = 0;
821 int div_okay = 1;
822 int baud;
823
824 /*
825 * The logic involved in setting the baudrate can be cleanly split in 3 steps.
826 * Obtaining the actual baud rate is a little tricky since unix traditionally
827 * somehow ignored the possibility to set non-standard baud rates.
828 * 1. Standard baud rates are set in tty->termios->c_cflag
829 * 2. If these are not enough, you can set any speed using alt_speed as follows:
830 * - set tty->termios->c_cflag speed to B38400
831 * - set your real speed in tty->alt_speed; it gets ignored when
832 * alt_speed==0, (or)
833 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
834 * flags & ASYNC_SPD_MASK == ASYNC_SPD_[HI, VHI, SHI, WARP], this just
835 * sets alt_speed to (HI: 57600, VHI: 115200, SHI: 230400, WARP: 460800)
836 * ** Steps 1, 2 are done courtesy of tty_get_baud_rate
837 * 3. You can also set baud rate by setting custom divisor as follows
838 * - set tty->termios->c_cflag speed to B38400
839 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
840 * o flags & ASYNC_SPD_MASK == ASYNC_SPD_CUST
841 * o custom_divisor set to baud_base / your_new_baudrate
842 * ** Step 3 is done courtesy of code borrowed from serial.c - I should really
843 * spend some time and separate+move this common code to serial.c, it is
844 * replicated in nearly every serial driver you see.
845 */
846
847 /* 1. Get the baud rate from the tty settings, this observes alt_speed hack */
848
849 baud = tty_get_baud_rate(port->tty);
850 dbg("%s - tty_get_baud_rate reports speed %d", __FUNCTION__, baud);
851
852 /* 2. Observe async-compatible custom_divisor hack, update baudrate if needed */
853
854 if (baud == 38400 &&
855 ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
856 (priv->custom_divisor)) {
857 baud = priv->baud_base / priv->custom_divisor;
858 dbg("%s - custom divisor %d sets baud rate to %d", __FUNCTION__, priv->custom_divisor, baud);
859 }
860
861 /* 3. Convert baudrate to device-specific divisor */
862
David Brownell5c09d142006-10-13 15:57:58 -0700863 if (!baud) baud = 9600;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 switch(priv->chip_type) {
865 case SIO: /* SIO chip */
866 switch(baud) {
867 case 300: div_value = ftdi_sio_b300; break;
868 case 600: div_value = ftdi_sio_b600; break;
869 case 1200: div_value = ftdi_sio_b1200; break;
870 case 2400: div_value = ftdi_sio_b2400; break;
871 case 4800: div_value = ftdi_sio_b4800; break;
872 case 9600: div_value = ftdi_sio_b9600; break;
873 case 19200: div_value = ftdi_sio_b19200; break;
874 case 38400: div_value = ftdi_sio_b38400; break;
875 case 57600: div_value = ftdi_sio_b57600; break;
876 case 115200: div_value = ftdi_sio_b115200; break;
877 } /* baud */
878 if (div_value == 0) {
David Brownell5c09d142006-10-13 15:57:58 -0700879 dbg("%s - Baudrate (%d) requested is not supported", __FUNCTION__, baud);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 div_value = ftdi_sio_b9600;
Andrew Mortonbd5e47c2007-10-18 01:24:25 -0700881 baud = 9600;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882 div_okay = 0;
883 }
884 break;
885 case FT8U232AM: /* 8U232AM chip */
886 if (baud <= 3000000) {
887 div_value = ftdi_232am_baud_to_divisor(baud);
888 } else {
889 dbg("%s - Baud rate too high!", __FUNCTION__);
Andrew Mortonbd5e47c2007-10-18 01:24:25 -0700890 baud = 9600;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891 div_value = ftdi_232am_baud_to_divisor(9600);
892 div_okay = 0;
893 }
894 break;
895 case FT232BM: /* FT232BM chip */
896 case FT2232C: /* FT2232C chip */
David Brownell3b009c62007-03-23 12:54:27 -0700897 case FT232RL:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898 if (baud <= 3000000) {
899 div_value = ftdi_232bm_baud_to_divisor(baud);
900 } else {
901 dbg("%s - Baud rate too high!", __FUNCTION__);
902 div_value = ftdi_232bm_baud_to_divisor(9600);
903 div_okay = 0;
Alan Cox669a6db2007-10-18 01:24:24 -0700904 baud = 9600;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905 }
906 break;
907 } /* priv->chip_type */
908
909 if (div_okay) {
910 dbg("%s - Baud rate set to %d (divisor 0x%lX) on chip %s",
911 __FUNCTION__, baud, (unsigned long)div_value,
912 ftdi_chip_name[priv->chip_type]);
913 }
914
Alan Cox669a6db2007-10-18 01:24:24 -0700915 tty_encode_baud_rate(port->tty, baud, baud);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916 return(div_value);
917}
918
919
920static int get_serial_info(struct usb_serial_port * port, struct serial_struct __user * retinfo)
921{
922 struct ftdi_private *priv = usb_get_serial_port_data(port);
923 struct serial_struct tmp;
924
925 if (!retinfo)
926 return -EFAULT;
927 memset(&tmp, 0, sizeof(tmp));
928 tmp.flags = priv->flags;
929 tmp.baud_base = priv->baud_base;
930 tmp.custom_divisor = priv->custom_divisor;
931 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
932 return -EFAULT;
933 return 0;
934} /* get_serial_info */
935
936
937static int set_serial_info(struct usb_serial_port * port, struct serial_struct __user * newinfo)
938{ /* set_serial_info */
939 struct ftdi_private *priv = usb_get_serial_port_data(port);
940 struct serial_struct new_serial;
941 struct ftdi_private old_priv;
942
943 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
944 return -EFAULT;
945 old_priv = * priv;
946
947 /* Do error checking and permission checking */
948
949 if (!capable(CAP_SYS_ADMIN)) {
950 if (((new_serial.flags & ~ASYNC_USR_MASK) !=
951 (priv->flags & ~ASYNC_USR_MASK)))
952 return -EPERM;
953 priv->flags = ((priv->flags & ~ASYNC_USR_MASK) |
954 (new_serial.flags & ASYNC_USR_MASK));
955 priv->custom_divisor = new_serial.custom_divisor;
956 goto check_and_exit;
957 }
958
959 if ((new_serial.baud_base != priv->baud_base) &&
960 (new_serial.baud_base < 9600))
961 return -EINVAL;
962
963 /* Make the changes - these are privileged changes! */
964
965 priv->flags = ((priv->flags & ~ASYNC_FLAGS) |
David Brownell5c09d142006-10-13 15:57:58 -0700966 (new_serial.flags & ASYNC_FLAGS));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 priv->custom_divisor = new_serial.custom_divisor;
968
969 port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
970
971check_and_exit:
972 if ((old_priv.flags & ASYNC_SPD_MASK) !=
973 (priv->flags & ASYNC_SPD_MASK)) {
974 if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_HI)
975 port->tty->alt_speed = 57600;
976 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_VHI)
977 port->tty->alt_speed = 115200;
978 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_SHI)
979 port->tty->alt_speed = 230400;
980 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_WARP)
981 port->tty->alt_speed = 460800;
982 else
983 port->tty->alt_speed = 0;
984 }
985 if (((old_priv.flags & ASYNC_SPD_MASK) !=
986 (priv->flags & ASYNC_SPD_MASK)) ||
987 (((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
988 (old_priv.custom_divisor != priv->custom_divisor))) {
989 change_speed(port);
990 }
David Brownell5c09d142006-10-13 15:57:58 -0700991
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992 return (0);
993
994} /* set_serial_info */
995
996
Ian Abbott8f977e42005-06-20 16:45:42 +0100997/* Determine type of FTDI chip based on USB config and descriptor. */
998static void ftdi_determine_type(struct usb_serial_port *port)
999{
1000 struct ftdi_private *priv = usb_get_serial_port_data(port);
1001 struct usb_serial *serial = port->serial;
1002 struct usb_device *udev = serial->dev;
1003 unsigned version;
1004 unsigned interfaces;
1005
1006 /* Assume it is not the original SIO device for now. */
Ian Abbottf5e09b72005-09-12 12:23:25 +01001007 priv->baud_base = 48000000 / 2;
Ian Abbott8f977e42005-06-20 16:45:42 +01001008 priv->write_offset = 0;
1009
1010 version = le16_to_cpu(udev->descriptor.bcdDevice);
1011 interfaces = udev->actconfig->desc.bNumInterfaces;
1012 dbg("%s: bcdDevice = 0x%x, bNumInterfaces = %u", __FUNCTION__,
1013 version, interfaces);
1014 if (interfaces > 1) {
1015 int inter;
1016
1017 /* Multiple interfaces. Assume FT2232C. */
1018 priv->chip_type = FT2232C;
1019 /* Determine interface code. */
1020 inter = serial->interface->altsetting->desc.bInterfaceNumber;
1021 if (inter == 0) {
1022 priv->interface = PIT_SIOA;
1023 } else {
1024 priv->interface = PIT_SIOB;
1025 }
1026 /* BM-type devices have a bug where bcdDevice gets set
1027 * to 0x200 when iSerialNumber is 0. */
1028 if (version < 0x500) {
1029 dbg("%s: something fishy - bcdDevice too low for multi-interface device",
1030 __FUNCTION__);
1031 }
1032 } else if (version < 0x200) {
1033 /* Old device. Assume its the original SIO. */
1034 priv->chip_type = SIO;
1035 priv->baud_base = 12000000 / 16;
1036 priv->write_offset = 1;
1037 } else if (version < 0x400) {
1038 /* Assume its an FT8U232AM (or FT8U245AM) */
1039 /* (It might be a BM because of the iSerialNumber bug,
1040 * but it will still work as an AM device.) */
1041 priv->chip_type = FT8U232AM;
David Brownell3b009c62007-03-23 12:54:27 -07001042 } else if (version < 0x600) {
Ian Abbott8f977e42005-06-20 16:45:42 +01001043 /* Assume its an FT232BM (or FT245BM) */
1044 priv->chip_type = FT232BM;
David Brownell3b009c62007-03-23 12:54:27 -07001045 } else {
1046 /* Assume its an FT232R */
1047 priv->chip_type = FT232RL;
Ian Abbott8f977e42005-06-20 16:45:42 +01001048 }
1049 info("Detected %s", ftdi_chip_name[priv->chip_type]);
1050}
1051
1052
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053/*
1054 * ***************************************************************************
1055 * Sysfs Attribute
1056 * ***************************************************************************
1057 */
1058
Yani Ioannou060b8842005-05-17 06:44:04 -04001059static ssize_t show_latency_timer(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060{
1061 struct usb_serial_port *port = to_usb_serial_port(dev);
1062 struct ftdi_private *priv = usb_get_serial_port_data(port);
Jim Radford12bdbe02007-02-28 10:10:50 -08001063 struct usb_device *udev = port->serial->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064 unsigned short latency = 0;
1065 int rv = 0;
David Brownell5c09d142006-10-13 15:57:58 -07001066
David Brownell5c09d142006-10-13 15:57:58 -07001067
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068 dbg("%s",__FUNCTION__);
David Brownell5c09d142006-10-13 15:57:58 -07001069
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070 rv = usb_control_msg(udev,
1071 usb_rcvctrlpipe(udev, 0),
1072 FTDI_SIO_GET_LATENCY_TIMER_REQUEST,
1073 FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07001074 0, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075 (char*) &latency, 1, WDR_TIMEOUT);
David Brownell5c09d142006-10-13 15:57:58 -07001076
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077 if (rv < 0) {
Joe Perches898eb712007-10-18 03:06:30 -07001078 dev_err(dev, "Unable to read latency timer: %i\n", rv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 return -EIO;
1080 }
1081 return sprintf(buf, "%i\n", latency);
1082}
1083
1084/* Write a new value of the latency timer, in units of milliseconds. */
Yani Ioannou060b8842005-05-17 06:44:04 -04001085static ssize_t store_latency_timer(struct device *dev, struct device_attribute *attr, const char *valbuf,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086 size_t count)
1087{
1088 struct usb_serial_port *port = to_usb_serial_port(dev);
1089 struct ftdi_private *priv = usb_get_serial_port_data(port);
Jim Radford12bdbe02007-02-28 10:10:50 -08001090 struct usb_device *udev = port->serial->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091 char buf[1];
1092 int v = simple_strtoul(valbuf, NULL, 10);
1093 int rv = 0;
David Brownell5c09d142006-10-13 15:57:58 -07001094
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095 dbg("%s: setting latency timer = %i", __FUNCTION__, v);
David Brownell5c09d142006-10-13 15:57:58 -07001096
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 rv = usb_control_msg(udev,
1098 usb_sndctrlpipe(udev, 0),
1099 FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
1100 FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07001101 v, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102 buf, 0, WDR_TIMEOUT);
David Brownell5c09d142006-10-13 15:57:58 -07001103
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104 if (rv < 0) {
Joe Perches898eb712007-10-18 03:06:30 -07001105 dev_err(dev, "Unable to write latency timer: %i\n", rv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001106 return -EIO;
1107 }
David Brownell5c09d142006-10-13 15:57:58 -07001108
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109 return count;
1110}
1111
1112/* Write an event character directly to the FTDI register. The ASCII
1113 value is in the low 8 bits, with the enable bit in the 9th bit. */
Yani Ioannou060b8842005-05-17 06:44:04 -04001114static ssize_t store_event_char(struct device *dev, struct device_attribute *attr, const char *valbuf,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115 size_t count)
1116{
1117 struct usb_serial_port *port = to_usb_serial_port(dev);
1118 struct ftdi_private *priv = usb_get_serial_port_data(port);
Jim Radford12bdbe02007-02-28 10:10:50 -08001119 struct usb_device *udev = port->serial->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120 char buf[1];
1121 int v = simple_strtoul(valbuf, NULL, 10);
1122 int rv = 0;
David Brownell5c09d142006-10-13 15:57:58 -07001123
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124 dbg("%s: setting event char = %i", __FUNCTION__, v);
David Brownell5c09d142006-10-13 15:57:58 -07001125
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126 rv = usb_control_msg(udev,
1127 usb_sndctrlpipe(udev, 0),
1128 FTDI_SIO_SET_EVENT_CHAR_REQUEST,
1129 FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07001130 v, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131 buf, 0, WDR_TIMEOUT);
David Brownell5c09d142006-10-13 15:57:58 -07001132
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133 if (rv < 0) {
1134 dbg("Unable to write event character: %i", rv);
1135 return -EIO;
1136 }
David Brownell5c09d142006-10-13 15:57:58 -07001137
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 return count;
1139}
1140
1141static DEVICE_ATTR(latency_timer, S_IWUSR | S_IRUGO, show_latency_timer, store_latency_timer);
1142static DEVICE_ATTR(event_char, S_IWUSR, NULL, store_event_char);
1143
Jim Radford12bdbe02007-02-28 10:10:50 -08001144static int create_sysfs_attrs(struct usb_serial_port *port)
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001145{
Jim Radford12bdbe02007-02-28 10:10:50 -08001146 struct ftdi_private *priv = usb_get_serial_port_data(port);
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001147 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148
1149 dbg("%s",__FUNCTION__);
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001150
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151 /* XXX I've no idea if the original SIO supports the event_char
1152 * sysfs parameter, so I'm playing it safe. */
1153 if (priv->chip_type != SIO) {
1154 dbg("sysfs attributes for %s", ftdi_chip_name[priv->chip_type]);
Jim Radford12bdbe02007-02-28 10:10:50 -08001155 retval = device_create_file(&port->dev, &dev_attr_event_char);
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001156 if ((!retval) &&
Stepan Moskovchenko97cd49e2007-05-09 14:53:04 -04001157 (priv->chip_type == FT232BM ||
1158 priv->chip_type == FT2232C ||
1159 priv->chip_type == FT232RL)) {
Jim Radford12bdbe02007-02-28 10:10:50 -08001160 retval = device_create_file(&port->dev,
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001161 &dev_attr_latency_timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162 }
1163 }
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001164 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165}
1166
Jim Radford12bdbe02007-02-28 10:10:50 -08001167static void remove_sysfs_attrs(struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168{
Jim Radford12bdbe02007-02-28 10:10:50 -08001169 struct ftdi_private *priv = usb_get_serial_port_data(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170
David Brownell5c09d142006-10-13 15:57:58 -07001171 dbg("%s",__FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 /* XXX see create_sysfs_attrs */
1174 if (priv->chip_type != SIO) {
Jim Radford12bdbe02007-02-28 10:10:50 -08001175 device_remove_file(&port->dev, &dev_attr_event_char);
Andrew M. Bishoped6e5282007-08-21 19:08:56 +01001176 if (priv->chip_type == FT232BM ||
1177 priv->chip_type == FT2232C ||
1178 priv->chip_type == FT232RL) {
Jim Radford12bdbe02007-02-28 10:10:50 -08001179 device_remove_file(&port->dev, &dev_attr_latency_timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180 }
1181 }
David Brownell5c09d142006-10-13 15:57:58 -07001182
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183}
1184
1185/*
1186 * ***************************************************************************
1187 * FTDI driver specific functions
1188 * ***************************************************************************
1189 */
1190
Ian Abbott8f977e42005-06-20 16:45:42 +01001191/* Probe function to check for special devices */
1192static int ftdi_sio_probe (struct usb_serial *serial, const struct usb_device_id *id)
1193{
Tony Lindgrenfa91d432007-05-04 18:23:24 -07001194 struct ftdi_sio_quirk *quirk = (struct ftdi_sio_quirk *)id->driver_info;
1195
1196 if (quirk && quirk->probe) {
1197 int ret = quirk->probe(serial);
1198 if (ret != 0)
1199 return ret;
1200 }
1201
Ian Abbott8f977e42005-06-20 16:45:42 +01001202 usb_set_serial_data(serial, (void *)id->driver_info);
1203
Tony Lindgrenfa91d432007-05-04 18:23:24 -07001204 return 0;
Ian Abbott8f977e42005-06-20 16:45:42 +01001205}
1206
Jim Radford12bdbe02007-02-28 10:10:50 -08001207static int ftdi_sio_port_probe(struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209 struct ftdi_private *priv;
Oliver Neukum0ffbbe22007-07-09 12:03:08 -07001210 struct ftdi_sio_quirk *quirk = usb_get_serial_data(port->serial);
1211
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001212
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213 dbg("%s",__FUNCTION__);
1214
Eric Sesterhenn80b6ca42006-02-27 21:29:43 +01001215 priv = kzalloc(sizeof(struct ftdi_private), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216 if (!priv){
1217 err("%s- kmalloc(%Zd) failed.", __FUNCTION__, sizeof(struct ftdi_private));
1218 return -ENOMEM;
1219 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220
1221 spin_lock_init(&priv->rx_lock);
Ian Abbott22465402006-06-26 12:59:17 +01001222 spin_lock_init(&priv->tx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223 init_waitqueue_head(&priv->delta_msr_wait);
1224 /* This will push the characters through immediately rather
1225 than queue a task to deliver them */
1226 priv->flags = ASYNC_LOW_LATENCY;
1227
Oliver Neukum0ffbbe22007-07-09 12:03:08 -07001228 if (quirk && quirk->port_probe)
1229 quirk->port_probe(priv);
1230
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231 /* Increase the size of read buffers */
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07001232 kfree(port->bulk_in_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233 port->bulk_in_buffer = kmalloc (BUFSZ, GFP_KERNEL);
1234 if (!port->bulk_in_buffer) {
1235 kfree (priv);
1236 return -ENOMEM;
1237 }
1238 if (port->read_urb) {
1239 port->read_urb->transfer_buffer = port->bulk_in_buffer;
1240 port->read_urb->transfer_buffer_length = BUFSZ;
1241 }
1242
David Howellsc4028952006-11-22 14:57:56 +00001243 INIT_DELAYED_WORK(&priv->rx_work, ftdi_process_read);
1244 priv->port = port;
Ian Abbott76854ce2005-06-02 10:34:11 +01001245
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246 /* Free port's existing write urb and transfer buffer. */
1247 if (port->write_urb) {
1248 usb_free_urb (port->write_urb);
1249 port->write_urb = NULL;
1250 }
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07001251 kfree(port->bulk_out_buffer);
1252 port->bulk_out_buffer = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253
Jim Radford12bdbe02007-02-28 10:10:50 -08001254 usb_set_serial_port_data(port, priv);
Ian Abbott8f977e42005-06-20 16:45:42 +01001255
Jim Radford12bdbe02007-02-28 10:10:50 -08001256 ftdi_determine_type (port);
1257 create_sysfs_attrs(port);
1258 return 0;
1259}
Ian Abbott8f977e42005-06-20 16:45:42 +01001260
Ian Abbott8f977e42005-06-20 16:45:42 +01001261/* Setup for the USB-UIRT device, which requires hardwired
1262 * baudrate (38400 gets mapped to 312500) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263/* Called from usbserial:serial_probe */
Oliver Neukum0ffbbe22007-07-09 12:03:08 -07001264static void ftdi_USB_UIRT_setup (struct ftdi_private *priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266 dbg("%s",__FUNCTION__);
1267
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268 priv->flags |= ASYNC_SPD_CUST;
1269 priv->custom_divisor = 77;
Alan Cox669a6db2007-10-18 01:24:24 -07001270 priv->force_baud = 38400;
Ian Abbott8f977e42005-06-20 16:45:42 +01001271} /* ftdi_USB_UIRT_setup */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272
Ian Abbott8f977e42005-06-20 16:45:42 +01001273/* Setup for the HE-TIRA1 device, which requires hardwired
1274 * baudrate (38400 gets mapped to 100000) and RTS-CTS enabled. */
Oliver Neukum0ffbbe22007-07-09 12:03:08 -07001275static void ftdi_HE_TIRA1_setup (struct ftdi_private *priv)
Ian Abbott8f977e42005-06-20 16:45:42 +01001276{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277 dbg("%s",__FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279 priv->flags |= ASYNC_SPD_CUST;
1280 priv->custom_divisor = 240;
Alan Cox669a6db2007-10-18 01:24:24 -07001281 priv->force_baud = 38400;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282 priv->force_rtscts = 1;
Ian Abbott8f977e42005-06-20 16:45:42 +01001283} /* ftdi_HE_TIRA1_setup */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284
Tony Lindgrenfa91d432007-05-04 18:23:24 -07001285/*
1286 * First port on Olimex arm-usb-ocd is reserved for JTAG interface
1287 * and can be accessed from userspace using openocd.
1288 */
1289static int ftdi_olimex_probe(struct usb_serial *serial)
1290{
1291 struct usb_device *udev = serial->dev;
1292 struct usb_interface *interface = serial->interface;
1293
1294 dbg("%s",__FUNCTION__);
1295
1296 if (interface == udev->actconfig->interface[0]) {
1297 info("Ignoring reserved serial port on Olimex arm-usb-ocd\n");
1298 return -ENODEV;
1299 }
1300
1301 return 0;
1302}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303
David Brownell5c09d142006-10-13 15:57:58 -07001304/* ftdi_shutdown is called from usbserial:usb_serial_disconnect
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305 * it is called when the usb device is disconnected
1306 *
1307 * usbserial:usb_serial_disconnect
1308 * calls __serial_close for each open of the port
1309 * shutdown is called then (ie ftdi_shutdown)
1310 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311static void ftdi_shutdown (struct usb_serial *serial)
Jim Radford12bdbe02007-02-28 10:10:50 -08001312{
1313 dbg("%s", __FUNCTION__);
1314}
David Brownell5c09d142006-10-13 15:57:58 -07001315
Jim Radford12bdbe02007-02-28 10:10:50 -08001316static int ftdi_sio_port_remove(struct usb_serial_port *port)
1317{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318 struct ftdi_private *priv = usb_get_serial_port_data(port);
1319
1320 dbg("%s", __FUNCTION__);
1321
Jim Radford12bdbe02007-02-28 10:10:50 -08001322 remove_sysfs_attrs(port);
David Brownell5c09d142006-10-13 15:57:58 -07001323
1324 /* all open ports are closed at this point
1325 * (by usbserial.c:__serial_close, which calls ftdi_close)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326 */
1327
1328 if (priv) {
1329 usb_set_serial_port_data(port, NULL);
1330 kfree(priv);
1331 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332
Jim Radford12bdbe02007-02-28 10:10:50 -08001333 return 0;
1334}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335
1336static int ftdi_open (struct usb_serial_port *port, struct file *filp)
1337{ /* ftdi_open */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 struct usb_device *dev = port->serial->dev;
1339 struct ftdi_private *priv = usb_get_serial_port_data(port);
1340 unsigned long flags;
David Brownell5c09d142006-10-13 15:57:58 -07001341
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342 int result = 0;
1343 char buf[1]; /* Needed for the usb_control_msg I think */
1344
1345 dbg("%s", __FUNCTION__);
1346
Ian Abbott22465402006-06-26 12:59:17 +01001347 spin_lock_irqsave(&priv->tx_lock, flags);
1348 priv->tx_bytes = 0;
1349 spin_unlock_irqrestore(&priv->tx_lock, flags);
1350 spin_lock_irqsave(&priv->rx_lock, flags);
1351 priv->rx_bytes = 0;
1352 spin_unlock_irqrestore(&priv->rx_lock, flags);
1353
Guennadi Liakhovetski57845bd2006-04-13 22:27:12 +02001354 if (port->tty)
1355 port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356
1357 /* No error checking for this (will get errors later anyway) */
1358 /* See ftdi_sio.h for description of what is reset */
1359 usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07001360 FTDI_SIO_RESET_REQUEST, FTDI_SIO_RESET_REQUEST_TYPE,
1361 FTDI_SIO_RESET_SIO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362 priv->interface, buf, 0, WDR_TIMEOUT);
1363
1364 /* Termios defaults are set by usb_serial_init. We don't change
1365 port->tty->termios - this would loose speed settings, etc.
1366 This is same behaviour as serial.c/rs_open() - Kuba */
1367
1368 /* ftdi_set_termios will send usb control messages */
Guennadi Liakhovetski57845bd2006-04-13 22:27:12 +02001369 if (port->tty)
Alan Cox669a6db2007-10-18 01:24:24 -07001370 ftdi_set_termios(port, port->tty->termios);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371
1372 /* FIXME: Flow control might be enabled, so it should be checked -
1373 we have no control of defaults! */
1374 /* Turn on RTS and DTR since we are not flow controlling by default */
Ian Abbott74ede0f2005-07-29 12:16:41 -07001375 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376
1377 /* Not throttled */
1378 spin_lock_irqsave(&priv->rx_lock, flags);
1379 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
1380 spin_unlock_irqrestore(&priv->rx_lock, flags);
1381
1382 /* Start reading from the device */
Ian Abbott76854ce2005-06-02 10:34:11 +01001383 priv->rx_processed = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384 usb_fill_bulk_urb(port->read_urb, dev,
1385 usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress),
1386 port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
1387 ftdi_read_bulk_callback, port);
1388 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
1389 if (result)
1390 err("%s - failed submitting read urb, error %d", __FUNCTION__, result);
1391
1392
1393 return result;
1394} /* ftdi_open */
1395
1396
1397
David Brownell5c09d142006-10-13 15:57:58 -07001398/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399 * usbserial:__serial_close only calls ftdi_close if the point is open
1400 *
1401 * This only gets called when it is the last close
David Brownell5c09d142006-10-13 15:57:58 -07001402 *
1403 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 */
1405
1406static void ftdi_close (struct usb_serial_port *port, struct file *filp)
1407{ /* ftdi_close */
1408 unsigned int c_cflag = port->tty->termios->c_cflag;
1409 struct ftdi_private *priv = usb_get_serial_port_data(port);
1410 char buf[1];
1411
1412 dbg("%s", __FUNCTION__);
1413
1414 if (c_cflag & HUPCL){
1415 /* Disable flow control */
David Brownell5c09d142006-10-13 15:57:58 -07001416 if (usb_control_msg(port->serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417 usb_sndctrlpipe(port->serial->dev, 0),
1418 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1419 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1420 0, priv->interface, buf, 0,
1421 WDR_TIMEOUT) < 0) {
1422 err("error from flowcontrol urb");
David Brownell5c09d142006-10-13 15:57:58 -07001423 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424
Ian Abbott74ede0f2005-07-29 12:16:41 -07001425 /* drop RTS and DTR */
1426 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427 } /* Note change no line if hupcl is off */
Ian Abbott76854ce2005-06-02 10:34:11 +01001428
1429 /* cancel any scheduled reading */
1430 cancel_delayed_work(&priv->rx_work);
1431 flush_scheduled_work();
David Brownell5c09d142006-10-13 15:57:58 -07001432
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433 /* shutdown our bulk read */
Mariusz Kozlowski794c9442006-11-08 15:36:25 +01001434 usb_kill_urb(port->read_urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435} /* ftdi_close */
1436
1437
David Brownell5c09d142006-10-13 15:57:58 -07001438
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439/* The SIO requires the first byte to have:
1440 * B0 1
1441 * B1 0
1442 * B2..7 length of message excluding byte 0
1443 *
1444 * The new devices do not require this byte
1445 */
1446static int ftdi_write (struct usb_serial_port *port,
1447 const unsigned char *buf, int count)
1448{ /* ftdi_write */
1449 struct ftdi_private *priv = usb_get_serial_port_data(port);
1450 struct urb *urb;
1451 unsigned char *buffer;
1452 int data_offset ; /* will be 1 for the SIO and 0 otherwise */
1453 int status;
1454 int transfer_size;
Ian Abbott22465402006-06-26 12:59:17 +01001455 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456
1457 dbg("%s port %d, %d bytes", __FUNCTION__, port->number, count);
1458
1459 if (count == 0) {
1460 dbg("write request of 0 bytes");
1461 return 0;
1462 }
Ian Abbott22465402006-06-26 12:59:17 +01001463 spin_lock_irqsave(&priv->tx_lock, flags);
1464 if (priv->tx_outstanding_urbs > URB_UPPER_LIMIT) {
1465 spin_unlock_irqrestore(&priv->tx_lock, flags);
1466 dbg("%s - write limit hit\n", __FUNCTION__);
1467 return 0;
1468 }
Oliver Neukum62127a52007-03-23 14:30:16 +01001469 priv->tx_outstanding_urbs++;
Ian Abbott22465402006-06-26 12:59:17 +01001470 spin_unlock_irqrestore(&priv->tx_lock, flags);
David Brownell5c09d142006-10-13 15:57:58 -07001471
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472 data_offset = priv->write_offset;
1473 dbg("data_offset set to %d",data_offset);
1474
1475 /* Determine total transfer size */
1476 transfer_size = count;
1477 if (data_offset > 0) {
1478 /* Original sio needs control bytes too... */
1479 transfer_size += (data_offset *
1480 ((count + (PKTSZ - 1 - data_offset)) /
1481 (PKTSZ - data_offset)));
1482 }
1483
1484 buffer = kmalloc (transfer_size, GFP_ATOMIC);
1485 if (!buffer) {
1486 err("%s ran out of kernel memory for urb ...", __FUNCTION__);
Oliver Neukum62127a52007-03-23 14:30:16 +01001487 count = -ENOMEM;
1488 goto error_no_buffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489 }
1490
1491 urb = usb_alloc_urb(0, GFP_ATOMIC);
1492 if (!urb) {
1493 err("%s - no more free urbs", __FUNCTION__);
Oliver Neukum62127a52007-03-23 14:30:16 +01001494 count = -ENOMEM;
1495 goto error_no_urb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496 }
1497
1498 /* Copy data */
1499 if (data_offset > 0) {
1500 /* Original sio requires control byte at start of each packet. */
1501 int user_pktsz = PKTSZ - data_offset;
1502 int todo = count;
1503 unsigned char *first_byte = buffer;
1504 const unsigned char *current_position = buf;
1505
1506 while (todo > 0) {
1507 if (user_pktsz > todo) {
1508 user_pktsz = todo;
1509 }
1510 /* Write the control byte at the front of the packet*/
David Brownell5c09d142006-10-13 15:57:58 -07001511 *first_byte = 1 | ((user_pktsz) << 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512 /* Copy data for packet */
1513 memcpy (first_byte + data_offset,
1514 current_position, user_pktsz);
1515 first_byte += user_pktsz + data_offset;
1516 current_position += user_pktsz;
1517 todo -= user_pktsz;
1518 }
1519 } else {
1520 /* No control byte required. */
1521 /* Copy in the data to send */
1522 memcpy (buffer, buf, count);
1523 }
1524
1525 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, transfer_size, buffer);
1526
1527 /* fill the buffer and send it */
David Brownell5c09d142006-10-13 15:57:58 -07001528 usb_fill_bulk_urb(urb, port->serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529 usb_sndbulkpipe(port->serial->dev, port->bulk_out_endpointAddress),
1530 buffer, transfer_size,
1531 ftdi_write_bulk_callback, port);
1532
1533 status = usb_submit_urb(urb, GFP_ATOMIC);
1534 if (status) {
1535 err("%s - failed submitting write urb, error %d", __FUNCTION__, status);
1536 count = status;
Oliver Neukum62127a52007-03-23 14:30:16 +01001537 goto error;
Ian Abbott22465402006-06-26 12:59:17 +01001538 } else {
1539 spin_lock_irqsave(&priv->tx_lock, flags);
Ian Abbott22465402006-06-26 12:59:17 +01001540 priv->tx_outstanding_bytes += count;
1541 priv->tx_bytes += count;
1542 spin_unlock_irqrestore(&priv->tx_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543 }
1544
1545 /* we are done with this urb, so let the host driver
1546 * really free it when it is finished with it */
Oliver Neukum62127a52007-03-23 14:30:16 +01001547 usb_free_urb(urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548
1549 dbg("%s write returning: %d", __FUNCTION__, count);
1550 return count;
Oliver Neukum62127a52007-03-23 14:30:16 +01001551error:
1552 usb_free_urb(urb);
1553error_no_urb:
1554 kfree (buffer);
1555error_no_buffer:
1556 spin_lock_irqsave(&priv->tx_lock, flags);
1557 priv->tx_outstanding_urbs--;
1558 spin_unlock_irqrestore(&priv->tx_lock, flags);
1559 return count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560} /* ftdi_write */
1561
1562
1563/* This function may get called when the device is closed */
1564
David Howells7d12e782006-10-05 14:55:46 +01001565static void ftdi_write_bulk_callback (struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566{
Ian Abbott22465402006-06-26 12:59:17 +01001567 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
Ian Abbott22465402006-06-26 12:59:17 +01001569 struct ftdi_private *priv;
1570 int data_offset; /* will be 1 for the SIO and 0 otherwise */
1571 unsigned long countback;
Greg Kroah-Hartman0fb0aa12007-06-15 15:44:13 -07001572 int status = urb->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573
1574 /* free up the transfer buffer, as usb_free_urb() does not do this */
1575 kfree (urb->transfer_buffer);
1576
1577 dbg("%s - port %d", __FUNCTION__, port->number);
David Brownell5c09d142006-10-13 15:57:58 -07001578
Greg Kroah-Hartman0fb0aa12007-06-15 15:44:13 -07001579 if (status) {
1580 dbg("nonzero write bulk status received: %d", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581 return;
1582 }
1583
Ian Abbott22465402006-06-26 12:59:17 +01001584 priv = usb_get_serial_port_data(port);
1585 if (!priv) {
1586 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1587 return;
1588 }
1589 /* account for transferred data */
1590 countback = urb->actual_length;
1591 data_offset = priv->write_offset;
1592 if (data_offset > 0) {
1593 /* Subtract the control bytes */
1594 countback -= (data_offset * ((countback + (PKTSZ - 1)) / PKTSZ));
1595 }
1596 spin_lock_irqsave(&priv->tx_lock, flags);
1597 --priv->tx_outstanding_urbs;
1598 priv->tx_outstanding_bytes -= countback;
1599 spin_unlock_irqrestore(&priv->tx_lock, flags);
1600
Pete Zaitcevcf2c7482006-05-22 21:58:49 -07001601 usb_serial_port_softint(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602} /* ftdi_write_bulk_callback */
1603
1604
1605static int ftdi_write_room( struct usb_serial_port *port )
1606{
Ian Abbott22465402006-06-26 12:59:17 +01001607 struct ftdi_private *priv = usb_get_serial_port_data(port);
1608 int room;
1609 unsigned long flags;
1610
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611 dbg("%s - port %d", __FUNCTION__, port->number);
1612
Ian Abbott22465402006-06-26 12:59:17 +01001613 spin_lock_irqsave(&priv->tx_lock, flags);
1614 if (priv->tx_outstanding_urbs < URB_UPPER_LIMIT) {
1615 /*
1616 * We really can take anything the user throws at us
1617 * but let's pick a nice big number to tell the tty
1618 * layer that we have lots of free space
1619 */
1620 room = 2048;
1621 } else {
1622 room = 0;
1623 }
1624 spin_unlock_irqrestore(&priv->tx_lock, flags);
1625 return room;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626} /* ftdi_write_room */
1627
1628
1629static int ftdi_chars_in_buffer (struct usb_serial_port *port)
1630{ /* ftdi_chars_in_buffer */
Ian Abbott22465402006-06-26 12:59:17 +01001631 struct ftdi_private *priv = usb_get_serial_port_data(port);
1632 int buffered;
1633 unsigned long flags;
1634
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635 dbg("%s - port %d", __FUNCTION__, port->number);
1636
Ian Abbott22465402006-06-26 12:59:17 +01001637 spin_lock_irqsave(&priv->tx_lock, flags);
1638 buffered = (int)priv->tx_outstanding_bytes;
1639 spin_unlock_irqrestore(&priv->tx_lock, flags);
1640 if (buffered < 0) {
1641 err("%s outstanding tx bytes is negative!", __FUNCTION__);
1642 buffered = 0;
1643 }
1644 return buffered;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645} /* ftdi_chars_in_buffer */
1646
1647
1648
David Howells7d12e782006-10-05 14:55:46 +01001649static void ftdi_read_bulk_callback (struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650{ /* ftdi_read_bulk_callback */
1651 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1652 struct tty_struct *tty;
1653 struct ftdi_private *priv;
Ian Abbott22465402006-06-26 12:59:17 +01001654 unsigned long countread;
1655 unsigned long flags;
Greg Kroah-Hartman0fb0aa12007-06-15 15:44:13 -07001656 int status = urb->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657
1658 if (urb->number_of_packets > 0) {
1659 err("%s transfer_buffer_length %d actual_length %d number of packets %d",__FUNCTION__,
1660 urb->transfer_buffer_length, urb->actual_length, urb->number_of_packets );
1661 err("%s transfer_flags %x ", __FUNCTION__,urb->transfer_flags );
1662 }
1663
1664 dbg("%s - port %d", __FUNCTION__, port->number);
1665
1666 if (port->open_count <= 0)
1667 return;
1668
1669 tty = port->tty;
1670 if (!tty) {
1671 dbg("%s - bad tty pointer - exiting",__FUNCTION__);
1672 return;
1673 }
1674
1675 priv = usb_get_serial_port_data(port);
1676 if (!priv) {
1677 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1678 return;
1679 }
1680
1681 if (urb != port->read_urb) {
1682 err("%s - Not my urb!", __FUNCTION__);
1683 }
1684
Greg Kroah-Hartman0fb0aa12007-06-15 15:44:13 -07001685 if (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686 /* This will happen at close every time so it is a dbg not an err */
Greg Kroah-Hartman0fb0aa12007-06-15 15:44:13 -07001687 dbg("(this is ok on close) nonzero read bulk status received: "
1688 "%d", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689 return;
1690 }
1691
Ian Abbott22465402006-06-26 12:59:17 +01001692 /* count data bytes, but not status bytes */
1693 countread = urb->actual_length;
1694 countread -= 2 * ((countread + (PKTSZ - 1)) / PKTSZ);
1695 spin_lock_irqsave(&priv->rx_lock, flags);
1696 priv->rx_bytes += countread;
1697 spin_unlock_irqrestore(&priv->rx_lock, flags);
1698
David Howellsc4028952006-11-22 14:57:56 +00001699 ftdi_process_read(&priv->rx_work.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700
1701} /* ftdi_read_bulk_callback */
1702
1703
David Howellsc4028952006-11-22 14:57:56 +00001704static void ftdi_process_read (struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705{ /* ftdi_process_read */
David Howellsc4028952006-11-22 14:57:56 +00001706 struct ftdi_private *priv =
1707 container_of(work, struct ftdi_private, rx_work.work);
1708 struct usb_serial_port *port = priv->port;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001709 struct urb *urb;
1710 struct tty_struct *tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001711 char error_flag;
David Brownell5c09d142006-10-13 15:57:58 -07001712 unsigned char *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713
1714 int i;
1715 int result;
1716 int need_flip;
1717 int packet_offset;
Ian Abbott76854ce2005-06-02 10:34:11 +01001718 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719
1720 dbg("%s - port %d", __FUNCTION__, port->number);
1721
1722 if (port->open_count <= 0)
1723 return;
1724
1725 tty = port->tty;
1726 if (!tty) {
1727 dbg("%s - bad tty pointer - exiting",__FUNCTION__);
1728 return;
1729 }
1730
1731 priv = usb_get_serial_port_data(port);
1732 if (!priv) {
1733 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1734 return;
1735 }
1736
1737 urb = port->read_urb;
1738 if (!urb) {
1739 dbg("%s - bad read_urb pointer - exiting", __FUNCTION__);
1740 return;
1741 }
1742
1743 data = urb->transfer_buffer;
1744
Ian Abbott76854ce2005-06-02 10:34:11 +01001745 if (priv->rx_processed) {
1746 dbg("%s - already processed: %d bytes, %d remain", __FUNCTION__,
1747 priv->rx_processed,
1748 urb->actual_length - priv->rx_processed);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749 } else {
Ian Abbott76854ce2005-06-02 10:34:11 +01001750 /* The first two bytes of every read packet are status */
1751 if (urb->actual_length > 2) {
1752 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
1753 } else {
1754 dbg("Status only: %03oo %03oo",data[0],data[1]);
1755 }
1756 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757
1758
1759 /* TO DO -- check for hung up line and handle appropriately: */
1760 /* send hangup */
1761 /* See acm.c - you do a tty_hangup - eg tty_hangup(tty) */
1762 /* if CD is dropped and the line is not CLOCAL then we should hangup */
1763
1764 need_flip = 0;
Ian Abbott76854ce2005-06-02 10:34:11 +01001765 for (packet_offset = priv->rx_processed; packet_offset < urb->actual_length; packet_offset += PKTSZ) {
1766 int length;
1767
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768 /* Compare new line status to the old one, signal if different */
Ian Abbott76854ce2005-06-02 10:34:11 +01001769 /* N.B. packet may be processed more than once, but differences
1770 * are only processed once. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771 if (priv != NULL) {
1772 char new_status = data[packet_offset+0] & FTDI_STATUS_B0_MASK;
1773 if (new_status != priv->prev_status) {
1774 priv->diff_status |= new_status ^ priv->prev_status;
1775 wake_up_interruptible(&priv->delta_msr_wait);
1776 priv->prev_status = new_status;
1777 }
1778 }
1779
Ian Abbott76854ce2005-06-02 10:34:11 +01001780 length = min(PKTSZ, urb->actual_length-packet_offset)-2;
1781 if (length < 0) {
1782 err("%s - bad packet length: %d", __FUNCTION__, length+2);
1783 length = 0;
1784 }
1785
Ian Abbott76854ce2005-06-02 10:34:11 +01001786 if (priv->rx_flags & THROTTLED) {
1787 dbg("%s - throttled", __FUNCTION__);
1788 break;
1789 }
Alan Cox33f0f882006-01-09 20:54:13 -08001790 if (tty_buffer_request_room(tty, length) < length) {
Ian Abbott76854ce2005-06-02 10:34:11 +01001791 /* break out & wait for throttling/unthrottling to happen */
1792 dbg("%s - receive room low", __FUNCTION__);
1793 break;
1794 }
1795
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796 /* Handle errors and break */
1797 error_flag = TTY_NORMAL;
1798 /* Although the device uses a bitmask and hence can have multiple */
1799 /* errors on a packet - the order here sets the priority the */
1800 /* error is returned to the tty layer */
1801
1802 if ( data[packet_offset+1] & FTDI_RS_OE ) {
1803 error_flag = TTY_OVERRUN;
1804 dbg("OVERRRUN error");
1805 }
1806 if ( data[packet_offset+1] & FTDI_RS_BI ) {
1807 error_flag = TTY_BREAK;
1808 dbg("BREAK received");
1809 }
1810 if ( data[packet_offset+1] & FTDI_RS_PE ) {
1811 error_flag = TTY_PARITY;
1812 dbg("PARITY error");
1813 }
1814 if ( data[packet_offset+1] & FTDI_RS_FE ) {
1815 error_flag = TTY_FRAME;
1816 dbg("FRAMING error");
1817 }
Ian Abbott76854ce2005-06-02 10:34:11 +01001818 if (length > 0) {
1819 for (i = 2; i < length+2; i++) {
David Brownell5c09d142006-10-13 15:57:58 -07001820 /* Note that the error flag is duplicated for
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821 every character received since we don't know
1822 which character it applied to */
1823 tty_insert_flip_char(tty, data[packet_offset+i], error_flag);
1824 }
1825 need_flip = 1;
1826 }
1827
1828#ifdef NOT_CORRECT_BUT_KEEPING_IT_FOR_NOW
1829 /* if a parity error is detected you get status packets forever
1830 until a character is sent without a parity error.
1831 This doesn't work well since the application receives a never
1832 ending stream of bad data - even though new data hasn't been sent.
1833 Therefore I (bill) have taken this out.
David Brownell5c09d142006-10-13 15:57:58 -07001834 However - this might make sense for framing errors and so on
Linus Torvalds1da177e2005-04-16 15:20:36 -07001835 so I am leaving the code in for now.
1836 */
1837 else {
1838 if (error_flag != TTY_NORMAL){
1839 dbg("error_flag is not normal");
1840 /* In this case it is just status - if that is an error send a bad character */
1841 if(tty->flip.count >= TTY_FLIPBUF_SIZE) {
1842 tty_flip_buffer_push(tty);
1843 }
1844 tty_insert_flip_char(tty, 0xff, error_flag);
1845 need_flip = 1;
1846 }
1847 }
1848#endif
1849 } /* "for(packet_offset=0..." */
1850
1851 /* Low latency */
1852 if (need_flip) {
1853 tty_flip_buffer_push(tty);
1854 }
1855
Ian Abbott76854ce2005-06-02 10:34:11 +01001856 if (packet_offset < urb->actual_length) {
1857 /* not completely processed - record progress */
1858 priv->rx_processed = packet_offset;
1859 dbg("%s - incomplete, %d bytes processed, %d remain",
1860 __FUNCTION__, packet_offset,
1861 urb->actual_length - packet_offset);
1862 /* check if we were throttled while processing */
1863 spin_lock_irqsave(&priv->rx_lock, flags);
1864 if (priv->rx_flags & THROTTLED) {
1865 priv->rx_flags |= ACTUALLY_THROTTLED;
1866 spin_unlock_irqrestore(&priv->rx_lock, flags);
1867 dbg("%s - deferring remainder until unthrottled",
1868 __FUNCTION__);
1869 return;
1870 }
1871 spin_unlock_irqrestore(&priv->rx_lock, flags);
1872 /* if the port is closed stop trying to read */
1873 if (port->open_count > 0){
1874 /* delay processing of remainder */
1875 schedule_delayed_work(&priv->rx_work, 1);
1876 } else {
1877 dbg("%s - port is closed", __FUNCTION__);
1878 }
1879 return;
1880 }
1881
1882 /* urb is completely processed */
1883 priv->rx_processed = 0;
1884
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885 /* if the port is closed stop trying to read */
1886 if (port->open_count > 0){
1887 /* Continue trying to always read */
David Brownell5c09d142006-10-13 15:57:58 -07001888 usb_fill_bulk_urb(port->read_urb, port->serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889 usb_rcvbulkpipe(port->serial->dev, port->bulk_in_endpointAddress),
1890 port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
1891 ftdi_read_bulk_callback, port);
1892
1893 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1894 if (result)
1895 err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
1896 }
1897
1898 return;
1899} /* ftdi_process_read */
1900
1901
1902static void ftdi_break_ctl( struct usb_serial_port *port, int break_state )
1903{
1904 struct ftdi_private *priv = usb_get_serial_port_data(port);
David Brownell5c09d142006-10-13 15:57:58 -07001905 __u16 urb_value = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906 char buf[1];
David Brownell5c09d142006-10-13 15:57:58 -07001907
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908 /* break_state = -1 to turn on break, and 0 to turn off break */
1909 /* see drivers/char/tty_io.c to see it used */
1910 /* last_set_data_urb_value NEVER has the break bit set in it */
1911
1912 if (break_state) {
1913 urb_value = priv->last_set_data_urb_value | FTDI_SIO_SET_BREAK;
1914 } else {
David Brownell5c09d142006-10-13 15:57:58 -07001915 urb_value = priv->last_set_data_urb_value;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916 }
1917
David Brownell5c09d142006-10-13 15:57:58 -07001918
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919 if (usb_control_msg(port->serial->dev, usb_sndctrlpipe(port->serial->dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07001920 FTDI_SIO_SET_DATA_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921 FTDI_SIO_SET_DATA_REQUEST_TYPE,
1922 urb_value , priv->interface,
1923 buf, 0, WDR_TIMEOUT) < 0) {
1924 err("%s FAILED to enable/disable break state (state was %d)", __FUNCTION__,break_state);
David Brownell5c09d142006-10-13 15:57:58 -07001925 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926
1927 dbg("%s break state is %d - urb is %d", __FUNCTION__,break_state, urb_value);
David Brownell5c09d142006-10-13 15:57:58 -07001928
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929}
1930
1931
1932/* old_termios contains the original termios settings and tty->termios contains
1933 * the new setting to be used
1934 * WARNING: set_termios calls this with old_termios in kernel space
1935 */
1936
Alan Cox606d0992006-12-08 02:38:45 -08001937static void ftdi_set_termios (struct usb_serial_port *port, struct ktermios *old_termios)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938{ /* ftdi_termios */
1939 struct usb_device *dev = port->serial->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940 struct ftdi_private *priv = usb_get_serial_port_data(port);
Alan Cox669a6db2007-10-18 01:24:24 -07001941 struct ktermios *termios = port->tty->termios;
1942 unsigned int cflag = termios->c_cflag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001943 __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
Alan Cox669a6db2007-10-18 01:24:24 -07001947 unsigned int iflag = termios->c_iflag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948 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. */
Alan Cox669a6db2007-10-18 01:24:24 -07001954 if (priv->force_baud && ((termios->c_cflag & CBAUD) != B0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955 dbg("%s: forcing baud rate for this device", __FUNCTION__);
Andrew Mortonbd5e47c2007-10-18 01:24:25 -07001956 tty_encode_baud_rate(port->tty, priv->force_baud,
1957 priv->force_baud);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001958 }
1959
1960 /* Force RTS-CTS if this device requires it. */
1961 if (priv->force_rtscts) {
1962 dbg("%s: forcing rtscts for this device", __FUNCTION__);
Alan Cox669a6db2007-10-18 01:24:24 -07001963 termios->c_cflag |= CRTSCTS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964 }
1965
Alan Cox669a6db2007-10-18 01:24:24 -07001966 cflag = termios->c_cflag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967
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
Alan Cox669a6db2007-10-18 01:24:24 -07001977 termios->c_cflag &= ~CMSPAR;
1978
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979 urb_value = 0;
1980 urb_value |= (cflag & CSTOPB ? FTDI_SIO_SET_DATA_STOP_BITS_2 :
1981 FTDI_SIO_SET_DATA_STOP_BITS_1);
David Brownell5c09d142006-10-13 15:57:58 -07001982 urb_value |= (cflag & PARENB ?
1983 (cflag & PARODD ? FTDI_SIO_SET_DATA_PARITY_ODD :
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984 FTDI_SIO_SET_DATA_PARITY_EVEN) :
1985 FTDI_SIO_SET_DATA_PARITY_NONE);
1986 if (cflag & CSIZE) {
1987 switch (cflag & CSIZE) {
1988 case CS5: urb_value |= 5; dbg("Setting CS5"); break;
1989 case CS6: urb_value |= 6; dbg("Setting CS6"); break;
1990 case CS7: urb_value |= 7; dbg("Setting CS7"); break;
1991 case CS8: urb_value |= 8; dbg("Setting CS8"); break;
1992 default:
1993 err("CSIZE was set but not CS5-CS8");
1994 }
1995 }
1996
1997 /* This is needed by the break command since it uses the same command - but is
1998 * or'ed with this value */
1999 priv->last_set_data_urb_value = urb_value;
David Brownell5c09d142006-10-13 15:57:58 -07002000
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002002 FTDI_SIO_SET_DATA_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003 FTDI_SIO_SET_DATA_REQUEST_TYPE,
2004 urb_value , priv->interface,
Ian Abbott279e1542005-07-29 12:16:52 -07002005 buf, 0, WDR_SHORT_TIMEOUT) < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006 err("%s FAILED to set databits/stopbits/parity", __FUNCTION__);
David Brownell5c09d142006-10-13 15:57:58 -07002007 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008
2009 /* Now do the baudrate */
2010 if ((cflag & CBAUD) == B0 ) {
2011 /* Disable flow control */
2012 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002013 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07002015 0, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016 buf, 0, WDR_TIMEOUT) < 0) {
2017 err("%s error from disable flowcontrol urb", __FUNCTION__);
David Brownell5c09d142006-10-13 15:57:58 -07002018 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019 /* Drop RTS and DTR */
Ian Abbott74ede0f2005-07-29 12:16:41 -07002020 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021 } else {
2022 /* set the baudrate determined before */
2023 if (change_speed(port)) {
Peter Favrholdt72a755f2005-09-22 00:48:49 -07002024 err("%s urb failed to set baudrate", __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025 }
Peter Favrholdt72a755f2005-09-22 00:48:49 -07002026 /* Ensure RTS and DTR are raised when baudrate changed from 0 */
Guennadi Liakhovetski57845bd2006-04-13 22:27:12 +02002027 if (!old_termios || (old_termios->c_cflag & CBAUD) == B0) {
Peter Favrholdt72a755f2005-09-22 00:48:49 -07002028 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2029 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030 }
2031
2032 /* Set flow control */
2033 /* Note device also supports DTR/CD (ugh) and Xon/Xoff in hardware */
2034 if (cflag & CRTSCTS) {
2035 dbg("%s Setting to CRTSCTS flow control", __FUNCTION__);
David Brownell5c09d142006-10-13 15:57:58 -07002036 if (usb_control_msg(dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037 usb_sndctrlpipe(dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002038 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002039 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2040 0 , (FTDI_SIO_RTS_CTS_HS | priv->interface),
2041 buf, 0, WDR_TIMEOUT) < 0) {
2042 err("urb failed to set to rts/cts flow control");
David Brownell5c09d142006-10-13 15:57:58 -07002043 }
2044
2045 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046 /*
2047 * Xon/Xoff code
2048 *
2049 * Check the IXOFF status in the iflag component of the termios structure
2050 * if IXOFF is not set, the pre-xon/xoff code is executed.
2051 */
2052 if (iflag & IXOFF) {
2053 dbg("%s request to enable xonxoff iflag=%04x",__FUNCTION__,iflag);
2054 // Try to enable the XON/XOFF on the ftdi_sio
2055 // Set the vstart and vstop -- could have been done up above where
2056 // a lot of other dereferencing is done but that would be very
2057 // inefficient as vstart and vstop are not always needed
Alan Cox669a6db2007-10-18 01:24:24 -07002058 vstart = termios->c_cc[VSTART];
2059 vstop = termios->c_cc[VSTOP];
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060 urb_value=(vstop << 8) | (vstart);
2061
2062 if (usb_control_msg(dev,
2063 usb_sndctrlpipe(dev, 0),
2064 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2065 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2066 urb_value , (FTDI_SIO_XON_XOFF_HS
2067 | priv->interface),
2068 buf, 0, WDR_TIMEOUT) < 0) {
2069 err("urb failed to set to xon/xoff flow control");
2070 }
2071 } else {
2072 /* else clause to only run if cfag ! CRTSCTS and iflag ! XOFF */
2073 /* CHECKME Assuming XON/XOFF handled by tty stack - not by device */
2074 dbg("%s Turning off hardware flow control", __FUNCTION__);
David Brownell5c09d142006-10-13 15:57:58 -07002075 if (usb_control_msg(dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076 usb_sndctrlpipe(dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002077 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07002079 0, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002080 buf, 0, WDR_TIMEOUT) < 0) {
2081 err("urb failed to clear flow control");
David Brownell5c09d142006-10-13 15:57:58 -07002082 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 }
David Brownell5c09d142006-10-13 15:57:58 -07002084
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085 }
2086 return;
2087} /* ftdi_termios */
2088
2089
2090static int ftdi_tiocmget (struct usb_serial_port *port, struct file *file)
2091{
2092 struct ftdi_private *priv = usb_get_serial_port_data(port);
2093 unsigned char buf[2];
2094 int ret;
2095
2096 dbg("%s TIOCMGET", __FUNCTION__);
2097 switch (priv->chip_type) {
2098 case SIO:
2099 /* Request the status from the device */
David Brownell5c09d142006-10-13 15:57:58 -07002100 if ((ret = usb_control_msg(port->serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101 usb_rcvctrlpipe(port->serial->dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002102 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07002104 0, 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105 buf, 1, WDR_TIMEOUT)) < 0 ) {
2106 err("%s Could not get modem status of device - err: %d", __FUNCTION__,
2107 ret);
2108 return(ret);
2109 }
2110 break;
2111 case FT8U232AM:
2112 case FT232BM:
2113 case FT2232C:
Andrew M. Bishoped6e5282007-08-21 19:08:56 +01002114 case FT232RL:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115 /* the 8U232AM returns a two byte value (the sio is a 1 byte value) - in the same
2116 format as the data returned from the in point */
David Brownell5c09d142006-10-13 15:57:58 -07002117 if ((ret = usb_control_msg(port->serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002118 usb_rcvctrlpipe(port->serial->dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002119 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07002121 0, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122 buf, 2, WDR_TIMEOUT)) < 0 ) {
2123 err("%s Could not get modem status of device - err: %d", __FUNCTION__,
2124 ret);
2125 return(ret);
2126 }
2127 break;
2128 default:
2129 return -EFAULT;
2130 break;
2131 }
David Brownell5c09d142006-10-13 15:57:58 -07002132
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133 return (buf[0] & FTDI_SIO_DSR_MASK ? TIOCM_DSR : 0) |
2134 (buf[0] & FTDI_SIO_CTS_MASK ? TIOCM_CTS : 0) |
2135 (buf[0] & FTDI_SIO_RI_MASK ? TIOCM_RI : 0) |
2136 (buf[0] & FTDI_SIO_RLSD_MASK ? TIOCM_CD : 0) |
David Brownell5c09d142006-10-13 15:57:58 -07002137 priv->last_dtr_rts;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138}
2139
2140static int ftdi_tiocmset(struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear)
2141{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142 dbg("%s TIOCMSET", __FUNCTION__);
Ian Abbott74ede0f2005-07-29 12:16:41 -07002143 return update_mctrl(port, set, clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144}
2145
2146
2147static int ftdi_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
2148{
2149 struct ftdi_private *priv = usb_get_serial_port_data(port);
2150
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151 dbg("%s cmd 0x%04x", __FUNCTION__, cmd);
2152
2153 /* Based on code from acm.c and others */
2154 switch (cmd) {
2155
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156 case TIOCGSERIAL: /* gets serial port data */
2157 return get_serial_info(port, (struct serial_struct __user *) arg);
2158
2159 case TIOCSSERIAL: /* sets serial port data */
2160 return set_serial_info(port, (struct serial_struct __user *) arg);
2161
2162 /*
2163 * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
2164 * - mask passed in arg for lines of interest
2165 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
2166 * Caller should use TIOCGICOUNT to see which one it was.
2167 *
2168 * This code is borrowed from linux/drivers/char/serial.c
2169 */
2170 case TIOCMIWAIT:
2171 while (priv != NULL) {
2172 interruptible_sleep_on(&priv->delta_msr_wait);
2173 /* see if a signal did it */
2174 if (signal_pending(current))
2175 return -ERESTARTSYS;
2176 else {
2177 char diff = priv->diff_status;
2178
2179 if (diff == 0) {
2180 return -EIO; /* no change => error */
2181 }
2182
2183 /* Consume all events */
2184 priv->diff_status = 0;
2185
2186 /* Return 0 if caller wanted to know about these bits */
2187 if ( ((arg & TIOCM_RNG) && (diff & FTDI_RS0_RI)) ||
2188 ((arg & TIOCM_DSR) && (diff & FTDI_RS0_DSR)) ||
2189 ((arg & TIOCM_CD) && (diff & FTDI_RS0_RLSD)) ||
2190 ((arg & TIOCM_CTS) && (diff & FTDI_RS0_CTS)) ) {
2191 return 0;
2192 }
2193 /*
2194 * Otherwise caller can't care less about what happened,
2195 * and so we continue to wait for more events.
2196 */
2197 }
2198 }
2199 return(0);
2200 break;
2201 default:
2202 break;
David Brownell5c09d142006-10-13 15:57:58 -07002203
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204 }
2205
2206
David Brownell5c09d142006-10-13 15:57:58 -07002207 /* This is not necessarily an error - turns out the higher layers will do
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208 * some ioctls itself (see comment above)
2209 */
2210 dbg("%s arg not supported - it was 0x%04x - check /usr/include/asm/ioctls.h", __FUNCTION__, cmd);
2211
2212 return(-ENOIOCTLCMD);
2213} /* ftdi_ioctl */
2214
2215
2216static void ftdi_throttle (struct usb_serial_port *port)
2217{
2218 struct ftdi_private *priv = usb_get_serial_port_data(port);
2219 unsigned long flags;
2220
2221 dbg("%s - port %d", __FUNCTION__, port->number);
2222
2223 spin_lock_irqsave(&priv->rx_lock, flags);
2224 priv->rx_flags |= THROTTLED;
2225 spin_unlock_irqrestore(&priv->rx_lock, flags);
2226}
2227
2228
2229static void ftdi_unthrottle (struct usb_serial_port *port)
2230{
2231 struct ftdi_private *priv = usb_get_serial_port_data(port);
2232 int actually_throttled;
2233 unsigned long flags;
2234
2235 dbg("%s - port %d", __FUNCTION__, port->number);
2236
2237 spin_lock_irqsave(&priv->rx_lock, flags);
2238 actually_throttled = priv->rx_flags & ACTUALLY_THROTTLED;
2239 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
2240 spin_unlock_irqrestore(&priv->rx_lock, flags);
2241
2242 if (actually_throttled)
David Howellsc4028952006-11-22 14:57:56 +00002243 schedule_delayed_work(&priv->rx_work, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002244}
2245
2246static int __init ftdi_init (void)
2247{
2248 int retval;
2249
2250 dbg("%s", __FUNCTION__);
Ian Abbottfdcb0a02005-07-28 18:40:32 +01002251 if (vendor > 0 && product > 0) {
2252 /* Add user specified VID/PID to reserved element of table. */
2253 int i;
2254 for (i = 0; id_table_combined[i].idVendor; i++)
2255 ;
2256 id_table_combined[i].match_flags = USB_DEVICE_ID_MATCH_DEVICE;
2257 id_table_combined[i].idVendor = vendor;
2258 id_table_combined[i].idProduct = product;
2259 }
Ian Abbott8f977e42005-06-20 16:45:42 +01002260 retval = usb_serial_register(&ftdi_sio_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261 if (retval)
Ian Abbott8f977e42005-06-20 16:45:42 +01002262 goto failed_sio_register;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263 retval = usb_register(&ftdi_driver);
David Brownell5c09d142006-10-13 15:57:58 -07002264 if (retval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265 goto failed_usb_register;
2266
2267 info(DRIVER_VERSION ":" DRIVER_DESC);
2268 return 0;
2269failed_usb_register:
Ian Abbott8f977e42005-06-20 16:45:42 +01002270 usb_serial_deregister(&ftdi_sio_device);
2271failed_sio_register:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002272 return retval;
2273}
2274
2275
2276static void __exit ftdi_exit (void)
2277{
2278
2279 dbg("%s", __FUNCTION__);
2280
2281 usb_deregister (&ftdi_driver);
Ian Abbott8f977e42005-06-20 16:45:42 +01002282 usb_serial_deregister (&ftdi_sio_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283
2284}
2285
2286
2287module_init(ftdi_init);
2288module_exit(ftdi_exit);
2289
2290MODULE_AUTHOR( DRIVER_AUTHOR );
2291MODULE_DESCRIPTION( DRIVER_DESC );
2292MODULE_LICENSE("GPL");
2293
2294module_param(debug, bool, S_IRUGO | S_IWUSR);
2295MODULE_PARM_DESC(debug, "Debug enabled or not");
Ian Abbottfdcb0a02005-07-28 18:40:32 +01002296module_param(vendor, ushort, 0);
2297MODULE_PARM_DESC(vendor, "User specified vendor ID (default="
2298 __MODULE_STRING(FTDI_VID)")");
2299module_param(product, ushort, 0);
2300MODULE_PARM_DESC(vendor, "User specified product ID");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301