1 /*- 2 * Copyright (c) 2008, Pyun YongHyeon <yongari@FreeBSD.org> 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 unmodified, this list of conditions, and the following 10 * disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25 * SUCH DAMAGE. 26 * 27 * $FreeBSD: src/sys/dev/jme/if_jmevar.h,v 1.1 2008/05/27 01:42:01 yongari Exp $ 28 * $DragonFly: src/sys/dev/netif/jme/if_jmevar.h,v 1.8 2008/11/26 11:55:18 sephe Exp $ 29 */ 30 31 #ifndef _IF_JMEVAR_H 32 #define _IF_JMEVAR_H 33 34 #include <sys/queue.h> 35 #include <sys/callout.h> 36 #include <sys/taskqueue.h> 37 38 /* 39 * JMC250 supports upto JME_NDESC_MAX descriptors and the number of 40 * descriptors should be multiple of JME_NDESC_ALIGN. 41 */ 42 #define JME_TX_DESC_CNT_DEF 512 43 #define JME_RX_DESC_CNT_DEF 512 44 45 #define JME_NDESC_ALIGN 16 46 #define JME_NDESC_MAX 1024 47 48 #define JME_NRXRING_1 1 49 #define JME_NRXRING_2 2 50 #define JME_NRXRING_4 4 51 52 #define JME_NRXRING_MIN JME_NRXRING_1 53 #define JME_NRXRING_MAX JME_NRXRING_4 54 55 #define JME_NSERIALIZE (JME_NRXRING_MAX + 2) 56 57 #define JME_NMSIX (JME_NRXRING_MAX + 1) 58 59 /* 60 * Tx/Rx descriptor queue base should be 16bytes aligned and 61 * should not cross 4G bytes boundary on the 64bits address 62 * mode. 63 */ 64 #define JME_TX_RING_ALIGN __VM_CACHELINE_SIZE 65 #define JME_RX_RING_ALIGN __VM_CACHELINE_SIZE 66 #define JME_MAXSEGSIZE 4096 67 #define JME_TSO_MAXSIZE (IP_MAXPACKET + sizeof(struct ether_vlan_header)) 68 #define JME_MAXTXSEGS 40 69 #define JME_RX_BUF_ALIGN sizeof(uint64_t) 70 #define JME_SSB_ALIGN __VM_CACHELINE_SIZE 71 72 #if (BUS_SPACE_MAXADDR != BUS_SPACE_MAXADDR_32BIT) 73 #define JME_RING_BOUNDARY 0x100000000ULL 74 #else 75 #define JME_RING_BOUNDARY 0 76 #endif 77 78 #define JME_ADDR_LO(x) ((uint64_t) (x) & 0xFFFFFFFF) 79 #define JME_ADDR_HI(x) ((uint64_t) (x) >> 32) 80 81 #define JME_MSI_MESSAGES 8 82 #define JME_MSIX_MESSAGES 8 83 84 /* Water mark to kick reclaiming Tx buffers. */ 85 #define JME_TX_DESC_HIWAT(sc) \ 86 ((sc)->jme_cdata.jme_tx_desc_cnt - \ 87 (((sc)->jme_cdata.jme_tx_desc_cnt * 3) / 10)) 88 89 /* 90 * JMC250 can send 9K jumbo frame on Tx path and can receive 91 * 65535 bytes. 92 */ 93 #define JME_JUMBO_FRAMELEN 9216 94 #define JME_JUMBO_MTU \ 95 (JME_JUMBO_FRAMELEN - sizeof(struct ether_vlan_header) - \ 96 ETHER_HDR_LEN - ETHER_CRC_LEN) 97 #define JME_MAX_MTU \ 98 (ETHER_MAX_LEN + sizeof(struct ether_vlan_header) - \ 99 ETHER_HDR_LEN - ETHER_CRC_LEN) 100 /* 101 * JMC250 can't handle Tx checksum offload/TSO if frame length 102 * is larger than its FIFO size(2K). It's also good idea to not 103 * use jumbo frame if hardware is running at half-duplex media. 104 * Because the jumbo frame may not fit into the Tx FIFO, 105 * collisions make hardware fetch frame from host memory with 106 * DMA again which in turn slows down Tx performance 107 * significantly. 108 */ 109 #define JME_TX_FIFO_SIZE 2000 110 /* 111 * JMC250 has just 4K Rx FIFO. To support jumbo frame that is 112 * larger than 4K bytes in length, Rx FIFO threshold should be 113 * adjusted to minimize Rx FIFO overrun. 114 */ 115 #define JME_RX_FIFO_SIZE 4000 116 117 #define JME_DESC_INC(x, y) ((x) = ((x) + 1) % (y)) 118 #define JME_DESC_ADD(x, d, y) ((x) = ((x) + (d)) % (y)) 119 120 struct jme_txdesc { 121 struct mbuf *tx_m; 122 bus_dmamap_t tx_dmamap; 123 int tx_ndesc; 124 struct jme_desc *tx_desc; 125 }; 126 127 struct jme_rxdesc { 128 struct mbuf *rx_m; 129 bus_addr_t rx_paddr; 130 bus_dmamap_t rx_dmamap; 131 struct jme_desc *rx_desc; 132 }; 133 134 struct jme_softc; 135 136 /* 137 * RX ring/descs 138 */ 139 struct jme_rxdata { 140 struct lwkt_serialize jme_rx_serialize; 141 struct jme_softc *jme_sc; 142 143 uint32_t jme_rx_coal; 144 uint32_t jme_rx_comp; 145 uint32_t jme_rx_empty; 146 int jme_rx_idx; 147 148 bus_dma_tag_t jme_rx_tag; /* RX mbuf tag */ 149 bus_dmamap_t jme_rx_sparemap; 150 struct jme_rxdesc *jme_rxdesc; 151 152 struct jme_desc *jme_rx_ring; 153 bus_addr_t jme_rx_ring_paddr; 154 bus_dma_tag_t jme_rx_ring_tag; 155 bus_dmamap_t jme_rx_ring_map; 156 157 int jme_rx_cons; 158 int jme_rx_desc_cnt; 159 160 int jme_rxlen; 161 struct mbuf *jme_rxhead; 162 struct mbuf *jme_rxtail; 163 164 u_long jme_rx_pkt; 165 u_long jme_rx_emp; 166 } __cachealign; 167 168 struct jme_chain_data { 169 /* 170 * Top level tags 171 */ 172 bus_dma_tag_t jme_ring_tag; /* parent ring tag */ 173 bus_dma_tag_t jme_buffer_tag; /* parent mbuf/ssb tag */ 174 175 /* 176 * Shadow status block 177 */ 178 struct jme_ssb *jme_ssb_block; 179 bus_addr_t jme_ssb_block_paddr; 180 bus_dma_tag_t jme_ssb_tag; 181 bus_dmamap_t jme_ssb_map; 182 183 /* 184 * TX ring/descs 185 */ 186 struct lwkt_serialize jme_tx_serialize; 187 struct jme_softc *jme_sc; 188 bus_dma_tag_t jme_tx_tag; /* TX mbuf tag */ 189 struct jme_txdesc *jme_txdesc; 190 191 struct jme_desc *jme_tx_ring; 192 bus_addr_t jme_tx_ring_paddr; 193 bus_dma_tag_t jme_tx_ring_tag; 194 bus_dmamap_t jme_tx_ring_map; 195 196 int jme_tx_prod; 197 int jme_tx_cons; 198 int jme_tx_cnt; 199 int jme_tx_desc_cnt; 200 201 int jme_rx_ring_cnt; 202 struct jme_rxdata jme_rx_data[JME_NRXRING_MAX]; 203 } __cachealign; 204 205 struct jme_msix_data { 206 int jme_msix_rid; 207 int jme_msix_cpuid; 208 u_int jme_msix_vector; 209 uint32_t jme_msix_intrs; 210 struct resource *jme_msix_res; 211 void *jme_msix_handle; 212 struct lwkt_serialize *jme_msix_serialize; 213 char jme_msix_desc[64]; 214 215 driver_intr_t *jme_msix_func; 216 void *jme_msix_arg; 217 }; 218 219 #define JME_TX_RING_SIZE(sc) \ 220 (sizeof(struct jme_desc) * (sc)->jme_cdata.jme_tx_desc_cnt) 221 #define JME_RX_RING_SIZE(rdata) \ 222 (sizeof(struct jme_desc) * (rdata)->jme_rx_desc_cnt) 223 #define JME_SSB_SIZE sizeof(struct jme_ssb) 224 225 /* 226 * Software state per device. 227 */ 228 struct jme_softc { 229 struct arpcom arpcom; 230 device_t jme_dev; 231 232 int jme_mem_rid; 233 struct resource *jme_mem_res; 234 bus_space_tag_t jme_mem_bt; 235 bus_space_handle_t jme_mem_bh; 236 237 int jme_irq_type; 238 int jme_irq_rid; 239 struct resource *jme_irq_res; 240 void *jme_irq_handle; 241 struct jme_msix_data jme_msix[JME_NMSIX]; 242 int jme_msix_cnt; 243 uint32_t jme_msinum[JME_MSINUM_CNT]; 244 int jme_tx_cpuid; 245 246 device_t jme_miibus; 247 int jme_phyaddr; 248 bus_addr_t jme_lowaddr; 249 250 uint32_t jme_clksrc; 251 uint32_t jme_clksrc_1000; 252 uint32_t jme_tx_dma_size; 253 uint32_t jme_rx_dma_size; 254 255 uint32_t jme_caps; 256 #define JME_CAP_FPGA 0x0001 257 #define JME_CAP_PCIE 0x0002 258 #define JME_CAP_PMCAP 0x0004 259 #define JME_CAP_FASTETH 0x0008 260 #define JME_CAP_JUMBO 0x0010 261 262 uint32_t jme_workaround; 263 #define JME_WA_EXTFIFO 0x0001 264 #define JME_WA_HDX 0x0002 265 266 boolean_t jme_has_link; 267 boolean_t jme_in_tick; 268 269 struct lwkt_serialize jme_serialize; 270 struct lwkt_serialize *jme_serialize_arr[JME_NSERIALIZE]; 271 int jme_serialize_cnt; 272 273 struct callout jme_tick_ch; 274 struct jme_chain_data jme_cdata; 275 int jme_if_flags; 276 uint32_t jme_txcsr; 277 uint32_t jme_rxcsr; 278 279 struct sysctl_ctx_list jme_sysctl_ctx; 280 struct sysctl_oid *jme_sysctl_tree; 281 282 /* 283 * Sysctl variables 284 */ 285 int jme_tx_coal_to; 286 int jme_tx_coal_pkt; 287 int jme_rx_coal_to; 288 int jme_rx_coal_pkt; 289 int jme_rss_debug; 290 }; 291 292 /* Register access macros. */ 293 #define CSR_WRITE_4(_sc, reg, val) \ 294 bus_space_write_4((_sc)->jme_mem_bt, (_sc)->jme_mem_bh, (reg), (val)) 295 #define CSR_READ_4(_sc, reg) \ 296 bus_space_read_4((_sc)->jme_mem_bt, (_sc)->jme_mem_bh, (reg)) 297 298 #define JME_MAXERR 5 299 300 #define JME_RXCHAIN_RESET(rdata) \ 301 do { \ 302 (rdata)->jme_rxhead = NULL; \ 303 (rdata)->jme_rxtail = NULL; \ 304 (rdata)->jme_rxlen = 0; \ 305 } while (0) 306 307 #define JME_TX_TIMEOUT 5 308 #define JME_TIMEOUT 1000 309 #define JME_PHY_TIMEOUT 1000 310 #define JME_EEPROM_TIMEOUT 1000 311 312 #define JME_TXD_RSVD 1 313 /* Large enough to cooperate 64K TSO segment and one spare TX descriptor */ 314 #define JME_TXD_SPARE 34 315 316 #define JME_ENABLE_HWRSS(sc) \ 317 ((sc)->jme_cdata.jme_rx_ring_cnt > JME_NRXRING_MIN) 318 319 #endif 320