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