Rename functions to avoid conflicts with libc.
[dragonfly.git] / sys / dev / atm / en / midwayreg.h
1 /*      $NetBSD: midwayreg.h,v 1.6 1997/03/20 21:34:47 chuck Exp $      */
2 /* $DragonFly: src/sys/dev/atm/en/midwayreg.h,v 1.3 2005/02/01 00:51:49 joerg Exp $ */
3
4 /*
5  * m i d w a y r e g . h
6  *
7  * this file contains the description of the ENI ATM midway chip
8  * data structures.   see midway.c for more details.
9  *
10  */
11
12 typedef void * bus_space_tag_t;
13 typedef u_int32_t pci_chipset_tag_t;
14 typedef caddr_t bus_space_handle_t;
15 typedef u_int32_t bus_size_t;
16 typedef caddr_t bus_addr_t;
17
18 #define bus_space_read_4(t, h, o) ((void) t,                            \
19     (*(volatile u_int32_t *)((h) + (o))))
20 #define bus_space_write_4(t, h, o, v)                                   \
21     ((void) t, ((void)(*(volatile u_int32_t *)((h) + (o)) = (v))))
22
23 #define MID_SZTOB(X)    ((X) * 256 * 4) /* size to bytes */
24 #define MID_BTOSZ(X)    ((X) / 256 / 4) /* bytes to "size" */
25
26 #define MID_N_VC        1024            /* # of VCs we can use */
27 #define MID_NTX_CH      8               /* 8 transmit channels (shared) */
28 #define MID_ATMDATASZ   48              /* need data in 48 byte blocks */
29
30 /*
31  * card data structures, top down
32  *
33  * in order to have a portable driver, the netbsd guys will not let us
34  * use structs.   we have a bus_space_handle_t which is the en_base address.
35  * everything else is an offset from that base.   all card data must be 
36  * accessed with bus_space_read_4()/bus_space_write_4():
37  *
38  * rv = bus_space_read_4(sc->en_memt, sc->en_base, BYTE_OFFSET);
39  * bus_space_write_4(sc->en_memt, sc->en_base, BYTE_OFFSET, VALUE);
40  *
41  * en_card: the whole card (prom + phy + midway + obmem)
42  *      obmem contains: vci tab + dma queues (rx & tx) + service list + bufs
43  */
44
45 /* byte offsets from en_base of various items */
46 #define MID_PHYOFF      0x030000        /* PHY offset */
47 #define MID_MIDOFF      0x040000        /* midway regs offset */
48 #define MID_RAMOFF      0x200000        /* RAM offset */
49 #define MID_DRQOFF      0x204000        /* DRQ offset */
50 #define MID_DRQEND      MID_DTQOFF      /* DRQ end */
51 #define MID_DTQOFF      0x205000        /* DTQ offset */
52 #define MID_DTQEND      MID_SLOFF       /* DTQ end */
53 #define MID_SLOFF       0x206000        /* service list */
54 #define MID_SLEND       MID_BUFOFF      /* service list end */
55 #define MID_BUFOFF      0x207000        /* buffer area */
56 #define MID_PROBEOFF    0x21fffc        /* start probe here */
57 #define MID_PROBSIZE    0x020000        /* 128 KB */
58 #define MID_MAXOFF      0x3ffffc        /* max offset */
59
60 /*
61  * prom & phy: not defined here
62  */
63 #define MID_ADPMACOFF   0xffc0          /* mac address offset (adaptec only) */
64
65 /*
66  * midway regs  (byte offsets from en_base)
67  */
68
69 #define MID_RESID       0x40000         /* write=reset reg, read=ID reg */
70
71 #define MID_VER(X)      (((X) & 0xf0000000) >> 28) /* midway version # */
72 #define MID_MID(X)      (((X) & 0x700) >> 8)    /* motherboard ID */
73 #define MID_IS_SABRE(X) ((X) & 0x80)            /* sabre controller? */
74 #define MID_IS_SUNI(X)  ((X) & 0x40)            /* SUNI? vs utopia */
75 #define MID_IS_UPIPE(X) ((X) & 0x20)            /* utopia pipeline? */
76 #define MID_DID(X)      ((X) & 0x1f)            /* daughterboard ID */
77
78 #define MID_INTACK      0x40004         /* interrupt ACK */
79 #define MID_INTSTAT     0x40008         /* interrupt status */
80 #define MID_INTENA      0x4000c         /* interrupt enable */
81
82 #define MID_TXCHAN(N) (1 << ((N) + 9))  /* ack/status/enable xmit channel bit*/
83 #define MID_INT_TX      0x1fe00         /* mask for any xmit interrupt */
84 #define MID_INT_DMA_OVR 0x00100         /* DMA overflow interrupt */
85 #define MID_INT_IDENT   0x00080         /* ident match error interrupt */
86 #define MID_INT_LERR    0x00040         /* LERR interrupt (sbus?) */
87 #define MID_INT_DMA_ERR 0x00020         /* DMA error interrupt */
88 #define MID_INT_DMA_RX  0x00010         /* DMA recv interrupt */
89 #define MID_INT_DMA_TX  0x00008         /* DMA xmit interrupt */
90 #define MID_INT_SERVICE 0x00004         /* service list interrupt */
91 #define MID_INT_SUNI    0x00002         /* SUNI interrupt */
92 #define MID_INT_STATS   0x00001         /* stats overflow interrupt */
93
94 #define MID_INT_ANY     0x1ffff         /* any interrupt? */
95
96 #define MID_INTBITS "\20\21T7\20T6\17T5\16T4\15T3\14T2\13T1\12T0\11DMAOVR\10ID\7LERR\6DMAERR\5RXDMA\4TXDMA\3SERV\2SUNI\1STAT"
97
98 #define MID_MAST_CSR    0x40010         /* master CSR */
99
100 #define MID_IPL(X)      (((X) & 0x1c0) >> 6) /* IPL */
101 #define MID_SETIPL(I)   ((I) << 6)
102 #define MID_MCSR_TXLOCK 0x20            /* lock on xmit overflow mode */
103 /* NOTE: next 5 bits: write 1 means enable, write 0 means no change */
104 #define MID_MCSR_ENDMA  0x10            /* DMA enable */
105 #define MID_MCSR_ENTX   0x08            /* TX enable */
106 #define MID_MCSR_ENRX   0x04            /* RX enable */
107 #define MID_MCSR_W1MS   0x02            /* wait 1 msec */
108 #define MID_MCSR_W500US 0x01            /* wait 500 usec */
109
110 #define MID_MCSRBITS "\20\6LCK\5DMAON\4TXON\3RXON\2W1MS\1W500US"
111
112 #define MID_STAT        0x40014         /* stat register, clear on read */
113
114 #define MID_VTRASH(X) (((X) >> 16) & 0xffff)
115                                         /* # cells trashed due to VCI's mode */
116 #define MID_OTRASH(X) ((X) & 0xffff)    /* # cells trashed due to overflow */
117
118 #define MID_SERV_WRITE  0x40018         /* 10 bit service write pointer (r/o) */
119 #define MID_DMA_ADDR    0x4001c         /* VA of DMA (r/o) */
120
121   /* DMA queue pointers (bits 0 to 8) */
122 #define MID_DMA_WRRX    0x40020         /* write ptr. for DMA recv queue */
123                                         /* (for adaptor -> host xfers) */
124 #define MID_DMA_RDRX    0x40024         /* read ptr for DMA recv queue (r/o) */
125                                         /* (i.e. current adaptor->host xfer) */
126 #define MID_DMA_WRTX    0x40028         /* write ptr for DMA xmit queue */
127                                         /* (for host -> adaptor xfers) */
128 #define MID_DMA_RDTX    0x4002c         /* read ptr for DMA xmit queue (r/o) */
129                                         /* (i.e. current host->adaptor xfer) */
130
131         /* xmit channel regs (1 per channel, MID_NTX_CH max channels) */
132
133 #define MIDX_PLACE(N)   (0x40040+((N)*0x10))    /* xmit place */
134
135 #define MIDX_MKPLACE(SZ,LOC) ( ((SZ) << 11) | (LOC) )
136 #define MIDX_LOC(X)     ((X) & 0x7ff)   /* location in obmem */
137 #define MIDX_SZ(X)      ((X) >> 11)     /* (size of block / 256) in int32_t's*/
138 #define MIDX_BASE(X)    \
139         (((MIDX_LOC(X) << MIDV_LOCTOPSHFT) * sizeof(u_int32_t)) + MID_RAMOFF)
140
141   /* the following two regs are word offsets in the block */
142 #define MIDX_READPTR(N) (0x40044+((N)*0x10))    /* xmit read pointer (r/o) */
143 #define MIDX_DESCSTART(N) (0x40048+((N)*0x10))  /* seg currently in DMA (r/o) */
144
145
146 /*
147  * obmem items
148  */
149
150 /* 
151  * vci table in obmem (offset from MID_VCTOFF)
152  */
153
154 #define MID_VC(N)       (MID_RAMOFF+((N)*0x10))
155
156 #define MIDV_TRASH      0x00000000      /* ignore VC */
157 #define MIDV_AAL5       0x80000000      /* do AAL5 on it */
158 #define MIDV_NOAAL      0x40000000      /* do per-cell stuff on it */
159 #define MIDV_MASK       0xc0000000      /* mode mask */
160 #define MIDV_SETMODE(VC,M) (((VC) & ~(MIDV_MASK)) | (M))  /* new mode */
161 #define MIDV_PTI        0x20000000      /* save PTI cells? */
162 #define MIDV_LOCTOPSHFT 8               /* shift to get top 11 bits of 19 */
163 #define MIDV_LOCSHIFT   18
164 #define MIDV_LOCMASK    0x7ff
165 #define MIDV_LOC(X)     (((X) >> MIDV_LOCSHIFT) & MIDV_LOCMASK) 
166                                         /* 11 most sig bits of addr */
167 #define MIDV_SZSHIFT    15
168 #define MIDV_SZ(X)      (((X) >> MIDV_SZSHIFT) & 7) 
169                                         /* size encoded the usual way */
170 #define MIDV_INSERVICE  0x1             /* in service list */
171
172 #define MID_DST_RP(N)   (MID_VC(N)|0x4)
173
174 #define MIDV_DSTART_SHIFT       16              /* shift */
175 #define MIDV_DSTART(X) (((X) >> MIDV_DSTART_SHIFT) & 0x7fff)
176 #define MIDV_READP_MASK         0x7fff          /* valid bits, (shift = 0) */
177
178 #define MID_WP_ST_CNT(N) (MID_VC(N)|0x8)      /* write pointer/state/count */
179
180 #define MIDV_WRITEP_MASK        0x7fff0000      /* mask for write ptr. */
181 #define MIDV_WRITEP_SHIFT       16
182 #define MIDV_ST_IDLE            0x0000
183 #define MIDV_ST_TRASH           0xc000
184 #define MIDV_ST_REASS           0x4000
185 #define MIDV_CCOUNT             0x7ff           /* cell count */
186
187 #define MID_CRC(N)      (MID_VC(N)|0xc)         /* CRC */
188
189 /*
190  * dma recv q.
191  */
192
193 #define MID_DMA_END     (1 << 5)        /* for both tx and rx */
194 #define MID_DMA_CNT(X)  (((X) >> 16) & 0xffff)
195 #define MID_DMA_TXCHAN(X) (((X) >> 6) & 0x7)
196 #define MID_DMA_RXVCI(X)  (((X) >> 6) & 0x3ff)
197 #define MID_DMA_TYPE(X) ((X) & 0xf)
198
199 #define MID_DRQ_N       512                     /* # of descriptors */
200 #define MID_DRQ_A2REG(N)        (((N) - MID_DRQOFF) >> 3)
201                                 /* convert byte offset to reg value */
202 #define MID_DRQ_REG2A(N)        (((N) << 3) + MID_DRQOFF) /* and back */
203
204 /* note: format of word 1 of RXQ is different beween ENI and ADP cards */
205 #define MID_MK_RXQ_ENI(CNT,VC,END,TYPE) \
206         ( ((CNT) << 16)|((VC) << 6)|(END)|(TYPE) )
207
208 #define MID_MK_RXQ_ADP(CNT,VC,END,JK) \
209         ( ((CNT) << 12)|((VC) << 2)|((END) >> 4)|(((JK) != 0) ? 1 : 0))
210 /*
211  * dma xmit q.
212  */
213
214 #define MID_DTQ_N       512                     /* # of descriptors */
215 #define MID_DTQ_A2REG(N)        (((N) - MID_DTQOFF) >> 3)
216                                 /* convert byte offset to reg value */
217 #define MID_DTQ_REG2A(N)        (((N) << 3) + MID_DTQOFF) /* and back */
218
219
220 /* note: format of word 1 of TXQ is different beween ENI and ADP cards */
221 #define MID_MK_TXQ_ENI(CNT,CHN,END,TYPE) \
222         ( ((CNT) << 16)|((CHN) << 6)|(END)|(TYPE) )
223
224 #define MID_MK_TXQ_ADP(CNT,CHN,END,JK) \
225         ( ((CNT) << 12)|((CHN) << 2)|((END) >> 4)|(((JK) != 0) ? 1 : 0) )
226
227 /*
228  * dma types
229  */
230
231 #define MIDDMA_JK       0x3     /* just kidding */
232 #define MIDDMA_BYTE     0x1     /* byte */
233 #define MIDDMA_2BYTE    0x2     /* 2 bytes */
234 #define MIDDMA_WORD     0x0     /* word */
235 #define MIDDMA_2WORD    0x7     /* 2 words */
236 #define MIDDMA_4WORD    0x4     /* 4 words */
237 #define MIDDMA_8WORD    0x5     /* 8 words */
238 #define MIDDMA_16WORD   0x6     /* 16 words!!! */
239 #define MIDDMA_2WMAYBE  0xf     /* 2 words, maybe */
240 #define MIDDMA_4WMAYBE  0xc     /* 4 words, maybe */
241 #define MIDDMA_8WMAYBE  0xd     /* 8 words, maybe */
242 #define MIDDMA_16WMAYBE 0xe     /* 16 words, maybe */
243
244 #define MIDDMA_MAYBE    0xc     /* mask to detect WMAYBE dma code */
245 #define MIDDMA_MAXBURST (16 * sizeof(u_int32_t))        /* largest burst */
246
247 /*
248  * service list
249  */
250
251 #define MID_SL_N        1024    /* max # entries on slist */
252 #define MID_SL_A2REG(N) (((N) - MID_SLOFF) >> 2)
253                                 /* convert byte offset to reg value */
254 #define MID_SL_REG2A(N) (((N) << 2) + MID_SLOFF) /* and back */
255
256 /*
257  * data in the buffer area of obmem
258  */
259
260 /*
261  * recv buffer desc. (1 u_int32_t at start of buffer)
262  */
263
264 #define MID_RBD_SIZE    4                       /* RBD size */
265 #define MID_CHDR_SIZE   4                       /* on aal0, cell header size */
266 #define MID_RBD_ID(X)   ((X) & 0xfe000000)      /* get ID */
267 #define MID_RBD_STDID   0x36000000              /* standard ID */
268 #define MID_RBD_CLP     0x01000000              /* CLP: cell loss priority */
269 #define MID_RBD_CE      0x00010000              /* CE: congestion experienced */
270 #define MID_RBD_T       0x00001000              /* T: trashed due to overflow */
271 #define MID_RBD_CRCERR  0x00000800              /* CRC error */
272 #define MID_RBD_CNT(X)  ((X) & 0x7ff)           /* cell count */
273
274 /*
275  * xmit buffer desc. (2 u_int32_t's at start of buffer)
276  * (note we treat the PR & RATE as a single u_int8_t)
277  */
278
279 #define MID_TBD_SIZE    8
280 #define MID_TBD_MK1(AAL,PR_RATE,CNT) \
281         (MID_TBD_STDID|(AAL)|((PR_RATE) << 19)|(CNT))
282 #define MID_TBD_STDID   0xb0000000      /* standard ID */
283 #define MID_TBD_AAL5    0x08000000      /* AAL 5 */
284 #define MID_TBD_NOAAL5  0x00000000      /* not AAL 5 */
285
286 #define MID_TBD_MK2(VCI,PTI,CLP) \
287         (((VCI) << 4)|((PTI) << 1)|(CLP))
288
289 /*
290  * aal5 pdu tail, last 2 words of last cell of AAL5 frame
291  * (word 2 is CRC .. handled by hw)
292  */
293
294 #define MID_PDU_SIZE    8
295 #define MID_PDU_MK1(UU,CPI,LEN) \
296         (((UU) << 24)|((CPI) << 16)|(LEN))
297 #define MID_PDU_LEN(X) ((X) & 0xffff)