1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2010, Pyun YongHyeon <yongari@FreeBSD.org> 5 * 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 unmodified, this list of conditions, and the following 12 * disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 */ 29 30 #ifndef _IF_VTEVAR_H 31 #define _IF_VTEVAR_H 32 33 #define VTE_TX_RING_CNT 64 34 #define VTE_TX_RING_ALIGN 16 35 /* 36 * The TX/RX descriptor format has no limitation for number of 37 * descriptors in TX/RX ring. However, the maximum number of 38 * descriptors that could be set as RX descriptor ring residue 39 * counter is 255. This effectively limits number of RX 40 * descriptors available to be less than or equal to 255. 41 */ 42 #define VTE_RX_RING_CNT 128 43 #define VTE_RX_RING_ALIGN 16 44 #define VTE_RX_BUF_ALIGN 4 45 46 #define VTE_DESC_INC(x, y) ((x) = ((x) + 1) % (y)) 47 48 #define VTE_TX_RING_SZ \ 49 (sizeof(struct vte_tx_desc) * VTE_TX_RING_CNT) 50 #define VTE_RX_RING_SZ \ 51 (sizeof(struct vte_rx_desc) * VTE_RX_RING_CNT) 52 53 #define VTE_RX_BUF_SIZE_MAX (MCLBYTES - sizeof(uint32_t)) 54 55 #define VTE_MIN_FRAMELEN (ETHER_MIN_LEN - ETHER_CRC_LEN) 56 57 struct vte_rxdesc { 58 struct mbuf *rx_m; 59 bus_dmamap_t rx_dmamap; 60 struct vte_rx_desc *rx_desc; 61 }; 62 63 struct vte_txdesc { 64 struct mbuf *tx_m; 65 bus_dmamap_t tx_dmamap; 66 struct vte_tx_desc *tx_desc; 67 int tx_flags; 68 #define VTE_TXMBUF 0x0001 69 }; 70 71 struct vte_chain_data { 72 bus_dma_tag_t vte_parent_tag; 73 bus_dma_tag_t vte_buffer_tag; 74 bus_dma_tag_t vte_tx_tag; 75 struct vte_txdesc vte_txdesc[VTE_TX_RING_CNT]; 76 struct mbuf *vte_txmbufs[VTE_TX_RING_CNT]; 77 bus_dma_tag_t vte_rx_tag; 78 struct vte_rxdesc vte_rxdesc[VTE_RX_RING_CNT]; 79 bus_dma_tag_t vte_tx_ring_tag; 80 bus_dmamap_t vte_tx_ring_map; 81 bus_dma_tag_t vte_rx_ring_tag; 82 bus_dmamap_t vte_rx_ring_map; 83 bus_dmamap_t vte_rx_sparemap; 84 struct vte_tx_desc *vte_tx_ring; 85 bus_addr_t vte_tx_ring_paddr; 86 struct vte_rx_desc *vte_rx_ring; 87 bus_addr_t vte_rx_ring_paddr; 88 89 int vte_tx_prod; 90 int vte_tx_cons; 91 int vte_tx_cnt; 92 int vte_rx_cons; 93 }; 94 95 struct vte_hw_stats { 96 /* RX stats. */ 97 uint32_t rx_frames; 98 uint32_t rx_bcast_frames; 99 uint32_t rx_mcast_frames; 100 uint32_t rx_runts; 101 uint32_t rx_crcerrs; 102 uint32_t rx_long_frames; 103 uint32_t rx_fifo_full; 104 uint32_t rx_desc_unavail; 105 uint32_t rx_pause_frames; 106 107 /* TX stats. */ 108 uint32_t tx_frames; 109 uint32_t tx_underruns; 110 uint32_t tx_late_colls; 111 uint32_t tx_pause_frames; 112 }; 113 114 struct vte_ident { 115 uint16_t vendorid; 116 uint16_t deviceid; 117 const char *name; 118 }; 119 120 /* 121 * Software state per device. 122 */ 123 struct vte_softc { 124 if_t vte_ifp; 125 device_t vte_dev; 126 device_t vte_miibus; 127 struct resource *vte_res; 128 int vte_res_id; 129 int vte_res_type; 130 struct resource *vte_irq; 131 void *vte_intrhand; 132 const struct vte_ident *vte_ident; 133 uint8_t vte_eaddr[ETHER_ADDR_LEN]; 134 int vte_flags; 135 #define VTE_FLAG_LINK 0x8000 136 137 struct callout vte_tick_ch; 138 struct vte_hw_stats vte_stats; 139 struct vte_chain_data vte_cdata; 140 int vte_if_flags; 141 int vte_watchdog_timer; 142 int vte_int_rx_mod; 143 int vte_int_tx_mod; 144 145 struct mtx vte_mtx; 146 }; 147 148 /* Register access macros. */ 149 #define CSR_WRITE_2(_sc, reg, val) \ 150 bus_write_2((_sc)->vte_res, (reg), (val)) 151 #define CSR_READ_2(_sc, reg) \ 152 bus_read_2((_sc)->vte_res, (reg)) 153 154 #define VTE_LOCK(_sc) mtx_lock(&(_sc)->vte_mtx) 155 #define VTE_UNLOCK(_sc) mtx_unlock(&(_sc)->vte_mtx) 156 #define VTE_LOCK_ASSERT(_sc) mtx_assert(&(_sc)->vte_mtx, MA_OWNED) 157 158 #define VTE_TX_TIMEOUT 5 159 #define VTE_RESET_TIMEOUT 100 160 #define VTE_TIMEOUT 1000 161 #define VTE_PHY_TIMEOUT 1000 162 163 #endif /* _IF_VTEVAR_H */ 164