keyspan_usa67msg.h 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255
  1. /* SPDX-License-Identifier: BSD-3-Clause */
  2. /*
  3. usa67msg.h
  4. Copyright (c) 1998-2007 InnoSys Incorporated. All Rights Reserved
  5. This file is available under a BSD-style copyright
  6. Keyspan USB Async Firmware to run on Anchor FX1
  7. Redistribution and use in source and binary forms, with or without
  8. modification, are permitted provided that the following conditions are
  9. met:
  10. 1. Redistributions of source code must retain this licence text
  11. without modification, this list of conditions, and the following
  12. disclaimer. The following copyright notice must appear immediately at
  13. the beginning of all source files:
  14. Copyright (c) 1998-2007 InnoSys Incorporated. All Rights Reserved
  15. This file is available under a BSD-style copyright
  16. 2. Redistributions in binary form must reproduce the above copyright
  17. notice, this list of conditions and the following disclaimer in the
  18. documentation and/or other materials provided with the distribution.
  19. 3. The name of InnoSys Incorprated may not be used to endorse or promote
  20. products derived from this software without specific prior written
  21. permission.
  22. THIS SOFTWARE IS PROVIDED BY INNOSYS CORP. ``AS IS'' AND ANY EXPRESS OR
  23. IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  24. OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
  25. NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  26. INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  27. (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  28. SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  29. CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30. LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31. OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32. SUCH DAMAGE.
  33. Fourth revision: This message format supports the USA28XG
  34. Buffer formats for RX/TX data messages are not defined by
  35. a structure, but are described here:
  36. USB OUT (host -> USAxx, transmit) messages contain a
  37. REQUEST_ACK indicator (set to 0xff to request an ACK at the
  38. completion of transmit; 0x00 otherwise), followed by data:
  39. RQSTACK DAT DAT DAT ...
  40. with a total data length of up to 63.
  41. USB IN (USAxx -> host, receive) messages begin with a status
  42. byte in which the 0x80 bit is either:
  43. (a) 0x80 bit clear
  44. indicates that the bytes following it are all data
  45. bytes:
  46. STAT DATA DATA DATA DATA DATA ...
  47. for a total of up to 63 DATA bytes,
  48. or:
  49. (b) 0x80 bit set
  50. indiates that the bytes following alternate data and
  51. status bytes:
  52. STAT DATA STAT DATA STAT DATA STAT DATA ...
  53. for a total of up to 32 DATA bytes.
  54. The valid bits in the STAT bytes are:
  55. OVERRUN 0x02
  56. PARITY 0x04
  57. FRAMING 0x08
  58. BREAK 0x10
  59. Notes:
  60. (1) The OVERRUN bit can appear in either (a) or (b) format
  61. messages, but the but the PARITY/FRAMING/BREAK bits
  62. only appear in (b) format messages.
  63. (2) For the host to determine the exact point at which the
  64. overrun occurred (to identify the point in the data
  65. stream at which the data was lost), it needs to count
  66. 128 characters, starting at the first character of the
  67. message in which OVERRUN was reported; the lost character(s)
  68. would have been received between the 128th and 129th
  69. characters.
  70. (3) An RX data message in which the first byte has 0x80 clear
  71. serves as a "break off" indicator.
  72. revision history:
  73. 1999feb10 add reportHskiaChanges to allow us to ignore them
  74. 1999feb10 add txAckThreshold for fast+loose throughput enhancement
  75. 1999mar30 beef up support for RX error reporting
  76. 1999apr14 add resetDataToggle to control message
  77. 2000jan04 merge with usa17msg.h
  78. 2000jun01 add extended BSD-style copyright text
  79. 2001jul05 change message format to improve OVERRUN case
  80. 2002jun05 update copyright date, improve comments
  81. 2006feb06 modify for FX1 chip
  82. */
  83. #ifndef __USA67MSG__
  84. #define __USA67MSG__
  85. // all things called "ControlMessage" are sent on the 'control' endpoint
  86. typedef struct keyspan_usa67_portControlMessage
  87. {
  88. u8 port; // 0 or 1 (selects port)
  89. /*
  90. there are three types of "commands" sent in the control message:
  91. 1. configuration changes which must be requested by setting
  92. the corresponding "set" flag (and should only be requested
  93. when necessary, to reduce overhead on the device):
  94. */
  95. u8 setClocking, // host requests baud rate be set
  96. baudLo, // host does baud divisor calculation
  97. baudHi, // baudHi is only used for first port (gives lower rates)
  98. externalClock_txClocking,
  99. // 0=internal, other=external
  100. setLcr, // host requests lcr be set
  101. lcr, // use PARITY, STOPBITS, DATABITS below
  102. setFlowControl, // host requests flow control be set
  103. ctsFlowControl, // 1=use CTS flow control, 0=don't
  104. xonFlowControl, // 1=use XON/XOFF flow control, 0=don't
  105. xonChar, // specified in current character format
  106. xoffChar, // specified in current character format
  107. setTxTriState_setRts,
  108. // host requests TX tri-state be set
  109. txTriState_rts, // 1=active (normal), 0=tristate (off)
  110. setHskoa_setDtr,
  111. // host requests HSKOA output be set
  112. hskoa_dtr, // 1=on, 0=off
  113. setPrescaler, // host requests prescalar be set (default: 13)
  114. prescaler; // specified as N/8; values 8-ff are valid
  115. // must be set any time internal baud rate is set;
  116. // must not be set when external clocking is used
  117. /*
  118. 3. configuration data which is simply used as is (no overhead,
  119. but must be specified correctly in every host message).
  120. */
  121. u8 forwardingLength, // forward when this number of chars available
  122. reportHskiaChanges_dsrFlowControl,
  123. // 1=normal; 0=ignore external clock
  124. // 1=use DSR flow control, 0=don't
  125. txAckThreshold, // 0=not allowed, 1=normal, 2-255 deliver ACK faster
  126. loopbackMode; // 0=no loopback, 1=loopback enabled
  127. /*
  128. 4. commands which are flags only; these are processed in order
  129. (so that, e.g., if both _txOn and _txOff flags are set, the
  130. port ends in a TX_OFF state); any non-zero value is respected
  131. */
  132. u8 _txOn, // enable transmitting (and continue if there's data)
  133. _txOff, // stop transmitting
  134. txFlush, // toss outbound data
  135. txBreak, // turn on break (cleared by _txOn)
  136. rxOn, // turn on receiver
  137. rxOff, // turn off receiver
  138. rxFlush, // toss inbound data
  139. rxForward, // forward all inbound data, NOW (as if fwdLen==1)
  140. returnStatus, // return current status (even if it hasn't changed)
  141. resetDataToggle;// reset data toggle state to DATA0
  142. } keyspan_usa67_portControlMessage;
  143. // defines for bits in lcr
  144. #define USA_DATABITS_5 0x00
  145. #define USA_DATABITS_6 0x01
  146. #define USA_DATABITS_7 0x02
  147. #define USA_DATABITS_8 0x03
  148. #define STOPBITS_5678_1 0x00 // 1 stop bit for all byte sizes
  149. #define STOPBITS_5_1p5 0x04 // 1.5 stop bits for 5-bit byte
  150. #define STOPBITS_678_2 0x04 // 2 stop bits for 6/7/8-bit byte
  151. #define USA_PARITY_NONE 0x00
  152. #define USA_PARITY_ODD 0x08
  153. #define USA_PARITY_EVEN 0x18
  154. #define PARITY_1 0x28
  155. #define PARITY_0 0x38
  156. // all things called "StatusMessage" are sent on the status endpoint
  157. typedef struct keyspan_usa67_portStatusMessage // one for each port
  158. {
  159. u8 port, // 0=first, 1=second, other=see below
  160. hskia_cts, // reports HSKIA pin
  161. gpia_dcd, // reports GPIA pin
  162. _txOff, // port has been disabled (by host)
  163. _txXoff, // port is in XOFF state (either host or RX XOFF)
  164. txAck, // indicates a TX message acknowledgement
  165. rxEnabled, // as configured by rxOn/rxOff 1=on, 0=off
  166. controlResponse;// 1=a control message has been processed
  167. } keyspan_usa67_portStatusMessage;
  168. // bits in RX data message when STAT byte is included
  169. #define RXERROR_OVERRUN 0x02
  170. #define RXERROR_PARITY 0x04
  171. #define RXERROR_FRAMING 0x08
  172. #define RXERROR_BREAK 0x10
  173. typedef struct keyspan_usa67_globalControlMessage
  174. {
  175. u8 port, // 3
  176. sendGlobalStatus, // 2=request for two status responses
  177. resetStatusToggle, // 1=reset global status toggle
  178. resetStatusCount; // a cycling value
  179. } keyspan_usa67_globalControlMessage;
  180. typedef struct keyspan_usa67_globalStatusMessage
  181. {
  182. u8 port, // 3
  183. sendGlobalStatus, // from request, decremented
  184. resetStatusCount; // as in request
  185. } keyspan_usa67_globalStatusMessage;
  186. typedef struct keyspan_usa67_globalDebugMessage
  187. {
  188. u8 port, // 2
  189. a,
  190. b,
  191. c,
  192. d;
  193. } keyspan_usa67_globalDebugMessage;
  194. // ie: the maximum length of an FX1 endpoint buffer
  195. #define MAX_DATA_LEN 64
  196. // update status approx. 60 times a second (16.6666 ms)
  197. #define STATUS_UPDATE_INTERVAL 16
  198. // status rationing tuning value (each port gets checked each n ms)
  199. #define STATUS_RATION 10
  200. #endif