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