Merge from vendor branch LIBARCHIVE:
[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  *      @(#) $DragonFly: src/sys/dev/atm/hfa/fore.h,v 1.3 2005/02/01 00:51:50 joerg Exp $
28  *
29  */
30
31 /*
32  * FORE Systems 200-Series Adapter Support
33  * ---------------------------------------
34  *
35  * Protocol and implementation definitions
36  *
37  */
38
39 #ifndef _FORE_H
40 #define _FORE_H
41
42 #ifndef FORE_DEV_NAME
43 #define FORE_DEV_NAME   "hfa"
44 #endif
45
46 #define FORE_MAX_UNITS  8       /* Maximum number of devices we support */
47 #define FORE_MIN_UCODE  0x20300 /* Minimum microcode version we support */
48
49 #define FORE_IFF_MTU    9188    /* Network interface MTU */
50 #define FORE_MAX_VCC    1024    /* Maximum number of open VCCs */
51 #define FORE_MAX_VPI    0       /* Maximum VPI value */
52 #define FORE_MAX_VCI    1023    /* Maximum VCI value */
53 #define FORE_DEF_RATE   0x00000000      /* Default rate control = disabled */
54
55 #define XMIT_QUELEN     32      /* Length of transmit queue */
56 #define RECV_QUELEN     32      /* Length of receive queue */
57 #define CMD_QUELEN      8       /* Length of command queue */
58
59 #define FORE_TIME_TICK  5       /* Watchdog timer tick (seconds) */
60 #define FORE_WATCHDOG   3       /* Device watchdog timeout (ticks) */
61 #define FORE_RECV_RETRY 3       /* Wait for receive queue entry retry count */
62 #define FORE_RECV_DELAY 10      /* Wait for receive queue entry delay (usec) */
63
64
65 /*
66  * Receive Buffer strategies
67  */
68 #define BUF_MIN_VCC     4       /* Minimum for buffer supply calculations */
69
70 #define BUF_DATA_ALIGN  4       /* Fore-required data alignment */
71
72 /*
73  * Strategy 1 Small - mbuf
74  * Strategy 1 Large - cluster mbuf
75  *
76  * XXX buffer controls - the RECV_MAX_SEGS calculation comes out wrong
77  * using the true buffer size values if the CP really only does full-cell
78  * filling of a particular buffer - we must clarify this...it also appears
79  * the minimum buffer size is 64, even if the CP can only fit in 1 cell.
80  */
81 #define SIZEOF_Buf_handle       16      /* XXX sizeof(Buf_handle) */
82
83 #undef m_ext
84 typedef struct m_ext    M_ext;
85 #define m_ext           M_dat.MH.MH_dat.MH_ext
86 #define BUF1_SM_HOFF    (sizeof(struct m_hdr))  /* Buffer-to-handle offset */
87 #define BUF1_SM_HDR     (sizeof(struct m_hdr) + sizeof(struct pkthdr))
88 #define BUF1_SM_LEN     (MHLEN)
89 #define BUF1_LG_HOFF    (sizeof(struct m_hdr) + sizeof(struct pkthdr) \
90                             + sizeof(M_ext))    /* Buffer-to-handle offset */
91
92 /*
93  * BUF1_SM_DOFF - CP data offset into buffer data space
94  * BUF1_SM_SIZE - Buffer size
95  *
96  * These should be defined as follows, but we need compile-time constants:
97  *
98  *      #define BUF1_SM_DOFF (roundup(BUF1_SM_HOFF + SIZEOF_Buf_handle, 
99  *                      BUF_DATA_ALIGN) - BUF1_SM_HDR)
100  *      #define BUF1_SM_SIZE    MAX(BUF1_SM_LEN - BUF1_SM_DOFF, 64)
101  *
102  */
103 #define BUF1_SM_DOFF    (SIZEOF_Buf_handle)
104 #define BUF1_SM_SIZE    (BUF1_SM_LEN - BUF1_SM_DOFF)
105
106 #define BUF1_SM_QUELEN  16      /* Entries in supply queue */
107 #define BUF1_SM_CPPOOL  256     /* Buffers in CP-resident pool */
108 #define BUF1_SM_ENTSIZE 8       /* Buffers in each supply queue entry */
109
110 #define BUF1_LG_DOFF    0       /* CP data offset into mbuf data space */
111 #define BUF1_LG_SIZE    MCLBYTES        /* Buffer size */
112 #define BUF1_LG_QUELEN  16      /* Entries in supply queue */
113 #define BUF1_LG_CPPOOL  512     /* Buffers in CP-resident pool */
114 #define BUF1_LG_ENTSIZE 8       /* Buffers in each supply queue entry */
115
116 #endif  /* _FORE_H */