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