drivers/net/sfc/base/efx.h

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