4 * Copyright (C) 1999 - 2001
5 * Greg Kroah-Hartman (greg@kroah.com)
6 * Bill Ryder (bryder@sgi.com)
8 * Kuba Ober (kuba@mareimbrium.org)
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.
15 * See Documentation/usb/usb-serial.txt for more information on using this
18 * See http://ftdi-usb-sio.sourceforge.net for upto date testing info
19 * and extra documentation
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.
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
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>
50 #define DRIVER_VERSION "v1.5.0"
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"
55 static __u16 vendor = FTDI_VID;
60 ftdi_chip_type_t chip_type;
61 /* type of device, either SIO or FT8U232AM */
62 int baud_base; /* baud base clock for divisor setting */
63 int custom_divisor; /* custom_divisor kludge, this is for
64 baud_base (different from what goes to the
66 __u16 last_set_data_urb_value ;
67 /* the last data state set - needed for doing
70 int write_offset; /* This is the offset in the usb data block to
71 * write the serial data - it varies between
74 int flags; /* some ASYNC_xxxx flags are supported */
75 unsigned long last_dtr_rts; /* saved modem control outputs */
76 wait_queue_head_t delta_msr_wait; /* Used for TIOCMIWAIT */
77 char prev_status, diff_status; /* Used for TIOCMIWAIT */
78 __u8 rx_flags; /* receive state flags (throttling) */
79 spinlock_t rx_lock; /* spinlock for receive state */
80 struct delayed_work rx_work;
81 struct usb_serial_port *port;
83 unsigned long rx_bytes;
85 __u16 interface; /* FT2232C, FT2232H or FT4232H port interface
88 speed_t force_baud; /* if non-zero, force the baud rate to
90 int force_rtscts; /* if non-zero, force RTS-CTS to always
93 unsigned int latency; /* latency setting in use */
94 spinlock_t tx_lock; /* spinlock for transmit state */
95 unsigned long tx_bytes;
96 unsigned long tx_outstanding_bytes;
97 unsigned long tx_outstanding_urbs;
100 /* struct ftdi_sio_quirk is used by devices requiring special attention. */
101 struct ftdi_sio_quirk {
102 int (*probe)(struct usb_serial *);
103 /* Special settings for probed ports. */
104 void (*port_probe)(struct ftdi_private *);
107 static int ftdi_jtag_probe(struct usb_serial *serial);
108 static int ftdi_mtxorb_hack_setup(struct usb_serial *serial);
109 static void ftdi_USB_UIRT_setup(struct ftdi_private *priv);
110 static void ftdi_HE_TIRA1_setup(struct ftdi_private *priv);
112 static struct ftdi_sio_quirk ftdi_jtag_quirk = {
113 .probe = ftdi_jtag_probe,
116 static struct ftdi_sio_quirk ftdi_mtxorb_hack_quirk = {
117 .probe = ftdi_mtxorb_hack_setup,
120 static struct ftdi_sio_quirk ftdi_USB_UIRT_quirk = {
121 .port_probe = ftdi_USB_UIRT_setup,
124 static struct ftdi_sio_quirk ftdi_HE_TIRA1_quirk = {
125 .port_probe = ftdi_HE_TIRA1_setup,
129 * The 8U232AM has the same API as the sio except for:
130 * - it can support MUCH higher baudrates; up to:
131 * o 921600 for RS232 and 2000000 for RS422/485 at 48MHz
133 * so .. 8U232AM's baudrate setting codes are different
134 * - it has a two byte status code.
135 * - it returns characters every 16ms (the FTDI does it every 40ms)
137 * the bcdDevice value is used to differentiate FT232BM and FT245BM from
138 * the earlier FT8U232AM and FT8U232BM. For now, include all known VID/PID
139 * combinations in both tables.
140 * FIXME: perhaps bcdDevice can also identify 12MHz FT8U232AM devices,
141 * but I don't know if those ever went into mass production. [Ian Abbott]
146 static struct usb_device_id id_table_combined [] = {
147 { USB_DEVICE(FTDI_VID, FTDI_AMC232_PID) },
148 { USB_DEVICE(FTDI_VID, FTDI_CANUSB_PID) },
149 { USB_DEVICE(FTDI_VID, FTDI_CANDAPTER_PID) },
150 { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_0_PID) },
151 { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_1_PID) },
152 { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_2_PID) },
153 { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_3_PID) },
154 { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_4_PID) },
155 { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_5_PID) },
156 { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_6_PID) },
157 { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_7_PID) },
158 { USB_DEVICE(FTDI_VID, FTDI_ACTZWAVE_PID) },
159 { USB_DEVICE(FTDI_VID, FTDI_IRTRANS_PID) },
160 { USB_DEVICE(FTDI_VID, FTDI_IPLUS_PID) },
161 { USB_DEVICE(FTDI_VID, FTDI_IPLUS2_PID) },
162 { USB_DEVICE(FTDI_VID, FTDI_DMX4ALL) },
163 { USB_DEVICE(FTDI_VID, FTDI_SIO_PID) },
164 { USB_DEVICE(FTDI_VID, FTDI_8U232AM_PID) },
165 { USB_DEVICE(FTDI_VID, FTDI_8U232AM_ALT_PID) },
166 { USB_DEVICE(FTDI_VID, FTDI_232RL_PID) },
167 { USB_DEVICE(FTDI_VID, FTDI_8U2232C_PID) },
168 { USB_DEVICE(FTDI_VID, FTDI_4232H_PID) },
169 { USB_DEVICE(FTDI_VID, FTDI_MICRO_CHAMELEON_PID) },
170 { USB_DEVICE(FTDI_VID, FTDI_RELAIS_PID) },
171 { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_PID) },
172 { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_IOBOARD_PID) },
173 { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_MINI_IOBOARD_PID) },
174 { USB_DEVICE(FTDI_VID, FTDI_SPROG_II) },
175 { USB_DEVICE(FTDI_VID, FTDI_XF_632_PID) },
176 { USB_DEVICE(FTDI_VID, FTDI_XF_634_PID) },
177 { USB_DEVICE(FTDI_VID, FTDI_XF_547_PID) },
178 { USB_DEVICE(FTDI_VID, FTDI_XF_633_PID) },
179 { USB_DEVICE(FTDI_VID, FTDI_XF_631_PID) },
180 { USB_DEVICE(FTDI_VID, FTDI_XF_635_PID) },
181 { USB_DEVICE(FTDI_VID, FTDI_XF_640_PID) },
182 { USB_DEVICE(FTDI_VID, FTDI_XF_642_PID) },
183 { USB_DEVICE(FTDI_VID, FTDI_DSS20_PID) },
184 { USB_DEVICE(FTDI_NF_RIC_VID, FTDI_NF_RIC_PID) },
185 { USB_DEVICE(FTDI_VID, FTDI_VNHCPCUSB_D_PID) },
186 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_0_PID) },
187 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_1_PID) },
188 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_2_PID) },
189 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_3_PID) },
190 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_4_PID) },
191 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_5_PID) },
192 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_6_PID) },
193 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0100_PID) },
194 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0101_PID) },
195 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0102_PID) },
196 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0103_PID) },
197 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0104_PID) },
198 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0105_PID) },
199 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0106_PID) },
200 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0107_PID) },
201 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0108_PID) },
202 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0109_PID) },
203 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010A_PID) },
204 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010B_PID) },
205 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010C_PID) },
206 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010D_PID) },
207 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010E_PID) },
208 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010F_PID) },
209 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0110_PID) },
210 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0111_PID) },
211 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0112_PID) },
212 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0113_PID) },
213 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0114_PID) },
214 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0115_PID) },
215 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0116_PID) },
216 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0117_PID) },
217 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0118_PID) },
218 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0119_PID) },
219 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011A_PID) },
220 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011B_PID) },
221 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011C_PID) },
222 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011D_PID) },
223 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011E_PID) },
224 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011F_PID) },
225 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0120_PID) },
226 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0121_PID) },
227 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0122_PID) },
228 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0123_PID) },
229 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0124_PID) },
230 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0125_PID) },
231 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0126_PID) },
232 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0127_PID),
233 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
234 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0128_PID) },
235 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0129_PID) },
236 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012A_PID) },
237 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012B_PID) },
238 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012C_PID),
239 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
240 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012D_PID) },
241 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012E_PID) },
242 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012F_PID) },
243 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0130_PID) },
244 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0131_PID) },
245 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0132_PID) },
246 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0133_PID) },
247 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0134_PID) },
248 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0135_PID) },
249 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0136_PID) },
250 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0137_PID) },
251 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0138_PID) },
252 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0139_PID) },
253 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013A_PID) },
254 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013B_PID) },
255 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013C_PID) },
256 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013D_PID) },
257 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013E_PID) },
258 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013F_PID) },
259 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0140_PID) },
260 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0141_PID) },
261 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0142_PID) },
262 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0143_PID) },
263 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0144_PID) },
264 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0145_PID) },
265 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0146_PID) },
266 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0147_PID) },
267 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0148_PID) },
268 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0149_PID) },
269 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014A_PID) },
270 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014B_PID) },
271 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014C_PID) },
272 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014D_PID) },
273 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014E_PID) },
274 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014F_PID) },
275 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0150_PID) },
276 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0151_PID) },
277 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0152_PID) },
278 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0153_PID),
279 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
280 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0154_PID),
281 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
282 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0155_PID),
283 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
284 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0156_PID),
285 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
286 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0157_PID),
287 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
288 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0158_PID),
289 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
290 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0159_PID) },
291 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015A_PID) },
292 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015B_PID) },
293 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015C_PID) },
294 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015D_PID) },
295 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015E_PID) },
296 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015F_PID) },
297 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0160_PID) },
298 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0161_PID) },
299 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0162_PID) },
300 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0163_PID) },
301 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0164_PID) },
302 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0165_PID) },
303 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0166_PID) },
304 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0167_PID) },
305 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0168_PID) },
306 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0169_PID) },
307 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016A_PID) },
308 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016B_PID) },
309 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016C_PID) },
310 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016D_PID) },
311 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016E_PID) },
312 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016F_PID) },
313 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0170_PID) },
314 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0171_PID) },
315 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0172_PID) },
316 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0173_PID) },
317 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0174_PID) },
318 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0175_PID) },
319 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0176_PID) },
320 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0177_PID) },
321 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0178_PID) },
322 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0179_PID) },
323 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017A_PID) },
324 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017B_PID) },
325 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017C_PID) },
326 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017D_PID) },
327 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017E_PID) },
328 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017F_PID) },
329 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0180_PID) },
330 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0181_PID) },
331 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0182_PID) },
332 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0183_PID) },
333 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0184_PID) },
334 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0185_PID) },
335 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0186_PID) },
336 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0187_PID) },
337 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0188_PID) },
338 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0189_PID) },
339 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018A_PID) },
340 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018B_PID) },
341 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018C_PID) },
342 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018D_PID) },
343 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018E_PID) },
344 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018F_PID) },
345 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0190_PID) },
346 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0191_PID) },
347 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0192_PID) },
348 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0193_PID) },
349 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0194_PID) },
350 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0195_PID) },
351 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0196_PID) },
352 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0197_PID) },
353 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0198_PID) },
354 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0199_PID) },
355 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019A_PID) },
356 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019B_PID) },
357 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019C_PID) },
358 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019D_PID) },
359 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019E_PID) },
360 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019F_PID) },
361 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A0_PID) },
362 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A1_PID) },
363 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A2_PID) },
364 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A3_PID) },
365 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A4_PID) },
366 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A5_PID) },
367 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A6_PID) },
368 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A7_PID) },
369 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A8_PID) },
370 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A9_PID) },
371 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AA_PID) },
372 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AB_PID) },
373 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AC_PID) },
374 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AD_PID) },
375 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AE_PID) },
376 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AF_PID) },
377 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B0_PID) },
378 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B1_PID) },
379 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B2_PID) },
380 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B3_PID) },
381 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B4_PID) },
382 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B5_PID) },
383 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B6_PID) },
384 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B7_PID) },
385 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B8_PID) },
386 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B9_PID) },
387 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BA_PID) },
388 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BB_PID) },
389 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BC_PID) },
390 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BD_PID) },
391 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BE_PID) },
392 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BF_PID) },
393 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C0_PID) },
394 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C1_PID) },
395 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C2_PID) },
396 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C3_PID) },
397 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C4_PID) },
398 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C5_PID) },
399 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C6_PID) },
400 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C7_PID) },
401 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C8_PID) },
402 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C9_PID) },
403 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CA_PID) },
404 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CB_PID) },
405 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CC_PID) },
406 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CD_PID) },
407 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CE_PID) },
408 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CF_PID) },
409 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D0_PID) },
410 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D1_PID) },
411 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D2_PID) },
412 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D3_PID) },
413 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D4_PID) },
414 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D5_PID) },
415 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D6_PID) },
416 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D7_PID) },
417 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D8_PID) },
418 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D9_PID) },
419 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DA_PID) },
420 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DB_PID) },
421 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DC_PID) },
422 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DD_PID) },
423 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DE_PID) },
424 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DF_PID) },
425 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E0_PID) },
426 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E1_PID) },
427 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E2_PID) },
428 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E3_PID) },
429 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E4_PID) },
430 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E5_PID) },
431 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E6_PID) },
432 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E7_PID) },
433 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E8_PID) },
434 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E9_PID) },
435 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EA_PID) },
436 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EB_PID) },
437 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EC_PID) },
438 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01ED_PID) },
439 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EE_PID) },
440 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EF_PID) },
441 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F0_PID) },
442 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F1_PID) },
443 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F2_PID) },
444 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F3_PID) },
445 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F4_PID) },
446 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F5_PID) },
447 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F6_PID) },
448 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F7_PID) },
449 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F8_PID) },
450 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F9_PID) },
451 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FA_PID) },
452 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FB_PID) },
453 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FC_PID) },
454 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FD_PID) },
455 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FE_PID) },
456 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FF_PID) },
457 { USB_DEVICE(FTDI_VID, FTDI_PERLE_ULTRAPORT_PID) },
458 { USB_DEVICE(FTDI_VID, FTDI_PIEGROUP_PID) },
459 { USB_DEVICE(FTDI_VID, FTDI_TNC_X_PID) },
460 { USB_DEVICE(FTDI_VID, FTDI_USBX_707_PID) },
461 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2101_PID) },
462 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2102_PID) },
463 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2103_PID) },
464 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2104_PID) },
465 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2106_PID) },
466 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_1_PID) },
467 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_2_PID) },
468 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_1_PID) },
469 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_2_PID) },
470 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_1_PID) },
471 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_2_PID) },
472 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_1_PID) },
473 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_2_PID) },
474 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_3_PID) },
475 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_4_PID) },
476 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_1_PID) },
477 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_2_PID) },
478 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_3_PID) },
479 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_4_PID) },
480 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_1_PID) },
481 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_2_PID) },
482 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_3_PID) },
483 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_4_PID) },
484 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_1_PID) },
485 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_2_PID) },
486 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_3_PID) },
487 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_4_PID) },
488 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_5_PID) },
489 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_6_PID) },
490 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_7_PID) },
491 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_8_PID) },
492 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_1_PID) },
493 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_2_PID) },
494 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_3_PID) },
495 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_4_PID) },
496 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_5_PID) },
497 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_6_PID) },
498 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_7_PID) },
499 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_8_PID) },
500 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_1_PID) },
501 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_2_PID) },
502 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_3_PID) },
503 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_4_PID) },
504 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_5_PID) },
505 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_6_PID) },
506 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_7_PID) },
507 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_8_PID) },
508 { USB_DEVICE(IDTECH_VID, IDTECH_IDT1221U_PID) },
509 { USB_DEVICE(OCT_VID, OCT_US101_PID) },
510 { USB_DEVICE(FTDI_VID, FTDI_HE_TIRA1_PID),
511 .driver_info = (kernel_ulong_t)&ftdi_HE_TIRA1_quirk },
512 { USB_DEVICE(FTDI_VID, FTDI_USB_UIRT_PID),
513 .driver_info = (kernel_ulong_t)&ftdi_USB_UIRT_quirk },
514 { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_1) },
515 { USB_DEVICE(FTDI_VID, PROTEGO_R2X0) },
516 { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_3) },
517 { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_4) },
518 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E808_PID) },
519 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E809_PID) },
520 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80A_PID) },
521 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80B_PID) },
522 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80C_PID) },
523 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80D_PID) },
524 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80E_PID) },
525 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80F_PID) },
526 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E888_PID) },
527 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E889_PID) },
528 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88A_PID) },
529 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88B_PID) },
530 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88C_PID) },
531 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88D_PID) },
532 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88E_PID) },
533 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88F_PID) },
534 { USB_DEVICE(FTDI_VID, FTDI_ELV_UO100_PID) },
535 { USB_DEVICE(FTDI_VID, FTDI_ELV_UM100_PID) },
536 { USB_DEVICE(FTDI_VID, FTDI_ELV_UR100_PID) },
537 { USB_DEVICE(FTDI_VID, FTDI_ELV_ALC8500_PID) },
538 { USB_DEVICE(FTDI_VID, FTDI_PYRAMID_PID) },
539 { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1000PC_PID) },
540 { USB_DEVICE(FTDI_VID, FTDI_IBS_US485_PID) },
541 { USB_DEVICE(FTDI_VID, FTDI_IBS_PICPRO_PID) },
542 { USB_DEVICE(FTDI_VID, FTDI_IBS_PCMCIA_PID) },
543 { USB_DEVICE(FTDI_VID, FTDI_IBS_PK1_PID) },
544 { USB_DEVICE(FTDI_VID, FTDI_IBS_RS232MON_PID) },
545 { USB_DEVICE(FTDI_VID, FTDI_IBS_APP70_PID) },
546 { USB_DEVICE(FTDI_VID, FTDI_IBS_PEDO_PID) },
547 { USB_DEVICE(FTDI_VID, FTDI_IBS_PROD_PID) },
549 * Due to many user requests for multiple ELV devices we enable
552 { USB_DEVICE(FTDI_VID, FTDI_ELV_CLI7000_PID) },
553 { USB_DEVICE(FTDI_VID, FTDI_ELV_PPS7330_PID) },
554 { USB_DEVICE(FTDI_VID, FTDI_ELV_TFM100_PID) },
555 { USB_DEVICE(FTDI_VID, FTDI_ELV_UDF77_PID) },
556 { USB_DEVICE(FTDI_VID, FTDI_ELV_UIO88_PID) },
557 { USB_DEVICE(FTDI_VID, FTDI_ELV_UAD8_PID) },
558 { USB_DEVICE(FTDI_VID, FTDI_ELV_UDA7_PID) },
559 { USB_DEVICE(FTDI_VID, FTDI_ELV_USI2_PID) },
560 { USB_DEVICE(FTDI_VID, FTDI_ELV_T1100_PID) },
561 { USB_DEVICE(FTDI_VID, FTDI_ELV_PCD200_PID) },
562 { USB_DEVICE(FTDI_VID, FTDI_ELV_ULA200_PID) },
563 { USB_DEVICE(FTDI_VID, FTDI_ELV_CSI8_PID) },
564 { USB_DEVICE(FTDI_VID, FTDI_ELV_EM1000DL_PID) },
565 { USB_DEVICE(FTDI_VID, FTDI_ELV_PCK100_PID) },
566 { USB_DEVICE(FTDI_VID, FTDI_ELV_RFP500_PID) },
567 { USB_DEVICE(FTDI_VID, FTDI_ELV_FS20SIG_PID) },
568 { USB_DEVICE(FTDI_VID, FTDI_ELV_WS300PC_PID) },
569 { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1300PC_PID) },
570 { USB_DEVICE(FTDI_VID, FTDI_ELV_EM1010PC_PID) },
571 { USB_DEVICE(FTDI_VID, FTDI_ELV_WS500_PID) },
572 { USB_DEVICE(FTDI_VID, FTDI_ELV_HS485_PID) },
573 { USB_DEVICE(FTDI_VID, LINX_SDMUSBQSS_PID) },
574 { USB_DEVICE(FTDI_VID, LINX_MASTERDEVEL2_PID) },
575 { USB_DEVICE(FTDI_VID, LINX_FUTURE_0_PID) },
576 { USB_DEVICE(FTDI_VID, LINX_FUTURE_1_PID) },
577 { USB_DEVICE(FTDI_VID, LINX_FUTURE_2_PID) },
578 { USB_DEVICE(FTDI_VID, FTDI_CCSICDU20_0_PID) },
579 { USB_DEVICE(FTDI_VID, FTDI_CCSICDU40_1_PID) },
580 { USB_DEVICE(FTDI_VID, FTDI_CCSMACHX_2_PID) },
581 { USB_DEVICE(FTDI_VID, INSIDE_ACCESSO) },
582 { USB_DEVICE(INTREPID_VID, INTREPID_VALUECAN_PID) },
583 { USB_DEVICE(INTREPID_VID, INTREPID_NEOVI_PID) },
584 { USB_DEVICE(FALCOM_VID, FALCOM_TWIST_PID) },
585 { USB_DEVICE(FALCOM_VID, FALCOM_SAMBA_PID) },
586 { USB_DEVICE(FTDI_VID, FTDI_SUUNTO_SPORTS_PID) },
587 { USB_DEVICE(FTDI_VID, FTDI_OCEANIC_PID) },
588 { USB_DEVICE(TTI_VID, TTI_QL355P_PID) },
589 { USB_DEVICE(FTDI_VID, FTDI_RM_CANVIEW_PID) },
590 { USB_DEVICE(BANDB_VID, BANDB_USOTL4_PID) },
591 { USB_DEVICE(BANDB_VID, BANDB_USTL4_PID) },
592 { USB_DEVICE(BANDB_VID, BANDB_USO9ML2_PID) },
593 { USB_DEVICE(FTDI_VID, EVER_ECO_PRO_CDS) },
594 { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_1_PID) },
595 { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_2_PID) },
596 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_0_PID) },
597 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_1_PID) },
598 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_2_PID) },
599 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_3_PID) },
600 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_4_PID) },
601 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_5_PID) },
602 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_6_PID) },
603 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_7_PID) },
604 { USB_DEVICE(MOBILITY_VID, MOBILITY_USB_SERIAL_PID) },
605 { USB_DEVICE(FTDI_VID, FTDI_ACTIVE_ROBOTS_PID) },
606 { USB_DEVICE(FTDI_VID, FTDI_MHAM_KW_PID) },
607 { USB_DEVICE(FTDI_VID, FTDI_MHAM_YS_PID) },
608 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y6_PID) },
609 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y8_PID) },
610 { USB_DEVICE(FTDI_VID, FTDI_MHAM_IC_PID) },
611 { USB_DEVICE(FTDI_VID, FTDI_MHAM_DB9_PID) },
612 { USB_DEVICE(FTDI_VID, FTDI_MHAM_RS232_PID) },
613 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y9_PID) },
614 { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_VCP_PID) },
615 { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_D2XX_PID) },
616 { USB_DEVICE(EVOLUTION_VID, EVOLUTION_ER1_PID) },
617 { USB_DEVICE(EVOLUTION_VID, EVO_HYBRID_PID) },
618 { USB_DEVICE(EVOLUTION_VID, EVO_RCM4_PID) },
619 { USB_DEVICE(FTDI_VID, FTDI_ARTEMIS_PID) },
620 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16_PID) },
621 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16C_PID) },
622 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HR_PID) },
623 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HRC_PID) },
624 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16IC_PID) },
625 { USB_DEVICE(KOBIL_VID, KOBIL_CONV_B1_PID) },
626 { USB_DEVICE(KOBIL_VID, KOBIL_CONV_KAAN_PID) },
627 { USB_DEVICE(POSIFLEX_VID, POSIFLEX_PP7000_PID) },
628 { USB_DEVICE(FTDI_VID, FTDI_TTUSB_PID) },
629 { USB_DEVICE(FTDI_VID, FTDI_ECLO_COM_1WIRE_PID) },
630 { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_777_PID) },
631 { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_8900F_PID) },
632 { USB_DEVICE(FTDI_VID, FTDI_PCDJ_DAC2_PID) },
633 { USB_DEVICE(FTDI_VID, FTDI_RRCIRKITS_LOCOBUFFER_PID) },
634 { USB_DEVICE(FTDI_VID, FTDI_ASK_RDR400_PID) },
635 { USB_DEVICE(ICOM_ID1_VID, ICOM_ID1_PID) },
636 { USB_DEVICE(PAPOUCH_VID, PAPOUCH_TMU_PID) },
637 { USB_DEVICE(FTDI_VID, FTDI_ACG_HFDUAL_PID) },
638 { USB_DEVICE(FTDI_VID, FTDI_YEI_SERVOCENTER31_PID) },
639 { USB_DEVICE(FTDI_VID, FTDI_THORLABS_PID) },
640 { USB_DEVICE(TESTO_VID, TESTO_USB_INTERFACE_PID) },
641 { USB_DEVICE(FTDI_VID, FTDI_GAMMA_SCOUT_PID) },
642 { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13M_PID) },
643 { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13S_PID) },
644 { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13U_PID) },
645 { USB_DEVICE(ELEKTOR_VID, ELEKTOR_FT323R_PID) },
646 { USB_DEVICE(TELLDUS_VID, TELLDUS_TELLSTICK_PID) },
647 { USB_DEVICE(FTDI_VID, FTDI_MAXSTREAM_PID) },
648 { USB_DEVICE(FTDI_VID, FTDI_PHI_FISCO_PID) },
649 { USB_DEVICE(TML_VID, TML_USB_SERIAL_PID) },
650 { USB_DEVICE(FTDI_VID, FTDI_ELSTER_UNICOM_PID) },
651 { USB_DEVICE(FTDI_VID, FTDI_PROPOX_JTAGCABLEII_PID) },
652 { USB_DEVICE(OLIMEX_VID, OLIMEX_ARM_USB_OCD_PID),
653 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
654 { USB_DEVICE(FIC_VID, FIC_NEO1973_DEBUG_PID),
655 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
656 { USB_DEVICE(FTDI_VID, FTDI_OOCDLINK_PID),
657 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
658 { USB_DEVICE(FTDI_VID, LMI_LM3S_DEVEL_BOARD_PID),
659 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
660 { USB_DEVICE(FTDI_VID, LMI_LM3S_EVAL_BOARD_PID),
661 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
662 { USB_DEVICE(RATOC_VENDOR_ID, RATOC_PRODUCT_ID_USB60F) },
663 { USB_DEVICE(FTDI_VID, FTDI_REU_TINY_PID) },
664 { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO4x4_PID) },
665 { USB_DEVICE(FTDI_VID, FTDI_DOMINTELL_DGQG_PID) },
666 { USB_DEVICE(FTDI_VID, FTDI_DOMINTELL_DUSB_PID) },
667 { USB_DEVICE(ALTI2_VID, ALTI2_N3_PID) },
668 { USB_DEVICE(FTDI_VID, DIEBOLD_BCS_SE923_PID) },
669 { USB_DEVICE(FTDI_VID, FTDI_NDI_HUC_PID) },
670 { USB_DEVICE(ATMEL_VID, STK541_PID) },
671 { USB_DEVICE(DE_VID, STB_PID) },
672 { USB_DEVICE(DE_VID, WHT_PID) },
673 { USB_DEVICE(ADI_VID, ADI_GNICE_PID),
674 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
675 { USB_DEVICE(JETI_VID, JETI_SPC1201_PID) },
676 { USB_DEVICE(MARVELL_VID, MARVELL_SHEEVAPLUG_PID),
677 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
678 { USB_DEVICE(LARSENBRUSGAARD_VID, LB_ALTITRACK_PID) },
679 { }, /* Optional parameter entry */
680 { } /* Terminating entry */
683 MODULE_DEVICE_TABLE(usb, id_table_combined);
685 static struct usb_driver ftdi_driver = {
687 .probe = usb_serial_probe,
688 .disconnect = usb_serial_disconnect,
689 .id_table = id_table_combined,
693 static const char *ftdi_chip_name[] = {
694 [SIO] = "SIO", /* the serial part of FT8U100AX */
695 [FT8U232AM] = "FT8U232AM",
696 [FT232BM] = "FT232BM",
697 [FT2232C] = "FT2232C",
698 [FT232RL] = "FT232RL",
699 [FT2232H] = "FT2232H",
700 [FT4232H] = "FT4232H"
704 /* Constants for read urb and write urb */
709 #define THROTTLED 0x01
710 #define ACTUALLY_THROTTLED 0x02
712 /* Used for TIOCMIWAIT */
713 #define FTDI_STATUS_B0_MASK (FTDI_RS0_CTS | FTDI_RS0_DSR | FTDI_RS0_RI | FTDI_RS0_RLSD)
714 #define FTDI_STATUS_B1_MASK (FTDI_RS_BI)
717 #define FTDI_IMPL_ASYNC_FLAGS = (ASYNC_SPD_HI | ASYNC_SPD_VHI \
718 | ASYNC_SPD_CUST | ASYNC_SPD_SHI | ASYNC_SPD_WARP)
720 /* function prototypes for a FTDI serial converter */
721 static int ftdi_sio_probe(struct usb_serial *serial,
722 const struct usb_device_id *id);
723 static void ftdi_shutdown(struct usb_serial *serial);
724 static int ftdi_sio_port_probe(struct usb_serial_port *port);
725 static int ftdi_sio_port_remove(struct usb_serial_port *port);
726 static int ftdi_open(struct tty_struct *tty,
727 struct usb_serial_port *port, struct file *filp);
728 static void ftdi_close(struct usb_serial_port *port);
729 static void ftdi_dtr_rts(struct usb_serial_port *port, int on);
730 static int ftdi_write(struct tty_struct *tty, struct usb_serial_port *port,
731 const unsigned char *buf, int count);
732 static int ftdi_write_room(struct tty_struct *tty);
733 static int ftdi_chars_in_buffer(struct tty_struct *tty);
734 static void ftdi_write_bulk_callback(struct urb *urb);
735 static void ftdi_read_bulk_callback(struct urb *urb);
736 static void ftdi_process_read(struct work_struct *work);
737 static void ftdi_set_termios(struct tty_struct *tty,
738 struct usb_serial_port *port, struct ktermios *old);
739 static int ftdi_tiocmget(struct tty_struct *tty, struct file *file);
740 static int ftdi_tiocmset(struct tty_struct *tty, struct file *file,
741 unsigned int set, unsigned int clear);
742 static int ftdi_ioctl(struct tty_struct *tty, struct file *file,
743 unsigned int cmd, unsigned long arg);
744 static void ftdi_break_ctl(struct tty_struct *tty, int break_state);
745 static void ftdi_throttle(struct tty_struct *tty);
746 static void ftdi_unthrottle(struct tty_struct *tty);
748 static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base);
749 static unsigned short int ftdi_232am_baud_to_divisor(int baud);
750 static __u32 ftdi_232bm_baud_base_to_divisor(int baud, int base);
751 static __u32 ftdi_232bm_baud_to_divisor(int baud);
752 static __u32 ftdi_2232h_baud_base_to_divisor(int baud, int base);
753 static __u32 ftdi_2232h_baud_to_divisor(int baud);
755 static struct usb_serial_driver ftdi_sio_device = {
757 .owner = THIS_MODULE,
760 .description = "FTDI USB Serial Device",
761 .usb_driver = &ftdi_driver ,
762 .id_table = id_table_combined,
764 .probe = ftdi_sio_probe,
765 .port_probe = ftdi_sio_port_probe,
766 .port_remove = ftdi_sio_port_remove,
769 .dtr_rts = ftdi_dtr_rts,
770 .throttle = ftdi_throttle,
771 .unthrottle = ftdi_unthrottle,
773 .write_room = ftdi_write_room,
774 .chars_in_buffer = ftdi_chars_in_buffer,
775 .read_bulk_callback = ftdi_read_bulk_callback,
776 .write_bulk_callback = ftdi_write_bulk_callback,
777 .tiocmget = ftdi_tiocmget,
778 .tiocmset = ftdi_tiocmset,
780 .set_termios = ftdi_set_termios,
781 .break_ctl = ftdi_break_ctl,
782 .shutdown = ftdi_shutdown,
786 #define WDR_TIMEOUT 5000 /* default urb timeout */
787 #define WDR_SHORT_TIMEOUT 1000 /* shorter urb timeout */
789 /* High and low are for DTR, RTS etc etc */
793 /* number of outstanding urbs to prevent userspace DoS from happening */
794 #define URB_UPPER_LIMIT 42
797 * ***************************************************************************
799 * ***************************************************************************
802 static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base)
804 unsigned short int divisor;
805 /* divisor shifted 3 bits to the left */
806 int divisor3 = base / 2 / baud;
807 if ((divisor3 & 0x7) == 7)
808 divisor3++; /* round x.7/8 up to x+1 */
809 divisor = divisor3 >> 3;
813 else if (divisor3 >= 4)
815 else if (divisor3 != 0)
817 else if (divisor == 1)
818 divisor = 0; /* special case for maximum baud rate */
822 static unsigned short int ftdi_232am_baud_to_divisor(int baud)
824 return ftdi_232am_baud_base_to_divisor(baud, 48000000);
827 static __u32 ftdi_232bm_baud_base_to_divisor(int baud, int base)
829 static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
831 /* divisor shifted 3 bits to the left */
832 int divisor3 = base / 2 / baud;
833 divisor = divisor3 >> 3;
834 divisor |= (__u32)divfrac[divisor3 & 0x7] << 14;
835 /* Deal with special cases for highest baud rates. */
838 else if (divisor == 0x4001)
843 static __u32 ftdi_232bm_baud_to_divisor(int baud)
845 return ftdi_232bm_baud_base_to_divisor(baud, 48000000);
848 static __u32 ftdi_2232h_baud_base_to_divisor(int baud, int base)
850 static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
854 /* hi-speed baud rate is 10-bit sampling instead of 16-bit */
855 divisor3 = (base / 10 / baud) * 8;
857 divisor = divisor3 >> 3;
858 divisor |= (__u32)divfrac[divisor3 & 0x7] << 14;
859 /* Deal with special cases for highest baud rates. */
862 else if (divisor == 0x4001)
865 * Set this bit to turn off a divide by 2.5 on baud rate generator
866 * This enables baud rates up to 12Mbaud but cannot reach below 1200
867 * baud with this bit set
869 divisor |= 0x00020000;
873 static __u32 ftdi_2232h_baud_to_divisor(int baud)
875 return ftdi_2232h_baud_base_to_divisor(baud, 120000000);
878 #define set_mctrl(port, set) update_mctrl((port), (set), 0)
879 #define clear_mctrl(port, clear) update_mctrl((port), 0, (clear))
881 static int update_mctrl(struct usb_serial_port *port, unsigned int set,
884 struct ftdi_private *priv = usb_get_serial_port_data(port);
889 if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
890 dbg("%s - DTR|RTS not being set|cleared", __func__);
891 return 0; /* no change */
894 buf = kmalloc(1, GFP_NOIO);
898 clear &= ~set; /* 'set' takes precedence over 'clear' */
900 if (clear & TIOCM_DTR)
901 urb_value |= FTDI_SIO_SET_DTR_LOW;
902 if (clear & TIOCM_RTS)
903 urb_value |= FTDI_SIO_SET_RTS_LOW;
905 urb_value |= FTDI_SIO_SET_DTR_HIGH;
907 urb_value |= FTDI_SIO_SET_RTS_HIGH;
908 rv = usb_control_msg(port->serial->dev,
909 usb_sndctrlpipe(port->serial->dev, 0),
910 FTDI_SIO_SET_MODEM_CTRL_REQUEST,
911 FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE,
912 urb_value, priv->interface,
913 buf, 0, WDR_TIMEOUT);
917 dbg("%s Error from MODEM_CTRL urb: DTR %s, RTS %s",
919 (set & TIOCM_DTR) ? "HIGH" :
920 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
921 (set & TIOCM_RTS) ? "HIGH" :
922 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
924 dbg("%s - DTR %s, RTS %s", __func__,
925 (set & TIOCM_DTR) ? "HIGH" :
926 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
927 (set & TIOCM_RTS) ? "HIGH" :
928 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
929 /* FIXME: locking on last_dtr_rts */
930 priv->last_dtr_rts = (priv->last_dtr_rts & ~clear) | set;
936 static __u32 get_ftdi_divisor(struct tty_struct *tty,
937 struct usb_serial_port *port)
938 { /* get_ftdi_divisor */
939 struct ftdi_private *priv = usb_get_serial_port_data(port);
945 * The logic involved in setting the baudrate can be cleanly split into
947 * 1. Standard baud rates are set in tty->termios->c_cflag
948 * 2. If these are not enough, you can set any speed using alt_speed as
950 * - set tty->termios->c_cflag speed to B38400
951 * - set your real speed in tty->alt_speed; it gets ignored when
953 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as
955 * flags & ASYNC_SPD_MASK == ASYNC_SPD_[HI, VHI, SHI, WARP],
956 * this just sets alt_speed to (HI: 57600, VHI: 115200,
957 * SHI: 230400, WARP: 460800)
958 * ** Steps 1, 2 are done courtesy of tty_get_baud_rate
959 * 3. You can also set baud rate by setting custom divisor as follows
960 * - set tty->termios->c_cflag speed to B38400
961 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as
963 * o flags & ASYNC_SPD_MASK == ASYNC_SPD_CUST
964 * o custom_divisor set to baud_base / your_new_baudrate
965 * ** Step 3 is done courtesy of code borrowed from serial.c
966 * I should really spend some time and separate + move this common
967 * code to serial.c, it is replicated in nearly every serial driver
971 /* 1. Get the baud rate from the tty settings, this observes
974 baud = tty_get_baud_rate(tty);
975 dbg("%s - tty_get_baud_rate reports speed %d", __func__, baud);
977 /* 2. Observe async-compatible custom_divisor hack, update baudrate
981 ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
982 (priv->custom_divisor)) {
983 baud = priv->baud_base / priv->custom_divisor;
984 dbg("%s - custom divisor %d sets baud rate to %d",
985 __func__, priv->custom_divisor, baud);
988 /* 3. Convert baudrate to device-specific divisor */
992 switch (priv->chip_type) {
993 case SIO: /* SIO chip */
995 case 300: div_value = ftdi_sio_b300; break;
996 case 600: div_value = ftdi_sio_b600; break;
997 case 1200: div_value = ftdi_sio_b1200; break;
998 case 2400: div_value = ftdi_sio_b2400; break;
999 case 4800: div_value = ftdi_sio_b4800; break;
1000 case 9600: div_value = ftdi_sio_b9600; break;
1001 case 19200: div_value = ftdi_sio_b19200; break;
1002 case 38400: div_value = ftdi_sio_b38400; break;
1003 case 57600: div_value = ftdi_sio_b57600; break;
1004 case 115200: div_value = ftdi_sio_b115200; break;
1006 if (div_value == 0) {
1007 dbg("%s - Baudrate (%d) requested is not supported",
1009 div_value = ftdi_sio_b9600;
1014 case FT8U232AM: /* 8U232AM chip */
1015 if (baud <= 3000000) {
1016 div_value = ftdi_232am_baud_to_divisor(baud);
1018 dbg("%s - Baud rate too high!", __func__);
1020 div_value = ftdi_232am_baud_to_divisor(9600);
1024 case FT232BM: /* FT232BM chip */
1025 case FT2232C: /* FT2232C chip */
1027 if (baud <= 3000000) {
1028 div_value = ftdi_232bm_baud_to_divisor(baud);
1030 dbg("%s - Baud rate too high!", __func__);
1031 div_value = ftdi_232bm_baud_to_divisor(9600);
1036 case FT2232H: /* FT2232H chip */
1037 case FT4232H: /* FT4232H chip */
1038 if ((baud <= 12000000) & (baud >= 1200)) {
1039 div_value = ftdi_2232h_baud_to_divisor(baud);
1040 } else if (baud < 1200) {
1041 div_value = ftdi_232bm_baud_to_divisor(baud);
1043 dbg("%s - Baud rate too high!", __func__);
1044 div_value = ftdi_232bm_baud_to_divisor(9600);
1049 } /* priv->chip_type */
1052 dbg("%s - Baud rate set to %d (divisor 0x%lX) on chip %s",
1053 __func__, baud, (unsigned long)div_value,
1054 ftdi_chip_name[priv->chip_type]);
1057 tty_encode_baud_rate(tty, baud, baud);
1061 static int change_speed(struct tty_struct *tty, struct usb_serial_port *port)
1063 struct ftdi_private *priv = usb_get_serial_port_data(port);
1067 __u32 urb_index_value;
1070 buf = kmalloc(1, GFP_NOIO);
1074 urb_index_value = get_ftdi_divisor(tty, port);
1075 urb_value = (__u16)urb_index_value;
1076 urb_index = (__u16)(urb_index_value >> 16);
1077 if (priv->interface) { /* FT2232C */
1078 urb_index = (__u16)((urb_index << 8) | priv->interface);
1081 rv = usb_control_msg(port->serial->dev,
1082 usb_sndctrlpipe(port->serial->dev, 0),
1083 FTDI_SIO_SET_BAUDRATE_REQUEST,
1084 FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE,
1085 urb_value, urb_index,
1086 buf, 0, WDR_SHORT_TIMEOUT);
1092 static int write_latency_timer(struct usb_serial_port *port)
1094 struct ftdi_private *priv = usb_get_serial_port_data(port);
1095 struct usb_device *udev = port->serial->dev;
1098 int l = priv->latency;
1100 if (priv->flags & ASYNC_LOW_LATENCY)
1103 dbg("%s: setting latency timer = %i", __func__, l);
1105 rv = usb_control_msg(udev,
1106 usb_sndctrlpipe(udev, 0),
1107 FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
1108 FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
1110 buf, 0, WDR_TIMEOUT);
1113 dev_err(&port->dev, "Unable to write latency timer: %i\n", rv);
1117 static int read_latency_timer(struct usb_serial_port *port)
1119 struct ftdi_private *priv = usb_get_serial_port_data(port);
1120 struct usb_device *udev = port->serial->dev;
1121 unsigned short latency = 0;
1125 dbg("%s", __func__);
1127 rv = usb_control_msg(udev,
1128 usb_rcvctrlpipe(udev, 0),
1129 FTDI_SIO_GET_LATENCY_TIMER_REQUEST,
1130 FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE,
1132 (char *) &latency, 1, WDR_TIMEOUT);
1135 dev_err(&port->dev, "Unable to read latency timer: %i\n", rv);
1141 static int get_serial_info(struct usb_serial_port *port,
1142 struct serial_struct __user *retinfo)
1144 struct ftdi_private *priv = usb_get_serial_port_data(port);
1145 struct serial_struct tmp;
1149 memset(&tmp, 0, sizeof(tmp));
1150 tmp.flags = priv->flags;
1151 tmp.baud_base = priv->baud_base;
1152 tmp.custom_divisor = priv->custom_divisor;
1153 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
1156 } /* get_serial_info */
1159 static int set_serial_info(struct tty_struct *tty,
1160 struct usb_serial_port *port, struct serial_struct __user *newinfo)
1161 { /* set_serial_info */
1162 struct ftdi_private *priv = usb_get_serial_port_data(port);
1163 struct serial_struct new_serial;
1164 struct ftdi_private old_priv;
1166 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
1172 /* Do error checking and permission checking */
1174 if (!capable(CAP_SYS_ADMIN)) {
1175 if (((new_serial.flags & ~ASYNC_USR_MASK) !=
1176 (priv->flags & ~ASYNC_USR_MASK))) {
1180 priv->flags = ((priv->flags & ~ASYNC_USR_MASK) |
1181 (new_serial.flags & ASYNC_USR_MASK));
1182 priv->custom_divisor = new_serial.custom_divisor;
1183 goto check_and_exit;
1186 if ((new_serial.baud_base != priv->baud_base) &&
1187 (new_serial.baud_base < 9600)) {
1192 /* Make the changes - these are privileged changes! */
1194 priv->flags = ((priv->flags & ~ASYNC_FLAGS) |
1195 (new_serial.flags & ASYNC_FLAGS));
1196 priv->custom_divisor = new_serial.custom_divisor;
1198 tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
1199 write_latency_timer(port);
1202 if ((old_priv.flags & ASYNC_SPD_MASK) !=
1203 (priv->flags & ASYNC_SPD_MASK)) {
1204 if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_HI)
1205 tty->alt_speed = 57600;
1206 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_VHI)
1207 tty->alt_speed = 115200;
1208 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_SHI)
1209 tty->alt_speed = 230400;
1210 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_WARP)
1211 tty->alt_speed = 460800;
1215 if (((old_priv.flags & ASYNC_SPD_MASK) !=
1216 (priv->flags & ASYNC_SPD_MASK)) ||
1217 (((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
1218 (old_priv.custom_divisor != priv->custom_divisor))) {
1220 change_speed(tty, port);
1226 } /* set_serial_info */
1229 /* Determine type of FTDI chip based on USB config and descriptor. */
1230 static void ftdi_determine_type(struct usb_serial_port *port)
1232 struct ftdi_private *priv = usb_get_serial_port_data(port);
1233 struct usb_serial *serial = port->serial;
1234 struct usb_device *udev = serial->dev;
1236 unsigned interfaces;
1238 /* Assume it is not the original SIO device for now. */
1239 priv->baud_base = 48000000 / 2;
1240 priv->write_offset = 0;
1242 version = le16_to_cpu(udev->descriptor.bcdDevice);
1243 interfaces = udev->actconfig->desc.bNumInterfaces;
1244 dbg("%s: bcdDevice = 0x%x, bNumInterfaces = %u", __func__,
1245 version, interfaces);
1246 if (interfaces > 1) {
1249 /* Multiple interfaces.*/
1250 if (version == 0x0800) {
1251 priv->chip_type = FT4232H;
1252 /* Hi-speed - baud clock runs at 120MHz */
1253 priv->baud_base = 120000000 / 2;
1254 } else if (version == 0x0700) {
1255 priv->chip_type = FT2232H;
1256 /* Hi-speed - baud clock runs at 120MHz */
1257 priv->baud_base = 120000000 / 2;
1259 priv->chip_type = FT2232C;
1261 /* Determine interface code. */
1262 inter = serial->interface->altsetting->desc.bInterfaceNumber;
1264 priv->interface = INTERFACE_A;
1265 } else if (inter == 1) {
1266 priv->interface = INTERFACE_B;
1267 } else if (inter == 2) {
1268 priv->interface = INTERFACE_C;
1269 } else if (inter == 3) {
1270 priv->interface = INTERFACE_D;
1272 /* BM-type devices have a bug where bcdDevice gets set
1273 * to 0x200 when iSerialNumber is 0. */
1274 if (version < 0x500) {
1275 dbg("%s: something fishy - bcdDevice too low for multi-interface device",
1278 } else if (version < 0x200) {
1279 /* Old device. Assume its the original SIO. */
1280 priv->chip_type = SIO;
1281 priv->baud_base = 12000000 / 16;
1282 priv->write_offset = 1;
1283 } else if (version < 0x400) {
1284 /* Assume its an FT8U232AM (or FT8U245AM) */
1285 /* (It might be a BM because of the iSerialNumber bug,
1286 * but it will still work as an AM device.) */
1287 priv->chip_type = FT8U232AM;
1288 } else if (version < 0x600) {
1289 /* Assume its an FT232BM (or FT245BM) */
1290 priv->chip_type = FT232BM;
1292 /* Assume its an FT232R */
1293 priv->chip_type = FT232RL;
1295 dev_info(&udev->dev, "Detected %s\n", ftdi_chip_name[priv->chip_type]);
1300 * ***************************************************************************
1302 * ***************************************************************************
1305 static ssize_t show_latency_timer(struct device *dev,
1306 struct device_attribute *attr, char *buf)
1308 struct usb_serial_port *port = to_usb_serial_port(dev);
1309 struct ftdi_private *priv = usb_get_serial_port_data(port);
1310 if (priv->flags & ASYNC_LOW_LATENCY)
1311 return sprintf(buf, "1\n");
1313 return sprintf(buf, "%i\n", priv->latency);
1317 /* Write a new value of the latency timer, in units of milliseconds. */
1318 static ssize_t store_latency_timer(struct device *dev,
1319 struct device_attribute *attr, const char *valbuf,
1322 struct usb_serial_port *port = to_usb_serial_port(dev);
1323 struct ftdi_private *priv = usb_get_serial_port_data(port);
1324 int v = simple_strtoul(valbuf, NULL, 10);
1328 rv = write_latency_timer(port);
1334 /* Write an event character directly to the FTDI register. The ASCII
1335 value is in the low 8 bits, with the enable bit in the 9th bit. */
1336 static ssize_t store_event_char(struct device *dev,
1337 struct device_attribute *attr, const char *valbuf, size_t count)
1339 struct usb_serial_port *port = to_usb_serial_port(dev);
1340 struct ftdi_private *priv = usb_get_serial_port_data(port);
1341 struct usb_device *udev = port->serial->dev;
1343 int v = simple_strtoul(valbuf, NULL, 10);
1346 dbg("%s: setting event char = %i", __func__, v);
1348 rv = usb_control_msg(udev,
1349 usb_sndctrlpipe(udev, 0),
1350 FTDI_SIO_SET_EVENT_CHAR_REQUEST,
1351 FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE,
1353 buf, 0, WDR_TIMEOUT);
1356 dbg("Unable to write event character: %i", rv);
1363 static DEVICE_ATTR(latency_timer, S_IWUSR | S_IRUGO, show_latency_timer,
1364 store_latency_timer);
1365 static DEVICE_ATTR(event_char, S_IWUSR, NULL, store_event_char);
1367 static int create_sysfs_attrs(struct usb_serial_port *port)
1369 struct ftdi_private *priv = usb_get_serial_port_data(port);
1372 dbg("%s", __func__);
1374 /* XXX I've no idea if the original SIO supports the event_char
1375 * sysfs parameter, so I'm playing it safe. */
1376 if (priv->chip_type != SIO) {
1377 dbg("sysfs attributes for %s", ftdi_chip_name[priv->chip_type]);
1378 retval = device_create_file(&port->dev, &dev_attr_event_char);
1380 (priv->chip_type == FT232BM ||
1381 priv->chip_type == FT2232C ||
1382 priv->chip_type == FT232RL ||
1383 priv->chip_type == FT2232H ||
1384 priv->chip_type == FT4232H)) {
1385 retval = device_create_file(&port->dev,
1386 &dev_attr_latency_timer);
1392 static void remove_sysfs_attrs(struct usb_serial_port *port)
1394 struct ftdi_private *priv = usb_get_serial_port_data(port);
1396 dbg("%s", __func__);
1398 /* XXX see create_sysfs_attrs */
1399 if (priv->chip_type != SIO) {
1400 device_remove_file(&port->dev, &dev_attr_event_char);
1401 if (priv->chip_type == FT232BM ||
1402 priv->chip_type == FT2232C ||
1403 priv->chip_type == FT232RL ||
1404 priv->chip_type == FT2232H ||
1405 priv->chip_type == FT4232H) {
1406 device_remove_file(&port->dev, &dev_attr_latency_timer);
1413 * ***************************************************************************
1414 * FTDI driver specific functions
1415 * ***************************************************************************
1418 /* Probe function to check for special devices */
1419 static int ftdi_sio_probe(struct usb_serial *serial,
1420 const struct usb_device_id *id)
1422 struct ftdi_sio_quirk *quirk =
1423 (struct ftdi_sio_quirk *)id->driver_info;
1425 if (quirk && quirk->probe) {
1426 int ret = quirk->probe(serial);
1431 usb_set_serial_data(serial, (void *)id->driver_info);
1436 static int ftdi_sio_port_probe(struct usb_serial_port *port)
1438 struct ftdi_private *priv;
1439 struct ftdi_sio_quirk *quirk = usb_get_serial_data(port->serial);
1442 dbg("%s", __func__);
1444 priv = kzalloc(sizeof(struct ftdi_private), GFP_KERNEL);
1446 dev_err(&port->dev, "%s- kmalloc(%Zd) failed.\n", __func__,
1447 sizeof(struct ftdi_private));
1451 kref_init(&priv->kref);
1452 spin_lock_init(&priv->rx_lock);
1453 spin_lock_init(&priv->tx_lock);
1454 init_waitqueue_head(&priv->delta_msr_wait);
1455 /* This will push the characters through immediately rather
1456 than queue a task to deliver them */
1457 priv->flags = ASYNC_LOW_LATENCY;
1459 if (quirk && quirk->port_probe)
1460 quirk->port_probe(priv);
1462 /* Increase the size of read buffers */
1463 kfree(port->bulk_in_buffer);
1464 port->bulk_in_buffer = kmalloc(BUFSZ, GFP_KERNEL);
1465 if (!port->bulk_in_buffer) {
1469 if (port->read_urb) {
1470 port->read_urb->transfer_buffer = port->bulk_in_buffer;
1471 port->read_urb->transfer_buffer_length = BUFSZ;
1474 INIT_DELAYED_WORK(&priv->rx_work, ftdi_process_read);
1477 /* Free port's existing write urb and transfer buffer. */
1478 if (port->write_urb) {
1479 usb_free_urb(port->write_urb);
1480 port->write_urb = NULL;
1482 kfree(port->bulk_out_buffer);
1483 port->bulk_out_buffer = NULL;
1485 usb_set_serial_port_data(port, priv);
1487 ftdi_determine_type(port);
1488 read_latency_timer(port);
1489 create_sysfs_attrs(port);
1493 /* Setup for the USB-UIRT device, which requires hardwired
1494 * baudrate (38400 gets mapped to 312500) */
1495 /* Called from usbserial:serial_probe */
1496 static void ftdi_USB_UIRT_setup(struct ftdi_private *priv)
1498 dbg("%s", __func__);
1500 priv->flags |= ASYNC_SPD_CUST;
1501 priv->custom_divisor = 77;
1502 priv->force_baud = 38400;
1503 } /* ftdi_USB_UIRT_setup */
1505 /* Setup for the HE-TIRA1 device, which requires hardwired
1506 * baudrate (38400 gets mapped to 100000) and RTS-CTS enabled. */
1508 static void ftdi_HE_TIRA1_setup(struct ftdi_private *priv)
1510 dbg("%s", __func__);
1512 priv->flags |= ASYNC_SPD_CUST;
1513 priv->custom_divisor = 240;
1514 priv->force_baud = 38400;
1515 priv->force_rtscts = 1;
1516 } /* ftdi_HE_TIRA1_setup */
1519 * First port on JTAG adaptors such as Olimex arm-usb-ocd or the FIC/OpenMoko
1520 * Neo1973 Debug Board is reserved for JTAG interface and can be accessed from
1521 * userspace using openocd.
1523 static int ftdi_jtag_probe(struct usb_serial *serial)
1525 struct usb_device *udev = serial->dev;
1526 struct usb_interface *interface = serial->interface;
1528 dbg("%s", __func__);
1530 if (interface == udev->actconfig->interface[0]) {
1531 dev_info(&udev->dev,
1532 "Ignoring serial port reserved for JTAG\n");
1540 * The Matrix Orbital VK204-25-USB has an invalid IN endpoint.
1541 * We have to correct it if we want to read from it.
1543 static int ftdi_mtxorb_hack_setup(struct usb_serial *serial)
1545 struct usb_host_endpoint *ep = serial->dev->ep_in[1];
1546 struct usb_endpoint_descriptor *ep_desc = &ep->desc;
1548 if (ep->enabled && ep_desc->wMaxPacketSize == 0) {
1549 ep_desc->wMaxPacketSize = cpu_to_le16(0x40);
1550 dev_info(&serial->dev->dev,
1551 "Fixing invalid wMaxPacketSize on read pipe\n");
1557 /* ftdi_shutdown is called from usbserial:usb_serial_disconnect
1558 * it is called when the usb device is disconnected
1560 * usbserial:usb_serial_disconnect
1561 * calls __serial_close for each open of the port
1562 * shutdown is called then (ie ftdi_shutdown)
1564 static void ftdi_shutdown(struct usb_serial *serial)
1566 dbg("%s", __func__);
1569 static void ftdi_sio_priv_release(struct kref *k)
1571 struct ftdi_private *priv = container_of(k, struct ftdi_private, kref);
1576 static int ftdi_sio_port_remove(struct usb_serial_port *port)
1578 struct ftdi_private *priv = usb_get_serial_port_data(port);
1580 dbg("%s", __func__);
1582 remove_sysfs_attrs(port);
1584 kref_put(&priv->kref, ftdi_sio_priv_release);
1589 static int ftdi_open(struct tty_struct *tty,
1590 struct usb_serial_port *port, struct file *filp)
1592 struct usb_device *dev = port->serial->dev;
1593 struct ftdi_private *priv = usb_get_serial_port_data(port);
1594 unsigned long flags;
1597 char buf[1]; /* Needed for the usb_control_msg I think */
1599 dbg("%s", __func__);
1601 spin_lock_irqsave(&priv->tx_lock, flags);
1603 spin_unlock_irqrestore(&priv->tx_lock, flags);
1604 spin_lock_irqsave(&priv->rx_lock, flags);
1606 spin_unlock_irqrestore(&priv->rx_lock, flags);
1609 tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
1611 write_latency_timer(port);
1613 /* No error checking for this (will get errors later anyway) */
1614 /* See ftdi_sio.h for description of what is reset */
1615 usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1616 FTDI_SIO_RESET_REQUEST, FTDI_SIO_RESET_REQUEST_TYPE,
1618 priv->interface, buf, 0, WDR_TIMEOUT);
1620 /* Termios defaults are set by usb_serial_init. We don't change
1621 port->tty->termios - this would lose speed settings, etc.
1622 This is same behaviour as serial.c/rs_open() - Kuba */
1624 /* ftdi_set_termios will send usb control messages */
1626 ftdi_set_termios(tty, port, tty->termios);
1629 spin_lock_irqsave(&priv->rx_lock, flags);
1630 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
1631 spin_unlock_irqrestore(&priv->rx_lock, flags);
1633 /* Start reading from the device */
1634 priv->rx_processed = 0;
1635 usb_fill_bulk_urb(port->read_urb, dev,
1636 usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress),
1637 port->read_urb->transfer_buffer,
1638 port->read_urb->transfer_buffer_length,
1639 ftdi_read_bulk_callback, port);
1640 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
1643 "%s - failed submitting read urb, error %d\n",
1646 kref_get(&priv->kref);
1652 static void ftdi_dtr_rts(struct usb_serial_port *port, int on)
1654 struct ftdi_private *priv = usb_get_serial_port_data(port);
1657 mutex_lock(&port->serial->disc_mutex);
1658 if (!port->serial->disconnected) {
1659 /* Disable flow control */
1660 if (!on && usb_control_msg(port->serial->dev,
1661 usb_sndctrlpipe(port->serial->dev, 0),
1662 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1663 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1664 0, priv->interface, buf, 0,
1666 dev_err(&port->dev, "error from flowcontrol urb\n");
1668 /* drop RTS and DTR */
1670 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1672 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1674 mutex_unlock(&port->serial->disc_mutex);
1678 * usbserial:__serial_close only calls ftdi_close if the point is open
1680 * This only gets called when it is the last close
1685 static void ftdi_close(struct usb_serial_port *port)
1687 struct ftdi_private *priv = usb_get_serial_port_data(port);
1689 dbg("%s", __func__);
1692 /* cancel any scheduled reading */
1693 cancel_delayed_work_sync(&priv->rx_work);
1695 /* shutdown our bulk read */
1696 usb_kill_urb(port->read_urb);
1697 kref_put(&priv->kref, ftdi_sio_priv_release);
1702 /* The SIO requires the first byte to have:
1705 * B2..7 length of message excluding byte 0
1707 * The new devices do not require this byte
1709 static int ftdi_write(struct tty_struct *tty, struct usb_serial_port *port,
1710 const unsigned char *buf, int count)
1712 struct ftdi_private *priv = usb_get_serial_port_data(port);
1714 unsigned char *buffer;
1715 int data_offset ; /* will be 1 for the SIO and 0 otherwise */
1718 unsigned long flags;
1720 dbg("%s port %d, %d bytes", __func__, port->number, count);
1723 dbg("write request of 0 bytes");
1726 spin_lock_irqsave(&priv->tx_lock, flags);
1727 if (priv->tx_outstanding_urbs > URB_UPPER_LIMIT) {
1728 spin_unlock_irqrestore(&priv->tx_lock, flags);
1729 dbg("%s - write limit hit\n", __func__);
1732 priv->tx_outstanding_urbs++;
1733 spin_unlock_irqrestore(&priv->tx_lock, flags);
1735 data_offset = priv->write_offset;
1736 dbg("data_offset set to %d", data_offset);
1738 /* Determine total transfer size */
1739 transfer_size = count;
1740 if (data_offset > 0) {
1741 /* Original sio needs control bytes too... */
1742 transfer_size += (data_offset *
1743 ((count + (PKTSZ - 1 - data_offset)) /
1744 (PKTSZ - data_offset)));
1747 buffer = kmalloc(transfer_size, GFP_ATOMIC);
1750 "%s ran out of kernel memory for urb ...\n", __func__);
1752 goto error_no_buffer;
1755 urb = usb_alloc_urb(0, GFP_ATOMIC);
1757 dev_err(&port->dev, "%s - no more free urbs\n", __func__);
1763 if (data_offset > 0) {
1764 /* Original sio requires control byte at start of
1766 int user_pktsz = PKTSZ - data_offset;
1768 unsigned char *first_byte = buffer;
1769 const unsigned char *current_position = buf;
1772 if (user_pktsz > todo)
1774 /* Write the control byte at the front of the packet*/
1775 *first_byte = 1 | ((user_pktsz) << 2);
1776 /* Copy data for packet */
1777 memcpy(first_byte + data_offset,
1778 current_position, user_pktsz);
1779 first_byte += user_pktsz + data_offset;
1780 current_position += user_pktsz;
1784 /* No control byte required. */
1785 /* Copy in the data to send */
1786 memcpy(buffer, buf, count);
1789 usb_serial_debug_data(debug, &port->dev, __func__,
1790 transfer_size, buffer);
1792 /* fill the buffer and send it */
1793 usb_fill_bulk_urb(urb, port->serial->dev,
1794 usb_sndbulkpipe(port->serial->dev,
1795 port->bulk_out_endpointAddress),
1796 buffer, transfer_size,
1797 ftdi_write_bulk_callback, port);
1799 status = usb_submit_urb(urb, GFP_ATOMIC);
1802 "%s - failed submitting write urb, error %d\n",
1807 spin_lock_irqsave(&priv->tx_lock, flags);
1808 priv->tx_outstanding_bytes += count;
1809 priv->tx_bytes += count;
1810 spin_unlock_irqrestore(&priv->tx_lock, flags);
1813 /* we are done with this urb, so let the host driver
1814 * really free it when it is finished with it */
1817 dbg("%s write returning: %d", __func__, count);
1824 spin_lock_irqsave(&priv->tx_lock, flags);
1825 priv->tx_outstanding_urbs--;
1826 spin_unlock_irqrestore(&priv->tx_lock, flags);
1831 /* This function may get called when the device is closed */
1833 static void ftdi_write_bulk_callback(struct urb *urb)
1835 unsigned long flags;
1836 struct usb_serial_port *port = urb->context;
1837 struct ftdi_private *priv;
1838 int data_offset; /* will be 1 for the SIO and 0 otherwise */
1839 unsigned long countback;
1840 int status = urb->status;
1842 /* free up the transfer buffer, as usb_free_urb() does not do this */
1843 kfree(urb->transfer_buffer);
1845 dbg("%s - port %d", __func__, port->number);
1848 dbg("nonzero write bulk status received: %d", status);
1852 priv = usb_get_serial_port_data(port);
1854 dbg("%s - bad port private data pointer - exiting", __func__);
1857 /* account for transferred data */
1858 countback = urb->actual_length;
1859 data_offset = priv->write_offset;
1860 if (data_offset > 0) {
1861 /* Subtract the control bytes */
1862 countback -= (data_offset * DIV_ROUND_UP(countback, PKTSZ));
1864 spin_lock_irqsave(&priv->tx_lock, flags);
1865 --priv->tx_outstanding_urbs;
1866 priv->tx_outstanding_bytes -= countback;
1867 spin_unlock_irqrestore(&priv->tx_lock, flags);
1869 usb_serial_port_softint(port);
1870 } /* ftdi_write_bulk_callback */
1873 static int ftdi_write_room(struct tty_struct *tty)
1875 struct usb_serial_port *port = tty->driver_data;
1876 struct ftdi_private *priv = usb_get_serial_port_data(port);
1878 unsigned long flags;
1880 dbg("%s - port %d", __func__, port->number);
1882 spin_lock_irqsave(&priv->tx_lock, flags);
1883 if (priv->tx_outstanding_urbs < URB_UPPER_LIMIT) {
1885 * We really can take anything the user throws at us
1886 * but let's pick a nice big number to tell the tty
1887 * layer that we have lots of free space
1893 spin_unlock_irqrestore(&priv->tx_lock, flags);
1897 static int ftdi_chars_in_buffer(struct tty_struct *tty)
1899 struct usb_serial_port *port = tty->driver_data;
1900 struct ftdi_private *priv = usb_get_serial_port_data(port);
1902 unsigned long flags;
1904 dbg("%s - port %d", __func__, port->number);
1906 spin_lock_irqsave(&priv->tx_lock, flags);
1907 buffered = (int)priv->tx_outstanding_bytes;
1908 spin_unlock_irqrestore(&priv->tx_lock, flags);
1910 dev_err(&port->dev, "%s outstanding tx bytes is negative!\n",
1917 static void ftdi_read_bulk_callback(struct urb *urb)
1919 struct usb_serial_port *port = urb->context;
1920 struct tty_struct *tty;
1921 struct ftdi_private *priv;
1922 unsigned long countread;
1923 unsigned long flags;
1924 int status = urb->status;
1926 if (urb->number_of_packets > 0) {
1927 dev_err(&port->dev, "%s transfer_buffer_length %d "
1928 "actual_length %d number of packets %d\n", __func__,
1929 urb->transfer_buffer_length,
1930 urb->actual_length, urb->number_of_packets);
1931 dev_err(&port->dev, "%s transfer_flags %x\n", __func__,
1932 urb->transfer_flags);
1935 dbg("%s - port %d", __func__, port->number);
1937 if (port->port.count <= 0)
1940 tty = tty_port_tty_get(&port->port);
1942 dbg("%s - bad tty pointer - exiting", __func__);
1946 priv = usb_get_serial_port_data(port);
1948 dbg("%s - bad port private data pointer - exiting", __func__);
1952 if (urb != port->read_urb)
1953 dev_err(&port->dev, "%s - Not my urb!\n", __func__);
1956 /* This will happen at close every time so it is a dbg not an
1958 dbg("(this is ok on close) nonzero read bulk status received: %d", status);
1962 /* count data bytes, but not status bytes */
1963 countread = urb->actual_length;
1964 countread -= 2 * DIV_ROUND_UP(countread, PKTSZ);
1965 spin_lock_irqsave(&priv->rx_lock, flags);
1966 priv->rx_bytes += countread;
1967 spin_unlock_irqrestore(&priv->rx_lock, flags);
1969 ftdi_process_read(&priv->rx_work.work);
1972 } /* ftdi_read_bulk_callback */
1975 static void ftdi_process_read(struct work_struct *work)
1976 { /* ftdi_process_read */
1977 struct ftdi_private *priv =
1978 container_of(work, struct ftdi_private, rx_work.work);
1979 struct usb_serial_port *port = priv->port;
1981 struct tty_struct *tty;
1983 unsigned char *data;
1989 unsigned long flags;
1991 dbg("%s - port %d", __func__, port->number);
1993 if (port->port.count <= 0)
1996 tty = tty_port_tty_get(&port->port);
1998 dbg("%s - bad tty pointer - exiting", __func__);
2002 priv = usb_get_serial_port_data(port);
2004 dbg("%s - bad port private data pointer - exiting", __func__);
2008 urb = port->read_urb;
2010 dbg("%s - bad read_urb pointer - exiting", __func__);
2014 data = urb->transfer_buffer;
2016 if (priv->rx_processed) {
2017 dbg("%s - already processed: %d bytes, %d remain", __func__,
2019 urb->actual_length - priv->rx_processed);
2021 /* The first two bytes of every read packet are status */
2022 if (urb->actual_length > 2)
2023 usb_serial_debug_data(debug, &port->dev, __func__,
2024 urb->actual_length, data);
2026 dbg("Status only: %03oo %03oo", data[0], data[1]);
2030 /* TO DO -- check for hung up line and handle appropriately: */
2032 /* See acm.c - you do a tty_hangup - eg tty_hangup(tty) */
2033 /* if CD is dropped and the line is not CLOCAL then we should hangup */
2036 for (packet_offset = priv->rx_processed;
2037 packet_offset < urb->actual_length; packet_offset += PKTSZ) {
2040 /* Compare new line status to the old one, signal if different/
2041 N.B. packet may be processed more than once, but differences
2042 are only processed once. */
2043 char new_status = data[packet_offset + 0] &
2044 FTDI_STATUS_B0_MASK;
2045 if (new_status != priv->prev_status) {
2046 priv->diff_status |=
2047 new_status ^ priv->prev_status;
2048 wake_up_interruptible(&priv->delta_msr_wait);
2049 priv->prev_status = new_status;
2052 length = min_t(u32, PKTSZ, urb->actual_length-packet_offset)-2;
2054 dev_err(&port->dev, "%s - bad packet length: %d\n",
2055 __func__, length+2);
2059 if (priv->rx_flags & THROTTLED) {
2060 dbg("%s - throttled", __func__);
2063 if (tty_buffer_request_room(tty, length) < length) {
2064 /* break out & wait for throttling/unthrottling to
2066 dbg("%s - receive room low", __func__);
2070 /* Handle errors and break */
2071 error_flag = TTY_NORMAL;
2072 /* Although the device uses a bitmask and hence can have
2073 multiple errors on a packet - the order here sets the
2074 priority the error is returned to the tty layer */
2076 if (data[packet_offset+1] & FTDI_RS_OE) {
2077 error_flag = TTY_OVERRUN;
2078 dbg("OVERRRUN error");
2080 if (data[packet_offset+1] & FTDI_RS_BI) {
2081 error_flag = TTY_BREAK;
2082 dbg("BREAK received");
2084 if (data[packet_offset+1] & FTDI_RS_PE) {
2085 error_flag = TTY_PARITY;
2086 dbg("PARITY error");
2088 if (data[packet_offset+1] & FTDI_RS_FE) {
2089 error_flag = TTY_FRAME;
2090 dbg("FRAMING error");
2093 for (i = 2; i < length+2; i++) {
2094 /* Note that the error flag is duplicated for
2095 every character received since we don't know
2096 which character it applied to */
2097 tty_insert_flip_char(tty,
2098 data[packet_offset + i], error_flag);
2103 #ifdef NOT_CORRECT_BUT_KEEPING_IT_FOR_NOW
2104 /* if a parity error is detected you get status packets forever
2105 until a character is sent without a parity error.
2106 This doesn't work well since the application receives a
2107 never ending stream of bad data - even though new data
2108 hasn't been sent. Therefore I (bill) have taken this out.
2109 However - this might make sense for framing errors and so on
2110 so I am leaving the code in for now.
2113 if (error_flag != TTY_NORMAL) {
2114 dbg("error_flag is not normal");
2115 /* In this case it is just status - if that is
2116 an error send a bad character */
2117 if (tty->flip.count >= TTY_FLIPBUF_SIZE)
2118 tty_flip_buffer_push(tty);
2119 tty_insert_flip_char(tty, 0xff, error_flag);
2124 } /* "for(packet_offset=0..." */
2128 tty_flip_buffer_push(tty);
2130 if (packet_offset < urb->actual_length) {
2131 /* not completely processed - record progress */
2132 priv->rx_processed = packet_offset;
2133 dbg("%s - incomplete, %d bytes processed, %d remain",
2134 __func__, packet_offset,
2135 urb->actual_length - packet_offset);
2136 /* check if we were throttled while processing */
2137 spin_lock_irqsave(&priv->rx_lock, flags);
2138 if (priv->rx_flags & THROTTLED) {
2139 priv->rx_flags |= ACTUALLY_THROTTLED;
2140 spin_unlock_irqrestore(&priv->rx_lock, flags);
2141 dbg("%s - deferring remainder until unthrottled",
2145 spin_unlock_irqrestore(&priv->rx_lock, flags);
2146 /* if the port is closed stop trying to read */
2147 if (port->port.count > 0)
2148 /* delay processing of remainder */
2149 schedule_delayed_work(&priv->rx_work, 1);
2151 dbg("%s - port is closed", __func__);
2155 /* urb is completely processed */
2156 priv->rx_processed = 0;
2158 /* if the port is closed stop trying to read */
2159 if (port->port.count > 0) {
2160 /* Continue trying to always read */
2161 usb_fill_bulk_urb(port->read_urb, port->serial->dev,
2162 usb_rcvbulkpipe(port->serial->dev,
2163 port->bulk_in_endpointAddress),
2164 port->read_urb->transfer_buffer,
2165 port->read_urb->transfer_buffer_length,
2166 ftdi_read_bulk_callback, port);
2168 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
2171 "%s - failed resubmitting read urb, error %d\n",
2176 } /* ftdi_process_read */
2179 static void ftdi_break_ctl(struct tty_struct *tty, int break_state)
2181 struct usb_serial_port *port = tty->driver_data;
2182 struct ftdi_private *priv = usb_get_serial_port_data(port);
2183 __u16 urb_value = 0;
2186 /* break_state = -1 to turn on break, and 0 to turn off break */
2187 /* see drivers/char/tty_io.c to see it used */
2188 /* last_set_data_urb_value NEVER has the break bit set in it */
2191 urb_value = priv->last_set_data_urb_value | FTDI_SIO_SET_BREAK;
2193 urb_value = priv->last_set_data_urb_value;
2195 if (usb_control_msg(port->serial->dev,
2196 usb_sndctrlpipe(port->serial->dev, 0),
2197 FTDI_SIO_SET_DATA_REQUEST,
2198 FTDI_SIO_SET_DATA_REQUEST_TYPE,
2199 urb_value , priv->interface,
2200 buf, 0, WDR_TIMEOUT) < 0) {
2201 dev_err(&port->dev, "%s FAILED to enable/disable break state "
2202 "(state was %d)\n", __func__, break_state);
2205 dbg("%s break state is %d - urb is %d", __func__,
2206 break_state, urb_value);
2211 /* old_termios contains the original termios settings and tty->termios contains
2212 * the new setting to be used
2213 * WARNING: set_termios calls this with old_termios in kernel space
2216 static void ftdi_set_termios(struct tty_struct *tty,
2217 struct usb_serial_port *port, struct ktermios *old_termios)
2218 { /* ftdi_termios */
2219 struct usb_device *dev = port->serial->dev;
2220 struct ftdi_private *priv = usb_get_serial_port_data(port);
2221 struct ktermios *termios = tty->termios;
2222 unsigned int cflag = termios->c_cflag;
2223 __u16 urb_value; /* will hold the new flags */
2224 char buf[1]; /* Perhaps I should dynamically alloc this? */
2226 /* Added for xon/xoff support */
2227 unsigned int iflag = termios->c_iflag;
2228 unsigned char vstop;
2229 unsigned char vstart;
2231 dbg("%s", __func__);
2233 /* Force baud rate if this device requires it, unless it is set to
2235 if (priv->force_baud && ((termios->c_cflag & CBAUD) != B0)) {
2236 dbg("%s: forcing baud rate for this device", __func__);
2237 tty_encode_baud_rate(tty, priv->force_baud,
2241 /* Force RTS-CTS if this device requires it. */
2242 if (priv->force_rtscts) {
2243 dbg("%s: forcing rtscts for this device", __func__);
2244 termios->c_cflag |= CRTSCTS;
2247 cflag = termios->c_cflag;
2249 /* FIXME -For this cut I don't care if the line is really changing or
2250 not - so just do the change regardless - should be able to
2251 compare old_termios and tty->termios */
2252 /* NOTE These routines can get interrupted by
2253 ftdi_sio_read_bulk_callback - need to examine what this means -
2254 don't see any problems yet */
2256 /* Set number of data bits, parity, stop bits */
2258 termios->c_cflag &= ~CMSPAR;
2261 urb_value |= (cflag & CSTOPB ? FTDI_SIO_SET_DATA_STOP_BITS_2 :
2262 FTDI_SIO_SET_DATA_STOP_BITS_1);
2263 urb_value |= (cflag & PARENB ?
2264 (cflag & PARODD ? FTDI_SIO_SET_DATA_PARITY_ODD :
2265 FTDI_SIO_SET_DATA_PARITY_EVEN) :
2266 FTDI_SIO_SET_DATA_PARITY_NONE);
2267 if (cflag & CSIZE) {
2268 switch (cflag & CSIZE) {
2269 case CS5: urb_value |= 5; dbg("Setting CS5"); break;
2270 case CS6: urb_value |= 6; dbg("Setting CS6"); break;
2271 case CS7: urb_value |= 7; dbg("Setting CS7"); break;
2272 case CS8: urb_value |= 8; dbg("Setting CS8"); break;
2274 dev_err(&port->dev, "CSIZE was set but not CS5-CS8\n");
2278 /* This is needed by the break command since it uses the same command
2279 - but is or'ed with this value */
2280 priv->last_set_data_urb_value = urb_value;
2282 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2283 FTDI_SIO_SET_DATA_REQUEST,
2284 FTDI_SIO_SET_DATA_REQUEST_TYPE,
2285 urb_value , priv->interface,
2286 buf, 0, WDR_SHORT_TIMEOUT) < 0) {
2287 dev_err(&port->dev, "%s FAILED to set "
2288 "databits/stopbits/parity\n", __func__);
2291 /* Now do the baudrate */
2292 if ((cflag & CBAUD) == B0) {
2293 /* Disable flow control */
2294 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2295 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2296 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2298 buf, 0, WDR_TIMEOUT) < 0) {
2300 "%s error from disable flowcontrol urb\n",
2303 /* Drop RTS and DTR */
2304 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2306 /* set the baudrate determined before */
2307 if (change_speed(tty, port))
2308 dev_err(&port->dev, "%s urb failed to set baudrate\n",
2310 /* Ensure RTS and DTR are raised when baudrate changed from 0 */
2311 if (!old_termios || (old_termios->c_cflag & CBAUD) == B0)
2312 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2315 /* Set flow control */
2316 /* Note device also supports DTR/CD (ugh) and Xon/Xoff in hardware */
2317 if (cflag & CRTSCTS) {
2318 dbg("%s Setting to CRTSCTS flow control", __func__);
2319 if (usb_control_msg(dev,
2320 usb_sndctrlpipe(dev, 0),
2321 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2322 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2323 0 , (FTDI_SIO_RTS_CTS_HS | priv->interface),
2324 buf, 0, WDR_TIMEOUT) < 0) {
2326 "urb failed to set to rts/cts flow control\n");
2333 * Check the IXOFF status in the iflag component of the
2334 * termios structure. If IXOFF is not set, the pre-xon/xoff
2337 if (iflag & IXOFF) {
2338 dbg("%s request to enable xonxoff iflag=%04x",
2340 /* Try to enable the XON/XOFF on the ftdi_sio
2341 * Set the vstart and vstop -- could have been done up
2342 * above where a lot of other dereferencing is done but
2343 * that would be very inefficient as vstart and vstop
2344 * are not always needed.
2346 vstart = termios->c_cc[VSTART];
2347 vstop = termios->c_cc[VSTOP];
2348 urb_value = (vstop << 8) | (vstart);
2350 if (usb_control_msg(dev,
2351 usb_sndctrlpipe(dev, 0),
2352 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2353 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2354 urb_value , (FTDI_SIO_XON_XOFF_HS
2356 buf, 0, WDR_TIMEOUT) < 0) {
2357 dev_err(&port->dev, "urb failed to set to "
2358 "xon/xoff flow control\n");
2361 /* else clause to only run if cflag ! CRTSCTS and iflag
2362 * ! XOFF. CHECKME Assuming XON/XOFF handled by tty
2363 * stack - not by device */
2364 dbg("%s Turning off hardware flow control", __func__);
2365 if (usb_control_msg(dev,
2366 usb_sndctrlpipe(dev, 0),
2367 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2368 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2370 buf, 0, WDR_TIMEOUT) < 0) {
2372 "urb failed to clear flow control\n");
2380 static int ftdi_tiocmget(struct tty_struct *tty, struct file *file)
2382 struct usb_serial_port *port = tty->driver_data;
2383 struct ftdi_private *priv = usb_get_serial_port_data(port);
2384 unsigned char buf[2];
2387 dbg("%s TIOCMGET", __func__);
2388 switch (priv->chip_type) {
2390 /* Request the status from the device */
2391 ret = usb_control_msg(port->serial->dev,
2392 usb_rcvctrlpipe(port->serial->dev, 0),
2393 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
2394 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
2396 buf, 1, WDR_TIMEOUT);
2406 /* the 8U232AM returns a two byte value (the sio is a 1 byte
2407 value) - in the same format as the data returned from the in
2409 ret = usb_control_msg(port->serial->dev,
2410 usb_rcvctrlpipe(port->serial->dev, 0),
2411 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
2412 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
2414 buf, 2, WDR_TIMEOUT);
2422 return (buf[0] & FTDI_SIO_DSR_MASK ? TIOCM_DSR : 0) |
2423 (buf[0] & FTDI_SIO_CTS_MASK ? TIOCM_CTS : 0) |
2424 (buf[0] & FTDI_SIO_RI_MASK ? TIOCM_RI : 0) |
2425 (buf[0] & FTDI_SIO_RLSD_MASK ? TIOCM_CD : 0) |
2429 static int ftdi_tiocmset(struct tty_struct *tty, struct file *file,
2430 unsigned int set, unsigned int clear)
2432 struct usb_serial_port *port = tty->driver_data;
2433 dbg("%s TIOCMSET", __func__);
2434 return update_mctrl(port, set, clear);
2438 static int ftdi_ioctl(struct tty_struct *tty, struct file *file,
2439 unsigned int cmd, unsigned long arg)
2441 struct usb_serial_port *port = tty->driver_data;
2442 struct ftdi_private *priv = usb_get_serial_port_data(port);
2444 dbg("%s cmd 0x%04x", __func__, cmd);
2446 /* Based on code from acm.c and others */
2449 case TIOCGSERIAL: /* gets serial port data */
2450 return get_serial_info(port,
2451 (struct serial_struct __user *) arg);
2453 case TIOCSSERIAL: /* sets serial port data */
2454 return set_serial_info(tty, port,
2455 (struct serial_struct __user *) arg);
2458 * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
2459 * - mask passed in arg for lines of interest
2460 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
2461 * Caller should use TIOCGICOUNT to see which one it was.
2463 * This code is borrowed from linux/drivers/char/serial.c
2466 while (priv != NULL) {
2467 interruptible_sleep_on(&priv->delta_msr_wait);
2468 /* see if a signal did it */
2469 if (signal_pending(current))
2470 return -ERESTARTSYS;
2472 char diff = priv->diff_status;
2475 return -EIO; /* no change => error */
2477 /* Consume all events */
2478 priv->diff_status = 0;
2480 /* Return 0 if caller wanted to know about
2482 if (((arg & TIOCM_RNG) && (diff & FTDI_RS0_RI)) ||
2483 ((arg & TIOCM_DSR) && (diff & FTDI_RS0_DSR)) ||
2484 ((arg & TIOCM_CD) && (diff & FTDI_RS0_RLSD)) ||
2485 ((arg & TIOCM_CTS) && (diff & FTDI_RS0_CTS))) {
2489 * Otherwise caller can't care less about what
2490 * happened,and so we continue to wait for more
2499 /* This is not necessarily an error - turns out the higher layers
2500 * will do some ioctls themselves (see comment above)
2502 dbg("%s arg not supported - it was 0x%04x - check /usr/include/asm/ioctls.h", __func__, cmd);
2503 return -ENOIOCTLCMD;
2506 static void ftdi_throttle(struct tty_struct *tty)
2508 struct usb_serial_port *port = tty->driver_data;
2509 struct ftdi_private *priv = usb_get_serial_port_data(port);
2510 unsigned long flags;
2512 dbg("%s - port %d", __func__, port->number);
2514 spin_lock_irqsave(&priv->rx_lock, flags);
2515 priv->rx_flags |= THROTTLED;
2516 spin_unlock_irqrestore(&priv->rx_lock, flags);
2520 static void ftdi_unthrottle(struct tty_struct *tty)
2522 struct usb_serial_port *port = tty->driver_data;
2523 struct ftdi_private *priv = usb_get_serial_port_data(port);
2524 int actually_throttled;
2525 unsigned long flags;
2527 dbg("%s - port %d", __func__, port->number);
2529 spin_lock_irqsave(&priv->rx_lock, flags);
2530 actually_throttled = priv->rx_flags & ACTUALLY_THROTTLED;
2531 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
2532 spin_unlock_irqrestore(&priv->rx_lock, flags);
2534 if (actually_throttled)
2535 schedule_delayed_work(&priv->rx_work, 0);
2538 static int __init ftdi_init(void)
2542 dbg("%s", __func__);
2543 if (vendor > 0 && product > 0) {
2544 /* Add user specified VID/PID to reserved element of table. */
2546 for (i = 0; id_table_combined[i].idVendor; i++)
2548 id_table_combined[i].match_flags = USB_DEVICE_ID_MATCH_DEVICE;
2549 id_table_combined[i].idVendor = vendor;
2550 id_table_combined[i].idProduct = product;
2552 retval = usb_serial_register(&ftdi_sio_device);
2554 goto failed_sio_register;
2555 retval = usb_register(&ftdi_driver);
2557 goto failed_usb_register;
2559 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
2562 failed_usb_register:
2563 usb_serial_deregister(&ftdi_sio_device);
2564 failed_sio_register:
2569 static void __exit ftdi_exit(void)
2572 dbg("%s", __func__);
2574 usb_deregister(&ftdi_driver);
2575 usb_serial_deregister(&ftdi_sio_device);
2580 module_init(ftdi_init);
2581 module_exit(ftdi_exit);
2583 MODULE_AUTHOR(DRIVER_AUTHOR);
2584 MODULE_DESCRIPTION(DRIVER_DESC);
2585 MODULE_LICENSE("GPL");
2587 module_param(debug, bool, S_IRUGO | S_IWUSR);
2588 MODULE_PARM_DESC(debug, "Debug enabled or not");
2589 module_param(vendor, ushort, 0);
2590 MODULE_PARM_DESC(vendor, "User specified vendor ID (default="
2591 __MODULE_STRING(FTDI_VID)")");
2592 module_param(product, ushort, 0);
2593 MODULE_PARM_DESC(product, "User specified product ID");