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