2.11BSD#431 - /usr/src/sys/vaxif/if_hyreg.h

   1: /*
   2:  *	@(#)if_hyreg.h	7.1 (Berkeley) 6/5/86
   3:  *
   4:  * $Header: if_hyreg.h,v 10.0 84/06/30 19:51:34 steveg Stable $
   5:  * $Locker:  $
   6:  *
   7:  * Modifications from Berkeley 4.2 BSD
   8:  * Copyright (c) 1983, Tektronix Inc.
   9:  * All Rights Reserved
  10:  *
  11:  */
  12: 
  13: 
  14: /*
  15:  * Network Systems Corporation Hyperchannel interface
  16:  *
  17:  * supports A410 adapter interfaced via a DEC DR-11B, NSC PI-13 or PI-14
  18:  *	(PI-14 is a PI-13 with different line drivers, software is
  19:  *	identical to a PI-13)
  20:  *
  21:  * Written by Steve Glaser, Tektronix Inc., July 1982
  22:  *
  23:  * NOTE:
  24:  *
  25:  * DR11B code has not been fully checked out with 4.1a.
  26:  * The first adapters at Tek came with DR11Bs, and the code once worked,
  27:  * but those have been upgraded to PI-13s.
  28:  */
  29: 
  30: /*
  31:  * The HYPERchannel driver sends and receives messages formatted:
  32:  *
  33:  *	+---------------------------------------+	---
  34:  *	|					|	/|\
  35:  *	|  HYPERchannel adapter header (hy_hdr)	|	 |
  36:  *	|					|	 |
  37:  *	+---------------------------------------+	 |
  38:  *	|					|	 |
  39:  *	|     Internet Protocol header (ip)	|    message proper
  40:  *	|					|    (64 bytes max)
  41:  *	+---------------------------------------+	 |
  42:  *	|					|	 |
  43:  *	|	TCP header + user data		|	 |
  44:  *	|	(if it all fits here)		|	 |
  45:  *	|					|	\|/
  46:  *	+---------------------------------------+	---
  47:  *
  48:  *	+---------------------------------------+	---
  49:  *	|					|	/|\
  50:  *	|					|	 |
  51:  *	|	TCP header + user data		|  associated data
  52:  *	|					|	 |
  53:  *	|					|	\|/
  54:  *	+---------------------------------------+	---
  55:  *
  56:  * If all of the datagram will fit in the message proper (including
  57:  * the TCP header and user data) the entire datagram is passed in
  58:  * the message proper and the associated data feature of the HYPERchannel
  59:  * is not used.
  60:  *
  61:  * The mapping from internet addresses to HYPERchannel addresses is:
  62:  *
  63:  *	 0       7 8      15 16                   31
  64:  *	+---------+---------+-----------------------+
  65:  *	| network | special | HYPERchannel address  |
  66:  *	+---------+---------+-----------------------+
  67:  *
  68:  *	|<------------ internet address ----------->|
  69:  *
  70:  * The hyperchannel address is decoded as follows:
  71:  *
  72:  *       0                 7 8             13 14  15
  73:  *	+-------------------+----------------+------+
  74:  *	|   adapter number  |      zero      | port |
  75:  *	+-------------------+----------------+------+
  76:  *
  77:  * The low 2 bits are port number (interpreted by hyperchannel hardware).
  78:  *
  79:  * The encoding of special bits is:
  80:  *
  81:  *	00	normal packet
  82:  *
  83:  *	01	loop this packet back to the sender at the
  84:  *		specified adapter (ip header source/destination addresses
  85:  *		swapped before sending, command bits added to tell the
  86:  *		remote HYPERchannel adapter debug & performance studies]
  87:  *		this code acts like 02 (below) if the ip destination (before
  88:  *		any swapping) and the destination address don't match (e.g.
  89:  *		this packet is being routed through a gateway)
  90:  *
  91:  *	02	loop this packet back to the sender at the
  92:  *		specified adapter, but go through the specified adapter's
  93:  *		IP.  This is for testing IP's store and forward mechanism.
  94:  *
  95:  *	other	undefined, currently treated as normal packet
  96:  *
  97:  */
  98: #define MPSIZE      64  /* "Message Proper" size */
  99: #define MAXRETRY    4
 100: 
 101: /*
 102:  * Device registers
 103:  */
 104: struct  hydevice {
 105:     short   hyd_wcr;    /* word count (negated) */
 106:     u_short hyd_bar;    /* bus address bits 15-0 */
 107:     u_short hyd_csr;    /* control and status */
 108:     u_short hyd_dbuf;   /* data buffer */
 109: };
 110: 
 111: /*
 112:  * CSR bit layout
 113:  */
 114: #define S_ERROR    0100000  /* error */
 115: #define S_NEX      0040000  /* non-existent memory error */
 116: #define S_ATTN     0020000  /* attn (always zero) */
 117: #ifdef PI13
 118: #define S_STKINTR  0010000  /* stacked interrupt */
 119: #else
 120: #define S_MAINT    0010000  /* maintenance (not used) */
 121: #endif
 122: #define S_A    0004000  /* device status A (recieve data available) */
 123: #define S_B    0002000  /* device status B (normal termination) */
 124: #define S_C    0001000  /* device status C (abnormal termination) */
 125: #ifdef PI13
 126: #define S_POWEROFF 0000400  /* power off indicator */
 127: #else
 128: #define S_CYCLE    0000400  /* cycle (not used) */
 129: #endif
 130: #define S_READY    0000200  /* ready */
 131: #define S_IE       0000100  /* interrupt enable */
 132: #define S_XBA      0000060  /* bus address bit bits 17 and 16 */
 133: #define S_CLRINT   0000014  /* clear stacked interrupt */
 134: #define S_IATTN    0000010  /* interrupt on attention only */
 135: #define S_WC       0000004  /* interrupt on word count == 0 only */
 136: #define S_IATTNWC  0000000  /* interrupt on word count == 0 and attention */
 137: #define S_BURST    0000002  /* burst mode DMA (not used) */
 138: #define S_GO       0000001  /* go */
 139: 
 140: #define XBASHIFT    12
 141: 
 142: #define HY_CSR_BITS "\20\
 143: \20ERROR\17NEX\16ATTN\15STKINTR\14RECV_DATA\13NORMAL\12ABNORMAL\11POWER\
 144: \10READY\07IENABLE\06XBA17\05XBA16\04IATTN\03IWC\02BURST\01GO"
 145: 
 146: /*
 147:  * PI13 status conditions
 148:  */
 149: #define HYS_RECVDATA(x) (((x)->hyd_csr & S_A) != 0) /* get adapter data */
 150: #define HYS_NORMAL(x)   (((x)->hyd_csr & S_B) != 0) /* done normally */
 151: #define HYS_ABNORMAL(x) (((x)->hyd_csr & S_C) != 0) /* done abnormally */
 152: #define HYS_ERROR(x)    (((x)->hyd_csr & S_ERROR) != 0) /* error condition */
 153: #define HYS_DONE(x) (((x)->hyd_csr & (S_ERROR|S_B|S_C)) != 0)
 154: 
 155: /*
 156:  * Function Codes for the Hyperchannel Adapter
 157:  * The codes are offset so they can be "or"ed into
 158:  * the reg data buffer
 159:  */
 160: #define HYF_XMITMSG 0x04    /* transmit message */
 161: #define HYF_XMITDATA    0x08    /* transmit associated data */
 162: #define HYF_XMITLSTDATA 0x0C    /* transmit last associated data */
 163: #define HYF_XMITLOCMSG  0x10    /* transmit local message */
 164: #define HYF_INPUTMSG    0x24    /* input message proper */
 165: #define HYF_INPUTDATA   0x28    /* input assiciated data */
 166: #define HYF_STATUS  0x40    /* request status */
 167: #define HYF_DUMPREGS    0x50    /* dump extention registers */
 168: #define HYF_MARKP0  0x60    /* mark down port 0 */
 169: #define HYF_MARKP1  0x64    /* mark down port 1 */
 170: #define HYF_MARKP2  0x68    /* mark down port 2 */
 171: #define HYF_MARKP3  0x6C    /* mark down port 3 */
 172: #define HYF_MP0RR   0x70    /* mark down port 0 and reroute messages */
 173: #define HYF_MP1RR   0x74    /* mark down port 1 and reroute messages */
 174: #define HYF_MP2RR   0x78    /* mark down port 2 and reroute messages */
 175: #define HYF_MP3RR   0x7C    /* mark down port 3 and reroute messages */
 176: #define HYF_RSTATS  0xA0    /* read statistics */
 177: #define HYF_RCSTATS 0xA4    /* read and clear statistics */
 178: #define HYF_SETTEST 0xC0    /* enable test operations *set test mode) */
 179: #define HYF_SADDR_LEN   0xC4    /* test mode: set address and length */
 180: #define HYF_WBUFF   0xC8    /* test mode: write buffer */
 181: #define HYF_RBUFF   0xCC    /* test mode: read buffer */
 182: #define HYF_CLRADAPTER  0xE0    /* clear adapter */
 183: #define HYF_END_OP  0xE4    /* end operation */
 184: #define HYF_CLRWFMSG    0xE6    /* clear wait for mwssage */
 185: #define HYF_WAITFORMSG  0xE8    /* wait for message */

Defined struct's

Defined macros