| blob | 7417d5ce1e23918145f3ff0ad1e185f7233b9dda |
1 /*
2 * Definitions for MCT (Magic Control Technology) USB-RS232 Converter Driver
3 *
4 * Copyright (C) 2000 Wolfgang Grandegger (wolfgang@ces.ch)
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This driver is for the device MCT USB-RS232 Converter (25 pin, Model No.
12 * U232-P25) from Magic Control Technology Corp. (there is also a 9 pin
13 * Model No. U232-P9). See http://www.mct.com.tw/p_u232.html for further
14 * information. The properties of this device are listed at the end of this
15 * file. This device is available from various distributors. I know Hana,
16 * http://www.hana.de and D-Link, http://www.dlink.com/products/usb/dsbs25.
17 *
18 * All of the information about the device was acquired by using SniffUSB
19 * on Windows98. The technical details of the reverse engineering are
20 * summarized at the end of this file.
21 */
23 #ifndef __LINUX_USB_SERIAL_MCT_U232_H
24 #define __LINUX_USB_SERIAL_MCT_U232_H
29 /* U232-P25, Sitecom */
32 /* DU-H3SP USB BAY hub */
35 /* Belkin badge the MCT U232-P9 as the F5U109 */
39 /*
40 * Vendor Request Interface
41 */
42 #define MCT_U232_SET_REQUEST_TYPE 0x40
43 #define MCT_U232_GET_REQUEST_TYPE 0xc0
46 #define MCT_U232_GET_MODEM_STAT_SIZE 1
52 #define MCT_U232_SET_BAUD_RATE_SIZE 4
55 #define MCT_U232_SET_LINE_CTRL_SIZE 1
58 #define MCT_U232_SET_MODEM_CTRL_SIZE 1
60 /* This USB device request code is not well understood. It is transmitted by
61 the MCT-supplied Windows driver whenever the baud rate changes.
62 */
64 #define MCT_U232_SET_UNKNOWN1_SIZE 1
66 /* This USB device request code appears to control whether CTS is required
67 during transmission.
69 Sending a zero byte allows data transmission to a device which is not
70 asserting CTS. Sending a '1' byte will cause transmission to be deferred
71 until the device asserts CTS.
72 */
73 #define MCT_U232_SET_CTS_REQUEST 12
74 #define MCT_U232_SET_CTS_SIZE 1
78 /*
79 * Baud rate (divisor)
80 * Actually, there are two of them, MCT website calls them "Philips solution"
81 * and "Intel solution". They are the regular MCT and "Sitecom" for us.
82 * This is pointless to document in the header, see the code for the bits.
83 */
84 static int mct_u232_calculate_baud_rate(struct usb_serial *serial, speed_t value, speed_t *result);
86 /*
87 * Line Control Register (LCR)
88 */
89 #define MCT_U232_SET_BREAK 0x40
91 #define MCT_U232_PARITY_SPACE 0x38
92 #define MCT_U232_PARITY_MARK 0x28
93 #define MCT_U232_PARITY_EVEN 0x18
94 #define MCT_U232_PARITY_ODD 0x08
95 #define MCT_U232_PARITY_NONE 0x00
97 #define MCT_U232_DATA_BITS_5 0x00
98 #define MCT_U232_DATA_BITS_6 0x01
99 #define MCT_U232_DATA_BITS_7 0x02
100 #define MCT_U232_DATA_BITS_8 0x03
102 #define MCT_U232_STOP_BITS_2 0x04
103 #define MCT_U232_STOP_BITS_1 0x00
105 /*
106 * Modem Control Register (MCR)
107 */
112 /*
113 * Modem Status Register (MSR)
114 */
125 /*
126 * Line Status Register (LSR)
127 */
140 /* -----------------------------------------------------------------------------
141 * Technical Specification reverse engineered with SniffUSB on Windows98
142 * =====================================================================
143 *
144 * The technical details of the device have been acquired be using "SniffUSB"
145 * and the vendor-supplied device driver (version 2.3A) under Windows98. To
146 * identify the USB vendor-specific requests and to assign them to terminal
147 * settings (flow control, baud rate, etc.) the program "SerialSettings" from
148 * William G. Greathouse has been proven to be very useful. I also used the
149 * Win98 "HyperTerminal" and "usb-robot" on Linux for testing. The results and
150 * observations are summarized below:
151 *
152 * The USB requests seem to be directly mapped to the registers of a 8250,
153 * 16450 or 16550 UART. The FreeBSD handbook (appendix F.4 "Input/Output
154 * devices") contains a comprehensive description of UARTs and its registers.
155 * The bit descriptions are actually taken from there.
156 *
157 *
158 * Baud rate (divisor)
159 * -------------------
160 *
161 * BmRequestType: 0x40 (0100 0000B)
162 * bRequest: 0x05
163 * wValue: 0x0000
164 * wIndex: 0x0000
165 * wLength: 0x0004
166 * Data: divisor = 115200 / baud_rate
167 *
168 * SniffUSB observations (Nov 2003): Contrary to the 'wLength' value of 4
169 * shown above, observations with a Belkin F5U109 adapter, using the
170 * MCT-supplied Windows98 driver (U2SPORT.VXD, "File version: 1.21P.0104 for
171 * Win98/Me"), show this request has a length of 1 byte, presumably because
172 * of the fact that the Belkin adapter and the 'Sitecom U232-P25' adapter
173 * use a baud-rate code instead of a conventional RS-232 baud rate divisor.
174 * The current source code for this driver does not reflect this fact, but
175 * the driver works fine with this adapter/driver combination nonetheless.
176 *
177 *
178 * Line Control Register (LCR)
179 * ---------------------------
180 *
181 * BmRequestType: 0x40 (0100 0000B) 0xc0 (1100 0000B)
182 * bRequest: 0x07 0x06
183 * wValue: 0x0000
184 * wIndex: 0x0000
185 * wLength: 0x0001
186 * Data: LCR (see below)
187 *
188 * Bit 7: Divisor Latch Access Bit (DLAB). When set, access to the data
189 * transmit/receive register (THR/RBR) and the Interrupt Enable Register
190 * (IER) is disabled. Any access to these ports is now redirected to the
191 * Divisor Latch Registers. Setting this bit, loading the Divisor
192 * Registers, and clearing DLAB should be done with interrupts disabled.
193 * Bit 6: Set Break. When set to "1", the transmitter begins to transmit
194 * continuous Spacing until this bit is set to "0". This overrides any
195 * bits of characters that are being transmitted.
196 * Bit 5: Stick Parity. When parity is enabled, setting this bit causes parity
197 * to always be "1" or "0", based on the value of Bit 4.
198 * Bit 4: Even Parity Select (EPS). When parity is enabled and Bit 5 is "0",
199 * setting this bit causes even parity to be transmitted and expected.
200 * Otherwise, odd parity is used.
201 * Bit 3: Parity Enable (PEN). When set to "1", a parity bit is inserted
202 * between the last bit of the data and the Stop Bit. The UART will also
203 * expect parity to be present in the received data.
204 * Bit 2: Number of Stop Bits (STB). If set to "1" and using 5-bit data words,
205 * 1.5 Stop Bits are transmitted and expected in each data word. For
206 * 6, 7 and 8-bit data words, 2 Stop Bits are transmitted and expected.
207 * When this bit is set to "0", one Stop Bit is used on each data word.
208 * Bit 1: Word Length Select Bit #1 (WLSB1)
209 * Bit 0: Word Length Select Bit #0 (WLSB0)
210 * Together these bits specify the number of bits in each data word.
211 * 1 0 Word Length
212 * 0 0 5 Data Bits
213 * 0 1 6 Data Bits
214 * 1 0 7 Data Bits
215 * 1 1 8 Data Bits
216 *
217 * SniffUSB observations: Bit 7 seems not to be used. There seem to be two bugs
218 * in the Win98 driver: the break does not work (bit 6 is not asserted) and the
219 * stick parity bit is not cleared when set once. The LCR can also be read
220 * back with USB request 6 but this has never been observed with SniffUSB.
221 *
222 *
223 * Modem Control Register (MCR)
224 * ----------------------------
225 *
226 * BmRequestType: 0x40 (0100 0000B)
227 * bRequest: 0x0a
228 * wValue: 0x0000
229 * wIndex: 0x0000
230 * wLength: 0x0001
231 * Data: MCR (Bit 4..7, see below)
232 *
233 * Bit 7: Reserved, always 0.
234 * Bit 6: Reserved, always 0.
235 * Bit 5: Reserved, always 0.
236 * Bit 4: Loop-Back Enable. When set to "1", the UART transmitter and receiver
237 * are internally connected together to allow diagnostic operations. In
238 * addition, the UART modem control outputs are connected to the UART
239 * modem control inputs. CTS is connected to RTS, DTR is connected to
240 * DSR, OUT1 is connected to RI, and OUT 2 is connected to DCD.
241 * Bit 3: OUT 2. An auxiliary output that the host processor may set high or
242 * low. In the IBM PC serial adapter (and most clones), OUT 2 is used
243 * to tri-state (disable) the interrupt signal from the
244 * 8250/16450/16550 UART.
245 * Bit 2: OUT 1. An auxiliary output that the host processor may set high or
246 * low. This output is not used on the IBM PC serial adapter.
247 * Bit 1: Request to Send (RTS). When set to "1", the output of the UART -RTS
248 * line is Low (Active).
249 * Bit 0: Data Terminal Ready (DTR). When set to "1", the output of the UART
250 * -DTR line is Low (Active).
251 *
252 * SniffUSB observations: Bit 2 and 4 seem not to be used but bit 3 has been
253 * seen _always_ set.
254 *
255 *
256 * Modem Status Register (MSR)
257 * ---------------------------
258 *
259 * BmRequestType: 0xc0 (1100 0000B)
260 * bRequest: 0x02
261 * wValue: 0x0000
262 * wIndex: 0x0000
263 * wLength: 0x0001
264 * Data: MSR (see below)
265 *
266 * Bit 7: Data Carrier Detect (CD). Reflects the state of the DCD line on the
267 * UART.
268 * Bit 6: Ring Indicator (RI). Reflects the state of the RI line on the UART.
269 * Bit 5: Data Set Ready (DSR). Reflects the state of the DSR line on the UART.
270 * Bit 4: Clear To Send (CTS). Reflects the state of the CTS line on the UART.
271 * Bit 3: Delta Data Carrier Detect (DDCD). Set to "1" if the -DCD line has
272 * changed state one more more times since the last time the MSR was
273 * read by the host.
274 * Bit 2: Trailing Edge Ring Indicator (TERI). Set to "1" if the -RI line has
275 * had a low to high transition since the last time the MSR was read by
276 * the host.
277 * Bit 1: Delta Data Set Ready (DDSR). Set to "1" if the -DSR line has changed
278 * state one more more times since the last time the MSR was read by the
279 * host.
280 * Bit 0: Delta Clear To Send (DCTS). Set to "1" if the -CTS line has changed
281 * state one more times since the last time the MSR was read by the
282 * host.
283 *
284 * SniffUSB observations: the MSR is also returned as first byte on the
285 * interrupt-in endpoint 0x83 to signal changes of modem status lines. The USB
286 * request to read MSR cannot be applied during normal device operation.
287 *
288 *
289 * Line Status Register (LSR)
290 * --------------------------
291 *
292 * Bit 7 Error in Receiver FIFO. On the 8250/16450 UART, this bit is zero.
293 * This bit is set to "1" when any of the bytes in the FIFO have one or
294 * more of the following error conditions: PE, FE, or BI.
295 * Bit 6 Transmitter Empty (TEMT). When set to "1", there are no words
296 * remaining in the transmit FIFO or the transmit shift register. The
297 * transmitter is completely idle.
298 * Bit 5 Transmitter Holding Register Empty (THRE). When set to "1", the FIFO
299 * (or holding register) now has room for at least one additional word
300 * to transmit. The transmitter may still be transmitting when this bit
301 * is set to "1".
302 * Bit 4 Break Interrupt (BI). The receiver has detected a Break signal.
303 * Bit 3 Framing Error (FE). A Start Bit was detected but the Stop Bit did not
304 * appear at the expected time. The received word is probably garbled.
305 * Bit 2 Parity Error (PE). The parity bit was incorrect for the word received.
306 * Bit 1 Overrun Error (OE). A new word was received and there was no room in
307 * the receive buffer. The newly-arrived word in the shift register is
308 * discarded. On 8250/16450 UARTs, the word in the holding register is
309 * discarded and the newly- arrived word is put in the holding register.
310 * Bit 0 Data Ready (DR). One or more words are in the receive FIFO that the
311 * host may read. A word must be completely received and moved from the
312 * shift register into the FIFO (or holding register for 8250/16450
313 * designs) before this bit is set.
314 *
315 * SniffUSB observations: the LSR is returned as second byte on the interrupt-in
316 * endpoint 0x83 to signal error conditions. Such errors have been seen with
317 * minicom/zmodem transfers (CRC errors).
318 *
319 *
320 * Unknown #1
321 * -------------------
322 *
323 * BmRequestType: 0x40 (0100 0000B)
324 * bRequest: 0x0b
325 * wValue: 0x0000
326 * wIndex: 0x0000
327 * wLength: 0x0001
328 * Data: 0x00
329 *
330 * SniffUSB observations (Nov 2003): With the MCT-supplied Windows98 driver
331 * (U2SPORT.VXD, "File version: 1.21P.0104 for Win98/Me"), this request
332 * occurs immediately after a "Baud rate (divisor)" message. It was not
333 * observed at any other time. It is unclear what purpose this message
334 * serves.
335 *
336 *
337 * Unknown #2
338 * -------------------
339 *
340 * BmRequestType: 0x40 (0100 0000B)
341 * bRequest: 0x0c
342 * wValue: 0x0000
343 * wIndex: 0x0000
344 * wLength: 0x0001
345 * Data: 0x00
346 *
347 * SniffUSB observations (Nov 2003): With the MCT-supplied Windows98 driver
348 * (U2SPORT.VXD, "File version: 1.21P.0104 for Win98/Me"), this request
349 * occurs immediately after the 'Unknown #1' message (see above). It was
350 * not observed at any other time. It is unclear what other purpose (if
351 * any) this message might serve, but without it, the USB/RS-232 adapter
352 * will not write to RS-232 devices which do not assert the 'CTS' signal.
353 *
354 *
355 * Flow control
356 * ------------
357 *
358 * SniffUSB observations: no flow control specific requests have been realized
359 * apart from DTR/RTS settings. Both signals are dropped for no flow control
360 * but asserted for hardware or software flow control.
361 *
362 *
363 * Endpoint usage
364 * --------------
365 *
366 * SniffUSB observations: the bulk-out endpoint 0x1 and interrupt-in endpoint
367 * 0x81 is used to transmit and receive characters. The second interrupt-in
368 * endpoint 0x83 signals exceptional conditions like modem line changes and
369 * errors. The first byte returned is the MSR and the second byte the LSR.
370 *
371 *
372 * Other observations
373 * ------------------
374 *
375 * Queued bulk transfers like used in visor.c did not work.
376 *
377 *
378 * Properties of the USB device used (as found in /var/log/messages)
379 * -----------------------------------------------------------------
380 *
381 * Manufacturer: MCT Corporation.
382 * Product: USB-232 Interfact Controller
383 * SerialNumber: U2S22050
384 *
385 * Length = 18
386 * DescriptorType = 01
387 * USB version = 1.00
388 * Vendor:Product = 0711:0210
389 * MaxPacketSize0 = 8
390 * NumConfigurations = 1
391 * Device version = 1.02
392 * Device Class:SubClass:Protocol = 00:00:00
393 * Per-interface classes
394 * Configuration:
395 * bLength = 9
396 * bDescriptorType = 02
397 * wTotalLength = 0027
398 * bNumInterfaces = 01
399 * bConfigurationValue = 01
400 * iConfiguration = 00
401 * bmAttributes = c0
402 * MaxPower = 100mA
403 *
404 * Interface: 0
405 * Alternate Setting: 0
406 * bLength = 9
407 * bDescriptorType = 04
408 * bInterfaceNumber = 00
409 * bAlternateSetting = 00
410 * bNumEndpoints = 03
411 * bInterface Class:SubClass:Protocol = 00:00:00
412 * iInterface = 00
413 * Endpoint:
414 * bLength = 7
415 * bDescriptorType = 05
416 * bEndpointAddress = 81 (in)
417 * bmAttributes = 03 (Interrupt)
418 * wMaxPacketSize = 0040
419 * bInterval = 02
420 * Endpoint:
421 * bLength = 7
422 * bDescriptorType = 05
423 * bEndpointAddress = 01 (out)
424 * bmAttributes = 02 (Bulk)
425 * wMaxPacketSize = 0040
426 * bInterval = 00
427 * Endpoint:
428 * bLength = 7
429 * bDescriptorType = 05
430 * bEndpointAddress = 83 (in)
431 * bmAttributes = 03 (Interrupt)
432 * wMaxPacketSize = 0002
433 * bInterval = 02
434 *
435 *
436 * Hardware details (added by Martin Hamilton, 2001/12/06)
437 * -----------------------------------------------------------------
438 *
439 * This info was gleaned from opening a Belkin F5U109 DB9 USB serial
440 * adaptor, which turns out to simply be a re-badged U232-P9. We
441 * know this because there is a sticky label on the circuit board
442 * which says "U232-P9" ;-)
443 *
444 * The circuit board inside the adaptor contains a Philips PDIUSBD12
445 * USB endpoint chip and a Philips P87C52UBAA microcontroller with
446 * embedded UART. Exhaustive documentation for these is available at:
447 *
448 * http://www.semiconductors.philips.com/pip/p87c52ubaa
449 * http://www.semiconductors.philips.com/pip/pdiusbd12
450 *
451 * Thanks to Julian Highfield for the pointer to the Philips database.
452 *
453 */