1
/* pdp11_xq.h: DEQNA/DELQA ethernet controller information
2
------------------------------------------------------------------------------
4
Copyright (c) 2002-2004, David T. Hittner
6
Permission is hereby granted, free of charge, to any person obtaining a
7
copy of this software and associated documentation files (the "Software"),
8
to deal in the Software without restriction, including without limitation
9
the rights to use, copy, modify, merge, publish, distribute, sublicense,
10
and/or sell copies of the Software, and to permit persons to whom the
11
Software is furnished to do so, subject to the following conditions:
13
The above copyright notice and this permission notice shall be included in
14
all copies or substantial portions of the Software.
16
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19
THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
20
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23
Except as contained in this notice, the name of the author shall not be
24
used in advertising or otherwise to promote the sale, use or other dealings
25
in this Software without prior written authorization from the author.
27
------------------------------------------------------------------------------
31
20-Jan-04 DTH Added new sanity timer and system id timer
32
19-Jan-04 DTH Added XQ_SERVICE_INTERVAL, poll
33
09-Jan-04 DTH Added Boot PDP diagnostic definition, XI/RI combination
34
26-Dec-03 DTH Moved ethernet queue definitions to sim_ether
35
25-Nov-03 DTH Added interrupt request flag
36
02-Jun-03 DTH Added struct xq_stats
37
28-May-03 DTH Made xq_msg_que.item dynamic
38
28-May-03 MP Optimized structures, removed rtime variable
39
06-May-03 DTH Changed 32-bit t_addr to uint32 for v3.0
40
28-Apr-03 DTH Added callbacks for multicontroller identification
41
25-Mar-03 DTH Removed bootrom field - no longer needed; Updated copyright
42
15-Jan-03 DTH Merged Mark Pizzolato's changes into main source
43
13-Jan-03 MP Added countdown for System Id multicast packets
44
10-Jan-03 DTH Added bootrom field
45
30-Dec-02 DTH Added setup valid field
46
21-Oct-02 DTH Corrected copyright again
47
15-Oct-02 DTH Fixed copyright, added sanity timer support
48
10-Oct-02 DTH Added more setup fields and bitmasks
49
08-Oct-02 DTH Integrated with 2.10-0p4, added variable vector and copyrights
50
03-Oct-02 DTH Beta version of xq/sim_ether released for SIMH 2.09-11
51
15-Aug-02 DTH Started XQ simulation
53
------------------------------------------------------------------------------
59
#if defined (VM_PDP10) /* PDP10 version */
60
#error "DEQNA/DELQA not supported on PDP10!"
62
#elif defined (VM_VAX) /* VAX version */
66
extern int32 PSL; /* PSL */
67
extern int32 fault_PC; /* fault PC */
68
extern int32 int_req[IPL_HLVL];
69
extern int32 int_vec[IPL_HLVL][32];
71
#else /* PDP-11 version */
72
#include "pdp11_defs.h"
75
extern int32 int_req[IPL_HLVL];
76
extern int32 int_vec[IPL_HLVL][32];
79
#include "sim_ether.h"
81
#define XQ_QUE_MAX 500 /* read queue size in packets */
82
#define XQ_FILTER_MAX 14 /* number of filters allowed */
83
#define XQ_SERVICE_INTERVAL 100 /* polling interval - X per second */
84
#define XQ_SYSTEM_ID_SECS 540 /* seconds before system ID timer expires */
85
#define XQ_HW_SANITY_SECS 240 /* seconds before HW sanity timer expires */
86
#define XQ_MAX_CONTROLLERS 2 /* maximum controllers allowed */
88
enum xq_type {XQ_T_DEQNA, XQ_T_DELQA};
91
int enabled; /* sanity timer enabled? 2=HW, 1=SW, 0=off */
92
int quarter_secs; /* sanity timer value in 1/4 seconds */
93
int max; /* maximum timeout (based on poll) */
94
int timer; /* countdown timer */
98
int valid; /* is the setup block valid? */
99
int promiscuous; /* promiscuous mode enabled */
100
int multicast; /* enable all multicast addresses */
101
int l1; /* first diagnostic led state */
102
int l2; /* second diagnostic led state */
103
int l3; /* third diagnostic led state */
104
int sanity_timer; /* sanity timer value (encoded) */
105
ETH_MAC macs[XQ_FILTER_MAX]; /* MAC addresses to respond to */
109
int recv; /* received packets */
110
int filter; /* filtered packets */
111
int xmit; /* transmitted packets */
112
int fail; /* transmit failed */
113
int runt; /* runts */
114
int giant; /* oversize packets */
115
int setup; /* setup packets */
116
int loop; /* loopback packets */
119
struct xq_meb { /* MEB block */
129
/*+ initialized values - DO NOT MOVE */
130
ETH_PCALLBACK rcallback; /* read callback routine */
131
ETH_PCALLBACK wcallback; /* write callback routine */
132
ETH_MAC mac; /* MAC address */
133
enum xq_type type; /* controller type */
134
int poll; /* poll ethernet times/sec */
135
struct xq_sanity sanity; /* sanity timer information */
136
/*- initialized values - DO NOT MOVE */
138
/* I/O register storage */
144
uint32 irq; /* interrupt request flag */
147
struct xq_setup setup;
148
struct xq_stats stats;
149
uint8 mac_checksum[2];
156
ETH_PACK read_buffer;
157
ETH_PACK write_buffer;
159
int idtmr; /* countdown for ID Timer */
162
struct xq_controller {
163
DEVICE* dev; /* device block */
164
UNIT* unit; /* unit block */
165
DIB* dib; /* device interface block */
166
struct xq_device* var; /* controller-specific variables */
169
typedef struct xq_controller CTLR;
172
#define XQ_CSR_RI 0x8000 /* Receive Interrupt Request (RI) [RO/W1] */
173
#define XQ_CSR_PE 0x4000 /* Parity Error in Host Memory (PE) [RO] */
174
#define XQ_CSR_CA 0x2000 /* Carrier from Receiver Enabled (CA) [RO] */
175
#define XQ_CSR_OK 0x1000 /* Ethernet Transceiver Power (OK) [RO] */
176
#define XQ_CSR_RR 0x0800 /* Reserved : Set to Zero (RR) [RO] */
177
#define XQ_CSR_SE 0x0400 /* Sanity Timer Enable (SE) [RW] */
178
#define XQ_CSR_EL 0x0200 /* External Loopback (EL) [RW] */
179
#define XQ_CSR_IL 0x0100 /* Internal Loopback (IL) [RW] */
180
#define XQ_CSR_XI 0x0080 /* Transmit Interrupt Request (XI) [RO/W1] */
181
#define XQ_CSR_IE 0x0040 /* Interrupt Enable (IE) [RW] */
182
#define XQ_CSR_RL 0x0020 /* Receive List Invalid/Empty (RL) [RO] */
183
#define XQ_CSR_XL 0x0010 /* Transmit List Invalid/Empty (XL) [RO] */
184
#define XQ_CSR_BD 0x0008 /* Boot/Diagnostic ROM Load (BD) [RW] */
185
#define XQ_CSR_NI 0x0004 /* NonExistant Memory Timeout (NXM) [RO] */
186
#define XQ_CSR_SR 0x0002 /* Software Reset (SR) [RW] */
187
#define XQ_CSR_RE 0x0001 /* Receiver Enable (RE) [RW] */
189
/* special access bitmaps */
190
#define XQ_CSR_RO 0xF8B4 /* Read-Only bits */
191
#define XQ_CSR_RW 0x074B /* Read/Write bits */
192
#define XQ_CSR_W1 0x8080 /* Write-one-to-clear bits */
193
#define XQ_CSR_BP 0x0208 /* Boot PDP diagnostic ROM */
194
#define XQ_CSR_XIRI 0X8080 /* Transmit & Receive Interrupts */
196
#define XQ_VEC_MS 0x8000 /* Mode Select (MO) [RW] */
197
#define XQ_VEC_OS 0x4000 /* Option Switch Setting (OS) [RO] */
198
#define XQ_VEC_RS 0x2000 /* Request Self-Test (RS) [RW] */
199
#define XQ_VEC_S3 0x1000 /* Self-Test Status (S3) [RO] */
200
#define XQ_VEC_S2 0x0800 /* Self-Test Status (S2) [RO] */
201
#define XQ_VEC_S1 0x0400 /* Self-Test Status (S1) [RO] */
202
#define XQ_VEC_ST 0x1C00 /* Self-Test (S1 + S2 + S3) [RO] */
203
#define XQ_VEC_IV 0x03FC /* Interrupt Vector (IV) [RW] */
204
#define XQ_VEC_RR 0x0002 /* Reserved (RR) [RO] */
205
#define XQ_VEC_ID 0x0001 /* Identity Test Bit (ID) [RW] */
207
/* special access bitmaps */
208
#define XQ_VEC_RO 0x5C02 /* Read-Only bits */
209
#define XQ_VEC_RW 0xA3FD /* Read/Write bits */
211
#define XQ_DSC_V 0x8000 /* Valid bit */
212
#define XQ_DSC_C 0x4000 /* Chain bit */
213
#define XQ_DSC_E 0x2000 /* End of Message bit [Transmit only] */
214
#define XQ_DSC_S 0x1000 /* Setup bit [Transmit only] */
215
#define XQ_DSC_L 0x0080 /* Low Byte Termination bit [Transmit only] */
216
#define XQ_DSC_H 0x0040 /* High Byte Start bit [Transmit only] */
218
#define XQ_SETUP_MC 0x0001 /* multicast bit */
219
#define XQ_SETUP_PM 0x0002 /* promiscuous bit */
220
#define XQ_SETUP_LD 0x000C /* led bits */
221
#define XQ_SETUP_ST 0x0070 /* sanity timer bits */
223
/* debugging bitmaps */
224
#define DBG_TRC 0x0001 /* trace routine calls */
225
#define DBG_REG 0x0002 /* trace read/write registers */
226
#define DBG_CSR 0x0004 /* watch CSR */
227
#define DBG_VAR 0x0008 /* watch VAR */
228
#define DBG_WRN 0x0010 /* display warnings */
229
#define DBG_SAN 0x0020 /* display sanity timer info */
230
#define DBG_SET 0x0040 /* display setup info */
231
#define DBG_PCK 0x0080 /* display packets */
232
#define DBG_ETH 0x8000 /* debug ethernet device */
234
#endif /* _PDP11_XQ_H */