2 * Definitions for the FTDI USB Single Port Serial Converter -
3 * known as FTDI_SIO (Serial Input/Output application of the chipset)
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!
10 * The device is based on the FTDI FT8U100AX chip. It has a DB25 on one side,
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
17 * Bill Ryder - bryder@sgi.com formerly of Silicon Graphics, Inc.- wrote the
18 * FTDI_SIO implementation.
20 * Philipp Gühring - pg@futureware.at - added the Device ID of the USB relais
25 #define FTDI_VID 0x0403 /* Vendor Id */
26 #define FTDI_SIO_PID 0x8372 /* Product Id SIO application of 8U100AX */
27 #define FTDI_8U232AM_PID 0x6001 /* Similar device to SIO above */
28 #define FTDI_8U232AM_ALT_PID 0x6006 /* FTDI's alternate PID for above */
29 #define FTDI_RELAIS_PID 0xFA10 /* Relais device from Rudolf Gugler */
30 #define FTDI_NF_RIC_VID 0x0DCD /* Vendor Id */
31 #define FTDI_NF_RIC_PID 0x0001 /* Product Id */
33 /* www.irtrans.de device */
34 #define FTDI_IRTRANS_PID 0xFC60 /* Product Id */
36 /* www.crystalfontz.com devices - thanx for providing free devices for evaluation ! */
37 /* they use the ftdi chipset for the USB interface and the vendor id is the same */
38 #define FTDI_XF_632_PID 0xFC08 /* 632: 16x2 Character Display */
39 #define FTDI_XF_634_PID 0xFC09 /* 634: 20x4 Character Display */
40 #define FTDI_XF_547_PID 0xFC0A /* 547: Two line Display */
41 #define FTDI_XF_633_PID 0xFC0B /* 633: 16x2 Character Display with Keys */
42 #define FTDI_XF_631_PID 0xFC0C /* 631: 20x2 Character Display */
43 #define FTDI_XF_635_PID 0xFC0D /* 635: 20x4 Character Display */
44 #define FTDI_XF_640_PID 0xFC0E /* 640: Two line Display */
45 #define FTDI_XF_642_PID 0xFC0F /* 642: Two line Display */
47 /* Video Networks Limited / Homechoice in the UK use an ftdi-based device for their 1Mb */
48 /* broadband internet service. The following PID is exhibited by the usb device supplied */
49 /* (the VID is the standard ftdi vid (FTDI_VID) */
50 #define FTDI_VNHCPCUSB_D_PID 0xfe38 /* Product Id */
53 * The following are the values for the Matrix Orbital LCD displays,
54 * which are the FT232BM ( similar to the 8U232AM )
56 #define FTDI_MTXORB_0_PID 0xFA00 /* Matrix Orbital Product Id */
57 #define FTDI_MTXORB_1_PID 0xFA01 /* Matrix Orbital Product Id */
58 #define FTDI_MTXORB_2_PID 0xFA02 /* Matrix Orbital Product Id */
59 #define FTDI_MTXORB_3_PID 0xFA03 /* Matrix Orbital Product Id */
60 #define FTDI_MTXORB_4_PID 0xFA04 /* Matrix Orbital Product Id */
61 #define FTDI_MTXORB_5_PID 0xFA05 /* Matrix Orbital Product Id */
62 #define FTDI_MTXORB_6_PID 0xFA06 /* Matrix Orbital Product Id */
64 /* Interbiometrics USB I/O Board */
65 /* Developed for Interbiometrics by Rudolf Gugler */
66 #define INTERBIOMETRICS_VID 0x1209
67 #define INTERBIOMETRICS_IOBOARD_PID 0x1002
68 #define INTERBIOMETRICS_MINI_IOBOARD_PID 0x1006
71 * The following are the values for the Perle Systems
72 * UltraPort USB serial converters
74 #define FTDI_PERLE_ULTRAPORT_PID 0xF0C0 /* Perle UltraPort Product Id */
77 * The following are the values for the Sealevel SeaLINK+ adapters.
78 * (Original list sent by Tuan Hoang. Ian Abbott renamed the macros and
79 * removed some PIDs that don't seem to match any existing products.)
81 #define SEALEVEL_VID 0x0c52 /* Sealevel Vendor ID */
82 #define SEALEVEL_2101_PID 0x2101 /* SeaLINK+232 (2101/2105) */
83 #define SEALEVEL_2102_PID 0x2102 /* SeaLINK+485 (2102) */
84 #define SEALEVEL_2103_PID 0x2103 /* SeaLINK+232I (2103) */
85 #define SEALEVEL_2104_PID 0x2104 /* SeaLINK+485I (2104) */
86 #define SEALEVEL_2201_1_PID 0x2211 /* SeaPORT+2/232 (2201) Port 1 */
87 #define SEALEVEL_2201_2_PID 0x2221 /* SeaPORT+2/232 (2201) Port 2 */
88 #define SEALEVEL_2202_1_PID 0x2212 /* SeaPORT+2/485 (2202) Port 1 */
89 #define SEALEVEL_2202_2_PID 0x2222 /* SeaPORT+2/485 (2202) Port 2 */
90 #define SEALEVEL_2203_1_PID 0x2213 /* SeaPORT+2 (2203) Port 1 */
91 #define SEALEVEL_2203_2_PID 0x2223 /* SeaPORT+2 (2203) Port 2 */
92 #define SEALEVEL_2401_1_PID 0x2411 /* SeaPORT+4/232 (2401) Port 1 */
93 #define SEALEVEL_2401_2_PID 0x2421 /* SeaPORT+4/232 (2401) Port 2 */
94 #define SEALEVEL_2401_3_PID 0x2431 /* SeaPORT+4/232 (2401) Port 3 */
95 #define SEALEVEL_2401_4_PID 0x2441 /* SeaPORT+4/232 (2401) Port 4 */
96 #define SEALEVEL_2402_1_PID 0x2412 /* SeaPORT+4/485 (2402) Port 1 */
97 #define SEALEVEL_2402_2_PID 0x2422 /* SeaPORT+4/485 (2402) Port 2 */
98 #define SEALEVEL_2402_3_PID 0x2432 /* SeaPORT+4/485 (2402) Port 3 */
99 #define SEALEVEL_2402_4_PID 0x2442 /* SeaPORT+4/485 (2402) Port 4 */
100 #define SEALEVEL_2403_1_PID 0x2413 /* SeaPORT+4 (2403) Port 1 */
101 #define SEALEVEL_2403_2_PID 0x2423 /* SeaPORT+4 (2403) Port 2 */
102 #define SEALEVEL_2403_3_PID 0x2433 /* SeaPORT+4 (2403) Port 3 */
103 #define SEALEVEL_2403_4_PID 0x2443 /* SeaPORT+4 (2403) Port 4 */
104 #define SEALEVEL_2801_1_PID 0X2811 /* SeaLINK+8/232 (2801) Port 1 */
105 #define SEALEVEL_2801_2_PID 0X2821 /* SeaLINK+8/232 (2801) Port 2 */
106 #define SEALEVEL_2801_3_PID 0X2831 /* SeaLINK+8/232 (2801) Port 3 */
107 #define SEALEVEL_2801_4_PID 0X2841 /* SeaLINK+8/232 (2801) Port 4 */
108 #define SEALEVEL_2801_5_PID 0X2851 /* SeaLINK+8/232 (2801) Port 5 */
109 #define SEALEVEL_2801_6_PID 0X2861 /* SeaLINK+8/232 (2801) Port 6 */
110 #define SEALEVEL_2801_7_PID 0X2871 /* SeaLINK+8/232 (2801) Port 7 */
111 #define SEALEVEL_2801_8_PID 0X2881 /* SeaLINK+8/232 (2801) Port 8 */
112 #define SEALEVEL_2802_1_PID 0X2812 /* SeaLINK+8/485 (2802) Port 1 */
113 #define SEALEVEL_2802_2_PID 0X2822 /* SeaLINK+8/485 (2802) Port 2 */
114 #define SEALEVEL_2802_3_PID 0X2832 /* SeaLINK+8/485 (2802) Port 3 */
115 #define SEALEVEL_2802_4_PID 0X2842 /* SeaLINK+8/485 (2802) Port 4 */
116 #define SEALEVEL_2802_5_PID 0X2852 /* SeaLINK+8/485 (2802) Port 5 */
117 #define SEALEVEL_2802_6_PID 0X2862 /* SeaLINK+8/485 (2802) Port 6 */
118 #define SEALEVEL_2802_7_PID 0X2872 /* SeaLINK+8/485 (2802) Port 7 */
119 #define SEALEVEL_2802_8_PID 0X2882 /* SeaLINK+8/485 (2802) Port 8 */
120 #define SEALEVEL_2803_1_PID 0X2813 /* SeaLINK+8 (2803) Port 1 */
121 #define SEALEVEL_2803_2_PID 0X2823 /* SeaLINK+8 (2803) Port 2 */
122 #define SEALEVEL_2803_3_PID 0X2833 /* SeaLINK+8 (2803) Port 3 */
123 #define SEALEVEL_2803_4_PID 0X2843 /* SeaLINK+8 (2803) Port 4 */
124 #define SEALEVEL_2803_5_PID 0X2853 /* SeaLINK+8 (2803) Port 5 */
125 #define SEALEVEL_2803_6_PID 0X2863 /* SeaLINK+8 (2803) Port 6 */
126 #define SEALEVEL_2803_7_PID 0X2873 /* SeaLINK+8 (2803) Port 7 */
127 #define SEALEVEL_2803_8_PID 0X2883 /* SeaLINK+8 (2803) Port 8 */
130 * DSS-20 Sync Station for Sony Ericsson P800
133 #define FTDI_DSS20_PID 0xFC82
136 * Home Electronics (www.home-electro.com) USB gadgets
138 #define FTDI_HE_TIRA1_PID 0xFA78 /* Tira-1 IR tranceiver */
140 /* USB-UIRT - An infrared receiver and transmitter using the 8U232AM chip */
141 /* http://home.earthlink.net/~jrhees/USBUIRT/index.htm */
142 #define FTDI_USB_UIRT_PID 0xF850 /* Product Id */
144 /* ELV USB Module UO100 (PID sent by Stefan Frings) */
145 #define FTDI_ELV_UO100_PID 0xFB58 /* Product Id */
148 * Definitions for ID TECH (www.idt-net.com) devices
150 #define IDTECH_VID 0x0ACD /* ID TECH Vendor ID */
151 #define IDTECH_IDT1221U_PID 0x0300 /* IDT1221U USB to RS-232 adapter */
154 * Definitions for Omnidirectional Control Technology, Inc. devices
156 #define OCT_VID 0x0B39 /* OCT vendor ID */
157 /* Note: OCT US101 is also rebadged as Dick Smith Electronics (NZ) XH6381 */
158 /* Also rebadged as SIIG Inc. model US2308 */
159 #define OCT_US101_PID 0x0421 /* OCT US101 USB to RS-232 */
161 /* an infrared receiver for user access control with IR tags */
162 #define FTDI_PIEGROUP_PID 0xF208 /* Product Id */
165 * Protego product ids
167 #define PROTEGO_SPECIAL_1 0xFC70 /* special/unknown device */
168 #define PROTEGO_R2X0 0xFC71 /* R200-USB TRNG unit (R210, R220, and R230) */
169 #define PROTEGO_SPECIAL_3 0xFC72 /* special/unknown device */
170 #define PROTEGO_SPECIAL_4 0xFC73 /* special/unknown device */
173 * Gude Analog- und Digitalsysteme GmbH
175 #define FTDI_GUDEADS_E808_PID 0xE808
176 #define FTDI_GUDEADS_E809_PID 0xE809
177 #define FTDI_GUDEADS_E80A_PID 0xE80A
178 #define FTDI_GUDEADS_E80B_PID 0xE80B
179 #define FTDI_GUDEADS_E80C_PID 0xE80C
180 #define FTDI_GUDEADS_E80D_PID 0xE80D
181 #define FTDI_GUDEADS_E80E_PID 0xE80E
182 #define FTDI_GUDEADS_E80F_PID 0xE80F
183 #define FTDI_GUDEADS_E888_PID 0xE888 /* Expert ISDN Control USB */
184 #define FTDI_GUDEADS_E889_PID 0xE889 /* USB RS-232 OptoBridge */
185 #define FTDI_GUDEADS_E88A_PID 0xE88A
186 #define FTDI_GUDEADS_E88B_PID 0xE88B
187 #define FTDI_GUDEADS_E88C_PID 0xE88C
188 #define FTDI_GUDEADS_E88D_PID 0xE88D
189 #define FTDI_GUDEADS_E88E_PID 0xE88E
190 #define FTDI_GUDEADS_E88F_PID 0xE88F
193 * Linx Technologies product ids
195 #define LINX_SDMUSBQSS_PID 0xF448 /* Linx SDM-USB-QS-S */
196 #define LINX_MASTERDEVEL2_PID 0xF449 /* Linx Master Development 2.0 */
197 #define LINX_FUTURE_0_PID 0xF44A /* Linx future device */
198 #define LINX_FUTURE_1_PID 0xF44B /* Linx future device */
199 #define LINX_FUTURE_2_PID 0xF44C /* Linx future device */
201 /* CCS Inc. ICDU/ICDU40 product ID - the FT232BM is used in an in-circuit-debugger */
202 /* unit for PIC16's/PIC18's */
203 #define FTDI_CCSICDU20_0_PID 0xF9D0
204 #define FTDI_CCSICDU40_1_PID 0xF9D1
206 /* Inside Accesso contactless reader (http://www.insidefr.com) */
207 #define INSIDE_ACCESSO 0xFAD0
210 * Intrepid Control Systems (http://www.intrepidcs.com/) ValueCAN and NeoVI
212 #define INTREPID_VID 0x093C
213 #define INTREPID_VALUECAN_PID 0x0601
214 #define INTREPID_NEOVI_PID 0x0701
217 * Falcom Wireless Communications GmbH
219 #define FALCOM_VID 0x0F94 /* Vendor Id */
220 #define FALCOM_TWIST_PID 0x0001 /* Falcom Twist USB GPRS modem */
225 #define FTDI_SUUNTO_SPORTS_PID 0xF680 /* Suunto Sports instrument */
228 #define FTDI_SIO_RESET 0 /* Reset the port */
229 #define FTDI_SIO_MODEM_CTRL 1 /* Set the modem control register */
230 #define FTDI_SIO_SET_FLOW_CTRL 2 /* Set flow control register */
231 #define FTDI_SIO_SET_BAUD_RATE 3 /* Set baud rate */
232 #define FTDI_SIO_SET_DATA 4 /* Set the data characteristics of the port */
233 #define FTDI_SIO_GET_MODEM_STATUS 5 /* Retrieve current value of modern status register */
234 #define FTDI_SIO_SET_EVENT_CHAR 6 /* Set the event character */
235 #define FTDI_SIO_SET_ERROR_CHAR 7 /* Set the error character */
237 /* Port Identifier Table */
238 #define PIT_DEFAULT 0 /* SIOA */
239 #define PIT_SIOA 1 /* SIOA */
240 /* The device this driver is tested with one has only one port */
241 #define PIT_SIOB 2 /* SIOB */
242 #define PIT_PARALLEL 3 /* Parallel */
245 #define FTDI_SIO_RESET_REQUEST FTDI_SIO_RESET
246 #define FTDI_SIO_RESET_REQUEST_TYPE 0x40
247 #define FTDI_SIO_RESET_SIO 0
248 #define FTDI_SIO_RESET_PURGE_RX 1
249 #define FTDI_SIO_RESET_PURGE_TX 2
252 * BmRequestType: 0100 0000B
253 * bRequest: FTDI_SIO_RESET
254 * wValue: Control Value
256 * 1 = Purge RX buffer
257 * 2 = Purge TX buffer
262 * The Reset SIO command has this effect:
264 * Sets flow control set to 'none'
266 * Event trigger = disabled
271 * baud and data format not reset
273 * The Purge RX and TX buffer commands affect nothing except the buffers
277 /* FTDI_SIO_SET_BAUDRATE */
278 #define FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE 0x40
279 #define FTDI_SIO_SET_BAUDRATE_REQUEST 3
282 * BmRequestType: 0100 0000B
283 * bRequest: FTDI_SIO_SET_BAUDRATE
284 * wValue: BaudDivisor value - see below
288 * The BaudDivisor values are calculated as follows:
289 * - BaseClock is either 12000000 or 48000000 depending on the device. FIXME: I wish
290 * I knew how to detect old chips to select proper base clock!
291 * - BaudDivisor is a fixed point number encoded in a funny way.
292 * (--WRONG WAY OF THINKING--)
293 * BaudDivisor is a fixed point number encoded with following bit weighs:
294 * (-2)(-1)(13..0). It is a radical with a denominator of 4, so values
295 * end with 0.0 (00...), 0.25 (10...), 0.5 (01...), and 0.75 (11...).
297 * The both-bits-set has quite different meaning from 0.75 - the chip designers
298 * have decided it to mean 0.125 instead of 0.75.
299 * This info looked up in FTDI application note "FT8U232 DEVICES \ Data Rates
300 * and Flow Control Consideration for USB to RS232".
301 * - BaudDivisor = (BaseClock / 16) / BaudRate, where the (=) operation should
302 * automagically re-encode the resulting value to take fractions into consideration.
303 * As all values are integers, some bit twiddling is in order:
304 * BaudDivisor = (BaseClock / 16 / BaudRate) |
305 * (((BaseClock / 2 / BaudRate) & 4) ? 0x4000 // 0.5
306 * : ((BaseClock / 2 / BaudRate) & 2) ? 0x8000 // 0.25
307 * : ((BaseClock / 2 / BaudRate) & 1) ? 0xc000 // 0.125
310 * For the FT232BM, a 17th divisor bit was introduced to encode the multiples
311 * of 0.125 missing from the FT8U232AM. Bits 16 to 14 are coded as follows
312 * (the first four codes are the same as for the FT8U232AM, where bit 16 is
314 * 000 - add .000 to divisor
315 * 001 - add .500 to divisor
316 * 010 - add .250 to divisor
317 * 011 - add .125 to divisor
318 * 100 - add .375 to divisor
319 * 101 - add .625 to divisor
320 * 110 - add .750 to divisor
321 * 111 - add .875 to divisor
322 * Bits 15 to 0 of the 17-bit divisor are placed in the urb value. Bit 16 is
323 * placed in bit 0 of the urb index.
325 * Note that there are a couple of special cases to support the highest baud
326 * rates. If the calculated divisor value is 1, this needs to be replaced with
327 * 0. Additionally for the FT232BM, if the calculated divisor value is 0x4001
328 * (1.5), this needs to be replaced with 0x0001 (1) (but this divisor value is
329 * not supported by the FT8U232AM).
349 } FTDI_SIO_baudrate_t ;
352 * The ftdi_8U232AM_xxMHz_byyy constants have been removed. The encoded divisor values
353 * are calculated internally.
356 #define FTDI_SIO_SET_DATA_REQUEST FTDI_SIO_SET_DATA
357 #define FTDI_SIO_SET_DATA_REQUEST_TYPE 0x40
358 #define FTDI_SIO_SET_DATA_PARITY_NONE (0x0 << 8 )
359 #define FTDI_SIO_SET_DATA_PARITY_ODD (0x1 << 8 )
360 #define FTDI_SIO_SET_DATA_PARITY_EVEN (0x2 << 8 )
361 #define FTDI_SIO_SET_DATA_PARITY_MARK (0x3 << 8 )
362 #define FTDI_SIO_SET_DATA_PARITY_SPACE (0x4 << 8 )
363 #define FTDI_SIO_SET_DATA_STOP_BITS_1 (0x0 << 11 )
364 #define FTDI_SIO_SET_DATA_STOP_BITS_15 (0x1 << 11 )
365 #define FTDI_SIO_SET_DATA_STOP_BITS_2 (0x2 << 11 )
366 #define FTDI_SIO_SET_BREAK (0x1 << 14)
367 /* FTDI_SIO_SET_DATA */
370 * BmRequestType: 0100 0000B
371 * bRequest: FTDI_SIO_SET_DATA
372 * wValue: Data characteristics (see below)
377 * Data characteristics
379 * B0..7 Number of data bits
392 * 0 = TX OFF (normal state)
399 /* FTDI_SIO_MODEM_CTRL */
400 #define FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE 0x40
401 #define FTDI_SIO_SET_MODEM_CTRL_REQUEST FTDI_SIO_MODEM_CTRL
404 * BmRequestType: 0100 0000B
405 * bRequest: FTDI_SIO_MODEM_CTRL
406 * wValue: ControlValue (see below)
411 * NOTE: If the device is in RTS/CTS flow control, the RTS set by this
412 * command will be IGNORED without an error being returned
413 * Also - you can not set DTR and RTS with one control message
416 #define FTDI_SIO_SET_DTR_MASK 0x1
417 #define FTDI_SIO_SET_DTR_HIGH ( 1 | ( FTDI_SIO_SET_DTR_MASK << 8))
418 #define FTDI_SIO_SET_DTR_LOW ( 0 | ( FTDI_SIO_SET_DTR_MASK << 8))
419 #define FTDI_SIO_SET_RTS_MASK 0x2
420 #define FTDI_SIO_SET_RTS_HIGH ( 2 | ( FTDI_SIO_SET_RTS_MASK << 8 ))
421 #define FTDI_SIO_SET_RTS_LOW ( 0 | ( FTDI_SIO_SET_RTS_MASK << 8 ))
432 * B8 DTR state enable
435 * B9 RTS state enable
441 /* FTDI_SIO_SET_FLOW_CTRL */
442 #define FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE 0x40
443 #define FTDI_SIO_SET_FLOW_CTRL_REQUEST FTDI_SIO_SET_FLOW_CTRL
444 #define FTDI_SIO_DISABLE_FLOW_CTRL 0x0
445 #define FTDI_SIO_RTS_CTS_HS (0x1 << 8)
446 #define FTDI_SIO_DTR_DSR_HS (0x2 << 8)
447 #define FTDI_SIO_XON_XOFF_HS (0x4 << 8)
449 * BmRequestType: 0100 0000b
450 * bRequest: FTDI_SIO_SET_FLOW_CTRL
452 * wIndex: Protocol/Port - hIndex is protocl / lIndex is port
456 * hIndex protocol is:
457 * B0 Output handshaking using RTS/CTS
460 * B1 Output handshaking using DTR/DSR
463 * B2 Xon/Xoff handshaking
467 * A value of zero in the hIndex field disables handshaking
469 * If Xon/Xoff handshaking is specified, the hValue field should contain the XOFF character
470 * and the lValue field contains the XON character.
474 * FTDI_SIO_SET_EVENT_CHAR
476 * Set the special event character for the specified communications port.
477 * If the device sees this character it will immediately return the
478 * data read so far - rather than wait 40ms or until 62 bytes are read
479 * which is what normally happens.
483 #define FTDI_SIO_SET_EVENT_CHAR_REQUEST FTDI_SIO_SET_EVENT_CHAR
484 #define FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE 0x40
488 * BmRequestType: 0100 0000b
489 * bRequest: FTDI_SIO_SET_EVENT_CHAR
496 * B0..7 Event Character
497 * B8 Event Character Processing
504 /* FTDI_SIO_SET_ERROR_CHAR */
506 /* Set the parity error replacement character for the specified communications port */
509 * BmRequestType: 0100 0000b
510 * bRequest: FTDI_SIO_SET_EVENT_CHAR
517 * B0..7 Error Character
518 * B8 Error Character Processing
525 /* FTDI_SIO_GET_MODEM_STATUS */
526 /* Retreive the current value of the modem status register */
528 #define FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE 0xc0
529 #define FTDI_SIO_GET_MODEM_STATUS_REQUEST FTDI_SIO_GET_MODEM_STATUS
530 #define FTDI_SIO_CTS_MASK 0x10
531 #define FTDI_SIO_DSR_MASK 0x20
532 #define FTDI_SIO_RI_MASK 0x40
533 #define FTDI_SIO_RLSD_MASK 0x80
535 * BmRequestType: 1100 0000b
536 * bRequest: FTDI_SIO_GET_MODEM_STATUS
542 * One byte of data is returned
550 * B6 Ring Indicator (RI)
553 * B7 Receive Line Signal Detect (RLSD)
560 /* Descriptors returned by the device
564 * Offset Field Size Value Description
565 * 0 bLength 1 0x12 Size of descriptor in bytes
566 * 1 bDescriptorType 1 0x01 DEVICE Descriptor Type
567 * 2 bcdUSB 2 0x0110 USB Spec Release Number
568 * 4 bDeviceClass 1 0x00 Class Code
569 * 5 bDeviceSubClass 1 0x00 SubClass Code
570 * 6 bDeviceProtocol 1 0x00 Protocol Code
571 * 7 bMaxPacketSize0 1 0x08 Maximum packet size for endpoint 0
572 * 8 idVendor 2 0x0403 Vendor ID
573 * 10 idProduct 2 0x8372 Product ID (FTDI_SIO_PID)
574 * 12 bcdDevice 2 0x0001 Device release number
575 * 14 iManufacturer 1 0x01 Index of man. string desc
576 * 15 iProduct 1 0x02 Index of prod string desc
577 * 16 iSerialNumber 1 0x02 Index of serial nmr string desc
578 * 17 bNumConfigurations 1 0x01 Number of possible configurations
580 * Configuration Descriptor
582 * Offset Field Size Value
583 * 0 bLength 1 0x09 Size of descriptor in bytes
584 * 1 bDescriptorType 1 0x02 CONFIGURATION Descriptor Type
585 * 2 wTotalLength 2 0x0020 Total length of data
586 * 4 bNumInterfaces 1 0x01 Number of interfaces supported
587 * 5 bConfigurationValue 1 0x01 Argument for SetCOnfiguration() req
588 * 6 iConfiguration 1 0x02 Index of config string descriptor
589 * 7 bmAttributes 1 0x20 Config characteristics Remote Wakeup
590 * 8 MaxPower 1 0x1E Max power consumption
592 * Interface Descriptor
594 * Offset Field Size Value
595 * 0 bLength 1 0x09 Size of descriptor in bytes
596 * 1 bDescriptorType 1 0x04 INTERFACE Descriptor Type
597 * 2 bInterfaceNumber 1 0x00 Number of interface
598 * 3 bAlternateSetting 1 0x00 Value used to select alternate
599 * 4 bNumEndpoints 1 0x02 Number of endpoints
600 * 5 bInterfaceClass 1 0xFF Class Code
601 * 6 bInterfaceSubClass 1 0xFF Subclass Code
602 * 7 bInterfaceProtocol 1 0xFF Protocol Code
603 * 8 iInterface 1 0x02 Index of interface string description
605 * IN Endpoint Descriptor
607 * Offset Field Size Value
608 * 0 bLength 1 0x07 Size of descriptor in bytes
609 * 1 bDescriptorType 1 0x05 ENDPOINT descriptor type
610 * 2 bEndpointAddress 1 0x82 Address of endpoint
611 * 3 bmAttributes 1 0x02 Endpoint attributes - Bulk
612 * 4 bNumEndpoints 2 0x0040 maximum packet size
613 * 5 bInterval 1 0x00 Interval for polling endpoint
615 * OUT Endpoint Descriptor
617 * Offset Field Size Value
618 * 0 bLength 1 0x07 Size of descriptor in bytes
619 * 1 bDescriptorType 1 0x05 ENDPOINT descriptor type
620 * 2 bEndpointAddress 1 0x02 Address of endpoint
621 * 3 bmAttributes 1 0x02 Endpoint attributes - Bulk
622 * 4 bNumEndpoints 2 0x0040 maximum packet size
623 * 5 bInterval 1 0x00 Interval for polling endpoint
629 * The device reserves the first two bytes of data on this endpoint to contain the current
630 * values of the modem and line status registers. In the absence of data, the device
631 * generates a message consisting of these two status bytes every 40 ms
633 * Byte 0: Modem Status
636 * B0 Reserved - must be 1
637 * B1 Reserved - must be 0
638 * B2 Reserved - must be 0
639 * B3 Reserved - must be 0
640 * B4 Clear to Send (CTS)
641 * B5 Data Set Ready (DSR)
642 * B6 Ring Indicator (RI)
643 * B7 Receive Line Signal Detect (RLSD)
645 * Byte 1: Line Status
649 * B1 Overrun Error (OE)
650 * B2 Parity Error (PE)
651 * B3 Framing Error (FE)
652 * B4 Break Interrupt (BI)
653 * B5 Transmitter Holding Register (THRE)
654 * B6 Transmitter Empty (TEMT)
655 * B7 Error in RCVR FIFO
658 #define FTDI_RS0_CTS (1 << 4)
659 #define FTDI_RS0_DSR (1 << 5)
660 #define FTDI_RS0_RI (1 << 6)
661 #define FTDI_RS0_RLSD (1 << 7)
664 #define FTDI_RS_OE (1<<1)
665 #define FTDI_RS_PE (1<<2)
666 #define FTDI_RS_FE (1<<3)
667 #define FTDI_RS_BI (1<<4)
668 #define FTDI_RS_THRE (1<<5)
669 #define FTDI_RS_TEMT (1<<6)
670 #define FTDI_RS_FIFO (1<<7)
675 * This device reserves the first bytes of data on this endpoint contain the length
676 * and port identifier of the message. For the FTDI USB Serial converter the port
677 * identifier is always 1.
679 * Byte 0: Line Status
682 * B0 Reserved - must be 1
683 * B1 Reserved - must be 0
684 * B2..7 Length of message - (not including Byte 0)