1 /* SPDX-License-Identifier: BSD-3-Clause 2 * 3 * Copyright(c) 2019-2021 Xilinx, Inc. 4 * Copyright(c) 2006-2019 Solarflare Communications Inc. 5 */ 6 7 #ifndef _SYS_EFX_H 8 #define _SYS_EFX_H 9 10 #include "efx_annote.h" 11 #include "efsys.h" 12 #include "efx_types.h" 13 #include "efx_check.h" 14 #include "efx_phy_ids.h" 15 16 #ifdef __cplusplus 17 extern "C" { 18 #endif 19 20 #define EFX_STATIC_ASSERT(_cond) \ 21 ((void)sizeof (char[(_cond) ? 1 : -1])) 22 23 #define EFX_ARRAY_SIZE(_array) \ 24 (sizeof (_array) / sizeof ((_array)[0])) 25 26 #define EFX_FIELD_OFFSET(_type, _field) \ 27 ((size_t)&(((_type *)0)->_field)) 28 29 /* The macro expands divider twice */ 30 #define EFX_DIV_ROUND_UP(_n, _d) (((_n) + (_d) - 1) / (_d)) 31 32 /* Round value up to the nearest power of two. */ 33 #define EFX_P2ROUNDUP(_type, _value, _align) \ 34 (-(-(_type)(_value) & -(_type)(_align))) 35 36 /* Align value down to the nearest power of two. */ 37 #define EFX_P2ALIGN(_type, _value, _align) \ 38 ((_type)(_value) & -(_type)(_align)) 39 40 /* Test if value is power of 2 aligned. */ 41 #define EFX_IS_P2ALIGNED(_type, _value, _align) \ 42 ((((_type)(_value)) & ((_type)(_align) - 1)) == 0) 43 44 /* Return codes */ 45 46 typedef __success(return == 0) int efx_rc_t; 47 48 49 /* Chip families */ 50 51 typedef enum efx_family_e { 52 EFX_FAMILY_INVALID, 53 EFX_FAMILY_FALCON, /* Obsolete and not supported */ 54 EFX_FAMILY_SIENA, 55 EFX_FAMILY_HUNTINGTON, 56 EFX_FAMILY_MEDFORD, 57 EFX_FAMILY_MEDFORD2, 58 EFX_FAMILY_RIVERHEAD, 59 EFX_FAMILY_NTYPES 60 } efx_family_t; 61 62 typedef enum efx_bar_type_e { 63 EFX_BAR_TYPE_MEM, 64 EFX_BAR_TYPE_IO 65 } efx_bar_type_t; 66 67 typedef struct efx_bar_region_s { 68 efx_bar_type_t ebr_type; 69 int ebr_index; 70 efsys_dma_addr_t ebr_offset; 71 efsys_dma_addr_t ebr_length; 72 } efx_bar_region_t; 73 74 /* The function is deprecated. It is used only if Riverhead is not supported. */ 75 LIBEFX_API 76 extern __checkReturn efx_rc_t 77 efx_family( 78 __in uint16_t venid, 79 __in uint16_t devid, 80 __out efx_family_t *efp, 81 __out unsigned int *membarp); 82 83 #if EFSYS_OPT_PCI 84 85 typedef struct efx_pci_ops_s { 86 /* 87 * Function for reading PCIe configuration space. 88 * 89 * espcp System-specific PCIe device handle; 90 * offset Offset inside PCIe configuration space to start reading 91 * from; 92 * edp EFX DWORD structure that should be populated by function 93 * in little-endian order; 94 * 95 * Returns status code, 0 on success, any other value on error. 96 */ 97 efx_rc_t (*epo_config_readd)(efsys_pci_config_t *espcp, 98 uint32_t offset, efx_dword_t *edp); 99 /* 100 * Function for finding PCIe memory bar handle by its index from a PCIe 101 * device handle. The found memory bar is available in read-only mode. 102 * 103 * configp System-specific PCIe device handle; 104 * index Memory bar index; 105 * memp Pointer to the found memory bar handle; 106 * 107 * Returns status code, 0 on success, any other value on error. 108 */ 109 efx_rc_t (*epo_find_mem_bar)(efsys_pci_config_t *configp, 110 int index, efsys_bar_t *memp); 111 } efx_pci_ops_t; 112 113 /* Determine EFX family and perform lookup of the function control window 114 * 115 * The function requires PCI config handle from which all memory bars can 116 * be accessed. 117 * A user of the API must be aware of memory bars indexes (not available 118 * on Windows). 119 */ 120 LIBEFX_API 121 extern __checkReturn efx_rc_t 122 efx_family_probe_bar( 123 __in uint16_t venid, 124 __in uint16_t devid, 125 __in efsys_pci_config_t *espcp, 126 __in const efx_pci_ops_t *epop, 127 __out efx_family_t *efp, 128 __out efx_bar_region_t *ebrp); 129 130 #endif /* EFSYS_OPT_PCI */ 131 132 133 #define EFX_PCI_VENID_SFC 0x1924 134 #define EFX_PCI_VENID_XILINX 0x10EE 135 136 #define EFX_PCI_DEVID_FALCON 0x0710 /* SFC4000 */ 137 138 #define EFX_PCI_DEVID_BETHPAGE 0x0803 /* SFC9020 */ 139 #define EFX_PCI_DEVID_SIENA 0x0813 /* SFL9021 */ 140 #define EFX_PCI_DEVID_SIENA_F1_UNINIT 0x0810 141 142 #define EFX_PCI_DEVID_HUNTINGTON_PF_UNINIT 0x0901 143 #define EFX_PCI_DEVID_FARMINGDALE 0x0903 /* SFC9120 PF */ 144 #define EFX_PCI_DEVID_GREENPORT 0x0923 /* SFC9140 PF */ 145 146 #define EFX_PCI_DEVID_FARMINGDALE_VF 0x1903 /* SFC9120 VF */ 147 #define EFX_PCI_DEVID_GREENPORT_VF 0x1923 /* SFC9140 VF */ 148 149 #define EFX_PCI_DEVID_MEDFORD_PF_UNINIT 0x0913 150 #define EFX_PCI_DEVID_MEDFORD 0x0A03 /* SFC9240 PF */ 151 #define EFX_PCI_DEVID_MEDFORD_VF 0x1A03 /* SFC9240 VF */ 152 153 #define EFX_PCI_DEVID_MEDFORD2_PF_UNINIT 0x0B13 154 #define EFX_PCI_DEVID_MEDFORD2 0x0B03 /* SFC9250 PF */ 155 #define EFX_PCI_DEVID_MEDFORD2_VF 0x1B03 /* SFC9250 VF */ 156 157 #define EFX_PCI_DEVID_RIVERHEAD 0x0100 158 #define EFX_PCI_DEVID_RIVERHEAD_VF 0x1100 159 160 #define EFX_MEM_BAR_SIENA 2 161 162 #define EFX_MEM_BAR_HUNTINGTON_PF 2 163 #define EFX_MEM_BAR_HUNTINGTON_VF 0 164 165 #define EFX_MEM_BAR_MEDFORD_PF 2 166 #define EFX_MEM_BAR_MEDFORD_VF 0 167 168 #define EFX_MEM_BAR_MEDFORD2 0 169 170 /* FIXME Fix it when memory bar is fixed in FPGA image. It must be 0. */ 171 #define EFX_MEM_BAR_RIVERHEAD 2 172 173 174 /* Error codes */ 175 176 enum { 177 EFX_ERR_INVALID, 178 EFX_ERR_SRAM_OOB, 179 EFX_ERR_BUFID_DC_OOB, 180 EFX_ERR_MEM_PERR, 181 EFX_ERR_RBUF_OWN, 182 EFX_ERR_TBUF_OWN, 183 EFX_ERR_RDESQ_OWN, 184 EFX_ERR_TDESQ_OWN, 185 EFX_ERR_EVQ_OWN, 186 EFX_ERR_EVFF_OFLO, 187 EFX_ERR_ILL_ADDR, 188 EFX_ERR_SRAM_PERR, 189 EFX_ERR_NCODES 190 }; 191 192 /* Calculate the IEEE 802.3 CRC32 of a MAC addr */ 193 LIBEFX_API 194 extern __checkReturn uint32_t 195 efx_crc32_calculate( 196 __in uint32_t crc_init, 197 __in_ecount(length) uint8_t const *input, 198 __in int length); 199 200 201 /* Type prototypes */ 202 203 typedef struct efx_rxq_s efx_rxq_t; 204 205 /* NIC */ 206 207 typedef struct efx_nic_s efx_nic_t; 208 209 LIBEFX_API 210 extern __checkReturn efx_rc_t 211 efx_nic_create( 212 __in efx_family_t family, 213 __in efsys_identifier_t *esip, 214 __in efsys_bar_t *esbp, 215 __in uint32_t fcw_offset, 216 __in efsys_lock_t *eslp, 217 __deref_out efx_nic_t **enpp); 218 219 /* EFX_FW_VARIANT codes map one to one on MC_CMD_FW codes */ 220 typedef enum efx_fw_variant_e { 221 EFX_FW_VARIANT_FULL_FEATURED, 222 EFX_FW_VARIANT_LOW_LATENCY, 223 EFX_FW_VARIANT_PACKED_STREAM, 224 EFX_FW_VARIANT_HIGH_TX_RATE, 225 EFX_FW_VARIANT_PACKED_STREAM_HASH_MODE_1, 226 EFX_FW_VARIANT_RULES_ENGINE, 227 EFX_FW_VARIANT_DPDK, 228 EFX_FW_VARIANT_DONT_CARE = 0xffffffff 229 } efx_fw_variant_t; 230 231 LIBEFX_API 232 extern __checkReturn efx_rc_t 233 efx_nic_probe( 234 __in efx_nic_t *enp, 235 __in efx_fw_variant_t efv); 236 237 LIBEFX_API 238 extern __checkReturn efx_rc_t 239 efx_nic_init( 240 __in efx_nic_t *enp); 241 242 LIBEFX_API 243 extern __checkReturn efx_rc_t 244 efx_nic_reset( 245 __in efx_nic_t *enp); 246 247 LIBEFX_API 248 extern __checkReturn boolean_t 249 efx_nic_hw_unavailable( 250 __in efx_nic_t *enp); 251 252 LIBEFX_API 253 extern void 254 efx_nic_set_hw_unavailable( 255 __in efx_nic_t *enp); 256 257 #if EFSYS_OPT_DIAG 258 259 LIBEFX_API 260 extern __checkReturn efx_rc_t 261 efx_nic_register_test( 262 __in efx_nic_t *enp); 263 264 #endif /* EFSYS_OPT_DIAG */ 265 266 LIBEFX_API 267 extern void 268 efx_nic_fini( 269 __in efx_nic_t *enp); 270 271 LIBEFX_API 272 extern void 273 efx_nic_unprobe( 274 __in efx_nic_t *enp); 275 276 LIBEFX_API 277 extern void 278 efx_nic_destroy( 279 __in efx_nic_t *enp); 280 281 #define EFX_PCIE_LINK_SPEED_GEN1 1 282 #define EFX_PCIE_LINK_SPEED_GEN2 2 283 #define EFX_PCIE_LINK_SPEED_GEN3 3 284 285 typedef enum efx_pcie_link_performance_e { 286 EFX_PCIE_LINK_PERFORMANCE_UNKNOWN_BANDWIDTH, 287 EFX_PCIE_LINK_PERFORMANCE_SUBOPTIMAL_BANDWIDTH, 288 EFX_PCIE_LINK_PERFORMANCE_SUBOPTIMAL_LATENCY, 289 EFX_PCIE_LINK_PERFORMANCE_OPTIMAL 290 } efx_pcie_link_performance_t; 291 292 LIBEFX_API 293 extern __checkReturn efx_rc_t 294 efx_nic_calculate_pcie_link_bandwidth( 295 __in uint32_t pcie_link_width, 296 __in uint32_t pcie_link_gen, 297 __out uint32_t *bandwidth_mbpsp); 298 299 LIBEFX_API 300 extern __checkReturn efx_rc_t 301 efx_nic_check_pcie_link_speed( 302 __in efx_nic_t *enp, 303 __in uint32_t pcie_link_width, 304 __in uint32_t pcie_link_gen, 305 __out efx_pcie_link_performance_t *resultp); 306 307 #if EFSYS_OPT_MCDI 308 309 #if EFSYS_OPT_RIVERHEAD || EFX_OPTS_EF10() 310 /* EF10 architecture and Riverhead NICs require MCDIv2 commands */ 311 #define WITH_MCDI_V2 1 312 #endif 313 314 typedef struct efx_mcdi_req_s efx_mcdi_req_t; 315 316 typedef enum efx_mcdi_exception_e { 317 EFX_MCDI_EXCEPTION_MC_REBOOT, 318 EFX_MCDI_EXCEPTION_MC_BADASSERT, 319 } efx_mcdi_exception_t; 320 321 #if EFSYS_OPT_MCDI_LOGGING 322 typedef enum efx_log_msg_e { 323 EFX_LOG_INVALID, 324 EFX_LOG_MCDI_REQUEST, 325 EFX_LOG_MCDI_RESPONSE, 326 } efx_log_msg_t; 327 #endif /* EFSYS_OPT_MCDI_LOGGING */ 328 329 typedef struct efx_mcdi_transport_s { 330 void *emt_context; 331 efsys_mem_t *emt_dma_mem; 332 void (*emt_execute)(void *, efx_mcdi_req_t *); 333 void (*emt_ev_cpl)(void *); 334 void (*emt_exception)(void *, efx_mcdi_exception_t); 335 #if EFSYS_OPT_MCDI_LOGGING 336 void (*emt_logger)(void *, efx_log_msg_t, 337 void *, size_t, void *, size_t); 338 #endif /* EFSYS_OPT_MCDI_LOGGING */ 339 #if EFSYS_OPT_MCDI_PROXY_AUTH 340 void (*emt_ev_proxy_response)(void *, uint32_t, efx_rc_t); 341 #endif /* EFSYS_OPT_MCDI_PROXY_AUTH */ 342 #if EFSYS_OPT_MCDI_PROXY_AUTH_SERVER 343 void (*emt_ev_proxy_request)(void *, uint32_t); 344 #endif /* EFSYS_OPT_MCDI_PROXY_AUTH_SERVER */ 345 } efx_mcdi_transport_t; 346 347 LIBEFX_API 348 extern __checkReturn efx_rc_t 349 efx_mcdi_init( 350 __in efx_nic_t *enp, 351 __in const efx_mcdi_transport_t *mtp); 352 353 LIBEFX_API 354 extern __checkReturn efx_rc_t 355 efx_mcdi_reboot( 356 __in efx_nic_t *enp); 357 358 LIBEFX_API 359 extern void 360 efx_mcdi_new_epoch( 361 __in efx_nic_t *enp); 362 363 LIBEFX_API 364 extern void 365 efx_mcdi_get_timeout( 366 __in efx_nic_t *enp, 367 __in efx_mcdi_req_t *emrp, 368 __out uint32_t *usec_timeoutp); 369 370 LIBEFX_API 371 extern void 372 efx_mcdi_request_start( 373 __in efx_nic_t *enp, 374 __in efx_mcdi_req_t *emrp, 375 __in boolean_t ev_cpl); 376 377 LIBEFX_API 378 extern __checkReturn boolean_t 379 efx_mcdi_request_poll( 380 __in efx_nic_t *enp); 381 382 LIBEFX_API 383 extern __checkReturn boolean_t 384 efx_mcdi_request_abort( 385 __in efx_nic_t *enp); 386 387 LIBEFX_API 388 extern void 389 efx_mcdi_fini( 390 __in efx_nic_t *enp); 391 392 #endif /* EFSYS_OPT_MCDI */ 393 394 /* INTR */ 395 396 #define EFX_NINTR_SIENA 1024 397 398 typedef enum efx_intr_type_e { 399 EFX_INTR_INVALID = 0, 400 EFX_INTR_LINE, 401 EFX_INTR_MESSAGE, 402 EFX_INTR_NTYPES 403 } efx_intr_type_t; 404 405 #define EFX_INTR_SIZE (sizeof (efx_oword_t)) 406 407 LIBEFX_API 408 extern __checkReturn efx_rc_t 409 efx_intr_init( 410 __in efx_nic_t *enp, 411 __in efx_intr_type_t type, 412 __in_opt efsys_mem_t *esmp); 413 414 LIBEFX_API 415 extern void 416 efx_intr_enable( 417 __in efx_nic_t *enp); 418 419 LIBEFX_API 420 extern void 421 efx_intr_disable( 422 __in efx_nic_t *enp); 423 424 LIBEFX_API 425 extern void 426 efx_intr_disable_unlocked( 427 __in efx_nic_t *enp); 428 429 #define EFX_INTR_NEVQS 32 430 431 LIBEFX_API 432 extern __checkReturn efx_rc_t 433 efx_intr_trigger( 434 __in efx_nic_t *enp, 435 __in unsigned int level); 436 437 LIBEFX_API 438 extern void 439 efx_intr_status_line( 440 __in efx_nic_t *enp, 441 __out boolean_t *fatalp, 442 __out uint32_t *maskp); 443 444 LIBEFX_API 445 extern void 446 efx_intr_status_message( 447 __in efx_nic_t *enp, 448 __in unsigned int message, 449 __out boolean_t *fatalp); 450 451 LIBEFX_API 452 extern void 453 efx_intr_fatal( 454 __in efx_nic_t *enp); 455 456 LIBEFX_API 457 extern void 458 efx_intr_fini( 459 __in efx_nic_t *enp); 460 461 /* MAC */ 462 463 #if EFSYS_OPT_MAC_STATS 464 465 /* START MKCONFIG GENERATED EfxHeaderMacBlock ea466a9bc8789994 */ 466 typedef enum efx_mac_stat_e { 467 EFX_MAC_RX_OCTETS, 468 EFX_MAC_RX_PKTS, 469 EFX_MAC_RX_UNICST_PKTS, 470 EFX_MAC_RX_MULTICST_PKTS, 471 EFX_MAC_RX_BRDCST_PKTS, 472 EFX_MAC_RX_PAUSE_PKTS, 473 EFX_MAC_RX_LE_64_PKTS, 474 EFX_MAC_RX_65_TO_127_PKTS, 475 EFX_MAC_RX_128_TO_255_PKTS, 476 EFX_MAC_RX_256_TO_511_PKTS, 477 EFX_MAC_RX_512_TO_1023_PKTS, 478 EFX_MAC_RX_1024_TO_15XX_PKTS, 479 EFX_MAC_RX_GE_15XX_PKTS, 480 EFX_MAC_RX_ERRORS, 481 EFX_MAC_RX_FCS_ERRORS, 482 EFX_MAC_RX_DROP_EVENTS, 483 EFX_MAC_RX_FALSE_CARRIER_ERRORS, 484 EFX_MAC_RX_SYMBOL_ERRORS, 485 EFX_MAC_RX_ALIGN_ERRORS, 486 EFX_MAC_RX_INTERNAL_ERRORS, 487 EFX_MAC_RX_JABBER_PKTS, 488 EFX_MAC_RX_LANE0_CHAR_ERR, 489 EFX_MAC_RX_LANE1_CHAR_ERR, 490 EFX_MAC_RX_LANE2_CHAR_ERR, 491 EFX_MAC_RX_LANE3_CHAR_ERR, 492 EFX_MAC_RX_LANE0_DISP_ERR, 493 EFX_MAC_RX_LANE1_DISP_ERR, 494 EFX_MAC_RX_LANE2_DISP_ERR, 495 EFX_MAC_RX_LANE3_DISP_ERR, 496 EFX_MAC_RX_MATCH_FAULT, 497 EFX_MAC_RX_NODESC_DROP_CNT, 498 EFX_MAC_TX_OCTETS, 499 EFX_MAC_TX_PKTS, 500 EFX_MAC_TX_UNICST_PKTS, 501 EFX_MAC_TX_MULTICST_PKTS, 502 EFX_MAC_TX_BRDCST_PKTS, 503 EFX_MAC_TX_PAUSE_PKTS, 504 EFX_MAC_TX_LE_64_PKTS, 505 EFX_MAC_TX_65_TO_127_PKTS, 506 EFX_MAC_TX_128_TO_255_PKTS, 507 EFX_MAC_TX_256_TO_511_PKTS, 508 EFX_MAC_TX_512_TO_1023_PKTS, 509 EFX_MAC_TX_1024_TO_15XX_PKTS, 510 EFX_MAC_TX_GE_15XX_PKTS, 511 EFX_MAC_TX_ERRORS, 512 EFX_MAC_TX_SGL_COL_PKTS, 513 EFX_MAC_TX_MULT_COL_PKTS, 514 EFX_MAC_TX_EX_COL_PKTS, 515 EFX_MAC_TX_LATE_COL_PKTS, 516 EFX_MAC_TX_DEF_PKTS, 517 EFX_MAC_TX_EX_DEF_PKTS, 518 EFX_MAC_PM_TRUNC_BB_OVERFLOW, 519 EFX_MAC_PM_DISCARD_BB_OVERFLOW, 520 EFX_MAC_PM_TRUNC_VFIFO_FULL, 521 EFX_MAC_PM_DISCARD_VFIFO_FULL, 522 EFX_MAC_PM_TRUNC_QBB, 523 EFX_MAC_PM_DISCARD_QBB, 524 EFX_MAC_PM_DISCARD_MAPPING, 525 EFX_MAC_RXDP_Q_DISABLED_PKTS, 526 EFX_MAC_RXDP_DI_DROPPED_PKTS, 527 EFX_MAC_RXDP_STREAMING_PKTS, 528 EFX_MAC_RXDP_HLB_FETCH, 529 EFX_MAC_RXDP_HLB_WAIT, 530 EFX_MAC_VADAPTER_RX_UNICAST_PACKETS, 531 EFX_MAC_VADAPTER_RX_UNICAST_BYTES, 532 EFX_MAC_VADAPTER_RX_MULTICAST_PACKETS, 533 EFX_MAC_VADAPTER_RX_MULTICAST_BYTES, 534 EFX_MAC_VADAPTER_RX_BROADCAST_PACKETS, 535 EFX_MAC_VADAPTER_RX_BROADCAST_BYTES, 536 EFX_MAC_VADAPTER_RX_BAD_PACKETS, 537 EFX_MAC_VADAPTER_RX_BAD_BYTES, 538 EFX_MAC_VADAPTER_RX_OVERFLOW, 539 EFX_MAC_VADAPTER_TX_UNICAST_PACKETS, 540 EFX_MAC_VADAPTER_TX_UNICAST_BYTES, 541 EFX_MAC_VADAPTER_TX_MULTICAST_PACKETS, 542 EFX_MAC_VADAPTER_TX_MULTICAST_BYTES, 543 EFX_MAC_VADAPTER_TX_BROADCAST_PACKETS, 544 EFX_MAC_VADAPTER_TX_BROADCAST_BYTES, 545 EFX_MAC_VADAPTER_TX_BAD_PACKETS, 546 EFX_MAC_VADAPTER_TX_BAD_BYTES, 547 EFX_MAC_VADAPTER_TX_OVERFLOW, 548 EFX_MAC_FEC_UNCORRECTED_ERRORS, 549 EFX_MAC_FEC_CORRECTED_ERRORS, 550 EFX_MAC_FEC_CORRECTED_SYMBOLS_LANE0, 551 EFX_MAC_FEC_CORRECTED_SYMBOLS_LANE1, 552 EFX_MAC_FEC_CORRECTED_SYMBOLS_LANE2, 553 EFX_MAC_FEC_CORRECTED_SYMBOLS_LANE3, 554 EFX_MAC_CTPIO_VI_BUSY_FALLBACK, 555 EFX_MAC_CTPIO_LONG_WRITE_SUCCESS, 556 EFX_MAC_CTPIO_MISSING_DBELL_FAIL, 557 EFX_MAC_CTPIO_OVERFLOW_FAIL, 558 EFX_MAC_CTPIO_UNDERFLOW_FAIL, 559 EFX_MAC_CTPIO_TIMEOUT_FAIL, 560 EFX_MAC_CTPIO_NONCONTIG_WR_FAIL, 561 EFX_MAC_CTPIO_FRM_CLOBBER_FAIL, 562 EFX_MAC_CTPIO_INVALID_WR_FAIL, 563 EFX_MAC_CTPIO_VI_CLOBBER_FALLBACK, 564 EFX_MAC_CTPIO_UNQUALIFIED_FALLBACK, 565 EFX_MAC_CTPIO_RUNT_FALLBACK, 566 EFX_MAC_CTPIO_SUCCESS, 567 EFX_MAC_CTPIO_FALLBACK, 568 EFX_MAC_CTPIO_POISON, 569 EFX_MAC_CTPIO_ERASE, 570 EFX_MAC_RXDP_SCATTER_DISABLED_TRUNC, 571 EFX_MAC_RXDP_HLB_IDLE, 572 EFX_MAC_RXDP_HLB_TIMEOUT, 573 EFX_MAC_NSTATS 574 } efx_mac_stat_t; 575 576 /* END MKCONFIG GENERATED EfxHeaderMacBlock */ 577 578 #endif /* EFSYS_OPT_MAC_STATS */ 579 580 typedef enum efx_link_mode_e { 581 EFX_LINK_UNKNOWN = 0, 582 EFX_LINK_DOWN, 583 EFX_LINK_10HDX, 584 EFX_LINK_10FDX, 585 EFX_LINK_100HDX, 586 EFX_LINK_100FDX, 587 EFX_LINK_1000HDX, 588 EFX_LINK_1000FDX, 589 EFX_LINK_10000FDX, 590 EFX_LINK_40000FDX, 591 EFX_LINK_25000FDX, 592 EFX_LINK_50000FDX, 593 EFX_LINK_100000FDX, 594 EFX_LINK_NMODES 595 } efx_link_mode_t; 596 597 #define EFX_MAC_ADDR_LEN 6 598 599 #define EFX_VNI_OR_VSID_LEN 3 600 601 #define EFX_MAC_ADDR_IS_MULTICAST(_address) (((uint8_t *)_address)[0] & 0x01) 602 603 #define EFX_MAC_MULTICAST_LIST_MAX 256 604 605 #define EFX_MAC_SDU_MAX 9202 606 607 #define EFX_MAC_PDU_ADJUSTMENT \ 608 (/* EtherII */ 14 \ 609 + /* VLAN */ 4 \ 610 + /* CRC */ 4 \ 611 + /* bug16011 */ 16) \ 612 613 #define EFX_MAC_PDU(_sdu) \ 614 EFX_P2ROUNDUP(size_t, (_sdu) + EFX_MAC_PDU_ADJUSTMENT, 8) 615 616 /* 617 * Due to the EFX_P2ROUNDUP in EFX_MAC_PDU(), EFX_MAC_SDU_FROM_PDU() may give 618 * the SDU rounded up slightly. 619 */ 620 #define EFX_MAC_SDU_FROM_PDU(_pdu) ((_pdu) - EFX_MAC_PDU_ADJUSTMENT) 621 622 #define EFX_MAC_PDU_MIN 60 623 #define EFX_MAC_PDU_MAX EFX_MAC_PDU(EFX_MAC_SDU_MAX) 624 625 LIBEFX_API 626 extern __checkReturn efx_rc_t 627 efx_mac_pdu_get( 628 __in efx_nic_t *enp, 629 __out size_t *pdu); 630 631 LIBEFX_API 632 extern __checkReturn efx_rc_t 633 efx_mac_pdu_set( 634 __in efx_nic_t *enp, 635 __in size_t pdu); 636 637 LIBEFX_API 638 extern __checkReturn efx_rc_t 639 efx_mac_addr_set( 640 __in efx_nic_t *enp, 641 __in uint8_t *addr); 642 643 LIBEFX_API 644 extern __checkReturn efx_rc_t 645 efx_mac_filter_set( 646 __in efx_nic_t *enp, 647 __in boolean_t all_unicst, 648 __in boolean_t mulcst, 649 __in boolean_t all_mulcst, 650 __in boolean_t brdcst); 651 652 LIBEFX_API 653 extern void 654 efx_mac_filter_get_all_ucast_mcast( 655 __in efx_nic_t *enp, 656 __out boolean_t *all_unicst, 657 __out boolean_t *all_mulcst); 658 659 LIBEFX_API 660 extern __checkReturn efx_rc_t 661 efx_mac_multicast_list_set( 662 __in efx_nic_t *enp, 663 __in_ecount(6*count) uint8_t const *addrs, 664 __in int count); 665 666 LIBEFX_API 667 extern __checkReturn efx_rc_t 668 efx_mac_filter_default_rxq_set( 669 __in efx_nic_t *enp, 670 __in efx_rxq_t *erp, 671 __in boolean_t using_rss); 672 673 LIBEFX_API 674 extern void 675 efx_mac_filter_default_rxq_clear( 676 __in efx_nic_t *enp); 677 678 LIBEFX_API 679 extern __checkReturn efx_rc_t 680 efx_mac_drain( 681 __in efx_nic_t *enp, 682 __in boolean_t enabled); 683 684 LIBEFX_API 685 extern __checkReturn efx_rc_t 686 efx_mac_up( 687 __in efx_nic_t *enp, 688 __out boolean_t *mac_upp); 689 690 #define EFX_FCNTL_RESPOND 0x00000001 691 #define EFX_FCNTL_GENERATE 0x00000002 692 693 LIBEFX_API 694 extern __checkReturn efx_rc_t 695 efx_mac_fcntl_set( 696 __in efx_nic_t *enp, 697 __in unsigned int fcntl, 698 __in boolean_t autoneg); 699 700 LIBEFX_API 701 extern void 702 efx_mac_fcntl_get( 703 __in efx_nic_t *enp, 704 __out unsigned int *fcntl_wantedp, 705 __out unsigned int *fcntl_linkp); 706 707 708 #if EFSYS_OPT_MAC_STATS 709 710 #if EFSYS_OPT_NAMES 711 712 LIBEFX_API 713 extern __checkReturn const char * 714 efx_mac_stat_name( 715 __in efx_nic_t *enp, 716 __in unsigned int id); 717 718 #endif /* EFSYS_OPT_NAMES */ 719 720 #define EFX_MAC_STATS_MASK_BITS_PER_PAGE (8 * sizeof (uint32_t)) 721 722 #define EFX_MAC_STATS_MASK_NPAGES \ 723 (EFX_P2ROUNDUP(uint32_t, EFX_MAC_NSTATS, \ 724 EFX_MAC_STATS_MASK_BITS_PER_PAGE) / \ 725 EFX_MAC_STATS_MASK_BITS_PER_PAGE) 726 727 /* 728 * Get mask of MAC statistics supported by the hardware. 729 * 730 * If mask_size is insufficient to return the mask, EINVAL error is 731 * returned. EFX_MAC_STATS_MASK_NPAGES multiplied by size of the page 732 * (which is sizeof (uint32_t)) is sufficient. 733 */ 734 LIBEFX_API 735 extern __checkReturn efx_rc_t 736 efx_mac_stats_get_mask( 737 __in efx_nic_t *enp, 738 __out_bcount(mask_size) uint32_t *maskp, 739 __in size_t mask_size); 740 741 #define EFX_MAC_STAT_SUPPORTED(_mask, _stat) \ 742 ((_mask)[(_stat) / EFX_MAC_STATS_MASK_BITS_PER_PAGE] & \ 743 (1ULL << ((_stat) & (EFX_MAC_STATS_MASK_BITS_PER_PAGE - 1)))) 744 745 746 LIBEFX_API 747 extern __checkReturn efx_rc_t 748 efx_mac_stats_clear( 749 __in efx_nic_t *enp); 750 751 /* 752 * Upload mac statistics supported by the hardware into the given buffer. 753 * 754 * The DMA buffer must be 4Kbyte aligned and sized to hold at least 755 * efx_nic_cfg_t::enc_mac_stats_nstats 64bit counters. 756 * 757 * The hardware will only DMA statistics that it understands (of course). 758 * Drivers should not make any assumptions about which statistics are 759 * supported, especially when the statistics are generated by firmware. 760 * 761 * Thus, drivers should zero this buffer before use, so that not-understood 762 * statistics read back as zero. 763 */ 764 LIBEFX_API 765 extern __checkReturn efx_rc_t 766 efx_mac_stats_upload( 767 __in efx_nic_t *enp, 768 __in efsys_mem_t *esmp); 769 770 LIBEFX_API 771 extern __checkReturn efx_rc_t 772 efx_mac_stats_periodic( 773 __in efx_nic_t *enp, 774 __in efsys_mem_t *esmp, 775 __in uint16_t period_ms, 776 __in boolean_t events); 777 778 LIBEFX_API 779 extern __checkReturn efx_rc_t 780 efx_mac_stats_update( 781 __in efx_nic_t *enp, 782 __in efsys_mem_t *esmp, 783 __inout_ecount(EFX_MAC_NSTATS) efsys_stat_t *stat, 784 __inout_opt uint32_t *generationp); 785 786 #endif /* EFSYS_OPT_MAC_STATS */ 787 788 /* MON */ 789 790 typedef enum efx_mon_type_e { 791 EFX_MON_INVALID = 0, 792 EFX_MON_SFC90X0, 793 EFX_MON_SFC91X0, 794 EFX_MON_SFC92X0, 795 EFX_MON_NTYPES 796 } efx_mon_type_t; 797 798 #if EFSYS_OPT_NAMES 799 800 LIBEFX_API 801 extern const char * 802 efx_mon_name( 803 __in efx_nic_t *enp); 804 805 #endif /* EFSYS_OPT_NAMES */ 806 807 LIBEFX_API 808 extern __checkReturn efx_rc_t 809 efx_mon_init( 810 __in efx_nic_t *enp); 811 812 #if EFSYS_OPT_MON_STATS 813 814 #define EFX_MON_STATS_PAGE_SIZE 0x100 815 #define EFX_MON_MASK_ELEMENT_SIZE 32 816 817 /* START MKCONFIG GENERATED MonitorHeaderStatsBlock 78b65c8d5af9747b */ 818 typedef enum efx_mon_stat_e { 819 EFX_MON_STAT_CONTROLLER_TEMP, 820 EFX_MON_STAT_PHY_COMMON_TEMP, 821 EFX_MON_STAT_CONTROLLER_COOLING, 822 EFX_MON_STAT_PHY0_TEMP, 823 EFX_MON_STAT_PHY0_COOLING, 824 EFX_MON_STAT_PHY1_TEMP, 825 EFX_MON_STAT_PHY1_COOLING, 826 EFX_MON_STAT_IN_1V0, 827 EFX_MON_STAT_IN_1V2, 828 EFX_MON_STAT_IN_1V8, 829 EFX_MON_STAT_IN_2V5, 830 EFX_MON_STAT_IN_3V3, 831 EFX_MON_STAT_IN_12V0, 832 EFX_MON_STAT_IN_1V2A, 833 EFX_MON_STAT_IN_VREF, 834 EFX_MON_STAT_OUT_VAOE, 835 EFX_MON_STAT_AOE_TEMP, 836 EFX_MON_STAT_PSU_AOE_TEMP, 837 EFX_MON_STAT_PSU_TEMP, 838 EFX_MON_STAT_FAN_0, 839 EFX_MON_STAT_FAN_1, 840 EFX_MON_STAT_FAN_2, 841 EFX_MON_STAT_FAN_3, 842 EFX_MON_STAT_FAN_4, 843 EFX_MON_STAT_IN_VAOE, 844 EFX_MON_STAT_OUT_IAOE, 845 EFX_MON_STAT_IN_IAOE, 846 EFX_MON_STAT_NIC_POWER, 847 EFX_MON_STAT_IN_0V9, 848 EFX_MON_STAT_IN_I0V9, 849 EFX_MON_STAT_IN_I1V2, 850 EFX_MON_STAT_IN_0V9_ADC, 851 EFX_MON_STAT_CONTROLLER_2_TEMP, 852 EFX_MON_STAT_VREG_INTERNAL_TEMP, 853 EFX_MON_STAT_VREG_0V9_TEMP, 854 EFX_MON_STAT_VREG_1V2_TEMP, 855 EFX_MON_STAT_CONTROLLER_VPTAT, 856 EFX_MON_STAT_CONTROLLER_INTERNAL_TEMP, 857 EFX_MON_STAT_CONTROLLER_VPTAT_EXTADC, 858 EFX_MON_STAT_CONTROLLER_INTERNAL_TEMP_EXTADC, 859 EFX_MON_STAT_AMBIENT_TEMP, 860 EFX_MON_STAT_AIRFLOW, 861 EFX_MON_STAT_VDD08D_VSS08D_CSR, 862 EFX_MON_STAT_VDD08D_VSS08D_CSR_EXTADC, 863 EFX_MON_STAT_HOTPOINT_TEMP, 864 EFX_MON_STAT_PHY_POWER_PORT0, 865 EFX_MON_STAT_PHY_POWER_PORT1, 866 EFX_MON_STAT_MUM_VCC, 867 EFX_MON_STAT_IN_0V9_A, 868 EFX_MON_STAT_IN_I0V9_A, 869 EFX_MON_STAT_VREG_0V9_A_TEMP, 870 EFX_MON_STAT_IN_0V9_B, 871 EFX_MON_STAT_IN_I0V9_B, 872 EFX_MON_STAT_VREG_0V9_B_TEMP, 873 EFX_MON_STAT_CCOM_AVREG_1V2_SUPPLY, 874 EFX_MON_STAT_CCOM_AVREG_1V2_SUPPLY_EXTADC, 875 EFX_MON_STAT_CCOM_AVREG_1V8_SUPPLY, 876 EFX_MON_STAT_CCOM_AVREG_1V8_SUPPLY_EXTADC, 877 EFX_MON_STAT_CONTROLLER_MASTER_VPTAT, 878 EFX_MON_STAT_CONTROLLER_MASTER_INTERNAL_TEMP, 879 EFX_MON_STAT_CONTROLLER_MASTER_VPTAT_EXTADC, 880 EFX_MON_STAT_CONTROLLER_MASTER_INTERNAL_TEMP_EXTADC, 881 EFX_MON_STAT_CONTROLLER_SLAVE_VPTAT, 882 EFX_MON_STAT_CONTROLLER_SLAVE_INTERNAL_TEMP, 883 EFX_MON_STAT_CONTROLLER_SLAVE_VPTAT_EXTADC, 884 EFX_MON_STAT_CONTROLLER_SLAVE_INTERNAL_TEMP_EXTADC, 885 EFX_MON_STAT_SODIMM_VOUT, 886 EFX_MON_STAT_SODIMM_0_TEMP, 887 EFX_MON_STAT_SODIMM_1_TEMP, 888 EFX_MON_STAT_PHY0_VCC, 889 EFX_MON_STAT_PHY1_VCC, 890 EFX_MON_STAT_CONTROLLER_TDIODE_TEMP, 891 EFX_MON_STAT_BOARD_FRONT_TEMP, 892 EFX_MON_STAT_BOARD_BACK_TEMP, 893 EFX_MON_STAT_IN_I1V8, 894 EFX_MON_STAT_IN_I2V5, 895 EFX_MON_STAT_IN_I3V3, 896 EFX_MON_STAT_IN_I12V0, 897 EFX_MON_STAT_IN_1V3, 898 EFX_MON_STAT_IN_I1V3, 899 EFX_MON_NSTATS 900 } efx_mon_stat_t; 901 902 /* END MKCONFIG GENERATED MonitorHeaderStatsBlock */ 903 904 typedef enum efx_mon_stat_state_e { 905 EFX_MON_STAT_STATE_OK = 0, 906 EFX_MON_STAT_STATE_WARNING = 1, 907 EFX_MON_STAT_STATE_FATAL = 2, 908 EFX_MON_STAT_STATE_BROKEN = 3, 909 EFX_MON_STAT_STATE_NO_READING = 4, 910 } efx_mon_stat_state_t; 911 912 typedef enum efx_mon_stat_unit_e { 913 EFX_MON_STAT_UNIT_UNKNOWN = 0, 914 EFX_MON_STAT_UNIT_BOOL, 915 EFX_MON_STAT_UNIT_TEMP_C, 916 EFX_MON_STAT_UNIT_VOLTAGE_MV, 917 EFX_MON_STAT_UNIT_CURRENT_MA, 918 EFX_MON_STAT_UNIT_POWER_W, 919 EFX_MON_STAT_UNIT_RPM, 920 EFX_MON_NUNITS 921 } efx_mon_stat_unit_t; 922 923 typedef struct efx_mon_stat_value_s { 924 uint16_t emsv_value; 925 efx_mon_stat_state_t emsv_state; 926 efx_mon_stat_unit_t emsv_unit; 927 } efx_mon_stat_value_t; 928 929 typedef struct efx_mon_limit_value_s { 930 uint16_t emlv_warning_min; 931 uint16_t emlv_warning_max; 932 uint16_t emlv_fatal_min; 933 uint16_t emlv_fatal_max; 934 } efx_mon_stat_limits_t; 935 936 typedef enum efx_mon_stat_portmask_e { 937 EFX_MON_STAT_PORTMAP_NONE = 0, 938 EFX_MON_STAT_PORTMAP_PORT0 = 1, 939 EFX_MON_STAT_PORTMAP_PORT1 = 2, 940 EFX_MON_STAT_PORTMAP_PORT2 = 3, 941 EFX_MON_STAT_PORTMAP_PORT3 = 4, 942 EFX_MON_STAT_PORTMAP_ALL = (-1), 943 EFX_MON_STAT_PORTMAP_UNKNOWN = (-2) 944 } efx_mon_stat_portmask_t; 945 946 #if EFSYS_OPT_NAMES 947 948 LIBEFX_API 949 extern const char * 950 efx_mon_stat_name( 951 __in efx_nic_t *enp, 952 __in efx_mon_stat_t id); 953 954 LIBEFX_API 955 extern const char * 956 efx_mon_stat_description( 957 __in efx_nic_t *enp, 958 __in efx_mon_stat_t id); 959 960 #endif /* EFSYS_OPT_NAMES */ 961 962 LIBEFX_API 963 extern __checkReturn boolean_t 964 efx_mon_mcdi_to_efx_stat( 965 __in int mcdi_index, 966 __out efx_mon_stat_t *statp); 967 968 LIBEFX_API 969 extern __checkReturn boolean_t 970 efx_mon_get_stat_unit( 971 __in efx_mon_stat_t stat, 972 __out efx_mon_stat_unit_t *unitp); 973 974 LIBEFX_API 975 extern __checkReturn boolean_t 976 efx_mon_get_stat_portmap( 977 __in efx_mon_stat_t stat, 978 __out efx_mon_stat_portmask_t *maskp); 979 980 LIBEFX_API 981 extern __checkReturn efx_rc_t 982 efx_mon_stats_update( 983 __in efx_nic_t *enp, 984 __in efsys_mem_t *esmp, 985 __inout_ecount(EFX_MON_NSTATS) efx_mon_stat_value_t *values); 986 987 LIBEFX_API 988 extern __checkReturn efx_rc_t 989 efx_mon_limits_update( 990 __in efx_nic_t *enp, 991 __inout_ecount(EFX_MON_NSTATS) efx_mon_stat_limits_t *values); 992 993 #endif /* EFSYS_OPT_MON_STATS */ 994 995 LIBEFX_API 996 extern void 997 efx_mon_fini( 998 __in efx_nic_t *enp); 999 1000 /* PHY */ 1001 1002 LIBEFX_API 1003 extern __checkReturn efx_rc_t 1004 efx_phy_verify( 1005 __in efx_nic_t *enp); 1006 1007 typedef enum efx_phy_led_mode_e { 1008 EFX_PHY_LED_DEFAULT = 0, 1009 EFX_PHY_LED_OFF, 1010 EFX_PHY_LED_ON, 1011 EFX_PHY_LED_FLASH, 1012 EFX_PHY_LED_NMODES 1013 } efx_phy_led_mode_t; 1014 1015 #if EFSYS_OPT_PHY_LED_CONTROL 1016 1017 LIBEFX_API 1018 extern __checkReturn efx_rc_t 1019 efx_phy_led_set( 1020 __in efx_nic_t *enp, 1021 __in efx_phy_led_mode_t mode); 1022 1023 #endif /* EFSYS_OPT_PHY_LED_CONTROL */ 1024 1025 LIBEFX_API 1026 extern __checkReturn efx_rc_t 1027 efx_port_init( 1028 __in efx_nic_t *enp); 1029 1030 #if EFSYS_OPT_LOOPBACK 1031 1032 typedef enum efx_loopback_type_e { 1033 EFX_LOOPBACK_OFF = 0, 1034 EFX_LOOPBACK_DATA = 1, 1035 EFX_LOOPBACK_GMAC = 2, 1036 EFX_LOOPBACK_XGMII = 3, 1037 EFX_LOOPBACK_XGXS = 4, 1038 EFX_LOOPBACK_XAUI = 5, 1039 EFX_LOOPBACK_GMII = 6, 1040 EFX_LOOPBACK_SGMII = 7, 1041 EFX_LOOPBACK_XGBR = 8, 1042 EFX_LOOPBACK_XFI = 9, 1043 EFX_LOOPBACK_XAUI_FAR = 10, 1044 EFX_LOOPBACK_GMII_FAR = 11, 1045 EFX_LOOPBACK_SGMII_FAR = 12, 1046 EFX_LOOPBACK_XFI_FAR = 13, 1047 EFX_LOOPBACK_GPHY = 14, 1048 EFX_LOOPBACK_PHY_XS = 15, 1049 EFX_LOOPBACK_PCS = 16, 1050 EFX_LOOPBACK_PMA_PMD = 17, 1051 EFX_LOOPBACK_XPORT = 18, 1052 EFX_LOOPBACK_XGMII_WS = 19, 1053 EFX_LOOPBACK_XAUI_WS = 20, 1054 EFX_LOOPBACK_XAUI_WS_FAR = 21, 1055 EFX_LOOPBACK_XAUI_WS_NEAR = 22, 1056 EFX_LOOPBACK_GMII_WS = 23, 1057 EFX_LOOPBACK_XFI_WS = 24, 1058 EFX_LOOPBACK_XFI_WS_FAR = 25, 1059 EFX_LOOPBACK_PHYXS_WS = 26, 1060 EFX_LOOPBACK_PMA_INT = 27, 1061 EFX_LOOPBACK_SD_NEAR = 28, 1062 EFX_LOOPBACK_SD_FAR = 29, 1063 EFX_LOOPBACK_PMA_INT_WS = 30, 1064 EFX_LOOPBACK_SD_FEP2_WS = 31, 1065 EFX_LOOPBACK_SD_FEP1_5_WS = 32, 1066 EFX_LOOPBACK_SD_FEP_WS = 33, 1067 EFX_LOOPBACK_SD_FES_WS = 34, 1068 EFX_LOOPBACK_AOE_INT_NEAR = 35, 1069 EFX_LOOPBACK_DATA_WS = 36, 1070 EFX_LOOPBACK_FORCE_EXT_LINK = 37, 1071 EFX_LOOPBACK_NTYPES 1072 } efx_loopback_type_t; 1073 1074 typedef enum efx_loopback_kind_e { 1075 EFX_LOOPBACK_KIND_OFF = 0, 1076 EFX_LOOPBACK_KIND_ALL, 1077 EFX_LOOPBACK_KIND_MAC, 1078 EFX_LOOPBACK_KIND_PHY, 1079 EFX_LOOPBACK_NKINDS 1080 } efx_loopback_kind_t; 1081 1082 LIBEFX_API 1083 extern void 1084 efx_loopback_mask( 1085 __in efx_loopback_kind_t loopback_kind, 1086 __out efx_qword_t *maskp); 1087 1088 LIBEFX_API 1089 extern __checkReturn efx_rc_t 1090 efx_port_loopback_set( 1091 __in efx_nic_t *enp, 1092 __in efx_link_mode_t link_mode, 1093 __in efx_loopback_type_t type); 1094 1095 #if EFSYS_OPT_NAMES 1096 1097 LIBEFX_API 1098 extern __checkReturn const char * 1099 efx_loopback_type_name( 1100 __in efx_nic_t *enp, 1101 __in efx_loopback_type_t type); 1102 1103 #endif /* EFSYS_OPT_NAMES */ 1104 1105 #endif /* EFSYS_OPT_LOOPBACK */ 1106 1107 LIBEFX_API 1108 extern __checkReturn efx_rc_t 1109 efx_port_poll( 1110 __in efx_nic_t *enp, 1111 __out_opt efx_link_mode_t *link_modep); 1112 1113 LIBEFX_API 1114 extern void 1115 efx_port_fini( 1116 __in efx_nic_t *enp); 1117 1118 typedef enum efx_phy_cap_type_e { 1119 EFX_PHY_CAP_INVALID = 0, 1120 EFX_PHY_CAP_10HDX, 1121 EFX_PHY_CAP_10FDX, 1122 EFX_PHY_CAP_100HDX, 1123 EFX_PHY_CAP_100FDX, 1124 EFX_PHY_CAP_1000HDX, 1125 EFX_PHY_CAP_1000FDX, 1126 EFX_PHY_CAP_10000FDX, 1127 EFX_PHY_CAP_PAUSE, 1128 EFX_PHY_CAP_ASYM, 1129 EFX_PHY_CAP_AN, 1130 EFX_PHY_CAP_40000FDX, 1131 EFX_PHY_CAP_DDM, 1132 EFX_PHY_CAP_100000FDX, 1133 EFX_PHY_CAP_25000FDX, 1134 EFX_PHY_CAP_50000FDX, 1135 EFX_PHY_CAP_BASER_FEC, 1136 EFX_PHY_CAP_BASER_FEC_REQUESTED, 1137 EFX_PHY_CAP_RS_FEC, 1138 EFX_PHY_CAP_RS_FEC_REQUESTED, 1139 EFX_PHY_CAP_25G_BASER_FEC, 1140 EFX_PHY_CAP_25G_BASER_FEC_REQUESTED, 1141 EFX_PHY_CAP_NTYPES 1142 } efx_phy_cap_type_t; 1143 1144 1145 #define EFX_PHY_CAP_CURRENT 0x00000000 1146 #define EFX_PHY_CAP_DEFAULT 0x00000001 1147 #define EFX_PHY_CAP_PERM 0x00000002 1148 1149 LIBEFX_API 1150 extern void 1151 efx_phy_adv_cap_get( 1152 __in efx_nic_t *enp, 1153 __in uint32_t flag, 1154 __out uint32_t *maskp); 1155 1156 LIBEFX_API 1157 extern __checkReturn efx_rc_t 1158 efx_phy_adv_cap_set( 1159 __in efx_nic_t *enp, 1160 __in uint32_t mask); 1161 1162 LIBEFX_API 1163 extern void 1164 efx_phy_lp_cap_get( 1165 __in efx_nic_t *enp, 1166 __out uint32_t *maskp); 1167 1168 LIBEFX_API 1169 extern __checkReturn efx_rc_t 1170 efx_phy_oui_get( 1171 __in efx_nic_t *enp, 1172 __out uint32_t *ouip); 1173 1174 typedef enum efx_phy_media_type_e { 1175 EFX_PHY_MEDIA_INVALID = 0, 1176 EFX_PHY_MEDIA_XAUI, 1177 EFX_PHY_MEDIA_CX4, 1178 EFX_PHY_MEDIA_KX4, 1179 EFX_PHY_MEDIA_XFP, 1180 EFX_PHY_MEDIA_SFP_PLUS, 1181 EFX_PHY_MEDIA_BASE_T, 1182 EFX_PHY_MEDIA_QSFP_PLUS, 1183 EFX_PHY_MEDIA_NTYPES 1184 } efx_phy_media_type_t; 1185 1186 /* 1187 * Get the type of medium currently used. If the board has ports for 1188 * modules, a module is present, and we recognise the media type of 1189 * the module, then this will be the media type of the module. 1190 * Otherwise it will be the media type of the port. 1191 */ 1192 LIBEFX_API 1193 extern void 1194 efx_phy_media_type_get( 1195 __in efx_nic_t *enp, 1196 __out efx_phy_media_type_t *typep); 1197 1198 /* 1199 * 2-wire device address of the base information in accordance with SFF-8472 1200 * Diagnostic Monitoring Interface for Optical Transceivers section 1201 * 4 Memory Organization. 1202 */ 1203 #define EFX_PHY_MEDIA_INFO_DEV_ADDR_SFP_BASE 0xA0 1204 1205 /* 1206 * 2-wire device address of the digital diagnostics monitoring interface 1207 * in accordance with SFF-8472 Diagnostic Monitoring Interface for Optical 1208 * Transceivers section 4 Memory Organization. 1209 */ 1210 #define EFX_PHY_MEDIA_INFO_DEV_ADDR_SFP_DDM 0xA2 1211 1212 /* 1213 * Hard wired 2-wire device address for QSFP+ in accordance with SFF-8436 1214 * QSFP+ 10 Gbs 4X PLUGGABLE TRANSCEIVER section 7.4 Device Addressing and 1215 * Operation. 1216 */ 1217 #define EFX_PHY_MEDIA_INFO_DEV_ADDR_QSFP 0xA0 1218 1219 /* 1220 * Maximum accessible data offset for PHY module information. 1221 */ 1222 #define EFX_PHY_MEDIA_INFO_MAX_OFFSET 0x100 1223 1224 1225 LIBEFX_API 1226 extern __checkReturn efx_rc_t 1227 efx_phy_module_get_info( 1228 __in efx_nic_t *enp, 1229 __in uint8_t dev_addr, 1230 __in size_t offset, 1231 __in size_t len, 1232 __out_bcount(len) uint8_t *data); 1233 1234 #if EFSYS_OPT_PHY_STATS 1235 1236 /* START MKCONFIG GENERATED PhyHeaderStatsBlock 30ed56ad501f8e36 */ 1237 typedef enum efx_phy_stat_e { 1238 EFX_PHY_STAT_OUI, 1239 EFX_PHY_STAT_PMA_PMD_LINK_UP, 1240 EFX_PHY_STAT_PMA_PMD_RX_FAULT, 1241 EFX_PHY_STAT_PMA_PMD_TX_FAULT, 1242 EFX_PHY_STAT_PMA_PMD_REV_A, 1243 EFX_PHY_STAT_PMA_PMD_REV_B, 1244 EFX_PHY_STAT_PMA_PMD_REV_C, 1245 EFX_PHY_STAT_PMA_PMD_REV_D, 1246 EFX_PHY_STAT_PCS_LINK_UP, 1247 EFX_PHY_STAT_PCS_RX_FAULT, 1248 EFX_PHY_STAT_PCS_TX_FAULT, 1249 EFX_PHY_STAT_PCS_BER, 1250 EFX_PHY_STAT_PCS_BLOCK_ERRORS, 1251 EFX_PHY_STAT_PHY_XS_LINK_UP, 1252 EFX_PHY_STAT_PHY_XS_RX_FAULT, 1253 EFX_PHY_STAT_PHY_XS_TX_FAULT, 1254 EFX_PHY_STAT_PHY_XS_ALIGN, 1255 EFX_PHY_STAT_PHY_XS_SYNC_A, 1256 EFX_PHY_STAT_PHY_XS_SYNC_B, 1257 EFX_PHY_STAT_PHY_XS_SYNC_C, 1258 EFX_PHY_STAT_PHY_XS_SYNC_D, 1259 EFX_PHY_STAT_AN_LINK_UP, 1260 EFX_PHY_STAT_AN_MASTER, 1261 EFX_PHY_STAT_AN_LOCAL_RX_OK, 1262 EFX_PHY_STAT_AN_REMOTE_RX_OK, 1263 EFX_PHY_STAT_CL22EXT_LINK_UP, 1264 EFX_PHY_STAT_SNR_A, 1265 EFX_PHY_STAT_SNR_B, 1266 EFX_PHY_STAT_SNR_C, 1267 EFX_PHY_STAT_SNR_D, 1268 EFX_PHY_STAT_PMA_PMD_SIGNAL_A, 1269 EFX_PHY_STAT_PMA_PMD_SIGNAL_B, 1270 EFX_PHY_STAT_PMA_PMD_SIGNAL_C, 1271 EFX_PHY_STAT_PMA_PMD_SIGNAL_D, 1272 EFX_PHY_STAT_AN_COMPLETE, 1273 EFX_PHY_STAT_PMA_PMD_REV_MAJOR, 1274 EFX_PHY_STAT_PMA_PMD_REV_MINOR, 1275 EFX_PHY_STAT_PMA_PMD_REV_MICRO, 1276 EFX_PHY_STAT_PCS_FW_VERSION_0, 1277 EFX_PHY_STAT_PCS_FW_VERSION_1, 1278 EFX_PHY_STAT_PCS_FW_VERSION_2, 1279 EFX_PHY_STAT_PCS_FW_VERSION_3, 1280 EFX_PHY_STAT_PCS_FW_BUILD_YY, 1281 EFX_PHY_STAT_PCS_FW_BUILD_MM, 1282 EFX_PHY_STAT_PCS_FW_BUILD_DD, 1283 EFX_PHY_STAT_PCS_OP_MODE, 1284 EFX_PHY_NSTATS 1285 } efx_phy_stat_t; 1286 1287 /* END MKCONFIG GENERATED PhyHeaderStatsBlock */ 1288 1289 #if EFSYS_OPT_NAMES 1290 1291 LIBEFX_API 1292 extern const char * 1293 efx_phy_stat_name( 1294 __in efx_nic_t *enp, 1295 __in efx_phy_stat_t stat); 1296 1297 #endif /* EFSYS_OPT_NAMES */ 1298 1299 #define EFX_PHY_STATS_SIZE 0x100 1300 1301 LIBEFX_API 1302 extern __checkReturn efx_rc_t 1303 efx_phy_stats_update( 1304 __in efx_nic_t *enp, 1305 __in efsys_mem_t *esmp, 1306 __inout_ecount(EFX_PHY_NSTATS) uint32_t *stat); 1307 1308 #endif /* EFSYS_OPT_PHY_STATS */ 1309 1310 1311 #if EFSYS_OPT_BIST 1312 1313 typedef enum efx_bist_type_e { 1314 EFX_BIST_TYPE_UNKNOWN, 1315 EFX_BIST_TYPE_PHY_NORMAL, 1316 EFX_BIST_TYPE_PHY_CABLE_SHORT, 1317 EFX_BIST_TYPE_PHY_CABLE_LONG, 1318 EFX_BIST_TYPE_MC_MEM, /* Test the MC DMEM and IMEM */ 1319 EFX_BIST_TYPE_SAT_MEM, /* Test the DMEM and IMEM of satellite cpus */ 1320 EFX_BIST_TYPE_REG, /* Test the register memories */ 1321 EFX_BIST_TYPE_NTYPES, 1322 } efx_bist_type_t; 1323 1324 typedef enum efx_bist_result_e { 1325 EFX_BIST_RESULT_UNKNOWN, 1326 EFX_BIST_RESULT_RUNNING, 1327 EFX_BIST_RESULT_PASSED, 1328 EFX_BIST_RESULT_FAILED, 1329 } efx_bist_result_t; 1330 1331 typedef enum efx_phy_cable_status_e { 1332 EFX_PHY_CABLE_STATUS_OK, 1333 EFX_PHY_CABLE_STATUS_INVALID, 1334 EFX_PHY_CABLE_STATUS_OPEN, 1335 EFX_PHY_CABLE_STATUS_INTRAPAIRSHORT, 1336 EFX_PHY_CABLE_STATUS_INTERPAIRSHORT, 1337 EFX_PHY_CABLE_STATUS_BUSY, 1338 } efx_phy_cable_status_t; 1339 1340 typedef enum efx_bist_value_e { 1341 EFX_BIST_PHY_CABLE_LENGTH_A, 1342 EFX_BIST_PHY_CABLE_LENGTH_B, 1343 EFX_BIST_PHY_CABLE_LENGTH_C, 1344 EFX_BIST_PHY_CABLE_LENGTH_D, 1345 EFX_BIST_PHY_CABLE_STATUS_A, 1346 EFX_BIST_PHY_CABLE_STATUS_B, 1347 EFX_BIST_PHY_CABLE_STATUS_C, 1348 EFX_BIST_PHY_CABLE_STATUS_D, 1349 EFX_BIST_FAULT_CODE, 1350 /* 1351 * Memory BIST specific values. These match to the MC_CMD_BIST_POLL 1352 * response. 1353 */ 1354 EFX_BIST_MEM_TEST, 1355 EFX_BIST_MEM_ADDR, 1356 EFX_BIST_MEM_BUS, 1357 EFX_BIST_MEM_EXPECT, 1358 EFX_BIST_MEM_ACTUAL, 1359 EFX_BIST_MEM_ECC, 1360 EFX_BIST_MEM_ECC_PARITY, 1361 EFX_BIST_MEM_ECC_FATAL, 1362 EFX_BIST_NVALUES, 1363 } efx_bist_value_t; 1364 1365 LIBEFX_API 1366 extern __checkReturn efx_rc_t 1367 efx_bist_enable_offline( 1368 __in efx_nic_t *enp); 1369 1370 LIBEFX_API 1371 extern __checkReturn efx_rc_t 1372 efx_bist_start( 1373 __in efx_nic_t *enp, 1374 __in efx_bist_type_t type); 1375 1376 LIBEFX_API 1377 extern __checkReturn efx_rc_t 1378 efx_bist_poll( 1379 __in efx_nic_t *enp, 1380 __in efx_bist_type_t type, 1381 __out efx_bist_result_t *resultp, 1382 __out_opt uint32_t *value_maskp, 1383 __out_ecount_opt(count) unsigned long *valuesp, 1384 __in size_t count); 1385 1386 LIBEFX_API 1387 extern void 1388 efx_bist_stop( 1389 __in efx_nic_t *enp, 1390 __in efx_bist_type_t type); 1391 1392 #endif /* EFSYS_OPT_BIST */ 1393 1394 #define EFX_FEATURE_IPV6 0x00000001 1395 #define EFX_FEATURE_LFSR_HASH_INSERT 0x00000002 1396 #define EFX_FEATURE_LINK_EVENTS 0x00000004 1397 #define EFX_FEATURE_PERIODIC_MAC_STATS 0x00000008 1398 #define EFX_FEATURE_MCDI 0x00000020 1399 #define EFX_FEATURE_LOOKAHEAD_SPLIT 0x00000040 1400 #define EFX_FEATURE_MAC_HEADER_FILTERS 0x00000080 1401 #define EFX_FEATURE_TURBO 0x00000100 1402 #define EFX_FEATURE_MCDI_DMA 0x00000200 1403 #define EFX_FEATURE_TX_SRC_FILTERS 0x00000400 1404 #define EFX_FEATURE_PIO_BUFFERS 0x00000800 1405 #define EFX_FEATURE_FW_ASSISTED_TSO 0x00001000 1406 #define EFX_FEATURE_FW_ASSISTED_TSO_V2 0x00002000 1407 #define EFX_FEATURE_PACKED_STREAM 0x00004000 1408 #define EFX_FEATURE_TXQ_CKSUM_OP_DESC 0x00008000 1409 1410 typedef enum efx_tunnel_protocol_e { 1411 EFX_TUNNEL_PROTOCOL_NONE = 0, 1412 EFX_TUNNEL_PROTOCOL_VXLAN, 1413 EFX_TUNNEL_PROTOCOL_GENEVE, 1414 EFX_TUNNEL_PROTOCOL_NVGRE, 1415 EFX_TUNNEL_NPROTOS 1416 } efx_tunnel_protocol_t; 1417 1418 typedef enum efx_vi_window_shift_e { 1419 EFX_VI_WINDOW_SHIFT_INVALID = 0, 1420 EFX_VI_WINDOW_SHIFT_8K = 13, 1421 EFX_VI_WINDOW_SHIFT_16K = 14, 1422 EFX_VI_WINDOW_SHIFT_64K = 16, 1423 } efx_vi_window_shift_t; 1424 1425 typedef struct efx_nic_cfg_s { 1426 uint32_t enc_board_type; 1427 uint32_t enc_phy_type; 1428 #if EFSYS_OPT_NAMES 1429 char enc_phy_name[21]; 1430 #endif 1431 char enc_phy_revision[21]; 1432 efx_mon_type_t enc_mon_type; 1433 #if EFSYS_OPT_MON_STATS 1434 uint32_t enc_mon_stat_dma_buf_size; 1435 uint32_t enc_mon_stat_mask[(EFX_MON_NSTATS + 31) / 32]; 1436 #endif 1437 unsigned int enc_features; 1438 efx_vi_window_shift_t enc_vi_window_shift; 1439 uint8_t enc_mac_addr[6]; 1440 uint8_t enc_port; /* PHY port number */ 1441 uint32_t enc_intr_vec_base; 1442 uint32_t enc_intr_limit; 1443 uint32_t enc_evq_limit; 1444 uint32_t enc_txq_limit; 1445 uint32_t enc_rxq_limit; 1446 uint32_t enc_evq_max_nevs; 1447 uint32_t enc_evq_min_nevs; 1448 uint32_t enc_rxq_max_ndescs; 1449 uint32_t enc_rxq_min_ndescs; 1450 uint32_t enc_txq_max_ndescs; 1451 uint32_t enc_txq_min_ndescs; 1452 uint32_t enc_buftbl_limit; 1453 uint32_t enc_piobuf_limit; 1454 uint32_t enc_piobuf_size; 1455 uint32_t enc_piobuf_min_alloc_size; 1456 uint32_t enc_evq_timer_quantum_ns; 1457 uint32_t enc_evq_timer_max_us; 1458 uint32_t enc_clk_mult; 1459 uint32_t enc_ev_ew_desc_size; 1460 uint32_t enc_ev_desc_size; 1461 uint32_t enc_rx_desc_size; 1462 uint32_t enc_tx_desc_size; 1463 /* Maximum Rx prefix size if many Rx prefixes are supported */ 1464 uint32_t enc_rx_prefix_size; 1465 uint32_t enc_rx_buf_align_start; 1466 uint32_t enc_rx_buf_align_end; 1467 #if EFSYS_OPT_RX_SCALE 1468 uint32_t enc_rx_scale_max_exclusive_contexts; 1469 /* 1470 * Mask of supported hash algorithms. 1471 * Hash algorithm types are used as the bit indices. 1472 */ 1473 uint32_t enc_rx_scale_hash_alg_mask; 1474 /* 1475 * Indicates whether port numbers can be included to the 1476 * input data for hash computation. 1477 */ 1478 boolean_t enc_rx_scale_l4_hash_supported; 1479 boolean_t enc_rx_scale_additional_modes_supported; 1480 #endif /* EFSYS_OPT_RX_SCALE */ 1481 #if EFSYS_OPT_LOOPBACK 1482 efx_qword_t enc_loopback_types[EFX_LINK_NMODES]; 1483 #endif /* EFSYS_OPT_LOOPBACK */ 1484 #if EFSYS_OPT_PHY_FLAGS 1485 uint32_t enc_phy_flags_mask; 1486 #endif /* EFSYS_OPT_PHY_FLAGS */ 1487 #if EFSYS_OPT_PHY_LED_CONTROL 1488 uint32_t enc_led_mask; 1489 #endif /* EFSYS_OPT_PHY_LED_CONTROL */ 1490 #if EFSYS_OPT_PHY_STATS 1491 uint64_t enc_phy_stat_mask; 1492 #endif /* EFSYS_OPT_PHY_STATS */ 1493 #if EFSYS_OPT_MCDI 1494 uint8_t enc_mcdi_mdio_channel; 1495 #if EFSYS_OPT_PHY_STATS 1496 uint32_t enc_mcdi_phy_stat_mask; 1497 #endif /* EFSYS_OPT_PHY_STATS */ 1498 #if EFSYS_OPT_MON_STATS 1499 uint32_t *enc_mcdi_sensor_maskp; 1500 uint32_t enc_mcdi_sensor_mask_size; 1501 #endif /* EFSYS_OPT_MON_STATS */ 1502 #endif /* EFSYS_OPT_MCDI */ 1503 #if EFSYS_OPT_BIST 1504 uint32_t enc_bist_mask; 1505 #endif /* EFSYS_OPT_BIST */ 1506 #if EFSYS_OPT_RIVERHEAD || EFX_OPTS_EF10() 1507 uint32_t enc_pf; 1508 uint32_t enc_vf; 1509 uint32_t enc_privilege_mask; 1510 #endif /* EFSYS_OPT_RIVERHEAD || EFX_OPTS_EF10() */ 1511 boolean_t enc_evq_init_done_ev_supported; 1512 boolean_t enc_bug26807_workaround; 1513 boolean_t enc_bug35388_workaround; 1514 boolean_t enc_bug41750_workaround; 1515 boolean_t enc_bug61265_workaround; 1516 boolean_t enc_bug61297_workaround; 1517 boolean_t enc_rx_batching_enabled; 1518 /* Maximum number of descriptors completed in an rx event. */ 1519 uint32_t enc_rx_batch_max; 1520 /* Number of rx descriptors the hardware requires for a push. */ 1521 uint32_t enc_rx_push_align; 1522 /* Maximum amount of data in DMA descriptor */ 1523 uint32_t enc_tx_dma_desc_size_max; 1524 /* 1525 * Boundary which DMA descriptor data must not cross or 0 if no 1526 * limitation. 1527 */ 1528 uint32_t enc_tx_dma_desc_boundary; 1529 /* 1530 * Maximum number of bytes into the packet the TCP header can start for 1531 * the hardware to apply TSO packet edits. 1532 */ 1533 uint32_t enc_tx_tso_tcp_header_offset_limit; 1534 /* Maximum number of header DMA descriptors per TSO transaction. */ 1535 uint32_t enc_tx_tso_max_header_ndescs; 1536 /* Maximum header length acceptable by TSO transaction. */ 1537 uint32_t enc_tx_tso_max_header_length; 1538 /* Maximum number of payload DMA descriptors per TSO transaction. */ 1539 uint32_t enc_tx_tso_max_payload_ndescs; 1540 /* Maximum payload length per TSO transaction. */ 1541 uint32_t enc_tx_tso_max_payload_length; 1542 /* Maximum number of frames to be generated per TSO transaction. */ 1543 uint32_t enc_tx_tso_max_nframes; 1544 boolean_t enc_fw_assisted_tso_enabled; 1545 boolean_t enc_fw_assisted_tso_v2_enabled; 1546 boolean_t enc_fw_assisted_tso_v2_encap_enabled; 1547 boolean_t enc_tso_v3_enabled; 1548 /* Number of TSO contexts on the NIC (FATSOv2) */ 1549 uint32_t enc_fw_assisted_tso_v2_n_contexts; 1550 boolean_t enc_hw_tx_insert_vlan_enabled; 1551 /* Number of PFs on the NIC */ 1552 uint32_t enc_hw_pf_count; 1553 /* Datapath firmware vadapter/vport/vswitch support */ 1554 boolean_t enc_datapath_cap_evb; 1555 /* Datapath firmware vport reconfigure support */ 1556 boolean_t enc_vport_reconfigure_supported; 1557 boolean_t enc_rx_disable_scatter_supported; 1558 /* Maximum number of Rx scatter segments supported by HW */ 1559 uint32_t enc_rx_scatter_max; 1560 boolean_t enc_allow_set_mac_with_installed_filters; 1561 boolean_t enc_enhanced_set_mac_supported; 1562 boolean_t enc_init_evq_v2_supported; 1563 boolean_t enc_init_evq_extended_width_supported; 1564 boolean_t enc_no_cont_ev_mode_supported; 1565 boolean_t enc_init_rxq_with_buffer_size; 1566 boolean_t enc_rx_packed_stream_supported; 1567 boolean_t enc_rx_var_packed_stream_supported; 1568 boolean_t enc_rx_es_super_buffer_supported; 1569 boolean_t enc_fw_subvariant_no_tx_csum_supported; 1570 boolean_t enc_pm_and_rxdp_counters; 1571 boolean_t enc_mac_stats_40g_tx_size_bins; 1572 uint32_t enc_tunnel_encapsulations_supported; 1573 /* 1574 * NIC global maximum for unique UDP tunnel ports shared by all 1575 * functions. 1576 */ 1577 uint32_t enc_tunnel_config_udp_entries_max; 1578 /* External port identifier */ 1579 uint8_t enc_external_port; 1580 uint32_t enc_mcdi_max_payload_length; 1581 /* VPD may be per-PF or global */ 1582 boolean_t enc_vpd_is_global; 1583 /* Minimum unidirectional bandwidth in Mb/s to max out all ports */ 1584 uint32_t enc_required_pcie_bandwidth_mbps; 1585 uint32_t enc_max_pcie_link_gen; 1586 /* Firmware verifies integrity of NVRAM updates */ 1587 boolean_t enc_nvram_update_verify_result_supported; 1588 /* Firmware supports polled NVRAM updates on select partitions */ 1589 boolean_t enc_nvram_update_poll_verify_result_supported; 1590 /* Firmware accepts updates via the BUNDLE partition */ 1591 boolean_t enc_nvram_bundle_update_supported; 1592 /* Firmware support for extended MAC_STATS buffer */ 1593 uint32_t enc_mac_stats_nstats; 1594 boolean_t enc_fec_counters; 1595 boolean_t enc_hlb_counters; 1596 /* NIC support for Match-Action Engine (MAE). */ 1597 boolean_t enc_mae_supported; 1598 /* Firmware support for "FLAG" and "MARK" filter actions */ 1599 boolean_t enc_filter_action_flag_supported; 1600 boolean_t enc_filter_action_mark_supported; 1601 uint32_t enc_filter_action_mark_max; 1602 /* Port assigned to this PCI function */ 1603 uint32_t enc_assigned_port; 1604 } efx_nic_cfg_t; 1605 1606 #define EFX_PCI_VF_INVALID 0xffff 1607 1608 #define EFX_VPORT_PCI_FUNCTION_IS_PF(configp) \ 1609 ((configp)->evc_function == EFX_PCI_VF_INVALID) 1610 1611 #define EFX_PCI_FUNCTION_IS_PF(_encp) ((_encp)->enc_vf == EFX_PCI_VF_INVALID) 1612 #define EFX_PCI_FUNCTION_IS_VF(_encp) ((_encp)->enc_vf != EFX_PCI_VF_INVALID) 1613 1614 #define EFX_PCI_FUNCTION(_encp) \ 1615 (EFX_PCI_FUNCTION_IS_PF(_encp) ? (_encp)->enc_pf : (_encp)->enc_vf) 1616 1617 #define EFX_PCI_VF_PARENT(_encp) ((_encp)->enc_pf) 1618 1619 LIBEFX_API 1620 extern const efx_nic_cfg_t * 1621 efx_nic_cfg_get( 1622 __in const efx_nic_t *enp); 1623 1624 /* RxDPCPU firmware id values by which FW variant can be identified */ 1625 #define EFX_RXDP_FULL_FEATURED_FW_ID 0x0 1626 #define EFX_RXDP_LOW_LATENCY_FW_ID 0x1 1627 #define EFX_RXDP_PACKED_STREAM_FW_ID 0x2 1628 #define EFX_RXDP_RULES_ENGINE_FW_ID 0x5 1629 #define EFX_RXDP_DPDK_FW_ID 0x6 1630 1631 typedef struct efx_nic_fw_info_s { 1632 /* Basic FW version information */ 1633 uint16_t enfi_mc_fw_version[4]; 1634 /* 1635 * If datapath capabilities can be detected, 1636 * additional FW information is to be shown 1637 */ 1638 boolean_t enfi_dpcpu_fw_ids_valid; 1639 /* Rx and Tx datapath CPU FW IDs */ 1640 uint16_t enfi_rx_dpcpu_fw_id; 1641 uint16_t enfi_tx_dpcpu_fw_id; 1642 } efx_nic_fw_info_t; 1643 1644 LIBEFX_API 1645 extern __checkReturn efx_rc_t 1646 efx_nic_get_fw_version( 1647 __in efx_nic_t *enp, 1648 __out efx_nic_fw_info_t *enfip); 1649 1650 #define EFX_NIC_BOARD_INFO_SERIAL_LEN (64) 1651 #define EFX_NIC_BOARD_INFO_NAME_LEN (16) 1652 1653 typedef struct efx_nic_board_info_s { 1654 /* The following two fields are NUL-terminated ASCII strings. */ 1655 char enbi_serial[EFX_NIC_BOARD_INFO_SERIAL_LEN]; 1656 char enbi_name[EFX_NIC_BOARD_INFO_NAME_LEN]; 1657 uint32_t enbi_revision; 1658 } efx_nic_board_info_t; 1659 1660 LIBEFX_API 1661 extern __checkReturn efx_rc_t 1662 efx_nic_get_board_info( 1663 __in efx_nic_t *enp, 1664 __out efx_nic_board_info_t *board_infop); 1665 1666 /* Driver resource limits (minimum required/maximum usable). */ 1667 typedef struct efx_drv_limits_s { 1668 uint32_t edl_min_evq_count; 1669 uint32_t edl_max_evq_count; 1670 1671 uint32_t edl_min_rxq_count; 1672 uint32_t edl_max_rxq_count; 1673 1674 uint32_t edl_min_txq_count; 1675 uint32_t edl_max_txq_count; 1676 1677 /* PIO blocks (sub-allocated from piobuf) */ 1678 uint32_t edl_min_pio_alloc_size; 1679 uint32_t edl_max_pio_alloc_count; 1680 } efx_drv_limits_t; 1681 1682 LIBEFX_API 1683 extern __checkReturn efx_rc_t 1684 efx_nic_set_drv_limits( 1685 __inout efx_nic_t *enp, 1686 __in efx_drv_limits_t *edlp); 1687 1688 /* 1689 * Register the OS driver version string for management agents 1690 * (e.g. via NC-SI). The content length is provided (i.e. no 1691 * NUL terminator). Use length 0 to indicate no version string 1692 * should be advertised. It is valid to set the version string 1693 * only before efx_nic_probe() is called. 1694 */ 1695 LIBEFX_API 1696 extern __checkReturn efx_rc_t 1697 efx_nic_set_drv_version( 1698 __inout efx_nic_t *enp, 1699 __in_ecount(length) char const *verp, 1700 __in size_t length); 1701 1702 typedef enum efx_nic_region_e { 1703 EFX_REGION_VI, /* Memory BAR UC mapping */ 1704 EFX_REGION_PIO_WRITE_VI, /* Memory BAR WC mapping */ 1705 } efx_nic_region_t; 1706 1707 LIBEFX_API 1708 extern __checkReturn efx_rc_t 1709 efx_nic_get_bar_region( 1710 __in efx_nic_t *enp, 1711 __in efx_nic_region_t region, 1712 __out uint32_t *offsetp, 1713 __out size_t *sizep); 1714 1715 LIBEFX_API 1716 extern __checkReturn efx_rc_t 1717 efx_nic_get_vi_pool( 1718 __in efx_nic_t *enp, 1719 __out uint32_t *evq_countp, 1720 __out uint32_t *rxq_countp, 1721 __out uint32_t *txq_countp); 1722 1723 1724 #if EFSYS_OPT_VPD 1725 1726 typedef enum efx_vpd_tag_e { 1727 EFX_VPD_ID = 0x02, 1728 EFX_VPD_END = 0x0f, 1729 EFX_VPD_RO = 0x10, 1730 EFX_VPD_RW = 0x11, 1731 } efx_vpd_tag_t; 1732 1733 typedef uint16_t efx_vpd_keyword_t; 1734 1735 typedef struct efx_vpd_value_s { 1736 efx_vpd_tag_t evv_tag; 1737 efx_vpd_keyword_t evv_keyword; 1738 uint8_t evv_length; 1739 uint8_t evv_value[0x100]; 1740 } efx_vpd_value_t; 1741 1742 1743 #define EFX_VPD_KEYWORD(x, y) ((x) | ((y) << 8)) 1744 1745 LIBEFX_API 1746 extern __checkReturn efx_rc_t 1747 efx_vpd_init( 1748 __in efx_nic_t *enp); 1749 1750 LIBEFX_API 1751 extern __checkReturn efx_rc_t 1752 efx_vpd_size( 1753 __in efx_nic_t *enp, 1754 __out size_t *sizep); 1755 1756 LIBEFX_API 1757 extern __checkReturn efx_rc_t 1758 efx_vpd_read( 1759 __in efx_nic_t *enp, 1760 __out_bcount(size) caddr_t data, 1761 __in size_t size); 1762 1763 LIBEFX_API 1764 extern __checkReturn efx_rc_t 1765 efx_vpd_verify( 1766 __in efx_nic_t *enp, 1767 __in_bcount(size) caddr_t data, 1768 __in size_t size); 1769 1770 LIBEFX_API 1771 extern __checkReturn efx_rc_t 1772 efx_vpd_reinit( 1773 __in efx_nic_t *enp, 1774 __in_bcount(size) caddr_t data, 1775 __in size_t size); 1776 1777 LIBEFX_API 1778 extern __checkReturn efx_rc_t 1779 efx_vpd_get( 1780 __in efx_nic_t *enp, 1781 __in_bcount(size) caddr_t data, 1782 __in size_t size, 1783 __inout efx_vpd_value_t *evvp); 1784 1785 LIBEFX_API 1786 extern __checkReturn efx_rc_t 1787 efx_vpd_set( 1788 __in efx_nic_t *enp, 1789 __inout_bcount(size) caddr_t data, 1790 __in size_t size, 1791 __in efx_vpd_value_t *evvp); 1792 1793 LIBEFX_API 1794 extern __checkReturn efx_rc_t 1795 efx_vpd_next( 1796 __in efx_nic_t *enp, 1797 __inout_bcount(size) caddr_t data, 1798 __in size_t size, 1799 __out efx_vpd_value_t *evvp, 1800 __inout unsigned int *contp); 1801 1802 LIBEFX_API 1803 extern __checkReturn efx_rc_t 1804 efx_vpd_write( 1805 __in efx_nic_t *enp, 1806 __in_bcount(size) caddr_t data, 1807 __in size_t size); 1808 1809 LIBEFX_API 1810 extern void 1811 efx_vpd_fini( 1812 __in efx_nic_t *enp); 1813 1814 #endif /* EFSYS_OPT_VPD */ 1815 1816 /* NVRAM */ 1817 1818 #if EFSYS_OPT_NVRAM 1819 1820 typedef enum efx_nvram_type_e { 1821 EFX_NVRAM_INVALID = 0, 1822 EFX_NVRAM_BOOTROM, 1823 EFX_NVRAM_BOOTROM_CFG, 1824 EFX_NVRAM_MC_FIRMWARE, 1825 EFX_NVRAM_MC_GOLDEN, 1826 EFX_NVRAM_PHY, 1827 EFX_NVRAM_NULLPHY, 1828 EFX_NVRAM_FPGA, 1829 EFX_NVRAM_FCFW, 1830 EFX_NVRAM_CPLD, 1831 EFX_NVRAM_FPGA_BACKUP, 1832 EFX_NVRAM_DYNAMIC_CFG, 1833 EFX_NVRAM_LICENSE, 1834 EFX_NVRAM_UEFIROM, 1835 EFX_NVRAM_MUM_FIRMWARE, 1836 EFX_NVRAM_DYNCONFIG_DEFAULTS, 1837 EFX_NVRAM_ROMCONFIG_DEFAULTS, 1838 EFX_NVRAM_BUNDLE, 1839 EFX_NVRAM_BUNDLE_METADATA, 1840 EFX_NVRAM_NTYPES, 1841 } efx_nvram_type_t; 1842 1843 typedef struct efx_nvram_info_s { 1844 uint32_t eni_flags; 1845 uint32_t eni_partn_size; 1846 uint32_t eni_address; 1847 uint32_t eni_erase_size; 1848 uint32_t eni_write_size; 1849 } efx_nvram_info_t; 1850 1851 #define EFX_NVRAM_FLAG_READ_ONLY (1 << 0) 1852 1853 LIBEFX_API 1854 extern __checkReturn efx_rc_t 1855 efx_nvram_init( 1856 __in efx_nic_t *enp); 1857 1858 #if EFSYS_OPT_DIAG 1859 1860 LIBEFX_API 1861 extern __checkReturn efx_rc_t 1862 efx_nvram_test( 1863 __in efx_nic_t *enp); 1864 1865 #endif /* EFSYS_OPT_DIAG */ 1866 1867 LIBEFX_API 1868 extern __checkReturn efx_rc_t 1869 efx_nvram_size( 1870 __in efx_nic_t *enp, 1871 __in efx_nvram_type_t type, 1872 __out size_t *sizep); 1873 1874 LIBEFX_API 1875 extern __checkReturn efx_rc_t 1876 efx_nvram_info( 1877 __in efx_nic_t *enp, 1878 __in efx_nvram_type_t type, 1879 __out efx_nvram_info_t *enip); 1880 1881 LIBEFX_API 1882 extern __checkReturn efx_rc_t 1883 efx_nvram_rw_start( 1884 __in efx_nic_t *enp, 1885 __in efx_nvram_type_t type, 1886 __out_opt size_t *pref_chunkp); 1887 1888 LIBEFX_API 1889 extern __checkReturn efx_rc_t 1890 efx_nvram_rw_finish( 1891 __in efx_nic_t *enp, 1892 __in efx_nvram_type_t type, 1893 __out_opt uint32_t *verify_resultp); 1894 1895 LIBEFX_API 1896 extern __checkReturn efx_rc_t 1897 efx_nvram_get_version( 1898 __in efx_nic_t *enp, 1899 __in efx_nvram_type_t type, 1900 __out uint32_t *subtypep, 1901 __out_ecount(4) uint16_t version[4]); 1902 1903 LIBEFX_API 1904 extern __checkReturn efx_rc_t 1905 efx_nvram_read_chunk( 1906 __in efx_nic_t *enp, 1907 __in efx_nvram_type_t type, 1908 __in unsigned int offset, 1909 __out_bcount(size) caddr_t data, 1910 __in size_t size); 1911 1912 LIBEFX_API 1913 extern __checkReturn efx_rc_t 1914 efx_nvram_read_backup( 1915 __in efx_nic_t *enp, 1916 __in efx_nvram_type_t type, 1917 __in unsigned int offset, 1918 __out_bcount(size) caddr_t data, 1919 __in size_t size); 1920 1921 LIBEFX_API 1922 extern __checkReturn efx_rc_t 1923 efx_nvram_set_version( 1924 __in efx_nic_t *enp, 1925 __in efx_nvram_type_t type, 1926 __in_ecount(4) uint16_t version[4]); 1927 1928 LIBEFX_API 1929 extern __checkReturn efx_rc_t 1930 efx_nvram_validate( 1931 __in efx_nic_t *enp, 1932 __in efx_nvram_type_t type, 1933 __in_bcount(partn_size) caddr_t partn_data, 1934 __in size_t partn_size); 1935 1936 LIBEFX_API 1937 extern __checkReturn efx_rc_t 1938 efx_nvram_erase( 1939 __in efx_nic_t *enp, 1940 __in efx_nvram_type_t type); 1941 1942 LIBEFX_API 1943 extern __checkReturn efx_rc_t 1944 efx_nvram_write_chunk( 1945 __in efx_nic_t *enp, 1946 __in efx_nvram_type_t type, 1947 __in unsigned int offset, 1948 __in_bcount(size) caddr_t data, 1949 __in size_t size); 1950 1951 LIBEFX_API 1952 extern void 1953 efx_nvram_fini( 1954 __in efx_nic_t *enp); 1955 1956 #endif /* EFSYS_OPT_NVRAM */ 1957 1958 #if EFSYS_OPT_BOOTCFG 1959 1960 /* Report size and offset of bootcfg sector in NVRAM partition. */ 1961 LIBEFX_API 1962 extern __checkReturn efx_rc_t 1963 efx_bootcfg_sector_info( 1964 __in efx_nic_t *enp, 1965 __in uint32_t pf, 1966 __out_opt uint32_t *sector_countp, 1967 __out size_t *offsetp, 1968 __out size_t *max_sizep); 1969 1970 /* 1971 * Copy bootcfg sector data to a target buffer which may differ in size. 1972 * Optionally corrects format errors in source buffer. 1973 */ 1974 LIBEFX_API 1975 extern efx_rc_t 1976 efx_bootcfg_copy_sector( 1977 __in efx_nic_t *enp, 1978 __inout_bcount(sector_length) 1979 uint8_t *sector, 1980 __in size_t sector_length, 1981 __out_bcount(data_size) uint8_t *data, 1982 __in size_t data_size, 1983 __in boolean_t handle_format_errors); 1984 1985 LIBEFX_API 1986 extern efx_rc_t 1987 efx_bootcfg_read( 1988 __in efx_nic_t *enp, 1989 __out_bcount(size) uint8_t *data, 1990 __in size_t size); 1991 1992 LIBEFX_API 1993 extern efx_rc_t 1994 efx_bootcfg_write( 1995 __in efx_nic_t *enp, 1996 __in_bcount(size) uint8_t *data, 1997 __in size_t size); 1998 1999 2000 /* 2001 * Processing routines for buffers arranged in the DHCP/BOOTP option format 2002 * (see https://tools.ietf.org/html/rfc1533) 2003 * 2004 * Summarising the format: the buffer is a sequence of options. All options 2005 * begin with a tag octet, which uniquely identifies the option. Fixed- 2006 * length options without data consist of only a tag octet. Only options PAD 2007 * (0) and END (255) are fixed length. All other options are variable-length 2008 * with a length octet following the tag octet. The value of the length 2009 * octet does not include the two octets specifying the tag and length. The 2010 * length octet is followed by "length" octets of data. 2011 * 2012 * Option data may be a sequence of sub-options in the same format. The data 2013 * content of the encapsulating option is one or more encapsulated sub-options, 2014 * with no terminating END tag is required. 2015 * 2016 * To be valid, the top-level sequence of options should be terminated by an 2017 * END tag. The buffer should be padded with the PAD byte. 2018 * 2019 * When stored to NVRAM, the DHCP option format buffer is preceded by a 2020 * checksum octet. The full buffer (including after the END tag) contributes 2021 * to the checksum, hence the need to fill the buffer to the end with PAD. 2022 */ 2023 2024 #define EFX_DHCP_END ((uint8_t)0xff) 2025 #define EFX_DHCP_PAD ((uint8_t)0) 2026 2027 #define EFX_DHCP_ENCAP_OPT(encapsulator, encapsulated) \ 2028 (uint16_t)(((encapsulator) << 8) | (encapsulated)) 2029 2030 LIBEFX_API 2031 extern __checkReturn uint8_t 2032 efx_dhcp_csum( 2033 __in_bcount(size) uint8_t const *data, 2034 __in size_t size); 2035 2036 LIBEFX_API 2037 extern __checkReturn efx_rc_t 2038 efx_dhcp_verify( 2039 __in_bcount(size) uint8_t const *data, 2040 __in size_t size, 2041 __out_opt size_t *usedp); 2042 2043 LIBEFX_API 2044 extern __checkReturn efx_rc_t 2045 efx_dhcp_find_tag( 2046 __in_bcount(buffer_length) uint8_t *bufferp, 2047 __in size_t buffer_length, 2048 __in uint16_t opt, 2049 __deref_out uint8_t **valuepp, 2050 __out size_t *value_lengthp); 2051 2052 LIBEFX_API 2053 extern __checkReturn efx_rc_t 2054 efx_dhcp_find_end( 2055 __in_bcount(buffer_length) uint8_t *bufferp, 2056 __in size_t buffer_length, 2057 __deref_out uint8_t **endpp); 2058 2059 2060 LIBEFX_API 2061 extern __checkReturn efx_rc_t 2062 efx_dhcp_delete_tag( 2063 __inout_bcount(buffer_length) uint8_t *bufferp, 2064 __in size_t buffer_length, 2065 __in uint16_t opt); 2066 2067 LIBEFX_API 2068 extern __checkReturn efx_rc_t 2069 efx_dhcp_add_tag( 2070 __inout_bcount(buffer_length) uint8_t *bufferp, 2071 __in size_t buffer_length, 2072 __in uint16_t opt, 2073 __in_bcount_opt(value_length) uint8_t *valuep, 2074 __in size_t value_length); 2075 2076 LIBEFX_API 2077 extern __checkReturn efx_rc_t 2078 efx_dhcp_update_tag( 2079 __inout_bcount(buffer_length) uint8_t *bufferp, 2080 __in size_t buffer_length, 2081 __in uint16_t opt, 2082 __in uint8_t *value_locationp, 2083 __in_bcount_opt(value_length) uint8_t *valuep, 2084 __in size_t value_length); 2085 2086 2087 #endif /* EFSYS_OPT_BOOTCFG */ 2088 2089 #if EFSYS_OPT_IMAGE_LAYOUT 2090 2091 #include "ef10_signed_image_layout.h" 2092 2093 /* 2094 * Image header used in unsigned and signed image layouts (see SF-102785-PS). 2095 * 2096 * NOTE: 2097 * The image header format is extensible. However, older drivers require an 2098 * exact match of image header version and header length when validating and 2099 * writing firmware images. 2100 * 2101 * To avoid breaking backward compatibility, we use the upper bits of the 2102 * controller version fields to contain an extra version number used for 2103 * combined bootROM and UEFI ROM images on EF10 and later (to hold the UEFI ROM 2104 * version). See bug39254 and SF-102785-PS for details. 2105 */ 2106 typedef struct efx_image_header_s { 2107 uint32_t eih_magic; 2108 uint32_t eih_version; 2109 uint32_t eih_type; 2110 uint32_t eih_subtype; 2111 uint32_t eih_code_size; 2112 uint32_t eih_size; 2113 union { 2114 uint32_t eih_controller_version_min; 2115 struct { 2116 uint16_t eih_controller_version_min_short; 2117 uint8_t eih_extra_version_a; 2118 uint8_t eih_extra_version_b; 2119 }; 2120 }; 2121 union { 2122 uint32_t eih_controller_version_max; 2123 struct { 2124 uint16_t eih_controller_version_max_short; 2125 uint8_t eih_extra_version_c; 2126 uint8_t eih_extra_version_d; 2127 }; 2128 }; 2129 uint16_t eih_code_version_a; 2130 uint16_t eih_code_version_b; 2131 uint16_t eih_code_version_c; 2132 uint16_t eih_code_version_d; 2133 } efx_image_header_t; 2134 2135 #define EFX_IMAGE_HEADER_SIZE (40) 2136 #define EFX_IMAGE_HEADER_VERSION (4) 2137 #define EFX_IMAGE_HEADER_MAGIC (0x106F1A5) 2138 2139 2140 typedef struct efx_image_trailer_s { 2141 uint32_t eit_crc; 2142 } efx_image_trailer_t; 2143 2144 #define EFX_IMAGE_TRAILER_SIZE (4) 2145 2146 typedef enum efx_image_format_e { 2147 EFX_IMAGE_FORMAT_NO_IMAGE, 2148 EFX_IMAGE_FORMAT_INVALID, 2149 EFX_IMAGE_FORMAT_UNSIGNED, 2150 EFX_IMAGE_FORMAT_SIGNED, 2151 EFX_IMAGE_FORMAT_SIGNED_PACKAGE 2152 } efx_image_format_t; 2153 2154 typedef struct efx_image_info_s { 2155 efx_image_format_t eii_format; 2156 uint8_t * eii_imagep; 2157 size_t eii_image_size; 2158 efx_image_header_t * eii_headerp; 2159 } efx_image_info_t; 2160 2161 LIBEFX_API 2162 extern __checkReturn efx_rc_t 2163 efx_check_reflash_image( 2164 __in void *bufferp, 2165 __in uint32_t buffer_size, 2166 __out efx_image_info_t *infop); 2167 2168 LIBEFX_API 2169 extern __checkReturn efx_rc_t 2170 efx_build_signed_image_write_buffer( 2171 __out_bcount(buffer_size) 2172 uint8_t *bufferp, 2173 __in uint32_t buffer_size, 2174 __in efx_image_info_t *infop, 2175 __out efx_image_header_t **headerpp); 2176 2177 #endif /* EFSYS_OPT_IMAGE_LAYOUT */ 2178 2179 #if EFSYS_OPT_DIAG 2180 2181 typedef enum efx_pattern_type_t { 2182 EFX_PATTERN_BYTE_INCREMENT = 0, 2183 EFX_PATTERN_ALL_THE_SAME, 2184 EFX_PATTERN_BIT_ALTERNATE, 2185 EFX_PATTERN_BYTE_ALTERNATE, 2186 EFX_PATTERN_BYTE_CHANGING, 2187 EFX_PATTERN_BIT_SWEEP, 2188 EFX_PATTERN_NTYPES 2189 } efx_pattern_type_t; 2190 2191 typedef void 2192 (*efx_sram_pattern_fn_t)( 2193 __in size_t row, 2194 __in boolean_t negate, 2195 __out efx_qword_t *eqp); 2196 2197 LIBEFX_API 2198 extern __checkReturn efx_rc_t 2199 efx_sram_test( 2200 __in efx_nic_t *enp, 2201 __in efx_pattern_type_t type); 2202 2203 #endif /* EFSYS_OPT_DIAG */ 2204 2205 LIBEFX_API 2206 extern __checkReturn efx_rc_t 2207 efx_sram_buf_tbl_set( 2208 __in efx_nic_t *enp, 2209 __in uint32_t id, 2210 __in efsys_mem_t *esmp, 2211 __in size_t n); 2212 2213 LIBEFX_API 2214 extern void 2215 efx_sram_buf_tbl_clear( 2216 __in efx_nic_t *enp, 2217 __in uint32_t id, 2218 __in size_t n); 2219 2220 #define EFX_BUF_TBL_SIZE 0x20000 2221 2222 #define EFX_BUF_SIZE 4096 2223 2224 /* EV */ 2225 2226 typedef struct efx_evq_s efx_evq_t; 2227 2228 #if EFSYS_OPT_QSTATS 2229 2230 /* START MKCONFIG GENERATED EfxHeaderEventQueueBlock 0a147ace40844969 */ 2231 typedef enum efx_ev_qstat_e { 2232 EV_ALL, 2233 EV_RX, 2234 EV_RX_OK, 2235 EV_RX_FRM_TRUNC, 2236 EV_RX_TOBE_DISC, 2237 EV_RX_PAUSE_FRM_ERR, 2238 EV_RX_BUF_OWNER_ID_ERR, 2239 EV_RX_IPV4_HDR_CHKSUM_ERR, 2240 EV_RX_TCP_UDP_CHKSUM_ERR, 2241 EV_RX_ETH_CRC_ERR, 2242 EV_RX_IP_FRAG_ERR, 2243 EV_RX_MCAST_PKT, 2244 EV_RX_MCAST_HASH_MATCH, 2245 EV_RX_TCP_IPV4, 2246 EV_RX_TCP_IPV6, 2247 EV_RX_UDP_IPV4, 2248 EV_RX_UDP_IPV6, 2249 EV_RX_OTHER_IPV4, 2250 EV_RX_OTHER_IPV6, 2251 EV_RX_NON_IP, 2252 EV_RX_BATCH, 2253 EV_TX, 2254 EV_TX_WQ_FF_FULL, 2255 EV_TX_PKT_ERR, 2256 EV_TX_PKT_TOO_BIG, 2257 EV_TX_UNEXPECTED, 2258 EV_GLOBAL, 2259 EV_GLOBAL_MNT, 2260 EV_DRIVER, 2261 EV_DRIVER_SRM_UPD_DONE, 2262 EV_DRIVER_TX_DESCQ_FLS_DONE, 2263 EV_DRIVER_RX_DESCQ_FLS_DONE, 2264 EV_DRIVER_RX_DESCQ_FLS_FAILED, 2265 EV_DRIVER_RX_DSC_ERROR, 2266 EV_DRIVER_TX_DSC_ERROR, 2267 EV_DRV_GEN, 2268 EV_MCDI_RESPONSE, 2269 EV_RX_PARSE_INCOMPLETE, 2270 EV_NQSTATS 2271 } efx_ev_qstat_t; 2272 2273 /* END MKCONFIG GENERATED EfxHeaderEventQueueBlock */ 2274 2275 #endif /* EFSYS_OPT_QSTATS */ 2276 2277 LIBEFX_API 2278 extern __checkReturn efx_rc_t 2279 efx_ev_init( 2280 __in efx_nic_t *enp); 2281 2282 LIBEFX_API 2283 extern void 2284 efx_ev_fini( 2285 __in efx_nic_t *enp); 2286 2287 LIBEFX_API 2288 extern __checkReturn size_t 2289 efx_evq_size( 2290 __in const efx_nic_t *enp, 2291 __in unsigned int ndescs, 2292 __in uint32_t flags); 2293 2294 LIBEFX_API 2295 extern __checkReturn unsigned int 2296 efx_evq_nbufs( 2297 __in const efx_nic_t *enp, 2298 __in unsigned int ndescs, 2299 __in uint32_t flags); 2300 2301 #define EFX_EVQ_FLAGS_TYPE_MASK (0x3) 2302 #define EFX_EVQ_FLAGS_TYPE_AUTO (0x0) 2303 #define EFX_EVQ_FLAGS_TYPE_THROUGHPUT (0x1) 2304 #define EFX_EVQ_FLAGS_TYPE_LOW_LATENCY (0x2) 2305 2306 #define EFX_EVQ_FLAGS_NOTIFY_MASK (0xC) 2307 #define EFX_EVQ_FLAGS_NOTIFY_INTERRUPT (0x0) /* Interrupting (default) */ 2308 #define EFX_EVQ_FLAGS_NOTIFY_DISABLED (0x4) /* Non-interrupting */ 2309 2310 /* 2311 * Use the NO_CONT_EV RX event format, which allows the firmware to operate more 2312 * efficiently at high data rates. See SF-109306-TC 5.11 "Events for RXQs in 2313 * NO_CONT_EV mode". 2314 * 2315 * NO_CONT_EV requires EVQ_RX_MERGE and RXQ_FORCED_EV_MERGING to both be set, 2316 * which is the case when an event queue is set to THROUGHPUT mode. 2317 */ 2318 #define EFX_EVQ_FLAGS_NO_CONT_EV (0x10) 2319 2320 /* Configure EVQ for extended width events (EF100 only) */ 2321 #define EFX_EVQ_FLAGS_EXTENDED_WIDTH (0x20) 2322 2323 2324 LIBEFX_API 2325 extern __checkReturn efx_rc_t 2326 efx_ev_qcreate( 2327 __in efx_nic_t *enp, 2328 __in unsigned int index, 2329 __in efsys_mem_t *esmp, 2330 __in size_t ndescs, 2331 __in uint32_t id, 2332 __in uint32_t us, 2333 __in uint32_t flags, 2334 __deref_out efx_evq_t **eepp); 2335 2336 LIBEFX_API 2337 extern void 2338 efx_ev_qpost( 2339 __in efx_evq_t *eep, 2340 __in uint16_t data); 2341 2342 typedef __checkReturn boolean_t 2343 (*efx_initialized_ev_t)( 2344 __in_opt void *arg); 2345 2346 #define EFX_PKT_UNICAST 0x0004 2347 #define EFX_PKT_START 0x0008 2348 2349 #define EFX_PKT_VLAN_TAGGED 0x0010 2350 #define EFX_CKSUM_TCPUDP 0x0020 2351 #define EFX_CKSUM_IPV4 0x0040 2352 #define EFX_PKT_CONT 0x0080 2353 2354 #define EFX_CHECK_VLAN 0x0100 2355 #define EFX_PKT_TCP 0x0200 2356 #define EFX_PKT_UDP 0x0400 2357 #define EFX_PKT_IPV4 0x0800 2358 2359 #define EFX_PKT_IPV6 0x1000 2360 #define EFX_PKT_PREFIX_LEN 0x2000 2361 #define EFX_ADDR_MISMATCH 0x4000 2362 #define EFX_DISCARD 0x8000 2363 2364 /* 2365 * The following flags are used only for packed stream 2366 * mode. The values for the flags are reused to fit into 16 bit, 2367 * since EFX_PKT_START and EFX_PKT_CONT are never used in 2368 * packed stream mode 2369 */ 2370 #define EFX_PKT_PACKED_STREAM_NEW_BUFFER EFX_PKT_START 2371 #define EFX_PKT_PACKED_STREAM_PARSE_INCOMPLETE EFX_PKT_CONT 2372 2373 2374 #define EFX_EV_RX_NLABELS 32 2375 #define EFX_EV_TX_NLABELS 32 2376 2377 typedef __checkReturn boolean_t 2378 (*efx_rx_ev_t)( 2379 __in_opt void *arg, 2380 __in uint32_t label, 2381 __in uint32_t id, 2382 __in uint32_t size, 2383 __in uint16_t flags); 2384 2385 typedef __checkReturn boolean_t 2386 (*efx_rx_packets_ev_t)( 2387 __in_opt void *arg, 2388 __in uint32_t label, 2389 __in unsigned int num_packets, 2390 __in uint32_t flags); 2391 2392 #if EFSYS_OPT_RX_PACKED_STREAM || EFSYS_OPT_RX_ES_SUPER_BUFFER 2393 2394 /* 2395 * Packed stream mode is documented in SF-112241-TC. 2396 * The general idea is that, instead of putting each incoming 2397 * packet into a separate buffer which is specified in a RX 2398 * descriptor, a large buffer is provided to the hardware and 2399 * packets are put there in a continuous stream. 2400 * The main advantage of such an approach is that RX queue refilling 2401 * happens much less frequently. 2402 * 2403 * Equal stride packed stream mode is documented in SF-119419-TC. 2404 * The general idea is to utilize advantages of the packed stream, 2405 * but avoid indirection in packets representation. 2406 * The main advantage of such an approach is that RX queue refilling 2407 * happens much less frequently and packets buffers are independent 2408 * from upper layers point of view. 2409 */ 2410 2411 typedef __checkReturn boolean_t 2412 (*efx_rx_ps_ev_t)( 2413 __in_opt void *arg, 2414 __in uint32_t label, 2415 __in uint32_t id, 2416 __in uint32_t pkt_count, 2417 __in uint16_t flags); 2418 2419 #endif 2420 2421 typedef __checkReturn boolean_t 2422 (*efx_tx_ev_t)( 2423 __in_opt void *arg, 2424 __in uint32_t label, 2425 __in uint32_t id); 2426 2427 typedef __checkReturn boolean_t 2428 (*efx_tx_ndescs_ev_t)( 2429 __in_opt void *arg, 2430 __in uint32_t label, 2431 __in unsigned int ndescs); 2432 2433 #define EFX_EXCEPTION_RX_RECOVERY 0x00000001 2434 #define EFX_EXCEPTION_RX_DSC_ERROR 0x00000002 2435 #define EFX_EXCEPTION_TX_DSC_ERROR 0x00000003 2436 #define EFX_EXCEPTION_UNKNOWN_SENSOREVT 0x00000004 2437 #define EFX_EXCEPTION_FWALERT_SRAM 0x00000005 2438 #define EFX_EXCEPTION_UNKNOWN_FWALERT 0x00000006 2439 #define EFX_EXCEPTION_RX_ERROR 0x00000007 2440 #define EFX_EXCEPTION_TX_ERROR 0x00000008 2441 #define EFX_EXCEPTION_EV_ERROR 0x00000009 2442 2443 typedef __checkReturn boolean_t 2444 (*efx_exception_ev_t)( 2445 __in_opt void *arg, 2446 __in uint32_t label, 2447 __in uint32_t data); 2448 2449 typedef __checkReturn boolean_t 2450 (*efx_rxq_flush_done_ev_t)( 2451 __in_opt void *arg, 2452 __in uint32_t rxq_index); 2453 2454 typedef __checkReturn boolean_t 2455 (*efx_rxq_flush_failed_ev_t)( 2456 __in_opt void *arg, 2457 __in uint32_t rxq_index); 2458 2459 typedef __checkReturn boolean_t 2460 (*efx_txq_flush_done_ev_t)( 2461 __in_opt void *arg, 2462 __in uint32_t txq_index); 2463 2464 typedef __checkReturn boolean_t 2465 (*efx_software_ev_t)( 2466 __in_opt void *arg, 2467 __in uint16_t magic); 2468 2469 typedef __checkReturn boolean_t 2470 (*efx_sram_ev_t)( 2471 __in_opt void *arg, 2472 __in uint32_t code); 2473 2474 #define EFX_SRAM_CLEAR 0 2475 #define EFX_SRAM_UPDATE 1 2476 #define EFX_SRAM_ILLEGAL_CLEAR 2 2477 2478 typedef __checkReturn boolean_t 2479 (*efx_wake_up_ev_t)( 2480 __in_opt void *arg, 2481 __in uint32_t label); 2482 2483 typedef __checkReturn boolean_t 2484 (*efx_timer_ev_t)( 2485 __in_opt void *arg, 2486 __in uint32_t label); 2487 2488 typedef __checkReturn boolean_t 2489 (*efx_link_change_ev_t)( 2490 __in_opt void *arg, 2491 __in efx_link_mode_t link_mode); 2492 2493 #if EFSYS_OPT_MON_STATS 2494 2495 typedef __checkReturn boolean_t 2496 (*efx_monitor_ev_t)( 2497 __in_opt void *arg, 2498 __in efx_mon_stat_t id, 2499 __in efx_mon_stat_value_t value); 2500 2501 #endif /* EFSYS_OPT_MON_STATS */ 2502 2503 #if EFSYS_OPT_MAC_STATS 2504 2505 typedef __checkReturn boolean_t 2506 (*efx_mac_stats_ev_t)( 2507 __in_opt void *arg, 2508 __in uint32_t generation); 2509 2510 #endif /* EFSYS_OPT_MAC_STATS */ 2511 2512 #if EFSYS_OPT_DESC_PROXY 2513 2514 /* 2515 * NOTE: This callback returns the raw descriptor data, which has not been 2516 * converted to host endian. The callback must use the EFX_OWORD macros 2517 * to extract the descriptor fields as host endian values. 2518 */ 2519 typedef __checkReturn boolean_t 2520 (*efx_desc_proxy_txq_desc_ev_t)( 2521 __in_opt void *arg, 2522 __in uint16_t vi_id, 2523 __in efx_oword_t txq_desc); 2524 2525 /* 2526 * NOTE: This callback returns the raw descriptor data, which has not been 2527 * converted to host endian. The callback must use the EFX_OWORD macros 2528 * to extract the descriptor fields as host endian values. 2529 */ 2530 typedef __checkReturn boolean_t 2531 (*efx_desc_proxy_virtq_desc_ev_t)( 2532 __in_opt void *arg, 2533 __in uint16_t vi_id, 2534 __in uint16_t avail, 2535 __in efx_oword_t virtq_desc); 2536 2537 #endif /* EFSYS_OPT_DESC_PROXY */ 2538 2539 typedef struct efx_ev_callbacks_s { 2540 efx_initialized_ev_t eec_initialized; 2541 efx_rx_ev_t eec_rx; 2542 efx_rx_packets_ev_t eec_rx_packets; 2543 #if EFSYS_OPT_RX_PACKED_STREAM || EFSYS_OPT_RX_ES_SUPER_BUFFER 2544 efx_rx_ps_ev_t eec_rx_ps; 2545 #endif 2546 efx_tx_ev_t eec_tx; 2547 efx_tx_ndescs_ev_t eec_tx_ndescs; 2548 efx_exception_ev_t eec_exception; 2549 efx_rxq_flush_done_ev_t eec_rxq_flush_done; 2550 efx_rxq_flush_failed_ev_t eec_rxq_flush_failed; 2551 efx_txq_flush_done_ev_t eec_txq_flush_done; 2552 efx_software_ev_t eec_software; 2553 efx_sram_ev_t eec_sram; 2554 efx_wake_up_ev_t eec_wake_up; 2555 efx_timer_ev_t eec_timer; 2556 efx_link_change_ev_t eec_link_change; 2557 #if EFSYS_OPT_MON_STATS 2558 efx_monitor_ev_t eec_monitor; 2559 #endif /* EFSYS_OPT_MON_STATS */ 2560 #if EFSYS_OPT_MAC_STATS 2561 efx_mac_stats_ev_t eec_mac_stats; 2562 #endif /* EFSYS_OPT_MAC_STATS */ 2563 #if EFSYS_OPT_DESC_PROXY 2564 efx_desc_proxy_txq_desc_ev_t eec_desc_proxy_txq_desc; 2565 efx_desc_proxy_virtq_desc_ev_t eec_desc_proxy_virtq_desc; 2566 #endif /* EFSYS_OPT_DESC_PROXY */ 2567 2568 } efx_ev_callbacks_t; 2569 2570 LIBEFX_API 2571 extern __checkReturn boolean_t 2572 efx_ev_qpending( 2573 __in efx_evq_t *eep, 2574 __in unsigned int count); 2575 2576 #if EFSYS_OPT_EV_PREFETCH 2577 2578 LIBEFX_API 2579 extern void 2580 efx_ev_qprefetch( 2581 __in efx_evq_t *eep, 2582 __in unsigned int count); 2583 2584 #endif /* EFSYS_OPT_EV_PREFETCH */ 2585 2586 LIBEFX_API 2587 extern void 2588 efx_ev_qcreate_check_init_done( 2589 __in efx_evq_t *eep, 2590 __in const efx_ev_callbacks_t *eecp, 2591 __in_opt void *arg); 2592 2593 LIBEFX_API 2594 extern void 2595 efx_ev_qpoll( 2596 __in efx_evq_t *eep, 2597 __inout unsigned int *countp, 2598 __in const efx_ev_callbacks_t *eecp, 2599 __in_opt void *arg); 2600 2601 LIBEFX_API 2602 extern __checkReturn efx_rc_t 2603 efx_ev_usecs_to_ticks( 2604 __in efx_nic_t *enp, 2605 __in unsigned int usecs, 2606 __out unsigned int *ticksp); 2607 2608 LIBEFX_API 2609 extern __checkReturn efx_rc_t 2610 efx_ev_qmoderate( 2611 __in efx_evq_t *eep, 2612 __in unsigned int us); 2613 2614 LIBEFX_API 2615 extern __checkReturn efx_rc_t 2616 efx_ev_qprime( 2617 __in efx_evq_t *eep, 2618 __in unsigned int count); 2619 2620 #if EFSYS_OPT_QSTATS 2621 2622 #if EFSYS_OPT_NAMES 2623 2624 LIBEFX_API 2625 extern const char * 2626 efx_ev_qstat_name( 2627 __in efx_nic_t *enp, 2628 __in unsigned int id); 2629 2630 #endif /* EFSYS_OPT_NAMES */ 2631 2632 LIBEFX_API 2633 extern void 2634 efx_ev_qstats_update( 2635 __in efx_evq_t *eep, 2636 __inout_ecount(EV_NQSTATS) efsys_stat_t *stat); 2637 2638 #endif /* EFSYS_OPT_QSTATS */ 2639 2640 LIBEFX_API 2641 extern void 2642 efx_ev_qdestroy( 2643 __in efx_evq_t *eep); 2644 2645 /* RX */ 2646 2647 LIBEFX_API 2648 extern __checkReturn efx_rc_t 2649 efx_rx_init( 2650 __inout efx_nic_t *enp); 2651 2652 LIBEFX_API 2653 extern void 2654 efx_rx_fini( 2655 __in efx_nic_t *enp); 2656 2657 #if EFSYS_OPT_RX_SCATTER 2658 LIBEFX_API 2659 extern __checkReturn efx_rc_t 2660 efx_rx_scatter_enable( 2661 __in efx_nic_t *enp, 2662 __in unsigned int buf_size); 2663 #endif /* EFSYS_OPT_RX_SCATTER */ 2664 2665 /* Handle to represent use of the default RSS context. */ 2666 #define EFX_RSS_CONTEXT_DEFAULT 0xffffffff 2667 2668 #if EFSYS_OPT_RX_SCALE 2669 2670 typedef enum efx_rx_hash_alg_e { 2671 EFX_RX_HASHALG_LFSR = 0, 2672 EFX_RX_HASHALG_TOEPLITZ, 2673 EFX_RX_HASHALG_PACKED_STREAM, 2674 EFX_RX_NHASHALGS 2675 } efx_rx_hash_alg_t; 2676 2677 /* 2678 * Legacy hash type flags. 2679 * 2680 * They represent standard tuples for distinct traffic classes. 2681 */ 2682 #define EFX_RX_HASH_IPV4 (1U << 0) 2683 #define EFX_RX_HASH_TCPIPV4 (1U << 1) 2684 #define EFX_RX_HASH_IPV6 (1U << 2) 2685 #define EFX_RX_HASH_TCPIPV6 (1U << 3) 2686 2687 #define EFX_RX_HASH_LEGACY_MASK \ 2688 (EFX_RX_HASH_IPV4 | \ 2689 EFX_RX_HASH_TCPIPV4 | \ 2690 EFX_RX_HASH_IPV6 | \ 2691 EFX_RX_HASH_TCPIPV6) 2692 2693 /* 2694 * The type of the argument used by efx_rx_scale_mode_set() to 2695 * provide a means for the client drivers to configure hashing. 2696 * 2697 * A properly constructed value can either be: 2698 * - a combination of legacy flags 2699 * - a combination of EFX_RX_HASH() flags 2700 */ 2701 typedef uint32_t efx_rx_hash_type_t; 2702 2703 typedef enum efx_rx_hash_support_e { 2704 EFX_RX_HASH_UNAVAILABLE = 0, /* Hardware hash not inserted */ 2705 EFX_RX_HASH_AVAILABLE /* Insert hash with/without RSS */ 2706 } efx_rx_hash_support_t; 2707 2708 #define EFX_RSS_KEY_SIZE 40 /* RSS key size (bytes) */ 2709 #define EFX_RSS_TBL_SIZE 128 /* Rows in RX indirection table */ 2710 #define EFX_MAXRSS 64 /* RX indirection entry range */ 2711 #define EFX_MAXRSS_LEGACY 16 /* See bug16611 and bug17213 */ 2712 2713 typedef enum efx_rx_scale_context_type_e { 2714 EFX_RX_SCALE_UNAVAILABLE = 0, /* No RX scale context */ 2715 EFX_RX_SCALE_EXCLUSIVE, /* Writable key/indirection table */ 2716 EFX_RX_SCALE_SHARED /* Read-only key/indirection table */ 2717 } efx_rx_scale_context_type_t; 2718 2719 /* 2720 * Traffic classes eligible for hash computation. 2721 * 2722 * Select packet headers used in computing the receive hash. 2723 * This uses the same encoding as the RSS_MODES field of 2724 * MC_CMD_RSS_CONTEXT_SET_FLAGS. 2725 */ 2726 #define EFX_RX_CLASS_IPV4_TCP_LBN 8 2727 #define EFX_RX_CLASS_IPV4_TCP_WIDTH 4 2728 #define EFX_RX_CLASS_IPV4_UDP_LBN 12 2729 #define EFX_RX_CLASS_IPV4_UDP_WIDTH 4 2730 #define EFX_RX_CLASS_IPV4_LBN 16 2731 #define EFX_RX_CLASS_IPV4_WIDTH 4 2732 #define EFX_RX_CLASS_IPV6_TCP_LBN 20 2733 #define EFX_RX_CLASS_IPV6_TCP_WIDTH 4 2734 #define EFX_RX_CLASS_IPV6_UDP_LBN 24 2735 #define EFX_RX_CLASS_IPV6_UDP_WIDTH 4 2736 #define EFX_RX_CLASS_IPV6_LBN 28 2737 #define EFX_RX_CLASS_IPV6_WIDTH 4 2738 2739 #define EFX_RX_NCLASSES 6 2740 2741 /* 2742 * Ancillary flags used to construct generic hash tuples. 2743 * This uses the same encoding as RSS_MODE_HASH_SELECTOR. 2744 */ 2745 #define EFX_RX_CLASS_HASH_SRC_ADDR (1U << 0) 2746 #define EFX_RX_CLASS_HASH_DST_ADDR (1U << 1) 2747 #define EFX_RX_CLASS_HASH_SRC_PORT (1U << 2) 2748 #define EFX_RX_CLASS_HASH_DST_PORT (1U << 3) 2749 2750 /* 2751 * Generic hash tuples. 2752 * 2753 * They express combinations of packet fields 2754 * which can contribute to the hash value for 2755 * a particular traffic class. 2756 */ 2757 #define EFX_RX_CLASS_HASH_DISABLE 0 2758 2759 #define EFX_RX_CLASS_HASH_1TUPLE_SRC EFX_RX_CLASS_HASH_SRC_ADDR 2760 #define EFX_RX_CLASS_HASH_1TUPLE_DST EFX_RX_CLASS_HASH_DST_ADDR 2761 2762 #define EFX_RX_CLASS_HASH_2TUPLE \ 2763 (EFX_RX_CLASS_HASH_SRC_ADDR | \ 2764 EFX_RX_CLASS_HASH_DST_ADDR) 2765 2766 #define EFX_RX_CLASS_HASH_2TUPLE_SRC \ 2767 (EFX_RX_CLASS_HASH_SRC_ADDR | \ 2768 EFX_RX_CLASS_HASH_SRC_PORT) 2769 2770 #define EFX_RX_CLASS_HASH_2TUPLE_DST \ 2771 (EFX_RX_CLASS_HASH_DST_ADDR | \ 2772 EFX_RX_CLASS_HASH_DST_PORT) 2773 2774 #define EFX_RX_CLASS_HASH_4TUPLE \ 2775 (EFX_RX_CLASS_HASH_SRC_ADDR | \ 2776 EFX_RX_CLASS_HASH_DST_ADDR | \ 2777 EFX_RX_CLASS_HASH_SRC_PORT | \ 2778 EFX_RX_CLASS_HASH_DST_PORT) 2779 2780 #define EFX_RX_CLASS_HASH_NTUPLES 7 2781 2782 /* 2783 * Hash flag constructor. 2784 * 2785 * Resulting flags encode hash tuples for specific traffic classes. 2786 * The client drivers are encouraged to use these flags to form 2787 * a hash type value. 2788 */ 2789 #define EFX_RX_HASH(_class, _tuple) \ 2790 EFX_INSERT_FIELD_NATIVE32(0, 31, \ 2791 EFX_RX_CLASS_##_class, EFX_RX_CLASS_HASH_##_tuple) 2792 2793 /* 2794 * The maximum number of EFX_RX_HASH() flags. 2795 */ 2796 #define EFX_RX_HASH_NFLAGS (EFX_RX_NCLASSES * EFX_RX_CLASS_HASH_NTUPLES) 2797 2798 LIBEFX_API 2799 extern __checkReturn efx_rc_t 2800 efx_rx_scale_hash_flags_get( 2801 __in efx_nic_t *enp, 2802 __in efx_rx_hash_alg_t hash_alg, 2803 __out_ecount_part(max_nflags, *nflagsp) unsigned int *flagsp, 2804 __in unsigned int max_nflags, 2805 __out unsigned int *nflagsp); 2806 2807 LIBEFX_API 2808 extern __checkReturn efx_rc_t 2809 efx_rx_hash_default_support_get( 2810 __in efx_nic_t *enp, 2811 __out efx_rx_hash_support_t *supportp); 2812 2813 2814 LIBEFX_API 2815 extern __checkReturn efx_rc_t 2816 efx_rx_scale_default_support_get( 2817 __in efx_nic_t *enp, 2818 __out efx_rx_scale_context_type_t *typep); 2819 2820 LIBEFX_API 2821 extern __checkReturn efx_rc_t 2822 efx_rx_scale_context_alloc( 2823 __in efx_nic_t *enp, 2824 __in efx_rx_scale_context_type_t type, 2825 __in uint32_t num_queues, 2826 __out uint32_t *rss_contextp); 2827 2828 LIBEFX_API 2829 extern __checkReturn efx_rc_t 2830 efx_rx_scale_context_free( 2831 __in efx_nic_t *enp, 2832 __in uint32_t rss_context); 2833 2834 LIBEFX_API 2835 extern __checkReturn efx_rc_t 2836 efx_rx_scale_mode_set( 2837 __in efx_nic_t *enp, 2838 __in uint32_t rss_context, 2839 __in efx_rx_hash_alg_t alg, 2840 __in efx_rx_hash_type_t type, 2841 __in boolean_t insert); 2842 2843 LIBEFX_API 2844 extern __checkReturn efx_rc_t 2845 efx_rx_scale_tbl_set( 2846 __in efx_nic_t *enp, 2847 __in uint32_t rss_context, 2848 __in_ecount(n) unsigned int *table, 2849 __in size_t n); 2850 2851 LIBEFX_API 2852 extern __checkReturn efx_rc_t 2853 efx_rx_scale_key_set( 2854 __in efx_nic_t *enp, 2855 __in uint32_t rss_context, 2856 __in_ecount(n) uint8_t *key, 2857 __in size_t n); 2858 2859 LIBEFX_API 2860 extern __checkReturn uint32_t 2861 efx_pseudo_hdr_hash_get( 2862 __in efx_rxq_t *erp, 2863 __in efx_rx_hash_alg_t func, 2864 __in uint8_t *buffer); 2865 2866 #endif /* EFSYS_OPT_RX_SCALE */ 2867 2868 LIBEFX_API 2869 extern __checkReturn efx_rc_t 2870 efx_pseudo_hdr_pkt_length_get( 2871 __in efx_rxq_t *erp, 2872 __in uint8_t *buffer, 2873 __out uint16_t *pkt_lengthp); 2874 2875 LIBEFX_API 2876 extern __checkReturn size_t 2877 efx_rxq_size( 2878 __in const efx_nic_t *enp, 2879 __in unsigned int ndescs); 2880 2881 LIBEFX_API 2882 extern __checkReturn unsigned int 2883 efx_rxq_nbufs( 2884 __in const efx_nic_t *enp, 2885 __in unsigned int ndescs); 2886 2887 #define EFX_RXQ_LIMIT(_ndescs) ((_ndescs) - 16) 2888 2889 /* 2890 * libefx representation of the Rx prefix layout information. 2891 * 2892 * The information may be used inside libefx to implement Rx prefix fields 2893 * accessors and by drivers which process Rx prefix itself. 2894 */ 2895 2896 /* 2897 * All known Rx prefix fields. 2898 * 2899 * An Rx prefix may have a subset of these fields. 2900 */ 2901 typedef enum efx_rx_prefix_field_e { 2902 EFX_RX_PREFIX_FIELD_LENGTH = 0, 2903 EFX_RX_PREFIX_FIELD_ORIG_LENGTH, 2904 EFX_RX_PREFIX_FIELD_CLASS, 2905 EFX_RX_PREFIX_FIELD_RSS_HASH, 2906 EFX_RX_PREFIX_FIELD_RSS_HASH_VALID, 2907 EFX_RX_PREFIX_FIELD_PARTIAL_TSTAMP, 2908 EFX_RX_PREFIX_FIELD_VLAN_STRIP_TCI, 2909 EFX_RX_PREFIX_FIELD_INNER_VLAN_STRIP_TCI, 2910 EFX_RX_PREFIX_FIELD_USER_FLAG, 2911 EFX_RX_PREFIX_FIELD_USER_MARK, 2912 EFX_RX_PREFIX_FIELD_USER_MARK_VALID, 2913 EFX_RX_PREFIX_FIELD_CSUM_FRAME, 2914 EFX_RX_PREFIX_FIELD_INGRESS_VPORT, 2915 EFX_RX_PREFIX_NFIELDS 2916 } efx_rx_prefix_field_t; 2917 2918 /* 2919 * Location and endianness of a field in Rx prefix. 2920 * 2921 * If width is zero, the field is not present. 2922 */ 2923 typedef struct efx_rx_prefix_field_info_s { 2924 uint16_t erpfi_offset_bits; 2925 uint8_t erpfi_width_bits; 2926 boolean_t erpfi_big_endian; 2927 } efx_rx_prefix_field_info_t; 2928 2929 /* Helper macro to define Rx prefix fields */ 2930 #define EFX_RX_PREFIX_FIELD(_efx, _field, _big_endian) \ 2931 [EFX_RX_PREFIX_FIELD_ ## _efx] = { \ 2932 .erpfi_offset_bits = EFX_LOW_BIT(_field), \ 2933 .erpfi_width_bits = EFX_WIDTH(_field), \ 2934 .erpfi_big_endian = (_big_endian), \ 2935 } 2936 2937 typedef struct efx_rx_prefix_layout_s { 2938 uint32_t erpl_id; 2939 uint8_t erpl_length; 2940 efx_rx_prefix_field_info_t erpl_fields[EFX_RX_PREFIX_NFIELDS]; 2941 } efx_rx_prefix_layout_t; 2942 2943 /* 2944 * Helper function to find out a bit mask of wanted but not available 2945 * Rx prefix fields. 2946 * 2947 * A field is considered as not available if any parameter mismatch. 2948 */ 2949 LIBEFX_API 2950 extern __checkReturn uint32_t 2951 efx_rx_prefix_layout_check( 2952 __in const efx_rx_prefix_layout_t *available, 2953 __in const efx_rx_prefix_layout_t *wanted); 2954 2955 LIBEFX_API 2956 extern __checkReturn efx_rc_t 2957 efx_rx_prefix_get_layout( 2958 __in const efx_rxq_t *erp, 2959 __out efx_rx_prefix_layout_t *erplp); 2960 2961 typedef enum efx_rxq_type_e { 2962 EFX_RXQ_TYPE_DEFAULT, 2963 EFX_RXQ_TYPE_PACKED_STREAM, 2964 EFX_RXQ_TYPE_ES_SUPER_BUFFER, 2965 EFX_RXQ_NTYPES 2966 } efx_rxq_type_t; 2967 2968 /* 2969 * Dummy flag to be used instead of 0 to make it clear that the argument 2970 * is receive queue flags. 2971 */ 2972 #define EFX_RXQ_FLAG_NONE 0x0 2973 #define EFX_RXQ_FLAG_SCATTER 0x1 2974 /* 2975 * If tunnels are supported and Rx event can provide information about 2976 * either outer or inner packet classes (e.g. SFN8xxx adapters with 2977 * full-feature firmware variant running), outer classes are requested by 2978 * default. However, if the driver supports tunnels, the flag allows to 2979 * request inner classes which are required to be able to interpret inner 2980 * Rx checksum offload results. 2981 */ 2982 #define EFX_RXQ_FLAG_INNER_CLASSES 0x2 2983 /* 2984 * Request delivery of the RSS hash calculated by HW to be used by 2985 * the driver. 2986 */ 2987 #define EFX_RXQ_FLAG_RSS_HASH 0x4 2988 2989 LIBEFX_API 2990 extern __checkReturn efx_rc_t 2991 efx_rx_qcreate( 2992 __in efx_nic_t *enp, 2993 __in unsigned int index, 2994 __in unsigned int label, 2995 __in efx_rxq_type_t type, 2996 __in size_t buf_size, 2997 __in efsys_mem_t *esmp, 2998 __in size_t ndescs, 2999 __in uint32_t id, 3000 __in unsigned int flags, 3001 __in efx_evq_t *eep, 3002 __deref_out efx_rxq_t **erpp); 3003 3004 #if EFSYS_OPT_RX_PACKED_STREAM 3005 3006 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_1M (1U * 1024 * 1024) 3007 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_512K (512U * 1024) 3008 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_256K (256U * 1024) 3009 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_128K (128U * 1024) 3010 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_64K (64U * 1024) 3011 3012 LIBEFX_API 3013 extern __checkReturn efx_rc_t 3014 efx_rx_qcreate_packed_stream( 3015 __in efx_nic_t *enp, 3016 __in unsigned int index, 3017 __in unsigned int label, 3018 __in uint32_t ps_buf_size, 3019 __in efsys_mem_t *esmp, 3020 __in size_t ndescs, 3021 __in efx_evq_t *eep, 3022 __deref_out efx_rxq_t **erpp); 3023 3024 #endif 3025 3026 #if EFSYS_OPT_RX_ES_SUPER_BUFFER 3027 3028 /* Maximum head-of-line block timeout in nanoseconds */ 3029 #define EFX_RXQ_ES_SUPER_BUFFER_HOL_BLOCK_MAX (400U * 1000 * 1000) 3030 3031 LIBEFX_API 3032 extern __checkReturn efx_rc_t 3033 efx_rx_qcreate_es_super_buffer( 3034 __in efx_nic_t *enp, 3035 __in unsigned int index, 3036 __in unsigned int label, 3037 __in uint32_t n_bufs_per_desc, 3038 __in uint32_t max_dma_len, 3039 __in uint32_t buf_stride, 3040 __in uint32_t hol_block_timeout, 3041 __in efsys_mem_t *esmp, 3042 __in size_t ndescs, 3043 __in unsigned int flags, 3044 __in efx_evq_t *eep, 3045 __deref_out efx_rxq_t **erpp); 3046 3047 #endif 3048 3049 typedef struct efx_buffer_s { 3050 efsys_dma_addr_t eb_addr; 3051 size_t eb_size; 3052 boolean_t eb_eop; 3053 } efx_buffer_t; 3054 3055 typedef struct efx_desc_s { 3056 efx_qword_t ed_eq; 3057 } efx_desc_t; 3058 3059 LIBEFX_API 3060 extern void 3061 efx_rx_qpost( 3062 __in efx_rxq_t *erp, 3063 __in_ecount(ndescs) efsys_dma_addr_t *addrp, 3064 __in size_t size, 3065 __in unsigned int ndescs, 3066 __in unsigned int completed, 3067 __in unsigned int added); 3068 3069 LIBEFX_API 3070 extern void 3071 efx_rx_qpush( 3072 __in efx_rxq_t *erp, 3073 __in unsigned int added, 3074 __inout unsigned int *pushedp); 3075 3076 #if EFSYS_OPT_RX_PACKED_STREAM 3077 3078 LIBEFX_API 3079 extern void 3080 efx_rx_qpush_ps_credits( 3081 __in efx_rxq_t *erp); 3082 3083 LIBEFX_API 3084 extern __checkReturn uint8_t * 3085 efx_rx_qps_packet_info( 3086 __in efx_rxq_t *erp, 3087 __in uint8_t *buffer, 3088 __in uint32_t buffer_length, 3089 __in uint32_t current_offset, 3090 __out uint16_t *lengthp, 3091 __out uint32_t *next_offsetp, 3092 __out uint32_t *timestamp); 3093 #endif 3094 3095 LIBEFX_API 3096 extern __checkReturn efx_rc_t 3097 efx_rx_qflush( 3098 __in efx_rxq_t *erp); 3099 3100 LIBEFX_API 3101 extern void 3102 efx_rx_qenable( 3103 __in efx_rxq_t *erp); 3104 3105 LIBEFX_API 3106 extern void 3107 efx_rx_qdestroy( 3108 __in efx_rxq_t *erp); 3109 3110 /* TX */ 3111 3112 typedef struct efx_txq_s efx_txq_t; 3113 3114 #if EFSYS_OPT_QSTATS 3115 3116 /* START MKCONFIG GENERATED EfxHeaderTransmitQueueBlock 12dff8778598b2db */ 3117 typedef enum efx_tx_qstat_e { 3118 TX_POST, 3119 TX_POST_PIO, 3120 TX_NQSTATS 3121 } efx_tx_qstat_t; 3122 3123 /* END MKCONFIG GENERATED EfxHeaderTransmitQueueBlock */ 3124 3125 #endif /* EFSYS_OPT_QSTATS */ 3126 3127 LIBEFX_API 3128 extern __checkReturn efx_rc_t 3129 efx_tx_init( 3130 __in efx_nic_t *enp); 3131 3132 LIBEFX_API 3133 extern void 3134 efx_tx_fini( 3135 __in efx_nic_t *enp); 3136 3137 LIBEFX_API 3138 extern __checkReturn size_t 3139 efx_txq_size( 3140 __in const efx_nic_t *enp, 3141 __in unsigned int ndescs); 3142 3143 LIBEFX_API 3144 extern __checkReturn unsigned int 3145 efx_txq_nbufs( 3146 __in const efx_nic_t *enp, 3147 __in unsigned int ndescs); 3148 3149 #define EFX_TXQ_LIMIT(_ndescs) ((_ndescs) - 16) 3150 3151 #define EFX_TXQ_CKSUM_IPV4 0x0001 3152 #define EFX_TXQ_CKSUM_TCPUDP 0x0002 3153 #define EFX_TXQ_FATSOV2 0x0004 3154 #define EFX_TXQ_CKSUM_INNER_IPV4 0x0008 3155 #define EFX_TXQ_CKSUM_INNER_TCPUDP 0x0010 3156 3157 LIBEFX_API 3158 extern __checkReturn efx_rc_t 3159 efx_tx_qcreate( 3160 __in efx_nic_t *enp, 3161 __in unsigned int index, 3162 __in unsigned int label, 3163 __in efsys_mem_t *esmp, 3164 __in size_t n, 3165 __in uint32_t id, 3166 __in uint16_t flags, 3167 __in efx_evq_t *eep, 3168 __deref_out efx_txq_t **etpp, 3169 __out unsigned int *addedp); 3170 3171 LIBEFX_API 3172 extern __checkReturn efx_rc_t 3173 efx_tx_qpost( 3174 __in efx_txq_t *etp, 3175 __in_ecount(ndescs) efx_buffer_t *eb, 3176 __in unsigned int ndescs, 3177 __in unsigned int completed, 3178 __inout unsigned int *addedp); 3179 3180 LIBEFX_API 3181 extern __checkReturn efx_rc_t 3182 efx_tx_qpace( 3183 __in efx_txq_t *etp, 3184 __in unsigned int ns); 3185 3186 LIBEFX_API 3187 extern void 3188 efx_tx_qpush( 3189 __in efx_txq_t *etp, 3190 __in unsigned int added, 3191 __in unsigned int pushed); 3192 3193 LIBEFX_API 3194 extern __checkReturn efx_rc_t 3195 efx_tx_qflush( 3196 __in efx_txq_t *etp); 3197 3198 LIBEFX_API 3199 extern void 3200 efx_tx_qenable( 3201 __in efx_txq_t *etp); 3202 3203 LIBEFX_API 3204 extern __checkReturn efx_rc_t 3205 efx_tx_qpio_enable( 3206 __in efx_txq_t *etp); 3207 3208 LIBEFX_API 3209 extern void 3210 efx_tx_qpio_disable( 3211 __in efx_txq_t *etp); 3212 3213 LIBEFX_API 3214 extern __checkReturn efx_rc_t 3215 efx_tx_qpio_write( 3216 __in efx_txq_t *etp, 3217 __in_ecount(buf_length) uint8_t *buffer, 3218 __in size_t buf_length, 3219 __in size_t pio_buf_offset); 3220 3221 LIBEFX_API 3222 extern __checkReturn efx_rc_t 3223 efx_tx_qpio_post( 3224 __in efx_txq_t *etp, 3225 __in size_t pkt_length, 3226 __in unsigned int completed, 3227 __inout unsigned int *addedp); 3228 3229 LIBEFX_API 3230 extern __checkReturn efx_rc_t 3231 efx_tx_qdesc_post( 3232 __in efx_txq_t *etp, 3233 __in_ecount(n) efx_desc_t *ed, 3234 __in unsigned int n, 3235 __in unsigned int completed, 3236 __inout unsigned int *addedp); 3237 3238 LIBEFX_API 3239 extern void 3240 efx_tx_qdesc_dma_create( 3241 __in efx_txq_t *etp, 3242 __in efsys_dma_addr_t addr, 3243 __in size_t size, 3244 __in boolean_t eop, 3245 __out efx_desc_t *edp); 3246 3247 LIBEFX_API 3248 extern void 3249 efx_tx_qdesc_tso_create( 3250 __in efx_txq_t *etp, 3251 __in uint16_t ipv4_id, 3252 __in uint32_t tcp_seq, 3253 __in uint8_t tcp_flags, 3254 __out efx_desc_t *edp); 3255 3256 /* Number of FATSOv2 option descriptors */ 3257 #define EFX_TX_FATSOV2_OPT_NDESCS 2 3258 3259 /* Maximum number of DMA segments per TSO packet (not superframe) */ 3260 #define EFX_TX_FATSOV2_DMA_SEGS_PER_PKT_MAX 24 3261 3262 LIBEFX_API 3263 extern void 3264 efx_tx_qdesc_tso2_create( 3265 __in efx_txq_t *etp, 3266 __in uint16_t ipv4_id, 3267 __in uint16_t outer_ipv4_id, 3268 __in uint32_t tcp_seq, 3269 __in uint16_t tcp_mss, 3270 __out_ecount(count) efx_desc_t *edp, 3271 __in int count); 3272 3273 LIBEFX_API 3274 extern void 3275 efx_tx_qdesc_vlantci_create( 3276 __in efx_txq_t *etp, 3277 __in uint16_t tci, 3278 __out efx_desc_t *edp); 3279 3280 LIBEFX_API 3281 extern void 3282 efx_tx_qdesc_checksum_create( 3283 __in efx_txq_t *etp, 3284 __in uint16_t flags, 3285 __out efx_desc_t *edp); 3286 3287 #if EFSYS_OPT_QSTATS 3288 3289 #if EFSYS_OPT_NAMES 3290 3291 LIBEFX_API 3292 extern const char * 3293 efx_tx_qstat_name( 3294 __in efx_nic_t *etp, 3295 __in unsigned int id); 3296 3297 #endif /* EFSYS_OPT_NAMES */ 3298 3299 LIBEFX_API 3300 extern void 3301 efx_tx_qstats_update( 3302 __in efx_txq_t *etp, 3303 __inout_ecount(TX_NQSTATS) efsys_stat_t *stat); 3304 3305 #endif /* EFSYS_OPT_QSTATS */ 3306 3307 LIBEFX_API 3308 extern void 3309 efx_tx_qdestroy( 3310 __in efx_txq_t *etp); 3311 3312 3313 /* FILTER */ 3314 3315 #if EFSYS_OPT_FILTER 3316 3317 #define EFX_ETHER_TYPE_IPV4 0x0800 3318 #define EFX_ETHER_TYPE_IPV6 0x86DD 3319 3320 #define EFX_IPPROTO_TCP 6 3321 #define EFX_IPPROTO_UDP 17 3322 #define EFX_IPPROTO_GRE 47 3323 3324 /* Use RSS to spread across multiple queues */ 3325 #define EFX_FILTER_FLAG_RX_RSS 0x01 3326 /* Enable RX scatter */ 3327 #define EFX_FILTER_FLAG_RX_SCATTER 0x02 3328 /* 3329 * Override an automatic filter (priority EFX_FILTER_PRI_AUTO). 3330 * May only be set by the filter implementation for each type. 3331 * A removal request will restore the automatic filter in its place. 3332 */ 3333 #define EFX_FILTER_FLAG_RX_OVER_AUTO 0x04 3334 /* Filter is for RX */ 3335 #define EFX_FILTER_FLAG_RX 0x08 3336 /* Filter is for TX */ 3337 #define EFX_FILTER_FLAG_TX 0x10 3338 /* Set match flag on the received packet */ 3339 #define EFX_FILTER_FLAG_ACTION_FLAG 0x20 3340 /* Set match mark on the received packet */ 3341 #define EFX_FILTER_FLAG_ACTION_MARK 0x40 3342 3343 typedef uint8_t efx_filter_flags_t; 3344 3345 /* 3346 * Flags which specify the fields to match on. The values are the same as in the 3347 * MC_CMD_FILTER_OP/MC_CMD_FILTER_OP_EXT commands. 3348 */ 3349 3350 /* Match by remote IP host address */ 3351 #define EFX_FILTER_MATCH_REM_HOST 0x00000001 3352 /* Match by local IP host address */ 3353 #define EFX_FILTER_MATCH_LOC_HOST 0x00000002 3354 /* Match by remote MAC address */ 3355 #define EFX_FILTER_MATCH_REM_MAC 0x00000004 3356 /* Match by remote TCP/UDP port */ 3357 #define EFX_FILTER_MATCH_REM_PORT 0x00000008 3358 /* Match by remote TCP/UDP port */ 3359 #define EFX_FILTER_MATCH_LOC_MAC 0x00000010 3360 /* Match by local TCP/UDP port */ 3361 #define EFX_FILTER_MATCH_LOC_PORT 0x00000020 3362 /* Match by Ether-type */ 3363 #define EFX_FILTER_MATCH_ETHER_TYPE 0x00000040 3364 /* Match by inner VLAN ID */ 3365 #define EFX_FILTER_MATCH_INNER_VID 0x00000080 3366 /* Match by outer VLAN ID */ 3367 #define EFX_FILTER_MATCH_OUTER_VID 0x00000100 3368 /* Match by IP transport protocol */ 3369 #define EFX_FILTER_MATCH_IP_PROTO 0x00000200 3370 /* Match by VNI or VSID */ 3371 #define EFX_FILTER_MATCH_VNI_OR_VSID 0x00000800 3372 /* For encapsulated packets, match by inner frame local MAC address */ 3373 #define EFX_FILTER_MATCH_IFRM_LOC_MAC 0x00010000 3374 /* For encapsulated packets, match all multicast inner frames */ 3375 #define EFX_FILTER_MATCH_IFRM_UNKNOWN_MCAST_DST 0x01000000 3376 /* For encapsulated packets, match all unicast inner frames */ 3377 #define EFX_FILTER_MATCH_IFRM_UNKNOWN_UCAST_DST 0x02000000 3378 /* 3379 * Match by encap type, this flag does not correspond to 3380 * the MCDI match flags and any unoccupied value may be used 3381 */ 3382 #define EFX_FILTER_MATCH_ENCAP_TYPE 0x20000000 3383 /* Match otherwise-unmatched multicast and broadcast packets */ 3384 #define EFX_FILTER_MATCH_UNKNOWN_MCAST_DST 0x40000000 3385 /* Match otherwise-unmatched unicast packets */ 3386 #define EFX_FILTER_MATCH_UNKNOWN_UCAST_DST 0x80000000 3387 3388 typedef uint32_t efx_filter_match_flags_t; 3389 3390 /* Filter priority from lowest to highest */ 3391 typedef enum efx_filter_priority_s { 3392 EFX_FILTER_PRI_AUTO = 0, /* Automatic filter based on device 3393 * address list or hardware 3394 * requirements. This may only be used 3395 * by the filter implementation for 3396 * each NIC type. */ 3397 EFX_FILTER_PRI_MANUAL, /* Manually configured filter */ 3398 EFX_FILTER_NPRI, 3399 } efx_filter_priority_t; 3400 3401 /* 3402 * FIXME: All these fields are assumed to be in little-endian byte order. 3403 * It may be better for some to be big-endian. See bug42804. 3404 */ 3405 3406 typedef struct efx_filter_spec_s { 3407 efx_filter_match_flags_t efs_match_flags; 3408 uint8_t efs_priority; 3409 efx_filter_flags_t efs_flags; 3410 uint16_t efs_dmaq_id; 3411 uint32_t efs_rss_context; 3412 uint32_t efs_mark; 3413 /* 3414 * Saved lower-priority filter. If it is set, it is restored on 3415 * filter delete operation. 3416 */ 3417 struct efx_filter_spec_s *efs_overridden_spec; 3418 /* Fields below here are hashed for software filter lookup */ 3419 uint16_t efs_outer_vid; 3420 uint16_t efs_inner_vid; 3421 uint8_t efs_loc_mac[EFX_MAC_ADDR_LEN]; 3422 uint8_t efs_rem_mac[EFX_MAC_ADDR_LEN]; 3423 uint16_t efs_ether_type; 3424 uint8_t efs_ip_proto; 3425 efx_tunnel_protocol_t efs_encap_type; 3426 uint16_t efs_loc_port; 3427 uint16_t efs_rem_port; 3428 efx_oword_t efs_rem_host; 3429 efx_oword_t efs_loc_host; 3430 uint8_t efs_vni_or_vsid[EFX_VNI_OR_VSID_LEN]; 3431 uint8_t efs_ifrm_loc_mac[EFX_MAC_ADDR_LEN]; 3432 } efx_filter_spec_t; 3433 3434 3435 /* Default values for use in filter specifications */ 3436 #define EFX_FILTER_SPEC_RX_DMAQ_ID_DROP 0xfff 3437 #define EFX_FILTER_SPEC_VID_UNSPEC 0xffff 3438 3439 LIBEFX_API 3440 extern __checkReturn efx_rc_t 3441 efx_filter_init( 3442 __in efx_nic_t *enp); 3443 3444 LIBEFX_API 3445 extern void 3446 efx_filter_fini( 3447 __in efx_nic_t *enp); 3448 3449 LIBEFX_API 3450 extern __checkReturn efx_rc_t 3451 efx_filter_insert( 3452 __in efx_nic_t *enp, 3453 __inout efx_filter_spec_t *spec); 3454 3455 LIBEFX_API 3456 extern __checkReturn efx_rc_t 3457 efx_filter_remove( 3458 __in efx_nic_t *enp, 3459 __inout efx_filter_spec_t *spec); 3460 3461 LIBEFX_API 3462 extern __checkReturn efx_rc_t 3463 efx_filter_restore( 3464 __in efx_nic_t *enp); 3465 3466 LIBEFX_API 3467 extern __checkReturn efx_rc_t 3468 efx_filter_supported_filters( 3469 __in efx_nic_t *enp, 3470 __out_ecount(buffer_length) uint32_t *buffer, 3471 __in size_t buffer_length, 3472 __out size_t *list_lengthp); 3473 3474 LIBEFX_API 3475 extern void 3476 efx_filter_spec_init_rx( 3477 __out efx_filter_spec_t *spec, 3478 __in efx_filter_priority_t priority, 3479 __in efx_filter_flags_t flags, 3480 __in efx_rxq_t *erp); 3481 3482 LIBEFX_API 3483 extern void 3484 efx_filter_spec_init_tx( 3485 __out efx_filter_spec_t *spec, 3486 __in efx_txq_t *etp); 3487 3488 LIBEFX_API 3489 extern __checkReturn efx_rc_t 3490 efx_filter_spec_set_ipv4_local( 3491 __inout efx_filter_spec_t *spec, 3492 __in uint8_t proto, 3493 __in uint32_t host, 3494 __in uint16_t port); 3495 3496 LIBEFX_API 3497 extern __checkReturn efx_rc_t 3498 efx_filter_spec_set_ipv4_full( 3499 __inout efx_filter_spec_t *spec, 3500 __in uint8_t proto, 3501 __in uint32_t lhost, 3502 __in uint16_t lport, 3503 __in uint32_t rhost, 3504 __in uint16_t rport); 3505 3506 LIBEFX_API 3507 extern __checkReturn efx_rc_t 3508 efx_filter_spec_set_eth_local( 3509 __inout efx_filter_spec_t *spec, 3510 __in uint16_t vid, 3511 __in const uint8_t *addr); 3512 3513 LIBEFX_API 3514 extern void 3515 efx_filter_spec_set_ether_type( 3516 __inout efx_filter_spec_t *spec, 3517 __in uint16_t ether_type); 3518 3519 LIBEFX_API 3520 extern __checkReturn efx_rc_t 3521 efx_filter_spec_set_uc_def( 3522 __inout efx_filter_spec_t *spec); 3523 3524 LIBEFX_API 3525 extern __checkReturn efx_rc_t 3526 efx_filter_spec_set_mc_def( 3527 __inout efx_filter_spec_t *spec); 3528 3529 typedef enum efx_filter_inner_frame_match_e { 3530 EFX_FILTER_INNER_FRAME_MATCH_OTHER = 0, 3531 EFX_FILTER_INNER_FRAME_MATCH_UNKNOWN_MCAST_DST, 3532 EFX_FILTER_INNER_FRAME_MATCH_UNKNOWN_UCAST_DST 3533 } efx_filter_inner_frame_match_t; 3534 3535 LIBEFX_API 3536 extern __checkReturn efx_rc_t 3537 efx_filter_spec_set_encap_type( 3538 __inout efx_filter_spec_t *spec, 3539 __in efx_tunnel_protocol_t encap_type, 3540 __in efx_filter_inner_frame_match_t inner_frame_match); 3541 3542 LIBEFX_API 3543 extern __checkReturn efx_rc_t 3544 efx_filter_spec_set_vxlan( 3545 __inout efx_filter_spec_t *spec, 3546 __in const uint8_t *vni, 3547 __in const uint8_t *inner_addr, 3548 __in const uint8_t *outer_addr); 3549 3550 LIBEFX_API 3551 extern __checkReturn efx_rc_t 3552 efx_filter_spec_set_geneve( 3553 __inout efx_filter_spec_t *spec, 3554 __in const uint8_t *vni, 3555 __in const uint8_t *inner_addr, 3556 __in const uint8_t *outer_addr); 3557 3558 LIBEFX_API 3559 extern __checkReturn efx_rc_t 3560 efx_filter_spec_set_nvgre( 3561 __inout efx_filter_spec_t *spec, 3562 __in const uint8_t *vsid, 3563 __in const uint8_t *inner_addr, 3564 __in const uint8_t *outer_addr); 3565 3566 #if EFSYS_OPT_RX_SCALE 3567 LIBEFX_API 3568 extern __checkReturn efx_rc_t 3569 efx_filter_spec_set_rss_context( 3570 __inout efx_filter_spec_t *spec, 3571 __in uint32_t rss_context); 3572 #endif 3573 #endif /* EFSYS_OPT_FILTER */ 3574 3575 /* HASH */ 3576 3577 LIBEFX_API 3578 extern __checkReturn uint32_t 3579 efx_hash_dwords( 3580 __in_ecount(count) uint32_t const *input, 3581 __in size_t count, 3582 __in uint32_t init); 3583 3584 LIBEFX_API 3585 extern __checkReturn uint32_t 3586 efx_hash_bytes( 3587 __in_ecount(length) uint8_t const *input, 3588 __in size_t length, 3589 __in uint32_t init); 3590 3591 #if EFSYS_OPT_LICENSING 3592 3593 /* LICENSING */ 3594 3595 typedef struct efx_key_stats_s { 3596 uint32_t eks_valid; 3597 uint32_t eks_invalid; 3598 uint32_t eks_blacklisted; 3599 uint32_t eks_unverifiable; 3600 uint32_t eks_wrong_node; 3601 uint32_t eks_licensed_apps_lo; 3602 uint32_t eks_licensed_apps_hi; 3603 uint32_t eks_licensed_features_lo; 3604 uint32_t eks_licensed_features_hi; 3605 } efx_key_stats_t; 3606 3607 LIBEFX_API 3608 extern __checkReturn efx_rc_t 3609 efx_lic_init( 3610 __in efx_nic_t *enp); 3611 3612 LIBEFX_API 3613 extern void 3614 efx_lic_fini( 3615 __in efx_nic_t *enp); 3616 3617 LIBEFX_API 3618 extern __checkReturn boolean_t 3619 efx_lic_check_support( 3620 __in efx_nic_t *enp); 3621 3622 LIBEFX_API 3623 extern __checkReturn efx_rc_t 3624 efx_lic_update_licenses( 3625 __in efx_nic_t *enp); 3626 3627 LIBEFX_API 3628 extern __checkReturn efx_rc_t 3629 efx_lic_get_key_stats( 3630 __in efx_nic_t *enp, 3631 __out efx_key_stats_t *ksp); 3632 3633 LIBEFX_API 3634 extern __checkReturn efx_rc_t 3635 efx_lic_app_state( 3636 __in efx_nic_t *enp, 3637 __in uint64_t app_id, 3638 __out boolean_t *licensedp); 3639 3640 LIBEFX_API 3641 extern __checkReturn efx_rc_t 3642 efx_lic_get_id( 3643 __in efx_nic_t *enp, 3644 __in size_t buffer_size, 3645 __out uint32_t *typep, 3646 __out size_t *lengthp, 3647 __out_opt uint8_t *bufferp); 3648 3649 3650 LIBEFX_API 3651 extern __checkReturn efx_rc_t 3652 efx_lic_find_start( 3653 __in efx_nic_t *enp, 3654 __in_bcount(buffer_size) 3655 caddr_t bufferp, 3656 __in size_t buffer_size, 3657 __out uint32_t *startp); 3658 3659 LIBEFX_API 3660 extern __checkReturn efx_rc_t 3661 efx_lic_find_end( 3662 __in efx_nic_t *enp, 3663 __in_bcount(buffer_size) 3664 caddr_t bufferp, 3665 __in size_t buffer_size, 3666 __in uint32_t offset, 3667 __out uint32_t *endp); 3668 3669 LIBEFX_API 3670 extern __checkReturn __success(return != B_FALSE) boolean_t 3671 efx_lic_find_key( 3672 __in efx_nic_t *enp, 3673 __in_bcount(buffer_size) 3674 caddr_t bufferp, 3675 __in size_t buffer_size, 3676 __in uint32_t offset, 3677 __out uint32_t *startp, 3678 __out uint32_t *lengthp); 3679 3680 LIBEFX_API 3681 extern __checkReturn __success(return != B_FALSE) boolean_t 3682 efx_lic_validate_key( 3683 __in efx_nic_t *enp, 3684 __in_bcount(length) caddr_t keyp, 3685 __in uint32_t length); 3686 3687 LIBEFX_API 3688 extern __checkReturn efx_rc_t 3689 efx_lic_read_key( 3690 __in efx_nic_t *enp, 3691 __in_bcount(buffer_size) 3692 caddr_t bufferp, 3693 __in size_t buffer_size, 3694 __in uint32_t offset, 3695 __in uint32_t length, 3696 __out_bcount_part(key_max_size, *lengthp) 3697 caddr_t keyp, 3698 __in size_t key_max_size, 3699 __out uint32_t *lengthp); 3700 3701 LIBEFX_API 3702 extern __checkReturn efx_rc_t 3703 efx_lic_write_key( 3704 __in efx_nic_t *enp, 3705 __in_bcount(buffer_size) 3706 caddr_t bufferp, 3707 __in size_t buffer_size, 3708 __in uint32_t offset, 3709 __in_bcount(length) caddr_t keyp, 3710 __in uint32_t length, 3711 __out uint32_t *lengthp); 3712 3713 LIBEFX_API 3714 extern __checkReturn efx_rc_t 3715 efx_lic_delete_key( 3716 __in efx_nic_t *enp, 3717 __in_bcount(buffer_size) 3718 caddr_t bufferp, 3719 __in size_t buffer_size, 3720 __in uint32_t offset, 3721 __in uint32_t length, 3722 __in uint32_t end, 3723 __out uint32_t *deltap); 3724 3725 LIBEFX_API 3726 extern __checkReturn efx_rc_t 3727 efx_lic_create_partition( 3728 __in efx_nic_t *enp, 3729 __in_bcount(buffer_size) 3730 caddr_t bufferp, 3731 __in size_t buffer_size); 3732 3733 extern __checkReturn efx_rc_t 3734 efx_lic_finish_partition( 3735 __in efx_nic_t *enp, 3736 __in_bcount(buffer_size) 3737 caddr_t bufferp, 3738 __in size_t buffer_size); 3739 3740 #endif /* EFSYS_OPT_LICENSING */ 3741 3742 /* TUNNEL */ 3743 3744 #if EFSYS_OPT_TUNNEL 3745 3746 LIBEFX_API 3747 extern __checkReturn efx_rc_t 3748 efx_tunnel_init( 3749 __in efx_nic_t *enp); 3750 3751 LIBEFX_API 3752 extern void 3753 efx_tunnel_fini( 3754 __in efx_nic_t *enp); 3755 3756 /* 3757 * For overlay network encapsulation using UDP, the firmware needs to know 3758 * the configured UDP port for the overlay so it can decode encapsulated 3759 * frames correctly. 3760 * The UDP port/protocol list is global. 3761 */ 3762 3763 LIBEFX_API 3764 extern __checkReturn efx_rc_t 3765 efx_tunnel_config_udp_add( 3766 __in efx_nic_t *enp, 3767 __in uint16_t port /* host/cpu-endian */, 3768 __in efx_tunnel_protocol_t protocol); 3769 3770 /* 3771 * Returns EBUSY if reconfiguration of the port is in progress in other thread. 3772 */ 3773 LIBEFX_API 3774 extern __checkReturn efx_rc_t 3775 efx_tunnel_config_udp_remove( 3776 __in efx_nic_t *enp, 3777 __in uint16_t port /* host/cpu-endian */, 3778 __in efx_tunnel_protocol_t protocol); 3779 3780 /* 3781 * Returns EBUSY if reconfiguration of any of the tunnel entries 3782 * is in progress in other thread. 3783 */ 3784 LIBEFX_API 3785 extern __checkReturn efx_rc_t 3786 efx_tunnel_config_clear( 3787 __in efx_nic_t *enp); 3788 3789 /** 3790 * Apply tunnel UDP ports configuration to hardware. 3791 * 3792 * EAGAIN is returned if hardware will be reset (datapath and managment CPU 3793 * reboot). 3794 */ 3795 LIBEFX_API 3796 extern __checkReturn efx_rc_t 3797 efx_tunnel_reconfigure( 3798 __in efx_nic_t *enp); 3799 3800 #endif /* EFSYS_OPT_TUNNEL */ 3801 3802 #if EFSYS_OPT_FW_SUBVARIANT_AWARE 3803 3804 /** 3805 * Firmware subvariant choice options. 3806 * 3807 * It may be switched to no Tx checksum if attached drivers are either 3808 * preboot or firmware subvariant aware and no VIS are allocated. 3809 * If may be always switched to default explicitly using set request or 3810 * implicitly if unaware driver is attaching. If switching is done when 3811 * a driver is attached, it gets MC_REBOOT event and should recreate its 3812 * datapath. 3813 * 3814 * See SF-119419-TC DPDK Firmware Driver Interface and 3815 * SF-109306-TC EF10 for Driver Writers for details. 3816 */ 3817 typedef enum efx_nic_fw_subvariant_e { 3818 EFX_NIC_FW_SUBVARIANT_DEFAULT = 0, 3819 EFX_NIC_FW_SUBVARIANT_NO_TX_CSUM = 1, 3820 EFX_NIC_FW_SUBVARIANT_NTYPES 3821 } efx_nic_fw_subvariant_t; 3822 3823 LIBEFX_API 3824 extern __checkReturn efx_rc_t 3825 efx_nic_get_fw_subvariant( 3826 __in efx_nic_t *enp, 3827 __out efx_nic_fw_subvariant_t *subvariantp); 3828 3829 LIBEFX_API 3830 extern __checkReturn efx_rc_t 3831 efx_nic_set_fw_subvariant( 3832 __in efx_nic_t *enp, 3833 __in efx_nic_fw_subvariant_t subvariant); 3834 3835 #endif /* EFSYS_OPT_FW_SUBVARIANT_AWARE */ 3836 3837 typedef enum efx_phy_fec_type_e { 3838 EFX_PHY_FEC_NONE = 0, 3839 EFX_PHY_FEC_BASER, 3840 EFX_PHY_FEC_RS 3841 } efx_phy_fec_type_t; 3842 3843 LIBEFX_API 3844 extern __checkReturn efx_rc_t 3845 efx_phy_fec_type_get( 3846 __in efx_nic_t *enp, 3847 __out efx_phy_fec_type_t *typep); 3848 3849 typedef struct efx_phy_link_state_s { 3850 uint32_t epls_adv_cap_mask; 3851 uint32_t epls_lp_cap_mask; 3852 uint32_t epls_ld_cap_mask; 3853 unsigned int epls_fcntl; 3854 efx_phy_fec_type_t epls_fec; 3855 efx_link_mode_t epls_link_mode; 3856 } efx_phy_link_state_t; 3857 3858 LIBEFX_API 3859 extern __checkReturn efx_rc_t 3860 efx_phy_link_state_get( 3861 __in efx_nic_t *enp, 3862 __out efx_phy_link_state_t *eplsp); 3863 3864 3865 #if EFSYS_OPT_EVB 3866 3867 typedef uint32_t efx_vswitch_id_t; 3868 typedef uint32_t efx_vport_id_t; 3869 3870 typedef enum efx_vswitch_type_e { 3871 EFX_VSWITCH_TYPE_VLAN = 1, 3872 EFX_VSWITCH_TYPE_VEB, 3873 /* VSWITCH_TYPE_VEPA: obsolete */ 3874 EFX_VSWITCH_TYPE_MUX = 4, 3875 } efx_vswitch_type_t; 3876 3877 typedef enum efx_vport_type_e { 3878 EFX_VPORT_TYPE_NORMAL = 4, 3879 EFX_VPORT_TYPE_EXPANSION, 3880 EFX_VPORT_TYPE_TEST, 3881 } efx_vport_type_t; 3882 3883 /* Unspecified VLAN ID to support disabling of VLAN filtering */ 3884 #define EFX_FILTER_VID_UNSPEC 0xffff 3885 #define EFX_DEFAULT_VSWITCH_ID 1 3886 3887 /* Default VF VLAN ID on creation */ 3888 #define EFX_VF_VID_DEFAULT EFX_FILTER_VID_UNSPEC 3889 #define EFX_VPORT_ID_INVALID 0 3890 3891 typedef struct efx_vport_config_s { 3892 /* Either VF index or EFX_PCI_VF_INVALID for PF */ 3893 uint16_t evc_function; 3894 /* VLAN ID of the associated function */ 3895 uint16_t evc_vid; 3896 /* vport id shared with client driver */ 3897 efx_vport_id_t evc_vport_id; 3898 /* MAC address of the associated function */ 3899 uint8_t evc_mac_addr[EFX_MAC_ADDR_LEN]; 3900 /* 3901 * vports created with this flag set may only transfer traffic on the 3902 * VLANs permitted by the vport. Also, an attempt to install filter with 3903 * VLAN will be refused unless requesting function has VLAN privilege. 3904 */ 3905 boolean_t evc_vlan_restrict; 3906 /* Whether this function is assigned or not */ 3907 boolean_t evc_vport_assigned; 3908 } efx_vport_config_t; 3909 3910 typedef struct efx_vswitch_s efx_vswitch_t; 3911 3912 LIBEFX_API 3913 extern __checkReturn efx_rc_t 3914 efx_evb_init( 3915 __in efx_nic_t *enp); 3916 3917 LIBEFX_API 3918 extern void 3919 efx_evb_fini( 3920 __in efx_nic_t *enp); 3921 3922 LIBEFX_API 3923 extern __checkReturn efx_rc_t 3924 efx_evb_vswitch_create( 3925 __in efx_nic_t *enp, 3926 __in uint32_t num_vports, 3927 __inout_ecount(num_vports) efx_vport_config_t *vport_configp, 3928 __deref_out efx_vswitch_t **evpp); 3929 3930 LIBEFX_API 3931 extern __checkReturn efx_rc_t 3932 efx_evb_vswitch_destroy( 3933 __in efx_nic_t *enp, 3934 __in efx_vswitch_t *evp); 3935 3936 LIBEFX_API 3937 extern __checkReturn efx_rc_t 3938 efx_evb_vport_mac_set( 3939 __in efx_nic_t *enp, 3940 __in efx_vswitch_t *evp, 3941 __in efx_vport_id_t vport_id, 3942 __in_bcount(EFX_MAC_ADDR_LEN) uint8_t *addrp); 3943 3944 LIBEFX_API 3945 extern __checkReturn efx_rc_t 3946 efx_evb_vport_vlan_set( 3947 __in efx_nic_t *enp, 3948 __in efx_vswitch_t *evp, 3949 __in efx_vport_id_t vport_id, 3950 __in uint16_t vid); 3951 3952 LIBEFX_API 3953 extern __checkReturn efx_rc_t 3954 efx_evb_vport_reset( 3955 __in efx_nic_t *enp, 3956 __in efx_vswitch_t *evp, 3957 __in efx_vport_id_t vport_id, 3958 __in_bcount(EFX_MAC_ADDR_LEN) uint8_t *addrp, 3959 __in uint16_t vid, 3960 __out boolean_t *is_fn_resetp); 3961 3962 LIBEFX_API 3963 extern __checkReturn efx_rc_t 3964 efx_evb_vport_stats( 3965 __in efx_nic_t *enp, 3966 __in efx_vswitch_t *evp, 3967 __in efx_vport_id_t vport_id, 3968 __out efsys_mem_t *stats_bufferp); 3969 3970 #endif /* EFSYS_OPT_EVB */ 3971 3972 #if EFSYS_OPT_MCDI_PROXY_AUTH_SERVER 3973 3974 typedef struct efx_proxy_auth_config_s { 3975 efsys_mem_t *request_bufferp; 3976 efsys_mem_t *response_bufferp; 3977 efsys_mem_t *status_bufferp; 3978 uint32_t block_cnt; 3979 uint32_t *op_listp; 3980 size_t op_count; 3981 uint32_t handled_privileges; 3982 } efx_proxy_auth_config_t; 3983 3984 typedef struct efx_proxy_cmd_params_s { 3985 uint32_t pf_index; 3986 uint32_t vf_index; 3987 uint8_t *request_bufferp; 3988 size_t request_size; 3989 uint8_t *response_bufferp; 3990 size_t response_size; 3991 size_t *response_size_actualp; 3992 } efx_proxy_cmd_params_t; 3993 3994 LIBEFX_API 3995 extern __checkReturn efx_rc_t 3996 efx_proxy_auth_init( 3997 __in efx_nic_t *enp); 3998 3999 LIBEFX_API 4000 extern void 4001 efx_proxy_auth_fini( 4002 __in efx_nic_t *enp); 4003 4004 LIBEFX_API 4005 extern __checkReturn efx_rc_t 4006 efx_proxy_auth_configure( 4007 __in efx_nic_t *enp, 4008 __in efx_proxy_auth_config_t *configp); 4009 4010 LIBEFX_API 4011 extern __checkReturn efx_rc_t 4012 efx_proxy_auth_destroy( 4013 __in efx_nic_t *enp, 4014 __in uint32_t handled_privileges); 4015 4016 LIBEFX_API 4017 extern __checkReturn efx_rc_t 4018 efx_proxy_auth_complete_request( 4019 __in efx_nic_t *enp, 4020 __in uint32_t fn_index, 4021 __in uint32_t proxy_result, 4022 __in uint32_t handle); 4023 4024 LIBEFX_API 4025 extern __checkReturn efx_rc_t 4026 efx_proxy_auth_exec_cmd( 4027 __in efx_nic_t *enp, 4028 __inout efx_proxy_cmd_params_t *paramsp); 4029 4030 LIBEFX_API 4031 extern __checkReturn efx_rc_t 4032 efx_proxy_auth_set_privilege_mask( 4033 __in efx_nic_t *enp, 4034 __in uint32_t vf_index, 4035 __in uint32_t mask, 4036 __in uint32_t value); 4037 4038 LIBEFX_API 4039 extern __checkReturn efx_rc_t 4040 efx_proxy_auth_privilege_mask_get( 4041 __in efx_nic_t *enp, 4042 __in uint32_t pf_index, 4043 __in uint32_t vf_index, 4044 __out uint32_t *maskp); 4045 4046 LIBEFX_API 4047 extern __checkReturn efx_rc_t 4048 efx_proxy_auth_privilege_modify( 4049 __in efx_nic_t *enp, 4050 __in uint32_t pf_index, 4051 __in uint32_t vf_index, 4052 __in uint32_t add_privileges_mask, 4053 __in uint32_t remove_privileges_mask); 4054 4055 #endif /* EFSYS_OPT_MCDI_PROXY_AUTH_SERVER */ 4056 4057 #if EFSYS_OPT_MAE 4058 4059 LIBEFX_API 4060 extern __checkReturn efx_rc_t 4061 efx_mae_init( 4062 __in efx_nic_t *enp); 4063 4064 LIBEFX_API 4065 extern void 4066 efx_mae_fini( 4067 __in efx_nic_t *enp); 4068 4069 typedef struct efx_mae_limits_s { 4070 uint32_t eml_max_n_action_prios; 4071 uint32_t eml_max_n_outer_prios; 4072 uint32_t eml_encap_types_supported; 4073 uint32_t eml_encap_header_size_limit; 4074 } efx_mae_limits_t; 4075 4076 LIBEFX_API 4077 extern __checkReturn efx_rc_t 4078 efx_mae_get_limits( 4079 __in efx_nic_t *enp, 4080 __out efx_mae_limits_t *emlp); 4081 4082 typedef enum efx_mae_rule_type_e { 4083 EFX_MAE_RULE_ACTION = 0, 4084 EFX_MAE_RULE_OUTER, 4085 4086 EFX_MAE_RULE_NTYPES 4087 } efx_mae_rule_type_t; 4088 4089 typedef struct efx_mae_match_spec_s efx_mae_match_spec_t; 4090 4091 LIBEFX_API 4092 extern __checkReturn efx_rc_t 4093 efx_mae_match_spec_init( 4094 __in efx_nic_t *enp, 4095 __in efx_mae_rule_type_t type, 4096 __in uint32_t prio, 4097 __out efx_mae_match_spec_t **specp); 4098 4099 LIBEFX_API 4100 extern void 4101 efx_mae_match_spec_fini( 4102 __in efx_nic_t *enp, 4103 __in efx_mae_match_spec_t *spec); 4104 4105 typedef enum efx_mae_field_id_e { 4106 EFX_MAE_FIELD_INGRESS_MPORT_SELECTOR = 0, 4107 EFX_MAE_FIELD_ETHER_TYPE_BE, 4108 EFX_MAE_FIELD_ETH_SADDR_BE, 4109 EFX_MAE_FIELD_ETH_DADDR_BE, 4110 EFX_MAE_FIELD_VLAN0_TCI_BE, 4111 EFX_MAE_FIELD_VLAN0_PROTO_BE, 4112 EFX_MAE_FIELD_VLAN1_TCI_BE, 4113 EFX_MAE_FIELD_VLAN1_PROTO_BE, 4114 EFX_MAE_FIELD_SRC_IP4_BE, 4115 EFX_MAE_FIELD_DST_IP4_BE, 4116 EFX_MAE_FIELD_IP_PROTO, 4117 EFX_MAE_FIELD_IP_TOS, 4118 EFX_MAE_FIELD_IP_TTL, 4119 EFX_MAE_FIELD_SRC_IP6_BE, 4120 EFX_MAE_FIELD_DST_IP6_BE, 4121 EFX_MAE_FIELD_L4_SPORT_BE, 4122 EFX_MAE_FIELD_L4_DPORT_BE, 4123 EFX_MAE_FIELD_TCP_FLAGS_BE, 4124 EFX_MAE_FIELD_ENC_ETHER_TYPE_BE, 4125 EFX_MAE_FIELD_ENC_ETH_SADDR_BE, 4126 EFX_MAE_FIELD_ENC_ETH_DADDR_BE, 4127 EFX_MAE_FIELD_ENC_VLAN0_TCI_BE, 4128 EFX_MAE_FIELD_ENC_VLAN0_PROTO_BE, 4129 EFX_MAE_FIELD_ENC_VLAN1_TCI_BE, 4130 EFX_MAE_FIELD_ENC_VLAN1_PROTO_BE, 4131 EFX_MAE_FIELD_ENC_SRC_IP4_BE, 4132 EFX_MAE_FIELD_ENC_DST_IP4_BE, 4133 EFX_MAE_FIELD_ENC_IP_PROTO, 4134 EFX_MAE_FIELD_ENC_IP_TOS, 4135 EFX_MAE_FIELD_ENC_IP_TTL, 4136 EFX_MAE_FIELD_ENC_SRC_IP6_BE, 4137 EFX_MAE_FIELD_ENC_DST_IP6_BE, 4138 EFX_MAE_FIELD_ENC_L4_SPORT_BE, 4139 EFX_MAE_FIELD_ENC_L4_DPORT_BE, 4140 EFX_MAE_FIELD_ENC_VNET_ID_BE, 4141 EFX_MAE_FIELD_OUTER_RULE_ID, 4142 4143 EFX_MAE_FIELD_NIDS 4144 } efx_mae_field_id_t; 4145 4146 /* MPORT selector. Used to refer to MPORTs in match/action rules. */ 4147 typedef struct efx_mport_sel_s { 4148 uint32_t sel; 4149 } efx_mport_sel_t; 4150 4151 #define EFX_MPORT_NULL (0U) 4152 4153 /* 4154 * Get MPORT selector of a physical port. 4155 * 4156 * The resulting MPORT selector is opaque to the caller and can be 4157 * passed as an argument to efx_mae_match_spec_mport_set() 4158 * and efx_mae_action_set_populate_deliver(). 4159 */ 4160 LIBEFX_API 4161 extern __checkReturn efx_rc_t 4162 efx_mae_mport_by_phy_port( 4163 __in uint32_t phy_port, 4164 __out efx_mport_sel_t *mportp); 4165 4166 /* 4167 * Get MPORT selector of a PCIe function. 4168 * 4169 * The resulting MPORT selector is opaque to the caller and can be 4170 * passed as an argument to efx_mae_match_spec_mport_set() 4171 * and efx_mae_action_set_populate_deliver(). 4172 */ 4173 LIBEFX_API 4174 extern __checkReturn efx_rc_t 4175 efx_mae_mport_by_pcie_function( 4176 __in uint32_t pf, 4177 __in uint32_t vf, 4178 __out efx_mport_sel_t *mportp); 4179 4180 /* 4181 * Fields which have BE postfix in their named constants are expected 4182 * to be passed by callers in big-endian byte order. They will appear 4183 * in the MCDI buffer, which is a part of the match specification, in 4184 * the very same byte order, that is, no conversion will be performed. 4185 * 4186 * Fields which don't have BE postfix in their named constants are in 4187 * host byte order. MCDI expects them to be little-endian, so the API 4188 * will take care to carry out conversion to little-endian byte order. 4189 * At the moment, the only field in host byte order is MPORT selector. 4190 */ 4191 LIBEFX_API 4192 extern __checkReturn efx_rc_t 4193 efx_mae_match_spec_field_set( 4194 __in efx_mae_match_spec_t *spec, 4195 __in efx_mae_field_id_t field_id, 4196 __in size_t value_size, 4197 __in_bcount(value_size) const uint8_t *value, 4198 __in size_t mask_size, 4199 __in_bcount(mask_size) const uint8_t *mask); 4200 4201 /* If the mask argument is NULL, the API will use full mask by default. */ 4202 LIBEFX_API 4203 extern __checkReturn efx_rc_t 4204 efx_mae_match_spec_mport_set( 4205 __in efx_mae_match_spec_t *spec, 4206 __in const efx_mport_sel_t *valuep, 4207 __in_opt const efx_mport_sel_t *maskp); 4208 4209 LIBEFX_API 4210 extern __checkReturn boolean_t 4211 efx_mae_match_specs_equal( 4212 __in const efx_mae_match_spec_t *left, 4213 __in const efx_mae_match_spec_t *right); 4214 4215 /* 4216 * Make sure that match fields known by EFX have proper masks set 4217 * in the match specification as per requirements of SF-122526-TC. 4218 * 4219 * In the case efx_mae_field_id_t lacks named identifiers for any 4220 * fields which the FW maintains with support status MATCH_ALWAYS, 4221 * the validation result may not be accurate. 4222 */ 4223 LIBEFX_API 4224 extern __checkReturn boolean_t 4225 efx_mae_match_spec_is_valid( 4226 __in efx_nic_t *enp, 4227 __in const efx_mae_match_spec_t *spec); 4228 4229 typedef struct efx_mae_actions_s efx_mae_actions_t; 4230 4231 LIBEFX_API 4232 extern __checkReturn efx_rc_t 4233 efx_mae_action_set_spec_init( 4234 __in efx_nic_t *enp, 4235 __out efx_mae_actions_t **specp); 4236 4237 LIBEFX_API 4238 extern void 4239 efx_mae_action_set_spec_fini( 4240 __in efx_nic_t *enp, 4241 __in efx_mae_actions_t *spec); 4242 4243 LIBEFX_API 4244 extern __checkReturn efx_rc_t 4245 efx_mae_action_set_populate_decap( 4246 __in efx_mae_actions_t *spec); 4247 4248 LIBEFX_API 4249 extern __checkReturn efx_rc_t 4250 efx_mae_action_set_populate_vlan_pop( 4251 __in efx_mae_actions_t *spec); 4252 4253 LIBEFX_API 4254 extern __checkReturn efx_rc_t 4255 efx_mae_action_set_populate_vlan_push( 4256 __in efx_mae_actions_t *spec, 4257 __in uint16_t tpid_be, 4258 __in uint16_t tci_be); 4259 4260 /* 4261 * Use efx_mae_action_set_fill_in_eh_id() to set ID of the allocated 4262 * encap. header in the specification prior to action set allocation. 4263 */ 4264 LIBEFX_API 4265 extern __checkReturn efx_rc_t 4266 efx_mae_action_set_populate_encap( 4267 __in efx_mae_actions_t *spec); 4268 4269 LIBEFX_API 4270 extern __checkReturn efx_rc_t 4271 efx_mae_action_set_populate_flag( 4272 __in efx_mae_actions_t *spec); 4273 4274 LIBEFX_API 4275 extern __checkReturn efx_rc_t 4276 efx_mae_action_set_populate_mark( 4277 __in efx_mae_actions_t *spec, 4278 __in uint32_t mark_value); 4279 4280 LIBEFX_API 4281 extern __checkReturn efx_rc_t 4282 efx_mae_action_set_populate_deliver( 4283 __in efx_mae_actions_t *spec, 4284 __in const efx_mport_sel_t *mportp); 4285 4286 LIBEFX_API 4287 extern __checkReturn efx_rc_t 4288 efx_mae_action_set_populate_drop( 4289 __in efx_mae_actions_t *spec); 4290 4291 LIBEFX_API 4292 extern __checkReturn boolean_t 4293 efx_mae_action_set_specs_equal( 4294 __in const efx_mae_actions_t *left, 4295 __in const efx_mae_actions_t *right); 4296 4297 /* 4298 * Conduct a comparison to check whether two match specifications 4299 * of equal rule type (action / outer) and priority would map to 4300 * the very same rule class from the firmware's standpoint. 4301 * 4302 * For match specification fields that are not supported by firmware, 4303 * the rule class only matches if the mask/value pairs for that field 4304 * are equal. Clients should use efx_mae_match_spec_is_valid() before 4305 * calling this API to detect usage of unsupported fields. 4306 */ 4307 LIBEFX_API 4308 extern __checkReturn efx_rc_t 4309 efx_mae_match_specs_class_cmp( 4310 __in efx_nic_t *enp, 4311 __in const efx_mae_match_spec_t *left, 4312 __in const efx_mae_match_spec_t *right, 4313 __out boolean_t *have_same_classp); 4314 4315 #define EFX_MAE_RSRC_ID_INVALID UINT32_MAX 4316 4317 /* Rule ID */ 4318 typedef struct efx_mae_rule_id_s { 4319 uint32_t id; 4320 } efx_mae_rule_id_t; 4321 4322 LIBEFX_API 4323 extern __checkReturn efx_rc_t 4324 efx_mae_outer_rule_insert( 4325 __in efx_nic_t *enp, 4326 __in const efx_mae_match_spec_t *spec, 4327 __in efx_tunnel_protocol_t encap_type, 4328 __out efx_mae_rule_id_t *or_idp); 4329 4330 LIBEFX_API 4331 extern __checkReturn efx_rc_t 4332 efx_mae_outer_rule_remove( 4333 __in efx_nic_t *enp, 4334 __in const efx_mae_rule_id_t *or_idp); 4335 4336 LIBEFX_API 4337 extern __checkReturn efx_rc_t 4338 efx_mae_match_spec_outer_rule_id_set( 4339 __in efx_mae_match_spec_t *spec, 4340 __in const efx_mae_rule_id_t *or_idp); 4341 4342 /* Encap. header ID */ 4343 typedef struct efx_mae_eh_id_s { 4344 uint32_t id; 4345 } efx_mae_eh_id_t; 4346 4347 LIBEFX_API 4348 extern __checkReturn efx_rc_t 4349 efx_mae_encap_header_alloc( 4350 __in efx_nic_t *enp, 4351 __in efx_tunnel_protocol_t encap_type, 4352 __in_bcount(header_size) uint8_t *header_data, 4353 __in size_t header_size, 4354 __out efx_mae_eh_id_t *eh_idp); 4355 4356 LIBEFX_API 4357 extern __checkReturn efx_rc_t 4358 efx_mae_encap_header_free( 4359 __in efx_nic_t *enp, 4360 __in const efx_mae_eh_id_t *eh_idp); 4361 4362 /* See description before efx_mae_action_set_populate_encap(). */ 4363 LIBEFX_API 4364 extern __checkReturn efx_rc_t 4365 efx_mae_action_set_fill_in_eh_id( 4366 __in efx_mae_actions_t *spec, 4367 __in const efx_mae_eh_id_t *eh_idp); 4368 4369 /* Action set ID */ 4370 typedef struct efx_mae_aset_id_s { 4371 uint32_t id; 4372 } efx_mae_aset_id_t; 4373 4374 LIBEFX_API 4375 extern __checkReturn efx_rc_t 4376 efx_mae_action_set_alloc( 4377 __in efx_nic_t *enp, 4378 __in const efx_mae_actions_t *spec, 4379 __out efx_mae_aset_id_t *aset_idp); 4380 4381 LIBEFX_API 4382 extern __checkReturn efx_rc_t 4383 efx_mae_action_set_free( 4384 __in efx_nic_t *enp, 4385 __in const efx_mae_aset_id_t *aset_idp); 4386 4387 /* Action set list ID */ 4388 typedef struct efx_mae_aset_list_id_s { 4389 uint32_t id; 4390 } efx_mae_aset_list_id_t; 4391 4392 /* 4393 * Either action set list ID or action set ID must be passed to this API, 4394 * but not both. 4395 */ 4396 LIBEFX_API 4397 extern __checkReturn efx_rc_t 4398 efx_mae_action_rule_insert( 4399 __in efx_nic_t *enp, 4400 __in const efx_mae_match_spec_t *spec, 4401 __in const efx_mae_aset_list_id_t *asl_idp, 4402 __in const efx_mae_aset_id_t *as_idp, 4403 __out efx_mae_rule_id_t *ar_idp); 4404 4405 LIBEFX_API 4406 extern __checkReturn efx_rc_t 4407 efx_mae_action_rule_remove( 4408 __in efx_nic_t *enp, 4409 __in const efx_mae_rule_id_t *ar_idp); 4410 4411 #endif /* EFSYS_OPT_MAE */ 4412 4413 #if EFSYS_OPT_VIRTIO 4414 4415 /* A Virtio net device can have one or more pairs of Rx/Tx virtqueues 4416 * while virtio block device has a single virtqueue, 4417 * for further details refer section of 4.2.3 of SF-120734 4418 */ 4419 typedef enum efx_virtio_vq_type_e { 4420 EFX_VIRTIO_VQ_TYPE_NET_RXQ, 4421 EFX_VIRTIO_VQ_TYPE_NET_TXQ, 4422 EFX_VIRTIO_VQ_TYPE_BLOCK, 4423 EFX_VIRTIO_VQ_NTYPES 4424 } efx_virtio_vq_type_t; 4425 4426 typedef struct efx_virtio_vq_dyncfg_s { 4427 /* 4428 * If queue is being created to be migrated then this 4429 * should be the FINAL_PIDX value returned by MC_CMD_VIRTIO_FINI_QUEUE 4430 * of the queue being migrated from. Otherwise, it should be zero. 4431 */ 4432 uint32_t evvd_vq_pidx; 4433 /* 4434 * If this queue is being created to be migrated then this 4435 * should be the FINAL_CIDX value returned by MC_CMD_VIRTIO_FINI_QUEUE 4436 * of the queue being migrated from. Otherwise, it should be zero. 4437 */ 4438 uint32_t evvd_vq_cidx; 4439 } efx_virtio_vq_dyncfg_t; 4440 4441 /* 4442 * Virtqueue size must be a power of 2, maximum size is 32768 4443 * (see VIRTIO v1.1 section 2.6) 4444 */ 4445 #define EFX_VIRTIO_MAX_VQ_SIZE 0x8000 4446 4447 typedef struct efx_virtio_vq_cfg_s { 4448 unsigned int evvc_vq_num; 4449 efx_virtio_vq_type_t evvc_type; 4450 /* 4451 * vDPA as VF : It is target VF number if queue is being created on VF. 4452 * vDPA as PF : If queue to be created on PF then it should be 4453 * EFX_PCI_VF_INVALID. 4454 */ 4455 uint16_t evvc_target_vf; 4456 /* 4457 * Maximum virtqueue size is EFX_VIRTIO_MAX_VQ_SIZE and 4458 * virtqueue size 0 means the queue is unavailable. 4459 */ 4460 uint32_t evvc_vq_size; 4461 efsys_dma_addr_t evvc_desc_tbl_addr; 4462 efsys_dma_addr_t evvc_avail_ring_addr; 4463 efsys_dma_addr_t evvc_used_ring_addr; 4464 /* MSIX vector number for the virtqueue or 0xFFFF if MSIX is not used */ 4465 uint16_t evvc_msix_vector; 4466 /* 4467 * evvc_pas_id contains a PCIe address space identifier if the queue 4468 * uses PASID. 4469 */ 4470 boolean_t evvc_use_pasid; 4471 uint32_t evvc_pas_id; 4472 /* Negotiated virtio features to be applied to this virtqueue */ 4473 uint64_t evcc_features; 4474 } efx_virtio_vq_cfg_t; 4475 4476 typedef struct efx_virtio_vq_s efx_virtio_vq_t; 4477 4478 typedef enum efx_virtio_device_type_e { 4479 EFX_VIRTIO_DEVICE_TYPE_RESERVED, 4480 EFX_VIRTIO_DEVICE_TYPE_NET, 4481 EFX_VIRTIO_DEVICE_TYPE_BLOCK, 4482 EFX_VIRTIO_DEVICE_NTYPES 4483 } efx_virtio_device_type_t; 4484 4485 LIBEFX_API 4486 extern __checkReturn efx_rc_t 4487 efx_virtio_init( 4488 __in efx_nic_t *enp); 4489 4490 LIBEFX_API 4491 extern void 4492 efx_virtio_fini( 4493 __in efx_nic_t *enp); 4494 4495 /* 4496 * When virtio net driver in the guest sets VIRTIO_CONFIG_STATUS_DRIVER_OK bit, 4497 * hypervisor starts configuring all the virtqueues in the device. When the 4498 * vhost_user has received VHOST_USER_SET_VRING_ENABLE for all the virtqueues, 4499 * then it invokes VDPA driver callback dev_conf. APIs qstart and qcreate would 4500 * be invoked from dev_conf callback to create the virtqueues, For further 4501 * details refer SF-122427. 4502 */ 4503 LIBEFX_API 4504 extern __checkReturn efx_rc_t 4505 efx_virtio_qcreate( 4506 __in efx_nic_t *enp, 4507 __deref_out efx_virtio_vq_t **evvpp); 4508 4509 LIBEFX_API 4510 extern __checkReturn efx_rc_t 4511 efx_virtio_qstart( 4512 __in efx_virtio_vq_t *evvp, 4513 __in efx_virtio_vq_cfg_t *evvcp, 4514 __in_opt efx_virtio_vq_dyncfg_t *evvdp); 4515 4516 LIBEFX_API 4517 extern __checkReturn efx_rc_t 4518 efx_virtio_qstop( 4519 __in efx_virtio_vq_t *evvp, 4520 __out_opt efx_virtio_vq_dyncfg_t *evvdp); 4521 4522 LIBEFX_API 4523 extern void 4524 efx_virtio_qdestroy( 4525 __in efx_virtio_vq_t *evvp); 4526 4527 /* 4528 * Get the offset in the BAR of the doorbells for a VI. 4529 * net device : doorbell offset of RX & TX queues 4530 * block device : request doorbell offset in the BAR. 4531 * For further details refer section of 4 of SF-119689 4532 */ 4533 LIBEFX_API 4534 extern __checkReturn efx_rc_t 4535 efx_virtio_get_doorbell_offset( 4536 __in efx_virtio_vq_t *evvp, 4537 __out uint32_t *offsetp); 4538 4539 LIBEFX_API 4540 extern __checkReturn efx_rc_t 4541 efx_virtio_get_features( 4542 __in efx_nic_t *enp, 4543 __in efx_virtio_device_type_t type, 4544 __out uint64_t *featuresp); 4545 4546 LIBEFX_API 4547 extern __checkReturn efx_rc_t 4548 efx_virtio_verify_features( 4549 __in efx_nic_t *enp, 4550 __in efx_virtio_device_type_t type, 4551 __in uint64_t features); 4552 4553 #endif /* EFSYS_OPT_VIRTIO */ 4554 4555 #ifdef __cplusplus 4556 } 4557 #endif 4558 4559 #endif /* _SYS_EFX_H */ 4560