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