1 /*- 2 * Copyright (c) 2010-2016 Solarflare Communications Inc. 3 * All rights reserved. 4 * 5 * This software was developed in part by Philip Paeps under contract for 6 * Solarflare Communications, Inc. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions are met: 10 * 11 * 1. Redistributions of source code must retain the above copyright notice, 12 * this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright notice, 14 * this list of conditions and the following disclaimer in the documentation 15 * and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 18 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 19 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 20 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 21 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 23 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 24 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 25 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 26 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 27 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28 * 29 * The views and conclusions contained in the software and documentation are 30 * those of the authors and should not be interpreted as representing official 31 * policies, either expressed or implied, of the FreeBSD Project. 32 * 33 * $FreeBSD$ 34 */ 35 36 #ifndef _SFXGE_H 37 #define _SFXGE_H 38 39 #include <sys/param.h> 40 #include <sys/kernel.h> 41 #include <sys/socket.h> 42 #include <sys/sysctl.h> 43 #include <sys/sx.h> 44 #include <vm/uma.h> 45 46 #include <net/ethernet.h> 47 #include <net/if.h> 48 #include <net/if_var.h> 49 #include <net/if_media.h> 50 #include <net/if_types.h> 51 52 #include "sfxge_ioc.h" 53 54 /* 55 * Debugging 56 */ 57 #if 0 58 #define DBGPRINT(dev, fmt, args...) \ 59 device_printf(dev, "%s: " fmt "\n", __func__, ## args) 60 #else 61 #define DBGPRINT(dev, fmt, args...) 62 #endif 63 64 /* 65 * Backward-compatibility 66 */ 67 #ifndef CACHE_LINE_SIZE 68 /* This should be right on most machines the driver will be used on, and 69 * we needn't care too much about wasting a few KB per interface. 70 */ 71 #define CACHE_LINE_SIZE 128 72 #endif 73 74 #ifndef IFCAP_LINKSTATE 75 #define IFCAP_LINKSTATE 0 76 #endif 77 78 #ifndef IFCAP_VLAN_HWTSO 79 #define IFCAP_VLAN_HWTSO 0 80 #endif 81 82 #ifndef IFM_10G_T 83 #define IFM_10G_T IFM_UNKNOWN 84 #endif 85 86 #ifndef IFM_10G_KX4 87 #define IFM_10G_KX4 IFM_10G_CX4 88 #endif 89 90 #ifndef IFM_40G_CR4 91 #define IFM_40G_CR4 IFM_UNKNOWN 92 #endif 93 94 #if (__FreeBSD_version >= 800501 && __FreeBSD_version < 900000) || \ 95 __FreeBSD_version >= 900003 96 #define SFXGE_HAVE_DESCRIBE_INTR 97 #endif 98 99 #ifdef IFM_ETH_RXPAUSE 100 #define SFXGE_HAVE_PAUSE_MEDIAOPTS 101 #endif 102 103 #ifndef CTLTYPE_U64 104 #define CTLTYPE_U64 CTLTYPE_QUAD 105 #endif 106 107 #include "sfxge_rx.h" 108 #include "sfxge_tx.h" 109 110 #define ROUNDUP_POW_OF_TWO(_n) (1ULL << flsl((_n) - 1)) 111 112 #define SFXGE_IP_ALIGN 2 113 114 #define SFXGE_ETHERTYPE_LOOPBACK 0x9000 /* Xerox loopback */ 115 116 117 #define SFXGE_MAGIC_RESERVED 0x8000 118 119 #define SFXGE_MAGIC_DMAQ_LABEL_WIDTH 6 120 #define SFXGE_MAGIC_DMAQ_LABEL_MASK \ 121 ((1 << SFXGE_MAGIC_DMAQ_LABEL_WIDTH) - 1) 122 123 enum sfxge_sw_ev { 124 SFXGE_SW_EV_RX_QFLUSH_DONE = 1, 125 SFXGE_SW_EV_RX_QFLUSH_FAILED, 126 SFXGE_SW_EV_RX_QREFILL, 127 SFXGE_SW_EV_TX_QFLUSH_DONE, 128 }; 129 130 #define SFXGE_SW_EV_MAGIC(_sw_ev) \ 131 (SFXGE_MAGIC_RESERVED | ((_sw_ev) << SFXGE_MAGIC_DMAQ_LABEL_WIDTH)) 132 133 static inline uint16_t 134 sfxge_sw_ev_mk_magic(enum sfxge_sw_ev sw_ev, unsigned int label) 135 { 136 KASSERT((label & SFXGE_MAGIC_DMAQ_LABEL_MASK) == label, 137 ("(label & SFXGE_MAGIC_DMAQ_LABEL_MASK) != label")); 138 return SFXGE_SW_EV_MAGIC(sw_ev) | label; 139 } 140 141 static inline uint16_t 142 sfxge_sw_ev_rxq_magic(enum sfxge_sw_ev sw_ev, struct sfxge_rxq *rxq) 143 { 144 return sfxge_sw_ev_mk_magic(sw_ev, 0); 145 } 146 147 static inline uint16_t 148 sfxge_sw_ev_txq_magic(enum sfxge_sw_ev sw_ev, struct sfxge_txq *txq) 149 { 150 return sfxge_sw_ev_mk_magic(sw_ev, txq->type); 151 } 152 153 enum sfxge_evq_state { 154 SFXGE_EVQ_UNINITIALIZED = 0, 155 SFXGE_EVQ_INITIALIZED, 156 SFXGE_EVQ_STARTING, 157 SFXGE_EVQ_STARTED 158 }; 159 160 #define SFXGE_EV_BATCH 16384 161 162 #define SFXGE_STATS_UPDATE_PERIOD_MS 1000 163 164 struct sfxge_evq { 165 /* Structure members below are sorted by usage order */ 166 struct sfxge_softc *sc; 167 struct mtx lock; 168 unsigned int index; 169 enum sfxge_evq_state init_state; 170 efsys_mem_t mem; 171 efx_evq_t *common; 172 unsigned int read_ptr; 173 boolean_t exception; 174 unsigned int rx_done; 175 unsigned int tx_done; 176 177 /* Linked list of TX queues with completions to process */ 178 struct sfxge_txq *txq; 179 struct sfxge_txq **txqs; 180 181 /* Structure members not used on event processing path */ 182 unsigned int buf_base_id; 183 unsigned int entries; 184 char lock_name[SFXGE_LOCK_NAME_MAX]; 185 } __aligned(CACHE_LINE_SIZE); 186 187 #define SFXGE_NDESCS 1024 188 #define SFXGE_MODERATION 30 189 190 enum sfxge_intr_state { 191 SFXGE_INTR_UNINITIALIZED = 0, 192 SFXGE_INTR_INITIALIZED, 193 SFXGE_INTR_TESTING, 194 SFXGE_INTR_STARTED 195 }; 196 197 struct sfxge_intr_hdl { 198 int eih_rid; 199 void *eih_tag; 200 struct resource *eih_res; 201 }; 202 203 struct sfxge_intr { 204 enum sfxge_intr_state state; 205 struct resource *msix_res; 206 struct sfxge_intr_hdl *table; 207 int n_alloc; 208 int type; 209 efsys_mem_t status; 210 uint32_t zero_count; 211 }; 212 213 enum sfxge_mcdi_state { 214 SFXGE_MCDI_UNINITIALIZED = 0, 215 SFXGE_MCDI_INITIALIZED, 216 SFXGE_MCDI_BUSY, 217 SFXGE_MCDI_COMPLETED 218 }; 219 220 struct sfxge_mcdi { 221 struct mtx lock; 222 efsys_mem_t mem; 223 enum sfxge_mcdi_state state; 224 efx_mcdi_transport_t transport; 225 226 /* Only used in debugging output */ 227 char lock_name[SFXGE_LOCK_NAME_MAX]; 228 }; 229 230 struct sfxge_hw_stats { 231 clock_t update_time; 232 efsys_mem_t dma_buf; 233 void *decode_buf; 234 }; 235 236 enum sfxge_port_state { 237 SFXGE_PORT_UNINITIALIZED = 0, 238 SFXGE_PORT_INITIALIZED, 239 SFXGE_PORT_STARTED 240 }; 241 242 struct sfxge_port { 243 struct sfxge_softc *sc; 244 struct mtx lock; 245 enum sfxge_port_state init_state; 246 #ifndef SFXGE_HAVE_PAUSE_MEDIAOPTS 247 unsigned int wanted_fc; 248 #endif 249 struct sfxge_hw_stats phy_stats; 250 struct sfxge_hw_stats mac_stats; 251 uint16_t stats_update_period_ms; 252 efx_link_mode_t link_mode; 253 uint8_t mcast_addrs[EFX_MAC_MULTICAST_LIST_MAX * 254 EFX_MAC_ADDR_LEN]; 255 unsigned int mcast_count; 256 257 /* Only used in debugging output */ 258 char lock_name[SFXGE_LOCK_NAME_MAX]; 259 }; 260 261 enum sfxge_softc_state { 262 SFXGE_UNINITIALIZED = 0, 263 SFXGE_INITIALIZED, 264 SFXGE_REGISTERED, 265 SFXGE_STARTED 266 }; 267 268 struct sfxge_softc { 269 device_t dev; 270 struct sx softc_lock; 271 char softc_lock_name[SFXGE_LOCK_NAME_MAX]; 272 enum sfxge_softc_state init_state; 273 struct ifnet *ifnet; 274 unsigned int if_flags; 275 struct sysctl_oid *stats_node; 276 struct sysctl_oid *txqs_node; 277 278 struct task task_reset; 279 280 efx_family_t family; 281 caddr_t vpd_data; 282 size_t vpd_size; 283 efx_nic_t *enp; 284 efsys_lock_t enp_lock; 285 286 unsigned int rxq_entries; 287 unsigned int txq_entries; 288 289 bus_dma_tag_t parent_dma_tag; 290 efsys_bar_t bar; 291 292 struct sfxge_intr intr; 293 struct sfxge_mcdi mcdi; 294 struct sfxge_port port; 295 uint32_t buffer_table_next; 296 297 struct sfxge_evq *evq[SFXGE_RX_SCALE_MAX]; 298 unsigned int ev_moderation; 299 #if EFSYS_OPT_QSTATS 300 clock_t ev_stats_update_time; 301 uint64_t ev_stats[EV_NQSTATS]; 302 #endif 303 304 unsigned int max_rss_channels; 305 struct sfxge_rxq *rxq[SFXGE_RX_SCALE_MAX]; 306 unsigned int rx_indir_table[EFX_RSS_TBL_SIZE]; 307 308 struct sfxge_txq *txq[SFXGE_TXQ_NTYPES + SFXGE_RX_SCALE_MAX]; 309 310 struct ifmedia media; 311 312 size_t rx_prefix_size; 313 size_t rx_buffer_size; 314 size_t rx_buffer_align; 315 int rx_cluster_size; 316 317 unsigned int evq_max; 318 unsigned int evq_count; 319 unsigned int rxq_count; 320 unsigned int txq_count; 321 322 unsigned int tso_fw_assisted; 323 #define SFXGE_FATSOV1 (1 << 0) 324 #define SFXGE_FATSOV2 (1 << 1) 325 326 #if EFSYS_OPT_MCDI_LOGGING 327 int mcdi_logging; 328 #endif 329 }; 330 331 #define SFXGE_LINK_UP(sc) \ 332 ((sc)->port.link_mode != EFX_LINK_DOWN && \ 333 (sc)->port.link_mode != EFX_LINK_UNKNOWN) 334 #define SFXGE_RUNNING(sc) ((sc)->ifnet->if_drv_flags & IFF_DRV_RUNNING) 335 336 #define SFXGE_PARAM(_name) "hw.sfxge." #_name 337 338 SYSCTL_DECL(_hw_sfxge); 339 340 /* 341 * From sfxge.c. 342 */ 343 extern void sfxge_schedule_reset(struct sfxge_softc *sc); 344 extern void sfxge_sram_buf_tbl_alloc(struct sfxge_softc *sc, size_t n, 345 uint32_t *idp); 346 347 /* 348 * From sfxge_dma.c. 349 */ 350 extern int sfxge_dma_init(struct sfxge_softc *sc); 351 extern void sfxge_dma_fini(struct sfxge_softc *sc); 352 extern int sfxge_dma_alloc(struct sfxge_softc *sc, bus_size_t len, 353 efsys_mem_t *esmp); 354 extern void sfxge_dma_free(efsys_mem_t *esmp); 355 extern int sfxge_dma_map_sg_collapse(bus_dma_tag_t tag, bus_dmamap_t map, 356 struct mbuf **mp, 357 bus_dma_segment_t *segs, 358 int *nsegs, int maxsegs); 359 360 /* 361 * From sfxge_ev.c. 362 */ 363 extern int sfxge_ev_init(struct sfxge_softc *sc); 364 extern void sfxge_ev_fini(struct sfxge_softc *sc); 365 extern int sfxge_ev_start(struct sfxge_softc *sc); 366 extern void sfxge_ev_stop(struct sfxge_softc *sc); 367 extern int sfxge_ev_qpoll(struct sfxge_evq *evq); 368 369 /* 370 * From sfxge_intr.c. 371 */ 372 extern int sfxge_intr_init(struct sfxge_softc *sc); 373 extern void sfxge_intr_fini(struct sfxge_softc *sc); 374 extern int sfxge_intr_start(struct sfxge_softc *sc); 375 extern void sfxge_intr_stop(struct sfxge_softc *sc); 376 377 /* 378 * From sfxge_mcdi.c. 379 */ 380 extern int sfxge_mcdi_init(struct sfxge_softc *sc); 381 extern void sfxge_mcdi_fini(struct sfxge_softc *sc); 382 extern int sfxge_mcdi_ioctl(struct sfxge_softc *sc, sfxge_ioc_t *ip); 383 384 /* 385 * From sfxge_nvram.c. 386 */ 387 extern int sfxge_nvram_ioctl(struct sfxge_softc *sc, sfxge_ioc_t *ip); 388 389 /* 390 * From sfxge_port.c. 391 */ 392 extern int sfxge_port_init(struct sfxge_softc *sc); 393 extern void sfxge_port_fini(struct sfxge_softc *sc); 394 extern int sfxge_port_start(struct sfxge_softc *sc); 395 extern void sfxge_port_stop(struct sfxge_softc *sc); 396 extern void sfxge_mac_link_update(struct sfxge_softc *sc, 397 efx_link_mode_t mode); 398 extern int sfxge_mac_filter_set(struct sfxge_softc *sc); 399 extern int sfxge_port_ifmedia_init(struct sfxge_softc *sc); 400 extern uint64_t sfxge_get_counter(struct ifnet *ifp, ift_counter c); 401 402 #define SFXGE_MAX_MTU (9 * 1024) 403 404 #define SFXGE_ADAPTER_LOCK_INIT(_sc, _ifname) \ 405 do { \ 406 struct sfxge_softc *__sc = (_sc); \ 407 \ 408 snprintf((__sc)->softc_lock_name, \ 409 sizeof((__sc)->softc_lock_name), \ 410 "%s:softc", (_ifname)); \ 411 sx_init(&(__sc)->softc_lock, (__sc)->softc_lock_name); \ 412 } while (B_FALSE) 413 #define SFXGE_ADAPTER_LOCK_DESTROY(_sc) \ 414 sx_destroy(&(_sc)->softc_lock) 415 #define SFXGE_ADAPTER_LOCK(_sc) \ 416 sx_xlock(&(_sc)->softc_lock) 417 #define SFXGE_ADAPTER_UNLOCK(_sc) \ 418 sx_xunlock(&(_sc)->softc_lock) 419 #define SFXGE_ADAPTER_LOCK_ASSERT_OWNED(_sc) \ 420 sx_assert(&(_sc)->softc_lock, LA_XLOCKED) 421 422 #define SFXGE_PORT_LOCK_INIT(_port, _ifname) \ 423 do { \ 424 struct sfxge_port *__port = (_port); \ 425 \ 426 snprintf((__port)->lock_name, \ 427 sizeof((__port)->lock_name), \ 428 "%s:port", (_ifname)); \ 429 mtx_init(&(__port)->lock, (__port)->lock_name, \ 430 NULL, MTX_DEF); \ 431 } while (B_FALSE) 432 #define SFXGE_PORT_LOCK_DESTROY(_port) \ 433 mtx_destroy(&(_port)->lock) 434 #define SFXGE_PORT_LOCK(_port) \ 435 mtx_lock(&(_port)->lock) 436 #define SFXGE_PORT_UNLOCK(_port) \ 437 mtx_unlock(&(_port)->lock) 438 #define SFXGE_PORT_LOCK_ASSERT_OWNED(_port) \ 439 mtx_assert(&(_port)->lock, MA_OWNED) 440 441 #define SFXGE_MCDI_LOCK_INIT(_mcdi, _ifname) \ 442 do { \ 443 struct sfxge_mcdi *__mcdi = (_mcdi); \ 444 \ 445 snprintf((__mcdi)->lock_name, \ 446 sizeof((__mcdi)->lock_name), \ 447 "%s:mcdi", (_ifname)); \ 448 mtx_init(&(__mcdi)->lock, (__mcdi)->lock_name, \ 449 NULL, MTX_DEF); \ 450 } while (B_FALSE) 451 #define SFXGE_MCDI_LOCK_DESTROY(_mcdi) \ 452 mtx_destroy(&(_mcdi)->lock) 453 #define SFXGE_MCDI_LOCK(_mcdi) \ 454 mtx_lock(&(_mcdi)->lock) 455 #define SFXGE_MCDI_UNLOCK(_mcdi) \ 456 mtx_unlock(&(_mcdi)->lock) 457 #define SFXGE_MCDI_LOCK_ASSERT_OWNED(_mcdi) \ 458 mtx_assert(&(_mcdi)->lock, MA_OWNED) 459 460 #define SFXGE_EVQ_LOCK_INIT(_evq, _ifname, _evq_index) \ 461 do { \ 462 struct sfxge_evq *__evq = (_evq); \ 463 \ 464 snprintf((__evq)->lock_name, \ 465 sizeof((__evq)->lock_name), \ 466 "%s:evq%u", (_ifname), (_evq_index)); \ 467 mtx_init(&(__evq)->lock, (__evq)->lock_name, \ 468 NULL, MTX_DEF); \ 469 } while (B_FALSE) 470 #define SFXGE_EVQ_LOCK_DESTROY(_evq) \ 471 mtx_destroy(&(_evq)->lock) 472 #define SFXGE_EVQ_LOCK(_evq) \ 473 mtx_lock(&(_evq)->lock) 474 #define SFXGE_EVQ_UNLOCK(_evq) \ 475 mtx_unlock(&(_evq)->lock) 476 #define SFXGE_EVQ_LOCK_ASSERT_OWNED(_evq) \ 477 mtx_assert(&(_evq)->lock, MA_OWNED) 478 479 #endif /* _SFXGE_H */ 480