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