USB: serial: ftdi_sio: add support for TIOCSERGETLSR
[linux-flexiantxendom0.git] / drivers / usb / serial / ftdi_sio.c
1 /*
2  * USB FTDI SIO driver
3  *
4  *      Copyright (C) 2009 - 2010
5  *          Johan Hovold (jhovold@gmail.com)
6  *      Copyright (C) 1999 - 2001
7  *          Greg Kroah-Hartman (greg@kroah.com)
8  *          Bill Ryder (bryder@sgi.com)
9  *      Copyright (C) 2002
10  *          Kuba Ober (kuba@mareimbrium.org)
11  *
12  *      This program is free software; you can redistribute it and/or modify
13  *      it under the terms of the GNU General Public License as published by
14  *      the Free Software Foundation; either version 2 of the License, or
15  *      (at your option) any later version.
16  *
17  * See Documentation/usb/usb-serial.txt for more information on using this
18  * driver
19  *
20  * See http://ftdi-usb-sio.sourceforge.net for upto date testing info
21  *      and extra documentation
22  *
23  * Change entries from 2004 and earlier can be found in versions of this
24  * file in kernel versions prior to the 2.6.24 release.
25  *
26  */
27
28 /* Bill Ryder - bryder@sgi.com - wrote the FTDI_SIO implementation */
29 /* Thanx to FTDI for so kindly providing details of the protocol required */
30 /*   to talk to the device */
31 /* Thanx to gkh and the rest of the usb dev group for all code I have
32    assimilated :-) */
33
34 #include <linux/kernel.h>
35 #include <linux/errno.h>
36 #include <linux/init.h>
37 #include <linux/slab.h>
38 #include <linux/tty.h>
39 #include <linux/tty_driver.h>
40 #include <linux/tty_flip.h>
41 #include <linux/module.h>
42 #include <linux/spinlock.h>
43 #include <linux/mutex.h>
44 #include <linux/uaccess.h>
45 #include <linux/usb.h>
46 #include <linux/serial.h>
47 #include <linux/usb/serial.h>
48 #include "ftdi_sio.h"
49 #include "ftdi_sio_ids.h"
50
51 /*
52  * Version Information
53  */
54 #define DRIVER_VERSION "v1.6.0"
55 #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>"
56 #define DRIVER_DESC "USB FTDI Serial Converters Driver"
57
58 static int debug;
59 static __u16 vendor = FTDI_VID;
60 static __u16 product;
61
62 struct ftdi_private {
63         struct kref kref;
64         enum ftdi_chip_type chip_type;
65                                 /* type of device, either SIO or FT8U232AM */
66         int baud_base;          /* baud base clock for divisor setting */
67         int custom_divisor;     /* custom_divisor kludge, this is for
68                                    baud_base (different from what goes to the
69                                    chip!) */
70         __u16 last_set_data_urb_value ;
71                                 /* the last data state set - needed for doing
72                                  * a break
73                                  */
74         int flags;              /* some ASYNC_xxxx flags are supported */
75         unsigned long last_dtr_rts;     /* saved modem control outputs */
76         wait_queue_head_t delta_msr_wait; /* Used for TIOCMIWAIT */
77         char prev_status, diff_status;        /* Used for TIOCMIWAIT */
78         char transmit_empty;    /* If transmitter is empty or not */
79         struct usb_serial_port *port;
80         __u16 interface;        /* FT2232C, FT2232H or FT4232H port interface
81                                    (0 for FT232/245) */
82
83         speed_t force_baud;     /* if non-zero, force the baud rate to
84                                    this value */
85         int force_rtscts;       /* if non-zero, force RTS-CTS to always
86                                    be enabled */
87
88         unsigned int latency;           /* latency setting in use */
89         unsigned short max_packet_size;
90         struct mutex cfg_lock; /* Avoid mess by parallel calls of config ioctl() and change_speed() */
91 };
92
93 /* struct ftdi_sio_quirk is used by devices requiring special attention. */
94 struct ftdi_sio_quirk {
95         int (*probe)(struct usb_serial *);
96         /* Special settings for probed ports. */
97         void (*port_probe)(struct ftdi_private *);
98 };
99
100 static int   ftdi_jtag_probe(struct usb_serial *serial);
101 static int   ftdi_mtxorb_hack_setup(struct usb_serial *serial);
102 static int   ftdi_NDI_device_setup(struct usb_serial *serial);
103 static void  ftdi_USB_UIRT_setup(struct ftdi_private *priv);
104 static void  ftdi_HE_TIRA1_setup(struct ftdi_private *priv);
105
106 static struct ftdi_sio_quirk ftdi_jtag_quirk = {
107         .probe  = ftdi_jtag_probe,
108 };
109
110 static struct ftdi_sio_quirk ftdi_mtxorb_hack_quirk = {
111         .probe  = ftdi_mtxorb_hack_setup,
112 };
113
114 static struct ftdi_sio_quirk ftdi_NDI_device_quirk = {
115         .probe  = ftdi_NDI_device_setup,
116 };
117
118 static struct ftdi_sio_quirk ftdi_USB_UIRT_quirk = {
119         .port_probe = ftdi_USB_UIRT_setup,
120 };
121
122 static struct ftdi_sio_quirk ftdi_HE_TIRA1_quirk = {
123         .port_probe = ftdi_HE_TIRA1_setup,
124 };
125
126 /*
127  * The 8U232AM has the same API as the sio except for:
128  * - it can support MUCH higher baudrates; up to:
129  *   o 921600 for RS232 and 2000000 for RS422/485 at 48MHz
130  *   o 230400 at 12MHz
131  *   so .. 8U232AM's baudrate setting codes are different
132  * - it has a two byte status code.
133  * - it returns characters every 16ms (the FTDI does it every 40ms)
134  *
135  * the bcdDevice value is used to differentiate FT232BM and FT245BM from
136  * the earlier FT8U232AM and FT8U232BM.  For now, include all known VID/PID
137  * combinations in both tables.
138  * FIXME: perhaps bcdDevice can also identify 12MHz FT8U232AM devices,
139  * but I don't know if those ever went into mass production. [Ian Abbott]
140  */
141
142
143
144 /*
145  * Device ID not listed? Test via module params product/vendor or
146  * /sys/bus/usb/ftdi_sio/new_id, then send patch/report!
147  */
148 static struct usb_device_id id_table_combined [] = {
149         { USB_DEVICE(FTDI_VID, FTDI_AMC232_PID) },
150         { USB_DEVICE(FTDI_VID, FTDI_CANUSB_PID) },
151         { USB_DEVICE(FTDI_VID, FTDI_CANDAPTER_PID) },
152         { USB_DEVICE(FTDI_VID, FTDI_NXTCAM_PID) },
153         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_0_PID) },
154         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_1_PID) },
155         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_2_PID) },
156         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_3_PID) },
157         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_4_PID) },
158         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_5_PID) },
159         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_6_PID) },
160         { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_7_PID) },
161         { USB_DEVICE(FTDI_VID, FTDI_USINT_CAT_PID) },
162         { USB_DEVICE(FTDI_VID, FTDI_USINT_WKEY_PID) },
163         { USB_DEVICE(FTDI_VID, FTDI_USINT_RS232_PID) },
164         { USB_DEVICE(FTDI_VID, FTDI_ACTZWAVE_PID) },
165         { USB_DEVICE(FTDI_VID, FTDI_IRTRANS_PID) },
166         { USB_DEVICE(FTDI_VID, FTDI_IPLUS_PID) },
167         { USB_DEVICE(FTDI_VID, FTDI_IPLUS2_PID) },
168         { USB_DEVICE(FTDI_VID, FTDI_DMX4ALL) },
169         { USB_DEVICE(FTDI_VID, FTDI_SIO_PID) },
170         { USB_DEVICE(FTDI_VID, FTDI_8U232AM_PID) },
171         { USB_DEVICE(FTDI_VID, FTDI_8U232AM_ALT_PID) },
172         { USB_DEVICE(FTDI_VID, FTDI_232RL_PID) },
173         { USB_DEVICE(FTDI_VID, FTDI_8U2232C_PID) },
174         { USB_DEVICE(FTDI_VID, FTDI_4232H_PID) },
175         { USB_DEVICE(FTDI_VID, FTDI_MICRO_CHAMELEON_PID) },
176         { USB_DEVICE(FTDI_VID, FTDI_RELAIS_PID) },
177         { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_PID) },
178         { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_SNIFFER_PID) },
179         { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_THROTTLE_PID) },
180         { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_GATEWAY_PID) },
181         { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_GBM_PID) },
182         { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_IOBOARD_PID) },
183         { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_MINI_IOBOARD_PID) },
184         { USB_DEVICE(FTDI_VID, FTDI_SPROG_II) },
185         { USB_DEVICE(FTDI_VID, FTDI_LENZ_LIUSB_PID) },
186         { USB_DEVICE(FTDI_VID, FTDI_XF_632_PID) },
187         { USB_DEVICE(FTDI_VID, FTDI_XF_634_PID) },
188         { USB_DEVICE(FTDI_VID, FTDI_XF_547_PID) },
189         { USB_DEVICE(FTDI_VID, FTDI_XF_633_PID) },
190         { USB_DEVICE(FTDI_VID, FTDI_XF_631_PID) },
191         { USB_DEVICE(FTDI_VID, FTDI_XF_635_PID) },
192         { USB_DEVICE(FTDI_VID, FTDI_XF_640_PID) },
193         { USB_DEVICE(FTDI_VID, FTDI_XF_642_PID) },
194         { USB_DEVICE(FTDI_VID, FTDI_DSS20_PID) },
195         { USB_DEVICE(FTDI_NF_RIC_VID, FTDI_NF_RIC_PID) },
196         { USB_DEVICE(FTDI_VID, FTDI_VNHCPCUSB_D_PID) },
197         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_0_PID) },
198         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_1_PID) },
199         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_2_PID) },
200         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_3_PID) },
201         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_4_PID) },
202         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_5_PID) },
203         { USB_DEVICE(FTDI_VID, FTDI_MTXORB_6_PID) },
204         { USB_DEVICE(FTDI_VID, FTDI_R2000KU_TRUE_RNG) },
205         { USB_DEVICE(FTDI_VID, FTDI_VARDAAN_PID) },
206         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0100_PID) },
207         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0101_PID) },
208         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0102_PID) },
209         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0103_PID) },
210         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0104_PID) },
211         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0105_PID) },
212         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0106_PID) },
213         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0107_PID) },
214         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0108_PID) },
215         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0109_PID) },
216         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010A_PID) },
217         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010B_PID) },
218         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010C_PID) },
219         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010D_PID) },
220         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010E_PID) },
221         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010F_PID) },
222         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0110_PID) },
223         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0111_PID) },
224         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0112_PID) },
225         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0113_PID) },
226         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0114_PID) },
227         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0115_PID) },
228         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0116_PID) },
229         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0117_PID) },
230         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0118_PID) },
231         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0119_PID) },
232         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011A_PID) },
233         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011B_PID) },
234         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011C_PID) },
235         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011D_PID) },
236         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011E_PID) },
237         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011F_PID) },
238         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0120_PID) },
239         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0121_PID) },
240         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0122_PID) },
241         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0123_PID) },
242         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0124_PID) },
243         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0125_PID) },
244         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0126_PID) },
245         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0127_PID),
246                 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
247         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0128_PID) },
248         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0129_PID) },
249         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012A_PID) },
250         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012B_PID) },
251         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012C_PID),
252                 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
253         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012D_PID) },
254         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012E_PID) },
255         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012F_PID) },
256         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0130_PID) },
257         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0131_PID) },
258         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0132_PID) },
259         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0133_PID) },
260         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0134_PID) },
261         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0135_PID) },
262         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0136_PID) },
263         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0137_PID) },
264         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0138_PID) },
265         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0139_PID) },
266         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013A_PID) },
267         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013B_PID) },
268         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013C_PID) },
269         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013D_PID) },
270         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013E_PID) },
271         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013F_PID) },
272         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0140_PID) },
273         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0141_PID) },
274         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0142_PID) },
275         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0143_PID) },
276         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0144_PID) },
277         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0145_PID) },
278         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0146_PID) },
279         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0147_PID) },
280         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0148_PID) },
281         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0149_PID) },
282         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014A_PID) },
283         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014B_PID) },
284         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014C_PID) },
285         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014D_PID) },
286         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014E_PID) },
287         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014F_PID) },
288         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0150_PID) },
289         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0151_PID) },
290         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0152_PID) },
291         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0153_PID),
292                 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
293         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0154_PID),
294                 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
295         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0155_PID),
296                 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
297         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0156_PID),
298                 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
299         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0157_PID),
300                 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
301         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0158_PID),
302                 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
303         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0159_PID) },
304         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015A_PID) },
305         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015B_PID) },
306         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015C_PID) },
307         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015D_PID) },
308         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015E_PID) },
309         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015F_PID) },
310         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0160_PID) },
311         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0161_PID) },
312         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0162_PID) },
313         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0163_PID) },
314         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0164_PID) },
315         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0165_PID) },
316         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0166_PID) },
317         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0167_PID) },
318         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0168_PID) },
319         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0169_PID) },
320         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016A_PID) },
321         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016B_PID) },
322         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016C_PID) },
323         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016D_PID) },
324         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016E_PID) },
325         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016F_PID) },
326         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0170_PID) },
327         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0171_PID) },
328         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0172_PID) },
329         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0173_PID) },
330         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0174_PID) },
331         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0175_PID) },
332         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0176_PID) },
333         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0177_PID) },
334         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0178_PID) },
335         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0179_PID) },
336         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017A_PID) },
337         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017B_PID) },
338         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017C_PID) },
339         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017D_PID) },
340         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017E_PID) },
341         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017F_PID) },
342         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0180_PID) },
343         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0181_PID) },
344         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0182_PID) },
345         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0183_PID) },
346         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0184_PID) },
347         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0185_PID) },
348         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0186_PID) },
349         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0187_PID) },
350         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0188_PID) },
351         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0189_PID) },
352         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018A_PID) },
353         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018B_PID) },
354         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018C_PID) },
355         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018D_PID) },
356         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018E_PID) },
357         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018F_PID) },
358         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0190_PID) },
359         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0191_PID) },
360         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0192_PID) },
361         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0193_PID) },
362         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0194_PID) },
363         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0195_PID) },
364         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0196_PID) },
365         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0197_PID) },
366         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0198_PID) },
367         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0199_PID) },
368         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019A_PID) },
369         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019B_PID) },
370         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019C_PID) },
371         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019D_PID) },
372         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019E_PID) },
373         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019F_PID) },
374         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A0_PID) },
375         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A1_PID) },
376         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A2_PID) },
377         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A3_PID) },
378         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A4_PID) },
379         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A5_PID) },
380         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A6_PID) },
381         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A7_PID) },
382         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A8_PID) },
383         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A9_PID) },
384         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AA_PID) },
385         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AB_PID) },
386         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AC_PID) },
387         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AD_PID) },
388         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AE_PID) },
389         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AF_PID) },
390         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B0_PID) },
391         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B1_PID) },
392         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B2_PID) },
393         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B3_PID) },
394         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B4_PID) },
395         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B5_PID) },
396         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B6_PID) },
397         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B7_PID) },
398         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B8_PID) },
399         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B9_PID) },
400         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BA_PID) },
401         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BB_PID) },
402         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BC_PID) },
403         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BD_PID) },
404         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BE_PID) },
405         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BF_PID) },
406         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C0_PID) },
407         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C1_PID) },
408         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C2_PID) },
409         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C3_PID) },
410         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C4_PID) },
411         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C5_PID) },
412         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C6_PID) },
413         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C7_PID) },
414         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C8_PID) },
415         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C9_PID) },
416         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CA_PID) },
417         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CB_PID) },
418         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CC_PID) },
419         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CD_PID) },
420         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CE_PID) },
421         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CF_PID) },
422         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D0_PID) },
423         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D1_PID) },
424         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D2_PID) },
425         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D3_PID) },
426         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D4_PID) },
427         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D5_PID) },
428         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D6_PID) },
429         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D7_PID) },
430         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D8_PID) },
431         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D9_PID) },
432         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DA_PID) },
433         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DB_PID) },
434         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DC_PID) },
435         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DD_PID) },
436         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DE_PID) },
437         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DF_PID) },
438         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E0_PID) },
439         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E1_PID) },
440         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E2_PID) },
441         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E3_PID) },
442         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E4_PID) },
443         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E5_PID) },
444         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E6_PID) },
445         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E7_PID) },
446         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E8_PID) },
447         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E9_PID) },
448         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EA_PID) },
449         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EB_PID) },
450         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EC_PID) },
451         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01ED_PID) },
452         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EE_PID) },
453         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EF_PID) },
454         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F0_PID) },
455         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F1_PID) },
456         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F2_PID) },
457         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F3_PID) },
458         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F4_PID) },
459         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F5_PID) },
460         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F6_PID) },
461         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F7_PID) },
462         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F8_PID) },
463         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F9_PID) },
464         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FA_PID) },
465         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FB_PID) },
466         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FC_PID) },
467         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FD_PID) },
468         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FE_PID) },
469         { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FF_PID) },
470         { USB_DEVICE(FTDI_VID, FTDI_PERLE_ULTRAPORT_PID) },
471         { USB_DEVICE(FTDI_VID, FTDI_PIEGROUP_PID) },
472         { USB_DEVICE(FTDI_VID, FTDI_TNC_X_PID) },
473         { USB_DEVICE(FTDI_VID, FTDI_USBX_707_PID) },
474         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2101_PID) },
475         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2102_PID) },
476         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2103_PID) },
477         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2104_PID) },
478         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2106_PID) },
479         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_1_PID) },
480         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_2_PID) },
481         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_1_PID) },
482         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_2_PID) },
483         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_1_PID) },
484         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_2_PID) },
485         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_1_PID) },
486         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_2_PID) },
487         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_3_PID) },
488         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_4_PID) },
489         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_1_PID) },
490         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_2_PID) },
491         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_3_PID) },
492         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_4_PID) },
493         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_1_PID) },
494         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_2_PID) },
495         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_3_PID) },
496         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_4_PID) },
497         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_1_PID) },
498         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_2_PID) },
499         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_3_PID) },
500         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_4_PID) },
501         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_5_PID) },
502         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_6_PID) },
503         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_7_PID) },
504         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_8_PID) },
505         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_1_PID) },
506         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_2_PID) },
507         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_3_PID) },
508         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_4_PID) },
509         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_5_PID) },
510         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_6_PID) },
511         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_7_PID) },
512         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_8_PID) },
513         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_1_PID) },
514         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_2_PID) },
515         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_3_PID) },
516         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_4_PID) },
517         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_5_PID) },
518         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_6_PID) },
519         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_7_PID) },
520         { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_8_PID) },
521         { USB_DEVICE(IDTECH_VID, IDTECH_IDT1221U_PID) },
522         { USB_DEVICE(OCT_VID, OCT_US101_PID) },
523         { USB_DEVICE(FTDI_VID, FTDI_HE_TIRA1_PID),
524                 .driver_info = (kernel_ulong_t)&ftdi_HE_TIRA1_quirk },
525         { USB_DEVICE(FTDI_VID, FTDI_USB_UIRT_PID),
526                 .driver_info = (kernel_ulong_t)&ftdi_USB_UIRT_quirk },
527         { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_1) },
528         { USB_DEVICE(FTDI_VID, PROTEGO_R2X0) },
529         { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_3) },
530         { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_4) },
531         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E808_PID) },
532         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E809_PID) },
533         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80A_PID) },
534         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80B_PID) },
535         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80C_PID) },
536         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80D_PID) },
537         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80E_PID) },
538         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80F_PID) },
539         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E888_PID) },
540         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E889_PID) },
541         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88A_PID) },
542         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88B_PID) },
543         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88C_PID) },
544         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88D_PID) },
545         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88E_PID) },
546         { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88F_PID) },
547         { USB_DEVICE(FTDI_VID, FTDI_ELV_UO100_PID) },
548         { USB_DEVICE(FTDI_VID, FTDI_ELV_UM100_PID) },
549         { USB_DEVICE(FTDI_VID, FTDI_ELV_UR100_PID) },
550         { USB_DEVICE(FTDI_VID, FTDI_ELV_ALC8500_PID) },
551         { USB_DEVICE(FTDI_VID, FTDI_PYRAMID_PID) },
552         { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1000PC_PID) },
553         { USB_DEVICE(FTDI_VID, FTDI_IBS_US485_PID) },
554         { USB_DEVICE(FTDI_VID, FTDI_IBS_PICPRO_PID) },
555         { USB_DEVICE(FTDI_VID, FTDI_IBS_PCMCIA_PID) },
556         { USB_DEVICE(FTDI_VID, FTDI_IBS_PK1_PID) },
557         { USB_DEVICE(FTDI_VID, FTDI_IBS_RS232MON_PID) },
558         { USB_DEVICE(FTDI_VID, FTDI_IBS_APP70_PID) },
559         { USB_DEVICE(FTDI_VID, FTDI_IBS_PEDO_PID) },
560         { USB_DEVICE(FTDI_VID, FTDI_IBS_PROD_PID) },
561         /*
562          * ELV devices:
563          */
564         { USB_DEVICE(FTDI_VID, FTDI_ELV_USR_PID) },
565         { USB_DEVICE(FTDI_VID, FTDI_ELV_MSM1_PID) },
566         { USB_DEVICE(FTDI_VID, FTDI_ELV_KL100_PID) },
567         { USB_DEVICE(FTDI_VID, FTDI_ELV_WS550_PID) },
568         { USB_DEVICE(FTDI_VID, FTDI_ELV_EC3000_PID) },
569         { USB_DEVICE(FTDI_VID, FTDI_ELV_WS888_PID) },
570         { USB_DEVICE(FTDI_VID, FTDI_ELV_TWS550_PID) },
571         { USB_DEVICE(FTDI_VID, FTDI_ELV_FEM_PID) },
572         { USB_DEVICE(FTDI_VID, FTDI_ELV_CLI7000_PID) },
573         { USB_DEVICE(FTDI_VID, FTDI_ELV_PPS7330_PID) },
574         { USB_DEVICE(FTDI_VID, FTDI_ELV_TFM100_PID) },
575         { USB_DEVICE(FTDI_VID, FTDI_ELV_UDF77_PID) },
576         { USB_DEVICE(FTDI_VID, FTDI_ELV_UIO88_PID) },
577         { USB_DEVICE(FTDI_VID, FTDI_ELV_UAD8_PID) },
578         { USB_DEVICE(FTDI_VID, FTDI_ELV_UDA7_PID) },
579         { USB_DEVICE(FTDI_VID, FTDI_ELV_USI2_PID) },
580         { USB_DEVICE(FTDI_VID, FTDI_ELV_T1100_PID) },
581         { USB_DEVICE(FTDI_VID, FTDI_ELV_PCD200_PID) },
582         { USB_DEVICE(FTDI_VID, FTDI_ELV_ULA200_PID) },
583         { USB_DEVICE(FTDI_VID, FTDI_ELV_CSI8_PID) },
584         { USB_DEVICE(FTDI_VID, FTDI_ELV_EM1000DL_PID) },
585         { USB_DEVICE(FTDI_VID, FTDI_ELV_PCK100_PID) },
586         { USB_DEVICE(FTDI_VID, FTDI_ELV_RFP500_PID) },
587         { USB_DEVICE(FTDI_VID, FTDI_ELV_FS20SIG_PID) },
588         { USB_DEVICE(FTDI_VID, FTDI_ELV_UTP8_PID) },
589         { USB_DEVICE(FTDI_VID, FTDI_ELV_WS300PC_PID) },
590         { USB_DEVICE(FTDI_VID, FTDI_ELV_WS444PC_PID) },
591         { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1300PC_PID) },
592         { USB_DEVICE(FTDI_VID, FTDI_ELV_EM1010PC_PID) },
593         { USB_DEVICE(FTDI_VID, FTDI_ELV_WS500_PID) },
594         { USB_DEVICE(FTDI_VID, FTDI_ELV_HS485_PID) },
595         { USB_DEVICE(FTDI_VID, FTDI_ELV_UMS100_PID) },
596         { USB_DEVICE(FTDI_VID, FTDI_ELV_TFD128_PID) },
597         { USB_DEVICE(FTDI_VID, FTDI_ELV_FM3RX_PID) },
598         { USB_DEVICE(FTDI_VID, FTDI_ELV_WS777_PID) },
599         { USB_DEVICE(FTDI_VID, LINX_SDMUSBQSS_PID) },
600         { USB_DEVICE(FTDI_VID, LINX_MASTERDEVEL2_PID) },
601         { USB_DEVICE(FTDI_VID, LINX_FUTURE_0_PID) },
602         { USB_DEVICE(FTDI_VID, LINX_FUTURE_1_PID) },
603         { USB_DEVICE(FTDI_VID, LINX_FUTURE_2_PID) },
604         { USB_DEVICE(FTDI_VID, FTDI_CCSICDU20_0_PID) },
605         { USB_DEVICE(FTDI_VID, FTDI_CCSICDU40_1_PID) },
606         { USB_DEVICE(FTDI_VID, FTDI_CCSMACHX_2_PID) },
607         { USB_DEVICE(FTDI_VID, FTDI_CCSLOAD_N_GO_3_PID) },
608         { USB_DEVICE(FTDI_VID, FTDI_CCSICDU64_4_PID) },
609         { USB_DEVICE(FTDI_VID, FTDI_CCSPRIME8_5_PID) },
610         { USB_DEVICE(FTDI_VID, INSIDE_ACCESSO) },
611         { USB_DEVICE(INTREPID_VID, INTREPID_VALUECAN_PID) },
612         { USB_DEVICE(INTREPID_VID, INTREPID_NEOVI_PID) },
613         { USB_DEVICE(FALCOM_VID, FALCOM_TWIST_PID) },
614         { USB_DEVICE(FALCOM_VID, FALCOM_SAMBA_PID) },
615         { USB_DEVICE(FTDI_VID, FTDI_SUUNTO_SPORTS_PID) },
616         { USB_DEVICE(FTDI_VID, FTDI_OCEANIC_PID) },
617         { USB_DEVICE(TTI_VID, TTI_QL355P_PID) },
618         { USB_DEVICE(FTDI_VID, FTDI_RM_CANVIEW_PID) },
619         { USB_DEVICE(CONTEC_VID, CONTEC_COM1USBH_PID) },
620         { USB_DEVICE(BANDB_VID, BANDB_USOTL4_PID) },
621         { USB_DEVICE(BANDB_VID, BANDB_USTL4_PID) },
622         { USB_DEVICE(BANDB_VID, BANDB_USO9ML2_PID) },
623         { USB_DEVICE(BANDB_VID, BANDB_USOPTL4_PID) },
624         { USB_DEVICE(BANDB_VID, BANDB_USPTL4_PID) },
625         { USB_DEVICE(BANDB_VID, BANDB_USO9ML2DR_2_PID) },
626         { USB_DEVICE(BANDB_VID, BANDB_USO9ML2DR_PID) },
627         { USB_DEVICE(BANDB_VID, BANDB_USOPTL4DR2_PID) },
628         { USB_DEVICE(BANDB_VID, BANDB_USOPTL4DR_PID) },
629         { USB_DEVICE(BANDB_VID, BANDB_485USB9F_2W_PID) },
630         { USB_DEVICE(BANDB_VID, BANDB_485USB9F_4W_PID) },
631         { USB_DEVICE(BANDB_VID, BANDB_232USB9M_PID) },
632         { USB_DEVICE(BANDB_VID, BANDB_485USBTB_2W_PID) },
633         { USB_DEVICE(BANDB_VID, BANDB_485USBTB_4W_PID) },
634         { USB_DEVICE(BANDB_VID, BANDB_TTL5USB9M_PID) },
635         { USB_DEVICE(BANDB_VID, BANDB_TTL3USB9M_PID) },
636         { USB_DEVICE(BANDB_VID, BANDB_ZZ_PROG1_USB_PID) },
637         { USB_DEVICE(FTDI_VID, EVER_ECO_PRO_CDS) },
638         { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_1_PID) },
639         { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_2_PID) },
640         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_0_PID) },
641         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_1_PID) },
642         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_2_PID) },
643         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_3_PID) },
644         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_4_PID) },
645         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_5_PID) },
646         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_6_PID) },
647         { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_7_PID) },
648         { USB_DEVICE(MOBILITY_VID, MOBILITY_USB_SERIAL_PID) },
649         { USB_DEVICE(FTDI_VID, FTDI_ACTIVE_ROBOTS_PID) },
650         { USB_DEVICE(FTDI_VID, FTDI_MHAM_KW_PID) },
651         { USB_DEVICE(FTDI_VID, FTDI_MHAM_YS_PID) },
652         { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y6_PID) },
653         { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y8_PID) },
654         { USB_DEVICE(FTDI_VID, FTDI_MHAM_IC_PID) },
655         { USB_DEVICE(FTDI_VID, FTDI_MHAM_DB9_PID) },
656         { USB_DEVICE(FTDI_VID, FTDI_MHAM_RS232_PID) },
657         { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y9_PID) },
658         { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_VCP_PID) },
659         { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_D2XX_PID) },
660         { USB_DEVICE(EVOLUTION_VID, EVOLUTION_ER1_PID) },
661         { USB_DEVICE(EVOLUTION_VID, EVO_HYBRID_PID) },
662         { USB_DEVICE(EVOLUTION_VID, EVO_RCM4_PID) },
663         { USB_DEVICE(FTDI_VID, FTDI_ARTEMIS_PID) },
664         { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16_PID) },
665         { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16C_PID) },
666         { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HR_PID) },
667         { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HRC_PID) },
668         { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16IC_PID) },
669         { USB_DEVICE(KOBIL_VID, KOBIL_CONV_B1_PID) },
670         { USB_DEVICE(KOBIL_VID, KOBIL_CONV_KAAN_PID) },
671         { USB_DEVICE(POSIFLEX_VID, POSIFLEX_PP7000_PID) },
672         { USB_DEVICE(FTDI_VID, FTDI_TTUSB_PID) },
673         { USB_DEVICE(FTDI_VID, FTDI_ECLO_COM_1WIRE_PID) },
674         { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_777_PID) },
675         { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_8900F_PID) },
676         { USB_DEVICE(FTDI_VID, FTDI_PCDJ_DAC2_PID) },
677         { USB_DEVICE(FTDI_VID, FTDI_RRCIRKITS_LOCOBUFFER_PID) },
678         { USB_DEVICE(FTDI_VID, FTDI_ASK_RDR400_PID) },
679         { USB_DEVICE(ICOM_ID1_VID, ICOM_ID1_PID) },
680         { USB_DEVICE(FTDI_VID, FTDI_ACG_HFDUAL_PID) },
681         { USB_DEVICE(FTDI_VID, FTDI_YEI_SERVOCENTER31_PID) },
682         { USB_DEVICE(FTDI_VID, FTDI_THORLABS_PID) },
683         { USB_DEVICE(TESTO_VID, TESTO_USB_INTERFACE_PID) },
684         { USB_DEVICE(FTDI_VID, FTDI_GAMMA_SCOUT_PID) },
685         { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13M_PID) },
686         { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13S_PID) },
687         { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13U_PID) },
688         { USB_DEVICE(ELEKTOR_VID, ELEKTOR_FT323R_PID) },
689         { USB_DEVICE(FTDI_VID, FTDI_NDI_HUC_PID),
690                 .driver_info = (kernel_ulong_t)&ftdi_NDI_device_quirk },
691         { USB_DEVICE(FTDI_VID, FTDI_NDI_SPECTRA_SCU_PID),
692                 .driver_info = (kernel_ulong_t)&ftdi_NDI_device_quirk },
693         { USB_DEVICE(FTDI_VID, FTDI_NDI_FUTURE_2_PID),
694                 .driver_info = (kernel_ulong_t)&ftdi_NDI_device_quirk },
695         { USB_DEVICE(FTDI_VID, FTDI_NDI_FUTURE_3_PID),
696                 .driver_info = (kernel_ulong_t)&ftdi_NDI_device_quirk },
697         { USB_DEVICE(FTDI_VID, FTDI_NDI_AURORA_SCU_PID),
698                 .driver_info = (kernel_ulong_t)&ftdi_NDI_device_quirk },
699         { USB_DEVICE(TELLDUS_VID, TELLDUS_TELLSTICK_PID) },
700         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_SERIAL_VX7_PID) },
701         { USB_DEVICE(RTSYSTEMS_VID, RTSYSTEMS_CT29B_PID) },
702         { USB_DEVICE(FTDI_VID, FTDI_MAXSTREAM_PID) },
703         { USB_DEVICE(FTDI_VID, FTDI_PHI_FISCO_PID) },
704         { USB_DEVICE(TML_VID, TML_USB_SERIAL_PID) },
705         { USB_DEVICE(FTDI_VID, FTDI_ELSTER_UNICOM_PID) },
706         { USB_DEVICE(FTDI_VID, FTDI_PROPOX_JTAGCABLEII_PID) },
707         { USB_DEVICE(OLIMEX_VID, OLIMEX_ARM_USB_OCD_PID),
708                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
709         { USB_DEVICE(FIC_VID, FIC_NEO1973_DEBUG_PID),
710                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
711         { USB_DEVICE(FTDI_VID, FTDI_OOCDLINK_PID),
712                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
713         { USB_DEVICE(FTDI_VID, LMI_LM3S_DEVEL_BOARD_PID),
714                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
715         { USB_DEVICE(FTDI_VID, LMI_LM3S_EVAL_BOARD_PID),
716                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
717         { USB_DEVICE(FTDI_VID, FTDI_TURTELIZER_PID),
718                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
719         { USB_DEVICE(RATOC_VENDOR_ID, RATOC_PRODUCT_ID_USB60F) },
720         { USB_DEVICE(FTDI_VID, FTDI_REU_TINY_PID) },
721
722         /* Papouch devices based on FTDI chip */
723         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB485_PID) },
724         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_AP485_PID) },
725         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB422_PID) },
726         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB485_2_PID) },
727         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_AP485_2_PID) },
728         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB422_2_PID) },
729         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB485S_PID) },
730         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB485C_PID) },
731         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_LEC_PID) },
732         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SB232_PID) },
733         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_TMU_PID) },
734         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_IRAMP_PID) },
735         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_DRAK5_PID) },
736         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO8x8_PID) },
737         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO4x4_PID) },
738         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO2x2_PID) },
739         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO10x1_PID) },
740         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO30x3_PID) },
741         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO60x3_PID) },
742         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO2x16_PID) },
743         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO3x32_PID) },
744         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_DRAK6_PID) },
745         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_UPSUSB_PID) },
746         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_MU_PID) },
747         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_SIMUKEY_PID) },
748         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_AD4USB_PID) },
749         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_GMUX_PID) },
750         { USB_DEVICE(PAPOUCH_VID, PAPOUCH_GMSR_PID) },
751
752         { USB_DEVICE(FTDI_VID, FTDI_DOMINTELL_DGQG_PID) },
753         { USB_DEVICE(FTDI_VID, FTDI_DOMINTELL_DUSB_PID) },
754         { USB_DEVICE(ALTI2_VID, ALTI2_N3_PID) },
755         { USB_DEVICE(FTDI_VID, DIEBOLD_BCS_SE923_PID) },
756         { USB_DEVICE(ATMEL_VID, STK541_PID) },
757         { USB_DEVICE(DE_VID, STB_PID) },
758         { USB_DEVICE(DE_VID, WHT_PID) },
759         { USB_DEVICE(ADI_VID, ADI_GNICE_PID),
760                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
761         { USB_DEVICE(ADI_VID, ADI_GNICEPLUS_PID),
762                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
763         { USB_DEVICE(JETI_VID, JETI_SPC1201_PID) },
764         { USB_DEVICE(MARVELL_VID, MARVELL_SHEEVAPLUG_PID),
765                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
766         { USB_DEVICE(LARSENBRUSGAARD_VID, LB_ALTITRACK_PID) },
767         { USB_DEVICE(GN_OTOMETRICS_VID, AURICAL_USB_PID) },
768         { USB_DEVICE(BAYER_VID, BAYER_CONTOUR_CABLE_PID) },
769         { USB_DEVICE(FTDI_VID, MARVELL_OPENRD_PID),
770                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
771         { USB_DEVICE(FTDI_VID, HAMEG_HO820_PID) },
772         { USB_DEVICE(FTDI_VID, HAMEG_HO870_PID) },
773         { USB_DEVICE(FTDI_VID, MJSG_GENERIC_PID) },
774         { USB_DEVICE(FTDI_VID, MJSG_SR_RADIO_PID) },
775         { USB_DEVICE(FTDI_VID, MJSG_HD_RADIO_PID) },
776         { USB_DEVICE(FTDI_VID, MJSG_XM_RADIO_PID) },
777         { USB_DEVICE(FTDI_VID, XVERVE_SIGNALYZER_ST_PID),
778                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
779         { USB_DEVICE(FTDI_VID, XVERVE_SIGNALYZER_SLITE_PID),
780                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
781         { USB_DEVICE(FTDI_VID, XVERVE_SIGNALYZER_SH2_PID),
782                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
783         { USB_DEVICE(FTDI_VID, XVERVE_SIGNALYZER_SH4_PID),
784                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
785         { USB_DEVICE(FTDI_VID, SEGWAY_RMP200_PID) },
786         { USB_DEVICE(FTDI_VID, ACCESIO_COM4SM_PID) },
787         { USB_DEVICE(IONICS_VID, IONICS_PLUGCOMPUTER_PID),
788                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
789         { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_24_MASTER_WING_PID) },
790         { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_PC_WING_PID) },
791         { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_USB_DMX_PID) },
792         { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_MIDI_TIMECODE_PID) },
793         { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_MINI_WING_PID) },
794         { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_MAXI_WING_PID) },
795         { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_MEDIA_WING_PID) },
796         { USB_DEVICE(FTDI_VID, FTDI_CHAMSYS_WING_PID) },
797         { USB_DEVICE(FTDI_VID, FTDI_SCIENCESCOPE_LOGBOOKML_PID) },
798         { USB_DEVICE(FTDI_VID, FTDI_SCIENCESCOPE_LS_LOGBOOK_PID) },
799         { USB_DEVICE(FTDI_VID, FTDI_SCIENCESCOPE_HS_LOGBOOK_PID) },
800         { USB_DEVICE(QIHARDWARE_VID, MILKYMISTONE_JTAGSERIAL_PID),
801                 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
802         { },                                    /* Optional parameter entry */
803         { }                                     /* Terminating entry */
804 };
805
806 MODULE_DEVICE_TABLE(usb, id_table_combined);
807
808 static struct usb_driver ftdi_driver = {
809         .name =         "ftdi_sio",
810         .probe =        usb_serial_probe,
811         .disconnect =   usb_serial_disconnect,
812         .id_table =     id_table_combined,
813         .no_dynamic_id =        1,
814 };
815
816 static const char *ftdi_chip_name[] = {
817         [SIO] = "SIO",  /* the serial part of FT8U100AX */
818         [FT8U232AM] = "FT8U232AM",
819         [FT232BM] = "FT232BM",
820         [FT2232C] = "FT2232C",
821         [FT232RL] = "FT232RL",
822         [FT2232H] = "FT2232H",
823         [FT4232H] = "FT4232H"
824 };
825
826
827 /* Used for TIOCMIWAIT */
828 #define FTDI_STATUS_B0_MASK     (FTDI_RS0_CTS | FTDI_RS0_DSR | FTDI_RS0_RI | FTDI_RS0_RLSD)
829 #define FTDI_STATUS_B1_MASK     (FTDI_RS_BI)
830 /* End TIOCMIWAIT */
831
832 #define FTDI_IMPL_ASYNC_FLAGS = (ASYNC_SPD_HI | ASYNC_SPD_VHI \
833  | ASYNC_SPD_CUST | ASYNC_SPD_SHI | ASYNC_SPD_WARP)
834
835 /* function prototypes for a FTDI serial converter */
836 static int  ftdi_sio_probe(struct usb_serial *serial,
837                                         const struct usb_device_id *id);
838 static int  ftdi_sio_port_probe(struct usb_serial_port *port);
839 static int  ftdi_sio_port_remove(struct usb_serial_port *port);
840 static int  ftdi_open(struct tty_struct *tty, struct usb_serial_port *port);
841 static void ftdi_close(struct usb_serial_port *port);
842 static void ftdi_dtr_rts(struct usb_serial_port *port, int on);
843 static void ftdi_process_read_urb(struct urb *urb);
844 static int ftdi_prepare_write_buffer(struct usb_serial_port *port,
845                                                 void *dest, size_t size);
846 static void ftdi_set_termios(struct tty_struct *tty,
847                         struct usb_serial_port *port, struct ktermios *old);
848 static int  ftdi_tiocmget(struct tty_struct *tty, struct file *file);
849 static int  ftdi_tiocmset(struct tty_struct *tty, struct file *file,
850                         unsigned int set, unsigned int clear);
851 static int  ftdi_ioctl(struct tty_struct *tty, struct file *file,
852                         unsigned int cmd, unsigned long arg);
853 static void ftdi_break_ctl(struct tty_struct *tty, int break_state);
854
855 static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base);
856 static unsigned short int ftdi_232am_baud_to_divisor(int baud);
857 static __u32 ftdi_232bm_baud_base_to_divisor(int baud, int base);
858 static __u32 ftdi_232bm_baud_to_divisor(int baud);
859 static __u32 ftdi_2232h_baud_base_to_divisor(int baud, int base);
860 static __u32 ftdi_2232h_baud_to_divisor(int baud);
861
862 static struct usb_serial_driver ftdi_sio_device = {
863         .driver = {
864                 .owner =        THIS_MODULE,
865                 .name =         "ftdi_sio",
866         },
867         .description =          "FTDI USB Serial Device",
868         .usb_driver =           &ftdi_driver,
869         .id_table =             id_table_combined,
870         .num_ports =            1,
871         .bulk_in_size =         512,
872         .bulk_out_size =        256,
873         .probe =                ftdi_sio_probe,
874         .port_probe =           ftdi_sio_port_probe,
875         .port_remove =          ftdi_sio_port_remove,
876         .open =                 ftdi_open,
877         .close =                ftdi_close,
878         .dtr_rts =              ftdi_dtr_rts,
879         .throttle =             usb_serial_generic_throttle,
880         .unthrottle =           usb_serial_generic_unthrottle,
881         .process_read_urb =     ftdi_process_read_urb,
882         .prepare_write_buffer = ftdi_prepare_write_buffer,
883         .tiocmget =             ftdi_tiocmget,
884         .tiocmset =             ftdi_tiocmset,
885         .ioctl =                ftdi_ioctl,
886         .set_termios =          ftdi_set_termios,
887         .break_ctl =            ftdi_break_ctl,
888 };
889
890
891 #define WDR_TIMEOUT 5000 /* default urb timeout */
892 #define WDR_SHORT_TIMEOUT 1000  /* shorter urb timeout */
893
894 /* High and low are for DTR, RTS etc etc */
895 #define HIGH 1
896 #define LOW 0
897
898 /*
899  * ***************************************************************************
900  * Utility functions
901  * ***************************************************************************
902  */
903
904 static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base)
905 {
906         unsigned short int divisor;
907         /* divisor shifted 3 bits to the left */
908         int divisor3 = base / 2 / baud;
909         if ((divisor3 & 0x7) == 7)
910                 divisor3++; /* round x.7/8 up to x+1 */
911         divisor = divisor3 >> 3;
912         divisor3 &= 0x7;
913         if (divisor3 == 1)
914                 divisor |= 0xc000;
915         else if (divisor3 >= 4)
916                 divisor |= 0x4000;
917         else if (divisor3 != 0)
918                 divisor |= 0x8000;
919         else if (divisor == 1)
920                 divisor = 0;    /* special case for maximum baud rate */
921         return divisor;
922 }
923
924 static unsigned short int ftdi_232am_baud_to_divisor(int baud)
925 {
926          return ftdi_232am_baud_base_to_divisor(baud, 48000000);
927 }
928
929 static __u32 ftdi_232bm_baud_base_to_divisor(int baud, int base)
930 {
931         static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
932         __u32 divisor;
933         /* divisor shifted 3 bits to the left */
934         int divisor3 = base / 2 / baud;
935         divisor = divisor3 >> 3;
936         divisor |= (__u32)divfrac[divisor3 & 0x7] << 14;
937         /* Deal with special cases for highest baud rates. */
938         if (divisor == 1)
939                 divisor = 0;
940         else if (divisor == 0x4001)
941                 divisor = 1;
942         return divisor;
943 }
944
945 static __u32 ftdi_232bm_baud_to_divisor(int baud)
946 {
947          return ftdi_232bm_baud_base_to_divisor(baud, 48000000);
948 }
949
950 static __u32 ftdi_2232h_baud_base_to_divisor(int baud, int base)
951 {
952         static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
953         __u32 divisor;
954         int divisor3;
955
956         /* hi-speed baud rate is 10-bit sampling instead of 16-bit */
957         divisor3 = (base / 10 / baud) * 8;
958
959         divisor = divisor3 >> 3;
960         divisor |= (__u32)divfrac[divisor3 & 0x7] << 14;
961         /* Deal with special cases for highest baud rates. */
962         if (divisor == 1)
963                 divisor = 0;
964         else if (divisor == 0x4001)
965                 divisor = 1;
966         /*
967          * Set this bit to turn off a divide by 2.5 on baud rate generator
968          * This enables baud rates up to 12Mbaud but cannot reach below 1200
969          * baud with this bit set
970          */
971         divisor |= 0x00020000;
972         return divisor;
973 }
974
975 static __u32 ftdi_2232h_baud_to_divisor(int baud)
976 {
977          return ftdi_2232h_baud_base_to_divisor(baud, 120000000);
978 }
979
980 #define set_mctrl(port, set)            update_mctrl((port), (set), 0)
981 #define clear_mctrl(port, clear)        update_mctrl((port), 0, (clear))
982
983 static int update_mctrl(struct usb_serial_port *port, unsigned int set,
984                                                         unsigned int clear)
985 {
986         struct ftdi_private *priv = usb_get_serial_port_data(port);
987         unsigned urb_value;
988         int rv;
989
990         if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
991                 dbg("%s - DTR|RTS not being set|cleared", __func__);
992                 return 0;       /* no change */
993         }
994
995         clear &= ~set;  /* 'set' takes precedence over 'clear' */
996         urb_value = 0;
997         if (clear & TIOCM_DTR)
998                 urb_value |= FTDI_SIO_SET_DTR_LOW;
999         if (clear & TIOCM_RTS)
1000                 urb_value |= FTDI_SIO_SET_RTS_LOW;
1001         if (set & TIOCM_DTR)
1002                 urb_value |= FTDI_SIO_SET_DTR_HIGH;
1003         if (set & TIOCM_RTS)
1004                 urb_value |= FTDI_SIO_SET_RTS_HIGH;
1005         rv = usb_control_msg(port->serial->dev,
1006                                usb_sndctrlpipe(port->serial->dev, 0),
1007                                FTDI_SIO_SET_MODEM_CTRL_REQUEST,
1008                                FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE,
1009                                urb_value, priv->interface,
1010                                NULL, 0, WDR_TIMEOUT);
1011         if (rv < 0) {
1012                 dbg("%s Error from MODEM_CTRL urb: DTR %s, RTS %s",
1013                                 __func__,
1014                                 (set & TIOCM_DTR) ? "HIGH" :
1015                                 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
1016                                 (set & TIOCM_RTS) ? "HIGH" :
1017                                 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
1018         } else {
1019                 dbg("%s - DTR %s, RTS %s", __func__,
1020                                 (set & TIOCM_DTR) ? "HIGH" :
1021                                 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
1022                                 (set & TIOCM_RTS) ? "HIGH" :
1023                                 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
1024                 /* FIXME: locking on last_dtr_rts */
1025                 priv->last_dtr_rts = (priv->last_dtr_rts & ~clear) | set;
1026         }
1027         return rv;
1028 }
1029
1030
1031 static __u32 get_ftdi_divisor(struct tty_struct *tty,
1032                                                 struct usb_serial_port *port)
1033 {
1034         struct ftdi_private *priv = usb_get_serial_port_data(port);
1035         __u32 div_value = 0;
1036         int div_okay = 1;
1037         int baud;
1038
1039         /*
1040          * The logic involved in setting the baudrate can be cleanly split into
1041          * 3 steps.
1042          * 1. Standard baud rates are set in tty->termios->c_cflag
1043          * 2. If these are not enough, you can set any speed using alt_speed as
1044          * follows:
1045          *    - set tty->termios->c_cflag speed to B38400
1046          *    - set your real speed in tty->alt_speed; it gets ignored when
1047          *      alt_speed==0, (or)
1048          *    - call TIOCSSERIAL ioctl with (struct serial_struct) set as
1049          *      follows:
1050          *      flags & ASYNC_SPD_MASK == ASYNC_SPD_[HI, VHI, SHI, WARP],
1051          *      this just sets alt_speed to (HI: 57600, VHI: 115200,
1052          *      SHI: 230400, WARP: 460800)
1053          * ** Steps 1, 2 are done courtesy of tty_get_baud_rate
1054          * 3. You can also set baud rate by setting custom divisor as follows
1055          *    - set tty->termios->c_cflag speed to B38400
1056          *    - call TIOCSSERIAL ioctl with (struct serial_struct) set as
1057          *      follows:
1058          *      o flags & ASYNC_SPD_MASK == ASYNC_SPD_CUST
1059          *      o custom_divisor set to baud_base / your_new_baudrate
1060          * ** Step 3 is done courtesy of code borrowed from serial.c
1061          *    I should really spend some time and separate + move this common
1062          *    code to serial.c, it is replicated in nearly every serial driver
1063          *    you see.
1064          */
1065
1066         /* 1. Get the baud rate from the tty settings, this observes
1067               alt_speed hack */
1068
1069         baud = tty_get_baud_rate(tty);
1070         dbg("%s - tty_get_baud_rate reports speed %d", __func__, baud);
1071
1072         /* 2. Observe async-compatible custom_divisor hack, update baudrate
1073            if needed */
1074
1075         if (baud == 38400 &&
1076             ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
1077              (priv->custom_divisor)) {
1078                 baud = priv->baud_base / priv->custom_divisor;
1079                 dbg("%s - custom divisor %d sets baud rate to %d",
1080                                 __func__, priv->custom_divisor, baud);
1081         }
1082
1083         /* 3. Convert baudrate to device-specific divisor */
1084
1085         if (!baud)
1086                 baud = 9600;
1087         switch (priv->chip_type) {
1088         case SIO: /* SIO chip */
1089                 switch (baud) {
1090                 case 300: div_value = ftdi_sio_b300; break;
1091                 case 600: div_value = ftdi_sio_b600; break;
1092                 case 1200: div_value = ftdi_sio_b1200; break;
1093                 case 2400: div_value = ftdi_sio_b2400; break;
1094                 case 4800: div_value = ftdi_sio_b4800; break;
1095                 case 9600: div_value = ftdi_sio_b9600; break;
1096                 case 19200: div_value = ftdi_sio_b19200; break;
1097                 case 38400: div_value = ftdi_sio_b38400; break;
1098                 case 57600: div_value = ftdi_sio_b57600;  break;
1099                 case 115200: div_value = ftdi_sio_b115200; break;
1100                 } /* baud */
1101                 if (div_value == 0) {
1102                         dbg("%s - Baudrate (%d) requested is not supported",
1103                                                         __func__,  baud);
1104                         div_value = ftdi_sio_b9600;
1105                         baud = 9600;
1106                         div_okay = 0;
1107                 }
1108                 break;
1109         case FT8U232AM: /* 8U232AM chip */
1110                 if (baud <= 3000000) {
1111                         div_value = ftdi_232am_baud_to_divisor(baud);
1112                 } else {
1113                         dbg("%s - Baud rate too high!", __func__);
1114                         baud = 9600;
1115                         div_value = ftdi_232am_baud_to_divisor(9600);
1116                         div_okay = 0;
1117                 }
1118                 break;
1119         case FT232BM: /* FT232BM chip */
1120         case FT2232C: /* FT2232C chip */
1121         case FT232RL:
1122                 if (baud <= 3000000) {
1123                         __u16 product_id = le16_to_cpu(
1124                                 port->serial->dev->descriptor.idProduct);
1125                         if (((FTDI_NDI_HUC_PID == product_id) ||
1126                              (FTDI_NDI_SPECTRA_SCU_PID == product_id) ||
1127                              (FTDI_NDI_FUTURE_2_PID == product_id) ||
1128                              (FTDI_NDI_FUTURE_3_PID == product_id) ||
1129                              (FTDI_NDI_AURORA_SCU_PID == product_id)) &&
1130                             (baud == 19200)) {
1131                                 baud = 1200000;
1132                         }
1133                         div_value = ftdi_232bm_baud_to_divisor(baud);
1134                 } else {
1135                         dbg("%s - Baud rate too high!", __func__);
1136                         div_value = ftdi_232bm_baud_to_divisor(9600);
1137                         div_okay = 0;
1138                         baud = 9600;
1139                 }
1140                 break;
1141         case FT2232H: /* FT2232H chip */
1142         case FT4232H: /* FT4232H chip */
1143                 if ((baud <= 12000000) & (baud >= 1200)) {
1144                         div_value = ftdi_2232h_baud_to_divisor(baud);
1145                 } else if (baud < 1200) {
1146                         div_value = ftdi_232bm_baud_to_divisor(baud);
1147                 } else {
1148                         dbg("%s - Baud rate too high!", __func__);
1149                         div_value = ftdi_232bm_baud_to_divisor(9600);
1150                         div_okay = 0;
1151                         baud = 9600;
1152                 }
1153                 break;
1154         } /* priv->chip_type */
1155
1156         if (div_okay) {
1157                 dbg("%s - Baud rate set to %d (divisor 0x%lX) on chip %s",
1158                         __func__, baud, (unsigned long)div_value,
1159                         ftdi_chip_name[priv->chip_type]);
1160         }
1161
1162         tty_encode_baud_rate(tty, baud, baud);
1163         return div_value;
1164 }
1165
1166 static int change_speed(struct tty_struct *tty, struct usb_serial_port *port)
1167 {
1168         struct ftdi_private *priv = usb_get_serial_port_data(port);
1169         __u16 urb_value;
1170         __u16 urb_index;
1171         __u32 urb_index_value;
1172         int rv;
1173
1174         urb_index_value = get_ftdi_divisor(tty, port);
1175         urb_value = (__u16)urb_index_value;
1176         urb_index = (__u16)(urb_index_value >> 16);
1177         if (priv->interface) {  /* FT2232C */
1178                 urb_index = (__u16)((urb_index << 8) | priv->interface);
1179         }
1180
1181         rv = usb_control_msg(port->serial->dev,
1182                             usb_sndctrlpipe(port->serial->dev, 0),
1183                             FTDI_SIO_SET_BAUDRATE_REQUEST,
1184                             FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE,
1185                             urb_value, urb_index,
1186                             NULL, 0, WDR_SHORT_TIMEOUT);
1187         return rv;
1188 }
1189
1190 static int write_latency_timer(struct usb_serial_port *port)
1191 {
1192         struct ftdi_private *priv = usb_get_serial_port_data(port);
1193         struct usb_device *udev = port->serial->dev;
1194         int rv;
1195         int l = priv->latency;
1196
1197         if (priv->flags & ASYNC_LOW_LATENCY)
1198                 l = 1;
1199
1200         dbg("%s: setting latency timer = %i", __func__, l);
1201
1202         rv = usb_control_msg(udev,
1203                              usb_sndctrlpipe(udev, 0),
1204                              FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
1205                              FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
1206                              l, priv->interface,
1207                              NULL, 0, WDR_TIMEOUT);
1208         if (rv < 0)
1209                 dev_err(&port->dev, "Unable to write latency timer: %i\n", rv);
1210         return rv;
1211 }
1212
1213 static int read_latency_timer(struct usb_serial_port *port)
1214 {
1215         struct ftdi_private *priv = usb_get_serial_port_data(port);
1216         struct usb_device *udev = port->serial->dev;
1217         unsigned char *buf;
1218         int rv;
1219
1220         dbg("%s", __func__);
1221
1222         buf = kmalloc(1, GFP_KERNEL);
1223         if (!buf)
1224                 return -ENOMEM;
1225
1226         rv = usb_control_msg(udev,
1227                              usb_rcvctrlpipe(udev, 0),
1228                              FTDI_SIO_GET_LATENCY_TIMER_REQUEST,
1229                              FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE,
1230                              0, priv->interface,
1231                              buf, 1, WDR_TIMEOUT);
1232         if (rv < 0)
1233                 dev_err(&port->dev, "Unable to read latency timer: %i\n", rv);
1234         else
1235                 priv->latency = buf[0];
1236
1237         kfree(buf);
1238
1239         return rv;
1240 }
1241
1242 static int get_serial_info(struct usb_serial_port *port,
1243                                 struct serial_struct __user *retinfo)
1244 {
1245         struct ftdi_private *priv = usb_get_serial_port_data(port);
1246         struct serial_struct tmp;
1247
1248         if (!retinfo)
1249                 return -EFAULT;
1250         memset(&tmp, 0, sizeof(tmp));
1251         tmp.flags = priv->flags;
1252         tmp.baud_base = priv->baud_base;
1253         tmp.custom_divisor = priv->custom_divisor;
1254         if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
1255                 return -EFAULT;
1256         return 0;
1257 }
1258
1259 static int set_serial_info(struct tty_struct *tty,
1260         struct usb_serial_port *port, struct serial_struct __user *newinfo)
1261 {
1262         struct ftdi_private *priv = usb_get_serial_port_data(port);
1263         struct serial_struct new_serial;
1264         struct ftdi_private old_priv;
1265
1266         if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
1267                 return -EFAULT;
1268
1269         mutex_lock(&priv->cfg_lock);
1270         old_priv = *priv;
1271
1272         /* Do error checking and permission checking */
1273
1274         if (!capable(CAP_SYS_ADMIN)) {
1275                 if (((new_serial.flags & ~ASYNC_USR_MASK) !=
1276                      (priv->flags & ~ASYNC_USR_MASK))) {
1277                         mutex_unlock(&priv->cfg_lock);
1278                         return -EPERM;
1279                 }
1280                 priv->flags = ((priv->flags & ~ASYNC_USR_MASK) |
1281                                (new_serial.flags & ASYNC_USR_MASK));
1282                 priv->custom_divisor = new_serial.custom_divisor;
1283                 goto check_and_exit;
1284         }
1285
1286         if ((new_serial.baud_base != priv->baud_base) &&
1287             (new_serial.baud_base < 9600)) {
1288                 mutex_unlock(&priv->cfg_lock);
1289                 return -EINVAL;
1290         }
1291
1292         /* Make the changes - these are privileged changes! */
1293
1294         priv->flags = ((priv->flags & ~ASYNC_FLAGS) |
1295                                         (new_serial.flags & ASYNC_FLAGS));
1296         priv->custom_divisor = new_serial.custom_divisor;
1297
1298         write_latency_timer(port);
1299
1300 check_and_exit:
1301         if ((old_priv.flags & ASYNC_SPD_MASK) !=
1302              (priv->flags & ASYNC_SPD_MASK)) {
1303                 if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_HI)
1304                         tty->alt_speed = 57600;
1305                 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_VHI)
1306                         tty->alt_speed = 115200;
1307                 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_SHI)
1308                         tty->alt_speed = 230400;
1309                 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_WARP)
1310                         tty->alt_speed = 460800;
1311                 else
1312                         tty->alt_speed = 0;
1313         }
1314         if (((old_priv.flags & ASYNC_SPD_MASK) !=
1315              (priv->flags & ASYNC_SPD_MASK)) ||
1316             (((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
1317              (old_priv.custom_divisor != priv->custom_divisor))) {
1318                 change_speed(tty, port);
1319                 mutex_unlock(&priv->cfg_lock);
1320         }
1321         else
1322                 mutex_unlock(&priv->cfg_lock);
1323         return 0;
1324 }
1325
1326 static int get_lsr_info(struct usb_serial_port *port,
1327                         struct serial_struct __user *retinfo)
1328 {
1329         struct ftdi_private *priv = usb_get_serial_port_data(port);
1330         unsigned int result = 0;
1331
1332         if (!retinfo)
1333                 return -EFAULT;
1334
1335         if (priv->transmit_empty)
1336                 result = TIOCSER_TEMT;
1337
1338         if (copy_to_user(retinfo, &result, sizeof(unsigned int)))
1339                 return -EFAULT;
1340         return 0;
1341 }
1342
1343
1344 /* Determine type of FTDI chip based on USB config and descriptor. */
1345 static void ftdi_determine_type(struct usb_serial_port *port)
1346 {
1347         struct ftdi_private *priv = usb_get_serial_port_data(port);
1348         struct usb_serial *serial = port->serial;
1349         struct usb_device *udev = serial->dev;
1350         unsigned version;
1351         unsigned interfaces;
1352
1353         /* Assume it is not the original SIO device for now. */
1354         priv->baud_base = 48000000 / 2;
1355
1356         version = le16_to_cpu(udev->descriptor.bcdDevice);
1357         interfaces = udev->actconfig->desc.bNumInterfaces;
1358         dbg("%s: bcdDevice = 0x%x, bNumInterfaces = %u", __func__,
1359                         version, interfaces);
1360         if (interfaces > 1) {
1361                 int inter;
1362
1363                 /* Multiple interfaces.*/
1364                 if (version == 0x0800) {
1365                         priv->chip_type = FT4232H;
1366                         /* Hi-speed - baud clock runs at 120MHz */
1367                         priv->baud_base = 120000000 / 2;
1368                 } else if (version == 0x0700) {
1369                         priv->chip_type = FT2232H;
1370                         /* Hi-speed - baud clock runs at 120MHz */
1371                         priv->baud_base = 120000000 / 2;
1372                 } else
1373                         priv->chip_type = FT2232C;
1374
1375                 /* Determine interface code. */
1376                 inter = serial->interface->altsetting->desc.bInterfaceNumber;
1377                 if (inter == 0) {
1378                         priv->interface = INTERFACE_A;
1379                 } else  if (inter == 1) {
1380                         priv->interface = INTERFACE_B;
1381                 } else  if (inter == 2) {
1382                         priv->interface = INTERFACE_C;
1383                 } else  if (inter == 3) {
1384                         priv->interface = INTERFACE_D;
1385                 }
1386                 /* BM-type devices have a bug where bcdDevice gets set
1387                  * to 0x200 when iSerialNumber is 0.  */
1388                 if (version < 0x500) {
1389                         dbg("%s: something fishy - bcdDevice too low for multi-interface device",
1390                                         __func__);
1391                 }
1392         } else if (version < 0x200) {
1393                 /* Old device.  Assume it's the original SIO. */
1394                 priv->chip_type = SIO;
1395                 priv->baud_base = 12000000 / 16;
1396         } else if (version < 0x400) {
1397                 /* Assume it's an FT8U232AM (or FT8U245AM) */
1398                 /* (It might be a BM because of the iSerialNumber bug,
1399                  * but it will still work as an AM device.) */
1400                 priv->chip_type = FT8U232AM;
1401         } else if (version < 0x600) {
1402                 /* Assume it's an FT232BM (or FT245BM) */
1403                 priv->chip_type = FT232BM;
1404         } else {
1405                 /* Assume it's an FT232R */
1406                 priv->chip_type = FT232RL;
1407         }
1408         dev_info(&udev->dev, "Detected %s\n", ftdi_chip_name[priv->chip_type]);
1409 }
1410
1411
1412 /* Determine the maximum packet size for the device.  This depends on the chip
1413  * type and the USB host capabilities.  The value should be obtained from the
1414  * device descriptor as the chip will use the appropriate values for the host.*/
1415 static void ftdi_set_max_packet_size(struct usb_serial_port *port)
1416 {
1417         struct ftdi_private *priv = usb_get_serial_port_data(port);
1418         struct usb_serial *serial = port->serial;
1419         struct usb_device *udev = serial->dev;
1420
1421         struct usb_interface *interface = serial->interface;
1422         struct usb_endpoint_descriptor *ep_desc = &interface->cur_altsetting->endpoint[1].desc;
1423
1424         unsigned num_endpoints;
1425         int i;
1426
1427         num_endpoints = interface->cur_altsetting->desc.bNumEndpoints;
1428         dev_info(&udev->dev, "Number of endpoints %d\n", num_endpoints);
1429
1430         /* NOTE: some customers have programmed FT232R/FT245R devices
1431          * with an endpoint size of 0 - not good.  In this case, we
1432          * want to override the endpoint descriptor setting and use a
1433          * value of 64 for wMaxPacketSize */
1434         for (i = 0; i < num_endpoints; i++) {
1435                 dev_info(&udev->dev, "Endpoint %d MaxPacketSize %d\n", i+1,
1436                         interface->cur_altsetting->endpoint[i].desc.wMaxPacketSize);
1437                 ep_desc = &interface->cur_altsetting->endpoint[i].desc;
1438                 if (ep_desc->wMaxPacketSize == 0) {
1439                         ep_desc->wMaxPacketSize = cpu_to_le16(0x40);
1440                         dev_info(&udev->dev, "Overriding wMaxPacketSize on endpoint %d\n", i);
1441                 }
1442         }
1443
1444         /* set max packet size based on descriptor */
1445         priv->max_packet_size = le16_to_cpu(ep_desc->wMaxPacketSize);
1446
1447         dev_info(&udev->dev, "Setting MaxPacketSize %d\n", priv->max_packet_size);
1448 }
1449
1450
1451 /*
1452  * ***************************************************************************
1453  * Sysfs Attribute
1454  * ***************************************************************************
1455  */
1456
1457 static ssize_t show_latency_timer(struct device *dev,
1458                                 struct device_attribute *attr, char *buf)
1459 {
1460         struct usb_serial_port *port = to_usb_serial_port(dev);
1461         struct ftdi_private *priv = usb_get_serial_port_data(port);
1462         if (priv->flags & ASYNC_LOW_LATENCY)
1463                 return sprintf(buf, "1\n");
1464         else
1465                 return sprintf(buf, "%i\n", priv->latency);
1466 }
1467
1468
1469 /* Write a new value of the latency timer, in units of milliseconds. */
1470 static ssize_t store_latency_timer(struct device *dev,
1471                         struct device_attribute *attr, const char *valbuf,
1472                         size_t count)
1473 {
1474         struct usb_serial_port *port = to_usb_serial_port(dev);
1475         struct ftdi_private *priv = usb_get_serial_port_data(port);
1476         int v = simple_strtoul(valbuf, NULL, 10);
1477         int rv;
1478
1479         priv->latency = v;
1480         rv = write_latency_timer(port);
1481         if (rv < 0)
1482                 return -EIO;
1483         return count;
1484 }
1485
1486 /* Write an event character directly to the FTDI register.  The ASCII
1487    value is in the low 8 bits, with the enable bit in the 9th bit. */
1488 static ssize_t store_event_char(struct device *dev,
1489         struct device_attribute *attr, const char *valbuf, size_t count)
1490 {
1491         struct usb_serial_port *port = to_usb_serial_port(dev);
1492         struct ftdi_private *priv = usb_get_serial_port_data(port);
1493         struct usb_device *udev = port->serial->dev;
1494         int v = simple_strtoul(valbuf, NULL, 10);
1495         int rv;
1496
1497         dbg("%s: setting event char = %i", __func__, v);
1498
1499         rv = usb_control_msg(udev,
1500                              usb_sndctrlpipe(udev, 0),
1501                              FTDI_SIO_SET_EVENT_CHAR_REQUEST,
1502                              FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE,
1503                              v, priv->interface,
1504                              NULL, 0, WDR_TIMEOUT);
1505         if (rv < 0) {
1506                 dbg("Unable to write event character: %i", rv);
1507                 return -EIO;
1508         }
1509
1510         return count;
1511 }
1512
1513 static DEVICE_ATTR(latency_timer, S_IWUSR | S_IRUGO, show_latency_timer,
1514                                                         store_latency_timer);
1515 static DEVICE_ATTR(event_char, S_IWUSR, NULL, store_event_char);
1516
1517 static int create_sysfs_attrs(struct usb_serial_port *port)
1518 {
1519         struct ftdi_private *priv = usb_get_serial_port_data(port);
1520         int retval = 0;
1521
1522         dbg("%s", __func__);
1523
1524         /* XXX I've no idea if the original SIO supports the event_char
1525          * sysfs parameter, so I'm playing it safe.  */
1526         if (priv->chip_type != SIO) {
1527                 dbg("sysfs attributes for %s", ftdi_chip_name[priv->chip_type]);
1528                 retval = device_create_file(&port->dev, &dev_attr_event_char);
1529                 if ((!retval) &&
1530                     (priv->chip_type == FT232BM ||
1531                      priv->chip_type == FT2232C ||
1532                      priv->chip_type == FT232RL ||
1533                      priv->chip_type == FT2232H ||
1534                      priv->chip_type == FT4232H)) {
1535                         retval = device_create_file(&port->dev,
1536                                                     &dev_attr_latency_timer);
1537                 }
1538         }
1539         return retval;
1540 }
1541
1542 static void remove_sysfs_attrs(struct usb_serial_port *port)
1543 {
1544         struct ftdi_private *priv = usb_get_serial_port_data(port);
1545
1546         dbg("%s", __func__);
1547
1548         /* XXX see create_sysfs_attrs */
1549         if (priv->chip_type != SIO) {
1550                 device_remove_file(&port->dev, &dev_attr_event_char);
1551                 if (priv->chip_type == FT232BM ||
1552                     priv->chip_type == FT2232C ||
1553                     priv->chip_type == FT232RL ||
1554                     priv->chip_type == FT2232H ||
1555                     priv->chip_type == FT4232H) {
1556                         device_remove_file(&port->dev, &dev_attr_latency_timer);
1557                 }
1558         }
1559
1560 }
1561
1562 /*
1563  * ***************************************************************************
1564  * FTDI driver specific functions
1565  * ***************************************************************************
1566  */
1567
1568 /* Probe function to check for special devices */
1569 static int ftdi_sio_probe(struct usb_serial *serial,
1570                                         const struct usb_device_id *id)
1571 {
1572         struct ftdi_sio_quirk *quirk =
1573                                 (struct ftdi_sio_quirk *)id->driver_info;
1574
1575         if (quirk && quirk->probe) {
1576                 int ret = quirk->probe(serial);
1577                 if (ret != 0)
1578                         return ret;
1579         }
1580
1581         usb_set_serial_data(serial, (void *)id->driver_info);
1582
1583         return 0;
1584 }
1585
1586 static int ftdi_sio_port_probe(struct usb_serial_port *port)
1587 {
1588         struct ftdi_private *priv;
1589         struct ftdi_sio_quirk *quirk = usb_get_serial_data(port->serial);
1590
1591
1592         dbg("%s", __func__);
1593
1594         priv = kzalloc(sizeof(struct ftdi_private), GFP_KERNEL);
1595         if (!priv) {
1596                 dev_err(&port->dev, "%s- kmalloc(%Zd) failed.\n", __func__,
1597                                         sizeof(struct ftdi_private));
1598                 return -ENOMEM;
1599         }
1600
1601         kref_init(&priv->kref);
1602         mutex_init(&priv->cfg_lock);
1603         init_waitqueue_head(&priv->delta_msr_wait);
1604
1605         priv->flags = ASYNC_LOW_LATENCY;
1606
1607         if (quirk && quirk->port_probe)
1608                 quirk->port_probe(priv);
1609
1610         priv->port = port;
1611         usb_set_serial_port_data(port, priv);
1612
1613         ftdi_determine_type(port);
1614         ftdi_set_max_packet_size(port);
1615         if (read_latency_timer(port) < 0)
1616                 priv->latency = 16;
1617         write_latency_timer(port);
1618         create_sysfs_attrs(port);
1619         return 0;
1620 }
1621
1622 /* Setup for the USB-UIRT device, which requires hardwired
1623  * baudrate (38400 gets mapped to 312500) */
1624 /* Called from usbserial:serial_probe */
1625 static void ftdi_USB_UIRT_setup(struct ftdi_private *priv)
1626 {
1627         dbg("%s", __func__);
1628
1629         priv->flags |= ASYNC_SPD_CUST;
1630         priv->custom_divisor = 77;
1631         priv->force_baud = 38400;
1632 }
1633
1634 /* Setup for the HE-TIRA1 device, which requires hardwired
1635  * baudrate (38400 gets mapped to 100000) and RTS-CTS enabled.  */
1636
1637 static void ftdi_HE_TIRA1_setup(struct ftdi_private *priv)
1638 {
1639         dbg("%s", __func__);
1640
1641         priv->flags |= ASYNC_SPD_CUST;
1642         priv->custom_divisor = 240;
1643         priv->force_baud = 38400;
1644         priv->force_rtscts = 1;
1645 }
1646
1647 /*
1648  * Module parameter to control latency timer for NDI FTDI-based USB devices.
1649  * If this value is not set in modprobe.conf.local its value will be set to 1ms.
1650  */
1651 static int ndi_latency_timer = 1;
1652
1653 /* Setup for the NDI FTDI-based USB devices, which requires hardwired
1654  * baudrate (19200 gets mapped to 1200000).
1655  *
1656  * Called from usbserial:serial_probe.
1657  */
1658 static int ftdi_NDI_device_setup(struct usb_serial *serial)
1659 {
1660         struct usb_device *udev = serial->dev;
1661         int latency = ndi_latency_timer;
1662
1663         if (latency == 0)
1664                 latency = 1;
1665         if (latency > 99)
1666                 latency = 99;
1667
1668         dbg("%s setting NDI device latency to %d", __func__, latency);
1669         dev_info(&udev->dev, "NDI device with a latency value of %d", latency);
1670
1671         /* FIXME: errors are not returned */
1672         usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1673                                 FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
1674                                 FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
1675                                 latency, 0, NULL, 0, WDR_TIMEOUT);
1676         return 0;
1677 }
1678
1679 /*
1680  * First port on JTAG adaptors such as Olimex arm-usb-ocd or the FIC/OpenMoko
1681  * Neo1973 Debug Board is reserved for JTAG interface and can be accessed from
1682  * userspace using openocd.
1683  */
1684 static int ftdi_jtag_probe(struct usb_serial *serial)
1685 {
1686         struct usb_device *udev = serial->dev;
1687         struct usb_interface *interface = serial->interface;
1688
1689         dbg("%s", __func__);
1690
1691         if (interface == udev->actconfig->interface[0]) {
1692                 dev_info(&udev->dev,
1693                          "Ignoring serial port reserved for JTAG\n");
1694                 return -ENODEV;
1695         }
1696
1697         return 0;
1698 }
1699
1700 /*
1701  * The Matrix Orbital VK204-25-USB has an invalid IN endpoint.
1702  * We have to correct it if we want to read from it.
1703  */
1704 static int ftdi_mtxorb_hack_setup(struct usb_serial *serial)
1705 {
1706         struct usb_host_endpoint *ep = serial->dev->ep_in[1];
1707         struct usb_endpoint_descriptor *ep_desc = &ep->desc;
1708
1709         if (ep->enabled && ep_desc->wMaxPacketSize == 0) {
1710                 ep_desc->wMaxPacketSize = cpu_to_le16(0x40);
1711                 dev_info(&serial->dev->dev,
1712                          "Fixing invalid wMaxPacketSize on read pipe\n");
1713         }
1714
1715         return 0;
1716 }
1717
1718 static void ftdi_sio_priv_release(struct kref *k)
1719 {
1720         struct ftdi_private *priv = container_of(k, struct ftdi_private, kref);
1721
1722         kfree(priv);
1723 }
1724
1725 static int ftdi_sio_port_remove(struct usb_serial_port *port)
1726 {
1727         struct ftdi_private *priv = usb_get_serial_port_data(port);
1728
1729         dbg("%s", __func__);
1730
1731         remove_sysfs_attrs(port);
1732
1733         kref_put(&priv->kref, ftdi_sio_priv_release);
1734
1735         return 0;
1736 }
1737
1738 static int ftdi_open(struct tty_struct *tty, struct usb_serial_port *port)
1739 {
1740         struct usb_device *dev = port->serial->dev;
1741         struct ftdi_private *priv = usb_get_serial_port_data(port);
1742         int result;
1743
1744         dbg("%s", __func__);
1745
1746         /* No error checking for this (will get errors later anyway) */
1747         /* See ftdi_sio.h for description of what is reset */
1748         usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1749                         FTDI_SIO_RESET_REQUEST, FTDI_SIO_RESET_REQUEST_TYPE,
1750                         FTDI_SIO_RESET_SIO,
1751                         priv->interface, NULL, 0, WDR_TIMEOUT);
1752
1753         /* Termios defaults are set by usb_serial_init. We don't change
1754            port->tty->termios - this would lose speed settings, etc.
1755            This is same behaviour as serial.c/rs_open() - Kuba */
1756
1757         /* ftdi_set_termios  will send usb control messages */
1758         if (tty)
1759                 ftdi_set_termios(tty, port, tty->termios);
1760
1761         /* Start reading from the device */
1762         result = usb_serial_generic_open(tty, port);
1763         if (!result)
1764                 kref_get(&priv->kref);
1765
1766         return result;
1767 }
1768
1769 static void ftdi_dtr_rts(struct usb_serial_port *port, int on)
1770 {
1771         struct ftdi_private *priv = usb_get_serial_port_data(port);
1772
1773         mutex_lock(&port->serial->disc_mutex);
1774         if (!port->serial->disconnected) {
1775                 /* Disable flow control */
1776                 if (!on && usb_control_msg(port->serial->dev,
1777                             usb_sndctrlpipe(port->serial->dev, 0),
1778                             FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1779                             FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1780                             0, priv->interface, NULL, 0,
1781                             WDR_TIMEOUT) < 0) {
1782                             dev_err(&port->dev, "error from flowcontrol urb\n");
1783                 }
1784                 /* drop RTS and DTR */
1785                 if (on)
1786                         set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1787                 else
1788                         clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1789         }
1790         mutex_unlock(&port->serial->disc_mutex);
1791 }
1792
1793 /*
1794  * usbserial:__serial_close  only calls ftdi_close if the point is open
1795  *
1796  *   This only gets called when it is the last close
1797  */
1798 static void ftdi_close(struct usb_serial_port *port)
1799 {
1800         struct ftdi_private *priv = usb_get_serial_port_data(port);
1801
1802         dbg("%s", __func__);
1803
1804         usb_serial_generic_close(port);
1805         kref_put(&priv->kref, ftdi_sio_priv_release);
1806 }
1807
1808 /* The SIO requires the first byte to have:
1809  *  B0 1
1810  *  B1 0
1811  *  B2..7 length of message excluding byte 0
1812  *
1813  * The new devices do not require this byte
1814  */
1815 static int ftdi_prepare_write_buffer(struct usb_serial_port *port,
1816                                                 void *dest, size_t size)
1817 {
1818         struct ftdi_private *priv;
1819         int count;
1820         unsigned long flags;
1821
1822         priv = usb_get_serial_port_data(port);
1823
1824         if (priv->chip_type == SIO) {
1825                 unsigned char *buffer = dest;
1826                 int i, len, c;
1827
1828                 count = 0;
1829                 spin_lock_irqsave(&port->lock, flags);
1830                 for (i = 0; i < size - 1; i += priv->max_packet_size) {
1831                         len = min_t(int, size - i, priv->max_packet_size) - 1;
1832                         c = kfifo_out(&port->write_fifo, &buffer[i + 1], len);
1833                         if (!c)
1834                                 break;
1835                         buffer[i] = (c << 2) + 1;
1836                         count += c + 1;
1837                 }
1838                 spin_unlock_irqrestore(&port->lock, flags);
1839         } else {
1840                 count = kfifo_out_locked(&port->write_fifo, dest, size,
1841                                                                 &port->lock);
1842         }
1843
1844         return count;
1845 }
1846
1847 #define FTDI_RS_ERR_MASK (FTDI_RS_BI | FTDI_RS_PE | FTDI_RS_FE | FTDI_RS_OE)
1848
1849 static int ftdi_process_packet(struct tty_struct *tty,
1850                 struct usb_serial_port *port, struct ftdi_private *priv,
1851                 char *packet, int len)
1852 {
1853         int i;
1854         char status;
1855         char flag;
1856         char *ch;
1857
1858         dbg("%s - port %d", __func__, port->number);
1859
1860         if (len < 2) {
1861                 dbg("malformed packet");
1862                 return 0;
1863         }
1864
1865         /* Compare new line status to the old one, signal if different/
1866            N.B. packet may be processed more than once, but differences
1867            are only processed once.  */
1868         status = packet[0] & FTDI_STATUS_B0_MASK;
1869         if (status != priv->prev_status) {
1870                 priv->diff_status |= status ^ priv->prev_status;
1871                 wake_up_interruptible(&priv->delta_msr_wait);
1872                 priv->prev_status = status;
1873         }
1874
1875         flag = TTY_NORMAL;
1876         if (packet[1] & FTDI_RS_ERR_MASK) {
1877                 /* Break takes precedence over parity, which takes precedence
1878                  * over framing errors */
1879                 if (packet[1] & FTDI_RS_BI) {
1880                         flag = TTY_BREAK;
1881                         usb_serial_handle_break(port);
1882                 } else if (packet[1] & FTDI_RS_PE) {
1883                         flag = TTY_PARITY;
1884                 } else if (packet[1] & FTDI_RS_FE) {
1885                         flag = TTY_FRAME;
1886                 }
1887                 /* Overrun is special, not associated with a char */
1888                 if (packet[1] & FTDI_RS_OE)
1889                         tty_insert_flip_char(tty, 0, TTY_OVERRUN);
1890         }
1891
1892         /* save if the transmitter is empty or not */
1893         if (packet[1] & FTDI_RS_TEMT)
1894                 priv->transmit_empty = 1;
1895         else
1896                 priv->transmit_empty = 0;
1897
1898         len -= 2;
1899         if (!len)
1900                 return 0;       /* status only */
1901         ch = packet + 2;
1902
1903         if (port->port.console && port->sysrq) {
1904                 for (i = 0; i < len; i++, ch++) {
1905                         if (!usb_serial_handle_sysrq_char(port, *ch))
1906                                 tty_insert_flip_char(tty, *ch, flag);
1907                 }
1908         } else {
1909                 tty_insert_flip_string_fixed_flag(tty, ch, flag, len);
1910         }
1911
1912         return len;
1913 }
1914
1915 static void ftdi_process_read_urb(struct urb *urb)
1916 {
1917         struct usb_serial_port *port = urb->context;
1918         struct tty_struct *tty;
1919         struct ftdi_private *priv = usb_get_serial_port_data(port);
1920         char *data = (char *)urb->transfer_buffer;
1921         int i;
1922         int len;
1923         int count = 0;
1924
1925         tty = tty_port_tty_get(&port->port);
1926         if (!tty)
1927                 return;
1928
1929         for (i = 0; i < urb->actual_length; i += priv->max_packet_size) {
1930                 len = min_t(int, urb->actual_length - i, priv->max_packet_size);
1931                 count += ftdi_process_packet(tty, port, priv, &data[i], len);
1932         }
1933
1934         if (count)
1935                 tty_flip_buffer_push(tty);
1936         tty_kref_put(tty);
1937 }
1938
1939 static void ftdi_break_ctl(struct tty_struct *tty, int break_state)
1940 {
1941         struct usb_serial_port *port = tty->driver_data;
1942         struct ftdi_private *priv = usb_get_serial_port_data(port);
1943         __u16 urb_value;
1944
1945         /* break_state = -1 to turn on break, and 0 to turn off break */
1946         /* see drivers/char/tty_io.c to see it used */
1947         /* last_set_data_urb_value NEVER has the break bit set in it */
1948
1949         if (break_state)
1950                 urb_value = priv->last_set_data_urb_value | FTDI_SIO_SET_BREAK;
1951         else
1952                 urb_value = priv->last_set_data_urb_value;
1953
1954         if (usb_control_msg(port->serial->dev,
1955                         usb_sndctrlpipe(port->serial->dev, 0),
1956                         FTDI_SIO_SET_DATA_REQUEST,
1957                         FTDI_SIO_SET_DATA_REQUEST_TYPE,
1958                         urb_value , priv->interface,
1959                         NULL, 0, WDR_TIMEOUT) < 0) {
1960                 dev_err(&port->dev, "%s FAILED to enable/disable break state "
1961                         "(state was %d)\n", __func__, break_state);
1962         }
1963
1964         dbg("%s break state is %d - urb is %d", __func__,
1965                                                 break_state, urb_value);
1966
1967 }
1968
1969 /* old_termios contains the original termios settings and tty->termios contains
1970  * the new setting to be used
1971  * WARNING: set_termios calls this with old_termios in kernel space
1972  */
1973 static void ftdi_set_termios(struct tty_struct *tty,
1974                 struct usb_serial_port *port, struct ktermios *old_termios)
1975 {
1976         struct usb_device *dev = port->serial->dev;
1977         struct ftdi_private *priv = usb_get_serial_port_data(port);
1978         struct ktermios *termios = tty->termios;
1979         unsigned int cflag = termios->c_cflag;
1980         __u16 urb_value; /* will hold the new flags */
1981
1982         /* Added for xon/xoff support */
1983         unsigned int iflag = termios->c_iflag;
1984         unsigned char vstop;
1985         unsigned char vstart;
1986
1987         dbg("%s", __func__);
1988
1989         /* Force baud rate if this device requires it, unless it is set to
1990            B0. */
1991         if (priv->force_baud && ((termios->c_cflag & CBAUD) != B0)) {
1992                 dbg("%s: forcing baud rate for this device", __func__);
1993                 tty_encode_baud_rate(tty, priv->force_baud,
1994                                         priv->force_baud);
1995         }
1996
1997         /* Force RTS-CTS if this device requires it. */
1998         if (priv->force_rtscts) {
1999                 dbg("%s: forcing rtscts for this device", __func__);
2000                 termios->c_cflag |= CRTSCTS;
2001         }
2002
2003         cflag = termios->c_cflag;
2004
2005         /* FIXME -For this cut I don't care if the line is really changing or
2006            not  - so just do the change regardless  - should be able to
2007            compare old_termios and tty->termios */
2008         /* NOTE These routines can get interrupted by
2009            ftdi_sio_read_bulk_callback  - need to examine what this means -
2010            don't see any problems yet */
2011
2012         /* Set number of data bits, parity, stop bits */
2013
2014         urb_value = 0;
2015         urb_value |= (cflag & CSTOPB ? FTDI_SIO_SET_DATA_STOP_BITS_2 :
2016                       FTDI_SIO_SET_DATA_STOP_BITS_1);
2017         if (cflag & PARENB) {
2018                 if (cflag & CMSPAR)
2019                         urb_value |= cflag & PARODD ?
2020                                      FTDI_SIO_SET_DATA_PARITY_MARK :
2021                                      FTDI_SIO_SET_DATA_PARITY_SPACE;
2022                 else
2023                         urb_value |= cflag & PARODD ?
2024                                      FTDI_SIO_SET_DATA_PARITY_ODD :
2025                                      FTDI_SIO_SET_DATA_PARITY_EVEN;
2026         } else {
2027                 urb_value |= FTDI_SIO_SET_DATA_PARITY_NONE;
2028         }
2029         if (cflag & CSIZE) {
2030                 switch (cflag & CSIZE) {
2031                 case CS7: urb_value |= 7; dbg("Setting CS7"); break;
2032                 case CS8: urb_value |= 8; dbg("Setting CS8"); break;
2033                 default:
2034                         dev_err(&port->dev, "CSIZE was set but not CS7-CS8\n");
2035                 }
2036         }
2037
2038         /* This is needed by the break command since it uses the same command
2039            - but is or'ed with this value  */
2040         priv->last_set_data_urb_value = urb_value;
2041
2042         if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2043                             FTDI_SIO_SET_DATA_REQUEST,
2044                             FTDI_SIO_SET_DATA_REQUEST_TYPE,
2045                             urb_value , priv->interface,
2046                             NULL, 0, WDR_SHORT_TIMEOUT) < 0) {
2047                 dev_err(&port->dev, "%s FAILED to set "
2048                         "databits/stopbits/parity\n", __func__);
2049         }
2050
2051         /* Now do the baudrate */
2052         if ((cflag & CBAUD) == B0) {
2053                 /* Disable flow control */
2054                 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2055                                     FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2056                                     FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2057                                     0, priv->interface,
2058                                     NULL, 0, WDR_TIMEOUT) < 0) {
2059                         dev_err(&port->dev,
2060                                 "%s error from disable flowcontrol urb\n",
2061                                 __func__);
2062                 }
2063                 /* Drop RTS and DTR */
2064                 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2065         } else {
2066                 /* set the baudrate determined before */
2067                 mutex_lock(&priv->cfg_lock);
2068                 if (change_speed(tty, port))
2069                         dev_err(&port->dev, "%s urb failed to set baudrate\n",
2070                                 __func__);
2071                 mutex_unlock(&priv->cfg_lock);
2072                 /* Ensure RTS and DTR are raised when baudrate changed from 0 */
2073                 if (!old_termios || (old_termios->c_cflag & CBAUD) == B0)
2074                         set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2075         }
2076
2077         /* Set flow control */
2078         /* Note device also supports DTR/CD (ugh) and Xon/Xoff in hardware */
2079         if (cflag & CRTSCTS) {
2080                 dbg("%s Setting to CRTSCTS flow control", __func__);
2081                 if (usb_control_msg(dev,
2082                                     usb_sndctrlpipe(dev, 0),
2083                                     FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2084                                     FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2085                                     0 , (FTDI_SIO_RTS_CTS_HS | priv->interface),
2086                                     NULL, 0, WDR_TIMEOUT) < 0) {
2087                         dev_err(&port->dev,
2088                                 "urb failed to set to rts/cts flow control\n");
2089                 }
2090
2091         } else {
2092                 /*
2093                  * Xon/Xoff code
2094                  *
2095                  * Check the IXOFF status in the iflag component of the
2096                  * termios structure. If IXOFF is not set, the pre-xon/xoff
2097                  * code is executed.
2098                  */
2099                 if (iflag & IXOFF) {
2100                         dbg("%s  request to enable xonxoff iflag=%04x",
2101                                                         __func__, iflag);
2102                         /* Try to enable the XON/XOFF on the ftdi_sio
2103                          * Set the vstart and vstop -- could have been done up
2104                          * above where a lot of other dereferencing is done but
2105                          * that would be very inefficient as vstart and vstop
2106                          * are not always needed.
2107                          */
2108                         vstart = termios->c_cc[VSTART];
2109                         vstop = termios->c_cc[VSTOP];
2110                         urb_value = (vstop << 8) | (vstart);
2111
2112                         if (usb_control_msg(dev,
2113                                             usb_sndctrlpipe(dev, 0),
2114                                             FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2115                                             FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2116                                             urb_value , (FTDI_SIO_XON_XOFF_HS
2117                                                          | priv->interface),
2118                                             NULL, 0, WDR_TIMEOUT) < 0) {
2119                                 dev_err(&port->dev, "urb failed to set to "
2120                                         "xon/xoff flow control\n");
2121                         }
2122                 } else {
2123                         /* else clause to only run if cflag ! CRTSCTS and iflag
2124                          * ! XOFF. CHECKME Assuming XON/XOFF handled by tty
2125                          * stack - not by device */
2126                         dbg("%s Turning off hardware flow control", __func__);
2127                         if (usb_control_msg(dev,
2128                                             usb_sndctrlpipe(dev, 0),
2129                                             FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2130                                             FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2131                                             0, priv->interface,
2132                                             NULL, 0, WDR_TIMEOUT) < 0) {
2133                                 dev_err(&port->dev,
2134                                         "urb failed to clear flow control\n");
2135                         }
2136                 }
2137
2138         }
2139 }
2140
2141 static int ftdi_tiocmget(struct tty_struct *tty, struct file *file)
2142 {
2143         struct usb_serial_port *port = tty->driver_data;
2144         struct ftdi_private *priv = usb_get_serial_port_data(port);
2145         unsigned char *buf;
2146         int len;
2147         int ret;
2148
2149         dbg("%s TIOCMGET", __func__);
2150
2151         buf = kmalloc(2, GFP_KERNEL);
2152         if (!buf)
2153                 return -ENOMEM;
2154         /*
2155          * The 8U232AM returns a two byte value (the SIO a 1 byte value) in
2156          * the same format as the data returned from the in point.
2157          */
2158         switch (priv->chip_type) {
2159         case SIO:
2160                 len = 1;
2161                 break;
2162         case FT8U232AM:
2163         case FT232BM:
2164         case FT2232C:
2165         case FT232RL:
2166         case FT2232H:
2167         case FT4232H:
2168                 len = 2;
2169                 break;
2170         default:
2171                 ret = -EFAULT;
2172                 goto out;
2173         }
2174
2175         ret = usb_control_msg(port->serial->dev,
2176                         usb_rcvctrlpipe(port->serial->dev, 0),
2177                         FTDI_SIO_GET_MODEM_STATUS_REQUEST,
2178                         FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
2179                         0, priv->interface,
2180                         buf, len, WDR_TIMEOUT);
2181         if (ret < 0)
2182                 goto out;
2183
2184         ret = (buf[0] & FTDI_SIO_DSR_MASK ? TIOCM_DSR : 0) |
2185                 (buf[0] & FTDI_SIO_CTS_MASK ? TIOCM_CTS : 0) |
2186                 (buf[0]  & FTDI_SIO_RI_MASK  ? TIOCM_RI  : 0) |
2187                 (buf[0]  & FTDI_SIO_RLSD_MASK ? TIOCM_CD  : 0) |
2188                 priv->last_dtr_rts;
2189 out:
2190         kfree(buf);
2191         return ret;
2192 }
2193
2194 static int ftdi_tiocmset(struct tty_struct *tty, struct file *file,
2195                         unsigned int set, unsigned int clear)
2196 {
2197         struct usb_serial_port *port = tty->driver_data;
2198         dbg("%s TIOCMSET", __func__);
2199         return update_mctrl(port, set, clear);
2200 }
2201
2202 static int ftdi_ioctl(struct tty_struct *tty, struct file *file,
2203                                         unsigned int cmd, unsigned long arg)
2204 {
2205         struct usb_serial_port *port = tty->driver_data;
2206         struct ftdi_private *priv = usb_get_serial_port_data(port);
2207
2208         dbg("%s cmd 0x%04x", __func__, cmd);
2209
2210         /* Based on code from acm.c and others */
2211         switch (cmd) {
2212
2213         case TIOCGSERIAL: /* gets serial port data */
2214                 return get_serial_info(port,
2215                                         (struct serial_struct __user *) arg);
2216
2217         case TIOCSSERIAL: /* sets serial port data */
2218                 return set_serial_info(tty, port,
2219                                         (struct serial_struct __user *) arg);
2220
2221         /*
2222          * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
2223          * - mask passed in arg for lines of interest
2224          *   (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
2225          * Caller should use TIOCGICOUNT to see which one it was.
2226          * (except that the driver doesn't support it !)
2227          *
2228          * This code is borrowed from linux/drivers/char/serial.c
2229          */
2230         case TIOCMIWAIT:
2231                 while (priv != NULL) {
2232                         interruptible_sleep_on(&priv->delta_msr_wait);
2233                         /* see if a signal did it */
2234                         if (signal_pending(current))
2235                                 return -ERESTARTSYS;
2236                         else {
2237                                 char diff = priv->diff_status;
2238
2239                                 if (diff == 0)
2240                                         return -EIO; /* no change => error */
2241
2242                                 /* Consume all events */
2243                                 priv->diff_status = 0;
2244
2245                                 /* Return 0 if caller wanted to know about
2246                                    these bits */
2247                                 if (((arg & TIOCM_RNG) && (diff & FTDI_RS0_RI)) ||
2248                                     ((arg & TIOCM_DSR) && (diff & FTDI_RS0_DSR)) ||
2249                                     ((arg & TIOCM_CD)  && (diff & FTDI_RS0_RLSD)) ||
2250                                     ((arg & TIOCM_CTS) && (diff & FTDI_RS0_CTS))) {
2251                                         return 0;
2252                                 }
2253                                 /*
2254                                  * Otherwise caller can't care less about what
2255                                  * happened,and so we continue to wait for more
2256                                  * events.
2257                                  */
2258                         }
2259                 }
2260                 return 0;
2261         case TIOCSERGETLSR:
2262                 return get_lsr_info(port, (struct serial_struct __user *)arg);
2263                 break;
2264         default:
2265                 break;
2266         }
2267         /* This is not necessarily an error - turns out the higher layers
2268          * will do some ioctls themselves (see comment above)
2269          */
2270         dbg("%s arg not supported - it was 0x%04x - check /usr/include/asm/ioctls.h", __func__, cmd);
2271         return -ENOIOCTLCMD;
2272 }
2273
2274 static int __init ftdi_init(void)
2275 {
2276         int retval;
2277
2278         dbg("%s", __func__);
2279         if (vendor > 0 && product > 0) {
2280                 /* Add user specified VID/PID to reserved element of table. */
2281                 int i;
2282                 for (i = 0; id_table_combined[i].idVendor; i++)
2283                         ;
2284                 id_table_combined[i].match_flags = USB_DEVICE_ID_MATCH_DEVICE;
2285                 id_table_combined[i].idVendor = vendor;
2286                 id_table_combined[i].idProduct = product;
2287         }
2288         retval = usb_serial_register(&ftdi_sio_device);
2289         if (retval)
2290                 goto failed_sio_register;
2291         retval = usb_register(&ftdi_driver);
2292         if (retval)
2293                 goto failed_usb_register;
2294
2295         printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
2296                DRIVER_DESC "\n");
2297         return 0;
2298 failed_usb_register:
2299         usb_serial_deregister(&ftdi_sio_device);
2300 failed_sio_register:
2301         return retval;
2302 }
2303
2304 static void __exit ftdi_exit(void)
2305 {
2306         dbg("%s", __func__);
2307
2308         usb_deregister(&ftdi_driver);
2309         usb_serial_deregister(&ftdi_sio_device);
2310 }
2311
2312
2313 module_init(ftdi_init);
2314 module_exit(ftdi_exit);
2315
2316 MODULE_AUTHOR(DRIVER_AUTHOR);
2317 MODULE_DESCRIPTION(DRIVER_DESC);
2318 MODULE_LICENSE("GPL");
2319
2320 module_param(debug, bool, S_IRUGO | S_IWUSR);
2321 MODULE_PARM_DESC(debug, "Debug enabled or not");
2322 module_param(vendor, ushort, 0);
2323 MODULE_PARM_DESC(vendor, "User specified vendor ID (default="
2324                 __MODULE_STRING(FTDI_VID)")");
2325 module_param(product, ushort, 0);
2326 MODULE_PARM_DESC(product, "User specified product ID");
2327
2328 module_param(ndi_latency_timer, int, S_IRUGO | S_IWUSR);
2329 MODULE_PARM_DESC(ndi_latency_timer, "NDI device latency timer override");