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