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