]> git.ipfire.org Git - people/arne_f/kernel.git/blame - drivers/usb/serial/ftdi_sio.c
projects / people / arne_f / kernel.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
USB: cp2101: convert to new termios
[people/arne_f/kernel.git] / drivers / usb / serial / ftdi_sio.c
CommitLineData
1da177e4
LT		 1/*
2 * USB FTDI SIO driver
3 *
5c09d144
DB		 4 * Copyright (C) 1999 - 2001
5 * Greg Kroah-Hartman (greg@kroah.com)
1da177e4
LT		 6 * Bill Ryder (bryder@sgi.com)
7 * Copyright (C) 2002
8 * Kuba Ober (kuba@mareimbrium.org)
9 *
5c09d144
DB		 10 * 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.
1da177e4
LT		 14 *
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.
5c09d144 35 *
1da177e4
LT		 36 * (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.
5c09d144 72 *
1da177e4
LT		 73 * (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
093cf723 79 * Added support for Home Electronics Tira-1 IR transceiver using FT232BM chip.
5c09d144 80 * See <http://www.home-electro.com/tira1.htm>. Only operates properly
1da177e4
LT		 81 * 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
96de0e25 86 * Philipp Gühring's patch for 2.5.x kernel).
1da177e4
LT		 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
093cf723 94 * Added support for USB-UIRT IR transceiver using 8U232AM chip.
1da177e4
LT		 95 * 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)
5c09d144 140 * Added CrystalFontz 632 and 634 PIDs
1da177e4
LT		 141 * (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
5c09d144
DB		 147 *
148 *
149 *
150 *
1da177e4
LT		 151 * (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.
5c09d144 161 *
1da177e4
LT		 162 * (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.
5c09d144 182 *
1da177e4
LT		 183 * (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.
5c09d144 191 *
1da177e4
LT		 192 * (04/08/2001) gb
193 * Identify version on module load.
5c09d144 194 *
1da177e4
LT		 195 * (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
5c09d144 200 *
1da177e4
LT		 201 * (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
5c09d144 214 *
1da177e4
LT		 215 * (11/01/2000) Adam J. Richter
216 * usb_device_id table support
5c09d144 217 *
1da177e4
LT		 218 * (10/05/2000) gkh
219 * Fixed bug with urb->dev not being set properly, now that the usb
220 * core needs it.
5c09d144 221 *
1da177e4
LT		 222 * (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 *
5c09d144 229 * (04/04/2000) Bill Ryder
1da177e4
LT		 230 * Fixed bugs in TCGET/TCSET ioctls (by removing them - they are
231 * handled elsewhere in the tty io driver chain).
232 *
5c09d144 233 * (03/30/2000) Bill Ryder
1da177e4
LT		 234 * 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
1da177e4
LT		 248#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>
a969888c 260#include <linux/usb/serial.h>
1da177e4
LT		 261#include "ftdi_sio.h"
262
263/*
264 * Version Information
265 */
8f977e42 266#define DRIVER_VERSION "v1.4.3"
1da177e4
LT		 267#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;
fdcb0a0f
IA		 271static __u16 vendor = FTDI_VID;
272static __u16 product;
1da177e4 273
0ffbbe25
ON		 274struct 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
8f977e42
IA		 306/* struct ftdi_sio_quirk is used by devices requiring special attention. */
307struct ftdi_sio_quirk {
fa91d43b 308 int (*probe)(struct usb_serial *);
0ffbbe25 309 void (*port_probe)(struct ftdi_private *); /* Special settings for probed ports. */
8f977e42
IA		 310};
311
fa91d43b 312static int ftdi_olimex_probe (struct usb_serial *serial);
0ffbbe25
ON		 313static void ftdi_USB_UIRT_setup (struct ftdi_private *priv);
314static void ftdi_HE_TIRA1_setup (struct ftdi_private *priv);
8f977e42 315
fa91d43b
TL		 316static struct ftdi_sio_quirk ftdi_olimex_quirk = {
317 .probe = ftdi_olimex_probe,
318};
319
8f977e42 320static struct ftdi_sio_quirk ftdi_USB_UIRT_quirk = {
0ffbbe25 321 .port_probe = ftdi_USB_UIRT_setup,
8f977e42
IA		 322};
323
324static struct ftdi_sio_quirk ftdi_HE_TIRA1_quirk = {
0ffbbe25 325 .port_probe = ftdi_HE_TIRA1_setup,
1da177e4
LT		 326};
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.
8f977e42
IA		 340 * FIXME: perhaps bcdDevice can also identify 12MHz FT8U232AM devices,
341 * but I don't know if those ever went into mass production. [Ian Abbott]
1da177e4
LT		 342 */
343
344
1da177e4
LT		 345
346static struct usb_device_id id_table_combined [] = {
2011e924
JD		 347 { USB_DEVICE(FTDI_VID, FTDI_AMC232_PID) },
348 { USB_DEVICE(FTDI_VID, FTDI_CANUSB_PID) },
72a9f958 349 { USB_DEVICE(FTDI_VID, FTDI_ACTZWAVE_PID) },
1da177e4 350 { USB_DEVICE(FTDI_VID, FTDI_IRTRANS_PID) },
69737dfa 351 { USB_DEVICE(FTDI_VID, FTDI_IPLUS_PID) },
d099321b 352 { USB_DEVICE(FTDI_VID, FTDI_IPLUS2_PID) },
fad14a0d 353 { USB_DEVICE(FTDI_VID, FTDI_DMX4ALL) },
1da177e4
LT		 354 { USB_DEVICE(FTDI_VID, FTDI_SIO_PID) },
355 { USB_DEVICE(FTDI_VID, FTDI_8U232AM_PID) },
356 { USB_DEVICE(FTDI_VID, FTDI_8U232AM_ALT_PID) },
d8b21606 357 { USB_DEVICE(FTDI_VID, FTDI_232RL_PID) },
1da177e4 358 { USB_DEVICE(FTDI_VID, FTDI_8U2232C_PID) },
c0f8d561 359 { USB_DEVICE(FTDI_VID, FTDI_MICRO_CHAMELEON_PID) },
1da177e4 360 { USB_DEVICE(FTDI_VID, FTDI_RELAIS_PID) },
2adb80e9 361 { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_PID) },
1da177e4
LT		 362 { 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) },
8f977e42
IA		 375 { 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) },
1da177e4 383 { USB_DEVICE(FTDI_VID, FTDI_PIEGROUP_PID) },
274a4bbc 384 { USB_DEVICE(FTDI_VID, FTDI_TNC_X_PID) },
868e440d 385 { USB_DEVICE(FTDI_VID, FTDI_USBX_707_PID) },
1da177e4
LT		 386 { 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) },
a1484827 390 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2106_PID) },
1da177e4
LT		 391 { 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) },
8f977e42
IA		 435 { 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 },
1da177e4
LT		 439 { 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) },
8f977e42
IA		 443 { 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) },
1da177e4 459 { USB_DEVICE(FTDI_VID, FTDI_ELV_UO100_PID) },
47900743 460 { USB_DEVICE(FTDI_VID, FTDI_ELV_UM100_PID) },
e6ac4a40
IA		 461 { USB_DEVICE(FTDI_VID, FTDI_ELV_UR100_PID) },
462 { USB_DEVICE(FTDI_VID, FTDI_ELV_ALC8500_PID) },
207c47e1 463 { USB_DEVICE(FTDI_VID, FTDI_PYRAMID_PID) },
bde62185 464 { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1000PC_PID) },
4eaf60e0
TS		 465 { 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) },
e6ac4a40
IA		 473 /*
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) }, */
e6ac4a40
IA		 490 /* { 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) }, */
5c09d144
DB		 498 { 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) },
ec434e9b 505 { USB_DEVICE(FTDI_VID, FTDI_CCSMACHX_2_PID) },
1da177e4
LT		 506 { 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) },
e6ac4a40 510 { USB_DEVICE(FALCOM_VID, FALCOM_SAMBA_PID) },
1da177e4 511 { USB_DEVICE(FTDI_VID, FTDI_SUUNTO_SPORTS_PID) },
ef31fec0 512 { USB_DEVICE(TTI_VID, TTI_QL355P_PID) },
6f92872c 513 { USB_DEVICE(FTDI_VID, FTDI_RM_CANVIEW_PID) },
1da177e4
LT		 514 { 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) },
6f92872c
IA		 518 { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_1_PID) },
519 { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_2_PID) },
e6ac4a40
IA		 520 { 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) },
6f92872c 528 { USB_DEVICE(MOBILITY_VID, MOBILITY_USB_SERIAL_PID) },
8f977e42 529 { USB_DEVICE(FTDI_VID, FTDI_ACTIVE_ROBOTS_PID) },
34d1a8aa
IA		 530 { USB_DEVICE(FTDI_VID, FTDI_MHAM_KW_PID) },
531 { USB_DEVICE(FTDI_VID, FTDI_MHAM_YS_PID) },
9b1513d9
IA		 532 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y6_PID) },
533 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y8_PID) },
34d1a8aa
IA		 534 { 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) },
740a4282
IA		 538 { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_VCP_PID) },
539 { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_D2XX_PID) },
9b1513d9 540 { USB_DEVICE(EVOLUTION_VID, EVOLUTION_ER1_PID) },
c1f8ea7d
SH		 541 { USB_DEVICE(EVOLUTION_VID, EVO_HYBRID_PID) },
542 { USB_DEVICE(EVOLUTION_VID, EVO_RCM4_PID) },
c9c7746d
RS		 543 { USB_DEVICE(FTDI_VID, FTDI_ARTEMIS_PID) },
544 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16_PID) },
09c280a2 545 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16C_PID) },
c9c7746d 546 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HR_PID) },
09c280a2 547 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HRC_PID) },
b4723ae3
IA		 548 { USB_DEVICE(KOBIL_VID, KOBIL_CONV_B1_PID) },
549 { USB_DEVICE(KOBIL_VID, KOBIL_CONV_KAAN_PID) },
effac8be 550 { USB_DEVICE(POSIFLEX_VID, POSIFLEX_PP7000_PID) },
641adaae 551 { USB_DEVICE(FTDI_VID, FTDI_TTUSB_PID) },
7e1c0b86 552 { USB_DEVICE(FTDI_VID, FTDI_ECLO_COM_1WIRE_PID) },
a94b52ac
IA		 553 { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_777_PID) },
554 { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_8900F_PID) },
ce40d290 555 { USB_DEVICE(FTDI_VID, FTDI_PCDJ_DAC2_PID) },
cdd3b156 556 { USB_DEVICE(FTDI_VID, FTDI_RRCIRKITS_LOCOBUFFER_PID) },
7e0258fd 557 { USB_DEVICE(FTDI_VID, FTDI_ASK_RDR400_PID) },
bf58fbd5 558 { USB_DEVICE(ICOM_ID1_VID, ICOM_ID1_PID) },
62a13db3 559 { USB_DEVICE(PAPOUCH_VID, PAPOUCH_TMU_PID) },
20a0f47e 560 { USB_DEVICE(FTDI_VID, FTDI_ACG_HFDUAL_PID) },
eb79b4fd 561 { USB_DEVICE(FTDI_VID, FTDI_YEI_SERVOCENTER31_PID) },
48437486 562 { USB_DEVICE(FTDI_VID, FTDI_THORLABS_PID) },
e1979fef 563 { USB_DEVICE(TESTO_VID, TESTO_USB_INTERFACE_PID) },
eaede2cb 564 { USB_DEVICE(FTDI_VID, FTDI_GAMMA_SCOUT_PID) },
9978f9e1
IA		 565 { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13M_PID) },
566 { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13S_PID) },
567 { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13U_PID) },
40c36092 568 { USB_DEVICE(ELEKTOR_VID, ELEKTOR_FT323R_PID) },
822c7ef4 569 { USB_DEVICE(TELLDUS_VID, TELLDUS_TELLSTICK_PID) },
762e92fa 570 { USB_DEVICE(FTDI_VID, FTDI_MAXSTREAM_PID) },
d7fde2d6 571 { USB_DEVICE(TML_VID, TML_USB_SERIAL_PID) },
fa91d43b
TL		 572 { USB_DEVICE(OLIMEX_VID, OLIMEX_ARM_USB_OCD_PID),
573 .driver_info = (kernel_ulong_t)&ftdi_olimex_quirk },
fdcb0a0f
IA		 574 { }, /* Optional parameter entry */
575 { } /* Terminating entry */
1da177e4
LT		 576};
577
578MODULE_DEVICE_TABLE (usb, id_table_combined);
579
580static struct usb_driver ftdi_driver = {
581 .name = "ftdi_sio",
582 .probe = usb_serial_probe,
583 .disconnect = usb_serial_disconnect,
584 .id_table = id_table_combined,
5c09d144 585 .no_dynamic_id = 1,
1da177e4
LT		 586};
587
4c4c9432 588static const char *ftdi_chip_name[] = {
1da177e4
LT		 589 [SIO] = "SIO", /* the serial part of FT8U100AX */
590 [FT8U232AM] = "FT8U232AM",
591 [FT232BM] = "FT232BM",
592 [FT2232C] = "FT2232C",
d8b21606 593 [FT232RL] = "FT232RL",
1da177e4
LT		 594};
595
596
597/* Constants for read urb and write urb */
598#define BUFSZ 512
599#define PKTSZ 64
600
601/* rx_flags */
602#define THROTTLED 0x01
603#define ACTUALLY_THROTTLED 0x02
604
1da177e4
LT		 605/* Used for TIOCMIWAIT */
606#define FTDI_STATUS_B0_MASK (FTDI_RS0_CTS | FTDI_RS0_DSR | FTDI_RS0_RI | FTDI_RS0_RLSD)
607#define FTDI_STATUS_B1_MASK (FTDI_RS_BI)
608/* End TIOCMIWAIT */
609
610#define FTDI_IMPL_ASYNC_FLAGS = ( ASYNC_SPD_HI | ASYNC_SPD_VHI \
611 ASYNC_SPD_CUST | ASYNC_SPD_SHI | ASYNC_SPD_WARP )
612
613/* function prototypes for a FTDI serial converter */
8f977e42 614static int ftdi_sio_probe (struct usb_serial *serial, const struct usb_device_id *id);
1da177e4 615static void ftdi_shutdown (struct usb_serial *serial);
12bdbe03
JR		 616static int ftdi_sio_port_probe (struct usb_serial_port *port);
617static int ftdi_sio_port_remove (struct usb_serial_port *port);
1da177e4
LT		 618static int ftdi_open (struct usb_serial_port *port, struct file *filp);
619static void ftdi_close (struct usb_serial_port *port, struct file *filp);
620static int ftdi_write (struct usb_serial_port *port, const unsigned char *buf, int count);
621static int ftdi_write_room (struct usb_serial_port *port);
622static int ftdi_chars_in_buffer (struct usb_serial_port *port);
7d12e780
DH		 623static void ftdi_write_bulk_callback (struct urb *urb);
624static void ftdi_read_bulk_callback (struct urb *urb);
c4028958 625static void ftdi_process_read (struct work_struct *work);
606d099c 626static void ftdi_set_termios (struct usb_serial_port *port, struct ktermios * old);
1da177e4
LT		 627static int ftdi_tiocmget (struct usb_serial_port *port, struct file *file);
628static int ftdi_tiocmset (struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear);
629static int ftdi_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg);
630static void ftdi_break_ctl (struct usb_serial_port *port, int break_state );
631static void ftdi_throttle (struct usb_serial_port *port);
632static void ftdi_unthrottle (struct usb_serial_port *port);
633
634static unsigned short int ftdi_232am_baud_base_to_divisor (int baud, int base);
635static unsigned short int ftdi_232am_baud_to_divisor (int baud);
636static __u32 ftdi_232bm_baud_base_to_divisor (int baud, int base);
637static __u32 ftdi_232bm_baud_to_divisor (int baud);
638
ea65370d 639static struct usb_serial_driver ftdi_sio_device = {
18fcac35
GKH		 640 .driver = {
641 .owner = THIS_MODULE,
269bda1c 642 .name = "ftdi_sio",
18fcac35 643 },
269bda1c 644 .description = "FTDI USB Serial Device",
d9b1b787 645 .usb_driver = &ftdi_driver ,
8f977e42 646 .id_table = id_table_combined,
1da177e4
LT		 647 .num_interrupt_in = 0,
648 .num_bulk_in = 1,
649 .num_bulk_out = 1,
650 .num_ports = 1,
8f977e42 651 .probe = ftdi_sio_probe,
12bdbe03
JR		 652 .port_probe = ftdi_sio_port_probe,
653 .port_remove = ftdi_sio_port_remove,
1da177e4
LT		 654 .open = ftdi_open,
655 .close = ftdi_close,
656 .throttle = ftdi_throttle,
657 .unthrottle = ftdi_unthrottle,
658 .write = ftdi_write,
659 .write_room = ftdi_write_room,
660 .chars_in_buffer = ftdi_chars_in_buffer,
661 .read_bulk_callback = ftdi_read_bulk_callback,
662 .write_bulk_callback = ftdi_write_bulk_callback,
663 .tiocmget = ftdi_tiocmget,
664 .tiocmset = ftdi_tiocmset,
665 .ioctl = ftdi_ioctl,
666 .set_termios = ftdi_set_termios,
667 .break_ctl = ftdi_break_ctl,
1da177e4
LT		 668 .shutdown = ftdi_shutdown,
669};
670
1da177e4
LT		 671
672#define WDR_TIMEOUT 5000 /* default urb timeout */
279e1545 673#define WDR_SHORT_TIMEOUT 1000 /* shorter urb timeout */
1da177e4
LT		 674
675/* High and low are for DTR, RTS etc etc */
676#define HIGH 1
677#define LOW 0
678
22465400
IA		 679/* number of outstanding urbs to prevent userspace DoS from happening */
680#define URB_UPPER_LIMIT 42
681
1da177e4
LT		 682/*
683 * ***************************************************************************
fa91d43b 684 * Utility functions
1da177e4
LT		 685 * ***************************************************************************
686 */
687
688static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base)
689{
690 unsigned short int divisor;
691 int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
692 if ((divisor3 & 0x7) == 7) divisor3 ++; // round x.7/8 up to x+1
693 divisor = divisor3 >> 3;
694 divisor3 &= 0x7;
695 if (divisor3 == 1) divisor |= 0xc000; else // 0.125
696 if (divisor3 >= 4) divisor |= 0x4000; else // 0.5
697 if (divisor3 != 0) divisor |= 0x8000; // 0.25
698 if (divisor == 1) divisor = 0; /* special case for maximum baud rate */
699 return divisor;
700}
701
702static unsigned short int ftdi_232am_baud_to_divisor(int baud)
703{
704 return(ftdi_232am_baud_base_to_divisor(baud, 48000000));
705}
706
707static __u32 ftdi_232bm_baud_base_to_divisor(int baud, int base)
708{
709 static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
710 __u32 divisor;
711 int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
712 divisor = divisor3 >> 3;
713 divisor |= (__u32)divfrac[divisor3 & 0x7] << 14;
714 /* Deal with special cases for highest baud rates. */
715 if (divisor == 1) divisor = 0; else // 1.0
716 if (divisor == 0x4001) divisor = 1; // 1.5
717 return divisor;
718}
719
720static __u32 ftdi_232bm_baud_to_divisor(int baud)
721{
722 return(ftdi_232bm_baud_base_to_divisor(baud, 48000000));
723}
724
74ede0ff
IA		 725#define set_mctrl(port, set) update_mctrl((port), (set), 0)
726#define clear_mctrl(port, clear) update_mctrl((port), 0, (clear))
727
728static int update_mctrl(struct usb_serial_port *port, unsigned int set, unsigned int clear)
1da177e4
LT		 729{
730 struct ftdi_private *priv = usb_get_serial_port_data(port);
731 char *buf;
74ede0ff 732 unsigned urb_value;
1da177e4 733 int rv;
1da177e4 734
74ede0ff
IA		 735 if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
736 dbg("%s - DTR|RTS not being set|cleared", __FUNCTION__);
737 return 0; /* no change */
738 }
1da177e4 739
1da177e4 740 buf = kmalloc(1, GFP_NOIO);
74ede0ff 741 if (!buf) {
1da177e4 742 return -ENOMEM;
1da177e4 743 }
74ede0ff
IA		 744
745 clear &= ~set; /* 'set' takes precedence over 'clear' */
746 urb_value = 0;
747 if (clear & TIOCM_DTR)
748 urb_value |= FTDI_SIO_SET_DTR_LOW;
749 if (clear & TIOCM_RTS)
750 urb_value |= FTDI_SIO_SET_RTS_LOW;
751 if (set & TIOCM_DTR)
752 urb_value |= FTDI_SIO_SET_DTR_HIGH;
753 if (set & TIOCM_RTS)
754 urb_value |= FTDI_SIO_SET_RTS_HIGH;
1da177e4
LT		 755 rv = usb_control_msg(port->serial->dev,
756 usb_sndctrlpipe(port->serial->dev, 0),
5c09d144 757 FTDI_SIO_SET_MODEM_CTRL_REQUEST,
1da177e4 758 FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE,
74ede0ff 759 urb_value, priv->interface,
1da177e4
LT		 760 buf, 0, WDR_TIMEOUT);
761
762 kfree(buf);
74ede0ff
IA		 763 if (rv < 0) {
764 err("%s Error from MODEM_CTRL urb: DTR %s, RTS %s",
765 __FUNCTION__,
766 (set & TIOCM_DTR) ? "HIGH" :
767 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
768 (set & TIOCM_RTS) ? "HIGH" :
769 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
770 } else {
771 dbg("%s - DTR %s, RTS %s", __FUNCTION__,
772 (set & TIOCM_DTR) ? "HIGH" :
773 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
774 (set & TIOCM_RTS) ? "HIGH" :
775 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
776 priv->last_dtr_rts = (priv->last_dtr_rts & ~clear) | set;
777 }
1da177e4
LT		 778 return rv;
779}
780
781
782static __u32 get_ftdi_divisor(struct usb_serial_port * port);
783
784
785static int change_speed(struct usb_serial_port *port)
786{
787 struct ftdi_private *priv = usb_get_serial_port_data(port);
788 char *buf;
789 __u16 urb_value;
790 __u16 urb_index;
791 __u32 urb_index_value;
792 int rv;
793
794 buf = kmalloc(1, GFP_NOIO);
795 if (!buf)
796 return -ENOMEM;
797
798 urb_index_value = get_ftdi_divisor(port);
799 urb_value = (__u16)urb_index_value;
800 urb_index = (__u16)(urb_index_value >> 16);
801 if (priv->interface) { /* FT2232C */
802 urb_index = (__u16)((urb_index << 8) | priv->interface);
803 }
5c09d144 804
1da177e4
LT		 805 rv = usb_control_msg(port->serial->dev,
806 usb_sndctrlpipe(port->serial->dev, 0),
807 FTDI_SIO_SET_BAUDRATE_REQUEST,
808 FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE,
809 urb_value, urb_index,
279e1545 810 buf, 0, WDR_SHORT_TIMEOUT);
1da177e4
LT		 811
812 kfree(buf);
813 return rv;
814}
815
816
817static __u32 get_ftdi_divisor(struct usb_serial_port * port)
818{ /* get_ftdi_divisor */
819 struct ftdi_private *priv = usb_get_serial_port_data(port);
820 __u32 div_value = 0;
821 int div_okay = 1;
822 int baud;
823
824 /*
825 * The logic involved in setting the baudrate can be cleanly split in 3 steps.
826 * Obtaining the actual baud rate is a little tricky since unix traditionally
827 * somehow ignored the possibility to set non-standard baud rates.
828 * 1. Standard baud rates are set in tty->termios->c_cflag
829 * 2. If these are not enough, you can set any speed using alt_speed as follows:
830 * - set tty->termios->c_cflag speed to B38400
831 * - set your real speed in tty->alt_speed; it gets ignored when
832 * alt_speed==0, (or)
833 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
834 * flags & ASYNC_SPD_MASK == ASYNC_SPD_[HI, VHI, SHI, WARP], this just
835 * sets alt_speed to (HI: 57600, VHI: 115200, SHI: 230400, WARP: 460800)
836 * ** Steps 1, 2 are done courtesy of tty_get_baud_rate
837 * 3. You can also set baud rate by setting custom divisor as follows
838 * - set tty->termios->c_cflag speed to B38400
839 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
840 * o flags & ASYNC_SPD_MASK == ASYNC_SPD_CUST
841 * o custom_divisor set to baud_base / your_new_baudrate
842 * ** Step 3 is done courtesy of code borrowed from serial.c - I should really
843 * spend some time and separate+move this common code to serial.c, it is
844 * replicated in nearly every serial driver you see.
845 */
846
847 /* 1. Get the baud rate from the tty settings, this observes alt_speed hack */
848
849 baud = tty_get_baud_rate(port->tty);
850 dbg("%s - tty_get_baud_rate reports speed %d", __FUNCTION__, baud);
851
852 /* 2. Observe async-compatible custom_divisor hack, update baudrate if needed */
853
854 if (baud == 38400 &&
855 ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
856 (priv->custom_divisor)) {
857 baud = priv->baud_base / priv->custom_divisor;
858 dbg("%s - custom divisor %d sets baud rate to %d", __FUNCTION__, priv->custom_divisor, baud);
859 }
860
861 /* 3. Convert baudrate to device-specific divisor */
862
5c09d144 863 if (!baud) baud = 9600;
1da177e4
LT		 864 switch(priv->chip_type) {
865 case SIO: /* SIO chip */
866 switch(baud) {
867 case 300: div_value = ftdi_sio_b300; break;
868 case 600: div_value = ftdi_sio_b600; break;
869 case 1200: div_value = ftdi_sio_b1200; break;
870 case 2400: div_value = ftdi_sio_b2400; break;
871 case 4800: div_value = ftdi_sio_b4800; break;
872 case 9600: div_value = ftdi_sio_b9600; break;
873 case 19200: div_value = ftdi_sio_b19200; break;
874 case 38400: div_value = ftdi_sio_b38400; break;
875 case 57600: div_value = ftdi_sio_b57600; break;
876 case 115200: div_value = ftdi_sio_b115200; break;
877 } /* baud */
878 if (div_value == 0) {
5c09d144 879 dbg("%s - Baudrate (%d) requested is not supported", __FUNCTION__, baud);
1da177e4
LT		 880 div_value = ftdi_sio_b9600;
881 div_okay = 0;
882 }
883 break;
884 case FT8U232AM: /* 8U232AM chip */
885 if (baud <= 3000000) {
886 div_value = ftdi_232am_baud_to_divisor(baud);
887 } else {
888 dbg("%s - Baud rate too high!", __FUNCTION__);
889 div_value = ftdi_232am_baud_to_divisor(9600);
890 div_okay = 0;
891 }
892 break;
893 case FT232BM: /* FT232BM chip */
894 case FT2232C: /* FT2232C chip */
3b009c63 895 case FT232RL:
1da177e4
LT		 896 if (baud <= 3000000) {
897 div_value = ftdi_232bm_baud_to_divisor(baud);
898 } else {
899 dbg("%s - Baud rate too high!", __FUNCTION__);
900 div_value = ftdi_232bm_baud_to_divisor(9600);
901 div_okay = 0;
902 }
903 break;
904 } /* priv->chip_type */
905
906 if (div_okay) {
907 dbg("%s - Baud rate set to %d (divisor 0x%lX) on chip %s",
908 __FUNCTION__, baud, (unsigned long)div_value,
909 ftdi_chip_name[priv->chip_type]);
910 }
911
912 return(div_value);
913}
914
915
916static int get_serial_info(struct usb_serial_port * port, struct serial_struct __user * retinfo)
917{
918 struct ftdi_private *priv = usb_get_serial_port_data(port);
919 struct serial_struct tmp;
920
921 if (!retinfo)
922 return -EFAULT;
923 memset(&tmp, 0, sizeof(tmp));
924 tmp.flags = priv->flags;
925 tmp.baud_base = priv->baud_base;
926 tmp.custom_divisor = priv->custom_divisor;
927 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
928 return -EFAULT;
929 return 0;
930} /* get_serial_info */
931
932
933static int set_serial_info(struct usb_serial_port * port, struct serial_struct __user * newinfo)
934{ /* set_serial_info */
935 struct ftdi_private *priv = usb_get_serial_port_data(port);
936 struct serial_struct new_serial;
937 struct ftdi_private old_priv;
938
939 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
940 return -EFAULT;
941 old_priv = * priv;
942
943 /* Do error checking and permission checking */
944
945 if (!capable(CAP_SYS_ADMIN)) {
946 if (((new_serial.flags & ~ASYNC_USR_MASK) !=
947 (priv->flags & ~ASYNC_USR_MASK)))
948 return -EPERM;
949 priv->flags = ((priv->flags & ~ASYNC_USR_MASK) |
950 (new_serial.flags & ASYNC_USR_MASK));
951 priv->custom_divisor = new_serial.custom_divisor;
952 goto check_and_exit;
953 }
954
955 if ((new_serial.baud_base != priv->baud_base) &&
956 (new_serial.baud_base < 9600))
957 return -EINVAL;
958
959 /* Make the changes - these are privileged changes! */
960
961 priv->flags = ((priv->flags & ~ASYNC_FLAGS) |
5c09d144 962 (new_serial.flags & ASYNC_FLAGS));
1da177e4
LT		 963 priv->custom_divisor = new_serial.custom_divisor;
964
965 port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
966
967check_and_exit:
968 if ((old_priv.flags & ASYNC_SPD_MASK) !=
969 (priv->flags & ASYNC_SPD_MASK)) {
970 if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_HI)
971 port->tty->alt_speed = 57600;
972 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_VHI)
973 port->tty->alt_speed = 115200;
974 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_SHI)
975 port->tty->alt_speed = 230400;
976 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_WARP)
977 port->tty->alt_speed = 460800;
978 else
979 port->tty->alt_speed = 0;
980 }
981 if (((old_priv.flags & ASYNC_SPD_MASK) !=
982 (priv->flags & ASYNC_SPD_MASK)) ||
983 (((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
984 (old_priv.custom_divisor != priv->custom_divisor))) {
985 change_speed(port);
986 }
5c09d144 987
1da177e4
LT		 988 return (0);
989
990} /* set_serial_info */
991
992
8f977e42
IA		 993/* Determine type of FTDI chip based on USB config and descriptor. */
994static void ftdi_determine_type(struct usb_serial_port *port)
995{
996 struct ftdi_private *priv = usb_get_serial_port_data(port);
997 struct usb_serial *serial = port->serial;
998 struct usb_device *udev = serial->dev;
999 unsigned version;
1000 unsigned interfaces;
1001
1002 /* Assume it is not the original SIO device for now. */
f5e09b7c 1003 priv->baud_base = 48000000 / 2;
8f977e42
IA		 1004 priv->write_offset = 0;
1005
1006 version = le16_to_cpu(udev->descriptor.bcdDevice);
1007 interfaces = udev->actconfig->desc.bNumInterfaces;
1008 dbg("%s: bcdDevice = 0x%x, bNumInterfaces = %u", __FUNCTION__,
1009 version, interfaces);
1010 if (interfaces > 1) {
1011 int inter;
1012
1013 /* Multiple interfaces. Assume FT2232C. */
1014 priv->chip_type = FT2232C;
1015 /* Determine interface code. */
1016 inter = serial->interface->altsetting->desc.bInterfaceNumber;
1017 if (inter == 0) {
1018 priv->interface = PIT_SIOA;
1019 } else {
1020 priv->interface = PIT_SIOB;
1021 }
1022 /* BM-type devices have a bug where bcdDevice gets set
1023 * to 0x200 when iSerialNumber is 0. */
1024 if (version < 0x500) {
1025 dbg("%s: something fishy - bcdDevice too low for multi-interface device",
1026 __FUNCTION__);
1027 }
1028 } else if (version < 0x200) {
1029 /* Old device. Assume its the original SIO. */
1030 priv->chip_type = SIO;
1031 priv->baud_base = 12000000 / 16;
1032 priv->write_offset = 1;
1033 } else if (version < 0x400) {
1034 /* Assume its an FT8U232AM (or FT8U245AM) */
1035 /* (It might be a BM because of the iSerialNumber bug,
1036 * but it will still work as an AM device.) */
1037 priv->chip_type = FT8U232AM;
3b009c63 1038 } else if (version < 0x600) {
8f977e42
IA		 1039 /* Assume its an FT232BM (or FT245BM) */
1040 priv->chip_type = FT232BM;
3b009c63
DB		 1041 } else {
1042 /* Assume its an FT232R */
1043 priv->chip_type = FT232RL;
8f977e42
IA		 1044 }
1045 info("Detected %s", ftdi_chip_name[priv->chip_type]);
1046}
1047
1048
1da177e4
LT		 1049/*
1050 * ***************************************************************************
1051 * Sysfs Attribute
1052 * ***************************************************************************
1053 */
1054
060b8845 1055static ssize_t show_latency_timer(struct device *dev, struct device_attribute *attr, char *buf)
1da177e4
LT		 1056{
1057 struct usb_serial_port *port = to_usb_serial_port(dev);
1058 struct ftdi_private *priv = usb_get_serial_port_data(port);
12bdbe03 1059 struct usb_device *udev = port->serial->dev;
1da177e4
LT		 1060 unsigned short latency = 0;
1061 int rv = 0;
5c09d144 1062
5c09d144 1063
1da177e4 1064 dbg("%s",__FUNCTION__);
5c09d144 1065
1da177e4
LT		 1066 rv = usb_control_msg(udev,
1067 usb_rcvctrlpipe(udev, 0),
1068 FTDI_SIO_GET_LATENCY_TIMER_REQUEST,
1069 FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE,
5c09d144 1070 0, priv->interface,
1da177e4 1071 (char*) &latency, 1, WDR_TIMEOUT);
5c09d144 1072
1da177e4 1073 if (rv < 0) {
898eb71c 1074 dev_err(dev, "Unable to read latency timer: %i\n", rv);
1da177e4
LT		 1075 return -EIO;
1076 }
1077 return sprintf(buf, "%i\n", latency);
1078}
1079
1080/* Write a new value of the latency timer, in units of milliseconds. */
060b8845 1081static ssize_t store_latency_timer(struct device *dev, struct device_attribute *attr, const char *valbuf,
1da177e4
LT		 1082 size_t count)
1083{
1084 struct usb_serial_port *port = to_usb_serial_port(dev);
1085 struct ftdi_private *priv = usb_get_serial_port_data(port);
12bdbe03 1086 struct usb_device *udev = port->serial->dev;
1da177e4
LT		 1087 char buf[1];
1088 int v = simple_strtoul(valbuf, NULL, 10);
1089 int rv = 0;
5c09d144 1090
1da177e4 1091 dbg("%s: setting latency timer = %i", __FUNCTION__, v);
5c09d144 1092
1da177e4
LT		 1093 rv = usb_control_msg(udev,
1094 usb_sndctrlpipe(udev, 0),
1095 FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
1096 FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
5c09d144 1097 v, priv->interface,
1da177e4 1098 buf, 0, WDR_TIMEOUT);
5c09d144 1099
1da177e4 1100 if (rv < 0) {
898eb71c 1101 dev_err(dev, "Unable to write latency timer: %i\n", rv);
1da177e4
LT		 1102 return -EIO;
1103 }
5c09d144 1104
1da177e4
LT		 1105 return count;
1106}
1107
1108/* Write an event character directly to the FTDI register. The ASCII
1109 value is in the low 8 bits, with the enable bit in the 9th bit. */
060b8845 1110static ssize_t store_event_char(struct device *dev, struct device_attribute *attr, const char *valbuf,
1da177e4
LT		 1111 size_t count)
1112{
1113 struct usb_serial_port *port = to_usb_serial_port(dev);
1114 struct ftdi_private *priv = usb_get_serial_port_data(port);
12bdbe03 1115 struct usb_device *udev = port->serial->dev;
1da177e4
LT		 1116 char buf[1];
1117 int v = simple_strtoul(valbuf, NULL, 10);
1118 int rv = 0;
5c09d144 1119
1da177e4 1120 dbg("%s: setting event char = %i", __FUNCTION__, v);
5c09d144 1121
1da177e4
LT		 1122 rv = usb_control_msg(udev,
1123 usb_sndctrlpipe(udev, 0),
1124 FTDI_SIO_SET_EVENT_CHAR_REQUEST,
1125 FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE,
5c09d144 1126 v, priv->interface,
1da177e4 1127 buf, 0, WDR_TIMEOUT);
5c09d144 1128
1da177e4
LT		 1129 if (rv < 0) {
1130 dbg("Unable to write event character: %i", rv);
1131 return -EIO;
1132 }
5c09d144 1133
1da177e4
LT		 1134 return count;
1135}
1136
1137static DEVICE_ATTR(latency_timer, S_IWUSR | S_IRUGO, show_latency_timer, store_latency_timer);
1138static DEVICE_ATTR(event_char, S_IWUSR, NULL, store_event_char);
1139
12bdbe03 1140static int create_sysfs_attrs(struct usb_serial_port *port)
13f4db9e 1141{
12bdbe03 1142 struct ftdi_private *priv = usb_get_serial_port_data(port);
13f4db9e 1143 int retval = 0;
1da177e4
LT		 1144
1145 dbg("%s",__FUNCTION__);
13f4db9e 1146
1da177e4
LT		 1147 /* XXX I've no idea if the original SIO supports the event_char
1148 * sysfs parameter, so I'm playing it safe. */
1149 if (priv->chip_type != SIO) {
1150 dbg("sysfs attributes for %s", ftdi_chip_name[priv->chip_type]);
12bdbe03 1151 retval = device_create_file(&port->dev, &dev_attr_event_char);
13f4db9e 1152 if ((!retval) &&
97cd49eb
SM		 1153 (priv->chip_type == FT232BM ||
1154 priv->chip_type == FT2232C ||
1155 priv->chip_type == FT232RL)) {
12bdbe03 1156 retval = device_create_file(&port->dev,
13f4db9e 1157 &dev_attr_latency_timer);
1da177e4
LT		 1158 }
1159 }
13f4db9e 1160 return retval;
1da177e4
LT		 1161}
1162
12bdbe03 1163static void remove_sysfs_attrs(struct usb_serial_port *port)
1da177e4 1164{
12bdbe03 1165 struct ftdi_private *priv = usb_get_serial_port_data(port);
1da177e4 1166
5c09d144 1167 dbg("%s",__FUNCTION__);
1da177e4 1168
1da177e4
LT		 1169 /* XXX see create_sysfs_attrs */
1170 if (priv->chip_type != SIO) {
12bdbe03 1171 device_remove_file(&port->dev, &dev_attr_event_char);
ed6e5282
AB		 1172 if (priv->chip_type == FT232BM ||
1173 priv->chip_type == FT2232C ||
1174 priv->chip_type == FT232RL) {
12bdbe03 1175 device_remove_file(&port->dev, &dev_attr_latency_timer);
1da177e4
LT		 1176 }
1177 }
5c09d144 1178
1da177e4
LT		 1179}
1180
1181/*
1182 * ***************************************************************************
1183 * FTDI driver specific functions
1184 * ***************************************************************************
1185 */
1186
8f977e42
IA		 1187/* Probe function to check for special devices */
1188static int ftdi_sio_probe (struct usb_serial *serial, const struct usb_device_id *id)
1189{
fa91d43b
TL		 1190 struct ftdi_sio_quirk *quirk = (struct ftdi_sio_quirk *)id->driver_info;
1191
1192 if (quirk && quirk->probe) {
1193 int ret = quirk->probe(serial);
1194 if (ret != 0)
1195 return ret;
1196 }
1197
8f977e42
IA		 1198 usb_set_serial_data(serial, (void *)id->driver_info);
1199
fa91d43b 1200 return 0;
8f977e42
IA		 1201}
1202
12bdbe03 1203static int ftdi_sio_port_probe(struct usb_serial_port *port)
1da177e4 1204{
1da177e4 1205 struct ftdi_private *priv;
0ffbbe25
ON		 1206 struct ftdi_sio_quirk *quirk = usb_get_serial_data(port->serial);
1207
13f4db9e 1208
1da177e4
LT		 1209 dbg("%s",__FUNCTION__);
1210
80b6ca48 1211 priv = kzalloc(sizeof(struct ftdi_private), GFP_KERNEL);
1da177e4
LT		 1212 if (!priv){
1213 err("%s- kmalloc(%Zd) failed.", __FUNCTION__, sizeof(struct ftdi_private));
1214 return -ENOMEM;
1215 }
1da177e4
LT		 1216
1217 spin_lock_init(&priv->rx_lock);
22465400 1218 spin_lock_init(&priv->tx_lock);
1da177e4
LT		 1219 init_waitqueue_head(&priv->delta_msr_wait);
1220 /* This will push the characters through immediately rather
1221 than queue a task to deliver them */
1222 priv->flags = ASYNC_LOW_LATENCY;
1223
0ffbbe25
ON		 1224 if (quirk && quirk->port_probe)
1225 quirk->port_probe(priv);
1226
1da177e4 1227 /* Increase the size of read buffers */
1bc3c9e1 1228 kfree(port->bulk_in_buffer);
1da177e4
LT		 1229 port->bulk_in_buffer = kmalloc (BUFSZ, GFP_KERNEL);
1230 if (!port->bulk_in_buffer) {
1231 kfree (priv);
1232 return -ENOMEM;
1233 }
1234 if (port->read_urb) {
1235 port->read_urb->transfer_buffer = port->bulk_in_buffer;
1236 port->read_urb->transfer_buffer_length = BUFSZ;
1237 }
1238
c4028958
DH		 1239 INIT_DELAYED_WORK(&priv->rx_work, ftdi_process_read);
1240 priv->port = port;
76854cea 1241
1da177e4
LT		 1242 /* Free port's existing write urb and transfer buffer. */
1243 if (port->write_urb) {
1244 usb_free_urb (port->write_urb);
1245 port->write_urb = NULL;
1246 }
1bc3c9e1
JJ		 1247 kfree(port->bulk_out_buffer);
1248 port->bulk_out_buffer = NULL;
1da177e4 1249
12bdbe03 1250 usb_set_serial_port_data(port, priv);
1da177e4 1251
12bdbe03
JR		 1252 ftdi_determine_type (port);
1253 create_sysfs_attrs(port);
1254 return 0;
1255}
1da177e4 1256
8f977e42
IA		 1257/* Setup for the USB-UIRT device, which requires hardwired
1258 * baudrate (38400 gets mapped to 312500) */
1da177e4 1259/* Called from usbserial:serial_probe */
0ffbbe25 1260static void ftdi_USB_UIRT_setup (struct ftdi_private *priv)
8f977e42 1261{
1da177e4 1262 dbg("%s",__FUNCTION__);
1da177e4 1263
1da177e4
LT		 1264 priv->flags |= ASYNC_SPD_CUST;
1265 priv->custom_divisor = 77;
1266 priv->force_baud = B38400;
8f977e42 1267} /* ftdi_USB_UIRT_setup */
1da177e4 1268
8f977e42
IA		 1269/* Setup for the HE-TIRA1 device, which requires hardwired
1270 * baudrate (38400 gets mapped to 100000) and RTS-CTS enabled. */
0ffbbe25 1271static void ftdi_HE_TIRA1_setup (struct ftdi_private *priv)
8f977e42 1272{
1da177e4 1273 dbg("%s",__FUNCTION__);
1da177e4 1274
1da177e4
LT		 1275 priv->flags |= ASYNC_SPD_CUST;
1276 priv->custom_divisor = 240;
1277 priv->force_baud = B38400;
1278 priv->force_rtscts = 1;
8f977e42 1279} /* ftdi_HE_TIRA1_setup */
1da177e4 1280
fa91d43b
TL		 1281/*
1282 * First port on Olimex arm-usb-ocd is reserved for JTAG interface
1283 * and can be accessed from userspace using openocd.
1284 */
1285static int ftdi_olimex_probe(struct usb_serial *serial)
1286{
1287 struct usb_device *udev = serial->dev;
1288 struct usb_interface *interface = serial->interface;
1289
1290 dbg("%s",__FUNCTION__);
1291
1292 if (interface == udev->actconfig->interface[0]) {
1293 info("Ignoring reserved serial port on Olimex arm-usb-ocd\n");
1294 return -ENODEV;
1295 }
1296
1297 return 0;
1298}
1da177e4 1299
5c09d144 1300/* ftdi_shutdown is called from usbserial:usb_serial_disconnect
1da177e4
LT		 1301 * it is called when the usb device is disconnected
1302 *
1303 * usbserial:usb_serial_disconnect
1304 * calls __serial_close for each open of the port
1305 * shutdown is called then (ie ftdi_shutdown)
1306 */
1da177e4 1307static void ftdi_shutdown (struct usb_serial *serial)
12bdbe03
JR		 1308{
1309 dbg("%s", __FUNCTION__);
1310}
5c09d144 1311
12bdbe03
JR		 1312static int ftdi_sio_port_remove(struct usb_serial_port *port)
1313{
1da177e4
LT		 1314 struct ftdi_private *priv = usb_get_serial_port_data(port);
1315
1316 dbg("%s", __FUNCTION__);
1317
12bdbe03 1318 remove_sysfs_attrs(port);
5c09d144
DB		 1319
1320 /* all open ports are closed at this point
1321 * (by usbserial.c:__serial_close, which calls ftdi_close)
1da177e4
LT		 1322 */
1323
1324 if (priv) {
1325 usb_set_serial_port_data(port, NULL);
1326 kfree(priv);
1327 }
1da177e4 1328
12bdbe03
JR		 1329 return 0;
1330}
1da177e4
LT		 1331
1332static int ftdi_open (struct usb_serial_port *port, struct file *filp)
1333{ /* ftdi_open */
1da177e4
LT		 1334 struct usb_device *dev = port->serial->dev;
1335 struct ftdi_private *priv = usb_get_serial_port_data(port);
1336 unsigned long flags;
5c09d144 1337
1da177e4
LT		 1338 int result = 0;
1339 char buf[1]; /* Needed for the usb_control_msg I think */
1340
1341 dbg("%s", __FUNCTION__);
1342
22465400
IA		 1343 spin_lock_irqsave(&priv->tx_lock, flags);
1344 priv->tx_bytes = 0;
1345 spin_unlock_irqrestore(&priv->tx_lock, flags);
1346 spin_lock_irqsave(&priv->rx_lock, flags);
1347 priv->rx_bytes = 0;
1348 spin_unlock_irqrestore(&priv->rx_lock, flags);
1349
57845bd1
GL		 1350 if (port->tty)
1351 port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
1da177e4
LT		 1352
1353 /* No error checking for this (will get errors later anyway) */
1354 /* See ftdi_sio.h for description of what is reset */
1355 usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
5c09d144
DB		 1356 FTDI_SIO_RESET_REQUEST, FTDI_SIO_RESET_REQUEST_TYPE,
1357 FTDI_SIO_RESET_SIO,
1da177e4
LT		 1358 priv->interface, buf, 0, WDR_TIMEOUT);
1359
1360 /* Termios defaults are set by usb_serial_init. We don't change
1361 port->tty->termios - this would loose speed settings, etc.
1362 This is same behaviour as serial.c/rs_open() - Kuba */
1363
1364 /* ftdi_set_termios will send usb control messages */
57845bd1
GL		 1365 if (port->tty)
1366 ftdi_set_termios(port, NULL);
1da177e4
LT		 1367
1368 /* FIXME: Flow control might be enabled, so it should be checked -
1369 we have no control of defaults! */
1370 /* Turn on RTS and DTR since we are not flow controlling by default */
74ede0ff 1371 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1da177e4
LT		 1372
1373 /* Not throttled */
1374 spin_lock_irqsave(&priv->rx_lock, flags);
1375 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
1376 spin_unlock_irqrestore(&priv->rx_lock, flags);
1377
1378 /* Start reading from the device */
76854cea 1379 priv->rx_processed = 0;
1da177e4
LT		 1380 usb_fill_bulk_urb(port->read_urb, dev,
1381 usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress),
1382 port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
1383 ftdi_read_bulk_callback, port);
1384 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
1385 if (result)
1386 err("%s - failed submitting read urb, error %d", __FUNCTION__, result);
1387
1388
1389 return result;
1390} /* ftdi_open */
1391
1392
1393
5c09d144 1394/*
1da177e4
LT		 1395 * usbserial:__serial_close only calls ftdi_close if the point is open
1396 *
1397 * This only gets called when it is the last close
5c09d144
DB		 1398 *
1399 *
1da177e4
LT		 1400 */
1401
1402static void ftdi_close (struct usb_serial_port *port, struct file *filp)
1403{ /* ftdi_close */
1404 unsigned int c_cflag = port->tty->termios->c_cflag;
1405 struct ftdi_private *priv = usb_get_serial_port_data(port);
1406 char buf[1];
1407
1408 dbg("%s", __FUNCTION__);
1409
1410 if (c_cflag & HUPCL){
1411 /* Disable flow control */
5c09d144 1412 if (usb_control_msg(port->serial->dev,
1da177e4
LT		 1413 usb_sndctrlpipe(port->serial->dev, 0),
1414 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1415 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1416 0, priv->interface, buf, 0,
1417 WDR_TIMEOUT) < 0) {
1418 err("error from flowcontrol urb");
5c09d144 1419 }
1da177e4 1420
74ede0ff
IA		 1421 /* drop RTS and DTR */
1422 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1da177e4 1423 } /* Note change no line if hupcl is off */
76854cea
IA		 1424
1425 /* cancel any scheduled reading */
1426 cancel_delayed_work(&priv->rx_work);
1427 flush_scheduled_work();
5c09d144 1428
1da177e4 1429 /* shutdown our bulk read */
794c944e 1430 usb_kill_urb(port->read_urb);
1da177e4
LT		 1431} /* ftdi_close */
1432
1433
5c09d144 1434
1da177e4
LT		 1435/* The SIO requires the first byte to have:
1436 * B0 1
1437 * B1 0
1438 * B2..7 length of message excluding byte 0
1439 *
1440 * The new devices do not require this byte
1441 */
1442static int ftdi_write (struct usb_serial_port *port,
1443 const unsigned char *buf, int count)
1444{ /* ftdi_write */
1445 struct ftdi_private *priv = usb_get_serial_port_data(port);
1446 struct urb *urb;
1447 unsigned char *buffer;
1448 int data_offset ; /* will be 1 for the SIO and 0 otherwise */
1449 int status;
1450 int transfer_size;
22465400 1451 unsigned long flags;
1da177e4
LT		 1452
1453 dbg("%s port %d, %d bytes", __FUNCTION__, port->number, count);
1454
1455 if (count == 0) {
1456 dbg("write request of 0 bytes");
1457 return 0;
1458 }
22465400
IA		 1459 spin_lock_irqsave(&priv->tx_lock, flags);
1460 if (priv->tx_outstanding_urbs > URB_UPPER_LIMIT) {
1461 spin_unlock_irqrestore(&priv->tx_lock, flags);
1462 dbg("%s - write limit hit\n", __FUNCTION__);
1463 return 0;
1464 }
62127a58 1465 priv->tx_outstanding_urbs++;
22465400 1466 spin_unlock_irqrestore(&priv->tx_lock, flags);
5c09d144 1467
1da177e4
LT		 1468 data_offset = priv->write_offset;
1469 dbg("data_offset set to %d",data_offset);
1470
1471 /* Determine total transfer size */
1472 transfer_size = count;
1473 if (data_offset > 0) {
1474 /* Original sio needs control bytes too... */
1475 transfer_size += (data_offset *
1476 ((count + (PKTSZ - 1 - data_offset)) /
1477 (PKTSZ - data_offset)));
1478 }
1479
1480 buffer = kmalloc (transfer_size, GFP_ATOMIC);
1481 if (!buffer) {
1482 err("%s ran out of kernel memory for urb ...", __FUNCTION__);
62127a58
ON		 1483 count = -ENOMEM;
1484 goto error_no_buffer;
1da177e4
LT		 1485 }
1486
1487 urb = usb_alloc_urb(0, GFP_ATOMIC);
1488 if (!urb) {
1489 err("%s - no more free urbs", __FUNCTION__);
62127a58
ON		 1490 count = -ENOMEM;
1491 goto error_no_urb;
1da177e4
LT		 1492 }
1493
1494 /* Copy data */
1495 if (data_offset > 0) {
1496 /* Original sio requires control byte at start of each packet. */
1497 int user_pktsz = PKTSZ - data_offset;
1498 int todo = count;
1499 unsigned char *first_byte = buffer;
1500 const unsigned char *current_position = buf;
1501
1502 while (todo > 0) {
1503 if (user_pktsz > todo) {
1504 user_pktsz = todo;
1505 }
1506 /* Write the control byte at the front of the packet*/
5c09d144 1507 *first_byte = 1 | ((user_pktsz) << 2);
1da177e4
LT		 1508 /* Copy data for packet */
1509 memcpy (first_byte + data_offset,
1510 current_position, user_pktsz);
1511 first_byte += user_pktsz + data_offset;
1512 current_position += user_pktsz;
1513 todo -= user_pktsz;
1514 }
1515 } else {
1516 /* No control byte required. */
1517 /* Copy in the data to send */
1518 memcpy (buffer, buf, count);
1519 }
1520
1521 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, transfer_size, buffer);
1522
1523 /* fill the buffer and send it */
5c09d144 1524 usb_fill_bulk_urb(urb, port->serial->dev,
1da177e4
LT		 1525 usb_sndbulkpipe(port->serial->dev, port->bulk_out_endpointAddress),
1526 buffer, transfer_size,
1527 ftdi_write_bulk_callback, port);
1528
1529 status = usb_submit_urb(urb, GFP_ATOMIC);
1530 if (status) {
1531 err("%s - failed submitting write urb, error %d", __FUNCTION__, status);
1532 count = status;
62127a58 1533 goto error;
22465400
IA		 1534 } else {
1535 spin_lock_irqsave(&priv->tx_lock, flags);
22465400
IA		 1536 priv->tx_outstanding_bytes += count;
1537 priv->tx_bytes += count;
1538 spin_unlock_irqrestore(&priv->tx_lock, flags);
1da177e4
LT		 1539 }
1540
1541 /* we are done with this urb, so let the host driver
1542 * really free it when it is finished with it */
62127a58 1543 usb_free_urb(urb);
1da177e4
LT		 1544
1545 dbg("%s write returning: %d", __FUNCTION__, count);
1546 return count;
62127a58
ON		 1547error:
1548 usb_free_urb(urb);
1549error_no_urb:
1550 kfree (buffer);
1551error_no_buffer:
1552 spin_lock_irqsave(&priv->tx_lock, flags);
1553 priv->tx_outstanding_urbs--;
1554 spin_unlock_irqrestore(&priv->tx_lock, flags);
1555 return count;
1da177e4
LT		 1556} /* ftdi_write */
1557
1558
1559/* This function may get called when the device is closed */
1560
7d12e780 1561static void ftdi_write_bulk_callback (struct urb *urb)
1da177e4 1562{
22465400 1563 unsigned long flags;
1da177e4 1564 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
22465400
IA		 1565 struct ftdi_private *priv;
1566 int data_offset; /* will be 1 for the SIO and 0 otherwise */
1567 unsigned long countback;
0fb0aa18 1568 int status = urb->status;
1da177e4
LT		 1569
1570 /* free up the transfer buffer, as usb_free_urb() does not do this */
1571 kfree (urb->transfer_buffer);
1572
1573 dbg("%s - port %d", __FUNCTION__, port->number);
5c09d144 1574
0fb0aa18
GKH		 1575 if (status) {
1576 dbg("nonzero write bulk status received: %d", status);
1da177e4
LT		 1577 return;
1578 }
1579
22465400
IA		 1580 priv = usb_get_serial_port_data(port);
1581 if (!priv) {
1582 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1583 return;
1584 }
1585 /* account for transferred data */
1586 countback = urb->actual_length;
1587 data_offset = priv->write_offset;
1588 if (data_offset > 0) {
1589 /* Subtract the control bytes */
1590 countback -= (data_offset * ((countback + (PKTSZ - 1)) / PKTSZ));
1591 }
1592 spin_lock_irqsave(&priv->tx_lock, flags);
1593 --priv->tx_outstanding_urbs;
1594 priv->tx_outstanding_bytes -= countback;
1595 spin_unlock_irqrestore(&priv->tx_lock, flags);
1596
cf2c7481 1597 usb_serial_port_softint(port);
1da177e4
LT		 1598} /* ftdi_write_bulk_callback */
1599
1600
1601static int ftdi_write_room( struct usb_serial_port *port )
1602{
22465400
IA		 1603 struct ftdi_private *priv = usb_get_serial_port_data(port);
1604 int room;
1605 unsigned long flags;
1606
1da177e4
LT		 1607 dbg("%s - port %d", __FUNCTION__, port->number);
1608
22465400
IA		 1609 spin_lock_irqsave(&priv->tx_lock, flags);
1610 if (priv->tx_outstanding_urbs < URB_UPPER_LIMIT) {
1611 /*
1612 * We really can take anything the user throws at us
1613 * but let's pick a nice big number to tell the tty
1614 * layer that we have lots of free space
1615 */
1616 room = 2048;
1617 } else {
1618 room = 0;
1619 }
1620 spin_unlock_irqrestore(&priv->tx_lock, flags);
1621 return room;
1da177e4
LT		 1622} /* ftdi_write_room */
1623
1624
1625static int ftdi_chars_in_buffer (struct usb_serial_port *port)
1626{ /* ftdi_chars_in_buffer */
22465400
IA		 1627 struct ftdi_private *priv = usb_get_serial_port_data(port);
1628 int buffered;
1629 unsigned long flags;
1630
1da177e4
LT		 1631 dbg("%s - port %d", __FUNCTION__, port->number);
1632
22465400
IA		 1633 spin_lock_irqsave(&priv->tx_lock, flags);
1634 buffered = (int)priv->tx_outstanding_bytes;
1635 spin_unlock_irqrestore(&priv->tx_lock, flags);
1636 if (buffered < 0) {
1637 err("%s outstanding tx bytes is negative!", __FUNCTION__);
1638 buffered = 0;
1639 }
1640 return buffered;
1da177e4
LT		 1641} /* ftdi_chars_in_buffer */
1642
1643
1644
7d12e780 1645static void ftdi_read_bulk_callback (struct urb *urb)
1da177e4
LT		 1646{ /* ftdi_read_bulk_callback */
1647 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1648 struct tty_struct *tty;
1649 struct ftdi_private *priv;
22465400
IA		 1650 unsigned long countread;
1651 unsigned long flags;
0fb0aa18 1652 int status = urb->status;
1da177e4
LT		 1653
1654 if (urb->number_of_packets > 0) {
1655 err("%s transfer_buffer_length %d actual_length %d number of packets %d",__FUNCTION__,
1656 urb->transfer_buffer_length, urb->actual_length, urb->number_of_packets );
1657 err("%s transfer_flags %x ", __FUNCTION__,urb->transfer_flags );
1658 }
1659
1660 dbg("%s - port %d", __FUNCTION__, port->number);
1661
1662 if (port->open_count <= 0)
1663 return;
1664
1665 tty = port->tty;
1666 if (!tty) {
1667 dbg("%s - bad tty pointer - exiting",__FUNCTION__);
1668 return;
1669 }
1670
1671 priv = usb_get_serial_port_data(port);
1672 if (!priv) {
1673 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1674 return;
1675 }
1676
1677 if (urb != port->read_urb) {
1678 err("%s - Not my urb!", __FUNCTION__);
1679 }
1680
0fb0aa18 1681 if (status) {
1da177e4 1682 /* This will happen at close every time so it is a dbg not an err */
0fb0aa18
GKH		 1683 dbg("(this is ok on close) nonzero read bulk status received: "
1684 "%d", status);
1da177e4
LT		 1685 return;
1686 }
1687
22465400
IA		 1688 /* count data bytes, but not status bytes */
1689 countread = urb->actual_length;
1690 countread -= 2 * ((countread + (PKTSZ - 1)) / PKTSZ);
1691 spin_lock_irqsave(&priv->rx_lock, flags);
1692 priv->rx_bytes += countread;
1693 spin_unlock_irqrestore(&priv->rx_lock, flags);
1694
c4028958 1695 ftdi_process_read(&priv->rx_work.work);
1da177e4
LT		 1696
1697} /* ftdi_read_bulk_callback */
1698
1699
c4028958 1700static void ftdi_process_read (struct work_struct *work)
1da177e4 1701{ /* ftdi_process_read */
c4028958
DH		 1702 struct ftdi_private *priv =
1703 container_of(work, struct ftdi_private, rx_work.work);
1704 struct usb_serial_port *port = priv->port;
1da177e4
LT		 1705 struct urb *urb;
1706 struct tty_struct *tty;
1da177e4 1707 char error_flag;
5c09d144 1708 unsigned char *data;
1da177e4
LT		 1709
1710 int i;
1711 int result;
1712 int need_flip;
1713 int packet_offset;
76854cea 1714 unsigned long flags;
1da177e4
LT		 1715
1716 dbg("%s - port %d", __FUNCTION__, port->number);
1717
1718 if (port->open_count <= 0)
1719 return;
1720
1721 tty = port->tty;
1722 if (!tty) {
1723 dbg("%s - bad tty pointer - exiting",__FUNCTION__);
1724 return;
1725 }
1726
1727 priv = usb_get_serial_port_data(port);
1728 if (!priv) {
1729 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1730 return;
1731 }
1732
1733 urb = port->read_urb;
1734 if (!urb) {
1735 dbg("%s - bad read_urb pointer - exiting", __FUNCTION__);
1736 return;
1737 }
1738
1739 data = urb->transfer_buffer;
1740
76854cea
IA		 1741 if (priv->rx_processed) {
1742 dbg("%s - already processed: %d bytes, %d remain", __FUNCTION__,
1743 priv->rx_processed,
1744 urb->actual_length - priv->rx_processed);
1da177e4 1745 } else {
76854cea
IA		 1746 /* The first two bytes of every read packet are status */
1747 if (urb->actual_length > 2) {
1748 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
1749 } else {
1750 dbg("Status only: %03oo %03oo",data[0],data[1]);
1751 }
1752 }
1da177e4
LT		 1753
1754
1755 /* TO DO -- check for hung up line and handle appropriately: */
1756 /* send hangup */
1757 /* See acm.c - you do a tty_hangup - eg tty_hangup(tty) */
1758 /* if CD is dropped and the line is not CLOCAL then we should hangup */
1759
1760 need_flip = 0;
76854cea
IA		 1761 for (packet_offset = priv->rx_processed; packet_offset < urb->actual_length; packet_offset += PKTSZ) {
1762 int length;
1763
1da177e4 1764 /* Compare new line status to the old one, signal if different */
76854cea
IA		 1765 /* N.B. packet may be processed more than once, but differences
1766 * are only processed once. */
1da177e4
LT		 1767 if (priv != NULL) {
1768 char new_status = data[packet_offset+0] & FTDI_STATUS_B0_MASK;
1769 if (new_status != priv->prev_status) {
1770 priv->diff_status |= new_status ^ priv->prev_status;
1771 wake_up_interruptible(&priv->delta_msr_wait);
1772 priv->prev_status = new_status;
1773 }
1774 }
1775
76854cea
IA		 1776 length = min(PKTSZ, urb->actual_length-packet_offset)-2;
1777 if (length < 0) {
1778 err("%s - bad packet length: %d", __FUNCTION__, length+2);
1779 length = 0;
1780 }
1781
76854cea
IA		 1782 if (priv->rx_flags & THROTTLED) {
1783 dbg("%s - throttled", __FUNCTION__);
1784 break;
1785 }
33f0f88f 1786 if (tty_buffer_request_room(tty, length) < length) {
76854cea
IA		 1787 /* break out & wait for throttling/unthrottling to happen */
1788 dbg("%s - receive room low", __FUNCTION__);
1789 break;
1790 }
1791
1da177e4
LT		 1792 /* Handle errors and break */
1793 error_flag = TTY_NORMAL;
1794 /* Although the device uses a bitmask and hence can have multiple */
1795 /* errors on a packet - the order here sets the priority the */
1796 /* error is returned to the tty layer */
1797
1798 if ( data[packet_offset+1] & FTDI_RS_OE ) {
1799 error_flag = TTY_OVERRUN;
1800 dbg("OVERRRUN error");
1801 }
1802 if ( data[packet_offset+1] & FTDI_RS_BI ) {
1803 error_flag = TTY_BREAK;
1804 dbg("BREAK received");
1805 }
1806 if ( data[packet_offset+1] & FTDI_RS_PE ) {
1807 error_flag = TTY_PARITY;
1808 dbg("PARITY error");
1809 }
1810 if ( data[packet_offset+1] & FTDI_RS_FE ) {
1811 error_flag = TTY_FRAME;
1812 dbg("FRAMING error");
1813 }
76854cea
IA		 1814 if (length > 0) {
1815 for (i = 2; i < length+2; i++) {
5c09d144 1816 /* Note that the error flag is duplicated for
1da177e4
LT		 1817 every character received since we don't know
1818 which character it applied to */
1819 tty_insert_flip_char(tty, data[packet_offset+i], error_flag);
1820 }
1821 need_flip = 1;
1822 }
1823
1824#ifdef NOT_CORRECT_BUT_KEEPING_IT_FOR_NOW
1825 /* if a parity error is detected you get status packets forever
1826 until a character is sent without a parity error.
1827 This doesn't work well since the application receives a never
1828 ending stream of bad data - even though new data hasn't been sent.
1829 Therefore I (bill) have taken this out.
5c09d144 1830 However - this might make sense for framing errors and so on
1da177e4
LT		 1831 so I am leaving the code in for now.
1832 */
1833 else {
1834 if (error_flag != TTY_NORMAL){
1835 dbg("error_flag is not normal");
1836 /* In this case it is just status - if that is an error send a bad character */
1837 if(tty->flip.count >= TTY_FLIPBUF_SIZE) {
1838 tty_flip_buffer_push(tty);
1839 }
1840 tty_insert_flip_char(tty, 0xff, error_flag);
1841 need_flip = 1;
1842 }
1843 }
1844#endif
1845 } /* "for(packet_offset=0..." */
1846
1847 /* Low latency */
1848 if (need_flip) {
1849 tty_flip_buffer_push(tty);
1850 }
1851
76854cea
IA		 1852 if (packet_offset < urb->actual_length) {
1853 /* not completely processed - record progress */
1854 priv->rx_processed = packet_offset;
1855 dbg("%s - incomplete, %d bytes processed, %d remain",
1856 __FUNCTION__, packet_offset,
1857 urb->actual_length - packet_offset);
1858 /* check if we were throttled while processing */
1859 spin_lock_irqsave(&priv->rx_lock, flags);
1860 if (priv->rx_flags & THROTTLED) {
1861 priv->rx_flags |= ACTUALLY_THROTTLED;
1862 spin_unlock_irqrestore(&priv->rx_lock, flags);
1863 dbg("%s - deferring remainder until unthrottled",
1864 __FUNCTION__);
1865 return;
1866 }
1867 spin_unlock_irqrestore(&priv->rx_lock, flags);
1868 /* if the port is closed stop trying to read */
1869 if (port->open_count > 0){
1870 /* delay processing of remainder */
1871 schedule_delayed_work(&priv->rx_work, 1);
1872 } else {
1873 dbg("%s - port is closed", __FUNCTION__);
1874 }
1875 return;
1876 }
1877
1878 /* urb is completely processed */
1879 priv->rx_processed = 0;
1880
1da177e4
LT		 1881 /* if the port is closed stop trying to read */
1882 if (port->open_count > 0){
1883 /* Continue trying to always read */
5c09d144 1884 usb_fill_bulk_urb(port->read_urb, port->serial->dev,
1da177e4
LT		 1885 usb_rcvbulkpipe(port->serial->dev, port->bulk_in_endpointAddress),
1886 port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
1887 ftdi_read_bulk_callback, port);
1888
1889 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1890 if (result)
1891 err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
1892 }
1893
1894 return;
1895} /* ftdi_process_read */
1896
1897
1898static void ftdi_break_ctl( struct usb_serial_port *port, int break_state )
1899{
1900 struct ftdi_private *priv = usb_get_serial_port_data(port);
5c09d144 1901 __u16 urb_value = 0;
1da177e4 1902 char buf[1];
5c09d144 1903
1da177e4
LT		 1904 /* break_state = -1 to turn on break, and 0 to turn off break */
1905 /* see drivers/char/tty_io.c to see it used */
1906 /* last_set_data_urb_value NEVER has the break bit set in it */
1907
1908 if (break_state) {
1909 urb_value = priv->last_set_data_urb_value | FTDI_SIO_SET_BREAK;
1910 } else {
5c09d144 1911 urb_value = priv->last_set_data_urb_value;
1da177e4
LT		 1912 }
1913
5c09d144 1914
1da177e4 1915 if (usb_control_msg(port->serial->dev, usb_sndctrlpipe(port->serial->dev, 0),
5c09d144 1916 FTDI_SIO_SET_DATA_REQUEST,
1da177e4
LT		 1917 FTDI_SIO_SET_DATA_REQUEST_TYPE,
1918 urb_value , priv->interface,
1919 buf, 0, WDR_TIMEOUT) < 0) {
1920 err("%s FAILED to enable/disable break state (state was %d)", __FUNCTION__,break_state);
5c09d144 1921 }
1da177e4
LT		 1922
1923 dbg("%s break state is %d - urb is %d", __FUNCTION__,break_state, urb_value);
5c09d144 1924
1da177e4
LT		 1925}
1926
1927
1928/* old_termios contains the original termios settings and tty->termios contains
1929 * the new setting to be used
1930 * WARNING: set_termios calls this with old_termios in kernel space
1931 */
1932
606d099c 1933static void ftdi_set_termios (struct usb_serial_port *port, struct ktermios *old_termios)
1da177e4
LT		 1934{ /* ftdi_termios */
1935 struct usb_device *dev = port->serial->dev;
1936 unsigned int cflag = port->tty->termios->c_cflag;
1937 struct ftdi_private *priv = usb_get_serial_port_data(port);
1938 __u16 urb_value; /* will hold the new flags */
1939 char buf[1]; /* Perhaps I should dynamically alloc this? */
5c09d144 1940
1da177e4
LT		 1941 // Added for xon/xoff support
1942 unsigned int iflag = port->tty->termios->c_iflag;
1943 unsigned char vstop;
1944 unsigned char vstart;
5c09d144 1945
1da177e4
LT		 1946 dbg("%s", __FUNCTION__);
1947
1948 /* Force baud rate if this device requires it, unless it is set to B0. */
1949 if (priv->force_baud && ((port->tty->termios->c_cflag & CBAUD) != B0)) {
1950 dbg("%s: forcing baud rate for this device", __FUNCTION__);
1951 port->tty->termios->c_cflag &= ~CBAUD;
1952 port->tty->termios->c_cflag |= priv->force_baud;
1953 }
1954
1955 /* Force RTS-CTS if this device requires it. */
1956 if (priv->force_rtscts) {
1957 dbg("%s: forcing rtscts for this device", __FUNCTION__);
1958 port->tty->termios->c_cflag |= CRTSCTS;
1959 }
1960
1961 cflag = port->tty->termios->c_cflag;
1962
5c09d144
DB		 1963 /* FIXME -For this cut I don't care if the line is really changing or
1964 not - so just do the change regardless - should be able to
1da177e4 1965 compare old_termios and tty->termios */
5c09d144
DB		 1966 /* NOTE These routines can get interrupted by
1967 ftdi_sio_read_bulk_callback - need to examine what this
1da177e4 1968 means - don't see any problems yet */
5c09d144 1969
1da177e4 1970 /* Set number of data bits, parity, stop bits */
5c09d144 1971
1da177e4
LT		 1972 urb_value = 0;
1973 urb_value |= (cflag & CSTOPB ? FTDI_SIO_SET_DATA_STOP_BITS_2 :
1974 FTDI_SIO_SET_DATA_STOP_BITS_1);
5c09d144
DB		 1975 urb_value |= (cflag & PARENB ?
1976 (cflag & PARODD ? FTDI_SIO_SET_DATA_PARITY_ODD :
1da177e4
LT		 1977 FTDI_SIO_SET_DATA_PARITY_EVEN) :
1978 FTDI_SIO_SET_DATA_PARITY_NONE);
1979 if (cflag & CSIZE) {
1980 switch (cflag & CSIZE) {
1981 case CS5: urb_value |= 5; dbg("Setting CS5"); break;
1982 case CS6: urb_value |= 6; dbg("Setting CS6"); break;
1983 case CS7: urb_value |= 7; dbg("Setting CS7"); break;
1984 case CS8: urb_value |= 8; dbg("Setting CS8"); break;
1985 default:
1986 err("CSIZE was set but not CS5-CS8");
1987 }
1988 }
1989
1990 /* This is needed by the break command since it uses the same command - but is
1991 * or'ed with this value */
1992 priv->last_set_data_urb_value = urb_value;
5c09d144 1993
1da177e4 1994 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
5c09d144 1995 FTDI_SIO_SET_DATA_REQUEST,
1da177e4
LT		 1996 FTDI_SIO_SET_DATA_REQUEST_TYPE,
1997 urb_value , priv->interface,
279e1545 1998 buf, 0, WDR_SHORT_TIMEOUT) < 0) {
1da177e4 1999 err("%s FAILED to set databits/stopbits/parity", __FUNCTION__);
5c09d144 2000 }
1da177e4
LT		 2001
2002 /* Now do the baudrate */
2003 if ((cflag & CBAUD) == B0 ) {
2004 /* Disable flow control */
2005 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
5c09d144 2006 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1da177e4 2007 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
5c09d144 2008 0, priv->interface,
1da177e4
LT		 2009 buf, 0, WDR_TIMEOUT) < 0) {
2010 err("%s error from disable flowcontrol urb", __FUNCTION__);
5c09d144 2011 }
1da177e4 2012 /* Drop RTS and DTR */
74ede0ff 2013 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1da177e4
LT		 2014 } else {
2015 /* set the baudrate determined before */
2016 if (change_speed(port)) {
72a755fc
PF		 2017 err("%s urb failed to set baudrate", __FUNCTION__);
2018 }
2019 /* Ensure RTS and DTR are raised when baudrate changed from 0 */
57845bd1 2020 if (!old_termios || (old_termios->c_cflag & CBAUD) == B0) {
72a755fc 2021 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1da177e4 2022 }
1da177e4
LT		 2023 }
2024
2025 /* Set flow control */
2026 /* Note device also supports DTR/CD (ugh) and Xon/Xoff in hardware */
2027 if (cflag & CRTSCTS) {
2028 dbg("%s Setting to CRTSCTS flow control", __FUNCTION__);
5c09d144 2029 if (usb_control_msg(dev,
1da177e4 2030 usb_sndctrlpipe(dev, 0),
5c09d144 2031 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1da177e4
LT		 2032 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2033 0 , (FTDI_SIO_RTS_CTS_HS | priv->interface),
2034 buf, 0, WDR_TIMEOUT) < 0) {
2035 err("urb failed to set to rts/cts flow control");
5c09d144
DB		 2036 }
2037
2038 } else {
1da177e4
LT		 2039 /*
2040 * Xon/Xoff code
2041 *
2042 * Check the IXOFF status in the iflag component of the termios structure
2043 * if IXOFF is not set, the pre-xon/xoff code is executed.
2044 */
2045 if (iflag & IXOFF) {
2046 dbg("%s request to enable xonxoff iflag=%04x",__FUNCTION__,iflag);
2047 // Try to enable the XON/XOFF on the ftdi_sio
2048 // Set the vstart and vstop -- could have been done up above where
2049 // a lot of other dereferencing is done but that would be very
2050 // inefficient as vstart and vstop are not always needed
2051 vstart=port->tty->termios->c_cc[VSTART];
2052 vstop=port->tty->termios->c_cc[VSTOP];
2053 urb_value=(vstop << 8) | (vstart);
2054
2055 if (usb_control_msg(dev,
2056 usb_sndctrlpipe(dev, 0),
2057 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2058 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2059 urb_value , (FTDI_SIO_XON_XOFF_HS
2060 | priv->interface),
2061 buf, 0, WDR_TIMEOUT) < 0) {
2062 err("urb failed to set to xon/xoff flow control");
2063 }
2064 } else {
2065 /* else clause to only run if cfag ! CRTSCTS and iflag ! XOFF */
2066 /* CHECKME Assuming XON/XOFF handled by tty stack - not by device */
2067 dbg("%s Turning off hardware flow control", __FUNCTION__);
5c09d144 2068 if (usb_control_msg(dev,
1da177e4 2069 usb_sndctrlpipe(dev, 0),
5c09d144 2070 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1da177e4 2071 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
5c09d144 2072 0, priv->interface,
1da177e4
LT		 2073 buf, 0, WDR_TIMEOUT) < 0) {
2074 err("urb failed to clear flow control");
5c09d144 2075 }
1da177e4 2076 }
5c09d144 2077
1da177e4
LT		 2078 }
2079 return;
2080} /* ftdi_termios */
2081
2082
2083static int ftdi_tiocmget (struct usb_serial_port *port, struct file *file)
2084{
2085 struct ftdi_private *priv = usb_get_serial_port_data(port);
2086 unsigned char buf[2];
2087 int ret;
2088
2089 dbg("%s TIOCMGET", __FUNCTION__);
2090 switch (priv->chip_type) {
2091 case SIO:
2092 /* Request the status from the device */
5c09d144 2093 if ((ret = usb_control_msg(port->serial->dev,
1da177e4 2094 usb_rcvctrlpipe(port->serial->dev, 0),
5c09d144 2095 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
1da177e4 2096 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
5c09d144 2097 0, 0,
1da177e4
LT		 2098 buf, 1, WDR_TIMEOUT)) < 0 ) {
2099 err("%s Could not get modem status of device - err: %d", __FUNCTION__,
2100 ret);
2101 return(ret);
2102 }
2103 break;
2104 case FT8U232AM:
2105 case FT232BM:
2106 case FT2232C:
ed6e5282 2107 case FT232RL:
1da177e4
LT		 2108 /* the 8U232AM returns a two byte value (the sio is a 1 byte value) - in the same
2109 format as the data returned from the in point */
5c09d144 2110 if ((ret = usb_control_msg(port->serial->dev,
1da177e4 2111 usb_rcvctrlpipe(port->serial->dev, 0),
5c09d144 2112 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
1da177e4 2113 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
5c09d144 2114 0, priv->interface,
1da177e4
LT		 2115 buf, 2, WDR_TIMEOUT)) < 0 ) {
2116 err("%s Could not get modem status of device - err: %d", __FUNCTION__,
2117 ret);
2118 return(ret);
2119 }
2120 break;
2121 default:
2122 return -EFAULT;
2123 break;
2124 }
5c09d144 2125
1da177e4
LT		 2126 return (buf[0] & FTDI_SIO_DSR_MASK ? TIOCM_DSR : 0) |
2127 (buf[0] & FTDI_SIO_CTS_MASK ? TIOCM_CTS : 0) |
2128 (buf[0] & FTDI_SIO_RI_MASK ? TIOCM_RI : 0) |
2129 (buf[0] & FTDI_SIO_RLSD_MASK ? TIOCM_CD : 0) |
5c09d144 2130 priv->last_dtr_rts;
1da177e4
LT		 2131}
2132
2133static int ftdi_tiocmset(struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear)
2134{
1da177e4 2135 dbg("%s TIOCMSET", __FUNCTION__);
74ede0ff 2136 return update_mctrl(port, set, clear);
1da177e4
LT		 2137}
2138
2139
2140static int ftdi_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
2141{
2142 struct ftdi_private *priv = usb_get_serial_port_data(port);
2143
1da177e4
LT		 2144 dbg("%s cmd 0x%04x", __FUNCTION__, cmd);
2145
2146 /* Based on code from acm.c and others */
2147 switch (cmd) {
2148
1da177e4
LT		 2149 case TIOCGSERIAL: /* gets serial port data */
2150 return get_serial_info(port, (struct serial_struct __user *) arg);
2151
2152 case TIOCSSERIAL: /* sets serial port data */
2153 return set_serial_info(port, (struct serial_struct __user *) arg);
2154
2155 /*
2156 * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
2157 * - mask passed in arg for lines of interest
2158 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
2159 * Caller should use TIOCGICOUNT to see which one it was.
2160 *
2161 * This code is borrowed from linux/drivers/char/serial.c
2162 */
2163 case TIOCMIWAIT:
2164 while (priv != NULL) {
2165 interruptible_sleep_on(&priv->delta_msr_wait);
2166 /* see if a signal did it */
2167 if (signal_pending(current))
2168 return -ERESTARTSYS;
2169 else {
2170 char diff = priv->diff_status;
2171
2172 if (diff == 0) {
2173 return -EIO; /* no change => error */
2174 }
2175
2176 /* Consume all events */
2177 priv->diff_status = 0;
2178
2179 /* Return 0 if caller wanted to know about these bits */
2180 if ( ((arg & TIOCM_RNG) && (diff & FTDI_RS0_RI)) ||
2181 ((arg & TIOCM_DSR) && (diff & FTDI_RS0_DSR)) ||
2182 ((arg & TIOCM_CD) && (diff & FTDI_RS0_RLSD)) ||
2183 ((arg & TIOCM_CTS) && (diff & FTDI_RS0_CTS)) ) {
2184 return 0;
2185 }
2186 /*
2187 * Otherwise caller can't care less about what happened,
2188 * and so we continue to wait for more events.
2189 */
2190 }
2191 }
2192 return(0);
2193 break;
2194 default:
2195 break;
5c09d144 2196
1da177e4
LT		 2197 }
2198
2199
5c09d144 2200 /* This is not necessarily an error - turns out the higher layers will do
1da177e4
LT		 2201 * some ioctls itself (see comment above)
2202 */
2203 dbg("%s arg not supported - it was 0x%04x - check /usr/include/asm/ioctls.h", __FUNCTION__, cmd);
2204
2205 return(-ENOIOCTLCMD);
2206} /* ftdi_ioctl */
2207
2208
2209static void ftdi_throttle (struct usb_serial_port *port)
2210{
2211 struct ftdi_private *priv = usb_get_serial_port_data(port);
2212 unsigned long flags;
2213
2214 dbg("%s - port %d", __FUNCTION__, port->number);
2215
2216 spin_lock_irqsave(&priv->rx_lock, flags);
2217 priv->rx_flags |= THROTTLED;
2218 spin_unlock_irqrestore(&priv->rx_lock, flags);
2219}
2220
2221
2222static void ftdi_unthrottle (struct usb_serial_port *port)
2223{
2224 struct ftdi_private *priv = usb_get_serial_port_data(port);
2225 int actually_throttled;
2226 unsigned long flags;
2227
2228 dbg("%s - port %d", __FUNCTION__, port->number);
2229
2230 spin_lock_irqsave(&priv->rx_lock, flags);
2231 actually_throttled = priv->rx_flags & ACTUALLY_THROTTLED;
2232 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
2233 spin_unlock_irqrestore(&priv->rx_lock, flags);
2234
2235 if (actually_throttled)
c4028958 2236 schedule_delayed_work(&priv->rx_work, 0);
1da177e4
LT		 2237}
2238
2239static int __init ftdi_init (void)
2240{
2241 int retval;
2242
2243 dbg("%s", __FUNCTION__);
fdcb0a0f
IA		 2244 if (vendor > 0 && product > 0) {
2245 /* Add user specified VID/PID to reserved element of table. */
2246 int i;
2247 for (i = 0; id_table_combined[i].idVendor; i++)
2248 ;
2249 id_table_combined[i].match_flags = USB_DEVICE_ID_MATCH_DEVICE;
2250 id_table_combined[i].idVendor = vendor;
2251 id_table_combined[i].idProduct = product;
2252 }
8f977e42 2253 retval = usb_serial_register(&ftdi_sio_device);
1da177e4 2254 if (retval)
8f977e42 2255 goto failed_sio_register;
1da177e4 2256 retval = usb_register(&ftdi_driver);
5c09d144 2257 if (retval)
1da177e4
LT		 2258 goto failed_usb_register;
2259
2260 info(DRIVER_VERSION ":" DRIVER_DESC);
2261 return 0;
2262failed_usb_register:
8f977e42
IA		 2263 usb_serial_deregister(&ftdi_sio_device);
2264failed_sio_register:
1da177e4
LT		 2265 return retval;
2266}
2267
2268
2269static void __exit ftdi_exit (void)
2270{
2271
2272 dbg("%s", __FUNCTION__);
2273
2274 usb_deregister (&ftdi_driver);
8f977e42 2275 usb_serial_deregister (&ftdi_sio_device);
1da177e4
LT		 2276
2277}
2278
2279
2280module_init(ftdi_init);
2281module_exit(ftdi_exit);
2282
2283MODULE_AUTHOR( DRIVER_AUTHOR );
2284MODULE_DESCRIPTION( DRIVER_DESC );
2285MODULE_LICENSE("GPL");
2286
2287module_param(debug, bool, S_IRUGO | S_IWUSR);
2288MODULE_PARM_DESC(debug, "Debug enabled or not");
fdcb0a0f
IA		 2289module_param(vendor, ushort, 0);
2290MODULE_PARM_DESC(vendor, "User specified vendor ID (default="
2291 __MODULE_STRING(FTDI_VID)")");
2292module_param(product, ushort, 0);
2293MODULE_PARM_DESC(vendor, "User specified product ID");
1da177e4 2294
Arne's tree of linux kernel.