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;
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 port interface (0 for FT232/245) */
87 speed_t force_baud; /* if non-zero, force the baud rate to
89 int force_rtscts; /* if non-zero, force RTS-CTS to always
92 unsigned int latency; /* latency setting in use */
93 spinlock_t tx_lock; /* spinlock for transmit state */
94 unsigned long tx_bytes;
95 unsigned long tx_outstanding_bytes;
96 unsigned long tx_outstanding_urbs;
99 /* struct ftdi_sio_quirk is used by devices requiring special attention. */
100 struct ftdi_sio_quirk {
101 int (*probe)(struct usb_serial *);
102 /* Special settings for probed ports. */
103 void (*port_probe)(struct ftdi_private *);
106 static int ftdi_jtag_probe(struct usb_serial *serial);
107 static int ftdi_mtxorb_hack_setup(struct usb_serial *serial);
108 static void ftdi_USB_UIRT_setup(struct ftdi_private *priv);
109 static void ftdi_HE_TIRA1_setup(struct ftdi_private *priv);
111 static struct ftdi_sio_quirk ftdi_jtag_quirk = {
112 .probe = ftdi_jtag_probe,
115 static struct ftdi_sio_quirk ftdi_mtxorb_hack_quirk = {
116 .probe = ftdi_mtxorb_hack_setup,
119 static struct ftdi_sio_quirk ftdi_USB_UIRT_quirk = {
120 .port_probe = ftdi_USB_UIRT_setup,
123 static struct ftdi_sio_quirk ftdi_HE_TIRA1_quirk = {
124 .port_probe = ftdi_HE_TIRA1_setup,
128 * The 8U232AM has the same API as the sio except for:
129 * - it can support MUCH higher baudrates; up to:
130 * o 921600 for RS232 and 2000000 for RS422/485 at 48MHz
132 * so .. 8U232AM's baudrate setting codes are different
133 * - it has a two byte status code.
134 * - it returns characters every 16ms (the FTDI does it every 40ms)
136 * the bcdDevice value is used to differentiate FT232BM and FT245BM from
137 * the earlier FT8U232AM and FT8U232BM. For now, include all known VID/PID
138 * combinations in both tables.
139 * FIXME: perhaps bcdDevice can also identify 12MHz FT8U232AM devices,
140 * but I don't know if those ever went into mass production. [Ian Abbott]
145 static struct usb_device_id id_table_combined [] = {
146 { USB_DEVICE(FTDI_VID, FTDI_AMC232_PID) },
147 { USB_DEVICE(FTDI_VID, FTDI_CANUSB_PID) },
148 { USB_DEVICE(FTDI_VID, FTDI_CANDAPTER_PID) },
149 { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_0_PID) },
150 { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_1_PID) },
151 { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_2_PID) },
152 { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_3_PID) },
153 { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_4_PID) },
154 { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_5_PID) },
155 { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_6_PID) },
156 { USB_DEVICE(FTDI_VID, FTDI_SCS_DEVICE_7_PID) },
157 { USB_DEVICE(FTDI_VID, FTDI_ACTZWAVE_PID) },
158 { USB_DEVICE(FTDI_VID, FTDI_IRTRANS_PID) },
159 { USB_DEVICE(FTDI_VID, FTDI_IPLUS_PID) },
160 { USB_DEVICE(FTDI_VID, FTDI_IPLUS2_PID) },
161 { USB_DEVICE(FTDI_VID, FTDI_DMX4ALL) },
162 { USB_DEVICE(FTDI_VID, FTDI_SIO_PID) },
163 { USB_DEVICE(FTDI_VID, FTDI_8U232AM_PID) },
164 { USB_DEVICE(FTDI_VID, FTDI_8U232AM_ALT_PID) },
165 { USB_DEVICE(FTDI_VID, FTDI_232RL_PID) },
166 { USB_DEVICE(FTDI_VID, FTDI_8U2232C_PID) },
167 { USB_DEVICE(FTDI_VID, FTDI_MICRO_CHAMELEON_PID) },
168 { USB_DEVICE(FTDI_VID, FTDI_RELAIS_PID) },
169 { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_PID) },
170 { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_IOBOARD_PID) },
171 { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_MINI_IOBOARD_PID) },
172 { USB_DEVICE(FTDI_VID, FTDI_SPROG_II) },
173 { USB_DEVICE(FTDI_VID, FTDI_XF_632_PID) },
174 { USB_DEVICE(FTDI_VID, FTDI_XF_634_PID) },
175 { USB_DEVICE(FTDI_VID, FTDI_XF_547_PID) },
176 { USB_DEVICE(FTDI_VID, FTDI_XF_633_PID) },
177 { USB_DEVICE(FTDI_VID, FTDI_XF_631_PID) },
178 { USB_DEVICE(FTDI_VID, FTDI_XF_635_PID) },
179 { USB_DEVICE(FTDI_VID, FTDI_XF_640_PID) },
180 { USB_DEVICE(FTDI_VID, FTDI_XF_642_PID) },
181 { USB_DEVICE(FTDI_VID, FTDI_DSS20_PID) },
182 { USB_DEVICE(FTDI_NF_RIC_VID, FTDI_NF_RIC_PID) },
183 { USB_DEVICE(FTDI_VID, FTDI_VNHCPCUSB_D_PID) },
184 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_0_PID) },
185 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_1_PID) },
186 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_2_PID) },
187 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_3_PID) },
188 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_4_PID) },
189 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_5_PID) },
190 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_6_PID) },
191 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0100_PID) },
192 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0101_PID) },
193 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0102_PID) },
194 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0103_PID) },
195 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0104_PID) },
196 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0105_PID) },
197 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0106_PID) },
198 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0107_PID) },
199 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0108_PID) },
200 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0109_PID) },
201 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010A_PID) },
202 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010B_PID) },
203 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010C_PID) },
204 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010D_PID) },
205 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010E_PID) },
206 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_010F_PID) },
207 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0110_PID) },
208 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0111_PID) },
209 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0112_PID) },
210 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0113_PID) },
211 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0114_PID) },
212 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0115_PID) },
213 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0116_PID) },
214 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0117_PID) },
215 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0118_PID) },
216 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0119_PID) },
217 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011A_PID) },
218 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011B_PID) },
219 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011C_PID) },
220 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011D_PID) },
221 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011E_PID) },
222 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_011F_PID) },
223 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0120_PID) },
224 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0121_PID) },
225 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0122_PID) },
226 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0123_PID) },
227 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0124_PID) },
228 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0125_PID) },
229 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0126_PID) },
230 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0127_PID),
231 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
232 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0128_PID) },
233 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0129_PID) },
234 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012A_PID) },
235 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012B_PID) },
236 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012C_PID),
237 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
238 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012D_PID) },
239 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012E_PID) },
240 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_012F_PID) },
241 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0130_PID) },
242 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0131_PID) },
243 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0132_PID) },
244 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0133_PID) },
245 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0134_PID) },
246 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0135_PID) },
247 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0136_PID) },
248 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0137_PID) },
249 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0138_PID) },
250 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0139_PID) },
251 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013A_PID) },
252 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013B_PID) },
253 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013C_PID) },
254 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013D_PID) },
255 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013E_PID) },
256 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_013F_PID) },
257 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0140_PID) },
258 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0141_PID) },
259 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0142_PID) },
260 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0143_PID) },
261 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0144_PID) },
262 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0145_PID) },
263 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0146_PID) },
264 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0147_PID) },
265 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0148_PID) },
266 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0149_PID) },
267 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014A_PID) },
268 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014B_PID) },
269 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014C_PID) },
270 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014D_PID) },
271 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014E_PID) },
272 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_014F_PID) },
273 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0150_PID) },
274 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0151_PID) },
275 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0152_PID) },
276 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0153_PID),
277 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
278 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0154_PID),
279 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
280 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0155_PID),
281 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
282 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0156_PID),
283 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
284 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0157_PID),
285 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
286 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0158_PID),
287 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
288 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0159_PID) },
289 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015A_PID) },
290 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015B_PID) },
291 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015C_PID) },
292 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015D_PID) },
293 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015E_PID) },
294 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_015F_PID) },
295 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0160_PID) },
296 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0161_PID) },
297 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0162_PID) },
298 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0163_PID) },
299 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0164_PID) },
300 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0165_PID) },
301 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0166_PID) },
302 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0167_PID) },
303 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0168_PID) },
304 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0169_PID) },
305 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016A_PID) },
306 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016B_PID) },
307 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016C_PID) },
308 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016D_PID) },
309 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016E_PID) },
310 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_016F_PID) },
311 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0170_PID) },
312 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0171_PID) },
313 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0172_PID) },
314 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0173_PID) },
315 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0174_PID) },
316 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0175_PID) },
317 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0176_PID) },
318 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0177_PID) },
319 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0178_PID) },
320 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0179_PID) },
321 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017A_PID) },
322 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017B_PID) },
323 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017C_PID) },
324 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017D_PID) },
325 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017E_PID) },
326 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_017F_PID) },
327 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0180_PID) },
328 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0181_PID) },
329 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0182_PID) },
330 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0183_PID) },
331 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0184_PID) },
332 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0185_PID) },
333 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0186_PID) },
334 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0187_PID) },
335 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0188_PID) },
336 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0189_PID) },
337 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018A_PID) },
338 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018B_PID) },
339 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018C_PID) },
340 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018D_PID) },
341 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018E_PID) },
342 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_018F_PID) },
343 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0190_PID) },
344 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0191_PID) },
345 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0192_PID) },
346 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0193_PID) },
347 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0194_PID) },
348 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0195_PID) },
349 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0196_PID) },
350 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0197_PID) },
351 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0198_PID) },
352 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_0199_PID) },
353 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019A_PID) },
354 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019B_PID) },
355 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019C_PID) },
356 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019D_PID) },
357 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019E_PID) },
358 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_019F_PID) },
359 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A0_PID) },
360 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A1_PID) },
361 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A2_PID) },
362 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A3_PID) },
363 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A4_PID) },
364 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A5_PID) },
365 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A6_PID) },
366 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A7_PID) },
367 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A8_PID) },
368 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01A9_PID) },
369 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AA_PID) },
370 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AB_PID) },
371 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AC_PID) },
372 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AD_PID) },
373 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AE_PID) },
374 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01AF_PID) },
375 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B0_PID) },
376 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B1_PID) },
377 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B2_PID) },
378 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B3_PID) },
379 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B4_PID) },
380 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B5_PID) },
381 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B6_PID) },
382 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B7_PID) },
383 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B8_PID) },
384 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01B9_PID) },
385 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BA_PID) },
386 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BB_PID) },
387 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BC_PID) },
388 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BD_PID) },
389 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BE_PID) },
390 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01BF_PID) },
391 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C0_PID) },
392 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C1_PID) },
393 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C2_PID) },
394 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C3_PID) },
395 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C4_PID) },
396 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C5_PID) },
397 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C6_PID) },
398 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C7_PID) },
399 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C8_PID) },
400 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01C9_PID) },
401 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CA_PID) },
402 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CB_PID) },
403 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CC_PID) },
404 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CD_PID) },
405 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CE_PID) },
406 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01CF_PID) },
407 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D0_PID) },
408 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D1_PID) },
409 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D2_PID) },
410 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D3_PID) },
411 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D4_PID) },
412 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D5_PID) },
413 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D6_PID) },
414 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D7_PID) },
415 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D8_PID) },
416 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01D9_PID) },
417 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DA_PID) },
418 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DB_PID) },
419 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DC_PID) },
420 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DD_PID) },
421 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DE_PID) },
422 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01DF_PID) },
423 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E0_PID) },
424 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E1_PID) },
425 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E2_PID) },
426 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E3_PID) },
427 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E4_PID) },
428 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E5_PID) },
429 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E6_PID) },
430 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E7_PID) },
431 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E8_PID) },
432 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01E9_PID) },
433 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EA_PID) },
434 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EB_PID) },
435 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EC_PID) },
436 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01ED_PID) },
437 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EE_PID) },
438 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01EF_PID) },
439 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F0_PID) },
440 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F1_PID) },
441 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F2_PID) },
442 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F3_PID) },
443 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F4_PID) },
444 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F5_PID) },
445 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F6_PID) },
446 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F7_PID) },
447 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F8_PID) },
448 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01F9_PID) },
449 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FA_PID) },
450 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FB_PID) },
451 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FC_PID) },
452 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FD_PID) },
453 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FE_PID) },
454 { USB_DEVICE(MTXORB_VID, MTXORB_FTDI_RANGE_01FF_PID) },
455 { USB_DEVICE(FTDI_VID, FTDI_PERLE_ULTRAPORT_PID) },
456 { USB_DEVICE(FTDI_VID, FTDI_PIEGROUP_PID) },
457 { USB_DEVICE(FTDI_VID, FTDI_TNC_X_PID) },
458 { USB_DEVICE(FTDI_VID, FTDI_USBX_707_PID) },
459 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2101_PID) },
460 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2102_PID) },
461 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2103_PID) },
462 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2104_PID) },
463 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2106_PID) },
464 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_1_PID) },
465 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_2_PID) },
466 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_1_PID) },
467 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_2_PID) },
468 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_1_PID) },
469 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_2_PID) },
470 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_1_PID) },
471 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_2_PID) },
472 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_3_PID) },
473 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_4_PID) },
474 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_1_PID) },
475 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_2_PID) },
476 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_3_PID) },
477 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_4_PID) },
478 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_1_PID) },
479 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_2_PID) },
480 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_3_PID) },
481 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_4_PID) },
482 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_1_PID) },
483 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_2_PID) },
484 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_3_PID) },
485 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_4_PID) },
486 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_5_PID) },
487 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_6_PID) },
488 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_7_PID) },
489 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_8_PID) },
490 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_1_PID) },
491 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_2_PID) },
492 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_3_PID) },
493 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_4_PID) },
494 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_5_PID) },
495 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_6_PID) },
496 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_7_PID) },
497 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_8_PID) },
498 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_1_PID) },
499 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_2_PID) },
500 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_3_PID) },
501 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_4_PID) },
502 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_5_PID) },
503 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_6_PID) },
504 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_7_PID) },
505 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_8_PID) },
506 { USB_DEVICE(IDTECH_VID, IDTECH_IDT1221U_PID) },
507 { USB_DEVICE(OCT_VID, OCT_US101_PID) },
508 { USB_DEVICE(FTDI_VID, FTDI_HE_TIRA1_PID),
509 .driver_info = (kernel_ulong_t)&ftdi_HE_TIRA1_quirk },
510 { USB_DEVICE(FTDI_VID, FTDI_USB_UIRT_PID),
511 .driver_info = (kernel_ulong_t)&ftdi_USB_UIRT_quirk },
512 { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_1) },
513 { USB_DEVICE(FTDI_VID, PROTEGO_R2X0) },
514 { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_3) },
515 { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_4) },
516 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E808_PID) },
517 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E809_PID) },
518 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80A_PID) },
519 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80B_PID) },
520 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80C_PID) },
521 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80D_PID) },
522 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80E_PID) },
523 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80F_PID) },
524 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E888_PID) },
525 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E889_PID) },
526 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88A_PID) },
527 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88B_PID) },
528 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88C_PID) },
529 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88D_PID) },
530 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88E_PID) },
531 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88F_PID) },
532 { USB_DEVICE(FTDI_VID, FTDI_ELV_UO100_PID) },
533 { USB_DEVICE(FTDI_VID, FTDI_ELV_UM100_PID) },
534 { USB_DEVICE(FTDI_VID, FTDI_ELV_UR100_PID) },
535 { USB_DEVICE(FTDI_VID, FTDI_ELV_ALC8500_PID) },
536 { USB_DEVICE(FTDI_VID, FTDI_PYRAMID_PID) },
537 { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1000PC_PID) },
538 { USB_DEVICE(FTDI_VID, FTDI_IBS_US485_PID) },
539 { USB_DEVICE(FTDI_VID, FTDI_IBS_PICPRO_PID) },
540 { USB_DEVICE(FTDI_VID, FTDI_IBS_PCMCIA_PID) },
541 { USB_DEVICE(FTDI_VID, FTDI_IBS_PK1_PID) },
542 { USB_DEVICE(FTDI_VID, FTDI_IBS_RS232MON_PID) },
543 { USB_DEVICE(FTDI_VID, FTDI_IBS_APP70_PID) },
544 { USB_DEVICE(FTDI_VID, FTDI_IBS_PEDO_PID) },
545 { USB_DEVICE(FTDI_VID, FTDI_IBS_PROD_PID) },
547 * Due to many user requests for multiple ELV devices we enable
550 { USB_DEVICE(FTDI_VID, FTDI_ELV_CLI7000_PID) },
551 { USB_DEVICE(FTDI_VID, FTDI_ELV_PPS7330_PID) },
552 { USB_DEVICE(FTDI_VID, FTDI_ELV_TFM100_PID) },
553 { USB_DEVICE(FTDI_VID, FTDI_ELV_UDF77_PID) },
554 { USB_DEVICE(FTDI_VID, FTDI_ELV_UIO88_PID) },
555 { USB_DEVICE(FTDI_VID, FTDI_ELV_UAD8_PID) },
556 { USB_DEVICE(FTDI_VID, FTDI_ELV_UDA7_PID) },
557 { USB_DEVICE(FTDI_VID, FTDI_ELV_USI2_PID) },
558 { USB_DEVICE(FTDI_VID, FTDI_ELV_T1100_PID) },
559 { USB_DEVICE(FTDI_VID, FTDI_ELV_PCD200_PID) },
560 { USB_DEVICE(FTDI_VID, FTDI_ELV_ULA200_PID) },
561 { USB_DEVICE(FTDI_VID, FTDI_ELV_CSI8_PID) },
562 { USB_DEVICE(FTDI_VID, FTDI_ELV_EM1000DL_PID) },
563 { USB_DEVICE(FTDI_VID, FTDI_ELV_PCK100_PID) },
564 { USB_DEVICE(FTDI_VID, FTDI_ELV_RFP500_PID) },
565 { USB_DEVICE(FTDI_VID, FTDI_ELV_FS20SIG_PID) },
566 { USB_DEVICE(FTDI_VID, FTDI_ELV_WS300PC_PID) },
567 { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1300PC_PID) },
568 { USB_DEVICE(FTDI_VID, FTDI_ELV_EM1010PC_PID) },
569 { USB_DEVICE(FTDI_VID, FTDI_ELV_WS500_PID) },
570 { USB_DEVICE(FTDI_VID, FTDI_ELV_HS485_PID) },
571 { USB_DEVICE(FTDI_VID, LINX_SDMUSBQSS_PID) },
572 { USB_DEVICE(FTDI_VID, LINX_MASTERDEVEL2_PID) },
573 { USB_DEVICE(FTDI_VID, LINX_FUTURE_0_PID) },
574 { USB_DEVICE(FTDI_VID, LINX_FUTURE_1_PID) },
575 { USB_DEVICE(FTDI_VID, LINX_FUTURE_2_PID) },
576 { USB_DEVICE(FTDI_VID, FTDI_CCSICDU20_0_PID) },
577 { USB_DEVICE(FTDI_VID, FTDI_CCSICDU40_1_PID) },
578 { USB_DEVICE(FTDI_VID, FTDI_CCSMACHX_2_PID) },
579 { USB_DEVICE(FTDI_VID, INSIDE_ACCESSO) },
580 { USB_DEVICE(INTREPID_VID, INTREPID_VALUECAN_PID) },
581 { USB_DEVICE(INTREPID_VID, INTREPID_NEOVI_PID) },
582 { USB_DEVICE(FALCOM_VID, FALCOM_TWIST_PID) },
583 { USB_DEVICE(FALCOM_VID, FALCOM_SAMBA_PID) },
584 { USB_DEVICE(FTDI_VID, FTDI_SUUNTO_SPORTS_PID) },
585 { USB_DEVICE(FTDI_VID, FTDI_OCEANIC_PID) },
586 { USB_DEVICE(TTI_VID, TTI_QL355P_PID) },
587 { USB_DEVICE(FTDI_VID, FTDI_RM_CANVIEW_PID) },
588 { USB_DEVICE(BANDB_VID, BANDB_USOTL4_PID) },
589 { USB_DEVICE(BANDB_VID, BANDB_USTL4_PID) },
590 { USB_DEVICE(BANDB_VID, BANDB_USO9ML2_PID) },
591 { USB_DEVICE(FTDI_VID, EVER_ECO_PRO_CDS) },
592 { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_1_PID) },
593 { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_2_PID) },
594 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_0_PID) },
595 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_1_PID) },
596 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_2_PID) },
597 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_3_PID) },
598 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_4_PID) },
599 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_5_PID) },
600 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_6_PID) },
601 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_7_PID) },
602 { USB_DEVICE(MOBILITY_VID, MOBILITY_USB_SERIAL_PID) },
603 { USB_DEVICE(FTDI_VID, FTDI_ACTIVE_ROBOTS_PID) },
604 { USB_DEVICE(FTDI_VID, FTDI_MHAM_KW_PID) },
605 { USB_DEVICE(FTDI_VID, FTDI_MHAM_YS_PID) },
606 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y6_PID) },
607 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y8_PID) },
608 { USB_DEVICE(FTDI_VID, FTDI_MHAM_IC_PID) },
609 { USB_DEVICE(FTDI_VID, FTDI_MHAM_DB9_PID) },
610 { USB_DEVICE(FTDI_VID, FTDI_MHAM_RS232_PID) },
611 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y9_PID) },
612 { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_VCP_PID) },
613 { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_D2XX_PID) },
614 { USB_DEVICE(EVOLUTION_VID, EVOLUTION_ER1_PID) },
615 { USB_DEVICE(EVOLUTION_VID, EVO_HYBRID_PID) },
616 { USB_DEVICE(EVOLUTION_VID, EVO_RCM4_PID) },
617 { USB_DEVICE(FTDI_VID, FTDI_ARTEMIS_PID) },
618 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16_PID) },
619 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16C_PID) },
620 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HR_PID) },
621 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HRC_PID) },
622 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16IC_PID) },
623 { USB_DEVICE(KOBIL_VID, KOBIL_CONV_B1_PID) },
624 { USB_DEVICE(KOBIL_VID, KOBIL_CONV_KAAN_PID) },
625 { USB_DEVICE(POSIFLEX_VID, POSIFLEX_PP7000_PID) },
626 { USB_DEVICE(FTDI_VID, FTDI_TTUSB_PID) },
627 { USB_DEVICE(FTDI_VID, FTDI_ECLO_COM_1WIRE_PID) },
628 { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_777_PID) },
629 { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_8900F_PID) },
630 { USB_DEVICE(FTDI_VID, FTDI_PCDJ_DAC2_PID) },
631 { USB_DEVICE(FTDI_VID, FTDI_RRCIRKITS_LOCOBUFFER_PID) },
632 { USB_DEVICE(FTDI_VID, FTDI_ASK_RDR400_PID) },
633 { USB_DEVICE(ICOM_ID1_VID, ICOM_ID1_PID) },
634 { USB_DEVICE(PAPOUCH_VID, PAPOUCH_TMU_PID) },
635 { USB_DEVICE(FTDI_VID, FTDI_ACG_HFDUAL_PID) },
636 { USB_DEVICE(FTDI_VID, FTDI_YEI_SERVOCENTER31_PID) },
637 { USB_DEVICE(FTDI_VID, FTDI_THORLABS_PID) },
638 { USB_DEVICE(TESTO_VID, TESTO_USB_INTERFACE_PID) },
639 { USB_DEVICE(FTDI_VID, FTDI_GAMMA_SCOUT_PID) },
640 { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13M_PID) },
641 { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13S_PID) },
642 { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13U_PID) },
643 { USB_DEVICE(ELEKTOR_VID, ELEKTOR_FT323R_PID) },
644 { USB_DEVICE(TELLDUS_VID, TELLDUS_TELLSTICK_PID) },
645 { USB_DEVICE(FTDI_VID, FTDI_MAXSTREAM_PID) },
646 { USB_DEVICE(FTDI_VID, FTDI_PHI_FISCO_PID) },
647 { USB_DEVICE(TML_VID, TML_USB_SERIAL_PID) },
648 { USB_DEVICE(FTDI_VID, FTDI_ELSTER_UNICOM_PID) },
649 { USB_DEVICE(FTDI_VID, FTDI_PROPOX_JTAGCABLEII_PID) },
650 { USB_DEVICE(OLIMEX_VID, OLIMEX_ARM_USB_OCD_PID),
651 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
652 { USB_DEVICE(FIC_VID, FIC_NEO1973_DEBUG_PID),
653 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
654 { USB_DEVICE(FTDI_VID, FTDI_OOCDLINK_PID),
655 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
656 { USB_DEVICE(FTDI_VID, LMI_LM3S_DEVEL_BOARD_PID),
657 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
658 { USB_DEVICE(FTDI_VID, LMI_LM3S_EVAL_BOARD_PID),
659 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
660 { USB_DEVICE(RATOC_VENDOR_ID, RATOC_PRODUCT_ID_USB60F) },
661 { USB_DEVICE(FTDI_VID, FTDI_REU_TINY_PID) },
662 { USB_DEVICE(PAPOUCH_VID, PAPOUCH_QUIDO4x4_PID) },
663 { USB_DEVICE(FTDI_VID, FTDI_DOMINTELL_DGQG_PID) },
664 { USB_DEVICE(FTDI_VID, FTDI_DOMINTELL_DUSB_PID) },
665 { USB_DEVICE(ALTI2_VID, ALTI2_N3_PID) },
666 { USB_DEVICE(FTDI_VID, DIEBOLD_BCS_SE923_PID) },
667 { USB_DEVICE(FTDI_VID, FTDI_NDI_HUC_PID) },
668 { USB_DEVICE(ATMEL_VID, STK541_PID) },
669 { USB_DEVICE(DE_VID, STB_PID) },
670 { USB_DEVICE(DE_VID, WHT_PID) },
671 { USB_DEVICE(ADI_VID, ADI_GNICE_PID),
672 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
673 { USB_DEVICE(JETI_VID, JETI_SPC1201_PID) },
674 { USB_DEVICE(MARVELL_VID, MARVELL_SHEEVAPLUG_PID),
675 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
676 { }, /* Optional parameter entry */
677 { } /* Terminating entry */
680 MODULE_DEVICE_TABLE(usb, id_table_combined);
682 static struct usb_driver ftdi_driver = {
684 .probe = usb_serial_probe,
685 .disconnect = usb_serial_disconnect,
686 .id_table = id_table_combined,
690 static const char *ftdi_chip_name[] = {
691 [SIO] = "SIO", /* the serial part of FT8U100AX */
692 [FT8U232AM] = "FT8U232AM",
693 [FT232BM] = "FT232BM",
694 [FT2232C] = "FT2232C",
695 [FT232RL] = "FT232RL",
699 /* Constants for read urb and write urb */
704 #define THROTTLED 0x01
705 #define ACTUALLY_THROTTLED 0x02
707 /* Used for TIOCMIWAIT */
708 #define FTDI_STATUS_B0_MASK (FTDI_RS0_CTS | FTDI_RS0_DSR | FTDI_RS0_RI | FTDI_RS0_RLSD)
709 #define FTDI_STATUS_B1_MASK (FTDI_RS_BI)
712 #define FTDI_IMPL_ASYNC_FLAGS = (ASYNC_SPD_HI | ASYNC_SPD_VHI \
713 | ASYNC_SPD_CUST | ASYNC_SPD_SHI | ASYNC_SPD_WARP)
715 /* function prototypes for a FTDI serial converter */
716 static int ftdi_sio_probe(struct usb_serial *serial,
717 const struct usb_device_id *id);
718 static void ftdi_shutdown(struct usb_serial *serial);
719 static int ftdi_sio_port_probe(struct usb_serial_port *port);
720 static int ftdi_sio_port_remove(struct usb_serial_port *port);
721 static int ftdi_open(struct tty_struct *tty,
722 struct usb_serial_port *port, struct file *filp);
723 static void ftdi_close(struct usb_serial_port *port);
724 static void ftdi_dtr_rts(struct usb_serial_port *port, int on);
725 static int ftdi_write(struct tty_struct *tty, struct usb_serial_port *port,
726 const unsigned char *buf, int count);
727 static int ftdi_write_room(struct tty_struct *tty);
728 static int ftdi_chars_in_buffer(struct tty_struct *tty);
729 static void ftdi_write_bulk_callback(struct urb *urb);
730 static void ftdi_read_bulk_callback(struct urb *urb);
731 static void ftdi_process_read(struct work_struct *work);
732 static void ftdi_set_termios(struct tty_struct *tty,
733 struct usb_serial_port *port, struct ktermios *old);
734 static int ftdi_tiocmget(struct tty_struct *tty, struct file *file);
735 static int ftdi_tiocmset(struct tty_struct *tty, struct file *file,
736 unsigned int set, unsigned int clear);
737 static int ftdi_ioctl(struct tty_struct *tty, struct file *file,
738 unsigned int cmd, unsigned long arg);
739 static void ftdi_break_ctl(struct tty_struct *tty, int break_state);
740 static void ftdi_throttle(struct tty_struct *tty);
741 static void ftdi_unthrottle(struct tty_struct *tty);
743 static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base);
744 static unsigned short int ftdi_232am_baud_to_divisor(int baud);
745 static __u32 ftdi_232bm_baud_base_to_divisor(int baud, int base);
746 static __u32 ftdi_232bm_baud_to_divisor(int baud);
748 static struct usb_serial_driver ftdi_sio_device = {
750 .owner = THIS_MODULE,
753 .description = "FTDI USB Serial Device",
754 .usb_driver = &ftdi_driver ,
755 .id_table = id_table_combined,
757 .probe = ftdi_sio_probe,
758 .port_probe = ftdi_sio_port_probe,
759 .port_remove = ftdi_sio_port_remove,
762 .dtr_rts = ftdi_dtr_rts,
763 .throttle = ftdi_throttle,
764 .unthrottle = ftdi_unthrottle,
766 .write_room = ftdi_write_room,
767 .chars_in_buffer = ftdi_chars_in_buffer,
768 .read_bulk_callback = ftdi_read_bulk_callback,
769 .write_bulk_callback = ftdi_write_bulk_callback,
770 .tiocmget = ftdi_tiocmget,
771 .tiocmset = ftdi_tiocmset,
773 .set_termios = ftdi_set_termios,
774 .break_ctl = ftdi_break_ctl,
775 .shutdown = ftdi_shutdown,
779 #define WDR_TIMEOUT 5000 /* default urb timeout */
780 #define WDR_SHORT_TIMEOUT 1000 /* shorter urb timeout */
782 /* High and low are for DTR, RTS etc etc */
786 /* number of outstanding urbs to prevent userspace DoS from happening */
787 #define URB_UPPER_LIMIT 42
790 * ***************************************************************************
792 * ***************************************************************************
795 static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base)
797 unsigned short int divisor;
798 /* divisor shifted 3 bits to the left */
799 int divisor3 = base / 2 / baud;
800 if ((divisor3 & 0x7) == 7)
801 divisor3++; /* round x.7/8 up to x+1 */
802 divisor = divisor3 >> 3;
806 else if (divisor3 >= 4)
808 else if (divisor3 != 0)
810 else if (divisor == 1)
811 divisor = 0; /* special case for maximum baud rate */
815 static unsigned short int ftdi_232am_baud_to_divisor(int baud)
817 return ftdi_232am_baud_base_to_divisor(baud, 48000000);
820 static __u32 ftdi_232bm_baud_base_to_divisor(int baud, int base)
822 static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
824 /* divisor shifted 3 bits to the left */
825 int divisor3 = base / 2 / baud;
826 divisor = divisor3 >> 3;
827 divisor |= (__u32)divfrac[divisor3 & 0x7] << 14;
828 /* Deal with special cases for highest baud rates. */
831 else if (divisor == 0x4001)
836 static __u32 ftdi_232bm_baud_to_divisor(int baud)
838 return ftdi_232bm_baud_base_to_divisor(baud, 48000000);
841 #define set_mctrl(port, set) update_mctrl((port), (set), 0)
842 #define clear_mctrl(port, clear) update_mctrl((port), 0, (clear))
844 static int update_mctrl(struct usb_serial_port *port, unsigned int set,
847 struct ftdi_private *priv = usb_get_serial_port_data(port);
852 if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
853 dbg("%s - DTR|RTS not being set|cleared", __func__);
854 return 0; /* no change */
857 buf = kmalloc(1, GFP_NOIO);
861 clear &= ~set; /* 'set' takes precedence over 'clear' */
863 if (clear & TIOCM_DTR)
864 urb_value |= FTDI_SIO_SET_DTR_LOW;
865 if (clear & TIOCM_RTS)
866 urb_value |= FTDI_SIO_SET_RTS_LOW;
868 urb_value |= FTDI_SIO_SET_DTR_HIGH;
870 urb_value |= FTDI_SIO_SET_RTS_HIGH;
871 rv = usb_control_msg(port->serial->dev,
872 usb_sndctrlpipe(port->serial->dev, 0),
873 FTDI_SIO_SET_MODEM_CTRL_REQUEST,
874 FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE,
875 urb_value, priv->interface,
876 buf, 0, WDR_TIMEOUT);
880 dbg("%s Error from MODEM_CTRL urb: DTR %s, RTS %s",
882 (set & TIOCM_DTR) ? "HIGH" :
883 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
884 (set & TIOCM_RTS) ? "HIGH" :
885 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
887 dbg("%s - DTR %s, RTS %s", __func__,
888 (set & TIOCM_DTR) ? "HIGH" :
889 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
890 (set & TIOCM_RTS) ? "HIGH" :
891 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
892 /* FIXME: locking on last_dtr_rts */
893 priv->last_dtr_rts = (priv->last_dtr_rts & ~clear) | set;
899 static __u32 get_ftdi_divisor(struct tty_struct *tty,
900 struct usb_serial_port *port)
901 { /* get_ftdi_divisor */
902 struct ftdi_private *priv = usb_get_serial_port_data(port);
908 * The logic involved in setting the baudrate can be cleanly split into
910 * 1. Standard baud rates are set in tty->termios->c_cflag
911 * 2. If these are not enough, you can set any speed using alt_speed as
913 * - set tty->termios->c_cflag speed to B38400
914 * - set your real speed in tty->alt_speed; it gets ignored when
916 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as
918 * flags & ASYNC_SPD_MASK == ASYNC_SPD_[HI, VHI, SHI, WARP],
919 * this just sets alt_speed to (HI: 57600, VHI: 115200,
920 * SHI: 230400, WARP: 460800)
921 * ** Steps 1, 2 are done courtesy of tty_get_baud_rate
922 * 3. You can also set baud rate by setting custom divisor as follows
923 * - set tty->termios->c_cflag speed to B38400
924 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as
926 * o flags & ASYNC_SPD_MASK == ASYNC_SPD_CUST
927 * o custom_divisor set to baud_base / your_new_baudrate
928 * ** Step 3 is done courtesy of code borrowed from serial.c
929 * I should really spend some time and separate + move this common
930 * code to serial.c, it is replicated in nearly every serial driver
934 /* 1. Get the baud rate from the tty settings, this observes
937 baud = tty_get_baud_rate(tty);
938 dbg("%s - tty_get_baud_rate reports speed %d", __func__, baud);
940 /* 2. Observe async-compatible custom_divisor hack, update baudrate
944 ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
945 (priv->custom_divisor)) {
946 baud = priv->baud_base / priv->custom_divisor;
947 dbg("%s - custom divisor %d sets baud rate to %d",
948 __func__, priv->custom_divisor, baud);
951 /* 3. Convert baudrate to device-specific divisor */
955 switch (priv->chip_type) {
956 case SIO: /* SIO chip */
958 case 300: div_value = ftdi_sio_b300; break;
959 case 600: div_value = ftdi_sio_b600; break;
960 case 1200: div_value = ftdi_sio_b1200; break;
961 case 2400: div_value = ftdi_sio_b2400; break;
962 case 4800: div_value = ftdi_sio_b4800; break;
963 case 9600: div_value = ftdi_sio_b9600; break;
964 case 19200: div_value = ftdi_sio_b19200; break;
965 case 38400: div_value = ftdi_sio_b38400; break;
966 case 57600: div_value = ftdi_sio_b57600; break;
967 case 115200: div_value = ftdi_sio_b115200; break;
969 if (div_value == 0) {
970 dbg("%s - Baudrate (%d) requested is not supported",
972 div_value = ftdi_sio_b9600;
977 case FT8U232AM: /* 8U232AM chip */
978 if (baud <= 3000000) {
979 div_value = ftdi_232am_baud_to_divisor(baud);
981 dbg("%s - Baud rate too high!", __func__);
983 div_value = ftdi_232am_baud_to_divisor(9600);
987 case FT232BM: /* FT232BM chip */
988 case FT2232C: /* FT2232C chip */
990 if (baud <= 3000000) {
991 div_value = ftdi_232bm_baud_to_divisor(baud);
993 dbg("%s - Baud rate too high!", __func__);
994 div_value = ftdi_232bm_baud_to_divisor(9600);
999 } /* priv->chip_type */
1002 dbg("%s - Baud rate set to %d (divisor 0x%lX) on chip %s",
1003 __func__, baud, (unsigned long)div_value,
1004 ftdi_chip_name[priv->chip_type]);
1007 tty_encode_baud_rate(tty, baud, baud);
1011 static int change_speed(struct tty_struct *tty, struct usb_serial_port *port)
1013 struct ftdi_private *priv = usb_get_serial_port_data(port);
1017 __u32 urb_index_value;
1020 buf = kmalloc(1, GFP_NOIO);
1024 urb_index_value = get_ftdi_divisor(tty, port);
1025 urb_value = (__u16)urb_index_value;
1026 urb_index = (__u16)(urb_index_value >> 16);
1027 if (priv->interface) { /* FT2232C */
1028 urb_index = (__u16)((urb_index << 8) | priv->interface);
1031 rv = usb_control_msg(port->serial->dev,
1032 usb_sndctrlpipe(port->serial->dev, 0),
1033 FTDI_SIO_SET_BAUDRATE_REQUEST,
1034 FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE,
1035 urb_value, urb_index,
1036 buf, 0, WDR_SHORT_TIMEOUT);
1042 static int write_latency_timer(struct usb_serial_port *port)
1044 struct ftdi_private *priv = usb_get_serial_port_data(port);
1045 struct usb_device *udev = port->serial->dev;
1048 int l = priv->latency;
1050 if (priv->flags & ASYNC_LOW_LATENCY)
1053 dbg("%s: setting latency timer = %i", __func__, l);
1055 rv = usb_control_msg(udev,
1056 usb_sndctrlpipe(udev, 0),
1057 FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
1058 FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
1060 buf, 0, WDR_TIMEOUT);
1063 dev_err(&port->dev, "Unable to write latency timer: %i\n", rv);
1067 static int read_latency_timer(struct usb_serial_port *port)
1069 struct ftdi_private *priv = usb_get_serial_port_data(port);
1070 struct usb_device *udev = port->serial->dev;
1071 unsigned short latency = 0;
1075 dbg("%s", __func__);
1077 rv = usb_control_msg(udev,
1078 usb_rcvctrlpipe(udev, 0),
1079 FTDI_SIO_GET_LATENCY_TIMER_REQUEST,
1080 FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE,
1082 (char *) &latency, 1, WDR_TIMEOUT);
1085 dev_err(&port->dev, "Unable to read latency timer: %i\n", rv);
1091 static int get_serial_info(struct usb_serial_port *port,
1092 struct serial_struct __user *retinfo)
1094 struct ftdi_private *priv = usb_get_serial_port_data(port);
1095 struct serial_struct tmp;
1099 memset(&tmp, 0, sizeof(tmp));
1100 tmp.flags = priv->flags;
1101 tmp.baud_base = priv->baud_base;
1102 tmp.custom_divisor = priv->custom_divisor;
1103 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
1106 } /* get_serial_info */
1109 static int set_serial_info(struct tty_struct *tty,
1110 struct usb_serial_port *port, struct serial_struct __user *newinfo)
1111 { /* set_serial_info */
1112 struct ftdi_private *priv = usb_get_serial_port_data(port);
1113 struct serial_struct new_serial;
1114 struct ftdi_private old_priv;
1116 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
1122 /* Do error checking and permission checking */
1124 if (!capable(CAP_SYS_ADMIN)) {
1125 if (((new_serial.flags & ~ASYNC_USR_MASK) !=
1126 (priv->flags & ~ASYNC_USR_MASK))) {
1130 priv->flags = ((priv->flags & ~ASYNC_USR_MASK) |
1131 (new_serial.flags & ASYNC_USR_MASK));
1132 priv->custom_divisor = new_serial.custom_divisor;
1133 goto check_and_exit;
1136 if ((new_serial.baud_base != priv->baud_base) &&
1137 (new_serial.baud_base < 9600)) {
1142 /* Make the changes - these are privileged changes! */
1144 priv->flags = ((priv->flags & ~ASYNC_FLAGS) |
1145 (new_serial.flags & ASYNC_FLAGS));
1146 priv->custom_divisor = new_serial.custom_divisor;
1148 tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
1149 write_latency_timer(port);
1152 if ((old_priv.flags & ASYNC_SPD_MASK) !=
1153 (priv->flags & ASYNC_SPD_MASK)) {
1154 if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_HI)
1155 tty->alt_speed = 57600;
1156 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_VHI)
1157 tty->alt_speed = 115200;
1158 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_SHI)
1159 tty->alt_speed = 230400;
1160 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_WARP)
1161 tty->alt_speed = 460800;
1165 if (((old_priv.flags & ASYNC_SPD_MASK) !=
1166 (priv->flags & ASYNC_SPD_MASK)) ||
1167 (((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
1168 (old_priv.custom_divisor != priv->custom_divisor))) {
1170 change_speed(tty, port);
1176 } /* set_serial_info */
1179 /* Determine type of FTDI chip based on USB config and descriptor. */
1180 static void ftdi_determine_type(struct usb_serial_port *port)
1182 struct ftdi_private *priv = usb_get_serial_port_data(port);
1183 struct usb_serial *serial = port->serial;
1184 struct usb_device *udev = serial->dev;
1186 unsigned interfaces;
1188 /* Assume it is not the original SIO device for now. */
1189 priv->baud_base = 48000000 / 2;
1190 priv->write_offset = 0;
1192 version = le16_to_cpu(udev->descriptor.bcdDevice);
1193 interfaces = udev->actconfig->desc.bNumInterfaces;
1194 dbg("%s: bcdDevice = 0x%x, bNumInterfaces = %u", __func__,
1195 version, interfaces);
1196 if (interfaces > 1) {
1199 /* Multiple interfaces. Assume FT2232C. */
1200 priv->chip_type = FT2232C;
1201 /* Determine interface code. */
1202 inter = serial->interface->altsetting->desc.bInterfaceNumber;
1204 priv->interface = PIT_SIOA;
1206 priv->interface = PIT_SIOB;
1207 /* BM-type devices have a bug where bcdDevice gets set
1208 * to 0x200 when iSerialNumber is 0. */
1209 if (version < 0x500) {
1210 dbg("%s: something fishy - bcdDevice too low for multi-interface device",
1213 } else if (version < 0x200) {
1214 /* Old device. Assume its the original SIO. */
1215 priv->chip_type = SIO;
1216 priv->baud_base = 12000000 / 16;
1217 priv->write_offset = 1;
1218 } else if (version < 0x400) {
1219 /* Assume its an FT8U232AM (or FT8U245AM) */
1220 /* (It might be a BM because of the iSerialNumber bug,
1221 * but it will still work as an AM device.) */
1222 priv->chip_type = FT8U232AM;
1223 } else if (version < 0x600) {
1224 /* Assume its an FT232BM (or FT245BM) */
1225 priv->chip_type = FT232BM;
1227 /* Assume its an FT232R */
1228 priv->chip_type = FT232RL;
1230 dev_info(&udev->dev, "Detected %s\n", ftdi_chip_name[priv->chip_type]);
1235 * ***************************************************************************
1237 * ***************************************************************************
1240 static ssize_t show_latency_timer(struct device *dev,
1241 struct device_attribute *attr, char *buf)
1243 struct usb_serial_port *port = to_usb_serial_port(dev);
1244 struct ftdi_private *priv = usb_get_serial_port_data(port);
1245 if (priv->flags & ASYNC_LOW_LATENCY)
1246 return sprintf(buf, "1\n");
1248 return sprintf(buf, "%i\n", priv->latency);
1252 /* Write a new value of the latency timer, in units of milliseconds. */
1253 static ssize_t store_latency_timer(struct device *dev,
1254 struct device_attribute *attr, const char *valbuf,
1257 struct usb_serial_port *port = to_usb_serial_port(dev);
1258 struct ftdi_private *priv = usb_get_serial_port_data(port);
1259 int v = simple_strtoul(valbuf, NULL, 10);
1263 rv = write_latency_timer(port);
1269 /* Write an event character directly to the FTDI register. The ASCII
1270 value is in the low 8 bits, with the enable bit in the 9th bit. */
1271 static ssize_t store_event_char(struct device *dev,
1272 struct device_attribute *attr, const char *valbuf, size_t count)
1274 struct usb_serial_port *port = to_usb_serial_port(dev);
1275 struct ftdi_private *priv = usb_get_serial_port_data(port);
1276 struct usb_device *udev = port->serial->dev;
1278 int v = simple_strtoul(valbuf, NULL, 10);
1281 dbg("%s: setting event char = %i", __func__, v);
1283 rv = usb_control_msg(udev,
1284 usb_sndctrlpipe(udev, 0),
1285 FTDI_SIO_SET_EVENT_CHAR_REQUEST,
1286 FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE,
1288 buf, 0, WDR_TIMEOUT);
1291 dbg("Unable to write event character: %i", rv);
1298 static DEVICE_ATTR(latency_timer, S_IWUSR | S_IRUGO, show_latency_timer,
1299 store_latency_timer);
1300 static DEVICE_ATTR(event_char, S_IWUSR, NULL, store_event_char);
1302 static int create_sysfs_attrs(struct usb_serial_port *port)
1304 struct ftdi_private *priv = usb_get_serial_port_data(port);
1307 dbg("%s", __func__);
1309 /* XXX I've no idea if the original SIO supports the event_char
1310 * sysfs parameter, so I'm playing it safe. */
1311 if (priv->chip_type != SIO) {
1312 dbg("sysfs attributes for %s", ftdi_chip_name[priv->chip_type]);
1313 retval = device_create_file(&port->dev, &dev_attr_event_char);
1315 (priv->chip_type == FT232BM ||
1316 priv->chip_type == FT2232C ||
1317 priv->chip_type == FT232RL)) {
1318 retval = device_create_file(&port->dev,
1319 &dev_attr_latency_timer);
1325 static void remove_sysfs_attrs(struct usb_serial_port *port)
1327 struct ftdi_private *priv = usb_get_serial_port_data(port);
1329 dbg("%s", __func__);
1331 /* XXX see create_sysfs_attrs */
1332 if (priv->chip_type != SIO) {
1333 device_remove_file(&port->dev, &dev_attr_event_char);
1334 if (priv->chip_type == FT232BM ||
1335 priv->chip_type == FT2232C ||
1336 priv->chip_type == FT232RL) {
1337 device_remove_file(&port->dev, &dev_attr_latency_timer);
1344 * ***************************************************************************
1345 * FTDI driver specific functions
1346 * ***************************************************************************
1349 /* Probe function to check for special devices */
1350 static int ftdi_sio_probe(struct usb_serial *serial,
1351 const struct usb_device_id *id)
1353 struct ftdi_sio_quirk *quirk =
1354 (struct ftdi_sio_quirk *)id->driver_info;
1356 if (quirk && quirk->probe) {
1357 int ret = quirk->probe(serial);
1362 usb_set_serial_data(serial, (void *)id->driver_info);
1367 static int ftdi_sio_port_probe(struct usb_serial_port *port)
1369 struct ftdi_private *priv;
1370 struct ftdi_sio_quirk *quirk = usb_get_serial_data(port->serial);
1373 dbg("%s", __func__);
1375 priv = kzalloc(sizeof(struct ftdi_private), GFP_KERNEL);
1377 dev_err(&port->dev, "%s- kmalloc(%Zd) failed.\n", __func__,
1378 sizeof(struct ftdi_private));
1382 kref_init(&priv->kref);
1383 spin_lock_init(&priv->rx_lock);
1384 spin_lock_init(&priv->tx_lock);
1385 init_waitqueue_head(&priv->delta_msr_wait);
1386 /* This will push the characters through immediately rather
1387 than queue a task to deliver them */
1388 priv->flags = ASYNC_LOW_LATENCY;
1390 if (quirk && quirk->port_probe)
1391 quirk->port_probe(priv);
1393 /* Increase the size of read buffers */
1394 kfree(port->bulk_in_buffer);
1395 port->bulk_in_buffer = kmalloc(BUFSZ, GFP_KERNEL);
1396 if (!port->bulk_in_buffer) {
1400 if (port->read_urb) {
1401 port->read_urb->transfer_buffer = port->bulk_in_buffer;
1402 port->read_urb->transfer_buffer_length = BUFSZ;
1405 INIT_DELAYED_WORK(&priv->rx_work, ftdi_process_read);
1408 /* Free port's existing write urb and transfer buffer. */
1409 if (port->write_urb) {
1410 usb_free_urb(port->write_urb);
1411 port->write_urb = NULL;
1413 kfree(port->bulk_out_buffer);
1414 port->bulk_out_buffer = NULL;
1416 usb_set_serial_port_data(port, priv);
1418 ftdi_determine_type(port);
1419 read_latency_timer(port);
1420 create_sysfs_attrs(port);
1424 /* Setup for the USB-UIRT device, which requires hardwired
1425 * baudrate (38400 gets mapped to 312500) */
1426 /* Called from usbserial:serial_probe */
1427 static void ftdi_USB_UIRT_setup(struct ftdi_private *priv)
1429 dbg("%s", __func__);
1431 priv->flags |= ASYNC_SPD_CUST;
1432 priv->custom_divisor = 77;
1433 priv->force_baud = 38400;
1434 } /* ftdi_USB_UIRT_setup */
1436 /* Setup for the HE-TIRA1 device, which requires hardwired
1437 * baudrate (38400 gets mapped to 100000) and RTS-CTS enabled. */
1439 static void ftdi_HE_TIRA1_setup(struct ftdi_private *priv)
1441 dbg("%s", __func__);
1443 priv->flags |= ASYNC_SPD_CUST;
1444 priv->custom_divisor = 240;
1445 priv->force_baud = 38400;
1446 priv->force_rtscts = 1;
1447 } /* ftdi_HE_TIRA1_setup */
1450 * First port on JTAG adaptors such as Olimex arm-usb-ocd or the FIC/OpenMoko
1451 * Neo1973 Debug Board is reserved for JTAG interface and can be accessed from
1452 * userspace using openocd.
1454 static int ftdi_jtag_probe(struct usb_serial *serial)
1456 struct usb_device *udev = serial->dev;
1457 struct usb_interface *interface = serial->interface;
1459 dbg("%s", __func__);
1461 if (interface == udev->actconfig->interface[0]) {
1462 dev_info(&udev->dev,
1463 "Ignoring serial port reserved for JTAG\n");
1471 * The Matrix Orbital VK204-25-USB has an invalid IN endpoint.
1472 * We have to correct it if we want to read from it.
1474 static int ftdi_mtxorb_hack_setup(struct usb_serial *serial)
1476 struct usb_host_endpoint *ep = serial->dev->ep_in[1];
1477 struct usb_endpoint_descriptor *ep_desc = &ep->desc;
1479 if (ep->enabled && ep_desc->wMaxPacketSize == 0) {
1480 ep_desc->wMaxPacketSize = cpu_to_le16(0x40);
1481 dev_info(&serial->dev->dev,
1482 "Fixing invalid wMaxPacketSize on read pipe\n");
1488 /* ftdi_shutdown is called from usbserial:usb_serial_disconnect
1489 * it is called when the usb device is disconnected
1491 * usbserial:usb_serial_disconnect
1492 * calls __serial_close for each open of the port
1493 * shutdown is called then (ie ftdi_shutdown)
1495 static void ftdi_shutdown(struct usb_serial *serial)
1497 dbg("%s", __func__);
1500 static void ftdi_sio_priv_release(struct kref *k)
1502 struct ftdi_private *priv = container_of(k, struct ftdi_private, kref);
1507 static int ftdi_sio_port_remove(struct usb_serial_port *port)
1509 struct ftdi_private *priv = usb_get_serial_port_data(port);
1511 dbg("%s", __func__);
1513 remove_sysfs_attrs(port);
1515 kref_put(&priv->kref, ftdi_sio_priv_release);
1520 static int ftdi_open(struct tty_struct *tty,
1521 struct usb_serial_port *port, struct file *filp)
1523 struct usb_device *dev = port->serial->dev;
1524 struct ftdi_private *priv = usb_get_serial_port_data(port);
1525 unsigned long flags;
1528 char buf[1]; /* Needed for the usb_control_msg I think */
1530 dbg("%s", __func__);
1532 spin_lock_irqsave(&priv->tx_lock, flags);
1534 spin_unlock_irqrestore(&priv->tx_lock, flags);
1535 spin_lock_irqsave(&priv->rx_lock, flags);
1537 spin_unlock_irqrestore(&priv->rx_lock, flags);
1540 tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
1542 write_latency_timer(port);
1544 /* No error checking for this (will get errors later anyway) */
1545 /* See ftdi_sio.h for description of what is reset */
1546 usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1547 FTDI_SIO_RESET_REQUEST, FTDI_SIO_RESET_REQUEST_TYPE,
1549 priv->interface, buf, 0, WDR_TIMEOUT);
1551 /* Termios defaults are set by usb_serial_init. We don't change
1552 port->tty->termios - this would lose speed settings, etc.
1553 This is same behaviour as serial.c/rs_open() - Kuba */
1555 /* ftdi_set_termios will send usb control messages */
1557 ftdi_set_termios(tty, port, tty->termios);
1560 spin_lock_irqsave(&priv->rx_lock, flags);
1561 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
1562 spin_unlock_irqrestore(&priv->rx_lock, flags);
1564 /* Start reading from the device */
1565 priv->rx_processed = 0;
1566 usb_fill_bulk_urb(port->read_urb, dev,
1567 usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress),
1568 port->read_urb->transfer_buffer,
1569 port->read_urb->transfer_buffer_length,
1570 ftdi_read_bulk_callback, port);
1571 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
1574 "%s - failed submitting read urb, error %d\n",
1577 kref_get(&priv->kref);
1583 static void ftdi_dtr_rts(struct usb_serial_port *port, int on)
1585 struct ftdi_private *priv = usb_get_serial_port_data(port);
1588 mutex_lock(&port->serial->disc_mutex);
1589 if (!port->serial->disconnected) {
1590 /* Disable flow control */
1591 if (!on && usb_control_msg(port->serial->dev,
1592 usb_sndctrlpipe(port->serial->dev, 0),
1593 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1594 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1595 0, priv->interface, buf, 0,
1597 dev_err(&port->dev, "error from flowcontrol urb\n");
1599 /* drop RTS and DTR */
1601 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1603 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1605 mutex_unlock(&port->serial->disc_mutex);
1609 * usbserial:__serial_close only calls ftdi_close if the point is open
1611 * This only gets called when it is the last close
1616 static void ftdi_close(struct usb_serial_port *port)
1618 struct ftdi_private *priv = usb_get_serial_port_data(port);
1620 dbg("%s", __func__);
1623 /* cancel any scheduled reading */
1624 cancel_delayed_work_sync(&priv->rx_work);
1626 /* shutdown our bulk read */
1627 usb_kill_urb(port->read_urb);
1628 kref_put(&priv->kref, ftdi_sio_priv_release);
1633 /* The SIO requires the first byte to have:
1636 * B2..7 length of message excluding byte 0
1638 * The new devices do not require this byte
1640 static int ftdi_write(struct tty_struct *tty, struct usb_serial_port *port,
1641 const unsigned char *buf, int count)
1643 struct ftdi_private *priv = usb_get_serial_port_data(port);
1645 unsigned char *buffer;
1646 int data_offset ; /* will be 1 for the SIO and 0 otherwise */
1649 unsigned long flags;
1651 dbg("%s port %d, %d bytes", __func__, port->number, count);
1654 dbg("write request of 0 bytes");
1657 spin_lock_irqsave(&priv->tx_lock, flags);
1658 if (priv->tx_outstanding_urbs > URB_UPPER_LIMIT) {
1659 spin_unlock_irqrestore(&priv->tx_lock, flags);
1660 dbg("%s - write limit hit\n", __func__);
1663 priv->tx_outstanding_urbs++;
1664 spin_unlock_irqrestore(&priv->tx_lock, flags);
1666 data_offset = priv->write_offset;
1667 dbg("data_offset set to %d", data_offset);
1669 /* Determine total transfer size */
1670 transfer_size = count;
1671 if (data_offset > 0) {
1672 /* Original sio needs control bytes too... */
1673 transfer_size += (data_offset *
1674 ((count + (PKTSZ - 1 - data_offset)) /
1675 (PKTSZ - data_offset)));
1678 buffer = kmalloc(transfer_size, GFP_ATOMIC);
1681 "%s ran out of kernel memory for urb ...\n", __func__);
1683 goto error_no_buffer;
1686 urb = usb_alloc_urb(0, GFP_ATOMIC);
1688 dev_err(&port->dev, "%s - no more free urbs\n", __func__);
1694 if (data_offset > 0) {
1695 /* Original sio requires control byte at start of
1697 int user_pktsz = PKTSZ - data_offset;
1699 unsigned char *first_byte = buffer;
1700 const unsigned char *current_position = buf;
1703 if (user_pktsz > todo)
1705 /* Write the control byte at the front of the packet*/
1706 *first_byte = 1 | ((user_pktsz) << 2);
1707 /* Copy data for packet */
1708 memcpy(first_byte + data_offset,
1709 current_position, user_pktsz);
1710 first_byte += user_pktsz + data_offset;
1711 current_position += user_pktsz;
1715 /* No control byte required. */
1716 /* Copy in the data to send */
1717 memcpy(buffer, buf, count);
1720 usb_serial_debug_data(debug, &port->dev, __func__,
1721 transfer_size, buffer);
1723 /* fill the buffer and send it */
1724 usb_fill_bulk_urb(urb, port->serial->dev,
1725 usb_sndbulkpipe(port->serial->dev,
1726 port->bulk_out_endpointAddress),
1727 buffer, transfer_size,
1728 ftdi_write_bulk_callback, port);
1730 status = usb_submit_urb(urb, GFP_ATOMIC);
1733 "%s - failed submitting write urb, error %d\n",
1738 spin_lock_irqsave(&priv->tx_lock, flags);
1739 priv->tx_outstanding_bytes += count;
1740 priv->tx_bytes += count;
1741 spin_unlock_irqrestore(&priv->tx_lock, flags);
1744 /* we are done with this urb, so let the host driver
1745 * really free it when it is finished with it */
1748 dbg("%s write returning: %d", __func__, count);
1755 spin_lock_irqsave(&priv->tx_lock, flags);
1756 priv->tx_outstanding_urbs--;
1757 spin_unlock_irqrestore(&priv->tx_lock, flags);
1762 /* This function may get called when the device is closed */
1764 static void ftdi_write_bulk_callback(struct urb *urb)
1766 unsigned long flags;
1767 struct usb_serial_port *port = urb->context;
1768 struct ftdi_private *priv;
1769 int data_offset; /* will be 1 for the SIO and 0 otherwise */
1770 unsigned long countback;
1771 int status = urb->status;
1773 /* free up the transfer buffer, as usb_free_urb() does not do this */
1774 kfree(urb->transfer_buffer);
1776 dbg("%s - port %d", __func__, port->number);
1779 dbg("nonzero write bulk status received: %d", status);
1783 priv = usb_get_serial_port_data(port);
1785 dbg("%s - bad port private data pointer - exiting", __func__);
1788 /* account for transferred data */
1789 countback = urb->actual_length;
1790 data_offset = priv->write_offset;
1791 if (data_offset > 0) {
1792 /* Subtract the control bytes */
1793 countback -= (data_offset * DIV_ROUND_UP(countback, PKTSZ));
1795 spin_lock_irqsave(&priv->tx_lock, flags);
1796 --priv->tx_outstanding_urbs;
1797 priv->tx_outstanding_bytes -= countback;
1798 spin_unlock_irqrestore(&priv->tx_lock, flags);
1800 usb_serial_port_softint(port);
1801 } /* ftdi_write_bulk_callback */
1804 static int ftdi_write_room(struct tty_struct *tty)
1806 struct usb_serial_port *port = tty->driver_data;
1807 struct ftdi_private *priv = usb_get_serial_port_data(port);
1809 unsigned long flags;
1811 dbg("%s - port %d", __func__, port->number);
1813 spin_lock_irqsave(&priv->tx_lock, flags);
1814 if (priv->tx_outstanding_urbs < URB_UPPER_LIMIT) {
1816 * We really can take anything the user throws at us
1817 * but let's pick a nice big number to tell the tty
1818 * layer that we have lots of free space
1824 spin_unlock_irqrestore(&priv->tx_lock, flags);
1828 static int ftdi_chars_in_buffer(struct tty_struct *tty)
1830 struct usb_serial_port *port = tty->driver_data;
1831 struct ftdi_private *priv = usb_get_serial_port_data(port);
1833 unsigned long flags;
1835 dbg("%s - port %d", __func__, port->number);
1837 spin_lock_irqsave(&priv->tx_lock, flags);
1838 buffered = (int)priv->tx_outstanding_bytes;
1839 spin_unlock_irqrestore(&priv->tx_lock, flags);
1841 dev_err(&port->dev, "%s outstanding tx bytes is negative!\n",
1848 static void ftdi_read_bulk_callback(struct urb *urb)
1850 struct usb_serial_port *port = urb->context;
1851 struct tty_struct *tty;
1852 struct ftdi_private *priv;
1853 unsigned long countread;
1854 unsigned long flags;
1855 int status = urb->status;
1857 if (urb->number_of_packets > 0) {
1858 dev_err(&port->dev, "%s transfer_buffer_length %d "
1859 "actual_length %d number of packets %d\n", __func__,
1860 urb->transfer_buffer_length,
1861 urb->actual_length, urb->number_of_packets);
1862 dev_err(&port->dev, "%s transfer_flags %x\n", __func__,
1863 urb->transfer_flags);
1866 dbg("%s - port %d", __func__, port->number);
1868 if (port->port.count <= 0)
1871 tty = tty_port_tty_get(&port->port);
1873 dbg("%s - bad tty pointer - exiting", __func__);
1877 priv = usb_get_serial_port_data(port);
1879 dbg("%s - bad port private data pointer - exiting", __func__);
1883 if (urb != port->read_urb)
1884 dev_err(&port->dev, "%s - Not my urb!\n", __func__);
1887 /* This will happen at close every time so it is a dbg not an
1889 dbg("(this is ok on close) nonzero read bulk status received: %d", status);
1893 /* count data bytes, but not status bytes */
1894 countread = urb->actual_length;
1895 countread -= 2 * DIV_ROUND_UP(countread, PKTSZ);
1896 spin_lock_irqsave(&priv->rx_lock, flags);
1897 priv->rx_bytes += countread;
1898 spin_unlock_irqrestore(&priv->rx_lock, flags);
1900 ftdi_process_read(&priv->rx_work.work);
1903 } /* ftdi_read_bulk_callback */
1906 static void ftdi_process_read(struct work_struct *work)
1907 { /* ftdi_process_read */
1908 struct ftdi_private *priv =
1909 container_of(work, struct ftdi_private, rx_work.work);
1910 struct usb_serial_port *port = priv->port;
1912 struct tty_struct *tty;
1914 unsigned char *data;
1920 unsigned long flags;
1922 dbg("%s - port %d", __func__, port->number);
1924 if (port->port.count <= 0)
1927 tty = tty_port_tty_get(&port->port);
1929 dbg("%s - bad tty pointer - exiting", __func__);
1933 priv = usb_get_serial_port_data(port);
1935 dbg("%s - bad port private data pointer - exiting", __func__);
1939 urb = port->read_urb;
1941 dbg("%s - bad read_urb pointer - exiting", __func__);
1945 data = urb->transfer_buffer;
1947 if (priv->rx_processed) {
1948 dbg("%s - already processed: %d bytes, %d remain", __func__,
1950 urb->actual_length - priv->rx_processed);
1952 /* The first two bytes of every read packet are status */
1953 if (urb->actual_length > 2)
1954 usb_serial_debug_data(debug, &port->dev, __func__,
1955 urb->actual_length, data);
1957 dbg("Status only: %03oo %03oo", data[0], data[1]);
1961 /* TO DO -- check for hung up line and handle appropriately: */
1963 /* See acm.c - you do a tty_hangup - eg tty_hangup(tty) */
1964 /* if CD is dropped and the line is not CLOCAL then we should hangup */
1967 for (packet_offset = priv->rx_processed;
1968 packet_offset < urb->actual_length; packet_offset += PKTSZ) {
1971 /* Compare new line status to the old one, signal if different/
1972 N.B. packet may be processed more than once, but differences
1973 are only processed once. */
1974 char new_status = data[packet_offset + 0] &
1975 FTDI_STATUS_B0_MASK;
1976 if (new_status != priv->prev_status) {
1977 priv->diff_status |=
1978 new_status ^ priv->prev_status;
1979 wake_up_interruptible(&priv->delta_msr_wait);
1980 priv->prev_status = new_status;
1983 length = min_t(u32, PKTSZ, urb->actual_length-packet_offset)-2;
1985 dev_err(&port->dev, "%s - bad packet length: %d\n",
1986 __func__, length+2);
1990 if (priv->rx_flags & THROTTLED) {
1991 dbg("%s - throttled", __func__);
1994 if (tty_buffer_request_room(tty, length) < length) {
1995 /* break out & wait for throttling/unthrottling to
1997 dbg("%s - receive room low", __func__);
2001 /* Handle errors and break */
2002 error_flag = TTY_NORMAL;
2003 /* Although the device uses a bitmask and hence can have
2004 multiple errors on a packet - the order here sets the
2005 priority the error is returned to the tty layer */
2007 if (data[packet_offset+1] & FTDI_RS_OE) {
2008 error_flag = TTY_OVERRUN;
2009 dbg("OVERRRUN error");
2011 if (data[packet_offset+1] & FTDI_RS_BI) {
2012 error_flag = TTY_BREAK;
2013 dbg("BREAK received");
2015 if (data[packet_offset+1] & FTDI_RS_PE) {
2016 error_flag = TTY_PARITY;
2017 dbg("PARITY error");
2019 if (data[packet_offset+1] & FTDI_RS_FE) {
2020 error_flag = TTY_FRAME;
2021 dbg("FRAMING error");
2024 for (i = 2; i < length+2; i++) {
2025 /* Note that the error flag is duplicated for
2026 every character received since we don't know
2027 which character it applied to */
2028 tty_insert_flip_char(tty,
2029 data[packet_offset + i], error_flag);
2034 #ifdef NOT_CORRECT_BUT_KEEPING_IT_FOR_NOW
2035 /* if a parity error is detected you get status packets forever
2036 until a character is sent without a parity error.
2037 This doesn't work well since the application receives a
2038 never ending stream of bad data - even though new data
2039 hasn't been sent. Therefore I (bill) have taken this out.
2040 However - this might make sense for framing errors and so on
2041 so I am leaving the code in for now.
2044 if (error_flag != TTY_NORMAL) {
2045 dbg("error_flag is not normal");
2046 /* In this case it is just status - if that is
2047 an error send a bad character */
2048 if (tty->flip.count >= TTY_FLIPBUF_SIZE)
2049 tty_flip_buffer_push(tty);
2050 tty_insert_flip_char(tty, 0xff, error_flag);
2055 } /* "for(packet_offset=0..." */
2059 tty_flip_buffer_push(tty);
2061 if (packet_offset < urb->actual_length) {
2062 /* not completely processed - record progress */
2063 priv->rx_processed = packet_offset;
2064 dbg("%s - incomplete, %d bytes processed, %d remain",
2065 __func__, packet_offset,
2066 urb->actual_length - packet_offset);
2067 /* check if we were throttled while processing */
2068 spin_lock_irqsave(&priv->rx_lock, flags);
2069 if (priv->rx_flags & THROTTLED) {
2070 priv->rx_flags |= ACTUALLY_THROTTLED;
2071 spin_unlock_irqrestore(&priv->rx_lock, flags);
2072 dbg("%s - deferring remainder until unthrottled",
2076 spin_unlock_irqrestore(&priv->rx_lock, flags);
2077 /* if the port is closed stop trying to read */
2078 if (port->port.count > 0)
2079 /* delay processing of remainder */
2080 schedule_delayed_work(&priv->rx_work, 1);
2082 dbg("%s - port is closed", __func__);
2086 /* urb is completely processed */
2087 priv->rx_processed = 0;
2089 /* if the port is closed stop trying to read */
2090 if (port->port.count > 0) {
2091 /* Continue trying to always read */
2092 usb_fill_bulk_urb(port->read_urb, port->serial->dev,
2093 usb_rcvbulkpipe(port->serial->dev,
2094 port->bulk_in_endpointAddress),
2095 port->read_urb->transfer_buffer,
2096 port->read_urb->transfer_buffer_length,
2097 ftdi_read_bulk_callback, port);
2099 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
2102 "%s - failed resubmitting read urb, error %d\n",
2107 } /* ftdi_process_read */
2110 static void ftdi_break_ctl(struct tty_struct *tty, int break_state)
2112 struct usb_serial_port *port = tty->driver_data;
2113 struct ftdi_private *priv = usb_get_serial_port_data(port);
2114 __u16 urb_value = 0;
2117 /* break_state = -1 to turn on break, and 0 to turn off break */
2118 /* see drivers/char/tty_io.c to see it used */
2119 /* last_set_data_urb_value NEVER has the break bit set in it */
2122 urb_value = priv->last_set_data_urb_value | FTDI_SIO_SET_BREAK;
2124 urb_value = priv->last_set_data_urb_value;
2126 if (usb_control_msg(port->serial->dev,
2127 usb_sndctrlpipe(port->serial->dev, 0),
2128 FTDI_SIO_SET_DATA_REQUEST,
2129 FTDI_SIO_SET_DATA_REQUEST_TYPE,
2130 urb_value , priv->interface,
2131 buf, 0, WDR_TIMEOUT) < 0) {
2132 dev_err(&port->dev, "%s FAILED to enable/disable break state "
2133 "(state was %d)\n", __func__, break_state);
2136 dbg("%s break state is %d - urb is %d", __func__,
2137 break_state, urb_value);
2142 /* old_termios contains the original termios settings and tty->termios contains
2143 * the new setting to be used
2144 * WARNING: set_termios calls this with old_termios in kernel space
2147 static void ftdi_set_termios(struct tty_struct *tty,
2148 struct usb_serial_port *port, struct ktermios *old_termios)
2149 { /* ftdi_termios */
2150 struct usb_device *dev = port->serial->dev;
2151 struct ftdi_private *priv = usb_get_serial_port_data(port);
2152 struct ktermios *termios = tty->termios;
2153 unsigned int cflag = termios->c_cflag;
2154 __u16 urb_value; /* will hold the new flags */
2155 char buf[1]; /* Perhaps I should dynamically alloc this? */
2157 /* Added for xon/xoff support */
2158 unsigned int iflag = termios->c_iflag;
2159 unsigned char vstop;
2160 unsigned char vstart;
2162 dbg("%s", __func__);
2164 /* Force baud rate if this device requires it, unless it is set to
2166 if (priv->force_baud && ((termios->c_cflag & CBAUD) != B0)) {
2167 dbg("%s: forcing baud rate for this device", __func__);
2168 tty_encode_baud_rate(tty, priv->force_baud,
2172 /* Force RTS-CTS if this device requires it. */
2173 if (priv->force_rtscts) {
2174 dbg("%s: forcing rtscts for this device", __func__);
2175 termios->c_cflag |= CRTSCTS;
2178 cflag = termios->c_cflag;
2180 /* FIXME -For this cut I don't care if the line is really changing or
2181 not - so just do the change regardless - should be able to
2182 compare old_termios and tty->termios */
2183 /* NOTE These routines can get interrupted by
2184 ftdi_sio_read_bulk_callback - need to examine what this means -
2185 don't see any problems yet */
2187 /* Set number of data bits, parity, stop bits */
2189 termios->c_cflag &= ~CMSPAR;
2192 urb_value |= (cflag & CSTOPB ? FTDI_SIO_SET_DATA_STOP_BITS_2 :
2193 FTDI_SIO_SET_DATA_STOP_BITS_1);
2194 urb_value |= (cflag & PARENB ?
2195 (cflag & PARODD ? FTDI_SIO_SET_DATA_PARITY_ODD :
2196 FTDI_SIO_SET_DATA_PARITY_EVEN) :
2197 FTDI_SIO_SET_DATA_PARITY_NONE);
2198 if (cflag & CSIZE) {
2199 switch (cflag & CSIZE) {
2200 case CS5: urb_value |= 5; dbg("Setting CS5"); break;
2201 case CS6: urb_value |= 6; dbg("Setting CS6"); break;
2202 case CS7: urb_value |= 7; dbg("Setting CS7"); break;
2203 case CS8: urb_value |= 8; dbg("Setting CS8"); break;
2205 dev_err(&port->dev, "CSIZE was set but not CS5-CS8\n");
2209 /* This is needed by the break command since it uses the same command
2210 - but is or'ed with this value */
2211 priv->last_set_data_urb_value = urb_value;
2213 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2214 FTDI_SIO_SET_DATA_REQUEST,
2215 FTDI_SIO_SET_DATA_REQUEST_TYPE,
2216 urb_value , priv->interface,
2217 buf, 0, WDR_SHORT_TIMEOUT) < 0) {
2218 dev_err(&port->dev, "%s FAILED to set "
2219 "databits/stopbits/parity\n", __func__);
2222 /* Now do the baudrate */
2223 if ((cflag & CBAUD) == B0) {
2224 /* Disable flow control */
2225 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2226 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2227 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2229 buf, 0, WDR_TIMEOUT) < 0) {
2231 "%s error from disable flowcontrol urb\n",
2234 /* Drop RTS and DTR */
2235 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2237 /* set the baudrate determined before */
2238 if (change_speed(tty, port))
2239 dev_err(&port->dev, "%s urb failed to set baudrate\n",
2241 /* Ensure RTS and DTR are raised when baudrate changed from 0 */
2242 if (!old_termios || (old_termios->c_cflag & CBAUD) == B0)
2243 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2246 /* Set flow control */
2247 /* Note device also supports DTR/CD (ugh) and Xon/Xoff in hardware */
2248 if (cflag & CRTSCTS) {
2249 dbg("%s Setting to CRTSCTS flow control", __func__);
2250 if (usb_control_msg(dev,
2251 usb_sndctrlpipe(dev, 0),
2252 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2253 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2254 0 , (FTDI_SIO_RTS_CTS_HS | priv->interface),
2255 buf, 0, WDR_TIMEOUT) < 0) {
2257 "urb failed to set to rts/cts flow control\n");
2264 * Check the IXOFF status in the iflag component of the
2265 * termios structure. If IXOFF is not set, the pre-xon/xoff
2268 if (iflag & IXOFF) {
2269 dbg("%s request to enable xonxoff iflag=%04x",
2271 /* Try to enable the XON/XOFF on the ftdi_sio
2272 * Set the vstart and vstop -- could have been done up
2273 * above where a lot of other dereferencing is done but
2274 * that would be very inefficient as vstart and vstop
2275 * are not always needed.
2277 vstart = termios->c_cc[VSTART];
2278 vstop = termios->c_cc[VSTOP];
2279 urb_value = (vstop << 8) | (vstart);
2281 if (usb_control_msg(dev,
2282 usb_sndctrlpipe(dev, 0),
2283 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2284 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2285 urb_value , (FTDI_SIO_XON_XOFF_HS
2287 buf, 0, WDR_TIMEOUT) < 0) {
2288 dev_err(&port->dev, "urb failed to set to "
2289 "xon/xoff flow control\n");
2292 /* else clause to only run if cflag ! CRTSCTS and iflag
2293 * ! XOFF. CHECKME Assuming XON/XOFF handled by tty
2294 * stack - not by device */
2295 dbg("%s Turning off hardware flow control", __func__);
2296 if (usb_control_msg(dev,
2297 usb_sndctrlpipe(dev, 0),
2298 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2299 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2301 buf, 0, WDR_TIMEOUT) < 0) {
2303 "urb failed to clear flow control\n");
2311 static int ftdi_tiocmget(struct tty_struct *tty, struct file *file)
2313 struct usb_serial_port *port = tty->driver_data;
2314 struct ftdi_private *priv = usb_get_serial_port_data(port);
2315 unsigned char buf[2];
2318 dbg("%s TIOCMGET", __func__);
2319 switch (priv->chip_type) {
2321 /* Request the status from the device */
2322 ret = usb_control_msg(port->serial->dev,
2323 usb_rcvctrlpipe(port->serial->dev, 0),
2324 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
2325 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
2327 buf, 1, WDR_TIMEOUT);
2335 /* the 8U232AM returns a two byte value (the sio is a 1 byte
2336 value) - in the same format as the data returned from the in
2338 ret = usb_control_msg(port->serial->dev,
2339 usb_rcvctrlpipe(port->serial->dev, 0),
2340 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
2341 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
2343 buf, 2, WDR_TIMEOUT);
2351 return (buf[0] & FTDI_SIO_DSR_MASK ? TIOCM_DSR : 0) |
2352 (buf[0] & FTDI_SIO_CTS_MASK ? TIOCM_CTS : 0) |
2353 (buf[0] & FTDI_SIO_RI_MASK ? TIOCM_RI : 0) |
2354 (buf[0] & FTDI_SIO_RLSD_MASK ? TIOCM_CD : 0) |
2358 static int ftdi_tiocmset(struct tty_struct *tty, struct file *file,
2359 unsigned int set, unsigned int clear)
2361 struct usb_serial_port *port = tty->driver_data;
2362 dbg("%s TIOCMSET", __func__);
2363 return update_mctrl(port, set, clear);
2367 static int ftdi_ioctl(struct tty_struct *tty, struct file *file,
2368 unsigned int cmd, unsigned long arg)
2370 struct usb_serial_port *port = tty->driver_data;
2371 struct ftdi_private *priv = usb_get_serial_port_data(port);
2373 dbg("%s cmd 0x%04x", __func__, cmd);
2375 /* Based on code from acm.c and others */
2378 case TIOCGSERIAL: /* gets serial port data */
2379 return get_serial_info(port,
2380 (struct serial_struct __user *) arg);
2382 case TIOCSSERIAL: /* sets serial port data */
2383 return set_serial_info(tty, port,
2384 (struct serial_struct __user *) arg);
2387 * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
2388 * - mask passed in arg for lines of interest
2389 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
2390 * Caller should use TIOCGICOUNT to see which one it was.
2392 * This code is borrowed from linux/drivers/char/serial.c
2395 while (priv != NULL) {
2396 interruptible_sleep_on(&priv->delta_msr_wait);
2397 /* see if a signal did it */
2398 if (signal_pending(current))
2399 return -ERESTARTSYS;
2401 char diff = priv->diff_status;
2404 return -EIO; /* no change => error */
2406 /* Consume all events */
2407 priv->diff_status = 0;
2409 /* Return 0 if caller wanted to know about
2411 if (((arg & TIOCM_RNG) && (diff & FTDI_RS0_RI)) ||
2412 ((arg & TIOCM_DSR) && (diff & FTDI_RS0_DSR)) ||
2413 ((arg & TIOCM_CD) && (diff & FTDI_RS0_RLSD)) ||
2414 ((arg & TIOCM_CTS) && (diff & FTDI_RS0_CTS))) {
2418 * Otherwise caller can't care less about what
2419 * happened,and so we continue to wait for more
2428 /* This is not necessarily an error - turns out the higher layers
2429 * will do some ioctls themselves (see comment above)
2431 dbg("%s arg not supported - it was 0x%04x - check /usr/include/asm/ioctls.h", __func__, cmd);
2432 return -ENOIOCTLCMD;
2435 static void ftdi_throttle(struct tty_struct *tty)
2437 struct usb_serial_port *port = tty->driver_data;
2438 struct ftdi_private *priv = usb_get_serial_port_data(port);
2439 unsigned long flags;
2441 dbg("%s - port %d", __func__, port->number);
2443 spin_lock_irqsave(&priv->rx_lock, flags);
2444 priv->rx_flags |= THROTTLED;
2445 spin_unlock_irqrestore(&priv->rx_lock, flags);
2449 static void ftdi_unthrottle(struct tty_struct *tty)
2451 struct usb_serial_port *port = tty->driver_data;
2452 struct ftdi_private *priv = usb_get_serial_port_data(port);
2453 int actually_throttled;
2454 unsigned long flags;
2456 dbg("%s - port %d", __func__, port->number);
2458 spin_lock_irqsave(&priv->rx_lock, flags);
2459 actually_throttled = priv->rx_flags & ACTUALLY_THROTTLED;
2460 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
2461 spin_unlock_irqrestore(&priv->rx_lock, flags);
2463 if (actually_throttled)
2464 schedule_delayed_work(&priv->rx_work, 0);
2467 static int __init ftdi_init(void)
2471 dbg("%s", __func__);
2472 if (vendor > 0 && product > 0) {
2473 /* Add user specified VID/PID to reserved element of table. */
2475 for (i = 0; id_table_combined[i].idVendor; i++)
2477 id_table_combined[i].match_flags = USB_DEVICE_ID_MATCH_DEVICE;
2478 id_table_combined[i].idVendor = vendor;
2479 id_table_combined[i].idProduct = product;
2481 retval = usb_serial_register(&ftdi_sio_device);
2483 goto failed_sio_register;
2484 retval = usb_register(&ftdi_driver);
2486 goto failed_usb_register;
2488 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
2491 failed_usb_register:
2492 usb_serial_deregister(&ftdi_sio_device);
2493 failed_sio_register:
2498 static void __exit ftdi_exit(void)
2501 dbg("%s", __func__);
2503 usb_deregister(&ftdi_driver);
2504 usb_serial_deregister(&ftdi_sio_device);
2509 module_init(ftdi_init);
2510 module_exit(ftdi_exit);
2512 MODULE_AUTHOR(DRIVER_AUTHOR);
2513 MODULE_DESCRIPTION(DRIVER_DESC);
2514 MODULE_LICENSE("GPL");
2516 module_param(debug, bool, S_IRUGO | S_IWUSR);
2517 MODULE_PARM_DESC(debug, "Debug enabled or not");
2518 module_param(vendor, ushort, 0);
2519 MODULE_PARM_DESC(vendor, "User specified vendor ID (default="
2520 __MODULE_STRING(FTDI_VID)")");
2521 module_param(product, ushort, 0);
2522 MODULE_PARM_DESC(product, "User specified product ID");