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