Initial import from FreeBSD RELENG_4:
[dragonfly.git] / sys / dev / atm / hfa / fore.h
1 /*
2  *
3  * ===================================
4  * HARP  |  Host ATM Research Platform
5  * ===================================
6  *
7  *
8  * This Host ATM Research Platform ("HARP") file (the "Software") is
9  * made available by Network Computing Services, Inc. ("NetworkCS")
10  * "AS IS".  NetworkCS does not provide maintenance, improvements or
11  * support of any kind.
12  *
13  * NETWORKCS MAKES NO WARRANTIES OR REPRESENTATIONS, EXPRESS OR IMPLIED,
14  * INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY
15  * AND FITNESS FOR A PARTICULAR PURPOSE, AS TO ANY ELEMENT OF THE
16  * SOFTWARE OR ANY SUPPORT PROVIDED IN CONNECTION WITH THIS SOFTWARE.
17  * In no event shall NetworkCS be responsible for any damages, including
18  * but not limited to consequential damages, arising from or relating to
19  * any use of the Software or related support.
20  *
21  * Copyright 1994-1998 Network Computing Services, Inc.
22  *
23  * Copies of this Software may be made, however, the above copyright
24  * notice must be reproduced on all copies.
25  *
26  *      @(#) $FreeBSD: src/sys/dev/hfa/fore.h,v 1.2.2.1 2001/07/20 20:43:17 pirzyk Exp $
27  *
28  */
29
30 /*
31  * FORE Systems 200-Series Adapter Support
32  * ---------------------------------------
33  *
34  * Protocol and implementation definitions
35  *
36  */
37
38 #ifndef _FORE_H
39 #define _FORE_H
40
41 #ifndef FORE_DEV_NAME
42 #define FORE_DEV_NAME   "hfa"
43 #endif
44
45 #define FORE_MAX_UNITS  8       /* Maximum number of devices we support */
46 #define FORE_MIN_UCODE  0x20300 /* Minimum microcode version we support */
47
48 #define FORE_IFF_MTU    9188    /* Network interface MTU */
49 #define FORE_MAX_VCC    1024    /* Maximum number of open VCCs */
50 #define FORE_MAX_VPI    0       /* Maximum VPI value */
51 #define FORE_MAX_VCI    1023    /* Maximum VCI value */
52 #define FORE_DEF_RATE   0x00000000      /* Default rate control = disabled */
53
54 #define XMIT_QUELEN     32      /* Length of transmit queue */
55 #define RECV_QUELEN     32      /* Length of receive queue */
56 #define CMD_QUELEN      8       /* Length of command queue */
57
58 #define FORE_TIME_TICK  5       /* Watchdog timer tick (seconds) */
59 #define FORE_WATCHDOG   3       /* Device watchdog timeout (ticks) */
60 #define FORE_RECV_RETRY 3       /* Wait for receive queue entry retry count */
61 #define FORE_RECV_DELAY 10      /* Wait for receive queue entry delay (usec) */
62
63
64 /*
65  * Receive Buffer strategies
66  */
67 #define BUF_MIN_VCC     4       /* Minimum for buffer supply calculations */
68
69 #ifdef FORE_SBUS
70 #if defined(sun4c)
71 #define BUF_DATA_ALIGN  32      /* Fore-required data alignment */
72 #elif defined(sun4m)
73 #define BUF_DATA_ALIGN  64      /* Fore-required data alignment */
74 #endif
75 #endif
76 #ifdef FORE_PCI
77 #define BUF_DATA_ALIGN  4       /* Fore-required data alignment */
78 #endif
79
80 #if defined(BSD)
81 /*
82  * Strategy 1 Small - mbuf
83  * Strategy 1 Large - cluster mbuf
84  *
85  * XXX buffer controls - the RECV_MAX_SEGS calculation comes out wrong
86  * using the true buffer size values if the CP really only does full-cell
87  * filling of a particular buffer - we must clarify this...it also appears
88  * the minimum buffer size is 64, even if the CP can only fit in 1 cell.
89  */
90 #define SIZEOF_Buf_handle       16      /* XXX sizeof(Buf_handle) */
91
92 #if BSD >= 199103
93 #undef m_ext
94 typedef struct m_ext    M_ext;
95 #define m_ext           M_dat.MH.MH_dat.MH_ext
96 #define BUF1_SM_HOFF    (sizeof(struct m_hdr))  /* Buffer-to-handle offset */
97 #define BUF1_SM_HDR     (sizeof(struct m_hdr) + sizeof(struct pkthdr))
98 #define BUF1_SM_LEN     (MHLEN)
99 #define BUF1_LG_HOFF    (sizeof(struct m_hdr) + sizeof(struct pkthdr) \
100                             + sizeof(M_ext))    /* Buffer-to-handle offset */
101 #else
102 #define BUF1_SM_HOFF    (MMINOFF)               /* Buffer-to-handle offset */
103 #define BUF1_SM_HDR     (MMINOFF)
104 #define BUF1_SM_LEN     (MLEN)
105 #define BUF1_LG_HOFF    (MMINOFF + 16)          /* Buffer-to-handle offset */
106 #endif
107
108 /*
109  * BUF1_SM_DOFF - CP data offset into buffer data space
110  * BUF1_SM_SIZE - Buffer size
111  *
112  * These should be defined as follows, but we need compile-time constants:
113  *
114  *      #define BUF1_SM_DOFF (roundup(BUF1_SM_HOFF + SIZEOF_Buf_handle, 
115  *                      BUF_DATA_ALIGN) - BUF1_SM_HDR)
116  *      #define BUF1_SM_SIZE    MAX(BUF1_SM_LEN - BUF1_SM_DOFF, 64)
117  *
118  */
119 #if ((BSD >= 199103) && defined(FORE_PCI))
120 #define BUF1_SM_DOFF    (SIZEOF_Buf_handle)
121 #define BUF1_SM_SIZE    (BUF1_SM_LEN - BUF1_SM_DOFF)
122 #endif
123 #if ((BSD < 199103) && defined(FORE_SBUS) && defined(sun4c))
124 #define BUF1_SM_DOFF    (BUF_DATA_ALIGN - BUF1_SM_HDR)
125 #define BUF1_SM_SIZE    (BUF1_SM_LEN - BUF1_SM_DOFF)
126 #endif
127 #if ((BSD < 199103) && defined(FORE_SBUS) && defined(sun4m))
128 #define BUF1_SM_DOFF    (BUF_DATA_ALIGN - BUF1_SM_HDR)
129 #define BUF1_SM_SIZE    (64)
130 #endif
131
132 #define BUF1_SM_QUELEN  16      /* Entries in supply queue */
133 #define BUF1_SM_CPPOOL  256     /* Buffers in CP-resident pool */
134 #define BUF1_SM_ENTSIZE 8       /* Buffers in each supply queue entry */
135
136 #define BUF1_LG_DOFF    0       /* CP data offset into mbuf data space */
137 #define BUF1_LG_SIZE    MCLBYTES        /* Buffer size */
138 #define BUF1_LG_QUELEN  16      /* Entries in supply queue */
139 #define BUF1_LG_CPPOOL  512     /* Buffers in CP-resident pool */
140 #define BUF1_LG_ENTSIZE 8       /* Buffers in each supply queue entry */
141
142 #endif /* defined(BSD) */
143
144 #endif  /* _FORE_H */