drivers/net/sfc/base/efx.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  *
   3  * Copyright (c) 2006-2018 Solarflare Communications Inc.
   4  * All rights reserved.
   5  */
   6
   7 #ifndef _SYS_EFX_H
   8 #define _SYS_EFX_H
   9
  10 #include "efsys.h"
  11 #include "efx_check.h"
  12 #include "efx_phy_ids.h"
  13
  14 #ifdef  __cplusplus
  15 extern "C" {
  16 #endif
  17
  18 #define EFX_STATIC_ASSERT(_cond)                \
  19         ((void)sizeof (char[(_cond) ? 1 : -1]))
  20
  21 #define EFX_ARRAY_SIZE(_array)                  \
  22         (sizeof (_array) / sizeof ((_array)[0]))
  23
  24 #define EFX_FIELD_OFFSET(_type, _field)         \
  25         ((size_t)&(((_type *)0)->_field))
  26
  27 /* The macro expands divider twice */
  28 #define EFX_DIV_ROUND_UP(_n, _d)                (((_n) + (_d) - 1) / (_d))
  29
  30 /* Return codes */
  31
  32 typedef __success(return == 0) int efx_rc_t;
  33
  34
  35 /* Chip families */
  36
  37 typedef enum efx_family_e {
  38         EFX_FAMILY_INVALID,
  39         EFX_FAMILY_FALCON,      /* Obsolete and not supported */
  40         EFX_FAMILY_SIENA,
  41         EFX_FAMILY_HUNTINGTON,
  42         EFX_FAMILY_MEDFORD,
  43         EFX_FAMILY_NTYPES
  44 } efx_family_t;
  45
  46 extern  __checkReturn   efx_rc_t
  47 efx_family(
  48         __in            uint16_t venid,
  49         __in            uint16_t devid,
  50         __out           efx_family_t *efp);
  51
  52
  53 #define EFX_PCI_VENID_SFC                       0x1924
  54
  55 #define EFX_PCI_DEVID_FALCON                    0x0710  /* SFC4000 */
  56
  57 #define EFX_PCI_DEVID_BETHPAGE                  0x0803  /* SFC9020 */
  58 #define EFX_PCI_DEVID_SIENA                     0x0813  /* SFL9021 */
  59 #define EFX_PCI_DEVID_SIENA_F1_UNINIT           0x0810
  60
  61 #define EFX_PCI_DEVID_HUNTINGTON_PF_UNINIT      0x0901
  62 #define EFX_PCI_DEVID_FARMINGDALE               0x0903  /* SFC9120 PF */
  63 #define EFX_PCI_DEVID_GREENPORT                 0x0923  /* SFC9140 PF */
  64
  65 #define EFX_PCI_DEVID_FARMINGDALE_VF            0x1903  /* SFC9120 VF */
  66 #define EFX_PCI_DEVID_GREENPORT_VF              0x1923  /* SFC9140 VF */
  67
  68 #define EFX_PCI_DEVID_MEDFORD_PF_UNINIT         0x0913
  69 #define EFX_PCI_DEVID_MEDFORD                   0x0A03  /* SFC9240 PF */
  70 #define EFX_PCI_DEVID_MEDFORD_VF                0x1A03  /* SFC9240 VF */
  71
  72 #define EFX_MEM_BAR     2
  73
  74 /* Error codes */
  75
  76 enum {
  77         EFX_ERR_INVALID,
  78         EFX_ERR_SRAM_OOB,
  79         EFX_ERR_BUFID_DC_OOB,
  80         EFX_ERR_MEM_PERR,
  81         EFX_ERR_RBUF_OWN,
  82         EFX_ERR_TBUF_OWN,
  83         EFX_ERR_RDESQ_OWN,
  84         EFX_ERR_TDESQ_OWN,
  85         EFX_ERR_EVQ_OWN,
  86         EFX_ERR_EVFF_OFLO,
  87         EFX_ERR_ILL_ADDR,
  88         EFX_ERR_SRAM_PERR,
  89         EFX_ERR_NCODES
  90 };
  91
  92 /* Calculate the IEEE 802.3 CRC32 of a MAC addr */
  93 extern  __checkReturn           uint32_t
  94 efx_crc32_calculate(
  95         __in                    uint32_t crc_init,
  96         __in_ecount(length)     uint8_t const *input,
  97         __in                    int length);
  98
  99
 100 /* Type prototypes */
 101
 102 typedef struct efx_rxq_s        efx_rxq_t;
 103
 104 /* NIC */
 105
 106 typedef struct efx_nic_s        efx_nic_t;
 107
 108 extern  __checkReturn   efx_rc_t
 109 efx_nic_create(
 110         __in            efx_family_t family,
 111         __in            efsys_identifier_t *esip,
 112         __in            efsys_bar_t *esbp,
 113         __in            efsys_lock_t *eslp,
 114         __deref_out     efx_nic_t **enpp);
 115
 116 extern  __checkReturn   efx_rc_t
 117 efx_nic_probe(
 118         __in            efx_nic_t *enp);
 119
 120 extern  __checkReturn   efx_rc_t
 121 efx_nic_init(
 122         __in            efx_nic_t *enp);
 123
 124 extern  __checkReturn   efx_rc_t
 125 efx_nic_reset(
 126         __in            efx_nic_t *enp);
 127
 128 #if EFSYS_OPT_DIAG
 129
 130 extern  __checkReturn   efx_rc_t
 131 efx_nic_register_test(
 132         __in            efx_nic_t *enp);
 133
 134 #endif  /* EFSYS_OPT_DIAG */
 135
 136 extern          void
 137 efx_nic_fini(
 138         __in            efx_nic_t *enp);
 139
 140 extern          void
 141 efx_nic_unprobe(
 142         __in            efx_nic_t *enp);
 143
 144 extern          void
 145 efx_nic_destroy(
 146         __in    efx_nic_t *enp);
 147
 148 #define EFX_PCIE_LINK_SPEED_GEN1                1
 149 #define EFX_PCIE_LINK_SPEED_GEN2                2
 150 #define EFX_PCIE_LINK_SPEED_GEN3                3
 151
 152 typedef enum efx_pcie_link_performance_e {
 153         EFX_PCIE_LINK_PERFORMANCE_UNKNOWN_BANDWIDTH,
 154         EFX_PCIE_LINK_PERFORMANCE_SUBOPTIMAL_BANDWIDTH,
 155         EFX_PCIE_LINK_PERFORMANCE_SUBOPTIMAL_LATENCY,
 156         EFX_PCIE_LINK_PERFORMANCE_OPTIMAL
 157 } efx_pcie_link_performance_t;
 158
 159 extern  __checkReturn   efx_rc_t
 160 efx_nic_calculate_pcie_link_bandwidth(
 161         __in            uint32_t pcie_link_width,
 162         __in            uint32_t pcie_link_gen,
 163         __out           uint32_t *bandwidth_mbpsp);
 164
 165 extern  __checkReturn   efx_rc_t
 166 efx_nic_check_pcie_link_speed(
 167         __in            efx_nic_t *enp,
 168         __in            uint32_t pcie_link_width,
 169         __in            uint32_t pcie_link_gen,
 170         __out           efx_pcie_link_performance_t *resultp);
 171
 172 #if EFSYS_OPT_MCDI
 173
 174 #if EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD
 175 /* Huntington and Medford require MCDIv2 commands */
 176 #define WITH_MCDI_V2 1
 177 #endif
 178
 179 typedef struct efx_mcdi_req_s efx_mcdi_req_t;
 180
 181 typedef enum efx_mcdi_exception_e {
 182         EFX_MCDI_EXCEPTION_MC_REBOOT,
 183         EFX_MCDI_EXCEPTION_MC_BADASSERT,
 184 } efx_mcdi_exception_t;
 185
 186 #if EFSYS_OPT_MCDI_LOGGING
 187 typedef enum efx_log_msg_e {
 188         EFX_LOG_INVALID,
 189         EFX_LOG_MCDI_REQUEST,
 190         EFX_LOG_MCDI_RESPONSE,
 191 } efx_log_msg_t;
 192 #endif /* EFSYS_OPT_MCDI_LOGGING */
 193
 194 typedef struct efx_mcdi_transport_s {
 195         void            *emt_context;
 196         efsys_mem_t     *emt_dma_mem;
 197         void            (*emt_execute)(void *, efx_mcdi_req_t *);
 198         void            (*emt_ev_cpl)(void *);
 199         void            (*emt_exception)(void *, efx_mcdi_exception_t);
 200 #if EFSYS_OPT_MCDI_LOGGING
 201         void            (*emt_logger)(void *, efx_log_msg_t,
 202                                         void *, size_t, void *, size_t);
 203 #endif /* EFSYS_OPT_MCDI_LOGGING */
 204 #if EFSYS_OPT_MCDI_PROXY_AUTH
 205         void            (*emt_ev_proxy_response)(void *, uint32_t, efx_rc_t);
 206 #endif /* EFSYS_OPT_MCDI_PROXY_AUTH */
 207 } efx_mcdi_transport_t;
 208
 209 extern  __checkReturn   efx_rc_t
 210 efx_mcdi_init(
 211         __in            efx_nic_t *enp,
 212         __in            const efx_mcdi_transport_t *mtp);
 213
 214 extern  __checkReturn   efx_rc_t
 215 efx_mcdi_reboot(
 216         __in            efx_nic_t *enp);
 217
 218                         void
 219 efx_mcdi_new_epoch(
 220         __in            efx_nic_t *enp);
 221
 222 extern                  void
 223 efx_mcdi_get_timeout(
 224         __in            efx_nic_t *enp,
 225         __in            efx_mcdi_req_t *emrp,
 226         __out           uint32_t *usec_timeoutp);
 227
 228 extern                  void
 229 efx_mcdi_request_start(
 230         __in            efx_nic_t *enp,
 231         __in            efx_mcdi_req_t *emrp,
 232         __in            boolean_t ev_cpl);
 233
 234 extern  __checkReturn   boolean_t
 235 efx_mcdi_request_poll(
 236         __in            efx_nic_t *enp);
 237
 238 extern  __checkReturn   boolean_t
 239 efx_mcdi_request_abort(
 240         __in            efx_nic_t *enp);
 241
 242 extern                  void
 243 efx_mcdi_fini(
 244         __in            efx_nic_t *enp);
 245
 246 #endif  /* EFSYS_OPT_MCDI */
 247
 248 /* INTR */
 249
 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_ADJUSTMENT                                  \
 423         (/* EtherII */ 14                                       \
 424             + /* VLAN */ 4                                      \
 425             + /* CRC */ 4                                       \
 426             + /* bug16011 */ 16)                                \
 427
 428 #define EFX_MAC_PDU(_sdu)                                       \
 429         P2ROUNDUP((_sdu) + EFX_MAC_PDU_ADJUSTMENT, 8)
 430
 431 /*
 432  * Due to the P2ROUNDUP in EFX_MAC_PDU(), EFX_MAC_SDU_FROM_PDU() may give
 433  * the SDU rounded up slightly.
 434  */
 435 #define EFX_MAC_SDU_FROM_PDU(_pdu)      ((_pdu) - EFX_MAC_PDU_ADJUSTMENT)
 436
 437 #define EFX_MAC_PDU_MIN 60
 438 #define EFX_MAC_PDU_MAX EFX_MAC_PDU(EFX_MAC_SDU_MAX)
 439
 440 extern  __checkReturn   efx_rc_t
 441 efx_mac_pdu_get(
 442         __in            efx_nic_t *enp,
 443         __out           size_t *pdu);
 444
 445 extern  __checkReturn   efx_rc_t
 446 efx_mac_pdu_set(
 447         __in            efx_nic_t *enp,
 448         __in            size_t pdu);
 449
 450 extern  __checkReturn   efx_rc_t
 451 efx_mac_addr_set(
 452         __in            efx_nic_t *enp,
 453         __in            uint8_t *addr);
 454
 455 extern  __checkReturn                   efx_rc_t
 456 efx_mac_filter_set(
 457         __in                            efx_nic_t *enp,
 458         __in                            boolean_t all_unicst,
 459         __in                            boolean_t mulcst,
 460         __in                            boolean_t all_mulcst,
 461         __in                            boolean_t brdcst);
 462
 463 extern  __checkReturn   efx_rc_t
 464 efx_mac_multicast_list_set(
 465         __in                            efx_nic_t *enp,
 466         __in_ecount(6*count)            uint8_t const *addrs,
 467         __in                            int count);
 468
 469 extern  __checkReturn   efx_rc_t
 470 efx_mac_filter_default_rxq_set(
 471         __in            efx_nic_t *enp,
 472         __in            efx_rxq_t *erp,
 473         __in            boolean_t using_rss);
 474
 475 extern                  void
 476 efx_mac_filter_default_rxq_clear(
 477         __in            efx_nic_t *enp);
 478
 479 extern  __checkReturn   efx_rc_t
 480 efx_mac_drain(
 481         __in            efx_nic_t *enp,
 482         __in            boolean_t enabled);
 483
 484 extern  __checkReturn   efx_rc_t
 485 efx_mac_up(
 486         __in            efx_nic_t *enp,
 487         __out           boolean_t *mac_upp);
 488
 489 #define EFX_FCNTL_RESPOND       0x00000001
 490 #define EFX_FCNTL_GENERATE      0x00000002
 491
 492 extern  __checkReturn   efx_rc_t
 493 efx_mac_fcntl_set(
 494         __in            efx_nic_t *enp,
 495         __in            unsigned int fcntl,
 496         __in            boolean_t autoneg);
 497
 498 extern                  void
 499 efx_mac_fcntl_get(
 500         __in            efx_nic_t *enp,
 501         __out           unsigned int *fcntl_wantedp,
 502         __out           unsigned int *fcntl_linkp);
 503
 504
 505 #if EFSYS_OPT_MAC_STATS
 506
 507 #if EFSYS_OPT_NAMES
 508
 509 extern  __checkReturn                   const char *
 510 efx_mac_stat_name(
 511         __in                            efx_nic_t *enp,
 512         __in                            unsigned int id);
 513
 514 #endif  /* EFSYS_OPT_NAMES */
 515
 516 #define EFX_MAC_STATS_MASK_BITS_PER_PAGE        (8 * sizeof (uint32_t))
 517
 518 #define EFX_MAC_STATS_MASK_NPAGES       \
 519         (P2ROUNDUP(EFX_MAC_NSTATS, EFX_MAC_STATS_MASK_BITS_PER_PAGE) / \
 520             EFX_MAC_STATS_MASK_BITS_PER_PAGE)
 521
 522 /*
 523  * Get mask of MAC statistics supported by the hardware.
 524  *
 525  * If mask_size is insufficient to return the mask, EINVAL error is
 526  * returned. EFX_MAC_STATS_MASK_NPAGES multiplied by size of the page
 527  * (which is sizeof (uint32_t)) is sufficient.
 528  */
 529 extern  __checkReturn                   efx_rc_t
 530 efx_mac_stats_get_mask(
 531         __in                            efx_nic_t *enp,
 532         __out_bcount(mask_size)         uint32_t *maskp,
 533         __in                            size_t mask_size);
 534
 535 #define EFX_MAC_STAT_SUPPORTED(_mask, _stat)    \
 536         ((_mask)[(_stat) / EFX_MAC_STATS_MASK_BITS_PER_PAGE] &  \
 537             (1ULL << ((_stat) & (EFX_MAC_STATS_MASK_BITS_PER_PAGE - 1))))
 538
 539 #define EFX_MAC_STATS_SIZE 0x400
 540
 541 extern  __checkReturn                   efx_rc_t
 542 efx_mac_stats_clear(
 543         __in                            efx_nic_t *enp);
 544
 545 /*
 546  * Upload mac statistics supported by the hardware into the given buffer.
 547  *
 548  * The reference buffer must be at least %EFX_MAC_STATS_SIZE bytes,
 549  * and page aligned.
 550  *
 551  * The hardware will only DMA statistics that it understands (of course).
 552  * Drivers should not make any assumptions about which statistics are
 553  * supported, especially when the statistics are generated by firmware.
 554  *
 555  * Thus, drivers should zero this buffer before use, so that not-understood
 556  * statistics read back as zero.
 557  */
 558 extern  __checkReturn                   efx_rc_t
 559 efx_mac_stats_upload(
 560         __in                            efx_nic_t *enp,
 561         __in                            efsys_mem_t *esmp);
 562
 563 extern  __checkReturn                   efx_rc_t
 564 efx_mac_stats_periodic(
 565         __in                            efx_nic_t *enp,
 566         __in                            efsys_mem_t *esmp,
 567         __in                            uint16_t period_ms,
 568         __in                            boolean_t events);
 569
 570 extern  __checkReturn                   efx_rc_t
 571 efx_mac_stats_update(
 572         __in                            efx_nic_t *enp,
 573         __in                            efsys_mem_t *esmp,
 574         __inout_ecount(EFX_MAC_NSTATS)  efsys_stat_t *stat,
 575         __inout_opt                     uint32_t *generationp);
 576
 577 #endif  /* EFSYS_OPT_MAC_STATS */
 578
 579 /* MON */
 580
 581 typedef enum efx_mon_type_e {
 582         EFX_MON_INVALID = 0,
 583         EFX_MON_SFC90X0,
 584         EFX_MON_SFC91X0,
 585         EFX_MON_SFC92X0,
 586         EFX_MON_NTYPES
 587 } efx_mon_type_t;
 588
 589 #if EFSYS_OPT_NAMES
 590
 591 extern          const char *
 592 efx_mon_name(
 593         __in    efx_nic_t *enp);
 594
 595 #endif  /* EFSYS_OPT_NAMES */
 596
 597 extern  __checkReturn   efx_rc_t
 598 efx_mon_init(
 599         __in            efx_nic_t *enp);
 600
 601 #if EFSYS_OPT_MON_STATS
 602
 603 #define EFX_MON_STATS_PAGE_SIZE 0x100
 604 #define EFX_MON_MASK_ELEMENT_SIZE 32
 605
 606 /* START MKCONFIG GENERATED MonitorHeaderStatsBlock aa0233c80156308e */
 607 typedef enum efx_mon_stat_e {
 608         EFX_MON_STAT_2_5V,
 609         EFX_MON_STAT_VCCP1,
 610         EFX_MON_STAT_VCC,
 611         EFX_MON_STAT_5V,
 612         EFX_MON_STAT_12V,
 613         EFX_MON_STAT_VCCP2,
 614         EFX_MON_STAT_EXT_TEMP,
 615         EFX_MON_STAT_INT_TEMP,
 616         EFX_MON_STAT_AIN1,
 617         EFX_MON_STAT_AIN2,
 618         EFX_MON_STAT_INT_COOLING,
 619         EFX_MON_STAT_EXT_COOLING,
 620         EFX_MON_STAT_1V,
 621         EFX_MON_STAT_1_2V,
 622         EFX_MON_STAT_1_8V,
 623         EFX_MON_STAT_3_3V,
 624         EFX_MON_STAT_1_2VA,
 625         EFX_MON_STAT_VREF,
 626         EFX_MON_STAT_VAOE,
 627         EFX_MON_STAT_AOE_TEMP,
 628         EFX_MON_STAT_PSU_AOE_TEMP,
 629         EFX_MON_STAT_PSU_TEMP,
 630         EFX_MON_STAT_FAN0,
 631         EFX_MON_STAT_FAN1,
 632         EFX_MON_STAT_FAN2,
 633         EFX_MON_STAT_FAN3,
 634         EFX_MON_STAT_FAN4,
 635         EFX_MON_STAT_VAOE_IN,
 636         EFX_MON_STAT_IAOE,
 637         EFX_MON_STAT_IAOE_IN,
 638         EFX_MON_STAT_NIC_POWER,
 639         EFX_MON_STAT_0_9V,
 640         EFX_MON_STAT_I0_9V,
 641         EFX_MON_STAT_I1_2V,
 642         EFX_MON_STAT_0_9V_ADC,
 643         EFX_MON_STAT_INT_TEMP2,
 644         EFX_MON_STAT_VREG_TEMP,
 645         EFX_MON_STAT_VREG_0_9V_TEMP,
 646         EFX_MON_STAT_VREG_1_2V_TEMP,
 647         EFX_MON_STAT_INT_VPTAT,
 648         EFX_MON_STAT_INT_ADC_TEMP,
 649         EFX_MON_STAT_EXT_VPTAT,
 650         EFX_MON_STAT_EXT_ADC_TEMP,
 651         EFX_MON_STAT_AMBIENT_TEMP,
 652         EFX_MON_STAT_AIRFLOW,
 653         EFX_MON_STAT_VDD08D_VSS08D_CSR,
 654         EFX_MON_STAT_VDD08D_VSS08D_CSR_EXTADC,
 655         EFX_MON_STAT_HOTPOINT_TEMP,
 656         EFX_MON_STAT_PHY_POWER_SWITCH_PORT0,
 657         EFX_MON_STAT_PHY_POWER_SWITCH_PORT1,
 658         EFX_MON_STAT_MUM_VCC,
 659         EFX_MON_STAT_0V9_A,
 660         EFX_MON_STAT_I0V9_A,
 661         EFX_MON_STAT_0V9_A_TEMP,
 662         EFX_MON_STAT_0V9_B,
 663         EFX_MON_STAT_I0V9_B,
 664         EFX_MON_STAT_0V9_B_TEMP,
 665         EFX_MON_STAT_CCOM_AVREG_1V2_SUPPLY,
 666         EFX_MON_STAT_CCOM_AVREG_1V2_SUPPLY_EXT_ADC,
 667         EFX_MON_STAT_CCOM_AVREG_1V8_SUPPLY,
 668         EFX_MON_STAT_CCOM_AVREG_1V8_SUPPLY_EXT_ADC,
 669         EFX_MON_STAT_CONTROLLER_MASTER_VPTAT,
 670         EFX_MON_STAT_CONTROLLER_MASTER_INTERNAL_TEMP,
 671         EFX_MON_STAT_CONTROLLER_MASTER_VPTAT_EXT_ADC,
 672         EFX_MON_STAT_CONTROLLER_MASTER_INTERNAL_TEMP_EXT_ADC,
 673         EFX_MON_STAT_CONTROLLER_SLAVE_VPTAT,
 674         EFX_MON_STAT_CONTROLLER_SLAVE_INTERNAL_TEMP,
 675         EFX_MON_STAT_CONTROLLER_SLAVE_VPTAT_EXT_ADC,
 676         EFX_MON_STAT_CONTROLLER_SLAVE_INTERNAL_TEMP_EXT_ADC,
 677         EFX_MON_STAT_SODIMM_VOUT,
 678         EFX_MON_STAT_SODIMM_0_TEMP,
 679         EFX_MON_STAT_SODIMM_1_TEMP,
 680         EFX_MON_STAT_PHY0_VCC,
 681         EFX_MON_STAT_PHY1_VCC,
 682         EFX_MON_STAT_CONTROLLER_TDIODE_TEMP,
 683         EFX_MON_STAT_BOARD_FRONT_TEMP,
 684         EFX_MON_STAT_BOARD_BACK_TEMP,
 685         EFX_MON_STAT_I1V8,
 686         EFX_MON_STAT_I2V5,
 687         EFX_MON_NSTATS
 688 } efx_mon_stat_t;
 689
 690 /* END MKCONFIG GENERATED MonitorHeaderStatsBlock */
 691
 692 typedef enum efx_mon_stat_state_e {
 693         EFX_MON_STAT_STATE_OK = 0,
 694         EFX_MON_STAT_STATE_WARNING = 1,
 695         EFX_MON_STAT_STATE_FATAL = 2,
 696         EFX_MON_STAT_STATE_BROKEN = 3,
 697         EFX_MON_STAT_STATE_NO_READING = 4,
 698 } efx_mon_stat_state_t;
 699
 700 typedef struct efx_mon_stat_value_s {
 701         uint16_t        emsv_value;
 702         uint16_t        emsv_state;
 703 } efx_mon_stat_value_t;
 704
 705 #if EFSYS_OPT_NAMES
 706
 707 extern                                  const char *
 708 efx_mon_stat_name(
 709         __in                            efx_nic_t *enp,
 710         __in                            efx_mon_stat_t id);
 711
 712 #endif  /* EFSYS_OPT_NAMES */
 713
 714 extern  __checkReturn                   efx_rc_t
 715 efx_mon_stats_update(
 716         __in                            efx_nic_t *enp,
 717         __in                            efsys_mem_t *esmp,
 718         __inout_ecount(EFX_MON_NSTATS)  efx_mon_stat_value_t *values);
 719
 720 #endif  /* EFSYS_OPT_MON_STATS */
 721
 722 extern          void
 723 efx_mon_fini(
 724         __in    efx_nic_t *enp);
 725
 726 /* PHY */
 727
 728 extern  __checkReturn   efx_rc_t
 729 efx_phy_verify(
 730         __in            efx_nic_t *enp);
 731
 732 #if EFSYS_OPT_PHY_LED_CONTROL
 733
 734 typedef enum efx_phy_led_mode_e {
 735         EFX_PHY_LED_DEFAULT = 0,
 736         EFX_PHY_LED_OFF,
 737         EFX_PHY_LED_ON,
 738         EFX_PHY_LED_FLASH,
 739         EFX_PHY_LED_NMODES
 740 } efx_phy_led_mode_t;
 741
 742 extern  __checkReturn   efx_rc_t
 743 efx_phy_led_set(
 744         __in    efx_nic_t *enp,
 745         __in    efx_phy_led_mode_t mode);
 746
 747 #endif  /* EFSYS_OPT_PHY_LED_CONTROL */
 748
 749 extern  __checkReturn   efx_rc_t
 750 efx_port_init(
 751         __in            efx_nic_t *enp);
 752
 753 #if EFSYS_OPT_LOOPBACK
 754
 755 typedef enum efx_loopback_type_e {
 756         EFX_LOOPBACK_OFF = 0,
 757         EFX_LOOPBACK_DATA = 1,
 758         EFX_LOOPBACK_GMAC = 2,
 759         EFX_LOOPBACK_XGMII = 3,
 760         EFX_LOOPBACK_XGXS = 4,
 761         EFX_LOOPBACK_XAUI = 5,
 762         EFX_LOOPBACK_GMII = 6,
 763         EFX_LOOPBACK_SGMII = 7,
 764         EFX_LOOPBACK_XGBR = 8,
 765         EFX_LOOPBACK_XFI = 9,
 766         EFX_LOOPBACK_XAUI_FAR = 10,
 767         EFX_LOOPBACK_GMII_FAR = 11,
 768         EFX_LOOPBACK_SGMII_FAR = 12,
 769         EFX_LOOPBACK_XFI_FAR = 13,
 770         EFX_LOOPBACK_GPHY = 14,
 771         EFX_LOOPBACK_PHY_XS = 15,
 772         EFX_LOOPBACK_PCS = 16,
 773         EFX_LOOPBACK_PMA_PMD = 17,
 774         EFX_LOOPBACK_XPORT = 18,
 775         EFX_LOOPBACK_XGMII_WS = 19,
 776         EFX_LOOPBACK_XAUI_WS = 20,
 777         EFX_LOOPBACK_XAUI_WS_FAR = 21,
 778         EFX_LOOPBACK_XAUI_WS_NEAR = 22,
 779         EFX_LOOPBACK_GMII_WS = 23,
 780         EFX_LOOPBACK_XFI_WS = 24,
 781         EFX_LOOPBACK_XFI_WS_FAR = 25,
 782         EFX_LOOPBACK_PHYXS_WS = 26,
 783         EFX_LOOPBACK_PMA_INT = 27,
 784         EFX_LOOPBACK_SD_NEAR = 28,
 785         EFX_LOOPBACK_SD_FAR = 29,
 786         EFX_LOOPBACK_PMA_INT_WS = 30,
 787         EFX_LOOPBACK_SD_FEP2_WS = 31,
 788         EFX_LOOPBACK_SD_FEP1_5_WS = 32,
 789         EFX_LOOPBACK_SD_FEP_WS = 33,
 790         EFX_LOOPBACK_SD_FES_WS = 34,
 791         EFX_LOOPBACK_NTYPES
 792 } efx_loopback_type_t;
 793
 794 typedef enum efx_loopback_kind_e {
 795         EFX_LOOPBACK_KIND_OFF = 0,
 796         EFX_LOOPBACK_KIND_ALL,
 797         EFX_LOOPBACK_KIND_MAC,
 798         EFX_LOOPBACK_KIND_PHY,
 799         EFX_LOOPBACK_NKINDS
 800 } efx_loopback_kind_t;
 801
 802 extern                  void
 803 efx_loopback_mask(
 804         __in    efx_loopback_kind_t loopback_kind,
 805         __out   efx_qword_t *maskp);
 806
 807 extern  __checkReturn   efx_rc_t
 808 efx_port_loopback_set(
 809         __in    efx_nic_t *enp,
 810         __in    efx_link_mode_t link_mode,
 811         __in    efx_loopback_type_t type);
 812
 813 #if EFSYS_OPT_NAMES
 814
 815 extern  __checkReturn   const char *
 816 efx_loopback_type_name(
 817         __in            efx_nic_t *enp,
 818         __in            efx_loopback_type_t type);
 819
 820 #endif  /* EFSYS_OPT_NAMES */
 821
 822 #endif  /* EFSYS_OPT_LOOPBACK */
 823
 824 extern  __checkReturn   efx_rc_t
 825 efx_port_poll(
 826         __in            efx_nic_t *enp,
 827         __out_opt       efx_link_mode_t *link_modep);
 828
 829 extern          void
 830 efx_port_fini(
 831         __in    efx_nic_t *enp);
 832
 833 typedef enum efx_phy_cap_type_e {
 834         EFX_PHY_CAP_INVALID = 0,
 835         EFX_PHY_CAP_10HDX,
 836         EFX_PHY_CAP_10FDX,
 837         EFX_PHY_CAP_100HDX,
 838         EFX_PHY_CAP_100FDX,
 839         EFX_PHY_CAP_1000HDX,
 840         EFX_PHY_CAP_1000FDX,
 841         EFX_PHY_CAP_10000FDX,
 842         EFX_PHY_CAP_PAUSE,
 843         EFX_PHY_CAP_ASYM,
 844         EFX_PHY_CAP_AN,
 845         EFX_PHY_CAP_40000FDX,
 846         EFX_PHY_CAP_NTYPES
 847 } efx_phy_cap_type_t;
 848
 849
 850 #define EFX_PHY_CAP_CURRENT     0x00000000
 851 #define EFX_PHY_CAP_DEFAULT     0x00000001
 852 #define EFX_PHY_CAP_PERM        0x00000002
 853
 854 extern          void
 855 efx_phy_adv_cap_get(
 856         __in            efx_nic_t *enp,
 857         __in            uint32_t flag,
 858         __out           uint32_t *maskp);
 859
 860 extern  __checkReturn   efx_rc_t
 861 efx_phy_adv_cap_set(
 862         __in            efx_nic_t *enp,
 863         __in            uint32_t mask);
 864
 865 extern                  void
 866 efx_phy_lp_cap_get(
 867         __in            efx_nic_t *enp,
 868         __out           uint32_t *maskp);
 869
 870 extern  __checkReturn   efx_rc_t
 871 efx_phy_oui_get(
 872         __in            efx_nic_t *enp,
 873         __out           uint32_t *ouip);
 874
 875 typedef enum efx_phy_media_type_e {
 876         EFX_PHY_MEDIA_INVALID = 0,
 877         EFX_PHY_MEDIA_XAUI,
 878         EFX_PHY_MEDIA_CX4,
 879         EFX_PHY_MEDIA_KX4,
 880         EFX_PHY_MEDIA_XFP,
 881         EFX_PHY_MEDIA_SFP_PLUS,
 882         EFX_PHY_MEDIA_BASE_T,
 883         EFX_PHY_MEDIA_QSFP_PLUS,
 884         EFX_PHY_MEDIA_NTYPES
 885 } efx_phy_media_type_t;
 886
 887 /*
 888  * Get the type of medium currently used.  If the board has ports for
 889  * modules, a module is present, and we recognise the media type of
 890  * the module, then this will be the media type of the module.
 891  * Otherwise it will be the media type of the port.
 892  */
 893 extern                  void
 894 efx_phy_media_type_get(
 895         __in            efx_nic_t *enp,
 896         __out           efx_phy_media_type_t *typep);
 897
 898 extern  __checkReturn           efx_rc_t
 899 efx_phy_module_get_info(
 900         __in                    efx_nic_t *enp,
 901         __in                    uint8_t dev_addr,
 902         __in                    uint8_t offset,
 903         __in                    uint8_t len,
 904         __out_bcount(len)       uint8_t *data);
 905
 906 #if EFSYS_OPT_PHY_STATS
 907
 908 /* START MKCONFIG GENERATED PhyHeaderStatsBlock 30ed56ad501f8e36 */
 909 typedef enum efx_phy_stat_e {
 910         EFX_PHY_STAT_OUI,
 911         EFX_PHY_STAT_PMA_PMD_LINK_UP,
 912         EFX_PHY_STAT_PMA_PMD_RX_FAULT,
 913         EFX_PHY_STAT_PMA_PMD_TX_FAULT,
 914         EFX_PHY_STAT_PMA_PMD_REV_A,
 915         EFX_PHY_STAT_PMA_PMD_REV_B,
 916         EFX_PHY_STAT_PMA_PMD_REV_C,
 917         EFX_PHY_STAT_PMA_PMD_REV_D,
 918         EFX_PHY_STAT_PCS_LINK_UP,
 919         EFX_PHY_STAT_PCS_RX_FAULT,
 920         EFX_PHY_STAT_PCS_TX_FAULT,
 921         EFX_PHY_STAT_PCS_BER,
 922         EFX_PHY_STAT_PCS_BLOCK_ERRORS,
 923         EFX_PHY_STAT_PHY_XS_LINK_UP,
 924         EFX_PHY_STAT_PHY_XS_RX_FAULT,
 925         EFX_PHY_STAT_PHY_XS_TX_FAULT,
 926         EFX_PHY_STAT_PHY_XS_ALIGN,
 927         EFX_PHY_STAT_PHY_XS_SYNC_A,
 928         EFX_PHY_STAT_PHY_XS_SYNC_B,
 929         EFX_PHY_STAT_PHY_XS_SYNC_C,
 930         EFX_PHY_STAT_PHY_XS_SYNC_D,
 931         EFX_PHY_STAT_AN_LINK_UP,
 932         EFX_PHY_STAT_AN_MASTER,
 933         EFX_PHY_STAT_AN_LOCAL_RX_OK,
 934         EFX_PHY_STAT_AN_REMOTE_RX_OK,
 935         EFX_PHY_STAT_CL22EXT_LINK_UP,
 936         EFX_PHY_STAT_SNR_A,
 937         EFX_PHY_STAT_SNR_B,
 938         EFX_PHY_STAT_SNR_C,
 939         EFX_PHY_STAT_SNR_D,
 940         EFX_PHY_STAT_PMA_PMD_SIGNAL_A,
 941         EFX_PHY_STAT_PMA_PMD_SIGNAL_B,
 942         EFX_PHY_STAT_PMA_PMD_SIGNAL_C,
 943         EFX_PHY_STAT_PMA_PMD_SIGNAL_D,
 944         EFX_PHY_STAT_AN_COMPLETE,
 945         EFX_PHY_STAT_PMA_PMD_REV_MAJOR,
 946         EFX_PHY_STAT_PMA_PMD_REV_MINOR,
 947         EFX_PHY_STAT_PMA_PMD_REV_MICRO,
 948         EFX_PHY_STAT_PCS_FW_VERSION_0,
 949         EFX_PHY_STAT_PCS_FW_VERSION_1,
 950         EFX_PHY_STAT_PCS_FW_VERSION_2,
 951         EFX_PHY_STAT_PCS_FW_VERSION_3,
 952         EFX_PHY_STAT_PCS_FW_BUILD_YY,
 953         EFX_PHY_STAT_PCS_FW_BUILD_MM,
 954         EFX_PHY_STAT_PCS_FW_BUILD_DD,
 955         EFX_PHY_STAT_PCS_OP_MODE,
 956         EFX_PHY_NSTATS
 957 } efx_phy_stat_t;
 958
 959 /* END MKCONFIG GENERATED PhyHeaderStatsBlock */
 960
 961 #if EFSYS_OPT_NAMES
 962
 963 extern                                  const char *
 964 efx_phy_stat_name(
 965         __in                            efx_nic_t *enp,
 966         __in                            efx_phy_stat_t stat);
 967
 968 #endif  /* EFSYS_OPT_NAMES */
 969
 970 #define EFX_PHY_STATS_SIZE 0x100
 971
 972 extern  __checkReturn                   efx_rc_t
 973 efx_phy_stats_update(
 974         __in                            efx_nic_t *enp,
 975         __in                            efsys_mem_t *esmp,
 976         __inout_ecount(EFX_PHY_NSTATS)  uint32_t *stat);
 977
 978 #endif  /* EFSYS_OPT_PHY_STATS */
 979
 980
 981 #if EFSYS_OPT_BIST
 982
 983 typedef enum efx_bist_type_e {
 984         EFX_BIST_TYPE_UNKNOWN,
 985         EFX_BIST_TYPE_PHY_NORMAL,
 986         EFX_BIST_TYPE_PHY_CABLE_SHORT,
 987         EFX_BIST_TYPE_PHY_CABLE_LONG,
 988         EFX_BIST_TYPE_MC_MEM,   /* Test the MC DMEM and IMEM */
 989         EFX_BIST_TYPE_SAT_MEM,  /* Test the DMEM and IMEM of satellite cpus */
 990         EFX_BIST_TYPE_REG,      /* Test the register memories */
 991         EFX_BIST_TYPE_NTYPES,
 992 } efx_bist_type_t;
 993
 994 typedef enum efx_bist_result_e {
 995         EFX_BIST_RESULT_UNKNOWN,
 996         EFX_BIST_RESULT_RUNNING,
 997         EFX_BIST_RESULT_PASSED,
 998         EFX_BIST_RESULT_FAILED,
 999 } efx_bist_result_t;
1000
1001 typedef enum efx_phy_cable_status_e {
1002         EFX_PHY_CABLE_STATUS_OK,
1003         EFX_PHY_CABLE_STATUS_INVALID,
1004         EFX_PHY_CABLE_STATUS_OPEN,
1005         EFX_PHY_CABLE_STATUS_INTRAPAIRSHORT,
1006         EFX_PHY_CABLE_STATUS_INTERPAIRSHORT,
1007         EFX_PHY_CABLE_STATUS_BUSY,
1008 } efx_phy_cable_status_t;
1009
1010 typedef enum efx_bist_value_e {
1011         EFX_BIST_PHY_CABLE_LENGTH_A,
1012         EFX_BIST_PHY_CABLE_LENGTH_B,
1013         EFX_BIST_PHY_CABLE_LENGTH_C,
1014         EFX_BIST_PHY_CABLE_LENGTH_D,
1015         EFX_BIST_PHY_CABLE_STATUS_A,
1016         EFX_BIST_PHY_CABLE_STATUS_B,
1017         EFX_BIST_PHY_CABLE_STATUS_C,
1018         EFX_BIST_PHY_CABLE_STATUS_D,
1019         EFX_BIST_FAULT_CODE,
1020         /*
1021          * Memory BIST specific values. These match to the MC_CMD_BIST_POLL
1022          * response.
1023          */
1024         EFX_BIST_MEM_TEST,
1025         EFX_BIST_MEM_ADDR,
1026         EFX_BIST_MEM_BUS,
1027         EFX_BIST_MEM_EXPECT,
1028         EFX_BIST_MEM_ACTUAL,
1029         EFX_BIST_MEM_ECC,
1030         EFX_BIST_MEM_ECC_PARITY,
1031         EFX_BIST_MEM_ECC_FATAL,
1032         EFX_BIST_NVALUES,
1033 } efx_bist_value_t;
1034
1035 extern  __checkReturn           efx_rc_t
1036 efx_bist_enable_offline(
1037         __in                    efx_nic_t *enp);
1038
1039 extern  __checkReturn           efx_rc_t
1040 efx_bist_start(
1041         __in                    efx_nic_t *enp,
1042         __in                    efx_bist_type_t type);
1043
1044 extern  __checkReturn           efx_rc_t
1045 efx_bist_poll(
1046         __in                    efx_nic_t *enp,
1047         __in                    efx_bist_type_t type,
1048         __out                   efx_bist_result_t *resultp,
1049         __out_opt               uint32_t *value_maskp,
1050         __out_ecount_opt(count) unsigned long *valuesp,
1051         __in                    size_t count);
1052
1053 extern                          void
1054 efx_bist_stop(
1055         __in                    efx_nic_t *enp,
1056         __in                    efx_bist_type_t type);
1057
1058 #endif  /* EFSYS_OPT_BIST */
1059
1060 #define EFX_FEATURE_IPV6                0x00000001
1061 #define EFX_FEATURE_LFSR_HASH_INSERT    0x00000002
1062 #define EFX_FEATURE_LINK_EVENTS         0x00000004
1063 #define EFX_FEATURE_PERIODIC_MAC_STATS  0x00000008
1064 #define EFX_FEATURE_MCDI                0x00000020
1065 #define EFX_FEATURE_LOOKAHEAD_SPLIT     0x00000040
1066 #define EFX_FEATURE_MAC_HEADER_FILTERS  0x00000080
1067 #define EFX_FEATURE_TURBO               0x00000100
1068 #define EFX_FEATURE_MCDI_DMA            0x00000200
1069 #define EFX_FEATURE_TX_SRC_FILTERS      0x00000400
1070 #define EFX_FEATURE_PIO_BUFFERS         0x00000800
1071 #define EFX_FEATURE_FW_ASSISTED_TSO     0x00001000
1072 #define EFX_FEATURE_FW_ASSISTED_TSO_V2  0x00002000
1073 #define EFX_FEATURE_PACKED_STREAM       0x00004000
1074
1075 typedef enum efx_tunnel_protocol_e {
1076         EFX_TUNNEL_PROTOCOL_NONE = 0,
1077         EFX_TUNNEL_PROTOCOL_VXLAN,
1078         EFX_TUNNEL_PROTOCOL_GENEVE,
1079         EFX_TUNNEL_PROTOCOL_NVGRE,
1080         EFX_TUNNEL_NPROTOS
1081 } efx_tunnel_protocol_t;
1082
1083 typedef struct efx_nic_cfg_s {
1084         uint32_t                enc_board_type;
1085         uint32_t                enc_phy_type;
1086 #if EFSYS_OPT_NAMES
1087         char                    enc_phy_name[21];
1088 #endif
1089         char                    enc_phy_revision[21];
1090         efx_mon_type_t          enc_mon_type;
1091 #if EFSYS_OPT_MON_STATS
1092         uint32_t                enc_mon_stat_dma_buf_size;
1093         uint32_t                enc_mon_stat_mask[(EFX_MON_NSTATS + 31) / 32];
1094 #endif
1095         unsigned int            enc_features;
1096         uint8_t                 enc_mac_addr[6];
1097         uint8_t                 enc_port;       /* PHY port number */
1098         uint32_t                enc_intr_vec_base;
1099         uint32_t                enc_intr_limit;
1100         uint32_t                enc_evq_limit;
1101         uint32_t                enc_txq_limit;
1102         uint32_t                enc_rxq_limit;
1103         uint32_t                enc_txq_max_ndescs;
1104         uint32_t                enc_buftbl_limit;
1105         uint32_t                enc_piobuf_limit;
1106         uint32_t                enc_piobuf_size;
1107         uint32_t                enc_piobuf_min_alloc_size;
1108         uint32_t                enc_evq_timer_quantum_ns;
1109         uint32_t                enc_evq_timer_max_us;
1110         uint32_t                enc_clk_mult;
1111         uint32_t                enc_rx_prefix_size;
1112         uint32_t                enc_rx_buf_align_start;
1113         uint32_t                enc_rx_buf_align_end;
1114         uint32_t                enc_rx_scale_max_exclusive_contexts;
1115 #if EFSYS_OPT_LOOPBACK
1116         efx_qword_t             enc_loopback_types[EFX_LINK_NMODES];
1117 #endif  /* EFSYS_OPT_LOOPBACK */
1118 #if EFSYS_OPT_PHY_FLAGS
1119         uint32_t                enc_phy_flags_mask;
1120 #endif  /* EFSYS_OPT_PHY_FLAGS */
1121 #if EFSYS_OPT_PHY_LED_CONTROL
1122         uint32_t                enc_led_mask;
1123 #endif  /* EFSYS_OPT_PHY_LED_CONTROL */
1124 #if EFSYS_OPT_PHY_STATS
1125         uint64_t                enc_phy_stat_mask;
1126 #endif  /* EFSYS_OPT_PHY_STATS */
1127 #if EFSYS_OPT_MCDI
1128         uint8_t                 enc_mcdi_mdio_channel;
1129 #if EFSYS_OPT_PHY_STATS
1130         uint32_t                enc_mcdi_phy_stat_mask;
1131 #endif  /* EFSYS_OPT_PHY_STATS */
1132 #if EFSYS_OPT_MON_STATS
1133         uint32_t                *enc_mcdi_sensor_maskp;
1134         uint32_t                enc_mcdi_sensor_mask_size;
1135 #endif  /* EFSYS_OPT_MON_STATS */
1136 #endif  /* EFSYS_OPT_MCDI */
1137 #if EFSYS_OPT_BIST
1138         uint32_t                enc_bist_mask;
1139 #endif  /* EFSYS_OPT_BIST */
1140 #if EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD
1141         uint32_t                enc_pf;
1142         uint32_t                enc_vf;
1143         uint32_t                enc_privilege_mask;
1144 #endif /* EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD */
1145         boolean_t               enc_bug26807_workaround;
1146         boolean_t               enc_bug35388_workaround;
1147         boolean_t               enc_bug41750_workaround;
1148         boolean_t               enc_bug61265_workaround;
1149         boolean_t               enc_rx_batching_enabled;
1150         /* Maximum number of descriptors completed in an rx event. */
1151         uint32_t                enc_rx_batch_max;
1152         /* Number of rx descriptors the hardware requires for a push. */
1153         uint32_t                enc_rx_push_align;
1154         /* Maximum amount of data in DMA descriptor */
1155         uint32_t                enc_tx_dma_desc_size_max;
1156         /*
1157          * Boundary which DMA descriptor data must not cross or 0 if no
1158          * limitation.
1159          */
1160         uint32_t                enc_tx_dma_desc_boundary;
1161         /*
1162          * Maximum number of bytes into the packet the TCP header can start for
1163          * the hardware to apply TSO packet edits.
1164          */
1165         uint32_t                enc_tx_tso_tcp_header_offset_limit;
1166         boolean_t               enc_fw_assisted_tso_enabled;
1167         boolean_t               enc_fw_assisted_tso_v2_enabled;
1168         /* Number of TSO contexts on the NIC (FATSOv2) */
1169         uint32_t                enc_fw_assisted_tso_v2_n_contexts;
1170         boolean_t               enc_hw_tx_insert_vlan_enabled;
1171         /* Number of PFs on the NIC */
1172         uint32_t                enc_hw_pf_count;
1173         /* Datapath firmware vadapter/vport/vswitch support */
1174         boolean_t               enc_datapath_cap_evb;
1175         boolean_t               enc_rx_disable_scatter_supported;
1176         boolean_t               enc_allow_set_mac_with_installed_filters;
1177         boolean_t               enc_enhanced_set_mac_supported;
1178         boolean_t               enc_init_evq_v2_supported;
1179         boolean_t               enc_rx_packed_stream_supported;
1180         boolean_t               enc_rx_var_packed_stream_supported;
1181         boolean_t               enc_pm_and_rxdp_counters;
1182         boolean_t               enc_mac_stats_40g_tx_size_bins;
1183         uint32_t                enc_tunnel_encapsulations_supported;
1184         /*
1185          * NIC global maximum for unique UDP tunnel ports shared by all
1186          * functions.
1187          */
1188         uint32_t                enc_tunnel_config_udp_entries_max;
1189         /* External port identifier */
1190         uint8_t                 enc_external_port;
1191         uint32_t                enc_mcdi_max_payload_length;
1192         /* VPD may be per-PF or global */
1193         boolean_t               enc_vpd_is_global;
1194         /* Minimum unidirectional bandwidth in Mb/s to max out all ports */
1195         uint32_t                enc_required_pcie_bandwidth_mbps;
1196         uint32_t                enc_max_pcie_link_gen;
1197         /* Firmware verifies integrity of NVRAM updates */
1198         uint32_t                enc_nvram_update_verify_result_supported;
1199 } efx_nic_cfg_t;
1200
1201 #define EFX_PCI_FUNCTION_IS_PF(_encp)   ((_encp)->enc_vf == 0xffff)
1202 #define EFX_PCI_FUNCTION_IS_VF(_encp)   ((_encp)->enc_vf != 0xffff)
1203
1204 #define EFX_PCI_FUNCTION(_encp) \
1205         (EFX_PCI_FUNCTION_IS_PF(_encp) ? (_encp)->enc_pf : (_encp)->enc_vf)
1206
1207 #define EFX_PCI_VF_PARENT(_encp)        ((_encp)->enc_pf)
1208
1209 extern                  const efx_nic_cfg_t *
1210 efx_nic_cfg_get(
1211         __in            efx_nic_t *enp);
1212
1213 typedef struct efx_nic_fw_info_s {
1214         /* Basic FW version information */
1215         uint16_t        enfi_mc_fw_version[4];
1216         /*
1217          * If datapath capabilities can be detected,
1218          * additional FW information is to be shown
1219          */
1220         boolean_t       enfi_dpcpu_fw_ids_valid;
1221         /* Rx and Tx datapath CPU FW IDs */
1222         uint16_t        enfi_rx_dpcpu_fw_id;
1223         uint16_t        enfi_tx_dpcpu_fw_id;
1224 } efx_nic_fw_info_t;
1225
1226 extern  __checkReturn           efx_rc_t
1227 efx_nic_get_fw_version(
1228         __in                    efx_nic_t *enp,
1229         __out                   efx_nic_fw_info_t *enfip);
1230
1231 /* Driver resource limits (minimum required/maximum usable). */
1232 typedef struct efx_drv_limits_s {
1233         uint32_t        edl_min_evq_count;
1234         uint32_t        edl_max_evq_count;
1235
1236         uint32_t        edl_min_rxq_count;
1237         uint32_t        edl_max_rxq_count;
1238
1239         uint32_t        edl_min_txq_count;
1240         uint32_t        edl_max_txq_count;
1241
1242         /* PIO blocks (sub-allocated from piobuf) */
1243         uint32_t        edl_min_pio_alloc_size;
1244         uint32_t        edl_max_pio_alloc_count;
1245 } efx_drv_limits_t;
1246
1247 extern  __checkReturn   efx_rc_t
1248 efx_nic_set_drv_limits(
1249         __inout         efx_nic_t *enp,
1250         __in            efx_drv_limits_t *edlp);
1251
1252 typedef enum efx_nic_region_e {
1253         EFX_REGION_VI,                  /* Memory BAR UC mapping */
1254         EFX_REGION_PIO_WRITE_VI,        /* Memory BAR WC mapping */
1255 } efx_nic_region_t;
1256
1257 extern  __checkReturn   efx_rc_t
1258 efx_nic_get_bar_region(
1259         __in            efx_nic_t *enp,
1260         __in            efx_nic_region_t region,
1261         __out           uint32_t *offsetp,
1262         __out           size_t *sizep);
1263
1264 extern  __checkReturn   efx_rc_t
1265 efx_nic_get_vi_pool(
1266         __in            efx_nic_t *enp,
1267         __out           uint32_t *evq_countp,
1268         __out           uint32_t *rxq_countp,
1269         __out           uint32_t *txq_countp);
1270
1271
1272 #if EFSYS_OPT_VPD
1273
1274 typedef enum efx_vpd_tag_e {
1275         EFX_VPD_ID = 0x02,
1276         EFX_VPD_END = 0x0f,
1277         EFX_VPD_RO = 0x10,
1278         EFX_VPD_RW = 0x11,
1279 } efx_vpd_tag_t;
1280
1281 typedef uint16_t efx_vpd_keyword_t;
1282
1283 typedef struct efx_vpd_value_s {
1284         efx_vpd_tag_t           evv_tag;
1285         efx_vpd_keyword_t       evv_keyword;
1286         uint8_t                 evv_length;
1287         uint8_t                 evv_value[0x100];
1288 } efx_vpd_value_t;
1289
1290
1291 #define EFX_VPD_KEYWORD(x, y) ((x) | ((y) << 8))
1292
1293 extern  __checkReturn           efx_rc_t
1294 efx_vpd_init(
1295         __in                    efx_nic_t *enp);
1296
1297 extern  __checkReturn           efx_rc_t
1298 efx_vpd_size(
1299         __in                    efx_nic_t *enp,
1300         __out                   size_t *sizep);
1301
1302 extern  __checkReturn           efx_rc_t
1303 efx_vpd_read(
1304         __in                    efx_nic_t *enp,
1305         __out_bcount(size)      caddr_t data,
1306         __in                    size_t size);
1307
1308 extern  __checkReturn           efx_rc_t
1309 efx_vpd_verify(
1310         __in                    efx_nic_t *enp,
1311         __in_bcount(size)       caddr_t data,
1312         __in                    size_t size);
1313
1314 extern  __checkReturn           efx_rc_t
1315 efx_vpd_reinit(
1316         __in                    efx_nic_t *enp,
1317         __in_bcount(size)       caddr_t data,
1318         __in                    size_t size);
1319
1320 extern  __checkReturn           efx_rc_t
1321 efx_vpd_get(
1322         __in                    efx_nic_t *enp,
1323         __in_bcount(size)       caddr_t data,
1324         __in                    size_t size,
1325         __inout                 efx_vpd_value_t *evvp);
1326
1327 extern  __checkReturn           efx_rc_t
1328 efx_vpd_set(
1329         __in                    efx_nic_t *enp,
1330         __inout_bcount(size)    caddr_t data,
1331         __in                    size_t size,
1332         __in                    efx_vpd_value_t *evvp);
1333
1334 extern  __checkReturn           efx_rc_t
1335 efx_vpd_next(
1336         __in                    efx_nic_t *enp,
1337         __inout_bcount(size)    caddr_t data,
1338         __in                    size_t size,
1339         __out                   efx_vpd_value_t *evvp,
1340         __inout                 unsigned int *contp);
1341
1342 extern  __checkReturn           efx_rc_t
1343 efx_vpd_write(
1344         __in                    efx_nic_t *enp,
1345         __in_bcount(size)       caddr_t data,
1346         __in                    size_t size);
1347
1348 extern                          void
1349 efx_vpd_fini(
1350         __in                    efx_nic_t *enp);
1351
1352 #endif  /* EFSYS_OPT_VPD */
1353
1354 /* NVRAM */
1355
1356 #if EFSYS_OPT_NVRAM
1357
1358 typedef enum efx_nvram_type_e {
1359         EFX_NVRAM_INVALID = 0,
1360         EFX_NVRAM_BOOTROM,
1361         EFX_NVRAM_BOOTROM_CFG,
1362         EFX_NVRAM_MC_FIRMWARE,
1363         EFX_NVRAM_MC_GOLDEN,
1364         EFX_NVRAM_PHY,
1365         EFX_NVRAM_NULLPHY,
1366         EFX_NVRAM_FPGA,
1367         EFX_NVRAM_FCFW,
1368         EFX_NVRAM_CPLD,
1369         EFX_NVRAM_FPGA_BACKUP,
1370         EFX_NVRAM_DYNAMIC_CFG,
1371         EFX_NVRAM_LICENSE,
1372         EFX_NVRAM_UEFIROM,
1373         EFX_NVRAM_MUM_FIRMWARE,
1374         EFX_NVRAM_NTYPES,
1375 } efx_nvram_type_t;
1376
1377 extern  __checkReturn           efx_rc_t
1378 efx_nvram_init(
1379         __in                    efx_nic_t *enp);
1380
1381 #if EFSYS_OPT_DIAG
1382
1383 extern  __checkReturn           efx_rc_t
1384 efx_nvram_test(
1385         __in                    efx_nic_t *enp);
1386
1387 #endif  /* EFSYS_OPT_DIAG */
1388
1389 extern  __checkReturn           efx_rc_t
1390 efx_nvram_size(
1391         __in                    efx_nic_t *enp,
1392         __in                    efx_nvram_type_t type,
1393         __out                   size_t *sizep);
1394
1395 extern  __checkReturn           efx_rc_t
1396 efx_nvram_rw_start(
1397         __in                    efx_nic_t *enp,
1398         __in                    efx_nvram_type_t type,
1399         __out_opt               size_t *pref_chunkp);
1400
1401 extern  __checkReturn           efx_rc_t
1402 efx_nvram_rw_finish(
1403         __in                    efx_nic_t *enp,
1404         __in                    efx_nvram_type_t type,
1405         __out_opt               uint32_t *verify_resultp);
1406
1407 extern  __checkReturn           efx_rc_t
1408 efx_nvram_get_version(
1409         __in                    efx_nic_t *enp,
1410         __in                    efx_nvram_type_t type,
1411         __out                   uint32_t *subtypep,
1412         __out_ecount(4)         uint16_t version[4]);
1413
1414 extern  __checkReturn           efx_rc_t
1415 efx_nvram_read_chunk(
1416         __in                    efx_nic_t *enp,
1417         __in                    efx_nvram_type_t type,
1418         __in                    unsigned int offset,
1419         __out_bcount(size)      caddr_t data,
1420         __in                    size_t size);
1421
1422 extern  __checkReturn           efx_rc_t
1423 efx_nvram_read_backup(
1424         __in                    efx_nic_t *enp,
1425         __in                    efx_nvram_type_t type,
1426         __in                    unsigned int offset,
1427         __out_bcount(size)      caddr_t data,
1428         __in                    size_t size);
1429
1430 extern  __checkReturn           efx_rc_t
1431 efx_nvram_set_version(
1432         __in                    efx_nic_t *enp,
1433         __in                    efx_nvram_type_t type,
1434         __in_ecount(4)          uint16_t version[4]);
1435
1436 extern  __checkReturn           efx_rc_t
1437 efx_nvram_validate(
1438         __in                    efx_nic_t *enp,
1439         __in                    efx_nvram_type_t type,
1440         __in_bcount(partn_size) caddr_t partn_data,
1441         __in                    size_t partn_size);
1442
1443 extern   __checkReturn          efx_rc_t
1444 efx_nvram_erase(
1445         __in                    efx_nic_t *enp,
1446         __in                    efx_nvram_type_t type);
1447
1448 extern  __checkReturn           efx_rc_t
1449 efx_nvram_write_chunk(
1450         __in                    efx_nic_t *enp,
1451         __in                    efx_nvram_type_t type,
1452         __in                    unsigned int offset,
1453         __in_bcount(size)       caddr_t data,
1454         __in                    size_t size);
1455
1456 extern                          void
1457 efx_nvram_fini(
1458         __in                    efx_nic_t *enp);
1459
1460 #endif  /* EFSYS_OPT_NVRAM */
1461
1462 #if EFSYS_OPT_BOOTCFG
1463
1464 /* Report size and offset of bootcfg sector in NVRAM partition. */
1465 extern  __checkReturn           efx_rc_t
1466 efx_bootcfg_sector_info(
1467         __in                    efx_nic_t *enp,
1468         __in                    uint32_t pf,
1469         __out_opt               uint32_t *sector_countp,
1470         __out                   size_t *offsetp,
1471         __out                   size_t *max_sizep);
1472
1473 /*
1474  * Copy bootcfg sector data to a target buffer which may differ in size.
1475  * Optionally corrects format errors in source buffer.
1476  */
1477 extern                          efx_rc_t
1478 efx_bootcfg_copy_sector(
1479         __in                    efx_nic_t *enp,
1480         __inout_bcount(sector_length)
1481                                 uint8_t *sector,
1482         __in                    size_t sector_length,
1483         __out_bcount(data_size) uint8_t *data,
1484         __in                    size_t data_size,
1485         __in                    boolean_t handle_format_errors);
1486
1487 extern                          efx_rc_t
1488 efx_bootcfg_read(
1489         __in                    efx_nic_t *enp,
1490         __out_bcount(size)      uint8_t *data,
1491         __in                    size_t size);
1492
1493 extern                          efx_rc_t
1494 efx_bootcfg_write(
1495         __in                    efx_nic_t *enp,
1496         __in_bcount(size)       uint8_t *data,
1497         __in                    size_t size);
1498
1499 #endif  /* EFSYS_OPT_BOOTCFG */
1500
1501 #if EFSYS_OPT_DIAG
1502
1503 typedef enum efx_pattern_type_t {
1504         EFX_PATTERN_BYTE_INCREMENT = 0,
1505         EFX_PATTERN_ALL_THE_SAME,
1506         EFX_PATTERN_BIT_ALTERNATE,
1507         EFX_PATTERN_BYTE_ALTERNATE,
1508         EFX_PATTERN_BYTE_CHANGING,
1509         EFX_PATTERN_BIT_SWEEP,
1510         EFX_PATTERN_NTYPES
1511 } efx_pattern_type_t;
1512
1513 typedef                 void
1514 (*efx_sram_pattern_fn_t)(
1515         __in            size_t row,
1516         __in            boolean_t negate,
1517         __out           efx_qword_t *eqp);
1518
1519 extern  __checkReturn   efx_rc_t
1520 efx_sram_test(
1521         __in            efx_nic_t *enp,
1522         __in            efx_pattern_type_t type);
1523
1524 #endif  /* EFSYS_OPT_DIAG */
1525
1526 extern  __checkReturn   efx_rc_t
1527 efx_sram_buf_tbl_set(
1528         __in            efx_nic_t *enp,
1529         __in            uint32_t id,
1530         __in            efsys_mem_t *esmp,
1531         __in            size_t n);
1532
1533 extern          void
1534 efx_sram_buf_tbl_clear(
1535         __in    efx_nic_t *enp,
1536         __in    uint32_t id,
1537         __in    size_t n);
1538
1539 #define EFX_BUF_TBL_SIZE        0x20000
1540
1541 #define EFX_BUF_SIZE            4096
1542
1543 /* EV */
1544
1545 typedef struct efx_evq_s        efx_evq_t;
1546
1547 #if EFSYS_OPT_QSTATS
1548
1549 /* START MKCONFIG GENERATED EfxHeaderEventQueueBlock 6f3843f5fe7cc843 */
1550 typedef enum efx_ev_qstat_e {
1551         EV_ALL,
1552         EV_RX,
1553         EV_RX_OK,
1554         EV_RX_FRM_TRUNC,
1555         EV_RX_TOBE_DISC,
1556         EV_RX_PAUSE_FRM_ERR,
1557         EV_RX_BUF_OWNER_ID_ERR,
1558         EV_RX_IPV4_HDR_CHKSUM_ERR,
1559         EV_RX_TCP_UDP_CHKSUM_ERR,
1560         EV_RX_ETH_CRC_ERR,
1561         EV_RX_IP_FRAG_ERR,
1562         EV_RX_MCAST_PKT,
1563         EV_RX_MCAST_HASH_MATCH,
1564         EV_RX_TCP_IPV4,
1565         EV_RX_TCP_IPV6,
1566         EV_RX_UDP_IPV4,
1567         EV_RX_UDP_IPV6,
1568         EV_RX_OTHER_IPV4,
1569         EV_RX_OTHER_IPV6,
1570         EV_RX_NON_IP,
1571         EV_RX_BATCH,
1572         EV_TX,
1573         EV_TX_WQ_FF_FULL,
1574         EV_TX_PKT_ERR,
1575         EV_TX_PKT_TOO_BIG,
1576         EV_TX_UNEXPECTED,
1577         EV_GLOBAL,
1578         EV_GLOBAL_MNT,
1579         EV_DRIVER,
1580         EV_DRIVER_SRM_UPD_DONE,
1581         EV_DRIVER_TX_DESCQ_FLS_DONE,
1582         EV_DRIVER_RX_DESCQ_FLS_DONE,
1583         EV_DRIVER_RX_DESCQ_FLS_FAILED,
1584         EV_DRIVER_RX_DSC_ERROR,
1585         EV_DRIVER_TX_DSC_ERROR,
1586         EV_DRV_GEN,
1587         EV_MCDI_RESPONSE,
1588         EV_NQSTATS
1589 } efx_ev_qstat_t;
1590
1591 /* END MKCONFIG GENERATED EfxHeaderEventQueueBlock */
1592
1593 #endif  /* EFSYS_OPT_QSTATS */
1594
1595 extern  __checkReturn   efx_rc_t
1596 efx_ev_init(
1597         __in            efx_nic_t *enp);
1598
1599 extern          void
1600 efx_ev_fini(
1601         __in            efx_nic_t *enp);
1602
1603 #define EFX_EVQ_MAXNEVS         32768
1604 #define EFX_EVQ_MINNEVS         512
1605
1606 #define EFX_EVQ_SIZE(_nevs)     ((_nevs) * sizeof (efx_qword_t))
1607 #define EFX_EVQ_NBUFS(_nevs)    (EFX_EVQ_SIZE(_nevs) / EFX_BUF_SIZE)
1608
1609 #define EFX_EVQ_FLAGS_TYPE_MASK         (0x3)
1610 #define EFX_EVQ_FLAGS_TYPE_AUTO         (0x0)
1611 #define EFX_EVQ_FLAGS_TYPE_THROUGHPUT   (0x1)
1612 #define EFX_EVQ_FLAGS_TYPE_LOW_LATENCY  (0x2)
1613
1614 #define EFX_EVQ_FLAGS_NOTIFY_MASK       (0xC)
1615 #define EFX_EVQ_FLAGS_NOTIFY_INTERRUPT  (0x0)   /* Interrupting (default) */
1616 #define EFX_EVQ_FLAGS_NOTIFY_DISABLED   (0x4)   /* Non-interrupting */
1617
1618 extern  __checkReturn   efx_rc_t
1619 efx_ev_qcreate(
1620         __in            efx_nic_t *enp,
1621         __in            unsigned int index,
1622         __in            efsys_mem_t *esmp,
1623         __in            size_t ndescs,
1624         __in            uint32_t id,
1625         __in            uint32_t us,
1626         __in            uint32_t flags,
1627         __deref_out     efx_evq_t **eepp);
1628
1629 extern          void
1630 efx_ev_qpost(
1631         __in            efx_evq_t *eep,
1632         __in            uint16_t data);
1633
1634 typedef __checkReturn   boolean_t
1635 (*efx_initialized_ev_t)(
1636         __in_opt        void *arg);
1637
1638 #define EFX_PKT_UNICAST         0x0004
1639 #define EFX_PKT_START           0x0008
1640
1641 #define EFX_PKT_VLAN_TAGGED     0x0010
1642 #define EFX_CKSUM_TCPUDP        0x0020
1643 #define EFX_CKSUM_IPV4          0x0040
1644 #define EFX_PKT_CONT            0x0080
1645
1646 #define EFX_CHECK_VLAN          0x0100
1647 #define EFX_PKT_TCP             0x0200
1648 #define EFX_PKT_UDP             0x0400
1649 #define EFX_PKT_IPV4            0x0800
1650
1651 #define EFX_PKT_IPV6            0x1000
1652 #define EFX_PKT_PREFIX_LEN      0x2000
1653 #define EFX_ADDR_MISMATCH       0x4000
1654 #define EFX_DISCARD             0x8000
1655
1656 /*
1657  * The following flags are used only for packed stream
1658  * mode. The values for the flags are reused to fit into 16 bit,
1659  * since EFX_PKT_START and EFX_PKT_CONT are never used in
1660  * packed stream mode
1661  */
1662 #define EFX_PKT_PACKED_STREAM_NEW_BUFFER        EFX_PKT_START
1663 #define EFX_PKT_PACKED_STREAM_PARSE_INCOMPLETE  EFX_PKT_CONT
1664
1665
1666 #define EFX_EV_RX_NLABELS       32
1667 #define EFX_EV_TX_NLABELS       32
1668
1669 typedef __checkReturn   boolean_t
1670 (*efx_rx_ev_t)(
1671         __in_opt        void *arg,
1672         __in            uint32_t label,
1673         __in            uint32_t id,
1674         __in            uint32_t size,
1675         __in            uint16_t flags);
1676
1677 #if EFSYS_OPT_RX_PACKED_STREAM
1678
1679 /*
1680  * Packed stream mode is documented in SF-112241-TC.
1681  * The general idea is that, instead of putting each incoming
1682  * packet into a separate buffer which is specified in a RX
1683  * descriptor, a large buffer is provided to the hardware and
1684  * packets are put there in a continuous stream.
1685  * The main advantage of such an approach is that RX queue refilling
1686  * happens much less frequently.
1687  */
1688
1689 typedef __checkReturn   boolean_t
1690 (*efx_rx_ps_ev_t)(
1691         __in_opt        void *arg,
1692         __in            uint32_t label,
1693         __in            uint32_t id,
1694         __in            uint32_t pkt_count,
1695         __in            uint16_t flags);
1696
1697 #endif
1698
1699 typedef __checkReturn   boolean_t
1700 (*efx_tx_ev_t)(
1701         __in_opt        void *arg,
1702         __in            uint32_t label,
1703         __in            uint32_t id);
1704
1705 #define EFX_EXCEPTION_RX_RECOVERY       0x00000001
1706 #define EFX_EXCEPTION_RX_DSC_ERROR      0x00000002
1707 #define EFX_EXCEPTION_TX_DSC_ERROR      0x00000003
1708 #define EFX_EXCEPTION_UNKNOWN_SENSOREVT 0x00000004
1709 #define EFX_EXCEPTION_FWALERT_SRAM      0x00000005
1710 #define EFX_EXCEPTION_UNKNOWN_FWALERT   0x00000006
1711 #define EFX_EXCEPTION_RX_ERROR          0x00000007
1712 #define EFX_EXCEPTION_TX_ERROR          0x00000008
1713 #define EFX_EXCEPTION_EV_ERROR          0x00000009
1714
1715 typedef __checkReturn   boolean_t
1716 (*efx_exception_ev_t)(
1717         __in_opt        void *arg,
1718         __in            uint32_t label,
1719         __in            uint32_t data);
1720
1721 typedef __checkReturn   boolean_t
1722 (*efx_rxq_flush_done_ev_t)(
1723         __in_opt        void *arg,
1724         __in            uint32_t rxq_index);
1725
1726 typedef __checkReturn   boolean_t
1727 (*efx_rxq_flush_failed_ev_t)(
1728         __in_opt        void *arg,
1729         __in            uint32_t rxq_index);
1730
1731 typedef __checkReturn   boolean_t
1732 (*efx_txq_flush_done_ev_t)(
1733         __in_opt        void *arg,
1734         __in            uint32_t txq_index);
1735
1736 typedef __checkReturn   boolean_t
1737 (*efx_software_ev_t)(
1738         __in_opt        void *arg,
1739         __in            uint16_t magic);
1740
1741 typedef __checkReturn   boolean_t
1742 (*efx_sram_ev_t)(
1743         __in_opt        void *arg,
1744         __in            uint32_t code);
1745
1746 #define EFX_SRAM_CLEAR          0
1747 #define EFX_SRAM_UPDATE         1
1748 #define EFX_SRAM_ILLEGAL_CLEAR  2
1749
1750 typedef __checkReturn   boolean_t
1751 (*efx_wake_up_ev_t)(
1752         __in_opt        void *arg,
1753         __in            uint32_t label);
1754
1755 typedef __checkReturn   boolean_t
1756 (*efx_timer_ev_t)(
1757         __in_opt        void *arg,
1758         __in            uint32_t label);
1759
1760 typedef __checkReturn   boolean_t
1761 (*efx_link_change_ev_t)(
1762         __in_opt        void *arg,
1763         __in            efx_link_mode_t link_mode);
1764
1765 #if EFSYS_OPT_MON_STATS
1766
1767 typedef __checkReturn   boolean_t
1768 (*efx_monitor_ev_t)(
1769         __in_opt        void *arg,
1770         __in            efx_mon_stat_t id,
1771         __in            efx_mon_stat_value_t value);
1772
1773 #endif  /* EFSYS_OPT_MON_STATS */
1774
1775 #if EFSYS_OPT_MAC_STATS
1776
1777 typedef __checkReturn   boolean_t
1778 (*efx_mac_stats_ev_t)(
1779         __in_opt        void *arg,
1780         __in            uint32_t generation);
1781
1782 #endif  /* EFSYS_OPT_MAC_STATS */
1783
1784 typedef struct efx_ev_callbacks_s {
1785         efx_initialized_ev_t            eec_initialized;
1786         efx_rx_ev_t                     eec_rx;
1787 #if EFSYS_OPT_RX_PACKED_STREAM
1788         efx_rx_ps_ev_t                  eec_rx_ps;
1789 #endif
1790         efx_tx_ev_t                     eec_tx;
1791         efx_exception_ev_t              eec_exception;
1792         efx_rxq_flush_done_ev_t         eec_rxq_flush_done;
1793         efx_rxq_flush_failed_ev_t       eec_rxq_flush_failed;
1794         efx_txq_flush_done_ev_t         eec_txq_flush_done;
1795         efx_software_ev_t               eec_software;
1796         efx_sram_ev_t                   eec_sram;
1797         efx_wake_up_ev_t                eec_wake_up;
1798         efx_timer_ev_t                  eec_timer;
1799         efx_link_change_ev_t            eec_link_change;
1800 #if EFSYS_OPT_MON_STATS
1801         efx_monitor_ev_t                eec_monitor;
1802 #endif  /* EFSYS_OPT_MON_STATS */
1803 #if EFSYS_OPT_MAC_STATS
1804         efx_mac_stats_ev_t              eec_mac_stats;
1805 #endif  /* EFSYS_OPT_MAC_STATS */
1806 } efx_ev_callbacks_t;
1807
1808 extern  __checkReturn   boolean_t
1809 efx_ev_qpending(
1810         __in            efx_evq_t *eep,
1811         __in            unsigned int count);
1812
1813 #if EFSYS_OPT_EV_PREFETCH
1814
1815 extern                  void
1816 efx_ev_qprefetch(
1817         __in            efx_evq_t *eep,
1818         __in            unsigned int count);
1819
1820 #endif  /* EFSYS_OPT_EV_PREFETCH */
1821
1822 extern                  void
1823 efx_ev_qpoll(
1824         __in            efx_evq_t *eep,
1825         __inout         unsigned int *countp,
1826         __in            const efx_ev_callbacks_t *eecp,
1827         __in_opt        void *arg);
1828
1829 extern  __checkReturn   efx_rc_t
1830 efx_ev_usecs_to_ticks(
1831         __in            efx_nic_t *enp,
1832         __in            unsigned int usecs,
1833         __out           unsigned int *ticksp);
1834
1835 extern  __checkReturn   efx_rc_t
1836 efx_ev_qmoderate(
1837         __in            efx_evq_t *eep,
1838         __in            unsigned int us);
1839
1840 extern  __checkReturn   efx_rc_t
1841 efx_ev_qprime(
1842         __in            efx_evq_t *eep,
1843         __in            unsigned int count);
1844
1845 #if EFSYS_OPT_QSTATS
1846
1847 #if EFSYS_OPT_NAMES
1848
1849 extern          const char *
1850 efx_ev_qstat_name(
1851         __in    efx_nic_t *enp,
1852         __in    unsigned int id);
1853
1854 #endif  /* EFSYS_OPT_NAMES */
1855
1856 extern                                  void
1857 efx_ev_qstats_update(
1858         __in                            efx_evq_t *eep,
1859         __inout_ecount(EV_NQSTATS)      efsys_stat_t *stat);
1860
1861 #endif  /* EFSYS_OPT_QSTATS */
1862
1863 extern          void
1864 efx_ev_qdestroy(
1865         __in    efx_evq_t *eep);
1866
1867 /* RX */
1868
1869 extern  __checkReturn   efx_rc_t
1870 efx_rx_init(
1871         __inout         efx_nic_t *enp);
1872
1873 extern          void
1874 efx_rx_fini(
1875         __in            efx_nic_t *enp);
1876
1877 #if EFSYS_OPT_RX_SCATTER
1878         __checkReturn   efx_rc_t
1879 efx_rx_scatter_enable(
1880         __in            efx_nic_t *enp,
1881         __in            unsigned int buf_size);
1882 #endif  /* EFSYS_OPT_RX_SCATTER */
1883
1884 /* Handle to represent use of the default RSS context. */
1885 #define EFX_RSS_CONTEXT_DEFAULT 0xffffffff
1886
1887 #if EFSYS_OPT_RX_SCALE
1888
1889 typedef enum efx_rx_hash_alg_e {
1890         EFX_RX_HASHALG_LFSR = 0,
1891         EFX_RX_HASHALG_TOEPLITZ
1892 } efx_rx_hash_alg_t;
1893
1894 #define EFX_RX_HASH_IPV4        (1U << 0)
1895 #define EFX_RX_HASH_TCPIPV4     (1U << 1)
1896 #define EFX_RX_HASH_IPV6        (1U << 2)
1897 #define EFX_RX_HASH_TCPIPV6     (1U << 3)
1898
1899 typedef unsigned int efx_rx_hash_type_t;
1900
1901 typedef enum efx_rx_hash_support_e {
1902         EFX_RX_HASH_UNAVAILABLE = 0,    /* Hardware hash not inserted */
1903         EFX_RX_HASH_AVAILABLE           /* Insert hash with/without RSS */
1904 } efx_rx_hash_support_t;
1905
1906 #define EFX_RSS_KEY_SIZE        40      /* RSS key size (bytes) */
1907 #define EFX_RSS_TBL_SIZE        128     /* Rows in RX indirection table */
1908 #define EFX_MAXRSS              64      /* RX indirection entry range */
1909 #define EFX_MAXRSS_LEGACY       16      /* See bug16611 and bug17213 */
1910
1911 typedef enum efx_rx_scale_context_type_e {
1912         EFX_RX_SCALE_UNAVAILABLE = 0,   /* No RX scale context */
1913         EFX_RX_SCALE_EXCLUSIVE,         /* Writable key/indirection table */
1914         EFX_RX_SCALE_SHARED             /* Read-only key/indirection table */
1915 } efx_rx_scale_context_type_t;
1916
1917 extern  __checkReturn   efx_rc_t
1918 efx_rx_hash_default_support_get(
1919         __in            efx_nic_t *enp,
1920         __out           efx_rx_hash_support_t *supportp);
1921
1922
1923 extern  __checkReturn   efx_rc_t
1924 efx_rx_scale_default_support_get(
1925         __in            efx_nic_t *enp,
1926         __out           efx_rx_scale_context_type_t *typep);
1927
1928 extern  __checkReturn   efx_rc_t
1929 efx_rx_scale_context_alloc(
1930         __in            efx_nic_t *enp,
1931         __in            efx_rx_scale_context_type_t type,
1932         __in            uint32_t num_queues,
1933         __out           uint32_t *rss_contextp);
1934
1935 extern  __checkReturn   efx_rc_t
1936 efx_rx_scale_context_free(
1937         __in            efx_nic_t *enp,
1938         __in            uint32_t rss_context);
1939
1940 extern  __checkReturn   efx_rc_t
1941 efx_rx_scale_mode_set(
1942         __in    efx_nic_t *enp,
1943         __in    uint32_t rss_context,
1944         __in    efx_rx_hash_alg_t alg,
1945         __in    efx_rx_hash_type_t type,
1946         __in    boolean_t insert);
1947
1948 extern  __checkReturn   efx_rc_t
1949 efx_rx_scale_tbl_set(
1950         __in            efx_nic_t *enp,
1951         __in            uint32_t rss_context,
1952         __in_ecount(n)  unsigned int *table,
1953         __in            size_t n);
1954
1955 extern  __checkReturn   efx_rc_t
1956 efx_rx_scale_key_set(
1957         __in            efx_nic_t *enp,
1958         __in            uint32_t rss_context,
1959         __in_ecount(n)  uint8_t *key,
1960         __in            size_t n);
1961
1962 extern  __checkReturn   uint32_t
1963 efx_pseudo_hdr_hash_get(
1964         __in            efx_rxq_t *erp,
1965         __in            efx_rx_hash_alg_t func,
1966         __in            uint8_t *buffer);
1967
1968 #endif  /* EFSYS_OPT_RX_SCALE */
1969
1970 extern  __checkReturn   efx_rc_t
1971 efx_pseudo_hdr_pkt_length_get(
1972         __in            efx_rxq_t *erp,
1973         __in            uint8_t *buffer,
1974         __out           uint16_t *pkt_lengthp);
1975
1976 #define EFX_RXQ_MAXNDESCS               4096
1977 #define EFX_RXQ_MINNDESCS               512
1978
1979 #define EFX_RXQ_SIZE(_ndescs)           ((_ndescs) * sizeof (efx_qword_t))
1980 #define EFX_RXQ_NBUFS(_ndescs)          (EFX_RXQ_SIZE(_ndescs) / EFX_BUF_SIZE)
1981 #define EFX_RXQ_LIMIT(_ndescs)          ((_ndescs) - 16)
1982 #define EFX_RXQ_DC_NDESCS(_dcsize)      (8 << _dcsize)
1983
1984 typedef enum efx_rxq_type_e {
1985         EFX_RXQ_TYPE_DEFAULT,
1986         EFX_RXQ_TYPE_PACKED_STREAM,
1987         EFX_RXQ_NTYPES
1988 } efx_rxq_type_t;
1989
1990 /*
1991  * Dummy flag to be used instead of 0 to make it clear that the argument
1992  * is receive queue flags.
1993  */
1994 #define EFX_RXQ_FLAG_NONE               0x0
1995 #define EFX_RXQ_FLAG_SCATTER            0x1
1996 /*
1997  * If tunnels are supported and Rx event can provide information about
1998  * either outer or inner packet classes (e.g. SFN8xxx adapters with
1999  * full-feature firmware variant running), outer classes are requested by
2000  * default. However, if the driver supports tunnels, the flag allows to
2001  * request inner classes which are required to be able to interpret inner
2002  * Rx checksum offload results.
2003  */
2004 #define EFX_RXQ_FLAG_INNER_CLASSES      0x2
2005
2006 extern  __checkReturn   efx_rc_t
2007 efx_rx_qcreate(
2008         __in            efx_nic_t *enp,
2009         __in            unsigned int index,
2010         __in            unsigned int label,
2011         __in            efx_rxq_type_t type,
2012         __in            efsys_mem_t *esmp,
2013         __in            size_t ndescs,
2014         __in            uint32_t id,
2015         __in            unsigned int flags,
2016         __in            efx_evq_t *eep,
2017         __deref_out     efx_rxq_t **erpp);
2018
2019 #if EFSYS_OPT_RX_PACKED_STREAM
2020
2021 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_1M       (1U * 1024 * 1024)
2022 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_512K     (512U * 1024)
2023 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_256K     (256U * 1024)
2024 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_128K     (128U * 1024)
2025 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_64K      (64U * 1024)
2026
2027 extern  __checkReturn   efx_rc_t
2028 efx_rx_qcreate_packed_stream(
2029         __in            efx_nic_t *enp,
2030         __in            unsigned int index,
2031         __in            unsigned int label,
2032         __in            uint32_t ps_buf_size,
2033         __in            efsys_mem_t *esmp,
2034         __in            size_t ndescs,
2035         __in            efx_evq_t *eep,
2036         __deref_out     efx_rxq_t **erpp);
2037
2038 #endif
2039
2040 typedef struct efx_buffer_s {
2041         efsys_dma_addr_t        eb_addr;
2042         size_t                  eb_size;
2043         boolean_t               eb_eop;
2044 } efx_buffer_t;
2045
2046 typedef struct efx_desc_s {
2047         efx_qword_t ed_eq;
2048 } efx_desc_t;
2049
2050 extern                          void
2051 efx_rx_qpost(
2052         __in                    efx_rxq_t *erp,
2053         __in_ecount(ndescs)     efsys_dma_addr_t *addrp,
2054         __in                    size_t size,
2055         __in                    unsigned int ndescs,
2056         __in                    unsigned int completed,
2057         __in                    unsigned int added);
2058
2059 extern          void
2060 efx_rx_qpush(
2061         __in    efx_rxq_t *erp,
2062         __in    unsigned int added,
2063         __inout unsigned int *pushedp);
2064
2065 #if EFSYS_OPT_RX_PACKED_STREAM
2066
2067 extern                  void
2068 efx_rx_qpush_ps_credits(
2069         __in            efx_rxq_t *erp);
2070
2071 extern  __checkReturn   uint8_t *
2072 efx_rx_qps_packet_info(
2073         __in            efx_rxq_t *erp,
2074         __in            uint8_t *buffer,
2075         __in            uint32_t buffer_length,
2076         __in            uint32_t current_offset,
2077         __out           uint16_t *lengthp,
2078         __out           uint32_t *next_offsetp,
2079         __out           uint32_t *timestamp);
2080 #endif
2081
2082 extern  __checkReturn   efx_rc_t
2083 efx_rx_qflush(
2084         __in    efx_rxq_t *erp);
2085
2086 extern          void
2087 efx_rx_qenable(
2088         __in    efx_rxq_t *erp);
2089
2090 extern          void
2091 efx_rx_qdestroy(
2092         __in    efx_rxq_t *erp);
2093
2094 /* TX */
2095
2096 typedef struct efx_txq_s        efx_txq_t;
2097
2098 #if EFSYS_OPT_QSTATS
2099
2100 /* START MKCONFIG GENERATED EfxHeaderTransmitQueueBlock 12dff8778598b2db */
2101 typedef enum efx_tx_qstat_e {
2102         TX_POST,
2103         TX_POST_PIO,
2104         TX_NQSTATS
2105 } efx_tx_qstat_t;
2106
2107 /* END MKCONFIG GENERATED EfxHeaderTransmitQueueBlock */
2108
2109 #endif  /* EFSYS_OPT_QSTATS */
2110
2111 extern  __checkReturn   efx_rc_t
2112 efx_tx_init(
2113         __in            efx_nic_t *enp);
2114
2115 extern          void
2116 efx_tx_fini(
2117         __in    efx_nic_t *enp);
2118
2119 #define EFX_TXQ_MINNDESCS               512
2120
2121 #define EFX_TXQ_SIZE(_ndescs)           ((_ndescs) * sizeof (efx_qword_t))
2122 #define EFX_TXQ_NBUFS(_ndescs)          (EFX_TXQ_SIZE(_ndescs) / EFX_BUF_SIZE)
2123 #define EFX_TXQ_LIMIT(_ndescs)          ((_ndescs) - 16)
2124
2125 #define EFX_TXQ_MAX_BUFS 8 /* Maximum independent of EFX_BUG35388_WORKAROUND. */
2126
2127 #define EFX_TXQ_CKSUM_IPV4              0x0001
2128 #define EFX_TXQ_CKSUM_TCPUDP            0x0002
2129 #define EFX_TXQ_FATSOV2                 0x0004
2130 #define EFX_TXQ_CKSUM_INNER_IPV4        0x0008
2131 #define EFX_TXQ_CKSUM_INNER_TCPUDP      0x0010
2132
2133 extern  __checkReturn   efx_rc_t
2134 efx_tx_qcreate(
2135         __in            efx_nic_t *enp,
2136         __in            unsigned int index,
2137         __in            unsigned int label,
2138         __in            efsys_mem_t *esmp,
2139         __in            size_t n,
2140         __in            uint32_t id,
2141         __in            uint16_t flags,
2142         __in            efx_evq_t *eep,
2143         __deref_out     efx_txq_t **etpp,
2144         __out           unsigned int *addedp);
2145
2146 extern  __checkReturn           efx_rc_t
2147 efx_tx_qpost(
2148         __in                    efx_txq_t *etp,
2149         __in_ecount(ndescs)     efx_buffer_t *eb,
2150         __in                    unsigned int ndescs,
2151         __in                    unsigned int completed,
2152         __inout                 unsigned int *addedp);
2153
2154 extern  __checkReturn   efx_rc_t
2155 efx_tx_qpace(
2156         __in            efx_txq_t *etp,
2157         __in            unsigned int ns);
2158
2159 extern                  void
2160 efx_tx_qpush(
2161         __in            efx_txq_t *etp,
2162         __in            unsigned int added,
2163         __in            unsigned int pushed);
2164
2165 extern  __checkReturn   efx_rc_t
2166 efx_tx_qflush(
2167         __in            efx_txq_t *etp);
2168
2169 extern                  void
2170 efx_tx_qenable(
2171         __in            efx_txq_t *etp);
2172
2173 extern  __checkReturn   efx_rc_t
2174 efx_tx_qpio_enable(
2175         __in            efx_txq_t *etp);
2176
2177 extern                  void
2178 efx_tx_qpio_disable(
2179         __in            efx_txq_t *etp);
2180
2181 extern  __checkReturn   efx_rc_t
2182 efx_tx_qpio_write(
2183         __in                    efx_txq_t *etp,
2184         __in_ecount(buf_length) uint8_t *buffer,
2185         __in                    size_t buf_length,
2186         __in                    size_t pio_buf_offset);
2187
2188 extern  __checkReturn   efx_rc_t
2189 efx_tx_qpio_post(
2190         __in                    efx_txq_t *etp,
2191         __in                    size_t pkt_length,
2192         __in                    unsigned int completed,
2193         __inout                 unsigned int *addedp);
2194
2195 extern  __checkReturn   efx_rc_t
2196 efx_tx_qdesc_post(
2197         __in            efx_txq_t *etp,
2198         __in_ecount(n)  efx_desc_t *ed,
2199         __in            unsigned int n,
2200         __in            unsigned int completed,
2201         __inout         unsigned int *addedp);
2202
2203 extern  void
2204 efx_tx_qdesc_dma_create(
2205         __in    efx_txq_t *etp,
2206         __in    efsys_dma_addr_t addr,
2207         __in    size_t size,
2208         __in    boolean_t eop,
2209         __out   efx_desc_t *edp);
2210
2211 extern  void
2212 efx_tx_qdesc_tso_create(
2213         __in    efx_txq_t *etp,
2214         __in    uint16_t ipv4_id,
2215         __in    uint32_t tcp_seq,
2216         __in    uint8_t  tcp_flags,
2217         __out   efx_desc_t *edp);
2218
2219 /* Number of FATSOv2 option descriptors */
2220 #define EFX_TX_FATSOV2_OPT_NDESCS               2
2221
2222 /* Maximum number of DMA segments per TSO packet (not superframe) */
2223 #define EFX_TX_FATSOV2_DMA_SEGS_PER_PKT_MAX     24
2224
2225 extern  void
2226 efx_tx_qdesc_tso2_create(
2227         __in                    efx_txq_t *etp,
2228         __in                    uint16_t ipv4_id,
2229         __in                    uint32_t tcp_seq,
2230         __in                    uint16_t tcp_mss,
2231         __out_ecount(count)     efx_desc_t *edp,
2232         __in                    int count);
2233
2234 extern  void
2235 efx_tx_qdesc_vlantci_create(
2236         __in    efx_txq_t *etp,
2237         __in    uint16_t tci,
2238         __out   efx_desc_t *edp);
2239
2240 #if EFSYS_OPT_QSTATS
2241
2242 #if EFSYS_OPT_NAMES
2243
2244 extern          const char *
2245 efx_tx_qstat_name(
2246         __in    efx_nic_t *etp,
2247         __in    unsigned int id);
2248
2249 #endif  /* EFSYS_OPT_NAMES */
2250
2251 extern                                  void
2252 efx_tx_qstats_update(
2253         __in                            efx_txq_t *etp,
2254         __inout_ecount(TX_NQSTATS)      efsys_stat_t *stat);
2255
2256 #endif  /* EFSYS_OPT_QSTATS */
2257
2258 extern          void
2259 efx_tx_qdestroy(
2260         __in    efx_txq_t *etp);
2261
2262
2263 /* FILTER */
2264
2265 #if EFSYS_OPT_FILTER
2266
2267 #define EFX_ETHER_TYPE_IPV4 0x0800
2268 #define EFX_ETHER_TYPE_IPV6 0x86DD
2269
2270 #define EFX_IPPROTO_TCP 6
2271 #define EFX_IPPROTO_UDP 17
2272 #define EFX_IPPROTO_GRE 47
2273
2274 /* Use RSS to spread across multiple queues */
2275 #define EFX_FILTER_FLAG_RX_RSS          0x01
2276 /* Enable RX scatter */
2277 #define EFX_FILTER_FLAG_RX_SCATTER      0x02
2278 /*
2279  * Override an automatic filter (priority EFX_FILTER_PRI_AUTO).
2280  * May only be set by the filter implementation for each type.
2281  * A removal request will restore the automatic filter in its place.
2282  */
2283 #define EFX_FILTER_FLAG_RX_OVER_AUTO    0x04
2284 /* Filter is for RX */
2285 #define EFX_FILTER_FLAG_RX              0x08
2286 /* Filter is for TX */
2287 #define EFX_FILTER_FLAG_TX              0x10
2288
2289 typedef uint8_t efx_filter_flags_t;
2290
2291 /*
2292  * Flags which specify the fields to match on. The values are the same as in the
2293  * MC_CMD_FILTER_OP/MC_CMD_FILTER_OP_EXT commands.
2294  */
2295
2296 /* Match by remote IP host address */
2297 #define EFX_FILTER_MATCH_REM_HOST               0x00000001
2298 /* Match by local IP host address */
2299 #define EFX_FILTER_MATCH_LOC_HOST               0x00000002
2300 /* Match by remote MAC address */
2301 #define EFX_FILTER_MATCH_REM_MAC                0x00000004
2302 /* Match by remote TCP/UDP port */
2303 #define EFX_FILTER_MATCH_REM_PORT               0x00000008
2304 /* Match by remote TCP/UDP port */
2305 #define EFX_FILTER_MATCH_LOC_MAC                0x00000010
2306 /* Match by local TCP/UDP port */
2307 #define EFX_FILTER_MATCH_LOC_PORT               0x00000020
2308 /* Match by Ether-type */
2309 #define EFX_FILTER_MATCH_ETHER_TYPE             0x00000040
2310 /* Match by inner VLAN ID */
2311 #define EFX_FILTER_MATCH_INNER_VID              0x00000080
2312 /* Match by outer VLAN ID */
2313 #define EFX_FILTER_MATCH_OUTER_VID              0x00000100
2314 /* Match by IP transport protocol */
2315 #define EFX_FILTER_MATCH_IP_PROTO               0x00000200
2316 /* For encapsulated packets, match all multicast inner frames */
2317 #define EFX_FILTER_MATCH_IFRM_UNKNOWN_MCAST_DST 0x01000000
2318 /* For encapsulated packets, match all unicast inner frames */
2319 #define EFX_FILTER_MATCH_IFRM_UNKNOWN_UCAST_DST 0x02000000
2320 /* Match otherwise-unmatched multicast and broadcast packets */
2321 #define EFX_FILTER_MATCH_UNKNOWN_MCAST_DST      0x40000000
2322 /* Match otherwise-unmatched unicast packets */
2323 #define EFX_FILTER_MATCH_UNKNOWN_UCAST_DST      0x80000000
2324
2325 typedef uint32_t efx_filter_match_flags_t;
2326
2327 typedef enum efx_filter_priority_s {
2328         EFX_FILTER_PRI_HINT = 0,        /* Performance hint */
2329         EFX_FILTER_PRI_AUTO,            /* Automatic filter based on device
2330                                          * address list or hardware
2331                                          * requirements. This may only be used
2332                                          * by the filter implementation for
2333                                          * each NIC type. */
2334         EFX_FILTER_PRI_MANUAL,          /* Manually configured filter */
2335         EFX_FILTER_PRI_REQUIRED,        /* Required for correct behaviour of the
2336                                          * client (e.g. SR-IOV, HyperV VMQ etc.)
2337                                          */
2338 } efx_filter_priority_t;
2339
2340 /*
2341  * FIXME: All these fields are assumed to be in little-endian byte order.
2342  * It may be better for some to be big-endian. See bug42804.
2343  */
2344
2345 typedef struct efx_filter_spec_s {
2346         efx_filter_match_flags_t        efs_match_flags;
2347         uint8_t                         efs_priority;
2348         efx_filter_flags_t              efs_flags;
2349         uint16_t                        efs_dmaq_id;
2350         uint32_t                        efs_rss_context;
2351         uint16_t                        efs_outer_vid;
2352         uint16_t                        efs_inner_vid;
2353         uint8_t                         efs_loc_mac[EFX_MAC_ADDR_LEN];
2354         uint8_t                         efs_rem_mac[EFX_MAC_ADDR_LEN];
2355         uint16_t                        efs_ether_type;
2356         uint8_t                         efs_ip_proto;
2357         efx_tunnel_protocol_t           efs_encap_type;
2358         uint16_t                        efs_loc_port;
2359         uint16_t                        efs_rem_port;
2360         efx_oword_t                     efs_rem_host;
2361         efx_oword_t                     efs_loc_host;
2362 } efx_filter_spec_t;
2363
2364
2365 /* Default values for use in filter specifications */
2366 #define EFX_FILTER_SPEC_RX_DMAQ_ID_DROP         0xfff
2367 #define EFX_FILTER_SPEC_VID_UNSPEC              0xffff
2368
2369 extern  __checkReturn   efx_rc_t
2370 efx_filter_init(
2371         __in            efx_nic_t *enp);
2372
2373 extern                  void
2374 efx_filter_fini(
2375         __in            efx_nic_t *enp);
2376
2377 extern  __checkReturn   efx_rc_t
2378 efx_filter_insert(
2379         __in            efx_nic_t *enp,
2380         __inout         efx_filter_spec_t *spec);
2381
2382 extern  __checkReturn   efx_rc_t
2383 efx_filter_remove(
2384         __in            efx_nic_t *enp,
2385         __inout         efx_filter_spec_t *spec);
2386
2387 extern  __checkReturn   efx_rc_t
2388 efx_filter_restore(
2389         __in            efx_nic_t *enp);
2390
2391 extern  __checkReturn   efx_rc_t
2392 efx_filter_supported_filters(
2393         __in                            efx_nic_t *enp,
2394         __out_ecount(buffer_length)     uint32_t *buffer,
2395         __in                            size_t buffer_length,
2396         __out                           size_t *list_lengthp);
2397
2398 extern                  void
2399 efx_filter_spec_init_rx(
2400         __out           efx_filter_spec_t *spec,
2401         __in            efx_filter_priority_t priority,
2402         __in            efx_filter_flags_t flags,
2403         __in            efx_rxq_t *erp);
2404
2405 extern                  void
2406 efx_filter_spec_init_tx(
2407         __out           efx_filter_spec_t *spec,
2408         __in            efx_txq_t *etp);
2409
2410 extern  __checkReturn   efx_rc_t
2411 efx_filter_spec_set_ipv4_local(
2412         __inout         efx_filter_spec_t *spec,
2413         __in            uint8_t proto,
2414         __in            uint32_t host,
2415         __in            uint16_t port);
2416
2417 extern  __checkReturn   efx_rc_t
2418 efx_filter_spec_set_ipv4_full(
2419         __inout         efx_filter_spec_t *spec,
2420         __in            uint8_t proto,
2421         __in            uint32_t lhost,
2422         __in            uint16_t lport,
2423         __in            uint32_t rhost,
2424         __in            uint16_t rport);
2425
2426 extern  __checkReturn   efx_rc_t
2427 efx_filter_spec_set_eth_local(
2428         __inout         efx_filter_spec_t *spec,
2429         __in            uint16_t vid,
2430         __in            const uint8_t *addr);
2431
2432 extern                  void
2433 efx_filter_spec_set_ether_type(
2434         __inout         efx_filter_spec_t *spec,
2435         __in            uint16_t ether_type);
2436
2437 extern  __checkReturn   efx_rc_t
2438 efx_filter_spec_set_uc_def(
2439         __inout         efx_filter_spec_t *spec);
2440
2441 extern  __checkReturn   efx_rc_t
2442 efx_filter_spec_set_mc_def(
2443         __inout         efx_filter_spec_t *spec);
2444
2445 typedef enum efx_filter_inner_frame_match_e {
2446         EFX_FILTER_INNER_FRAME_MATCH_OTHER = 0,
2447         EFX_FILTER_INNER_FRAME_MATCH_UNKNOWN_MCAST_DST,
2448         EFX_FILTER_INNER_FRAME_MATCH_UNKNOWN_UCAST_DST
2449 } efx_filter_inner_frame_match_t;
2450
2451 extern  __checkReturn   efx_rc_t
2452 efx_filter_spec_set_encap_type(
2453         __inout         efx_filter_spec_t *spec,
2454         __in            efx_tunnel_protocol_t encap_type,
2455         __in            efx_filter_inner_frame_match_t inner_frame_match);
2456
2457 #if EFSYS_OPT_RX_SCALE
2458 extern  __checkReturn   efx_rc_t
2459 efx_filter_spec_set_rss_context(
2460         __inout         efx_filter_spec_t *spec,
2461         __in            uint32_t rss_context);
2462 #endif
2463 #endif  /* EFSYS_OPT_FILTER */
2464
2465 /* HASH */
2466
2467 extern  __checkReturn           uint32_t
2468 efx_hash_dwords(
2469         __in_ecount(count)      uint32_t const *input,
2470         __in                    size_t count,
2471         __in                    uint32_t init);
2472
2473 extern  __checkReturn           uint32_t
2474 efx_hash_bytes(
2475         __in_ecount(length)     uint8_t const *input,
2476         __in                    size_t length,
2477         __in                    uint32_t init);
2478
2479 #if EFSYS_OPT_LICENSING
2480
2481 /* LICENSING */
2482
2483 typedef struct efx_key_stats_s {
2484         uint32_t        eks_valid;
2485         uint32_t        eks_invalid;
2486         uint32_t        eks_blacklisted;
2487         uint32_t        eks_unverifiable;
2488         uint32_t        eks_wrong_node;
2489         uint32_t        eks_licensed_apps_lo;
2490         uint32_t        eks_licensed_apps_hi;
2491         uint32_t        eks_licensed_features_lo;
2492         uint32_t        eks_licensed_features_hi;
2493 } efx_key_stats_t;
2494
2495 extern  __checkReturn           efx_rc_t
2496 efx_lic_init(
2497         __in                    efx_nic_t *enp);
2498
2499 extern                          void
2500 efx_lic_fini(
2501         __in                    efx_nic_t *enp);
2502
2503 extern  __checkReturn   boolean_t
2504 efx_lic_check_support(
2505         __in                    efx_nic_t *enp);
2506
2507 extern  __checkReturn   efx_rc_t
2508 efx_lic_update_licenses(
2509         __in            efx_nic_t *enp);
2510
2511 extern  __checkReturn   efx_rc_t
2512 efx_lic_get_key_stats(
2513         __in            efx_nic_t *enp,
2514         __out           efx_key_stats_t *ksp);
2515
2516 extern  __checkReturn   efx_rc_t
2517 efx_lic_app_state(
2518         __in            efx_nic_t *enp,
2519         __in            uint64_t app_id,
2520         __out           boolean_t *licensedp);
2521
2522 extern  __checkReturn   efx_rc_t
2523 efx_lic_get_id(
2524         __in            efx_nic_t *enp,
2525         __in            size_t buffer_size,
2526         __out           uint32_t *typep,
2527         __out           size_t *lengthp,
2528         __out_opt       uint8_t *bufferp);
2529
2530
2531 extern  __checkReturn           efx_rc_t
2532 efx_lic_find_start(
2533         __in                    efx_nic_t *enp,
2534         __in_bcount(buffer_size)
2535                                 caddr_t bufferp,
2536         __in                    size_t buffer_size,
2537         __out                   uint32_t *startp);
2538
2539 extern  __checkReturn           efx_rc_t
2540 efx_lic_find_end(
2541         __in                    efx_nic_t *enp,
2542         __in_bcount(buffer_size)
2543                                 caddr_t bufferp,
2544         __in                    size_t buffer_size,
2545         __in                    uint32_t offset,
2546         __out                   uint32_t *endp);
2547
2548 extern  __checkReturn   __success(return != B_FALSE)    boolean_t
2549 efx_lic_find_key(
2550         __in                    efx_nic_t *enp,
2551         __in_bcount(buffer_size)
2552                                 caddr_t bufferp,
2553         __in                    size_t buffer_size,
2554         __in                    uint32_t offset,
2555         __out                   uint32_t *startp,
2556         __out                   uint32_t *lengthp);
2557
2558 extern  __checkReturn   __success(return != B_FALSE)    boolean_t
2559 efx_lic_validate_key(
2560         __in                    efx_nic_t *enp,
2561         __in_bcount(length)     caddr_t keyp,
2562         __in                    uint32_t length);
2563
2564 extern  __checkReturn           efx_rc_t
2565 efx_lic_read_key(
2566         __in                    efx_nic_t *enp,
2567         __in_bcount(buffer_size)
2568                                 caddr_t bufferp,
2569         __in                    size_t buffer_size,
2570         __in                    uint32_t offset,
2571         __in                    uint32_t length,
2572         __out_bcount_part(key_max_size, *lengthp)
2573                                 caddr_t keyp,
2574         __in                    size_t key_max_size,
2575         __out                   uint32_t *lengthp);
2576
2577 extern  __checkReturn           efx_rc_t
2578 efx_lic_write_key(
2579         __in                    efx_nic_t *enp,
2580         __in_bcount(buffer_size)
2581                                 caddr_t bufferp,
2582         __in                    size_t buffer_size,
2583         __in                    uint32_t offset,
2584         __in_bcount(length)     caddr_t keyp,
2585         __in                    uint32_t length,
2586         __out                   uint32_t *lengthp);
2587
2588         __checkReturn           efx_rc_t
2589 efx_lic_delete_key(
2590         __in                    efx_nic_t *enp,
2591         __in_bcount(buffer_size)
2592                                 caddr_t bufferp,
2593         __in                    size_t buffer_size,
2594         __in                    uint32_t offset,
2595         __in                    uint32_t length,
2596         __in                    uint32_t end,
2597         __out                   uint32_t *deltap);
2598
2599 extern  __checkReturn           efx_rc_t
2600 efx_lic_create_partition(
2601         __in                    efx_nic_t *enp,
2602         __in_bcount(buffer_size)
2603                                 caddr_t bufferp,
2604         __in                    size_t buffer_size);
2605
2606 extern  __checkReturn           efx_rc_t
2607 efx_lic_finish_partition(
2608         __in                    efx_nic_t *enp,
2609         __in_bcount(buffer_size)
2610                                 caddr_t bufferp,
2611         __in                    size_t buffer_size);
2612
2613 #endif  /* EFSYS_OPT_LICENSING */
2614
2615 /* TUNNEL */
2616
2617 #if EFSYS_OPT_TUNNEL
2618
2619 extern  __checkReturn   efx_rc_t
2620 efx_tunnel_init(
2621         __in            efx_nic_t *enp);
2622
2623 extern                  void
2624 efx_tunnel_fini(
2625         __in            efx_nic_t *enp);
2626
2627 /*
2628  * For overlay network encapsulation using UDP, the firmware needs to know
2629  * the configured UDP port for the overlay so it can decode encapsulated
2630  * frames correctly.
2631  * The UDP port/protocol list is global.
2632  */
2633
2634 extern  __checkReturn   efx_rc_t
2635 efx_tunnel_config_udp_add(
2636         __in            efx_nic_t *enp,
2637         __in            uint16_t port /* host/cpu-endian */,
2638         __in            efx_tunnel_protocol_t protocol);
2639
2640 extern  __checkReturn   efx_rc_t
2641 efx_tunnel_config_udp_remove(
2642         __in            efx_nic_t *enp,
2643         __in            uint16_t port /* host/cpu-endian */,
2644         __in            efx_tunnel_protocol_t protocol);
2645
2646 extern                  void
2647 efx_tunnel_config_clear(
2648         __in            efx_nic_t *enp);
2649
2650 /**
2651  * Apply tunnel UDP ports configuration to hardware.
2652  *
2653  * EAGAIN is returned if hardware will be reset (datapath and managment CPU
2654  * reboot).
2655  */
2656 extern  __checkReturn   efx_rc_t
2657 efx_tunnel_reconfigure(
2658         __in            efx_nic_t *enp);
2659
2660 #endif /* EFSYS_OPT_TUNNEL */
2661
2662
2663 #ifdef  __cplusplus
2664 }
2665 #endif
2666
2667 #endif  /* _SYS_EFX_H */