1 /* SPDX-License-Identifier: BSD-3-Clause */ 2 /* Copyright (c) 2021, Intel Corporation 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 are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright notice, 9 * this list of conditions and the following disclaimer. 10 * 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 * 3. Neither the name of the Intel Corporation nor the names of its 16 * contributors may be used to endorse or promote products derived from 17 * this software without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 20 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 23 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 * POSSIBILITY OF SUCH DAMAGE. 30 */ 31 /*$FreeBSD$*/ 32 33 /** 34 * @file ice_lib.h 35 * @brief header for generic device and sysctl functions 36 * 37 * Contains definitions and function declarations for the ice_lib.c file. It 38 * does not depend on the iflib networking stack. 39 */ 40 41 #ifndef _ICE_LIB_H_ 42 #define _ICE_LIB_H_ 43 44 #include <sys/types.h> 45 #include <sys/bus.h> 46 #include <sys/rman.h> 47 #include <sys/socket.h> 48 #include <sys/sbuf.h> 49 #include <sys/sysctl.h> 50 #include <sys/syslog.h> 51 #include <sys/module.h> 52 #include <sys/proc.h> 53 54 #include <net/if.h> 55 #include <net/if_var.h> 56 #include <net/if_media.h> 57 #include <net/ethernet.h> 58 59 #include <sys/bitstring.h> 60 61 #include "ice_dcb.h" 62 #include "ice_type.h" 63 #include "ice_common.h" 64 #include "ice_flow.h" 65 #include "ice_sched.h" 66 #include "ice_resmgr.h" 67 68 #include "ice_rdma_internal.h" 69 70 #include "ice_rss.h" 71 72 /* Hide debug sysctls unless INVARIANTS is enabled */ 73 #ifdef INVARIANTS 74 #define ICE_CTLFLAG_DEBUG 0 75 #else 76 #define ICE_CTLFLAG_DEBUG CTLFLAG_SKIP 77 #endif 78 79 /** 80 * for_each_set_bit - For loop over each set bit in a bit string 81 * @bit: storage for the bit index 82 * @data: address of data block to loop over 83 * @nbits: maximum number of bits to loop over 84 * 85 * macro to create a for loop over a bit string, which runs the body once for 86 * each bit that is set in the string. The bit variable will be set to the 87 * index of each set bit in the string, with zero representing the first bit. 88 */ 89 #define for_each_set_bit(bit, data, nbits) \ 90 for (bit_ffs((bitstr_t *)(data), (nbits), &(bit)); \ 91 (bit) != -1; \ 92 bit_ffs_at((bitstr_t *)(data), (bit) + 1, (nbits), &(bit))) 93 94 /** 95 * @var broadcastaddr 96 * @brief broadcast MAC address 97 * 98 * constant defining the broadcast MAC address, used for programming the 99 * broadcast address as a MAC filter for the PF VSI. 100 */ 101 static const u8 broadcastaddr[ETHER_ADDR_LEN] = { 102 0xff, 0xff, 0xff, 0xff, 0xff, 0xff 103 }; 104 105 MALLOC_DECLARE(M_ICE); 106 107 extern const char ice_driver_version[]; 108 extern const uint8_t ice_major_version; 109 extern const uint8_t ice_minor_version; 110 extern const uint8_t ice_patch_version; 111 extern const uint8_t ice_rc_version; 112 113 /* global sysctl indicating whether the Tx FC filter should be enabled */ 114 extern bool ice_enable_tx_fc_filter; 115 116 /* global sysctl indicating whether the Tx LLDP filter should be enabled */ 117 extern bool ice_enable_tx_lldp_filter; 118 119 /* global sysctl indicating whether FW health status events should be enabled */ 120 extern bool ice_enable_health_events; 121 122 /** 123 * @struct ice_bar_info 124 * @brief PCI BAR mapping information 125 * 126 * Contains data about a PCI BAR that the driver has mapped for use. 127 */ 128 struct ice_bar_info { 129 struct resource *res; 130 bus_space_tag_t tag; 131 bus_space_handle_t handle; 132 bus_size_t size; 133 int rid; 134 }; 135 136 /* Alignment for queues */ 137 #define DBA_ALIGN 128 138 139 /* Maximum TSO size is (256K)-1 */ 140 #define ICE_TSO_SIZE ((256*1024) - 1) 141 142 /* Minimum size for TSO MSS */ 143 #define ICE_MIN_TSO_MSS 64 144 145 #define ICE_MAX_TX_SEGS 8 146 #define ICE_MAX_TSO_SEGS 128 147 148 #define ICE_MAX_DMA_SEG_SIZE ((16*1024) - 1) 149 150 #define ICE_MAX_RX_SEGS 5 151 152 #define ICE_MAX_TSO_HDR_SEGS 3 153 154 #define ICE_MSIX_BAR 3 155 156 #define ICE_MAX_DCB_TCS 8 157 158 #define ICE_DEFAULT_DESC_COUNT 1024 159 #define ICE_MAX_DESC_COUNT 8160 160 #define ICE_MIN_DESC_COUNT 64 161 #define ICE_DESC_COUNT_INCR 32 162 163 /* List of hardware offloads we support */ 164 #define ICE_CSUM_OFFLOAD (CSUM_IP | CSUM_IP_TCP | CSUM_IP_UDP | CSUM_IP_SCTP | \ 165 CSUM_IP6_TCP| CSUM_IP6_UDP | CSUM_IP6_SCTP | \ 166 CSUM_IP_TSO | CSUM_IP6_TSO) 167 168 /* Macros to decide what kind of hardware offload to enable */ 169 #define ICE_CSUM_TCP (CSUM_IP_TCP|CSUM_IP_TSO|CSUM_IP6_TSO|CSUM_IP6_TCP) 170 #define ICE_CSUM_UDP (CSUM_IP_UDP|CSUM_IP6_UDP) 171 #define ICE_CSUM_SCTP (CSUM_IP_SCTP|CSUM_IP6_SCTP) 172 #define ICE_CSUM_IP (CSUM_IP|CSUM_IP_TSO) 173 174 /* List of known RX CSUM offload flags */ 175 #define ICE_RX_CSUM_FLAGS (CSUM_L3_CALC | CSUM_L3_VALID | CSUM_L4_CALC | \ 176 CSUM_L4_VALID | CSUM_L5_CALC | CSUM_L5_VALID | \ 177 CSUM_COALESCED) 178 179 /* List of interface capabilities supported by ice hardware */ 180 #define ICE_FULL_CAPS \ 181 (IFCAP_TSO4 | IFCAP_TSO6 | \ 182 IFCAP_TXCSUM | IFCAP_TXCSUM_IPV6 | \ 183 IFCAP_RXCSUM | IFCAP_RXCSUM_IPV6 | \ 184 IFCAP_VLAN_HWFILTER | IFCAP_VLAN_HWTSO | \ 185 IFCAP_VLAN_HWTAGGING | IFCAP_VLAN_HWCSUM | IFCAP_VLAN_HWTSO | \ 186 IFCAP_VLAN_MTU | IFCAP_JUMBO_MTU | IFCAP_LRO) 187 188 /* Safe mode disables support for hardware checksums and TSO */ 189 #define ICE_SAFE_CAPS \ 190 (ICE_FULL_CAPS & ~(IFCAP_HWCSUM | IFCAP_TSO | \ 191 IFCAP_VLAN_HWTSO | IFCAP_VLAN_HWCSUM)) 192 193 #define ICE_CAPS(sc) \ 194 (ice_is_bit_set(sc->feat_en, ICE_FEATURE_SAFE_MODE) ? ICE_SAFE_CAPS : ICE_FULL_CAPS) 195 196 /** 197 * ICE_NVM_ACCESS 198 * @brief Private ioctl command number for NVM access ioctls 199 * 200 * The ioctl command number used by NVM update for accessing the driver for 201 * NVM access commands. 202 */ 203 #define ICE_NVM_ACCESS \ 204 (((((((('E' << 4) + '1') << 4) + 'K') << 4) + 'G') << 4) | 5) 205 206 #define ICE_AQ_LEN 1023 207 #define ICE_MBXQ_LEN 512 208 #define ICE_SBQ_LEN 512 209 210 #define ICE_CTRLQ_WORK_LIMIT 256 211 212 #define ICE_DFLT_TRAFFIC_CLASS BIT(0) 213 214 /* wait up to 50 microseconds for queue state change */ 215 #define ICE_Q_WAIT_RETRY_LIMIT 5 216 217 #define ICE_UP_TABLE_TRANSLATE(val, i) \ 218 (((val) << ICE_AQ_VSI_UP_TABLE_UP##i##_S) & \ 219 ICE_AQ_VSI_UP_TABLE_UP##i##_M) 220 221 /* 222 * For now, set this to the hardware maximum. Each function gets a smaller 223 * number assigned to it in hw->func_caps.guar_num_vsi, though there 224 * appears to be no guarantee that is the maximum number that a function 225 * can use. 226 */ 227 #define ICE_MAX_VSI_AVAILABLE 768 228 229 /* Maximum size of a single frame (for Tx and Rx) */ 230 #define ICE_MAX_FRAME_SIZE ICE_AQ_SET_MAC_FRAME_SIZE_MAX 231 232 /* Maximum MTU size */ 233 #define ICE_MAX_MTU (ICE_MAX_FRAME_SIZE - \ 234 ETHER_HDR_LEN - ETHER_CRC_LEN - ETHER_VLAN_ENCAP_LEN) 235 236 /* 237 * Hardware requires that TSO packets have an segment size of at least 64 238 * bytes. To avoid sending bad frames to the hardware, the driver forces the 239 * MSS for all TSO packets to have a segment size of at least 64 bytes. 240 * 241 * However, if the MTU is reduced below a certain size, then the resulting 242 * larger MSS can result in transmitting segmented frames with a packet size 243 * larger than the MTU. 244 * 245 * Avoid this by preventing the MTU from being lowered below this limit. 246 * Alternative solutions require changing the TCP stack to disable offloading 247 * the segmentation when the requested segment size goes below 64 bytes. 248 */ 249 #define ICE_MIN_MTU 112 250 251 #define ICE_DEFAULT_VF_QUEUES 4 252 253 /* 254 * The maximum number of RX queues allowed per TC in a VSI. 255 */ 256 #define ICE_MAX_RXQS_PER_TC 256 257 258 /* 259 * There are three settings that can be updated independently or 260 * altogether: Link speed, FEC, and Flow Control. These macros allow 261 * the caller to specify which setting(s) to update. 262 */ 263 #define ICE_APPLY_LS BIT(0) 264 #define ICE_APPLY_FEC BIT(1) 265 #define ICE_APPLY_FC BIT(2) 266 #define ICE_APPLY_LS_FEC (ICE_APPLY_LS | ICE_APPLY_FEC) 267 #define ICE_APPLY_LS_FC (ICE_APPLY_LS | ICE_APPLY_FC) 268 #define ICE_APPLY_FEC_FC (ICE_APPLY_FEC | ICE_APPLY_FC) 269 #define ICE_APPLY_LS_FEC_FC (ICE_APPLY_LS_FEC | ICE_APPLY_FC) 270 271 /** 272 * @enum ice_dyn_idx_t 273 * @brief Dynamic Control ITR indexes 274 * 275 * This enum matches hardware bits and is meant to be used by DYN_CTLN 276 * registers and QINT registers or more generally anywhere in the manual 277 * mentioning ITR_INDX, ITR_NONE cannot be used as an index 'n' into any 278 * register but instead is a special value meaning "don't update" ITR0/1/2. 279 */ 280 enum ice_dyn_idx_t { 281 ICE_IDX_ITR0 = 0, 282 ICE_IDX_ITR1 = 1, 283 ICE_IDX_ITR2 = 2, 284 ICE_ITR_NONE = 3 /* ITR_NONE must not be used as an index */ 285 }; 286 287 /* By convenction ITR0 is used for RX, and ITR1 is used for TX */ 288 #define ICE_RX_ITR ICE_IDX_ITR0 289 #define ICE_TX_ITR ICE_IDX_ITR1 290 291 #define ICE_ITR_MAX 8160 292 293 /* Define the default Tx and Rx ITR as 50us (translates to ~20k int/sec max) */ 294 #define ICE_DFLT_TX_ITR 50 295 #define ICE_DFLT_RX_ITR 50 296 297 /** 298 * ice_itr_to_reg - Convert an ITR setting into its register equivalent 299 * @hw: The device HW structure 300 * @itr_setting: the ITR setting to convert 301 * 302 * Based on the hardware ITR granularity, convert an ITR setting into the 303 * correct value to prepare programming to the HW. 304 */ 305 static inline u16 ice_itr_to_reg(struct ice_hw *hw, u16 itr_setting) 306 { 307 return itr_setting / hw->itr_gran; 308 } 309 310 /** 311 * @enum ice_rx_dtype 312 * @brief DTYPE header split options 313 * 314 * This enum matches the Rx context bits to define whether header split is 315 * enabled or not. 316 */ 317 enum ice_rx_dtype { 318 ICE_RX_DTYPE_NO_SPLIT = 0, 319 ICE_RX_DTYPE_HEADER_SPLIT = 1, 320 ICE_RX_DTYPE_SPLIT_ALWAYS = 2, 321 }; 322 323 /* Strings used for displaying FEC mode 324 * 325 * Use ice_fec_str() to get these unless these need to be embedded in a 326 * string constant. 327 */ 328 #define ICE_FEC_STRING_AUTO "Auto" 329 #define ICE_FEC_STRING_RS "RS-FEC" 330 #define ICE_FEC_STRING_BASER "FC-FEC/BASE-R" 331 #define ICE_FEC_STRING_NONE "None" 332 333 /* Strings used for displaying Flow Control mode 334 * 335 * Use ice_fc_str() to get these unless these need to be embedded in a 336 * string constant. 337 */ 338 #define ICE_FC_STRING_FULL "Full" 339 #define ICE_FC_STRING_TX "Tx" 340 #define ICE_FC_STRING_RX "Rx" 341 #define ICE_FC_STRING_NONE "None" 342 343 /* 344 * The number of times the ice_handle_i2c_req function will retry reading 345 * I2C data via the Admin Queue before returning EBUSY. 346 */ 347 #define ICE_I2C_MAX_RETRIES 10 348 349 /* 350 * The Start LLDP Agent AQ command will fail if it's sent too soon after 351 * the LLDP agent is stopped. The period between the stop and start 352 * commands must currently be at least 2 seconds. 353 */ 354 #define ICE_START_LLDP_RETRY_WAIT (2 * hz) 355 356 /* 357 * The ice_(set|clear)_vsi_promisc() function expects a mask of promiscuous 358 * modes to operate on. This mask is the default one for the driver, where 359 * promiscuous is enabled/disabled for all types of non-VLAN-tagged/VLAN 0 360 * traffic. 361 */ 362 #define ICE_VSI_PROMISC_MASK (ICE_PROMISC_UCAST_TX | \ 363 ICE_PROMISC_UCAST_RX | \ 364 ICE_PROMISC_MCAST_TX | \ 365 ICE_PROMISC_MCAST_RX) 366 367 struct ice_softc; 368 369 /** 370 * @enum ice_rx_cso_stat 371 * @brief software checksum offload statistics 372 * 373 * Enumeration of possible checksum offload statistics captured by software 374 * during the Rx path. 375 */ 376 enum ice_rx_cso_stat { 377 ICE_CSO_STAT_RX_IP4_ERR, 378 ICE_CSO_STAT_RX_IP6_ERR, 379 ICE_CSO_STAT_RX_L3_ERR, 380 ICE_CSO_STAT_RX_TCP_ERR, 381 ICE_CSO_STAT_RX_UDP_ERR, 382 ICE_CSO_STAT_RX_SCTP_ERR, 383 ICE_CSO_STAT_RX_L4_ERR, 384 ICE_CSO_STAT_RX_COUNT 385 }; 386 387 /** 388 * @enum ice_tx_cso_stat 389 * @brief software checksum offload statistics 390 * 391 * Enumeration of possible checksum offload statistics captured by software 392 * during the Tx path. 393 */ 394 enum ice_tx_cso_stat { 395 ICE_CSO_STAT_TX_TCP, 396 ICE_CSO_STAT_TX_UDP, 397 ICE_CSO_STAT_TX_SCTP, 398 ICE_CSO_STAT_TX_IP4, 399 ICE_CSO_STAT_TX_IP6, 400 ICE_CSO_STAT_TX_L3_ERR, 401 ICE_CSO_STAT_TX_L4_ERR, 402 ICE_CSO_STAT_TX_COUNT 403 }; 404 405 /** 406 * @struct tx_stats 407 * @brief software Tx statistics 408 * 409 * Contains software counted Tx statistics for a single queue 410 */ 411 struct tx_stats { 412 /* Soft Stats */ 413 u64 tx_bytes; 414 u64 tx_packets; 415 u64 mss_too_small; 416 u64 cso[ICE_CSO_STAT_TX_COUNT]; 417 }; 418 419 /** 420 * @struct rx_stats 421 * @brief software Rx statistics 422 * 423 * Contains software counted Rx statistics for a single queue 424 */ 425 struct rx_stats { 426 /* Soft Stats */ 427 u64 rx_packets; 428 u64 rx_bytes; 429 u64 desc_errs; 430 u64 cso[ICE_CSO_STAT_RX_COUNT]; 431 }; 432 433 /** 434 * @struct ice_vsi_hw_stats 435 * @brief hardware statistics for a VSI 436 * 437 * Stores statistics that are generated by hardware for a VSI. 438 */ 439 struct ice_vsi_hw_stats { 440 struct ice_eth_stats prev; 441 struct ice_eth_stats cur; 442 bool offsets_loaded; 443 }; 444 445 /** 446 * @struct ice_pf_hw_stats 447 * @brief hardware statistics for a PF 448 * 449 * Stores statistics that are generated by hardware for each PF. 450 */ 451 struct ice_pf_hw_stats { 452 struct ice_hw_port_stats prev; 453 struct ice_hw_port_stats cur; 454 bool offsets_loaded; 455 }; 456 457 /** 458 * @struct ice_pf_sw_stats 459 * @brief software statistics for a PF 460 * 461 * Contains software generated statistics relevant to a PF. 462 */ 463 struct ice_pf_sw_stats { 464 /* # of reset events handled, by type */ 465 u32 corer_count; 466 u32 globr_count; 467 u32 empr_count; 468 u32 pfr_count; 469 470 /* # of detected MDD events for Tx and Rx */ 471 u32 tx_mdd_count; 472 u32 rx_mdd_count; 473 }; 474 475 /** 476 * @struct ice_tc_info 477 * @brief Traffic class information for a VSI 478 * 479 * Stores traffic class information used in configuring 480 * a VSI. 481 */ 482 struct ice_tc_info { 483 u16 qoffset; /* Offset in VSI queue space */ 484 u16 qcount_tx; /* TX queues for this Traffic Class */ 485 u16 qcount_rx; /* RX queues */ 486 }; 487 488 /** 489 * @struct ice_vsi 490 * @brief VSI structure 491 * 492 * Contains data relevant to a single VSI 493 */ 494 struct ice_vsi { 495 /* back pointer to the softc */ 496 struct ice_softc *sc; 497 498 bool dynamic; /* if true, dynamically allocated */ 499 500 enum ice_vsi_type type; /* type of this VSI */ 501 u16 idx; /* software index to sc->all_vsi[] */ 502 503 u16 *tx_qmap; /* Tx VSI to PF queue mapping */ 504 u16 *rx_qmap; /* Rx VSI to PF queue mapping */ 505 506 bitstr_t *vmap; /* Vector(s) assigned to VSI */ 507 508 enum ice_resmgr_alloc_type qmap_type; 509 510 struct ice_tx_queue *tx_queues; /* Tx queue array */ 511 struct ice_rx_queue *rx_queues; /* Rx queue array */ 512 513 int num_tx_queues; 514 int num_rx_queues; 515 int num_vectors; 516 517 int16_t rx_itr; 518 int16_t tx_itr; 519 520 /* RSS configuration */ 521 u16 rss_table_size; /* HW RSS table size */ 522 u8 rss_lut_type; /* Used to configure Get/Set RSS LUT AQ call */ 523 524 int max_frame_size; 525 u16 mbuf_sz; 526 527 struct ice_aqc_vsi_props info; 528 529 /* DCB configuration */ 530 u8 num_tcs; /* Total number of enabled TCs */ 531 u16 tc_map; /* bitmap of enabled Traffic Classes */ 532 /* Information for each traffic class */ 533 struct ice_tc_info tc_info[ICE_MAX_TRAFFIC_CLASS]; 534 535 /* context for per-VSI sysctls */ 536 struct sysctl_ctx_list ctx; 537 struct sysctl_oid *vsi_node; 538 539 /* context for per-txq sysctls */ 540 struct sysctl_ctx_list txqs_ctx; 541 struct sysctl_oid *txqs_node; 542 543 /* context for per-rxq sysctls */ 544 struct sysctl_ctx_list rxqs_ctx; 545 struct sysctl_oid *rxqs_node; 546 547 /* VSI-level stats */ 548 struct ice_vsi_hw_stats hw_stats; 549 }; 550 551 /** 552 * @enum ice_state 553 * @brief Driver state flags 554 * 555 * Used to indicate the status of various driver events. Intended to be 556 * modified only using atomic operations, so that we can use it even in places 557 * which aren't locked. 558 */ 559 enum ice_state { 560 ICE_STATE_CONTROLQ_EVENT_PENDING, 561 ICE_STATE_VFLR_PENDING, 562 ICE_STATE_MDD_PENDING, 563 ICE_STATE_RESET_OICR_RECV, 564 ICE_STATE_RESET_PFR_REQ, 565 ICE_STATE_PREPARED_FOR_RESET, 566 ICE_STATE_RESET_FAILED, 567 ICE_STATE_DRIVER_INITIALIZED, 568 ICE_STATE_NO_MEDIA, 569 ICE_STATE_RECOVERY_MODE, 570 ICE_STATE_ROLLBACK_MODE, 571 ICE_STATE_LINK_STATUS_REPORTED, 572 ICE_STATE_ATTACHING, 573 ICE_STATE_DETACHING, 574 ICE_STATE_LINK_DEFAULT_OVERRIDE_PENDING, 575 ICE_STATE_LLDP_RX_FLTR_FROM_DRIVER, 576 ICE_STATE_MULTIPLE_TCS, 577 /* This entry must be last */ 578 ICE_STATE_LAST, 579 }; 580 581 /* Functions for setting and checking driver state. Note the functions take 582 * bit positions, not bitmasks. The atomic_testandset_32 and 583 * atomic_testandclear_32 operations require bit positions, while the 584 * atomic_set_32 and atomic_clear_32 require bitmasks. This can easily lead to 585 * programming error, so we provide wrapper functions to avoid this. 586 */ 587 588 /** 589 * ice_set_state - Set the specified state 590 * @s: the state bitmap 591 * @bit: the state to set 592 * 593 * Atomically update the state bitmap with the specified bit set. 594 */ 595 static inline void 596 ice_set_state(volatile u32 *s, enum ice_state bit) 597 { 598 /* atomic_set_32 expects a bitmask */ 599 atomic_set_32(s, BIT(bit)); 600 } 601 602 /** 603 * ice_clear_state - Clear the specified state 604 * @s: the state bitmap 605 * @bit: the state to clear 606 * 607 * Atomically update the state bitmap with the specified bit cleared. 608 */ 609 static inline void 610 ice_clear_state(volatile u32 *s, enum ice_state bit) 611 { 612 /* atomic_clear_32 expects a bitmask */ 613 atomic_clear_32(s, BIT(bit)); 614 } 615 616 /** 617 * ice_testandset_state - Test and set the specified state 618 * @s: the state bitmap 619 * @bit: the bit to test 620 * 621 * Atomically update the state bitmap, setting the specified bit. Returns the 622 * previous value of the bit. 623 */ 624 static inline u32 625 ice_testandset_state(volatile u32 *s, enum ice_state bit) 626 { 627 /* atomic_testandset_32 expects a bit position */ 628 return atomic_testandset_32(s, bit); 629 } 630 631 /** 632 * ice_testandclear_state - Test and clear the specified state 633 * @s: the state bitmap 634 * @bit: the bit to test 635 * 636 * Atomically update the state bitmap, clearing the specified bit. Returns the 637 * previous value of the bit. 638 */ 639 static inline u32 640 ice_testandclear_state(volatile u32 *s, enum ice_state bit) 641 { 642 /* atomic_testandclear_32 expects a bit position */ 643 return atomic_testandclear_32(s, bit); 644 } 645 646 /** 647 * ice_test_state - Test the specified state 648 * @s: the state bitmap 649 * @bit: the bit to test 650 * 651 * Return true if the state is set, false otherwise. Use this only if the flow 652 * does not need to update the state. If you must update the state as well, 653 * prefer ice_testandset_state or ice_testandclear_state. 654 */ 655 static inline u32 656 ice_test_state(volatile u32 *s, enum ice_state bit) 657 { 658 return (*s & BIT(bit)) ? true : false; 659 } 660 661 /** 662 * @struct ice_str_buf 663 * @brief static length buffer for string returning 664 * 665 * Structure containing a fixed size string buffer, used to implement 666 * numeric->string conversion functions that may want to return non-constant 667 * strings. 668 * 669 * This allows returning a fixed size string that is generated by a conversion 670 * function, and then copied to the used location without needing to use an 671 * explicit local variable passed by reference. 672 */ 673 struct ice_str_buf { 674 char str[ICE_STR_BUF_LEN]; 675 }; 676 677 struct ice_str_buf _ice_aq_str(enum ice_aq_err aq_err); 678 struct ice_str_buf _ice_status_str(enum ice_status status); 679 struct ice_str_buf _ice_err_str(int err); 680 struct ice_str_buf _ice_fltr_flag_str(u16 flag); 681 struct ice_str_buf _ice_log_sev_str(u8 log_level); 682 struct ice_str_buf _ice_mdd_tx_tclan_str(u8 event); 683 struct ice_str_buf _ice_mdd_tx_pqm_str(u8 event); 684 struct ice_str_buf _ice_mdd_rx_str(u8 event); 685 struct ice_str_buf _ice_fw_lldp_status(u32 lldp_status); 686 687 #define ice_aq_str(err) _ice_aq_str(err).str 688 #define ice_status_str(err) _ice_status_str(err).str 689 #define ice_err_str(err) _ice_err_str(err).str 690 #define ice_fltr_flag_str(flag) _ice_fltr_flag_str(flag).str 691 692 #define ice_mdd_tx_tclan_str(event) _ice_mdd_tx_tclan_str(event).str 693 #define ice_mdd_tx_pqm_str(event) _ice_mdd_tx_pqm_str(event).str 694 #define ice_mdd_rx_str(event) _ice_mdd_rx_str(event).str 695 696 #define ice_log_sev_str(log_level) _ice_log_sev_str(log_level).str 697 #define ice_fw_lldp_status(lldp_status) _ice_fw_lldp_status(lldp_status).str 698 699 /** 700 * ice_enable_intr - Enable interrupts for given vector 701 * @hw: the device private HW structure 702 * @vector: the interrupt index in PF space 703 * 704 * In MSI or Legacy interrupt mode, interrupt 0 is the only valid index. 705 */ 706 static inline void 707 ice_enable_intr(struct ice_hw *hw, int vector) 708 { 709 u32 dyn_ctl; 710 711 /* Use ITR_NONE so that ITR configuration is not changed. */ 712 dyn_ctl = GLINT_DYN_CTL_INTENA_M | GLINT_DYN_CTL_CLEARPBA_M | 713 (ICE_ITR_NONE << GLINT_DYN_CTL_ITR_INDX_S); 714 wr32(hw, GLINT_DYN_CTL(vector), dyn_ctl); 715 } 716 717 /** 718 * ice_disable_intr - Disable interrupts for given vector 719 * @hw: the device private HW structure 720 * @vector: the interrupt index in PF space 721 * 722 * In MSI or Legacy interrupt mode, interrupt 0 is the only valid index. 723 */ 724 static inline void 725 ice_disable_intr(struct ice_hw *hw, int vector) 726 { 727 u32 dyn_ctl; 728 729 /* Use ITR_NONE so that ITR configuration is not changed. */ 730 dyn_ctl = ICE_ITR_NONE << GLINT_DYN_CTL_ITR_INDX_S; 731 wr32(hw, GLINT_DYN_CTL(vector), dyn_ctl); 732 } 733 734 /** 735 * ice_is_tx_desc_done - determine if a Tx descriptor is done 736 * @txd: the Tx descriptor to check 737 * 738 * Returns true if hardware is done with a Tx descriptor and software is 739 * capable of re-using it. 740 */ 741 static inline bool 742 ice_is_tx_desc_done(struct ice_tx_desc *txd) 743 { 744 return (((txd->cmd_type_offset_bsz & ICE_TXD_QW1_DTYPE_M) 745 >> ICE_TXD_QW1_DTYPE_S) == ICE_TX_DESC_DTYPE_DESC_DONE); 746 } 747 748 /** 749 * ice_get_pf_id - Get the PF id from the hardware registers 750 * @hw: the ice hardware structure 751 * 752 * Reads the PF_FUNC_RID register and extracts the function number from it. 753 * Intended to be used in cases where hw->pf_id hasn't yet been assigned by 754 * ice_init_hw. 755 * 756 * @pre this function should be called only after PCI register access has been 757 * setup, and prior to ice_init_hw. After hardware has been initialized, the 758 * cached hw->pf_id value can be used. 759 */ 760 static inline u8 761 ice_get_pf_id(struct ice_hw *hw) 762 { 763 return (u8)((rd32(hw, PF_FUNC_RID) & PF_FUNC_RID_FUNCTION_NUMBER_M) >> 764 PF_FUNC_RID_FUNCTION_NUMBER_S); 765 } 766 767 /* Details of how to re-initialize depend on the networking stack */ 768 void ice_request_stack_reinit(struct ice_softc *sc); 769 770 /* Details of how to check if the network stack is detaching us */ 771 bool ice_driver_is_detaching(struct ice_softc *sc); 772 773 const char * ice_fw_module_str(enum ice_aqc_fw_logging_mod module); 774 void ice_add_fw_logging_tunables(struct ice_softc *sc, 775 struct sysctl_oid *parent); 776 void ice_handle_fw_log_event(struct ice_softc *sc, struct ice_aq_desc *desc, 777 void *buf); 778 779 int ice_process_ctrlq(struct ice_softc *sc, enum ice_ctl_q q_type, u16 *pending); 780 int ice_map_bar(device_t dev, struct ice_bar_info *bar, int bar_num); 781 void ice_free_bar(device_t dev, struct ice_bar_info *bar); 782 void ice_set_ctrlq_len(struct ice_hw *hw); 783 void ice_release_vsi(struct ice_vsi *vsi); 784 struct ice_vsi *ice_alloc_vsi(struct ice_softc *sc, enum ice_vsi_type type); 785 int ice_alloc_vsi_qmap(struct ice_vsi *vsi, const int max_tx_queues, 786 const int max_rx_queues); 787 void ice_free_vsi_qmaps(struct ice_vsi *vsi); 788 int ice_initialize_vsi(struct ice_vsi *vsi); 789 void ice_deinit_vsi(struct ice_vsi *vsi); 790 uint64_t ice_aq_speed_to_rate(struct ice_port_info *pi); 791 int ice_get_phy_type_low(uint64_t phy_type_low); 792 int ice_get_phy_type_high(uint64_t phy_type_high); 793 enum ice_status ice_add_media_types(struct ice_softc *sc, struct ifmedia *media); 794 void ice_configure_rxq_interrupts(struct ice_vsi *vsi); 795 void ice_configure_txq_interrupts(struct ice_vsi *vsi); 796 void ice_flush_rxq_interrupts(struct ice_vsi *vsi); 797 void ice_flush_txq_interrupts(struct ice_vsi *vsi); 798 int ice_cfg_vsi_for_tx(struct ice_vsi *vsi); 799 int ice_cfg_vsi_for_rx(struct ice_vsi *vsi); 800 int ice_control_rx_queues(struct ice_vsi *vsi, bool enable); 801 int ice_cfg_pf_default_mac_filters(struct ice_softc *sc); 802 int ice_rm_pf_default_mac_filters(struct ice_softc *sc); 803 void ice_print_nvm_version(struct ice_softc *sc); 804 void ice_update_vsi_hw_stats(struct ice_vsi *vsi); 805 void ice_reset_vsi_stats(struct ice_vsi *vsi); 806 void ice_update_pf_stats(struct ice_softc *sc); 807 void ice_reset_pf_stats(struct ice_softc *sc); 808 void ice_add_device_sysctls(struct ice_softc *sc); 809 void ice_log_hmc_error(struct ice_hw *hw, device_t dev); 810 void ice_add_sysctls_eth_stats(struct sysctl_ctx_list *ctx, 811 struct sysctl_oid *parent, 812 struct ice_eth_stats *stats); 813 void ice_add_vsi_sysctls(struct ice_vsi *vsi); 814 void ice_add_sysctls_mac_stats(struct sysctl_ctx_list *ctx, 815 struct sysctl_oid *parent, 816 struct ice_hw_port_stats *stats); 817 void ice_configure_misc_interrupts(struct ice_softc *sc); 818 int ice_sync_multicast_filters(struct ice_softc *sc); 819 enum ice_status ice_add_vlan_hw_filter(struct ice_vsi *vsi, u16 vid); 820 enum ice_status ice_remove_vlan_hw_filter(struct ice_vsi *vsi, u16 vid); 821 void ice_add_vsi_tunables(struct ice_vsi *vsi, struct sysctl_oid *parent); 822 void ice_del_vsi_sysctl_ctx(struct ice_vsi *vsi); 823 void ice_add_device_tunables(struct ice_softc *sc); 824 int ice_add_vsi_mac_filter(struct ice_vsi *vsi, const u8 *addr); 825 int ice_remove_vsi_mac_filter(struct ice_vsi *vsi, const u8 *addr); 826 int ice_vsi_disable_tx(struct ice_vsi *vsi); 827 void ice_vsi_add_txqs_ctx(struct ice_vsi *vsi); 828 void ice_vsi_add_rxqs_ctx(struct ice_vsi *vsi); 829 void ice_vsi_del_txqs_ctx(struct ice_vsi *vsi); 830 void ice_vsi_del_rxqs_ctx(struct ice_vsi *vsi); 831 void ice_add_txq_sysctls(struct ice_tx_queue *txq); 832 void ice_add_rxq_sysctls(struct ice_rx_queue *rxq); 833 int ice_config_rss(struct ice_vsi *vsi); 834 void ice_clean_all_vsi_rss_cfg(struct ice_softc *sc); 835 void ice_load_pkg_file(struct ice_softc *sc); 836 void ice_log_pkg_init(struct ice_softc *sc, enum ice_status *pkg_status); 837 uint64_t ice_get_ifnet_counter(struct ice_vsi *vsi, ift_counter counter); 838 void ice_save_pci_info(struct ice_hw *hw, device_t dev); 839 int ice_replay_all_vsi_cfg(struct ice_softc *sc); 840 void ice_link_up_msg(struct ice_softc *sc); 841 int ice_update_laa_mac(struct ice_softc *sc); 842 void ice_get_and_print_bus_info(struct ice_softc *sc); 843 const char *ice_fec_str(enum ice_fec_mode mode); 844 const char *ice_fc_str(enum ice_fc_mode mode); 845 const char *ice_fwd_act_str(enum ice_sw_fwd_act_type action); 846 const char *ice_state_to_str(enum ice_state state); 847 int ice_init_link_events(struct ice_softc *sc); 848 void ice_configure_rx_itr(struct ice_vsi *vsi); 849 void ice_configure_tx_itr(struct ice_vsi *vsi); 850 void ice_setup_pf_vsi(struct ice_softc *sc); 851 void ice_handle_mdd_event(struct ice_softc *sc); 852 void ice_init_dcb_setup(struct ice_softc *sc); 853 int ice_send_version(struct ice_softc *sc); 854 int ice_cfg_pf_ethertype_filters(struct ice_softc *sc); 855 void ice_init_link_configuration(struct ice_softc *sc); 856 void ice_init_saved_phy_cfg(struct ice_softc *sc); 857 int ice_apply_saved_phy_cfg(struct ice_softc *sc, u8 settings); 858 void ice_set_link_management_mode(struct ice_softc *sc); 859 int ice_module_event_handler(module_t mod, int what, void *arg); 860 int ice_handle_nvm_access_ioctl(struct ice_softc *sc, struct ifdrv *ifd); 861 int ice_handle_i2c_req(struct ice_softc *sc, struct ifi2creq *req); 862 int ice_read_sff_eeprom(struct ice_softc *sc, u16 dev_addr, u16 offset, u8* data, u16 length); 863 int ice_alloc_intr_tracking(struct ice_softc *sc); 864 void ice_free_intr_tracking(struct ice_softc *sc); 865 void ice_set_default_local_lldp_mib(struct ice_softc *sc); 866 void ice_init_health_events(struct ice_softc *sc); 867 void ice_cfg_pba_num(struct ice_softc *sc); 868 869 #endif /* _ICE_LIB_H_ */ 870