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