1b2441318SGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 */ 21da177e4SLinus Torvalds /* 331844d55SAndreas Mohr * Driver definitions for the FTDI USB Single Port Serial Converter - 41da177e4SLinus Torvalds * known as FTDI_SIO (Serial Input/Output application of the chipset) 51da177e4SLinus Torvalds * 631844d55SAndreas Mohr * For USB vendor/product IDs (VID/PID), please see ftdi_sio_ids.h 731844d55SAndreas Mohr * 831844d55SAndreas Mohr * 91da177e4SLinus Torvalds * The example I have is known as the USC-1000 which is available from 101da177e4SLinus Torvalds * http://www.dse.co.nz - cat no XH4214 It looks similar to this: 111da177e4SLinus Torvalds * http://www.dansdata.com/usbser.htm but I can't be sure There are other 121da177e4SLinus Torvalds * USC-1000s which don't look like my device though so beware! 131da177e4SLinus Torvalds * 141da177e4SLinus Torvalds * The device is based on the FTDI FT8U100AX chip. It has a DB25 on one side, 151da177e4SLinus Torvalds * USB on the other. 161da177e4SLinus Torvalds * 17094c2e6dSMark Adamson * Thanx to FTDI (http://www.ftdichip.com) for so kindly providing details 181da177e4SLinus Torvalds * of the protocol required to talk to the device and ongoing assistence 191da177e4SLinus Torvalds * during development. 201da177e4SLinus Torvalds * 211da177e4SLinus Torvalds * Bill Ryder - bryder@sgi.com formerly of Silicon Graphics, Inc.- wrote the 221da177e4SLinus Torvalds * FTDI_SIO implementation. 231da177e4SLinus Torvalds * 241da177e4SLinus Torvalds */ 251da177e4SLinus Torvalds 261da177e4SLinus Torvalds /* Commands */ 271da177e4SLinus Torvalds #define FTDI_SIO_RESET 0 /* Reset the port */ 281da177e4SLinus Torvalds #define FTDI_SIO_MODEM_CTRL 1 /* Set the modem control register */ 291da177e4SLinus Torvalds #define FTDI_SIO_SET_FLOW_CTRL 2 /* Set flow control register */ 301da177e4SLinus Torvalds #define FTDI_SIO_SET_BAUD_RATE 3 /* Set baud rate */ 313bb36aa2SGreg Kroah-Hartman #define FTDI_SIO_SET_DATA 4 /* Set the data characteristics of 323bb36aa2SGreg Kroah-Hartman the port */ 333bb36aa2SGreg Kroah-Hartman #define FTDI_SIO_GET_MODEM_STATUS 5 /* Retrieve current value of modem 343bb36aa2SGreg Kroah-Hartman status register */ 351da177e4SLinus Torvalds #define FTDI_SIO_SET_EVENT_CHAR 6 /* Set the event character */ 361da177e4SLinus Torvalds #define FTDI_SIO_SET_ERROR_CHAR 7 /* Set the error character */ 371da177e4SLinus Torvalds #define FTDI_SIO_SET_LATENCY_TIMER 9 /* Set the latency timer */ 381da177e4SLinus Torvalds #define FTDI_SIO_GET_LATENCY_TIMER 10 /* Get the latency timer */ 391da177e4SLinus Torvalds 400a2a3775SAndreas Mohr /* Interface indices for FT2232, FT2232H and FT4232H devices */ 41094c2e6dSMark Adamson #define INTERFACE_A 1 42094c2e6dSMark Adamson #define INTERFACE_B 2 43094c2e6dSMark Adamson #define INTERFACE_C 3 44094c2e6dSMark Adamson #define INTERFACE_D 4 451da177e4SLinus Torvalds 46e7d7fcc0SPawel Ludwikow 47e7d7fcc0SPawel Ludwikow /* 481da177e4SLinus Torvalds * BmRequestType: 1100 0000b 491da177e4SLinus Torvalds * bRequest: FTDI_E2_READ 501da177e4SLinus Torvalds * wValue: 0 511da177e4SLinus Torvalds * wIndex: Address of word to read 521da177e4SLinus Torvalds * wLength: 2 531da177e4SLinus Torvalds * Data: Will return a word of data from E2Address 541da177e4SLinus Torvalds * 551da177e4SLinus Torvalds */ 561da177e4SLinus Torvalds 571da177e4SLinus Torvalds /* Port Identifier Table */ 581da177e4SLinus Torvalds #define PIT_DEFAULT 0 /* SIOA */ 591da177e4SLinus Torvalds #define PIT_SIOA 1 /* SIOA */ 601da177e4SLinus Torvalds /* The device this driver is tested with one has only one port */ 611da177e4SLinus Torvalds #define PIT_SIOB 2 /* SIOB */ 621da177e4SLinus Torvalds #define PIT_PARALLEL 3 /* Parallel */ 631da177e4SLinus Torvalds 641da177e4SLinus Torvalds /* FTDI_SIO_RESET */ 651da177e4SLinus Torvalds #define FTDI_SIO_RESET_REQUEST FTDI_SIO_RESET 661da177e4SLinus Torvalds #define FTDI_SIO_RESET_REQUEST_TYPE 0x40 671da177e4SLinus Torvalds #define FTDI_SIO_RESET_SIO 0 681da177e4SLinus Torvalds #define FTDI_SIO_RESET_PURGE_RX 1 691da177e4SLinus Torvalds #define FTDI_SIO_RESET_PURGE_TX 2 701da177e4SLinus Torvalds 711da177e4SLinus Torvalds /* 721da177e4SLinus Torvalds * BmRequestType: 0100 0000B 731da177e4SLinus Torvalds * bRequest: FTDI_SIO_RESET 741da177e4SLinus Torvalds * wValue: Control Value 751da177e4SLinus Torvalds * 0 = Reset SIO 761da177e4SLinus Torvalds * 1 = Purge RX buffer 771da177e4SLinus Torvalds * 2 = Purge TX buffer 781da177e4SLinus Torvalds * wIndex: Port 791da177e4SLinus Torvalds * wLength: 0 801da177e4SLinus Torvalds * Data: None 811da177e4SLinus Torvalds * 821da177e4SLinus Torvalds * The Reset SIO command has this effect: 831da177e4SLinus Torvalds * 841da177e4SLinus Torvalds * Sets flow control set to 'none' 851da177e4SLinus Torvalds * Event char = $0D 861da177e4SLinus Torvalds * Event trigger = disabled 871da177e4SLinus Torvalds * Purge RX buffer 881da177e4SLinus Torvalds * Purge TX buffer 891da177e4SLinus Torvalds * Clear DTR 901da177e4SLinus Torvalds * Clear RTS 911da177e4SLinus Torvalds * baud and data format not reset 921da177e4SLinus Torvalds * 931da177e4SLinus Torvalds * The Purge RX and TX buffer commands affect nothing except the buffers 941da177e4SLinus Torvalds * 951da177e4SLinus Torvalds */ 961da177e4SLinus Torvalds 971da177e4SLinus Torvalds /* FTDI_SIO_SET_BAUDRATE */ 981da177e4SLinus Torvalds #define FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE 0x40 991da177e4SLinus Torvalds #define FTDI_SIO_SET_BAUDRATE_REQUEST 3 1001da177e4SLinus Torvalds 1011da177e4SLinus Torvalds /* 1021da177e4SLinus Torvalds * BmRequestType: 0100 0000B 1031da177e4SLinus Torvalds * bRequest: FTDI_SIO_SET_BAUDRATE 1041da177e4SLinus Torvalds * wValue: BaudDivisor value - see below 1051da177e4SLinus Torvalds * wIndex: Port 1061da177e4SLinus Torvalds * wLength: 0 1071da177e4SLinus Torvalds * Data: None 1081da177e4SLinus Torvalds * The BaudDivisor values are calculated as follows: 1093bb36aa2SGreg Kroah-Hartman * - BaseClock is either 12000000 or 48000000 depending on the device. 1103bb36aa2SGreg Kroah-Hartman * FIXME: I wish I knew how to detect old chips to select proper base clock! 1111da177e4SLinus Torvalds * - BaudDivisor is a fixed point number encoded in a funny way. 1121da177e4SLinus Torvalds * (--WRONG WAY OF THINKING--) 1131da177e4SLinus Torvalds * BaudDivisor is a fixed point number encoded with following bit weighs: 1141da177e4SLinus Torvalds * (-2)(-1)(13..0). It is a radical with a denominator of 4, so values 1151da177e4SLinus Torvalds * end with 0.0 (00...), 0.25 (10...), 0.5 (01...), and 0.75 (11...). 1161da177e4SLinus Torvalds * (--THE REALITY--) 1173bb36aa2SGreg Kroah-Hartman * The both-bits-set has quite different meaning from 0.75 - the chip 1183bb36aa2SGreg Kroah-Hartman * designers have decided it to mean 0.125 instead of 0.75. 1191da177e4SLinus Torvalds * This info looked up in FTDI application note "FT8U232 DEVICES \ Data Rates 1201da177e4SLinus Torvalds * and Flow Control Consideration for USB to RS232". 1211da177e4SLinus Torvalds * - BaudDivisor = (BaseClock / 16) / BaudRate, where the (=) operation should 1223bb36aa2SGreg Kroah-Hartman * automagically re-encode the resulting value to take fractions into 1233bb36aa2SGreg Kroah-Hartman * consideration. 1241da177e4SLinus Torvalds * As all values are integers, some bit twiddling is in order: 1251da177e4SLinus Torvalds * BaudDivisor = (BaseClock / 16 / BaudRate) | 1261da177e4SLinus Torvalds * (((BaseClock / 2 / BaudRate) & 4) ? 0x4000 // 0.5 1271da177e4SLinus Torvalds * : ((BaseClock / 2 / BaudRate) & 2) ? 0x8000 // 0.25 1281da177e4SLinus Torvalds * : ((BaseClock / 2 / BaudRate) & 1) ? 0xc000 // 0.125 1291da177e4SLinus Torvalds * : 0) 1301da177e4SLinus Torvalds * 1311da177e4SLinus Torvalds * For the FT232BM, a 17th divisor bit was introduced to encode the multiples 1321da177e4SLinus Torvalds * of 0.125 missing from the FT8U232AM. Bits 16 to 14 are coded as follows 1331da177e4SLinus Torvalds * (the first four codes are the same as for the FT8U232AM, where bit 16 is 1341da177e4SLinus Torvalds * always 0): 1351da177e4SLinus Torvalds * 000 - add .000 to divisor 1361da177e4SLinus Torvalds * 001 - add .500 to divisor 1371da177e4SLinus Torvalds * 010 - add .250 to divisor 1381da177e4SLinus Torvalds * 011 - add .125 to divisor 1391da177e4SLinus Torvalds * 100 - add .375 to divisor 1401da177e4SLinus Torvalds * 101 - add .625 to divisor 1411da177e4SLinus Torvalds * 110 - add .750 to divisor 1421da177e4SLinus Torvalds * 111 - add .875 to divisor 1431da177e4SLinus Torvalds * Bits 15 to 0 of the 17-bit divisor are placed in the urb value. Bit 16 is 1441da177e4SLinus Torvalds * placed in bit 0 of the urb index. 1451da177e4SLinus Torvalds * 1461da177e4SLinus Torvalds * Note that there are a couple of special cases to support the highest baud 1471da177e4SLinus Torvalds * rates. If the calculated divisor value is 1, this needs to be replaced with 1481da177e4SLinus Torvalds * 0. Additionally for the FT232BM, if the calculated divisor value is 0x4001 1491da177e4SLinus Torvalds * (1.5), this needs to be replaced with 0x0001 (1) (but this divisor value is 1501da177e4SLinus Torvalds * not supported by the FT8U232AM). 1511da177e4SLinus Torvalds */ 1521da177e4SLinus Torvalds 1533bb36aa2SGreg Kroah-Hartman enum ftdi_chip_type { 1541da177e4SLinus Torvalds SIO = 1, 1551da177e4SLinus Torvalds FT8U232AM = 2, 1561da177e4SLinus Torvalds FT232BM = 3, 1571da177e4SLinus Torvalds FT2232C = 4, 158d8b21606SGard Spreemann FT232RL = 5, 159094c2e6dSMark Adamson FT2232H = 6, 160309427b6SUwe Bonnes FT4232H = 7, 161dc0827c1SJim Paris FT232H = 8, 162dc0827c1SJim Paris FTX = 9, 1633bb36aa2SGreg Kroah-Hartman }; 1641da177e4SLinus Torvalds 1653bb36aa2SGreg Kroah-Hartman enum ftdi_sio_baudrate { 1661da177e4SLinus Torvalds ftdi_sio_b300 = 0, 1671da177e4SLinus Torvalds ftdi_sio_b600 = 1, 1681da177e4SLinus Torvalds ftdi_sio_b1200 = 2, 1691da177e4SLinus Torvalds ftdi_sio_b2400 = 3, 1701da177e4SLinus Torvalds ftdi_sio_b4800 = 4, 1711da177e4SLinus Torvalds ftdi_sio_b9600 = 5, 1721da177e4SLinus Torvalds ftdi_sio_b19200 = 6, 1731da177e4SLinus Torvalds ftdi_sio_b38400 = 7, 1741da177e4SLinus Torvalds ftdi_sio_b57600 = 8, 1751da177e4SLinus Torvalds ftdi_sio_b115200 = 9 1763bb36aa2SGreg Kroah-Hartman }; 1771da177e4SLinus Torvalds 1781da177e4SLinus Torvalds /* 1793bb36aa2SGreg Kroah-Hartman * The ftdi_8U232AM_xxMHz_byyy constants have been removed. The encoded divisor 1803bb36aa2SGreg Kroah-Hartman * values are calculated internally. 1811da177e4SLinus Torvalds */ 1821da177e4SLinus Torvalds #define FTDI_SIO_SET_DATA_REQUEST FTDI_SIO_SET_DATA 1831da177e4SLinus Torvalds #define FTDI_SIO_SET_DATA_REQUEST_TYPE 0x40 1841da177e4SLinus Torvalds #define FTDI_SIO_SET_DATA_PARITY_NONE (0x0 << 8) 1851da177e4SLinus Torvalds #define FTDI_SIO_SET_DATA_PARITY_ODD (0x1 << 8) 1861da177e4SLinus Torvalds #define FTDI_SIO_SET_DATA_PARITY_EVEN (0x2 << 8) 1871da177e4SLinus Torvalds #define FTDI_SIO_SET_DATA_PARITY_MARK (0x3 << 8) 1881da177e4SLinus Torvalds #define FTDI_SIO_SET_DATA_PARITY_SPACE (0x4 << 8) 1891da177e4SLinus Torvalds #define FTDI_SIO_SET_DATA_STOP_BITS_1 (0x0 << 11) 1901da177e4SLinus Torvalds #define FTDI_SIO_SET_DATA_STOP_BITS_15 (0x1 << 11) 1911da177e4SLinus Torvalds #define FTDI_SIO_SET_DATA_STOP_BITS_2 (0x2 << 11) 1921da177e4SLinus Torvalds #define FTDI_SIO_SET_BREAK (0x1 << 14) 1931da177e4SLinus Torvalds /* FTDI_SIO_SET_DATA */ 1941da177e4SLinus Torvalds 1951da177e4SLinus Torvalds /* 1961da177e4SLinus Torvalds * BmRequestType: 0100 0000B 1971da177e4SLinus Torvalds * bRequest: FTDI_SIO_SET_DATA 1981da177e4SLinus Torvalds * wValue: Data characteristics (see below) 1991da177e4SLinus Torvalds * wIndex: Port 2001da177e4SLinus Torvalds * wLength: 0 2011da177e4SLinus Torvalds * Data: No 2021da177e4SLinus Torvalds * 2031da177e4SLinus Torvalds * Data characteristics 2041da177e4SLinus Torvalds * 2051da177e4SLinus Torvalds * B0..7 Number of data bits 2061da177e4SLinus Torvalds * B8..10 Parity 2071da177e4SLinus Torvalds * 0 = None 2081da177e4SLinus Torvalds * 1 = Odd 2091da177e4SLinus Torvalds * 2 = Even 2101da177e4SLinus Torvalds * 3 = Mark 2111da177e4SLinus Torvalds * 4 = Space 2121da177e4SLinus Torvalds * B11..13 Stop Bits 2131da177e4SLinus Torvalds * 0 = 1 2141da177e4SLinus Torvalds * 1 = 1.5 2151da177e4SLinus Torvalds * 2 = 2 2161da177e4SLinus Torvalds * B14 2171da177e4SLinus Torvalds * 1 = TX ON (break) 2181da177e4SLinus Torvalds * 0 = TX OFF (normal state) 2191da177e4SLinus Torvalds * B15 Reserved 2201da177e4SLinus Torvalds * 2211da177e4SLinus Torvalds */ 2221da177e4SLinus Torvalds 2231da177e4SLinus Torvalds 2241da177e4SLinus Torvalds 2251da177e4SLinus Torvalds /* FTDI_SIO_MODEM_CTRL */ 2261da177e4SLinus Torvalds #define FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE 0x40 2271da177e4SLinus Torvalds #define FTDI_SIO_SET_MODEM_CTRL_REQUEST FTDI_SIO_MODEM_CTRL 2281da177e4SLinus Torvalds 2291da177e4SLinus Torvalds /* 2301da177e4SLinus Torvalds * BmRequestType: 0100 0000B 2311da177e4SLinus Torvalds * bRequest: FTDI_SIO_MODEM_CTRL 2321da177e4SLinus Torvalds * wValue: ControlValue (see below) 2331da177e4SLinus Torvalds * wIndex: Port 2341da177e4SLinus Torvalds * wLength: 0 2351da177e4SLinus Torvalds * Data: None 2361da177e4SLinus Torvalds * 2371da177e4SLinus Torvalds * NOTE: If the device is in RTS/CTS flow control, the RTS set by this 2381da177e4SLinus Torvalds * command will be IGNORED without an error being returned 2391da177e4SLinus Torvalds * Also - you can not set DTR and RTS with one control message 2401da177e4SLinus Torvalds */ 2411da177e4SLinus Torvalds 2421da177e4SLinus Torvalds #define FTDI_SIO_SET_DTR_MASK 0x1 243fb571101SMathieu OTHACEHE #define FTDI_SIO_SET_DTR_HIGH ((FTDI_SIO_SET_DTR_MASK << 8) | 1) 244fb571101SMathieu OTHACEHE #define FTDI_SIO_SET_DTR_LOW ((FTDI_SIO_SET_DTR_MASK << 8) | 0) 2451da177e4SLinus Torvalds #define FTDI_SIO_SET_RTS_MASK 0x2 246fb571101SMathieu OTHACEHE #define FTDI_SIO_SET_RTS_HIGH ((FTDI_SIO_SET_RTS_MASK << 8) | 2) 247fb571101SMathieu OTHACEHE #define FTDI_SIO_SET_RTS_LOW ((FTDI_SIO_SET_RTS_MASK << 8) | 0) 2481da177e4SLinus Torvalds 2491da177e4SLinus Torvalds /* 2501da177e4SLinus Torvalds * ControlValue 2511da177e4SLinus Torvalds * B0 DTR state 2521da177e4SLinus Torvalds * 0 = reset 2531da177e4SLinus Torvalds * 1 = set 2541da177e4SLinus Torvalds * B1 RTS state 2551da177e4SLinus Torvalds * 0 = reset 2561da177e4SLinus Torvalds * 1 = set 2571da177e4SLinus Torvalds * B2..7 Reserved 2581da177e4SLinus Torvalds * B8 DTR state enable 2591da177e4SLinus Torvalds * 0 = ignore 2601da177e4SLinus Torvalds * 1 = use DTR state 2611da177e4SLinus Torvalds * B9 RTS state enable 2621da177e4SLinus Torvalds * 0 = ignore 2631da177e4SLinus Torvalds * 1 = use RTS state 2641da177e4SLinus Torvalds * B10..15 Reserved 2651da177e4SLinus Torvalds */ 2661da177e4SLinus Torvalds 2671da177e4SLinus Torvalds /* FTDI_SIO_SET_FLOW_CTRL */ 2681da177e4SLinus Torvalds #define FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE 0x40 2691da177e4SLinus Torvalds #define FTDI_SIO_SET_FLOW_CTRL_REQUEST FTDI_SIO_SET_FLOW_CTRL 2701da177e4SLinus Torvalds #define FTDI_SIO_DISABLE_FLOW_CTRL 0x0 2711da177e4SLinus Torvalds #define FTDI_SIO_RTS_CTS_HS (0x1 << 8) 2721da177e4SLinus Torvalds #define FTDI_SIO_DTR_DSR_HS (0x2 << 8) 2731da177e4SLinus Torvalds #define FTDI_SIO_XON_XOFF_HS (0x4 << 8) 2741da177e4SLinus Torvalds /* 2751da177e4SLinus Torvalds * BmRequestType: 0100 0000b 2761da177e4SLinus Torvalds * bRequest: FTDI_SIO_SET_FLOW_CTRL 2771da177e4SLinus Torvalds * wValue: Xoff/Xon 2780a2a3775SAndreas Mohr * wIndex: Protocol/Port - hIndex is protocol / lIndex is port 2791da177e4SLinus Torvalds * wLength: 0 2801da177e4SLinus Torvalds * Data: None 2811da177e4SLinus Torvalds * 2821da177e4SLinus Torvalds * hIndex protocol is: 2831da177e4SLinus Torvalds * B0 Output handshaking using RTS/CTS 2841da177e4SLinus Torvalds * 0 = disabled 2851da177e4SLinus Torvalds * 1 = enabled 2861da177e4SLinus Torvalds * B1 Output handshaking using DTR/DSR 2871da177e4SLinus Torvalds * 0 = disabled 2881da177e4SLinus Torvalds * 1 = enabled 2891da177e4SLinus Torvalds * B2 Xon/Xoff handshaking 2901da177e4SLinus Torvalds * 0 = disabled 2911da177e4SLinus Torvalds * 1 = enabled 2921da177e4SLinus Torvalds * 2931da177e4SLinus Torvalds * A value of zero in the hIndex field disables handshaking 2941da177e4SLinus Torvalds * 2953bb36aa2SGreg Kroah-Hartman * If Xon/Xoff handshaking is specified, the hValue field should contain the 2963bb36aa2SGreg Kroah-Hartman * XOFF character and the lValue field contains the XON character. 2971da177e4SLinus Torvalds */ 2981da177e4SLinus Torvalds 2991da177e4SLinus Torvalds /* 3001da177e4SLinus Torvalds * FTDI_SIO_GET_LATENCY_TIMER 3011da177e4SLinus Torvalds * 3021da177e4SLinus Torvalds * Set the timeout interval. The FTDI collects data from the slave 3031da177e4SLinus Torvalds * device, transmitting it to the host when either A) 62 bytes are 3041da177e4SLinus Torvalds * received, or B) the timeout interval has elapsed and the buffer 3051da177e4SLinus Torvalds * contains at least 1 byte. Setting this value to a small number 3061da177e4SLinus Torvalds * can dramatically improve performance for applications which send 3071da177e4SLinus Torvalds * small packets, since the default value is 16ms. 3081da177e4SLinus Torvalds */ 3091da177e4SLinus Torvalds #define FTDI_SIO_GET_LATENCY_TIMER_REQUEST FTDI_SIO_GET_LATENCY_TIMER 3101da177e4SLinus Torvalds #define FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE 0xC0 3111da177e4SLinus Torvalds 3121da177e4SLinus Torvalds /* 3131da177e4SLinus Torvalds * BmRequestType: 1100 0000b 3141da177e4SLinus Torvalds * bRequest: FTDI_SIO_GET_LATENCY_TIMER 3151da177e4SLinus Torvalds * wValue: 0 3161da177e4SLinus Torvalds * wIndex: Port 3171da177e4SLinus Torvalds * wLength: 0 3181da177e4SLinus Torvalds * Data: latency (on return) 3191da177e4SLinus Torvalds */ 3201da177e4SLinus Torvalds 3211da177e4SLinus Torvalds /* 3221da177e4SLinus Torvalds * FTDI_SIO_SET_LATENCY_TIMER 3231da177e4SLinus Torvalds * 3241da177e4SLinus Torvalds * Set the timeout interval. The FTDI collects data from the slave 3251da177e4SLinus Torvalds * device, transmitting it to the host when either A) 62 bytes are 3261da177e4SLinus Torvalds * received, or B) the timeout interval has elapsed and the buffer 3271da177e4SLinus Torvalds * contains at least 1 byte. Setting this value to a small number 3281da177e4SLinus Torvalds * can dramatically improve performance for applications which send 3291da177e4SLinus Torvalds * small packets, since the default value is 16ms. 3301da177e4SLinus Torvalds */ 3311da177e4SLinus Torvalds #define FTDI_SIO_SET_LATENCY_TIMER_REQUEST FTDI_SIO_SET_LATENCY_TIMER 3321da177e4SLinus Torvalds #define FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE 0x40 3331da177e4SLinus Torvalds 3341da177e4SLinus Torvalds /* 3351da177e4SLinus Torvalds * BmRequestType: 0100 0000b 3361da177e4SLinus Torvalds * bRequest: FTDI_SIO_SET_LATENCY_TIMER 3371da177e4SLinus Torvalds * wValue: Latency (milliseconds) 3381da177e4SLinus Torvalds * wIndex: Port 3391da177e4SLinus Torvalds * wLength: 0 3401da177e4SLinus Torvalds * Data: None 3411da177e4SLinus Torvalds * 3421da177e4SLinus Torvalds * wValue: 3431da177e4SLinus Torvalds * B0..7 Latency timer 3441da177e4SLinus Torvalds * B8..15 0 3451da177e4SLinus Torvalds * 3461da177e4SLinus Torvalds */ 3471da177e4SLinus Torvalds 3481da177e4SLinus Torvalds /* 3491da177e4SLinus Torvalds * FTDI_SIO_SET_EVENT_CHAR 3501da177e4SLinus Torvalds * 3511da177e4SLinus Torvalds * Set the special event character for the specified communications port. 3521da177e4SLinus Torvalds * If the device sees this character it will immediately return the 3531da177e4SLinus Torvalds * data read so far - rather than wait 40ms or until 62 bytes are read 3541da177e4SLinus Torvalds * which is what normally happens. 3551da177e4SLinus Torvalds */ 3561da177e4SLinus Torvalds 3571da177e4SLinus Torvalds 3581da177e4SLinus Torvalds #define FTDI_SIO_SET_EVENT_CHAR_REQUEST FTDI_SIO_SET_EVENT_CHAR 3591da177e4SLinus Torvalds #define FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE 0x40 3601da177e4SLinus Torvalds 3611da177e4SLinus Torvalds 3621da177e4SLinus Torvalds /* 3631da177e4SLinus Torvalds * BmRequestType: 0100 0000b 3641da177e4SLinus Torvalds * bRequest: FTDI_SIO_SET_EVENT_CHAR 3651da177e4SLinus Torvalds * wValue: EventChar 3661da177e4SLinus Torvalds * wIndex: Port 3671da177e4SLinus Torvalds * wLength: 0 3681da177e4SLinus Torvalds * Data: None 3691da177e4SLinus Torvalds * 3701da177e4SLinus Torvalds * wValue: 3711da177e4SLinus Torvalds * B0..7 Event Character 3721da177e4SLinus Torvalds * B8 Event Character Processing 3731da177e4SLinus Torvalds * 0 = disabled 3741da177e4SLinus Torvalds * 1 = enabled 3751da177e4SLinus Torvalds * B9..15 Reserved 3761da177e4SLinus Torvalds * 3771da177e4SLinus Torvalds */ 3781da177e4SLinus Torvalds 3791da177e4SLinus Torvalds /* FTDI_SIO_SET_ERROR_CHAR */ 3801da177e4SLinus Torvalds 3813bb36aa2SGreg Kroah-Hartman /* 3823bb36aa2SGreg Kroah-Hartman * Set the parity error replacement character for the specified communications 3833bb36aa2SGreg Kroah-Hartman * port 3843bb36aa2SGreg Kroah-Hartman */ 3851da177e4SLinus Torvalds 3861da177e4SLinus Torvalds /* 3871da177e4SLinus Torvalds * BmRequestType: 0100 0000b 3881da177e4SLinus Torvalds * bRequest: FTDI_SIO_SET_EVENT_CHAR 3891da177e4SLinus Torvalds * wValue: Error Char 3901da177e4SLinus Torvalds * wIndex: Port 3911da177e4SLinus Torvalds * wLength: 0 3921da177e4SLinus Torvalds * Data: None 3931da177e4SLinus Torvalds * 3941da177e4SLinus Torvalds *Error Char 3951da177e4SLinus Torvalds * B0..7 Error Character 3961da177e4SLinus Torvalds * B8 Error Character Processing 3971da177e4SLinus Torvalds * 0 = disabled 3981da177e4SLinus Torvalds * 1 = enabled 3991da177e4SLinus Torvalds * B9..15 Reserved 4001da177e4SLinus Torvalds * 4011da177e4SLinus Torvalds */ 4021da177e4SLinus Torvalds 4031da177e4SLinus Torvalds /* FTDI_SIO_GET_MODEM_STATUS */ 4044a4efbdeSMatt Mackall /* Retrieve the current value of the modem status register */ 4051da177e4SLinus Torvalds 4061da177e4SLinus Torvalds #define FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE 0xc0 4071da177e4SLinus Torvalds #define FTDI_SIO_GET_MODEM_STATUS_REQUEST FTDI_SIO_GET_MODEM_STATUS 4081da177e4SLinus Torvalds #define FTDI_SIO_CTS_MASK 0x10 4091da177e4SLinus Torvalds #define FTDI_SIO_DSR_MASK 0x20 4101da177e4SLinus Torvalds #define FTDI_SIO_RI_MASK 0x40 4111da177e4SLinus Torvalds #define FTDI_SIO_RLSD_MASK 0x80 4121da177e4SLinus Torvalds /* 4131da177e4SLinus Torvalds * BmRequestType: 1100 0000b 4141da177e4SLinus Torvalds * bRequest: FTDI_SIO_GET_MODEM_STATUS 4151da177e4SLinus Torvalds * wValue: zero 4161da177e4SLinus Torvalds * wIndex: Port 4171da177e4SLinus Torvalds * wLength: 1 4181da177e4SLinus Torvalds * Data: Status 4191da177e4SLinus Torvalds * 4201da177e4SLinus Torvalds * One byte of data is returned 4211da177e4SLinus Torvalds * B0..3 0 4221da177e4SLinus Torvalds * B4 CTS 4231da177e4SLinus Torvalds * 0 = inactive 4241da177e4SLinus Torvalds * 1 = active 4251da177e4SLinus Torvalds * B5 DSR 4261da177e4SLinus Torvalds * 0 = inactive 4271da177e4SLinus Torvalds * 1 = active 4281da177e4SLinus Torvalds * B6 Ring Indicator (RI) 4291da177e4SLinus Torvalds * 0 = inactive 4301da177e4SLinus Torvalds * 1 = active 4311da177e4SLinus Torvalds * B7 Receive Line Signal Detect (RLSD) 4321da177e4SLinus Torvalds * 0 = inactive 4331da177e4SLinus Torvalds * 1 = active 4341da177e4SLinus Torvalds */ 4351da177e4SLinus Torvalds 4361da177e4SLinus Torvalds 4371da177e4SLinus Torvalds 4381da177e4SLinus Torvalds /* Descriptors returned by the device 4391da177e4SLinus Torvalds * 4401da177e4SLinus Torvalds * Device Descriptor 4411da177e4SLinus Torvalds * 4421da177e4SLinus Torvalds * Offset Field Size Value Description 4431da177e4SLinus Torvalds * 0 bLength 1 0x12 Size of descriptor in bytes 4441da177e4SLinus Torvalds * 1 bDescriptorType 1 0x01 DEVICE Descriptor Type 4451da177e4SLinus Torvalds * 2 bcdUSB 2 0x0110 USB Spec Release Number 4461da177e4SLinus Torvalds * 4 bDeviceClass 1 0x00 Class Code 4471da177e4SLinus Torvalds * 5 bDeviceSubClass 1 0x00 SubClass Code 4481da177e4SLinus Torvalds * 6 bDeviceProtocol 1 0x00 Protocol Code 4491da177e4SLinus Torvalds * 7 bMaxPacketSize0 1 0x08 Maximum packet size for endpoint 0 4501da177e4SLinus Torvalds * 8 idVendor 2 0x0403 Vendor ID 4511da177e4SLinus Torvalds * 10 idProduct 2 0x8372 Product ID (FTDI_SIO_PID) 4521da177e4SLinus Torvalds * 12 bcdDevice 2 0x0001 Device release number 4531da177e4SLinus Torvalds * 14 iManufacturer 1 0x01 Index of man. string desc 4541da177e4SLinus Torvalds * 15 iProduct 1 0x02 Index of prod string desc 4551da177e4SLinus Torvalds * 16 iSerialNumber 1 0x02 Index of serial nmr string desc 4561da177e4SLinus Torvalds * 17 bNumConfigurations 1 0x01 Number of possible configurations 4571da177e4SLinus Torvalds * 4581da177e4SLinus Torvalds * Configuration Descriptor 4591da177e4SLinus Torvalds * 4601da177e4SLinus Torvalds * Offset Field Size Value 4611da177e4SLinus Torvalds * 0 bLength 1 0x09 Size of descriptor in bytes 4621da177e4SLinus Torvalds * 1 bDescriptorType 1 0x02 CONFIGURATION Descriptor Type 4631da177e4SLinus Torvalds * 2 wTotalLength 2 0x0020 Total length of data 4641da177e4SLinus Torvalds * 4 bNumInterfaces 1 0x01 Number of interfaces supported 4651da177e4SLinus Torvalds * 5 bConfigurationValue 1 0x01 Argument for SetCOnfiguration() req 4661da177e4SLinus Torvalds * 6 iConfiguration 1 0x02 Index of config string descriptor 4671da177e4SLinus Torvalds * 7 bmAttributes 1 0x20 Config characteristics Remote Wakeup 4681da177e4SLinus Torvalds * 8 MaxPower 1 0x1E Max power consumption 4691da177e4SLinus Torvalds * 4701da177e4SLinus Torvalds * Interface Descriptor 4711da177e4SLinus Torvalds * 4721da177e4SLinus Torvalds * Offset Field Size Value 4731da177e4SLinus Torvalds * 0 bLength 1 0x09 Size of descriptor in bytes 4741da177e4SLinus Torvalds * 1 bDescriptorType 1 0x04 INTERFACE Descriptor Type 4751da177e4SLinus Torvalds * 2 bInterfaceNumber 1 0x00 Number of interface 4761da177e4SLinus Torvalds * 3 bAlternateSetting 1 0x00 Value used to select alternate 4771da177e4SLinus Torvalds * 4 bNumEndpoints 1 0x02 Number of endpoints 4781da177e4SLinus Torvalds * 5 bInterfaceClass 1 0xFF Class Code 4791da177e4SLinus Torvalds * 6 bInterfaceSubClass 1 0xFF Subclass Code 4801da177e4SLinus Torvalds * 7 bInterfaceProtocol 1 0xFF Protocol Code 4811da177e4SLinus Torvalds * 8 iInterface 1 0x02 Index of interface string description 4821da177e4SLinus Torvalds * 4831da177e4SLinus Torvalds * IN Endpoint Descriptor 4841da177e4SLinus Torvalds * 4851da177e4SLinus Torvalds * Offset Field Size Value 4861da177e4SLinus Torvalds * 0 bLength 1 0x07 Size of descriptor in bytes 4871da177e4SLinus Torvalds * 1 bDescriptorType 1 0x05 ENDPOINT descriptor type 4881da177e4SLinus Torvalds * 2 bEndpointAddress 1 0x82 Address of endpoint 4891da177e4SLinus Torvalds * 3 bmAttributes 1 0x02 Endpoint attributes - Bulk 4901da177e4SLinus Torvalds * 4 bNumEndpoints 2 0x0040 maximum packet size 4911da177e4SLinus Torvalds * 5 bInterval 1 0x00 Interval for polling endpoint 4921da177e4SLinus Torvalds * 4931da177e4SLinus Torvalds * OUT Endpoint Descriptor 4941da177e4SLinus Torvalds * 4951da177e4SLinus Torvalds * Offset Field Size Value 4961da177e4SLinus Torvalds * 0 bLength 1 0x07 Size of descriptor in bytes 4971da177e4SLinus Torvalds * 1 bDescriptorType 1 0x05 ENDPOINT descriptor type 4981da177e4SLinus Torvalds * 2 bEndpointAddress 1 0x02 Address of endpoint 4991da177e4SLinus Torvalds * 3 bmAttributes 1 0x02 Endpoint attributes - Bulk 5001da177e4SLinus Torvalds * 4 bNumEndpoints 2 0x0040 maximum packet size 5011da177e4SLinus Torvalds * 5 bInterval 1 0x00 Interval for polling endpoint 5021da177e4SLinus Torvalds * 5031da177e4SLinus Torvalds * DATA FORMAT 5041da177e4SLinus Torvalds * 5051da177e4SLinus Torvalds * IN Endpoint 5061da177e4SLinus Torvalds * 5073bb36aa2SGreg Kroah-Hartman * The device reserves the first two bytes of data on this endpoint to contain 5083bb36aa2SGreg Kroah-Hartman * the current values of the modem and line status registers. In the absence of 5093bb36aa2SGreg Kroah-Hartman * data, the device generates a message consisting of these two status bytes 5103bb36aa2SGreg Kroah-Hartman * every 40 ms 5111da177e4SLinus Torvalds * 5121da177e4SLinus Torvalds * Byte 0: Modem Status 5131da177e4SLinus Torvalds * 5141da177e4SLinus Torvalds * Offset Description 5151da177e4SLinus Torvalds * B0 Reserved - must be 1 5161da177e4SLinus Torvalds * B1 Reserved - must be 0 5171da177e4SLinus Torvalds * B2 Reserved - must be 0 5181da177e4SLinus Torvalds * B3 Reserved - must be 0 5191da177e4SLinus Torvalds * B4 Clear to Send (CTS) 5201da177e4SLinus Torvalds * B5 Data Set Ready (DSR) 5211da177e4SLinus Torvalds * B6 Ring Indicator (RI) 5221da177e4SLinus Torvalds * B7 Receive Line Signal Detect (RLSD) 5231da177e4SLinus Torvalds * 5241da177e4SLinus Torvalds * Byte 1: Line Status 5251da177e4SLinus Torvalds * 5261da177e4SLinus Torvalds * Offset Description 5271da177e4SLinus Torvalds * B0 Data Ready (DR) 5281da177e4SLinus Torvalds * B1 Overrun Error (OE) 5291da177e4SLinus Torvalds * B2 Parity Error (PE) 5301da177e4SLinus Torvalds * B3 Framing Error (FE) 5311da177e4SLinus Torvalds * B4 Break Interrupt (BI) 5321da177e4SLinus Torvalds * B5 Transmitter Holding Register (THRE) 5331da177e4SLinus Torvalds * B6 Transmitter Empty (TEMT) 5341da177e4SLinus Torvalds * B7 Error in RCVR FIFO 5351da177e4SLinus Torvalds * 5361da177e4SLinus Torvalds */ 5371da177e4SLinus Torvalds #define FTDI_RS0_CTS (1 << 4) 5381da177e4SLinus Torvalds #define FTDI_RS0_DSR (1 << 5) 5391da177e4SLinus Torvalds #define FTDI_RS0_RI (1 << 6) 5401da177e4SLinus Torvalds #define FTDI_RS0_RLSD (1 << 7) 5411da177e4SLinus Torvalds 5421da177e4SLinus Torvalds #define FTDI_RS_DR 1 5431da177e4SLinus Torvalds #define FTDI_RS_OE (1<<1) 5441da177e4SLinus Torvalds #define FTDI_RS_PE (1<<2) 5451da177e4SLinus Torvalds #define FTDI_RS_FE (1<<3) 5461da177e4SLinus Torvalds #define FTDI_RS_BI (1<<4) 5471da177e4SLinus Torvalds #define FTDI_RS_THRE (1<<5) 5481da177e4SLinus Torvalds #define FTDI_RS_TEMT (1<<6) 5491da177e4SLinus Torvalds #define FTDI_RS_FIFO (1<<7) 5501da177e4SLinus Torvalds 5511da177e4SLinus Torvalds /* 5521da177e4SLinus Torvalds * OUT Endpoint 5531da177e4SLinus Torvalds * 5543bb36aa2SGreg Kroah-Hartman * This device reserves the first bytes of data on this endpoint contain the 5553bb36aa2SGreg Kroah-Hartman * length and port identifier of the message. For the FTDI USB Serial converter 5563bb36aa2SGreg Kroah-Hartman * the port identifier is always 1. 5571da177e4SLinus Torvalds * 5581da177e4SLinus Torvalds * Byte 0: Line Status 5591da177e4SLinus Torvalds * 5601da177e4SLinus Torvalds * Offset Description 5611da177e4SLinus Torvalds * B0 Reserved - must be 1 5621da177e4SLinus Torvalds * B1 Reserved - must be 0 5631da177e4SLinus Torvalds * B2..7 Length of message - (not including Byte 0) 5641da177e4SLinus Torvalds * 5651da177e4SLinus Torvalds */ 566