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