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