sys/dev/sfxge/common/efx.h

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