drivers/net/sfc/base/efx.h

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