drivers/common/sfc_efx/base/efx.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  *
   3  * Copyright(c) 2019-2020 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 /* Driver resource limits (minimum required/maximum usable). */
1651 typedef struct efx_drv_limits_s {
1652         uint32_t        edl_min_evq_count;
1653         uint32_t        edl_max_evq_count;
1654
1655         uint32_t        edl_min_rxq_count;
1656         uint32_t        edl_max_rxq_count;
1657
1658         uint32_t        edl_min_txq_count;
1659         uint32_t        edl_max_txq_count;
1660
1661         /* PIO blocks (sub-allocated from piobuf) */
1662         uint32_t        edl_min_pio_alloc_size;
1663         uint32_t        edl_max_pio_alloc_count;
1664 } efx_drv_limits_t;
1665
1666 LIBEFX_API
1667 extern  __checkReturn   efx_rc_t
1668 efx_nic_set_drv_limits(
1669         __inout         efx_nic_t *enp,
1670         __in            efx_drv_limits_t *edlp);
1671
1672 /*
1673  * Register the OS driver version string for management agents
1674  * (e.g. via NC-SI). The content length is provided (i.e. no
1675  * NUL terminator). Use length 0 to indicate no version string
1676  * should be advertised. It is valid to set the version string
1677  * only before efx_nic_probe() is called.
1678  */
1679 LIBEFX_API
1680 extern  __checkReturn   efx_rc_t
1681 efx_nic_set_drv_version(
1682         __inout                 efx_nic_t *enp,
1683         __in_ecount(length)     char const *verp,
1684         __in                    size_t length);
1685
1686 typedef enum efx_nic_region_e {
1687         EFX_REGION_VI,                  /* Memory BAR UC mapping */
1688         EFX_REGION_PIO_WRITE_VI,        /* Memory BAR WC mapping */
1689 } efx_nic_region_t;
1690
1691 LIBEFX_API
1692 extern  __checkReturn   efx_rc_t
1693 efx_nic_get_bar_region(
1694         __in            efx_nic_t *enp,
1695         __in            efx_nic_region_t region,
1696         __out           uint32_t *offsetp,
1697         __out           size_t *sizep);
1698
1699 LIBEFX_API
1700 extern  __checkReturn   efx_rc_t
1701 efx_nic_get_vi_pool(
1702         __in            efx_nic_t *enp,
1703         __out           uint32_t *evq_countp,
1704         __out           uint32_t *rxq_countp,
1705         __out           uint32_t *txq_countp);
1706
1707
1708 #if EFSYS_OPT_VPD
1709
1710 typedef enum efx_vpd_tag_e {
1711         EFX_VPD_ID = 0x02,
1712         EFX_VPD_END = 0x0f,
1713         EFX_VPD_RO = 0x10,
1714         EFX_VPD_RW = 0x11,
1715 } efx_vpd_tag_t;
1716
1717 typedef uint16_t efx_vpd_keyword_t;
1718
1719 typedef struct efx_vpd_value_s {
1720         efx_vpd_tag_t           evv_tag;
1721         efx_vpd_keyword_t       evv_keyword;
1722         uint8_t                 evv_length;
1723         uint8_t                 evv_value[0x100];
1724 } efx_vpd_value_t;
1725
1726
1727 #define EFX_VPD_KEYWORD(x, y) ((x) | ((y) << 8))
1728
1729 LIBEFX_API
1730 extern  __checkReturn           efx_rc_t
1731 efx_vpd_init(
1732         __in                    efx_nic_t *enp);
1733
1734 LIBEFX_API
1735 extern  __checkReturn           efx_rc_t
1736 efx_vpd_size(
1737         __in                    efx_nic_t *enp,
1738         __out                   size_t *sizep);
1739
1740 LIBEFX_API
1741 extern  __checkReturn           efx_rc_t
1742 efx_vpd_read(
1743         __in                    efx_nic_t *enp,
1744         __out_bcount(size)      caddr_t data,
1745         __in                    size_t size);
1746
1747 LIBEFX_API
1748 extern  __checkReturn           efx_rc_t
1749 efx_vpd_verify(
1750         __in                    efx_nic_t *enp,
1751         __in_bcount(size)       caddr_t data,
1752         __in                    size_t size);
1753
1754 LIBEFX_API
1755 extern  __checkReturn           efx_rc_t
1756 efx_vpd_reinit(
1757         __in                    efx_nic_t *enp,
1758         __in_bcount(size)       caddr_t data,
1759         __in                    size_t size);
1760
1761 LIBEFX_API
1762 extern  __checkReturn           efx_rc_t
1763 efx_vpd_get(
1764         __in                    efx_nic_t *enp,
1765         __in_bcount(size)       caddr_t data,
1766         __in                    size_t size,
1767         __inout                 efx_vpd_value_t *evvp);
1768
1769 LIBEFX_API
1770 extern  __checkReturn           efx_rc_t
1771 efx_vpd_set(
1772         __in                    efx_nic_t *enp,
1773         __inout_bcount(size)    caddr_t data,
1774         __in                    size_t size,
1775         __in                    efx_vpd_value_t *evvp);
1776
1777 LIBEFX_API
1778 extern  __checkReturn           efx_rc_t
1779 efx_vpd_next(
1780         __in                    efx_nic_t *enp,
1781         __inout_bcount(size)    caddr_t data,
1782         __in                    size_t size,
1783         __out                   efx_vpd_value_t *evvp,
1784         __inout                 unsigned int *contp);
1785
1786 LIBEFX_API
1787 extern  __checkReturn           efx_rc_t
1788 efx_vpd_write(
1789         __in                    efx_nic_t *enp,
1790         __in_bcount(size)       caddr_t data,
1791         __in                    size_t size);
1792
1793 LIBEFX_API
1794 extern                          void
1795 efx_vpd_fini(
1796         __in                    efx_nic_t *enp);
1797
1798 #endif  /* EFSYS_OPT_VPD */
1799
1800 /* NVRAM */
1801
1802 #if EFSYS_OPT_NVRAM
1803
1804 typedef enum efx_nvram_type_e {
1805         EFX_NVRAM_INVALID = 0,
1806         EFX_NVRAM_BOOTROM,
1807         EFX_NVRAM_BOOTROM_CFG,
1808         EFX_NVRAM_MC_FIRMWARE,
1809         EFX_NVRAM_MC_GOLDEN,
1810         EFX_NVRAM_PHY,
1811         EFX_NVRAM_NULLPHY,
1812         EFX_NVRAM_FPGA,
1813         EFX_NVRAM_FCFW,
1814         EFX_NVRAM_CPLD,
1815         EFX_NVRAM_FPGA_BACKUP,
1816         EFX_NVRAM_DYNAMIC_CFG,
1817         EFX_NVRAM_LICENSE,
1818         EFX_NVRAM_UEFIROM,
1819         EFX_NVRAM_MUM_FIRMWARE,
1820         EFX_NVRAM_DYNCONFIG_DEFAULTS,
1821         EFX_NVRAM_ROMCONFIG_DEFAULTS,
1822         EFX_NVRAM_BUNDLE,
1823         EFX_NVRAM_BUNDLE_METADATA,
1824         EFX_NVRAM_NTYPES,
1825 } efx_nvram_type_t;
1826
1827 typedef struct efx_nvram_info_s {
1828         uint32_t eni_flags;
1829         uint32_t eni_partn_size;
1830         uint32_t eni_address;
1831         uint32_t eni_erase_size;
1832         uint32_t eni_write_size;
1833 } efx_nvram_info_t;
1834
1835 #define EFX_NVRAM_FLAG_READ_ONLY        (1 << 0)
1836
1837 LIBEFX_API
1838 extern  __checkReturn           efx_rc_t
1839 efx_nvram_init(
1840         __in                    efx_nic_t *enp);
1841
1842 #if EFSYS_OPT_DIAG
1843
1844 LIBEFX_API
1845 extern  __checkReturn           efx_rc_t
1846 efx_nvram_test(
1847         __in                    efx_nic_t *enp);
1848
1849 #endif  /* EFSYS_OPT_DIAG */
1850
1851 LIBEFX_API
1852 extern  __checkReturn           efx_rc_t
1853 efx_nvram_size(
1854         __in                    efx_nic_t *enp,
1855         __in                    efx_nvram_type_t type,
1856         __out                   size_t *sizep);
1857
1858 LIBEFX_API
1859 extern  __checkReturn           efx_rc_t
1860 efx_nvram_info(
1861         __in                    efx_nic_t *enp,
1862         __in                    efx_nvram_type_t type,
1863         __out                   efx_nvram_info_t *enip);
1864
1865 LIBEFX_API
1866 extern  __checkReturn           efx_rc_t
1867 efx_nvram_rw_start(
1868         __in                    efx_nic_t *enp,
1869         __in                    efx_nvram_type_t type,
1870         __out_opt               size_t *pref_chunkp);
1871
1872 LIBEFX_API
1873 extern  __checkReturn           efx_rc_t
1874 efx_nvram_rw_finish(
1875         __in                    efx_nic_t *enp,
1876         __in                    efx_nvram_type_t type,
1877         __out_opt               uint32_t *verify_resultp);
1878
1879 LIBEFX_API
1880 extern  __checkReturn           efx_rc_t
1881 efx_nvram_get_version(
1882         __in                    efx_nic_t *enp,
1883         __in                    efx_nvram_type_t type,
1884         __out                   uint32_t *subtypep,
1885         __out_ecount(4)         uint16_t version[4]);
1886
1887 LIBEFX_API
1888 extern  __checkReturn           efx_rc_t
1889 efx_nvram_read_chunk(
1890         __in                    efx_nic_t *enp,
1891         __in                    efx_nvram_type_t type,
1892         __in                    unsigned int offset,
1893         __out_bcount(size)      caddr_t data,
1894         __in                    size_t size);
1895
1896 LIBEFX_API
1897 extern  __checkReturn           efx_rc_t
1898 efx_nvram_read_backup(
1899         __in                    efx_nic_t *enp,
1900         __in                    efx_nvram_type_t type,
1901         __in                    unsigned int offset,
1902         __out_bcount(size)      caddr_t data,
1903         __in                    size_t size);
1904
1905 LIBEFX_API
1906 extern  __checkReturn           efx_rc_t
1907 efx_nvram_set_version(
1908         __in                    efx_nic_t *enp,
1909         __in                    efx_nvram_type_t type,
1910         __in_ecount(4)          uint16_t version[4]);
1911
1912 LIBEFX_API
1913 extern  __checkReturn           efx_rc_t
1914 efx_nvram_validate(
1915         __in                    efx_nic_t *enp,
1916         __in                    efx_nvram_type_t type,
1917         __in_bcount(partn_size) caddr_t partn_data,
1918         __in                    size_t partn_size);
1919
1920 LIBEFX_API
1921 extern   __checkReturn          efx_rc_t
1922 efx_nvram_erase(
1923         __in                    efx_nic_t *enp,
1924         __in                    efx_nvram_type_t type);
1925
1926 LIBEFX_API
1927 extern  __checkReturn           efx_rc_t
1928 efx_nvram_write_chunk(
1929         __in                    efx_nic_t *enp,
1930         __in                    efx_nvram_type_t type,
1931         __in                    unsigned int offset,
1932         __in_bcount(size)       caddr_t data,
1933         __in                    size_t size);
1934
1935 LIBEFX_API
1936 extern                          void
1937 efx_nvram_fini(
1938         __in                    efx_nic_t *enp);
1939
1940 #endif  /* EFSYS_OPT_NVRAM */
1941
1942 #if EFSYS_OPT_BOOTCFG
1943
1944 /* Report size and offset of bootcfg sector in NVRAM partition. */
1945 LIBEFX_API
1946 extern  __checkReturn           efx_rc_t
1947 efx_bootcfg_sector_info(
1948         __in                    efx_nic_t *enp,
1949         __in                    uint32_t pf,
1950         __out_opt               uint32_t *sector_countp,
1951         __out                   size_t *offsetp,
1952         __out                   size_t *max_sizep);
1953
1954 /*
1955  * Copy bootcfg sector data to a target buffer which may differ in size.
1956  * Optionally corrects format errors in source buffer.
1957  */
1958 LIBEFX_API
1959 extern                          efx_rc_t
1960 efx_bootcfg_copy_sector(
1961         __in                    efx_nic_t *enp,
1962         __inout_bcount(sector_length)
1963                                 uint8_t *sector,
1964         __in                    size_t sector_length,
1965         __out_bcount(data_size) uint8_t *data,
1966         __in                    size_t data_size,
1967         __in                    boolean_t handle_format_errors);
1968
1969 LIBEFX_API
1970 extern                          efx_rc_t
1971 efx_bootcfg_read(
1972         __in                    efx_nic_t *enp,
1973         __out_bcount(size)      uint8_t *data,
1974         __in                    size_t size);
1975
1976 LIBEFX_API
1977 extern                          efx_rc_t
1978 efx_bootcfg_write(
1979         __in                    efx_nic_t *enp,
1980         __in_bcount(size)       uint8_t *data,
1981         __in                    size_t size);
1982
1983
1984 /*
1985  * Processing routines for buffers arranged in the DHCP/BOOTP option format
1986  * (see https://tools.ietf.org/html/rfc1533)
1987  *
1988  * Summarising the format: the buffer is a sequence of options. All options
1989  * begin with a tag octet, which uniquely identifies the option.  Fixed-
1990  * length options without data consist of only a tag octet.  Only options PAD
1991  * (0) and END (255) are fixed length.  All other options are variable-length
1992  * with a length octet following the tag octet.  The value of the length
1993  * octet does not include the two octets specifying the tag and length.  The
1994  * length octet is followed by "length" octets of data.
1995  *
1996  * Option data may be a sequence of sub-options in the same format. The data
1997  * content of the encapsulating option is one or more encapsulated sub-options,
1998  * with no terminating END tag is required.
1999  *
2000  * To be valid, the top-level sequence of options should be terminated by an
2001  * END tag. The buffer should be padded with the PAD byte.
2002  *
2003  * When stored to NVRAM, the DHCP option format buffer is preceded by a
2004  * checksum octet. The full buffer (including after the END tag) contributes
2005  * to the checksum, hence the need to fill the buffer to the end with PAD.
2006  */
2007
2008 #define EFX_DHCP_END ((uint8_t)0xff)
2009 #define EFX_DHCP_PAD ((uint8_t)0)
2010
2011 #define EFX_DHCP_ENCAP_OPT(encapsulator, encapsulated) \
2012   (uint16_t)(((encapsulator) << 8) | (encapsulated))
2013
2014 LIBEFX_API
2015 extern  __checkReturn           uint8_t
2016 efx_dhcp_csum(
2017         __in_bcount(size)       uint8_t const *data,
2018         __in                    size_t size);
2019
2020 LIBEFX_API
2021 extern  __checkReturn           efx_rc_t
2022 efx_dhcp_verify(
2023         __in_bcount(size)       uint8_t const *data,
2024         __in                    size_t size,
2025         __out_opt               size_t *usedp);
2026
2027 LIBEFX_API
2028 extern  __checkReturn   efx_rc_t
2029 efx_dhcp_find_tag(
2030         __in_bcount(buffer_length)      uint8_t *bufferp,
2031         __in                            size_t buffer_length,
2032         __in                            uint16_t opt,
2033         __deref_out                     uint8_t **valuepp,
2034         __out                           size_t *value_lengthp);
2035
2036 LIBEFX_API
2037 extern  __checkReturn   efx_rc_t
2038 efx_dhcp_find_end(
2039         __in_bcount(buffer_length)      uint8_t *bufferp,
2040         __in                            size_t buffer_length,
2041         __deref_out                     uint8_t **endpp);
2042
2043
2044 LIBEFX_API
2045 extern  __checkReturn   efx_rc_t
2046 efx_dhcp_delete_tag(
2047         __inout_bcount(buffer_length)   uint8_t *bufferp,
2048         __in                            size_t buffer_length,
2049         __in                            uint16_t opt);
2050
2051 LIBEFX_API
2052 extern  __checkReturn   efx_rc_t
2053 efx_dhcp_add_tag(
2054         __inout_bcount(buffer_length)   uint8_t *bufferp,
2055         __in                            size_t buffer_length,
2056         __in                            uint16_t opt,
2057         __in_bcount_opt(value_length)   uint8_t *valuep,
2058         __in                            size_t value_length);
2059
2060 LIBEFX_API
2061 extern  __checkReturn   efx_rc_t
2062 efx_dhcp_update_tag(
2063         __inout_bcount(buffer_length)   uint8_t *bufferp,
2064         __in                            size_t buffer_length,
2065         __in                            uint16_t opt,
2066         __in                            uint8_t *value_locationp,
2067         __in_bcount_opt(value_length)   uint8_t *valuep,
2068         __in                            size_t value_length);
2069
2070
2071 #endif  /* EFSYS_OPT_BOOTCFG */
2072
2073 #if EFSYS_OPT_IMAGE_LAYOUT
2074
2075 #include "ef10_signed_image_layout.h"
2076
2077 /*
2078  * Image header used in unsigned and signed image layouts (see SF-102785-PS).
2079  *
2080  * NOTE:
2081  * The image header format is extensible. However, older drivers require an
2082  * exact match of image header version and header length when validating and
2083  * writing firmware images.
2084  *
2085  * To avoid breaking backward compatibility, we use the upper bits of the
2086  * controller version fields to contain an extra version number used for
2087  * combined bootROM and UEFI ROM images on EF10 and later (to hold the UEFI ROM
2088  * version). See bug39254 and SF-102785-PS for details.
2089  */
2090 typedef struct efx_image_header_s {
2091         uint32_t        eih_magic;
2092         uint32_t        eih_version;
2093         uint32_t        eih_type;
2094         uint32_t        eih_subtype;
2095         uint32_t        eih_code_size;
2096         uint32_t        eih_size;
2097         union {
2098                 uint32_t        eih_controller_version_min;
2099                 struct {
2100                         uint16_t        eih_controller_version_min_short;
2101                         uint8_t         eih_extra_version_a;
2102                         uint8_t         eih_extra_version_b;
2103                 };
2104         };
2105         union {
2106                 uint32_t        eih_controller_version_max;
2107                 struct {
2108                         uint16_t        eih_controller_version_max_short;
2109                         uint8_t         eih_extra_version_c;
2110                         uint8_t         eih_extra_version_d;
2111                 };
2112         };
2113         uint16_t        eih_code_version_a;
2114         uint16_t        eih_code_version_b;
2115         uint16_t        eih_code_version_c;
2116         uint16_t        eih_code_version_d;
2117 } efx_image_header_t;
2118
2119 #define EFX_IMAGE_HEADER_SIZE           (40)
2120 #define EFX_IMAGE_HEADER_VERSION        (4)
2121 #define EFX_IMAGE_HEADER_MAGIC          (0x106F1A5)
2122
2123
2124 typedef struct efx_image_trailer_s {
2125         uint32_t        eit_crc;
2126 } efx_image_trailer_t;
2127
2128 #define EFX_IMAGE_TRAILER_SIZE          (4)
2129
2130 typedef enum efx_image_format_e {
2131         EFX_IMAGE_FORMAT_NO_IMAGE,
2132         EFX_IMAGE_FORMAT_INVALID,
2133         EFX_IMAGE_FORMAT_UNSIGNED,
2134         EFX_IMAGE_FORMAT_SIGNED,
2135         EFX_IMAGE_FORMAT_SIGNED_PACKAGE
2136 } efx_image_format_t;
2137
2138 typedef struct efx_image_info_s {
2139         efx_image_format_t      eii_format;
2140         uint8_t *               eii_imagep;
2141         size_t                  eii_image_size;
2142         efx_image_header_t *    eii_headerp;
2143 } efx_image_info_t;
2144
2145 LIBEFX_API
2146 extern  __checkReturn   efx_rc_t
2147 efx_check_reflash_image(
2148         __in            void                    *bufferp,
2149         __in            uint32_t                buffer_size,
2150         __out           efx_image_info_t        *infop);
2151
2152 LIBEFX_API
2153 extern  __checkReturn   efx_rc_t
2154 efx_build_signed_image_write_buffer(
2155         __out_bcount(buffer_size)
2156                         uint8_t                 *bufferp,
2157         __in            uint32_t                buffer_size,
2158         __in            efx_image_info_t        *infop,
2159         __out           efx_image_header_t      **headerpp);
2160
2161 #endif  /* EFSYS_OPT_IMAGE_LAYOUT */
2162
2163 #if EFSYS_OPT_DIAG
2164
2165 typedef enum efx_pattern_type_t {
2166         EFX_PATTERN_BYTE_INCREMENT = 0,
2167         EFX_PATTERN_ALL_THE_SAME,
2168         EFX_PATTERN_BIT_ALTERNATE,
2169         EFX_PATTERN_BYTE_ALTERNATE,
2170         EFX_PATTERN_BYTE_CHANGING,
2171         EFX_PATTERN_BIT_SWEEP,
2172         EFX_PATTERN_NTYPES
2173 } efx_pattern_type_t;
2174
2175 typedef                 void
2176 (*efx_sram_pattern_fn_t)(
2177         __in            size_t row,
2178         __in            boolean_t negate,
2179         __out           efx_qword_t *eqp);
2180
2181 LIBEFX_API
2182 extern  __checkReturn   efx_rc_t
2183 efx_sram_test(
2184         __in            efx_nic_t *enp,
2185         __in            efx_pattern_type_t type);
2186
2187 #endif  /* EFSYS_OPT_DIAG */
2188
2189 LIBEFX_API
2190 extern  __checkReturn   efx_rc_t
2191 efx_sram_buf_tbl_set(
2192         __in            efx_nic_t *enp,
2193         __in            uint32_t id,
2194         __in            efsys_mem_t *esmp,
2195         __in            size_t n);
2196
2197 LIBEFX_API
2198 extern          void
2199 efx_sram_buf_tbl_clear(
2200         __in    efx_nic_t *enp,
2201         __in    uint32_t id,
2202         __in    size_t n);
2203
2204 #define EFX_BUF_TBL_SIZE        0x20000
2205
2206 #define EFX_BUF_SIZE            4096
2207
2208 /* EV */
2209
2210 typedef struct efx_evq_s        efx_evq_t;
2211
2212 #if EFSYS_OPT_QSTATS
2213
2214 /* START MKCONFIG GENERATED EfxHeaderEventQueueBlock 0a147ace40844969 */
2215 typedef enum efx_ev_qstat_e {
2216         EV_ALL,
2217         EV_RX,
2218         EV_RX_OK,
2219         EV_RX_FRM_TRUNC,
2220         EV_RX_TOBE_DISC,
2221         EV_RX_PAUSE_FRM_ERR,
2222         EV_RX_BUF_OWNER_ID_ERR,
2223         EV_RX_IPV4_HDR_CHKSUM_ERR,
2224         EV_RX_TCP_UDP_CHKSUM_ERR,
2225         EV_RX_ETH_CRC_ERR,
2226         EV_RX_IP_FRAG_ERR,
2227         EV_RX_MCAST_PKT,
2228         EV_RX_MCAST_HASH_MATCH,
2229         EV_RX_TCP_IPV4,
2230         EV_RX_TCP_IPV6,
2231         EV_RX_UDP_IPV4,
2232         EV_RX_UDP_IPV6,
2233         EV_RX_OTHER_IPV4,
2234         EV_RX_OTHER_IPV6,
2235         EV_RX_NON_IP,
2236         EV_RX_BATCH,
2237         EV_TX,
2238         EV_TX_WQ_FF_FULL,
2239         EV_TX_PKT_ERR,
2240         EV_TX_PKT_TOO_BIG,
2241         EV_TX_UNEXPECTED,
2242         EV_GLOBAL,
2243         EV_GLOBAL_MNT,
2244         EV_DRIVER,
2245         EV_DRIVER_SRM_UPD_DONE,
2246         EV_DRIVER_TX_DESCQ_FLS_DONE,
2247         EV_DRIVER_RX_DESCQ_FLS_DONE,
2248         EV_DRIVER_RX_DESCQ_FLS_FAILED,
2249         EV_DRIVER_RX_DSC_ERROR,
2250         EV_DRIVER_TX_DSC_ERROR,
2251         EV_DRV_GEN,
2252         EV_MCDI_RESPONSE,
2253         EV_RX_PARSE_INCOMPLETE,
2254         EV_NQSTATS
2255 } efx_ev_qstat_t;
2256
2257 /* END MKCONFIG GENERATED EfxHeaderEventQueueBlock */
2258
2259 #endif  /* EFSYS_OPT_QSTATS */
2260
2261 LIBEFX_API
2262 extern  __checkReturn   efx_rc_t
2263 efx_ev_init(
2264         __in            efx_nic_t *enp);
2265
2266 LIBEFX_API
2267 extern          void
2268 efx_ev_fini(
2269         __in            efx_nic_t *enp);
2270
2271 LIBEFX_API
2272 extern  __checkReturn   size_t
2273 efx_evq_size(
2274         __in    const efx_nic_t *enp,
2275         __in    unsigned int ndescs,
2276         __in    uint32_t flags);
2277
2278 LIBEFX_API
2279 extern  __checkReturn   unsigned int
2280 efx_evq_nbufs(
2281         __in    const efx_nic_t *enp,
2282         __in    unsigned int ndescs,
2283         __in    uint32_t flags);
2284
2285 #define EFX_EVQ_FLAGS_TYPE_MASK         (0x3)
2286 #define EFX_EVQ_FLAGS_TYPE_AUTO         (0x0)
2287 #define EFX_EVQ_FLAGS_TYPE_THROUGHPUT   (0x1)
2288 #define EFX_EVQ_FLAGS_TYPE_LOW_LATENCY  (0x2)
2289
2290 #define EFX_EVQ_FLAGS_NOTIFY_MASK       (0xC)
2291 #define EFX_EVQ_FLAGS_NOTIFY_INTERRUPT  (0x0)   /* Interrupting (default) */
2292 #define EFX_EVQ_FLAGS_NOTIFY_DISABLED   (0x4)   /* Non-interrupting */
2293
2294 /*
2295  * Use the NO_CONT_EV RX event format, which allows the firmware to operate more
2296  * efficiently at high data rates. See SF-109306-TC 5.11 "Events for RXQs in
2297  * NO_CONT_EV mode".
2298  *
2299  * NO_CONT_EV requires EVQ_RX_MERGE and RXQ_FORCED_EV_MERGING to both be set,
2300  * which is the case when an event queue is set to THROUGHPUT mode.
2301  */
2302 #define EFX_EVQ_FLAGS_NO_CONT_EV        (0x10)
2303
2304 /* Configure EVQ for extended width events (EF100 only) */
2305 #define EFX_EVQ_FLAGS_EXTENDED_WIDTH    (0x20)
2306
2307
2308 LIBEFX_API
2309 extern  __checkReturn   efx_rc_t
2310 efx_ev_qcreate(
2311         __in            efx_nic_t *enp,
2312         __in            unsigned int index,
2313         __in            efsys_mem_t *esmp,
2314         __in            size_t ndescs,
2315         __in            uint32_t id,
2316         __in            uint32_t us,
2317         __in            uint32_t flags,
2318         __deref_out     efx_evq_t **eepp);
2319
2320 LIBEFX_API
2321 extern          void
2322 efx_ev_qpost(
2323         __in            efx_evq_t *eep,
2324         __in            uint16_t data);
2325
2326 typedef __checkReturn   boolean_t
2327 (*efx_initialized_ev_t)(
2328         __in_opt        void *arg);
2329
2330 #define EFX_PKT_UNICAST         0x0004
2331 #define EFX_PKT_START           0x0008
2332
2333 #define EFX_PKT_VLAN_TAGGED     0x0010
2334 #define EFX_CKSUM_TCPUDP        0x0020
2335 #define EFX_CKSUM_IPV4          0x0040
2336 #define EFX_PKT_CONT            0x0080
2337
2338 #define EFX_CHECK_VLAN          0x0100
2339 #define EFX_PKT_TCP             0x0200
2340 #define EFX_PKT_UDP             0x0400
2341 #define EFX_PKT_IPV4            0x0800
2342
2343 #define EFX_PKT_IPV6            0x1000
2344 #define EFX_PKT_PREFIX_LEN      0x2000
2345 #define EFX_ADDR_MISMATCH       0x4000
2346 #define EFX_DISCARD             0x8000
2347
2348 /*
2349  * The following flags are used only for packed stream
2350  * mode. The values for the flags are reused to fit into 16 bit,
2351  * since EFX_PKT_START and EFX_PKT_CONT are never used in
2352  * packed stream mode
2353  */
2354 #define EFX_PKT_PACKED_STREAM_NEW_BUFFER        EFX_PKT_START
2355 #define EFX_PKT_PACKED_STREAM_PARSE_INCOMPLETE  EFX_PKT_CONT
2356
2357
2358 #define EFX_EV_RX_NLABELS       32
2359 #define EFX_EV_TX_NLABELS       32
2360
2361 typedef __checkReturn   boolean_t
2362 (*efx_rx_ev_t)(
2363         __in_opt        void *arg,
2364         __in            uint32_t label,
2365         __in            uint32_t id,
2366         __in            uint32_t size,
2367         __in            uint16_t flags);
2368
2369 typedef __checkReturn   boolean_t
2370 (*efx_rx_packets_ev_t)(
2371         __in_opt        void *arg,
2372         __in            uint32_t label,
2373         __in            unsigned int num_packets,
2374         __in            uint32_t flags);
2375
2376 #if EFSYS_OPT_RX_PACKED_STREAM || EFSYS_OPT_RX_ES_SUPER_BUFFER
2377
2378 /*
2379  * Packed stream mode is documented in SF-112241-TC.
2380  * The general idea is that, instead of putting each incoming
2381  * packet into a separate buffer which is specified in a RX
2382  * descriptor, a large buffer is provided to the hardware and
2383  * packets are put there in a continuous stream.
2384  * The main advantage of such an approach is that RX queue refilling
2385  * happens much less frequently.
2386  *
2387  * Equal stride packed stream mode is documented in SF-119419-TC.
2388  * The general idea is to utilize advantages of the packed stream,
2389  * but avoid indirection in packets representation.
2390  * The main advantage of such an approach is that RX queue refilling
2391  * happens much less frequently and packets buffers are independent
2392  * from upper layers point of view.
2393  */
2394
2395 typedef __checkReturn   boolean_t
2396 (*efx_rx_ps_ev_t)(
2397         __in_opt        void *arg,
2398         __in            uint32_t label,
2399         __in            uint32_t id,
2400         __in            uint32_t pkt_count,
2401         __in            uint16_t flags);
2402
2403 #endif
2404
2405 typedef __checkReturn   boolean_t
2406 (*efx_tx_ev_t)(
2407         __in_opt        void *arg,
2408         __in            uint32_t label,
2409         __in            uint32_t id);
2410
2411 typedef __checkReturn   boolean_t
2412 (*efx_tx_ndescs_ev_t)(
2413         __in_opt        void *arg,
2414         __in            uint32_t label,
2415         __in            unsigned int ndescs);
2416
2417 #define EFX_EXCEPTION_RX_RECOVERY       0x00000001
2418 #define EFX_EXCEPTION_RX_DSC_ERROR      0x00000002
2419 #define EFX_EXCEPTION_TX_DSC_ERROR      0x00000003
2420 #define EFX_EXCEPTION_UNKNOWN_SENSOREVT 0x00000004
2421 #define EFX_EXCEPTION_FWALERT_SRAM      0x00000005
2422 #define EFX_EXCEPTION_UNKNOWN_FWALERT   0x00000006
2423 #define EFX_EXCEPTION_RX_ERROR          0x00000007
2424 #define EFX_EXCEPTION_TX_ERROR          0x00000008
2425 #define EFX_EXCEPTION_EV_ERROR          0x00000009
2426
2427 typedef __checkReturn   boolean_t
2428 (*efx_exception_ev_t)(
2429         __in_opt        void *arg,
2430         __in            uint32_t label,
2431         __in            uint32_t data);
2432
2433 typedef __checkReturn   boolean_t
2434 (*efx_rxq_flush_done_ev_t)(
2435         __in_opt        void *arg,
2436         __in            uint32_t rxq_index);
2437
2438 typedef __checkReturn   boolean_t
2439 (*efx_rxq_flush_failed_ev_t)(
2440         __in_opt        void *arg,
2441         __in            uint32_t rxq_index);
2442
2443 typedef __checkReturn   boolean_t
2444 (*efx_txq_flush_done_ev_t)(
2445         __in_opt        void *arg,
2446         __in            uint32_t txq_index);
2447
2448 typedef __checkReturn   boolean_t
2449 (*efx_software_ev_t)(
2450         __in_opt        void *arg,
2451         __in            uint16_t magic);
2452
2453 typedef __checkReturn   boolean_t
2454 (*efx_sram_ev_t)(
2455         __in_opt        void *arg,
2456         __in            uint32_t code);
2457
2458 #define EFX_SRAM_CLEAR          0
2459 #define EFX_SRAM_UPDATE         1
2460 #define EFX_SRAM_ILLEGAL_CLEAR  2
2461
2462 typedef __checkReturn   boolean_t
2463 (*efx_wake_up_ev_t)(
2464         __in_opt        void *arg,
2465         __in            uint32_t label);
2466
2467 typedef __checkReturn   boolean_t
2468 (*efx_timer_ev_t)(
2469         __in_opt        void *arg,
2470         __in            uint32_t label);
2471
2472 typedef __checkReturn   boolean_t
2473 (*efx_link_change_ev_t)(
2474         __in_opt        void *arg,
2475         __in            efx_link_mode_t link_mode);
2476
2477 #if EFSYS_OPT_MON_STATS
2478
2479 typedef __checkReturn   boolean_t
2480 (*efx_monitor_ev_t)(
2481         __in_opt        void *arg,
2482         __in            efx_mon_stat_t id,
2483         __in            efx_mon_stat_value_t value);
2484
2485 #endif  /* EFSYS_OPT_MON_STATS */
2486
2487 #if EFSYS_OPT_MAC_STATS
2488
2489 typedef __checkReturn   boolean_t
2490 (*efx_mac_stats_ev_t)(
2491         __in_opt        void *arg,
2492         __in            uint32_t generation);
2493
2494 #endif  /* EFSYS_OPT_MAC_STATS */
2495
2496 #if EFSYS_OPT_DESC_PROXY
2497
2498 /*
2499  * NOTE: This callback returns the raw descriptor data, which has not been
2500  * converted to host endian. The callback must use the EFX_OWORD macros
2501  * to extract the descriptor fields as host endian values.
2502  */
2503 typedef __checkReturn   boolean_t
2504 (*efx_desc_proxy_txq_desc_ev_t)(
2505         __in_opt        void *arg,
2506         __in            uint16_t vi_id,
2507         __in            efx_oword_t txq_desc);
2508
2509 /*
2510  * NOTE: This callback returns the raw descriptor data, which has not been
2511  * converted to host endian. The callback must use the EFX_OWORD macros
2512  * to extract the descriptor fields as host endian values.
2513  */
2514 typedef __checkReturn   boolean_t
2515 (*efx_desc_proxy_virtq_desc_ev_t)(
2516         __in_opt        void *arg,
2517         __in            uint16_t vi_id,
2518         __in            uint16_t avail,
2519         __in            efx_oword_t virtq_desc);
2520
2521 #endif /* EFSYS_OPT_DESC_PROXY */
2522
2523 typedef struct efx_ev_callbacks_s {
2524         efx_initialized_ev_t            eec_initialized;
2525         efx_rx_ev_t                     eec_rx;
2526         efx_rx_packets_ev_t             eec_rx_packets;
2527 #if EFSYS_OPT_RX_PACKED_STREAM || EFSYS_OPT_RX_ES_SUPER_BUFFER
2528         efx_rx_ps_ev_t                  eec_rx_ps;
2529 #endif
2530         efx_tx_ev_t                     eec_tx;
2531         efx_tx_ndescs_ev_t              eec_tx_ndescs;
2532         efx_exception_ev_t              eec_exception;
2533         efx_rxq_flush_done_ev_t         eec_rxq_flush_done;
2534         efx_rxq_flush_failed_ev_t       eec_rxq_flush_failed;
2535         efx_txq_flush_done_ev_t         eec_txq_flush_done;
2536         efx_software_ev_t               eec_software;
2537         efx_sram_ev_t                   eec_sram;
2538         efx_wake_up_ev_t                eec_wake_up;
2539         efx_timer_ev_t                  eec_timer;
2540         efx_link_change_ev_t            eec_link_change;
2541 #if EFSYS_OPT_MON_STATS
2542         efx_monitor_ev_t                eec_monitor;
2543 #endif  /* EFSYS_OPT_MON_STATS */
2544 #if EFSYS_OPT_MAC_STATS
2545         efx_mac_stats_ev_t              eec_mac_stats;
2546 #endif  /* EFSYS_OPT_MAC_STATS */
2547 #if EFSYS_OPT_DESC_PROXY
2548         efx_desc_proxy_txq_desc_ev_t    eec_desc_proxy_txq_desc;
2549         efx_desc_proxy_virtq_desc_ev_t  eec_desc_proxy_virtq_desc;
2550 #endif /* EFSYS_OPT_DESC_PROXY */
2551
2552 } efx_ev_callbacks_t;
2553
2554 LIBEFX_API
2555 extern  __checkReturn   boolean_t
2556 efx_ev_qpending(
2557         __in            efx_evq_t *eep,
2558         __in            unsigned int count);
2559
2560 #if EFSYS_OPT_EV_PREFETCH
2561
2562 LIBEFX_API
2563 extern                  void
2564 efx_ev_qprefetch(
2565         __in            efx_evq_t *eep,
2566         __in            unsigned int count);
2567
2568 #endif  /* EFSYS_OPT_EV_PREFETCH */
2569
2570 LIBEFX_API
2571 extern                  void
2572 efx_ev_qcreate_check_init_done(
2573         __in            efx_evq_t *eep,
2574         __in            const efx_ev_callbacks_t *eecp,
2575         __in_opt        void *arg);
2576
2577 LIBEFX_API
2578 extern                  void
2579 efx_ev_qpoll(
2580         __in            efx_evq_t *eep,
2581         __inout         unsigned int *countp,
2582         __in            const efx_ev_callbacks_t *eecp,
2583         __in_opt        void *arg);
2584
2585 LIBEFX_API
2586 extern  __checkReturn   efx_rc_t
2587 efx_ev_usecs_to_ticks(
2588         __in            efx_nic_t *enp,
2589         __in            unsigned int usecs,
2590         __out           unsigned int *ticksp);
2591
2592 LIBEFX_API
2593 extern  __checkReturn   efx_rc_t
2594 efx_ev_qmoderate(
2595         __in            efx_evq_t *eep,
2596         __in            unsigned int us);
2597
2598 LIBEFX_API
2599 extern  __checkReturn   efx_rc_t
2600 efx_ev_qprime(
2601         __in            efx_evq_t *eep,
2602         __in            unsigned int count);
2603
2604 #if EFSYS_OPT_QSTATS
2605
2606 #if EFSYS_OPT_NAMES
2607
2608 LIBEFX_API
2609 extern          const char *
2610 efx_ev_qstat_name(
2611         __in    efx_nic_t *enp,
2612         __in    unsigned int id);
2613
2614 #endif  /* EFSYS_OPT_NAMES */
2615
2616 LIBEFX_API
2617 extern                                  void
2618 efx_ev_qstats_update(
2619         __in                            efx_evq_t *eep,
2620         __inout_ecount(EV_NQSTATS)      efsys_stat_t *stat);
2621
2622 #endif  /* EFSYS_OPT_QSTATS */
2623
2624 LIBEFX_API
2625 extern          void
2626 efx_ev_qdestroy(
2627         __in    efx_evq_t *eep);
2628
2629 /* RX */
2630
2631 LIBEFX_API
2632 extern  __checkReturn   efx_rc_t
2633 efx_rx_init(
2634         __inout         efx_nic_t *enp);
2635
2636 LIBEFX_API
2637 extern          void
2638 efx_rx_fini(
2639         __in            efx_nic_t *enp);
2640
2641 #if EFSYS_OPT_RX_SCATTER
2642 LIBEFX_API
2643 extern  __checkReturn   efx_rc_t
2644 efx_rx_scatter_enable(
2645         __in            efx_nic_t *enp,
2646         __in            unsigned int buf_size);
2647 #endif  /* EFSYS_OPT_RX_SCATTER */
2648
2649 /* Handle to represent use of the default RSS context. */
2650 #define EFX_RSS_CONTEXT_DEFAULT 0xffffffff
2651
2652 #if EFSYS_OPT_RX_SCALE
2653
2654 typedef enum efx_rx_hash_alg_e {
2655         EFX_RX_HASHALG_LFSR = 0,
2656         EFX_RX_HASHALG_TOEPLITZ,
2657         EFX_RX_HASHALG_PACKED_STREAM,
2658         EFX_RX_NHASHALGS
2659 } efx_rx_hash_alg_t;
2660
2661 /*
2662  * Legacy hash type flags.
2663  *
2664  * They represent standard tuples for distinct traffic classes.
2665  */
2666 #define EFX_RX_HASH_IPV4        (1U << 0)
2667 #define EFX_RX_HASH_TCPIPV4     (1U << 1)
2668 #define EFX_RX_HASH_IPV6        (1U << 2)
2669 #define EFX_RX_HASH_TCPIPV6     (1U << 3)
2670
2671 #define EFX_RX_HASH_LEGACY_MASK         \
2672         (EFX_RX_HASH_IPV4       |       \
2673         EFX_RX_HASH_TCPIPV4     |       \
2674         EFX_RX_HASH_IPV6        |       \
2675         EFX_RX_HASH_TCPIPV6)
2676
2677 /*
2678  * The type of the argument used by efx_rx_scale_mode_set() to
2679  * provide a means for the client drivers to configure hashing.
2680  *
2681  * A properly constructed value can either be:
2682  *  - a combination of legacy flags
2683  *  - a combination of EFX_RX_HASH() flags
2684  */
2685 typedef uint32_t efx_rx_hash_type_t;
2686
2687 typedef enum efx_rx_hash_support_e {
2688         EFX_RX_HASH_UNAVAILABLE = 0,    /* Hardware hash not inserted */
2689         EFX_RX_HASH_AVAILABLE           /* Insert hash with/without RSS */
2690 } efx_rx_hash_support_t;
2691
2692 #define EFX_RSS_KEY_SIZE        40      /* RSS key size (bytes) */
2693 #define EFX_RSS_TBL_SIZE        128     /* Rows in RX indirection table */
2694 #define EFX_MAXRSS              64      /* RX indirection entry range */
2695 #define EFX_MAXRSS_LEGACY       16      /* See bug16611 and bug17213 */
2696
2697 typedef enum efx_rx_scale_context_type_e {
2698         EFX_RX_SCALE_UNAVAILABLE = 0,   /* No RX scale context */
2699         EFX_RX_SCALE_EXCLUSIVE,         /* Writable key/indirection table */
2700         EFX_RX_SCALE_SHARED             /* Read-only key/indirection table */
2701 } efx_rx_scale_context_type_t;
2702
2703 /*
2704  * Traffic classes eligible for hash computation.
2705  *
2706  * Select packet headers used in computing the receive hash.
2707  * This uses the same encoding as the RSS_MODES field of
2708  * MC_CMD_RSS_CONTEXT_SET_FLAGS.
2709  */
2710 #define EFX_RX_CLASS_IPV4_TCP_LBN       8
2711 #define EFX_RX_CLASS_IPV4_TCP_WIDTH     4
2712 #define EFX_RX_CLASS_IPV4_UDP_LBN       12
2713 #define EFX_RX_CLASS_IPV4_UDP_WIDTH     4
2714 #define EFX_RX_CLASS_IPV4_LBN           16
2715 #define EFX_RX_CLASS_IPV4_WIDTH         4
2716 #define EFX_RX_CLASS_IPV6_TCP_LBN       20
2717 #define EFX_RX_CLASS_IPV6_TCP_WIDTH     4
2718 #define EFX_RX_CLASS_IPV6_UDP_LBN       24
2719 #define EFX_RX_CLASS_IPV6_UDP_WIDTH     4
2720 #define EFX_RX_CLASS_IPV6_LBN           28
2721 #define EFX_RX_CLASS_IPV6_WIDTH         4
2722
2723 #define EFX_RX_NCLASSES                 6
2724
2725 /*
2726  * Ancillary flags used to construct generic hash tuples.
2727  * This uses the same encoding as RSS_MODE_HASH_SELECTOR.
2728  */
2729 #define EFX_RX_CLASS_HASH_SRC_ADDR      (1U << 0)
2730 #define EFX_RX_CLASS_HASH_DST_ADDR      (1U << 1)
2731 #define EFX_RX_CLASS_HASH_SRC_PORT      (1U << 2)
2732 #define EFX_RX_CLASS_HASH_DST_PORT      (1U << 3)
2733
2734 /*
2735  * Generic hash tuples.
2736  *
2737  * They express combinations of packet fields
2738  * which can contribute to the hash value for
2739  * a particular traffic class.
2740  */
2741 #define EFX_RX_CLASS_HASH_DISABLE       0
2742
2743 #define EFX_RX_CLASS_HASH_1TUPLE_SRC    EFX_RX_CLASS_HASH_SRC_ADDR
2744 #define EFX_RX_CLASS_HASH_1TUPLE_DST    EFX_RX_CLASS_HASH_DST_ADDR
2745
2746 #define EFX_RX_CLASS_HASH_2TUPLE                \
2747         (EFX_RX_CLASS_HASH_SRC_ADDR     |       \
2748         EFX_RX_CLASS_HASH_DST_ADDR)
2749
2750 #define EFX_RX_CLASS_HASH_2TUPLE_SRC            \
2751         (EFX_RX_CLASS_HASH_SRC_ADDR     |       \
2752         EFX_RX_CLASS_HASH_SRC_PORT)
2753
2754 #define EFX_RX_CLASS_HASH_2TUPLE_DST            \
2755         (EFX_RX_CLASS_HASH_DST_ADDR     |       \
2756         EFX_RX_CLASS_HASH_DST_PORT)
2757
2758 #define EFX_RX_CLASS_HASH_4TUPLE                \
2759         (EFX_RX_CLASS_HASH_SRC_ADDR     |       \
2760         EFX_RX_CLASS_HASH_DST_ADDR      |       \
2761         EFX_RX_CLASS_HASH_SRC_PORT      |       \
2762         EFX_RX_CLASS_HASH_DST_PORT)
2763
2764 #define EFX_RX_CLASS_HASH_NTUPLES       7
2765
2766 /*
2767  * Hash flag constructor.
2768  *
2769  * Resulting flags encode hash tuples for specific traffic classes.
2770  * The client drivers are encouraged to use these flags to form
2771  * a hash type value.
2772  */
2773 #define EFX_RX_HASH(_class, _tuple)                             \
2774         EFX_INSERT_FIELD_NATIVE32(0, 31,                        \
2775         EFX_RX_CLASS_##_class, EFX_RX_CLASS_HASH_##_tuple)
2776
2777 /*
2778  * The maximum number of EFX_RX_HASH() flags.
2779  */
2780 #define EFX_RX_HASH_NFLAGS      (EFX_RX_NCLASSES * EFX_RX_CLASS_HASH_NTUPLES)
2781
2782 LIBEFX_API
2783 extern  __checkReturn                           efx_rc_t
2784 efx_rx_scale_hash_flags_get(
2785         __in                                    efx_nic_t *enp,
2786         __in                                    efx_rx_hash_alg_t hash_alg,
2787         __out_ecount_part(max_nflags, *nflagsp) unsigned int *flagsp,
2788         __in                                    unsigned int max_nflags,
2789         __out                                   unsigned int *nflagsp);
2790
2791 LIBEFX_API
2792 extern  __checkReturn   efx_rc_t
2793 efx_rx_hash_default_support_get(
2794         __in            efx_nic_t *enp,
2795         __out           efx_rx_hash_support_t *supportp);
2796
2797
2798 LIBEFX_API
2799 extern  __checkReturn   efx_rc_t
2800 efx_rx_scale_default_support_get(
2801         __in            efx_nic_t *enp,
2802         __out           efx_rx_scale_context_type_t *typep);
2803
2804 LIBEFX_API
2805 extern  __checkReturn   efx_rc_t
2806 efx_rx_scale_context_alloc(
2807         __in            efx_nic_t *enp,
2808         __in            efx_rx_scale_context_type_t type,
2809         __in            uint32_t num_queues,
2810         __out           uint32_t *rss_contextp);
2811
2812 LIBEFX_API
2813 extern  __checkReturn   efx_rc_t
2814 efx_rx_scale_context_free(
2815         __in            efx_nic_t *enp,
2816         __in            uint32_t rss_context);
2817
2818 LIBEFX_API
2819 extern  __checkReturn   efx_rc_t
2820 efx_rx_scale_mode_set(
2821         __in    efx_nic_t *enp,
2822         __in    uint32_t rss_context,
2823         __in    efx_rx_hash_alg_t alg,
2824         __in    efx_rx_hash_type_t type,
2825         __in    boolean_t insert);
2826
2827 LIBEFX_API
2828 extern  __checkReturn   efx_rc_t
2829 efx_rx_scale_tbl_set(
2830         __in            efx_nic_t *enp,
2831         __in            uint32_t rss_context,
2832         __in_ecount(n)  unsigned int *table,
2833         __in            size_t n);
2834
2835 LIBEFX_API
2836 extern  __checkReturn   efx_rc_t
2837 efx_rx_scale_key_set(
2838         __in            efx_nic_t *enp,
2839         __in            uint32_t rss_context,
2840         __in_ecount(n)  uint8_t *key,
2841         __in            size_t n);
2842
2843 LIBEFX_API
2844 extern  __checkReturn   uint32_t
2845 efx_pseudo_hdr_hash_get(
2846         __in            efx_rxq_t *erp,
2847         __in            efx_rx_hash_alg_t func,
2848         __in            uint8_t *buffer);
2849
2850 #endif  /* EFSYS_OPT_RX_SCALE */
2851
2852 LIBEFX_API
2853 extern  __checkReturn   efx_rc_t
2854 efx_pseudo_hdr_pkt_length_get(
2855         __in            efx_rxq_t *erp,
2856         __in            uint8_t *buffer,
2857         __out           uint16_t *pkt_lengthp);
2858
2859 LIBEFX_API
2860 extern  __checkReturn   size_t
2861 efx_rxq_size(
2862         __in    const efx_nic_t *enp,
2863         __in    unsigned int ndescs);
2864
2865 LIBEFX_API
2866 extern  __checkReturn   unsigned int
2867 efx_rxq_nbufs(
2868         __in    const efx_nic_t *enp,
2869         __in    unsigned int ndescs);
2870
2871 #define EFX_RXQ_LIMIT(_ndescs)          ((_ndescs) - 16)
2872
2873 /*
2874  * libefx representation of the Rx prefix layout information.
2875  *
2876  * The information may be used inside libefx to implement Rx prefix fields
2877  * accessors and by drivers which process Rx prefix itself.
2878  */
2879
2880 /*
2881  * All known Rx prefix fields.
2882  *
2883  * An Rx prefix may have a subset of these fields.
2884  */
2885 typedef enum efx_rx_prefix_field_e {
2886         EFX_RX_PREFIX_FIELD_LENGTH = 0,
2887         EFX_RX_PREFIX_FIELD_ORIG_LENGTH,
2888         EFX_RX_PREFIX_FIELD_CLASS,
2889         EFX_RX_PREFIX_FIELD_RSS_HASH,
2890         EFX_RX_PREFIX_FIELD_RSS_HASH_VALID,
2891         EFX_RX_PREFIX_FIELD_PARTIAL_TSTAMP,
2892         EFX_RX_PREFIX_FIELD_VLAN_STRIP_TCI,
2893         EFX_RX_PREFIX_FIELD_INNER_VLAN_STRIP_TCI,
2894         EFX_RX_PREFIX_FIELD_USER_FLAG,
2895         EFX_RX_PREFIX_FIELD_USER_MARK,
2896         EFX_RX_PREFIX_FIELD_USER_MARK_VALID,
2897         EFX_RX_PREFIX_FIELD_CSUM_FRAME,
2898         EFX_RX_PREFIX_FIELD_INGRESS_VPORT,
2899         EFX_RX_PREFIX_NFIELDS
2900 } efx_rx_prefix_field_t;
2901
2902 /*
2903  * Location and endianness of a field in Rx prefix.
2904  *
2905  * If width is zero, the field is not present.
2906  */
2907 typedef struct efx_rx_prefix_field_info_s {
2908         uint16_t                        erpfi_offset_bits;
2909         uint8_t                         erpfi_width_bits;
2910         boolean_t                       erpfi_big_endian;
2911 } efx_rx_prefix_field_info_t;
2912
2913 /* Helper macro to define Rx prefix fields */
2914 #define EFX_RX_PREFIX_FIELD(_efx, _field, _big_endian)          \
2915         [EFX_RX_PREFIX_FIELD_ ## _efx] = {                      \
2916                 .erpfi_offset_bits      = EFX_LOW_BIT(_field),  \
2917                 .erpfi_width_bits       = EFX_WIDTH(_field),    \
2918                 .erpfi_big_endian       = (_big_endian),        \
2919         }
2920
2921 typedef struct efx_rx_prefix_layout_s {
2922         uint32_t                        erpl_id;
2923         uint8_t                         erpl_length;
2924         efx_rx_prefix_field_info_t      erpl_fields[EFX_RX_PREFIX_NFIELDS];
2925 } efx_rx_prefix_layout_t;
2926
2927 /*
2928  * Helper function to find out a bit mask of wanted but not available
2929  * Rx prefix fields.
2930  *
2931  * A field is considered as not available if any parameter mismatch.
2932  */
2933 LIBEFX_API
2934 extern  __checkReturn   uint32_t
2935 efx_rx_prefix_layout_check(
2936         __in            const efx_rx_prefix_layout_t *available,
2937         __in            const efx_rx_prefix_layout_t *wanted);
2938
2939 LIBEFX_API
2940 extern  __checkReturn   efx_rc_t
2941 efx_rx_prefix_get_layout(
2942         __in            const efx_rxq_t *erp,
2943         __out           efx_rx_prefix_layout_t *erplp);
2944
2945 typedef enum efx_rxq_type_e {
2946         EFX_RXQ_TYPE_DEFAULT,
2947         EFX_RXQ_TYPE_PACKED_STREAM,
2948         EFX_RXQ_TYPE_ES_SUPER_BUFFER,
2949         EFX_RXQ_NTYPES
2950 } efx_rxq_type_t;
2951
2952 /*
2953  * Dummy flag to be used instead of 0 to make it clear that the argument
2954  * is receive queue flags.
2955  */
2956 #define EFX_RXQ_FLAG_NONE               0x0
2957 #define EFX_RXQ_FLAG_SCATTER            0x1
2958 /*
2959  * If tunnels are supported and Rx event can provide information about
2960  * either outer or inner packet classes (e.g. SFN8xxx adapters with
2961  * full-feature firmware variant running), outer classes are requested by
2962  * default. However, if the driver supports tunnels, the flag allows to
2963  * request inner classes which are required to be able to interpret inner
2964  * Rx checksum offload results.
2965  */
2966 #define EFX_RXQ_FLAG_INNER_CLASSES      0x2
2967 /*
2968  * Request delivery of the RSS hash calculated by HW to be used by
2969  * the driver.
2970  */
2971 #define EFX_RXQ_FLAG_RSS_HASH           0x4
2972
2973 LIBEFX_API
2974 extern  __checkReturn   efx_rc_t
2975 efx_rx_qcreate(
2976         __in            efx_nic_t *enp,
2977         __in            unsigned int index,
2978         __in            unsigned int label,
2979         __in            efx_rxq_type_t type,
2980         __in            size_t buf_size,
2981         __in            efsys_mem_t *esmp,
2982         __in            size_t ndescs,
2983         __in            uint32_t id,
2984         __in            unsigned int flags,
2985         __in            efx_evq_t *eep,
2986         __deref_out     efx_rxq_t **erpp);
2987
2988 #if EFSYS_OPT_RX_PACKED_STREAM
2989
2990 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_1M       (1U * 1024 * 1024)
2991 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_512K     (512U * 1024)
2992 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_256K     (256U * 1024)
2993 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_128K     (128U * 1024)
2994 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_64K      (64U * 1024)
2995
2996 LIBEFX_API
2997 extern  __checkReturn   efx_rc_t
2998 efx_rx_qcreate_packed_stream(
2999         __in            efx_nic_t *enp,
3000         __in            unsigned int index,
3001         __in            unsigned int label,
3002         __in            uint32_t ps_buf_size,
3003         __in            efsys_mem_t *esmp,
3004         __in            size_t ndescs,
3005         __in            efx_evq_t *eep,
3006         __deref_out     efx_rxq_t **erpp);
3007
3008 #endif
3009
3010 #if EFSYS_OPT_RX_ES_SUPER_BUFFER
3011
3012 /* Maximum head-of-line block timeout in nanoseconds */
3013 #define EFX_RXQ_ES_SUPER_BUFFER_HOL_BLOCK_MAX   (400U * 1000 * 1000)
3014
3015 LIBEFX_API
3016 extern  __checkReturn   efx_rc_t
3017 efx_rx_qcreate_es_super_buffer(
3018         __in            efx_nic_t *enp,
3019         __in            unsigned int index,
3020         __in            unsigned int label,
3021         __in            uint32_t n_bufs_per_desc,
3022         __in            uint32_t max_dma_len,
3023         __in            uint32_t buf_stride,
3024         __in            uint32_t hol_block_timeout,
3025         __in            efsys_mem_t *esmp,
3026         __in            size_t ndescs,
3027         __in            unsigned int flags,
3028         __in            efx_evq_t *eep,
3029         __deref_out     efx_rxq_t **erpp);
3030
3031 #endif
3032
3033 typedef struct efx_buffer_s {
3034         efsys_dma_addr_t        eb_addr;
3035         size_t                  eb_size;
3036         boolean_t               eb_eop;
3037 } efx_buffer_t;
3038
3039 typedef struct efx_desc_s {
3040         efx_qword_t ed_eq;
3041 } efx_desc_t;
3042
3043 LIBEFX_API
3044 extern                          void
3045 efx_rx_qpost(
3046         __in                    efx_rxq_t *erp,
3047         __in_ecount(ndescs)     efsys_dma_addr_t *addrp,
3048         __in                    size_t size,
3049         __in                    unsigned int ndescs,
3050         __in                    unsigned int completed,
3051         __in                    unsigned int added);
3052
3053 LIBEFX_API
3054 extern          void
3055 efx_rx_qpush(
3056         __in    efx_rxq_t *erp,
3057         __in    unsigned int added,
3058         __inout unsigned int *pushedp);
3059
3060 #if EFSYS_OPT_RX_PACKED_STREAM
3061
3062 LIBEFX_API
3063 extern                  void
3064 efx_rx_qpush_ps_credits(
3065         __in            efx_rxq_t *erp);
3066
3067 LIBEFX_API
3068 extern  __checkReturn   uint8_t *
3069 efx_rx_qps_packet_info(
3070         __in            efx_rxq_t *erp,
3071         __in            uint8_t *buffer,
3072         __in            uint32_t buffer_length,
3073         __in            uint32_t current_offset,
3074         __out           uint16_t *lengthp,
3075         __out           uint32_t *next_offsetp,
3076         __out           uint32_t *timestamp);
3077 #endif
3078
3079 LIBEFX_API
3080 extern  __checkReturn   efx_rc_t
3081 efx_rx_qflush(
3082         __in    efx_rxq_t *erp);
3083
3084 LIBEFX_API
3085 extern          void
3086 efx_rx_qenable(
3087         __in    efx_rxq_t *erp);
3088
3089 LIBEFX_API
3090 extern          void
3091 efx_rx_qdestroy(
3092         __in    efx_rxq_t *erp);
3093
3094 /* TX */
3095
3096 typedef struct efx_txq_s        efx_txq_t;
3097
3098 #if EFSYS_OPT_QSTATS
3099
3100 /* START MKCONFIG GENERATED EfxHeaderTransmitQueueBlock 12dff8778598b2db */
3101 typedef enum efx_tx_qstat_e {
3102         TX_POST,
3103         TX_POST_PIO,
3104         TX_NQSTATS
3105 } efx_tx_qstat_t;
3106
3107 /* END MKCONFIG GENERATED EfxHeaderTransmitQueueBlock */
3108
3109 #endif  /* EFSYS_OPT_QSTATS */
3110
3111 LIBEFX_API
3112 extern  __checkReturn   efx_rc_t
3113 efx_tx_init(
3114         __in            efx_nic_t *enp);
3115
3116 LIBEFX_API
3117 extern          void
3118 efx_tx_fini(
3119         __in    efx_nic_t *enp);
3120
3121 LIBEFX_API
3122 extern  __checkReturn   size_t
3123 efx_txq_size(
3124         __in    const efx_nic_t *enp,
3125         __in    unsigned int ndescs);
3126
3127 LIBEFX_API
3128 extern  __checkReturn   unsigned int
3129 efx_txq_nbufs(
3130         __in    const efx_nic_t *enp,
3131         __in    unsigned int ndescs);
3132
3133 #define EFX_TXQ_LIMIT(_ndescs)          ((_ndescs) - 16)
3134
3135 #define EFX_TXQ_CKSUM_IPV4              0x0001
3136 #define EFX_TXQ_CKSUM_TCPUDP            0x0002
3137 #define EFX_TXQ_FATSOV2                 0x0004
3138 #define EFX_TXQ_CKSUM_INNER_IPV4        0x0008
3139 #define EFX_TXQ_CKSUM_INNER_TCPUDP      0x0010
3140
3141 LIBEFX_API
3142 extern  __checkReturn   efx_rc_t
3143 efx_tx_qcreate(
3144         __in            efx_nic_t *enp,
3145         __in            unsigned int index,
3146         __in            unsigned int label,
3147         __in            efsys_mem_t *esmp,
3148         __in            size_t n,
3149         __in            uint32_t id,
3150         __in            uint16_t flags,
3151         __in            efx_evq_t *eep,
3152         __deref_out     efx_txq_t **etpp,
3153         __out           unsigned int *addedp);
3154
3155 LIBEFX_API
3156 extern  __checkReturn           efx_rc_t
3157 efx_tx_qpost(
3158         __in                    efx_txq_t *etp,
3159         __in_ecount(ndescs)     efx_buffer_t *eb,
3160         __in                    unsigned int ndescs,
3161         __in                    unsigned int completed,
3162         __inout                 unsigned int *addedp);
3163
3164 LIBEFX_API
3165 extern  __checkReturn   efx_rc_t
3166 efx_tx_qpace(
3167         __in            efx_txq_t *etp,
3168         __in            unsigned int ns);
3169
3170 LIBEFX_API
3171 extern                  void
3172 efx_tx_qpush(
3173         __in            efx_txq_t *etp,
3174         __in            unsigned int added,
3175         __in            unsigned int pushed);
3176
3177 LIBEFX_API
3178 extern  __checkReturn   efx_rc_t
3179 efx_tx_qflush(
3180         __in            efx_txq_t *etp);
3181
3182 LIBEFX_API
3183 extern                  void
3184 efx_tx_qenable(
3185         __in            efx_txq_t *etp);
3186
3187 LIBEFX_API
3188 extern  __checkReturn   efx_rc_t
3189 efx_tx_qpio_enable(
3190         __in            efx_txq_t *etp);
3191
3192 LIBEFX_API
3193 extern                  void
3194 efx_tx_qpio_disable(
3195         __in            efx_txq_t *etp);
3196
3197 LIBEFX_API
3198 extern  __checkReturn   efx_rc_t
3199 efx_tx_qpio_write(
3200         __in                    efx_txq_t *etp,
3201         __in_ecount(buf_length) uint8_t *buffer,
3202         __in                    size_t buf_length,
3203         __in                    size_t pio_buf_offset);
3204
3205 LIBEFX_API
3206 extern  __checkReturn   efx_rc_t
3207 efx_tx_qpio_post(
3208         __in                    efx_txq_t *etp,
3209         __in                    size_t pkt_length,
3210         __in                    unsigned int completed,
3211         __inout                 unsigned int *addedp);
3212
3213 LIBEFX_API
3214 extern  __checkReturn   efx_rc_t
3215 efx_tx_qdesc_post(
3216         __in            efx_txq_t *etp,
3217         __in_ecount(n)  efx_desc_t *ed,
3218         __in            unsigned int n,
3219         __in            unsigned int completed,
3220         __inout         unsigned int *addedp);
3221
3222 LIBEFX_API
3223 extern  void
3224 efx_tx_qdesc_dma_create(
3225         __in    efx_txq_t *etp,
3226         __in    efsys_dma_addr_t addr,
3227         __in    size_t size,
3228         __in    boolean_t eop,
3229         __out   efx_desc_t *edp);
3230
3231 LIBEFX_API
3232 extern  void
3233 efx_tx_qdesc_tso_create(
3234         __in    efx_txq_t *etp,
3235         __in    uint16_t ipv4_id,
3236         __in    uint32_t tcp_seq,
3237         __in    uint8_t  tcp_flags,
3238         __out   efx_desc_t *edp);
3239
3240 /* Number of FATSOv2 option descriptors */
3241 #define EFX_TX_FATSOV2_OPT_NDESCS               2
3242
3243 /* Maximum number of DMA segments per TSO packet (not superframe) */
3244 #define EFX_TX_FATSOV2_DMA_SEGS_PER_PKT_MAX     24
3245
3246 LIBEFX_API
3247 extern  void
3248 efx_tx_qdesc_tso2_create(
3249         __in                    efx_txq_t *etp,
3250         __in                    uint16_t ipv4_id,
3251         __in                    uint16_t outer_ipv4_id,
3252         __in                    uint32_t tcp_seq,
3253         __in                    uint16_t tcp_mss,
3254         __out_ecount(count)     efx_desc_t *edp,
3255         __in                    int count);
3256
3257 LIBEFX_API
3258 extern  void
3259 efx_tx_qdesc_vlantci_create(
3260         __in    efx_txq_t *etp,
3261         __in    uint16_t tci,
3262         __out   efx_desc_t *edp);
3263
3264 LIBEFX_API
3265 extern  void
3266 efx_tx_qdesc_checksum_create(
3267         __in    efx_txq_t *etp,
3268         __in    uint16_t flags,
3269         __out   efx_desc_t *edp);
3270
3271 #if EFSYS_OPT_QSTATS
3272
3273 #if EFSYS_OPT_NAMES
3274
3275 LIBEFX_API
3276 extern          const char *
3277 efx_tx_qstat_name(
3278         __in    efx_nic_t *etp,
3279         __in    unsigned int id);
3280
3281 #endif  /* EFSYS_OPT_NAMES */
3282
3283 LIBEFX_API
3284 extern                                  void
3285 efx_tx_qstats_update(
3286         __in                            efx_txq_t *etp,
3287         __inout_ecount(TX_NQSTATS)      efsys_stat_t *stat);
3288
3289 #endif  /* EFSYS_OPT_QSTATS */
3290
3291 LIBEFX_API
3292 extern          void
3293 efx_tx_qdestroy(
3294         __in    efx_txq_t *etp);
3295
3296
3297 /* FILTER */
3298
3299 #if EFSYS_OPT_FILTER
3300
3301 #define EFX_ETHER_TYPE_IPV4 0x0800
3302 #define EFX_ETHER_TYPE_IPV6 0x86DD
3303
3304 #define EFX_IPPROTO_TCP 6
3305 #define EFX_IPPROTO_UDP 17
3306 #define EFX_IPPROTO_GRE 47
3307
3308 /* Use RSS to spread across multiple queues */
3309 #define EFX_FILTER_FLAG_RX_RSS          0x01
3310 /* Enable RX scatter */
3311 #define EFX_FILTER_FLAG_RX_SCATTER      0x02
3312 /*
3313  * Override an automatic filter (priority EFX_FILTER_PRI_AUTO).
3314  * May only be set by the filter implementation for each type.
3315  * A removal request will restore the automatic filter in its place.
3316  */
3317 #define EFX_FILTER_FLAG_RX_OVER_AUTO    0x04
3318 /* Filter is for RX */
3319 #define EFX_FILTER_FLAG_RX              0x08
3320 /* Filter is for TX */
3321 #define EFX_FILTER_FLAG_TX              0x10
3322 /* Set match flag on the received packet */
3323 #define EFX_FILTER_FLAG_ACTION_FLAG     0x20
3324 /* Set match mark on the received packet */
3325 #define EFX_FILTER_FLAG_ACTION_MARK     0x40
3326
3327 typedef uint8_t efx_filter_flags_t;
3328
3329 /*
3330  * Flags which specify the fields to match on. The values are the same as in the
3331  * MC_CMD_FILTER_OP/MC_CMD_FILTER_OP_EXT commands.
3332  */
3333
3334 /* Match by remote IP host address */
3335 #define EFX_FILTER_MATCH_REM_HOST               0x00000001
3336 /* Match by local IP host address */
3337 #define EFX_FILTER_MATCH_LOC_HOST               0x00000002
3338 /* Match by remote MAC address */
3339 #define EFX_FILTER_MATCH_REM_MAC                0x00000004
3340 /* Match by remote TCP/UDP port */
3341 #define EFX_FILTER_MATCH_REM_PORT               0x00000008
3342 /* Match by remote TCP/UDP port */
3343 #define EFX_FILTER_MATCH_LOC_MAC                0x00000010
3344 /* Match by local TCP/UDP port */
3345 #define EFX_FILTER_MATCH_LOC_PORT               0x00000020
3346 /* Match by Ether-type */
3347 #define EFX_FILTER_MATCH_ETHER_TYPE             0x00000040
3348 /* Match by inner VLAN ID */
3349 #define EFX_FILTER_MATCH_INNER_VID              0x00000080
3350 /* Match by outer VLAN ID */
3351 #define EFX_FILTER_MATCH_OUTER_VID              0x00000100
3352 /* Match by IP transport protocol */
3353 #define EFX_FILTER_MATCH_IP_PROTO               0x00000200
3354 /* Match by VNI or VSID */
3355 #define EFX_FILTER_MATCH_VNI_OR_VSID            0x00000800
3356 /* For encapsulated packets, match by inner frame local MAC address */
3357 #define EFX_FILTER_MATCH_IFRM_LOC_MAC           0x00010000
3358 /* For encapsulated packets, match all multicast inner frames */
3359 #define EFX_FILTER_MATCH_IFRM_UNKNOWN_MCAST_DST 0x01000000
3360 /* For encapsulated packets, match all unicast inner frames */
3361 #define EFX_FILTER_MATCH_IFRM_UNKNOWN_UCAST_DST 0x02000000
3362 /*
3363  * Match by encap type, this flag does not correspond to
3364  * the MCDI match flags and any unoccupied value may be used
3365  */
3366 #define EFX_FILTER_MATCH_ENCAP_TYPE             0x20000000
3367 /* Match otherwise-unmatched multicast and broadcast packets */
3368 #define EFX_FILTER_MATCH_UNKNOWN_MCAST_DST      0x40000000
3369 /* Match otherwise-unmatched unicast packets */
3370 #define EFX_FILTER_MATCH_UNKNOWN_UCAST_DST      0x80000000
3371
3372 typedef uint32_t efx_filter_match_flags_t;
3373
3374 /* Filter priority from lowest to highest */
3375 typedef enum efx_filter_priority_s {
3376         EFX_FILTER_PRI_AUTO = 0,        /* Automatic filter based on device
3377                                          * address list or hardware
3378                                          * requirements. This may only be used
3379                                          * by the filter implementation for
3380                                          * each NIC type. */
3381         EFX_FILTER_PRI_MANUAL,          /* Manually configured filter */
3382         EFX_FILTER_NPRI,
3383 } efx_filter_priority_t;
3384
3385 /*
3386  * FIXME: All these fields are assumed to be in little-endian byte order.
3387  * It may be better for some to be big-endian. See bug42804.
3388  */
3389
3390 typedef struct efx_filter_spec_s {
3391         efx_filter_match_flags_t        efs_match_flags;
3392         uint8_t                         efs_priority;
3393         efx_filter_flags_t              efs_flags;
3394         uint16_t                        efs_dmaq_id;
3395         uint32_t                        efs_rss_context;
3396         uint32_t                        efs_mark;
3397         /*
3398          * Saved lower-priority filter. If it is set, it is restored on
3399          * filter delete operation.
3400          */
3401         struct efx_filter_spec_s        *efs_overridden_spec;
3402         /* Fields below here are hashed for software filter lookup */
3403         uint16_t                        efs_outer_vid;
3404         uint16_t                        efs_inner_vid;
3405         uint8_t                         efs_loc_mac[EFX_MAC_ADDR_LEN];
3406         uint8_t                         efs_rem_mac[EFX_MAC_ADDR_LEN];
3407         uint16_t                        efs_ether_type;
3408         uint8_t                         efs_ip_proto;
3409         efx_tunnel_protocol_t           efs_encap_type;
3410         uint16_t                        efs_loc_port;
3411         uint16_t                        efs_rem_port;
3412         efx_oword_t                     efs_rem_host;
3413         efx_oword_t                     efs_loc_host;
3414         uint8_t                         efs_vni_or_vsid[EFX_VNI_OR_VSID_LEN];
3415         uint8_t                         efs_ifrm_loc_mac[EFX_MAC_ADDR_LEN];
3416 } efx_filter_spec_t;
3417
3418
3419 /* Default values for use in filter specifications */
3420 #define EFX_FILTER_SPEC_RX_DMAQ_ID_DROP         0xfff
3421 #define EFX_FILTER_SPEC_VID_UNSPEC              0xffff
3422
3423 LIBEFX_API
3424 extern  __checkReturn   efx_rc_t
3425 efx_filter_init(
3426         __in            efx_nic_t *enp);
3427
3428 LIBEFX_API
3429 extern                  void
3430 efx_filter_fini(
3431         __in            efx_nic_t *enp);
3432
3433 LIBEFX_API
3434 extern  __checkReturn   efx_rc_t
3435 efx_filter_insert(
3436         __in            efx_nic_t *enp,
3437         __inout         efx_filter_spec_t *spec);
3438
3439 LIBEFX_API
3440 extern  __checkReturn   efx_rc_t
3441 efx_filter_remove(
3442         __in            efx_nic_t *enp,
3443         __inout         efx_filter_spec_t *spec);
3444
3445 LIBEFX_API
3446 extern  __checkReturn   efx_rc_t
3447 efx_filter_restore(
3448         __in            efx_nic_t *enp);
3449
3450 LIBEFX_API
3451 extern  __checkReturn   efx_rc_t
3452 efx_filter_supported_filters(
3453         __in                            efx_nic_t *enp,
3454         __out_ecount(buffer_length)     uint32_t *buffer,
3455         __in                            size_t buffer_length,
3456         __out                           size_t *list_lengthp);
3457
3458 LIBEFX_API
3459 extern                  void
3460 efx_filter_spec_init_rx(
3461         __out           efx_filter_spec_t *spec,
3462         __in            efx_filter_priority_t priority,
3463         __in            efx_filter_flags_t flags,
3464         __in            efx_rxq_t *erp);
3465
3466 LIBEFX_API
3467 extern                  void
3468 efx_filter_spec_init_tx(
3469         __out           efx_filter_spec_t *spec,
3470         __in            efx_txq_t *etp);
3471
3472 LIBEFX_API
3473 extern  __checkReturn   efx_rc_t
3474 efx_filter_spec_set_ipv4_local(
3475         __inout         efx_filter_spec_t *spec,
3476         __in            uint8_t proto,
3477         __in            uint32_t host,
3478         __in            uint16_t port);
3479
3480 LIBEFX_API
3481 extern  __checkReturn   efx_rc_t
3482 efx_filter_spec_set_ipv4_full(
3483         __inout         efx_filter_spec_t *spec,
3484         __in            uint8_t proto,
3485         __in            uint32_t lhost,
3486         __in            uint16_t lport,
3487         __in            uint32_t rhost,
3488         __in            uint16_t rport);
3489
3490 LIBEFX_API
3491 extern  __checkReturn   efx_rc_t
3492 efx_filter_spec_set_eth_local(
3493         __inout         efx_filter_spec_t *spec,
3494         __in            uint16_t vid,
3495         __in            const uint8_t *addr);
3496
3497 LIBEFX_API
3498 extern                  void
3499 efx_filter_spec_set_ether_type(
3500         __inout         efx_filter_spec_t *spec,
3501         __in            uint16_t ether_type);
3502
3503 LIBEFX_API
3504 extern  __checkReturn   efx_rc_t
3505 efx_filter_spec_set_uc_def(
3506         __inout         efx_filter_spec_t *spec);
3507
3508 LIBEFX_API
3509 extern  __checkReturn   efx_rc_t
3510 efx_filter_spec_set_mc_def(
3511         __inout         efx_filter_spec_t *spec);
3512
3513 typedef enum efx_filter_inner_frame_match_e {
3514         EFX_FILTER_INNER_FRAME_MATCH_OTHER = 0,
3515         EFX_FILTER_INNER_FRAME_MATCH_UNKNOWN_MCAST_DST,
3516         EFX_FILTER_INNER_FRAME_MATCH_UNKNOWN_UCAST_DST
3517 } efx_filter_inner_frame_match_t;
3518
3519 LIBEFX_API
3520 extern  __checkReturn   efx_rc_t
3521 efx_filter_spec_set_encap_type(
3522         __inout         efx_filter_spec_t *spec,
3523         __in            efx_tunnel_protocol_t encap_type,
3524         __in            efx_filter_inner_frame_match_t inner_frame_match);
3525
3526 LIBEFX_API
3527 extern  __checkReturn   efx_rc_t
3528 efx_filter_spec_set_vxlan(
3529         __inout         efx_filter_spec_t *spec,
3530         __in            const uint8_t *vni,
3531         __in            const uint8_t *inner_addr,
3532         __in            const uint8_t *outer_addr);
3533
3534 LIBEFX_API
3535 extern  __checkReturn   efx_rc_t
3536 efx_filter_spec_set_geneve(
3537         __inout         efx_filter_spec_t *spec,
3538         __in            const uint8_t *vni,
3539         __in            const uint8_t *inner_addr,
3540         __in            const uint8_t *outer_addr);
3541
3542 LIBEFX_API
3543 extern  __checkReturn   efx_rc_t
3544 efx_filter_spec_set_nvgre(
3545         __inout         efx_filter_spec_t *spec,
3546         __in            const uint8_t *vsid,
3547         __in            const uint8_t *inner_addr,
3548         __in            const uint8_t *outer_addr);
3549
3550 #if EFSYS_OPT_RX_SCALE
3551 LIBEFX_API
3552 extern  __checkReturn   efx_rc_t
3553 efx_filter_spec_set_rss_context(
3554         __inout         efx_filter_spec_t *spec,
3555         __in            uint32_t rss_context);
3556 #endif
3557 #endif  /* EFSYS_OPT_FILTER */
3558
3559 /* HASH */
3560
3561 LIBEFX_API
3562 extern  __checkReturn           uint32_t
3563 efx_hash_dwords(
3564         __in_ecount(count)      uint32_t const *input,
3565         __in                    size_t count,
3566         __in                    uint32_t init);
3567
3568 LIBEFX_API
3569 extern  __checkReturn           uint32_t
3570 efx_hash_bytes(
3571         __in_ecount(length)     uint8_t const *input,
3572         __in                    size_t length,
3573         __in                    uint32_t init);
3574
3575 #if EFSYS_OPT_LICENSING
3576
3577 /* LICENSING */
3578
3579 typedef struct efx_key_stats_s {
3580         uint32_t        eks_valid;
3581         uint32_t        eks_invalid;
3582         uint32_t        eks_blacklisted;
3583         uint32_t        eks_unverifiable;
3584         uint32_t        eks_wrong_node;
3585         uint32_t        eks_licensed_apps_lo;
3586         uint32_t        eks_licensed_apps_hi;
3587         uint32_t        eks_licensed_features_lo;
3588         uint32_t        eks_licensed_features_hi;
3589 } efx_key_stats_t;
3590
3591 LIBEFX_API
3592 extern  __checkReturn           efx_rc_t
3593 efx_lic_init(
3594         __in                    efx_nic_t *enp);
3595
3596 LIBEFX_API
3597 extern                          void
3598 efx_lic_fini(
3599         __in                    efx_nic_t *enp);
3600
3601 LIBEFX_API
3602 extern  __checkReturn   boolean_t
3603 efx_lic_check_support(
3604         __in                    efx_nic_t *enp);
3605
3606 LIBEFX_API
3607 extern  __checkReturn   efx_rc_t
3608 efx_lic_update_licenses(
3609         __in            efx_nic_t *enp);
3610
3611 LIBEFX_API
3612 extern  __checkReturn   efx_rc_t
3613 efx_lic_get_key_stats(
3614         __in            efx_nic_t *enp,
3615         __out           efx_key_stats_t *ksp);
3616
3617 LIBEFX_API
3618 extern  __checkReturn   efx_rc_t
3619 efx_lic_app_state(
3620         __in            efx_nic_t *enp,
3621         __in            uint64_t app_id,
3622         __out           boolean_t *licensedp);
3623
3624 LIBEFX_API
3625 extern  __checkReturn   efx_rc_t
3626 efx_lic_get_id(
3627         __in            efx_nic_t *enp,
3628         __in            size_t buffer_size,
3629         __out           uint32_t *typep,
3630         __out           size_t *lengthp,
3631         __out_opt       uint8_t *bufferp);
3632
3633
3634 LIBEFX_API
3635 extern  __checkReturn           efx_rc_t
3636 efx_lic_find_start(
3637         __in                    efx_nic_t *enp,
3638         __in_bcount(buffer_size)
3639                                 caddr_t bufferp,
3640         __in                    size_t buffer_size,
3641         __out                   uint32_t *startp);
3642
3643 LIBEFX_API
3644 extern  __checkReturn           efx_rc_t
3645 efx_lic_find_end(
3646         __in                    efx_nic_t *enp,
3647         __in_bcount(buffer_size)
3648                                 caddr_t bufferp,
3649         __in                    size_t buffer_size,
3650         __in                    uint32_t offset,
3651         __out                   uint32_t *endp);
3652
3653 LIBEFX_API
3654 extern  __checkReturn   __success(return != B_FALSE)    boolean_t
3655 efx_lic_find_key(
3656         __in                    efx_nic_t *enp,
3657         __in_bcount(buffer_size)
3658                                 caddr_t bufferp,
3659         __in                    size_t buffer_size,
3660         __in                    uint32_t offset,
3661         __out                   uint32_t *startp,
3662         __out                   uint32_t *lengthp);
3663
3664 LIBEFX_API
3665 extern  __checkReturn   __success(return != B_FALSE)    boolean_t
3666 efx_lic_validate_key(
3667         __in                    efx_nic_t *enp,
3668         __in_bcount(length)     caddr_t keyp,
3669         __in                    uint32_t length);
3670
3671 LIBEFX_API
3672 extern  __checkReturn           efx_rc_t
3673 efx_lic_read_key(
3674         __in                    efx_nic_t *enp,
3675         __in_bcount(buffer_size)
3676                                 caddr_t bufferp,
3677         __in                    size_t buffer_size,
3678         __in                    uint32_t offset,
3679         __in                    uint32_t length,
3680         __out_bcount_part(key_max_size, *lengthp)
3681                                 caddr_t keyp,
3682         __in                    size_t key_max_size,
3683         __out                   uint32_t *lengthp);
3684
3685 LIBEFX_API
3686 extern  __checkReturn           efx_rc_t
3687 efx_lic_write_key(
3688         __in                    efx_nic_t *enp,
3689         __in_bcount(buffer_size)
3690                                 caddr_t bufferp,
3691         __in                    size_t buffer_size,
3692         __in                    uint32_t offset,
3693         __in_bcount(length)     caddr_t keyp,
3694         __in                    uint32_t length,
3695         __out                   uint32_t *lengthp);
3696
3697 LIBEFX_API
3698 extern  __checkReturn           efx_rc_t
3699 efx_lic_delete_key(
3700         __in                    efx_nic_t *enp,
3701         __in_bcount(buffer_size)
3702                                 caddr_t bufferp,
3703         __in                    size_t buffer_size,
3704         __in                    uint32_t offset,
3705         __in                    uint32_t length,
3706         __in                    uint32_t end,
3707         __out                   uint32_t *deltap);
3708
3709 LIBEFX_API
3710 extern  __checkReturn           efx_rc_t
3711 efx_lic_create_partition(
3712         __in                    efx_nic_t *enp,
3713         __in_bcount(buffer_size)
3714                                 caddr_t bufferp,
3715         __in                    size_t buffer_size);
3716
3717 extern  __checkReturn           efx_rc_t
3718 efx_lic_finish_partition(
3719         __in                    efx_nic_t *enp,
3720         __in_bcount(buffer_size)
3721                                 caddr_t bufferp,
3722         __in                    size_t buffer_size);
3723
3724 #endif  /* EFSYS_OPT_LICENSING */
3725
3726 /* TUNNEL */
3727
3728 #if EFSYS_OPT_TUNNEL
3729
3730 LIBEFX_API
3731 extern  __checkReturn   efx_rc_t
3732 efx_tunnel_init(
3733         __in            efx_nic_t *enp);
3734
3735 LIBEFX_API
3736 extern                  void
3737 efx_tunnel_fini(
3738         __in            efx_nic_t *enp);
3739
3740 /*
3741  * For overlay network encapsulation using UDP, the firmware needs to know
3742  * the configured UDP port for the overlay so it can decode encapsulated
3743  * frames correctly.
3744  * The UDP port/protocol list is global.
3745  */
3746
3747 LIBEFX_API
3748 extern  __checkReturn   efx_rc_t
3749 efx_tunnel_config_udp_add(
3750         __in            efx_nic_t *enp,
3751         __in            uint16_t port /* host/cpu-endian */,
3752         __in            efx_tunnel_protocol_t protocol);
3753
3754 /*
3755  * Returns EBUSY if reconfiguration of the port is in progress in other thread.
3756  */
3757 LIBEFX_API
3758 extern  __checkReturn   efx_rc_t
3759 efx_tunnel_config_udp_remove(
3760         __in            efx_nic_t *enp,
3761         __in            uint16_t port /* host/cpu-endian */,
3762         __in            efx_tunnel_protocol_t protocol);
3763
3764 /*
3765  * Returns EBUSY if reconfiguration of any of the tunnel entries
3766  * is in progress in other thread.
3767  */
3768 LIBEFX_API
3769 extern  __checkReturn   efx_rc_t
3770 efx_tunnel_config_clear(
3771         __in            efx_nic_t *enp);
3772
3773 /**
3774  * Apply tunnel UDP ports configuration to hardware.
3775  *
3776  * EAGAIN is returned if hardware will be reset (datapath and managment CPU
3777  * reboot).
3778  */
3779 LIBEFX_API
3780 extern  __checkReturn   efx_rc_t
3781 efx_tunnel_reconfigure(
3782         __in            efx_nic_t *enp);
3783
3784 #endif /* EFSYS_OPT_TUNNEL */
3785
3786 #if EFSYS_OPT_FW_SUBVARIANT_AWARE
3787
3788 /**
3789  * Firmware subvariant choice options.
3790  *
3791  * It may be switched to no Tx checksum if attached drivers are either
3792  * preboot or firmware subvariant aware and no VIS are allocated.
3793  * If may be always switched to default explicitly using set request or
3794  * implicitly if unaware driver is attaching. If switching is done when
3795  * a driver is attached, it gets MC_REBOOT event and should recreate its
3796  * datapath.
3797  *
3798  * See SF-119419-TC DPDK Firmware Driver Interface and
3799  * SF-109306-TC EF10 for Driver Writers for details.
3800  */
3801 typedef enum efx_nic_fw_subvariant_e {
3802         EFX_NIC_FW_SUBVARIANT_DEFAULT = 0,
3803         EFX_NIC_FW_SUBVARIANT_NO_TX_CSUM = 1,
3804         EFX_NIC_FW_SUBVARIANT_NTYPES
3805 } efx_nic_fw_subvariant_t;
3806
3807 LIBEFX_API
3808 extern  __checkReturn   efx_rc_t
3809 efx_nic_get_fw_subvariant(
3810         __in            efx_nic_t *enp,
3811         __out           efx_nic_fw_subvariant_t *subvariantp);
3812
3813 LIBEFX_API
3814 extern  __checkReturn   efx_rc_t
3815 efx_nic_set_fw_subvariant(
3816         __in            efx_nic_t *enp,
3817         __in            efx_nic_fw_subvariant_t subvariant);
3818
3819 #endif  /* EFSYS_OPT_FW_SUBVARIANT_AWARE */
3820
3821 typedef enum efx_phy_fec_type_e {
3822         EFX_PHY_FEC_NONE = 0,
3823         EFX_PHY_FEC_BASER,
3824         EFX_PHY_FEC_RS
3825 } efx_phy_fec_type_t;
3826
3827 LIBEFX_API
3828 extern  __checkReturn   efx_rc_t
3829 efx_phy_fec_type_get(
3830         __in            efx_nic_t *enp,
3831         __out           efx_phy_fec_type_t *typep);
3832
3833 typedef struct efx_phy_link_state_s {
3834         uint32_t                epls_adv_cap_mask;
3835         uint32_t                epls_lp_cap_mask;
3836         uint32_t                epls_ld_cap_mask;
3837         unsigned int            epls_fcntl;
3838         efx_phy_fec_type_t      epls_fec;
3839         efx_link_mode_t         epls_link_mode;
3840 } efx_phy_link_state_t;
3841
3842 LIBEFX_API
3843 extern  __checkReturn   efx_rc_t
3844 efx_phy_link_state_get(
3845         __in            efx_nic_t *enp,
3846         __out           efx_phy_link_state_t  *eplsp);
3847
3848
3849 #if EFSYS_OPT_EVB
3850
3851 typedef uint32_t efx_vswitch_id_t;
3852 typedef uint32_t efx_vport_id_t;
3853
3854 typedef enum efx_vswitch_type_e {
3855         EFX_VSWITCH_TYPE_VLAN = 1,
3856         EFX_VSWITCH_TYPE_VEB,
3857         /* VSWITCH_TYPE_VEPA: obsolete */
3858         EFX_VSWITCH_TYPE_MUX = 4,
3859 } efx_vswitch_type_t;
3860
3861 typedef enum efx_vport_type_e {
3862         EFX_VPORT_TYPE_NORMAL = 4,
3863         EFX_VPORT_TYPE_EXPANSION,
3864         EFX_VPORT_TYPE_TEST,
3865 } efx_vport_type_t;
3866
3867 /* Unspecified VLAN ID to support disabling of VLAN filtering */
3868 #define EFX_FILTER_VID_UNSPEC   0xffff
3869 #define EFX_DEFAULT_VSWITCH_ID  1
3870
3871 /* Default VF VLAN ID on creation */
3872 #define         EFX_VF_VID_DEFAULT      EFX_FILTER_VID_UNSPEC
3873 #define         EFX_VPORT_ID_INVALID    0
3874
3875 typedef struct efx_vport_config_s {
3876         /* Either VF index or EFX_PCI_VF_INVALID for PF */
3877         uint16_t        evc_function;
3878         /* VLAN ID of the associated function */
3879         uint16_t        evc_vid;
3880         /* vport id shared with client driver */
3881         efx_vport_id_t  evc_vport_id;
3882         /* MAC address of the associated function */
3883         uint8_t         evc_mac_addr[EFX_MAC_ADDR_LEN];
3884         /*
3885          * vports created with this flag set may only transfer traffic on the
3886          * VLANs permitted by the vport. Also, an attempt to install filter with
3887          * VLAN will be refused unless requesting function has VLAN privilege.
3888          */
3889         boolean_t       evc_vlan_restrict;
3890         /* Whether this function is assigned or not */
3891         boolean_t       evc_vport_assigned;
3892 } efx_vport_config_t;
3893
3894 typedef struct  efx_vswitch_s   efx_vswitch_t;
3895
3896 LIBEFX_API
3897 extern  __checkReturn   efx_rc_t
3898 efx_evb_init(
3899         __in            efx_nic_t *enp);
3900
3901 LIBEFX_API
3902 extern                  void
3903 efx_evb_fini(
3904         __in            efx_nic_t *enp);
3905
3906 LIBEFX_API
3907 extern  __checkReturn   efx_rc_t
3908 efx_evb_vswitch_create(
3909         __in                            efx_nic_t *enp,
3910         __in                            uint32_t num_vports,
3911         __inout_ecount(num_vports)      efx_vport_config_t *vport_configp,
3912         __deref_out                     efx_vswitch_t **evpp);
3913
3914 LIBEFX_API
3915 extern  __checkReturn   efx_rc_t
3916 efx_evb_vswitch_destroy(
3917         __in                            efx_nic_t *enp,
3918         __in                            efx_vswitch_t *evp);
3919
3920 LIBEFX_API
3921 extern  __checkReturn                   efx_rc_t
3922 efx_evb_vport_mac_set(
3923         __in                            efx_nic_t *enp,
3924         __in                            efx_vswitch_t *evp,
3925         __in                            efx_vport_id_t vport_id,
3926         __in_bcount(EFX_MAC_ADDR_LEN)   uint8_t *addrp);
3927
3928 LIBEFX_API
3929 extern  __checkReturn   efx_rc_t
3930 efx_evb_vport_vlan_set(
3931         __in            efx_nic_t *enp,
3932         __in            efx_vswitch_t *evp,
3933         __in            efx_vport_id_t vport_id,
3934         __in            uint16_t vid);
3935
3936 LIBEFX_API
3937 extern  __checkReturn                   efx_rc_t
3938 efx_evb_vport_reset(
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         __in                            uint16_t vid,
3944         __out                           boolean_t *is_fn_resetp);
3945
3946 LIBEFX_API
3947 extern  __checkReturn   efx_rc_t
3948 efx_evb_vport_stats(
3949         __in            efx_nic_t *enp,
3950         __in            efx_vswitch_t *evp,
3951         __in            efx_vport_id_t vport_id,
3952         __out           efsys_mem_t *stats_bufferp);
3953
3954 #endif /* EFSYS_OPT_EVB */
3955
3956 #if EFSYS_OPT_MCDI_PROXY_AUTH_SERVER
3957
3958 typedef struct efx_proxy_auth_config_s {
3959         efsys_mem_t     *request_bufferp;
3960         efsys_mem_t     *response_bufferp;
3961         efsys_mem_t     *status_bufferp;
3962         uint32_t        block_cnt;
3963         uint32_t        *op_listp;
3964         size_t          op_count;
3965         uint32_t        handled_privileges;
3966 } efx_proxy_auth_config_t;
3967
3968 typedef struct efx_proxy_cmd_params_s {
3969         uint32_t        pf_index;
3970         uint32_t        vf_index;
3971         uint8_t         *request_bufferp;
3972         size_t          request_size;
3973         uint8_t         *response_bufferp;
3974         size_t          response_size;
3975         size_t          *response_size_actualp;
3976 } efx_proxy_cmd_params_t;
3977
3978 LIBEFX_API
3979 extern  __checkReturn   efx_rc_t
3980 efx_proxy_auth_init(
3981         __in            efx_nic_t *enp);
3982
3983 LIBEFX_API
3984 extern                  void
3985 efx_proxy_auth_fini(
3986         __in            efx_nic_t *enp);
3987
3988 LIBEFX_API
3989 extern  __checkReturn   efx_rc_t
3990 efx_proxy_auth_configure(
3991         __in            efx_nic_t *enp,
3992         __in            efx_proxy_auth_config_t *configp);
3993
3994 LIBEFX_API
3995 extern  __checkReturn   efx_rc_t
3996 efx_proxy_auth_destroy(
3997         __in            efx_nic_t *enp,
3998         __in            uint32_t handled_privileges);
3999
4000 LIBEFX_API
4001 extern  __checkReturn   efx_rc_t
4002 efx_proxy_auth_complete_request(
4003         __in            efx_nic_t *enp,
4004         __in            uint32_t fn_index,
4005         __in            uint32_t proxy_result,
4006         __in            uint32_t handle);
4007
4008 LIBEFX_API
4009 extern  __checkReturn   efx_rc_t
4010 efx_proxy_auth_exec_cmd(
4011         __in            efx_nic_t *enp,
4012         __inout         efx_proxy_cmd_params_t *paramsp);
4013
4014 LIBEFX_API
4015 extern  __checkReturn   efx_rc_t
4016 efx_proxy_auth_set_privilege_mask(
4017         __in            efx_nic_t *enp,
4018         __in            uint32_t vf_index,
4019         __in            uint32_t mask,
4020         __in            uint32_t value);
4021
4022 LIBEFX_API
4023 extern  __checkReturn   efx_rc_t
4024 efx_proxy_auth_privilege_mask_get(
4025         __in            efx_nic_t *enp,
4026         __in            uint32_t pf_index,
4027         __in            uint32_t vf_index,
4028         __out           uint32_t *maskp);
4029
4030 LIBEFX_API
4031 extern  __checkReturn   efx_rc_t
4032 efx_proxy_auth_privilege_modify(
4033         __in            efx_nic_t *enp,
4034         __in            uint32_t pf_index,
4035         __in            uint32_t vf_index,
4036         __in            uint32_t add_privileges_mask,
4037         __in            uint32_t remove_privileges_mask);
4038
4039 #endif /* EFSYS_OPT_MCDI_PROXY_AUTH_SERVER */
4040
4041 #if EFSYS_OPT_MAE
4042
4043 LIBEFX_API
4044 extern  __checkReturn                   efx_rc_t
4045 efx_mae_init(
4046         __in                            efx_nic_t *enp);
4047
4048 LIBEFX_API
4049 extern                                  void
4050 efx_mae_fini(
4051         __in                            efx_nic_t *enp);
4052
4053 typedef struct efx_mae_limits_s {
4054         uint32_t                        eml_max_n_action_prios;
4055 } efx_mae_limits_t;
4056
4057 LIBEFX_API
4058 extern  __checkReturn                   efx_rc_t
4059 efx_mae_get_limits(
4060         __in                            efx_nic_t *enp,
4061         __out                           efx_mae_limits_t *emlp);
4062
4063 typedef enum efx_mae_rule_type_e {
4064         EFX_MAE_RULE_ACTION = 0,
4065
4066         EFX_MAE_RULE_NTYPES
4067 } efx_mae_rule_type_t;
4068
4069 typedef struct efx_mae_match_spec_s     efx_mae_match_spec_t;
4070
4071 LIBEFX_API
4072 extern  __checkReturn                   efx_rc_t
4073 efx_mae_match_spec_init(
4074         __in                            efx_nic_t *enp,
4075         __in                            efx_mae_rule_type_t type,
4076         __in                            uint32_t prio,
4077         __out                           efx_mae_match_spec_t **specp);
4078
4079 LIBEFX_API
4080 extern                                  void
4081 efx_mae_match_spec_fini(
4082         __in                            efx_nic_t *enp,
4083         __in                            efx_mae_match_spec_t *spec);
4084
4085 typedef enum efx_mae_field_id_e {
4086         EFX_MAE_FIELD_INGRESS_MPORT_SELECTOR = 0,
4087         EFX_MAE_FIELD_ETHER_TYPE_BE,
4088         EFX_MAE_FIELD_ETH_SADDR_BE,
4089         EFX_MAE_FIELD_ETH_DADDR_BE,
4090
4091         EFX_MAE_FIELD_NIDS
4092 } efx_mae_field_id_t;
4093
4094 /* MPORT selector. Used to refer to MPORTs in match/action rules. */
4095 typedef struct efx_mport_sel_s {
4096         uint32_t sel;
4097 } efx_mport_sel_t;
4098
4099 #define EFX_MPORT_NULL                  (0U)
4100
4101 /*
4102  * Get MPORT selector of a physical port.
4103  *
4104  * The resulting MPORT selector is opaque to the caller and can be
4105  * passed as an argument to efx_mae_match_spec_mport_set()
4106  * and efx_mae_action_set_populate_deliver().
4107  */
4108 LIBEFX_API
4109 extern  __checkReturn                   efx_rc_t
4110 efx_mae_mport_by_phy_port(
4111         __in                            uint32_t phy_port,
4112         __out                           efx_mport_sel_t *mportp);
4113
4114 /*
4115  * Get MPORT selector of a PCIe function.
4116  *
4117  * The resulting MPORT selector is opaque to the caller and can be
4118  * passed as an argument to efx_mae_match_spec_mport_set()
4119  * and efx_mae_action_set_populate_deliver().
4120  */
4121 LIBEFX_API
4122 extern  __checkReturn                   efx_rc_t
4123 efx_mae_mport_by_pcie_function(
4124         __in                            uint32_t pf,
4125         __in                            uint32_t vf,
4126         __out                           efx_mport_sel_t *mportp);
4127
4128 /*
4129  * Fields which have BE postfix in their named constants are expected
4130  * to be passed by callers in big-endian byte order. They will appear
4131  * in the MCDI buffer, which is a part of the match specification, in
4132  * the very same byte order, that is, no conversion will be performed.
4133  *
4134  * Fields which don't have BE postfix in their named constants are in
4135  * host byte order. MCDI expects them to be little-endian, so the API
4136  * will take care to carry out conversion to little-endian byte order.
4137  * At the moment, the only field in host byte order is MPORT selector.
4138  */
4139 LIBEFX_API
4140 extern  __checkReturn                   efx_rc_t
4141 efx_mae_match_spec_field_set(
4142         __in                            efx_mae_match_spec_t *spec,
4143         __in                            efx_mae_field_id_t field_id,
4144         __in                            size_t value_size,
4145         __in_bcount(value_size)         const uint8_t *value,
4146         __in                            size_t mask_size,
4147         __in_bcount(mask_size)          const uint8_t *mask);
4148
4149 /* If the mask argument is NULL, the API will use full mask by default. */
4150 LIBEFX_API
4151 extern  __checkReturn                   efx_rc_t
4152 efx_mae_match_spec_mport_set(
4153         __in                            efx_mae_match_spec_t *spec,
4154         __in                            const efx_mport_sel_t *valuep,
4155         __in_opt                        const efx_mport_sel_t *maskp);
4156
4157 /*
4158  * Make sure that match fields known by EFX have proper masks set
4159  * in the match specification as per requirements of SF-122526-TC.
4160  *
4161  * In the case efx_mae_field_id_t lacks named identifiers for any
4162  * fields which the FW maintains with support status MATCH_ALWAYS,
4163  * the validation result may not be accurate.
4164  */
4165 LIBEFX_API
4166 extern  __checkReturn                   boolean_t
4167 efx_mae_match_spec_is_valid(
4168         __in                            efx_nic_t *enp,
4169         __in                            const efx_mae_match_spec_t *spec);
4170
4171 typedef struct efx_mae_actions_s efx_mae_actions_t;
4172
4173 LIBEFX_API
4174 extern  __checkReturn                   efx_rc_t
4175 efx_mae_action_set_spec_init(
4176         __in                            efx_nic_t *enp,
4177         __out                           efx_mae_actions_t **specp);
4178
4179 LIBEFX_API
4180 extern                                  void
4181 efx_mae_action_set_spec_fini(
4182         __in                            efx_nic_t *enp,
4183         __in                            efx_mae_actions_t *spec);
4184
4185 LIBEFX_API
4186 extern  __checkReturn                   efx_rc_t
4187 efx_mae_action_set_populate_vlan_pop(
4188         __in                            efx_mae_actions_t *spec);
4189
4190 LIBEFX_API
4191 extern  __checkReturn                   efx_rc_t
4192 efx_mae_action_set_populate_vlan_push(
4193         __in                            efx_mae_actions_t *spec,
4194         __in                            uint16_t tpid_be,
4195         __in                            uint16_t tci_be);
4196
4197 LIBEFX_API
4198 extern  __checkReturn                   efx_rc_t
4199 efx_mae_action_set_populate_flag(
4200         __in                            efx_mae_actions_t *spec);
4201
4202 LIBEFX_API
4203 extern  __checkReturn                   efx_rc_t
4204 efx_mae_action_set_populate_mark(
4205         __in                            efx_mae_actions_t *spec,
4206         __in                            uint32_t mark_value);
4207
4208 LIBEFX_API
4209 extern  __checkReturn                   efx_rc_t
4210 efx_mae_action_set_populate_deliver(
4211         __in                            efx_mae_actions_t *spec,
4212         __in                            const efx_mport_sel_t *mportp);
4213
4214 LIBEFX_API
4215 extern  __checkReturn                   efx_rc_t
4216 efx_mae_action_set_populate_drop(
4217         __in                            efx_mae_actions_t *spec);
4218
4219 LIBEFX_API
4220 extern  __checkReturn                   boolean_t
4221 efx_mae_action_set_specs_equal(
4222         __in                            const efx_mae_actions_t *left,
4223         __in                            const efx_mae_actions_t *right);
4224
4225 /*
4226  * Conduct a comparison to check whether two match specifications
4227  * of equal rule type (action / outer) and priority would map to
4228  * the very same rule class from the firmware's standpoint.
4229  */
4230 LIBEFX_API
4231 extern  __checkReturn                   efx_rc_t
4232 efx_mae_match_specs_class_cmp(
4233         __in                            efx_nic_t *enp,
4234         __in                            const efx_mae_match_spec_t *left,
4235         __in                            const efx_mae_match_spec_t *right,
4236         __out                           boolean_t *have_same_classp);
4237
4238 #define EFX_MAE_RSRC_ID_INVALID UINT32_MAX
4239
4240 /* Rule ID */
4241 typedef struct efx_mae_rule_id_s {
4242         uint32_t id;
4243 } efx_mae_rule_id_t;
4244
4245 /* Action set ID */
4246 typedef struct efx_mae_aset_id_s {
4247         uint32_t id;
4248 } efx_mae_aset_id_t;
4249
4250 LIBEFX_API
4251 extern  __checkReturn                   efx_rc_t
4252 efx_mae_action_set_alloc(
4253         __in                            efx_nic_t *enp,
4254         __in                            const efx_mae_actions_t *spec,
4255         __out                           efx_mae_aset_id_t *aset_idp);
4256
4257 LIBEFX_API
4258 extern  __checkReturn                   efx_rc_t
4259 efx_mae_action_set_free(
4260         __in                            efx_nic_t *enp,
4261         __in                            const efx_mae_aset_id_t *aset_idp);
4262
4263 /* Action set list ID */
4264 typedef struct efx_mae_aset_list_id_s {
4265         uint32_t id;
4266 } efx_mae_aset_list_id_t;
4267
4268 /*
4269  * Either action set list ID or action set ID must be passed to this API,
4270  * but not both.
4271  */
4272 LIBEFX_API
4273 extern  __checkReturn                   efx_rc_t
4274 efx_mae_action_rule_insert(
4275         __in                            efx_nic_t *enp,
4276         __in                            const efx_mae_match_spec_t *spec,
4277         __in                            const efx_mae_aset_list_id_t *asl_idp,
4278         __in                            const efx_mae_aset_id_t *as_idp,
4279         __out                           efx_mae_rule_id_t *ar_idp);
4280
4281 LIBEFX_API
4282 extern  __checkReturn                   efx_rc_t
4283 efx_mae_action_rule_remove(
4284         __in                            efx_nic_t *enp,
4285         __in                            const efx_mae_rule_id_t *ar_idp);
4286
4287 #endif /* EFSYS_OPT_MAE */
4288
4289 #ifdef  __cplusplus
4290 }
4291 #endif
4292
4293 #endif  /* _SYS_EFX_H */