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