1 /* $NetBSD: gemvar.h,v 1.12 2005/05/16 15:56:38 bouyer Exp $ */ 2 3 /* 4 * 5 * Copyright (C) 2001 Eduardo Horvath. 6 * All rights reserved. 7 * 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND 19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28 * SUCH DAMAGE. 29 * 30 */ 31 32 #ifndef _IF_GEMVAR_H 33 #define _IF_GEMVAR_H 34 35 36 #include "rnd.h" 37 38 #include <sys/queue.h> 39 #include <sys/callout.h> 40 41 #if NRND > 0 42 #include <sys/rnd.h> 43 #endif 44 45 /* 46 * Misc. definitions for the Sun ``Gem'' Ethernet controller family driver. 47 */ 48 49 /* 50 * Transmit descriptor list size. This is arbitrary, but allocate 51 * enough descriptors for 64 pending transmissions and 16 segments 52 * per packet. 53 */ 54 #define GEM_NTXSEGS 16 55 56 #define GEM_TXQUEUELEN 64 57 #define GEM_NTXDESC (GEM_TXQUEUELEN * GEM_NTXSEGS) 58 #define GEM_NTXDESC_MASK (GEM_NTXDESC - 1) 59 #define GEM_NEXTTX(x) ((x + 1) & GEM_NTXDESC_MASK) 60 61 /* 62 * Receive descriptor list size. We have one Rx buffer per incoming 63 * packet, so this logic is a little simpler. 64 */ 65 #define GEM_NRXDESC 128 66 #define GEM_NRXDESC_MASK (GEM_NRXDESC - 1) 67 #define GEM_PREVRX(x) ((x - 1) & GEM_NRXDESC_MASK) 68 #define GEM_NEXTRX(x) ((x + 1) & GEM_NRXDESC_MASK) 69 70 /* 71 * Control structures are DMA'd to the GEM chip. We allocate them in 72 * a single clump that maps to a single DMA segment to make several things 73 * easier. 74 */ 75 struct gem_control_data { 76 /* 77 * The transmit descriptors. 78 */ 79 struct gem_desc gcd_txdescs[GEM_NTXDESC]; 80 81 /* 82 * The receive descriptors. 83 */ 84 struct gem_desc gcd_rxdescs[GEM_NRXDESC]; 85 }; 86 87 #define GEM_CDOFF(x) offsetof(struct gem_control_data, x) 88 #define GEM_CDTXOFF(x) GEM_CDOFF(gcd_txdescs[(x)]) 89 #define GEM_CDRXOFF(x) GEM_CDOFF(gcd_rxdescs[(x)]) 90 91 /* 92 * Software state for transmit jobs. 93 */ 94 struct gem_txsoft { 95 struct mbuf *txs_mbuf; /* head of our mbuf chain */ 96 bus_dmamap_t txs_dmamap; /* our DMA map */ 97 int txs_firstdesc; /* first descriptor in packet */ 98 int txs_lastdesc; /* last descriptor in packet */ 99 int txs_ndescs; /* number of descriptors */ 100 SIMPLEQ_ENTRY(gem_txsoft) txs_q; 101 }; 102 103 SIMPLEQ_HEAD(gem_txsq, gem_txsoft); 104 105 /* 106 * Software state for receive jobs. 107 */ 108 struct gem_rxsoft { 109 struct mbuf *rxs_mbuf; /* head of our mbuf chain */ 110 bus_dmamap_t rxs_dmamap; /* our DMA map */ 111 }; 112 113 /* 114 * Software state per device. 115 */ 116 struct gem_softc { 117 struct device sc_dev; /* generic device information */ 118 struct ethercom sc_ethercom; /* ethernet common data */ 119 struct mii_data sc_mii; /* MII media control */ 120 #define sc_media sc_mii.mii_media/* shorthand */ 121 struct callout sc_tick_ch; /* tick callout */ 122 123 /* The following bus handles are to be provided by the bus front-end */ 124 bus_space_tag_t sc_bustag; /* bus tag */ 125 bus_dma_tag_t sc_dmatag; /* bus dma tag */ 126 bus_dmamap_t sc_dmamap; /* bus dma handle */ 127 bus_space_handle_t sc_h; /* bus space handle for all regs */ 128 129 int sc_phys[2]; /* MII instance -> PHY map */ 130 131 int sc_mif_config; /* Selected MII reg setting */ 132 133 int sc_pci; /* XXXXX -- PCI buses are LE. */ 134 u_int sc_variant; /* which GEM are we dealing with? */ 135 #define GEM_UNKNOWN 0 /* don't know */ 136 #define GEM_SUN_GEM 1 /* Sun GEM variant */ 137 #define GEM_APPLE_GMAC 2 /* Apple GMAC variant */ 138 139 u_int sc_flags; /* */ 140 #define GEM_GIGABIT 0x0001 /* has a gigabit PHY */ 141 142 void *sc_sdhook; /* shutdown hook */ 143 void *sc_powerhook; /* power management hook */ 144 145 /* 146 * Ring buffer DMA stuff. 147 */ 148 bus_dma_segment_t sc_cdseg; /* control data memory */ 149 int sc_cdnseg; /* number of segments */ 150 bus_dmamap_t sc_cddmamap; /* control data DMA map */ 151 #define sc_cddma sc_cddmamap->dm_segs[0].ds_addr 152 153 bus_dmamap_t sc_nulldmamap; /* for small packets padding */ 154 155 /* 156 * Software state for transmit and receive descriptors. 157 */ 158 struct gem_txsoft sc_txsoft[GEM_TXQUEUELEN]; 159 struct gem_rxsoft sc_rxsoft[GEM_NRXDESC]; 160 161 /* 162 * Control data structures. 163 */ 164 struct gem_control_data *sc_control_data; 165 #define sc_txdescs sc_control_data->gcd_txdescs 166 #define sc_rxdescs sc_control_data->gcd_rxdescs 167 168 int sc_txfree; /* number of free Tx descriptors */ 169 int sc_txnext; /* next ready Tx descriptor */ 170 int sc_txwin; /* Tx descriptors since last Tx int */ 171 172 struct gem_txsq sc_txfreeq; /* free Tx descsofts */ 173 struct gem_txsq sc_txdirtyq; /* dirty Tx descsofts */ 174 175 int sc_rxptr; /* next ready RX descriptor/descsoft */ 176 int sc_rxfifosize; /* Rx FIFO size (bytes) */ 177 178 /* ========== */ 179 int sc_inited; 180 int sc_debug; 181 void *sc_sh; /* shutdownhook cookie */ 182 183 /* Special hardware hooks */ 184 void (*sc_hwreset)(struct gem_softc *); 185 void (*sc_hwinit)(struct gem_softc *); 186 187 #if NRND > 0 188 rndsource_element_t rnd_source; 189 #endif 190 191 struct evcnt sc_ev_intr; 192 #ifdef GEM_COUNTERS 193 struct evcnt sc_ev_txint; 194 struct evcnt sc_ev_rxint; 195 struct evcnt sc_ev_rxnobuf; 196 struct evcnt sc_ev_rxfull; 197 struct evcnt sc_ev_rxhist[9]; 198 #endif 199 }; 200 201 #ifdef GEM_COUNTERS 202 #define GEM_COUNTER_INCR(sc, ctr) ((void) (sc->ctr.ev_count++)) 203 #else 204 #define GEM_COUNTER_INCR(sc, ctr) ((void) sc) 205 #endif 206 207 208 #define GEM_DMA_READ(sc, v) (((sc)->sc_pci) ? le64toh(v) : be64toh(v)) 209 #define GEM_DMA_WRITE(sc, v) (((sc)->sc_pci) ? htole64(v) : htobe64(v)) 210 211 #define GEM_CDTXADDR(sc, x) ((sc)->sc_cddma + GEM_CDTXOFF((x))) 212 #define GEM_CDRXADDR(sc, x) ((sc)->sc_cddma + GEM_CDRXOFF((x))) 213 214 #define GEM_CDSPADDR(sc) ((sc)->sc_cddma + GEM_CDSPOFF) 215 216 #define GEM_CDTXSYNC(sc, x, n, ops) \ 217 do { \ 218 int __x, __n; \ 219 \ 220 __x = (x); \ 221 __n = (n); \ 222 \ 223 /* If it will wrap around, sync to the end of the ring. */ \ 224 if ((__x + __n) > GEM_NTXDESC) { \ 225 bus_dmamap_sync((sc)->sc_dmatag, (sc)->sc_cddmamap, \ 226 GEM_CDTXOFF(__x), sizeof(struct gem_desc) * \ 227 (GEM_NTXDESC - __x), (ops)); \ 228 __n -= (GEM_NTXDESC - __x); \ 229 __x = 0; \ 230 } \ 231 \ 232 /* Now sync whatever is left. */ \ 233 bus_dmamap_sync((sc)->sc_dmatag, (sc)->sc_cddmamap, \ 234 GEM_CDTXOFF(__x), sizeof(struct gem_desc) * __n, (ops)); \ 235 } while (0) 236 237 #define GEM_CDRXSYNC(sc, x, ops) \ 238 bus_dmamap_sync((sc)->sc_dmatag, (sc)->sc_cddmamap, \ 239 GEM_CDRXOFF((x)), sizeof(struct gem_desc), (ops)) 240 241 #define GEM_CDSPSYNC(sc, ops) \ 242 bus_dmamap_sync((sc)->sc_dmatag, (sc)->sc_cddmamap, \ 243 GEM_CDSPOFF, GEM_SETUP_PACKET_LEN, (ops)) 244 245 #define GEM_INIT_RXDESC(sc, x) \ 246 do { \ 247 struct gem_rxsoft *__rxs = &sc->sc_rxsoft[(x)]; \ 248 struct gem_desc *__rxd = &sc->sc_rxdescs[(x)]; \ 249 struct mbuf *__m = __rxs->rxs_mbuf; \ 250 \ 251 __m->m_data = __m->m_ext.ext_buf; \ 252 __rxd->gd_addr = \ 253 GEM_DMA_WRITE((sc), __rxs->rxs_dmamap->dm_segs[0].ds_addr); \ 254 __rxd->gd_flags = \ 255 GEM_DMA_WRITE((sc), \ 256 (((__m->m_ext.ext_size)<<GEM_RD_BUFSHIFT) \ 257 & GEM_RD_BUFSIZE) | GEM_RD_OWN); \ 258 GEM_CDRXSYNC((sc), (x), BUS_DMASYNC_PREREAD|BUS_DMASYNC_PREWRITE); \ 259 } while (0) 260 261 #ifdef _KERNEL 262 void gem_attach(struct gem_softc *, const uint8_t *); 263 int gem_intr(void *); 264 265 void gem_reset(struct gem_softc *); 266 #endif /* _KERNEL */ 267 268 269 #endif 270