whiteheat.h 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * USB ConnectTech WhiteHEAT driver
  4. *
  5. * Copyright (C) 2002
  6. * Connect Tech Inc.
  7. *
  8. * Copyright (C) 1999, 2000
  9. * Greg Kroah-Hartman (greg@kroah.com)
  10. *
  11. * See Documentation/usb/usb-serial.rst for more information on using this
  12. * driver
  13. *
  14. */
  15. #ifndef __LINUX_USB_SERIAL_WHITEHEAT_H
  16. #define __LINUX_USB_SERIAL_WHITEHEAT_H
  17. /* WhiteHEAT commands */
  18. #define WHITEHEAT_OPEN 1 /* open the port */
  19. #define WHITEHEAT_CLOSE 2 /* close the port */
  20. #define WHITEHEAT_SETUP_PORT 3 /* change port settings */
  21. #define WHITEHEAT_SET_RTS 4 /* turn RTS on or off */
  22. #define WHITEHEAT_SET_DTR 5 /* turn DTR on or off */
  23. #define WHITEHEAT_SET_BREAK 6 /* turn BREAK on or off */
  24. #define WHITEHEAT_DUMP 7 /* dump memory */
  25. #define WHITEHEAT_STATUS 8 /* get status */
  26. #define WHITEHEAT_PURGE 9 /* clear the UART fifos */
  27. #define WHITEHEAT_GET_DTR_RTS 10 /* get the state of DTR and RTS
  28. for a port */
  29. #define WHITEHEAT_GET_HW_INFO 11 /* get EEPROM info and
  30. 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
  34. IN endpoint */
  35. #define WHITEHEAT_DO_TEST 15 /* perform specified test */
  36. #define WHITEHEAT_CMD_COMPLETE 16 /* reply for some commands */
  37. #define WHITEHEAT_CMD_FAILURE 17 /* reply for failed commands */
  38. /*
  39. * Commands to the firmware
  40. */
  41. /*
  42. * WHITEHEAT_OPEN
  43. * WHITEHEAT_CLOSE
  44. * WHITEHEAT_STATUS
  45. * WHITEHEAT_GET_DTR_RTS
  46. * WHITEHEAT_REPORT_TX_DONE
  47. */
  48. struct whiteheat_simple {
  49. __u8 port; /* port number (1 to N) */
  50. };
  51. /*
  52. * WHITEHEAT_SETUP_PORT
  53. */
  54. #define WHITEHEAT_PAR_NONE 'n' /* no parity */
  55. #define WHITEHEAT_PAR_EVEN 'e' /* even parity */
  56. #define WHITEHEAT_PAR_ODD 'o' /* odd parity */
  57. #define WHITEHEAT_PAR_SPACE '0' /* space (force 0) parity */
  58. #define WHITEHEAT_PAR_MARK '1' /* mark (force 1) parity */
  59. #define WHITEHEAT_SFLOW_NONE 'n' /* no software flow control */
  60. #define WHITEHEAT_SFLOW_RX 'r' /* XOFF/ON is sent when RX
  61. fills/empties */
  62. #define WHITEHEAT_SFLOW_TX 't' /* when received XOFF/ON will
  63. stop/start TX */
  64. #define WHITEHEAT_SFLOW_RXTX 'b' /* both SFLOW_RX and SFLOW_TX */
  65. #define WHITEHEAT_HFLOW_NONE 0x00 /* no hardware flow control */
  66. #define WHITEHEAT_HFLOW_RTS_TOGGLE 0x01 /* RTS is on during transmit,
  67. off otherwise */
  68. #define WHITEHEAT_HFLOW_DTR 0x02 /* DTR is off/on when RX
  69. fills/empties */
  70. #define WHITEHEAT_HFLOW_CTS 0x08 /* when received CTS off/on
  71. will stop/start TX */
  72. #define WHITEHEAT_HFLOW_DSR 0x10 /* when received DSR off/on
  73. will stop/start TX */
  74. #define WHITEHEAT_HFLOW_RTS 0x80 /* RTS is off/on when RX
  75. fills/empties */
  76. struct whiteheat_port_settings {
  77. __u8 port; /* port number (1 to N) */
  78. __le32 baud; /* any value 7 - 460800, firmware calculates
  79. best fit; arrives little endian */
  80. __u8 bits; /* 5, 6, 7, or 8 */
  81. __u8 stop; /* 1 or 2, default 1 (2 = 1.5 if bits = 5) */
  82. __u8 parity; /* see WHITEHEAT_PAR_* above */
  83. __u8 sflow; /* see WHITEHEAT_SFLOW_* above */
  84. __u8 xoff; /* XOFF byte value */
  85. __u8 xon; /* XON byte value */
  86. __u8 hflow; /* see WHITEHEAT_HFLOW_* above */
  87. __u8 lloop; /* 0/1 turns local loopback mode off/on */
  88. } __attribute__ ((packed));
  89. /*
  90. * WHITEHEAT_SET_RTS
  91. * WHITEHEAT_SET_DTR
  92. * WHITEHEAT_SET_BREAK
  93. */
  94. #define WHITEHEAT_RTS_OFF 0x00
  95. #define WHITEHEAT_RTS_ON 0x01
  96. #define WHITEHEAT_DTR_OFF 0x00
  97. #define WHITEHEAT_DTR_ON 0x01
  98. #define WHITEHEAT_BREAK_OFF 0x00
  99. #define WHITEHEAT_BREAK_ON 0x01
  100. struct whiteheat_set_rdb {
  101. __u8 port; /* port number (1 to N) */
  102. __u8 state; /* 0/1 turns signal off/on */
  103. };
  104. /*
  105. * WHITEHEAT_DUMP
  106. */
  107. #define WHITEHEAT_DUMP_MEM_DATA 'd' /* data */
  108. #define WHITEHEAT_DUMP_MEM_IDATA 'i' /* idata */
  109. #define WHITEHEAT_DUMP_MEM_BDATA 'b' /* bdata */
  110. #define WHITEHEAT_DUMP_MEM_XDATA 'x' /* xdata */
  111. /*
  112. * Allowable address ranges (firmware checks address):
  113. * Type DATA: 0x00 - 0xff
  114. * Type IDATA: 0x80 - 0xff
  115. * Type BDATA: 0x20 - 0x2f
  116. * Type XDATA: 0x0000 - 0xffff
  117. *
  118. * B/I/DATA all read the local memory space
  119. * XDATA reads the external memory space
  120. * BDATA returns bits as bytes
  121. *
  122. * NOTE: 0x80 - 0xff (local space) are the Special Function Registers
  123. * of the 8051, and some have on-read side-effects.
  124. */
  125. struct whiteheat_dump {
  126. __u8 mem_type; /* see WHITEHEAT_DUMP_* above */
  127. __u16 addr; /* address, see restrictions above */
  128. __u16 length; /* number of bytes to dump, max 63 bytes */
  129. };
  130. /*
  131. * WHITEHEAT_PURGE
  132. */
  133. #define WHITEHEAT_PURGE_RX 0x01 /* purge rx fifos */
  134. #define WHITEHEAT_PURGE_TX 0x02 /* purge tx fifos */
  135. struct whiteheat_purge {
  136. __u8 port; /* port number (1 to N) */
  137. __u8 what; /* bit pattern of what to purge */
  138. };
  139. /*
  140. * WHITEHEAT_ECHO
  141. */
  142. struct whiteheat_echo {
  143. __u8 port; /* port number (1 to N) */
  144. __u8 length; /* length of message to echo, max 61 bytes */
  145. __u8 echo_data[61]; /* data to echo */
  146. };
  147. /*
  148. * WHITEHEAT_DO_TEST
  149. */
  150. #define WHITEHEAT_TEST_UART_RW 0x01 /* read/write uart registers */
  151. #define WHITEHEAT_TEST_UART_INTR 0x02 /* uart interrupt */
  152. #define WHITEHEAT_TEST_SETUP_CONT 0x03 /* setup for
  153. PORT_CONT/PORT_DISCONT */
  154. #define WHITEHEAT_TEST_PORT_CONT 0x04 /* port connect */
  155. #define WHITEHEAT_TEST_PORT_DISCONT 0x05 /* port disconnect */
  156. #define WHITEHEAT_TEST_UART_CLK_START 0x06 /* uart clock test start */
  157. #define WHITEHEAT_TEST_UART_CLK_STOP 0x07 /* uart clock test stop */
  158. #define WHITEHEAT_TEST_MODEM_FT 0x08 /* modem signals, requires a
  159. loopback cable/connector */
  160. #define WHITEHEAT_TEST_ERASE_EEPROM 0x09 /* erase eeprom */
  161. #define WHITEHEAT_TEST_READ_EEPROM 0x0a /* read eeprom */
  162. #define WHITEHEAT_TEST_PROGRAM_EEPROM 0x0b /* program eeprom */
  163. struct whiteheat_test {
  164. __u8 port; /* port number (1 to n) */
  165. __u8 test; /* see WHITEHEAT_TEST_* above*/
  166. __u8 info[32]; /* additional info */
  167. };
  168. /*
  169. * Replies from the firmware
  170. */
  171. /*
  172. * WHITEHEAT_STATUS
  173. */
  174. #define WHITEHEAT_EVENT_MODEM 0x01 /* modem field is valid */
  175. #define WHITEHEAT_EVENT_ERROR 0x02 /* error field is valid */
  176. #define WHITEHEAT_EVENT_FLOW 0x04 /* flow field is valid */
  177. #define WHITEHEAT_EVENT_CONNECT 0x08 /* connect field is valid */
  178. #define WHITEHEAT_FLOW_NONE 0x00 /* no flow control active */
  179. #define WHITEHEAT_FLOW_HARD_OUT 0x01 /* TX is stopped by CTS
  180. (waiting for CTS to go on) */
  181. #define WHITEHEAT_FLOW_HARD_IN 0x02 /* remote TX is stopped
  182. by RTS */
  183. #define WHITEHEAT_FLOW_SOFT_OUT 0x04 /* TX is stopped by XOFF
  184. received (waiting for XON) */
  185. #define WHITEHEAT_FLOW_SOFT_IN 0x08 /* remote TX is stopped by XOFF
  186. transmitted */
  187. #define WHITEHEAT_FLOW_TX_DONE 0x80 /* TX has completed */
  188. struct whiteheat_status_info {
  189. __u8 port; /* port number (1 to N) */
  190. __u8 event; /* indicates what the current event is,
  191. see WHITEHEAT_EVENT_* above */
  192. __u8 modem; /* modem signal status (copy of uart's
  193. MSR register) */
  194. __u8 error; /* line status (copy of uart's LSR register) */
  195. __u8 flow; /* flow control state, see WHITEHEAT_FLOW_*
  196. above */
  197. __u8 connect; /* 0 means not connected, non-zero means
  198. connected */
  199. };
  200. /*
  201. * WHITEHEAT_GET_DTR_RTS
  202. */
  203. struct whiteheat_dr_info {
  204. __u8 mcr; /* copy of uart's MCR register */
  205. };
  206. /*
  207. * WHITEHEAT_GET_HW_INFO
  208. */
  209. struct whiteheat_hw_info {
  210. __u8 hw_id; /* hardware id number, WhiteHEAT = 0 */
  211. __u8 sw_major_rev; /* major version number */
  212. __u8 sw_minor_rev; /* minor version number */
  213. struct whiteheat_hw_eeprom_info {
  214. __u8 b0; /* B0 */
  215. __u8 vendor_id_low; /* vendor id (low byte) */
  216. __u8 vendor_id_high; /* vendor id (high byte) */
  217. __u8 product_id_low; /* product id (low byte) */
  218. __u8 product_id_high; /* product id (high byte) */
  219. __u8 device_id_low; /* device id (low byte) */
  220. __u8 device_id_high; /* device id (high byte) */
  221. __u8 not_used_1;
  222. __u8 serial_number_0; /* serial number (low byte) */
  223. __u8 serial_number_1; /* serial number */
  224. __u8 serial_number_2; /* serial number */
  225. __u8 serial_number_3; /* serial number (high byte) */
  226. __u8 not_used_2;
  227. __u8 not_used_3;
  228. __u8 checksum_low; /* checksum (low byte) */
  229. __u8 checksum_high; /* checksum (high byte */
  230. } hw_eeprom_info; /* EEPROM contents */
  231. };
  232. /*
  233. * WHITEHEAT_EVENT
  234. */
  235. struct whiteheat_event_info {
  236. __u8 port; /* port number (1 to N) */
  237. __u8 event; /* see whiteheat_status_info.event */
  238. __u8 info; /* see whiteheat_status_info.modem, .error,
  239. .flow, .connect */
  240. };
  241. /*
  242. * WHITEHEAT_DO_TEST
  243. */
  244. #define WHITEHEAT_TEST_FAIL 0x00 /* test failed */
  245. #define WHITEHEAT_TEST_UNKNOWN 0x01 /* unknown test requested */
  246. #define WHITEHEAT_TEST_PASS 0xff /* test passed */
  247. struct whiteheat_test_info {
  248. __u8 port; /* port number (1 to N) */
  249. __u8 test; /* indicates which test this is a response for,
  250. see WHITEHEAT_DO_TEST above */
  251. __u8 status; /* see WHITEHEAT_TEST_* above */
  252. __u8 results[32]; /* test-dependent results */
  253. };
  254. #endif