1 /* $NetBSD: uftdireg.h,v 1.6 2002/07/11 21:14:28 augustss 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
27 #define FTDI_SIO_GET_STATUS 5 /* Retrieve current value of status
29 #define FTDI_SIO_SET_EVENT_CHAR 6 /* Set the event character */
30 #define FTDI_SIO_SET_ERROR_CHAR 7 /* Set the error character */
32 /* Port Identifier Table */
33 #define FTDI_PIT_DEFAULT 0 /* SIOA */
34 #define FTDI_PIT_SIOA 1 /* SIOA */
35 #define FTDI_PIT_SIOB 2 /* SIOB */
36 #define FTDI_PIT_PARALLEL 3 /* Parallel */
38 /* Values for driver_info */
39 #define UFTDI_TYPE_MASK 0x000000ff
40 #define UFTDI_TYPE_SIO 0x00000001
41 #define UFTDI_TYPE_8U232AM 0x00000002
42 #define UFTDI_TYPE_AUTO (UFTDI_TYPE_SIO | UFTDI_TYPE_8U232AM)
43 #define UFTDI_FLAG_MASK 0x0000ff00
44 #define UFTDI_FLAG_JTAG 0x00000100
47 * BmRequestType: 0100 0000B
48 * bRequest: FTDI_SIO_RESET
49 * wValue: Control Value
57 * The Reset SIO command has this effect:
59 * Sets flow control set to 'none'
61 * Event trigger = disabled
66 * baud and data format not reset
68 * The Purge RX and TX buffer commands affect nothing except the buffers
71 #define FTDI_SIO_RESET_SIO 0
72 #define FTDI_SIO_RESET_PURGE_RX 1
73 #define FTDI_SIO_RESET_PURGE_TX 2
76 * BmRequestType: 0100 0000B
77 * bRequest: FTDI_SIO_SET_BAUDRATE
78 * wValue: BaudRate value - see below
83 /* FTDI_SIO_SET_BAUDRATE */
97 #define FTDI_8U232AM_FREQ 3000000
99 /* Bounds for normal divisors as 4-bit fixed precision ints. */
100 #define FTDI_8U232AM_MIN_DIV 0x20
101 #define FTDI_8U232AM_MAX_DIV 0x3fff8
104 * BmRequestType: 0100 0000B
105 * bRequest: FTDI_SIO_SET_DATA
106 * wValue: Data characteristics (see below)
111 * Data characteristics
113 * B0..7 Number of data bits
127 /* FTDI_SIO_SET_DATA */
128 #define FTDI_SIO_SET_DATA_BITS(n) (n)
129 #define FTDI_SIO_SET_DATA_PARITY_NONE (0x0 << 8)
130 #define FTDI_SIO_SET_DATA_PARITY_ODD (0x1 << 8)
131 #define FTDI_SIO_SET_DATA_PARITY_EVEN (0x2 << 8)
132 #define FTDI_SIO_SET_DATA_PARITY_MARK (0x3 << 8)
133 #define FTDI_SIO_SET_DATA_PARITY_SPACE (0x4 << 8)
134 #define FTDI_SIO_SET_DATA_STOP_BITS_1 (0x0 << 11)
135 #define FTDI_SIO_SET_DATA_STOP_BITS_15 (0x1 << 11)
136 #define FTDI_SIO_SET_DATA_STOP_BITS_2 (0x2 << 11)
137 #define FTDI_SIO_SET_BREAK (0x1 << 14)
140 * BmRequestType: 0100 0000B
141 * bRequest: FTDI_SIO_MODEM_CTRL
142 * wValue: ControlValue (see below)
147 * NOTE: If the device is in RTS/CTS flow control, the RTS set by this
148 * command will be IGNORED without an error being returned
149 * Also - you can not set DTR and RTS with one control message
159 * B8 DTR state enable
162 * B9 RTS state enable
167 /* FTDI_SIO_MODEM_CTRL */
168 #define FTDI_SIO_SET_DTR_MASK 0x1
169 #define FTDI_SIO_SET_DTR_HIGH (1 | ( FTDI_SIO_SET_DTR_MASK << 8))
170 #define FTDI_SIO_SET_DTR_LOW (0 | ( FTDI_SIO_SET_DTR_MASK << 8))
171 #define FTDI_SIO_SET_RTS_MASK 0x2
172 #define FTDI_SIO_SET_RTS_HIGH (2 | ( FTDI_SIO_SET_RTS_MASK << 8))
173 #define FTDI_SIO_SET_RTS_LOW (0 | ( FTDI_SIO_SET_RTS_MASK << 8))
176 * BmRequestType: 0100 0000b
177 * bRequest: FTDI_SIO_SET_FLOW_CTRL
179 * wIndex: Protocol/Port - hIndex is protocol / lIndex is port
183 * hIndex protocol is:
184 * B0 Output handshaking using RTS/CTS
187 * B1 Output handshaking using DTR/DSR
190 * B2 Xon/Xoff handshaking
194 * A value of zero in the hIndex field disables handshaking
196 * If Xon/Xoff handshaking is specified, the hValue field should contain the
197 * XOFF character and the lValue field contains the XON character.
199 /* FTDI_SIO_SET_FLOW_CTRL */
200 #define FTDI_SIO_DISABLE_FLOW_CTRL 0x0
201 #define FTDI_SIO_RTS_CTS_HS 0x1
202 #define FTDI_SIO_DTR_DSR_HS 0x2
203 #define FTDI_SIO_XON_XOFF_HS 0x4
206 * BmRequestType: 0100 0000b
207 * bRequest: FTDI_SIO_SET_EVENT_CHAR
214 * B0..7 Event Character
215 * B8 Event Character Processing
220 * FTDI_SIO_SET_EVENT_CHAR
222 * Set the special event character for the specified communications port.
223 * If the device sees this character it will immediately return the
224 * data read so far - rather than wait 40ms or until 62 bytes are read
225 * which is what normally happens.
229 * BmRequestType: 0100 0000b
230 * bRequest: FTDI_SIO_SET_ERROR_CHAR
237 * B0..7 Error Character
238 * B8 Error Character Processing
242 * FTDI_SIO_SET_ERROR_CHAR
243 * Set the parity error replacement character for the specified communications
248 * BmRequestType: 1100 0000b
249 * bRequest: FTDI_SIO_GET_MODEM_STATUS
255 * One byte of data is returned
263 * B6 Ring Indicator (RI)
266 * B7 Receive Line Signal Detect (RLSD)
270 * FTDI_SIO_GET_MODEM_STATUS
271 * Retrieve the current value of the modem status register.
273 #define FTDI_SIO_CTS_MASK 0x10
274 #define FTDI_SIO_DSR_MASK 0x20
275 #define FTDI_SIO_RI_MASK 0x40
276 #define FTDI_SIO_RLSD_MASK 0x80
283 * The device reserves the first two bytes of data on this endpoint to contain
284 * the current values of the modem and line status registers. In the absence of
285 * data, the device generates a message consisting of these two status bytes
288 * Byte 0: Modem Status
289 * NOTE: 4 upper bits have same layout as the MSR register in a 16550
293 * B4 Clear to Send (CTS)
294 * B5 Data Set Ready (DSR)
295 * B6 Ring Indicator (RI)
296 * B7 Receive Line Signal Detect (RLSD)
298 * Byte 1: Line Status
299 * NOTE: same layout as the LSR register in a 16550
303 * B1 Overrun Error (OE)
304 * B2 Parity Error (PE)
305 * B3 Framing Error (FE)
306 * B4 Break Interrupt (BI)
307 * B5 Transmitter Holding Register (THRE)
308 * B6 Transmitter Empty (TEMT)
309 * B7 Error in RCVR FIFO
312 * This device reserves the first bytes of data on this endpoint contain the
313 * length and port identifier of the message. For the FTDI USB Serial converter
314 * the port identifier is always 1.
316 * Byte 0: Port & length
320 * B2..7 Length of message - (not including Byte 0)
322 #define FTDI_PORT_MASK 0x0f
323 #define FTDI_MSR_MASK 0xf0
324 #define FTDI_GET_MSR(p) (((p)[0]) & FTDI_MSR_MASK)
325 #define FTDI_GET_LSR(p) ((p)[1])
326 #define FTDI_LSR_MASK (~0x60) /* interesting bits */
327 #define FTDI_OUT_TAG(len, port) (((len) << 2) | (port))