drivers/usb/serial/ftdi_sio.h

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