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

嵌入式Linux

开发平台:

Unix_Linux

  1. /*
  2.  * USB ConnectTech WhiteHEAT driver
  3.  *
  4.  *      Copyright (C) 1999, 2000
  5.  *          Greg Kroah-Hartman (greg@kroah.com)
  6.  *
  7.  *      This program is free software; you can redistribute it and/or modify
  8.  *      it under the terms of the GNU General Public License as published by
  9.  *      the Free Software Foundation; either version 2 of the License, or
  10.  *      (at your option) any later version.
  11.  *
  12.  * See Documentation/usb/usb-serial.txt for more information on using this driver
  13.  *
  14.  */
  15. #ifndef __LINUX_USB_SERIAL_WHITEHEAT_H
  16. #define __LINUX_USB_SERIAL_WHITEHEAT_H
  17. #define FALSE 0
  18. #define TRUE 1
  19. /* WhiteHEAT commands */
  20. #define WHITEHEAT_OPEN 1 /* open the port */
  21. #define WHITEHEAT_CLOSE 2 /* close the port */
  22. #define WHITEHEAT_SETUP_PORT 3 /* change port settings */
  23. #define WHITEHEAT_SET_RTS 4 /* turn RTS on or off */
  24. #define WHITEHEAT_SET_DTR 5 /* turn DTR on or off */
  25. #define WHITEHEAT_SET_BREAK 6 /* turn BREAK on or off */
  26. #define WHITEHEAT_DUMP 7 /* dump memory */
  27. #define WHITEHEAT_STATUS 8 /* get status */
  28. #define WHITEHEAT_PURGE 9 /* clear the UART fifos */
  29. #define WHITEHEAT_GET_DTR_RTS 10 /* get the state of DTR and RTS for a port */
  30. #define WHITEHEAT_GET_HW_INFO 11 /* get EEPROM info and hardware ID */
  31. #define WHITEHEAT_REPORT_TX_DONE 12 /* get the next TX done */
  32. #define WHITEHEAT_EVENT 13 /* unsolicited status events */
  33. #define WHITEHEAT_ECHO 14 /* send data to the indicated IN endpoint */
  34. #define WHITEHEAT_DO_TEST 15 /* perform the specified test */
  35. #define WHITEHEAT_CMD_COMPLETE 16 /* reply for certain commands */
  36. #define WHITEHEAT_CMD_FAILURE 17 /* reply for failed commands */
  37. /* Data for the WHITEHEAT_SETUP_PORT command */
  38. #define WHITEHEAT_CTS_FLOW 0x08
  39. #define WHITEHEAT_RTS_FLOW 0x80
  40. #define WHITEHEAT_DSR_FLOW 0x10
  41. #define WHITEHEAT_DTR_FLOW 0x02
  42. struct whiteheat_port_settings {
  43. __u8 port; /* port number (1 to N) */
  44. __u32 baud; /* any value allowed, default 9600, arrives little endian, range is 7 - 460800 */
  45. __u8 bits; /* 5, 6, 7, or 8, default 8 */
  46. __u8 stop; /* 1 or 2, default 1 (2 = 1.5 if bits = 5) */
  47. __u8 parity; /* 'n, e, o, 0, or 1' (ascii), default 'n'
  48.  * n = none e = even o = odd
  49.  * 0 = force 0 1 = force 1 */
  50. __u8 sflow; /* 'n, r, t, or b' (ascii), default 'n'
  51.  * n = none
  52.  * r = receive (XOFF/XON transmitted when receiver fills / empties)
  53.  * t = transmit (XOFF/XON received will stop/start TX)
  54.  * b = both  */
  55. __u8 xoff; /* XOFF byte value, default 0x13 */
  56. __u8 xon; /* XON byte value, default 0x11 */
  57. __u8 hflow; /* bits indicate mode as follows:
  58.  * CTS (0x08) (CTS off/on will control/cause TX off/on)
  59.  * DSR (0x10) (DSR off/on will control/cause TX off/on)
  60.  * RTS (0x80) (RTS off/on when receiver fills/empties)
  61.  * DTR (0x02) (DTR off/on when receiver fills/empties) */
  62. __u8 lloop; /* local loopback 0 or 1, default 0 */
  63. } __attribute__ ((packed));
  64. /* data for WHITEHEAT_SET_RTS, WHITEHEAT_SET_DTR, and WHITEHEAT_SET_BREAK commands */
  65. struct whiteheat_rdb_set {
  66. __u8 port; /* port number (1 to N) */
  67. __u8 state; /* 0 = off, non-zero = on */
  68. };
  69. /* data for:
  70. WHITEHEAT_OPEN
  71. WHITEHEAT_CLOSE
  72. WHITEHEAT_STATUS
  73. WHITEHEAT_GET_DTR_RTS
  74. WHITEHEAT_REPORT_TX_DONE */
  75. struct whiteheat_min_set {
  76. __u8 port; /* port number (1 to N) */
  77. };
  78. /* data for WHITEHEAT_PURGE command */
  79. #define WHITEHEAT_PURGE_INPUT 0x01
  80. #define WHITEHEAT_PURGE_OUTPUT 0x02
  81. struct whiteheat_purge_set {
  82. __u8 port; /* port number (1 to N) */
  83. __u8 what; /* bit pattern of what to purge */
  84. };
  85. /* data for WHITEHEAT_DUMP command */
  86. struct whiteheat_dump_info {
  87. __u8 mem_type; /* memory type: 'd' = data, 'i' = idata, 'b' = bdata, 'x' = xdata */
  88. __u16 addr; /* memory address to dump, address range depends on the above mem_type:
  89.  * 'd' = 0 to ff (80 to FF is SFR's)
  90.  * 'i' = 80 to ff
  91.  * 'b' = 20 to 2f (bits returned as bytes)
  92.  * 'x' = 0000 to ffff (also code space) */
  93. __u16 length; /* number of bytes to dump, max 64 */
  94. };
  95. /* data for WHITEHEAT_ECHO command */
  96. struct whiteheat_echo_set {
  97. __u8 port; /* port number (1 to N) */
  98. __u8 length; /* length of message to echo */
  99. __u8 echo_data[61]; /* data to echo */
  100. };
  101. /* data returned from WHITEHEAT_STATUS command */
  102. #define WHITEHEAT_OVERRUN_ERROR 0x02
  103. #define WHITEHEAT_PARITY_ERROR 0x04
  104. #define WHITEHEAT_FRAMING_ERROR 0x08
  105. #define WHITEHEAT_BREAK_ERROR 0x10
  106. #define WHITEHEAT_OHFLOW 0x01 /* TX is stopped by CTS (waiting for CTS to go ON) */
  107. #define WHITEHEAT_IHFLOW 0x02 /* remote TX is stopped by RTS */
  108. #define WHITEHEAT_OSFLOW 0x04 /* TX is stopped by XOFF received (waiting for XON to occur) */
  109. #define WHITEHEAT_ISFLOW 0x08 /* remote TX is stopped by XOFF transmitted */
  110. #define WHITEHEAT_TX_DONE 0x80 /* TX has completed */
  111. #define WHITEHEAT_MODEM_EVENT 0x01
  112. #define WHITEHEAT_ERROR_EVENT 0x02
  113. #define WHITEHEAT_FLOW_EVENT 0x04
  114. #define WHITEHEAT_CONNECT_EVENT 0x08
  115. struct whiteheat_status_info {
  116. __u8 port; /* port number (1 to N) */
  117. __u8 event; /* indicates which of the following bytes are the current event */
  118. __u8 modem; /* modem signal status (copy of UART MSR register) */
  119. __u8 error; /* PFO and RX break (copy of UART LSR register) */
  120. __u8 flow; /* flow control state */
  121. __u8 connect; /* connect state, non-zero value indicates connected */
  122. };
  123. /* data returned from WHITEHEAT_EVENT command */
  124. struct whiteheat_event {
  125. __u8 port; /* port number (1 to N) */
  126. __u8 event; /* indicates which of the following bytes are the current event */
  127. __u8 info; /* either modem, error, flow, or connect information */
  128. };
  129. /* data retured by the WHITEHEAT_GET_HW_INFO command */
  130. struct whiteheat_hw_info {
  131. __u8 hw_id; /* hardware id number, WhiteHEAT = 0 */
  132. __u8 sw_major_rev; /* major version number */
  133. __u8 sw_minor_rev; /* minor version number */
  134. struct whiteheat_hw_eeprom_info {
  135. __u8 b0; /* B0 */
  136. __u8 vendor_id_low; /* vendor id (low byte) */
  137. __u8 vendor_id_high; /* vendor id (high byte) */
  138. __u8 product_id_low; /* product id (low byte) */
  139. __u8 product_id_high; /* product id (high byte) */
  140. __u8 device_id_low; /* device id (low byte) */
  141. __u8 device_id_high; /* device id (high byte) */
  142. __u8 not_used_1;
  143. __u8 serial_number_0; /* serial number (low byte) */
  144. __u8 serial_number_1; /* serial number */
  145. __u8 serial_number_2; /* serial number */
  146. __u8 serial_number_3; /* serial number (high byte) */
  147. __u8 not_used_2;
  148. __u8 not_used_3;
  149. __u8 checksum_low; /* checksum (low byte) */
  150. __u8 checksum_high; /* checksum (high byte */
  151. } hw_eeprom_info; /* EEPROM contents */
  152. };
  153. #endif