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.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"
55 static __u16 vendor = FTDI_VID;
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
65 __u16 last_set_data_urb_value ;
66 /* the last data state set - needed for doing
69 int write_offset; /* This is the offset in the usb data block to
70 * write the serial data - it varies between
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;
82 unsigned long rx_bytes;
84 __u16 interface; /* FT2232C port interface (0 for FT232/245) */
86 speed_t force_baud; /* if non-zero, force the baud rate to
88 int force_rtscts; /* if non-zero, force RTS-CTS to always
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;
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 *);
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);
109 static struct ftdi_sio_quirk ftdi_jtag_quirk = {
110 .probe = ftdi_jtag_probe,
113 static struct ftdi_sio_quirk ftdi_mtxorb_hack_quirk = {
114 .probe = ftdi_mtxorb_hack_setup,
117 static struct ftdi_sio_quirk ftdi_USB_UIRT_quirk = {
118 .port_probe = ftdi_USB_UIRT_setup,
121 static struct ftdi_sio_quirk ftdi_HE_TIRA1_quirk = {
122 .port_probe = ftdi_HE_TIRA1_setup,
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
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)
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]
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) },
545 * Due to many user requests for multiple ELV devices we enable
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 { }, /* Optional parameter entry */
667 { } /* Terminating entry */
670 MODULE_DEVICE_TABLE(usb, id_table_combined);
672 static struct usb_driver ftdi_driver = {
674 .probe = usb_serial_probe,
675 .disconnect = usb_serial_disconnect,
676 .id_table = id_table_combined,
680 static const char *ftdi_chip_name[] = {
681 [SIO] = "SIO", /* the serial part of FT8U100AX */
682 [FT8U232AM] = "FT8U232AM",
683 [FT232BM] = "FT232BM",
684 [FT2232C] = "FT2232C",
685 [FT232RL] = "FT232RL",
689 /* Constants for read urb and write urb */
694 #define THROTTLED 0x01
695 #define ACTUALLY_THROTTLED 0x02
697 /* Used for TIOCMIWAIT */
698 #define FTDI_STATUS_B0_MASK (FTDI_RS0_CTS | FTDI_RS0_DSR | FTDI_RS0_RI | FTDI_RS0_RLSD)
699 #define FTDI_STATUS_B1_MASK (FTDI_RS_BI)
702 #define FTDI_IMPL_ASYNC_FLAGS = (ASYNC_SPD_HI | ASYNC_SPD_VHI \
703 | ASYNC_SPD_CUST | ASYNC_SPD_SHI | ASYNC_SPD_WARP)
705 /* function prototypes for a FTDI serial converter */
706 static int ftdi_sio_probe(struct usb_serial *serial,
707 const struct usb_device_id *id);
708 static void ftdi_shutdown(struct usb_serial *serial);
709 static int ftdi_sio_port_probe(struct usb_serial_port *port);
710 static int ftdi_sio_port_remove(struct usb_serial_port *port);
711 static int ftdi_open(struct tty_struct *tty,
712 struct usb_serial_port *port, struct file *filp);
713 static void ftdi_close(struct tty_struct *tty,
714 struct usb_serial_port *port, struct file *filp);
715 static int ftdi_write(struct tty_struct *tty, struct usb_serial_port *port,
716 const unsigned char *buf, int count);
717 static int ftdi_write_room(struct tty_struct *tty);
718 static int ftdi_chars_in_buffer(struct tty_struct *tty);
719 static void ftdi_write_bulk_callback(struct urb *urb);
720 static void ftdi_read_bulk_callback(struct urb *urb);
721 static void ftdi_process_read(struct work_struct *work);
722 static void ftdi_set_termios(struct tty_struct *tty,
723 struct usb_serial_port *port, struct ktermios *old);
724 static int ftdi_tiocmget(struct tty_struct *tty, struct file *file);
725 static int ftdi_tiocmset(struct tty_struct *tty, struct file *file,
726 unsigned int set, unsigned int clear);
727 static int ftdi_ioctl(struct tty_struct *tty, struct file *file,
728 unsigned int cmd, unsigned long arg);
729 static void ftdi_break_ctl(struct tty_struct *tty, int break_state);
730 static void ftdi_throttle(struct tty_struct *tty);
731 static void ftdi_unthrottle(struct tty_struct *tty);
733 static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base);
734 static unsigned short int ftdi_232am_baud_to_divisor(int baud);
735 static __u32 ftdi_232bm_baud_base_to_divisor(int baud, int base);
736 static __u32 ftdi_232bm_baud_to_divisor(int baud);
738 static struct usb_serial_driver ftdi_sio_device = {
740 .owner = THIS_MODULE,
743 .description = "FTDI USB Serial Device",
744 .usb_driver = &ftdi_driver ,
745 .id_table = id_table_combined,
747 .probe = ftdi_sio_probe,
748 .port_probe = ftdi_sio_port_probe,
749 .port_remove = ftdi_sio_port_remove,
752 .throttle = ftdi_throttle,
753 .unthrottle = ftdi_unthrottle,
755 .write_room = ftdi_write_room,
756 .chars_in_buffer = ftdi_chars_in_buffer,
757 .read_bulk_callback = ftdi_read_bulk_callback,
758 .write_bulk_callback = ftdi_write_bulk_callback,
759 .tiocmget = ftdi_tiocmget,
760 .tiocmset = ftdi_tiocmset,
762 .set_termios = ftdi_set_termios,
763 .break_ctl = ftdi_break_ctl,
764 .shutdown = ftdi_shutdown,
768 #define WDR_TIMEOUT 5000 /* default urb timeout */
769 #define WDR_SHORT_TIMEOUT 1000 /* shorter urb timeout */
771 /* High and low are for DTR, RTS etc etc */
775 /* number of outstanding urbs to prevent userspace DoS from happening */
776 #define URB_UPPER_LIMIT 42
779 * ***************************************************************************
781 * ***************************************************************************
784 static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base)
786 unsigned short int divisor;
787 /* divisor shifted 3 bits to the left */
788 int divisor3 = base / 2 / baud;
789 if ((divisor3 & 0x7) == 7)
790 divisor3++; /* round x.7/8 up to x+1 */
791 divisor = divisor3 >> 3;
795 else if (divisor3 >= 4)
797 else if (divisor3 != 0)
799 else if (divisor == 1)
800 divisor = 0; /* special case for maximum baud rate */
804 static unsigned short int ftdi_232am_baud_to_divisor(int baud)
806 return ftdi_232am_baud_base_to_divisor(baud, 48000000);
809 static __u32 ftdi_232bm_baud_base_to_divisor(int baud, int base)
811 static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
813 /* divisor shifted 3 bits to the left */
814 int divisor3 = base / 2 / baud;
815 divisor = divisor3 >> 3;
816 divisor |= (__u32)divfrac[divisor3 & 0x7] << 14;
817 /* Deal with special cases for highest baud rates. */
820 else if (divisor == 0x4001)
825 static __u32 ftdi_232bm_baud_to_divisor(int baud)
827 return ftdi_232bm_baud_base_to_divisor(baud, 48000000);
830 #define set_mctrl(port, set) update_mctrl((port), (set), 0)
831 #define clear_mctrl(port, clear) update_mctrl((port), 0, (clear))
833 static int update_mctrl(struct usb_serial_port *port, unsigned int set,
836 struct ftdi_private *priv = usb_get_serial_port_data(port);
841 if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
842 dbg("%s - DTR|RTS not being set|cleared", __func__);
843 return 0; /* no change */
846 buf = kmalloc(1, GFP_NOIO);
850 clear &= ~set; /* 'set' takes precedence over 'clear' */
852 if (clear & TIOCM_DTR)
853 urb_value |= FTDI_SIO_SET_DTR_LOW;
854 if (clear & TIOCM_RTS)
855 urb_value |= FTDI_SIO_SET_RTS_LOW;
857 urb_value |= FTDI_SIO_SET_DTR_HIGH;
859 urb_value |= FTDI_SIO_SET_RTS_HIGH;
860 rv = usb_control_msg(port->serial->dev,
861 usb_sndctrlpipe(port->serial->dev, 0),
862 FTDI_SIO_SET_MODEM_CTRL_REQUEST,
863 FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE,
864 urb_value, priv->interface,
865 buf, 0, WDR_TIMEOUT);
869 dbg("%s Error from MODEM_CTRL urb: DTR %s, RTS %s",
871 (set & TIOCM_DTR) ? "HIGH" :
872 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
873 (set & TIOCM_RTS) ? "HIGH" :
874 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
876 dbg("%s - DTR %s, RTS %s", __func__,
877 (set & TIOCM_DTR) ? "HIGH" :
878 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
879 (set & TIOCM_RTS) ? "HIGH" :
880 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
881 /* FIXME: locking on last_dtr_rts */
882 priv->last_dtr_rts = (priv->last_dtr_rts & ~clear) | set;
888 static __u32 get_ftdi_divisor(struct tty_struct *tty,
889 struct usb_serial_port *port)
890 { /* get_ftdi_divisor */
891 struct ftdi_private *priv = usb_get_serial_port_data(port);
897 * The logic involved in setting the baudrate can be cleanly split into
899 * 1. Standard baud rates are set in tty->termios->c_cflag
900 * 2. If these are not enough, you can set any speed using alt_speed as
902 * - set tty->termios->c_cflag speed to B38400
903 * - set your real speed in tty->alt_speed; it gets ignored when
905 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as
907 * flags & ASYNC_SPD_MASK == ASYNC_SPD_[HI, VHI, SHI, WARP],
908 * this just sets alt_speed to (HI: 57600, VHI: 115200,
909 * SHI: 230400, WARP: 460800)
910 * ** Steps 1, 2 are done courtesy of tty_get_baud_rate
911 * 3. You can also set baud rate by setting custom divisor as follows
912 * - set tty->termios->c_cflag speed to B38400
913 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as
915 * o flags & ASYNC_SPD_MASK == ASYNC_SPD_CUST
916 * o custom_divisor set to baud_base / your_new_baudrate
917 * ** Step 3 is done courtesy of code borrowed from serial.c
918 * I should really spend some time and separate + move this common
919 * code to serial.c, it is replicated in nearly every serial driver
923 /* 1. Get the baud rate from the tty settings, this observes
926 baud = tty_get_baud_rate(tty);
927 dbg("%s - tty_get_baud_rate reports speed %d", __func__, baud);
929 /* 2. Observe async-compatible custom_divisor hack, update baudrate
933 ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
934 (priv->custom_divisor)) {
935 baud = priv->baud_base / priv->custom_divisor;
936 dbg("%s - custom divisor %d sets baud rate to %d",
937 __func__, priv->custom_divisor, baud);
940 /* 3. Convert baudrate to device-specific divisor */
944 switch (priv->chip_type) {
945 case SIO: /* SIO chip */
947 case 300: div_value = ftdi_sio_b300; break;
948 case 600: div_value = ftdi_sio_b600; break;
949 case 1200: div_value = ftdi_sio_b1200; break;
950 case 2400: div_value = ftdi_sio_b2400; break;
951 case 4800: div_value = ftdi_sio_b4800; break;
952 case 9600: div_value = ftdi_sio_b9600; break;
953 case 19200: div_value = ftdi_sio_b19200; break;
954 case 38400: div_value = ftdi_sio_b38400; break;
955 case 57600: div_value = ftdi_sio_b57600; break;
956 case 115200: div_value = ftdi_sio_b115200; break;
958 if (div_value == 0) {
959 dbg("%s - Baudrate (%d) requested is not supported",
961 div_value = ftdi_sio_b9600;
966 case FT8U232AM: /* 8U232AM chip */
967 if (baud <= 3000000) {
968 div_value = ftdi_232am_baud_to_divisor(baud);
970 dbg("%s - Baud rate too high!", __func__);
972 div_value = ftdi_232am_baud_to_divisor(9600);
976 case FT232BM: /* FT232BM chip */
977 case FT2232C: /* FT2232C chip */
979 if (baud <= 3000000) {
980 div_value = ftdi_232bm_baud_to_divisor(baud);
982 dbg("%s - Baud rate too high!", __func__);
983 div_value = ftdi_232bm_baud_to_divisor(9600);
988 } /* priv->chip_type */
991 dbg("%s - Baud rate set to %d (divisor 0x%lX) on chip %s",
992 __func__, baud, (unsigned long)div_value,
993 ftdi_chip_name[priv->chip_type]);
996 tty_encode_baud_rate(tty, baud, baud);
1000 static int change_speed(struct tty_struct *tty, struct usb_serial_port *port)
1002 struct ftdi_private *priv = usb_get_serial_port_data(port);
1006 __u32 urb_index_value;
1009 buf = kmalloc(1, GFP_NOIO);
1013 urb_index_value = get_ftdi_divisor(tty, port);
1014 urb_value = (__u16)urb_index_value;
1015 urb_index = (__u16)(urb_index_value >> 16);
1016 if (priv->interface) { /* FT2232C */
1017 urb_index = (__u16)((urb_index << 8) | priv->interface);
1020 rv = usb_control_msg(port->serial->dev,
1021 usb_sndctrlpipe(port->serial->dev, 0),
1022 FTDI_SIO_SET_BAUDRATE_REQUEST,
1023 FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE,
1024 urb_value, urb_index,
1025 buf, 0, WDR_SHORT_TIMEOUT);
1033 static int get_serial_info(struct usb_serial_port *port,
1034 struct serial_struct __user *retinfo)
1036 struct ftdi_private *priv = usb_get_serial_port_data(port);
1037 struct serial_struct tmp;
1041 memset(&tmp, 0, sizeof(tmp));
1042 tmp.flags = priv->flags;
1043 tmp.baud_base = priv->baud_base;
1044 tmp.custom_divisor = priv->custom_divisor;
1045 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
1048 } /* get_serial_info */
1051 static int set_serial_info(struct tty_struct *tty,
1052 struct usb_serial_port *port, struct serial_struct __user *newinfo)
1053 { /* set_serial_info */
1054 struct ftdi_private *priv = usb_get_serial_port_data(port);
1055 struct serial_struct new_serial;
1056 struct ftdi_private old_priv;
1058 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
1064 /* Do error checking and permission checking */
1066 if (!capable(CAP_SYS_ADMIN)) {
1067 if (((new_serial.flags & ~ASYNC_USR_MASK) !=
1068 (priv->flags & ~ASYNC_USR_MASK))) {
1072 priv->flags = ((priv->flags & ~ASYNC_USR_MASK) |
1073 (new_serial.flags & ASYNC_USR_MASK));
1074 priv->custom_divisor = new_serial.custom_divisor;
1075 goto check_and_exit;
1078 if ((new_serial.baud_base != priv->baud_base) &&
1079 (new_serial.baud_base < 9600)) {
1084 /* Make the changes - these are privileged changes! */
1086 priv->flags = ((priv->flags & ~ASYNC_FLAGS) |
1087 (new_serial.flags & ASYNC_FLAGS));
1088 priv->custom_divisor = new_serial.custom_divisor;
1090 tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
1093 if ((old_priv.flags & ASYNC_SPD_MASK) !=
1094 (priv->flags & ASYNC_SPD_MASK)) {
1095 if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_HI)
1096 tty->alt_speed = 57600;
1097 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_VHI)
1098 tty->alt_speed = 115200;
1099 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_SHI)
1100 tty->alt_speed = 230400;
1101 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_WARP)
1102 tty->alt_speed = 460800;
1106 if (((old_priv.flags & ASYNC_SPD_MASK) !=
1107 (priv->flags & ASYNC_SPD_MASK)) ||
1108 (((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
1109 (old_priv.custom_divisor != priv->custom_divisor))) {
1111 change_speed(tty, port);
1117 } /* set_serial_info */
1120 /* Determine type of FTDI chip based on USB config and descriptor. */
1121 static void ftdi_determine_type(struct usb_serial_port *port)
1123 struct ftdi_private *priv = usb_get_serial_port_data(port);
1124 struct usb_serial *serial = port->serial;
1125 struct usb_device *udev = serial->dev;
1127 unsigned interfaces;
1129 /* Assume it is not the original SIO device for now. */
1130 priv->baud_base = 48000000 / 2;
1131 priv->write_offset = 0;
1133 version = le16_to_cpu(udev->descriptor.bcdDevice);
1134 interfaces = udev->actconfig->desc.bNumInterfaces;
1135 dbg("%s: bcdDevice = 0x%x, bNumInterfaces = %u", __func__,
1136 version, interfaces);
1137 if (interfaces > 1) {
1140 /* Multiple interfaces. Assume FT2232C. */
1141 priv->chip_type = FT2232C;
1142 /* Determine interface code. */
1143 inter = serial->interface->altsetting->desc.bInterfaceNumber;
1145 priv->interface = PIT_SIOA;
1147 priv->interface = PIT_SIOB;
1148 /* BM-type devices have a bug where bcdDevice gets set
1149 * to 0x200 when iSerialNumber is 0. */
1150 if (version < 0x500) {
1151 dbg("%s: something fishy - bcdDevice too low for multi-interface device",
1154 } else if (version < 0x200) {
1155 /* Old device. Assume its the original SIO. */
1156 priv->chip_type = SIO;
1157 priv->baud_base = 12000000 / 16;
1158 priv->write_offset = 1;
1159 } else if (version < 0x400) {
1160 /* Assume its an FT8U232AM (or FT8U245AM) */
1161 /* (It might be a BM because of the iSerialNumber bug,
1162 * but it will still work as an AM device.) */
1163 priv->chip_type = FT8U232AM;
1164 } else if (version < 0x600) {
1165 /* Assume its an FT232BM (or FT245BM) */
1166 priv->chip_type = FT232BM;
1168 /* Assume its an FT232R */
1169 priv->chip_type = FT232RL;
1171 dev_info(&udev->dev, "Detected %s\n", ftdi_chip_name[priv->chip_type]);
1176 * ***************************************************************************
1178 * ***************************************************************************
1181 static ssize_t show_latency_timer(struct device *dev,
1182 struct device_attribute *attr, char *buf)
1184 struct usb_serial_port *port = to_usb_serial_port(dev);
1185 struct ftdi_private *priv = usb_get_serial_port_data(port);
1186 struct usb_device *udev = port->serial->dev;
1187 unsigned short latency = 0;
1191 dbg("%s", __func__);
1193 rv = usb_control_msg(udev,
1194 usb_rcvctrlpipe(udev, 0),
1195 FTDI_SIO_GET_LATENCY_TIMER_REQUEST,
1196 FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE,
1198 (char *) &latency, 1, WDR_TIMEOUT);
1201 dev_err(dev, "Unable to read latency timer: %i\n", rv);
1204 return sprintf(buf, "%i\n", latency);
1207 /* Write a new value of the latency timer, in units of milliseconds. */
1208 static ssize_t store_latency_timer(struct device *dev,
1209 struct device_attribute *attr, const char *valbuf,
1212 struct usb_serial_port *port = to_usb_serial_port(dev);
1213 struct ftdi_private *priv = usb_get_serial_port_data(port);
1214 struct usb_device *udev = port->serial->dev;
1216 int v = simple_strtoul(valbuf, NULL, 10);
1219 dbg("%s: setting latency timer = %i", __func__, v);
1221 rv = usb_control_msg(udev,
1222 usb_sndctrlpipe(udev, 0),
1223 FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
1224 FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
1226 buf, 0, WDR_TIMEOUT);
1229 dev_err(dev, "Unable to write latency timer: %i\n", rv);
1236 /* Write an event character directly to the FTDI register. The ASCII
1237 value is in the low 8 bits, with the enable bit in the 9th bit. */
1238 static ssize_t store_event_char(struct device *dev,
1239 struct device_attribute *attr, const char *valbuf, size_t count)
1241 struct usb_serial_port *port = to_usb_serial_port(dev);
1242 struct ftdi_private *priv = usb_get_serial_port_data(port);
1243 struct usb_device *udev = port->serial->dev;
1245 int v = simple_strtoul(valbuf, NULL, 10);
1248 dbg("%s: setting event char = %i", __func__, v);
1250 rv = usb_control_msg(udev,
1251 usb_sndctrlpipe(udev, 0),
1252 FTDI_SIO_SET_EVENT_CHAR_REQUEST,
1253 FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE,
1255 buf, 0, WDR_TIMEOUT);
1258 dbg("Unable to write event character: %i", rv);
1265 static DEVICE_ATTR(latency_timer, S_IWUSR | S_IRUGO, show_latency_timer,
1266 store_latency_timer);
1267 static DEVICE_ATTR(event_char, S_IWUSR, NULL, store_event_char);
1269 static int create_sysfs_attrs(struct usb_serial_port *port)
1271 struct ftdi_private *priv = usb_get_serial_port_data(port);
1274 dbg("%s", __func__);
1276 /* XXX I've no idea if the original SIO supports the event_char
1277 * sysfs parameter, so I'm playing it safe. */
1278 if (priv->chip_type != SIO) {
1279 dbg("sysfs attributes for %s", ftdi_chip_name[priv->chip_type]);
1280 retval = device_create_file(&port->dev, &dev_attr_event_char);
1282 (priv->chip_type == FT232BM ||
1283 priv->chip_type == FT2232C ||
1284 priv->chip_type == FT232RL)) {
1285 retval = device_create_file(&port->dev,
1286 &dev_attr_latency_timer);
1292 static void remove_sysfs_attrs(struct usb_serial_port *port)
1294 struct ftdi_private *priv = usb_get_serial_port_data(port);
1296 dbg("%s", __func__);
1298 /* XXX see create_sysfs_attrs */
1299 if (priv->chip_type != SIO) {
1300 device_remove_file(&port->dev, &dev_attr_event_char);
1301 if (priv->chip_type == FT232BM ||
1302 priv->chip_type == FT2232C ||
1303 priv->chip_type == FT232RL) {
1304 device_remove_file(&port->dev, &dev_attr_latency_timer);
1311 * ***************************************************************************
1312 * FTDI driver specific functions
1313 * ***************************************************************************
1316 /* Probe function to check for special devices */
1317 static int ftdi_sio_probe(struct usb_serial *serial,
1318 const struct usb_device_id *id)
1320 struct ftdi_sio_quirk *quirk =
1321 (struct ftdi_sio_quirk *)id->driver_info;
1323 if (quirk && quirk->probe) {
1324 int ret = quirk->probe(serial);
1329 usb_set_serial_data(serial, (void *)id->driver_info);
1334 static int ftdi_sio_port_probe(struct usb_serial_port *port)
1336 struct ftdi_private *priv;
1337 struct ftdi_sio_quirk *quirk = usb_get_serial_data(port->serial);
1340 dbg("%s", __func__);
1342 priv = kzalloc(sizeof(struct ftdi_private), GFP_KERNEL);
1344 dev_err(&port->dev, "%s- kmalloc(%Zd) failed.\n", __func__,
1345 sizeof(struct ftdi_private));
1349 spin_lock_init(&priv->rx_lock);
1350 spin_lock_init(&priv->tx_lock);
1351 init_waitqueue_head(&priv->delta_msr_wait);
1352 /* This will push the characters through immediately rather
1353 than queue a task to deliver them */
1354 priv->flags = ASYNC_LOW_LATENCY;
1356 if (quirk && quirk->port_probe)
1357 quirk->port_probe(priv);
1359 /* Increase the size of read buffers */
1360 kfree(port->bulk_in_buffer);
1361 port->bulk_in_buffer = kmalloc(BUFSZ, GFP_KERNEL);
1362 if (!port->bulk_in_buffer) {
1366 if (port->read_urb) {
1367 port->read_urb->transfer_buffer = port->bulk_in_buffer;
1368 port->read_urb->transfer_buffer_length = BUFSZ;
1371 INIT_DELAYED_WORK(&priv->rx_work, ftdi_process_read);
1374 /* Free port's existing write urb and transfer buffer. */
1375 if (port->write_urb) {
1376 usb_free_urb(port->write_urb);
1377 port->write_urb = NULL;
1379 kfree(port->bulk_out_buffer);
1380 port->bulk_out_buffer = NULL;
1382 usb_set_serial_port_data(port, priv);
1384 ftdi_determine_type(port);
1385 create_sysfs_attrs(port);
1389 /* Setup for the USB-UIRT device, which requires hardwired
1390 * baudrate (38400 gets mapped to 312500) */
1391 /* Called from usbserial:serial_probe */
1392 static void ftdi_USB_UIRT_setup(struct ftdi_private *priv)
1394 dbg("%s", __func__);
1396 priv->flags |= ASYNC_SPD_CUST;
1397 priv->custom_divisor = 77;
1398 priv->force_baud = 38400;
1399 } /* ftdi_USB_UIRT_setup */
1401 /* Setup for the HE-TIRA1 device, which requires hardwired
1402 * baudrate (38400 gets mapped to 100000) and RTS-CTS enabled. */
1404 static void ftdi_HE_TIRA1_setup(struct ftdi_private *priv)
1406 dbg("%s", __func__);
1408 priv->flags |= ASYNC_SPD_CUST;
1409 priv->custom_divisor = 240;
1410 priv->force_baud = 38400;
1411 priv->force_rtscts = 1;
1412 } /* ftdi_HE_TIRA1_setup */
1415 * First port on JTAG adaptors such as Olimex arm-usb-ocd or the FIC/OpenMoko
1416 * Neo1973 Debug Board is reserved for JTAG interface and can be accessed from
1417 * userspace using openocd.
1419 static int ftdi_jtag_probe(struct usb_serial *serial)
1421 struct usb_device *udev = serial->dev;
1422 struct usb_interface *interface = serial->interface;
1424 dbg("%s", __func__);
1426 if (interface == udev->actconfig->interface[0]) {
1427 dev_info(&udev->dev,
1428 "Ignoring serial port reserved for JTAG\n");
1436 * The Matrix Orbital VK204-25-USB has an invalid IN endpoint.
1437 * We have to correct it if we want to read from it.
1439 static int ftdi_mtxorb_hack_setup(struct usb_serial *serial)
1441 struct usb_host_endpoint *ep = serial->dev->ep_in[1];
1442 struct usb_endpoint_descriptor *ep_desc = &ep->desc;
1444 if (ep->enabled && ep_desc->wMaxPacketSize == 0) {
1445 ep_desc->wMaxPacketSize = cpu_to_le16(0x40);
1446 dev_info(&serial->dev->dev,
1447 "Fixing invalid wMaxPacketSize on read pipe\n");
1453 /* ftdi_shutdown is called from usbserial:usb_serial_disconnect
1454 * it is called when the usb device is disconnected
1456 * usbserial:usb_serial_disconnect
1457 * calls __serial_close for each open of the port
1458 * shutdown is called then (ie ftdi_shutdown)
1460 static void ftdi_shutdown(struct usb_serial *serial)
1462 dbg("%s", __func__);
1465 static int ftdi_sio_port_remove(struct usb_serial_port *port)
1467 struct ftdi_private *priv = usb_get_serial_port_data(port);
1469 dbg("%s", __func__);
1471 remove_sysfs_attrs(port);
1473 /* all open ports are closed at this point
1474 * (by usbserial.c:__serial_close, which calls ftdi_close)
1478 usb_set_serial_port_data(port, NULL);
1485 static int ftdi_open(struct tty_struct *tty,
1486 struct usb_serial_port *port, struct file *filp)
1488 struct usb_device *dev = port->serial->dev;
1489 struct ftdi_private *priv = usb_get_serial_port_data(port);
1490 unsigned long flags;
1493 char buf[1]; /* Needed for the usb_control_msg I think */
1495 dbg("%s", __func__);
1497 spin_lock_irqsave(&priv->tx_lock, flags);
1499 spin_unlock_irqrestore(&priv->tx_lock, flags);
1500 spin_lock_irqsave(&priv->rx_lock, flags);
1502 spin_unlock_irqrestore(&priv->rx_lock, flags);
1505 tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
1507 /* No error checking for this (will get errors later anyway) */
1508 /* See ftdi_sio.h for description of what is reset */
1509 usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1510 FTDI_SIO_RESET_REQUEST, FTDI_SIO_RESET_REQUEST_TYPE,
1512 priv->interface, buf, 0, WDR_TIMEOUT);
1514 /* Termios defaults are set by usb_serial_init. We don't change
1515 port->tty->termios - this would lose speed settings, etc.
1516 This is same behaviour as serial.c/rs_open() - Kuba */
1518 /* ftdi_set_termios will send usb control messages */
1520 ftdi_set_termios(tty, port, tty->termios);
1522 /* FIXME: Flow control might be enabled, so it should be checked -
1523 we have no control of defaults! */
1524 /* Turn on RTS and DTR since we are not flow controlling by default */
1525 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1528 spin_lock_irqsave(&priv->rx_lock, flags);
1529 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
1530 spin_unlock_irqrestore(&priv->rx_lock, flags);
1532 /* Start reading from the device */
1533 priv->rx_processed = 0;
1534 usb_fill_bulk_urb(port->read_urb, dev,
1535 usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress),
1536 port->read_urb->transfer_buffer,
1537 port->read_urb->transfer_buffer_length,
1538 ftdi_read_bulk_callback, port);
1539 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
1542 "%s - failed submitting read urb, error %d\n",
1552 * usbserial:__serial_close only calls ftdi_close if the point is open
1554 * This only gets called when it is the last close
1559 static void ftdi_close(struct tty_struct *tty,
1560 struct usb_serial_port *port, struct file *filp)
1562 unsigned int c_cflag = tty->termios->c_cflag;
1563 struct ftdi_private *priv = usb_get_serial_port_data(port);
1566 dbg("%s", __func__);
1568 mutex_lock(&port->serial->disc_mutex);
1569 if (c_cflag & HUPCL && !port->serial->disconnected) {
1570 /* Disable flow control */
1571 if (usb_control_msg(port->serial->dev,
1572 usb_sndctrlpipe(port->serial->dev, 0),
1573 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1574 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1575 0, priv->interface, buf, 0,
1577 dev_err(&port->dev, "error from flowcontrol urb\n");
1580 /* drop RTS and DTR */
1581 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1582 } /* Note change no line if hupcl is off */
1583 mutex_unlock(&port->serial->disc_mutex);
1585 /* cancel any scheduled reading */
1586 cancel_delayed_work(&priv->rx_work);
1587 flush_scheduled_work();
1589 /* shutdown our bulk read */
1590 usb_kill_urb(port->read_urb);
1595 /* The SIO requires the first byte to have:
1598 * B2..7 length of message excluding byte 0
1600 * The new devices do not require this byte
1602 static int ftdi_write(struct tty_struct *tty, struct usb_serial_port *port,
1603 const unsigned char *buf, int count)
1605 struct ftdi_private *priv = usb_get_serial_port_data(port);
1607 unsigned char *buffer;
1608 int data_offset ; /* will be 1 for the SIO and 0 otherwise */
1611 unsigned long flags;
1613 dbg("%s port %d, %d bytes", __func__, port->number, count);
1616 dbg("write request of 0 bytes");
1619 spin_lock_irqsave(&priv->tx_lock, flags);
1620 if (priv->tx_outstanding_urbs > URB_UPPER_LIMIT) {
1621 spin_unlock_irqrestore(&priv->tx_lock, flags);
1622 dbg("%s - write limit hit\n", __func__);
1625 priv->tx_outstanding_urbs++;
1626 spin_unlock_irqrestore(&priv->tx_lock, flags);
1628 data_offset = priv->write_offset;
1629 dbg("data_offset set to %d", data_offset);
1631 /* Determine total transfer size */
1632 transfer_size = count;
1633 if (data_offset > 0) {
1634 /* Original sio needs control bytes too... */
1635 transfer_size += (data_offset *
1636 ((count + (PKTSZ - 1 - data_offset)) /
1637 (PKTSZ - data_offset)));
1640 buffer = kmalloc(transfer_size, GFP_ATOMIC);
1643 "%s ran out of kernel memory for urb ...\n", __func__);
1645 goto error_no_buffer;
1648 urb = usb_alloc_urb(0, GFP_ATOMIC);
1650 dev_err(&port->dev, "%s - no more free urbs\n", __func__);
1656 if (data_offset > 0) {
1657 /* Original sio requires control byte at start of
1659 int user_pktsz = PKTSZ - data_offset;
1661 unsigned char *first_byte = buffer;
1662 const unsigned char *current_position = buf;
1665 if (user_pktsz > todo)
1667 /* Write the control byte at the front of the packet*/
1668 *first_byte = 1 | ((user_pktsz) << 2);
1669 /* Copy data for packet */
1670 memcpy(first_byte + data_offset,
1671 current_position, user_pktsz);
1672 first_byte += user_pktsz + data_offset;
1673 current_position += user_pktsz;
1677 /* No control byte required. */
1678 /* Copy in the data to send */
1679 memcpy(buffer, buf, count);
1682 usb_serial_debug_data(debug, &port->dev, __func__,
1683 transfer_size, buffer);
1685 /* fill the buffer and send it */
1686 usb_fill_bulk_urb(urb, port->serial->dev,
1687 usb_sndbulkpipe(port->serial->dev,
1688 port->bulk_out_endpointAddress),
1689 buffer, transfer_size,
1690 ftdi_write_bulk_callback, port);
1692 status = usb_submit_urb(urb, GFP_ATOMIC);
1695 "%s - failed submitting write urb, error %d\n",
1700 spin_lock_irqsave(&priv->tx_lock, flags);
1701 priv->tx_outstanding_bytes += count;
1702 priv->tx_bytes += count;
1703 spin_unlock_irqrestore(&priv->tx_lock, flags);
1706 /* we are done with this urb, so let the host driver
1707 * really free it when it is finished with it */
1710 dbg("%s write returning: %d", __func__, count);
1717 spin_lock_irqsave(&priv->tx_lock, flags);
1718 priv->tx_outstanding_urbs--;
1719 spin_unlock_irqrestore(&priv->tx_lock, flags);
1724 /* This function may get called when the device is closed */
1726 static void ftdi_write_bulk_callback(struct urb *urb)
1728 unsigned long flags;
1729 struct usb_serial_port *port = urb->context;
1730 struct ftdi_private *priv;
1731 int data_offset; /* will be 1 for the SIO and 0 otherwise */
1732 unsigned long countback;
1733 int status = urb->status;
1735 /* free up the transfer buffer, as usb_free_urb() does not do this */
1736 kfree(urb->transfer_buffer);
1738 dbg("%s - port %d", __func__, port->number);
1741 dbg("nonzero write bulk status received: %d", status);
1745 priv = usb_get_serial_port_data(port);
1747 dbg("%s - bad port private data pointer - exiting", __func__);
1750 /* account for transferred data */
1751 countback = urb->actual_length;
1752 data_offset = priv->write_offset;
1753 if (data_offset > 0) {
1754 /* Subtract the control bytes */
1755 countback -= (data_offset * DIV_ROUND_UP(countback, PKTSZ));
1757 spin_lock_irqsave(&priv->tx_lock, flags);
1758 --priv->tx_outstanding_urbs;
1759 priv->tx_outstanding_bytes -= countback;
1760 spin_unlock_irqrestore(&priv->tx_lock, flags);
1762 usb_serial_port_softint(port);
1763 } /* ftdi_write_bulk_callback */
1766 static int ftdi_write_room(struct tty_struct *tty)
1768 struct usb_serial_port *port = tty->driver_data;
1769 struct ftdi_private *priv = usb_get_serial_port_data(port);
1771 unsigned long flags;
1773 dbg("%s - port %d", __func__, port->number);
1775 spin_lock_irqsave(&priv->tx_lock, flags);
1776 if (priv->tx_outstanding_urbs < URB_UPPER_LIMIT) {
1778 * We really can take anything the user throws at us
1779 * but let's pick a nice big number to tell the tty
1780 * layer that we have lots of free space
1786 spin_unlock_irqrestore(&priv->tx_lock, flags);
1790 static int ftdi_chars_in_buffer(struct tty_struct *tty)
1792 struct usb_serial_port *port = tty->driver_data;
1793 struct ftdi_private *priv = usb_get_serial_port_data(port);
1795 unsigned long flags;
1797 dbg("%s - port %d", __func__, port->number);
1799 spin_lock_irqsave(&priv->tx_lock, flags);
1800 buffered = (int)priv->tx_outstanding_bytes;
1801 spin_unlock_irqrestore(&priv->tx_lock, flags);
1803 dev_err(&port->dev, "%s outstanding tx bytes is negative!\n",
1810 static void ftdi_read_bulk_callback(struct urb *urb)
1812 struct usb_serial_port *port = urb->context;
1813 struct tty_struct *tty;
1814 struct ftdi_private *priv;
1815 unsigned long countread;
1816 unsigned long flags;
1817 int status = urb->status;
1819 if (urb->number_of_packets > 0) {
1820 dev_err(&port->dev, "%s transfer_buffer_length %d "
1821 "actual_length %d number of packets %d\n", __func__,
1822 urb->transfer_buffer_length,
1823 urb->actual_length, urb->number_of_packets);
1824 dev_err(&port->dev, "%s transfer_flags %x\n", __func__,
1825 urb->transfer_flags);
1828 dbg("%s - port %d", __func__, port->number);
1830 if (port->port.count <= 0)
1833 tty = tty_port_tty_get(&port->port);
1835 dbg("%s - bad tty pointer - exiting", __func__);
1839 priv = usb_get_serial_port_data(port);
1841 dbg("%s - bad port private data pointer - exiting", __func__);
1845 if (urb != port->read_urb)
1846 dev_err(&port->dev, "%s - Not my urb!\n", __func__);
1849 /* This will happen at close every time so it is a dbg not an
1851 dbg("(this is ok on close) nonzero read bulk status received: %d", status);
1855 /* count data bytes, but not status bytes */
1856 countread = urb->actual_length;
1857 countread -= 2 * DIV_ROUND_UP(countread, PKTSZ);
1858 spin_lock_irqsave(&priv->rx_lock, flags);
1859 priv->rx_bytes += countread;
1860 spin_unlock_irqrestore(&priv->rx_lock, flags);
1862 ftdi_process_read(&priv->rx_work.work);
1865 } /* ftdi_read_bulk_callback */
1868 static void ftdi_process_read(struct work_struct *work)
1869 { /* ftdi_process_read */
1870 struct ftdi_private *priv =
1871 container_of(work, struct ftdi_private, rx_work.work);
1872 struct usb_serial_port *port = priv->port;
1874 struct tty_struct *tty;
1876 unsigned char *data;
1882 unsigned long flags;
1884 dbg("%s - port %d", __func__, port->number);
1886 if (port->port.count <= 0)
1889 tty = tty_port_tty_get(&port->port);
1891 dbg("%s - bad tty pointer - exiting", __func__);
1895 priv = usb_get_serial_port_data(port);
1897 dbg("%s - bad port private data pointer - exiting", __func__);
1901 urb = port->read_urb;
1903 dbg("%s - bad read_urb pointer - exiting", __func__);
1907 data = urb->transfer_buffer;
1909 if (priv->rx_processed) {
1910 dbg("%s - already processed: %d bytes, %d remain", __func__,
1912 urb->actual_length - priv->rx_processed);
1914 /* The first two bytes of every read packet are status */
1915 if (urb->actual_length > 2)
1916 usb_serial_debug_data(debug, &port->dev, __func__,
1917 urb->actual_length, data);
1919 dbg("Status only: %03oo %03oo", data[0], data[1]);
1923 /* TO DO -- check for hung up line and handle appropriately: */
1925 /* See acm.c - you do a tty_hangup - eg tty_hangup(tty) */
1926 /* if CD is dropped and the line is not CLOCAL then we should hangup */
1929 for (packet_offset = priv->rx_processed;
1930 packet_offset < urb->actual_length; packet_offset += PKTSZ) {
1933 /* Compare new line status to the old one, signal if different/
1934 N.B. packet may be processed more than once, but differences
1935 are only processed once. */
1937 char new_status = data[packet_offset + 0] &
1938 FTDI_STATUS_B0_MASK;
1939 if (new_status != priv->prev_status) {
1940 priv->diff_status |=
1941 new_status ^ priv->prev_status;
1942 wake_up_interruptible(&priv->delta_msr_wait);
1943 priv->prev_status = new_status;
1947 length = min(PKTSZ, urb->actual_length-packet_offset)-2;
1949 dev_err(&port->dev, "%s - bad packet length: %d\n",
1950 __func__, length+2);
1954 if (priv->rx_flags & THROTTLED) {
1955 dbg("%s - throttled", __func__);
1958 if (tty_buffer_request_room(tty, length) < length) {
1959 /* break out & wait for throttling/unthrottling to
1961 dbg("%s - receive room low", __func__);
1965 /* Handle errors and break */
1966 error_flag = TTY_NORMAL;
1967 /* Although the device uses a bitmask and hence can have
1968 multiple errors on a packet - the order here sets the
1969 priority the error is returned to the tty layer */
1971 if (data[packet_offset+1] & FTDI_RS_OE) {
1972 error_flag = TTY_OVERRUN;
1973 dbg("OVERRRUN error");
1975 if (data[packet_offset+1] & FTDI_RS_BI) {
1976 error_flag = TTY_BREAK;
1977 dbg("BREAK received");
1979 if (data[packet_offset+1] & FTDI_RS_PE) {
1980 error_flag = TTY_PARITY;
1981 dbg("PARITY error");
1983 if (data[packet_offset+1] & FTDI_RS_FE) {
1984 error_flag = TTY_FRAME;
1985 dbg("FRAMING error");
1988 for (i = 2; i < length+2; i++) {
1989 /* Note that the error flag is duplicated for
1990 every character received since we don't know
1991 which character it applied to */
1992 tty_insert_flip_char(tty,
1993 data[packet_offset + i], error_flag);
1998 #ifdef NOT_CORRECT_BUT_KEEPING_IT_FOR_NOW
1999 /* if a parity error is detected you get status packets forever
2000 until a character is sent without a parity error.
2001 This doesn't work well since the application receives a
2002 never ending stream of bad data - even though new data
2003 hasn't been sent. Therefore I (bill) have taken this out.
2004 However - this might make sense for framing errors and so on
2005 so I am leaving the code in for now.
2008 if (error_flag != TTY_NORMAL) {
2009 dbg("error_flag is not normal");
2010 /* In this case it is just status - if that is
2011 an error send a bad character */
2012 if (tty->flip.count >= TTY_FLIPBUF_SIZE)
2013 tty_flip_buffer_push(tty);
2014 tty_insert_flip_char(tty, 0xff, error_flag);
2019 } /* "for(packet_offset=0..." */
2023 tty_flip_buffer_push(tty);
2025 if (packet_offset < urb->actual_length) {
2026 /* not completely processed - record progress */
2027 priv->rx_processed = packet_offset;
2028 dbg("%s - incomplete, %d bytes processed, %d remain",
2029 __func__, packet_offset,
2030 urb->actual_length - packet_offset);
2031 /* check if we were throttled while processing */
2032 spin_lock_irqsave(&priv->rx_lock, flags);
2033 if (priv->rx_flags & THROTTLED) {
2034 priv->rx_flags |= ACTUALLY_THROTTLED;
2035 spin_unlock_irqrestore(&priv->rx_lock, flags);
2036 dbg("%s - deferring remainder until unthrottled",
2040 spin_unlock_irqrestore(&priv->rx_lock, flags);
2041 /* if the port is closed stop trying to read */
2042 if (port->port.count > 0)
2043 /* delay processing of remainder */
2044 schedule_delayed_work(&priv->rx_work, 1);
2046 dbg("%s - port is closed", __func__);
2050 /* urb is completely processed */
2051 priv->rx_processed = 0;
2053 /* if the port is closed stop trying to read */
2054 if (port->port.count > 0) {
2055 /* Continue trying to always read */
2056 usb_fill_bulk_urb(port->read_urb, port->serial->dev,
2057 usb_rcvbulkpipe(port->serial->dev,
2058 port->bulk_in_endpointAddress),
2059 port->read_urb->transfer_buffer,
2060 port->read_urb->transfer_buffer_length,
2061 ftdi_read_bulk_callback, port);
2063 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
2066 "%s - failed resubmitting read urb, error %d\n",
2071 } /* ftdi_process_read */
2074 static void ftdi_break_ctl(struct tty_struct *tty, int break_state)
2076 struct usb_serial_port *port = tty->driver_data;
2077 struct ftdi_private *priv = usb_get_serial_port_data(port);
2078 __u16 urb_value = 0;
2081 /* break_state = -1 to turn on break, and 0 to turn off break */
2082 /* see drivers/char/tty_io.c to see it used */
2083 /* last_set_data_urb_value NEVER has the break bit set in it */
2086 urb_value = priv->last_set_data_urb_value | FTDI_SIO_SET_BREAK;
2088 urb_value = priv->last_set_data_urb_value;
2090 if (usb_control_msg(port->serial->dev,
2091 usb_sndctrlpipe(port->serial->dev, 0),
2092 FTDI_SIO_SET_DATA_REQUEST,
2093 FTDI_SIO_SET_DATA_REQUEST_TYPE,
2094 urb_value , priv->interface,
2095 buf, 0, WDR_TIMEOUT) < 0) {
2096 dev_err(&port->dev, "%s FAILED to enable/disable break state "
2097 "(state was %d)\n", __func__, break_state);
2100 dbg("%s break state is %d - urb is %d", __func__,
2101 break_state, urb_value);
2106 /* old_termios contains the original termios settings and tty->termios contains
2107 * the new setting to be used
2108 * WARNING: set_termios calls this with old_termios in kernel space
2111 static void ftdi_set_termios(struct tty_struct *tty,
2112 struct usb_serial_port *port, struct ktermios *old_termios)
2113 { /* ftdi_termios */
2114 struct usb_device *dev = port->serial->dev;
2115 struct ftdi_private *priv = usb_get_serial_port_data(port);
2116 struct ktermios *termios = tty->termios;
2117 unsigned int cflag = termios->c_cflag;
2118 __u16 urb_value; /* will hold the new flags */
2119 char buf[1]; /* Perhaps I should dynamically alloc this? */
2121 /* Added for xon/xoff support */
2122 unsigned int iflag = termios->c_iflag;
2123 unsigned char vstop;
2124 unsigned char vstart;
2126 dbg("%s", __func__);
2128 /* Force baud rate if this device requires it, unless it is set to
2130 if (priv->force_baud && ((termios->c_cflag & CBAUD) != B0)) {
2131 dbg("%s: forcing baud rate for this device", __func__);
2132 tty_encode_baud_rate(tty, priv->force_baud,
2136 /* Force RTS-CTS if this device requires it. */
2137 if (priv->force_rtscts) {
2138 dbg("%s: forcing rtscts for this device", __func__);
2139 termios->c_cflag |= CRTSCTS;
2142 cflag = termios->c_cflag;
2144 /* FIXME -For this cut I don't care if the line is really changing or
2145 not - so just do the change regardless - should be able to
2146 compare old_termios and tty->termios */
2147 /* NOTE These routines can get interrupted by
2148 ftdi_sio_read_bulk_callback - need to examine what this means -
2149 don't see any problems yet */
2151 /* Set number of data bits, parity, stop bits */
2153 termios->c_cflag &= ~CMSPAR;
2156 urb_value |= (cflag & CSTOPB ? FTDI_SIO_SET_DATA_STOP_BITS_2 :
2157 FTDI_SIO_SET_DATA_STOP_BITS_1);
2158 urb_value |= (cflag & PARENB ?
2159 (cflag & PARODD ? FTDI_SIO_SET_DATA_PARITY_ODD :
2160 FTDI_SIO_SET_DATA_PARITY_EVEN) :
2161 FTDI_SIO_SET_DATA_PARITY_NONE);
2162 if (cflag & CSIZE) {
2163 switch (cflag & CSIZE) {
2164 case CS5: urb_value |= 5; dbg("Setting CS5"); break;
2165 case CS6: urb_value |= 6; dbg("Setting CS6"); break;
2166 case CS7: urb_value |= 7; dbg("Setting CS7"); break;
2167 case CS8: urb_value |= 8; dbg("Setting CS8"); break;
2169 dev_err(&port->dev, "CSIZE was set but not CS5-CS8\n");
2173 /* This is needed by the break command since it uses the same command
2174 - but is or'ed with this value */
2175 priv->last_set_data_urb_value = urb_value;
2177 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2178 FTDI_SIO_SET_DATA_REQUEST,
2179 FTDI_SIO_SET_DATA_REQUEST_TYPE,
2180 urb_value , priv->interface,
2181 buf, 0, WDR_SHORT_TIMEOUT) < 0) {
2182 dev_err(&port->dev, "%s FAILED to set "
2183 "databits/stopbits/parity\n", __func__);
2186 /* Now do the baudrate */
2187 if ((cflag & CBAUD) == B0) {
2188 /* Disable flow control */
2189 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2190 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2191 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2193 buf, 0, WDR_TIMEOUT) < 0) {
2195 "%s error from disable flowcontrol urb\n",
2198 /* Drop RTS and DTR */
2199 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2201 /* set the baudrate determined before */
2202 if (change_speed(tty, port))
2203 dev_err(&port->dev, "%s urb failed to set baudrate\n",
2205 /* Ensure RTS and DTR are raised when baudrate changed from 0 */
2206 if (!old_termios || (old_termios->c_cflag & CBAUD) == B0)
2207 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2210 /* Set flow control */
2211 /* Note device also supports DTR/CD (ugh) and Xon/Xoff in hardware */
2212 if (cflag & CRTSCTS) {
2213 dbg("%s Setting to CRTSCTS flow control", __func__);
2214 if (usb_control_msg(dev,
2215 usb_sndctrlpipe(dev, 0),
2216 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2217 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2218 0 , (FTDI_SIO_RTS_CTS_HS | priv->interface),
2219 buf, 0, WDR_TIMEOUT) < 0) {
2221 "urb failed to set to rts/cts flow control\n");
2228 * Check the IXOFF status in the iflag component of the
2229 * termios structure. If IXOFF is not set, the pre-xon/xoff
2232 if (iflag & IXOFF) {
2233 dbg("%s request to enable xonxoff iflag=%04x",
2235 /* Try to enable the XON/XOFF on the ftdi_sio
2236 * Set the vstart and vstop -- could have been done up
2237 * above where a lot of other dereferencing is done but
2238 * that would be very inefficient as vstart and vstop
2239 * are not always needed.
2241 vstart = termios->c_cc[VSTART];
2242 vstop = termios->c_cc[VSTOP];
2243 urb_value = (vstop << 8) | (vstart);
2245 if (usb_control_msg(dev,
2246 usb_sndctrlpipe(dev, 0),
2247 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2248 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2249 urb_value , (FTDI_SIO_XON_XOFF_HS
2251 buf, 0, WDR_TIMEOUT) < 0) {
2252 dev_err(&port->dev, "urb failed to set to "
2253 "xon/xoff flow control\n");
2256 /* else clause to only run if cflag ! CRTSCTS and iflag
2257 * ! XOFF. CHECKME Assuming XON/XOFF handled by tty
2258 * stack - not by device */
2259 dbg("%s Turning off hardware flow control", __func__);
2260 if (usb_control_msg(dev,
2261 usb_sndctrlpipe(dev, 0),
2262 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2263 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2265 buf, 0, WDR_TIMEOUT) < 0) {
2267 "urb failed to clear flow control\n");
2275 static int ftdi_tiocmget(struct tty_struct *tty, struct file *file)
2277 struct usb_serial_port *port = tty->driver_data;
2278 struct ftdi_private *priv = usb_get_serial_port_data(port);
2279 unsigned char buf[2];
2282 dbg("%s TIOCMGET", __func__);
2283 switch (priv->chip_type) {
2285 /* Request the status from the device */
2286 ret = usb_control_msg(port->serial->dev,
2287 usb_rcvctrlpipe(port->serial->dev, 0),
2288 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
2289 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
2291 buf, 1, WDR_TIMEOUT);
2293 dbg("%s Could not get modem status of device - err: %d", __func__,
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
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,
2310 buf, 2, WDR_TIMEOUT);
2312 dbg("%s Could not get modem status of device - err: %d", __func__,
2322 return (buf[0] & FTDI_SIO_DSR_MASK ? TIOCM_DSR : 0) |
2323 (buf[0] & FTDI_SIO_CTS_MASK ? TIOCM_CTS : 0) |
2324 (buf[0] & FTDI_SIO_RI_MASK ? TIOCM_RI : 0) |
2325 (buf[0] & FTDI_SIO_RLSD_MASK ? TIOCM_CD : 0) |
2329 static int ftdi_tiocmset(struct tty_struct *tty, struct file *file,
2330 unsigned int set, unsigned int clear)
2332 struct usb_serial_port *port = tty->driver_data;
2333 dbg("%s TIOCMSET", __func__);
2334 return update_mctrl(port, set, clear);
2338 static int ftdi_ioctl(struct tty_struct *tty, struct file *file,
2339 unsigned int cmd, unsigned long arg)
2341 struct usb_serial_port *port = tty->driver_data;
2342 struct ftdi_private *priv = usb_get_serial_port_data(port);
2344 dbg("%s cmd 0x%04x", __func__, cmd);
2346 /* Based on code from acm.c and others */
2349 case TIOCGSERIAL: /* gets serial port data */
2350 return get_serial_info(port,
2351 (struct serial_struct __user *) arg);
2353 case TIOCSSERIAL: /* sets serial port data */
2354 return set_serial_info(tty, port,
2355 (struct serial_struct __user *) arg);
2358 * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
2359 * - mask passed in arg for lines of interest
2360 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
2361 * Caller should use TIOCGICOUNT to see which one it was.
2363 * This code is borrowed from linux/drivers/char/serial.c
2366 while (priv != NULL) {
2367 interruptible_sleep_on(&priv->delta_msr_wait);
2368 /* see if a signal did it */
2369 if (signal_pending(current))
2370 return -ERESTARTSYS;
2372 char diff = priv->diff_status;
2375 return -EIO; /* no change => error */
2377 /* Consume all events */
2378 priv->diff_status = 0;
2380 /* Return 0 if caller wanted to know about
2382 if (((arg & TIOCM_RNG) && (diff & FTDI_RS0_RI)) ||
2383 ((arg & TIOCM_DSR) && (diff & FTDI_RS0_DSR)) ||
2384 ((arg & TIOCM_CD) && (diff & FTDI_RS0_RLSD)) ||
2385 ((arg & TIOCM_CTS) && (diff & FTDI_RS0_CTS))) {
2389 * Otherwise caller can't care less about what
2390 * happened,and so we continue to wait for more
2399 /* This is not necessarily an error - turns out the higher layers
2400 * will do some ioctls themselves (see comment above)
2402 dbg("%s arg not supported - it was 0x%04x - check /usr/include/asm/ioctls.h", __func__, cmd);
2403 return -ENOIOCTLCMD;
2406 static void ftdi_throttle(struct tty_struct *tty)
2408 struct usb_serial_port *port = tty->driver_data;
2409 struct ftdi_private *priv = usb_get_serial_port_data(port);
2410 unsigned long flags;
2412 dbg("%s - port %d", __func__, port->number);
2414 spin_lock_irqsave(&priv->rx_lock, flags);
2415 priv->rx_flags |= THROTTLED;
2416 spin_unlock_irqrestore(&priv->rx_lock, flags);
2420 static void ftdi_unthrottle(struct tty_struct *tty)
2422 struct usb_serial_port *port = tty->driver_data;
2423 struct ftdi_private *priv = usb_get_serial_port_data(port);
2424 int actually_throttled;
2425 unsigned long flags;
2427 dbg("%s - port %d", __func__, port->number);
2429 spin_lock_irqsave(&priv->rx_lock, flags);
2430 actually_throttled = priv->rx_flags & ACTUALLY_THROTTLED;
2431 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
2432 spin_unlock_irqrestore(&priv->rx_lock, flags);
2434 if (actually_throttled)
2435 schedule_delayed_work(&priv->rx_work, 0);
2438 static int __init ftdi_init(void)
2442 dbg("%s", __func__);
2443 if (vendor > 0 && product > 0) {
2444 /* Add user specified VID/PID to reserved element of table. */
2446 for (i = 0; id_table_combined[i].idVendor; i++)
2448 id_table_combined[i].match_flags = USB_DEVICE_ID_MATCH_DEVICE;
2449 id_table_combined[i].idVendor = vendor;
2450 id_table_combined[i].idProduct = product;
2452 retval = usb_serial_register(&ftdi_sio_device);
2454 goto failed_sio_register;
2455 retval = usb_register(&ftdi_driver);
2457 goto failed_usb_register;
2459 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
2462 failed_usb_register:
2463 usb_serial_deregister(&ftdi_sio_device);
2464 failed_sio_register:
2469 static void __exit ftdi_exit(void)
2472 dbg("%s", __func__);
2474 usb_deregister(&ftdi_driver);
2475 usb_serial_deregister(&ftdi_sio_device);
2480 module_init(ftdi_init);
2481 module_exit(ftdi_exit);
2483 MODULE_AUTHOR(DRIVER_AUTHOR);
2484 MODULE_DESCRIPTION(DRIVER_DESC);
2485 MODULE_LICENSE("GPL");
2487 module_param(debug, bool, S_IRUGO | S_IWUSR);
2488 MODULE_PARM_DESC(debug, "Debug enabled or not");
2489 module_param(vendor, ushort, 0);
2490 MODULE_PARM_DESC(vendor, "User specified vendor ID (default="
2491 __MODULE_STRING(FTDI_VID)")");
2492 module_param(product, ushort, 0);
2493 MODULE_PARM_DESC(product, "User specified product ID");