Ticket #11563: ftdi_sio.c

File ftdi_sio.c, 106.6 KB (added by shepsoft@…, 6 years ago)

ftdi driver source

Line 
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 * (31/May/2012) Paul Sheppard
21 *      Backported most FTDI devices from version 1.6 (plus some other
22 *      improvements) for use with OpenWRT / DD-WRT (kernel 2.6.23)
23 *
24 * (21/Jul/2004) Ian Abbott
25 *      Incorporated Steven Turner's code to add support for the FT2232C chip.
26 *      The prelimilary port to the 2.6 kernel was by Rus V. Brushkoff.  I have
27 *      fixed a couple of things.
28 *
29 * (27/May/2004) Ian Abbott
30 *      Improved throttling code, mostly stolen from the WhiteHEAT driver.
31 *
32 * (26/Mar/2004) Jan Capek
33 *      Added PID's for ICD-U20/ICD-U40 - incircuit PIC debuggers from CCS Inc.
34 *
35 * (09/Feb/2004) Ian Abbott
36 *      Changed full name of USB-UIRT device to avoid "/" character.
37 *      Added FTDI's alternate PID (0x6006) for FT232/245 devices.
38 *      Added PID for "ELV USB Module UO100" from Stefan Frings.
39 *
40 * (21/Oct/2003) Ian Abbott
41 *      Renamed some VID/PID macros for Matrix Orbital and Perle Systems
42 *      devices.  Removed Matrix Orbital and Perle Systems devices from the
43 *      8U232AM device table, but left them in the FT232BM table, as they are
44 *      known to use only FT232BM.
45 *
46 * (17/Oct/2003) Scott Allen
47 *      Added vid/pid for Perle Systems UltraPort USB serial converters
48 *
49 * (21/Sep/2003) Ian Abbott
50 *      Added VID/PID for Omnidirectional Control Technology US101 USB to
51 *      RS-232 adapter (also rebadged as Dick Smith Electronics XH6381).
52 *      VID/PID supplied by Donald Gordon.
53 *
54 * (19/Aug/2003) Ian Abbott
55 *      Freed urb's transfer buffer in write bulk callback.
56 *      Omitted some paranoid checks in write bulk callback that don't matter.
57 *      Scheduled work in write bulk callback regardless of port's open count.
58 *
59 * (05/Aug/2003) Ian Abbott
60 *      Added VID/PID for ID TECH IDT1221U USB to RS-232 adapter.
61 *      VID/PID provided by Steve Briggs.
62 *
63 * (23/Jul/2003) Ian Abbott
64 *      Added PIDs for CrystalFontz 547, 633, 631, 635, 640 and 640 from
65 *      Wayne Wylupski.
66 *
67 * (10/Jul/2003) David Glance
68 *      Added PID for DSS-20 SyncStation cradle for Sony-Ericsson P800.
69 *
70 * (27/Jun/2003) Ian Abbott
71 *      Reworked the urb handling logic.  We have no more pool, but dynamically
72 *      allocate the urb and the transfer buffer on the fly.  In testing this
73 *      does not incure any measurable overhead.  This also relies on the fact
74 *      that we have proper reference counting logic for urbs.  I nicked this
75 *      from Greg KH's Visor driver.
76 *
77 * (23/Jun/2003) Ian Abbott
78 *      Reduced flip buffer pushes and corrected a data length test in
79 *      ftdi_read_bulk_callback.
80 *      Defererence pointers after any paranoid checks, not before.
81 *
82 * (21/Jun/2003) Erik Nygren
83 *      Added support for Home Electronics Tira-1 IR transceiver using FT232BM chip.
84 *      See <http://www.home-electro.com/tira1.htm>.  Only operates properly
85 *      at 100000 and RTS-CTS, so set custom divisor mode on startup.
86 *      Also force the Tira-1 and USB-UIRT to only use their custom baud rates.
87 *
88 * (18/Jun/2003) Ian Abbott
89 *      Added Device ID of the USB relais from Rudolf Gugler (backported from
90 *      Philipp Gühring's patch for 2.5.x kernel).
91 *      Moved read transfer buffer reallocation into startup function.
92 *      Free existing write urb and transfer buffer in startup function.
93 *      Only use urbs in write urb pool that were successfully allocated.
94 *      Moved some constant macros out of functions.
95 *      Minor whitespace and comment changes.
96 *
97 * (12/Jun/2003) David Norwood
98 *      Added support for USB-UIRT IR transceiver using 8U232AM chip.
99 *      See <http://home.earthlink.net/~jrhees/USBUIRT/index.htm>.  Only
100 *      operates properly at 312500, so set custom divisor mode on startup.
101 *
102 * (12/Jun/2003) Ian Abbott
103 *      Added Sealevel SeaLINK+ 210x, 220x, 240x, 280x vid/pids from Tuan Hoang
104 *      - I've eliminated some that don't seem to exist!
105 *      Added Home Electronics Tira-1 IR transceiver pid from Chris Horn
106 *      Some whitespace/coding-style cleanups
107 *
108 * (11/Jun/2003) Ian Abbott
109 *      Fixed unsafe spinlock usage in ftdi_write
110 *
111 * (24/Feb/2003) Richard Shooter
112 *      Increase read buffer size to improve read speeds at higher baud rates
113 *      (specifically tested with up to 1Mb/sec at 1.5M baud)
114 *
115 * (23/Feb/2003) John Wilkins
116 *      Added Xon/xoff flow control (activating support in the ftdi device)
117 *      Added vid/pid for Videonetworks/Homechoice (UK ISP)
118 *
119 * (23/Feb/2003) Bill Ryder
120 *      Added matrix orb device vid/pids from Wayne Wylupski
121 *
122 * (19/Feb/2003) Ian Abbott
123 *      For TIOCSSERIAL, set alt_speed to 0 when ASYNC_SPD_MASK value has
124 *      changed to something other than ASYNC_SPD_HI, ASYNC_SPD_VHI,
125 *      ASYNC_SPD_SHI or ASYNC_SPD_WARP.  Also, unless ASYNC_SPD_CUST is in
126 *      force, don't bother changing baud rate when custom_divisor has changed.
127 *
128 * (18/Feb/2003) Ian Abbott
129 *      Fixed TIOCMGET handling to include state of DTR and RTS, the state
130 *      of which are now saved by set_dtr() and set_rts().
131 *      Fixed improper storage class for buf in set_dtr() and set_rts().
132 *      Added FT232BM chip type and support for its extra baud rates (compared
133 *      to FT8U232AM).
134 *      Took account of special case divisor values for highest baud rates of
135 *      FT8U232AM and FT232BM.
136 *      For TIOCSSERIAL, forced alt_speed to 0 when ASYNC_SPD_CUST kludge used,
137 *      as previous alt_speed setting is now stale.
138 *      Moved startup code common between the startup routines for the
139 *      different chip types into a common subroutine.
140 *
141 * (17/Feb/2003) Bill Ryder
142 *      Added write urb buffer pool on a per device basis
143 *      Added more checking for open file on callbacks (fixed OOPS)
144 *      Added CrystalFontz 632 and 634 PIDs
145 *         (thanx to CrystalFontz for the sample devices - they flushed out
146 *           some driver bugs)
147 *      Minor debugging message changes
148 *      Added throttle, unthrottle and chars_in_buffer functions
149 *      Fixed FTDI_SIO (the original device) bug
150 *      Fixed some shutdown handling
151 *
152 *
153 *
154 *
155 * (07/Jun/2002) Kuba Ober
156 *      Changed FTDI_SIO_BASE_BAUD_TO_DIVISOR macro into ftdi_baud_to_divisor
157 *      function. It was getting too complex.
158 *      Fix the divisor calculation logic which was setting divisor of 0.125
159 *      instead of 0.5 for fractional parts of divisor equal to 5/8, 6/8, 7/8.
160 *      Also make it bump up the divisor to next integer in case of 7/8 - it's
161 *      a better approximation.
162 *
163 * (25/Jul/2002) Bill Ryder inserted Dmitri's TIOCMIWAIT patch
164 *      Not tested by me but it doesn't break anything I use.
165 *
166 * (04/Jan/2002) Kuba Ober
167 *      Implemented 38400 baudrate kludge, where it can be substituted with other
168 *        values. That's the only way to set custom baudrates.
169 *      Implemented TIOCSSERIAL, TIOCGSERIAL ioctl's so that setserial is happy.
170 *      FIXME: both baudrate things should eventually go to usbserial.c as other
171 *        devices may need that functionality too. Actually, it can probably be
172 *        merged in serial.c somehow - too many drivers repeat this code over
173 *        and over.
174 *      Fixed baudrate forgetfulness - open() used to reset baudrate to 9600 every time.
175 *      Divisors for baudrates are calculated by a macro.
176 *      Small code cleanups. Ugly whitespace changes for Plato's sake only ;-].
177 *
178 * (04/Nov/2001) Bill Ryder
179 *      Fixed bug in read_bulk_callback where incorrect urb buffer was used.
180 *      Cleaned up write offset calculation
181 *      Added write_room since default values can be incorrect for sio
182 *      Changed write_bulk_callback to use same queue_task as other drivers
183 *        (the previous version caused panics)
184 *      Removed port iteration code since the device only has one I/O port and it
185 *        was wrong anyway.
186 *
187 * (31/May/2001) gkh
188 *      Switched from using spinlock to a semaphore, which fixes lots of problems.
189 *
190 * (23/May/2001)   Bill Ryder
191 *      Added runtime debug patch (thanx Tyson D Sawyer).
192 *      Cleaned up comments for 8U232
193 *      Added parity, framing and overrun error handling
194 *      Added receive break handling.
195 *
196 * (04/08/2001) gb
197 *      Identify version on module load.
198 *
199 * (18/March/2001) Bill Ryder
200 *      (Not released)
201 *      Added send break handling. (requires kernel patch too)
202 *      Fixed 8U232AM hardware RTS/CTS etc status reporting.
203 *      Added flipbuf fix copied from generic device
204 *
205 * (12/3/2000) Bill Ryder
206 *      Added support for 8U232AM device.
207 *      Moved PID and VIDs into header file only.
208 *      Turned on low-latency for the tty (device will do high baudrates)
209 *      Added shutdown routine to close files when device removed.
210 *      More debug and error message cleanups.
211 *
212 * (11/13/2000) Bill Ryder
213 *      Added spinlock protected open code and close code.
214 *      Multiple opens work (sort of - see webpage mentioned above).
215 *      Cleaned up comments. Removed multiple PID/VID definitions.
216 *      Factorised cts/dtr code
217 *      Made use of __FUNCTION__ in dbg's
218 *
219 * (11/01/2000) Adam J. Richter
220 *      usb_device_id table support
221 *
222 * (10/05/2000) gkh
223 *      Fixed bug with urb->dev not being set properly, now that the usb
224 *      core needs it.
225 *
226 * (09/11/2000) gkh
227 *      Removed DEBUG #ifdefs with call to usb_serial_debug_data
228 *
229 * (07/19/2000) gkh
230 *      Added module_init and module_exit functions to handle the fact that this
231 *      driver is a loadable module now.
232 *
233 * (04/04/2000) Bill Ryder
234 *      Fixed bugs in TCGET/TCSET ioctls (by removing them - they are
235 *        handled elsewhere in the tty io driver chain).
236 *
237 * (03/30/2000) Bill Ryder
238 *      Implemented lots of ioctls
239 *      Fixed a race condition in write
240 *      Changed some dbg's to errs
241 *
242 * (03/26/2000) gkh
243 *      Split driver up into device specific pieces.
244 *
245 */
246
247/* Bill Ryder - bryder@sgi.com - wrote the FTDI_SIO implementation */
248/* Thanx to FTDI for so kindly providing details of the protocol required */
249/*   to talk to the device */
250/* Thanx to gkh and the rest of the usb dev group for all code I have assimilated :-) */
251
252#include <linux/kernel.h>
253#include <linux/errno.h>
254#include <linux/init.h>
255#include <linux/slab.h>
256#include <linux/tty.h>
257#include <linux/tty_driver.h>
258#include <linux/tty_flip.h>
259#include <linux/module.h>
260#include <linux/spinlock.h>
261#include <asm/uaccess.h>
262#include <linux/usb.h>
263#include <linux/serial.h>
264#include <linux/usb/serial.h>
265#include "ftdi_sio.h"
266#include "ftdi_sio_ids.h"
267
268/*
269 * Version Information
270 */
271#define DRIVER_VERSION "v1.4.3.1"
272#define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>, Bill Ryder <bryder@sgi.com>, Kuba Ober <kuba@mareimbrium.org>, Paul Sheppard <shep(nospace)soft(at)gmail.com>"
273#define DRIVER_DESC "USB FTDI Serial Converters Driver"
274
275static int debug;
276static __u16 vendor = FTDI_VID;
277static __u16 product;
278
279struct ftdi_private {
280        ftdi_chip_type_t chip_type;
281                                /* type of the device, either SIO or FT8U232AM */
282        int baud_base;          /* baud base clock for divisor setting */
283        int custom_divisor;     /* custom_divisor kludge, this is for baud_base (different from what goes to the chip!) */
284        __u16 last_set_data_urb_value ;
285                                /* the last data state set - needed for doing a break */
286        int write_offset;       /* This is the offset in the usb data block to write the serial data -
287                                 * it is different between devices
288                                 */
289        int flags;              /* some ASYNC_xxxx flags are supported */
290        unsigned long last_dtr_rts;     /* saved modem control outputs */
291        wait_queue_head_t delta_msr_wait; /* Used for TIOCMIWAIT */
292        char prev_status, diff_status;        /* Used for TIOCMIWAIT */
293        __u8 rx_flags;          /* receive state flags (throttling) */
294        spinlock_t rx_lock;     /* spinlock for receive state */
295        struct delayed_work rx_work;
296        struct usb_serial_port *port;
297        int rx_processed;
298        unsigned long rx_bytes;
299
300        __u16 interface;        /* FT2232C port interface (0 for FT232/245) */
301
302        int force_baud;         /* if non-zero, force the baud rate to this value */
303        int force_rtscts;       /* if non-zero, force RTS-CTS to always be enabled */
304
305        spinlock_t tx_lock;     /* spinlock for transmit state */
306        unsigned long tx_bytes;
307        unsigned long tx_outstanding_bytes;
308        unsigned long tx_outstanding_urbs;
309        unsigned short max_packet_size;
310};
311
312/* struct ftdi_sio_quirk is used by devices requiring special attention. */
313struct ftdi_sio_quirk {
314        int (*probe)(struct usb_serial *);
315        void (*port_probe)(struct ftdi_private *); /* Special settings for probed ports. */
316};
317
318static int   ftdi_jtag_probe(struct usb_serial *serial);
319static int   ftdi_mtxorb_hack_setup(struct usb_serial *serial);
320static int   ftdi_NDI_device_setup(struct usb_serial *serial);
321static int   ftdi_stmclite_probe(struct usb_serial *serial);
322static int   ftdi_8u2232c_probe(struct usb_serial *serial);
323static void  ftdi_USB_UIRT_setup(struct ftdi_private *priv);
324static void  ftdi_HE_TIRA1_setup(struct ftdi_private *priv);
325
326static struct ftdi_sio_quirk ftdi_jtag_quirk = {
327        .probe  = ftdi_jtag_probe,
328};
329
330static struct ftdi_sio_quirk ftdi_mtxorb_hack_quirk = {
331        .probe  = ftdi_mtxorb_hack_setup,
332};
333
334static struct ftdi_sio_quirk ftdi_NDI_device_quirk = {
335        .probe  = ftdi_NDI_device_setup,
336};
337
338static struct ftdi_sio_quirk ftdi_USB_UIRT_quirk = {
339        .port_probe = ftdi_USB_UIRT_setup,
340};
341
342static struct ftdi_sio_quirk ftdi_HE_TIRA1_quirk = {
343        .port_probe = ftdi_HE_TIRA1_setup,
344};
345
346static struct ftdi_sio_quirk ftdi_stmclite_quirk = {
347        .probe  = ftdi_stmclite_probe,
348};
349
350static struct ftdi_sio_quirk ftdi_8u2232c_quirk = {
351        .probe  = ftdi_8u2232c_probe,
352};
353
354/*
355 * The 8U232AM has the same API as the sio except for:
356 * - it can support MUCH higher baudrates; up to:
357 *   o 921600 for RS232 and 2000000 for RS422/485 at 48MHz
358 *   o 230400 at 12MHz
359 *   so .. 8U232AM's baudrate setting codes are different
360 * - it has a two byte status code.
361 * - it returns characters every 16ms (the FTDI does it every 40ms)
362 *
363 * the bcdDevice value is used to differentiate FT232BM and FT245BM from
364 * the earlier FT8U232AM and FT8U232BM.  For now, include all known VID/PID
365 * combinations in both tables.
366 * FIXME: perhaps bcdDevice can also identify 12MHz FT8U232AM devices,
367 * but I don't know if those ever went into mass production. [Ian Abbott]
368 */
369
370
371
372static struct usb_device_id id_table_combined [] = {
373        { USB_DEVICE(FTDI_VID, FTDI_ZEITCONTROL_TAGTRACE_MIFARE_PID) },
374        { USB_DEVICE(FTDI_VID, FTDI_CTI_MINI_PID) },
375        { USB_DEVICE(FTDI_VID, FTDI_CTI_NANO_PID) },
376        { USB_DEVICE(FTDI_VID, FTDI_AMC232_PID) },
377        { USB_DEVICE(FTDI_VID, FTDI_CANUSB_PID) },
378        { USB_DEVICE(FTDI_VID, FTDI_CANDAPTER_PID) },
379        { USB_DEVICE(FTDI_VID, FTDI_NXTCAM_PID) },
380        { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_0_PID) },
381        { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_1_PID) },
382        { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_2_PID) },
383        { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_3_PID) },
384        { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_4_PID) },
385        { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_5_PID) },
386        { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_6_PID) },
387        { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_7_PID) },
388        { USB_DEVICE(FTDI_VID, FTDI_USINT_CAT_PID) },
389        { USB_DEVICE(FTDI_VID, FTDI_USINT_WKEY_PID) },
390        { USB_DEVICE(FTDI_VID, FTDI_USINT_RS232_PID) },
391        { USB_DEVICE(FTDI_VID, FTDI_ACTZWAVE_PID) },
392        { USB_DEVICE(FTDI_VID, FTDI_IRTRANS_PID) },
393        { USB_DEVICE(FTDI_VID, FTDI_IPLUS_PID) },
394        { USB_DEVICE(FTDI_VID, FTDI_IPLUS2_PID) },
395        { USB_DEVICE(FTDI_VID, FTDI_DMX4ALL) },
396        { USB_DEVICE(FTDI_VID, FTDI_SIO_PID) },
397        { USB_DEVICE(FTDI_VID, FTDI_8U232AM_PID) },
398        { USB_DEVICE(FTDI_VID, FTDI_8U232AM_ALT_PID) },
399        { USB_DEVICE(FTDI_VID, FTDI_232RL_PID) },
400        { USB_DEVICE(FTDI_VID, FTDI_8U2232C_PID) ,
401                .driver_info = (kernel_ulong_t)&ftdi_8u2232c_quirk },
402        { USB_DEVICE(FTDI_VID, FTDI_4232H_PID) },
403        { USB_DEVICE(FTDI_VID, FTDI_232H_PID) },
404        { USB_DEVICE(FTDI_VID, FTDI_FTX_PID) },
405        { USB_DEVICE(FTDI_VID, FTDI_MICRO_CHAMELEON_PID) },
406        { USB_DEVICE(FTDI_VID, FTDI_RELAIS_PID) },
407        { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_PID) },
408        { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_SNIFFER_PID) },
409        { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_THROTTLE_PID) },
410        { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_GATEWAY_PID) },
411        { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_GBM_PID) },
412        { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_IOBOARD_PID) },
413        { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_MINI_IOBOARD_PID) },
414        { USB_DEVICE(FTDI_VID, FTDI_SPROG_II) },
415        { USB_DEVICE(FTDI_VID, FTDI_LENZ_LIUSB_PID) },
416        { USB_DEVICE(FTDI_VID, FTDI_XF_632_PID) },
417        { USB_DEVICE(FTDI_VID, FTDI_XF_634_PID) },
418        { USB_DEVICE(FTDI_VID, FTDI_XF_547_PID) },
419        { USB_DEVICE(FTDI_VID, FTDI_XF_633_PID) },
420        { USB_DEVICE(FTDI_VID, FTDI_XF_631_PID) },
421        { USB_DEVICE(FTDI_VID, FTDI_XF_635_PID) },
422        { USB_DEVICE(FTDI_VID, FTDI_XF_640_PID) },
423        { USB_DEVICE(FTDI_VID, FTDI_XF_642_PID) },
424        { USB_DEVICE(FTDI_VID, FTDI_DSS20_PID) },
425        { USB_DEVICE(FTDI_VID, FTDI_URBAN_0_PID) },
426        { USB_DEVICE(FTDI_VID, FTDI_URBAN_1_PID) },
427        { USB_DEVICE(FTDI_NF_RIC_VID, FTDI_NF_RIC_PID) },
428        { USB_DEVICE(FTDI_VID, FTDI_VNHCPCUSB_D_PID) },
429        { USB_DEVICE(FTDI_VID, FTDI_MTXORB_0_PID) },
430        { USB_DEVICE(FTDI_VID, FTDI_MTXORB_1_PID) },
431        { USB_DEVICE(FTDI_VID, FTDI_MTXORB_2_PID) },
432        { USB_DEVICE(FTDI_VID, FTDI_MTXORB_3_PID) },
433        { USB_DEVICE(FTDI_VID, FTDI_MTXORB_4_PID) },
434        { USB_DEVICE(FTDI_VID, FTDI_MTXORB_5_PID) },
435        { USB_DEVICE(FTDI_VID, FTDI_MTXORB_6_PID) },
436        { USB_DEVICE(FTDI_VID, FTDI_R2000KU_TRUE_RNG) },
437        { USB_DEVICE(FTDI_VID, FTDI_VARDAAN_PID) },
438        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0100_PID) },
439        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0101_PID) },
440        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0102_PID) },
441        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0103_PID) },
442        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0104_PID) },
443        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0105_PID) },
444        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0106_PID) },
445        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0107_PID) },
446        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0108_PID) },
447        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0109_PID) },
448        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010A_PID) },
449        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010B_PID) },
450        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010C_PID) },
451        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010D_PID) },
452        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010E_PID) },
453        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010F_PID) },
454        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0110_PID) },
455        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0111_PID) },
456        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0112_PID) },
457        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0113_PID) },
458        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0114_PID) },
459        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0115_PID) },
460        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0116_PID) },
461        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0117_PID) },
462        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0118_PID) },
463        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0119_PID) },
464        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011A_PID) },
465        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011B_PID) },
466        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011C_PID) },
467        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011D_PID) },
468        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011E_PID) },
469        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011F_PID) },
470        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0120_PID) },
471        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0121_PID) },
472        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0122_PID) },
473        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0123_PID) },
474        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0124_PID) },
475        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0125_PID) },
476        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0126_PID) },
477        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0127_PID),
478                .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
479        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0128_PID) },
480        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0129_PID) },
481        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012A_PID) },
482        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012B_PID) },
483        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012C_PID),
484                .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
485        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012D_PID) },
486        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012E_PID) },
487        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012F_PID) },
488        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0130_PID) },
489        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0131_PID) },
490        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0132_PID) },
491        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0133_PID) },
492        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0134_PID) },
493        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0135_PID) },
494        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0136_PID) },
495        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0137_PID) },
496        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0138_PID) },
497        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0139_PID) },
498        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013A_PID) },
499        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013B_PID) },
500        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013C_PID) },
501        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013D_PID) },
502        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013E_PID) },
503        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013F_PID) },
504        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0140_PID) },
505        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0141_PID) },
506        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0142_PID) },
507        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0143_PID) },
508        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0144_PID) },
509        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0145_PID) },
510        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0146_PID) },
511        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0147_PID) },
512        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0148_PID) },
513        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0149_PID) },
514        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014A_PID) },
515        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014B_PID) },
516        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014C_PID) },
517        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014D_PID) },
518        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014E_PID) },
519        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014F_PID) },
520        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0150_PID) },
521        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0151_PID) },
522        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0152_PID) },
523        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0153_PID),
524                .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
525        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0154_PID),
526                .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
527        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0155_PID),
528                .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
529        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0156_PID),
530                .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
531        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0157_PID),
532                .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
533        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0158_PID),
534                .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
535        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0159_PID) },
536        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015A_PID) },
537        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015B_PID) },
538        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015C_PID) },
539        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015D_PID) },
540        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015E_PID) },
541        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015F_PID) },
542        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0160_PID) },
543        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0161_PID) },
544        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0162_PID) },
545        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0163_PID) },
546        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0164_PID) },
547        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0165_PID) },
548        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0166_PID) },
549        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0167_PID) },
550        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0168_PID) },
551        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0169_PID) },
552        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016A_PID) },
553        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016B_PID) },
554        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016C_PID) },
555        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016D_PID) },
556        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016E_PID) },
557        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016F_PID) },
558        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0170_PID) },
559        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0171_PID) },
560        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0172_PID) },
561        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0173_PID) },
562        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0174_PID) },
563        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0175_PID) },
564        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0176_PID) },
565        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0177_PID) },
566        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0178_PID) },
567        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0179_PID) },
568        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017A_PID) },
569        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017B_PID) },
570        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017C_PID) },
571        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017D_PID) },
572        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017E_PID) },
573        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017F_PID) },
574        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0180_PID) },
575        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0181_PID) },
576        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0182_PID) },
577        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0183_PID) },
578        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0184_PID) },
579        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0185_PID) },
580        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0186_PID) },
581        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0187_PID) },
582        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0188_PID) },
583        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0189_PID) },
584        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018A_PID) },
585        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018B_PID) },
586        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018C_PID) },
587        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018D_PID) },
588        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018E_PID) },
589        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018F_PID) },
590        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0190_PID) },
591        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0191_PID) },
592        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0192_PID) },
593        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0193_PID) },
594        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0194_PID) },
595        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0195_PID) },
596        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0196_PID) },
597        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0197_PID) },
598        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0198_PID) },
599        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0199_PID) },
600        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019A_PID) },
601        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019B_PID) },
602        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019C_PID) },
603        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019D_PID) },
604        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019E_PID) },
605        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019F_PID) },
606        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A0_PID) },
607        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A1_PID) },
608        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A2_PID) },
609        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A3_PID) },
610        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A4_PID) },
611        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A5_PID) },
612        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A6_PID) },
613        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A7_PID) },
614        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A8_PID) },
615        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A9_PID) },
616        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AA_PID) },
617        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AB_PID) },
618        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AC_PID) },
619        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AD_PID) },
620        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AE_PID) },
621        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AF_PID) },
622        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B0_PID) },
623        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B1_PID) },
624        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B2_PID) },
625        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B3_PID) },
626        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B4_PID) },
627        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B5_PID) },
628        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B6_PID) },
629        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B7_PID) },
630        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B8_PID) },
631        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B9_PID) },
632        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BA_PID) },
633        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BB_PID) },
634        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BC_PID) },
635        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BD_PID) },
636        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BE_PID) },
637        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BF_PID) },
638        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C0_PID) },
639        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C1_PID) },
640        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C2_PID) },
641        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C3_PID) },
642        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C4_PID) },
643        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C5_PID) },
644        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C6_PID) },
645        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C7_PID) },
646        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C8_PID) },
647        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C9_PID) },
648        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CA_PID) },
649        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CB_PID) },
650        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CC_PID) },
651        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CD_PID) },
652        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CE_PID) },
653        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CF_PID) },
654        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D0_PID) },
655        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D1_PID) },
656        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D2_PID) },
657        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D3_PID) },
658        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D4_PID) },
659        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D5_PID) },
660        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D6_PID) },
661        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D7_PID) },
662        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D8_PID) },
663        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D9_PID) },
664        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DA_PID) },
665        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DB_PID) },
666        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DC_PID) },
667        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DD_PID) },
668        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DE_PID) },
669        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DF_PID) },
670        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E0_PID) },
671        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E1_PID) },
672        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E2_PID) },
673        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E3_PID) },
674        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E4_PID) },
675        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E5_PID) },
676        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E6_PID) },
677        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E7_PID) },
678        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E8_PID) },
679        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E9_PID) },
680        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EA_PID) },
681        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EB_PID) },
682        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EC_PID) },
683        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01ED_PID) },
684        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EE_PID) },
685        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EF_PID) },
686        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F0_PID) },
687        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F1_PID) },
688        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F2_PID) },
689        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F3_PID) },
690        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F4_PID) },
691        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F5_PID) },
692        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F6_PID) },
693        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F7_PID) },
694        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F8_PID) },
695        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F9_PID) },
696        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FA_PID) },
697        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FB_PID) },
698        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FC_PID) },
699        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FD_PID) },
700        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FE_PID) },
701        { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FF_PID) },
702        { USB_DEVICE(FTDI_VID, FTDI_PERLE_ULTRAPORT_PID) },
703        { USB_DEVICE(FTDI_VID, FTDI_PIEGROUP_PID) },
704        { USB_DEVICE(FTDI_VID, FTDI_TNC_X_PID) },
705        { USB_DEVICE(FTDI_VID, FTDI_USBX_707_PID) },
706        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2101_PID) },
707        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2102_PID) },
708        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2103_PID) },
709        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2104_PID) },
710        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2106_PID) },
711        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_1_PID) },
712        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_2_PID) },
713        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_1_PID) },
714        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_2_PID) },
715        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_1_PID) },
716        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_2_PID) },
717        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_1_PID) },
718        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_2_PID) },
719        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_3_PID) },
720        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_4_PID) },
721        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_1_PID) },
722        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_2_PID) },
723        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_3_PID) },
724        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_4_PID) },
725        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_1_PID) },
726        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_2_PID) },
727        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_3_PID) },
728        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_4_PID) },
729        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_1_PID) },
730        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_2_PID) },
731        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_3_PID) },
732        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_4_PID) },
733        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_5_PID) },
734        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_6_PID) },
735        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_7_PID) },
736        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_8_PID) },
737        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_1_PID) },
738        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_2_PID) },
739        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_3_PID) },
740        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_4_PID) },
741        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_5_PID) },
742        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_6_PID) },
743        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_7_PID) },
744        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_8_PID) },
745        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_1_PID) },
746        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_2_PID) },
747        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_3_PID) },
748        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_4_PID) },
749        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_5_PID) },
750        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_6_PID) },
751        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_7_PID) },
752        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_8_PID) },
753        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803R_1_PID) },
754        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803R_2_PID) },
755        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803R_3_PID) },
756        { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803R_4_PID) },
757        { USB_DEVICE(IDTECH_VID, IDTECH_IDT1221U_PID) },
758        { USB_DEVICE(OCT_VID, OCT_US101_PID) },
759        { USB_DEVICE(OCT_VID, OCT_DK201_PID) },
760        { USB_DEVICE(FTDI_VID, FTDI_HE_TIRA1_PID),
761                .driver_info = (kernel_ulong_t)&ftdi_HE_TIRA1_quirk },
762        { USB_DEVICE(FTDI_VID, FTDI_USB_UIRT_PID),
763                .driver_info = (kernel_ulong_t)&ftdi_USB_UIRT_quirk },
764        { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_1) },
765        { USB_DEVICE(FTDI_VID, PROTEGO_R2X0) },
766        { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_3) },
767        { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_4) },
768        { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E808_PID) },
769        { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E809_PID) },
770        { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80A_PID) },
771        { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80B_PID) },
772        { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80C_PID) },
773        { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80D_PID) },
774        { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80E_PID) },
775        { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80F_PID) },
776        { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E888_PID) },
777        { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E889_PID) },
778        { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88A_PID) },
779        { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88B_PID) },
780        { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88C_PID) },
781        { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88D_PID) },
782        { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88E_PID) },
783        { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88F_PID) },
784        { USB_DEVICE(FTDI_VID, FTDI_ELV_UO100_PID) },
785        { USB_DEVICE(FTDI_VID, FTDI_ELV_UM100_PID) },
786        { USB_DEVICE(FTDI_VID, FTDI_ELV_UR100_PID) },
787        { USB_DEVICE(FTDI_VID, FTDI_ELV_ALC8500_PID) },
788        { USB_DEVICE(FTDI_VID, FTDI_PYRAMID_PID) },
789        { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1000PC_PID) },
790        { USB_DEVICE(FTDI_VID, FTDI_IBS_US485_PID) },
791        { USB_DEVICE(FTDI_VID, FTDI_IBS_PICPRO_PID) },
792        { USB_DEVICE(FTDI_VID, FTDI_IBS_PCMCIA_PID) },
793        { USB_DEVICE(FTDI_VID, FTDI_IBS_PK1_PID) },
794        { USB_DEVICE(FTDI_VID, FTDI_IBS_RS232MON_PID) },
795        { USB_DEVICE(FTDI_VID, FTDI_IBS_APP70_PID) },
796        { USB_DEVICE(FTDI_VID, FTDI_IBS_PEDO_PID) },
797        { USB_DEVICE(FTDI_VID, FTDI_IBS_PROD_PID) },
798        { USB_DEVICE(FTDI_VID, FTDI_TAVIR_STK500_PID) },
799        /*
800         * ELV devices:
801         */
802        { USB_DEVICE(FTDI_VID, FTDI_ELV_USR_PID) },
803        { USB_DEVICE(FTDI_VID, FTDI_ELV_MSM1_PID) },
804        { USB_DEVICE(FTDI_VID, FTDI_ELV_KL100_PID) },
805        { USB_DEVICE(FTDI_VID, FTDI_ELV_WS550_PID) },
806        { USB_DEVICE(FTDI_VID, FTDI_ELV_EC3000_PID) },
807        { USB_DEVICE(FTDI_VID, FTDI_ELV_WS888_PID) },
808        { USB_DEVICE(FTDI_VID, FTDI_ELV_TWS550_PID) },
809        { USB_DEVICE(FTDI_VID, FTDI_ELV_FEM_PID) },
810        { USB_DEVICE(FTDI_VID, FTDI_ELV_CLI7000_PID) },
811        { USB_DEVICE(FTDI_VID, FTDI_ELV_PPS7330_PID) },
812        { USB_DEVICE(FTDI_VID, FTDI_ELV_TFM100_PID) },
813        { USB_DEVICE(FTDI_VID, FTDI_ELV_UDF77_PID) },
814        { USB_DEVICE(FTDI_VID, FTDI_ELV_UIO88_PID) },
815        { USB_DEVICE(FTDI_VID, FTDI_ELV_UAD8_PID) },
816        { USB_DEVICE(FTDI_VID, FTDI_ELV_UDA7_PID) },
817        { USB_DEVICE(FTDI_VID, FTDI_ELV_USI2_PID) },
818        { USB_DEVICE(FTDI_VID, FTDI_ELV_T1100_PID) },
819        { USB_DEVICE(FTDI_VID, FTDI_ELV_PCD200_PID) },
820        { USB_DEVICE(FTDI_VID, FTDI_ELV_ULA200_PID) },
821        { USB_DEVICE(FTDI_VID, FTDI_ELV_CSI8_PID) },
822        { USB_DEVICE(FTDI_VID, FTDI_ELV_EM1000DL_PID) },
823        { USB_DEVICE(FTDI_VID, FTDI_ELV_PCK100_PID) },
824        { USB_DEVICE(FTDI_VID, FTDI_ELV_RFP500_PID) },
825        { USB_DEVICE(FTDI_VID, FTDI_ELV_FS20SIG_PID) },
826        { USB_DEVICE(FTDI_VID, FTDI_ELV_UTP8_PID) },
827        { USB_DEVICE(FTDI_VID, FTDI_ELV_WS300PC_PID) },
828        { USB_DEVICE(FTDI_VID, FTDI_ELV_WS444PC_PID) },
829        { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1300PC_PID) },
830        { USB_DEVICE(FTDI_VID, FTDI_ELV_EM1010PC_PID) },
831        { USB_DEVICE(FTDI_VID, FTDI_ELV_WS500_PID) },
832        { USB_DEVICE(FTDI_VID, FTDI_ELV_HS485_PID) },
833        { USB_DEVICE(FTDI_VID, FTDI_ELV_UMS100_PID) },
834        { USB_DEVICE(FTDI_VID, FTDI_ELV_TFD128_PID) },
835        { USB_DEVICE(FTDI_VID, FTDI_ELV_FM3RX_PID) },
836        { USB_DEVICE(FTDI_VID, FTDI_ELV_WS777_PID) },
837        { USB_DEVICE(FTDI_VID, LINX_SDMUSBQSS_PID) },
838        { USB_DEVICE(FTDI_VID, LINX_MASTERDEVEL2_PID) },
839        { USB_DEVICE(FTDI_VID, LINX_FUTURE_0_PID) },
840        { USB_DEVICE(FTDI_VID, LINX_FUTURE_1_PID) },
841        { USB_DEVICE(FTDI_VID, LINX_FUTURE_2_PID) },
842        { USB_DEVICE(FTDI_VID, FTDI_CCSICDU20_0_PID) },
843        { USB_DEVICE(FTDI_VID, FTDI_CCSICDU40_1_PID) },
844        { USB_DEVICE(FTDI_VID, FTDI_CCSMACHX_2_PID) },
845        { USB_DEVICE(FTDI_VID, FTDI_CCSLOAD_N_GO_3_PID) },
846        { USB_DEVICE(FTDI_VID, FTDI_CCSICDU64_4_PID) },
847        { USB_DEVICE(FTDI_VID, FTDI_CCSPRIME8_5_PID) },
848        { USB_DEVICE(FTDI_VID, INSIDE_ACCESSO) },
849        { USB_DEVICE(INTREPID_VID, INTREPID_VALUECAN_PID) },
850        { USB_DEVICE(INTREPID_VID, INTREPID_NEOVI_PID) },
851        { USB_DEVICE(FALCOM_VID, FALCOM_TWIST_PID) },
852        { USB_DEVICE(FALCOM_VID, FALCOM_SAMBA_PID) },
853        { USB_DEVICE(FTDI_VID, FTDI_SUUNTO_SPORTS_PID) },
854        { USB_DEVICE(FTDI_VID, FTDI_OCEANIC_PID) },
855        { USB_DEVICE(TTI_VID, TTI_QL355P_PID) },
856        { USB_DEVICE(FTDI_VID, FTDI_RM_CANVIEW_PID) },
857        { USB_DEVICE(ACTON_VID, ACTON_SPECTRAPRO_PID) },
858        { USB_DEVICE(CONTEC_VID, CONTEC_COM1USBH_PID) },
859        { USB_DEVICE(BANDB_VID, BANDB_USOTL4_PID) },
860        { USB_DEVICE(BANDB_VID, BANDB_USTL4_PID) },
861        { USB_DEVICE(BANDB_VID, BANDB_USO9ML2_PID) },
862        { USB_DEVICE(BANDB_VID, BANDB_USOPTL4_PID) },
863        { USB_DEVICE(BANDB_VID, BANDB_USPTL4_PID) },
864        { USB_DEVICE(BANDB_VID, BANDB_USO9ML2DR_2_PID) },
865        { USB_DEVICE(BANDB_VID, BANDB_USO9ML2DR_PID) },
866        { USB_DEVICE(BANDB_VID, BANDB_USOPTL4DR2_PID) },
867        { USB_DEVICE(BANDB_VID, BANDB_USOPTL4DR_PID) },
868        { USB_DEVICE(BANDB_VID, BANDB_485USB9F_2W_PID) },
869        { USB_DEVICE(BANDB_VID, BANDB_485USB9F_4W_PID) },
870        { USB_DEVICE(BANDB_VID, BANDB_232USB9M_PID) },
871        { USB_DEVICE(BANDB_VID, BANDB_485USBTB_2W_PID) },
872        { USB_DEVICE(BANDB_VID, BANDB_485USBTB_4W_PID) },
873        { USB_DEVICE(BANDB_VID, BANDB_TTL5USB9M_PID) },
874        { USB_DEVICE(BANDB_VID, BANDB_TTL3USB9M_PID) },
875        { USB_DEVICE(BANDB_VID, BANDB_ZZ_PROG1_USB_PID) },
876        { USB_DEVICE(FTDI_VID, EVER_ECO_PRO_CDS) },
877        { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_1_PID) },
878        { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_2_PID) },
879        { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_3_PID) },
880        { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_0_PID) },
881        { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_1_PID) },
882        { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_2_PID) },
883        { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_3_PID) },
884        { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_4_PID) },
885        { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_5_PID) },
886        { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_6_PID) },
887        { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_7_PID) },
888        { USB_DEVICE(MOBILITY_VID, MOBILITY_USB_SERIAL_PID) },
889        { USB_DEVICE(FTDI_VID, FTDI_ACTIVE_ROBOTS_PID) },
890        { USB_DEVICE(FTDI_VID, FTDI_MHAM_KW_PID) },
891        { USB_DEVICE(FTDI_VID, FTDI_MHAM_YS_PID) },
892        { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y6_PID) },
893        { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y8_PID) },
894        { USB_DEVICE(FTDI_VID, FTDI_MHAM_IC_PID) },
895        { USB_DEVICE(FTDI_VID, FTDI_MHAM_DB9_PID) },
896        { USB_DEVICE(FTDI_VID, FTDI_MHAM_RS232_PID) },
897        { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y9_PID) },
898        { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_VCP_PID) },
899        { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_D2XX_PID) },
900        { USB_DEVICE(EVOLUTION_VID, EVOLUTION_ER1_PID) },
901        { USB_DEVICE(EVOLUTION_VID, EVO_HYBRID_PID) },
902        { USB_DEVICE(EVOLUTION_VID, EVO_RCM4_PID) },
903        { USB_DEVICE(FTDI_VID, FTDI_ARTEMIS_PID) },
904        { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16_PID) },
905        { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16C_PID) },
906        { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HR_PID) },
907        { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HRC_PID) },
908        { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16IC_PID) },
909        { USB_DEVICE(KOBIL_VID, KOBIL_CONV_B1_PID) },
910        { USB_DEVICE(KOBIL_VID, KOBIL_CONV_KAAN_PID) },
911        { USB_DEVICE(POSIFLEX_VID, POSIFLEX_PP7000_PID) },
912        { USB_DEVICE(FTDI_VID, FTDI_TTUSB_PID) },
913        { USB_DEVICE(FTDI_VID, FTDI_ECLO_COM_1WIRE_PID) },
914        { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_777_PID) },
915        { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_8900F_PID) },
916        { USB_DEVICE(FTDI_VID, FTDI_PCDJ_DAC2_PID) },
917        { USB_DEVICE(FTDI_VID, FTDI_RRCIRKITS_LOCOBUFFER_PID) },
918        { USB_DEVICE(FTDI_VID, FTDI_ASK_RDR400_PID) },
919        { USB_DEVICE(ICOM_VID, ICOM_ID_1_PID) },
920        { USB_DEVICE(ICOM_VID, ICOM_OPC_U_UC_PID) },
921        { USB_DEVICE(ICOM_VID, ICOM_ID_RP2C1_PID) },
922        { USB_DEVICE(ICOM_VID, ICOM_ID_RP2C2_PID) },
923        { USB_DEVICE(ICOM_VID, ICOM_ID_RP2D_PID) },
924        { USB_DEVICE(ICOM_VID, ICOM_ID_RP2VT_PID) },
925        { USB_DEVICE(ICOM_VID, ICOM_ID_RP2VR_PID) },
926        { USB_DEVICE(ICOM_VID, ICOM_ID_RP4KVT_PID) },
927        { USB_DEVICE(ICOM_VID, ICOM_ID_RP4KVR_PID) },
928        { USB_DEVICE(ICOM_VID, ICOM_ID_RP2KVT_PID) },
929        { USB_DEVICE(ICOM_VID, ICOM_ID_RP2KVR_PID) },
930        { USB_DEVICE(FTDI_VID, FTDI_ACG_HFDUAL_PID) },
931        { USB_DEVICE(FTDI_VID, FTDI_YEI_SERVOCENTER31_PID) },
932        { USB_DEVICE(FTDI_VID, FTDI_THORLABS_PID) },
933        { USB_DEVICE(TESTO_VID, TESTO_USB_INTERFACE_PID) },
934        { USB_DEVICE(FTDI_VID, FTDI_GAMMA_SCOUT_PID) },
935        { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13M_PID) },
936        { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13S_PID) },
937        { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13U_PID) },
938        { USB_DEVICE(ELEKTOR_VID, ELEKTOR_FT323R_PID) },
939        { USB_DEVICE(FTDI_VID, FTDI_NDI_HUC_PID),
940                .driver_info = (kernel_ulong_t)&ftdi_NDI_device_quirk },
941        { USB_DEVICE(FTDI_VID, FTDI_NDI_SPECTRA_SCU_PID),
942                .driver_info = (kernel_ulong_t)&ftdi_NDI_device_quirk },
943        { USB_DEVICE(FTDI_VID, FTDI_NDI_FUTURE_2_PID),
944                .driver_info = (kernel_ulong_t)&ftdi_NDI_device_quirk },
945        { USB_DEVICE(FTDI_VID, FTDI_NDI_FUTURE_3_PID),
946                .driver_info = (kernel_ulong_t)&ftdi_NDI_device_quirk },
947        { USB_DEVICE(FTDI_VID, FTDI_NDI_AURORA_SCU_PID),
948                .driver_info = (kernel_ulong_t)&ftdi_NDI_device_quirk },
949        { USB_DEVICE(TELLDUS_VID, TELLDUS_TELLSTICK_PID) },
950        { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_SERIAL_VX7_PID) },
951        { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_CT29B_PID) },
952        { USB_DEVICE(FTDI_VID, FTDI_MAXSTREAM_PID) },
953        { USB_DEVICE(FTDI_VID, FTDI_PHI_FISCO_PID) },
954        { USB_DEVICE(TML_VID, TML_USB_SERIAL_PID) },
955        { USB_DEVICE(FTDI_VID, FTDI_ELSTER_UNICOM_PID) },
956        { USB_DEVICE(FTDI_VID, FTDI_PROPOX_JTAGCABLEII_PID) },
957        { USB_DEVICE(FTDI_VID, FTDI_PROPOX_ISPCABLEIII_PID) },
958        { USB_DEVICE(OLIMEX_VID, OLIMEX_ARM_USB_OCD_PID),
959                .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
960        { USB_DEVICE(OLIMEX_VID, OLIMEX_ARM_USB_OCD_H_PID),
961                .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
962        { USB_DEVICE(FIC_VID, FIC_NEO1973_DEBUG_PID),
963                .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
964        { USB_DEVICE(FTDI_VID, FTDI_OOCDLINK_PID),
965                .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
966        { USB_DEVICE(FTDI_VID, LMI_LM3S_DEVEL_BOARD_PID),
967                .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
968        { USB_DEVICE(FTDI_VID, LMI_LM3S_EVAL_BOARD_PID),
969                .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
970        { USB_DEVICE(FTDI_VID, LMI_LM3S_ICDI_BOARD_PID),
971                .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
972        { USB_DEVICE(FTDI_VID, FTDI_TURTELIZER_PID),
973                .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
974        { USB_DEVICE(RATOC_VENDOR_ID, RATOC_PRODUCT_ID_USB60F) },
975        { USB_DEVICE(FTDI_VID, FTDI_REU_TINY_PID) },
976
977        /* Papouch devices based on FTDI chip */
978        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB485_PID) },
979        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_AP485_PID) },
980        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB422_PID) },
981        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB485_2_PID) },
982        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_AP485_2_PID) },
983        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB422_2_PID) },
984        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB485S_PID) },
985        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB485C_PID) },
986        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_LEC_PID) },
987        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB232_PID) },
988        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_TMU_PID) },
989        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_IRAMP_PID) },
990        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_DRAK5_PID) },
991        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO8x8_PID) },
992        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO4x4_PID) },
993        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO2x2_PID) },
994        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO10x1_PID) },
995        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO30x3_PID) },
996        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO60x3_PID) },
997        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO2x16_PID) },
998        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO3x32_PID) },
999        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_DRAK6_PID) },
1000        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_UPSUSB_PID) },
1001        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_MU_PID) },
1002        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SIMUKEY_PID) },
1003        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_AD4USB_PID) },
1004        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_GMUX_PID) },
1005        { USB_DEVICE(PAPOUCH_VID, PAPOUCH_GMSR_PID) },
1006
1007        { USB_DEVICE(FTDI_VID, FTDI_DOMINTELL_DGQG_PID) },
1008        { USB_DEVICE(FTDI_VID, FTDI_DOMINTELL_DUSB_PID) },
1009        { USB_DEVICE(ALTI2_VID, ALTI2_N3_PID) },
1010        { USB_DEVICE(FTDI_VID, DIEBOLD_BCS_SE923_PID) },
1011        { USB_DEVICE(ATMEL_VID, STK541_PID) },
1012        { USB_DEVICE(DE_VID, STB_PID) },
1013        { USB_DEVICE(DE_VID, WHT_PID) },
1014        { USB_DEVICE(ADI_VID, ADI_GNICE_PID),
1015                .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
1016        { USB_DEVICE(ADI_VID, ADI_GNICEPLUS_PID),
1017                .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
1018        { USB_DEVICE(MICROCHIP_VID, MICROCHIP_USB_BOARD_PID) },
1019        { USB_DEVICE(JETI_VID, JETI_SPC1201_PID) },
1020        { USB_DEVICE(MARVELL_VID, MARVELL_SHEEVAPLUG_PID),
1021                .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
1022        { USB_DEVICE(LARSENBRUSGAARD_VID, LB_ALTITRACK_PID) },
1023        { USB_DEVICE(GN_OTOMETRICS_VID, AURICAL_USB_PID) },
1024        { USB_DEVICE(BAYER_VID, BAYER_CONTOUR_CABLE_PID) },
1025        { USB_DEVICE(FTDI_VID, MARVELL_OPENRD_PID),
1026                .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
1027        { USB_DEVICE(FTDI_VID, TI_XDS100V2_PID),
1028                .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
1029        { USB_DEVICE(FTDI_VID, HAMEG_HO820_PID) },
1030        { USB_DEVICE(FTDI_VID, HAMEG_HO720_PID) },
1031        { USB_DEVICE(FTDI_VID, HAMEG_HO730_PID) },
1032        { USB_DEVICE(FTDI_VID, HAMEG_HO870_PID) },
1033        { USB_DEVICE(FTDI_VID, MJSG_GENERIC_PID) },
1034        { USB_DEVICE(FTDI_VID, MJSG_SR_RADIO_PID) },
1035        { USB_DEVICE(FTDI_VID, MJSG_HD_RADIO_PID) },
1036        { USB_DEVICE(FTDI_VID, MJSG_XM_RADIO_PID) },
1037        { USB_DEVICE(FTDI_VID, XVERVE_SIGNALYZER_ST_PID),
1038                .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
1039        { USB_DEVICE(FTDI_VID, XVERVE_SIGNALYZER_SLITE_PID),
1040                .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
1041        { USB_DEVICE(FTDI_VID, XVERVE_SIGNALYZER_SH2_PID),
1042                .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
1043        { USB_DEVICE(FTDI_VID, XVERVE_SIGNALYZER_SH4_PID),
1044                .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
1045        { USB_DEVICE(FTDI_VID, SEGWAY_RMP200_PID) },
1046        { USB_DEVICE(FTDI_VID, ACCESIO_COM4SM_PID) },
1047        { USB_DEVICE(IONICS_VID, IONICS_PLUGCOMPUTER_PID),
1048                .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
1049        { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_24_MASTER_WING_PID) },
1050        { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_PC_WING_PID) },
1051        { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_USB_DMX_PID) },
1052        { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_MIDI_TIMECODE_PID) },
1053        { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_MINI_WING_PID) },
1054        { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_MAXI_WING_PID) },
1055        { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_MEDIA_WING_PID) },
1056        { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_WING_PID) },
1057        { USB_DEVICE(FTDI_VID, FTDI_SCIENCESCOPE_LOGBOOKML_PID) },
1058        { USB_DEVICE(FTDI_VID, FTDI_SCIENCESCOPE_LS_LOGBOOK_PID) },
1059        { USB_DEVICE(FTDI_VID, FTDI_SCIENCESCOPE_HS_LOGBOOK_PID) },
1060        { USB_DEVICE(FTDI_VID, FTDI_CINTERION_MC55I_PID) },
1061        { USB_DEVICE(FTDI_VID, FTDI_DOTEC_PID) },
1062        { USB_DEVICE(QIHARDWARE_VID, MILKYMISTONE_JTAGSERIAL_PID),
1063                .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
1064        { USB_DEVICE(ST_VID, ST_STMCLT1030_PID),
1065                .driver_info = (kernel_ulong_t)&ftdi_stmclite_quirk },
1066        { USB_DEVICE(FTDI_VID, FTDI_RF_R106) },
1067        { USB_DEVICE(FTDI_VID, FTDI_DISTORTEC_JTAG_LOCK_PICK_PID),
1068                .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
1069        { USB_DEVICE(FTDI_VID, FTDI_LUMEL_PD12_PID) },
1070        { },                                    /* Optional parameter entry */
1071        { }                                     /* Terminating entry */
1072};
1073
1074MODULE_DEVICE_TABLE (usb, id_table_combined);
1075
1076static struct usb_driver ftdi_driver = {
1077        .name =         "ftdi_sio",
1078        .probe =        usb_serial_probe,
1079        .disconnect =   usb_serial_disconnect,
1080        .id_table =     id_table_combined,
1081        .no_dynamic_id =        1,
1082};
1083
1084static const char *ftdi_chip_name[] = {
1085        [SIO] = "SIO",  /* the serial part of FT8U100AX */
1086        [FT8U232AM] = "FT8U232AM",
1087        [FT232BM] = "FT232BM",
1088        [FT2232C] = "FT2232C",
1089        [FT232RL] = "FT232RL",
1090        [FT2232H] = "FT2232H",
1091        [FT4232H] = "FT4232H",
1092        [FT232H]  = "FT232H",
1093        [FTX]     = "FT-X"
1094};
1095
1096
1097/* Constants for read urb and write urb */
1098#define BUFSZ 512
1099#define PKTSZ 64
1100
1101/* rx_flags */
1102#define THROTTLED               0x01
1103#define ACTUALLY_THROTTLED      0x02
1104
1105/* Used for TIOCMIWAIT */
1106#define FTDI_STATUS_B0_MASK     (FTDI_RS0_CTS | FTDI_RS0_DSR | FTDI_RS0_RI | FTDI_RS0_RLSD)
1107#define FTDI_STATUS_B1_MASK     (FTDI_RS_BI)
1108/* End TIOCMIWAIT */
1109
1110#define FTDI_IMPL_ASYNC_FLAGS = ( ASYNC_SPD_HI | ASYNC_SPD_VHI \
1111 ASYNC_SPD_CUST | ASYNC_SPD_SHI | ASYNC_SPD_WARP )
1112
1113/* function prototypes for a FTDI serial converter */
1114static int  ftdi_sio_probe      (struct usb_serial *serial, const struct usb_device_id *id);
1115static void ftdi_shutdown               (struct usb_serial *serial);
1116static int  ftdi_sio_port_probe (struct usb_serial_port *port);
1117static int  ftdi_sio_port_remove        (struct usb_serial_port *port);
1118static int  ftdi_open                   (struct usb_serial_port *port, struct file *filp);
1119static void ftdi_close                  (struct usb_serial_port *port, struct file *filp);
1120static int  ftdi_write                  (struct usb_serial_port *port, const unsigned char *buf, int count);
1121static int  ftdi_write_room             (struct usb_serial_port *port);
1122static int  ftdi_chars_in_buffer        (struct usb_serial_port *port);
1123static void ftdi_write_bulk_callback    (struct urb *urb);
1124static void ftdi_read_bulk_callback     (struct urb *urb);
1125static void ftdi_process_read           (struct work_struct *work);
1126static void ftdi_set_termios            (struct usb_serial_port *port, struct ktermios * old);
1127static int  ftdi_tiocmget               (struct usb_serial_port *port, struct file *file);
1128static int  ftdi_tiocmset               (struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear);
1129static int  ftdi_ioctl                  (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg);
1130static void ftdi_break_ctl              (struct usb_serial_port *port, int break_state );
1131static void ftdi_throttle               (struct usb_serial_port *port);
1132static void ftdi_unthrottle             (struct usb_serial_port *port);
1133
1134static unsigned short int ftdi_232am_baud_base_to_divisor (int baud, int base);
1135static unsigned short int ftdi_232am_baud_to_divisor (int baud);
1136static __u32 ftdi_232bm_baud_base_to_divisor (int baud, int base);
1137static __u32 ftdi_232bm_baud_to_divisor (int baud);
1138static __u32 ftdi_2232h_baud_base_to_divisor(int baud, int base);
1139static __u32 ftdi_2232h_baud_to_divisor(int baud);
1140
1141static struct usb_serial_driver ftdi_sio_device = {
1142        .driver = {
1143                .owner =        THIS_MODULE,
1144                .name =         "ftdi_sio",
1145        },
1146        .description =          "FTDI USB Serial Device",
1147        .usb_driver =           &ftdi_driver ,
1148        .id_table =             id_table_combined,
1149        .num_interrupt_in =     0,
1150        .num_bulk_in =          1,
1151        .num_bulk_out =         1,
1152        .num_ports =            1,
1153        .probe =                ftdi_sio_probe,
1154        .port_probe =           ftdi_sio_port_probe,
1155        .port_remove =          ftdi_sio_port_remove,
1156        .open =                 ftdi_open,
1157        .close =                ftdi_close,
1158        .throttle =             ftdi_throttle,
1159        .unthrottle =           ftdi_unthrottle,
1160        .write =                ftdi_write,
1161        .write_room =           ftdi_write_room,
1162        .chars_in_buffer =      ftdi_chars_in_buffer,
1163        .read_bulk_callback =   ftdi_read_bulk_callback,
1164        .write_bulk_callback =  ftdi_write_bulk_callback,
1165        .tiocmget =             ftdi_tiocmget,
1166        .tiocmset =             ftdi_tiocmset,
1167        .ioctl =                ftdi_ioctl,
1168        .set_termios =          ftdi_set_termios,
1169        .break_ctl =            ftdi_break_ctl,
1170        .shutdown =             ftdi_shutdown,
1171};
1172
1173
1174#define WDR_TIMEOUT 5000 /* default urb timeout */
1175#define WDR_SHORT_TIMEOUT 1000  /* shorter urb timeout */
1176
1177/* High and low are for DTR, RTS etc etc */
1178#define HIGH 1
1179#define LOW 0
1180
1181/* number of outstanding urbs to prevent userspace DoS from happening */
1182#define URB_UPPER_LIMIT 42
1183
1184/*
1185 * ***************************************************************************
1186 * Utility functions
1187 * ***************************************************************************
1188 */
1189
1190static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base)
1191{
1192        unsigned short int divisor;
1193        int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
1194        if ((divisor3 & 0x7) == 7) divisor3 ++; // round x.7/8 up to x+1
1195        divisor = divisor3 >> 3;
1196        divisor3 &= 0x7;
1197        if (divisor3 == 1) divisor |= 0xc000; else // 0.125
1198        if (divisor3 >= 4) divisor |= 0x4000; else // 0.5
1199        if (divisor3 != 0) divisor |= 0x8000;      // 0.25
1200        if (divisor == 1) divisor = 0;  /* special case for maximum baud rate */
1201        return divisor;
1202}
1203
1204static unsigned short int ftdi_232am_baud_to_divisor(int baud)
1205{
1206         return(ftdi_232am_baud_base_to_divisor(baud, 48000000));
1207}
1208
1209static __u32 ftdi_232bm_baud_base_to_divisor(int baud, int base)
1210{
1211        static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
1212        __u32 divisor;
1213        int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
1214        divisor = divisor3 >> 3;
1215        divisor |= (__u32)divfrac[divisor3 & 0x7] << 14;
1216        /* Deal with special cases for highest baud rates. */
1217        if (divisor == 1) divisor = 0; else     // 1.0
1218        if (divisor == 0x4001) divisor = 1;     // 1.5
1219        return divisor;
1220}
1221
1222static __u32 ftdi_232bm_baud_to_divisor(int baud)
1223{
1224         return(ftdi_232bm_baud_base_to_divisor(baud, 48000000));
1225}
1226
1227static __u32 ftdi_2232h_baud_base_to_divisor(int baud, int base)
1228{
1229        static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
1230        __u32 divisor;
1231        int divisor3;
1232
1233        /* hi-speed baud rate is 10-bit sampling instead of 16-bit */
1234        divisor3 = base * 8 / (baud * 10);
1235
1236        divisor = divisor3 >> 3;
1237        divisor |= (__u32)divfrac[divisor3 & 0x7] << 14;
1238        /* Deal with special cases for highest baud rates. */
1239        if (divisor == 1)
1240                divisor = 0;
1241        else if (divisor == 0x4001)
1242                divisor = 1;
1243        /*
1244         * Set this bit to turn off a divide by 2.5 on baud rate generator
1245         * This enables baud rates up to 12Mbaud but cannot reach below 1200
1246         * baud with this bit set
1247         */
1248        divisor |= 0x00020000;
1249        return divisor;
1250}
1251
1252static __u32 ftdi_2232h_baud_to_divisor(int baud)
1253{
1254         return ftdi_2232h_baud_base_to_divisor(baud, 120000000);
1255}
1256
1257#define set_mctrl(port, set)            update_mctrl((port), (set), 0)
1258#define clear_mctrl(port, clear)        update_mctrl((port), 0, (clear))
1259
1260static int update_mctrl(struct usb_serial_port *port, unsigned int set, unsigned int clear)
1261{
1262        struct ftdi_private *priv = usb_get_serial_port_data(port);
1263        unsigned urb_value;
1264        int rv;
1265
1266        if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
1267                dbg("%s - DTR|RTS not being set|cleared", __FUNCTION__);
1268                return 0;       /* no change */
1269        }
1270
1271        clear &= ~set;  /* 'set' takes precedence over 'clear' */
1272        urb_value = 0;
1273        if (clear & TIOCM_DTR)
1274                urb_value |= FTDI_SIO_SET_DTR_LOW;
1275        if (clear & TIOCM_RTS)
1276                urb_value |= FTDI_SIO_SET_RTS_LOW;
1277        if (set & TIOCM_DTR)
1278                urb_value |= FTDI_SIO_SET_DTR_HIGH;
1279        if (set & TIOCM_RTS)
1280                urb_value |= FTDI_SIO_SET_RTS_HIGH;
1281        rv = usb_control_msg(port->serial->dev,
1282                               usb_sndctrlpipe(port->serial->dev, 0),
1283                               FTDI_SIO_SET_MODEM_CTRL_REQUEST,
1284                               FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE,
1285                               urb_value, priv->interface,
1286                               NULL, 0, WDR_TIMEOUT);
1287
1288        if (rv < 0) {
1289                err("%s Error from MODEM_CTRL urb: DTR %s, RTS %s",
1290                                __FUNCTION__,
1291                                (set & TIOCM_DTR) ? "HIGH" :
1292                                (clear & TIOCM_DTR) ? "LOW" : "unchanged",
1293                                (set & TIOCM_RTS) ? "HIGH" :
1294                                (clear & TIOCM_RTS) ? "LOW" : "unchanged");
1295        } else {
1296                dbg("%s - DTR %s, RTS %s", __FUNCTION__,
1297                                (set & TIOCM_DTR) ? "HIGH" :
1298                                (clear & TIOCM_DTR) ? "LOW" : "unchanged",
1299                                (set & TIOCM_RTS) ? "HIGH" :
1300                                (clear & TIOCM_RTS) ? "LOW" : "unchanged");
1301                priv->last_dtr_rts = (priv->last_dtr_rts & ~clear) | set;
1302        }
1303        return rv;
1304}
1305
1306
1307static __u32 get_ftdi_divisor(struct usb_serial_port * port);
1308
1309
1310static int change_speed(struct usb_serial_port *port)
1311{
1312        struct ftdi_private *priv = usb_get_serial_port_data(port);
1313    __u16 urb_value;
1314        __u16 urb_index;
1315        __u32 urb_index_value;
1316        int rv;
1317
1318        urb_index_value = get_ftdi_divisor(port);
1319        urb_value = (__u16)urb_index_value;
1320        urb_index = (__u16)(urb_index_value >> 16);
1321        if ((priv->chip_type == FT2232C) || (priv->chip_type == FT2232H) ||
1322                (priv->chip_type == FT4232H) || (priv->chip_type == FT232H)) {
1323                /* Probably the BM type needs the MSB of the encoded fractional
1324                 * divider also moved like for the chips above. Any infos? */
1325                urb_index = (__u16)((urb_index << 8) | priv->interface);
1326        }
1327
1328        rv = usb_control_msg(port->serial->dev,
1329                            usb_sndctrlpipe(port->serial->dev, 0),
1330                            FTDI_SIO_SET_BAUDRATE_REQUEST,
1331                            FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE,
1332                            urb_value, urb_index,
1333                            NULL, 0, WDR_SHORT_TIMEOUT);
1334
1335        return rv;
1336}
1337
1338
1339static __u32 get_ftdi_divisor(struct usb_serial_port * port)
1340{ /* get_ftdi_divisor */
1341        struct ftdi_private *priv = usb_get_serial_port_data(port);
1342        __u32 div_value = 0;
1343        int div_okay = 1;
1344        int baud;
1345
1346        /*
1347         * The logic involved in setting the baudrate can be cleanly split in 3 steps.
1348         * Obtaining the actual baud rate is a little tricky since unix traditionally
1349         * somehow ignored the possibility to set non-standard baud rates.
1350         * 1. Standard baud rates are set in tty->termios->c_cflag
1351         * 2. If these are not enough, you can set any speed using alt_speed as follows:
1352         *    - set tty->termios->c_cflag speed to B38400
1353         *    - set your real speed in tty->alt_speed; it gets ignored when
1354         *      alt_speed==0, (or)
1355         *    - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
1356         *      flags & ASYNC_SPD_MASK == ASYNC_SPD_[HI, VHI, SHI, WARP], this just
1357         *      sets alt_speed to (HI: 57600, VHI: 115200, SHI: 230400, WARP: 460800)
1358         * ** Steps 1, 2 are done courtesy of tty_get_baud_rate
1359         * 3. You can also set baud rate by setting custom divisor as follows
1360         *    - set tty->termios->c_cflag speed to B38400
1361         *    - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
1362         *      o flags & ASYNC_SPD_MASK == ASYNC_SPD_CUST
1363         *      o custom_divisor set to baud_base / your_new_baudrate
1364         * ** Step 3 is done courtesy of code borrowed from serial.c - I should really
1365         *    spend some time and separate+move this common code to serial.c, it is
1366         *    replicated in nearly every serial driver you see.
1367         */
1368
1369        /* 1. Get the baud rate from the tty settings, this observes alt_speed hack */
1370
1371        baud = tty_get_baud_rate(port->tty);
1372        dbg("%s - tty_get_baud_rate reports speed %d", __FUNCTION__, baud);
1373
1374        /* 2. Observe async-compatible custom_divisor hack, update baudrate if needed */
1375
1376        if (baud == 38400 &&
1377            ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
1378             (priv->custom_divisor)) {
1379                baud = priv->baud_base / priv->custom_divisor;
1380                dbg("%s - custom divisor %d sets baud rate to %d", __FUNCTION__, priv->custom_divisor, baud);
1381        }
1382
1383        /* 3. Convert baudrate to device-specific divisor */
1384
1385        if (!baud) baud = 9600;
1386        switch(priv->chip_type) {
1387        case SIO: /* SIO chip */
1388                switch(baud) {
1389                case 300: div_value = ftdi_sio_b300; break;
1390                case 600: div_value = ftdi_sio_b600; break;
1391                case 1200: div_value = ftdi_sio_b1200; break;
1392                case 2400: div_value = ftdi_sio_b2400; break;
1393                case 4800: div_value = ftdi_sio_b4800; break;
1394                case 9600: div_value = ftdi_sio_b9600; break;
1395                case 19200: div_value = ftdi_sio_b19200; break;
1396                case 38400: div_value = ftdi_sio_b38400; break;
1397                case 57600: div_value = ftdi_sio_b57600;  break;
1398                case 115200: div_value = ftdi_sio_b115200; break;
1399                } /* baud */
1400                if (div_value == 0) {
1401                        dbg("%s - Baudrate (%d) requested is not supported", __FUNCTION__,  baud);
1402                        div_value = ftdi_sio_b9600;
1403                        baud = 9600;
1404                        div_okay = 0;
1405                }
1406                break;
1407        case FT8U232AM: /* 8U232AM chip */
1408                if (baud <= 3000000) {
1409                        div_value = ftdi_232am_baud_to_divisor(baud);
1410                } else {
1411                        dbg("%s - Baud rate too high!", __FUNCTION__);
1412                        baud = 9600;
1413                        div_value = ftdi_232am_baud_to_divisor(9600);
1414                        div_okay = 0;
1415                }
1416                break;
1417        case FT232BM: /* FT232BM chip */
1418        case FT2232C: /* FT2232C chip */
1419        case FT232RL: /* FT232RL chip */
1420        case FTX:     /* FT-X series */
1421                if (baud <= 3000000) {
1422                        __u16 product_id = le16_to_cpu(
1423                                port->serial->dev->descriptor.idProduct);
1424                        if (((FTDI_NDI_HUC_PID == product_id) ||
1425                             (FTDI_NDI_SPECTRA_SCU_PID == product_id) ||
1426                             (FTDI_NDI_FUTURE_2_PID == product_id) ||
1427                             (FTDI_NDI_FUTURE_3_PID == product_id) ||
1428                             (FTDI_NDI_AURORA_SCU_PID == product_id)) &&
1429                            (baud == 19200)) {
1430                                baud = 1200000;
1431                        }
1432                        div_value = ftdi_232bm_baud_to_divisor(baud);
1433                } else {
1434                        dbg("%s - Baud rate too high!", __func__);
1435                        div_value = ftdi_232bm_baud_to_divisor(9600);
1436                        div_okay = 0;
1437                        baud = 9600;
1438                }
1439                break;
1440        case FT2232H: /* FT2232H chip */
1441        case FT4232H: /* FT4232H chip */
1442        case FT232H:  /* FT232H chip */
1443                if ((baud <= 12000000) && (baud >= 1200)) {
1444                        div_value = ftdi_2232h_baud_to_divisor(baud);
1445                } else if (baud < 1200) {
1446                        div_value = ftdi_232bm_baud_to_divisor(baud);
1447                } else {
1448                        dbg("%s - Baud rate too high!", __func__);
1449                        div_value = ftdi_232bm_baud_to_divisor(9600);
1450                        div_okay = 0;
1451                        baud = 9600;
1452                }
1453                break;
1454        } /* priv->chip_type */
1455
1456        if (div_okay) {
1457                dbg("%s - Baud rate set to %d (divisor 0x%lX) on chip %s",
1458                        __FUNCTION__, baud, (unsigned long)div_value,
1459                        ftdi_chip_name[priv->chip_type]);
1460        }
1461
1462        return(div_value);
1463}
1464
1465
1466static int get_serial_info(struct usb_serial_port * port, struct serial_struct __user * retinfo)
1467{
1468        struct ftdi_private *priv = usb_get_serial_port_data(port);
1469        struct serial_struct tmp;
1470
1471        if (!retinfo)
1472                return -EFAULT;
1473        memset(&tmp, 0, sizeof(tmp));
1474        tmp.flags = priv->flags;
1475        tmp.baud_base = priv->baud_base;
1476        tmp.custom_divisor = priv->custom_divisor;
1477        if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
1478                return -EFAULT;
1479        return 0;
1480} /* get_serial_info */
1481
1482
1483static int set_serial_info(struct usb_serial_port * port, struct serial_struct __user * newinfo)
1484{ /* set_serial_info */
1485        struct ftdi_private *priv = usb_get_serial_port_data(port);
1486        struct serial_struct new_serial;
1487        struct ftdi_private old_priv;
1488
1489        if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
1490                return -EFAULT;
1491        old_priv = * priv;
1492
1493        /* Do error checking and permission checking */
1494
1495        if (!capable(CAP_SYS_ADMIN)) {
1496                if (((new_serial.flags & ~ASYNC_USR_MASK) !=
1497                     (priv->flags & ~ASYNC_USR_MASK)))
1498                        return -EPERM;
1499                priv->flags = ((priv->flags & ~ASYNC_USR_MASK) |
1500                               (new_serial.flags & ASYNC_USR_MASK));
1501                priv->custom_divisor = new_serial.custom_divisor;
1502                goto check_and_exit;
1503        }
1504
1505        if ((new_serial.baud_base != priv->baud_base) &&
1506            (new_serial.baud_base < 9600))
1507                return -EINVAL;
1508
1509        /* Make the changes - these are privileged changes! */
1510
1511        priv->flags = ((priv->flags & ~ASYNC_FLAGS) |
1512                       (new_serial.flags & ASYNC_FLAGS));
1513        priv->custom_divisor = new_serial.custom_divisor;
1514
1515        port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
1516
1517check_and_exit:
1518        if ((old_priv.flags & ASYNC_SPD_MASK) !=
1519             (priv->flags & ASYNC_SPD_MASK)) {
1520                if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_HI)
1521                        port->tty->alt_speed = 57600;
1522                else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_VHI)
1523                        port->tty->alt_speed = 115200;
1524                else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_SHI)
1525                        port->tty->alt_speed = 230400;
1526                else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_WARP)
1527                        port->tty->alt_speed = 460800;
1528                else
1529                        port->tty->alt_speed = 0;
1530        }
1531        if (((old_priv.flags & ASYNC_SPD_MASK) !=
1532             (priv->flags & ASYNC_SPD_MASK)) ||
1533            (((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
1534             (old_priv.custom_divisor != priv->custom_divisor))) {
1535                change_speed(port);
1536        }
1537
1538        return (0);
1539
1540} /* set_serial_info */
1541
1542
1543/* Determine type of FTDI chip based on USB config and descriptor. */
1544static void ftdi_determine_type(struct usb_serial_port *port)
1545{
1546        struct ftdi_private *priv = usb_get_serial_port_data(port);
1547        struct usb_serial *serial = port->serial;
1548        struct usb_device *udev = serial->dev;
1549        unsigned version;
1550        unsigned interfaces;
1551
1552        /* Assume it is not the original SIO device for now. */
1553        priv->baud_base = 48000000 / 2;
1554        priv->write_offset = 0;
1555
1556        version = le16_to_cpu(udev->descriptor.bcdDevice);
1557        interfaces = udev->actconfig->desc.bNumInterfaces;
1558        dbg("%s: bcdDevice = 0x%x, bNumInterfaces = %u", __FUNCTION__,
1559                        version, interfaces);
1560        if (interfaces > 1) {
1561                int inter;
1562
1563                /* Multiple interfaces.*/
1564                if (version == 0x0800) {
1565                        priv->chip_type = FT4232H;
1566                        /* Hi-speed - baud clock runs at 120MHz */
1567                        priv->baud_base = 120000000 / 2;
1568                } else if (version == 0x0700) {
1569                        priv->chip_type = FT2232H;
1570                        /* Hi-speed - baud clock runs at 120MHz */
1571                        priv->baud_base = 120000000 / 2;
1572                } else
1573                        priv->chip_type = FT2232C;
1574
1575                /* Determine interface code. */
1576                inter = serial->interface->altsetting->desc.bInterfaceNumber;
1577                if (inter == 0) {
1578                        priv->interface = INTERFACE_A;
1579                } else  if (inter == 1) {
1580                        priv->interface = INTERFACE_B;
1581                } else  if (inter == 2) {
1582                        priv->interface = INTERFACE_C;
1583                } else  if (inter == 3) {
1584                        priv->interface = INTERFACE_D;
1585                }
1586                /* BM-type devices have a bug where bcdDevice gets set
1587                 * to 0x200 when iSerialNumber is 0.  */
1588                if (version < 0x500) {
1589                        dbg("%s: something fishy - bcdDevice too low for multi-interface device",
1590                                        __func__);
1591                }
1592        } else if (version < 0x200) {
1593                /* Old device.  Assume its the original SIO. */
1594                priv->chip_type = SIO;
1595                priv->baud_base = 12000000 / 16;
1596                priv->write_offset = 1;
1597        } else if (version < 0x400) {
1598                /* Assume its an FT8U232AM (or FT8U245AM) */
1599                /* (It might be a BM because of the iSerialNumber bug,
1600                 * but it will still work as an AM device.) */
1601                priv->chip_type = FT8U232AM;
1602        } else if (version < 0x600) {
1603                /* Assume its an FT232BM (or FT245BM) */
1604                priv->chip_type = FT232BM;
1605        } else if (version < 0x900) {
1606                /* Assume it's an FT232RL */
1607                priv->chip_type = FT232RL;
1608        } else if (version < 0x1000) {
1609                /* Assume it's an FT232H */
1610                priv->chip_type = FT232H;
1611        } else {
1612                /* Assume it's an FT-X series device */
1613                priv->chip_type = FTX;
1614        }
1615        info("Detected %s", ftdi_chip_name[priv->chip_type]);
1616}
1617
1618/* Determine the maximum packet size for the device.  This depends on the chip
1619 * type and the USB host capabilities.  The value should be obtained from the
1620 * device descriptor as the chip will use the appropriate values for the host.*/
1621static void ftdi_set_max_packet_size(struct usb_serial_port *port)
1622{
1623        struct ftdi_private *priv = usb_get_serial_port_data(port);
1624        struct usb_serial *serial = port->serial;
1625        struct usb_device *udev = serial->dev;
1626
1627        struct usb_interface *interface = serial->interface;
1628        struct usb_endpoint_descriptor *ep_desc = &interface->cur_altsetting->endpoint[1].desc;
1629
1630        unsigned num_endpoints;
1631        int i;
1632
1633        num_endpoints = interface->cur_altsetting->desc.bNumEndpoints;
1634        dev_info(&udev->dev, "Number of endpoints %d\n", num_endpoints);
1635
1636        /* NOTE: some customers have programmed FT232R/FT245R devices
1637         * with an endpoint size of 0 - not good.  In this case, we
1638         * want to override the endpoint descriptor setting and use a
1639         * value of 64 for wMaxPacketSize */
1640        for (i = 0; i < num_endpoints; i++) {
1641                dev_info(&udev->dev, "Endpoint %d MaxPacketSize %d\n", i+1,
1642                        interface->cur_altsetting->endpoint[i].desc.wMaxPacketSize);
1643                ep_desc = &interface->cur_altsetting->endpoint[i].desc;
1644                if (ep_desc->wMaxPacketSize == 0) {
1645                        ep_desc->wMaxPacketSize = cpu_to_le16(PKTSZ);
1646                        dev_info(&udev->dev, "Overriding wMaxPacketSize on endpoint %d\n", i);
1647                }
1648        }
1649
1650        /* set max packet size based on descriptor */
1651        priv->max_packet_size = le16_to_cpu(ep_desc->wMaxPacketSize);
1652
1653        dev_info(&udev->dev, "Setting MaxPacketSize %d\n", priv->max_packet_size);
1654}
1655
1656/*
1657 * ***************************************************************************
1658 * Sysfs Attribute
1659 * ***************************************************************************
1660 */
1661
1662static ssize_t show_latency_timer(struct device *dev, struct device_attribute *attr, char *buf)
1663{
1664        struct usb_serial_port *port = to_usb_serial_port(dev);
1665        struct ftdi_private *priv = usb_get_serial_port_data(port);
1666        struct usb_device *udev = port->serial->dev;
1667        unsigned short latency = 0;
1668        int rv = 0;
1669
1670
1671        dbg("%s",__FUNCTION__);
1672
1673        rv = usb_control_msg(udev,
1674                             usb_rcvctrlpipe(udev, 0),
1675                             FTDI_SIO_GET_LATENCY_TIMER_REQUEST,
1676                             FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE,
1677                             0, priv->interface,
1678                             (char*) &latency, 1, WDR_TIMEOUT);
1679
1680        if (rv < 0) {
1681                dev_err(dev, "Unable to read latency timer: %i", rv);
1682                return -EIO;
1683        }
1684        return sprintf(buf, "%i\n", latency);
1685}
1686
1687/* Write a new value of the latency timer, in units of milliseconds. */
1688static ssize_t store_latency_timer(struct device *dev, struct device_attribute *attr, const char *valbuf,
1689                                   size_t count)
1690{
1691        struct usb_serial_port *port = to_usb_serial_port(dev);
1692        struct ftdi_private *priv = usb_get_serial_port_data(port);
1693        struct usb_device *udev = port->serial->dev;
1694        int v = simple_strtoul(valbuf, NULL, 10);
1695        int rv = 0;
1696
1697        dbg("%s: setting latency timer = %i", __FUNCTION__, v);
1698
1699        rv = usb_control_msg(udev,
1700                             usb_sndctrlpipe(udev, 0),
1701                             FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
1702                             FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
1703                             v, priv->interface,
1704                             NULL, 0, WDR_TIMEOUT);
1705
1706        if (rv < 0) {
1707                dev_err(dev, "Unable to write latency timer: %i", rv);
1708                return -EIO;
1709        }
1710
1711        return count;
1712}
1713
1714/* Write an event character directly to the FTDI register.  The ASCII
1715   value is in the low 8 bits, with the enable bit in the 9th bit. */
1716static ssize_t store_event_char(struct device *dev, struct device_attribute *attr, const char *valbuf,
1717                                size_t count)
1718{
1719        struct usb_serial_port *port = to_usb_serial_port(dev);
1720        struct ftdi_private *priv = usb_get_serial_port_data(port);
1721        struct usb_device *udev = port->serial->dev;
1722        int v = simple_strtoul(valbuf, NULL, 10);
1723        int rv = 0;
1724
1725        dbg("%s: setting event char = %i", __FUNCTION__, v);
1726
1727        rv = usb_control_msg(udev,
1728                             usb_sndctrlpipe(udev, 0),
1729                             FTDI_SIO_SET_EVENT_CHAR_REQUEST,
1730                             FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE,
1731                             v, priv->interface,
1732                             NULL, 0, WDR_TIMEOUT);
1733
1734        if (rv < 0) {
1735                dbg("Unable to write event character: %i", rv);
1736                return -EIO;
1737        }
1738
1739        return count;
1740}
1741
1742static DEVICE_ATTR(latency_timer, S_IWUSR | S_IRUGO, show_latency_timer, store_latency_timer);
1743static DEVICE_ATTR(event_char, S_IWUSR, NULL, store_event_char);
1744
1745static int create_sysfs_attrs(struct usb_serial_port *port)
1746{
1747        struct ftdi_private *priv = usb_get_serial_port_data(port);
1748        int retval = 0;
1749
1750        dbg("%s",__FUNCTION__);
1751
1752        /* XXX I've no idea if the original SIO supports the event_char
1753         * sysfs parameter, so I'm playing it safe.  */
1754        if (priv->chip_type != SIO) {
1755                dbg("sysfs attributes for %s", ftdi_chip_name[priv->chip_type]);
1756                retval = device_create_file(&port->dev, &dev_attr_event_char);
1757                if ((!retval) &&
1758                    (priv->chip_type == FT232BM ||
1759                     priv->chip_type == FT2232C ||
1760                     priv->chip_type == FT232RL ||
1761                     priv->chip_type == FT2232H ||
1762                     priv->chip_type == FT4232H ||
1763                     priv->chip_type == FT232H ||
1764                     priv->chip_type == FTX)) {
1765                        retval = device_create_file(&port->dev,
1766                                                    &dev_attr_latency_timer);
1767                }
1768        }
1769        return retval;
1770}
1771
1772static void remove_sysfs_attrs(struct usb_serial_port *port)
1773{
1774        struct ftdi_private *priv = usb_get_serial_port_data(port);
1775
1776        dbg("%s",__FUNCTION__);
1777
1778        /* XXX see create_sysfs_attrs */
1779        if (priv->chip_type != SIO) {
1780                device_remove_file(&port->dev, &dev_attr_event_char);
1781                if (priv->chip_type == FT232BM ||
1782                    priv->chip_type == FT2232C ||
1783                    priv->chip_type == FT232RL ||
1784                    priv->chip_type == FT2232H ||
1785                    priv->chip_type == FT4232H ||
1786                    priv->chip_type == FT232H ||
1787                    priv->chip_type == FTX) {
1788                        device_remove_file(&port->dev, &dev_attr_latency_timer);
1789                }
1790        }
1791}
1792
1793/*
1794 * ***************************************************************************
1795 * FTDI driver specific functions
1796 * ***************************************************************************
1797 */
1798
1799/* Probe function to check for special devices */
1800static int ftdi_sio_probe (struct usb_serial *serial, const struct usb_device_id *id)
1801{
1802        struct ftdi_sio_quirk *quirk = (struct ftdi_sio_quirk *)id->driver_info;
1803
1804        if (quirk && quirk->probe) {
1805                int ret = quirk->probe(serial);
1806                if (ret != 0)
1807                        return ret;
1808        }
1809
1810        usb_set_serial_data(serial, (void *)id->driver_info);
1811
1812        return 0;
1813}
1814
1815static int ftdi_sio_port_probe(struct usb_serial_port *port)
1816{
1817        struct ftdi_private *priv;
1818        struct ftdi_sio_quirk *quirk = usb_get_serial_data(port->serial);
1819
1820        dbg("%s",__FUNCTION__);
1821
1822        priv = kzalloc(sizeof(struct ftdi_private), GFP_KERNEL);
1823        if (!priv){
1824                err("%s- kmalloc(%Zd) failed.", __FUNCTION__, sizeof(struct ftdi_private));
1825                return -ENOMEM;
1826        }
1827
1828        spin_lock_init(&priv->rx_lock);
1829        spin_lock_init(&priv->tx_lock);
1830        init_waitqueue_head(&priv->delta_msr_wait);
1831        /* This will push the characters through immediately rather
1832           than queue a task to deliver them */
1833        priv->flags = ASYNC_LOW_LATENCY;
1834
1835        if (quirk && quirk->port_probe)
1836                quirk->port_probe(priv);
1837
1838        /* Increase the size of read buffers */
1839        kfree(port->bulk_in_buffer);
1840        port->bulk_in_buffer = kmalloc (BUFSZ, GFP_KERNEL);
1841        if (!port->bulk_in_buffer) {
1842                kfree (priv);
1843                return -ENOMEM;
1844        }
1845        if (port->read_urb) {
1846                port->read_urb->transfer_buffer = port->bulk_in_buffer;
1847                port->read_urb->transfer_buffer_length = BUFSZ;
1848        }
1849
1850        INIT_DELAYED_WORK(&priv->rx_work, ftdi_process_read);
1851        priv->port = port;
1852
1853        /* Free port's existing write urb and transfer buffer. */
1854        if (port->write_urb) {
1855                usb_free_urb (port->write_urb);
1856                port->write_urb = NULL;
1857        }
1858        kfree(port->bulk_out_buffer);
1859        port->bulk_out_buffer = NULL;
1860
1861        usb_set_serial_port_data(port, priv);
1862
1863        ftdi_determine_type (port);
1864        ftdi_set_max_packet_size(port);
1865        create_sysfs_attrs(port);
1866        return 0;
1867}
1868
1869/* Setup for the USB-UIRT device, which requires hardwired
1870 * baudrate (38400 gets mapped to 312500) */
1871/* Called from usbserial:serial_probe */
1872static void ftdi_USB_UIRT_setup(struct ftdi_private *priv)
1873{
1874        dbg("%s", __func__);
1875
1876        priv->flags |= ASYNC_SPD_CUST;
1877        priv->custom_divisor = 77;
1878        priv->force_baud = 38400;
1879}
1880
1881/* Setup for the HE-TIRA1 device, which requires hardwired
1882 * baudrate (38400 gets mapped to 100000) and RTS-CTS enabled.  */
1883
1884static void ftdi_HE_TIRA1_setup(struct ftdi_private *priv)
1885{
1886        dbg("%s", __func__);
1887
1888        priv->flags |= ASYNC_SPD_CUST;
1889        priv->custom_divisor = 240;
1890        priv->force_baud = 38400;
1891        priv->force_rtscts = 1;
1892}
1893
1894/*
1895 * Module parameter to control latency timer for NDI FTDI-based USB devices.
1896 * If this value is not set in /etc/modprobe.d/ its value will be set
1897 * to 1ms.
1898 */
1899static int ndi_latency_timer = 1;
1900
1901/* Setup for the NDI FTDI-based USB devices, which requires hardwired
1902 * baudrate (19200 gets mapped to 1200000).
1903 *
1904 * Called from usbserial:serial_probe.
1905 */
1906static int ftdi_NDI_device_setup(struct usb_serial *serial)
1907{
1908        struct usb_device *udev = serial->dev;
1909        int latency = ndi_latency_timer;
1910
1911        if (latency == 0)
1912                latency = 1;
1913        if (latency > 99)
1914                latency = 99;
1915
1916        dbg("%s setting NDI device latency to %d", __func__, latency);
1917        dev_info(&udev->dev, "NDI device with a latency value of %d", latency);
1918
1919        /* FIXME: errors are not returned */
1920        usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1921                                FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
1922                                FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
1923                                latency, 0, NULL, 0, WDR_TIMEOUT);
1924        return 0;
1925}
1926
1927/*
1928 * First port on JTAG adaptors such as Olimex arm-usb-ocd or the FIC/OpenMoko
1929 * Neo1973 Debug Board is reserved for JTAG interface and can be accessed from
1930 * userspace using openocd.
1931 */
1932static int ftdi_jtag_probe(struct usb_serial *serial)
1933{
1934        struct usb_device *udev = serial->dev;
1935        struct usb_interface *interface = serial->interface;
1936
1937        dbg("%s", __func__);
1938
1939        if (interface == udev->actconfig->interface[0]) {
1940                dev_info(&udev->dev,
1941                         "Ignoring serial port reserved for JTAG\n");
1942                return -ENODEV;
1943        }
1944
1945        return 0;
1946}
1947
1948static int ftdi_8u2232c_probe(struct usb_serial *serial)
1949{
1950        struct usb_device *udev = serial->dev;
1951
1952        dbg("%s", __func__);
1953
1954        if ((udev->manufacturer && !strcmp(udev->manufacturer, "CALAO Systems")) ||
1955            (udev->product && !strcmp(udev->product, "BeagleBone/XDS100")))
1956                return ftdi_jtag_probe(serial);
1957
1958        return 0;
1959}
1960
1961/*
1962 * First and second port on STMCLiteadaptors is reserved for JTAG interface
1963 * and the forth port for pio
1964 */
1965static int ftdi_stmclite_probe(struct usb_serial *serial)
1966{
1967        struct usb_device *udev = serial->dev;
1968        struct usb_interface *interface = serial->interface;
1969
1970        dbg("%s", __func__);
1971
1972        if (interface == udev->actconfig->interface[2])
1973                return 0;
1974
1975        dev_info(&udev->dev, "Ignoring serial port reserved for JTAG\n");
1976
1977        return -ENODEV;
1978}
1979
1980/*
1981 * The Matrix Orbital VK204-25-USB has an invalid IN endpoint.
1982 * We have to correct it if we want to read from it.
1983 */
1984static int ftdi_mtxorb_hack_setup(struct usb_serial *serial)
1985{
1986        struct usb_host_endpoint *ep = serial->dev->ep_in[1];
1987        struct usb_endpoint_descriptor *ep_desc = &ep->desc;
1988
1989        if (ep_desc->wMaxPacketSize == 0) {
1990                ep_desc->wMaxPacketSize = cpu_to_le16(0x40);
1991                dev_info(&serial->dev->dev,
1992                         "Fixing invalid wMaxPacketSize on read pipe\n");
1993        }
1994
1995        return 0;
1996}
1997
1998/*******************************************************************************
1999
2000*******************************************************************************/
2001
2002/* ftdi_shutdown is called from usbserial:usb_serial_disconnect
2003 *   it is called when the usb device is disconnected
2004 *
2005 *   usbserial:usb_serial_disconnect
2006 *      calls __serial_close for each open of the port
2007 *      shutdown is called then (ie ftdi_shutdown)
2008 */
2009static void ftdi_shutdown (struct usb_serial *serial)
2010{
2011        dbg("%s", __FUNCTION__);
2012}
2013
2014static int ftdi_sio_port_remove(struct usb_serial_port *port)
2015{
2016        struct ftdi_private *priv = usb_get_serial_port_data(port);
2017
2018        dbg("%s", __FUNCTION__);
2019
2020        remove_sysfs_attrs(port);
2021
2022        /* all open ports are closed at this point
2023         *    (by usbserial.c:__serial_close, which calls ftdi_close)
2024         */
2025
2026        if (priv) {
2027                usb_set_serial_port_data(port, NULL);
2028                kfree(priv);
2029        }
2030
2031        return 0;
2032}
2033
2034static int  ftdi_open (struct usb_serial_port *port, struct file *filp)
2035{ /* ftdi_open */
2036        struct usb_device *dev = port->serial->dev;
2037        struct ftdi_private *priv = usb_get_serial_port_data(port);
2038        unsigned long flags;
2039
2040        int result = 0;
2041
2042        dbg("%s", __FUNCTION__);
2043
2044        spin_lock_irqsave(&priv->tx_lock, flags);
2045        priv->tx_bytes = 0;
2046        spin_unlock_irqrestore(&priv->tx_lock, flags);
2047        spin_lock_irqsave(&priv->rx_lock, flags);
2048        priv->rx_bytes = 0;
2049        spin_unlock_irqrestore(&priv->rx_lock, flags);
2050
2051        if (port->tty)
2052                port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
2053
2054        /* No error checking for this (will get errors later anyway) */
2055        /* See ftdi_sio.h for description of what is reset */
2056        usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2057                        FTDI_SIO_RESET_REQUEST, FTDI_SIO_RESET_REQUEST_TYPE,
2058                        FTDI_SIO_RESET_SIO,
2059                        priv->interface, NULL, 0, WDR_TIMEOUT);
2060
2061        /* Termios defaults are set by usb_serial_init. We don't change
2062           port->tty->termios - this would loose speed settings, etc.
2063           This is same behaviour as serial.c/rs_open() - Kuba */
2064
2065        /* ftdi_set_termios  will send usb control messages */
2066        if (port->tty)
2067                ftdi_set_termios(port, NULL);
2068
2069        /* FIXME: Flow control might be enabled, so it should be checked -
2070           we have no control of defaults! */
2071        /* Turn on RTS and DTR since we are not flow controlling by default */
2072        set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2073
2074        /* Not throttled */
2075        spin_lock_irqsave(&priv->rx_lock, flags);
2076        priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
2077        spin_unlock_irqrestore(&priv->rx_lock, flags);
2078
2079        /* Start reading from the device */
2080        priv->rx_processed = 0;
2081        usb_fill_bulk_urb(port->read_urb, dev,
2082                      usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress),
2083                      port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
2084                      ftdi_read_bulk_callback, port);
2085        result = usb_submit_urb(port->read_urb, GFP_KERNEL);
2086        if (result)
2087                err("%s - failed submitting read urb, error %d", __FUNCTION__, result);
2088
2089
2090        return result;
2091} /* ftdi_open */
2092
2093
2094
2095/*
2096 * usbserial:__serial_close  only calls ftdi_close if the point is open
2097 *
2098 *   This only gets called when it is the last close
2099 *
2100 *
2101 */
2102
2103static void ftdi_close (struct usb_serial_port *port, struct file *filp)
2104{ /* ftdi_close */
2105        unsigned int c_cflag = port->tty->termios->c_cflag;
2106        struct ftdi_private *priv = usb_get_serial_port_data(port);
2107
2108        dbg("%s", __FUNCTION__);
2109
2110        if (c_cflag & HUPCL){
2111                /* Disable flow control */
2112                if (usb_control_msg(port->serial->dev,
2113                                    usb_sndctrlpipe(port->serial->dev, 0),
2114                                    FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2115                                    FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2116                                    0, priv->interface, NULL, 0,
2117                                    WDR_TIMEOUT) < 0) {
2118                        err("error from flowcontrol urb");
2119                }
2120
2121                /* drop RTS and DTR */
2122                clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2123        } /* Note change no line if hupcl is off */
2124
2125        /* cancel any scheduled reading */
2126        cancel_delayed_work(&priv->rx_work);
2127        flush_scheduled_work();
2128
2129        /* shutdown our bulk read */
2130        usb_kill_urb(port->read_urb);
2131} /* ftdi_close */
2132
2133
2134
2135/* The SIO requires the first byte to have:
2136 *  B0 1
2137 *  B1 0
2138 *  B2..7 length of message excluding byte 0
2139 *
2140 * The new devices do not require this byte
2141 */
2142static int ftdi_write (struct usb_serial_port *port,
2143                           const unsigned char *buf, int count)
2144{ /* ftdi_write */
2145        struct ftdi_private *priv = usb_get_serial_port_data(port);
2146        struct urb *urb;
2147        unsigned char *buffer;
2148        int data_offset ;       /* will be 1 for the SIO and 0 otherwise */
2149        int status;
2150        int transfer_size;
2151        unsigned long flags;
2152
2153        dbg("%s port %d, %d bytes", __FUNCTION__, port->number, count);
2154
2155        if (count == 0) {
2156                dbg("write request of 0 bytes");
2157                return 0;
2158        }
2159        spin_lock_irqsave(&priv->tx_lock, flags);
2160        if (priv->tx_outstanding_urbs > URB_UPPER_LIMIT) {
2161                spin_unlock_irqrestore(&priv->tx_lock, flags);
2162                dbg("%s - write limit hit\n", __FUNCTION__);
2163                return 0;
2164        }
2165        priv->tx_outstanding_urbs++;
2166        spin_unlock_irqrestore(&priv->tx_lock, flags);
2167
2168        data_offset = priv->write_offset;
2169        dbg("data_offset set to %d",data_offset);
2170
2171        /* Determine total transfer size */
2172        transfer_size = count;
2173        if (data_offset > 0) {
2174                /* Original sio needs control bytes too... */
2175                transfer_size += (data_offset *
2176                                ((count + (priv->max_packet_size - 1 - data_offset)) /
2177                                 (priv->max_packet_size - data_offset)));
2178        }
2179
2180        buffer = kmalloc (transfer_size, GFP_ATOMIC);
2181        if (!buffer) {
2182                err("%s ran out of kernel memory for urb ...", __FUNCTION__);
2183                count = -ENOMEM;
2184                goto error_no_buffer;
2185        }
2186
2187        urb = usb_alloc_urb(0, GFP_ATOMIC);
2188        if (!urb) {
2189                err("%s - no more free urbs", __FUNCTION__);
2190                count = -ENOMEM;
2191                goto error_no_urb;
2192        }
2193
2194        /* Copy data */
2195        if (data_offset > 0) {
2196                /* Original sio requires control byte at start of each packet. */
2197                int user_pktsz = priv->max_packet_size - data_offset;
2198                int todo = count;
2199                unsigned char *first_byte = buffer;
2200                const unsigned char *current_position = buf;
2201
2202                while (todo > 0) {
2203                        if (user_pktsz > todo) {
2204                                user_pktsz = todo;
2205                        }
2206                        /* Write the control byte at the front of the packet*/
2207                        *first_byte = 1 | ((user_pktsz) << 2);
2208                        /* Copy data for packet */
2209                        memcpy (first_byte + data_offset,
2210                                current_position, user_pktsz);
2211                        first_byte += user_pktsz + data_offset;
2212                        current_position += user_pktsz;
2213                        todo -= user_pktsz;
2214                }
2215        } else {
2216                /* No control byte required. */
2217                /* Copy in the data to send */
2218                memcpy (buffer, buf, count);
2219        }
2220
2221        usb_serial_debug_data(debug, &port->dev, __FUNCTION__, transfer_size, buffer);
2222
2223        /* fill the buffer and send it */
2224        usb_fill_bulk_urb(urb, port->serial->dev,
2225                      usb_sndbulkpipe(port->serial->dev, port->bulk_out_endpointAddress),
2226                      buffer, transfer_size,
2227                      ftdi_write_bulk_callback, port);
2228
2229        status = usb_submit_urb(urb, GFP_ATOMIC);
2230        if (status) {
2231                err("%s - failed submitting write urb, error %d", __FUNCTION__, status);
2232                count = status;
2233                goto error;
2234        } else {
2235                spin_lock_irqsave(&priv->tx_lock, flags);
2236                priv->tx_outstanding_bytes += count;
2237                priv->tx_bytes += count;
2238                spin_unlock_irqrestore(&priv->tx_lock, flags);
2239        }
2240
2241        /* we are done with this urb, so let the host driver
2242         * really free it when it is finished with it */
2243        usb_free_urb(urb);
2244
2245        dbg("%s write returning: %d", __FUNCTION__, count);
2246        return count;
2247error:
2248        usb_free_urb(urb);
2249error_no_urb:
2250        kfree (buffer);
2251error_no_buffer:
2252        spin_lock_irqsave(&priv->tx_lock, flags);
2253        priv->tx_outstanding_urbs--;
2254        spin_unlock_irqrestore(&priv->tx_lock, flags);
2255        return count;
2256} /* ftdi_write */
2257
2258
2259/* This function may get called when the device is closed */
2260
2261static void ftdi_write_bulk_callback (struct urb *urb)
2262{
2263        unsigned long flags;
2264        struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
2265        struct ftdi_private *priv;
2266        int data_offset;       /* will be 1 for the SIO and 0 otherwise */
2267        unsigned long countback;
2268        int status = urb->status;
2269
2270        /* free up the transfer buffer, as usb_free_urb() does not do this */
2271        kfree (urb->transfer_buffer);
2272
2273        dbg("%s - port %d", __FUNCTION__, port->number);
2274
2275        if (status) {
2276                dbg("nonzero write bulk status received: %d", status);
2277                return;
2278        }
2279
2280        priv = usb_get_serial_port_data(port);
2281        if (!priv) {
2282                dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
2283                return;
2284        }
2285        /* account for transferred data */
2286        countback = urb->actual_length;
2287        data_offset = priv->write_offset;
2288        if (data_offset > 0) {
2289                /* Subtract the control bytes */
2290                countback -= (data_offset * ((countback + (priv->max_packet_size - 1)) / priv->max_packet_size));
2291        }
2292        spin_lock_irqsave(&priv->tx_lock, flags);
2293        --priv->tx_outstanding_urbs;
2294        priv->tx_outstanding_bytes -= countback;
2295        spin_unlock_irqrestore(&priv->tx_lock, flags);
2296
2297        usb_serial_port_softint(port);
2298} /* ftdi_write_bulk_callback */
2299
2300
2301static int ftdi_write_room( struct usb_serial_port *port )
2302{
2303        struct ftdi_private *priv = usb_get_serial_port_data(port);
2304        int room;
2305        unsigned long flags;
2306
2307        dbg("%s - port %d", __FUNCTION__, port->number);
2308
2309        spin_lock_irqsave(&priv->tx_lock, flags);
2310        if (priv->tx_outstanding_urbs < URB_UPPER_LIMIT) {
2311                /*
2312                 * We really can take anything the user throws at us
2313                 * but let's pick a nice big number to tell the tty
2314                 * layer that we have lots of free space
2315                 */
2316                room = 2048;
2317        } else {
2318                room = 0;
2319        }
2320        spin_unlock_irqrestore(&priv->tx_lock, flags);
2321        return room;
2322} /* ftdi_write_room */
2323
2324
2325static int ftdi_chars_in_buffer (struct usb_serial_port *port)
2326{ /* ftdi_chars_in_buffer */
2327        struct ftdi_private *priv = usb_get_serial_port_data(port);
2328        int buffered;
2329        unsigned long flags;
2330
2331        dbg("%s - port %d", __FUNCTION__, port->number);
2332
2333        spin_lock_irqsave(&priv->tx_lock, flags);
2334        buffered = (int)priv->tx_outstanding_bytes;
2335        spin_unlock_irqrestore(&priv->tx_lock, flags);
2336        if (buffered < 0) {
2337                err("%s outstanding tx bytes is negative!", __FUNCTION__);
2338                buffered = 0;
2339        }
2340        return buffered;
2341} /* ftdi_chars_in_buffer */
2342
2343
2344
2345static void ftdi_read_bulk_callback (struct urb *urb)
2346{ /* ftdi_read_bulk_callback */
2347        struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
2348        struct tty_struct *tty;
2349        struct ftdi_private *priv;
2350        unsigned long countread;
2351        unsigned long flags;
2352        int status = urb->status;
2353
2354        if (urb->number_of_packets > 0) {
2355                err("%s transfer_buffer_length %d actual_length %d number of packets %d",__FUNCTION__,
2356                    urb->transfer_buffer_length, urb->actual_length, urb->number_of_packets );
2357                err("%s transfer_flags %x ", __FUNCTION__,urb->transfer_flags );
2358        }
2359
2360        dbg("%s - port %d", __FUNCTION__, port->number);
2361
2362        if (port->open_count <= 0)
2363                return;
2364
2365        tty = port->tty;
2366        if (!tty) {
2367                dbg("%s - bad tty pointer - exiting",__FUNCTION__);
2368                return;
2369        }
2370
2371        priv = usb_get_serial_port_data(port);
2372        if (!priv) {
2373                dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
2374                return;
2375        }
2376
2377        if (urb != port->read_urb) {
2378                err("%s - Not my urb!", __FUNCTION__);
2379        }
2380
2381        if (status) {
2382                /* This will happen at close every time so it is a dbg not an err */
2383                dbg("(this is ok on close) nonzero read bulk status received: "
2384                    "%d", status);
2385                return;
2386        }
2387
2388        /* count data bytes, but not status bytes */
2389        countread = urb->actual_length;
2390        countread -= 2 * ((countread + (priv->max_packet_size - 1)) / priv->max_packet_size);
2391        spin_lock_irqsave(&priv->rx_lock, flags);
2392        priv->rx_bytes += countread;
2393        spin_unlock_irqrestore(&priv->rx_lock, flags);
2394
2395        ftdi_process_read(&priv->rx_work.work);
2396
2397} /* ftdi_read_bulk_callback */
2398
2399
2400static void ftdi_process_read (struct work_struct *work)
2401{ /* ftdi_process_read */
2402        struct ftdi_private *priv =
2403                container_of(work, struct ftdi_private, rx_work.work);
2404        struct usb_serial_port *port = priv->port;
2405        struct urb *urb;
2406        struct tty_struct *tty;
2407        char error_flag;
2408        unsigned char *data;
2409
2410        int i;
2411        int result;
2412        int need_flip;
2413        int packet_offset;
2414        unsigned long flags;
2415
2416        dbg("%s - port %d", __FUNCTION__, port->number);
2417
2418        if (port->open_count <= 0)
2419                return;
2420
2421        tty = port->tty;
2422        if (!tty) {
2423                dbg("%s - bad tty pointer - exiting",__FUNCTION__);
2424                return;
2425        }
2426
2427        priv = usb_get_serial_port_data(port);
2428        if (!priv) {
2429                dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
2430                return;
2431        }
2432
2433        urb = port->read_urb;
2434        if (!urb) {
2435                dbg("%s - bad read_urb pointer - exiting", __FUNCTION__);
2436                return;
2437        }
2438
2439        data = urb->transfer_buffer;
2440
2441        if (priv->rx_processed) {
2442                dbg("%s - already processed: %d bytes, %d remain", __FUNCTION__,
2443                                priv->rx_processed,
2444                                urb->actual_length - priv->rx_processed);
2445        } else {
2446                /* The first two bytes of every read packet are status */
2447                if (urb->actual_length > 2) {
2448                        usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
2449                } else {
2450                        dbg("Status only: %03oo %03oo",data[0],data[1]);
2451                }
2452        }
2453
2454
2455        /* TO DO -- check for hung up line and handle appropriately: */
2456        /*   send hangup  */
2457        /* See acm.c - you do a tty_hangup  - eg tty_hangup(tty) */
2458        /* if CD is dropped and the line is not CLOCAL then we should hangup */
2459
2460        need_flip = 0;
2461        for (packet_offset = priv->rx_processed; packet_offset < urb->actual_length; packet_offset += priv->max_packet_size) {
2462                int length;
2463
2464                /* Compare new line status to the old one, signal if different */
2465                /* N.B. packet may be processed more than once, but differences
2466                 * are only processed once.  */
2467                if (priv != NULL) {
2468                        char new_status = data[packet_offset+0] & FTDI_STATUS_B0_MASK;
2469                        if (new_status != priv->prev_status) {
2470                                priv->diff_status |= new_status ^ priv->prev_status;
2471                                wake_up_interruptible(&priv->delta_msr_wait);
2472                                priv->prev_status = new_status;
2473                        }
2474                }
2475
2476                length = min((int) priv->max_packet_size, (int) urb->actual_length-packet_offset)-2;
2477                if (length < 0) {
2478                        err("%s - bad packet length: %d", __FUNCTION__, length+2);
2479                        length = 0;
2480                }
2481
2482                if (priv->rx_flags & THROTTLED) {
2483                        dbg("%s - throttled", __FUNCTION__);
2484                        break;
2485                }
2486                if (tty_buffer_request_room(tty, length) < length) {
2487                        /* break out & wait for throttling/unthrottling to happen */
2488                        dbg("%s - receive room low", __FUNCTION__);
2489                        break;
2490                }
2491
2492                /* Handle errors and break */
2493                error_flag = TTY_NORMAL;
2494                /* Although the device uses a bitmask and hence can have multiple */
2495                /* errors on a packet - the order here sets the priority the */
2496                /* error is returned to the tty layer  */
2497
2498                if ( data[packet_offset+1] & FTDI_RS_OE ) {
2499                        error_flag = TTY_OVERRUN;
2500                        dbg("OVERRRUN error");
2501                }
2502                if ( data[packet_offset+1] & FTDI_RS_BI ) {
2503                        error_flag = TTY_BREAK;
2504                        dbg("BREAK received");
2505                }
2506                if ( data[packet_offset+1] & FTDI_RS_PE ) {
2507                        error_flag = TTY_PARITY;
2508                        dbg("PARITY error");
2509                }
2510                if ( data[packet_offset+1] & FTDI_RS_FE ) {
2511                        error_flag = TTY_FRAME;
2512                        dbg("FRAMING error");
2513                }
2514                if (length > 0) {
2515                        for (i = 2; i < length+2; i++) {
2516                                /* Note that the error flag is duplicated for
2517                                   every character received since we don't know
2518                                   which character it applied to */
2519                                tty_insert_flip_char(tty, data[packet_offset+i], error_flag);
2520                        }
2521                        need_flip = 1;
2522                }
2523
2524#ifdef NOT_CORRECT_BUT_KEEPING_IT_FOR_NOW
2525                /* if a parity error is detected you get status packets forever
2526                   until a character is sent without a parity error.
2527                   This doesn't work well since the application receives a never
2528                   ending stream of bad data - even though new data hasn't been sent.
2529                   Therefore I (bill) have taken this out.
2530                   However - this might make sense for framing errors and so on
2531                   so I am leaving the code in for now.
2532                */
2533                else {
2534                        if (error_flag != TTY_NORMAL){
2535                                dbg("error_flag is not normal");
2536                                /* In this case it is just status - if that is an error send a bad character */
2537                                if(tty->flip.count >= TTY_FLIPBUF_SIZE) {
2538                                        tty_flip_buffer_push(tty);
2539                                }
2540                                tty_insert_flip_char(tty, 0xff, error_flag);
2541                                need_flip = 1;
2542                        }
2543                }
2544#endif
2545        } /* "for(packet_offset=0..." */
2546
2547        /* Low latency */
2548        if (need_flip) {
2549                tty_flip_buffer_push(tty);
2550        }
2551
2552        if (packet_offset < urb->actual_length) {
2553                /* not completely processed - record progress */
2554                priv->rx_processed = packet_offset;
2555                dbg("%s - incomplete, %d bytes processed, %d remain",
2556                                __FUNCTION__, packet_offset,
2557                                urb->actual_length - packet_offset);
2558                /* check if we were throttled while processing */
2559                spin_lock_irqsave(&priv->rx_lock, flags);
2560                if (priv->rx_flags & THROTTLED) {
2561                        priv->rx_flags |= ACTUALLY_THROTTLED;
2562                        spin_unlock_irqrestore(&priv->rx_lock, flags);
2563                        dbg("%s - deferring remainder until unthrottled",
2564                                        __FUNCTION__);
2565                        return;
2566                }
2567                spin_unlock_irqrestore(&priv->rx_lock, flags);
2568                /* if the port is closed stop trying to read */
2569                if (port->open_count > 0){
2570                        /* delay processing of remainder */
2571                        schedule_delayed_work(&priv->rx_work, 1);
2572                } else {
2573                        dbg("%s - port is closed", __FUNCTION__);
2574                }
2575                return;
2576        }
2577
2578        /* urb is completely processed */
2579        priv->rx_processed = 0;
2580
2581        /* if the port is closed stop trying to read */
2582        if (port->open_count > 0){
2583                /* Continue trying to always read  */
2584                usb_fill_bulk_urb(port->read_urb, port->serial->dev,
2585                              usb_rcvbulkpipe(port->serial->dev, port->bulk_in_endpointAddress),
2586                              port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
2587                              ftdi_read_bulk_callback, port);
2588
2589                result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
2590                if (result)
2591                        err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
2592        }
2593
2594        return;
2595} /* ftdi_process_read */
2596
2597
2598static void ftdi_break_ctl( struct usb_serial_port *port, int break_state )
2599{
2600        struct ftdi_private *priv = usb_get_serial_port_data(port);
2601        __u16 urb_value = 0;
2602
2603        /* break_state = -1 to turn on break, and 0 to turn off break */
2604        /* see drivers/char/tty_io.c to see it used */
2605        /* last_set_data_urb_value NEVER has the break bit set in it */
2606
2607        if (break_state) {
2608                urb_value = priv->last_set_data_urb_value | FTDI_SIO_SET_BREAK;
2609        } else {
2610                urb_value = priv->last_set_data_urb_value;
2611        }
2612
2613
2614        if (usb_control_msg(port->serial->dev, usb_sndctrlpipe(port->serial->dev, 0),
2615                            FTDI_SIO_SET_DATA_REQUEST,
2616                            FTDI_SIO_SET_DATA_REQUEST_TYPE,
2617                            urb_value , priv->interface,
2618                            NULL, 0, WDR_TIMEOUT) < 0) {
2619                err("%s FAILED to enable/disable break state (state was %d)", __FUNCTION__,break_state);
2620        }
2621
2622        dbg("%s break state is %d - urb is %d", __FUNCTION__,break_state, urb_value);
2623
2624}
2625
2626
2627/* old_termios contains the original termios settings and tty->termios contains
2628 * the new setting to be used
2629 * WARNING: set_termios calls this with old_termios in kernel space
2630 */
2631
2632static void ftdi_set_termios (struct usb_serial_port *port, struct ktermios *old_termios)
2633{ /* ftdi_termios */
2634        struct usb_device *dev = port->serial->dev;
2635        unsigned int cflag = port->tty->termios->c_cflag;
2636        struct ftdi_private *priv = usb_get_serial_port_data(port);
2637        __u16 urb_value; /* will hold the new flags */
2638
2639        // Added for xon/xoff support
2640        unsigned int iflag = port->tty->termios->c_iflag;
2641        unsigned char vstop;
2642        unsigned char vstart;
2643
2644        dbg("%s", __FUNCTION__);
2645
2646        /* Force baud rate if this device requires it, unless it is set to B0. */
2647        if (priv->force_baud && ((port->tty->termios->c_cflag & CBAUD) != B0)) {
2648                dbg("%s: forcing baud rate for this device", __FUNCTION__);
2649                port->tty->termios->c_cflag &= ~CBAUD;
2650                port->tty->termios->c_cflag |= priv->force_baud;
2651        }
2652
2653        /* Force RTS-CTS if this device requires it. */
2654        if (priv->force_rtscts) {
2655                dbg("%s: forcing rtscts for this device", __FUNCTION__);
2656                port->tty->termios->c_cflag |= CRTSCTS;
2657        }
2658
2659        cflag = port->tty->termios->c_cflag;
2660
2661        /* FIXME -For this cut I don't care if the line is really changing or
2662           not  - so just do the change regardless  - should be able to
2663           compare old_termios and tty->termios */
2664        /* NOTE These routines can get interrupted by
2665           ftdi_sio_read_bulk_callback  - need to examine what this
2666           means - don't see any problems yet */
2667
2668        /* Set number of data bits, parity, stop bits */
2669
2670        urb_value = 0;
2671        urb_value |= (cflag & CSTOPB ? FTDI_SIO_SET_DATA_STOP_BITS_2 :
2672                      FTDI_SIO_SET_DATA_STOP_BITS_1);
2673        urb_value |= (cflag & PARENB ?
2674                      (cflag & PARODD ? FTDI_SIO_SET_DATA_PARITY_ODD :
2675                       FTDI_SIO_SET_DATA_PARITY_EVEN) :
2676                      FTDI_SIO_SET_DATA_PARITY_NONE);
2677        if (cflag & CSIZE) {
2678                switch (cflag & CSIZE) {
2679                case CS5: urb_value |= 5; dbg("Setting CS5"); break;
2680                case CS6: urb_value |= 6; dbg("Setting CS6"); break;
2681                case CS7: urb_value |= 7; dbg("Setting CS7"); break;
2682                case CS8: urb_value |= 8; dbg("Setting CS8"); break;
2683                default:
2684                        err("CSIZE was set but not CS5-CS8");
2685                }
2686        }
2687
2688        /* This is needed by the break command since it uses the same command - but is
2689         *  or'ed with this value  */
2690        priv->last_set_data_urb_value = urb_value;
2691
2692        if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2693                            FTDI_SIO_SET_DATA_REQUEST,
2694                            FTDI_SIO_SET_DATA_REQUEST_TYPE,
2695                            urb_value , priv->interface,
2696                            NULL, 0, WDR_SHORT_TIMEOUT) < 0) {
2697                err("%s FAILED to set databits/stopbits/parity", __FUNCTION__);
2698        }
2699
2700        /* Now do the baudrate */
2701        if ((cflag & CBAUD) == B0 ) {
2702                /* Disable flow control */
2703                if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2704                                    FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2705                                    FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2706                                    0, priv->interface,
2707                                    NULL, 0, WDR_TIMEOUT) < 0) {
2708                        err("%s error from disable flowcontrol urb", __FUNCTION__);
2709                }
2710                /* Drop RTS and DTR */
2711                clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2712        } else {
2713                /* set the baudrate determined before */
2714                if (change_speed(port)) {
2715                        err("%s urb failed to set baudrate", __FUNCTION__);
2716                }
2717                /* Ensure RTS and DTR are raised when baudrate changed from 0 */
2718                if (!old_termios || (old_termios->c_cflag & CBAUD) == B0) {
2719                        set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2720                }
2721        }
2722
2723        /* Set flow control */
2724        /* Note device also supports DTR/CD (ugh) and Xon/Xoff in hardware */
2725        if (cflag & CRTSCTS) {
2726                dbg("%s Setting to CRTSCTS flow control", __FUNCTION__);
2727                if (usb_control_msg(dev,
2728                                    usb_sndctrlpipe(dev, 0),
2729                                    FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2730                                    FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2731                                    0 , (FTDI_SIO_RTS_CTS_HS | priv->interface),
2732                                    NULL, 0, WDR_TIMEOUT) < 0) {
2733                        err("urb failed to set to rts/cts flow control");
2734                }
2735
2736        } else {
2737                /*
2738                 * Xon/Xoff code
2739                 *
2740                 * Check the IXOFF status in the iflag component of the termios structure
2741                 * if IXOFF is not set, the pre-xon/xoff code is executed.
2742                */
2743                if (iflag & IXOFF) {
2744                        dbg("%s  request to enable xonxoff iflag=%04x",__FUNCTION__,iflag);
2745                        // Try to enable the XON/XOFF on the ftdi_sio
2746                        // Set the vstart and vstop -- could have been done up above where
2747                        // a lot of other dereferencing is done but that would be very
2748                        // inefficient as vstart and vstop are not always needed
2749                        vstart=port->tty->termios->c_cc[VSTART];
2750                        vstop=port->tty->termios->c_cc[VSTOP];
2751                        urb_value=(vstop << 8) | (vstart);
2752
2753                        if (usb_control_msg(dev,
2754                                            usb_sndctrlpipe(dev, 0),
2755                                            FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2756                                            FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2757                                            urb_value , (FTDI_SIO_XON_XOFF_HS
2758                                                         | priv->interface),
2759                                            NULL, 0, WDR_TIMEOUT) < 0) {
2760                                err("urb failed to set to xon/xoff flow control");
2761                        }
2762                } else {
2763                        /* else clause to only run if cfag ! CRTSCTS and iflag ! XOFF */
2764                        /* CHECKME Assuming XON/XOFF handled by tty stack - not by device */
2765                        dbg("%s Turning off hardware flow control", __FUNCTION__);
2766                        if (usb_control_msg(dev,
2767                                            usb_sndctrlpipe(dev, 0),
2768                                            FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2769                                            FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2770                                            0, priv->interface,
2771                                            NULL, 0, WDR_TIMEOUT) < 0) {
2772                                err("urb failed to clear flow control");
2773                        }
2774                }
2775
2776        }
2777        return;
2778} /* ftdi_termios */
2779
2780
2781static int ftdi_tiocmget (struct usb_serial_port *port, struct file *file)
2782{
2783        struct ftdi_private *priv = usb_get_serial_port_data(port);
2784        unsigned char buf[2];
2785        int ret;
2786
2787        dbg("%s TIOCMGET", __FUNCTION__);
2788        switch (priv->chip_type) {
2789        case SIO:
2790                /* Request the status from the device */
2791                if ((ret = usb_control_msg(port->serial->dev,
2792                                           usb_rcvctrlpipe(port->serial->dev, 0),
2793                                           FTDI_SIO_GET_MODEM_STATUS_REQUEST,
2794                                           FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
2795                                           0, 0,
2796                                           buf, 1, WDR_TIMEOUT)) < 0 ) {
2797                        err("%s Could not get modem status of device - err: %d", __FUNCTION__,
2798                            ret);
2799                        return(ret);
2800                }
2801                break;
2802        case FT8U232AM:
2803        case FT232BM:
2804        case FT2232C:
2805        case FT232RL:
2806        case FT2232H:
2807        case FT4232H:
2808        case FT232H:
2809        case FTX:
2810                /* the 8U232AM returns a two byte value (the sio is a 1 byte value) - in the same
2811                   format as the data returned from the in point */
2812                if ((ret = usb_control_msg(port->serial->dev,
2813                                           usb_rcvctrlpipe(port->serial->dev, 0),
2814                                           FTDI_SIO_GET_MODEM_STATUS_REQUEST,
2815                                           FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
2816                                           0, priv->interface,
2817                                           buf, 2, WDR_TIMEOUT)) < 0 ) {
2818                        err("%s Could not get modem status of device - err: %d", __FUNCTION__,
2819                            ret);
2820                        return(ret);
2821                }
2822                break;
2823        default:
2824                return -EFAULT;
2825                break;
2826        }
2827
2828        return  (buf[0] & FTDI_SIO_DSR_MASK ? TIOCM_DSR : 0) |
2829                (buf[0] & FTDI_SIO_CTS_MASK ? TIOCM_CTS : 0) |
2830                (buf[0]  & FTDI_SIO_RI_MASK  ? TIOCM_RI  : 0) |
2831                (buf[0]  & FTDI_SIO_RLSD_MASK ? TIOCM_CD  : 0) |
2832                priv->last_dtr_rts;
2833}
2834
2835static int ftdi_tiocmset(struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear)
2836{
2837        dbg("%s TIOCMSET", __FUNCTION__);
2838        return update_mctrl(port, set, clear);
2839}
2840
2841
2842static int ftdi_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
2843{
2844        struct ftdi_private *priv = usb_get_serial_port_data(port);
2845
2846        dbg("%s cmd 0x%04x", __FUNCTION__, cmd);
2847
2848        /* Based on code from acm.c and others */
2849        switch (cmd) {
2850
2851        case TIOCGSERIAL: /* gets serial port data */
2852                return get_serial_info(port, (struct serial_struct __user *) arg);
2853
2854        case TIOCSSERIAL: /* sets serial port data */
2855                return set_serial_info(port, (struct serial_struct __user *) arg);
2856
2857        /*
2858         * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
2859         * - mask passed in arg for lines of interest
2860         *   (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
2861         * Caller should use TIOCGICOUNT to see which one it was.
2862         *
2863         * This code is borrowed from linux/drivers/char/serial.c
2864         */
2865        case TIOCMIWAIT:
2866                while (priv != NULL) {
2867                        interruptible_sleep_on(&priv->delta_msr_wait);
2868                        /* see if a signal did it */
2869                        if (signal_pending(current))
2870                                return -ERESTARTSYS;
2871                        else {
2872                                char diff = priv->diff_status;
2873
2874                                if (diff == 0) {
2875                                        return -EIO; /* no change => error */
2876                                }
2877
2878                                /* Consume all events */
2879                                priv->diff_status = 0;
2880
2881                                /* Return 0 if caller wanted to know about these bits */
2882                                if ( ((arg & TIOCM_RNG) && (diff & FTDI_RS0_RI)) ||
2883                                     ((arg & TIOCM_DSR) && (diff & FTDI_RS0_DSR)) ||
2884                                     ((arg & TIOCM_CD)  && (diff & FTDI_RS0_RLSD)) ||
2885                                     ((arg & TIOCM_CTS) && (diff & FTDI_RS0_CTS)) ) {
2886                                        return 0;
2887                                }
2888                                /*
2889                                 * Otherwise caller can't care less about what happened,
2890                                 * and so we continue to wait for more events.
2891                                 */
2892                        }
2893                }
2894                return(0);
2895                break;
2896        default:
2897                break;
2898
2899        }
2900
2901
2902        /* This is not necessarily an error - turns out the higher layers will do
2903         *  some ioctls itself (see comment above)
2904         */
2905        dbg("%s arg not supported - it was 0x%04x - check /usr/include/asm/ioctls.h", __FUNCTION__, cmd);
2906
2907        return(-ENOIOCTLCMD);
2908} /* ftdi_ioctl */
2909
2910
2911static void ftdi_throttle (struct usb_serial_port *port)
2912{
2913        struct ftdi_private *priv = usb_get_serial_port_data(port);
2914        unsigned long flags;
2915
2916        dbg("%s - port %d", __FUNCTION__, port->number);
2917
2918        spin_lock_irqsave(&priv->rx_lock, flags);
2919        priv->rx_flags |= THROTTLED;
2920        spin_unlock_irqrestore(&priv->rx_lock, flags);
2921}
2922
2923
2924static void ftdi_unthrottle (struct usb_serial_port *port)
2925{
2926        struct ftdi_private *priv = usb_get_serial_port_data(port);
2927        int actually_throttled;
2928        unsigned long flags;
2929
2930        dbg("%s - port %d", __FUNCTION__, port->number);
2931
2932        spin_lock_irqsave(&priv->rx_lock, flags);
2933        actually_throttled = priv->rx_flags & ACTUALLY_THROTTLED;
2934        priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
2935        spin_unlock_irqrestore(&priv->rx_lock, flags);
2936
2937        if (actually_throttled)
2938                schedule_delayed_work(&priv->rx_work, 0);
2939}
2940
2941static int __init ftdi_init (void)
2942{
2943        int retval;
2944
2945        dbg("%s", __FUNCTION__);
2946        if (vendor > 0 && product > 0) {
2947                /* Add user specified VID/PID to reserved element of table. */
2948                int i;
2949                for (i = 0; id_table_combined[i].idVendor; i++)
2950                        ;
2951                id_table_combined[i].match_flags = USB_DEVICE_ID_MATCH_DEVICE;
2952                id_table_combined[i].idVendor = vendor;
2953                id_table_combined[i].idProduct = product;
2954        }
2955        retval = usb_serial_register(&ftdi_sio_device);
2956        if (retval)
2957                goto failed_sio_register;
2958        retval = usb_register(&ftdi_driver);
2959        if (retval)
2960                goto failed_usb_register;
2961
2962        info(DRIVER_VERSION ":" DRIVER_DESC);
2963        return 0;
2964failed_usb_register:
2965        usb_serial_deregister(&ftdi_sio_device);
2966failed_sio_register:
2967        return retval;
2968}
2969
2970
2971static void __exit ftdi_exit (void)
2972{
2973
2974        dbg("%s", __FUNCTION__);
2975
2976        usb_deregister (&ftdi_driver);
2977        usb_serial_deregister (&ftdi_sio_device);
2978
2979}
2980
2981
2982module_init(ftdi_init);
2983module_exit(ftdi_exit);
2984
2985MODULE_AUTHOR( DRIVER_AUTHOR );
2986MODULE_DESCRIPTION( DRIVER_DESC );
2987MODULE_LICENSE("GPL");
2988
2989module_param(debug, bool, S_IRUGO | S_IWUSR);
2990MODULE_PARM_DESC(debug, "Debug enabled or not");
2991module_param(vendor, ushort, 0);
2992MODULE_PARM_DESC(vendor, "User specified vendor ID (default="
2993                __MODULE_STRING(FTDI_VID)")");
2994module_param(product, ushort, 0);
2995MODULE_PARM_DESC(vendor, "User specified product ID");
2996