drivers/usb/serial/ftdi_sio.h

   1 /*
   2  * Definitions for the FTDI USB Single Port Serial Converter -
   3  * known as FTDI_SIO (Serial Input/Output application of the chipset)
   4  *
   5  * The example I have is known as the USC-1000 which is available from
   6  * http://www.dse.co.nz - cat no XH4214 It looks similar to this:
   7  * http://www.dansdata.com/usbser.htm but I can't be sure There are other
   8  * USC-1000s which don't look like my device though so beware!
   9  *
  10  * The device is based on the FTDI FT8U100AX chip. It has a DB25 on one side,
  11  * USB on the other.
  12  *
  13  * Thanx to FTDI (http://www.ftdi.co.uk) for so kindly providing details
  14  * of the protocol required to talk to the device and ongoing assistence
  15  * during development.
  16  *
  17  * Bill Ryder - bryder@sgi.com formerly of Silicon Graphics, Inc.- wrote the
  18  * FTDI_SIO implementation.
  19  *
  20  * Philipp Gühring - pg@futureware.at - added the Device ID of the USB relais
  21  * from Rudolf Gugler
  22  *
  23  */
  24
  25 #define FTDI_VID        0x0403  /* Vendor Id */
  26 #define FTDI_SIO_PID    0x8372  /* Product Id SIO application of 8U100AX  */
  27 #define FTDI_8U232AM_PID 0x6001 /* Similar device to SIO above */
  28 #define FTDI_8U232AM_ALT_PID 0x6006 /* FTDI's alternate PID for above */
  29 #define FTDI_8U2232C_PID 0x6010 /* Dual channel device */
  30 #define FTDI_232RL_PID  0xFBFA  /* Product ID for FT232RL */
  31 #define FTDI_RELAIS_PID 0xFA10  /* Relais device from Rudolf Gugler */
  32 #define FTDI_NF_RIC_VID 0x0DCD  /* Vendor Id */
  33 #define FTDI_NF_RIC_PID 0x0001  /* Product Id */
  34 #define FTDI_USBX_707_PID 0xF857        /* ADSTech IR Blaster USBX-707 */
  35
  36
  37 /* www.canusb.com Lawicel CANUSB device */
  38 #define FTDI_CANUSB_PID 0xFFA8 /* Product Id */
  39
  40 /* AlphaMicro Components AMC-232USB01 device */
  41 #define FTDI_AMC232_PID 0xFF00 /* Product Id */
  42
  43 /* SCS HF Radio Modems PID's (http://www.scs-ptc.com) */
  44 /* the VID is the standard ftdi vid (FTDI_VID) */
  45 #define FTDI_SCS_DEVICE_0_PID 0xD010    /* SCS PTC-IIusb */
  46 #define FTDI_SCS_DEVICE_1_PID 0xD011    /* SCS Tracker / DSP TNC */
  47 #define FTDI_SCS_DEVICE_2_PID 0xD012
  48 #define FTDI_SCS_DEVICE_3_PID 0xD013
  49 #define FTDI_SCS_DEVICE_4_PID 0xD014
  50 #define FTDI_SCS_DEVICE_5_PID 0xD015
  51 #define FTDI_SCS_DEVICE_6_PID 0xD016
  52 #define FTDI_SCS_DEVICE_7_PID 0xD017
  53
  54 /* ACT Solutions HomePro ZWave interface (http://www.act-solutions.com/HomePro.htm) */
  55 #define FTDI_ACTZWAVE_PID       0xF2D0
  56
  57
  58 /* www.starting-point-systems.com µChameleon device */
  59 #define FTDI_MICRO_CHAMELEON_PID        0xCAA0  /* Product Id */
  60
  61 /* www.irtrans.de device */
  62 #define FTDI_IRTRANS_PID 0xFC60 /* Product Id */
  63
  64
  65 /* www.thoughttechnology.com/ TT-USB provide with procomp use ftdi_sio */
  66 #define FTDI_TTUSB_PID 0xFF20 /* Product Id */
  67
  68 /* iPlus device */
  69 #define FTDI_IPLUS_PID 0xD070 /* Product Id */
  70 #define FTDI_IPLUS2_PID 0xD071 /* Product Id */
  71
  72 /* DMX4ALL DMX Interfaces */
  73 #define FTDI_DMX4ALL 0xC850
  74
  75 /* OpenDCC (www.opendcc.de) product id */
  76 #define FTDI_OPENDCC_PID        0xBFD8
  77
  78 /* www.crystalfontz.com devices - thanx for providing free devices for evaluation ! */
  79 /* they use the ftdi chipset for the USB interface and the vendor id is the same */
  80 #define FTDI_XF_632_PID 0xFC08  /* 632: 16x2 Character Display */
  81 #define FTDI_XF_634_PID 0xFC09  /* 634: 20x4 Character Display */
  82 #define FTDI_XF_547_PID 0xFC0A  /* 547: Two line Display */
  83 #define FTDI_XF_633_PID 0xFC0B  /* 633: 16x2 Character Display with Keys */
  84 #define FTDI_XF_631_PID 0xFC0C  /* 631: 20x2 Character Display */
  85 #define FTDI_XF_635_PID 0xFC0D  /* 635: 20x4 Character Display */
  86 #define FTDI_XF_640_PID 0xFC0E  /* 640: Two line Display */
  87 #define FTDI_XF_642_PID 0xFC0F  /* 642: Two line Display */
  88
  89 /* Video Networks Limited / Homechoice in the UK use an ftdi-based device for their 1Mb */
  90 /* broadband internet service.  The following PID is exhibited by the usb device supplied */
  91 /* (the VID is the standard ftdi vid (FTDI_VID) */
  92 #define FTDI_VNHCPCUSB_D_PID 0xfe38 /* Product Id */
  93
  94 /*
  95  * PCDJ use ftdi based dj-controllers.  The following PID is for their DAC-2 device
  96  * http://www.pcdjhardware.com/DAC2.asp (PID sent by Wouter Paesen)
  97  * (the VID is the standard ftdi vid (FTDI_VID) */
  98 #define FTDI_PCDJ_DAC2_PID 0xFA88
  99
 100 /*
 101  * The following are the values for the Matrix Orbital LCD displays,
 102  * which are the FT232BM ( similar to the 8U232AM )
 103  */
 104 #define FTDI_MTXORB_0_PID      0xFA00  /* Matrix Orbital Product Id */
 105 #define FTDI_MTXORB_1_PID      0xFA01  /* Matrix Orbital Product Id */
 106 #define FTDI_MTXORB_2_PID      0xFA02  /* Matrix Orbital Product Id */
 107 #define FTDI_MTXORB_3_PID      0xFA03  /* Matrix Orbital Product Id */
 108 #define FTDI_MTXORB_4_PID      0xFA04  /* Matrix Orbital Product Id */
 109 #define FTDI_MTXORB_5_PID      0xFA05  /* Matrix Orbital Product Id */
 110 #define FTDI_MTXORB_6_PID      0xFA06  /* Matrix Orbital Product Id */
 111
 112 /* OOCDlink by Joern Kaipf <joernk@web.de>
 113  * (http://www.joernonline.de/dw/doku.php?id=start&idx=projects:oocdlink) */
 114 #define FTDI_OOCDLINK_PID       0xbaf8  /* Amontec JTAGkey */
 115
 116 /*
 117  * The following are the values for the Matrix Orbital VK204-25-USB
 118  * display, which use the FT232RL.
 119  */
 120 #define MTXORB_VK_VID           0x1b3d
 121 #define MTXORB_VK_PID           0x0158
 122
 123 /* Interbiometrics USB I/O Board */
 124 /* Developed for Interbiometrics by Rudolf Gugler */
 125 #define INTERBIOMETRICS_VID              0x1209
 126 #define INTERBIOMETRICS_IOBOARD_PID      0x1002
 127 #define INTERBIOMETRICS_MINI_IOBOARD_PID 0x1006
 128
 129 /*
 130  * The following are the values for the Perle Systems
 131  * UltraPort USB serial converters
 132  */
 133 #define FTDI_PERLE_ULTRAPORT_PID 0xF0C0 /* Perle UltraPort Product Id */
 134
 135 /*
 136  * The following are the values for the Sealevel SeaLINK+ adapters.
 137  * (Original list sent by Tuan Hoang.  Ian Abbott renamed the macros and
 138  * removed some PIDs that don't seem to match any existing products.)
 139  */
 140 #define SEALEVEL_VID            0x0c52  /* Sealevel Vendor ID */
 141 #define SEALEVEL_2101_PID       0x2101  /* SeaLINK+232 (2101/2105) */
 142 #define SEALEVEL_2102_PID       0x2102  /* SeaLINK+485 (2102) */
 143 #define SEALEVEL_2103_PID       0x2103  /* SeaLINK+232I (2103) */
 144 #define SEALEVEL_2104_PID       0x2104  /* SeaLINK+485I (2104) */
 145 #define SEALEVEL_2106_PID       0x9020  /* SeaLINK+422 (2106) */
 146 #define SEALEVEL_2201_1_PID     0x2211  /* SeaPORT+2/232 (2201) Port 1 */
 147 #define SEALEVEL_2201_2_PID     0x2221  /* SeaPORT+2/232 (2201) Port 2 */
 148 #define SEALEVEL_2202_1_PID     0x2212  /* SeaPORT+2/485 (2202) Port 1 */
 149 #define SEALEVEL_2202_2_PID     0x2222  /* SeaPORT+2/485 (2202) Port 2 */
 150 #define SEALEVEL_2203_1_PID     0x2213  /* SeaPORT+2 (2203) Port 1 */
 151 #define SEALEVEL_2203_2_PID     0x2223  /* SeaPORT+2 (2203) Port 2 */
 152 #define SEALEVEL_2401_1_PID     0x2411  /* SeaPORT+4/232 (2401) Port 1 */
 153 #define SEALEVEL_2401_2_PID     0x2421  /* SeaPORT+4/232 (2401) Port 2 */
 154 #define SEALEVEL_2401_3_PID     0x2431  /* SeaPORT+4/232 (2401) Port 3 */
 155 #define SEALEVEL_2401_4_PID     0x2441  /* SeaPORT+4/232 (2401) Port 4 */
 156 #define SEALEVEL_2402_1_PID     0x2412  /* SeaPORT+4/485 (2402) Port 1 */
 157 #define SEALEVEL_2402_2_PID     0x2422  /* SeaPORT+4/485 (2402) Port 2 */
 158 #define SEALEVEL_2402_3_PID     0x2432  /* SeaPORT+4/485 (2402) Port 3 */
 159 #define SEALEVEL_2402_4_PID     0x2442  /* SeaPORT+4/485 (2402) Port 4 */
 160 #define SEALEVEL_2403_1_PID     0x2413  /* SeaPORT+4 (2403) Port 1 */
 161 #define SEALEVEL_2403_2_PID     0x2423  /* SeaPORT+4 (2403) Port 2 */
 162 #define SEALEVEL_2403_3_PID     0x2433  /* SeaPORT+4 (2403) Port 3 */
 163 #define SEALEVEL_2403_4_PID     0x2443  /* SeaPORT+4 (2403) Port 4 */
 164 #define SEALEVEL_2801_1_PID     0X2811  /* SeaLINK+8/232 (2801) Port 1 */
 165 #define SEALEVEL_2801_2_PID     0X2821  /* SeaLINK+8/232 (2801) Port 2 */
 166 #define SEALEVEL_2801_3_PID     0X2831  /* SeaLINK+8/232 (2801) Port 3 */
 167 #define SEALEVEL_2801_4_PID     0X2841  /* SeaLINK+8/232 (2801) Port 4 */
 168 #define SEALEVEL_2801_5_PID     0X2851  /* SeaLINK+8/232 (2801) Port 5 */
 169 #define SEALEVEL_2801_6_PID     0X2861  /* SeaLINK+8/232 (2801) Port 6 */
 170 #define SEALEVEL_2801_7_PID     0X2871  /* SeaLINK+8/232 (2801) Port 7 */
 171 #define SEALEVEL_2801_8_PID     0X2881  /* SeaLINK+8/232 (2801) Port 8 */
 172 #define SEALEVEL_2802_1_PID     0X2812  /* SeaLINK+8/485 (2802) Port 1 */
 173 #define SEALEVEL_2802_2_PID     0X2822  /* SeaLINK+8/485 (2802) Port 2 */
 174 #define SEALEVEL_2802_3_PID     0X2832  /* SeaLINK+8/485 (2802) Port 3 */
 175 #define SEALEVEL_2802_4_PID     0X2842  /* SeaLINK+8/485 (2802) Port 4 */
 176 #define SEALEVEL_2802_5_PID     0X2852  /* SeaLINK+8/485 (2802) Port 5 */
 177 #define SEALEVEL_2802_6_PID     0X2862  /* SeaLINK+8/485 (2802) Port 6 */
 178 #define SEALEVEL_2802_7_PID     0X2872  /* SeaLINK+8/485 (2802) Port 7 */
 179 #define SEALEVEL_2802_8_PID     0X2882  /* SeaLINK+8/485 (2802) Port 8 */
 180 #define SEALEVEL_2803_1_PID     0X2813  /* SeaLINK+8 (2803) Port 1 */
 181 #define SEALEVEL_2803_2_PID     0X2823  /* SeaLINK+8 (2803) Port 2 */
 182 #define SEALEVEL_2803_3_PID     0X2833  /* SeaLINK+8 (2803) Port 3 */
 183 #define SEALEVEL_2803_4_PID     0X2843  /* SeaLINK+8 (2803) Port 4 */
 184 #define SEALEVEL_2803_5_PID     0X2853  /* SeaLINK+8 (2803) Port 5 */
 185 #define SEALEVEL_2803_6_PID     0X2863  /* SeaLINK+8 (2803) Port 6 */
 186 #define SEALEVEL_2803_7_PID     0X2873  /* SeaLINK+8 (2803) Port 7 */
 187 #define SEALEVEL_2803_8_PID     0X2883  /* SeaLINK+8 (2803) Port 8 */
 188
 189 /*
 190  * The following are the values for two KOBIL chipcard terminals.
 191  */
 192 #define KOBIL_VID               0x0d46  /* KOBIL Vendor ID */
 193 #define KOBIL_CONV_B1_PID       0x2020  /* KOBIL Konverter for B1 */
 194 #define KOBIL_CONV_KAAN_PID     0x2021  /* KOBIL_Konverter for KAAN */
 195
 196 /*
 197  * Icom ID-1 digital transceiver
 198  */
 199
 200 #define ICOM_ID1_VID            0x0C26
 201 #define ICOM_ID1_PID            0x0004
 202
 203 /*
 204  * ASK.fr devices
 205  */
 206 #define FTDI_ASK_RDR400_PID     0xC991  /* ASK RDR 400 series card reader */
 207
 208 /*
 209  * FTDI USB UART chips used in construction projects from the
 210  * Elektor Electronics magazine (http://elektor-electronics.co.uk)
 211  */
 212 #define ELEKTOR_VID             0x0C7D
 213 #define ELEKTOR_FT323R_PID      0x0005  /* RFID-Reader, issue 09-2006 */
 214
 215 /*
 216  * DSS-20 Sync Station for Sony Ericsson P800
 217  */
 218 #define FTDI_DSS20_PID          0xFC82
 219
 220 /*
 221  * Home Electronics (www.home-electro.com) USB gadgets
 222  */
 223 #define FTDI_HE_TIRA1_PID       0xFA78  /* Tira-1 IR transceiver */
 224
 225 /* USB-UIRT - An infrared receiver and transmitter using the 8U232AM chip */
 226 /* http://home.earthlink.net/~jrhees/USBUIRT/index.htm */
 227 #define FTDI_USB_UIRT_PID       0xF850  /* Product Id */
 228
 229 /* TNC-X USB-to-packet-radio adapter, versions prior to 3.0 (DLP module) */
 230
 231 #define FTDI_TNC_X_PID          0xEBE0
 232
 233 /*
 234  * ELV USB devices submitted by Christian Abt of ELV (www.elv.de).
 235  * All of these devices use FTDI's vendor ID (0x0403).
 236  *
 237  * The previously included PID for the UO 100 module was incorrect.
 238  * In fact, that PID was for ELV's UR 100 USB-RS232 converter (0xFB58).
 239  *
 240  * Armin Laeuger originally sent the PID for the UM 100 module.
 241  */
 242 #define FTDI_ELV_UR100_PID      0xFB58  /* USB-RS232-Umsetzer (UR 100) */
 243 #define FTDI_ELV_UM100_PID      0xFB5A  /* USB-Modul UM 100 */
 244 #define FTDI_ELV_UO100_PID      0xFB5B  /* USB-Modul UO 100 */
 245 #define FTDI_ELV_ALC8500_PID    0xF06E  /* ALC 8500 Expert */
 246 /* Additional ELV PIDs that default to using the FTDI D2XX drivers on
 247  * MS Windows, rather than the FTDI Virtual Com Port drivers.
 248  * Maybe these will be easier to use with the libftdi/libusb user-space
 249  * drivers, or possibly the Comedi drivers in some cases. */
 250 #define FTDI_ELV_CLI7000_PID    0xFB59  /* Computer-Light-Interface (CLI 7000) */
 251 #define FTDI_ELV_PPS7330_PID    0xFB5C  /* Processor-Power-Supply (PPS 7330) */
 252 #define FTDI_ELV_TFM100_PID     0xFB5D  /* Temperartur-Feuchte Messgeraet (TFM 100) */
 253 #define FTDI_ELV_UDF77_PID      0xFB5E  /* USB DCF Funkurh (UDF 77) */
 254 #define FTDI_ELV_UIO88_PID      0xFB5F  /* USB-I/O Interface (UIO 88) */
 255 #define FTDI_ELV_UAD8_PID       0xF068  /* USB-AD-Wandler (UAD 8) */
 256 #define FTDI_ELV_UDA7_PID       0xF069  /* USB-DA-Wandler (UDA 7) */
 257 #define FTDI_ELV_USI2_PID       0xF06A  /* USB-Schrittmotoren-Interface (USI 2) */
 258 #define FTDI_ELV_T1100_PID      0xF06B  /* Thermometer (T 1100) */
 259 #define FTDI_ELV_PCD200_PID     0xF06C  /* PC-Datenlogger (PCD 200) */
 260 #define FTDI_ELV_ULA200_PID     0xF06D  /* USB-LCD-Ansteuerung (ULA 200) */
 261 #define FTDI_ELV_FHZ1000PC_PID  0xF06F  /* FHZ 1000 PC */
 262 #define FTDI_ELV_CSI8_PID       0xE0F0  /* Computer-Schalt-Interface (CSI 8) */
 263 #define FTDI_ELV_EM1000DL_PID   0xE0F1  /* PC-Datenlogger fuer Energiemonitor (EM 1000 DL) */
 264 #define FTDI_ELV_PCK100_PID     0xE0F2  /* PC-Kabeltester (PCK 100) */
 265 #define FTDI_ELV_RFP500_PID     0xE0F3  /* HF-Leistungsmesser (RFP 500) */
 266 #define FTDI_ELV_FS20SIG_PID    0xE0F4  /* Signalgeber (FS 20 SIG) */
 267 #define FTDI_ELV_WS300PC_PID    0xE0F6  /* PC-Wetterstation (WS 300 PC) */
 268 #define FTDI_ELV_FHZ1300PC_PID  0xE0E8  /* FHZ 1300 PC */
 269 #define FTDI_ELV_WS500_PID      0xE0E9  /* PC-Wetterstation (WS 500) */
 270 #define FTDI_ELV_EM1010PC_PID   0xE0EF  /* Engery monitor EM 1010 PC */
 271
 272 /*
 273  * Definitions for ID TECH (www.idt-net.com) devices
 274  */
 275 #define IDTECH_VID              0x0ACD  /* ID TECH Vendor ID */
 276 #define IDTECH_IDT1221U_PID     0x0300  /* IDT1221U USB to RS-232 adapter */
 277
 278 /*
 279  * Definitions for Omnidirectional Control Technology, Inc. devices
 280  */
 281 #define OCT_VID                 0x0B39  /* OCT vendor ID */
 282 /* Note: OCT US101 is also rebadged as Dick Smith Electronics (NZ) XH6381 */
 283 /* Also rebadged as Dick Smith Electronics (Aus) XH6451 */
 284 /* Also rebadged as SIIG Inc. model US2308 hardware version 1 */
 285 #define OCT_US101_PID           0x0421  /* OCT US101 USB to RS-232 */
 286
 287 /* an infrared receiver for user access control with IR tags */
 288 #define FTDI_PIEGROUP_PID       0xF208  /* Product Id */
 289
 290 /*
 291  * Definitions for Artemis astronomical USB based cameras
 292  * Check it at http://www.artemisccd.co.uk/
 293  */
 294 #define FTDI_ARTEMIS_PID        0xDF28  /* All Artemis Cameras */
 295
 296 /*
 297  * Definitions for ATIK Instruments astronomical USB based cameras
 298  * Check it at http://www.atik-instruments.com/
 299  */
 300 #define FTDI_ATIK_ATK16_PID     0xDF30  /* ATIK ATK-16 Grayscale Camera */
 301 #define FTDI_ATIK_ATK16C_PID    0xDF32  /* ATIK ATK-16C Colour Camera */
 302 #define FTDI_ATIK_ATK16HR_PID   0xDF31  /* ATIK ATK-16HR Grayscale Camera */
 303 #define FTDI_ATIK_ATK16HRC_PID  0xDF33  /* ATIK ATK-16HRC Colour Camera */
 304 #define FTDI_ATIK_ATK16IC_PID   0xDF35  /* ATIK ATK-16IC Grayscale Camera */
 305
 306 /*
 307  * Protego product ids
 308  */
 309 #define PROTEGO_SPECIAL_1       0xFC70  /* special/unknown device */
 310 #define PROTEGO_R2X0            0xFC71  /* R200-USB TRNG unit (R210, R220, and R230) */
 311 #define PROTEGO_SPECIAL_3       0xFC72  /* special/unknown device */
 312 #define PROTEGO_SPECIAL_4       0xFC73  /* special/unknown device */
 313
 314 /*
 315  * Gude Analog- und Digitalsysteme GmbH
 316  */
 317 #define FTDI_GUDEADS_E808_PID    0xE808
 318 #define FTDI_GUDEADS_E809_PID    0xE809
 319 #define FTDI_GUDEADS_E80A_PID    0xE80A
 320 #define FTDI_GUDEADS_E80B_PID    0xE80B
 321 #define FTDI_GUDEADS_E80C_PID    0xE80C
 322 #define FTDI_GUDEADS_E80D_PID    0xE80D
 323 #define FTDI_GUDEADS_E80E_PID    0xE80E
 324 #define FTDI_GUDEADS_E80F_PID    0xE80F
 325 #define FTDI_GUDEADS_E888_PID    0xE888  /* Expert ISDN Control USB */
 326 #define FTDI_GUDEADS_E889_PID    0xE889  /* USB RS-232 OptoBridge */
 327 #define FTDI_GUDEADS_E88A_PID    0xE88A
 328 #define FTDI_GUDEADS_E88B_PID    0xE88B
 329 #define FTDI_GUDEADS_E88C_PID    0xE88C
 330 #define FTDI_GUDEADS_E88D_PID    0xE88D
 331 #define FTDI_GUDEADS_E88E_PID    0xE88E
 332 #define FTDI_GUDEADS_E88F_PID    0xE88F
 333
 334 /*
 335  * Linx Technologies product ids
 336  */
 337 #define LINX_SDMUSBQSS_PID      0xF448  /* Linx SDM-USB-QS-S */
 338 #define LINX_MASTERDEVEL2_PID   0xF449   /* Linx Master Development 2.0 */
 339 #define LINX_FUTURE_0_PID   0xF44A   /* Linx future device */
 340 #define LINX_FUTURE_1_PID   0xF44B   /* Linx future device */
 341 #define LINX_FUTURE_2_PID   0xF44C   /* Linx future device */
 342
 343 /* CCS Inc. ICDU/ICDU40 product ID - the FT232BM is used in an in-circuit-debugger */
 344 /* unit for PIC16's/PIC18's */
 345 #define FTDI_CCSICDU20_0_PID    0xF9D0
 346 #define FTDI_CCSICDU40_1_PID    0xF9D1
 347 #define FTDI_CCSMACHX_2_PID     0xF9D2
 348
 349 /* Inside Accesso contactless reader (http://www.insidefr.com) */
 350 #define INSIDE_ACCESSO          0xFAD0
 351
 352 /*
 353  * Intrepid Control Systems (http://www.intrepidcs.com/) ValueCAN and NeoVI
 354  */
 355 #define INTREPID_VID            0x093C
 356 #define INTREPID_VALUECAN_PID   0x0601
 357 #define INTREPID_NEOVI_PID      0x0701
 358
 359 /*
 360  * Falcom Wireless Communications GmbH
 361  */
 362 #define FALCOM_VID              0x0F94  /* Vendor Id */
 363 #define FALCOM_TWIST_PID        0x0001  /* Falcom Twist USB GPRS modem */
 364 #define FALCOM_SAMBA_PID        0x0005  /* Falcom Samba USB GPRS modem */
 365
 366 /*
 367  * SUUNTO product ids
 368  */
 369 #define FTDI_SUUNTO_SPORTS_PID  0xF680  /* Suunto Sports instrument */
 370
 371 /*
 372  * TTi (Thurlby Thandar Instruments)
 373  */
 374 #define TTI_VID                 0x103E  /* Vendor Id */
 375 #define TTI_QL355P_PID          0x03E8  /* TTi QL355P power supply */
 376
 377 /*
 378  * Definitions for B&B Electronics products.
 379  */
 380 #define BANDB_VID               0x0856  /* B&B Electronics Vendor ID */
 381 #define BANDB_USOTL4_PID        0xAC01  /* USOTL4 Isolated RS-485 Converter */
 382 #define BANDB_USTL4_PID         0xAC02  /* USTL4 RS-485 Converter */
 383 #define BANDB_USO9ML2_PID       0xAC03  /* USO9ML2 Isolated RS-232 Converter */
 384
 385 /*
 386  * RM Michaelides CANview USB (http://www.rmcan.com)
 387  * CAN fieldbus interface adapter, added by port GmbH www.port.de)
 388  * Ian Abbott changed the macro names for consistency.
 389  */
 390 #define FTDI_RM_CANVIEW_PID     0xfd60  /* Product Id */
 391
 392 /*
 393  * EVER Eco Pro UPS (http://www.ever.com.pl/)
 394  */
 395
 396 #define EVER_ECO_PRO_CDS        0xe520  /* RS-232 converter */
 397
 398 /*
 399  * 4N-GALAXY.DE PIDs for CAN-USB, USB-RS232, USB-RS422, USB-RS485,
 400  * USB-TTY activ, USB-TTY passiv.  Some PIDs are used by several devices
 401  * and I'm not entirely sure which are used by which.
 402  */
 403 #define FTDI_4N_GALAXY_DE_1_PID 0xF3C0
 404 #define FTDI_4N_GALAXY_DE_2_PID 0xF3C1
 405
 406 /*
 407  * Mobility Electronics products.
 408  */
 409 #define MOBILITY_VID                    0x1342
 410 #define MOBILITY_USB_SERIAL_PID         0x0202  /* EasiDock USB 200 serial */
 411
 412 /*
 413  * microHAM product IDs (http://www.microham.com).
 414  * Submitted by Justin Burket (KL1RL) <zorton@jtan.com>
 415  * and Mike Studer (K6EEP) <k6eep@hamsoftware.org>.
 416  * Ian Abbott <abbotti@mev.co.uk> added a few more from the driver INF file.
 417  */
 418 #define FTDI_MHAM_KW_PID 0xEEE8         /* USB-KW interface */
 419 #define FTDI_MHAM_YS_PID 0xEEE9         /* USB-YS interface */
 420 #define FTDI_MHAM_Y6_PID 0xEEEA         /* USB-Y6 interface */
 421 #define FTDI_MHAM_Y8_PID 0xEEEB         /* USB-Y8 interface */
 422 #define FTDI_MHAM_IC_PID 0xEEEC         /* USB-IC interface */
 423 #define FTDI_MHAM_DB9_PID 0xEEED        /* USB-DB9 interface */
 424 #define FTDI_MHAM_RS232_PID 0xEEEE      /* USB-RS232 interface */
 425 #define FTDI_MHAM_Y9_PID 0xEEEF         /* USB-Y9 interface */
 426
 427 /*
 428  * Active Robots product ids.
 429  */
 430 #define FTDI_ACTIVE_ROBOTS_PID  0xE548  /* USB comms board */
 431
 432 /*
 433  * Xsens Technologies BV products (http://www.xsens.com).
 434  */
 435 #define XSENS_CONVERTER_0_PID   0xD388
 436 #define XSENS_CONVERTER_1_PID   0xD389
 437 #define XSENS_CONVERTER_2_PID   0xD38A
 438 #define XSENS_CONVERTER_3_PID   0xD38B
 439 #define XSENS_CONVERTER_4_PID   0xD38C
 440 #define XSENS_CONVERTER_5_PID   0xD38D
 441 #define XSENS_CONVERTER_6_PID   0xD38E
 442 #define XSENS_CONVERTER_7_PID   0xD38F
 443
 444 /*
 445  * Teratronik product ids.
 446  * Submitted by O. Wölfelschneider.
 447  */
 448 #define FTDI_TERATRONIK_VCP_PID  0xEC88 /* Teratronik device (preferring VCP driver on windows) */
 449 #define FTDI_TERATRONIK_D2XX_PID 0xEC89 /* Teratronik device (preferring D2XX driver on windows) */
 450
 451 /*
 452  * Evolution Robotics products (http://www.evolution.com/).
 453  * Submitted by Shawn M. Lavelle.
 454  */
 455 #define EVOLUTION_VID           0xDEEE  /* Vendor ID */
 456 #define EVOLUTION_ER1_PID       0x0300  /* ER1 Control Module */
 457 #define EVO_8U232AM_PID 0x02FF  /* Evolution robotics RCM2 (FT232AM)*/
 458 #define EVO_HYBRID_PID          0x0302  /* Evolution robotics RCM4 PID (FT232BM)*/
 459 #define EVO_RCM4_PID            0x0303  /* Evolution robotics RCM4 PID */
 460
 461 /* Pyramid Computer GmbH */
 462 #define FTDI_PYRAMID_PID        0xE6C8  /* Pyramid Appliance Display */
 463
 464 /*
 465  * Posiflex inc retail equipment (http://www.posiflex.com.tw)
 466  */
 467 #define POSIFLEX_VID            0x0d3a  /* Vendor ID */
 468 #define POSIFLEX_PP7000_PID     0x0300  /* PP-7000II thermal printer */
 469
 470 /*
 471  * Westrex International devices submitted by Cory Lee
 472  */
 473 #define FTDI_WESTREX_MODEL_777_PID      0xDC00  /* Model 777 */
 474 #define FTDI_WESTREX_MODEL_8900F_PID    0xDC01  /* Model 8900F */
 475
 476 /*
 477  * RR-CirKits LocoBuffer USB (http://www.rr-cirkits.com)
 478  */
 479 #define FTDI_RRCIRKITS_LOCOBUFFER_PID   0xc7d0  /* LocoBuffer USB */
 480
 481 /*
 482  * Eclo (http://www.eclo.pt/) product IDs.
 483  * PID 0xEA90 submitted by Martin Grill.
 484  */
 485 #define FTDI_ECLO_COM_1WIRE_PID 0xEA90  /* COM to 1-Wire USB adaptor */
 486
 487 /*
 488  * Papouch products (http://www.papouch.com/)
 489  * Submitted by Folkert van Heusden
 490  */
 491
 492 #define PAPOUCH_VID                     0x5050  /* Vendor ID */
 493 #define PAPOUCH_TMU_PID                 0x0400  /* TMU USB Thermometer */
 494
 495 /*
 496  * ACG Identification Technologies GmbH products (http://www.acg.de/).
 497  * Submitted by anton -at- goto10 -dot- org.
 498  */
 499 #define FTDI_ACG_HFDUAL_PID             0xDD20  /* HF Dual ISO Reader (RFID) */
 500
 501 /*
 502  * Yost Engineering, Inc. products (www.yostengineering.com).
 503  * PID 0xE050 submitted by Aaron Prose.
 504  */
 505 #define FTDI_YEI_SERVOCENTER31_PID      0xE050  /* YEI ServoCenter3.1 USB */
 506
 507 /*
 508  * ThorLabs USB motor drivers
 509  */
 510 #define FTDI_THORLABS_PID               0xfaf0 /* ThorLabs USB motor drivers */
 511
 512 /*
 513  * Testo products (http://www.testo.com/)
 514  * Submitted by Colin Leroy
 515  */
 516 #define TESTO_VID                       0x128D
 517 #define TESTO_USB_INTERFACE_PID         0x0001
 518
 519 /*
 520  * Gamma Scout (http://gamma-scout.com/). Submitted by rsc@runtux.com.
 521  */
 522 #define FTDI_GAMMA_SCOUT_PID            0xD678  /* Gamma Scout online */
 523
 524 /*
 525  * Tactrix OpenPort (ECU) devices.
 526  * OpenPort 1.3M submitted by Donour Sizemore.
 527  * OpenPort 1.3S and 1.3U submitted by Ian Abbott.
 528  */
 529 #define FTDI_TACTRIX_OPENPORT_13M_PID   0xCC48  /* OpenPort 1.3 Mitsubishi */
 530 #define FTDI_TACTRIX_OPENPORT_13S_PID   0xCC49  /* OpenPort 1.3 Subaru */
 531 #define FTDI_TACTRIX_OPENPORT_13U_PID   0xCC4A  /* OpenPort 1.3 Universal */
 532
 533 /*
 534  * Telldus Technologies
 535  */
 536 #define TELLDUS_VID                     0x1781  /* Vendor ID */
 537 #define TELLDUS_TELLSTICK_PID           0x0C30  /* RF control dongle 433 MHz using FT232RL */
 538
 539 /*
 540  * IBS elektronik product ids
 541  * Submitted by Thomas Schleusener
 542  */
 543 #define FTDI_IBS_US485_PID      0xff38  /* IBS US485 (USB<-->RS422/485 interface) */
 544 #define FTDI_IBS_PICPRO_PID     0xff39  /* IBS PIC-Programmer */
 545 #define FTDI_IBS_PCMCIA_PID     0xff3a  /* IBS Card reader for PCMCIA SRAM-cards */
 546 #define FTDI_IBS_PK1_PID        0xff3b  /* IBS PK1 - Particel counter */
 547 #define FTDI_IBS_RS232MON_PID   0xff3c  /* IBS RS232 - Monitor */
 548 #define FTDI_IBS_APP70_PID      0xff3d  /* APP 70 (dust monitoring system) */
 549 #define FTDI_IBS_PEDO_PID       0xff3e  /* IBS PEDO-Modem (RF modem 868.35 MHz) */
 550 #define FTDI_IBS_PROD_PID       0xff3f  /* future device */
 551
 552 /*
 553  *  MaxStream devices   www.maxstream.net
 554  */
 555 #define FTDI_MAXSTREAM_PID      0xEE18  /* Xbee PKG-U Module */
 556
 557 /* Olimex */
 558 #define OLIMEX_VID                      0x15BA
 559 #define OLIMEX_ARM_USB_OCD_PID          0x0003
 560
 561 /* www.elsterelectricity.com Elster Unicom III Optical Probe */
 562 #define FTDI_ELSTER_UNICOM_PID          0xE700 /* Product Id */
 563
 564 /*
 565  * The Mobility Lab (TML)
 566  * Submitted by Pierre Castella
 567  */
 568 #define TML_VID                 0x1B91  /* Vendor ID */
 569 #define TML_USB_SERIAL_PID      0x0064  /* USB - Serial Converter */
 570
 571 /* Propox devices */
 572 #define FTDI_PROPOX_JTAGCABLEII_PID     0xD738
 573
 574 /* Commands */
 575 #define FTDI_SIO_RESET          0 /* Reset the port */
 576 #define FTDI_SIO_MODEM_CTRL     1 /* Set the modem control register */
 577 #define FTDI_SIO_SET_FLOW_CTRL  2 /* Set flow control register */
 578 #define FTDI_SIO_SET_BAUD_RATE  3 /* Set baud rate */
 579 #define FTDI_SIO_SET_DATA       4 /* Set the data characteristics of the port */
 580 #define FTDI_SIO_GET_MODEM_STATUS       5 /* Retrieve current value of modern status register */
 581 #define FTDI_SIO_SET_EVENT_CHAR 6 /* Set the event character */
 582 #define FTDI_SIO_SET_ERROR_CHAR 7 /* Set the error character */
 583 #define FTDI_SIO_SET_LATENCY_TIMER      9 /* Set the latency timer */
 584 #define FTDI_SIO_GET_LATENCY_TIMER      10 /* Get the latency timer */
 585
 586
 587 /*
 588  * FIC / OpenMoko, Inc. http://wiki.openmoko.org/wiki/Neo1973_Debug_Board_v3
 589  * Submitted by Harald Welte <laforge@openmoko.org>
 590  */
 591 #define FIC_VID                 0x1457
 592 #define FIC_NEO1973_DEBUG_PID   0x5118
 593
 594 /*
 595  *   BmRequestType:  1100 0000b
 596  *   bRequest:       FTDI_E2_READ
 597  *   wValue:         0
 598  *   wIndex:         Address of word to read
 599  *   wLength:        2
 600  *   Data:           Will return a word of data from E2Address
 601  *
 602  */
 603
 604 /* Port Identifier Table */
 605 #define PIT_DEFAULT             0 /* SIOA */
 606 #define PIT_SIOA                1 /* SIOA */
 607 /* The device this driver is tested with one has only one port */
 608 #define PIT_SIOB                2 /* SIOB */
 609 #define PIT_PARALLEL            3 /* Parallel */
 610
 611 /* FTDI_SIO_RESET */
 612 #define FTDI_SIO_RESET_REQUEST FTDI_SIO_RESET
 613 #define FTDI_SIO_RESET_REQUEST_TYPE 0x40
 614 #define FTDI_SIO_RESET_SIO 0
 615 #define FTDI_SIO_RESET_PURGE_RX 1
 616 #define FTDI_SIO_RESET_PURGE_TX 2
 617
 618 /*
 619  * BmRequestType:  0100 0000B
 620  * bRequest:       FTDI_SIO_RESET
 621  * wValue:         Control Value
 622  *                   0 = Reset SIO
 623  *                   1 = Purge RX buffer
 624  *                   2 = Purge TX buffer
 625  * wIndex:         Port
 626  * wLength:        0
 627  * Data:           None
 628  *
 629  * The Reset SIO command has this effect:
 630  *
 631  *    Sets flow control set to 'none'
 632  *    Event char = $0D
 633  *    Event trigger = disabled
 634  *    Purge RX buffer
 635  *    Purge TX buffer
 636  *    Clear DTR
 637  *    Clear RTS
 638  *    baud and data format not reset
 639  *
 640  * The Purge RX and TX buffer commands affect nothing except the buffers
 641  *
 642    */
 643
 644 /* FTDI_SIO_SET_BAUDRATE */
 645 #define FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE 0x40
 646 #define FTDI_SIO_SET_BAUDRATE_REQUEST 3
 647
 648 /*
 649  * BmRequestType:  0100 0000B
 650  * bRequest:       FTDI_SIO_SET_BAUDRATE
 651  * wValue:         BaudDivisor value - see below
 652  * wIndex:         Port
 653  * wLength:        0
 654  * Data:           None
 655  * The BaudDivisor values are calculated as follows:
 656  * - BaseClock is either 12000000 or 48000000 depending on the device. FIXME: I wish
 657  *   I knew how to detect old chips to select proper base clock!
 658  * - BaudDivisor is a fixed point number encoded in a funny way.
 659  *   (--WRONG WAY OF THINKING--)
 660  *   BaudDivisor is a fixed point number encoded with following bit weighs:
 661  *   (-2)(-1)(13..0). It is a radical with a denominator of 4, so values
 662  *   end with 0.0 (00...), 0.25 (10...), 0.5 (01...), and 0.75 (11...).
 663  *   (--THE REALITY--)
 664  *   The both-bits-set has quite different meaning from 0.75 - the chip designers
 665  *   have decided it to mean 0.125 instead of 0.75.
 666  *   This info looked up in FTDI application note "FT8U232 DEVICES \ Data Rates
 667  *   and Flow Control Consideration for USB to RS232".
 668  * - BaudDivisor = (BaseClock / 16) / BaudRate, where the (=) operation should
 669  *   automagically re-encode the resulting value to take fractions into consideration.
 670  * As all values are integers, some bit twiddling is in order:
 671  *   BaudDivisor = (BaseClock / 16 / BaudRate) |
 672  *   (((BaseClock / 2 / BaudRate) & 4) ? 0x4000    // 0.5
 673  *    : ((BaseClock / 2 / BaudRate) & 2) ? 0x8000  // 0.25
 674  *    : ((BaseClock / 2 / BaudRate) & 1) ? 0xc000  // 0.125
 675  *    : 0)
 676  *
 677  * For the FT232BM, a 17th divisor bit was introduced to encode the multiples
 678  * of 0.125 missing from the FT8U232AM.  Bits 16 to 14 are coded as follows
 679  * (the first four codes are the same as for the FT8U232AM, where bit 16 is
 680  * always 0):
 681  *   000 - add .000 to divisor
 682  *   001 - add .500 to divisor
 683  *   010 - add .250 to divisor
 684  *   011 - add .125 to divisor
 685  *   100 - add .375 to divisor
 686  *   101 - add .625 to divisor
 687  *   110 - add .750 to divisor
 688  *   111 - add .875 to divisor
 689  * Bits 15 to 0 of the 17-bit divisor are placed in the urb value.  Bit 16 is
 690  * placed in bit 0 of the urb index.
 691  *
 692  * Note that there are a couple of special cases to support the highest baud
 693  * rates.  If the calculated divisor value is 1, this needs to be replaced with
 694  * 0.  Additionally for the FT232BM, if the calculated divisor value is 0x4001
 695  * (1.5), this needs to be replaced with 0x0001 (1) (but this divisor value is
 696  * not supported by the FT8U232AM).
 697  */
 698
 699 typedef enum {
 700         SIO = 1,
 701         FT8U232AM = 2,
 702         FT232BM = 3,
 703         FT2232C = 4,
 704         FT232RL = 5,
 705 } ftdi_chip_type_t;
 706
 707 typedef enum {
 708  ftdi_sio_b300 = 0,
 709  ftdi_sio_b600 = 1,
 710  ftdi_sio_b1200 = 2,
 711  ftdi_sio_b2400 = 3,
 712  ftdi_sio_b4800 = 4,
 713  ftdi_sio_b9600 = 5,
 714  ftdi_sio_b19200 = 6,
 715  ftdi_sio_b38400 = 7,
 716  ftdi_sio_b57600 = 8,
 717  ftdi_sio_b115200 = 9
 718 } FTDI_SIO_baudrate_t ;
 719
 720 /*
 721  * The ftdi_8U232AM_xxMHz_byyy constants have been removed. The encoded divisor values
 722  * are calculated internally.
 723  */
 724
 725 #define FTDI_SIO_SET_DATA_REQUEST FTDI_SIO_SET_DATA
 726 #define FTDI_SIO_SET_DATA_REQUEST_TYPE 0x40
 727 #define FTDI_SIO_SET_DATA_PARITY_NONE (0x0 << 8 )
 728 #define FTDI_SIO_SET_DATA_PARITY_ODD (0x1 << 8 )
 729 #define FTDI_SIO_SET_DATA_PARITY_EVEN (0x2 << 8 )
 730 #define FTDI_SIO_SET_DATA_PARITY_MARK (0x3 << 8 )
 731 #define FTDI_SIO_SET_DATA_PARITY_SPACE (0x4 << 8 )
 732 #define FTDI_SIO_SET_DATA_STOP_BITS_1 (0x0 << 11 )
 733 #define FTDI_SIO_SET_DATA_STOP_BITS_15 (0x1 << 11 )
 734 #define FTDI_SIO_SET_DATA_STOP_BITS_2 (0x2 << 11 )
 735 #define FTDI_SIO_SET_BREAK (0x1 << 14)
 736 /* FTDI_SIO_SET_DATA */
 737
 738 /*
 739  * BmRequestType:  0100 0000B
 740  * bRequest:       FTDI_SIO_SET_DATA
 741  * wValue:         Data characteristics (see below)
 742  * wIndex:         Port
 743  * wLength:        0
 744  * Data:           No
 745  *
 746  * Data characteristics
 747  *
 748  *   B0..7   Number of data bits
 749  *   B8..10  Parity
 750  *           0 = None
 751  *           1 = Odd
 752  *           2 = Even
 753  *           3 = Mark
 754  *           4 = Space
 755  *   B11..13 Stop Bits
 756  *           0 = 1
 757  *           1 = 1.5
 758  *           2 = 2
 759  *   B14
 760  *           1 = TX ON (break)
 761  *           0 = TX OFF (normal state)
 762  *   B15 Reserved
 763  *
 764  */
 765
 766
 767
 768 /* FTDI_SIO_MODEM_CTRL */
 769 #define FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE 0x40
 770 #define FTDI_SIO_SET_MODEM_CTRL_REQUEST FTDI_SIO_MODEM_CTRL
 771
 772 /*
 773  * BmRequestType:   0100 0000B
 774  * bRequest:        FTDI_SIO_MODEM_CTRL
 775  * wValue:          ControlValue (see below)
 776  * wIndex:          Port
 777  * wLength:         0
 778  * Data:            None
 779  *
 780  * NOTE: If the device is in RTS/CTS flow control, the RTS set by this
 781  * command will be IGNORED without an error being returned
 782  * Also - you can not set DTR and RTS with one control message
 783  */
 784
 785 #define FTDI_SIO_SET_DTR_MASK 0x1
 786 #define FTDI_SIO_SET_DTR_HIGH ( 1 | ( FTDI_SIO_SET_DTR_MASK  << 8))
 787 #define FTDI_SIO_SET_DTR_LOW  ( 0 | ( FTDI_SIO_SET_DTR_MASK  << 8))
 788 #define FTDI_SIO_SET_RTS_MASK 0x2
 789 #define FTDI_SIO_SET_RTS_HIGH ( 2 | ( FTDI_SIO_SET_RTS_MASK << 8 ))
 790 #define FTDI_SIO_SET_RTS_LOW ( 0 | ( FTDI_SIO_SET_RTS_MASK << 8 ))
 791
 792 /*
 793  * ControlValue
 794  * B0    DTR state
 795  *          0 = reset
 796  *          1 = set
 797  * B1    RTS state
 798  *          0 = reset
 799  *          1 = set
 800  * B2..7 Reserved
 801  * B8    DTR state enable
 802  *          0 = ignore
 803  *          1 = use DTR state
 804  * B9    RTS state enable
 805  *          0 = ignore
 806  *          1 = use RTS state
 807  * B10..15 Reserved
 808  */
 809
 810 /* FTDI_SIO_SET_FLOW_CTRL */
 811 #define FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE 0x40
 812 #define FTDI_SIO_SET_FLOW_CTRL_REQUEST FTDI_SIO_SET_FLOW_CTRL
 813 #define FTDI_SIO_DISABLE_FLOW_CTRL 0x0
 814 #define FTDI_SIO_RTS_CTS_HS (0x1 << 8)
 815 #define FTDI_SIO_DTR_DSR_HS (0x2 << 8)
 816 #define FTDI_SIO_XON_XOFF_HS (0x4 << 8)
 817 /*
 818  *   BmRequestType:  0100 0000b
 819  *   bRequest:       FTDI_SIO_SET_FLOW_CTRL
 820  *   wValue:         Xoff/Xon
 821  *   wIndex:         Protocol/Port - hIndex is protocl / lIndex is port
 822  *   wLength:        0
 823  *   Data:           None
 824  *
 825  * hIndex protocol is:
 826  *   B0 Output handshaking using RTS/CTS
 827  *       0 = disabled
 828  *       1 = enabled
 829  *   B1 Output handshaking using DTR/DSR
 830  *       0 = disabled
 831  *       1 = enabled
 832  *   B2 Xon/Xoff handshaking
 833  *       0 = disabled
 834  *       1 = enabled
 835  *
 836  * A value of zero in the hIndex field disables handshaking
 837  *
 838  * If Xon/Xoff handshaking is specified, the hValue field should contain the XOFF character
 839  * and the lValue field contains the XON character.
 840  */
 841
 842 /*
 843  * FTDI_SIO_GET_LATENCY_TIMER
 844  *
 845  * Set the timeout interval. The FTDI collects data from the slave
 846  * device, transmitting it to the host when either A) 62 bytes are
 847  * received, or B) the timeout interval has elapsed and the buffer
 848  * contains at least 1 byte.  Setting this value to a small number
 849  * can dramatically improve performance for applications which send
 850  * small packets, since the default value is 16ms.
 851  */
 852 #define  FTDI_SIO_GET_LATENCY_TIMER_REQUEST FTDI_SIO_GET_LATENCY_TIMER
 853 #define  FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE 0xC0
 854
 855 /*
 856  *  BmRequestType:   1100 0000b
 857  *  bRequest:        FTDI_SIO_GET_LATENCY_TIMER
 858  *  wValue:          0
 859  *  wIndex:          Port
 860  *  wLength:         0
 861  *  Data:            latency (on return)
 862  */
 863
 864 /*
 865  * FTDI_SIO_SET_LATENCY_TIMER
 866  *
 867  * Set the timeout interval. The FTDI collects data from the slave
 868  * device, transmitting it to the host when either A) 62 bytes are
 869  * received, or B) the timeout interval has elapsed and the buffer
 870  * contains at least 1 byte.  Setting this value to a small number
 871  * can dramatically improve performance for applications which send
 872  * small packets, since the default value is 16ms.
 873  */
 874 #define  FTDI_SIO_SET_LATENCY_TIMER_REQUEST FTDI_SIO_SET_LATENCY_TIMER
 875 #define  FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE 0x40
 876
 877 /*
 878  *  BmRequestType:   0100 0000b
 879  *  bRequest:        FTDI_SIO_SET_LATENCY_TIMER
 880  *  wValue:          Latency (milliseconds)
 881  *  wIndex:          Port
 882  *  wLength:         0
 883  *  Data:            None
 884  *
 885  * wValue:
 886  *   B0..7   Latency timer
 887  *   B8..15  0
 888  *
 889  */
 890
 891 /*
 892  * FTDI_SIO_SET_EVENT_CHAR
 893  *
 894  * Set the special event character for the specified communications port.
 895  * If the device sees this character it will immediately return the
 896  * data read so far - rather than wait 40ms or until 62 bytes are read
 897  * which is what normally happens.
 898  */
 899
 900
 901 #define  FTDI_SIO_SET_EVENT_CHAR_REQUEST FTDI_SIO_SET_EVENT_CHAR
 902 #define  FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE 0x40
 903
 904
 905 /*
 906  *  BmRequestType:   0100 0000b
 907  *  bRequest:        FTDI_SIO_SET_EVENT_CHAR
 908  *  wValue:          EventChar
 909  *  wIndex:          Port
 910  *  wLength:         0
 911  *  Data:            None
 912  *
 913  * wValue:
 914  *   B0..7   Event Character
 915  *   B8      Event Character Processing
 916  *             0 = disabled
 917  *             1 = enabled
 918  *   B9..15  Reserved
 919  *
 920  */
 921
 922 /* FTDI_SIO_SET_ERROR_CHAR */
 923
 924 /* Set the parity error replacement character for the specified communications port */
 925
 926 /*
 927  *  BmRequestType:  0100 0000b
 928  *  bRequest:       FTDI_SIO_SET_EVENT_CHAR
 929  *  wValue:         Error Char
 930  *  wIndex:         Port
 931  *  wLength:        0
 932  *  Data:           None
 933  *
 934  *Error Char
 935  *  B0..7  Error Character
 936  *  B8     Error Character Processing
 937  *           0 = disabled
 938  *           1 = enabled
 939  *  B9..15 Reserved
 940  *
 941  */
 942
 943 /* FTDI_SIO_GET_MODEM_STATUS */
 944 /* Retrieve the current value of the modem status register */
 945
 946 #define FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE 0xc0
 947 #define FTDI_SIO_GET_MODEM_STATUS_REQUEST FTDI_SIO_GET_MODEM_STATUS
 948 #define FTDI_SIO_CTS_MASK 0x10
 949 #define FTDI_SIO_DSR_MASK 0x20
 950 #define FTDI_SIO_RI_MASK  0x40
 951 #define FTDI_SIO_RLSD_MASK 0x80
 952 /*
 953  *   BmRequestType:   1100 0000b
 954  *   bRequest:        FTDI_SIO_GET_MODEM_STATUS
 955  *   wValue:          zero
 956  *   wIndex:          Port
 957  *   wLength:         1
 958  *   Data:            Status
 959  *
 960  * One byte of data is returned
 961  * B0..3 0
 962  * B4    CTS
 963  *         0 = inactive
 964  *         1 = active
 965  * B5    DSR
 966  *         0 = inactive
 967  *         1 = active
 968  * B6    Ring Indicator (RI)
 969  *         0 = inactive
 970  *         1 = active
 971  * B7    Receive Line Signal Detect (RLSD)
 972  *         0 = inactive
 973  *         1 = active
 974  */
 975
 976
 977
 978 /* Descriptors returned by the device
 979  *
 980  *  Device Descriptor
 981  *
 982  * Offset       Field           Size    Value   Description
 983  * 0    bLength         1       0x12    Size of descriptor in bytes
 984  * 1    bDescriptorType 1       0x01    DEVICE Descriptor Type
 985  * 2    bcdUSB          2       0x0110  USB Spec Release Number
 986  * 4    bDeviceClass    1       0x00    Class Code
 987  * 5    bDeviceSubClass 1       0x00    SubClass Code
 988  * 6    bDeviceProtocol 1       0x00    Protocol Code
 989  * 7    bMaxPacketSize0 1       0x08    Maximum packet size for endpoint 0
 990  * 8    idVendor        2       0x0403  Vendor ID
 991  * 10   idProduct       2       0x8372  Product ID (FTDI_SIO_PID)
 992  * 12   bcdDevice       2       0x0001  Device release number
 993  * 14   iManufacturer   1       0x01    Index of man. string desc
 994  * 15   iProduct        1       0x02    Index of prod string desc
 995  * 16   iSerialNumber   1       0x02    Index of serial nmr string desc
 996  * 17   bNumConfigurations 1    0x01    Number of possible configurations
 997  *
 998  * Configuration Descriptor
 999  *
1000  * Offset       Field                   Size    Value
1001  * 0    bLength                 1       0x09    Size of descriptor in bytes
1002  * 1    bDescriptorType         1       0x02    CONFIGURATION Descriptor Type
1003  * 2    wTotalLength            2       0x0020  Total length of data
1004  * 4    bNumInterfaces          1       0x01    Number of interfaces supported
1005  * 5    bConfigurationValue     1       0x01    Argument for SetCOnfiguration() req
1006  * 6    iConfiguration          1       0x02    Index of config string descriptor
1007  * 7    bmAttributes            1       0x20    Config characteristics Remote Wakeup
1008  * 8    MaxPower                1       0x1E    Max power consumption
1009  *
1010  * Interface Descriptor
1011  *
1012  * Offset       Field                   Size    Value
1013  * 0    bLength                 1       0x09    Size of descriptor in bytes
1014  * 1    bDescriptorType         1       0x04    INTERFACE Descriptor Type
1015  * 2    bInterfaceNumber        1       0x00    Number of interface
1016  * 3    bAlternateSetting       1       0x00    Value used to select alternate
1017  * 4    bNumEndpoints           1       0x02    Number of endpoints
1018  * 5    bInterfaceClass         1       0xFF    Class Code
1019  * 6    bInterfaceSubClass      1       0xFF    Subclass Code
1020  * 7    bInterfaceProtocol      1       0xFF    Protocol Code
1021  * 8    iInterface              1       0x02    Index of interface string description
1022  *
1023  * IN Endpoint Descriptor
1024  *
1025  * Offset       Field                   Size    Value
1026  * 0    bLength                 1       0x07    Size of descriptor in bytes
1027  * 1    bDescriptorType         1       0x05    ENDPOINT descriptor type
1028  * 2    bEndpointAddress        1       0x82    Address of endpoint
1029  * 3    bmAttributes            1       0x02    Endpoint attributes - Bulk
1030  * 4    bNumEndpoints           2       0x0040  maximum packet size
1031  * 5    bInterval               1       0x00    Interval for polling endpoint
1032  *
1033  * OUT Endpoint Descriptor
1034  *
1035  * Offset       Field                   Size    Value
1036  * 0    bLength                 1       0x07    Size of descriptor in bytes
1037  * 1    bDescriptorType         1       0x05    ENDPOINT descriptor type
1038  * 2    bEndpointAddress        1       0x02    Address of endpoint
1039  * 3    bmAttributes            1       0x02    Endpoint attributes - Bulk
1040  * 4    bNumEndpoints           2       0x0040  maximum packet size
1041  * 5    bInterval               1       0x00    Interval for polling endpoint
1042  *
1043  * DATA FORMAT
1044  *
1045  * IN Endpoint
1046  *
1047  * The device reserves the first two bytes of data on this endpoint to contain the current
1048  * values of the modem and line status registers. In the absence of data, the device
1049  * generates a message consisting of these two status bytes every 40 ms
1050  *
1051  * Byte 0: Modem Status
1052  *
1053  * Offset       Description
1054  * B0   Reserved - must be 1
1055  * B1   Reserved - must be 0
1056  * B2   Reserved - must be 0
1057  * B3   Reserved - must be 0
1058  * B4   Clear to Send (CTS)
1059  * B5   Data Set Ready (DSR)
1060  * B6   Ring Indicator (RI)
1061  * B7   Receive Line Signal Detect (RLSD)
1062  *
1063  * Byte 1: Line Status
1064  *
1065  * Offset       Description
1066  * B0   Data Ready (DR)
1067  * B1   Overrun Error (OE)
1068  * B2   Parity Error (PE)
1069  * B3   Framing Error (FE)
1070  * B4   Break Interrupt (BI)
1071  * B5   Transmitter Holding Register (THRE)
1072  * B6   Transmitter Empty (TEMT)
1073  * B7   Error in RCVR FIFO
1074  *
1075  */
1076 #define FTDI_RS0_CTS    (1 << 4)
1077 #define FTDI_RS0_DSR    (1 << 5)
1078 #define FTDI_RS0_RI     (1 << 6)
1079 #define FTDI_RS0_RLSD   (1 << 7)
1080
1081 #define FTDI_RS_DR  1
1082 #define FTDI_RS_OE (1<<1)
1083 #define FTDI_RS_PE (1<<2)
1084 #define FTDI_RS_FE (1<<3)
1085 #define FTDI_RS_BI (1<<4)
1086 #define FTDI_RS_THRE (1<<5)
1087 #define FTDI_RS_TEMT (1<<6)
1088 #define FTDI_RS_FIFO  (1<<7)
1089
1090 /*
1091  * OUT Endpoint
1092  *
1093  * This device reserves the first bytes of data on this endpoint contain the length
1094  * and port identifier of the message. For the FTDI USB Serial converter the port
1095  * identifier is always 1.
1096  *
1097  * Byte 0: Line Status
1098  *
1099  * Offset       Description
1100  * B0   Reserved - must be 1
1101  * B1   Reserved - must be 0
1102  * B2..7        Length of message - (not including Byte 0)
1103  *
1104  */
1105