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