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