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