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_RELAIS_PID 0xFA10  /* Relais device from Rudolf Gugler */
  30 #define FTDI_NF_RIC_VID 0x0DCD  /* Vendor Id */
  31 #define FTDI_NF_RIC_PID 0x0001  /* Product Id */
  32
  33 /* www.irtrans.de device */
  34 #define FTDI_IRTRANS_PID 0xFC60 /* Product Id */
  35
  36 /* www.crystalfontz.com devices - thanx for providing free devices for evaluation ! */
  37 /* they use the ftdi chipset for the USB interface and the vendor id is the same */
  38 #define FTDI_XF_632_PID 0xFC08  /* 632: 16x2 Character Display */
  39 #define FTDI_XF_634_PID 0xFC09  /* 634: 20x4 Character Display */
  40 #define FTDI_XF_547_PID 0xFC0A  /* 547: Two line Display */
  41 #define FTDI_XF_633_PID 0xFC0B  /* 633: 16x2 Character Display with Keys */
  42 #define FTDI_XF_631_PID 0xFC0C  /* 631: 20x2 Character Display */
  43 #define FTDI_XF_635_PID 0xFC0D  /* 635: 20x4 Character Display */
  44 #define FTDI_XF_640_PID 0xFC0E  /* 640: Two line Display */
  45 #define FTDI_XF_642_PID 0xFC0F  /* 642: Two line Display */
  46
  47 /* Video Networks Limited / Homechoice in the UK use an ftdi-based device for their 1Mb */
  48 /* broadband internet service.  The following PID is exhibited by the usb device supplied */
  49 /* (the VID is the standard ftdi vid (FTDI_VID) */
  50 #define FTDI_VNHCPCUSB_D_PID 0xfe38 /* Product Id */
  51
  52 /*
  53  * The following are the values for the Matrix Orbital LCD displays,
  54  * which are the FT232BM ( similar to the 8U232AM )
  55  */
  56 #define FTDI_MTXORB_0_PID      0xFA00  /* Matrix Orbital Product Id */
  57 #define FTDI_MTXORB_1_PID      0xFA01  /* Matrix Orbital Product Id */
  58 #define FTDI_MTXORB_2_PID      0xFA02  /* Matrix Orbital Product Id */
  59 #define FTDI_MTXORB_3_PID      0xFA03  /* Matrix Orbital Product Id */
  60 #define FTDI_MTXORB_4_PID      0xFA04  /* Matrix Orbital Product Id */
  61 #define FTDI_MTXORB_5_PID      0xFA05  /* Matrix Orbital Product Id */
  62 #define FTDI_MTXORB_6_PID      0xFA06  /* Matrix Orbital Product Id */
  63
  64 /*
  65  * The following are the values for the Perle Systems
  66  * UltraPort USB serial converters
  67  */
  68 #define FTDI_PERLE_ULTRAPORT_PID 0xF0C0 /* Perle UltraPort Product Id */
  69
  70 /*
  71  * The following are the values for the Sealevel SeaLINK+ adapters.
  72  * (Original list sent by Tuan Hoang.  Ian Abbott renamed the macros and
  73  * removed some PIDs that don't seem to match any existing products.)
  74  */
  75 #define SEALEVEL_VID            0x0c52  /* Sealevel Vendor ID */
  76 #define SEALEVEL_2101_PID       0x2101  /* SeaLINK+232 (2101/2105) */
  77 #define SEALEVEL_2102_PID       0x2102  /* SeaLINK+485 (2102) */
  78 #define SEALEVEL_2103_PID       0x2103  /* SeaLINK+232I (2103) */
  79 #define SEALEVEL_2104_PID       0x2104  /* SeaLINK+485I (2104) */
  80 #define SEALEVEL_2201_1_PID     0x2211  /* SeaPORT+2/232 (2201) Port 1 */
  81 #define SEALEVEL_2201_2_PID     0x2221  /* SeaPORT+2/232 (2201) Port 2 */
  82 #define SEALEVEL_2202_1_PID     0x2212  /* SeaPORT+2/485 (2202) Port 1 */
  83 #define SEALEVEL_2202_2_PID     0x2222  /* SeaPORT+2/485 (2202) Port 2 */
  84 #define SEALEVEL_2203_1_PID     0x2213  /* SeaPORT+2 (2203) Port 1 */
  85 #define SEALEVEL_2203_2_PID     0x2223  /* SeaPORT+2 (2203) Port 2 */
  86 #define SEALEVEL_2401_1_PID     0x2411  /* SeaPORT+4/232 (2401) Port 1 */
  87 #define SEALEVEL_2401_2_PID     0x2421  /* SeaPORT+4/232 (2401) Port 2 */
  88 #define SEALEVEL_2401_3_PID     0x2431  /* SeaPORT+4/232 (2401) Port 3 */
  89 #define SEALEVEL_2401_4_PID     0x2441  /* SeaPORT+4/232 (2401) Port 4 */
  90 #define SEALEVEL_2402_1_PID     0x2412  /* SeaPORT+4/485 (2402) Port 1 */
  91 #define SEALEVEL_2402_2_PID     0x2422  /* SeaPORT+4/485 (2402) Port 2 */
  92 #define SEALEVEL_2402_3_PID     0x2432  /* SeaPORT+4/485 (2402) Port 3 */
  93 #define SEALEVEL_2402_4_PID     0x2442  /* SeaPORT+4/485 (2402) Port 4 */
  94 #define SEALEVEL_2403_1_PID     0x2413  /* SeaPORT+4 (2403) Port 1 */
  95 #define SEALEVEL_2403_2_PID     0x2423  /* SeaPORT+4 (2403) Port 2 */
  96 #define SEALEVEL_2403_3_PID     0x2433  /* SeaPORT+4 (2403) Port 3 */
  97 #define SEALEVEL_2403_4_PID     0x2443  /* SeaPORT+4 (2403) Port 4 */
  98 #define SEALEVEL_2801_1_PID     0X2811  /* SeaLINK+8/232 (2801) Port 1 */
  99 #define SEALEVEL_2801_2_PID     0X2821  /* SeaLINK+8/232 (2801) Port 2 */
 100 #define SEALEVEL_2801_3_PID     0X2831  /* SeaLINK+8/232 (2801) Port 3 */
 101 #define SEALEVEL_2801_4_PID     0X2841  /* SeaLINK+8/232 (2801) Port 4 */
 102 #define SEALEVEL_2801_5_PID     0X2851  /* SeaLINK+8/232 (2801) Port 5 */
 103 #define SEALEVEL_2801_6_PID     0X2861  /* SeaLINK+8/232 (2801) Port 6 */
 104 #define SEALEVEL_2801_7_PID     0X2871  /* SeaLINK+8/232 (2801) Port 7 */
 105 #define SEALEVEL_2801_8_PID     0X2881  /* SeaLINK+8/232 (2801) Port 8 */
 106 #define SEALEVEL_2802_1_PID     0X2812  /* SeaLINK+8/485 (2802) Port 1 */
 107 #define SEALEVEL_2802_2_PID     0X2822  /* SeaLINK+8/485 (2802) Port 2 */
 108 #define SEALEVEL_2802_3_PID     0X2832  /* SeaLINK+8/485 (2802) Port 3 */
 109 #define SEALEVEL_2802_4_PID     0X2842  /* SeaLINK+8/485 (2802) Port 4 */
 110 #define SEALEVEL_2802_5_PID     0X2852  /* SeaLINK+8/485 (2802) Port 5 */
 111 #define SEALEVEL_2802_6_PID     0X2862  /* SeaLINK+8/485 (2802) Port 6 */
 112 #define SEALEVEL_2802_7_PID     0X2872  /* SeaLINK+8/485 (2802) Port 7 */
 113 #define SEALEVEL_2802_8_PID     0X2882  /* SeaLINK+8/485 (2802) Port 8 */
 114 #define SEALEVEL_2803_1_PID     0X2813  /* SeaLINK+8 (2803) Port 1 */
 115 #define SEALEVEL_2803_2_PID     0X2823  /* SeaLINK+8 (2803) Port 2 */
 116 #define SEALEVEL_2803_3_PID     0X2833  /* SeaLINK+8 (2803) Port 3 */
 117 #define SEALEVEL_2803_4_PID     0X2843  /* SeaLINK+8 (2803) Port 4 */
 118 #define SEALEVEL_2803_5_PID     0X2853  /* SeaLINK+8 (2803) Port 5 */
 119 #define SEALEVEL_2803_6_PID     0X2863  /* SeaLINK+8 (2803) Port 6 */
 120 #define SEALEVEL_2803_7_PID     0X2873  /* SeaLINK+8 (2803) Port 7 */
 121 #define SEALEVEL_2803_8_PID     0X2883  /* SeaLINK+8 (2803) Port 8 */
 122
 123 /*
 124  * DSS-20 Sync Station for Sony Ericsson P800
 125  */
 126
 127 #define FTDI_DSS20_PID          0xFC82
 128
 129 /*
 130  * Home Electronics (www.home-electro.com) USB gadgets
 131  */
 132 #define FTDI_HE_TIRA1_PID       0xFA78  /* Tira-1 IR tranceiver */
 133
 134 /* USB-UIRT - An infrared receiver and transmitter using the 8U232AM chip */
 135 /* http://home.earthlink.net/~jrhees/USBUIRT/index.htm */
 136 #define FTDI_USB_UIRT_PID       0xF850  /* Product Id */
 137
 138 /* ELV USB Module UO100 (PID sent by Stefan Frings) */
 139 #define FTDI_ELV_UO100_PID      0xFB58  /* Product Id */
 140
 141 /*
 142  * Definitions for ID TECH (www.idt-net.com) devices
 143  */
 144 #define IDTECH_VID              0x0ACD  /* ID TECH Vendor ID */
 145 #define IDTECH_IDT1221U_PID     0x0300  /* IDT1221U USB to RS-232 adapter */
 146
 147 /*
 148  * Definitions for Omnidirectional Control Technology, Inc. devices
 149  */
 150 #define OCT_VID                 0x0B39  /* OCT vendor ID */
 151 /* Note: OCT US101 is also rebadged as Dick Smith Electronics (NZ) XH6381 */
 152 #define OCT_US101_PID           0x0421  /* OCT US101 USB to RS-232 */
 153
 154 /* an infrared receiver for user access control with IR tags */
 155 #define FTDI_PIEGROUP_PID       0xF208  /* Product Id */
 156
 157 /*
 158  * Protego product ids
 159  */
 160 #define PROTEGO_SPECIAL_1       0xFC70  /* special/unknown device */
 161 #define PROTEGO_R2X0            0xFC71  /* R200-USB TRNG unit (R210, R220, and R230) */
 162 #define PROTEGO_SPECIAL_3       0xFC72  /* special/unknown device */
 163 #define PROTEGO_SPECIAL_4       0xFC73  /* special/unknown device */
 164
 165 /*
 166  * Gude Analog- und Digitalsysteme GmbH
 167  */
 168 #define FTDI_GUDEADS_E808_PID    0xE808
 169 #define FTDI_GUDEADS_E809_PID    0xE809
 170 #define FTDI_GUDEADS_E80A_PID    0xE80A
 171 #define FTDI_GUDEADS_E80B_PID    0xE80B
 172 #define FTDI_GUDEADS_E80C_PID    0xE80C
 173 #define FTDI_GUDEADS_E80D_PID    0xE80D
 174 #define FTDI_GUDEADS_E80E_PID    0xE80E
 175 #define FTDI_GUDEADS_E80F_PID    0xE80F
 176 #define FTDI_GUDEADS_E888_PID    0xE888  /* Expert ISDN Control USB */
 177 #define FTDI_GUDEADS_E889_PID    0xE889  /* USB RS-232 OptoBridge */
 178 #define FTDI_GUDEADS_E88A_PID    0xE88A
 179 #define FTDI_GUDEADS_E88B_PID    0xE88B
 180 #define FTDI_GUDEADS_E88C_PID    0xE88C
 181 #define FTDI_GUDEADS_E88D_PID    0xE88D
 182 #define FTDI_GUDEADS_E88E_PID    0xE88E
 183 #define FTDI_GUDEADS_E88F_PID    0xE88F
 184
 185 /*
 186  * Linx Technologies product ids
 187  */
 188 #define LINX_SDMUSBQSS_PID      0xF448  /* Linx SDM-USB-QS-S */
 189 #define LINX_MASTERDEVEL2_PID   0xF449   /* Linx Master Development 2.0 */
 190 #define LINX_FUTURE_0_PID   0xF44A   /* Linx future device */
 191 #define LINX_FUTURE_1_PID   0xF44B   /* Linx future device */
 192 #define LINX_FUTURE_2_PID   0xF44C   /* Linx future device */
 193 #define FTDI_GUDEADS_889_PID    0xe889  /* USB RS323 OptoBridge */
 194 /* CCS Inc. ICDU/ICDU40 product ID - the FT232BM is used in an in-circuit-debugger */
 195 /* unit for PIC16's/PIC18's */
 196 #define FTDI_CCSICDU20_0_PID    0xF9D0
 197 #define FTDI_CCSICDU40_1_PID    0xF9D1
 198
 199 /* Inside Accesso contactless reader (http://www.insidefr.com) */
 200 #define INSIDE_ACCESSO          0xFAD0
 201
 202 /* Commands */
 203 #define FTDI_SIO_RESET          0 /* Reset the port */
 204 #define FTDI_SIO_MODEM_CTRL     1 /* Set the modem control register */
 205 #define FTDI_SIO_SET_FLOW_CTRL  2 /* Set flow control register */
 206 #define FTDI_SIO_SET_BAUD_RATE  3 /* Set baud rate */
 207 #define FTDI_SIO_SET_DATA       4 /* Set the data characteristics of the port */
 208 #define FTDI_SIO_GET_MODEM_STATUS       5 /* Retrieve current value of modern status register */
 209 #define FTDI_SIO_SET_EVENT_CHAR 6 /* Set the event character */
 210 #define FTDI_SIO_SET_ERROR_CHAR 7 /* Set the error character */
 211
 212 /* Port Identifier Table */
 213 #define PIT_DEFAULT             0 /* SIOA */
 214 #define PIT_SIOA                1 /* SIOA */
 215 /* The device this driver is tested with one has only one port */
 216 #define PIT_SIOB                2 /* SIOB */
 217 #define PIT_PARALLEL            3 /* Parallel */
 218
 219 /* FTDI_SIO_RESET */
 220 #define FTDI_SIO_RESET_REQUEST FTDI_SIO_RESET
 221 #define FTDI_SIO_RESET_REQUEST_TYPE 0x40
 222 #define FTDI_SIO_RESET_SIO 0
 223 #define FTDI_SIO_RESET_PURGE_RX 1
 224 #define FTDI_SIO_RESET_PURGE_TX 2
 225
 226 /*
 227  * BmRequestType:  0100 0000B
 228  * bRequest:       FTDI_SIO_RESET
 229  * wValue:         Control Value
 230  *                   0 = Reset SIO
 231  *                   1 = Purge RX buffer
 232  *                   2 = Purge TX buffer
 233  * wIndex:         Port
 234  * wLength:        0
 235  * Data:           None
 236  *
 237  * The Reset SIO command has this effect:
 238  *
 239  *    Sets flow control set to 'none'
 240  *    Event char = $0D
 241  *    Event trigger = disabled
 242  *    Purge RX buffer
 243  *    Purge TX buffer
 244  *    Clear DTR
 245  *    Clear RTS
 246  *    baud and data format not reset
 247  *
 248  * The Purge RX and TX buffer commands affect nothing except the buffers
 249  *
 250    */
 251
 252 /* FTDI_SIO_SET_BAUDRATE */
 253 #define FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE 0x40
 254 #define FTDI_SIO_SET_BAUDRATE_REQUEST 3
 255
 256 /*
 257  * BmRequestType:  0100 0000B
 258  * bRequest:       FTDI_SIO_SET_BAUDRATE
 259  * wValue:         BaudDivisor value - see below
 260  * wIndex:         Port
 261  * wLength:        0
 262  * Data:           None
 263  * The BaudDivisor values are calculated as follows:
 264  * - BaseClock is either 12000000 or 48000000 depending on the device. FIXME: I wish
 265  *   I knew how to detect old chips to select proper base clock!
 266  * - BaudDivisor is a fixed point number encoded in a funny way.
 267  *   (--WRONG WAY OF THINKING--)
 268  *   BaudDivisor is a fixed point number encoded with following bit weighs:
 269  *   (-2)(-1)(13..0). It is a radical with a denominator of 4, so values
 270  *   end with 0.0 (00...), 0.25 (10...), 0.5 (01...), and 0.75 (11...).
 271  *   (--THE REALITY--)
 272  *   The both-bits-set has quite different meaning from 0.75 - the chip designers
 273  *   have decided it to mean 0.125 instead of 0.75.
 274  *   This info looked up in FTDI application note "FT8U232 DEVICES \ Data Rates
 275  *   and Flow Control Consideration for USB to RS232".
 276  * - BaudDivisor = (BaseClock / 16) / BaudRate, where the (=) operation should
 277  *   automagically re-encode the resulting value to take fractions into consideration.
 278  * As all values are integers, some bit twiddling is in order:
 279  *   BaudDivisor = (BaseClock / 16 / BaudRate) |
 280  *   (((BaseClock / 2 / BaudRate) & 4) ? 0x4000    // 0.5
 281  *    : ((BaseClock / 2 / BaudRate) & 2) ? 0x8000  // 0.25
 282  *    : ((BaseClock / 2 / BaudRate) & 1) ? 0xc000  // 0.125
 283  *    : 0)
 284  *
 285  * For the FT232BM, a 17th divisor bit was introduced to encode the multiples
 286  * of 0.125 missing from the FT8U232AM.  Bits 16 to 14 are coded as follows
 287  * (the first four codes are the same as for the FT8U232AM, where bit 16 is
 288  * always 0):
 289  *   000 - add .000 to divisor
 290  *   001 - add .500 to divisor
 291  *   010 - add .250 to divisor
 292  *   011 - add .125 to divisor
 293  *   100 - add .375 to divisor
 294  *   101 - add .625 to divisor
 295  *   110 - add .750 to divisor
 296  *   111 - add .875 to divisor
 297  * Bits 15 to 0 of the 17-bit divisor are placed in the urb value.  Bit 16 is
 298  * placed in bit 0 of the urb index.
 299  *
 300  * Note that there are a couple of special cases to support the highest baud
 301  * rates.  If the calculated divisor value is 1, this needs to be replaced with
 302  * 0.  Additionally for the FT232BM, if the calculated divisor value is 0x4001
 303  * (1.5), this needs to be replaced with 0x0001 (1) (but this divisor value is
 304  * not supported by the FT8U232AM).
 305  */
 306
 307 typedef enum {
 308         SIO = 1,
 309         FT8U232AM = 2,
 310         FT232BM = 3,
 311 } ftdi_chip_type_t;
 312
 313 typedef enum {
 314  ftdi_sio_b300 = 0,
 315  ftdi_sio_b600 = 1,
 316  ftdi_sio_b1200 = 2,
 317  ftdi_sio_b2400 = 3,
 318  ftdi_sio_b4800 = 4,
 319  ftdi_sio_b9600 = 5,
 320  ftdi_sio_b19200 = 6,
 321  ftdi_sio_b38400 = 7,
 322  ftdi_sio_b57600 = 8,
 323  ftdi_sio_b115200 = 9
 324 } FTDI_SIO_baudrate_t ;
 325
 326 /*
 327  * The ftdi_8U232AM_xxMHz_byyy constants have been removed. The encoded divisor values
 328  * are calculated internally.
 329  */
 330
 331 #define FTDI_SIO_SET_DATA_REQUEST FTDI_SIO_SET_DATA
 332 #define FTDI_SIO_SET_DATA_REQUEST_TYPE 0x40
 333 #define FTDI_SIO_SET_DATA_PARITY_NONE (0x0 << 8 )
 334 #define FTDI_SIO_SET_DATA_PARITY_ODD (0x1 << 8 )
 335 #define FTDI_SIO_SET_DATA_PARITY_EVEN (0x2 << 8 )
 336 #define FTDI_SIO_SET_DATA_PARITY_MARK (0x3 << 8 )
 337 #define FTDI_SIO_SET_DATA_PARITY_SPACE (0x4 << 8 )
 338 #define FTDI_SIO_SET_DATA_STOP_BITS_1 (0x0 << 11 )
 339 #define FTDI_SIO_SET_DATA_STOP_BITS_15 (0x1 << 11 )
 340 #define FTDI_SIO_SET_DATA_STOP_BITS_2 (0x2 << 11 )
 341 #define FTDI_SIO_SET_BREAK (0x1 << 14)
 342 /* FTDI_SIO_SET_DATA */
 343
 344 /*
 345  * BmRequestType:  0100 0000B
 346  * bRequest:       FTDI_SIO_SET_DATA
 347  * wValue:         Data characteristics (see below)
 348  * wIndex:         Port
 349  * wLength:        0
 350  * Data:           No
 351  *
 352  * Data characteristics
 353  *
 354  *   B0..7   Number of data bits
 355  *   B8..10  Parity
 356  *           0 = None
 357  *           1 = Odd
 358  *           2 = Even
 359  *           3 = Mark
 360  *           4 = Space
 361  *   B11..13 Stop Bits
 362  *           0 = 1
 363  *           1 = 1.5
 364  *           2 = 2
 365  *   B14
 366  *           1 = TX ON (break)
 367  *           0 = TX OFF (normal state)
 368  *   B15 Reserved
 369  *
 370  */
 371
 372
 373
 374 /* FTDI_SIO_MODEM_CTRL */
 375 #define FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE 0x40
 376 #define FTDI_SIO_SET_MODEM_CTRL_REQUEST FTDI_SIO_MODEM_CTRL
 377
 378 /*
 379  * BmRequestType:   0100 0000B
 380  * bRequest:        FTDI_SIO_MODEM_CTRL
 381  * wValue:          ControlValue (see below)
 382  * wIndex:          Port
 383  * wLength:         0
 384  * Data:            None
 385  *
 386  * NOTE: If the device is in RTS/CTS flow control, the RTS set by this
 387  * command will be IGNORED without an error being returned
 388  * Also - you can not set DTR and RTS with one control message
 389  */
 390
 391 #define FTDI_SIO_SET_DTR_MASK 0x1
 392 #define FTDI_SIO_SET_DTR_HIGH ( 1 | ( FTDI_SIO_SET_DTR_MASK  << 8))
 393 #define FTDI_SIO_SET_DTR_LOW  ( 0 | ( FTDI_SIO_SET_DTR_MASK  << 8))
 394 #define FTDI_SIO_SET_RTS_MASK 0x2
 395 #define FTDI_SIO_SET_RTS_HIGH ( 2 | ( FTDI_SIO_SET_RTS_MASK << 8 ))
 396 #define FTDI_SIO_SET_RTS_LOW ( 0 | ( FTDI_SIO_SET_RTS_MASK << 8 ))
 397
 398 /*
 399  * ControlValue
 400  * B0    DTR state
 401  *          0 = reset
 402  *          1 = set
 403  * B1    RTS state
 404  *          0 = reset
 405  *          1 = set
 406  * B2..7 Reserved
 407  * B8    DTR state enable
 408  *          0 = ignore
 409  *          1 = use DTR state
 410  * B9    RTS state enable
 411  *          0 = ignore
 412  *          1 = use RTS state
 413  * B10..15 Reserved
 414  */
 415
 416 /* FTDI_SIO_SET_FLOW_CTRL */
 417 #define FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE 0x40
 418 #define FTDI_SIO_SET_FLOW_CTRL_REQUEST FTDI_SIO_SET_FLOW_CTRL
 419 #define FTDI_SIO_DISABLE_FLOW_CTRL 0x0
 420 #define FTDI_SIO_RTS_CTS_HS (0x1 << 8)
 421 #define FTDI_SIO_DTR_DSR_HS (0x2 << 8)
 422 #define FTDI_SIO_XON_XOFF_HS (0x4 << 8)
 423 /*
 424  *   BmRequestType:  0100 0000b
 425  *   bRequest:       FTDI_SIO_SET_FLOW_CTRL
 426  *   wValue:         Xoff/Xon
 427  *   wIndex:         Protocol/Port - hIndex is protocl / lIndex is port
 428  *   wLength:        0
 429  *   Data:           None
 430  *
 431  * hIndex protocol is:
 432  *   B0 Output handshaking using RTS/CTS
 433  *       0 = disabled
 434  *       1 = enabled
 435  *   B1 Output handshaking using DTR/DSR
 436  *       0 = disabled
 437  *       1 = enabled
 438  *   B2 Xon/Xoff handshaking
 439  *       0 = disabled
 440  *       1 = enabled
 441  *
 442  * A value of zero in the hIndex field disables handshaking
 443  *
 444  * If Xon/Xoff handshaking is specified, the hValue field should contain the XOFF character
 445  * and the lValue field contains the XON character.
 446  */
 447
 448 /*
 449  * FTDI_SIO_SET_EVENT_CHAR
 450  *
 451  * Set the special event character for the specified communications port.
 452  * If the device sees this character it will immediately return the
 453  * data read so far - rather than wait 40ms or until 62 bytes are read
 454  * which is what normally happens.
 455  */
 456
 457
 458 #define  FTDI_SIO_SET_EVENT_CHAR_REQUEST FTDI_SIO_SET_EVENT_CHAR
 459 #define  FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE 0x40
 460
 461
 462 /*
 463  *  BmRequestType:   0100 0000b
 464  *  bRequest:        FTDI_SIO_SET_EVENT_CHAR
 465  *  wValue:          EventChar
 466  *  wIndex:          Port
 467  *  wLength:         0
 468  *  Data:            None
 469  *
 470  * wValue:
 471  *   B0..7   Event Character
 472  *   B8      Event Character Processing
 473  *             0 = disabled
 474  *             1 = enabled
 475  *   B9..15  Reserved
 476  *
 477  */
 478
 479 /* FTDI_SIO_SET_ERROR_CHAR */
 480
 481 /* Set the parity error replacement character for the specified communications port */
 482
 483 /*
 484  *  BmRequestType:  0100 0000b
 485  *  bRequest:       FTDI_SIO_SET_EVENT_CHAR
 486  *  wValue:         Error Char
 487  *  wIndex:         Port
 488  *  wLength:        0
 489  *  Data:           None
 490  *
 491  *Error Char
 492  *  B0..7  Error Character
 493  *  B8     Error Character Processing
 494  *           0 = disabled
 495  *           1 = enabled
 496  *  B9..15 Reserved
 497  *
 498  */
 499
 500 /* FTDI_SIO_GET_MODEM_STATUS */
 501 /* Retreive the current value of the modem status register */
 502
 503 #define FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE 0xc0
 504 #define FTDI_SIO_GET_MODEM_STATUS_REQUEST FTDI_SIO_GET_MODEM_STATUS
 505 #define FTDI_SIO_CTS_MASK 0x10
 506 #define FTDI_SIO_DSR_MASK 0x20
 507 #define FTDI_SIO_RI_MASK  0x40
 508 #define FTDI_SIO_RLSD_MASK 0x80
 509 /*
 510  *   BmRequestType:   1100 0000b
 511  *   bRequest:        FTDI_SIO_GET_MODEM_STATUS
 512  *   wValue:          zero
 513  *   wIndex:          Port
 514  *   wLength:         1
 515  *   Data:            Status
 516  *
 517  * One byte of data is returned
 518  * B0..3 0
 519  * B4    CTS
 520  *         0 = inactive
 521  *         1 = active
 522  * B5    DSR
 523  *         0 = inactive
 524  *         1 = active
 525  * B6    Ring Indicator (RI)
 526  *         0 = inactive
 527  *         1 = active
 528  * B7    Receive Line Signal Detect (RLSD)
 529  *         0 = inactive
 530  *         1 = active
 531  */
 532
 533
 534
 535 /* Descriptors returned by the device
 536  *
 537  *  Device Descriptor
 538  *
 539  * Offset       Field           Size    Value   Description
 540  * 0    bLength         1       0x12    Size of descriptor in bytes
 541  * 1    bDescriptorType 1       0x01    DEVICE Descriptor Type
 542  * 2    bcdUSB          2       0x0110  USB Spec Release Number
 543  * 4    bDeviceClass    1       0x00    Class Code
 544  * 5    bDeviceSubClass 1       0x00    SubClass Code
 545  * 6    bDeviceProtocol 1       0x00    Protocol Code
 546  * 7    bMaxPacketSize0 1       0x08    Maximum packet size for endpoint 0
 547  * 8    idVendor        2       0x0403  Vendor ID
 548  * 10   idProduct       2       0x8372  Product ID (FTDI_SIO_PID)
 549  * 12   bcdDevice       2       0x0001  Device release number
 550  * 14   iManufacturer   1       0x01    Index of man. string desc
 551  * 15   iProduct        1       0x02    Index of prod string desc
 552  * 16   iSerialNumber   1       0x02    Index of serial nmr string desc
 553  * 17   bNumConfigurations 1    0x01    Number of possible configurations
 554  *
 555  * Configuration Descriptor
 556  *
 557  * Offset       Field                   Size    Value
 558  * 0    bLength                 1       0x09    Size of descriptor in bytes
 559  * 1    bDescriptorType         1       0x02    CONFIGURATION Descriptor Type
 560  * 2    wTotalLength            2       0x0020  Total length of data
 561  * 4    bNumInterfaces          1       0x01    Number of interfaces supported
 562  * 5    bConfigurationValue     1       0x01    Argument for SetCOnfiguration() req
 563  * 6    iConfiguration          1       0x02    Index of config string descriptor
 564  * 7    bmAttributes            1       0x20    Config characteristics Remote Wakeup
 565  * 8    MaxPower                1       0x1E    Max power consumption
 566  *
 567  * Interface Descriptor
 568  *
 569  * Offset       Field                   Size    Value
 570  * 0    bLength                 1       0x09    Size of descriptor in bytes
 571  * 1    bDescriptorType         1       0x04    INTERFACE Descriptor Type
 572  * 2    bInterfaceNumber        1       0x00    Number of interface
 573  * 3    bAlternateSetting       1       0x00    Value used to select alternate
 574  * 4    bNumEndpoints           1       0x02    Number of endpoints
 575  * 5    bInterfaceClass         1       0xFF    Class Code
 576  * 6    bInterfaceSubClass      1       0xFF    Subclass Code
 577  * 7    bInterfaceProtocol      1       0xFF    Protocol Code
 578  * 8    iInterface              1       0x02    Index of interface string description
 579  *
 580  * IN Endpoint Descriptor
 581  *
 582  * Offset       Field                   Size    Value
 583  * 0    bLength                 1       0x07    Size of descriptor in bytes
 584  * 1    bDescriptorType         1       0x05    ENDPOINT descriptor type
 585  * 2    bEndpointAddress        1       0x82    Address of endpoint
 586  * 3    bmAttributes            1       0x02    Endpoint attributes - Bulk
 587  * 4    bNumEndpoints           2       0x0040  maximum packet size
 588  * 5    bInterval               1       0x00    Interval for polling endpoint
 589  *
 590  * OUT Endpoint Descriptor
 591  *
 592  * Offset       Field                   Size    Value
 593  * 0    bLength                 1       0x07    Size of descriptor in bytes
 594  * 1    bDescriptorType         1       0x05    ENDPOINT descriptor type
 595  * 2    bEndpointAddress        1       0x02    Address of endpoint
 596  * 3    bmAttributes            1       0x02    Endpoint attributes - Bulk
 597  * 4    bNumEndpoints           2       0x0040  maximum packet size
 598  * 5    bInterval               1       0x00    Interval for polling endpoint
 599  *
 600  * DATA FORMAT
 601  *
 602  * IN Endpoint
 603  *
 604  * The device reserves the first two bytes of data on this endpoint to contain the current
 605  * values of the modem and line status registers. In the absence of data, the device
 606  * generates a message consisting of these two status bytes every 40 ms
 607  *
 608  * Byte 0: Modem Status
 609  *
 610  * Offset       Description
 611  * B0   Reserved - must be 1
 612  * B1   Reserved - must be 0
 613  * B2   Reserved - must be 0
 614  * B3   Reserved - must be 0
 615  * B4   Clear to Send (CTS)
 616  * B5   Data Set Ready (DSR)
 617  * B6   Ring Indicator (RI)
 618  * B7   Receive Line Signal Detect (RLSD)
 619  *
 620  * Byte 1: Line Status
 621  *
 622  * Offset       Description
 623  * B0   Data Ready (DR)
 624  * B1   Overrun Error (OE)
 625  * B2   Parity Error (PE)
 626  * B3   Framing Error (FE)
 627  * B4   Break Interrupt (BI)
 628  * B5   Transmitter Holding Register (THRE)
 629  * B6   Transmitter Empty (TEMT)
 630  * B7   Error in RCVR FIFO
 631  *
 632  */
 633 #define FTDI_RS0_CTS    (1 << 4)
 634 #define FTDI_RS0_DSR    (1 << 5)
 635 #define FTDI_RS0_RI     (1 << 6)
 636 #define FTDI_RS0_RLSD   (1 << 7)
 637
 638 #define FTDI_RS_DR  1
 639 #define FTDI_RS_OE (1<<1)
 640 #define FTDI_RS_PE (1<<2)
 641 #define FTDI_RS_FE (1<<3)
 642 #define FTDI_RS_BI (1<<4)
 643 #define FTDI_RS_THRE (1<<5)
 644 #define FTDI_RS_TEMT (1<<6)
 645 #define FTDI_RS_FIFO  (1<<7)
 646
 647 /*
 648  * OUT Endpoint
 649  *
 650  * This device reserves the first bytes of data on this endpoint contain the length
 651  * and port identifier of the message. For the FTDI USB Serial converter the port
 652  * identifier is always 1.
 653  *
 654  * Byte 0: Line Status
 655  *
 656  * Offset       Description
 657  * B0   Reserved - must be 1
 658  * B1   Reserved - must be 0
 659  * B2..7        Length of message - (not including Byte 0)
 660  *
 661  */
 662