first working version of BSD/tahoe ex driver; checkpoint other
[unix-history] / usr / src / sys / tahoe / if / if_exreg.h
CommitLineData
497f05af
KS
1/*
2 * Copyright (c) 1989 The Regents of the University of California.
3 * All rights reserved.
4 *
5 * This code is derived from software contributed to Berkeley by
6 * Excelan Inc.
7 *
8 * Redistribution and use in source and binary forms are permitted
9 * provided that the above copyright notice and this paragraph are
10 * duplicated in all such forms and that any documentation,
11 * advertising materials, and other materials related to such
12 * distribution and use acknowledge that the software was developed
13 * by the University of California, Berkeley. The name of the
14 * University may not be used to endorse or promote products derived
15 * from this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
19 *
385e8f24 20 * @(#)if_exreg.h 7.2 (Berkeley) %G%
497f05af
KS
21 */
22
23struct exdevice {
24 ushort ex_porta; /* write on porta resets EXOS */
25 ushort ex_portb; /* write on portb interrupts EXOS */
26};
27
28/* EXOS I/O PORT A write definitions */
29#define EX_RESET 0 /* value doesn't really matter... */
30
31/* EXOS I/O PORT B write definitions */
32#define EX_NTRUPT 0
33
34/* EXOS I/O PORT B read definitions */
35#define EX_TESTOK 1 /* set when self-diagnostics passed */
36#define EX_UNREADY (1<<3) /* set until EXOS ready to read from B */
37
38/* message buffer status field definitions */
39#define MH_OWNER 1 /* mask for status bit for owner */
40#define MH_HOST 0 /* if 0, the host owns the buffer */
41#define MH_EXOS 1 /* if 1, the EXOS owns the buffer */
42
43/* EXOS Link Level request codes */
44#define LLTRANSMIT 0xC /* send a packet */
45#define LLRTRANSMIT 0xE /* send a packet, and self-receive */
46#define LLRECEIVE 0xD /* receive a packet */
47#define LLNET_MODE 0x8 /* read/write mode control objects */
48#define LLNET_ADDRS 0x9 /* read/write receive address slots */
49#define LLNET_RECV 0xA /* read/alter receive slot enable bit */
50#define LLNET_STSTCS 0xB /* read/reset network statistics objects */
51
52/* Link Level return codes common to all requests */
53#define LL_OK 0 /* successful completion */
54#define LLX_MODE 0xA1 /* EXOS not in link level mode (impossible) */
55
56/* LLTRANSMIT unique return codes */
57#define LLXM_1RTRY 0x1 /* successful xmission, 1 retry */
58#define LLXM_RTRYS 0x2 /* successful xmission, more than 1 retry */
59#define LLXM_NSQE 0x8 /* successful xmission, no SQE TEST signal */
60#define LLXM_CLSN 0x10 /* xmission failed, excess retries */
61#define LLXM_NCS 0x20 /* xmission failed, no carrier sense */
62#define LLXM_LNGTH 0x40 /* xmission failed, bad packet length */
63#define XMIT_BITS "\7\7LENGTH\6CARRIER\5XCLSNS\4SQETST"
385e8f24
KS
64/*#define LLXM_ERROR (LLXM_NSQE|LLXM_CLSN|LLXM_NCS|LLXM_LNGTH)*/
65#define LLXM_ERROR (LLXM_CLSN|LLXM_NCS|LLXM_LNGTH)
497f05af
KS
66
67/* LLRECEIVE unique return codes */
68#define LLRC_TRUNC 0x4 /* pkt received, but truncated to fit buffer */
69#define LLRC_ALIGN 0x10 /* pkt received, but with alignment error */
70#define LLRC_CRC 0x20 /* pkt received, but with CRC error */
71#define LLRC_BUFLEN 0x40 /* no pkt received, buffer less than 64 bytes */
72 /* this should never happen here */
73#define RECV_BITS "\7\7BUFLEN\6CRC\5ALIGN\3TRUNC"
74
75/* LLNET_ADDRS unique return codes */
76#define LLNA_BADSLOT 0xD1 /* slot doesn't exist or can't be accessed */
77#define LLNA_BADADDR 0xD3 /* invalid address for designated slot */
78
79/* LLNET_RECV unique return codes */
80#define LLNR_BADSLOT 0xD1 /* slot doesn't exist or can't be accessed */
81#define LLNR_BADADDR 0xD2 /* designated slot was empty */
82
83/* address slot object indices */
84#define NULLSLOT 0 /* the null slot */
85#define MINMCSLOT 1 /* minimum multicast slot index */
86#define MAXMCSLOT 8 /* default maximum multicast slot index */
87#define PHYSSLOT 253 /* physical slot index */
88#define UNVRSSLOT 254 /* universal slot index */
89#define BROADSLOT 255 /* broadcast slot index */
90
91/* request mask bit definitions */
92#define WRITE_OBJ 1 /* write the object */
93#define READ_OBJ 2 /* read the object */
94#define ENABLE_RCV 4 /* enable reception on designated slot */
95
96/* NET_MODE options mask bit definitions */
97#define OPT_ALIGN 0x10 /* receive packets with alignment errors */
98#define OPT_CRC 0x20 /* receive packets with CRC errors */
99#define OPT_DSABLE 0x80 /* disconnect controller hardware */
100
101/* NET_MODE mode field value definitions */
102#define MODE_OFF 0 /* stop transmission and reception */
103#define MODE_PERF 1 /* perfect multicast address filtering */
104#define MODE_HW 2 /* hardware-only multicast address filtering */
105#define MODE_PROM 3 /* promiscuous reception */
106
497f05af 107#define NFRAGMENTS 8 /* number fragments that the EXOS will scatter/gather */
497f05af
KS
108#define EXMAXRBUF 1518 /* per EXOS 202 manual 5.3.7 (maybe 1518 would do) */
109
110/*
111 * N.B. Structures below are carefully constructed so that
112 * they correspond to the message formats that NX firmware
113 * defines. None of them should contain any compiler-instigated
114 * padding. Be especially careful about VAX C longword alignment!
115 */
116
385e8f24 117struct ex_stat {
497f05af
KS
118 u_long sa_fsent; /* frames sent without errors */
119 u_long sa_xsclsn; /* frames aborted excess collisions */
120 u_long sa_nsqe; /* frames subject to heartbeat failure */
121 u_long sa_undef; /* undefined (TDR on EXOS 101) */
122 u_long sa_frcvd; /* frames received no errors */
123 u_long sa_align; /* frames received alignment error */
124 u_long sa_crc; /* frames received crc error */
125 u_long sa_flost; /* frames lost */
126};
127
128struct buf_blk { /* packet/buffer block descriptor */
129 u_short bb_len; /* length of block, in bytes */
130 struct i86_long {
131 u_short realaddr[2]; /* address of block */
132 } bb_addr;
133 /*
134 * Array above is really a single u_long field.
135 * We kludge its definition to defeat word-alignment.
136 */
137};
138
139struct net_mode { /* read/write mode control objects */
140/*12*/ u_char nm_rqst; /* request code */
141/*13*/ u_char nm_rply; /* reply code */
142/*14*/ u_char nm_mask; /* bit-wise switches for read, write */
143/*15*/ u_char nm_optn; /* acceptable packet reception errors */
144/*16*/ u_char nm_mode; /* EXOS filtering mode */
145/*17*/
146};
147
148struct net_addrs { /* read/write receive address slots */
149/*12*/ u_char na_rqst; /* request code */
150/*13*/ u_char na_rply; /* reply code */
151/*14*/ u_char na_mask; /* bit-wise switches for read, write */
152/*15*/ u_char na_slot; /* index of address slot */
153/*16*/ u_char na_addrs[6]; /* address read and/or written */
154/*22*/
155};
156
157struct net_recv { /* read/alter receive slot enable bit */
158/*12*/ u_char nr_rqst; /* request code */
159/*13*/ u_char nr_rply; /* reply code */
160/*14*/ u_char nr_mask; /* bit-wise switches for read, write */
161/*15*/ u_char nr_slot; /* index of address slot */
162/*16*/
163};
164
165struct net_ststcs { /* read/reset network statistics objects */
166/*12*/ u_char ns_rqst; /* request code */
167/*13*/ u_char ns_rply; /* reply code */
168/*14*/ u_char ns_mask; /* bit-wise switches for read, write */
169/*15*/ u_char ns_rsrv; /* reserved for EXOS */
170/*16*/ u_short ns_nobj; /* number of objects to work on */
171/*18*/ u_short ns_xobj; /* index of first object to work on */
172/*20*/ u_long ns_bufp; /* pointer to statistics buffer */
173/*24*/
174};
175
176struct enet_xmit { /* send a packet on the Ethernet */
177/*12*/ u_char et_rqst; /* request code */
178/*13*/ u_char et_rply; /* reply code */
179/*14*/ u_char et_slot; /* address slot matching dest address */
180/*15*/ u_char et_nblock; /* number of blocks composing packet */
181/*16*/ struct buf_blk et_blks[NFRAGMENTS]; /* array of block descriptors */
182/*22-64*/
183};
184
185struct enet_recv { /* receive a packet on the Ethernet */
186/*12*/ u_char er_rqst; /* request code */
187/*13*/ u_char er_rply; /* reply code */
188/*14*/ u_char er_slot; /* address slot matching dest address */
189/*15*/ u_char er_nblock; /* number of blocks composing buffer */
190/*16*/ struct buf_blk er_blks[NFRAGMENTS]; /* array of block descriptors */
191/*22-64*/
192};
193
194/* we send requests and receive replys with the EXOS using this structure */
195struct ex_msg {
196/*00*/ u_short mb_link; /* address of next message buffer */
197/*02*/ u_char mb_rsrv; /* reserved for use by EXOS */
198/*03*/ u_char mb_status; /* used bit-wise for message protocol */
199/*04*/ u_short mb_length; /* length, in bytes, of the rest */
200/*06*/ short mb_1rsrv; /* reserved for used by EXOS */
201/*08*/ struct ifvba *mb_pkb; /* available to user */
202/*12*/ union mb_all {
203 struct net_mode mb_net_mode;
204 struct net_addrs mb_net_addrs;
205 struct net_recv mb_net_recv;
206 struct net_ststcs mb_net_ststcs;
207 struct enet_xmit mb_enet_xmit;
208 struct enet_recv mb_enet_recv;
209 } mb_all;
210/* following field is used only by host, not read by board */
211 struct ex_msg *mb_next; /* host's pointer to next message */
212};
213#define mb_nm mb_all.mb_net_mode
214#define mb_na mb_all.mb_net_addrs
215#define mb_nr mb_all.mb_net_recv
216#define mb_ns mb_all.mb_net_ststcs
217#define mb_et mb_all.mb_enet_xmit
218#define mb_er mb_all.mb_enet_recv
219#define mb_rqst mb_nm.nm_rqst
220#define mb_rply mb_nm.nm_rply
221#define MBDATALEN (sizeof(union mb_all)+6)
222
385e8f24 223struct ex_conf {
497f05af
KS
224/*00*/ u_short cm_1rsrv; /* reserved, must be 1 */
225/*02*/ char cm_vc[4]; /* returns ASCII version code */
226/*06*/ u_char cm_cc; /* returns config completion code */
227/*07*/ u_char cm_opmode; /* specifies operation mode */
228/*08*/ u_short cm_dfo; /* specifies host data format option */
229/*00*/ u_char cm_dcn1; /* reserved, must be 1 */
230/*11*/ u_char cm_2rsrv[2]; /* reserved, must be 0 */
231/*13*/ u_char cm_ham; /* specifies host address mode */
232/*14*/ u_char cm_3rsrv; /* reserved, must be 0 */
233/*15*/ u_char cm_mapsiz; /* reserved, must be 0 */
234/*16*/ u_char cm_byteptrn[4]; /* host data format option test pattern */
235/*20*/ u_short cm_wordptrn[2];
236/*24*/ u_long cm_lwordptrn;
237/*28*/ u_char cm_rsrvd[20];
238/*48*/ u_long cm_mba; /* use 0xFFFFFFFF in link level mode */
239/*52*/ u_char cm_nproc; /* use 0xFF in link level mode */
240/*53*/ u_char cm_nmbox; /* use 0xFF in link level mode */
241/*54*/ u_char cm_nmcast; /* use 0xFF in link level mode */
242/*55*/ u_char cm_nhost; /* use 1 in link level mode */
243
244 /* the next five parameters define the request message queue */
245/*56*/ u_long cm_h2xba; /* base address of message queue */
246/*60*/ u_short cm_h2xhdr; /* address offset of msg Q header */
247/*62*/ u_char cm_h2xtyp; /* interrupt type */
248/*63*/ u_char cm_h2xval; /* interrupt value (not used) */
249/*64*/ u_short cm_h2xaddr; /* interrupt vector */
250/*66*/ u_short cm_h2xpad; /* pad out unused portion of vector */
251
252 /* the next five parameters define the reply message queue */
253/*68*/ u_long cm_x2hba; /* base address of message queue */
254/*72*/ u_short cm_x2hhdr; /* address offset of msg Q header */
255/*74*/ u_char cm_x2htyp; /* interrupt type */
256/*75*/ u_char cm_x2hval; /* interrupt value (not used) */
257/*76*/ u_short cm_x2haddr; /* interrupt vector */
258/*78*/ u_short cm_x2hpad; /* pad out unused portion of vector */
259/*80*/
260};