Merge drm/drm-fixes into drm-misc-fixes
[linux-2.6-microblaze.git] / drivers / usb / serial / ftdi_sio.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * USB FTDI SIO driver
4  *
5  *      Copyright (C) 2009 - 2013
6  *          Johan Hovold (jhovold@gmail.com)
7  *      Copyright (C) 1999 - 2001
8  *          Greg Kroah-Hartman (greg@kroah.com)
9  *          Bill Ryder (bryder@sgi.com)
10  *      Copyright (C) 2002
11  *          Kuba Ober (kuba@mareimbrium.org)
12  *
13  * See Documentation/usb/usb-serial.rst for more information on using this
14  * driver
15  *
16  * See http://ftdi-usb-sio.sourceforge.net for up to date testing info
17  *      and extra documentation
18  *
19  * Change entries from 2004 and earlier can be found in versions of this
20  * file in kernel versions prior to the 2.6.24 release.
21  *
22  */
23
24 /* Bill Ryder - bryder@sgi.com - wrote the FTDI_SIO implementation */
25 /* Thanx to FTDI for so kindly providing details of the protocol required */
26 /*   to talk to the device */
27 /* Thanx to gkh and the rest of the usb dev group for all code I have
28    assimilated :-) */
29
30 #include <linux/kernel.h>
31 #include <linux/errno.h>
32 #include <linux/slab.h>
33 #include <linux/tty.h>
34 #include <linux/tty_driver.h>
35 #include <linux/tty_flip.h>
36 #include <linux/module.h>
37 #include <linux/spinlock.h>
38 #include <linux/mutex.h>
39 #include <linux/uaccess.h>
40 #include <linux/usb.h>
41 #include <linux/serial.h>
42 #include <linux/gpio/driver.h>
43 #include <linux/usb/serial.h>
44 #include "ftdi_sio.h"
45 #include "ftdi_sio_ids.h"
46
47 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>, Bill Ryder <bryder@sgi.com>, Kuba Ober <kuba@mareimbrium.org>, Andreas Mohr, Johan Hovold <jhovold@gmail.com>"
48 #define DRIVER_DESC "USB FTDI Serial Converters Driver"
49
50
51 struct ftdi_private {
52         enum ftdi_chip_type chip_type;
53                                 /* type of device, either SIO or FT8U232AM */
54         int baud_base;          /* baud base clock for divisor setting */
55         int custom_divisor;     /* custom_divisor kludge, this is for
56                                    baud_base (different from what goes to the
57                                    chip!) */
58         u16 last_set_data_value; /* the last data state set - needed for doing
59                                   * a break
60                                   */
61         int flags;              /* some ASYNC_xxxx flags are supported */
62         unsigned long last_dtr_rts;     /* saved modem control outputs */
63         char prev_status;        /* Used for TIOCMIWAIT */
64         char transmit_empty;    /* If transmitter is empty or not */
65         u16 interface;          /* FT2232C, FT2232H or FT4232H port interface
66                                    (0 for FT232/245) */
67
68         speed_t force_baud;     /* if non-zero, force the baud rate to
69                                    this value */
70         int force_rtscts;       /* if non-zero, force RTS-CTS to always
71                                    be enabled */
72
73         unsigned int latency;           /* latency setting in use */
74         unsigned short max_packet_size;
75         struct mutex cfg_lock; /* Avoid mess by parallel calls of config ioctl() and change_speed() */
76 #ifdef CONFIG_GPIOLIB
77         struct gpio_chip gc;
78         struct mutex gpio_lock; /* protects GPIO state */
79         bool gpio_registered;   /* is the gpiochip in kernel registered */
80         bool gpio_used;         /* true if the user requested a gpio */
81         u8 gpio_altfunc;        /* which pins are in gpio mode */
82         u8 gpio_output;         /* pin directions cache */
83         u8 gpio_value;          /* pin value for outputs */
84 #endif
85 };
86
87 /* struct ftdi_sio_quirk is used by devices requiring special attention. */
88 struct ftdi_sio_quirk {
89         int (*probe)(struct usb_serial *);
90         /* Special settings for probed ports. */
91         void (*port_probe)(struct ftdi_private *);
92 };
93
94 static int   ftdi_jtag_probe(struct usb_serial *serial);
95 static int   ftdi_NDI_device_setup(struct usb_serial *serial);
96 static int   ftdi_stmclite_probe(struct usb_serial *serial);
97 static int   ftdi_8u2232c_probe(struct usb_serial *serial);
98 static void  ftdi_USB_UIRT_setup(struct ftdi_private *priv);
99 static void  ftdi_HE_TIRA1_setup(struct ftdi_private *priv);
100
101 static const struct ftdi_sio_quirk ftdi_jtag_quirk = {
102         .probe  = ftdi_jtag_probe,
103 };
104
105 static const struct ftdi_sio_quirk ftdi_NDI_device_quirk = {
106         .probe  = ftdi_NDI_device_setup,
107 };
108
109 static const struct ftdi_sio_quirk ftdi_USB_UIRT_quirk = {
110         .port_probe = ftdi_USB_UIRT_setup,
111 };
112
113 static const struct ftdi_sio_quirk ftdi_HE_TIRA1_quirk = {
114         .port_probe = ftdi_HE_TIRA1_setup,
115 };
116
117 static const struct ftdi_sio_quirk ftdi_stmclite_quirk = {
118         .probe  = ftdi_stmclite_probe,
119 };
120
121 static const struct ftdi_sio_quirk ftdi_8u2232c_quirk = {
122         .probe  = ftdi_8u2232c_probe,
123 };
124
125 /*
126  * The 8U232AM has the same API as the sio except for:
127  * - it can support MUCH higher baudrates; up to:
128  *   o 921600 for RS232 and 2000000 for RS422/485 at 48MHz
129  *   o 230400 at 12MHz
130  *   so .. 8U232AM's baudrate setting codes are different
131  * - it has a two byte status code.
132  * - it returns characters every 16ms (the FTDI does it every 40ms)
133  *
134  * the bcdDevice value is used to differentiate FT232BM and FT245BM from
135  * the earlier FT8U232AM and FT8U232BM.  For now, include all known VID/PID
136  * combinations in both tables.
137  * FIXME: perhaps bcdDevice can also identify 12MHz FT8U232AM devices,
138  * but I don't know if those ever went into mass production. [Ian Abbott]
139  */
140
141
142
143 /*
144  * Device ID not listed? Test it using
145  * /sys/bus/usb-serial/drivers/ftdi_sio/new_id and send a patch or report.
146  */
147 static const struct usb_device_id id_table_combined[] = {
148         { USB_DEVICE(FTDI_VID, FTDI_BRICK_PID) },
149         { USB_DEVICE(FTDI_VID, FTDI_ZEITCONTROL_TAGTRACE_MIFARE_PID) },
150         { USB_DEVICE(FTDI_VID, FTDI_CTI_MINI_PID) },
151         { USB_DEVICE(FTDI_VID, FTDI_CTI_NANO_PID) },
152         { USB_DEVICE(FTDI_VID, FTDI_AMC232_PID) },
153         { USB_DEVICE(FTDI_VID, FTDI_CANUSB_PID) },
154         { USB_DEVICE(FTDI_VID, FTDI_CANDAPTER_PID) },
155         { USB_DEVICE(FTDI_VID, FTDI_BM_ATOM_NANO_PID) },
156         { USB_DEVICE(FTDI_VID, FTDI_NXTCAM_PID) },
157         { USB_DEVICE(FTDI_VID, FTDI_EV3CON_PID) },
158         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_0_PID) },
159         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_1_PID) },
160         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_2_PID) },
161         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_3_PID) },
162         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_4_PID) },
163         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_5_PID) },
164         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_6_PID) },
165         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_7_PID) },
166         { USB_DEVICE(FTDI_VID, FTDI_USINT_CAT_PID) },
167         { USB_DEVICE(FTDI_VID, FTDI_USINT_WKEY_PID) },
168         { USB_DEVICE(FTDI_VID, FTDI_USINT_RS232_PID) },
169         { USB_DEVICE(FTDI_VID, FTDI_ACTZWAVE_PID) },
170         { USB_DEVICE(FTDI_VID, FTDI_IRTRANS_PID) },
171         { USB_DEVICE(FTDI_VID, FTDI_IPLUS_PID) },
172         { USB_DEVICE(FTDI_VID, FTDI_IPLUS2_PID) },
173         { USB_DEVICE(FTDI_VID, FTDI_DMX4ALL) },
174         { USB_DEVICE(FTDI_VID, FTDI_SIO_PID) },
175         { USB_DEVICE(FTDI_VID, FTDI_8U232AM_PID) },
176         { USB_DEVICE(FTDI_VID, FTDI_8U232AM_ALT_PID) },
177         { USB_DEVICE(FTDI_VID, FTDI_232RL_PID) },
178         { USB_DEVICE(FTDI_VID, FTDI_8U2232C_PID) ,
179                 .driver_info = (kernel_ulong_t)&ftdi_8u2232c_quirk },
180         { USB_DEVICE(FTDI_VID, FTDI_4232H_PID) },
181         { USB_DEVICE(FTDI_VID, FTDI_232H_PID) },
182         { USB_DEVICE(FTDI_VID, FTDI_FTX_PID) },
183         { USB_DEVICE(FTDI_VID, FTDI_MICRO_CHAMELEON_PID) },
184         { USB_DEVICE(FTDI_VID, FTDI_RELAIS_PID) },
185         { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_PID) },
186         { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_SNIFFER_PID) },
187         { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_THROTTLE_PID) },
188         { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_GATEWAY_PID) },
189         { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_GBM_PID) },
190         { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_GBM_BOOST_PID) },
191         { USB_DEVICE(NEWPORT_VID, NEWPORT_AGILIS_PID) },
192         { USB_DEVICE(NEWPORT_VID, NEWPORT_CONEX_CC_PID) },
193         { USB_DEVICE(NEWPORT_VID, NEWPORT_CONEX_AGP_PID) },
194         { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_IOBOARD_PID) },
195         { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_MINI_IOBOARD_PID) },
196         { USB_DEVICE(FTDI_VID, FTDI_SPROG_II) },
197         { USB_DEVICE(FTDI_VID, FTDI_TAGSYS_LP101_PID) },
198         { USB_DEVICE(FTDI_VID, FTDI_TAGSYS_P200X_PID) },
199         { USB_DEVICE(FTDI_VID, FTDI_LENZ_LIUSB_PID) },
200         { USB_DEVICE(FTDI_VID, FTDI_XF_632_PID) },
201         { USB_DEVICE(FTDI_VID, FTDI_XF_634_PID) },
202         { USB_DEVICE(FTDI_VID, FTDI_XF_547_PID) },
203         { USB_DEVICE(FTDI_VID, FTDI_XF_633_PID) },
204         { USB_DEVICE(FTDI_VID, FTDI_XF_631_PID) },
205         { USB_DEVICE(FTDI_VID, FTDI_XF_635_PID) },
206         { USB_DEVICE(FTDI_VID, FTDI_XF_640_PID) },
207         { USB_DEVICE(FTDI_VID, FTDI_XF_642_PID) },
208         { USB_DEVICE(FTDI_VID, FTDI_DSS20_PID) },
209         { USB_DEVICE(FTDI_VID, FTDI_URBAN_0_PID) },
210         { USB_DEVICE(FTDI_VID, FTDI_URBAN_1_PID) },
211         { USB_DEVICE(FTDI_NF_RIC_VID, FTDI_NF_RIC_PID) },
212         { USB_DEVICE(FTDI_VID, FTDI_VNHCPCUSB_D_PID) },
213         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_0_PID) },
214         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_1_PID) },
215         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_2_PID) },
216         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_3_PID) },
217         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_4_PID) },
218         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_5_PID) },
219         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_6_PID) },
220         { USB_DEVICE(FTDI_VID, FTDI_R2000KU_TRUE_RNG) },
221         { USB_DEVICE(FTDI_VID, FTDI_VARDAAN_PID) },
222         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0100_PID) },
223         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0101_PID) },
224         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0102_PID) },
225         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0103_PID) },
226         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0104_PID) },
227         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0105_PID) },
228         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0106_PID) },
229         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0107_PID) },
230         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0108_PID) },
231         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0109_PID) },
232         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010A_PID) },
233         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010B_PID) },
234         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010C_PID) },
235         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010D_PID) },
236         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010E_PID) },
237         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010F_PID) },
238         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0110_PID) },
239         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0111_PID) },
240         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0112_PID) },
241         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0113_PID) },
242         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0114_PID) },
243         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0115_PID) },
244         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0116_PID) },
245         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0117_PID) },
246         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0118_PID) },
247         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0119_PID) },
248         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011A_PID) },
249         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011B_PID) },
250         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011C_PID) },
251         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011D_PID) },
252         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011E_PID) },
253         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011F_PID) },
254         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0120_PID) },
255         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0121_PID) },
256         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0122_PID) },
257         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0123_PID) },
258         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0124_PID) },
259         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0125_PID) },
260         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0126_PID) },
261         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0127_PID) },
262         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0128_PID) },
263         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0129_PID) },
264         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012A_PID) },
265         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012B_PID) },
266         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012C_PID) },
267         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012D_PID) },
268         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012E_PID) },
269         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012F_PID) },
270         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0130_PID) },
271         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0131_PID) },
272         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0132_PID) },
273         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0133_PID) },
274         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0134_PID) },
275         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0135_PID) },
276         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0136_PID) },
277         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0137_PID) },
278         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0138_PID) },
279         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0139_PID) },
280         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013A_PID) },
281         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013B_PID) },
282         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013C_PID) },
283         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013D_PID) },
284         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013E_PID) },
285         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013F_PID) },
286         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0140_PID) },
287         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0141_PID) },
288         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0142_PID) },
289         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0143_PID) },
290         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0144_PID) },
291         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0145_PID) },
292         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0146_PID) },
293         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0147_PID) },
294         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0148_PID) },
295         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0149_PID) },
296         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014A_PID) },
297         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014B_PID) },
298         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014C_PID) },
299         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014D_PID) },
300         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014E_PID) },
301         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014F_PID) },
302         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0150_PID) },
303         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0151_PID) },
304         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0152_PID) },
305         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0153_PID) },
306         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0154_PID) },
307         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0155_PID) },
308         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0156_PID) },
309         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0157_PID) },
310         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0158_PID) },
311         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0159_PID) },
312         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015A_PID) },
313         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015B_PID) },
314         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015C_PID) },
315         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015D_PID) },
316         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015E_PID) },
317         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015F_PID) },
318         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0160_PID) },
319         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0161_PID) },
320         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0162_PID) },
321         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0163_PID) },
322         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0164_PID) },
323         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0165_PID) },
324         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0166_PID) },
325         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0167_PID) },
326         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0168_PID) },
327         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0169_PID) },
328         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016A_PID) },
329         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016B_PID) },
330         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016C_PID) },
331         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016D_PID) },
332         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016E_PID) },
333         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016F_PID) },
334         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0170_PID) },
335         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0171_PID) },
336         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0172_PID) },
337         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0173_PID) },
338         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0174_PID) },
339         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0175_PID) },
340         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0176_PID) },
341         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0177_PID) },
342         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0178_PID) },
343         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0179_PID) },
344         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017A_PID) },
345         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017B_PID) },
346         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017C_PID) },
347         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017D_PID) },
348         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017E_PID) },
349         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017F_PID) },
350         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0180_PID) },
351         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0181_PID) },
352         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0182_PID) },
353         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0183_PID) },
354         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0184_PID) },
355         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0185_PID) },
356         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0186_PID) },
357         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0187_PID) },
358         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0188_PID) },
359         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0189_PID) },
360         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018A_PID) },
361         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018B_PID) },
362         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018C_PID) },
363         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018D_PID) },
364         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018E_PID) },
365         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018F_PID) },
366         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0190_PID) },
367         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0191_PID) },
368         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0192_PID) },
369         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0193_PID) },
370         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0194_PID) },
371         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0195_PID) },
372         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0196_PID) },
373         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0197_PID) },
374         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0198_PID) },
375         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0199_PID) },
376         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019A_PID) },
377         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019B_PID) },
378         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019C_PID) },
379         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019D_PID) },
380         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019E_PID) },
381         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019F_PID) },
382         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A0_PID) },
383         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A1_PID) },
384         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A2_PID) },
385         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A3_PID) },
386         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A4_PID) },
387         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A5_PID) },
388         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A6_PID) },
389         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A7_PID) },
390         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A8_PID) },
391         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A9_PID) },
392         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AA_PID) },
393         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AB_PID) },
394         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AC_PID) },
395         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AD_PID) },
396         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AE_PID) },
397         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AF_PID) },
398         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B0_PID) },
399         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B1_PID) },
400         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B2_PID) },
401         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B3_PID) },
402         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B4_PID) },
403         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B5_PID) },
404         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B6_PID) },
405         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B7_PID) },
406         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B8_PID) },
407         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B9_PID) },
408         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BA_PID) },
409         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BB_PID) },
410         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BC_PID) },
411         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BD_PID) },
412         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BE_PID) },
413         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BF_PID) },
414         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C0_PID) },
415         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C1_PID) },
416         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C2_PID) },
417         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C3_PID) },
418         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C4_PID) },
419         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C5_PID) },
420         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C6_PID) },
421         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C7_PID) },
422         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C8_PID) },
423         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C9_PID) },
424         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CA_PID) },
425         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CB_PID) },
426         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CC_PID) },
427         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CD_PID) },
428         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CE_PID) },
429         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CF_PID) },
430         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D0_PID) },
431         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D1_PID) },
432         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D2_PID) },
433         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D3_PID) },
434         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D4_PID) },
435         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D5_PID) },
436         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D6_PID) },
437         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D7_PID) },
438         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D8_PID) },
439         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D9_PID) },
440         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DA_PID) },
441         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DB_PID) },
442         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DC_PID) },
443         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DD_PID) },
444         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DE_PID) },
445         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DF_PID) },
446         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E0_PID) },
447         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E1_PID) },
448         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E2_PID) },
449         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E3_PID) },
450         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E4_PID) },
451         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E5_PID) },
452         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E6_PID) },
453         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E7_PID) },
454         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E8_PID) },
455         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E9_PID) },
456         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EA_PID) },
457         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EB_PID) },
458         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EC_PID) },
459         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01ED_PID) },
460         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EE_PID) },
461         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EF_PID) },
462         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F0_PID) },
463         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F1_PID) },
464         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F2_PID) },
465         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F3_PID) },
466         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F4_PID) },
467         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F5_PID) },
468         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F6_PID) },
469         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F7_PID) },
470         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F8_PID) },
471         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F9_PID) },
472         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FA_PID) },
473         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FB_PID) },
474         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FC_PID) },
475         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FD_PID) },
476         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FE_PID) },
477         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FF_PID) },
478         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_4701_PID) },
479         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9300_PID) },
480         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9301_PID) },
481         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9302_PID) },
482         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9303_PID) },
483         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9304_PID) },
484         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9305_PID) },
485         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9306_PID) },
486         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9307_PID) },
487         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9308_PID) },
488         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9309_PID) },
489         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_930A_PID) },
490         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_930B_PID) },
491         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_930C_PID) },
492         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_930D_PID) },
493         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_930E_PID) },
494         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_930F_PID) },
495         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9310_PID) },
496         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9311_PID) },
497         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9312_PID) },
498         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9313_PID) },
499         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9314_PID) },
500         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9315_PID) },
501         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9316_PID) },
502         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9317_PID) },
503         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9318_PID) },
504         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_9319_PID) },
505         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_931A_PID) },
506         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_931B_PID) },
507         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_931C_PID) },
508         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_931D_PID) },
509         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_931E_PID) },
510         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_931F_PID) },
511         { USB_DEVICE(FTDI_VID, FTDI_PERLE_ULTRAPORT_PID) },
512         { USB_DEVICE(FTDI_VID, FTDI_PIEGROUP_PID) },
513         { USB_DEVICE(FTDI_VID, FTDI_TNC_X_PID) },
514         { USB_DEVICE(FTDI_VID, FTDI_USBX_707_PID) },
515         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2101_PID) },
516         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2102_PID) },
517         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2103_PID) },
518         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2104_PID) },
519         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2106_PID) },
520         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_1_PID) },
521         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_2_PID) },
522         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_1_PID) },
523         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_2_PID) },
524         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_1_PID) },
525         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_2_PID) },
526         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_1_PID) },
527         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_2_PID) },
528         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_3_PID) },
529         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_4_PID) },
530         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_1_PID) },
531         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_2_PID) },
532         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_3_PID) },
533         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_4_PID) },
534         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_1_PID) },
535         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_2_PID) },
536         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_3_PID) },
537         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_4_PID) },
538         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_1_PID) },
539         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_2_PID) },
540         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_3_PID) },
541         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_4_PID) },
542         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_5_PID) },
543         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_6_PID) },
544         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_7_PID) },
545         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_8_PID) },
546         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_1_PID) },
547         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_2_PID) },
548         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_3_PID) },
549         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_4_PID) },
550         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_5_PID) },
551         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_6_PID) },
552         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_7_PID) },
553         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_8_PID) },
554         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_1_PID) },
555         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_2_PID) },
556         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_3_PID) },
557         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_4_PID) },
558         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_5_PID) },
559         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_6_PID) },
560         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_7_PID) },
561         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_8_PID) },
562         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803R_1_PID) },
563         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803R_2_PID) },
564         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803R_3_PID) },
565         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803R_4_PID) },
566         { USB_DEVICE(IDTECH_VID, IDTECH_IDT1221U_PID) },
567         { USB_DEVICE(OCT_VID, OCT_US101_PID) },
568         { USB_DEVICE(OCT_VID, OCT_DK201_PID) },
569         { USB_DEVICE(FTDI_VID, FTDI_HE_TIRA1_PID),
570                 .driver_info = (kernel_ulong_t)&ftdi_HE_TIRA1_quirk },
571         { USB_DEVICE(FTDI_VID, FTDI_USB_UIRT_PID),
572                 .driver_info = (kernel_ulong_t)&ftdi_USB_UIRT_quirk },
573         { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_1) },
574         { USB_DEVICE(FTDI_VID, PROTEGO_R2X0) },
575         { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_3) },
576         { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_4) },
577         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E808_PID) },
578         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E809_PID) },
579         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80A_PID) },
580         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80B_PID) },
581         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80C_PID) },
582         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80D_PID) },
583         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80E_PID) },
584         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80F_PID) },
585         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E888_PID) },
586         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E889_PID) },
587         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88A_PID) },
588         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88B_PID) },
589         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88C_PID) },
590         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88D_PID) },
591         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88E_PID) },
592         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88F_PID) },
593         { USB_DEVICE(FTDI_VID, FTDI_ELV_UO100_PID) },
594         { USB_DEVICE(FTDI_VID, FTDI_ELV_UM100_PID) },
595         { USB_DEVICE(FTDI_VID, FTDI_ELV_UR100_PID) },
596         { USB_DEVICE(FTDI_VID, FTDI_ELV_ALC8500_PID) },
597         { USB_DEVICE(FTDI_VID, FTDI_PYRAMID_PID) },
598         { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1000PC_PID) },
599         { USB_DEVICE(FTDI_VID, FTDI_IBS_US485_PID) },
600         { USB_DEVICE(FTDI_VID, FTDI_IBS_PICPRO_PID) },
601         { USB_DEVICE(FTDI_VID, FTDI_IBS_PCMCIA_PID) },
602         { USB_DEVICE(FTDI_VID, FTDI_IBS_PK1_PID) },
603         { USB_DEVICE(FTDI_VID, FTDI_IBS_RS232MON_PID) },
604         { USB_DEVICE(FTDI_VID, FTDI_IBS_APP70_PID) },
605         { USB_DEVICE(FTDI_VID, FTDI_IBS_PEDO_PID) },
606         { USB_DEVICE(FTDI_VID, FTDI_IBS_PROD_PID) },
607         { USB_DEVICE(FTDI_VID, FTDI_TAVIR_STK500_PID) },
608         { USB_DEVICE(FTDI_VID, FTDI_TIAO_UMPA_PID),
609                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
610         { USB_DEVICE(FTDI_VID, FTDI_NT_ORIONLXM_PID),
611                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
612         { USB_DEVICE(FTDI_VID, FTDI_NT_ORIONLX_PLUS_PID) },
613         { USB_DEVICE(FTDI_VID, FTDI_NT_ORION_IO_PID) },
614         { USB_DEVICE(FTDI_VID, FTDI_SYNAPSE_SS200_PID) },
615         { USB_DEVICE(FTDI_VID, FTDI_CUSTOMWARE_MINIPLEX_PID) },
616         { USB_DEVICE(FTDI_VID, FTDI_CUSTOMWARE_MINIPLEX2_PID) },
617         { USB_DEVICE(FTDI_VID, FTDI_CUSTOMWARE_MINIPLEX2WI_PID) },
618         { USB_DEVICE(FTDI_VID, FTDI_CUSTOMWARE_MINIPLEX3_PID) },
619         /*
620          * ELV devices:
621          */
622         { USB_DEVICE(FTDI_ELV_VID, FTDI_ELV_WS300_PID) },
623         { USB_DEVICE(FTDI_VID, FTDI_ELV_USR_PID) },
624         { USB_DEVICE(FTDI_VID, FTDI_ELV_MSM1_PID) },
625         { USB_DEVICE(FTDI_VID, FTDI_ELV_KL100_PID) },
626         { USB_DEVICE(FTDI_VID, FTDI_ELV_WS550_PID) },
627         { USB_DEVICE(FTDI_VID, FTDI_ELV_EC3000_PID) },
628         { USB_DEVICE(FTDI_VID, FTDI_ELV_WS888_PID) },
629         { USB_DEVICE(FTDI_VID, FTDI_ELV_TWS550_PID) },
630         { USB_DEVICE(FTDI_VID, FTDI_ELV_FEM_PID) },
631         { USB_DEVICE(FTDI_VID, FTDI_ELV_CLI7000_PID) },
632         { USB_DEVICE(FTDI_VID, FTDI_ELV_PPS7330_PID) },
633         { USB_DEVICE(FTDI_VID, FTDI_ELV_TFM100_PID) },
634         { USB_DEVICE(FTDI_VID, FTDI_ELV_UDF77_PID) },
635         { USB_DEVICE(FTDI_VID, FTDI_ELV_UIO88_PID) },
636         { USB_DEVICE(FTDI_VID, FTDI_ELV_UAD8_PID) },
637         { USB_DEVICE(FTDI_VID, FTDI_ELV_UDA7_PID) },
638         { USB_DEVICE(FTDI_VID, FTDI_ELV_USI2_PID) },
639         { USB_DEVICE(FTDI_VID, FTDI_ELV_T1100_PID) },
640         { USB_DEVICE(FTDI_VID, FTDI_ELV_PCD200_PID) },
641         { USB_DEVICE(FTDI_VID, FTDI_ELV_ULA200_PID) },
642         { USB_DEVICE(FTDI_VID, FTDI_ELV_CSI8_PID) },
643         { USB_DEVICE(FTDI_VID, FTDI_ELV_EM1000DL_PID) },
644         { USB_DEVICE(FTDI_VID, FTDI_ELV_PCK100_PID) },
645         { USB_DEVICE(FTDI_VID, FTDI_ELV_RFP500_PID) },
646         { USB_DEVICE(FTDI_VID, FTDI_ELV_FS20SIG_PID) },
647         { USB_DEVICE(FTDI_VID, FTDI_ELV_UTP8_PID) },
648         { USB_DEVICE(FTDI_VID, FTDI_ELV_WS300PC_PID) },
649         { USB_DEVICE(FTDI_VID, FTDI_ELV_WS444PC_PID) },
650         { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1300PC_PID) },
651         { USB_DEVICE(FTDI_VID, FTDI_ELV_EM1010PC_PID) },
652         { USB_DEVICE(FTDI_VID, FTDI_ELV_WS500_PID) },
653         { USB_DEVICE(FTDI_VID, FTDI_ELV_HS485_PID) },
654         { USB_DEVICE(FTDI_VID, FTDI_ELV_UMS100_PID) },
655         { USB_DEVICE(FTDI_VID, FTDI_ELV_TFD128_PID) },
656         { USB_DEVICE(FTDI_VID, FTDI_ELV_FM3RX_PID) },
657         { USB_DEVICE(FTDI_VID, FTDI_ELV_WS777_PID) },
658         { USB_DEVICE(FTDI_VID, FTDI_PALMSENS_PID) },
659         { USB_DEVICE(FTDI_VID, FTDI_IVIUM_XSTAT_PID) },
660         { USB_DEVICE(FTDI_VID, LINX_SDMUSBQSS_PID) },
661         { USB_DEVICE(FTDI_VID, LINX_MASTERDEVEL2_PID) },
662         { USB_DEVICE(FTDI_VID, LINX_FUTURE_0_PID) },
663         { USB_DEVICE(FTDI_VID, LINX_FUTURE_1_PID) },
664         { USB_DEVICE(FTDI_VID, LINX_FUTURE_2_PID) },
665         { USB_DEVICE(FTDI_VID, FTDI_CCSICDU20_0_PID) },
666         { USB_DEVICE(FTDI_VID, FTDI_CCSICDU40_1_PID) },
667         { USB_DEVICE(FTDI_VID, FTDI_CCSMACHX_2_PID) },
668         { USB_DEVICE(FTDI_VID, FTDI_CCSLOAD_N_GO_3_PID) },
669         { USB_DEVICE(FTDI_VID, FTDI_CCSICDU64_4_PID) },
670         { USB_DEVICE(FTDI_VID, FTDI_CCSPRIME8_5_PID) },
671         { USB_DEVICE(FTDI_VID, INSIDE_ACCESSO) },
672         { USB_DEVICE(INTREPID_VID, INTREPID_VALUECAN_PID) },
673         { USB_DEVICE(INTREPID_VID, INTREPID_NEOVI_PID) },
674         { USB_DEVICE(FALCOM_VID, FALCOM_TWIST_PID) },
675         { USB_DEVICE(FALCOM_VID, FALCOM_SAMBA_PID) },
676         { USB_DEVICE(FTDI_VID, FTDI_SUUNTO_SPORTS_PID) },
677         { USB_DEVICE(FTDI_VID, FTDI_OCEANIC_PID) },
678         { USB_DEVICE(TTI_VID, TTI_QL355P_PID) },
679         { USB_DEVICE(FTDI_VID, FTDI_RM_CANVIEW_PID) },
680         { USB_DEVICE(ACTON_VID, ACTON_SPECTRAPRO_PID) },
681         { USB_DEVICE(CONTEC_VID, CONTEC_COM1USBH_PID) },
682         { USB_DEVICE(MITSUBISHI_VID, MITSUBISHI_FXUSB_PID) },
683         { USB_DEVICE(BANDB_VID, BANDB_USOTL4_PID) },
684         { USB_DEVICE(BANDB_VID, BANDB_USTL4_PID) },
685         { USB_DEVICE(BANDB_VID, BANDB_USO9ML2_PID) },
686         { USB_DEVICE(BANDB_VID, BANDB_USOPTL4_PID) },
687         { USB_DEVICE(BANDB_VID, BANDB_USPTL4_PID) },
688         { USB_DEVICE(BANDB_VID, BANDB_USO9ML2DR_2_PID) },
689         { USB_DEVICE(BANDB_VID, BANDB_USO9ML2DR_PID) },
690         { USB_DEVICE(BANDB_VID, BANDB_USOPTL4DR2_PID) },
691         { USB_DEVICE(BANDB_VID, BANDB_USOPTL4DR_PID) },
692         { USB_DEVICE(BANDB_VID, BANDB_485USB9F_2W_PID) },
693         { USB_DEVICE(BANDB_VID, BANDB_485USB9F_4W_PID) },
694         { USB_DEVICE(BANDB_VID, BANDB_232USB9M_PID) },
695         { USB_DEVICE(BANDB_VID, BANDB_485USBTB_2W_PID) },
696         { USB_DEVICE(BANDB_VID, BANDB_485USBTB_4W_PID) },
697         { USB_DEVICE(BANDB_VID, BANDB_TTL5USB9M_PID) },
698         { USB_DEVICE(BANDB_VID, BANDB_TTL3USB9M_PID) },
699         { USB_DEVICE(BANDB_VID, BANDB_ZZ_PROG1_USB_PID) },
700         { USB_DEVICE(FTDI_VID, EVER_ECO_PRO_CDS) },
701         { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_1_PID) },
702         { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_2_PID) },
703         { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_3_PID) },
704         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_0_PID) },
705         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_1_PID) },
706         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_2_PID) },
707         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_3_PID) },
708         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_4_PID) },
709         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_5_PID) },
710         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_6_PID) },
711         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_7_PID) },
712         { USB_DEVICE(XSENS_VID, XSENS_AWINDA_DONGLE_PID) },
713         { USB_DEVICE(XSENS_VID, XSENS_AWINDA_STATION_PID) },
714         { USB_DEVICE(XSENS_VID, XSENS_CONVERTER_PID) },
715         { USB_DEVICE(XSENS_VID, XSENS_MTDEVBOARD_PID) },
716         { USB_DEVICE(XSENS_VID, XSENS_MTIUSBCONVERTER_PID) },
717         { USB_DEVICE(XSENS_VID, XSENS_MTW_PID) },
718         { USB_DEVICE(FTDI_VID, FTDI_OMNI1509) },
719         { USB_DEVICE(MOBILITY_VID, MOBILITY_USB_SERIAL_PID) },
720         { USB_DEVICE(FTDI_VID, FTDI_ACTIVE_ROBOTS_PID) },
721         { USB_DEVICE(FTDI_VID, FTDI_MHAM_KW_PID) },
722         { USB_DEVICE(FTDI_VID, FTDI_MHAM_YS_PID) },
723         { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y6_PID) },
724         { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y8_PID) },
725         { USB_DEVICE(FTDI_VID, FTDI_MHAM_IC_PID) },
726         { USB_DEVICE(FTDI_VID, FTDI_MHAM_DB9_PID) },
727         { USB_DEVICE(FTDI_VID, FTDI_MHAM_RS232_PID) },
728         { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y9_PID) },
729         { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_VCP_PID) },
730         { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_D2XX_PID) },
731         { USB_DEVICE(EVOLUTION_VID, EVOLUTION_ER1_PID) },
732         { USB_DEVICE(EVOLUTION_VID, EVO_HYBRID_PID) },
733         { USB_DEVICE(EVOLUTION_VID, EVO_RCM4_PID) },
734         { USB_DEVICE(FTDI_VID, FTDI_ARTEMIS_PID) },
735         { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16_PID) },
736         { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16C_PID) },
737         { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HR_PID) },
738         { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HRC_PID) },
739         { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16IC_PID) },
740         { USB_DEVICE(KOBIL_VID, KOBIL_CONV_B1_PID) },
741         { USB_DEVICE(KOBIL_VID, KOBIL_CONV_KAAN_PID) },
742         { USB_DEVICE(POSIFLEX_VID, POSIFLEX_PP7000_PID) },
743         { USB_DEVICE(FTDI_VID, FTDI_TTUSB_PID) },
744         { USB_DEVICE(FTDI_VID, FTDI_ECLO_COM_1WIRE_PID) },
745         { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_777_PID) },
746         { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_8900F_PID) },
747         { USB_DEVICE(FTDI_VID, FTDI_PCDJ_DAC2_PID) },
748         { USB_DEVICE(FTDI_VID, FTDI_RRCIRKITS_LOCOBUFFER_PID) },
749         { USB_DEVICE(FTDI_VID, FTDI_ASK_RDR400_PID) },
750         { USB_DEVICE(FTDI_VID, FTDI_NZR_SEM_USB_PID) },
751         { USB_DEVICE(ICOM_VID, ICOM_ID_1_PID) },
752         { USB_DEVICE(ICOM_VID, ICOM_OPC_U_UC_PID) },
753         { USB_DEVICE(ICOM_VID, ICOM_ID_RP2C1_PID) },
754         { USB_DEVICE(ICOM_VID, ICOM_ID_RP2C2_PID) },
755         { USB_DEVICE(ICOM_VID, ICOM_ID_RP2D_PID) },
756         { USB_DEVICE(ICOM_VID, ICOM_ID_RP2VT_PID) },
757         { USB_DEVICE(ICOM_VID, ICOM_ID_RP2VR_PID) },
758         { USB_DEVICE(ICOM_VID, ICOM_ID_RP4KVT_PID) },
759         { USB_DEVICE(ICOM_VID, ICOM_ID_RP4KVR_PID) },
760         { USB_DEVICE(ICOM_VID, ICOM_ID_RP2KVT_PID) },
761         { USB_DEVICE(ICOM_VID, ICOM_ID_RP2KVR_PID) },
762         { USB_DEVICE(FTDI_VID, FTDI_ACG_HFDUAL_PID) },
763         { USB_DEVICE(FTDI_VID, FTDI_YEI_SERVOCENTER31_PID) },
764         { USB_DEVICE(FTDI_VID, FTDI_THORLABS_PID) },
765         { USB_DEVICE(TESTO_VID, TESTO_1_PID) },
766         { USB_DEVICE(TESTO_VID, TESTO_3_PID) },
767         { USB_DEVICE(FTDI_VID, FTDI_GAMMA_SCOUT_PID) },
768         { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13M_PID) },
769         { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13S_PID) },
770         { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13U_PID) },
771         { USB_DEVICE(ELEKTOR_VID, ELEKTOR_FT323R_PID) },
772         { USB_DEVICE(FTDI_VID, FTDI_NDI_HUC_PID),
773                 .driver_info = (kernel_ulong_t)&ftdi_NDI_device_quirk },
774         { USB_DEVICE(FTDI_VID, FTDI_NDI_SPECTRA_SCU_PID),
775                 .driver_info = (kernel_ulong_t)&ftdi_NDI_device_quirk },
776         { USB_DEVICE(FTDI_VID, FTDI_NDI_FUTURE_2_PID),
777                 .driver_info = (kernel_ulong_t)&ftdi_NDI_device_quirk },
778         { USB_DEVICE(FTDI_VID, FTDI_NDI_FUTURE_3_PID),
779                 .driver_info = (kernel_ulong_t)&ftdi_NDI_device_quirk },
780         { USB_DEVICE(FTDI_VID, FTDI_NDI_AURORA_SCU_PID),
781                 .driver_info = (kernel_ulong_t)&ftdi_NDI_device_quirk },
782         { USB_DEVICE(TELLDUS_VID, TELLDUS_TELLSTICK_PID) },
783         { USB_DEVICE(NOVITUS_VID, NOVITUS_BONO_E_PID) },
784         { USB_DEVICE(FTDI_VID, RTSYSTEMS_USB_VX8_PID) },
785         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_S03_PID) },
786         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_59_PID) },
787         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_57A_PID) },
788         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_57B_PID) },
789         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_29A_PID) },
790         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_29B_PID) },
791         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_29F_PID) },
792         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_62B_PID) },
793         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_S01_PID) },
794         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_63_PID) },
795         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_29C_PID) },
796         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_81B_PID) },
797         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_82B_PID) },
798         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_K5D_PID) },
799         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_K4Y_PID) },
800         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_K5G_PID) },
801         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_S05_PID) },
802         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_60_PID) },
803         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_61_PID) },
804         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_62_PID) },
805         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_63B_PID) },
806         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_64_PID) },
807         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_65_PID) },
808         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_92_PID) },
809         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_92D_PID) },
810         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_W5R_PID) },
811         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_A5R_PID) },
812         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_USB_PW1_PID) },
813         { USB_DEVICE(FTDI_VID, FTDI_MAXSTREAM_PID) },
814         { USB_DEVICE(FTDI_VID, FTDI_PHI_FISCO_PID) },
815         { USB_DEVICE(TML_VID, TML_USB_SERIAL_PID) },
816         { USB_DEVICE(FTDI_VID, FTDI_ELSTER_UNICOM_PID) },
817         { USB_DEVICE(FTDI_VID, FTDI_PROPOX_JTAGCABLEII_PID) },
818         { USB_DEVICE(FTDI_VID, FTDI_PROPOX_ISPCABLEIII_PID) },
819         { USB_DEVICE(FTDI_VID, CYBER_CORTEX_AV_PID),
820                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
821         { USB_DEVICE_INTERFACE_NUMBER(OLIMEX_VID, OLIMEX_ARM_USB_OCD_PID, 1) },
822         { USB_DEVICE_INTERFACE_NUMBER(OLIMEX_VID, OLIMEX_ARM_USB_OCD_H_PID, 1) },
823         { USB_DEVICE_INTERFACE_NUMBER(OLIMEX_VID, OLIMEX_ARM_USB_TINY_PID, 1) },
824         { USB_DEVICE_INTERFACE_NUMBER(OLIMEX_VID, OLIMEX_ARM_USB_TINY_H_PID, 1) },
825         { USB_DEVICE(FIC_VID, FIC_NEO1973_DEBUG_PID),
826                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
827         { USB_DEVICE(FTDI_VID, FTDI_OOCDLINK_PID),
828                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
829         { USB_DEVICE(FTDI_VID, LMI_LM3S_DEVEL_BOARD_PID),
830                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
831         { USB_DEVICE(FTDI_VID, LMI_LM3S_EVAL_BOARD_PID),
832                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
833         { USB_DEVICE(FTDI_VID, LMI_LM3S_ICDI_BOARD_PID),
834                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
835         { USB_DEVICE(FTDI_VID, FTDI_TURTELIZER_PID),
836                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
837         { USB_DEVICE(RATOC_VENDOR_ID, RATOC_PRODUCT_ID_USB60F) },
838         { USB_DEVICE(RATOC_VENDOR_ID, RATOC_PRODUCT_ID_SCU18) },
839         { USB_DEVICE(FTDI_VID, FTDI_REU_TINY_PID) },
840
841         /* Papouch devices based on FTDI chip */
842         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB485_PID) },
843         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_AP485_PID) },
844         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB422_PID) },
845         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB485_2_PID) },
846         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_AP485_2_PID) },
847         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB422_2_PID) },
848         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB485S_PID) },
849         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB485C_PID) },
850         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_LEC_PID) },
851         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB232_PID) },
852         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_TMU_PID) },
853         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_IRAMP_PID) },
854         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_DRAK5_PID) },
855         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO8x8_PID) },
856         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO4x4_PID) },
857         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO2x2_PID) },
858         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO10x1_PID) },
859         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO30x3_PID) },
860         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO60x3_PID) },
861         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO2x16_PID) },
862         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO3x32_PID) },
863         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_DRAK6_PID) },
864         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_UPSUSB_PID) },
865         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_MU_PID) },
866         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SIMUKEY_PID) },
867         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_AD4USB_PID) },
868         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_GMUX_PID) },
869         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_GMSR_PID) },
870
871         { USB_DEVICE(FTDI_VID, FTDI_DOMINTELL_DGQG_PID) },
872         { USB_DEVICE(FTDI_VID, FTDI_DOMINTELL_DUSB_PID) },
873         { USB_DEVICE(ALTI2_VID, ALTI2_N3_PID) },
874         { USB_DEVICE(FTDI_VID, DIEBOLD_BCS_SE923_PID) },
875         { USB_DEVICE(ATMEL_VID, STK541_PID) },
876         { USB_DEVICE(DE_VID, STB_PID) },
877         { USB_DEVICE(DE_VID, WHT_PID) },
878         { USB_DEVICE(ADI_VID, ADI_GNICE_PID),
879                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
880         { USB_DEVICE(ADI_VID, ADI_GNICEPLUS_PID),
881                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
882         { USB_DEVICE_AND_INTERFACE_INFO(MICROCHIP_VID, MICROCHIP_USB_BOARD_PID,
883                                         USB_CLASS_VENDOR_SPEC,
884                                         USB_SUBCLASS_VENDOR_SPEC, 0x00) },
885         { USB_DEVICE_INTERFACE_NUMBER(ACTEL_VID, MICROSEMI_ARROW_SF2PLUS_BOARD_PID, 2) },
886         { USB_DEVICE(JETI_VID, JETI_SPC1201_PID) },
887         { USB_DEVICE(MARVELL_VID, MARVELL_SHEEVAPLUG_PID),
888                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
889         { USB_DEVICE(LARSENBRUSGAARD_VID, LB_ALTITRACK_PID) },
890         { USB_DEVICE(GN_OTOMETRICS_VID, AURICAL_USB_PID) },
891         { USB_DEVICE(FTDI_VID, PI_C865_PID) },
892         { USB_DEVICE(FTDI_VID, PI_C857_PID) },
893         { USB_DEVICE(PI_VID, PI_C866_PID) },
894         { USB_DEVICE(PI_VID, PI_C663_PID) },
895         { USB_DEVICE(PI_VID, PI_C725_PID) },
896         { USB_DEVICE(PI_VID, PI_E517_PID) },
897         { USB_DEVICE(PI_VID, PI_C863_PID) },
898         { USB_DEVICE(PI_VID, PI_E861_PID) },
899         { USB_DEVICE(PI_VID, PI_C867_PID) },
900         { USB_DEVICE(PI_VID, PI_E609_PID) },
901         { USB_DEVICE(PI_VID, PI_E709_PID) },
902         { USB_DEVICE(PI_VID, PI_100F_PID) },
903         { USB_DEVICE(PI_VID, PI_1011_PID) },
904         { USB_DEVICE(PI_VID, PI_1012_PID) },
905         { USB_DEVICE(PI_VID, PI_1013_PID) },
906         { USB_DEVICE(PI_VID, PI_1014_PID) },
907         { USB_DEVICE(PI_VID, PI_1015_PID) },
908         { USB_DEVICE(PI_VID, PI_1016_PID) },
909         { USB_DEVICE(KONDO_VID, KONDO_USB_SERIAL_PID) },
910         { USB_DEVICE(BAYER_VID, BAYER_CONTOUR_CABLE_PID) },
911         { USB_DEVICE(FTDI_VID, MARVELL_OPENRD_PID),
912                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
913         { USB_DEVICE(FTDI_VID, TI_XDS100V2_PID),
914                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
915         { USB_DEVICE(FTDI_VID, HAMEG_HO820_PID) },
916         { USB_DEVICE(FTDI_VID, HAMEG_HO720_PID) },
917         { USB_DEVICE(FTDI_VID, HAMEG_HO730_PID) },
918         { USB_DEVICE(FTDI_VID, HAMEG_HO870_PID) },
919         { USB_DEVICE(FTDI_VID, MJSG_GENERIC_PID) },
920         { USB_DEVICE(FTDI_VID, MJSG_SR_RADIO_PID) },
921         { USB_DEVICE(FTDI_VID, MJSG_HD_RADIO_PID) },
922         { USB_DEVICE(FTDI_VID, MJSG_XM_RADIO_PID) },
923         { USB_DEVICE(FTDI_VID, XVERVE_SIGNALYZER_ST_PID),
924                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
925         { USB_DEVICE(FTDI_VID, XVERVE_SIGNALYZER_SLITE_PID),
926                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
927         { USB_DEVICE(FTDI_VID, XVERVE_SIGNALYZER_SH2_PID),
928                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
929         { USB_DEVICE(FTDI_VID, XVERVE_SIGNALYZER_SH4_PID),
930                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
931         { USB_DEVICE(FTDI_VID, SEGWAY_RMP200_PID) },
932         { USB_DEVICE(FTDI_VID, ACCESIO_COM4SM_PID) },
933         { USB_DEVICE(IONICS_VID, IONICS_PLUGCOMPUTER_PID),
934                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
935         { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_24_MASTER_WING_PID) },
936         { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_PC_WING_PID) },
937         { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_USB_DMX_PID) },
938         { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_MIDI_TIMECODE_PID) },
939         { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_MINI_WING_PID) },
940         { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_MAXI_WING_PID) },
941         { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_MEDIA_WING_PID) },
942         { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_WING_PID) },
943         { USB_DEVICE(FTDI_VID, FTDI_SCIENCESCOPE_LOGBOOKML_PID) },
944         { USB_DEVICE(FTDI_VID, FTDI_SCIENCESCOPE_LS_LOGBOOK_PID) },
945         { USB_DEVICE(FTDI_VID, FTDI_SCIENCESCOPE_HS_LOGBOOK_PID) },
946         { USB_DEVICE(FTDI_VID, FTDI_CINTERION_MC55I_PID) },
947         { USB_DEVICE(FTDI_VID, FTDI_FHE_PID) },
948         { USB_DEVICE(FTDI_VID, FTDI_DOTEC_PID) },
949         { USB_DEVICE(QIHARDWARE_VID, MILKYMISTONE_JTAGSERIAL_PID),
950                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
951         { USB_DEVICE(ST_VID, ST_STMCLT_2232_PID),
952                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
953         { USB_DEVICE(ST_VID, ST_STMCLT_4232_PID),
954                 .driver_info = (kernel_ulong_t)&ftdi_stmclite_quirk },
955         { USB_DEVICE(FTDI_VID, FTDI_RF_R106) },
956         { USB_DEVICE(FTDI_VID, FTDI_DISTORTEC_JTAG_LOCK_PICK_PID),
957                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
958         { USB_DEVICE(FTDI_VID, FTDI_LUMEL_PD12_PID) },
959         /* Crucible Devices */
960         { USB_DEVICE(FTDI_VID, FTDI_CT_COMET_PID) },
961         { USB_DEVICE(FTDI_VID, FTDI_Z3X_PID) },
962         /* Cressi Devices */
963         { USB_DEVICE(FTDI_VID, FTDI_CRESSI_PID) },
964         /* Brainboxes Devices */
965         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_VX_001_PID) },
966         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_VX_012_PID) },
967         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_VX_023_PID) },
968         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_VX_034_PID) },
969         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_101_PID) },
970         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_160_1_PID) },
971         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_160_2_PID) },
972         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_160_3_PID) },
973         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_160_4_PID) },
974         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_160_5_PID) },
975         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_160_6_PID) },
976         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_160_7_PID) },
977         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_160_8_PID) },
978         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_257_PID) },
979         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_279_1_PID) },
980         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_279_2_PID) },
981         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_279_3_PID) },
982         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_279_4_PID) },
983         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_313_PID) },
984         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_324_PID) },
985         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_346_1_PID) },
986         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_346_2_PID) },
987         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_357_PID) },
988         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_606_1_PID) },
989         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_606_2_PID) },
990         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_606_3_PID) },
991         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_701_1_PID) },
992         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_701_2_PID) },
993         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_842_1_PID) },
994         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_842_2_PID) },
995         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_842_3_PID) },
996         { USB_DEVICE(BRAINBOXES_VID, BRAINBOXES_US_842_4_PID) },
997         /* ekey Devices */
998         { USB_DEVICE(FTDI_VID, FTDI_EKEY_CONV_USB_PID) },
999         /* Infineon Devices */
1000         { USB_DEVICE_INTERFACE_NUMBER(INFINEON_VID, INFINEON_TRIBOARD_TC1798_PID, 1) },
1001         { USB_DEVICE_INTERFACE_NUMBER(INFINEON_VID, INFINEON_TRIBOARD_TC2X7_PID, 1) },
1002         /* GE Healthcare devices */
1003         { USB_DEVICE(GE_HEALTHCARE_VID, GE_HEALTHCARE_NEMO_TRACKER_PID) },
1004         /* Active Research (Actisense) devices */
1005         { USB_DEVICE(FTDI_VID, ACTISENSE_NDC_PID) },
1006         { USB_DEVICE(FTDI_VID, ACTISENSE_USG_PID) },
1007         { USB_DEVICE(FTDI_VID, ACTISENSE_NGT_PID) },
1008         { USB_DEVICE(FTDI_VID, ACTISENSE_NGW_PID) },
1009         { USB_DEVICE(FTDI_VID, ACTISENSE_D9AC_PID) },
1010         { USB_DEVICE(FTDI_VID, ACTISENSE_D9AD_PID) },
1011         { USB_DEVICE(FTDI_VID, ACTISENSE_D9AE_PID) },
1012         { USB_DEVICE(FTDI_VID, ACTISENSE_D9AF_PID) },
1013         { USB_DEVICE(FTDI_VID, CHETCO_SEAGAUGE_PID) },
1014         { USB_DEVICE(FTDI_VID, CHETCO_SEASWITCH_PID) },
1015         { USB_DEVICE(FTDI_VID, CHETCO_SEASMART_NMEA2000_PID) },
1016         { USB_DEVICE(FTDI_VID, CHETCO_SEASMART_ETHERNET_PID) },
1017         { USB_DEVICE(FTDI_VID, CHETCO_SEASMART_WIFI_PID) },
1018         { USB_DEVICE(FTDI_VID, CHETCO_SEASMART_DISPLAY_PID) },
1019         { USB_DEVICE(FTDI_VID, CHETCO_SEASMART_LITE_PID) },
1020         { USB_DEVICE(FTDI_VID, CHETCO_SEASMART_ANALOG_PID) },
1021         /* ICP DAS I-756xU devices */
1022         { USB_DEVICE(ICPDAS_VID, ICPDAS_I7560U_PID) },
1023         { USB_DEVICE(ICPDAS_VID, ICPDAS_I7561U_PID) },
1024         { USB_DEVICE(ICPDAS_VID, ICPDAS_I7563U_PID) },
1025         { USB_DEVICE(WICED_VID, WICED_USB20706V2_PID) },
1026         { USB_DEVICE(TI_VID, TI_CC3200_LAUNCHPAD_PID),
1027                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
1028         { USB_DEVICE(CYPRESS_VID, CYPRESS_WICED_BT_USB_PID) },
1029         { USB_DEVICE(CYPRESS_VID, CYPRESS_WICED_WL_USB_PID) },
1030         { USB_DEVICE(AIRBUS_DS_VID, AIRBUS_DS_P8GR) },
1031         /* EZPrototypes devices */
1032         { USB_DEVICE(EZPROTOTYPES_VID, HJELMSLUND_USB485_ISO_PID) },
1033         { USB_DEVICE_INTERFACE_NUMBER(UNJO_VID, UNJO_ISODEBUG_V1_PID, 1) },
1034         /* Sienna devices */
1035         { USB_DEVICE(FTDI_VID, FTDI_SIENNA_PID) },
1036         { USB_DEVICE(ECHELON_VID, ECHELON_U20_PID) },
1037         /* U-Blox devices */
1038         { USB_DEVICE(UBLOX_VID, UBLOX_C099F9P_ZED_PID) },
1039         { USB_DEVICE(UBLOX_VID, UBLOX_C099F9P_ODIN_PID) },
1040         /* FreeCalypso USB adapters */
1041         { USB_DEVICE(FTDI_VID, FTDI_FALCONIA_JTAG_BUF_PID),
1042                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
1043         { USB_DEVICE(FTDI_VID, FTDI_FALCONIA_JTAG_UNBUF_PID),
1044                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
1045         { }                                     /* Terminating entry */
1046 };
1047
1048 MODULE_DEVICE_TABLE(usb, id_table_combined);
1049
1050 static const char *ftdi_chip_name[] = {
1051         [SIO] = "SIO",  /* the serial part of FT8U100AX */
1052         [FT8U232AM] = "FT8U232AM",
1053         [FT232BM] = "FT232BM",
1054         [FT2232C] = "FT2232C",
1055         [FT232RL] = "FT232RL",
1056         [FT2232H] = "FT2232H",
1057         [FT4232H] = "FT4232H",
1058         [FT232H]  = "FT232H",
1059         [FTX]     = "FT-X"
1060 };
1061
1062
1063 /* Used for TIOCMIWAIT */
1064 #define FTDI_STATUS_B0_MASK     (FTDI_RS0_CTS | FTDI_RS0_DSR | FTDI_RS0_RI | FTDI_RS0_RLSD)
1065 #define FTDI_STATUS_B1_MASK     (FTDI_RS_BI)
1066 /* End TIOCMIWAIT */
1067
1068 /* function prototypes for a FTDI serial converter */
1069 static int  ftdi_sio_probe(struct usb_serial *serial,
1070                                         const struct usb_device_id *id);
1071 static int  ftdi_sio_port_probe(struct usb_serial_port *port);
1072 static void ftdi_sio_port_remove(struct usb_serial_port *port);
1073 static int  ftdi_open(struct tty_struct *tty, struct usb_serial_port *port);
1074 static void ftdi_dtr_rts(struct usb_serial_port *port, int on);
1075 static void ftdi_process_read_urb(struct urb *urb);
1076 static int ftdi_prepare_write_buffer(struct usb_serial_port *port,
1077                                                 void *dest, size_t size);
1078 static void ftdi_set_termios(struct tty_struct *tty,
1079                         struct usb_serial_port *port, struct ktermios *old);
1080 static int  ftdi_tiocmget(struct tty_struct *tty);
1081 static int  ftdi_tiocmset(struct tty_struct *tty,
1082                         unsigned int set, unsigned int clear);
1083 static int  ftdi_ioctl(struct tty_struct *tty,
1084                         unsigned int cmd, unsigned long arg);
1085 static void get_serial_info(struct tty_struct *tty, struct serial_struct *ss);
1086 static int set_serial_info(struct tty_struct *tty,
1087                                 struct serial_struct *ss);
1088 static void ftdi_break_ctl(struct tty_struct *tty, int break_state);
1089 static bool ftdi_tx_empty(struct usb_serial_port *port);
1090 static int ftdi_get_modem_status(struct usb_serial_port *port,
1091                                                 unsigned char status[2]);
1092
1093 static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base);
1094 static unsigned short int ftdi_232am_baud_to_divisor(int baud);
1095 static u32 ftdi_232bm_baud_base_to_divisor(int baud, int base);
1096 static u32 ftdi_232bm_baud_to_divisor(int baud);
1097 static u32 ftdi_2232h_baud_base_to_divisor(int baud, int base);
1098 static u32 ftdi_2232h_baud_to_divisor(int baud);
1099
1100 static struct usb_serial_driver ftdi_sio_device = {
1101         .driver = {
1102                 .owner =        THIS_MODULE,
1103                 .name =         "ftdi_sio",
1104         },
1105         .description =          "FTDI USB Serial Device",
1106         .id_table =             id_table_combined,
1107         .num_ports =            1,
1108         .bulk_in_size =         512,
1109         .bulk_out_size =        256,
1110         .probe =                ftdi_sio_probe,
1111         .port_probe =           ftdi_sio_port_probe,
1112         .port_remove =          ftdi_sio_port_remove,
1113         .open =                 ftdi_open,
1114         .dtr_rts =              ftdi_dtr_rts,
1115         .throttle =             usb_serial_generic_throttle,
1116         .unthrottle =           usb_serial_generic_unthrottle,
1117         .process_read_urb =     ftdi_process_read_urb,
1118         .prepare_write_buffer = ftdi_prepare_write_buffer,
1119         .tiocmget =             ftdi_tiocmget,
1120         .tiocmset =             ftdi_tiocmset,
1121         .tiocmiwait =           usb_serial_generic_tiocmiwait,
1122         .get_icount =           usb_serial_generic_get_icount,
1123         .ioctl =                ftdi_ioctl,
1124         .get_serial =           get_serial_info,
1125         .set_serial =           set_serial_info,
1126         .set_termios =          ftdi_set_termios,
1127         .break_ctl =            ftdi_break_ctl,
1128         .tx_empty =             ftdi_tx_empty,
1129 };
1130
1131 static struct usb_serial_driver * const serial_drivers[] = {
1132         &ftdi_sio_device, NULL
1133 };
1134
1135
1136 #define WDR_TIMEOUT 5000 /* default urb timeout */
1137 #define WDR_SHORT_TIMEOUT 1000  /* shorter urb timeout */
1138
1139 /*
1140  * ***************************************************************************
1141  * Utility functions
1142  * ***************************************************************************
1143  */
1144
1145 static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base)
1146 {
1147         unsigned short int divisor;
1148         /* divisor shifted 3 bits to the left */
1149         int divisor3 = DIV_ROUND_CLOSEST(base, 2 * baud);
1150         if ((divisor3 & 0x7) == 7)
1151                 divisor3++; /* round x.7/8 up to x+1 */
1152         divisor = divisor3 >> 3;
1153         divisor3 &= 0x7;
1154         if (divisor3 == 1)
1155                 divisor |= 0xc000;      /* +0.125 */
1156         else if (divisor3 >= 4)
1157                 divisor |= 0x4000;      /* +0.5 */
1158         else if (divisor3 != 0)
1159                 divisor |= 0x8000;      /* +0.25 */
1160         else if (divisor == 1)
1161                 divisor = 0;            /* special case for maximum baud rate */
1162         return divisor;
1163 }
1164
1165 static unsigned short int ftdi_232am_baud_to_divisor(int baud)
1166 {
1167          return ftdi_232am_baud_base_to_divisor(baud, 48000000);
1168 }
1169
1170 static u32 ftdi_232bm_baud_base_to_divisor(int baud, int base)
1171 {
1172         static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
1173         u32 divisor;
1174         /* divisor shifted 3 bits to the left */
1175         int divisor3 = DIV_ROUND_CLOSEST(base, 2 * baud);
1176         divisor = divisor3 >> 3;
1177         divisor |= (u32)divfrac[divisor3 & 0x7] << 14;
1178         /* Deal with special cases for highest baud rates. */
1179         if (divisor == 1)               /* 1.0 */
1180                 divisor = 0;
1181         else if (divisor == 0x4001)     /* 1.5 */
1182                 divisor = 1;
1183         return divisor;
1184 }
1185
1186 static u32 ftdi_232bm_baud_to_divisor(int baud)
1187 {
1188          return ftdi_232bm_baud_base_to_divisor(baud, 48000000);
1189 }
1190
1191 static u32 ftdi_2232h_baud_base_to_divisor(int baud, int base)
1192 {
1193         static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
1194         u32 divisor;
1195         int divisor3;
1196
1197         /* hi-speed baud rate is 10-bit sampling instead of 16-bit */
1198         divisor3 = DIV_ROUND_CLOSEST(8 * base, 10 * baud);
1199
1200         divisor = divisor3 >> 3;
1201         divisor |= (u32)divfrac[divisor3 & 0x7] << 14;
1202         /* Deal with special cases for highest baud rates. */
1203         if (divisor == 1)               /* 1.0 */
1204                 divisor = 0;
1205         else if (divisor == 0x4001)     /* 1.5 */
1206                 divisor = 1;
1207         /*
1208          * Set this bit to turn off a divide by 2.5 on baud rate generator
1209          * This enables baud rates up to 12Mbaud but cannot reach below 1200
1210          * baud with this bit set
1211          */
1212         divisor |= 0x00020000;
1213         return divisor;
1214 }
1215
1216 static u32 ftdi_2232h_baud_to_divisor(int baud)
1217 {
1218          return ftdi_2232h_baud_base_to_divisor(baud, 120000000);
1219 }
1220
1221 #define set_mctrl(port, set)            update_mctrl((port), (set), 0)
1222 #define clear_mctrl(port, clear)        update_mctrl((port), 0, (clear))
1223
1224 static int update_mctrl(struct usb_serial_port *port, unsigned int set,
1225                                                         unsigned int clear)
1226 {
1227         struct ftdi_private *priv = usb_get_serial_port_data(port);
1228         struct device *dev = &port->dev;
1229         unsigned value;
1230         int rv;
1231
1232         if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
1233                 dev_dbg(dev, "%s - DTR|RTS not being set|cleared\n", __func__);
1234                 return 0;       /* no change */
1235         }
1236
1237         clear &= ~set;  /* 'set' takes precedence over 'clear' */
1238         value = 0;
1239         if (clear & TIOCM_DTR)
1240                 value |= FTDI_SIO_SET_DTR_LOW;
1241         if (clear & TIOCM_RTS)
1242                 value |= FTDI_SIO_SET_RTS_LOW;
1243         if (set & TIOCM_DTR)
1244                 value |= FTDI_SIO_SET_DTR_HIGH;
1245         if (set & TIOCM_RTS)
1246                 value |= FTDI_SIO_SET_RTS_HIGH;
1247         rv = usb_control_msg(port->serial->dev,
1248                                usb_sndctrlpipe(port->serial->dev, 0),
1249                                FTDI_SIO_SET_MODEM_CTRL_REQUEST,
1250                                FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE,
1251                                value, priv->interface,
1252                                NULL, 0, WDR_TIMEOUT);
1253         if (rv < 0) {
1254                 dev_dbg(dev, "%s Error from MODEM_CTRL urb: DTR %s, RTS %s\n",
1255                         __func__,
1256                         (set & TIOCM_DTR) ? "HIGH" : (clear & TIOCM_DTR) ? "LOW" : "unchanged",
1257                         (set & TIOCM_RTS) ? "HIGH" : (clear & TIOCM_RTS) ? "LOW" : "unchanged");
1258                 rv = usb_translate_errors(rv);
1259         } else {
1260                 dev_dbg(dev, "%s - DTR %s, RTS %s\n", __func__,
1261                         (set & TIOCM_DTR) ? "HIGH" : (clear & TIOCM_DTR) ? "LOW" : "unchanged",
1262                         (set & TIOCM_RTS) ? "HIGH" : (clear & TIOCM_RTS) ? "LOW" : "unchanged");
1263                 /* FIXME: locking on last_dtr_rts */
1264                 priv->last_dtr_rts = (priv->last_dtr_rts & ~clear) | set;
1265         }
1266         return rv;
1267 }
1268
1269
1270 static u32 get_ftdi_divisor(struct tty_struct *tty,
1271                                                 struct usb_serial_port *port)
1272 {
1273         struct ftdi_private *priv = usb_get_serial_port_data(port);
1274         struct device *dev = &port->dev;
1275         u32 div_value = 0;
1276         int div_okay = 1;
1277         int baud;
1278
1279         baud = tty_get_baud_rate(tty);
1280         dev_dbg(dev, "%s - tty_get_baud_rate reports speed %d\n", __func__, baud);
1281
1282         /*
1283          * Observe deprecated async-compatible custom_divisor hack, update
1284          * baudrate if needed.
1285          */
1286         if (baud == 38400 &&
1287             ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
1288              (priv->custom_divisor)) {
1289                 baud = priv->baud_base / priv->custom_divisor;
1290                 dev_dbg(dev, "%s - custom divisor %d sets baud rate to %d\n",
1291                         __func__, priv->custom_divisor, baud);
1292         }
1293
1294         if (!baud)
1295                 baud = 9600;
1296         switch (priv->chip_type) {
1297         case SIO: /* SIO chip */
1298                 switch (baud) {
1299                 case 300: div_value = ftdi_sio_b300; break;
1300                 case 600: div_value = ftdi_sio_b600; break;
1301                 case 1200: div_value = ftdi_sio_b1200; break;
1302                 case 2400: div_value = ftdi_sio_b2400; break;
1303                 case 4800: div_value = ftdi_sio_b4800; break;
1304                 case 9600: div_value = ftdi_sio_b9600; break;
1305                 case 19200: div_value = ftdi_sio_b19200; break;
1306                 case 38400: div_value = ftdi_sio_b38400; break;
1307                 case 57600: div_value = ftdi_sio_b57600;  break;
1308                 case 115200: div_value = ftdi_sio_b115200; break;
1309                 } /* baud */
1310                 if (div_value == 0) {
1311                         dev_dbg(dev, "%s - Baudrate (%d) requested is not supported\n",
1312                                 __func__,  baud);
1313                         div_value = ftdi_sio_b9600;
1314                         baud = 9600;
1315                         div_okay = 0;
1316                 }
1317                 break;
1318         case FT8U232AM: /* 8U232AM chip */
1319                 if (baud <= 3000000) {
1320                         div_value = ftdi_232am_baud_to_divisor(baud);
1321                 } else {
1322                         dev_dbg(dev, "%s - Baud rate too high!\n", __func__);
1323                         baud = 9600;
1324                         div_value = ftdi_232am_baud_to_divisor(9600);
1325                         div_okay = 0;
1326                 }
1327                 break;
1328         case FT232BM: /* FT232BM chip */
1329         case FT2232C: /* FT2232C chip */
1330         case FT232RL: /* FT232RL chip */
1331         case FTX:     /* FT-X series */
1332                 if (baud <= 3000000) {
1333                         u16 product_id = le16_to_cpu(
1334                                 port->serial->dev->descriptor.idProduct);
1335                         if (((product_id == FTDI_NDI_HUC_PID)           ||
1336                              (product_id == FTDI_NDI_SPECTRA_SCU_PID)   ||
1337                              (product_id == FTDI_NDI_FUTURE_2_PID)      ||
1338                              (product_id == FTDI_NDI_FUTURE_3_PID)      ||
1339                              (product_id == FTDI_NDI_AURORA_SCU_PID))   &&
1340                             (baud == 19200)) {
1341                                 baud = 1200000;
1342                         }
1343                         div_value = ftdi_232bm_baud_to_divisor(baud);
1344                 } else {
1345                         dev_dbg(dev, "%s - Baud rate too high!\n", __func__);
1346                         div_value = ftdi_232bm_baud_to_divisor(9600);
1347                         div_okay = 0;
1348                         baud = 9600;
1349                 }
1350                 break;
1351         case FT2232H: /* FT2232H chip */
1352         case FT4232H: /* FT4232H chip */
1353         case FT232H:  /* FT232H chip */
1354                 if ((baud <= 12000000) && (baud >= 1200)) {
1355                         div_value = ftdi_2232h_baud_to_divisor(baud);
1356                 } else if (baud < 1200) {
1357                         div_value = ftdi_232bm_baud_to_divisor(baud);
1358                 } else {
1359                         dev_dbg(dev, "%s - Baud rate too high!\n", __func__);
1360                         div_value = ftdi_232bm_baud_to_divisor(9600);
1361                         div_okay = 0;
1362                         baud = 9600;
1363                 }
1364                 break;
1365         } /* priv->chip_type */
1366
1367         if (div_okay) {
1368                 dev_dbg(dev, "%s - Baud rate set to %d (divisor 0x%lX) on chip %s\n",
1369                         __func__, baud, (unsigned long)div_value,
1370                         ftdi_chip_name[priv->chip_type]);
1371         }
1372
1373         tty_encode_baud_rate(tty, baud, baud);
1374         return div_value;
1375 }
1376
1377 static int change_speed(struct tty_struct *tty, struct usb_serial_port *port)
1378 {
1379         struct ftdi_private *priv = usb_get_serial_port_data(port);
1380         u16 value;
1381         u16 index;
1382         u32 index_value;
1383         int rv;
1384
1385         index_value = get_ftdi_divisor(tty, port);
1386         value = (u16)index_value;
1387         index = (u16)(index_value >> 16);
1388         if (priv->chip_type == FT2232C || priv->chip_type == FT2232H ||
1389                         priv->chip_type == FT4232H || priv->chip_type == FT232H ||
1390                         priv->chip_type == FTX) {
1391                 /* Probably the BM type needs the MSB of the encoded fractional
1392                  * divider also moved like for the chips above. Any infos? */
1393                 index = (u16)((index << 8) | priv->interface);
1394         }
1395
1396         rv = usb_control_msg(port->serial->dev,
1397                             usb_sndctrlpipe(port->serial->dev, 0),
1398                             FTDI_SIO_SET_BAUDRATE_REQUEST,
1399                             FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE,
1400                             value, index,
1401                             NULL, 0, WDR_SHORT_TIMEOUT);
1402         return rv;
1403 }
1404
1405 static int write_latency_timer(struct usb_serial_port *port)
1406 {
1407         struct ftdi_private *priv = usb_get_serial_port_data(port);
1408         struct usb_device *udev = port->serial->dev;
1409         int rv;
1410         int l = priv->latency;
1411
1412         if (priv->chip_type == SIO || priv->chip_type == FT8U232AM)
1413                 return -EINVAL;
1414
1415         if (priv->flags & ASYNC_LOW_LATENCY)
1416                 l = 1;
1417
1418         dev_dbg(&port->dev, "%s: setting latency timer = %i\n", __func__, l);
1419
1420         rv = usb_control_msg(udev,
1421                              usb_sndctrlpipe(udev, 0),
1422                              FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
1423                              FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
1424                              l, priv->interface,
1425                              NULL, 0, WDR_TIMEOUT);
1426         if (rv < 0)
1427                 dev_err(&port->dev, "Unable to write latency timer: %i\n", rv);
1428         return rv;
1429 }
1430
1431 static int _read_latency_timer(struct usb_serial_port *port)
1432 {
1433         struct ftdi_private *priv = usb_get_serial_port_data(port);
1434         struct usb_device *udev = port->serial->dev;
1435         unsigned char *buf;
1436         int rv;
1437
1438         buf = kmalloc(1, GFP_KERNEL);
1439         if (!buf)
1440                 return -ENOMEM;
1441
1442         rv = usb_control_msg(udev,
1443                              usb_rcvctrlpipe(udev, 0),
1444                              FTDI_SIO_GET_LATENCY_TIMER_REQUEST,
1445                              FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE,
1446                              0, priv->interface,
1447                              buf, 1, WDR_TIMEOUT);
1448         if (rv < 1) {
1449                 if (rv >= 0)
1450                         rv = -EIO;
1451         } else {
1452                 rv = buf[0];
1453         }
1454
1455         kfree(buf);
1456
1457         return rv;
1458 }
1459
1460 static int read_latency_timer(struct usb_serial_port *port)
1461 {
1462         struct ftdi_private *priv = usb_get_serial_port_data(port);
1463         int rv;
1464
1465         if (priv->chip_type == SIO || priv->chip_type == FT8U232AM)
1466                 return -EINVAL;
1467
1468         rv = _read_latency_timer(port);
1469         if (rv < 0) {
1470                 dev_err(&port->dev, "Unable to read latency timer: %i\n", rv);
1471                 return rv;
1472         }
1473
1474         priv->latency = rv;
1475
1476         return 0;
1477 }
1478
1479 static void get_serial_info(struct tty_struct *tty, struct serial_struct *ss)
1480 {
1481         struct usb_serial_port *port = tty->driver_data;
1482         struct ftdi_private *priv = usb_get_serial_port_data(port);
1483
1484         ss->flags = priv->flags;
1485         ss->baud_base = priv->baud_base;
1486         ss->custom_divisor = priv->custom_divisor;
1487 }
1488
1489 static int set_serial_info(struct tty_struct *tty, struct serial_struct *ss)
1490 {
1491         struct usb_serial_port *port = tty->driver_data;
1492         struct ftdi_private *priv = usb_get_serial_port_data(port);
1493         int old_flags, old_divisor;
1494
1495         mutex_lock(&priv->cfg_lock);
1496
1497         if (!capable(CAP_SYS_ADMIN)) {
1498                 if ((ss->flags ^ priv->flags) & ~ASYNC_USR_MASK) {
1499                         mutex_unlock(&priv->cfg_lock);
1500                         return -EPERM;
1501                 }
1502         }
1503
1504         old_flags = priv->flags;
1505         old_divisor = priv->custom_divisor;
1506
1507         priv->flags = ss->flags & ASYNC_FLAGS;
1508         priv->custom_divisor = ss->custom_divisor;
1509
1510         write_latency_timer(port);
1511
1512         if ((priv->flags ^ old_flags) & ASYNC_SPD_MASK ||
1513                         ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST &&
1514                          priv->custom_divisor != old_divisor)) {
1515
1516                 /* warn about deprecation unless clearing */
1517                 if (priv->flags & ASYNC_SPD_MASK)
1518                         dev_warn_ratelimited(&port->dev, "use of SPD flags is deprecated\n");
1519
1520                 change_speed(tty, port);
1521         }
1522         mutex_unlock(&priv->cfg_lock);
1523         return 0;
1524 }
1525
1526 static int get_lsr_info(struct usb_serial_port *port,
1527                         unsigned int __user *retinfo)
1528 {
1529         struct ftdi_private *priv = usb_get_serial_port_data(port);
1530         unsigned int result = 0;
1531
1532         if (priv->transmit_empty)
1533                 result = TIOCSER_TEMT;
1534
1535         if (copy_to_user(retinfo, &result, sizeof(unsigned int)))
1536                 return -EFAULT;
1537         return 0;
1538 }
1539
1540
1541 /* Determine type of FTDI chip based on USB config and descriptor. */
1542 static void ftdi_determine_type(struct usb_serial_port *port)
1543 {
1544         struct ftdi_private *priv = usb_get_serial_port_data(port);
1545         struct usb_serial *serial = port->serial;
1546         struct usb_device *udev = serial->dev;
1547         unsigned version;
1548         unsigned interfaces;
1549
1550         /* Assume it is not the original SIO device for now. */
1551         priv->baud_base = 48000000 / 2;
1552
1553         version = le16_to_cpu(udev->descriptor.bcdDevice);
1554         interfaces = udev->actconfig->desc.bNumInterfaces;
1555         dev_dbg(&port->dev, "%s: bcdDevice = 0x%x, bNumInterfaces = %u\n", __func__,
1556                 version, interfaces);
1557         if (interfaces > 1) {
1558                 struct usb_interface *intf = serial->interface;
1559                 int ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
1560
1561                 /* Multiple interfaces.*/
1562                 if (version == 0x0800) {
1563                         priv->chip_type = FT4232H;
1564                         /* Hi-speed - baud clock runs at 120MHz */
1565                         priv->baud_base = 120000000 / 2;
1566                 } else if (version == 0x0700) {
1567                         priv->chip_type = FT2232H;
1568                         /* Hi-speed - baud clock runs at 120MHz */
1569                         priv->baud_base = 120000000 / 2;
1570                 } else
1571                         priv->chip_type = FT2232C;
1572
1573                 /* Determine interface code. */
1574                 if (ifnum == 0)
1575                         priv->interface = INTERFACE_A;
1576                 else if (ifnum == 1)
1577                         priv->interface = INTERFACE_B;
1578                 else if (ifnum == 2)
1579                         priv->interface = INTERFACE_C;
1580                 else if (ifnum == 3)
1581                         priv->interface = INTERFACE_D;
1582
1583                 /* BM-type devices have a bug where bcdDevice gets set
1584                  * to 0x200 when iSerialNumber is 0.  */
1585                 if (version < 0x500) {
1586                         dev_dbg(&port->dev,
1587                                 "%s: something fishy - bcdDevice too low for multi-interface device\n",
1588                                 __func__);
1589                 }
1590         } else if (version < 0x200) {
1591                 /* Old device.  Assume it's the original SIO. */
1592                 priv->chip_type = SIO;
1593                 priv->baud_base = 12000000 / 16;
1594         } else if (version < 0x400) {
1595                 /* Assume it's an FT8U232AM (or FT8U245AM) */
1596                 priv->chip_type = FT8U232AM;
1597                 /*
1598                  * It might be a BM type because of the iSerialNumber bug.
1599                  * If iSerialNumber==0 and the latency timer is readable,
1600                  * assume it is BM type.
1601                  */
1602                 if (udev->descriptor.iSerialNumber == 0 &&
1603                                 _read_latency_timer(port) >= 0) {
1604                         dev_dbg(&port->dev,
1605                                 "%s: has latency timer so not an AM type\n",
1606                                 __func__);
1607                         priv->chip_type = FT232BM;
1608                 }
1609         } else if (version < 0x600) {
1610                 /* Assume it's an FT232BM (or FT245BM) */
1611                 priv->chip_type = FT232BM;
1612         } else if (version < 0x900) {
1613                 /* Assume it's an FT232RL */
1614                 priv->chip_type = FT232RL;
1615         } else if (version < 0x1000) {
1616                 /* Assume it's an FT232H */
1617                 priv->chip_type = FT232H;
1618         } else {
1619                 /* Assume it's an FT-X series device */
1620                 priv->chip_type = FTX;
1621         }
1622
1623         dev_info(&udev->dev, "Detected %s\n", ftdi_chip_name[priv->chip_type]);
1624 }
1625
1626
1627 /*
1628  * Determine the maximum packet size for the device. This depends on the chip
1629  * type and the USB host capabilities. The value should be obtained from the
1630  * device descriptor as the chip will use the appropriate values for the host.
1631  */
1632 static void ftdi_set_max_packet_size(struct usb_serial_port *port)
1633 {
1634         struct ftdi_private *priv = usb_get_serial_port_data(port);
1635         struct usb_interface *interface = port->serial->interface;
1636         struct usb_endpoint_descriptor *ep_desc;
1637         unsigned num_endpoints;
1638         unsigned i;
1639
1640         num_endpoints = interface->cur_altsetting->desc.bNumEndpoints;
1641         if (!num_endpoints)
1642                 return;
1643
1644         /*
1645          * NOTE: Some customers have programmed FT232R/FT245R devices
1646          * with an endpoint size of 0 - not good. In this case, we
1647          * want to override the endpoint descriptor setting and use a
1648          * value of 64 for wMaxPacketSize.
1649          */
1650         for (i = 0; i < num_endpoints; i++) {
1651                 ep_desc = &interface->cur_altsetting->endpoint[i].desc;
1652                 if (!ep_desc->wMaxPacketSize) {
1653                         ep_desc->wMaxPacketSize = cpu_to_le16(0x40);
1654                         dev_warn(&port->dev, "Overriding wMaxPacketSize on endpoint %d\n",
1655                                         usb_endpoint_num(ep_desc));
1656                 }
1657         }
1658
1659         /* Set max packet size based on last descriptor. */
1660         priv->max_packet_size = usb_endpoint_maxp(ep_desc);
1661 }
1662
1663
1664 /*
1665  * ***************************************************************************
1666  * Sysfs Attribute
1667  * ***************************************************************************
1668  */
1669
1670 static ssize_t latency_timer_show(struct device *dev,
1671                                   struct device_attribute *attr, char *buf)
1672 {
1673         struct usb_serial_port *port = to_usb_serial_port(dev);
1674         struct ftdi_private *priv = usb_get_serial_port_data(port);
1675         if (priv->flags & ASYNC_LOW_LATENCY)
1676                 return sprintf(buf, "1\n");
1677         else
1678                 return sprintf(buf, "%i\n", priv->latency);
1679 }
1680
1681 /* Write a new value of the latency timer, in units of milliseconds. */
1682 static ssize_t latency_timer_store(struct device *dev,
1683                                    struct device_attribute *attr,
1684                                    const char *valbuf, size_t count)
1685 {
1686         struct usb_serial_port *port = to_usb_serial_port(dev);
1687         struct ftdi_private *priv = usb_get_serial_port_data(port);
1688         u8 v;
1689         int rv;
1690
1691         if (kstrtou8(valbuf, 10, &v))
1692                 return -EINVAL;
1693
1694         priv->latency = v;
1695         rv = write_latency_timer(port);
1696         if (rv < 0)
1697                 return -EIO;
1698         return count;
1699 }
1700 static DEVICE_ATTR_RW(latency_timer);
1701
1702 /* Write an event character directly to the FTDI register.  The ASCII
1703    value is in the low 8 bits, with the enable bit in the 9th bit. */
1704 static ssize_t event_char_store(struct device *dev,
1705         struct device_attribute *attr, const char *valbuf, size_t count)
1706 {
1707         struct usb_serial_port *port = to_usb_serial_port(dev);
1708         struct ftdi_private *priv = usb_get_serial_port_data(port);
1709         struct usb_device *udev = port->serial->dev;
1710         unsigned int v;
1711         int rv;
1712
1713         if (kstrtouint(valbuf, 0, &v) || v >= 0x200)
1714                 return -EINVAL;
1715
1716         dev_dbg(&port->dev, "%s: setting event char = 0x%03x\n", __func__, v);
1717
1718         rv = usb_control_msg(udev,
1719                              usb_sndctrlpipe(udev, 0),
1720                              FTDI_SIO_SET_EVENT_CHAR_REQUEST,
1721                              FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE,
1722                              v, priv->interface,
1723                              NULL, 0, WDR_TIMEOUT);
1724         if (rv < 0) {
1725                 dev_dbg(&port->dev, "Unable to write event character: %i\n", rv);
1726                 return -EIO;
1727         }
1728
1729         return count;
1730 }
1731 static DEVICE_ATTR_WO(event_char);
1732
1733 static int create_sysfs_attrs(struct usb_serial_port *port)
1734 {
1735         struct ftdi_private *priv = usb_get_serial_port_data(port);
1736         int retval = 0;
1737
1738         /* XXX I've no idea if the original SIO supports the event_char
1739          * sysfs parameter, so I'm playing it safe.  */
1740         if (priv->chip_type != SIO) {
1741                 dev_dbg(&port->dev, "sysfs attributes for %s\n", ftdi_chip_name[priv->chip_type]);
1742                 retval = device_create_file(&port->dev, &dev_attr_event_char);
1743                 if ((!retval) &&
1744                     (priv->chip_type == FT232BM ||
1745                      priv->chip_type == FT2232C ||
1746                      priv->chip_type == FT232RL ||
1747                      priv->chip_type == FT2232H ||
1748                      priv->chip_type == FT4232H ||
1749                      priv->chip_type == FT232H ||
1750                      priv->chip_type == FTX)) {
1751                         retval = device_create_file(&port->dev,
1752                                                     &dev_attr_latency_timer);
1753                 }
1754         }
1755         return retval;
1756 }
1757
1758 static void remove_sysfs_attrs(struct usb_serial_port *port)
1759 {
1760         struct ftdi_private *priv = usb_get_serial_port_data(port);
1761
1762         /* XXX see create_sysfs_attrs */
1763         if (priv->chip_type != SIO) {
1764                 device_remove_file(&port->dev, &dev_attr_event_char);
1765                 if (priv->chip_type == FT232BM ||
1766                     priv->chip_type == FT2232C ||
1767                     priv->chip_type == FT232RL ||
1768                     priv->chip_type == FT2232H ||
1769                     priv->chip_type == FT4232H ||
1770                     priv->chip_type == FT232H ||
1771                     priv->chip_type == FTX) {
1772                         device_remove_file(&port->dev, &dev_attr_latency_timer);
1773                 }
1774         }
1775
1776 }
1777
1778 #ifdef CONFIG_GPIOLIB
1779
1780 static int ftdi_set_bitmode(struct usb_serial_port *port, u8 mode)
1781 {
1782         struct ftdi_private *priv = usb_get_serial_port_data(port);
1783         struct usb_serial *serial = port->serial;
1784         int result;
1785         u16 val;
1786
1787         result = usb_autopm_get_interface(serial->interface);
1788         if (result)
1789                 return result;
1790
1791         val = (mode << 8) | (priv->gpio_output << 4) | priv->gpio_value;
1792         result = usb_control_msg(serial->dev,
1793                                  usb_sndctrlpipe(serial->dev, 0),
1794                                  FTDI_SIO_SET_BITMODE_REQUEST,
1795                                  FTDI_SIO_SET_BITMODE_REQUEST_TYPE, val,
1796                                  priv->interface, NULL, 0, WDR_TIMEOUT);
1797         if (result < 0) {
1798                 dev_err(&serial->interface->dev,
1799                         "bitmode request failed for value 0x%04x: %d\n",
1800                         val, result);
1801         }
1802
1803         usb_autopm_put_interface(serial->interface);
1804
1805         return result;
1806 }
1807
1808 static int ftdi_set_cbus_pins(struct usb_serial_port *port)
1809 {
1810         return ftdi_set_bitmode(port, FTDI_SIO_BITMODE_CBUS);
1811 }
1812
1813 static int ftdi_exit_cbus_mode(struct usb_serial_port *port)
1814 {
1815         struct ftdi_private *priv = usb_get_serial_port_data(port);
1816
1817         priv->gpio_output = 0;
1818         priv->gpio_value = 0;
1819         return ftdi_set_bitmode(port, FTDI_SIO_BITMODE_RESET);
1820 }
1821
1822 static int ftdi_gpio_request(struct gpio_chip *gc, unsigned int offset)
1823 {
1824         struct usb_serial_port *port = gpiochip_get_data(gc);
1825         struct ftdi_private *priv = usb_get_serial_port_data(port);
1826         int result;
1827
1828         mutex_lock(&priv->gpio_lock);
1829         if (!priv->gpio_used) {
1830                 /* Set default pin states, as we cannot get them from device */
1831                 priv->gpio_output = 0x00;
1832                 priv->gpio_value = 0x00;
1833                 result = ftdi_set_cbus_pins(port);
1834                 if (result) {
1835                         mutex_unlock(&priv->gpio_lock);
1836                         return result;
1837                 }
1838
1839                 priv->gpio_used = true;
1840         }
1841         mutex_unlock(&priv->gpio_lock);
1842
1843         return 0;
1844 }
1845
1846 static int ftdi_read_cbus_pins(struct usb_serial_port *port)
1847 {
1848         struct ftdi_private *priv = usb_get_serial_port_data(port);
1849         struct usb_serial *serial = port->serial;
1850         unsigned char *buf;
1851         int result;
1852
1853         result = usb_autopm_get_interface(serial->interface);
1854         if (result)
1855                 return result;
1856
1857         buf = kmalloc(1, GFP_KERNEL);
1858         if (!buf) {
1859                 usb_autopm_put_interface(serial->interface);
1860                 return -ENOMEM;
1861         }
1862
1863         result = usb_control_msg(serial->dev,
1864                                  usb_rcvctrlpipe(serial->dev, 0),
1865                                  FTDI_SIO_READ_PINS_REQUEST,
1866                                  FTDI_SIO_READ_PINS_REQUEST_TYPE, 0,
1867                                  priv->interface, buf, 1, WDR_TIMEOUT);
1868         if (result < 1) {
1869                 if (result >= 0)
1870                         result = -EIO;
1871         } else {
1872                 result = buf[0];
1873         }
1874
1875         kfree(buf);
1876         usb_autopm_put_interface(serial->interface);
1877
1878         return result;
1879 }
1880
1881 static int ftdi_gpio_get(struct gpio_chip *gc, unsigned int gpio)
1882 {
1883         struct usb_serial_port *port = gpiochip_get_data(gc);
1884         int result;
1885
1886         result = ftdi_read_cbus_pins(port);
1887         if (result < 0)
1888                 return result;
1889
1890         return !!(result & BIT(gpio));
1891 }
1892
1893 static void ftdi_gpio_set(struct gpio_chip *gc, unsigned int gpio, int value)
1894 {
1895         struct usb_serial_port *port = gpiochip_get_data(gc);
1896         struct ftdi_private *priv = usb_get_serial_port_data(port);
1897
1898         mutex_lock(&priv->gpio_lock);
1899
1900         if (value)
1901                 priv->gpio_value |= BIT(gpio);
1902         else
1903                 priv->gpio_value &= ~BIT(gpio);
1904
1905         ftdi_set_cbus_pins(port);
1906
1907         mutex_unlock(&priv->gpio_lock);
1908 }
1909
1910 static int ftdi_gpio_get_multiple(struct gpio_chip *gc, unsigned long *mask,
1911                                         unsigned long *bits)
1912 {
1913         struct usb_serial_port *port = gpiochip_get_data(gc);
1914         int result;
1915
1916         result = ftdi_read_cbus_pins(port);
1917         if (result < 0)
1918                 return result;
1919
1920         *bits = result & *mask;
1921
1922         return 0;
1923 }
1924
1925 static void ftdi_gpio_set_multiple(struct gpio_chip *gc, unsigned long *mask,
1926                                         unsigned long *bits)
1927 {
1928         struct usb_serial_port *port = gpiochip_get_data(gc);
1929         struct ftdi_private *priv = usb_get_serial_port_data(port);
1930
1931         mutex_lock(&priv->gpio_lock);
1932
1933         priv->gpio_value &= ~(*mask);
1934         priv->gpio_value |= *bits & *mask;
1935         ftdi_set_cbus_pins(port);
1936
1937         mutex_unlock(&priv->gpio_lock);
1938 }
1939
1940 static int ftdi_gpio_direction_get(struct gpio_chip *gc, unsigned int gpio)
1941 {
1942         struct usb_serial_port *port = gpiochip_get_data(gc);
1943         struct ftdi_private *priv = usb_get_serial_port_data(port);
1944
1945         return !(priv->gpio_output & BIT(gpio));
1946 }
1947
1948 static int ftdi_gpio_direction_input(struct gpio_chip *gc, unsigned int gpio)
1949 {
1950         struct usb_serial_port *port = gpiochip_get_data(gc);
1951         struct ftdi_private *priv = usb_get_serial_port_data(port);
1952         int result;
1953
1954         mutex_lock(&priv->gpio_lock);
1955
1956         priv->gpio_output &= ~BIT(gpio);
1957         result = ftdi_set_cbus_pins(port);
1958
1959         mutex_unlock(&priv->gpio_lock);
1960
1961         return result;
1962 }
1963
1964 static int ftdi_gpio_direction_output(struct gpio_chip *gc, unsigned int gpio,
1965                                         int value)
1966 {
1967         struct usb_serial_port *port = gpiochip_get_data(gc);
1968         struct ftdi_private *priv = usb_get_serial_port_data(port);
1969         int result;
1970
1971         mutex_lock(&priv->gpio_lock);
1972
1973         priv->gpio_output |= BIT(gpio);
1974         if (value)
1975                 priv->gpio_value |= BIT(gpio);
1976         else
1977                 priv->gpio_value &= ~BIT(gpio);
1978
1979         result = ftdi_set_cbus_pins(port);
1980
1981         mutex_unlock(&priv->gpio_lock);
1982
1983         return result;
1984 }
1985
1986 static int ftdi_gpio_init_valid_mask(struct gpio_chip *gc,
1987                                      unsigned long *valid_mask,
1988                                      unsigned int ngpios)
1989 {
1990         struct usb_serial_port *port = gpiochip_get_data(gc);
1991         struct ftdi_private *priv = usb_get_serial_port_data(port);
1992         unsigned long map = priv->gpio_altfunc;
1993
1994         bitmap_complement(valid_mask, &map, ngpios);
1995
1996         if (bitmap_empty(valid_mask, ngpios))
1997                 dev_dbg(&port->dev, "no CBUS pin configured for GPIO\n");
1998         else
1999                 dev_dbg(&port->dev, "CBUS%*pbl configured for GPIO\n", ngpios,
2000                         valid_mask);
2001
2002         return 0;
2003 }
2004
2005 static int ftdi_read_eeprom(struct usb_serial *serial, void *dst, u16 addr,
2006                                 u16 nbytes)
2007 {
2008         int read = 0;
2009
2010         if (addr % 2 != 0)
2011                 return -EINVAL;
2012         if (nbytes % 2 != 0)
2013                 return -EINVAL;
2014
2015         /* Read EEPROM two bytes at a time */
2016         while (read < nbytes) {
2017                 int rv;
2018
2019                 rv = usb_control_msg(serial->dev,
2020                                      usb_rcvctrlpipe(serial->dev, 0),
2021                                      FTDI_SIO_READ_EEPROM_REQUEST,
2022                                      FTDI_SIO_READ_EEPROM_REQUEST_TYPE,
2023                                      0, (addr + read) / 2, dst + read, 2,
2024                                      WDR_TIMEOUT);
2025                 if (rv < 2) {
2026                         if (rv >= 0)
2027                                 return -EIO;
2028                         else
2029                                 return rv;
2030                 }
2031
2032                 read += rv;
2033         }
2034
2035         return 0;
2036 }
2037
2038 static int ftdi_gpio_init_ft232h(struct usb_serial_port *port)
2039 {
2040         struct ftdi_private *priv = usb_get_serial_port_data(port);
2041         u16 cbus_config;
2042         u8 *buf;
2043         int ret;
2044         int i;
2045
2046         buf = kmalloc(4, GFP_KERNEL);
2047         if (!buf)
2048                 return -ENOMEM;
2049
2050         ret = ftdi_read_eeprom(port->serial, buf, 0x1a, 4);
2051         if (ret < 0)
2052                 goto out_free;
2053
2054         /*
2055          * FT232H CBUS Memory Map
2056          *
2057          * 0x1a: X- (upper nibble -> AC5)
2058          * 0x1b: -X (lower nibble -> AC6)
2059          * 0x1c: XX (upper nibble -> AC9 | lower nibble -> AC8)
2060          */
2061         cbus_config = buf[2] << 8 | (buf[1] & 0xf) << 4 | (buf[0] & 0xf0) >> 4;
2062
2063         priv->gc.ngpio = 4;
2064         priv->gpio_altfunc = 0xff;
2065
2066         for (i = 0; i < priv->gc.ngpio; ++i) {
2067                 if ((cbus_config & 0xf) == FTDI_FTX_CBUS_MUX_GPIO)
2068                         priv->gpio_altfunc &= ~BIT(i);
2069                 cbus_config >>= 4;
2070         }
2071
2072 out_free:
2073         kfree(buf);
2074
2075         return ret;
2076 }
2077
2078 static int ftdi_gpio_init_ft232r(struct usb_serial_port *port)
2079 {
2080         struct ftdi_private *priv = usb_get_serial_port_data(port);
2081         u16 cbus_config;
2082         u8 *buf;
2083         int ret;
2084         int i;
2085
2086         buf = kmalloc(2, GFP_KERNEL);
2087         if (!buf)
2088                 return -ENOMEM;
2089
2090         ret = ftdi_read_eeprom(port->serial, buf, 0x14, 2);
2091         if (ret < 0)
2092                 goto out_free;
2093
2094         cbus_config = le16_to_cpup((__le16 *)buf);
2095         dev_dbg(&port->dev, "cbus_config = 0x%04x\n", cbus_config);
2096
2097         priv->gc.ngpio = 4;
2098
2099         priv->gpio_altfunc = 0xff;
2100         for (i = 0; i < priv->gc.ngpio; ++i) {
2101                 if ((cbus_config & 0xf) == FTDI_FT232R_CBUS_MUX_GPIO)
2102                         priv->gpio_altfunc &= ~BIT(i);
2103                 cbus_config >>= 4;
2104         }
2105 out_free:
2106         kfree(buf);
2107
2108         return ret;
2109 }
2110
2111 static int ftdi_gpio_init_ftx(struct usb_serial_port *port)
2112 {
2113         struct ftdi_private *priv = usb_get_serial_port_data(port);
2114         struct usb_serial *serial = port->serial;
2115         const u16 cbus_cfg_addr = 0x1a;
2116         const u16 cbus_cfg_size = 4;
2117         u8 *cbus_cfg_buf;
2118         int result;
2119         u8 i;
2120
2121         cbus_cfg_buf = kmalloc(cbus_cfg_size, GFP_KERNEL);
2122         if (!cbus_cfg_buf)
2123                 return -ENOMEM;
2124
2125         result = ftdi_read_eeprom(serial, cbus_cfg_buf,
2126                                   cbus_cfg_addr, cbus_cfg_size);
2127         if (result < 0)
2128                 goto out_free;
2129
2130         /* FIXME: FT234XD alone has 1 GPIO, but how to recognize this IC? */
2131         priv->gc.ngpio = 4;
2132
2133         /* Determine which pins are configured for CBUS bitbanging */
2134         priv->gpio_altfunc = 0xff;
2135         for (i = 0; i < priv->gc.ngpio; ++i) {
2136                 if (cbus_cfg_buf[i] == FTDI_FTX_CBUS_MUX_GPIO)
2137                         priv->gpio_altfunc &= ~BIT(i);
2138         }
2139
2140 out_free:
2141         kfree(cbus_cfg_buf);
2142
2143         return result;
2144 }
2145
2146 static int ftdi_gpio_init(struct usb_serial_port *port)
2147 {
2148         struct ftdi_private *priv = usb_get_serial_port_data(port);
2149         struct usb_serial *serial = port->serial;
2150         int result;
2151
2152         switch (priv->chip_type) {
2153         case FT232H:
2154                 result = ftdi_gpio_init_ft232h(port);
2155                 break;
2156         case FT232RL:
2157                 result = ftdi_gpio_init_ft232r(port);
2158                 break;
2159         case FTX:
2160                 result = ftdi_gpio_init_ftx(port);
2161                 break;
2162         default:
2163                 return 0;
2164         }
2165
2166         if (result < 0)
2167                 return result;
2168
2169         mutex_init(&priv->gpio_lock);
2170
2171         priv->gc.label = "ftdi-cbus";
2172         priv->gc.request = ftdi_gpio_request;
2173         priv->gc.get_direction = ftdi_gpio_direction_get;
2174         priv->gc.direction_input = ftdi_gpio_direction_input;
2175         priv->gc.direction_output = ftdi_gpio_direction_output;
2176         priv->gc.init_valid_mask = ftdi_gpio_init_valid_mask;
2177         priv->gc.get = ftdi_gpio_get;
2178         priv->gc.set = ftdi_gpio_set;
2179         priv->gc.get_multiple = ftdi_gpio_get_multiple;
2180         priv->gc.set_multiple = ftdi_gpio_set_multiple;
2181         priv->gc.owner = THIS_MODULE;
2182         priv->gc.parent = &serial->interface->dev;
2183         priv->gc.base = -1;
2184         priv->gc.can_sleep = true;
2185
2186         result = gpiochip_add_data(&priv->gc, port);
2187         if (!result)
2188                 priv->gpio_registered = true;
2189
2190         return result;
2191 }
2192
2193 static void ftdi_gpio_remove(struct usb_serial_port *port)
2194 {
2195         struct ftdi_private *priv = usb_get_serial_port_data(port);
2196
2197         if (priv->gpio_registered) {
2198                 gpiochip_remove(&priv->gc);
2199                 priv->gpio_registered = false;
2200         }
2201
2202         if (priv->gpio_used) {
2203                 /* Exiting CBUS-mode does not reset pin states. */
2204                 ftdi_exit_cbus_mode(port);
2205                 priv->gpio_used = false;
2206         }
2207 }
2208
2209 #else
2210
2211 static int ftdi_gpio_init(struct usb_serial_port *port)
2212 {
2213         return 0;
2214 }
2215
2216 static void ftdi_gpio_remove(struct usb_serial_port *port) { }
2217
2218 #endif  /* CONFIG_GPIOLIB */
2219
2220 /*
2221  * ***************************************************************************
2222  * FTDI driver specific functions
2223  * ***************************************************************************
2224  */
2225
2226 /* Probe function to check for special devices */
2227 static int ftdi_sio_probe(struct usb_serial *serial,
2228                                         const struct usb_device_id *id)
2229 {
2230         const struct ftdi_sio_quirk *quirk =
2231                                 (struct ftdi_sio_quirk *)id->driver_info;
2232
2233         if (quirk && quirk->probe) {
2234                 int ret = quirk->probe(serial);
2235                 if (ret != 0)
2236                         return ret;
2237         }
2238
2239         usb_set_serial_data(serial, (void *)id->driver_info);
2240
2241         return 0;
2242 }
2243
2244 static int ftdi_sio_port_probe(struct usb_serial_port *port)
2245 {
2246         struct ftdi_private *priv;
2247         const struct ftdi_sio_quirk *quirk = usb_get_serial_data(port->serial);
2248         int result;
2249
2250         priv = kzalloc(sizeof(struct ftdi_private), GFP_KERNEL);
2251         if (!priv)
2252                 return -ENOMEM;
2253
2254         mutex_init(&priv->cfg_lock);
2255
2256         if (quirk && quirk->port_probe)
2257                 quirk->port_probe(priv);
2258
2259         usb_set_serial_port_data(port, priv);
2260
2261         ftdi_determine_type(port);
2262         ftdi_set_max_packet_size(port);
2263         if (read_latency_timer(port) < 0)
2264                 priv->latency = 16;
2265         write_latency_timer(port);
2266         create_sysfs_attrs(port);
2267
2268         result = ftdi_gpio_init(port);
2269         if (result < 0) {
2270                 dev_err(&port->serial->interface->dev,
2271                         "GPIO initialisation failed: %d\n",
2272                         result);
2273         }
2274
2275         return 0;
2276 }
2277
2278 /* Setup for the USB-UIRT device, which requires hardwired
2279  * baudrate (38400 gets mapped to 312500) */
2280 /* Called from usbserial:serial_probe */
2281 static void ftdi_USB_UIRT_setup(struct ftdi_private *priv)
2282 {
2283         priv->flags |= ASYNC_SPD_CUST;
2284         priv->custom_divisor = 77;
2285         priv->force_baud = 38400;
2286 }
2287
2288 /* Setup for the HE-TIRA1 device, which requires hardwired
2289  * baudrate (38400 gets mapped to 100000) and RTS-CTS enabled.  */
2290
2291 static void ftdi_HE_TIRA1_setup(struct ftdi_private *priv)
2292 {
2293         priv->flags |= ASYNC_SPD_CUST;
2294         priv->custom_divisor = 240;
2295         priv->force_baud = 38400;
2296         priv->force_rtscts = 1;
2297 }
2298
2299 /*
2300  * Module parameter to control latency timer for NDI FTDI-based USB devices.
2301  * If this value is not set in /etc/modprobe.d/ its value will be set
2302  * to 1ms.
2303  */
2304 static int ndi_latency_timer = 1;
2305
2306 /* Setup for the NDI FTDI-based USB devices, which requires hardwired
2307  * baudrate (19200 gets mapped to 1200000).
2308  *
2309  * Called from usbserial:serial_probe.
2310  */
2311 static int ftdi_NDI_device_setup(struct usb_serial *serial)
2312 {
2313         struct usb_device *udev = serial->dev;
2314         int latency = ndi_latency_timer;
2315
2316         if (latency == 0)
2317                 latency = 1;
2318         if (latency > 99)
2319                 latency = 99;
2320
2321         dev_dbg(&udev->dev, "%s setting NDI device latency to %d\n", __func__, latency);
2322         dev_info(&udev->dev, "NDI device with a latency value of %d\n", latency);
2323
2324         /* FIXME: errors are not returned */
2325         usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2326                                 FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
2327                                 FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
2328                                 latency, 0, NULL, 0, WDR_TIMEOUT);
2329         return 0;
2330 }
2331
2332 /*
2333  * First port on JTAG adaptors such as Olimex arm-usb-ocd or the FIC/OpenMoko
2334  * Neo1973 Debug Board is reserved for JTAG interface and can be accessed from
2335  * userspace using openocd.
2336  */
2337 static int ftdi_jtag_probe(struct usb_serial *serial)
2338 {
2339         struct usb_interface *intf = serial->interface;
2340         int ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
2341
2342         if (ifnum == 0) {
2343                 dev_info(&intf->dev, "Ignoring interface reserved for JTAG\n");
2344                 return -ENODEV;
2345         }
2346
2347         return 0;
2348 }
2349
2350 static int ftdi_8u2232c_probe(struct usb_serial *serial)
2351 {
2352         struct usb_device *udev = serial->dev;
2353
2354         if (udev->manufacturer && !strcmp(udev->manufacturer, "CALAO Systems"))
2355                 return ftdi_jtag_probe(serial);
2356
2357         if (udev->product &&
2358                 (!strcmp(udev->product, "Arrow USB Blaster") ||
2359                  !strcmp(udev->product, "BeagleBone/XDS100V2") ||
2360                  !strcmp(udev->product, "SNAP Connect E10")))
2361                 return ftdi_jtag_probe(serial);
2362
2363         return 0;
2364 }
2365
2366 /*
2367  * First two ports on JTAG adaptors using an FT4232 such as STMicroelectronics's
2368  * ST Micro Connect Lite are reserved for JTAG or other non-UART interfaces and
2369  * can be accessed from userspace.
2370  * The next two ports are enabled as UARTs by default, where port 2 is
2371  * a conventional RS-232 UART.
2372  */
2373 static int ftdi_stmclite_probe(struct usb_serial *serial)
2374 {
2375         struct usb_interface *intf = serial->interface;
2376         int ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
2377
2378         if (ifnum < 2) {
2379                 dev_info(&intf->dev, "Ignoring interface reserved for JTAG\n");
2380                 return -ENODEV;
2381         }
2382
2383         return 0;
2384 }
2385
2386 static void ftdi_sio_port_remove(struct usb_serial_port *port)
2387 {
2388         struct ftdi_private *priv = usb_get_serial_port_data(port);
2389
2390         ftdi_gpio_remove(port);
2391
2392         remove_sysfs_attrs(port);
2393
2394         kfree(priv);
2395 }
2396
2397 static int ftdi_open(struct tty_struct *tty, struct usb_serial_port *port)
2398 {
2399         struct usb_device *dev = port->serial->dev;
2400         struct ftdi_private *priv = usb_get_serial_port_data(port);
2401
2402         /* No error checking for this (will get errors later anyway) */
2403         /* See ftdi_sio.h for description of what is reset */
2404         usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2405                         FTDI_SIO_RESET_REQUEST, FTDI_SIO_RESET_REQUEST_TYPE,
2406                         FTDI_SIO_RESET_SIO,
2407                         priv->interface, NULL, 0, WDR_TIMEOUT);
2408
2409         /* Termios defaults are set by usb_serial_init. We don't change
2410            port->tty->termios - this would lose speed settings, etc.
2411            This is same behaviour as serial.c/rs_open() - Kuba */
2412
2413         /* ftdi_set_termios  will send usb control messages */
2414         if (tty)
2415                 ftdi_set_termios(tty, port, NULL);
2416
2417         return usb_serial_generic_open(tty, port);
2418 }
2419
2420 static void ftdi_dtr_rts(struct usb_serial_port *port, int on)
2421 {
2422         struct ftdi_private *priv = usb_get_serial_port_data(port);
2423
2424         /* Disable flow control */
2425         if (!on) {
2426                 if (usb_control_msg(port->serial->dev,
2427                             usb_sndctrlpipe(port->serial->dev, 0),
2428                             FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2429                             FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2430                             0, priv->interface, NULL, 0,
2431                             WDR_TIMEOUT) < 0) {
2432                         dev_err(&port->dev, "error from flowcontrol urb\n");
2433                 }
2434         }
2435         /* drop RTS and DTR */
2436         if (on)
2437                 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2438         else
2439                 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2440 }
2441
2442 /* The SIO requires the first byte to have:
2443  *  B0 1
2444  *  B1 0
2445  *  B2..7 length of message excluding byte 0
2446  *
2447  * The new devices do not require this byte
2448  */
2449 static int ftdi_prepare_write_buffer(struct usb_serial_port *port,
2450                                                 void *dest, size_t size)
2451 {
2452         struct ftdi_private *priv;
2453         int count;
2454         unsigned long flags;
2455
2456         priv = usb_get_serial_port_data(port);
2457
2458         if (priv->chip_type == SIO) {
2459                 unsigned char *buffer = dest;
2460                 int i, len, c;
2461
2462                 count = 0;
2463                 spin_lock_irqsave(&port->lock, flags);
2464                 for (i = 0; i < size - 1; i += priv->max_packet_size) {
2465                         len = min_t(int, size - i, priv->max_packet_size) - 1;
2466                         c = kfifo_out(&port->write_fifo, &buffer[i + 1], len);
2467                         if (!c)
2468                                 break;
2469                         port->icount.tx += c;
2470                         buffer[i] = (c << 2) + 1;
2471                         count += c + 1;
2472                 }
2473                 spin_unlock_irqrestore(&port->lock, flags);
2474         } else {
2475                 count = kfifo_out_locked(&port->write_fifo, dest, size,
2476                                                                 &port->lock);
2477                 port->icount.tx += count;
2478         }
2479
2480         return count;
2481 }
2482
2483 #define FTDI_RS_ERR_MASK (FTDI_RS_BI | FTDI_RS_PE | FTDI_RS_FE | FTDI_RS_OE)
2484
2485 static int ftdi_process_packet(struct usb_serial_port *port,
2486                 struct ftdi_private *priv, unsigned char *buf, int len)
2487 {
2488         unsigned char status;
2489         bool brkint = false;
2490         int i;
2491         char flag;
2492
2493         if (len < 2) {
2494                 dev_dbg(&port->dev, "malformed packet\n");
2495                 return 0;
2496         }
2497
2498         /* Compare new line status to the old one, signal if different/
2499            N.B. packet may be processed more than once, but differences
2500            are only processed once.  */
2501         status = buf[0] & FTDI_STATUS_B0_MASK;
2502         if (status != priv->prev_status) {
2503                 char diff_status = status ^ priv->prev_status;
2504
2505                 if (diff_status & FTDI_RS0_CTS)
2506                         port->icount.cts++;
2507                 if (diff_status & FTDI_RS0_DSR)
2508                         port->icount.dsr++;
2509                 if (diff_status & FTDI_RS0_RI)
2510                         port->icount.rng++;
2511                 if (diff_status & FTDI_RS0_RLSD) {
2512                         struct tty_struct *tty;
2513
2514                         port->icount.dcd++;
2515                         tty = tty_port_tty_get(&port->port);
2516                         if (tty)
2517                                 usb_serial_handle_dcd_change(port, tty,
2518                                                 status & FTDI_RS0_RLSD);
2519                         tty_kref_put(tty);
2520                 }
2521
2522                 wake_up_interruptible(&port->port.delta_msr_wait);
2523                 priv->prev_status = status;
2524         }
2525
2526         /* save if the transmitter is empty or not */
2527         if (buf[1] & FTDI_RS_TEMT)
2528                 priv->transmit_empty = 1;
2529         else
2530                 priv->transmit_empty = 0;
2531
2532         if (len == 2)
2533                 return 0;       /* status only */
2534
2535         /*
2536          * Break and error status must only be processed for packets with
2537          * data payload to avoid over-reporting.
2538          */
2539         flag = TTY_NORMAL;
2540         if (buf[1] & FTDI_RS_ERR_MASK) {
2541                 /*
2542                  * Break takes precedence over parity, which takes precedence
2543                  * over framing errors. Note that break is only associated
2544                  * with the last character in the buffer and only when it's a
2545                  * NUL.
2546                  */
2547                 if (buf[1] & FTDI_RS_BI && buf[len - 1] == '\0') {
2548                         port->icount.brk++;
2549                         brkint = true;
2550                 }
2551                 if (buf[1] & FTDI_RS_PE) {
2552                         flag = TTY_PARITY;
2553                         port->icount.parity++;
2554                 } else if (buf[1] & FTDI_RS_FE) {
2555                         flag = TTY_FRAME;
2556                         port->icount.frame++;
2557                 }
2558                 /* Overrun is special, not associated with a char */
2559                 if (buf[1] & FTDI_RS_OE) {
2560                         port->icount.overrun++;
2561                         tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
2562                 }
2563         }
2564
2565         port->icount.rx += len - 2;
2566
2567         if (brkint || port->sysrq) {
2568                 for (i = 2; i < len; i++) {
2569                         if (brkint && i == len - 1) {
2570                                 if (usb_serial_handle_break(port))
2571                                         return len - 3;
2572                                 flag = TTY_BREAK;
2573                         }
2574                         if (usb_serial_handle_sysrq_char(port, buf[i]))
2575                                 continue;
2576                         tty_insert_flip_char(&port->port, buf[i], flag);
2577                 }
2578         } else {
2579                 tty_insert_flip_string_fixed_flag(&port->port, buf + 2, flag,
2580                                 len - 2);
2581         }
2582
2583         return len - 2;
2584 }
2585
2586 static void ftdi_process_read_urb(struct urb *urb)
2587 {
2588         struct usb_serial_port *port = urb->context;
2589         struct ftdi_private *priv = usb_get_serial_port_data(port);
2590         char *data = urb->transfer_buffer;
2591         int i;
2592         int len;
2593         int count = 0;
2594
2595         for (i = 0; i < urb->actual_length; i += priv->max_packet_size) {
2596                 len = min_t(int, urb->actual_length - i, priv->max_packet_size);
2597                 count += ftdi_process_packet(port, priv, &data[i], len);
2598         }
2599
2600         if (count)
2601                 tty_flip_buffer_push(&port->port);
2602 }
2603
2604 static void ftdi_break_ctl(struct tty_struct *tty, int break_state)
2605 {
2606         struct usb_serial_port *port = tty->driver_data;
2607         struct ftdi_private *priv = usb_get_serial_port_data(port);
2608         u16 value;
2609
2610         /* break_state = -1 to turn on break, and 0 to turn off break */
2611         /* see drivers/char/tty_io.c to see it used */
2612         /* last_set_data_value NEVER has the break bit set in it */
2613
2614         if (break_state)
2615                 value = priv->last_set_data_value | FTDI_SIO_SET_BREAK;
2616         else
2617                 value = priv->last_set_data_value;
2618
2619         if (usb_control_msg(port->serial->dev,
2620                         usb_sndctrlpipe(port->serial->dev, 0),
2621                         FTDI_SIO_SET_DATA_REQUEST,
2622                         FTDI_SIO_SET_DATA_REQUEST_TYPE,
2623                         value , priv->interface,
2624                         NULL, 0, WDR_TIMEOUT) < 0) {
2625                 dev_err(&port->dev, "%s FAILED to enable/disable break state (state was %d)\n",
2626                         __func__, break_state);
2627         }
2628
2629         dev_dbg(&port->dev, "%s break state is %d - urb is %d\n", __func__,
2630                 break_state, value);
2631
2632 }
2633
2634 static bool ftdi_tx_empty(struct usb_serial_port *port)
2635 {
2636         unsigned char buf[2];
2637         int ret;
2638
2639         ret = ftdi_get_modem_status(port, buf);
2640         if (ret == 2) {
2641                 if (!(buf[1] & FTDI_RS_TEMT))
2642                         return false;
2643         }
2644
2645         return true;
2646 }
2647
2648 /* old_termios contains the original termios settings and tty->termios contains
2649  * the new setting to be used
2650  * WARNING: set_termios calls this with old_termios in kernel space
2651  */
2652 static void ftdi_set_termios(struct tty_struct *tty,
2653                 struct usb_serial_port *port, struct ktermios *old_termios)
2654 {
2655         struct usb_device *dev = port->serial->dev;
2656         struct device *ddev = &port->dev;
2657         struct ftdi_private *priv = usb_get_serial_port_data(port);
2658         struct ktermios *termios = &tty->termios;
2659         unsigned int cflag = termios->c_cflag;
2660         u16 value, index;
2661         int ret;
2662
2663         /* Force baud rate if this device requires it, unless it is set to
2664            B0. */
2665         if (priv->force_baud && ((termios->c_cflag & CBAUD) != B0)) {
2666                 dev_dbg(ddev, "%s: forcing baud rate for this device\n", __func__);
2667                 tty_encode_baud_rate(tty, priv->force_baud,
2668                                         priv->force_baud);
2669         }
2670
2671         /* Force RTS-CTS if this device requires it. */
2672         if (priv->force_rtscts) {
2673                 dev_dbg(ddev, "%s: forcing rtscts for this device\n", __func__);
2674                 termios->c_cflag |= CRTSCTS;
2675         }
2676
2677         /*
2678          * All FTDI UART chips are limited to CS7/8. We shouldn't pretend to
2679          * support CS5/6 and revert the CSIZE setting instead.
2680          *
2681          * CS5 however is used to control some smartcard readers which abuse
2682          * this limitation to switch modes. Original FTDI chips fall back to
2683          * eight data bits.
2684          *
2685          * TODO: Implement a quirk to only allow this with mentioned
2686          *       readers. One I know of (Argolis Smartreader V1)
2687          *       returns "USB smartcard server" as iInterface string.
2688          *       The vendor didn't bother with a custom VID/PID of
2689          *       course.
2690          */
2691         if (C_CSIZE(tty) == CS6) {
2692                 dev_warn(ddev, "requested CSIZE setting not supported\n");
2693
2694                 termios->c_cflag &= ~CSIZE;
2695                 if (old_termios)
2696                         termios->c_cflag |= old_termios->c_cflag & CSIZE;
2697                 else
2698                         termios->c_cflag |= CS8;
2699         }
2700
2701         cflag = termios->c_cflag;
2702
2703         if (!old_termios)
2704                 goto no_skip;
2705
2706         if (old_termios->c_cflag == termios->c_cflag
2707             && old_termios->c_ispeed == termios->c_ispeed
2708             && old_termios->c_ospeed == termios->c_ospeed)
2709                 goto no_c_cflag_changes;
2710
2711         /* NOTE These routines can get interrupted by
2712            ftdi_sio_read_bulk_callback  - need to examine what this means -
2713            don't see any problems yet */
2714
2715         if ((old_termios->c_cflag & (CSIZE|PARODD|PARENB|CMSPAR|CSTOPB)) ==
2716             (termios->c_cflag & (CSIZE|PARODD|PARENB|CMSPAR|CSTOPB)))
2717                 goto no_data_parity_stop_changes;
2718
2719 no_skip:
2720         /* Set number of data bits, parity, stop bits */
2721
2722         value = 0;
2723         value |= (cflag & CSTOPB ? FTDI_SIO_SET_DATA_STOP_BITS_2 :
2724                         FTDI_SIO_SET_DATA_STOP_BITS_1);
2725         if (cflag & PARENB) {
2726                 if (cflag & CMSPAR)
2727                         value |= cflag & PARODD ?
2728                                         FTDI_SIO_SET_DATA_PARITY_MARK :
2729                                         FTDI_SIO_SET_DATA_PARITY_SPACE;
2730                 else
2731                         value |= cflag & PARODD ?
2732                                         FTDI_SIO_SET_DATA_PARITY_ODD :
2733                                         FTDI_SIO_SET_DATA_PARITY_EVEN;
2734         } else {
2735                 value |= FTDI_SIO_SET_DATA_PARITY_NONE;
2736         }
2737         switch (cflag & CSIZE) {
2738         case CS5:
2739                 dev_dbg(ddev, "Setting CS5 quirk\n");
2740                 break;
2741         case CS7:
2742                 value |= 7;
2743                 dev_dbg(ddev, "Setting CS7\n");
2744                 break;
2745         default:
2746         case CS8:
2747                 value |= 8;
2748                 dev_dbg(ddev, "Setting CS8\n");
2749                 break;
2750         }
2751
2752         /* This is needed by the break command since it uses the same command
2753            - but is or'ed with this value  */
2754         priv->last_set_data_value = value;
2755
2756         if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2757                             FTDI_SIO_SET_DATA_REQUEST,
2758                             FTDI_SIO_SET_DATA_REQUEST_TYPE,
2759                             value , priv->interface,
2760                             NULL, 0, WDR_SHORT_TIMEOUT) < 0) {
2761                 dev_err(ddev, "%s FAILED to set databits/stopbits/parity\n",
2762                         __func__);
2763         }
2764
2765         /* Now do the baudrate */
2766 no_data_parity_stop_changes:
2767         if ((cflag & CBAUD) == B0) {
2768                 /* Disable flow control */
2769                 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2770                                     FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2771                                     FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2772                                     0, priv->interface,
2773                                     NULL, 0, WDR_TIMEOUT) < 0) {
2774                         dev_err(ddev, "%s error from disable flowcontrol urb\n",
2775                                 __func__);
2776                 }
2777                 /* Drop RTS and DTR */
2778                 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2779         } else {
2780                 /* set the baudrate determined before */
2781                 mutex_lock(&priv->cfg_lock);
2782                 if (change_speed(tty, port))
2783                         dev_err(ddev, "%s urb failed to set baudrate\n", __func__);
2784                 mutex_unlock(&priv->cfg_lock);
2785                 /* Ensure RTS and DTR are raised when baudrate changed from 0 */
2786                 if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
2787                         set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2788         }
2789
2790 no_c_cflag_changes:
2791         /* Set hardware-assisted flow control */
2792         value = 0;
2793
2794         if (C_CRTSCTS(tty)) {
2795                 dev_dbg(&port->dev, "enabling rts/cts flow control\n");
2796                 index = FTDI_SIO_RTS_CTS_HS;
2797         } else if (I_IXON(tty)) {
2798                 dev_dbg(&port->dev, "enabling xon/xoff flow control\n");
2799                 index = FTDI_SIO_XON_XOFF_HS;
2800                 value = STOP_CHAR(tty) << 8 | START_CHAR(tty);
2801         } else {
2802                 dev_dbg(&port->dev, "disabling flow control\n");
2803                 index = FTDI_SIO_DISABLE_FLOW_CTRL;
2804         }
2805
2806         index |= priv->interface;
2807
2808         ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2809                         FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2810                         FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2811                         value, index, NULL, 0, WDR_TIMEOUT);
2812         if (ret < 0)
2813                 dev_err(&port->dev, "failed to set flow control: %d\n", ret);
2814 }
2815
2816 /*
2817  * Get modem-control status.
2818  *
2819  * Returns the number of status bytes retrieved (device dependant), or
2820  * negative error code.
2821  */
2822 static int ftdi_get_modem_status(struct usb_serial_port *port,
2823                                                 unsigned char status[2])
2824 {
2825         struct ftdi_private *priv = usb_get_serial_port_data(port);
2826         unsigned char *buf;
2827         int len;
2828         int ret;
2829
2830         buf = kmalloc(2, GFP_KERNEL);
2831         if (!buf)
2832                 return -ENOMEM;
2833         /*
2834          * The 8U232AM returns a two byte value (the SIO a 1 byte value) in
2835          * the same format as the data returned from the in point.
2836          */
2837         switch (priv->chip_type) {
2838         case SIO:
2839                 len = 1;
2840                 break;
2841         case FT8U232AM:
2842         case FT232BM:
2843         case FT2232C:
2844         case FT232RL:
2845         case FT2232H:
2846         case FT4232H:
2847         case FT232H:
2848         case FTX:
2849                 len = 2;
2850                 break;
2851         default:
2852                 ret = -EFAULT;
2853                 goto out;
2854         }
2855
2856         ret = usb_control_msg(port->serial->dev,
2857                         usb_rcvctrlpipe(port->serial->dev, 0),
2858                         FTDI_SIO_GET_MODEM_STATUS_REQUEST,
2859                         FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
2860                         0, priv->interface,
2861                         buf, len, WDR_TIMEOUT);
2862
2863         /* NOTE: We allow short responses and handle that below. */
2864         if (ret < 1) {
2865                 dev_err(&port->dev, "failed to get modem status: %d\n", ret);
2866                 if (ret >= 0)
2867                         ret = -EIO;
2868                 ret = usb_translate_errors(ret);
2869                 goto out;
2870         }
2871
2872         status[0] = buf[0];
2873         if (ret > 1)
2874                 status[1] = buf[1];
2875         else
2876                 status[1] = 0;
2877
2878         dev_dbg(&port->dev, "%s - 0x%02x%02x\n", __func__, status[0],
2879                                                                 status[1]);
2880 out:
2881         kfree(buf);
2882
2883         return ret;
2884 }
2885
2886 static int ftdi_tiocmget(struct tty_struct *tty)
2887 {
2888         struct usb_serial_port *port = tty->driver_data;
2889         struct ftdi_private *priv = usb_get_serial_port_data(port);
2890         unsigned char buf[2];
2891         int ret;
2892
2893         ret = ftdi_get_modem_status(port, buf);
2894         if (ret < 0)
2895                 return ret;
2896
2897         ret =   (buf[0] & FTDI_SIO_DSR_MASK  ? TIOCM_DSR : 0) |
2898                 (buf[0] & FTDI_SIO_CTS_MASK  ? TIOCM_CTS : 0) |
2899                 (buf[0] & FTDI_SIO_RI_MASK   ? TIOCM_RI  : 0) |
2900                 (buf[0] & FTDI_SIO_RLSD_MASK ? TIOCM_CD  : 0) |
2901                 priv->last_dtr_rts;
2902
2903         return ret;
2904 }
2905
2906 static int ftdi_tiocmset(struct tty_struct *tty,
2907                         unsigned int set, unsigned int clear)
2908 {
2909         struct usb_serial_port *port = tty->driver_data;
2910
2911         return update_mctrl(port, set, clear);
2912 }
2913
2914 static int ftdi_ioctl(struct tty_struct *tty,
2915                                         unsigned int cmd, unsigned long arg)
2916 {
2917         struct usb_serial_port *port = tty->driver_data;
2918         void __user *argp = (void __user *)arg;
2919
2920         switch (cmd) {
2921         case TIOCSERGETLSR:
2922                 return get_lsr_info(port, argp);
2923         default:
2924                 break;
2925         }
2926
2927         return -ENOIOCTLCMD;
2928 }
2929
2930 module_usb_serial_driver(serial_drivers, id_table_combined);
2931
2932 MODULE_AUTHOR(DRIVER_AUTHOR);
2933 MODULE_DESCRIPTION(DRIVER_DESC);
2934 MODULE_LICENSE("GPL");
2935
2936 module_param(ndi_latency_timer, int, S_IRUGO | S_IWUSR);
2937 MODULE_PARM_DESC(ndi_latency_timer, "NDI device latency timer override");