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