tulipvar.h revision 1.3
1 /* $NetBSD: tulipvar.h,v 1.3 1999/09/01 20:56:15 thorpej Exp $ */ 2 3 /*- 4 * Copyright (c) 1998, 1999 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility, 9 * NASA Ames Research Center. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. All advertising materials mentioning features or use of this software 20 * must display the following acknowledgement: 21 * This product includes software developed by the NetBSD 22 * Foundation, Inc. and its contributors. 23 * 4. Neither the name of The NetBSD Foundation nor the names of its 24 * contributors may be used to endorse or promote products derived 25 * from this software without specific prior written permission. 26 * 27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 37 * POSSIBILITY OF SUCH DAMAGE. 38 */ 39 40 #ifndef _DEV_IC_TULIPVAR_H_ 41 #define _DEV_IC_TULIPVAR_H_ 42 43 #include <sys/queue.h> 44 45 /* 46 * Misc. definitions for the Digital Semiconductor ``Tulip'' (21x4x) 47 * Ethernet controller family driver. 48 */ 49 50 /* 51 * Transmit descriptor list size. This is arbitrary, but allocate 52 * enough descriptors for 64 pending transmissions and 16 segments 53 * per packet. Since a descriptor holds 2 buffer addresses, that's 54 * 8 descriptors per packet. This MUST work out to a power of 2. 55 */ 56 #define TULIP_NTXSEGS 16 57 58 #define TULIP_TXQUEUELEN 64 59 #define TULIP_NTXDESC (TULIP_TXQUEUELEN * TULIP_NTXSEGS) 60 #define TULIP_NTXDESC_MASK (TULIP_NTXDESC - 1) 61 #define TULIP_NEXTTX(x) ((x + 1) & TULIP_NTXDESC_MASK) 62 63 /* 64 * Receive descriptor list size. We have one Rx buffer per incoming 65 * packet, so this logic is a little simpler. 66 */ 67 #define TULIP_NRXDESC 64 68 #define TULIP_NRXDESC_MASK (TULIP_NRXDESC - 1) 69 #define TULIP_NEXTRX(x) ((x + 1) & TULIP_NRXDESC_MASK) 70 71 /* 72 * Control structures are DMA'd to the TULIP chip. We allocate them in 73 * a single clump that maps to a single DMA segment to make several things 74 * easier. 75 */ 76 struct tulip_control_data { 77 /* 78 * The transmit descriptors. 79 */ 80 struct tulip_desc tcd_txdescs[TULIP_NTXDESC]; 81 82 /* 83 * The receive descriptors. 84 */ 85 struct tulip_desc tcd_rxdescs[TULIP_NRXDESC]; 86 87 /* 88 * The setup descriptor. 89 */ 90 struct tulip_desc tcd_setup_desc; 91 92 /* 93 * The setup packet. 94 */ 95 u_int32_t tcd_setup_packet[TULIP_SETUP_PACKET_LEN / sizeof(u_int32_t)]; 96 }; 97 98 #define TULIP_CDOFF(x) offsetof(struct tulip_control_data, x) 99 #define TULIP_CDTXOFF(x) TULIP_CDOFF(tcd_txdescs[(x)]) 100 #define TULIP_CDRXOFF(x) TULIP_CDOFF(tcd_rxdescs[(x)]) 101 #define TULIP_CDSDOFF TULIP_CDOFF(tcd_setup_desc) 102 #define TULIP_CDSPOFF TULIP_CDOFF(tcd_setup_packet) 103 104 /* 105 * Software state for transmit jobs. 106 */ 107 struct tulip_txsoft { 108 struct mbuf *txs_mbuf; /* head of our mbuf chain */ 109 bus_dmamap_t txs_dmamap; /* our DMA map */ 110 int txs_firstdesc; /* first descriptor in packet */ 111 int txs_lastdesc; /* last descriptor in packet */ 112 SIMPLEQ_ENTRY(tulip_txsoft) txs_q; 113 }; 114 115 SIMPLEQ_HEAD(tulip_txsq, tulip_txsoft); 116 117 /* 118 * Software state for receive jobs. 119 */ 120 struct tulip_rxsoft { 121 struct mbuf *rxs_mbuf; /* head of our mbuf chain */ 122 bus_dmamap_t rxs_dmamap; /* our DMA map */ 123 }; 124 125 /* 126 * Type of Tulip chip we're dealing with. 127 */ 128 typedef enum { 129 TULIP_CHIP_INVALID = 0, /* invalid chip type */ 130 TULIP_CHIP_DE425 = 1, /* DE-425 EISA */ 131 TULIP_CHIP_21040 = 2, /* DECchip 21040 */ 132 TULIP_CHIP_21041 = 3, /* DECchip 21041 */ 133 TULIP_CHIP_21140 = 4, /* DECchip 21140 */ 134 TULIP_CHIP_21140A = 5, /* DECchip 21140A */ 135 TULIP_CHIP_21142 = 6, /* DECchip 21142 */ 136 TULIP_CHIP_21143 = 7, /* DECchip 21143 */ 137 TULIP_CHIP_82C168 = 8, /* Lite-On 82C168 PNIC */ 138 TULIP_CHIP_82C169 = 9, /* Lite-On 82C169 PNIC */ 139 TULIP_CHIP_MX98713 = 10, /* Macronix 98713 PMAC */ 140 TULIP_CHIP_MX98713A = 11, /* Macronix 98713A PMAC */ 141 TULIP_CHIP_MX98715 = 12, /* Macronix 98715, 98715A PMAC */ 142 TULIP_CHIP_MX98725 = 13, /* Macronix 98725 PMAC */ 143 TULIP_CHIP_WB89C840F = 14, /* Winbond 89C840F */ 144 } tulip_chip_t; 145 146 #define TULIP_CHIP_NAMES \ 147 { \ 148 NULL, \ 149 "DE-425", \ 150 "DECchip 21040", \ 151 "DECchip 21041", \ 152 "DECchip 21140", \ 153 "DECchip 21140A", \ 154 "DECchip 21142", \ 155 "DECchip 21143", \ 156 "Lite-On 82C168", \ 157 "Lite-On 82C169", \ 158 "Macronix MX98713", \ 159 "Macronix MX98713A", \ 160 "Macronix MX98715", \ 161 "Macronix MX98725", \ 162 "Winbond 89C840F", \ 163 } 164 165 struct tulip_softc; 166 167 /* 168 * Media init, change, status function pointers. 169 */ 170 struct tulip_mediasw { 171 void (*tmsw_init) __P((struct tulip_softc *)); 172 void (*tmsw_get) __P((struct tulip_softc *, struct ifmediareq *)); 173 int (*tmsw_set) __P((struct tulip_softc *)); 174 }; 175 176 /* 177 * Table which describes the transmit threshold mode. 178 */ 179 struct tulip_txthresh_tab { 180 u_int32_t txth_opmode; /* OPMODE bits */ 181 const char *txth_name; /* name of mode */ 182 }; 183 184 /* 185 * Software state per device. 186 */ 187 struct tulip_softc { 188 struct device sc_dev; /* generic device information */ 189 bus_space_tag_t sc_st; /* bus space tag */ 190 bus_space_handle_t sc_sh; /* bus space handle */ 191 bus_dma_tag_t sc_dmat; /* bus DMA tag */ 192 struct ethercom sc_ethercom; /* ethernet common data */ 193 void *sc_sdhook; /* shutdown hook */ 194 195 /* 196 * Media access functions for this chip. 197 */ 198 const struct tulip_mediasw *sc_mediasw; 199 200 tulip_chip_t sc_chip; /* chip type */ 201 int sc_rev; /* chip revision */ 202 int sc_flags; /* misc flags. */ 203 u_int32_t sc_cacheline; /* cache line size */ 204 205 struct mii_data sc_mii; /* MII/media information */ 206 207 const struct tulip_txthresh_tab *sc_txth; 208 int sc_txthresh; /* current transmit threshold */ 209 210 /* Filter setup function. */ 211 void (*sc_filter_setup) __P((struct tulip_softc *)); 212 213 /* 214 * The Winbond 89C840F places registers 4 bytes apart, instead 215 * of 8. 216 */ 217 int sc_regshift; 218 219 u_int32_t sc_busmode; /* copy of CSR_BUSMODE */ 220 u_int32_t sc_opmode; /* copy of CSR_OPMODE */ 221 u_int32_t sc_inten; /* copy of CSR_INTEN */ 222 223 u_int32_t sc_filtmode; /* filter mode we're using */ 224 225 bus_dmamap_t sc_cddmamap; /* control data DMA map */ 226 #define sc_cddma sc_cddmamap->dm_segs[0].ds_addr 227 228 /* 229 * Software state for transmit and receive descriptors. 230 */ 231 struct tulip_txsoft sc_txsoft[TULIP_TXQUEUELEN]; 232 struct tulip_rxsoft sc_rxsoft[TULIP_NRXDESC]; 233 234 /* 235 * Control data structures. 236 */ 237 struct tulip_control_data *sc_control_data; 238 #define sc_txdescs sc_control_data->tcd_txdescs 239 #define sc_rxdescs sc_control_data->tcd_rxdescs 240 #define sc_setup_desc sc_control_data->tcd_setup_desc 241 242 int sc_txfree; /* number of free Tx descriptors */ 243 int sc_txnext; /* next ready Tx descriptor */ 244 245 struct tulip_txsq sc_txfreeq; /* free Tx descsofts */ 246 struct tulip_txsq sc_txdirtyq; /* dirty Tx descsofts */ 247 248 int sc_rxptr; /* next ready RX descriptor/descsoft */ 249 }; 250 251 /* sc_flags */ 252 #define TULIPF_WANT_SETUP 0x00000001 /* want filter setup */ 253 #define TULIPF_DOING_SETUP 0x00000002 /* doing multicast setup */ 254 #define TULIPF_HAS_MII 0x00000004 /* has media on MII */ 255 #define TULIPF_IC_FS 0x00000008 /* IC bit on first tx seg */ 256 257 #define TULIP_CDTXADDR(sc, x) ((sc)->sc_cddma + TULIP_CDTXOFF((x))) 258 #define TULIP_CDRXADDR(sc, x) ((sc)->sc_cddma + TULIP_CDRXOFF((x))) 259 260 #define TULIP_CDSDADDR(sc) ((sc)->sc_cddma + TULIP_CDSDOFF) 261 #define TULIP_CDSPADDR(sc) ((sc)->sc_cddma + TULIP_CDSPOFF) 262 263 #define TULIP_CDSP(sc) ((sc)->sc_control_data->tcd_setup_packet) 264 265 #define TULIP_CDTXSYNC(sc, x, n, ops) \ 266 do { \ 267 int __x, __n; \ 268 \ 269 __x = (x); \ 270 __n = (n); \ 271 \ 272 /* If it will wrap around, sync to the end of the ring. */ \ 273 if ((__x + __n) > TULIP_NTXDESC) { \ 274 bus_dmamap_sync((sc)->sc_dmat, (sc)->sc_cddmamap, \ 275 TULIP_CDTXOFF(__x), sizeof(struct tulip_desc) * \ 276 (TULIP_NTXDESC - __x), (ops)); \ 277 __n -= (TULIP_NTXDESC - __x); \ 278 __x = 0; \ 279 } \ 280 \ 281 /* Now sync whatever is left. */ \ 282 bus_dmamap_sync((sc)->sc_dmat, (sc)->sc_cddmamap, \ 283 TULIP_CDTXOFF(__x), sizeof(struct tulip_desc) * __n, (ops)); \ 284 } while (0) 285 286 #define TULIP_CDRXSYNC(sc, x, ops) \ 287 bus_dmamap_sync((sc)->sc_dmat, (sc)->sc_cddmamap, \ 288 TULIP_CDRXOFF((x)), sizeof(struct tulip_desc), (ops)) 289 290 #define TULIP_CDSDSYNC(sc, ops) \ 291 bus_dmamap_sync((sc)->sc_dmat, (sc)->sc_cddmamap, \ 292 TULIP_CDSDOFF, sizeof(struct tulip_desc), (ops)) 293 294 #define TULIP_CDSPSYNC(sc, ops) \ 295 bus_dmamap_sync((sc)->sc_dmat, (sc)->sc_cddmamap, \ 296 TULIP_CDSPOFF, TULIP_SETUP_PACKET_LEN, (ops)) 297 298 /* 299 * Note we rely on MCLBYTES being a power of two. Because the `length' 300 * field is only 11 bits, we must subtract 1 from the length to avoid 301 * having it truncated to 0! 302 */ 303 #define TULIP_INIT_RXDESC(sc, x) \ 304 do { \ 305 struct tulip_rxsoft *__rxs = &sc->sc_rxsoft[(x)]; \ 306 struct tulip_desc *__rxd = &sc->sc_rxdescs[(x)]; \ 307 struct mbuf *__m = __rxs->rxs_mbuf; \ 308 \ 309 __m->m_data = __m->m_ext.ext_buf; \ 310 __rxd->td_bufaddr1 = __rxs->rxs_dmamap->dm_segs[0].ds_addr; \ 311 __rxd->td_bufaddr2 = TULIP_CDRXADDR((sc), TULIP_NEXTRX((x))); \ 312 __rxd->td_ctl = \ 313 ((__m->m_ext.ext_size - 1) << TDCTL_SIZE1_SHIFT) | TDCTL_CH; \ 314 __rxd->td_status = TDSTAT_OWN|TDSTAT_Rx_FS|TDSTAT_Rx_LS; \ 315 TULIP_CDRXSYNC((sc), (x), BUS_DMASYNC_PREREAD|BUS_DMASYNC_PREWRITE); \ 316 } while (0) 317 318 /* CSR access */ 319 #define TULIP_READ(sc, reg) \ 320 bus_space_read_4((sc)->sc_st, (sc)->sc_sh, \ 321 (reg) >> (sc)->sc_regshift) 322 323 #define TULIP_WRITE(sc, reg, val) \ 324 bus_space_write_4((sc)->sc_st, (sc)->sc_sh, \ 325 (reg) >> (sc)->sc_regshift, (val)) 326 327 #define TULIP_SET(sc, reg, mask) \ 328 TULIP_WRITE((sc), (reg), TULIP_READ((sc), (reg)) | (mask)) 329 330 #define TULIP_CLR(sc, reg, mask) \ 331 TULIP_WRITE((sc), (reg), TULIP_READ((sc), (reg)) & ~(mask)) 332 333 #define TULIP_ISSET(sc, reg, mask) \ 334 (TULIP_READ((sc), (reg)) & (mask)) 335 336 #ifdef _KERNEL 337 extern const struct tulip_mediasw tlp_sio_mii_mediasw; 338 extern const struct tulip_mediasw tlp_pnic_mediasw; 339 340 void tlp_attach __P((struct tulip_softc *, const char *, const u_int8_t *)); 341 int tlp_intr __P((void *)); 342 void tlp_read_srom __P((struct tulip_softc *, int, int, u_int16_t *)); 343 int tlp_srom_crcok __P((u_int8_t *)); 344 345 int tlp_mediachange __P((struct ifnet *)); 346 void tlp_mediastatus __P((struct ifnet *, struct ifmediareq *)); 347 #endif /* _KERNEL */ 348 349 #endif /* _DEV_IC_TULIPVAR_H_ */ 350
Indexes created Fri Sep 26 08:10:20 GMT 2025