drivers/net/sfc/base/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
  31 #ifndef _SYS_EFX_H
  32 #define _SYS_EFX_H
  33
  34 #include "efsys.h"
  35 #include "efx_check.h"
  36 #include "efx_phy_ids.h"
  37
  38 #ifdef  __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 #define EFX_STATIC_ASSERT(_cond)                \
  43         ((void)sizeof(char[(_cond) ? 1 : -1]))
  44
  45 #define EFX_ARRAY_SIZE(_array)                  \
  46         (sizeof(_array) / sizeof((_array)[0]))
  47
  48 #define EFX_FIELD_OFFSET(_type, _field)         \
  49         ((size_t) &(((_type *)0)->_field))
  50
  51 /* Return codes */
  52
  53 typedef __success(return == 0) int efx_rc_t;
  54
  55
  56 /* Chip families */
  57
  58 typedef enum efx_family_e {
  59         EFX_FAMILY_INVALID,
  60         EFX_FAMILY_FALCON,      /* Obsolete and not supported */
  61         EFX_FAMILY_SIENA,
  62         EFX_FAMILY_HUNTINGTON,
  63         EFX_FAMILY_MEDFORD,
  64         EFX_FAMILY_NTYPES
  65 } efx_family_t;
  66
  67 extern  __checkReturn   efx_rc_t
  68 efx_family(
  69         __in            uint16_t venid,
  70         __in            uint16_t devid,
  71         __out           efx_family_t *efp);
  72
  73
  74 #define EFX_PCI_VENID_SFC                       0x1924
  75
  76 #define EFX_PCI_DEVID_FALCON                    0x0710  /* SFC4000 */
  77
  78 #define EFX_PCI_DEVID_BETHPAGE                  0x0803  /* SFC9020 */
  79 #define EFX_PCI_DEVID_SIENA                     0x0813  /* SFL9021 */
  80 #define EFX_PCI_DEVID_SIENA_F1_UNINIT           0x0810
  81
  82 #define EFX_PCI_DEVID_HUNTINGTON_PF_UNINIT      0x0901
  83 #define EFX_PCI_DEVID_FARMINGDALE               0x0903  /* SFC9120 PF */
  84 #define EFX_PCI_DEVID_GREENPORT                 0x0923  /* SFC9140 PF */
  85
  86 #define EFX_PCI_DEVID_FARMINGDALE_VF            0x1903  /* SFC9120 VF */
  87 #define EFX_PCI_DEVID_GREENPORT_VF              0x1923  /* SFC9140 VF */
  88
  89 #define EFX_PCI_DEVID_MEDFORD_PF_UNINIT         0x0913
  90 #define EFX_PCI_DEVID_MEDFORD                   0x0A03  /* SFC9240 PF */
  91 #define EFX_PCI_DEVID_MEDFORD_VF                0x1A03  /* SFC9240 VF */
  92
  93 #define EFX_MEM_BAR     2
  94
  95 /* Error codes */
  96
  97 enum {
  98         EFX_ERR_INVALID,
  99         EFX_ERR_SRAM_OOB,
 100         EFX_ERR_BUFID_DC_OOB,
 101         EFX_ERR_MEM_PERR,
 102         EFX_ERR_RBUF_OWN,
 103         EFX_ERR_TBUF_OWN,
 104         EFX_ERR_RDESQ_OWN,
 105         EFX_ERR_TDESQ_OWN,
 106         EFX_ERR_EVQ_OWN,
 107         EFX_ERR_EVFF_OFLO,
 108         EFX_ERR_ILL_ADDR,
 109         EFX_ERR_SRAM_PERR,
 110         EFX_ERR_NCODES
 111 };
 112
 113 /* Calculate the IEEE 802.3 CRC32 of a MAC addr */
 114 extern  __checkReturn           uint32_t
 115 efx_crc32_calculate(
 116         __in                    uint32_t crc_init,
 117         __in_ecount(length)     uint8_t const *input,
 118         __in                    int length);
 119
 120
 121 /* Type prototypes */
 122
 123 typedef struct efx_rxq_s        efx_rxq_t;
 124
 125 /* NIC */
 126
 127 typedef struct efx_nic_s        efx_nic_t;
 128
 129 extern  __checkReturn   efx_rc_t
 130 efx_nic_create(
 131         __in            efx_family_t family,
 132         __in            efsys_identifier_t *esip,
 133         __in            efsys_bar_t *esbp,
 134         __in            efsys_lock_t *eslp,
 135         __deref_out     efx_nic_t **enpp);
 136
 137 extern  __checkReturn   efx_rc_t
 138 efx_nic_probe(
 139         __in            efx_nic_t *enp);
 140
 141 extern  __checkReturn   efx_rc_t
 142 efx_nic_init(
 143         __in            efx_nic_t *enp);
 144
 145 extern  __checkReturn   efx_rc_t
 146 efx_nic_reset(
 147         __in            efx_nic_t *enp);
 148
 149 #if EFSYS_OPT_DIAG
 150
 151 extern  __checkReturn   efx_rc_t
 152 efx_nic_register_test(
 153         __in            efx_nic_t *enp);
 154
 155 #endif  /* EFSYS_OPT_DIAG */
 156
 157 extern          void
 158 efx_nic_fini(
 159         __in            efx_nic_t *enp);
 160
 161 extern          void
 162 efx_nic_unprobe(
 163         __in            efx_nic_t *enp);
 164
 165 extern          void
 166 efx_nic_destroy(
 167         __in    efx_nic_t *enp);
 168
 169 #define EFX_PCIE_LINK_SPEED_GEN1                1
 170 #define EFX_PCIE_LINK_SPEED_GEN2                2
 171 #define EFX_PCIE_LINK_SPEED_GEN3                3
 172
 173 typedef enum efx_pcie_link_performance_e {
 174         EFX_PCIE_LINK_PERFORMANCE_UNKNOWN_BANDWIDTH,
 175         EFX_PCIE_LINK_PERFORMANCE_SUBOPTIMAL_BANDWIDTH,
 176         EFX_PCIE_LINK_PERFORMANCE_SUBOPTIMAL_LATENCY,
 177         EFX_PCIE_LINK_PERFORMANCE_OPTIMAL
 178 } efx_pcie_link_performance_t;
 179
 180 extern  __checkReturn   efx_rc_t
 181 efx_nic_calculate_pcie_link_bandwidth(
 182         __in            uint32_t pcie_link_width,
 183         __in            uint32_t pcie_link_gen,
 184         __out           uint32_t *bandwidth_mbpsp);
 185
 186 extern  __checkReturn   efx_rc_t
 187 efx_nic_check_pcie_link_speed(
 188         __in            efx_nic_t *enp,
 189         __in            uint32_t pcie_link_width,
 190         __in            uint32_t pcie_link_gen,
 191         __out           efx_pcie_link_performance_t *resultp);
 192
 193 #if EFSYS_OPT_MCDI
 194
 195 #if EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD
 196 /* Huntington and Medford require MCDIv2 commands */
 197 #define WITH_MCDI_V2 1
 198 #endif
 199
 200 typedef struct efx_mcdi_req_s efx_mcdi_req_t;
 201
 202 typedef enum efx_mcdi_exception_e {
 203         EFX_MCDI_EXCEPTION_MC_REBOOT,
 204         EFX_MCDI_EXCEPTION_MC_BADASSERT,
 205 } efx_mcdi_exception_t;
 206
 207 #if EFSYS_OPT_MCDI_LOGGING
 208 typedef enum efx_log_msg_e {
 209         EFX_LOG_INVALID,
 210         EFX_LOG_MCDI_REQUEST,
 211         EFX_LOG_MCDI_RESPONSE,
 212 } efx_log_msg_t;
 213 #endif /* EFSYS_OPT_MCDI_LOGGING */
 214
 215 typedef struct efx_mcdi_transport_s {
 216         void            *emt_context;
 217         efsys_mem_t     *emt_dma_mem;
 218         void            (*emt_execute)(void *, efx_mcdi_req_t *);
 219         void            (*emt_ev_cpl)(void *);
 220         void            (*emt_exception)(void *, efx_mcdi_exception_t);
 221 #if EFSYS_OPT_MCDI_LOGGING
 222         void            (*emt_logger)(void *, efx_log_msg_t,
 223                                         void *, size_t, void *, size_t);
 224 #endif /* EFSYS_OPT_MCDI_LOGGING */
 225 #if EFSYS_OPT_MCDI_PROXY_AUTH
 226         void            (*emt_ev_proxy_response)(void *, uint32_t, efx_rc_t);
 227 #endif /* EFSYS_OPT_MCDI_PROXY_AUTH */
 228 } efx_mcdi_transport_t;
 229
 230 extern  __checkReturn   efx_rc_t
 231 efx_mcdi_init(
 232         __in            efx_nic_t *enp,
 233         __in            const efx_mcdi_transport_t *mtp);
 234
 235 extern  __checkReturn   efx_rc_t
 236 efx_mcdi_reboot(
 237         __in            efx_nic_t *enp);
 238
 239                         void
 240 efx_mcdi_new_epoch(
 241         __in            efx_nic_t *enp);
 242
 243 extern                  void
 244 efx_mcdi_get_timeout(
 245         __in            efx_nic_t *enp,
 246         __in            efx_mcdi_req_t *emrp,
 247         __out           uint32_t *usec_timeoutp);
 248
 249 extern                  void
 250 efx_mcdi_request_start(
 251         __in            efx_nic_t *enp,
 252         __in            efx_mcdi_req_t *emrp,
 253         __in            boolean_t ev_cpl);
 254
 255 extern  __checkReturn   boolean_t
 256 efx_mcdi_request_poll(
 257         __in            efx_nic_t *enp);
 258
 259 extern  __checkReturn   boolean_t
 260 efx_mcdi_request_abort(
 261         __in            efx_nic_t *enp);
 262
 263 extern                  void
 264 efx_mcdi_fini(
 265         __in            efx_nic_t *enp);
 266
 267 #endif  /* EFSYS_OPT_MCDI */
 268
 269 /* INTR */
 270
 271 #define EFX_NINTR_SIENA 1024
 272
 273 typedef enum efx_intr_type_e {
 274         EFX_INTR_INVALID = 0,
 275         EFX_INTR_LINE,
 276         EFX_INTR_MESSAGE,
 277         EFX_INTR_NTYPES
 278 } efx_intr_type_t;
 279
 280 #define EFX_INTR_SIZE   (sizeof (efx_oword_t))
 281
 282 extern  __checkReturn   efx_rc_t
 283 efx_intr_init(
 284         __in            efx_nic_t *enp,
 285         __in            efx_intr_type_t type,
 286         __in            efsys_mem_t *esmp);
 287
 288 extern                  void
 289 efx_intr_enable(
 290         __in            efx_nic_t *enp);
 291
 292 extern                  void
 293 efx_intr_disable(
 294         __in            efx_nic_t *enp);
 295
 296 extern                  void
 297 efx_intr_disable_unlocked(
 298         __in            efx_nic_t *enp);
 299
 300 #define EFX_INTR_NEVQS  32
 301
 302 extern  __checkReturn   efx_rc_t
 303 efx_intr_trigger(
 304         __in            efx_nic_t *enp,
 305         __in            unsigned int level);
 306
 307 extern                  void
 308 efx_intr_status_line(
 309         __in            efx_nic_t *enp,
 310         __out           boolean_t *fatalp,
 311         __out           uint32_t *maskp);
 312
 313 extern                  void
 314 efx_intr_status_message(
 315         __in            efx_nic_t *enp,
 316         __in            unsigned int message,
 317         __out           boolean_t *fatalp);
 318
 319 extern                  void
 320 efx_intr_fatal(
 321         __in            efx_nic_t *enp);
 322
 323 extern                  void
 324 efx_intr_fini(
 325         __in            efx_nic_t *enp);
 326
 327 /* MAC */
 328
 329 #if EFSYS_OPT_MAC_STATS
 330
 331 /* START MKCONFIG GENERATED EfxHeaderMacBlock e323546097fd7c65 */
 332 typedef enum efx_mac_stat_e {
 333         EFX_MAC_RX_OCTETS,
 334         EFX_MAC_RX_PKTS,
 335         EFX_MAC_RX_UNICST_PKTS,
 336         EFX_MAC_RX_MULTICST_PKTS,
 337         EFX_MAC_RX_BRDCST_PKTS,
 338         EFX_MAC_RX_PAUSE_PKTS,
 339         EFX_MAC_RX_LE_64_PKTS,
 340         EFX_MAC_RX_65_TO_127_PKTS,
 341         EFX_MAC_RX_128_TO_255_PKTS,
 342         EFX_MAC_RX_256_TO_511_PKTS,
 343         EFX_MAC_RX_512_TO_1023_PKTS,
 344         EFX_MAC_RX_1024_TO_15XX_PKTS,
 345         EFX_MAC_RX_GE_15XX_PKTS,
 346         EFX_MAC_RX_ERRORS,
 347         EFX_MAC_RX_FCS_ERRORS,
 348         EFX_MAC_RX_DROP_EVENTS,
 349         EFX_MAC_RX_FALSE_CARRIER_ERRORS,
 350         EFX_MAC_RX_SYMBOL_ERRORS,
 351         EFX_MAC_RX_ALIGN_ERRORS,
 352         EFX_MAC_RX_INTERNAL_ERRORS,
 353         EFX_MAC_RX_JABBER_PKTS,
 354         EFX_MAC_RX_LANE0_CHAR_ERR,
 355         EFX_MAC_RX_LANE1_CHAR_ERR,
 356         EFX_MAC_RX_LANE2_CHAR_ERR,
 357         EFX_MAC_RX_LANE3_CHAR_ERR,
 358         EFX_MAC_RX_LANE0_DISP_ERR,
 359         EFX_MAC_RX_LANE1_DISP_ERR,
 360         EFX_MAC_RX_LANE2_DISP_ERR,
 361         EFX_MAC_RX_LANE3_DISP_ERR,
 362         EFX_MAC_RX_MATCH_FAULT,
 363         EFX_MAC_RX_NODESC_DROP_CNT,
 364         EFX_MAC_TX_OCTETS,
 365         EFX_MAC_TX_PKTS,
 366         EFX_MAC_TX_UNICST_PKTS,
 367         EFX_MAC_TX_MULTICST_PKTS,
 368         EFX_MAC_TX_BRDCST_PKTS,
 369         EFX_MAC_TX_PAUSE_PKTS,
 370         EFX_MAC_TX_LE_64_PKTS,
 371         EFX_MAC_TX_65_TO_127_PKTS,
 372         EFX_MAC_TX_128_TO_255_PKTS,
 373         EFX_MAC_TX_256_TO_511_PKTS,
 374         EFX_MAC_TX_512_TO_1023_PKTS,
 375         EFX_MAC_TX_1024_TO_15XX_PKTS,
 376         EFX_MAC_TX_GE_15XX_PKTS,
 377         EFX_MAC_TX_ERRORS,
 378         EFX_MAC_TX_SGL_COL_PKTS,
 379         EFX_MAC_TX_MULT_COL_PKTS,
 380         EFX_MAC_TX_EX_COL_PKTS,
 381         EFX_MAC_TX_LATE_COL_PKTS,
 382         EFX_MAC_TX_DEF_PKTS,
 383         EFX_MAC_TX_EX_DEF_PKTS,
 384         EFX_MAC_PM_TRUNC_BB_OVERFLOW,
 385         EFX_MAC_PM_DISCARD_BB_OVERFLOW,
 386         EFX_MAC_PM_TRUNC_VFIFO_FULL,
 387         EFX_MAC_PM_DISCARD_VFIFO_FULL,
 388         EFX_MAC_PM_TRUNC_QBB,
 389         EFX_MAC_PM_DISCARD_QBB,
 390         EFX_MAC_PM_DISCARD_MAPPING,
 391         EFX_MAC_RXDP_Q_DISABLED_PKTS,
 392         EFX_MAC_RXDP_DI_DROPPED_PKTS,
 393         EFX_MAC_RXDP_STREAMING_PKTS,
 394         EFX_MAC_RXDP_HLB_FETCH,
 395         EFX_MAC_RXDP_HLB_WAIT,
 396         EFX_MAC_VADAPTER_RX_UNICAST_PACKETS,
 397         EFX_MAC_VADAPTER_RX_UNICAST_BYTES,
 398         EFX_MAC_VADAPTER_RX_MULTICAST_PACKETS,
 399         EFX_MAC_VADAPTER_RX_MULTICAST_BYTES,
 400         EFX_MAC_VADAPTER_RX_BROADCAST_PACKETS,
 401         EFX_MAC_VADAPTER_RX_BROADCAST_BYTES,
 402         EFX_MAC_VADAPTER_RX_BAD_PACKETS,
 403         EFX_MAC_VADAPTER_RX_BAD_BYTES,
 404         EFX_MAC_VADAPTER_RX_OVERFLOW,
 405         EFX_MAC_VADAPTER_TX_UNICAST_PACKETS,
 406         EFX_MAC_VADAPTER_TX_UNICAST_BYTES,
 407         EFX_MAC_VADAPTER_TX_MULTICAST_PACKETS,
 408         EFX_MAC_VADAPTER_TX_MULTICAST_BYTES,
 409         EFX_MAC_VADAPTER_TX_BROADCAST_PACKETS,
 410         EFX_MAC_VADAPTER_TX_BROADCAST_BYTES,
 411         EFX_MAC_VADAPTER_TX_BAD_PACKETS,
 412         EFX_MAC_VADAPTER_TX_BAD_BYTES,
 413         EFX_MAC_VADAPTER_TX_OVERFLOW,
 414         EFX_MAC_NSTATS
 415 } efx_mac_stat_t;
 416
 417 /* END MKCONFIG GENERATED EfxHeaderMacBlock */
 418
 419 #endif  /* EFSYS_OPT_MAC_STATS */
 420
 421 typedef enum efx_link_mode_e {
 422         EFX_LINK_UNKNOWN = 0,
 423         EFX_LINK_DOWN,
 424         EFX_LINK_10HDX,
 425         EFX_LINK_10FDX,
 426         EFX_LINK_100HDX,
 427         EFX_LINK_100FDX,
 428         EFX_LINK_1000HDX,
 429         EFX_LINK_1000FDX,
 430         EFX_LINK_10000FDX,
 431         EFX_LINK_40000FDX,
 432         EFX_LINK_NMODES
 433 } efx_link_mode_t;
 434
 435 #define EFX_MAC_ADDR_LEN 6
 436
 437 #define EFX_MAC_ADDR_IS_MULTICAST(_address) (((uint8_t *)_address)[0] & 0x01)
 438
 439 #define EFX_MAC_MULTICAST_LIST_MAX      256
 440
 441 #define EFX_MAC_SDU_MAX 9202
 442
 443 #define EFX_MAC_PDU_ADJUSTMENT                                  \
 444         (/* EtherII */ 14                                       \
 445             + /* VLAN */ 4                                      \
 446             + /* CRC */ 4                                       \
 447             + /* bug16011 */ 16)                                \
 448
 449 #define EFX_MAC_PDU(_sdu)                                       \
 450         P2ROUNDUP((_sdu) + EFX_MAC_PDU_ADJUSTMENT, 8)
 451
 452 /*
 453  * Due to the P2ROUNDUP in EFX_MAC_PDU(), EFX_MAC_SDU_FROM_PDU() may give
 454  * the SDU rounded up slightly.
 455  */
 456 #define EFX_MAC_SDU_FROM_PDU(_pdu)      ((_pdu) - EFX_MAC_PDU_ADJUSTMENT)
 457
 458 #define EFX_MAC_PDU_MIN 60
 459 #define EFX_MAC_PDU_MAX EFX_MAC_PDU(EFX_MAC_SDU_MAX)
 460
 461 extern  __checkReturn   efx_rc_t
 462 efx_mac_pdu_get(
 463         __in            efx_nic_t *enp,
 464         __out           size_t *pdu);
 465
 466 extern  __checkReturn   efx_rc_t
 467 efx_mac_pdu_set(
 468         __in            efx_nic_t *enp,
 469         __in            size_t pdu);
 470
 471 extern  __checkReturn   efx_rc_t
 472 efx_mac_addr_set(
 473         __in            efx_nic_t *enp,
 474         __in            uint8_t *addr);
 475
 476 extern  __checkReturn                   efx_rc_t
 477 efx_mac_filter_set(
 478         __in                            efx_nic_t *enp,
 479         __in                            boolean_t all_unicst,
 480         __in                            boolean_t mulcst,
 481         __in                            boolean_t all_mulcst,
 482         __in                            boolean_t brdcst);
 483
 484 extern  __checkReturn   efx_rc_t
 485 efx_mac_multicast_list_set(
 486         __in                            efx_nic_t *enp,
 487         __in_ecount(6*count)            uint8_t const *addrs,
 488         __in                            int count);
 489
 490 extern  __checkReturn   efx_rc_t
 491 efx_mac_filter_default_rxq_set(
 492         __in            efx_nic_t *enp,
 493         __in            efx_rxq_t *erp,
 494         __in            boolean_t using_rss);
 495
 496 extern                  void
 497 efx_mac_filter_default_rxq_clear(
 498         __in            efx_nic_t *enp);
 499
 500 extern  __checkReturn   efx_rc_t
 501 efx_mac_drain(
 502         __in            efx_nic_t *enp,
 503         __in            boolean_t enabled);
 504
 505 extern  __checkReturn   efx_rc_t
 506 efx_mac_up(
 507         __in            efx_nic_t *enp,
 508         __out           boolean_t *mac_upp);
 509
 510 #define EFX_FCNTL_RESPOND       0x00000001
 511 #define EFX_FCNTL_GENERATE      0x00000002
 512
 513 extern  __checkReturn   efx_rc_t
 514 efx_mac_fcntl_set(
 515         __in            efx_nic_t *enp,
 516         __in            unsigned int fcntl,
 517         __in            boolean_t autoneg);
 518
 519 extern                  void
 520 efx_mac_fcntl_get(
 521         __in            efx_nic_t *enp,
 522         __out           unsigned int *fcntl_wantedp,
 523         __out           unsigned int *fcntl_linkp);
 524
 525
 526 #if EFSYS_OPT_MAC_STATS
 527
 528 #if EFSYS_OPT_NAMES
 529
 530 extern  __checkReturn                   const char *
 531 efx_mac_stat_name(
 532         __in                            efx_nic_t *enp,
 533         __in                            unsigned int id);
 534
 535 #endif  /* EFSYS_OPT_NAMES */
 536
 537 #define EFX_MAC_STATS_MASK_BITS_PER_PAGE        (8 * sizeof (uint32_t))
 538
 539 #define EFX_MAC_STATS_MASK_NPAGES       \
 540         (P2ROUNDUP(EFX_MAC_NSTATS, EFX_MAC_STATS_MASK_BITS_PER_PAGE) / \
 541             EFX_MAC_STATS_MASK_BITS_PER_PAGE)
 542
 543 /*
 544  * Get mask of MAC statistics supported by the hardware.
 545  *
 546  * If mask_size is insufficient to return the mask, EINVAL error is
 547  * returned. EFX_MAC_STATS_MASK_NPAGES multiplied by size of the page
 548  * (which is sizeof (uint32_t)) is sufficient.
 549  */
 550 extern  __checkReturn                   efx_rc_t
 551 efx_mac_stats_get_mask(
 552         __in                            efx_nic_t *enp,
 553         __out_bcount(mask_size)         uint32_t *maskp,
 554         __in                            size_t mask_size);
 555
 556 #define EFX_MAC_STAT_SUPPORTED(_mask, _stat)    \
 557         ((_mask)[(_stat) / EFX_MAC_STATS_MASK_BITS_PER_PAGE] &  \
 558          (1ULL << ((_stat) & (EFX_MAC_STATS_MASK_BITS_PER_PAGE - 1))))
 559
 560 #define EFX_MAC_STATS_SIZE 0x400
 561
 562 /*
 563  * Upload mac statistics supported by the hardware into the given buffer.
 564  *
 565  * The reference buffer must be at least %EFX_MAC_STATS_SIZE bytes,
 566  * and page aligned.
 567  *
 568  * The hardware will only DMA statistics that it understands (of course).
 569  * Drivers should not make any assumptions about which statistics are
 570  * supported, especially when the statistics are generated by firmware.
 571  *
 572  * Thus, drivers should zero this buffer before use, so that not-understood
 573  * statistics read back as zero.
 574  */
 575 extern  __checkReturn                   efx_rc_t
 576 efx_mac_stats_upload(
 577         __in                            efx_nic_t *enp,
 578         __in                            efsys_mem_t *esmp);
 579
 580 extern  __checkReturn                   efx_rc_t
 581 efx_mac_stats_periodic(
 582         __in                            efx_nic_t *enp,
 583         __in                            efsys_mem_t *esmp,
 584         __in                            uint16_t period_ms,
 585         __in                            boolean_t events);
 586
 587 extern  __checkReturn                   efx_rc_t
 588 efx_mac_stats_update(
 589         __in                            efx_nic_t *enp,
 590         __in                            efsys_mem_t *esmp,
 591         __inout_ecount(EFX_MAC_NSTATS)  efsys_stat_t *stat,
 592         __inout_opt                     uint32_t *generationp);
 593
 594 #endif  /* EFSYS_OPT_MAC_STATS */
 595
 596 /* MON */
 597
 598 typedef enum efx_mon_type_e {
 599         EFX_MON_INVALID = 0,
 600         EFX_MON_SFC90X0,
 601         EFX_MON_SFC91X0,
 602         EFX_MON_SFC92X0,
 603         EFX_MON_NTYPES
 604 } efx_mon_type_t;
 605
 606 #if EFSYS_OPT_NAMES
 607
 608 extern          const char *
 609 efx_mon_name(
 610         __in    efx_nic_t *enp);
 611
 612 #endif  /* EFSYS_OPT_NAMES */
 613
 614 extern  __checkReturn   efx_rc_t
 615 efx_mon_init(
 616         __in            efx_nic_t *enp);
 617
 618 extern          void
 619 efx_mon_fini(
 620         __in    efx_nic_t *enp);
 621
 622 /* PHY */
 623
 624 extern  __checkReturn   efx_rc_t
 625 efx_phy_verify(
 626         __in            efx_nic_t *enp);
 627
 628 #if EFSYS_OPT_PHY_LED_CONTROL
 629
 630 typedef enum efx_phy_led_mode_e {
 631         EFX_PHY_LED_DEFAULT = 0,
 632         EFX_PHY_LED_OFF,
 633         EFX_PHY_LED_ON,
 634         EFX_PHY_LED_FLASH,
 635         EFX_PHY_LED_NMODES
 636 } efx_phy_led_mode_t;
 637
 638 extern  __checkReturn   efx_rc_t
 639 efx_phy_led_set(
 640         __in    efx_nic_t *enp,
 641         __in    efx_phy_led_mode_t mode);
 642
 643 #endif  /* EFSYS_OPT_PHY_LED_CONTROL */
 644
 645 extern  __checkReturn   efx_rc_t
 646 efx_port_init(
 647         __in            efx_nic_t *enp);
 648
 649 extern  __checkReturn   efx_rc_t
 650 efx_port_poll(
 651         __in            efx_nic_t *enp,
 652         __out_opt       efx_link_mode_t *link_modep);
 653
 654 extern          void
 655 efx_port_fini(
 656         __in    efx_nic_t *enp);
 657
 658 typedef enum efx_phy_cap_type_e {
 659         EFX_PHY_CAP_INVALID = 0,
 660         EFX_PHY_CAP_10HDX,
 661         EFX_PHY_CAP_10FDX,
 662         EFX_PHY_CAP_100HDX,
 663         EFX_PHY_CAP_100FDX,
 664         EFX_PHY_CAP_1000HDX,
 665         EFX_PHY_CAP_1000FDX,
 666         EFX_PHY_CAP_10000FDX,
 667         EFX_PHY_CAP_PAUSE,
 668         EFX_PHY_CAP_ASYM,
 669         EFX_PHY_CAP_AN,
 670         EFX_PHY_CAP_40000FDX,
 671         EFX_PHY_CAP_NTYPES
 672 } efx_phy_cap_type_t;
 673
 674
 675 #define EFX_PHY_CAP_CURRENT     0x00000000
 676 #define EFX_PHY_CAP_DEFAULT     0x00000001
 677 #define EFX_PHY_CAP_PERM        0x00000002
 678
 679 extern          void
 680 efx_phy_adv_cap_get(
 681         __in            efx_nic_t *enp,
 682         __in            uint32_t flag,
 683         __out           uint32_t *maskp);
 684
 685 extern  __checkReturn   efx_rc_t
 686 efx_phy_adv_cap_set(
 687         __in            efx_nic_t *enp,
 688         __in            uint32_t mask);
 689
 690 extern                  void
 691 efx_phy_lp_cap_get(
 692         __in            efx_nic_t *enp,
 693         __out           uint32_t *maskp);
 694
 695 extern  __checkReturn   efx_rc_t
 696 efx_phy_oui_get(
 697         __in            efx_nic_t *enp,
 698         __out           uint32_t *ouip);
 699
 700 typedef enum efx_phy_media_type_e {
 701         EFX_PHY_MEDIA_INVALID = 0,
 702         EFX_PHY_MEDIA_XAUI,
 703         EFX_PHY_MEDIA_CX4,
 704         EFX_PHY_MEDIA_KX4,
 705         EFX_PHY_MEDIA_XFP,
 706         EFX_PHY_MEDIA_SFP_PLUS,
 707         EFX_PHY_MEDIA_BASE_T,
 708         EFX_PHY_MEDIA_QSFP_PLUS,
 709         EFX_PHY_MEDIA_NTYPES
 710 } efx_phy_media_type_t;
 711
 712 /* Get the type of medium currently used.  If the board has ports for
 713  * modules, a module is present, and we recognise the media type of
 714  * the module, then this will be the media type of the module.
 715  * Otherwise it will be the media type of the port.
 716  */
 717 extern                  void
 718 efx_phy_media_type_get(
 719         __in            efx_nic_t *enp,
 720         __out           efx_phy_media_type_t *typep);
 721
 722 extern                                  efx_rc_t
 723 efx_phy_module_get_info(
 724         __in                            efx_nic_t *enp,
 725         __in                            uint8_t dev_addr,
 726         __in                            uint8_t offset,
 727         __in                            uint8_t len,
 728         __out_bcount(len)               uint8_t *data);
 729
 730 #if EFSYS_OPT_PHY_STATS
 731
 732 /* START MKCONFIG GENERATED PhyHeaderStatsBlock 30ed56ad501f8e36 */
 733 typedef enum efx_phy_stat_e {
 734         EFX_PHY_STAT_OUI,
 735         EFX_PHY_STAT_PMA_PMD_LINK_UP,
 736         EFX_PHY_STAT_PMA_PMD_RX_FAULT,
 737         EFX_PHY_STAT_PMA_PMD_TX_FAULT,
 738         EFX_PHY_STAT_PMA_PMD_REV_A,
 739         EFX_PHY_STAT_PMA_PMD_REV_B,
 740         EFX_PHY_STAT_PMA_PMD_REV_C,
 741         EFX_PHY_STAT_PMA_PMD_REV_D,
 742         EFX_PHY_STAT_PCS_LINK_UP,
 743         EFX_PHY_STAT_PCS_RX_FAULT,
 744         EFX_PHY_STAT_PCS_TX_FAULT,
 745         EFX_PHY_STAT_PCS_BER,
 746         EFX_PHY_STAT_PCS_BLOCK_ERRORS,
 747         EFX_PHY_STAT_PHY_XS_LINK_UP,
 748         EFX_PHY_STAT_PHY_XS_RX_FAULT,
 749         EFX_PHY_STAT_PHY_XS_TX_FAULT,
 750         EFX_PHY_STAT_PHY_XS_ALIGN,
 751         EFX_PHY_STAT_PHY_XS_SYNC_A,
 752         EFX_PHY_STAT_PHY_XS_SYNC_B,
 753         EFX_PHY_STAT_PHY_XS_SYNC_C,
 754         EFX_PHY_STAT_PHY_XS_SYNC_D,
 755         EFX_PHY_STAT_AN_LINK_UP,
 756         EFX_PHY_STAT_AN_MASTER,
 757         EFX_PHY_STAT_AN_LOCAL_RX_OK,
 758         EFX_PHY_STAT_AN_REMOTE_RX_OK,
 759         EFX_PHY_STAT_CL22EXT_LINK_UP,
 760         EFX_PHY_STAT_SNR_A,
 761         EFX_PHY_STAT_SNR_B,
 762         EFX_PHY_STAT_SNR_C,
 763         EFX_PHY_STAT_SNR_D,
 764         EFX_PHY_STAT_PMA_PMD_SIGNAL_A,
 765         EFX_PHY_STAT_PMA_PMD_SIGNAL_B,
 766         EFX_PHY_STAT_PMA_PMD_SIGNAL_C,
 767         EFX_PHY_STAT_PMA_PMD_SIGNAL_D,
 768         EFX_PHY_STAT_AN_COMPLETE,
 769         EFX_PHY_STAT_PMA_PMD_REV_MAJOR,
 770         EFX_PHY_STAT_PMA_PMD_REV_MINOR,
 771         EFX_PHY_STAT_PMA_PMD_REV_MICRO,
 772         EFX_PHY_STAT_PCS_FW_VERSION_0,
 773         EFX_PHY_STAT_PCS_FW_VERSION_1,
 774         EFX_PHY_STAT_PCS_FW_VERSION_2,
 775         EFX_PHY_STAT_PCS_FW_VERSION_3,
 776         EFX_PHY_STAT_PCS_FW_BUILD_YY,
 777         EFX_PHY_STAT_PCS_FW_BUILD_MM,
 778         EFX_PHY_STAT_PCS_FW_BUILD_DD,
 779         EFX_PHY_STAT_PCS_OP_MODE,
 780         EFX_PHY_NSTATS
 781 } efx_phy_stat_t;
 782
 783 /* END MKCONFIG GENERATED PhyHeaderStatsBlock */
 784
 785 #if EFSYS_OPT_NAMES
 786
 787 extern                                  const char *
 788 efx_phy_stat_name(
 789         __in                            efx_nic_t *enp,
 790         __in                            efx_phy_stat_t stat);
 791
 792 #endif  /* EFSYS_OPT_NAMES */
 793
 794 #define EFX_PHY_STATS_SIZE 0x100
 795
 796 extern  __checkReturn                   efx_rc_t
 797 efx_phy_stats_update(
 798         __in                            efx_nic_t *enp,
 799         __in                            efsys_mem_t *esmp,
 800         __inout_ecount(EFX_PHY_NSTATS)  uint32_t *stat);
 801
 802 #endif  /* EFSYS_OPT_PHY_STATS */
 803
 804
 805 #if EFSYS_OPT_BIST
 806
 807 typedef enum efx_bist_type_e {
 808         EFX_BIST_TYPE_UNKNOWN,
 809         EFX_BIST_TYPE_PHY_NORMAL,
 810         EFX_BIST_TYPE_PHY_CABLE_SHORT,
 811         EFX_BIST_TYPE_PHY_CABLE_LONG,
 812         EFX_BIST_TYPE_MC_MEM,   /* Test the MC DMEM and IMEM */
 813         EFX_BIST_TYPE_SAT_MEM,  /* Test the DMEM and IMEM of satellite cpus*/
 814         EFX_BIST_TYPE_REG,      /* Test the register memories */
 815         EFX_BIST_TYPE_NTYPES,
 816 } efx_bist_type_t;
 817
 818 typedef enum efx_bist_result_e {
 819         EFX_BIST_RESULT_UNKNOWN,
 820         EFX_BIST_RESULT_RUNNING,
 821         EFX_BIST_RESULT_PASSED,
 822         EFX_BIST_RESULT_FAILED,
 823 } efx_bist_result_t;
 824
 825 typedef enum efx_phy_cable_status_e {
 826         EFX_PHY_CABLE_STATUS_OK,
 827         EFX_PHY_CABLE_STATUS_INVALID,
 828         EFX_PHY_CABLE_STATUS_OPEN,
 829         EFX_PHY_CABLE_STATUS_INTRAPAIRSHORT,
 830         EFX_PHY_CABLE_STATUS_INTERPAIRSHORT,
 831         EFX_PHY_CABLE_STATUS_BUSY,
 832 } efx_phy_cable_status_t;
 833
 834 typedef enum efx_bist_value_e {
 835         EFX_BIST_PHY_CABLE_LENGTH_A,
 836         EFX_BIST_PHY_CABLE_LENGTH_B,
 837         EFX_BIST_PHY_CABLE_LENGTH_C,
 838         EFX_BIST_PHY_CABLE_LENGTH_D,
 839         EFX_BIST_PHY_CABLE_STATUS_A,
 840         EFX_BIST_PHY_CABLE_STATUS_B,
 841         EFX_BIST_PHY_CABLE_STATUS_C,
 842         EFX_BIST_PHY_CABLE_STATUS_D,
 843         EFX_BIST_FAULT_CODE,
 844         /* Memory BIST specific values. These match to the MC_CMD_BIST_POLL
 845          * response. */
 846         EFX_BIST_MEM_TEST,
 847         EFX_BIST_MEM_ADDR,
 848         EFX_BIST_MEM_BUS,
 849         EFX_BIST_MEM_EXPECT,
 850         EFX_BIST_MEM_ACTUAL,
 851         EFX_BIST_MEM_ECC,
 852         EFX_BIST_MEM_ECC_PARITY,
 853         EFX_BIST_MEM_ECC_FATAL,
 854         EFX_BIST_NVALUES,
 855 } efx_bist_value_t;
 856
 857 extern  __checkReturn           efx_rc_t
 858 efx_bist_enable_offline(
 859         __in                    efx_nic_t *enp);
 860
 861 extern  __checkReturn           efx_rc_t
 862 efx_bist_start(
 863         __in                    efx_nic_t *enp,
 864         __in                    efx_bist_type_t type);
 865
 866 extern  __checkReturn           efx_rc_t
 867 efx_bist_poll(
 868         __in                    efx_nic_t *enp,
 869         __in                    efx_bist_type_t type,
 870         __out                   efx_bist_result_t *resultp,
 871         __out_opt               uint32_t *value_maskp,
 872         __out_ecount_opt(count) unsigned long *valuesp,
 873         __in                    size_t count);
 874
 875 extern                          void
 876 efx_bist_stop(
 877         __in                    efx_nic_t *enp,
 878         __in                    efx_bist_type_t type);
 879
 880 #endif  /* EFSYS_OPT_BIST */
 881
 882 #define EFX_FEATURE_IPV6                0x00000001
 883 #define EFX_FEATURE_LFSR_HASH_INSERT    0x00000002
 884 #define EFX_FEATURE_LINK_EVENTS         0x00000004
 885 #define EFX_FEATURE_PERIODIC_MAC_STATS  0x00000008
 886 #define EFX_FEATURE_MCDI                0x00000020
 887 #define EFX_FEATURE_LOOKAHEAD_SPLIT     0x00000040
 888 #define EFX_FEATURE_MAC_HEADER_FILTERS  0x00000080
 889 #define EFX_FEATURE_TURBO               0x00000100
 890 #define EFX_FEATURE_MCDI_DMA            0x00000200
 891 #define EFX_FEATURE_TX_SRC_FILTERS      0x00000400
 892 #define EFX_FEATURE_PIO_BUFFERS         0x00000800
 893 #define EFX_FEATURE_FW_ASSISTED_TSO     0x00001000
 894 #define EFX_FEATURE_FW_ASSISTED_TSO_V2  0x00002000
 895 #define EFX_FEATURE_PACKED_STREAM       0x00004000
 896
 897 typedef struct efx_nic_cfg_s {
 898         uint32_t                enc_board_type;
 899         uint32_t                enc_phy_type;
 900 #if EFSYS_OPT_NAMES
 901         char                    enc_phy_name[21];
 902 #endif
 903         char                    enc_phy_revision[21];
 904         efx_mon_type_t          enc_mon_type;
 905         unsigned int            enc_features;
 906         uint8_t                 enc_mac_addr[6];
 907         uint8_t                 enc_port;       /* PHY port number */
 908         uint32_t                enc_intr_vec_base;
 909         uint32_t                enc_intr_limit;
 910         uint32_t                enc_evq_limit;
 911         uint32_t                enc_txq_limit;
 912         uint32_t                enc_rxq_limit;
 913         uint32_t                enc_txq_max_ndescs;
 914         uint32_t                enc_buftbl_limit;
 915         uint32_t                enc_piobuf_limit;
 916         uint32_t                enc_piobuf_size;
 917         uint32_t                enc_piobuf_min_alloc_size;
 918         uint32_t                enc_evq_timer_quantum_ns;
 919         uint32_t                enc_evq_timer_max_us;
 920         uint32_t                enc_clk_mult;
 921         uint32_t                enc_rx_prefix_size;
 922         uint32_t                enc_rx_buf_align_start;
 923         uint32_t                enc_rx_buf_align_end;
 924 #if EFSYS_OPT_PHY_FLAGS
 925         uint32_t                enc_phy_flags_mask;
 926 #endif  /* EFSYS_OPT_PHY_FLAGS */
 927 #if EFSYS_OPT_PHY_LED_CONTROL
 928         uint32_t                enc_led_mask;
 929 #endif  /* EFSYS_OPT_PHY_LED_CONTROL */
 930 #if EFSYS_OPT_PHY_STATS
 931         uint64_t                enc_phy_stat_mask;
 932 #endif  /* EFSYS_OPT_PHY_STATS */
 933 #if EFSYS_OPT_MCDI
 934         uint8_t                 enc_mcdi_mdio_channel;
 935 #if EFSYS_OPT_PHY_STATS
 936         uint32_t                enc_mcdi_phy_stat_mask;
 937 #endif  /* EFSYS_OPT_PHY_STATS */
 938 #endif  /* EFSYS_OPT_MCDI */
 939 #if EFSYS_OPT_BIST
 940         uint32_t                enc_bist_mask;
 941 #endif  /* EFSYS_OPT_BIST */
 942 #if EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD
 943         uint32_t                enc_pf;
 944         uint32_t                enc_vf;
 945         uint32_t                enc_privilege_mask;
 946 #endif /* EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD */
 947         boolean_t               enc_bug26807_workaround;
 948         boolean_t               enc_bug35388_workaround;
 949         boolean_t               enc_bug41750_workaround;
 950         boolean_t               enc_bug61265_workaround;
 951         boolean_t               enc_rx_batching_enabled;
 952         /* Maximum number of descriptors completed in an rx event. */
 953         uint32_t                enc_rx_batch_max;
 954         /* Number of rx descriptors the hardware requires for a push. */
 955         uint32_t                enc_rx_push_align;
 956         /*
 957          * Maximum number of bytes into the packet the TCP header can start for
 958          * the hardware to apply TSO packet edits.
 959          */
 960         uint32_t                enc_tx_tso_tcp_header_offset_limit;
 961         boolean_t               enc_fw_assisted_tso_enabled;
 962         boolean_t               enc_fw_assisted_tso_v2_enabled;
 963         /* Number of TSO contexts on the NIC (FATSOv2) */
 964         uint32_t                enc_fw_assisted_tso_v2_n_contexts;
 965         boolean_t               enc_hw_tx_insert_vlan_enabled;
 966         /* Number of PFs on the NIC */
 967         uint32_t                enc_hw_pf_count;
 968         /* Datapath firmware vadapter/vport/vswitch support */
 969         boolean_t               enc_datapath_cap_evb;
 970         boolean_t               enc_rx_disable_scatter_supported;
 971         boolean_t               enc_allow_set_mac_with_installed_filters;
 972         boolean_t               enc_enhanced_set_mac_supported;
 973         boolean_t               enc_init_evq_v2_supported;
 974         boolean_t               enc_rx_packed_stream_supported;
 975         boolean_t               enc_rx_var_packed_stream_supported;
 976         boolean_t               enc_pm_and_rxdp_counters;
 977         boolean_t               enc_mac_stats_40g_tx_size_bins;
 978         /* External port identifier */
 979         uint8_t                 enc_external_port;
 980         uint32_t                enc_mcdi_max_payload_length;
 981         /* VPD may be per-PF or global */
 982         boolean_t               enc_vpd_is_global;
 983         /* Minimum unidirectional bandwidth in Mb/s to max out all ports */
 984         uint32_t                enc_required_pcie_bandwidth_mbps;
 985         uint32_t                enc_max_pcie_link_gen;
 986         /* Firmware verifies integrity of NVRAM updates */
 987         uint32_t                enc_fw_verified_nvram_update_required;
 988 } efx_nic_cfg_t;
 989
 990 #define EFX_PCI_FUNCTION_IS_PF(_encp)   ((_encp)->enc_vf == 0xffff)
 991 #define EFX_PCI_FUNCTION_IS_VF(_encp)   ((_encp)->enc_vf != 0xffff)
 992
 993 #define EFX_PCI_FUNCTION(_encp) \
 994         (EFX_PCI_FUNCTION_IS_PF(_encp) ? (_encp)->enc_pf : (_encp)->enc_vf)
 995
 996 #define EFX_PCI_VF_PARENT(_encp)        ((_encp)->enc_pf)
 997
 998 extern                  const efx_nic_cfg_t *
 999 efx_nic_cfg_get(
1000         __in            efx_nic_t *enp);
1001
1002 /* Driver resource limits (minimum required/maximum usable). */
1003 typedef struct efx_drv_limits_s {
1004         uint32_t        edl_min_evq_count;
1005         uint32_t        edl_max_evq_count;
1006
1007         uint32_t        edl_min_rxq_count;
1008         uint32_t        edl_max_rxq_count;
1009
1010         uint32_t        edl_min_txq_count;
1011         uint32_t        edl_max_txq_count;
1012
1013         /* PIO blocks (sub-allocated from piobuf) */
1014         uint32_t        edl_min_pio_alloc_size;
1015         uint32_t        edl_max_pio_alloc_count;
1016 } efx_drv_limits_t;
1017
1018 extern  __checkReturn   efx_rc_t
1019 efx_nic_set_drv_limits(
1020         __inout         efx_nic_t *enp,
1021         __in            efx_drv_limits_t *edlp);
1022
1023 typedef enum efx_nic_region_e {
1024         EFX_REGION_VI,                  /* Memory BAR UC mapping */
1025         EFX_REGION_PIO_WRITE_VI,        /* Memory BAR WC mapping */
1026 } efx_nic_region_t;
1027
1028 extern  __checkReturn   efx_rc_t
1029 efx_nic_get_bar_region(
1030         __in            efx_nic_t *enp,
1031         __in            efx_nic_region_t region,
1032         __out           uint32_t *offsetp,
1033         __out           size_t *sizep);
1034
1035 extern  __checkReturn   efx_rc_t
1036 efx_nic_get_vi_pool(
1037         __in            efx_nic_t *enp,
1038         __out           uint32_t *evq_countp,
1039         __out           uint32_t *rxq_countp,
1040         __out           uint32_t *txq_countp);
1041
1042
1043 /* NVRAM */
1044
1045 #if EFSYS_OPT_DIAG
1046
1047 typedef enum efx_pattern_type_t {
1048         EFX_PATTERN_BYTE_INCREMENT = 0,
1049         EFX_PATTERN_ALL_THE_SAME,
1050         EFX_PATTERN_BIT_ALTERNATE,
1051         EFX_PATTERN_BYTE_ALTERNATE,
1052         EFX_PATTERN_BYTE_CHANGING,
1053         EFX_PATTERN_BIT_SWEEP,
1054         EFX_PATTERN_NTYPES
1055 } efx_pattern_type_t;
1056
1057 typedef                 void
1058 (*efx_sram_pattern_fn_t)(
1059         __in            size_t row,
1060         __in            boolean_t negate,
1061         __out           efx_qword_t *eqp);
1062
1063 extern  __checkReturn   efx_rc_t
1064 efx_sram_test(
1065         __in            efx_nic_t *enp,
1066         __in            efx_pattern_type_t type);
1067
1068 #endif  /* EFSYS_OPT_DIAG */
1069
1070 extern  __checkReturn   efx_rc_t
1071 efx_sram_buf_tbl_set(
1072         __in            efx_nic_t *enp,
1073         __in            uint32_t id,
1074         __in            efsys_mem_t *esmp,
1075         __in            size_t n);
1076
1077 extern          void
1078 efx_sram_buf_tbl_clear(
1079         __in    efx_nic_t *enp,
1080         __in    uint32_t id,
1081         __in    size_t n);
1082
1083 #define EFX_BUF_TBL_SIZE        0x20000
1084
1085 #define EFX_BUF_SIZE            4096
1086
1087 /* EV */
1088
1089 typedef struct efx_evq_s        efx_evq_t;
1090
1091 #if EFSYS_OPT_QSTATS
1092
1093 /* START MKCONFIG GENERATED EfxHeaderEventQueueBlock 6f3843f5fe7cc843 */
1094 typedef enum efx_ev_qstat_e {
1095         EV_ALL,
1096         EV_RX,
1097         EV_RX_OK,
1098         EV_RX_FRM_TRUNC,
1099         EV_RX_TOBE_DISC,
1100         EV_RX_PAUSE_FRM_ERR,
1101         EV_RX_BUF_OWNER_ID_ERR,
1102         EV_RX_IPV4_HDR_CHKSUM_ERR,
1103         EV_RX_TCP_UDP_CHKSUM_ERR,
1104         EV_RX_ETH_CRC_ERR,
1105         EV_RX_IP_FRAG_ERR,
1106         EV_RX_MCAST_PKT,
1107         EV_RX_MCAST_HASH_MATCH,
1108         EV_RX_TCP_IPV4,
1109         EV_RX_TCP_IPV6,
1110         EV_RX_UDP_IPV4,
1111         EV_RX_UDP_IPV6,
1112         EV_RX_OTHER_IPV4,
1113         EV_RX_OTHER_IPV6,
1114         EV_RX_NON_IP,
1115         EV_RX_BATCH,
1116         EV_TX,
1117         EV_TX_WQ_FF_FULL,
1118         EV_TX_PKT_ERR,
1119         EV_TX_PKT_TOO_BIG,
1120         EV_TX_UNEXPECTED,
1121         EV_GLOBAL,
1122         EV_GLOBAL_MNT,
1123         EV_DRIVER,
1124         EV_DRIVER_SRM_UPD_DONE,
1125         EV_DRIVER_TX_DESCQ_FLS_DONE,
1126         EV_DRIVER_RX_DESCQ_FLS_DONE,
1127         EV_DRIVER_RX_DESCQ_FLS_FAILED,
1128         EV_DRIVER_RX_DSC_ERROR,
1129         EV_DRIVER_TX_DSC_ERROR,
1130         EV_DRV_GEN,
1131         EV_MCDI_RESPONSE,
1132         EV_NQSTATS
1133 } efx_ev_qstat_t;
1134
1135 /* END MKCONFIG GENERATED EfxHeaderEventQueueBlock */
1136
1137 #endif  /* EFSYS_OPT_QSTATS */
1138
1139 extern  __checkReturn   efx_rc_t
1140 efx_ev_init(
1141         __in            efx_nic_t *enp);
1142
1143 extern          void
1144 efx_ev_fini(
1145         __in            efx_nic_t *enp);
1146
1147 #define EFX_EVQ_MAXNEVS         32768
1148 #define EFX_EVQ_MINNEVS         512
1149
1150 #define EFX_EVQ_SIZE(_nevs)     ((_nevs) * sizeof (efx_qword_t))
1151 #define EFX_EVQ_NBUFS(_nevs)    (EFX_EVQ_SIZE(_nevs) / EFX_BUF_SIZE)
1152
1153 #define EFX_EVQ_FLAGS_TYPE_MASK         (0x3)
1154 #define EFX_EVQ_FLAGS_TYPE_AUTO         (0x0)
1155 #define EFX_EVQ_FLAGS_TYPE_THROUGHPUT   (0x1)
1156 #define EFX_EVQ_FLAGS_TYPE_LOW_LATENCY  (0x2)
1157
1158 #define EFX_EVQ_FLAGS_NOTIFY_MASK       (0xC)
1159 #define EFX_EVQ_FLAGS_NOTIFY_INTERRUPT  (0x0)   /* Interrupting (default) */
1160 #define EFX_EVQ_FLAGS_NOTIFY_DISABLED   (0x4)   /* Non-interrupting */
1161
1162 extern  __checkReturn   efx_rc_t
1163 efx_ev_qcreate(
1164         __in            efx_nic_t *enp,
1165         __in            unsigned int index,
1166         __in            efsys_mem_t *esmp,
1167         __in            size_t n,
1168         __in            uint32_t id,
1169         __in            uint32_t us,
1170         __in            uint32_t flags,
1171         __deref_out     efx_evq_t **eepp);
1172
1173 extern          void
1174 efx_ev_qpost(
1175         __in            efx_evq_t *eep,
1176         __in            uint16_t data);
1177
1178 typedef __checkReturn   boolean_t
1179 (*efx_initialized_ev_t)(
1180         __in_opt        void *arg);
1181
1182 #define EFX_PKT_UNICAST         0x0004
1183 #define EFX_PKT_START           0x0008
1184
1185 #define EFX_PKT_VLAN_TAGGED     0x0010
1186 #define EFX_CKSUM_TCPUDP        0x0020
1187 #define EFX_CKSUM_IPV4          0x0040
1188 #define EFX_PKT_CONT            0x0080
1189
1190 #define EFX_CHECK_VLAN          0x0100
1191 #define EFX_PKT_TCP             0x0200
1192 #define EFX_PKT_UDP             0x0400
1193 #define EFX_PKT_IPV4            0x0800
1194
1195 #define EFX_PKT_IPV6            0x1000
1196 #define EFX_PKT_PREFIX_LEN      0x2000
1197 #define EFX_ADDR_MISMATCH       0x4000
1198 #define EFX_DISCARD             0x8000
1199
1200 /*
1201  * The following flags are used only for packed stream
1202  * mode. The values for the flags are reused to fit into 16 bit,
1203  * since EFX_PKT_START and EFX_PKT_CONT are never used in
1204  * packed stream mode
1205  */
1206 #define EFX_PKT_PACKED_STREAM_NEW_BUFFER        EFX_PKT_START
1207 #define EFX_PKT_PACKED_STREAM_PARSE_INCOMPLETE  EFX_PKT_CONT
1208
1209
1210 #define EFX_EV_RX_NLABELS       32
1211 #define EFX_EV_TX_NLABELS       32
1212
1213 typedef __checkReturn   boolean_t
1214 (*efx_rx_ev_t)(
1215         __in_opt        void *arg,
1216         __in            uint32_t label,
1217         __in            uint32_t id,
1218         __in            uint32_t size,
1219         __in            uint16_t flags);
1220
1221 typedef __checkReturn   boolean_t
1222 (*efx_tx_ev_t)(
1223         __in_opt        void *arg,
1224         __in            uint32_t label,
1225         __in            uint32_t id);
1226
1227 #define EFX_EXCEPTION_RX_RECOVERY       0x00000001
1228 #define EFX_EXCEPTION_RX_DSC_ERROR      0x00000002
1229 #define EFX_EXCEPTION_TX_DSC_ERROR      0x00000003
1230 #define EFX_EXCEPTION_UNKNOWN_SENSOREVT 0x00000004
1231 #define EFX_EXCEPTION_FWALERT_SRAM      0x00000005
1232 #define EFX_EXCEPTION_UNKNOWN_FWALERT   0x00000006
1233 #define EFX_EXCEPTION_RX_ERROR          0x00000007
1234 #define EFX_EXCEPTION_TX_ERROR          0x00000008
1235 #define EFX_EXCEPTION_EV_ERROR          0x00000009
1236
1237 typedef __checkReturn   boolean_t
1238 (*efx_exception_ev_t)(
1239         __in_opt        void *arg,
1240         __in            uint32_t label,
1241         __in            uint32_t data);
1242
1243 typedef __checkReturn   boolean_t
1244 (*efx_rxq_flush_done_ev_t)(
1245         __in_opt        void *arg,
1246         __in            uint32_t rxq_index);
1247
1248 typedef __checkReturn   boolean_t
1249 (*efx_rxq_flush_failed_ev_t)(
1250         __in_opt        void *arg,
1251         __in            uint32_t rxq_index);
1252
1253 typedef __checkReturn   boolean_t
1254 (*efx_txq_flush_done_ev_t)(
1255         __in_opt        void *arg,
1256         __in            uint32_t txq_index);
1257
1258 typedef __checkReturn   boolean_t
1259 (*efx_software_ev_t)(
1260         __in_opt        void *arg,
1261         __in            uint16_t magic);
1262
1263 typedef __checkReturn   boolean_t
1264 (*efx_sram_ev_t)(
1265         __in_opt        void *arg,
1266         __in            uint32_t code);
1267
1268 #define EFX_SRAM_CLEAR          0
1269 #define EFX_SRAM_UPDATE         1
1270 #define EFX_SRAM_ILLEGAL_CLEAR  2
1271
1272 typedef __checkReturn   boolean_t
1273 (*efx_wake_up_ev_t)(
1274         __in_opt        void *arg,
1275         __in            uint32_t label);
1276
1277 typedef __checkReturn   boolean_t
1278 (*efx_timer_ev_t)(
1279         __in_opt        void *arg,
1280         __in            uint32_t label);
1281
1282 typedef __checkReturn   boolean_t
1283 (*efx_link_change_ev_t)(
1284         __in_opt        void *arg,
1285         __in            efx_link_mode_t link_mode);
1286
1287 #if EFSYS_OPT_MAC_STATS
1288
1289 typedef __checkReturn   boolean_t
1290 (*efx_mac_stats_ev_t)(
1291         __in_opt        void *arg,
1292         __in            uint32_t generation
1293         );
1294
1295 #endif  /* EFSYS_OPT_MAC_STATS */
1296
1297 typedef struct efx_ev_callbacks_s {
1298         efx_initialized_ev_t            eec_initialized;
1299         efx_rx_ev_t                     eec_rx;
1300         efx_tx_ev_t                     eec_tx;
1301         efx_exception_ev_t              eec_exception;
1302         efx_rxq_flush_done_ev_t         eec_rxq_flush_done;
1303         efx_rxq_flush_failed_ev_t       eec_rxq_flush_failed;
1304         efx_txq_flush_done_ev_t         eec_txq_flush_done;
1305         efx_software_ev_t               eec_software;
1306         efx_sram_ev_t                   eec_sram;
1307         efx_wake_up_ev_t                eec_wake_up;
1308         efx_timer_ev_t                  eec_timer;
1309         efx_link_change_ev_t            eec_link_change;
1310 #if EFSYS_OPT_MAC_STATS
1311         efx_mac_stats_ev_t              eec_mac_stats;
1312 #endif  /* EFSYS_OPT_MAC_STATS */
1313 } efx_ev_callbacks_t;
1314
1315 extern  __checkReturn   boolean_t
1316 efx_ev_qpending(
1317         __in            efx_evq_t *eep,
1318         __in            unsigned int count);
1319
1320 extern                  void
1321 efx_ev_qpoll(
1322         __in            efx_evq_t *eep,
1323         __inout         unsigned int *countp,
1324         __in            const efx_ev_callbacks_t *eecp,
1325         __in_opt        void *arg);
1326
1327 extern  __checkReturn   efx_rc_t
1328 efx_ev_usecs_to_ticks(
1329         __in            efx_nic_t *enp,
1330         __in            unsigned int usecs,
1331         __out           unsigned int *ticksp);
1332
1333 extern  __checkReturn   efx_rc_t
1334 efx_ev_qmoderate(
1335         __in            efx_evq_t *eep,
1336         __in            unsigned int us);
1337
1338 extern  __checkReturn   efx_rc_t
1339 efx_ev_qprime(
1340         __in            efx_evq_t *eep,
1341         __in            unsigned int count);
1342
1343 #if EFSYS_OPT_QSTATS
1344
1345 #if EFSYS_OPT_NAMES
1346
1347 extern          const char *
1348 efx_ev_qstat_name(
1349         __in    efx_nic_t *enp,
1350         __in    unsigned int id);
1351
1352 #endif  /* EFSYS_OPT_NAMES */
1353
1354 extern                                  void
1355 efx_ev_qstats_update(
1356         __in                            efx_evq_t *eep,
1357         __inout_ecount(EV_NQSTATS)      efsys_stat_t *stat);
1358
1359 #endif  /* EFSYS_OPT_QSTATS */
1360
1361 extern          void
1362 efx_ev_qdestroy(
1363         __in    efx_evq_t *eep);
1364
1365 /* RX */
1366
1367 extern  __checkReturn   efx_rc_t
1368 efx_rx_init(
1369         __inout         efx_nic_t *enp);
1370
1371 extern          void
1372 efx_rx_fini(
1373         __in            efx_nic_t *enp);
1374
1375 extern  __checkReturn   efx_rc_t
1376 efx_pseudo_hdr_pkt_length_get(
1377         __in            efx_rxq_t *erp,
1378         __in            uint8_t *buffer,
1379         __out           uint16_t *pkt_lengthp);
1380
1381 #define EFX_RXQ_MAXNDESCS               4096
1382 #define EFX_RXQ_MINNDESCS               512
1383
1384 #define EFX_RXQ_SIZE(_ndescs)           ((_ndescs) * sizeof (efx_qword_t))
1385 #define EFX_RXQ_NBUFS(_ndescs)          (EFX_RXQ_SIZE(_ndescs) / EFX_BUF_SIZE)
1386 #define EFX_RXQ_LIMIT(_ndescs)          ((_ndescs) - 16)
1387 #define EFX_RXQ_DC_NDESCS(_dcsize)      (8 << _dcsize)
1388
1389 typedef enum efx_rxq_type_e {
1390         EFX_RXQ_TYPE_DEFAULT,
1391         EFX_RXQ_TYPE_SCATTER,
1392         EFX_RXQ_TYPE_PACKED_STREAM_1M,
1393         EFX_RXQ_TYPE_PACKED_STREAM_512K,
1394         EFX_RXQ_TYPE_PACKED_STREAM_256K,
1395         EFX_RXQ_TYPE_PACKED_STREAM_128K,
1396         EFX_RXQ_TYPE_PACKED_STREAM_64K,
1397         EFX_RXQ_NTYPES
1398 } efx_rxq_type_t;
1399
1400 extern  __checkReturn   efx_rc_t
1401 efx_rx_qcreate(
1402         __in            efx_nic_t *enp,
1403         __in            unsigned int index,
1404         __in            unsigned int label,
1405         __in            efx_rxq_type_t type,
1406         __in            efsys_mem_t *esmp,
1407         __in            size_t n,
1408         __in            uint32_t id,
1409         __in            efx_evq_t *eep,
1410         __deref_out     efx_rxq_t **erpp);
1411
1412 typedef struct efx_buffer_s {
1413         efsys_dma_addr_t        eb_addr;
1414         size_t                  eb_size;
1415         boolean_t               eb_eop;
1416 } efx_buffer_t;
1417
1418 typedef struct efx_desc_s {
1419         efx_qword_t ed_eq;
1420 } efx_desc_t;
1421
1422 extern                  void
1423 efx_rx_qpost(
1424         __in            efx_rxq_t *erp,
1425         __in_ecount(n)  efsys_dma_addr_t *addrp,
1426         __in            size_t size,
1427         __in            unsigned int n,
1428         __in            unsigned int completed,
1429         __in            unsigned int added);
1430
1431 extern          void
1432 efx_rx_qpush(
1433         __in    efx_rxq_t *erp,
1434         __in    unsigned int added,
1435         __inout unsigned int *pushedp);
1436
1437 extern  __checkReturn   efx_rc_t
1438 efx_rx_qflush(
1439         __in    efx_rxq_t *erp);
1440
1441 extern          void
1442 efx_rx_qenable(
1443         __in    efx_rxq_t *erp);
1444
1445 extern          void
1446 efx_rx_qdestroy(
1447         __in    efx_rxq_t *erp);
1448
1449 /* TX */
1450
1451 typedef struct efx_txq_s        efx_txq_t;
1452
1453 #if EFSYS_OPT_QSTATS
1454
1455 /* START MKCONFIG GENERATED EfxHeaderTransmitQueueBlock 12dff8778598b2db */
1456 typedef enum efx_tx_qstat_e {
1457         TX_POST,
1458         TX_POST_PIO,
1459         TX_NQSTATS
1460 } efx_tx_qstat_t;
1461
1462 /* END MKCONFIG GENERATED EfxHeaderTransmitQueueBlock */
1463
1464 #endif  /* EFSYS_OPT_QSTATS */
1465
1466 extern  __checkReturn   efx_rc_t
1467 efx_tx_init(
1468         __in            efx_nic_t *enp);
1469
1470 extern          void
1471 efx_tx_fini(
1472         __in    efx_nic_t *enp);
1473
1474 #define EFX_TXQ_MINNDESCS               512
1475
1476 #define EFX_TXQ_SIZE(_ndescs)           ((_ndescs) * sizeof (efx_qword_t))
1477 #define EFX_TXQ_NBUFS(_ndescs)          (EFX_TXQ_SIZE(_ndescs) / EFX_BUF_SIZE)
1478 #define EFX_TXQ_LIMIT(_ndescs)          ((_ndescs) - 16)
1479 #define EFX_TXQ_DC_NDESCS(_dcsize)      (8 << _dcsize)
1480
1481 #define EFX_TXQ_MAX_BUFS 8 /* Maximum independent of EFX_BUG35388_WORKAROUND. */
1482
1483 #define EFX_TXQ_CKSUM_IPV4      0x0001
1484 #define EFX_TXQ_CKSUM_TCPUDP    0x0002
1485 #define EFX_TXQ_FATSOV2         0x0004
1486
1487 extern  __checkReturn   efx_rc_t
1488 efx_tx_qcreate(
1489         __in            efx_nic_t *enp,
1490         __in            unsigned int index,
1491         __in            unsigned int label,
1492         __in            efsys_mem_t *esmp,
1493         __in            size_t n,
1494         __in            uint32_t id,
1495         __in            uint16_t flags,
1496         __in            efx_evq_t *eep,
1497         __deref_out     efx_txq_t **etpp,
1498         __out           unsigned int *addedp);
1499
1500 extern  __checkReturn   efx_rc_t
1501 efx_tx_qpost(
1502         __in            efx_txq_t *etp,
1503         __in_ecount(n)  efx_buffer_t *eb,
1504         __in            unsigned int n,
1505         __in            unsigned int completed,
1506         __inout         unsigned int *addedp);
1507
1508 extern  __checkReturn   efx_rc_t
1509 efx_tx_qpace(
1510         __in            efx_txq_t *etp,
1511         __in            unsigned int ns);
1512
1513 extern                  void
1514 efx_tx_qpush(
1515         __in            efx_txq_t *etp,
1516         __in            unsigned int added,
1517         __in            unsigned int pushed);
1518
1519 extern  __checkReturn   efx_rc_t
1520 efx_tx_qflush(
1521         __in            efx_txq_t *etp);
1522
1523 extern                  void
1524 efx_tx_qenable(
1525         __in            efx_txq_t *etp);
1526
1527 extern  __checkReturn   efx_rc_t
1528 efx_tx_qpio_enable(
1529         __in            efx_txq_t *etp);
1530
1531 extern                  void
1532 efx_tx_qpio_disable(
1533         __in            efx_txq_t *etp);
1534
1535 extern  __checkReturn   efx_rc_t
1536 efx_tx_qpio_write(
1537         __in                    efx_txq_t *etp,
1538         __in_ecount(buf_length) uint8_t *buffer,
1539         __in                    size_t buf_length,
1540         __in                    size_t pio_buf_offset);
1541
1542 extern  __checkReturn   efx_rc_t
1543 efx_tx_qpio_post(
1544         __in                    efx_txq_t *etp,
1545         __in                    size_t pkt_length,
1546         __in                    unsigned int completed,
1547         __inout                 unsigned int *addedp);
1548
1549 extern  __checkReturn   efx_rc_t
1550 efx_tx_qdesc_post(
1551         __in            efx_txq_t *etp,
1552         __in_ecount(n)  efx_desc_t *ed,
1553         __in            unsigned int n,
1554         __in            unsigned int completed,
1555         __inout         unsigned int *addedp);
1556
1557 extern  void
1558 efx_tx_qdesc_dma_create(
1559         __in    efx_txq_t *etp,
1560         __in    efsys_dma_addr_t addr,
1561         __in    size_t size,
1562         __in    boolean_t eop,
1563         __out   efx_desc_t *edp);
1564
1565 extern  void
1566 efx_tx_qdesc_tso_create(
1567         __in    efx_txq_t *etp,
1568         __in    uint16_t ipv4_id,
1569         __in    uint32_t tcp_seq,
1570         __in    uint8_t  tcp_flags,
1571         __out   efx_desc_t *edp);
1572
1573 /* Number of FATSOv2 option descriptors */
1574 #define EFX_TX_FATSOV2_OPT_NDESCS               2
1575
1576 /* Maximum number of DMA segments per TSO packet (not superframe) */
1577 #define EFX_TX_FATSOV2_DMA_SEGS_PER_PKT_MAX     24
1578
1579 extern  void
1580 efx_tx_qdesc_tso2_create(
1581         __in                    efx_txq_t *etp,
1582         __in                    uint16_t ipv4_id,
1583         __in                    uint32_t tcp_seq,
1584         __in                    uint16_t tcp_mss,
1585         __out_ecount(count)     efx_desc_t *edp,
1586         __in                    int count);
1587
1588 extern  void
1589 efx_tx_qdesc_vlantci_create(
1590         __in    efx_txq_t *etp,
1591         __in    uint16_t tci,
1592         __out   efx_desc_t *edp);
1593
1594 #if EFSYS_OPT_QSTATS
1595
1596 #if EFSYS_OPT_NAMES
1597
1598 extern          const char *
1599 efx_tx_qstat_name(
1600         __in    efx_nic_t *etp,
1601         __in    unsigned int id);
1602
1603 #endif  /* EFSYS_OPT_NAMES */
1604
1605 extern                                  void
1606 efx_tx_qstats_update(
1607         __in                            efx_txq_t *etp,
1608         __inout_ecount(TX_NQSTATS)      efsys_stat_t *stat);
1609
1610 #endif  /* EFSYS_OPT_QSTATS */
1611
1612 extern          void
1613 efx_tx_qdestroy(
1614         __in    efx_txq_t *etp);
1615
1616
1617 /* FILTER */
1618
1619 #if EFSYS_OPT_FILTER
1620
1621 #define EFX_ETHER_TYPE_IPV4 0x0800
1622 #define EFX_ETHER_TYPE_IPV6 0x86DD
1623
1624 #define EFX_IPPROTO_TCP 6
1625 #define EFX_IPPROTO_UDP 17
1626
1627 /* Use RSS to spread across multiple queues */
1628 #define EFX_FILTER_FLAG_RX_RSS          0x01
1629 /* Enable RX scatter */
1630 #define EFX_FILTER_FLAG_RX_SCATTER      0x02
1631 /*
1632  * Override an automatic filter (priority EFX_FILTER_PRI_AUTO).
1633  * May only be set by the filter implementation for each type.
1634  * A removal request will restore the automatic filter in its place.
1635  */
1636 #define EFX_FILTER_FLAG_RX_OVER_AUTO    0x04
1637 /* Filter is for RX */
1638 #define EFX_FILTER_FLAG_RX              0x08
1639 /* Filter is for TX */
1640 #define EFX_FILTER_FLAG_TX              0x10
1641
1642 typedef unsigned int efx_filter_flags_t;
1643
1644 typedef enum efx_filter_match_flags_e {
1645         EFX_FILTER_MATCH_REM_HOST = 0x0001,     /* Match by remote IP host
1646                                                  * address */
1647         EFX_FILTER_MATCH_LOC_HOST = 0x0002,     /* Match by local IP host
1648                                                  * address */
1649         EFX_FILTER_MATCH_REM_MAC = 0x0004,      /* Match by remote MAC address */
1650         EFX_FILTER_MATCH_REM_PORT = 0x0008,     /* Match by remote TCP/UDP port */
1651         EFX_FILTER_MATCH_LOC_MAC = 0x0010,      /* Match by remote TCP/UDP port */
1652         EFX_FILTER_MATCH_LOC_PORT = 0x0020,     /* Match by local TCP/UDP port */
1653         EFX_FILTER_MATCH_ETHER_TYPE = 0x0040,   /* Match by Ether-type */
1654         EFX_FILTER_MATCH_INNER_VID = 0x0080,    /* Match by inner VLAN ID */
1655         EFX_FILTER_MATCH_OUTER_VID = 0x0100,    /* Match by outer VLAN ID */
1656         EFX_FILTER_MATCH_IP_PROTO = 0x0200,     /* Match by IP transport
1657                                                  * protocol */
1658         EFX_FILTER_MATCH_LOC_MAC_IG = 0x0400,   /* Match by local MAC address
1659                                                  * I/G bit. Used for RX default
1660                                                  * unicast and multicast/
1661                                                  * broadcast filters. */
1662 } efx_filter_match_flags_t;
1663
1664 typedef enum efx_filter_priority_s {
1665         EFX_FILTER_PRI_HINT = 0,        /* Performance hint */
1666         EFX_FILTER_PRI_AUTO,            /* Automatic filter based on device
1667                                          * address list or hardware
1668                                          * requirements. This may only be used
1669                                          * by the filter implementation for
1670                                          * each NIC type. */
1671         EFX_FILTER_PRI_MANUAL,          /* Manually configured filter */
1672         EFX_FILTER_PRI_REQUIRED,        /* Required for correct behaviour of the
1673                                          * client (e.g. SR-IOV, HyperV VMQ etc.)
1674                                          */
1675 } efx_filter_priority_t;
1676
1677 /*
1678  * FIXME: All these fields are assumed to be in little-endian byte order.
1679  * It may be better for some to be big-endian. See bug42804.
1680  */
1681
1682 typedef struct efx_filter_spec_s {
1683         uint32_t        efs_match_flags:12;
1684         uint32_t        efs_priority:2;
1685         uint32_t        efs_flags:6;
1686         uint32_t        efs_dmaq_id:12;
1687         uint32_t        efs_rss_context;
1688         uint16_t        efs_outer_vid;
1689         uint16_t        efs_inner_vid;
1690         uint8_t         efs_loc_mac[EFX_MAC_ADDR_LEN];
1691         uint8_t         efs_rem_mac[EFX_MAC_ADDR_LEN];
1692         uint16_t        efs_ether_type;
1693         uint8_t         efs_ip_proto;
1694         uint16_t        efs_loc_port;
1695         uint16_t        efs_rem_port;
1696         efx_oword_t     efs_rem_host;
1697         efx_oword_t     efs_loc_host;
1698 } efx_filter_spec_t;
1699
1700
1701 /* Default values for use in filter specifications */
1702 #define EFX_FILTER_SPEC_RSS_CONTEXT_DEFAULT     0xffffffff
1703 #define EFX_FILTER_SPEC_RX_DMAQ_ID_DROP         0xfff
1704 #define EFX_FILTER_SPEC_VID_UNSPEC              0xffff
1705
1706 extern  __checkReturn   efx_rc_t
1707 efx_filter_init(
1708         __in            efx_nic_t *enp);
1709
1710 extern                  void
1711 efx_filter_fini(
1712         __in            efx_nic_t *enp);
1713
1714 extern  __checkReturn   efx_rc_t
1715 efx_filter_insert(
1716         __in            efx_nic_t *enp,
1717         __inout         efx_filter_spec_t *spec);
1718
1719 extern  __checkReturn   efx_rc_t
1720 efx_filter_remove(
1721         __in            efx_nic_t *enp,
1722         __inout         efx_filter_spec_t *spec);
1723
1724 extern  __checkReturn   efx_rc_t
1725 efx_filter_restore(
1726         __in            efx_nic_t *enp);
1727
1728 extern  __checkReturn   efx_rc_t
1729 efx_filter_supported_filters(
1730         __in            efx_nic_t *enp,
1731         __out           uint32_t *list,
1732         __out           size_t *length);
1733
1734 extern                  void
1735 efx_filter_spec_init_rx(
1736         __out           efx_filter_spec_t *spec,
1737         __in            efx_filter_priority_t priority,
1738         __in            efx_filter_flags_t flags,
1739         __in            efx_rxq_t *erp);
1740
1741 extern                  void
1742 efx_filter_spec_init_tx(
1743         __out           efx_filter_spec_t *spec,
1744         __in            efx_txq_t *etp);
1745
1746 extern  __checkReturn   efx_rc_t
1747 efx_filter_spec_set_ipv4_local(
1748         __inout         efx_filter_spec_t *spec,
1749         __in            uint8_t proto,
1750         __in            uint32_t host,
1751         __in            uint16_t port);
1752
1753 extern  __checkReturn   efx_rc_t
1754 efx_filter_spec_set_ipv4_full(
1755         __inout         efx_filter_spec_t *spec,
1756         __in            uint8_t proto,
1757         __in            uint32_t lhost,
1758         __in            uint16_t lport,
1759         __in            uint32_t rhost,
1760         __in            uint16_t rport);
1761
1762 extern  __checkReturn   efx_rc_t
1763 efx_filter_spec_set_eth_local(
1764         __inout         efx_filter_spec_t *spec,
1765         __in            uint16_t vid,
1766         __in            const uint8_t *addr);
1767
1768 extern  __checkReturn   efx_rc_t
1769 efx_filter_spec_set_uc_def(
1770         __inout         efx_filter_spec_t *spec);
1771
1772 extern  __checkReturn   efx_rc_t
1773 efx_filter_spec_set_mc_def(
1774         __inout         efx_filter_spec_t *spec);
1775
1776 #endif  /* EFSYS_OPT_FILTER */
1777
1778 /* HASH */
1779
1780 extern  __checkReturn           uint32_t
1781 efx_hash_dwords(
1782         __in_ecount(count)      uint32_t const *input,
1783         __in                    size_t count,
1784         __in                    uint32_t init);
1785
1786 extern  __checkReturn           uint32_t
1787 efx_hash_bytes(
1788         __in_ecount(length)     uint8_t const *input,
1789         __in                    size_t length,
1790         __in                    uint32_t init);
1791
1792
1793
1794 #ifdef  __cplusplus
1795 }
1796 #endif
1797
1798 #endif  /* _SYS_EFX_H */