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_NTYPES
 598 } efx_mon_type_t;
 599
 600 #if EFSYS_OPT_NAMES
 601
 602 extern          const char *
 603 efx_mon_name(
 604         __in    efx_nic_t *enp);
 605
 606 #endif  /* EFSYS_OPT_NAMES */
 607
 608 extern  __checkReturn   efx_rc_t
 609 efx_mon_init(
 610         __in            efx_nic_t *enp);
 611
 612 #if EFSYS_OPT_MON_STATS
 613
 614 #define EFX_MON_STATS_PAGE_SIZE 0x100
 615 #define EFX_MON_MASK_ELEMENT_SIZE 32
 616
 617 /* START MKCONFIG GENERATED MonitorHeaderStatsBlock c79c86b62a144846 */
 618 typedef enum efx_mon_stat_e {
 619         EFX_MON_STAT_2_5V,
 620         EFX_MON_STAT_VCCP1,
 621         EFX_MON_STAT_VCC,
 622         EFX_MON_STAT_5V,
 623         EFX_MON_STAT_12V,
 624         EFX_MON_STAT_VCCP2,
 625         EFX_MON_STAT_EXT_TEMP,
 626         EFX_MON_STAT_INT_TEMP,
 627         EFX_MON_STAT_AIN1,
 628         EFX_MON_STAT_AIN2,
 629         EFX_MON_STAT_INT_COOLING,
 630         EFX_MON_STAT_EXT_COOLING,
 631         EFX_MON_STAT_1V,
 632         EFX_MON_STAT_1_2V,
 633         EFX_MON_STAT_1_8V,
 634         EFX_MON_STAT_3_3V,
 635         EFX_MON_STAT_1_2VA,
 636         EFX_MON_STAT_VREF,
 637         EFX_MON_STAT_VAOE,
 638         EFX_MON_STAT_AOE_TEMP,
 639         EFX_MON_STAT_PSU_AOE_TEMP,
 640         EFX_MON_STAT_PSU_TEMP,
 641         EFX_MON_STAT_FAN0,
 642         EFX_MON_STAT_FAN1,
 643         EFX_MON_STAT_FAN2,
 644         EFX_MON_STAT_FAN3,
 645         EFX_MON_STAT_FAN4,
 646         EFX_MON_STAT_VAOE_IN,
 647         EFX_MON_STAT_IAOE,
 648         EFX_MON_STAT_IAOE_IN,
 649         EFX_MON_STAT_NIC_POWER,
 650         EFX_MON_STAT_0_9V,
 651         EFX_MON_STAT_I0_9V,
 652         EFX_MON_STAT_I1_2V,
 653         EFX_MON_STAT_0_9V_ADC,
 654         EFX_MON_STAT_INT_TEMP2,
 655         EFX_MON_STAT_VREG_TEMP,
 656         EFX_MON_STAT_VREG_0_9V_TEMP,
 657         EFX_MON_STAT_VREG_1_2V_TEMP,
 658         EFX_MON_STAT_INT_VPTAT,
 659         EFX_MON_STAT_INT_ADC_TEMP,
 660         EFX_MON_STAT_EXT_VPTAT,
 661         EFX_MON_STAT_EXT_ADC_TEMP,
 662         EFX_MON_STAT_AMBIENT_TEMP,
 663         EFX_MON_STAT_AIRFLOW,
 664         EFX_MON_STAT_VDD08D_VSS08D_CSR,
 665         EFX_MON_STAT_VDD08D_VSS08D_CSR_EXTADC,
 666         EFX_MON_STAT_HOTPOINT_TEMP,
 667         EFX_MON_STAT_PHY_POWER_SWITCH_PORT0,
 668         EFX_MON_STAT_PHY_POWER_SWITCH_PORT1,
 669         EFX_MON_STAT_MUM_VCC,
 670         EFX_MON_STAT_0V9_A,
 671         EFX_MON_STAT_I0V9_A,
 672         EFX_MON_STAT_0V9_A_TEMP,
 673         EFX_MON_STAT_0V9_B,
 674         EFX_MON_STAT_I0V9_B,
 675         EFX_MON_STAT_0V9_B_TEMP,
 676         EFX_MON_STAT_CCOM_AVREG_1V2_SUPPLY,
 677         EFX_MON_STAT_CCOM_AVREG_1V2_SUPPLY_EXT_ADC,
 678         EFX_MON_STAT_CCOM_AVREG_1V8_SUPPLY,
 679         EFX_MON_STAT_CCOM_AVREG_1V8_SUPPLY_EXT_ADC,
 680         EFX_MON_STAT_CONTROLLER_MASTER_VPTAT,
 681         EFX_MON_STAT_CONTROLLER_MASTER_INTERNAL_TEMP,
 682         EFX_MON_STAT_CONTROLLER_MASTER_VPTAT_EXT_ADC,
 683         EFX_MON_STAT_CONTROLLER_MASTER_INTERNAL_TEMP_EXT_ADC,
 684         EFX_MON_STAT_CONTROLLER_SLAVE_VPTAT,
 685         EFX_MON_STAT_CONTROLLER_SLAVE_INTERNAL_TEMP,
 686         EFX_MON_STAT_CONTROLLER_SLAVE_VPTAT_EXT_ADC,
 687         EFX_MON_STAT_CONTROLLER_SLAVE_INTERNAL_TEMP_EXT_ADC,
 688         EFX_MON_NSTATS
 689 } efx_mon_stat_t;
 690
 691 /* END MKCONFIG GENERATED MonitorHeaderStatsBlock */
 692
 693 typedef enum efx_mon_stat_state_e {
 694         EFX_MON_STAT_STATE_OK = 0,
 695         EFX_MON_STAT_STATE_WARNING = 1,
 696         EFX_MON_STAT_STATE_FATAL = 2,
 697         EFX_MON_STAT_STATE_BROKEN = 3,
 698         EFX_MON_STAT_STATE_NO_READING = 4,
 699 } efx_mon_stat_state_t;
 700
 701 typedef struct efx_mon_stat_value_s {
 702         uint16_t        emsv_value;
 703         uint16_t        emsv_state;
 704 } efx_mon_stat_value_t;
 705
 706 #if EFSYS_OPT_NAMES
 707
 708 extern                                  const char *
 709 efx_mon_stat_name(
 710         __in                            efx_nic_t *enp,
 711         __in                            efx_mon_stat_t id);
 712
 713 #endif  /* EFSYS_OPT_NAMES */
 714
 715 extern  __checkReturn                   efx_rc_t
 716 efx_mon_stats_update(
 717         __in                            efx_nic_t *enp,
 718         __in                            efsys_mem_t *esmp,
 719         __inout_ecount(EFX_MON_NSTATS)  efx_mon_stat_value_t *values);
 720
 721 #endif  /* EFSYS_OPT_MON_STATS */
 722
 723 extern          void
 724 efx_mon_fini(
 725         __in    efx_nic_t *enp);
 726
 727 /* PHY */
 728
 729 #define PMA_PMD_MMD     1
 730 #define PCS_MMD         3
 731 #define PHY_XS_MMD      4
 732 #define DTE_XS_MMD      5
 733 #define AN_MMD          7
 734 #define CL22EXT_MMD     29
 735
 736 #define MAXMMD          ((1 << 5) - 1)
 737
 738 extern  __checkReturn   efx_rc_t
 739 efx_phy_verify(
 740         __in            efx_nic_t *enp);
 741
 742 #if EFSYS_OPT_PHY_LED_CONTROL
 743
 744 typedef enum efx_phy_led_mode_e {
 745         EFX_PHY_LED_DEFAULT = 0,
 746         EFX_PHY_LED_OFF,
 747         EFX_PHY_LED_ON,
 748         EFX_PHY_LED_FLASH,
 749         EFX_PHY_LED_NMODES
 750 } efx_phy_led_mode_t;
 751
 752 extern  __checkReturn   efx_rc_t
 753 efx_phy_led_set(
 754         __in    efx_nic_t *enp,
 755         __in    efx_phy_led_mode_t mode);
 756
 757 #endif  /* EFSYS_OPT_PHY_LED_CONTROL */
 758
 759 extern  __checkReturn   efx_rc_t
 760 efx_port_init(
 761         __in            efx_nic_t *enp);
 762
 763 #if EFSYS_OPT_LOOPBACK
 764
 765 typedef enum efx_loopback_type_e {
 766         EFX_LOOPBACK_OFF = 0,
 767         EFX_LOOPBACK_DATA = 1,
 768         EFX_LOOPBACK_GMAC = 2,
 769         EFX_LOOPBACK_XGMII = 3,
 770         EFX_LOOPBACK_XGXS = 4,
 771         EFX_LOOPBACK_XAUI = 5,
 772         EFX_LOOPBACK_GMII = 6,
 773         EFX_LOOPBACK_SGMII = 7,
 774         EFX_LOOPBACK_XGBR = 8,
 775         EFX_LOOPBACK_XFI = 9,
 776         EFX_LOOPBACK_XAUI_FAR = 10,
 777         EFX_LOOPBACK_GMII_FAR = 11,
 778         EFX_LOOPBACK_SGMII_FAR = 12,
 779         EFX_LOOPBACK_XFI_FAR = 13,
 780         EFX_LOOPBACK_GPHY = 14,
 781         EFX_LOOPBACK_PHY_XS = 15,
 782         EFX_LOOPBACK_PCS = 16,
 783         EFX_LOOPBACK_PMA_PMD = 17,
 784         EFX_LOOPBACK_XPORT = 18,
 785         EFX_LOOPBACK_XGMII_WS = 19,
 786         EFX_LOOPBACK_XAUI_WS = 20,
 787         EFX_LOOPBACK_XAUI_WS_FAR = 21,
 788         EFX_LOOPBACK_XAUI_WS_NEAR = 22,
 789         EFX_LOOPBACK_GMII_WS = 23,
 790         EFX_LOOPBACK_XFI_WS = 24,
 791         EFX_LOOPBACK_XFI_WS_FAR = 25,
 792         EFX_LOOPBACK_PHYXS_WS = 26,
 793         EFX_LOOPBACK_PMA_INT = 27,
 794         EFX_LOOPBACK_SD_NEAR = 28,
 795         EFX_LOOPBACK_SD_FAR = 29,
 796         EFX_LOOPBACK_PMA_INT_WS = 30,
 797         EFX_LOOPBACK_SD_FEP2_WS = 31,
 798         EFX_LOOPBACK_SD_FEP1_5_WS = 32,
 799         EFX_LOOPBACK_SD_FEP_WS = 33,
 800         EFX_LOOPBACK_SD_FES_WS = 34,
 801         EFX_LOOPBACK_NTYPES
 802 } efx_loopback_type_t;
 803
 804 typedef enum efx_loopback_kind_e {
 805         EFX_LOOPBACK_KIND_OFF = 0,
 806         EFX_LOOPBACK_KIND_ALL,
 807         EFX_LOOPBACK_KIND_MAC,
 808         EFX_LOOPBACK_KIND_PHY,
 809         EFX_LOOPBACK_NKINDS
 810 } efx_loopback_kind_t;
 811
 812 extern                  void
 813 efx_loopback_mask(
 814         __in    efx_loopback_kind_t loopback_kind,
 815         __out   efx_qword_t *maskp);
 816
 817 extern  __checkReturn   efx_rc_t
 818 efx_port_loopback_set(
 819         __in    efx_nic_t *enp,
 820         __in    efx_link_mode_t link_mode,
 821         __in    efx_loopback_type_t type);
 822
 823 #if EFSYS_OPT_NAMES
 824
 825 extern  __checkReturn   const char *
 826 efx_loopback_type_name(
 827         __in            efx_nic_t *enp,
 828         __in            efx_loopback_type_t type);
 829
 830 #endif  /* EFSYS_OPT_NAMES */
 831
 832 #endif  /* EFSYS_OPT_LOOPBACK */
 833
 834 extern  __checkReturn   efx_rc_t
 835 efx_port_poll(
 836         __in            efx_nic_t *enp,
 837         __out_opt       efx_link_mode_t *link_modep);
 838
 839 extern          void
 840 efx_port_fini(
 841         __in    efx_nic_t *enp);
 842
 843 typedef enum efx_phy_cap_type_e {
 844         EFX_PHY_CAP_INVALID = 0,
 845         EFX_PHY_CAP_10HDX,
 846         EFX_PHY_CAP_10FDX,
 847         EFX_PHY_CAP_100HDX,
 848         EFX_PHY_CAP_100FDX,
 849         EFX_PHY_CAP_1000HDX,
 850         EFX_PHY_CAP_1000FDX,
 851         EFX_PHY_CAP_10000FDX,
 852         EFX_PHY_CAP_PAUSE,
 853         EFX_PHY_CAP_ASYM,
 854         EFX_PHY_CAP_AN,
 855         EFX_PHY_CAP_40000FDX,
 856         EFX_PHY_CAP_NTYPES
 857 } efx_phy_cap_type_t;
 858
 859
 860 #define EFX_PHY_CAP_CURRENT     0x00000000
 861 #define EFX_PHY_CAP_DEFAULT     0x00000001
 862 #define EFX_PHY_CAP_PERM        0x00000002
 863
 864 extern          void
 865 efx_phy_adv_cap_get(
 866         __in            efx_nic_t *enp,
 867         __in            uint32_t flag,
 868         __out           uint32_t *maskp);
 869
 870 extern  __checkReturn   efx_rc_t
 871 efx_phy_adv_cap_set(
 872         __in            efx_nic_t *enp,
 873         __in            uint32_t mask);
 874
 875 extern                  void
 876 efx_phy_lp_cap_get(
 877         __in            efx_nic_t *enp,
 878         __out           uint32_t *maskp);
 879
 880 extern  __checkReturn   efx_rc_t
 881 efx_phy_oui_get(
 882         __in            efx_nic_t *enp,
 883         __out           uint32_t *ouip);
 884
 885 typedef enum efx_phy_media_type_e {
 886         EFX_PHY_MEDIA_INVALID = 0,
 887         EFX_PHY_MEDIA_XAUI,
 888         EFX_PHY_MEDIA_CX4,
 889         EFX_PHY_MEDIA_KX4,
 890         EFX_PHY_MEDIA_XFP,
 891         EFX_PHY_MEDIA_SFP_PLUS,
 892         EFX_PHY_MEDIA_BASE_T,
 893         EFX_PHY_MEDIA_QSFP_PLUS,
 894         EFX_PHY_MEDIA_NTYPES
 895 } efx_phy_media_type_t;
 896
 897 /* Get the type of medium currently used.  If the board has ports for
 898  * modules, a module is present, and we recognise the media type of
 899  * the module, then this will be the media type of the module.
 900  * Otherwise it will be the media type of the port.
 901  */
 902 extern                  void
 903 efx_phy_media_type_get(
 904         __in            efx_nic_t *enp,
 905         __out           efx_phy_media_type_t *typep);
 906
 907 #if EFSYS_OPT_PHY_STATS
 908
 909 /* START MKCONFIG GENERATED PhyHeaderStatsBlock 30ed56ad501f8e36 */
 910 typedef enum efx_phy_stat_e {
 911         EFX_PHY_STAT_OUI,
 912         EFX_PHY_STAT_PMA_PMD_LINK_UP,
 913         EFX_PHY_STAT_PMA_PMD_RX_FAULT,
 914         EFX_PHY_STAT_PMA_PMD_TX_FAULT,
 915         EFX_PHY_STAT_PMA_PMD_REV_A,
 916         EFX_PHY_STAT_PMA_PMD_REV_B,
 917         EFX_PHY_STAT_PMA_PMD_REV_C,
 918         EFX_PHY_STAT_PMA_PMD_REV_D,
 919         EFX_PHY_STAT_PCS_LINK_UP,
 920         EFX_PHY_STAT_PCS_RX_FAULT,
 921         EFX_PHY_STAT_PCS_TX_FAULT,
 922         EFX_PHY_STAT_PCS_BER,
 923         EFX_PHY_STAT_PCS_BLOCK_ERRORS,
 924         EFX_PHY_STAT_PHY_XS_LINK_UP,
 925         EFX_PHY_STAT_PHY_XS_RX_FAULT,
 926         EFX_PHY_STAT_PHY_XS_TX_FAULT,
 927         EFX_PHY_STAT_PHY_XS_ALIGN,
 928         EFX_PHY_STAT_PHY_XS_SYNC_A,
 929         EFX_PHY_STAT_PHY_XS_SYNC_B,
 930         EFX_PHY_STAT_PHY_XS_SYNC_C,
 931         EFX_PHY_STAT_PHY_XS_SYNC_D,
 932         EFX_PHY_STAT_AN_LINK_UP,
 933         EFX_PHY_STAT_AN_MASTER,
 934         EFX_PHY_STAT_AN_LOCAL_RX_OK,
 935         EFX_PHY_STAT_AN_REMOTE_RX_OK,
 936         EFX_PHY_STAT_CL22EXT_LINK_UP,
 937         EFX_PHY_STAT_SNR_A,
 938         EFX_PHY_STAT_SNR_B,
 939         EFX_PHY_STAT_SNR_C,
 940         EFX_PHY_STAT_SNR_D,
 941         EFX_PHY_STAT_PMA_PMD_SIGNAL_A,
 942         EFX_PHY_STAT_PMA_PMD_SIGNAL_B,
 943         EFX_PHY_STAT_PMA_PMD_SIGNAL_C,
 944         EFX_PHY_STAT_PMA_PMD_SIGNAL_D,
 945         EFX_PHY_STAT_AN_COMPLETE,
 946         EFX_PHY_STAT_PMA_PMD_REV_MAJOR,
 947         EFX_PHY_STAT_PMA_PMD_REV_MINOR,
 948         EFX_PHY_STAT_PMA_PMD_REV_MICRO,
 949         EFX_PHY_STAT_PCS_FW_VERSION_0,
 950         EFX_PHY_STAT_PCS_FW_VERSION_1,
 951         EFX_PHY_STAT_PCS_FW_VERSION_2,
 952         EFX_PHY_STAT_PCS_FW_VERSION_3,
 953         EFX_PHY_STAT_PCS_FW_BUILD_YY,
 954         EFX_PHY_STAT_PCS_FW_BUILD_MM,
 955         EFX_PHY_STAT_PCS_FW_BUILD_DD,
 956         EFX_PHY_STAT_PCS_OP_MODE,
 957         EFX_PHY_NSTATS
 958 } efx_phy_stat_t;
 959
 960 /* END MKCONFIG GENERATED PhyHeaderStatsBlock */
 961
 962 #if EFSYS_OPT_NAMES
 963
 964 extern                                  const char *
 965 efx_phy_stat_name(
 966         __in                            efx_nic_t *enp,
 967         __in                            efx_phy_stat_t stat);
 968
 969 #endif  /* EFSYS_OPT_NAMES */
 970
 971 #define EFX_PHY_STATS_SIZE 0x100
 972
 973 extern  __checkReturn                   efx_rc_t
 974 efx_phy_stats_update(
 975         __in                            efx_nic_t *enp,
 976         __in                            efsys_mem_t *esmp,
 977         __inout_ecount(EFX_PHY_NSTATS)  uint32_t *stat);
 978
 979 #endif  /* EFSYS_OPT_PHY_STATS */
 980
 981 #if EFSYS_OPT_PHY_PROPS
 982
 983 #if EFSYS_OPT_NAMES
 984
 985 extern          const char *
 986 efx_phy_prop_name(
 987         __in    efx_nic_t *enp,
 988         __in    unsigned int id);
 989
 990 #endif  /* EFSYS_OPT_NAMES */
 991
 992 #define EFX_PHY_PROP_DEFAULT    0x00000001
 993
 994 extern  __checkReturn   efx_rc_t
 995 efx_phy_prop_get(
 996         __in            efx_nic_t *enp,
 997         __in            unsigned int id,
 998         __in            uint32_t flags,
 999         __out           uint32_t *valp);
1000
1001 extern  __checkReturn   efx_rc_t
1002 efx_phy_prop_set(
1003         __in            efx_nic_t *enp,
1004         __in            unsigned int id,
1005         __in            uint32_t val);
1006
1007 #endif  /* EFSYS_OPT_PHY_PROPS */
1008
1009 #if EFSYS_OPT_BIST
1010
1011 typedef enum efx_bist_type_e {
1012         EFX_BIST_TYPE_UNKNOWN,
1013         EFX_BIST_TYPE_PHY_NORMAL,
1014         EFX_BIST_TYPE_PHY_CABLE_SHORT,
1015         EFX_BIST_TYPE_PHY_CABLE_LONG,
1016         EFX_BIST_TYPE_MC_MEM,   /* Test the MC DMEM and IMEM */
1017         EFX_BIST_TYPE_SAT_MEM,  /* Test the DMEM and IMEM of satellite cpus*/
1018         EFX_BIST_TYPE_REG,      /* Test the register memories */
1019         EFX_BIST_TYPE_NTYPES,
1020 } efx_bist_type_t;
1021
1022 typedef enum efx_bist_result_e {
1023         EFX_BIST_RESULT_UNKNOWN,
1024         EFX_BIST_RESULT_RUNNING,
1025         EFX_BIST_RESULT_PASSED,
1026         EFX_BIST_RESULT_FAILED,
1027 } efx_bist_result_t;
1028
1029 typedef enum efx_phy_cable_status_e {
1030         EFX_PHY_CABLE_STATUS_OK,
1031         EFX_PHY_CABLE_STATUS_INVALID,
1032         EFX_PHY_CABLE_STATUS_OPEN,
1033         EFX_PHY_CABLE_STATUS_INTRAPAIRSHORT,
1034         EFX_PHY_CABLE_STATUS_INTERPAIRSHORT,
1035         EFX_PHY_CABLE_STATUS_BUSY,
1036 } efx_phy_cable_status_t;
1037
1038 typedef enum efx_bist_value_e {
1039         EFX_BIST_PHY_CABLE_LENGTH_A,
1040         EFX_BIST_PHY_CABLE_LENGTH_B,
1041         EFX_BIST_PHY_CABLE_LENGTH_C,
1042         EFX_BIST_PHY_CABLE_LENGTH_D,
1043         EFX_BIST_PHY_CABLE_STATUS_A,
1044         EFX_BIST_PHY_CABLE_STATUS_B,
1045         EFX_BIST_PHY_CABLE_STATUS_C,
1046         EFX_BIST_PHY_CABLE_STATUS_D,
1047         EFX_BIST_FAULT_CODE,
1048         /* Memory BIST specific values. These match to the MC_CMD_BIST_POLL
1049          * response. */
1050         EFX_BIST_MEM_TEST,
1051         EFX_BIST_MEM_ADDR,
1052         EFX_BIST_MEM_BUS,
1053         EFX_BIST_MEM_EXPECT,
1054         EFX_BIST_MEM_ACTUAL,
1055         EFX_BIST_MEM_ECC,
1056         EFX_BIST_MEM_ECC_PARITY,
1057         EFX_BIST_MEM_ECC_FATAL,
1058         EFX_BIST_NVALUES,
1059 } efx_bist_value_t;
1060
1061 extern  __checkReturn           efx_rc_t
1062 efx_bist_enable_offline(
1063         __in                    efx_nic_t *enp);
1064
1065 extern  __checkReturn           efx_rc_t
1066 efx_bist_start(
1067         __in                    efx_nic_t *enp,
1068         __in                    efx_bist_type_t type);
1069
1070 extern  __checkReturn           efx_rc_t
1071 efx_bist_poll(
1072         __in                    efx_nic_t *enp,
1073         __in                    efx_bist_type_t type,
1074         __out                   efx_bist_result_t *resultp,
1075         __out_opt               uint32_t *value_maskp,
1076         __out_ecount_opt(count) unsigned long *valuesp,
1077         __in                    size_t count);
1078
1079 extern                          void
1080 efx_bist_stop(
1081         __in                    efx_nic_t *enp,
1082         __in                    efx_bist_type_t type);
1083
1084 #endif  /* EFSYS_OPT_BIST */
1085
1086 #define EFX_FEATURE_IPV6                0x00000001
1087 #define EFX_FEATURE_LFSR_HASH_INSERT    0x00000002
1088 #define EFX_FEATURE_LINK_EVENTS         0x00000004
1089 #define EFX_FEATURE_PERIODIC_MAC_STATS  0x00000008
1090 #define EFX_FEATURE_WOL                 0x00000010
1091 #define EFX_FEATURE_MCDI                0x00000020
1092 #define EFX_FEATURE_LOOKAHEAD_SPLIT     0x00000040
1093 #define EFX_FEATURE_MAC_HEADER_FILTERS  0x00000080
1094 #define EFX_FEATURE_TURBO               0x00000100
1095 #define EFX_FEATURE_MCDI_DMA            0x00000200
1096 #define EFX_FEATURE_TX_SRC_FILTERS      0x00000400
1097 #define EFX_FEATURE_PIO_BUFFERS         0x00000800
1098 #define EFX_FEATURE_FW_ASSISTED_TSO     0x00001000
1099
1100 typedef struct efx_nic_cfg_s {
1101         uint32_t                enc_board_type;
1102         uint32_t                enc_phy_type;
1103 #if EFSYS_OPT_NAMES
1104         char                    enc_phy_name[21];
1105 #endif
1106         char                    enc_phy_revision[21];
1107         efx_mon_type_t          enc_mon_type;
1108 #if EFSYS_OPT_MON_STATS
1109         uint32_t                enc_mon_stat_dma_buf_size;
1110         uint32_t                enc_mon_stat_mask[(EFX_MON_NSTATS + 31) / 32];
1111 #endif
1112         unsigned int            enc_features;
1113         uint8_t                 enc_mac_addr[6];
1114         uint8_t                 enc_port;       /* PHY port number */
1115         uint32_t                enc_func_flags;
1116         uint32_t                enc_intr_vec_base;
1117         uint32_t                enc_intr_limit;
1118         uint32_t                enc_evq_limit;
1119         uint32_t                enc_txq_limit;
1120         uint32_t                enc_rxq_limit;
1121         uint32_t                enc_buftbl_limit;
1122         uint32_t                enc_piobuf_limit;
1123         uint32_t                enc_piobuf_size;
1124         uint32_t                enc_evq_timer_quantum_ns;
1125         uint32_t                enc_evq_timer_max_us;
1126         uint32_t                enc_clk_mult;
1127         uint32_t                enc_rx_prefix_size;
1128         uint32_t                enc_rx_buf_align_start;
1129         uint32_t                enc_rx_buf_align_end;
1130 #if EFSYS_OPT_LOOPBACK
1131         efx_qword_t             enc_loopback_types[EFX_LINK_NMODES];
1132 #endif  /* EFSYS_OPT_LOOPBACK */
1133 #if EFSYS_OPT_PHY_FLAGS
1134         uint32_t                enc_phy_flags_mask;
1135 #endif  /* EFSYS_OPT_PHY_FLAGS */
1136 #if EFSYS_OPT_PHY_LED_CONTROL
1137         uint32_t                enc_led_mask;
1138 #endif  /* EFSYS_OPT_PHY_LED_CONTROL */
1139 #if EFSYS_OPT_PHY_STATS
1140         uint64_t                enc_phy_stat_mask;
1141 #endif  /* EFSYS_OPT_PHY_STATS */
1142 #if EFSYS_OPT_PHY_PROPS
1143         unsigned int            enc_phy_nprops;
1144 #endif  /* EFSYS_OPT_PHY_PROPS */
1145 #if EFSYS_OPT_SIENA
1146         uint8_t                 enc_mcdi_mdio_channel;
1147 #if EFSYS_OPT_PHY_STATS
1148         uint32_t                enc_mcdi_phy_stat_mask;
1149 #endif  /* EFSYS_OPT_PHY_STATS */
1150 #endif /* EFSYS_OPT_SIENA */
1151 #if (EFSYS_OPT_SIENA || EFSYS_OPT_HUNTINGTON)
1152 #if EFSYS_OPT_MON_STATS
1153         uint32_t                *enc_mcdi_sensor_maskp;
1154         uint32_t                enc_mcdi_sensor_mask_size;
1155 #endif  /* EFSYS_OPT_MON_STATS */
1156 #endif  /* (EFSYS_OPT_SIENA | EFSYS_OPT_HUNTINGTON) */
1157 #if EFSYS_OPT_BIST
1158         uint32_t                enc_bist_mask;
1159 #endif  /* EFSYS_OPT_BIST */
1160 #if EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD
1161         uint32_t                enc_pf;
1162         uint32_t                enc_vf;
1163         uint32_t                enc_privilege_mask;
1164 #endif /* EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD */
1165         boolean_t               enc_bug26807_workaround;
1166         boolean_t               enc_bug35388_workaround;
1167         boolean_t               enc_bug41750_workaround;
1168         boolean_t               enc_rx_batching_enabled;
1169         /* Maximum number of descriptors completed in an rx event. */
1170         uint32_t                enc_rx_batch_max;
1171         /* Number of rx descriptors the hardware requires for a push. */
1172         uint32_t                enc_rx_push_align;
1173         /*
1174          * Maximum number of bytes into the packet the TCP header can start for
1175          * the hardware to apply TSO packet edits.
1176          */
1177         uint32_t                enc_tx_tso_tcp_header_offset_limit;
1178         boolean_t               enc_fw_assisted_tso_enabled;
1179         boolean_t               enc_hw_tx_insert_vlan_enabled;
1180         /* Datapath firmware vadapter/vport/vswitch support */
1181         boolean_t               enc_datapath_cap_evb;
1182         boolean_t               enc_rx_disable_scatter_supported;
1183         boolean_t               enc_allow_set_mac_with_installed_filters;
1184         /* External port identifier */
1185         uint8_t                 enc_external_port;
1186         uint32_t                enc_mcdi_max_payload_length;
1187 } efx_nic_cfg_t;
1188
1189 #define EFX_PCI_FUNCTION_IS_PF(_encp)   ((_encp)->enc_vf == 0xffff)
1190 #define EFX_PCI_FUNCTION_IS_VF(_encp)   ((_encp)->enc_vf != 0xffff)
1191
1192 #define EFX_PCI_FUNCTION(_encp) \
1193         (EFX_PCI_FUNCTION_IS_PF(_encp) ? (_encp)->enc_pf : (_encp)->enc_vf)
1194
1195 #define EFX_PCI_VF_PARENT(_encp)        ((_encp)->enc_pf)
1196
1197 extern                  const efx_nic_cfg_t *
1198 efx_nic_cfg_get(
1199         __in            efx_nic_t *enp);
1200
1201 /* Driver resource limits (minimum required/maximum usable). */
1202 typedef struct efx_drv_limits_s
1203 {
1204         uint32_t        edl_min_evq_count;
1205         uint32_t        edl_max_evq_count;
1206
1207         uint32_t        edl_min_rxq_count;
1208         uint32_t        edl_max_rxq_count;
1209
1210         uint32_t        edl_min_txq_count;
1211         uint32_t        edl_max_txq_count;
1212
1213         /* PIO blocks (sub-allocated from piobuf) */
1214         uint32_t        edl_min_pio_alloc_size;
1215         uint32_t        edl_max_pio_alloc_count;
1216 } efx_drv_limits_t;
1217
1218 extern  __checkReturn   efx_rc_t
1219 efx_nic_set_drv_limits(
1220         __inout         efx_nic_t *enp,
1221         __in            efx_drv_limits_t *edlp);
1222
1223 typedef enum efx_nic_region_e {
1224         EFX_REGION_VI,                  /* Memory BAR UC mapping */
1225         EFX_REGION_PIO_WRITE_VI,        /* Memory BAR WC mapping */
1226 } efx_nic_region_t;
1227
1228 extern  __checkReturn   efx_rc_t
1229 efx_nic_get_bar_region(
1230         __in            efx_nic_t *enp,
1231         __in            efx_nic_region_t region,
1232         __out           uint32_t *offsetp,
1233         __out           size_t *sizep);
1234
1235 extern  __checkReturn   efx_rc_t
1236 efx_nic_get_vi_pool(
1237         __in            efx_nic_t *enp,
1238         __out           uint32_t *evq_countp,
1239         __out           uint32_t *rxq_countp,
1240         __out           uint32_t *txq_countp);
1241
1242
1243 #if EFSYS_OPT_VPD
1244
1245 typedef enum efx_vpd_tag_e {
1246         EFX_VPD_ID = 0x02,
1247         EFX_VPD_END = 0x0f,
1248         EFX_VPD_RO = 0x10,
1249         EFX_VPD_RW = 0x11,
1250 } efx_vpd_tag_t;
1251
1252 typedef uint16_t efx_vpd_keyword_t;
1253
1254 typedef struct efx_vpd_value_s {
1255         efx_vpd_tag_t           evv_tag;
1256         efx_vpd_keyword_t       evv_keyword;
1257         uint8_t                 evv_length;
1258         uint8_t                 evv_value[0x100];
1259 } efx_vpd_value_t;
1260
1261
1262 #define EFX_VPD_KEYWORD(x, y) ((x) | ((y) << 8))
1263
1264 extern  __checkReturn           efx_rc_t
1265 efx_vpd_init(
1266         __in                    efx_nic_t *enp);
1267
1268 extern  __checkReturn           efx_rc_t
1269 efx_vpd_size(
1270         __in                    efx_nic_t *enp,
1271         __out                   size_t *sizep);
1272
1273 extern  __checkReturn           efx_rc_t
1274 efx_vpd_read(
1275         __in                    efx_nic_t *enp,
1276         __out_bcount(size)      caddr_t data,
1277         __in                    size_t size);
1278
1279 extern  __checkReturn           efx_rc_t
1280 efx_vpd_verify(
1281         __in                    efx_nic_t *enp,
1282         __in_bcount(size)       caddr_t data,
1283         __in                    size_t size);
1284
1285 extern  __checkReturn           efx_rc_t
1286 efx_vpd_reinit(
1287         __in                    efx_nic_t *enp,
1288         __in_bcount(size)       caddr_t data,
1289         __in                    size_t size);
1290
1291 extern  __checkReturn           efx_rc_t
1292 efx_vpd_get(
1293         __in                    efx_nic_t *enp,
1294         __in_bcount(size)       caddr_t data,
1295         __in                    size_t size,
1296         __inout                 efx_vpd_value_t *evvp);
1297
1298 extern  __checkReturn           efx_rc_t
1299 efx_vpd_set(
1300         __in                    efx_nic_t *enp,
1301         __inout_bcount(size)    caddr_t data,
1302         __in                    size_t size,
1303         __in                    efx_vpd_value_t *evvp);
1304
1305 extern  __checkReturn           efx_rc_t
1306 efx_vpd_next(
1307         __in                    efx_nic_t *enp,
1308         __inout_bcount(size)    caddr_t data,
1309         __in                    size_t size,
1310         __out                   efx_vpd_value_t *evvp,
1311         __inout                 unsigned int *contp);
1312
1313 extern __checkReturn            efx_rc_t
1314 efx_vpd_write(
1315         __in                    efx_nic_t *enp,
1316         __in_bcount(size)       caddr_t data,
1317         __in                    size_t size);
1318
1319 extern                          void
1320 efx_vpd_fini(
1321         __in                    efx_nic_t *enp);
1322
1323 #endif  /* EFSYS_OPT_VPD */
1324
1325 /* NVRAM */
1326
1327 #if EFSYS_OPT_NVRAM
1328
1329 typedef enum efx_nvram_type_e {
1330         EFX_NVRAM_INVALID = 0,
1331         EFX_NVRAM_BOOTROM,
1332         EFX_NVRAM_BOOTROM_CFG,
1333         EFX_NVRAM_MC_FIRMWARE,
1334         EFX_NVRAM_MC_GOLDEN,
1335         EFX_NVRAM_PHY,
1336         EFX_NVRAM_NULLPHY,
1337         EFX_NVRAM_FPGA,
1338         EFX_NVRAM_FCFW,
1339         EFX_NVRAM_CPLD,
1340         EFX_NVRAM_FPGA_BACKUP,
1341         EFX_NVRAM_DYNAMIC_CFG,
1342         EFX_NVRAM_NTYPES,
1343 } efx_nvram_type_t;
1344
1345 extern  __checkReturn           efx_rc_t
1346 efx_nvram_init(
1347         __in                    efx_nic_t *enp);
1348
1349 #if EFSYS_OPT_DIAG
1350
1351 extern  __checkReturn           efx_rc_t
1352 efx_nvram_test(
1353         __in                    efx_nic_t *enp);
1354
1355 #endif  /* EFSYS_OPT_DIAG */
1356
1357 extern  __checkReturn           efx_rc_t
1358 efx_nvram_size(
1359         __in                    efx_nic_t *enp,
1360         __in                    efx_nvram_type_t type,
1361         __out                   size_t *sizep);
1362
1363 extern  __checkReturn           efx_rc_t
1364 efx_nvram_rw_start(
1365         __in                    efx_nic_t *enp,
1366         __in                    efx_nvram_type_t type,
1367         __out_opt               size_t *pref_chunkp);
1368
1369 extern                          void
1370 efx_nvram_rw_finish(
1371         __in                    efx_nic_t *enp,
1372         __in                    efx_nvram_type_t type);
1373
1374 extern  __checkReturn           efx_rc_t
1375 efx_nvram_get_version(
1376         __in                    efx_nic_t *enp,
1377         __in                    efx_nvram_type_t type,
1378         __out                   uint32_t *subtypep,
1379         __out_ecount(4)         uint16_t version[4]);
1380
1381 extern  __checkReturn           efx_rc_t
1382 efx_nvram_read_chunk(
1383         __in                    efx_nic_t *enp,
1384         __in                    efx_nvram_type_t type,
1385         __in                    unsigned int offset,
1386         __out_bcount(size)      caddr_t data,
1387         __in                    size_t size);
1388
1389 extern  __checkReturn           efx_rc_t
1390 efx_nvram_set_version(
1391         __in                    efx_nic_t *enp,
1392         __in                    efx_nvram_type_t type,
1393         __in_ecount(4)          uint16_t version[4]);
1394
1395 /* Validate contents of TLV formatted partition */
1396 extern  __checkReturn           efx_rc_t
1397 efx_nvram_tlv_validate(
1398         __in                    efx_nic_t *enp,
1399         __in                    uint32_t partn,
1400         __in_bcount(partn_size) caddr_t partn_data,
1401         __in                    size_t partn_size);
1402
1403 extern   __checkReturn          efx_rc_t
1404 efx_nvram_erase(
1405         __in                    efx_nic_t *enp,
1406         __in                    efx_nvram_type_t type);
1407
1408 extern  __checkReturn           efx_rc_t
1409 efx_nvram_write_chunk(
1410         __in                    efx_nic_t *enp,
1411         __in                    efx_nvram_type_t type,
1412         __in                    unsigned int offset,
1413         __in_bcount(size)       caddr_t data,
1414         __in                    size_t size);
1415
1416 extern                          void
1417 efx_nvram_fini(
1418         __in                    efx_nic_t *enp);
1419
1420 #endif  /* EFSYS_OPT_NVRAM */
1421
1422 #if EFSYS_OPT_BOOTCFG
1423
1424 extern                          efx_rc_t
1425 efx_bootcfg_read(
1426         __in                    efx_nic_t *enp,
1427         __out_bcount(size)      caddr_t data,
1428         __in                    size_t size);
1429
1430 extern                          efx_rc_t
1431 efx_bootcfg_write(
1432         __in                    efx_nic_t *enp,
1433         __in_bcount(size)       caddr_t data,
1434         __in                    size_t size);
1435
1436 #endif  /* EFSYS_OPT_BOOTCFG */
1437
1438 #if EFSYS_OPT_WOL
1439
1440 typedef enum efx_wol_type_e {
1441         EFX_WOL_TYPE_INVALID,
1442         EFX_WOL_TYPE_MAGIC,
1443         EFX_WOL_TYPE_BITMAP,
1444         EFX_WOL_TYPE_LINK,
1445         EFX_WOL_NTYPES,
1446 } efx_wol_type_t;
1447
1448 typedef enum efx_lightsout_offload_type_e {
1449         EFX_LIGHTSOUT_OFFLOAD_TYPE_INVALID,
1450         EFX_LIGHTSOUT_OFFLOAD_TYPE_ARP,
1451         EFX_LIGHTSOUT_OFFLOAD_TYPE_NS,
1452 } efx_lightsout_offload_type_t;
1453
1454 #define EFX_WOL_BITMAP_MASK_SIZE    (48)
1455 #define EFX_WOL_BITMAP_VALUE_SIZE   (128)
1456
1457 typedef union efx_wol_param_u {
1458         struct {
1459                 uint8_t mac_addr[6];
1460         } ewp_magic;
1461         struct {
1462                 uint8_t mask[EFX_WOL_BITMAP_MASK_SIZE];   /* 1 bit per byte */
1463                 uint8_t value[EFX_WOL_BITMAP_VALUE_SIZE]; /* value to match */
1464                 uint8_t value_len;
1465         } ewp_bitmap;
1466 } efx_wol_param_t;
1467
1468 typedef union efx_lightsout_offload_param_u {
1469         struct {
1470                 uint8_t mac_addr[6];
1471                 uint32_t ip;
1472         } elop_arp;
1473         struct {
1474                 uint8_t mac_addr[6];
1475                 uint32_t solicited_node[4];
1476                 uint32_t ip[4];
1477         } elop_ns;
1478 } efx_lightsout_offload_param_t;
1479
1480 extern  __checkReturn   efx_rc_t
1481 efx_wol_init(
1482         __in            efx_nic_t *enp);
1483
1484 extern  __checkReturn   efx_rc_t
1485 efx_wol_filter_clear(
1486         __in            efx_nic_t *enp);
1487
1488 extern  __checkReturn   efx_rc_t
1489 efx_wol_filter_add(
1490         __in            efx_nic_t *enp,
1491         __in            efx_wol_type_t type,
1492         __in            efx_wol_param_t *paramp,
1493         __out           uint32_t *filter_idp);
1494
1495 extern  __checkReturn   efx_rc_t
1496 efx_wol_filter_remove(
1497         __in            efx_nic_t *enp,
1498         __in            uint32_t filter_id);
1499
1500 extern  __checkReturn   efx_rc_t
1501 efx_lightsout_offload_add(
1502         __in            efx_nic_t *enp,
1503         __in            efx_lightsout_offload_type_t type,
1504         __in            efx_lightsout_offload_param_t *paramp,
1505         __out           uint32_t *filter_idp);
1506
1507 extern  __checkReturn   efx_rc_t
1508 efx_lightsout_offload_remove(
1509         __in            efx_nic_t *enp,
1510         __in            efx_lightsout_offload_type_t type,
1511         __in            uint32_t filter_id);
1512
1513 extern                  void
1514 efx_wol_fini(
1515         __in            efx_nic_t *enp);
1516
1517 #endif  /* EFSYS_OPT_WOL */
1518
1519 #if EFSYS_OPT_DIAG
1520
1521 typedef enum efx_pattern_type_t {
1522         EFX_PATTERN_BYTE_INCREMENT = 0,
1523         EFX_PATTERN_ALL_THE_SAME,
1524         EFX_PATTERN_BIT_ALTERNATE,
1525         EFX_PATTERN_BYTE_ALTERNATE,
1526         EFX_PATTERN_BYTE_CHANGING,
1527         EFX_PATTERN_BIT_SWEEP,
1528         EFX_PATTERN_NTYPES
1529 } efx_pattern_type_t;
1530
1531 typedef                 void
1532 (*efx_sram_pattern_fn_t)(
1533         __in            size_t row,
1534         __in            boolean_t negate,
1535         __out           efx_qword_t *eqp);
1536
1537 extern  __checkReturn   efx_rc_t
1538 efx_sram_test(
1539         __in            efx_nic_t *enp,
1540         __in            efx_pattern_type_t type);
1541
1542 #endif  /* EFSYS_OPT_DIAG */
1543
1544 extern  __checkReturn   efx_rc_t
1545 efx_sram_buf_tbl_set(
1546         __in            efx_nic_t *enp,
1547         __in            uint32_t id,
1548         __in            efsys_mem_t *esmp,
1549         __in            size_t n);
1550
1551 extern          void
1552 efx_sram_buf_tbl_clear(
1553         __in    efx_nic_t *enp,
1554         __in    uint32_t id,
1555         __in    size_t n);
1556
1557 #define EFX_BUF_TBL_SIZE        0x20000
1558
1559 #define EFX_BUF_SIZE            4096
1560
1561 /* EV */
1562
1563 typedef struct efx_evq_s        efx_evq_t;
1564
1565 #if EFSYS_OPT_QSTATS
1566
1567 /* START MKCONFIG GENERATED EfxHeaderEventQueueBlock 6f3843f5fe7cc843 */
1568 typedef enum efx_ev_qstat_e {
1569         EV_ALL,
1570         EV_RX,
1571         EV_RX_OK,
1572         EV_RX_FRM_TRUNC,
1573         EV_RX_TOBE_DISC,
1574         EV_RX_PAUSE_FRM_ERR,
1575         EV_RX_BUF_OWNER_ID_ERR,
1576         EV_RX_IPV4_HDR_CHKSUM_ERR,
1577         EV_RX_TCP_UDP_CHKSUM_ERR,
1578         EV_RX_ETH_CRC_ERR,
1579         EV_RX_IP_FRAG_ERR,
1580         EV_RX_MCAST_PKT,
1581         EV_RX_MCAST_HASH_MATCH,
1582         EV_RX_TCP_IPV4,
1583         EV_RX_TCP_IPV6,
1584         EV_RX_UDP_IPV4,
1585         EV_RX_UDP_IPV6,
1586         EV_RX_OTHER_IPV4,
1587         EV_RX_OTHER_IPV6,
1588         EV_RX_NON_IP,
1589         EV_RX_BATCH,
1590         EV_TX,
1591         EV_TX_WQ_FF_FULL,
1592         EV_TX_PKT_ERR,
1593         EV_TX_PKT_TOO_BIG,
1594         EV_TX_UNEXPECTED,
1595         EV_GLOBAL,
1596         EV_GLOBAL_MNT,
1597         EV_DRIVER,
1598         EV_DRIVER_SRM_UPD_DONE,
1599         EV_DRIVER_TX_DESCQ_FLS_DONE,
1600         EV_DRIVER_RX_DESCQ_FLS_DONE,
1601         EV_DRIVER_RX_DESCQ_FLS_FAILED,
1602         EV_DRIVER_RX_DSC_ERROR,
1603         EV_DRIVER_TX_DSC_ERROR,
1604         EV_DRV_GEN,
1605         EV_MCDI_RESPONSE,
1606         EV_NQSTATS
1607 } efx_ev_qstat_t;
1608
1609 /* END MKCONFIG GENERATED EfxHeaderEventQueueBlock */
1610
1611 #endif  /* EFSYS_OPT_QSTATS */
1612
1613 extern  __checkReturn   efx_rc_t
1614 efx_ev_init(
1615         __in            efx_nic_t *enp);
1616
1617 extern          void
1618 efx_ev_fini(
1619         __in            efx_nic_t *enp);
1620
1621 #define EFX_EVQ_MAXNEVS         32768
1622 #define EFX_EVQ_MINNEVS         512
1623
1624 #define EFX_EVQ_SIZE(_nevs)     ((_nevs) * sizeof (efx_qword_t))
1625 #define EFX_EVQ_NBUFS(_nevs)    (EFX_EVQ_SIZE(_nevs) / EFX_BUF_SIZE)
1626
1627 extern  __checkReturn   efx_rc_t
1628 efx_ev_qcreate(
1629         __in            efx_nic_t *enp,
1630         __in            unsigned int index,
1631         __in            efsys_mem_t *esmp,
1632         __in            size_t n,
1633         __in            uint32_t id,
1634         __deref_out     efx_evq_t **eepp);
1635
1636 extern          void
1637 efx_ev_qpost(
1638         __in            efx_evq_t *eep,
1639         __in            uint16_t data);
1640
1641 typedef __checkReturn   boolean_t
1642 (*efx_initialized_ev_t)(
1643         __in_opt        void *arg);
1644
1645 #define EFX_PKT_UNICAST         0x0004
1646 #define EFX_PKT_START           0x0008
1647
1648 #define EFX_PKT_VLAN_TAGGED     0x0010
1649 #define EFX_CKSUM_TCPUDP        0x0020
1650 #define EFX_CKSUM_IPV4          0x0040
1651 #define EFX_PKT_CONT            0x0080
1652
1653 #define EFX_CHECK_VLAN          0x0100
1654 #define EFX_PKT_TCP             0x0200
1655 #define EFX_PKT_UDP             0x0400
1656 #define EFX_PKT_IPV4            0x0800
1657
1658 #define EFX_PKT_IPV6            0x1000
1659 #define EFX_PKT_PREFIX_LEN      0x2000
1660 #define EFX_ADDR_MISMATCH       0x4000
1661 #define EFX_DISCARD             0x8000
1662
1663 #define EFX_EV_RX_NLABELS       32
1664 #define EFX_EV_TX_NLABELS       32
1665
1666 typedef __checkReturn   boolean_t
1667 (*efx_rx_ev_t)(
1668         __in_opt        void *arg,
1669         __in            uint32_t label,
1670         __in            uint32_t id,
1671         __in            uint32_t size,
1672         __in            uint16_t flags);
1673
1674 typedef __checkReturn   boolean_t
1675 (*efx_tx_ev_t)(
1676         __in_opt        void *arg,
1677         __in            uint32_t label,
1678         __in            uint32_t id);
1679
1680 #define EFX_EXCEPTION_RX_RECOVERY       0x00000001
1681 #define EFX_EXCEPTION_RX_DSC_ERROR      0x00000002
1682 #define EFX_EXCEPTION_TX_DSC_ERROR      0x00000003
1683 #define EFX_EXCEPTION_UNKNOWN_SENSOREVT 0x00000004
1684 #define EFX_EXCEPTION_FWALERT_SRAM      0x00000005
1685 #define EFX_EXCEPTION_UNKNOWN_FWALERT   0x00000006
1686 #define EFX_EXCEPTION_RX_ERROR          0x00000007
1687 #define EFX_EXCEPTION_TX_ERROR          0x00000008
1688 #define EFX_EXCEPTION_EV_ERROR          0x00000009
1689
1690 typedef __checkReturn   boolean_t
1691 (*efx_exception_ev_t)(
1692         __in_opt        void *arg,
1693         __in            uint32_t label,
1694         __in            uint32_t data);
1695
1696 typedef __checkReturn   boolean_t
1697 (*efx_rxq_flush_done_ev_t)(
1698         __in_opt        void *arg,
1699         __in            uint32_t rxq_index);
1700
1701 typedef __checkReturn   boolean_t
1702 (*efx_rxq_flush_failed_ev_t)(
1703         __in_opt        void *arg,
1704         __in            uint32_t rxq_index);
1705
1706 typedef __checkReturn   boolean_t
1707 (*efx_txq_flush_done_ev_t)(
1708         __in_opt        void *arg,
1709         __in            uint32_t txq_index);
1710
1711 typedef __checkReturn   boolean_t
1712 (*efx_software_ev_t)(
1713         __in_opt        void *arg,
1714         __in            uint16_t magic);
1715
1716 typedef __checkReturn   boolean_t
1717 (*efx_sram_ev_t)(
1718         __in_opt        void *arg,
1719         __in            uint32_t code);
1720
1721 #define EFX_SRAM_CLEAR          0
1722 #define EFX_SRAM_UPDATE         1
1723 #define EFX_SRAM_ILLEGAL_CLEAR  2
1724
1725 typedef __checkReturn   boolean_t
1726 (*efx_wake_up_ev_t)(
1727         __in_opt        void *arg,
1728         __in            uint32_t label);
1729
1730 typedef __checkReturn   boolean_t
1731 (*efx_timer_ev_t)(
1732         __in_opt        void *arg,
1733         __in            uint32_t label);
1734
1735 typedef __checkReturn   boolean_t
1736 (*efx_link_change_ev_t)(
1737         __in_opt        void *arg,
1738         __in            efx_link_mode_t link_mode);
1739
1740 #if EFSYS_OPT_MON_STATS
1741
1742 typedef __checkReturn   boolean_t
1743 (*efx_monitor_ev_t)(
1744         __in_opt        void *arg,
1745         __in            efx_mon_stat_t id,
1746         __in            efx_mon_stat_value_t value);
1747
1748 #endif  /* EFSYS_OPT_MON_STATS */
1749
1750 #if EFSYS_OPT_MAC_STATS
1751
1752 typedef __checkReturn   boolean_t
1753 (*efx_mac_stats_ev_t)(
1754         __in_opt        void *arg,
1755         __in            uint32_t generation
1756         );
1757
1758 #endif  /* EFSYS_OPT_MAC_STATS */
1759
1760 typedef struct efx_ev_callbacks_s {
1761         efx_initialized_ev_t            eec_initialized;
1762         efx_rx_ev_t                     eec_rx;
1763         efx_tx_ev_t                     eec_tx;
1764         efx_exception_ev_t              eec_exception;
1765         efx_rxq_flush_done_ev_t         eec_rxq_flush_done;
1766         efx_rxq_flush_failed_ev_t       eec_rxq_flush_failed;
1767         efx_txq_flush_done_ev_t         eec_txq_flush_done;
1768         efx_software_ev_t               eec_software;
1769         efx_sram_ev_t                   eec_sram;
1770         efx_wake_up_ev_t                eec_wake_up;
1771         efx_timer_ev_t                  eec_timer;
1772         efx_link_change_ev_t            eec_link_change;
1773 #if EFSYS_OPT_MON_STATS
1774         efx_monitor_ev_t                eec_monitor;
1775 #endif  /* EFSYS_OPT_MON_STATS */
1776 #if EFSYS_OPT_MAC_STATS
1777         efx_mac_stats_ev_t              eec_mac_stats;
1778 #endif  /* EFSYS_OPT_MAC_STATS */
1779 } efx_ev_callbacks_t;
1780
1781 extern  __checkReturn   boolean_t
1782 efx_ev_qpending(
1783         __in            efx_evq_t *eep,
1784         __in            unsigned int count);
1785
1786 #if EFSYS_OPT_EV_PREFETCH
1787
1788 extern                  void
1789 efx_ev_qprefetch(
1790         __in            efx_evq_t *eep,
1791         __in            unsigned int count);
1792
1793 #endif  /* EFSYS_OPT_EV_PREFETCH */
1794
1795 extern                  void
1796 efx_ev_qpoll(
1797         __in            efx_evq_t *eep,
1798         __inout         unsigned int *countp,
1799         __in            const efx_ev_callbacks_t *eecp,
1800         __in_opt        void *arg);
1801
1802 extern  __checkReturn   efx_rc_t
1803 efx_ev_qmoderate(
1804         __in            efx_evq_t *eep,
1805         __in            unsigned int us);
1806
1807 extern  __checkReturn   efx_rc_t
1808 efx_ev_qprime(
1809         __in            efx_evq_t *eep,
1810         __in            unsigned int count);
1811
1812 #if EFSYS_OPT_QSTATS
1813
1814 #if EFSYS_OPT_NAMES
1815
1816 extern          const char *
1817 efx_ev_qstat_name(
1818         __in    efx_nic_t *enp,
1819         __in    unsigned int id);
1820
1821 #endif  /* EFSYS_OPT_NAMES */
1822
1823 extern                                  void
1824 efx_ev_qstats_update(
1825         __in                            efx_evq_t *eep,
1826         __inout_ecount(EV_NQSTATS)      efsys_stat_t *stat);
1827
1828 #endif  /* EFSYS_OPT_QSTATS */
1829
1830 extern          void
1831 efx_ev_qdestroy(
1832         __in    efx_evq_t *eep);
1833
1834 /* RX */
1835
1836 extern  __checkReturn   efx_rc_t
1837 efx_rx_init(
1838         __inout         efx_nic_t *enp);
1839
1840 extern          void
1841 efx_rx_fini(
1842         __in            efx_nic_t *enp);
1843
1844 #if EFSYS_OPT_RX_HDR_SPLIT
1845         __checkReturn   efx_rc_t
1846 efx_rx_hdr_split_enable(
1847         __in            efx_nic_t *enp,
1848         __in            unsigned int hdr_buf_size,
1849         __in            unsigned int pld_buf_size);
1850
1851 #endif  /* EFSYS_OPT_RX_HDR_SPLIT */
1852
1853 #if EFSYS_OPT_RX_SCATTER
1854         __checkReturn   efx_rc_t
1855 efx_rx_scatter_enable(
1856         __in            efx_nic_t *enp,
1857         __in            unsigned int buf_size);
1858 #endif  /* EFSYS_OPT_RX_SCATTER */
1859
1860 #if EFSYS_OPT_RX_SCALE
1861
1862 typedef enum efx_rx_hash_alg_e {
1863         EFX_RX_HASHALG_LFSR = 0,
1864         EFX_RX_HASHALG_TOEPLITZ
1865 } efx_rx_hash_alg_t;
1866
1867 typedef enum efx_rx_hash_type_e {
1868         EFX_RX_HASH_IPV4 = 0,
1869         EFX_RX_HASH_TCPIPV4,
1870         EFX_RX_HASH_IPV6,
1871         EFX_RX_HASH_TCPIPV6,
1872 } efx_rx_hash_type_t;
1873
1874 typedef enum efx_rx_hash_support_e {
1875         EFX_RX_HASH_UNAVAILABLE = 0,    /* Hardware hash not inserted */
1876         EFX_RX_HASH_AVAILABLE           /* Insert hash with/without RSS */
1877 } efx_rx_hash_support_t;
1878
1879 #define EFX_RSS_TBL_SIZE        128     /* Rows in RX indirection table */
1880 #define EFX_MAXRSS              64      /* RX indirection entry range */
1881 #define EFX_MAXRSS_LEGACY       16      /* See bug16611 and bug17213 */
1882
1883 typedef enum efx_rx_scale_support_e {
1884         EFX_RX_SCALE_UNAVAILABLE = 0,   /* Not supported */
1885         EFX_RX_SCALE_EXCLUSIVE,         /* Writable key/indirection table */
1886         EFX_RX_SCALE_SHARED             /* Read-only key/indirection table */
1887 } efx_rx_scale_support_t;
1888
1889 extern  __checkReturn   efx_rc_t
1890 efx_rx_hash_support_get(
1891         __in            efx_nic_t *enp,
1892         __out           efx_rx_hash_support_t *supportp);
1893
1894
1895 extern  __checkReturn   efx_rc_t
1896 efx_rx_scale_support_get(
1897         __in            efx_nic_t *enp,
1898         __out           efx_rx_scale_support_t *supportp);
1899
1900 extern  __checkReturn   efx_rc_t
1901 efx_rx_scale_mode_set(
1902         __in    efx_nic_t *enp,
1903         __in    efx_rx_hash_alg_t alg,
1904         __in    efx_rx_hash_type_t type,
1905         __in    boolean_t insert);
1906
1907 extern  __checkReturn   efx_rc_t
1908 efx_rx_scale_tbl_set(
1909         __in            efx_nic_t *enp,
1910         __in_ecount(n)  unsigned int *table,
1911         __in            size_t n);
1912
1913 extern  __checkReturn   efx_rc_t
1914 efx_rx_scale_key_set(
1915         __in            efx_nic_t *enp,
1916         __in_ecount(n)  uint8_t *key,
1917         __in            size_t n);
1918
1919 extern uint32_t
1920 efx_psuedo_hdr_hash_get(
1921         __in            efx_nic_t *enp,
1922         __in            efx_rx_hash_alg_t func,
1923         __in            uint8_t *buffer);
1924
1925 #endif  /* EFSYS_OPT_RX_SCALE */
1926
1927 extern  __checkReturn   efx_rc_t
1928 efx_psuedo_hdr_pkt_length_get(
1929         __in            efx_nic_t *enp,
1930         __in            uint8_t *buffer,
1931         __out           uint16_t *pkt_lengthp);
1932
1933 #define EFX_RXQ_MAXNDESCS               4096
1934 #define EFX_RXQ_MINNDESCS               512
1935
1936 #define EFX_RXQ_SIZE(_ndescs)           ((_ndescs) * sizeof (efx_qword_t))
1937 #define EFX_RXQ_NBUFS(_ndescs)          (EFX_RXQ_SIZE(_ndescs) / EFX_BUF_SIZE)
1938 #define EFX_RXQ_LIMIT(_ndescs)          ((_ndescs) - 16)
1939 #define EFX_RXQ_DC_NDESCS(_dcsize)      (8 << _dcsize)
1940
1941 typedef enum efx_rxq_type_e {
1942         EFX_RXQ_TYPE_DEFAULT,
1943         EFX_RXQ_TYPE_SPLIT_HEADER,
1944         EFX_RXQ_TYPE_SPLIT_PAYLOAD,
1945         EFX_RXQ_TYPE_SCATTER,
1946         EFX_RXQ_NTYPES
1947 } efx_rxq_type_t;
1948
1949 extern  __checkReturn   efx_rc_t
1950 efx_rx_qcreate(
1951         __in            efx_nic_t *enp,
1952         __in            unsigned int index,
1953         __in            unsigned int label,
1954         __in            efx_rxq_type_t type,
1955         __in            efsys_mem_t *esmp,
1956         __in            size_t n,
1957         __in            uint32_t id,
1958         __in            efx_evq_t *eep,
1959         __deref_out     efx_rxq_t **erpp);
1960
1961 typedef struct efx_buffer_s {
1962         efsys_dma_addr_t        eb_addr;
1963         size_t                  eb_size;
1964         boolean_t               eb_eop;
1965 } efx_buffer_t;
1966
1967 typedef struct efx_desc_s {
1968         efx_qword_t ed_eq;
1969 } efx_desc_t;
1970
1971 extern                  void
1972 efx_rx_qpost(
1973         __in            efx_rxq_t *erp,
1974         __in_ecount(n)  efsys_dma_addr_t *addrp,
1975         __in            size_t size,
1976         __in            unsigned int n,
1977         __in            unsigned int completed,
1978         __in            unsigned int added);
1979
1980 extern          void
1981 efx_rx_qpush(
1982         __in    efx_rxq_t *erp,
1983         __in    unsigned int added,
1984         __inout unsigned int *pushedp);
1985
1986 extern  __checkReturn   efx_rc_t
1987 efx_rx_qflush(
1988         __in    efx_rxq_t *erp);
1989
1990 extern          void
1991 efx_rx_qenable(
1992         __in    efx_rxq_t *erp);
1993
1994 extern          void
1995 efx_rx_qdestroy(
1996         __in    efx_rxq_t *erp);
1997
1998 /* TX */
1999
2000 typedef struct efx_txq_s        efx_txq_t;
2001
2002 #if EFSYS_OPT_QSTATS
2003
2004 /* START MKCONFIG GENERATED EfxHeaderTransmitQueueBlock 12dff8778598b2db */
2005 typedef enum efx_tx_qstat_e {
2006         TX_POST,
2007         TX_POST_PIO,
2008         TX_NQSTATS
2009 } efx_tx_qstat_t;
2010
2011 /* END MKCONFIG GENERATED EfxHeaderTransmitQueueBlock */
2012
2013 #endif  /* EFSYS_OPT_QSTATS */
2014
2015 extern  __checkReturn   efx_rc_t
2016 efx_tx_init(
2017         __in            efx_nic_t *enp);
2018
2019 extern          void
2020 efx_tx_fini(
2021         __in    efx_nic_t *enp);
2022
2023 #define EFX_BUG35388_WORKAROUND(_encp)                                  \
2024         (((_encp) == NULL) ? 1 : ((_encp)->enc_bug35388_workaround != 0))
2025
2026 #define EFX_TXQ_MAXNDESCS(_encp)                                        \
2027         ((EFX_BUG35388_WORKAROUND(_encp)) ? 2048 : 4096)
2028
2029 #define EFX_TXQ_MINNDESCS               512
2030
2031 #define EFX_TXQ_SIZE(_ndescs)           ((_ndescs) * sizeof (efx_qword_t))
2032 #define EFX_TXQ_NBUFS(_ndescs)          (EFX_TXQ_SIZE(_ndescs) / EFX_BUF_SIZE)
2033 #define EFX_TXQ_LIMIT(_ndescs)          ((_ndescs) - 16)
2034 #define EFX_TXQ_DC_NDESCS(_dcsize)      (8 << _dcsize)
2035
2036 #define EFX_TXQ_MAX_BUFS 8 /* Maximum independent of EFX_BUG35388_WORKAROUND. */
2037
2038 #define EFX_TXQ_CKSUM_IPV4      0x0001
2039 #define EFX_TXQ_CKSUM_TCPUDP    0x0002
2040
2041 extern  __checkReturn   efx_rc_t
2042 efx_tx_qcreate(
2043         __in            efx_nic_t *enp,
2044         __in            unsigned int index,
2045         __in            unsigned int label,
2046         __in            efsys_mem_t *esmp,
2047         __in            size_t n,
2048         __in            uint32_t id,
2049         __in            uint16_t flags,
2050         __in            efx_evq_t *eep,
2051         __deref_out     efx_txq_t **etpp,
2052         __out           unsigned int *addedp);
2053
2054 extern  __checkReturn   efx_rc_t
2055 efx_tx_qpost(
2056         __in            efx_txq_t *etp,
2057         __in_ecount(n)  efx_buffer_t *eb,
2058         __in            unsigned int n,
2059         __in            unsigned int completed,
2060         __inout         unsigned int *addedp);
2061
2062 extern  __checkReturn   efx_rc_t
2063 efx_tx_qpace(
2064         __in            efx_txq_t *etp,
2065         __in            unsigned int ns);
2066
2067 extern                  void
2068 efx_tx_qpush(
2069         __in            efx_txq_t *etp,
2070         __in            unsigned int added,
2071         __in            unsigned int pushed);
2072
2073 extern  __checkReturn   efx_rc_t
2074 efx_tx_qflush(
2075         __in            efx_txq_t *etp);
2076
2077 extern                  void
2078 efx_tx_qenable(
2079         __in            efx_txq_t *etp);
2080
2081 extern  __checkReturn   efx_rc_t
2082 efx_tx_qpio_enable(
2083         __in            efx_txq_t *etp);
2084
2085 extern                  void
2086 efx_tx_qpio_disable(
2087         __in            efx_txq_t *etp);
2088
2089 extern  __checkReturn   efx_rc_t
2090 efx_tx_qpio_write(
2091         __in                    efx_txq_t *etp,
2092         __in_ecount(buf_length) uint8_t *buffer,
2093         __in                    size_t buf_length,
2094         __in                    size_t pio_buf_offset);
2095
2096 extern  __checkReturn   efx_rc_t
2097 efx_tx_qpio_post(
2098         __in                    efx_txq_t *etp,
2099         __in                    size_t pkt_length,
2100         __in                    unsigned int completed,
2101         __inout                 unsigned int *addedp);
2102
2103 extern  __checkReturn   efx_rc_t
2104 efx_tx_qdesc_post(
2105         __in            efx_txq_t *etp,
2106         __in_ecount(n)  efx_desc_t *ed,
2107         __in            unsigned int n,
2108         __in            unsigned int completed,
2109         __inout         unsigned int *addedp);
2110
2111 extern  void
2112 efx_tx_qdesc_dma_create(
2113         __in    efx_txq_t *etp,
2114         __in    efsys_dma_addr_t addr,
2115         __in    size_t size,
2116         __in    boolean_t eop,
2117         __out   efx_desc_t *edp);
2118
2119 extern  void
2120 efx_tx_qdesc_tso_create(
2121         __in    efx_txq_t *etp,
2122         __in    uint16_t ipv4_id,
2123         __in    uint32_t tcp_seq,
2124         __in    uint8_t  tcp_flags,
2125         __out   efx_desc_t *edp);
2126
2127 extern  void
2128 efx_tx_qdesc_vlantci_create(
2129         __in    efx_txq_t *etp,
2130         __in    uint16_t tci,
2131         __out   efx_desc_t *edp);
2132
2133 #if EFSYS_OPT_QSTATS
2134
2135 #if EFSYS_OPT_NAMES
2136
2137 extern          const char *
2138 efx_tx_qstat_name(
2139         __in    efx_nic_t *etp,
2140         __in    unsigned int id);
2141
2142 #endif  /* EFSYS_OPT_NAMES */
2143
2144 extern                                  void
2145 efx_tx_qstats_update(
2146         __in                            efx_txq_t *etp,
2147         __inout_ecount(TX_NQSTATS)      efsys_stat_t *stat);
2148
2149 #endif  /* EFSYS_OPT_QSTATS */
2150
2151 extern          void
2152 efx_tx_qdestroy(
2153         __in    efx_txq_t *etp);
2154
2155
2156 /* FILTER */
2157
2158 #if EFSYS_OPT_FILTER
2159
2160 #define EFX_ETHER_TYPE_IPV4 0x0800
2161 #define EFX_ETHER_TYPE_IPV6 0x86DD
2162
2163 #define EFX_IPPROTO_TCP 6
2164 #define EFX_IPPROTO_UDP 17
2165
2166 typedef enum efx_filter_flag_e {
2167         EFX_FILTER_FLAG_RX_RSS = 0x01,          /* use RSS to spread across
2168                                                  * multiple queues */
2169         EFX_FILTER_FLAG_RX_SCATTER = 0x02,      /* enable RX scatter */
2170         EFX_FILTER_FLAG_RX_OVER_AUTO = 0x04,    /* Override an automatic filter
2171                                                  * (priority EFX_FILTER_PRI_AUTO).
2172                                                  * May only be set by the filter
2173                                                  * implementation for each type.
2174                                                  * A removal request will
2175                                                  * restore the automatic filter
2176                                                  * in its place. */
2177         EFX_FILTER_FLAG_RX = 0x08,              /* Filter is for RX */
2178         EFX_FILTER_FLAG_TX = 0x10,              /* Filter is for TX */
2179 } efx_filter_flag_t;
2180
2181 typedef enum efx_filter_match_flags_e {
2182         EFX_FILTER_MATCH_REM_HOST = 0x0001,     /* Match by remote IP host
2183                                                  * address */
2184         EFX_FILTER_MATCH_LOC_HOST = 0x0002,     /* Match by local IP host
2185                                                  * address */
2186         EFX_FILTER_MATCH_REM_MAC = 0x0004,      /* Match by remote MAC address */
2187         EFX_FILTER_MATCH_REM_PORT = 0x0008,     /* Match by remote TCP/UDP port */
2188         EFX_FILTER_MATCH_LOC_MAC = 0x0010,      /* Match by remote TCP/UDP port */
2189         EFX_FILTER_MATCH_LOC_PORT = 0x0020,     /* Match by local TCP/UDP port */
2190         EFX_FILTER_MATCH_ETHER_TYPE = 0x0040,   /* Match by Ether-type */
2191         EFX_FILTER_MATCH_INNER_VID = 0x0080,    /* Match by inner VLAN ID */
2192         EFX_FILTER_MATCH_OUTER_VID = 0x0100,    /* Match by outer VLAN ID */
2193         EFX_FILTER_MATCH_IP_PROTO = 0x0200,     /* Match by IP transport
2194                                                  * protocol */
2195         EFX_FILTER_MATCH_LOC_MAC_IG = 0x0400,   /* Match by local MAC address
2196                                                  * I/G bit. Used for RX default
2197                                                  * unicast and multicast/
2198                                                  * broadcast filters. */
2199 } efx_filter_match_flags_t;
2200
2201 typedef enum efx_filter_priority_s {
2202         EFX_FILTER_PRI_HINT = 0,        /* Performance hint */
2203         EFX_FILTER_PRI_AUTO,            /* Automatic filter based on device
2204                                          * address list or hardware
2205                                          * requirements. This may only be used
2206                                          * by the filter implementation for
2207                                          * each NIC type. */
2208         EFX_FILTER_PRI_MANUAL,          /* Manually configured filter */
2209         EFX_FILTER_PRI_REQUIRED,        /* Required for correct behaviour of the
2210                                          * client (e.g. SR-IOV, HyperV VMQ etc.)
2211                                          */
2212 } efx_filter_priority_t;
2213
2214 /*
2215  * FIXME: All these fields are assumed to be in little-endian byte order.
2216  * It may be better for some to be big-endian. See bug42804.
2217  */
2218
2219 typedef struct efx_filter_spec_s {
2220         uint32_t        efs_match_flags:12;
2221         uint32_t        efs_priority:2;
2222         uint32_t        efs_flags:6;
2223         uint32_t        efs_dmaq_id:12;
2224         uint32_t        efs_rss_context;
2225         uint16_t        efs_outer_vid;
2226         uint16_t        efs_inner_vid;
2227         uint8_t         efs_loc_mac[EFX_MAC_ADDR_LEN];
2228         uint8_t         efs_rem_mac[EFX_MAC_ADDR_LEN];
2229         uint16_t        efs_ether_type;
2230         uint8_t         efs_ip_proto;
2231         uint16_t        efs_loc_port;
2232         uint16_t        efs_rem_port;
2233         efx_oword_t     efs_rem_host;
2234         efx_oword_t     efs_loc_host;
2235 } efx_filter_spec_t;
2236
2237
2238 /* Default values for use in filter specifications */
2239 #define EFX_FILTER_SPEC_RSS_CONTEXT_DEFAULT     0xffffffff
2240 #define EFX_FILTER_SPEC_RX_DMAQ_ID_DROP         0xfff
2241 #define EFX_FILTER_SPEC_VID_UNSPEC              0xffff
2242
2243 extern  __checkReturn   efx_rc_t
2244 efx_filter_init(
2245         __in            efx_nic_t *enp);
2246
2247 extern                  void
2248 efx_filter_fini(
2249         __in            efx_nic_t *enp);
2250
2251 extern  __checkReturn   efx_rc_t
2252 efx_filter_insert(
2253         __in            efx_nic_t *enp,
2254         __inout         efx_filter_spec_t *spec);
2255
2256 extern  __checkReturn   efx_rc_t
2257 efx_filter_remove(
2258         __in            efx_nic_t *enp,
2259         __inout         efx_filter_spec_t *spec);
2260
2261 extern  __checkReturn   efx_rc_t
2262 efx_filter_restore(
2263         __in            efx_nic_t *enp);
2264
2265 extern  __checkReturn   efx_rc_t
2266 efx_filter_supported_filters(
2267         __in            efx_nic_t *enp,
2268         __out           uint32_t *list,
2269         __out           size_t *length);
2270
2271 extern                  void
2272 efx_filter_spec_init_rx(
2273         __inout         efx_filter_spec_t *spec,
2274         __in            efx_filter_priority_t priority,
2275         __in            efx_filter_flag_t flags,
2276         __in            efx_rxq_t *erp);
2277
2278 extern                  void
2279 efx_filter_spec_init_tx(
2280         __inout         efx_filter_spec_t *spec,
2281         __in            efx_txq_t *etp);
2282
2283 extern  __checkReturn   efx_rc_t
2284 efx_filter_spec_set_ipv4_local(
2285         __inout         efx_filter_spec_t *spec,
2286         __in            uint8_t proto,
2287         __in            uint32_t host,
2288         __in            uint16_t port);
2289
2290 extern  __checkReturn   efx_rc_t
2291 efx_filter_spec_set_ipv4_full(
2292         __inout         efx_filter_spec_t *spec,
2293         __in            uint8_t proto,
2294         __in            uint32_t lhost,
2295         __in            uint16_t lport,
2296         __in            uint32_t rhost,
2297         __in            uint16_t rport);
2298
2299 extern  __checkReturn   efx_rc_t
2300 efx_filter_spec_set_eth_local(
2301         __inout         efx_filter_spec_t *spec,
2302         __in            uint16_t vid,
2303         __in            const uint8_t *addr);
2304
2305 extern  __checkReturn   efx_rc_t
2306 efx_filter_spec_set_uc_def(
2307         __inout         efx_filter_spec_t *spec);
2308
2309 extern  __checkReturn   efx_rc_t
2310 efx_filter_spec_set_mc_def(
2311         __inout         efx_filter_spec_t *spec);
2312
2313 #endif  /* EFSYS_OPT_FILTER */
2314
2315 /* HASH */
2316
2317 extern  __checkReturn           uint32_t
2318 efx_hash_dwords(
2319         __in_ecount(count)      uint32_t const *input,
2320         __in                    size_t count,
2321         __in                    uint32_t init);
2322
2323 extern  __checkReturn           uint32_t
2324 efx_hash_bytes(
2325         __in_ecount(length)     uint8_t const *input,
2326         __in                    size_t length,
2327         __in                    uint32_t init);
2328
2329
2330 #ifdef  __cplusplus
2331 }
2332 #endif
2333
2334 #endif  /* _SYS_EFX_H */