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