?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
serial core: fix new kernel-doc warnings
[linux/fpc-iii.git] / drivers / usb / serial / ftdi_sio.c
blob4f883b1773d0541f2b2a536c2908c68a149affe1
1 /*
2 * USB FTDI SIO driver
3 *
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)
9 *
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.
14 *
15 * See Documentation/usb/usb-serial.txt for more information on using this
16 * driver
17 *
18 * See http://ftdi-usb-sio.sourceforge.net for upto date testing info
19 * and extra documentation
20 *
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.
23 *
24 */
25
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 :-) */
31
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"
47
48 /*
49 * Version Information
50 */
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"
54
55 static int debug;
56 static __u16 vendor = FTDI_VID;
57 static __u16 product;
58
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
70 */
71 int write_offset; /* This is the offset in the usb data block to
72 * write the serial data - it varies between
73 * devices
74 */
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;
85
86 __u16 interface; /* FT2232C, FT2232H or FT4232H port interface
87 (0 for FT232/245) */
88
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 */
93
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;
100 };
101
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 *);
107 };
108
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);
114
115 static struct ftdi_sio_quirk ftdi_jtag_quirk = {
116 .probe = ftdi_jtag_probe,
117 };
118
119 static struct ftdi_sio_quirk ftdi_mtxorb_hack_quirk = {
120 .probe = ftdi_mtxorb_hack_setup,
121 };
122
123 static struct ftdi_sio_quirk ftdi_NDI_device_quirk = {
124 .probe = ftdi_NDI_device_setup,
125 };
126
127 static struct ftdi_sio_quirk ftdi_USB_UIRT_quirk = {
128 .port_probe = ftdi_USB_UIRT_setup,
129 };
130
131 static struct ftdi_sio_quirk ftdi_HE_TIRA1_quirk = {
132 .port_probe = ftdi_HE_TIRA1_setup,
133 };
134
135 /*
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)
143 *
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]
149 */
150
151
152
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) },
559 /*
560 * Due to many user requests for multiple ELV devices we enable
561 * them by default.
562 */
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(ADI_VID, ADI_GNICEPLUS_PID),
701 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
702 { USB_DEVICE(JETI_VID, JETI_SPC1201_PID) },
703 { USB_DEVICE(MARVELL_VID, MARVELL_SHEEVAPLUG_PID),
704 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
705 { USB_DEVICE(LARSENBRUSGAARD_VID, LB_ALTITRACK_PID) },
706 { USB_DEVICE(GN_OTOMETRICS_VID, AURICAL_USB_PID) },
707 { USB_DEVICE(BAYER_VID, BAYER_CONTOUR_CABLE_PID) },
708 { USB_DEVICE(FTDI_VID, MARVELL_OPENRD_PID),
709 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
710 { USB_DEVICE(FTDI_VID, HAMEG_HO820_PID) },
711 { USB_DEVICE(FTDI_VID, HAMEG_HO870_PID) },
712 { }, /* Optional parameter entry */
713 { } /* Terminating entry */
714 };
715
716 MODULE_DEVICE_TABLE(usb, id_table_combined);
717
718 static struct usb_driver ftdi_driver = {
719 .name = "ftdi_sio",
720 .probe = usb_serial_probe,
721 .disconnect = usb_serial_disconnect,
722 .id_table = id_table_combined,
723 .no_dynamic_id = 1,
724 };
725
726 static const char *ftdi_chip_name[] = {
727 [SIO] = "SIO", /* the serial part of FT8U100AX */
728 [FT8U232AM] = "FT8U232AM",
729 [FT232BM] = "FT232BM",
730 [FT2232C] = "FT2232C",
731 [FT232RL] = "FT232RL",
732 [FT2232H] = "FT2232H",
733 [FT4232H] = "FT4232H"
734 };
735
736
737 /* Constants for read urb and write urb */
738 #define BUFSZ 512
739
740 /* rx_flags */
741 #define THROTTLED 0x01
742 #define ACTUALLY_THROTTLED 0x02
743
744 /* Used for TIOCMIWAIT */
745 #define FTDI_STATUS_B0_MASK (FTDI_RS0_CTS | FTDI_RS0_DSR | FTDI_RS0_RI | FTDI_RS0_RLSD)
746 #define FTDI_STATUS_B1_MASK (FTDI_RS_BI)
747 /* End TIOCMIWAIT */
748
749 #define FTDI_IMPL_ASYNC_FLAGS = (ASYNC_SPD_HI | ASYNC_SPD_VHI \
750 | ASYNC_SPD_CUST | ASYNC_SPD_SHI | ASYNC_SPD_WARP)
751
752 /* function prototypes for a FTDI serial converter */
753 static int ftdi_sio_probe(struct usb_serial *serial,
754 const struct usb_device_id *id);
755 static int ftdi_sio_port_probe(struct usb_serial_port *port);
756 static int ftdi_sio_port_remove(struct usb_serial_port *port);
757 static int ftdi_open(struct tty_struct *tty, struct usb_serial_port *port);
758 static void ftdi_close(struct usb_serial_port *port);
759 static void ftdi_dtr_rts(struct usb_serial_port *port, int on);
760 static int ftdi_write(struct tty_struct *tty, struct usb_serial_port *port,
761 const unsigned char *buf, int count);
762 static int ftdi_write_room(struct tty_struct *tty);
763 static int ftdi_chars_in_buffer(struct tty_struct *tty);
764 static void ftdi_write_bulk_callback(struct urb *urb);
765 static void ftdi_read_bulk_callback(struct urb *urb);
766 static void ftdi_process_read(struct work_struct *work);
767 static void ftdi_set_termios(struct tty_struct *tty,
768 struct usb_serial_port *port, struct ktermios *old);
769 static int ftdi_tiocmget(struct tty_struct *tty, struct file *file);
770 static int ftdi_tiocmset(struct tty_struct *tty, struct file *file,
771 unsigned int set, unsigned int clear);
772 static int ftdi_ioctl(struct tty_struct *tty, struct file *file,
773 unsigned int cmd, unsigned long arg);
774 static void ftdi_break_ctl(struct tty_struct *tty, int break_state);
775 static void ftdi_throttle(struct tty_struct *tty);
776 static void ftdi_unthrottle(struct tty_struct *tty);
777
778 static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base);
779 static unsigned short int ftdi_232am_baud_to_divisor(int baud);
780 static __u32 ftdi_232bm_baud_base_to_divisor(int baud, int base);
781 static __u32 ftdi_232bm_baud_to_divisor(int baud);
782 static __u32 ftdi_2232h_baud_base_to_divisor(int baud, int base);
783 static __u32 ftdi_2232h_baud_to_divisor(int baud);
784
785 static struct usb_serial_driver ftdi_sio_device = {
786 .driver = {
787 .owner = THIS_MODULE,
788 .name = "ftdi_sio",
789 },
790 .description = "FTDI USB Serial Device",
791 .usb_driver = &ftdi_driver ,
792 .id_table = id_table_combined,
793 .num_ports = 1,
794 .probe = ftdi_sio_probe,
795 .port_probe = ftdi_sio_port_probe,
796 .port_remove = ftdi_sio_port_remove,
797 .open = ftdi_open,
798 .close = ftdi_close,
799 .dtr_rts = ftdi_dtr_rts,
800 .throttle = ftdi_throttle,
801 .unthrottle = ftdi_unthrottle,
802 .write = ftdi_write,
803 .write_room = ftdi_write_room,
804 .chars_in_buffer = ftdi_chars_in_buffer,
805 .read_bulk_callback = ftdi_read_bulk_callback,
806 .write_bulk_callback = ftdi_write_bulk_callback,
807 .tiocmget = ftdi_tiocmget,
808 .tiocmset = ftdi_tiocmset,
809 .ioctl = ftdi_ioctl,
810 .set_termios = ftdi_set_termios,
811 .break_ctl = ftdi_break_ctl,
812 };
813
814
815 #define WDR_TIMEOUT 5000 /* default urb timeout */
816 #define WDR_SHORT_TIMEOUT 1000 /* shorter urb timeout */
817
818 /* High and low are for DTR, RTS etc etc */
819 #define HIGH 1
820 #define LOW 0
821
822 /* number of outstanding urbs to prevent userspace DoS from happening */
823 #define URB_UPPER_LIMIT 42
824
825 /*
826 * ***************************************************************************
827 * Utility functions
828 * ***************************************************************************
829 */
830
831 static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base)
832 {
833 unsigned short int divisor;
834 /* divisor shifted 3 bits to the left */
835 int divisor3 = base / 2 / baud;
836 if ((divisor3 & 0x7) == 7)
837 divisor3++; /* round x.7/8 up to x+1 */
838 divisor = divisor3 >> 3;
839 divisor3 &= 0x7;
840 if (divisor3 == 1)
841 divisor |= 0xc000;
842 else if (divisor3 >= 4)
843 divisor |= 0x4000;
844 else if (divisor3 != 0)
845 divisor |= 0x8000;
846 else if (divisor == 1)
847 divisor = 0; /* special case for maximum baud rate */
848 return divisor;
849 }
850
851 static unsigned short int ftdi_232am_baud_to_divisor(int baud)
852 {
853 return ftdi_232am_baud_base_to_divisor(baud, 48000000);
854 }
855
856 static __u32 ftdi_232bm_baud_base_to_divisor(int baud, int base)
857 {
858 static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
859 __u32 divisor;
860 /* divisor shifted 3 bits to the left */
861 int divisor3 = base / 2 / baud;
862 divisor = divisor3 >> 3;
863 divisor |= (__u32)divfrac[divisor3 & 0x7] << 14;
864 /* Deal with special cases for highest baud rates. */
865 if (divisor == 1)
866 divisor = 0;
867 else if (divisor == 0x4001)
868 divisor = 1;
869 return divisor;
870 }
871
872 static __u32 ftdi_232bm_baud_to_divisor(int baud)
873 {
874 return ftdi_232bm_baud_base_to_divisor(baud, 48000000);
875 }
876
877 static __u32 ftdi_2232h_baud_base_to_divisor(int baud, int base)
878 {
879 static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
880 __u32 divisor;
881 int divisor3;
882
883 /* hi-speed baud rate is 10-bit sampling instead of 16-bit */
884 divisor3 = (base / 10 / baud) * 8;
885
886 divisor = divisor3 >> 3;
887 divisor |= (__u32)divfrac[divisor3 & 0x7] << 14;
888 /* Deal with special cases for highest baud rates. */
889 if (divisor == 1)
890 divisor = 0;
891 else if (divisor == 0x4001)
892 divisor = 1;
893 /*
894 * Set this bit to turn off a divide by 2.5 on baud rate generator
895 * This enables baud rates up to 12Mbaud but cannot reach below 1200
896 * baud with this bit set
897 */
898 divisor |= 0x00020000;
899 return divisor;
900 }
901
902 static __u32 ftdi_2232h_baud_to_divisor(int baud)
903 {
904 return ftdi_2232h_baud_base_to_divisor(baud, 120000000);
905 }
906
907 #define set_mctrl(port, set) update_mctrl((port), (set), 0)
908 #define clear_mctrl(port, clear) update_mctrl((port), 0, (clear))
909
910 static int update_mctrl(struct usb_serial_port *port, unsigned int set,
911 unsigned int clear)
912 {
913 struct ftdi_private *priv = usb_get_serial_port_data(port);
914 char *buf;
915 unsigned urb_value;
916 int rv;
917
918 if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
919 dbg("%s - DTR|RTS not being set|cleared", __func__);
920 return 0; /* no change */
921 }
922
923 buf = kmalloc(1, GFP_NOIO);
924 if (!buf)
925 return -ENOMEM;
926
927 clear &= ~set; /* 'set' takes precedence over 'clear' */
928 urb_value = 0;
929 if (clear & TIOCM_DTR)
930 urb_value |= FTDI_SIO_SET_DTR_LOW;
931 if (clear & TIOCM_RTS)
932 urb_value |= FTDI_SIO_SET_RTS_LOW;
933 if (set & TIOCM_DTR)
934 urb_value |= FTDI_SIO_SET_DTR_HIGH;
935 if (set & TIOCM_RTS)
936 urb_value |= FTDI_SIO_SET_RTS_HIGH;
937 rv = usb_control_msg(port->serial->dev,
938 usb_sndctrlpipe(port->serial->dev, 0),
939 FTDI_SIO_SET_MODEM_CTRL_REQUEST,
940 FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE,
941 urb_value, priv->interface,
942 buf, 0, WDR_TIMEOUT);
943
944 kfree(buf);
945 if (rv < 0) {
946 dbg("%s Error from MODEM_CTRL urb: DTR %s, RTS %s",
947 __func__,
948 (set & TIOCM_DTR) ? "HIGH" :
949 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
950 (set & TIOCM_RTS) ? "HIGH" :
951 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
952 } else {
953 dbg("%s - DTR %s, RTS %s", __func__,
954 (set & TIOCM_DTR) ? "HIGH" :
955 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
956 (set & TIOCM_RTS) ? "HIGH" :
957 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
958 /* FIXME: locking on last_dtr_rts */
959 priv->last_dtr_rts = (priv->last_dtr_rts & ~clear) | set;
960 }
961 return rv;
962 }
963
964
965 static __u32 get_ftdi_divisor(struct tty_struct *tty,
966 struct usb_serial_port *port)
967 { /* get_ftdi_divisor */
968 struct ftdi_private *priv = usb_get_serial_port_data(port);
969 __u32 div_value = 0;
970 int div_okay = 1;
971 int baud;
972
973 /*
974 * The logic involved in setting the baudrate can be cleanly split into
975 * 3 steps.
976 * 1. Standard baud rates are set in tty->termios->c_cflag
977 * 2. If these are not enough, you can set any speed using alt_speed as
978 * follows:
979 * - set tty->termios->c_cflag speed to B38400
980 * - set your real speed in tty->alt_speed; it gets ignored when
981 * alt_speed==0, (or)
982 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as
983 * follows:
984 * flags & ASYNC_SPD_MASK == ASYNC_SPD_[HI, VHI, SHI, WARP],
985 * this just sets alt_speed to (HI: 57600, VHI: 115200,
986 * SHI: 230400, WARP: 460800)
987 * ** Steps 1, 2 are done courtesy of tty_get_baud_rate
988 * 3. You can also set baud rate by setting custom divisor as follows
989 * - set tty->termios->c_cflag speed to B38400
990 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as
991 * follows:
992 * o flags & ASYNC_SPD_MASK == ASYNC_SPD_CUST
993 * o custom_divisor set to baud_base / your_new_baudrate
994 * ** Step 3 is done courtesy of code borrowed from serial.c
995 * I should really spend some time and separate + move this common
996 * code to serial.c, it is replicated in nearly every serial driver
997 * you see.
998 */
999
1000 /* 1. Get the baud rate from the tty settings, this observes
1001 alt_speed hack */
1002
1003 baud = tty_get_baud_rate(tty);
1004 dbg("%s - tty_get_baud_rate reports speed %d", __func__, baud);
1005
1006 /* 2. Observe async-compatible custom_divisor hack, update baudrate
1007 if needed */
1008
1009 if (baud == 38400 &&
1010 ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
1011 (priv->custom_divisor)) {
1012 baud = priv->baud_base / priv->custom_divisor;
1013 dbg("%s - custom divisor %d sets baud rate to %d",
1014 __func__, priv->custom_divisor, baud);
1015 }
1016
1017 /* 3. Convert baudrate to device-specific divisor */
1018
1019 if (!baud)
1020 baud = 9600;
1021 switch (priv->chip_type) {
1022 case SIO: /* SIO chip */
1023 switch (baud) {
1024 case 300: div_value = ftdi_sio_b300; break;
1025 case 600: div_value = ftdi_sio_b600; break;
1026 case 1200: div_value = ftdi_sio_b1200; break;
1027 case 2400: div_value = ftdi_sio_b2400; break;
1028 case 4800: div_value = ftdi_sio_b4800; break;
1029 case 9600: div_value = ftdi_sio_b9600; break;
1030 case 19200: div_value = ftdi_sio_b19200; break;
1031 case 38400: div_value = ftdi_sio_b38400; break;
1032 case 57600: div_value = ftdi_sio_b57600; break;
1033 case 115200: div_value = ftdi_sio_b115200; break;
1034 } /* baud */
1035 if (div_value == 0) {
1036 dbg("%s - Baudrate (%d) requested is not supported",
1037 __func__, baud);
1038 div_value = ftdi_sio_b9600;
1039 baud = 9600;
1040 div_okay = 0;
1041 }
1042 break;
1043 case FT8U232AM: /* 8U232AM chip */
1044 if (baud <= 3000000) {
1045 div_value = ftdi_232am_baud_to_divisor(baud);
1046 } else {
1047 dbg("%s - Baud rate too high!", __func__);
1048 baud = 9600;
1049 div_value = ftdi_232am_baud_to_divisor(9600);
1050 div_okay = 0;
1051 }
1052 break;
1053 case FT232BM: /* FT232BM chip */
1054 case FT2232C: /* FT2232C chip */
1055 case FT232RL:
1056 if (baud <= 3000000) {
1057 __u16 product_id = le16_to_cpu(
1058 port->serial->dev->descriptor.idProduct);
1059 if (((FTDI_NDI_HUC_PID == product_id) ||
1060 (FTDI_NDI_SPECTRA_SCU_PID == product_id) ||
1061 (FTDI_NDI_FUTURE_2_PID == product_id) ||
1062 (FTDI_NDI_FUTURE_3_PID == product_id) ||
1063 (FTDI_NDI_AURORA_SCU_PID == product_id)) &&
1064 (baud == 19200)) {
1065 baud = 1200000;
1066 }
1067 div_value = ftdi_232bm_baud_to_divisor(baud);
1068 } else {
1069 dbg("%s - Baud rate too high!", __func__);
1070 div_value = ftdi_232bm_baud_to_divisor(9600);
1071 div_okay = 0;
1072 baud = 9600;
1073 }
1074 break;
1075 case FT2232H: /* FT2232H chip */
1076 case FT4232H: /* FT4232H chip */
1077 if ((baud <= 12000000) & (baud >= 1200)) {
1078 div_value = ftdi_2232h_baud_to_divisor(baud);
1079 } else if (baud < 1200) {
1080 div_value = ftdi_232bm_baud_to_divisor(baud);
1081 } else {
1082 dbg("%s - Baud rate too high!", __func__);
1083 div_value = ftdi_232bm_baud_to_divisor(9600);
1084 div_okay = 0;
1085 baud = 9600;
1086 }
1087 break;
1088 } /* priv->chip_type */
1089
1090 if (div_okay) {
1091 dbg("%s - Baud rate set to %d (divisor 0x%lX) on chip %s",
1092 __func__, baud, (unsigned long)div_value,
1093 ftdi_chip_name[priv->chip_type]);
1094 }
1095
1096 tty_encode_baud_rate(tty, baud, baud);
1097 return div_value;
1098 }
1099
1100 static int change_speed(struct tty_struct *tty, struct usb_serial_port *port)
1101 {
1102 struct ftdi_private *priv = usb_get_serial_port_data(port);
1103 char *buf;
1104 __u16 urb_value;
1105 __u16 urb_index;
1106 __u32 urb_index_value;
1107 int rv;
1108
1109 buf = kmalloc(1, GFP_NOIO);
1110 if (!buf)
1111 return -ENOMEM;
1112
1113 urb_index_value = get_ftdi_divisor(tty, port);
1114 urb_value = (__u16)urb_index_value;
1115 urb_index = (__u16)(urb_index_value >> 16);
1116 if (priv->interface) { /* FT2232C */
1117 urb_index = (__u16)((urb_index << 8) | priv->interface);
1118 }
1119
1120 rv = usb_control_msg(port->serial->dev,
1121 usb_sndctrlpipe(port->serial->dev, 0),
1122 FTDI_SIO_SET_BAUDRATE_REQUEST,
1123 FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE,
1124 urb_value, urb_index,
1125 buf, 0, WDR_SHORT_TIMEOUT);
1126
1127 kfree(buf);
1128 return rv;
1129 }
1130
1131 static int write_latency_timer(struct usb_serial_port *port)
1132 {
1133 struct ftdi_private *priv = usb_get_serial_port_data(port);
1134 struct usb_device *udev = port->serial->dev;
1135 char buf[1];
1136 int rv = 0;
1137 int l = priv->latency;
1138
1139 if (priv->flags & ASYNC_LOW_LATENCY)
1140 l = 1;
1141
1142 dbg("%s: setting latency timer = %i", __func__, l);
1143
1144 rv = usb_control_msg(udev,
1145 usb_sndctrlpipe(udev, 0),
1146 FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
1147 FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
1148 l, priv->interface,
1149 buf, 0, WDR_TIMEOUT);
1150
1151 if (rv < 0)
1152 dev_err(&port->dev, "Unable to write latency timer: %i\n", rv);
1153 return rv;
1154 }
1155
1156 static int read_latency_timer(struct usb_serial_port *port)
1157 {
1158 struct ftdi_private *priv = usb_get_serial_port_data(port);
1159 struct usb_device *udev = port->serial->dev;
1160 unsigned short latency = 0;
1161 int rv = 0;
1162
1163
1164 dbg("%s", __func__);
1165
1166 rv = usb_control_msg(udev,
1167 usb_rcvctrlpipe(udev, 0),
1168 FTDI_SIO_GET_LATENCY_TIMER_REQUEST,
1169 FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE,
1170 0, priv->interface,
1171 (char *) &latency, 1, WDR_TIMEOUT);
1172
1173 if (rv < 0) {
1174 dev_err(&port->dev, "Unable to read latency timer: %i\n", rv);
1175 return -EIO;
1176 }
1177 return latency;
1178 }
1179
1180 static int get_serial_info(struct usb_serial_port *port,
1181 struct serial_struct __user *retinfo)
1182 {
1183 struct ftdi_private *priv = usb_get_serial_port_data(port);
1184 struct serial_struct tmp;
1185
1186 if (!retinfo)
1187 return -EFAULT;
1188 memset(&tmp, 0, sizeof(tmp));
1189 tmp.flags = priv->flags;
1190 tmp.baud_base = priv->baud_base;
1191 tmp.custom_divisor = priv->custom_divisor;
1192 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
1193 return -EFAULT;
1194 return 0;
1195 } /* get_serial_info */
1196
1197
1198 static int set_serial_info(struct tty_struct *tty,
1199 struct usb_serial_port *port, struct serial_struct __user *newinfo)
1200 { /* set_serial_info */
1201 struct ftdi_private *priv = usb_get_serial_port_data(port);
1202 struct serial_struct new_serial;
1203 struct ftdi_private old_priv;
1204
1205 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
1206 return -EFAULT;
1207
1208 lock_kernel();
1209 old_priv = *priv;
1210
1211 /* Do error checking and permission checking */
1212
1213 if (!capable(CAP_SYS_ADMIN)) {
1214 if (((new_serial.flags & ~ASYNC_USR_MASK) !=
1215 (priv->flags & ~ASYNC_USR_MASK))) {
1216 unlock_kernel();
1217 return -EPERM;
1218 }
1219 priv->flags = ((priv->flags & ~ASYNC_USR_MASK) |
1220 (new_serial.flags & ASYNC_USR_MASK));
1221 priv->custom_divisor = new_serial.custom_divisor;
1222 goto check_and_exit;
1223 }
1224
1225 if ((new_serial.baud_base != priv->baud_base) &&
1226 (new_serial.baud_base < 9600)) {
1227 unlock_kernel();
1228 return -EINVAL;
1229 }
1230
1231 /* Make the changes - these are privileged changes! */
1232
1233 priv->flags = ((priv->flags & ~ASYNC_FLAGS) |
1234 (new_serial.flags & ASYNC_FLAGS));
1235 priv->custom_divisor = new_serial.custom_divisor;
1236
1237 tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
1238 write_latency_timer(port);
1239
1240 check_and_exit:
1241 if ((old_priv.flags & ASYNC_SPD_MASK) !=
1242 (priv->flags & ASYNC_SPD_MASK)) {
1243 if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_HI)
1244 tty->alt_speed = 57600;
1245 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_VHI)
1246 tty->alt_speed = 115200;
1247 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_SHI)
1248 tty->alt_speed = 230400;
1249 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_WARP)
1250 tty->alt_speed = 460800;
1251 else
1252 tty->alt_speed = 0;
1253 }
1254 if (((old_priv.flags & ASYNC_SPD_MASK) !=
1255 (priv->flags & ASYNC_SPD_MASK)) ||
1256 (((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
1257 (old_priv.custom_divisor != priv->custom_divisor))) {
1258 unlock_kernel();
1259 change_speed(tty, port);
1260 }
1261 else
1262 unlock_kernel();
1263 return 0;
1264
1265 } /* set_serial_info */
1266
1267
1268 /* Determine type of FTDI chip based on USB config and descriptor. */
1269 static void ftdi_determine_type(struct usb_serial_port *port)
1270 {
1271 struct ftdi_private *priv = usb_get_serial_port_data(port);
1272 struct usb_serial *serial = port->serial;
1273 struct usb_device *udev = serial->dev;
1274 unsigned version;
1275 unsigned interfaces;
1276
1277 /* Assume it is not the original SIO device for now. */
1278 priv->baud_base = 48000000 / 2;
1279 priv->write_offset = 0;
1280
1281 version = le16_to_cpu(udev->descriptor.bcdDevice);
1282 interfaces = udev->actconfig->desc.bNumInterfaces;
1283 dbg("%s: bcdDevice = 0x%x, bNumInterfaces = %u", __func__,
1284 version, interfaces);
1285 if (interfaces > 1) {
1286 int inter;
1287
1288 /* Multiple interfaces.*/
1289 if (version == 0x0800) {
1290 priv->chip_type = FT4232H;
1291 /* Hi-speed - baud clock runs at 120MHz */
1292 priv->baud_base = 120000000 / 2;
1293 } else if (version == 0x0700) {
1294 priv->chip_type = FT2232H;
1295 /* Hi-speed - baud clock runs at 120MHz */
1296 priv->baud_base = 120000000 / 2;
1297 } else
1298 priv->chip_type = FT2232C;
1299
1300 /* Determine interface code. */
1301 inter = serial->interface->altsetting->desc.bInterfaceNumber;
1302 if (inter == 0) {
1303 priv->interface = INTERFACE_A;
1304 } else if (inter == 1) {
1305 priv->interface = INTERFACE_B;
1306 } else if (inter == 2) {
1307 priv->interface = INTERFACE_C;
1308 } else if (inter == 3) {
1309 priv->interface = INTERFACE_D;
1310 }
1311 /* BM-type devices have a bug where bcdDevice gets set
1312 * to 0x200 when iSerialNumber is 0. */
1313 if (version < 0x500) {
1314 dbg("%s: something fishy - bcdDevice too low for multi-interface device",
1315 __func__);
1316 }
1317 } else if (version < 0x200) {
1318 /* Old device. Assume its the original SIO. */
1319 priv->chip_type = SIO;
1320 priv->baud_base = 12000000 / 16;
1321 priv->write_offset = 1;
1322 } else if (version < 0x400) {
1323 /* Assume its an FT8U232AM (or FT8U245AM) */
1324 /* (It might be a BM because of the iSerialNumber bug,
1325 * but it will still work as an AM device.) */
1326 priv->chip_type = FT8U232AM;
1327 } else if (version < 0x600) {
1328 /* Assume its an FT232BM (or FT245BM) */
1329 priv->chip_type = FT232BM;
1330 } else {
1331 /* Assume its an FT232R */
1332 priv->chip_type = FT232RL;
1333 }
1334 dev_info(&udev->dev, "Detected %s\n", ftdi_chip_name[priv->chip_type]);
1335 }
1336
1337
1338 /* Determine the maximum packet size for the device. This depends on the chip
1339 * type and the USB host capabilities. The value should be obtained from the
1340 * device descriptor as the chip will use the appropriate values for the host.*/
1341 static void ftdi_set_max_packet_size(struct usb_serial_port *port)
1342 {
1343 struct ftdi_private *priv = usb_get_serial_port_data(port);
1344 struct usb_serial *serial = port->serial;
1345 struct usb_device *udev = serial->dev;
1346
1347 struct usb_interface *interface = serial->interface;
1348 struct usb_endpoint_descriptor *ep_desc = &interface->cur_altsetting->endpoint[1].desc;
1349
1350 unsigned num_endpoints;
1351 int i = 0;
1352
1353 num_endpoints = interface->cur_altsetting->desc.bNumEndpoints;
1354 dev_info(&udev->dev, "Number of endpoints %d\n", num_endpoints);
1355
1356 /* NOTE: some customers have programmed FT232R/FT245R devices
1357 * with an endpoint size of 0 - not good. In this case, we
1358 * want to override the endpoint descriptor setting and use a
1359 * value of 64 for wMaxPacketSize */
1360 for (i = 0; i < num_endpoints; i++) {
1361 dev_info(&udev->dev, "Endpoint %d MaxPacketSize %d\n", i+1,
1362 interface->cur_altsetting->endpoint[i].desc.wMaxPacketSize);
1363 ep_desc = &interface->cur_altsetting->endpoint[i].desc;
1364 if (ep_desc->wMaxPacketSize == 0) {
1365 ep_desc->wMaxPacketSize = cpu_to_le16(0x40);
1366 dev_info(&udev->dev, "Overriding wMaxPacketSize on endpoint %d\n", i);
1367 }
1368 }
1369
1370 /* set max packet size based on descriptor */
1371 priv->max_packet_size = ep_desc->wMaxPacketSize;
1372
1373 dev_info(&udev->dev, "Setting MaxPacketSize %d\n", priv->max_packet_size);
1374 }
1375
1376
1377 /*
1378 * ***************************************************************************
1379 * Sysfs Attribute
1380 * ***************************************************************************
1381 */
1382
1383 static ssize_t show_latency_timer(struct device *dev,
1384 struct device_attribute *attr, char *buf)
1385 {
1386 struct usb_serial_port *port = to_usb_serial_port(dev);
1387 struct ftdi_private *priv = usb_get_serial_port_data(port);
1388 if (priv->flags & ASYNC_LOW_LATENCY)
1389 return sprintf(buf, "1\n");
1390 else
1391 return sprintf(buf, "%i\n", priv->latency);
1392 }
1393
1394
1395 /* Write a new value of the latency timer, in units of milliseconds. */
1396 static ssize_t store_latency_timer(struct device *dev,
1397 struct device_attribute *attr, const char *valbuf,
1398 size_t count)
1399 {
1400 struct usb_serial_port *port = to_usb_serial_port(dev);
1401 struct ftdi_private *priv = usb_get_serial_port_data(port);
1402 int v = simple_strtoul(valbuf, NULL, 10);
1403 int rv = 0;
1404
1405 priv->latency = v;
1406 rv = write_latency_timer(port);
1407 if (rv < 0)
1408 return -EIO;
1409 return count;
1410 }
1411
1412 /* Write an event character directly to the FTDI register. The ASCII
1413 value is in the low 8 bits, with the enable bit in the 9th bit. */
1414 static ssize_t store_event_char(struct device *dev,
1415 struct device_attribute *attr, const char *valbuf, size_t count)
1416 {
1417 struct usb_serial_port *port = to_usb_serial_port(dev);
1418 struct ftdi_private *priv = usb_get_serial_port_data(port);
1419 struct usb_device *udev = port->serial->dev;
1420 char buf[1];
1421 int v = simple_strtoul(valbuf, NULL, 10);
1422 int rv = 0;
1423
1424 dbg("%s: setting event char = %i", __func__, v);
1425
1426 rv = usb_control_msg(udev,
1427 usb_sndctrlpipe(udev, 0),
1428 FTDI_SIO_SET_EVENT_CHAR_REQUEST,
1429 FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE,
1430 v, priv->interface,
1431 buf, 0, WDR_TIMEOUT);
1432
1433 if (rv < 0) {
1434 dbg("Unable to write event character: %i", rv);
1435 return -EIO;
1436 }
1437
1438 return count;
1439 }
1440
1441 static DEVICE_ATTR(latency_timer, S_IWUSR | S_IRUGO, show_latency_timer,
1442 store_latency_timer);
1443 static DEVICE_ATTR(event_char, S_IWUSR, NULL, store_event_char);
1444
1445 static int create_sysfs_attrs(struct usb_serial_port *port)
1446 {
1447 struct ftdi_private *priv = usb_get_serial_port_data(port);
1448 int retval = 0;
1449
1450 dbg("%s", __func__);
1451
1452 /* XXX I've no idea if the original SIO supports the event_char
1453 * sysfs parameter, so I'm playing it safe. */
1454 if (priv->chip_type != SIO) {
1455 dbg("sysfs attributes for %s", ftdi_chip_name[priv->chip_type]);
1456 retval = device_create_file(&port->dev, &dev_attr_event_char);
1457 if ((!retval) &&
1458 (priv->chip_type == FT232BM ||
1459 priv->chip_type == FT2232C ||
1460 priv->chip_type == FT232RL ||
1461 priv->chip_type == FT2232H ||
1462 priv->chip_type == FT4232H)) {
1463 retval = device_create_file(&port->dev,
1464 &dev_attr_latency_timer);
1465 }
1466 }
1467 return retval;
1468 }
1469
1470 static void remove_sysfs_attrs(struct usb_serial_port *port)
1471 {
1472 struct ftdi_private *priv = usb_get_serial_port_data(port);
1473
1474 dbg("%s", __func__);
1475
1476 /* XXX see create_sysfs_attrs */
1477 if (priv->chip_type != SIO) {
1478 device_remove_file(&port->dev, &dev_attr_event_char);
1479 if (priv->chip_type == FT232BM ||
1480 priv->chip_type == FT2232C ||
1481 priv->chip_type == FT232RL ||
1482 priv->chip_type == FT2232H ||
1483 priv->chip_type == FT4232H) {
1484 device_remove_file(&port->dev, &dev_attr_latency_timer);
1485 }
1486 }
1487
1488 }
1489
1490 /*
1491 * ***************************************************************************
1492 * FTDI driver specific functions
1493 * ***************************************************************************
1494 */
1495
1496 /* Probe function to check for special devices */
1497 static int ftdi_sio_probe(struct usb_serial *serial,
1498 const struct usb_device_id *id)
1499 {
1500 struct ftdi_sio_quirk *quirk =
1501 (struct ftdi_sio_quirk *)id->driver_info;
1502
1503 if (quirk && quirk->probe) {
1504 int ret = quirk->probe(serial);
1505 if (ret != 0)
1506 return ret;
1507 }
1508
1509 usb_set_serial_data(serial, (void *)id->driver_info);
1510
1511 return 0;
1512 }
1513
1514 static int ftdi_sio_port_probe(struct usb_serial_port *port)
1515 {
1516 struct ftdi_private *priv;
1517 struct ftdi_sio_quirk *quirk = usb_get_serial_data(port->serial);
1518
1519
1520 dbg("%s", __func__);
1521
1522 priv = kzalloc(sizeof(struct ftdi_private), GFP_KERNEL);
1523 if (!priv) {
1524 dev_err(&port->dev, "%s- kmalloc(%Zd) failed.\n", __func__,
1525 sizeof(struct ftdi_private));
1526 return -ENOMEM;
1527 }
1528
1529 kref_init(&priv->kref);
1530 spin_lock_init(&priv->rx_lock);
1531 spin_lock_init(&priv->tx_lock);
1532 init_waitqueue_head(&priv->delta_msr_wait);
1533 /* This will push the characters through immediately rather
1534 than queue a task to deliver them */
1535 priv->flags = ASYNC_LOW_LATENCY;
1536
1537 if (quirk && quirk->port_probe)
1538 quirk->port_probe(priv);
1539
1540 /* Increase the size of read buffers */
1541 kfree(port->bulk_in_buffer);
1542 port->bulk_in_buffer = kmalloc(BUFSZ, GFP_KERNEL);
1543 if (!port->bulk_in_buffer) {
1544 kfree(priv);
1545 return -ENOMEM;
1546 }
1547 if (port->read_urb) {
1548 port->read_urb->transfer_buffer = port->bulk_in_buffer;
1549 port->read_urb->transfer_buffer_length = BUFSZ;
1550 }
1551
1552 INIT_DELAYED_WORK(&priv->rx_work, ftdi_process_read);
1553 priv->port = port;
1554
1555 /* Free port's existing write urb and transfer buffer. */
1556 if (port->write_urb) {
1557 usb_free_urb(port->write_urb);
1558 port->write_urb = NULL;
1559 }
1560 kfree(port->bulk_out_buffer);
1561 port->bulk_out_buffer = NULL;
1562
1563 usb_set_serial_port_data(port, priv);
1564
1565 ftdi_determine_type(port);
1566 ftdi_set_max_packet_size(port);
1567 read_latency_timer(port);
1568 create_sysfs_attrs(port);
1569 return 0;
1570 }
1571
1572 /* Setup for the USB-UIRT device, which requires hardwired
1573 * baudrate (38400 gets mapped to 312500) */
1574 /* Called from usbserial:serial_probe */
1575 static void ftdi_USB_UIRT_setup(struct ftdi_private *priv)
1576 {
1577 dbg("%s", __func__);
1578
1579 priv->flags |= ASYNC_SPD_CUST;
1580 priv->custom_divisor = 77;
1581 priv->force_baud = 38400;
1582 } /* ftdi_USB_UIRT_setup */
1583
1584 /* Setup for the HE-TIRA1 device, which requires hardwired
1585 * baudrate (38400 gets mapped to 100000) and RTS-CTS enabled. */
1586
1587 static void ftdi_HE_TIRA1_setup(struct ftdi_private *priv)
1588 {
1589 dbg("%s", __func__);
1590
1591 priv->flags |= ASYNC_SPD_CUST;
1592 priv->custom_divisor = 240;
1593 priv->force_baud = 38400;
1594 priv->force_rtscts = 1;
1595 } /* ftdi_HE_TIRA1_setup */
1596
1597 /*
1598 * Module parameter to control latency timer for NDI FTDI-based USB devices.
1599 * If this value is not set in modprobe.conf.local its value will be set to 1ms.
1600 */
1601 static int ndi_latency_timer = 1;
1602
1603 /* Setup for the NDI FTDI-based USB devices, which requires hardwired
1604 * baudrate (19200 gets mapped to 1200000).
1605 *
1606 * Called from usbserial:serial_probe.
1607 */
1608 static int ftdi_NDI_device_setup(struct usb_serial *serial)
1609 {
1610 struct usb_device *udev = serial->dev;
1611 int latency = ndi_latency_timer;
1612 int rv = 0;
1613 char buf[1];
1614
1615 if (latency == 0)
1616 latency = 1;
1617 if (latency > 99)
1618 latency = 99;
1619
1620 dbg("%s setting NDI device latency to %d", __func__, latency);
1621 dev_info(&udev->dev, "NDI device with a latency value of %d", latency);
1622
1623 rv = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1624 FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
1625 FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
1626 latency, 0, buf, 0, WDR_TIMEOUT);
1627 return 0;
1628 }
1629
1630 /*
1631 * First port on JTAG adaptors such as Olimex arm-usb-ocd or the FIC/OpenMoko
1632 * Neo1973 Debug Board is reserved for JTAG interface and can be accessed from
1633 * userspace using openocd.
1634 */
1635 static int ftdi_jtag_probe(struct usb_serial *serial)
1636 {
1637 struct usb_device *udev = serial->dev;
1638 struct usb_interface *interface = serial->interface;
1639
1640 dbg("%s", __func__);
1641
1642 if (interface == udev->actconfig->interface[0]) {
1643 dev_info(&udev->dev,
1644 "Ignoring serial port reserved for JTAG\n");
1645 return -ENODEV;
1646 }
1647
1648 return 0;
1649 }
1650
1651 /*
1652 * The Matrix Orbital VK204-25-USB has an invalid IN endpoint.
1653 * We have to correct it if we want to read from it.
1654 */
1655 static int ftdi_mtxorb_hack_setup(struct usb_serial *serial)
1656 {
1657 struct usb_host_endpoint *ep = serial->dev->ep_in[1];
1658 struct usb_endpoint_descriptor *ep_desc = &ep->desc;
1659
1660 if (ep->enabled && ep_desc->wMaxPacketSize == 0) {
1661 ep_desc->wMaxPacketSize = cpu_to_le16(0x40);
1662 dev_info(&serial->dev->dev,
1663 "Fixing invalid wMaxPacketSize on read pipe\n");
1664 }
1665
1666 return 0;
1667 }
1668
1669 static void ftdi_sio_priv_release(struct kref *k)
1670 {
1671 struct ftdi_private *priv = container_of(k, struct ftdi_private, kref);
1672
1673 kfree(priv);
1674 }
1675
1676 static int ftdi_sio_port_remove(struct usb_serial_port *port)
1677 {
1678 struct ftdi_private *priv = usb_get_serial_port_data(port);
1679
1680 dbg("%s", __func__);
1681
1682 remove_sysfs_attrs(port);
1683
1684 kref_put(&priv->kref, ftdi_sio_priv_release);
1685
1686 return 0;
1687 }
1688
1689 static int ftdi_open(struct tty_struct *tty, struct usb_serial_port *port)
1690 { /* ftdi_open */
1691 struct usb_device *dev = port->serial->dev;
1692 struct ftdi_private *priv = usb_get_serial_port_data(port);
1693 unsigned long flags;
1694
1695 int result = 0;
1696 char buf[1]; /* Needed for the usb_control_msg I think */
1697
1698 dbg("%s", __func__);
1699
1700 spin_lock_irqsave(&priv->tx_lock, flags);
1701 priv->tx_bytes = 0;
1702 spin_unlock_irqrestore(&priv->tx_lock, flags);
1703 spin_lock_irqsave(&priv->rx_lock, flags);
1704 priv->rx_bytes = 0;
1705 spin_unlock_irqrestore(&priv->rx_lock, flags);
1706
1707 if (tty)
1708 tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
1709
1710 write_latency_timer(port);
1711
1712 /* No error checking for this (will get errors later anyway) */
1713 /* See ftdi_sio.h for description of what is reset */
1714 usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1715 FTDI_SIO_RESET_REQUEST, FTDI_SIO_RESET_REQUEST_TYPE,
1716 FTDI_SIO_RESET_SIO,
1717 priv->interface, buf, 0, WDR_TIMEOUT);
1718
1719 /* Termios defaults are set by usb_serial_init. We don't change
1720 port->tty->termios - this would lose speed settings, etc.
1721 This is same behaviour as serial.c/rs_open() - Kuba */
1722
1723 /* ftdi_set_termios will send usb control messages */
1724 if (tty)
1725 ftdi_set_termios(tty, port, tty->termios);
1726
1727 /* Not throttled */
1728 spin_lock_irqsave(&priv->rx_lock, flags);
1729 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
1730 spin_unlock_irqrestore(&priv->rx_lock, flags);
1731
1732 /* Start reading from the device */
1733 priv->rx_processed = 0;
1734 usb_fill_bulk_urb(port->read_urb, dev,
1735 usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress),
1736 port->read_urb->transfer_buffer,
1737 port->read_urb->transfer_buffer_length,
1738 ftdi_read_bulk_callback, port);
1739 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
1740 if (result)
1741 dev_err(&port->dev,
1742 "%s - failed submitting read urb, error %d\n",
1743 __func__, result);
1744 else
1745 kref_get(&priv->kref);
1746
1747 return result;
1748 } /* ftdi_open */
1749
1750
1751 static void ftdi_dtr_rts(struct usb_serial_port *port, int on)
1752 {
1753 struct ftdi_private *priv = usb_get_serial_port_data(port);
1754 char buf[1];
1755
1756 mutex_lock(&port->serial->disc_mutex);
1757 if (!port->serial->disconnected) {
1758 /* Disable flow control */
1759 if (!on && usb_control_msg(port->serial->dev,
1760 usb_sndctrlpipe(port->serial->dev, 0),
1761 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1762 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1763 0, priv->interface, buf, 0,
1764 WDR_TIMEOUT) < 0) {
1765 dev_err(&port->dev, "error from flowcontrol urb\n");
1766 }
1767 /* drop RTS and DTR */
1768 if (on)
1769 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1770 else
1771 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1772 }
1773 mutex_unlock(&port->serial->disc_mutex);
1774 }
1775
1776 /*
1777 * usbserial:__serial_close only calls ftdi_close if the point is open
1778 *
1779 * This only gets called when it is the last close
1780 *
1781 *
1782 */
1783
1784 static void ftdi_close(struct usb_serial_port *port)
1785 { /* ftdi_close */
1786 struct ftdi_private *priv = usb_get_serial_port_data(port);
1787
1788 dbg("%s", __func__);
1789
1790
1791 /* cancel any scheduled reading */
1792 cancel_delayed_work_sync(&priv->rx_work);
1793
1794 /* shutdown our bulk read */
1795 usb_kill_urb(port->read_urb);
1796 kref_put(&priv->kref, ftdi_sio_priv_release);
1797 } /* ftdi_close */
1798
1799
1800
1801 /* The SIO requires the first byte to have:
1802 * B0 1
1803 * B1 0
1804 * B2..7 length of message excluding byte 0
1805 *
1806 * The new devices do not require this byte
1807 */
1808 static int ftdi_write(struct tty_struct *tty, struct usb_serial_port *port,
1809 const unsigned char *buf, int count)
1810 { /* ftdi_write */
1811 struct ftdi_private *priv = usb_get_serial_port_data(port);
1812 struct urb *urb;
1813 unsigned char *buffer;
1814 int data_offset ; /* will be 1 for the SIO and 0 otherwise */
1815 int status;
1816 int transfer_size;
1817 unsigned long flags;
1818
1819 dbg("%s port %d, %d bytes", __func__, port->number, count);
1820
1821 if (count == 0) {
1822 dbg("write request of 0 bytes");
1823 return 0;
1824 }
1825 spin_lock_irqsave(&priv->tx_lock, flags);
1826 if (priv->tx_outstanding_urbs > URB_UPPER_LIMIT) {
1827 spin_unlock_irqrestore(&priv->tx_lock, flags);
1828 dbg("%s - write limit hit\n", __func__);
1829 return 0;
1830 }
1831 priv->tx_outstanding_urbs++;
1832 spin_unlock_irqrestore(&priv->tx_lock, flags);
1833
1834 data_offset = priv->write_offset;
1835 dbg("data_offset set to %d", data_offset);
1836
1837 /* Determine total transfer size */
1838 transfer_size = count;
1839 if (data_offset > 0) {
1840 /* Original sio needs control bytes too... */
1841 transfer_size += (data_offset *
1842 ((count + (priv->max_packet_size - 1 - data_offset)) /
1843 (priv->max_packet_size - data_offset)));
1844 }
1845
1846 buffer = kmalloc(transfer_size, GFP_ATOMIC);
1847 if (!buffer) {
1848 dev_err(&port->dev,
1849 "%s ran out of kernel memory for urb ...\n", __func__);
1850 count = -ENOMEM;
1851 goto error_no_buffer;
1852 }
1853
1854 urb = usb_alloc_urb(0, GFP_ATOMIC);
1855 if (!urb) {
1856 dev_err(&port->dev, "%s - no more free urbs\n", __func__);
1857 count = -ENOMEM;
1858 goto error_no_urb;
1859 }
1860
1861 /* Copy data */
1862 if (data_offset > 0) {
1863 /* Original sio requires control byte at start of
1864 each packet. */
1865 int user_pktsz = priv->max_packet_size - data_offset;
1866 int todo = count;
1867 unsigned char *first_byte = buffer;
1868 const unsigned char *current_position = buf;
1869
1870 while (todo > 0) {
1871 if (user_pktsz > todo)
1872 user_pktsz = todo;
1873 /* Write the control byte at the front of the packet*/
1874 *first_byte = 1 | ((user_pktsz) << 2);
1875 /* Copy data for packet */
1876 memcpy(first_byte + data_offset,
1877 current_position, user_pktsz);
1878 first_byte += user_pktsz + data_offset;
1879 current_position += user_pktsz;
1880 todo -= user_pktsz;
1881 }
1882 } else {
1883 /* No control byte required. */
1884 /* Copy in the data to send */
1885 memcpy(buffer, buf, count);
1886 }
1887
1888 usb_serial_debug_data(debug, &port->dev, __func__,
1889 transfer_size, buffer);
1890
1891 /* fill the buffer and send it */
1892 usb_fill_bulk_urb(urb, port->serial->dev,
1893 usb_sndbulkpipe(port->serial->dev,
1894 port->bulk_out_endpointAddress),
1895 buffer, transfer_size,
1896 ftdi_write_bulk_callback, port);
1897
1898 status = usb_submit_urb(urb, GFP_ATOMIC);
1899 if (status) {
1900 dev_err(&port->dev,
1901 "%s - failed submitting write urb, error %d\n",
1902 __func__, status);
1903 count = status;
1904 goto error;
1905 } else {
1906 spin_lock_irqsave(&priv->tx_lock, flags);
1907 priv->tx_outstanding_bytes += count;
1908 priv->tx_bytes += count;
1909 spin_unlock_irqrestore(&priv->tx_lock, flags);
1910 }
1911
1912 /* we are done with this urb, so let the host driver
1913 * really free it when it is finished with it */
1914 usb_free_urb(urb);
1915
1916 dbg("%s write returning: %d", __func__, count);
1917 return count;
1918 error:
1919 usb_free_urb(urb);
1920 error_no_urb:
1921 kfree(buffer);
1922 error_no_buffer:
1923 spin_lock_irqsave(&priv->tx_lock, flags);
1924 priv->tx_outstanding_urbs--;
1925 spin_unlock_irqrestore(&priv->tx_lock, flags);
1926 return count;
1927 } /* ftdi_write */
1928
1929
1930 /* This function may get called when the device is closed */
1931
1932 static void ftdi_write_bulk_callback(struct urb *urb)
1933 {
1934 unsigned long flags;
1935 struct usb_serial_port *port = urb->context;
1936 struct ftdi_private *priv;
1937 int data_offset; /* will be 1 for the SIO and 0 otherwise */
1938 unsigned long countback;
1939 int status = urb->status;
1940
1941 /* free up the transfer buffer, as usb_free_urb() does not do this */
1942 kfree(urb->transfer_buffer);
1943
1944 dbg("%s - port %d", __func__, port->number);
1945
1946 priv = usb_get_serial_port_data(port);
1947 if (!priv) {
1948 dbg("%s - bad port private data pointer - exiting", __func__);
1949 return;
1950 }
1951 /* account for transferred data */
1952 countback = urb->actual_length;
1953 data_offset = priv->write_offset;
1954 if (data_offset > 0) {
1955 /* Subtract the control bytes */
1956 countback -= (data_offset * DIV_ROUND_UP(countback, priv->max_packet_size));
1957 }
1958 spin_lock_irqsave(&priv->tx_lock, flags);
1959 --priv->tx_outstanding_urbs;
1960 priv->tx_outstanding_bytes -= countback;
1961 spin_unlock_irqrestore(&priv->tx_lock, flags);
1962
1963 if (status) {
1964 dbg("nonzero write bulk status received: %d", status);
1965 return;
1966 }
1967
1968 usb_serial_port_softint(port);
1969 } /* ftdi_write_bulk_callback */
1970
1971
1972 static int ftdi_write_room(struct tty_struct *tty)
1973 {
1974 struct usb_serial_port *port = tty->driver_data;
1975 struct ftdi_private *priv = usb_get_serial_port_data(port);
1976 int room;
1977 unsigned long flags;
1978
1979 dbg("%s - port %d", __func__, port->number);
1980
1981 spin_lock_irqsave(&priv->tx_lock, flags);
1982 if (priv->tx_outstanding_urbs < URB_UPPER_LIMIT) {
1983 /*
1984 * We really can take anything the user throws at us
1985 * but let's pick a nice big number to tell the tty
1986 * layer that we have lots of free space
1987 */
1988 room = 2048;
1989 } else {
1990 room = 0;
1991 }
1992 spin_unlock_irqrestore(&priv->tx_lock, flags);
1993 return room;
1994 }
1995
1996 static int ftdi_chars_in_buffer(struct tty_struct *tty)
1997 {
1998 struct usb_serial_port *port = tty->driver_data;
1999 struct ftdi_private *priv = usb_get_serial_port_data(port);
2000 int buffered;
2001 unsigned long flags;
2002
2003 dbg("%s - port %d", __func__, port->number);
2004
2005 spin_lock_irqsave(&priv->tx_lock, flags);
2006 buffered = (int)priv->tx_outstanding_bytes;
2007 spin_unlock_irqrestore(&priv->tx_lock, flags);
2008 if (buffered < 0) {
2009 dev_err(&port->dev, "%s outstanding tx bytes is negative!\n",
2010 __func__);
2011 buffered = 0;
2012 }
2013 return buffered;
2014 }
2015
2016 static void ftdi_read_bulk_callback(struct urb *urb)
2017 {
2018 struct usb_serial_port *port = urb->context;
2019 struct tty_struct *tty;
2020 struct ftdi_private *priv;
2021 unsigned long countread;
2022 unsigned long flags;
2023 int status = urb->status;
2024
2025 if (urb->number_of_packets > 0) {
2026 dev_err(&port->dev, "%s transfer_buffer_length %d "
2027 "actual_length %d number of packets %d\n", __func__,
2028 urb->transfer_buffer_length,
2029 urb->actual_length, urb->number_of_packets);
2030 dev_err(&port->dev, "%s transfer_flags %x\n", __func__,
2031 urb->transfer_flags);
2032 }
2033
2034 dbg("%s - port %d", __func__, port->number);
2035
2036 if (port->port.count <= 0)
2037 return;
2038
2039 tty = tty_port_tty_get(&port->port);
2040 if (!tty) {
2041 dbg("%s - bad tty pointer - exiting", __func__);
2042 return;
2043 }
2044
2045 priv = usb_get_serial_port_data(port);
2046 if (!priv) {
2047 dbg("%s - bad port private data pointer - exiting", __func__);
2048 goto out;
2049 }
2050
2051 if (urb != port->read_urb)
2052 dev_err(&port->dev, "%s - Not my urb!\n", __func__);
2053
2054 if (status) {
2055 /* This will happen at close every time so it is a dbg not an
2056 err */
2057 dbg("(this is ok on close) nonzero read bulk status received: %d", status);
2058 goto out;
2059 }
2060
2061 /* count data bytes, but not status bytes */
2062 countread = urb->actual_length;
2063 countread -= 2 * DIV_ROUND_UP(countread, priv->max_packet_size);
2064 spin_lock_irqsave(&priv->rx_lock, flags);
2065 priv->rx_bytes += countread;
2066 spin_unlock_irqrestore(&priv->rx_lock, flags);
2067
2068 ftdi_process_read(&priv->rx_work.work);
2069 out:
2070 tty_kref_put(tty);
2071 } /* ftdi_read_bulk_callback */
2072
2073
2074 static void ftdi_process_read(struct work_struct *work)
2075 { /* ftdi_process_read */
2076 struct ftdi_private *priv =
2077 container_of(work, struct ftdi_private, rx_work.work);
2078 struct usb_serial_port *port = priv->port;
2079 struct urb *urb;
2080 struct tty_struct *tty;
2081 char error_flag;
2082 unsigned char *data;
2083
2084 int i;
2085 int result;
2086 int need_flip;
2087 int packet_offset;
2088 unsigned long flags;
2089
2090 dbg("%s - port %d", __func__, port->number);
2091
2092 if (port->port.count <= 0)
2093 return;
2094
2095 tty = tty_port_tty_get(&port->port);
2096 if (!tty) {
2097 dbg("%s - bad tty pointer - exiting", __func__);
2098 return;
2099 }
2100
2101 priv = usb_get_serial_port_data(port);
2102 if (!priv) {
2103 dbg("%s - bad port private data pointer - exiting", __func__);
2104 goto out;
2105 }
2106
2107 urb = port->read_urb;
2108 if (!urb) {
2109 dbg("%s - bad read_urb pointer - exiting", __func__);
2110 goto out;
2111 }
2112
2113 data = urb->transfer_buffer;
2114
2115 if (priv->rx_processed) {
2116 dbg("%s - already processed: %d bytes, %d remain", __func__,
2117 priv->rx_processed,
2118 urb->actual_length - priv->rx_processed);
2119 } else {
2120 /* The first two bytes of every read packet are status */
2121 if (urb->actual_length > 2)
2122 usb_serial_debug_data(debug, &port->dev, __func__,
2123 urb->actual_length, data);
2124 else
2125 dbg("Status only: %03oo %03oo", data[0], data[1]);
2126 }
2127
2128
2129 /* TO DO -- check for hung up line and handle appropriately: */
2130 /* send hangup */
2131 /* See acm.c - you do a tty_hangup - eg tty_hangup(tty) */
2132 /* if CD is dropped and the line is not CLOCAL then we should hangup */
2133
2134 need_flip = 0;
2135 for (packet_offset = priv->rx_processed;
2136 packet_offset < urb->actual_length; packet_offset += priv->max_packet_size) {
2137 int length;
2138
2139 /* Compare new line status to the old one, signal if different/
2140 N.B. packet may be processed more than once, but differences
2141 are only processed once. */
2142 char new_status = data[packet_offset + 0] &
2143 FTDI_STATUS_B0_MASK;
2144 if (new_status != priv->prev_status) {
2145 priv->diff_status |=
2146 new_status ^ priv->prev_status;
2147 wake_up_interruptible(&priv->delta_msr_wait);
2148 priv->prev_status = new_status;
2149 }
2150
2151 length = min_t(u32, priv->max_packet_size, urb->actual_length-packet_offset)-2;
2152 if (length < 0) {
2153 dev_err(&port->dev, "%s - bad packet length: %d\n",
2154 __func__, length+2);
2155 length = 0;
2156 }
2157
2158 if (priv->rx_flags & THROTTLED) {
2159 dbg("%s - throttled", __func__);
2160 break;
2161 }
2162 if (tty_buffer_request_room(tty, length) < length) {
2163 /* break out & wait for throttling/unthrottling to
2164 happen */
2165 dbg("%s - receive room low", __func__);
2166 break;
2167 }
2168
2169 /* Handle errors and break */
2170 error_flag = TTY_NORMAL;
2171 /* Although the device uses a bitmask and hence can have
2172 multiple errors on a packet - the order here sets the
2173 priority the error is returned to the tty layer */
2174
2175 if (data[packet_offset+1] & FTDI_RS_OE) {
2176 error_flag = TTY_OVERRUN;
2177 dbg("OVERRRUN error");
2178 }
2179 if (data[packet_offset+1] & FTDI_RS_BI) {
2180 error_flag = TTY_BREAK;
2181 dbg("BREAK received");
2182 usb_serial_handle_break(port);
2183 }
2184 if (data[packet_offset+1] & FTDI_RS_PE) {
2185 error_flag = TTY_PARITY;
2186 dbg("PARITY error");
2187 }
2188 if (data[packet_offset+1] & FTDI_RS_FE) {
2189 error_flag = TTY_FRAME;
2190 dbg("FRAMING error");
2191 }
2192 if (length > 0) {
2193 for (i = 2; i < length+2; i++) {
2194 /* Note that the error flag is duplicated for
2195 every character received since we don't know
2196 which character it applied to */
2197 if (!usb_serial_handle_sysrq_char(tty, port,
2198 data[packet_offset + i]))
2199 tty_insert_flip_char(tty,
2200 data[packet_offset + i],
2201 error_flag);
2202 }
2203 need_flip = 1;
2204 }
2205
2206 #ifdef NOT_CORRECT_BUT_KEEPING_IT_FOR_NOW
2207 /* if a parity error is detected you get status packets forever
2208 until a character is sent without a parity error.
2209 This doesn't work well since the application receives a
2210 never ending stream of bad data - even though new data
2211 hasn't been sent. Therefore I (bill) have taken this out.
2212 However - this might make sense for framing errors and so on
2213 so I am leaving the code in for now.
2214 */
2215 else {
2216 if (error_flag != TTY_NORMAL) {
2217 dbg("error_flag is not normal");
2218 /* In this case it is just status - if that is
2219 an error send a bad character */
2220 if (tty->flip.count >= TTY_FLIPBUF_SIZE)
2221 tty_flip_buffer_push(tty);
2222 tty_insert_flip_char(tty, 0xff, error_flag);
2223 need_flip = 1;
2224 }
2225 }
2226 #endif
2227 } /* "for(packet_offset=0..." */
2228
2229 /* Low latency */
2230 if (need_flip)
2231 tty_flip_buffer_push(tty);
2232
2233 if (packet_offset < urb->actual_length) {
2234 /* not completely processed - record progress */
2235 priv->rx_processed = packet_offset;
2236 dbg("%s - incomplete, %d bytes processed, %d remain",
2237 __func__, packet_offset,
2238 urb->actual_length - packet_offset);
2239 /* check if we were throttled while processing */
2240 spin_lock_irqsave(&priv->rx_lock, flags);
2241 if (priv->rx_flags & THROTTLED) {
2242 priv->rx_flags |= ACTUALLY_THROTTLED;
2243 spin_unlock_irqrestore(&priv->rx_lock, flags);
2244 dbg("%s - deferring remainder until unthrottled",
2245 __func__);
2246 goto out;
2247 }
2248 spin_unlock_irqrestore(&priv->rx_lock, flags);
2249 /* if the port is closed stop trying to read */
2250 if (port->port.count > 0)
2251 /* delay processing of remainder */
2252 schedule_delayed_work(&priv->rx_work, 1);
2253 else
2254 dbg("%s - port is closed", __func__);
2255 goto out;
2256 }
2257
2258 /* urb is completely processed */
2259 priv->rx_processed = 0;
2260
2261 /* if the port is closed stop trying to read */
2262 if (port->port.count > 0) {
2263 /* Continue trying to always read */
2264 usb_fill_bulk_urb(port->read_urb, port->serial->dev,
2265 usb_rcvbulkpipe(port->serial->dev,
2266 port->bulk_in_endpointAddress),
2267 port->read_urb->transfer_buffer,
2268 port->read_urb->transfer_buffer_length,
2269 ftdi_read_bulk_callback, port);
2270
2271 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
2272 if (result)
2273 dev_err(&port->dev,
2274 "%s - failed resubmitting read urb, error %d\n",
2275 __func__, result);
2276 }
2277 out:
2278 tty_kref_put(tty);
2279 } /* ftdi_process_read */
2280
2281
2282 static void ftdi_break_ctl(struct tty_struct *tty, int break_state)
2283 {
2284 struct usb_serial_port *port = tty->driver_data;
2285 struct ftdi_private *priv = usb_get_serial_port_data(port);
2286 __u16 urb_value = 0;
2287 char buf[1];
2288
2289 /* break_state = -1 to turn on break, and 0 to turn off break */
2290 /* see drivers/char/tty_io.c to see it used */
2291 /* last_set_data_urb_value NEVER has the break bit set in it */
2292
2293 if (break_state)
2294 urb_value = priv->last_set_data_urb_value | FTDI_SIO_SET_BREAK;
2295 else
2296 urb_value = priv->last_set_data_urb_value;
2297
2298 if (usb_control_msg(port->serial->dev,
2299 usb_sndctrlpipe(port->serial->dev, 0),
2300 FTDI_SIO_SET_DATA_REQUEST,
2301 FTDI_SIO_SET_DATA_REQUEST_TYPE,
2302 urb_value , priv->interface,
2303 buf, 0, WDR_TIMEOUT) < 0) {
2304 dev_err(&port->dev, "%s FAILED to enable/disable break state "
2305 "(state was %d)\n", __func__, break_state);
2306 }
2307
2308 dbg("%s break state is %d - urb is %d", __func__,
2309 break_state, urb_value);
2310
2311 }
2312
2313
2314 /* old_termios contains the original termios settings and tty->termios contains
2315 * the new setting to be used
2316 * WARNING: set_termios calls this with old_termios in kernel space
2317 */
2318
2319 static void ftdi_set_termios(struct tty_struct *tty,
2320 struct usb_serial_port *port, struct ktermios *old_termios)
2321 { /* ftdi_termios */
2322 struct usb_device *dev = port->serial->dev;
2323 struct ftdi_private *priv = usb_get_serial_port_data(port);
2324 struct ktermios *termios = tty->termios;
2325 unsigned int cflag = termios->c_cflag;
2326 __u16 urb_value; /* will hold the new flags */
2327 char buf[1]; /* Perhaps I should dynamically alloc this? */
2328
2329 /* Added for xon/xoff support */
2330 unsigned int iflag = termios->c_iflag;
2331 unsigned char vstop;
2332 unsigned char vstart;
2333
2334 dbg("%s", __func__);
2335
2336 /* Force baud rate if this device requires it, unless it is set to
2337 B0. */
2338 if (priv->force_baud && ((termios->c_cflag & CBAUD) != B0)) {
2339 dbg("%s: forcing baud rate for this device", __func__);
2340 tty_encode_baud_rate(tty, priv->force_baud,
2341 priv->force_baud);
2342 }
2343
2344 /* Force RTS-CTS if this device requires it. */
2345 if (priv->force_rtscts) {
2346 dbg("%s: forcing rtscts for this device", __func__);
2347 termios->c_cflag |= CRTSCTS;
2348 }
2349
2350 cflag = termios->c_cflag;
2351
2352 /* FIXME -For this cut I don't care if the line is really changing or
2353 not - so just do the change regardless - should be able to
2354 compare old_termios and tty->termios */
2355 /* NOTE These routines can get interrupted by
2356 ftdi_sio_read_bulk_callback - need to examine what this means -
2357 don't see any problems yet */
2358
2359 /* Set number of data bits, parity, stop bits */
2360
2361 termios->c_cflag &= ~CMSPAR;
2362
2363 urb_value = 0;
2364 urb_value |= (cflag & CSTOPB ? FTDI_SIO_SET_DATA_STOP_BITS_2 :
2365 FTDI_SIO_SET_DATA_STOP_BITS_1);
2366 urb_value |= (cflag & PARENB ?
2367 (cflag & PARODD ? FTDI_SIO_SET_DATA_PARITY_ODD :
2368 FTDI_SIO_SET_DATA_PARITY_EVEN) :
2369 FTDI_SIO_SET_DATA_PARITY_NONE);
2370 if (cflag & CSIZE) {
2371 switch (cflag & CSIZE) {
2372 case CS5: urb_value |= 5; dbg("Setting CS5"); break;
2373 case CS6: urb_value |= 6; dbg("Setting CS6"); break;
2374 case CS7: urb_value |= 7; dbg("Setting CS7"); break;
2375 case CS8: urb_value |= 8; dbg("Setting CS8"); break;
2376 default:
2377 dev_err(&port->dev, "CSIZE was set but not CS5-CS8\n");
2378 }
2379 }
2380
2381 /* This is needed by the break command since it uses the same command
2382 - but is or'ed with this value */
2383 priv->last_set_data_urb_value = urb_value;
2384
2385 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2386 FTDI_SIO_SET_DATA_REQUEST,
2387 FTDI_SIO_SET_DATA_REQUEST_TYPE,
2388 urb_value , priv->interface,
2389 buf, 0, WDR_SHORT_TIMEOUT) < 0) {
2390 dev_err(&port->dev, "%s FAILED to set "
2391 "databits/stopbits/parity\n", __func__);
2392 }
2393
2394 /* Now do the baudrate */
2395 if ((cflag & CBAUD) == B0) {
2396 /* Disable flow control */
2397 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
2398 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2399 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2400 0, priv->interface,
2401 buf, 0, WDR_TIMEOUT) < 0) {
2402 dev_err(&port->dev,
2403 "%s error from disable flowcontrol urb\n",
2404 __func__);
2405 }
2406 /* Drop RTS and DTR */
2407 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2408 } else {
2409 /* set the baudrate determined before */
2410 if (change_speed(tty, port))
2411 dev_err(&port->dev, "%s urb failed to set baudrate\n",
2412 __func__);
2413 /* Ensure RTS and DTR are raised when baudrate changed from 0 */
2414 if (!old_termios || (old_termios->c_cflag & CBAUD) == B0)
2415 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
2416 }
2417
2418 /* Set flow control */
2419 /* Note device also supports DTR/CD (ugh) and Xon/Xoff in hardware */
2420 if (cflag & CRTSCTS) {
2421 dbg("%s Setting to CRTSCTS flow control", __func__);
2422 if (usb_control_msg(dev,
2423 usb_sndctrlpipe(dev, 0),
2424 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2425 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2426 0 , (FTDI_SIO_RTS_CTS_HS | priv->interface),
2427 buf, 0, WDR_TIMEOUT) < 0) {
2428 dev_err(&port->dev,
2429 "urb failed to set to rts/cts flow control\n");
2430 }
2431
2432 } else {
2433 /*
2434 * Xon/Xoff code
2435 *
2436 * Check the IXOFF status in the iflag component of the
2437 * termios structure. If IXOFF is not set, the pre-xon/xoff
2438 * code is executed.
2439 */
2440 if (iflag & IXOFF) {
2441 dbg("%s request to enable xonxoff iflag=%04x",
2442 __func__, iflag);
2443 /* Try to enable the XON/XOFF on the ftdi_sio
2444 * Set the vstart and vstop -- could have been done up
2445 * above where a lot of other dereferencing is done but
2446 * that would be very inefficient as vstart and vstop
2447 * are not always needed.
2448 */
2449 vstart = termios->c_cc[VSTART];
2450 vstop = termios->c_cc[VSTOP];
2451 urb_value = (vstop << 8) | (vstart);
2452
2453 if (usb_control_msg(dev,
2454 usb_sndctrlpipe(dev, 0),
2455 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2456 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2457 urb_value , (FTDI_SIO_XON_XOFF_HS
2458 | priv->interface),
2459 buf, 0, WDR_TIMEOUT) < 0) {
2460 dev_err(&port->dev, "urb failed to set to "
2461 "xon/xoff flow control\n");
2462 }
2463 } else {
2464 /* else clause to only run if cflag ! CRTSCTS and iflag
2465 * ! XOFF. CHECKME Assuming XON/XOFF handled by tty
2466 * stack - not by device */
2467 dbg("%s Turning off hardware flow control", __func__);
2468 if (usb_control_msg(dev,
2469 usb_sndctrlpipe(dev, 0),
2470 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
2471 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
2472 0, priv->interface,
2473 buf, 0, WDR_TIMEOUT) < 0) {
2474 dev_err(&port->dev,
2475 "urb failed to clear flow control\n");
2476 }
2477 }
2478
2479 }
2480 return;
2481 }
2482
2483 static int ftdi_tiocmget(struct tty_struct *tty, struct file *file)
2484 {
2485 struct usb_serial_port *port = tty->driver_data;
2486 struct ftdi_private *priv = usb_get_serial_port_data(port);
2487 unsigned char buf[2];
2488 int ret;
2489
2490 dbg("%s TIOCMGET", __func__);
2491 switch (priv->chip_type) {
2492 case SIO:
2493 /* Request the status from the device */
2494 ret = usb_control_msg(port->serial->dev,
2495 usb_rcvctrlpipe(port->serial->dev, 0),
2496 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
2497 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
2498 0, 0,
2499 buf, 1, WDR_TIMEOUT);
2500 if (ret < 0)
2501 return ret;
2502 break;
2503 case FT8U232AM:
2504 case FT232BM:
2505 case FT2232C:
2506 case FT232RL:
2507 case FT2232H:
2508 case FT4232H:
2509 /* the 8U232AM returns a two byte value (the sio is a 1 byte
2510 value) - in the same format as the data returned from the in
2511 point */
2512 ret = usb_control_msg(port->serial->dev,
2513 usb_rcvctrlpipe(port->serial->dev, 0),
2514 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
2515 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
2516 0, priv->interface,
2517 buf, 2, WDR_TIMEOUT);
2518 if (ret < 0)
2519 return ret;
2520 break;
2521 default:
2522 return -EFAULT;
2523 }
2524
2525 return (buf[0] & FTDI_SIO_DSR_MASK ? TIOCM_DSR : 0) |
2526 (buf[0] & FTDI_SIO_CTS_MASK ? TIOCM_CTS : 0) |
2527 (buf[0] & FTDI_SIO_RI_MASK ? TIOCM_RI : 0) |
2528 (buf[0] & FTDI_SIO_RLSD_MASK ? TIOCM_CD : 0) |
2529 priv->last_dtr_rts;
2530 }
2531
2532 static int ftdi_tiocmset(struct tty_struct *tty, struct file *file,
2533 unsigned int set, unsigned int clear)
2534 {
2535 struct usb_serial_port *port = tty->driver_data;
2536 dbg("%s TIOCMSET", __func__);
2537 return update_mctrl(port, set, clear);
2538 }
2539
2540
2541 static int ftdi_ioctl(struct tty_struct *tty, struct file *file,
2542 unsigned int cmd, unsigned long arg)
2543 {
2544 struct usb_serial_port *port = tty->driver_data;
2545 struct ftdi_private *priv = usb_get_serial_port_data(port);
2546
2547 dbg("%s cmd 0x%04x", __func__, cmd);
2548
2549 /* Based on code from acm.c and others */
2550 switch (cmd) {
2551
2552 case TIOCGSERIAL: /* gets serial port data */
2553 return get_serial_info(port,
2554 (struct serial_struct __user *) arg);
2555
2556 case TIOCSSERIAL: /* sets serial port data */
2557 return set_serial_info(tty, port,
2558 (struct serial_struct __user *) arg);
2559
2560 /*
2561 * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
2562 * - mask passed in arg for lines of interest
2563 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
2564 * Caller should use TIOCGICOUNT to see which one it was.
2565 *
2566 * This code is borrowed from linux/drivers/char/serial.c
2567 */
2568 case TIOCMIWAIT:
2569 while (priv != NULL) {
2570 interruptible_sleep_on(&priv->delta_msr_wait);
2571 /* see if a signal did it */
2572 if (signal_pending(current))
2573 return -ERESTARTSYS;
2574 else {
2575 char diff = priv->diff_status;
2576
2577 if (diff == 0)
2578 return -EIO; /* no change => error */
2579
2580 /* Consume all events */
2581 priv->diff_status = 0;
2582
2583 /* Return 0 if caller wanted to know about
2584 these bits */
2585 if (((arg & TIOCM_RNG) && (diff & FTDI_RS0_RI)) ||
2586 ((arg & TIOCM_DSR) && (diff & FTDI_RS0_DSR)) ||
2587 ((arg & TIOCM_CD) && (diff & FTDI_RS0_RLSD)) ||
2588 ((arg & TIOCM_CTS) && (diff & FTDI_RS0_CTS))) {
2589 return 0;
2590 }
2591 /*
2592 * Otherwise caller can't care less about what
2593 * happened,and so we continue to wait for more
2594 * events.
2595 */
2596 }
2597 }
2598 return 0;
2599 default:
2600 break;
2601 }
2602 /* This is not necessarily an error - turns out the higher layers
2603 * will do some ioctls themselves (see comment above)
2604 */
2605 dbg("%s arg not supported - it was 0x%04x - check /usr/include/asm/ioctls.h", __func__, cmd);
2606 return -ENOIOCTLCMD;
2607 }
2608
2609 static void ftdi_throttle(struct tty_struct *tty)
2610 {
2611 struct usb_serial_port *port = tty->driver_data;
2612 struct ftdi_private *priv = usb_get_serial_port_data(port);
2613 unsigned long flags;
2614
2615 dbg("%s - port %d", __func__, port->number);
2616
2617 spin_lock_irqsave(&priv->rx_lock, flags);
2618 priv->rx_flags |= THROTTLED;
2619 spin_unlock_irqrestore(&priv->rx_lock, flags);
2620 }
2621
2622
2623 static void ftdi_unthrottle(struct tty_struct *tty)
2624 {
2625 struct usb_serial_port *port = tty->driver_data;
2626 struct ftdi_private *priv = usb_get_serial_port_data(port);
2627 int actually_throttled;
2628 unsigned long flags;
2629
2630 dbg("%s - port %d", __func__, port->number);
2631
2632 spin_lock_irqsave(&priv->rx_lock, flags);
2633 actually_throttled = priv->rx_flags & ACTUALLY_THROTTLED;
2634 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
2635 spin_unlock_irqrestore(&priv->rx_lock, flags);
2636
2637 if (actually_throttled)
2638 schedule_delayed_work(&priv->rx_work, 0);
2639 }
2640
2641 static int __init ftdi_init(void)
2642 {
2643 int retval;
2644
2645 dbg("%s", __func__);
2646 if (vendor > 0 && product > 0) {
2647 /* Add user specified VID/PID to reserved element of table. */
2648 int i;
2649 for (i = 0; id_table_combined[i].idVendor; i++)
2650 ;
2651 id_table_combined[i].match_flags = USB_DEVICE_ID_MATCH_DEVICE;
2652 id_table_combined[i].idVendor = vendor;
2653 id_table_combined[i].idProduct = product;
2654 }
2655 retval = usb_serial_register(&ftdi_sio_device);
2656 if (retval)
2657 goto failed_sio_register;
2658 retval = usb_register(&ftdi_driver);
2659 if (retval)
2660 goto failed_usb_register;
2661
2662 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
2663 DRIVER_DESC "\n");
2664 return 0;
2665 failed_usb_register:
2666 usb_serial_deregister(&ftdi_sio_device);
2667 failed_sio_register:
2668 return retval;
2669 }
2670
2671
2672 static void __exit ftdi_exit(void)
2673 {
2674
2675 dbg("%s", __func__);
2676
2677 usb_deregister(&ftdi_driver);
2678 usb_serial_deregister(&ftdi_sio_device);
2679
2680 }
2681
2682
2683 module_init(ftdi_init);
2684 module_exit(ftdi_exit);
2685
2686 MODULE_AUTHOR(DRIVER_AUTHOR);
2687 MODULE_DESCRIPTION(DRIVER_DESC);
2688 MODULE_LICENSE("GPL");
2689
2690 module_param(debug, bool, S_IRUGO | S_IWUSR);
2691 MODULE_PARM_DESC(debug, "Debug enabled or not");
2692 module_param(vendor, ushort, 0);
2693 MODULE_PARM_DESC(vendor, "User specified vendor ID (default="
2694 __MODULE_STRING(FTDI_VID)")");
2695 module_param(product, ushort, 0);
2696 MODULE_PARM_DESC(product, "User specified product ID");
2697
2698 module_param(ndi_latency_timer, int, S_IRUGO | S_IWUSR);
2699 MODULE_PARM_DESC(ndi_latency_timer, "NDI device latency timer override");
Linux with added FPC-III support