1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 2007 Sepherosa Ziehau. All rights reserved. 5 * 6 * This code is derived from software contributed to The DragonFly Project 7 * by Sepherosa Ziehau <sepherosa@gmail.com> 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 * 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in 17 * the documentation and/or other materials provided with the 18 * distribution. 19 * 3. Neither the name of The DragonFly Project nor the names of its 20 * contributors may be used to endorse or promote products derived 21 * from this software without specific, prior written permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 24 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 26 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 27 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 28 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, 29 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 30 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 31 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 33 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34 * SUCH DAMAGE. 35 * 36 * $DragonFly: src/sys/dev/netif/et/if_etvar.h,v 1.4 2007/10/23 14:28:42 sephe Exp $ 37 */ 38 39 #ifndef _IF_ETVAR_H 40 #define _IF_ETVAR_H 41 42 #define ET_RING_ALIGN 4096 43 #define ET_STATUS_ALIGN 8 44 #define ET_NSEG_MAX 32 /* XXX no limit actually */ 45 #define ET_NSEG_SPARE 4 46 47 #define ET_TX_NDESC 512 48 #define ET_RX_NDESC 512 49 #define ET_RX_NRING 2 50 #define ET_RX_NSTAT (ET_RX_NRING * ET_RX_NDESC) 51 52 #define ET_TX_RING_SIZE (ET_TX_NDESC * sizeof(struct et_txdesc)) 53 #define ET_RX_RING_SIZE (ET_RX_NDESC * sizeof(struct et_rxdesc)) 54 #define ET_RXSTAT_RING_SIZE (ET_RX_NSTAT * sizeof(struct et_rxstat)) 55 56 #define ET_JUMBO_FRAMELEN (ET_MEM_SIZE - ET_MEM_RXSIZE_MIN - \ 57 ET_MEM_TXSIZE_EX) 58 #define ET_JUMBO_MTU (ET_JUMBO_FRAMELEN - ETHER_HDR_LEN - \ 59 EVL_ENCAPLEN - ETHER_CRC_LEN) 60 61 #define ET_FRAMELEN(mtu) (ETHER_HDR_LEN + ETHER_VLAN_ENCAP_LEN + \ 62 (mtu) + ETHER_CRC_LEN) 63 64 #define ET_JSLOTS (ET_RX_NDESC + 128) 65 #define ET_JLEN (ET_JUMBO_FRAMELEN + ETHER_ALIGN) 66 #define ET_JUMBO_MEM_SIZE (ET_JSLOTS * ET_JLEN) 67 68 #define CSR_WRITE_4(sc, reg, val) \ 69 bus_write_4((sc)->sc_mem_res, (reg), (val)) 70 #define CSR_READ_4(sc, reg) \ 71 bus_read_4((sc)->sc_mem_res, (reg)) 72 73 #define ET_ADDR_HI(addr) ((uint64_t) (addr) >> 32) 74 #define ET_ADDR_LO(addr) ((uint64_t) (addr) & 0xffffffff) 75 76 struct et_txdesc { 77 uint32_t td_addr_hi; 78 uint32_t td_addr_lo; 79 uint32_t td_ctrl1; /* ET_TDCTRL1_ */ 80 uint32_t td_ctrl2; /* ET_TDCTRL2_ */ 81 }; 82 83 #define ET_TDCTRL1_LEN_MASK 0x0000FFFF 84 85 #define ET_TDCTRL2_LAST_FRAG 0x00000001 86 #define ET_TDCTRL2_FIRST_FRAG 0x00000002 87 #define ET_TDCTRL2_INTR 0x00000004 88 #define ET_TDCTRL2_CTRL_WORD 0x00000008 89 #define ET_TDCTRL2_HDX_BACKP 0x00000010 90 #define ET_TDCTRL2_XMIT_PAUSE 0x00000020 91 #define ET_TDCTRL2_FRAME_ERR 0x00000040 92 #define ET_TDCTRL2_NO_CRC 0x00000080 93 #define ET_TDCTRL2_MAC_OVRRD 0x00000100 94 #define ET_TDCTRL2_PAD_PACKET 0x00000200 95 #define ET_TDCTRL2_JUMBO_PACKET 0x00000400 96 #define ET_TDCTRL2_INS_VLAN 0x00000800 97 #define ET_TDCTRL2_CSUM_IP 0x00001000 98 #define ET_TDCTRL2_CSUM_TCP 0x00002000 99 #define ET_TDCTRL2_CSUM_UDP 0x00004000 100 101 struct et_rxdesc { 102 uint32_t rd_addr_lo; 103 uint32_t rd_addr_hi; 104 uint32_t rd_ctrl; /* ET_RDCTRL_ */ 105 }; 106 107 #define ET_RDCTRL_BUFIDX_MASK 0x000003FF 108 109 struct et_rxstat { 110 uint32_t rxst_info1; 111 uint32_t rxst_info2; /* ET_RXST_INFO2_ */ 112 }; 113 114 #define ET_RXST_INFO1_HASH_PASS 0x00000001 115 #define ET_RXST_INFO1_IPCSUM 0x00000002 116 #define ET_RXST_INFO1_IPCSUM_OK 0x00000004 117 #define ET_RXST_INFO1_TCPCSUM 0x00000008 118 #define ET_RXST_INFO1_TCPCSUM_OK 0x00000010 119 #define ET_RXST_INFO1_WOL 0x00000020 120 #define ET_RXST_INFO1_RXMAC_ERR 0x00000040 121 #define ET_RXST_INFO1_DROP 0x00000080 122 #define ET_RXST_INFO1_FRAME_TRUNC 0x00000100 123 #define ET_RXST_INFO1_JUMBO 0x00000200 124 #define ET_RXST_INFO1_VLAN 0x00000400 125 #define ET_RXST_INFO1_PREV_FRMAE_DROP 0x00010000 126 #define ET_RXST_INFO1_SHORT 0x00020000 127 #define ET_RXST_INFO1_BAD_CARRIER 0x00040000 128 #define ET_RXST_INFO1_CODE_ERR 0x00080000 129 #define ET_RXST_INFO1_CRC_ERR 0x00100000 130 #define ET_RXST_INFO1_LEN_MISMATCH 0x00200000 131 #define ET_RXST_INFO1_TOO_LONG 0x00400000 132 #define ET_RXST_INFO1_OK 0x00800000 133 #define ET_RXST_INFO1_MULTICAST 0x01000000 134 #define ET_RXST_INFO1_BROADCAST 0x02000000 135 #define ET_RXST_INFO1_DRIBBLE 0x04000000 136 #define ET_RXST_INFO1_CTL_FRAME 0x08000000 137 #define ET_RXST_INFO1_PAUSE_FRAME 0x10000000 138 #define ET_RXST_INFO1_UNKWN_CTL_FRAME 0x20000000 139 #define ET_RXST_INFO1_VLAN_TAG 0x40000000 140 #define ET_RXST_INFO1_LONG_EVENT 0x80000000 141 142 #define ET_RXST_INFO2_LEN_MASK 0x0000FFFF 143 #define ET_RXST_INFO2_LEN_SHIFT 0 144 #define ET_RXST_INFO2_BUFIDX_MASK 0x03FF0000 145 #define ET_RXST_INFO2_BUFIDX_SHIFT 16 146 #define ET_RXST_INFO2_RINGIDX_MASK 0x0C000000 147 #define ET_RXST_INFO2_RINGIDX_SHIFT 26 148 149 struct et_rxstatus { 150 uint32_t rxs_ring; 151 uint32_t rxs_stat_ring; /* ET_RXS_STATRING_ */ 152 }; 153 154 #define ET_RXS_STATRING_INDEX_MASK 0x0FFF0000 155 #define ET_RXS_STATRING_INDEX_SHIFT 16 156 #define ET_RXS_STATRING_WRAP 0x10000000 157 158 struct et_txbuf { 159 struct mbuf *tb_mbuf; 160 bus_dmamap_t tb_dmap; 161 }; 162 163 struct et_rxbuf { 164 struct mbuf *rb_mbuf; 165 bus_dmamap_t rb_dmap; 166 }; 167 168 struct et_txstatus_data { 169 uint32_t *txsd_status; 170 bus_addr_t txsd_paddr; 171 bus_dma_tag_t txsd_dtag; 172 bus_dmamap_t txsd_dmap; 173 }; 174 175 struct et_rxstatus_data { 176 struct et_rxstatus *rxsd_status; 177 bus_addr_t rxsd_paddr; 178 bus_dma_tag_t rxsd_dtag; 179 bus_dmamap_t rxsd_dmap; 180 }; 181 182 struct et_rxstat_ring { 183 struct et_rxstat *rsr_stat; 184 bus_addr_t rsr_paddr; 185 bus_dma_tag_t rsr_dtag; 186 bus_dmamap_t rsr_dmap; 187 188 int rsr_index; 189 int rsr_wrap; 190 }; 191 192 struct et_txdesc_ring { 193 struct et_txdesc *tr_desc; 194 bus_addr_t tr_paddr; 195 bus_dma_tag_t tr_dtag; 196 bus_dmamap_t tr_dmap; 197 198 int tr_ready_index; 199 int tr_ready_wrap; 200 }; 201 202 struct et_rxdesc_ring { 203 struct et_rxdesc *rr_desc; 204 bus_addr_t rr_paddr; 205 bus_dma_tag_t rr_dtag; 206 bus_dmamap_t rr_dmap; 207 208 uint32_t rr_posreg; 209 int rr_index; 210 int rr_wrap; 211 }; 212 213 struct et_txbuf_data { 214 struct et_txbuf tbd_buf[ET_TX_NDESC]; 215 216 int tbd_start_index; 217 int tbd_start_wrap; 218 int tbd_used; 219 }; 220 221 struct et_softc; 222 struct et_rxbuf_data; 223 224 struct et_rxbuf_data { 225 struct et_rxbuf rbd_buf[ET_RX_NDESC]; 226 227 struct et_softc *rbd_softc; 228 struct et_rxdesc_ring *rbd_ring; 229 230 int rbd_bufsize; 231 int (*rbd_newbuf)(struct et_rxbuf_data *, int); 232 void (*rbd_discard)(struct et_rxbuf_data *, int); 233 }; 234 235 struct et_hw_stats { 236 /* RX/TX stats. */ 237 uint64_t pkts_64; 238 uint64_t pkts_65; 239 uint64_t pkts_128; 240 uint64_t pkts_256; 241 uint64_t pkts_512; 242 uint64_t pkts_1024; 243 uint64_t pkts_1519; 244 /* RX stats. */ 245 uint64_t rx_bytes; 246 uint64_t rx_frames; 247 uint32_t rx_crcerrs; 248 uint64_t rx_mcast; 249 uint64_t rx_bcast; 250 uint32_t rx_control; 251 uint32_t rx_pause; 252 uint32_t rx_unknown_control; 253 uint32_t rx_alignerrs; 254 uint32_t rx_lenerrs; 255 uint32_t rx_codeerrs; 256 uint32_t rx_cserrs; 257 uint32_t rx_runts; 258 uint64_t rx_oversize; 259 uint32_t rx_fragments; 260 uint32_t rx_jabbers; 261 uint32_t rx_drop; 262 /* TX stats. */ 263 uint64_t tx_bytes; 264 uint64_t tx_frames; 265 uint64_t tx_mcast; 266 uint64_t tx_bcast; 267 uint32_t tx_pause; 268 uint32_t tx_deferred; 269 uint32_t tx_excess_deferred; 270 uint32_t tx_single_colls; 271 uint32_t tx_multi_colls; 272 uint32_t tx_late_colls; 273 uint32_t tx_excess_colls; 274 uint32_t tx_total_colls; 275 uint32_t tx_pause_honored; 276 uint32_t tx_drop; 277 uint32_t tx_jabbers; 278 uint32_t tx_crcerrs; 279 uint32_t tx_control; 280 uint64_t tx_oversize; 281 uint32_t tx_undersize; 282 uint32_t tx_fragments; 283 }; 284 285 struct et_softc { 286 if_t ifp; 287 device_t dev; 288 struct mtx sc_mtx; 289 device_t sc_miibus; 290 void *sc_irq_handle; 291 struct resource *sc_irq_res; 292 struct resource *sc_mem_res; 293 294 int sc_if_flags; 295 uint32_t sc_flags; /* ET_FLAG_ */ 296 int sc_expcap; 297 298 int sc_mem_rid; 299 300 int sc_irq_rid; 301 302 struct callout sc_tick; 303 304 int watchdog_timer; 305 306 bus_dma_tag_t sc_dtag; 307 308 struct et_rxdesc_ring sc_rx_ring[ET_RX_NRING]; 309 struct et_rxstat_ring sc_rxstat_ring; 310 struct et_rxstatus_data sc_rx_status; 311 312 struct et_txdesc_ring sc_tx_ring; 313 struct et_txstatus_data sc_tx_status; 314 315 bus_dma_tag_t sc_mbuf_dtag; 316 bus_dma_tag_t sc_rx_mini_tag; 317 bus_dmamap_t sc_rx_mini_sparemap; 318 bus_dma_tag_t sc_rx_tag; 319 bus_dmamap_t sc_rx_sparemap; 320 bus_dma_tag_t sc_tx_tag; 321 struct et_rxbuf_data sc_rx_data[ET_RX_NRING]; 322 struct et_txbuf_data sc_tx_data; 323 324 struct et_hw_stats sc_stats; 325 uint32_t sc_tx; 326 uint32_t sc_tx_intr; 327 328 /* 329 * Sysctl variables 330 */ 331 int sc_rx_intr_npkts; 332 int sc_rx_intr_delay; 333 int sc_tx_intr_nsegs; 334 uint32_t sc_timer; 335 }; 336 337 #define ET_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx) 338 #define ET_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx) 339 #define ET_LOCK_ASSERT(_sc) mtx_assert(&(_sc)->sc_mtx, MA_OWNED) 340 341 #define ET_FLAG_PCIE 0x0001 342 #define ET_FLAG_MSI 0x0002 343 #define ET_FLAG_FASTETHER 0x0004 344 #define ET_FLAG_TXRX_ENABLED 0x0100 345 #define ET_FLAG_JUMBO 0x0200 346 #define ET_FLAG_LINK 0x8000 347 348 #endif /* !_IF_ETVAR_H */ 349