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 tranceiver */
 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 /* ELV USB Module UO100 (PID sent by Stefan Frings) */
 146 #define FTDI_ELV_UO100_PID      0xFB58  /* Product Id */
 147
 148 /*
 149  * Definitions for ID TECH (www.idt-net.com) devices
 150  */
 151 #define IDTECH_VID              0x0ACD  /* ID TECH Vendor ID */
 152 #define IDTECH_IDT1221U_PID     0x0300  /* IDT1221U USB to RS-232 adapter */
 153
 154 /*
 155  * Definitions for Omnidirectional Control Technology, Inc. devices
 156  */
 157 #define OCT_VID                 0x0B39  /* OCT vendor ID */
 158 /* Note: OCT US101 is also rebadged as Dick Smith Electronics (NZ) XH6381 */
 159 /* Also rebadged as SIIG Inc. model US2308 */
 160 #define OCT_US101_PID           0x0421  /* OCT US101 USB to RS-232 */
 161
 162 /* an infrared receiver for user access control with IR tags */
 163 #define FTDI_PIEGROUP_PID       0xF208  /* Product Id */
 164
 165 /*
 166  * Protego product ids
 167  */
 168 #define PROTEGO_SPECIAL_1       0xFC70  /* special/unknown device */
 169 #define PROTEGO_R2X0            0xFC71  /* R200-USB TRNG unit (R210, R220, and R230) */
 170 #define PROTEGO_SPECIAL_3       0xFC72  /* special/unknown device */
 171 #define PROTEGO_SPECIAL_4       0xFC73  /* special/unknown device */
 172
 173 /*
 174  * Gude Analog- und Digitalsysteme GmbH
 175  */
 176 #define FTDI_GUDEADS_E808_PID    0xE808
 177 #define FTDI_GUDEADS_E809_PID    0xE809
 178 #define FTDI_GUDEADS_E80A_PID    0xE80A
 179 #define FTDI_GUDEADS_E80B_PID    0xE80B
 180 #define FTDI_GUDEADS_E80C_PID    0xE80C
 181 #define FTDI_GUDEADS_E80D_PID    0xE80D
 182 #define FTDI_GUDEADS_E80E_PID    0xE80E
 183 #define FTDI_GUDEADS_E80F_PID    0xE80F
 184 #define FTDI_GUDEADS_E888_PID    0xE888  /* Expert ISDN Control USB */
 185 #define FTDI_GUDEADS_E889_PID    0xE889  /* USB RS-232 OptoBridge */
 186 #define FTDI_GUDEADS_E88A_PID    0xE88A
 187 #define FTDI_GUDEADS_E88B_PID    0xE88B
 188 #define FTDI_GUDEADS_E88C_PID    0xE88C
 189 #define FTDI_GUDEADS_E88D_PID    0xE88D
 190 #define FTDI_GUDEADS_E88E_PID    0xE88E
 191 #define FTDI_GUDEADS_E88F_PID    0xE88F
 192
 193 /*
 194  * Linx Technologies product ids
 195  */
 196 #define LINX_SDMUSBQSS_PID      0xF448  /* Linx SDM-USB-QS-S */
 197 #define LINX_MASTERDEVEL2_PID   0xF449   /* Linx Master Development 2.0 */
 198 #define LINX_FUTURE_0_PID   0xF44A   /* Linx future device */
 199 #define LINX_FUTURE_1_PID   0xF44B   /* Linx future device */
 200 #define LINX_FUTURE_2_PID   0xF44C   /* Linx future device */
 201
 202 /* CCS Inc. ICDU/ICDU40 product ID - the FT232BM is used in an in-circuit-debugger */
 203 /* unit for PIC16's/PIC18's */
 204 #define FTDI_CCSICDU20_0_PID    0xF9D0
 205 #define FTDI_CCSICDU40_1_PID    0xF9D1
 206
 207 /* Inside Accesso contactless reader (http://www.insidefr.com) */
 208 #define INSIDE_ACCESSO          0xFAD0
 209
 210 /*
 211  * Intrepid Control Systems (http://www.intrepidcs.com/) ValueCAN and NeoVI
 212  */
 213 #define INTREPID_VID            0x093C
 214 #define INTREPID_VALUECAN_PID   0x0601
 215 #define INTREPID_NEOVI_PID      0x0701
 216
 217 /*
 218  * Falcom Wireless Communications GmbH
 219  */
 220 #define FALCOM_VID              0x0F94  /* Vendor Id */
 221 #define FALCOM_TWIST_PID        0x0001  /* Falcom Twist USB GPRS modem */
 222
 223 /*
 224  * SUUNTO product ids
 225  */
 226 #define FTDI_SUUNTO_SPORTS_PID  0xF680  /* Suunto Sports instrument */
 227
 228 /* Commands */
 229 #define FTDI_SIO_RESET          0 /* Reset the port */
 230 #define FTDI_SIO_MODEM_CTRL     1 /* Set the modem control register */
 231 #define FTDI_SIO_SET_FLOW_CTRL  2 /* Set flow control register */
 232 #define FTDI_SIO_SET_BAUD_RATE  3 /* Set baud rate */
 233 #define FTDI_SIO_SET_DATA       4 /* Set the data characteristics of the port */
 234 #define FTDI_SIO_GET_MODEM_STATUS       5 /* Retrieve current value of modern status register */
 235 #define FTDI_SIO_SET_EVENT_CHAR 6 /* Set the event character */
 236 #define FTDI_SIO_SET_ERROR_CHAR 7 /* Set the error character */
 237
 238 /* Port interface code for FT2232C */
 239 #define INTERFACE_A             1
 240 #define INTERFACE_B             2
 241
 242
 243 /*
 244  *   BmRequestType:  1100 0000b
 245  *   bRequest:       FTDI_E2_READ
 246  *   wValue:         0
 247  *   wIndex:         Address of word to read
 248  *   wLength:        2
 249  *   Data:           Will return a word of data from E2Address
 250  *
 251  */
 252
 253 /* Port Identifier Table */
 254 #define PIT_DEFAULT             0 /* SIOA */
 255 #define PIT_SIOA                1 /* SIOA */
 256 /* The device this driver is tested with one has only one port */
 257 #define PIT_SIOB                2 /* SIOB */
 258 #define PIT_PARALLEL            3 /* Parallel */
 259
 260 /* FTDI_SIO_RESET */
 261 #define FTDI_SIO_RESET_REQUEST FTDI_SIO_RESET
 262 #define FTDI_SIO_RESET_REQUEST_TYPE 0x40
 263 #define FTDI_SIO_RESET_SIO 0
 264 #define FTDI_SIO_RESET_PURGE_RX 1
 265 #define FTDI_SIO_RESET_PURGE_TX 2
 266
 267 /*
 268  * BmRequestType:  0100 0000B
 269  * bRequest:       FTDI_SIO_RESET
 270  * wValue:         Control Value
 271  *                   0 = Reset SIO
 272  *                   1 = Purge RX buffer
 273  *                   2 = Purge TX buffer
 274  * wIndex:         Port
 275  * wLength:        0
 276  * Data:           None
 277  *
 278  * The Reset SIO command has this effect:
 279  *
 280  *    Sets flow control set to 'none'
 281  *    Event char = $0D
 282  *    Event trigger = disabled
 283  *    Purge RX buffer
 284  *    Purge TX buffer
 285  *    Clear DTR
 286  *    Clear RTS
 287  *    baud and data format not reset
 288  *
 289  * The Purge RX and TX buffer commands affect nothing except the buffers
 290  *
 291    */
 292
 293 /* FTDI_SIO_SET_BAUDRATE */
 294 #define FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE 0x40
 295 #define FTDI_SIO_SET_BAUDRATE_REQUEST 3
 296
 297 /*
 298  * BmRequestType:  0100 0000B
 299  * bRequest:       FTDI_SIO_SET_BAUDRATE
 300  * wValue:         BaudDivisor value - see below
 301  * wIndex:         Port
 302  * wLength:        0
 303  * Data:           None
 304  * The BaudDivisor values are calculated as follows:
 305  * - BaseClock is either 12000000 or 48000000 depending on the device. FIXME: I wish
 306  *   I knew how to detect old chips to select proper base clock!
 307  * - BaudDivisor is a fixed point number encoded in a funny way.
 308  *   (--WRONG WAY OF THINKING--)
 309  *   BaudDivisor is a fixed point number encoded with following bit weighs:
 310  *   (-2)(-1)(13..0). It is a radical with a denominator of 4, so values
 311  *   end with 0.0 (00...), 0.25 (10...), 0.5 (01...), and 0.75 (11...).
 312  *   (--THE REALITY--)
 313  *   The both-bits-set has quite different meaning from 0.75 - the chip designers
 314  *   have decided it to mean 0.125 instead of 0.75.
 315  *   This info looked up in FTDI application note "FT8U232 DEVICES \ Data Rates
 316  *   and Flow Control Consideration for USB to RS232".
 317  * - BaudDivisor = (BaseClock / 16) / BaudRate, where the (=) operation should
 318  *   automagically re-encode the resulting value to take fractions into consideration.
 319  * As all values are integers, some bit twiddling is in order:
 320  *   BaudDivisor = (BaseClock / 16 / BaudRate) |
 321  *   (((BaseClock / 2 / BaudRate) & 4) ? 0x4000    // 0.5
 322  *    : ((BaseClock / 2 / BaudRate) & 2) ? 0x8000  // 0.25
 323  *    : ((BaseClock / 2 / BaudRate) & 1) ? 0xc000  // 0.125
 324  *    : 0)
 325  *
 326  * For the FT232BM, a 17th divisor bit was introduced to encode the multiples
 327  * of 0.125 missing from the FT8U232AM.  Bits 16 to 14 are coded as follows
 328  * (the first four codes are the same as for the FT8U232AM, where bit 16 is
 329  * always 0):
 330  *   000 - add .000 to divisor
 331  *   001 - add .500 to divisor
 332  *   010 - add .250 to divisor
 333  *   011 - add .125 to divisor
 334  *   100 - add .375 to divisor
 335  *   101 - add .625 to divisor
 336  *   110 - add .750 to divisor
 337  *   111 - add .875 to divisor
 338  * Bits 15 to 0 of the 17-bit divisor are placed in the urb value.  Bit 16 is
 339  * placed in bit 0 of the urb index.
 340  *
 341  * Note that there are a couple of special cases to support the highest baud
 342  * rates.  If the calculated divisor value is 1, this needs to be replaced with
 343  * 0.  Additionally for the FT232BM, if the calculated divisor value is 0x4001
 344  * (1.5), this needs to be replaced with 0x0001 (1) (but this divisor value is
 345  * not supported by the FT8U232AM).
 346  */
 347
 348 typedef enum {
 349         SIO = 1,
 350         FT8U232AM = 2,
 351         FT232BM = 3,
 352         FT2232C = 4,
 353 } ftdi_chip_type_t;
 354
 355 typedef enum {
 356  ftdi_sio_b300 = 0,
 357  ftdi_sio_b600 = 1,
 358  ftdi_sio_b1200 = 2,
 359  ftdi_sio_b2400 = 3,
 360  ftdi_sio_b4800 = 4,
 361  ftdi_sio_b9600 = 5,
 362  ftdi_sio_b19200 = 6,
 363  ftdi_sio_b38400 = 7,
 364  ftdi_sio_b57600 = 8,
 365  ftdi_sio_b115200 = 9
 366 } FTDI_SIO_baudrate_t ;
 367
 368 /*
 369  * The ftdi_8U232AM_xxMHz_byyy constants have been removed. The encoded divisor values
 370  * are calculated internally.
 371  */
 372
 373 #define FTDI_SIO_SET_DATA_REQUEST FTDI_SIO_SET_DATA
 374 #define FTDI_SIO_SET_DATA_REQUEST_TYPE 0x40
 375 #define FTDI_SIO_SET_DATA_PARITY_NONE (0x0 << 8 )
 376 #define FTDI_SIO_SET_DATA_PARITY_ODD (0x1 << 8 )
 377 #define FTDI_SIO_SET_DATA_PARITY_EVEN (0x2 << 8 )
 378 #define FTDI_SIO_SET_DATA_PARITY_MARK (0x3 << 8 )
 379 #define FTDI_SIO_SET_DATA_PARITY_SPACE (0x4 << 8 )
 380 #define FTDI_SIO_SET_DATA_STOP_BITS_1 (0x0 << 11 )
 381 #define FTDI_SIO_SET_DATA_STOP_BITS_15 (0x1 << 11 )
 382 #define FTDI_SIO_SET_DATA_STOP_BITS_2 (0x2 << 11 )
 383 #define FTDI_SIO_SET_BREAK (0x1 << 14)
 384 /* FTDI_SIO_SET_DATA */
 385
 386 /*
 387  * BmRequestType:  0100 0000B
 388  * bRequest:       FTDI_SIO_SET_DATA
 389  * wValue:         Data characteristics (see below)
 390  * wIndex:         Port
 391  * wLength:        0
 392  * Data:           No
 393  *
 394  * Data characteristics
 395  *
 396  *   B0..7   Number of data bits
 397  *   B8..10  Parity
 398  *           0 = None
 399  *           1 = Odd
 400  *           2 = Even
 401  *           3 = Mark
 402  *           4 = Space
 403  *   B11..13 Stop Bits
 404  *           0 = 1
 405  *           1 = 1.5
 406  *           2 = 2
 407  *   B14
 408  *           1 = TX ON (break)
 409  *           0 = TX OFF (normal state)
 410  *   B15 Reserved
 411  *
 412  */
 413
 414
 415
 416 /* FTDI_SIO_MODEM_CTRL */
 417 #define FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE 0x40
 418 #define FTDI_SIO_SET_MODEM_CTRL_REQUEST FTDI_SIO_MODEM_CTRL
 419
 420 /*
 421  * BmRequestType:   0100 0000B
 422  * bRequest:        FTDI_SIO_MODEM_CTRL
 423  * wValue:          ControlValue (see below)
 424  * wIndex:          Port
 425  * wLength:         0
 426  * Data:            None
 427  *
 428  * NOTE: If the device is in RTS/CTS flow control, the RTS set by this
 429  * command will be IGNORED without an error being returned
 430  * Also - you can not set DTR and RTS with one control message
 431  */
 432
 433 #define FTDI_SIO_SET_DTR_MASK 0x1
 434 #define FTDI_SIO_SET_DTR_HIGH ( 1 | ( FTDI_SIO_SET_DTR_MASK  << 8))
 435 #define FTDI_SIO_SET_DTR_LOW  ( 0 | ( FTDI_SIO_SET_DTR_MASK  << 8))
 436 #define FTDI_SIO_SET_RTS_MASK 0x2
 437 #define FTDI_SIO_SET_RTS_HIGH ( 2 | ( FTDI_SIO_SET_RTS_MASK << 8 ))
 438 #define FTDI_SIO_SET_RTS_LOW ( 0 | ( FTDI_SIO_SET_RTS_MASK << 8 ))
 439
 440 /*
 441  * ControlValue
 442  * B0    DTR state
 443  *          0 = reset
 444  *          1 = set
 445  * B1    RTS state
 446  *          0 = reset
 447  *          1 = set
 448  * B2..7 Reserved
 449  * B8    DTR state enable
 450  *          0 = ignore
 451  *          1 = use DTR state
 452  * B9    RTS state enable
 453  *          0 = ignore
 454  *          1 = use RTS state
 455  * B10..15 Reserved
 456  */
 457
 458 /* FTDI_SIO_SET_FLOW_CTRL */
 459 #define FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE 0x40
 460 #define FTDI_SIO_SET_FLOW_CTRL_REQUEST FTDI_SIO_SET_FLOW_CTRL
 461 #define FTDI_SIO_DISABLE_FLOW_CTRL 0x0
 462 #define FTDI_SIO_RTS_CTS_HS (0x1 << 8)
 463 #define FTDI_SIO_DTR_DSR_HS (0x2 << 8)
 464 #define FTDI_SIO_XON_XOFF_HS (0x4 << 8)
 465 /*
 466  *   BmRequestType:  0100 0000b
 467  *   bRequest:       FTDI_SIO_SET_FLOW_CTRL
 468  *   wValue:         Xoff/Xon
 469  *   wIndex:         Protocol/Port - hIndex is protocl / lIndex is port
 470  *   wLength:        0
 471  *   Data:           None
 472  *
 473  * hIndex protocol is:
 474  *   B0 Output handshaking using RTS/CTS
 475  *       0 = disabled
 476  *       1 = enabled
 477  *   B1 Output handshaking using DTR/DSR
 478  *       0 = disabled
 479  *       1 = enabled
 480  *   B2 Xon/Xoff handshaking
 481  *       0 = disabled
 482  *       1 = enabled
 483  *
 484  * A value of zero in the hIndex field disables handshaking
 485  *
 486  * If Xon/Xoff handshaking is specified, the hValue field should contain the XOFF character
 487  * and the lValue field contains the XON character.
 488  */
 489
 490 /*
 491  * FTDI_SIO_SET_EVENT_CHAR
 492  *
 493  * Set the special event character for the specified communications port.
 494  * If the device sees this character it will immediately return the
 495  * data read so far - rather than wait 40ms or until 62 bytes are read
 496  * which is what normally happens.
 497  */
 498
 499
 500 #define  FTDI_SIO_SET_EVENT_CHAR_REQUEST FTDI_SIO_SET_EVENT_CHAR
 501 #define  FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE 0x40
 502
 503
 504 /*
 505  *  BmRequestType:   0100 0000b
 506  *  bRequest:        FTDI_SIO_SET_EVENT_CHAR
 507  *  wValue:          EventChar
 508  *  wIndex:          Port
 509  *  wLength:         0
 510  *  Data:            None
 511  *
 512  * wValue:
 513  *   B0..7   Event Character
 514  *   B8      Event Character Processing
 515  *             0 = disabled
 516  *             1 = enabled
 517  *   B9..15  Reserved
 518  *
 519  */
 520
 521 /* FTDI_SIO_SET_ERROR_CHAR */
 522
 523 /* Set the parity error replacement character for the specified communications port */
 524
 525 /*
 526  *  BmRequestType:  0100 0000b
 527  *  bRequest:       FTDI_SIO_SET_EVENT_CHAR
 528  *  wValue:         Error Char
 529  *  wIndex:         Port
 530  *  wLength:        0
 531  *  Data:           None
 532  *
 533  *Error Char
 534  *  B0..7  Error Character
 535  *  B8     Error Character Processing
 536  *           0 = disabled
 537  *           1 = enabled
 538  *  B9..15 Reserved
 539  *
 540  */
 541
 542 /* FTDI_SIO_GET_MODEM_STATUS */
 543 /* Retreive the current value of the modem status register */
 544
 545 #define FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE 0xc0
 546 #define FTDI_SIO_GET_MODEM_STATUS_REQUEST FTDI_SIO_GET_MODEM_STATUS
 547 #define FTDI_SIO_CTS_MASK 0x10
 548 #define FTDI_SIO_DSR_MASK 0x20
 549 #define FTDI_SIO_RI_MASK  0x40
 550 #define FTDI_SIO_RLSD_MASK 0x80
 551 /*
 552  *   BmRequestType:   1100 0000b
 553  *   bRequest:        FTDI_SIO_GET_MODEM_STATUS
 554  *   wValue:          zero
 555  *   wIndex:          Port
 556  *   wLength:         1
 557  *   Data:            Status
 558  *
 559  * One byte of data is returned
 560  * B0..3 0
 561  * B4    CTS
 562  *         0 = inactive
 563  *         1 = active
 564  * B5    DSR
 565  *         0 = inactive
 566  *         1 = active
 567  * B6    Ring Indicator (RI)
 568  *         0 = inactive
 569  *         1 = active
 570  * B7    Receive Line Signal Detect (RLSD)
 571  *         0 = inactive
 572  *         1 = active
 573  */
 574
 575
 576
 577 /* Descriptors returned by the device
 578  *
 579  *  Device Descriptor
 580  *
 581  * Offset       Field           Size    Value   Description
 582  * 0    bLength         1       0x12    Size of descriptor in bytes
 583  * 1    bDescriptorType 1       0x01    DEVICE Descriptor Type
 584  * 2    bcdUSB          2       0x0110  USB Spec Release Number
 585  * 4    bDeviceClass    1       0x00    Class Code
 586  * 5    bDeviceSubClass 1       0x00    SubClass Code
 587  * 6    bDeviceProtocol 1       0x00    Protocol Code
 588  * 7    bMaxPacketSize0 1       0x08    Maximum packet size for endpoint 0
 589  * 8    idVendor        2       0x0403  Vendor ID
 590  * 10   idProduct       2       0x8372  Product ID (FTDI_SIO_PID)
 591  * 12   bcdDevice       2       0x0001  Device release number
 592  * 14   iManufacturer   1       0x01    Index of man. string desc
 593  * 15   iProduct        1       0x02    Index of prod string desc
 594  * 16   iSerialNumber   1       0x02    Index of serial nmr string desc
 595  * 17   bNumConfigurations 1    0x01    Number of possible configurations
 596  *
 597  * Configuration Descriptor
 598  *
 599  * Offset       Field                   Size    Value
 600  * 0    bLength                 1       0x09    Size of descriptor in bytes
 601  * 1    bDescriptorType         1       0x02    CONFIGURATION Descriptor Type
 602  * 2    wTotalLength            2       0x0020  Total length of data
 603  * 4    bNumInterfaces          1       0x01    Number of interfaces supported
 604  * 5    bConfigurationValue     1       0x01    Argument for SetCOnfiguration() req
 605  * 6    iConfiguration          1       0x02    Index of config string descriptor
 606  * 7    bmAttributes            1       0x20    Config characteristics Remote Wakeup
 607  * 8    MaxPower                1       0x1E    Max power consumption
 608  *
 609  * Interface Descriptor
 610  *
 611  * Offset       Field                   Size    Value
 612  * 0    bLength                 1       0x09    Size of descriptor in bytes
 613  * 1    bDescriptorType         1       0x04    INTERFACE Descriptor Type
 614  * 2    bInterfaceNumber        1       0x00    Number of interface
 615  * 3    bAlternateSetting       1       0x00    Value used to select alternate
 616  * 4    bNumEndpoints           1       0x02    Number of endpoints
 617  * 5    bInterfaceClass         1       0xFF    Class Code
 618  * 6    bInterfaceSubClass      1       0xFF    Subclass Code
 619  * 7    bInterfaceProtocol      1       0xFF    Protocol Code
 620  * 8    iInterface              1       0x02    Index of interface string description
 621  *
 622  * IN Endpoint Descriptor
 623  *
 624  * Offset       Field                   Size    Value
 625  * 0    bLength                 1       0x07    Size of descriptor in bytes
 626  * 1    bDescriptorType         1       0x05    ENDPOINT descriptor type
 627  * 2    bEndpointAddress        1       0x82    Address of endpoint
 628  * 3    bmAttributes            1       0x02    Endpoint attributes - Bulk
 629  * 4    bNumEndpoints           2       0x0040  maximum packet size
 630  * 5    bInterval               1       0x00    Interval for polling endpoint
 631  *
 632  * OUT Endpoint Descriptor
 633  *
 634  * Offset       Field                   Size    Value
 635  * 0    bLength                 1       0x07    Size of descriptor in bytes
 636  * 1    bDescriptorType         1       0x05    ENDPOINT descriptor type
 637  * 2    bEndpointAddress        1       0x02    Address of endpoint
 638  * 3    bmAttributes            1       0x02    Endpoint attributes - Bulk
 639  * 4    bNumEndpoints           2       0x0040  maximum packet size
 640  * 5    bInterval               1       0x00    Interval for polling endpoint
 641  *
 642  * DATA FORMAT
 643  *
 644  * IN Endpoint
 645  *
 646  * The device reserves the first two bytes of data on this endpoint to contain the current
 647  * values of the modem and line status registers. In the absence of data, the device
 648  * generates a message consisting of these two status bytes every 40 ms
 649  *
 650  * Byte 0: Modem Status
 651  *
 652  * Offset       Description
 653  * B0   Reserved - must be 1
 654  * B1   Reserved - must be 0
 655  * B2   Reserved - must be 0
 656  * B3   Reserved - must be 0
 657  * B4   Clear to Send (CTS)
 658  * B5   Data Set Ready (DSR)
 659  * B6   Ring Indicator (RI)
 660  * B7   Receive Line Signal Detect (RLSD)
 661  *
 662  * Byte 1: Line Status
 663  *
 664  * Offset       Description
 665  * B0   Data Ready (DR)
 666  * B1   Overrun Error (OE)
 667  * B2   Parity Error (PE)
 668  * B3   Framing Error (FE)
 669  * B4   Break Interrupt (BI)
 670  * B5   Transmitter Holding Register (THRE)
 671  * B6   Transmitter Empty (TEMT)
 672  * B7   Error in RCVR FIFO
 673  *
 674  */
 675 #define FTDI_RS0_CTS    (1 << 4)
 676 #define FTDI_RS0_DSR    (1 << 5)
 677 #define FTDI_RS0_RI     (1 << 6)
 678 #define FTDI_RS0_RLSD   (1 << 7)
 679
 680 #define FTDI_RS_DR  1
 681 #define FTDI_RS_OE (1<<1)
 682 #define FTDI_RS_PE (1<<2)
 683 #define FTDI_RS_FE (1<<3)
 684 #define FTDI_RS_BI (1<<4)
 685 #define FTDI_RS_THRE (1<<5)
 686 #define FTDI_RS_TEMT (1<<6)
 687 #define FTDI_RS_FIFO  (1<<7)
 688
 689 /*
 690  * OUT Endpoint
 691  *
 692  * This device reserves the first bytes of data on this endpoint contain the length
 693  * and port identifier of the message. For the FTDI USB Serial converter the port
 694  * identifier is always 1.
 695  *
 696  * Byte 0: Line Status
 697  *
 698  * Offset       Description
 699  * B0   Reserved - must be 1
 700  * B1   Reserved - must be 0
 701  * B2..7        Length of message - (not including Byte 0)
 702  *
 703  */
 704