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