Merge tag 'hwmon-for-v5.13-rc4' of git://git.kernel.org/pub/scm/linux/kernel/git...
[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         /* IDS GmbH devices */
1038         { USB_DEVICE(IDS_VID, IDS_SI31A_PID) },
1039         { USB_DEVICE(IDS_VID, IDS_CM31A_PID) },
1040         /* U-Blox devices */
1041         { USB_DEVICE(UBLOX_VID, UBLOX_C099F9P_ZED_PID) },
1042         { USB_DEVICE(UBLOX_VID, UBLOX_C099F9P_ODIN_PID) },
1043         /* FreeCalypso USB adapters */
1044         { USB_DEVICE(FTDI_VID, FTDI_FALCONIA_JTAG_BUF_PID),
1045                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
1046         { USB_DEVICE(FTDI_VID, FTDI_FALCONIA_JTAG_UNBUF_PID),
1047                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
1048         { }                                     /* Terminating entry */
1049 };
1050
1051 MODULE_DEVICE_TABLE(usb, id_table_combined);
1052
1053 static const char *ftdi_chip_name[] = {
1054         [SIO] = "SIO",  /* the serial part of FT8U100AX */
1055         [FT8U232AM] = "FT8U232AM",
1056         [FT232BM] = "FT232BM",
1057         [FT2232C] = "FT2232C",
1058         [FT232RL] = "FT232RL",
1059         [FT2232H] = "FT2232H",
1060         [FT4232H] = "FT4232H",
1061         [FT232H]  = "FT232H",
1062         [FTX]     = "FT-X"
1063 };
1064
1065
1066 /* Used for TIOCMIWAIT */
1067 #define FTDI_STATUS_B0_MASK     (FTDI_RS0_CTS | FTDI_RS0_DSR | FTDI_RS0_RI | FTDI_RS0_RLSD)
1068 #define FTDI_STATUS_B1_MASK     (FTDI_RS_BI)
1069 /* End TIOCMIWAIT */
1070
1071 /* function prototypes for a FTDI serial converter */
1072 static int  ftdi_sio_probe(struct usb_serial *serial,
1073                                         const struct usb_device_id *id);
1074 static int  ftdi_sio_port_probe(struct usb_serial_port *port);
1075 static void ftdi_sio_port_remove(struct usb_serial_port *port);
1076 static int  ftdi_open(struct tty_struct *tty, struct usb_serial_port *port);
1077 static void ftdi_dtr_rts(struct usb_serial_port *port, int on);
1078 static void ftdi_process_read_urb(struct urb *urb);
1079 static int ftdi_prepare_write_buffer(struct usb_serial_port *port,
1080                                                 void *dest, size_t size);
1081 static void ftdi_set_termios(struct tty_struct *tty,
1082                         struct usb_serial_port *port, struct ktermios *old);
1083 static int  ftdi_tiocmget(struct tty_struct *tty);
1084 static int  ftdi_tiocmset(struct tty_struct *tty,
1085                         unsigned int set, unsigned int clear);
1086 static int  ftdi_ioctl(struct tty_struct *tty,
1087                         unsigned int cmd, unsigned long arg);
1088 static void get_serial_info(struct tty_struct *tty, struct serial_struct *ss);
1089 static int set_serial_info(struct tty_struct *tty,
1090                                 struct serial_struct *ss);
1091 static void ftdi_break_ctl(struct tty_struct *tty, int break_state);
1092 static bool ftdi_tx_empty(struct usb_serial_port *port);
1093 static int ftdi_get_modem_status(struct usb_serial_port *port,
1094                                                 unsigned char status[2]);
1095
1096 static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base);
1097 static unsigned short int ftdi_232am_baud_to_divisor(int baud);
1098 static u32 ftdi_232bm_baud_base_to_divisor(int baud, int base);
1099 static u32 ftdi_232bm_baud_to_divisor(int baud);
1100 static u32 ftdi_2232h_baud_base_to_divisor(int baud, int base);
1101 static u32 ftdi_2232h_baud_to_divisor(int baud);
1102
1103 static struct usb_serial_driver ftdi_sio_device = {
1104         .driver = {
1105                 .owner =        THIS_MODULE,
1106                 .name =         "ftdi_sio",
1107         },
1108         .description =          "FTDI USB Serial Device",
1109         .id_table =             id_table_combined,
1110         .num_ports =            1,
1111         .bulk_in_size =         512,
1112         .bulk_out_size =        256,
1113         .probe =                ftdi_sio_probe,
1114         .port_probe =           ftdi_sio_port_probe,
1115         .port_remove =          ftdi_sio_port_remove,
1116         .open =                 ftdi_open,
1117         .dtr_rts =              ftdi_dtr_rts,
1118         .throttle =             usb_serial_generic_throttle,
1119         .unthrottle =           usb_serial_generic_unthrottle,
1120         .process_read_urb =     ftdi_process_read_urb,
1121         .prepare_write_buffer = ftdi_prepare_write_buffer,
1122         .tiocmget =             ftdi_tiocmget,
1123         .tiocmset =             ftdi_tiocmset,
1124         .tiocmiwait =           usb_serial_generic_tiocmiwait,
1125         .get_icount =           usb_serial_generic_get_icount,
1126         .ioctl =                ftdi_ioctl,
1127         .get_serial =           get_serial_info,
1128         .set_serial =           set_serial_info,
1129         .set_termios =          ftdi_set_termios,
1130         .break_ctl =            ftdi_break_ctl,
1131         .tx_empty =             ftdi_tx_empty,
1132 };
1133
1134 static struct usb_serial_driver * const serial_drivers[] = {
1135         &ftdi_sio_device, NULL
1136 };
1137
1138
1139 #define WDR_TIMEOUT 5000 /* default urb timeout */
1140 #define WDR_SHORT_TIMEOUT 1000  /* shorter urb timeout */
1141
1142 /*
1143  * ***************************************************************************
1144  * Utility functions
1145  * ***************************************************************************
1146  */
1147
1148 static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base)
1149 {
1150         unsigned short int divisor;
1151         /* divisor shifted 3 bits to the left */
1152         int divisor3 = DIV_ROUND_CLOSEST(base, 2 * baud);
1153         if ((divisor3 & 0x7) == 7)
1154                 divisor3++; /* round x.7/8 up to x+1 */
1155         divisor = divisor3 >> 3;
1156         divisor3 &= 0x7;
1157         if (divisor3 == 1)
1158                 divisor |= 0xc000;      /* +0.125 */
1159         else if (divisor3 >= 4)
1160                 divisor |= 0x4000;      /* +0.5 */
1161         else if (divisor3 != 0)
1162                 divisor |= 0x8000;      /* +0.25 */
1163         else if (divisor == 1)
1164                 divisor = 0;            /* special case for maximum baud rate */
1165         return divisor;
1166 }
1167
1168 static unsigned short int ftdi_232am_baud_to_divisor(int baud)
1169 {
1170          return ftdi_232am_baud_base_to_divisor(baud, 48000000);
1171 }
1172
1173 static u32 ftdi_232bm_baud_base_to_divisor(int baud, int base)
1174 {
1175         static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
1176         u32 divisor;
1177         /* divisor shifted 3 bits to the left */
1178         int divisor3 = DIV_ROUND_CLOSEST(base, 2 * baud);
1179         divisor = divisor3 >> 3;
1180         divisor |= (u32)divfrac[divisor3 & 0x7] << 14;
1181         /* Deal with special cases for highest baud rates. */
1182         if (divisor == 1)               /* 1.0 */
1183                 divisor = 0;
1184         else if (divisor == 0x4001)     /* 1.5 */
1185                 divisor = 1;
1186         return divisor;
1187 }
1188
1189 static u32 ftdi_232bm_baud_to_divisor(int baud)
1190 {
1191          return ftdi_232bm_baud_base_to_divisor(baud, 48000000);
1192 }
1193
1194 static u32 ftdi_2232h_baud_base_to_divisor(int baud, int base)
1195 {
1196         static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
1197         u32 divisor;
1198         int divisor3;
1199
1200         /* hi-speed baud rate is 10-bit sampling instead of 16-bit */
1201         divisor3 = DIV_ROUND_CLOSEST(8 * base, 10 * baud);
1202
1203         divisor = divisor3 >> 3;
1204         divisor |= (u32)divfrac[divisor3 & 0x7] << 14;
1205         /* Deal with special cases for highest baud rates. */
1206         if (divisor == 1)               /* 1.0 */
1207                 divisor = 0;
1208         else if (divisor == 0x4001)     /* 1.5 */
1209                 divisor = 1;
1210         /*
1211          * Set this bit to turn off a divide by 2.5 on baud rate generator
1212          * This enables baud rates up to 12Mbaud but cannot reach below 1200
1213          * baud with this bit set
1214          */
1215         divisor |= 0x00020000;
1216         return divisor;
1217 }
1218
1219 static u32 ftdi_2232h_baud_to_divisor(int baud)
1220 {
1221          return ftdi_2232h_baud_base_to_divisor(baud, 120000000);
1222 }
1223
1224 #define set_mctrl(port, set)            update_mctrl((port), (set), 0)
1225 #define clear_mctrl(port, clear)        update_mctrl((port), 0, (clear))
1226
1227 static int update_mctrl(struct usb_serial_port *port, unsigned int set,
1228                                                         unsigned int clear)
1229 {
1230         struct ftdi_private *priv = usb_get_serial_port_data(port);
1231         struct device *dev = &port->dev;
1232         unsigned value;
1233         int rv;
1234
1235         if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
1236                 dev_dbg(dev, "%s - DTR|RTS not being set|cleared\n", __func__);
1237                 return 0;       /* no change */
1238         }
1239
1240         clear &= ~set;  /* 'set' takes precedence over 'clear' */
1241         value = 0;
1242         if (clear & TIOCM_DTR)
1243                 value |= FTDI_SIO_SET_DTR_LOW;
1244         if (clear & TIOCM_RTS)
1245                 value |= FTDI_SIO_SET_RTS_LOW;
1246         if (set & TIOCM_DTR)
1247                 value |= FTDI_SIO_SET_DTR_HIGH;
1248         if (set & TIOCM_RTS)
1249                 value |= FTDI_SIO_SET_RTS_HIGH;
1250         rv = usb_control_msg(port->serial->dev,
1251                                usb_sndctrlpipe(port->serial->dev, 0),
1252                                FTDI_SIO_SET_MODEM_CTRL_REQUEST,
1253                                FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE,
1254                                value, priv->interface,
1255                                NULL, 0, WDR_TIMEOUT);
1256         if (rv < 0) {
1257                 dev_dbg(dev, "%s Error from MODEM_CTRL urb: DTR %s, RTS %s\n",
1258                         __func__,
1259                         (set & TIOCM_DTR) ? "HIGH" : (clear & TIOCM_DTR) ? "LOW" : "unchanged",
1260                         (set & TIOCM_RTS) ? "HIGH" : (clear & TIOCM_RTS) ? "LOW" : "unchanged");
1261                 rv = usb_translate_errors(rv);
1262         } else {
1263                 dev_dbg(dev, "%s - DTR %s, RTS %s\n", __func__,
1264                         (set & TIOCM_DTR) ? "HIGH" : (clear & TIOCM_DTR) ? "LOW" : "unchanged",
1265                         (set & TIOCM_RTS) ? "HIGH" : (clear & TIOCM_RTS) ? "LOW" : "unchanged");
1266                 /* FIXME: locking on last_dtr_rts */
1267                 priv->last_dtr_rts = (priv->last_dtr_rts & ~clear) | set;
1268         }
1269         return rv;
1270 }
1271
1272
1273 static u32 get_ftdi_divisor(struct tty_struct *tty,
1274                                                 struct usb_serial_port *port)
1275 {
1276         struct ftdi_private *priv = usb_get_serial_port_data(port);
1277         struct device *dev = &port->dev;
1278         u32 div_value = 0;
1279         int div_okay = 1;
1280         int baud;
1281
1282         baud = tty_get_baud_rate(tty);
1283         dev_dbg(dev, "%s - tty_get_baud_rate reports speed %d\n", __func__, baud);
1284
1285         /*
1286          * Observe deprecated async-compatible custom_divisor hack, update
1287          * baudrate if needed.
1288          */
1289         if (baud == 38400 &&
1290             ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
1291              (priv->custom_divisor)) {
1292                 baud = priv->baud_base / priv->custom_divisor;
1293                 dev_dbg(dev, "%s - custom divisor %d sets baud rate to %d\n",
1294                         __func__, priv->custom_divisor, baud);
1295         }
1296
1297         if (!baud)
1298                 baud = 9600;
1299         switch (priv->chip_type) {
1300         case SIO: /* SIO chip */
1301                 switch (baud) {
1302                 case 300: div_value = ftdi_sio_b300; break;
1303                 case 600: div_value = ftdi_sio_b600; break;
1304                 case 1200: div_value = ftdi_sio_b1200; break;
1305                 case 2400: div_value = ftdi_sio_b2400; break;
1306                 case 4800: div_value = ftdi_sio_b4800; break;
1307                 case 9600: div_value = ftdi_sio_b9600; break;
1308                 case 19200: div_value = ftdi_sio_b19200; break;
1309                 case 38400: div_value = ftdi_sio_b38400; break;
1310                 case 57600: div_value = ftdi_sio_b57600;  break;
1311                 case 115200: div_value = ftdi_sio_b115200; break;
1312                 } /* baud */
1313                 if (div_value == 0) {
1314                         dev_dbg(dev, "%s - Baudrate (%d) requested is not supported\n",
1315                                 __func__,  baud);
1316                         div_value = ftdi_sio_b9600;
1317                         baud = 9600;
1318                         div_okay = 0;
1319                 }
1320                 break;
1321         case FT8U232AM: /* 8U232AM chip */
1322                 if (baud <= 3000000) {
1323                         div_value = ftdi_232am_baud_to_divisor(baud);
1324                 } else {
1325                         dev_dbg(dev, "%s - Baud rate too high!\n", __func__);
1326                         baud = 9600;
1327                         div_value = ftdi_232am_baud_to_divisor(9600);
1328                         div_okay = 0;
1329                 }
1330                 break;
1331         case FT232BM: /* FT232BM chip */
1332         case FT2232C: /* FT2232C chip */
1333         case FT232RL: /* FT232RL chip */
1334         case FTX:     /* FT-X series */
1335                 if (baud <= 3000000) {
1336                         u16 product_id = le16_to_cpu(
1337                                 port->serial->dev->descriptor.idProduct);
1338                         if (((product_id == FTDI_NDI_HUC_PID)           ||
1339                              (product_id == FTDI_NDI_SPECTRA_SCU_PID)   ||
1340                              (product_id == FTDI_NDI_FUTURE_2_PID)      ||
1341                              (product_id == FTDI_NDI_FUTURE_3_PID)      ||
1342                              (product_id == FTDI_NDI_AURORA_SCU_PID))   &&
1343                             (baud == 19200)) {
1344                                 baud = 1200000;
1345                         }
1346                         div_value = ftdi_232bm_baud_to_divisor(baud);
1347                 } else {
1348                         dev_dbg(dev, "%s - Baud rate too high!\n", __func__);
1349                         div_value = ftdi_232bm_baud_to_divisor(9600);
1350                         div_okay = 0;
1351                         baud = 9600;
1352                 }
1353                 break;
1354         case FT2232H: /* FT2232H chip */
1355         case FT4232H: /* FT4232H chip */
1356         case FT232H:  /* FT232H chip */
1357                 if ((baud <= 12000000) && (baud >= 1200)) {
1358                         div_value = ftdi_2232h_baud_to_divisor(baud);
1359                 } else if (baud < 1200) {
1360                         div_value = ftdi_232bm_baud_to_divisor(baud);
1361                 } else {
1362                         dev_dbg(dev, "%s - Baud rate too high!\n", __func__);
1363                         div_value = ftdi_232bm_baud_to_divisor(9600);
1364                         div_okay = 0;
1365                         baud = 9600;
1366                 }
1367                 break;
1368         } /* priv->chip_type */
1369
1370         if (div_okay) {
1371                 dev_dbg(dev, "%s - Baud rate set to %d (divisor 0x%lX) on chip %s\n",
1372                         __func__, baud, (unsigned long)div_value,
1373                         ftdi_chip_name[priv->chip_type]);
1374         }
1375
1376         tty_encode_baud_rate(tty, baud, baud);
1377         return div_value;
1378 }
1379
1380 static int change_speed(struct tty_struct *tty, struct usb_serial_port *port)
1381 {
1382         struct ftdi_private *priv = usb_get_serial_port_data(port);
1383         u16 value;
1384         u16 index;
1385         u32 index_value;
1386         int rv;
1387
1388         index_value = get_ftdi_divisor(tty, port);
1389         value = (u16)index_value;
1390         index = (u16)(index_value >> 16);
1391         if (priv->chip_type == FT2232C || priv->chip_type == FT2232H ||
1392                         priv->chip_type == FT4232H || priv->chip_type == FT232H ||
1393                         priv->chip_type == FTX) {
1394                 /* Probably the BM type needs the MSB of the encoded fractional
1395                  * divider also moved like for the chips above. Any infos? */
1396                 index = (u16)((index << 8) | priv->interface);
1397         }
1398
1399         rv = usb_control_msg(port->serial->dev,
1400                             usb_sndctrlpipe(port->serial->dev, 0),
1401                             FTDI_SIO_SET_BAUDRATE_REQUEST,
1402                             FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE,
1403                             value, index,
1404                             NULL, 0, WDR_SHORT_TIMEOUT);
1405         return rv;
1406 }
1407
1408 static int write_latency_timer(struct usb_serial_port *port)
1409 {
1410         struct ftdi_private *priv = usb_get_serial_port_data(port);
1411         struct usb_device *udev = port->serial->dev;
1412         int rv;
1413         int l = priv->latency;
1414
1415         if (priv->chip_type == SIO || priv->chip_type == FT8U232AM)
1416                 return -EINVAL;
1417
1418         if (priv->flags & ASYNC_LOW_LATENCY)
1419                 l = 1;
1420
1421         dev_dbg(&port->dev, "%s: setting latency timer = %i\n", __func__, l);
1422
1423         rv = usb_control_msg(udev,
1424                              usb_sndctrlpipe(udev, 0),
1425                              FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
1426                              FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
1427                              l, priv->interface,
1428                              NULL, 0, WDR_TIMEOUT);
1429         if (rv < 0)
1430                 dev_err(&port->dev, "Unable to write latency timer: %i\n", rv);
1431         return rv;
1432 }
1433
1434 static int _read_latency_timer(struct usb_serial_port *port)
1435 {
1436         struct ftdi_private *priv = usb_get_serial_port_data(port);
1437         struct usb_device *udev = port->serial->dev;
1438         unsigned char *buf;
1439         int rv;
1440
1441         buf = kmalloc(1, GFP_KERNEL);
1442         if (!buf)
1443                 return -ENOMEM;
1444
1445         rv = usb_control_msg(udev,
1446                              usb_rcvctrlpipe(udev, 0),
1447                              FTDI_SIO_GET_LATENCY_TIMER_REQUEST,
1448                              FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE,
1449                              0, priv->interface,
1450                              buf, 1, WDR_TIMEOUT);
1451         if (rv < 1) {
1452                 if (rv >= 0)
1453                         rv = -EIO;
1454         } else {
1455                 rv = buf[0];
1456         }
1457
1458         kfree(buf);
1459
1460         return rv;
1461 }
1462
1463 static int read_latency_timer(struct usb_serial_port *port)
1464 {
1465         struct ftdi_private *priv = usb_get_serial_port_data(port);
1466         int rv;
1467
1468         if (priv->chip_type == SIO || priv->chip_type == FT8U232AM)
1469                 return -EINVAL;
1470
1471         rv = _read_latency_timer(port);
1472         if (rv < 0) {
1473                 dev_err(&port->dev, "Unable to read latency timer: %i\n", rv);
1474                 return rv;
1475         }
1476
1477         priv->latency = rv;
1478
1479         return 0;
1480 }
1481
1482 static void get_serial_info(struct tty_struct *tty, struct serial_struct *ss)
1483 {
1484         struct usb_serial_port *port = tty->driver_data;
1485         struct ftdi_private *priv = usb_get_serial_port_data(port);
1486
1487         ss->flags = priv->flags;
1488         ss->baud_base = priv->baud_base;
1489         ss->custom_divisor = priv->custom_divisor;
1490 }
1491
1492 static int set_serial_info(struct tty_struct *tty, struct serial_struct *ss)
1493 {
1494         struct usb_serial_port *port = tty->driver_data;
1495         struct ftdi_private *priv = usb_get_serial_port_data(port);
1496         int old_flags, old_divisor;
1497
1498         mutex_lock(&priv->cfg_lock);
1499
1500         if (!capable(CAP_SYS_ADMIN)) {
1501                 if ((ss->flags ^ priv->flags) & ~ASYNC_USR_MASK) {
1502                         mutex_unlock(&priv->cfg_lock);
1503                         return -EPERM;
1504                 }
1505         }
1506
1507         old_flags = priv->flags;
1508         old_divisor = priv->custom_divisor;
1509
1510         priv->flags = ss->flags & ASYNC_FLAGS;
1511         priv->custom_divisor = ss->custom_divisor;
1512
1513         write_latency_timer(port);
1514
1515         if ((priv->flags ^ old_flags) & ASYNC_SPD_MASK ||
1516                         ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST &&
1517                          priv->custom_divisor != old_divisor)) {
1518
1519                 /* warn about deprecation unless clearing */
1520                 if (priv->flags & ASYNC_SPD_MASK)
1521                         dev_warn_ratelimited(&port->dev, "use of SPD flags is deprecated\n");
1522
1523                 change_speed(tty, port);
1524         }
1525         mutex_unlock(&priv->cfg_lock);
1526         return 0;
1527 }
1528
1529 static int get_lsr_info(struct usb_serial_port *port,
1530                         unsigned int __user *retinfo)
1531 {
1532         struct ftdi_private *priv = usb_get_serial_port_data(port);
1533         unsigned int result = 0;
1534
1535         if (priv->transmit_empty)
1536                 result = TIOCSER_TEMT;
1537
1538         if (copy_to_user(retinfo, &result, sizeof(unsigned int)))
1539                 return -EFAULT;
1540         return 0;
1541 }
1542
1543
1544 /* Determine type of FTDI chip based on USB config and descriptor. */
1545 static void ftdi_determine_type(struct usb_serial_port *port)
1546 {
1547         struct ftdi_private *priv = usb_get_serial_port_data(port);
1548         struct usb_serial *serial = port->serial;
1549         struct usb_device *udev = serial->dev;
1550         unsigned version;
1551         unsigned interfaces;
1552
1553         /* Assume it is not the original SIO device for now. */
1554         priv->baud_base = 48000000 / 2;
1555
1556         version = le16_to_cpu(udev->descriptor.bcdDevice);
1557         interfaces = udev->actconfig->desc.bNumInterfaces;
1558         dev_dbg(&port->dev, "%s: bcdDevice = 0x%x, bNumInterfaces = %u\n", __func__,
1559                 version, interfaces);
1560         if (interfaces > 1) {
1561                 struct usb_interface *intf = serial->interface;
1562                 int ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
1563
1564                 /* Multiple interfaces.*/
1565                 if (version == 0x0800) {
1566                         priv->chip_type = FT4232H;
1567                         /* Hi-speed - baud clock runs at 120MHz */
1568                         priv->baud_base = 120000000 / 2;
1569                 } else if (version == 0x0700) {
1570                         priv->chip_type = FT2232H;
1571                         /* Hi-speed - baud clock runs at 120MHz */
1572                         priv->baud_base = 120000000 / 2;
1573                 } else
1574                         priv->chip_type = FT2232C;
1575
1576                 /* Determine interface code. */
1577                 if (ifnum == 0)
1578                         priv->interface = INTERFACE_A;
1579                 else if (ifnum == 1)
1580                         priv->interface = INTERFACE_B;
1581                 else if (ifnum == 2)
1582                         priv->interface = INTERFACE_C;
1583                 else if (ifnum == 3)
1584                         priv->interface = INTERFACE_D;
1585
1586                 /* BM-type devices have a bug where bcdDevice gets set
1587                  * to 0x200 when iSerialNumber is 0.  */
1588                 if (version < 0x500) {
1589                         dev_dbg(&port->dev,
1590                                 "%s: something fishy - bcdDevice too low for multi-interface device\n",
1591                                 __func__);
1592                 }
1593         } else if (version < 0x200) {
1594                 /* Old device.  Assume it's the original SIO. */
1595                 priv->chip_type = SIO;
1596                 priv->baud_base = 12000000 / 16;
1597         } else if (version < 0x400) {
1598                 /* Assume it's an FT8U232AM (or FT8U245AM) */
1599                 priv->chip_type = FT8U232AM;
1600                 /*
1601                  * It might be a BM type because of the iSerialNumber bug.
1602                  * If iSerialNumber==0 and the latency timer is readable,
1603                  * assume it is BM type.
1604                  */
1605                 if (udev->descriptor.iSerialNumber == 0 &&
1606                                 _read_latency_timer(port) >= 0) {
1607                         dev_dbg(&port->dev,
1608                                 "%s: has latency timer so not an AM type\n",
1609                                 __func__);
1610                         priv->chip_type = FT232BM;
1611                 }
1612         } else if (version < 0x600) {
1613                 /* Assume it's an FT232BM (or FT245BM) */
1614                 priv->chip_type = FT232BM;
1615         } else if (version < 0x900) {
1616                 /* Assume it's an FT232RL */
1617                 priv->chip_type = FT232RL;
1618         } else if (version < 0x1000) {
1619                 /* Assume it's an FT232H */
1620                 priv->chip_type = FT232H;
1621         } else {
1622                 /* Assume it's an FT-X series device */
1623                 priv->chip_type = FTX;
1624         }
1625
1626         dev_info(&udev->dev, "Detected %s\n", ftdi_chip_name[priv->chip_type]);
1627 }
1628
1629
1630 /*
1631  * Determine the maximum packet size for the device. This depends on the chip
1632  * type and the USB host capabilities. The value should be obtained from the
1633  * device descriptor as the chip will use the appropriate values for the host.
1634  */
1635 static void ftdi_set_max_packet_size(struct usb_serial_port *port)
1636 {
1637         struct ftdi_private *priv = usb_get_serial_port_data(port);
1638         struct usb_interface *interface = port->serial->interface;
1639         struct usb_endpoint_descriptor *ep_desc;
1640         unsigned num_endpoints;
1641         unsigned i;
1642
1643         num_endpoints = interface->cur_altsetting->desc.bNumEndpoints;
1644         if (!num_endpoints)
1645                 return;
1646
1647         /*
1648          * NOTE: Some customers have programmed FT232R/FT245R devices
1649          * with an endpoint size of 0 - not good. In this case, we
1650          * want to override the endpoint descriptor setting and use a
1651          * value of 64 for wMaxPacketSize.
1652          */
1653         for (i = 0; i < num_endpoints; i++) {
1654                 ep_desc = &interface->cur_altsetting->endpoint[i].desc;
1655                 if (!ep_desc->wMaxPacketSize) {
1656                         ep_desc->wMaxPacketSize = cpu_to_le16(0x40);
1657                         dev_warn(&port->dev, "Overriding wMaxPacketSize on endpoint %d\n",
1658                                         usb_endpoint_num(ep_desc));
1659                 }
1660         }
1661
1662         /* Set max packet size based on last descriptor. */
1663         priv->max_packet_size = usb_endpoint_maxp(ep_desc);
1664 }
1665
1666
1667 /*
1668  * ***************************************************************************
1669  * Sysfs Attribute
1670  * ***************************************************************************
1671  */
1672
1673 static ssize_t latency_timer_show(struct device *dev,
1674                                   struct device_attribute *attr, char *buf)
1675 {
1676         struct usb_serial_port *port = to_usb_serial_port(dev);
1677         struct ftdi_private *priv = usb_get_serial_port_data(port);
1678         if (priv->flags & ASYNC_LOW_LATENCY)
1679                 return sprintf(buf, "1\n");
1680         else
1681                 return sprintf(buf, "%i\n", priv->latency);
1682 }
1683
1684 /* Write a new value of the latency timer, in units of milliseconds. */
1685 static ssize_t latency_timer_store(struct device *dev,
1686                                    struct device_attribute *attr,
1687                                    const char *valbuf, size_t count)
1688 {
1689         struct usb_serial_port *port = to_usb_serial_port(dev);
1690         struct ftdi_private *priv = usb_get_serial_port_data(port);
1691         u8 v;
1692         int rv;
1693
1694         if (kstrtou8(valbuf, 10, &v))
1695                 return -EINVAL;
1696
1697         priv->latency = v;
1698         rv = write_latency_timer(port);
1699         if (rv < 0)
1700                 return -EIO;
1701         return count;
1702 }
1703 static DEVICE_ATTR_RW(latency_timer);
1704
1705 /* Write an event character directly to the FTDI register.  The ASCII
1706    value is in the low 8 bits, with the enable bit in the 9th bit. */
1707 static ssize_t event_char_store(struct device *dev,
1708         struct device_attribute *attr, const char *valbuf, size_t count)
1709 {
1710         struct usb_serial_port *port = to_usb_serial_port(dev);
1711         struct ftdi_private *priv = usb_get_serial_port_data(port);
1712         struct usb_device *udev = port->serial->dev;
1713         unsigned int v;
1714         int rv;
1715
1716         if (kstrtouint(valbuf, 0, &v) || v >= 0x200)
1717                 return -EINVAL;
1718
1719         dev_dbg(&port->dev, "%s: setting event char = 0x%03x\n", __func__, v);
1720
1721         rv = usb_control_msg(udev,
1722                              usb_sndctrlpipe(udev, 0),
1723                              FTDI_SIO_SET_EVENT_CHAR_REQUEST,
1724                              FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE,
1725                              v, priv->interface,
1726                              NULL, 0, WDR_TIMEOUT);
1727         if (rv < 0) {
1728                 dev_dbg(&port->dev, "Unable to write event character: %i\n", rv);
1729                 return -EIO;
1730         }
1731
1732         return count;
1733 }
1734 static DEVICE_ATTR_WO(event_char);
1735
1736 static int create_sysfs_attrs(struct usb_serial_port *port)
1737 {
1738         struct ftdi_private *priv = usb_get_serial_port_data(port);
1739         int retval = 0;
1740
1741         /* XXX I've no idea if the original SIO supports the event_char
1742          * sysfs parameter, so I'm playing it safe.  */
1743         if (priv->chip_type != SIO) {
1744                 dev_dbg(&port->dev, "sysfs attributes for %s\n", ftdi_chip_name[priv->chip_type]);
1745                 retval = device_create_file(&port->dev, &dev_attr_event_char);
1746                 if ((!retval) &&
1747                     (priv->chip_type == FT232BM ||
1748                      priv->chip_type == FT2232C ||
1749                      priv->chip_type == FT232RL ||
1750                      priv->chip_type == FT2232H ||
1751                      priv->chip_type == FT4232H ||
1752                      priv->chip_type == FT232H ||
1753                      priv->chip_type == FTX)) {
1754                         retval = device_create_file(&port->dev,
1755                                                     &dev_attr_latency_timer);
1756                 }
1757         }
1758         return retval;
1759 }
1760
1761 static void remove_sysfs_attrs(struct usb_serial_port *port)
1762 {
1763         struct ftdi_private *priv = usb_get_serial_port_data(port);
1764
1765         /* XXX see create_sysfs_attrs */
1766         if (priv->chip_type != SIO) {
1767                 device_remove_file(&port->dev, &dev_attr_event_char);
1768                 if (priv->chip_type == FT232BM ||
1769                     priv->chip_type == FT2232C ||
1770                     priv->chip_type == FT232RL ||
1771                     priv->chip_type == FT2232H ||
1772                     priv->chip_type == FT4232H ||
1773                     priv->chip_type == FT232H ||
1774                     priv->chip_type == FTX) {
1775                         device_remove_file(&port->dev, &dev_attr_latency_timer);
1776                 }
1777         }
1778
1779 }
1780
1781 #ifdef CONFIG_GPIOLIB
1782
1783 static int ftdi_set_bitmode(struct usb_serial_port *port, u8 mode)
1784 {
1785         struct ftdi_private *priv = usb_get_serial_port_data(port);
1786         struct usb_serial *serial = port->serial;
1787         int result;
1788         u16 val;
1789
1790         result = usb_autopm_get_interface(serial->interface);
1791         if (result)
1792                 return result;
1793
1794         val = (mode << 8) | (priv->gpio_output << 4) | priv->gpio_value;
1795         result = usb_control_msg(serial->dev,
1796                                  usb_sndctrlpipe(serial->dev, 0),
1797                                  FTDI_SIO_SET_BITMODE_REQUEST,
1798                                  FTDI_SIO_SET_BITMODE_REQUEST_TYPE, val,
1799                                  priv->interface, NULL, 0, WDR_TIMEOUT);
1800         if (result < 0) {
1801                 dev_err(&serial->interface->dev,
1802                         "bitmode request failed for value 0x%04x: %d\n",
1803                         val, result);
1804         }
1805
1806         usb_autopm_put_interface(serial->interface);
1807
1808         return result;
1809 }
1810
1811 static int ftdi_set_cbus_pins(struct usb_serial_port *port)
1812 {
1813         return ftdi_set_bitmode(port, FTDI_SIO_BITMODE_CBUS);
1814 }
1815
1816 static int ftdi_exit_cbus_mode(struct usb_serial_port *port)
1817 {
1818         struct ftdi_private *priv = usb_get_serial_port_data(port);
1819
1820         priv->gpio_output = 0;
1821         priv->gpio_value = 0;
1822         return ftdi_set_bitmode(port, FTDI_SIO_BITMODE_RESET);
1823 }
1824
1825 static int ftdi_gpio_request(struct gpio_chip *gc, unsigned int offset)
1826 {
1827         struct usb_serial_port *port = gpiochip_get_data(gc);
1828         struct ftdi_private *priv = usb_get_serial_port_data(port);
1829         int result;
1830
1831         mutex_lock(&priv->gpio_lock);
1832         if (!priv->gpio_used) {
1833                 /* Set default pin states, as we cannot get them from device */
1834                 priv->gpio_output = 0x00;
1835                 priv->gpio_value = 0x00;
1836                 result = ftdi_set_cbus_pins(port);
1837                 if (result) {
1838                         mutex_unlock(&priv->gpio_lock);
1839                         return result;
1840                 }
1841
1842                 priv->gpio_used = true;
1843         }
1844         mutex_unlock(&priv->gpio_lock);
1845
1846         return 0;
1847 }
1848
1849 static int ftdi_read_cbus_pins(struct usb_serial_port *port)
1850 {
1851         struct ftdi_private *priv = usb_get_serial_port_data(port);
1852         struct usb_serial *serial = port->serial;
1853         unsigned char *buf;
1854         int result;
1855
1856         result = usb_autopm_get_interface(serial->interface);
1857         if (result)
1858                 return result;
1859
1860         buf = kmalloc(1, GFP_KERNEL);
1861         if (!buf) {
1862                 usb_autopm_put_interface(serial->interface);
1863                 return -ENOMEM;
1864         }
1865
1866         result = usb_control_msg(serial->dev,
1867                                  usb_rcvctrlpipe(serial->dev, 0),
1868                                  FTDI_SIO_READ_PINS_REQUEST,
1869                                  FTDI_SIO_READ_PINS_REQUEST_TYPE, 0,
1870                                  priv->interface, buf, 1, WDR_TIMEOUT);
1871         if (result < 1) {
1872                 if (result >= 0)
1873                         result = -EIO;
1874         } else {
1875                 result = buf[0];
1876         }
1877
1878         kfree(buf);
1879         usb_autopm_put_interface(serial->interface);
1880
1881         return result;
1882 }
1883
1884 static int ftdi_gpio_get(struct gpio_chip *gc, unsigned int gpio)
1885 {
1886         struct usb_serial_port *port = gpiochip_get_data(gc);
1887         int result;
1888
1889         result = ftdi_read_cbus_pins(port);
1890         if (result < 0)
1891                 return result;
1892
1893         return !!(result & BIT(gpio));
1894 }
1895
1896 static void ftdi_gpio_set(struct gpio_chip *gc, unsigned int gpio, int value)
1897 {
1898         struct usb_serial_port *port = gpiochip_get_data(gc);
1899         struct ftdi_private *priv = usb_get_serial_port_data(port);
1900
1901         mutex_lock(&priv->gpio_lock);
1902
1903         if (value)
1904                 priv->gpio_value |= BIT(gpio);
1905         else
1906                 priv->gpio_value &= ~BIT(gpio);
1907
1908         ftdi_set_cbus_pins(port);
1909
1910         mutex_unlock(&priv->gpio_lock);
1911 }
1912
1913 static int ftdi_gpio_get_multiple(struct gpio_chip *gc, unsigned long *mask,
1914                                         unsigned long *bits)
1915 {
1916         struct usb_serial_port *port = gpiochip_get_data(gc);
1917         int result;
1918
1919         result = ftdi_read_cbus_pins(port);
1920         if (result < 0)
1921                 return result;
1922
1923         *bits = result & *mask;
1924
1925         return 0;
1926 }
1927
1928 static void ftdi_gpio_set_multiple(struct gpio_chip *gc, unsigned long *mask,
1929                                         unsigned long *bits)
1930 {
1931         struct usb_serial_port *port = gpiochip_get_data(gc);
1932         struct ftdi_private *priv = usb_get_serial_port_data(port);
1933
1934         mutex_lock(&priv->gpio_lock);
1935
1936         priv->gpio_value &= ~(*mask);
1937         priv->gpio_value |= *bits & *mask;
1938         ftdi_set_cbus_pins(port);
1939
1940         mutex_unlock(&priv->gpio_lock);
1941 }
1942
1943 static int ftdi_gpio_direction_get(struct gpio_chip *gc, unsigned int gpio)
1944 {
1945         struct usb_serial_port *port = gpiochip_get_data(gc);
1946         struct ftdi_private *priv = usb_get_serial_port_data(port);
1947
1948         return !(priv->gpio_output & BIT(gpio));
1949 }
1950
1951 static int ftdi_gpio_direction_input(struct gpio_chip *gc, unsigned int gpio)
1952 {
1953         struct usb_serial_port *port = gpiochip_get_data(gc);
1954         struct ftdi_private *priv = usb_get_serial_port_data(port);
1955         int result;
1956
1957         mutex_lock(&priv->gpio_lock);
1958
1959         priv->gpio_output &= ~BIT(gpio);
1960         result = ftdi_set_cbus_pins(port);
1961
1962         mutex_unlock(&priv->gpio_lock);
1963
1964         return result;
1965 }
1966
1967 static int ftdi_gpio_direction_output(struct gpio_chip *gc, unsigned int gpio,
1968                                         int value)
1969 {
1970         struct usb_serial_port *port = gpiochip_get_data(gc);
1971         struct ftdi_private *priv = usb_get_serial_port_data(port);
1972         int result;
1973
1974         mutex_lock(&priv->gpio_lock);
1975
1976         priv->gpio_output |= BIT(gpio);
1977         if (value)
1978                 priv->gpio_value |= BIT(gpio);
1979         else
1980                 priv->gpio_value &= ~BIT(gpio);
1981
1982         result = ftdi_set_cbus_pins(port);
1983
1984         mutex_unlock(&priv->gpio_lock);
1985
1986         return result;
1987 }
1988
1989 static int ftdi_gpio_init_valid_mask(struct gpio_chip *gc,
1990                                      unsigned long *valid_mask,
1991                                      unsigned int ngpios)
1992 {
1993         struct usb_serial_port *port = gpiochip_get_data(gc);
1994         struct ftdi_private *priv = usb_get_serial_port_data(port);
1995         unsigned long map = priv->gpio_altfunc;
1996
1997         bitmap_complement(valid_mask, &map, ngpios);
1998
1999         if (bitmap_empty(valid_mask, ngpios))
2000                 dev_dbg(&port->dev, "no CBUS pin configured for GPIO\n");
2001         else
2002                 dev_dbg(&port->dev, "CBUS%*pbl configured for GPIO\n", ngpios,
2003                         valid_mask);
2004
2005         return 0;
2006 }
2007
2008 static int ftdi_read_eeprom(struct usb_serial *serial, void *dst, u16 addr,
2009                                 u16 nbytes)
2010 {
2011         int read = 0;
2012
2013         if (addr % 2 != 0)
2014                 return -EINVAL;
2015         if (nbytes % 2 != 0)
2016                 return -EINVAL;
2017
2018         /* Read EEPROM two bytes at a time */
2019         while (read < nbytes) {
2020                 int rv;
2021
2022                 rv = usb_control_msg(serial->dev,
2023                                      usb_rcvctrlpipe(serial->dev, 0),
2024                                      FTDI_SIO_READ_EEPROM_REQUEST,
2025                                      FTDI_SIO_READ_EEPROM_REQUEST_TYPE,
2026                                      0, (addr + read) / 2, dst + read, 2,
2027                                      WDR_TIMEOUT);
2028                 if (rv < 2) {
2029                         if (rv >= 0)
2030                                 return -EIO;
2031                         else
2032                                 return rv;
2033                 }
2034
2035                 read += rv;
2036         }
2037
2038         return 0;
2039 }
2040
2041 static int ftdi_gpio_init_ft232h(struct usb_serial_port *port)
2042 {
2043         struct ftdi_private *priv = usb_get_serial_port_data(port);
2044         u16 cbus_config;
2045         u8 *buf;
2046         int ret;
2047         int i;
2048
2049         buf = kmalloc(4, GFP_KERNEL);
2050         if (!buf)
2051                 return -ENOMEM;
2052
2053         ret = ftdi_read_eeprom(port->serial, buf, 0x1a, 4);
2054         if (ret < 0)
2055                 goto out_free;
2056
2057         /*
2058          * FT232H CBUS Memory Map
2059          *
2060          * 0x1a: X- (upper nibble -> AC5)
2061          * 0x1b: -X (lower nibble -> AC6)
2062          * 0x1c: XX (upper nibble -> AC9 | lower nibble -> AC8)
2063          */
2064         cbus_config = buf[2] << 8 | (buf[1] & 0xf) << 4 | (buf[0] & 0xf0) >> 4;
2065
2066         priv->gc.ngpio = 4;
2067         priv->gpio_altfunc = 0xff;
2068
2069         for (i = 0; i < priv->gc.ngpio; ++i) {
2070                 if ((cbus_config & 0xf) == FTDI_FTX_CBUS_MUX_GPIO)
2071                         priv->gpio_altfunc &= ~BIT(i);
2072                 cbus_config >>= 4;
2073         }
2074
2075 out_free:
2076         kfree(buf);
2077
2078         return ret;
2079 }
2080
2081 static int ftdi_gpio_init_ft232r(struct usb_serial_port *port)
2082 {
2083         struct ftdi_private *priv = usb_get_serial_port_data(port);
2084         u16 cbus_config;
2085         u8 *buf;
2086         int ret;
2087         int i;
2088
2089         buf = kmalloc(2, GFP_KERNEL);
2090         if (!buf)
2091                 return -ENOMEM;
2092
2093         ret = ftdi_read_eeprom(port->serial, buf, 0x14, 2);
2094         if (ret < 0)
2095                 goto out_free;
2096
2097         cbus_config = le16_to_cpup((__le16 *)buf);
2098         dev_dbg(&port->dev, "cbus_config = 0x%04x\n", cbus_config);
2099
2100         priv->gc.ngpio = 4;
2101
2102         priv->gpio_altfunc = 0xff;
2103         for (i = 0; i < priv->gc.ngpio; ++i) {
2104                 if ((cbus_config & 0xf) == FTDI_FT232R_CBUS_MUX_GPIO)
2105                         priv->gpio_altfunc &= ~BIT(i);
2106                 cbus_config >>= 4;
2107         }
2108 out_free:
2109         kfree(buf);
2110
2111         return ret;
2112 }
2113
2114 static int ftdi_gpio_init_ftx(struct usb_serial_port *port)
2115 {
2116         struct ftdi_private *priv = usb_get_serial_port_data(port);
2117         struct usb_serial *serial = port->serial;
2118         const u16 cbus_cfg_addr = 0x1a;
2119         const u16 cbus_cfg_size = 4;
2120         u8 *cbus_cfg_buf;
2121         int result;
2122         u8 i;
2123
2124         cbus_cfg_buf = kmalloc(cbus_cfg_size, GFP_KERNEL);
2125         if (!cbus_cfg_buf)
2126                 return -ENOMEM;
2127
2128         result = ftdi_read_eeprom(serial, cbus_cfg_buf,
2129                                   cbus_cfg_addr, cbus_cfg_size);
2130         if (result < 0)
2131                 goto out_free;
2132
2133         /* FIXME: FT234XD alone has 1 GPIO, but how to recognize this IC? */
2134         priv->gc.ngpio = 4;
2135
2136         /* Determine which pins are configured for CBUS bitbanging */
2137         priv->gpio_altfunc = 0xff;
2138         for (i = 0; i < priv->gc.ngpio; ++i) {
2139                 if (cbus_cfg_buf[i] == FTDI_FTX_CBUS_MUX_GPIO)
2140                         priv->gpio_altfunc &= ~BIT(i);
2141         }
2142
2143 out_free:
2144         kfree(cbus_cfg_buf);
2145
2146         return result;
2147 }
2148
2149 static int ftdi_gpio_init(struct usb_serial_port *port)
2150 {
2151         struct ftdi_private *priv = usb_get_serial_port_data(port);
2152         struct usb_serial *serial = port->serial;
2153         int result;
2154
2155         switch (priv->chip_type) {
2156         case FT232H:
2157                 result = ftdi_gpio_init_ft232h(port);
2158                 break;
2159         case FT232RL:
2160                 result = ftdi_gpio_init_ft232r(port);
2161                 break;
2162         case FTX:
2163                 result = ftdi_gpio_init_ftx(port);
2164                 break;
2165         default:
2166                 return 0;
2167         }
2168
2169         if (result < 0)
2170                 return result;
2171
2172         mutex_init(&priv->gpio_lock);
2173
2174         priv->gc.label = "ftdi-cbus";
2175         priv->gc.request = ftdi_gpio_request;
2176         priv->gc.get_direction = ftdi_gpio_direction_get;
2177         priv->gc.direction_input = ftdi_gpio_direction_input;
2178         priv->gc.direction_output = ftdi_gpio_direction_output;
2179         priv->gc.init_valid_mask = ftdi_gpio_init_valid_mask;
2180         priv->gc.get = ftdi_gpio_get;
2181         priv->gc.set = ftdi_gpio_set;
2182         priv->gc.get_multiple = ftdi_gpio_get_multiple;
2183         priv->gc.set_multiple = ftdi_gpio_set_multiple;
2184         priv->gc.owner = THIS_MODULE;
2185         priv->gc.parent = &serial->interface->dev;
2186         priv->gc.base = -1;
2187         priv->gc.can_sleep = true;
2188
2189         result = gpiochip_add_data(&priv->gc, port);
2190         if (!result)
2191                 priv->gpio_registered = true;
2192
2193         return result;
2194 }
2195
2196 static void ftdi_gpio_remove(struct usb_serial_port *port)
2197 {
2198         struct ftdi_private *priv = usb_get_serial_port_data(port);
2199
2200         if (priv->gpio_registered) {
2201                 gpiochip_remove(&priv->gc);
2202                 priv->gpio_registered = false;
2203         }
2204
2205         if (priv->gpio_used) {
2206                 /* Exiting CBUS-mode does not reset pin states. */
2207                 ftdi_exit_cbus_mode(port);
2208                 priv->gpio_used = false;
2209         }
2210 }
2211
2212 #else
2213
2214 static int ftdi_gpio_init(struct usb_serial_port *port)
2215 {
2216         return 0;
2217 }
2218
2219 static void ftdi_gpio_remove(struct usb_serial_port *port) { }
2220
2221 #endif  /* CONFIG_GPIOLIB */
2222
2223 /*
2224  * ***************************************************************************
2225  * FTDI driver specific functions
2226  * ***************************************************************************
2227  */
2228
2229 /* Probe function to check for special devices */
2230 static int ftdi_sio_probe(struct usb_serial *serial,
2231                                         const struct usb_device_id *id)
2232 {
2233         const struct ftdi_sio_quirk *quirk =
2234                                 (struct ftdi_sio_quirk *)id->driver_info;
2235
2236         if (quirk && quirk->probe) {
2237                 int ret = quirk->probe(serial);
2238                 if (ret != 0)
2239                         return ret;
2240         }
2241
2242         usb_set_serial_data(serial, (void *)id->driver_info);
2243
2244         return 0;
2245 }
2246
2247 static int ftdi_sio_port_probe(struct usb_serial_port *port)
2248 {
2249         struct ftdi_private *priv;
2250         const struct ftdi_sio_quirk *quirk = usb_get_serial_data(port->serial);
2251         int result;
2252
2253         priv = kzalloc(sizeof(struct ftdi_private), GFP_KERNEL);
2254         if (!priv)
2255                 return -ENOMEM;
2256
2257         mutex_init(&priv->cfg_lock);
2258
2259         if (quirk && quirk->port_probe)
2260                 quirk->port_probe(priv);
2261
2262         usb_set_serial_port_data(port, priv);
2263
2264         ftdi_determine_type(port);
2265         ftdi_set_max_packet_size(port);
2266         if (read_latency_timer(port) < 0)
2267                 priv->latency = 16;
2268         write_latency_timer(port);
2269         create_sysfs_attrs(port);
2270
2271         result = ftdi_gpio_init(port);
2272         if (result < 0) {
2273                 dev_err(&port->serial->interface->dev,
2274                         "GPIO initialisation failed: %d\n",
2275                         result);
2276         }
2277
2278         return 0;
2279 }
2280
2281 /* Setup for the USB-UIRT device, which requires hardwired
2282  * baudrate (38400 gets mapped to 312500) */
2283 /* Called from usbserial:serial_probe */
2284 static void ftdi_USB_UIRT_setup(struct ftdi_private *priv)
2285 {
2286         priv->flags |= ASYNC_SPD_CUST;
2287         priv->custom_divisor = 77;
2288         priv->force_baud = 38400;
2289 }
2290
2291 /* Setup for the HE-TIRA1 device, which requires hardwired
2292  * baudrate (38400 gets mapped to 100000) and RTS-CTS enabled.  */
2293
2294 static void ftdi_HE_TIRA1_setup(struct ftdi_private *priv)
2295 {
2296         priv->flags |= ASYNC_SPD_CUST;
2297         priv->custom_divisor = 240;
2298         priv->force_baud = 38400;
2299         priv->force_rtscts = 1;
2300 }
2301
2302 /*
2303  * Module parameter to control latency timer for NDI FTDI-based USB devices.
2304  * If this value is not set in /etc/modprobe.d/ its value will be set
2305  * to 1ms.
2306  */
2307 static int ndi_latency_timer = 1;
2308
2309 /* Setup for the NDI FTDI-based USB devices, which requires hardwired
2310  * baudrate (19200 gets mapped to 1200000).
2311  *
2312  * Called from usbserial:serial_probe.
2313  */
2314 static int ftdi_NDI_device_setup(struct usb_serial *serial)
2315 {
2316         struct usb_device *udev = serial->dev;
2317         int latency = ndi_latency_timer;
2318
2319         if (latency == 0)
2320                 latency = 1;
2321         if (latency > 99)
2322                 latency = 99;
2323
2324         dev_dbg(&udev->dev, "%s setting NDI device latency to %d\n", __func__, latency);
2325         dev_info(&udev->dev, "NDI device with a latency value of %d\n", latency);
2326
2327         /* FIXME: errors are not returned */
2328         usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2329                                 FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
2330                                 FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
2331                                 latency, 0, NULL, 0, WDR_TIMEOUT);
2332         return 0;
2333 }
2334
2335 /*
2336  * First port on JTAG adaptors such as Olimex arm-usb-ocd or the FIC/OpenMoko
2337  * Neo1973 Debug Board is reserved for JTAG interface and can be accessed from
2338  * userspace using openocd.
2339  */
2340 static int ftdi_jtag_probe(struct usb_serial *serial)
2341 {
2342         struct usb_interface *intf = serial->interface;
2343         int ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
2344
2345         if (ifnum == 0) {
2346                 dev_info(&intf->dev, "Ignoring interface reserved for JTAG\n");
2347                 return -ENODEV;
2348         }
2349
2350         return 0;
2351 }
2352
2353 static int ftdi_8u2232c_probe(struct usb_serial *serial)
2354 {
2355         struct usb_device *udev = serial->dev;
2356
2357         if (udev->manufacturer && !strcmp(udev->manufacturer, "CALAO Systems"))
2358                 return ftdi_jtag_probe(serial);
2359
2360         if (udev->product &&
2361                 (!strcmp(udev->product, "Arrow USB Blaster") ||
2362                  !strcmp(udev->product, "BeagleBone/XDS100V2") ||
2363                  !strcmp(udev->product, "SNAP Connect E10")))
2364                 return ftdi_jtag_probe(serial);
2365
2366         return 0;
2367 }
2368
2369 /*
2370  * First two ports on JTAG adaptors using an FT4232 such as STMicroelectronics's
2371  * ST Micro Connect Lite are reserved for JTAG or other non-UART interfaces and
2372  * can be accessed from userspace.
2373  * The next two ports are enabled as UARTs by default, where port 2 is
2374  * a conventional RS-232 UART.
2375  */
2376 static int ftdi_stmclite_probe(struct usb_serial *serial)
2377 {
2378         struct usb_interface *intf = serial->interface;
2379         int ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
2380
2381         if (ifnum < 2) {
2382                 dev_info(&intf->dev, "Ignoring interface reserved for JTAG\n");
2383                 return -ENODEV;
2384         }
2385
2386         return 0;
2387 }
2388
2389 static void ftdi_sio_port_remove(struct usb_serial_port *port)
2390 {
2391         struct ftdi_private *priv = usb_get_serial_port_data(port);
2392
2393         ftdi_gpio_remove(port);
2394
2395         remove_sysfs_attrs(port);
2396
2397         kfree(priv);
2398 }
2399
2400 static int ftdi_open(struct tty_struct *tty, struct usb_serial_port *port)
2401 {
2402         struct usb_device *dev = port->serial->dev;
2403         struct ftdi_private *priv = usb_get_serial_port_data(port);
2404
2405         /* No error checking for this (will get errors later anyway) */
2406         /* See ftdi_sio.h for description of what is reset */
2407         usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2408                         FTDI_SIO_RESET_REQUEST, FTDI_SIO_RESET_REQUEST_TYPE,
2409                         FTDI_SIO_RESET_SIO,
2410                         priv->interface, NULL, 0, WDR_TIMEOUT);
2411
2412         /* Termios defaults are set by usb_serial_init. We don't change
2413            port->tty->termios - this would lose speed settings, etc.
2414            This is same behaviour as serial.c/rs_open() - Kuba */
2415
2416         /* ftdi_set_termios  will send usb control messages */
2417         if (tty)
2418                 ftdi_set_termios(tty, port, NULL);
2419
2420         return usb_serial_generic_open(tty, port);
2421 }
2422
2423 static void ftdi_dtr_rts(struct usb_serial_port *port, int on)
2424 {
2425         struct ftdi_private *priv = usb_get_serial_port_data(port);
2426
2427         /* Disable flow control */
2428         if (!on) {
2429                 if (usb_control_msg(port->serial->dev,
2430                             usb_sndctrlpipe(port->serial->dev, 0),
2431                             FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2432                             FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2433                             0, priv->interface, NULL, 0,
2434                             WDR_TIMEOUT) < 0) {
2435                         dev_err(&port->dev, "error from flowcontrol urb\n");
2436                 }
2437         }
2438         /* drop RTS and DTR */
2439         if (on)
2440                 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2441         else
2442                 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2443 }
2444
2445 /* The SIO requires the first byte to have:
2446  *  B0 1
2447  *  B1 0
2448  *  B2..7 length of message excluding byte 0
2449  *
2450  * The new devices do not require this byte
2451  */
2452 static int ftdi_prepare_write_buffer(struct usb_serial_port *port,
2453                                                 void *dest, size_t size)
2454 {
2455         struct ftdi_private *priv;
2456         int count;
2457         unsigned long flags;
2458
2459         priv = usb_get_serial_port_data(port);
2460
2461         if (priv->chip_type == SIO) {
2462                 unsigned char *buffer = dest;
2463                 int i, len, c;
2464
2465                 count = 0;
2466                 spin_lock_irqsave(&port->lock, flags);
2467                 for (i = 0; i < size - 1; i += priv->max_packet_size) {
2468                         len = min_t(int, size - i, priv->max_packet_size) - 1;
2469                         c = kfifo_out(&port->write_fifo, &buffer[i + 1], len);
2470                         if (!c)
2471                                 break;
2472                         port->icount.tx += c;
2473                         buffer[i] = (c << 2) + 1;
2474                         count += c + 1;
2475                 }
2476                 spin_unlock_irqrestore(&port->lock, flags);
2477         } else {
2478                 count = kfifo_out_locked(&port->write_fifo, dest, size,
2479                                                                 &port->lock);
2480                 port->icount.tx += count;
2481         }
2482
2483         return count;
2484 }
2485
2486 #define FTDI_RS_ERR_MASK (FTDI_RS_BI | FTDI_RS_PE | FTDI_RS_FE | FTDI_RS_OE)
2487
2488 static int ftdi_process_packet(struct usb_serial_port *port,
2489                 struct ftdi_private *priv, unsigned char *buf, int len)
2490 {
2491         unsigned char status;
2492         bool brkint = false;
2493         int i;
2494         char flag;
2495
2496         if (len < 2) {
2497                 dev_dbg(&port->dev, "malformed packet\n");
2498                 return 0;
2499         }
2500
2501         /* Compare new line status to the old one, signal if different/
2502            N.B. packet may be processed more than once, but differences
2503            are only processed once.  */
2504         status = buf[0] & FTDI_STATUS_B0_MASK;
2505         if (status != priv->prev_status) {
2506                 char diff_status = status ^ priv->prev_status;
2507
2508                 if (diff_status & FTDI_RS0_CTS)
2509                         port->icount.cts++;
2510                 if (diff_status & FTDI_RS0_DSR)
2511                         port->icount.dsr++;
2512                 if (diff_status & FTDI_RS0_RI)
2513                         port->icount.rng++;
2514                 if (diff_status & FTDI_RS0_RLSD) {
2515                         struct tty_struct *tty;
2516
2517                         port->icount.dcd++;
2518                         tty = tty_port_tty_get(&port->port);
2519                         if (tty)
2520                                 usb_serial_handle_dcd_change(port, tty,
2521                                                 status & FTDI_RS0_RLSD);
2522                         tty_kref_put(tty);
2523                 }
2524
2525                 wake_up_interruptible(&port->port.delta_msr_wait);
2526                 priv->prev_status = status;
2527         }
2528
2529         /* save if the transmitter is empty or not */
2530         if (buf[1] & FTDI_RS_TEMT)
2531                 priv->transmit_empty = 1;
2532         else
2533                 priv->transmit_empty = 0;
2534
2535         if (len == 2)
2536                 return 0;       /* status only */
2537
2538         /*
2539          * Break and error status must only be processed for packets with
2540          * data payload to avoid over-reporting.
2541          */
2542         flag = TTY_NORMAL;
2543         if (buf[1] & FTDI_RS_ERR_MASK) {
2544                 /*
2545                  * Break takes precedence over parity, which takes precedence
2546                  * over framing errors. Note that break is only associated
2547                  * with the last character in the buffer and only when it's a
2548                  * NUL.
2549                  */
2550                 if (buf[1] & FTDI_RS_BI && buf[len - 1] == '\0') {
2551                         port->icount.brk++;
2552                         brkint = true;
2553                 }
2554                 if (buf[1] & FTDI_RS_PE) {
2555                         flag = TTY_PARITY;
2556                         port->icount.parity++;
2557                 } else if (buf[1] & FTDI_RS_FE) {
2558                         flag = TTY_FRAME;
2559                         port->icount.frame++;
2560                 }
2561                 /* Overrun is special, not associated with a char */
2562                 if (buf[1] & FTDI_RS_OE) {
2563                         port->icount.overrun++;
2564                         tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
2565                 }
2566         }
2567
2568         port->icount.rx += len - 2;
2569
2570         if (brkint || port->sysrq) {
2571                 for (i = 2; i < len; i++) {
2572                         if (brkint && i == len - 1) {
2573                                 if (usb_serial_handle_break(port))
2574                                         return len - 3;
2575                                 flag = TTY_BREAK;
2576                         }
2577                         if (usb_serial_handle_sysrq_char(port, buf[i]))
2578                                 continue;
2579                         tty_insert_flip_char(&port->port, buf[i], flag);
2580                 }
2581         } else {
2582                 tty_insert_flip_string_fixed_flag(&port->port, buf + 2, flag,
2583                                 len - 2);
2584         }
2585
2586         return len - 2;
2587 }
2588
2589 static void ftdi_process_read_urb(struct urb *urb)
2590 {
2591         struct usb_serial_port *port = urb->context;
2592         struct ftdi_private *priv = usb_get_serial_port_data(port);
2593         char *data = urb->transfer_buffer;
2594         int i;
2595         int len;
2596         int count = 0;
2597
2598         for (i = 0; i < urb->actual_length; i += priv->max_packet_size) {
2599                 len = min_t(int, urb->actual_length - i, priv->max_packet_size);
2600                 count += ftdi_process_packet(port, priv, &data[i], len);
2601         }
2602
2603         if (count)
2604                 tty_flip_buffer_push(&port->port);
2605 }
2606
2607 static void ftdi_break_ctl(struct tty_struct *tty, int break_state)
2608 {
2609         struct usb_serial_port *port = tty->driver_data;
2610         struct ftdi_private *priv = usb_get_serial_port_data(port);
2611         u16 value;
2612
2613         /* break_state = -1 to turn on break, and 0 to turn off break */
2614         /* see drivers/char/tty_io.c to see it used */
2615         /* last_set_data_value NEVER has the break bit set in it */
2616
2617         if (break_state)
2618                 value = priv->last_set_data_value | FTDI_SIO_SET_BREAK;
2619         else
2620                 value = priv->last_set_data_value;
2621
2622         if (usb_control_msg(port->serial->dev,
2623                         usb_sndctrlpipe(port->serial->dev, 0),
2624                         FTDI_SIO_SET_DATA_REQUEST,
2625                         FTDI_SIO_SET_DATA_REQUEST_TYPE,
2626                         value , priv->interface,
2627                         NULL, 0, WDR_TIMEOUT) < 0) {
2628                 dev_err(&port->dev, "%s FAILED to enable/disable break state (state was %d)\n",
2629                         __func__, break_state);
2630         }
2631
2632         dev_dbg(&port->dev, "%s break state is %d - urb is %d\n", __func__,
2633                 break_state, value);
2634
2635 }
2636
2637 static bool ftdi_tx_empty(struct usb_serial_port *port)
2638 {
2639         unsigned char buf[2];
2640         int ret;
2641
2642         ret = ftdi_get_modem_status(port, buf);
2643         if (ret == 2) {
2644                 if (!(buf[1] & FTDI_RS_TEMT))
2645                         return false;
2646         }
2647
2648         return true;
2649 }
2650
2651 /* old_termios contains the original termios settings and tty->termios contains
2652  * the new setting to be used
2653  * WARNING: set_termios calls this with old_termios in kernel space
2654  */
2655 static void ftdi_set_termios(struct tty_struct *tty,
2656                 struct usb_serial_port *port, struct ktermios *old_termios)
2657 {
2658         struct usb_device *dev = port->serial->dev;
2659         struct device *ddev = &port->dev;
2660         struct ftdi_private *priv = usb_get_serial_port_data(port);
2661         struct ktermios *termios = &tty->termios;
2662         unsigned int cflag = termios->c_cflag;
2663         u16 value, index;
2664         int ret;
2665
2666         /* Force baud rate if this device requires it, unless it is set to
2667            B0. */
2668         if (priv->force_baud && ((termios->c_cflag & CBAUD) != B0)) {
2669                 dev_dbg(ddev, "%s: forcing baud rate for this device\n", __func__);
2670                 tty_encode_baud_rate(tty, priv->force_baud,
2671                                         priv->force_baud);
2672         }
2673
2674         /* Force RTS-CTS if this device requires it. */
2675         if (priv->force_rtscts) {
2676                 dev_dbg(ddev, "%s: forcing rtscts for this device\n", __func__);
2677                 termios->c_cflag |= CRTSCTS;
2678         }
2679
2680         /*
2681          * All FTDI UART chips are limited to CS7/8. We shouldn't pretend to
2682          * support CS5/6 and revert the CSIZE setting instead.
2683          *
2684          * CS5 however is used to control some smartcard readers which abuse
2685          * this limitation to switch modes. Original FTDI chips fall back to
2686          * eight data bits.
2687          *
2688          * TODO: Implement a quirk to only allow this with mentioned
2689          *       readers. One I know of (Argolis Smartreader V1)
2690          *       returns "USB smartcard server" as iInterface string.
2691          *       The vendor didn't bother with a custom VID/PID of
2692          *       course.
2693          */
2694         if (C_CSIZE(tty) == CS6) {
2695                 dev_warn(ddev, "requested CSIZE setting not supported\n");
2696
2697                 termios->c_cflag &= ~CSIZE;
2698                 if (old_termios)
2699                         termios->c_cflag |= old_termios->c_cflag & CSIZE;
2700                 else
2701                         termios->c_cflag |= CS8;
2702         }
2703
2704         cflag = termios->c_cflag;
2705
2706         if (!old_termios)
2707                 goto no_skip;
2708
2709         if (old_termios->c_cflag == termios->c_cflag
2710             && old_termios->c_ispeed == termios->c_ispeed
2711             && old_termios->c_ospeed == termios->c_ospeed)
2712                 goto no_c_cflag_changes;
2713
2714         /* NOTE These routines can get interrupted by
2715            ftdi_sio_read_bulk_callback  - need to examine what this means -
2716            don't see any problems yet */
2717
2718         if ((old_termios->c_cflag & (CSIZE|PARODD|PARENB|CMSPAR|CSTOPB)) ==
2719             (termios->c_cflag & (CSIZE|PARODD|PARENB|CMSPAR|CSTOPB)))
2720                 goto no_data_parity_stop_changes;
2721
2722 no_skip:
2723         /* Set number of data bits, parity, stop bits */
2724
2725         value = 0;
2726         value |= (cflag & CSTOPB ? FTDI_SIO_SET_DATA_STOP_BITS_2 :
2727                         FTDI_SIO_SET_DATA_STOP_BITS_1);
2728         if (cflag & PARENB) {
2729                 if (cflag & CMSPAR)
2730                         value |= cflag & PARODD ?
2731                                         FTDI_SIO_SET_DATA_PARITY_MARK :
2732                                         FTDI_SIO_SET_DATA_PARITY_SPACE;
2733                 else
2734                         value |= cflag & PARODD ?
2735                                         FTDI_SIO_SET_DATA_PARITY_ODD :
2736                                         FTDI_SIO_SET_DATA_PARITY_EVEN;
2737         } else {
2738                 value |= FTDI_SIO_SET_DATA_PARITY_NONE;
2739         }
2740         switch (cflag & CSIZE) {
2741         case CS5:
2742                 dev_dbg(ddev, "Setting CS5 quirk\n");
2743                 break;
2744         case CS7:
2745                 value |= 7;
2746                 dev_dbg(ddev, "Setting CS7\n");
2747                 break;
2748         default:
2749         case CS8:
2750                 value |= 8;
2751                 dev_dbg(ddev, "Setting CS8\n");
2752                 break;
2753         }
2754
2755         /* This is needed by the break command since it uses the same command
2756            - but is or'ed with this value  */
2757         priv->last_set_data_value = value;
2758
2759         if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2760                             FTDI_SIO_SET_DATA_REQUEST,
2761                             FTDI_SIO_SET_DATA_REQUEST_TYPE,
2762                             value , priv->interface,
2763                             NULL, 0, WDR_SHORT_TIMEOUT) < 0) {
2764                 dev_err(ddev, "%s FAILED to set databits/stopbits/parity\n",
2765                         __func__);
2766         }
2767
2768         /* Now do the baudrate */
2769 no_data_parity_stop_changes:
2770         if ((cflag & CBAUD) == B0) {
2771                 /* Disable flow control */
2772                 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2773                                     FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2774                                     FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2775                                     0, priv->interface,
2776                                     NULL, 0, WDR_TIMEOUT) < 0) {
2777                         dev_err(ddev, "%s error from disable flowcontrol urb\n",
2778                                 __func__);
2779                 }
2780                 /* Drop RTS and DTR */
2781                 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2782         } else {
2783                 /* set the baudrate determined before */
2784                 mutex_lock(&priv->cfg_lock);
2785                 if (change_speed(tty, port))
2786                         dev_err(ddev, "%s urb failed to set baudrate\n", __func__);
2787                 mutex_unlock(&priv->cfg_lock);
2788                 /* Ensure RTS and DTR are raised when baudrate changed from 0 */
2789                 if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
2790                         set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2791         }
2792
2793 no_c_cflag_changes:
2794         /* Set hardware-assisted flow control */
2795         value = 0;
2796
2797         if (C_CRTSCTS(tty)) {
2798                 dev_dbg(&port->dev, "enabling rts/cts flow control\n");
2799                 index = FTDI_SIO_RTS_CTS_HS;
2800         } else if (I_IXON(tty)) {
2801                 dev_dbg(&port->dev, "enabling xon/xoff flow control\n");
2802                 index = FTDI_SIO_XON_XOFF_HS;
2803                 value = STOP_CHAR(tty) << 8 | START_CHAR(tty);
2804         } else {
2805                 dev_dbg(&port->dev, "disabling flow control\n");
2806                 index = FTDI_SIO_DISABLE_FLOW_CTRL;
2807         }
2808
2809         index |= priv->interface;
2810
2811         ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2812                         FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2813                         FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2814                         value, index, NULL, 0, WDR_TIMEOUT);
2815         if (ret < 0)
2816                 dev_err(&port->dev, "failed to set flow control: %d\n", ret);
2817 }
2818
2819 /*
2820  * Get modem-control status.
2821  *
2822  * Returns the number of status bytes retrieved (device dependant), or
2823  * negative error code.
2824  */
2825 static int ftdi_get_modem_status(struct usb_serial_port *port,
2826                                                 unsigned char status[2])
2827 {
2828         struct ftdi_private *priv = usb_get_serial_port_data(port);
2829         unsigned char *buf;
2830         int len;
2831         int ret;
2832
2833         buf = kmalloc(2, GFP_KERNEL);
2834         if (!buf)
2835                 return -ENOMEM;
2836         /*
2837          * The 8U232AM returns a two byte value (the SIO a 1 byte value) in
2838          * the same format as the data returned from the in point.
2839          */
2840         switch (priv->chip_type) {
2841         case SIO:
2842                 len = 1;
2843                 break;
2844         case FT8U232AM:
2845         case FT232BM:
2846         case FT2232C:
2847         case FT232RL:
2848         case FT2232H:
2849         case FT4232H:
2850         case FT232H:
2851         case FTX:
2852                 len = 2;
2853                 break;
2854         default:
2855                 ret = -EFAULT;
2856                 goto out;
2857         }
2858
2859         ret = usb_control_msg(port->serial->dev,
2860                         usb_rcvctrlpipe(port->serial->dev, 0),
2861                         FTDI_SIO_GET_MODEM_STATUS_REQUEST,
2862                         FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
2863                         0, priv->interface,
2864                         buf, len, WDR_TIMEOUT);
2865
2866         /* NOTE: We allow short responses and handle that below. */
2867         if (ret < 1) {
2868                 dev_err(&port->dev, "failed to get modem status: %d\n", ret);
2869                 if (ret >= 0)
2870                         ret = -EIO;
2871                 ret = usb_translate_errors(ret);
2872                 goto out;
2873         }
2874
2875         status[0] = buf[0];
2876         if (ret > 1)
2877                 status[1] = buf[1];
2878         else
2879                 status[1] = 0;
2880
2881         dev_dbg(&port->dev, "%s - 0x%02x%02x\n", __func__, status[0],
2882                                                                 status[1]);
2883 out:
2884         kfree(buf);
2885
2886         return ret;
2887 }
2888
2889 static int ftdi_tiocmget(struct tty_struct *tty)
2890 {
2891         struct usb_serial_port *port = tty->driver_data;
2892         struct ftdi_private *priv = usb_get_serial_port_data(port);
2893         unsigned char buf[2];
2894         int ret;
2895
2896         ret = ftdi_get_modem_status(port, buf);
2897         if (ret < 0)
2898                 return ret;
2899
2900         ret =   (buf[0] & FTDI_SIO_DSR_MASK  ? TIOCM_DSR : 0) |
2901                 (buf[0] & FTDI_SIO_CTS_MASK  ? TIOCM_CTS : 0) |
2902                 (buf[0] & FTDI_SIO_RI_MASK   ? TIOCM_RI  : 0) |
2903                 (buf[0] & FTDI_SIO_RLSD_MASK ? TIOCM_CD  : 0) |
2904                 priv->last_dtr_rts;
2905
2906         return ret;
2907 }
2908
2909 static int ftdi_tiocmset(struct tty_struct *tty,
2910                         unsigned int set, unsigned int clear)
2911 {
2912         struct usb_serial_port *port = tty->driver_data;
2913
2914         return update_mctrl(port, set, clear);
2915 }
2916
2917 static int ftdi_ioctl(struct tty_struct *tty,
2918                                         unsigned int cmd, unsigned long arg)
2919 {
2920         struct usb_serial_port *port = tty->driver_data;
2921         void __user *argp = (void __user *)arg;
2922
2923         switch (cmd) {
2924         case TIOCSERGETLSR:
2925                 return get_lsr_info(port, argp);
2926         default:
2927                 break;
2928         }
2929
2930         return -ENOIOCTLCMD;
2931 }
2932
2933 module_usb_serial_driver(serial_drivers, id_table_combined);
2934
2935 MODULE_AUTHOR(DRIVER_AUTHOR);
2936 MODULE_DESCRIPTION(DRIVER_DESC);
2937 MODULE_LICENSE("GPL");
2938
2939 module_param(ndi_latency_timer, int, S_IRUGO | S_IWUSR);
2940 MODULE_PARM_DESC(ndi_latency_timer, "NDI device latency timer override");