sys/dev/sfxge/common/efx.h

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