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  * DSS-20 Sync Station for Sony Ericsson P800
 132  */
 133
 134 #define FTDI_DSS20_PID          0xFC82
 135
 136 /*
 137  * Home Electronics (www.home-electro.com) USB gadgets
 138  */
 139 #define FTDI_HE_TIRA1_PID       0xFA78  /* Tira-1 IR transceiver */
 140
 141 /* USB-UIRT - An infrared receiver and transmitter using the 8U232AM chip */
 142 /* http://home.earthlink.net/~jrhees/USBUIRT/index.htm */
 143 #define FTDI_USB_UIRT_PID       0xF850  /* Product Id */
 144
 145 /*
 146  * ELV USB devices submitted by Christian Abt of ELV (www.elv.de).
 147  * All of these devices use FTDI's vendor ID (0x0403).
 148  *
 149  * The previously included PID for the UO 100 module was incorrect.
 150  * In fact, that PID was for ELV's UR 100 USB-RS232 converter (0xFB58).
 151  *
 152  * Armin Laeuger originally sent the PID for the UM 100 module.
 153  */
 154 #define FTDI_ELV_UR100_PID      0xFB58  /* USB-RS232-Umsetzer (UR 100) */
 155 #define FTDI_ELV_UM100_PID      0xFB5A  /* USB-Modul UM 100 */
 156 #define FTDI_ELV_UO100_PID      0xFB5B  /* USB-Modul UO 100 */
 157 #define FTDI_ELV_ALC8500_PID    0xF06E  /* ALC 8500 Expert */
 158 /* Additional ELV PIDs that default to using the FTDI D2XX drivers on
 159  * MS Windows, rather than the FTDI Virtual Com Port drivers.
 160  * Maybe these will be easier to use with the libftdi/libusb user-space
 161  * drivers, or possibly the Comedi drivers in some cases. */
 162 #define FTDI_ELV_CLI7000_PID    0xFB59  /* Computer-Light-Interface (CLI 7000) */
 163 #define FTDI_ELV_PPS7330_PID    0xFB5C  /* Processor-Power-Supply (PPS 7330) */
 164 #define FTDI_ELV_TFM100_PID     0xFB5D  /* Temperartur-Feuchte Messgeraet (TFM 100) */
 165 #define FTDI_ELV_UDF77_PID      0xFB5E  /* USB DCF Funkurh (UDF 77) */
 166 #define FTDI_ELV_UIO88_PID      0xFB5F  /* USB-I/O Interface (UIO 88) */
 167 #define FTDI_ELV_UAD8_PID       0xF068  /* USB-AD-Wandler (UAD 8) */
 168 #define FTDI_ELV_UDA7_PID       0xF069  /* USB-DA-Wandler (UDA 7) */
 169 #define FTDI_ELV_USI2_PID       0xF06A  /* USB-Schrittmotoren-Interface (USI 2) */
 170 #define FTDI_ELV_T1100_PID      0xF06B  /* Thermometer (T 1100) */
 171 #define FTDI_ELV_PCD200_PID     0xF06C  /* PC-Datenlogger (PCD 200) */
 172 #define FTDI_ELV_ULA200_PID     0xF06D  /* USB-LCD-Ansteuerung (ULA 200) */
 173 #define FTDI_ELV_FHZ1000PC_PID  0xF06F  /* FHZ 1000 PC */
 174 #define FTDI_ELV_CSI8_PID       0xE0F0  /* Computer-Schalt-Interface (CSI 8) */
 175 #define FTDI_ELV_EM1000DL_PID   0xE0F1  /* PC-Datenlogger fuer Energiemonitor (EM 1000 DL) */
 176 #define FTDI_ELV_PCK100_PID     0xE0F2  /* PC-Kabeltester (PCK 100) */
 177 #define FTDI_ELV_RFP500_PID     0xE0F3  /* HF-Leistungsmesser (RFP 500) */
 178 #define FTDI_ELV_FS20SIG_PID    0xE0F4  /* Signalgeber (FS 20 SIG) */
 179 #define FTDI_ELV_WS300PC_PID    0xE0F6  /* PC-Wetterstation (WS 300 PC) */
 180 #define FTDI_ELV_FHZ1300PC_PID  0xE0E8  /* FHZ 1300 PC */
 181 #define FTDI_ELV_WS500_PID      0xE0E9  /* PC-Wetterstation (WS 500) */
 182
 183 /*
 184  * Definitions for ID TECH (www.idt-net.com) devices
 185  */
 186 #define IDTECH_VID              0x0ACD  /* ID TECH Vendor ID */
 187 #define IDTECH_IDT1221U_PID     0x0300  /* IDT1221U USB to RS-232 adapter */
 188
 189 /*
 190  * Definitions for Omnidirectional Control Technology, Inc. devices
 191  */
 192 #define OCT_VID                 0x0B39  /* OCT vendor ID */
 193 /* Note: OCT US101 is also rebadged as Dick Smith Electronics (NZ) XH6381 */
 194 /* Also rebadged as Dick Smith Electronics (Aus) XH6451 */
 195 /* Also rebadged as SIIG Inc. model US2308 hardware version 1 */
 196 #define OCT_US101_PID           0x0421  /* OCT US101 USB to RS-232 */
 197
 198 /* an infrared receiver for user access control with IR tags */
 199 #define FTDI_PIEGROUP_PID       0xF208  /* Product Id */
 200
 201 /*
 202  * Protego product ids
 203  */
 204 #define PROTEGO_SPECIAL_1       0xFC70  /* special/unknown device */
 205 #define PROTEGO_R2X0            0xFC71  /* R200-USB TRNG unit (R210, R220, and R230) */
 206 #define PROTEGO_SPECIAL_3       0xFC72  /* special/unknown device */
 207 #define PROTEGO_SPECIAL_4       0xFC73  /* special/unknown device */
 208
 209 /*
 210  * Gude Analog- und Digitalsysteme GmbH
 211  */
 212 #define FTDI_GUDEADS_E808_PID    0xE808
 213 #define FTDI_GUDEADS_E809_PID    0xE809
 214 #define FTDI_GUDEADS_E80A_PID    0xE80A
 215 #define FTDI_GUDEADS_E80B_PID    0xE80B
 216 #define FTDI_GUDEADS_E80C_PID    0xE80C
 217 #define FTDI_GUDEADS_E80D_PID    0xE80D
 218 #define FTDI_GUDEADS_E80E_PID    0xE80E
 219 #define FTDI_GUDEADS_E80F_PID    0xE80F
 220 #define FTDI_GUDEADS_E888_PID    0xE888  /* Expert ISDN Control USB */
 221 #define FTDI_GUDEADS_E889_PID    0xE889  /* USB RS-232 OptoBridge */
 222 #define FTDI_GUDEADS_E88A_PID    0xE88A
 223 #define FTDI_GUDEADS_E88B_PID    0xE88B
 224 #define FTDI_GUDEADS_E88C_PID    0xE88C
 225 #define FTDI_GUDEADS_E88D_PID    0xE88D
 226 #define FTDI_GUDEADS_E88E_PID    0xE88E
 227 #define FTDI_GUDEADS_E88F_PID    0xE88F
 228
 229 /*
 230  * Linx Technologies product ids
 231  */
 232 #define LINX_SDMUSBQSS_PID      0xF448  /* Linx SDM-USB-QS-S */
 233 #define LINX_MASTERDEVEL2_PID   0xF449   /* Linx Master Development 2.0 */
 234 #define LINX_FUTURE_0_PID   0xF44A   /* Linx future device */
 235 #define LINX_FUTURE_1_PID   0xF44B   /* Linx future device */
 236 #define LINX_FUTURE_2_PID   0xF44C   /* Linx future device */
 237
 238 /* CCS Inc. ICDU/ICDU40 product ID - the FT232BM is used in an in-circuit-debugger */
 239 /* unit for PIC16's/PIC18's */
 240 #define FTDI_CCSICDU20_0_PID    0xF9D0
 241 #define FTDI_CCSICDU40_1_PID    0xF9D1
 242
 243 /* Inside Accesso contactless reader (http://www.insidefr.com) */
 244 #define INSIDE_ACCESSO          0xFAD0
 245
 246 /*
 247  * Intrepid Control Systems (http://www.intrepidcs.com/) ValueCAN and NeoVI
 248  */
 249 #define INTREPID_VID            0x093C
 250 #define INTREPID_VALUECAN_PID   0x0601
 251 #define INTREPID_NEOVI_PID      0x0701
 252
 253 /*
 254  * Falcom Wireless Communications GmbH
 255  */
 256 #define FALCOM_VID              0x0F94  /* Vendor Id */
 257 #define FALCOM_TWIST_PID        0x0001  /* Falcom Twist USB GPRS modem */
 258 #define FALCOM_SAMBA_PID        0x0005  /* Falcom Samba USB GPRS modem */
 259
 260 /*
 261  * SUUNTO product ids
 262  */
 263 #define FTDI_SUUNTO_SPORTS_PID  0xF680  /* Suunto Sports instrument */
 264
 265 /*
 266  * Definitions for B&B Electronics products.
 267  */
 268 #define BANDB_VID               0x0856  /* B&B Electronics Vendor ID */
 269 #define BANDB_USOTL4_PID        0xAC01  /* USOTL4 Isolated RS-485 Converter */
 270 #define BANDB_USTL4_PID         0xAC02  /* USTL4 RS-485 Converter */
 271 #define BANDB_USO9ML2_PID       0xAC03  /* USO9ML2 Isolated RS-232 Converter */
 272
 273 /*
 274  * RM Michaelides CANview USB (http://www.rmcan.com)
 275  * CAN fieldbus interface adapter, added by port GmbH www.port.de)
 276  * Ian Abbott changed the macro names for consistency.
 277  */
 278 #define FTDI_RM_CANVIEW_PID     0xfd60  /* Product Id */
 279
 280 /*
 281  * EVER Eco Pro UPS (http://www.ever.com.pl/)
 282  */
 283
 284 #define EVER_ECO_PRO_CDS        0xe520  /* RS-232 converter */
 285
 286 /*
 287  * 4N-GALAXY.DE PIDs for CAN-USB, USB-RS232, USB-RS422, USB-RS485,
 288  * USB-TTY activ, USB-TTY passiv.  Some PIDs are used by several devices
 289  * and I'm not entirely sure which are used by which.
 290  */
 291 #define FTDI_4N_GALAXY_DE_0_PID 0x8372
 292 #define FTDI_4N_GALAXY_DE_1_PID 0xF3C0
 293 #define FTDI_4N_GALAXY_DE_2_PID 0xF3C1
 294
 295 /*
 296  * Mobility Electronics products.
 297  */
 298 #define MOBILITY_VID                    0x1342
 299 #define MOBILITY_USB_SERIAL_PID         0x0202  /* EasiDock USB 200 serial */
 300
 301 /*
 302  * microHAM product IDs (http://www.microham.com).
 303  * Submitted by Justin Burket (KL1RL) <zorton@jtan.com>.
 304  */
 305 #define FTDI_MHAM_Y6_PID 0xEEEA         /* USB-Y6 interface */
 306 #define FTDI_MHAM_Y8_PID 0xEEEB         /* USB-Y8 interface */
 307
 308 /*
 309  * Active Robots product ids.
 310  */
 311 #define FTDI_ACTIVE_ROBOTS_PID  0xE548  /* USB comms board */
 312
 313 /*
 314  * Xsens Technologies BV products (http://www.xsens.com).
 315  */
 316 #define XSENS_CONVERTER_0_PID   0xD388
 317 #define XSENS_CONVERTER_1_PID   0xD389
 318 #define XSENS_CONVERTER_2_PID   0xD38A
 319 #define XSENS_CONVERTER_3_PID   0xD38B
 320 #define XSENS_CONVERTER_4_PID   0xD38C
 321 #define XSENS_CONVERTER_5_PID   0xD38D
 322 #define XSENS_CONVERTER_6_PID   0xD38E
 323 #define XSENS_CONVERTER_7_PID   0xD38F
 324
 325 /*
 326  * Evolution Robotics products (http://www.evolution.com/).
 327  * Submitted by Shawn M. Lavelle.
 328  */
 329 #define EVOLUTION_VID           0xDEEE  /* Vendor ID */
 330 #define EVOLUTION_ER1_PID       0x0300  /* ER1 Control Module */
 331
 332 /* Commands */
 333 #define FTDI_SIO_RESET          0 /* Reset the port */
 334 #define FTDI_SIO_MODEM_CTRL     1 /* Set the modem control register */
 335 #define FTDI_SIO_SET_FLOW_CTRL  2 /* Set flow control register */
 336 #define FTDI_SIO_SET_BAUD_RATE  3 /* Set baud rate */
 337 #define FTDI_SIO_SET_DATA       4 /* Set the data characteristics of the port */
 338 #define FTDI_SIO_GET_MODEM_STATUS       5 /* Retrieve current value of modern status register */
 339 #define FTDI_SIO_SET_EVENT_CHAR 6 /* Set the event character */
 340 #define FTDI_SIO_SET_ERROR_CHAR 7 /* Set the error character */
 341 #define FTDI_SIO_SET_LATENCY_TIMER      9 /* Set the latency timer */
 342 #define FTDI_SIO_GET_LATENCY_TIMER      10 /* Get the latency timer */
 343
 344
 345 /*
 346  *   BmRequestType:  1100 0000b
 347  *   bRequest:       FTDI_E2_READ
 348  *   wValue:         0
 349  *   wIndex:         Address of word to read
 350  *   wLength:        2
 351  *   Data:           Will return a word of data from E2Address
 352  *
 353  */
 354
 355 /* Port Identifier Table */
 356 #define PIT_DEFAULT             0 /* SIOA */
 357 #define PIT_SIOA                1 /* SIOA */
 358 /* The device this driver is tested with one has only one port */
 359 #define PIT_SIOB                2 /* SIOB */
 360 #define PIT_PARALLEL            3 /* Parallel */
 361
 362 /* FTDI_SIO_RESET */
 363 #define FTDI_SIO_RESET_REQUEST FTDI_SIO_RESET
 364 #define FTDI_SIO_RESET_REQUEST_TYPE 0x40
 365 #define FTDI_SIO_RESET_SIO 0
 366 #define FTDI_SIO_RESET_PURGE_RX 1
 367 #define FTDI_SIO_RESET_PURGE_TX 2
 368
 369 /*
 370  * BmRequestType:  0100 0000B
 371  * bRequest:       FTDI_SIO_RESET
 372  * wValue:         Control Value
 373  *                   0 = Reset SIO
 374  *                   1 = Purge RX buffer
 375  *                   2 = Purge TX buffer
 376  * wIndex:         Port
 377  * wLength:        0
 378  * Data:           None
 379  *
 380  * The Reset SIO command has this effect:
 381  *
 382  *    Sets flow control set to 'none'
 383  *    Event char = $0D
 384  *    Event trigger = disabled
 385  *    Purge RX buffer
 386  *    Purge TX buffer
 387  *    Clear DTR
 388  *    Clear RTS
 389  *    baud and data format not reset
 390  *
 391  * The Purge RX and TX buffer commands affect nothing except the buffers
 392  *
 393    */
 394
 395 /* FTDI_SIO_SET_BAUDRATE */
 396 #define FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE 0x40
 397 #define FTDI_SIO_SET_BAUDRATE_REQUEST 3
 398
 399 /*
 400  * BmRequestType:  0100 0000B
 401  * bRequest:       FTDI_SIO_SET_BAUDRATE
 402  * wValue:         BaudDivisor value - see below
 403  * wIndex:         Port
 404  * wLength:        0
 405  * Data:           None
 406  * The BaudDivisor values are calculated as follows:
 407  * - BaseClock is either 12000000 or 48000000 depending on the device. FIXME: I wish
 408  *   I knew how to detect old chips to select proper base clock!
 409  * - BaudDivisor is a fixed point number encoded in a funny way.
 410  *   (--WRONG WAY OF THINKING--)
 411  *   BaudDivisor is a fixed point number encoded with following bit weighs:
 412  *   (-2)(-1)(13..0). It is a radical with a denominator of 4, so values
 413  *   end with 0.0 (00...), 0.25 (10...), 0.5 (01...), and 0.75 (11...).
 414  *   (--THE REALITY--)
 415  *   The both-bits-set has quite different meaning from 0.75 - the chip designers
 416  *   have decided it to mean 0.125 instead of 0.75.
 417  *   This info looked up in FTDI application note "FT8U232 DEVICES \ Data Rates
 418  *   and Flow Control Consideration for USB to RS232".
 419  * - BaudDivisor = (BaseClock / 16) / BaudRate, where the (=) operation should
 420  *   automagically re-encode the resulting value to take fractions into consideration.
 421  * As all values are integers, some bit twiddling is in order:
 422  *   BaudDivisor = (BaseClock / 16 / BaudRate) |
 423  *   (((BaseClock / 2 / BaudRate) & 4) ? 0x4000    // 0.5
 424  *    : ((BaseClock / 2 / BaudRate) & 2) ? 0x8000  // 0.25
 425  *    : ((BaseClock / 2 / BaudRate) & 1) ? 0xc000  // 0.125
 426  *    : 0)
 427  *
 428  * For the FT232BM, a 17th divisor bit was introduced to encode the multiples
 429  * of 0.125 missing from the FT8U232AM.  Bits 16 to 14 are coded as follows
 430  * (the first four codes are the same as for the FT8U232AM, where bit 16 is
 431  * always 0):
 432  *   000 - add .000 to divisor
 433  *   001 - add .500 to divisor
 434  *   010 - add .250 to divisor
 435  *   011 - add .125 to divisor
 436  *   100 - add .375 to divisor
 437  *   101 - add .625 to divisor
 438  *   110 - add .750 to divisor
 439  *   111 - add .875 to divisor
 440  * Bits 15 to 0 of the 17-bit divisor are placed in the urb value.  Bit 16 is
 441  * placed in bit 0 of the urb index.
 442  *
 443  * Note that there are a couple of special cases to support the highest baud
 444  * rates.  If the calculated divisor value is 1, this needs to be replaced with
 445  * 0.  Additionally for the FT232BM, if the calculated divisor value is 0x4001
 446  * (1.5), this needs to be replaced with 0x0001 (1) (but this divisor value is
 447  * not supported by the FT8U232AM).
 448  */
 449
 450 typedef enum {
 451         SIO = 1,
 452         FT8U232AM = 2,
 453         FT232BM = 3,
 454         FT2232C = 4,
 455 } ftdi_chip_type_t;
 456
 457 typedef enum {
 458  ftdi_sio_b300 = 0,
 459  ftdi_sio_b600 = 1,
 460  ftdi_sio_b1200 = 2,
 461  ftdi_sio_b2400 = 3,
 462  ftdi_sio_b4800 = 4,
 463  ftdi_sio_b9600 = 5,
 464  ftdi_sio_b19200 = 6,
 465  ftdi_sio_b38400 = 7,
 466  ftdi_sio_b57600 = 8,
 467  ftdi_sio_b115200 = 9
 468 } FTDI_SIO_baudrate_t ;
 469
 470 /*
 471  * The ftdi_8U232AM_xxMHz_byyy constants have been removed. The encoded divisor values
 472  * are calculated internally.
 473  */
 474
 475 #define FTDI_SIO_SET_DATA_REQUEST FTDI_SIO_SET_DATA
 476 #define FTDI_SIO_SET_DATA_REQUEST_TYPE 0x40
 477 #define FTDI_SIO_SET_DATA_PARITY_NONE (0x0 << 8 )
 478 #define FTDI_SIO_SET_DATA_PARITY_ODD (0x1 << 8 )
 479 #define FTDI_SIO_SET_DATA_PARITY_EVEN (0x2 << 8 )
 480 #define FTDI_SIO_SET_DATA_PARITY_MARK (0x3 << 8 )
 481 #define FTDI_SIO_SET_DATA_PARITY_SPACE (0x4 << 8 )
 482 #define FTDI_SIO_SET_DATA_STOP_BITS_1 (0x0 << 11 )
 483 #define FTDI_SIO_SET_DATA_STOP_BITS_15 (0x1 << 11 )
 484 #define FTDI_SIO_SET_DATA_STOP_BITS_2 (0x2 << 11 )
 485 #define FTDI_SIO_SET_BREAK (0x1 << 14)
 486 /* FTDI_SIO_SET_DATA */
 487
 488 /*
 489  * BmRequestType:  0100 0000B
 490  * bRequest:       FTDI_SIO_SET_DATA
 491  * wValue:         Data characteristics (see below)
 492  * wIndex:         Port
 493  * wLength:        0
 494  * Data:           No
 495  *
 496  * Data characteristics
 497  *
 498  *   B0..7   Number of data bits
 499  *   B8..10  Parity
 500  *           0 = None
 501  *           1 = Odd
 502  *           2 = Even
 503  *           3 = Mark
 504  *           4 = Space
 505  *   B11..13 Stop Bits
 506  *           0 = 1
 507  *           1 = 1.5
 508  *           2 = 2
 509  *   B14
 510  *           1 = TX ON (break)
 511  *           0 = TX OFF (normal state)
 512  *   B15 Reserved
 513  *
 514  */
 515
 516
 517
 518 /* FTDI_SIO_MODEM_CTRL */
 519 #define FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE 0x40
 520 #define FTDI_SIO_SET_MODEM_CTRL_REQUEST FTDI_SIO_MODEM_CTRL
 521
 522 /*
 523  * BmRequestType:   0100 0000B
 524  * bRequest:        FTDI_SIO_MODEM_CTRL
 525  * wValue:          ControlValue (see below)
 526  * wIndex:          Port
 527  * wLength:         0
 528  * Data:            None
 529  *
 530  * NOTE: If the device is in RTS/CTS flow control, the RTS set by this
 531  * command will be IGNORED without an error being returned
 532  * Also - you can not set DTR and RTS with one control message
 533  */
 534
 535 #define FTDI_SIO_SET_DTR_MASK 0x1
 536 #define FTDI_SIO_SET_DTR_HIGH ( 1 | ( FTDI_SIO_SET_DTR_MASK  << 8))
 537 #define FTDI_SIO_SET_DTR_LOW  ( 0 | ( FTDI_SIO_SET_DTR_MASK  << 8))
 538 #define FTDI_SIO_SET_RTS_MASK 0x2
 539 #define FTDI_SIO_SET_RTS_HIGH ( 2 | ( FTDI_SIO_SET_RTS_MASK << 8 ))
 540 #define FTDI_SIO_SET_RTS_LOW ( 0 | ( FTDI_SIO_SET_RTS_MASK << 8 ))
 541
 542 /*
 543  * ControlValue
 544  * B0    DTR state
 545  *          0 = reset
 546  *          1 = set
 547  * B1    RTS state
 548  *          0 = reset
 549  *          1 = set
 550  * B2..7 Reserved
 551  * B8    DTR state enable
 552  *          0 = ignore
 553  *          1 = use DTR state
 554  * B9    RTS state enable
 555  *          0 = ignore
 556  *          1 = use RTS state
 557  * B10..15 Reserved
 558  */
 559
 560 /* FTDI_SIO_SET_FLOW_CTRL */
 561 #define FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE 0x40
 562 #define FTDI_SIO_SET_FLOW_CTRL_REQUEST FTDI_SIO_SET_FLOW_CTRL
 563 #define FTDI_SIO_DISABLE_FLOW_CTRL 0x0
 564 #define FTDI_SIO_RTS_CTS_HS (0x1 << 8)
 565 #define FTDI_SIO_DTR_DSR_HS (0x2 << 8)
 566 #define FTDI_SIO_XON_XOFF_HS (0x4 << 8)
 567 /*
 568  *   BmRequestType:  0100 0000b
 569  *   bRequest:       FTDI_SIO_SET_FLOW_CTRL
 570  *   wValue:         Xoff/Xon
 571  *   wIndex:         Protocol/Port - hIndex is protocl / lIndex is port
 572  *   wLength:        0
 573  *   Data:           None
 574  *
 575  * hIndex protocol is:
 576  *   B0 Output handshaking using RTS/CTS
 577  *       0 = disabled
 578  *       1 = enabled
 579  *   B1 Output handshaking using DTR/DSR
 580  *       0 = disabled
 581  *       1 = enabled
 582  *   B2 Xon/Xoff handshaking
 583  *       0 = disabled
 584  *       1 = enabled
 585  *
 586  * A value of zero in the hIndex field disables handshaking
 587  *
 588  * If Xon/Xoff handshaking is specified, the hValue field should contain the XOFF character
 589  * and the lValue field contains the XON character.
 590  */
 591
 592 /*
 593  * FTDI_SIO_GET_LATENCY_TIMER
 594  *
 595  * Set the timeout interval. The FTDI collects data from the slave
 596  * device, transmitting it to the host when either A) 62 bytes are
 597  * received, or B) the timeout interval has elapsed and the buffer
 598  * contains at least 1 byte.  Setting this value to a small number
 599  * can dramatically improve performance for applications which send
 600  * small packets, since the default value is 16ms.
 601  */
 602 #define  FTDI_SIO_GET_LATENCY_TIMER_REQUEST FTDI_SIO_GET_LATENCY_TIMER
 603 #define  FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE 0xC0
 604
 605 /*
 606  *  BmRequestType:   1100 0000b
 607  *  bRequest:        FTDI_SIO_GET_LATENCY_TIMER
 608  *  wValue:          0
 609  *  wIndex:          Port
 610  *  wLength:         0
 611  *  Data:            latency (on return)
 612  */
 613
 614 /*
 615  * FTDI_SIO_SET_LATENCY_TIMER
 616  *
 617  * Set the timeout interval. The FTDI collects data from the slave
 618  * device, transmitting it to the host when either A) 62 bytes are
 619  * received, or B) the timeout interval has elapsed and the buffer
 620  * contains at least 1 byte.  Setting this value to a small number
 621  * can dramatically improve performance for applications which send
 622  * small packets, since the default value is 16ms.
 623  */
 624 #define  FTDI_SIO_SET_LATENCY_TIMER_REQUEST FTDI_SIO_SET_LATENCY_TIMER
 625 #define  FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE 0x40
 626
 627 /*
 628  *  BmRequestType:   0100 0000b
 629  *  bRequest:        FTDI_SIO_SET_LATENCY_TIMER
 630  *  wValue:          Latency (milliseconds)
 631  *  wIndex:          Port
 632  *  wLength:         0
 633  *  Data:            None
 634  *
 635  * wValue:
 636  *   B0..7   Latency timer
 637  *   B8..15  0
 638  *
 639  */
 640
 641 /*
 642  * FTDI_SIO_SET_EVENT_CHAR
 643  *
 644  * Set the special event character for the specified communications port.
 645  * If the device sees this character it will immediately return the
 646  * data read so far - rather than wait 40ms or until 62 bytes are read
 647  * which is what normally happens.
 648  */
 649
 650
 651 #define  FTDI_SIO_SET_EVENT_CHAR_REQUEST FTDI_SIO_SET_EVENT_CHAR
 652 #define  FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE 0x40
 653
 654
 655 /*
 656  *  BmRequestType:   0100 0000b
 657  *  bRequest:        FTDI_SIO_SET_EVENT_CHAR
 658  *  wValue:          EventChar
 659  *  wIndex:          Port
 660  *  wLength:         0
 661  *  Data:            None
 662  *
 663  * wValue:
 664  *   B0..7   Event Character
 665  *   B8      Event Character Processing
 666  *             0 = disabled
 667  *             1 = enabled
 668  *   B9..15  Reserved
 669  *
 670  */
 671
 672 /* FTDI_SIO_SET_ERROR_CHAR */
 673
 674 /* Set the parity error replacement character for the specified communications port */
 675
 676 /*
 677  *  BmRequestType:  0100 0000b
 678  *  bRequest:       FTDI_SIO_SET_EVENT_CHAR
 679  *  wValue:         Error Char
 680  *  wIndex:         Port
 681  *  wLength:        0
 682  *  Data:           None
 683  *
 684  *Error Char
 685  *  B0..7  Error Character
 686  *  B8     Error Character Processing
 687  *           0 = disabled
 688  *           1 = enabled
 689  *  B9..15 Reserved
 690  *
 691  */
 692
 693 /* FTDI_SIO_GET_MODEM_STATUS */
 694 /* Retreive the current value of the modem status register */
 695
 696 #define FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE 0xc0
 697 #define FTDI_SIO_GET_MODEM_STATUS_REQUEST FTDI_SIO_GET_MODEM_STATUS
 698 #define FTDI_SIO_CTS_MASK 0x10
 699 #define FTDI_SIO_DSR_MASK 0x20
 700 #define FTDI_SIO_RI_MASK  0x40
 701 #define FTDI_SIO_RLSD_MASK 0x80
 702 /*
 703  *   BmRequestType:   1100 0000b
 704  *   bRequest:        FTDI_SIO_GET_MODEM_STATUS
 705  *   wValue:          zero
 706  *   wIndex:          Port
 707  *   wLength:         1
 708  *   Data:            Status
 709  *
 710  * One byte of data is returned
 711  * B0..3 0
 712  * B4    CTS
 713  *         0 = inactive
 714  *         1 = active
 715  * B5    DSR
 716  *         0 = inactive
 717  *         1 = active
 718  * B6    Ring Indicator (RI)
 719  *         0 = inactive
 720  *         1 = active
 721  * B7    Receive Line Signal Detect (RLSD)
 722  *         0 = inactive
 723  *         1 = active
 724  */
 725
 726
 727
 728 /* Descriptors returned by the device
 729  *
 730  *  Device Descriptor
 731  *
 732  * Offset       Field           Size    Value   Description
 733  * 0    bLength         1       0x12    Size of descriptor in bytes
 734  * 1    bDescriptorType 1       0x01    DEVICE Descriptor Type
 735  * 2    bcdUSB          2       0x0110  USB Spec Release Number
 736  * 4    bDeviceClass    1       0x00    Class Code
 737  * 5    bDeviceSubClass 1       0x00    SubClass Code
 738  * 6    bDeviceProtocol 1       0x00    Protocol Code
 739  * 7    bMaxPacketSize0 1       0x08    Maximum packet size for endpoint 0
 740  * 8    idVendor        2       0x0403  Vendor ID
 741  * 10   idProduct       2       0x8372  Product ID (FTDI_SIO_PID)
 742  * 12   bcdDevice       2       0x0001  Device release number
 743  * 14   iManufacturer   1       0x01    Index of man. string desc
 744  * 15   iProduct        1       0x02    Index of prod string desc
 745  * 16   iSerialNumber   1       0x02    Index of serial nmr string desc
 746  * 17   bNumConfigurations 1    0x01    Number of possible configurations
 747  *
 748  * Configuration Descriptor
 749  *
 750  * Offset       Field                   Size    Value
 751  * 0    bLength                 1       0x09    Size of descriptor in bytes
 752  * 1    bDescriptorType         1       0x02    CONFIGURATION Descriptor Type
 753  * 2    wTotalLength            2       0x0020  Total length of data
 754  * 4    bNumInterfaces          1       0x01    Number of interfaces supported
 755  * 5    bConfigurationValue     1       0x01    Argument for SetCOnfiguration() req
 756  * 6    iConfiguration          1       0x02    Index of config string descriptor
 757  * 7    bmAttributes            1       0x20    Config characteristics Remote Wakeup
 758  * 8    MaxPower                1       0x1E    Max power consumption
 759  *
 760  * Interface Descriptor
 761  *
 762  * Offset       Field                   Size    Value
 763  * 0    bLength                 1       0x09    Size of descriptor in bytes
 764  * 1    bDescriptorType         1       0x04    INTERFACE Descriptor Type
 765  * 2    bInterfaceNumber        1       0x00    Number of interface
 766  * 3    bAlternateSetting       1       0x00    Value used to select alternate
 767  * 4    bNumEndpoints           1       0x02    Number of endpoints
 768  * 5    bInterfaceClass         1       0xFF    Class Code
 769  * 6    bInterfaceSubClass      1       0xFF    Subclass Code
 770  * 7    bInterfaceProtocol      1       0xFF    Protocol Code
 771  * 8    iInterface              1       0x02    Index of interface string description
 772  *
 773  * IN Endpoint Descriptor
 774  *
 775  * Offset       Field                   Size    Value
 776  * 0    bLength                 1       0x07    Size of descriptor in bytes
 777  * 1    bDescriptorType         1       0x05    ENDPOINT descriptor type
 778  * 2    bEndpointAddress        1       0x82    Address of endpoint
 779  * 3    bmAttributes            1       0x02    Endpoint attributes - Bulk
 780  * 4    bNumEndpoints           2       0x0040  maximum packet size
 781  * 5    bInterval               1       0x00    Interval for polling endpoint
 782  *
 783  * OUT Endpoint Descriptor
 784  *
 785  * Offset       Field                   Size    Value
 786  * 0    bLength                 1       0x07    Size of descriptor in bytes
 787  * 1    bDescriptorType         1       0x05    ENDPOINT descriptor type
 788  * 2    bEndpointAddress        1       0x02    Address of endpoint
 789  * 3    bmAttributes            1       0x02    Endpoint attributes - Bulk
 790  * 4    bNumEndpoints           2       0x0040  maximum packet size
 791  * 5    bInterval               1       0x00    Interval for polling endpoint
 792  *
 793  * DATA FORMAT
 794  *
 795  * IN Endpoint
 796  *
 797  * The device reserves the first two bytes of data on this endpoint to contain the current
 798  * values of the modem and line status registers. In the absence of data, the device
 799  * generates a message consisting of these two status bytes every 40 ms
 800  *
 801  * Byte 0: Modem Status
 802  *
 803  * Offset       Description
 804  * B0   Reserved - must be 1
 805  * B1   Reserved - must be 0
 806  * B2   Reserved - must be 0
 807  * B3   Reserved - must be 0
 808  * B4   Clear to Send (CTS)
 809  * B5   Data Set Ready (DSR)
 810  * B6   Ring Indicator (RI)
 811  * B7   Receive Line Signal Detect (RLSD)
 812  *
 813  * Byte 1: Line Status
 814  *
 815  * Offset       Description
 816  * B0   Data Ready (DR)
 817  * B1   Overrun Error (OE)
 818  * B2   Parity Error (PE)
 819  * B3   Framing Error (FE)
 820  * B4   Break Interrupt (BI)
 821  * B5   Transmitter Holding Register (THRE)
 822  * B6   Transmitter Empty (TEMT)
 823  * B7   Error in RCVR FIFO
 824  *
 825  */
 826 #define FTDI_RS0_CTS    (1 << 4)
 827 #define FTDI_RS0_DSR    (1 << 5)
 828 #define FTDI_RS0_RI     (1 << 6)
 829 #define FTDI_RS0_RLSD   (1 << 7)
 830
 831 #define FTDI_RS_DR  1
 832 #define FTDI_RS_OE (1<<1)
 833 #define FTDI_RS_PE (1<<2)
 834 #define FTDI_RS_FE (1<<3)
 835 #define FTDI_RS_BI (1<<4)
 836 #define FTDI_RS_THRE (1<<5)
 837 #define FTDI_RS_TEMT (1<<6)
 838 #define FTDI_RS_FIFO  (1<<7)
 839
 840 /*
 841  * OUT Endpoint
 842  *
 843  * This device reserves the first bytes of data on this endpoint contain the length
 844  * and port identifier of the message. For the FTDI USB Serial converter the port
 845  * identifier is always 1.
 846  *
 847  * Byte 0: Line Status
 848  *
 849  * Offset       Description
 850  * B0   Reserved - must be 1
 851  * B1   Reserved - must be 0
 852  * B2..7        Length of message - (not including Byte 0)
 853  *
 854  */
 855