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