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