drivers/usb/serial/keyspan_usa67msg.h

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