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