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