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