rtl81x9var.h revision 1.52
1 /* $NetBSD: rtl81x9var.h,v 1.52 2011/11/22 18:42:57 garbled Exp $ */ 2 3 /* 4 * Copyright (c) 1997, 1998 5 * Bill Paul <wpaul (at) ctr.columbia.edu>. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. All advertising materials mentioning features or use of this software 16 * must display the following acknowledgement: 17 * This product includes software developed by Bill Paul. 18 * 4. Neither the name of the author nor the names of any co-contributors 19 * may be used to endorse or promote products derived from this software 20 * without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND 23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 * ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD 26 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 32 * THE POSSIBILITY OF SUCH DAMAGE. 33 * 34 * FreeBSD Id: if_rlreg.h,v 1.9 1999/06/20 18:56:09 wpaul Exp 35 */ 36 37 #include "rnd.h" 38 39 #if NRND > 0 40 #include <sys/rnd.h> 41 #endif 42 43 #define RTK_ETHER_ALIGN 2 44 #define RTK_RXSTAT_LEN 4 45 46 #ifdef __NO_STRICT_ALIGNMENT 47 /* 48 * XXX According to PR kern/33763, some 8168 and variants can't DMA 49 * XXX RX packet data into unaligned buffer. This means such chips will 50 * XXX never work on !__NO_STRICT_ALIGNMENT hosts without copying buffer. 51 */ 52 #define RE_ETHER_ALIGN 0 53 #else 54 #define RE_ETHER_ALIGN 2 55 #endif 56 57 struct rtk_type { 58 uint16_t rtk_vid; 59 uint16_t rtk_did; 60 int rtk_basetype; 61 #define RTK_8129 1 62 #define RTK_8139 2 63 #define RTK_8139CPLUS 3 64 #define RTK_8169 4 65 #define RTK_8168 5 66 #define RTK_8101E 6 67 const char *rtk_name; 68 }; 69 70 struct rtk_mii_frame { 71 uint8_t mii_stdelim; 72 uint8_t mii_opcode; 73 uint8_t mii_phyaddr; 74 uint8_t mii_regaddr; 75 uint8_t mii_turnaround; 76 uint16_t mii_data; 77 }; 78 79 /* 80 * MII constants 81 */ 82 #define RTK_MII_STARTDELIM 0x01 83 #define RTK_MII_READOP 0x02 84 #define RTK_MII_WRITEOP 0x01 85 #define RTK_MII_TURNAROUND 0x02 86 87 88 /* 89 * The RealTek doesn't use a fragment-based descriptor mechanism. 90 * Instead, there are only four register sets, each or which represents 91 * one 'descriptor.' Basically, each TX descriptor is just a contiguous 92 * packet buffer (32-bit aligned!) and we place the buffer addresses in 93 * the registers so the chip knows where they are. 94 * 95 * We can sort of kludge together the same kind of buffer management 96 * used in previous drivers, but we have to do buffer copies almost all 97 * the time, so it doesn't really buy us much. 98 * 99 * For reception, there's just one large buffer where the chip stores 100 * all received packets. 101 */ 102 103 #ifdef dreamcast 104 /* 105 * XXX dreamcast has only 32KB DMA'able memory on its PCI bridge. 106 * XXX Maybe this should be handled by prop_dictionary, or 107 * XXX some other new API which returns available DMA resources. 108 */ 109 #define RTK_RX_BUF_SZ RTK_RXBUF_16 110 #else 111 #define RTK_RX_BUF_SZ RTK_RXBUF_64 112 #endif 113 #define RTK_RXBUFLEN RTK_RXBUF_LEN(RTK_RX_BUF_SZ) 114 #define RTK_TX_LIST_CNT 4 115 116 /* 117 * The 8139C+ and 8169 gigE chips support descriptor-based TX 118 * and RX. In fact, they even support TCP large send. Descriptors 119 * must be allocated in contiguous blocks that are aligned on a 120 * 256-byte boundary. The RX rings can hold a maximum of 64 descriptors. 121 * The TX rings can hold upto 64 descriptors on 8139C+, and 122 * 1024 descriptors on 8169 gigE chips. 123 */ 124 #define RE_RING_ALIGN 256 125 126 /* 127 * Size of descriptors and TX queue. 128 * These numbers must be power of two to simplify RE_NEXT_*() macro. 129 */ 130 #define RE_RX_DESC_CNT 64 131 #define RE_TX_DESC_CNT_8139 64 132 #define RE_TX_DESC_CNT_8169 1024 133 #define RE_TX_QLEN 64 134 135 #define RE_NTXDESC_RSVD 4 136 137 struct re_rxsoft { 138 struct mbuf *rxs_mbuf; 139 bus_dmamap_t rxs_dmamap; 140 }; 141 142 struct re_txq { 143 struct mbuf *txq_mbuf; 144 bus_dmamap_t txq_dmamap; 145 int txq_descidx; 146 int txq_nsegs; 147 }; 148 149 struct re_list_data { 150 struct re_txq re_txq[RE_TX_QLEN]; 151 int re_txq_considx; 152 int re_txq_prodidx; 153 int re_txq_free; 154 155 bus_dmamap_t re_tx_list_map; 156 struct re_desc *re_tx_list; 157 int re_tx_free; /* # of free descriptors */ 158 int re_tx_nextfree; /* next descriptor to use */ 159 int re_tx_desc_cnt; /* # of descriptors */ 160 bus_dma_segment_t re_tx_listseg; 161 int re_tx_listnseg; 162 163 struct re_rxsoft re_rxsoft[RE_RX_DESC_CNT]; 164 bus_dmamap_t re_rx_list_map; 165 struct re_desc *re_rx_list; 166 int re_rx_prodidx; 167 bus_dma_segment_t re_rx_listseg; 168 int re_rx_listnseg; 169 }; 170 171 struct rtk_tx_desc { 172 SIMPLEQ_ENTRY(rtk_tx_desc) txd_q; 173 struct mbuf *txd_mbuf; 174 bus_dmamap_t txd_dmamap; 175 bus_addr_t txd_txaddr; 176 bus_addr_t txd_txstat; 177 }; 178 179 struct rtk_softc { 180 device_t sc_dev; 181 struct ethercom ethercom; /* interface info */ 182 struct mii_data mii; 183 struct callout rtk_tick_ch; /* tick callout */ 184 bus_space_tag_t rtk_btag; /* bus space tag */ 185 bus_space_handle_t rtk_bhandle; /* bus space handle */ 186 bus_size_t rtk_bsize; /* bus space mapping size */ 187 u_int sc_quirk; /* chip quirks */ 188 #define RTKQ_8129 0x00000001 /* 8129 */ 189 #define RTKQ_8139CPLUS 0x00000002 /* 8139C+ */ 190 #define RTKQ_8169NONS 0x00000004 /* old non-single 8169 */ 191 #define RTKQ_PCIE 0x00000008 /* PCIe variants */ 192 #define RTKQ_MACLDPS 0x00000010 /* has LDPS register */ 193 #define RTKQ_DESCV2 0x00000020 /* has V2 TX/RX descriptor */ 194 #define RTKQ_NOJUMBO 0x00000040 /* no jumbo MTU support */ 195 #define RTKQ_NOEECMD 0x00000080 /* unusable EEPROM command */ 196 #define RTKQ_MACSTAT 0x00000100 /* set MACSTAT_DIS on init */ 197 #define RTKQ_CMDSTOP 0x00000200 /* set STOPREQ on stop */ 198 #define RTKQ_PHYWAKE_PM 0x00000400 /* wake PHY from power down */ 199 200 bus_dma_tag_t sc_dmat; 201 202 bus_dma_segment_t sc_dmaseg; /* for rtk(4) */ 203 int sc_dmanseg; /* for rtk(4) */ 204 205 bus_dmamap_t recv_dmamap; /* for rtk(4) */ 206 uint8_t *rtk_rx_buf; 207 208 struct rtk_tx_desc rtk_tx_descs[RTK_TX_LIST_CNT]; 209 SIMPLEQ_HEAD(, rtk_tx_desc) rtk_tx_free; 210 SIMPLEQ_HEAD(, rtk_tx_desc) rtk_tx_dirty; 211 212 struct re_list_data re_ldata; 213 struct mbuf *re_head; 214 struct mbuf *re_tail; 215 uint32_t re_rxlenmask; 216 int re_testmode; 217 218 int sc_flags; /* misc flags */ 219 #define RTK_ATTACHED 0x00000001 /* attach has succeeded */ 220 #define RTK_ENABLED 0x00000002 /* chip is enabled */ 221 #define RTK_IS_ENABLED(sc) ((sc)->sc_flags & RTK_ENABLED) 222 223 int sc_txthresh; /* Early tx threshold */ 224 int sc_rev; /* MII revision */ 225 226 /* Power management hooks. */ 227 int (*sc_enable) (struct rtk_softc *); 228 void (*sc_disable) (struct rtk_softc *); 229 #if NRND > 0 230 krndsource_t rnd_source; 231 #endif 232 }; 233 234 #define RE_TX_DESC_CNT(sc) ((sc)->re_ldata.re_tx_desc_cnt) 235 #define RE_TX_LIST_SZ(sc) (RE_TX_DESC_CNT(sc) * sizeof(struct re_desc)) 236 #define RE_NEXT_TX_DESC(sc, x) (((x) + 1) & (RE_TX_DESC_CNT(sc) - 1)) 237 238 #define RE_RX_LIST_SZ (RE_RX_DESC_CNT * sizeof(struct re_desc)) 239 #define RE_NEXT_RX_DESC(sc, x) (((x) + 1) & (RE_RX_DESC_CNT - 1)) 240 241 #define RE_NEXT_TXQ(sc, x) (((x) + 1) & (RE_TX_QLEN - 1)) 242 243 #define RE_TXDESCSYNC(sc, idx, ops) \ 244 bus_dmamap_sync((sc)->sc_dmat, \ 245 (sc)->re_ldata.re_tx_list_map, \ 246 sizeof(struct re_desc) * (idx), \ 247 sizeof(struct re_desc), \ 248 (ops)) 249 #define RE_RXDESCSYNC(sc, idx, ops) \ 250 bus_dmamap_sync((sc)->sc_dmat, \ 251 (sc)->re_ldata.re_rx_list_map, \ 252 sizeof(struct re_desc) * (idx), \ 253 sizeof(struct re_desc), \ 254 (ops)) 255 256 /* 257 * re(4) hardware ip4csum-tx could be mangled with 28 byte or less IP packets 258 */ 259 #define RE_IP4CSUMTX_MINLEN 28 260 #define RE_IP4CSUMTX_PADLEN (ETHER_HDR_LEN + RE_IP4CSUMTX_MINLEN) 261 /* 262 * XXX 263 * We are allocating pad DMA buffer after RX DMA descs for now 264 * because RE_TX_LIST_SZ(sc) always occupies whole page but 265 * RE_RX_LIST_SZ is less than PAGE_SIZE so there is some unused region. 266 */ 267 #define RE_RX_DMAMEM_SZ (RE_RX_LIST_SZ + RE_IP4CSUMTX_PADLEN) 268 #define RE_TXPADOFF RE_RX_LIST_SZ 269 #define RE_TXPADDADDR(sc) \ 270 ((sc)->re_ldata.re_rx_list_map->dm_segs[0].ds_addr + RE_TXPADOFF) 271 272 273 #define RTK_TXTH_MAX RTK_TXTH_1536 274 275 /* 276 * register space access macros 277 */ 278 #define CSR_WRITE_4(sc, reg, val) \ 279 bus_space_write_4(sc->rtk_btag, sc->rtk_bhandle, reg, val) 280 #define CSR_WRITE_2(sc, reg, val) \ 281 bus_space_write_2(sc->rtk_btag, sc->rtk_bhandle, reg, val) 282 #define CSR_WRITE_1(sc, reg, val) \ 283 bus_space_write_1(sc->rtk_btag, sc->rtk_bhandle, reg, val) 284 285 #define CSR_READ_4(sc, reg) \ 286 bus_space_read_4(sc->rtk_btag, sc->rtk_bhandle, reg) 287 #define CSR_READ_2(sc, reg) \ 288 bus_space_read_2(sc->rtk_btag, sc->rtk_bhandle, reg) 289 #define CSR_READ_1(sc, reg) \ 290 bus_space_read_1(sc->rtk_btag, sc->rtk_bhandle, reg) 291 292 #define RTK_TIMEOUT 1000 293 294 /* 295 * PCI low memory base and low I/O base registers 296 */ 297 298 #define RTK_PCI_LOIO 0x10 299 #define RTK_PCI_LOMEM 0x14 300 301 #ifdef _KERNEL 302 uint16_t rtk_read_eeprom(struct rtk_softc *, int, int); 303 void rtk_setmulti(struct rtk_softc *); 304 void rtk_attach(struct rtk_softc *); 305 int rtk_detach(struct rtk_softc *); 306 int rtk_activate(device_t, enum devact); 307 int rtk_intr(void *); 308 #endif /* _KERNEL */ 309
Indexes created Fri Sep 26 20:09:58 GMT 2025