mct_u232.h
上传用户:lgb322
上传日期:2013-02-24
资源大小:30529k
文件大小:16k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  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.  */
  22. #ifndef __LINUX_USB_SERIAL_MCT_U232_H
  23. #define __LINUX_USB_SERIAL_MCT_U232_H
  24. #define MCT_U232_VID                 0x0711 /* Vendor Id */
  25. #define MCT_U232_PID                 0x0210 /* Original MCT Product Id */
  26. /* U232-P25, Sitecom */
  27. #define MCT_U232_SITECOM_PID 0x0230 /* Sitecom Product Id */
  28. /* DU-H3SP USB BAY hub */
  29. #define MCT_U232_DU_H3SP_PID 0x0200 /* D-Link DU-H3SP USB BAY */
  30. /* Belkin badge the MCT U232-P9 as the F5U109 */
  31. #define MCT_U232_BELKIN_F5U109_VID 0x050d /* Vendor Id */
  32. #define MCT_U232_BELKIN_F5U109_PID 0x0109 /* Product Id */
  33. /*
  34.  * Vendor Request Interface
  35.  */
  36. #define MCT_U232_SET_REQUEST_TYPE 0x40
  37. #define MCT_U232_GET_REQUEST_TYPE 0xc0
  38. #define MCT_U232_GET_MODEM_STAT_REQUEST 2  /* Get Modem Status Register (MSR) */
  39. #define MCT_U232_GET_MODEM_STAT_SIZE    1
  40. #define MCT_U232_GET_LINE_CTRL_REQUEST  6  /* Get Line Control Register (LCR) */
  41. #define MCT_U232_GET_LINE_CTRL_SIZE     1  /* ... not used by this driver */
  42. #define MCT_U232_SET_BAUD_RATE_REQUEST 5  /* Set Baud Rate Divisor */
  43. #define MCT_U232_SET_BAUD_RATE_SIZE     4
  44. #define MCT_U232_SET_LINE_CTRL_REQUEST 7  /* Set Line Control Register (LCR) */
  45. #define MCT_U232_SET_LINE_CTRL_SIZE     1
  46. #define MCT_U232_SET_MODEM_CTRL_REQUEST 10 /* Set Modem Control Register (MCR) */
  47. #define MCT_U232_SET_MODEM_CTRL_SIZE    1
  48. /*
  49.  * Baud rate (divisor)
  50.  */
  51. #define MCT_U232_BAUD_RATE(b) (115200/b)
  52. /*
  53.  * Line Control Register (LCR)
  54.  */
  55. #define MCT_U232_SET_BREAK              0x40
  56. #define MCT_U232_PARITY_SPACE 0x38
  57. #define MCT_U232_PARITY_MARK 0x28
  58. #define MCT_U232_PARITY_EVEN 0x18
  59. #define MCT_U232_PARITY_ODD 0x08
  60. #define MCT_U232_PARITY_NONE 0x00
  61. #define MCT_U232_DATA_BITS_5            0x00
  62. #define MCT_U232_DATA_BITS_6            0x01
  63. #define MCT_U232_DATA_BITS_7            0x02
  64. #define MCT_U232_DATA_BITS_8            0x03
  65. #define MCT_U232_STOP_BITS_2            0x04
  66. #define MCT_U232_STOP_BITS_1            0x00
  67. /*
  68.  * Modem Control Register (MCR)
  69.  */
  70. #define MCT_U232_MCR_NONE               0x8     /* Deactivate DTR and RTS */
  71. #define MCT_U232_MCR_RTS                0xa     /* Activate RTS */
  72. #define MCT_U232_MCR_DTR                0x9     /* Activate DTR */
  73. /*
  74.  * Modem Status Register (MSR)
  75.  */
  76. #define MCT_U232_MSR_INDEX              0x0     /* data[index] */
  77. #define MCT_U232_MSR_CD                 0x80    /* Current CD */
  78. #define MCT_U232_MSR_RI                 0x40    /* Current RI */
  79. #define MCT_U232_MSR_DSR                0x20    /* Current DSR */
  80. #define MCT_U232_MSR_CTS                0x10    /* Current CTS */
  81. #define MCT_U232_MSR_DCD                0x08    /* Delta CD */
  82. #define MCT_U232_MSR_DRI                0x04    /* Delta RI */
  83. #define MCT_U232_MSR_DDSR               0x02    /* Delta DSR */
  84. #define MCT_U232_MSR_DCTS               0x01    /* Delta CTS */
  85. /*
  86.  * Line Status Register (LSR)
  87.  */
  88. #define MCT_U232_LSR_INDEX              1       /* data[index] */
  89. #define MCT_U232_LSR_ERR                0x80    /* OE | PE | FE | BI */
  90. #define MCT_U232_LSR_TEMT               0x40    /* transmit register empty */
  91. #define MCT_U232_LSR_THRE               0x20    /* transmit holding register empty */
  92. #define MCT_U232_LSR_BI                 0x10    /* break indicator */
  93. #define MCT_U232_LSR_FE                 0x08    /* framing error */
  94. #define MCT_U232_LSR_OE                 0x02    /* overrun error */
  95. #define MCT_U232_LSR_PE                 0x04    /* parity error */
  96. #define MCT_U232_LSR_OE                 0x02    /* overrun error */
  97. #define MCT_U232_LSR_DR                 0x01    /* receive data ready */
  98. /* -----------------------------------------------------------------------------
  99.  * Technical Specification reverse engineered with SniffUSB on Windows98
  100.  * =====================================================================
  101.  *
  102.  *  The technical details of the device have been acquired be using "SniffUSB"
  103.  *  and the vendor-supplied device driver (version 2.3A) under Windows98. To
  104.  *  identify the USB vendor-specific requests and to assign them to terminal 
  105.  *  settings (flow control, baud rate, etc.) the program "SerialSettings" from
  106.  *  William G. Greathouse has been proven to be very useful. I also used the
  107.  *  Win98 "HyperTerminal" and "usb-robot" on Linux for testing. The results and 
  108.  *  observations are summarized below:
  109.  *
  110.  *  The USB requests seem to be directly mapped to the registers of a 8250,
  111.  *  16450 or 16550 UART. The FreeBSD handbook (appendix F.4 "Input/Output
  112.  *  devices") contains a comprehensive description of UARTs and its registers.
  113.  *  The bit descriptions are actually taken from there.
  114.  *
  115.  *
  116.  * Baud rate (divisor)
  117.  * -------------------
  118.  *
  119.  *   BmRequestType:  0x4 (0100 0000B)
  120.  *   bRequest:       0x5
  121.  *   wValue:         0x0
  122.  *   wIndex:         0x0
  123.  *   wLength:        0x4
  124.  *   Data:           divisor = 115200 / baud_rate
  125.  *
  126.  *
  127.  * Line Control Register (LCR)
  128.  * ---------------------------
  129.  *
  130.  *  BmRequestType:  0x4 (0100 0000B)    0xc (1100 0000B)
  131.  *  bRequest:       0x7                 0x6
  132.  *  wValue:         0x0
  133.  *  wIndex:         0x0
  134.  *  wLength:        0x1
  135.  *  Data:           LCR (see below)
  136.  *
  137.  *  Bit 7: Divisor Latch Access Bit (DLAB). When set, access to the data
  138.  *      transmit/receive register (THR/RBR) and the Interrupt Enable Register
  139.  *      (IER) is disabled. Any access to these ports is now redirected to the
  140.  *      Divisor Latch Registers. Setting this bit, loading the Divisor
  141.  *      Registers, and clearing DLAB should be done with interrupts disabled.
  142.  *  Bit 6: Set Break. When set to "1", the transmitter begins to transmit
  143.  *      continuous Spacing until this bit is set to "0". This overrides any
  144.  *      bits of characters that are being transmitted.
  145.  *  Bit 5: Stick Parity. When parity is enabled, setting this bit causes parity
  146.  *      to always be "1" or "0", based on the value of Bit 4.
  147.  *  Bit 4: Even Parity Select (EPS). When parity is enabled and Bit 5 is "0",
  148.  *      setting this bit causes even parity to be transmitted and expected.
  149.  *      Otherwise, odd parity is used.
  150.  *  Bit 3: Parity Enable (PEN). When set to "1", a parity bit is inserted
  151.  *      between the last bit of the data and the Stop Bit. The UART will also
  152.  *      expect parity to be present in the received data.
  153.  *  Bit 2: Number of Stop Bits (STB). If set to "1" and using 5-bit data words,
  154.  *      1.5 Stop Bits are transmitted and expected in each data word. For
  155.  *      6, 7 and 8-bit data words, 2 Stop Bits are transmitted and expected.
  156.  *      When this bit is set to "0", one Stop Bit is used on each data word.
  157.  *  Bit 1: Word Length Select Bit #1 (WLSB1)
  158.  *  Bit 0: Word Length Select Bit #0 (WLSB0)
  159.  *      Together these bits specify the number of bits in each data word.
  160.  *        1 0  Word Length
  161.  *        0 0  5 Data Bits
  162.  *        0 1  6 Data Bits
  163.  *        1 0  7 Data Bits
  164.  *        1 1  8 Data Bits
  165.  *
  166.  *  SniffUSB observations: Bit 7 seems not to be used. There seem to be two bugs
  167.  *  in the Win98 driver: the break does not work (bit 6 is not asserted) and the
  168.  *  sticky parity bit is not cleared when set once. The LCR can also be read
  169.  *  back with USB request 6 but this has never been observed with SniffUSB.
  170.  *
  171.  *
  172.  * Modem Control Register (MCR)
  173.  * ----------------------------
  174.  *
  175.  *  BmRequestType:  0x4  (0100 0000B)
  176.  *  bRequest:       0xa
  177.  *  wValue:         0x0
  178.  *  wIndex:         0x0
  179.  *  wLength:        0x1
  180.  *  Data:           MCR (Bit 4..7, see below)
  181.  *
  182.  *  Bit 7: Reserved, always 0.
  183.  *  Bit 6: Reserved, always 0.
  184.  *  Bit 5: Reserved, always 0.
  185.  *  Bit 4: Loop-Back Enable. When set to "1", the UART transmitter and receiver
  186.  *      are internally connected together to allow diagnostic operations. In
  187.  *      addition, the UART modem control outputs are connected to the UART
  188.  *      modem control inputs. CTS is connected to RTS, DTR is connected to
  189.  *      DSR, OUT1 is connected to RI, and OUT 2 is connected to DCD.
  190.  *  Bit 3: OUT 2. An auxiliary output that the host processor may set high or
  191.  *      low. In the IBM PC serial adapter (and most clones), OUT 2 is used
  192.  *      to tri-state (disable) the interrupt signal from the
  193.  *      8250/16450/16550 UART.
  194.  *  Bit 2: OUT 1. An auxiliary output that the host processor may set high or
  195.  *      low. This output is not used on the IBM PC serial adapter.
  196.  *  Bit 1: Request to Send (RTS). When set to "1", the output of the UART -RTS
  197.  *      line is Low (Active).
  198.  *  Bit 0: Data Terminal Ready (DTR). When set to "1", the output of the UART
  199.  *      -DTR line is Low (Active).
  200.  *
  201.  *  SniffUSB observations: Bit 2 and 4 seem not to be used but bit 3 has been
  202.  *  seen _always_ set.
  203.  *
  204.  *
  205.  * Modem Status Register (MSR)
  206.  * ---------------------------
  207.  *
  208.  *  BmRequestType:  0xc  (1100 0000B)
  209.  *  bRequest:       0x2
  210.  *  wValue:         0x0
  211.  *  wIndex:         0x0
  212.  *  wLength:        0x1
  213.  *  Data:           MSR (see below)
  214.  *
  215.  *  Bit 7: Data Carrier Detect (CD). Reflects the state of the DCD line on the
  216.  *      UART.
  217.  *  Bit 6: Ring Indicator (RI). Reflects the state of the RI line on the UART.
  218.  *  Bit 5: Data Set Ready (DSR). Reflects the state of the DSR line on the UART.
  219.  *  Bit 4: Clear To Send (CTS). Reflects the state of the CTS line on the UART.
  220.  *  Bit 3: Delta Data Carrier Detect (DDCD). Set to "1" if the -DCD line has
  221.  *      changed state one more more times since the last time the MSR was
  222.  *      read by the host.
  223.  *  Bit 2: Trailing Edge Ring Indicator (TERI). Set to "1" if the -RI line has
  224.  *      had a low to high transition since the last time the MSR was read by
  225.  *      the host.
  226.  *  Bit 1: Delta Data Set Ready (DDSR). Set to "1" if the -DSR line has changed
  227.  *      state one more more times since the last time the MSR was read by the
  228.  *      host.
  229.  *  Bit 0: Delta Clear To Send (DCTS). Set to "1" if the -CTS line has changed
  230.  *      state one more times since the last time the MSR was read by the
  231.  *      host.
  232.  *
  233.  *  SniffUSB observations: the MSR is also returned as first byte on the
  234.  *  interrupt-in endpoint 0x83 to signal changes of modem status lines. The USB
  235.  *  request to read MSR cannot be applied during normal device operation.
  236.  *
  237.  *
  238.  * Line Status Register (LSR)
  239.  * --------------------------
  240.  *
  241.  *  Bit 7   Error in Receiver FIFO. On the 8250/16450 UART, this bit is zero.
  242.  *       This bit is set to "1" when any of the bytes in the FIFO have one or
  243.  *       more of the following error conditions: PE, FE, or BI.
  244.  *  Bit 6   Transmitter Empty (TEMT). When set to "1", there are no words
  245.  *       remaining in the transmit FIFO or the transmit shift register. The
  246.  *       transmitter is completely idle.
  247.  *  Bit 5   Transmitter Holding Register Empty (THRE). When set to "1", the FIFO
  248.  *       (or holding register) now has room for at least one additional word
  249.  *       to transmit. The transmitter may still be transmitting when this bit
  250.  *       is set to "1".
  251.  *  Bit 4   Break Interrupt (BI). The receiver has detected a Break signal.
  252.  *  Bit 3   Framing Error (FE). A Start Bit was detected but the Stop Bit did not
  253.  *       appear at the expected time. The received word is probably garbled.
  254.  *  Bit 2   Parity Error (PE). The parity bit was incorrect for the word received.
  255.  *  Bit 1   Overrun Error (OE). A new word was received and there was no room in
  256.  *       the receive buffer. The newly-arrived word in the shift register is
  257.  *       discarded. On 8250/16450 UARTs, the word in the holding register is
  258.  *       discarded and the newly- arrived word is put in the holding register.
  259.  *  Bit 0   Data Ready (DR). One or more words are in the receive FIFO that the
  260.  *       host may read. A word must be completely received and moved from the
  261.  *       shift register into the FIFO (or holding register for 8250/16450
  262.  *       designs) before this bit is set.
  263.  *
  264.  *  SniffUSB observations: the LSR is returned as second byte on the interrupt-in
  265.  *  endpoint 0x83 to signal error conditions. Such errors have been seen with
  266.  *  minicom/zmodem transfers (CRC errors).
  267.  *
  268.  *
  269.  * Flow control
  270.  * ------------
  271.  *
  272.  *  SniffUSB observations: no flow control specific requests have been realized
  273.  *  apart from DTR/RTS settings. Both signals are dropped for no flow control
  274.  *  but asserted for hardware or software flow control.
  275.  *
  276.  *
  277.  * Endpoint usage
  278.  * --------------
  279.  *
  280.  *  SniffUSB observations: the bulk-out endpoint 0x1 and interrupt-in endpoint
  281.  *  0x81 is used to transmit and receive characters. The second interrupt-in 
  282.  *  endpoint 0x83 signals exceptional conditions like modem line changes and 
  283.  *  errors. The first byte returned is the MSR and the second byte the LSR.
  284.  *
  285.  *
  286.  * Other observations
  287.  * ------------------
  288.  *
  289.  *  Queued bulk transfers like used in visor.c did not work. 
  290.  *  
  291.  *
  292.  * Properties of the USB device used (as found in /var/log/messages)
  293.  * -----------------------------------------------------------------
  294.  *
  295.  *  Manufacturer: MCT Corporation.
  296.  *  Product: USB-232 Interfact Controller
  297.  *  SerialNumber: U2S22050
  298.  *
  299.  *    Length              = 18
  300.  *    DescriptorType      = 01
  301.  *    USB version         = 1.00
  302.  *    Vendor:Product      = 0711:0210
  303.  *    MaxPacketSize0      = 8
  304.  *    NumConfigurations   = 1
  305.  *    Device version      = 1.02
  306.  *    Device Class:SubClass:Protocol = 00:00:00
  307.  *      Per-interface classes
  308.  *  Configuration:
  309.  *    bLength             =    9
  310.  *    bDescriptorType     =   02
  311.  *    wTotalLength        = 0027
  312.  *    bNumInterfaces      =   01
  313.  *    bConfigurationValue =   01
  314.  *    iConfiguration      =   00
  315.  *    bmAttributes        =   c0
  316.  *    MaxPower            =  100mA
  317.  *
  318.  *    Interface: 0
  319.  *    Alternate Setting:  0
  320.  *      bLength             =    9
  321.  *      bDescriptorType     =   04
  322.  *      bInterfaceNumber    =   00
  323.  *      bAlternateSetting   =   00
  324.  *      bNumEndpoints       =   03
  325.  *      bInterface Class:SubClass:Protocol =   00:00:00
  326.  *      iInterface          =   00
  327.  *      Endpoint:
  328.  *    bLength             =    7
  329.  *    bDescriptorType     =   05
  330.  *    bEndpointAddress    =   81 (in)
  331.  *    bmAttributes        =   03 (Interrupt)
  332.  *    wMaxPacketSize      = 0040
  333.  *    bInterval           =   02
  334.  *      Endpoint:
  335.  *    bLength             =    7
  336.  *    bDescriptorType     =   05
  337.  *    bEndpointAddress    =   01 (out)
  338.  *    bmAttributes        =   02 (Bulk)
  339.  *    wMaxPacketSize      = 0040
  340.  *    bInterval           =   00
  341.  *      Endpoint:
  342.  *    bLength             =    7
  343.  *    bDescriptorType     =   05
  344.  *    bEndpointAddress    =   83 (in)
  345.  *    bmAttributes        =   03 (Interrupt)
  346.  *    wMaxPacketSize      = 0002
  347.  *    bInterval           =   02
  348.  *
  349.  *
  350.  * Hardware details (added by Martin Hamilton, 2001/12/06)
  351.  * -----------------------------------------------------------------
  352.  *
  353.  * This info was gleaned from opening a Belkin F5U109 DB9 USB serial
  354.  * adaptor, which turns out to simply be a re-badged U232-P9.  We
  355.  * know this because there is a sticky label on the circuit board
  356.  * which says "U232-P9" ;-)
  357.  * 
  358.  * The circuit board inside the adaptor contains a Philips PDIUSBD12
  359.  * USB endpoint chip and a Phillips P87C52UBAA microcontroller with
  360.  * embedded UART.  Exhaustive documentation for these is available at:
  361.  *
  362.  *   http://www.semiconductors.philips.com/pip/p87c52ubaa
  363.  *   http://www.semiconductors.philips.com/pip/pdiusbd12
  364.  *
  365.  * Thanks to Julian Highfield for the pointer to the Philips database.
  366.  * 
  367.  */
  368. #endif /* __LINUX_USB_SERIAL_MCT_U232_H */