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