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_8U2232C_PID 0x6010 /* Dual channel device */
30 #define FTDI_RELAIS_PID 0xFA10 /* Relais device from Rudolf Gugler */
31 #define FTDI_NF_RIC_VID 0x0DCD /* Vendor Id */
32 #define FTDI_NF_RIC_PID 0x0001 /* Product Id */
34 /* www.irtrans.de device */
35 #define FTDI_IRTRANS_PID 0xFC60 /* Product Id */
37 /* www.crystalfontz.com devices - thanx for providing free devices for evaluation ! */
38 /* they use the ftdi chipset for the USB interface and the vendor id is the same */
39 #define FTDI_XF_632_PID 0xFC08 /* 632: 16x2 Character Display */
40 #define FTDI_XF_634_PID 0xFC09 /* 634: 20x4 Character Display */
41 #define FTDI_XF_547_PID 0xFC0A /* 547: Two line Display */
42 #define FTDI_XF_633_PID 0xFC0B /* 633: 16x2 Character Display with Keys */
43 #define FTDI_XF_631_PID 0xFC0C /* 631: 20x2 Character Display */
44 #define FTDI_XF_635_PID 0xFC0D /* 635: 20x4 Character Display */
45 #define FTDI_XF_640_PID 0xFC0E /* 640: Two line Display */
46 #define FTDI_XF_642_PID 0xFC0F /* 642: Two line Display */
48 /* Video Networks Limited / Homechoice in the UK use an ftdi-based device for their 1Mb */
49 /* broadband internet service. The following PID is exhibited by the usb device supplied */
50 /* (the VID is the standard ftdi vid (FTDI_VID) */
51 #define FTDI_VNHCPCUSB_D_PID 0xfe38 /* Product Id */
54 * The following are the values for the Matrix Orbital LCD displays,
55 * which are the FT232BM ( similar to the 8U232AM )
57 #define FTDI_MTXORB_0_PID 0xFA00 /* Matrix Orbital Product Id */
58 #define FTDI_MTXORB_1_PID 0xFA01 /* Matrix Orbital Product Id */
59 #define FTDI_MTXORB_2_PID 0xFA02 /* Matrix Orbital Product Id */
60 #define FTDI_MTXORB_3_PID 0xFA03 /* Matrix Orbital Product Id */
61 #define FTDI_MTXORB_4_PID 0xFA04 /* Matrix Orbital Product Id */
62 #define FTDI_MTXORB_5_PID 0xFA05 /* Matrix Orbital Product Id */
63 #define FTDI_MTXORB_6_PID 0xFA06 /* Matrix Orbital Product Id */
65 /* Interbiometrics USB I/O Board */
66 /* Developed for Interbiometrics by Rudolf Gugler */
67 #define INTERBIOMETRICS_VID 0x1209
68 #define INTERBIOMETRICS_IOBOARD_PID 0x1002
69 #define INTERBIOMETRICS_MINI_IOBOARD_PID 0x1006
72 * The following are the values for the Perle Systems
73 * UltraPort USB serial converters
75 #define FTDI_PERLE_ULTRAPORT_PID 0xF0C0 /* Perle UltraPort Product Id */
78 * The following are the values for the Sealevel SeaLINK+ adapters.
79 * (Original list sent by Tuan Hoang. Ian Abbott renamed the macros and
80 * removed some PIDs that don't seem to match any existing products.)
82 #define SEALEVEL_VID 0x0c52 /* Sealevel Vendor ID */
83 #define SEALEVEL_2101_PID 0x2101 /* SeaLINK+232 (2101/2105) */
84 #define SEALEVEL_2102_PID 0x2102 /* SeaLINK+485 (2102) */
85 #define SEALEVEL_2103_PID 0x2103 /* SeaLINK+232I (2103) */
86 #define SEALEVEL_2104_PID 0x2104 /* SeaLINK+485I (2104) */
87 #define SEALEVEL_2201_1_PID 0x2211 /* SeaPORT+2/232 (2201) Port 1 */
88 #define SEALEVEL_2201_2_PID 0x2221 /* SeaPORT+2/232 (2201) Port 2 */
89 #define SEALEVEL_2202_1_PID 0x2212 /* SeaPORT+2/485 (2202) Port 1 */
90 #define SEALEVEL_2202_2_PID 0x2222 /* SeaPORT+2/485 (2202) Port 2 */
91 #define SEALEVEL_2203_1_PID 0x2213 /* SeaPORT+2 (2203) Port 1 */
92 #define SEALEVEL_2203_2_PID 0x2223 /* SeaPORT+2 (2203) Port 2 */
93 #define SEALEVEL_2401_1_PID 0x2411 /* SeaPORT+4/232 (2401) Port 1 */
94 #define SEALEVEL_2401_2_PID 0x2421 /* SeaPORT+4/232 (2401) Port 2 */
95 #define SEALEVEL_2401_3_PID 0x2431 /* SeaPORT+4/232 (2401) Port 3 */
96 #define SEALEVEL_2401_4_PID 0x2441 /* SeaPORT+4/232 (2401) Port 4 */
97 #define SEALEVEL_2402_1_PID 0x2412 /* SeaPORT+4/485 (2402) Port 1 */
98 #define SEALEVEL_2402_2_PID 0x2422 /* SeaPORT+4/485 (2402) Port 2 */
99 #define SEALEVEL_2402_3_PID 0x2432 /* SeaPORT+4/485 (2402) Port 3 */
100 #define SEALEVEL_2402_4_PID 0x2442 /* SeaPORT+4/485 (2402) Port 4 */
101 #define SEALEVEL_2403_1_PID 0x2413 /* SeaPORT+4 (2403) Port 1 */
102 #define SEALEVEL_2403_2_PID 0x2423 /* SeaPORT+4 (2403) Port 2 */
103 #define SEALEVEL_2403_3_PID 0x2433 /* SeaPORT+4 (2403) Port 3 */
104 #define SEALEVEL_2403_4_PID 0x2443 /* SeaPORT+4 (2403) Port 4 */
105 #define SEALEVEL_2801_1_PID 0X2811 /* SeaLINK+8/232 (2801) Port 1 */
106 #define SEALEVEL_2801_2_PID 0X2821 /* SeaLINK+8/232 (2801) Port 2 */
107 #define SEALEVEL_2801_3_PID 0X2831 /* SeaLINK+8/232 (2801) Port 3 */
108 #define SEALEVEL_2801_4_PID 0X2841 /* SeaLINK+8/232 (2801) Port 4 */
109 #define SEALEVEL_2801_5_PID 0X2851 /* SeaLINK+8/232 (2801) Port 5 */
110 #define SEALEVEL_2801_6_PID 0X2861 /* SeaLINK+8/232 (2801) Port 6 */
111 #define SEALEVEL_2801_7_PID 0X2871 /* SeaLINK+8/232 (2801) Port 7 */
112 #define SEALEVEL_2801_8_PID 0X2881 /* SeaLINK+8/232 (2801) Port 8 */
113 #define SEALEVEL_2802_1_PID 0X2812 /* SeaLINK+8/485 (2802) Port 1 */
114 #define SEALEVEL_2802_2_PID 0X2822 /* SeaLINK+8/485 (2802) Port 2 */
115 #define SEALEVEL_2802_3_PID 0X2832 /* SeaLINK+8/485 (2802) Port 3 */
116 #define SEALEVEL_2802_4_PID 0X2842 /* SeaLINK+8/485 (2802) Port 4 */
117 #define SEALEVEL_2802_5_PID 0X2852 /* SeaLINK+8/485 (2802) Port 5 */
118 #define SEALEVEL_2802_6_PID 0X2862 /* SeaLINK+8/485 (2802) Port 6 */
119 #define SEALEVEL_2802_7_PID 0X2872 /* SeaLINK+8/485 (2802) Port 7 */
120 #define SEALEVEL_2802_8_PID 0X2882 /* SeaLINK+8/485 (2802) Port 8 */
121 #define SEALEVEL_2803_1_PID 0X2813 /* SeaLINK+8 (2803) Port 1 */
122 #define SEALEVEL_2803_2_PID 0X2823 /* SeaLINK+8 (2803) Port 2 */
123 #define SEALEVEL_2803_3_PID 0X2833 /* SeaLINK+8 (2803) Port 3 */
124 #define SEALEVEL_2803_4_PID 0X2843 /* SeaLINK+8 (2803) Port 4 */
125 #define SEALEVEL_2803_5_PID 0X2853 /* SeaLINK+8 (2803) Port 5 */
126 #define SEALEVEL_2803_6_PID 0X2863 /* SeaLINK+8 (2803) Port 6 */
127 #define SEALEVEL_2803_7_PID 0X2873 /* SeaLINK+8 (2803) Port 7 */
128 #define SEALEVEL_2803_8_PID 0X2883 /* SeaLINK+8 (2803) Port 8 */
131 * DSS-20 Sync Station for Sony Ericsson P800
134 #define FTDI_DSS20_PID 0xFC82
137 * Home Electronics (www.home-electro.com) USB gadgets
139 #define FTDI_HE_TIRA1_PID 0xFA78 /* Tira-1 IR transceiver */
141 /* USB-UIRT - An infrared receiver and transmitter using the 8U232AM chip */
142 /* http://home.earthlink.net/~jrhees/USBUIRT/index.htm */
143 #define FTDI_USB_UIRT_PID 0xF850 /* Product Id */
145 /* ELV USB Module UO100 (PID sent by Stefan Frings) */
146 #define FTDI_ELV_UO100_PID 0xFB58 /* Product Id */
147 /* ELV USB Module UM100 (PID sent by Arnim Laeuger) */
148 #define FTDI_ELV_UM100_PID 0xFB5A /* Product Id */
151 * Definitions for ID TECH (www.idt-net.com) devices
153 #define IDTECH_VID 0x0ACD /* ID TECH Vendor ID */
154 #define IDTECH_IDT1221U_PID 0x0300 /* IDT1221U USB to RS-232 adapter */
157 * Definitions for Omnidirectional Control Technology, Inc. devices
159 #define OCT_VID 0x0B39 /* OCT vendor ID */
160 /* Note: OCT US101 is also rebadged as Dick Smith Electronics (NZ) XH6381 */
161 /* Also rebadged as Dick Smith Electronics (Aus) XH6451 */
162 /* Also rebadged as SIIG Inc. model US2308 hardware version 1 */
163 #define OCT_US101_PID 0x0421 /* OCT US101 USB to RS-232 */
165 /* an infrared receiver for user access control with IR tags */
166 #define FTDI_PIEGROUP_PID 0xF208 /* Product Id */
169 * Protego product ids
171 #define PROTEGO_SPECIAL_1 0xFC70 /* special/unknown device */
172 #define PROTEGO_R2X0 0xFC71 /* R200-USB TRNG unit (R210, R220, and R230) */
173 #define PROTEGO_SPECIAL_3 0xFC72 /* special/unknown device */
174 #define PROTEGO_SPECIAL_4 0xFC73 /* special/unknown device */
177 * Gude Analog- und Digitalsysteme GmbH
179 #define FTDI_GUDEADS_E808_PID 0xE808
180 #define FTDI_GUDEADS_E809_PID 0xE809
181 #define FTDI_GUDEADS_E80A_PID 0xE80A
182 #define FTDI_GUDEADS_E80B_PID 0xE80B
183 #define FTDI_GUDEADS_E80C_PID 0xE80C
184 #define FTDI_GUDEADS_E80D_PID 0xE80D
185 #define FTDI_GUDEADS_E80E_PID 0xE80E
186 #define FTDI_GUDEADS_E80F_PID 0xE80F
187 #define FTDI_GUDEADS_E888_PID 0xE888 /* Expert ISDN Control USB */
188 #define FTDI_GUDEADS_E889_PID 0xE889 /* USB RS-232 OptoBridge */
189 #define FTDI_GUDEADS_E88A_PID 0xE88A
190 #define FTDI_GUDEADS_E88B_PID 0xE88B
191 #define FTDI_GUDEADS_E88C_PID 0xE88C
192 #define FTDI_GUDEADS_E88D_PID 0xE88D
193 #define FTDI_GUDEADS_E88E_PID 0xE88E
194 #define FTDI_GUDEADS_E88F_PID 0xE88F
197 * Linx Technologies product ids
199 #define LINX_SDMUSBQSS_PID 0xF448 /* Linx SDM-USB-QS-S */
200 #define LINX_MASTERDEVEL2_PID 0xF449 /* Linx Master Development 2.0 */
201 #define LINX_FUTURE_0_PID 0xF44A /* Linx future device */
202 #define LINX_FUTURE_1_PID 0xF44B /* Linx future device */
203 #define LINX_FUTURE_2_PID 0xF44C /* Linx future device */
205 /* CCS Inc. ICDU/ICDU40 product ID - the FT232BM is used in an in-circuit-debugger */
206 /* unit for PIC16's/PIC18's */
207 #define FTDI_CCSICDU20_0_PID 0xF9D0
208 #define FTDI_CCSICDU40_1_PID 0xF9D1
210 /* Inside Accesso contactless reader (http://www.insidefr.com) */
211 #define INSIDE_ACCESSO 0xFAD0
214 * Intrepid Control Systems (http://www.intrepidcs.com/) ValueCAN and NeoVI
216 #define INTREPID_VID 0x093C
217 #define INTREPID_VALUECAN_PID 0x0601
218 #define INTREPID_NEOVI_PID 0x0701
221 * Falcom Wireless Communications GmbH
223 #define FALCOM_VID 0x0F94 /* Vendor Id */
224 #define FALCOM_TWIST_PID 0x0001 /* Falcom Twist USB GPRS modem */
229 #define FTDI_SUUNTO_SPORTS_PID 0xF680 /* Suunto Sports instrument */
232 * Definitions for B&B Electronics products.
234 #define BANDB_VID 0x0856 /* B&B Electronics Vendor ID */
235 #define BANDB_USOTL4_PID 0xAC01 /* USOTL4 Isolated RS-485 Converter */
236 #define BANDB_USTL4_PID 0xAC02 /* USTL4 RS-485 Converter */
237 #define BANDB_USO9ML2_PID 0xAC03 /* USO9ML2 Isolated RS-232 Converter */
240 * RM Michaelides CANview USB (http://www.rmcan.com)
241 * CAN fieldbus interface adapter, added by port GmbH www.port.de)
242 * Ian Abbott changed the macro names for consistency.
244 #define FTDI_RM_CANVIEW_PID 0xfd60 /* Product Id */
247 * EVER Eco Pro UPS (http://www.ever.com.pl/)
250 #define EVER_ECO_PRO_CDS 0xe520 /* RS-232 converter */
253 * 4N-GALAXY.DE PIDs for CAN-USB, USB-RS232, USB-RS422, USB-RS485,
254 * USB-TTY activ, USB-TTY passiv. Some PIDs are used by several devices
255 * and I'm not entirely sure which are used by which.
257 #define FTDI_4N_GALAXY_DE_0_PID 0x8372
258 #define FTDI_4N_GALAXY_DE_1_PID 0xF3C0
259 #define FTDI_4N_GALAXY_DE_2_PID 0xF3C1
262 * Mobility Electronics products.
264 #define MOBILITY_VID 0x1342
265 #define MOBILITY_USB_SERIAL_PID 0x0202 /* EasiDock USB 200 serial */
268 * Active Robots product ids.
270 #define FTDI_ACTIVE_ROBOTS_PID 0xE548 /* USB comms board */
273 #define FTDI_SIO_RESET 0 /* Reset the port */
274 #define FTDI_SIO_MODEM_CTRL 1 /* Set the modem control register */
275 #define FTDI_SIO_SET_FLOW_CTRL 2 /* Set flow control register */
276 #define FTDI_SIO_SET_BAUD_RATE 3 /* Set baud rate */
277 #define FTDI_SIO_SET_DATA 4 /* Set the data characteristics of the port */
278 #define FTDI_SIO_GET_MODEM_STATUS 5 /* Retrieve current value of modern status register */
279 #define FTDI_SIO_SET_EVENT_CHAR 6 /* Set the event character */
280 #define FTDI_SIO_SET_ERROR_CHAR 7 /* Set the error character */
281 #define FTDI_SIO_SET_LATENCY_TIMER 9 /* Set the latency timer */
282 #define FTDI_SIO_GET_LATENCY_TIMER 10 /* Get the latency timer */
286 * BmRequestType: 1100 0000b
287 * bRequest: FTDI_E2_READ
289 * wIndex: Address of word to read
291 * Data: Will return a word of data from E2Address
295 /* Port Identifier Table */
296 #define PIT_DEFAULT 0 /* SIOA */
297 #define PIT_SIOA 1 /* SIOA */
298 /* The device this driver is tested with one has only one port */
299 #define PIT_SIOB 2 /* SIOB */
300 #define PIT_PARALLEL 3 /* Parallel */
303 #define FTDI_SIO_RESET_REQUEST FTDI_SIO_RESET
304 #define FTDI_SIO_RESET_REQUEST_TYPE 0x40
305 #define FTDI_SIO_RESET_SIO 0
306 #define FTDI_SIO_RESET_PURGE_RX 1
307 #define FTDI_SIO_RESET_PURGE_TX 2
310 * BmRequestType: 0100 0000B
311 * bRequest: FTDI_SIO_RESET
312 * wValue: Control Value
314 * 1 = Purge RX buffer
315 * 2 = Purge TX buffer
320 * The Reset SIO command has this effect:
322 * Sets flow control set to 'none'
324 * Event trigger = disabled
329 * baud and data format not reset
331 * The Purge RX and TX buffer commands affect nothing except the buffers
335 /* FTDI_SIO_SET_BAUDRATE */
336 #define FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE 0x40
337 #define FTDI_SIO_SET_BAUDRATE_REQUEST 3
340 * BmRequestType: 0100 0000B
341 * bRequest: FTDI_SIO_SET_BAUDRATE
342 * wValue: BaudDivisor value - see below
346 * The BaudDivisor values are calculated as follows:
347 * - BaseClock is either 12000000 or 48000000 depending on the device. FIXME: I wish
348 * I knew how to detect old chips to select proper base clock!
349 * - BaudDivisor is a fixed point number encoded in a funny way.
350 * (--WRONG WAY OF THINKING--)
351 * BaudDivisor is a fixed point number encoded with following bit weighs:
352 * (-2)(-1)(13..0). It is a radical with a denominator of 4, so values
353 * end with 0.0 (00...), 0.25 (10...), 0.5 (01...), and 0.75 (11...).
355 * The both-bits-set has quite different meaning from 0.75 - the chip designers
356 * have decided it to mean 0.125 instead of 0.75.
357 * This info looked up in FTDI application note "FT8U232 DEVICES \ Data Rates
358 * and Flow Control Consideration for USB to RS232".
359 * - BaudDivisor = (BaseClock / 16) / BaudRate, where the (=) operation should
360 * automagically re-encode the resulting value to take fractions into consideration.
361 * As all values are integers, some bit twiddling is in order:
362 * BaudDivisor = (BaseClock / 16 / BaudRate) |
363 * (((BaseClock / 2 / BaudRate) & 4) ? 0x4000 // 0.5
364 * : ((BaseClock / 2 / BaudRate) & 2) ? 0x8000 // 0.25
365 * : ((BaseClock / 2 / BaudRate) & 1) ? 0xc000 // 0.125
368 * For the FT232BM, a 17th divisor bit was introduced to encode the multiples
369 * of 0.125 missing from the FT8U232AM. Bits 16 to 14 are coded as follows
370 * (the first four codes are the same as for the FT8U232AM, where bit 16 is
372 * 000 - add .000 to divisor
373 * 001 - add .500 to divisor
374 * 010 - add .250 to divisor
375 * 011 - add .125 to divisor
376 * 100 - add .375 to divisor
377 * 101 - add .625 to divisor
378 * 110 - add .750 to divisor
379 * 111 - add .875 to divisor
380 * Bits 15 to 0 of the 17-bit divisor are placed in the urb value. Bit 16 is
381 * placed in bit 0 of the urb index.
383 * Note that there are a couple of special cases to support the highest baud
384 * rates. If the calculated divisor value is 1, this needs to be replaced with
385 * 0. Additionally for the FT232BM, if the calculated divisor value is 0x4001
386 * (1.5), this needs to be replaced with 0x0001 (1) (but this divisor value is
387 * not supported by the FT8U232AM).
408 } FTDI_SIO_baudrate_t ;
411 * The ftdi_8U232AM_xxMHz_byyy constants have been removed. The encoded divisor values
412 * are calculated internally.
415 #define FTDI_SIO_SET_DATA_REQUEST FTDI_SIO_SET_DATA
416 #define FTDI_SIO_SET_DATA_REQUEST_TYPE 0x40
417 #define FTDI_SIO_SET_DATA_PARITY_NONE (0x0 << 8 )
418 #define FTDI_SIO_SET_DATA_PARITY_ODD (0x1 << 8 )
419 #define FTDI_SIO_SET_DATA_PARITY_EVEN (0x2 << 8 )
420 #define FTDI_SIO_SET_DATA_PARITY_MARK (0x3 << 8 )
421 #define FTDI_SIO_SET_DATA_PARITY_SPACE (0x4 << 8 )
422 #define FTDI_SIO_SET_DATA_STOP_BITS_1 (0x0 << 11 )
423 #define FTDI_SIO_SET_DATA_STOP_BITS_15 (0x1 << 11 )
424 #define FTDI_SIO_SET_DATA_STOP_BITS_2 (0x2 << 11 )
425 #define FTDI_SIO_SET_BREAK (0x1 << 14)
426 /* FTDI_SIO_SET_DATA */
429 * BmRequestType: 0100 0000B
430 * bRequest: FTDI_SIO_SET_DATA
431 * wValue: Data characteristics (see below)
436 * Data characteristics
438 * B0..7 Number of data bits
451 * 0 = TX OFF (normal state)
458 /* FTDI_SIO_MODEM_CTRL */
459 #define FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE 0x40
460 #define FTDI_SIO_SET_MODEM_CTRL_REQUEST FTDI_SIO_MODEM_CTRL
463 * BmRequestType: 0100 0000B
464 * bRequest: FTDI_SIO_MODEM_CTRL
465 * wValue: ControlValue (see below)
470 * NOTE: If the device is in RTS/CTS flow control, the RTS set by this
471 * command will be IGNORED without an error being returned
472 * Also - you can not set DTR and RTS with one control message
475 #define FTDI_SIO_SET_DTR_MASK 0x1
476 #define FTDI_SIO_SET_DTR_HIGH ( 1 | ( FTDI_SIO_SET_DTR_MASK << 8))
477 #define FTDI_SIO_SET_DTR_LOW ( 0 | ( FTDI_SIO_SET_DTR_MASK << 8))
478 #define FTDI_SIO_SET_RTS_MASK 0x2
479 #define FTDI_SIO_SET_RTS_HIGH ( 2 | ( FTDI_SIO_SET_RTS_MASK << 8 ))
480 #define FTDI_SIO_SET_RTS_LOW ( 0 | ( FTDI_SIO_SET_RTS_MASK << 8 ))
491 * B8 DTR state enable
494 * B9 RTS state enable
500 /* FTDI_SIO_SET_FLOW_CTRL */
501 #define FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE 0x40
502 #define FTDI_SIO_SET_FLOW_CTRL_REQUEST FTDI_SIO_SET_FLOW_CTRL
503 #define FTDI_SIO_DISABLE_FLOW_CTRL 0x0
504 #define FTDI_SIO_RTS_CTS_HS (0x1 << 8)
505 #define FTDI_SIO_DTR_DSR_HS (0x2 << 8)
506 #define FTDI_SIO_XON_XOFF_HS (0x4 << 8)
508 * BmRequestType: 0100 0000b
509 * bRequest: FTDI_SIO_SET_FLOW_CTRL
511 * wIndex: Protocol/Port - hIndex is protocl / lIndex is port
515 * hIndex protocol is:
516 * B0 Output handshaking using RTS/CTS
519 * B1 Output handshaking using DTR/DSR
522 * B2 Xon/Xoff handshaking
526 * A value of zero in the hIndex field disables handshaking
528 * If Xon/Xoff handshaking is specified, the hValue field should contain the XOFF character
529 * and the lValue field contains the XON character.
533 * FTDI_SIO_GET_LATENCY_TIMER
535 * Set the timeout interval. The FTDI collects data from the slave
536 * device, transmitting it to the host when either A) 62 bytes are
537 * received, or B) the timeout interval has elapsed and the buffer
538 * contains at least 1 byte. Setting this value to a small number
539 * can dramatically improve performance for applications which send
540 * small packets, since the default value is 16ms.
542 #define FTDI_SIO_GET_LATENCY_TIMER_REQUEST FTDI_SIO_GET_LATENCY_TIMER
543 #define FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE 0xC0
546 * BmRequestType: 1100 0000b
547 * bRequest: FTDI_SIO_GET_LATENCY_TIMER
551 * Data: latency (on return)
555 * FTDI_SIO_SET_LATENCY_TIMER
557 * Set the timeout interval. The FTDI collects data from the slave
558 * device, transmitting it to the host when either A) 62 bytes are
559 * received, or B) the timeout interval has elapsed and the buffer
560 * contains at least 1 byte. Setting this value to a small number
561 * can dramatically improve performance for applications which send
562 * small packets, since the default value is 16ms.
564 #define FTDI_SIO_SET_LATENCY_TIMER_REQUEST FTDI_SIO_SET_LATENCY_TIMER
565 #define FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE 0x40
568 * BmRequestType: 0100 0000b
569 * bRequest: FTDI_SIO_SET_LATENCY_TIMER
570 * wValue: Latency (milliseconds)
576 * B0..7 Latency timer
582 * FTDI_SIO_SET_EVENT_CHAR
584 * Set the special event character for the specified communications port.
585 * If the device sees this character it will immediately return the
586 * data read so far - rather than wait 40ms or until 62 bytes are read
587 * which is what normally happens.
591 #define FTDI_SIO_SET_EVENT_CHAR_REQUEST FTDI_SIO_SET_EVENT_CHAR
592 #define FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE 0x40
596 * BmRequestType: 0100 0000b
597 * bRequest: FTDI_SIO_SET_EVENT_CHAR
604 * B0..7 Event Character
605 * B8 Event Character Processing
612 /* FTDI_SIO_SET_ERROR_CHAR */
614 /* Set the parity error replacement character for the specified communications port */
617 * BmRequestType: 0100 0000b
618 * bRequest: FTDI_SIO_SET_EVENT_CHAR
625 * B0..7 Error Character
626 * B8 Error Character Processing
633 /* FTDI_SIO_GET_MODEM_STATUS */
634 /* Retreive the current value of the modem status register */
636 #define FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE 0xc0
637 #define FTDI_SIO_GET_MODEM_STATUS_REQUEST FTDI_SIO_GET_MODEM_STATUS
638 #define FTDI_SIO_CTS_MASK 0x10
639 #define FTDI_SIO_DSR_MASK 0x20
640 #define FTDI_SIO_RI_MASK 0x40
641 #define FTDI_SIO_RLSD_MASK 0x80
643 * BmRequestType: 1100 0000b
644 * bRequest: FTDI_SIO_GET_MODEM_STATUS
650 * One byte of data is returned
658 * B6 Ring Indicator (RI)
661 * B7 Receive Line Signal Detect (RLSD)
668 /* Descriptors returned by the device
672 * Offset Field Size Value Description
673 * 0 bLength 1 0x12 Size of descriptor in bytes
674 * 1 bDescriptorType 1 0x01 DEVICE Descriptor Type
675 * 2 bcdUSB 2 0x0110 USB Spec Release Number
676 * 4 bDeviceClass 1 0x00 Class Code
677 * 5 bDeviceSubClass 1 0x00 SubClass Code
678 * 6 bDeviceProtocol 1 0x00 Protocol Code
679 * 7 bMaxPacketSize0 1 0x08 Maximum packet size for endpoint 0
680 * 8 idVendor 2 0x0403 Vendor ID
681 * 10 idProduct 2 0x8372 Product ID (FTDI_SIO_PID)
682 * 12 bcdDevice 2 0x0001 Device release number
683 * 14 iManufacturer 1 0x01 Index of man. string desc
684 * 15 iProduct 1 0x02 Index of prod string desc
685 * 16 iSerialNumber 1 0x02 Index of serial nmr string desc
686 * 17 bNumConfigurations 1 0x01 Number of possible configurations
688 * Configuration Descriptor
690 * Offset Field Size Value
691 * 0 bLength 1 0x09 Size of descriptor in bytes
692 * 1 bDescriptorType 1 0x02 CONFIGURATION Descriptor Type
693 * 2 wTotalLength 2 0x0020 Total length of data
694 * 4 bNumInterfaces 1 0x01 Number of interfaces supported
695 * 5 bConfigurationValue 1 0x01 Argument for SetCOnfiguration() req
696 * 6 iConfiguration 1 0x02 Index of config string descriptor
697 * 7 bmAttributes 1 0x20 Config characteristics Remote Wakeup
698 * 8 MaxPower 1 0x1E Max power consumption
700 * Interface Descriptor
702 * Offset Field Size Value
703 * 0 bLength 1 0x09 Size of descriptor in bytes
704 * 1 bDescriptorType 1 0x04 INTERFACE Descriptor Type
705 * 2 bInterfaceNumber 1 0x00 Number of interface
706 * 3 bAlternateSetting 1 0x00 Value used to select alternate
707 * 4 bNumEndpoints 1 0x02 Number of endpoints
708 * 5 bInterfaceClass 1 0xFF Class Code
709 * 6 bInterfaceSubClass 1 0xFF Subclass Code
710 * 7 bInterfaceProtocol 1 0xFF Protocol Code
711 * 8 iInterface 1 0x02 Index of interface string description
713 * IN Endpoint Descriptor
715 * Offset Field Size Value
716 * 0 bLength 1 0x07 Size of descriptor in bytes
717 * 1 bDescriptorType 1 0x05 ENDPOINT descriptor type
718 * 2 bEndpointAddress 1 0x82 Address of endpoint
719 * 3 bmAttributes 1 0x02 Endpoint attributes - Bulk
720 * 4 bNumEndpoints 2 0x0040 maximum packet size
721 * 5 bInterval 1 0x00 Interval for polling endpoint
723 * OUT Endpoint Descriptor
725 * Offset Field Size Value
726 * 0 bLength 1 0x07 Size of descriptor in bytes
727 * 1 bDescriptorType 1 0x05 ENDPOINT descriptor type
728 * 2 bEndpointAddress 1 0x02 Address of endpoint
729 * 3 bmAttributes 1 0x02 Endpoint attributes - Bulk
730 * 4 bNumEndpoints 2 0x0040 maximum packet size
731 * 5 bInterval 1 0x00 Interval for polling endpoint
737 * The device reserves the first two bytes of data on this endpoint to contain the current
738 * values of the modem and line status registers. In the absence of data, the device
739 * generates a message consisting of these two status bytes every 40 ms
741 * Byte 0: Modem Status
744 * B0 Reserved - must be 1
745 * B1 Reserved - must be 0
746 * B2 Reserved - must be 0
747 * B3 Reserved - must be 0
748 * B4 Clear to Send (CTS)
749 * B5 Data Set Ready (DSR)
750 * B6 Ring Indicator (RI)
751 * B7 Receive Line Signal Detect (RLSD)
753 * Byte 1: Line Status
757 * B1 Overrun Error (OE)
758 * B2 Parity Error (PE)
759 * B3 Framing Error (FE)
760 * B4 Break Interrupt (BI)
761 * B5 Transmitter Holding Register (THRE)
762 * B6 Transmitter Empty (TEMT)
763 * B7 Error in RCVR FIFO
766 #define FTDI_RS0_CTS (1 << 4)
767 #define FTDI_RS0_DSR (1 << 5)
768 #define FTDI_RS0_RI (1 << 6)
769 #define FTDI_RS0_RLSD (1 << 7)
772 #define FTDI_RS_OE (1<<1)
773 #define FTDI_RS_PE (1<<2)
774 #define FTDI_RS_FE (1<<3)
775 #define FTDI_RS_BI (1<<4)
776 #define FTDI_RS_THRE (1<<5)
777 #define FTDI_RS_TEMT (1<<6)
778 #define FTDI_RS_FIFO (1<<7)
783 * This device reserves the first bytes of data on this endpoint contain the length
784 * and port identifier of the message. For the FTDI USB Serial converter the port
785 * identifier is always 1.
787 * Byte 0: Line Status
790 * B0 Reserved - must be 1
791 * B1 Reserved - must be 0
792 * B2..7 Length of message - (not including Byte 0)