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 /* NVRAM */
1245
1246 #if EFSYS_OPT_DIAG
1247
1248 typedef enum efx_pattern_type_t {
1249         EFX_PATTERN_BYTE_INCREMENT = 0,
1250         EFX_PATTERN_ALL_THE_SAME,
1251         EFX_PATTERN_BIT_ALTERNATE,
1252         EFX_PATTERN_BYTE_ALTERNATE,
1253         EFX_PATTERN_BYTE_CHANGING,
1254         EFX_PATTERN_BIT_SWEEP,
1255         EFX_PATTERN_NTYPES
1256 } efx_pattern_type_t;
1257
1258 typedef                 void
1259 (*efx_sram_pattern_fn_t)(
1260         __in            size_t row,
1261         __in            boolean_t negate,
1262         __out           efx_qword_t *eqp);
1263
1264 extern  __checkReturn   efx_rc_t
1265 efx_sram_test(
1266         __in            efx_nic_t *enp,
1267         __in            efx_pattern_type_t type);
1268
1269 #endif  /* EFSYS_OPT_DIAG */
1270
1271 extern  __checkReturn   efx_rc_t
1272 efx_sram_buf_tbl_set(
1273         __in            efx_nic_t *enp,
1274         __in            uint32_t id,
1275         __in            efsys_mem_t *esmp,
1276         __in            size_t n);
1277
1278 extern          void
1279 efx_sram_buf_tbl_clear(
1280         __in    efx_nic_t *enp,
1281         __in    uint32_t id,
1282         __in    size_t n);
1283
1284 #define EFX_BUF_TBL_SIZE        0x20000
1285
1286 #define EFX_BUF_SIZE            4096
1287
1288 /* EV */
1289
1290 typedef struct efx_evq_s        efx_evq_t;
1291
1292 #if EFSYS_OPT_QSTATS
1293
1294 /* START MKCONFIG GENERATED EfxHeaderEventQueueBlock 6f3843f5fe7cc843 */
1295 typedef enum efx_ev_qstat_e {
1296         EV_ALL,
1297         EV_RX,
1298         EV_RX_OK,
1299         EV_RX_FRM_TRUNC,
1300         EV_RX_TOBE_DISC,
1301         EV_RX_PAUSE_FRM_ERR,
1302         EV_RX_BUF_OWNER_ID_ERR,
1303         EV_RX_IPV4_HDR_CHKSUM_ERR,
1304         EV_RX_TCP_UDP_CHKSUM_ERR,
1305         EV_RX_ETH_CRC_ERR,
1306         EV_RX_IP_FRAG_ERR,
1307         EV_RX_MCAST_PKT,
1308         EV_RX_MCAST_HASH_MATCH,
1309         EV_RX_TCP_IPV4,
1310         EV_RX_TCP_IPV6,
1311         EV_RX_UDP_IPV4,
1312         EV_RX_UDP_IPV6,
1313         EV_RX_OTHER_IPV4,
1314         EV_RX_OTHER_IPV6,
1315         EV_RX_NON_IP,
1316         EV_RX_BATCH,
1317         EV_TX,
1318         EV_TX_WQ_FF_FULL,
1319         EV_TX_PKT_ERR,
1320         EV_TX_PKT_TOO_BIG,
1321         EV_TX_UNEXPECTED,
1322         EV_GLOBAL,
1323         EV_GLOBAL_MNT,
1324         EV_DRIVER,
1325         EV_DRIVER_SRM_UPD_DONE,
1326         EV_DRIVER_TX_DESCQ_FLS_DONE,
1327         EV_DRIVER_RX_DESCQ_FLS_DONE,
1328         EV_DRIVER_RX_DESCQ_FLS_FAILED,
1329         EV_DRIVER_RX_DSC_ERROR,
1330         EV_DRIVER_TX_DSC_ERROR,
1331         EV_DRV_GEN,
1332         EV_MCDI_RESPONSE,
1333         EV_NQSTATS
1334 } efx_ev_qstat_t;
1335
1336 /* END MKCONFIG GENERATED EfxHeaderEventQueueBlock */
1337
1338 #endif  /* EFSYS_OPT_QSTATS */
1339
1340 extern  __checkReturn   efx_rc_t
1341 efx_ev_init(
1342         __in            efx_nic_t *enp);
1343
1344 extern          void
1345 efx_ev_fini(
1346         __in            efx_nic_t *enp);
1347
1348 #define EFX_EVQ_MAXNEVS         32768
1349 #define EFX_EVQ_MINNEVS         512
1350
1351 #define EFX_EVQ_SIZE(_nevs)     ((_nevs) * sizeof (efx_qword_t))
1352 #define EFX_EVQ_NBUFS(_nevs)    (EFX_EVQ_SIZE(_nevs) / EFX_BUF_SIZE)
1353
1354 #define EFX_EVQ_FLAGS_TYPE_MASK         (0x3)
1355 #define EFX_EVQ_FLAGS_TYPE_AUTO         (0x0)
1356 #define EFX_EVQ_FLAGS_TYPE_THROUGHPUT   (0x1)
1357 #define EFX_EVQ_FLAGS_TYPE_LOW_LATENCY  (0x2)
1358
1359 #define EFX_EVQ_FLAGS_NOTIFY_MASK       (0xC)
1360 #define EFX_EVQ_FLAGS_NOTIFY_INTERRUPT  (0x0)   /* Interrupting (default) */
1361 #define EFX_EVQ_FLAGS_NOTIFY_DISABLED   (0x4)   /* Non-interrupting */
1362
1363 extern  __checkReturn   efx_rc_t
1364 efx_ev_qcreate(
1365         __in            efx_nic_t *enp,
1366         __in            unsigned int index,
1367         __in            efsys_mem_t *esmp,
1368         __in            size_t n,
1369         __in            uint32_t id,
1370         __in            uint32_t us,
1371         __in            uint32_t flags,
1372         __deref_out     efx_evq_t **eepp);
1373
1374 extern          void
1375 efx_ev_qpost(
1376         __in            efx_evq_t *eep,
1377         __in            uint16_t data);
1378
1379 typedef __checkReturn   boolean_t
1380 (*efx_initialized_ev_t)(
1381         __in_opt        void *arg);
1382
1383 #define EFX_PKT_UNICAST         0x0004
1384 #define EFX_PKT_START           0x0008
1385
1386 #define EFX_PKT_VLAN_TAGGED     0x0010
1387 #define EFX_CKSUM_TCPUDP        0x0020
1388 #define EFX_CKSUM_IPV4          0x0040
1389 #define EFX_PKT_CONT            0x0080
1390
1391 #define EFX_CHECK_VLAN          0x0100
1392 #define EFX_PKT_TCP             0x0200
1393 #define EFX_PKT_UDP             0x0400
1394 #define EFX_PKT_IPV4            0x0800
1395
1396 #define EFX_PKT_IPV6            0x1000
1397 #define EFX_PKT_PREFIX_LEN      0x2000
1398 #define EFX_ADDR_MISMATCH       0x4000
1399 #define EFX_DISCARD             0x8000
1400
1401 /*
1402  * The following flags are used only for packed stream
1403  * mode. The values for the flags are reused to fit into 16 bit,
1404  * since EFX_PKT_START and EFX_PKT_CONT are never used in
1405  * packed stream mode
1406  */
1407 #define EFX_PKT_PACKED_STREAM_NEW_BUFFER        EFX_PKT_START
1408 #define EFX_PKT_PACKED_STREAM_PARSE_INCOMPLETE  EFX_PKT_CONT
1409
1410
1411 #define EFX_EV_RX_NLABELS       32
1412 #define EFX_EV_TX_NLABELS       32
1413
1414 typedef __checkReturn   boolean_t
1415 (*efx_rx_ev_t)(
1416         __in_opt        void *arg,
1417         __in            uint32_t label,
1418         __in            uint32_t id,
1419         __in            uint32_t size,
1420         __in            uint16_t flags);
1421
1422 typedef __checkReturn   boolean_t
1423 (*efx_tx_ev_t)(
1424         __in_opt        void *arg,
1425         __in            uint32_t label,
1426         __in            uint32_t id);
1427
1428 #define EFX_EXCEPTION_RX_RECOVERY       0x00000001
1429 #define EFX_EXCEPTION_RX_DSC_ERROR      0x00000002
1430 #define EFX_EXCEPTION_TX_DSC_ERROR      0x00000003
1431 #define EFX_EXCEPTION_UNKNOWN_SENSOREVT 0x00000004
1432 #define EFX_EXCEPTION_FWALERT_SRAM      0x00000005
1433 #define EFX_EXCEPTION_UNKNOWN_FWALERT   0x00000006
1434 #define EFX_EXCEPTION_RX_ERROR          0x00000007
1435 #define EFX_EXCEPTION_TX_ERROR          0x00000008
1436 #define EFX_EXCEPTION_EV_ERROR          0x00000009
1437
1438 typedef __checkReturn   boolean_t
1439 (*efx_exception_ev_t)(
1440         __in_opt        void *arg,
1441         __in            uint32_t label,
1442         __in            uint32_t data);
1443
1444 typedef __checkReturn   boolean_t
1445 (*efx_rxq_flush_done_ev_t)(
1446         __in_opt        void *arg,
1447         __in            uint32_t rxq_index);
1448
1449 typedef __checkReturn   boolean_t
1450 (*efx_rxq_flush_failed_ev_t)(
1451         __in_opt        void *arg,
1452         __in            uint32_t rxq_index);
1453
1454 typedef __checkReturn   boolean_t
1455 (*efx_txq_flush_done_ev_t)(
1456         __in_opt        void *arg,
1457         __in            uint32_t txq_index);
1458
1459 typedef __checkReturn   boolean_t
1460 (*efx_software_ev_t)(
1461         __in_opt        void *arg,
1462         __in            uint16_t magic);
1463
1464 typedef __checkReturn   boolean_t
1465 (*efx_sram_ev_t)(
1466         __in_opt        void *arg,
1467         __in            uint32_t code);
1468
1469 #define EFX_SRAM_CLEAR          0
1470 #define EFX_SRAM_UPDATE         1
1471 #define EFX_SRAM_ILLEGAL_CLEAR  2
1472
1473 typedef __checkReturn   boolean_t
1474 (*efx_wake_up_ev_t)(
1475         __in_opt        void *arg,
1476         __in            uint32_t label);
1477
1478 typedef __checkReturn   boolean_t
1479 (*efx_timer_ev_t)(
1480         __in_opt        void *arg,
1481         __in            uint32_t label);
1482
1483 typedef __checkReturn   boolean_t
1484 (*efx_link_change_ev_t)(
1485         __in_opt        void *arg,
1486         __in            efx_link_mode_t link_mode);
1487
1488 #if EFSYS_OPT_MON_STATS
1489
1490 typedef __checkReturn   boolean_t
1491 (*efx_monitor_ev_t)(
1492         __in_opt        void *arg,
1493         __in            efx_mon_stat_t id,
1494         __in            efx_mon_stat_value_t value);
1495
1496 #endif  /* EFSYS_OPT_MON_STATS */
1497
1498 #if EFSYS_OPT_MAC_STATS
1499
1500 typedef __checkReturn   boolean_t
1501 (*efx_mac_stats_ev_t)(
1502         __in_opt        void *arg,
1503         __in            uint32_t generation
1504         );
1505
1506 #endif  /* EFSYS_OPT_MAC_STATS */
1507
1508 typedef struct efx_ev_callbacks_s {
1509         efx_initialized_ev_t            eec_initialized;
1510         efx_rx_ev_t                     eec_rx;
1511         efx_tx_ev_t                     eec_tx;
1512         efx_exception_ev_t              eec_exception;
1513         efx_rxq_flush_done_ev_t         eec_rxq_flush_done;
1514         efx_rxq_flush_failed_ev_t       eec_rxq_flush_failed;
1515         efx_txq_flush_done_ev_t         eec_txq_flush_done;
1516         efx_software_ev_t               eec_software;
1517         efx_sram_ev_t                   eec_sram;
1518         efx_wake_up_ev_t                eec_wake_up;
1519         efx_timer_ev_t                  eec_timer;
1520         efx_link_change_ev_t            eec_link_change;
1521 #if EFSYS_OPT_MON_STATS
1522         efx_monitor_ev_t                eec_monitor;
1523 #endif  /* EFSYS_OPT_MON_STATS */
1524 #if EFSYS_OPT_MAC_STATS
1525         efx_mac_stats_ev_t              eec_mac_stats;
1526 #endif  /* EFSYS_OPT_MAC_STATS */
1527 } efx_ev_callbacks_t;
1528
1529 extern  __checkReturn   boolean_t
1530 efx_ev_qpending(
1531         __in            efx_evq_t *eep,
1532         __in            unsigned int count);
1533
1534 #if EFSYS_OPT_EV_PREFETCH
1535
1536 extern                  void
1537 efx_ev_qprefetch(
1538         __in            efx_evq_t *eep,
1539         __in            unsigned int count);
1540
1541 #endif  /* EFSYS_OPT_EV_PREFETCH */
1542
1543 extern                  void
1544 efx_ev_qpoll(
1545         __in            efx_evq_t *eep,
1546         __inout         unsigned int *countp,
1547         __in            const efx_ev_callbacks_t *eecp,
1548         __in_opt        void *arg);
1549
1550 extern  __checkReturn   efx_rc_t
1551 efx_ev_usecs_to_ticks(
1552         __in            efx_nic_t *enp,
1553         __in            unsigned int usecs,
1554         __out           unsigned int *ticksp);
1555
1556 extern  __checkReturn   efx_rc_t
1557 efx_ev_qmoderate(
1558         __in            efx_evq_t *eep,
1559         __in            unsigned int us);
1560
1561 extern  __checkReturn   efx_rc_t
1562 efx_ev_qprime(
1563         __in            efx_evq_t *eep,
1564         __in            unsigned int count);
1565
1566 #if EFSYS_OPT_QSTATS
1567
1568 #if EFSYS_OPT_NAMES
1569
1570 extern          const char *
1571 efx_ev_qstat_name(
1572         __in    efx_nic_t *enp,
1573         __in    unsigned int id);
1574
1575 #endif  /* EFSYS_OPT_NAMES */
1576
1577 extern                                  void
1578 efx_ev_qstats_update(
1579         __in                            efx_evq_t *eep,
1580         __inout_ecount(EV_NQSTATS)      efsys_stat_t *stat);
1581
1582 #endif  /* EFSYS_OPT_QSTATS */
1583
1584 extern          void
1585 efx_ev_qdestroy(
1586         __in    efx_evq_t *eep);
1587
1588 /* RX */
1589
1590 extern  __checkReturn   efx_rc_t
1591 efx_rx_init(
1592         __inout         efx_nic_t *enp);
1593
1594 extern          void
1595 efx_rx_fini(
1596         __in            efx_nic_t *enp);
1597
1598 #if EFSYS_OPT_RX_SCATTER
1599         __checkReturn   efx_rc_t
1600 efx_rx_scatter_enable(
1601         __in            efx_nic_t *enp,
1602         __in            unsigned int buf_size);
1603 #endif  /* EFSYS_OPT_RX_SCATTER */
1604
1605 #if EFSYS_OPT_RX_SCALE
1606
1607 typedef enum efx_rx_hash_alg_e {
1608         EFX_RX_HASHALG_LFSR = 0,
1609         EFX_RX_HASHALG_TOEPLITZ
1610 } efx_rx_hash_alg_t;
1611
1612 typedef enum efx_rx_hash_type_e {
1613         EFX_RX_HASH_IPV4 = 0,
1614         EFX_RX_HASH_TCPIPV4,
1615         EFX_RX_HASH_IPV6,
1616         EFX_RX_HASH_TCPIPV6,
1617 } efx_rx_hash_type_t;
1618
1619 typedef enum efx_rx_hash_support_e {
1620         EFX_RX_HASH_UNAVAILABLE = 0,    /* Hardware hash not inserted */
1621         EFX_RX_HASH_AVAILABLE           /* Insert hash with/without RSS */
1622 } efx_rx_hash_support_t;
1623
1624 #define EFX_RSS_TBL_SIZE        128     /* Rows in RX indirection table */
1625 #define EFX_MAXRSS              64      /* RX indirection entry range */
1626 #define EFX_MAXRSS_LEGACY       16      /* See bug16611 and bug17213 */
1627
1628 typedef enum efx_rx_scale_support_e {
1629         EFX_RX_SCALE_UNAVAILABLE = 0,   /* Not supported */
1630         EFX_RX_SCALE_EXCLUSIVE,         /* Writable key/indirection table */
1631         EFX_RX_SCALE_SHARED             /* Read-only key/indirection table */
1632 } efx_rx_scale_support_t;
1633
1634 extern  __checkReturn   efx_rc_t
1635 efx_rx_hash_support_get(
1636         __in            efx_nic_t *enp,
1637         __out           efx_rx_hash_support_t *supportp);
1638
1639
1640 extern  __checkReturn   efx_rc_t
1641 efx_rx_scale_support_get(
1642         __in            efx_nic_t *enp,
1643         __out           efx_rx_scale_support_t *supportp);
1644
1645 extern  __checkReturn   efx_rc_t
1646 efx_rx_scale_mode_set(
1647         __in    efx_nic_t *enp,
1648         __in    efx_rx_hash_alg_t alg,
1649         __in    efx_rx_hash_type_t type,
1650         __in    boolean_t insert);
1651
1652 extern  __checkReturn   efx_rc_t
1653 efx_rx_scale_tbl_set(
1654         __in            efx_nic_t *enp,
1655         __in_ecount(n)  unsigned int *table,
1656         __in            size_t n);
1657
1658 extern  __checkReturn   efx_rc_t
1659 efx_rx_scale_key_set(
1660         __in            efx_nic_t *enp,
1661         __in_ecount(n)  uint8_t *key,
1662         __in            size_t n);
1663
1664 extern  __checkReturn   uint32_t
1665 efx_pseudo_hdr_hash_get(
1666         __in            efx_rxq_t *erp,
1667         __in            efx_rx_hash_alg_t func,
1668         __in            uint8_t *buffer);
1669
1670 #endif  /* EFSYS_OPT_RX_SCALE */
1671
1672 extern  __checkReturn   efx_rc_t
1673 efx_pseudo_hdr_pkt_length_get(
1674         __in            efx_rxq_t *erp,
1675         __in            uint8_t *buffer,
1676         __out           uint16_t *pkt_lengthp);
1677
1678 #define EFX_RXQ_MAXNDESCS               4096
1679 #define EFX_RXQ_MINNDESCS               512
1680
1681 #define EFX_RXQ_SIZE(_ndescs)           ((_ndescs) * sizeof (efx_qword_t))
1682 #define EFX_RXQ_NBUFS(_ndescs)          (EFX_RXQ_SIZE(_ndescs) / EFX_BUF_SIZE)
1683 #define EFX_RXQ_LIMIT(_ndescs)          ((_ndescs) - 16)
1684 #define EFX_RXQ_DC_NDESCS(_dcsize)      (8 << _dcsize)
1685
1686 typedef enum efx_rxq_type_e {
1687         EFX_RXQ_TYPE_DEFAULT,
1688         EFX_RXQ_TYPE_SCATTER,
1689         EFX_RXQ_TYPE_PACKED_STREAM_1M,
1690         EFX_RXQ_TYPE_PACKED_STREAM_512K,
1691         EFX_RXQ_TYPE_PACKED_STREAM_256K,
1692         EFX_RXQ_TYPE_PACKED_STREAM_128K,
1693         EFX_RXQ_TYPE_PACKED_STREAM_64K,
1694         EFX_RXQ_NTYPES
1695 } efx_rxq_type_t;
1696
1697 extern  __checkReturn   efx_rc_t
1698 efx_rx_qcreate(
1699         __in            efx_nic_t *enp,
1700         __in            unsigned int index,
1701         __in            unsigned int label,
1702         __in            efx_rxq_type_t type,
1703         __in            efsys_mem_t *esmp,
1704         __in            size_t n,
1705         __in            uint32_t id,
1706         __in            efx_evq_t *eep,
1707         __deref_out     efx_rxq_t **erpp);
1708
1709 typedef struct efx_buffer_s {
1710         efsys_dma_addr_t        eb_addr;
1711         size_t                  eb_size;
1712         boolean_t               eb_eop;
1713 } efx_buffer_t;
1714
1715 typedef struct efx_desc_s {
1716         efx_qword_t ed_eq;
1717 } efx_desc_t;
1718
1719 extern                  void
1720 efx_rx_qpost(
1721         __in            efx_rxq_t *erp,
1722         __in_ecount(n)  efsys_dma_addr_t *addrp,
1723         __in            size_t size,
1724         __in            unsigned int n,
1725         __in            unsigned int completed,
1726         __in            unsigned int added);
1727
1728 extern          void
1729 efx_rx_qpush(
1730         __in    efx_rxq_t *erp,
1731         __in    unsigned int added,
1732         __inout unsigned int *pushedp);
1733
1734 extern  __checkReturn   efx_rc_t
1735 efx_rx_qflush(
1736         __in    efx_rxq_t *erp);
1737
1738 extern          void
1739 efx_rx_qenable(
1740         __in    efx_rxq_t *erp);
1741
1742 extern          void
1743 efx_rx_qdestroy(
1744         __in    efx_rxq_t *erp);
1745
1746 /* TX */
1747
1748 typedef struct efx_txq_s        efx_txq_t;
1749
1750 #if EFSYS_OPT_QSTATS
1751
1752 /* START MKCONFIG GENERATED EfxHeaderTransmitQueueBlock 12dff8778598b2db */
1753 typedef enum efx_tx_qstat_e {
1754         TX_POST,
1755         TX_POST_PIO,
1756         TX_NQSTATS
1757 } efx_tx_qstat_t;
1758
1759 /* END MKCONFIG GENERATED EfxHeaderTransmitQueueBlock */
1760
1761 #endif  /* EFSYS_OPT_QSTATS */
1762
1763 extern  __checkReturn   efx_rc_t
1764 efx_tx_init(
1765         __in            efx_nic_t *enp);
1766
1767 extern          void
1768 efx_tx_fini(
1769         __in    efx_nic_t *enp);
1770
1771 #define EFX_TXQ_MINNDESCS               512
1772
1773 #define EFX_TXQ_SIZE(_ndescs)           ((_ndescs) * sizeof (efx_qword_t))
1774 #define EFX_TXQ_NBUFS(_ndescs)          (EFX_TXQ_SIZE(_ndescs) / EFX_BUF_SIZE)
1775 #define EFX_TXQ_LIMIT(_ndescs)          ((_ndescs) - 16)
1776 #define EFX_TXQ_DC_NDESCS(_dcsize)      (8 << _dcsize)
1777
1778 #define EFX_TXQ_MAX_BUFS 8 /* Maximum independent of EFX_BUG35388_WORKAROUND. */
1779
1780 #define EFX_TXQ_CKSUM_IPV4      0x0001
1781 #define EFX_TXQ_CKSUM_TCPUDP    0x0002
1782 #define EFX_TXQ_FATSOV2         0x0004
1783
1784 extern  __checkReturn   efx_rc_t
1785 efx_tx_qcreate(
1786         __in            efx_nic_t *enp,
1787         __in            unsigned int index,
1788         __in            unsigned int label,
1789         __in            efsys_mem_t *esmp,
1790         __in            size_t n,
1791         __in            uint32_t id,
1792         __in            uint16_t flags,
1793         __in            efx_evq_t *eep,
1794         __deref_out     efx_txq_t **etpp,
1795         __out           unsigned int *addedp);
1796
1797 extern  __checkReturn   efx_rc_t
1798 efx_tx_qpost(
1799         __in            efx_txq_t *etp,
1800         __in_ecount(n)  efx_buffer_t *eb,
1801         __in            unsigned int n,
1802         __in            unsigned int completed,
1803         __inout         unsigned int *addedp);
1804
1805 extern  __checkReturn   efx_rc_t
1806 efx_tx_qpace(
1807         __in            efx_txq_t *etp,
1808         __in            unsigned int ns);
1809
1810 extern                  void
1811 efx_tx_qpush(
1812         __in            efx_txq_t *etp,
1813         __in            unsigned int added,
1814         __in            unsigned int pushed);
1815
1816 extern  __checkReturn   efx_rc_t
1817 efx_tx_qflush(
1818         __in            efx_txq_t *etp);
1819
1820 extern                  void
1821 efx_tx_qenable(
1822         __in            efx_txq_t *etp);
1823
1824 extern  __checkReturn   efx_rc_t
1825 efx_tx_qpio_enable(
1826         __in            efx_txq_t *etp);
1827
1828 extern                  void
1829 efx_tx_qpio_disable(
1830         __in            efx_txq_t *etp);
1831
1832 extern  __checkReturn   efx_rc_t
1833 efx_tx_qpio_write(
1834         __in                    efx_txq_t *etp,
1835         __in_ecount(buf_length) uint8_t *buffer,
1836         __in                    size_t buf_length,
1837         __in                    size_t pio_buf_offset);
1838
1839 extern  __checkReturn   efx_rc_t
1840 efx_tx_qpio_post(
1841         __in                    efx_txq_t *etp,
1842         __in                    size_t pkt_length,
1843         __in                    unsigned int completed,
1844         __inout                 unsigned int *addedp);
1845
1846 extern  __checkReturn   efx_rc_t
1847 efx_tx_qdesc_post(
1848         __in            efx_txq_t *etp,
1849         __in_ecount(n)  efx_desc_t *ed,
1850         __in            unsigned int n,
1851         __in            unsigned int completed,
1852         __inout         unsigned int *addedp);
1853
1854 extern  void
1855 efx_tx_qdesc_dma_create(
1856         __in    efx_txq_t *etp,
1857         __in    efsys_dma_addr_t addr,
1858         __in    size_t size,
1859         __in    boolean_t eop,
1860         __out   efx_desc_t *edp);
1861
1862 extern  void
1863 efx_tx_qdesc_tso_create(
1864         __in    efx_txq_t *etp,
1865         __in    uint16_t ipv4_id,
1866         __in    uint32_t tcp_seq,
1867         __in    uint8_t  tcp_flags,
1868         __out   efx_desc_t *edp);
1869
1870 /* Number of FATSOv2 option descriptors */
1871 #define EFX_TX_FATSOV2_OPT_NDESCS               2
1872
1873 /* Maximum number of DMA segments per TSO packet (not superframe) */
1874 #define EFX_TX_FATSOV2_DMA_SEGS_PER_PKT_MAX     24
1875
1876 extern  void
1877 efx_tx_qdesc_tso2_create(
1878         __in                    efx_txq_t *etp,
1879         __in                    uint16_t ipv4_id,
1880         __in                    uint32_t tcp_seq,
1881         __in                    uint16_t tcp_mss,
1882         __out_ecount(count)     efx_desc_t *edp,
1883         __in                    int count);
1884
1885 extern  void
1886 efx_tx_qdesc_vlantci_create(
1887         __in    efx_txq_t *etp,
1888         __in    uint16_t tci,
1889         __out   efx_desc_t *edp);
1890
1891 #if EFSYS_OPT_QSTATS
1892
1893 #if EFSYS_OPT_NAMES
1894
1895 extern          const char *
1896 efx_tx_qstat_name(
1897         __in    efx_nic_t *etp,
1898         __in    unsigned int id);
1899
1900 #endif  /* EFSYS_OPT_NAMES */
1901
1902 extern                                  void
1903 efx_tx_qstats_update(
1904         __in                            efx_txq_t *etp,
1905         __inout_ecount(TX_NQSTATS)      efsys_stat_t *stat);
1906
1907 #endif  /* EFSYS_OPT_QSTATS */
1908
1909 extern          void
1910 efx_tx_qdestroy(
1911         __in    efx_txq_t *etp);
1912
1913
1914 /* FILTER */
1915
1916 #if EFSYS_OPT_FILTER
1917
1918 #define EFX_ETHER_TYPE_IPV4 0x0800
1919 #define EFX_ETHER_TYPE_IPV6 0x86DD
1920
1921 #define EFX_IPPROTO_TCP 6
1922 #define EFX_IPPROTO_UDP 17
1923
1924 /* Use RSS to spread across multiple queues */
1925 #define EFX_FILTER_FLAG_RX_RSS          0x01
1926 /* Enable RX scatter */
1927 #define EFX_FILTER_FLAG_RX_SCATTER      0x02
1928 /*
1929  * Override an automatic filter (priority EFX_FILTER_PRI_AUTO).
1930  * May only be set by the filter implementation for each type.
1931  * A removal request will restore the automatic filter in its place.
1932  */
1933 #define EFX_FILTER_FLAG_RX_OVER_AUTO    0x04
1934 /* Filter is for RX */
1935 #define EFX_FILTER_FLAG_RX              0x08
1936 /* Filter is for TX */
1937 #define EFX_FILTER_FLAG_TX              0x10
1938
1939 typedef unsigned int efx_filter_flags_t;
1940
1941 typedef enum efx_filter_match_flags_e {
1942         EFX_FILTER_MATCH_REM_HOST = 0x0001,     /* Match by remote IP host
1943                                                  * address */
1944         EFX_FILTER_MATCH_LOC_HOST = 0x0002,     /* Match by local IP host
1945                                                  * address */
1946         EFX_FILTER_MATCH_REM_MAC = 0x0004,      /* Match by remote MAC address */
1947         EFX_FILTER_MATCH_REM_PORT = 0x0008,     /* Match by remote TCP/UDP port */
1948         EFX_FILTER_MATCH_LOC_MAC = 0x0010,      /* Match by remote TCP/UDP port */
1949         EFX_FILTER_MATCH_LOC_PORT = 0x0020,     /* Match by local TCP/UDP port */
1950         EFX_FILTER_MATCH_ETHER_TYPE = 0x0040,   /* Match by Ether-type */
1951         EFX_FILTER_MATCH_INNER_VID = 0x0080,    /* Match by inner VLAN ID */
1952         EFX_FILTER_MATCH_OUTER_VID = 0x0100,    /* Match by outer VLAN ID */
1953         EFX_FILTER_MATCH_IP_PROTO = 0x0200,     /* Match by IP transport
1954                                                  * protocol */
1955         EFX_FILTER_MATCH_LOC_MAC_IG = 0x0400,   /* Match by local MAC address
1956                                                  * I/G bit. Used for RX default
1957                                                  * unicast and multicast/
1958                                                  * broadcast filters. */
1959 } efx_filter_match_flags_t;
1960
1961 typedef enum efx_filter_priority_s {
1962         EFX_FILTER_PRI_HINT = 0,        /* Performance hint */
1963         EFX_FILTER_PRI_AUTO,            /* Automatic filter based on device
1964                                          * address list or hardware
1965                                          * requirements. This may only be used
1966                                          * by the filter implementation for
1967                                          * each NIC type. */
1968         EFX_FILTER_PRI_MANUAL,          /* Manually configured filter */
1969         EFX_FILTER_PRI_REQUIRED,        /* Required for correct behaviour of the
1970                                          * client (e.g. SR-IOV, HyperV VMQ etc.)
1971                                          */
1972 } efx_filter_priority_t;
1973
1974 /*
1975  * FIXME: All these fields are assumed to be in little-endian byte order.
1976  * It may be better for some to be big-endian. See bug42804.
1977  */
1978
1979 typedef struct efx_filter_spec_s {
1980         uint32_t        efs_match_flags:12;
1981         uint32_t        efs_priority:2;
1982         uint32_t        efs_flags:6;
1983         uint32_t        efs_dmaq_id:12;
1984         uint32_t        efs_rss_context;
1985         uint16_t        efs_outer_vid;
1986         uint16_t        efs_inner_vid;
1987         uint8_t         efs_loc_mac[EFX_MAC_ADDR_LEN];
1988         uint8_t         efs_rem_mac[EFX_MAC_ADDR_LEN];
1989         uint16_t        efs_ether_type;
1990         uint8_t         efs_ip_proto;
1991         uint16_t        efs_loc_port;
1992         uint16_t        efs_rem_port;
1993         efx_oword_t     efs_rem_host;
1994         efx_oword_t     efs_loc_host;
1995 } efx_filter_spec_t;
1996
1997
1998 /* Default values for use in filter specifications */
1999 #define EFX_FILTER_SPEC_RSS_CONTEXT_DEFAULT     0xffffffff
2000 #define EFX_FILTER_SPEC_RX_DMAQ_ID_DROP         0xfff
2001 #define EFX_FILTER_SPEC_VID_UNSPEC              0xffff
2002
2003 extern  __checkReturn   efx_rc_t
2004 efx_filter_init(
2005         __in            efx_nic_t *enp);
2006
2007 extern                  void
2008 efx_filter_fini(
2009         __in            efx_nic_t *enp);
2010
2011 extern  __checkReturn   efx_rc_t
2012 efx_filter_insert(
2013         __in            efx_nic_t *enp,
2014         __inout         efx_filter_spec_t *spec);
2015
2016 extern  __checkReturn   efx_rc_t
2017 efx_filter_remove(
2018         __in            efx_nic_t *enp,
2019         __inout         efx_filter_spec_t *spec);
2020
2021 extern  __checkReturn   efx_rc_t
2022 efx_filter_restore(
2023         __in            efx_nic_t *enp);
2024
2025 extern  __checkReturn   efx_rc_t
2026 efx_filter_supported_filters(
2027         __in            efx_nic_t *enp,
2028         __out           uint32_t *list,
2029         __out           size_t *length);
2030
2031 extern                  void
2032 efx_filter_spec_init_rx(
2033         __out           efx_filter_spec_t *spec,
2034         __in            efx_filter_priority_t priority,
2035         __in            efx_filter_flags_t flags,
2036         __in            efx_rxq_t *erp);
2037
2038 extern                  void
2039 efx_filter_spec_init_tx(
2040         __out           efx_filter_spec_t *spec,
2041         __in            efx_txq_t *etp);
2042
2043 extern  __checkReturn   efx_rc_t
2044 efx_filter_spec_set_ipv4_local(
2045         __inout         efx_filter_spec_t *spec,
2046         __in            uint8_t proto,
2047         __in            uint32_t host,
2048         __in            uint16_t port);
2049
2050 extern  __checkReturn   efx_rc_t
2051 efx_filter_spec_set_ipv4_full(
2052         __inout         efx_filter_spec_t *spec,
2053         __in            uint8_t proto,
2054         __in            uint32_t lhost,
2055         __in            uint16_t lport,
2056         __in            uint32_t rhost,
2057         __in            uint16_t rport);
2058
2059 extern  __checkReturn   efx_rc_t
2060 efx_filter_spec_set_eth_local(
2061         __inout         efx_filter_spec_t *spec,
2062         __in            uint16_t vid,
2063         __in            const uint8_t *addr);
2064
2065 extern  __checkReturn   efx_rc_t
2066 efx_filter_spec_set_uc_def(
2067         __inout         efx_filter_spec_t *spec);
2068
2069 extern  __checkReturn   efx_rc_t
2070 efx_filter_spec_set_mc_def(
2071         __inout         efx_filter_spec_t *spec);
2072
2073 #endif  /* EFSYS_OPT_FILTER */
2074
2075 /* HASH */
2076
2077 extern  __checkReturn           uint32_t
2078 efx_hash_dwords(
2079         __in_ecount(count)      uint32_t const *input,
2080         __in                    size_t count,
2081         __in                    uint32_t init);
2082
2083 extern  __checkReturn           uint32_t
2084 efx_hash_bytes(
2085         __in_ecount(length)     uint8_t const *input,
2086         __in                    size_t length,
2087         __in                    uint32_t init);
2088
2089
2090
2091 #ifdef  __cplusplus
2092 }
2093 #endif
2094
2095 #endif  /* _SYS_EFX_H */