1 /*- 2 * Copyright (c) 2016 Matt Macy <mmacy@nextbsd.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, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 */ 26 27 /*$FreeBSD$*/ 28 #include "opt_ddb.h" 29 #include "opt_inet.h" 30 #include "opt_inet6.h" 31 32 #ifdef HAVE_KERNEL_OPTION_HEADERS 33 #include "opt_device_polling.h" 34 #endif 35 36 #include <sys/param.h> 37 #include <sys/systm.h> 38 #ifdef DDB 39 #include <sys/types.h> 40 #include <ddb/ddb.h> 41 #endif 42 #if __FreeBSD_version >= 800000 43 #include <sys/buf_ring.h> 44 #endif 45 #include <sys/bus.h> 46 #include <sys/endian.h> 47 #include <sys/kernel.h> 48 #include <sys/kthread.h> 49 #include <sys/malloc.h> 50 #include <sys/mbuf.h> 51 #include <sys/module.h> 52 #include <sys/rman.h> 53 #include <sys/smp.h> 54 #include <sys/socket.h> 55 #include <sys/sockio.h> 56 #include <sys/sysctl.h> 57 #include <sys/taskqueue.h> 58 #include <sys/eventhandler.h> 59 #include <machine/bus.h> 60 #include <machine/resource.h> 61 62 #include <net/bpf.h> 63 #include <net/ethernet.h> 64 #include <net/if.h> 65 #include <net/if_var.h> 66 #include <net/if_arp.h> 67 #include <net/if_dl.h> 68 #include <net/if_media.h> 69 #include <net/iflib.h> 70 71 #include <net/if_types.h> 72 #include <net/if_vlan_var.h> 73 74 #include <netinet/in_systm.h> 75 #include <netinet/in.h> 76 #include <netinet/if_ether.h> 77 #include <netinet/ip.h> 78 #include <netinet/ip6.h> 79 #include <netinet/tcp.h> 80 #include <netinet/udp.h> 81 82 #include <machine/in_cksum.h> 83 #include <dev/led/led.h> 84 #include <dev/pci/pcivar.h> 85 #include <dev/pci/pcireg.h> 86 87 #include "e1000_api.h" 88 #include "e1000_82571.h" 89 #include "ifdi_if.h" 90 91 92 #ifndef _EM_H_DEFINED_ 93 #define _EM_H_DEFINED_ 94 95 96 /* Tunables */ 97 98 /* 99 * EM_TXD: Maximum number of Transmit Descriptors 100 * Valid Range: 80-256 for 82542 and 82543-based adapters 101 * 80-4096 for others 102 * Default Value: 256 103 * This value is the number of transmit descriptors allocated by the driver. 104 * Increasing this value allows the driver to queue more transmits. Each 105 * descriptor is 16 bytes. 106 * Since TDLEN should be multiple of 128bytes, the number of transmit 107 * desscriptors should meet the following condition. 108 * (num_tx_desc * sizeof(struct e1000_tx_desc)) % 128 == 0 109 */ 110 #define EM_MIN_TXD 128 111 #define EM_MAX_TXD 4096 112 #define EM_DEFAULT_TXD 1024 113 #define EM_DEFAULT_MULTI_TXD 4096 114 115 /* 116 * EM_RXD - Maximum number of receive Descriptors 117 * Valid Range: 80-256 for 82542 and 82543-based adapters 118 * 80-4096 for others 119 * Default Value: 256 120 * This value is the number of receive descriptors allocated by the driver. 121 * Increasing this value allows the driver to buffer more incoming packets. 122 * Each descriptor is 16 bytes. A receive buffer is also allocated for each 123 * descriptor. The maximum MTU size is 16110. 124 * Since TDLEN should be multiple of 128bytes, the number of transmit 125 * desscriptors should meet the following condition. 126 * (num_tx_desc * sizeof(struct e1000_tx_desc)) % 128 == 0 127 */ 128 #define EM_MIN_RXD 128 129 #define EM_MAX_RXD 4096 130 #define EM_DEFAULT_RXD 1024 131 #define EM_DEFAULT_MULTI_RXD 4096 132 133 /* 134 * EM_TIDV - Transmit Interrupt Delay Value 135 * Valid Range: 0-65535 (0=off) 136 * Default Value: 64 137 * This value delays the generation of transmit interrupts in units of 138 * 1.024 microseconds. Transmit interrupt reduction can improve CPU 139 * efficiency if properly tuned for specific network traffic. If the 140 * system is reporting dropped transmits, this value may be set too high 141 * causing the driver to run out of available transmit descriptors. 142 */ 143 #define EM_TIDV 64 144 145 /* 146 * EM_TADV - Transmit Absolute Interrupt Delay Value 147 * (Not valid for 82542/82543/82544) 148 * Valid Range: 0-65535 (0=off) 149 * Default Value: 64 150 * This value, in units of 1.024 microseconds, limits the delay in which a 151 * transmit interrupt is generated. Useful only if EM_TIDV is non-zero, 152 * this value ensures that an interrupt is generated after the initial 153 * packet is sent on the wire within the set amount of time. Proper tuning, 154 * along with EM_TIDV, may improve traffic throughput in specific 155 * network conditions. 156 */ 157 #define EM_TADV 64 158 159 /* 160 * EM_RDTR - Receive Interrupt Delay Timer (Packet Timer) 161 * Valid Range: 0-65535 (0=off) 162 * Default Value: 0 163 * This value delays the generation of receive interrupts in units of 1.024 164 * microseconds. Receive interrupt reduction can improve CPU efficiency if 165 * properly tuned for specific network traffic. Increasing this value adds 166 * extra latency to frame reception and can end up decreasing the throughput 167 * of TCP traffic. If the system is reporting dropped receives, this value 168 * may be set too high, causing the driver to run out of available receive 169 * descriptors. 170 * 171 * CAUTION: When setting EM_RDTR to a value other than 0, adapters 172 * may hang (stop transmitting) under certain network conditions. 173 * If this occurs a WATCHDOG message is logged in the system 174 * event log. In addition, the controller is automatically reset, 175 * restoring the network connection. To eliminate the potential 176 * for the hang ensure that EM_RDTR is set to 0. 177 */ 178 #define EM_RDTR 0 179 180 /* 181 * Receive Interrupt Absolute Delay Timer (Not valid for 82542/82543/82544) 182 * Valid Range: 0-65535 (0=off) 183 * Default Value: 64 184 * This value, in units of 1.024 microseconds, limits the delay in which a 185 * receive interrupt is generated. Useful only if EM_RDTR is non-zero, 186 * this value ensures that an interrupt is generated after the initial 187 * packet is received within the set amount of time. Proper tuning, 188 * along with EM_RDTR, may improve traffic throughput in specific network 189 * conditions. 190 */ 191 #define EM_RADV 64 192 193 /* 194 * This parameter controls whether or not autonegotation is enabled. 195 * 0 - Disable autonegotiation 196 * 1 - Enable autonegotiation 197 */ 198 #define DO_AUTO_NEG 1 199 200 /* 201 * This parameter control whether or not the driver will wait for 202 * autonegotiation to complete. 203 * 1 - Wait for autonegotiation to complete 204 * 0 - Don't wait for autonegotiation to complete 205 */ 206 #define WAIT_FOR_AUTO_NEG_DEFAULT 0 207 208 /* Tunables -- End */ 209 210 #define AUTONEG_ADV_DEFAULT (ADVERTISE_10_HALF | ADVERTISE_10_FULL | \ 211 ADVERTISE_100_HALF | ADVERTISE_100_FULL | \ 212 ADVERTISE_1000_FULL) 213 214 #define AUTO_ALL_MODES 0 215 216 /* PHY master/slave setting */ 217 #define EM_MASTER_SLAVE e1000_ms_hw_default 218 219 /* 220 * Micellaneous constants 221 */ 222 #define EM_VENDOR_ID 0x8086 223 #define EM_FLASH 0x0014 224 225 #define EM_JUMBO_PBA 0x00000028 226 #define EM_DEFAULT_PBA 0x00000030 227 #define EM_SMARTSPEED_DOWNSHIFT 3 228 #define EM_SMARTSPEED_MAX 15 229 #define EM_MAX_LOOP 10 230 231 #define MAX_NUM_MULTICAST_ADDRESSES 128 232 #define PCI_ANY_ID (~0U) 233 #define ETHER_ALIGN 2 234 #define EM_FC_PAUSE_TIME 0x0680 235 #define EM_EEPROM_APME 0x400; 236 #define EM_82544_APME 0x0004; 237 238 /* 239 * Driver state logic for the detection of a hung state 240 * in hardware. Set TX_HUNG whenever a TX packet is used 241 * (data is sent) and clear it when txeof() is invoked if 242 * any descriptors from the ring are cleaned/reclaimed. 243 * Increment internal counter if no descriptors are cleaned 244 * and compare to TX_MAXTRIES. When counter > TX_MAXTRIES, 245 * reset adapter. 246 */ 247 #define EM_TX_IDLE 0x00000000 248 #define EM_TX_BUSY 0x00000001 249 #define EM_TX_HUNG 0x80000000 250 #define EM_TX_MAXTRIES 10 251 252 #define PCICFG_DESC_RING_STATUS 0xe4 253 #define FLUSH_DESC_REQUIRED 0x100 254 255 256 #define IGB_RX_PTHRESH ((hw->mac.type == e1000_i354) ? 12 : \ 257 ((hw->mac.type <= e1000_82576) ? 16 : 8)) 258 #define IGB_RX_HTHRESH 8 259 #define IGB_RX_WTHRESH ((hw->mac.type == e1000_82576 && \ 260 (adapter->intr_type == IFLIB_INTR_MSIX)) ? 1 : 4) 261 262 #define IGB_TX_PTHRESH ((hw->mac.type == e1000_i354) ? 20 : 8) 263 #define IGB_TX_HTHRESH 1 264 #define IGB_TX_WTHRESH ((hw->mac.type != e1000_82575 && \ 265 (adapter->intr_type == IFLIB_INTR_MSIX) ? 1 : 16) 266 267 /* 268 * TDBA/RDBA should be aligned on 16 byte boundary. But TDLEN/RDLEN should be 269 * multiple of 128 bytes. So we align TDBA/RDBA on 128 byte boundary. This will 270 * also optimize cache line size effect. H/W supports up to cache line size 128. 271 */ 272 #define EM_DBA_ALIGN 128 273 274 /* 275 * See Intel 82574 Driver Programming Interface Manual, Section 10.2.6.9 276 */ 277 #define TARC_COMPENSATION_MODE (1 << 7) /* Compensation Mode */ 278 #define TARC_SPEED_MODE_BIT (1 << 21) /* On PCI-E MACs only */ 279 #define TARC_MQ_FIX (1 << 23) | \ 280 (1 << 24) | \ 281 (1 << 25) /* Handle errata in MQ mode */ 282 #define TARC_ERRATA_BIT (1 << 26) /* Note from errata on 82574 */ 283 284 /* PCI Config defines */ 285 #define EM_BAR_TYPE(v) ((v) & EM_BAR_TYPE_MASK) 286 #define EM_BAR_TYPE_MASK 0x00000001 287 #define EM_BAR_TYPE_MMEM 0x00000000 288 #define EM_BAR_TYPE_IO 0x00000001 289 #define EM_BAR_TYPE_FLASH 0x0014 290 #define EM_BAR_MEM_TYPE(v) ((v) & EM_BAR_MEM_TYPE_MASK) 291 #define EM_BAR_MEM_TYPE_MASK 0x00000006 292 #define EM_BAR_MEM_TYPE_32BIT 0x00000000 293 #define EM_BAR_MEM_TYPE_64BIT 0x00000004 294 #define EM_MSIX_BAR 3 /* On 82575 */ 295 296 /* More backward compatibility */ 297 #if __FreeBSD_version < 900000 298 #define SYSCTL_ADD_UQUAD SYSCTL_ADD_QUAD 299 #endif 300 301 /* Defines for printing debug information */ 302 #define DEBUG_INIT 0 303 #define DEBUG_IOCTL 0 304 #define DEBUG_HW 0 305 306 #define INIT_DEBUGOUT(S) if (DEBUG_INIT) printf(S "\n") 307 #define INIT_DEBUGOUT1(S, A) if (DEBUG_INIT) printf(S "\n", A) 308 #define INIT_DEBUGOUT2(S, A, B) if (DEBUG_INIT) printf(S "\n", A, B) 309 #define IOCTL_DEBUGOUT(S) if (DEBUG_IOCTL) printf(S "\n") 310 #define IOCTL_DEBUGOUT1(S, A) if (DEBUG_IOCTL) printf(S "\n", A) 311 #define IOCTL_DEBUGOUT2(S, A, B) if (DEBUG_IOCTL) printf(S "\n", A, B) 312 #define HW_DEBUGOUT(S) if (DEBUG_HW) printf(S "\n") 313 #define HW_DEBUGOUT1(S, A) if (DEBUG_HW) printf(S "\n", A) 314 #define HW_DEBUGOUT2(S, A, B) if (DEBUG_HW) printf(S "\n", A, B) 315 316 #define EM_MAX_SCATTER 40 317 #define EM_VFTA_SIZE 128 318 #define EM_TSO_SIZE (65535 + sizeof(struct ether_vlan_header)) 319 #define EM_TSO_SEG_SIZE 4096 /* Max dma segment size */ 320 #define EM_MSIX_MASK 0x01F00000 /* For 82574 use */ 321 #define EM_MSIX_LINK 0x01000000 /* For 82574 use */ 322 #define ETH_ZLEN 60 323 #define ETH_ADDR_LEN 6 324 #define EM_CSUM_OFFLOAD 7 /* Offload bits in mbuf flag */ 325 #define IGB_CSUM_OFFLOAD 0x0E0F /* Offload bits in mbuf flag */ 326 327 #define IGB_PKTTYPE_MASK 0x0000FFF0 328 #define IGB_DMCTLX_DCFLUSH_DIS 0x80000000 /* Disable DMA Coalesce Flush */ 329 330 /* 331 * 82574 has a nonstandard address for EIAC 332 * and since its only used in MSIX, and in 333 * the em driver only 82574 uses MSIX we can 334 * solve it just using this define. 335 */ 336 #define EM_EIAC 0x000DC 337 /* 338 * 82574 only reports 3 MSI-X vectors by default; 339 * defines assisting with making it report 5 are 340 * located here. 341 */ 342 #define EM_NVM_PCIE_CTRL 0x1B 343 #define EM_NVM_MSIX_N_MASK (0x7 << EM_NVM_MSIX_N_SHIFT) 344 #define EM_NVM_MSIX_N_SHIFT 7 345 346 struct adapter; 347 348 struct em_int_delay_info { 349 struct adapter *adapter; /* Back-pointer to the adapter struct */ 350 int offset; /* Register offset to read/write */ 351 int value; /* Current value in usecs */ 352 }; 353 354 /* 355 * The transmit ring, one per tx queue 356 */ 357 struct tx_ring { 358 struct adapter *adapter; 359 struct em_tx_queue *que; 360 u32 me; 361 int busy; 362 struct e1000_tx_desc *tx_base; 363 uint64_t tx_paddr; 364 struct em_txbuffer *tx_buffers; 365 u32 tx_tso; /* last tx was tso */ 366 367 /* Interrupt resources */ 368 void *tag; 369 struct resource *res; 370 unsigned long tx_irq; 371 unsigned long no_desc_avail; 372 373 /* Saved csum offloading context information */ 374 int csum_flags; 375 int csum_lhlen; 376 int csum_iphlen; 377 378 int csum_thlen; 379 int csum_mss; 380 int csum_pktlen; 381 382 uint32_t csum_txd_upper; 383 uint32_t csum_txd_lower; /* last field */ 384 }; 385 386 /* 387 * The Receive ring, one per rx queue 388 */ 389 struct rx_ring { 390 struct adapter *adapter; 391 struct em_rx_queue *que; 392 u32 me; 393 u32 payload; 394 union e1000_rx_desc_extended *rx_base; 395 uint64_t rx_paddr; 396 397 /* Interrupt resources */ 398 void *tag; 399 struct resource *res; 400 bool discard; 401 402 /* Soft stats */ 403 unsigned long rx_irq; 404 unsigned long rx_discarded; 405 unsigned long rx_packets; 406 unsigned long rx_bytes; 407 }; 408 409 struct em_tx_queue { 410 struct adapter *adapter; 411 u32 msix; 412 u32 eims; /* This queue's EIMS bit */ 413 u32 me; 414 struct tx_ring txr; 415 }; 416 417 struct em_rx_queue { 418 struct adapter *adapter; 419 u32 me; 420 u32 msix; 421 u32 eims; 422 struct rx_ring rxr; 423 u64 irqs; 424 struct if_irq que_irq; 425 }; 426 427 /* Our adapter structure */ 428 struct adapter { 429 struct ifnet *ifp; 430 struct e1000_hw hw; 431 432 if_softc_ctx_t shared; 433 if_ctx_t ctx; 434 #define tx_num_queues shared->isc_ntxqsets 435 #define rx_num_queues shared->isc_nrxqsets 436 #define intr_type shared->isc_intr 437 /* FreeBSD operating-system-specific structures. */ 438 struct e1000_osdep osdep; 439 device_t dev; 440 struct cdev *led_dev; 441 442 struct em_tx_queue *tx_queues; 443 struct em_rx_queue *rx_queues; 444 struct if_irq irq; 445 446 struct resource *memory; 447 struct resource *flash; 448 struct resource *ioport; 449 int io_rid; 450 451 struct resource *res; 452 void *tag; 453 u32 linkvec; 454 u32 ivars; 455 456 struct ifmedia *media; 457 int msix; 458 int if_flags; 459 int min_frame_size; 460 int em_insert_vlan_header; 461 u32 ims; 462 bool in_detach; 463 464 /* Task for FAST handling */ 465 struct grouptask link_task; 466 467 u16 num_vlans; 468 u32 txd_cmd; 469 470 u32 tx_process_limit; 471 u32 rx_process_limit; 472 u32 rx_mbuf_sz; 473 474 /* Management and WOL features */ 475 u32 wol; 476 bool has_manage; 477 bool has_amt; 478 479 /* Multicast array memory */ 480 u8 *mta; 481 482 /* 483 ** Shadow VFTA table, this is needed because 484 ** the real vlan filter table gets cleared during 485 ** a soft reset and the driver needs to be able 486 ** to repopulate it. 487 */ 488 u32 shadow_vfta[EM_VFTA_SIZE]; 489 490 /* Info about the interface */ 491 u16 link_active; 492 u16 fc; 493 u16 link_speed; 494 u16 link_duplex; 495 u32 smartspeed; 496 u32 dmac; 497 int link_mask; 498 499 u64 que_mask; 500 501 502 struct em_int_delay_info tx_int_delay; 503 struct em_int_delay_info tx_abs_int_delay; 504 struct em_int_delay_info rx_int_delay; 505 struct em_int_delay_info rx_abs_int_delay; 506 struct em_int_delay_info tx_itr; 507 508 /* Misc stats maintained by the driver */ 509 unsigned long dropped_pkts; 510 unsigned long link_irq; 511 unsigned long mbuf_defrag_failed; 512 unsigned long no_tx_dma_setup; 513 unsigned long no_tx_map_avail; 514 unsigned long rx_overruns; 515 unsigned long watchdog_events; 516 517 struct e1000_hw_stats stats; 518 }; 519 520 /******************************************************************************** 521 * vendor_info_array 522 * 523 * This array contains the list of Subvendor/Subdevice IDs on which the driver 524 * should load. 525 * 526 ********************************************************************************/ 527 typedef struct _em_vendor_info_t { 528 unsigned int vendor_id; 529 unsigned int device_id; 530 unsigned int subvendor_id; 531 unsigned int subdevice_id; 532 unsigned int index; 533 } em_vendor_info_t; 534 535 struct em_txbuffer { 536 int eop; 537 }; 538 539 540 #define EM_CORE_LOCK_INIT(_sc, _name) \ 541 mtx_init(&(_sc)->core_mtx, _name, "EM Core Lock", MTX_DEF) 542 #define EM_TX_LOCK_INIT(_sc, _name) \ 543 mtx_init(&(_sc)->tx_mtx, _name, "EM TX Lock", MTX_DEF) 544 #define EM_RX_LOCK_INIT(_sc, _name) \ 545 mtx_init(&(_sc)->rx_mtx, _name, "EM RX Lock", MTX_DEF) 546 #define EM_CORE_LOCK_DESTROY(_sc) mtx_destroy(&(_sc)->core_mtx) 547 #define EM_TX_LOCK_DESTROY(_sc) mtx_destroy(&(_sc)->tx_mtx) 548 #define EM_RX_LOCK_DESTROY(_sc) mtx_destroy(&(_sc)->rx_mtx) 549 #define EM_CORE_LOCK(_sc) mtx_lock(&(_sc)->core_mtx) 550 #define EM_TX_LOCK(_sc) mtx_lock(&(_sc)->tx_mtx) 551 #define EM_TX_TRYLOCK(_sc) mtx_trylock(&(_sc)->tx_mtx) 552 #define EM_RX_LOCK(_sc) mtx_lock(&(_sc)->rx_mtx) 553 #define EM_CORE_UNLOCK(_sc) mtx_unlock(&(_sc)->core_mtx) 554 #define EM_TX_UNLOCK(_sc) mtx_unlock(&(_sc)->tx_mtx) 555 #define EM_RX_UNLOCK(_sc) mtx_unlock(&(_sc)->rx_mtx) 556 #define EM_CORE_LOCK_ASSERT(_sc) mtx_assert(&(_sc)->core_mtx, MA_OWNED) 557 #define EM_TX_LOCK_ASSERT(_sc) mtx_assert(&(_sc)->tx_mtx, MA_OWNED) 558 #define EM_RX_LOCK_ASSERT(_sc) mtx_assert(&(_sc)->rx_mtx, MA_OWNED) 559 560 #define EM_RSSRK_SIZE 4 561 #define EM_RSSRK_VAL(key, i) (key[(i) * EM_RSSRK_SIZE] | \ 562 key[(i) * EM_RSSRK_SIZE + 1] << 8 | \ 563 key[(i) * EM_RSSRK_SIZE + 2] << 16 | \ 564 key[(i) * EM_RSSRK_SIZE + 3] << 24) 565 #endif /* _EM_H_DEFINED_ */ 566