1 /* SPDX-License-Identifier: BSD-3-Clause
3 * Copyright(c) 2019-2020 Xilinx, Inc.
4 * Copyright(c) 2006-2019 Solarflare Communications Inc.
10 #include "efx_annote.h"
12 #include "efx_types.h"
13 #include "efx_check.h"
14 #include "efx_phy_ids.h"
20 #define EFX_STATIC_ASSERT(_cond) \
21 ((void)sizeof (char[(_cond) ? 1 : -1]))
23 #define EFX_ARRAY_SIZE(_array) \
24 (sizeof (_array) / sizeof ((_array)[0]))
26 #define EFX_FIELD_OFFSET(_type, _field) \
27 ((size_t)&(((_type *)0)->_field))
29 /* The macro expands divider twice */
30 #define EFX_DIV_ROUND_UP(_n, _d) (((_n) + (_d) - 1) / (_d))
32 /* Round value up to the nearest power of two. */
33 #define EFX_P2ROUNDUP(_type, _value, _align) \
34 (-(-(_type)(_value) & -(_type)(_align)))
36 /* Align value down to the nearest power of two. */
37 #define EFX_P2ALIGN(_type, _value, _align) \
38 ((_type)(_value) & -(_type)(_align))
40 /* Test if value is power of 2 aligned. */
41 #define EFX_IS_P2ALIGNED(_type, _value, _align) \
42 ((((_type)(_value)) & ((_type)(_align) - 1)) == 0)
46 typedef __success(return == 0) int efx_rc_t;
51 typedef enum efx_family_e {
53 EFX_FAMILY_FALCON, /* Obsolete and not supported */
55 EFX_FAMILY_HUNTINGTON,
62 typedef enum efx_bar_type_e {
67 typedef struct efx_bar_region_s {
68 efx_bar_type_t ebr_type;
70 efsys_dma_addr_t ebr_offset;
71 efsys_dma_addr_t ebr_length;
74 /* The function is deprecated. It is used only if Riverhead is not supported. */
76 extern __checkReturn efx_rc_t
80 __out efx_family_t *efp,
81 __out unsigned int *membarp);
85 typedef struct efx_pci_ops_s {
87 * Function for reading PCIe configuration space.
89 * espcp System-specific PCIe device handle;
90 * offset Offset inside PCIe configuration space to start reading
92 * edp EFX DWORD structure that should be populated by function
93 * in little-endian order;
95 * Returns status code, 0 on success, any other value on error.
97 efx_rc_t (*epo_config_readd)(efsys_pci_config_t *espcp,
98 uint32_t offset, efx_dword_t *edp);
100 * Function for finding PCIe memory bar handle by its index from a PCIe
101 * device handle. The found memory bar is available in read-only mode.
103 * configp System-specific PCIe device handle;
104 * index Memory bar index;
105 * memp Pointer to the found memory bar handle;
107 * Returns status code, 0 on success, any other value on error.
109 efx_rc_t (*epo_find_mem_bar)(efsys_pci_config_t *configp,
110 int index, efsys_bar_t *memp);
113 /* Determine EFX family and perform lookup of the function control window
115 * The function requires PCI config handle from which all memory bars can
117 * A user of the API must be aware of memory bars indexes (not available
121 extern __checkReturn efx_rc_t
122 efx_family_probe_bar(
125 __in efsys_pci_config_t *espcp,
126 __in const efx_pci_ops_t *epop,
127 __out efx_family_t *efp,
128 __out efx_bar_region_t *ebrp);
130 #endif /* EFSYS_OPT_PCI */
133 #define EFX_PCI_VENID_SFC 0x1924
134 #define EFX_PCI_VENID_XILINX 0x10EE
136 #define EFX_PCI_DEVID_FALCON 0x0710 /* SFC4000 */
138 #define EFX_PCI_DEVID_BETHPAGE 0x0803 /* SFC9020 */
139 #define EFX_PCI_DEVID_SIENA 0x0813 /* SFL9021 */
140 #define EFX_PCI_DEVID_SIENA_F1_UNINIT 0x0810
142 #define EFX_PCI_DEVID_HUNTINGTON_PF_UNINIT 0x0901
143 #define EFX_PCI_DEVID_FARMINGDALE 0x0903 /* SFC9120 PF */
144 #define EFX_PCI_DEVID_GREENPORT 0x0923 /* SFC9140 PF */
146 #define EFX_PCI_DEVID_FARMINGDALE_VF 0x1903 /* SFC9120 VF */
147 #define EFX_PCI_DEVID_GREENPORT_VF 0x1923 /* SFC9140 VF */
149 #define EFX_PCI_DEVID_MEDFORD_PF_UNINIT 0x0913
150 #define EFX_PCI_DEVID_MEDFORD 0x0A03 /* SFC9240 PF */
151 #define EFX_PCI_DEVID_MEDFORD_VF 0x1A03 /* SFC9240 VF */
153 #define EFX_PCI_DEVID_MEDFORD2_PF_UNINIT 0x0B13
154 #define EFX_PCI_DEVID_MEDFORD2 0x0B03 /* SFC9250 PF */
155 #define EFX_PCI_DEVID_MEDFORD2_VF 0x1B03 /* SFC9250 VF */
157 #define EFX_PCI_DEVID_RIVERHEAD 0x0100
158 #define EFX_PCI_DEVID_RIVERHEAD_VF 0x1100
160 #define EFX_MEM_BAR_SIENA 2
162 #define EFX_MEM_BAR_HUNTINGTON_PF 2
163 #define EFX_MEM_BAR_HUNTINGTON_VF 0
165 #define EFX_MEM_BAR_MEDFORD_PF 2
166 #define EFX_MEM_BAR_MEDFORD_VF 0
168 #define EFX_MEM_BAR_MEDFORD2 0
170 /* FIXME Fix it when memory bar is fixed in FPGA image. It must be 0. */
171 #define EFX_MEM_BAR_RIVERHEAD 2
179 EFX_ERR_BUFID_DC_OOB,
192 /* Calculate the IEEE 802.3 CRC32 of a MAC addr */
194 extern __checkReturn uint32_t
196 __in uint32_t crc_init,
197 __in_ecount(length) uint8_t const *input,
201 /* Type prototypes */
203 typedef struct efx_rxq_s efx_rxq_t;
207 typedef struct efx_nic_s efx_nic_t;
210 extern __checkReturn efx_rc_t
212 __in efx_family_t family,
213 __in efsys_identifier_t *esip,
214 __in efsys_bar_t *esbp,
215 __in uint32_t fcw_offset,
216 __in efsys_lock_t *eslp,
217 __deref_out efx_nic_t **enpp);
219 /* EFX_FW_VARIANT codes map one to one on MC_CMD_FW codes */
220 typedef enum efx_fw_variant_e {
221 EFX_FW_VARIANT_FULL_FEATURED,
222 EFX_FW_VARIANT_LOW_LATENCY,
223 EFX_FW_VARIANT_PACKED_STREAM,
224 EFX_FW_VARIANT_HIGH_TX_RATE,
225 EFX_FW_VARIANT_PACKED_STREAM_HASH_MODE_1,
226 EFX_FW_VARIANT_RULES_ENGINE,
228 EFX_FW_VARIANT_DONT_CARE = 0xffffffff
232 extern __checkReturn efx_rc_t
235 __in efx_fw_variant_t efv);
238 extern __checkReturn efx_rc_t
240 __in efx_nic_t *enp);
243 extern __checkReturn efx_rc_t
245 __in efx_nic_t *enp);
248 extern __checkReturn boolean_t
249 efx_nic_hw_unavailable(
250 __in efx_nic_t *enp);
254 efx_nic_set_hw_unavailable(
255 __in efx_nic_t *enp);
260 extern __checkReturn efx_rc_t
261 efx_nic_register_test(
262 __in efx_nic_t *enp);
264 #endif /* EFSYS_OPT_DIAG */
269 __in efx_nic_t *enp);
274 __in efx_nic_t *enp);
279 __in efx_nic_t *enp);
281 #define EFX_PCIE_LINK_SPEED_GEN1 1
282 #define EFX_PCIE_LINK_SPEED_GEN2 2
283 #define EFX_PCIE_LINK_SPEED_GEN3 3
285 typedef enum efx_pcie_link_performance_e {
286 EFX_PCIE_LINK_PERFORMANCE_UNKNOWN_BANDWIDTH,
287 EFX_PCIE_LINK_PERFORMANCE_SUBOPTIMAL_BANDWIDTH,
288 EFX_PCIE_LINK_PERFORMANCE_SUBOPTIMAL_LATENCY,
289 EFX_PCIE_LINK_PERFORMANCE_OPTIMAL
290 } efx_pcie_link_performance_t;
293 extern __checkReturn efx_rc_t
294 efx_nic_calculate_pcie_link_bandwidth(
295 __in uint32_t pcie_link_width,
296 __in uint32_t pcie_link_gen,
297 __out uint32_t *bandwidth_mbpsp);
300 extern __checkReturn efx_rc_t
301 efx_nic_check_pcie_link_speed(
303 __in uint32_t pcie_link_width,
304 __in uint32_t pcie_link_gen,
305 __out efx_pcie_link_performance_t *resultp);
309 #if EFSYS_OPT_RIVERHEAD || EFX_OPTS_EF10()
310 /* EF10 architecture and Riverhead NICs require MCDIv2 commands */
311 #define WITH_MCDI_V2 1
314 typedef struct efx_mcdi_req_s efx_mcdi_req_t;
316 typedef enum efx_mcdi_exception_e {
317 EFX_MCDI_EXCEPTION_MC_REBOOT,
318 EFX_MCDI_EXCEPTION_MC_BADASSERT,
319 } efx_mcdi_exception_t;
321 #if EFSYS_OPT_MCDI_LOGGING
322 typedef enum efx_log_msg_e {
324 EFX_LOG_MCDI_REQUEST,
325 EFX_LOG_MCDI_RESPONSE,
327 #endif /* EFSYS_OPT_MCDI_LOGGING */
329 typedef struct efx_mcdi_transport_s {
331 efsys_mem_t *emt_dma_mem;
332 void (*emt_execute)(void *, efx_mcdi_req_t *);
333 void (*emt_ev_cpl)(void *);
334 void (*emt_exception)(void *, efx_mcdi_exception_t);
335 #if EFSYS_OPT_MCDI_LOGGING
336 void (*emt_logger)(void *, efx_log_msg_t,
337 void *, size_t, void *, size_t);
338 #endif /* EFSYS_OPT_MCDI_LOGGING */
339 #if EFSYS_OPT_MCDI_PROXY_AUTH
340 void (*emt_ev_proxy_response)(void *, uint32_t, efx_rc_t);
341 #endif /* EFSYS_OPT_MCDI_PROXY_AUTH */
342 #if EFSYS_OPT_MCDI_PROXY_AUTH_SERVER
343 void (*emt_ev_proxy_request)(void *, uint32_t);
344 #endif /* EFSYS_OPT_MCDI_PROXY_AUTH_SERVER */
345 } efx_mcdi_transport_t;
348 extern __checkReturn efx_rc_t
351 __in const efx_mcdi_transport_t *mtp);
354 extern __checkReturn efx_rc_t
356 __in efx_nic_t *enp);
361 __in efx_nic_t *enp);
365 efx_mcdi_get_timeout(
367 __in efx_mcdi_req_t *emrp,
368 __out uint32_t *usec_timeoutp);
372 efx_mcdi_request_start(
374 __in efx_mcdi_req_t *emrp,
375 __in boolean_t ev_cpl);
378 extern __checkReturn boolean_t
379 efx_mcdi_request_poll(
380 __in efx_nic_t *enp);
383 extern __checkReturn boolean_t
384 efx_mcdi_request_abort(
385 __in efx_nic_t *enp);
390 __in efx_nic_t *enp);
392 #endif /* EFSYS_OPT_MCDI */
396 #define EFX_NINTR_SIENA 1024
398 typedef enum efx_intr_type_e {
399 EFX_INTR_INVALID = 0,
405 #define EFX_INTR_SIZE (sizeof (efx_oword_t))
408 extern __checkReturn efx_rc_t
411 __in efx_intr_type_t type,
412 __in_opt efsys_mem_t *esmp);
417 __in efx_nic_t *enp);
422 __in efx_nic_t *enp);
426 efx_intr_disable_unlocked(
427 __in efx_nic_t *enp);
429 #define EFX_INTR_NEVQS 32
432 extern __checkReturn efx_rc_t
435 __in unsigned int level);
439 efx_intr_status_line(
441 __out boolean_t *fatalp,
442 __out uint32_t *maskp);
446 efx_intr_status_message(
448 __in unsigned int message,
449 __out boolean_t *fatalp);
454 __in efx_nic_t *enp);
459 __in efx_nic_t *enp);
463 #if EFSYS_OPT_MAC_STATS
465 /* START MKCONFIG GENERATED EfxHeaderMacBlock ea466a9bc8789994 */
466 typedef enum efx_mac_stat_e {
469 EFX_MAC_RX_UNICST_PKTS,
470 EFX_MAC_RX_MULTICST_PKTS,
471 EFX_MAC_RX_BRDCST_PKTS,
472 EFX_MAC_RX_PAUSE_PKTS,
473 EFX_MAC_RX_LE_64_PKTS,
474 EFX_MAC_RX_65_TO_127_PKTS,
475 EFX_MAC_RX_128_TO_255_PKTS,
476 EFX_MAC_RX_256_TO_511_PKTS,
477 EFX_MAC_RX_512_TO_1023_PKTS,
478 EFX_MAC_RX_1024_TO_15XX_PKTS,
479 EFX_MAC_RX_GE_15XX_PKTS,
481 EFX_MAC_RX_FCS_ERRORS,
482 EFX_MAC_RX_DROP_EVENTS,
483 EFX_MAC_RX_FALSE_CARRIER_ERRORS,
484 EFX_MAC_RX_SYMBOL_ERRORS,
485 EFX_MAC_RX_ALIGN_ERRORS,
486 EFX_MAC_RX_INTERNAL_ERRORS,
487 EFX_MAC_RX_JABBER_PKTS,
488 EFX_MAC_RX_LANE0_CHAR_ERR,
489 EFX_MAC_RX_LANE1_CHAR_ERR,
490 EFX_MAC_RX_LANE2_CHAR_ERR,
491 EFX_MAC_RX_LANE3_CHAR_ERR,
492 EFX_MAC_RX_LANE0_DISP_ERR,
493 EFX_MAC_RX_LANE1_DISP_ERR,
494 EFX_MAC_RX_LANE2_DISP_ERR,
495 EFX_MAC_RX_LANE3_DISP_ERR,
496 EFX_MAC_RX_MATCH_FAULT,
497 EFX_MAC_RX_NODESC_DROP_CNT,
500 EFX_MAC_TX_UNICST_PKTS,
501 EFX_MAC_TX_MULTICST_PKTS,
502 EFX_MAC_TX_BRDCST_PKTS,
503 EFX_MAC_TX_PAUSE_PKTS,
504 EFX_MAC_TX_LE_64_PKTS,
505 EFX_MAC_TX_65_TO_127_PKTS,
506 EFX_MAC_TX_128_TO_255_PKTS,
507 EFX_MAC_TX_256_TO_511_PKTS,
508 EFX_MAC_TX_512_TO_1023_PKTS,
509 EFX_MAC_TX_1024_TO_15XX_PKTS,
510 EFX_MAC_TX_GE_15XX_PKTS,
512 EFX_MAC_TX_SGL_COL_PKTS,
513 EFX_MAC_TX_MULT_COL_PKTS,
514 EFX_MAC_TX_EX_COL_PKTS,
515 EFX_MAC_TX_LATE_COL_PKTS,
517 EFX_MAC_TX_EX_DEF_PKTS,
518 EFX_MAC_PM_TRUNC_BB_OVERFLOW,
519 EFX_MAC_PM_DISCARD_BB_OVERFLOW,
520 EFX_MAC_PM_TRUNC_VFIFO_FULL,
521 EFX_MAC_PM_DISCARD_VFIFO_FULL,
522 EFX_MAC_PM_TRUNC_QBB,
523 EFX_MAC_PM_DISCARD_QBB,
524 EFX_MAC_PM_DISCARD_MAPPING,
525 EFX_MAC_RXDP_Q_DISABLED_PKTS,
526 EFX_MAC_RXDP_DI_DROPPED_PKTS,
527 EFX_MAC_RXDP_STREAMING_PKTS,
528 EFX_MAC_RXDP_HLB_FETCH,
529 EFX_MAC_RXDP_HLB_WAIT,
530 EFX_MAC_VADAPTER_RX_UNICAST_PACKETS,
531 EFX_MAC_VADAPTER_RX_UNICAST_BYTES,
532 EFX_MAC_VADAPTER_RX_MULTICAST_PACKETS,
533 EFX_MAC_VADAPTER_RX_MULTICAST_BYTES,
534 EFX_MAC_VADAPTER_RX_BROADCAST_PACKETS,
535 EFX_MAC_VADAPTER_RX_BROADCAST_BYTES,
536 EFX_MAC_VADAPTER_RX_BAD_PACKETS,
537 EFX_MAC_VADAPTER_RX_BAD_BYTES,
538 EFX_MAC_VADAPTER_RX_OVERFLOW,
539 EFX_MAC_VADAPTER_TX_UNICAST_PACKETS,
540 EFX_MAC_VADAPTER_TX_UNICAST_BYTES,
541 EFX_MAC_VADAPTER_TX_MULTICAST_PACKETS,
542 EFX_MAC_VADAPTER_TX_MULTICAST_BYTES,
543 EFX_MAC_VADAPTER_TX_BROADCAST_PACKETS,
544 EFX_MAC_VADAPTER_TX_BROADCAST_BYTES,
545 EFX_MAC_VADAPTER_TX_BAD_PACKETS,
546 EFX_MAC_VADAPTER_TX_BAD_BYTES,
547 EFX_MAC_VADAPTER_TX_OVERFLOW,
548 EFX_MAC_FEC_UNCORRECTED_ERRORS,
549 EFX_MAC_FEC_CORRECTED_ERRORS,
550 EFX_MAC_FEC_CORRECTED_SYMBOLS_LANE0,
551 EFX_MAC_FEC_CORRECTED_SYMBOLS_LANE1,
552 EFX_MAC_FEC_CORRECTED_SYMBOLS_LANE2,
553 EFX_MAC_FEC_CORRECTED_SYMBOLS_LANE3,
554 EFX_MAC_CTPIO_VI_BUSY_FALLBACK,
555 EFX_MAC_CTPIO_LONG_WRITE_SUCCESS,
556 EFX_MAC_CTPIO_MISSING_DBELL_FAIL,
557 EFX_MAC_CTPIO_OVERFLOW_FAIL,
558 EFX_MAC_CTPIO_UNDERFLOW_FAIL,
559 EFX_MAC_CTPIO_TIMEOUT_FAIL,
560 EFX_MAC_CTPIO_NONCONTIG_WR_FAIL,
561 EFX_MAC_CTPIO_FRM_CLOBBER_FAIL,
562 EFX_MAC_CTPIO_INVALID_WR_FAIL,
563 EFX_MAC_CTPIO_VI_CLOBBER_FALLBACK,
564 EFX_MAC_CTPIO_UNQUALIFIED_FALLBACK,
565 EFX_MAC_CTPIO_RUNT_FALLBACK,
566 EFX_MAC_CTPIO_SUCCESS,
567 EFX_MAC_CTPIO_FALLBACK,
568 EFX_MAC_CTPIO_POISON,
570 EFX_MAC_RXDP_SCATTER_DISABLED_TRUNC,
571 EFX_MAC_RXDP_HLB_IDLE,
572 EFX_MAC_RXDP_HLB_TIMEOUT,
576 /* END MKCONFIG GENERATED EfxHeaderMacBlock */
578 #endif /* EFSYS_OPT_MAC_STATS */
580 typedef enum efx_link_mode_e {
581 EFX_LINK_UNKNOWN = 0,
597 #define EFX_MAC_ADDR_LEN 6
599 #define EFX_VNI_OR_VSID_LEN 3
601 #define EFX_MAC_ADDR_IS_MULTICAST(_address) (((uint8_t *)_address)[0] & 0x01)
603 #define EFX_MAC_MULTICAST_LIST_MAX 256
605 #define EFX_MAC_SDU_MAX 9202
607 #define EFX_MAC_PDU_ADJUSTMENT \
611 + /* bug16011 */ 16) \
613 #define EFX_MAC_PDU(_sdu) \
614 EFX_P2ROUNDUP(size_t, (_sdu) + EFX_MAC_PDU_ADJUSTMENT, 8)
617 * Due to the EFX_P2ROUNDUP in EFX_MAC_PDU(), EFX_MAC_SDU_FROM_PDU() may give
618 * the SDU rounded up slightly.
620 #define EFX_MAC_SDU_FROM_PDU(_pdu) ((_pdu) - EFX_MAC_PDU_ADJUSTMENT)
622 #define EFX_MAC_PDU_MIN 60
623 #define EFX_MAC_PDU_MAX EFX_MAC_PDU(EFX_MAC_SDU_MAX)
626 extern __checkReturn efx_rc_t
632 extern __checkReturn efx_rc_t
638 extern __checkReturn efx_rc_t
644 extern __checkReturn efx_rc_t
647 __in boolean_t all_unicst,
648 __in boolean_t mulcst,
649 __in boolean_t all_mulcst,
650 __in boolean_t brdcst);
654 efx_mac_filter_get_all_ucast_mcast(
656 __out boolean_t *all_unicst,
657 __out boolean_t *all_mulcst);
660 extern __checkReturn efx_rc_t
661 efx_mac_multicast_list_set(
663 __in_ecount(6*count) uint8_t const *addrs,
667 extern __checkReturn efx_rc_t
668 efx_mac_filter_default_rxq_set(
671 __in boolean_t using_rss);
675 efx_mac_filter_default_rxq_clear(
676 __in efx_nic_t *enp);
679 extern __checkReturn efx_rc_t
682 __in boolean_t enabled);
685 extern __checkReturn efx_rc_t
688 __out boolean_t *mac_upp);
690 #define EFX_FCNTL_RESPOND 0x00000001
691 #define EFX_FCNTL_GENERATE 0x00000002
694 extern __checkReturn efx_rc_t
697 __in unsigned int fcntl,
698 __in boolean_t autoneg);
704 __out unsigned int *fcntl_wantedp,
705 __out unsigned int *fcntl_linkp);
708 #if EFSYS_OPT_MAC_STATS
713 extern __checkReturn const char *
716 __in unsigned int id);
718 #endif /* EFSYS_OPT_NAMES */
720 #define EFX_MAC_STATS_MASK_BITS_PER_PAGE (8 * sizeof (uint32_t))
722 #define EFX_MAC_STATS_MASK_NPAGES \
723 (EFX_P2ROUNDUP(uint32_t, EFX_MAC_NSTATS, \
724 EFX_MAC_STATS_MASK_BITS_PER_PAGE) / \
725 EFX_MAC_STATS_MASK_BITS_PER_PAGE)
728 * Get mask of MAC statistics supported by the hardware.
730 * If mask_size is insufficient to return the mask, EINVAL error is
731 * returned. EFX_MAC_STATS_MASK_NPAGES multiplied by size of the page
732 * (which is sizeof (uint32_t)) is sufficient.
735 extern __checkReturn efx_rc_t
736 efx_mac_stats_get_mask(
738 __out_bcount(mask_size) uint32_t *maskp,
739 __in size_t mask_size);
741 #define EFX_MAC_STAT_SUPPORTED(_mask, _stat) \
742 ((_mask)[(_stat) / EFX_MAC_STATS_MASK_BITS_PER_PAGE] & \
743 (1ULL << ((_stat) & (EFX_MAC_STATS_MASK_BITS_PER_PAGE - 1))))
747 extern __checkReturn efx_rc_t
749 __in efx_nic_t *enp);
752 * Upload mac statistics supported by the hardware into the given buffer.
754 * The DMA buffer must be 4Kbyte aligned and sized to hold at least
755 * efx_nic_cfg_t::enc_mac_stats_nstats 64bit counters.
757 * The hardware will only DMA statistics that it understands (of course).
758 * Drivers should not make any assumptions about which statistics are
759 * supported, especially when the statistics are generated by firmware.
761 * Thus, drivers should zero this buffer before use, so that not-understood
762 * statistics read back as zero.
765 extern __checkReturn efx_rc_t
766 efx_mac_stats_upload(
768 __in efsys_mem_t *esmp);
771 extern __checkReturn efx_rc_t
772 efx_mac_stats_periodic(
774 __in efsys_mem_t *esmp,
775 __in uint16_t period_ms,
776 __in boolean_t events);
779 extern __checkReturn efx_rc_t
780 efx_mac_stats_update(
782 __in efsys_mem_t *esmp,
783 __inout_ecount(EFX_MAC_NSTATS) efsys_stat_t *stat,
784 __inout_opt uint32_t *generationp);
786 #endif /* EFSYS_OPT_MAC_STATS */
790 typedef enum efx_mon_type_e {
803 __in efx_nic_t *enp);
805 #endif /* EFSYS_OPT_NAMES */
808 extern __checkReturn efx_rc_t
810 __in efx_nic_t *enp);
812 #if EFSYS_OPT_MON_STATS
814 #define EFX_MON_STATS_PAGE_SIZE 0x100
815 #define EFX_MON_MASK_ELEMENT_SIZE 32
817 /* START MKCONFIG GENERATED MonitorHeaderStatsBlock 78b65c8d5af9747b */
818 typedef enum efx_mon_stat_e {
819 EFX_MON_STAT_CONTROLLER_TEMP,
820 EFX_MON_STAT_PHY_COMMON_TEMP,
821 EFX_MON_STAT_CONTROLLER_COOLING,
822 EFX_MON_STAT_PHY0_TEMP,
823 EFX_MON_STAT_PHY0_COOLING,
824 EFX_MON_STAT_PHY1_TEMP,
825 EFX_MON_STAT_PHY1_COOLING,
831 EFX_MON_STAT_IN_12V0,
832 EFX_MON_STAT_IN_1V2A,
833 EFX_MON_STAT_IN_VREF,
834 EFX_MON_STAT_OUT_VAOE,
835 EFX_MON_STAT_AOE_TEMP,
836 EFX_MON_STAT_PSU_AOE_TEMP,
837 EFX_MON_STAT_PSU_TEMP,
843 EFX_MON_STAT_IN_VAOE,
844 EFX_MON_STAT_OUT_IAOE,
845 EFX_MON_STAT_IN_IAOE,
846 EFX_MON_STAT_NIC_POWER,
848 EFX_MON_STAT_IN_I0V9,
849 EFX_MON_STAT_IN_I1V2,
850 EFX_MON_STAT_IN_0V9_ADC,
851 EFX_MON_STAT_CONTROLLER_2_TEMP,
852 EFX_MON_STAT_VREG_INTERNAL_TEMP,
853 EFX_MON_STAT_VREG_0V9_TEMP,
854 EFX_MON_STAT_VREG_1V2_TEMP,
855 EFX_MON_STAT_CONTROLLER_VPTAT,
856 EFX_MON_STAT_CONTROLLER_INTERNAL_TEMP,
857 EFX_MON_STAT_CONTROLLER_VPTAT_EXTADC,
858 EFX_MON_STAT_CONTROLLER_INTERNAL_TEMP_EXTADC,
859 EFX_MON_STAT_AMBIENT_TEMP,
860 EFX_MON_STAT_AIRFLOW,
861 EFX_MON_STAT_VDD08D_VSS08D_CSR,
862 EFX_MON_STAT_VDD08D_VSS08D_CSR_EXTADC,
863 EFX_MON_STAT_HOTPOINT_TEMP,
864 EFX_MON_STAT_PHY_POWER_PORT0,
865 EFX_MON_STAT_PHY_POWER_PORT1,
866 EFX_MON_STAT_MUM_VCC,
867 EFX_MON_STAT_IN_0V9_A,
868 EFX_MON_STAT_IN_I0V9_A,
869 EFX_MON_STAT_VREG_0V9_A_TEMP,
870 EFX_MON_STAT_IN_0V9_B,
871 EFX_MON_STAT_IN_I0V9_B,
872 EFX_MON_STAT_VREG_0V9_B_TEMP,
873 EFX_MON_STAT_CCOM_AVREG_1V2_SUPPLY,
874 EFX_MON_STAT_CCOM_AVREG_1V2_SUPPLY_EXTADC,
875 EFX_MON_STAT_CCOM_AVREG_1V8_SUPPLY,
876 EFX_MON_STAT_CCOM_AVREG_1V8_SUPPLY_EXTADC,
877 EFX_MON_STAT_CONTROLLER_MASTER_VPTAT,
878 EFX_MON_STAT_CONTROLLER_MASTER_INTERNAL_TEMP,
879 EFX_MON_STAT_CONTROLLER_MASTER_VPTAT_EXTADC,
880 EFX_MON_STAT_CONTROLLER_MASTER_INTERNAL_TEMP_EXTADC,
881 EFX_MON_STAT_CONTROLLER_SLAVE_VPTAT,
882 EFX_MON_STAT_CONTROLLER_SLAVE_INTERNAL_TEMP,
883 EFX_MON_STAT_CONTROLLER_SLAVE_VPTAT_EXTADC,
884 EFX_MON_STAT_CONTROLLER_SLAVE_INTERNAL_TEMP_EXTADC,
885 EFX_MON_STAT_SODIMM_VOUT,
886 EFX_MON_STAT_SODIMM_0_TEMP,
887 EFX_MON_STAT_SODIMM_1_TEMP,
888 EFX_MON_STAT_PHY0_VCC,
889 EFX_MON_STAT_PHY1_VCC,
890 EFX_MON_STAT_CONTROLLER_TDIODE_TEMP,
891 EFX_MON_STAT_BOARD_FRONT_TEMP,
892 EFX_MON_STAT_BOARD_BACK_TEMP,
893 EFX_MON_STAT_IN_I1V8,
894 EFX_MON_STAT_IN_I2V5,
895 EFX_MON_STAT_IN_I3V3,
896 EFX_MON_STAT_IN_I12V0,
898 EFX_MON_STAT_IN_I1V3,
902 /* END MKCONFIG GENERATED MonitorHeaderStatsBlock */
904 typedef enum efx_mon_stat_state_e {
905 EFX_MON_STAT_STATE_OK = 0,
906 EFX_MON_STAT_STATE_WARNING = 1,
907 EFX_MON_STAT_STATE_FATAL = 2,
908 EFX_MON_STAT_STATE_BROKEN = 3,
909 EFX_MON_STAT_STATE_NO_READING = 4,
910 } efx_mon_stat_state_t;
912 typedef enum efx_mon_stat_unit_e {
913 EFX_MON_STAT_UNIT_UNKNOWN = 0,
914 EFX_MON_STAT_UNIT_BOOL,
915 EFX_MON_STAT_UNIT_TEMP_C,
916 EFX_MON_STAT_UNIT_VOLTAGE_MV,
917 EFX_MON_STAT_UNIT_CURRENT_MA,
918 EFX_MON_STAT_UNIT_POWER_W,
919 EFX_MON_STAT_UNIT_RPM,
921 } efx_mon_stat_unit_t;
923 typedef struct efx_mon_stat_value_s {
925 efx_mon_stat_state_t emsv_state;
926 efx_mon_stat_unit_t emsv_unit;
927 } efx_mon_stat_value_t;
929 typedef struct efx_mon_limit_value_s {
930 uint16_t emlv_warning_min;
931 uint16_t emlv_warning_max;
932 uint16_t emlv_fatal_min;
933 uint16_t emlv_fatal_max;
934 } efx_mon_stat_limits_t;
936 typedef enum efx_mon_stat_portmask_e {
937 EFX_MON_STAT_PORTMAP_NONE = 0,
938 EFX_MON_STAT_PORTMAP_PORT0 = 1,
939 EFX_MON_STAT_PORTMAP_PORT1 = 2,
940 EFX_MON_STAT_PORTMAP_PORT2 = 3,
941 EFX_MON_STAT_PORTMAP_PORT3 = 4,
942 EFX_MON_STAT_PORTMAP_ALL = (-1),
943 EFX_MON_STAT_PORTMAP_UNKNOWN = (-2)
944 } efx_mon_stat_portmask_t;
952 __in efx_mon_stat_t id);
956 efx_mon_stat_description(
958 __in efx_mon_stat_t id);
960 #endif /* EFSYS_OPT_NAMES */
963 extern __checkReturn boolean_t
964 efx_mon_mcdi_to_efx_stat(
966 __out efx_mon_stat_t *statp);
969 extern __checkReturn boolean_t
970 efx_mon_get_stat_unit(
971 __in efx_mon_stat_t stat,
972 __out efx_mon_stat_unit_t *unitp);
975 extern __checkReturn boolean_t
976 efx_mon_get_stat_portmap(
977 __in efx_mon_stat_t stat,
978 __out efx_mon_stat_portmask_t *maskp);
981 extern __checkReturn efx_rc_t
982 efx_mon_stats_update(
984 __in efsys_mem_t *esmp,
985 __inout_ecount(EFX_MON_NSTATS) efx_mon_stat_value_t *values);
988 extern __checkReturn efx_rc_t
989 efx_mon_limits_update(
991 __inout_ecount(EFX_MON_NSTATS) efx_mon_stat_limits_t *values);
993 #endif /* EFSYS_OPT_MON_STATS */
998 __in efx_nic_t *enp);
1003 extern __checkReturn efx_rc_t
1005 __in efx_nic_t *enp);
1007 typedef enum efx_phy_led_mode_e {
1008 EFX_PHY_LED_DEFAULT = 0,
1013 } efx_phy_led_mode_t;
1015 #if EFSYS_OPT_PHY_LED_CONTROL
1018 extern __checkReturn efx_rc_t
1020 __in efx_nic_t *enp,
1021 __in efx_phy_led_mode_t mode);
1023 #endif /* EFSYS_OPT_PHY_LED_CONTROL */
1026 extern __checkReturn efx_rc_t
1028 __in efx_nic_t *enp);
1030 #if EFSYS_OPT_LOOPBACK
1032 typedef enum efx_loopback_type_e {
1033 EFX_LOOPBACK_OFF = 0,
1034 EFX_LOOPBACK_DATA = 1,
1035 EFX_LOOPBACK_GMAC = 2,
1036 EFX_LOOPBACK_XGMII = 3,
1037 EFX_LOOPBACK_XGXS = 4,
1038 EFX_LOOPBACK_XAUI = 5,
1039 EFX_LOOPBACK_GMII = 6,
1040 EFX_LOOPBACK_SGMII = 7,
1041 EFX_LOOPBACK_XGBR = 8,
1042 EFX_LOOPBACK_XFI = 9,
1043 EFX_LOOPBACK_XAUI_FAR = 10,
1044 EFX_LOOPBACK_GMII_FAR = 11,
1045 EFX_LOOPBACK_SGMII_FAR = 12,
1046 EFX_LOOPBACK_XFI_FAR = 13,
1047 EFX_LOOPBACK_GPHY = 14,
1048 EFX_LOOPBACK_PHY_XS = 15,
1049 EFX_LOOPBACK_PCS = 16,
1050 EFX_LOOPBACK_PMA_PMD = 17,
1051 EFX_LOOPBACK_XPORT = 18,
1052 EFX_LOOPBACK_XGMII_WS = 19,
1053 EFX_LOOPBACK_XAUI_WS = 20,
1054 EFX_LOOPBACK_XAUI_WS_FAR = 21,
1055 EFX_LOOPBACK_XAUI_WS_NEAR = 22,
1056 EFX_LOOPBACK_GMII_WS = 23,
1057 EFX_LOOPBACK_XFI_WS = 24,
1058 EFX_LOOPBACK_XFI_WS_FAR = 25,
1059 EFX_LOOPBACK_PHYXS_WS = 26,
1060 EFX_LOOPBACK_PMA_INT = 27,
1061 EFX_LOOPBACK_SD_NEAR = 28,
1062 EFX_LOOPBACK_SD_FAR = 29,
1063 EFX_LOOPBACK_PMA_INT_WS = 30,
1064 EFX_LOOPBACK_SD_FEP2_WS = 31,
1065 EFX_LOOPBACK_SD_FEP1_5_WS = 32,
1066 EFX_LOOPBACK_SD_FEP_WS = 33,
1067 EFX_LOOPBACK_SD_FES_WS = 34,
1068 EFX_LOOPBACK_AOE_INT_NEAR = 35,
1069 EFX_LOOPBACK_DATA_WS = 36,
1070 EFX_LOOPBACK_FORCE_EXT_LINK = 37,
1072 } efx_loopback_type_t;
1074 typedef enum efx_loopback_kind_e {
1075 EFX_LOOPBACK_KIND_OFF = 0,
1076 EFX_LOOPBACK_KIND_ALL,
1077 EFX_LOOPBACK_KIND_MAC,
1078 EFX_LOOPBACK_KIND_PHY,
1080 } efx_loopback_kind_t;
1085 __in efx_loopback_kind_t loopback_kind,
1086 __out efx_qword_t *maskp);
1089 extern __checkReturn efx_rc_t
1090 efx_port_loopback_set(
1091 __in efx_nic_t *enp,
1092 __in efx_link_mode_t link_mode,
1093 __in efx_loopback_type_t type);
1098 extern __checkReturn const char *
1099 efx_loopback_type_name(
1100 __in efx_nic_t *enp,
1101 __in efx_loopback_type_t type);
1103 #endif /* EFSYS_OPT_NAMES */
1105 #endif /* EFSYS_OPT_LOOPBACK */
1108 extern __checkReturn efx_rc_t
1110 __in efx_nic_t *enp,
1111 __out_opt efx_link_mode_t *link_modep);
1116 __in efx_nic_t *enp);
1118 typedef enum efx_phy_cap_type_e {
1119 EFX_PHY_CAP_INVALID = 0,
1124 EFX_PHY_CAP_1000HDX,
1125 EFX_PHY_CAP_1000FDX,
1126 EFX_PHY_CAP_10000FDX,
1130 EFX_PHY_CAP_40000FDX,
1132 EFX_PHY_CAP_100000FDX,
1133 EFX_PHY_CAP_25000FDX,
1134 EFX_PHY_CAP_50000FDX,
1135 EFX_PHY_CAP_BASER_FEC,
1136 EFX_PHY_CAP_BASER_FEC_REQUESTED,
1138 EFX_PHY_CAP_RS_FEC_REQUESTED,
1139 EFX_PHY_CAP_25G_BASER_FEC,
1140 EFX_PHY_CAP_25G_BASER_FEC_REQUESTED,
1142 } efx_phy_cap_type_t;
1145 #define EFX_PHY_CAP_CURRENT 0x00000000
1146 #define EFX_PHY_CAP_DEFAULT 0x00000001
1147 #define EFX_PHY_CAP_PERM 0x00000002
1151 efx_phy_adv_cap_get(
1152 __in efx_nic_t *enp,
1154 __out uint32_t *maskp);
1157 extern __checkReturn efx_rc_t
1158 efx_phy_adv_cap_set(
1159 __in efx_nic_t *enp,
1160 __in uint32_t mask);
1165 __in efx_nic_t *enp,
1166 __out uint32_t *maskp);
1169 extern __checkReturn efx_rc_t
1171 __in efx_nic_t *enp,
1172 __out uint32_t *ouip);
1174 typedef enum efx_phy_media_type_e {
1175 EFX_PHY_MEDIA_INVALID = 0,
1180 EFX_PHY_MEDIA_SFP_PLUS,
1181 EFX_PHY_MEDIA_BASE_T,
1182 EFX_PHY_MEDIA_QSFP_PLUS,
1183 EFX_PHY_MEDIA_NTYPES
1184 } efx_phy_media_type_t;
1187 * Get the type of medium currently used. If the board has ports for
1188 * modules, a module is present, and we recognise the media type of
1189 * the module, then this will be the media type of the module.
1190 * Otherwise it will be the media type of the port.
1194 efx_phy_media_type_get(
1195 __in efx_nic_t *enp,
1196 __out efx_phy_media_type_t *typep);
1199 * 2-wire device address of the base information in accordance with SFF-8472
1200 * Diagnostic Monitoring Interface for Optical Transceivers section
1201 * 4 Memory Organization.
1203 #define EFX_PHY_MEDIA_INFO_DEV_ADDR_SFP_BASE 0xA0
1206 * 2-wire device address of the digital diagnostics monitoring interface
1207 * in accordance with SFF-8472 Diagnostic Monitoring Interface for Optical
1208 * Transceivers section 4 Memory Organization.
1210 #define EFX_PHY_MEDIA_INFO_DEV_ADDR_SFP_DDM 0xA2
1213 * Hard wired 2-wire device address for QSFP+ in accordance with SFF-8436
1214 * QSFP+ 10 Gbs 4X PLUGGABLE TRANSCEIVER section 7.4 Device Addressing and
1217 #define EFX_PHY_MEDIA_INFO_DEV_ADDR_QSFP 0xA0
1220 * Maximum accessible data offset for PHY module information.
1222 #define EFX_PHY_MEDIA_INFO_MAX_OFFSET 0x100
1226 extern __checkReturn efx_rc_t
1227 efx_phy_module_get_info(
1228 __in efx_nic_t *enp,
1229 __in uint8_t dev_addr,
1232 __out_bcount(len) uint8_t *data);
1234 #if EFSYS_OPT_PHY_STATS
1236 /* START MKCONFIG GENERATED PhyHeaderStatsBlock 30ed56ad501f8e36 */
1237 typedef enum efx_phy_stat_e {
1239 EFX_PHY_STAT_PMA_PMD_LINK_UP,
1240 EFX_PHY_STAT_PMA_PMD_RX_FAULT,
1241 EFX_PHY_STAT_PMA_PMD_TX_FAULT,
1242 EFX_PHY_STAT_PMA_PMD_REV_A,
1243 EFX_PHY_STAT_PMA_PMD_REV_B,
1244 EFX_PHY_STAT_PMA_PMD_REV_C,
1245 EFX_PHY_STAT_PMA_PMD_REV_D,
1246 EFX_PHY_STAT_PCS_LINK_UP,
1247 EFX_PHY_STAT_PCS_RX_FAULT,
1248 EFX_PHY_STAT_PCS_TX_FAULT,
1249 EFX_PHY_STAT_PCS_BER,
1250 EFX_PHY_STAT_PCS_BLOCK_ERRORS,
1251 EFX_PHY_STAT_PHY_XS_LINK_UP,
1252 EFX_PHY_STAT_PHY_XS_RX_FAULT,
1253 EFX_PHY_STAT_PHY_XS_TX_FAULT,
1254 EFX_PHY_STAT_PHY_XS_ALIGN,
1255 EFX_PHY_STAT_PHY_XS_SYNC_A,
1256 EFX_PHY_STAT_PHY_XS_SYNC_B,
1257 EFX_PHY_STAT_PHY_XS_SYNC_C,
1258 EFX_PHY_STAT_PHY_XS_SYNC_D,
1259 EFX_PHY_STAT_AN_LINK_UP,
1260 EFX_PHY_STAT_AN_MASTER,
1261 EFX_PHY_STAT_AN_LOCAL_RX_OK,
1262 EFX_PHY_STAT_AN_REMOTE_RX_OK,
1263 EFX_PHY_STAT_CL22EXT_LINK_UP,
1268 EFX_PHY_STAT_PMA_PMD_SIGNAL_A,
1269 EFX_PHY_STAT_PMA_PMD_SIGNAL_B,
1270 EFX_PHY_STAT_PMA_PMD_SIGNAL_C,
1271 EFX_PHY_STAT_PMA_PMD_SIGNAL_D,
1272 EFX_PHY_STAT_AN_COMPLETE,
1273 EFX_PHY_STAT_PMA_PMD_REV_MAJOR,
1274 EFX_PHY_STAT_PMA_PMD_REV_MINOR,
1275 EFX_PHY_STAT_PMA_PMD_REV_MICRO,
1276 EFX_PHY_STAT_PCS_FW_VERSION_0,
1277 EFX_PHY_STAT_PCS_FW_VERSION_1,
1278 EFX_PHY_STAT_PCS_FW_VERSION_2,
1279 EFX_PHY_STAT_PCS_FW_VERSION_3,
1280 EFX_PHY_STAT_PCS_FW_BUILD_YY,
1281 EFX_PHY_STAT_PCS_FW_BUILD_MM,
1282 EFX_PHY_STAT_PCS_FW_BUILD_DD,
1283 EFX_PHY_STAT_PCS_OP_MODE,
1287 /* END MKCONFIG GENERATED PhyHeaderStatsBlock */
1294 __in efx_nic_t *enp,
1295 __in efx_phy_stat_t stat);
1297 #endif /* EFSYS_OPT_NAMES */
1299 #define EFX_PHY_STATS_SIZE 0x100
1302 extern __checkReturn efx_rc_t
1303 efx_phy_stats_update(
1304 __in efx_nic_t *enp,
1305 __in efsys_mem_t *esmp,
1306 __inout_ecount(EFX_PHY_NSTATS) uint32_t *stat);
1308 #endif /* EFSYS_OPT_PHY_STATS */
1313 typedef enum efx_bist_type_e {
1314 EFX_BIST_TYPE_UNKNOWN,
1315 EFX_BIST_TYPE_PHY_NORMAL,
1316 EFX_BIST_TYPE_PHY_CABLE_SHORT,
1317 EFX_BIST_TYPE_PHY_CABLE_LONG,
1318 EFX_BIST_TYPE_MC_MEM, /* Test the MC DMEM and IMEM */
1319 EFX_BIST_TYPE_SAT_MEM, /* Test the DMEM and IMEM of satellite cpus */
1320 EFX_BIST_TYPE_REG, /* Test the register memories */
1321 EFX_BIST_TYPE_NTYPES,
1324 typedef enum efx_bist_result_e {
1325 EFX_BIST_RESULT_UNKNOWN,
1326 EFX_BIST_RESULT_RUNNING,
1327 EFX_BIST_RESULT_PASSED,
1328 EFX_BIST_RESULT_FAILED,
1329 } efx_bist_result_t;
1331 typedef enum efx_phy_cable_status_e {
1332 EFX_PHY_CABLE_STATUS_OK,
1333 EFX_PHY_CABLE_STATUS_INVALID,
1334 EFX_PHY_CABLE_STATUS_OPEN,
1335 EFX_PHY_CABLE_STATUS_INTRAPAIRSHORT,
1336 EFX_PHY_CABLE_STATUS_INTERPAIRSHORT,
1337 EFX_PHY_CABLE_STATUS_BUSY,
1338 } efx_phy_cable_status_t;
1340 typedef enum efx_bist_value_e {
1341 EFX_BIST_PHY_CABLE_LENGTH_A,
1342 EFX_BIST_PHY_CABLE_LENGTH_B,
1343 EFX_BIST_PHY_CABLE_LENGTH_C,
1344 EFX_BIST_PHY_CABLE_LENGTH_D,
1345 EFX_BIST_PHY_CABLE_STATUS_A,
1346 EFX_BIST_PHY_CABLE_STATUS_B,
1347 EFX_BIST_PHY_CABLE_STATUS_C,
1348 EFX_BIST_PHY_CABLE_STATUS_D,
1349 EFX_BIST_FAULT_CODE,
1351 * Memory BIST specific values. These match to the MC_CMD_BIST_POLL
1357 EFX_BIST_MEM_EXPECT,
1358 EFX_BIST_MEM_ACTUAL,
1360 EFX_BIST_MEM_ECC_PARITY,
1361 EFX_BIST_MEM_ECC_FATAL,
1366 extern __checkReturn efx_rc_t
1367 efx_bist_enable_offline(
1368 __in efx_nic_t *enp);
1371 extern __checkReturn efx_rc_t
1373 __in efx_nic_t *enp,
1374 __in efx_bist_type_t type);
1377 extern __checkReturn efx_rc_t
1379 __in efx_nic_t *enp,
1380 __in efx_bist_type_t type,
1381 __out efx_bist_result_t *resultp,
1382 __out_opt uint32_t *value_maskp,
1383 __out_ecount_opt(count) unsigned long *valuesp,
1389 __in efx_nic_t *enp,
1390 __in efx_bist_type_t type);
1392 #endif /* EFSYS_OPT_BIST */
1394 #define EFX_FEATURE_IPV6 0x00000001
1395 #define EFX_FEATURE_LFSR_HASH_INSERT 0x00000002
1396 #define EFX_FEATURE_LINK_EVENTS 0x00000004
1397 #define EFX_FEATURE_PERIODIC_MAC_STATS 0x00000008
1398 #define EFX_FEATURE_MCDI 0x00000020
1399 #define EFX_FEATURE_LOOKAHEAD_SPLIT 0x00000040
1400 #define EFX_FEATURE_MAC_HEADER_FILTERS 0x00000080
1401 #define EFX_FEATURE_TURBO 0x00000100
1402 #define EFX_FEATURE_MCDI_DMA 0x00000200
1403 #define EFX_FEATURE_TX_SRC_FILTERS 0x00000400
1404 #define EFX_FEATURE_PIO_BUFFERS 0x00000800
1405 #define EFX_FEATURE_FW_ASSISTED_TSO 0x00001000
1406 #define EFX_FEATURE_FW_ASSISTED_TSO_V2 0x00002000
1407 #define EFX_FEATURE_PACKED_STREAM 0x00004000
1408 #define EFX_FEATURE_TXQ_CKSUM_OP_DESC 0x00008000
1410 typedef enum efx_tunnel_protocol_e {
1411 EFX_TUNNEL_PROTOCOL_NONE = 0,
1412 EFX_TUNNEL_PROTOCOL_VXLAN,
1413 EFX_TUNNEL_PROTOCOL_GENEVE,
1414 EFX_TUNNEL_PROTOCOL_NVGRE,
1416 } efx_tunnel_protocol_t;
1418 typedef enum efx_vi_window_shift_e {
1419 EFX_VI_WINDOW_SHIFT_INVALID = 0,
1420 EFX_VI_WINDOW_SHIFT_8K = 13,
1421 EFX_VI_WINDOW_SHIFT_16K = 14,
1422 EFX_VI_WINDOW_SHIFT_64K = 16,
1423 } efx_vi_window_shift_t;
1425 typedef struct efx_nic_cfg_s {
1426 uint32_t enc_board_type;
1427 uint32_t enc_phy_type;
1429 char enc_phy_name[21];
1431 char enc_phy_revision[21];
1432 efx_mon_type_t enc_mon_type;
1433 #if EFSYS_OPT_MON_STATS
1434 uint32_t enc_mon_stat_dma_buf_size;
1435 uint32_t enc_mon_stat_mask[(EFX_MON_NSTATS + 31) / 32];
1437 unsigned int enc_features;
1438 efx_vi_window_shift_t enc_vi_window_shift;
1439 uint8_t enc_mac_addr[6];
1440 uint8_t enc_port; /* PHY port number */
1441 uint32_t enc_intr_vec_base;
1442 uint32_t enc_intr_limit;
1443 uint32_t enc_evq_limit;
1444 uint32_t enc_txq_limit;
1445 uint32_t enc_rxq_limit;
1446 uint32_t enc_evq_max_nevs;
1447 uint32_t enc_evq_min_nevs;
1448 uint32_t enc_rxq_max_ndescs;
1449 uint32_t enc_rxq_min_ndescs;
1450 uint32_t enc_txq_max_ndescs;
1451 uint32_t enc_txq_min_ndescs;
1452 uint32_t enc_buftbl_limit;
1453 uint32_t enc_piobuf_limit;
1454 uint32_t enc_piobuf_size;
1455 uint32_t enc_piobuf_min_alloc_size;
1456 uint32_t enc_evq_timer_quantum_ns;
1457 uint32_t enc_evq_timer_max_us;
1458 uint32_t enc_clk_mult;
1459 uint32_t enc_ev_ew_desc_size;
1460 uint32_t enc_ev_desc_size;
1461 uint32_t enc_rx_desc_size;
1462 uint32_t enc_tx_desc_size;
1463 /* Maximum Rx prefix size if many Rx prefixes are supported */
1464 uint32_t enc_rx_prefix_size;
1465 uint32_t enc_rx_buf_align_start;
1466 uint32_t enc_rx_buf_align_end;
1467 #if EFSYS_OPT_RX_SCALE
1468 uint32_t enc_rx_scale_max_exclusive_contexts;
1470 * Mask of supported hash algorithms.
1471 * Hash algorithm types are used as the bit indices.
1473 uint32_t enc_rx_scale_hash_alg_mask;
1475 * Indicates whether port numbers can be included to the
1476 * input data for hash computation.
1478 boolean_t enc_rx_scale_l4_hash_supported;
1479 boolean_t enc_rx_scale_additional_modes_supported;
1480 #endif /* EFSYS_OPT_RX_SCALE */
1481 #if EFSYS_OPT_LOOPBACK
1482 efx_qword_t enc_loopback_types[EFX_LINK_NMODES];
1483 #endif /* EFSYS_OPT_LOOPBACK */
1484 #if EFSYS_OPT_PHY_FLAGS
1485 uint32_t enc_phy_flags_mask;
1486 #endif /* EFSYS_OPT_PHY_FLAGS */
1487 #if EFSYS_OPT_PHY_LED_CONTROL
1488 uint32_t enc_led_mask;
1489 #endif /* EFSYS_OPT_PHY_LED_CONTROL */
1490 #if EFSYS_OPT_PHY_STATS
1491 uint64_t enc_phy_stat_mask;
1492 #endif /* EFSYS_OPT_PHY_STATS */
1494 uint8_t enc_mcdi_mdio_channel;
1495 #if EFSYS_OPT_PHY_STATS
1496 uint32_t enc_mcdi_phy_stat_mask;
1497 #endif /* EFSYS_OPT_PHY_STATS */
1498 #if EFSYS_OPT_MON_STATS
1499 uint32_t *enc_mcdi_sensor_maskp;
1500 uint32_t enc_mcdi_sensor_mask_size;
1501 #endif /* EFSYS_OPT_MON_STATS */
1502 #endif /* EFSYS_OPT_MCDI */
1504 uint32_t enc_bist_mask;
1505 #endif /* EFSYS_OPT_BIST */
1506 #if EFSYS_OPT_RIVERHEAD || EFX_OPTS_EF10()
1509 uint32_t enc_privilege_mask;
1510 #endif /* EFSYS_OPT_RIVERHEAD || EFX_OPTS_EF10() */
1511 boolean_t enc_evq_init_done_ev_supported;
1512 boolean_t enc_bug26807_workaround;
1513 boolean_t enc_bug35388_workaround;
1514 boolean_t enc_bug41750_workaround;
1515 boolean_t enc_bug61265_workaround;
1516 boolean_t enc_bug61297_workaround;
1517 boolean_t enc_rx_batching_enabled;
1518 /* Maximum number of descriptors completed in an rx event. */
1519 uint32_t enc_rx_batch_max;
1520 /* Number of rx descriptors the hardware requires for a push. */
1521 uint32_t enc_rx_push_align;
1522 /* Maximum amount of data in DMA descriptor */
1523 uint32_t enc_tx_dma_desc_size_max;
1525 * Boundary which DMA descriptor data must not cross or 0 if no
1528 uint32_t enc_tx_dma_desc_boundary;
1530 * Maximum number of bytes into the packet the TCP header can start for
1531 * the hardware to apply TSO packet edits.
1533 uint32_t enc_tx_tso_tcp_header_offset_limit;
1534 /* Maximum number of header DMA descriptors per TSO transaction. */
1535 uint32_t enc_tx_tso_max_header_ndescs;
1536 /* Maximum header length acceptable by TSO transaction. */
1537 uint32_t enc_tx_tso_max_header_length;
1538 /* Maximum number of payload DMA descriptors per TSO transaction. */
1539 uint32_t enc_tx_tso_max_payload_ndescs;
1540 /* Maximum payload length per TSO transaction. */
1541 uint32_t enc_tx_tso_max_payload_length;
1542 /* Maximum number of frames to be generated per TSO transaction. */
1543 uint32_t enc_tx_tso_max_nframes;
1544 boolean_t enc_fw_assisted_tso_enabled;
1545 boolean_t enc_fw_assisted_tso_v2_enabled;
1546 boolean_t enc_fw_assisted_tso_v2_encap_enabled;
1547 boolean_t enc_tso_v3_enabled;
1548 /* Number of TSO contexts on the NIC (FATSOv2) */
1549 uint32_t enc_fw_assisted_tso_v2_n_contexts;
1550 boolean_t enc_hw_tx_insert_vlan_enabled;
1551 /* Number of PFs on the NIC */
1552 uint32_t enc_hw_pf_count;
1553 /* Datapath firmware vadapter/vport/vswitch support */
1554 boolean_t enc_datapath_cap_evb;
1555 /* Datapath firmware vport reconfigure support */
1556 boolean_t enc_vport_reconfigure_supported;
1557 boolean_t enc_rx_disable_scatter_supported;
1558 /* Maximum number of Rx scatter segments supported by HW */
1559 uint32_t enc_rx_scatter_max;
1560 boolean_t enc_allow_set_mac_with_installed_filters;
1561 boolean_t enc_enhanced_set_mac_supported;
1562 boolean_t enc_init_evq_v2_supported;
1563 boolean_t enc_init_evq_extended_width_supported;
1564 boolean_t enc_no_cont_ev_mode_supported;
1565 boolean_t enc_init_rxq_with_buffer_size;
1566 boolean_t enc_rx_packed_stream_supported;
1567 boolean_t enc_rx_var_packed_stream_supported;
1568 boolean_t enc_rx_es_super_buffer_supported;
1569 boolean_t enc_fw_subvariant_no_tx_csum_supported;
1570 boolean_t enc_pm_and_rxdp_counters;
1571 boolean_t enc_mac_stats_40g_tx_size_bins;
1572 uint32_t enc_tunnel_encapsulations_supported;
1574 * NIC global maximum for unique UDP tunnel ports shared by all
1577 uint32_t enc_tunnel_config_udp_entries_max;
1578 /* External port identifier */
1579 uint8_t enc_external_port;
1580 uint32_t enc_mcdi_max_payload_length;
1581 /* VPD may be per-PF or global */
1582 boolean_t enc_vpd_is_global;
1583 /* Minimum unidirectional bandwidth in Mb/s to max out all ports */
1584 uint32_t enc_required_pcie_bandwidth_mbps;
1585 uint32_t enc_max_pcie_link_gen;
1586 /* Firmware verifies integrity of NVRAM updates */
1587 boolean_t enc_nvram_update_verify_result_supported;
1588 /* Firmware supports polled NVRAM updates on select partitions */
1589 boolean_t enc_nvram_update_poll_verify_result_supported;
1590 /* Firmware accepts updates via the BUNDLE partition */
1591 boolean_t enc_nvram_bundle_update_supported;
1592 /* Firmware support for extended MAC_STATS buffer */
1593 uint32_t enc_mac_stats_nstats;
1594 boolean_t enc_fec_counters;
1595 boolean_t enc_hlb_counters;
1596 /* NIC support for Match-Action Engine (MAE). */
1597 boolean_t enc_mae_supported;
1598 /* Firmware support for "FLAG" and "MARK" filter actions */
1599 boolean_t enc_filter_action_flag_supported;
1600 boolean_t enc_filter_action_mark_supported;
1601 uint32_t enc_filter_action_mark_max;
1602 /* Port assigned to this PCI function */
1603 uint32_t enc_assigned_port;
1606 #define EFX_VPORT_PCI_FUNCTION_IS_PF(configp) \
1607 ((configp)->evc_function == 0xffff)
1609 #define EFX_PCI_FUNCTION_IS_PF(_encp) ((_encp)->enc_vf == 0xffff)
1610 #define EFX_PCI_FUNCTION_IS_VF(_encp) ((_encp)->enc_vf != 0xffff)
1612 #define EFX_PCI_FUNCTION(_encp) \
1613 (EFX_PCI_FUNCTION_IS_PF(_encp) ? (_encp)->enc_pf : (_encp)->enc_vf)
1615 #define EFX_PCI_VF_PARENT(_encp) ((_encp)->enc_pf)
1618 extern const efx_nic_cfg_t *
1620 __in const efx_nic_t *enp);
1622 /* RxDPCPU firmware id values by which FW variant can be identified */
1623 #define EFX_RXDP_FULL_FEATURED_FW_ID 0x0
1624 #define EFX_RXDP_LOW_LATENCY_FW_ID 0x1
1625 #define EFX_RXDP_PACKED_STREAM_FW_ID 0x2
1626 #define EFX_RXDP_RULES_ENGINE_FW_ID 0x5
1627 #define EFX_RXDP_DPDK_FW_ID 0x6
1629 typedef struct efx_nic_fw_info_s {
1630 /* Basic FW version information */
1631 uint16_t enfi_mc_fw_version[4];
1633 * If datapath capabilities can be detected,
1634 * additional FW information is to be shown
1636 boolean_t enfi_dpcpu_fw_ids_valid;
1637 /* Rx and Tx datapath CPU FW IDs */
1638 uint16_t enfi_rx_dpcpu_fw_id;
1639 uint16_t enfi_tx_dpcpu_fw_id;
1640 } efx_nic_fw_info_t;
1643 extern __checkReturn efx_rc_t
1644 efx_nic_get_fw_version(
1645 __in efx_nic_t *enp,
1646 __out efx_nic_fw_info_t *enfip);
1648 /* Driver resource limits (minimum required/maximum usable). */
1649 typedef struct efx_drv_limits_s {
1650 uint32_t edl_min_evq_count;
1651 uint32_t edl_max_evq_count;
1653 uint32_t edl_min_rxq_count;
1654 uint32_t edl_max_rxq_count;
1656 uint32_t edl_min_txq_count;
1657 uint32_t edl_max_txq_count;
1659 /* PIO blocks (sub-allocated from piobuf) */
1660 uint32_t edl_min_pio_alloc_size;
1661 uint32_t edl_max_pio_alloc_count;
1665 extern __checkReturn efx_rc_t
1666 efx_nic_set_drv_limits(
1667 __inout efx_nic_t *enp,
1668 __in efx_drv_limits_t *edlp);
1671 * Register the OS driver version string for management agents
1672 * (e.g. via NC-SI). The content length is provided (i.e. no
1673 * NUL terminator). Use length 0 to indicate no version string
1674 * should be advertised. It is valid to set the version string
1675 * only before efx_nic_probe() is called.
1678 extern __checkReturn efx_rc_t
1679 efx_nic_set_drv_version(
1680 __inout efx_nic_t *enp,
1681 __in_ecount(length) char const *verp,
1682 __in size_t length);
1684 typedef enum efx_nic_region_e {
1685 EFX_REGION_VI, /* Memory BAR UC mapping */
1686 EFX_REGION_PIO_WRITE_VI, /* Memory BAR WC mapping */
1690 extern __checkReturn efx_rc_t
1691 efx_nic_get_bar_region(
1692 __in efx_nic_t *enp,
1693 __in efx_nic_region_t region,
1694 __out uint32_t *offsetp,
1695 __out size_t *sizep);
1698 extern __checkReturn efx_rc_t
1699 efx_nic_get_vi_pool(
1700 __in efx_nic_t *enp,
1701 __out uint32_t *evq_countp,
1702 __out uint32_t *rxq_countp,
1703 __out uint32_t *txq_countp);
1708 typedef enum efx_vpd_tag_e {
1715 typedef uint16_t efx_vpd_keyword_t;
1717 typedef struct efx_vpd_value_s {
1718 efx_vpd_tag_t evv_tag;
1719 efx_vpd_keyword_t evv_keyword;
1721 uint8_t evv_value[0x100];
1725 #define EFX_VPD_KEYWORD(x, y) ((x) | ((y) << 8))
1728 extern __checkReturn efx_rc_t
1730 __in efx_nic_t *enp);
1733 extern __checkReturn efx_rc_t
1735 __in efx_nic_t *enp,
1736 __out size_t *sizep);
1739 extern __checkReturn efx_rc_t
1741 __in efx_nic_t *enp,
1742 __out_bcount(size) caddr_t data,
1746 extern __checkReturn efx_rc_t
1748 __in efx_nic_t *enp,
1749 __in_bcount(size) caddr_t data,
1753 extern __checkReturn efx_rc_t
1755 __in efx_nic_t *enp,
1756 __in_bcount(size) caddr_t data,
1760 extern __checkReturn efx_rc_t
1762 __in efx_nic_t *enp,
1763 __in_bcount(size) caddr_t data,
1765 __inout efx_vpd_value_t *evvp);
1768 extern __checkReturn efx_rc_t
1770 __in efx_nic_t *enp,
1771 __inout_bcount(size) caddr_t data,
1773 __in efx_vpd_value_t *evvp);
1776 extern __checkReturn efx_rc_t
1778 __in efx_nic_t *enp,
1779 __inout_bcount(size) caddr_t data,
1781 __out efx_vpd_value_t *evvp,
1782 __inout unsigned int *contp);
1785 extern __checkReturn efx_rc_t
1787 __in efx_nic_t *enp,
1788 __in_bcount(size) caddr_t data,
1794 __in efx_nic_t *enp);
1796 #endif /* EFSYS_OPT_VPD */
1802 typedef enum efx_nvram_type_e {
1803 EFX_NVRAM_INVALID = 0,
1805 EFX_NVRAM_BOOTROM_CFG,
1806 EFX_NVRAM_MC_FIRMWARE,
1807 EFX_NVRAM_MC_GOLDEN,
1813 EFX_NVRAM_FPGA_BACKUP,
1814 EFX_NVRAM_DYNAMIC_CFG,
1817 EFX_NVRAM_MUM_FIRMWARE,
1818 EFX_NVRAM_DYNCONFIG_DEFAULTS,
1819 EFX_NVRAM_ROMCONFIG_DEFAULTS,
1821 EFX_NVRAM_BUNDLE_METADATA,
1825 typedef struct efx_nvram_info_s {
1827 uint32_t eni_partn_size;
1828 uint32_t eni_address;
1829 uint32_t eni_erase_size;
1830 uint32_t eni_write_size;
1833 #define EFX_NVRAM_FLAG_READ_ONLY (1 << 0)
1836 extern __checkReturn efx_rc_t
1838 __in efx_nic_t *enp);
1843 extern __checkReturn efx_rc_t
1845 __in efx_nic_t *enp);
1847 #endif /* EFSYS_OPT_DIAG */
1850 extern __checkReturn efx_rc_t
1852 __in efx_nic_t *enp,
1853 __in efx_nvram_type_t type,
1854 __out size_t *sizep);
1857 extern __checkReturn efx_rc_t
1859 __in efx_nic_t *enp,
1860 __in efx_nvram_type_t type,
1861 __out efx_nvram_info_t *enip);
1864 extern __checkReturn efx_rc_t
1866 __in efx_nic_t *enp,
1867 __in efx_nvram_type_t type,
1868 __out_opt size_t *pref_chunkp);
1871 extern __checkReturn efx_rc_t
1872 efx_nvram_rw_finish(
1873 __in efx_nic_t *enp,
1874 __in efx_nvram_type_t type,
1875 __out_opt uint32_t *verify_resultp);
1878 extern __checkReturn efx_rc_t
1879 efx_nvram_get_version(
1880 __in efx_nic_t *enp,
1881 __in efx_nvram_type_t type,
1882 __out uint32_t *subtypep,
1883 __out_ecount(4) uint16_t version[4]);
1886 extern __checkReturn efx_rc_t
1887 efx_nvram_read_chunk(
1888 __in efx_nic_t *enp,
1889 __in efx_nvram_type_t type,
1890 __in unsigned int offset,
1891 __out_bcount(size) caddr_t data,
1895 extern __checkReturn efx_rc_t
1896 efx_nvram_read_backup(
1897 __in efx_nic_t *enp,
1898 __in efx_nvram_type_t type,
1899 __in unsigned int offset,
1900 __out_bcount(size) caddr_t data,
1904 extern __checkReturn efx_rc_t
1905 efx_nvram_set_version(
1906 __in efx_nic_t *enp,
1907 __in efx_nvram_type_t type,
1908 __in_ecount(4) uint16_t version[4]);
1911 extern __checkReturn efx_rc_t
1913 __in efx_nic_t *enp,
1914 __in efx_nvram_type_t type,
1915 __in_bcount(partn_size) caddr_t partn_data,
1916 __in size_t partn_size);
1919 extern __checkReturn efx_rc_t
1921 __in efx_nic_t *enp,
1922 __in efx_nvram_type_t type);
1925 extern __checkReturn efx_rc_t
1926 efx_nvram_write_chunk(
1927 __in efx_nic_t *enp,
1928 __in efx_nvram_type_t type,
1929 __in unsigned int offset,
1930 __in_bcount(size) caddr_t data,
1936 __in efx_nic_t *enp);
1938 #endif /* EFSYS_OPT_NVRAM */
1940 #if EFSYS_OPT_BOOTCFG
1942 /* Report size and offset of bootcfg sector in NVRAM partition. */
1944 extern __checkReturn efx_rc_t
1945 efx_bootcfg_sector_info(
1946 __in efx_nic_t *enp,
1948 __out_opt uint32_t *sector_countp,
1949 __out size_t *offsetp,
1950 __out size_t *max_sizep);
1953 * Copy bootcfg sector data to a target buffer which may differ in size.
1954 * Optionally corrects format errors in source buffer.
1958 efx_bootcfg_copy_sector(
1959 __in efx_nic_t *enp,
1960 __inout_bcount(sector_length)
1962 __in size_t sector_length,
1963 __out_bcount(data_size) uint8_t *data,
1964 __in size_t data_size,
1965 __in boolean_t handle_format_errors);
1970 __in efx_nic_t *enp,
1971 __out_bcount(size) uint8_t *data,
1977 __in efx_nic_t *enp,
1978 __in_bcount(size) uint8_t *data,
1983 * Processing routines for buffers arranged in the DHCP/BOOTP option format
1984 * (see https://tools.ietf.org/html/rfc1533)
1986 * Summarising the format: the buffer is a sequence of options. All options
1987 * begin with a tag octet, which uniquely identifies the option. Fixed-
1988 * length options without data consist of only a tag octet. Only options PAD
1989 * (0) and END (255) are fixed length. All other options are variable-length
1990 * with a length octet following the tag octet. The value of the length
1991 * octet does not include the two octets specifying the tag and length. The
1992 * length octet is followed by "length" octets of data.
1994 * Option data may be a sequence of sub-options in the same format. The data
1995 * content of the encapsulating option is one or more encapsulated sub-options,
1996 * with no terminating END tag is required.
1998 * To be valid, the top-level sequence of options should be terminated by an
1999 * END tag. The buffer should be padded with the PAD byte.
2001 * When stored to NVRAM, the DHCP option format buffer is preceded by a
2002 * checksum octet. The full buffer (including after the END tag) contributes
2003 * to the checksum, hence the need to fill the buffer to the end with PAD.
2006 #define EFX_DHCP_END ((uint8_t)0xff)
2007 #define EFX_DHCP_PAD ((uint8_t)0)
2009 #define EFX_DHCP_ENCAP_OPT(encapsulator, encapsulated) \
2010 (uint16_t)(((encapsulator) << 8) | (encapsulated))
2013 extern __checkReturn uint8_t
2015 __in_bcount(size) uint8_t const *data,
2019 extern __checkReturn efx_rc_t
2021 __in_bcount(size) uint8_t const *data,
2023 __out_opt size_t *usedp);
2026 extern __checkReturn efx_rc_t
2028 __in_bcount(buffer_length) uint8_t *bufferp,
2029 __in size_t buffer_length,
2031 __deref_out uint8_t **valuepp,
2032 __out size_t *value_lengthp);
2035 extern __checkReturn efx_rc_t
2037 __in_bcount(buffer_length) uint8_t *bufferp,
2038 __in size_t buffer_length,
2039 __deref_out uint8_t **endpp);
2043 extern __checkReturn efx_rc_t
2044 efx_dhcp_delete_tag(
2045 __inout_bcount(buffer_length) uint8_t *bufferp,
2046 __in size_t buffer_length,
2050 extern __checkReturn efx_rc_t
2052 __inout_bcount(buffer_length) uint8_t *bufferp,
2053 __in size_t buffer_length,
2055 __in_bcount_opt(value_length) uint8_t *valuep,
2056 __in size_t value_length);
2059 extern __checkReturn efx_rc_t
2060 efx_dhcp_update_tag(
2061 __inout_bcount(buffer_length) uint8_t *bufferp,
2062 __in size_t buffer_length,
2064 __in uint8_t *value_locationp,
2065 __in_bcount_opt(value_length) uint8_t *valuep,
2066 __in size_t value_length);
2069 #endif /* EFSYS_OPT_BOOTCFG */
2071 #if EFSYS_OPT_IMAGE_LAYOUT
2073 #include "ef10_signed_image_layout.h"
2076 * Image header used in unsigned and signed image layouts (see SF-102785-PS).
2079 * The image header format is extensible. However, older drivers require an
2080 * exact match of image header version and header length when validating and
2081 * writing firmware images.
2083 * To avoid breaking backward compatibility, we use the upper bits of the
2084 * controller version fields to contain an extra version number used for
2085 * combined bootROM and UEFI ROM images on EF10 and later (to hold the UEFI ROM
2086 * version). See bug39254 and SF-102785-PS for details.
2088 typedef struct efx_image_header_s {
2090 uint32_t eih_version;
2092 uint32_t eih_subtype;
2093 uint32_t eih_code_size;
2096 uint32_t eih_controller_version_min;
2098 uint16_t eih_controller_version_min_short;
2099 uint8_t eih_extra_version_a;
2100 uint8_t eih_extra_version_b;
2104 uint32_t eih_controller_version_max;
2106 uint16_t eih_controller_version_max_short;
2107 uint8_t eih_extra_version_c;
2108 uint8_t eih_extra_version_d;
2111 uint16_t eih_code_version_a;
2112 uint16_t eih_code_version_b;
2113 uint16_t eih_code_version_c;
2114 uint16_t eih_code_version_d;
2115 } efx_image_header_t;
2117 #define EFX_IMAGE_HEADER_SIZE (40)
2118 #define EFX_IMAGE_HEADER_VERSION (4)
2119 #define EFX_IMAGE_HEADER_MAGIC (0x106F1A5)
2122 typedef struct efx_image_trailer_s {
2124 } efx_image_trailer_t;
2126 #define EFX_IMAGE_TRAILER_SIZE (4)
2128 typedef enum efx_image_format_e {
2129 EFX_IMAGE_FORMAT_NO_IMAGE,
2130 EFX_IMAGE_FORMAT_INVALID,
2131 EFX_IMAGE_FORMAT_UNSIGNED,
2132 EFX_IMAGE_FORMAT_SIGNED,
2133 EFX_IMAGE_FORMAT_SIGNED_PACKAGE
2134 } efx_image_format_t;
2136 typedef struct efx_image_info_s {
2137 efx_image_format_t eii_format;
2138 uint8_t * eii_imagep;
2139 size_t eii_image_size;
2140 efx_image_header_t * eii_headerp;
2144 extern __checkReturn efx_rc_t
2145 efx_check_reflash_image(
2147 __in uint32_t buffer_size,
2148 __out efx_image_info_t *infop);
2151 extern __checkReturn efx_rc_t
2152 efx_build_signed_image_write_buffer(
2153 __out_bcount(buffer_size)
2155 __in uint32_t buffer_size,
2156 __in efx_image_info_t *infop,
2157 __out efx_image_header_t **headerpp);
2159 #endif /* EFSYS_OPT_IMAGE_LAYOUT */
2163 typedef enum efx_pattern_type_t {
2164 EFX_PATTERN_BYTE_INCREMENT = 0,
2165 EFX_PATTERN_ALL_THE_SAME,
2166 EFX_PATTERN_BIT_ALTERNATE,
2167 EFX_PATTERN_BYTE_ALTERNATE,
2168 EFX_PATTERN_BYTE_CHANGING,
2169 EFX_PATTERN_BIT_SWEEP,
2171 } efx_pattern_type_t;
2174 (*efx_sram_pattern_fn_t)(
2176 __in boolean_t negate,
2177 __out efx_qword_t *eqp);
2180 extern __checkReturn efx_rc_t
2182 __in efx_nic_t *enp,
2183 __in efx_pattern_type_t type);
2185 #endif /* EFSYS_OPT_DIAG */
2188 extern __checkReturn efx_rc_t
2189 efx_sram_buf_tbl_set(
2190 __in efx_nic_t *enp,
2192 __in efsys_mem_t *esmp,
2197 efx_sram_buf_tbl_clear(
2198 __in efx_nic_t *enp,
2202 #define EFX_BUF_TBL_SIZE 0x20000
2204 #define EFX_BUF_SIZE 4096
2208 typedef struct efx_evq_s efx_evq_t;
2210 #if EFSYS_OPT_QSTATS
2212 /* START MKCONFIG GENERATED EfxHeaderEventQueueBlock 0a147ace40844969 */
2213 typedef enum efx_ev_qstat_e {
2219 EV_RX_PAUSE_FRM_ERR,
2220 EV_RX_BUF_OWNER_ID_ERR,
2221 EV_RX_IPV4_HDR_CHKSUM_ERR,
2222 EV_RX_TCP_UDP_CHKSUM_ERR,
2226 EV_RX_MCAST_HASH_MATCH,
2243 EV_DRIVER_SRM_UPD_DONE,
2244 EV_DRIVER_TX_DESCQ_FLS_DONE,
2245 EV_DRIVER_RX_DESCQ_FLS_DONE,
2246 EV_DRIVER_RX_DESCQ_FLS_FAILED,
2247 EV_DRIVER_RX_DSC_ERROR,
2248 EV_DRIVER_TX_DSC_ERROR,
2251 EV_RX_PARSE_INCOMPLETE,
2255 /* END MKCONFIG GENERATED EfxHeaderEventQueueBlock */
2257 #endif /* EFSYS_OPT_QSTATS */
2260 extern __checkReturn efx_rc_t
2262 __in efx_nic_t *enp);
2267 __in efx_nic_t *enp);
2270 extern __checkReturn size_t
2272 __in const efx_nic_t *enp,
2273 __in unsigned int ndescs,
2274 __in uint32_t flags);
2277 extern __checkReturn unsigned int
2279 __in const efx_nic_t *enp,
2280 __in unsigned int ndescs,
2281 __in uint32_t flags);
2283 #define EFX_EVQ_FLAGS_TYPE_MASK (0x3)
2284 #define EFX_EVQ_FLAGS_TYPE_AUTO (0x0)
2285 #define EFX_EVQ_FLAGS_TYPE_THROUGHPUT (0x1)
2286 #define EFX_EVQ_FLAGS_TYPE_LOW_LATENCY (0x2)
2288 #define EFX_EVQ_FLAGS_NOTIFY_MASK (0xC)
2289 #define EFX_EVQ_FLAGS_NOTIFY_INTERRUPT (0x0) /* Interrupting (default) */
2290 #define EFX_EVQ_FLAGS_NOTIFY_DISABLED (0x4) /* Non-interrupting */
2293 * Use the NO_CONT_EV RX event format, which allows the firmware to operate more
2294 * efficiently at high data rates. See SF-109306-TC 5.11 "Events for RXQs in
2297 * NO_CONT_EV requires EVQ_RX_MERGE and RXQ_FORCED_EV_MERGING to both be set,
2298 * which is the case when an event queue is set to THROUGHPUT mode.
2300 #define EFX_EVQ_FLAGS_NO_CONT_EV (0x10)
2302 /* Configure EVQ for extended width events (EF100 only) */
2303 #define EFX_EVQ_FLAGS_EXTENDED_WIDTH (0x20)
2307 extern __checkReturn efx_rc_t
2309 __in efx_nic_t *enp,
2310 __in unsigned int index,
2311 __in efsys_mem_t *esmp,
2315 __in uint32_t flags,
2316 __deref_out efx_evq_t **eepp);
2321 __in efx_evq_t *eep,
2322 __in uint16_t data);
2324 typedef __checkReturn boolean_t
2325 (*efx_initialized_ev_t)(
2326 __in_opt void *arg);
2328 #define EFX_PKT_UNICAST 0x0004
2329 #define EFX_PKT_START 0x0008
2331 #define EFX_PKT_VLAN_TAGGED 0x0010
2332 #define EFX_CKSUM_TCPUDP 0x0020
2333 #define EFX_CKSUM_IPV4 0x0040
2334 #define EFX_PKT_CONT 0x0080
2336 #define EFX_CHECK_VLAN 0x0100
2337 #define EFX_PKT_TCP 0x0200
2338 #define EFX_PKT_UDP 0x0400
2339 #define EFX_PKT_IPV4 0x0800
2341 #define EFX_PKT_IPV6 0x1000
2342 #define EFX_PKT_PREFIX_LEN 0x2000
2343 #define EFX_ADDR_MISMATCH 0x4000
2344 #define EFX_DISCARD 0x8000
2347 * The following flags are used only for packed stream
2348 * mode. The values for the flags are reused to fit into 16 bit,
2349 * since EFX_PKT_START and EFX_PKT_CONT are never used in
2350 * packed stream mode
2352 #define EFX_PKT_PACKED_STREAM_NEW_BUFFER EFX_PKT_START
2353 #define EFX_PKT_PACKED_STREAM_PARSE_INCOMPLETE EFX_PKT_CONT
2356 #define EFX_EV_RX_NLABELS 32
2357 #define EFX_EV_TX_NLABELS 32
2359 typedef __checkReturn boolean_t
2362 __in uint32_t label,
2365 __in uint16_t flags);
2367 typedef __checkReturn boolean_t
2368 (*efx_rx_packets_ev_t)(
2370 __in uint32_t label,
2371 __in unsigned int num_packets,
2372 __in uint32_t flags);
2374 #if EFSYS_OPT_RX_PACKED_STREAM || EFSYS_OPT_RX_ES_SUPER_BUFFER
2377 * Packed stream mode is documented in SF-112241-TC.
2378 * The general idea is that, instead of putting each incoming
2379 * packet into a separate buffer which is specified in a RX
2380 * descriptor, a large buffer is provided to the hardware and
2381 * packets are put there in a continuous stream.
2382 * The main advantage of such an approach is that RX queue refilling
2383 * happens much less frequently.
2385 * Equal stride packed stream mode is documented in SF-119419-TC.
2386 * The general idea is to utilize advantages of the packed stream,
2387 * but avoid indirection in packets representation.
2388 * The main advantage of such an approach is that RX queue refilling
2389 * happens much less frequently and packets buffers are independent
2390 * from upper layers point of view.
2393 typedef __checkReturn boolean_t
2396 __in uint32_t label,
2398 __in uint32_t pkt_count,
2399 __in uint16_t flags);
2403 typedef __checkReturn boolean_t
2406 __in uint32_t label,
2409 typedef __checkReturn boolean_t
2410 (*efx_tx_ndescs_ev_t)(
2412 __in uint32_t label,
2413 __in unsigned int ndescs);
2415 #define EFX_EXCEPTION_RX_RECOVERY 0x00000001
2416 #define EFX_EXCEPTION_RX_DSC_ERROR 0x00000002
2417 #define EFX_EXCEPTION_TX_DSC_ERROR 0x00000003
2418 #define EFX_EXCEPTION_UNKNOWN_SENSOREVT 0x00000004
2419 #define EFX_EXCEPTION_FWALERT_SRAM 0x00000005
2420 #define EFX_EXCEPTION_UNKNOWN_FWALERT 0x00000006
2421 #define EFX_EXCEPTION_RX_ERROR 0x00000007
2422 #define EFX_EXCEPTION_TX_ERROR 0x00000008
2423 #define EFX_EXCEPTION_EV_ERROR 0x00000009
2425 typedef __checkReturn boolean_t
2426 (*efx_exception_ev_t)(
2428 __in uint32_t label,
2429 __in uint32_t data);
2431 typedef __checkReturn boolean_t
2432 (*efx_rxq_flush_done_ev_t)(
2434 __in uint32_t rxq_index);
2436 typedef __checkReturn boolean_t
2437 (*efx_rxq_flush_failed_ev_t)(
2439 __in uint32_t rxq_index);
2441 typedef __checkReturn boolean_t
2442 (*efx_txq_flush_done_ev_t)(
2444 __in uint32_t txq_index);
2446 typedef __checkReturn boolean_t
2447 (*efx_software_ev_t)(
2449 __in uint16_t magic);
2451 typedef __checkReturn boolean_t
2454 __in uint32_t code);
2456 #define EFX_SRAM_CLEAR 0
2457 #define EFX_SRAM_UPDATE 1
2458 #define EFX_SRAM_ILLEGAL_CLEAR 2
2460 typedef __checkReturn boolean_t
2461 (*efx_wake_up_ev_t)(
2463 __in uint32_t label);
2465 typedef __checkReturn boolean_t
2468 __in uint32_t label);
2470 typedef __checkReturn boolean_t
2471 (*efx_link_change_ev_t)(
2473 __in efx_link_mode_t link_mode);
2475 #if EFSYS_OPT_MON_STATS
2477 typedef __checkReturn boolean_t
2478 (*efx_monitor_ev_t)(
2480 __in efx_mon_stat_t id,
2481 __in efx_mon_stat_value_t value);
2483 #endif /* EFSYS_OPT_MON_STATS */
2485 #if EFSYS_OPT_MAC_STATS
2487 typedef __checkReturn boolean_t
2488 (*efx_mac_stats_ev_t)(
2490 __in uint32_t generation);
2492 #endif /* EFSYS_OPT_MAC_STATS */
2494 #if EFSYS_OPT_DESC_PROXY
2497 * NOTE: This callback returns the raw descriptor data, which has not been
2498 * converted to host endian. The callback must use the EFX_OWORD macros
2499 * to extract the descriptor fields as host endian values.
2501 typedef __checkReturn boolean_t
2502 (*efx_desc_proxy_txq_desc_ev_t)(
2504 __in uint16_t vi_id,
2505 __in efx_oword_t txq_desc);
2508 * NOTE: This callback returns the raw descriptor data, which has not been
2509 * converted to host endian. The callback must use the EFX_OWORD macros
2510 * to extract the descriptor fields as host endian values.
2512 typedef __checkReturn boolean_t
2513 (*efx_desc_proxy_virtq_desc_ev_t)(
2515 __in uint16_t vi_id,
2516 __in uint16_t avail,
2517 __in efx_oword_t virtq_desc);
2519 #endif /* EFSYS_OPT_DESC_PROXY */
2521 typedef struct efx_ev_callbacks_s {
2522 efx_initialized_ev_t eec_initialized;
2524 efx_rx_packets_ev_t eec_rx_packets;
2525 #if EFSYS_OPT_RX_PACKED_STREAM || EFSYS_OPT_RX_ES_SUPER_BUFFER
2526 efx_rx_ps_ev_t eec_rx_ps;
2529 efx_tx_ndescs_ev_t eec_tx_ndescs;
2530 efx_exception_ev_t eec_exception;
2531 efx_rxq_flush_done_ev_t eec_rxq_flush_done;
2532 efx_rxq_flush_failed_ev_t eec_rxq_flush_failed;
2533 efx_txq_flush_done_ev_t eec_txq_flush_done;
2534 efx_software_ev_t eec_software;
2535 efx_sram_ev_t eec_sram;
2536 efx_wake_up_ev_t eec_wake_up;
2537 efx_timer_ev_t eec_timer;
2538 efx_link_change_ev_t eec_link_change;
2539 #if EFSYS_OPT_MON_STATS
2540 efx_monitor_ev_t eec_monitor;
2541 #endif /* EFSYS_OPT_MON_STATS */
2542 #if EFSYS_OPT_MAC_STATS
2543 efx_mac_stats_ev_t eec_mac_stats;
2544 #endif /* EFSYS_OPT_MAC_STATS */
2545 #if EFSYS_OPT_DESC_PROXY
2546 efx_desc_proxy_txq_desc_ev_t eec_desc_proxy_txq_desc;
2547 efx_desc_proxy_virtq_desc_ev_t eec_desc_proxy_virtq_desc;
2548 #endif /* EFSYS_OPT_DESC_PROXY */
2550 } efx_ev_callbacks_t;
2553 extern __checkReturn boolean_t
2555 __in efx_evq_t *eep,
2556 __in unsigned int count);
2558 #if EFSYS_OPT_EV_PREFETCH
2563 __in efx_evq_t *eep,
2564 __in unsigned int count);
2566 #endif /* EFSYS_OPT_EV_PREFETCH */
2570 efx_ev_qcreate_check_init_done(
2571 __in efx_evq_t *eep,
2572 __in const efx_ev_callbacks_t *eecp,
2573 __in_opt void *arg);
2578 __in efx_evq_t *eep,
2579 __inout unsigned int *countp,
2580 __in const efx_ev_callbacks_t *eecp,
2581 __in_opt void *arg);
2584 extern __checkReturn efx_rc_t
2585 efx_ev_usecs_to_ticks(
2586 __in efx_nic_t *enp,
2587 __in unsigned int usecs,
2588 __out unsigned int *ticksp);
2591 extern __checkReturn efx_rc_t
2593 __in efx_evq_t *eep,
2594 __in unsigned int us);
2597 extern __checkReturn efx_rc_t
2599 __in efx_evq_t *eep,
2600 __in unsigned int count);
2602 #if EFSYS_OPT_QSTATS
2609 __in efx_nic_t *enp,
2610 __in unsigned int id);
2612 #endif /* EFSYS_OPT_NAMES */
2616 efx_ev_qstats_update(
2617 __in efx_evq_t *eep,
2618 __inout_ecount(EV_NQSTATS) efsys_stat_t *stat);
2620 #endif /* EFSYS_OPT_QSTATS */
2625 __in efx_evq_t *eep);
2630 extern __checkReturn efx_rc_t
2632 __inout efx_nic_t *enp);
2637 __in efx_nic_t *enp);
2639 #if EFSYS_OPT_RX_SCATTER
2641 extern __checkReturn efx_rc_t
2642 efx_rx_scatter_enable(
2643 __in efx_nic_t *enp,
2644 __in unsigned int buf_size);
2645 #endif /* EFSYS_OPT_RX_SCATTER */
2647 /* Handle to represent use of the default RSS context. */
2648 #define EFX_RSS_CONTEXT_DEFAULT 0xffffffff
2650 #if EFSYS_OPT_RX_SCALE
2652 typedef enum efx_rx_hash_alg_e {
2653 EFX_RX_HASHALG_LFSR = 0,
2654 EFX_RX_HASHALG_TOEPLITZ,
2655 EFX_RX_HASHALG_PACKED_STREAM,
2657 } efx_rx_hash_alg_t;
2660 * Legacy hash type flags.
2662 * They represent standard tuples for distinct traffic classes.
2664 #define EFX_RX_HASH_IPV4 (1U << 0)
2665 #define EFX_RX_HASH_TCPIPV4 (1U << 1)
2666 #define EFX_RX_HASH_IPV6 (1U << 2)
2667 #define EFX_RX_HASH_TCPIPV6 (1U << 3)
2669 #define EFX_RX_HASH_LEGACY_MASK \
2670 (EFX_RX_HASH_IPV4 | \
2671 EFX_RX_HASH_TCPIPV4 | \
2672 EFX_RX_HASH_IPV6 | \
2673 EFX_RX_HASH_TCPIPV6)
2676 * The type of the argument used by efx_rx_scale_mode_set() to
2677 * provide a means for the client drivers to configure hashing.
2679 * A properly constructed value can either be:
2680 * - a combination of legacy flags
2681 * - a combination of EFX_RX_HASH() flags
2683 typedef uint32_t efx_rx_hash_type_t;
2685 typedef enum efx_rx_hash_support_e {
2686 EFX_RX_HASH_UNAVAILABLE = 0, /* Hardware hash not inserted */
2687 EFX_RX_HASH_AVAILABLE /* Insert hash with/without RSS */
2688 } efx_rx_hash_support_t;
2690 #define EFX_RSS_KEY_SIZE 40 /* RSS key size (bytes) */
2691 #define EFX_RSS_TBL_SIZE 128 /* Rows in RX indirection table */
2692 #define EFX_MAXRSS 64 /* RX indirection entry range */
2693 #define EFX_MAXRSS_LEGACY 16 /* See bug16611 and bug17213 */
2695 typedef enum efx_rx_scale_context_type_e {
2696 EFX_RX_SCALE_UNAVAILABLE = 0, /* No RX scale context */
2697 EFX_RX_SCALE_EXCLUSIVE, /* Writable key/indirection table */
2698 EFX_RX_SCALE_SHARED /* Read-only key/indirection table */
2699 } efx_rx_scale_context_type_t;
2702 * Traffic classes eligible for hash computation.
2704 * Select packet headers used in computing the receive hash.
2705 * This uses the same encoding as the RSS_MODES field of
2706 * MC_CMD_RSS_CONTEXT_SET_FLAGS.
2708 #define EFX_RX_CLASS_IPV4_TCP_LBN 8
2709 #define EFX_RX_CLASS_IPV4_TCP_WIDTH 4
2710 #define EFX_RX_CLASS_IPV4_UDP_LBN 12
2711 #define EFX_RX_CLASS_IPV4_UDP_WIDTH 4
2712 #define EFX_RX_CLASS_IPV4_LBN 16
2713 #define EFX_RX_CLASS_IPV4_WIDTH 4
2714 #define EFX_RX_CLASS_IPV6_TCP_LBN 20
2715 #define EFX_RX_CLASS_IPV6_TCP_WIDTH 4
2716 #define EFX_RX_CLASS_IPV6_UDP_LBN 24
2717 #define EFX_RX_CLASS_IPV6_UDP_WIDTH 4
2718 #define EFX_RX_CLASS_IPV6_LBN 28
2719 #define EFX_RX_CLASS_IPV6_WIDTH 4
2721 #define EFX_RX_NCLASSES 6
2724 * Ancillary flags used to construct generic hash tuples.
2725 * This uses the same encoding as RSS_MODE_HASH_SELECTOR.
2727 #define EFX_RX_CLASS_HASH_SRC_ADDR (1U << 0)
2728 #define EFX_RX_CLASS_HASH_DST_ADDR (1U << 1)
2729 #define EFX_RX_CLASS_HASH_SRC_PORT (1U << 2)
2730 #define EFX_RX_CLASS_HASH_DST_PORT (1U << 3)
2733 * Generic hash tuples.
2735 * They express combinations of packet fields
2736 * which can contribute to the hash value for
2737 * a particular traffic class.
2739 #define EFX_RX_CLASS_HASH_DISABLE 0
2741 #define EFX_RX_CLASS_HASH_1TUPLE_SRC EFX_RX_CLASS_HASH_SRC_ADDR
2742 #define EFX_RX_CLASS_HASH_1TUPLE_DST EFX_RX_CLASS_HASH_DST_ADDR
2744 #define EFX_RX_CLASS_HASH_2TUPLE \
2745 (EFX_RX_CLASS_HASH_SRC_ADDR | \
2746 EFX_RX_CLASS_HASH_DST_ADDR)
2748 #define EFX_RX_CLASS_HASH_2TUPLE_SRC \
2749 (EFX_RX_CLASS_HASH_SRC_ADDR | \
2750 EFX_RX_CLASS_HASH_SRC_PORT)
2752 #define EFX_RX_CLASS_HASH_2TUPLE_DST \
2753 (EFX_RX_CLASS_HASH_DST_ADDR | \
2754 EFX_RX_CLASS_HASH_DST_PORT)
2756 #define EFX_RX_CLASS_HASH_4TUPLE \
2757 (EFX_RX_CLASS_HASH_SRC_ADDR | \
2758 EFX_RX_CLASS_HASH_DST_ADDR | \
2759 EFX_RX_CLASS_HASH_SRC_PORT | \
2760 EFX_RX_CLASS_HASH_DST_PORT)
2762 #define EFX_RX_CLASS_HASH_NTUPLES 7
2765 * Hash flag constructor.
2767 * Resulting flags encode hash tuples for specific traffic classes.
2768 * The client drivers are encouraged to use these flags to form
2769 * a hash type value.
2771 #define EFX_RX_HASH(_class, _tuple) \
2772 EFX_INSERT_FIELD_NATIVE32(0, 31, \
2773 EFX_RX_CLASS_##_class, EFX_RX_CLASS_HASH_##_tuple)
2776 * The maximum number of EFX_RX_HASH() flags.
2778 #define EFX_RX_HASH_NFLAGS (EFX_RX_NCLASSES * EFX_RX_CLASS_HASH_NTUPLES)
2781 extern __checkReturn efx_rc_t
2782 efx_rx_scale_hash_flags_get(
2783 __in efx_nic_t *enp,
2784 __in efx_rx_hash_alg_t hash_alg,
2785 __out_ecount_part(max_nflags, *nflagsp) unsigned int *flagsp,
2786 __in unsigned int max_nflags,
2787 __out unsigned int *nflagsp);
2790 extern __checkReturn efx_rc_t
2791 efx_rx_hash_default_support_get(
2792 __in efx_nic_t *enp,
2793 __out efx_rx_hash_support_t *supportp);
2797 extern __checkReturn efx_rc_t
2798 efx_rx_scale_default_support_get(
2799 __in efx_nic_t *enp,
2800 __out efx_rx_scale_context_type_t *typep);
2803 extern __checkReturn efx_rc_t
2804 efx_rx_scale_context_alloc(
2805 __in efx_nic_t *enp,
2806 __in efx_rx_scale_context_type_t type,
2807 __in uint32_t num_queues,
2808 __out uint32_t *rss_contextp);
2811 extern __checkReturn efx_rc_t
2812 efx_rx_scale_context_free(
2813 __in efx_nic_t *enp,
2814 __in uint32_t rss_context);
2817 extern __checkReturn efx_rc_t
2818 efx_rx_scale_mode_set(
2819 __in efx_nic_t *enp,
2820 __in uint32_t rss_context,
2821 __in efx_rx_hash_alg_t alg,
2822 __in efx_rx_hash_type_t type,
2823 __in boolean_t insert);
2826 extern __checkReturn efx_rc_t
2827 efx_rx_scale_tbl_set(
2828 __in efx_nic_t *enp,
2829 __in uint32_t rss_context,
2830 __in_ecount(n) unsigned int *table,
2834 extern __checkReturn efx_rc_t
2835 efx_rx_scale_key_set(
2836 __in efx_nic_t *enp,
2837 __in uint32_t rss_context,
2838 __in_ecount(n) uint8_t *key,
2842 extern __checkReturn uint32_t
2843 efx_pseudo_hdr_hash_get(
2844 __in efx_rxq_t *erp,
2845 __in efx_rx_hash_alg_t func,
2846 __in uint8_t *buffer);
2848 #endif /* EFSYS_OPT_RX_SCALE */
2851 extern __checkReturn efx_rc_t
2852 efx_pseudo_hdr_pkt_length_get(
2853 __in efx_rxq_t *erp,
2854 __in uint8_t *buffer,
2855 __out uint16_t *pkt_lengthp);
2858 extern __checkReturn size_t
2860 __in const efx_nic_t *enp,
2861 __in unsigned int ndescs);
2864 extern __checkReturn unsigned int
2866 __in const efx_nic_t *enp,
2867 __in unsigned int ndescs);
2869 #define EFX_RXQ_LIMIT(_ndescs) ((_ndescs) - 16)
2872 * libefx representation of the Rx prefix layout information.
2874 * The information may be used inside libefx to implement Rx prefix fields
2875 * accessors and by drivers which process Rx prefix itself.
2879 * All known Rx prefix fields.
2881 * An Rx prefix may have a subset of these fields.
2883 typedef enum efx_rx_prefix_field_e {
2884 EFX_RX_PREFIX_FIELD_LENGTH = 0,
2885 EFX_RX_PREFIX_FIELD_ORIG_LENGTH,
2886 EFX_RX_PREFIX_FIELD_CLASS,
2887 EFX_RX_PREFIX_FIELD_RSS_HASH,
2888 EFX_RX_PREFIX_FIELD_RSS_HASH_VALID,
2889 EFX_RX_PREFIX_FIELD_PARTIAL_TSTAMP,
2890 EFX_RX_PREFIX_FIELD_VLAN_STRIP_TCI,
2891 EFX_RX_PREFIX_FIELD_INNER_VLAN_STRIP_TCI,
2892 EFX_RX_PREFIX_FIELD_USER_FLAG,
2893 EFX_RX_PREFIX_FIELD_USER_MARK,
2894 EFX_RX_PREFIX_FIELD_USER_MARK_VALID,
2895 EFX_RX_PREFIX_FIELD_CSUM_FRAME,
2896 EFX_RX_PREFIX_FIELD_INGRESS_VPORT,
2897 EFX_RX_PREFIX_NFIELDS
2898 } efx_rx_prefix_field_t;
2901 * Location and endianness of a field in Rx prefix.
2903 * If width is zero, the field is not present.
2905 typedef struct efx_rx_prefix_field_info_s {
2906 uint16_t erpfi_offset_bits;
2907 uint8_t erpfi_width_bits;
2908 boolean_t erpfi_big_endian;
2909 } efx_rx_prefix_field_info_t;
2911 /* Helper macro to define Rx prefix fields */
2912 #define EFX_RX_PREFIX_FIELD(_efx, _field, _big_endian) \
2913 [EFX_RX_PREFIX_FIELD_ ## _efx] = { \
2914 .erpfi_offset_bits = EFX_LOW_BIT(_field), \
2915 .erpfi_width_bits = EFX_WIDTH(_field), \
2916 .erpfi_big_endian = (_big_endian), \
2919 typedef struct efx_rx_prefix_layout_s {
2921 uint8_t erpl_length;
2922 efx_rx_prefix_field_info_t erpl_fields[EFX_RX_PREFIX_NFIELDS];
2923 } efx_rx_prefix_layout_t;
2926 * Helper function to find out a bit mask of wanted but not available
2929 * A field is considered as not available if any parameter mismatch.
2932 extern __checkReturn uint32_t
2933 efx_rx_prefix_layout_check(
2934 __in const efx_rx_prefix_layout_t *available,
2935 __in const efx_rx_prefix_layout_t *wanted);
2938 extern __checkReturn efx_rc_t
2939 efx_rx_prefix_get_layout(
2940 __in const efx_rxq_t *erp,
2941 __out efx_rx_prefix_layout_t *erplp);
2943 typedef enum efx_rxq_type_e {
2944 EFX_RXQ_TYPE_DEFAULT,
2945 EFX_RXQ_TYPE_PACKED_STREAM,
2946 EFX_RXQ_TYPE_ES_SUPER_BUFFER,
2951 * Dummy flag to be used instead of 0 to make it clear that the argument
2952 * is receive queue flags.
2954 #define EFX_RXQ_FLAG_NONE 0x0
2955 #define EFX_RXQ_FLAG_SCATTER 0x1
2957 * If tunnels are supported and Rx event can provide information about
2958 * either outer or inner packet classes (e.g. SFN8xxx adapters with
2959 * full-feature firmware variant running), outer classes are requested by
2960 * default. However, if the driver supports tunnels, the flag allows to
2961 * request inner classes which are required to be able to interpret inner
2962 * Rx checksum offload results.
2964 #define EFX_RXQ_FLAG_INNER_CLASSES 0x2
2966 * Request delivery of the RSS hash calculated by HW to be used by
2969 #define EFX_RXQ_FLAG_RSS_HASH 0x4
2972 extern __checkReturn efx_rc_t
2974 __in efx_nic_t *enp,
2975 __in unsigned int index,
2976 __in unsigned int label,
2977 __in efx_rxq_type_t type,
2978 __in size_t buf_size,
2979 __in efsys_mem_t *esmp,
2982 __in unsigned int flags,
2983 __in efx_evq_t *eep,
2984 __deref_out efx_rxq_t **erpp);
2986 #if EFSYS_OPT_RX_PACKED_STREAM
2988 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_1M (1U * 1024 * 1024)
2989 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_512K (512U * 1024)
2990 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_256K (256U * 1024)
2991 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_128K (128U * 1024)
2992 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_64K (64U * 1024)
2995 extern __checkReturn efx_rc_t
2996 efx_rx_qcreate_packed_stream(
2997 __in efx_nic_t *enp,
2998 __in unsigned int index,
2999 __in unsigned int label,
3000 __in uint32_t ps_buf_size,
3001 __in efsys_mem_t *esmp,
3003 __in efx_evq_t *eep,
3004 __deref_out efx_rxq_t **erpp);
3008 #if EFSYS_OPT_RX_ES_SUPER_BUFFER
3010 /* Maximum head-of-line block timeout in nanoseconds */
3011 #define EFX_RXQ_ES_SUPER_BUFFER_HOL_BLOCK_MAX (400U * 1000 * 1000)
3014 extern __checkReturn efx_rc_t
3015 efx_rx_qcreate_es_super_buffer(
3016 __in efx_nic_t *enp,
3017 __in unsigned int index,
3018 __in unsigned int label,
3019 __in uint32_t n_bufs_per_desc,
3020 __in uint32_t max_dma_len,
3021 __in uint32_t buf_stride,
3022 __in uint32_t hol_block_timeout,
3023 __in efsys_mem_t *esmp,
3025 __in unsigned int flags,
3026 __in efx_evq_t *eep,
3027 __deref_out efx_rxq_t **erpp);
3031 typedef struct efx_buffer_s {
3032 efsys_dma_addr_t eb_addr;
3037 typedef struct efx_desc_s {
3044 __in efx_rxq_t *erp,
3045 __in_ecount(ndescs) efsys_dma_addr_t *addrp,
3047 __in unsigned int ndescs,
3048 __in unsigned int completed,
3049 __in unsigned int added);
3054 __in efx_rxq_t *erp,
3055 __in unsigned int added,
3056 __inout unsigned int *pushedp);
3058 #if EFSYS_OPT_RX_PACKED_STREAM
3062 efx_rx_qpush_ps_credits(
3063 __in efx_rxq_t *erp);
3066 extern __checkReturn uint8_t *
3067 efx_rx_qps_packet_info(
3068 __in efx_rxq_t *erp,
3069 __in uint8_t *buffer,
3070 __in uint32_t buffer_length,
3071 __in uint32_t current_offset,
3072 __out uint16_t *lengthp,
3073 __out uint32_t *next_offsetp,
3074 __out uint32_t *timestamp);
3078 extern __checkReturn efx_rc_t
3080 __in efx_rxq_t *erp);
3085 __in efx_rxq_t *erp);
3090 __in efx_rxq_t *erp);
3094 typedef struct efx_txq_s efx_txq_t;
3096 #if EFSYS_OPT_QSTATS
3098 /* START MKCONFIG GENERATED EfxHeaderTransmitQueueBlock 12dff8778598b2db */
3099 typedef enum efx_tx_qstat_e {
3105 /* END MKCONFIG GENERATED EfxHeaderTransmitQueueBlock */
3107 #endif /* EFSYS_OPT_QSTATS */
3110 extern __checkReturn efx_rc_t
3112 __in efx_nic_t *enp);
3117 __in efx_nic_t *enp);
3120 extern __checkReturn size_t
3122 __in const efx_nic_t *enp,
3123 __in unsigned int ndescs);
3126 extern __checkReturn unsigned int
3128 __in const efx_nic_t *enp,
3129 __in unsigned int ndescs);
3131 #define EFX_TXQ_LIMIT(_ndescs) ((_ndescs) - 16)
3133 #define EFX_TXQ_CKSUM_IPV4 0x0001
3134 #define EFX_TXQ_CKSUM_TCPUDP 0x0002
3135 #define EFX_TXQ_FATSOV2 0x0004
3136 #define EFX_TXQ_CKSUM_INNER_IPV4 0x0008
3137 #define EFX_TXQ_CKSUM_INNER_TCPUDP 0x0010
3140 extern __checkReturn efx_rc_t
3142 __in efx_nic_t *enp,
3143 __in unsigned int index,
3144 __in unsigned int label,
3145 __in efsys_mem_t *esmp,
3148 __in uint16_t flags,
3149 __in efx_evq_t *eep,
3150 __deref_out efx_txq_t **etpp,
3151 __out unsigned int *addedp);
3154 extern __checkReturn efx_rc_t
3156 __in efx_txq_t *etp,
3157 __in_ecount(ndescs) efx_buffer_t *eb,
3158 __in unsigned int ndescs,
3159 __in unsigned int completed,
3160 __inout unsigned int *addedp);
3163 extern __checkReturn efx_rc_t
3165 __in efx_txq_t *etp,
3166 __in unsigned int ns);
3171 __in efx_txq_t *etp,
3172 __in unsigned int added,
3173 __in unsigned int pushed);
3176 extern __checkReturn efx_rc_t
3178 __in efx_txq_t *etp);
3183 __in efx_txq_t *etp);
3186 extern __checkReturn efx_rc_t
3188 __in efx_txq_t *etp);
3192 efx_tx_qpio_disable(
3193 __in efx_txq_t *etp);
3196 extern __checkReturn efx_rc_t
3198 __in efx_txq_t *etp,
3199 __in_ecount(buf_length) uint8_t *buffer,
3200 __in size_t buf_length,
3201 __in size_t pio_buf_offset);
3204 extern __checkReturn efx_rc_t
3206 __in efx_txq_t *etp,
3207 __in size_t pkt_length,
3208 __in unsigned int completed,
3209 __inout unsigned int *addedp);
3212 extern __checkReturn efx_rc_t
3214 __in efx_txq_t *etp,
3215 __in_ecount(n) efx_desc_t *ed,
3216 __in unsigned int n,
3217 __in unsigned int completed,
3218 __inout unsigned int *addedp);
3222 efx_tx_qdesc_dma_create(
3223 __in efx_txq_t *etp,
3224 __in efsys_dma_addr_t addr,
3227 __out efx_desc_t *edp);
3231 efx_tx_qdesc_tso_create(
3232 __in efx_txq_t *etp,
3233 __in uint16_t ipv4_id,
3234 __in uint32_t tcp_seq,
3235 __in uint8_t tcp_flags,
3236 __out efx_desc_t *edp);
3238 /* Number of FATSOv2 option descriptors */
3239 #define EFX_TX_FATSOV2_OPT_NDESCS 2
3241 /* Maximum number of DMA segments per TSO packet (not superframe) */
3242 #define EFX_TX_FATSOV2_DMA_SEGS_PER_PKT_MAX 24
3246 efx_tx_qdesc_tso2_create(
3247 __in efx_txq_t *etp,
3248 __in uint16_t ipv4_id,
3249 __in uint16_t outer_ipv4_id,
3250 __in uint32_t tcp_seq,
3251 __in uint16_t tcp_mss,
3252 __out_ecount(count) efx_desc_t *edp,
3257 efx_tx_qdesc_vlantci_create(
3258 __in efx_txq_t *etp,
3260 __out efx_desc_t *edp);
3264 efx_tx_qdesc_checksum_create(
3265 __in efx_txq_t *etp,
3266 __in uint16_t flags,
3267 __out efx_desc_t *edp);
3269 #if EFSYS_OPT_QSTATS
3276 __in efx_nic_t *etp,
3277 __in unsigned int id);
3279 #endif /* EFSYS_OPT_NAMES */
3283 efx_tx_qstats_update(
3284 __in efx_txq_t *etp,
3285 __inout_ecount(TX_NQSTATS) efsys_stat_t *stat);
3287 #endif /* EFSYS_OPT_QSTATS */
3292 __in efx_txq_t *etp);
3297 #if EFSYS_OPT_FILTER
3299 #define EFX_ETHER_TYPE_IPV4 0x0800
3300 #define EFX_ETHER_TYPE_IPV6 0x86DD
3302 #define EFX_IPPROTO_TCP 6
3303 #define EFX_IPPROTO_UDP 17
3304 #define EFX_IPPROTO_GRE 47
3306 /* Use RSS to spread across multiple queues */
3307 #define EFX_FILTER_FLAG_RX_RSS 0x01
3308 /* Enable RX scatter */
3309 #define EFX_FILTER_FLAG_RX_SCATTER 0x02
3311 * Override an automatic filter (priority EFX_FILTER_PRI_AUTO).
3312 * May only be set by the filter implementation for each type.
3313 * A removal request will restore the automatic filter in its place.
3315 #define EFX_FILTER_FLAG_RX_OVER_AUTO 0x04
3316 /* Filter is for RX */
3317 #define EFX_FILTER_FLAG_RX 0x08
3318 /* Filter is for TX */
3319 #define EFX_FILTER_FLAG_TX 0x10
3320 /* Set match flag on the received packet */
3321 #define EFX_FILTER_FLAG_ACTION_FLAG 0x20
3322 /* Set match mark on the received packet */
3323 #define EFX_FILTER_FLAG_ACTION_MARK 0x40
3325 typedef uint8_t efx_filter_flags_t;
3328 * Flags which specify the fields to match on. The values are the same as in the
3329 * MC_CMD_FILTER_OP/MC_CMD_FILTER_OP_EXT commands.
3332 /* Match by remote IP host address */
3333 #define EFX_FILTER_MATCH_REM_HOST 0x00000001
3334 /* Match by local IP host address */
3335 #define EFX_FILTER_MATCH_LOC_HOST 0x00000002
3336 /* Match by remote MAC address */
3337 #define EFX_FILTER_MATCH_REM_MAC 0x00000004
3338 /* Match by remote TCP/UDP port */
3339 #define EFX_FILTER_MATCH_REM_PORT 0x00000008
3340 /* Match by remote TCP/UDP port */
3341 #define EFX_FILTER_MATCH_LOC_MAC 0x00000010
3342 /* Match by local TCP/UDP port */
3343 #define EFX_FILTER_MATCH_LOC_PORT 0x00000020
3344 /* Match by Ether-type */
3345 #define EFX_FILTER_MATCH_ETHER_TYPE 0x00000040
3346 /* Match by inner VLAN ID */
3347 #define EFX_FILTER_MATCH_INNER_VID 0x00000080
3348 /* Match by outer VLAN ID */
3349 #define EFX_FILTER_MATCH_OUTER_VID 0x00000100
3350 /* Match by IP transport protocol */
3351 #define EFX_FILTER_MATCH_IP_PROTO 0x00000200
3352 /* Match by VNI or VSID */
3353 #define EFX_FILTER_MATCH_VNI_OR_VSID 0x00000800
3354 /* For encapsulated packets, match by inner frame local MAC address */
3355 #define EFX_FILTER_MATCH_IFRM_LOC_MAC 0x00010000
3356 /* For encapsulated packets, match all multicast inner frames */
3357 #define EFX_FILTER_MATCH_IFRM_UNKNOWN_MCAST_DST 0x01000000
3358 /* For encapsulated packets, match all unicast inner frames */
3359 #define EFX_FILTER_MATCH_IFRM_UNKNOWN_UCAST_DST 0x02000000
3361 * Match by encap type, this flag does not correspond to
3362 * the MCDI match flags and any unoccupied value may be used
3364 #define EFX_FILTER_MATCH_ENCAP_TYPE 0x20000000
3365 /* Match otherwise-unmatched multicast and broadcast packets */
3366 #define EFX_FILTER_MATCH_UNKNOWN_MCAST_DST 0x40000000
3367 /* Match otherwise-unmatched unicast packets */
3368 #define EFX_FILTER_MATCH_UNKNOWN_UCAST_DST 0x80000000
3370 typedef uint32_t efx_filter_match_flags_t;
3372 /* Filter priority from lowest to highest */
3373 typedef enum efx_filter_priority_s {
3374 EFX_FILTER_PRI_AUTO = 0, /* Automatic filter based on device
3375 * address list or hardware
3376 * requirements. This may only be used
3377 * by the filter implementation for
3379 EFX_FILTER_PRI_MANUAL, /* Manually configured filter */
3381 } efx_filter_priority_t;
3384 * FIXME: All these fields are assumed to be in little-endian byte order.
3385 * It may be better for some to be big-endian. See bug42804.
3388 typedef struct efx_filter_spec_s {
3389 efx_filter_match_flags_t efs_match_flags;
3390 uint8_t efs_priority;
3391 efx_filter_flags_t efs_flags;
3392 uint16_t efs_dmaq_id;
3393 uint32_t efs_rss_context;
3396 * Saved lower-priority filter. If it is set, it is restored on
3397 * filter delete operation.
3399 struct efx_filter_spec_s *efs_overridden_spec;
3400 /* Fields below here are hashed for software filter lookup */
3401 uint16_t efs_outer_vid;
3402 uint16_t efs_inner_vid;
3403 uint8_t efs_loc_mac[EFX_MAC_ADDR_LEN];
3404 uint8_t efs_rem_mac[EFX_MAC_ADDR_LEN];
3405 uint16_t efs_ether_type;
3406 uint8_t efs_ip_proto;
3407 efx_tunnel_protocol_t efs_encap_type;
3408 uint16_t efs_loc_port;
3409 uint16_t efs_rem_port;
3410 efx_oword_t efs_rem_host;
3411 efx_oword_t efs_loc_host;
3412 uint8_t efs_vni_or_vsid[EFX_VNI_OR_VSID_LEN];
3413 uint8_t efs_ifrm_loc_mac[EFX_MAC_ADDR_LEN];
3414 } efx_filter_spec_t;
3417 /* Default values for use in filter specifications */
3418 #define EFX_FILTER_SPEC_RX_DMAQ_ID_DROP 0xfff
3419 #define EFX_FILTER_SPEC_VID_UNSPEC 0xffff
3422 extern __checkReturn efx_rc_t
3424 __in efx_nic_t *enp);
3429 __in efx_nic_t *enp);
3432 extern __checkReturn efx_rc_t
3434 __in efx_nic_t *enp,
3435 __inout efx_filter_spec_t *spec);
3438 extern __checkReturn efx_rc_t
3440 __in efx_nic_t *enp,
3441 __inout efx_filter_spec_t *spec);
3444 extern __checkReturn efx_rc_t
3446 __in efx_nic_t *enp);
3449 extern __checkReturn efx_rc_t
3450 efx_filter_supported_filters(
3451 __in efx_nic_t *enp,
3452 __out_ecount(buffer_length) uint32_t *buffer,
3453 __in size_t buffer_length,
3454 __out size_t *list_lengthp);
3458 efx_filter_spec_init_rx(
3459 __out efx_filter_spec_t *spec,
3460 __in efx_filter_priority_t priority,
3461 __in efx_filter_flags_t flags,
3462 __in efx_rxq_t *erp);
3466 efx_filter_spec_init_tx(
3467 __out efx_filter_spec_t *spec,
3468 __in efx_txq_t *etp);
3471 extern __checkReturn efx_rc_t
3472 efx_filter_spec_set_ipv4_local(
3473 __inout efx_filter_spec_t *spec,
3476 __in uint16_t port);
3479 extern __checkReturn efx_rc_t
3480 efx_filter_spec_set_ipv4_full(
3481 __inout efx_filter_spec_t *spec,
3483 __in uint32_t lhost,
3484 __in uint16_t lport,
3485 __in uint32_t rhost,
3486 __in uint16_t rport);
3489 extern __checkReturn efx_rc_t
3490 efx_filter_spec_set_eth_local(
3491 __inout efx_filter_spec_t *spec,
3493 __in const uint8_t *addr);
3497 efx_filter_spec_set_ether_type(
3498 __inout efx_filter_spec_t *spec,
3499 __in uint16_t ether_type);
3502 extern __checkReturn efx_rc_t
3503 efx_filter_spec_set_uc_def(
3504 __inout efx_filter_spec_t *spec);
3507 extern __checkReturn efx_rc_t
3508 efx_filter_spec_set_mc_def(
3509 __inout efx_filter_spec_t *spec);
3511 typedef enum efx_filter_inner_frame_match_e {
3512 EFX_FILTER_INNER_FRAME_MATCH_OTHER = 0,
3513 EFX_FILTER_INNER_FRAME_MATCH_UNKNOWN_MCAST_DST,
3514 EFX_FILTER_INNER_FRAME_MATCH_UNKNOWN_UCAST_DST
3515 } efx_filter_inner_frame_match_t;
3518 extern __checkReturn efx_rc_t
3519 efx_filter_spec_set_encap_type(
3520 __inout efx_filter_spec_t *spec,
3521 __in efx_tunnel_protocol_t encap_type,
3522 __in efx_filter_inner_frame_match_t inner_frame_match);
3525 extern __checkReturn efx_rc_t
3526 efx_filter_spec_set_vxlan(
3527 __inout efx_filter_spec_t *spec,
3528 __in const uint8_t *vni,
3529 __in const uint8_t *inner_addr,
3530 __in const uint8_t *outer_addr);
3533 extern __checkReturn efx_rc_t
3534 efx_filter_spec_set_geneve(
3535 __inout efx_filter_spec_t *spec,
3536 __in const uint8_t *vni,
3537 __in const uint8_t *inner_addr,
3538 __in const uint8_t *outer_addr);
3541 extern __checkReturn efx_rc_t
3542 efx_filter_spec_set_nvgre(
3543 __inout efx_filter_spec_t *spec,
3544 __in const uint8_t *vsid,
3545 __in const uint8_t *inner_addr,
3546 __in const uint8_t *outer_addr);
3548 #if EFSYS_OPT_RX_SCALE
3550 extern __checkReturn efx_rc_t
3551 efx_filter_spec_set_rss_context(
3552 __inout efx_filter_spec_t *spec,
3553 __in uint32_t rss_context);
3555 #endif /* EFSYS_OPT_FILTER */
3560 extern __checkReturn uint32_t
3562 __in_ecount(count) uint32_t const *input,
3564 __in uint32_t init);
3567 extern __checkReturn uint32_t
3569 __in_ecount(length) uint8_t const *input,
3571 __in uint32_t init);
3573 #if EFSYS_OPT_LICENSING
3577 typedef struct efx_key_stats_s {
3579 uint32_t eks_invalid;
3580 uint32_t eks_blacklisted;
3581 uint32_t eks_unverifiable;
3582 uint32_t eks_wrong_node;
3583 uint32_t eks_licensed_apps_lo;
3584 uint32_t eks_licensed_apps_hi;
3585 uint32_t eks_licensed_features_lo;
3586 uint32_t eks_licensed_features_hi;
3590 extern __checkReturn efx_rc_t
3592 __in efx_nic_t *enp);
3597 __in efx_nic_t *enp);
3600 extern __checkReturn boolean_t
3601 efx_lic_check_support(
3602 __in efx_nic_t *enp);
3605 extern __checkReturn efx_rc_t
3606 efx_lic_update_licenses(
3607 __in efx_nic_t *enp);
3610 extern __checkReturn efx_rc_t
3611 efx_lic_get_key_stats(
3612 __in efx_nic_t *enp,
3613 __out efx_key_stats_t *ksp);
3616 extern __checkReturn efx_rc_t
3618 __in efx_nic_t *enp,
3619 __in uint64_t app_id,
3620 __out boolean_t *licensedp);
3623 extern __checkReturn efx_rc_t
3625 __in efx_nic_t *enp,
3626 __in size_t buffer_size,
3627 __out uint32_t *typep,
3628 __out size_t *lengthp,
3629 __out_opt uint8_t *bufferp);
3633 extern __checkReturn efx_rc_t
3635 __in efx_nic_t *enp,
3636 __in_bcount(buffer_size)
3638 __in size_t buffer_size,
3639 __out uint32_t *startp);
3642 extern __checkReturn efx_rc_t
3644 __in efx_nic_t *enp,
3645 __in_bcount(buffer_size)
3647 __in size_t buffer_size,
3648 __in uint32_t offset,
3649 __out uint32_t *endp);
3652 extern __checkReturn __success(return != B_FALSE) boolean_t
3654 __in efx_nic_t *enp,
3655 __in_bcount(buffer_size)
3657 __in size_t buffer_size,
3658 __in uint32_t offset,
3659 __out uint32_t *startp,
3660 __out uint32_t *lengthp);
3663 extern __checkReturn __success(return != B_FALSE) boolean_t
3664 efx_lic_validate_key(
3665 __in efx_nic_t *enp,
3666 __in_bcount(length) caddr_t keyp,
3667 __in uint32_t length);
3670 extern __checkReturn efx_rc_t
3672 __in efx_nic_t *enp,
3673 __in_bcount(buffer_size)
3675 __in size_t buffer_size,
3676 __in uint32_t offset,
3677 __in uint32_t length,
3678 __out_bcount_part(key_max_size, *lengthp)
3680 __in size_t key_max_size,
3681 __out uint32_t *lengthp);
3684 extern __checkReturn efx_rc_t
3686 __in efx_nic_t *enp,
3687 __in_bcount(buffer_size)
3689 __in size_t buffer_size,
3690 __in uint32_t offset,
3691 __in_bcount(length) caddr_t keyp,
3692 __in uint32_t length,
3693 __out uint32_t *lengthp);
3696 extern __checkReturn efx_rc_t
3698 __in efx_nic_t *enp,
3699 __in_bcount(buffer_size)
3701 __in size_t buffer_size,
3702 __in uint32_t offset,
3703 __in uint32_t length,
3705 __out uint32_t *deltap);
3708 extern __checkReturn efx_rc_t
3709 efx_lic_create_partition(
3710 __in efx_nic_t *enp,
3711 __in_bcount(buffer_size)
3713 __in size_t buffer_size);
3715 extern __checkReturn efx_rc_t
3716 efx_lic_finish_partition(
3717 __in efx_nic_t *enp,
3718 __in_bcount(buffer_size)
3720 __in size_t buffer_size);
3722 #endif /* EFSYS_OPT_LICENSING */
3726 #if EFSYS_OPT_TUNNEL
3729 extern __checkReturn efx_rc_t
3731 __in efx_nic_t *enp);
3736 __in efx_nic_t *enp);
3739 * For overlay network encapsulation using UDP, the firmware needs to know
3740 * the configured UDP port for the overlay so it can decode encapsulated
3742 * The UDP port/protocol list is global.
3746 extern __checkReturn efx_rc_t
3747 efx_tunnel_config_udp_add(
3748 __in efx_nic_t *enp,
3749 __in uint16_t port /* host/cpu-endian */,
3750 __in efx_tunnel_protocol_t protocol);
3753 * Returns EBUSY if reconfiguration of the port is in progress in other thread.
3756 extern __checkReturn efx_rc_t
3757 efx_tunnel_config_udp_remove(
3758 __in efx_nic_t *enp,
3759 __in uint16_t port /* host/cpu-endian */,
3760 __in efx_tunnel_protocol_t protocol);
3763 * Returns EBUSY if reconfiguration of any of the tunnel entries
3764 * is in progress in other thread.
3767 extern __checkReturn efx_rc_t
3768 efx_tunnel_config_clear(
3769 __in efx_nic_t *enp);
3772 * Apply tunnel UDP ports configuration to hardware.
3774 * EAGAIN is returned if hardware will be reset (datapath and managment CPU
3778 extern __checkReturn efx_rc_t
3779 efx_tunnel_reconfigure(
3780 __in efx_nic_t *enp);
3782 #endif /* EFSYS_OPT_TUNNEL */
3784 #if EFSYS_OPT_FW_SUBVARIANT_AWARE
3787 * Firmware subvariant choice options.
3789 * It may be switched to no Tx checksum if attached drivers are either
3790 * preboot or firmware subvariant aware and no VIS are allocated.
3791 * If may be always switched to default explicitly using set request or
3792 * implicitly if unaware driver is attaching. If switching is done when
3793 * a driver is attached, it gets MC_REBOOT event and should recreate its
3796 * See SF-119419-TC DPDK Firmware Driver Interface and
3797 * SF-109306-TC EF10 for Driver Writers for details.
3799 typedef enum efx_nic_fw_subvariant_e {
3800 EFX_NIC_FW_SUBVARIANT_DEFAULT = 0,
3801 EFX_NIC_FW_SUBVARIANT_NO_TX_CSUM = 1,
3802 EFX_NIC_FW_SUBVARIANT_NTYPES
3803 } efx_nic_fw_subvariant_t;
3806 extern __checkReturn efx_rc_t
3807 efx_nic_get_fw_subvariant(
3808 __in efx_nic_t *enp,
3809 __out efx_nic_fw_subvariant_t *subvariantp);
3812 extern __checkReturn efx_rc_t
3813 efx_nic_set_fw_subvariant(
3814 __in efx_nic_t *enp,
3815 __in efx_nic_fw_subvariant_t subvariant);
3817 #endif /* EFSYS_OPT_FW_SUBVARIANT_AWARE */
3819 typedef enum efx_phy_fec_type_e {
3820 EFX_PHY_FEC_NONE = 0,
3823 } efx_phy_fec_type_t;
3826 extern __checkReturn efx_rc_t
3827 efx_phy_fec_type_get(
3828 __in efx_nic_t *enp,
3829 __out efx_phy_fec_type_t *typep);
3831 typedef struct efx_phy_link_state_s {
3832 uint32_t epls_adv_cap_mask;
3833 uint32_t epls_lp_cap_mask;
3834 uint32_t epls_ld_cap_mask;
3835 unsigned int epls_fcntl;
3836 efx_phy_fec_type_t epls_fec;
3837 efx_link_mode_t epls_link_mode;
3838 } efx_phy_link_state_t;
3841 extern __checkReturn efx_rc_t
3842 efx_phy_link_state_get(
3843 __in efx_nic_t *enp,
3844 __out efx_phy_link_state_t *eplsp);
3849 typedef uint32_t efx_vswitch_id_t;
3850 typedef uint32_t efx_vport_id_t;
3852 typedef enum efx_vswitch_type_e {
3853 EFX_VSWITCH_TYPE_VLAN = 1,
3854 EFX_VSWITCH_TYPE_VEB,
3855 /* VSWITCH_TYPE_VEPA: obsolete */
3856 EFX_VSWITCH_TYPE_MUX = 4,
3857 } efx_vswitch_type_t;
3859 typedef enum efx_vport_type_e {
3860 EFX_VPORT_TYPE_NORMAL = 4,
3861 EFX_VPORT_TYPE_EXPANSION,
3862 EFX_VPORT_TYPE_TEST,
3865 /* Unspecified VLAN ID to support disabling of VLAN filtering */
3866 #define EFX_FILTER_VID_UNSPEC 0xffff
3867 #define EFX_DEFAULT_VSWITCH_ID 1
3869 /* Default VF VLAN ID on creation */
3870 #define EFX_VF_VID_DEFAULT EFX_FILTER_VID_UNSPEC
3871 #define EFX_VPORT_ID_INVALID 0
3873 typedef struct efx_vport_config_s {
3874 /* Either VF index or 0xffff for PF */
3875 uint16_t evc_function;
3876 /* VLAN ID of the associated function */
3878 /* vport id shared with client driver */
3879 efx_vport_id_t evc_vport_id;
3880 /* MAC address of the associated function */
3881 uint8_t evc_mac_addr[EFX_MAC_ADDR_LEN];
3883 * vports created with this flag set may only transfer traffic on the
3884 * VLANs permitted by the vport. Also, an attempt to install filter with
3885 * VLAN will be refused unless requesting function has VLAN privilege.
3887 boolean_t evc_vlan_restrict;
3888 /* Whether this function is assigned or not */
3889 boolean_t evc_vport_assigned;
3890 } efx_vport_config_t;
3892 typedef struct efx_vswitch_s efx_vswitch_t;
3895 extern __checkReturn efx_rc_t
3897 __in efx_nic_t *enp);
3902 __in efx_nic_t *enp);
3905 extern __checkReturn efx_rc_t
3906 efx_evb_vswitch_create(
3907 __in efx_nic_t *enp,
3908 __in uint32_t num_vports,
3909 __inout_ecount(num_vports) efx_vport_config_t *vport_configp,
3910 __deref_out efx_vswitch_t **evpp);
3913 extern __checkReturn efx_rc_t
3914 efx_evb_vswitch_destroy(
3915 __in efx_nic_t *enp,
3916 __in efx_vswitch_t *evp);
3919 extern __checkReturn efx_rc_t
3920 efx_evb_vport_mac_set(
3921 __in efx_nic_t *enp,
3922 __in efx_vswitch_t *evp,
3923 __in efx_vport_id_t vport_id,
3924 __in_bcount(EFX_MAC_ADDR_LEN) uint8_t *addrp);
3927 extern __checkReturn efx_rc_t
3928 efx_evb_vport_vlan_set(
3929 __in efx_nic_t *enp,
3930 __in efx_vswitch_t *evp,
3931 __in efx_vport_id_t vport_id,
3935 extern __checkReturn efx_rc_t
3936 efx_evb_vport_reset(
3937 __in efx_nic_t *enp,
3938 __in efx_vswitch_t *evp,
3939 __in efx_vport_id_t vport_id,
3940 __in_bcount(EFX_MAC_ADDR_LEN) uint8_t *addrp,
3942 __out boolean_t *is_fn_resetp);
3945 extern __checkReturn efx_rc_t
3946 efx_evb_vport_stats(
3947 __in efx_nic_t *enp,
3948 __in efx_vswitch_t *evp,
3949 __in efx_vport_id_t vport_id,
3950 __out efsys_mem_t *stats_bufferp);
3952 #endif /* EFSYS_OPT_EVB */
3954 #if EFSYS_OPT_MCDI_PROXY_AUTH_SERVER
3956 typedef struct efx_proxy_auth_config_s {
3957 efsys_mem_t *request_bufferp;
3958 efsys_mem_t *response_bufferp;
3959 efsys_mem_t *status_bufferp;
3963 uint32_t handled_privileges;
3964 } efx_proxy_auth_config_t;
3966 typedef struct efx_proxy_cmd_params_s {
3969 uint8_t *request_bufferp;
3970 size_t request_size;
3971 uint8_t *response_bufferp;
3972 size_t response_size;
3973 size_t *response_size_actualp;
3974 } efx_proxy_cmd_params_t;
3977 extern __checkReturn efx_rc_t
3978 efx_proxy_auth_init(
3979 __in efx_nic_t *enp);
3983 efx_proxy_auth_fini(
3984 __in efx_nic_t *enp);
3987 extern __checkReturn efx_rc_t
3988 efx_proxy_auth_configure(
3989 __in efx_nic_t *enp,
3990 __in efx_proxy_auth_config_t *configp);
3993 extern __checkReturn efx_rc_t
3994 efx_proxy_auth_destroy(
3995 __in efx_nic_t *enp,
3996 __in uint32_t handled_privileges);
3999 extern __checkReturn efx_rc_t
4000 efx_proxy_auth_complete_request(
4001 __in efx_nic_t *enp,
4002 __in uint32_t fn_index,
4003 __in uint32_t proxy_result,
4004 __in uint32_t handle);
4007 extern __checkReturn efx_rc_t
4008 efx_proxy_auth_exec_cmd(
4009 __in efx_nic_t *enp,
4010 __inout efx_proxy_cmd_params_t *paramsp);
4013 extern __checkReturn efx_rc_t
4014 efx_proxy_auth_set_privilege_mask(
4015 __in efx_nic_t *enp,
4016 __in uint32_t vf_index,
4018 __in uint32_t value);
4021 extern __checkReturn efx_rc_t
4022 efx_proxy_auth_privilege_mask_get(
4023 __in efx_nic_t *enp,
4024 __in uint32_t pf_index,
4025 __in uint32_t vf_index,
4026 __out uint32_t *maskp);
4029 extern __checkReturn efx_rc_t
4030 efx_proxy_auth_privilege_modify(
4031 __in efx_nic_t *enp,
4032 __in uint32_t pf_index,
4033 __in uint32_t vf_index,
4034 __in uint32_t add_privileges_mask,
4035 __in uint32_t remove_privileges_mask);
4037 #endif /* EFSYS_OPT_MCDI_PROXY_AUTH_SERVER */
4042 extern __checkReturn efx_rc_t
4044 __in efx_nic_t *enp);
4049 __in efx_nic_t *enp);
4051 typedef struct efx_mae_limits_s {
4052 uint32_t eml_max_n_action_prios;
4056 extern __checkReturn efx_rc_t
4058 __in efx_nic_t *enp,
4059 __out efx_mae_limits_t *emlp);
4061 typedef enum efx_mae_rule_type_e {
4062 EFX_MAE_RULE_ACTION = 0,
4065 } efx_mae_rule_type_t;
4067 typedef struct efx_mae_match_spec_s efx_mae_match_spec_t;
4070 extern __checkReturn efx_rc_t
4071 efx_mae_match_spec_init(
4072 __in efx_nic_t *enp,
4073 __in efx_mae_rule_type_t type,
4075 __out efx_mae_match_spec_t **specp);
4079 efx_mae_match_spec_fini(
4080 __in efx_nic_t *enp,
4081 __in efx_mae_match_spec_t *spec);
4083 typedef enum efx_mae_field_id_e {
4084 EFX_MAE_FIELD_INGRESS_MPORT_SELECTOR = 0,
4085 EFX_MAE_FIELD_ETHER_TYPE_BE,
4086 EFX_MAE_FIELD_ETH_SADDR_BE,
4087 EFX_MAE_FIELD_ETH_DADDR_BE,
4090 } efx_mae_field_id_t;
4092 /* MPORT selector. Used to refer to MPORTs in match/action rules. */
4093 typedef struct efx_mport_sel_s {
4097 #define EFX_MPORT_NULL (0U)
4100 * Get MPORT selector of a physical port.
4102 * The resulting MPORT selector is opaque to the caller and can be
4103 * passed as an argument to efx_mae_match_spec_mport_set()
4104 * and efx_mae_action_set_populate_deliver().
4107 extern __checkReturn efx_rc_t
4108 efx_mae_mport_by_phy_port(
4109 __in uint32_t phy_port,
4110 __out efx_mport_sel_t *mportp);
4113 * Fields which have BE postfix in their named constants are expected
4114 * to be passed by callers in big-endian byte order. They will appear
4115 * in the MCDI buffer, which is a part of the match specification, in
4116 * the very same byte order, that is, no conversion will be performed.
4118 * Fields which don't have BE postfix in their named constants are in
4119 * host byte order. MCDI expects them to be little-endian, so the API
4120 * will take care to carry out conversion to little-endian byte order.
4121 * At the moment, the only field in host byte order is MPORT selector.
4124 extern __checkReturn efx_rc_t
4125 efx_mae_match_spec_field_set(
4126 __in efx_mae_match_spec_t *spec,
4127 __in efx_mae_field_id_t field_id,
4128 __in size_t value_size,
4129 __in_bcount(value_size) const uint8_t *value,
4130 __in size_t mask_size,
4131 __in_bcount(mask_size) const uint8_t *mask);
4133 /* If the mask argument is NULL, the API will use full mask by default. */
4135 extern __checkReturn efx_rc_t
4136 efx_mae_match_spec_mport_set(
4137 __in efx_mae_match_spec_t *spec,
4138 __in const efx_mport_sel_t *valuep,
4139 __in_opt const efx_mport_sel_t *maskp);
4142 * Make sure that match fields known by EFX have proper masks set
4143 * in the match specification as per requirements of SF-122526-TC.
4145 * In the case efx_mae_field_id_t lacks named identifiers for any
4146 * fields which the FW maintains with support status MATCH_ALWAYS,
4147 * the validation result may not be accurate.
4150 extern __checkReturn boolean_t
4151 efx_mae_match_spec_is_valid(
4152 __in efx_nic_t *enp,
4153 __in const efx_mae_match_spec_t *spec);
4155 typedef struct efx_mae_actions_s efx_mae_actions_t;
4158 extern __checkReturn efx_rc_t
4159 efx_mae_action_set_spec_init(
4160 __in efx_nic_t *enp,
4161 __out efx_mae_actions_t **specp);
4165 efx_mae_action_set_spec_fini(
4166 __in efx_nic_t *enp,
4167 __in efx_mae_actions_t *spec);
4170 extern __checkReturn efx_rc_t
4171 efx_mae_action_set_populate_deliver(
4172 __in efx_mae_actions_t *spec,
4173 __in const efx_mport_sel_t *mportp);
4176 extern __checkReturn boolean_t
4177 efx_mae_action_set_specs_equal(
4178 __in const efx_mae_actions_t *left,
4179 __in const efx_mae_actions_t *right);
4182 * Conduct a comparison to check whether two match specifications
4183 * of equal rule type (action / outer) and priority would map to
4184 * the very same rule class from the firmware's standpoint.
4187 extern __checkReturn efx_rc_t
4188 efx_mae_match_specs_class_cmp(
4189 __in efx_nic_t *enp,
4190 __in const efx_mae_match_spec_t *left,
4191 __in const efx_mae_match_spec_t *right,
4192 __out boolean_t *have_same_classp);
4194 #define EFX_MAE_RSRC_ID_INVALID UINT32_MAX
4197 typedef struct efx_mae_aset_id_s {
4199 } efx_mae_aset_id_t;
4202 extern __checkReturn efx_rc_t
4203 efx_mae_action_set_alloc(
4204 __in efx_nic_t *enp,
4205 __in const efx_mae_actions_t *spec,
4206 __out efx_mae_aset_id_t *aset_idp);
4209 extern __checkReturn efx_rc_t
4210 efx_mae_action_set_free(
4211 __in efx_nic_t *enp,
4212 __in const efx_mae_aset_id_t *aset_idp);
4214 #endif /* EFSYS_OPT_MAE */
4220 #endif /* _SYS_EFX_H */