sys/dev/sfxge/common/efx.h

   1 /*-
   2  * Copyright (c) 2006-2016 Solarflare Communications Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are met:
   7  *
   8  * 1. Redistributions of source code must retain the above copyright notice,
   9  *    this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright notice,
  11  *    this list of conditions and the following disclaimer in the documentation
  12  *    and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  16  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  21  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  22  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  23  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  24  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  * The views and conclusions contained in the software and documentation are
  27  * those of the authors and should not be interpreted as representing official
  28  * policies, either expressed or implied, of the FreeBSD Project.
  29  *
  30  * $FreeBSD$
  31  */
  32
  33 #ifndef _SYS_EFX_H
  34 #define _SYS_EFX_H
  35
  36 #include "efsys.h"
  37 #include "efx_check.h"
  38 #include "efx_phy_ids.h"
  39
  40 #ifdef  __cplusplus
  41 extern "C" {
  42 #endif
  43
  44 #define EFX_STATIC_ASSERT(_cond)                \
  45         ((void)sizeof(char[(_cond) ? 1 : -1]))
  46
  47 #define EFX_ARRAY_SIZE(_array)                  \
  48         (sizeof(_array) / sizeof((_array)[0]))
  49
  50 #define EFX_FIELD_OFFSET(_type, _field)         \
  51         ((size_t) &(((_type *)0)->_field))
  52
  53 /* Return codes */
  54
  55 typedef __success(return == 0) int efx_rc_t;
  56
  57
  58 /* Chip families */
  59
  60 typedef enum efx_family_e {
  61         EFX_FAMILY_INVALID,
  62         EFX_FAMILY_FALCON,      /* Obsolete and not supported */
  63         EFX_FAMILY_SIENA,
  64         EFX_FAMILY_HUNTINGTON,
  65         EFX_FAMILY_MEDFORD,
  66         EFX_FAMILY_NTYPES
  67 } efx_family_t;
  68
  69 extern  __checkReturn   efx_rc_t
  70 efx_family(
  71         __in            uint16_t venid,
  72         __in            uint16_t devid,
  73         __out           efx_family_t *efp);
  74
  75
  76 #define EFX_PCI_VENID_SFC                       0x1924
  77
  78 #define EFX_PCI_DEVID_FALCON                    0x0710  /* SFC4000 */
  79
  80 #define EFX_PCI_DEVID_BETHPAGE                  0x0803  /* SFC9020 */
  81 #define EFX_PCI_DEVID_SIENA                     0x0813  /* SFL9021 */
  82 #define EFX_PCI_DEVID_SIENA_F1_UNINIT           0x0810
  83
  84 #define EFX_PCI_DEVID_HUNTINGTON_PF_UNINIT      0x0901
  85 #define EFX_PCI_DEVID_FARMINGDALE               0x0903  /* SFC9120 PF */
  86 #define EFX_PCI_DEVID_GREENPORT                 0x0923  /* SFC9140 PF */
  87
  88 #define EFX_PCI_DEVID_FARMINGDALE_VF            0x1903  /* SFC9120 VF */
  89 #define EFX_PCI_DEVID_GREENPORT_VF              0x1923  /* SFC9140 VF */
  90
  91 #define EFX_PCI_DEVID_MEDFORD_PF_UNINIT         0x0913
  92 #define EFX_PCI_DEVID_MEDFORD                   0x0A03  /* SFC9240 PF */
  93 #define EFX_PCI_DEVID_MEDFORD_VF                0x1A03  /* SFC9240 VF */
  94
  95 #define EFX_MEM_BAR     2
  96
  97 /* Error codes */
  98
  99 enum {
 100         EFX_ERR_INVALID,
 101         EFX_ERR_SRAM_OOB,
 102         EFX_ERR_BUFID_DC_OOB,
 103         EFX_ERR_MEM_PERR,
 104         EFX_ERR_RBUF_OWN,
 105         EFX_ERR_TBUF_OWN,
 106         EFX_ERR_RDESQ_OWN,
 107         EFX_ERR_TDESQ_OWN,
 108         EFX_ERR_EVQ_OWN,
 109         EFX_ERR_EVFF_OFLO,
 110         EFX_ERR_ILL_ADDR,
 111         EFX_ERR_SRAM_PERR,
 112         EFX_ERR_NCODES
 113 };
 114
 115 /* Calculate the IEEE 802.3 CRC32 of a MAC addr */
 116 extern  __checkReturn           uint32_t
 117 efx_crc32_calculate(
 118         __in                    uint32_t crc_init,
 119         __in_ecount(length)     uint8_t const *input,
 120         __in                    int length);
 121
 122
 123 /* Type prototypes */
 124
 125 typedef struct efx_rxq_s        efx_rxq_t;
 126
 127 /* NIC */
 128
 129 typedef struct efx_nic_s        efx_nic_t;
 130
 131 extern  __checkReturn   efx_rc_t
 132 efx_nic_create(
 133         __in            efx_family_t family,
 134         __in            efsys_identifier_t *esip,
 135         __in            efsys_bar_t *esbp,
 136         __in            efsys_lock_t *eslp,
 137         __deref_out     efx_nic_t **enpp);
 138
 139 extern  __checkReturn   efx_rc_t
 140 efx_nic_probe(
 141         __in            efx_nic_t *enp);
 142
 143 extern  __checkReturn   efx_rc_t
 144 efx_nic_init(
 145         __in            efx_nic_t *enp);
 146
 147 extern  __checkReturn   efx_rc_t
 148 efx_nic_reset(
 149         __in            efx_nic_t *enp);
 150
 151 #if EFSYS_OPT_DIAG
 152
 153 extern  __checkReturn   efx_rc_t
 154 efx_nic_register_test(
 155         __in            efx_nic_t *enp);
 156
 157 #endif  /* EFSYS_OPT_DIAG */
 158
 159 extern          void
 160 efx_nic_fini(
 161         __in            efx_nic_t *enp);
 162
 163 extern          void
 164 efx_nic_unprobe(
 165         __in            efx_nic_t *enp);
 166
 167 extern          void
 168 efx_nic_destroy(
 169         __in    efx_nic_t *enp);
 170
 171 #define EFX_PCIE_LINK_SPEED_GEN1                1
 172 #define EFX_PCIE_LINK_SPEED_GEN2                2
 173 #define EFX_PCIE_LINK_SPEED_GEN3                3
 174
 175 typedef enum efx_pcie_link_performance_e {
 176         EFX_PCIE_LINK_PERFORMANCE_UNKNOWN_BANDWIDTH,
 177         EFX_PCIE_LINK_PERFORMANCE_SUBOPTIMAL_BANDWIDTH,
 178         EFX_PCIE_LINK_PERFORMANCE_SUBOPTIMAL_LATENCY,
 179         EFX_PCIE_LINK_PERFORMANCE_OPTIMAL
 180 } efx_pcie_link_performance_t;
 181
 182 extern  __checkReturn   efx_rc_t
 183 efx_nic_calculate_pcie_link_bandwidth(
 184         __in            uint32_t pcie_link_width,
 185         __in            uint32_t pcie_link_gen,
 186         __out           uint32_t *bandwidth_mbpsp);
 187
 188 extern  __checkReturn   efx_rc_t
 189 efx_nic_check_pcie_link_speed(
 190         __in            efx_nic_t *enp,
 191         __in            uint32_t pcie_link_width,
 192         __in            uint32_t pcie_link_gen,
 193         __out           efx_pcie_link_performance_t *resultp);
 194
 195 #if EFSYS_OPT_MCDI
 196
 197 #if EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD
 198 /* Huntington and Medford require MCDIv2 commands */
 199 #define WITH_MCDI_V2 1
 200 #endif
 201
 202 typedef struct efx_mcdi_req_s efx_mcdi_req_t;
 203
 204 typedef enum efx_mcdi_exception_e {
 205         EFX_MCDI_EXCEPTION_MC_REBOOT,
 206         EFX_MCDI_EXCEPTION_MC_BADASSERT,
 207 } efx_mcdi_exception_t;
 208
 209 #if EFSYS_OPT_MCDI_LOGGING
 210 typedef enum efx_log_msg_e {
 211         EFX_LOG_INVALID,
 212         EFX_LOG_MCDI_REQUEST,
 213         EFX_LOG_MCDI_RESPONSE,
 214 } efx_log_msg_t;
 215 #endif /* EFSYS_OPT_MCDI_LOGGING */
 216
 217 typedef struct efx_mcdi_transport_s {
 218         void            *emt_context;
 219         efsys_mem_t     *emt_dma_mem;
 220         void            (*emt_execute)(void *, efx_mcdi_req_t *);
 221         void            (*emt_ev_cpl)(void *);
 222         void            (*emt_exception)(void *, efx_mcdi_exception_t);
 223 #if EFSYS_OPT_MCDI_LOGGING
 224         void            (*emt_logger)(void *, efx_log_msg_t,
 225                                         void *, size_t, void *, size_t);
 226 #endif /* EFSYS_OPT_MCDI_LOGGING */
 227 #if EFSYS_OPT_MCDI_PROXY_AUTH
 228         void            (*emt_ev_proxy_response)(void *, uint32_t, efx_rc_t);
 229 #endif /* EFSYS_OPT_MCDI_PROXY_AUTH */
 230 } efx_mcdi_transport_t;
 231
 232 extern  __checkReturn   efx_rc_t
 233 efx_mcdi_init(
 234         __in            efx_nic_t *enp,
 235         __in            const efx_mcdi_transport_t *mtp);
 236
 237 extern  __checkReturn   efx_rc_t
 238 efx_mcdi_reboot(
 239         __in            efx_nic_t *enp);
 240
 241                         void
 242 efx_mcdi_new_epoch(
 243         __in            efx_nic_t *enp);
 244
 245 extern                  void
 246 efx_mcdi_request_start(
 247         __in            efx_nic_t *enp,
 248         __in            efx_mcdi_req_t *emrp,
 249         __in            boolean_t ev_cpl);
 250
 251 extern  __checkReturn   boolean_t
 252 efx_mcdi_request_poll(
 253         __in            efx_nic_t *enp);
 254
 255 extern  __checkReturn   boolean_t
 256 efx_mcdi_request_abort(
 257         __in            efx_nic_t *enp);
 258
 259 extern                  void
 260 efx_mcdi_fini(
 261         __in            efx_nic_t *enp);
 262
 263 #endif  /* EFSYS_OPT_MCDI */
 264
 265 /* INTR */
 266
 267 #define EFX_NINTR_SIENA 1024
 268
 269 typedef enum efx_intr_type_e {
 270         EFX_INTR_INVALID = 0,
 271         EFX_INTR_LINE,
 272         EFX_INTR_MESSAGE,
 273         EFX_INTR_NTYPES
 274 } efx_intr_type_t;
 275
 276 #define EFX_INTR_SIZE   (sizeof (efx_oword_t))
 277
 278 extern  __checkReturn   efx_rc_t
 279 efx_intr_init(
 280         __in            efx_nic_t *enp,
 281         __in            efx_intr_type_t type,
 282         __in            efsys_mem_t *esmp);
 283
 284 extern                  void
 285 efx_intr_enable(
 286         __in            efx_nic_t *enp);
 287
 288 extern                  void
 289 efx_intr_disable(
 290         __in            efx_nic_t *enp);
 291
 292 extern                  void
 293 efx_intr_disable_unlocked(
 294         __in            efx_nic_t *enp);
 295
 296 #define EFX_INTR_NEVQS  32
 297
 298 extern  __checkReturn   efx_rc_t
 299 efx_intr_trigger(
 300         __in            efx_nic_t *enp,
 301         __in            unsigned int level);
 302
 303 extern                  void
 304 efx_intr_status_line(
 305         __in            efx_nic_t *enp,
 306         __out           boolean_t *fatalp,
 307         __out           uint32_t *maskp);
 308
 309 extern                  void
 310 efx_intr_status_message(
 311         __in            efx_nic_t *enp,
 312         __in            unsigned int message,
 313         __out           boolean_t *fatalp);
 314
 315 extern                  void
 316 efx_intr_fatal(
 317         __in            efx_nic_t *enp);
 318
 319 extern                  void
 320 efx_intr_fini(
 321         __in            efx_nic_t *enp);
 322
 323 /* MAC */
 324
 325 #if EFSYS_OPT_MAC_STATS
 326
 327 /* START MKCONFIG GENERATED EfxHeaderMacBlock e323546097fd7c65 */
 328 typedef enum efx_mac_stat_e {
 329         EFX_MAC_RX_OCTETS,
 330         EFX_MAC_RX_PKTS,
 331         EFX_MAC_RX_UNICST_PKTS,
 332         EFX_MAC_RX_MULTICST_PKTS,
 333         EFX_MAC_RX_BRDCST_PKTS,
 334         EFX_MAC_RX_PAUSE_PKTS,
 335         EFX_MAC_RX_LE_64_PKTS,
 336         EFX_MAC_RX_65_TO_127_PKTS,
 337         EFX_MAC_RX_128_TO_255_PKTS,
 338         EFX_MAC_RX_256_TO_511_PKTS,
 339         EFX_MAC_RX_512_TO_1023_PKTS,
 340         EFX_MAC_RX_1024_TO_15XX_PKTS,
 341         EFX_MAC_RX_GE_15XX_PKTS,
 342         EFX_MAC_RX_ERRORS,
 343         EFX_MAC_RX_FCS_ERRORS,
 344         EFX_MAC_RX_DROP_EVENTS,
 345         EFX_MAC_RX_FALSE_CARRIER_ERRORS,
 346         EFX_MAC_RX_SYMBOL_ERRORS,
 347         EFX_MAC_RX_ALIGN_ERRORS,
 348         EFX_MAC_RX_INTERNAL_ERRORS,
 349         EFX_MAC_RX_JABBER_PKTS,
 350         EFX_MAC_RX_LANE0_CHAR_ERR,
 351         EFX_MAC_RX_LANE1_CHAR_ERR,
 352         EFX_MAC_RX_LANE2_CHAR_ERR,
 353         EFX_MAC_RX_LANE3_CHAR_ERR,
 354         EFX_MAC_RX_LANE0_DISP_ERR,
 355         EFX_MAC_RX_LANE1_DISP_ERR,
 356         EFX_MAC_RX_LANE2_DISP_ERR,
 357         EFX_MAC_RX_LANE3_DISP_ERR,
 358         EFX_MAC_RX_MATCH_FAULT,
 359         EFX_MAC_RX_NODESC_DROP_CNT,
 360         EFX_MAC_TX_OCTETS,
 361         EFX_MAC_TX_PKTS,
 362         EFX_MAC_TX_UNICST_PKTS,
 363         EFX_MAC_TX_MULTICST_PKTS,
 364         EFX_MAC_TX_BRDCST_PKTS,
 365         EFX_MAC_TX_PAUSE_PKTS,
 366         EFX_MAC_TX_LE_64_PKTS,
 367         EFX_MAC_TX_65_TO_127_PKTS,
 368         EFX_MAC_TX_128_TO_255_PKTS,
 369         EFX_MAC_TX_256_TO_511_PKTS,
 370         EFX_MAC_TX_512_TO_1023_PKTS,
 371         EFX_MAC_TX_1024_TO_15XX_PKTS,
 372         EFX_MAC_TX_GE_15XX_PKTS,
 373         EFX_MAC_TX_ERRORS,
 374         EFX_MAC_TX_SGL_COL_PKTS,
 375         EFX_MAC_TX_MULT_COL_PKTS,
 376         EFX_MAC_TX_EX_COL_PKTS,
 377         EFX_MAC_TX_LATE_COL_PKTS,
 378         EFX_MAC_TX_DEF_PKTS,
 379         EFX_MAC_TX_EX_DEF_PKTS,
 380         EFX_MAC_PM_TRUNC_BB_OVERFLOW,
 381         EFX_MAC_PM_DISCARD_BB_OVERFLOW,
 382         EFX_MAC_PM_TRUNC_VFIFO_FULL,
 383         EFX_MAC_PM_DISCARD_VFIFO_FULL,
 384         EFX_MAC_PM_TRUNC_QBB,
 385         EFX_MAC_PM_DISCARD_QBB,
 386         EFX_MAC_PM_DISCARD_MAPPING,
 387         EFX_MAC_RXDP_Q_DISABLED_PKTS,
 388         EFX_MAC_RXDP_DI_DROPPED_PKTS,
 389         EFX_MAC_RXDP_STREAMING_PKTS,
 390         EFX_MAC_RXDP_HLB_FETCH,
 391         EFX_MAC_RXDP_HLB_WAIT,
 392         EFX_MAC_VADAPTER_RX_UNICAST_PACKETS,
 393         EFX_MAC_VADAPTER_RX_UNICAST_BYTES,
 394         EFX_MAC_VADAPTER_RX_MULTICAST_PACKETS,
 395         EFX_MAC_VADAPTER_RX_MULTICAST_BYTES,
 396         EFX_MAC_VADAPTER_RX_BROADCAST_PACKETS,
 397         EFX_MAC_VADAPTER_RX_BROADCAST_BYTES,
 398         EFX_MAC_VADAPTER_RX_BAD_PACKETS,
 399         EFX_MAC_VADAPTER_RX_BAD_BYTES,
 400         EFX_MAC_VADAPTER_RX_OVERFLOW,
 401         EFX_MAC_VADAPTER_TX_UNICAST_PACKETS,
 402         EFX_MAC_VADAPTER_TX_UNICAST_BYTES,
 403         EFX_MAC_VADAPTER_TX_MULTICAST_PACKETS,
 404         EFX_MAC_VADAPTER_TX_MULTICAST_BYTES,
 405         EFX_MAC_VADAPTER_TX_BROADCAST_PACKETS,
 406         EFX_MAC_VADAPTER_TX_BROADCAST_BYTES,
 407         EFX_MAC_VADAPTER_TX_BAD_PACKETS,
 408         EFX_MAC_VADAPTER_TX_BAD_BYTES,
 409         EFX_MAC_VADAPTER_TX_OVERFLOW,
 410         EFX_MAC_NSTATS
 411 } efx_mac_stat_t;
 412
 413 /* END MKCONFIG GENERATED EfxHeaderMacBlock */
 414
 415 #endif  /* EFSYS_OPT_MAC_STATS */
 416
 417 typedef enum efx_link_mode_e {
 418         EFX_LINK_UNKNOWN = 0,
 419         EFX_LINK_DOWN,
 420         EFX_LINK_10HDX,
 421         EFX_LINK_10FDX,
 422         EFX_LINK_100HDX,
 423         EFX_LINK_100FDX,
 424         EFX_LINK_1000HDX,
 425         EFX_LINK_1000FDX,
 426         EFX_LINK_10000FDX,
 427         EFX_LINK_40000FDX,
 428         EFX_LINK_NMODES
 429 } efx_link_mode_t;
 430
 431 #define EFX_MAC_ADDR_LEN 6
 432
 433 #define EFX_MAC_ADDR_IS_MULTICAST(_address) (((uint8_t *)_address)[0] & 0x01)
 434
 435 #define EFX_MAC_MULTICAST_LIST_MAX      256
 436
 437 #define EFX_MAC_SDU_MAX 9202
 438
 439 #define EFX_MAC_PDU_ADJUSTMENT                                  \
 440         (/* EtherII */ 14                                       \
 441             + /* VLAN */ 4                                      \
 442             + /* CRC */ 4                                       \
 443             + /* bug16011 */ 16)                                \
 444
 445 #define EFX_MAC_PDU(_sdu)                                       \
 446         P2ROUNDUP((_sdu) + EFX_MAC_PDU_ADJUSTMENT, 8)
 447
 448 /*
 449  * Due to the P2ROUNDUP in EFX_MAC_PDU(), EFX_MAC_SDU_FROM_PDU() may give
 450  * the SDU rounded up slightly.
 451  */
 452 #define EFX_MAC_SDU_FROM_PDU(_pdu)      ((_pdu) - EFX_MAC_PDU_ADJUSTMENT)
 453
 454 #define EFX_MAC_PDU_MIN 60
 455 #define EFX_MAC_PDU_MAX EFX_MAC_PDU(EFX_MAC_SDU_MAX)
 456
 457 extern  __checkReturn   efx_rc_t
 458 efx_mac_pdu_get(
 459         __in            efx_nic_t *enp,
 460         __out           size_t *pdu);
 461
 462 extern  __checkReturn   efx_rc_t
 463 efx_mac_pdu_set(
 464         __in            efx_nic_t *enp,
 465         __in            size_t pdu);
 466
 467 extern  __checkReturn   efx_rc_t
 468 efx_mac_addr_set(
 469         __in            efx_nic_t *enp,
 470         __in            uint8_t *addr);
 471
 472 extern  __checkReturn                   efx_rc_t
 473 efx_mac_filter_set(
 474         __in                            efx_nic_t *enp,
 475         __in                            boolean_t all_unicst,
 476         __in                            boolean_t mulcst,
 477         __in                            boolean_t all_mulcst,
 478         __in                            boolean_t brdcst);
 479
 480 extern  __checkReturn   efx_rc_t
 481 efx_mac_multicast_list_set(
 482         __in                            efx_nic_t *enp,
 483         __in_ecount(6*count)            uint8_t const *addrs,
 484         __in                            int count);
 485
 486 extern  __checkReturn   efx_rc_t
 487 efx_mac_filter_default_rxq_set(
 488         __in            efx_nic_t *enp,
 489         __in            efx_rxq_t *erp,
 490         __in            boolean_t using_rss);
 491
 492 extern                  void
 493 efx_mac_filter_default_rxq_clear(
 494         __in            efx_nic_t *enp);
 495
 496 extern  __checkReturn   efx_rc_t
 497 efx_mac_drain(
 498         __in            efx_nic_t *enp,
 499         __in            boolean_t enabled);
 500
 501 extern  __checkReturn   efx_rc_t
 502 efx_mac_up(
 503         __in            efx_nic_t *enp,
 504         __out           boolean_t *mac_upp);
 505
 506 #define EFX_FCNTL_RESPOND       0x00000001
 507 #define EFX_FCNTL_GENERATE      0x00000002
 508
 509 extern  __checkReturn   efx_rc_t
 510 efx_mac_fcntl_set(
 511         __in            efx_nic_t *enp,
 512         __in            unsigned int fcntl,
 513         __in            boolean_t autoneg);
 514
 515 extern                  void
 516 efx_mac_fcntl_get(
 517         __in            efx_nic_t *enp,
 518         __out           unsigned int *fcntl_wantedp,
 519         __out           unsigned int *fcntl_linkp);
 520
 521
 522 #if EFSYS_OPT_MAC_STATS
 523
 524 #if EFSYS_OPT_NAMES
 525
 526 extern  __checkReturn                   const char *
 527 efx_mac_stat_name(
 528         __in                            efx_nic_t *enp,
 529         __in                            unsigned int id);
 530
 531 #endif  /* EFSYS_OPT_NAMES */
 532
 533 #define EFX_MAC_STATS_MASK_BITS_PER_PAGE        (8 * sizeof (uint32_t))
 534
 535 #define EFX_MAC_STATS_MASK_NPAGES       \
 536         (P2ROUNDUP(EFX_MAC_NSTATS, EFX_MAC_STATS_MASK_BITS_PER_PAGE) / \
 537             EFX_MAC_STATS_MASK_BITS_PER_PAGE)
 538
 539 /*
 540  * Get mask of MAC statistics supported by the hardware.
 541  *
 542  * If mask_size is insufficient to return the mask, EINVAL error is
 543  * returned. EFX_MAC_STATS_MASK_NPAGES multiplied by size of the page
 544  * (which is sizeof (uint32_t)) is sufficient.
 545  */
 546 extern  __checkReturn                   efx_rc_t
 547 efx_mac_stats_get_mask(
 548         __in                            efx_nic_t *enp,
 549         __out_bcount(mask_size)         uint32_t *maskp,
 550         __in                            size_t mask_size);
 551
 552 #define EFX_MAC_STAT_SUPPORTED(_mask, _stat)    \
 553         ((_mask)[(_stat) / EFX_MAC_STATS_MASK_BITS_PER_PAGE] &  \
 554          (1ULL << ((_stat) & (EFX_MAC_STATS_MASK_BITS_PER_PAGE - 1))))
 555
 556 #define EFX_MAC_STATS_SIZE 0x400
 557
 558 /*
 559  * Upload mac statistics supported by the hardware into the given buffer.
 560  *
 561  * The reference buffer must be at least %EFX_MAC_STATS_SIZE bytes,
 562  * and page aligned.
 563  *
 564  * The hardware will only DMA statistics that it understands (of course).
 565  * Drivers should not make any assumptions about which statistics are
 566  * supported, especially when the statistics are generated by firmware.
 567  *
 568  * Thus, drivers should zero this buffer before use, so that not-understood
 569  * statistics read back as zero.
 570  */
 571 extern  __checkReturn                   efx_rc_t
 572 efx_mac_stats_upload(
 573         __in                            efx_nic_t *enp,
 574         __in                            efsys_mem_t *esmp);
 575
 576 extern  __checkReturn                   efx_rc_t
 577 efx_mac_stats_periodic(
 578         __in                            efx_nic_t *enp,
 579         __in                            efsys_mem_t *esmp,
 580         __in                            uint16_t period_ms,
 581         __in                            boolean_t events);
 582
 583 extern  __checkReturn                   efx_rc_t
 584 efx_mac_stats_update(
 585         __in                            efx_nic_t *enp,
 586         __in                            efsys_mem_t *esmp,
 587         __inout_ecount(EFX_MAC_NSTATS)  efsys_stat_t *stat,
 588         __inout_opt                     uint32_t *generationp);
 589
 590 #endif  /* EFSYS_OPT_MAC_STATS */
 591
 592 /* MON */
 593
 594 typedef enum efx_mon_type_e {
 595         EFX_MON_INVALID = 0,
 596         EFX_MON_SFC90X0,
 597         EFX_MON_SFC91X0,
 598         EFX_MON_SFC92X0,
 599         EFX_MON_NTYPES
 600 } efx_mon_type_t;
 601
 602 #if EFSYS_OPT_NAMES
 603
 604 extern          const char *
 605 efx_mon_name(
 606         __in    efx_nic_t *enp);
 607
 608 #endif  /* EFSYS_OPT_NAMES */
 609
 610 extern  __checkReturn   efx_rc_t
 611 efx_mon_init(
 612         __in            efx_nic_t *enp);
 613
 614 #if EFSYS_OPT_MON_STATS
 615
 616 #define EFX_MON_STATS_PAGE_SIZE 0x100
 617 #define EFX_MON_MASK_ELEMENT_SIZE 32
 618
 619 /* START MKCONFIG GENERATED MonitorHeaderStatsBlock 5d4ee5185e419abe */
 620 typedef enum efx_mon_stat_e {
 621         EFX_MON_STAT_2_5V,
 622         EFX_MON_STAT_VCCP1,
 623         EFX_MON_STAT_VCC,
 624         EFX_MON_STAT_5V,
 625         EFX_MON_STAT_12V,
 626         EFX_MON_STAT_VCCP2,
 627         EFX_MON_STAT_EXT_TEMP,
 628         EFX_MON_STAT_INT_TEMP,
 629         EFX_MON_STAT_AIN1,
 630         EFX_MON_STAT_AIN2,
 631         EFX_MON_STAT_INT_COOLING,
 632         EFX_MON_STAT_EXT_COOLING,
 633         EFX_MON_STAT_1V,
 634         EFX_MON_STAT_1_2V,
 635         EFX_MON_STAT_1_8V,
 636         EFX_MON_STAT_3_3V,
 637         EFX_MON_STAT_1_2VA,
 638         EFX_MON_STAT_VREF,
 639         EFX_MON_STAT_VAOE,
 640         EFX_MON_STAT_AOE_TEMP,
 641         EFX_MON_STAT_PSU_AOE_TEMP,
 642         EFX_MON_STAT_PSU_TEMP,
 643         EFX_MON_STAT_FAN0,
 644         EFX_MON_STAT_FAN1,
 645         EFX_MON_STAT_FAN2,
 646         EFX_MON_STAT_FAN3,
 647         EFX_MON_STAT_FAN4,
 648         EFX_MON_STAT_VAOE_IN,
 649         EFX_MON_STAT_IAOE,
 650         EFX_MON_STAT_IAOE_IN,
 651         EFX_MON_STAT_NIC_POWER,
 652         EFX_MON_STAT_0_9V,
 653         EFX_MON_STAT_I0_9V,
 654         EFX_MON_STAT_I1_2V,
 655         EFX_MON_STAT_0_9V_ADC,
 656         EFX_MON_STAT_INT_TEMP2,
 657         EFX_MON_STAT_VREG_TEMP,
 658         EFX_MON_STAT_VREG_0_9V_TEMP,
 659         EFX_MON_STAT_VREG_1_2V_TEMP,
 660         EFX_MON_STAT_INT_VPTAT,
 661         EFX_MON_STAT_INT_ADC_TEMP,
 662         EFX_MON_STAT_EXT_VPTAT,
 663         EFX_MON_STAT_EXT_ADC_TEMP,
 664         EFX_MON_STAT_AMBIENT_TEMP,
 665         EFX_MON_STAT_AIRFLOW,
 666         EFX_MON_STAT_VDD08D_VSS08D_CSR,
 667         EFX_MON_STAT_VDD08D_VSS08D_CSR_EXTADC,
 668         EFX_MON_STAT_HOTPOINT_TEMP,
 669         EFX_MON_STAT_PHY_POWER_SWITCH_PORT0,
 670         EFX_MON_STAT_PHY_POWER_SWITCH_PORT1,
 671         EFX_MON_STAT_MUM_VCC,
 672         EFX_MON_STAT_0V9_A,
 673         EFX_MON_STAT_I0V9_A,
 674         EFX_MON_STAT_0V9_A_TEMP,
 675         EFX_MON_STAT_0V9_B,
 676         EFX_MON_STAT_I0V9_B,
 677         EFX_MON_STAT_0V9_B_TEMP,
 678         EFX_MON_STAT_CCOM_AVREG_1V2_SUPPLY,
 679         EFX_MON_STAT_CCOM_AVREG_1V2_SUPPLY_EXT_ADC,
 680         EFX_MON_STAT_CCOM_AVREG_1V8_SUPPLY,
 681         EFX_MON_STAT_CCOM_AVREG_1V8_SUPPLY_EXT_ADC,
 682         EFX_MON_STAT_CONTROLLER_MASTER_VPTAT,
 683         EFX_MON_STAT_CONTROLLER_MASTER_INTERNAL_TEMP,
 684         EFX_MON_STAT_CONTROLLER_MASTER_VPTAT_EXT_ADC,
 685         EFX_MON_STAT_CONTROLLER_MASTER_INTERNAL_TEMP_EXT_ADC,
 686         EFX_MON_STAT_CONTROLLER_SLAVE_VPTAT,
 687         EFX_MON_STAT_CONTROLLER_SLAVE_INTERNAL_TEMP,
 688         EFX_MON_STAT_CONTROLLER_SLAVE_VPTAT_EXT_ADC,
 689         EFX_MON_STAT_CONTROLLER_SLAVE_INTERNAL_TEMP_EXT_ADC,
 690         EFX_MON_STAT_SODIMM_VOUT,
 691         EFX_MON_STAT_SODIMM_0_TEMP,
 692         EFX_MON_STAT_SODIMM_1_TEMP,
 693         EFX_MON_STAT_PHY0_VCC,
 694         EFX_MON_STAT_PHY1_VCC,
 695         EFX_MON_STAT_CONTROLLER_TDIODE_TEMP,
 696         EFX_MON_STAT_BOARD_FRONT_TEMP,
 697         EFX_MON_STAT_BOARD_BACK_TEMP,
 698         EFX_MON_NSTATS
 699 } efx_mon_stat_t;
 700
 701 /* END MKCONFIG GENERATED MonitorHeaderStatsBlock */
 702
 703 typedef enum efx_mon_stat_state_e {
 704         EFX_MON_STAT_STATE_OK = 0,
 705         EFX_MON_STAT_STATE_WARNING = 1,
 706         EFX_MON_STAT_STATE_FATAL = 2,
 707         EFX_MON_STAT_STATE_BROKEN = 3,
 708         EFX_MON_STAT_STATE_NO_READING = 4,
 709 } efx_mon_stat_state_t;
 710
 711 typedef struct efx_mon_stat_value_s {
 712         uint16_t        emsv_value;
 713         uint16_t        emsv_state;
 714 } efx_mon_stat_value_t;
 715
 716 #if EFSYS_OPT_NAMES
 717
 718 extern                                  const char *
 719 efx_mon_stat_name(
 720         __in                            efx_nic_t *enp,
 721         __in                            efx_mon_stat_t id);
 722
 723 #endif  /* EFSYS_OPT_NAMES */
 724
 725 extern  __checkReturn                   efx_rc_t
 726 efx_mon_stats_update(
 727         __in                            efx_nic_t *enp,
 728         __in                            efsys_mem_t *esmp,
 729         __inout_ecount(EFX_MON_NSTATS)  efx_mon_stat_value_t *values);
 730
 731 #endif  /* EFSYS_OPT_MON_STATS */
 732
 733 extern          void
 734 efx_mon_fini(
 735         __in    efx_nic_t *enp);
 736
 737 /* PHY */
 738
 739 extern  __checkReturn   efx_rc_t
 740 efx_phy_verify(
 741         __in            efx_nic_t *enp);
 742
 743 #if EFSYS_OPT_PHY_LED_CONTROL
 744
 745 typedef enum efx_phy_led_mode_e {
 746         EFX_PHY_LED_DEFAULT = 0,
 747         EFX_PHY_LED_OFF,
 748         EFX_PHY_LED_ON,
 749         EFX_PHY_LED_FLASH,
 750         EFX_PHY_LED_NMODES
 751 } efx_phy_led_mode_t;
 752
 753 extern  __checkReturn   efx_rc_t
 754 efx_phy_led_set(
 755         __in    efx_nic_t *enp,
 756         __in    efx_phy_led_mode_t mode);
 757
 758 #endif  /* EFSYS_OPT_PHY_LED_CONTROL */
 759
 760 extern  __checkReturn   efx_rc_t
 761 efx_port_init(
 762         __in            efx_nic_t *enp);
 763
 764 #if EFSYS_OPT_LOOPBACK
 765
 766 typedef enum efx_loopback_type_e {
 767         EFX_LOOPBACK_OFF = 0,
 768         EFX_LOOPBACK_DATA = 1,
 769         EFX_LOOPBACK_GMAC = 2,
 770         EFX_LOOPBACK_XGMII = 3,
 771         EFX_LOOPBACK_XGXS = 4,
 772         EFX_LOOPBACK_XAUI = 5,
 773         EFX_LOOPBACK_GMII = 6,
 774         EFX_LOOPBACK_SGMII = 7,
 775         EFX_LOOPBACK_XGBR = 8,
 776         EFX_LOOPBACK_XFI = 9,
 777         EFX_LOOPBACK_XAUI_FAR = 10,
 778         EFX_LOOPBACK_GMII_FAR = 11,
 779         EFX_LOOPBACK_SGMII_FAR = 12,
 780         EFX_LOOPBACK_XFI_FAR = 13,
 781         EFX_LOOPBACK_GPHY = 14,
 782         EFX_LOOPBACK_PHY_XS = 15,
 783         EFX_LOOPBACK_PCS = 16,
 784         EFX_LOOPBACK_PMA_PMD = 17,
 785         EFX_LOOPBACK_XPORT = 18,
 786         EFX_LOOPBACK_XGMII_WS = 19,
 787         EFX_LOOPBACK_XAUI_WS = 20,
 788         EFX_LOOPBACK_XAUI_WS_FAR = 21,
 789         EFX_LOOPBACK_XAUI_WS_NEAR = 22,
 790         EFX_LOOPBACK_GMII_WS = 23,
 791         EFX_LOOPBACK_XFI_WS = 24,
 792         EFX_LOOPBACK_XFI_WS_FAR = 25,
 793         EFX_LOOPBACK_PHYXS_WS = 26,
 794         EFX_LOOPBACK_PMA_INT = 27,
 795         EFX_LOOPBACK_SD_NEAR = 28,
 796         EFX_LOOPBACK_SD_FAR = 29,
 797         EFX_LOOPBACK_PMA_INT_WS = 30,
 798         EFX_LOOPBACK_SD_FEP2_WS = 31,
 799         EFX_LOOPBACK_SD_FEP1_5_WS = 32,
 800         EFX_LOOPBACK_SD_FEP_WS = 33,
 801         EFX_LOOPBACK_SD_FES_WS = 34,
 802         EFX_LOOPBACK_NTYPES
 803 } efx_loopback_type_t;
 804
 805 typedef enum efx_loopback_kind_e {
 806         EFX_LOOPBACK_KIND_OFF = 0,
 807         EFX_LOOPBACK_KIND_ALL,
 808         EFX_LOOPBACK_KIND_MAC,
 809         EFX_LOOPBACK_KIND_PHY,
 810         EFX_LOOPBACK_NKINDS
 811 } efx_loopback_kind_t;
 812
 813 extern                  void
 814 efx_loopback_mask(
 815         __in    efx_loopback_kind_t loopback_kind,
 816         __out   efx_qword_t *maskp);
 817
 818 extern  __checkReturn   efx_rc_t
 819 efx_port_loopback_set(
 820         __in    efx_nic_t *enp,
 821         __in    efx_link_mode_t link_mode,
 822         __in    efx_loopback_type_t type);
 823
 824 #if EFSYS_OPT_NAMES
 825
 826 extern  __checkReturn   const char *
 827 efx_loopback_type_name(
 828         __in            efx_nic_t *enp,
 829         __in            efx_loopback_type_t type);
 830
 831 #endif  /* EFSYS_OPT_NAMES */
 832
 833 #endif  /* EFSYS_OPT_LOOPBACK */
 834
 835 extern  __checkReturn   efx_rc_t
 836 efx_port_poll(
 837         __in            efx_nic_t *enp,
 838         __out_opt       efx_link_mode_t *link_modep);
 839
 840 extern          void
 841 efx_port_fini(
 842         __in    efx_nic_t *enp);
 843
 844 typedef enum efx_phy_cap_type_e {
 845         EFX_PHY_CAP_INVALID = 0,
 846         EFX_PHY_CAP_10HDX,
 847         EFX_PHY_CAP_10FDX,
 848         EFX_PHY_CAP_100HDX,
 849         EFX_PHY_CAP_100FDX,
 850         EFX_PHY_CAP_1000HDX,
 851         EFX_PHY_CAP_1000FDX,
 852         EFX_PHY_CAP_10000FDX,
 853         EFX_PHY_CAP_PAUSE,
 854         EFX_PHY_CAP_ASYM,
 855         EFX_PHY_CAP_AN,
 856         EFX_PHY_CAP_40000FDX,
 857         EFX_PHY_CAP_NTYPES
 858 } efx_phy_cap_type_t;
 859
 860
 861 #define EFX_PHY_CAP_CURRENT     0x00000000
 862 #define EFX_PHY_CAP_DEFAULT     0x00000001
 863 #define EFX_PHY_CAP_PERM        0x00000002
 864
 865 extern          void
 866 efx_phy_adv_cap_get(
 867         __in            efx_nic_t *enp,
 868         __in            uint32_t flag,
 869         __out           uint32_t *maskp);
 870
 871 extern  __checkReturn   efx_rc_t
 872 efx_phy_adv_cap_set(
 873         __in            efx_nic_t *enp,
 874         __in            uint32_t mask);
 875
 876 extern                  void
 877 efx_phy_lp_cap_get(
 878         __in            efx_nic_t *enp,
 879         __out           uint32_t *maskp);
 880
 881 extern  __checkReturn   efx_rc_t
 882 efx_phy_oui_get(
 883         __in            efx_nic_t *enp,
 884         __out           uint32_t *ouip);
 885
 886 typedef enum efx_phy_media_type_e {
 887         EFX_PHY_MEDIA_INVALID = 0,
 888         EFX_PHY_MEDIA_XAUI,
 889         EFX_PHY_MEDIA_CX4,
 890         EFX_PHY_MEDIA_KX4,
 891         EFX_PHY_MEDIA_XFP,
 892         EFX_PHY_MEDIA_SFP_PLUS,
 893         EFX_PHY_MEDIA_BASE_T,
 894         EFX_PHY_MEDIA_QSFP_PLUS,
 895         EFX_PHY_MEDIA_NTYPES
 896 } efx_phy_media_type_t;
 897
 898 /* Get the type of medium currently used.  If the board has ports for
 899  * modules, a module is present, and we recognise the media type of
 900  * the module, then this will be the media type of the module.
 901  * Otherwise it will be the media type of the port.
 902  */
 903 extern                  void
 904 efx_phy_media_type_get(
 905         __in            efx_nic_t *enp,
 906         __out           efx_phy_media_type_t *typep);
 907
 908 extern                                  efx_rc_t
 909 efx_phy_module_get_info(
 910         __in                            efx_nic_t *enp,
 911         __in                            uint8_t dev_addr,
 912         __in                            uint8_t offset,
 913         __in                            uint8_t len,
 914         __out_bcount(len)               uint8_t *data);
 915
 916 #if EFSYS_OPT_PHY_STATS
 917
 918 /* START MKCONFIG GENERATED PhyHeaderStatsBlock 30ed56ad501f8e36 */
 919 typedef enum efx_phy_stat_e {
 920         EFX_PHY_STAT_OUI,
 921         EFX_PHY_STAT_PMA_PMD_LINK_UP,
 922         EFX_PHY_STAT_PMA_PMD_RX_FAULT,
 923         EFX_PHY_STAT_PMA_PMD_TX_FAULT,
 924         EFX_PHY_STAT_PMA_PMD_REV_A,
 925         EFX_PHY_STAT_PMA_PMD_REV_B,
 926         EFX_PHY_STAT_PMA_PMD_REV_C,
 927         EFX_PHY_STAT_PMA_PMD_REV_D,
 928         EFX_PHY_STAT_PCS_LINK_UP,
 929         EFX_PHY_STAT_PCS_RX_FAULT,
 930         EFX_PHY_STAT_PCS_TX_FAULT,
 931         EFX_PHY_STAT_PCS_BER,
 932         EFX_PHY_STAT_PCS_BLOCK_ERRORS,
 933         EFX_PHY_STAT_PHY_XS_LINK_UP,
 934         EFX_PHY_STAT_PHY_XS_RX_FAULT,
 935         EFX_PHY_STAT_PHY_XS_TX_FAULT,
 936         EFX_PHY_STAT_PHY_XS_ALIGN,
 937         EFX_PHY_STAT_PHY_XS_SYNC_A,
 938         EFX_PHY_STAT_PHY_XS_SYNC_B,
 939         EFX_PHY_STAT_PHY_XS_SYNC_C,
 940         EFX_PHY_STAT_PHY_XS_SYNC_D,
 941         EFX_PHY_STAT_AN_LINK_UP,
 942         EFX_PHY_STAT_AN_MASTER,
 943         EFX_PHY_STAT_AN_LOCAL_RX_OK,
 944         EFX_PHY_STAT_AN_REMOTE_RX_OK,
 945         EFX_PHY_STAT_CL22EXT_LINK_UP,
 946         EFX_PHY_STAT_SNR_A,
 947         EFX_PHY_STAT_SNR_B,
 948         EFX_PHY_STAT_SNR_C,
 949         EFX_PHY_STAT_SNR_D,
 950         EFX_PHY_STAT_PMA_PMD_SIGNAL_A,
 951         EFX_PHY_STAT_PMA_PMD_SIGNAL_B,
 952         EFX_PHY_STAT_PMA_PMD_SIGNAL_C,
 953         EFX_PHY_STAT_PMA_PMD_SIGNAL_D,
 954         EFX_PHY_STAT_AN_COMPLETE,
 955         EFX_PHY_STAT_PMA_PMD_REV_MAJOR,
 956         EFX_PHY_STAT_PMA_PMD_REV_MINOR,
 957         EFX_PHY_STAT_PMA_PMD_REV_MICRO,
 958         EFX_PHY_STAT_PCS_FW_VERSION_0,
 959         EFX_PHY_STAT_PCS_FW_VERSION_1,
 960         EFX_PHY_STAT_PCS_FW_VERSION_2,
 961         EFX_PHY_STAT_PCS_FW_VERSION_3,
 962         EFX_PHY_STAT_PCS_FW_BUILD_YY,
 963         EFX_PHY_STAT_PCS_FW_BUILD_MM,
 964         EFX_PHY_STAT_PCS_FW_BUILD_DD,
 965         EFX_PHY_STAT_PCS_OP_MODE,
 966         EFX_PHY_NSTATS
 967 } efx_phy_stat_t;
 968
 969 /* END MKCONFIG GENERATED PhyHeaderStatsBlock */
 970
 971 #if EFSYS_OPT_NAMES
 972
 973 extern                                  const char *
 974 efx_phy_stat_name(
 975         __in                            efx_nic_t *enp,
 976         __in                            efx_phy_stat_t stat);
 977
 978 #endif  /* EFSYS_OPT_NAMES */
 979
 980 #define EFX_PHY_STATS_SIZE 0x100
 981
 982 extern  __checkReturn                   efx_rc_t
 983 efx_phy_stats_update(
 984         __in                            efx_nic_t *enp,
 985         __in                            efsys_mem_t *esmp,
 986         __inout_ecount(EFX_PHY_NSTATS)  uint32_t *stat);
 987
 988 #endif  /* EFSYS_OPT_PHY_STATS */
 989
 990
 991 #if EFSYS_OPT_BIST
 992
 993 typedef enum efx_bist_type_e {
 994         EFX_BIST_TYPE_UNKNOWN,
 995         EFX_BIST_TYPE_PHY_NORMAL,
 996         EFX_BIST_TYPE_PHY_CABLE_SHORT,
 997         EFX_BIST_TYPE_PHY_CABLE_LONG,
 998         EFX_BIST_TYPE_MC_MEM,   /* Test the MC DMEM and IMEM */
 999         EFX_BIST_TYPE_SAT_MEM,  /* Test the DMEM and IMEM of satellite cpus*/
1000         EFX_BIST_TYPE_REG,      /* Test the register memories */
1001         EFX_BIST_TYPE_NTYPES,
1002 } efx_bist_type_t;
1003
1004 typedef enum efx_bist_result_e {
1005         EFX_BIST_RESULT_UNKNOWN,
1006         EFX_BIST_RESULT_RUNNING,
1007         EFX_BIST_RESULT_PASSED,
1008         EFX_BIST_RESULT_FAILED,
1009 } efx_bist_result_t;
1010
1011 typedef enum efx_phy_cable_status_e {
1012         EFX_PHY_CABLE_STATUS_OK,
1013         EFX_PHY_CABLE_STATUS_INVALID,
1014         EFX_PHY_CABLE_STATUS_OPEN,
1015         EFX_PHY_CABLE_STATUS_INTRAPAIRSHORT,
1016         EFX_PHY_CABLE_STATUS_INTERPAIRSHORT,
1017         EFX_PHY_CABLE_STATUS_BUSY,
1018 } efx_phy_cable_status_t;
1019
1020 typedef enum efx_bist_value_e {
1021         EFX_BIST_PHY_CABLE_LENGTH_A,
1022         EFX_BIST_PHY_CABLE_LENGTH_B,
1023         EFX_BIST_PHY_CABLE_LENGTH_C,
1024         EFX_BIST_PHY_CABLE_LENGTH_D,
1025         EFX_BIST_PHY_CABLE_STATUS_A,
1026         EFX_BIST_PHY_CABLE_STATUS_B,
1027         EFX_BIST_PHY_CABLE_STATUS_C,
1028         EFX_BIST_PHY_CABLE_STATUS_D,
1029         EFX_BIST_FAULT_CODE,
1030         /* Memory BIST specific values. These match to the MC_CMD_BIST_POLL
1031          * response. */
1032         EFX_BIST_MEM_TEST,
1033         EFX_BIST_MEM_ADDR,
1034         EFX_BIST_MEM_BUS,
1035         EFX_BIST_MEM_EXPECT,
1036         EFX_BIST_MEM_ACTUAL,
1037         EFX_BIST_MEM_ECC,
1038         EFX_BIST_MEM_ECC_PARITY,
1039         EFX_BIST_MEM_ECC_FATAL,
1040         EFX_BIST_NVALUES,
1041 } efx_bist_value_t;
1042
1043 extern  __checkReturn           efx_rc_t
1044 efx_bist_enable_offline(
1045         __in                    efx_nic_t *enp);
1046
1047 extern  __checkReturn           efx_rc_t
1048 efx_bist_start(
1049         __in                    efx_nic_t *enp,
1050         __in                    efx_bist_type_t type);
1051
1052 extern  __checkReturn           efx_rc_t
1053 efx_bist_poll(
1054         __in                    efx_nic_t *enp,
1055         __in                    efx_bist_type_t type,
1056         __out                   efx_bist_result_t *resultp,
1057         __out_opt               uint32_t *value_maskp,
1058         __out_ecount_opt(count) unsigned long *valuesp,
1059         __in                    size_t count);
1060
1061 extern                          void
1062 efx_bist_stop(
1063         __in                    efx_nic_t *enp,
1064         __in                    efx_bist_type_t type);
1065
1066 #endif  /* EFSYS_OPT_BIST */
1067
1068 #define EFX_FEATURE_IPV6                0x00000001
1069 #define EFX_FEATURE_LFSR_HASH_INSERT    0x00000002
1070 #define EFX_FEATURE_LINK_EVENTS         0x00000004
1071 #define EFX_FEATURE_PERIODIC_MAC_STATS  0x00000008
1072 #define EFX_FEATURE_WOL                 0x00000010
1073 #define EFX_FEATURE_MCDI                0x00000020
1074 #define EFX_FEATURE_LOOKAHEAD_SPLIT     0x00000040
1075 #define EFX_FEATURE_MAC_HEADER_FILTERS  0x00000080
1076 #define EFX_FEATURE_TURBO               0x00000100
1077 #define EFX_FEATURE_MCDI_DMA            0x00000200
1078 #define EFX_FEATURE_TX_SRC_FILTERS      0x00000400
1079 #define EFX_FEATURE_PIO_BUFFERS         0x00000800
1080 #define EFX_FEATURE_FW_ASSISTED_TSO     0x00001000
1081 #define EFX_FEATURE_FW_ASSISTED_TSO_V2  0x00002000
1082
1083 typedef struct efx_nic_cfg_s {
1084         uint32_t                enc_board_type;
1085         uint32_t                enc_phy_type;
1086 #if EFSYS_OPT_NAMES
1087         char                    enc_phy_name[21];
1088 #endif
1089         char                    enc_phy_revision[21];
1090         efx_mon_type_t          enc_mon_type;
1091 #if EFSYS_OPT_MON_STATS
1092         uint32_t                enc_mon_stat_dma_buf_size;
1093         uint32_t                enc_mon_stat_mask[(EFX_MON_NSTATS + 31) / 32];
1094 #endif
1095         unsigned int            enc_features;
1096         uint8_t                 enc_mac_addr[6];
1097         uint8_t                 enc_port;       /* PHY port number */
1098         uint32_t                enc_intr_vec_base;
1099         uint32_t                enc_intr_limit;
1100         uint32_t                enc_evq_limit;
1101         uint32_t                enc_txq_limit;
1102         uint32_t                enc_rxq_limit;
1103         uint32_t                enc_buftbl_limit;
1104         uint32_t                enc_piobuf_limit;
1105         uint32_t                enc_piobuf_size;
1106         uint32_t                enc_piobuf_min_alloc_size;
1107         uint32_t                enc_evq_timer_quantum_ns;
1108         uint32_t                enc_evq_timer_max_us;
1109         uint32_t                enc_clk_mult;
1110         uint32_t                enc_rx_prefix_size;
1111         uint32_t                enc_rx_buf_align_start;
1112         uint32_t                enc_rx_buf_align_end;
1113 #if EFSYS_OPT_LOOPBACK
1114         efx_qword_t             enc_loopback_types[EFX_LINK_NMODES];
1115 #endif  /* EFSYS_OPT_LOOPBACK */
1116 #if EFSYS_OPT_PHY_FLAGS
1117         uint32_t                enc_phy_flags_mask;
1118 #endif  /* EFSYS_OPT_PHY_FLAGS */
1119 #if EFSYS_OPT_PHY_LED_CONTROL
1120         uint32_t                enc_led_mask;
1121 #endif  /* EFSYS_OPT_PHY_LED_CONTROL */
1122 #if EFSYS_OPT_PHY_STATS
1123         uint64_t                enc_phy_stat_mask;
1124 #endif  /* EFSYS_OPT_PHY_STATS */
1125 #if EFSYS_OPT_MCDI
1126         uint8_t                 enc_mcdi_mdio_channel;
1127 #if EFSYS_OPT_PHY_STATS
1128         uint32_t                enc_mcdi_phy_stat_mask;
1129 #endif  /* EFSYS_OPT_PHY_STATS */
1130 #if EFSYS_OPT_MON_STATS
1131         uint32_t                *enc_mcdi_sensor_maskp;
1132         uint32_t                enc_mcdi_sensor_mask_size;
1133 #endif  /* EFSYS_OPT_MON_STATS */
1134 #endif  /* EFSYS_OPT_MCDI */
1135 #if EFSYS_OPT_BIST
1136         uint32_t                enc_bist_mask;
1137 #endif  /* EFSYS_OPT_BIST */
1138 #if EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD
1139         uint32_t                enc_pf;
1140         uint32_t                enc_vf;
1141         uint32_t                enc_privilege_mask;
1142 #endif /* EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD */
1143         boolean_t               enc_bug26807_workaround;
1144         boolean_t               enc_bug35388_workaround;
1145         boolean_t               enc_bug41750_workaround;
1146         boolean_t               enc_bug61265_workaround;
1147         boolean_t               enc_rx_batching_enabled;
1148         /* Maximum number of descriptors completed in an rx event. */
1149         uint32_t                enc_rx_batch_max;
1150         /* Number of rx descriptors the hardware requires for a push. */
1151         uint32_t                enc_rx_push_align;
1152         /*
1153          * Maximum number of bytes into the packet the TCP header can start for
1154          * the hardware to apply TSO packet edits.
1155          */
1156         uint32_t                enc_tx_tso_tcp_header_offset_limit;
1157         boolean_t               enc_fw_assisted_tso_enabled;
1158         boolean_t               enc_fw_assisted_tso_v2_enabled;
1159         /* Number of TSO contexts on the NIC (FATSOv2) */
1160         uint32_t                enc_fw_assisted_tso_v2_n_contexts;
1161         boolean_t               enc_hw_tx_insert_vlan_enabled;
1162         /* Number of PFs on the NIC */
1163         uint32_t                enc_hw_pf_count;
1164         /* Datapath firmware vadapter/vport/vswitch support */
1165         boolean_t               enc_datapath_cap_evb;
1166         boolean_t               enc_rx_disable_scatter_supported;
1167         boolean_t               enc_allow_set_mac_with_installed_filters;
1168         boolean_t               enc_enhanced_set_mac_supported;
1169         boolean_t               enc_init_evq_v2_supported;
1170         boolean_t               enc_pm_and_rxdp_counters;
1171         boolean_t               enc_mac_stats_40g_tx_size_bins;
1172         /* External port identifier */
1173         uint8_t                 enc_external_port;
1174         uint32_t                enc_mcdi_max_payload_length;
1175         /* VPD may be per-PF or global */
1176         boolean_t               enc_vpd_is_global;
1177         /* Minimum unidirectional bandwidth in Mb/s to max out all ports */
1178         uint32_t                enc_required_pcie_bandwidth_mbps;
1179         uint32_t                enc_max_pcie_link_gen;
1180 } efx_nic_cfg_t;
1181
1182 #define EFX_PCI_FUNCTION_IS_PF(_encp)   ((_encp)->enc_vf == 0xffff)
1183 #define EFX_PCI_FUNCTION_IS_VF(_encp)   ((_encp)->enc_vf != 0xffff)
1184
1185 #define EFX_PCI_FUNCTION(_encp) \
1186         (EFX_PCI_FUNCTION_IS_PF(_encp) ? (_encp)->enc_pf : (_encp)->enc_vf)
1187
1188 #define EFX_PCI_VF_PARENT(_encp)        ((_encp)->enc_pf)
1189
1190 extern                  const efx_nic_cfg_t *
1191 efx_nic_cfg_get(
1192         __in            efx_nic_t *enp);
1193
1194 /* Driver resource limits (minimum required/maximum usable). */
1195 typedef struct efx_drv_limits_s {
1196         uint32_t        edl_min_evq_count;
1197         uint32_t        edl_max_evq_count;
1198
1199         uint32_t        edl_min_rxq_count;
1200         uint32_t        edl_max_rxq_count;
1201
1202         uint32_t        edl_min_txq_count;
1203         uint32_t        edl_max_txq_count;
1204
1205         /* PIO blocks (sub-allocated from piobuf) */
1206         uint32_t        edl_min_pio_alloc_size;
1207         uint32_t        edl_max_pio_alloc_count;
1208 } efx_drv_limits_t;
1209
1210 extern  __checkReturn   efx_rc_t
1211 efx_nic_set_drv_limits(
1212         __inout         efx_nic_t *enp,
1213         __in            efx_drv_limits_t *edlp);
1214
1215 typedef enum efx_nic_region_e {
1216         EFX_REGION_VI,                  /* Memory BAR UC mapping */
1217         EFX_REGION_PIO_WRITE_VI,        /* Memory BAR WC mapping */
1218 } efx_nic_region_t;
1219
1220 extern  __checkReturn   efx_rc_t
1221 efx_nic_get_bar_region(
1222         __in            efx_nic_t *enp,
1223         __in            efx_nic_region_t region,
1224         __out           uint32_t *offsetp,
1225         __out           size_t *sizep);
1226
1227 extern  __checkReturn   efx_rc_t
1228 efx_nic_get_vi_pool(
1229         __in            efx_nic_t *enp,
1230         __out           uint32_t *evq_countp,
1231         __out           uint32_t *rxq_countp,
1232         __out           uint32_t *txq_countp);
1233
1234
1235 #if EFSYS_OPT_VPD
1236
1237 typedef enum efx_vpd_tag_e {
1238         EFX_VPD_ID = 0x02,
1239         EFX_VPD_END = 0x0f,
1240         EFX_VPD_RO = 0x10,
1241         EFX_VPD_RW = 0x11,
1242 } efx_vpd_tag_t;
1243
1244 typedef uint16_t efx_vpd_keyword_t;
1245
1246 typedef struct efx_vpd_value_s {
1247         efx_vpd_tag_t           evv_tag;
1248         efx_vpd_keyword_t       evv_keyword;
1249         uint8_t                 evv_length;
1250         uint8_t                 evv_value[0x100];
1251 } efx_vpd_value_t;
1252
1253
1254 #define EFX_VPD_KEYWORD(x, y) ((x) | ((y) << 8))
1255
1256 extern  __checkReturn           efx_rc_t
1257 efx_vpd_init(
1258         __in                    efx_nic_t *enp);
1259
1260 extern  __checkReturn           efx_rc_t
1261 efx_vpd_size(
1262         __in                    efx_nic_t *enp,
1263         __out                   size_t *sizep);
1264
1265 extern  __checkReturn           efx_rc_t
1266 efx_vpd_read(
1267         __in                    efx_nic_t *enp,
1268         __out_bcount(size)      caddr_t data,
1269         __in                    size_t size);
1270
1271 extern  __checkReturn           efx_rc_t
1272 efx_vpd_verify(
1273         __in                    efx_nic_t *enp,
1274         __in_bcount(size)       caddr_t data,
1275         __in                    size_t size);
1276
1277 extern  __checkReturn           efx_rc_t
1278 efx_vpd_reinit(
1279         __in                    efx_nic_t *enp,
1280         __in_bcount(size)       caddr_t data,
1281         __in                    size_t size);
1282
1283 extern  __checkReturn           efx_rc_t
1284 efx_vpd_get(
1285         __in                    efx_nic_t *enp,
1286         __in_bcount(size)       caddr_t data,
1287         __in                    size_t size,
1288         __inout                 efx_vpd_value_t *evvp);
1289
1290 extern  __checkReturn           efx_rc_t
1291 efx_vpd_set(
1292         __in                    efx_nic_t *enp,
1293         __inout_bcount(size)    caddr_t data,
1294         __in                    size_t size,
1295         __in                    efx_vpd_value_t *evvp);
1296
1297 extern  __checkReturn           efx_rc_t
1298 efx_vpd_next(
1299         __in                    efx_nic_t *enp,
1300         __inout_bcount(size)    caddr_t data,
1301         __in                    size_t size,
1302         __out                   efx_vpd_value_t *evvp,
1303         __inout                 unsigned int *contp);
1304
1305 extern  __checkReturn           efx_rc_t
1306 efx_vpd_write(
1307         __in                    efx_nic_t *enp,
1308         __in_bcount(size)       caddr_t data,
1309         __in                    size_t size);
1310
1311 extern                          void
1312 efx_vpd_fini(
1313         __in                    efx_nic_t *enp);
1314
1315 #endif  /* EFSYS_OPT_VPD */
1316
1317 /* NVRAM */
1318
1319 #if EFSYS_OPT_NVRAM
1320
1321 typedef enum efx_nvram_type_e {
1322         EFX_NVRAM_INVALID = 0,
1323         EFX_NVRAM_BOOTROM,
1324         EFX_NVRAM_BOOTROM_CFG,
1325         EFX_NVRAM_MC_FIRMWARE,
1326         EFX_NVRAM_MC_GOLDEN,
1327         EFX_NVRAM_PHY,
1328         EFX_NVRAM_NULLPHY,
1329         EFX_NVRAM_FPGA,
1330         EFX_NVRAM_FCFW,
1331         EFX_NVRAM_CPLD,
1332         EFX_NVRAM_FPGA_BACKUP,
1333         EFX_NVRAM_DYNAMIC_CFG,
1334         EFX_NVRAM_LICENSE,
1335         EFX_NVRAM_UEFIROM,
1336         EFX_NVRAM_NTYPES,
1337 } efx_nvram_type_t;
1338
1339 extern  __checkReturn           efx_rc_t
1340 efx_nvram_init(
1341         __in                    efx_nic_t *enp);
1342
1343 #if EFSYS_OPT_DIAG
1344
1345 extern  __checkReturn           efx_rc_t
1346 efx_nvram_test(
1347         __in                    efx_nic_t *enp);
1348
1349 #endif  /* EFSYS_OPT_DIAG */
1350
1351 extern  __checkReturn           efx_rc_t
1352 efx_nvram_size(
1353         __in                    efx_nic_t *enp,
1354         __in                    efx_nvram_type_t type,
1355         __out                   size_t *sizep);
1356
1357 extern  __checkReturn           efx_rc_t
1358 efx_nvram_rw_start(
1359         __in                    efx_nic_t *enp,
1360         __in                    efx_nvram_type_t type,
1361         __out_opt               size_t *pref_chunkp);
1362
1363 extern                          void
1364 efx_nvram_rw_finish(
1365         __in                    efx_nic_t *enp,
1366         __in                    efx_nvram_type_t type);
1367
1368 extern  __checkReturn           efx_rc_t
1369 efx_nvram_get_version(
1370         __in                    efx_nic_t *enp,
1371         __in                    efx_nvram_type_t type,
1372         __out                   uint32_t *subtypep,
1373         __out_ecount(4)         uint16_t version[4]);
1374
1375 extern  __checkReturn           efx_rc_t
1376 efx_nvram_read_chunk(
1377         __in                    efx_nic_t *enp,
1378         __in                    efx_nvram_type_t type,
1379         __in                    unsigned int offset,
1380         __out_bcount(size)      caddr_t data,
1381         __in                    size_t size);
1382
1383 extern  __checkReturn           efx_rc_t
1384 efx_nvram_set_version(
1385         __in                    efx_nic_t *enp,
1386         __in                    efx_nvram_type_t type,
1387         __in_ecount(4)          uint16_t version[4]);
1388
1389 extern  __checkReturn           efx_rc_t
1390 efx_nvram_validate(
1391         __in                    efx_nic_t *enp,
1392         __in                    efx_nvram_type_t type,
1393         __in_bcount(partn_size) caddr_t partn_data,
1394         __in                    size_t partn_size);
1395
1396 extern   __checkReturn          efx_rc_t
1397 efx_nvram_erase(
1398         __in                    efx_nic_t *enp,
1399         __in                    efx_nvram_type_t type);
1400
1401 extern  __checkReturn           efx_rc_t
1402 efx_nvram_write_chunk(
1403         __in                    efx_nic_t *enp,
1404         __in                    efx_nvram_type_t type,
1405         __in                    unsigned int offset,
1406         __in_bcount(size)       caddr_t data,
1407         __in                    size_t size);
1408
1409 extern                          void
1410 efx_nvram_fini(
1411         __in                    efx_nic_t *enp);
1412
1413 #endif  /* EFSYS_OPT_NVRAM */
1414
1415 #if EFSYS_OPT_BOOTCFG
1416
1417 extern                          efx_rc_t
1418 efx_bootcfg_read(
1419         __in                    efx_nic_t *enp,
1420         __out_bcount(size)      caddr_t data,
1421         __in                    size_t size);
1422
1423 extern                          efx_rc_t
1424 efx_bootcfg_write(
1425         __in                    efx_nic_t *enp,
1426         __in_bcount(size)       caddr_t data,
1427         __in                    size_t size);
1428
1429 #endif  /* EFSYS_OPT_BOOTCFG */
1430
1431 #if EFSYS_OPT_WOL
1432
1433 typedef enum efx_wol_type_e {
1434         EFX_WOL_TYPE_INVALID,
1435         EFX_WOL_TYPE_MAGIC,
1436         EFX_WOL_TYPE_BITMAP,
1437         EFX_WOL_TYPE_LINK,
1438         EFX_WOL_NTYPES,
1439 } efx_wol_type_t;
1440
1441 typedef enum efx_lightsout_offload_type_e {
1442         EFX_LIGHTSOUT_OFFLOAD_TYPE_INVALID,
1443         EFX_LIGHTSOUT_OFFLOAD_TYPE_ARP,
1444         EFX_LIGHTSOUT_OFFLOAD_TYPE_NS,
1445 } efx_lightsout_offload_type_t;
1446
1447 #define EFX_WOL_BITMAP_MASK_SIZE    (48)
1448 #define EFX_WOL_BITMAP_VALUE_SIZE   (128)
1449
1450 typedef union efx_wol_param_u {
1451         struct {
1452                 uint8_t mac_addr[6];
1453         } ewp_magic;
1454         struct {
1455                 uint8_t mask[EFX_WOL_BITMAP_MASK_SIZE];   /* 1 bit per byte */
1456                 uint8_t value[EFX_WOL_BITMAP_VALUE_SIZE]; /* value to match */
1457                 uint8_t value_len;
1458         } ewp_bitmap;
1459 } efx_wol_param_t;
1460
1461 typedef union efx_lightsout_offload_param_u {
1462         struct {
1463                 uint8_t mac_addr[6];
1464                 uint32_t ip;
1465         } elop_arp;
1466         struct {
1467                 uint8_t mac_addr[6];
1468                 uint32_t solicited_node[4];
1469                 uint32_t ip[4];
1470         } elop_ns;
1471 } efx_lightsout_offload_param_t;
1472
1473 extern  __checkReturn   efx_rc_t
1474 efx_wol_init(
1475         __in            efx_nic_t *enp);
1476
1477 extern  __checkReturn   efx_rc_t
1478 efx_wol_filter_clear(
1479         __in            efx_nic_t *enp);
1480
1481 extern  __checkReturn   efx_rc_t
1482 efx_wol_filter_add(
1483         __in            efx_nic_t *enp,
1484         __in            efx_wol_type_t type,
1485         __in            efx_wol_param_t *paramp,
1486         __out           uint32_t *filter_idp);
1487
1488 extern  __checkReturn   efx_rc_t
1489 efx_wol_filter_remove(
1490         __in            efx_nic_t *enp,
1491         __in            uint32_t filter_id);
1492
1493 extern  __checkReturn   efx_rc_t
1494 efx_lightsout_offload_add(
1495         __in            efx_nic_t *enp,
1496         __in            efx_lightsout_offload_type_t type,
1497         __in            efx_lightsout_offload_param_t *paramp,
1498         __out           uint32_t *filter_idp);
1499
1500 extern  __checkReturn   efx_rc_t
1501 efx_lightsout_offload_remove(
1502         __in            efx_nic_t *enp,
1503         __in            efx_lightsout_offload_type_t type,
1504         __in            uint32_t filter_id);
1505
1506 extern                  void
1507 efx_wol_fini(
1508         __in            efx_nic_t *enp);
1509
1510 #endif  /* EFSYS_OPT_WOL */
1511
1512 #if EFSYS_OPT_DIAG
1513
1514 typedef enum efx_pattern_type_t {
1515         EFX_PATTERN_BYTE_INCREMENT = 0,
1516         EFX_PATTERN_ALL_THE_SAME,
1517         EFX_PATTERN_BIT_ALTERNATE,
1518         EFX_PATTERN_BYTE_ALTERNATE,
1519         EFX_PATTERN_BYTE_CHANGING,
1520         EFX_PATTERN_BIT_SWEEP,
1521         EFX_PATTERN_NTYPES
1522 } efx_pattern_type_t;
1523
1524 typedef                 void
1525 (*efx_sram_pattern_fn_t)(
1526         __in            size_t row,
1527         __in            boolean_t negate,
1528         __out           efx_qword_t *eqp);
1529
1530 extern  __checkReturn   efx_rc_t
1531 efx_sram_test(
1532         __in            efx_nic_t *enp,
1533         __in            efx_pattern_type_t type);
1534
1535 #endif  /* EFSYS_OPT_DIAG */
1536
1537 extern  __checkReturn   efx_rc_t
1538 efx_sram_buf_tbl_set(
1539         __in            efx_nic_t *enp,
1540         __in            uint32_t id,
1541         __in            efsys_mem_t *esmp,
1542         __in            size_t n);
1543
1544 extern          void
1545 efx_sram_buf_tbl_clear(
1546         __in    efx_nic_t *enp,
1547         __in    uint32_t id,
1548         __in    size_t n);
1549
1550 #define EFX_BUF_TBL_SIZE        0x20000
1551
1552 #define EFX_BUF_SIZE            4096
1553
1554 /* EV */
1555
1556 typedef struct efx_evq_s        efx_evq_t;
1557
1558 #if EFSYS_OPT_QSTATS
1559
1560 /* START MKCONFIG GENERATED EfxHeaderEventQueueBlock 6f3843f5fe7cc843 */
1561 typedef enum efx_ev_qstat_e {
1562         EV_ALL,
1563         EV_RX,
1564         EV_RX_OK,
1565         EV_RX_FRM_TRUNC,
1566         EV_RX_TOBE_DISC,
1567         EV_RX_PAUSE_FRM_ERR,
1568         EV_RX_BUF_OWNER_ID_ERR,
1569         EV_RX_IPV4_HDR_CHKSUM_ERR,
1570         EV_RX_TCP_UDP_CHKSUM_ERR,
1571         EV_RX_ETH_CRC_ERR,
1572         EV_RX_IP_FRAG_ERR,
1573         EV_RX_MCAST_PKT,
1574         EV_RX_MCAST_HASH_MATCH,
1575         EV_RX_TCP_IPV4,
1576         EV_RX_TCP_IPV6,
1577         EV_RX_UDP_IPV4,
1578         EV_RX_UDP_IPV6,
1579         EV_RX_OTHER_IPV4,
1580         EV_RX_OTHER_IPV6,
1581         EV_RX_NON_IP,
1582         EV_RX_BATCH,
1583         EV_TX,
1584         EV_TX_WQ_FF_FULL,
1585         EV_TX_PKT_ERR,
1586         EV_TX_PKT_TOO_BIG,
1587         EV_TX_UNEXPECTED,
1588         EV_GLOBAL,
1589         EV_GLOBAL_MNT,
1590         EV_DRIVER,
1591         EV_DRIVER_SRM_UPD_DONE,
1592         EV_DRIVER_TX_DESCQ_FLS_DONE,
1593         EV_DRIVER_RX_DESCQ_FLS_DONE,
1594         EV_DRIVER_RX_DESCQ_FLS_FAILED,
1595         EV_DRIVER_RX_DSC_ERROR,
1596         EV_DRIVER_TX_DSC_ERROR,
1597         EV_DRV_GEN,
1598         EV_MCDI_RESPONSE,
1599         EV_NQSTATS
1600 } efx_ev_qstat_t;
1601
1602 /* END MKCONFIG GENERATED EfxHeaderEventQueueBlock */
1603
1604 #endif  /* EFSYS_OPT_QSTATS */
1605
1606 extern  __checkReturn   efx_rc_t
1607 efx_ev_init(
1608         __in            efx_nic_t *enp);
1609
1610 extern          void
1611 efx_ev_fini(
1612         __in            efx_nic_t *enp);
1613
1614 #define EFX_EVQ_MAXNEVS         32768
1615 #define EFX_EVQ_MINNEVS         512
1616
1617 #define EFX_EVQ_SIZE(_nevs)     ((_nevs) * sizeof (efx_qword_t))
1618 #define EFX_EVQ_NBUFS(_nevs)    (EFX_EVQ_SIZE(_nevs) / EFX_BUF_SIZE)
1619
1620 #define EFX_EVQ_FLAGS_TYPE_MASK         (0x3)
1621 #define EFX_EVQ_FLAGS_TYPE_AUTO         (0x0)
1622 #define EFX_EVQ_FLAGS_TYPE_THROUGHPUT   (0x1)
1623 #define EFX_EVQ_FLAGS_TYPE_LOW_LATENCY  (0x2)
1624
1625 #define EFX_EVQ_FLAGS_NOTIFY_MASK       (0xC)
1626 #define EFX_EVQ_FLAGS_NOTIFY_INTERRUPT  (0x0)   /* Interrupting (default) */
1627 #define EFX_EVQ_FLAGS_NOTIFY_DISABLED   (0x4)   /* Non-interrupting */
1628
1629 extern  __checkReturn   efx_rc_t
1630 efx_ev_qcreate(
1631         __in            efx_nic_t *enp,
1632         __in            unsigned int index,
1633         __in            efsys_mem_t *esmp,
1634         __in            size_t n,
1635         __in            uint32_t id,
1636         __in            uint32_t us,
1637         __in            uint32_t flags,
1638         __deref_out     efx_evq_t **eepp);
1639
1640 extern          void
1641 efx_ev_qpost(
1642         __in            efx_evq_t *eep,
1643         __in            uint16_t data);
1644
1645 typedef __checkReturn   boolean_t
1646 (*efx_initialized_ev_t)(
1647         __in_opt        void *arg);
1648
1649 #define EFX_PKT_UNICAST         0x0004
1650 #define EFX_PKT_START           0x0008
1651
1652 #define EFX_PKT_VLAN_TAGGED     0x0010
1653 #define EFX_CKSUM_TCPUDP        0x0020
1654 #define EFX_CKSUM_IPV4          0x0040
1655 #define EFX_PKT_CONT            0x0080
1656
1657 #define EFX_CHECK_VLAN          0x0100
1658 #define EFX_PKT_TCP             0x0200
1659 #define EFX_PKT_UDP             0x0400
1660 #define EFX_PKT_IPV4            0x0800
1661
1662 #define EFX_PKT_IPV6            0x1000
1663 #define EFX_PKT_PREFIX_LEN      0x2000
1664 #define EFX_ADDR_MISMATCH       0x4000
1665 #define EFX_DISCARD             0x8000
1666
1667 #define EFX_EV_RX_NLABELS       32
1668 #define EFX_EV_TX_NLABELS       32
1669
1670 typedef __checkReturn   boolean_t
1671 (*efx_rx_ev_t)(
1672         __in_opt        void *arg,
1673         __in            uint32_t label,
1674         __in            uint32_t id,
1675         __in            uint32_t size,
1676         __in            uint16_t flags);
1677
1678 typedef __checkReturn   boolean_t
1679 (*efx_tx_ev_t)(
1680         __in_opt        void *arg,
1681         __in            uint32_t label,
1682         __in            uint32_t id);
1683
1684 #define EFX_EXCEPTION_RX_RECOVERY       0x00000001
1685 #define EFX_EXCEPTION_RX_DSC_ERROR      0x00000002
1686 #define EFX_EXCEPTION_TX_DSC_ERROR      0x00000003
1687 #define EFX_EXCEPTION_UNKNOWN_SENSOREVT 0x00000004
1688 #define EFX_EXCEPTION_FWALERT_SRAM      0x00000005
1689 #define EFX_EXCEPTION_UNKNOWN_FWALERT   0x00000006
1690 #define EFX_EXCEPTION_RX_ERROR          0x00000007
1691 #define EFX_EXCEPTION_TX_ERROR          0x00000008
1692 #define EFX_EXCEPTION_EV_ERROR          0x00000009
1693
1694 typedef __checkReturn   boolean_t
1695 (*efx_exception_ev_t)(
1696         __in_opt        void *arg,
1697         __in            uint32_t label,
1698         __in            uint32_t data);
1699
1700 typedef __checkReturn   boolean_t
1701 (*efx_rxq_flush_done_ev_t)(
1702         __in_opt        void *arg,
1703         __in            uint32_t rxq_index);
1704
1705 typedef __checkReturn   boolean_t
1706 (*efx_rxq_flush_failed_ev_t)(
1707         __in_opt        void *arg,
1708         __in            uint32_t rxq_index);
1709
1710 typedef __checkReturn   boolean_t
1711 (*efx_txq_flush_done_ev_t)(
1712         __in_opt        void *arg,
1713         __in            uint32_t txq_index);
1714
1715 typedef __checkReturn   boolean_t
1716 (*efx_software_ev_t)(
1717         __in_opt        void *arg,
1718         __in            uint16_t magic);
1719
1720 typedef __checkReturn   boolean_t
1721 (*efx_sram_ev_t)(
1722         __in_opt        void *arg,
1723         __in            uint32_t code);
1724
1725 #define EFX_SRAM_CLEAR          0
1726 #define EFX_SRAM_UPDATE         1
1727 #define EFX_SRAM_ILLEGAL_CLEAR  2
1728
1729 typedef __checkReturn   boolean_t
1730 (*efx_wake_up_ev_t)(
1731         __in_opt        void *arg,
1732         __in            uint32_t label);
1733
1734 typedef __checkReturn   boolean_t
1735 (*efx_timer_ev_t)(
1736         __in_opt        void *arg,
1737         __in            uint32_t label);
1738
1739 typedef __checkReturn   boolean_t
1740 (*efx_link_change_ev_t)(
1741         __in_opt        void *arg,
1742         __in            efx_link_mode_t link_mode);
1743
1744 #if EFSYS_OPT_MON_STATS
1745
1746 typedef __checkReturn   boolean_t
1747 (*efx_monitor_ev_t)(
1748         __in_opt        void *arg,
1749         __in            efx_mon_stat_t id,
1750         __in            efx_mon_stat_value_t value);
1751
1752 #endif  /* EFSYS_OPT_MON_STATS */
1753
1754 #if EFSYS_OPT_MAC_STATS
1755
1756 typedef __checkReturn   boolean_t
1757 (*efx_mac_stats_ev_t)(
1758         __in_opt        void *arg,
1759         __in            uint32_t generation
1760         );
1761
1762 #endif  /* EFSYS_OPT_MAC_STATS */
1763
1764 typedef struct efx_ev_callbacks_s {
1765         efx_initialized_ev_t            eec_initialized;
1766         efx_rx_ev_t                     eec_rx;
1767         efx_tx_ev_t                     eec_tx;
1768         efx_exception_ev_t              eec_exception;
1769         efx_rxq_flush_done_ev_t         eec_rxq_flush_done;
1770         efx_rxq_flush_failed_ev_t       eec_rxq_flush_failed;
1771         efx_txq_flush_done_ev_t         eec_txq_flush_done;
1772         efx_software_ev_t               eec_software;
1773         efx_sram_ev_t                   eec_sram;
1774         efx_wake_up_ev_t                eec_wake_up;
1775         efx_timer_ev_t                  eec_timer;
1776         efx_link_change_ev_t            eec_link_change;
1777 #if EFSYS_OPT_MON_STATS
1778         efx_monitor_ev_t                eec_monitor;
1779 #endif  /* EFSYS_OPT_MON_STATS */
1780 #if EFSYS_OPT_MAC_STATS
1781         efx_mac_stats_ev_t              eec_mac_stats;
1782 #endif  /* EFSYS_OPT_MAC_STATS */
1783 } efx_ev_callbacks_t;
1784
1785 extern  __checkReturn   boolean_t
1786 efx_ev_qpending(
1787         __in            efx_evq_t *eep,
1788         __in            unsigned int count);
1789
1790 #if EFSYS_OPT_EV_PREFETCH
1791
1792 extern                  void
1793 efx_ev_qprefetch(
1794         __in            efx_evq_t *eep,
1795         __in            unsigned int count);
1796
1797 #endif  /* EFSYS_OPT_EV_PREFETCH */
1798
1799 extern                  void
1800 efx_ev_qpoll(
1801         __in            efx_evq_t *eep,
1802         __inout         unsigned int *countp,
1803         __in            const efx_ev_callbacks_t *eecp,
1804         __in_opt        void *arg);
1805
1806 extern  __checkReturn   efx_rc_t
1807 efx_ev_usecs_to_ticks(
1808         __in            efx_nic_t *enp,
1809         __in            unsigned int usecs,
1810         __out           unsigned int *ticksp);
1811
1812 extern  __checkReturn   efx_rc_t
1813 efx_ev_qmoderate(
1814         __in            efx_evq_t *eep,
1815         __in            unsigned int us);
1816
1817 extern  __checkReturn   efx_rc_t
1818 efx_ev_qprime(
1819         __in            efx_evq_t *eep,
1820         __in            unsigned int count);
1821
1822 #if EFSYS_OPT_QSTATS
1823
1824 #if EFSYS_OPT_NAMES
1825
1826 extern          const char *
1827 efx_ev_qstat_name(
1828         __in    efx_nic_t *enp,
1829         __in    unsigned int id);
1830
1831 #endif  /* EFSYS_OPT_NAMES */
1832
1833 extern                                  void
1834 efx_ev_qstats_update(
1835         __in                            efx_evq_t *eep,
1836         __inout_ecount(EV_NQSTATS)      efsys_stat_t *stat);
1837
1838 #endif  /* EFSYS_OPT_QSTATS */
1839
1840 extern          void
1841 efx_ev_qdestroy(
1842         __in    efx_evq_t *eep);
1843
1844 /* RX */
1845
1846 extern  __checkReturn   efx_rc_t
1847 efx_rx_init(
1848         __inout         efx_nic_t *enp);
1849
1850 extern          void
1851 efx_rx_fini(
1852         __in            efx_nic_t *enp);
1853
1854 #if EFSYS_OPT_RX_SCATTER
1855         __checkReturn   efx_rc_t
1856 efx_rx_scatter_enable(
1857         __in            efx_nic_t *enp,
1858         __in            unsigned int buf_size);
1859 #endif  /* EFSYS_OPT_RX_SCATTER */
1860
1861 #if EFSYS_OPT_RX_SCALE
1862
1863 typedef enum efx_rx_hash_alg_e {
1864         EFX_RX_HASHALG_LFSR = 0,
1865         EFX_RX_HASHALG_TOEPLITZ
1866 } efx_rx_hash_alg_t;
1867
1868 #define EFX_RX_HASH_IPV4        (1U << 0)
1869 #define EFX_RX_HASH_TCPIPV4     (1U << 1)
1870 #define EFX_RX_HASH_IPV6        (1U << 2)
1871 #define EFX_RX_HASH_TCPIPV6     (1U << 3)
1872
1873 typedef unsigned int efx_rx_hash_type_t;
1874
1875 typedef enum efx_rx_hash_support_e {
1876         EFX_RX_HASH_UNAVAILABLE = 0,    /* Hardware hash not inserted */
1877         EFX_RX_HASH_AVAILABLE           /* Insert hash with/without RSS */
1878 } efx_rx_hash_support_t;
1879
1880 #define EFX_RSS_TBL_SIZE        128     /* Rows in RX indirection table */
1881 #define EFX_MAXRSS              64      /* RX indirection entry range */
1882 #define EFX_MAXRSS_LEGACY       16      /* See bug16611 and bug17213 */
1883
1884 typedef enum efx_rx_scale_support_e {
1885         EFX_RX_SCALE_UNAVAILABLE = 0,   /* Not supported */
1886         EFX_RX_SCALE_EXCLUSIVE,         /* Writable key/indirection table */
1887         EFX_RX_SCALE_SHARED             /* Read-only key/indirection table */
1888 } efx_rx_scale_support_t;
1889
1890 extern  __checkReturn   efx_rc_t
1891 efx_rx_hash_support_get(
1892         __in            efx_nic_t *enp,
1893         __out           efx_rx_hash_support_t *supportp);
1894
1895
1896 extern  __checkReturn   efx_rc_t
1897 efx_rx_scale_support_get(
1898         __in            efx_nic_t *enp,
1899         __out           efx_rx_scale_support_t *supportp);
1900
1901 extern  __checkReturn   efx_rc_t
1902 efx_rx_scale_mode_set(
1903         __in    efx_nic_t *enp,
1904         __in    efx_rx_hash_alg_t alg,
1905         __in    efx_rx_hash_type_t type,
1906         __in    boolean_t insert);
1907
1908 extern  __checkReturn   efx_rc_t
1909 efx_rx_scale_tbl_set(
1910         __in            efx_nic_t *enp,
1911         __in_ecount(n)  unsigned int *table,
1912         __in            size_t n);
1913
1914 extern  __checkReturn   efx_rc_t
1915 efx_rx_scale_key_set(
1916         __in            efx_nic_t *enp,
1917         __in_ecount(n)  uint8_t *key,
1918         __in            size_t n);
1919
1920 extern  __checkReturn   uint32_t
1921 efx_pseudo_hdr_hash_get(
1922         __in            efx_rxq_t *erp,
1923         __in            efx_rx_hash_alg_t func,
1924         __in            uint8_t *buffer);
1925
1926 #endif  /* EFSYS_OPT_RX_SCALE */
1927
1928 extern  __checkReturn   efx_rc_t
1929 efx_pseudo_hdr_pkt_length_get(
1930         __in            efx_rxq_t *erp,
1931         __in            uint8_t *buffer,
1932         __out           uint16_t *pkt_lengthp);
1933
1934 #define EFX_RXQ_MAXNDESCS               4096
1935 #define EFX_RXQ_MINNDESCS               512
1936
1937 #define EFX_RXQ_SIZE(_ndescs)           ((_ndescs) * sizeof (efx_qword_t))
1938 #define EFX_RXQ_NBUFS(_ndescs)          (EFX_RXQ_SIZE(_ndescs) / EFX_BUF_SIZE)
1939 #define EFX_RXQ_LIMIT(_ndescs)          ((_ndescs) - 16)
1940 #define EFX_RXQ_DC_NDESCS(_dcsize)      (8 << _dcsize)
1941
1942 typedef enum efx_rxq_type_e {
1943         EFX_RXQ_TYPE_DEFAULT,
1944         EFX_RXQ_TYPE_SCATTER,
1945         EFX_RXQ_NTYPES
1946 } efx_rxq_type_t;
1947
1948 extern  __checkReturn   efx_rc_t
1949 efx_rx_qcreate(
1950         __in            efx_nic_t *enp,
1951         __in            unsigned int index,
1952         __in            unsigned int label,
1953         __in            efx_rxq_type_t type,
1954         __in            efsys_mem_t *esmp,
1955         __in            size_t n,
1956         __in            uint32_t id,
1957         __in            efx_evq_t *eep,
1958         __deref_out     efx_rxq_t **erpp);
1959
1960 typedef struct efx_buffer_s {
1961         efsys_dma_addr_t        eb_addr;
1962         size_t                  eb_size;
1963         boolean_t               eb_eop;
1964 } efx_buffer_t;
1965
1966 typedef struct efx_desc_s {
1967         efx_qword_t ed_eq;
1968 } efx_desc_t;
1969
1970 extern                  void
1971 efx_rx_qpost(
1972         __in            efx_rxq_t *erp,
1973         __in_ecount(n)  efsys_dma_addr_t *addrp,
1974         __in            size_t size,
1975         __in            unsigned int n,
1976         __in            unsigned int completed,
1977         __in            unsigned int added);
1978
1979 extern          void
1980 efx_rx_qpush(
1981         __in    efx_rxq_t *erp,
1982         __in    unsigned int added,
1983         __inout unsigned int *pushedp);
1984
1985 extern  __checkReturn   efx_rc_t
1986 efx_rx_qflush(
1987         __in    efx_rxq_t *erp);
1988
1989 extern          void
1990 efx_rx_qenable(
1991         __in    efx_rxq_t *erp);
1992
1993 extern          void
1994 efx_rx_qdestroy(
1995         __in    efx_rxq_t *erp);
1996
1997 /* TX */
1998
1999 typedef struct efx_txq_s        efx_txq_t;
2000
2001 #if EFSYS_OPT_QSTATS
2002
2003 /* START MKCONFIG GENERATED EfxHeaderTransmitQueueBlock 12dff8778598b2db */
2004 typedef enum efx_tx_qstat_e {
2005         TX_POST,
2006         TX_POST_PIO,
2007         TX_NQSTATS
2008 } efx_tx_qstat_t;
2009
2010 /* END MKCONFIG GENERATED EfxHeaderTransmitQueueBlock */
2011
2012 #endif  /* EFSYS_OPT_QSTATS */
2013
2014 extern  __checkReturn   efx_rc_t
2015 efx_tx_init(
2016         __in            efx_nic_t *enp);
2017
2018 extern          void
2019 efx_tx_fini(
2020         __in    efx_nic_t *enp);
2021
2022 #define EFX_BUG35388_WORKAROUND(_encp)                                  \
2023         (((_encp) == NULL) ? 1 : ((_encp)->enc_bug35388_workaround != 0))
2024
2025 #define EFX_TXQ_MAXNDESCS(_encp)                                        \
2026         ((EFX_BUG35388_WORKAROUND(_encp)) ? 2048 : 4096)
2027
2028 #define EFX_TXQ_MINNDESCS               512
2029
2030 #define EFX_TXQ_SIZE(_ndescs)           ((_ndescs) * sizeof (efx_qword_t))
2031 #define EFX_TXQ_NBUFS(_ndescs)          (EFX_TXQ_SIZE(_ndescs) / EFX_BUF_SIZE)
2032 #define EFX_TXQ_LIMIT(_ndescs)          ((_ndescs) - 16)
2033 #define EFX_TXQ_DC_NDESCS(_dcsize)      (8 << _dcsize)
2034
2035 #define EFX_TXQ_MAX_BUFS 8 /* Maximum independent of EFX_BUG35388_WORKAROUND. */
2036
2037 #define EFX_TXQ_CKSUM_IPV4      0x0001
2038 #define EFX_TXQ_CKSUM_TCPUDP    0x0002
2039 #define EFX_TXQ_FATSOV2         0x0004
2040
2041 extern  __checkReturn   efx_rc_t
2042 efx_tx_qcreate(
2043         __in            efx_nic_t *enp,
2044         __in            unsigned int index,
2045         __in            unsigned int label,
2046         __in            efsys_mem_t *esmp,
2047         __in            size_t n,
2048         __in            uint32_t id,
2049         __in            uint16_t flags,
2050         __in            efx_evq_t *eep,
2051         __deref_out     efx_txq_t **etpp,
2052         __out           unsigned int *addedp);
2053
2054 extern  __checkReturn   efx_rc_t
2055 efx_tx_qpost(
2056         __in            efx_txq_t *etp,
2057         __in_ecount(n)  efx_buffer_t *eb,
2058         __in            unsigned int n,
2059         __in            unsigned int completed,
2060         __inout         unsigned int *addedp);
2061
2062 extern  __checkReturn   efx_rc_t
2063 efx_tx_qpace(
2064         __in            efx_txq_t *etp,
2065         __in            unsigned int ns);
2066
2067 extern                  void
2068 efx_tx_qpush(
2069         __in            efx_txq_t *etp,
2070         __in            unsigned int added,
2071         __in            unsigned int pushed);
2072
2073 extern  __checkReturn   efx_rc_t
2074 efx_tx_qflush(
2075         __in            efx_txq_t *etp);
2076
2077 extern                  void
2078 efx_tx_qenable(
2079         __in            efx_txq_t *etp);
2080
2081 extern  __checkReturn   efx_rc_t
2082 efx_tx_qpio_enable(
2083         __in            efx_txq_t *etp);
2084
2085 extern                  void
2086 efx_tx_qpio_disable(
2087         __in            efx_txq_t *etp);
2088
2089 extern  __checkReturn   efx_rc_t
2090 efx_tx_qpio_write(
2091         __in                    efx_txq_t *etp,
2092         __in_ecount(buf_length) uint8_t *buffer,
2093         __in                    size_t buf_length,
2094         __in                    size_t pio_buf_offset);
2095
2096 extern  __checkReturn   efx_rc_t
2097 efx_tx_qpio_post(
2098         __in                    efx_txq_t *etp,
2099         __in                    size_t pkt_length,
2100         __in                    unsigned int completed,
2101         __inout                 unsigned int *addedp);
2102
2103 extern  __checkReturn   efx_rc_t
2104 efx_tx_qdesc_post(
2105         __in            efx_txq_t *etp,
2106         __in_ecount(n)  efx_desc_t *ed,
2107         __in            unsigned int n,
2108         __in            unsigned int completed,
2109         __inout         unsigned int *addedp);
2110
2111 extern  void
2112 efx_tx_qdesc_dma_create(
2113         __in    efx_txq_t *etp,
2114         __in    efsys_dma_addr_t addr,
2115         __in    size_t size,
2116         __in    boolean_t eop,
2117         __out   efx_desc_t *edp);
2118
2119 extern  void
2120 efx_tx_qdesc_tso_create(
2121         __in    efx_txq_t *etp,
2122         __in    uint16_t ipv4_id,
2123         __in    uint32_t tcp_seq,
2124         __in    uint8_t  tcp_flags,
2125         __out   efx_desc_t *edp);
2126
2127 /* Number of FATSOv2 option descriptors */
2128 #define EFX_TX_FATSOV2_OPT_NDESCS               2
2129
2130 /* Maximum number of DMA segments per TSO packet (not superframe) */
2131 #define EFX_TX_FATSOV2_DMA_SEGS_PER_PKT_MAX     24
2132
2133 extern  void
2134 efx_tx_qdesc_tso2_create(
2135         __in                    efx_txq_t *etp,
2136         __in                    uint16_t ipv4_id,
2137         __in                    uint32_t tcp_seq,
2138         __in                    uint16_t tcp_mss,
2139         __out_ecount(count)     efx_desc_t *edp,
2140         __in                    int count);
2141
2142 extern  void
2143 efx_tx_qdesc_vlantci_create(
2144         __in    efx_txq_t *etp,
2145         __in    uint16_t tci,
2146         __out   efx_desc_t *edp);
2147
2148 #if EFSYS_OPT_QSTATS
2149
2150 #if EFSYS_OPT_NAMES
2151
2152 extern          const char *
2153 efx_tx_qstat_name(
2154         __in    efx_nic_t *etp,
2155         __in    unsigned int id);
2156
2157 #endif  /* EFSYS_OPT_NAMES */
2158
2159 extern                                  void
2160 efx_tx_qstats_update(
2161         __in                            efx_txq_t *etp,
2162         __inout_ecount(TX_NQSTATS)      efsys_stat_t *stat);
2163
2164 #endif  /* EFSYS_OPT_QSTATS */
2165
2166 extern          void
2167 efx_tx_qdestroy(
2168         __in    efx_txq_t *etp);
2169
2170
2171 /* FILTER */
2172
2173 #if EFSYS_OPT_FILTER
2174
2175 #define EFX_ETHER_TYPE_IPV4 0x0800
2176 #define EFX_ETHER_TYPE_IPV6 0x86DD
2177
2178 #define EFX_IPPROTO_TCP 6
2179 #define EFX_IPPROTO_UDP 17
2180
2181 /* Use RSS to spread across multiple queues */
2182 #define EFX_FILTER_FLAG_RX_RSS          0x01
2183 /* Enable RX scatter */
2184 #define EFX_FILTER_FLAG_RX_SCATTER      0x02
2185 /*
2186  * Override an automatic filter (priority EFX_FILTER_PRI_AUTO).
2187  * May only be set by the filter implementation for each type.
2188  * A removal request will restore the automatic filter in its place.
2189  */
2190 #define EFX_FILTER_FLAG_RX_OVER_AUTO    0x04
2191 /* Filter is for RX */
2192 #define EFX_FILTER_FLAG_RX              0x08
2193 /* Filter is for TX */
2194 #define EFX_FILTER_FLAG_TX              0x10
2195
2196 typedef unsigned int efx_filter_flags_t;
2197
2198 typedef enum efx_filter_match_flags_e {
2199         EFX_FILTER_MATCH_REM_HOST = 0x0001,     /* Match by remote IP host
2200                                                  * address */
2201         EFX_FILTER_MATCH_LOC_HOST = 0x0002,     /* Match by local IP host
2202                                                  * address */
2203         EFX_FILTER_MATCH_REM_MAC = 0x0004,      /* Match by remote MAC address */
2204         EFX_FILTER_MATCH_REM_PORT = 0x0008,     /* Match by remote TCP/UDP port */
2205         EFX_FILTER_MATCH_LOC_MAC = 0x0010,      /* Match by remote TCP/UDP port */
2206         EFX_FILTER_MATCH_LOC_PORT = 0x0020,     /* Match by local TCP/UDP port */
2207         EFX_FILTER_MATCH_ETHER_TYPE = 0x0040,   /* Match by Ether-type */
2208         EFX_FILTER_MATCH_INNER_VID = 0x0080,    /* Match by inner VLAN ID */
2209         EFX_FILTER_MATCH_OUTER_VID = 0x0100,    /* Match by outer VLAN ID */
2210         EFX_FILTER_MATCH_IP_PROTO = 0x0200,     /* Match by IP transport
2211                                                  * protocol */
2212         /* Match otherwise-unmatched multicast and broadcast packets */
2213         EFX_FILTER_MATCH_UNKNOWN_MCAST_DST = 0x40000000,
2214         /* Match otherwise-unmatched unicast packets */
2215         EFX_FILTER_MATCH_UNKNOWN_UCAST_DST = 0x80000000,
2216 } efx_filter_match_flags_t;
2217
2218 typedef enum efx_filter_priority_s {
2219         EFX_FILTER_PRI_HINT = 0,        /* Performance hint */
2220         EFX_FILTER_PRI_AUTO,            /* Automatic filter based on device
2221                                          * address list or hardware
2222                                          * requirements. This may only be used
2223                                          * by the filter implementation for
2224                                          * each NIC type. */
2225         EFX_FILTER_PRI_MANUAL,          /* Manually configured filter */
2226         EFX_FILTER_PRI_REQUIRED,        /* Required for correct behaviour of the
2227                                          * client (e.g. SR-IOV, HyperV VMQ etc.)
2228                                          */
2229 } efx_filter_priority_t;
2230
2231 /*
2232  * FIXME: All these fields are assumed to be in little-endian byte order.
2233  * It may be better for some to be big-endian. See bug42804.
2234  */
2235
2236 typedef struct efx_filter_spec_s {
2237         uint32_t        efs_match_flags;
2238         uint32_t        efs_priority:2;
2239         uint32_t        efs_flags:6;
2240         uint32_t        efs_dmaq_id:12;
2241         uint32_t        efs_rss_context;
2242         uint16_t        efs_outer_vid;
2243         uint16_t        efs_inner_vid;
2244         uint8_t         efs_loc_mac[EFX_MAC_ADDR_LEN];
2245         uint8_t         efs_rem_mac[EFX_MAC_ADDR_LEN];
2246         uint16_t        efs_ether_type;
2247         uint8_t         efs_ip_proto;
2248         uint16_t        efs_loc_port;
2249         uint16_t        efs_rem_port;
2250         efx_oword_t     efs_rem_host;
2251         efx_oword_t     efs_loc_host;
2252 } efx_filter_spec_t;
2253
2254
2255 /* Default values for use in filter specifications */
2256 #define EFX_FILTER_SPEC_RSS_CONTEXT_DEFAULT     0xffffffff
2257 #define EFX_FILTER_SPEC_RX_DMAQ_ID_DROP         0xfff
2258 #define EFX_FILTER_SPEC_VID_UNSPEC              0xffff
2259
2260 extern  __checkReturn   efx_rc_t
2261 efx_filter_init(
2262         __in            efx_nic_t *enp);
2263
2264 extern                  void
2265 efx_filter_fini(
2266         __in            efx_nic_t *enp);
2267
2268 extern  __checkReturn   efx_rc_t
2269 efx_filter_insert(
2270         __in            efx_nic_t *enp,
2271         __inout         efx_filter_spec_t *spec);
2272
2273 extern  __checkReturn   efx_rc_t
2274 efx_filter_remove(
2275         __in            efx_nic_t *enp,
2276         __inout         efx_filter_spec_t *spec);
2277
2278 extern  __checkReturn   efx_rc_t
2279 efx_filter_restore(
2280         __in            efx_nic_t *enp);
2281
2282 extern  __checkReturn   efx_rc_t
2283 efx_filter_supported_filters(
2284         __in                            efx_nic_t *enp,
2285         __out_ecount(buffer_length)     uint32_t *buffer,
2286         __in                            size_t buffer_length,
2287         __out                           size_t *list_lengthp);
2288
2289 extern                  void
2290 efx_filter_spec_init_rx(
2291         __out           efx_filter_spec_t *spec,
2292         __in            efx_filter_priority_t priority,
2293         __in            efx_filter_flags_t flags,
2294         __in            efx_rxq_t *erp);
2295
2296 extern                  void
2297 efx_filter_spec_init_tx(
2298         __out           efx_filter_spec_t *spec,
2299         __in            efx_txq_t *etp);
2300
2301 extern  __checkReturn   efx_rc_t
2302 efx_filter_spec_set_ipv4_local(
2303         __inout         efx_filter_spec_t *spec,
2304         __in            uint8_t proto,
2305         __in            uint32_t host,
2306         __in            uint16_t port);
2307
2308 extern  __checkReturn   efx_rc_t
2309 efx_filter_spec_set_ipv4_full(
2310         __inout         efx_filter_spec_t *spec,
2311         __in            uint8_t proto,
2312         __in            uint32_t lhost,
2313         __in            uint16_t lport,
2314         __in            uint32_t rhost,
2315         __in            uint16_t rport);
2316
2317 extern  __checkReturn   efx_rc_t
2318 efx_filter_spec_set_eth_local(
2319         __inout         efx_filter_spec_t *spec,
2320         __in            uint16_t vid,
2321         __in            const uint8_t *addr);
2322
2323 extern  __checkReturn   efx_rc_t
2324 efx_filter_spec_set_uc_def(
2325         __inout         efx_filter_spec_t *spec);
2326
2327 extern  __checkReturn   efx_rc_t
2328 efx_filter_spec_set_mc_def(
2329         __inout         efx_filter_spec_t *spec);
2330
2331 #endif  /* EFSYS_OPT_FILTER */
2332
2333 /* HASH */
2334
2335 extern  __checkReturn           uint32_t
2336 efx_hash_dwords(
2337         __in_ecount(count)      uint32_t const *input,
2338         __in                    size_t count,
2339         __in                    uint32_t init);
2340
2341 extern  __checkReturn           uint32_t
2342 efx_hash_bytes(
2343         __in_ecount(length)     uint8_t const *input,
2344         __in                    size_t length,
2345         __in                    uint32_t init);
2346
2347 #if EFSYS_OPT_LICENSING
2348
2349 /* LICENSING */
2350
2351 typedef struct efx_key_stats_s {
2352         uint32_t        eks_valid;
2353         uint32_t        eks_invalid;
2354         uint32_t        eks_blacklisted;
2355         uint32_t        eks_unverifiable;
2356         uint32_t        eks_wrong_node;
2357         uint32_t        eks_licensed_apps_lo;
2358         uint32_t        eks_licensed_apps_hi;
2359         uint32_t        eks_licensed_features_lo;
2360         uint32_t        eks_licensed_features_hi;
2361 } efx_key_stats_t;
2362
2363 extern  __checkReturn           efx_rc_t
2364 efx_lic_init(
2365         __in                    efx_nic_t *enp);
2366
2367 extern                          void
2368 efx_lic_fini(
2369         __in                    efx_nic_t *enp);
2370
2371 extern  __checkReturn   boolean_t
2372 efx_lic_check_support(
2373         __in                    efx_nic_t *enp);
2374
2375 extern  __checkReturn   efx_rc_t
2376 efx_lic_update_licenses(
2377         __in            efx_nic_t *enp);
2378
2379 extern  __checkReturn   efx_rc_t
2380 efx_lic_get_key_stats(
2381         __in            efx_nic_t *enp,
2382         __out           efx_key_stats_t *ksp);
2383
2384 extern  __checkReturn   efx_rc_t
2385 efx_lic_app_state(
2386         __in            efx_nic_t *enp,
2387         __in            uint64_t app_id,
2388         __out           boolean_t *licensedp);
2389
2390 extern  __checkReturn   efx_rc_t
2391 efx_lic_get_id(
2392         __in            efx_nic_t *enp,
2393         __in            size_t buffer_size,
2394         __out           uint32_t *typep,
2395         __out           size_t *lengthp,
2396         __out_opt       uint8_t *bufferp);
2397
2398
2399 extern  __checkReturn           efx_rc_t
2400 efx_lic_find_start(
2401         __in                    efx_nic_t *enp,
2402         __in_bcount(buffer_size)
2403                                 caddr_t bufferp,
2404         __in                    size_t buffer_size,
2405         __out                   uint32_t *startp
2406         );
2407
2408 extern  __checkReturn           efx_rc_t
2409 efx_lic_find_end(
2410         __in                    efx_nic_t *enp,
2411         __in_bcount(buffer_size)
2412                                 caddr_t bufferp,
2413         __in                    size_t buffer_size,
2414         __in                    uint32_t offset,
2415         __out                   uint32_t *endp
2416         );
2417
2418 extern  __checkReturn   __success(return != B_FALSE)    boolean_t
2419 efx_lic_find_key(
2420         __in                    efx_nic_t *enp,
2421         __in_bcount(buffer_size)
2422                                 caddr_t bufferp,
2423         __in                    size_t buffer_size,
2424         __in                    uint32_t offset,
2425         __out                   uint32_t *startp,
2426         __out                   uint32_t *lengthp
2427         );
2428
2429 extern  __checkReturn   __success(return != B_FALSE)    boolean_t
2430 efx_lic_validate_key(
2431         __in                    efx_nic_t *enp,
2432         __in_bcount(length)     caddr_t keyp,
2433         __in                    uint32_t length
2434         );
2435
2436 extern  __checkReturn           efx_rc_t
2437 efx_lic_read_key(
2438         __in                    efx_nic_t *enp,
2439         __in_bcount(buffer_size)
2440                                 caddr_t bufferp,
2441         __in                    size_t buffer_size,
2442         __in                    uint32_t offset,
2443         __in                    uint32_t length,
2444         __out_bcount_part(key_max_size, *lengthp)
2445                                 caddr_t keyp,
2446         __in                    size_t key_max_size,
2447         __out                   uint32_t *lengthp
2448         );
2449
2450 extern  __checkReturn           efx_rc_t
2451 efx_lic_write_key(
2452         __in                    efx_nic_t *enp,
2453         __in_bcount(buffer_size)
2454                                 caddr_t bufferp,
2455         __in                    size_t buffer_size,
2456         __in                    uint32_t offset,
2457         __in_bcount(length)     caddr_t keyp,
2458         __in                    uint32_t length,
2459         __out                   uint32_t *lengthp
2460         );
2461
2462         __checkReturn           efx_rc_t
2463 efx_lic_delete_key(
2464         __in                    efx_nic_t *enp,
2465         __in_bcount(buffer_size)
2466                                 caddr_t bufferp,
2467         __in                    size_t buffer_size,
2468         __in                    uint32_t offset,
2469         __in                    uint32_t length,
2470         __in                    uint32_t end,
2471         __out                   uint32_t *deltap
2472         );
2473
2474 extern  __checkReturn           efx_rc_t
2475 efx_lic_create_partition(
2476         __in                    efx_nic_t *enp,
2477         __in_bcount(buffer_size)
2478                                 caddr_t bufferp,
2479         __in                    size_t buffer_size
2480         );
2481
2482 extern  __checkReturn           efx_rc_t
2483 efx_lic_finish_partition(
2484         __in                    efx_nic_t *enp,
2485         __in_bcount(buffer_size)
2486                                 caddr_t bufferp,
2487         __in                    size_t buffer_size
2488         );
2489
2490 #endif  /* EFSYS_OPT_LICENSING */
2491
2492
2493
2494 #ifdef  __cplusplus
2495 }
2496 #endif
2497
2498 #endif  /* _SYS_EFX_H */