c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * CDDL HEADER START
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * The contents of this file are subject to the terms of the
e4de76aa4e9407a815fe6a89e8fe9a19a827a5f6yz * Common Development and Distribution License (the "License").
e4de76aa4e9407a815fe6a89e8fe9a19a827a5f6yz * You may not use this file except in compliance with the License.
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * See the License for the specific language governing permissions
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * and limitations under the License.
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * When distributing Covered Code, include this CDDL HEADER in each
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * If applicable, add the following below this CDDL HEADER, with the
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * fields enclosed by brackets "[]" replaced with your own identifying
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * information: Portions Copyright [yyyy] [name of copyright owner]
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * CDDL HEADER END
d29f5a711240f866521445b1656d114da090335ezhigang lu - Sun Microsystems - Beijing China * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * Use is subject to license terms.
c138f478d2bc94e73ab8f6a084e323bec25e62f5yztypedef struct keyspan_usa49_port_ctrl_msg keyspan_usa49_port_ctrl_msg_t;
c138f478d2bc94e73ab8f6a084e323bec25e62f5yztypedef struct keyspan_usa49_port_status_msg keyspan_usa49_port_status_msg_t;
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * Copyright (C) 1998-2000 InnoSys Incorporated. All Rights Reserved
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * Keyspan USB Async Message Formats for the USA49W
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * Buffer formats for RX/TX data messages are not defined by
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * a structure, but are described here:
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * USB OUT (host -> USAxx, transmit) messages contain a
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * REQUEST_ACK indicator (set to 0xff to request an ACK at the
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * completion of transmit; 0x00 otherwise), followed by data:
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * RQSTACK DAT DAT DAT ...
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * with a total data length of 63.
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * USB IN (USAxx -> host, receive) messages begin with a status
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * byte in which the 0x80 bit is either:
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * (a) 0x80 bit clear
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * indicates that the bytes following it are all data
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * STAT DATA DATA DATA DATA DATA ...
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * for a total of up to 63 DATA bytes,
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * (b) 0x80 bit set
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * indiates that the bytes following alternate data and
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * status bytes:
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * STAT DATA STAT DATA STAT DATA STAT DATA ...
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * for a total of up to 32 DATA bytes.
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * The valid bits in the STAT bytes are:
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * OVERRUN 0x02
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * PARITY 0x04
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * FRAMING 0x08
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * BREAK 0x10
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * (1) The OVERRUN bit can appear in either (a) or (b) format
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * messages, but the but the PARITY/FRAMING/BREAK bits
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * only appear in (b) format messages.
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * (2) For the host to determine the exact point at which the
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * overrun occurred (to identify the point in the data
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * stream at which the data was lost), it needs to count
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * 128 characters, starting at the first character of the
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * message in which OVERRUN was reported; the lost character(s)
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * would have been received between the 128th and 129th
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * characters.
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * (3) An RX data message in which the first byte has 0x80 clear
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * serves as a "break off" indicator.
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * (4) a control message specifying disablePort will be answered
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * with a status message, but no further status will be sent
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * until a control messages with enablePort is sent
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * Host->device messages sent on the global control endpoint:
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * portNumber message
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * ---------- --------------------
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * 0,1,2,3 portControlMessage
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * 0x80 globalControlMessage
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * 0. 0/1/2/3 port control message follows
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * 0x80 set non-port control message follows
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * there are three types of "commands" sent in the control message:
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * 1. configuration changes which must be requested by setting
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * the corresponding "set" flag (and should only be requested
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * when necessary, to reduce overhead on the USA26):
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz uint8_t setClocking; /* host requests baud rate be set */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz /* baudHi is only used for first port (gives lower rates) */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz uint8_t prescaler; /* specified as N/8; values 8-ff are valid */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz /* must be set any time internal baud rate is set; */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz uint8_t setFlowControl; /* host requests flow control be set */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz uint8_t ctsFlowControl; /* 1=use CTS flow control, 0=don't */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz uint8_t xonFlowControl; /* 1=use XON/XOFF flow control, 0=don't */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz uint8_t xonChar; /* specified in current character format */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz uint8_t xoffChar; /* specified in current character format */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * 3. configuration data which is simply used as is (no overhead,
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * but must be specified correctly in every host message).
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz /* forward when this number of chars available */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz uint8_t dsrFlowControl; /* 1=use DSR flow control, 0=don't */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz /* 0=not allowed, 1=normal, 2-255 deliver ACK faster */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz uint8_t loopbackMode; /* 0=no loopback, 1=loopback enabled */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * 4. commands which are flags only; these are processed in order
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * (so that, e.g., if both _txOn and _txOff flags are set, the
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * port ends in a TX_OFF state); any non-zero value is respected
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz /* enable transmitting (and continue if there's data) */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz /* forward all inbound data, NOW (as if fwdLen==1) */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz /* return current status (even if it hasn't changed) */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz uint8_t resetDataToggle; /* reset data toggle state to DATA0 */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz /* start servicing port (move data, check status) */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz /* stop servicing port (does implicit tx/rx flush/off) */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz/* defines for bits in lcr */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz#define STOPBITS_5678_1 0x00 /* 1 stop bit for all byte sizes */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz#define STOPBITS_5_1p5 0x04 /* 1.5 stop bits for 5-bit byte */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz#define STOPBITS_678_2 0x04 /* 2 stop bits for 6/7/8-bit byte */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * during normal operation, status messages are returned
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * to the host whenever the board detects changes. In some
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * circumstances (e.g. Windows), status messages from the
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * device cause problems; to shut them off, the host issues
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * a control message with the disableStatusMessages flags
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * set (to any non-zero value). The device will respond to
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * this message, and then suppress further status messages;
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * it will resume sending status messages any time the host
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * sends any control message (either global or port-specific).
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz /* 1/2=number of status responses requested */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz uint8_t resetStatusToggle; /* 1=reset global status toggle */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz uint8_t remoteWakeupEnable; /* 0x10=P1, 0x20=P2, 0x40=P3, 0x80=P4 */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz uint8_t disableStatusMessages; /* 1=send no status until host talks */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * Device->host messages send on the global status endpoint
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * portNumber message
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * ---------- --------------------
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * 0x00,0x01,0x02,0x03 portStatusMessage
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * 0x80 globalStatusMessage
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz * 0x81 globalDebugMessage
c138f478d2bc94e73ab8f6a084e323bec25e62f5yzstruct keyspan_usa49_port_status_msg { /* one for each port */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz uint8_t _txOff; /* transmit has been disabled (by host) */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz /* transmit is in XOFF state (either host or RX XOFF) */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz uint8_t rxEnabled; /* as configured by rxOn/rxOff 1=on, 0=off */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz /* 1=a control message has been processed */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz/* bits in RX data message when STAT byte is included */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz uint8_t sendGlobalStatus; /* from request, decremented */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz/* ie: the maximum length of an EZUSB endpoint buffer */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz/* update status approx. 60 times a second (16.6666 ms) */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz/* status rationing tuning value (each port gets checked each n ms) */
c138f478d2bc94e73ab8f6a084e323bec25e62f5yz#endif /* _SYS_USB_USBSER_KEYSPAN_USA49MSG_H */