blob: f5851db67f5be87b2f37a69afd3feeb54fc93fbf [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * USB FTDI SIO driver
3 *
4 * Copyright (C) 1999 - 2001
5 * Greg Kroah-Hartman (greg@kroah.com)
6 * Bill Ryder (bryder@sgi.com)
7 * Copyright (C) 2002
8 * Kuba Ober (kuba@mareimbrium.org)
9 *
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.
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.
35 *
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.
72 *
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
Steven Cole093cf722005-05-03 19:07:24 -060079 * Added support for Home Electronics Tira-1 IR transceiver using FT232BM chip.
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 * See <http://www.home-electro.com/tira1.htm>. Only operates properly
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
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)
140 * Added CrystalFontz 632 and 634 PIDs
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
147 *
148 *
149 *
150 *
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.
161 *
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.
182 *
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.
191 *
192 * (04/08/2001) gb
193 * Identify version on module load.
194 *
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
200 *
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
214 *
215 * (11/01/2000) Adam J. Richter
216 * usb_device_id table support
217 *
218 * (10/05/2000) gkh
219 * Fixed bug with urb->dev not being set properly, now that the usb
220 * core needs it.
221 *
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 *
229 * (04/04/2000) Bill Ryder
230 * Fixed bugs in TCGET/TCSET ioctls (by removing them - they are
231 * handled elsewhere in the tty io driver chain).
232 *
233 * (03/30/2000) Bill Ryder
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
248#include <linux/config.h>
249#include <linux/kernel.h>
250#include <linux/errno.h>
251#include <linux/init.h>
252#include <linux/slab.h>
253#include <linux/tty.h>
254#include <linux/tty_driver.h>
255#include <linux/tty_flip.h>
256#include <linux/module.h>
257#include <linux/spinlock.h>
258#include <asm/uaccess.h>
259#include <linux/usb.h>
260#include <linux/serial.h>
261#include "usb-serial.h"
262#include "ftdi_sio.h"
263
264/*
265 * Version Information
266 */
Ian Abbott8f977e42005-06-20 16:45:42 +0100267#define DRIVER_VERSION "v1.4.3"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268#define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>, Bill Ryder <bryder@sgi.com>, Kuba Ober <kuba@mareimbrium.org>"
269#define DRIVER_DESC "USB FTDI Serial Converters Driver"
270
271static int debug;
Ian Abbottfdcb0a02005-07-28 18:40:32 +0100272static __u16 vendor = FTDI_VID;
273static __u16 product;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274
Ian Abbott8f977e42005-06-20 16:45:42 +0100275/* struct ftdi_sio_quirk is used by devices requiring special attention. */
276struct ftdi_sio_quirk {
277 void (*setup)(struct usb_serial *); /* Special settings during startup. */
278};
279
280static void ftdi_USB_UIRT_setup (struct usb_serial *serial);
281static void ftdi_HE_TIRA1_setup (struct usb_serial *serial);
282
283static struct ftdi_sio_quirk ftdi_USB_UIRT_quirk = {
284 .setup = ftdi_USB_UIRT_setup,
285};
286
287static struct ftdi_sio_quirk ftdi_HE_TIRA1_quirk = {
288 .setup = ftdi_HE_TIRA1_setup,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289};
290
291/*
292 * The 8U232AM has the same API as the sio except for:
293 * - it can support MUCH higher baudrates; up to:
294 * o 921600 for RS232 and 2000000 for RS422/485 at 48MHz
295 * o 230400 at 12MHz
296 * so .. 8U232AM's baudrate setting codes are different
297 * - it has a two byte status code.
298 * - it returns characters every 16ms (the FTDI does it every 40ms)
299 *
300 * the bcdDevice value is used to differentiate FT232BM and FT245BM from
301 * the earlier FT8U232AM and FT8U232BM. For now, include all known VID/PID
302 * combinations in both tables.
Ian Abbott8f977e42005-06-20 16:45:42 +0100303 * FIXME: perhaps bcdDevice can also identify 12MHz FT8U232AM devices,
304 * but I don't know if those ever went into mass production. [Ian Abbott]
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 */
306
307
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308
309static struct usb_device_id id_table_combined [] = {
310 { USB_DEVICE(FTDI_VID, FTDI_IRTRANS_PID) },
311 { USB_DEVICE(FTDI_VID, FTDI_SIO_PID) },
312 { USB_DEVICE(FTDI_VID, FTDI_8U232AM_PID) },
313 { USB_DEVICE(FTDI_VID, FTDI_8U232AM_ALT_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 { USB_DEVICE(FTDI_VID, FTDI_8U2232C_PID) },
315 { USB_DEVICE(FTDI_VID, FTDI_RELAIS_PID) },
316 { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_IOBOARD_PID) },
317 { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_MINI_IOBOARD_PID) },
318 { USB_DEVICE(FTDI_VID, FTDI_XF_632_PID) },
319 { USB_DEVICE(FTDI_VID, FTDI_XF_634_PID) },
320 { USB_DEVICE(FTDI_VID, FTDI_XF_547_PID) },
321 { USB_DEVICE(FTDI_VID, FTDI_XF_633_PID) },
322 { USB_DEVICE(FTDI_VID, FTDI_XF_631_PID) },
323 { USB_DEVICE(FTDI_VID, FTDI_XF_635_PID) },
324 { USB_DEVICE(FTDI_VID, FTDI_XF_640_PID) },
325 { USB_DEVICE(FTDI_VID, FTDI_XF_642_PID) },
326 { USB_DEVICE(FTDI_VID, FTDI_DSS20_PID) },
327 { USB_DEVICE(FTDI_NF_RIC_VID, FTDI_NF_RIC_PID) },
328 { USB_DEVICE(FTDI_VID, FTDI_VNHCPCUSB_D_PID) },
Ian Abbott8f977e42005-06-20 16:45:42 +0100329 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_0_PID) },
330 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_1_PID) },
331 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_2_PID) },
332 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_3_PID) },
333 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_4_PID) },
334 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_5_PID) },
335 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_6_PID) },
336 { USB_DEVICE(FTDI_VID, FTDI_PERLE_ULTRAPORT_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 { USB_DEVICE(FTDI_VID, FTDI_PIEGROUP_PID) },
338 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2101_PID) },
339 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2102_PID) },
340 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2103_PID) },
341 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2104_PID) },
342 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_1_PID) },
343 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_2_PID) },
344 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_1_PID) },
345 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_2_PID) },
346 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_1_PID) },
347 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_2_PID) },
348 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_1_PID) },
349 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_2_PID) },
350 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_3_PID) },
351 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_4_PID) },
352 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_1_PID) },
353 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_2_PID) },
354 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_3_PID) },
355 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_4_PID) },
356 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_1_PID) },
357 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_2_PID) },
358 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_3_PID) },
359 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_4_PID) },
360 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_1_PID) },
361 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_2_PID) },
362 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_3_PID) },
363 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_4_PID) },
364 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_5_PID) },
365 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_6_PID) },
366 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_7_PID) },
367 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_8_PID) },
368 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_1_PID) },
369 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_2_PID) },
370 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_3_PID) },
371 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_4_PID) },
372 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_5_PID) },
373 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_6_PID) },
374 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_7_PID) },
375 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_8_PID) },
376 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_1_PID) },
377 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_2_PID) },
378 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_3_PID) },
379 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_4_PID) },
380 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_5_PID) },
381 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_6_PID) },
382 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_7_PID) },
383 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_8_PID) },
384 { USB_DEVICE(IDTECH_VID, IDTECH_IDT1221U_PID) },
385 { USB_DEVICE(OCT_VID, OCT_US101_PID) },
Ian Abbott8f977e42005-06-20 16:45:42 +0100386 { USB_DEVICE(FTDI_VID, FTDI_HE_TIRA1_PID),
387 .driver_info = (kernel_ulong_t)&ftdi_HE_TIRA1_quirk },
388 { USB_DEVICE(FTDI_VID, FTDI_USB_UIRT_PID),
389 .driver_info = (kernel_ulong_t)&ftdi_USB_UIRT_quirk },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_1) },
391 { USB_DEVICE(FTDI_VID, PROTEGO_R2X0) },
392 { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_3) },
393 { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_4) },
Ian Abbott8f977e42005-06-20 16:45:42 +0100394 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E808_PID) },
395 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E809_PID) },
396 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80A_PID) },
397 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80B_PID) },
398 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80C_PID) },
399 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80D_PID) },
400 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80E_PID) },
401 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80F_PID) },
402 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E888_PID) },
403 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E889_PID) },
404 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88A_PID) },
405 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88B_PID) },
406 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88C_PID) },
407 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88D_PID) },
408 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88E_PID) },
409 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88F_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 { USB_DEVICE(FTDI_VID, FTDI_ELV_UO100_PID) },
Ian Abbott47900742005-05-17 15:12:13 +0100411 { USB_DEVICE(FTDI_VID, FTDI_ELV_UM100_PID) },
Ian Abbotte6ac4a42005-08-02 14:01:27 +0100412 { USB_DEVICE(FTDI_VID, FTDI_ELV_UR100_PID) },
413 { USB_DEVICE(FTDI_VID, FTDI_ELV_ALC8500_PID) },
Thomas Riewe207c47e2005-09-29 14:57:29 +0200414 { USB_DEVICE(FTDI_VID, FTDI_PYRAMID_PID) },
Martin Hagelinbde62182005-10-26 21:10:41 +0200415 { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1000PC_PID) },
Ian Abbotte6ac4a42005-08-02 14:01:27 +0100416 /*
417 * These will probably use user-space drivers. Uncomment them if
418 * you need them or use the user-specified vendor/product module
419 * parameters (see ftdi_sio.h for the numbers). Make a fuss if
420 * you think the driver should recognize any of them by default.
421 */
422 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_CLI7000_PID) }, */
423 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_PPS7330_PID) }, */
424 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_TFM100_PID) }, */
425 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UDF77_PID) }, */
426 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UIO88_PID) }, */
427 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UAD8_PID) }, */
428 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UDA7_PID) }, */
429 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_USI2_PID) }, */
430 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_T1100_PID) }, */
431 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_PCD200_PID) }, */
432 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_ULA200_PID) }, */
Ian Abbotte6ac4a42005-08-02 14:01:27 +0100433 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_CSI8_PID) }, */
434 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_EM1000DL_PID) }, */
435 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_PCK100_PID) }, */
436 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_RFP500_PID) }, */
437 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_FS20SIG_PID) }, */
438 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_WS300PC_PID) }, */
439 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1300PC_PID) }, */
440 /* { USB_DEVICE(FTDI_VID, FTDI_ELV_WS500_PID) }, */
Ian Abbott8f977e42005-06-20 16:45:42 +0100441 { USB_DEVICE(FTDI_VID, LINX_SDMUSBQSS_PID) },
442 { USB_DEVICE(FTDI_VID, LINX_MASTERDEVEL2_PID) },
443 { USB_DEVICE(FTDI_VID, LINX_FUTURE_0_PID) },
444 { USB_DEVICE(FTDI_VID, LINX_FUTURE_1_PID) },
445 { USB_DEVICE(FTDI_VID, LINX_FUTURE_2_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 { USB_DEVICE(FTDI_VID, FTDI_CCSICDU20_0_PID) },
447 { USB_DEVICE(FTDI_VID, FTDI_CCSICDU40_1_PID) },
448 { USB_DEVICE(FTDI_VID, INSIDE_ACCESSO) },
449 { USB_DEVICE(INTREPID_VID, INTREPID_VALUECAN_PID) },
450 { USB_DEVICE(INTREPID_VID, INTREPID_NEOVI_PID) },
451 { USB_DEVICE(FALCOM_VID, FALCOM_TWIST_PID) },
Ian Abbotte6ac4a42005-08-02 14:01:27 +0100452 { USB_DEVICE(FALCOM_VID, FALCOM_SAMBA_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 { USB_DEVICE(FTDI_VID, FTDI_SUUNTO_SPORTS_PID) },
Ian Abbott6f928722005-04-29 16:06:14 +0100454 { USB_DEVICE(FTDI_VID, FTDI_RM_CANVIEW_PID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 { USB_DEVICE(BANDB_VID, BANDB_USOTL4_PID) },
456 { USB_DEVICE(BANDB_VID, BANDB_USTL4_PID) },
457 { USB_DEVICE(BANDB_VID, BANDB_USO9ML2_PID) },
458 { USB_DEVICE(FTDI_VID, EVER_ECO_PRO_CDS) },
Ian Abbott6f928722005-04-29 16:06:14 +0100459 { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_0_PID) },
460 { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_1_PID) },
461 { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_2_PID) },
Ian Abbotte6ac4a42005-08-02 14:01:27 +0100462 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_0_PID) },
463 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_1_PID) },
464 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_2_PID) },
465 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_3_PID) },
466 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_4_PID) },
467 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_5_PID) },
468 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_6_PID) },
469 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_7_PID) },
Ian Abbott6f928722005-04-29 16:06:14 +0100470 { USB_DEVICE(MOBILITY_VID, MOBILITY_USB_SERIAL_PID) },
Ian Abbott8f977e42005-06-20 16:45:42 +0100471 { USB_DEVICE(FTDI_VID, FTDI_ACTIVE_ROBOTS_PID) },
Ian Abbott34d1a8a2006-02-27 14:05:32 +0000472 { USB_DEVICE(FTDI_VID, FTDI_MHAM_KW_PID) },
473 { USB_DEVICE(FTDI_VID, FTDI_MHAM_YS_PID) },
Ian Abbott9b1513d2005-07-29 12:16:31 -0700474 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y6_PID) },
475 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y8_PID) },
Ian Abbott34d1a8a2006-02-27 14:05:32 +0000476 { USB_DEVICE(FTDI_VID, FTDI_MHAM_IC_PID) },
477 { USB_DEVICE(FTDI_VID, FTDI_MHAM_DB9_PID) },
478 { USB_DEVICE(FTDI_VID, FTDI_MHAM_RS232_PID) },
479 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y9_PID) },
Ian Abbott740a4282005-12-13 16:18:47 +0000480 { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_VCP_PID) },
481 { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_D2XX_PID) },
Ian Abbott9b1513d2005-07-29 12:16:31 -0700482 { USB_DEVICE(EVOLUTION_VID, EVOLUTION_ER1_PID) },
Rui Santosc9c77462005-09-23 20:06:50 +0100483 { USB_DEVICE(FTDI_VID, FTDI_ARTEMIS_PID) },
484 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16_PID) },
Rui Santos09c280a2006-01-09 13:12:40 +0000485 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16C_PID) },
Rui Santosc9c77462005-09-23 20:06:50 +0100486 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HR_PID) },
Rui Santos09c280a2006-01-09 13:12:40 +0000487 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HRC_PID) },
Ian Abbottb4723ae2005-11-23 15:45:23 -0800488 { USB_DEVICE(KOBIL_VID, KOBIL_CONV_B1_PID) },
489 { USB_DEVICE(KOBIL_VID, KOBIL_CONV_KAAN_PID) },
Pavel Fedineffac8b2005-12-09 09:30:59 +0300490 { USB_DEVICE(POSIFLEX_VID, POSIFLEX_PP7000_PID) },
Louis Nyffenegger641adaa2006-01-05 17:20:37 +0100491 { USB_DEVICE(FTDI_VID, FTDI_TTUSB_PID) },
Ian Abbott7e1c0b82006-03-21 14:55:20 +0000492 { USB_DEVICE(FTDI_VID, FTDI_ECLO_COM_1WIRE_PID) },
Ian Abbotta94b52a2006-01-09 17:11:40 +0000493 { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_777_PID) },
494 { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_8900F_PID) },
Wouter Paesence40d292006-01-03 14:30:31 +0100495 { USB_DEVICE(FTDI_VID, FTDI_PCDJ_DAC2_PID) },
A. Maitland Bottomsbf58fbd2006-03-14 18:44:23 -0500496 { USB_DEVICE(ICOM_ID1_VID, ICOM_ID1_PID) },
Folkert van Heusden62a13db2006-03-28 20:41:26 +0900497 { USB_DEVICE(PAPOUCH_VID, PAPOUCH_TMU_PID) },
Ian Abbottfdcb0a02005-07-28 18:40:32 +0100498 { }, /* Optional parameter entry */
499 { } /* Terminating entry */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500};
501
502MODULE_DEVICE_TABLE (usb, id_table_combined);
503
504static struct usb_driver ftdi_driver = {
505 .name = "ftdi_sio",
506 .probe = usb_serial_probe,
507 .disconnect = usb_serial_disconnect,
508 .id_table = id_table_combined,
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800509 .no_dynamic_id = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510};
511
Arjan van de Ven4c4c9432005-11-29 09:43:42 +0100512static const char *ftdi_chip_name[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 [SIO] = "SIO", /* the serial part of FT8U100AX */
514 [FT8U232AM] = "FT8U232AM",
515 [FT232BM] = "FT232BM",
516 [FT2232C] = "FT2232C",
517};
518
519
520/* Constants for read urb and write urb */
521#define BUFSZ 512
522#define PKTSZ 64
523
524/* rx_flags */
525#define THROTTLED 0x01
526#define ACTUALLY_THROTTLED 0x02
527
528struct ftdi_private {
529 ftdi_chip_type_t chip_type;
530 /* type of the device, either SIO or FT8U232AM */
531 int baud_base; /* baud base clock for divisor setting */
532 int custom_divisor; /* custom_divisor kludge, this is for baud_base (different from what goes to the chip!) */
533 __u16 last_set_data_urb_value ;
534 /* the last data state set - needed for doing a break */
535 int write_offset; /* This is the offset in the usb data block to write the serial data -
536 * it is different between devices
537 */
538 int flags; /* some ASYNC_xxxx flags are supported */
539 unsigned long last_dtr_rts; /* saved modem control outputs */
540 wait_queue_head_t delta_msr_wait; /* Used for TIOCMIWAIT */
541 char prev_status, diff_status; /* Used for TIOCMIWAIT */
542 __u8 rx_flags; /* receive state flags (throttling) */
543 spinlock_t rx_lock; /* spinlock for receive state */
Ian Abbott76854ce2005-06-02 10:34:11 +0100544 struct work_struct rx_work;
545 int rx_processed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546
547 __u16 interface; /* FT2232C port interface (0 for FT232/245) */
548
549 int force_baud; /* if non-zero, force the baud rate to this value */
550 int force_rtscts; /* if non-zero, force RTS-CTS to always be enabled */
551};
552
553/* Used for TIOCMIWAIT */
554#define FTDI_STATUS_B0_MASK (FTDI_RS0_CTS | FTDI_RS0_DSR | FTDI_RS0_RI | FTDI_RS0_RLSD)
555#define FTDI_STATUS_B1_MASK (FTDI_RS_BI)
556/* End TIOCMIWAIT */
557
558#define FTDI_IMPL_ASYNC_FLAGS = ( ASYNC_SPD_HI | ASYNC_SPD_VHI \
559 ASYNC_SPD_CUST | ASYNC_SPD_SHI | ASYNC_SPD_WARP )
560
561/* function prototypes for a FTDI serial converter */
Ian Abbott8f977e42005-06-20 16:45:42 +0100562static int ftdi_sio_probe (struct usb_serial *serial, const struct usb_device_id *id);
563static int ftdi_sio_attach (struct usb_serial *serial);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564static void ftdi_shutdown (struct usb_serial *serial);
565static int ftdi_open (struct usb_serial_port *port, struct file *filp);
566static void ftdi_close (struct usb_serial_port *port, struct file *filp);
567static int ftdi_write (struct usb_serial_port *port, const unsigned char *buf, int count);
568static int ftdi_write_room (struct usb_serial_port *port);
569static int ftdi_chars_in_buffer (struct usb_serial_port *port);
570static void ftdi_write_bulk_callback (struct urb *urb, struct pt_regs *regs);
571static void ftdi_read_bulk_callback (struct urb *urb, struct pt_regs *regs);
Ian Abbott76854ce2005-06-02 10:34:11 +0100572static void ftdi_process_read (void *param);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573static void ftdi_set_termios (struct usb_serial_port *port, struct termios * old);
574static int ftdi_tiocmget (struct usb_serial_port *port, struct file *file);
575static int ftdi_tiocmset (struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear);
576static int ftdi_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg);
577static void ftdi_break_ctl (struct usb_serial_port *port, int break_state );
578static void ftdi_throttle (struct usb_serial_port *port);
579static void ftdi_unthrottle (struct usb_serial_port *port);
580
581static unsigned short int ftdi_232am_baud_base_to_divisor (int baud, int base);
582static unsigned short int ftdi_232am_baud_to_divisor (int baud);
583static __u32 ftdi_232bm_baud_base_to_divisor (int baud, int base);
584static __u32 ftdi_232bm_baud_to_divisor (int baud);
585
Greg Kroah-Hartmanea653702005-06-20 21:15:16 -0700586static struct usb_serial_driver ftdi_sio_device = {
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700587 .driver = {
588 .owner = THIS_MODULE,
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700589 .name = "ftdi_sio",
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700590 },
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700591 .description = "FTDI USB Serial Device",
Ian Abbott8f977e42005-06-20 16:45:42 +0100592 .id_table = id_table_combined,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 .num_interrupt_in = 0,
594 .num_bulk_in = 1,
595 .num_bulk_out = 1,
596 .num_ports = 1,
Ian Abbott8f977e42005-06-20 16:45:42 +0100597 .probe = ftdi_sio_probe,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 .open = ftdi_open,
599 .close = ftdi_close,
600 .throttle = ftdi_throttle,
601 .unthrottle = ftdi_unthrottle,
602 .write = ftdi_write,
603 .write_room = ftdi_write_room,
604 .chars_in_buffer = ftdi_chars_in_buffer,
605 .read_bulk_callback = ftdi_read_bulk_callback,
606 .write_bulk_callback = ftdi_write_bulk_callback,
607 .tiocmget = ftdi_tiocmget,
608 .tiocmset = ftdi_tiocmset,
609 .ioctl = ftdi_ioctl,
610 .set_termios = ftdi_set_termios,
611 .break_ctl = ftdi_break_ctl,
Ian Abbott8f977e42005-06-20 16:45:42 +0100612 .attach = ftdi_sio_attach,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 .shutdown = ftdi_shutdown,
614};
615
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616
617#define WDR_TIMEOUT 5000 /* default urb timeout */
Ian Abbott279e1542005-07-29 12:16:52 -0700618#define WDR_SHORT_TIMEOUT 1000 /* shorter urb timeout */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619
620/* High and low are for DTR, RTS etc etc */
621#define HIGH 1
622#define LOW 0
623
624/*
625 * ***************************************************************************
626 * Utlity functions
627 * ***************************************************************************
628 */
629
630static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base)
631{
632 unsigned short int divisor;
633 int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
634 if ((divisor3 & 0x7) == 7) divisor3 ++; // round x.7/8 up to x+1
635 divisor = divisor3 >> 3;
636 divisor3 &= 0x7;
637 if (divisor3 == 1) divisor |= 0xc000; else // 0.125
638 if (divisor3 >= 4) divisor |= 0x4000; else // 0.5
639 if (divisor3 != 0) divisor |= 0x8000; // 0.25
640 if (divisor == 1) divisor = 0; /* special case for maximum baud rate */
641 return divisor;
642}
643
644static unsigned short int ftdi_232am_baud_to_divisor(int baud)
645{
646 return(ftdi_232am_baud_base_to_divisor(baud, 48000000));
647}
648
649static __u32 ftdi_232bm_baud_base_to_divisor(int baud, int base)
650{
651 static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
652 __u32 divisor;
653 int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
654 divisor = divisor3 >> 3;
655 divisor |= (__u32)divfrac[divisor3 & 0x7] << 14;
656 /* Deal with special cases for highest baud rates. */
657 if (divisor == 1) divisor = 0; else // 1.0
658 if (divisor == 0x4001) divisor = 1; // 1.5
659 return divisor;
660}
661
662static __u32 ftdi_232bm_baud_to_divisor(int baud)
663{
664 return(ftdi_232bm_baud_base_to_divisor(baud, 48000000));
665}
666
Ian Abbott74ede0f2005-07-29 12:16:41 -0700667#define set_mctrl(port, set) update_mctrl((port), (set), 0)
668#define clear_mctrl(port, clear) update_mctrl((port), 0, (clear))
669
670static int update_mctrl(struct usb_serial_port *port, unsigned int set, unsigned int clear)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671{
672 struct ftdi_private *priv = usb_get_serial_port_data(port);
673 char *buf;
Ian Abbott74ede0f2005-07-29 12:16:41 -0700674 unsigned urb_value;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 int rv;
Ian Abbott74ede0f2005-07-29 12:16:41 -0700676
677 if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
678 dbg("%s - DTR|RTS not being set|cleared", __FUNCTION__);
679 return 0; /* no change */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 }
Ian Abbott74ede0f2005-07-29 12:16:41 -0700681
682 buf = kmalloc(1, GFP_NOIO);
683 if (!buf) {
684 return -ENOMEM;
685 }
686
687 clear &= ~set; /* 'set' takes precedence over 'clear' */
688 urb_value = 0;
689 if (clear & TIOCM_DTR)
690 urb_value |= FTDI_SIO_SET_DTR_LOW;
691 if (clear & TIOCM_RTS)
692 urb_value |= FTDI_SIO_SET_RTS_LOW;
693 if (set & TIOCM_DTR)
694 urb_value |= FTDI_SIO_SET_DTR_HIGH;
695 if (set & TIOCM_RTS)
696 urb_value |= FTDI_SIO_SET_RTS_HIGH;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 rv = usb_control_msg(port->serial->dev,
698 usb_sndctrlpipe(port->serial->dev, 0),
699 FTDI_SIO_SET_MODEM_CTRL_REQUEST,
700 FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE,
Ian Abbott74ede0f2005-07-29 12:16:41 -0700701 urb_value, priv->interface,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 buf, 0, WDR_TIMEOUT);
703
704 kfree(buf);
Ian Abbott74ede0f2005-07-29 12:16:41 -0700705 if (rv < 0) {
706 err("%s Error from MODEM_CTRL urb: DTR %s, RTS %s",
707 __FUNCTION__,
708 (set & TIOCM_DTR) ? "HIGH" :
709 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
710 (set & TIOCM_RTS) ? "HIGH" :
711 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 } else {
Ian Abbott74ede0f2005-07-29 12:16:41 -0700713 dbg("%s - DTR %s, RTS %s", __FUNCTION__,
714 (set & TIOCM_DTR) ? "HIGH" :
715 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
716 (set & TIOCM_RTS) ? "HIGH" :
717 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
718 priv->last_dtr_rts = (priv->last_dtr_rts & ~clear) | set;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 return rv;
721}
722
723
724static __u32 get_ftdi_divisor(struct usb_serial_port * port);
725
726
727static int change_speed(struct usb_serial_port *port)
728{
729 struct ftdi_private *priv = usb_get_serial_port_data(port);
730 char *buf;
731 __u16 urb_value;
732 __u16 urb_index;
733 __u32 urb_index_value;
734 int rv;
735
736 buf = kmalloc(1, GFP_NOIO);
737 if (!buf)
738 return -ENOMEM;
739
740 urb_index_value = get_ftdi_divisor(port);
741 urb_value = (__u16)urb_index_value;
742 urb_index = (__u16)(urb_index_value >> 16);
743 if (priv->interface) { /* FT2232C */
744 urb_index = (__u16)((urb_index << 8) | priv->interface);
745 }
746
747 rv = usb_control_msg(port->serial->dev,
748 usb_sndctrlpipe(port->serial->dev, 0),
749 FTDI_SIO_SET_BAUDRATE_REQUEST,
750 FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE,
751 urb_value, urb_index,
Ian Abbott279e1542005-07-29 12:16:52 -0700752 buf, 0, WDR_SHORT_TIMEOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753
754 kfree(buf);
755 return rv;
756}
757
758
759static __u32 get_ftdi_divisor(struct usb_serial_port * port)
760{ /* get_ftdi_divisor */
761 struct ftdi_private *priv = usb_get_serial_port_data(port);
762 __u32 div_value = 0;
763 int div_okay = 1;
764 int baud;
765
766 /*
767 * The logic involved in setting the baudrate can be cleanly split in 3 steps.
768 * Obtaining the actual baud rate is a little tricky since unix traditionally
769 * somehow ignored the possibility to set non-standard baud rates.
770 * 1. Standard baud rates are set in tty->termios->c_cflag
771 * 2. If these are not enough, you can set any speed using alt_speed as follows:
772 * - set tty->termios->c_cflag speed to B38400
773 * - set your real speed in tty->alt_speed; it gets ignored when
774 * alt_speed==0, (or)
775 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
776 * flags & ASYNC_SPD_MASK == ASYNC_SPD_[HI, VHI, SHI, WARP], this just
777 * sets alt_speed to (HI: 57600, VHI: 115200, SHI: 230400, WARP: 460800)
778 * ** Steps 1, 2 are done courtesy of tty_get_baud_rate
779 * 3. You can also set baud rate by setting custom divisor as follows
780 * - set tty->termios->c_cflag speed to B38400
781 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
782 * o flags & ASYNC_SPD_MASK == ASYNC_SPD_CUST
783 * o custom_divisor set to baud_base / your_new_baudrate
784 * ** Step 3 is done courtesy of code borrowed from serial.c - I should really
785 * spend some time and separate+move this common code to serial.c, it is
786 * replicated in nearly every serial driver you see.
787 */
788
789 /* 1. Get the baud rate from the tty settings, this observes alt_speed hack */
790
791 baud = tty_get_baud_rate(port->tty);
792 dbg("%s - tty_get_baud_rate reports speed %d", __FUNCTION__, baud);
793
794 /* 2. Observe async-compatible custom_divisor hack, update baudrate if needed */
795
796 if (baud == 38400 &&
797 ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
798 (priv->custom_divisor)) {
799 baud = priv->baud_base / priv->custom_divisor;
800 dbg("%s - custom divisor %d sets baud rate to %d", __FUNCTION__, priv->custom_divisor, baud);
801 }
802
803 /* 3. Convert baudrate to device-specific divisor */
804
805 if (!baud) baud = 9600;
806 switch(priv->chip_type) {
807 case SIO: /* SIO chip */
808 switch(baud) {
809 case 300: div_value = ftdi_sio_b300; break;
810 case 600: div_value = ftdi_sio_b600; break;
811 case 1200: div_value = ftdi_sio_b1200; break;
812 case 2400: div_value = ftdi_sio_b2400; break;
813 case 4800: div_value = ftdi_sio_b4800; break;
814 case 9600: div_value = ftdi_sio_b9600; break;
815 case 19200: div_value = ftdi_sio_b19200; break;
816 case 38400: div_value = ftdi_sio_b38400; break;
817 case 57600: div_value = ftdi_sio_b57600; break;
818 case 115200: div_value = ftdi_sio_b115200; break;
819 } /* baud */
820 if (div_value == 0) {
821 dbg("%s - Baudrate (%d) requested is not supported", __FUNCTION__, baud);
822 div_value = ftdi_sio_b9600;
823 div_okay = 0;
824 }
825 break;
826 case FT8U232AM: /* 8U232AM chip */
827 if (baud <= 3000000) {
828 div_value = ftdi_232am_baud_to_divisor(baud);
829 } else {
830 dbg("%s - Baud rate too high!", __FUNCTION__);
831 div_value = ftdi_232am_baud_to_divisor(9600);
832 div_okay = 0;
833 }
834 break;
835 case FT232BM: /* FT232BM chip */
836 case FT2232C: /* FT2232C chip */
837 if (baud <= 3000000) {
838 div_value = ftdi_232bm_baud_to_divisor(baud);
839 } else {
840 dbg("%s - Baud rate too high!", __FUNCTION__);
841 div_value = ftdi_232bm_baud_to_divisor(9600);
842 div_okay = 0;
843 }
844 break;
845 } /* priv->chip_type */
846
847 if (div_okay) {
848 dbg("%s - Baud rate set to %d (divisor 0x%lX) on chip %s",
849 __FUNCTION__, baud, (unsigned long)div_value,
850 ftdi_chip_name[priv->chip_type]);
851 }
852
853 return(div_value);
854}
855
856
857static int get_serial_info(struct usb_serial_port * port, struct serial_struct __user * retinfo)
858{
859 struct ftdi_private *priv = usb_get_serial_port_data(port);
860 struct serial_struct tmp;
861
862 if (!retinfo)
863 return -EFAULT;
864 memset(&tmp, 0, sizeof(tmp));
865 tmp.flags = priv->flags;
866 tmp.baud_base = priv->baud_base;
867 tmp.custom_divisor = priv->custom_divisor;
868 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
869 return -EFAULT;
870 return 0;
871} /* get_serial_info */
872
873
874static int set_serial_info(struct usb_serial_port * port, struct serial_struct __user * newinfo)
875{ /* set_serial_info */
876 struct ftdi_private *priv = usb_get_serial_port_data(port);
877 struct serial_struct new_serial;
878 struct ftdi_private old_priv;
879
880 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
881 return -EFAULT;
882 old_priv = * priv;
883
884 /* Do error checking and permission checking */
885
886 if (!capable(CAP_SYS_ADMIN)) {
887 if (((new_serial.flags & ~ASYNC_USR_MASK) !=
888 (priv->flags & ~ASYNC_USR_MASK)))
889 return -EPERM;
890 priv->flags = ((priv->flags & ~ASYNC_USR_MASK) |
891 (new_serial.flags & ASYNC_USR_MASK));
892 priv->custom_divisor = new_serial.custom_divisor;
893 goto check_and_exit;
894 }
895
896 if ((new_serial.baud_base != priv->baud_base) &&
897 (new_serial.baud_base < 9600))
898 return -EINVAL;
899
900 /* Make the changes - these are privileged changes! */
901
902 priv->flags = ((priv->flags & ~ASYNC_FLAGS) |
903 (new_serial.flags & ASYNC_FLAGS));
904 priv->custom_divisor = new_serial.custom_divisor;
905
906 port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
907
908check_and_exit:
909 if ((old_priv.flags & ASYNC_SPD_MASK) !=
910 (priv->flags & ASYNC_SPD_MASK)) {
911 if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_HI)
912 port->tty->alt_speed = 57600;
913 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_VHI)
914 port->tty->alt_speed = 115200;
915 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_SHI)
916 port->tty->alt_speed = 230400;
917 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_WARP)
918 port->tty->alt_speed = 460800;
919 else
920 port->tty->alt_speed = 0;
921 }
922 if (((old_priv.flags & ASYNC_SPD_MASK) !=
923 (priv->flags & ASYNC_SPD_MASK)) ||
924 (((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
925 (old_priv.custom_divisor != priv->custom_divisor))) {
926 change_speed(port);
927 }
928
929 return (0);
930
931} /* set_serial_info */
932
933
Ian Abbott8f977e42005-06-20 16:45:42 +0100934/* Determine type of FTDI chip based on USB config and descriptor. */
935static void ftdi_determine_type(struct usb_serial_port *port)
936{
937 struct ftdi_private *priv = usb_get_serial_port_data(port);
938 struct usb_serial *serial = port->serial;
939 struct usb_device *udev = serial->dev;
940 unsigned version;
941 unsigned interfaces;
942
943 /* Assume it is not the original SIO device for now. */
Ian Abbottf5e09b72005-09-12 12:23:25 +0100944 priv->baud_base = 48000000 / 2;
Ian Abbott8f977e42005-06-20 16:45:42 +0100945 priv->write_offset = 0;
946
947 version = le16_to_cpu(udev->descriptor.bcdDevice);
948 interfaces = udev->actconfig->desc.bNumInterfaces;
949 dbg("%s: bcdDevice = 0x%x, bNumInterfaces = %u", __FUNCTION__,
950 version, interfaces);
951 if (interfaces > 1) {
952 int inter;
953
954 /* Multiple interfaces. Assume FT2232C. */
955 priv->chip_type = FT2232C;
956 /* Determine interface code. */
957 inter = serial->interface->altsetting->desc.bInterfaceNumber;
958 if (inter == 0) {
959 priv->interface = PIT_SIOA;
960 } else {
961 priv->interface = PIT_SIOB;
962 }
963 /* BM-type devices have a bug where bcdDevice gets set
964 * to 0x200 when iSerialNumber is 0. */
965 if (version < 0x500) {
966 dbg("%s: something fishy - bcdDevice too low for multi-interface device",
967 __FUNCTION__);
968 }
969 } else if (version < 0x200) {
970 /* Old device. Assume its the original SIO. */
971 priv->chip_type = SIO;
972 priv->baud_base = 12000000 / 16;
973 priv->write_offset = 1;
974 } else if (version < 0x400) {
975 /* Assume its an FT8U232AM (or FT8U245AM) */
976 /* (It might be a BM because of the iSerialNumber bug,
977 * but it will still work as an AM device.) */
978 priv->chip_type = FT8U232AM;
979 } else {
980 /* Assume its an FT232BM (or FT245BM) */
981 priv->chip_type = FT232BM;
982 }
983 info("Detected %s", ftdi_chip_name[priv->chip_type]);
984}
985
986
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987/*
988 * ***************************************************************************
989 * Sysfs Attribute
990 * ***************************************************************************
991 */
992
Yani Ioannou060b8842005-05-17 06:44:04 -0400993static ssize_t show_latency_timer(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994{
995 struct usb_serial_port *port = to_usb_serial_port(dev);
996 struct ftdi_private *priv = usb_get_serial_port_data(port);
997 struct usb_device *udev;
998 unsigned short latency = 0;
999 int rv = 0;
1000
1001 udev = to_usb_device(dev);
1002
1003 dbg("%s",__FUNCTION__);
1004
1005 rv = usb_control_msg(udev,
1006 usb_rcvctrlpipe(udev, 0),
1007 FTDI_SIO_GET_LATENCY_TIMER_REQUEST,
1008 FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE,
1009 0, priv->interface,
1010 (char*) &latency, 1, WDR_TIMEOUT);
1011
1012 if (rv < 0) {
1013 dev_err(dev, "Unable to read latency timer: %i", rv);
1014 return -EIO;
1015 }
1016 return sprintf(buf, "%i\n", latency);
1017}
1018
1019/* Write a new value of the latency timer, in units of milliseconds. */
Yani Ioannou060b8842005-05-17 06:44:04 -04001020static ssize_t store_latency_timer(struct device *dev, struct device_attribute *attr, const char *valbuf,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021 size_t count)
1022{
1023 struct usb_serial_port *port = to_usb_serial_port(dev);
1024 struct ftdi_private *priv = usb_get_serial_port_data(port);
1025 struct usb_device *udev;
1026 char buf[1];
1027 int v = simple_strtoul(valbuf, NULL, 10);
1028 int rv = 0;
1029
1030 udev = to_usb_device(dev);
1031
1032 dbg("%s: setting latency timer = %i", __FUNCTION__, v);
1033
1034 rv = usb_control_msg(udev,
1035 usb_sndctrlpipe(udev, 0),
1036 FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
1037 FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
1038 v, priv->interface,
1039 buf, 0, WDR_TIMEOUT);
1040
1041 if (rv < 0) {
1042 dev_err(dev, "Unable to write latency timer: %i", rv);
1043 return -EIO;
1044 }
1045
1046 return count;
1047}
1048
1049/* Write an event character directly to the FTDI register. The ASCII
1050 value is in the low 8 bits, with the enable bit in the 9th bit. */
Yani Ioannou060b8842005-05-17 06:44:04 -04001051static ssize_t store_event_char(struct device *dev, struct device_attribute *attr, const char *valbuf,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052 size_t count)
1053{
1054 struct usb_serial_port *port = to_usb_serial_port(dev);
1055 struct ftdi_private *priv = usb_get_serial_port_data(port);
1056 struct usb_device *udev;
1057 char buf[1];
1058 int v = simple_strtoul(valbuf, NULL, 10);
1059 int rv = 0;
1060
1061 udev = to_usb_device(dev);
1062
1063 dbg("%s: setting event char = %i", __FUNCTION__, v);
1064
1065 rv = usb_control_msg(udev,
1066 usb_sndctrlpipe(udev, 0),
1067 FTDI_SIO_SET_EVENT_CHAR_REQUEST,
1068 FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE,
1069 v, priv->interface,
1070 buf, 0, WDR_TIMEOUT);
1071
1072 if (rv < 0) {
1073 dbg("Unable to write event character: %i", rv);
1074 return -EIO;
1075 }
1076
1077 return count;
1078}
1079
1080static DEVICE_ATTR(latency_timer, S_IWUSR | S_IRUGO, show_latency_timer, store_latency_timer);
1081static DEVICE_ATTR(event_char, S_IWUSR, NULL, store_event_char);
1082
1083static void create_sysfs_attrs(struct usb_serial *serial)
1084{
1085 struct ftdi_private *priv;
1086 struct usb_device *udev;
1087
1088 dbg("%s",__FUNCTION__);
1089
1090 priv = usb_get_serial_port_data(serial->port[0]);
1091 udev = serial->dev;
1092
1093 /* XXX I've no idea if the original SIO supports the event_char
1094 * sysfs parameter, so I'm playing it safe. */
1095 if (priv->chip_type != SIO) {
1096 dbg("sysfs attributes for %s", ftdi_chip_name[priv->chip_type]);
1097 device_create_file(&udev->dev, &dev_attr_event_char);
1098 if (priv->chip_type == FT232BM || priv->chip_type == FT2232C) {
1099 device_create_file(&udev->dev, &dev_attr_latency_timer);
1100 }
1101 }
1102}
1103
1104static void remove_sysfs_attrs(struct usb_serial *serial)
1105{
1106 struct ftdi_private *priv;
1107 struct usb_device *udev;
1108
1109 dbg("%s",__FUNCTION__);
1110
1111 priv = usb_get_serial_port_data(serial->port[0]);
1112 udev = serial->dev;
1113
1114 /* XXX see create_sysfs_attrs */
1115 if (priv->chip_type != SIO) {
1116 device_remove_file(&udev->dev, &dev_attr_event_char);
1117 if (priv->chip_type == FT232BM || priv->chip_type == FT2232C) {
1118 device_remove_file(&udev->dev, &dev_attr_latency_timer);
1119 }
1120 }
1121
1122}
1123
1124/*
1125 * ***************************************************************************
1126 * FTDI driver specific functions
1127 * ***************************************************************************
1128 */
1129
Ian Abbott8f977e42005-06-20 16:45:42 +01001130/* Probe function to check for special devices */
1131static int ftdi_sio_probe (struct usb_serial *serial, const struct usb_device_id *id)
1132{
1133 usb_set_serial_data(serial, (void *)id->driver_info);
1134
1135 return (0);
1136}
1137
1138/* attach subroutine */
1139static int ftdi_sio_attach (struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140{
1141 struct usb_serial_port *port = serial->port[0];
1142 struct ftdi_private *priv;
Ian Abbott8f977e42005-06-20 16:45:42 +01001143 struct ftdi_sio_quirk *quirk;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144
1145 dbg("%s",__FUNCTION__);
1146
Eric Sesterhenn80b6ca42006-02-27 21:29:43 +01001147 priv = kzalloc(sizeof(struct ftdi_private), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148 if (!priv){
1149 err("%s- kmalloc(%Zd) failed.", __FUNCTION__, sizeof(struct ftdi_private));
1150 return -ENOMEM;
1151 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152
1153 spin_lock_init(&priv->rx_lock);
1154 init_waitqueue_head(&priv->delta_msr_wait);
1155 /* This will push the characters through immediately rather
1156 than queue a task to deliver them */
1157 priv->flags = ASYNC_LOW_LATENCY;
1158
1159 /* Increase the size of read buffers */
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07001160 kfree(port->bulk_in_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161 port->bulk_in_buffer = kmalloc (BUFSZ, GFP_KERNEL);
1162 if (!port->bulk_in_buffer) {
1163 kfree (priv);
1164 return -ENOMEM;
1165 }
1166 if (port->read_urb) {
1167 port->read_urb->transfer_buffer = port->bulk_in_buffer;
1168 port->read_urb->transfer_buffer_length = BUFSZ;
1169 }
1170
Ian Abbott76854ce2005-06-02 10:34:11 +01001171 INIT_WORK(&priv->rx_work, ftdi_process_read, port);
1172
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 /* Free port's existing write urb and transfer buffer. */
1174 if (port->write_urb) {
1175 usb_free_urb (port->write_urb);
1176 port->write_urb = NULL;
1177 }
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07001178 kfree(port->bulk_out_buffer);
1179 port->bulk_out_buffer = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180
1181 usb_set_serial_port_data(serial->port[0], priv);
Ian Abbott8f977e42005-06-20 16:45:42 +01001182
1183 ftdi_determine_type (serial->port[0]);
1184 create_sysfs_attrs(serial);
1185
1186 /* Check for device requiring special set up. */
1187 quirk = (struct ftdi_sio_quirk *)usb_get_serial_data(serial);
1188 if (quirk && quirk->setup) {
1189 quirk->setup(serial);
1190 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191
1192 return (0);
Ian Abbott8f977e42005-06-20 16:45:42 +01001193} /* ftdi_sio_attach */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194
1195
Ian Abbott8f977e42005-06-20 16:45:42 +01001196/* Setup for the USB-UIRT device, which requires hardwired
1197 * baudrate (38400 gets mapped to 312500) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198/* Called from usbserial:serial_probe */
Ian Abbott8f977e42005-06-20 16:45:42 +01001199static void ftdi_USB_UIRT_setup (struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200{
1201 struct ftdi_private *priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202
1203 dbg("%s",__FUNCTION__);
1204
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205 priv = usb_get_serial_port_data(serial->port[0]);
1206 priv->flags |= ASYNC_SPD_CUST;
1207 priv->custom_divisor = 77;
1208 priv->force_baud = B38400;
Ian Abbott8f977e42005-06-20 16:45:42 +01001209} /* ftdi_USB_UIRT_setup */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210
Ian Abbott8f977e42005-06-20 16:45:42 +01001211/* Setup for the HE-TIRA1 device, which requires hardwired
1212 * baudrate (38400 gets mapped to 100000) and RTS-CTS enabled. */
1213static void ftdi_HE_TIRA1_setup (struct usb_serial *serial)
1214{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215 struct ftdi_private *priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216
1217 dbg("%s",__FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218
1219 priv = usb_get_serial_port_data(serial->port[0]);
1220 priv->flags |= ASYNC_SPD_CUST;
1221 priv->custom_divisor = 240;
1222 priv->force_baud = B38400;
1223 priv->force_rtscts = 1;
Ian Abbott8f977e42005-06-20 16:45:42 +01001224} /* ftdi_HE_TIRA1_setup */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225
1226
1227/* ftdi_shutdown is called from usbserial:usb_serial_disconnect
1228 * it is called when the usb device is disconnected
1229 *
1230 * usbserial:usb_serial_disconnect
1231 * calls __serial_close for each open of the port
1232 * shutdown is called then (ie ftdi_shutdown)
1233 */
1234
1235
1236static void ftdi_shutdown (struct usb_serial *serial)
1237{ /* ftdi_shutdown */
1238
1239 struct usb_serial_port *port = serial->port[0];
1240 struct ftdi_private *priv = usb_get_serial_port_data(port);
1241
1242 dbg("%s", __FUNCTION__);
1243
1244 remove_sysfs_attrs(serial);
1245
1246 /* all open ports are closed at this point
1247 * (by usbserial.c:__serial_close, which calls ftdi_close)
1248 */
1249
1250 if (priv) {
1251 usb_set_serial_port_data(port, NULL);
1252 kfree(priv);
1253 }
1254} /* ftdi_shutdown */
1255
1256
1257static int ftdi_open (struct usb_serial_port *port, struct file *filp)
1258{ /* ftdi_open */
1259 struct termios tmp_termios;
1260 struct usb_device *dev = port->serial->dev;
1261 struct ftdi_private *priv = usb_get_serial_port_data(port);
1262 unsigned long flags;
1263
1264 int result = 0;
1265 char buf[1]; /* Needed for the usb_control_msg I think */
1266
1267 dbg("%s", __FUNCTION__);
1268
1269
1270 port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
1271
1272 /* No error checking for this (will get errors later anyway) */
1273 /* See ftdi_sio.h for description of what is reset */
1274 usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1275 FTDI_SIO_RESET_REQUEST, FTDI_SIO_RESET_REQUEST_TYPE,
1276 FTDI_SIO_RESET_SIO,
1277 priv->interface, buf, 0, WDR_TIMEOUT);
1278
1279 /* Termios defaults are set by usb_serial_init. We don't change
1280 port->tty->termios - this would loose speed settings, etc.
1281 This is same behaviour as serial.c/rs_open() - Kuba */
1282
1283 /* ftdi_set_termios will send usb control messages */
1284 ftdi_set_termios(port, &tmp_termios);
1285
1286 /* FIXME: Flow control might be enabled, so it should be checked -
1287 we have no control of defaults! */
1288 /* Turn on RTS and DTR since we are not flow controlling by default */
Ian Abbott74ede0f2005-07-29 12:16:41 -07001289 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290
1291 /* Not throttled */
1292 spin_lock_irqsave(&priv->rx_lock, flags);
1293 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
1294 spin_unlock_irqrestore(&priv->rx_lock, flags);
1295
1296 /* Start reading from the device */
Ian Abbott76854ce2005-06-02 10:34:11 +01001297 priv->rx_processed = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298 usb_fill_bulk_urb(port->read_urb, dev,
1299 usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress),
1300 port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
1301 ftdi_read_bulk_callback, port);
1302 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
1303 if (result)
1304 err("%s - failed submitting read urb, error %d", __FUNCTION__, result);
1305
1306
1307 return result;
1308} /* ftdi_open */
1309
1310
1311
1312/*
1313 * usbserial:__serial_close only calls ftdi_close if the point is open
1314 *
1315 * This only gets called when it is the last close
1316 *
1317 *
1318 */
1319
1320static void ftdi_close (struct usb_serial_port *port, struct file *filp)
1321{ /* ftdi_close */
1322 unsigned int c_cflag = port->tty->termios->c_cflag;
1323 struct ftdi_private *priv = usb_get_serial_port_data(port);
1324 char buf[1];
1325
1326 dbg("%s", __FUNCTION__);
1327
1328 if (c_cflag & HUPCL){
1329 /* Disable flow control */
1330 if (usb_control_msg(port->serial->dev,
1331 usb_sndctrlpipe(port->serial->dev, 0),
1332 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1333 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1334 0, priv->interface, buf, 0,
1335 WDR_TIMEOUT) < 0) {
1336 err("error from flowcontrol urb");
1337 }
1338
Ian Abbott74ede0f2005-07-29 12:16:41 -07001339 /* drop RTS and DTR */
1340 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341 } /* Note change no line if hupcl is off */
Ian Abbott76854ce2005-06-02 10:34:11 +01001342
1343 /* cancel any scheduled reading */
1344 cancel_delayed_work(&priv->rx_work);
1345 flush_scheduled_work();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346
1347 /* shutdown our bulk read */
1348 if (port->read_urb)
1349 usb_kill_urb(port->read_urb);
1350} /* ftdi_close */
1351
1352
1353
1354/* The SIO requires the first byte to have:
1355 * B0 1
1356 * B1 0
1357 * B2..7 length of message excluding byte 0
1358 *
1359 * The new devices do not require this byte
1360 */
1361static int ftdi_write (struct usb_serial_port *port,
1362 const unsigned char *buf, int count)
1363{ /* ftdi_write */
1364 struct ftdi_private *priv = usb_get_serial_port_data(port);
1365 struct urb *urb;
1366 unsigned char *buffer;
1367 int data_offset ; /* will be 1 for the SIO and 0 otherwise */
1368 int status;
1369 int transfer_size;
1370
1371 dbg("%s port %d, %d bytes", __FUNCTION__, port->number, count);
1372
1373 if (count == 0) {
1374 dbg("write request of 0 bytes");
1375 return 0;
1376 }
1377
1378 data_offset = priv->write_offset;
1379 dbg("data_offset set to %d",data_offset);
1380
1381 /* Determine total transfer size */
1382 transfer_size = count;
1383 if (data_offset > 0) {
1384 /* Original sio needs control bytes too... */
1385 transfer_size += (data_offset *
1386 ((count + (PKTSZ - 1 - data_offset)) /
1387 (PKTSZ - data_offset)));
1388 }
1389
1390 buffer = kmalloc (transfer_size, GFP_ATOMIC);
1391 if (!buffer) {
1392 err("%s ran out of kernel memory for urb ...", __FUNCTION__);
1393 return -ENOMEM;
1394 }
1395
1396 urb = usb_alloc_urb(0, GFP_ATOMIC);
1397 if (!urb) {
1398 err("%s - no more free urbs", __FUNCTION__);
1399 kfree (buffer);
1400 return -ENOMEM;
1401 }
1402
1403 /* Copy data */
1404 if (data_offset > 0) {
1405 /* Original sio requires control byte at start of each packet. */
1406 int user_pktsz = PKTSZ - data_offset;
1407 int todo = count;
1408 unsigned char *first_byte = buffer;
1409 const unsigned char *current_position = buf;
1410
1411 while (todo > 0) {
1412 if (user_pktsz > todo) {
1413 user_pktsz = todo;
1414 }
1415 /* Write the control byte at the front of the packet*/
1416 *first_byte = 1 | ((user_pktsz) << 2);
1417 /* Copy data for packet */
1418 memcpy (first_byte + data_offset,
1419 current_position, user_pktsz);
1420 first_byte += user_pktsz + data_offset;
1421 current_position += user_pktsz;
1422 todo -= user_pktsz;
1423 }
1424 } else {
1425 /* No control byte required. */
1426 /* Copy in the data to send */
1427 memcpy (buffer, buf, count);
1428 }
1429
1430 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, transfer_size, buffer);
1431
1432 /* fill the buffer and send it */
1433 usb_fill_bulk_urb(urb, port->serial->dev,
1434 usb_sndbulkpipe(port->serial->dev, port->bulk_out_endpointAddress),
1435 buffer, transfer_size,
1436 ftdi_write_bulk_callback, port);
1437
1438 status = usb_submit_urb(urb, GFP_ATOMIC);
1439 if (status) {
1440 err("%s - failed submitting write urb, error %d", __FUNCTION__, status);
1441 count = status;
1442 kfree (buffer);
1443 }
1444
1445 /* we are done with this urb, so let the host driver
1446 * really free it when it is finished with it */
1447 usb_free_urb (urb);
1448
1449 dbg("%s write returning: %d", __FUNCTION__, count);
1450 return count;
1451} /* ftdi_write */
1452
1453
1454/* This function may get called when the device is closed */
1455
1456static void ftdi_write_bulk_callback (struct urb *urb, struct pt_regs *regs)
1457{
1458 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1459
1460 /* free up the transfer buffer, as usb_free_urb() does not do this */
1461 kfree (urb->transfer_buffer);
1462
1463 dbg("%s - port %d", __FUNCTION__, port->number);
1464
1465 if (urb->status) {
1466 dbg("nonzero write bulk status received: %d", urb->status);
1467 return;
1468 }
1469
1470 schedule_work(&port->work);
1471} /* ftdi_write_bulk_callback */
1472
1473
1474static int ftdi_write_room( struct usb_serial_port *port )
1475{
1476 dbg("%s - port %d", __FUNCTION__, port->number);
1477
1478 /*
1479 * We really can take anything the user throws at us
1480 * but let's pick a nice big number to tell the tty
1481 * layer that we have lots of free space
1482 */
1483 return 2048;
1484} /* ftdi_write_room */
1485
1486
1487static int ftdi_chars_in_buffer (struct usb_serial_port *port)
1488{ /* ftdi_chars_in_buffer */
1489 dbg("%s - port %d", __FUNCTION__, port->number);
1490
1491 /*
1492 * We can't really account for how much data we
1493 * have sent out, but hasn't made it through to the
1494 * device, so just tell the tty layer that everything
1495 * is flushed.
1496 */
1497 return 0;
1498} /* ftdi_chars_in_buffer */
1499
1500
1501
1502static void ftdi_read_bulk_callback (struct urb *urb, struct pt_regs *regs)
1503{ /* ftdi_read_bulk_callback */
1504 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1505 struct tty_struct *tty;
1506 struct ftdi_private *priv;
1507
1508 if (urb->number_of_packets > 0) {
1509 err("%s transfer_buffer_length %d actual_length %d number of packets %d",__FUNCTION__,
1510 urb->transfer_buffer_length, urb->actual_length, urb->number_of_packets );
1511 err("%s transfer_flags %x ", __FUNCTION__,urb->transfer_flags );
1512 }
1513
1514 dbg("%s - port %d", __FUNCTION__, port->number);
1515
1516 if (port->open_count <= 0)
1517 return;
1518
1519 tty = port->tty;
1520 if (!tty) {
1521 dbg("%s - bad tty pointer - exiting",__FUNCTION__);
1522 return;
1523 }
1524
1525 priv = usb_get_serial_port_data(port);
1526 if (!priv) {
1527 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1528 return;
1529 }
1530
1531 if (urb != port->read_urb) {
1532 err("%s - Not my urb!", __FUNCTION__);
1533 }
1534
1535 if (urb->status) {
1536 /* This will happen at close every time so it is a dbg not an err */
1537 dbg("(this is ok on close) nonzero read bulk status received: %d", urb->status);
1538 return;
1539 }
1540
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541 ftdi_process_read(port);
1542
1543} /* ftdi_read_bulk_callback */
1544
1545
Ian Abbott76854ce2005-06-02 10:34:11 +01001546static void ftdi_process_read (void *param)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547{ /* ftdi_process_read */
Ian Abbott76854ce2005-06-02 10:34:11 +01001548 struct usb_serial_port *port = (struct usb_serial_port*)param;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549 struct urb *urb;
1550 struct tty_struct *tty;
1551 struct ftdi_private *priv;
1552 char error_flag;
1553 unsigned char *data;
1554
1555 int i;
1556 int result;
1557 int need_flip;
1558 int packet_offset;
Ian Abbott76854ce2005-06-02 10:34:11 +01001559 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560
1561 dbg("%s - port %d", __FUNCTION__, port->number);
1562
1563 if (port->open_count <= 0)
1564 return;
1565
1566 tty = port->tty;
1567 if (!tty) {
1568 dbg("%s - bad tty pointer - exiting",__FUNCTION__);
1569 return;
1570 }
1571
1572 priv = usb_get_serial_port_data(port);
1573 if (!priv) {
1574 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1575 return;
1576 }
1577
1578 urb = port->read_urb;
1579 if (!urb) {
1580 dbg("%s - bad read_urb pointer - exiting", __FUNCTION__);
1581 return;
1582 }
1583
1584 data = urb->transfer_buffer;
1585
Ian Abbott76854ce2005-06-02 10:34:11 +01001586 if (priv->rx_processed) {
1587 dbg("%s - already processed: %d bytes, %d remain", __FUNCTION__,
1588 priv->rx_processed,
1589 urb->actual_length - priv->rx_processed);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590 } else {
Ian Abbott76854ce2005-06-02 10:34:11 +01001591 /* The first two bytes of every read packet are status */
1592 if (urb->actual_length > 2) {
1593 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
1594 } else {
1595 dbg("Status only: %03oo %03oo",data[0],data[1]);
1596 }
1597 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598
1599
1600 /* TO DO -- check for hung up line and handle appropriately: */
1601 /* send hangup */
1602 /* See acm.c - you do a tty_hangup - eg tty_hangup(tty) */
1603 /* if CD is dropped and the line is not CLOCAL then we should hangup */
1604
1605 need_flip = 0;
Ian Abbott76854ce2005-06-02 10:34:11 +01001606 for (packet_offset = priv->rx_processed; packet_offset < urb->actual_length; packet_offset += PKTSZ) {
1607 int length;
1608
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609 /* Compare new line status to the old one, signal if different */
Ian Abbott76854ce2005-06-02 10:34:11 +01001610 /* N.B. packet may be processed more than once, but differences
1611 * are only processed once. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612 if (priv != NULL) {
1613 char new_status = data[packet_offset+0] & FTDI_STATUS_B0_MASK;
1614 if (new_status != priv->prev_status) {
1615 priv->diff_status |= new_status ^ priv->prev_status;
1616 wake_up_interruptible(&priv->delta_msr_wait);
1617 priv->prev_status = new_status;
1618 }
1619 }
1620
Ian Abbott76854ce2005-06-02 10:34:11 +01001621 length = min(PKTSZ, urb->actual_length-packet_offset)-2;
1622 if (length < 0) {
1623 err("%s - bad packet length: %d", __FUNCTION__, length+2);
1624 length = 0;
1625 }
1626
Ian Abbott76854ce2005-06-02 10:34:11 +01001627 if (priv->rx_flags & THROTTLED) {
1628 dbg("%s - throttled", __FUNCTION__);
1629 break;
1630 }
Alan Cox33f0f882006-01-09 20:54:13 -08001631 if (tty_buffer_request_room(tty, length) < length) {
Ian Abbott76854ce2005-06-02 10:34:11 +01001632 /* break out & wait for throttling/unthrottling to happen */
1633 dbg("%s - receive room low", __FUNCTION__);
1634 break;
1635 }
1636
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637 /* Handle errors and break */
1638 error_flag = TTY_NORMAL;
1639 /* Although the device uses a bitmask and hence can have multiple */
1640 /* errors on a packet - the order here sets the priority the */
1641 /* error is returned to the tty layer */
1642
1643 if ( data[packet_offset+1] & FTDI_RS_OE ) {
1644 error_flag = TTY_OVERRUN;
1645 dbg("OVERRRUN error");
1646 }
1647 if ( data[packet_offset+1] & FTDI_RS_BI ) {
1648 error_flag = TTY_BREAK;
1649 dbg("BREAK received");
1650 }
1651 if ( data[packet_offset+1] & FTDI_RS_PE ) {
1652 error_flag = TTY_PARITY;
1653 dbg("PARITY error");
1654 }
1655 if ( data[packet_offset+1] & FTDI_RS_FE ) {
1656 error_flag = TTY_FRAME;
1657 dbg("FRAMING error");
1658 }
Ian Abbott76854ce2005-06-02 10:34:11 +01001659 if (length > 0) {
1660 for (i = 2; i < length+2; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661 /* Note that the error flag is duplicated for
1662 every character received since we don't know
1663 which character it applied to */
1664 tty_insert_flip_char(tty, data[packet_offset+i], error_flag);
1665 }
1666 need_flip = 1;
1667 }
1668
1669#ifdef NOT_CORRECT_BUT_KEEPING_IT_FOR_NOW
1670 /* if a parity error is detected you get status packets forever
1671 until a character is sent without a parity error.
1672 This doesn't work well since the application receives a never
1673 ending stream of bad data - even though new data hasn't been sent.
1674 Therefore I (bill) have taken this out.
1675 However - this might make sense for framing errors and so on
1676 so I am leaving the code in for now.
1677 */
1678 else {
1679 if (error_flag != TTY_NORMAL){
1680 dbg("error_flag is not normal");
1681 /* In this case it is just status - if that is an error send a bad character */
1682 if(tty->flip.count >= TTY_FLIPBUF_SIZE) {
1683 tty_flip_buffer_push(tty);
1684 }
1685 tty_insert_flip_char(tty, 0xff, error_flag);
1686 need_flip = 1;
1687 }
1688 }
1689#endif
1690 } /* "for(packet_offset=0..." */
1691
1692 /* Low latency */
1693 if (need_flip) {
1694 tty_flip_buffer_push(tty);
1695 }
1696
Ian Abbott76854ce2005-06-02 10:34:11 +01001697 if (packet_offset < urb->actual_length) {
1698 /* not completely processed - record progress */
1699 priv->rx_processed = packet_offset;
1700 dbg("%s - incomplete, %d bytes processed, %d remain",
1701 __FUNCTION__, packet_offset,
1702 urb->actual_length - packet_offset);
1703 /* check if we were throttled while processing */
1704 spin_lock_irqsave(&priv->rx_lock, flags);
1705 if (priv->rx_flags & THROTTLED) {
1706 priv->rx_flags |= ACTUALLY_THROTTLED;
1707 spin_unlock_irqrestore(&priv->rx_lock, flags);
1708 dbg("%s - deferring remainder until unthrottled",
1709 __FUNCTION__);
1710 return;
1711 }
1712 spin_unlock_irqrestore(&priv->rx_lock, flags);
1713 /* if the port is closed stop trying to read */
1714 if (port->open_count > 0){
1715 /* delay processing of remainder */
1716 schedule_delayed_work(&priv->rx_work, 1);
1717 } else {
1718 dbg("%s - port is closed", __FUNCTION__);
1719 }
1720 return;
1721 }
1722
1723 /* urb is completely processed */
1724 priv->rx_processed = 0;
1725
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726 /* if the port is closed stop trying to read */
1727 if (port->open_count > 0){
1728 /* Continue trying to always read */
1729 usb_fill_bulk_urb(port->read_urb, port->serial->dev,
1730 usb_rcvbulkpipe(port->serial->dev, port->bulk_in_endpointAddress),
1731 port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
1732 ftdi_read_bulk_callback, port);
1733
1734 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1735 if (result)
1736 err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
1737 }
1738
1739 return;
1740} /* ftdi_process_read */
1741
1742
1743static void ftdi_break_ctl( struct usb_serial_port *port, int break_state )
1744{
1745 struct ftdi_private *priv = usb_get_serial_port_data(port);
1746 __u16 urb_value = 0;
1747 char buf[1];
1748
1749 /* break_state = -1 to turn on break, and 0 to turn off break */
1750 /* see drivers/char/tty_io.c to see it used */
1751 /* last_set_data_urb_value NEVER has the break bit set in it */
1752
1753 if (break_state) {
1754 urb_value = priv->last_set_data_urb_value | FTDI_SIO_SET_BREAK;
1755 } else {
1756 urb_value = priv->last_set_data_urb_value;
1757 }
1758
1759
1760 if (usb_control_msg(port->serial->dev, usb_sndctrlpipe(port->serial->dev, 0),
1761 FTDI_SIO_SET_DATA_REQUEST,
1762 FTDI_SIO_SET_DATA_REQUEST_TYPE,
1763 urb_value , priv->interface,
1764 buf, 0, WDR_TIMEOUT) < 0) {
1765 err("%s FAILED to enable/disable break state (state was %d)", __FUNCTION__,break_state);
1766 }
1767
1768 dbg("%s break state is %d - urb is %d", __FUNCTION__,break_state, urb_value);
1769
1770}
1771
1772
1773/* old_termios contains the original termios settings and tty->termios contains
1774 * the new setting to be used
1775 * WARNING: set_termios calls this with old_termios in kernel space
1776 */
1777
1778static void ftdi_set_termios (struct usb_serial_port *port, struct termios *old_termios)
1779{ /* ftdi_termios */
1780 struct usb_device *dev = port->serial->dev;
1781 unsigned int cflag = port->tty->termios->c_cflag;
1782 struct ftdi_private *priv = usb_get_serial_port_data(port);
1783 __u16 urb_value; /* will hold the new flags */
1784 char buf[1]; /* Perhaps I should dynamically alloc this? */
1785
1786 // Added for xon/xoff support
1787 unsigned int iflag = port->tty->termios->c_iflag;
1788 unsigned char vstop;
1789 unsigned char vstart;
1790
1791 dbg("%s", __FUNCTION__);
1792
1793 /* Force baud rate if this device requires it, unless it is set to B0. */
1794 if (priv->force_baud && ((port->tty->termios->c_cflag & CBAUD) != B0)) {
1795 dbg("%s: forcing baud rate for this device", __FUNCTION__);
1796 port->tty->termios->c_cflag &= ~CBAUD;
1797 port->tty->termios->c_cflag |= priv->force_baud;
1798 }
1799
1800 /* Force RTS-CTS if this device requires it. */
1801 if (priv->force_rtscts) {
1802 dbg("%s: forcing rtscts for this device", __FUNCTION__);
1803 port->tty->termios->c_cflag |= CRTSCTS;
1804 }
1805
1806 cflag = port->tty->termios->c_cflag;
1807
1808 /* FIXME -For this cut I don't care if the line is really changing or
1809 not - so just do the change regardless - should be able to
1810 compare old_termios and tty->termios */
1811 /* NOTE These routines can get interrupted by
1812 ftdi_sio_read_bulk_callback - need to examine what this
1813 means - don't see any problems yet */
1814
1815 /* Set number of data bits, parity, stop bits */
1816
1817 urb_value = 0;
1818 urb_value |= (cflag & CSTOPB ? FTDI_SIO_SET_DATA_STOP_BITS_2 :
1819 FTDI_SIO_SET_DATA_STOP_BITS_1);
1820 urb_value |= (cflag & PARENB ?
1821 (cflag & PARODD ? FTDI_SIO_SET_DATA_PARITY_ODD :
1822 FTDI_SIO_SET_DATA_PARITY_EVEN) :
1823 FTDI_SIO_SET_DATA_PARITY_NONE);
1824 if (cflag & CSIZE) {
1825 switch (cflag & CSIZE) {
1826 case CS5: urb_value |= 5; dbg("Setting CS5"); break;
1827 case CS6: urb_value |= 6; dbg("Setting CS6"); break;
1828 case CS7: urb_value |= 7; dbg("Setting CS7"); break;
1829 case CS8: urb_value |= 8; dbg("Setting CS8"); break;
1830 default:
1831 err("CSIZE was set but not CS5-CS8");
1832 }
1833 }
1834
1835 /* This is needed by the break command since it uses the same command - but is
1836 * or'ed with this value */
1837 priv->last_set_data_urb_value = urb_value;
1838
1839 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1840 FTDI_SIO_SET_DATA_REQUEST,
1841 FTDI_SIO_SET_DATA_REQUEST_TYPE,
1842 urb_value , priv->interface,
Ian Abbott279e1542005-07-29 12:16:52 -07001843 buf, 0, WDR_SHORT_TIMEOUT) < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844 err("%s FAILED to set databits/stopbits/parity", __FUNCTION__);
1845 }
1846
1847 /* Now do the baudrate */
1848 if ((cflag & CBAUD) == B0 ) {
1849 /* Disable flow control */
1850 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1851 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1852 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1853 0, priv->interface,
1854 buf, 0, WDR_TIMEOUT) < 0) {
1855 err("%s error from disable flowcontrol urb", __FUNCTION__);
1856 }
1857 /* Drop RTS and DTR */
Ian Abbott74ede0f2005-07-29 12:16:41 -07001858 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859 } else {
1860 /* set the baudrate determined before */
1861 if (change_speed(port)) {
Peter Favrholdt72a755f2005-09-22 00:48:49 -07001862 err("%s urb failed to set baudrate", __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863 }
Peter Favrholdt72a755f2005-09-22 00:48:49 -07001864 /* Ensure RTS and DTR are raised when baudrate changed from 0 */
1865 if ((old_termios->c_cflag & CBAUD) == B0) {
1866 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1867 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868 }
1869
1870 /* Set flow control */
1871 /* Note device also supports DTR/CD (ugh) and Xon/Xoff in hardware */
1872 if (cflag & CRTSCTS) {
1873 dbg("%s Setting to CRTSCTS flow control", __FUNCTION__);
1874 if (usb_control_msg(dev,
1875 usb_sndctrlpipe(dev, 0),
1876 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1877 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1878 0 , (FTDI_SIO_RTS_CTS_HS | priv->interface),
1879 buf, 0, WDR_TIMEOUT) < 0) {
1880 err("urb failed to set to rts/cts flow control");
1881 }
1882
1883 } else {
1884 /*
1885 * Xon/Xoff code
1886 *
1887 * Check the IXOFF status in the iflag component of the termios structure
1888 * if IXOFF is not set, the pre-xon/xoff code is executed.
1889 */
1890 if (iflag & IXOFF) {
1891 dbg("%s request to enable xonxoff iflag=%04x",__FUNCTION__,iflag);
1892 // Try to enable the XON/XOFF on the ftdi_sio
1893 // Set the vstart and vstop -- could have been done up above where
1894 // a lot of other dereferencing is done but that would be very
1895 // inefficient as vstart and vstop are not always needed
1896 vstart=port->tty->termios->c_cc[VSTART];
1897 vstop=port->tty->termios->c_cc[VSTOP];
1898 urb_value=(vstop << 8) | (vstart);
1899
1900 if (usb_control_msg(dev,
1901 usb_sndctrlpipe(dev, 0),
1902 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1903 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1904 urb_value , (FTDI_SIO_XON_XOFF_HS
1905 | priv->interface),
1906 buf, 0, WDR_TIMEOUT) < 0) {
1907 err("urb failed to set to xon/xoff flow control");
1908 }
1909 } else {
1910 /* else clause to only run if cfag ! CRTSCTS and iflag ! XOFF */
1911 /* CHECKME Assuming XON/XOFF handled by tty stack - not by device */
1912 dbg("%s Turning off hardware flow control", __FUNCTION__);
1913 if (usb_control_msg(dev,
1914 usb_sndctrlpipe(dev, 0),
1915 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1916 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1917 0, priv->interface,
1918 buf, 0, WDR_TIMEOUT) < 0) {
1919 err("urb failed to clear flow control");
1920 }
1921 }
1922
1923 }
1924 return;
1925} /* ftdi_termios */
1926
1927
1928static int ftdi_tiocmget (struct usb_serial_port *port, struct file *file)
1929{
1930 struct ftdi_private *priv = usb_get_serial_port_data(port);
1931 unsigned char buf[2];
1932 int ret;
1933
1934 dbg("%s TIOCMGET", __FUNCTION__);
1935 switch (priv->chip_type) {
1936 case SIO:
1937 /* Request the status from the device */
1938 if ((ret = usb_control_msg(port->serial->dev,
1939 usb_rcvctrlpipe(port->serial->dev, 0),
1940 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
1941 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
1942 0, 0,
1943 buf, 1, WDR_TIMEOUT)) < 0 ) {
1944 err("%s Could not get modem status of device - err: %d", __FUNCTION__,
1945 ret);
1946 return(ret);
1947 }
1948 break;
1949 case FT8U232AM:
1950 case FT232BM:
1951 case FT2232C:
1952 /* the 8U232AM returns a two byte value (the sio is a 1 byte value) - in the same
1953 format as the data returned from the in point */
1954 if ((ret = usb_control_msg(port->serial->dev,
1955 usb_rcvctrlpipe(port->serial->dev, 0),
1956 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
1957 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
1958 0, priv->interface,
1959 buf, 2, WDR_TIMEOUT)) < 0 ) {
1960 err("%s Could not get modem status of device - err: %d", __FUNCTION__,
1961 ret);
1962 return(ret);
1963 }
1964 break;
1965 default:
1966 return -EFAULT;
1967 break;
1968 }
1969
1970 return (buf[0] & FTDI_SIO_DSR_MASK ? TIOCM_DSR : 0) |
1971 (buf[0] & FTDI_SIO_CTS_MASK ? TIOCM_CTS : 0) |
1972 (buf[0] & FTDI_SIO_RI_MASK ? TIOCM_RI : 0) |
1973 (buf[0] & FTDI_SIO_RLSD_MASK ? TIOCM_CD : 0) |
1974 priv->last_dtr_rts;
1975}
1976
1977static int ftdi_tiocmset(struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear)
1978{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979 dbg("%s TIOCMSET", __FUNCTION__);
Ian Abbott74ede0f2005-07-29 12:16:41 -07001980 return update_mctrl(port, set, clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001981}
1982
1983
1984static int ftdi_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
1985{
1986 struct ftdi_private *priv = usb_get_serial_port_data(port);
1987
Linus Torvalds1da177e2005-04-16 15:20:36 -07001988 dbg("%s cmd 0x%04x", __FUNCTION__, cmd);
1989
1990 /* Based on code from acm.c and others */
1991 switch (cmd) {
1992
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993 case TIOCGSERIAL: /* gets serial port data */
1994 return get_serial_info(port, (struct serial_struct __user *) arg);
1995
1996 case TIOCSSERIAL: /* sets serial port data */
1997 return set_serial_info(port, (struct serial_struct __user *) arg);
1998
1999 /*
2000 * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
2001 * - mask passed in arg for lines of interest
2002 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
2003 * Caller should use TIOCGICOUNT to see which one it was.
2004 *
2005 * This code is borrowed from linux/drivers/char/serial.c
2006 */
2007 case TIOCMIWAIT:
2008 while (priv != NULL) {
2009 interruptible_sleep_on(&priv->delta_msr_wait);
2010 /* see if a signal did it */
2011 if (signal_pending(current))
2012 return -ERESTARTSYS;
2013 else {
2014 char diff = priv->diff_status;
2015
2016 if (diff == 0) {
2017 return -EIO; /* no change => error */
2018 }
2019
2020 /* Consume all events */
2021 priv->diff_status = 0;
2022
2023 /* Return 0 if caller wanted to know about these bits */
2024 if ( ((arg & TIOCM_RNG) && (diff & FTDI_RS0_RI)) ||
2025 ((arg & TIOCM_DSR) && (diff & FTDI_RS0_DSR)) ||
2026 ((arg & TIOCM_CD) && (diff & FTDI_RS0_RLSD)) ||
2027 ((arg & TIOCM_CTS) && (diff & FTDI_RS0_CTS)) ) {
2028 return 0;
2029 }
2030 /*
2031 * Otherwise caller can't care less about what happened,
2032 * and so we continue to wait for more events.
2033 */
2034 }
2035 }
2036 return(0);
2037 break;
2038 default:
2039 break;
2040
2041 }
2042
2043
2044 /* This is not necessarily an error - turns out the higher layers will do
2045 * some ioctls itself (see comment above)
2046 */
2047 dbg("%s arg not supported - it was 0x%04x - check /usr/include/asm/ioctls.h", __FUNCTION__, cmd);
2048
2049 return(-ENOIOCTLCMD);
2050} /* ftdi_ioctl */
2051
2052
2053static void ftdi_throttle (struct usb_serial_port *port)
2054{
2055 struct ftdi_private *priv = usb_get_serial_port_data(port);
2056 unsigned long flags;
2057
2058 dbg("%s - port %d", __FUNCTION__, port->number);
2059
2060 spin_lock_irqsave(&priv->rx_lock, flags);
2061 priv->rx_flags |= THROTTLED;
2062 spin_unlock_irqrestore(&priv->rx_lock, flags);
2063}
2064
2065
2066static void ftdi_unthrottle (struct usb_serial_port *port)
2067{
2068 struct ftdi_private *priv = usb_get_serial_port_data(port);
2069 int actually_throttled;
2070 unsigned long flags;
2071
2072 dbg("%s - port %d", __FUNCTION__, port->number);
2073
2074 spin_lock_irqsave(&priv->rx_lock, flags);
2075 actually_throttled = priv->rx_flags & ACTUALLY_THROTTLED;
2076 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
2077 spin_unlock_irqrestore(&priv->rx_lock, flags);
2078
2079 if (actually_throttled)
Ian Abbott76854ce2005-06-02 10:34:11 +01002080 schedule_work(&priv->rx_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081}
2082
2083static int __init ftdi_init (void)
2084{
2085 int retval;
2086
2087 dbg("%s", __FUNCTION__);
Ian Abbottfdcb0a02005-07-28 18:40:32 +01002088 if (vendor > 0 && product > 0) {
2089 /* Add user specified VID/PID to reserved element of table. */
2090 int i;
2091 for (i = 0; id_table_combined[i].idVendor; i++)
2092 ;
2093 id_table_combined[i].match_flags = USB_DEVICE_ID_MATCH_DEVICE;
2094 id_table_combined[i].idVendor = vendor;
2095 id_table_combined[i].idProduct = product;
2096 }
Ian Abbott8f977e42005-06-20 16:45:42 +01002097 retval = usb_serial_register(&ftdi_sio_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098 if (retval)
Ian Abbott8f977e42005-06-20 16:45:42 +01002099 goto failed_sio_register;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100 retval = usb_register(&ftdi_driver);
2101 if (retval)
2102 goto failed_usb_register;
2103
2104 info(DRIVER_VERSION ":" DRIVER_DESC);
2105 return 0;
2106failed_usb_register:
Ian Abbott8f977e42005-06-20 16:45:42 +01002107 usb_serial_deregister(&ftdi_sio_device);
2108failed_sio_register:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 return retval;
2110}
2111
2112
2113static void __exit ftdi_exit (void)
2114{
2115
2116 dbg("%s", __FUNCTION__);
2117
2118 usb_deregister (&ftdi_driver);
Ian Abbott8f977e42005-06-20 16:45:42 +01002119 usb_serial_deregister (&ftdi_sio_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120
2121}
2122
2123
2124module_init(ftdi_init);
2125module_exit(ftdi_exit);
2126
2127MODULE_AUTHOR( DRIVER_AUTHOR );
2128MODULE_DESCRIPTION( DRIVER_DESC );
2129MODULE_LICENSE("GPL");
2130
2131module_param(debug, bool, S_IRUGO | S_IWUSR);
2132MODULE_PARM_DESC(debug, "Debug enabled or not");
Ian Abbottfdcb0a02005-07-28 18:40:32 +01002133module_param(vendor, ushort, 0);
2134MODULE_PARM_DESC(vendor, "User specified vendor ID (default="
2135 __MODULE_STRING(FTDI_VID)")");
2136module_param(product, ushort, 0);
2137MODULE_PARM_DESC(vendor, "User specified product ID");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138