4 * Copyright (C) 1999 - 2001
5 * Greg Kroah-Hartman (greg@kroah.com)
6 * Bill Ryder (bryder@sgi.com)
8 * Kuba Ober (kuba@mareimbrium.org)
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * See Documentation/usb/usb-serial.txt for more information on using this 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>
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"
53 static __u16 vendor
= FTDI_VID
;
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
;
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
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
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
= {
377 .probe
= usb_serial_probe
,
378 .disconnect
= usb_serial_disconnect
,
379 .id_table
= id_table_combined
,
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 */
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)
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
= {
436 .owner
= THIS_MODULE
,
439 .description
= "FTDI USB Serial Device",
440 .usb_driver
= &ftdi_driver
,
441 .id_table
= id_table_combined
,
443 .probe
= ftdi_sio_probe
,
444 .port_probe
= ftdi_sio_port_probe
,
445 .port_remove
= ftdi_sio_port_remove
,
448 .throttle
= ftdi_throttle
,
449 .unthrottle
= ftdi_unthrottle
,
451 .write_room
= ftdi_write_room
,
452 .chars_in_buffer
= ftdi_chars_in_buffer
,
453 .read_bulk_callback
= ftdi_read_bulk_callback
,
454 .write_bulk_callback
= ftdi_write_bulk_callback
,
455 .tiocmget
= ftdi_tiocmget
,
456 .tiocmset
= ftdi_tiocmset
,
458 .set_termios
= ftdi_set_termios
,
459 .break_ctl
= ftdi_break_ctl
,
460 .shutdown
= ftdi_shutdown
,
464 #define WDR_TIMEOUT 5000 /* default urb timeout */
465 #define WDR_SHORT_TIMEOUT 1000 /* shorter urb timeout */
467 /* High and low are for DTR, RTS etc etc */
471 /* number of outstanding urbs to prevent userspace DoS from happening */
472 #define URB_UPPER_LIMIT 42
475 * ***************************************************************************
477 * ***************************************************************************
480 static unsigned short int ftdi_232am_baud_base_to_divisor(int baud
, int base
)
482 unsigned short int divisor
;
483 int divisor3
= base
/ 2 / baud
; // divisor shifted 3 bits to the left
484 if ((divisor3
& 0x7) == 7) divisor3
++; // round x.7/8 up to x+1
485 divisor
= divisor3
>> 3;
487 if (divisor3
== 1) divisor
|= 0xc000; else // 0.125
488 if (divisor3
>= 4) divisor
|= 0x4000; else // 0.5
489 if (divisor3
!= 0) divisor
|= 0x8000; // 0.25
490 if (divisor
== 1) divisor
= 0; /* special case for maximum baud rate */
494 static unsigned short int ftdi_232am_baud_to_divisor(int baud
)
496 return(ftdi_232am_baud_base_to_divisor(baud
, 48000000));
499 static __u32
ftdi_232bm_baud_base_to_divisor(int baud
, int base
)
501 static const unsigned char divfrac
[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
503 int divisor3
= base
/ 2 / baud
; // divisor shifted 3 bits to the left
504 divisor
= divisor3
>> 3;
505 divisor
|= (__u32
)divfrac
[divisor3
& 0x7] << 14;
506 /* Deal with special cases for highest baud rates. */
507 if (divisor
== 1) divisor
= 0; else // 1.0
508 if (divisor
== 0x4001) divisor
= 1; // 1.5
512 static __u32
ftdi_232bm_baud_to_divisor(int baud
)
514 return(ftdi_232bm_baud_base_to_divisor(baud
, 48000000));
517 #define set_mctrl(port, set) update_mctrl((port), (set), 0)
518 #define clear_mctrl(port, clear) update_mctrl((port), 0, (clear))
520 static int update_mctrl(struct usb_serial_port
*port
, unsigned int set
, unsigned int clear
)
522 struct ftdi_private
*priv
= usb_get_serial_port_data(port
);
527 if (((set
| clear
) & (TIOCM_DTR
| TIOCM_RTS
)) == 0) {
528 dbg("%s - DTR|RTS not being set|cleared", __func__
);
529 return 0; /* no change */
532 buf
= kmalloc(1, GFP_NOIO
);
536 clear
&= ~set
; /* 'set' takes precedence over 'clear' */
538 if (clear
& TIOCM_DTR
)
539 urb_value
|= FTDI_SIO_SET_DTR_LOW
;
540 if (clear
& TIOCM_RTS
)
541 urb_value
|= FTDI_SIO_SET_RTS_LOW
;
543 urb_value
|= FTDI_SIO_SET_DTR_HIGH
;
545 urb_value
|= FTDI_SIO_SET_RTS_HIGH
;
546 rv
= usb_control_msg(port
->serial
->dev
,
547 usb_sndctrlpipe(port
->serial
->dev
, 0),
548 FTDI_SIO_SET_MODEM_CTRL_REQUEST
,
549 FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE
,
550 urb_value
, priv
->interface
,
551 buf
, 0, WDR_TIMEOUT
);
555 err("%s Error from MODEM_CTRL urb: DTR %s, RTS %s",
557 (set
& TIOCM_DTR
) ? "HIGH" :
558 (clear
& TIOCM_DTR
) ? "LOW" : "unchanged",
559 (set
& TIOCM_RTS
) ? "HIGH" :
560 (clear
& TIOCM_RTS
) ? "LOW" : "unchanged");
562 dbg("%s - DTR %s, RTS %s", __func__
,
563 (set
& TIOCM_DTR
) ? "HIGH" :
564 (clear
& TIOCM_DTR
) ? "LOW" : "unchanged",
565 (set
& TIOCM_RTS
) ? "HIGH" :
566 (clear
& TIOCM_RTS
) ? "LOW" : "unchanged");
567 /* FIXME: locking on last_dtr_rts */
568 priv
->last_dtr_rts
= (priv
->last_dtr_rts
& ~clear
) | set
;
574 static __u32
get_ftdi_divisor(struct usb_serial_port
* port
);
577 static int change_speed(struct usb_serial_port
*port
)
579 struct ftdi_private
*priv
= usb_get_serial_port_data(port
);
583 __u32 urb_index_value
;
586 buf
= kmalloc(1, GFP_NOIO
);
590 urb_index_value
= get_ftdi_divisor(port
);
591 urb_value
= (__u16
)urb_index_value
;
592 urb_index
= (__u16
)(urb_index_value
>> 16);
593 if (priv
->interface
) { /* FT2232C */
594 urb_index
= (__u16
)((urb_index
<< 8) | priv
->interface
);
597 rv
= usb_control_msg(port
->serial
->dev
,
598 usb_sndctrlpipe(port
->serial
->dev
, 0),
599 FTDI_SIO_SET_BAUDRATE_REQUEST
,
600 FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE
,
601 urb_value
, urb_index
,
602 buf
, 0, WDR_SHORT_TIMEOUT
);
609 static __u32
get_ftdi_divisor(struct usb_serial_port
* port
)
610 { /* get_ftdi_divisor */
611 struct ftdi_private
*priv
= usb_get_serial_port_data(port
);
617 * The logic involved in setting the baudrate can be cleanly split in 3 steps.
618 * Obtaining the actual baud rate is a little tricky since unix traditionally
619 * somehow ignored the possibility to set non-standard baud rates.
620 * 1. Standard baud rates are set in tty->termios->c_cflag
621 * 2. If these are not enough, you can set any speed using alt_speed as follows:
622 * - set tty->termios->c_cflag speed to B38400
623 * - set your real speed in tty->alt_speed; it gets ignored when
625 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
626 * flags & ASYNC_SPD_MASK == ASYNC_SPD_[HI, VHI, SHI, WARP], this just
627 * sets alt_speed to (HI: 57600, VHI: 115200, SHI: 230400, WARP: 460800)
628 * ** Steps 1, 2 are done courtesy of tty_get_baud_rate
629 * 3. You can also set baud rate by setting custom divisor as follows
630 * - set tty->termios->c_cflag speed to B38400
631 * - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
632 * o flags & ASYNC_SPD_MASK == ASYNC_SPD_CUST
633 * o custom_divisor set to baud_base / your_new_baudrate
634 * ** Step 3 is done courtesy of code borrowed from serial.c - I should really
635 * spend some time and separate+move this common code to serial.c, it is
636 * replicated in nearly every serial driver you see.
639 /* 1. Get the baud rate from the tty settings, this observes alt_speed hack */
641 baud
= tty_get_baud_rate(port
->tty
);
642 dbg("%s - tty_get_baud_rate reports speed %d", __func__
, baud
);
644 /* 2. Observe async-compatible custom_divisor hack, update baudrate if needed */
647 ((priv
->flags
& ASYNC_SPD_MASK
) == ASYNC_SPD_CUST
) &&
648 (priv
->custom_divisor
)) {
649 baud
= priv
->baud_base
/ priv
->custom_divisor
;
650 dbg("%s - custom divisor %d sets baud rate to %d", __func__
, priv
->custom_divisor
, baud
);
653 /* 3. Convert baudrate to device-specific divisor */
655 if (!baud
) baud
= 9600;
656 switch(priv
->chip_type
) {
657 case SIO
: /* SIO chip */
659 case 300: div_value
= ftdi_sio_b300
; break;
660 case 600: div_value
= ftdi_sio_b600
; break;
661 case 1200: div_value
= ftdi_sio_b1200
; break;
662 case 2400: div_value
= ftdi_sio_b2400
; break;
663 case 4800: div_value
= ftdi_sio_b4800
; break;
664 case 9600: div_value
= ftdi_sio_b9600
; break;
665 case 19200: div_value
= ftdi_sio_b19200
; break;
666 case 38400: div_value
= ftdi_sio_b38400
; break;
667 case 57600: div_value
= ftdi_sio_b57600
; break;
668 case 115200: div_value
= ftdi_sio_b115200
; break;
670 if (div_value
== 0) {
671 dbg("%s - Baudrate (%d) requested is not supported", __func__
, baud
);
672 div_value
= ftdi_sio_b9600
;
677 case FT8U232AM
: /* 8U232AM chip */
678 if (baud
<= 3000000) {
679 div_value
= ftdi_232am_baud_to_divisor(baud
);
681 dbg("%s - Baud rate too high!", __func__
);
683 div_value
= ftdi_232am_baud_to_divisor(9600);
687 case FT232BM
: /* FT232BM chip */
688 case FT2232C
: /* FT2232C chip */
690 if (baud
<= 3000000) {
691 div_value
= ftdi_232bm_baud_to_divisor(baud
);
693 dbg("%s - Baud rate too high!", __func__
);
694 div_value
= ftdi_232bm_baud_to_divisor(9600);
699 } /* priv->chip_type */
702 dbg("%s - Baud rate set to %d (divisor 0x%lX) on chip %s",
703 __func__
, baud
, (unsigned long)div_value
,
704 ftdi_chip_name
[priv
->chip_type
]);
707 tty_encode_baud_rate(port
->tty
, baud
, baud
);
712 static int get_serial_info(struct usb_serial_port
* port
, struct serial_struct __user
* retinfo
)
714 struct ftdi_private
*priv
= usb_get_serial_port_data(port
);
715 struct serial_struct tmp
;
719 memset(&tmp
, 0, sizeof(tmp
));
720 tmp
.flags
= priv
->flags
;
721 tmp
.baud_base
= priv
->baud_base
;
722 tmp
.custom_divisor
= priv
->custom_divisor
;
723 if (copy_to_user(retinfo
, &tmp
, sizeof(*retinfo
)))
726 } /* get_serial_info */
729 static int set_serial_info(struct usb_serial_port
* port
, struct serial_struct __user
* newinfo
)
730 { /* set_serial_info */
731 struct ftdi_private
*priv
= usb_get_serial_port_data(port
);
732 struct serial_struct new_serial
;
733 struct ftdi_private old_priv
;
735 if (copy_from_user(&new_serial
, newinfo
, sizeof(new_serial
)))
739 /* Do error checking and permission checking */
741 if (!capable(CAP_SYS_ADMIN
)) {
742 if (((new_serial
.flags
& ~ASYNC_USR_MASK
) !=
743 (priv
->flags
& ~ASYNC_USR_MASK
)))
745 priv
->flags
= ((priv
->flags
& ~ASYNC_USR_MASK
) |
746 (new_serial
.flags
& ASYNC_USR_MASK
));
747 priv
->custom_divisor
= new_serial
.custom_divisor
;
751 if ((new_serial
.baud_base
!= priv
->baud_base
) &&
752 (new_serial
.baud_base
< 9600))
755 /* Make the changes - these are privileged changes! */
757 priv
->flags
= ((priv
->flags
& ~ASYNC_FLAGS
) |
758 (new_serial
.flags
& ASYNC_FLAGS
));
759 priv
->custom_divisor
= new_serial
.custom_divisor
;
761 port
->tty
->low_latency
= (priv
->flags
& ASYNC_LOW_LATENCY
) ? 1 : 0;
764 if ((old_priv
.flags
& ASYNC_SPD_MASK
) !=
765 (priv
->flags
& ASYNC_SPD_MASK
)) {
766 if ((priv
->flags
& ASYNC_SPD_MASK
) == ASYNC_SPD_HI
)
767 port
->tty
->alt_speed
= 57600;
768 else if ((priv
->flags
& ASYNC_SPD_MASK
) == ASYNC_SPD_VHI
)
769 port
->tty
->alt_speed
= 115200;
770 else if ((priv
->flags
& ASYNC_SPD_MASK
) == ASYNC_SPD_SHI
)
771 port
->tty
->alt_speed
= 230400;
772 else if ((priv
->flags
& ASYNC_SPD_MASK
) == ASYNC_SPD_WARP
)
773 port
->tty
->alt_speed
= 460800;
775 port
->tty
->alt_speed
= 0;
777 if (((old_priv
.flags
& ASYNC_SPD_MASK
) !=
778 (priv
->flags
& ASYNC_SPD_MASK
)) ||
779 (((priv
->flags
& ASYNC_SPD_MASK
) == ASYNC_SPD_CUST
) &&
780 (old_priv
.custom_divisor
!= priv
->custom_divisor
))) {
786 } /* set_serial_info */
789 /* Determine type of FTDI chip based on USB config and descriptor. */
790 static void ftdi_determine_type(struct usb_serial_port
*port
)
792 struct ftdi_private
*priv
= usb_get_serial_port_data(port
);
793 struct usb_serial
*serial
= port
->serial
;
794 struct usb_device
*udev
= serial
->dev
;
798 /* Assume it is not the original SIO device for now. */
799 priv
->baud_base
= 48000000 / 2;
800 priv
->write_offset
= 0;
802 version
= le16_to_cpu(udev
->descriptor
.bcdDevice
);
803 interfaces
= udev
->actconfig
->desc
.bNumInterfaces
;
804 dbg("%s: bcdDevice = 0x%x, bNumInterfaces = %u", __func__
,
805 version
, interfaces
);
806 if (interfaces
> 1) {
809 /* Multiple interfaces. Assume FT2232C. */
810 priv
->chip_type
= FT2232C
;
811 /* Determine interface code. */
812 inter
= serial
->interface
->altsetting
->desc
.bInterfaceNumber
;
814 priv
->interface
= PIT_SIOA
;
816 priv
->interface
= PIT_SIOB
;
818 /* BM-type devices have a bug where bcdDevice gets set
819 * to 0x200 when iSerialNumber is 0. */
820 if (version
< 0x500) {
821 dbg("%s: something fishy - bcdDevice too low for multi-interface device",
824 } else if (version
< 0x200) {
825 /* Old device. Assume its the original SIO. */
826 priv
->chip_type
= SIO
;
827 priv
->baud_base
= 12000000 / 16;
828 priv
->write_offset
= 1;
829 } else if (version
< 0x400) {
830 /* Assume its an FT8U232AM (or FT8U245AM) */
831 /* (It might be a BM because of the iSerialNumber bug,
832 * but it will still work as an AM device.) */
833 priv
->chip_type
= FT8U232AM
;
834 } else if (version
< 0x600) {
835 /* Assume its an FT232BM (or FT245BM) */
836 priv
->chip_type
= FT232BM
;
838 /* Assume its an FT232R */
839 priv
->chip_type
= FT232RL
;
841 info("Detected %s", ftdi_chip_name
[priv
->chip_type
]);
846 * ***************************************************************************
848 * ***************************************************************************
851 static ssize_t
show_latency_timer(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
853 struct usb_serial_port
*port
= to_usb_serial_port(dev
);
854 struct ftdi_private
*priv
= usb_get_serial_port_data(port
);
855 struct usb_device
*udev
= port
->serial
->dev
;
856 unsigned short latency
= 0;
862 rv
= usb_control_msg(udev
,
863 usb_rcvctrlpipe(udev
, 0),
864 FTDI_SIO_GET_LATENCY_TIMER_REQUEST
,
865 FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE
,
867 (char*) &latency
, 1, WDR_TIMEOUT
);
870 dev_err(dev
, "Unable to read latency timer: %i\n", rv
);
873 return sprintf(buf
, "%i\n", latency
);
876 /* Write a new value of the latency timer, in units of milliseconds. */
877 static ssize_t
store_latency_timer(struct device
*dev
, struct device_attribute
*attr
, const char *valbuf
,
880 struct usb_serial_port
*port
= to_usb_serial_port(dev
);
881 struct ftdi_private
*priv
= usb_get_serial_port_data(port
);
882 struct usb_device
*udev
= port
->serial
->dev
;
884 int v
= simple_strtoul(valbuf
, NULL
, 10);
887 dbg("%s: setting latency timer = %i", __func__
, v
);
889 rv
= usb_control_msg(udev
,
890 usb_sndctrlpipe(udev
, 0),
891 FTDI_SIO_SET_LATENCY_TIMER_REQUEST
,
892 FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE
,
894 buf
, 0, WDR_TIMEOUT
);
897 dev_err(dev
, "Unable to write latency timer: %i\n", rv
);
904 /* Write an event character directly to the FTDI register. The ASCII
905 value is in the low 8 bits, with the enable bit in the 9th bit. */
906 static ssize_t
store_event_char(struct device
*dev
, struct device_attribute
*attr
, const char *valbuf
,
909 struct usb_serial_port
*port
= to_usb_serial_port(dev
);
910 struct ftdi_private
*priv
= usb_get_serial_port_data(port
);
911 struct usb_device
*udev
= port
->serial
->dev
;
913 int v
= simple_strtoul(valbuf
, NULL
, 10);
916 dbg("%s: setting event char = %i", __func__
, v
);
918 rv
= usb_control_msg(udev
,
919 usb_sndctrlpipe(udev
, 0),
920 FTDI_SIO_SET_EVENT_CHAR_REQUEST
,
921 FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE
,
923 buf
, 0, WDR_TIMEOUT
);
926 dbg("Unable to write event character: %i", rv
);
933 static DEVICE_ATTR(latency_timer
, S_IWUSR
| S_IRUGO
, show_latency_timer
, store_latency_timer
);
934 static DEVICE_ATTR(event_char
, S_IWUSR
, NULL
, store_event_char
);
936 static int create_sysfs_attrs(struct usb_serial_port
*port
)
938 struct ftdi_private
*priv
= usb_get_serial_port_data(port
);
943 /* XXX I've no idea if the original SIO supports the event_char
944 * sysfs parameter, so I'm playing it safe. */
945 if (priv
->chip_type
!= SIO
) {
946 dbg("sysfs attributes for %s", ftdi_chip_name
[priv
->chip_type
]);
947 retval
= device_create_file(&port
->dev
, &dev_attr_event_char
);
949 (priv
->chip_type
== FT232BM
||
950 priv
->chip_type
== FT2232C
||
951 priv
->chip_type
== FT232RL
)) {
952 retval
= device_create_file(&port
->dev
,
953 &dev_attr_latency_timer
);
959 static void remove_sysfs_attrs(struct usb_serial_port
*port
)
961 struct ftdi_private
*priv
= usb_get_serial_port_data(port
);
965 /* XXX see create_sysfs_attrs */
966 if (priv
->chip_type
!= SIO
) {
967 device_remove_file(&port
->dev
, &dev_attr_event_char
);
968 if (priv
->chip_type
== FT232BM
||
969 priv
->chip_type
== FT2232C
||
970 priv
->chip_type
== FT232RL
) {
971 device_remove_file(&port
->dev
, &dev_attr_latency_timer
);
978 * ***************************************************************************
979 * FTDI driver specific functions
980 * ***************************************************************************
983 /* Probe function to check for special devices */
984 static int ftdi_sio_probe (struct usb_serial
*serial
, const struct usb_device_id
*id
)
986 struct ftdi_sio_quirk
*quirk
= (struct ftdi_sio_quirk
*)id
->driver_info
;
988 if (quirk
&& quirk
->probe
) {
989 int ret
= quirk
->probe(serial
);
994 usb_set_serial_data(serial
, (void *)id
->driver_info
);
999 static int ftdi_sio_port_probe(struct usb_serial_port
*port
)
1001 struct ftdi_private
*priv
;
1002 struct ftdi_sio_quirk
*quirk
= usb_get_serial_data(port
->serial
);
1007 priv
= kzalloc(sizeof(struct ftdi_private
), GFP_KERNEL
);
1009 err("%s- kmalloc(%Zd) failed.", __func__
, sizeof(struct ftdi_private
));
1013 spin_lock_init(&priv
->rx_lock
);
1014 spin_lock_init(&priv
->tx_lock
);
1015 init_waitqueue_head(&priv
->delta_msr_wait
);
1016 /* This will push the characters through immediately rather
1017 than queue a task to deliver them */
1018 priv
->flags
= ASYNC_LOW_LATENCY
;
1020 if (quirk
&& quirk
->port_probe
)
1021 quirk
->port_probe(priv
);
1023 /* Increase the size of read buffers */
1024 kfree(port
->bulk_in_buffer
);
1025 port
->bulk_in_buffer
= kmalloc (BUFSZ
, GFP_KERNEL
);
1026 if (!port
->bulk_in_buffer
) {
1030 if (port
->read_urb
) {
1031 port
->read_urb
->transfer_buffer
= port
->bulk_in_buffer
;
1032 port
->read_urb
->transfer_buffer_length
= BUFSZ
;
1035 INIT_DELAYED_WORK(&priv
->rx_work
, ftdi_process_read
);
1038 /* Free port's existing write urb and transfer buffer. */
1039 if (port
->write_urb
) {
1040 usb_free_urb (port
->write_urb
);
1041 port
->write_urb
= NULL
;
1043 kfree(port
->bulk_out_buffer
);
1044 port
->bulk_out_buffer
= NULL
;
1046 usb_set_serial_port_data(port
, priv
);
1048 ftdi_determine_type (port
);
1049 create_sysfs_attrs(port
);
1053 /* Setup for the USB-UIRT device, which requires hardwired
1054 * baudrate (38400 gets mapped to 312500) */
1055 /* Called from usbserial:serial_probe */
1056 static void ftdi_USB_UIRT_setup (struct ftdi_private
*priv
)
1060 priv
->flags
|= ASYNC_SPD_CUST
;
1061 priv
->custom_divisor
= 77;
1062 priv
->force_baud
= 38400;
1063 } /* ftdi_USB_UIRT_setup */
1065 /* Setup for the HE-TIRA1 device, which requires hardwired
1066 * baudrate (38400 gets mapped to 100000) and RTS-CTS enabled. */
1067 static void ftdi_HE_TIRA1_setup (struct ftdi_private
*priv
)
1071 priv
->flags
|= ASYNC_SPD_CUST
;
1072 priv
->custom_divisor
= 240;
1073 priv
->force_baud
= 38400;
1074 priv
->force_rtscts
= 1;
1075 } /* ftdi_HE_TIRA1_setup */
1078 * First port on JTAG adaptors such as Olimex arm-usb-ocd or the FIC/OpenMoko
1079 * Neo1973 Debug Board is reserved for JTAG interface and can be accessed from
1080 * userspace using openocd.
1082 static int ftdi_jtag_probe(struct usb_serial
*serial
)
1084 struct usb_device
*udev
= serial
->dev
;
1085 struct usb_interface
*interface
= serial
->interface
;
1089 if (interface
== udev
->actconfig
->interface
[0]) {
1090 info("Ignoring serial port reserved for JTAG");
1098 * The Matrix Orbital VK204-25-USB has an invalid IN endpoint.
1099 * We have to correct it if we want to read from it.
1101 static int ftdi_mtxorb_hack_setup(struct usb_serial
*serial
)
1103 struct usb_host_endpoint
*ep
= serial
->dev
->ep_in
[1];
1104 struct usb_endpoint_descriptor
*ep_desc
= &ep
->desc
;
1106 if (ep
->enabled
&& ep_desc
->wMaxPacketSize
== 0) {
1107 ep_desc
->wMaxPacketSize
= 0x40;
1108 info("Fixing invalid wMaxPacketSize on read pipe");
1114 /* ftdi_shutdown is called from usbserial:usb_serial_disconnect
1115 * it is called when the usb device is disconnected
1117 * usbserial:usb_serial_disconnect
1118 * calls __serial_close for each open of the port
1119 * shutdown is called then (ie ftdi_shutdown)
1121 static void ftdi_shutdown (struct usb_serial
*serial
)
1123 dbg("%s", __func__
);
1126 static int ftdi_sio_port_remove(struct usb_serial_port
*port
)
1128 struct ftdi_private
*priv
= usb_get_serial_port_data(port
);
1130 dbg("%s", __func__
);
1132 remove_sysfs_attrs(port
);
1134 /* all open ports are closed at this point
1135 * (by usbserial.c:__serial_close, which calls ftdi_close)
1139 usb_set_serial_port_data(port
, NULL
);
1146 static int ftdi_open (struct usb_serial_port
*port
, struct file
*filp
)
1148 struct usb_device
*dev
= port
->serial
->dev
;
1149 struct ftdi_private
*priv
= usb_get_serial_port_data(port
);
1150 unsigned long flags
;
1153 char buf
[1]; /* Needed for the usb_control_msg I think */
1155 dbg("%s", __func__
);
1157 spin_lock_irqsave(&priv
->tx_lock
, flags
);
1159 spin_unlock_irqrestore(&priv
->tx_lock
, flags
);
1160 spin_lock_irqsave(&priv
->rx_lock
, flags
);
1162 spin_unlock_irqrestore(&priv
->rx_lock
, flags
);
1165 port
->tty
->low_latency
= (priv
->flags
& ASYNC_LOW_LATENCY
) ? 1 : 0;
1167 /* No error checking for this (will get errors later anyway) */
1168 /* See ftdi_sio.h for description of what is reset */
1169 usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
1170 FTDI_SIO_RESET_REQUEST
, FTDI_SIO_RESET_REQUEST_TYPE
,
1172 priv
->interface
, buf
, 0, WDR_TIMEOUT
);
1174 /* Termios defaults are set by usb_serial_init. We don't change
1175 port->tty->termios - this would loose speed settings, etc.
1176 This is same behaviour as serial.c/rs_open() - Kuba */
1178 /* ftdi_set_termios will send usb control messages */
1180 ftdi_set_termios(port
, port
->tty
->termios
);
1182 /* FIXME: Flow control might be enabled, so it should be checked -
1183 we have no control of defaults! */
1184 /* Turn on RTS and DTR since we are not flow controlling by default */
1185 set_mctrl(port
, TIOCM_DTR
| TIOCM_RTS
);
1188 spin_lock_irqsave(&priv
->rx_lock
, flags
);
1189 priv
->rx_flags
&= ~(THROTTLED
| ACTUALLY_THROTTLED
);
1190 spin_unlock_irqrestore(&priv
->rx_lock
, flags
);
1192 /* Start reading from the device */
1193 priv
->rx_processed
= 0;
1194 usb_fill_bulk_urb(port
->read_urb
, dev
,
1195 usb_rcvbulkpipe(dev
, port
->bulk_in_endpointAddress
),
1196 port
->read_urb
->transfer_buffer
, port
->read_urb
->transfer_buffer_length
,
1197 ftdi_read_bulk_callback
, port
);
1198 result
= usb_submit_urb(port
->read_urb
, GFP_KERNEL
);
1200 err("%s - failed submitting read urb, error %d", __func__
, result
);
1209 * usbserial:__serial_close only calls ftdi_close if the point is open
1211 * This only gets called when it is the last close
1216 static void ftdi_close (struct usb_serial_port
*port
, struct file
*filp
)
1218 unsigned int c_cflag
= port
->tty
->termios
->c_cflag
;
1219 struct ftdi_private
*priv
= usb_get_serial_port_data(port
);
1222 dbg("%s", __func__
);
1224 mutex_lock(&port
->serial
->disc_mutex
);
1225 if (c_cflag
& HUPCL
&& !port
->serial
->disconnected
){
1226 /* Disable flow control */
1227 if (usb_control_msg(port
->serial
->dev
,
1228 usb_sndctrlpipe(port
->serial
->dev
, 0),
1229 FTDI_SIO_SET_FLOW_CTRL_REQUEST
,
1230 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE
,
1231 0, priv
->interface
, buf
, 0,
1233 err("error from flowcontrol urb");
1236 /* drop RTS and DTR */
1237 clear_mctrl(port
, TIOCM_DTR
| TIOCM_RTS
);
1238 } /* Note change no line if hupcl is off */
1239 mutex_unlock(&port
->serial
->disc_mutex
);
1241 /* cancel any scheduled reading */
1242 cancel_delayed_work(&priv
->rx_work
);
1243 flush_scheduled_work();
1245 /* shutdown our bulk read */
1246 usb_kill_urb(port
->read_urb
);
1251 /* The SIO requires the first byte to have:
1254 * B2..7 length of message excluding byte 0
1256 * The new devices do not require this byte
1258 static int ftdi_write (struct usb_serial_port
*port
,
1259 const unsigned char *buf
, int count
)
1261 struct ftdi_private
*priv
= usb_get_serial_port_data(port
);
1263 unsigned char *buffer
;
1264 int data_offset
; /* will be 1 for the SIO and 0 otherwise */
1267 unsigned long flags
;
1269 dbg("%s port %d, %d bytes", __func__
, port
->number
, count
);
1272 dbg("write request of 0 bytes");
1275 spin_lock_irqsave(&priv
->tx_lock
, flags
);
1276 if (priv
->tx_outstanding_urbs
> URB_UPPER_LIMIT
) {
1277 spin_unlock_irqrestore(&priv
->tx_lock
, flags
);
1278 dbg("%s - write limit hit\n", __func__
);
1281 priv
->tx_outstanding_urbs
++;
1282 spin_unlock_irqrestore(&priv
->tx_lock
, flags
);
1284 data_offset
= priv
->write_offset
;
1285 dbg("data_offset set to %d",data_offset
);
1287 /* Determine total transfer size */
1288 transfer_size
= count
;
1289 if (data_offset
> 0) {
1290 /* Original sio needs control bytes too... */
1291 transfer_size
+= (data_offset
*
1292 ((count
+ (PKTSZ
- 1 - data_offset
)) /
1293 (PKTSZ
- data_offset
)));
1296 buffer
= kmalloc (transfer_size
, GFP_ATOMIC
);
1298 err("%s ran out of kernel memory for urb ...", __func__
);
1300 goto error_no_buffer
;
1303 urb
= usb_alloc_urb(0, GFP_ATOMIC
);
1305 err("%s - no more free urbs", __func__
);
1311 if (data_offset
> 0) {
1312 /* Original sio requires control byte at start of each packet. */
1313 int user_pktsz
= PKTSZ
- data_offset
;
1315 unsigned char *first_byte
= buffer
;
1316 const unsigned char *current_position
= buf
;
1319 if (user_pktsz
> todo
) {
1322 /* Write the control byte at the front of the packet*/
1323 *first_byte
= 1 | ((user_pktsz
) << 2);
1324 /* Copy data for packet */
1325 memcpy (first_byte
+ data_offset
,
1326 current_position
, user_pktsz
);
1327 first_byte
+= user_pktsz
+ data_offset
;
1328 current_position
+= user_pktsz
;
1332 /* No control byte required. */
1333 /* Copy in the data to send */
1334 memcpy (buffer
, buf
, count
);
1337 usb_serial_debug_data(debug
, &port
->dev
, __func__
, transfer_size
, buffer
);
1339 /* fill the buffer and send it */
1340 usb_fill_bulk_urb(urb
, port
->serial
->dev
,
1341 usb_sndbulkpipe(port
->serial
->dev
, port
->bulk_out_endpointAddress
),
1342 buffer
, transfer_size
,
1343 ftdi_write_bulk_callback
, port
);
1345 status
= usb_submit_urb(urb
, GFP_ATOMIC
);
1347 err("%s - failed submitting write urb, error %d", __func__
, status
);
1351 spin_lock_irqsave(&priv
->tx_lock
, flags
);
1352 priv
->tx_outstanding_bytes
+= count
;
1353 priv
->tx_bytes
+= count
;
1354 spin_unlock_irqrestore(&priv
->tx_lock
, flags
);
1357 /* we are done with this urb, so let the host driver
1358 * really free it when it is finished with it */
1361 dbg("%s write returning: %d", __func__
, count
);
1368 spin_lock_irqsave(&priv
->tx_lock
, flags
);
1369 priv
->tx_outstanding_urbs
--;
1370 spin_unlock_irqrestore(&priv
->tx_lock
, flags
);
1375 /* This function may get called when the device is closed */
1377 static void ftdi_write_bulk_callback (struct urb
*urb
)
1379 unsigned long flags
;
1380 struct usb_serial_port
*port
= (struct usb_serial_port
*)urb
->context
;
1381 struct ftdi_private
*priv
;
1382 int data_offset
; /* will be 1 for the SIO and 0 otherwise */
1383 unsigned long countback
;
1384 int status
= urb
->status
;
1386 /* free up the transfer buffer, as usb_free_urb() does not do this */
1387 kfree (urb
->transfer_buffer
);
1389 dbg("%s - port %d", __func__
, port
->number
);
1392 dbg("nonzero write bulk status received: %d", status
);
1396 priv
= usb_get_serial_port_data(port
);
1398 dbg("%s - bad port private data pointer - exiting", __func__
);
1401 /* account for transferred data */
1402 countback
= urb
->actual_length
;
1403 data_offset
= priv
->write_offset
;
1404 if (data_offset
> 0) {
1405 /* Subtract the control bytes */
1406 countback
-= (data_offset
* DIV_ROUND_UP(countback
, PKTSZ
));
1408 spin_lock_irqsave(&priv
->tx_lock
, flags
);
1409 --priv
->tx_outstanding_urbs
;
1410 priv
->tx_outstanding_bytes
-= countback
;
1411 spin_unlock_irqrestore(&priv
->tx_lock
, flags
);
1413 usb_serial_port_softint(port
);
1414 } /* ftdi_write_bulk_callback */
1417 static int ftdi_write_room( struct usb_serial_port
*port
)
1419 struct ftdi_private
*priv
= usb_get_serial_port_data(port
);
1421 unsigned long flags
;
1423 dbg("%s - port %d", __func__
, port
->number
);
1425 spin_lock_irqsave(&priv
->tx_lock
, flags
);
1426 if (priv
->tx_outstanding_urbs
< URB_UPPER_LIMIT
) {
1428 * We really can take anything the user throws at us
1429 * but let's pick a nice big number to tell the tty
1430 * layer that we have lots of free space
1436 spin_unlock_irqrestore(&priv
->tx_lock
, flags
);
1438 } /* ftdi_write_room */
1441 static int ftdi_chars_in_buffer (struct usb_serial_port
*port
)
1442 { /* ftdi_chars_in_buffer */
1443 struct ftdi_private
*priv
= usb_get_serial_port_data(port
);
1445 unsigned long flags
;
1447 dbg("%s - port %d", __func__
, port
->number
);
1449 spin_lock_irqsave(&priv
->tx_lock
, flags
);
1450 buffered
= (int)priv
->tx_outstanding_bytes
;
1451 spin_unlock_irqrestore(&priv
->tx_lock
, flags
);
1453 err("%s outstanding tx bytes is negative!", __func__
);
1457 } /* ftdi_chars_in_buffer */
1461 static void ftdi_read_bulk_callback (struct urb
*urb
)
1462 { /* ftdi_read_bulk_callback */
1463 struct usb_serial_port
*port
= (struct usb_serial_port
*)urb
->context
;
1464 struct tty_struct
*tty
;
1465 struct ftdi_private
*priv
;
1466 unsigned long countread
;
1467 unsigned long flags
;
1468 int status
= urb
->status
;
1470 if (urb
->number_of_packets
> 0) {
1471 err("%s transfer_buffer_length %d actual_length %d number of packets %d",__func__
,
1472 urb
->transfer_buffer_length
, urb
->actual_length
, urb
->number_of_packets
);
1473 err("%s transfer_flags %x ", __func__
,urb
->transfer_flags
);
1476 dbg("%s - port %d", __func__
, port
->number
);
1478 if (port
->open_count
<= 0)
1483 dbg("%s - bad tty pointer - exiting",__func__
);
1487 priv
= usb_get_serial_port_data(port
);
1489 dbg("%s - bad port private data pointer - exiting", __func__
);
1493 if (urb
!= port
->read_urb
) {
1494 err("%s - Not my urb!", __func__
);
1498 /* This will happen at close every time so it is a dbg not an err */
1499 dbg("(this is ok on close) nonzero read bulk status received: "
1504 /* count data bytes, but not status bytes */
1505 countread
= urb
->actual_length
;
1506 countread
-= 2 * DIV_ROUND_UP(countread
, PKTSZ
);
1507 spin_lock_irqsave(&priv
->rx_lock
, flags
);
1508 priv
->rx_bytes
+= countread
;
1509 spin_unlock_irqrestore(&priv
->rx_lock
, flags
);
1511 ftdi_process_read(&priv
->rx_work
.work
);
1513 } /* ftdi_read_bulk_callback */
1516 static void ftdi_process_read (struct work_struct
*work
)
1517 { /* ftdi_process_read */
1518 struct ftdi_private
*priv
=
1519 container_of(work
, struct ftdi_private
, rx_work
.work
);
1520 struct usb_serial_port
*port
= priv
->port
;
1522 struct tty_struct
*tty
;
1524 unsigned char *data
;
1530 unsigned long flags
;
1532 dbg("%s - port %d", __func__
, port
->number
);
1534 if (port
->open_count
<= 0)
1539 dbg("%s - bad tty pointer - exiting",__func__
);
1543 priv
= usb_get_serial_port_data(port
);
1545 dbg("%s - bad port private data pointer - exiting", __func__
);
1549 urb
= port
->read_urb
;
1551 dbg("%s - bad read_urb pointer - exiting", __func__
);
1555 data
= urb
->transfer_buffer
;
1557 if (priv
->rx_processed
) {
1558 dbg("%s - already processed: %d bytes, %d remain", __func__
,
1560 urb
->actual_length
- priv
->rx_processed
);
1562 /* The first two bytes of every read packet are status */
1563 if (urb
->actual_length
> 2) {
1564 usb_serial_debug_data(debug
, &port
->dev
, __func__
, urb
->actual_length
, data
);
1566 dbg("Status only: %03oo %03oo",data
[0],data
[1]);
1571 /* TO DO -- check for hung up line and handle appropriately: */
1573 /* See acm.c - you do a tty_hangup - eg tty_hangup(tty) */
1574 /* if CD is dropped and the line is not CLOCAL then we should hangup */
1577 for (packet_offset
= priv
->rx_processed
; packet_offset
< urb
->actual_length
; packet_offset
+= PKTSZ
) {
1580 /* Compare new line status to the old one, signal if different */
1581 /* N.B. packet may be processed more than once, but differences
1582 * are only processed once. */
1584 char new_status
= data
[packet_offset
+0] & FTDI_STATUS_B0_MASK
;
1585 if (new_status
!= priv
->prev_status
) {
1586 priv
->diff_status
|= new_status
^ priv
->prev_status
;
1587 wake_up_interruptible(&priv
->delta_msr_wait
);
1588 priv
->prev_status
= new_status
;
1592 length
= min(PKTSZ
, urb
->actual_length
-packet_offset
)-2;
1594 err("%s - bad packet length: %d", __func__
, length
+2);
1598 if (priv
->rx_flags
& THROTTLED
) {
1599 dbg("%s - throttled", __func__
);
1602 if (tty_buffer_request_room(tty
, length
) < length
) {
1603 /* break out & wait for throttling/unthrottling to happen */
1604 dbg("%s - receive room low", __func__
);
1608 /* Handle errors and break */
1609 error_flag
= TTY_NORMAL
;
1610 /* Although the device uses a bitmask and hence can have multiple */
1611 /* errors on a packet - the order here sets the priority the */
1612 /* error is returned to the tty layer */
1614 if ( data
[packet_offset
+1] & FTDI_RS_OE
) {
1615 error_flag
= TTY_OVERRUN
;
1616 dbg("OVERRRUN error");
1618 if ( data
[packet_offset
+1] & FTDI_RS_BI
) {
1619 error_flag
= TTY_BREAK
;
1620 dbg("BREAK received");
1622 if ( data
[packet_offset
+1] & FTDI_RS_PE
) {
1623 error_flag
= TTY_PARITY
;
1624 dbg("PARITY error");
1626 if ( data
[packet_offset
+1] & FTDI_RS_FE
) {
1627 error_flag
= TTY_FRAME
;
1628 dbg("FRAMING error");
1631 for (i
= 2; i
< length
+2; i
++) {
1632 /* Note that the error flag is duplicated for
1633 every character received since we don't know
1634 which character it applied to */
1635 tty_insert_flip_char(tty
, data
[packet_offset
+i
], error_flag
);
1640 #ifdef NOT_CORRECT_BUT_KEEPING_IT_FOR_NOW
1641 /* if a parity error is detected you get status packets forever
1642 until a character is sent without a parity error.
1643 This doesn't work well since the application receives a never
1644 ending stream of bad data - even though new data hasn't been sent.
1645 Therefore I (bill) have taken this out.
1646 However - this might make sense for framing errors and so on
1647 so I am leaving the code in for now.
1650 if (error_flag
!= TTY_NORMAL
){
1651 dbg("error_flag is not normal");
1652 /* In this case it is just status - if that is an error send a bad character */
1653 if(tty
->flip
.count
>= TTY_FLIPBUF_SIZE
) {
1654 tty_flip_buffer_push(tty
);
1656 tty_insert_flip_char(tty
, 0xff, error_flag
);
1661 } /* "for(packet_offset=0..." */
1665 tty_flip_buffer_push(tty
);
1668 if (packet_offset
< urb
->actual_length
) {
1669 /* not completely processed - record progress */
1670 priv
->rx_processed
= packet_offset
;
1671 dbg("%s - incomplete, %d bytes processed, %d remain",
1672 __func__
, packet_offset
,
1673 urb
->actual_length
- packet_offset
);
1674 /* check if we were throttled while processing */
1675 spin_lock_irqsave(&priv
->rx_lock
, flags
);
1676 if (priv
->rx_flags
& THROTTLED
) {
1677 priv
->rx_flags
|= ACTUALLY_THROTTLED
;
1678 spin_unlock_irqrestore(&priv
->rx_lock
, flags
);
1679 dbg("%s - deferring remainder until unthrottled",
1683 spin_unlock_irqrestore(&priv
->rx_lock
, flags
);
1684 /* if the port is closed stop trying to read */
1685 if (port
->open_count
> 0){
1686 /* delay processing of remainder */
1687 schedule_delayed_work(&priv
->rx_work
, 1);
1689 dbg("%s - port is closed", __func__
);
1694 /* urb is completely processed */
1695 priv
->rx_processed
= 0;
1697 /* if the port is closed stop trying to read */
1698 if (port
->open_count
> 0){
1699 /* Continue trying to always read */
1700 usb_fill_bulk_urb(port
->read_urb
, port
->serial
->dev
,
1701 usb_rcvbulkpipe(port
->serial
->dev
, port
->bulk_in_endpointAddress
),
1702 port
->read_urb
->transfer_buffer
, port
->read_urb
->transfer_buffer_length
,
1703 ftdi_read_bulk_callback
, port
);
1705 result
= usb_submit_urb(port
->read_urb
, GFP_ATOMIC
);
1707 err("%s - failed resubmitting read urb, error %d", __func__
, result
);
1711 } /* ftdi_process_read */
1714 static void ftdi_break_ctl( struct usb_serial_port
*port
, int break_state
)
1716 struct ftdi_private
*priv
= usb_get_serial_port_data(port
);
1717 __u16 urb_value
= 0;
1720 /* break_state = -1 to turn on break, and 0 to turn off break */
1721 /* see drivers/char/tty_io.c to see it used */
1722 /* last_set_data_urb_value NEVER has the break bit set in it */
1725 urb_value
= priv
->last_set_data_urb_value
| FTDI_SIO_SET_BREAK
;
1727 urb_value
= priv
->last_set_data_urb_value
;
1731 if (usb_control_msg(port
->serial
->dev
, usb_sndctrlpipe(port
->serial
->dev
, 0),
1732 FTDI_SIO_SET_DATA_REQUEST
,
1733 FTDI_SIO_SET_DATA_REQUEST_TYPE
,
1734 urb_value
, priv
->interface
,
1735 buf
, 0, WDR_TIMEOUT
) < 0) {
1736 err("%s FAILED to enable/disable break state (state was %d)", __func__
,break_state
);
1739 dbg("%s break state is %d - urb is %d", __func__
,break_state
, urb_value
);
1744 /* old_termios contains the original termios settings and tty->termios contains
1745 * the new setting to be used
1746 * WARNING: set_termios calls this with old_termios in kernel space
1749 static void ftdi_set_termios (struct usb_serial_port
*port
, struct ktermios
*old_termios
)
1750 { /* ftdi_termios */
1751 struct usb_device
*dev
= port
->serial
->dev
;
1752 struct ftdi_private
*priv
= usb_get_serial_port_data(port
);
1753 struct ktermios
*termios
= port
->tty
->termios
;
1754 unsigned int cflag
= termios
->c_cflag
;
1755 __u16 urb_value
; /* will hold the new flags */
1756 char buf
[1]; /* Perhaps I should dynamically alloc this? */
1758 // Added for xon/xoff support
1759 unsigned int iflag
= termios
->c_iflag
;
1760 unsigned char vstop
;
1761 unsigned char vstart
;
1763 dbg("%s", __func__
);
1765 /* Force baud rate if this device requires it, unless it is set to B0. */
1766 if (priv
->force_baud
&& ((termios
->c_cflag
& CBAUD
) != B0
)) {
1767 dbg("%s: forcing baud rate for this device", __func__
);
1768 tty_encode_baud_rate(port
->tty
, priv
->force_baud
,
1772 /* Force RTS-CTS if this device requires it. */
1773 if (priv
->force_rtscts
) {
1774 dbg("%s: forcing rtscts for this device", __func__
);
1775 termios
->c_cflag
|= CRTSCTS
;
1778 cflag
= termios
->c_cflag
;
1780 /* FIXME -For this cut I don't care if the line is really changing or
1781 not - so just do the change regardless - should be able to
1782 compare old_termios and tty->termios */
1783 /* NOTE These routines can get interrupted by
1784 ftdi_sio_read_bulk_callback - need to examine what this
1785 means - don't see any problems yet */
1787 /* Set number of data bits, parity, stop bits */
1789 termios
->c_cflag
&= ~CMSPAR
;
1792 urb_value
|= (cflag
& CSTOPB
? FTDI_SIO_SET_DATA_STOP_BITS_2
:
1793 FTDI_SIO_SET_DATA_STOP_BITS_1
);
1794 urb_value
|= (cflag
& PARENB
?
1795 (cflag
& PARODD
? FTDI_SIO_SET_DATA_PARITY_ODD
:
1796 FTDI_SIO_SET_DATA_PARITY_EVEN
) :
1797 FTDI_SIO_SET_DATA_PARITY_NONE
);
1798 if (cflag
& CSIZE
) {
1799 switch (cflag
& CSIZE
) {
1800 case CS5
: urb_value
|= 5; dbg("Setting CS5"); break;
1801 case CS6
: urb_value
|= 6; dbg("Setting CS6"); break;
1802 case CS7
: urb_value
|= 7; dbg("Setting CS7"); break;
1803 case CS8
: urb_value
|= 8; dbg("Setting CS8"); break;
1805 err("CSIZE was set but not CS5-CS8");
1809 /* This is needed by the break command since it uses the same command - but is
1810 * or'ed with this value */
1811 priv
->last_set_data_urb_value
= urb_value
;
1813 if (usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
1814 FTDI_SIO_SET_DATA_REQUEST
,
1815 FTDI_SIO_SET_DATA_REQUEST_TYPE
,
1816 urb_value
, priv
->interface
,
1817 buf
, 0, WDR_SHORT_TIMEOUT
) < 0) {
1818 err("%s FAILED to set databits/stopbits/parity", __func__
);
1821 /* Now do the baudrate */
1822 if ((cflag
& CBAUD
) == B0
) {
1823 /* Disable flow control */
1824 if (usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
1825 FTDI_SIO_SET_FLOW_CTRL_REQUEST
,
1826 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE
,
1828 buf
, 0, WDR_TIMEOUT
) < 0) {
1829 err("%s error from disable flowcontrol urb", __func__
);
1831 /* Drop RTS and DTR */
1832 clear_mctrl(port
, TIOCM_DTR
| TIOCM_RTS
);
1834 /* set the baudrate determined before */
1835 if (change_speed(port
)) {
1836 err("%s urb failed to set baudrate", __func__
);
1838 /* Ensure RTS and DTR are raised when baudrate changed from 0 */
1839 if (!old_termios
|| (old_termios
->c_cflag
& CBAUD
) == B0
) {
1840 set_mctrl(port
, TIOCM_DTR
| TIOCM_RTS
);
1844 /* Set flow control */
1845 /* Note device also supports DTR/CD (ugh) and Xon/Xoff in hardware */
1846 if (cflag
& CRTSCTS
) {
1847 dbg("%s Setting to CRTSCTS flow control", __func__
);
1848 if (usb_control_msg(dev
,
1849 usb_sndctrlpipe(dev
, 0),
1850 FTDI_SIO_SET_FLOW_CTRL_REQUEST
,
1851 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE
,
1852 0 , (FTDI_SIO_RTS_CTS_HS
| priv
->interface
),
1853 buf
, 0, WDR_TIMEOUT
) < 0) {
1854 err("urb failed to set to rts/cts flow control");
1861 * Check the IXOFF status in the iflag component of the termios structure
1862 * if IXOFF is not set, the pre-xon/xoff code is executed.
1864 if (iflag
& IXOFF
) {
1865 dbg("%s request to enable xonxoff iflag=%04x",__func__
,iflag
);
1866 // Try to enable the XON/XOFF on the ftdi_sio
1867 // Set the vstart and vstop -- could have been done up above where
1868 // a lot of other dereferencing is done but that would be very
1869 // inefficient as vstart and vstop are not always needed
1870 vstart
= termios
->c_cc
[VSTART
];
1871 vstop
= termios
->c_cc
[VSTOP
];
1872 urb_value
=(vstop
<< 8) | (vstart
);
1874 if (usb_control_msg(dev
,
1875 usb_sndctrlpipe(dev
, 0),
1876 FTDI_SIO_SET_FLOW_CTRL_REQUEST
,
1877 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE
,
1878 urb_value
, (FTDI_SIO_XON_XOFF_HS
1880 buf
, 0, WDR_TIMEOUT
) < 0) {
1881 err("urb failed to set to xon/xoff flow control");
1884 /* else clause to only run if cfag ! CRTSCTS and iflag ! XOFF */
1885 /* CHECKME Assuming XON/XOFF handled by tty stack - not by device */
1886 dbg("%s Turning off hardware flow control", __func__
);
1887 if (usb_control_msg(dev
,
1888 usb_sndctrlpipe(dev
, 0),
1889 FTDI_SIO_SET_FLOW_CTRL_REQUEST
,
1890 FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE
,
1892 buf
, 0, WDR_TIMEOUT
) < 0) {
1893 err("urb failed to clear flow control");
1899 } /* ftdi_termios */
1902 static int ftdi_tiocmget (struct usb_serial_port
*port
, struct file
*file
)
1904 struct ftdi_private
*priv
= usb_get_serial_port_data(port
);
1905 unsigned char buf
[2];
1908 dbg("%s TIOCMGET", __func__
);
1909 switch (priv
->chip_type
) {
1911 /* Request the status from the device */
1912 if ((ret
= usb_control_msg(port
->serial
->dev
,
1913 usb_rcvctrlpipe(port
->serial
->dev
, 0),
1914 FTDI_SIO_GET_MODEM_STATUS_REQUEST
,
1915 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE
,
1917 buf
, 1, WDR_TIMEOUT
)) < 0 ) {
1918 err("%s Could not get modem status of device - err: %d", __func__
,
1927 /* the 8U232AM returns a two byte value (the sio is a 1 byte value) - in the same
1928 format as the data returned from the in point */
1929 if ((ret
= usb_control_msg(port
->serial
->dev
,
1930 usb_rcvctrlpipe(port
->serial
->dev
, 0),
1931 FTDI_SIO_GET_MODEM_STATUS_REQUEST
,
1932 FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE
,
1934 buf
, 2, WDR_TIMEOUT
)) < 0 ) {
1935 err("%s Could not get modem status of device - err: %d", __func__
,
1945 return (buf
[0] & FTDI_SIO_DSR_MASK
? TIOCM_DSR
: 0) |
1946 (buf
[0] & FTDI_SIO_CTS_MASK
? TIOCM_CTS
: 0) |
1947 (buf
[0] & FTDI_SIO_RI_MASK
? TIOCM_RI
: 0) |
1948 (buf
[0] & FTDI_SIO_RLSD_MASK
? TIOCM_CD
: 0) |
1952 static int ftdi_tiocmset(struct usb_serial_port
*port
, struct file
* file
, unsigned int set
, unsigned int clear
)
1954 dbg("%s TIOCMSET", __func__
);
1955 return update_mctrl(port
, set
, clear
);
1959 static int ftdi_ioctl (struct usb_serial_port
*port
, struct file
* file
, unsigned int cmd
, unsigned long arg
)
1961 struct ftdi_private
*priv
= usb_get_serial_port_data(port
);
1963 dbg("%s cmd 0x%04x", __func__
, cmd
);
1965 /* Based on code from acm.c and others */
1968 case TIOCGSERIAL
: /* gets serial port data */
1969 return get_serial_info(port
, (struct serial_struct __user
*) arg
);
1971 case TIOCSSERIAL
: /* sets serial port data */
1972 return set_serial_info(port
, (struct serial_struct __user
*) arg
);
1975 * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1976 * - mask passed in arg for lines of interest
1977 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1978 * Caller should use TIOCGICOUNT to see which one it was.
1980 * This code is borrowed from linux/drivers/char/serial.c
1983 while (priv
!= NULL
) {
1984 interruptible_sleep_on(&priv
->delta_msr_wait
);
1985 /* see if a signal did it */
1986 if (signal_pending(current
))
1987 return -ERESTARTSYS
;
1989 char diff
= priv
->diff_status
;
1992 return -EIO
; /* no change => error */
1995 /* Consume all events */
1996 priv
->diff_status
= 0;
1998 /* Return 0 if caller wanted to know about these bits */
1999 if ( ((arg
& TIOCM_RNG
) && (diff
& FTDI_RS0_RI
)) ||
2000 ((arg
& TIOCM_DSR
) && (diff
& FTDI_RS0_DSR
)) ||
2001 ((arg
& TIOCM_CD
) && (diff
& FTDI_RS0_RLSD
)) ||
2002 ((arg
& TIOCM_CTS
) && (diff
& FTDI_RS0_CTS
)) ) {
2006 * Otherwise caller can't care less about what happened,
2007 * and so we continue to wait for more events.
2019 /* This is not necessarily an error - turns out the higher layers will do
2020 * some ioctls itself (see comment above)
2022 dbg("%s arg not supported - it was 0x%04x - check /usr/include/asm/ioctls.h", __func__
, cmd
);
2024 return(-ENOIOCTLCMD
);
2028 static void ftdi_throttle (struct usb_serial_port
*port
)
2030 struct ftdi_private
*priv
= usb_get_serial_port_data(port
);
2031 unsigned long flags
;
2033 dbg("%s - port %d", __func__
, port
->number
);
2035 spin_lock_irqsave(&priv
->rx_lock
, flags
);
2036 priv
->rx_flags
|= THROTTLED
;
2037 spin_unlock_irqrestore(&priv
->rx_lock
, flags
);
2041 static void ftdi_unthrottle (struct usb_serial_port
*port
)
2043 struct ftdi_private
*priv
= usb_get_serial_port_data(port
);
2044 int actually_throttled
;
2045 unsigned long flags
;
2047 dbg("%s - port %d", __func__
, port
->number
);
2049 spin_lock_irqsave(&priv
->rx_lock
, flags
);
2050 actually_throttled
= priv
->rx_flags
& ACTUALLY_THROTTLED
;
2051 priv
->rx_flags
&= ~(THROTTLED
| ACTUALLY_THROTTLED
);
2052 spin_unlock_irqrestore(&priv
->rx_lock
, flags
);
2054 if (actually_throttled
)
2055 schedule_delayed_work(&priv
->rx_work
, 0);
2058 static int __init
ftdi_init (void)
2062 dbg("%s", __func__
);
2063 if (vendor
> 0 && product
> 0) {
2064 /* Add user specified VID/PID to reserved element of table. */
2066 for (i
= 0; id_table_combined
[i
].idVendor
; i
++)
2068 id_table_combined
[i
].match_flags
= USB_DEVICE_ID_MATCH_DEVICE
;
2069 id_table_combined
[i
].idVendor
= vendor
;
2070 id_table_combined
[i
].idProduct
= product
;
2072 retval
= usb_serial_register(&ftdi_sio_device
);
2074 goto failed_sio_register
;
2075 retval
= usb_register(&ftdi_driver
);
2077 goto failed_usb_register
;
2079 info(DRIVER_VERSION
":" DRIVER_DESC
);
2081 failed_usb_register
:
2082 usb_serial_deregister(&ftdi_sio_device
);
2083 failed_sio_register
:
2088 static void __exit
ftdi_exit (void)
2091 dbg("%s", __func__
);
2093 usb_deregister (&ftdi_driver
);
2094 usb_serial_deregister (&ftdi_sio_device
);
2099 module_init(ftdi_init
);
2100 module_exit(ftdi_exit
);
2102 MODULE_AUTHOR( DRIVER_AUTHOR
);
2103 MODULE_DESCRIPTION( DRIVER_DESC
);
2104 MODULE_LICENSE("GPL");
2106 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
2107 MODULE_PARM_DESC(debug
, "Debug enabled or not");
2108 module_param(vendor
, ushort
, 0);
2109 MODULE_PARM_DESC(vendor
, "User specified vendor ID (default="
2110 __MODULE_STRING(FTDI_VID
)")");
2111 module_param(product
, ushort
, 0);
2112 MODULE_PARM_DESC(vendor
, "User specified product ID");