drivers/usb/serial/ftdi_sio.h

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