1 /****************************************************************************** 2 3 Copyright (c) 2013-2018, Intel Corporation 4 All rights reserved. 5 6 Redistribution and use in source and binary forms, with or without 7 modification, are permitted provided that the following conditions are met: 8 9 1. Redistributions of source code must retain the above copyright notice, 10 this list of conditions and the following disclaimer. 11 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 16 3. Neither the name of the Intel Corporation nor the names of its 17 contributors may be used to endorse or promote products derived from 18 this software without specific prior written permission. 19 20 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 21 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 24 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30 POSSIBILITY OF SUCH DAMAGE. 31 32 ******************************************************************************/ 33 /*$FreeBSD$*/ 34 35 #ifndef _IXL_H_ 36 #define _IXL_H_ 37 38 #include "opt_inet.h" 39 #include "opt_inet6.h" 40 #include "opt_rss.h" 41 #include "opt_ixl.h" 42 43 #include <sys/param.h> 44 #include <sys/systm.h> 45 #include <sys/buf_ring.h> 46 #include <sys/mbuf.h> 47 #include <sys/protosw.h> 48 #include <sys/socket.h> 49 #include <sys/malloc.h> 50 #include <sys/kernel.h> 51 #include <sys/module.h> 52 #include <sys/sockio.h> 53 #include <sys/eventhandler.h> 54 #include <sys/syslog.h> 55 #include <sys/priv.h> 56 #include <sys/bitstring.h> 57 58 #include <net/if.h> 59 #include <net/if_var.h> 60 #include <net/if_arp.h> 61 #include <net/bpf.h> 62 #include <net/ethernet.h> 63 #include <net/if_dl.h> 64 #include <net/if_media.h> 65 #include <net/iflib.h> 66 67 #include <net/bpf.h> 68 #include <net/if_types.h> 69 #include <net/if_vlan_var.h> 70 71 #include <netinet/in_systm.h> 72 #include <netinet/in.h> 73 #include <netinet/if_ether.h> 74 #include <netinet/ip.h> 75 #include <netinet/ip6.h> 76 #include <netinet/tcp.h> 77 #include <netinet/tcp_lro.h> 78 #include <netinet/udp.h> 79 #include <netinet/sctp.h> 80 81 #include <machine/in_cksum.h> 82 83 #include <sys/bus.h> 84 #include <machine/bus.h> 85 #include <sys/rman.h> 86 #include <machine/resource.h> 87 #include <vm/vm.h> 88 #include <vm/pmap.h> 89 #include <machine/clock.h> 90 #include <dev/pci/pcivar.h> 91 #include <dev/pci/pcireg.h> 92 #include <sys/proc.h> 93 #include <sys/sysctl.h> 94 #include <sys/endian.h> 95 #include <sys/taskqueue.h> 96 #include <sys/pcpu.h> 97 #include <sys/smp.h> 98 #include <sys/sbuf.h> 99 #include <machine/smp.h> 100 #include <machine/stdarg.h> 101 102 #ifdef RSS 103 #include <net/rss_config.h> 104 #include <netinet/in_rss.h> 105 #endif 106 107 #include "ifdi_if.h" 108 #include "i40e_type.h" 109 #include "i40e_prototype.h" 110 #include "ixl_debug.h" 111 112 #define PVIDV(vendor, devid, name) \ 113 PVID(vendor, devid, name " - " IXL_DRIVER_VERSION_STRING) 114 115 /* Tunables */ 116 117 /* 118 * Ring Descriptors Valid Range: 32-4096 Default Value: 1024 This value is the 119 * number of tx/rx descriptors allocated by the driver. Increasing this 120 * value allows the driver to queue more operations. 121 * 122 * Tx descriptors are always 16 bytes, but Rx descriptors can be 32 bytes. 123 * The driver currently always uses 32 byte Rx descriptors. 124 */ 125 #define IXL_DEFAULT_RING 1024 126 #define IXL_MAX_RING 4096 127 #define IXL_MIN_RING 64 128 #define IXL_RING_INCREMENT 32 129 130 #define IXL_AQ_LEN 256 131 #define IXL_AQ_LEN_MAX 1024 132 133 /* Alignment for rings */ 134 #define DBA_ALIGN 128 135 136 #define MAX_MULTICAST_ADDR 128 137 138 #define IXL_MSIX_BAR 3 139 #define IXL_ADM_LIMIT 2 140 #define IXL_TSO_SIZE ((255*1024)-1) 141 #define IXL_TX_BUF_SZ ((u32) 1514) 142 #define IXL_AQ_BUF_SZ ((u32) 4096) 143 #define IXL_RX_ITR 0 144 #define IXL_TX_ITR 1 145 #define IXL_ITR_NONE 3 146 #define IXL_QUEUE_EOL 0x7FF 147 #define IXL_MIN_FRAME 17 148 #define IXL_MAX_FRAME 9728 149 #define IXL_MAX_TX_SEGS 8 150 #define IXL_MAX_RX_SEGS 5 151 #define IXL_MAX_TSO_SEGS 128 152 #define IXL_SPARSE_CHAIN 7 153 #define IXL_MIN_TSO_MSS 64 154 #define IXL_MAX_TSO_MSS 9668 155 #define IXL_MAX_DMA_SEG_SIZE ((16 * 1024) - 1) 156 157 #define IXL_RSS_KEY_SIZE_REG 13 158 #define IXL_RSS_KEY_SIZE (IXL_RSS_KEY_SIZE_REG * 4) 159 #define IXL_RSS_VSI_LUT_SIZE 64 /* X722 -> VSI, X710 -> VF */ 160 #define IXL_RSS_VSI_LUT_ENTRY_MASK 0x3F 161 #define IXL_RSS_VF_LUT_ENTRY_MASK 0xF 162 163 #define IXL_VF_MAX_BUFFER 0x3F80 164 #define IXL_VF_MAX_HDR_BUFFER 0x840 165 #define IXL_VF_MAX_FRAME 0x3FFF 166 167 #define IXL_NVM_VERSION_LO_SHIFT 0 168 #define IXL_NVM_VERSION_LO_MASK (0xff << IXL_NVM_VERSION_LO_SHIFT) 169 #define IXL_NVM_VERSION_HI_SHIFT 12 170 #define IXL_NVM_VERSION_HI_MASK (0xf << IXL_NVM_VERSION_HI_SHIFT) 171 172 /* 173 * Interrupt Moderation parameters 174 * Multiply ITR values by 2 for real ITR value 175 */ 176 #define IXL_MAX_ITR 0x0FF0 177 #define IXL_ITR_100K 0x0005 178 #define IXL_ITR_20K 0x0019 179 #define IXL_ITR_8K 0x003E 180 #define IXL_ITR_4K 0x007A 181 #define IXL_ITR_1K 0x01F4 182 #define IXL_ITR_DYNAMIC 0x8000 183 #define IXL_LOW_LATENCY 0 184 #define IXL_AVE_LATENCY 1 185 #define IXL_BULK_LATENCY 2 186 187 /* MacVlan Flags */ 188 #define IXL_FILTER_VLAN (u16)(1 << 0) 189 #define IXL_FILTER_MC (u16)(1 << 1) 190 191 /* used in the vlan field of the filter when not a vlan */ 192 #define IXL_VLAN_ANY -1 193 194 /* Maximum number of MAC/VLAN filters supported by HW */ 195 #define IXL_MAX_VLAN_FILTERS 255 196 197 #define CSUM_OFFLOAD_IPV4 (CSUM_IP|CSUM_TCP|CSUM_UDP|CSUM_SCTP) 198 #define CSUM_OFFLOAD_IPV6 (CSUM_TCP_IPV6|CSUM_UDP_IPV6|CSUM_SCTP_IPV6) 199 #define CSUM_OFFLOAD (CSUM_OFFLOAD_IPV4|CSUM_OFFLOAD_IPV6|CSUM_TSO) 200 201 /* Misc flags for ixl_vsi.flags */ 202 #define IXL_FLAGS_KEEP_TSO4 (1 << 0) 203 #define IXL_FLAGS_KEEP_TSO6 (1 << 1) 204 #define IXL_FLAGS_USES_MSIX (1 << 2) 205 #define IXL_FLAGS_IS_VF (1 << 3) 206 207 #define IXL_VSI_IS_PF(v) ((v->flags & IXL_FLAGS_IS_VF) == 0) 208 #define IXL_VSI_IS_VF(v) ((v->flags & IXL_FLAGS_IS_VF) != 0) 209 210 #define IXL_VF_RESET_TIMEOUT 100 211 212 #define IXL_VSI_DATA_PORT 0x01 213 214 #define IAVF_MAX_QUEUES 16 215 #define IXL_MAX_VSI_QUEUES (2 * (I40E_VSILAN_QTABLE_MAX_INDEX + 1)) 216 217 #define IXL_RX_CTX_BASE_UNITS 128 218 #define IXL_TX_CTX_BASE_UNITS 128 219 220 #define IXL_PF_PCI_CIAA_VF_DEVICE_STATUS 0xAA 221 222 #define IXL_PF_PCI_CIAD_VF_TRANS_PENDING_MASK 0x20 223 224 #define IXL_GLGEN_VFLRSTAT_INDEX(glb_vf) ((glb_vf) / 32) 225 #define IXL_GLGEN_VFLRSTAT_MASK(glb_vf) (1 << ((glb_vf) % 32)) 226 227 #define IXL_MAX_ITR_IDX 3 228 229 #define IXL_END_OF_INTR_LNKLST 0x7FF 230 231 #define IXL_DEFAULT_RSS_HENA_BASE (\ 232 BIT_ULL(I40E_FILTER_PCTYPE_NONF_IPV4_UDP) | \ 233 BIT_ULL(I40E_FILTER_PCTYPE_NONF_IPV4_TCP) | \ 234 BIT_ULL(I40E_FILTER_PCTYPE_NONF_IPV4_SCTP) | \ 235 BIT_ULL(I40E_FILTER_PCTYPE_NONF_IPV4_OTHER) | \ 236 BIT_ULL(I40E_FILTER_PCTYPE_FRAG_IPV4) | \ 237 BIT_ULL(I40E_FILTER_PCTYPE_NONF_IPV6_UDP) | \ 238 BIT_ULL(I40E_FILTER_PCTYPE_NONF_IPV6_TCP) | \ 239 BIT_ULL(I40E_FILTER_PCTYPE_NONF_IPV6_SCTP) | \ 240 BIT_ULL(I40E_FILTER_PCTYPE_NONF_IPV6_OTHER) | \ 241 BIT_ULL(I40E_FILTER_PCTYPE_FRAG_IPV6) | \ 242 BIT_ULL(I40E_FILTER_PCTYPE_L2_PAYLOAD)) 243 244 #define IXL_DEFAULT_RSS_HENA_XL710 IXL_DEFAULT_RSS_HENA_BASE 245 246 #define IXL_DEFAULT_RSS_HENA_X722 (\ 247 IXL_DEFAULT_RSS_HENA_BASE | \ 248 BIT_ULL(I40E_FILTER_PCTYPE_NONF_UNICAST_IPV4_UDP) | \ 249 BIT_ULL(I40E_FILTER_PCTYPE_NONF_MULTICAST_IPV4_UDP) | \ 250 BIT_ULL(I40E_FILTER_PCTYPE_NONF_UNICAST_IPV6_UDP) | \ 251 BIT_ULL(I40E_FILTER_PCTYPE_NONF_MULTICAST_IPV6_UDP) | \ 252 BIT_ULL(I40E_FILTER_PCTYPE_NONF_IPV4_TCP_SYN_NO_ACK) | \ 253 BIT_ULL(I40E_FILTER_PCTYPE_NONF_IPV6_TCP_SYN_NO_ACK)) 254 255 #define IXL_CAPS \ 256 (IFCAP_TSO4 | IFCAP_TSO6 | \ 257 IFCAP_TXCSUM | IFCAP_TXCSUM_IPV6 | \ 258 IFCAP_RXCSUM | IFCAP_RXCSUM_IPV6 | \ 259 IFCAP_VLAN_HWFILTER | IFCAP_VLAN_HWTSO | \ 260 IFCAP_VLAN_HWTAGGING | IFCAP_VLAN_HWCSUM | \ 261 IFCAP_VLAN_MTU | IFCAP_JUMBO_MTU | IFCAP_LRO) 262 263 #define IXL_CSUM_TCP \ 264 (CSUM_IP_TCP|CSUM_IP_TSO|CSUM_IP6_TSO|CSUM_IP6_TCP) 265 #define IXL_CSUM_UDP \ 266 (CSUM_IP_UDP|CSUM_IP6_UDP) 267 #define IXL_CSUM_SCTP \ 268 (CSUM_IP_SCTP|CSUM_IP6_SCTP) 269 #define IXL_CSUM_IPV4 \ 270 (CSUM_IP|CSUM_IP_TSO) 271 272 /* Pre-11 counter(9) compatibility */ 273 #define IXL_SET_IPACKETS(vsi, count) (vsi)->ipackets = (count) 274 #define IXL_SET_IERRORS(vsi, count) (vsi)->ierrors = (count) 275 #define IXL_SET_OPACKETS(vsi, count) (vsi)->opackets = (count) 276 #define IXL_SET_OERRORS(vsi, count) (vsi)->oerrors = (count) 277 #define IXL_SET_COLLISIONS(vsi, count) /* Do nothing; collisions is always 0. */ 278 #define IXL_SET_IBYTES(vsi, count) (vsi)->ibytes = (count) 279 #define IXL_SET_OBYTES(vsi, count) (vsi)->obytes = (count) 280 #define IXL_SET_IMCASTS(vsi, count) (vsi)->imcasts = (count) 281 #define IXL_SET_OMCASTS(vsi, count) (vsi)->omcasts = (count) 282 #define IXL_SET_IQDROPS(vsi, count) (vsi)->iqdrops = (count) 283 #define IXL_SET_OQDROPS(vsi, count) (vsi)->oqdrops = (count) 284 #define IXL_SET_NOPROTO(vsi, count) (vsi)->noproto = (count) 285 286 /* For stats sysctl naming */ 287 #define IXL_QUEUE_NAME_LEN 32 288 289 MALLOC_DECLARE(M_IXL); 290 291 #define IXL_DEV_ERR(_dev, _format, ...) \ 292 device_printf(_dev, "%s: " _format " (%s:%d)\n", __func__, ##__VA_ARGS__, __FILE__, __LINE__) 293 294 /* 295 ***************************************************************************** 296 * vendor_info_array 297 * 298 * This array contains the list of Subvendor/Subdevice IDs on which the driver 299 * should load. 300 * 301 ***************************************************************************** 302 */ 303 typedef struct _ixl_vendor_info_t { 304 unsigned int vendor_id; 305 unsigned int device_id; 306 unsigned int subvendor_id; 307 unsigned int subdevice_id; 308 unsigned int index; 309 } ixl_vendor_info_t; 310 311 /* 312 ** This struct has multiple uses, multicast 313 ** addresses, vlans, and mac filters all use it. 314 */ 315 struct ixl_mac_filter { 316 LIST_ENTRY(ixl_mac_filter) ftle; 317 u8 macaddr[ETHER_ADDR_LEN]; 318 s16 vlan; 319 u16 flags; 320 }; 321 322 /* 323 * The Transmit ring control struct 324 */ 325 struct tx_ring { 326 struct ixl_tx_queue *que; 327 u32 tail; 328 struct i40e_tx_desc *tx_base; 329 u64 tx_paddr; 330 u32 latency; 331 u32 packets; 332 u32 me; 333 /* 334 * For reporting completed packet status 335 * in descriptor writeback mode 336 */ 337 qidx_t *tx_rsq; 338 qidx_t tx_rs_cidx; 339 qidx_t tx_rs_pidx; 340 qidx_t tx_cidx_processed; 341 342 /* Used for Dynamic ITR calculation */ 343 u32 itr; 344 u32 bytes; 345 346 /* Soft Stats */ 347 u64 tx_bytes; 348 u64 tx_packets; 349 u64 mss_too_small; 350 }; 351 352 353 /* 354 * The Receive ring control struct 355 */ 356 struct rx_ring { 357 struct ixl_rx_queue *que; 358 union i40e_rx_desc *rx_base; 359 uint64_t rx_paddr; 360 bool discard; 361 u32 itr; 362 u32 latency; 363 u32 mbuf_sz; 364 u32 tail; 365 u32 me; 366 367 /* Used for Dynamic ITR calculation */ 368 u32 packets; 369 u32 bytes; 370 371 /* Soft stats */ 372 u64 rx_packets; 373 u64 rx_bytes; 374 u64 desc_errs; 375 u64 csum_errs; 376 }; 377 378 /* 379 ** Driver queue structs 380 */ 381 struct ixl_tx_queue { 382 struct ixl_vsi *vsi; 383 struct tx_ring txr; 384 struct if_irq que_irq; 385 u32 msix; 386 /* Stats */ 387 u64 irqs; 388 u64 tso; 389 }; 390 391 struct ixl_rx_queue { 392 struct ixl_vsi *vsi; 393 struct rx_ring rxr; 394 struct if_irq que_irq; 395 u32 msix; /* This queue's MSIX vector */ 396 /* Stats */ 397 u64 irqs; 398 }; 399 400 /* 401 ** Virtual Station Interface 402 */ 403 LIST_HEAD(ixl_ftl_head, ixl_mac_filter); 404 struct ixl_vsi { 405 if_ctx_t ctx; 406 if_softc_ctx_t shared; 407 if_t ifp; 408 device_t dev; 409 struct i40e_hw *hw; 410 struct ifmedia *media; 411 412 int num_rx_queues; 413 int num_tx_queues; 414 415 void *back; 416 enum i40e_vsi_type type; 417 int id; 418 u32 rx_itr_setting; 419 u32 tx_itr_setting; 420 bool enable_head_writeback; 421 422 u16 vsi_num; 423 bool link_active; 424 u16 seid; 425 u16 uplink_seid; 426 u16 downlink_seid; 427 428 struct ixl_tx_queue *tx_queues; /* TX queue array */ 429 struct ixl_rx_queue *rx_queues; /* RX queue array */ 430 struct if_irq irq; 431 u32 link_speed; 432 433 /* MAC/VLAN Filter list */ 434 struct ixl_ftl_head ftl; 435 u16 num_macs; 436 u64 num_hw_filters; 437 438 /* Contains readylist & stat counter id */ 439 struct i40e_aqc_vsi_properties_data info; 440 441 #define IXL_VLANS_MAP_LEN EVL_VLID_MASK + 1 442 bitstr_t bit_decl(vlans_map, IXL_VLANS_MAP_LEN); 443 u16 num_vlans; 444 445 /* Per-VSI stats from hardware */ 446 struct i40e_eth_stats eth_stats; 447 struct i40e_eth_stats eth_stats_offsets; 448 bool stat_offsets_loaded; 449 /* VSI stat counters */ 450 u64 ipackets; 451 u64 ierrors; 452 u64 opackets; 453 u64 oerrors; 454 u64 ibytes; 455 u64 obytes; 456 u64 imcasts; 457 u64 omcasts; 458 u64 iqdrops; 459 u64 oqdrops; 460 u64 noproto; 461 462 /* Misc. */ 463 u64 flags; 464 /* Stats sysctls for this VSI */ 465 struct sysctl_oid *vsi_node; 466 struct sysctl_ctx_list sysctl_ctx; 467 }; 468 469 struct ixl_add_maddr_arg { 470 struct ixl_ftl_head to_add; 471 struct ixl_vsi *vsi; 472 }; 473 474 /* 475 ** Compare two ethernet addresses 476 */ 477 static inline bool 478 ixl_ether_is_equal(const u8 *ea1, const u8 *ea2) 479 { 480 return (bcmp(ea1, ea2, ETHER_ADDR_LEN) == 0); 481 } 482 483 /* 484 * Return next largest power of 2, unsigned 485 * 486 * Public domain, from Bit Twiddling Hacks 487 */ 488 static inline u32 489 next_power_of_two(u32 n) 490 { 491 n--; 492 n |= n >> 1; 493 n |= n >> 2; 494 n |= n >> 4; 495 n |= n >> 8; 496 n |= n >> 16; 497 n++; 498 499 /* Next power of two > 0 is 1 */ 500 n += (n == 0); 501 502 return (n); 503 } 504 505 /* 506 * Info for stats sysctls 507 */ 508 struct ixl_sysctl_info { 509 u64 *stat; 510 char *name; 511 char *description; 512 }; 513 514 extern const uint8_t ixl_bcast_addr[ETHER_ADDR_LEN]; 515 516 /* Common function prototypes between PF/VF driver */ 517 void ixl_debug_core(device_t dev, u32 enabled_mask, u32 mask, char *fmt, ...); 518 void ixl_init_tx_ring(struct ixl_vsi *vsi, struct ixl_tx_queue *que); 519 void ixl_get_default_rss_key(u32 *); 520 const char * i40e_vc_stat_str(struct i40e_hw *hw, 521 enum virtchnl_status_code stat_err); 522 void ixl_init_tx_rsqs(struct ixl_vsi *vsi); 523 void ixl_init_tx_cidx(struct ixl_vsi *vsi); 524 u64 ixl_max_vc_speed_to_value(u8 link_speeds); 525 void ixl_add_vsi_sysctls(device_t dev, struct ixl_vsi *vsi, 526 struct sysctl_ctx_list *ctx, const char *sysctl_name); 527 void ixl_add_sysctls_eth_stats(struct sysctl_ctx_list *ctx, 528 struct sysctl_oid_list *child, 529 struct i40e_eth_stats *eth_stats); 530 void ixl_vsi_add_queues_stats(struct ixl_vsi *vsi, 531 struct sysctl_ctx_list *ctx); 532 #endif /* _IXL_H_ */ 533