projects / deliverable / linux.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Merge branch 'master'
[deliverable/linux.git] / drivers / usb / serial / ftdi_sio.c
1 /*
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
79 * Added support for Home Electronics Tira-1 IR transceiver using FT232BM chip.
80 * 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
94 * Added support for USB-UIRT IR transceiver using 8U232AM chip.
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)
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 */
267 #define DRIVER_VERSION "v1.4.3"
268 #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
271 static int debug;
272 static __u16 vendor = FTDI_VID;
273 static __u16 product;
274
275 /* struct ftdi_sio_quirk is used by devices requiring special attention. */
276 struct ftdi_sio_quirk {
277 void (*setup)(struct usb_serial *); /* Special settings during startup. */
278 };
279
280 static void ftdi_USB_UIRT_setup (struct usb_serial *serial);
281 static void ftdi_HE_TIRA1_setup (struct usb_serial *serial);
282
283 static struct ftdi_sio_quirk ftdi_USB_UIRT_quirk = {
284 .setup = ftdi_USB_UIRT_setup,
285 };
286
287 static struct ftdi_sio_quirk ftdi_HE_TIRA1_quirk = {
288 .setup = ftdi_HE_TIRA1_setup,
289 };
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.
303 * FIXME: perhaps bcdDevice can also identify 12MHz FT8U232AM devices,
304 * but I don't know if those ever went into mass production. [Ian Abbott]
305 */
306
307
308
309 static 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) },
314 { 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) },
329 { 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) },
337 { 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) },
386 { 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 },
390 { 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) },
394 { 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) },
410 { USB_DEVICE(FTDI_VID, FTDI_ELV_UO100_PID) },
411 { USB_DEVICE(FTDI_VID, FTDI_ELV_UM100_PID) },
412 { USB_DEVICE(FTDI_VID, FTDI_ELV_UR100_PID) },
413 { USB_DEVICE(FTDI_VID, FTDI_ELV_ALC8500_PID) },
414 { USB_DEVICE(FTDI_VID, FTDI_PYRAMID_PID) },
415 { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1000PC_PID) },
416 /*
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) }, */
433 /* { 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) }, */
441 { 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) },
446 { 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) },
452 { USB_DEVICE(FALCOM_VID, FALCOM_SAMBA_PID) },
453 { USB_DEVICE(FTDI_VID, FTDI_SUUNTO_SPORTS_PID) },
454 { USB_DEVICE(FTDI_VID, FTDI_RM_CANVIEW_PID) },
455 { 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) },
459 { 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) },
462 { 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) },
470 { USB_DEVICE(MOBILITY_VID, MOBILITY_USB_SERIAL_PID) },
471 { USB_DEVICE(FTDI_VID, FTDI_ACTIVE_ROBOTS_PID) },
472 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y6_PID) },
473 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y8_PID) },
474 { USB_DEVICE(EVOLUTION_VID, EVOLUTION_ER1_PID) },
475 { USB_DEVICE(FTDI_VID, FTDI_ARTEMIS_PID) },
476 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16_PID) },
477 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HR_PID) },
478 { }, /* Optional parameter entry */
479 { } /* Terminating entry */
480 };
481
482 MODULE_DEVICE_TABLE (usb, id_table_combined);
483
484 static struct usb_driver ftdi_driver = {
485 .name = "ftdi_sio",
486 .probe = usb_serial_probe,
487 .disconnect = usb_serial_disconnect,
488 .id_table = id_table_combined,
489 };
490
491 static char *ftdi_chip_name[] = {
492 [SIO] = "SIO", /* the serial part of FT8U100AX */
493 [FT8U232AM] = "FT8U232AM",
494 [FT232BM] = "FT232BM",
495 [FT2232C] = "FT2232C",
496 };
497
498
499 /* Constants for read urb and write urb */
500 #define BUFSZ 512
501 #define PKTSZ 64
502
503 /* rx_flags */
504 #define THROTTLED 0x01
505 #define ACTUALLY_THROTTLED 0x02
506
507 struct ftdi_private {
508 ftdi_chip_type_t chip_type;
509 /* type of the device, either SIO or FT8U232AM */
510 int baud_base; /* baud base clock for divisor setting */
511 int custom_divisor; /* custom_divisor kludge, this is for baud_base (different from what goes to the chip!) */
512 __u16 last_set_data_urb_value ;
513 /* the last data state set - needed for doing a break */
514 int write_offset; /* This is the offset in the usb data block to write the serial data -
515 * it is different between devices
516 */
517 int flags; /* some ASYNC_xxxx flags are supported */
518 unsigned long last_dtr_rts; /* saved modem control outputs */
519 wait_queue_head_t delta_msr_wait; /* Used for TIOCMIWAIT */
520 char prev_status, diff_status; /* Used for TIOCMIWAIT */
521 __u8 rx_flags; /* receive state flags (throttling) */
522 spinlock_t rx_lock; /* spinlock for receive state */
523 struct work_struct rx_work;
524 int rx_processed;
525
526 __u16 interface; /* FT2232C port interface (0 for FT232/245) */
527
528 int force_baud; /* if non-zero, force the baud rate to this value */
529 int force_rtscts; /* if non-zero, force RTS-CTS to always be enabled */
530 };
531
532 /* Used for TIOCMIWAIT */
533 #define FTDI_STATUS_B0_MASK (FTDI_RS0_CTS | FTDI_RS0_DSR | FTDI_RS0_RI | FTDI_RS0_RLSD)
534 #define FTDI_STATUS_B1_MASK (FTDI_RS_BI)
535 /* End TIOCMIWAIT */
536
537 #define FTDI_IMPL_ASYNC_FLAGS = ( ASYNC_SPD_HI | ASYNC_SPD_VHI \
538 ASYNC_SPD_CUST | ASYNC_SPD_SHI | ASYNC_SPD_WARP )
539
540 /* function prototypes for a FTDI serial converter */
541 static int ftdi_sio_probe (struct usb_serial *serial, const struct usb_device_id *id);
542 static int ftdi_sio_attach (struct usb_serial *serial);
543 static void ftdi_shutdown (struct usb_serial *serial);
544 static int ftdi_open (struct usb_serial_port *port, struct file *filp);
545 static void ftdi_close (struct usb_serial_port *port, struct file *filp);
546 static int ftdi_write (struct usb_serial_port *port, const unsigned char *buf, int count);
547 static int ftdi_write_room (struct usb_serial_port *port);
548 static int ftdi_chars_in_buffer (struct usb_serial_port *port);
549 static void ftdi_write_bulk_callback (struct urb *urb, struct pt_regs *regs);
550 static void ftdi_read_bulk_callback (struct urb *urb, struct pt_regs *regs);
551 static void ftdi_process_read (void *param);
552 static void ftdi_set_termios (struct usb_serial_port *port, struct termios * old);
553 static int ftdi_tiocmget (struct usb_serial_port *port, struct file *file);
554 static int ftdi_tiocmset (struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear);
555 static int ftdi_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg);
556 static void ftdi_break_ctl (struct usb_serial_port *port, int break_state );
557 static void ftdi_throttle (struct usb_serial_port *port);
558 static void ftdi_unthrottle (struct usb_serial_port *port);
559
560 static unsigned short int ftdi_232am_baud_base_to_divisor (int baud, int base);
561 static unsigned short int ftdi_232am_baud_to_divisor (int baud);
562 static __u32 ftdi_232bm_baud_base_to_divisor (int baud, int base);
563 static __u32 ftdi_232bm_baud_to_divisor (int baud);
564
565 static struct usb_serial_driver ftdi_sio_device = {
566 .driver = {
567 .owner = THIS_MODULE,
568 .name = "ftdi_sio",
569 },
570 .description = "FTDI USB Serial Device",
571 .id_table = id_table_combined,
572 .num_interrupt_in = 0,
573 .num_bulk_in = 1,
574 .num_bulk_out = 1,
575 .num_ports = 1,
576 .probe = ftdi_sio_probe,
577 .open = ftdi_open,
578 .close = ftdi_close,
579 .throttle = ftdi_throttle,
580 .unthrottle = ftdi_unthrottle,
581 .write = ftdi_write,
582 .write_room = ftdi_write_room,
583 .chars_in_buffer = ftdi_chars_in_buffer,
584 .read_bulk_callback = ftdi_read_bulk_callback,
585 .write_bulk_callback = ftdi_write_bulk_callback,
586 .tiocmget = ftdi_tiocmget,
587 .tiocmset = ftdi_tiocmset,
588 .ioctl = ftdi_ioctl,
589 .set_termios = ftdi_set_termios,
590 .break_ctl = ftdi_break_ctl,
591 .attach = ftdi_sio_attach,
592 .shutdown = ftdi_shutdown,
593 };
594
595
596 #define WDR_TIMEOUT 5000 /* default urb timeout */
597 #define WDR_SHORT_TIMEOUT 1000 /* shorter urb timeout */
598
599 /* High and low are for DTR, RTS etc etc */
600 #define HIGH 1
601 #define LOW 0
602
603 /*
604 * ***************************************************************************
605 * Utlity functions
606 * ***************************************************************************
607 */
608
609 static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base)
610 {
611 unsigned short int divisor;
612 int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
613 if ((divisor3 & 0x7) == 7) divisor3 ++; // round x.7/8 up to x+1
614 divisor = divisor3 >> 3;
615 divisor3 &= 0x7;
616 if (divisor3 == 1) divisor |= 0xc000; else // 0.125
617 if (divisor3 >= 4) divisor |= 0x4000; else // 0.5
618 if (divisor3 != 0) divisor |= 0x8000; // 0.25
619 if (divisor == 1) divisor = 0; /* special case for maximum baud rate */
620 return divisor;
621 }
622
623 static unsigned short int ftdi_232am_baud_to_divisor(int baud)
624 {
625 return(ftdi_232am_baud_base_to_divisor(baud, 48000000));
626 }
627
628 static __u32 ftdi_232bm_baud_base_to_divisor(int baud, int base)
629 {
630 static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
631 __u32 divisor;
632 int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
633 divisor = divisor3 >> 3;
634 divisor |= (__u32)divfrac[divisor3 & 0x7] << 14;
635 /* Deal with special cases for highest baud rates. */
636 if (divisor == 1) divisor = 0; else // 1.0
637 if (divisor == 0x4001) divisor = 1; // 1.5
638 return divisor;
639 }
640
641 static __u32 ftdi_232bm_baud_to_divisor(int baud)
642 {
643 return(ftdi_232bm_baud_base_to_divisor(baud, 48000000));
644 }
645
646 #define set_mctrl(port, set) update_mctrl((port), (set), 0)
647 #define clear_mctrl(port, clear) update_mctrl((port), 0, (clear))
648
649 static int update_mctrl(struct usb_serial_port *port, unsigned int set, unsigned int clear)
650 {
651 struct ftdi_private *priv = usb_get_serial_port_data(port);
652 char *buf;
653 unsigned urb_value;
654 int rv;
655
656 if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
657 dbg("%s - DTR|RTS not being set|cleared", __FUNCTION__);
658 return 0; /* no change */
659 }
660
661 buf = kmalloc(1, GFP_NOIO);
662 if (!buf) {
663 return -ENOMEM;
664 }
665
666 clear &= ~set; /* 'set' takes precedence over 'clear' */
667 urb_value = 0;
668 if (clear & TIOCM_DTR)
669 urb_value |= FTDI_SIO_SET_DTR_LOW;
670 if (clear & TIOCM_RTS)
671 urb_value |= FTDI_SIO_SET_RTS_LOW;
672 if (set & TIOCM_DTR)
673 urb_value |= FTDI_SIO_SET_DTR_HIGH;
674 if (set & TIOCM_RTS)
675 urb_value |= FTDI_SIO_SET_RTS_HIGH;
676 rv = usb_control_msg(port->serial->dev,
677 usb_sndctrlpipe(port->serial->dev, 0),
678 FTDI_SIO_SET_MODEM_CTRL_REQUEST,
679 FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE,
680 urb_value, priv->interface,
681 buf, 0, WDR_TIMEOUT);
682
683 kfree(buf);
684 if (rv < 0) {
685 err("%s Error from MODEM_CTRL urb: DTR %s, RTS %s",
686 __FUNCTION__,
687 (set & TIOCM_DTR) ? "HIGH" :
688 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
689 (set & TIOCM_RTS) ? "HIGH" :
690 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
691 } else {
692 dbg("%s - DTR %s, RTS %s", __FUNCTION__,
693 (set & TIOCM_DTR) ? "HIGH" :
694 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
695 (set & TIOCM_RTS) ? "HIGH" :
696 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
697 priv->last_dtr_rts = (priv->last_dtr_rts & ~clear) | set;
698 }
699 return rv;
700 }
701
702
703 static __u32 get_ftdi_divisor(struct usb_serial_port * port);
704
705
706 static int change_speed(struct usb_serial_port *port)
707 {
708 struct ftdi_private *priv = usb_get_serial_port_data(port);
709 char *buf;
710 __u16 urb_value;
711 __u16 urb_index;
712 __u32 urb_index_value;
713 int rv;
714
715 buf = kmalloc(1, GFP_NOIO);
716 if (!buf)
717 return -ENOMEM;
718
719 urb_index_value = get_ftdi_divisor(port);
720 urb_value = (__u16)urb_index_value;
721 urb_index = (__u16)(urb_index_value >> 16);
722 if (priv->interface) { /* FT2232C */
723 urb_index = (__u16)((urb_index << 8) | priv->interface);
724 }
725
726 rv = usb_control_msg(port->serial->dev,
727 usb_sndctrlpipe(port->serial->dev, 0),
728 FTDI_SIO_SET_BAUDRATE_REQUEST,
729 FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE,
730 urb_value, urb_index,
731 buf, 0, WDR_SHORT_TIMEOUT);
732
733 kfree(buf);
734 return rv;
735 }
736
737
738 static __u32 get_ftdi_divisor(struct usb_serial_port * port)
739 { /* get_ftdi_divisor */
740 struct ftdi_private *priv = usb_get_serial_port_data(port);
741 __u32 div_value = 0;
742 int div_okay = 1;
743 int baud;
744
745 /*
746 * The logic involved in setting the baudrate can be cleanly split in 3 steps.
747 * Obtaining the actual baud rate is a little tricky since unix traditionally
748 * somehow ignored the possibility to set non-standard baud rates.
749 * 1. Standard baud rates are set in tty->termios->c_cflag
750 * 2. If these are not enough, you can set any speed using alt_speed as follows:
751 * - set tty->termios->c_cflag speed to B38400
752 * - set your real speed in tty->alt_speed; it gets ignored when
753 * alt_speed==0, (or)
754 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
755 * flags & ASYNC_SPD_MASK == ASYNC_SPD_[HI, VHI, SHI, WARP], this just
756 * sets alt_speed to (HI: 57600, VHI: 115200, SHI: 230400, WARP: 460800)
757 * ** Steps 1, 2 are done courtesy of tty_get_baud_rate
758 * 3. You can also set baud rate by setting custom divisor as follows
759 * - set tty->termios->c_cflag speed to B38400
760 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
761 * o flags & ASYNC_SPD_MASK == ASYNC_SPD_CUST
762 * o custom_divisor set to baud_base / your_new_baudrate
763 * ** Step 3 is done courtesy of code borrowed from serial.c - I should really
764 * spend some time and separate+move this common code to serial.c, it is
765 * replicated in nearly every serial driver you see.
766 */
767
768 /* 1. Get the baud rate from the tty settings, this observes alt_speed hack */
769
770 baud = tty_get_baud_rate(port->tty);
771 dbg("%s - tty_get_baud_rate reports speed %d", __FUNCTION__, baud);
772
773 /* 2. Observe async-compatible custom_divisor hack, update baudrate if needed */
774
775 if (baud == 38400 &&
776 ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
777 (priv->custom_divisor)) {
778 baud = priv->baud_base / priv->custom_divisor;
779 dbg("%s - custom divisor %d sets baud rate to %d", __FUNCTION__, priv->custom_divisor, baud);
780 }
781
782 /* 3. Convert baudrate to device-specific divisor */
783
784 if (!baud) baud = 9600;
785 switch(priv->chip_type) {
786 case SIO: /* SIO chip */
787 switch(baud) {
788 case 300: div_value = ftdi_sio_b300; break;
789 case 600: div_value = ftdi_sio_b600; break;
790 case 1200: div_value = ftdi_sio_b1200; break;
791 case 2400: div_value = ftdi_sio_b2400; break;
792 case 4800: div_value = ftdi_sio_b4800; break;
793 case 9600: div_value = ftdi_sio_b9600; break;
794 case 19200: div_value = ftdi_sio_b19200; break;
795 case 38400: div_value = ftdi_sio_b38400; break;
796 case 57600: div_value = ftdi_sio_b57600; break;
797 case 115200: div_value = ftdi_sio_b115200; break;
798 } /* baud */
799 if (div_value == 0) {
800 dbg("%s - Baudrate (%d) requested is not supported", __FUNCTION__, baud);
801 div_value = ftdi_sio_b9600;
802 div_okay = 0;
803 }
804 break;
805 case FT8U232AM: /* 8U232AM chip */
806 if (baud <= 3000000) {
807 div_value = ftdi_232am_baud_to_divisor(baud);
808 } else {
809 dbg("%s - Baud rate too high!", __FUNCTION__);
810 div_value = ftdi_232am_baud_to_divisor(9600);
811 div_okay = 0;
812 }
813 break;
814 case FT232BM: /* FT232BM chip */
815 case FT2232C: /* FT2232C chip */
816 if (baud <= 3000000) {
817 div_value = ftdi_232bm_baud_to_divisor(baud);
818 } else {
819 dbg("%s - Baud rate too high!", __FUNCTION__);
820 div_value = ftdi_232bm_baud_to_divisor(9600);
821 div_okay = 0;
822 }
823 break;
824 } /* priv->chip_type */
825
826 if (div_okay) {
827 dbg("%s - Baud rate set to %d (divisor 0x%lX) on chip %s",
828 __FUNCTION__, baud, (unsigned long)div_value,
829 ftdi_chip_name[priv->chip_type]);
830 }
831
832 return(div_value);
833 }
834
835
836 static int get_serial_info(struct usb_serial_port * port, struct serial_struct __user * retinfo)
837 {
838 struct ftdi_private *priv = usb_get_serial_port_data(port);
839 struct serial_struct tmp;
840
841 if (!retinfo)
842 return -EFAULT;
843 memset(&tmp, 0, sizeof(tmp));
844 tmp.flags = priv->flags;
845 tmp.baud_base = priv->baud_base;
846 tmp.custom_divisor = priv->custom_divisor;
847 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
848 return -EFAULT;
849 return 0;
850 } /* get_serial_info */
851
852
853 static int set_serial_info(struct usb_serial_port * port, struct serial_struct __user * newinfo)
854 { /* set_serial_info */
855 struct ftdi_private *priv = usb_get_serial_port_data(port);
856 struct serial_struct new_serial;
857 struct ftdi_private old_priv;
858
859 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
860 return -EFAULT;
861 old_priv = * priv;
862
863 /* Do error checking and permission checking */
864
865 if (!capable(CAP_SYS_ADMIN)) {
866 if (((new_serial.flags & ~ASYNC_USR_MASK) !=
867 (priv->flags & ~ASYNC_USR_MASK)))
868 return -EPERM;
869 priv->flags = ((priv->flags & ~ASYNC_USR_MASK) |
870 (new_serial.flags & ASYNC_USR_MASK));
871 priv->custom_divisor = new_serial.custom_divisor;
872 goto check_and_exit;
873 }
874
875 if ((new_serial.baud_base != priv->baud_base) &&
876 (new_serial.baud_base < 9600))
877 return -EINVAL;
878
879 /* Make the changes - these are privileged changes! */
880
881 priv->flags = ((priv->flags & ~ASYNC_FLAGS) |
882 (new_serial.flags & ASYNC_FLAGS));
883 priv->custom_divisor = new_serial.custom_divisor;
884
885 port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
886
887 check_and_exit:
888 if ((old_priv.flags & ASYNC_SPD_MASK) !=
889 (priv->flags & ASYNC_SPD_MASK)) {
890 if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_HI)
891 port->tty->alt_speed = 57600;
892 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_VHI)
893 port->tty->alt_speed = 115200;
894 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_SHI)
895 port->tty->alt_speed = 230400;
896 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_WARP)
897 port->tty->alt_speed = 460800;
898 else
899 port->tty->alt_speed = 0;
900 }
901 if (((old_priv.flags & ASYNC_SPD_MASK) !=
902 (priv->flags & ASYNC_SPD_MASK)) ||
903 (((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
904 (old_priv.custom_divisor != priv->custom_divisor))) {
905 change_speed(port);
906 }
907
908 return (0);
909
910 } /* set_serial_info */
911
912
913 /* Determine type of FTDI chip based on USB config and descriptor. */
914 static void ftdi_determine_type(struct usb_serial_port *port)
915 {
916 struct ftdi_private *priv = usb_get_serial_port_data(port);
917 struct usb_serial *serial = port->serial;
918 struct usb_device *udev = serial->dev;
919 unsigned version;
920 unsigned interfaces;
921
922 /* Assume it is not the original SIO device for now. */
923 priv->baud_base = 48000000 / 2;
924 priv->write_offset = 0;
925
926 version = le16_to_cpu(udev->descriptor.bcdDevice);
927 interfaces = udev->actconfig->desc.bNumInterfaces;
928 dbg("%s: bcdDevice = 0x%x, bNumInterfaces = %u", __FUNCTION__,
929 version, interfaces);
930 if (interfaces > 1) {
931 int inter;
932
933 /* Multiple interfaces. Assume FT2232C. */
934 priv->chip_type = FT2232C;
935 /* Determine interface code. */
936 inter = serial->interface->altsetting->desc.bInterfaceNumber;
937 if (inter == 0) {
938 priv->interface = PIT_SIOA;
939 } else {
940 priv->interface = PIT_SIOB;
941 }
942 /* BM-type devices have a bug where bcdDevice gets set
943 * to 0x200 when iSerialNumber is 0. */
944 if (version < 0x500) {
945 dbg("%s: something fishy - bcdDevice too low for multi-interface device",
946 __FUNCTION__);
947 }
948 } else if (version < 0x200) {
949 /* Old device. Assume its the original SIO. */
950 priv->chip_type = SIO;
951 priv->baud_base = 12000000 / 16;
952 priv->write_offset = 1;
953 } else if (version < 0x400) {
954 /* Assume its an FT8U232AM (or FT8U245AM) */
955 /* (It might be a BM because of the iSerialNumber bug,
956 * but it will still work as an AM device.) */
957 priv->chip_type = FT8U232AM;
958 } else {
959 /* Assume its an FT232BM (or FT245BM) */
960 priv->chip_type = FT232BM;
961 }
962 info("Detected %s", ftdi_chip_name[priv->chip_type]);
963 }
964
965
966 /*
967 * ***************************************************************************
968 * Sysfs Attribute
969 * ***************************************************************************
970 */
971
972 static ssize_t show_latency_timer(struct device *dev, struct device_attribute *attr, char *buf)
973 {
974 struct usb_serial_port *port = to_usb_serial_port(dev);
975 struct ftdi_private *priv = usb_get_serial_port_data(port);
976 struct usb_device *udev;
977 unsigned short latency = 0;
978 int rv = 0;
979
980 udev = to_usb_device(dev);
981
982 dbg("%s",__FUNCTION__);
983
984 rv = usb_control_msg(udev,
985 usb_rcvctrlpipe(udev, 0),
986 FTDI_SIO_GET_LATENCY_TIMER_REQUEST,
987 FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE,
988 0, priv->interface,
989 (char*) &latency, 1, WDR_TIMEOUT);
990
991 if (rv < 0) {
992 dev_err(dev, "Unable to read latency timer: %i", rv);
993 return -EIO;
994 }
995 return sprintf(buf, "%i\n", latency);
996 }
997
998 /* Write a new value of the latency timer, in units of milliseconds. */
999 static ssize_t store_latency_timer(struct device *dev, struct device_attribute *attr, const char *valbuf,
1000 size_t count)
1001 {
1002 struct usb_serial_port *port = to_usb_serial_port(dev);
1003 struct ftdi_private *priv = usb_get_serial_port_data(port);
1004 struct usb_device *udev;
1005 char buf[1];
1006 int v = simple_strtoul(valbuf, NULL, 10);
1007 int rv = 0;
1008
1009 udev = to_usb_device(dev);
1010
1011 dbg("%s: setting latency timer = %i", __FUNCTION__, v);
1012
1013 rv = usb_control_msg(udev,
1014 usb_sndctrlpipe(udev, 0),
1015 FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
1016 FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
1017 v, priv->interface,
1018 buf, 0, WDR_TIMEOUT);
1019
1020 if (rv < 0) {
1021 dev_err(dev, "Unable to write latency timer: %i", rv);
1022 return -EIO;
1023 }
1024
1025 return count;
1026 }
1027
1028 /* Write an event character directly to the FTDI register. The ASCII
1029 value is in the low 8 bits, with the enable bit in the 9th bit. */
1030 static ssize_t store_event_char(struct device *dev, struct device_attribute *attr, const char *valbuf,
1031 size_t count)
1032 {
1033 struct usb_serial_port *port = to_usb_serial_port(dev);
1034 struct ftdi_private *priv = usb_get_serial_port_data(port);
1035 struct usb_device *udev;
1036 char buf[1];
1037 int v = simple_strtoul(valbuf, NULL, 10);
1038 int rv = 0;
1039
1040 udev = to_usb_device(dev);
1041
1042 dbg("%s: setting event char = %i", __FUNCTION__, v);
1043
1044 rv = usb_control_msg(udev,
1045 usb_sndctrlpipe(udev, 0),
1046 FTDI_SIO_SET_EVENT_CHAR_REQUEST,
1047 FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE,
1048 v, priv->interface,
1049 buf, 0, WDR_TIMEOUT);
1050
1051 if (rv < 0) {
1052 dbg("Unable to write event character: %i", rv);
1053 return -EIO;
1054 }
1055
1056 return count;
1057 }
1058
1059 static DEVICE_ATTR(latency_timer, S_IWUSR | S_IRUGO, show_latency_timer, store_latency_timer);
1060 static DEVICE_ATTR(event_char, S_IWUSR, NULL, store_event_char);
1061
1062 static void create_sysfs_attrs(struct usb_serial *serial)
1063 {
1064 struct ftdi_private *priv;
1065 struct usb_device *udev;
1066
1067 dbg("%s",__FUNCTION__);
1068
1069 priv = usb_get_serial_port_data(serial->port[0]);
1070 udev = serial->dev;
1071
1072 /* XXX I've no idea if the original SIO supports the event_char
1073 * sysfs parameter, so I'm playing it safe. */
1074 if (priv->chip_type != SIO) {
1075 dbg("sysfs attributes for %s", ftdi_chip_name[priv->chip_type]);
1076 device_create_file(&udev->dev, &dev_attr_event_char);
1077 if (priv->chip_type == FT232BM || priv->chip_type == FT2232C) {
1078 device_create_file(&udev->dev, &dev_attr_latency_timer);
1079 }
1080 }
1081 }
1082
1083 static void remove_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 see create_sysfs_attrs */
1094 if (priv->chip_type != SIO) {
1095 device_remove_file(&udev->dev, &dev_attr_event_char);
1096 if (priv->chip_type == FT232BM || priv->chip_type == FT2232C) {
1097 device_remove_file(&udev->dev, &dev_attr_latency_timer);
1098 }
1099 }
1100
1101 }
1102
1103 /*
1104 * ***************************************************************************
1105 * FTDI driver specific functions
1106 * ***************************************************************************
1107 */
1108
1109 /* Probe function to check for special devices */
1110 static int ftdi_sio_probe (struct usb_serial *serial, const struct usb_device_id *id)
1111 {
1112 usb_set_serial_data(serial, (void *)id->driver_info);
1113
1114 return (0);
1115 }
1116
1117 /* attach subroutine */
1118 static int ftdi_sio_attach (struct usb_serial *serial)
1119 {
1120 struct usb_serial_port *port = serial->port[0];
1121 struct ftdi_private *priv;
1122 struct ftdi_sio_quirk *quirk;
1123
1124 dbg("%s",__FUNCTION__);
1125
1126 priv = kmalloc(sizeof(struct ftdi_private), GFP_KERNEL);
1127 if (!priv){
1128 err("%s- kmalloc(%Zd) failed.", __FUNCTION__, sizeof(struct ftdi_private));
1129 return -ENOMEM;
1130 }
1131 memset(priv, 0, sizeof(*priv));
1132
1133 spin_lock_init(&priv->rx_lock);
1134 init_waitqueue_head(&priv->delta_msr_wait);
1135 /* This will push the characters through immediately rather
1136 than queue a task to deliver them */
1137 priv->flags = ASYNC_LOW_LATENCY;
1138
1139 /* Increase the size of read buffers */
1140 kfree(port->bulk_in_buffer);
1141 port->bulk_in_buffer = kmalloc (BUFSZ, GFP_KERNEL);
1142 if (!port->bulk_in_buffer) {
1143 kfree (priv);
1144 return -ENOMEM;
1145 }
1146 if (port->read_urb) {
1147 port->read_urb->transfer_buffer = port->bulk_in_buffer;
1148 port->read_urb->transfer_buffer_length = BUFSZ;
1149 }
1150
1151 INIT_WORK(&priv->rx_work, ftdi_process_read, port);
1152
1153 /* Free port's existing write urb and transfer buffer. */
1154 if (port->write_urb) {
1155 usb_free_urb (port->write_urb);
1156 port->write_urb = NULL;
1157 }
1158 kfree(port->bulk_out_buffer);
1159 port->bulk_out_buffer = NULL;
1160
1161 usb_set_serial_port_data(serial->port[0], priv);
1162
1163 ftdi_determine_type (serial->port[0]);
1164 create_sysfs_attrs(serial);
1165
1166 /* Check for device requiring special set up. */
1167 quirk = (struct ftdi_sio_quirk *)usb_get_serial_data(serial);
1168 if (quirk && quirk->setup) {
1169 quirk->setup(serial);
1170 }
1171
1172 return (0);
1173 } /* ftdi_sio_attach */
1174
1175
1176 /* Setup for the USB-UIRT device, which requires hardwired
1177 * baudrate (38400 gets mapped to 312500) */
1178 /* Called from usbserial:serial_probe */
1179 static void ftdi_USB_UIRT_setup (struct usb_serial *serial)
1180 {
1181 struct ftdi_private *priv;
1182
1183 dbg("%s",__FUNCTION__);
1184
1185 priv = usb_get_serial_port_data(serial->port[0]);
1186 priv->flags |= ASYNC_SPD_CUST;
1187 priv->custom_divisor = 77;
1188 priv->force_baud = B38400;
1189 } /* ftdi_USB_UIRT_setup */
1190
1191 /* Setup for the HE-TIRA1 device, which requires hardwired
1192 * baudrate (38400 gets mapped to 100000) and RTS-CTS enabled. */
1193 static void ftdi_HE_TIRA1_setup (struct usb_serial *serial)
1194 {
1195 struct ftdi_private *priv;
1196
1197 dbg("%s",__FUNCTION__);
1198
1199 priv = usb_get_serial_port_data(serial->port[0]);
1200 priv->flags |= ASYNC_SPD_CUST;
1201 priv->custom_divisor = 240;
1202 priv->force_baud = B38400;
1203 priv->force_rtscts = 1;
1204 } /* ftdi_HE_TIRA1_setup */
1205
1206
1207 /* ftdi_shutdown is called from usbserial:usb_serial_disconnect
1208 * it is called when the usb device is disconnected
1209 *
1210 * usbserial:usb_serial_disconnect
1211 * calls __serial_close for each open of the port
1212 * shutdown is called then (ie ftdi_shutdown)
1213 */
1214
1215
1216 static void ftdi_shutdown (struct usb_serial *serial)
1217 { /* ftdi_shutdown */
1218
1219 struct usb_serial_port *port = serial->port[0];
1220 struct ftdi_private *priv = usb_get_serial_port_data(port);
1221
1222 dbg("%s", __FUNCTION__);
1223
1224 remove_sysfs_attrs(serial);
1225
1226 /* all open ports are closed at this point
1227 * (by usbserial.c:__serial_close, which calls ftdi_close)
1228 */
1229
1230 if (priv) {
1231 usb_set_serial_port_data(port, NULL);
1232 kfree(priv);
1233 }
1234 } /* ftdi_shutdown */
1235
1236
1237 static int ftdi_open (struct usb_serial_port *port, struct file *filp)
1238 { /* ftdi_open */
1239 struct termios tmp_termios;
1240 struct usb_device *dev = port->serial->dev;
1241 struct ftdi_private *priv = usb_get_serial_port_data(port);
1242 unsigned long flags;
1243
1244 int result = 0;
1245 char buf[1]; /* Needed for the usb_control_msg I think */
1246
1247 dbg("%s", __FUNCTION__);
1248
1249
1250 port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
1251
1252 /* No error checking for this (will get errors later anyway) */
1253 /* See ftdi_sio.h for description of what is reset */
1254 usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1255 FTDI_SIO_RESET_REQUEST, FTDI_SIO_RESET_REQUEST_TYPE,
1256 FTDI_SIO_RESET_SIO,
1257 priv->interface, buf, 0, WDR_TIMEOUT);
1258
1259 /* Termios defaults are set by usb_serial_init. We don't change
1260 port->tty->termios - this would loose speed settings, etc.
1261 This is same behaviour as serial.c/rs_open() - Kuba */
1262
1263 /* ftdi_set_termios will send usb control messages */
1264 ftdi_set_termios(port, &tmp_termios);
1265
1266 /* FIXME: Flow control might be enabled, so it should be checked -
1267 we have no control of defaults! */
1268 /* Turn on RTS and DTR since we are not flow controlling by default */
1269 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1270
1271 /* Not throttled */
1272 spin_lock_irqsave(&priv->rx_lock, flags);
1273 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
1274 spin_unlock_irqrestore(&priv->rx_lock, flags);
1275
1276 /* Start reading from the device */
1277 priv->rx_processed = 0;
1278 usb_fill_bulk_urb(port->read_urb, dev,
1279 usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress),
1280 port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
1281 ftdi_read_bulk_callback, port);
1282 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
1283 if (result)
1284 err("%s - failed submitting read urb, error %d", __FUNCTION__, result);
1285
1286
1287 return result;
1288 } /* ftdi_open */
1289
1290
1291
1292 /*
1293 * usbserial:__serial_close only calls ftdi_close if the point is open
1294 *
1295 * This only gets called when it is the last close
1296 *
1297 *
1298 */
1299
1300 static void ftdi_close (struct usb_serial_port *port, struct file *filp)
1301 { /* ftdi_close */
1302 unsigned int c_cflag = port->tty->termios->c_cflag;
1303 struct ftdi_private *priv = usb_get_serial_port_data(port);
1304 char buf[1];
1305
1306 dbg("%s", __FUNCTION__);
1307
1308 if (c_cflag & HUPCL){
1309 /* Disable flow control */
1310 if (usb_control_msg(port->serial->dev,
1311 usb_sndctrlpipe(port->serial->dev, 0),
1312 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1313 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1314 0, priv->interface, buf, 0,
1315 WDR_TIMEOUT) < 0) {
1316 err("error from flowcontrol urb");
1317 }
1318
1319 /* drop RTS and DTR */
1320 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1321 } /* Note change no line if hupcl is off */
1322
1323 /* cancel any scheduled reading */
1324 cancel_delayed_work(&priv->rx_work);
1325 flush_scheduled_work();
1326
1327 /* shutdown our bulk read */
1328 if (port->read_urb)
1329 usb_kill_urb(port->read_urb);
1330 } /* ftdi_close */
1331
1332
1333
1334 /* The SIO requires the first byte to have:
1335 * B0 1
1336 * B1 0
1337 * B2..7 length of message excluding byte 0
1338 *
1339 * The new devices do not require this byte
1340 */
1341 static int ftdi_write (struct usb_serial_port *port,
1342 const unsigned char *buf, int count)
1343 { /* ftdi_write */
1344 struct ftdi_private *priv = usb_get_serial_port_data(port);
1345 struct urb *urb;
1346 unsigned char *buffer;
1347 int data_offset ; /* will be 1 for the SIO and 0 otherwise */
1348 int status;
1349 int transfer_size;
1350
1351 dbg("%s port %d, %d bytes", __FUNCTION__, port->number, count);
1352
1353 if (count == 0) {
1354 dbg("write request of 0 bytes");
1355 return 0;
1356 }
1357
1358 data_offset = priv->write_offset;
1359 dbg("data_offset set to %d",data_offset);
1360
1361 /* Determine total transfer size */
1362 transfer_size = count;
1363 if (data_offset > 0) {
1364 /* Original sio needs control bytes too... */
1365 transfer_size += (data_offset *
1366 ((count + (PKTSZ - 1 - data_offset)) /
1367 (PKTSZ - data_offset)));
1368 }
1369
1370 buffer = kmalloc (transfer_size, GFP_ATOMIC);
1371 if (!buffer) {
1372 err("%s ran out of kernel memory for urb ...", __FUNCTION__);
1373 return -ENOMEM;
1374 }
1375
1376 urb = usb_alloc_urb(0, GFP_ATOMIC);
1377 if (!urb) {
1378 err("%s - no more free urbs", __FUNCTION__);
1379 kfree (buffer);
1380 return -ENOMEM;
1381 }
1382
1383 /* Copy data */
1384 if (data_offset > 0) {
1385 /* Original sio requires control byte at start of each packet. */
1386 int user_pktsz = PKTSZ - data_offset;
1387 int todo = count;
1388 unsigned char *first_byte = buffer;
1389 const unsigned char *current_position = buf;
1390
1391 while (todo > 0) {
1392 if (user_pktsz > todo) {
1393 user_pktsz = todo;
1394 }
1395 /* Write the control byte at the front of the packet*/
1396 *first_byte = 1 | ((user_pktsz) << 2);
1397 /* Copy data for packet */
1398 memcpy (first_byte + data_offset,
1399 current_position, user_pktsz);
1400 first_byte += user_pktsz + data_offset;
1401 current_position += user_pktsz;
1402 todo -= user_pktsz;
1403 }
1404 } else {
1405 /* No control byte required. */
1406 /* Copy in the data to send */
1407 memcpy (buffer, buf, count);
1408 }
1409
1410 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, transfer_size, buffer);
1411
1412 /* fill the buffer and send it */
1413 usb_fill_bulk_urb(urb, port->serial->dev,
1414 usb_sndbulkpipe(port->serial->dev, port->bulk_out_endpointAddress),
1415 buffer, transfer_size,
1416 ftdi_write_bulk_callback, port);
1417
1418 status = usb_submit_urb(urb, GFP_ATOMIC);
1419 if (status) {
1420 err("%s - failed submitting write urb, error %d", __FUNCTION__, status);
1421 count = status;
1422 kfree (buffer);
1423 }
1424
1425 /* we are done with this urb, so let the host driver
1426 * really free it when it is finished with it */
1427 usb_free_urb (urb);
1428
1429 dbg("%s write returning: %d", __FUNCTION__, count);
1430 return count;
1431 } /* ftdi_write */
1432
1433
1434 /* This function may get called when the device is closed */
1435
1436 static void ftdi_write_bulk_callback (struct urb *urb, struct pt_regs *regs)
1437 {
1438 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1439
1440 /* free up the transfer buffer, as usb_free_urb() does not do this */
1441 kfree (urb->transfer_buffer);
1442
1443 dbg("%s - port %d", __FUNCTION__, port->number);
1444
1445 if (urb->status) {
1446 dbg("nonzero write bulk status received: %d", urb->status);
1447 return;
1448 }
1449
1450 schedule_work(&port->work);
1451 } /* ftdi_write_bulk_callback */
1452
1453
1454 static int ftdi_write_room( struct usb_serial_port *port )
1455 {
1456 dbg("%s - port %d", __FUNCTION__, port->number);
1457
1458 /*
1459 * We really can take anything the user throws at us
1460 * but let's pick a nice big number to tell the tty
1461 * layer that we have lots of free space
1462 */
1463 return 2048;
1464 } /* ftdi_write_room */
1465
1466
1467 static int ftdi_chars_in_buffer (struct usb_serial_port *port)
1468 { /* ftdi_chars_in_buffer */
1469 dbg("%s - port %d", __FUNCTION__, port->number);
1470
1471 /*
1472 * We can't really account for how much data we
1473 * have sent out, but hasn't made it through to the
1474 * device, so just tell the tty layer that everything
1475 * is flushed.
1476 */
1477 return 0;
1478 } /* ftdi_chars_in_buffer */
1479
1480
1481
1482 static void ftdi_read_bulk_callback (struct urb *urb, struct pt_regs *regs)
1483 { /* ftdi_read_bulk_callback */
1484 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1485 struct tty_struct *tty;
1486 struct ftdi_private *priv;
1487
1488 if (urb->number_of_packets > 0) {
1489 err("%s transfer_buffer_length %d actual_length %d number of packets %d",__FUNCTION__,
1490 urb->transfer_buffer_length, urb->actual_length, urb->number_of_packets );
1491 err("%s transfer_flags %x ", __FUNCTION__,urb->transfer_flags );
1492 }
1493
1494 dbg("%s - port %d", __FUNCTION__, port->number);
1495
1496 if (port->open_count <= 0)
1497 return;
1498
1499 tty = port->tty;
1500 if (!tty) {
1501 dbg("%s - bad tty pointer - exiting",__FUNCTION__);
1502 return;
1503 }
1504
1505 priv = usb_get_serial_port_data(port);
1506 if (!priv) {
1507 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1508 return;
1509 }
1510
1511 if (urb != port->read_urb) {
1512 err("%s - Not my urb!", __FUNCTION__);
1513 }
1514
1515 if (urb->status) {
1516 /* This will happen at close every time so it is a dbg not an err */
1517 dbg("(this is ok on close) nonzero read bulk status received: %d", urb->status);
1518 return;
1519 }
1520
1521 ftdi_process_read(port);
1522
1523 } /* ftdi_read_bulk_callback */
1524
1525
1526 static void ftdi_process_read (void *param)
1527 { /* ftdi_process_read */
1528 struct usb_serial_port *port = (struct usb_serial_port*)param;
1529 struct urb *urb;
1530 struct tty_struct *tty;
1531 struct ftdi_private *priv;
1532 char error_flag;
1533 unsigned char *data;
1534
1535 int i;
1536 int result;
1537 int need_flip;
1538 int packet_offset;
1539 unsigned long flags;
1540
1541 dbg("%s - port %d", __FUNCTION__, port->number);
1542
1543 if (port->open_count <= 0)
1544 return;
1545
1546 tty = port->tty;
1547 if (!tty) {
1548 dbg("%s - bad tty pointer - exiting",__FUNCTION__);
1549 return;
1550 }
1551
1552 priv = usb_get_serial_port_data(port);
1553 if (!priv) {
1554 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1555 return;
1556 }
1557
1558 urb = port->read_urb;
1559 if (!urb) {
1560 dbg("%s - bad read_urb pointer - exiting", __FUNCTION__);
1561 return;
1562 }
1563
1564 data = urb->transfer_buffer;
1565
1566 if (priv->rx_processed) {
1567 dbg("%s - already processed: %d bytes, %d remain", __FUNCTION__,
1568 priv->rx_processed,
1569 urb->actual_length - priv->rx_processed);
1570 } else {
1571 /* The first two bytes of every read packet are status */
1572 if (urb->actual_length > 2) {
1573 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
1574 } else {
1575 dbg("Status only: %03oo %03oo",data[0],data[1]);
1576 }
1577 }
1578
1579
1580 /* TO DO -- check for hung up line and handle appropriately: */
1581 /* send hangup */
1582 /* See acm.c - you do a tty_hangup - eg tty_hangup(tty) */
1583 /* if CD is dropped and the line is not CLOCAL then we should hangup */
1584
1585 need_flip = 0;
1586 for (packet_offset = priv->rx_processed; packet_offset < urb->actual_length; packet_offset += PKTSZ) {
1587 int length;
1588
1589 /* Compare new line status to the old one, signal if different */
1590 /* N.B. packet may be processed more than once, but differences
1591 * are only processed once. */
1592 if (priv != NULL) {
1593 char new_status = data[packet_offset+0] & FTDI_STATUS_B0_MASK;
1594 if (new_status != priv->prev_status) {
1595 priv->diff_status |= new_status ^ priv->prev_status;
1596 wake_up_interruptible(&priv->delta_msr_wait);
1597 priv->prev_status = new_status;
1598 }
1599 }
1600
1601 length = min(PKTSZ, urb->actual_length-packet_offset)-2;
1602 if (length < 0) {
1603 err("%s - bad packet length: %d", __FUNCTION__, length+2);
1604 length = 0;
1605 }
1606
1607 /* have to make sure we don't overflow the buffer
1608 with tty_insert_flip_char's */
1609 if (tty->flip.count+length > TTY_FLIPBUF_SIZE) {
1610 tty_flip_buffer_push(tty);
1611 need_flip = 0;
1612
1613 if (tty->flip.count != 0) {
1614 /* flip didn't work, this happens when ftdi_process_read() is
1615 * called from ftdi_unthrottle, because TTY_DONT_FLIP is set */
1616 dbg("%s - flip buffer push failed", __FUNCTION__);
1617 break;
1618 }
1619 }
1620 if (priv->rx_flags & THROTTLED) {
1621 dbg("%s - throttled", __FUNCTION__);
1622 break;
1623 }
1624 if (tty->ldisc.receive_room(tty)-tty->flip.count < length) {
1625 /* break out & wait for throttling/unthrottling to happen */
1626 dbg("%s - receive room low", __FUNCTION__);
1627 break;
1628 }
1629
1630 /* Handle errors and break */
1631 error_flag = TTY_NORMAL;
1632 /* Although the device uses a bitmask and hence can have multiple */
1633 /* errors on a packet - the order here sets the priority the */
1634 /* error is returned to the tty layer */
1635
1636 if ( data[packet_offset+1] & FTDI_RS_OE ) {
1637 error_flag = TTY_OVERRUN;
1638 dbg("OVERRRUN error");
1639 }
1640 if ( data[packet_offset+1] & FTDI_RS_BI ) {
1641 error_flag = TTY_BREAK;
1642 dbg("BREAK received");
1643 }
1644 if ( data[packet_offset+1] & FTDI_RS_PE ) {
1645 error_flag = TTY_PARITY;
1646 dbg("PARITY error");
1647 }
1648 if ( data[packet_offset+1] & FTDI_RS_FE ) {
1649 error_flag = TTY_FRAME;
1650 dbg("FRAMING error");
1651 }
1652 if (length > 0) {
1653 for (i = 2; i < length+2; i++) {
1654 /* Note that the error flag is duplicated for
1655 every character received since we don't know
1656 which character it applied to */
1657 tty_insert_flip_char(tty, data[packet_offset+i], error_flag);
1658 }
1659 need_flip = 1;
1660 }
1661
1662 #ifdef NOT_CORRECT_BUT_KEEPING_IT_FOR_NOW
1663 /* if a parity error is detected you get status packets forever
1664 until a character is sent without a parity error.
1665 This doesn't work well since the application receives a never
1666 ending stream of bad data - even though new data hasn't been sent.
1667 Therefore I (bill) have taken this out.
1668 However - this might make sense for framing errors and so on
1669 so I am leaving the code in for now.
1670 */
1671 else {
1672 if (error_flag != TTY_NORMAL){
1673 dbg("error_flag is not normal");
1674 /* In this case it is just status - if that is an error send a bad character */
1675 if(tty->flip.count >= TTY_FLIPBUF_SIZE) {
1676 tty_flip_buffer_push(tty);
1677 }
1678 tty_insert_flip_char(tty, 0xff, error_flag);
1679 need_flip = 1;
1680 }
1681 }
1682 #endif
1683 } /* "for(packet_offset=0..." */
1684
1685 /* Low latency */
1686 if (need_flip) {
1687 tty_flip_buffer_push(tty);
1688 }
1689
1690 if (packet_offset < urb->actual_length) {
1691 /* not completely processed - record progress */
1692 priv->rx_processed = packet_offset;
1693 dbg("%s - incomplete, %d bytes processed, %d remain",
1694 __FUNCTION__, packet_offset,
1695 urb->actual_length - packet_offset);
1696 /* check if we were throttled while processing */
1697 spin_lock_irqsave(&priv->rx_lock, flags);
1698 if (priv->rx_flags & THROTTLED) {
1699 priv->rx_flags |= ACTUALLY_THROTTLED;
1700 spin_unlock_irqrestore(&priv->rx_lock, flags);
1701 dbg("%s - deferring remainder until unthrottled",
1702 __FUNCTION__);
1703 return;
1704 }
1705 spin_unlock_irqrestore(&priv->rx_lock, flags);
1706 /* if the port is closed stop trying to read */
1707 if (port->open_count > 0){
1708 /* delay processing of remainder */
1709 schedule_delayed_work(&priv->rx_work, 1);
1710 } else {
1711 dbg("%s - port is closed", __FUNCTION__);
1712 }
1713 return;
1714 }
1715
1716 /* urb is completely processed */
1717 priv->rx_processed = 0;
1718
1719 /* if the port is closed stop trying to read */
1720 if (port->open_count > 0){
1721 /* Continue trying to always read */
1722 usb_fill_bulk_urb(port->read_urb, port->serial->dev,
1723 usb_rcvbulkpipe(port->serial->dev, port->bulk_in_endpointAddress),
1724 port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
1725 ftdi_read_bulk_callback, port);
1726
1727 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1728 if (result)
1729 err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
1730 }
1731
1732 return;
1733 } /* ftdi_process_read */
1734
1735
1736 static void ftdi_break_ctl( struct usb_serial_port *port, int break_state )
1737 {
1738 struct ftdi_private *priv = usb_get_serial_port_data(port);
1739 __u16 urb_value = 0;
1740 char buf[1];
1741
1742 /* break_state = -1 to turn on break, and 0 to turn off break */
1743 /* see drivers/char/tty_io.c to see it used */
1744 /* last_set_data_urb_value NEVER has the break bit set in it */
1745
1746 if (break_state) {
1747 urb_value = priv->last_set_data_urb_value | FTDI_SIO_SET_BREAK;
1748 } else {
1749 urb_value = priv->last_set_data_urb_value;
1750 }
1751
1752
1753 if (usb_control_msg(port->serial->dev, usb_sndctrlpipe(port->serial->dev, 0),
1754 FTDI_SIO_SET_DATA_REQUEST,
1755 FTDI_SIO_SET_DATA_REQUEST_TYPE,
1756 urb_value , priv->interface,
1757 buf, 0, WDR_TIMEOUT) < 0) {
1758 err("%s FAILED to enable/disable break state (state was %d)", __FUNCTION__,break_state);
1759 }
1760
1761 dbg("%s break state is %d - urb is %d", __FUNCTION__,break_state, urb_value);
1762
1763 }
1764
1765
1766 /* old_termios contains the original termios settings and tty->termios contains
1767 * the new setting to be used
1768 * WARNING: set_termios calls this with old_termios in kernel space
1769 */
1770
1771 static void ftdi_set_termios (struct usb_serial_port *port, struct termios *old_termios)
1772 { /* ftdi_termios */
1773 struct usb_device *dev = port->serial->dev;
1774 unsigned int cflag = port->tty->termios->c_cflag;
1775 struct ftdi_private *priv = usb_get_serial_port_data(port);
1776 __u16 urb_value; /* will hold the new flags */
1777 char buf[1]; /* Perhaps I should dynamically alloc this? */
1778
1779 // Added for xon/xoff support
1780 unsigned int iflag = port->tty->termios->c_iflag;
1781 unsigned char vstop;
1782 unsigned char vstart;
1783
1784 dbg("%s", __FUNCTION__);
1785
1786 /* Force baud rate if this device requires it, unless it is set to B0. */
1787 if (priv->force_baud && ((port->tty->termios->c_cflag & CBAUD) != B0)) {
1788 dbg("%s: forcing baud rate for this device", __FUNCTION__);
1789 port->tty->termios->c_cflag &= ~CBAUD;
1790 port->tty->termios->c_cflag |= priv->force_baud;
1791 }
1792
1793 /* Force RTS-CTS if this device requires it. */
1794 if (priv->force_rtscts) {
1795 dbg("%s: forcing rtscts for this device", __FUNCTION__);
1796 port->tty->termios->c_cflag |= CRTSCTS;
1797 }
1798
1799 cflag = port->tty->termios->c_cflag;
1800
1801 /* FIXME -For this cut I don't care if the line is really changing or
1802 not - so just do the change regardless - should be able to
1803 compare old_termios and tty->termios */
1804 /* NOTE These routines can get interrupted by
1805 ftdi_sio_read_bulk_callback - need to examine what this
1806 means - don't see any problems yet */
1807
1808 /* Set number of data bits, parity, stop bits */
1809
1810 urb_value = 0;
1811 urb_value |= (cflag & CSTOPB ? FTDI_SIO_SET_DATA_STOP_BITS_2 :
1812 FTDI_SIO_SET_DATA_STOP_BITS_1);
1813 urb_value |= (cflag & PARENB ?
1814 (cflag & PARODD ? FTDI_SIO_SET_DATA_PARITY_ODD :
1815 FTDI_SIO_SET_DATA_PARITY_EVEN) :
1816 FTDI_SIO_SET_DATA_PARITY_NONE);
1817 if (cflag & CSIZE) {
1818 switch (cflag & CSIZE) {
1819 case CS5: urb_value |= 5; dbg("Setting CS5"); break;
1820 case CS6: urb_value |= 6; dbg("Setting CS6"); break;
1821 case CS7: urb_value |= 7; dbg("Setting CS7"); break;
1822 case CS8: urb_value |= 8; dbg("Setting CS8"); break;
1823 default:
1824 err("CSIZE was set but not CS5-CS8");
1825 }
1826 }
1827
1828 /* This is needed by the break command since it uses the same command - but is
1829 * or'ed with this value */
1830 priv->last_set_data_urb_value = urb_value;
1831
1832 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1833 FTDI_SIO_SET_DATA_REQUEST,
1834 FTDI_SIO_SET_DATA_REQUEST_TYPE,
1835 urb_value , priv->interface,
1836 buf, 0, WDR_SHORT_TIMEOUT) < 0) {
1837 err("%s FAILED to set databits/stopbits/parity", __FUNCTION__);
1838 }
1839
1840 /* Now do the baudrate */
1841 if ((cflag & CBAUD) == B0 ) {
1842 /* Disable flow control */
1843 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1844 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1845 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1846 0, priv->interface,
1847 buf, 0, WDR_TIMEOUT) < 0) {
1848 err("%s error from disable flowcontrol urb", __FUNCTION__);
1849 }
1850 /* Drop RTS and DTR */
1851 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1852 } else {
1853 /* set the baudrate determined before */
1854 if (change_speed(port)) {
1855 err("%s urb failed to set baudrate", __FUNCTION__);
1856 }
1857 /* Ensure RTS and DTR are raised when baudrate changed from 0 */
1858 if ((old_termios->c_cflag & CBAUD) == B0) {
1859 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1860 }
1861 }
1862
1863 /* Set flow control */
1864 /* Note device also supports DTR/CD (ugh) and Xon/Xoff in hardware */
1865 if (cflag & CRTSCTS) {
1866 dbg("%s Setting to CRTSCTS flow control", __FUNCTION__);
1867 if (usb_control_msg(dev,
1868 usb_sndctrlpipe(dev, 0),
1869 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1870 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1871 0 , (FTDI_SIO_RTS_CTS_HS | priv->interface),
1872 buf, 0, WDR_TIMEOUT) < 0) {
1873 err("urb failed to set to rts/cts flow control");
1874 }
1875
1876 } else {
1877 /*
1878 * Xon/Xoff code
1879 *
1880 * Check the IXOFF status in the iflag component of the termios structure
1881 * if IXOFF is not set, the pre-xon/xoff code is executed.
1882 */
1883 if (iflag & IXOFF) {
1884 dbg("%s request to enable xonxoff iflag=%04x",__FUNCTION__,iflag);
1885 // Try to enable the XON/XOFF on the ftdi_sio
1886 // Set the vstart and vstop -- could have been done up above where
1887 // a lot of other dereferencing is done but that would be very
1888 // inefficient as vstart and vstop are not always needed
1889 vstart=port->tty->termios->c_cc[VSTART];
1890 vstop=port->tty->termios->c_cc[VSTOP];
1891 urb_value=(vstop << 8) | (vstart);
1892
1893 if (usb_control_msg(dev,
1894 usb_sndctrlpipe(dev, 0),
1895 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1896 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1897 urb_value , (FTDI_SIO_XON_XOFF_HS
1898 | priv->interface),
1899 buf, 0, WDR_TIMEOUT) < 0) {
1900 err("urb failed to set to xon/xoff flow control");
1901 }
1902 } else {
1903 /* else clause to only run if cfag ! CRTSCTS and iflag ! XOFF */
1904 /* CHECKME Assuming XON/XOFF handled by tty stack - not by device */
1905 dbg("%s Turning off hardware flow control", __FUNCTION__);
1906 if (usb_control_msg(dev,
1907 usb_sndctrlpipe(dev, 0),
1908 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1909 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1910 0, priv->interface,
1911 buf, 0, WDR_TIMEOUT) < 0) {
1912 err("urb failed to clear flow control");
1913 }
1914 }
1915
1916 }
1917 return;
1918 } /* ftdi_termios */
1919
1920
1921 static int ftdi_tiocmget (struct usb_serial_port *port, struct file *file)
1922 {
1923 struct ftdi_private *priv = usb_get_serial_port_data(port);
1924 unsigned char buf[2];
1925 int ret;
1926
1927 dbg("%s TIOCMGET", __FUNCTION__);
1928 switch (priv->chip_type) {
1929 case SIO:
1930 /* Request the status from the device */
1931 if ((ret = usb_control_msg(port->serial->dev,
1932 usb_rcvctrlpipe(port->serial->dev, 0),
1933 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
1934 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
1935 0, 0,
1936 buf, 1, WDR_TIMEOUT)) < 0 ) {
1937 err("%s Could not get modem status of device - err: %d", __FUNCTION__,
1938 ret);
1939 return(ret);
1940 }
1941 break;
1942 case FT8U232AM:
1943 case FT232BM:
1944 case FT2232C:
1945 /* the 8U232AM returns a two byte value (the sio is a 1 byte value) - in the same
1946 format as the data returned from the in point */
1947 if ((ret = usb_control_msg(port->serial->dev,
1948 usb_rcvctrlpipe(port->serial->dev, 0),
1949 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
1950 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
1951 0, priv->interface,
1952 buf, 2, WDR_TIMEOUT)) < 0 ) {
1953 err("%s Could not get modem status of device - err: %d", __FUNCTION__,
1954 ret);
1955 return(ret);
1956 }
1957 break;
1958 default:
1959 return -EFAULT;
1960 break;
1961 }
1962
1963 return (buf[0] & FTDI_SIO_DSR_MASK ? TIOCM_DSR : 0) |
1964 (buf[0] & FTDI_SIO_CTS_MASK ? TIOCM_CTS : 0) |
1965 (buf[0] & FTDI_SIO_RI_MASK ? TIOCM_RI : 0) |
1966 (buf[0] & FTDI_SIO_RLSD_MASK ? TIOCM_CD : 0) |
1967 priv->last_dtr_rts;
1968 }
1969
1970 static int ftdi_tiocmset(struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear)
1971 {
1972 dbg("%s TIOCMSET", __FUNCTION__);
1973 return update_mctrl(port, set, clear);
1974 }
1975
1976
1977 static int ftdi_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
1978 {
1979 struct ftdi_private *priv = usb_get_serial_port_data(port);
1980
1981 dbg("%s cmd 0x%04x", __FUNCTION__, cmd);
1982
1983 /* Based on code from acm.c and others */
1984 switch (cmd) {
1985
1986 case TIOCGSERIAL: /* gets serial port data */
1987 return get_serial_info(port, (struct serial_struct __user *) arg);
1988
1989 case TIOCSSERIAL: /* sets serial port data */
1990 return set_serial_info(port, (struct serial_struct __user *) arg);
1991
1992 /*
1993 * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1994 * - mask passed in arg for lines of interest
1995 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1996 * Caller should use TIOCGICOUNT to see which one it was.
1997 *
1998 * This code is borrowed from linux/drivers/char/serial.c
1999 */
2000 case TIOCMIWAIT:
2001 while (priv != NULL) {
2002 interruptible_sleep_on(&priv->delta_msr_wait);
2003 /* see if a signal did it */
2004 if (signal_pending(current))
2005 return -ERESTARTSYS;
2006 else {
2007 char diff = priv->diff_status;
2008
2009 if (diff == 0) {
2010 return -EIO; /* no change => error */
2011 }
2012
2013 /* Consume all events */
2014 priv->diff_status = 0;
2015
2016 /* Return 0 if caller wanted to know about these bits */
2017 if ( ((arg & TIOCM_RNG) && (diff & FTDI_RS0_RI)) ||
2018 ((arg & TIOCM_DSR) && (diff & FTDI_RS0_DSR)) ||
2019 ((arg & TIOCM_CD) && (diff & FTDI_RS0_RLSD)) ||
2020 ((arg & TIOCM_CTS) && (diff & FTDI_RS0_CTS)) ) {
2021 return 0;
2022 }
2023 /*
2024 * Otherwise caller can't care less about what happened,
2025 * and so we continue to wait for more events.
2026 */
2027 }
2028 }
2029 return(0);
2030 break;
2031 default:
2032 break;
2033
2034 }
2035
2036
2037 /* This is not necessarily an error - turns out the higher layers will do
2038 * some ioctls itself (see comment above)
2039 */
2040 dbg("%s arg not supported - it was 0x%04x - check /usr/include/asm/ioctls.h", __FUNCTION__, cmd);
2041
2042 return(-ENOIOCTLCMD);
2043 } /* ftdi_ioctl */
2044
2045
2046 static void ftdi_throttle (struct usb_serial_port *port)
2047 {
2048 struct ftdi_private *priv = usb_get_serial_port_data(port);
2049 unsigned long flags;
2050
2051 dbg("%s - port %d", __FUNCTION__, port->number);
2052
2053 spin_lock_irqsave(&priv->rx_lock, flags);
2054 priv->rx_flags |= THROTTLED;
2055 spin_unlock_irqrestore(&priv->rx_lock, flags);
2056 }
2057
2058
2059 static void ftdi_unthrottle (struct usb_serial_port *port)
2060 {
2061 struct ftdi_private *priv = usb_get_serial_port_data(port);
2062 int actually_throttled;
2063 unsigned long flags;
2064
2065 dbg("%s - port %d", __FUNCTION__, port->number);
2066
2067 spin_lock_irqsave(&priv->rx_lock, flags);
2068 actually_throttled = priv->rx_flags & ACTUALLY_THROTTLED;
2069 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
2070 spin_unlock_irqrestore(&priv->rx_lock, flags);
2071
2072 if (actually_throttled)
2073 schedule_work(&priv->rx_work);
2074 }
2075
2076 static int __init ftdi_init (void)
2077 {
2078 int retval;
2079
2080 dbg("%s", __FUNCTION__);
2081 if (vendor > 0 && product > 0) {
2082 /* Add user specified VID/PID to reserved element of table. */
2083 int i;
2084 for (i = 0; id_table_combined[i].idVendor; i++)
2085 ;
2086 id_table_combined[i].match_flags = USB_DEVICE_ID_MATCH_DEVICE;
2087 id_table_combined[i].idVendor = vendor;
2088 id_table_combined[i].idProduct = product;
2089 }
2090 retval = usb_serial_register(&ftdi_sio_device);
2091 if (retval)
2092 goto failed_sio_register;
2093 retval = usb_register(&ftdi_driver);
2094 if (retval)
2095 goto failed_usb_register;
2096
2097 info(DRIVER_VERSION ":" DRIVER_DESC);
2098 return 0;
2099 failed_usb_register:
2100 usb_serial_deregister(&ftdi_sio_device);
2101 failed_sio_register:
2102 return retval;
2103 }
2104
2105
2106 static void __exit ftdi_exit (void)
2107 {
2108
2109 dbg("%s", __FUNCTION__);
2110
2111 usb_deregister (&ftdi_driver);
2112 usb_serial_deregister (&ftdi_sio_device);
2113
2114 }
2115
2116
2117 module_init(ftdi_init);
2118 module_exit(ftdi_exit);
2119
2120 MODULE_AUTHOR( DRIVER_AUTHOR );
2121 MODULE_DESCRIPTION( DRIVER_DESC );
2122 MODULE_LICENSE("GPL");
2123
2124 module_param(debug, bool, S_IRUGO | S_IWUSR);
2125 MODULE_PARM_DESC(debug, "Debug enabled or not");
2126 module_param(vendor, ushort, 0);
2127 MODULE_PARM_DESC(vendor, "User specified vendor ID (default="
2128 __MODULE_STRING(FTDI_VID)")");
2129 module_param(product, ushort, 0);
2130 MODULE_PARM_DESC(vendor, "User specified product ID");
2131
Linux kernel - Deliverables
This page took 0.080141 seconds and 6 git commands to generate.