drivers/net/sfc/base/efx.h

   1 /*
   2  * Copyright (c) 2006-2016 Solarflare Communications Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are met:
   7  *
   8  * 1. Redistributions of source code must retain the above copyright notice,
   9  *    this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright notice,
  11  *    this list of conditions and the following disclaimer in the documentation
  12  *    and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  16  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  21  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  22  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  23  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  24  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  * The views and conclusions contained in the software and documentation are
  27  * those of the authors and should not be interpreted as representing official
  28  * policies, either expressed or implied, of the FreeBSD Project.
  29  */
  30
  31 #ifndef _SYS_EFX_H
  32 #define _SYS_EFX_H
  33
  34 #include "efsys.h"
  35 #include "efx_check.h"
  36 #include "efx_phy_ids.h"
  37
  38 #ifdef  __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 #define EFX_STATIC_ASSERT(_cond)                \
  43         ((void)sizeof(char[(_cond) ? 1 : -1]))
  44
  45 #define EFX_ARRAY_SIZE(_array)                  \
  46         (sizeof(_array) / sizeof((_array)[0]))
  47
  48 #define EFX_FIELD_OFFSET(_type, _field)         \
  49         ((size_t) &(((_type *)0)->_field))
  50
  51 /* Return codes */
  52
  53 typedef __success(return == 0) int efx_rc_t;
  54
  55
  56 /* Chip families */
  57
  58 typedef enum efx_family_e {
  59         EFX_FAMILY_INVALID,
  60         EFX_FAMILY_FALCON,      /* Obsolete and not supported */
  61         EFX_FAMILY_SIENA,
  62         EFX_FAMILY_HUNTINGTON,
  63         EFX_FAMILY_MEDFORD,
  64         EFX_FAMILY_NTYPES
  65 } efx_family_t;
  66
  67 extern  __checkReturn   efx_rc_t
  68 efx_family(
  69         __in            uint16_t venid,
  70         __in            uint16_t devid,
  71         __out           efx_family_t *efp);
  72
  73
  74 #define EFX_PCI_VENID_SFC                       0x1924
  75
  76 #define EFX_PCI_DEVID_FALCON                    0x0710  /* SFC4000 */
  77
  78 #define EFX_PCI_DEVID_BETHPAGE                  0x0803  /* SFC9020 */
  79 #define EFX_PCI_DEVID_SIENA                     0x0813  /* SFL9021 */
  80 #define EFX_PCI_DEVID_SIENA_F1_UNINIT           0x0810
  81
  82 #define EFX_PCI_DEVID_HUNTINGTON_PF_UNINIT      0x0901
  83 #define EFX_PCI_DEVID_FARMINGDALE               0x0903  /* SFC9120 PF */
  84 #define EFX_PCI_DEVID_GREENPORT                 0x0923  /* SFC9140 PF */
  85
  86 #define EFX_PCI_DEVID_FARMINGDALE_VF            0x1903  /* SFC9120 VF */
  87 #define EFX_PCI_DEVID_GREENPORT_VF              0x1923  /* SFC9140 VF */
  88
  89 #define EFX_PCI_DEVID_MEDFORD_PF_UNINIT         0x0913
  90 #define EFX_PCI_DEVID_MEDFORD                   0x0A03  /* SFC9240 PF */
  91 #define EFX_PCI_DEVID_MEDFORD_VF                0x1A03  /* SFC9240 VF */
  92
  93 #define EFX_MEM_BAR     2
  94
  95 /* Error codes */
  96
  97 enum {
  98         EFX_ERR_INVALID,
  99         EFX_ERR_SRAM_OOB,
 100         EFX_ERR_BUFID_DC_OOB,
 101         EFX_ERR_MEM_PERR,
 102         EFX_ERR_RBUF_OWN,
 103         EFX_ERR_TBUF_OWN,
 104         EFX_ERR_RDESQ_OWN,
 105         EFX_ERR_TDESQ_OWN,
 106         EFX_ERR_EVQ_OWN,
 107         EFX_ERR_EVFF_OFLO,
 108         EFX_ERR_ILL_ADDR,
 109         EFX_ERR_SRAM_PERR,
 110         EFX_ERR_NCODES
 111 };
 112
 113 /* Calculate the IEEE 802.3 CRC32 of a MAC addr */
 114 extern  __checkReturn           uint32_t
 115 efx_crc32_calculate(
 116         __in                    uint32_t crc_init,
 117         __in_ecount(length)     uint8_t const *input,
 118         __in                    int length);
 119
 120
 121 /* Type prototypes */
 122
 123 typedef struct efx_rxq_s        efx_rxq_t;
 124
 125 /* NIC */
 126
 127 typedef struct efx_nic_s        efx_nic_t;
 128
 129 extern  __checkReturn   efx_rc_t
 130 efx_nic_create(
 131         __in            efx_family_t family,
 132         __in            efsys_identifier_t *esip,
 133         __in            efsys_bar_t *esbp,
 134         __in            efsys_lock_t *eslp,
 135         __deref_out     efx_nic_t **enpp);
 136
 137 extern  __checkReturn   efx_rc_t
 138 efx_nic_probe(
 139         __in            efx_nic_t *enp);
 140
 141 extern  __checkReturn   efx_rc_t
 142 efx_nic_init(
 143         __in            efx_nic_t *enp);
 144
 145 extern  __checkReturn   efx_rc_t
 146 efx_nic_reset(
 147         __in            efx_nic_t *enp);
 148
 149 extern          void
 150 efx_nic_fini(
 151         __in            efx_nic_t *enp);
 152
 153 extern          void
 154 efx_nic_unprobe(
 155         __in            efx_nic_t *enp);
 156
 157 extern          void
 158 efx_nic_destroy(
 159         __in    efx_nic_t *enp);
 160
 161 #define EFX_PCIE_LINK_SPEED_GEN1                1
 162 #define EFX_PCIE_LINK_SPEED_GEN2                2
 163 #define EFX_PCIE_LINK_SPEED_GEN3                3
 164
 165 typedef enum efx_pcie_link_performance_e {
 166         EFX_PCIE_LINK_PERFORMANCE_UNKNOWN_BANDWIDTH,
 167         EFX_PCIE_LINK_PERFORMANCE_SUBOPTIMAL_BANDWIDTH,
 168         EFX_PCIE_LINK_PERFORMANCE_SUBOPTIMAL_LATENCY,
 169         EFX_PCIE_LINK_PERFORMANCE_OPTIMAL
 170 } efx_pcie_link_performance_t;
 171
 172 extern  __checkReturn   efx_rc_t
 173 efx_nic_calculate_pcie_link_bandwidth(
 174         __in            uint32_t pcie_link_width,
 175         __in            uint32_t pcie_link_gen,
 176         __out           uint32_t *bandwidth_mbpsp);
 177
 178 extern  __checkReturn   efx_rc_t
 179 efx_nic_check_pcie_link_speed(
 180         __in            efx_nic_t *enp,
 181         __in            uint32_t pcie_link_width,
 182         __in            uint32_t pcie_link_gen,
 183         __out           efx_pcie_link_performance_t *resultp);
 184
 185 #if EFSYS_OPT_MCDI
 186
 187 typedef struct efx_mcdi_req_s efx_mcdi_req_t;
 188
 189 typedef enum efx_mcdi_exception_e {
 190         EFX_MCDI_EXCEPTION_MC_REBOOT,
 191         EFX_MCDI_EXCEPTION_MC_BADASSERT,
 192 } efx_mcdi_exception_t;
 193
 194 #if EFSYS_OPT_MCDI_LOGGING
 195 typedef enum efx_log_msg_e {
 196         EFX_LOG_INVALID,
 197         EFX_LOG_MCDI_REQUEST,
 198         EFX_LOG_MCDI_RESPONSE,
 199 } efx_log_msg_t;
 200 #endif /* EFSYS_OPT_MCDI_LOGGING */
 201
 202 typedef struct efx_mcdi_transport_s {
 203         void            *emt_context;
 204         efsys_mem_t     *emt_dma_mem;
 205         void            (*emt_execute)(void *, efx_mcdi_req_t *);
 206         void            (*emt_ev_cpl)(void *);
 207         void            (*emt_exception)(void *, efx_mcdi_exception_t);
 208 #if EFSYS_OPT_MCDI_LOGGING
 209         void            (*emt_logger)(void *, efx_log_msg_t,
 210                                         void *, size_t, void *, size_t);
 211 #endif /* EFSYS_OPT_MCDI_LOGGING */
 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_get_timeout(
 229         __in            efx_nic_t *enp,
 230         __in            efx_mcdi_req_t *emrp,
 231         __out           uint32_t *usec_timeoutp);
 232
 233 extern                  void
 234 efx_mcdi_request_start(
 235         __in            efx_nic_t *enp,
 236         __in            efx_mcdi_req_t *emrp,
 237         __in            boolean_t ev_cpl);
 238
 239 extern  __checkReturn   boolean_t
 240 efx_mcdi_request_poll(
 241         __in            efx_nic_t *enp);
 242
 243 extern  __checkReturn   boolean_t
 244 efx_mcdi_request_abort(
 245         __in            efx_nic_t *enp);
 246
 247 extern                  void
 248 efx_mcdi_fini(
 249         __in            efx_nic_t *enp);
 250
 251 #endif  /* EFSYS_OPT_MCDI */
 252
 253 /* INTR */
 254
 255 #define EFX_NINTR_SIENA 1024
 256
 257 typedef enum efx_intr_type_e {
 258         EFX_INTR_INVALID = 0,
 259         EFX_INTR_LINE,
 260         EFX_INTR_MESSAGE,
 261         EFX_INTR_NTYPES
 262 } efx_intr_type_t;
 263
 264 #define EFX_INTR_SIZE   (sizeof (efx_oword_t))
 265
 266 extern  __checkReturn   efx_rc_t
 267 efx_intr_init(
 268         __in            efx_nic_t *enp,
 269         __in            efx_intr_type_t type,
 270         __in            efsys_mem_t *esmp);
 271
 272 extern                  void
 273 efx_intr_enable(
 274         __in            efx_nic_t *enp);
 275
 276 extern                  void
 277 efx_intr_disable(
 278         __in            efx_nic_t *enp);
 279
 280 extern                  void
 281 efx_intr_disable_unlocked(
 282         __in            efx_nic_t *enp);
 283
 284 #define EFX_INTR_NEVQS  32
 285
 286 extern  __checkReturn   efx_rc_t
 287 efx_intr_trigger(
 288         __in            efx_nic_t *enp,
 289         __in            unsigned int level);
 290
 291 extern                  void
 292 efx_intr_status_line(
 293         __in            efx_nic_t *enp,
 294         __out           boolean_t *fatalp,
 295         __out           uint32_t *maskp);
 296
 297 extern                  void
 298 efx_intr_status_message(
 299         __in            efx_nic_t *enp,
 300         __in            unsigned int message,
 301         __out           boolean_t *fatalp);
 302
 303 extern                  void
 304 efx_intr_fatal(
 305         __in            efx_nic_t *enp);
 306
 307 extern                  void
 308 efx_intr_fini(
 309         __in            efx_nic_t *enp);
 310
 311 /* MAC */
 312
 313 typedef enum efx_link_mode_e {
 314         EFX_LINK_UNKNOWN = 0,
 315         EFX_LINK_DOWN,
 316         EFX_LINK_10HDX,
 317         EFX_LINK_10FDX,
 318         EFX_LINK_100HDX,
 319         EFX_LINK_100FDX,
 320         EFX_LINK_1000HDX,
 321         EFX_LINK_1000FDX,
 322         EFX_LINK_10000FDX,
 323         EFX_LINK_40000FDX,
 324         EFX_LINK_NMODES
 325 } efx_link_mode_t;
 326
 327 #define EFX_MAC_ADDR_LEN 6
 328
 329 #define EFX_MAC_ADDR_IS_MULTICAST(_address) (((uint8_t *)_address)[0] & 0x01)
 330
 331 #define EFX_MAC_MULTICAST_LIST_MAX      256
 332
 333 #define EFX_MAC_SDU_MAX 9202
 334
 335 #define EFX_MAC_PDU_ADJUSTMENT                                  \
 336         (/* EtherII */ 14                                       \
 337             + /* VLAN */ 4                                      \
 338             + /* CRC */ 4                                       \
 339             + /* bug16011 */ 16)                                \
 340
 341 #define EFX_MAC_PDU(_sdu)                                       \
 342         P2ROUNDUP((_sdu) + EFX_MAC_PDU_ADJUSTMENT, 8)
 343
 344 /*
 345  * Due to the P2ROUNDUP in EFX_MAC_PDU(), EFX_MAC_SDU_FROM_PDU() may give
 346  * the SDU rounded up slightly.
 347  */
 348 #define EFX_MAC_SDU_FROM_PDU(_pdu)      ((_pdu) - EFX_MAC_PDU_ADJUSTMENT)
 349
 350 #define EFX_MAC_PDU_MIN 60
 351 #define EFX_MAC_PDU_MAX EFX_MAC_PDU(EFX_MAC_SDU_MAX)
 352
 353 extern  __checkReturn   efx_rc_t
 354 efx_mac_pdu_get(
 355         __in            efx_nic_t *enp,
 356         __out           size_t *pdu);
 357
 358 extern  __checkReturn   efx_rc_t
 359 efx_mac_pdu_set(
 360         __in            efx_nic_t *enp,
 361         __in            size_t pdu);
 362
 363 extern  __checkReturn   efx_rc_t
 364 efx_mac_addr_set(
 365         __in            efx_nic_t *enp,
 366         __in            uint8_t *addr);
 367
 368 extern  __checkReturn                   efx_rc_t
 369 efx_mac_filter_set(
 370         __in                            efx_nic_t *enp,
 371         __in                            boolean_t all_unicst,
 372         __in                            boolean_t mulcst,
 373         __in                            boolean_t all_mulcst,
 374         __in                            boolean_t brdcst);
 375
 376 extern  __checkReturn   efx_rc_t
 377 efx_mac_multicast_list_set(
 378         __in                            efx_nic_t *enp,
 379         __in_ecount(6*count)            uint8_t const *addrs,
 380         __in                            int count);
 381
 382 extern  __checkReturn   efx_rc_t
 383 efx_mac_filter_default_rxq_set(
 384         __in            efx_nic_t *enp,
 385         __in            efx_rxq_t *erp,
 386         __in            boolean_t using_rss);
 387
 388 extern                  void
 389 efx_mac_filter_default_rxq_clear(
 390         __in            efx_nic_t *enp);
 391
 392 extern  __checkReturn   efx_rc_t
 393 efx_mac_drain(
 394         __in            efx_nic_t *enp,
 395         __in            boolean_t enabled);
 396
 397 extern  __checkReturn   efx_rc_t
 398 efx_mac_up(
 399         __in            efx_nic_t *enp,
 400         __out           boolean_t *mac_upp);
 401
 402 #define EFX_FCNTL_RESPOND       0x00000001
 403 #define EFX_FCNTL_GENERATE      0x00000002
 404
 405 extern  __checkReturn   efx_rc_t
 406 efx_mac_fcntl_set(
 407         __in            efx_nic_t *enp,
 408         __in            unsigned int fcntl,
 409         __in            boolean_t autoneg);
 410
 411 extern                  void
 412 efx_mac_fcntl_get(
 413         __in            efx_nic_t *enp,
 414         __out           unsigned int *fcntl_wantedp,
 415         __out           unsigned int *fcntl_linkp);
 416
 417
 418 /* MON */
 419
 420 typedef enum efx_mon_type_e {
 421         EFX_MON_INVALID = 0,
 422         EFX_MON_SFC90X0,
 423         EFX_MON_SFC91X0,
 424         EFX_MON_SFC92X0,
 425         EFX_MON_NTYPES
 426 } efx_mon_type_t;
 427
 428 #if EFSYS_OPT_NAMES
 429
 430 extern          const char *
 431 efx_mon_name(
 432         __in    efx_nic_t *enp);
 433
 434 #endif  /* EFSYS_OPT_NAMES */
 435
 436 extern  __checkReturn   efx_rc_t
 437 efx_mon_init(
 438         __in            efx_nic_t *enp);
 439
 440 extern          void
 441 efx_mon_fini(
 442         __in    efx_nic_t *enp);
 443
 444 /* PHY */
 445
 446 extern  __checkReturn   efx_rc_t
 447 efx_phy_verify(
 448         __in            efx_nic_t *enp);
 449
 450 extern  __checkReturn   efx_rc_t
 451 efx_port_init(
 452         __in            efx_nic_t *enp);
 453
 454 extern  __checkReturn   efx_rc_t
 455 efx_port_poll(
 456         __in            efx_nic_t *enp,
 457         __out_opt       efx_link_mode_t *link_modep);
 458
 459 extern          void
 460 efx_port_fini(
 461         __in    efx_nic_t *enp);
 462
 463 typedef enum efx_phy_cap_type_e {
 464         EFX_PHY_CAP_INVALID = 0,
 465         EFX_PHY_CAP_10HDX,
 466         EFX_PHY_CAP_10FDX,
 467         EFX_PHY_CAP_100HDX,
 468         EFX_PHY_CAP_100FDX,
 469         EFX_PHY_CAP_1000HDX,
 470         EFX_PHY_CAP_1000FDX,
 471         EFX_PHY_CAP_10000FDX,
 472         EFX_PHY_CAP_PAUSE,
 473         EFX_PHY_CAP_ASYM,
 474         EFX_PHY_CAP_AN,
 475         EFX_PHY_CAP_40000FDX,
 476         EFX_PHY_CAP_NTYPES
 477 } efx_phy_cap_type_t;
 478
 479
 480 #define EFX_PHY_CAP_CURRENT     0x00000000
 481 #define EFX_PHY_CAP_DEFAULT     0x00000001
 482 #define EFX_PHY_CAP_PERM        0x00000002
 483
 484 extern          void
 485 efx_phy_adv_cap_get(
 486         __in            efx_nic_t *enp,
 487         __in            uint32_t flag,
 488         __out           uint32_t *maskp);
 489
 490 extern  __checkReturn   efx_rc_t
 491 efx_phy_adv_cap_set(
 492         __in            efx_nic_t *enp,
 493         __in            uint32_t mask);
 494
 495 extern                  void
 496 efx_phy_lp_cap_get(
 497         __in            efx_nic_t *enp,
 498         __out           uint32_t *maskp);
 499
 500 extern  __checkReturn   efx_rc_t
 501 efx_phy_oui_get(
 502         __in            efx_nic_t *enp,
 503         __out           uint32_t *ouip);
 504
 505 typedef enum efx_phy_media_type_e {
 506         EFX_PHY_MEDIA_INVALID = 0,
 507         EFX_PHY_MEDIA_XAUI,
 508         EFX_PHY_MEDIA_CX4,
 509         EFX_PHY_MEDIA_KX4,
 510         EFX_PHY_MEDIA_XFP,
 511         EFX_PHY_MEDIA_SFP_PLUS,
 512         EFX_PHY_MEDIA_BASE_T,
 513         EFX_PHY_MEDIA_QSFP_PLUS,
 514         EFX_PHY_MEDIA_NTYPES
 515 } efx_phy_media_type_t;
 516
 517 /* Get the type of medium currently used.  If the board has ports for
 518  * modules, a module is present, and we recognise the media type of
 519  * the module, then this will be the media type of the module.
 520  * Otherwise it will be the media type of the port.
 521  */
 522 extern                  void
 523 efx_phy_media_type_get(
 524         __in            efx_nic_t *enp,
 525         __out           efx_phy_media_type_t *typep);
 526
 527 extern                                  efx_rc_t
 528 efx_phy_module_get_info(
 529         __in                            efx_nic_t *enp,
 530         __in                            uint8_t dev_addr,
 531         __in                            uint8_t offset,
 532         __in                            uint8_t len,
 533         __out_bcount(len)               uint8_t *data);
 534
 535
 536 #define EFX_FEATURE_IPV6                0x00000001
 537 #define EFX_FEATURE_LFSR_HASH_INSERT    0x00000002
 538 #define EFX_FEATURE_LINK_EVENTS         0x00000004
 539 #define EFX_FEATURE_PERIODIC_MAC_STATS  0x00000008
 540 #define EFX_FEATURE_MCDI                0x00000020
 541 #define EFX_FEATURE_LOOKAHEAD_SPLIT     0x00000040
 542 #define EFX_FEATURE_MAC_HEADER_FILTERS  0x00000080
 543 #define EFX_FEATURE_TURBO               0x00000100
 544 #define EFX_FEATURE_MCDI_DMA            0x00000200
 545 #define EFX_FEATURE_TX_SRC_FILTERS      0x00000400
 546 #define EFX_FEATURE_PIO_BUFFERS         0x00000800
 547 #define EFX_FEATURE_FW_ASSISTED_TSO     0x00001000
 548 #define EFX_FEATURE_FW_ASSISTED_TSO_V2  0x00002000
 549 #define EFX_FEATURE_PACKED_STREAM       0x00004000
 550
 551 typedef struct efx_nic_cfg_s {
 552         uint32_t                enc_board_type;
 553         uint32_t                enc_phy_type;
 554 #if EFSYS_OPT_NAMES
 555         char                    enc_phy_name[21];
 556 #endif
 557         char                    enc_phy_revision[21];
 558         efx_mon_type_t          enc_mon_type;
 559         unsigned int            enc_features;
 560         uint8_t                 enc_mac_addr[6];
 561         uint8_t                 enc_port;       /* PHY port number */
 562         uint32_t                enc_intr_vec_base;
 563         uint32_t                enc_intr_limit;
 564         uint32_t                enc_evq_limit;
 565         uint32_t                enc_txq_limit;
 566         uint32_t                enc_rxq_limit;
 567         uint32_t                enc_txq_max_ndescs;
 568         uint32_t                enc_buftbl_limit;
 569         uint32_t                enc_piobuf_limit;
 570         uint32_t                enc_piobuf_size;
 571         uint32_t                enc_piobuf_min_alloc_size;
 572         uint32_t                enc_evq_timer_quantum_ns;
 573         uint32_t                enc_evq_timer_max_us;
 574         uint32_t                enc_clk_mult;
 575         uint32_t                enc_rx_prefix_size;
 576         uint32_t                enc_rx_buf_align_start;
 577         uint32_t                enc_rx_buf_align_end;
 578 #if EFSYS_OPT_MCDI
 579         uint8_t                 enc_mcdi_mdio_channel;
 580 #endif  /* EFSYS_OPT_MCDI */
 581         boolean_t               enc_bug26807_workaround;
 582         boolean_t               enc_bug35388_workaround;
 583         boolean_t               enc_bug41750_workaround;
 584         boolean_t               enc_bug61265_workaround;
 585         boolean_t               enc_rx_batching_enabled;
 586         /* Maximum number of descriptors completed in an rx event. */
 587         uint32_t                enc_rx_batch_max;
 588         /* Number of rx descriptors the hardware requires for a push. */
 589         uint32_t                enc_rx_push_align;
 590         /*
 591          * Maximum number of bytes into the packet the TCP header can start for
 592          * the hardware to apply TSO packet edits.
 593          */
 594         uint32_t                enc_tx_tso_tcp_header_offset_limit;
 595         boolean_t               enc_fw_assisted_tso_enabled;
 596         boolean_t               enc_fw_assisted_tso_v2_enabled;
 597         /* Number of TSO contexts on the NIC (FATSOv2) */
 598         uint32_t                enc_fw_assisted_tso_v2_n_contexts;
 599         boolean_t               enc_hw_tx_insert_vlan_enabled;
 600         /* Number of PFs on the NIC */
 601         uint32_t                enc_hw_pf_count;
 602         /* Datapath firmware vadapter/vport/vswitch support */
 603         boolean_t               enc_datapath_cap_evb;
 604         boolean_t               enc_rx_disable_scatter_supported;
 605         boolean_t               enc_allow_set_mac_with_installed_filters;
 606         boolean_t               enc_enhanced_set_mac_supported;
 607         boolean_t               enc_init_evq_v2_supported;
 608         boolean_t               enc_rx_packed_stream_supported;
 609         boolean_t               enc_rx_var_packed_stream_supported;
 610         boolean_t               enc_pm_and_rxdp_counters;
 611         boolean_t               enc_mac_stats_40g_tx_size_bins;
 612         /* External port identifier */
 613         uint8_t                 enc_external_port;
 614         uint32_t                enc_mcdi_max_payload_length;
 615         /* VPD may be per-PF or global */
 616         boolean_t               enc_vpd_is_global;
 617         /* Minimum unidirectional bandwidth in Mb/s to max out all ports */
 618         uint32_t                enc_required_pcie_bandwidth_mbps;
 619         uint32_t                enc_max_pcie_link_gen;
 620         /* Firmware verifies integrity of NVRAM updates */
 621         uint32_t                enc_fw_verified_nvram_update_required;
 622 } efx_nic_cfg_t;
 623
 624 #define EFX_PCI_FUNCTION_IS_PF(_encp)   ((_encp)->enc_vf == 0xffff)
 625 #define EFX_PCI_FUNCTION_IS_VF(_encp)   ((_encp)->enc_vf != 0xffff)
 626
 627 #define EFX_PCI_FUNCTION(_encp) \
 628         (EFX_PCI_FUNCTION_IS_PF(_encp) ? (_encp)->enc_pf : (_encp)->enc_vf)
 629
 630 #define EFX_PCI_VF_PARENT(_encp)        ((_encp)->enc_pf)
 631
 632 extern                  const efx_nic_cfg_t *
 633 efx_nic_cfg_get(
 634         __in            efx_nic_t *enp);
 635
 636 /* Driver resource limits (minimum required/maximum usable). */
 637 typedef struct efx_drv_limits_s {
 638         uint32_t        edl_min_evq_count;
 639         uint32_t        edl_max_evq_count;
 640
 641         uint32_t        edl_min_rxq_count;
 642         uint32_t        edl_max_rxq_count;
 643
 644         uint32_t        edl_min_txq_count;
 645         uint32_t        edl_max_txq_count;
 646
 647         /* PIO blocks (sub-allocated from piobuf) */
 648         uint32_t        edl_min_pio_alloc_size;
 649         uint32_t        edl_max_pio_alloc_count;
 650 } efx_drv_limits_t;
 651
 652 extern  __checkReturn   efx_rc_t
 653 efx_nic_set_drv_limits(
 654         __inout         efx_nic_t *enp,
 655         __in            efx_drv_limits_t *edlp);
 656
 657 typedef enum efx_nic_region_e {
 658         EFX_REGION_VI,                  /* Memory BAR UC mapping */
 659         EFX_REGION_PIO_WRITE_VI,        /* Memory BAR WC mapping */
 660 } efx_nic_region_t;
 661
 662 extern  __checkReturn   efx_rc_t
 663 efx_nic_get_bar_region(
 664         __in            efx_nic_t *enp,
 665         __in            efx_nic_region_t region,
 666         __out           uint32_t *offsetp,
 667         __out           size_t *sizep);
 668
 669 extern  __checkReturn   efx_rc_t
 670 efx_nic_get_vi_pool(
 671         __in            efx_nic_t *enp,
 672         __out           uint32_t *evq_countp,
 673         __out           uint32_t *rxq_countp,
 674         __out           uint32_t *txq_countp);
 675
 676
 677 /* NVRAM */
 678
 679 extern  __checkReturn   efx_rc_t
 680 efx_sram_buf_tbl_set(
 681         __in            efx_nic_t *enp,
 682         __in            uint32_t id,
 683         __in            efsys_mem_t *esmp,
 684         __in            size_t n);
 685
 686 extern          void
 687 efx_sram_buf_tbl_clear(
 688         __in    efx_nic_t *enp,
 689         __in    uint32_t id,
 690         __in    size_t n);
 691
 692 #define EFX_BUF_TBL_SIZE        0x20000
 693
 694 #define EFX_BUF_SIZE            4096
 695
 696 /* EV */
 697
 698 typedef struct efx_evq_s        efx_evq_t;
 699
 700 extern  __checkReturn   efx_rc_t
 701 efx_ev_init(
 702         __in            efx_nic_t *enp);
 703
 704 extern          void
 705 efx_ev_fini(
 706         __in            efx_nic_t *enp);
 707
 708 #define EFX_EVQ_MAXNEVS         32768
 709 #define EFX_EVQ_MINNEVS         512
 710
 711 #define EFX_EVQ_SIZE(_nevs)     ((_nevs) * sizeof (efx_qword_t))
 712 #define EFX_EVQ_NBUFS(_nevs)    (EFX_EVQ_SIZE(_nevs) / EFX_BUF_SIZE)
 713
 714 #define EFX_EVQ_FLAGS_TYPE_MASK         (0x3)
 715 #define EFX_EVQ_FLAGS_TYPE_AUTO         (0x0)
 716 #define EFX_EVQ_FLAGS_TYPE_THROUGHPUT   (0x1)
 717 #define EFX_EVQ_FLAGS_TYPE_LOW_LATENCY  (0x2)
 718
 719 #define EFX_EVQ_FLAGS_NOTIFY_MASK       (0xC)
 720 #define EFX_EVQ_FLAGS_NOTIFY_INTERRUPT  (0x0)   /* Interrupting (default) */
 721 #define EFX_EVQ_FLAGS_NOTIFY_DISABLED   (0x4)   /* Non-interrupting */
 722
 723 extern  __checkReturn   efx_rc_t
 724 efx_ev_qcreate(
 725         __in            efx_nic_t *enp,
 726         __in            unsigned int index,
 727         __in            efsys_mem_t *esmp,
 728         __in            size_t n,
 729         __in            uint32_t id,
 730         __in            uint32_t us,
 731         __in            uint32_t flags,
 732         __deref_out     efx_evq_t **eepp);
 733
 734 extern          void
 735 efx_ev_qpost(
 736         __in            efx_evq_t *eep,
 737         __in            uint16_t data);
 738
 739 typedef __checkReturn   boolean_t
 740 (*efx_initialized_ev_t)(
 741         __in_opt        void *arg);
 742
 743 #define EFX_PKT_UNICAST         0x0004
 744 #define EFX_PKT_START           0x0008
 745
 746 #define EFX_PKT_VLAN_TAGGED     0x0010
 747 #define EFX_CKSUM_TCPUDP        0x0020
 748 #define EFX_CKSUM_IPV4          0x0040
 749 #define EFX_PKT_CONT            0x0080
 750
 751 #define EFX_CHECK_VLAN          0x0100
 752 #define EFX_PKT_TCP             0x0200
 753 #define EFX_PKT_UDP             0x0400
 754 #define EFX_PKT_IPV4            0x0800
 755
 756 #define EFX_PKT_IPV6            0x1000
 757 #define EFX_PKT_PREFIX_LEN      0x2000
 758 #define EFX_ADDR_MISMATCH       0x4000
 759 #define EFX_DISCARD             0x8000
 760
 761 /*
 762  * The following flags are used only for packed stream
 763  * mode. The values for the flags are reused to fit into 16 bit,
 764  * since EFX_PKT_START and EFX_PKT_CONT are never used in
 765  * packed stream mode
 766  */
 767 #define EFX_PKT_PACKED_STREAM_NEW_BUFFER        EFX_PKT_START
 768 #define EFX_PKT_PACKED_STREAM_PARSE_INCOMPLETE  EFX_PKT_CONT
 769
 770
 771 #define EFX_EV_RX_NLABELS       32
 772 #define EFX_EV_TX_NLABELS       32
 773
 774 typedef __checkReturn   boolean_t
 775 (*efx_rx_ev_t)(
 776         __in_opt        void *arg,
 777         __in            uint32_t label,
 778         __in            uint32_t id,
 779         __in            uint32_t size,
 780         __in            uint16_t flags);
 781
 782 typedef __checkReturn   boolean_t
 783 (*efx_tx_ev_t)(
 784         __in_opt        void *arg,
 785         __in            uint32_t label,
 786         __in            uint32_t id);
 787
 788 #define EFX_EXCEPTION_RX_RECOVERY       0x00000001
 789 #define EFX_EXCEPTION_RX_DSC_ERROR      0x00000002
 790 #define EFX_EXCEPTION_TX_DSC_ERROR      0x00000003
 791 #define EFX_EXCEPTION_UNKNOWN_SENSOREVT 0x00000004
 792 #define EFX_EXCEPTION_FWALERT_SRAM      0x00000005
 793 #define EFX_EXCEPTION_UNKNOWN_FWALERT   0x00000006
 794 #define EFX_EXCEPTION_RX_ERROR          0x00000007
 795 #define EFX_EXCEPTION_TX_ERROR          0x00000008
 796 #define EFX_EXCEPTION_EV_ERROR          0x00000009
 797
 798 typedef __checkReturn   boolean_t
 799 (*efx_exception_ev_t)(
 800         __in_opt        void *arg,
 801         __in            uint32_t label,
 802         __in            uint32_t data);
 803
 804 typedef __checkReturn   boolean_t
 805 (*efx_rxq_flush_done_ev_t)(
 806         __in_opt        void *arg,
 807         __in            uint32_t rxq_index);
 808
 809 typedef __checkReturn   boolean_t
 810 (*efx_rxq_flush_failed_ev_t)(
 811         __in_opt        void *arg,
 812         __in            uint32_t rxq_index);
 813
 814 typedef __checkReturn   boolean_t
 815 (*efx_txq_flush_done_ev_t)(
 816         __in_opt        void *arg,
 817         __in            uint32_t txq_index);
 818
 819 typedef __checkReturn   boolean_t
 820 (*efx_software_ev_t)(
 821         __in_opt        void *arg,
 822         __in            uint16_t magic);
 823
 824 typedef __checkReturn   boolean_t
 825 (*efx_sram_ev_t)(
 826         __in_opt        void *arg,
 827         __in            uint32_t code);
 828
 829 #define EFX_SRAM_CLEAR          0
 830 #define EFX_SRAM_UPDATE         1
 831 #define EFX_SRAM_ILLEGAL_CLEAR  2
 832
 833 typedef __checkReturn   boolean_t
 834 (*efx_wake_up_ev_t)(
 835         __in_opt        void *arg,
 836         __in            uint32_t label);
 837
 838 typedef __checkReturn   boolean_t
 839 (*efx_timer_ev_t)(
 840         __in_opt        void *arg,
 841         __in            uint32_t label);
 842
 843 typedef __checkReturn   boolean_t
 844 (*efx_link_change_ev_t)(
 845         __in_opt        void *arg,
 846         __in            efx_link_mode_t link_mode);
 847
 848 typedef struct efx_ev_callbacks_s {
 849         efx_initialized_ev_t            eec_initialized;
 850         efx_rx_ev_t                     eec_rx;
 851         efx_tx_ev_t                     eec_tx;
 852         efx_exception_ev_t              eec_exception;
 853         efx_rxq_flush_done_ev_t         eec_rxq_flush_done;
 854         efx_rxq_flush_failed_ev_t       eec_rxq_flush_failed;
 855         efx_txq_flush_done_ev_t         eec_txq_flush_done;
 856         efx_software_ev_t               eec_software;
 857         efx_sram_ev_t                   eec_sram;
 858         efx_wake_up_ev_t                eec_wake_up;
 859         efx_timer_ev_t                  eec_timer;
 860         efx_link_change_ev_t            eec_link_change;
 861 } efx_ev_callbacks_t;
 862
 863 extern  __checkReturn   boolean_t
 864 efx_ev_qpending(
 865         __in            efx_evq_t *eep,
 866         __in            unsigned int count);
 867
 868 extern                  void
 869 efx_ev_qpoll(
 870         __in            efx_evq_t *eep,
 871         __inout         unsigned int *countp,
 872         __in            const efx_ev_callbacks_t *eecp,
 873         __in_opt        void *arg);
 874
 875 extern  __checkReturn   efx_rc_t
 876 efx_ev_usecs_to_ticks(
 877         __in            efx_nic_t *enp,
 878         __in            unsigned int usecs,
 879         __out           unsigned int *ticksp);
 880
 881 extern  __checkReturn   efx_rc_t
 882 efx_ev_qmoderate(
 883         __in            efx_evq_t *eep,
 884         __in            unsigned int us);
 885
 886 extern  __checkReturn   efx_rc_t
 887 efx_ev_qprime(
 888         __in            efx_evq_t *eep,
 889         __in            unsigned int count);
 890
 891 extern          void
 892 efx_ev_qdestroy(
 893         __in    efx_evq_t *eep);
 894
 895 /* RX */
 896
 897 extern  __checkReturn   efx_rc_t
 898 efx_rx_init(
 899         __inout         efx_nic_t *enp);
 900
 901 extern          void
 902 efx_rx_fini(
 903         __in            efx_nic_t *enp);
 904
 905 extern  __checkReturn   efx_rc_t
 906 efx_pseudo_hdr_pkt_length_get(
 907         __in            efx_rxq_t *erp,
 908         __in            uint8_t *buffer,
 909         __out           uint16_t *pkt_lengthp);
 910
 911 #define EFX_RXQ_MAXNDESCS               4096
 912 #define EFX_RXQ_MINNDESCS               512
 913
 914 #define EFX_RXQ_SIZE(_ndescs)           ((_ndescs) * sizeof (efx_qword_t))
 915 #define EFX_RXQ_NBUFS(_ndescs)          (EFX_RXQ_SIZE(_ndescs) / EFX_BUF_SIZE)
 916 #define EFX_RXQ_LIMIT(_ndescs)          ((_ndescs) - 16)
 917 #define EFX_RXQ_DC_NDESCS(_dcsize)      (8 << _dcsize)
 918
 919 typedef enum efx_rxq_type_e {
 920         EFX_RXQ_TYPE_DEFAULT,
 921         EFX_RXQ_TYPE_SCATTER,
 922         EFX_RXQ_TYPE_PACKED_STREAM_1M,
 923         EFX_RXQ_TYPE_PACKED_STREAM_512K,
 924         EFX_RXQ_TYPE_PACKED_STREAM_256K,
 925         EFX_RXQ_TYPE_PACKED_STREAM_128K,
 926         EFX_RXQ_TYPE_PACKED_STREAM_64K,
 927         EFX_RXQ_NTYPES
 928 } efx_rxq_type_t;
 929
 930 extern  __checkReturn   efx_rc_t
 931 efx_rx_qcreate(
 932         __in            efx_nic_t *enp,
 933         __in            unsigned int index,
 934         __in            unsigned int label,
 935         __in            efx_rxq_type_t type,
 936         __in            efsys_mem_t *esmp,
 937         __in            size_t n,
 938         __in            uint32_t id,
 939         __in            efx_evq_t *eep,
 940         __deref_out     efx_rxq_t **erpp);
 941
 942 typedef struct efx_buffer_s {
 943         efsys_dma_addr_t        eb_addr;
 944         size_t                  eb_size;
 945         boolean_t               eb_eop;
 946 } efx_buffer_t;
 947
 948 typedef struct efx_desc_s {
 949         efx_qword_t ed_eq;
 950 } efx_desc_t;
 951
 952 extern                  void
 953 efx_rx_qpost(
 954         __in            efx_rxq_t *erp,
 955         __in_ecount(n)  efsys_dma_addr_t *addrp,
 956         __in            size_t size,
 957         __in            unsigned int n,
 958         __in            unsigned int completed,
 959         __in            unsigned int added);
 960
 961 extern          void
 962 efx_rx_qpush(
 963         __in    efx_rxq_t *erp,
 964         __in    unsigned int added,
 965         __inout unsigned int *pushedp);
 966
 967 extern  __checkReturn   efx_rc_t
 968 efx_rx_qflush(
 969         __in    efx_rxq_t *erp);
 970
 971 extern          void
 972 efx_rx_qenable(
 973         __in    efx_rxq_t *erp);
 974
 975 extern          void
 976 efx_rx_qdestroy(
 977         __in    efx_rxq_t *erp);
 978
 979 /* TX */
 980
 981 typedef struct efx_txq_s        efx_txq_t;
 982
 983 extern  __checkReturn   efx_rc_t
 984 efx_tx_init(
 985         __in            efx_nic_t *enp);
 986
 987 extern          void
 988 efx_tx_fini(
 989         __in    efx_nic_t *enp);
 990
 991 #define EFX_TXQ_MINNDESCS               512
 992
 993 #define EFX_TXQ_SIZE(_ndescs)           ((_ndescs) * sizeof (efx_qword_t))
 994 #define EFX_TXQ_NBUFS(_ndescs)          (EFX_TXQ_SIZE(_ndescs) / EFX_BUF_SIZE)
 995 #define EFX_TXQ_LIMIT(_ndescs)          ((_ndescs) - 16)
 996 #define EFX_TXQ_DC_NDESCS(_dcsize)      (8 << _dcsize)
 997
 998 #define EFX_TXQ_MAX_BUFS 8 /* Maximum independent of EFX_BUG35388_WORKAROUND. */
 999
1000 #define EFX_TXQ_CKSUM_IPV4      0x0001
1001 #define EFX_TXQ_CKSUM_TCPUDP    0x0002
1002 #define EFX_TXQ_FATSOV2         0x0004
1003
1004 extern  __checkReturn   efx_rc_t
1005 efx_tx_qcreate(
1006         __in            efx_nic_t *enp,
1007         __in            unsigned int index,
1008         __in            unsigned int label,
1009         __in            efsys_mem_t *esmp,
1010         __in            size_t n,
1011         __in            uint32_t id,
1012         __in            uint16_t flags,
1013         __in            efx_evq_t *eep,
1014         __deref_out     efx_txq_t **etpp,
1015         __out           unsigned int *addedp);
1016
1017 extern  __checkReturn   efx_rc_t
1018 efx_tx_qpost(
1019         __in            efx_txq_t *etp,
1020         __in_ecount(n)  efx_buffer_t *eb,
1021         __in            unsigned int n,
1022         __in            unsigned int completed,
1023         __inout         unsigned int *addedp);
1024
1025 extern  __checkReturn   efx_rc_t
1026 efx_tx_qpace(
1027         __in            efx_txq_t *etp,
1028         __in            unsigned int ns);
1029
1030 extern                  void
1031 efx_tx_qpush(
1032         __in            efx_txq_t *etp,
1033         __in            unsigned int added,
1034         __in            unsigned int pushed);
1035
1036 extern  __checkReturn   efx_rc_t
1037 efx_tx_qflush(
1038         __in            efx_txq_t *etp);
1039
1040 extern                  void
1041 efx_tx_qenable(
1042         __in            efx_txq_t *etp);
1043
1044 extern  __checkReturn   efx_rc_t
1045 efx_tx_qpio_enable(
1046         __in            efx_txq_t *etp);
1047
1048 extern                  void
1049 efx_tx_qpio_disable(
1050         __in            efx_txq_t *etp);
1051
1052 extern  __checkReturn   efx_rc_t
1053 efx_tx_qpio_write(
1054         __in                    efx_txq_t *etp,
1055         __in_ecount(buf_length) uint8_t *buffer,
1056         __in                    size_t buf_length,
1057         __in                    size_t pio_buf_offset);
1058
1059 extern  __checkReturn   efx_rc_t
1060 efx_tx_qpio_post(
1061         __in                    efx_txq_t *etp,
1062         __in                    size_t pkt_length,
1063         __in                    unsigned int completed,
1064         __inout                 unsigned int *addedp);
1065
1066 extern  __checkReturn   efx_rc_t
1067 efx_tx_qdesc_post(
1068         __in            efx_txq_t *etp,
1069         __in_ecount(n)  efx_desc_t *ed,
1070         __in            unsigned int n,
1071         __in            unsigned int completed,
1072         __inout         unsigned int *addedp);
1073
1074 extern  void
1075 efx_tx_qdesc_dma_create(
1076         __in    efx_txq_t *etp,
1077         __in    efsys_dma_addr_t addr,
1078         __in    size_t size,
1079         __in    boolean_t eop,
1080         __out   efx_desc_t *edp);
1081
1082 extern  void
1083 efx_tx_qdesc_tso_create(
1084         __in    efx_txq_t *etp,
1085         __in    uint16_t ipv4_id,
1086         __in    uint32_t tcp_seq,
1087         __in    uint8_t  tcp_flags,
1088         __out   efx_desc_t *edp);
1089
1090 /* Number of FATSOv2 option descriptors */
1091 #define EFX_TX_FATSOV2_OPT_NDESCS               2
1092
1093 /* Maximum number of DMA segments per TSO packet (not superframe) */
1094 #define EFX_TX_FATSOV2_DMA_SEGS_PER_PKT_MAX     24
1095
1096 extern  void
1097 efx_tx_qdesc_tso2_create(
1098         __in                    efx_txq_t *etp,
1099         __in                    uint16_t ipv4_id,
1100         __in                    uint32_t tcp_seq,
1101         __in                    uint16_t tcp_mss,
1102         __out_ecount(count)     efx_desc_t *edp,
1103         __in                    int count);
1104
1105 extern  void
1106 efx_tx_qdesc_vlantci_create(
1107         __in    efx_txq_t *etp,
1108         __in    uint16_t tci,
1109         __out   efx_desc_t *edp);
1110
1111 extern          void
1112 efx_tx_qdestroy(
1113         __in    efx_txq_t *etp);
1114
1115
1116 /* FILTER */
1117
1118 #if EFSYS_OPT_FILTER
1119
1120 #define EFX_ETHER_TYPE_IPV4 0x0800
1121 #define EFX_ETHER_TYPE_IPV6 0x86DD
1122
1123 #define EFX_IPPROTO_TCP 6
1124 #define EFX_IPPROTO_UDP 17
1125
1126 /* Use RSS to spread across multiple queues */
1127 #define EFX_FILTER_FLAG_RX_RSS          0x01
1128 /* Enable RX scatter */
1129 #define EFX_FILTER_FLAG_RX_SCATTER      0x02
1130 /*
1131  * Override an automatic filter (priority EFX_FILTER_PRI_AUTO).
1132  * May only be set by the filter implementation for each type.
1133  * A removal request will restore the automatic filter in its place.
1134  */
1135 #define EFX_FILTER_FLAG_RX_OVER_AUTO    0x04
1136 /* Filter is for RX */
1137 #define EFX_FILTER_FLAG_RX              0x08
1138 /* Filter is for TX */
1139 #define EFX_FILTER_FLAG_TX              0x10
1140
1141 typedef unsigned int efx_filter_flags_t;
1142
1143 typedef enum efx_filter_match_flags_e {
1144         EFX_FILTER_MATCH_REM_HOST = 0x0001,     /* Match by remote IP host
1145                                                  * address */
1146         EFX_FILTER_MATCH_LOC_HOST = 0x0002,     /* Match by local IP host
1147                                                  * address */
1148         EFX_FILTER_MATCH_REM_MAC = 0x0004,      /* Match by remote MAC address */
1149         EFX_FILTER_MATCH_REM_PORT = 0x0008,     /* Match by remote TCP/UDP port */
1150         EFX_FILTER_MATCH_LOC_MAC = 0x0010,      /* Match by remote TCP/UDP port */
1151         EFX_FILTER_MATCH_LOC_PORT = 0x0020,     /* Match by local TCP/UDP port */
1152         EFX_FILTER_MATCH_ETHER_TYPE = 0x0040,   /* Match by Ether-type */
1153         EFX_FILTER_MATCH_INNER_VID = 0x0080,    /* Match by inner VLAN ID */
1154         EFX_FILTER_MATCH_OUTER_VID = 0x0100,    /* Match by outer VLAN ID */
1155         EFX_FILTER_MATCH_IP_PROTO = 0x0200,     /* Match by IP transport
1156                                                  * protocol */
1157         EFX_FILTER_MATCH_LOC_MAC_IG = 0x0400,   /* Match by local MAC address
1158                                                  * I/G bit. Used for RX default
1159                                                  * unicast and multicast/
1160                                                  * broadcast filters. */
1161 } efx_filter_match_flags_t;
1162
1163 typedef enum efx_filter_priority_s {
1164         EFX_FILTER_PRI_HINT = 0,        /* Performance hint */
1165         EFX_FILTER_PRI_AUTO,            /* Automatic filter based on device
1166                                          * address list or hardware
1167                                          * requirements. This may only be used
1168                                          * by the filter implementation for
1169                                          * each NIC type. */
1170         EFX_FILTER_PRI_MANUAL,          /* Manually configured filter */
1171         EFX_FILTER_PRI_REQUIRED,        /* Required for correct behaviour of the
1172                                          * client (e.g. SR-IOV, HyperV VMQ etc.)
1173                                          */
1174 } efx_filter_priority_t;
1175
1176 /*
1177  * FIXME: All these fields are assumed to be in little-endian byte order.
1178  * It may be better for some to be big-endian. See bug42804.
1179  */
1180
1181 typedef struct efx_filter_spec_s {
1182         uint32_t        efs_match_flags:12;
1183         uint32_t        efs_priority:2;
1184         uint32_t        efs_flags:6;
1185         uint32_t        efs_dmaq_id:12;
1186         uint32_t        efs_rss_context;
1187         uint16_t        efs_outer_vid;
1188         uint16_t        efs_inner_vid;
1189         uint8_t         efs_loc_mac[EFX_MAC_ADDR_LEN];
1190         uint8_t         efs_rem_mac[EFX_MAC_ADDR_LEN];
1191         uint16_t        efs_ether_type;
1192         uint8_t         efs_ip_proto;
1193         uint16_t        efs_loc_port;
1194         uint16_t        efs_rem_port;
1195         efx_oword_t     efs_rem_host;
1196         efx_oword_t     efs_loc_host;
1197 } efx_filter_spec_t;
1198
1199
1200 /* Default values for use in filter specifications */
1201 #define EFX_FILTER_SPEC_RSS_CONTEXT_DEFAULT     0xffffffff
1202 #define EFX_FILTER_SPEC_RX_DMAQ_ID_DROP         0xfff
1203 #define EFX_FILTER_SPEC_VID_UNSPEC              0xffff
1204
1205 extern  __checkReturn   efx_rc_t
1206 efx_filter_init(
1207         __in            efx_nic_t *enp);
1208
1209 extern                  void
1210 efx_filter_fini(
1211         __in            efx_nic_t *enp);
1212
1213 extern  __checkReturn   efx_rc_t
1214 efx_filter_insert(
1215         __in            efx_nic_t *enp,
1216         __inout         efx_filter_spec_t *spec);
1217
1218 extern  __checkReturn   efx_rc_t
1219 efx_filter_remove(
1220         __in            efx_nic_t *enp,
1221         __inout         efx_filter_spec_t *spec);
1222
1223 extern  __checkReturn   efx_rc_t
1224 efx_filter_restore(
1225         __in            efx_nic_t *enp);
1226
1227 extern  __checkReturn   efx_rc_t
1228 efx_filter_supported_filters(
1229         __in            efx_nic_t *enp,
1230         __out           uint32_t *list,
1231         __out           size_t *length);
1232
1233 extern                  void
1234 efx_filter_spec_init_rx(
1235         __out           efx_filter_spec_t *spec,
1236         __in            efx_filter_priority_t priority,
1237         __in            efx_filter_flags_t flags,
1238         __in            efx_rxq_t *erp);
1239
1240 extern                  void
1241 efx_filter_spec_init_tx(
1242         __out           efx_filter_spec_t *spec,
1243         __in            efx_txq_t *etp);
1244
1245 extern  __checkReturn   efx_rc_t
1246 efx_filter_spec_set_ipv4_local(
1247         __inout         efx_filter_spec_t *spec,
1248         __in            uint8_t proto,
1249         __in            uint32_t host,
1250         __in            uint16_t port);
1251
1252 extern  __checkReturn   efx_rc_t
1253 efx_filter_spec_set_ipv4_full(
1254         __inout         efx_filter_spec_t *spec,
1255         __in            uint8_t proto,
1256         __in            uint32_t lhost,
1257         __in            uint16_t lport,
1258         __in            uint32_t rhost,
1259         __in            uint16_t rport);
1260
1261 extern  __checkReturn   efx_rc_t
1262 efx_filter_spec_set_eth_local(
1263         __inout         efx_filter_spec_t *spec,
1264         __in            uint16_t vid,
1265         __in            const uint8_t *addr);
1266
1267 extern  __checkReturn   efx_rc_t
1268 efx_filter_spec_set_uc_def(
1269         __inout         efx_filter_spec_t *spec);
1270
1271 extern  __checkReturn   efx_rc_t
1272 efx_filter_spec_set_mc_def(
1273         __inout         efx_filter_spec_t *spec);
1274
1275 #endif  /* EFSYS_OPT_FILTER */
1276
1277 /* HASH */
1278
1279 extern  __checkReturn           uint32_t
1280 efx_hash_dwords(
1281         __in_ecount(count)      uint32_t const *input,
1282         __in                    size_t count,
1283         __in                    uint32_t init);
1284
1285 extern  __checkReturn           uint32_t
1286 efx_hash_bytes(
1287         __in_ecount(length)     uint8_t const *input,
1288         __in                    size_t length,
1289         __in                    uint32_t init);
1290
1291
1292
1293 #ifdef  __cplusplus
1294 }
1295 #endif
1296
1297 #endif  /* _SYS_EFX_H */