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