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