xref: /dragonfly/sys/dev/serial/ic_layer/esp.h (revision 984263bc)
1 /*-
2  * Copyright (c) 1995 Sean Eric Fagan.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the author nor the names of contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * $FreeBSD: src/sys/dev/ic/esp.h,v 1.6.2.1 2002/02/03 14:52:02 nyan Exp $
30  */
31 
32 #ifndef _IC_ESP_H_
33 #define	_IC_ESP_H_
34 
35 /*
36  * Definitions for Hayes ESP serial cards.
37  */
38 
39 /*
40  * CMD1 and CMD2 are the command ports, offsets from <esp_iobase>.
41  */
42 #define	ESP_CMD1	4
43 #define	ESP_CMD2	5
44 
45 /*
46  * STAT1 and STAT2 are to get return values and status bytes;
47  * they overload CMD1 and CMD2.
48  */
49 #define	ESP_STATUS1	ESP_CMD1
50 #define	ESP_STATUS2	ESP_CMD2
51 
52 /*
53  * Commands.  Commands are given by writing the command value to
54  * ESP_CMD1 and then writing or reading some number of bytes from
55  * ESP_CMD2 or ESP_STATUS2.
56  */
57 #define	ESP_GETTEST	0x01	/* self-test command (1 byte + extras) */
58 #define	ESP_GETDIPS	0x02	/* get on-board DIP switches (1 byte) */
59 #define	ESP_SETFLOWTYPE	0x08	/* set type of flow-control (2 bytes) */
60 #define	ESP_SETRXFLOW	0x0a	/* set Rx FIFO flow control levels (4 bytes) */
61 #define	ESP_SETMODE	0x10	/* set board mode (1 byte) */
62 #define	ESP_SETCLOCK	0x23	/* set UART clock prescaler */
63 
64 /* Mode bits (ESP_SETMODE). */
65 #define	ESP_MODE_FIFO	0x02	/* act like a 16550 (compatibility mode) */
66 #define	ESP_MODE_RTS	0x04	/* use RTS hardware flow control */
67 #define	ESP_MODE_SCALE	0x80	/* scale FIFO trigger levels */
68 
69 /* Flow control type bits (ESP_SETFLOWTYPE). */
70 #define	ESP_FLOW_RTS	0x04	/* cmd1: local Rx sends RTS flow control */
71 #define	ESP_FLOW_CTS	0x10	/* cmd2: local transmitter responds to CTS */
72 
73 /* Used by ESP_SETRXFLOW. */
74 #define	HIBYTE(w)	(((w) >> 8) & 0xff)
75 #define	LOBYTE(w)	((w) & 0xff)
76 
77 #endif /* !_IC_ESP_H_ */
78