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