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