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