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