tulipvar.h revision 1.25
1 /* $NetBSD: tulipvar.h,v 1.25 2000/01/25 22:11:12 thorpej Exp $ */ 2 3 /*- 4 * Copyright (c) 1998, 1999, 2000 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_82C115 = 10, /* Lite-On 82C115 PNIC II */ 140 TULIP_CHIP_MX98713 = 11, /* Macronix 98713 PMAC */ 141 TULIP_CHIP_MX98713A = 12, /* Macronix 98713A PMAC */ 142 TULIP_CHIP_MX98715 = 13, /* Macronix 98715 PMAC */ 143 TULIP_CHIP_MX98715A = 14, /* Macronix 98715A PMAC */ 144 TULIP_CHIP_MX98725 = 15, /* Macronix 98725 PMAC */ 145 TULIP_CHIP_WB89C840F = 16, /* Winbond 89C840F */ 146 TULIP_CHIP_DM9102 = 17, /* Davicom DM9102 */ 147 TULIP_CHIP_AL981 = 18, /* ADMtek AL981 */ 148 TULIP_CHIP_AX88140 = 19, /* ASIX AX88140 */ 149 TULIP_CHIP_AX88141 = 20, /* ASIX AX88141 */ 150 TULIP_CHIP_X3201_3 = 21, /* Xircom X3201-3 */ 151 } tulip_chip_t; 152 153 #define TULIP_CHIP_NAMES \ 154 { \ 155 NULL, \ 156 "DE-425", \ 157 "DECchip 21040", \ 158 "DECchip 21041", \ 159 "DECchip 21140", \ 160 "DECchip 21140A", \ 161 "DECchip 21142", \ 162 "DECchip 21143", \ 163 "Lite-On 82C168", \ 164 "Lite-On 82C169", \ 165 "Lite-On 82C115", \ 166 "Macronix MX98713", \ 167 "Macronix MX98713A", \ 168 "Macronix MX98715", \ 169 "Macronix MX98715A", \ 170 "Macronix MX98725", \ 171 "Winbond 89C840F", \ 172 "Davicom DM9102", \ 173 "ADMtek AL981", \ 174 "ASIX AX88140", \ 175 "ASIX AX88141", \ 176 "Xircom X3201-3", \ 177 } 178 179 struct tulip_softc; 180 181 /* 182 * Media init, change, status function pointers. 183 */ 184 struct tulip_mediasw { 185 void (*tmsw_init) __P((struct tulip_softc *)); 186 void (*tmsw_get) __P((struct tulip_softc *, struct ifmediareq *)); 187 int (*tmsw_set) __P((struct tulip_softc *)); 188 }; 189 190 /* 191 * Table which describes the transmit threshold mode. 192 */ 193 struct tulip_txthresh_tab { 194 u_int32_t txth_opmode; /* OPMODE bits */ 195 const char *txth_name; /* name of mode */ 196 }; 197 198 /* 199 * Settings for Tulip SIA media. 200 */ 201 struct tulip_sia_media { 202 u_int32_t tsm_siaconn; /* CSR13 value */ 203 u_int32_t tsm_siatxrx; /* CSR14 value */ 204 u_int32_t tsm_siagen; /* CSR15 value */ 205 }; 206 207 /* 208 * Description of 2x14x media. 209 */ 210 struct tulip_21x4x_media { 211 int tm_type; /* type of media; see tulipreg.h */ 212 const char *tm_name; /* name of media */ 213 214 void (*tm_get) __P((struct tulip_softc *, 215 struct ifmediareq *)); 216 int (*tm_set) __P((struct tulip_softc *)); 217 218 int tm_phyno; /* PHY # on MII */ 219 220 int tm_gp_length; /* MII select sequence length */ 221 int tm_gp_offset; /* MII select sequence offset */ 222 223 int tm_reset_length;/* MII reset sequence length */ 224 int tm_reset_offset;/* MII reset sequence offset */ 225 226 u_int32_t tm_opmode; /* OPMODE bits for this media */ 227 u_int32_t tm_gpctl; /* GPIO control bits for this media */ 228 u_int32_t tm_gpdata; /* GPIO bits for this media */ 229 u_int32_t tm_actmask; /* `active' bits for this data */ 230 u_int32_t tm_actdata; /* active high/low info */ 231 232 struct tulip_sia_media tm_sia; /* SIA settings */ 233 #define tm_siaconn tm_sia.tsm_siaconn 234 #define tm_siatxrx tm_sia.tsm_siatxrx 235 #define tm_siagen tm_sia.tsm_siagen 236 }; 237 238 /* 239 * Table for converting Tulip SROM media info into ifmedia data. 240 */ 241 struct tulip_srom_to_ifmedia { 242 u_int8_t tsti_srom; /* SROM media type */ 243 int tsti_subtype; /* ifmedia subtype */ 244 int tsti_options; /* ifmedia options */ 245 const char *tsti_name; /* media name */ 246 247 u_int32_t tsti_opmode; /* OPMODE bits for this media */ 248 249 /* 250 * Settings for 21040, 21041, and 21142/21143 SIA, in the event 251 * the SROM doesn't have them. 252 */ 253 struct tulip_sia_media tsti_21040; 254 struct tulip_sia_media tsti_21041; 255 struct tulip_sia_media tsti_21142; 256 }; 257 258 /* 259 * Some misc. statics, useful for debugging. 260 */ 261 struct tulip_stats { 262 u_long ts_tx_uf; /* transmit underflow errors */ 263 u_long ts_tx_to; /* transmit jabber timeouts */ 264 u_long ts_tx_ec; /* excessve collision count */ 265 u_long ts_tx_lc; /* late collision count */ 266 }; 267 268 /* 269 * Software state per device. 270 */ 271 struct tulip_softc { 272 struct device sc_dev; /* generic device information */ 273 bus_space_tag_t sc_st; /* bus space tag */ 274 bus_space_handle_t sc_sh; /* bus space handle */ 275 bus_dma_tag_t sc_dmat; /* bus DMA tag */ 276 struct ethercom sc_ethercom; /* ethernet common data */ 277 void *sc_sdhook; /* shutdown hook */ 278 279 struct tulip_stats sc_stats; /* debugging stats */ 280 281 /* 282 * Contents of the SROM. 283 */ 284 u_int8_t sc_srom[TULIP_MAX_ROM_SIZE]; 285 int sc_srom_addrbits; 286 287 /* 288 * Media access functions for this chip. 289 */ 290 const struct tulip_mediasw *sc_mediasw; 291 mii_bitbang_ops_t sc_bitbang_ops; 292 293 /* 294 * For chips with built-in NWay blocks, these are state 295 * variables required for autonegotiation. 296 */ 297 int sc_nway_ticks; /* tick counter */ 298 struct ifmedia_entry *sc_nway_active; /* the active media */ 299 300 tulip_chip_t sc_chip; /* chip type */ 301 int sc_rev; /* chip revision */ 302 int sc_flags; /* misc flags. */ 303 char sc_name[16]; /* board name */ 304 u_int32_t sc_cacheline; /* cache line size */ 305 int sc_devno; /* PCI device # */ 306 307 struct mii_data sc_mii; /* MII/media information */ 308 309 const struct tulip_txthresh_tab *sc_txth; 310 int sc_txthresh; /* current transmit threshold */ 311 312 u_int8_t sc_gp_dir; /* GPIO pin direction bits (21140) */ 313 int sc_media_seen; /* ISV media block types seen */ 314 int sc_tlp_minst; /* Tulip internal media instance */ 315 316 /* Reset function. */ 317 void (*sc_reset) __P((struct tulip_softc *)); 318 319 /* Pre-init function. */ 320 void (*sc_preinit) __P((struct tulip_softc *)); 321 322 /* Filter setup function. */ 323 void (*sc_filter_setup) __P((struct tulip_softc *)); 324 325 /* Media status update function. */ 326 void (*sc_statchg) __P((struct device *)); 327 328 /* Media tick function. */ 329 void (*sc_tick) __P((void *)); 330 331 /* 332 * The Winbond 89C840F places registers 4 bytes apart, instead 333 * of 8. 334 */ 335 int sc_regshift; 336 337 u_int32_t sc_busmode; /* copy of CSR_BUSMODE */ 338 u_int32_t sc_opmode; /* copy of CSR_OPMODE */ 339 u_int32_t sc_inten; /* copy of CSR_INTEN */ 340 341 u_int32_t sc_rxint_mask; /* mask of Rx interrupts we want */ 342 u_int32_t sc_txint_mask; /* mask of Tx interrupts we want */ 343 344 u_int32_t sc_filtmode; /* filter mode we're using */ 345 346 bus_dmamap_t sc_cddmamap; /* control data DMA map */ 347 #define sc_cddma sc_cddmamap->dm_segs[0].ds_addr 348 349 /* 350 * Software state for transmit and receive descriptors. 351 */ 352 struct tulip_txsoft sc_txsoft[TULIP_TXQUEUELEN]; 353 struct tulip_rxsoft sc_rxsoft[TULIP_NRXDESC]; 354 355 /* 356 * Control data structures. 357 */ 358 struct tulip_control_data *sc_control_data; 359 #define sc_txdescs sc_control_data->tcd_txdescs 360 #define sc_rxdescs sc_control_data->tcd_rxdescs 361 #define sc_setup_desc sc_control_data->tcd_setup_desc 362 363 int sc_txfree; /* number of free Tx descriptors */ 364 int sc_txnext; /* next ready Tx descriptor */ 365 int sc_ntxsegs; /* number of transmit segs per pkt */ 366 367 struct tulip_txsq sc_txfreeq; /* free Tx descsofts */ 368 struct tulip_txsq sc_txdirtyq; /* dirty Tx descsofts */ 369 370 int sc_rxptr; /* next ready RX descriptor/descsoft */ 371 }; 372 373 /* sc_flags */ 374 #define TULIPF_WANT_SETUP 0x00000001 /* want filter setup */ 375 #define TULIPF_DOING_SETUP 0x00000002 /* doing multicast setup */ 376 #define TULIPF_HAS_MII 0x00000004 /* has media on MII */ 377 #define TULIPF_IC_FS 0x00000008 /* IC bit on first tx seg */ 378 #define TULIPF_MRL 0x00000010 /* memory read line okay */ 379 #define TULIPF_MRM 0x00000020 /* memory read multi okay */ 380 #define TULIPF_MWI 0x00000040 /* memory write inval okay */ 381 #define TULIPF_LINK_UP 0x00000100 /* link is up (non-MII) */ 382 #define TULIPF_LINK_VALID 0x00000200 /* link state valid */ 383 #define TULIPF_DOINGAUTO 0x00000400 /* doing autoneg (non-MII) */ 384 385 /* 386 * This macro returns the current media entry for *non-MII* media. 387 */ 388 #define TULIP_CURRENT_MEDIA(sc) \ 389 (IFM_SUBTYPE((sc)->sc_mii.mii_media.ifm_cur->ifm_media) != IFM_AUTO ? \ 390 (sc)->sc_mii.mii_media.ifm_cur : (sc)->sc_nway_active) 391 392 /* 393 * This macro determines if a change to media-related OPMODE bits requires 394 * a chip reset. 395 */ 396 #define TULIP_MEDIA_NEEDSRESET(sc, newbits) \ 397 (((sc)->sc_opmode & OPMODE_MEDIA_BITS) != \ 398 ((newbits) & OPMODE_MEDIA_BITS)) 399 400 #define TULIP_CDTXADDR(sc, x) ((sc)->sc_cddma + TULIP_CDTXOFF((x))) 401 #define TULIP_CDRXADDR(sc, x) ((sc)->sc_cddma + TULIP_CDRXOFF((x))) 402 403 #define TULIP_CDSDADDR(sc) ((sc)->sc_cddma + TULIP_CDSDOFF) 404 #define TULIP_CDSPADDR(sc) ((sc)->sc_cddma + TULIP_CDSPOFF) 405 406 #define TULIP_CDSP(sc) ((sc)->sc_control_data->tcd_setup_packet) 407 408 #define TULIP_CDTXSYNC(sc, x, n, ops) \ 409 do { \ 410 int __x, __n; \ 411 \ 412 __x = (x); \ 413 __n = (n); \ 414 \ 415 /* If it will wrap around, sync to the end of the ring. */ \ 416 if ((__x + __n) > TULIP_NTXDESC) { \ 417 bus_dmamap_sync((sc)->sc_dmat, (sc)->sc_cddmamap, \ 418 TULIP_CDTXOFF(__x), sizeof(struct tulip_desc) * \ 419 (TULIP_NTXDESC - __x), (ops)); \ 420 __n -= (TULIP_NTXDESC - __x); \ 421 __x = 0; \ 422 } \ 423 \ 424 /* Now sync whatever is left. */ \ 425 bus_dmamap_sync((sc)->sc_dmat, (sc)->sc_cddmamap, \ 426 TULIP_CDTXOFF(__x), sizeof(struct tulip_desc) * __n, (ops)); \ 427 } while (0) 428 429 #define TULIP_CDRXSYNC(sc, x, ops) \ 430 bus_dmamap_sync((sc)->sc_dmat, (sc)->sc_cddmamap, \ 431 TULIP_CDRXOFF((x)), sizeof(struct tulip_desc), (ops)) 432 433 #define TULIP_CDSDSYNC(sc, ops) \ 434 bus_dmamap_sync((sc)->sc_dmat, (sc)->sc_cddmamap, \ 435 TULIP_CDSDOFF, sizeof(struct tulip_desc), (ops)) 436 437 #define TULIP_CDSPSYNC(sc, ops) \ 438 bus_dmamap_sync((sc)->sc_dmat, (sc)->sc_cddmamap, \ 439 TULIP_CDSPOFF, TULIP_SETUP_PACKET_LEN, (ops)) 440 441 /* 442 * Note we rely on MCLBYTES being a power of two. Because the `length' 443 * field is only 11 bits, we must subtract 1 from the length to avoid 444 * having it truncated to 0! 445 */ 446 #define TULIP_INIT_RXDESC(sc, x) \ 447 do { \ 448 struct tulip_rxsoft *__rxs = &sc->sc_rxsoft[(x)]; \ 449 struct tulip_desc *__rxd = &sc->sc_rxdescs[(x)]; \ 450 struct mbuf *__m = __rxs->rxs_mbuf; \ 451 \ 452 __m->m_data = __m->m_ext.ext_buf; \ 453 __rxd->td_bufaddr1 = \ 454 htole32(__rxs->rxs_dmamap->dm_segs[0].ds_addr); \ 455 __rxd->td_bufaddr2 = \ 456 htole32(TULIP_CDRXADDR((sc), TULIP_NEXTRX((x)))); \ 457 __rxd->td_ctl = \ 458 htole32(((__m->m_ext.ext_size - 1) << TDCTL_SIZE1_SHIFT) | \ 459 TDCTL_CH); \ 460 __rxd->td_status = htole32(TDSTAT_OWN|TDSTAT_Rx_FS|TDSTAT_Rx_LS); \ 461 TULIP_CDRXSYNC((sc), (x), BUS_DMASYNC_PREREAD|BUS_DMASYNC_PREWRITE); \ 462 } while (0) 463 464 /* CSR access */ 465 #define TULIP_CSR_OFFSET(sc, csr) \ 466 (TULIP_CSR_INDEX(csr) << (sc)->sc_regshift) 467 468 #define TULIP_READ(sc, reg) \ 469 bus_space_read_4((sc)->sc_st, (sc)->sc_sh, \ 470 TULIP_CSR_OFFSET((sc), (reg))) 471 472 #define TULIP_WRITE(sc, reg, val) \ 473 bus_space_write_4((sc)->sc_st, (sc)->sc_sh, \ 474 TULIP_CSR_OFFSET((sc), (reg)), (val)) 475 476 #define TULIP_SET(sc, reg, mask) \ 477 TULIP_WRITE((sc), (reg), TULIP_READ((sc), (reg)) | (mask)) 478 479 #define TULIP_CLR(sc, reg, mask) \ 480 TULIP_WRITE((sc), (reg), TULIP_READ((sc), (reg)) & ~(mask)) 481 482 #define TULIP_ISSET(sc, reg, mask) \ 483 (TULIP_READ((sc), (reg)) & (mask)) 484 485 #if BYTE_ORDER == BIG_ENDIAN 486 #define TULIP_SP_FIELD_C(x) ((x) << 16) 487 #else 488 #define TULIP_SP_FIELD_C(x) (x) 489 #endif 490 #define TULIP_SP_FIELD(x, f) TULIP_SP_FIELD_C(((u_int16_t *)(x))[(f)]) 491 492 #ifdef _KERNEL 493 extern const char *tlp_chip_names[]; 494 495 extern const struct tulip_mediasw tlp_21040_mediasw; 496 extern const struct tulip_mediasw tlp_21040_tp_mediasw; 497 extern const struct tulip_mediasw tlp_21040_auibnc_mediasw; 498 extern const struct tulip_mediasw tlp_21041_mediasw; 499 extern const struct tulip_mediasw tlp_2114x_isv_mediasw; 500 extern const struct tulip_mediasw tlp_sio_mii_mediasw; 501 extern const struct tulip_mediasw tlp_pnic_mediasw; 502 extern const struct tulip_mediasw tlp_pmac_mediasw; 503 extern const struct tulip_mediasw tlp_al981_mediasw; 504 505 void tlp_attach __P((struct tulip_softc *, const u_int8_t *)); 506 int tlp_intr __P((void *)); 507 void tlp_read_srom __P((struct tulip_softc *, int, int, u_int8_t *)); 508 int tlp_srom_crcok __P((const u_int8_t *)); 509 int tlp_isv_srom __P((const u_int8_t *)); 510 int tlp_isv_srom_enaddr __P((struct tulip_softc *, u_int8_t *)); 511 int tlp_parse_old_srom __P((struct tulip_softc *, u_int8_t *)); 512 513 int tlp_mediachange __P((struct ifnet *)); 514 void tlp_mediastatus __P((struct ifnet *, struct ifmediareq *)); 515 #endif /* _KERNEL */ 516 517 #endif /* _DEV_IC_TULIPVAR_H_ */ 518
Indexes created Tue Sep 30 10:09:55 GMT 2025