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