blob: 7b1673a440775aaef3673915432cbed74c508051 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * USB FTDI SIO driver
3 *
David Brownell5c09d142006-10-13 15:57:58 -07004 * Copyright (C) 1999 - 2001
5 * Greg Kroah-Hartman (greg@kroah.com)
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 * Bill Ryder (bryder@sgi.com)
7 * Copyright (C) 2002
8 * Kuba Ober (kuba@mareimbrium.org)
9 *
David Brownell5c09d142006-10-13 15:57:58 -070010 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
Linus Torvalds1da177e2005-04-16 15:20:36 -070014 *
15 * See Documentation/usb/usb-serial.txt for more information on using this driver
16 *
17 * See http://ftdi-usb-sio.sourceforge.net for upto date testing info
18 * and extra documentation
19 *
20 * (21/Jul/2004) Ian Abbott
21 * Incorporated Steven Turner's code to add support for the FT2232C chip.
22 * The prelimilary port to the 2.6 kernel was by Rus V. Brushkoff. I have
23 * fixed a couple of things.
24 *
25 * (27/May/2004) Ian Abbott
26 * Improved throttling code, mostly stolen from the WhiteHEAT driver.
27 *
28 * (26/Mar/2004) Jan Capek
29 * Added PID's for ICD-U20/ICD-U40 - incircuit PIC debuggers from CCS Inc.
30 *
31 * (09/Feb/2004) Ian Abbott
32 * Changed full name of USB-UIRT device to avoid "/" character.
33 * Added FTDI's alternate PID (0x6006) for FT232/245 devices.
34 * Added PID for "ELV USB Module UO100" from Stefan Frings.
David Brownell5c09d142006-10-13 15:57:58 -070035 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070036 * (21/Oct/2003) Ian Abbott
37 * Renamed some VID/PID macros for Matrix Orbital and Perle Systems
38 * devices. Removed Matrix Orbital and Perle Systems devices from the
39 * 8U232AM device table, but left them in the FT232BM table, as they are
40 * known to use only FT232BM.
41 *
42 * (17/Oct/2003) Scott Allen
43 * Added vid/pid for Perle Systems UltraPort USB serial converters
44 *
45 * (21/Sep/2003) Ian Abbott
46 * Added VID/PID for Omnidirectional Control Technology US101 USB to
47 * RS-232 adapter (also rebadged as Dick Smith Electronics XH6381).
48 * VID/PID supplied by Donald Gordon.
49 *
50 * (19/Aug/2003) Ian Abbott
51 * Freed urb's transfer buffer in write bulk callback.
52 * Omitted some paranoid checks in write bulk callback that don't matter.
53 * Scheduled work in write bulk callback regardless of port's open count.
54 *
55 * (05/Aug/2003) Ian Abbott
56 * Added VID/PID for ID TECH IDT1221U USB to RS-232 adapter.
57 * VID/PID provided by Steve Briggs.
58 *
59 * (23/Jul/2003) Ian Abbott
60 * Added PIDs for CrystalFontz 547, 633, 631, 635, 640 and 640 from
61 * Wayne Wylupski.
62 *
63 * (10/Jul/2003) David Glance
64 * Added PID for DSS-20 SyncStation cradle for Sony-Ericsson P800.
65 *
66 * (27/Jun/2003) Ian Abbott
67 * Reworked the urb handling logic. We have no more pool, but dynamically
68 * allocate the urb and the transfer buffer on the fly. In testing this
69 * does not incure any measurable overhead. This also relies on the fact
70 * that we have proper reference counting logic for urbs. I nicked this
71 * from Greg KH's Visor driver.
David Brownell5c09d142006-10-13 15:57:58 -070072 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 * (23/Jun/2003) Ian Abbott
74 * Reduced flip buffer pushes and corrected a data length test in
75 * ftdi_read_bulk_callback.
76 * Defererence pointers after any paranoid checks, not before.
77 *
78 * (21/Jun/2003) Erik Nygren
Steven Cole093cf722005-05-03 19:07:24 -060079 * Added support for Home Electronics Tira-1 IR transceiver using FT232BM chip.
David Brownell5c09d142006-10-13 15:57:58 -070080 * See <http://www.home-electro.com/tira1.htm>. Only operates properly
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 * at 100000 and RTS-CTS, so set custom divisor mode on startup.
82 * Also force the Tira-1 and USB-UIRT to only use their custom baud rates.
83 *
84 * (18/Jun/2003) Ian Abbott
85 * Added Device ID of the USB relais from Rudolf Gugler (backported from
86 * Philipp Gühring's patch for 2.5.x kernel).
87 * Moved read transfer buffer reallocation into startup function.
88 * Free existing write urb and transfer buffer in startup function.
89 * Only use urbs in write urb pool that were successfully allocated.
90 * Moved some constant macros out of functions.
91 * Minor whitespace and comment changes.
92 *
93 * (12/Jun/2003) David Norwood
Steven Cole093cf722005-05-03 19:07:24 -060094 * Added support for USB-UIRT IR transceiver using 8U232AM chip.
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 * See <http://home.earthlink.net/~jrhees/USBUIRT/index.htm>. Only
96 * operates properly at 312500, so set custom divisor mode on startup.
97 *
98 * (12/Jun/2003) Ian Abbott
99 * Added Sealevel SeaLINK+ 210x, 220x, 240x, 280x vid/pids from Tuan Hoang
100 * - I've eliminated some that don't seem to exist!
101 * Added Home Electronics Tira-1 IR transceiver pid from Chris Horn
102 * Some whitespace/coding-style cleanups
103 *
104 * (11/Jun/2003) Ian Abbott
105 * Fixed unsafe spinlock usage in ftdi_write
106 *
107 * (24/Feb/2003) Richard Shooter
108 * Increase read buffer size to improve read speeds at higher baud rates
109 * (specifically tested with up to 1Mb/sec at 1.5M baud)
110 *
111 * (23/Feb/2003) John Wilkins
112 * Added Xon/xoff flow control (activating support in the ftdi device)
113 * Added vid/pid for Videonetworks/Homechoice (UK ISP)
114 *
115 * (23/Feb/2003) Bill Ryder
116 * Added matrix orb device vid/pids from Wayne Wylupski
117 *
118 * (19/Feb/2003) Ian Abbott
119 * For TIOCSSERIAL, set alt_speed to 0 when ASYNC_SPD_MASK value has
120 * changed to something other than ASYNC_SPD_HI, ASYNC_SPD_VHI,
121 * ASYNC_SPD_SHI or ASYNC_SPD_WARP. Also, unless ASYNC_SPD_CUST is in
122 * force, don't bother changing baud rate when custom_divisor has changed.
123 *
124 * (18/Feb/2003) Ian Abbott
125 * Fixed TIOCMGET handling to include state of DTR and RTS, the state
126 * of which are now saved by set_dtr() and set_rts().
127 * Fixed improper storage class for buf in set_dtr() and set_rts().
128 * Added FT232BM chip type and support for its extra baud rates (compared
129 * to FT8U232AM).
130 * Took account of special case divisor values for highest baud rates of
131 * FT8U232AM and FT232BM.
132 * For TIOCSSERIAL, forced alt_speed to 0 when ASYNC_SPD_CUST kludge used,
133 * as previous alt_speed setting is now stale.
134 * Moved startup code common between the startup routines for the
135 * different chip types into a common subroutine.
136 *
137 * (17/Feb/2003) Bill Ryder
138 * Added write urb buffer pool on a per device basis
139 * Added more checking for open file on callbacks (fixed OOPS)
David Brownell5c09d142006-10-13 15:57:58 -0700140 * Added CrystalFontz 632 and 634 PIDs
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 * (thanx to CrystalFontz for the sample devices - they flushed out
142 * some driver bugs)
143 * Minor debugging message changes
144 * Added throttle, unthrottle and chars_in_buffer functions
145 * Fixed FTDI_SIO (the original device) bug
146 * Fixed some shutdown handling
David Brownell5c09d142006-10-13 15:57:58 -0700147 *
148 *
149 *
150 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 * (07/Jun/2002) Kuba Ober
152 * Changed FTDI_SIO_BASE_BAUD_TO_DIVISOR macro into ftdi_baud_to_divisor
153 * function. It was getting too complex.
154 * Fix the divisor calculation logic which was setting divisor of 0.125
155 * instead of 0.5 for fractional parts of divisor equal to 5/8, 6/8, 7/8.
156 * Also make it bump up the divisor to next integer in case of 7/8 - it's
157 * a better approximation.
158 *
159 * (25/Jul/2002) Bill Ryder inserted Dmitri's TIOCMIWAIT patch
160 * Not tested by me but it doesn't break anything I use.
David Brownell5c09d142006-10-13 15:57:58 -0700161 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 * (04/Jan/2002) Kuba Ober
163 * Implemented 38400 baudrate kludge, where it can be substituted with other
164 * values. That's the only way to set custom baudrates.
165 * Implemented TIOCSSERIAL, TIOCGSERIAL ioctl's so that setserial is happy.
166 * FIXME: both baudrate things should eventually go to usbserial.c as other
167 * devices may need that functionality too. Actually, it can probably be
168 * merged in serial.c somehow - too many drivers repeat this code over
169 * and over.
170 * Fixed baudrate forgetfulness - open() used to reset baudrate to 9600 every time.
171 * Divisors for baudrates are calculated by a macro.
172 * Small code cleanups. Ugly whitespace changes for Plato's sake only ;-].
173 *
174 * (04/Nov/2001) Bill Ryder
175 * Fixed bug in read_bulk_callback where incorrect urb buffer was used.
176 * Cleaned up write offset calculation
177 * Added write_room since default values can be incorrect for sio
178 * Changed write_bulk_callback to use same queue_task as other drivers
179 * (the previous version caused panics)
180 * Removed port iteration code since the device only has one I/O port and it
181 * was wrong anyway.
David Brownell5c09d142006-10-13 15:57:58 -0700182 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 * (31/May/2001) gkh
184 * Switched from using spinlock to a semaphore, which fixes lots of problems.
185 *
186 * (23/May/2001) Bill Ryder
187 * Added runtime debug patch (thanx Tyson D Sawyer).
188 * Cleaned up comments for 8U232
189 * Added parity, framing and overrun error handling
190 * Added receive break handling.
David Brownell5c09d142006-10-13 15:57:58 -0700191 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 * (04/08/2001) gb
193 * Identify version on module load.
David Brownell5c09d142006-10-13 15:57:58 -0700194 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 * (18/March/2001) Bill Ryder
196 * (Not released)
197 * Added send break handling. (requires kernel patch too)
198 * Fixed 8U232AM hardware RTS/CTS etc status reporting.
199 * Added flipbuf fix copied from generic device
David Brownell5c09d142006-10-13 15:57:58 -0700200 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 * (12/3/2000) Bill Ryder
202 * Added support for 8U232AM device.
203 * Moved PID and VIDs into header file only.
204 * Turned on low-latency for the tty (device will do high baudrates)
205 * Added shutdown routine to close files when device removed.
206 * More debug and error message cleanups.
207 *
208 * (11/13/2000) Bill Ryder
209 * Added spinlock protected open code and close code.
210 * Multiple opens work (sort of - see webpage mentioned above).
211 * Cleaned up comments. Removed multiple PID/VID definitions.
212 * Factorised cts/dtr code
213 * Made use of __FUNCTION__ in dbg's
David Brownell5c09d142006-10-13 15:57:58 -0700214 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 * (11/01/2000) Adam J. Richter
216 * usb_device_id table support
David Brownell5c09d142006-10-13 15:57:58 -0700217 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 * (10/05/2000) gkh
219 * Fixed bug with urb->dev not being set properly, now that the usb
220 * core needs it.
David Brownell5c09d142006-10-13 15:57:58 -0700221 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 * (09/11/2000) gkh
223 * Removed DEBUG #ifdefs with call to usb_serial_debug_data
224 *
225 * (07/19/2000) gkh
226 * Added module_init and module_exit functions to handle the fact that this
227 * driver is a loadable module now.
228 *
David Brownell5c09d142006-10-13 15:57:58 -0700229 * (04/04/2000) Bill Ryder
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 * Fixed bugs in TCGET/TCSET ioctls (by removing them - they are
231 * handled elsewhere in the tty io driver chain).
232 *
David Brownell5c09d142006-10-13 15:57:58 -0700233 * (03/30/2000) Bill Ryder
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 * Implemented lots of ioctls
235 * Fixed a race condition in write
236 * Changed some dbg's to errs
237 *
238 * (03/26/2000) gkh
239 * Split driver up into device specific pieces.
240 *
241 */
242
243/* Bill Ryder - bryder@sgi.com - wrote the FTDI_SIO implementation */
244/* Thanx to FTDI for so kindly providing details of the protocol required */
245/* to talk to the device */
246/* Thanx to gkh and the rest of the usb dev group for all code I have assimilated :-) */
247
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248#include <linux/kernel.h>
249#include <linux/errno.h>
250#include <linux/init.h>
251#include <linux/slab.h>
252#include <linux/tty.h>
253#include <linux/tty_driver.h>
254#include <linux/tty_flip.h>
255#include <linux/module.h>
256#include <linux/spinlock.h>
257#include <asm/uaccess.h>
258#include <linux/usb.h>
259#include <linux/serial.h>
Greg Kroah-Hartmana9698882006-07-11 21:22:58 -0700260#include <linux/usb/serial.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261#include "ftdi_sio.h"
262
263/*
264 * Version Information
265 */
Ian Abbott8f977e42005-06-20 16:45:42 +0100266#define DRIVER_VERSION "v1.4.3"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267#define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>, Bill Ryder <bryder@sgi.com>, Kuba Ober <kuba@mareimbrium.org>"
268#define DRIVER_DESC "USB FTDI Serial Converters Driver"
269
270static int debug;
Ian Abbottfdcb0a02005-07-28 18:40:32 +0100271static __u16 vendor = FTDI_VID;
272static __u16 product;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273
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
297 int force_baud; /* if non-zero, force the baud rate to this value */
298 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) },
Rui Santosc9c77462005-09-23 20:06:50 +0100541 { USB_DEVICE(FTDI_VID, FTDI_ARTEMIS_PID) },
542 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16_PID) },
Rui Santos09c280a2006-01-09 13:12:40 +0000543 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16C_PID) },
Rui Santosc9c77462005-09-23 20:06:50 +0100544 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HR_PID) },
Rui Santos09c280a2006-01-09 13:12:40 +0000545 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HRC_PID) },
Ian Abbottb4723ae2005-11-23 15:45:23 -0800546 { USB_DEVICE(KOBIL_VID, KOBIL_CONV_B1_PID) },
547 { USB_DEVICE(KOBIL_VID, KOBIL_CONV_KAAN_PID) },
Pavel Fedineffac8b2005-12-09 09:30:59 +0300548 { USB_DEVICE(POSIFLEX_VID, POSIFLEX_PP7000_PID) },
Louis Nyffenegger641adaa2006-01-05 17:20:37 +0100549 { USB_DEVICE(FTDI_VID, FTDI_TTUSB_PID) },
Ian Abbott7e1c0b82006-03-21 14:55:20 +0000550 { USB_DEVICE(FTDI_VID, FTDI_ECLO_COM_1WIRE_PID) },
Ian Abbotta94b52a2006-01-09 17:11:40 +0000551 { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_777_PID) },
552 { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_8900F_PID) },
Wouter Paesence40d292006-01-03 14:30:31 +0100553 { USB_DEVICE(FTDI_VID, FTDI_PCDJ_DAC2_PID) },
Nathan Bronsoncdd3b152006-04-10 00:05:09 -0400554 { USB_DEVICE(FTDI_VID, FTDI_RRCIRKITS_LOCOBUFFER_PID) },
Ian Abbott7e0258f2006-04-12 15:20:35 +0100555 { USB_DEVICE(FTDI_VID, FTDI_ASK_RDR400_PID) },
A. Maitland Bottomsbf58fbd2006-03-14 18:44:23 -0500556 { USB_DEVICE(ICOM_ID1_VID, ICOM_ID1_PID) },
Folkert van Heusden62a13db2006-03-28 20:41:26 +0900557 { USB_DEVICE(PAPOUCH_VID, PAPOUCH_TMU_PID) },
Ian Abbott20a0f472006-05-04 11:34:25 +0100558 { USB_DEVICE(FTDI_VID, FTDI_ACG_HFDUAL_PID) },
Ian Abbotteb79b4f2006-05-30 12:36:30 +0100559 { USB_DEVICE(FTDI_VID, FTDI_YEI_SERVOCENTER31_PID) },
D. Peter Siddons48437482006-06-17 18:09:15 -0400560 { USB_DEVICE(FTDI_VID, FTDI_THORLABS_PID) },
Colin Leroye1979fe2006-07-11 11:36:43 +0200561 { USB_DEVICE(TESTO_VID, TESTO_USB_INTERFACE_PID) },
Ralf Schlatterbeckeaede2c2006-09-06 12:15:02 +0200562 { USB_DEVICE(FTDI_VID, FTDI_GAMMA_SCOUT_PID) },
Ian Abbott9978f9e2006-09-25 14:19:19 +0100563 { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13M_PID) },
564 { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13S_PID) },
565 { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13U_PID) },
Kjell Myksvoll40c36092006-10-22 23:26:42 +0200566 { USB_DEVICE(ELEKTOR_VID, ELEKTOR_FT323R_PID) },
Micke Prag822c7ef2007-02-04 23:39:11 +0100567 { USB_DEVICE(TELLDUS_VID, TELLDUS_TELLSTICK_PID) },
Neil \"Superna\" ARMSTRONG762e92f2007-04-25 20:34:28 +0200568 { USB_DEVICE(FTDI_VID, FTDI_MAXSTREAM_PID) },
Tony Lindgrenfa91d432007-05-04 18:23:24 -0700569 { USB_DEVICE(OLIMEX_VID, OLIMEX_ARM_USB_OCD_PID),
570 .driver_info = (kernel_ulong_t)&ftdi_olimex_quirk },
Ian Abbottfdcb0a02005-07-28 18:40:32 +0100571 { }, /* Optional parameter entry */
572 { } /* Terminating entry */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573};
574
575MODULE_DEVICE_TABLE (usb, id_table_combined);
576
577static struct usb_driver ftdi_driver = {
578 .name = "ftdi_sio",
579 .probe = usb_serial_probe,
580 .disconnect = usb_serial_disconnect,
581 .id_table = id_table_combined,
David Brownell5c09d142006-10-13 15:57:58 -0700582 .no_dynamic_id = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583};
584
Arjan van de Ven4c4c9432005-11-29 09:43:42 +0100585static const char *ftdi_chip_name[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 [SIO] = "SIO", /* the serial part of FT8U100AX */
587 [FT8U232AM] = "FT8U232AM",
588 [FT232BM] = "FT232BM",
589 [FT2232C] = "FT2232C",
Gard Spreemannd8b21602007-03-05 00:03:26 +0100590 [FT232RL] = "FT232RL",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591};
592
593
594/* Constants for read urb and write urb */
595#define BUFSZ 512
596#define PKTSZ 64
597
598/* rx_flags */
599#define THROTTLED 0x01
600#define ACTUALLY_THROTTLED 0x02
601
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602/* Used for TIOCMIWAIT */
603#define FTDI_STATUS_B0_MASK (FTDI_RS0_CTS | FTDI_RS0_DSR | FTDI_RS0_RI | FTDI_RS0_RLSD)
604#define FTDI_STATUS_B1_MASK (FTDI_RS_BI)
605/* End TIOCMIWAIT */
606
607#define FTDI_IMPL_ASYNC_FLAGS = ( ASYNC_SPD_HI | ASYNC_SPD_VHI \
608 ASYNC_SPD_CUST | ASYNC_SPD_SHI | ASYNC_SPD_WARP )
609
610/* function prototypes for a FTDI serial converter */
Ian Abbott8f977e42005-06-20 16:45:42 +0100611static int ftdi_sio_probe (struct usb_serial *serial, const struct usb_device_id *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612static void ftdi_shutdown (struct usb_serial *serial);
Jim Radford12bdbe02007-02-28 10:10:50 -0800613static int ftdi_sio_port_probe (struct usb_serial_port *port);
614static int ftdi_sio_port_remove (struct usb_serial_port *port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615static int ftdi_open (struct usb_serial_port *port, struct file *filp);
616static void ftdi_close (struct usb_serial_port *port, struct file *filp);
617static int ftdi_write (struct usb_serial_port *port, const unsigned char *buf, int count);
618static int ftdi_write_room (struct usb_serial_port *port);
619static int ftdi_chars_in_buffer (struct usb_serial_port *port);
David Howells7d12e782006-10-05 14:55:46 +0100620static void ftdi_write_bulk_callback (struct urb *urb);
621static void ftdi_read_bulk_callback (struct urb *urb);
David Howellsc4028952006-11-22 14:57:56 +0000622static void ftdi_process_read (struct work_struct *work);
Alan Cox606d0992006-12-08 02:38:45 -0800623static void ftdi_set_termios (struct usb_serial_port *port, struct ktermios * old);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624static int ftdi_tiocmget (struct usb_serial_port *port, struct file *file);
625static int ftdi_tiocmset (struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear);
626static int ftdi_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg);
627static void ftdi_break_ctl (struct usb_serial_port *port, int break_state );
628static void ftdi_throttle (struct usb_serial_port *port);
629static void ftdi_unthrottle (struct usb_serial_port *port);
630
631static unsigned short int ftdi_232am_baud_base_to_divisor (int baud, int base);
632static unsigned short int ftdi_232am_baud_to_divisor (int baud);
633static __u32 ftdi_232bm_baud_base_to_divisor (int baud, int base);
634static __u32 ftdi_232bm_baud_to_divisor (int baud);
635
Greg Kroah-Hartmanea653702005-06-20 21:15:16 -0700636static struct usb_serial_driver ftdi_sio_device = {
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700637 .driver = {
638 .owner = THIS_MODULE,
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700639 .name = "ftdi_sio",
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700640 },
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700641 .description = "FTDI USB Serial Device",
Johannes Hölzld9b1b782006-12-17 21:50:24 +0100642 .usb_driver = &ftdi_driver ,
Ian Abbott8f977e42005-06-20 16:45:42 +0100643 .id_table = id_table_combined,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 .num_interrupt_in = 0,
645 .num_bulk_in = 1,
646 .num_bulk_out = 1,
647 .num_ports = 1,
Ian Abbott8f977e42005-06-20 16:45:42 +0100648 .probe = ftdi_sio_probe,
Jim Radford12bdbe02007-02-28 10:10:50 -0800649 .port_probe = ftdi_sio_port_probe,
650 .port_remove = ftdi_sio_port_remove,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 .open = ftdi_open,
652 .close = ftdi_close,
653 .throttle = ftdi_throttle,
654 .unthrottle = ftdi_unthrottle,
655 .write = ftdi_write,
656 .write_room = ftdi_write_room,
657 .chars_in_buffer = ftdi_chars_in_buffer,
658 .read_bulk_callback = ftdi_read_bulk_callback,
659 .write_bulk_callback = ftdi_write_bulk_callback,
660 .tiocmget = ftdi_tiocmget,
661 .tiocmset = ftdi_tiocmset,
662 .ioctl = ftdi_ioctl,
663 .set_termios = ftdi_set_termios,
664 .break_ctl = ftdi_break_ctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665 .shutdown = ftdi_shutdown,
666};
667
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668
669#define WDR_TIMEOUT 5000 /* default urb timeout */
Ian Abbott279e1542005-07-29 12:16:52 -0700670#define WDR_SHORT_TIMEOUT 1000 /* shorter urb timeout */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671
672/* High and low are for DTR, RTS etc etc */
673#define HIGH 1
674#define LOW 0
675
Ian Abbott22465402006-06-26 12:59:17 +0100676/* number of outstanding urbs to prevent userspace DoS from happening */
677#define URB_UPPER_LIMIT 42
678
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679/*
680 * ***************************************************************************
Tony Lindgrenfa91d432007-05-04 18:23:24 -0700681 * Utility functions
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 * ***************************************************************************
683 */
684
685static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base)
686{
687 unsigned short int divisor;
688 int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
689 if ((divisor3 & 0x7) == 7) divisor3 ++; // round x.7/8 up to x+1
690 divisor = divisor3 >> 3;
691 divisor3 &= 0x7;
692 if (divisor3 == 1) divisor |= 0xc000; else // 0.125
693 if (divisor3 >= 4) divisor |= 0x4000; else // 0.5
694 if (divisor3 != 0) divisor |= 0x8000; // 0.25
695 if (divisor == 1) divisor = 0; /* special case for maximum baud rate */
696 return divisor;
697}
698
699static unsigned short int ftdi_232am_baud_to_divisor(int baud)
700{
701 return(ftdi_232am_baud_base_to_divisor(baud, 48000000));
702}
703
704static __u32 ftdi_232bm_baud_base_to_divisor(int baud, int base)
705{
706 static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
707 __u32 divisor;
708 int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
709 divisor = divisor3 >> 3;
710 divisor |= (__u32)divfrac[divisor3 & 0x7] << 14;
711 /* Deal with special cases for highest baud rates. */
712 if (divisor == 1) divisor = 0; else // 1.0
713 if (divisor == 0x4001) divisor = 1; // 1.5
714 return divisor;
715}
716
717static __u32 ftdi_232bm_baud_to_divisor(int baud)
718{
719 return(ftdi_232bm_baud_base_to_divisor(baud, 48000000));
720}
721
Ian Abbott74ede0f2005-07-29 12:16:41 -0700722#define set_mctrl(port, set) update_mctrl((port), (set), 0)
723#define clear_mctrl(port, clear) update_mctrl((port), 0, (clear))
724
725static int update_mctrl(struct usb_serial_port *port, unsigned int set, unsigned int clear)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726{
727 struct ftdi_private *priv = usb_get_serial_port_data(port);
728 char *buf;
Ian Abbott74ede0f2005-07-29 12:16:41 -0700729 unsigned urb_value;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 int rv;
Ian Abbott74ede0f2005-07-29 12:16:41 -0700731
732 if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
733 dbg("%s - DTR|RTS not being set|cleared", __FUNCTION__);
734 return 0; /* no change */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 }
Ian Abbott74ede0f2005-07-29 12:16:41 -0700736
737 buf = kmalloc(1, GFP_NOIO);
738 if (!buf) {
739 return -ENOMEM;
740 }
741
742 clear &= ~set; /* 'set' takes precedence over 'clear' */
743 urb_value = 0;
744 if (clear & TIOCM_DTR)
745 urb_value |= FTDI_SIO_SET_DTR_LOW;
746 if (clear & TIOCM_RTS)
747 urb_value |= FTDI_SIO_SET_RTS_LOW;
748 if (set & TIOCM_DTR)
749 urb_value |= FTDI_SIO_SET_DTR_HIGH;
750 if (set & TIOCM_RTS)
751 urb_value |= FTDI_SIO_SET_RTS_HIGH;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 rv = usb_control_msg(port->serial->dev,
753 usb_sndctrlpipe(port->serial->dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -0700754 FTDI_SIO_SET_MODEM_CTRL_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE,
Ian Abbott74ede0f2005-07-29 12:16:41 -0700756 urb_value, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 buf, 0, WDR_TIMEOUT);
758
759 kfree(buf);
Ian Abbott74ede0f2005-07-29 12:16:41 -0700760 if (rv < 0) {
761 err("%s Error from MODEM_CTRL urb: DTR %s, RTS %s",
762 __FUNCTION__,
763 (set & TIOCM_DTR) ? "HIGH" :
764 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
765 (set & TIOCM_RTS) ? "HIGH" :
766 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 } else {
Ian Abbott74ede0f2005-07-29 12:16:41 -0700768 dbg("%s - DTR %s, RTS %s", __FUNCTION__,
769 (set & TIOCM_DTR) ? "HIGH" :
770 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
771 (set & TIOCM_RTS) ? "HIGH" :
772 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
773 priv->last_dtr_rts = (priv->last_dtr_rts & ~clear) | set;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 return rv;
776}
777
778
779static __u32 get_ftdi_divisor(struct usb_serial_port * port);
780
781
782static int change_speed(struct usb_serial_port *port)
783{
784 struct ftdi_private *priv = usb_get_serial_port_data(port);
785 char *buf;
786 __u16 urb_value;
787 __u16 urb_index;
788 __u32 urb_index_value;
789 int rv;
790
791 buf = kmalloc(1, GFP_NOIO);
792 if (!buf)
793 return -ENOMEM;
794
795 urb_index_value = get_ftdi_divisor(port);
796 urb_value = (__u16)urb_index_value;
797 urb_index = (__u16)(urb_index_value >> 16);
798 if (priv->interface) { /* FT2232C */
799 urb_index = (__u16)((urb_index << 8) | priv->interface);
800 }
David Brownell5c09d142006-10-13 15:57:58 -0700801
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 rv = usb_control_msg(port->serial->dev,
803 usb_sndctrlpipe(port->serial->dev, 0),
804 FTDI_SIO_SET_BAUDRATE_REQUEST,
805 FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE,
806 urb_value, urb_index,
Ian Abbott279e1542005-07-29 12:16:52 -0700807 buf, 0, WDR_SHORT_TIMEOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808
809 kfree(buf);
810 return rv;
811}
812
813
814static __u32 get_ftdi_divisor(struct usb_serial_port * port)
815{ /* get_ftdi_divisor */
816 struct ftdi_private *priv = usb_get_serial_port_data(port);
817 __u32 div_value = 0;
818 int div_okay = 1;
819 int baud;
820
821 /*
822 * The logic involved in setting the baudrate can be cleanly split in 3 steps.
823 * Obtaining the actual baud rate is a little tricky since unix traditionally
824 * somehow ignored the possibility to set non-standard baud rates.
825 * 1. Standard baud rates are set in tty->termios->c_cflag
826 * 2. If these are not enough, you can set any speed using alt_speed as follows:
827 * - set tty->termios->c_cflag speed to B38400
828 * - set your real speed in tty->alt_speed; it gets ignored when
829 * alt_speed==0, (or)
830 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
831 * flags & ASYNC_SPD_MASK == ASYNC_SPD_[HI, VHI, SHI, WARP], this just
832 * sets alt_speed to (HI: 57600, VHI: 115200, SHI: 230400, WARP: 460800)
833 * ** Steps 1, 2 are done courtesy of tty_get_baud_rate
834 * 3. You can also set baud rate by setting custom divisor as follows
835 * - set tty->termios->c_cflag speed to B38400
836 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
837 * o flags & ASYNC_SPD_MASK == ASYNC_SPD_CUST
838 * o custom_divisor set to baud_base / your_new_baudrate
839 * ** Step 3 is done courtesy of code borrowed from serial.c - I should really
840 * spend some time and separate+move this common code to serial.c, it is
841 * replicated in nearly every serial driver you see.
842 */
843
844 /* 1. Get the baud rate from the tty settings, this observes alt_speed hack */
845
846 baud = tty_get_baud_rate(port->tty);
847 dbg("%s - tty_get_baud_rate reports speed %d", __FUNCTION__, baud);
848
849 /* 2. Observe async-compatible custom_divisor hack, update baudrate if needed */
850
851 if (baud == 38400 &&
852 ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
853 (priv->custom_divisor)) {
854 baud = priv->baud_base / priv->custom_divisor;
855 dbg("%s - custom divisor %d sets baud rate to %d", __FUNCTION__, priv->custom_divisor, baud);
856 }
857
858 /* 3. Convert baudrate to device-specific divisor */
859
David Brownell5c09d142006-10-13 15:57:58 -0700860 if (!baud) baud = 9600;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 switch(priv->chip_type) {
862 case SIO: /* SIO chip */
863 switch(baud) {
864 case 300: div_value = ftdi_sio_b300; break;
865 case 600: div_value = ftdi_sio_b600; break;
866 case 1200: div_value = ftdi_sio_b1200; break;
867 case 2400: div_value = ftdi_sio_b2400; break;
868 case 4800: div_value = ftdi_sio_b4800; break;
869 case 9600: div_value = ftdi_sio_b9600; break;
870 case 19200: div_value = ftdi_sio_b19200; break;
871 case 38400: div_value = ftdi_sio_b38400; break;
872 case 57600: div_value = ftdi_sio_b57600; break;
873 case 115200: div_value = ftdi_sio_b115200; break;
874 } /* baud */
875 if (div_value == 0) {
David Brownell5c09d142006-10-13 15:57:58 -0700876 dbg("%s - Baudrate (%d) requested is not supported", __FUNCTION__, baud);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877 div_value = ftdi_sio_b9600;
878 div_okay = 0;
879 }
880 break;
881 case FT8U232AM: /* 8U232AM chip */
882 if (baud <= 3000000) {
883 div_value = ftdi_232am_baud_to_divisor(baud);
884 } else {
885 dbg("%s - Baud rate too high!", __FUNCTION__);
886 div_value = ftdi_232am_baud_to_divisor(9600);
887 div_okay = 0;
888 }
889 break;
890 case FT232BM: /* FT232BM chip */
891 case FT2232C: /* FT2232C chip */
David Brownell3b009c62007-03-23 12:54:27 -0700892 case FT232RL:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893 if (baud <= 3000000) {
894 div_value = ftdi_232bm_baud_to_divisor(baud);
895 } else {
896 dbg("%s - Baud rate too high!", __FUNCTION__);
897 div_value = ftdi_232bm_baud_to_divisor(9600);
898 div_okay = 0;
899 }
900 break;
901 } /* priv->chip_type */
902
903 if (div_okay) {
904 dbg("%s - Baud rate set to %d (divisor 0x%lX) on chip %s",
905 __FUNCTION__, baud, (unsigned long)div_value,
906 ftdi_chip_name[priv->chip_type]);
907 }
908
909 return(div_value);
910}
911
912
913static int get_serial_info(struct usb_serial_port * port, struct serial_struct __user * retinfo)
914{
915 struct ftdi_private *priv = usb_get_serial_port_data(port);
916 struct serial_struct tmp;
917
918 if (!retinfo)
919 return -EFAULT;
920 memset(&tmp, 0, sizeof(tmp));
921 tmp.flags = priv->flags;
922 tmp.baud_base = priv->baud_base;
923 tmp.custom_divisor = priv->custom_divisor;
924 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
925 return -EFAULT;
926 return 0;
927} /* get_serial_info */
928
929
930static int set_serial_info(struct usb_serial_port * port, struct serial_struct __user * newinfo)
931{ /* set_serial_info */
932 struct ftdi_private *priv = usb_get_serial_port_data(port);
933 struct serial_struct new_serial;
934 struct ftdi_private old_priv;
935
936 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
937 return -EFAULT;
938 old_priv = * priv;
939
940 /* Do error checking and permission checking */
941
942 if (!capable(CAP_SYS_ADMIN)) {
943 if (((new_serial.flags & ~ASYNC_USR_MASK) !=
944 (priv->flags & ~ASYNC_USR_MASK)))
945 return -EPERM;
946 priv->flags = ((priv->flags & ~ASYNC_USR_MASK) |
947 (new_serial.flags & ASYNC_USR_MASK));
948 priv->custom_divisor = new_serial.custom_divisor;
949 goto check_and_exit;
950 }
951
952 if ((new_serial.baud_base != priv->baud_base) &&
953 (new_serial.baud_base < 9600))
954 return -EINVAL;
955
956 /* Make the changes - these are privileged changes! */
957
958 priv->flags = ((priv->flags & ~ASYNC_FLAGS) |
David Brownell5c09d142006-10-13 15:57:58 -0700959 (new_serial.flags & ASYNC_FLAGS));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 priv->custom_divisor = new_serial.custom_divisor;
961
962 port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
963
964check_and_exit:
965 if ((old_priv.flags & ASYNC_SPD_MASK) !=
966 (priv->flags & ASYNC_SPD_MASK)) {
967 if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_HI)
968 port->tty->alt_speed = 57600;
969 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_VHI)
970 port->tty->alt_speed = 115200;
971 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_SHI)
972 port->tty->alt_speed = 230400;
973 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_WARP)
974 port->tty->alt_speed = 460800;
975 else
976 port->tty->alt_speed = 0;
977 }
978 if (((old_priv.flags & ASYNC_SPD_MASK) !=
979 (priv->flags & ASYNC_SPD_MASK)) ||
980 (((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
981 (old_priv.custom_divisor != priv->custom_divisor))) {
982 change_speed(port);
983 }
David Brownell5c09d142006-10-13 15:57:58 -0700984
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985 return (0);
986
987} /* set_serial_info */
988
989
Ian Abbott8f977e42005-06-20 16:45:42 +0100990/* Determine type of FTDI chip based on USB config and descriptor. */
991static void ftdi_determine_type(struct usb_serial_port *port)
992{
993 struct ftdi_private *priv = usb_get_serial_port_data(port);
994 struct usb_serial *serial = port->serial;
995 struct usb_device *udev = serial->dev;
996 unsigned version;
997 unsigned interfaces;
998
999 /* Assume it is not the original SIO device for now. */
Ian Abbottf5e09b72005-09-12 12:23:25 +01001000 priv->baud_base = 48000000 / 2;
Ian Abbott8f977e42005-06-20 16:45:42 +01001001 priv->write_offset = 0;
1002
1003 version = le16_to_cpu(udev->descriptor.bcdDevice);
1004 interfaces = udev->actconfig->desc.bNumInterfaces;
1005 dbg("%s: bcdDevice = 0x%x, bNumInterfaces = %u", __FUNCTION__,
1006 version, interfaces);
1007 if (interfaces > 1) {
1008 int inter;
1009
1010 /* Multiple interfaces. Assume FT2232C. */
1011 priv->chip_type = FT2232C;
1012 /* Determine interface code. */
1013 inter = serial->interface->altsetting->desc.bInterfaceNumber;
1014 if (inter == 0) {
1015 priv->interface = PIT_SIOA;
1016 } else {
1017 priv->interface = PIT_SIOB;
1018 }
1019 /* BM-type devices have a bug where bcdDevice gets set
1020 * to 0x200 when iSerialNumber is 0. */
1021 if (version < 0x500) {
1022 dbg("%s: something fishy - bcdDevice too low for multi-interface device",
1023 __FUNCTION__);
1024 }
1025 } else if (version < 0x200) {
1026 /* Old device. Assume its the original SIO. */
1027 priv->chip_type = SIO;
1028 priv->baud_base = 12000000 / 16;
1029 priv->write_offset = 1;
1030 } else if (version < 0x400) {
1031 /* Assume its an FT8U232AM (or FT8U245AM) */
1032 /* (It might be a BM because of the iSerialNumber bug,
1033 * but it will still work as an AM device.) */
1034 priv->chip_type = FT8U232AM;
David Brownell3b009c62007-03-23 12:54:27 -07001035 } else if (version < 0x600) {
Ian Abbott8f977e42005-06-20 16:45:42 +01001036 /* Assume its an FT232BM (or FT245BM) */
1037 priv->chip_type = FT232BM;
David Brownell3b009c62007-03-23 12:54:27 -07001038 } else {
1039 /* Assume its an FT232R */
1040 priv->chip_type = FT232RL;
Ian Abbott8f977e42005-06-20 16:45:42 +01001041 }
1042 info("Detected %s", ftdi_chip_name[priv->chip_type]);
1043}
1044
1045
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046/*
1047 * ***************************************************************************
1048 * Sysfs Attribute
1049 * ***************************************************************************
1050 */
1051
Yani Ioannou060b8842005-05-17 06:44:04 -04001052static ssize_t show_latency_timer(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053{
1054 struct usb_serial_port *port = to_usb_serial_port(dev);
1055 struct ftdi_private *priv = usb_get_serial_port_data(port);
Jim Radford12bdbe02007-02-28 10:10:50 -08001056 struct usb_device *udev = port->serial->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 unsigned short latency = 0;
1058 int rv = 0;
David Brownell5c09d142006-10-13 15:57:58 -07001059
David Brownell5c09d142006-10-13 15:57:58 -07001060
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061 dbg("%s",__FUNCTION__);
David Brownell5c09d142006-10-13 15:57:58 -07001062
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063 rv = usb_control_msg(udev,
1064 usb_rcvctrlpipe(udev, 0),
1065 FTDI_SIO_GET_LATENCY_TIMER_REQUEST,
1066 FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07001067 0, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068 (char*) &latency, 1, WDR_TIMEOUT);
David Brownell5c09d142006-10-13 15:57:58 -07001069
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070 if (rv < 0) {
1071 dev_err(dev, "Unable to read latency timer: %i", rv);
1072 return -EIO;
1073 }
1074 return sprintf(buf, "%i\n", latency);
1075}
1076
1077/* Write a new value of the latency timer, in units of milliseconds. */
Yani Ioannou060b8842005-05-17 06:44:04 -04001078static ssize_t store_latency_timer(struct device *dev, struct device_attribute *attr, const char *valbuf,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 size_t count)
1080{
1081 struct usb_serial_port *port = to_usb_serial_port(dev);
1082 struct ftdi_private *priv = usb_get_serial_port_data(port);
Jim Radford12bdbe02007-02-28 10:10:50 -08001083 struct usb_device *udev = port->serial->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084 char buf[1];
1085 int v = simple_strtoul(valbuf, NULL, 10);
1086 int rv = 0;
David Brownell5c09d142006-10-13 15:57:58 -07001087
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088 dbg("%s: setting latency timer = %i", __FUNCTION__, v);
David Brownell5c09d142006-10-13 15:57:58 -07001089
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090 rv = usb_control_msg(udev,
1091 usb_sndctrlpipe(udev, 0),
1092 FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
1093 FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07001094 v, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095 buf, 0, WDR_TIMEOUT);
David Brownell5c09d142006-10-13 15:57:58 -07001096
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 if (rv < 0) {
1098 dev_err(dev, "Unable to write latency timer: %i", rv);
1099 return -EIO;
1100 }
David Brownell5c09d142006-10-13 15:57:58 -07001101
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102 return count;
1103}
1104
1105/* Write an event character directly to the FTDI register. The ASCII
1106 value is in the low 8 bits, with the enable bit in the 9th bit. */
Yani Ioannou060b8842005-05-17 06:44:04 -04001107static ssize_t store_event_char(struct device *dev, struct device_attribute *attr, const char *valbuf,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108 size_t count)
1109{
1110 struct usb_serial_port *port = to_usb_serial_port(dev);
1111 struct ftdi_private *priv = usb_get_serial_port_data(port);
Jim Radford12bdbe02007-02-28 10:10:50 -08001112 struct usb_device *udev = port->serial->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113 char buf[1];
1114 int v = simple_strtoul(valbuf, NULL, 10);
1115 int rv = 0;
David Brownell5c09d142006-10-13 15:57:58 -07001116
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117 dbg("%s: setting event char = %i", __FUNCTION__, v);
David Brownell5c09d142006-10-13 15:57:58 -07001118
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119 rv = usb_control_msg(udev,
1120 usb_sndctrlpipe(udev, 0),
1121 FTDI_SIO_SET_EVENT_CHAR_REQUEST,
1122 FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07001123 v, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124 buf, 0, WDR_TIMEOUT);
David Brownell5c09d142006-10-13 15:57:58 -07001125
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126 if (rv < 0) {
1127 dbg("Unable to write event character: %i", rv);
1128 return -EIO;
1129 }
David Brownell5c09d142006-10-13 15:57:58 -07001130
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131 return count;
1132}
1133
1134static DEVICE_ATTR(latency_timer, S_IWUSR | S_IRUGO, show_latency_timer, store_latency_timer);
1135static DEVICE_ATTR(event_char, S_IWUSR, NULL, store_event_char);
1136
Jim Radford12bdbe02007-02-28 10:10:50 -08001137static int create_sysfs_attrs(struct usb_serial_port *port)
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001138{
Jim Radford12bdbe02007-02-28 10:10:50 -08001139 struct ftdi_private *priv = usb_get_serial_port_data(port);
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001140 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141
1142 dbg("%s",__FUNCTION__);
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001143
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144 /* XXX I've no idea if the original SIO supports the event_char
1145 * sysfs parameter, so I'm playing it safe. */
1146 if (priv->chip_type != SIO) {
1147 dbg("sysfs attributes for %s", ftdi_chip_name[priv->chip_type]);
Jim Radford12bdbe02007-02-28 10:10:50 -08001148 retval = device_create_file(&port->dev, &dev_attr_event_char);
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001149 if ((!retval) &&
Stepan Moskovchenko97cd49e2007-05-09 14:53:04 -04001150 (priv->chip_type == FT232BM ||
1151 priv->chip_type == FT2232C ||
1152 priv->chip_type == FT232RL)) {
Jim Radford12bdbe02007-02-28 10:10:50 -08001153 retval = device_create_file(&port->dev,
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001154 &dev_attr_latency_timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155 }
1156 }
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001157 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158}
1159
Jim Radford12bdbe02007-02-28 10:10:50 -08001160static void remove_sysfs_attrs(struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161{
Jim Radford12bdbe02007-02-28 10:10:50 -08001162 struct ftdi_private *priv = usb_get_serial_port_data(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163
David Brownell5c09d142006-10-13 15:57:58 -07001164 dbg("%s",__FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166 /* XXX see create_sysfs_attrs */
1167 if (priv->chip_type != SIO) {
Jim Radford12bdbe02007-02-28 10:10:50 -08001168 device_remove_file(&port->dev, &dev_attr_event_char);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169 if (priv->chip_type == FT232BM || priv->chip_type == FT2232C) {
Jim Radford12bdbe02007-02-28 10:10:50 -08001170 device_remove_file(&port->dev, &dev_attr_latency_timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171 }
1172 }
David Brownell5c09d142006-10-13 15:57:58 -07001173
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174}
1175
1176/*
1177 * ***************************************************************************
1178 * FTDI driver specific functions
1179 * ***************************************************************************
1180 */
1181
Ian Abbott8f977e42005-06-20 16:45:42 +01001182/* Probe function to check for special devices */
1183static int ftdi_sio_probe (struct usb_serial *serial, const struct usb_device_id *id)
1184{
Tony Lindgrenfa91d432007-05-04 18:23:24 -07001185 struct ftdi_sio_quirk *quirk = (struct ftdi_sio_quirk *)id->driver_info;
1186
1187 if (quirk && quirk->probe) {
1188 int ret = quirk->probe(serial);
1189 if (ret != 0)
1190 return ret;
1191 }
1192
Ian Abbott8f977e42005-06-20 16:45:42 +01001193 usb_set_serial_data(serial, (void *)id->driver_info);
1194
Tony Lindgrenfa91d432007-05-04 18:23:24 -07001195 return 0;
Ian Abbott8f977e42005-06-20 16:45:42 +01001196}
1197
Jim Radford12bdbe02007-02-28 10:10:50 -08001198static int ftdi_sio_port_probe(struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200 struct ftdi_private *priv;
Oliver Neukum0ffbbe22007-07-09 12:03:08 -07001201 struct ftdi_sio_quirk *quirk = usb_get_serial_data(port->serial);
1202
Greg Kroah-Hartman13f4db92006-08-28 11:43:25 -07001203
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204 dbg("%s",__FUNCTION__);
1205
Eric Sesterhenn80b6ca42006-02-27 21:29:43 +01001206 priv = kzalloc(sizeof(struct ftdi_private), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207 if (!priv){
1208 err("%s- kmalloc(%Zd) failed.", __FUNCTION__, sizeof(struct ftdi_private));
1209 return -ENOMEM;
1210 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211
1212 spin_lock_init(&priv->rx_lock);
Ian Abbott22465402006-06-26 12:59:17 +01001213 spin_lock_init(&priv->tx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214 init_waitqueue_head(&priv->delta_msr_wait);
1215 /* This will push the characters through immediately rather
1216 than queue a task to deliver them */
1217 priv->flags = ASYNC_LOW_LATENCY;
1218
Oliver Neukum0ffbbe22007-07-09 12:03:08 -07001219 if (quirk && quirk->port_probe)
1220 quirk->port_probe(priv);
1221
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222 /* Increase the size of read buffers */
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07001223 kfree(port->bulk_in_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224 port->bulk_in_buffer = kmalloc (BUFSZ, GFP_KERNEL);
1225 if (!port->bulk_in_buffer) {
1226 kfree (priv);
1227 return -ENOMEM;
1228 }
1229 if (port->read_urb) {
1230 port->read_urb->transfer_buffer = port->bulk_in_buffer;
1231 port->read_urb->transfer_buffer_length = BUFSZ;
1232 }
1233
David Howellsc4028952006-11-22 14:57:56 +00001234 INIT_DELAYED_WORK(&priv->rx_work, ftdi_process_read);
1235 priv->port = port;
Ian Abbott76854ce2005-06-02 10:34:11 +01001236
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237 /* Free port's existing write urb and transfer buffer. */
1238 if (port->write_urb) {
1239 usb_free_urb (port->write_urb);
1240 port->write_urb = NULL;
1241 }
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07001242 kfree(port->bulk_out_buffer);
1243 port->bulk_out_buffer = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244
Jim Radford12bdbe02007-02-28 10:10:50 -08001245 usb_set_serial_port_data(port, priv);
Ian Abbott8f977e42005-06-20 16:45:42 +01001246
Jim Radford12bdbe02007-02-28 10:10:50 -08001247 ftdi_determine_type (port);
1248 create_sysfs_attrs(port);
1249 return 0;
1250}
Ian Abbott8f977e42005-06-20 16:45:42 +01001251
Ian Abbott8f977e42005-06-20 16:45:42 +01001252/* Setup for the USB-UIRT device, which requires hardwired
1253 * baudrate (38400 gets mapped to 312500) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254/* Called from usbserial:serial_probe */
Oliver Neukum0ffbbe22007-07-09 12:03:08 -07001255static void ftdi_USB_UIRT_setup (struct ftdi_private *priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 dbg("%s",__FUNCTION__);
1258
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259 priv->flags |= ASYNC_SPD_CUST;
1260 priv->custom_divisor = 77;
1261 priv->force_baud = B38400;
Ian Abbott8f977e42005-06-20 16:45:42 +01001262} /* ftdi_USB_UIRT_setup */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263
Ian Abbott8f977e42005-06-20 16:45:42 +01001264/* Setup for the HE-TIRA1 device, which requires hardwired
1265 * baudrate (38400 gets mapped to 100000) and RTS-CTS enabled. */
Oliver Neukum0ffbbe22007-07-09 12:03:08 -07001266static void ftdi_HE_TIRA1_setup (struct ftdi_private *priv)
Ian Abbott8f977e42005-06-20 16:45:42 +01001267{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268 dbg("%s",__FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270 priv->flags |= ASYNC_SPD_CUST;
1271 priv->custom_divisor = 240;
1272 priv->force_baud = B38400;
1273 priv->force_rtscts = 1;
Ian Abbott8f977e42005-06-20 16:45:42 +01001274} /* ftdi_HE_TIRA1_setup */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275
Tony Lindgrenfa91d432007-05-04 18:23:24 -07001276/*
1277 * First port on Olimex arm-usb-ocd is reserved for JTAG interface
1278 * and can be accessed from userspace using openocd.
1279 */
1280static int ftdi_olimex_probe(struct usb_serial *serial)
1281{
1282 struct usb_device *udev = serial->dev;
1283 struct usb_interface *interface = serial->interface;
1284
1285 dbg("%s",__FUNCTION__);
1286
1287 if (interface == udev->actconfig->interface[0]) {
1288 info("Ignoring reserved serial port on Olimex arm-usb-ocd\n");
1289 return -ENODEV;
1290 }
1291
1292 return 0;
1293}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294
David Brownell5c09d142006-10-13 15:57:58 -07001295/* ftdi_shutdown is called from usbserial:usb_serial_disconnect
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296 * it is called when the usb device is disconnected
1297 *
1298 * usbserial:usb_serial_disconnect
1299 * calls __serial_close for each open of the port
1300 * shutdown is called then (ie ftdi_shutdown)
1301 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302static void ftdi_shutdown (struct usb_serial *serial)
Jim Radford12bdbe02007-02-28 10:10:50 -08001303{
1304 dbg("%s", __FUNCTION__);
1305}
David Brownell5c09d142006-10-13 15:57:58 -07001306
Jim Radford12bdbe02007-02-28 10:10:50 -08001307static int ftdi_sio_port_remove(struct usb_serial_port *port)
1308{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309 struct ftdi_private *priv = usb_get_serial_port_data(port);
1310
1311 dbg("%s", __FUNCTION__);
1312
Jim Radford12bdbe02007-02-28 10:10:50 -08001313 remove_sysfs_attrs(port);
David Brownell5c09d142006-10-13 15:57:58 -07001314
1315 /* all open ports are closed at this point
1316 * (by usbserial.c:__serial_close, which calls ftdi_close)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 */
1318
1319 if (priv) {
1320 usb_set_serial_port_data(port, NULL);
1321 kfree(priv);
1322 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323
Jim Radford12bdbe02007-02-28 10:10:50 -08001324 return 0;
1325}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326
1327static int ftdi_open (struct usb_serial_port *port, struct file *filp)
1328{ /* ftdi_open */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329 struct usb_device *dev = port->serial->dev;
1330 struct ftdi_private *priv = usb_get_serial_port_data(port);
1331 unsigned long flags;
David Brownell5c09d142006-10-13 15:57:58 -07001332
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 int result = 0;
1334 char buf[1]; /* Needed for the usb_control_msg I think */
1335
1336 dbg("%s", __FUNCTION__);
1337
Ian Abbott22465402006-06-26 12:59:17 +01001338 spin_lock_irqsave(&priv->tx_lock, flags);
1339 priv->tx_bytes = 0;
1340 spin_unlock_irqrestore(&priv->tx_lock, flags);
1341 spin_lock_irqsave(&priv->rx_lock, flags);
1342 priv->rx_bytes = 0;
1343 spin_unlock_irqrestore(&priv->rx_lock, flags);
1344
Guennadi Liakhovetski57845bd2006-04-13 22:27:12 +02001345 if (port->tty)
1346 port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347
1348 /* No error checking for this (will get errors later anyway) */
1349 /* See ftdi_sio.h for description of what is reset */
1350 usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07001351 FTDI_SIO_RESET_REQUEST, FTDI_SIO_RESET_REQUEST_TYPE,
1352 FTDI_SIO_RESET_SIO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353 priv->interface, buf, 0, WDR_TIMEOUT);
1354
1355 /* Termios defaults are set by usb_serial_init. We don't change
1356 port->tty->termios - this would loose speed settings, etc.
1357 This is same behaviour as serial.c/rs_open() - Kuba */
1358
1359 /* ftdi_set_termios will send usb control messages */
Guennadi Liakhovetski57845bd2006-04-13 22:27:12 +02001360 if (port->tty)
1361 ftdi_set_termios(port, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362
1363 /* FIXME: Flow control might be enabled, so it should be checked -
1364 we have no control of defaults! */
1365 /* Turn on RTS and DTR since we are not flow controlling by default */
Ian Abbott74ede0f2005-07-29 12:16:41 -07001366 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367
1368 /* Not throttled */
1369 spin_lock_irqsave(&priv->rx_lock, flags);
1370 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
1371 spin_unlock_irqrestore(&priv->rx_lock, flags);
1372
1373 /* Start reading from the device */
Ian Abbott76854ce2005-06-02 10:34:11 +01001374 priv->rx_processed = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375 usb_fill_bulk_urb(port->read_urb, dev,
1376 usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress),
1377 port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
1378 ftdi_read_bulk_callback, port);
1379 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
1380 if (result)
1381 err("%s - failed submitting read urb, error %d", __FUNCTION__, result);
1382
1383
1384 return result;
1385} /* ftdi_open */
1386
1387
1388
David Brownell5c09d142006-10-13 15:57:58 -07001389/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 * usbserial:__serial_close only calls ftdi_close if the point is open
1391 *
1392 * This only gets called when it is the last close
David Brownell5c09d142006-10-13 15:57:58 -07001393 *
1394 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395 */
1396
1397static void ftdi_close (struct usb_serial_port *port, struct file *filp)
1398{ /* ftdi_close */
1399 unsigned int c_cflag = port->tty->termios->c_cflag;
1400 struct ftdi_private *priv = usb_get_serial_port_data(port);
1401 char buf[1];
1402
1403 dbg("%s", __FUNCTION__);
1404
1405 if (c_cflag & HUPCL){
1406 /* Disable flow control */
David Brownell5c09d142006-10-13 15:57:58 -07001407 if (usb_control_msg(port->serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408 usb_sndctrlpipe(port->serial->dev, 0),
1409 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1410 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1411 0, priv->interface, buf, 0,
1412 WDR_TIMEOUT) < 0) {
1413 err("error from flowcontrol urb");
David Brownell5c09d142006-10-13 15:57:58 -07001414 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415
Ian Abbott74ede0f2005-07-29 12:16:41 -07001416 /* drop RTS and DTR */
1417 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418 } /* Note change no line if hupcl is off */
Ian Abbott76854ce2005-06-02 10:34:11 +01001419
1420 /* cancel any scheduled reading */
1421 cancel_delayed_work(&priv->rx_work);
1422 flush_scheduled_work();
David Brownell5c09d142006-10-13 15:57:58 -07001423
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424 /* shutdown our bulk read */
Mariusz Kozlowski794c9442006-11-08 15:36:25 +01001425 usb_kill_urb(port->read_urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426} /* ftdi_close */
1427
1428
David Brownell5c09d142006-10-13 15:57:58 -07001429
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430/* The SIO requires the first byte to have:
1431 * B0 1
1432 * B1 0
1433 * B2..7 length of message excluding byte 0
1434 *
1435 * The new devices do not require this byte
1436 */
1437static int ftdi_write (struct usb_serial_port *port,
1438 const unsigned char *buf, int count)
1439{ /* ftdi_write */
1440 struct ftdi_private *priv = usb_get_serial_port_data(port);
1441 struct urb *urb;
1442 unsigned char *buffer;
1443 int data_offset ; /* will be 1 for the SIO and 0 otherwise */
1444 int status;
1445 int transfer_size;
Ian Abbott22465402006-06-26 12:59:17 +01001446 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447
1448 dbg("%s port %d, %d bytes", __FUNCTION__, port->number, count);
1449
1450 if (count == 0) {
1451 dbg("write request of 0 bytes");
1452 return 0;
1453 }
Ian Abbott22465402006-06-26 12:59:17 +01001454 spin_lock_irqsave(&priv->tx_lock, flags);
1455 if (priv->tx_outstanding_urbs > URB_UPPER_LIMIT) {
1456 spin_unlock_irqrestore(&priv->tx_lock, flags);
1457 dbg("%s - write limit hit\n", __FUNCTION__);
1458 return 0;
1459 }
Oliver Neukum62127a52007-03-23 14:30:16 +01001460 priv->tx_outstanding_urbs++;
Ian Abbott22465402006-06-26 12:59:17 +01001461 spin_unlock_irqrestore(&priv->tx_lock, flags);
David Brownell5c09d142006-10-13 15:57:58 -07001462
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463 data_offset = priv->write_offset;
1464 dbg("data_offset set to %d",data_offset);
1465
1466 /* Determine total transfer size */
1467 transfer_size = count;
1468 if (data_offset > 0) {
1469 /* Original sio needs control bytes too... */
1470 transfer_size += (data_offset *
1471 ((count + (PKTSZ - 1 - data_offset)) /
1472 (PKTSZ - data_offset)));
1473 }
1474
1475 buffer = kmalloc (transfer_size, GFP_ATOMIC);
1476 if (!buffer) {
1477 err("%s ran out of kernel memory for urb ...", __FUNCTION__);
Oliver Neukum62127a52007-03-23 14:30:16 +01001478 count = -ENOMEM;
1479 goto error_no_buffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480 }
1481
1482 urb = usb_alloc_urb(0, GFP_ATOMIC);
1483 if (!urb) {
1484 err("%s - no more free urbs", __FUNCTION__);
Oliver Neukum62127a52007-03-23 14:30:16 +01001485 count = -ENOMEM;
1486 goto error_no_urb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001487 }
1488
1489 /* Copy data */
1490 if (data_offset > 0) {
1491 /* Original sio requires control byte at start of each packet. */
1492 int user_pktsz = PKTSZ - data_offset;
1493 int todo = count;
1494 unsigned char *first_byte = buffer;
1495 const unsigned char *current_position = buf;
1496
1497 while (todo > 0) {
1498 if (user_pktsz > todo) {
1499 user_pktsz = todo;
1500 }
1501 /* Write the control byte at the front of the packet*/
David Brownell5c09d142006-10-13 15:57:58 -07001502 *first_byte = 1 | ((user_pktsz) << 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503 /* Copy data for packet */
1504 memcpy (first_byte + data_offset,
1505 current_position, user_pktsz);
1506 first_byte += user_pktsz + data_offset;
1507 current_position += user_pktsz;
1508 todo -= user_pktsz;
1509 }
1510 } else {
1511 /* No control byte required. */
1512 /* Copy in the data to send */
1513 memcpy (buffer, buf, count);
1514 }
1515
1516 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, transfer_size, buffer);
1517
1518 /* fill the buffer and send it */
David Brownell5c09d142006-10-13 15:57:58 -07001519 usb_fill_bulk_urb(urb, port->serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520 usb_sndbulkpipe(port->serial->dev, port->bulk_out_endpointAddress),
1521 buffer, transfer_size,
1522 ftdi_write_bulk_callback, port);
1523
1524 status = usb_submit_urb(urb, GFP_ATOMIC);
1525 if (status) {
1526 err("%s - failed submitting write urb, error %d", __FUNCTION__, status);
1527 count = status;
Oliver Neukum62127a52007-03-23 14:30:16 +01001528 goto error;
Ian Abbott22465402006-06-26 12:59:17 +01001529 } else {
1530 spin_lock_irqsave(&priv->tx_lock, flags);
Ian Abbott22465402006-06-26 12:59:17 +01001531 priv->tx_outstanding_bytes += count;
1532 priv->tx_bytes += count;
1533 spin_unlock_irqrestore(&priv->tx_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534 }
1535
1536 /* we are done with this urb, so let the host driver
1537 * really free it when it is finished with it */
Oliver Neukum62127a52007-03-23 14:30:16 +01001538 usb_free_urb(urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539
1540 dbg("%s write returning: %d", __FUNCTION__, count);
1541 return count;
Oliver Neukum62127a52007-03-23 14:30:16 +01001542error:
1543 usb_free_urb(urb);
1544error_no_urb:
1545 kfree (buffer);
1546error_no_buffer:
1547 spin_lock_irqsave(&priv->tx_lock, flags);
1548 priv->tx_outstanding_urbs--;
1549 spin_unlock_irqrestore(&priv->tx_lock, flags);
1550 return count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551} /* ftdi_write */
1552
1553
1554/* This function may get called when the device is closed */
1555
David Howells7d12e782006-10-05 14:55:46 +01001556static void ftdi_write_bulk_callback (struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557{
Ian Abbott22465402006-06-26 12:59:17 +01001558 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
Ian Abbott22465402006-06-26 12:59:17 +01001560 struct ftdi_private *priv;
1561 int data_offset; /* will be 1 for the SIO and 0 otherwise */
1562 unsigned long countback;
Greg Kroah-Hartman0fb0aa12007-06-15 15:44:13 -07001563 int status = urb->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564
1565 /* free up the transfer buffer, as usb_free_urb() does not do this */
1566 kfree (urb->transfer_buffer);
1567
1568 dbg("%s - port %d", __FUNCTION__, port->number);
David Brownell5c09d142006-10-13 15:57:58 -07001569
Greg Kroah-Hartman0fb0aa12007-06-15 15:44:13 -07001570 if (status) {
1571 dbg("nonzero write bulk status received: %d", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572 return;
1573 }
1574
Ian Abbott22465402006-06-26 12:59:17 +01001575 priv = usb_get_serial_port_data(port);
1576 if (!priv) {
1577 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1578 return;
1579 }
1580 /* account for transferred data */
1581 countback = urb->actual_length;
1582 data_offset = priv->write_offset;
1583 if (data_offset > 0) {
1584 /* Subtract the control bytes */
1585 countback -= (data_offset * ((countback + (PKTSZ - 1)) / PKTSZ));
1586 }
1587 spin_lock_irqsave(&priv->tx_lock, flags);
1588 --priv->tx_outstanding_urbs;
1589 priv->tx_outstanding_bytes -= countback;
1590 spin_unlock_irqrestore(&priv->tx_lock, flags);
1591
Pete Zaitcevcf2c7482006-05-22 21:58:49 -07001592 usb_serial_port_softint(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593} /* ftdi_write_bulk_callback */
1594
1595
1596static int ftdi_write_room( struct usb_serial_port *port )
1597{
Ian Abbott22465402006-06-26 12:59:17 +01001598 struct ftdi_private *priv = usb_get_serial_port_data(port);
1599 int room;
1600 unsigned long flags;
1601
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602 dbg("%s - port %d", __FUNCTION__, port->number);
1603
Ian Abbott22465402006-06-26 12:59:17 +01001604 spin_lock_irqsave(&priv->tx_lock, flags);
1605 if (priv->tx_outstanding_urbs < URB_UPPER_LIMIT) {
1606 /*
1607 * We really can take anything the user throws at us
1608 * but let's pick a nice big number to tell the tty
1609 * layer that we have lots of free space
1610 */
1611 room = 2048;
1612 } else {
1613 room = 0;
1614 }
1615 spin_unlock_irqrestore(&priv->tx_lock, flags);
1616 return room;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617} /* ftdi_write_room */
1618
1619
1620static int ftdi_chars_in_buffer (struct usb_serial_port *port)
1621{ /* ftdi_chars_in_buffer */
Ian Abbott22465402006-06-26 12:59:17 +01001622 struct ftdi_private *priv = usb_get_serial_port_data(port);
1623 int buffered;
1624 unsigned long flags;
1625
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 dbg("%s - port %d", __FUNCTION__, port->number);
1627
Ian Abbott22465402006-06-26 12:59:17 +01001628 spin_lock_irqsave(&priv->tx_lock, flags);
1629 buffered = (int)priv->tx_outstanding_bytes;
1630 spin_unlock_irqrestore(&priv->tx_lock, flags);
1631 if (buffered < 0) {
1632 err("%s outstanding tx bytes is negative!", __FUNCTION__);
1633 buffered = 0;
1634 }
1635 return buffered;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636} /* ftdi_chars_in_buffer */
1637
1638
1639
David Howells7d12e782006-10-05 14:55:46 +01001640static void ftdi_read_bulk_callback (struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641{ /* ftdi_read_bulk_callback */
1642 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1643 struct tty_struct *tty;
1644 struct ftdi_private *priv;
Ian Abbott22465402006-06-26 12:59:17 +01001645 unsigned long countread;
1646 unsigned long flags;
Greg Kroah-Hartman0fb0aa12007-06-15 15:44:13 -07001647 int status = urb->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648
1649 if (urb->number_of_packets > 0) {
1650 err("%s transfer_buffer_length %d actual_length %d number of packets %d",__FUNCTION__,
1651 urb->transfer_buffer_length, urb->actual_length, urb->number_of_packets );
1652 err("%s transfer_flags %x ", __FUNCTION__,urb->transfer_flags );
1653 }
1654
1655 dbg("%s - port %d", __FUNCTION__, port->number);
1656
1657 if (port->open_count <= 0)
1658 return;
1659
1660 tty = port->tty;
1661 if (!tty) {
1662 dbg("%s - bad tty pointer - exiting",__FUNCTION__);
1663 return;
1664 }
1665
1666 priv = usb_get_serial_port_data(port);
1667 if (!priv) {
1668 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1669 return;
1670 }
1671
1672 if (urb != port->read_urb) {
1673 err("%s - Not my urb!", __FUNCTION__);
1674 }
1675
Greg Kroah-Hartman0fb0aa12007-06-15 15:44:13 -07001676 if (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677 /* This will happen at close every time so it is a dbg not an err */
Greg Kroah-Hartman0fb0aa12007-06-15 15:44:13 -07001678 dbg("(this is ok on close) nonzero read bulk status received: "
1679 "%d", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680 return;
1681 }
1682
Ian Abbott22465402006-06-26 12:59:17 +01001683 /* count data bytes, but not status bytes */
1684 countread = urb->actual_length;
1685 countread -= 2 * ((countread + (PKTSZ - 1)) / PKTSZ);
1686 spin_lock_irqsave(&priv->rx_lock, flags);
1687 priv->rx_bytes += countread;
1688 spin_unlock_irqrestore(&priv->rx_lock, flags);
1689
David Howellsc4028952006-11-22 14:57:56 +00001690 ftdi_process_read(&priv->rx_work.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691
1692} /* ftdi_read_bulk_callback */
1693
1694
David Howellsc4028952006-11-22 14:57:56 +00001695static void ftdi_process_read (struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696{ /* ftdi_process_read */
David Howellsc4028952006-11-22 14:57:56 +00001697 struct ftdi_private *priv =
1698 container_of(work, struct ftdi_private, rx_work.work);
1699 struct usb_serial_port *port = priv->port;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700 struct urb *urb;
1701 struct tty_struct *tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702 char error_flag;
David Brownell5c09d142006-10-13 15:57:58 -07001703 unsigned char *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001704
1705 int i;
1706 int result;
1707 int need_flip;
1708 int packet_offset;
Ian Abbott76854ce2005-06-02 10:34:11 +01001709 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710
1711 dbg("%s - port %d", __FUNCTION__, port->number);
1712
1713 if (port->open_count <= 0)
1714 return;
1715
1716 tty = port->tty;
1717 if (!tty) {
1718 dbg("%s - bad tty pointer - exiting",__FUNCTION__);
1719 return;
1720 }
1721
1722 priv = usb_get_serial_port_data(port);
1723 if (!priv) {
1724 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1725 return;
1726 }
1727
1728 urb = port->read_urb;
1729 if (!urb) {
1730 dbg("%s - bad read_urb pointer - exiting", __FUNCTION__);
1731 return;
1732 }
1733
1734 data = urb->transfer_buffer;
1735
Ian Abbott76854ce2005-06-02 10:34:11 +01001736 if (priv->rx_processed) {
1737 dbg("%s - already processed: %d bytes, %d remain", __FUNCTION__,
1738 priv->rx_processed,
1739 urb->actual_length - priv->rx_processed);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740 } else {
Ian Abbott76854ce2005-06-02 10:34:11 +01001741 /* The first two bytes of every read packet are status */
1742 if (urb->actual_length > 2) {
1743 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
1744 } else {
1745 dbg("Status only: %03oo %03oo",data[0],data[1]);
1746 }
1747 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001748
1749
1750 /* TO DO -- check for hung up line and handle appropriately: */
1751 /* send hangup */
1752 /* See acm.c - you do a tty_hangup - eg tty_hangup(tty) */
1753 /* if CD is dropped and the line is not CLOCAL then we should hangup */
1754
1755 need_flip = 0;
Ian Abbott76854ce2005-06-02 10:34:11 +01001756 for (packet_offset = priv->rx_processed; packet_offset < urb->actual_length; packet_offset += PKTSZ) {
1757 int length;
1758
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759 /* Compare new line status to the old one, signal if different */
Ian Abbott76854ce2005-06-02 10:34:11 +01001760 /* N.B. packet may be processed more than once, but differences
1761 * are only processed once. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762 if (priv != NULL) {
1763 char new_status = data[packet_offset+0] & FTDI_STATUS_B0_MASK;
1764 if (new_status != priv->prev_status) {
1765 priv->diff_status |= new_status ^ priv->prev_status;
1766 wake_up_interruptible(&priv->delta_msr_wait);
1767 priv->prev_status = new_status;
1768 }
1769 }
1770
Ian Abbott76854ce2005-06-02 10:34:11 +01001771 length = min(PKTSZ, urb->actual_length-packet_offset)-2;
1772 if (length < 0) {
1773 err("%s - bad packet length: %d", __FUNCTION__, length+2);
1774 length = 0;
1775 }
1776
Ian Abbott76854ce2005-06-02 10:34:11 +01001777 if (priv->rx_flags & THROTTLED) {
1778 dbg("%s - throttled", __FUNCTION__);
1779 break;
1780 }
Alan Cox33f0f882006-01-09 20:54:13 -08001781 if (tty_buffer_request_room(tty, length) < length) {
Ian Abbott76854ce2005-06-02 10:34:11 +01001782 /* break out & wait for throttling/unthrottling to happen */
1783 dbg("%s - receive room low", __FUNCTION__);
1784 break;
1785 }
1786
Linus Torvalds1da177e2005-04-16 15:20:36 -07001787 /* Handle errors and break */
1788 error_flag = TTY_NORMAL;
1789 /* Although the device uses a bitmask and hence can have multiple */
1790 /* errors on a packet - the order here sets the priority the */
1791 /* error is returned to the tty layer */
1792
1793 if ( data[packet_offset+1] & FTDI_RS_OE ) {
1794 error_flag = TTY_OVERRUN;
1795 dbg("OVERRRUN error");
1796 }
1797 if ( data[packet_offset+1] & FTDI_RS_BI ) {
1798 error_flag = TTY_BREAK;
1799 dbg("BREAK received");
1800 }
1801 if ( data[packet_offset+1] & FTDI_RS_PE ) {
1802 error_flag = TTY_PARITY;
1803 dbg("PARITY error");
1804 }
1805 if ( data[packet_offset+1] & FTDI_RS_FE ) {
1806 error_flag = TTY_FRAME;
1807 dbg("FRAMING error");
1808 }
Ian Abbott76854ce2005-06-02 10:34:11 +01001809 if (length > 0) {
1810 for (i = 2; i < length+2; i++) {
David Brownell5c09d142006-10-13 15:57:58 -07001811 /* Note that the error flag is duplicated for
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812 every character received since we don't know
1813 which character it applied to */
1814 tty_insert_flip_char(tty, data[packet_offset+i], error_flag);
1815 }
1816 need_flip = 1;
1817 }
1818
1819#ifdef NOT_CORRECT_BUT_KEEPING_IT_FOR_NOW
1820 /* if a parity error is detected you get status packets forever
1821 until a character is sent without a parity error.
1822 This doesn't work well since the application receives a never
1823 ending stream of bad data - even though new data hasn't been sent.
1824 Therefore I (bill) have taken this out.
David Brownell5c09d142006-10-13 15:57:58 -07001825 However - this might make sense for framing errors and so on
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826 so I am leaving the code in for now.
1827 */
1828 else {
1829 if (error_flag != TTY_NORMAL){
1830 dbg("error_flag is not normal");
1831 /* In this case it is just status - if that is an error send a bad character */
1832 if(tty->flip.count >= TTY_FLIPBUF_SIZE) {
1833 tty_flip_buffer_push(tty);
1834 }
1835 tty_insert_flip_char(tty, 0xff, error_flag);
1836 need_flip = 1;
1837 }
1838 }
1839#endif
1840 } /* "for(packet_offset=0..." */
1841
1842 /* Low latency */
1843 if (need_flip) {
1844 tty_flip_buffer_push(tty);
1845 }
1846
Ian Abbott76854ce2005-06-02 10:34:11 +01001847 if (packet_offset < urb->actual_length) {
1848 /* not completely processed - record progress */
1849 priv->rx_processed = packet_offset;
1850 dbg("%s - incomplete, %d bytes processed, %d remain",
1851 __FUNCTION__, packet_offset,
1852 urb->actual_length - packet_offset);
1853 /* check if we were throttled while processing */
1854 spin_lock_irqsave(&priv->rx_lock, flags);
1855 if (priv->rx_flags & THROTTLED) {
1856 priv->rx_flags |= ACTUALLY_THROTTLED;
1857 spin_unlock_irqrestore(&priv->rx_lock, flags);
1858 dbg("%s - deferring remainder until unthrottled",
1859 __FUNCTION__);
1860 return;
1861 }
1862 spin_unlock_irqrestore(&priv->rx_lock, flags);
1863 /* if the port is closed stop trying to read */
1864 if (port->open_count > 0){
1865 /* delay processing of remainder */
1866 schedule_delayed_work(&priv->rx_work, 1);
1867 } else {
1868 dbg("%s - port is closed", __FUNCTION__);
1869 }
1870 return;
1871 }
1872
1873 /* urb is completely processed */
1874 priv->rx_processed = 0;
1875
Linus Torvalds1da177e2005-04-16 15:20:36 -07001876 /* if the port is closed stop trying to read */
1877 if (port->open_count > 0){
1878 /* Continue trying to always read */
David Brownell5c09d142006-10-13 15:57:58 -07001879 usb_fill_bulk_urb(port->read_urb, port->serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001880 usb_rcvbulkpipe(port->serial->dev, port->bulk_in_endpointAddress),
1881 port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
1882 ftdi_read_bulk_callback, port);
1883
1884 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1885 if (result)
1886 err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
1887 }
1888
1889 return;
1890} /* ftdi_process_read */
1891
1892
1893static void ftdi_break_ctl( struct usb_serial_port *port, int break_state )
1894{
1895 struct ftdi_private *priv = usb_get_serial_port_data(port);
David Brownell5c09d142006-10-13 15:57:58 -07001896 __u16 urb_value = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001897 char buf[1];
David Brownell5c09d142006-10-13 15:57:58 -07001898
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899 /* break_state = -1 to turn on break, and 0 to turn off break */
1900 /* see drivers/char/tty_io.c to see it used */
1901 /* last_set_data_urb_value NEVER has the break bit set in it */
1902
1903 if (break_state) {
1904 urb_value = priv->last_set_data_urb_value | FTDI_SIO_SET_BREAK;
1905 } else {
David Brownell5c09d142006-10-13 15:57:58 -07001906 urb_value = priv->last_set_data_urb_value;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001907 }
1908
David Brownell5c09d142006-10-13 15:57:58 -07001909
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910 if (usb_control_msg(port->serial->dev, usb_sndctrlpipe(port->serial->dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07001911 FTDI_SIO_SET_DATA_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912 FTDI_SIO_SET_DATA_REQUEST_TYPE,
1913 urb_value , priv->interface,
1914 buf, 0, WDR_TIMEOUT) < 0) {
1915 err("%s FAILED to enable/disable break state (state was %d)", __FUNCTION__,break_state);
David Brownell5c09d142006-10-13 15:57:58 -07001916 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001917
1918 dbg("%s break state is %d - urb is %d", __FUNCTION__,break_state, urb_value);
David Brownell5c09d142006-10-13 15:57:58 -07001919
Linus Torvalds1da177e2005-04-16 15:20:36 -07001920}
1921
1922
1923/* old_termios contains the original termios settings and tty->termios contains
1924 * the new setting to be used
1925 * WARNING: set_termios calls this with old_termios in kernel space
1926 */
1927
Alan Cox606d0992006-12-08 02:38:45 -08001928static void ftdi_set_termios (struct usb_serial_port *port, struct ktermios *old_termios)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929{ /* ftdi_termios */
1930 struct usb_device *dev = port->serial->dev;
1931 unsigned int cflag = port->tty->termios->c_cflag;
1932 struct ftdi_private *priv = usb_get_serial_port_data(port);
1933 __u16 urb_value; /* will hold the new flags */
1934 char buf[1]; /* Perhaps I should dynamically alloc this? */
David Brownell5c09d142006-10-13 15:57:58 -07001935
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936 // Added for xon/xoff support
1937 unsigned int iflag = port->tty->termios->c_iflag;
1938 unsigned char vstop;
1939 unsigned char vstart;
David Brownell5c09d142006-10-13 15:57:58 -07001940
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941 dbg("%s", __FUNCTION__);
1942
1943 /* Force baud rate if this device requires it, unless it is set to B0. */
1944 if (priv->force_baud && ((port->tty->termios->c_cflag & CBAUD) != B0)) {
1945 dbg("%s: forcing baud rate for this device", __FUNCTION__);
1946 port->tty->termios->c_cflag &= ~CBAUD;
1947 port->tty->termios->c_cflag |= priv->force_baud;
1948 }
1949
1950 /* Force RTS-CTS if this device requires it. */
1951 if (priv->force_rtscts) {
1952 dbg("%s: forcing rtscts for this device", __FUNCTION__);
1953 port->tty->termios->c_cflag |= CRTSCTS;
1954 }
1955
1956 cflag = port->tty->termios->c_cflag;
1957
David Brownell5c09d142006-10-13 15:57:58 -07001958 /* FIXME -For this cut I don't care if the line is really changing or
1959 not - so just do the change regardless - should be able to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001960 compare old_termios and tty->termios */
David Brownell5c09d142006-10-13 15:57:58 -07001961 /* NOTE These routines can get interrupted by
1962 ftdi_sio_read_bulk_callback - need to examine what this
Linus Torvalds1da177e2005-04-16 15:20:36 -07001963 means - don't see any problems yet */
David Brownell5c09d142006-10-13 15:57:58 -07001964
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965 /* Set number of data bits, parity, stop bits */
David Brownell5c09d142006-10-13 15:57:58 -07001966
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967 urb_value = 0;
1968 urb_value |= (cflag & CSTOPB ? FTDI_SIO_SET_DATA_STOP_BITS_2 :
1969 FTDI_SIO_SET_DATA_STOP_BITS_1);
David Brownell5c09d142006-10-13 15:57:58 -07001970 urb_value |= (cflag & PARENB ?
1971 (cflag & PARODD ? FTDI_SIO_SET_DATA_PARITY_ODD :
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972 FTDI_SIO_SET_DATA_PARITY_EVEN) :
1973 FTDI_SIO_SET_DATA_PARITY_NONE);
1974 if (cflag & CSIZE) {
1975 switch (cflag & CSIZE) {
1976 case CS5: urb_value |= 5; dbg("Setting CS5"); break;
1977 case CS6: urb_value |= 6; dbg("Setting CS6"); break;
1978 case CS7: urb_value |= 7; dbg("Setting CS7"); break;
1979 case CS8: urb_value |= 8; dbg("Setting CS8"); break;
1980 default:
1981 err("CSIZE was set but not CS5-CS8");
1982 }
1983 }
1984
1985 /* This is needed by the break command since it uses the same command - but is
1986 * or'ed with this value */
1987 priv->last_set_data_urb_value = urb_value;
David Brownell5c09d142006-10-13 15:57:58 -07001988
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07001990 FTDI_SIO_SET_DATA_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991 FTDI_SIO_SET_DATA_REQUEST_TYPE,
1992 urb_value , priv->interface,
Ian Abbott279e1542005-07-29 12:16:52 -07001993 buf, 0, WDR_SHORT_TIMEOUT) < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001994 err("%s FAILED to set databits/stopbits/parity", __FUNCTION__);
David Brownell5c09d142006-10-13 15:57:58 -07001995 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996
1997 /* Now do the baudrate */
1998 if ((cflag & CBAUD) == B0 ) {
1999 /* Disable flow control */
2000 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002001 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002002 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07002003 0, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002004 buf, 0, WDR_TIMEOUT) < 0) {
2005 err("%s error from disable flowcontrol urb", __FUNCTION__);
David Brownell5c09d142006-10-13 15:57:58 -07002006 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002007 /* Drop RTS and DTR */
Ian Abbott74ede0f2005-07-29 12:16:41 -07002008 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009 } else {
2010 /* set the baudrate determined before */
2011 if (change_speed(port)) {
Peter Favrholdt72a755f2005-09-22 00:48:49 -07002012 err("%s urb failed to set baudrate", __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002013 }
Peter Favrholdt72a755f2005-09-22 00:48:49 -07002014 /* Ensure RTS and DTR are raised when baudrate changed from 0 */
Guennadi Liakhovetski57845bd2006-04-13 22:27:12 +02002015 if (!old_termios || (old_termios->c_cflag & CBAUD) == B0) {
Peter Favrholdt72a755f2005-09-22 00:48:49 -07002016 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2017 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018 }
2019
2020 /* Set flow control */
2021 /* Note device also supports DTR/CD (ugh) and Xon/Xoff in hardware */
2022 if (cflag & CRTSCTS) {
2023 dbg("%s Setting to CRTSCTS flow control", __FUNCTION__);
David Brownell5c09d142006-10-13 15:57:58 -07002024 if (usb_control_msg(dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025 usb_sndctrlpipe(dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002026 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002027 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2028 0 , (FTDI_SIO_RTS_CTS_HS | priv->interface),
2029 buf, 0, WDR_TIMEOUT) < 0) {
2030 err("urb failed to set to rts/cts flow control");
David Brownell5c09d142006-10-13 15:57:58 -07002031 }
2032
2033 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034 /*
2035 * Xon/Xoff code
2036 *
2037 * Check the IXOFF status in the iflag component of the termios structure
2038 * if IXOFF is not set, the pre-xon/xoff code is executed.
2039 */
2040 if (iflag & IXOFF) {
2041 dbg("%s request to enable xonxoff iflag=%04x",__FUNCTION__,iflag);
2042 // Try to enable the XON/XOFF on the ftdi_sio
2043 // Set the vstart and vstop -- could have been done up above where
2044 // a lot of other dereferencing is done but that would be very
2045 // inefficient as vstart and vstop are not always needed
2046 vstart=port->tty->termios->c_cc[VSTART];
2047 vstop=port->tty->termios->c_cc[VSTOP];
2048 urb_value=(vstop << 8) | (vstart);
2049
2050 if (usb_control_msg(dev,
2051 usb_sndctrlpipe(dev, 0),
2052 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2053 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2054 urb_value , (FTDI_SIO_XON_XOFF_HS
2055 | priv->interface),
2056 buf, 0, WDR_TIMEOUT) < 0) {
2057 err("urb failed to set to xon/xoff flow control");
2058 }
2059 } else {
2060 /* else clause to only run if cfag ! CRTSCTS and iflag ! XOFF */
2061 /* CHECKME Assuming XON/XOFF handled by tty stack - not by device */
2062 dbg("%s Turning off hardware flow control", __FUNCTION__);
David Brownell5c09d142006-10-13 15:57:58 -07002063 if (usb_control_msg(dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064 usb_sndctrlpipe(dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002065 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07002067 0, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068 buf, 0, WDR_TIMEOUT) < 0) {
2069 err("urb failed to clear flow control");
David Brownell5c09d142006-10-13 15:57:58 -07002070 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071 }
David Brownell5c09d142006-10-13 15:57:58 -07002072
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073 }
2074 return;
2075} /* ftdi_termios */
2076
2077
2078static int ftdi_tiocmget (struct usb_serial_port *port, struct file *file)
2079{
2080 struct ftdi_private *priv = usb_get_serial_port_data(port);
2081 unsigned char buf[2];
2082 int ret;
2083
2084 dbg("%s TIOCMGET", __FUNCTION__);
2085 switch (priv->chip_type) {
2086 case SIO:
2087 /* Request the status from the device */
David Brownell5c09d142006-10-13 15:57:58 -07002088 if ((ret = usb_control_msg(port->serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089 usb_rcvctrlpipe(port->serial->dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002090 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07002092 0, 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093 buf, 1, WDR_TIMEOUT)) < 0 ) {
2094 err("%s Could not get modem status of device - err: %d", __FUNCTION__,
2095 ret);
2096 return(ret);
2097 }
2098 break;
2099 case FT8U232AM:
2100 case FT232BM:
2101 case FT2232C:
2102 /* the 8U232AM returns a two byte value (the sio is a 1 byte value) - in the same
2103 format as the data returned from the in point */
David Brownell5c09d142006-10-13 15:57:58 -07002104 if ((ret = usb_control_msg(port->serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105 usb_rcvctrlpipe(port->serial->dev, 0),
David Brownell5c09d142006-10-13 15:57:58 -07002106 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
David Brownell5c09d142006-10-13 15:57:58 -07002108 0, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 buf, 2, WDR_TIMEOUT)) < 0 ) {
2110 err("%s Could not get modem status of device - err: %d", __FUNCTION__,
2111 ret);
2112 return(ret);
2113 }
2114 break;
2115 default:
2116 return -EFAULT;
2117 break;
2118 }
David Brownell5c09d142006-10-13 15:57:58 -07002119
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120 return (buf[0] & FTDI_SIO_DSR_MASK ? TIOCM_DSR : 0) |
2121 (buf[0] & FTDI_SIO_CTS_MASK ? TIOCM_CTS : 0) |
2122 (buf[0] & FTDI_SIO_RI_MASK ? TIOCM_RI : 0) |
2123 (buf[0] & FTDI_SIO_RLSD_MASK ? TIOCM_CD : 0) |
David Brownell5c09d142006-10-13 15:57:58 -07002124 priv->last_dtr_rts;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125}
2126
2127static int ftdi_tiocmset(struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear)
2128{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129 dbg("%s TIOCMSET", __FUNCTION__);
Ian Abbott74ede0f2005-07-29 12:16:41 -07002130 return update_mctrl(port, set, clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131}
2132
2133
2134static int ftdi_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
2135{
2136 struct ftdi_private *priv = usb_get_serial_port_data(port);
2137
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138 dbg("%s cmd 0x%04x", __FUNCTION__, cmd);
2139
2140 /* Based on code from acm.c and others */
2141 switch (cmd) {
2142
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143 case TIOCGSERIAL: /* gets serial port data */
2144 return get_serial_info(port, (struct serial_struct __user *) arg);
2145
2146 case TIOCSSERIAL: /* sets serial port data */
2147 return set_serial_info(port, (struct serial_struct __user *) arg);
2148
2149 /*
2150 * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
2151 * - mask passed in arg for lines of interest
2152 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
2153 * Caller should use TIOCGICOUNT to see which one it was.
2154 *
2155 * This code is borrowed from linux/drivers/char/serial.c
2156 */
2157 case TIOCMIWAIT:
2158 while (priv != NULL) {
2159 interruptible_sleep_on(&priv->delta_msr_wait);
2160 /* see if a signal did it */
2161 if (signal_pending(current))
2162 return -ERESTARTSYS;
2163 else {
2164 char diff = priv->diff_status;
2165
2166 if (diff == 0) {
2167 return -EIO; /* no change => error */
2168 }
2169
2170 /* Consume all events */
2171 priv->diff_status = 0;
2172
2173 /* Return 0 if caller wanted to know about these bits */
2174 if ( ((arg & TIOCM_RNG) && (diff & FTDI_RS0_RI)) ||
2175 ((arg & TIOCM_DSR) && (diff & FTDI_RS0_DSR)) ||
2176 ((arg & TIOCM_CD) && (diff & FTDI_RS0_RLSD)) ||
2177 ((arg & TIOCM_CTS) && (diff & FTDI_RS0_CTS)) ) {
2178 return 0;
2179 }
2180 /*
2181 * Otherwise caller can't care less about what happened,
2182 * and so we continue to wait for more events.
2183 */
2184 }
2185 }
2186 return(0);
2187 break;
2188 default:
2189 break;
David Brownell5c09d142006-10-13 15:57:58 -07002190
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191 }
2192
2193
David Brownell5c09d142006-10-13 15:57:58 -07002194 /* This is not necessarily an error - turns out the higher layers will do
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195 * some ioctls itself (see comment above)
2196 */
2197 dbg("%s arg not supported - it was 0x%04x - check /usr/include/asm/ioctls.h", __FUNCTION__, cmd);
2198
2199 return(-ENOIOCTLCMD);
2200} /* ftdi_ioctl */
2201
2202
2203static void ftdi_throttle (struct usb_serial_port *port)
2204{
2205 struct ftdi_private *priv = usb_get_serial_port_data(port);
2206 unsigned long flags;
2207
2208 dbg("%s - port %d", __FUNCTION__, port->number);
2209
2210 spin_lock_irqsave(&priv->rx_lock, flags);
2211 priv->rx_flags |= THROTTLED;
2212 spin_unlock_irqrestore(&priv->rx_lock, flags);
2213}
2214
2215
2216static void ftdi_unthrottle (struct usb_serial_port *port)
2217{
2218 struct ftdi_private *priv = usb_get_serial_port_data(port);
2219 int actually_throttled;
2220 unsigned long flags;
2221
2222 dbg("%s - port %d", __FUNCTION__, port->number);
2223
2224 spin_lock_irqsave(&priv->rx_lock, flags);
2225 actually_throttled = priv->rx_flags & ACTUALLY_THROTTLED;
2226 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
2227 spin_unlock_irqrestore(&priv->rx_lock, flags);
2228
2229 if (actually_throttled)
David Howellsc4028952006-11-22 14:57:56 +00002230 schedule_delayed_work(&priv->rx_work, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002231}
2232
2233static int __init ftdi_init (void)
2234{
2235 int retval;
2236
2237 dbg("%s", __FUNCTION__);
Ian Abbottfdcb0a02005-07-28 18:40:32 +01002238 if (vendor > 0 && product > 0) {
2239 /* Add user specified VID/PID to reserved element of table. */
2240 int i;
2241 for (i = 0; id_table_combined[i].idVendor; i++)
2242 ;
2243 id_table_combined[i].match_flags = USB_DEVICE_ID_MATCH_DEVICE;
2244 id_table_combined[i].idVendor = vendor;
2245 id_table_combined[i].idProduct = product;
2246 }
Ian Abbott8f977e42005-06-20 16:45:42 +01002247 retval = usb_serial_register(&ftdi_sio_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248 if (retval)
Ian Abbott8f977e42005-06-20 16:45:42 +01002249 goto failed_sio_register;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250 retval = usb_register(&ftdi_driver);
David Brownell5c09d142006-10-13 15:57:58 -07002251 if (retval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002252 goto failed_usb_register;
2253
2254 info(DRIVER_VERSION ":" DRIVER_DESC);
2255 return 0;
2256failed_usb_register:
Ian Abbott8f977e42005-06-20 16:45:42 +01002257 usb_serial_deregister(&ftdi_sio_device);
2258failed_sio_register:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002259 return retval;
2260}
2261
2262
2263static void __exit ftdi_exit (void)
2264{
2265
2266 dbg("%s", __FUNCTION__);
2267
2268 usb_deregister (&ftdi_driver);
Ian Abbott8f977e42005-06-20 16:45:42 +01002269 usb_serial_deregister (&ftdi_sio_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002270
2271}
2272
2273
2274module_init(ftdi_init);
2275module_exit(ftdi_exit);
2276
2277MODULE_AUTHOR( DRIVER_AUTHOR );
2278MODULE_DESCRIPTION( DRIVER_DESC );
2279MODULE_LICENSE("GPL");
2280
2281module_param(debug, bool, S_IRUGO | S_IWUSR);
2282MODULE_PARM_DESC(debug, "Debug enabled or not");
Ian Abbottfdcb0a02005-07-28 18:40:32 +01002283module_param(vendor, ushort, 0);
2284MODULE_PARM_DESC(vendor, "User specified vendor ID (default="
2285 __MODULE_STRING(FTDI_VID)")");
2286module_param(product, ushort, 0);
2287MODULE_PARM_DESC(vendor, "User specified product ID");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002288