xref: /original-bsd/sys/vax/if/if_hy.h (revision 62cd422e)
1 /*
2  * Copyright (c) 1982, 1986 Regents of the University of California.
3  * All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * Tektronix Inc.
7  *
8  * %sccs.include.redist.c%
9  *
10  *	@(#)if_hy.h	7.4 (Berkeley) 06/28/90
11  */
12 
13 /*
14  * 4.2 BSD Unix Kernel - Vax Network Interface Support
15  *
16  * $Header: if_hy.h,v 10.0 84/06/30 19:51:21 steveg Stable $
17  * $Locker:  $
18  *
19  * Modifications from Berkeley 4.2 BSD
20  * Copyright (c) 1983, Tektronix Inc.
21  * All Rights Reserved
22  *
23  *
24  * $Log:	if_hy.h,v $
25  *	Revision 10.0  84/06/30  19:51:21  steveg
26  *	Big Build
27  *
28  *	Revision 3.13  84/05/30  19:40:58  steveg
29  *	update hy_stat to reflect new microcode
30  *
31  *	Revision 3.12  84/05/30  19:06:57  steveg
32  *	move driver state number definition here from if_hy.c
33  *
34  *	Revision 3.11  84/05/30  18:56:15  steveg
35  *	add definition of HYE_MAX and HYE_SIZE
36  *
37  *	Revision 3.10  84/05/30  17:14:04  steveg
38  *	add hyl_filter
39  *
40  *	Revision 3.9  84/05/30  13:45:24  steveg
41  *	rework logging
42  *
43  *	Revision 3.8  84/05/04  05:18:59  steveg
44  *	hyr_key now a u_long
45  *
46  *	Revision 3.7  84/05/01  22:45:20  steveg
47  *	add H_RLOOPBK for A710 remote end loopback command
48  *
49  *
50  */
51 
52 
53 /*
54  * Structure of a HYPERchannel adapter header
55  */
56 struct	hy_hdr {
57 	short	hyh_ctl;		/* control */
58 	short	hyh_access;		/* access code */
59 	union {
60 		short	hyh_addr;
61 		char	hyh_baddr[2];
62 	} hyh_uto, hyh_ufrom;		/* to/from address */
63 	short	hyh_param;		/* parameter word */
64 	short	hyh_type;		/* record type */
65 };
66 
67 
68 #define hyh_to		hyh_uto.hyh_addr
69 #define hyh_to_port	hyh_uto.hyh_baddr[1]
70 #define hyh_to_adapter	hyh_uto.hyh_baddr[0]
71 
72 #define hyh_from	hyh_ufrom.hyh_addr
73 #define hyh_from_port	hyh_ufrom.hyh_baddr[1]
74 #define hyh_from_adapter hyh_ufrom.hyh_baddr[0]
75 
76 /*
77  * Structure of a HYPERchannel message header (from software)
78  */
79 struct	hym_hdr {
80 	struct {
81 		short	hymd_mplen;	/* message proper len, if associated data */
82 	} hym_d;
83 	struct	hy_hdr hym_h;	/* hardware header, MUST BE LAST */
84 };
85 
86 #define hym_mplen	hym_d.hymd_mplen
87 
88 #define hym_ctl		hym_h.hyh_ctl
89 #define hym_access	hym_h.hyh_access
90 #define hym_param	hym_h.hyh_param
91 #define hym_type	hym_h.hyh_type
92 
93 #define hym_to		hym_h.hyh_to
94 #define hym_to_port	hym_h.hyh_to_port
95 #define hym_to_adapter	hym_h.hyh_to_adapter
96 
97 #define hym_from	hym_h.hyh_from
98 #define hym_from_port	hym_h.hyh_from_port
99 #define hym_from_adapter hym_h.hyh_from_adapter
100 
101 #define HYM_SWLEN (sizeof(struct hym_hdr) - sizeof(struct hy_hdr))
102 
103 /*
104  * HYPERchannel header word control bits
105  */
106 #define H_XTRUNKS	0x00F0	/* transmit trunks */
107 #define H_RTRUNKS	0x000F	/* remote trunks to transmit on for loopback */
108 #define H_ASSOC		0x0100	/* has associated data */
109 #define H_LOOPBK	0x00FF	/* loopback command */
110 #define H_RLOOPBK	0x008F	/* A710 remote loopback command */
111 
112 /*
113  * Hyperchannel record types
114  */
115 #define HYLINK_IP	0	/* Internet Protocol Packet */
116 
117 /*
118  * Routing database
119  */
120 #define HYRSIZE  37	/* max number of adapters in routing tables */
121 
122 struct hy_route {
123 	time_t hyr_lasttime;		/* last update time */
124 	u_char hyr_gateway[256];
125 	struct hyr_hash {
126 		u_long	hyr_key;	/* desired address */
127 		u_short hyr_flags;	/* status flags - see below */
128 		u_short hyr_size;	/* number of entries */
129 		union {
130 			/*
131 			 * direct entry (can get there directly)
132 			 */
133 			struct {
134 				u_short hyru_dst;	/* adapter number & port */
135 				u_short hyru_ctl;	/* trunks to try */
136 				u_short hyru_access;	/* access code (mostly unused) */
137 			} hyr_d;
138 #define hyr_dst		hyr_u.hyr_d.hyru_dst
139 #define hyr_ctl		hyr_u.hyr_d.hyru_ctl
140 #define hyr_access	hyr_u.hyr_d.hyru_access
141 			/*
142 			 * indirect entry (one or more hops required)
143 			 */
144 			struct {
145 				u_char hyru_pgate;	/* 1st gateway slot */
146 				u_char hyru_egate;	/* # gateways */
147 				u_char hyru_nextgate;	/* gateway to use next */
148 			} hyr_i;
149 #define hyr_pgate	hyr_u.hyr_i.hyru_pgate
150 #define hyr_egate	hyr_u.hyr_i.hyru_egate
151 #define hyr_nextgate	hyr_u.hyr_i.hyru_nextgate
152 		} hyr_u;
153 	} hyr_hash[HYRSIZE];
154 };
155 
156 /*
157  * routing table set/get structure
158  *
159  * used to just pass the entire routing table through, but 4.2 ioctls
160  * limit the data part of an ioctl to 128 bytes or so and use the
161  * interface name to get things sent the right place.
162  * see ../net/if.h for additional details.
163  */
164 struct hyrsetget {
165 	char	hyrsg_name[IFNAMSIZ];	/* if name, e.g. "hy0" */
166 	struct hy_route *hyrsg_ptr;	/* pointer to routing table */
167 	unsigned	hyrsg_len;	/* size of routing table provided */
168 };
169 
170 #define HYR_INUSE	0x01	/* entry in use */
171 #define HYR_DIR		0x02	/* direct entry */
172 #define HYR_GATE	0x04	/* gateway entry */
173 #define HYR_LOOP	0x08	/* hardware loopback entry */
174 #define HYR_RLOOP	0x10	/* remote adapter hardware loopback entry */
175 
176 #define HYRHASH(x) (((x) ^ ((x) >> 16)) % HYRSIZE)
177 
178 #define HYSETROUTE	_IOW('i', 0x80, struct hyrsetget)
179 #define HYGETROUTE	_IOW('i', 0x81, struct hyrsetget)
180 
181 struct	hylsetget {
182 	char	hylsg_name[IFNAMSIZ];	/* if name, e.g. "hy0" */
183 	int	hylsg_cmd;		/* logging command */
184 	caddr_t	hylsg_ptr;		/* pointer to table */
185 	u_long	hylsg_len;		/* size of table provided */
186 };
187 
188 #define HYSETLOG	_IOW('i', 0x82, struct hylsetget)
189 #define HYGETLOG	_IOW('i', 0x83, struct hylsetget)
190 #define HYGETELOG	_IOW('i', 0x84, struct hylsetget)
191 
192 /*
193  * Structure of Statistics Record (counters)
194  */
195 struct	hy_stat {
196 	u_char	hyc_df0[3];		/* # data frames trunk 0 */
197 	u_char	hyc_df1[3];		/* # data frames trunk 1 */
198 	u_char	hyc_df2[3];		/* # data frames trunk 2 */
199 	u_char	hyc_df3[3];		/* # data frames trunk 3 */
200 	u_char	hyc_cancel[2];		/* # cancel operations */
201 	u_char	hyc_abort[2];		/* # aborts */
202 	u_char	hyc_ret0[3];		/* # retransmissions trunk 0 */
203 	u_char	hyc_ret1[3];		/* # retransmissions trunk 1 */
204 	u_char	hyc_ret2[3];		/* # retransmissions trunk 2 */
205 	u_char	hyc_ret3[3];		/* # retransmissions trunk 3 */
206 	u_char	hyc_atype[3];		/* adapter type and revision level */
207 	u_char	hyc_uaddr;		/* adapter unit number */
208 };
209 
210 /*
211  * Structure of the Status Record
212  */
213 struct hy_status {
214 	u_char	hys_gen_status;		/* general status byte */
215 	u_char	hys_last_fcn;		/* last function code issued */
216 	u_char	hys_resp_trunk;		/* trunk response byte */
217 	u_char	hys_status_trunk;	/* trunk status byte */
218 	u_char	hys_recd_resp;		/* recieved response byte */
219 	u_char	hys_error;		/* error code */
220 	u_char	hys_caddr;		/* compressed addr of 1st msg on chain */
221 	u_char	hys_pad;		/* not used */
222 };
223 
224 /*
225  * Get port number from status record
226  */
227 #define PORTNUM(p)	(((p)->hys_gen_status >> 6) & 0x03)
228 
229 #define HYL_SIZE 16*1024
230 struct hy_log {
231 	struct	hy_log *hyl_self;
232 	u_char	hyl_enable;		/* logging enabled? */
233 	u_char	hyl_onerr;		/* state to enter on error */
234 	u_short	hyl_wait;		/* number of bytes till next wakeup */
235 	u_short	hyl_count;		/* number of samples till stop */
236 	u_short hyl_icount;		/* initial value of hyl_count */
237 	u_long	hyl_filter;		/* log items with specific bits set */
238 	u_char	*hyl_eptr;		/* &hy_log.hyl_buf[HYL_SIZE] */
239 	u_char	*hyl_ptr;		/* pointer into hyl_buf */
240 	u_char	hyl_buf[HYL_SIZE];	/* log buffer space */
241 };
242 
243 #define HYL_NOP		0
244 #define HYL_UP		1	/* markup */
245 #define HYL_STATUS	2	/* status results (struct hy_status) */
246 #define HYL_STATISTICS	3	/* statistics (struct hy_stat) */
247 #define HYL_XMIT	4	/* packed being send (struct hym_hdr) */
248 #define HYL_RECV	5	/* recieved pkt (short len; struct hym_hdr) */
249 #define HYL_CMD		6	/* cmd issued (uchar cmd, state; short count) */
250 #define HYL_INT		7	/* interrupt (short csr, wcr) */
251 #define	HYL_CANCEL	8	/* cancel transmit attempt */
252 #define	HYL_RESET	9	/* hyinit or unibus reset */
253 #define	HYL_IOCTL	10	/* hyioctl */
254 
255 #define HYL_DISABLED	0	/* logging disabled */
256 #define HYL_CONTINUOUS	1	/* continuous logging */
257 #define HYL_CATCHN	2	/* hyl_count transactions being captured */
258 
259 /*
260  * error code histograms
261  */
262 #define	HYE_MAX		0x18		/* maximum adapter error code */
263 #define	HYE_BINS	4		/* number of command bins */
264 #define	HYE_SIZE  (HYE_MAX+1)*HYE_BINS	/* size of histogram buffer */
265 
266 /*
267  * Requests for service (in order by descending priority).
268  */
269 #define RQ_ENDOP	001	/* end the last adapter function */
270 #define RQ_REISSUE	002	/* reissue previous cmd after status */
271 #define RQ_STATUS	004	/* get the status of the adapter */
272 #define RQ_STATISTICS	010	/* get the statistics of the adapter */
273 #define RQ_MARKDOWN	020	/* mark this adapter port down */
274 #define RQ_MARKUP	040	/* mark this interface up */
275 
276 #define RQ_XASSOC	0100	/* associated data to transmit */
277 
278 /*
279  * Driver states.
280  */
281 #define	STARTUP		0	/* initial state (before fully there) */
282 #define	IDLE		1	/* idle state */
283 #define	STATSENT	2	/* status cmd sent to adapter */
284 #define	ENDOPSENT	3	/* end operation cmd sent */
285 #define	RECVSENT	4	/* input message cmd sent */
286 #define	RECVDATASENT	5	/* input data cmd sent */
287 #define	XMITSENT	6	/* transmit message cmd sent */
288 #define	XMITDATASENT	7	/* transmit data cmd sent */
289 #define	WAITING		8	/* waiting for messages */
290 #define	CLEARSENT	9	/* clear wait for message cmd sent */
291 #define MARKPORT	10	/* mark this host's adapter port down issued */
292 #define RSTATSENT	11	/* read statistics cmd sent to adapter */
293 
294 #ifdef HYLOG
295 char *hy_state_names[] = {
296 	"Startup",
297 	"Idle",
298 	"Status Sent",
299 	"End op Sent",
300 	"Recieve Message Proper Sent",
301 	"Recieve Data Sent",
302 	"Transmit Message Proper Sent",
303 	"Transmit Data Sent",
304 	"Wait for Message Sent",
305 	"Clear Wait for Message Sent",
306 	"Mark Port Down Sent",
307 	"Read Statistics Sent"
308 };
309 #endif
310 
311