]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blob - drivers/usb/serial/ftdi_sio.c
projects / mirror_ubuntu-artful-kernel.git / blob
? search:


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