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