2 * Driver definitions for the FTDI USB Single Port Serial Converter -
3 * known as FTDI_SIO (Serial Input/Output application of the chipset)
5 * For USB vendor/product IDs (VID/PID), please see ftdi_sio_ids.h
8 * The example I have is known as the USC-1000 which is available from
9 * http://www.dse.co.nz - cat no XH4214 It looks similar to this:
10 * http://www.dansdata.com/usbser.htm but I can't be sure There are other
11 * USC-1000s which don't look like my device though so beware!
13 * The device is based on the FTDI FT8U100AX chip. It has a DB25 on one side,
16 * Thanx to FTDI (http://www.ftdichip.com) for so kindly providing details
17 * of the protocol required to talk to the device and ongoing assistence
20 * Bill Ryder - bryder@sgi.com formerly of Silicon Graphics, Inc.- wrote the
21 * FTDI_SIO implementation.
26 #define FTDI_SIO_RESET 0 /* Reset the port */
27 #define FTDI_SIO_MODEM_CTRL 1 /* Set the modem control register */
28 #define FTDI_SIO_SET_FLOW_CTRL 2 /* Set flow control register */
29 #define FTDI_SIO_SET_BAUD_RATE 3 /* Set baud rate */
30 #define FTDI_SIO_SET_DATA 4 /* Set the data characteristics of
32 #define FTDI_SIO_GET_MODEM_STATUS 5 /* Retrieve current value of modem
34 #define FTDI_SIO_SET_EVENT_CHAR 6 /* Set the event character */
35 #define FTDI_SIO_SET_ERROR_CHAR 7 /* Set the error character */
36 #define FTDI_SIO_SET_LATENCY_TIMER 9 /* Set the latency timer */
37 #define FTDI_SIO_GET_LATENCY_TIMER 10 /* Get the latency timer */
39 /* Interface indices for FT2232, FT2232H and FT4232H devices */
47 * BmRequestType: 1100 0000b
48 * bRequest: FTDI_E2_READ
50 * wIndex: Address of word to read
52 * Data: Will return a word of data from E2Address
56 /* Port Identifier Table */
57 #define PIT_DEFAULT 0 /* SIOA */
58 #define PIT_SIOA 1 /* SIOA */
59 /* The device this driver is tested with one has only one port */
60 #define PIT_SIOB 2 /* SIOB */
61 #define PIT_PARALLEL 3 /* Parallel */
64 #define FTDI_SIO_RESET_REQUEST FTDI_SIO_RESET
65 #define FTDI_SIO_RESET_REQUEST_TYPE 0x40
66 #define FTDI_SIO_RESET_SIO 0
67 #define FTDI_SIO_RESET_PURGE_RX 1
68 #define FTDI_SIO_RESET_PURGE_TX 2
71 * BmRequestType: 0100 0000B
72 * bRequest: FTDI_SIO_RESET
73 * wValue: Control Value
81 * The Reset SIO command has this effect:
83 * Sets flow control set to 'none'
85 * Event trigger = disabled
90 * baud and data format not reset
92 * The Purge RX and TX buffer commands affect nothing except the buffers
96 /* FTDI_SIO_SET_BAUDRATE */
97 #define FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE 0x40
98 #define FTDI_SIO_SET_BAUDRATE_REQUEST 3
101 * BmRequestType: 0100 0000B
102 * bRequest: FTDI_SIO_SET_BAUDRATE
103 * wValue: BaudDivisor value - see below
107 * The BaudDivisor values are calculated as follows:
108 * - BaseClock is either 12000000 or 48000000 depending on the device.
109 * FIXME: I wish I knew how to detect old chips to select proper base clock!
110 * - BaudDivisor is a fixed point number encoded in a funny way.
111 * (--WRONG WAY OF THINKING--)
112 * BaudDivisor is a fixed point number encoded with following bit weighs:
113 * (-2)(-1)(13..0). It is a radical with a denominator of 4, so values
114 * end with 0.0 (00...), 0.25 (10...), 0.5 (01...), and 0.75 (11...).
116 * The both-bits-set has quite different meaning from 0.75 - the chip
117 * designers have decided it to mean 0.125 instead of 0.75.
118 * This info looked up in FTDI application note "FT8U232 DEVICES \ Data Rates
119 * and Flow Control Consideration for USB to RS232".
120 * - BaudDivisor = (BaseClock / 16) / BaudRate, where the (=) operation should
121 * automagically re-encode the resulting value to take fractions into
123 * As all values are integers, some bit twiddling is in order:
124 * BaudDivisor = (BaseClock / 16 / BaudRate) |
125 * (((BaseClock / 2 / BaudRate) & 4) ? 0x4000 // 0.5
126 * : ((BaseClock / 2 / BaudRate) & 2) ? 0x8000 // 0.25
127 * : ((BaseClock / 2 / BaudRate) & 1) ? 0xc000 // 0.125
130 * For the FT232BM, a 17th divisor bit was introduced to encode the multiples
131 * of 0.125 missing from the FT8U232AM. Bits 16 to 14 are coded as follows
132 * (the first four codes are the same as for the FT8U232AM, where bit 16 is
134 * 000 - add .000 to divisor
135 * 001 - add .500 to divisor
136 * 010 - add .250 to divisor
137 * 011 - add .125 to divisor
138 * 100 - add .375 to divisor
139 * 101 - add .625 to divisor
140 * 110 - add .750 to divisor
141 * 111 - add .875 to divisor
142 * Bits 15 to 0 of the 17-bit divisor are placed in the urb value. Bit 16 is
143 * placed in bit 0 of the urb index.
145 * Note that there are a couple of special cases to support the highest baud
146 * rates. If the calculated divisor value is 1, this needs to be replaced with
147 * 0. Additionally for the FT232BM, if the calculated divisor value is 0x4001
148 * (1.5), this needs to be replaced with 0x0001 (1) (but this divisor value is
149 * not supported by the FT8U232AM).
152 enum ftdi_chip_type
{
164 enum ftdi_sio_baudrate
{
178 * The ftdi_8U232AM_xxMHz_byyy constants have been removed. The encoded divisor
179 * values are calculated internally.
181 #define FTDI_SIO_SET_DATA_REQUEST FTDI_SIO_SET_DATA
182 #define FTDI_SIO_SET_DATA_REQUEST_TYPE 0x40
183 #define FTDI_SIO_SET_DATA_PARITY_NONE (0x0 << 8)
184 #define FTDI_SIO_SET_DATA_PARITY_ODD (0x1 << 8)
185 #define FTDI_SIO_SET_DATA_PARITY_EVEN (0x2 << 8)
186 #define FTDI_SIO_SET_DATA_PARITY_MARK (0x3 << 8)
187 #define FTDI_SIO_SET_DATA_PARITY_SPACE (0x4 << 8)
188 #define FTDI_SIO_SET_DATA_STOP_BITS_1 (0x0 << 11)
189 #define FTDI_SIO_SET_DATA_STOP_BITS_15 (0x1 << 11)
190 #define FTDI_SIO_SET_DATA_STOP_BITS_2 (0x2 << 11)
191 #define FTDI_SIO_SET_BREAK (0x1 << 14)
192 /* FTDI_SIO_SET_DATA */
195 * BmRequestType: 0100 0000B
196 * bRequest: FTDI_SIO_SET_DATA
197 * wValue: Data characteristics (see below)
202 * Data characteristics
204 * B0..7 Number of data bits
217 * 0 = TX OFF (normal state)
224 /* FTDI_SIO_MODEM_CTRL */
225 #define FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE 0x40
226 #define FTDI_SIO_SET_MODEM_CTRL_REQUEST FTDI_SIO_MODEM_CTRL
229 * BmRequestType: 0100 0000B
230 * bRequest: FTDI_SIO_MODEM_CTRL
231 * wValue: ControlValue (see below)
236 * NOTE: If the device is in RTS/CTS flow control, the RTS set by this
237 * command will be IGNORED without an error being returned
238 * Also - you can not set DTR and RTS with one control message
241 #define FTDI_SIO_SET_DTR_MASK 0x1
242 #define FTDI_SIO_SET_DTR_HIGH ((FTDI_SIO_SET_DTR_MASK << 8) | 1)
243 #define FTDI_SIO_SET_DTR_LOW ((FTDI_SIO_SET_DTR_MASK << 8) | 0)
244 #define FTDI_SIO_SET_RTS_MASK 0x2
245 #define FTDI_SIO_SET_RTS_HIGH ((FTDI_SIO_SET_RTS_MASK << 8) | 2)
246 #define FTDI_SIO_SET_RTS_LOW ((FTDI_SIO_SET_RTS_MASK << 8) | 0)
257 * B8 DTR state enable
260 * B9 RTS state enable
266 /* FTDI_SIO_SET_FLOW_CTRL */
267 #define FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE 0x40
268 #define FTDI_SIO_SET_FLOW_CTRL_REQUEST FTDI_SIO_SET_FLOW_CTRL
269 #define FTDI_SIO_DISABLE_FLOW_CTRL 0x0
270 #define FTDI_SIO_RTS_CTS_HS (0x1 << 8)
271 #define FTDI_SIO_DTR_DSR_HS (0x2 << 8)
272 #define FTDI_SIO_XON_XOFF_HS (0x4 << 8)
274 * BmRequestType: 0100 0000b
275 * bRequest: FTDI_SIO_SET_FLOW_CTRL
277 * wIndex: Protocol/Port - hIndex is protocol / lIndex is port
281 * hIndex protocol is:
282 * B0 Output handshaking using RTS/CTS
285 * B1 Output handshaking using DTR/DSR
288 * B2 Xon/Xoff handshaking
292 * A value of zero in the hIndex field disables handshaking
294 * If Xon/Xoff handshaking is specified, the hValue field should contain the
295 * XOFF character and the lValue field contains the XON character.
299 * FTDI_SIO_GET_LATENCY_TIMER
301 * Set the timeout interval. The FTDI collects data from the slave
302 * device, transmitting it to the host when either A) 62 bytes are
303 * received, or B) the timeout interval has elapsed and the buffer
304 * contains at least 1 byte. Setting this value to a small number
305 * can dramatically improve performance for applications which send
306 * small packets, since the default value is 16ms.
308 #define FTDI_SIO_GET_LATENCY_TIMER_REQUEST FTDI_SIO_GET_LATENCY_TIMER
309 #define FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE 0xC0
312 * BmRequestType: 1100 0000b
313 * bRequest: FTDI_SIO_GET_LATENCY_TIMER
317 * Data: latency (on return)
321 * FTDI_SIO_SET_LATENCY_TIMER
323 * Set the timeout interval. The FTDI collects data from the slave
324 * device, transmitting it to the host when either A) 62 bytes are
325 * received, or B) the timeout interval has elapsed and the buffer
326 * contains at least 1 byte. Setting this value to a small number
327 * can dramatically improve performance for applications which send
328 * small packets, since the default value is 16ms.
330 #define FTDI_SIO_SET_LATENCY_TIMER_REQUEST FTDI_SIO_SET_LATENCY_TIMER
331 #define FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE 0x40
334 * BmRequestType: 0100 0000b
335 * bRequest: FTDI_SIO_SET_LATENCY_TIMER
336 * wValue: Latency (milliseconds)
342 * B0..7 Latency timer
348 * FTDI_SIO_SET_EVENT_CHAR
350 * Set the special event character for the specified communications port.
351 * If the device sees this character it will immediately return the
352 * data read so far - rather than wait 40ms or until 62 bytes are read
353 * which is what normally happens.
357 #define FTDI_SIO_SET_EVENT_CHAR_REQUEST FTDI_SIO_SET_EVENT_CHAR
358 #define FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE 0x40
362 * BmRequestType: 0100 0000b
363 * bRequest: FTDI_SIO_SET_EVENT_CHAR
370 * B0..7 Event Character
371 * B8 Event Character Processing
378 /* FTDI_SIO_SET_ERROR_CHAR */
381 * Set the parity error replacement character for the specified communications
386 * BmRequestType: 0100 0000b
387 * bRequest: FTDI_SIO_SET_EVENT_CHAR
394 * B0..7 Error Character
395 * B8 Error Character Processing
402 /* FTDI_SIO_GET_MODEM_STATUS */
403 /* Retrieve the current value of the modem status register */
405 #define FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE 0xc0
406 #define FTDI_SIO_GET_MODEM_STATUS_REQUEST FTDI_SIO_GET_MODEM_STATUS
407 #define FTDI_SIO_CTS_MASK 0x10
408 #define FTDI_SIO_DSR_MASK 0x20
409 #define FTDI_SIO_RI_MASK 0x40
410 #define FTDI_SIO_RLSD_MASK 0x80
412 * BmRequestType: 1100 0000b
413 * bRequest: FTDI_SIO_GET_MODEM_STATUS
419 * One byte of data is returned
427 * B6 Ring Indicator (RI)
430 * B7 Receive Line Signal Detect (RLSD)
437 /* Descriptors returned by the device
441 * Offset Field Size Value Description
442 * 0 bLength 1 0x12 Size of descriptor in bytes
443 * 1 bDescriptorType 1 0x01 DEVICE Descriptor Type
444 * 2 bcdUSB 2 0x0110 USB Spec Release Number
445 * 4 bDeviceClass 1 0x00 Class Code
446 * 5 bDeviceSubClass 1 0x00 SubClass Code
447 * 6 bDeviceProtocol 1 0x00 Protocol Code
448 * 7 bMaxPacketSize0 1 0x08 Maximum packet size for endpoint 0
449 * 8 idVendor 2 0x0403 Vendor ID
450 * 10 idProduct 2 0x8372 Product ID (FTDI_SIO_PID)
451 * 12 bcdDevice 2 0x0001 Device release number
452 * 14 iManufacturer 1 0x01 Index of man. string desc
453 * 15 iProduct 1 0x02 Index of prod string desc
454 * 16 iSerialNumber 1 0x02 Index of serial nmr string desc
455 * 17 bNumConfigurations 1 0x01 Number of possible configurations
457 * Configuration Descriptor
459 * Offset Field Size Value
460 * 0 bLength 1 0x09 Size of descriptor in bytes
461 * 1 bDescriptorType 1 0x02 CONFIGURATION Descriptor Type
462 * 2 wTotalLength 2 0x0020 Total length of data
463 * 4 bNumInterfaces 1 0x01 Number of interfaces supported
464 * 5 bConfigurationValue 1 0x01 Argument for SetCOnfiguration() req
465 * 6 iConfiguration 1 0x02 Index of config string descriptor
466 * 7 bmAttributes 1 0x20 Config characteristics Remote Wakeup
467 * 8 MaxPower 1 0x1E Max power consumption
469 * Interface Descriptor
471 * Offset Field Size Value
472 * 0 bLength 1 0x09 Size of descriptor in bytes
473 * 1 bDescriptorType 1 0x04 INTERFACE Descriptor Type
474 * 2 bInterfaceNumber 1 0x00 Number of interface
475 * 3 bAlternateSetting 1 0x00 Value used to select alternate
476 * 4 bNumEndpoints 1 0x02 Number of endpoints
477 * 5 bInterfaceClass 1 0xFF Class Code
478 * 6 bInterfaceSubClass 1 0xFF Subclass Code
479 * 7 bInterfaceProtocol 1 0xFF Protocol Code
480 * 8 iInterface 1 0x02 Index of interface string description
482 * IN Endpoint Descriptor
484 * Offset Field Size Value
485 * 0 bLength 1 0x07 Size of descriptor in bytes
486 * 1 bDescriptorType 1 0x05 ENDPOINT descriptor type
487 * 2 bEndpointAddress 1 0x82 Address of endpoint
488 * 3 bmAttributes 1 0x02 Endpoint attributes - Bulk
489 * 4 bNumEndpoints 2 0x0040 maximum packet size
490 * 5 bInterval 1 0x00 Interval for polling endpoint
492 * OUT Endpoint Descriptor
494 * Offset Field Size Value
495 * 0 bLength 1 0x07 Size of descriptor in bytes
496 * 1 bDescriptorType 1 0x05 ENDPOINT descriptor type
497 * 2 bEndpointAddress 1 0x02 Address of endpoint
498 * 3 bmAttributes 1 0x02 Endpoint attributes - Bulk
499 * 4 bNumEndpoints 2 0x0040 maximum packet size
500 * 5 bInterval 1 0x00 Interval for polling endpoint
506 * The device reserves the first two bytes of data on this endpoint to contain
507 * the current values of the modem and line status registers. In the absence of
508 * data, the device generates a message consisting of these two status bytes
511 * Byte 0: Modem Status
514 * B0 Reserved - must be 1
515 * B1 Reserved - must be 0
516 * B2 Reserved - must be 0
517 * B3 Reserved - must be 0
518 * B4 Clear to Send (CTS)
519 * B5 Data Set Ready (DSR)
520 * B6 Ring Indicator (RI)
521 * B7 Receive Line Signal Detect (RLSD)
523 * Byte 1: Line Status
527 * B1 Overrun Error (OE)
528 * B2 Parity Error (PE)
529 * B3 Framing Error (FE)
530 * B4 Break Interrupt (BI)
531 * B5 Transmitter Holding Register (THRE)
532 * B6 Transmitter Empty (TEMT)
533 * B7 Error in RCVR FIFO
536 #define FTDI_RS0_CTS (1 << 4)
537 #define FTDI_RS0_DSR (1 << 5)
538 #define FTDI_RS0_RI (1 << 6)
539 #define FTDI_RS0_RLSD (1 << 7)
542 #define FTDI_RS_OE (1<<1)
543 #define FTDI_RS_PE (1<<2)
544 #define FTDI_RS_FE (1<<3)
545 #define FTDI_RS_BI (1<<4)
546 #define FTDI_RS_THRE (1<<5)
547 #define FTDI_RS_TEMT (1<<6)
548 #define FTDI_RS_FIFO (1<<7)
553 * This device reserves the first bytes of data on this endpoint contain the
554 * length and port identifier of the message. For the FTDI USB Serial converter
555 * the port identifier is always 1.
557 * Byte 0: Line Status
560 * B0 Reserved - must be 1
561 * B1 Reserved - must be 0
562 * B2..7 Length of message - (not including Byte 0)