1 /* $NetBSD: uftdireg.h,v 1.6 2002/07/11 21:14:28 augustss Exp $ */ 2 /* $FreeBSD$ */ 3 4 /* 5 * Definitions for the FTDI USB Single Port Serial Converter - 6 * known as FTDI_SIO (Serial Input/Output application of the chipset) 7 * 8 * The device is based on the FTDI FT8U100AX chip. It has a DB25 on one side, 9 * USB on the other. 10 * 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 13 * during development. 14 * 15 * Bill Ryder - bryder@sgi.com of Silicon Graphics, Inc. is the original 16 * author of this file. 17 */ 18 /* Modified by Lennart Augustsson */ 19 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 26 * port */ 27 #define FTDI_SIO_GET_STATUS 5 /* Retrieve current value of status 28 * reg */ 29 #define FTDI_SIO_SET_EVENT_CHAR 6 /* Set the event character */ 30 #define FTDI_SIO_SET_ERROR_CHAR 7 /* Set the error character */ 31 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 */ 37 38 enum uftdi_type { 39 UFTDI_TYPE_SIO, 40 UFTDI_TYPE_8U232AM 41 }; 42 43 /* 44 * BmRequestType: 0100 0000B 45 * bRequest: FTDI_SIO_RESET 46 * wValue: Control Value 47 * 0 = Reset SIO 48 * 1 = Purge RX buffer 49 * 2 = Purge TX buffer 50 * wIndex: Port 51 * wLength: 0 52 * Data: None 53 * 54 * The Reset SIO command has this effect: 55 * 56 * Sets flow control set to 'none' 57 * Event char = 0x0d 58 * Event trigger = disabled 59 * Purge RX buffer 60 * Purge TX buffer 61 * Clear DTR 62 * Clear RTS 63 * baud and data format not reset 64 * 65 * The Purge RX and TX buffer commands affect nothing except the buffers 66 * 67 */ 68 /* FTDI_SIO_RESET */ 69 #define FTDI_SIO_RESET_SIO 0 70 #define FTDI_SIO_RESET_PURGE_RX 1 71 #define FTDI_SIO_RESET_PURGE_TX 2 72 73 74 /* 75 * BmRequestType: 0100 0000B 76 * bRequest: FTDI_SIO_SET_BAUDRATE 77 * wValue: BaudRate value - see below 78 * wIndex: Port 79 * wLength: 0 80 * Data: None 81 */ 82 /* FTDI_SIO_SET_BAUDRATE */ 83 enum { 84 ftdi_sio_b300 = 0, 85 ftdi_sio_b600 = 1, 86 ftdi_sio_b1200 = 2, 87 ftdi_sio_b2400 = 3, 88 ftdi_sio_b4800 = 4, 89 ftdi_sio_b9600 = 5, 90 ftdi_sio_b19200 = 6, 91 ftdi_sio_b38400 = 7, 92 ftdi_sio_b57600 = 8, 93 ftdi_sio_b115200 = 9 94 }; 95 96 #define FTDI_8U232AM_FREQ 3000000 97 98 /* Bounds for normal divisors as 4-bit fixed precision ints. */ 99 #define FTDI_8U232AM_MIN_DIV 0x20 100 #define FTDI_8U232AM_MAX_DIV 0x3fff8 101 102 /* 103 * BmRequestType: 0100 0000B 104 * bRequest: FTDI_SIO_SET_DATA 105 * wValue: Data characteristics (see below) 106 * wIndex: Port 107 * wLength: 0 108 * Data: No 109 * 110 * Data characteristics 111 * 112 * B0..7 Number of data bits 113 * B8..10 Parity 114 * 0 = None 115 * 1 = Odd 116 * 2 = Even 117 * 3 = Mark 118 * 4 = Space 119 * B11..13 Stop Bits 120 * 0 = 1 121 * 1 = 1.5 122 * 2 = 2 123 * B14..15 Reserved 124 * 125 */ 126 /* FTDI_SIO_SET_DATA */ 127 #define FTDI_SIO_SET_DATA_BITS(n) (n) 128 #define FTDI_SIO_SET_DATA_PARITY_NONE (0x0 << 8) 129 #define FTDI_SIO_SET_DATA_PARITY_ODD (0x1 << 8) 130 #define FTDI_SIO_SET_DATA_PARITY_EVEN (0x2 << 8) 131 #define FTDI_SIO_SET_DATA_PARITY_MARK (0x3 << 8) 132 #define FTDI_SIO_SET_DATA_PARITY_SPACE (0x4 << 8) 133 #define FTDI_SIO_SET_DATA_STOP_BITS_1 (0x0 << 11) 134 #define FTDI_SIO_SET_DATA_STOP_BITS_15 (0x1 << 11) 135 #define FTDI_SIO_SET_DATA_STOP_BITS_2 (0x2 << 11) 136 #define FTDI_SIO_SET_BREAK (0x1 << 14) 137 138 139 /* 140 * BmRequestType: 0100 0000B 141 * bRequest: FTDI_SIO_MODEM_CTRL 142 * wValue: ControlValue (see below) 143 * wIndex: Port 144 * wLength: 0 145 * Data: None 146 * 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 150 * 151 * ControlValue 152 * B0 DTR state 153 * 0 = reset 154 * 1 = set 155 * B1 RTS state 156 * 0 = reset 157 * 1 = set 158 * B2..7 Reserved 159 * B8 DTR state enable 160 * 0 = ignore 161 * 1 = use DTR state 162 * B9 RTS state enable 163 * 0 = ignore 164 * 1 = use RTS state 165 * B10..15 Reserved 166 */ 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)) 174 175 176 /* 177 * BmRequestType: 0100 0000b 178 * bRequest: FTDI_SIO_SET_FLOW_CTRL 179 * wValue: Xoff/Xon 180 * wIndex: Protocol/Port - hIndex is protocl / lIndex is port 181 * wLength: 0 182 * Data: None 183 * 184 * hIndex protocol is: 185 * B0 Output handshaking using RTS/CTS 186 * 0 = disabled 187 * 1 = enabled 188 * B1 Output handshaking using DTR/DSR 189 * 0 = disabled 190 * 1 = enabled 191 * B2 Xon/Xoff handshaking 192 * 0 = disabled 193 * 1 = enabled 194 * 195 * A value of zero in the hIndex field disables handshaking 196 * 197 * If Xon/Xoff handshaking is specified, the hValue field should contain the 198 * XOFF character and the lValue field contains the XON character. 199 */ 200 /* FTDI_SIO_SET_FLOW_CTRL */ 201 #define FTDI_SIO_DISABLE_FLOW_CTRL 0x0 202 #define FTDI_SIO_RTS_CTS_HS 0x1 203 #define FTDI_SIO_DTR_DSR_HS 0x2 204 #define FTDI_SIO_XON_XOFF_HS 0x4 205 206 207 /* 208 * BmRequestType: 0100 0000b 209 * bRequest: FTDI_SIO_SET_EVENT_CHAR 210 * wValue: Event Char 211 * wIndex: Port 212 * wLength: 0 213 * Data: None 214 * 215 * wValue: 216 * B0..7 Event Character 217 * B8 Event Character Processing 218 * 0 = disabled 219 * 1 = enabled 220 * B9..15 Reserved 221 * 222 * FTDI_SIO_SET_EVENT_CHAR 223 * 224 * Set the special event character for the specified communications port. 225 * If the device sees this character it will immediately return the 226 * data read so far - rather than wait 40ms or until 62 bytes are read 227 * which is what normally happens. 228 */ 229 230 231 232 /* 233 * BmRequestType: 0100 0000b 234 * bRequest: FTDI_SIO_SET_ERROR_CHAR 235 * wValue: Error Char 236 * wIndex: Port 237 * wLength: 0 238 * Data: None 239 * 240 * Error Char 241 * B0..7 Error Character 242 * B8 Error Character Processing 243 * 0 = disabled 244 * 1 = enabled 245 * B9..15 Reserved 246 * 247 * 248 * FTDI_SIO_SET_ERROR_CHAR 249 * Set the parity error replacement character for the specified communications 250 * port. 251 */ 252 253 254 /* 255 * BmRequestType: 1100 0000b 256 * bRequest: FTDI_SIO_GET_MODEM_STATUS 257 * wValue: zero 258 * wIndex: Port 259 * wLength: 1 260 * Data: Status 261 * 262 * One byte of data is returned 263 * B0..3 0 264 * B4 CTS 265 * 0 = inactive 266 * 1 = active 267 * B5 DSR 268 * 0 = inactive 269 * 1 = active 270 * B6 Ring Indicator (RI) 271 * 0 = inactive 272 * 1 = active 273 * B7 Receive Line Signal Detect (RLSD) 274 * 0 = inactive 275 * 1 = active 276 * 277 * FTDI_SIO_GET_MODEM_STATUS 278 * Retrieve the current value of the modem status register. 279 */ 280 #define FTDI_SIO_CTS_MASK 0x10 281 #define FTDI_SIO_DSR_MASK 0x20 282 #define FTDI_SIO_RI_MASK 0x40 283 #define FTDI_SIO_RLSD_MASK 0x80 284 285 286 287 /* 288 * 289 * DATA FORMAT 290 * 291 * IN Endpoint 292 * 293 * The device reserves the first two bytes of data on this endpoint to contain 294 * the current values of the modem and line status registers. In the absence of 295 * data, the device generates a message consisting of these two status bytes 296 * every 40 ms. 297 * 298 * Byte 0: Modem Status 299 * NOTE: 4 upper bits have same layout as the MSR register in a 16550 300 * 301 * Offset Description 302 * B0..3 Port 303 * B4 Clear to Send (CTS) 304 * B5 Data Set Ready (DSR) 305 * B6 Ring Indicator (RI) 306 * B7 Receive Line Signal Detect (RLSD) 307 * 308 * Byte 1: Line Status 309 * NOTE: same layout as the LSR register in a 16550 310 * 311 * Offset Description 312 * B0 Data Ready (DR) 313 * B1 Overrun Error (OE) 314 * B2 Parity Error (PE) 315 * B3 Framing Error (FE) 316 * B4 Break Interrupt (BI) 317 * B5 Transmitter Holding Register (THRE) 318 * B6 Transmitter Empty (TEMT) 319 * B7 Error in RCVR FIFO 320 * 321 * 322 * OUT Endpoint 323 * 324 * This device reserves the first bytes of data on this endpoint contain the 325 * length and port identifier of the message. For the FTDI USB Serial converter 326 * the port identifier is always 1. 327 * 328 * Byte 0: Port & length 329 * 330 * Offset Description 331 * B0..1 Port 332 * B2..7 Length of message - (not including Byte 0) 333 * 334 */ 335 #define FTDI_PORT_MASK 0x0f 336 #define FTDI_MSR_MASK 0xf0 337 #define FTDI_GET_MSR(p) (((p)[0]) & FTDI_MSR_MASK) 338 #define FTDI_GET_LSR(p) ((p)[1]) 339 #define FTDI_LSR_MASK (~0x60) /* interesting bits */ 340 #define FTDI_OUT_TAG(len, port) (((len) << 2) | (port)) 341