drivers/net/sfc/base/efx.h

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