11da177e4SLinus Torvalds /* 21da177e4SLinus Torvalds * Definitions for the FTDI USB Single Port Serial Converter - 31da177e4SLinus Torvalds * known as FTDI_SIO (Serial Input/Output application of the chipset) 41da177e4SLinus Torvalds * 51da177e4SLinus Torvalds * The example I have is known as the USC-1000 which is available from 61da177e4SLinus Torvalds * http://www.dse.co.nz - cat no XH4214 It looks similar to this: 71da177e4SLinus Torvalds * http://www.dansdata.com/usbser.htm but I can't be sure There are other 81da177e4SLinus Torvalds * USC-1000s which don't look like my device though so beware! 91da177e4SLinus Torvalds * 101da177e4SLinus Torvalds * The device is based on the FTDI FT8U100AX chip. It has a DB25 on one side, 111da177e4SLinus Torvalds * USB on the other. 121da177e4SLinus Torvalds * 131da177e4SLinus Torvalds * Thanx to FTDI (http://www.ftdi.co.uk) for so kindly providing details 141da177e4SLinus Torvalds * of the protocol required to talk to the device and ongoing assistence 151da177e4SLinus Torvalds * during development. 161da177e4SLinus Torvalds * 171da177e4SLinus Torvalds * Bill Ryder - bryder@sgi.com formerly of Silicon Graphics, Inc.- wrote the 181da177e4SLinus Torvalds * FTDI_SIO implementation. 191da177e4SLinus Torvalds * 201da177e4SLinus Torvalds * Philipp G�hring - pg@futureware.at - added the Device ID of the USB relais 211da177e4SLinus Torvalds * from Rudolf Gugler 221da177e4SLinus Torvalds * 231da177e4SLinus Torvalds */ 241da177e4SLinus Torvalds 251da177e4SLinus Torvalds #define FTDI_VID 0x0403 /* Vendor Id */ 261da177e4SLinus Torvalds #define FTDI_SIO_PID 0x8372 /* Product Id SIO application of 8U100AX */ 271da177e4SLinus Torvalds #define FTDI_8U232AM_PID 0x6001 /* Similar device to SIO above */ 281da177e4SLinus Torvalds #define FTDI_8U232AM_ALT_PID 0x6006 /* FTDI's alternate PID for above */ 291da177e4SLinus Torvalds #define FTDI_8U232AM_ALT_ALT_PID 0xf3c0 /* FTDI's second alternate PID for above */ 301da177e4SLinus Torvalds #define FTDI_8U2232C_PID 0x6010 /* Dual channel device */ 311da177e4SLinus Torvalds #define FTDI_RELAIS_PID 0xFA10 /* Relais device from Rudolf Gugler */ 321da177e4SLinus Torvalds #define FTDI_NF_RIC_VID 0x0DCD /* Vendor Id */ 331da177e4SLinus Torvalds #define FTDI_NF_RIC_PID 0x0001 /* Product Id */ 341da177e4SLinus Torvalds 351da177e4SLinus Torvalds /* www.irtrans.de device */ 361da177e4SLinus Torvalds #define FTDI_IRTRANS_PID 0xFC60 /* Product Id */ 371da177e4SLinus Torvalds 381da177e4SLinus Torvalds /* www.crystalfontz.com devices - thanx for providing free devices for evaluation ! */ 391da177e4SLinus Torvalds /* they use the ftdi chipset for the USB interface and the vendor id is the same */ 401da177e4SLinus Torvalds #define FTDI_XF_632_PID 0xFC08 /* 632: 16x2 Character Display */ 411da177e4SLinus Torvalds #define FTDI_XF_634_PID 0xFC09 /* 634: 20x4 Character Display */ 421da177e4SLinus Torvalds #define FTDI_XF_547_PID 0xFC0A /* 547: Two line Display */ 431da177e4SLinus Torvalds #define FTDI_XF_633_PID 0xFC0B /* 633: 16x2 Character Display with Keys */ 441da177e4SLinus Torvalds #define FTDI_XF_631_PID 0xFC0C /* 631: 20x2 Character Display */ 451da177e4SLinus Torvalds #define FTDI_XF_635_PID 0xFC0D /* 635: 20x4 Character Display */ 461da177e4SLinus Torvalds #define FTDI_XF_640_PID 0xFC0E /* 640: Two line Display */ 471da177e4SLinus Torvalds #define FTDI_XF_642_PID 0xFC0F /* 642: Two line Display */ 481da177e4SLinus Torvalds 491da177e4SLinus Torvalds /* Video Networks Limited / Homechoice in the UK use an ftdi-based device for their 1Mb */ 501da177e4SLinus Torvalds /* broadband internet service. The following PID is exhibited by the usb device supplied */ 511da177e4SLinus Torvalds /* (the VID is the standard ftdi vid (FTDI_VID) */ 521da177e4SLinus Torvalds #define FTDI_VNHCPCUSB_D_PID 0xfe38 /* Product Id */ 531da177e4SLinus Torvalds 541da177e4SLinus Torvalds /* 551da177e4SLinus Torvalds * The following are the values for the Matrix Orbital LCD displays, 561da177e4SLinus Torvalds * which are the FT232BM ( similar to the 8U232AM ) 571da177e4SLinus Torvalds */ 581da177e4SLinus Torvalds #define FTDI_MTXORB_0_PID 0xFA00 /* Matrix Orbital Product Id */ 591da177e4SLinus Torvalds #define FTDI_MTXORB_1_PID 0xFA01 /* Matrix Orbital Product Id */ 601da177e4SLinus Torvalds #define FTDI_MTXORB_2_PID 0xFA02 /* Matrix Orbital Product Id */ 611da177e4SLinus Torvalds #define FTDI_MTXORB_3_PID 0xFA03 /* Matrix Orbital Product Id */ 621da177e4SLinus Torvalds #define FTDI_MTXORB_4_PID 0xFA04 /* Matrix Orbital Product Id */ 631da177e4SLinus Torvalds #define FTDI_MTXORB_5_PID 0xFA05 /* Matrix Orbital Product Id */ 641da177e4SLinus Torvalds #define FTDI_MTXORB_6_PID 0xFA06 /* Matrix Orbital Product Id */ 651da177e4SLinus Torvalds 661da177e4SLinus Torvalds /* Interbiometrics USB I/O Board */ 671da177e4SLinus Torvalds /* Developed for Interbiometrics by Rudolf Gugler */ 681da177e4SLinus Torvalds #define INTERBIOMETRICS_VID 0x1209 691da177e4SLinus Torvalds #define INTERBIOMETRICS_IOBOARD_PID 0x1002 701da177e4SLinus Torvalds #define INTERBIOMETRICS_MINI_IOBOARD_PID 0x1006 711da177e4SLinus Torvalds 721da177e4SLinus Torvalds /* 731da177e4SLinus Torvalds * The following are the values for the Perle Systems 741da177e4SLinus Torvalds * UltraPort USB serial converters 751da177e4SLinus Torvalds */ 761da177e4SLinus Torvalds #define FTDI_PERLE_ULTRAPORT_PID 0xF0C0 /* Perle UltraPort Product Id */ 771da177e4SLinus Torvalds 781da177e4SLinus Torvalds /* 791da177e4SLinus Torvalds * The following are the values for the Sealevel SeaLINK+ adapters. 801da177e4SLinus Torvalds * (Original list sent by Tuan Hoang. Ian Abbott renamed the macros and 811da177e4SLinus Torvalds * removed some PIDs that don't seem to match any existing products.) 821da177e4SLinus Torvalds */ 831da177e4SLinus Torvalds #define SEALEVEL_VID 0x0c52 /* Sealevel Vendor ID */ 841da177e4SLinus Torvalds #define SEALEVEL_2101_PID 0x2101 /* SeaLINK+232 (2101/2105) */ 851da177e4SLinus Torvalds #define SEALEVEL_2102_PID 0x2102 /* SeaLINK+485 (2102) */ 861da177e4SLinus Torvalds #define SEALEVEL_2103_PID 0x2103 /* SeaLINK+232I (2103) */ 871da177e4SLinus Torvalds #define SEALEVEL_2104_PID 0x2104 /* SeaLINK+485I (2104) */ 881da177e4SLinus Torvalds #define SEALEVEL_2201_1_PID 0x2211 /* SeaPORT+2/232 (2201) Port 1 */ 891da177e4SLinus Torvalds #define SEALEVEL_2201_2_PID 0x2221 /* SeaPORT+2/232 (2201) Port 2 */ 901da177e4SLinus Torvalds #define SEALEVEL_2202_1_PID 0x2212 /* SeaPORT+2/485 (2202) Port 1 */ 911da177e4SLinus Torvalds #define SEALEVEL_2202_2_PID 0x2222 /* SeaPORT+2/485 (2202) Port 2 */ 921da177e4SLinus Torvalds #define SEALEVEL_2203_1_PID 0x2213 /* SeaPORT+2 (2203) Port 1 */ 931da177e4SLinus Torvalds #define SEALEVEL_2203_2_PID 0x2223 /* SeaPORT+2 (2203) Port 2 */ 941da177e4SLinus Torvalds #define SEALEVEL_2401_1_PID 0x2411 /* SeaPORT+4/232 (2401) Port 1 */ 951da177e4SLinus Torvalds #define SEALEVEL_2401_2_PID 0x2421 /* SeaPORT+4/232 (2401) Port 2 */ 961da177e4SLinus Torvalds #define SEALEVEL_2401_3_PID 0x2431 /* SeaPORT+4/232 (2401) Port 3 */ 971da177e4SLinus Torvalds #define SEALEVEL_2401_4_PID 0x2441 /* SeaPORT+4/232 (2401) Port 4 */ 981da177e4SLinus Torvalds #define SEALEVEL_2402_1_PID 0x2412 /* SeaPORT+4/485 (2402) Port 1 */ 991da177e4SLinus Torvalds #define SEALEVEL_2402_2_PID 0x2422 /* SeaPORT+4/485 (2402) Port 2 */ 1001da177e4SLinus Torvalds #define SEALEVEL_2402_3_PID 0x2432 /* SeaPORT+4/485 (2402) Port 3 */ 1011da177e4SLinus Torvalds #define SEALEVEL_2402_4_PID 0x2442 /* SeaPORT+4/485 (2402) Port 4 */ 1021da177e4SLinus Torvalds #define SEALEVEL_2403_1_PID 0x2413 /* SeaPORT+4 (2403) Port 1 */ 1031da177e4SLinus Torvalds #define SEALEVEL_2403_2_PID 0x2423 /* SeaPORT+4 (2403) Port 2 */ 1041da177e4SLinus Torvalds #define SEALEVEL_2403_3_PID 0x2433 /* SeaPORT+4 (2403) Port 3 */ 1051da177e4SLinus Torvalds #define SEALEVEL_2403_4_PID 0x2443 /* SeaPORT+4 (2403) Port 4 */ 1061da177e4SLinus Torvalds #define SEALEVEL_2801_1_PID 0X2811 /* SeaLINK+8/232 (2801) Port 1 */ 1071da177e4SLinus Torvalds #define SEALEVEL_2801_2_PID 0X2821 /* SeaLINK+8/232 (2801) Port 2 */ 1081da177e4SLinus Torvalds #define SEALEVEL_2801_3_PID 0X2831 /* SeaLINK+8/232 (2801) Port 3 */ 1091da177e4SLinus Torvalds #define SEALEVEL_2801_4_PID 0X2841 /* SeaLINK+8/232 (2801) Port 4 */ 1101da177e4SLinus Torvalds #define SEALEVEL_2801_5_PID 0X2851 /* SeaLINK+8/232 (2801) Port 5 */ 1111da177e4SLinus Torvalds #define SEALEVEL_2801_6_PID 0X2861 /* SeaLINK+8/232 (2801) Port 6 */ 1121da177e4SLinus Torvalds #define SEALEVEL_2801_7_PID 0X2871 /* SeaLINK+8/232 (2801) Port 7 */ 1131da177e4SLinus Torvalds #define SEALEVEL_2801_8_PID 0X2881 /* SeaLINK+8/232 (2801) Port 8 */ 1141da177e4SLinus Torvalds #define SEALEVEL_2802_1_PID 0X2812 /* SeaLINK+8/485 (2802) Port 1 */ 1151da177e4SLinus Torvalds #define SEALEVEL_2802_2_PID 0X2822 /* SeaLINK+8/485 (2802) Port 2 */ 1161da177e4SLinus Torvalds #define SEALEVEL_2802_3_PID 0X2832 /* SeaLINK+8/485 (2802) Port 3 */ 1171da177e4SLinus Torvalds #define SEALEVEL_2802_4_PID 0X2842 /* SeaLINK+8/485 (2802) Port 4 */ 1181da177e4SLinus Torvalds #define SEALEVEL_2802_5_PID 0X2852 /* SeaLINK+8/485 (2802) Port 5 */ 1191da177e4SLinus Torvalds #define SEALEVEL_2802_6_PID 0X2862 /* SeaLINK+8/485 (2802) Port 6 */ 1201da177e4SLinus Torvalds #define SEALEVEL_2802_7_PID 0X2872 /* SeaLINK+8/485 (2802) Port 7 */ 1211da177e4SLinus Torvalds #define SEALEVEL_2802_8_PID 0X2882 /* SeaLINK+8/485 (2802) Port 8 */ 1221da177e4SLinus Torvalds #define SEALEVEL_2803_1_PID 0X2813 /* SeaLINK+8 (2803) Port 1 */ 1231da177e4SLinus Torvalds #define SEALEVEL_2803_2_PID 0X2823 /* SeaLINK+8 (2803) Port 2 */ 1241da177e4SLinus Torvalds #define SEALEVEL_2803_3_PID 0X2833 /* SeaLINK+8 (2803) Port 3 */ 1251da177e4SLinus Torvalds #define SEALEVEL_2803_4_PID 0X2843 /* SeaLINK+8 (2803) Port 4 */ 1261da177e4SLinus Torvalds #define SEALEVEL_2803_5_PID 0X2853 /* SeaLINK+8 (2803) Port 5 */ 1271da177e4SLinus Torvalds #define SEALEVEL_2803_6_PID 0X2863 /* SeaLINK+8 (2803) Port 6 */ 1281da177e4SLinus Torvalds #define SEALEVEL_2803_7_PID 0X2873 /* SeaLINK+8 (2803) Port 7 */ 1291da177e4SLinus Torvalds #define SEALEVEL_2803_8_PID 0X2883 /* SeaLINK+8 (2803) Port 8 */ 1301da177e4SLinus Torvalds 1311da177e4SLinus Torvalds /* 1321da177e4SLinus Torvalds * DSS-20 Sync Station for Sony Ericsson P800 1331da177e4SLinus Torvalds */ 1341da177e4SLinus Torvalds 1351da177e4SLinus Torvalds #define FTDI_DSS20_PID 0xFC82 1361da177e4SLinus Torvalds 1371da177e4SLinus Torvalds /* 1381da177e4SLinus Torvalds * Home Electronics (www.home-electro.com) USB gadgets 1391da177e4SLinus Torvalds */ 1401da177e4SLinus Torvalds #define FTDI_HE_TIRA1_PID 0xFA78 /* Tira-1 IR tranceiver */ 1411da177e4SLinus Torvalds 1421da177e4SLinus Torvalds /* USB-UIRT - An infrared receiver and transmitter using the 8U232AM chip */ 1431da177e4SLinus Torvalds /* http://home.earthlink.net/~jrhees/USBUIRT/index.htm */ 1441da177e4SLinus Torvalds #define FTDI_USB_UIRT_PID 0xF850 /* Product Id */ 1451da177e4SLinus Torvalds 1461da177e4SLinus Torvalds /* ELV USB Module UO100 (PID sent by Stefan Frings) */ 1471da177e4SLinus Torvalds #define FTDI_ELV_UO100_PID 0xFB58 /* Product Id */ 1481da177e4SLinus Torvalds 1491da177e4SLinus Torvalds /* 1501da177e4SLinus Torvalds * Definitions for ID TECH (www.idt-net.com) devices 1511da177e4SLinus Torvalds */ 1521da177e4SLinus Torvalds #define IDTECH_VID 0x0ACD /* ID TECH Vendor ID */ 1531da177e4SLinus Torvalds #define IDTECH_IDT1221U_PID 0x0300 /* IDT1221U USB to RS-232 adapter */ 1541da177e4SLinus Torvalds 1551da177e4SLinus Torvalds /* 1561da177e4SLinus Torvalds * Definitions for Omnidirectional Control Technology, Inc. devices 1571da177e4SLinus Torvalds */ 1581da177e4SLinus Torvalds #define OCT_VID 0x0B39 /* OCT vendor ID */ 1591da177e4SLinus Torvalds /* Note: OCT US101 is also rebadged as Dick Smith Electronics (NZ) XH6381 */ 1601da177e4SLinus Torvalds /* Also rebadged as SIIG Inc. model US2308 */ 1611da177e4SLinus Torvalds #define OCT_US101_PID 0x0421 /* OCT US101 USB to RS-232 */ 1621da177e4SLinus Torvalds 1631da177e4SLinus Torvalds /* an infrared receiver for user access control with IR tags */ 1641da177e4SLinus Torvalds #define FTDI_PIEGROUP_PID 0xF208 /* Product Id */ 1651da177e4SLinus Torvalds 1661da177e4SLinus Torvalds /* 1671da177e4SLinus Torvalds * Protego product ids 1681da177e4SLinus Torvalds */ 1691da177e4SLinus Torvalds #define PROTEGO_SPECIAL_1 0xFC70 /* special/unknown device */ 1701da177e4SLinus Torvalds #define PROTEGO_R2X0 0xFC71 /* R200-USB TRNG unit (R210, R220, and R230) */ 1711da177e4SLinus Torvalds #define PROTEGO_SPECIAL_3 0xFC72 /* special/unknown device */ 1721da177e4SLinus Torvalds #define PROTEGO_SPECIAL_4 0xFC73 /* special/unknown device */ 1731da177e4SLinus Torvalds 1741da177e4SLinus Torvalds /* 1751da177e4SLinus Torvalds * Gude Analog- und Digitalsysteme GmbH 1761da177e4SLinus Torvalds */ 1771da177e4SLinus Torvalds #define FTDI_GUDEADS_E808_PID 0xE808 1781da177e4SLinus Torvalds #define FTDI_GUDEADS_E809_PID 0xE809 1791da177e4SLinus Torvalds #define FTDI_GUDEADS_E80A_PID 0xE80A 1801da177e4SLinus Torvalds #define FTDI_GUDEADS_E80B_PID 0xE80B 1811da177e4SLinus Torvalds #define FTDI_GUDEADS_E80C_PID 0xE80C 1821da177e4SLinus Torvalds #define FTDI_GUDEADS_E80D_PID 0xE80D 1831da177e4SLinus Torvalds #define FTDI_GUDEADS_E80E_PID 0xE80E 1841da177e4SLinus Torvalds #define FTDI_GUDEADS_E80F_PID 0xE80F 1851da177e4SLinus Torvalds #define FTDI_GUDEADS_E888_PID 0xE888 /* Expert ISDN Control USB */ 1861da177e4SLinus Torvalds #define FTDI_GUDEADS_E889_PID 0xE889 /* USB RS-232 OptoBridge */ 1871da177e4SLinus Torvalds #define FTDI_GUDEADS_E88A_PID 0xE88A 1881da177e4SLinus Torvalds #define FTDI_GUDEADS_E88B_PID 0xE88B 1891da177e4SLinus Torvalds #define FTDI_GUDEADS_E88C_PID 0xE88C 1901da177e4SLinus Torvalds #define FTDI_GUDEADS_E88D_PID 0xE88D 1911da177e4SLinus Torvalds #define FTDI_GUDEADS_E88E_PID 0xE88E 1921da177e4SLinus Torvalds #define FTDI_GUDEADS_E88F_PID 0xE88F 1931da177e4SLinus Torvalds 1941da177e4SLinus Torvalds /* 1951da177e4SLinus Torvalds * Linx Technologies product ids 1961da177e4SLinus Torvalds */ 1971da177e4SLinus Torvalds #define LINX_SDMUSBQSS_PID 0xF448 /* Linx SDM-USB-QS-S */ 1981da177e4SLinus Torvalds #define LINX_MASTERDEVEL2_PID 0xF449 /* Linx Master Development 2.0 */ 1991da177e4SLinus Torvalds #define LINX_FUTURE_0_PID 0xF44A /* Linx future device */ 2001da177e4SLinus Torvalds #define LINX_FUTURE_1_PID 0xF44B /* Linx future device */ 2011da177e4SLinus Torvalds #define LINX_FUTURE_2_PID 0xF44C /* Linx future device */ 2021da177e4SLinus Torvalds 2031da177e4SLinus Torvalds /* CCS Inc. ICDU/ICDU40 product ID - the FT232BM is used in an in-circuit-debugger */ 2041da177e4SLinus Torvalds /* unit for PIC16's/PIC18's */ 2051da177e4SLinus Torvalds #define FTDI_CCSICDU20_0_PID 0xF9D0 2061da177e4SLinus Torvalds #define FTDI_CCSICDU40_1_PID 0xF9D1 2071da177e4SLinus Torvalds 2081da177e4SLinus Torvalds /* Inside Accesso contactless reader (http://www.insidefr.com) */ 2091da177e4SLinus Torvalds #define INSIDE_ACCESSO 0xFAD0 2101da177e4SLinus Torvalds 2111da177e4SLinus Torvalds /* 2121da177e4SLinus Torvalds * Intrepid Control Systems (http://www.intrepidcs.com/) ValueCAN and NeoVI 2131da177e4SLinus Torvalds */ 2141da177e4SLinus Torvalds #define INTREPID_VID 0x093C 2151da177e4SLinus Torvalds #define INTREPID_VALUECAN_PID 0x0601 2161da177e4SLinus Torvalds #define INTREPID_NEOVI_PID 0x0701 2171da177e4SLinus Torvalds 2181da177e4SLinus Torvalds /* 2191da177e4SLinus Torvalds * Falcom Wireless Communications GmbH 2201da177e4SLinus Torvalds */ 2211da177e4SLinus Torvalds #define FALCOM_VID 0x0F94 /* Vendor Id */ 2221da177e4SLinus Torvalds #define FALCOM_TWIST_PID 0x0001 /* Falcom Twist USB GPRS modem */ 2231da177e4SLinus Torvalds 2241da177e4SLinus Torvalds /* 2251da177e4SLinus Torvalds * SUUNTO product ids 2261da177e4SLinus Torvalds */ 2271da177e4SLinus Torvalds #define FTDI_SUUNTO_SPORTS_PID 0xF680 /* Suunto Sports instrument */ 2281da177e4SLinus Torvalds 2291da177e4SLinus Torvalds /* 2301da177e4SLinus Torvalds * Definitions for B&B Electronics products. 2311da177e4SLinus Torvalds */ 2321da177e4SLinus Torvalds #define BANDB_VID 0x0856 /* B&B Electronics Vendor ID */ 2331da177e4SLinus Torvalds #define BANDB_USOTL4_PID 0xAC01 /* USOTL4 Isolated RS-485 Converter */ 2341da177e4SLinus Torvalds #define BANDB_USTL4_PID 0xAC02 /* USTL4 RS-485 Converter */ 2351da177e4SLinus Torvalds #define BANDB_USO9ML2_PID 0xAC03 /* USO9ML2 Isolated RS-232 Converter */ 2361da177e4SLinus Torvalds 2371da177e4SLinus Torvalds /* 2381da177e4SLinus Torvalds * RM Michaelides CANview USB (http://www.rmcan.com) 2391da177e4SLinus Torvalds * CAN filedbus interface adapter, addad by port GmbH www.port.de) 2401da177e4SLinus Torvalds */ 2411da177e4SLinus Torvalds #define FTDI_RM_VID 0x0403 /* Vendor Id */ 2421da177e4SLinus Torvalds #define FTDI_RMCANVIEW_PID 0xfd60 /* Product Id */ 2431da177e4SLinus Torvalds 2441da177e4SLinus Torvalds /* 2451da177e4SLinus Torvalds * EVER Eco Pro UPS (http://www.ever.com.pl/) 2461da177e4SLinus Torvalds */ 2471da177e4SLinus Torvalds 2481da177e4SLinus Torvalds #define EVER_ECO_PRO_CDS 0xe520 /* RS-232 converter */ 2491da177e4SLinus Torvalds 2501da177e4SLinus Torvalds /* Commands */ 2511da177e4SLinus Torvalds #define FTDI_SIO_RESET 0 /* Reset the port */ 2521da177e4SLinus Torvalds #define FTDI_SIO_MODEM_CTRL 1 /* Set the modem control register */ 2531da177e4SLinus Torvalds #define FTDI_SIO_SET_FLOW_CTRL 2 /* Set flow control register */ 2541da177e4SLinus Torvalds #define FTDI_SIO_SET_BAUD_RATE 3 /* Set baud rate */ 2551da177e4SLinus Torvalds #define FTDI_SIO_SET_DATA 4 /* Set the data characteristics of the port */ 2561da177e4SLinus Torvalds #define FTDI_SIO_GET_MODEM_STATUS 5 /* Retrieve current value of modern status register */ 2571da177e4SLinus Torvalds #define FTDI_SIO_SET_EVENT_CHAR 6 /* Set the event character */ 2581da177e4SLinus Torvalds #define FTDI_SIO_SET_ERROR_CHAR 7 /* Set the error character */ 2591da177e4SLinus Torvalds #define FTDI_SIO_SET_LATENCY_TIMER 9 /* Set the latency timer */ 2601da177e4SLinus Torvalds #define FTDI_SIO_GET_LATENCY_TIMER 10 /* Get the latency timer */ 2611da177e4SLinus Torvalds 2621da177e4SLinus Torvalds /* Port interface code for FT2232C */ 2631da177e4SLinus Torvalds #define INTERFACE_A 1 2641da177e4SLinus Torvalds #define INTERFACE_B 2 2651da177e4SLinus Torvalds 2661da177e4SLinus Torvalds 2671da177e4SLinus Torvalds /* 2681da177e4SLinus Torvalds * BmRequestType: 1100 0000b 2691da177e4SLinus Torvalds * bRequest: FTDI_E2_READ 2701da177e4SLinus Torvalds * wValue: 0 2711da177e4SLinus Torvalds * wIndex: Address of word to read 2721da177e4SLinus Torvalds * wLength: 2 2731da177e4SLinus Torvalds * Data: Will return a word of data from E2Address 2741da177e4SLinus Torvalds * 2751da177e4SLinus Torvalds */ 2761da177e4SLinus Torvalds 2771da177e4SLinus Torvalds /* Port Identifier Table */ 2781da177e4SLinus Torvalds #define PIT_DEFAULT 0 /* SIOA */ 2791da177e4SLinus Torvalds #define PIT_SIOA 1 /* SIOA */ 2801da177e4SLinus Torvalds /* The device this driver is tested with one has only one port */ 2811da177e4SLinus Torvalds #define PIT_SIOB 2 /* SIOB */ 2821da177e4SLinus Torvalds #define PIT_PARALLEL 3 /* Parallel */ 2831da177e4SLinus Torvalds 2841da177e4SLinus Torvalds /* FTDI_SIO_RESET */ 2851da177e4SLinus Torvalds #define FTDI_SIO_RESET_REQUEST FTDI_SIO_RESET 2861da177e4SLinus Torvalds #define FTDI_SIO_RESET_REQUEST_TYPE 0x40 2871da177e4SLinus Torvalds #define FTDI_SIO_RESET_SIO 0 2881da177e4SLinus Torvalds #define FTDI_SIO_RESET_PURGE_RX 1 2891da177e4SLinus Torvalds #define FTDI_SIO_RESET_PURGE_TX 2 2901da177e4SLinus Torvalds 2911da177e4SLinus Torvalds /* 2921da177e4SLinus Torvalds * BmRequestType: 0100 0000B 2931da177e4SLinus Torvalds * bRequest: FTDI_SIO_RESET 2941da177e4SLinus Torvalds * wValue: Control Value 2951da177e4SLinus Torvalds * 0 = Reset SIO 2961da177e4SLinus Torvalds * 1 = Purge RX buffer 2971da177e4SLinus Torvalds * 2 = Purge TX buffer 2981da177e4SLinus Torvalds * wIndex: Port 2991da177e4SLinus Torvalds * wLength: 0 3001da177e4SLinus Torvalds * Data: None 3011da177e4SLinus Torvalds * 3021da177e4SLinus Torvalds * The Reset SIO command has this effect: 3031da177e4SLinus Torvalds * 3041da177e4SLinus Torvalds * Sets flow control set to 'none' 3051da177e4SLinus Torvalds * Event char = $0D 3061da177e4SLinus Torvalds * Event trigger = disabled 3071da177e4SLinus Torvalds * Purge RX buffer 3081da177e4SLinus Torvalds * Purge TX buffer 3091da177e4SLinus Torvalds * Clear DTR 3101da177e4SLinus Torvalds * Clear RTS 3111da177e4SLinus Torvalds * baud and data format not reset 3121da177e4SLinus Torvalds * 3131da177e4SLinus Torvalds * The Purge RX and TX buffer commands affect nothing except the buffers 3141da177e4SLinus Torvalds * 3151da177e4SLinus Torvalds */ 3161da177e4SLinus Torvalds 3171da177e4SLinus Torvalds /* FTDI_SIO_SET_BAUDRATE */ 3181da177e4SLinus Torvalds #define FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE 0x40 3191da177e4SLinus Torvalds #define FTDI_SIO_SET_BAUDRATE_REQUEST 3 3201da177e4SLinus Torvalds 3211da177e4SLinus Torvalds /* 3221da177e4SLinus Torvalds * BmRequestType: 0100 0000B 3231da177e4SLinus Torvalds * bRequest: FTDI_SIO_SET_BAUDRATE 3241da177e4SLinus Torvalds * wValue: BaudDivisor value - see below 3251da177e4SLinus Torvalds * wIndex: Port 3261da177e4SLinus Torvalds * wLength: 0 3271da177e4SLinus Torvalds * Data: None 3281da177e4SLinus Torvalds * The BaudDivisor values are calculated as follows: 3291da177e4SLinus Torvalds * - BaseClock is either 12000000 or 48000000 depending on the device. FIXME: I wish 3301da177e4SLinus Torvalds * I knew how to detect old chips to select proper base clock! 3311da177e4SLinus Torvalds * - BaudDivisor is a fixed point number encoded in a funny way. 3321da177e4SLinus Torvalds * (--WRONG WAY OF THINKING--) 3331da177e4SLinus Torvalds * BaudDivisor is a fixed point number encoded with following bit weighs: 3341da177e4SLinus Torvalds * (-2)(-1)(13..0). It is a radical with a denominator of 4, so values 3351da177e4SLinus Torvalds * end with 0.0 (00...), 0.25 (10...), 0.5 (01...), and 0.75 (11...). 3361da177e4SLinus Torvalds * (--THE REALITY--) 3371da177e4SLinus Torvalds * The both-bits-set has quite different meaning from 0.75 - the chip designers 3381da177e4SLinus Torvalds * have decided it to mean 0.125 instead of 0.75. 3391da177e4SLinus Torvalds * This info looked up in FTDI application note "FT8U232 DEVICES \ Data Rates 3401da177e4SLinus Torvalds * and Flow Control Consideration for USB to RS232". 3411da177e4SLinus Torvalds * - BaudDivisor = (BaseClock / 16) / BaudRate, where the (=) operation should 3421da177e4SLinus Torvalds * automagically re-encode the resulting value to take fractions into consideration. 3431da177e4SLinus Torvalds * As all values are integers, some bit twiddling is in order: 3441da177e4SLinus Torvalds * BaudDivisor = (BaseClock / 16 / BaudRate) | 3451da177e4SLinus Torvalds * (((BaseClock / 2 / BaudRate) & 4) ? 0x4000 // 0.5 3461da177e4SLinus Torvalds * : ((BaseClock / 2 / BaudRate) & 2) ? 0x8000 // 0.25 3471da177e4SLinus Torvalds * : ((BaseClock / 2 / BaudRate) & 1) ? 0xc000 // 0.125 3481da177e4SLinus Torvalds * : 0) 3491da177e4SLinus Torvalds * 3501da177e4SLinus Torvalds * For the FT232BM, a 17th divisor bit was introduced to encode the multiples 3511da177e4SLinus Torvalds * of 0.125 missing from the FT8U232AM. Bits 16 to 14 are coded as follows 3521da177e4SLinus Torvalds * (the first four codes are the same as for the FT8U232AM, where bit 16 is 3531da177e4SLinus Torvalds * always 0): 3541da177e4SLinus Torvalds * 000 - add .000 to divisor 3551da177e4SLinus Torvalds * 001 - add .500 to divisor 3561da177e4SLinus Torvalds * 010 - add .250 to divisor 3571da177e4SLinus Torvalds * 011 - add .125 to divisor 3581da177e4SLinus Torvalds * 100 - add .375 to divisor 3591da177e4SLinus Torvalds * 101 - add .625 to divisor 3601da177e4SLinus Torvalds * 110 - add .750 to divisor 3611da177e4SLinus Torvalds * 111 - add .875 to divisor 3621da177e4SLinus Torvalds * Bits 15 to 0 of the 17-bit divisor are placed in the urb value. Bit 16 is 3631da177e4SLinus Torvalds * placed in bit 0 of the urb index. 3641da177e4SLinus Torvalds * 3651da177e4SLinus Torvalds * Note that there are a couple of special cases to support the highest baud 3661da177e4SLinus Torvalds * rates. If the calculated divisor value is 1, this needs to be replaced with 3671da177e4SLinus Torvalds * 0. Additionally for the FT232BM, if the calculated divisor value is 0x4001 3681da177e4SLinus Torvalds * (1.5), this needs to be replaced with 0x0001 (1) (but this divisor value is 3691da177e4SLinus Torvalds * not supported by the FT8U232AM). 3701da177e4SLinus Torvalds */ 3711da177e4SLinus Torvalds 3721da177e4SLinus Torvalds typedef enum { 3731da177e4SLinus Torvalds SIO = 1, 3741da177e4SLinus Torvalds FT8U232AM = 2, 3751da177e4SLinus Torvalds FT232BM = 3, 3761da177e4SLinus Torvalds FT2232C = 4, 3771da177e4SLinus Torvalds } ftdi_chip_type_t; 3781da177e4SLinus Torvalds 3791da177e4SLinus Torvalds typedef enum { 3801da177e4SLinus Torvalds ftdi_sio_b300 = 0, 3811da177e4SLinus Torvalds ftdi_sio_b600 = 1, 3821da177e4SLinus Torvalds ftdi_sio_b1200 = 2, 3831da177e4SLinus Torvalds ftdi_sio_b2400 = 3, 3841da177e4SLinus Torvalds ftdi_sio_b4800 = 4, 3851da177e4SLinus Torvalds ftdi_sio_b9600 = 5, 3861da177e4SLinus Torvalds ftdi_sio_b19200 = 6, 3871da177e4SLinus Torvalds ftdi_sio_b38400 = 7, 3881da177e4SLinus Torvalds ftdi_sio_b57600 = 8, 3891da177e4SLinus Torvalds ftdi_sio_b115200 = 9 3901da177e4SLinus Torvalds } FTDI_SIO_baudrate_t ; 3911da177e4SLinus Torvalds 3921da177e4SLinus Torvalds /* 3931da177e4SLinus Torvalds * The ftdi_8U232AM_xxMHz_byyy constants have been removed. The encoded divisor values 3941da177e4SLinus Torvalds * are calculated internally. 3951da177e4SLinus Torvalds */ 3961da177e4SLinus Torvalds 3971da177e4SLinus Torvalds #define FTDI_SIO_SET_DATA_REQUEST FTDI_SIO_SET_DATA 3981da177e4SLinus Torvalds #define FTDI_SIO_SET_DATA_REQUEST_TYPE 0x40 3991da177e4SLinus Torvalds #define FTDI_SIO_SET_DATA_PARITY_NONE (0x0 << 8 ) 4001da177e4SLinus Torvalds #define FTDI_SIO_SET_DATA_PARITY_ODD (0x1 << 8 ) 4011da177e4SLinus Torvalds #define FTDI_SIO_SET_DATA_PARITY_EVEN (0x2 << 8 ) 4021da177e4SLinus Torvalds #define FTDI_SIO_SET_DATA_PARITY_MARK (0x3 << 8 ) 4031da177e4SLinus Torvalds #define FTDI_SIO_SET_DATA_PARITY_SPACE (0x4 << 8 ) 4041da177e4SLinus Torvalds #define FTDI_SIO_SET_DATA_STOP_BITS_1 (0x0 << 11 ) 4051da177e4SLinus Torvalds #define FTDI_SIO_SET_DATA_STOP_BITS_15 (0x1 << 11 ) 4061da177e4SLinus Torvalds #define FTDI_SIO_SET_DATA_STOP_BITS_2 (0x2 << 11 ) 4071da177e4SLinus Torvalds #define FTDI_SIO_SET_BREAK (0x1 << 14) 4081da177e4SLinus Torvalds /* FTDI_SIO_SET_DATA */ 4091da177e4SLinus Torvalds 4101da177e4SLinus Torvalds /* 4111da177e4SLinus Torvalds * BmRequestType: 0100 0000B 4121da177e4SLinus Torvalds * bRequest: FTDI_SIO_SET_DATA 4131da177e4SLinus Torvalds * wValue: Data characteristics (see below) 4141da177e4SLinus Torvalds * wIndex: Port 4151da177e4SLinus Torvalds * wLength: 0 4161da177e4SLinus Torvalds * Data: No 4171da177e4SLinus Torvalds * 4181da177e4SLinus Torvalds * Data characteristics 4191da177e4SLinus Torvalds * 4201da177e4SLinus Torvalds * B0..7 Number of data bits 4211da177e4SLinus Torvalds * B8..10 Parity 4221da177e4SLinus Torvalds * 0 = None 4231da177e4SLinus Torvalds * 1 = Odd 4241da177e4SLinus Torvalds * 2 = Even 4251da177e4SLinus Torvalds * 3 = Mark 4261da177e4SLinus Torvalds * 4 = Space 4271da177e4SLinus Torvalds * B11..13 Stop Bits 4281da177e4SLinus Torvalds * 0 = 1 4291da177e4SLinus Torvalds * 1 = 1.5 4301da177e4SLinus Torvalds * 2 = 2 4311da177e4SLinus Torvalds * B14 4321da177e4SLinus Torvalds * 1 = TX ON (break) 4331da177e4SLinus Torvalds * 0 = TX OFF (normal state) 4341da177e4SLinus Torvalds * B15 Reserved 4351da177e4SLinus Torvalds * 4361da177e4SLinus Torvalds */ 4371da177e4SLinus Torvalds 4381da177e4SLinus Torvalds 4391da177e4SLinus Torvalds 4401da177e4SLinus Torvalds /* FTDI_SIO_MODEM_CTRL */ 4411da177e4SLinus Torvalds #define FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE 0x40 4421da177e4SLinus Torvalds #define FTDI_SIO_SET_MODEM_CTRL_REQUEST FTDI_SIO_MODEM_CTRL 4431da177e4SLinus Torvalds 4441da177e4SLinus Torvalds /* 4451da177e4SLinus Torvalds * BmRequestType: 0100 0000B 4461da177e4SLinus Torvalds * bRequest: FTDI_SIO_MODEM_CTRL 4471da177e4SLinus Torvalds * wValue: ControlValue (see below) 4481da177e4SLinus Torvalds * wIndex: Port 4491da177e4SLinus Torvalds * wLength: 0 4501da177e4SLinus Torvalds * Data: None 4511da177e4SLinus Torvalds * 4521da177e4SLinus Torvalds * NOTE: If the device is in RTS/CTS flow control, the RTS set by this 4531da177e4SLinus Torvalds * command will be IGNORED without an error being returned 4541da177e4SLinus Torvalds * Also - you can not set DTR and RTS with one control message 4551da177e4SLinus Torvalds */ 4561da177e4SLinus Torvalds 4571da177e4SLinus Torvalds #define FTDI_SIO_SET_DTR_MASK 0x1 4581da177e4SLinus Torvalds #define FTDI_SIO_SET_DTR_HIGH ( 1 | ( FTDI_SIO_SET_DTR_MASK << 8)) 4591da177e4SLinus Torvalds #define FTDI_SIO_SET_DTR_LOW ( 0 | ( FTDI_SIO_SET_DTR_MASK << 8)) 4601da177e4SLinus Torvalds #define FTDI_SIO_SET_RTS_MASK 0x2 4611da177e4SLinus Torvalds #define FTDI_SIO_SET_RTS_HIGH ( 2 | ( FTDI_SIO_SET_RTS_MASK << 8 )) 4621da177e4SLinus Torvalds #define FTDI_SIO_SET_RTS_LOW ( 0 | ( FTDI_SIO_SET_RTS_MASK << 8 )) 4631da177e4SLinus Torvalds 4641da177e4SLinus Torvalds /* 4651da177e4SLinus Torvalds * ControlValue 4661da177e4SLinus Torvalds * B0 DTR state 4671da177e4SLinus Torvalds * 0 = reset 4681da177e4SLinus Torvalds * 1 = set 4691da177e4SLinus Torvalds * B1 RTS state 4701da177e4SLinus Torvalds * 0 = reset 4711da177e4SLinus Torvalds * 1 = set 4721da177e4SLinus Torvalds * B2..7 Reserved 4731da177e4SLinus Torvalds * B8 DTR state enable 4741da177e4SLinus Torvalds * 0 = ignore 4751da177e4SLinus Torvalds * 1 = use DTR state 4761da177e4SLinus Torvalds * B9 RTS state enable 4771da177e4SLinus Torvalds * 0 = ignore 4781da177e4SLinus Torvalds * 1 = use RTS state 4791da177e4SLinus Torvalds * B10..15 Reserved 4801da177e4SLinus Torvalds */ 4811da177e4SLinus Torvalds 4821da177e4SLinus Torvalds /* FTDI_SIO_SET_FLOW_CTRL */ 4831da177e4SLinus Torvalds #define FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE 0x40 4841da177e4SLinus Torvalds #define FTDI_SIO_SET_FLOW_CTRL_REQUEST FTDI_SIO_SET_FLOW_CTRL 4851da177e4SLinus Torvalds #define FTDI_SIO_DISABLE_FLOW_CTRL 0x0 4861da177e4SLinus Torvalds #define FTDI_SIO_RTS_CTS_HS (0x1 << 8) 4871da177e4SLinus Torvalds #define FTDI_SIO_DTR_DSR_HS (0x2 << 8) 4881da177e4SLinus Torvalds #define FTDI_SIO_XON_XOFF_HS (0x4 << 8) 4891da177e4SLinus Torvalds /* 4901da177e4SLinus Torvalds * BmRequestType: 0100 0000b 4911da177e4SLinus Torvalds * bRequest: FTDI_SIO_SET_FLOW_CTRL 4921da177e4SLinus Torvalds * wValue: Xoff/Xon 4931da177e4SLinus Torvalds * wIndex: Protocol/Port - hIndex is protocl / lIndex is port 4941da177e4SLinus Torvalds * wLength: 0 4951da177e4SLinus Torvalds * Data: None 4961da177e4SLinus Torvalds * 4971da177e4SLinus Torvalds * hIndex protocol is: 4981da177e4SLinus Torvalds * B0 Output handshaking using RTS/CTS 4991da177e4SLinus Torvalds * 0 = disabled 5001da177e4SLinus Torvalds * 1 = enabled 5011da177e4SLinus Torvalds * B1 Output handshaking using DTR/DSR 5021da177e4SLinus Torvalds * 0 = disabled 5031da177e4SLinus Torvalds * 1 = enabled 5041da177e4SLinus Torvalds * B2 Xon/Xoff handshaking 5051da177e4SLinus Torvalds * 0 = disabled 5061da177e4SLinus Torvalds * 1 = enabled 5071da177e4SLinus Torvalds * 5081da177e4SLinus Torvalds * A value of zero in the hIndex field disables handshaking 5091da177e4SLinus Torvalds * 5101da177e4SLinus Torvalds * If Xon/Xoff handshaking is specified, the hValue field should contain the XOFF character 5111da177e4SLinus Torvalds * and the lValue field contains the XON character. 5121da177e4SLinus Torvalds */ 5131da177e4SLinus Torvalds 5141da177e4SLinus Torvalds /* 5151da177e4SLinus Torvalds * FTDI_SIO_GET_LATENCY_TIMER 5161da177e4SLinus Torvalds * 5171da177e4SLinus Torvalds * Set the timeout interval. The FTDI collects data from the slave 5181da177e4SLinus Torvalds * device, transmitting it to the host when either A) 62 bytes are 5191da177e4SLinus Torvalds * received, or B) the timeout interval has elapsed and the buffer 5201da177e4SLinus Torvalds * contains at least 1 byte. Setting this value to a small number 5211da177e4SLinus Torvalds * can dramatically improve performance for applications which send 5221da177e4SLinus Torvalds * small packets, since the default value is 16ms. 5231da177e4SLinus Torvalds */ 5241da177e4SLinus Torvalds #define FTDI_SIO_GET_LATENCY_TIMER_REQUEST FTDI_SIO_GET_LATENCY_TIMER 5251da177e4SLinus Torvalds #define FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE 0xC0 5261da177e4SLinus Torvalds 5271da177e4SLinus Torvalds /* 5281da177e4SLinus Torvalds * BmRequestType: 1100 0000b 5291da177e4SLinus Torvalds * bRequest: FTDI_SIO_GET_LATENCY_TIMER 5301da177e4SLinus Torvalds * wValue: 0 5311da177e4SLinus Torvalds * wIndex: Port 5321da177e4SLinus Torvalds * wLength: 0 5331da177e4SLinus Torvalds * Data: latency (on return) 5341da177e4SLinus Torvalds */ 5351da177e4SLinus Torvalds 5361da177e4SLinus Torvalds /* 5371da177e4SLinus Torvalds * FTDI_SIO_SET_LATENCY_TIMER 5381da177e4SLinus Torvalds * 5391da177e4SLinus Torvalds * Set the timeout interval. The FTDI collects data from the slave 5401da177e4SLinus Torvalds * device, transmitting it to the host when either A) 62 bytes are 5411da177e4SLinus Torvalds * received, or B) the timeout interval has elapsed and the buffer 5421da177e4SLinus Torvalds * contains at least 1 byte. Setting this value to a small number 5431da177e4SLinus Torvalds * can dramatically improve performance for applications which send 5441da177e4SLinus Torvalds * small packets, since the default value is 16ms. 5451da177e4SLinus Torvalds */ 5461da177e4SLinus Torvalds #define FTDI_SIO_SET_LATENCY_TIMER_REQUEST FTDI_SIO_SET_LATENCY_TIMER 5471da177e4SLinus Torvalds #define FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE 0x40 5481da177e4SLinus Torvalds 5491da177e4SLinus Torvalds /* 5501da177e4SLinus Torvalds * BmRequestType: 0100 0000b 5511da177e4SLinus Torvalds * bRequest: FTDI_SIO_SET_LATENCY_TIMER 5521da177e4SLinus Torvalds * wValue: Latency (milliseconds) 5531da177e4SLinus Torvalds * wIndex: Port 5541da177e4SLinus Torvalds * wLength: 0 5551da177e4SLinus Torvalds * Data: None 5561da177e4SLinus Torvalds * 5571da177e4SLinus Torvalds * wValue: 5581da177e4SLinus Torvalds * B0..7 Latency timer 5591da177e4SLinus Torvalds * B8..15 0 5601da177e4SLinus Torvalds * 5611da177e4SLinus Torvalds */ 5621da177e4SLinus Torvalds 5631da177e4SLinus Torvalds /* 5641da177e4SLinus Torvalds * FTDI_SIO_SET_EVENT_CHAR 5651da177e4SLinus Torvalds * 5661da177e4SLinus Torvalds * Set the special event character for the specified communications port. 5671da177e4SLinus Torvalds * If the device sees this character it will immediately return the 5681da177e4SLinus Torvalds * data read so far - rather than wait 40ms or until 62 bytes are read 5691da177e4SLinus Torvalds * which is what normally happens. 5701da177e4SLinus Torvalds */ 5711da177e4SLinus Torvalds 5721da177e4SLinus Torvalds 5731da177e4SLinus Torvalds #define FTDI_SIO_SET_EVENT_CHAR_REQUEST FTDI_SIO_SET_EVENT_CHAR 5741da177e4SLinus Torvalds #define FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE 0x40 5751da177e4SLinus Torvalds 5761da177e4SLinus Torvalds 5771da177e4SLinus Torvalds /* 5781da177e4SLinus Torvalds * BmRequestType: 0100 0000b 5791da177e4SLinus Torvalds * bRequest: FTDI_SIO_SET_EVENT_CHAR 5801da177e4SLinus Torvalds * wValue: EventChar 5811da177e4SLinus Torvalds * wIndex: Port 5821da177e4SLinus Torvalds * wLength: 0 5831da177e4SLinus Torvalds * Data: None 5841da177e4SLinus Torvalds * 5851da177e4SLinus Torvalds * wValue: 5861da177e4SLinus Torvalds * B0..7 Event Character 5871da177e4SLinus Torvalds * B8 Event Character Processing 5881da177e4SLinus Torvalds * 0 = disabled 5891da177e4SLinus Torvalds * 1 = enabled 5901da177e4SLinus Torvalds * B9..15 Reserved 5911da177e4SLinus Torvalds * 5921da177e4SLinus Torvalds */ 5931da177e4SLinus Torvalds 5941da177e4SLinus Torvalds /* FTDI_SIO_SET_ERROR_CHAR */ 5951da177e4SLinus Torvalds 5961da177e4SLinus Torvalds /* Set the parity error replacement character for the specified communications port */ 5971da177e4SLinus Torvalds 5981da177e4SLinus Torvalds /* 5991da177e4SLinus Torvalds * BmRequestType: 0100 0000b 6001da177e4SLinus Torvalds * bRequest: FTDI_SIO_SET_EVENT_CHAR 6011da177e4SLinus Torvalds * wValue: Error Char 6021da177e4SLinus Torvalds * wIndex: Port 6031da177e4SLinus Torvalds * wLength: 0 6041da177e4SLinus Torvalds * Data: None 6051da177e4SLinus Torvalds * 6061da177e4SLinus Torvalds *Error Char 6071da177e4SLinus Torvalds * B0..7 Error Character 6081da177e4SLinus Torvalds * B8 Error Character Processing 6091da177e4SLinus Torvalds * 0 = disabled 6101da177e4SLinus Torvalds * 1 = enabled 6111da177e4SLinus Torvalds * B9..15 Reserved 6121da177e4SLinus Torvalds * 6131da177e4SLinus Torvalds */ 6141da177e4SLinus Torvalds 6151da177e4SLinus Torvalds /* FTDI_SIO_GET_MODEM_STATUS */ 6161da177e4SLinus Torvalds /* Retreive the current value of the modem status register */ 6171da177e4SLinus Torvalds 6181da177e4SLinus Torvalds #define FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE 0xc0 6191da177e4SLinus Torvalds #define FTDI_SIO_GET_MODEM_STATUS_REQUEST FTDI_SIO_GET_MODEM_STATUS 6201da177e4SLinus Torvalds #define FTDI_SIO_CTS_MASK 0x10 6211da177e4SLinus Torvalds #define FTDI_SIO_DSR_MASK 0x20 6221da177e4SLinus Torvalds #define FTDI_SIO_RI_MASK 0x40 6231da177e4SLinus Torvalds #define FTDI_SIO_RLSD_MASK 0x80 6241da177e4SLinus Torvalds /* 6251da177e4SLinus Torvalds * BmRequestType: 1100 0000b 6261da177e4SLinus Torvalds * bRequest: FTDI_SIO_GET_MODEM_STATUS 6271da177e4SLinus Torvalds * wValue: zero 6281da177e4SLinus Torvalds * wIndex: Port 6291da177e4SLinus Torvalds * wLength: 1 6301da177e4SLinus Torvalds * Data: Status 6311da177e4SLinus Torvalds * 6321da177e4SLinus Torvalds * One byte of data is returned 6331da177e4SLinus Torvalds * B0..3 0 6341da177e4SLinus Torvalds * B4 CTS 6351da177e4SLinus Torvalds * 0 = inactive 6361da177e4SLinus Torvalds * 1 = active 6371da177e4SLinus Torvalds * B5 DSR 6381da177e4SLinus Torvalds * 0 = inactive 6391da177e4SLinus Torvalds * 1 = active 6401da177e4SLinus Torvalds * B6 Ring Indicator (RI) 6411da177e4SLinus Torvalds * 0 = inactive 6421da177e4SLinus Torvalds * 1 = active 6431da177e4SLinus Torvalds * B7 Receive Line Signal Detect (RLSD) 6441da177e4SLinus Torvalds * 0 = inactive 6451da177e4SLinus Torvalds * 1 = active 6461da177e4SLinus Torvalds */ 6471da177e4SLinus Torvalds 6481da177e4SLinus Torvalds 6491da177e4SLinus Torvalds 6501da177e4SLinus Torvalds /* Descriptors returned by the device 6511da177e4SLinus Torvalds * 6521da177e4SLinus Torvalds * Device Descriptor 6531da177e4SLinus Torvalds * 6541da177e4SLinus Torvalds * Offset Field Size Value Description 6551da177e4SLinus Torvalds * 0 bLength 1 0x12 Size of descriptor in bytes 6561da177e4SLinus Torvalds * 1 bDescriptorType 1 0x01 DEVICE Descriptor Type 6571da177e4SLinus Torvalds * 2 bcdUSB 2 0x0110 USB Spec Release Number 6581da177e4SLinus Torvalds * 4 bDeviceClass 1 0x00 Class Code 6591da177e4SLinus Torvalds * 5 bDeviceSubClass 1 0x00 SubClass Code 6601da177e4SLinus Torvalds * 6 bDeviceProtocol 1 0x00 Protocol Code 6611da177e4SLinus Torvalds * 7 bMaxPacketSize0 1 0x08 Maximum packet size for endpoint 0 6621da177e4SLinus Torvalds * 8 idVendor 2 0x0403 Vendor ID 6631da177e4SLinus Torvalds * 10 idProduct 2 0x8372 Product ID (FTDI_SIO_PID) 6641da177e4SLinus Torvalds * 12 bcdDevice 2 0x0001 Device release number 6651da177e4SLinus Torvalds * 14 iManufacturer 1 0x01 Index of man. string desc 6661da177e4SLinus Torvalds * 15 iProduct 1 0x02 Index of prod string desc 6671da177e4SLinus Torvalds * 16 iSerialNumber 1 0x02 Index of serial nmr string desc 6681da177e4SLinus Torvalds * 17 bNumConfigurations 1 0x01 Number of possible configurations 6691da177e4SLinus Torvalds * 6701da177e4SLinus Torvalds * Configuration Descriptor 6711da177e4SLinus Torvalds * 6721da177e4SLinus Torvalds * Offset Field Size Value 6731da177e4SLinus Torvalds * 0 bLength 1 0x09 Size of descriptor in bytes 6741da177e4SLinus Torvalds * 1 bDescriptorType 1 0x02 CONFIGURATION Descriptor Type 6751da177e4SLinus Torvalds * 2 wTotalLength 2 0x0020 Total length of data 6761da177e4SLinus Torvalds * 4 bNumInterfaces 1 0x01 Number of interfaces supported 6771da177e4SLinus Torvalds * 5 bConfigurationValue 1 0x01 Argument for SetCOnfiguration() req 6781da177e4SLinus Torvalds * 6 iConfiguration 1 0x02 Index of config string descriptor 6791da177e4SLinus Torvalds * 7 bmAttributes 1 0x20 Config characteristics Remote Wakeup 6801da177e4SLinus Torvalds * 8 MaxPower 1 0x1E Max power consumption 6811da177e4SLinus Torvalds * 6821da177e4SLinus Torvalds * Interface Descriptor 6831da177e4SLinus Torvalds * 6841da177e4SLinus Torvalds * Offset Field Size Value 6851da177e4SLinus Torvalds * 0 bLength 1 0x09 Size of descriptor in bytes 6861da177e4SLinus Torvalds * 1 bDescriptorType 1 0x04 INTERFACE Descriptor Type 6871da177e4SLinus Torvalds * 2 bInterfaceNumber 1 0x00 Number of interface 6881da177e4SLinus Torvalds * 3 bAlternateSetting 1 0x00 Value used to select alternate 6891da177e4SLinus Torvalds * 4 bNumEndpoints 1 0x02 Number of endpoints 6901da177e4SLinus Torvalds * 5 bInterfaceClass 1 0xFF Class Code 6911da177e4SLinus Torvalds * 6 bInterfaceSubClass 1 0xFF Subclass Code 6921da177e4SLinus Torvalds * 7 bInterfaceProtocol 1 0xFF Protocol Code 6931da177e4SLinus Torvalds * 8 iInterface 1 0x02 Index of interface string description 6941da177e4SLinus Torvalds * 6951da177e4SLinus Torvalds * IN Endpoint Descriptor 6961da177e4SLinus Torvalds * 6971da177e4SLinus Torvalds * Offset Field Size Value 6981da177e4SLinus Torvalds * 0 bLength 1 0x07 Size of descriptor in bytes 6991da177e4SLinus Torvalds * 1 bDescriptorType 1 0x05 ENDPOINT descriptor type 7001da177e4SLinus Torvalds * 2 bEndpointAddress 1 0x82 Address of endpoint 7011da177e4SLinus Torvalds * 3 bmAttributes 1 0x02 Endpoint attributes - Bulk 7021da177e4SLinus Torvalds * 4 bNumEndpoints 2 0x0040 maximum packet size 7031da177e4SLinus Torvalds * 5 bInterval 1 0x00 Interval for polling endpoint 7041da177e4SLinus Torvalds * 7051da177e4SLinus Torvalds * OUT Endpoint Descriptor 7061da177e4SLinus Torvalds * 7071da177e4SLinus Torvalds * Offset Field Size Value 7081da177e4SLinus Torvalds * 0 bLength 1 0x07 Size of descriptor in bytes 7091da177e4SLinus Torvalds * 1 bDescriptorType 1 0x05 ENDPOINT descriptor type 7101da177e4SLinus Torvalds * 2 bEndpointAddress 1 0x02 Address of endpoint 7111da177e4SLinus Torvalds * 3 bmAttributes 1 0x02 Endpoint attributes - Bulk 7121da177e4SLinus Torvalds * 4 bNumEndpoints 2 0x0040 maximum packet size 7131da177e4SLinus Torvalds * 5 bInterval 1 0x00 Interval for polling endpoint 7141da177e4SLinus Torvalds * 7151da177e4SLinus Torvalds * DATA FORMAT 7161da177e4SLinus Torvalds * 7171da177e4SLinus Torvalds * IN Endpoint 7181da177e4SLinus Torvalds * 7191da177e4SLinus Torvalds * The device reserves the first two bytes of data on this endpoint to contain the current 7201da177e4SLinus Torvalds * values of the modem and line status registers. In the absence of data, the device 7211da177e4SLinus Torvalds * generates a message consisting of these two status bytes every 40 ms 7221da177e4SLinus Torvalds * 7231da177e4SLinus Torvalds * Byte 0: Modem Status 7241da177e4SLinus Torvalds * 7251da177e4SLinus Torvalds * Offset Description 7261da177e4SLinus Torvalds * B0 Reserved - must be 1 7271da177e4SLinus Torvalds * B1 Reserved - must be 0 7281da177e4SLinus Torvalds * B2 Reserved - must be 0 7291da177e4SLinus Torvalds * B3 Reserved - must be 0 7301da177e4SLinus Torvalds * B4 Clear to Send (CTS) 7311da177e4SLinus Torvalds * B5 Data Set Ready (DSR) 7321da177e4SLinus Torvalds * B6 Ring Indicator (RI) 7331da177e4SLinus Torvalds * B7 Receive Line Signal Detect (RLSD) 7341da177e4SLinus Torvalds * 7351da177e4SLinus Torvalds * Byte 1: Line Status 7361da177e4SLinus Torvalds * 7371da177e4SLinus Torvalds * Offset Description 7381da177e4SLinus Torvalds * B0 Data Ready (DR) 7391da177e4SLinus Torvalds * B1 Overrun Error (OE) 7401da177e4SLinus Torvalds * B2 Parity Error (PE) 7411da177e4SLinus Torvalds * B3 Framing Error (FE) 7421da177e4SLinus Torvalds * B4 Break Interrupt (BI) 7431da177e4SLinus Torvalds * B5 Transmitter Holding Register (THRE) 7441da177e4SLinus Torvalds * B6 Transmitter Empty (TEMT) 7451da177e4SLinus Torvalds * B7 Error in RCVR FIFO 7461da177e4SLinus Torvalds * 7471da177e4SLinus Torvalds */ 7481da177e4SLinus Torvalds #define FTDI_RS0_CTS (1 << 4) 7491da177e4SLinus Torvalds #define FTDI_RS0_DSR (1 << 5) 7501da177e4SLinus Torvalds #define FTDI_RS0_RI (1 << 6) 7511da177e4SLinus Torvalds #define FTDI_RS0_RLSD (1 << 7) 7521da177e4SLinus Torvalds 7531da177e4SLinus Torvalds #define FTDI_RS_DR 1 7541da177e4SLinus Torvalds #define FTDI_RS_OE (1<<1) 7551da177e4SLinus Torvalds #define FTDI_RS_PE (1<<2) 7561da177e4SLinus Torvalds #define FTDI_RS_FE (1<<3) 7571da177e4SLinus Torvalds #define FTDI_RS_BI (1<<4) 7581da177e4SLinus Torvalds #define FTDI_RS_THRE (1<<5) 7591da177e4SLinus Torvalds #define FTDI_RS_TEMT (1<<6) 7601da177e4SLinus Torvalds #define FTDI_RS_FIFO (1<<7) 7611da177e4SLinus Torvalds 7621da177e4SLinus Torvalds /* 7631da177e4SLinus Torvalds * OUT Endpoint 7641da177e4SLinus Torvalds * 7651da177e4SLinus Torvalds * This device reserves the first bytes of data on this endpoint contain the length 7661da177e4SLinus Torvalds * and port identifier of the message. For the FTDI USB Serial converter the port 7671da177e4SLinus Torvalds * identifier is always 1. 7681da177e4SLinus Torvalds * 7691da177e4SLinus Torvalds * Byte 0: Line Status 7701da177e4SLinus Torvalds * 7711da177e4SLinus Torvalds * Offset Description 7721da177e4SLinus Torvalds * B0 Reserved - must be 1 7731da177e4SLinus Torvalds * B1 Reserved - must be 0 7741da177e4SLinus Torvalds * B2..7 Length of message - (not including Byte 0) 7751da177e4SLinus Torvalds * 7761da177e4SLinus Torvalds */ 7771da177e4SLinus Torvalds 778