1 /* $NetBSD: uftdireg.h,v 1.6 2002/07/11 21:14:28 augustss Exp $ */
2 /* $FreeBSD: src/sys/dev/usb/uftdireg.h,v 1.1.2.1 2002/11/21 01:28:17 ticso Exp $ */
5 * Definitions for the FTDI USB Single Port Serial Converter -
6 * known as FTDI_SIO (Serial Input/Output application of the chipset)
8 * The device is based on the FTDI FT8U100AX chip. It has a DB25 on one side,
11 * Thanx to FTDI (http://www.ftdi.co.uk) for so kindly providing details
12 * of the protocol required to talk to the device and ongoing assistence
15 * Bill Ryder - bryder@sgi.com of Silicon Graphics, Inc. is the original
16 * author of this file.
18 /* Modified by Lennart Augustsson */
20 /* Vendor Request Interface */
21 #define FTDI_SIO_RESET 0 /* Reset the port */
22 #define FTDI_SIO_MODEM_CTRL 1 /* Set the modem control register */
23 #define FTDI_SIO_SET_FLOW_CTRL 2 /* Set flow control register */
24 #define FTDI_SIO_SET_BAUD_RATE 3 /* Set baud rate */
25 #define FTDI_SIO_SET_DATA 4 /* Set the data characteristics of the port */
26 #define FTDI_SIO_GET_STATUS 5 /* Retrieve current value of status reg */
27 #define FTDI_SIO_SET_EVENT_CHAR 6 /* Set the event character */
28 #define FTDI_SIO_SET_ERROR_CHAR 7 /* Set the error character */
30 /* Port Identifier Table */
31 #define FTDI_PIT_DEFAULT 0 /* SIOA */
32 #define FTDI_PIT_SIOA 1 /* SIOA */
33 #define FTDI_PIT_SIOB 2 /* SIOB */
34 #define FTDI_PIT_PARALLEL 3 /* Parallel */
42 * BmRequestType: 0100 0000B
43 * bRequest: FTDI_SIO_RESET
44 * wValue: Control Value
52 * The Reset SIO command has this effect:
54 * Sets flow control set to 'none'
56 * Event trigger = disabled
61 * baud and data format not reset
63 * The Purge RX and TX buffer commands affect nothing except the buffers
67 #define FTDI_SIO_RESET_SIO 0
68 #define FTDI_SIO_RESET_PURGE_RX 1
69 #define FTDI_SIO_RESET_PURGE_TX 2
73 * BmRequestType: 0100 0000B
74 * bRequest: FTDI_SIO_SET_BAUDRATE
75 * wValue: BaudRate value - see below
80 /* FTDI_SIO_SET_BAUDRATE */
95 ftdi_8u232am_b300 = 0x2710,
96 ftdi_8u232am_b600 = 0x1388,
97 ftdi_8u232am_b1200 = 0x09c4,
98 ftdi_8u232am_b2400 = 0x04e2,
99 ftdi_8u232am_b4800 = 0x0271,
100 ftdi_8u232am_b9600 = 0x4138,
101 ftdi_8u232am_b19200 = 0x809c,
102 ftdi_8u232am_b38400 = 0xc04e,
103 ftdi_8u232am_b57600 = 0x0034,
104 ftdi_8u232am_b115200 = 0x001a,
105 ftdi_8u232am_b230400 = 0x000d,
106 ftdi_8u232am_b460800 = 0x4006,
107 ftdi_8u232am_b921600 = 0x8003
111 * BmRequestType: 0100 0000B
112 * bRequest: FTDI_SIO_SET_DATA
113 * wValue: Data characteristics (see below)
118 * Data characteristics
120 * B0..7 Number of data bits
134 /* FTDI_SIO_SET_DATA */
135 #define FTDI_SIO_SET_DATA_BITS(n) (n)
136 #define FTDI_SIO_SET_DATA_PARITY_NONE (0x0 << 8)
137 #define FTDI_SIO_SET_DATA_PARITY_ODD (0x1 << 8)
138 #define FTDI_SIO_SET_DATA_PARITY_EVEN (0x2 << 8)
139 #define FTDI_SIO_SET_DATA_PARITY_MARK (0x3 << 8)
140 #define FTDI_SIO_SET_DATA_PARITY_SPACE (0x4 << 8)
141 #define FTDI_SIO_SET_DATA_STOP_BITS_1 (0x0 << 11)
142 #define FTDI_SIO_SET_DATA_STOP_BITS_15 (0x1 << 11)
143 #define FTDI_SIO_SET_DATA_STOP_BITS_2 (0x2 << 11)
144 #define FTDI_SIO_SET_BREAK (0x1 << 14)
148 * BmRequestType: 0100 0000B
149 * bRequest: FTDI_SIO_MODEM_CTRL
150 * wValue: ControlValue (see below)
155 * NOTE: If the device is in RTS/CTS flow control, the RTS set by this
156 * command will be IGNORED without an error being returned
157 * Also - you can not set DTR and RTS with one control message
167 * B8 DTR state enable
170 * B9 RTS state enable
175 /* FTDI_SIO_MODEM_CTRL */
176 #define FTDI_SIO_SET_DTR_MASK 0x1
177 #define FTDI_SIO_SET_DTR_HIGH (1 | ( FTDI_SIO_SET_DTR_MASK << 8))
178 #define FTDI_SIO_SET_DTR_LOW (0 | ( FTDI_SIO_SET_DTR_MASK << 8))
179 #define FTDI_SIO_SET_RTS_MASK 0x2
180 #define FTDI_SIO_SET_RTS_HIGH (2 | ( FTDI_SIO_SET_RTS_MASK << 8))
181 #define FTDI_SIO_SET_RTS_LOW (0 | ( FTDI_SIO_SET_RTS_MASK << 8))
185 * BmRequestType: 0100 0000b
186 * bRequest: FTDI_SIO_SET_FLOW_CTRL
188 * wIndex: Protocol/Port - hIndex is protocl / lIndex is port
192 * hIndex protocol is:
193 * B0 Output handshaking using RTS/CTS
196 * B1 Output handshaking using DTR/DSR
199 * B2 Xon/Xoff handshaking
203 * A value of zero in the hIndex field disables handshaking
205 * If Xon/Xoff handshaking is specified, the hValue field should contain the
206 * XOFF character and the lValue field contains the XON character.
208 /* FTDI_SIO_SET_FLOW_CTRL */
209 #define FTDI_SIO_DISABLE_FLOW_CTRL 0x0
210 #define FTDI_SIO_RTS_CTS_HS 0x1
211 #define FTDI_SIO_DTR_DSR_HS 0x2
212 #define FTDI_SIO_XON_XOFF_HS 0x4
216 * BmRequestType: 0100 0000b
217 * bRequest: FTDI_SIO_SET_EVENT_CHAR
224 * B0..7 Event Character
225 * B8 Event Character Processing
230 * FTDI_SIO_SET_EVENT_CHAR
232 * Set the special event character for the specified communications port.
233 * If the device sees this character it will immediately return the
234 * data read so far - rather than wait 40ms or until 62 bytes are read
235 * which is what normally happens.
241 * BmRequestType: 0100 0000b
242 * bRequest: FTDI_SIO_SET_ERROR_CHAR
249 * B0..7 Error Character
250 * B8 Error Character Processing
256 * FTDI_SIO_SET_ERROR_CHAR
257 * Set the parity error replacement character for the specified communications
263 * BmRequestType: 1100 0000b
264 * bRequest: FTDI_SIO_GET_MODEM_STATUS
270 * One byte of data is returned
278 * B6 Ring Indicator (RI)
281 * B7 Receive Line Signal Detect (RLSD)
285 * FTDI_SIO_GET_MODEM_STATUS
286 * Retrieve the current value of the modem status register.
288 #define FTDI_SIO_CTS_MASK 0x10
289 #define FTDI_SIO_DSR_MASK 0x20
290 #define FTDI_SIO_RI_MASK 0x40
291 #define FTDI_SIO_RLSD_MASK 0x80
301 * The device reserves the first two bytes of data on this endpoint to contain
302 * the current values of the modem and line status registers. In the absence of
303 * data, the device generates a message consisting of these two status bytes
306 * Byte 0: Modem Status
307 * NOTE: 4 upper bits have same layout as the MSR register in a 16550
311 * B4 Clear to Send (CTS)
312 * B5 Data Set Ready (DSR)
313 * B6 Ring Indicator (RI)
314 * B7 Receive Line Signal Detect (RLSD)
316 * Byte 1: Line Status
317 * NOTE: same layout as the LSR register in a 16550
321 * B1 Overrun Error (OE)
322 * B2 Parity Error (PE)
323 * B3 Framing Error (FE)
324 * B4 Break Interrupt (BI)
325 * B5 Transmitter Holding Register (THRE)
326 * B6 Transmitter Empty (TEMT)
327 * B7 Error in RCVR FIFO
332 * This device reserves the first bytes of data on this endpoint contain the
333 * length and port identifier of the message. For the FTDI USB Serial converter
334 * the port identifier is always 1.
336 * Byte 0: Port & length
340 * B2..7 Length of message - (not including Byte 0)
343 #define FTDI_PORT_MASK 0x0f
344 #define FTDI_MSR_MASK 0xf0
345 #define FTDI_GET_MSR(p) (((p)[0]) & FTDI_MSR_MASK)
346 #define FTDI_GET_LSR(p) ((p)[1])
347 #define FTDI_LSR_MASK (~0x60) /* interesting bits */
348 #define FTDI_OUT_TAG(len, port) (((len) << 2) | (port))