USB: pl2303: another product ID
[linux-2.6/s3c2410-cpufreq.git] / drivers / usb / serial / ftdi_sio.c
blob3abb3c863647832a31937fb3363f415f4a344ed9
1 /*
2 * USB FTDI SIO driver
4 * Copyright (C) 1999 - 2001
5 * Greg Kroah-Hartman (greg@kroah.com)
6 * Bill Ryder (bryder@sgi.com)
7 * Copyright (C) 2002
8 * Kuba Ober (kuba@mareimbrium.org)
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * See Documentation/usb/usb-serial.txt for more information on using this driver
17 * See http://ftdi-usb-sio.sourceforge.net for upto date testing info
18 * and extra documentation
20 * Change entries from 2004 and earlier can be found in versions of this
21 * file in kernel versions prior to the 2.6.24 release.
25 /* Bill Ryder - bryder@sgi.com - wrote the FTDI_SIO implementation */
26 /* Thanx to FTDI for so kindly providing details of the protocol required */
27 /* to talk to the device */
28 /* Thanx to gkh and the rest of the usb dev group for all code I have assimilated :-) */
30 #include <linux/kernel.h>
31 #include <linux/errno.h>
32 #include <linux/init.h>
33 #include <linux/slab.h>
34 #include <linux/tty.h>
35 #include <linux/tty_driver.h>
36 #include <linux/tty_flip.h>
37 #include <linux/module.h>
38 #include <linux/spinlock.h>
39 #include <asm/uaccess.h>
40 #include <linux/usb.h>
41 #include <linux/serial.h>
42 #include <linux/usb/serial.h>
43 #include "ftdi_sio.h"
46 * Version Information
48 #define DRIVER_VERSION "v1.4.3"
49 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>, Bill Ryder <bryder@sgi.com>, Kuba Ober <kuba@mareimbrium.org>"
50 #define DRIVER_DESC "USB FTDI Serial Converters Driver"
52 static int debug;
53 static __u16 vendor = FTDI_VID;
54 static __u16 product;
56 struct ftdi_private {
57 ftdi_chip_type_t chip_type;
58 /* type of the device, either SIO or FT8U232AM */
59 int baud_base; /* baud base clock for divisor setting */
60 int custom_divisor; /* custom_divisor kludge, this is for baud_base (different from what goes to the chip!) */
61 __u16 last_set_data_urb_value ;
62 /* the last data state set - needed for doing a break */
63 int write_offset; /* This is the offset in the usb data block to write the serial data -
64 * it is different between devices
66 int flags; /* some ASYNC_xxxx flags are supported */
67 unsigned long last_dtr_rts; /* saved modem control outputs */
68 wait_queue_head_t delta_msr_wait; /* Used for TIOCMIWAIT */
69 char prev_status, diff_status; /* Used for TIOCMIWAIT */
70 __u8 rx_flags; /* receive state flags (throttling) */
71 spinlock_t rx_lock; /* spinlock for receive state */
72 struct delayed_work rx_work;
73 struct usb_serial_port *port;
74 int rx_processed;
75 unsigned long rx_bytes;
77 __u16 interface; /* FT2232C port interface (0 for FT232/245) */
79 speed_t force_baud; /* if non-zero, force the baud rate to this value */
80 int force_rtscts; /* if non-zero, force RTS-CTS to always be enabled */
82 spinlock_t tx_lock; /* spinlock for transmit state */
83 unsigned long tx_bytes;
84 unsigned long tx_outstanding_bytes;
85 unsigned long tx_outstanding_urbs;
88 /* struct ftdi_sio_quirk is used by devices requiring special attention. */
89 struct ftdi_sio_quirk {
90 int (*probe)(struct usb_serial *);
91 void (*port_probe)(struct ftdi_private *); /* Special settings for probed ports. */
94 static int ftdi_jtag_probe (struct usb_serial *serial);
95 static int ftdi_mtxorb_hack_setup (struct usb_serial *serial);
96 static void ftdi_USB_UIRT_setup (struct ftdi_private *priv);
97 static void ftdi_HE_TIRA1_setup (struct ftdi_private *priv);
99 static struct ftdi_sio_quirk ftdi_jtag_quirk = {
100 .probe = ftdi_jtag_probe,
103 static struct ftdi_sio_quirk ftdi_mtxorb_hack_quirk = {
104 .probe = ftdi_mtxorb_hack_setup,
107 static struct ftdi_sio_quirk ftdi_USB_UIRT_quirk = {
108 .port_probe = ftdi_USB_UIRT_setup,
111 static struct ftdi_sio_quirk ftdi_HE_TIRA1_quirk = {
112 .port_probe = ftdi_HE_TIRA1_setup,
116 * The 8U232AM has the same API as the sio except for:
117 * - it can support MUCH higher baudrates; up to:
118 * o 921600 for RS232 and 2000000 for RS422/485 at 48MHz
119 * o 230400 at 12MHz
120 * so .. 8U232AM's baudrate setting codes are different
121 * - it has a two byte status code.
122 * - it returns characters every 16ms (the FTDI does it every 40ms)
124 * the bcdDevice value is used to differentiate FT232BM and FT245BM from
125 * the earlier FT8U232AM and FT8U232BM. For now, include all known VID/PID
126 * combinations in both tables.
127 * FIXME: perhaps bcdDevice can also identify 12MHz FT8U232AM devices,
128 * but I don't know if those ever went into mass production. [Ian Abbott]
133 static struct usb_device_id id_table_combined [] = {
134 { USB_DEVICE(FTDI_VID, FTDI_AMC232_PID) },
135 { USB_DEVICE(FTDI_VID, FTDI_CANUSB_PID) },
136 { USB_DEVICE(FTDI_VID, FTDI_ACTZWAVE_PID) },
137 { USB_DEVICE(FTDI_VID, FTDI_IRTRANS_PID) },
138 { USB_DEVICE(FTDI_VID, FTDI_IPLUS_PID) },
139 { USB_DEVICE(FTDI_VID, FTDI_IPLUS2_PID) },
140 { USB_DEVICE(FTDI_VID, FTDI_DMX4ALL) },
141 { USB_DEVICE(FTDI_VID, FTDI_SIO_PID) },
142 { USB_DEVICE(FTDI_VID, FTDI_8U232AM_PID) },
143 { USB_DEVICE(FTDI_VID, FTDI_8U232AM_ALT_PID) },
144 { USB_DEVICE(FTDI_VID, FTDI_232RL_PID) },
145 { USB_DEVICE(FTDI_VID, FTDI_8U2232C_PID) },
146 { USB_DEVICE(FTDI_VID, FTDI_MICRO_CHAMELEON_PID) },
147 { USB_DEVICE(FTDI_VID, FTDI_RELAIS_PID) },
148 { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_PID) },
149 { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_IOBOARD_PID) },
150 { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_MINI_IOBOARD_PID) },
151 { USB_DEVICE(FTDI_VID, FTDI_XF_632_PID) },
152 { USB_DEVICE(FTDI_VID, FTDI_XF_634_PID) },
153 { USB_DEVICE(FTDI_VID, FTDI_XF_547_PID) },
154 { USB_DEVICE(FTDI_VID, FTDI_XF_633_PID) },
155 { USB_DEVICE(FTDI_VID, FTDI_XF_631_PID) },
156 { USB_DEVICE(FTDI_VID, FTDI_XF_635_PID) },
157 { USB_DEVICE(FTDI_VID, FTDI_XF_640_PID) },
158 { USB_DEVICE(FTDI_VID, FTDI_XF_642_PID) },
159 { USB_DEVICE(FTDI_VID, FTDI_DSS20_PID) },
160 { USB_DEVICE(FTDI_NF_RIC_VID, FTDI_NF_RIC_PID) },
161 { USB_DEVICE(FTDI_VID, FTDI_VNHCPCUSB_D_PID) },
162 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_0_PID) },
163 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_1_PID) },
164 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_2_PID) },
165 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_3_PID) },
166 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_4_PID) },
167 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_5_PID) },
168 { USB_DEVICE(FTDI_VID, FTDI_MTXORB_6_PID) },
169 { USB_DEVICE(MTXORB_VK_VID, MTXORB_VK_PID),
170 .driver_info = (kernel_ulong_t)&ftdi_mtxorb_hack_quirk },
171 { USB_DEVICE(FTDI_VID, FTDI_PERLE_ULTRAPORT_PID) },
172 { USB_DEVICE(FTDI_VID, FTDI_PIEGROUP_PID) },
173 { USB_DEVICE(FTDI_VID, FTDI_TNC_X_PID) },
174 { USB_DEVICE(FTDI_VID, FTDI_USBX_707_PID) },
175 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2101_PID) },
176 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2102_PID) },
177 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2103_PID) },
178 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2104_PID) },
179 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2106_PID) },
180 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_1_PID) },
181 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_2_PID) },
182 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_1_PID) },
183 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_2_PID) },
184 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_1_PID) },
185 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_2_PID) },
186 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_1_PID) },
187 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_2_PID) },
188 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_3_PID) },
189 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_4_PID) },
190 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_1_PID) },
191 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_2_PID) },
192 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_3_PID) },
193 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_4_PID) },
194 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_1_PID) },
195 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_2_PID) },
196 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_3_PID) },
197 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_4_PID) },
198 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_1_PID) },
199 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_2_PID) },
200 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_3_PID) },
201 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_4_PID) },
202 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_5_PID) },
203 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_6_PID) },
204 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_7_PID) },
205 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_8_PID) },
206 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_1_PID) },
207 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_2_PID) },
208 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_3_PID) },
209 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_4_PID) },
210 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_5_PID) },
211 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_6_PID) },
212 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_7_PID) },
213 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_8_PID) },
214 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_1_PID) },
215 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_2_PID) },
216 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_3_PID) },
217 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_4_PID) },
218 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_5_PID) },
219 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_6_PID) },
220 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_7_PID) },
221 { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_8_PID) },
222 { USB_DEVICE(IDTECH_VID, IDTECH_IDT1221U_PID) },
223 { USB_DEVICE(OCT_VID, OCT_US101_PID) },
224 { USB_DEVICE(FTDI_VID, FTDI_HE_TIRA1_PID),
225 .driver_info = (kernel_ulong_t)&ftdi_HE_TIRA1_quirk },
226 { USB_DEVICE(FTDI_VID, FTDI_USB_UIRT_PID),
227 .driver_info = (kernel_ulong_t)&ftdi_USB_UIRT_quirk },
228 { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_1) },
229 { USB_DEVICE(FTDI_VID, PROTEGO_R2X0) },
230 { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_3) },
231 { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_4) },
232 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E808_PID) },
233 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E809_PID) },
234 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80A_PID) },
235 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80B_PID) },
236 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80C_PID) },
237 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80D_PID) },
238 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80E_PID) },
239 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80F_PID) },
240 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E888_PID) },
241 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E889_PID) },
242 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88A_PID) },
243 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88B_PID) },
244 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88C_PID) },
245 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88D_PID) },
246 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88E_PID) },
247 { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88F_PID) },
248 { USB_DEVICE(FTDI_VID, FTDI_ELV_UO100_PID) },
249 { USB_DEVICE(FTDI_VID, FTDI_ELV_UM100_PID) },
250 { USB_DEVICE(FTDI_VID, FTDI_ELV_UR100_PID) },
251 { USB_DEVICE(FTDI_VID, FTDI_ELV_ALC8500_PID) },
252 { USB_DEVICE(FTDI_VID, FTDI_PYRAMID_PID) },
253 { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1000PC_PID) },
254 { USB_DEVICE(FTDI_VID, FTDI_IBS_US485_PID) },
255 { USB_DEVICE(FTDI_VID, FTDI_IBS_PICPRO_PID) },
256 { USB_DEVICE(FTDI_VID, FTDI_IBS_PCMCIA_PID) },
257 { USB_DEVICE(FTDI_VID, FTDI_IBS_PK1_PID) },
258 { USB_DEVICE(FTDI_VID, FTDI_IBS_RS232MON_PID) },
259 { USB_DEVICE(FTDI_VID, FTDI_IBS_APP70_PID) },
260 { USB_DEVICE(FTDI_VID, FTDI_IBS_PEDO_PID) },
261 { USB_DEVICE(FTDI_VID, FTDI_IBS_PROD_PID) },
263 * Due to many user requests for multiple ELV devices we enable
264 * them by default.
266 { USB_DEVICE(FTDI_VID, FTDI_ELV_CLI7000_PID) },
267 { USB_DEVICE(FTDI_VID, FTDI_ELV_PPS7330_PID) },
268 { USB_DEVICE(FTDI_VID, FTDI_ELV_TFM100_PID) },
269 { USB_DEVICE(FTDI_VID, FTDI_ELV_UDF77_PID) },
270 { USB_DEVICE(FTDI_VID, FTDI_ELV_UIO88_PID) },
271 { USB_DEVICE(FTDI_VID, FTDI_ELV_UAD8_PID) },
272 { USB_DEVICE(FTDI_VID, FTDI_ELV_UDA7_PID) },
273 { USB_DEVICE(FTDI_VID, FTDI_ELV_USI2_PID) },
274 { USB_DEVICE(FTDI_VID, FTDI_ELV_T1100_PID) },
275 { USB_DEVICE(FTDI_VID, FTDI_ELV_PCD200_PID) },
276 { USB_DEVICE(FTDI_VID, FTDI_ELV_ULA200_PID) },
277 { USB_DEVICE(FTDI_VID, FTDI_ELV_CSI8_PID) },
278 { USB_DEVICE(FTDI_VID, FTDI_ELV_EM1000DL_PID) },
279 { USB_DEVICE(FTDI_VID, FTDI_ELV_PCK100_PID) },
280 { USB_DEVICE(FTDI_VID, FTDI_ELV_RFP500_PID) },
281 { USB_DEVICE(FTDI_VID, FTDI_ELV_FS20SIG_PID) },
282 { USB_DEVICE(FTDI_VID, FTDI_ELV_WS300PC_PID) },
283 { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1300PC_PID) },
284 { USB_DEVICE(FTDI_VID, FTDI_ELV_EM1010PC_PID) },
285 { USB_DEVICE(FTDI_VID, FTDI_ELV_WS500_PID) },
286 { USB_DEVICE(FTDI_VID, LINX_SDMUSBQSS_PID) },
287 { USB_DEVICE(FTDI_VID, LINX_MASTERDEVEL2_PID) },
288 { USB_DEVICE(FTDI_VID, LINX_FUTURE_0_PID) },
289 { USB_DEVICE(FTDI_VID, LINX_FUTURE_1_PID) },
290 { USB_DEVICE(FTDI_VID, LINX_FUTURE_2_PID) },
291 { USB_DEVICE(FTDI_VID, FTDI_CCSICDU20_0_PID) },
292 { USB_DEVICE(FTDI_VID, FTDI_CCSICDU40_1_PID) },
293 { USB_DEVICE(FTDI_VID, FTDI_CCSMACHX_2_PID) },
294 { USB_DEVICE(FTDI_VID, INSIDE_ACCESSO) },
295 { USB_DEVICE(INTREPID_VID, INTREPID_VALUECAN_PID) },
296 { USB_DEVICE(INTREPID_VID, INTREPID_NEOVI_PID) },
297 { USB_DEVICE(FALCOM_VID, FALCOM_TWIST_PID) },
298 { USB_DEVICE(FALCOM_VID, FALCOM_SAMBA_PID) },
299 { USB_DEVICE(FTDI_VID, FTDI_SUUNTO_SPORTS_PID) },
300 { USB_DEVICE(TTI_VID, TTI_QL355P_PID) },
301 { USB_DEVICE(FTDI_VID, FTDI_RM_CANVIEW_PID) },
302 { USB_DEVICE(BANDB_VID, BANDB_USOTL4_PID) },
303 { USB_DEVICE(BANDB_VID, BANDB_USTL4_PID) },
304 { USB_DEVICE(BANDB_VID, BANDB_USO9ML2_PID) },
305 { USB_DEVICE(FTDI_VID, EVER_ECO_PRO_CDS) },
306 { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_1_PID) },
307 { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_2_PID) },
308 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_0_PID) },
309 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_1_PID) },
310 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_2_PID) },
311 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_3_PID) },
312 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_4_PID) },
313 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_5_PID) },
314 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_6_PID) },
315 { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_7_PID) },
316 { USB_DEVICE(MOBILITY_VID, MOBILITY_USB_SERIAL_PID) },
317 { USB_DEVICE(FTDI_VID, FTDI_ACTIVE_ROBOTS_PID) },
318 { USB_DEVICE(FTDI_VID, FTDI_MHAM_KW_PID) },
319 { USB_DEVICE(FTDI_VID, FTDI_MHAM_YS_PID) },
320 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y6_PID) },
321 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y8_PID) },
322 { USB_DEVICE(FTDI_VID, FTDI_MHAM_IC_PID) },
323 { USB_DEVICE(FTDI_VID, FTDI_MHAM_DB9_PID) },
324 { USB_DEVICE(FTDI_VID, FTDI_MHAM_RS232_PID) },
325 { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y9_PID) },
326 { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_VCP_PID) },
327 { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_D2XX_PID) },
328 { USB_DEVICE(EVOLUTION_VID, EVOLUTION_ER1_PID) },
329 { USB_DEVICE(EVOLUTION_VID, EVO_HYBRID_PID) },
330 { USB_DEVICE(EVOLUTION_VID, EVO_RCM4_PID) },
331 { USB_DEVICE(FTDI_VID, FTDI_ARTEMIS_PID) },
332 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16_PID) },
333 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16C_PID) },
334 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HR_PID) },
335 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HRC_PID) },
336 { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16IC_PID) },
337 { USB_DEVICE(KOBIL_VID, KOBIL_CONV_B1_PID) },
338 { USB_DEVICE(KOBIL_VID, KOBIL_CONV_KAAN_PID) },
339 { USB_DEVICE(POSIFLEX_VID, POSIFLEX_PP7000_PID) },
340 { USB_DEVICE(FTDI_VID, FTDI_TTUSB_PID) },
341 { USB_DEVICE(FTDI_VID, FTDI_ECLO_COM_1WIRE_PID) },
342 { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_777_PID) },
343 { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_8900F_PID) },
344 { USB_DEVICE(FTDI_VID, FTDI_PCDJ_DAC2_PID) },
345 { USB_DEVICE(FTDI_VID, FTDI_RRCIRKITS_LOCOBUFFER_PID) },
346 { USB_DEVICE(FTDI_VID, FTDI_ASK_RDR400_PID) },
347 { USB_DEVICE(ICOM_ID1_VID, ICOM_ID1_PID) },
348 { USB_DEVICE(PAPOUCH_VID, PAPOUCH_TMU_PID) },
349 { USB_DEVICE(FTDI_VID, FTDI_ACG_HFDUAL_PID) },
350 { USB_DEVICE(FTDI_VID, FTDI_YEI_SERVOCENTER31_PID) },
351 { USB_DEVICE(FTDI_VID, FTDI_THORLABS_PID) },
352 { USB_DEVICE(TESTO_VID, TESTO_USB_INTERFACE_PID) },
353 { USB_DEVICE(FTDI_VID, FTDI_GAMMA_SCOUT_PID) },
354 { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13M_PID) },
355 { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13S_PID) },
356 { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13U_PID) },
357 { USB_DEVICE(ELEKTOR_VID, ELEKTOR_FT323R_PID) },
358 { USB_DEVICE(TELLDUS_VID, TELLDUS_TELLSTICK_PID) },
359 { USB_DEVICE(FTDI_VID, FTDI_MAXSTREAM_PID) },
360 { USB_DEVICE(TML_VID, TML_USB_SERIAL_PID) },
361 { USB_DEVICE(FTDI_VID, FTDI_ELSTER_UNICOM_PID) },
362 { USB_DEVICE(FTDI_VID, FTDI_PROPOX_JTAGCABLEII_PID) },
363 { USB_DEVICE(OLIMEX_VID, OLIMEX_ARM_USB_OCD_PID),
364 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
365 { USB_DEVICE(FIC_VID, FIC_NEO1973_DEBUG_PID),
366 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
367 { USB_DEVICE(FTDI_VID, FTDI_OOCDLINK_PID),
368 .driver_info = (kernel_ulong_t)&ftdi_jtag_quirk },
369 { }, /* Optional parameter entry */
370 { } /* Terminating entry */
373 MODULE_DEVICE_TABLE (usb, id_table_combined);
375 static struct usb_driver ftdi_driver = {
376 .name = "ftdi_sio",
377 .probe = usb_serial_probe,
378 .disconnect = usb_serial_disconnect,
379 .id_table = id_table_combined,
380 .no_dynamic_id = 1,
383 static const char *ftdi_chip_name[] = {
384 [SIO] = "SIO", /* the serial part of FT8U100AX */
385 [FT8U232AM] = "FT8U232AM",
386 [FT232BM] = "FT232BM",
387 [FT2232C] = "FT2232C",
388 [FT232RL] = "FT232RL",
392 /* Constants for read urb and write urb */
393 #define BUFSZ 512
394 #define PKTSZ 64
396 /* rx_flags */
397 #define THROTTLED 0x01
398 #define ACTUALLY_THROTTLED 0x02
400 /* Used for TIOCMIWAIT */
401 #define FTDI_STATUS_B0_MASK (FTDI_RS0_CTS | FTDI_RS0_DSR | FTDI_RS0_RI | FTDI_RS0_RLSD)
402 #define FTDI_STATUS_B1_MASK (FTDI_RS_BI)
403 /* End TIOCMIWAIT */
405 #define FTDI_IMPL_ASYNC_FLAGS = (ASYNC_SPD_HI | ASYNC_SPD_VHI \
406 | ASYNC_SPD_CUST | ASYNC_SPD_SHI | ASYNC_SPD_WARP)
408 /* function prototypes for a FTDI serial converter */
409 static int ftdi_sio_probe (struct usb_serial *serial, const struct usb_device_id *id);
410 static void ftdi_shutdown (struct usb_serial *serial);
411 static int ftdi_sio_port_probe (struct usb_serial_port *port);
412 static int ftdi_sio_port_remove (struct usb_serial_port *port);
413 static int ftdi_open (struct usb_serial_port *port, struct file *filp);
414 static void ftdi_close (struct usb_serial_port *port, struct file *filp);
415 static int ftdi_write (struct usb_serial_port *port, const unsigned char *buf, int count);
416 static int ftdi_write_room (struct usb_serial_port *port);
417 static int ftdi_chars_in_buffer (struct usb_serial_port *port);
418 static void ftdi_write_bulk_callback (struct urb *urb);
419 static void ftdi_read_bulk_callback (struct urb *urb);
420 static void ftdi_process_read (struct work_struct *work);
421 static void ftdi_set_termios (struct usb_serial_port *port, struct ktermios * old);
422 static int ftdi_tiocmget (struct usb_serial_port *port, struct file *file);
423 static int ftdi_tiocmset (struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear);
424 static int ftdi_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg);
425 static void ftdi_break_ctl (struct usb_serial_port *port, int break_state );
426 static void ftdi_throttle (struct usb_serial_port *port);
427 static void ftdi_unthrottle (struct usb_serial_port *port);
429 static unsigned short int ftdi_232am_baud_base_to_divisor (int baud, int base);
430 static unsigned short int ftdi_232am_baud_to_divisor (int baud);
431 static __u32 ftdi_232bm_baud_base_to_divisor (int baud, int base);
432 static __u32 ftdi_232bm_baud_to_divisor (int baud);
434 static struct usb_serial_driver ftdi_sio_device = {
435 .driver = {
436 .owner = THIS_MODULE,
437 .name = "ftdi_sio",
439 .description = "FTDI USB Serial Device",
440 .usb_driver = &ftdi_driver ,
441 .id_table = id_table_combined,
442 .num_interrupt_in = 0,
443 .num_bulk_in = 1,
444 .num_bulk_out = 1,
445 .num_ports = 1,
446 .probe = ftdi_sio_probe,
447 .port_probe = ftdi_sio_port_probe,
448 .port_remove = ftdi_sio_port_remove,
449 .open = ftdi_open,
450 .close = ftdi_close,
451 .throttle = ftdi_throttle,
452 .unthrottle = ftdi_unthrottle,
453 .write = ftdi_write,
454 .write_room = ftdi_write_room,
455 .chars_in_buffer = ftdi_chars_in_buffer,
456 .read_bulk_callback = ftdi_read_bulk_callback,
457 .write_bulk_callback = ftdi_write_bulk_callback,
458 .tiocmget = ftdi_tiocmget,
459 .tiocmset = ftdi_tiocmset,
460 .ioctl = ftdi_ioctl,
461 .set_termios = ftdi_set_termios,
462 .break_ctl = ftdi_break_ctl,
463 .shutdown = ftdi_shutdown,
467 #define WDR_TIMEOUT 5000 /* default urb timeout */
468 #define WDR_SHORT_TIMEOUT 1000 /* shorter urb timeout */
470 /* High and low are for DTR, RTS etc etc */
471 #define HIGH 1
472 #define LOW 0
474 /* number of outstanding urbs to prevent userspace DoS from happening */
475 #define URB_UPPER_LIMIT 42
478 * ***************************************************************************
479 * Utility functions
480 * ***************************************************************************
483 static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base)
485 unsigned short int divisor;
486 int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
487 if ((divisor3 & 0x7) == 7) divisor3 ++; // round x.7/8 up to x+1
488 divisor = divisor3 >> 3;
489 divisor3 &= 0x7;
490 if (divisor3 == 1) divisor |= 0xc000; else // 0.125
491 if (divisor3 >= 4) divisor |= 0x4000; else // 0.5
492 if (divisor3 != 0) divisor |= 0x8000; // 0.25
493 if (divisor == 1) divisor = 0; /* special case for maximum baud rate */
494 return divisor;
497 static unsigned short int ftdi_232am_baud_to_divisor(int baud)
499 return(ftdi_232am_baud_base_to_divisor(baud, 48000000));
502 static __u32 ftdi_232bm_baud_base_to_divisor(int baud, int base)
504 static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
505 __u32 divisor;
506 int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
507 divisor = divisor3 >> 3;
508 divisor |= (__u32)divfrac[divisor3 & 0x7] << 14;
509 /* Deal with special cases for highest baud rates. */
510 if (divisor == 1) divisor = 0; else // 1.0
511 if (divisor == 0x4001) divisor = 1; // 1.5
512 return divisor;
515 static __u32 ftdi_232bm_baud_to_divisor(int baud)
517 return(ftdi_232bm_baud_base_to_divisor(baud, 48000000));
520 #define set_mctrl(port, set) update_mctrl((port), (set), 0)
521 #define clear_mctrl(port, clear) update_mctrl((port), 0, (clear))
523 static int update_mctrl(struct usb_serial_port *port, unsigned int set, unsigned int clear)
525 struct ftdi_private *priv = usb_get_serial_port_data(port);
526 char *buf;
527 unsigned urb_value;
528 int rv;
530 if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
531 dbg("%s - DTR|RTS not being set|cleared", __FUNCTION__);
532 return 0; /* no change */
535 buf = kmalloc(1, GFP_NOIO);
536 if (!buf) {
537 return -ENOMEM;
540 clear &= ~set; /* 'set' takes precedence over 'clear' */
541 urb_value = 0;
542 if (clear & TIOCM_DTR)
543 urb_value |= FTDI_SIO_SET_DTR_LOW;
544 if (clear & TIOCM_RTS)
545 urb_value |= FTDI_SIO_SET_RTS_LOW;
546 if (set & TIOCM_DTR)
547 urb_value |= FTDI_SIO_SET_DTR_HIGH;
548 if (set & TIOCM_RTS)
549 urb_value |= FTDI_SIO_SET_RTS_HIGH;
550 rv = usb_control_msg(port->serial->dev,
551 usb_sndctrlpipe(port->serial->dev, 0),
552 FTDI_SIO_SET_MODEM_CTRL_REQUEST,
553 FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE,
554 urb_value, priv->interface,
555 buf, 0, WDR_TIMEOUT);
557 kfree(buf);
558 if (rv < 0) {
559 err("%s Error from MODEM_CTRL urb: DTR %s, RTS %s",
560 __FUNCTION__,
561 (set & TIOCM_DTR) ? "HIGH" :
562 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
563 (set & TIOCM_RTS) ? "HIGH" :
564 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
565 } else {
566 dbg("%s - DTR %s, RTS %s", __FUNCTION__,
567 (set & TIOCM_DTR) ? "HIGH" :
568 (clear & TIOCM_DTR) ? "LOW" : "unchanged",
569 (set & TIOCM_RTS) ? "HIGH" :
570 (clear & TIOCM_RTS) ? "LOW" : "unchanged");
571 priv->last_dtr_rts = (priv->last_dtr_rts & ~clear) | set;
573 return rv;
577 static __u32 get_ftdi_divisor(struct usb_serial_port * port);
580 static int change_speed(struct usb_serial_port *port)
582 struct ftdi_private *priv = usb_get_serial_port_data(port);
583 char *buf;
584 __u16 urb_value;
585 __u16 urb_index;
586 __u32 urb_index_value;
587 int rv;
589 buf = kmalloc(1, GFP_NOIO);
590 if (!buf)
591 return -ENOMEM;
593 urb_index_value = get_ftdi_divisor(port);
594 urb_value = (__u16)urb_index_value;
595 urb_index = (__u16)(urb_index_value >> 16);
596 if (priv->interface) { /* FT2232C */
597 urb_index = (__u16)((urb_index << 8) | priv->interface);
600 rv = usb_control_msg(port->serial->dev,
601 usb_sndctrlpipe(port->serial->dev, 0),
602 FTDI_SIO_SET_BAUDRATE_REQUEST,
603 FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE,
604 urb_value, urb_index,
605 buf, 0, WDR_SHORT_TIMEOUT);
607 kfree(buf);
608 return rv;
612 static __u32 get_ftdi_divisor(struct usb_serial_port * port)
613 { /* get_ftdi_divisor */
614 struct ftdi_private *priv = usb_get_serial_port_data(port);
615 __u32 div_value = 0;
616 int div_okay = 1;
617 int baud;
620 * The logic involved in setting the baudrate can be cleanly split in 3 steps.
621 * Obtaining the actual baud rate is a little tricky since unix traditionally
622 * somehow ignored the possibility to set non-standard baud rates.
623 * 1. Standard baud rates are set in tty->termios->c_cflag
624 * 2. If these are not enough, you can set any speed using alt_speed as follows:
625 * - set tty->termios->c_cflag speed to B38400
626 * - set your real speed in tty->alt_speed; it gets ignored when
627 * alt_speed==0, (or)
628 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
629 * flags & ASYNC_SPD_MASK == ASYNC_SPD_[HI, VHI, SHI, WARP], this just
630 * sets alt_speed to (HI: 57600, VHI: 115200, SHI: 230400, WARP: 460800)
631 * ** Steps 1, 2 are done courtesy of tty_get_baud_rate
632 * 3. You can also set baud rate by setting custom divisor as follows
633 * - set tty->termios->c_cflag speed to B38400
634 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
635 * o flags & ASYNC_SPD_MASK == ASYNC_SPD_CUST
636 * o custom_divisor set to baud_base / your_new_baudrate
637 * ** Step 3 is done courtesy of code borrowed from serial.c - I should really
638 * spend some time and separate+move this common code to serial.c, it is
639 * replicated in nearly every serial driver you see.
642 /* 1. Get the baud rate from the tty settings, this observes alt_speed hack */
644 baud = tty_get_baud_rate(port->tty);
645 dbg("%s - tty_get_baud_rate reports speed %d", __FUNCTION__, baud);
647 /* 2. Observe async-compatible custom_divisor hack, update baudrate if needed */
649 if (baud == 38400 &&
650 ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
651 (priv->custom_divisor)) {
652 baud = priv->baud_base / priv->custom_divisor;
653 dbg("%s - custom divisor %d sets baud rate to %d", __FUNCTION__, priv->custom_divisor, baud);
656 /* 3. Convert baudrate to device-specific divisor */
658 if (!baud) baud = 9600;
659 switch(priv->chip_type) {
660 case SIO: /* SIO chip */
661 switch(baud) {
662 case 300: div_value = ftdi_sio_b300; break;
663 case 600: div_value = ftdi_sio_b600; break;
664 case 1200: div_value = ftdi_sio_b1200; break;
665 case 2400: div_value = ftdi_sio_b2400; break;
666 case 4800: div_value = ftdi_sio_b4800; break;
667 case 9600: div_value = ftdi_sio_b9600; break;
668 case 19200: div_value = ftdi_sio_b19200; break;
669 case 38400: div_value = ftdi_sio_b38400; break;
670 case 57600: div_value = ftdi_sio_b57600; break;
671 case 115200: div_value = ftdi_sio_b115200; break;
672 } /* baud */
673 if (div_value == 0) {
674 dbg("%s - Baudrate (%d) requested is not supported", __FUNCTION__, baud);
675 div_value = ftdi_sio_b9600;
676 baud = 9600;
677 div_okay = 0;
679 break;
680 case FT8U232AM: /* 8U232AM chip */
681 if (baud <= 3000000) {
682 div_value = ftdi_232am_baud_to_divisor(baud);
683 } else {
684 dbg("%s - Baud rate too high!", __FUNCTION__);
685 baud = 9600;
686 div_value = ftdi_232am_baud_to_divisor(9600);
687 div_okay = 0;
689 break;
690 case FT232BM: /* FT232BM chip */
691 case FT2232C: /* FT2232C chip */
692 case FT232RL:
693 if (baud <= 3000000) {
694 div_value = ftdi_232bm_baud_to_divisor(baud);
695 } else {
696 dbg("%s - Baud rate too high!", __FUNCTION__);
697 div_value = ftdi_232bm_baud_to_divisor(9600);
698 div_okay = 0;
699 baud = 9600;
701 break;
702 } /* priv->chip_type */
704 if (div_okay) {
705 dbg("%s - Baud rate set to %d (divisor 0x%lX) on chip %s",
706 __FUNCTION__, baud, (unsigned long)div_value,
707 ftdi_chip_name[priv->chip_type]);
710 tty_encode_baud_rate(port->tty, baud, baud);
711 return(div_value);
715 static int get_serial_info(struct usb_serial_port * port, struct serial_struct __user * retinfo)
717 struct ftdi_private *priv = usb_get_serial_port_data(port);
718 struct serial_struct tmp;
720 if (!retinfo)
721 return -EFAULT;
722 memset(&tmp, 0, sizeof(tmp));
723 tmp.flags = priv->flags;
724 tmp.baud_base = priv->baud_base;
725 tmp.custom_divisor = priv->custom_divisor;
726 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
727 return -EFAULT;
728 return 0;
729 } /* get_serial_info */
732 static int set_serial_info(struct usb_serial_port * port, struct serial_struct __user * newinfo)
733 { /* set_serial_info */
734 struct ftdi_private *priv = usb_get_serial_port_data(port);
735 struct serial_struct new_serial;
736 struct ftdi_private old_priv;
738 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
739 return -EFAULT;
740 old_priv = * priv;
742 /* Do error checking and permission checking */
744 if (!capable(CAP_SYS_ADMIN)) {
745 if (((new_serial.flags & ~ASYNC_USR_MASK) !=
746 (priv->flags & ~ASYNC_USR_MASK)))
747 return -EPERM;
748 priv->flags = ((priv->flags & ~ASYNC_USR_MASK) |
749 (new_serial.flags & ASYNC_USR_MASK));
750 priv->custom_divisor = new_serial.custom_divisor;
751 goto check_and_exit;
754 if ((new_serial.baud_base != priv->baud_base) &&
755 (new_serial.baud_base < 9600))
756 return -EINVAL;
758 /* Make the changes - these are privileged changes! */
760 priv->flags = ((priv->flags & ~ASYNC_FLAGS) |
761 (new_serial.flags & ASYNC_FLAGS));
762 priv->custom_divisor = new_serial.custom_divisor;
764 port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
766 check_and_exit:
767 if ((old_priv.flags & ASYNC_SPD_MASK) !=
768 (priv->flags & ASYNC_SPD_MASK)) {
769 if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_HI)
770 port->tty->alt_speed = 57600;
771 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_VHI)
772 port->tty->alt_speed = 115200;
773 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_SHI)
774 port->tty->alt_speed = 230400;
775 else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_WARP)
776 port->tty->alt_speed = 460800;
777 else
778 port->tty->alt_speed = 0;
780 if (((old_priv.flags & ASYNC_SPD_MASK) !=
781 (priv->flags & ASYNC_SPD_MASK)) ||
782 (((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
783 (old_priv.custom_divisor != priv->custom_divisor))) {
784 change_speed(port);
787 return (0);
789 } /* set_serial_info */
792 /* Determine type of FTDI chip based on USB config and descriptor. */
793 static void ftdi_determine_type(struct usb_serial_port *port)
795 struct ftdi_private *priv = usb_get_serial_port_data(port);
796 struct usb_serial *serial = port->serial;
797 struct usb_device *udev = serial->dev;
798 unsigned version;
799 unsigned interfaces;
801 /* Assume it is not the original SIO device for now. */
802 priv->baud_base = 48000000 / 2;
803 priv->write_offset = 0;
805 version = le16_to_cpu(udev->descriptor.bcdDevice);
806 interfaces = udev->actconfig->desc.bNumInterfaces;
807 dbg("%s: bcdDevice = 0x%x, bNumInterfaces = %u", __FUNCTION__,
808 version, interfaces);
809 if (interfaces > 1) {
810 int inter;
812 /* Multiple interfaces. Assume FT2232C. */
813 priv->chip_type = FT2232C;
814 /* Determine interface code. */
815 inter = serial->interface->altsetting->desc.bInterfaceNumber;
816 if (inter == 0) {
817 priv->interface = PIT_SIOA;
818 } else {
819 priv->interface = PIT_SIOB;
821 /* BM-type devices have a bug where bcdDevice gets set
822 * to 0x200 when iSerialNumber is 0. */
823 if (version < 0x500) {
824 dbg("%s: something fishy - bcdDevice too low for multi-interface device",
825 __FUNCTION__);
827 } else if (version < 0x200) {
828 /* Old device. Assume its the original SIO. */
829 priv->chip_type = SIO;
830 priv->baud_base = 12000000 / 16;
831 priv->write_offset = 1;
832 } else if (version < 0x400) {
833 /* Assume its an FT8U232AM (or FT8U245AM) */
834 /* (It might be a BM because of the iSerialNumber bug,
835 * but it will still work as an AM device.) */
836 priv->chip_type = FT8U232AM;
837 } else if (version < 0x600) {
838 /* Assume its an FT232BM (or FT245BM) */
839 priv->chip_type = FT232BM;
840 } else {
841 /* Assume its an FT232R */
842 priv->chip_type = FT232RL;
844 info("Detected %s", ftdi_chip_name[priv->chip_type]);
849 * ***************************************************************************
850 * Sysfs Attribute
851 * ***************************************************************************
854 static ssize_t show_latency_timer(struct device *dev, struct device_attribute *attr, char *buf)
856 struct usb_serial_port *port = to_usb_serial_port(dev);
857 struct ftdi_private *priv = usb_get_serial_port_data(port);
858 struct usb_device *udev = port->serial->dev;
859 unsigned short latency = 0;
860 int rv = 0;
863 dbg("%s",__FUNCTION__);
865 rv = usb_control_msg(udev,
866 usb_rcvctrlpipe(udev, 0),
867 FTDI_SIO_GET_LATENCY_TIMER_REQUEST,
868 FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE,
869 0, priv->interface,
870 (char*) &latency, 1, WDR_TIMEOUT);
872 if (rv < 0) {
873 dev_err(dev, "Unable to read latency timer: %i\n", rv);
874 return -EIO;
876 return sprintf(buf, "%i\n", latency);
879 /* Write a new value of the latency timer, in units of milliseconds. */
880 static ssize_t store_latency_timer(struct device *dev, struct device_attribute *attr, const char *valbuf,
881 size_t count)
883 struct usb_serial_port *port = to_usb_serial_port(dev);
884 struct ftdi_private *priv = usb_get_serial_port_data(port);
885 struct usb_device *udev = port->serial->dev;
886 char buf[1];
887 int v = simple_strtoul(valbuf, NULL, 10);
888 int rv = 0;
890 dbg("%s: setting latency timer = %i", __FUNCTION__, v);
892 rv = usb_control_msg(udev,
893 usb_sndctrlpipe(udev, 0),
894 FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
895 FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
896 v, priv->interface,
897 buf, 0, WDR_TIMEOUT);
899 if (rv < 0) {
900 dev_err(dev, "Unable to write latency timer: %i\n", rv);
901 return -EIO;
904 return count;
907 /* Write an event character directly to the FTDI register. The ASCII
908 value is in the low 8 bits, with the enable bit in the 9th bit. */
909 static ssize_t store_event_char(struct device *dev, struct device_attribute *attr, const char *valbuf,
910 size_t count)
912 struct usb_serial_port *port = to_usb_serial_port(dev);
913 struct ftdi_private *priv = usb_get_serial_port_data(port);
914 struct usb_device *udev = port->serial->dev;
915 char buf[1];
916 int v = simple_strtoul(valbuf, NULL, 10);
917 int rv = 0;
919 dbg("%s: setting event char = %i", __FUNCTION__, v);
921 rv = usb_control_msg(udev,
922 usb_sndctrlpipe(udev, 0),
923 FTDI_SIO_SET_EVENT_CHAR_REQUEST,
924 FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE,
925 v, priv->interface,
926 buf, 0, WDR_TIMEOUT);
928 if (rv < 0) {
929 dbg("Unable to write event character: %i", rv);
930 return -EIO;
933 return count;
936 static DEVICE_ATTR(latency_timer, S_IWUSR | S_IRUGO, show_latency_timer, store_latency_timer);
937 static DEVICE_ATTR(event_char, S_IWUSR, NULL, store_event_char);
939 static int create_sysfs_attrs(struct usb_serial_port *port)
941 struct ftdi_private *priv = usb_get_serial_port_data(port);
942 int retval = 0;
944 dbg("%s",__FUNCTION__);
946 /* XXX I've no idea if the original SIO supports the event_char
947 * sysfs parameter, so I'm playing it safe. */
948 if (priv->chip_type != SIO) {
949 dbg("sysfs attributes for %s", ftdi_chip_name[priv->chip_type]);
950 retval = device_create_file(&port->dev, &dev_attr_event_char);
951 if ((!retval) &&
952 (priv->chip_type == FT232BM ||
953 priv->chip_type == FT2232C ||
954 priv->chip_type == FT232RL)) {
955 retval = device_create_file(&port->dev,
956 &dev_attr_latency_timer);
959 return retval;
962 static void remove_sysfs_attrs(struct usb_serial_port *port)
964 struct ftdi_private *priv = usb_get_serial_port_data(port);
966 dbg("%s",__FUNCTION__);
968 /* XXX see create_sysfs_attrs */
969 if (priv->chip_type != SIO) {
970 device_remove_file(&port->dev, &dev_attr_event_char);
971 if (priv->chip_type == FT232BM ||
972 priv->chip_type == FT2232C ||
973 priv->chip_type == FT232RL) {
974 device_remove_file(&port->dev, &dev_attr_latency_timer);
981 * ***************************************************************************
982 * FTDI driver specific functions
983 * ***************************************************************************
986 /* Probe function to check for special devices */
987 static int ftdi_sio_probe (struct usb_serial *serial, const struct usb_device_id *id)
989 struct ftdi_sio_quirk *quirk = (struct ftdi_sio_quirk *)id->driver_info;
991 if (quirk && quirk->probe) {
992 int ret = quirk->probe(serial);
993 if (ret != 0)
994 return ret;
997 usb_set_serial_data(serial, (void *)id->driver_info);
999 return 0;
1002 static int ftdi_sio_port_probe(struct usb_serial_port *port)
1004 struct ftdi_private *priv;
1005 struct ftdi_sio_quirk *quirk = usb_get_serial_data(port->serial);
1008 dbg("%s",__FUNCTION__);
1010 priv = kzalloc(sizeof(struct ftdi_private), GFP_KERNEL);
1011 if (!priv){
1012 err("%s- kmalloc(%Zd) failed.", __FUNCTION__, sizeof(struct ftdi_private));
1013 return -ENOMEM;
1016 spin_lock_init(&priv->rx_lock);
1017 spin_lock_init(&priv->tx_lock);
1018 init_waitqueue_head(&priv->delta_msr_wait);
1019 /* This will push the characters through immediately rather
1020 than queue a task to deliver them */
1021 priv->flags = ASYNC_LOW_LATENCY;
1023 if (quirk && quirk->port_probe)
1024 quirk->port_probe(priv);
1026 /* Increase the size of read buffers */
1027 kfree(port->bulk_in_buffer);
1028 port->bulk_in_buffer = kmalloc (BUFSZ, GFP_KERNEL);
1029 if (!port->bulk_in_buffer) {
1030 kfree (priv);
1031 return -ENOMEM;
1033 if (port->read_urb) {
1034 port->read_urb->transfer_buffer = port->bulk_in_buffer;
1035 port->read_urb->transfer_buffer_length = BUFSZ;
1038 INIT_DELAYED_WORK(&priv->rx_work, ftdi_process_read);
1039 priv->port = port;
1041 /* Free port's existing write urb and transfer buffer. */
1042 if (port->write_urb) {
1043 usb_free_urb (port->write_urb);
1044 port->write_urb = NULL;
1046 kfree(port->bulk_out_buffer);
1047 port->bulk_out_buffer = NULL;
1049 usb_set_serial_port_data(port, priv);
1051 ftdi_determine_type (port);
1052 create_sysfs_attrs(port);
1053 return 0;
1056 /* Setup for the USB-UIRT device, which requires hardwired
1057 * baudrate (38400 gets mapped to 312500) */
1058 /* Called from usbserial:serial_probe */
1059 static void ftdi_USB_UIRT_setup (struct ftdi_private *priv)
1061 dbg("%s",__FUNCTION__);
1063 priv->flags |= ASYNC_SPD_CUST;
1064 priv->custom_divisor = 77;
1065 priv->force_baud = 38400;
1066 } /* ftdi_USB_UIRT_setup */
1068 /* Setup for the HE-TIRA1 device, which requires hardwired
1069 * baudrate (38400 gets mapped to 100000) and RTS-CTS enabled. */
1070 static void ftdi_HE_TIRA1_setup (struct ftdi_private *priv)
1072 dbg("%s",__FUNCTION__);
1074 priv->flags |= ASYNC_SPD_CUST;
1075 priv->custom_divisor = 240;
1076 priv->force_baud = 38400;
1077 priv->force_rtscts = 1;
1078 } /* ftdi_HE_TIRA1_setup */
1081 * First port on JTAG adaptors such as Olimex arm-usb-ocd or the FIC/OpenMoko
1082 * Neo1973 Debug Board is reserved for JTAG interface and can be accessed from
1083 * userspace using openocd.
1085 static int ftdi_jtag_probe(struct usb_serial *serial)
1087 struct usb_device *udev = serial->dev;
1088 struct usb_interface *interface = serial->interface;
1090 dbg("%s",__FUNCTION__);
1092 if (interface == udev->actconfig->interface[0]) {
1093 info("Ignoring serial port reserved for JTAG");
1094 return -ENODEV;
1097 return 0;
1101 * The Matrix Orbital VK204-25-USB has an invalid IN endpoint.
1102 * We have to correct it if we want to read from it.
1104 static int ftdi_mtxorb_hack_setup(struct usb_serial *serial)
1106 struct usb_host_endpoint *ep = serial->dev->ep_in[1];
1107 struct usb_endpoint_descriptor *ep_desc = &ep->desc;
1109 if (ep->enabled && ep_desc->wMaxPacketSize == 0) {
1110 ep_desc->wMaxPacketSize = 0x40;
1111 info("Fixing invalid wMaxPacketSize on read pipe");
1114 return 0;
1117 /* ftdi_shutdown is called from usbserial:usb_serial_disconnect
1118 * it is called when the usb device is disconnected
1120 * usbserial:usb_serial_disconnect
1121 * calls __serial_close for each open of the port
1122 * shutdown is called then (ie ftdi_shutdown)
1124 static void ftdi_shutdown (struct usb_serial *serial)
1126 dbg("%s", __FUNCTION__);
1129 static int ftdi_sio_port_remove(struct usb_serial_port *port)
1131 struct ftdi_private *priv = usb_get_serial_port_data(port);
1133 dbg("%s", __FUNCTION__);
1135 remove_sysfs_attrs(port);
1137 /* all open ports are closed at this point
1138 * (by usbserial.c:__serial_close, which calls ftdi_close)
1141 if (priv) {
1142 usb_set_serial_port_data(port, NULL);
1143 kfree(priv);
1146 return 0;
1149 static int ftdi_open (struct usb_serial_port *port, struct file *filp)
1150 { /* ftdi_open */
1151 struct usb_device *dev = port->serial->dev;
1152 struct ftdi_private *priv = usb_get_serial_port_data(port);
1153 unsigned long flags;
1155 int result = 0;
1156 char buf[1]; /* Needed for the usb_control_msg I think */
1158 dbg("%s", __FUNCTION__);
1160 spin_lock_irqsave(&priv->tx_lock, flags);
1161 priv->tx_bytes = 0;
1162 spin_unlock_irqrestore(&priv->tx_lock, flags);
1163 spin_lock_irqsave(&priv->rx_lock, flags);
1164 priv->rx_bytes = 0;
1165 spin_unlock_irqrestore(&priv->rx_lock, flags);
1167 if (port->tty)
1168 port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
1170 /* No error checking for this (will get errors later anyway) */
1171 /* See ftdi_sio.h for description of what is reset */
1172 usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1173 FTDI_SIO_RESET_REQUEST, FTDI_SIO_RESET_REQUEST_TYPE,
1174 FTDI_SIO_RESET_SIO,
1175 priv->interface, buf, 0, WDR_TIMEOUT);
1177 /* Termios defaults are set by usb_serial_init. We don't change
1178 port->tty->termios - this would loose speed settings, etc.
1179 This is same behaviour as serial.c/rs_open() - Kuba */
1181 /* ftdi_set_termios will send usb control messages */
1182 if (port->tty)
1183 ftdi_set_termios(port, port->tty->termios);
1185 /* FIXME: Flow control might be enabled, so it should be checked -
1186 we have no control of defaults! */
1187 /* Turn on RTS and DTR since we are not flow controlling by default */
1188 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1190 /* Not throttled */
1191 spin_lock_irqsave(&priv->rx_lock, flags);
1192 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
1193 spin_unlock_irqrestore(&priv->rx_lock, flags);
1195 /* Start reading from the device */
1196 priv->rx_processed = 0;
1197 usb_fill_bulk_urb(port->read_urb, dev,
1198 usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress),
1199 port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
1200 ftdi_read_bulk_callback, port);
1201 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
1202 if (result)
1203 err("%s - failed submitting read urb, error %d", __FUNCTION__, result);
1206 return result;
1207 } /* ftdi_open */
1212 * usbserial:__serial_close only calls ftdi_close if the point is open
1214 * This only gets called when it is the last close
1219 static void ftdi_close (struct usb_serial_port *port, struct file *filp)
1220 { /* ftdi_close */
1221 unsigned int c_cflag = port->tty->termios->c_cflag;
1222 struct ftdi_private *priv = usb_get_serial_port_data(port);
1223 char buf[1];
1225 dbg("%s", __FUNCTION__);
1227 mutex_lock(&port->serial->disc_mutex);
1228 if (c_cflag & HUPCL && !port->serial->disconnected){
1229 /* Disable flow control */
1230 if (usb_control_msg(port->serial->dev,
1231 usb_sndctrlpipe(port->serial->dev, 0),
1232 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1233 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1234 0, priv->interface, buf, 0,
1235 WDR_TIMEOUT) < 0) {
1236 err("error from flowcontrol urb");
1239 /* drop RTS and DTR */
1240 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1241 } /* Note change no line if hupcl is off */
1242 mutex_unlock(&port->serial->disc_mutex);
1244 /* cancel any scheduled reading */
1245 cancel_delayed_work(&priv->rx_work);
1246 flush_scheduled_work();
1248 /* shutdown our bulk read */
1249 usb_kill_urb(port->read_urb);
1250 } /* ftdi_close */
1254 /* The SIO requires the first byte to have:
1255 * B0 1
1256 * B1 0
1257 * B2..7 length of message excluding byte 0
1259 * The new devices do not require this byte
1261 static int ftdi_write (struct usb_serial_port *port,
1262 const unsigned char *buf, int count)
1263 { /* ftdi_write */
1264 struct ftdi_private *priv = usb_get_serial_port_data(port);
1265 struct urb *urb;
1266 unsigned char *buffer;
1267 int data_offset ; /* will be 1 for the SIO and 0 otherwise */
1268 int status;
1269 int transfer_size;
1270 unsigned long flags;
1272 dbg("%s port %d, %d bytes", __FUNCTION__, port->number, count);
1274 if (count == 0) {
1275 dbg("write request of 0 bytes");
1276 return 0;
1278 spin_lock_irqsave(&priv->tx_lock, flags);
1279 if (priv->tx_outstanding_urbs > URB_UPPER_LIMIT) {
1280 spin_unlock_irqrestore(&priv->tx_lock, flags);
1281 dbg("%s - write limit hit\n", __FUNCTION__);
1282 return 0;
1284 priv->tx_outstanding_urbs++;
1285 spin_unlock_irqrestore(&priv->tx_lock, flags);
1287 data_offset = priv->write_offset;
1288 dbg("data_offset set to %d",data_offset);
1290 /* Determine total transfer size */
1291 transfer_size = count;
1292 if (data_offset > 0) {
1293 /* Original sio needs control bytes too... */
1294 transfer_size += (data_offset *
1295 ((count + (PKTSZ - 1 - data_offset)) /
1296 (PKTSZ - data_offset)));
1299 buffer = kmalloc (transfer_size, GFP_ATOMIC);
1300 if (!buffer) {
1301 err("%s ran out of kernel memory for urb ...", __FUNCTION__);
1302 count = -ENOMEM;
1303 goto error_no_buffer;
1306 urb = usb_alloc_urb(0, GFP_ATOMIC);
1307 if (!urb) {
1308 err("%s - no more free urbs", __FUNCTION__);
1309 count = -ENOMEM;
1310 goto error_no_urb;
1313 /* Copy data */
1314 if (data_offset > 0) {
1315 /* Original sio requires control byte at start of each packet. */
1316 int user_pktsz = PKTSZ - data_offset;
1317 int todo = count;
1318 unsigned char *first_byte = buffer;
1319 const unsigned char *current_position = buf;
1321 while (todo > 0) {
1322 if (user_pktsz > todo) {
1323 user_pktsz = todo;
1325 /* Write the control byte at the front of the packet*/
1326 *first_byte = 1 | ((user_pktsz) << 2);
1327 /* Copy data for packet */
1328 memcpy (first_byte + data_offset,
1329 current_position, user_pktsz);
1330 first_byte += user_pktsz + data_offset;
1331 current_position += user_pktsz;
1332 todo -= user_pktsz;
1334 } else {
1335 /* No control byte required. */
1336 /* Copy in the data to send */
1337 memcpy (buffer, buf, count);
1340 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, transfer_size, buffer);
1342 /* fill the buffer and send it */
1343 usb_fill_bulk_urb(urb, port->serial->dev,
1344 usb_sndbulkpipe(port->serial->dev, port->bulk_out_endpointAddress),
1345 buffer, transfer_size,
1346 ftdi_write_bulk_callback, port);
1348 status = usb_submit_urb(urb, GFP_ATOMIC);
1349 if (status) {
1350 err("%s - failed submitting write urb, error %d", __FUNCTION__, status);
1351 count = status;
1352 goto error;
1353 } else {
1354 spin_lock_irqsave(&priv->tx_lock, flags);
1355 priv->tx_outstanding_bytes += count;
1356 priv->tx_bytes += count;
1357 spin_unlock_irqrestore(&priv->tx_lock, flags);
1360 /* we are done with this urb, so let the host driver
1361 * really free it when it is finished with it */
1362 usb_free_urb(urb);
1364 dbg("%s write returning: %d", __FUNCTION__, count);
1365 return count;
1366 error:
1367 usb_free_urb(urb);
1368 error_no_urb:
1369 kfree (buffer);
1370 error_no_buffer:
1371 spin_lock_irqsave(&priv->tx_lock, flags);
1372 priv->tx_outstanding_urbs--;
1373 spin_unlock_irqrestore(&priv->tx_lock, flags);
1374 return count;
1375 } /* ftdi_write */
1378 /* This function may get called when the device is closed */
1380 static void ftdi_write_bulk_callback (struct urb *urb)
1382 unsigned long flags;
1383 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1384 struct ftdi_private *priv;
1385 int data_offset; /* will be 1 for the SIO and 0 otherwise */
1386 unsigned long countback;
1387 int status = urb->status;
1389 /* free up the transfer buffer, as usb_free_urb() does not do this */
1390 kfree (urb->transfer_buffer);
1392 dbg("%s - port %d", __FUNCTION__, port->number);
1394 if (status) {
1395 dbg("nonzero write bulk status received: %d", status);
1396 return;
1399 priv = usb_get_serial_port_data(port);
1400 if (!priv) {
1401 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1402 return;
1404 /* account for transferred data */
1405 countback = urb->actual_length;
1406 data_offset = priv->write_offset;
1407 if (data_offset > 0) {
1408 /* Subtract the control bytes */
1409 countback -= (data_offset * ((countback + (PKTSZ - 1)) / PKTSZ));
1411 spin_lock_irqsave(&priv->tx_lock, flags);
1412 --priv->tx_outstanding_urbs;
1413 priv->tx_outstanding_bytes -= countback;
1414 spin_unlock_irqrestore(&priv->tx_lock, flags);
1416 usb_serial_port_softint(port);
1417 } /* ftdi_write_bulk_callback */
1420 static int ftdi_write_room( struct usb_serial_port *port )
1422 struct ftdi_private *priv = usb_get_serial_port_data(port);
1423 int room;
1424 unsigned long flags;
1426 dbg("%s - port %d", __FUNCTION__, port->number);
1428 spin_lock_irqsave(&priv->tx_lock, flags);
1429 if (priv->tx_outstanding_urbs < URB_UPPER_LIMIT) {
1431 * We really can take anything the user throws at us
1432 * but let's pick a nice big number to tell the tty
1433 * layer that we have lots of free space
1435 room = 2048;
1436 } else {
1437 room = 0;
1439 spin_unlock_irqrestore(&priv->tx_lock, flags);
1440 return room;
1441 } /* ftdi_write_room */
1444 static int ftdi_chars_in_buffer (struct usb_serial_port *port)
1445 { /* ftdi_chars_in_buffer */
1446 struct ftdi_private *priv = usb_get_serial_port_data(port);
1447 int buffered;
1448 unsigned long flags;
1450 dbg("%s - port %d", __FUNCTION__, port->number);
1452 spin_lock_irqsave(&priv->tx_lock, flags);
1453 buffered = (int)priv->tx_outstanding_bytes;
1454 spin_unlock_irqrestore(&priv->tx_lock, flags);
1455 if (buffered < 0) {
1456 err("%s outstanding tx bytes is negative!", __FUNCTION__);
1457 buffered = 0;
1459 return buffered;
1460 } /* ftdi_chars_in_buffer */
1464 static void ftdi_read_bulk_callback (struct urb *urb)
1465 { /* ftdi_read_bulk_callback */
1466 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1467 struct tty_struct *tty;
1468 struct ftdi_private *priv;
1469 unsigned long countread;
1470 unsigned long flags;
1471 int status = urb->status;
1473 if (urb->number_of_packets > 0) {
1474 err("%s transfer_buffer_length %d actual_length %d number of packets %d",__FUNCTION__,
1475 urb->transfer_buffer_length, urb->actual_length, urb->number_of_packets );
1476 err("%s transfer_flags %x ", __FUNCTION__,urb->transfer_flags );
1479 dbg("%s - port %d", __FUNCTION__, port->number);
1481 if (port->open_count <= 0)
1482 return;
1484 tty = port->tty;
1485 if (!tty) {
1486 dbg("%s - bad tty pointer - exiting",__FUNCTION__);
1487 return;
1490 priv = usb_get_serial_port_data(port);
1491 if (!priv) {
1492 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1493 return;
1496 if (urb != port->read_urb) {
1497 err("%s - Not my urb!", __FUNCTION__);
1500 if (status) {
1501 /* This will happen at close every time so it is a dbg not an err */
1502 dbg("(this is ok on close) nonzero read bulk status received: "
1503 "%d", status);
1504 return;
1507 /* count data bytes, but not status bytes */
1508 countread = urb->actual_length;
1509 countread -= 2 * ((countread + (PKTSZ - 1)) / PKTSZ);
1510 spin_lock_irqsave(&priv->rx_lock, flags);
1511 priv->rx_bytes += countread;
1512 spin_unlock_irqrestore(&priv->rx_lock, flags);
1514 ftdi_process_read(&priv->rx_work.work);
1516 } /* ftdi_read_bulk_callback */
1519 static void ftdi_process_read (struct work_struct *work)
1520 { /* ftdi_process_read */
1521 struct ftdi_private *priv =
1522 container_of(work, struct ftdi_private, rx_work.work);
1523 struct usb_serial_port *port = priv->port;
1524 struct urb *urb;
1525 struct tty_struct *tty;
1526 char error_flag;
1527 unsigned char *data;
1529 int i;
1530 int result;
1531 int need_flip;
1532 int packet_offset;
1533 unsigned long flags;
1535 dbg("%s - port %d", __FUNCTION__, port->number);
1537 if (port->open_count <= 0)
1538 return;
1540 tty = port->tty;
1541 if (!tty) {
1542 dbg("%s - bad tty pointer - exiting",__FUNCTION__);
1543 return;
1546 priv = usb_get_serial_port_data(port);
1547 if (!priv) {
1548 dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
1549 return;
1552 urb = port->read_urb;
1553 if (!urb) {
1554 dbg("%s - bad read_urb pointer - exiting", __FUNCTION__);
1555 return;
1558 data = urb->transfer_buffer;
1560 if (priv->rx_processed) {
1561 dbg("%s - already processed: %d bytes, %d remain", __FUNCTION__,
1562 priv->rx_processed,
1563 urb->actual_length - priv->rx_processed);
1564 } else {
1565 /* The first two bytes of every read packet are status */
1566 if (urb->actual_length > 2) {
1567 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
1568 } else {
1569 dbg("Status only: %03oo %03oo",data[0],data[1]);
1574 /* TO DO -- check for hung up line and handle appropriately: */
1575 /* send hangup */
1576 /* See acm.c - you do a tty_hangup - eg tty_hangup(tty) */
1577 /* if CD is dropped and the line is not CLOCAL then we should hangup */
1579 need_flip = 0;
1580 for (packet_offset = priv->rx_processed; packet_offset < urb->actual_length; packet_offset += PKTSZ) {
1581 int length;
1583 /* Compare new line status to the old one, signal if different */
1584 /* N.B. packet may be processed more than once, but differences
1585 * are only processed once. */
1586 if (priv != NULL) {
1587 char new_status = data[packet_offset+0] & FTDI_STATUS_B0_MASK;
1588 if (new_status != priv->prev_status) {
1589 priv->diff_status |= new_status ^ priv->prev_status;
1590 wake_up_interruptible(&priv->delta_msr_wait);
1591 priv->prev_status = new_status;
1595 length = min(PKTSZ, urb->actual_length-packet_offset)-2;
1596 if (length < 0) {
1597 err("%s - bad packet length: %d", __FUNCTION__, length+2);
1598 length = 0;
1601 if (priv->rx_flags & THROTTLED) {
1602 dbg("%s - throttled", __FUNCTION__);
1603 break;
1605 if (tty_buffer_request_room(tty, length) < length) {
1606 /* break out & wait for throttling/unthrottling to happen */
1607 dbg("%s - receive room low", __FUNCTION__);
1608 break;
1611 /* Handle errors and break */
1612 error_flag = TTY_NORMAL;
1613 /* Although the device uses a bitmask and hence can have multiple */
1614 /* errors on a packet - the order here sets the priority the */
1615 /* error is returned to the tty layer */
1617 if ( data[packet_offset+1] & FTDI_RS_OE ) {
1618 error_flag = TTY_OVERRUN;
1619 dbg("OVERRRUN error");
1621 if ( data[packet_offset+1] & FTDI_RS_BI ) {
1622 error_flag = TTY_BREAK;
1623 dbg("BREAK received");
1625 if ( data[packet_offset+1] & FTDI_RS_PE ) {
1626 error_flag = TTY_PARITY;
1627 dbg("PARITY error");
1629 if ( data[packet_offset+1] & FTDI_RS_FE ) {
1630 error_flag = TTY_FRAME;
1631 dbg("FRAMING error");
1633 if (length > 0) {
1634 for (i = 2; i < length+2; i++) {
1635 /* Note that the error flag is duplicated for
1636 every character received since we don't know
1637 which character it applied to */
1638 tty_insert_flip_char(tty, data[packet_offset+i], error_flag);
1640 need_flip = 1;
1643 #ifdef NOT_CORRECT_BUT_KEEPING_IT_FOR_NOW
1644 /* if a parity error is detected you get status packets forever
1645 until a character is sent without a parity error.
1646 This doesn't work well since the application receives a never
1647 ending stream of bad data - even though new data hasn't been sent.
1648 Therefore I (bill) have taken this out.
1649 However - this might make sense for framing errors and so on
1650 so I am leaving the code in for now.
1652 else {
1653 if (error_flag != TTY_NORMAL){
1654 dbg("error_flag is not normal");
1655 /* In this case it is just status - if that is an error send a bad character */
1656 if(tty->flip.count >= TTY_FLIPBUF_SIZE) {
1657 tty_flip_buffer_push(tty);
1659 tty_insert_flip_char(tty, 0xff, error_flag);
1660 need_flip = 1;
1663 #endif
1664 } /* "for(packet_offset=0..." */
1666 /* Low latency */
1667 if (need_flip) {
1668 tty_flip_buffer_push(tty);
1671 if (packet_offset < urb->actual_length) {
1672 /* not completely processed - record progress */
1673 priv->rx_processed = packet_offset;
1674 dbg("%s - incomplete, %d bytes processed, %d remain",
1675 __FUNCTION__, packet_offset,
1676 urb->actual_length - packet_offset);
1677 /* check if we were throttled while processing */
1678 spin_lock_irqsave(&priv->rx_lock, flags);
1679 if (priv->rx_flags & THROTTLED) {
1680 priv->rx_flags |= ACTUALLY_THROTTLED;
1681 spin_unlock_irqrestore(&priv->rx_lock, flags);
1682 dbg("%s - deferring remainder until unthrottled",
1683 __FUNCTION__);
1684 return;
1686 spin_unlock_irqrestore(&priv->rx_lock, flags);
1687 /* if the port is closed stop trying to read */
1688 if (port->open_count > 0){
1689 /* delay processing of remainder */
1690 schedule_delayed_work(&priv->rx_work, 1);
1691 } else {
1692 dbg("%s - port is closed", __FUNCTION__);
1694 return;
1697 /* urb is completely processed */
1698 priv->rx_processed = 0;
1700 /* if the port is closed stop trying to read */
1701 if (port->open_count > 0){
1702 /* Continue trying to always read */
1703 usb_fill_bulk_urb(port->read_urb, port->serial->dev,
1704 usb_rcvbulkpipe(port->serial->dev, port->bulk_in_endpointAddress),
1705 port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
1706 ftdi_read_bulk_callback, port);
1708 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1709 if (result)
1710 err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
1713 return;
1714 } /* ftdi_process_read */
1717 static void ftdi_break_ctl( struct usb_serial_port *port, int break_state )
1719 struct ftdi_private *priv = usb_get_serial_port_data(port);
1720 __u16 urb_value = 0;
1721 char buf[1];
1723 /* break_state = -1 to turn on break, and 0 to turn off break */
1724 /* see drivers/char/tty_io.c to see it used */
1725 /* last_set_data_urb_value NEVER has the break bit set in it */
1727 if (break_state) {
1728 urb_value = priv->last_set_data_urb_value | FTDI_SIO_SET_BREAK;
1729 } else {
1730 urb_value = priv->last_set_data_urb_value;
1734 if (usb_control_msg(port->serial->dev, usb_sndctrlpipe(port->serial->dev, 0),
1735 FTDI_SIO_SET_DATA_REQUEST,
1736 FTDI_SIO_SET_DATA_REQUEST_TYPE,
1737 urb_value , priv->interface,
1738 buf, 0, WDR_TIMEOUT) < 0) {
1739 err("%s FAILED to enable/disable break state (state was %d)", __FUNCTION__,break_state);
1742 dbg("%s break state is %d - urb is %d", __FUNCTION__,break_state, urb_value);
1747 /* old_termios contains the original termios settings and tty->termios contains
1748 * the new setting to be used
1749 * WARNING: set_termios calls this with old_termios in kernel space
1752 static void ftdi_set_termios (struct usb_serial_port *port, struct ktermios *old_termios)
1753 { /* ftdi_termios */
1754 struct usb_device *dev = port->serial->dev;
1755 struct ftdi_private *priv = usb_get_serial_port_data(port);
1756 struct ktermios *termios = port->tty->termios;
1757 unsigned int cflag = termios->c_cflag;
1758 __u16 urb_value; /* will hold the new flags */
1759 char buf[1]; /* Perhaps I should dynamically alloc this? */
1761 // Added for xon/xoff support
1762 unsigned int iflag = termios->c_iflag;
1763 unsigned char vstop;
1764 unsigned char vstart;
1766 dbg("%s", __FUNCTION__);
1768 /* Force baud rate if this device requires it, unless it is set to B0. */
1769 if (priv->force_baud && ((termios->c_cflag & CBAUD) != B0)) {
1770 dbg("%s: forcing baud rate for this device", __FUNCTION__);
1771 tty_encode_baud_rate(port->tty, priv->force_baud,
1772 priv->force_baud);
1775 /* Force RTS-CTS if this device requires it. */
1776 if (priv->force_rtscts) {
1777 dbg("%s: forcing rtscts for this device", __FUNCTION__);
1778 termios->c_cflag |= CRTSCTS;
1781 cflag = termios->c_cflag;
1783 /* FIXME -For this cut I don't care if the line is really changing or
1784 not - so just do the change regardless - should be able to
1785 compare old_termios and tty->termios */
1786 /* NOTE These routines can get interrupted by
1787 ftdi_sio_read_bulk_callback - need to examine what this
1788 means - don't see any problems yet */
1790 /* Set number of data bits, parity, stop bits */
1792 termios->c_cflag &= ~CMSPAR;
1794 urb_value = 0;
1795 urb_value |= (cflag & CSTOPB ? FTDI_SIO_SET_DATA_STOP_BITS_2 :
1796 FTDI_SIO_SET_DATA_STOP_BITS_1);
1797 urb_value |= (cflag & PARENB ?
1798 (cflag & PARODD ? FTDI_SIO_SET_DATA_PARITY_ODD :
1799 FTDI_SIO_SET_DATA_PARITY_EVEN) :
1800 FTDI_SIO_SET_DATA_PARITY_NONE);
1801 if (cflag & CSIZE) {
1802 switch (cflag & CSIZE) {
1803 case CS5: urb_value |= 5; dbg("Setting CS5"); break;
1804 case CS6: urb_value |= 6; dbg("Setting CS6"); break;
1805 case CS7: urb_value |= 7; dbg("Setting CS7"); break;
1806 case CS8: urb_value |= 8; dbg("Setting CS8"); break;
1807 default:
1808 err("CSIZE was set but not CS5-CS8");
1812 /* This is needed by the break command since it uses the same command - but is
1813 * or'ed with this value */
1814 priv->last_set_data_urb_value = urb_value;
1816 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1817 FTDI_SIO_SET_DATA_REQUEST,
1818 FTDI_SIO_SET_DATA_REQUEST_TYPE,
1819 urb_value , priv->interface,
1820 buf, 0, WDR_SHORT_TIMEOUT) < 0) {
1821 err("%s FAILED to set databits/stopbits/parity", __FUNCTION__);
1824 /* Now do the baudrate */
1825 if ((cflag & CBAUD) == B0 ) {
1826 /* Disable flow control */
1827 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1828 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1829 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1830 0, priv->interface,
1831 buf, 0, WDR_TIMEOUT) < 0) {
1832 err("%s error from disable flowcontrol urb", __FUNCTION__);
1834 /* Drop RTS and DTR */
1835 clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1836 } else {
1837 /* set the baudrate determined before */
1838 if (change_speed(port)) {
1839 err("%s urb failed to set baudrate", __FUNCTION__);
1841 /* Ensure RTS and DTR are raised when baudrate changed from 0 */
1842 if (!old_termios || (old_termios->c_cflag & CBAUD) == B0) {
1843 set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1847 /* Set flow control */
1848 /* Note device also supports DTR/CD (ugh) and Xon/Xoff in hardware */
1849 if (cflag & CRTSCTS) {
1850 dbg("%s Setting to CRTSCTS flow control", __FUNCTION__);
1851 if (usb_control_msg(dev,
1852 usb_sndctrlpipe(dev, 0),
1853 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1854 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1855 0 , (FTDI_SIO_RTS_CTS_HS | priv->interface),
1856 buf, 0, WDR_TIMEOUT) < 0) {
1857 err("urb failed to set to rts/cts flow control");
1860 } else {
1862 * Xon/Xoff code
1864 * Check the IXOFF status in the iflag component of the termios structure
1865 * if IXOFF is not set, the pre-xon/xoff code is executed.
1867 if (iflag & IXOFF) {
1868 dbg("%s request to enable xonxoff iflag=%04x",__FUNCTION__,iflag);
1869 // Try to enable the XON/XOFF on the ftdi_sio
1870 // Set the vstart and vstop -- could have been done up above where
1871 // a lot of other dereferencing is done but that would be very
1872 // inefficient as vstart and vstop are not always needed
1873 vstart = termios->c_cc[VSTART];
1874 vstop = termios->c_cc[VSTOP];
1875 urb_value=(vstop << 8) | (vstart);
1877 if (usb_control_msg(dev,
1878 usb_sndctrlpipe(dev, 0),
1879 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1880 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1881 urb_value , (FTDI_SIO_XON_XOFF_HS
1882 | priv->interface),
1883 buf, 0, WDR_TIMEOUT) < 0) {
1884 err("urb failed to set to xon/xoff flow control");
1886 } else {
1887 /* else clause to only run if cfag ! CRTSCTS and iflag ! XOFF */
1888 /* CHECKME Assuming XON/XOFF handled by tty stack - not by device */
1889 dbg("%s Turning off hardware flow control", __FUNCTION__);
1890 if (usb_control_msg(dev,
1891 usb_sndctrlpipe(dev, 0),
1892 FTDI_SIO_SET_FLOW_CTRL_REQUEST,
1893 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
1894 0, priv->interface,
1895 buf, 0, WDR_TIMEOUT) < 0) {
1896 err("urb failed to clear flow control");
1901 return;
1902 } /* ftdi_termios */
1905 static int ftdi_tiocmget (struct usb_serial_port *port, struct file *file)
1907 struct ftdi_private *priv = usb_get_serial_port_data(port);
1908 unsigned char buf[2];
1909 int ret;
1911 dbg("%s TIOCMGET", __FUNCTION__);
1912 switch (priv->chip_type) {
1913 case SIO:
1914 /* Request the status from the device */
1915 if ((ret = usb_control_msg(port->serial->dev,
1916 usb_rcvctrlpipe(port->serial->dev, 0),
1917 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
1918 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
1919 0, 0,
1920 buf, 1, WDR_TIMEOUT)) < 0 ) {
1921 err("%s Could not get modem status of device - err: %d", __FUNCTION__,
1922 ret);
1923 return(ret);
1925 break;
1926 case FT8U232AM:
1927 case FT232BM:
1928 case FT2232C:
1929 case FT232RL:
1930 /* the 8U232AM returns a two byte value (the sio is a 1 byte value) - in the same
1931 format as the data returned from the in point */
1932 if ((ret = usb_control_msg(port->serial->dev,
1933 usb_rcvctrlpipe(port->serial->dev, 0),
1934 FTDI_SIO_GET_MODEM_STATUS_REQUEST,
1935 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
1936 0, priv->interface,
1937 buf, 2, WDR_TIMEOUT)) < 0 ) {
1938 err("%s Could not get modem status of device - err: %d", __FUNCTION__,
1939 ret);
1940 return(ret);
1942 break;
1943 default:
1944 return -EFAULT;
1945 break;
1948 return (buf[0] & FTDI_SIO_DSR_MASK ? TIOCM_DSR : 0) |
1949 (buf[0] & FTDI_SIO_CTS_MASK ? TIOCM_CTS : 0) |
1950 (buf[0] & FTDI_SIO_RI_MASK ? TIOCM_RI : 0) |
1951 (buf[0] & FTDI_SIO_RLSD_MASK ? TIOCM_CD : 0) |
1952 priv->last_dtr_rts;
1955 static int ftdi_tiocmset(struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear)
1957 dbg("%s TIOCMSET", __FUNCTION__);
1958 return update_mctrl(port, set, clear);
1962 static int ftdi_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
1964 struct ftdi_private *priv = usb_get_serial_port_data(port);
1966 dbg("%s cmd 0x%04x", __FUNCTION__, cmd);
1968 /* Based on code from acm.c and others */
1969 switch (cmd) {
1971 case TIOCGSERIAL: /* gets serial port data */
1972 return get_serial_info(port, (struct serial_struct __user *) arg);
1974 case TIOCSSERIAL: /* sets serial port data */
1975 return set_serial_info(port, (struct serial_struct __user *) arg);
1978 * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1979 * - mask passed in arg for lines of interest
1980 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1981 * Caller should use TIOCGICOUNT to see which one it was.
1983 * This code is borrowed from linux/drivers/char/serial.c
1985 case TIOCMIWAIT:
1986 while (priv != NULL) {
1987 interruptible_sleep_on(&priv->delta_msr_wait);
1988 /* see if a signal did it */
1989 if (signal_pending(current))
1990 return -ERESTARTSYS;
1991 else {
1992 char diff = priv->diff_status;
1994 if (diff == 0) {
1995 return -EIO; /* no change => error */
1998 /* Consume all events */
1999 priv->diff_status = 0;
2001 /* Return 0 if caller wanted to know about these bits */
2002 if ( ((arg & TIOCM_RNG) && (diff & FTDI_RS0_RI)) ||
2003 ((arg & TIOCM_DSR) && (diff & FTDI_RS0_DSR)) ||
2004 ((arg & TIOCM_CD) && (diff & FTDI_RS0_RLSD)) ||
2005 ((arg & TIOCM_CTS) && (diff & FTDI_RS0_CTS)) ) {
2006 return 0;
2009 * Otherwise caller can't care less about what happened,
2010 * and so we continue to wait for more events.
2014 return(0);
2015 break;
2016 default:
2017 break;
2022 /* This is not necessarily an error - turns out the higher layers will do
2023 * some ioctls itself (see comment above)
2025 dbg("%s arg not supported - it was 0x%04x - check /usr/include/asm/ioctls.h", __FUNCTION__, cmd);
2027 return(-ENOIOCTLCMD);
2028 } /* ftdi_ioctl */
2031 static void ftdi_throttle (struct usb_serial_port *port)
2033 struct ftdi_private *priv = usb_get_serial_port_data(port);
2034 unsigned long flags;
2036 dbg("%s - port %d", __FUNCTION__, port->number);
2038 spin_lock_irqsave(&priv->rx_lock, flags);
2039 priv->rx_flags |= THROTTLED;
2040 spin_unlock_irqrestore(&priv->rx_lock, flags);
2044 static void ftdi_unthrottle (struct usb_serial_port *port)
2046 struct ftdi_private *priv = usb_get_serial_port_data(port);
2047 int actually_throttled;
2048 unsigned long flags;
2050 dbg("%s - port %d", __FUNCTION__, port->number);
2052 spin_lock_irqsave(&priv->rx_lock, flags);
2053 actually_throttled = priv->rx_flags & ACTUALLY_THROTTLED;
2054 priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
2055 spin_unlock_irqrestore(&priv->rx_lock, flags);
2057 if (actually_throttled)
2058 schedule_delayed_work(&priv->rx_work, 0);
2061 static int __init ftdi_init (void)
2063 int retval;
2065 dbg("%s", __FUNCTION__);
2066 if (vendor > 0 && product > 0) {
2067 /* Add user specified VID/PID to reserved element of table. */
2068 int i;
2069 for (i = 0; id_table_combined[i].idVendor; i++)
2071 id_table_combined[i].match_flags = USB_DEVICE_ID_MATCH_DEVICE;
2072 id_table_combined[i].idVendor = vendor;
2073 id_table_combined[i].idProduct = product;
2075 retval = usb_serial_register(&ftdi_sio_device);
2076 if (retval)
2077 goto failed_sio_register;
2078 retval = usb_register(&ftdi_driver);
2079 if (retval)
2080 goto failed_usb_register;
2082 info(DRIVER_VERSION ":" DRIVER_DESC);
2083 return 0;
2084 failed_usb_register:
2085 usb_serial_deregister(&ftdi_sio_device);
2086 failed_sio_register:
2087 return retval;
2091 static void __exit ftdi_exit (void)
2094 dbg("%s", __FUNCTION__);
2096 usb_deregister (&ftdi_driver);
2097 usb_serial_deregister (&ftdi_sio_device);
2102 module_init(ftdi_init);
2103 module_exit(ftdi_exit);
2105 MODULE_AUTHOR( DRIVER_AUTHOR );
2106 MODULE_DESCRIPTION( DRIVER_DESC );
2107 MODULE_LICENSE("GPL");
2109 module_param(debug, bool, S_IRUGO | S_IWUSR);
2110 MODULE_PARM_DESC(debug, "Debug enabled or not");
2111 module_param(vendor, ushort, 0);
2112 MODULE_PARM_DESC(vendor, "User specified vendor ID (default="
2113 __MODULE_STRING(FTDI_VID)")");
2114 module_param(product, ushort, 0);
2115 MODULE_PARM_DESC(vendor, "User specified product ID");