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