drivers/net/sfc/base/efx.h

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