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