drivers/net/sfc/base/efx.h

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