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