1 /* SPDX-License-Identifier: BSD-3-Clause
3 * Copyright (c) 2006-2018 Solarflare Communications Inc.
10 #include "efx_annote.h"
12 #include "efx_check.h"
13 #include "efx_phy_ids.h"
19 #define EFX_STATIC_ASSERT(_cond) \
20 ((void)sizeof (char[(_cond) ? 1 : -1]))
22 #define EFX_ARRAY_SIZE(_array) \
23 (sizeof (_array) / sizeof ((_array)[0]))
25 #define EFX_FIELD_OFFSET(_type, _field) \
26 ((size_t)&(((_type *)0)->_field))
28 /* The macro expands divider twice */
29 #define EFX_DIV_ROUND_UP(_n, _d) (((_n) + (_d) - 1) / (_d))
33 typedef __success(return == 0) int efx_rc_t;
38 typedef enum efx_family_e {
40 EFX_FAMILY_FALCON, /* Obsolete and not supported */
42 EFX_FAMILY_HUNTINGTON,
48 extern __checkReturn efx_rc_t
52 __out efx_family_t *efp,
53 __out unsigned int *membarp);
56 #define EFX_PCI_VENID_SFC 0x1924
58 #define EFX_PCI_DEVID_FALCON 0x0710 /* SFC4000 */
60 #define EFX_PCI_DEVID_BETHPAGE 0x0803 /* SFC9020 */
61 #define EFX_PCI_DEVID_SIENA 0x0813 /* SFL9021 */
62 #define EFX_PCI_DEVID_SIENA_F1_UNINIT 0x0810
64 #define EFX_PCI_DEVID_HUNTINGTON_PF_UNINIT 0x0901
65 #define EFX_PCI_DEVID_FARMINGDALE 0x0903 /* SFC9120 PF */
66 #define EFX_PCI_DEVID_GREENPORT 0x0923 /* SFC9140 PF */
68 #define EFX_PCI_DEVID_FARMINGDALE_VF 0x1903 /* SFC9120 VF */
69 #define EFX_PCI_DEVID_GREENPORT_VF 0x1923 /* SFC9140 VF */
71 #define EFX_PCI_DEVID_MEDFORD_PF_UNINIT 0x0913
72 #define EFX_PCI_DEVID_MEDFORD 0x0A03 /* SFC9240 PF */
73 #define EFX_PCI_DEVID_MEDFORD_VF 0x1A03 /* SFC9240 VF */
75 #define EFX_PCI_DEVID_MEDFORD2_PF_UNINIT 0x0B13
76 #define EFX_PCI_DEVID_MEDFORD2 0x0B03 /* SFC9250 PF */
77 #define EFX_PCI_DEVID_MEDFORD2_VF 0x1B03 /* SFC9250 VF */
80 #define EFX_MEM_BAR_SIENA 2
82 #define EFX_MEM_BAR_HUNTINGTON_PF 2
83 #define EFX_MEM_BAR_HUNTINGTON_VF 0
85 #define EFX_MEM_BAR_MEDFORD_PF 2
86 #define EFX_MEM_BAR_MEDFORD_VF 0
88 #define EFX_MEM_BAR_MEDFORD2 0
109 /* Calculate the IEEE 802.3 CRC32 of a MAC addr */
110 extern __checkReturn uint32_t
112 __in uint32_t crc_init,
113 __in_ecount(length) uint8_t const *input,
117 /* Type prototypes */
119 typedef struct efx_rxq_s efx_rxq_t;
123 typedef struct efx_nic_s efx_nic_t;
125 extern __checkReturn efx_rc_t
127 __in efx_family_t family,
128 __in efsys_identifier_t *esip,
129 __in efsys_bar_t *esbp,
130 __in efsys_lock_t *eslp,
131 __deref_out efx_nic_t **enpp);
133 /* EFX_FW_VARIANT codes map one to one on MC_CMD_FW codes */
134 typedef enum efx_fw_variant_e {
135 EFX_FW_VARIANT_FULL_FEATURED,
136 EFX_FW_VARIANT_LOW_LATENCY,
137 EFX_FW_VARIANT_PACKED_STREAM,
138 EFX_FW_VARIANT_HIGH_TX_RATE,
139 EFX_FW_VARIANT_PACKED_STREAM_HASH_MODE_1,
140 EFX_FW_VARIANT_RULES_ENGINE,
142 EFX_FW_VARIANT_DONT_CARE = 0xffffffff
145 extern __checkReturn efx_rc_t
148 __in efx_fw_variant_t efv);
150 extern __checkReturn efx_rc_t
152 __in efx_nic_t *enp);
154 extern __checkReturn efx_rc_t
156 __in efx_nic_t *enp);
158 extern __checkReturn boolean_t
159 efx_nic_hw_unavailable(
160 __in efx_nic_t *enp);
163 efx_nic_set_hw_unavailable(
164 __in efx_nic_t *enp);
168 extern __checkReturn efx_rc_t
169 efx_nic_register_test(
170 __in efx_nic_t *enp);
172 #endif /* EFSYS_OPT_DIAG */
176 __in efx_nic_t *enp);
180 __in efx_nic_t *enp);
184 __in efx_nic_t *enp);
186 #define EFX_PCIE_LINK_SPEED_GEN1 1
187 #define EFX_PCIE_LINK_SPEED_GEN2 2
188 #define EFX_PCIE_LINK_SPEED_GEN3 3
190 typedef enum efx_pcie_link_performance_e {
191 EFX_PCIE_LINK_PERFORMANCE_UNKNOWN_BANDWIDTH,
192 EFX_PCIE_LINK_PERFORMANCE_SUBOPTIMAL_BANDWIDTH,
193 EFX_PCIE_LINK_PERFORMANCE_SUBOPTIMAL_LATENCY,
194 EFX_PCIE_LINK_PERFORMANCE_OPTIMAL
195 } efx_pcie_link_performance_t;
197 extern __checkReturn efx_rc_t
198 efx_nic_calculate_pcie_link_bandwidth(
199 __in uint32_t pcie_link_width,
200 __in uint32_t pcie_link_gen,
201 __out uint32_t *bandwidth_mbpsp);
203 extern __checkReturn efx_rc_t
204 efx_nic_check_pcie_link_speed(
206 __in uint32_t pcie_link_width,
207 __in uint32_t pcie_link_gen,
208 __out efx_pcie_link_performance_t *resultp);
212 #if EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD || EFSYS_OPT_MEDFORD2
213 /* Huntington and Medford require MCDIv2 commands */
214 #define WITH_MCDI_V2 1
217 typedef struct efx_mcdi_req_s efx_mcdi_req_t;
219 typedef enum efx_mcdi_exception_e {
220 EFX_MCDI_EXCEPTION_MC_REBOOT,
221 EFX_MCDI_EXCEPTION_MC_BADASSERT,
222 } efx_mcdi_exception_t;
224 #if EFSYS_OPT_MCDI_LOGGING
225 typedef enum efx_log_msg_e {
227 EFX_LOG_MCDI_REQUEST,
228 EFX_LOG_MCDI_RESPONSE,
230 #endif /* EFSYS_OPT_MCDI_LOGGING */
232 typedef struct efx_mcdi_transport_s {
234 efsys_mem_t *emt_dma_mem;
235 void (*emt_execute)(void *, efx_mcdi_req_t *);
236 void (*emt_ev_cpl)(void *);
237 void (*emt_exception)(void *, efx_mcdi_exception_t);
238 #if EFSYS_OPT_MCDI_LOGGING
239 void (*emt_logger)(void *, efx_log_msg_t,
240 void *, size_t, void *, size_t);
241 #endif /* EFSYS_OPT_MCDI_LOGGING */
242 #if EFSYS_OPT_MCDI_PROXY_AUTH
243 void (*emt_ev_proxy_response)(void *, uint32_t, efx_rc_t);
244 #endif /* EFSYS_OPT_MCDI_PROXY_AUTH */
245 } efx_mcdi_transport_t;
247 extern __checkReturn efx_rc_t
250 __in const efx_mcdi_transport_t *mtp);
252 extern __checkReturn efx_rc_t
254 __in efx_nic_t *enp);
258 __in efx_nic_t *enp);
261 efx_mcdi_get_timeout(
263 __in efx_mcdi_req_t *emrp,
264 __out uint32_t *usec_timeoutp);
267 efx_mcdi_request_start(
269 __in efx_mcdi_req_t *emrp,
270 __in boolean_t ev_cpl);
272 extern __checkReturn boolean_t
273 efx_mcdi_request_poll(
274 __in efx_nic_t *enp);
276 extern __checkReturn boolean_t
277 efx_mcdi_request_abort(
278 __in efx_nic_t *enp);
282 __in efx_nic_t *enp);
284 #endif /* EFSYS_OPT_MCDI */
288 #define EFX_NINTR_SIENA 1024
290 typedef enum efx_intr_type_e {
291 EFX_INTR_INVALID = 0,
297 #define EFX_INTR_SIZE (sizeof (efx_oword_t))
299 extern __checkReturn efx_rc_t
302 __in efx_intr_type_t type,
303 __in_opt efsys_mem_t *esmp);
307 __in efx_nic_t *enp);
311 __in efx_nic_t *enp);
314 efx_intr_disable_unlocked(
315 __in efx_nic_t *enp);
317 #define EFX_INTR_NEVQS 32
319 extern __checkReturn efx_rc_t
322 __in unsigned int level);
325 efx_intr_status_line(
327 __out boolean_t *fatalp,
328 __out uint32_t *maskp);
331 efx_intr_status_message(
333 __in unsigned int message,
334 __out boolean_t *fatalp);
338 __in efx_nic_t *enp);
342 __in efx_nic_t *enp);
346 #if EFSYS_OPT_MAC_STATS
348 /* START MKCONFIG GENERATED EfxHeaderMacBlock ea466a9bc8789994 */
349 typedef enum efx_mac_stat_e {
352 EFX_MAC_RX_UNICST_PKTS,
353 EFX_MAC_RX_MULTICST_PKTS,
354 EFX_MAC_RX_BRDCST_PKTS,
355 EFX_MAC_RX_PAUSE_PKTS,
356 EFX_MAC_RX_LE_64_PKTS,
357 EFX_MAC_RX_65_TO_127_PKTS,
358 EFX_MAC_RX_128_TO_255_PKTS,
359 EFX_MAC_RX_256_TO_511_PKTS,
360 EFX_MAC_RX_512_TO_1023_PKTS,
361 EFX_MAC_RX_1024_TO_15XX_PKTS,
362 EFX_MAC_RX_GE_15XX_PKTS,
364 EFX_MAC_RX_FCS_ERRORS,
365 EFX_MAC_RX_DROP_EVENTS,
366 EFX_MAC_RX_FALSE_CARRIER_ERRORS,
367 EFX_MAC_RX_SYMBOL_ERRORS,
368 EFX_MAC_RX_ALIGN_ERRORS,
369 EFX_MAC_RX_INTERNAL_ERRORS,
370 EFX_MAC_RX_JABBER_PKTS,
371 EFX_MAC_RX_LANE0_CHAR_ERR,
372 EFX_MAC_RX_LANE1_CHAR_ERR,
373 EFX_MAC_RX_LANE2_CHAR_ERR,
374 EFX_MAC_RX_LANE3_CHAR_ERR,
375 EFX_MAC_RX_LANE0_DISP_ERR,
376 EFX_MAC_RX_LANE1_DISP_ERR,
377 EFX_MAC_RX_LANE2_DISP_ERR,
378 EFX_MAC_RX_LANE3_DISP_ERR,
379 EFX_MAC_RX_MATCH_FAULT,
380 EFX_MAC_RX_NODESC_DROP_CNT,
383 EFX_MAC_TX_UNICST_PKTS,
384 EFX_MAC_TX_MULTICST_PKTS,
385 EFX_MAC_TX_BRDCST_PKTS,
386 EFX_MAC_TX_PAUSE_PKTS,
387 EFX_MAC_TX_LE_64_PKTS,
388 EFX_MAC_TX_65_TO_127_PKTS,
389 EFX_MAC_TX_128_TO_255_PKTS,
390 EFX_MAC_TX_256_TO_511_PKTS,
391 EFX_MAC_TX_512_TO_1023_PKTS,
392 EFX_MAC_TX_1024_TO_15XX_PKTS,
393 EFX_MAC_TX_GE_15XX_PKTS,
395 EFX_MAC_TX_SGL_COL_PKTS,
396 EFX_MAC_TX_MULT_COL_PKTS,
397 EFX_MAC_TX_EX_COL_PKTS,
398 EFX_MAC_TX_LATE_COL_PKTS,
400 EFX_MAC_TX_EX_DEF_PKTS,
401 EFX_MAC_PM_TRUNC_BB_OVERFLOW,
402 EFX_MAC_PM_DISCARD_BB_OVERFLOW,
403 EFX_MAC_PM_TRUNC_VFIFO_FULL,
404 EFX_MAC_PM_DISCARD_VFIFO_FULL,
405 EFX_MAC_PM_TRUNC_QBB,
406 EFX_MAC_PM_DISCARD_QBB,
407 EFX_MAC_PM_DISCARD_MAPPING,
408 EFX_MAC_RXDP_Q_DISABLED_PKTS,
409 EFX_MAC_RXDP_DI_DROPPED_PKTS,
410 EFX_MAC_RXDP_STREAMING_PKTS,
411 EFX_MAC_RXDP_HLB_FETCH,
412 EFX_MAC_RXDP_HLB_WAIT,
413 EFX_MAC_VADAPTER_RX_UNICAST_PACKETS,
414 EFX_MAC_VADAPTER_RX_UNICAST_BYTES,
415 EFX_MAC_VADAPTER_RX_MULTICAST_PACKETS,
416 EFX_MAC_VADAPTER_RX_MULTICAST_BYTES,
417 EFX_MAC_VADAPTER_RX_BROADCAST_PACKETS,
418 EFX_MAC_VADAPTER_RX_BROADCAST_BYTES,
419 EFX_MAC_VADAPTER_RX_BAD_PACKETS,
420 EFX_MAC_VADAPTER_RX_BAD_BYTES,
421 EFX_MAC_VADAPTER_RX_OVERFLOW,
422 EFX_MAC_VADAPTER_TX_UNICAST_PACKETS,
423 EFX_MAC_VADAPTER_TX_UNICAST_BYTES,
424 EFX_MAC_VADAPTER_TX_MULTICAST_PACKETS,
425 EFX_MAC_VADAPTER_TX_MULTICAST_BYTES,
426 EFX_MAC_VADAPTER_TX_BROADCAST_PACKETS,
427 EFX_MAC_VADAPTER_TX_BROADCAST_BYTES,
428 EFX_MAC_VADAPTER_TX_BAD_PACKETS,
429 EFX_MAC_VADAPTER_TX_BAD_BYTES,
430 EFX_MAC_VADAPTER_TX_OVERFLOW,
431 EFX_MAC_FEC_UNCORRECTED_ERRORS,
432 EFX_MAC_FEC_CORRECTED_ERRORS,
433 EFX_MAC_FEC_CORRECTED_SYMBOLS_LANE0,
434 EFX_MAC_FEC_CORRECTED_SYMBOLS_LANE1,
435 EFX_MAC_FEC_CORRECTED_SYMBOLS_LANE2,
436 EFX_MAC_FEC_CORRECTED_SYMBOLS_LANE3,
437 EFX_MAC_CTPIO_VI_BUSY_FALLBACK,
438 EFX_MAC_CTPIO_LONG_WRITE_SUCCESS,
439 EFX_MAC_CTPIO_MISSING_DBELL_FAIL,
440 EFX_MAC_CTPIO_OVERFLOW_FAIL,
441 EFX_MAC_CTPIO_UNDERFLOW_FAIL,
442 EFX_MAC_CTPIO_TIMEOUT_FAIL,
443 EFX_MAC_CTPIO_NONCONTIG_WR_FAIL,
444 EFX_MAC_CTPIO_FRM_CLOBBER_FAIL,
445 EFX_MAC_CTPIO_INVALID_WR_FAIL,
446 EFX_MAC_CTPIO_VI_CLOBBER_FALLBACK,
447 EFX_MAC_CTPIO_UNQUALIFIED_FALLBACK,
448 EFX_MAC_CTPIO_RUNT_FALLBACK,
449 EFX_MAC_CTPIO_SUCCESS,
450 EFX_MAC_CTPIO_FALLBACK,
451 EFX_MAC_CTPIO_POISON,
453 EFX_MAC_RXDP_SCATTER_DISABLED_TRUNC,
454 EFX_MAC_RXDP_HLB_IDLE,
455 EFX_MAC_RXDP_HLB_TIMEOUT,
459 /* END MKCONFIG GENERATED EfxHeaderMacBlock */
461 #endif /* EFSYS_OPT_MAC_STATS */
463 typedef enum efx_link_mode_e {
464 EFX_LINK_UNKNOWN = 0,
480 #define EFX_MAC_ADDR_LEN 6
482 #define EFX_VNI_OR_VSID_LEN 3
484 #define EFX_MAC_ADDR_IS_MULTICAST(_address) (((uint8_t *)_address)[0] & 0x01)
486 #define EFX_MAC_MULTICAST_LIST_MAX 256
488 #define EFX_MAC_SDU_MAX 9202
490 #define EFX_MAC_PDU_ADJUSTMENT \
494 + /* bug16011 */ 16) \
496 #define EFX_MAC_PDU(_sdu) \
497 P2ROUNDUP((_sdu) + EFX_MAC_PDU_ADJUSTMENT, 8)
500 * Due to the P2ROUNDUP in EFX_MAC_PDU(), EFX_MAC_SDU_FROM_PDU() may give
501 * the SDU rounded up slightly.
503 #define EFX_MAC_SDU_FROM_PDU(_pdu) ((_pdu) - EFX_MAC_PDU_ADJUSTMENT)
505 #define EFX_MAC_PDU_MIN 60
506 #define EFX_MAC_PDU_MAX EFX_MAC_PDU(EFX_MAC_SDU_MAX)
508 extern __checkReturn efx_rc_t
513 extern __checkReturn efx_rc_t
518 extern __checkReturn efx_rc_t
523 extern __checkReturn efx_rc_t
526 __in boolean_t all_unicst,
527 __in boolean_t mulcst,
528 __in boolean_t all_mulcst,
529 __in boolean_t brdcst);
531 extern __checkReturn efx_rc_t
532 efx_mac_multicast_list_set(
534 __in_ecount(6*count) uint8_t const *addrs,
537 extern __checkReturn efx_rc_t
538 efx_mac_filter_default_rxq_set(
541 __in boolean_t using_rss);
544 efx_mac_filter_default_rxq_clear(
545 __in efx_nic_t *enp);
547 extern __checkReturn efx_rc_t
550 __in boolean_t enabled);
552 extern __checkReturn efx_rc_t
555 __out boolean_t *mac_upp);
557 #define EFX_FCNTL_RESPOND 0x00000001
558 #define EFX_FCNTL_GENERATE 0x00000002
560 extern __checkReturn efx_rc_t
563 __in unsigned int fcntl,
564 __in boolean_t autoneg);
569 __out unsigned int *fcntl_wantedp,
570 __out unsigned int *fcntl_linkp);
573 #if EFSYS_OPT_MAC_STATS
577 extern __checkReturn const char *
580 __in unsigned int id);
582 #endif /* EFSYS_OPT_NAMES */
584 #define EFX_MAC_STATS_MASK_BITS_PER_PAGE (8 * sizeof (uint32_t))
586 #define EFX_MAC_STATS_MASK_NPAGES \
587 (P2ROUNDUP(EFX_MAC_NSTATS, EFX_MAC_STATS_MASK_BITS_PER_PAGE) / \
588 EFX_MAC_STATS_MASK_BITS_PER_PAGE)
591 * Get mask of MAC statistics supported by the hardware.
593 * If mask_size is insufficient to return the mask, EINVAL error is
594 * returned. EFX_MAC_STATS_MASK_NPAGES multiplied by size of the page
595 * (which is sizeof (uint32_t)) is sufficient.
597 extern __checkReturn efx_rc_t
598 efx_mac_stats_get_mask(
600 __out_bcount(mask_size) uint32_t *maskp,
601 __in size_t mask_size);
603 #define EFX_MAC_STAT_SUPPORTED(_mask, _stat) \
604 ((_mask)[(_stat) / EFX_MAC_STATS_MASK_BITS_PER_PAGE] & \
605 (1ULL << ((_stat) & (EFX_MAC_STATS_MASK_BITS_PER_PAGE - 1))))
608 extern __checkReturn efx_rc_t
610 __in efx_nic_t *enp);
613 * Upload mac statistics supported by the hardware into the given buffer.
615 * The DMA buffer must be 4Kbyte aligned and sized to hold at least
616 * efx_nic_cfg_t::enc_mac_stats_nstats 64bit counters.
618 * The hardware will only DMA statistics that it understands (of course).
619 * Drivers should not make any assumptions about which statistics are
620 * supported, especially when the statistics are generated by firmware.
622 * Thus, drivers should zero this buffer before use, so that not-understood
623 * statistics read back as zero.
625 extern __checkReturn efx_rc_t
626 efx_mac_stats_upload(
628 __in efsys_mem_t *esmp);
630 extern __checkReturn efx_rc_t
631 efx_mac_stats_periodic(
633 __in efsys_mem_t *esmp,
634 __in uint16_t period_ms,
635 __in boolean_t events);
637 extern __checkReturn efx_rc_t
638 efx_mac_stats_update(
640 __in efsys_mem_t *esmp,
641 __inout_ecount(EFX_MAC_NSTATS) efsys_stat_t *stat,
642 __inout_opt uint32_t *generationp);
644 #endif /* EFSYS_OPT_MAC_STATS */
648 typedef enum efx_mon_type_e {
660 __in efx_nic_t *enp);
662 #endif /* EFSYS_OPT_NAMES */
664 extern __checkReturn efx_rc_t
666 __in efx_nic_t *enp);
668 #if EFSYS_OPT_MON_STATS
670 #define EFX_MON_STATS_PAGE_SIZE 0x100
671 #define EFX_MON_MASK_ELEMENT_SIZE 32
673 /* START MKCONFIG GENERATED MonitorHeaderStatsBlock 78b65c8d5af9747b */
674 typedef enum efx_mon_stat_e {
675 EFX_MON_STAT_CONTROLLER_TEMP,
676 EFX_MON_STAT_PHY_COMMON_TEMP,
677 EFX_MON_STAT_CONTROLLER_COOLING,
678 EFX_MON_STAT_PHY0_TEMP,
679 EFX_MON_STAT_PHY0_COOLING,
680 EFX_MON_STAT_PHY1_TEMP,
681 EFX_MON_STAT_PHY1_COOLING,
687 EFX_MON_STAT_IN_12V0,
688 EFX_MON_STAT_IN_1V2A,
689 EFX_MON_STAT_IN_VREF,
690 EFX_MON_STAT_OUT_VAOE,
691 EFX_MON_STAT_AOE_TEMP,
692 EFX_MON_STAT_PSU_AOE_TEMP,
693 EFX_MON_STAT_PSU_TEMP,
699 EFX_MON_STAT_IN_VAOE,
700 EFX_MON_STAT_OUT_IAOE,
701 EFX_MON_STAT_IN_IAOE,
702 EFX_MON_STAT_NIC_POWER,
704 EFX_MON_STAT_IN_I0V9,
705 EFX_MON_STAT_IN_I1V2,
706 EFX_MON_STAT_IN_0V9_ADC,
707 EFX_MON_STAT_CONTROLLER_2_TEMP,
708 EFX_MON_STAT_VREG_INTERNAL_TEMP,
709 EFX_MON_STAT_VREG_0V9_TEMP,
710 EFX_MON_STAT_VREG_1V2_TEMP,
711 EFX_MON_STAT_CONTROLLER_VPTAT,
712 EFX_MON_STAT_CONTROLLER_INTERNAL_TEMP,
713 EFX_MON_STAT_CONTROLLER_VPTAT_EXTADC,
714 EFX_MON_STAT_CONTROLLER_INTERNAL_TEMP_EXTADC,
715 EFX_MON_STAT_AMBIENT_TEMP,
716 EFX_MON_STAT_AIRFLOW,
717 EFX_MON_STAT_VDD08D_VSS08D_CSR,
718 EFX_MON_STAT_VDD08D_VSS08D_CSR_EXTADC,
719 EFX_MON_STAT_HOTPOINT_TEMP,
720 EFX_MON_STAT_PHY_POWER_PORT0,
721 EFX_MON_STAT_PHY_POWER_PORT1,
722 EFX_MON_STAT_MUM_VCC,
723 EFX_MON_STAT_IN_0V9_A,
724 EFX_MON_STAT_IN_I0V9_A,
725 EFX_MON_STAT_VREG_0V9_A_TEMP,
726 EFX_MON_STAT_IN_0V9_B,
727 EFX_MON_STAT_IN_I0V9_B,
728 EFX_MON_STAT_VREG_0V9_B_TEMP,
729 EFX_MON_STAT_CCOM_AVREG_1V2_SUPPLY,
730 EFX_MON_STAT_CCOM_AVREG_1V2_SUPPLY_EXTADC,
731 EFX_MON_STAT_CCOM_AVREG_1V8_SUPPLY,
732 EFX_MON_STAT_CCOM_AVREG_1V8_SUPPLY_EXTADC,
733 EFX_MON_STAT_CONTROLLER_MASTER_VPTAT,
734 EFX_MON_STAT_CONTROLLER_MASTER_INTERNAL_TEMP,
735 EFX_MON_STAT_CONTROLLER_MASTER_VPTAT_EXTADC,
736 EFX_MON_STAT_CONTROLLER_MASTER_INTERNAL_TEMP_EXTADC,
737 EFX_MON_STAT_CONTROLLER_SLAVE_VPTAT,
738 EFX_MON_STAT_CONTROLLER_SLAVE_INTERNAL_TEMP,
739 EFX_MON_STAT_CONTROLLER_SLAVE_VPTAT_EXTADC,
740 EFX_MON_STAT_CONTROLLER_SLAVE_INTERNAL_TEMP_EXTADC,
741 EFX_MON_STAT_SODIMM_VOUT,
742 EFX_MON_STAT_SODIMM_0_TEMP,
743 EFX_MON_STAT_SODIMM_1_TEMP,
744 EFX_MON_STAT_PHY0_VCC,
745 EFX_MON_STAT_PHY1_VCC,
746 EFX_MON_STAT_CONTROLLER_TDIODE_TEMP,
747 EFX_MON_STAT_BOARD_FRONT_TEMP,
748 EFX_MON_STAT_BOARD_BACK_TEMP,
749 EFX_MON_STAT_IN_I1V8,
750 EFX_MON_STAT_IN_I2V5,
751 EFX_MON_STAT_IN_I3V3,
752 EFX_MON_STAT_IN_I12V0,
754 EFX_MON_STAT_IN_I1V3,
758 /* END MKCONFIG GENERATED MonitorHeaderStatsBlock */
760 typedef enum efx_mon_stat_state_e {
761 EFX_MON_STAT_STATE_OK = 0,
762 EFX_MON_STAT_STATE_WARNING = 1,
763 EFX_MON_STAT_STATE_FATAL = 2,
764 EFX_MON_STAT_STATE_BROKEN = 3,
765 EFX_MON_STAT_STATE_NO_READING = 4,
766 } efx_mon_stat_state_t;
768 typedef enum efx_mon_stat_unit_e {
769 EFX_MON_STAT_UNIT_UNKNOWN = 0,
770 EFX_MON_STAT_UNIT_BOOL,
771 EFX_MON_STAT_UNIT_TEMP_C,
772 EFX_MON_STAT_UNIT_VOLTAGE_MV,
773 EFX_MON_STAT_UNIT_CURRENT_MA,
774 EFX_MON_STAT_UNIT_POWER_W,
775 EFX_MON_STAT_UNIT_RPM,
777 } efx_mon_stat_unit_t;
779 typedef struct efx_mon_stat_value_s {
781 efx_mon_stat_state_t emsv_state;
782 efx_mon_stat_unit_t emsv_unit;
783 } efx_mon_stat_value_t;
785 typedef struct efx_mon_limit_value_s {
786 uint16_t emlv_warning_min;
787 uint16_t emlv_warning_max;
788 uint16_t emlv_fatal_min;
789 uint16_t emlv_fatal_max;
790 } efx_mon_stat_limits_t;
792 typedef enum efx_mon_stat_portmask_e {
793 EFX_MON_STAT_PORTMAP_NONE = 0,
794 EFX_MON_STAT_PORTMAP_PORT0 = 1,
795 EFX_MON_STAT_PORTMAP_PORT1 = 2,
796 EFX_MON_STAT_PORTMAP_PORT2 = 3,
797 EFX_MON_STAT_PORTMAP_PORT3 = 4,
798 EFX_MON_STAT_PORTMAP_ALL = (-1),
799 EFX_MON_STAT_PORTMAP_UNKNOWN = (-2)
800 } efx_mon_stat_portmask_t;
807 __in efx_mon_stat_t id);
810 efx_mon_stat_description(
812 __in efx_mon_stat_t id);
814 #endif /* EFSYS_OPT_NAMES */
816 extern __checkReturn boolean_t
817 efx_mon_mcdi_to_efx_stat(
819 __out efx_mon_stat_t *statp);
821 extern __checkReturn boolean_t
822 efx_mon_get_stat_unit(
823 __in efx_mon_stat_t stat,
824 __out efx_mon_stat_unit_t *unitp);
826 extern __checkReturn boolean_t
827 efx_mon_get_stat_portmap(
828 __in efx_mon_stat_t stat,
829 __out efx_mon_stat_portmask_t *maskp);
831 extern __checkReturn efx_rc_t
832 efx_mon_stats_update(
834 __in efsys_mem_t *esmp,
835 __inout_ecount(EFX_MON_NSTATS) efx_mon_stat_value_t *values);
837 extern __checkReturn efx_rc_t
838 efx_mon_limits_update(
840 __inout_ecount(EFX_MON_NSTATS) efx_mon_stat_limits_t *values);
842 #endif /* EFSYS_OPT_MON_STATS */
846 __in efx_nic_t *enp);
850 extern __checkReturn efx_rc_t
852 __in efx_nic_t *enp);
854 #if EFSYS_OPT_PHY_LED_CONTROL
856 typedef enum efx_phy_led_mode_e {
857 EFX_PHY_LED_DEFAULT = 0,
862 } efx_phy_led_mode_t;
864 extern __checkReturn efx_rc_t
867 __in efx_phy_led_mode_t mode);
869 #endif /* EFSYS_OPT_PHY_LED_CONTROL */
871 extern __checkReturn efx_rc_t
873 __in efx_nic_t *enp);
875 #if EFSYS_OPT_LOOPBACK
877 typedef enum efx_loopback_type_e {
878 EFX_LOOPBACK_OFF = 0,
879 EFX_LOOPBACK_DATA = 1,
880 EFX_LOOPBACK_GMAC = 2,
881 EFX_LOOPBACK_XGMII = 3,
882 EFX_LOOPBACK_XGXS = 4,
883 EFX_LOOPBACK_XAUI = 5,
884 EFX_LOOPBACK_GMII = 6,
885 EFX_LOOPBACK_SGMII = 7,
886 EFX_LOOPBACK_XGBR = 8,
887 EFX_LOOPBACK_XFI = 9,
888 EFX_LOOPBACK_XAUI_FAR = 10,
889 EFX_LOOPBACK_GMII_FAR = 11,
890 EFX_LOOPBACK_SGMII_FAR = 12,
891 EFX_LOOPBACK_XFI_FAR = 13,
892 EFX_LOOPBACK_GPHY = 14,
893 EFX_LOOPBACK_PHY_XS = 15,
894 EFX_LOOPBACK_PCS = 16,
895 EFX_LOOPBACK_PMA_PMD = 17,
896 EFX_LOOPBACK_XPORT = 18,
897 EFX_LOOPBACK_XGMII_WS = 19,
898 EFX_LOOPBACK_XAUI_WS = 20,
899 EFX_LOOPBACK_XAUI_WS_FAR = 21,
900 EFX_LOOPBACK_XAUI_WS_NEAR = 22,
901 EFX_LOOPBACK_GMII_WS = 23,
902 EFX_LOOPBACK_XFI_WS = 24,
903 EFX_LOOPBACK_XFI_WS_FAR = 25,
904 EFX_LOOPBACK_PHYXS_WS = 26,
905 EFX_LOOPBACK_PMA_INT = 27,
906 EFX_LOOPBACK_SD_NEAR = 28,
907 EFX_LOOPBACK_SD_FAR = 29,
908 EFX_LOOPBACK_PMA_INT_WS = 30,
909 EFX_LOOPBACK_SD_FEP2_WS = 31,
910 EFX_LOOPBACK_SD_FEP1_5_WS = 32,
911 EFX_LOOPBACK_SD_FEP_WS = 33,
912 EFX_LOOPBACK_SD_FES_WS = 34,
913 EFX_LOOPBACK_AOE_INT_NEAR = 35,
914 EFX_LOOPBACK_DATA_WS = 36,
915 EFX_LOOPBACK_FORCE_EXT_LINK = 37,
917 } efx_loopback_type_t;
919 typedef enum efx_loopback_kind_e {
920 EFX_LOOPBACK_KIND_OFF = 0,
921 EFX_LOOPBACK_KIND_ALL,
922 EFX_LOOPBACK_KIND_MAC,
923 EFX_LOOPBACK_KIND_PHY,
925 } efx_loopback_kind_t;
929 __in efx_loopback_kind_t loopback_kind,
930 __out efx_qword_t *maskp);
932 extern __checkReturn efx_rc_t
933 efx_port_loopback_set(
935 __in efx_link_mode_t link_mode,
936 __in efx_loopback_type_t type);
940 extern __checkReturn const char *
941 efx_loopback_type_name(
943 __in efx_loopback_type_t type);
945 #endif /* EFSYS_OPT_NAMES */
947 #endif /* EFSYS_OPT_LOOPBACK */
949 extern __checkReturn efx_rc_t
952 __out_opt efx_link_mode_t *link_modep);
956 __in efx_nic_t *enp);
958 typedef enum efx_phy_cap_type_e {
959 EFX_PHY_CAP_INVALID = 0,
966 EFX_PHY_CAP_10000FDX,
970 EFX_PHY_CAP_40000FDX,
972 EFX_PHY_CAP_100000FDX,
973 EFX_PHY_CAP_25000FDX,
974 EFX_PHY_CAP_50000FDX,
975 EFX_PHY_CAP_BASER_FEC,
976 EFX_PHY_CAP_BASER_FEC_REQUESTED,
978 EFX_PHY_CAP_RS_FEC_REQUESTED,
979 EFX_PHY_CAP_25G_BASER_FEC,
980 EFX_PHY_CAP_25G_BASER_FEC_REQUESTED,
982 } efx_phy_cap_type_t;
985 #define EFX_PHY_CAP_CURRENT 0x00000000
986 #define EFX_PHY_CAP_DEFAULT 0x00000001
987 #define EFX_PHY_CAP_PERM 0x00000002
993 __out uint32_t *maskp);
995 extern __checkReturn efx_rc_t
1002 __in efx_nic_t *enp,
1003 __out uint32_t *maskp);
1005 extern __checkReturn efx_rc_t
1007 __in efx_nic_t *enp,
1008 __out uint32_t *ouip);
1010 typedef enum efx_phy_media_type_e {
1011 EFX_PHY_MEDIA_INVALID = 0,
1016 EFX_PHY_MEDIA_SFP_PLUS,
1017 EFX_PHY_MEDIA_BASE_T,
1018 EFX_PHY_MEDIA_QSFP_PLUS,
1019 EFX_PHY_MEDIA_NTYPES
1020 } efx_phy_media_type_t;
1023 * Get the type of medium currently used. If the board has ports for
1024 * modules, a module is present, and we recognise the media type of
1025 * the module, then this will be the media type of the module.
1026 * Otherwise it will be the media type of the port.
1029 efx_phy_media_type_get(
1030 __in efx_nic_t *enp,
1031 __out efx_phy_media_type_t *typep);
1034 * 2-wire device address of the base information in accordance with SFF-8472
1035 * Diagnostic Monitoring Interface for Optical Transceivers section
1036 * 4 Memory Organization.
1038 #define EFX_PHY_MEDIA_INFO_DEV_ADDR_SFP_BASE 0xA0
1041 * 2-wire device address of the digital diagnostics monitoring interface
1042 * in accordance with SFF-8472 Diagnostic Monitoring Interface for Optical
1043 * Transceivers section 4 Memory Organization.
1045 #define EFX_PHY_MEDIA_INFO_DEV_ADDR_SFP_DDM 0xA2
1048 * Hard wired 2-wire device address for QSFP+ in accordance with SFF-8436
1049 * QSFP+ 10 Gbs 4X PLUGGABLE TRANSCEIVER section 7.4 Device Addressing and
1052 #define EFX_PHY_MEDIA_INFO_DEV_ADDR_QSFP 0xA0
1055 * Maximum accessible data offset for PHY module information.
1057 #define EFX_PHY_MEDIA_INFO_MAX_OFFSET 0x100
1060 extern __checkReturn efx_rc_t
1061 efx_phy_module_get_info(
1062 __in efx_nic_t *enp,
1063 __in uint8_t dev_addr,
1066 __out_bcount(len) uint8_t *data);
1068 #if EFSYS_OPT_PHY_STATS
1070 /* START MKCONFIG GENERATED PhyHeaderStatsBlock 30ed56ad501f8e36 */
1071 typedef enum efx_phy_stat_e {
1073 EFX_PHY_STAT_PMA_PMD_LINK_UP,
1074 EFX_PHY_STAT_PMA_PMD_RX_FAULT,
1075 EFX_PHY_STAT_PMA_PMD_TX_FAULT,
1076 EFX_PHY_STAT_PMA_PMD_REV_A,
1077 EFX_PHY_STAT_PMA_PMD_REV_B,
1078 EFX_PHY_STAT_PMA_PMD_REV_C,
1079 EFX_PHY_STAT_PMA_PMD_REV_D,
1080 EFX_PHY_STAT_PCS_LINK_UP,
1081 EFX_PHY_STAT_PCS_RX_FAULT,
1082 EFX_PHY_STAT_PCS_TX_FAULT,
1083 EFX_PHY_STAT_PCS_BER,
1084 EFX_PHY_STAT_PCS_BLOCK_ERRORS,
1085 EFX_PHY_STAT_PHY_XS_LINK_UP,
1086 EFX_PHY_STAT_PHY_XS_RX_FAULT,
1087 EFX_PHY_STAT_PHY_XS_TX_FAULT,
1088 EFX_PHY_STAT_PHY_XS_ALIGN,
1089 EFX_PHY_STAT_PHY_XS_SYNC_A,
1090 EFX_PHY_STAT_PHY_XS_SYNC_B,
1091 EFX_PHY_STAT_PHY_XS_SYNC_C,
1092 EFX_PHY_STAT_PHY_XS_SYNC_D,
1093 EFX_PHY_STAT_AN_LINK_UP,
1094 EFX_PHY_STAT_AN_MASTER,
1095 EFX_PHY_STAT_AN_LOCAL_RX_OK,
1096 EFX_PHY_STAT_AN_REMOTE_RX_OK,
1097 EFX_PHY_STAT_CL22EXT_LINK_UP,
1102 EFX_PHY_STAT_PMA_PMD_SIGNAL_A,
1103 EFX_PHY_STAT_PMA_PMD_SIGNAL_B,
1104 EFX_PHY_STAT_PMA_PMD_SIGNAL_C,
1105 EFX_PHY_STAT_PMA_PMD_SIGNAL_D,
1106 EFX_PHY_STAT_AN_COMPLETE,
1107 EFX_PHY_STAT_PMA_PMD_REV_MAJOR,
1108 EFX_PHY_STAT_PMA_PMD_REV_MINOR,
1109 EFX_PHY_STAT_PMA_PMD_REV_MICRO,
1110 EFX_PHY_STAT_PCS_FW_VERSION_0,
1111 EFX_PHY_STAT_PCS_FW_VERSION_1,
1112 EFX_PHY_STAT_PCS_FW_VERSION_2,
1113 EFX_PHY_STAT_PCS_FW_VERSION_3,
1114 EFX_PHY_STAT_PCS_FW_BUILD_YY,
1115 EFX_PHY_STAT_PCS_FW_BUILD_MM,
1116 EFX_PHY_STAT_PCS_FW_BUILD_DD,
1117 EFX_PHY_STAT_PCS_OP_MODE,
1121 /* END MKCONFIG GENERATED PhyHeaderStatsBlock */
1127 __in efx_nic_t *enp,
1128 __in efx_phy_stat_t stat);
1130 #endif /* EFSYS_OPT_NAMES */
1132 #define EFX_PHY_STATS_SIZE 0x100
1134 extern __checkReturn efx_rc_t
1135 efx_phy_stats_update(
1136 __in efx_nic_t *enp,
1137 __in efsys_mem_t *esmp,
1138 __inout_ecount(EFX_PHY_NSTATS) uint32_t *stat);
1140 #endif /* EFSYS_OPT_PHY_STATS */
1145 typedef enum efx_bist_type_e {
1146 EFX_BIST_TYPE_UNKNOWN,
1147 EFX_BIST_TYPE_PHY_NORMAL,
1148 EFX_BIST_TYPE_PHY_CABLE_SHORT,
1149 EFX_BIST_TYPE_PHY_CABLE_LONG,
1150 EFX_BIST_TYPE_MC_MEM, /* Test the MC DMEM and IMEM */
1151 EFX_BIST_TYPE_SAT_MEM, /* Test the DMEM and IMEM of satellite cpus */
1152 EFX_BIST_TYPE_REG, /* Test the register memories */
1153 EFX_BIST_TYPE_NTYPES,
1156 typedef enum efx_bist_result_e {
1157 EFX_BIST_RESULT_UNKNOWN,
1158 EFX_BIST_RESULT_RUNNING,
1159 EFX_BIST_RESULT_PASSED,
1160 EFX_BIST_RESULT_FAILED,
1161 } efx_bist_result_t;
1163 typedef enum efx_phy_cable_status_e {
1164 EFX_PHY_CABLE_STATUS_OK,
1165 EFX_PHY_CABLE_STATUS_INVALID,
1166 EFX_PHY_CABLE_STATUS_OPEN,
1167 EFX_PHY_CABLE_STATUS_INTRAPAIRSHORT,
1168 EFX_PHY_CABLE_STATUS_INTERPAIRSHORT,
1169 EFX_PHY_CABLE_STATUS_BUSY,
1170 } efx_phy_cable_status_t;
1172 typedef enum efx_bist_value_e {
1173 EFX_BIST_PHY_CABLE_LENGTH_A,
1174 EFX_BIST_PHY_CABLE_LENGTH_B,
1175 EFX_BIST_PHY_CABLE_LENGTH_C,
1176 EFX_BIST_PHY_CABLE_LENGTH_D,
1177 EFX_BIST_PHY_CABLE_STATUS_A,
1178 EFX_BIST_PHY_CABLE_STATUS_B,
1179 EFX_BIST_PHY_CABLE_STATUS_C,
1180 EFX_BIST_PHY_CABLE_STATUS_D,
1181 EFX_BIST_FAULT_CODE,
1183 * Memory BIST specific values. These match to the MC_CMD_BIST_POLL
1189 EFX_BIST_MEM_EXPECT,
1190 EFX_BIST_MEM_ACTUAL,
1192 EFX_BIST_MEM_ECC_PARITY,
1193 EFX_BIST_MEM_ECC_FATAL,
1197 extern __checkReturn efx_rc_t
1198 efx_bist_enable_offline(
1199 __in efx_nic_t *enp);
1201 extern __checkReturn efx_rc_t
1203 __in efx_nic_t *enp,
1204 __in efx_bist_type_t type);
1206 extern __checkReturn efx_rc_t
1208 __in efx_nic_t *enp,
1209 __in efx_bist_type_t type,
1210 __out efx_bist_result_t *resultp,
1211 __out_opt uint32_t *value_maskp,
1212 __out_ecount_opt(count) unsigned long *valuesp,
1217 __in efx_nic_t *enp,
1218 __in efx_bist_type_t type);
1220 #endif /* EFSYS_OPT_BIST */
1222 #define EFX_FEATURE_IPV6 0x00000001
1223 #define EFX_FEATURE_LFSR_HASH_INSERT 0x00000002
1224 #define EFX_FEATURE_LINK_EVENTS 0x00000004
1225 #define EFX_FEATURE_PERIODIC_MAC_STATS 0x00000008
1226 #define EFX_FEATURE_MCDI 0x00000020
1227 #define EFX_FEATURE_LOOKAHEAD_SPLIT 0x00000040
1228 #define EFX_FEATURE_MAC_HEADER_FILTERS 0x00000080
1229 #define EFX_FEATURE_TURBO 0x00000100
1230 #define EFX_FEATURE_MCDI_DMA 0x00000200
1231 #define EFX_FEATURE_TX_SRC_FILTERS 0x00000400
1232 #define EFX_FEATURE_PIO_BUFFERS 0x00000800
1233 #define EFX_FEATURE_FW_ASSISTED_TSO 0x00001000
1234 #define EFX_FEATURE_FW_ASSISTED_TSO_V2 0x00002000
1235 #define EFX_FEATURE_PACKED_STREAM 0x00004000
1236 #define EFX_FEATURE_TXQ_CKSUM_OP_DESC 0x00008000
1238 typedef enum efx_tunnel_protocol_e {
1239 EFX_TUNNEL_PROTOCOL_NONE = 0,
1240 EFX_TUNNEL_PROTOCOL_VXLAN,
1241 EFX_TUNNEL_PROTOCOL_GENEVE,
1242 EFX_TUNNEL_PROTOCOL_NVGRE,
1244 } efx_tunnel_protocol_t;
1246 typedef enum efx_vi_window_shift_e {
1247 EFX_VI_WINDOW_SHIFT_INVALID = 0,
1248 EFX_VI_WINDOW_SHIFT_8K = 13,
1249 EFX_VI_WINDOW_SHIFT_16K = 14,
1250 EFX_VI_WINDOW_SHIFT_64K = 16,
1251 } efx_vi_window_shift_t;
1253 typedef struct efx_nic_cfg_s {
1254 uint32_t enc_board_type;
1255 uint32_t enc_phy_type;
1257 char enc_phy_name[21];
1259 char enc_phy_revision[21];
1260 efx_mon_type_t enc_mon_type;
1261 #if EFSYS_OPT_MON_STATS
1262 uint32_t enc_mon_stat_dma_buf_size;
1263 uint32_t enc_mon_stat_mask[(EFX_MON_NSTATS + 31) / 32];
1265 unsigned int enc_features;
1266 efx_vi_window_shift_t enc_vi_window_shift;
1267 uint8_t enc_mac_addr[6];
1268 uint8_t enc_port; /* PHY port number */
1269 uint32_t enc_intr_vec_base;
1270 uint32_t enc_intr_limit;
1271 uint32_t enc_evq_limit;
1272 uint32_t enc_txq_limit;
1273 uint32_t enc_rxq_limit;
1274 uint32_t enc_txq_max_ndescs;
1275 uint32_t enc_buftbl_limit;
1276 uint32_t enc_piobuf_limit;
1277 uint32_t enc_piobuf_size;
1278 uint32_t enc_piobuf_min_alloc_size;
1279 uint32_t enc_evq_timer_quantum_ns;
1280 uint32_t enc_evq_timer_max_us;
1281 uint32_t enc_clk_mult;
1282 uint32_t enc_rx_prefix_size;
1283 uint32_t enc_rx_buf_align_start;
1284 uint32_t enc_rx_buf_align_end;
1285 #if EFSYS_OPT_RX_SCALE
1286 uint32_t enc_rx_scale_max_exclusive_contexts;
1288 * Mask of supported hash algorithms.
1289 * Hash algorithm types are used as the bit indices.
1291 uint32_t enc_rx_scale_hash_alg_mask;
1293 * Indicates whether port numbers can be included to the
1294 * input data for hash computation.
1296 boolean_t enc_rx_scale_l4_hash_supported;
1297 boolean_t enc_rx_scale_additional_modes_supported;
1298 #endif /* EFSYS_OPT_RX_SCALE */
1299 #if EFSYS_OPT_LOOPBACK
1300 efx_qword_t enc_loopback_types[EFX_LINK_NMODES];
1301 #endif /* EFSYS_OPT_LOOPBACK */
1302 #if EFSYS_OPT_PHY_FLAGS
1303 uint32_t enc_phy_flags_mask;
1304 #endif /* EFSYS_OPT_PHY_FLAGS */
1305 #if EFSYS_OPT_PHY_LED_CONTROL
1306 uint32_t enc_led_mask;
1307 #endif /* EFSYS_OPT_PHY_LED_CONTROL */
1308 #if EFSYS_OPT_PHY_STATS
1309 uint64_t enc_phy_stat_mask;
1310 #endif /* EFSYS_OPT_PHY_STATS */
1312 uint8_t enc_mcdi_mdio_channel;
1313 #if EFSYS_OPT_PHY_STATS
1314 uint32_t enc_mcdi_phy_stat_mask;
1315 #endif /* EFSYS_OPT_PHY_STATS */
1316 #if EFSYS_OPT_MON_STATS
1317 uint32_t *enc_mcdi_sensor_maskp;
1318 uint32_t enc_mcdi_sensor_mask_size;
1319 #endif /* EFSYS_OPT_MON_STATS */
1320 #endif /* EFSYS_OPT_MCDI */
1322 uint32_t enc_bist_mask;
1323 #endif /* EFSYS_OPT_BIST */
1324 #if EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD || EFSYS_OPT_MEDFORD2
1327 uint32_t enc_privilege_mask;
1328 #endif /* EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD || EFSYS_OPT_MEDFORD2 */
1329 boolean_t enc_bug26807_workaround;
1330 boolean_t enc_bug35388_workaround;
1331 boolean_t enc_bug41750_workaround;
1332 boolean_t enc_bug61265_workaround;
1333 boolean_t enc_bug61297_workaround;
1334 boolean_t enc_rx_batching_enabled;
1335 /* Maximum number of descriptors completed in an rx event. */
1336 uint32_t enc_rx_batch_max;
1337 /* Number of rx descriptors the hardware requires for a push. */
1338 uint32_t enc_rx_push_align;
1339 /* Maximum amount of data in DMA descriptor */
1340 uint32_t enc_tx_dma_desc_size_max;
1342 * Boundary which DMA descriptor data must not cross or 0 if no
1345 uint32_t enc_tx_dma_desc_boundary;
1347 * Maximum number of bytes into the packet the TCP header can start for
1348 * the hardware to apply TSO packet edits.
1350 uint32_t enc_tx_tso_tcp_header_offset_limit;
1351 boolean_t enc_fw_assisted_tso_enabled;
1352 boolean_t enc_fw_assisted_tso_v2_enabled;
1353 boolean_t enc_fw_assisted_tso_v2_encap_enabled;
1354 /* Number of TSO contexts on the NIC (FATSOv2) */
1355 uint32_t enc_fw_assisted_tso_v2_n_contexts;
1356 boolean_t enc_hw_tx_insert_vlan_enabled;
1357 /* Number of PFs on the NIC */
1358 uint32_t enc_hw_pf_count;
1359 /* Datapath firmware vadapter/vport/vswitch support */
1360 boolean_t enc_datapath_cap_evb;
1361 boolean_t enc_rx_disable_scatter_supported;
1362 boolean_t enc_allow_set_mac_with_installed_filters;
1363 boolean_t enc_enhanced_set_mac_supported;
1364 boolean_t enc_init_evq_v2_supported;
1365 boolean_t enc_rx_packed_stream_supported;
1366 boolean_t enc_rx_var_packed_stream_supported;
1367 boolean_t enc_rx_es_super_buffer_supported;
1368 boolean_t enc_fw_subvariant_no_tx_csum_supported;
1369 boolean_t enc_pm_and_rxdp_counters;
1370 boolean_t enc_mac_stats_40g_tx_size_bins;
1371 uint32_t enc_tunnel_encapsulations_supported;
1373 * NIC global maximum for unique UDP tunnel ports shared by all
1376 uint32_t enc_tunnel_config_udp_entries_max;
1377 /* External port identifier */
1378 uint8_t enc_external_port;
1379 uint32_t enc_mcdi_max_payload_length;
1380 /* VPD may be per-PF or global */
1381 boolean_t enc_vpd_is_global;
1382 /* Minimum unidirectional bandwidth in Mb/s to max out all ports */
1383 uint32_t enc_required_pcie_bandwidth_mbps;
1384 uint32_t enc_max_pcie_link_gen;
1385 /* Firmware verifies integrity of NVRAM updates */
1386 uint32_t enc_nvram_update_verify_result_supported;
1387 /* Firmware support for extended MAC_STATS buffer */
1388 uint32_t enc_mac_stats_nstats;
1389 boolean_t enc_fec_counters;
1390 boolean_t enc_hlb_counters;
1391 /* Firmware support for "FLAG" and "MARK" filter actions */
1392 boolean_t enc_filter_action_flag_supported;
1393 boolean_t enc_filter_action_mark_supported;
1394 uint32_t enc_filter_action_mark_max;
1397 #define EFX_PCI_FUNCTION_IS_PF(_encp) ((_encp)->enc_vf == 0xffff)
1398 #define EFX_PCI_FUNCTION_IS_VF(_encp) ((_encp)->enc_vf != 0xffff)
1400 #define EFX_PCI_FUNCTION(_encp) \
1401 (EFX_PCI_FUNCTION_IS_PF(_encp) ? (_encp)->enc_pf : (_encp)->enc_vf)
1403 #define EFX_PCI_VF_PARENT(_encp) ((_encp)->enc_pf)
1405 extern const efx_nic_cfg_t *
1407 __in efx_nic_t *enp);
1409 /* RxDPCPU firmware id values by which FW variant can be identified */
1410 #define EFX_RXDP_FULL_FEATURED_FW_ID 0x0
1411 #define EFX_RXDP_LOW_LATENCY_FW_ID 0x1
1412 #define EFX_RXDP_PACKED_STREAM_FW_ID 0x2
1413 #define EFX_RXDP_RULES_ENGINE_FW_ID 0x5
1414 #define EFX_RXDP_DPDK_FW_ID 0x6
1416 typedef struct efx_nic_fw_info_s {
1417 /* Basic FW version information */
1418 uint16_t enfi_mc_fw_version[4];
1420 * If datapath capabilities can be detected,
1421 * additional FW information is to be shown
1423 boolean_t enfi_dpcpu_fw_ids_valid;
1424 /* Rx and Tx datapath CPU FW IDs */
1425 uint16_t enfi_rx_dpcpu_fw_id;
1426 uint16_t enfi_tx_dpcpu_fw_id;
1427 } efx_nic_fw_info_t;
1429 extern __checkReturn efx_rc_t
1430 efx_nic_get_fw_version(
1431 __in efx_nic_t *enp,
1432 __out efx_nic_fw_info_t *enfip);
1434 /* Driver resource limits (minimum required/maximum usable). */
1435 typedef struct efx_drv_limits_s {
1436 uint32_t edl_min_evq_count;
1437 uint32_t edl_max_evq_count;
1439 uint32_t edl_min_rxq_count;
1440 uint32_t edl_max_rxq_count;
1442 uint32_t edl_min_txq_count;
1443 uint32_t edl_max_txq_count;
1445 /* PIO blocks (sub-allocated from piobuf) */
1446 uint32_t edl_min_pio_alloc_size;
1447 uint32_t edl_max_pio_alloc_count;
1450 extern __checkReturn efx_rc_t
1451 efx_nic_set_drv_limits(
1452 __inout efx_nic_t *enp,
1453 __in efx_drv_limits_t *edlp);
1455 typedef enum efx_nic_region_e {
1456 EFX_REGION_VI, /* Memory BAR UC mapping */
1457 EFX_REGION_PIO_WRITE_VI, /* Memory BAR WC mapping */
1460 extern __checkReturn efx_rc_t
1461 efx_nic_get_bar_region(
1462 __in efx_nic_t *enp,
1463 __in efx_nic_region_t region,
1464 __out uint32_t *offsetp,
1465 __out size_t *sizep);
1467 extern __checkReturn efx_rc_t
1468 efx_nic_get_vi_pool(
1469 __in efx_nic_t *enp,
1470 __out uint32_t *evq_countp,
1471 __out uint32_t *rxq_countp,
1472 __out uint32_t *txq_countp);
1477 typedef enum efx_vpd_tag_e {
1484 typedef uint16_t efx_vpd_keyword_t;
1486 typedef struct efx_vpd_value_s {
1487 efx_vpd_tag_t evv_tag;
1488 efx_vpd_keyword_t evv_keyword;
1490 uint8_t evv_value[0x100];
1494 #define EFX_VPD_KEYWORD(x, y) ((x) | ((y) << 8))
1496 extern __checkReturn efx_rc_t
1498 __in efx_nic_t *enp);
1500 extern __checkReturn efx_rc_t
1502 __in efx_nic_t *enp,
1503 __out size_t *sizep);
1505 extern __checkReturn efx_rc_t
1507 __in efx_nic_t *enp,
1508 __out_bcount(size) caddr_t data,
1511 extern __checkReturn efx_rc_t
1513 __in efx_nic_t *enp,
1514 __in_bcount(size) caddr_t data,
1517 extern __checkReturn efx_rc_t
1519 __in efx_nic_t *enp,
1520 __in_bcount(size) caddr_t data,
1523 extern __checkReturn efx_rc_t
1525 __in efx_nic_t *enp,
1526 __in_bcount(size) caddr_t data,
1528 __inout efx_vpd_value_t *evvp);
1530 extern __checkReturn efx_rc_t
1532 __in efx_nic_t *enp,
1533 __inout_bcount(size) caddr_t data,
1535 __in efx_vpd_value_t *evvp);
1537 extern __checkReturn efx_rc_t
1539 __in efx_nic_t *enp,
1540 __inout_bcount(size) caddr_t data,
1542 __out efx_vpd_value_t *evvp,
1543 __inout unsigned int *contp);
1545 extern __checkReturn efx_rc_t
1547 __in efx_nic_t *enp,
1548 __in_bcount(size) caddr_t data,
1553 __in efx_nic_t *enp);
1555 #endif /* EFSYS_OPT_VPD */
1561 typedef enum efx_nvram_type_e {
1562 EFX_NVRAM_INVALID = 0,
1564 EFX_NVRAM_BOOTROM_CFG,
1565 EFX_NVRAM_MC_FIRMWARE,
1566 EFX_NVRAM_MC_GOLDEN,
1572 EFX_NVRAM_FPGA_BACKUP,
1573 EFX_NVRAM_DYNAMIC_CFG,
1576 EFX_NVRAM_MUM_FIRMWARE,
1577 EFX_NVRAM_DYNCONFIG_DEFAULTS,
1578 EFX_NVRAM_ROMCONFIG_DEFAULTS,
1582 extern __checkReturn efx_rc_t
1584 __in efx_nic_t *enp);
1588 extern __checkReturn efx_rc_t
1590 __in efx_nic_t *enp);
1592 #endif /* EFSYS_OPT_DIAG */
1594 extern __checkReturn efx_rc_t
1596 __in efx_nic_t *enp,
1597 __in efx_nvram_type_t type,
1598 __out size_t *sizep);
1600 extern __checkReturn efx_rc_t
1602 __in efx_nic_t *enp,
1603 __in efx_nvram_type_t type,
1604 __out_opt size_t *pref_chunkp);
1606 extern __checkReturn efx_rc_t
1607 efx_nvram_rw_finish(
1608 __in efx_nic_t *enp,
1609 __in efx_nvram_type_t type,
1610 __out_opt uint32_t *verify_resultp);
1612 extern __checkReturn efx_rc_t
1613 efx_nvram_get_version(
1614 __in efx_nic_t *enp,
1615 __in efx_nvram_type_t type,
1616 __out uint32_t *subtypep,
1617 __out_ecount(4) uint16_t version[4]);
1619 extern __checkReturn efx_rc_t
1620 efx_nvram_read_chunk(
1621 __in efx_nic_t *enp,
1622 __in efx_nvram_type_t type,
1623 __in unsigned int offset,
1624 __out_bcount(size) caddr_t data,
1627 extern __checkReturn efx_rc_t
1628 efx_nvram_read_backup(
1629 __in efx_nic_t *enp,
1630 __in efx_nvram_type_t type,
1631 __in unsigned int offset,
1632 __out_bcount(size) caddr_t data,
1635 extern __checkReturn efx_rc_t
1636 efx_nvram_set_version(
1637 __in efx_nic_t *enp,
1638 __in efx_nvram_type_t type,
1639 __in_ecount(4) uint16_t version[4]);
1641 extern __checkReturn efx_rc_t
1643 __in efx_nic_t *enp,
1644 __in efx_nvram_type_t type,
1645 __in_bcount(partn_size) caddr_t partn_data,
1646 __in size_t partn_size);
1648 extern __checkReturn efx_rc_t
1650 __in efx_nic_t *enp,
1651 __in efx_nvram_type_t type);
1653 extern __checkReturn efx_rc_t
1654 efx_nvram_write_chunk(
1655 __in efx_nic_t *enp,
1656 __in efx_nvram_type_t type,
1657 __in unsigned int offset,
1658 __in_bcount(size) caddr_t data,
1663 __in efx_nic_t *enp);
1665 #endif /* EFSYS_OPT_NVRAM */
1667 #if EFSYS_OPT_BOOTCFG
1669 /* Report size and offset of bootcfg sector in NVRAM partition. */
1670 extern __checkReturn efx_rc_t
1671 efx_bootcfg_sector_info(
1672 __in efx_nic_t *enp,
1674 __out_opt uint32_t *sector_countp,
1675 __out size_t *offsetp,
1676 __out size_t *max_sizep);
1679 * Copy bootcfg sector data to a target buffer which may differ in size.
1680 * Optionally corrects format errors in source buffer.
1683 efx_bootcfg_copy_sector(
1684 __in efx_nic_t *enp,
1685 __inout_bcount(sector_length)
1687 __in size_t sector_length,
1688 __out_bcount(data_size) uint8_t *data,
1689 __in size_t data_size,
1690 __in boolean_t handle_format_errors);
1694 __in efx_nic_t *enp,
1695 __out_bcount(size) uint8_t *data,
1700 __in efx_nic_t *enp,
1701 __in_bcount(size) uint8_t *data,
1706 * Processing routines for buffers arranged in the DHCP/BOOTP option format
1707 * (see https://tools.ietf.org/html/rfc1533)
1709 * Summarising the format: the buffer is a sequence of options. All options
1710 * begin with a tag octet, which uniquely identifies the option. Fixed-
1711 * length options without data consist of only a tag octet. Only options PAD
1712 * (0) and END (255) are fixed length. All other options are variable-length
1713 * with a length octet following the tag octet. The value of the length
1714 * octet does not include the two octets specifying the tag and length. The
1715 * length octet is followed by "length" octets of data.
1717 * Option data may be a sequence of sub-options in the same format. The data
1718 * content of the encapsulating option is one or more encapsulated sub-options,
1719 * with no terminating END tag is required.
1721 * To be valid, the top-level sequence of options should be terminated by an
1722 * END tag. The buffer should be padded with the PAD byte.
1724 * When stored to NVRAM, the DHCP option format buffer is preceded by a
1725 * checksum octet. The full buffer (including after the END tag) contributes
1726 * to the checksum, hence the need to fill the buffer to the end with PAD.
1729 #define EFX_DHCP_END ((uint8_t)0xff)
1730 #define EFX_DHCP_PAD ((uint8_t)0)
1732 #define EFX_DHCP_ENCAP_OPT(encapsulator, encapsulated) \
1733 (uint16_t)(((encapsulator) << 8) | (encapsulated))
1735 extern __checkReturn uint8_t
1737 __in_bcount(size) uint8_t const *data,
1740 extern __checkReturn efx_rc_t
1742 __in_bcount(size) uint8_t const *data,
1744 __out_opt size_t *usedp);
1746 extern __checkReturn efx_rc_t
1748 __in_bcount(buffer_length) uint8_t *bufferp,
1749 __in size_t buffer_length,
1751 __deref_out uint8_t **valuepp,
1752 __out size_t *value_lengthp);
1754 extern __checkReturn efx_rc_t
1756 __in_bcount(buffer_length) uint8_t *bufferp,
1757 __in size_t buffer_length,
1758 __deref_out uint8_t **endpp);
1761 extern __checkReturn efx_rc_t
1762 efx_dhcp_delete_tag(
1763 __inout_bcount(buffer_length) uint8_t *bufferp,
1764 __in size_t buffer_length,
1767 extern __checkReturn efx_rc_t
1769 __inout_bcount(buffer_length) uint8_t *bufferp,
1770 __in size_t buffer_length,
1772 __in_bcount_opt(value_length) uint8_t *valuep,
1773 __in size_t value_length);
1775 extern __checkReturn efx_rc_t
1776 efx_dhcp_update_tag(
1777 __inout_bcount(buffer_length) uint8_t *bufferp,
1778 __in size_t buffer_length,
1780 __in uint8_t *value_locationp,
1781 __in_bcount_opt(value_length) uint8_t *valuep,
1782 __in size_t value_length);
1785 #endif /* EFSYS_OPT_BOOTCFG */
1787 #if EFSYS_OPT_IMAGE_LAYOUT
1789 #include "ef10_signed_image_layout.h"
1792 * Image header used in unsigned and signed image layouts (see SF-102785-PS).
1795 * The image header format is extensible. However, older drivers require an
1796 * exact match of image header version and header length when validating and
1797 * writing firmware images.
1799 * To avoid breaking backward compatibility, we use the upper bits of the
1800 * controller version fields to contain an extra version number used for
1801 * combined bootROM and UEFI ROM images on EF10 and later (to hold the UEFI ROM
1802 * version). See bug39254 and SF-102785-PS for details.
1804 typedef struct efx_image_header_s {
1806 uint32_t eih_version;
1808 uint32_t eih_subtype;
1809 uint32_t eih_code_size;
1812 uint32_t eih_controller_version_min;
1814 uint16_t eih_controller_version_min_short;
1815 uint8_t eih_extra_version_a;
1816 uint8_t eih_extra_version_b;
1820 uint32_t eih_controller_version_max;
1822 uint16_t eih_controller_version_max_short;
1823 uint8_t eih_extra_version_c;
1824 uint8_t eih_extra_version_d;
1827 uint16_t eih_code_version_a;
1828 uint16_t eih_code_version_b;
1829 uint16_t eih_code_version_c;
1830 uint16_t eih_code_version_d;
1831 } efx_image_header_t;
1833 #define EFX_IMAGE_HEADER_SIZE (40)
1834 #define EFX_IMAGE_HEADER_VERSION (4)
1835 #define EFX_IMAGE_HEADER_MAGIC (0x106F1A5)
1838 typedef struct efx_image_trailer_s {
1840 } efx_image_trailer_t;
1842 #define EFX_IMAGE_TRAILER_SIZE (4)
1844 typedef enum efx_image_format_e {
1845 EFX_IMAGE_FORMAT_NO_IMAGE,
1846 EFX_IMAGE_FORMAT_INVALID,
1847 EFX_IMAGE_FORMAT_UNSIGNED,
1848 EFX_IMAGE_FORMAT_SIGNED,
1849 } efx_image_format_t;
1851 typedef struct efx_image_info_s {
1852 efx_image_format_t eii_format;
1853 uint8_t * eii_imagep;
1854 size_t eii_image_size;
1855 efx_image_header_t * eii_headerp;
1858 extern __checkReturn efx_rc_t
1859 efx_check_reflash_image(
1861 __in uint32_t buffer_size,
1862 __out efx_image_info_t *infop);
1864 extern __checkReturn efx_rc_t
1865 efx_build_signed_image_write_buffer(
1866 __out_bcount(buffer_size)
1868 __in uint32_t buffer_size,
1869 __in efx_image_info_t *infop,
1870 __out efx_image_header_t **headerpp);
1872 #endif /* EFSYS_OPT_IMAGE_LAYOUT */
1876 typedef enum efx_pattern_type_t {
1877 EFX_PATTERN_BYTE_INCREMENT = 0,
1878 EFX_PATTERN_ALL_THE_SAME,
1879 EFX_PATTERN_BIT_ALTERNATE,
1880 EFX_PATTERN_BYTE_ALTERNATE,
1881 EFX_PATTERN_BYTE_CHANGING,
1882 EFX_PATTERN_BIT_SWEEP,
1884 } efx_pattern_type_t;
1887 (*efx_sram_pattern_fn_t)(
1889 __in boolean_t negate,
1890 __out efx_qword_t *eqp);
1892 extern __checkReturn efx_rc_t
1894 __in efx_nic_t *enp,
1895 __in efx_pattern_type_t type);
1897 #endif /* EFSYS_OPT_DIAG */
1899 extern __checkReturn efx_rc_t
1900 efx_sram_buf_tbl_set(
1901 __in efx_nic_t *enp,
1903 __in efsys_mem_t *esmp,
1907 efx_sram_buf_tbl_clear(
1908 __in efx_nic_t *enp,
1912 #define EFX_BUF_TBL_SIZE 0x20000
1914 #define EFX_BUF_SIZE 4096
1918 typedef struct efx_evq_s efx_evq_t;
1920 #if EFSYS_OPT_QSTATS
1922 /* START MKCONFIG GENERATED EfxHeaderEventQueueBlock 6f3843f5fe7cc843 */
1923 typedef enum efx_ev_qstat_e {
1929 EV_RX_PAUSE_FRM_ERR,
1930 EV_RX_BUF_OWNER_ID_ERR,
1931 EV_RX_IPV4_HDR_CHKSUM_ERR,
1932 EV_RX_TCP_UDP_CHKSUM_ERR,
1936 EV_RX_MCAST_HASH_MATCH,
1953 EV_DRIVER_SRM_UPD_DONE,
1954 EV_DRIVER_TX_DESCQ_FLS_DONE,
1955 EV_DRIVER_RX_DESCQ_FLS_DONE,
1956 EV_DRIVER_RX_DESCQ_FLS_FAILED,
1957 EV_DRIVER_RX_DSC_ERROR,
1958 EV_DRIVER_TX_DSC_ERROR,
1964 /* END MKCONFIG GENERATED EfxHeaderEventQueueBlock */
1966 #endif /* EFSYS_OPT_QSTATS */
1968 extern __checkReturn efx_rc_t
1970 __in efx_nic_t *enp);
1974 __in efx_nic_t *enp);
1976 #define EFX_EVQ_MAXNEVS 32768
1977 #define EFX_EVQ_MINNEVS 512
1979 #define EFX_EVQ_SIZE(_nevs) ((_nevs) * sizeof (efx_qword_t))
1980 #define EFX_EVQ_NBUFS(_nevs) (EFX_EVQ_SIZE(_nevs) / EFX_BUF_SIZE)
1982 #define EFX_EVQ_FLAGS_TYPE_MASK (0x3)
1983 #define EFX_EVQ_FLAGS_TYPE_AUTO (0x0)
1984 #define EFX_EVQ_FLAGS_TYPE_THROUGHPUT (0x1)
1985 #define EFX_EVQ_FLAGS_TYPE_LOW_LATENCY (0x2)
1987 #define EFX_EVQ_FLAGS_NOTIFY_MASK (0xC)
1988 #define EFX_EVQ_FLAGS_NOTIFY_INTERRUPT (0x0) /* Interrupting (default) */
1989 #define EFX_EVQ_FLAGS_NOTIFY_DISABLED (0x4) /* Non-interrupting */
1991 extern __checkReturn efx_rc_t
1993 __in efx_nic_t *enp,
1994 __in unsigned int index,
1995 __in efsys_mem_t *esmp,
1999 __in uint32_t flags,
2000 __deref_out efx_evq_t **eepp);
2004 __in efx_evq_t *eep,
2005 __in uint16_t data);
2007 typedef __checkReturn boolean_t
2008 (*efx_initialized_ev_t)(
2009 __in_opt void *arg);
2011 #define EFX_PKT_UNICAST 0x0004
2012 #define EFX_PKT_START 0x0008
2014 #define EFX_PKT_VLAN_TAGGED 0x0010
2015 #define EFX_CKSUM_TCPUDP 0x0020
2016 #define EFX_CKSUM_IPV4 0x0040
2017 #define EFX_PKT_CONT 0x0080
2019 #define EFX_CHECK_VLAN 0x0100
2020 #define EFX_PKT_TCP 0x0200
2021 #define EFX_PKT_UDP 0x0400
2022 #define EFX_PKT_IPV4 0x0800
2024 #define EFX_PKT_IPV6 0x1000
2025 #define EFX_PKT_PREFIX_LEN 0x2000
2026 #define EFX_ADDR_MISMATCH 0x4000
2027 #define EFX_DISCARD 0x8000
2030 * The following flags are used only for packed stream
2031 * mode. The values for the flags are reused to fit into 16 bit,
2032 * since EFX_PKT_START and EFX_PKT_CONT are never used in
2033 * packed stream mode
2035 #define EFX_PKT_PACKED_STREAM_NEW_BUFFER EFX_PKT_START
2036 #define EFX_PKT_PACKED_STREAM_PARSE_INCOMPLETE EFX_PKT_CONT
2039 #define EFX_EV_RX_NLABELS 32
2040 #define EFX_EV_TX_NLABELS 32
2042 typedef __checkReturn boolean_t
2045 __in uint32_t label,
2048 __in uint16_t flags);
2050 #if EFSYS_OPT_RX_PACKED_STREAM || EFSYS_OPT_RX_ES_SUPER_BUFFER
2053 * Packed stream mode is documented in SF-112241-TC.
2054 * The general idea is that, instead of putting each incoming
2055 * packet into a separate buffer which is specified in a RX
2056 * descriptor, a large buffer is provided to the hardware and
2057 * packets are put there in a continuous stream.
2058 * The main advantage of such an approach is that RX queue refilling
2059 * happens much less frequently.
2061 * Equal stride packed stream mode is documented in SF-119419-TC.
2062 * The general idea is to utilize advantages of the packed stream,
2063 * but avoid indirection in packets representation.
2064 * The main advantage of such an approach is that RX queue refilling
2065 * happens much less frequently and packets buffers are independent
2066 * from upper layers point of view.
2069 typedef __checkReturn boolean_t
2072 __in uint32_t label,
2074 __in uint32_t pkt_count,
2075 __in uint16_t flags);
2079 typedef __checkReturn boolean_t
2082 __in uint32_t label,
2085 #define EFX_EXCEPTION_RX_RECOVERY 0x00000001
2086 #define EFX_EXCEPTION_RX_DSC_ERROR 0x00000002
2087 #define EFX_EXCEPTION_TX_DSC_ERROR 0x00000003
2088 #define EFX_EXCEPTION_UNKNOWN_SENSOREVT 0x00000004
2089 #define EFX_EXCEPTION_FWALERT_SRAM 0x00000005
2090 #define EFX_EXCEPTION_UNKNOWN_FWALERT 0x00000006
2091 #define EFX_EXCEPTION_RX_ERROR 0x00000007
2092 #define EFX_EXCEPTION_TX_ERROR 0x00000008
2093 #define EFX_EXCEPTION_EV_ERROR 0x00000009
2095 typedef __checkReturn boolean_t
2096 (*efx_exception_ev_t)(
2098 __in uint32_t label,
2099 __in uint32_t data);
2101 typedef __checkReturn boolean_t
2102 (*efx_rxq_flush_done_ev_t)(
2104 __in uint32_t rxq_index);
2106 typedef __checkReturn boolean_t
2107 (*efx_rxq_flush_failed_ev_t)(
2109 __in uint32_t rxq_index);
2111 typedef __checkReturn boolean_t
2112 (*efx_txq_flush_done_ev_t)(
2114 __in uint32_t txq_index);
2116 typedef __checkReturn boolean_t
2117 (*efx_software_ev_t)(
2119 __in uint16_t magic);
2121 typedef __checkReturn boolean_t
2124 __in uint32_t code);
2126 #define EFX_SRAM_CLEAR 0
2127 #define EFX_SRAM_UPDATE 1
2128 #define EFX_SRAM_ILLEGAL_CLEAR 2
2130 typedef __checkReturn boolean_t
2131 (*efx_wake_up_ev_t)(
2133 __in uint32_t label);
2135 typedef __checkReturn boolean_t
2138 __in uint32_t label);
2140 typedef __checkReturn boolean_t
2141 (*efx_link_change_ev_t)(
2143 __in efx_link_mode_t link_mode);
2145 #if EFSYS_OPT_MON_STATS
2147 typedef __checkReturn boolean_t
2148 (*efx_monitor_ev_t)(
2150 __in efx_mon_stat_t id,
2151 __in efx_mon_stat_value_t value);
2153 #endif /* EFSYS_OPT_MON_STATS */
2155 #if EFSYS_OPT_MAC_STATS
2157 typedef __checkReturn boolean_t
2158 (*efx_mac_stats_ev_t)(
2160 __in uint32_t generation);
2162 #endif /* EFSYS_OPT_MAC_STATS */
2164 typedef struct efx_ev_callbacks_s {
2165 efx_initialized_ev_t eec_initialized;
2167 #if EFSYS_OPT_RX_PACKED_STREAM || EFSYS_OPT_RX_ES_SUPER_BUFFER
2168 efx_rx_ps_ev_t eec_rx_ps;
2171 efx_exception_ev_t eec_exception;
2172 efx_rxq_flush_done_ev_t eec_rxq_flush_done;
2173 efx_rxq_flush_failed_ev_t eec_rxq_flush_failed;
2174 efx_txq_flush_done_ev_t eec_txq_flush_done;
2175 efx_software_ev_t eec_software;
2176 efx_sram_ev_t eec_sram;
2177 efx_wake_up_ev_t eec_wake_up;
2178 efx_timer_ev_t eec_timer;
2179 efx_link_change_ev_t eec_link_change;
2180 #if EFSYS_OPT_MON_STATS
2181 efx_monitor_ev_t eec_monitor;
2182 #endif /* EFSYS_OPT_MON_STATS */
2183 #if EFSYS_OPT_MAC_STATS
2184 efx_mac_stats_ev_t eec_mac_stats;
2185 #endif /* EFSYS_OPT_MAC_STATS */
2186 } efx_ev_callbacks_t;
2188 extern __checkReturn boolean_t
2190 __in efx_evq_t *eep,
2191 __in unsigned int count);
2193 #if EFSYS_OPT_EV_PREFETCH
2197 __in efx_evq_t *eep,
2198 __in unsigned int count);
2200 #endif /* EFSYS_OPT_EV_PREFETCH */
2204 __in efx_evq_t *eep,
2205 __inout unsigned int *countp,
2206 __in const efx_ev_callbacks_t *eecp,
2207 __in_opt void *arg);
2209 extern __checkReturn efx_rc_t
2210 efx_ev_usecs_to_ticks(
2211 __in efx_nic_t *enp,
2212 __in unsigned int usecs,
2213 __out unsigned int *ticksp);
2215 extern __checkReturn efx_rc_t
2217 __in efx_evq_t *eep,
2218 __in unsigned int us);
2220 extern __checkReturn efx_rc_t
2222 __in efx_evq_t *eep,
2223 __in unsigned int count);
2225 #if EFSYS_OPT_QSTATS
2231 __in efx_nic_t *enp,
2232 __in unsigned int id);
2234 #endif /* EFSYS_OPT_NAMES */
2237 efx_ev_qstats_update(
2238 __in efx_evq_t *eep,
2239 __inout_ecount(EV_NQSTATS) efsys_stat_t *stat);
2241 #endif /* EFSYS_OPT_QSTATS */
2245 __in efx_evq_t *eep);
2249 extern __checkReturn efx_rc_t
2251 __inout efx_nic_t *enp);
2255 __in efx_nic_t *enp);
2257 #if EFSYS_OPT_RX_SCATTER
2258 __checkReturn efx_rc_t
2259 efx_rx_scatter_enable(
2260 __in efx_nic_t *enp,
2261 __in unsigned int buf_size);
2262 #endif /* EFSYS_OPT_RX_SCATTER */
2264 /* Handle to represent use of the default RSS context. */
2265 #define EFX_RSS_CONTEXT_DEFAULT 0xffffffff
2267 #if EFSYS_OPT_RX_SCALE
2269 typedef enum efx_rx_hash_alg_e {
2270 EFX_RX_HASHALG_LFSR = 0,
2271 EFX_RX_HASHALG_TOEPLITZ,
2272 EFX_RX_HASHALG_PACKED_STREAM,
2274 } efx_rx_hash_alg_t;
2277 * Legacy hash type flags.
2279 * They represent standard tuples for distinct traffic classes.
2281 #define EFX_RX_HASH_IPV4 (1U << 0)
2282 #define EFX_RX_HASH_TCPIPV4 (1U << 1)
2283 #define EFX_RX_HASH_IPV6 (1U << 2)
2284 #define EFX_RX_HASH_TCPIPV6 (1U << 3)
2286 #define EFX_RX_HASH_LEGACY_MASK \
2287 (EFX_RX_HASH_IPV4 | \
2288 EFX_RX_HASH_TCPIPV4 | \
2289 EFX_RX_HASH_IPV6 | \
2290 EFX_RX_HASH_TCPIPV6)
2293 * The type of the argument used by efx_rx_scale_mode_set() to
2294 * provide a means for the client drivers to configure hashing.
2296 * A properly constructed value can either be:
2297 * - a combination of legacy flags
2298 * - a combination of EFX_RX_HASH() flags
2300 typedef uint32_t efx_rx_hash_type_t;
2302 typedef enum efx_rx_hash_support_e {
2303 EFX_RX_HASH_UNAVAILABLE = 0, /* Hardware hash not inserted */
2304 EFX_RX_HASH_AVAILABLE /* Insert hash with/without RSS */
2305 } efx_rx_hash_support_t;
2307 #define EFX_RSS_KEY_SIZE 40 /* RSS key size (bytes) */
2308 #define EFX_RSS_TBL_SIZE 128 /* Rows in RX indirection table */
2309 #define EFX_MAXRSS 64 /* RX indirection entry range */
2310 #define EFX_MAXRSS_LEGACY 16 /* See bug16611 and bug17213 */
2312 typedef enum efx_rx_scale_context_type_e {
2313 EFX_RX_SCALE_UNAVAILABLE = 0, /* No RX scale context */
2314 EFX_RX_SCALE_EXCLUSIVE, /* Writable key/indirection table */
2315 EFX_RX_SCALE_SHARED /* Read-only key/indirection table */
2316 } efx_rx_scale_context_type_t;
2319 * Traffic classes eligible for hash computation.
2321 * Select packet headers used in computing the receive hash.
2322 * This uses the same encoding as the RSS_MODES field of
2323 * MC_CMD_RSS_CONTEXT_SET_FLAGS.
2325 #define EFX_RX_CLASS_IPV4_TCP_LBN 8
2326 #define EFX_RX_CLASS_IPV4_TCP_WIDTH 4
2327 #define EFX_RX_CLASS_IPV4_UDP_LBN 12
2328 #define EFX_RX_CLASS_IPV4_UDP_WIDTH 4
2329 #define EFX_RX_CLASS_IPV4_LBN 16
2330 #define EFX_RX_CLASS_IPV4_WIDTH 4
2331 #define EFX_RX_CLASS_IPV6_TCP_LBN 20
2332 #define EFX_RX_CLASS_IPV6_TCP_WIDTH 4
2333 #define EFX_RX_CLASS_IPV6_UDP_LBN 24
2334 #define EFX_RX_CLASS_IPV6_UDP_WIDTH 4
2335 #define EFX_RX_CLASS_IPV6_LBN 28
2336 #define EFX_RX_CLASS_IPV6_WIDTH 4
2338 #define EFX_RX_NCLASSES 6
2341 * Ancillary flags used to construct generic hash tuples.
2342 * This uses the same encoding as RSS_MODE_HASH_SELECTOR.
2344 #define EFX_RX_CLASS_HASH_SRC_ADDR (1U << 0)
2345 #define EFX_RX_CLASS_HASH_DST_ADDR (1U << 1)
2346 #define EFX_RX_CLASS_HASH_SRC_PORT (1U << 2)
2347 #define EFX_RX_CLASS_HASH_DST_PORT (1U << 3)
2350 * Generic hash tuples.
2352 * They express combinations of packet fields
2353 * which can contribute to the hash value for
2354 * a particular traffic class.
2356 #define EFX_RX_CLASS_HASH_DISABLE 0
2358 #define EFX_RX_CLASS_HASH_1TUPLE_SRC EFX_RX_CLASS_HASH_SRC_ADDR
2359 #define EFX_RX_CLASS_HASH_1TUPLE_DST EFX_RX_CLASS_HASH_DST_ADDR
2361 #define EFX_RX_CLASS_HASH_2TUPLE \
2362 (EFX_RX_CLASS_HASH_SRC_ADDR | \
2363 EFX_RX_CLASS_HASH_DST_ADDR)
2365 #define EFX_RX_CLASS_HASH_2TUPLE_SRC \
2366 (EFX_RX_CLASS_HASH_SRC_ADDR | \
2367 EFX_RX_CLASS_HASH_SRC_PORT)
2369 #define EFX_RX_CLASS_HASH_2TUPLE_DST \
2370 (EFX_RX_CLASS_HASH_DST_ADDR | \
2371 EFX_RX_CLASS_HASH_DST_PORT)
2373 #define EFX_RX_CLASS_HASH_4TUPLE \
2374 (EFX_RX_CLASS_HASH_SRC_ADDR | \
2375 EFX_RX_CLASS_HASH_DST_ADDR | \
2376 EFX_RX_CLASS_HASH_SRC_PORT | \
2377 EFX_RX_CLASS_HASH_DST_PORT)
2379 #define EFX_RX_CLASS_HASH_NTUPLES 7
2382 * Hash flag constructor.
2384 * Resulting flags encode hash tuples for specific traffic classes.
2385 * The client drivers are encouraged to use these flags to form
2386 * a hash type value.
2388 #define EFX_RX_HASH(_class, _tuple) \
2389 EFX_INSERT_FIELD_NATIVE32(0, 31, \
2390 EFX_RX_CLASS_##_class, EFX_RX_CLASS_HASH_##_tuple)
2393 * The maximum number of EFX_RX_HASH() flags.
2395 #define EFX_RX_HASH_NFLAGS (EFX_RX_NCLASSES * EFX_RX_CLASS_HASH_NTUPLES)
2397 extern __checkReturn efx_rc_t
2398 efx_rx_scale_hash_flags_get(
2399 __in efx_nic_t *enp,
2400 __in efx_rx_hash_alg_t hash_alg,
2401 __out_ecount_part(max_nflags, *nflagsp) unsigned int *flagsp,
2402 __in unsigned int max_nflags,
2403 __out unsigned int *nflagsp);
2405 extern __checkReturn efx_rc_t
2406 efx_rx_hash_default_support_get(
2407 __in efx_nic_t *enp,
2408 __out efx_rx_hash_support_t *supportp);
2411 extern __checkReturn efx_rc_t
2412 efx_rx_scale_default_support_get(
2413 __in efx_nic_t *enp,
2414 __out efx_rx_scale_context_type_t *typep);
2416 extern __checkReturn efx_rc_t
2417 efx_rx_scale_context_alloc(
2418 __in efx_nic_t *enp,
2419 __in efx_rx_scale_context_type_t type,
2420 __in uint32_t num_queues,
2421 __out uint32_t *rss_contextp);
2423 extern __checkReturn efx_rc_t
2424 efx_rx_scale_context_free(
2425 __in efx_nic_t *enp,
2426 __in uint32_t rss_context);
2428 extern __checkReturn efx_rc_t
2429 efx_rx_scale_mode_set(
2430 __in efx_nic_t *enp,
2431 __in uint32_t rss_context,
2432 __in efx_rx_hash_alg_t alg,
2433 __in efx_rx_hash_type_t type,
2434 __in boolean_t insert);
2436 extern __checkReturn efx_rc_t
2437 efx_rx_scale_tbl_set(
2438 __in efx_nic_t *enp,
2439 __in uint32_t rss_context,
2440 __in_ecount(n) unsigned int *table,
2443 extern __checkReturn efx_rc_t
2444 efx_rx_scale_key_set(
2445 __in efx_nic_t *enp,
2446 __in uint32_t rss_context,
2447 __in_ecount(n) uint8_t *key,
2450 extern __checkReturn uint32_t
2451 efx_pseudo_hdr_hash_get(
2452 __in efx_rxq_t *erp,
2453 __in efx_rx_hash_alg_t func,
2454 __in uint8_t *buffer);
2456 #endif /* EFSYS_OPT_RX_SCALE */
2458 extern __checkReturn efx_rc_t
2459 efx_pseudo_hdr_pkt_length_get(
2460 __in efx_rxq_t *erp,
2461 __in uint8_t *buffer,
2462 __out uint16_t *pkt_lengthp);
2464 #define EFX_RXQ_MAXNDESCS 4096
2465 #define EFX_RXQ_MINNDESCS 512
2467 #define EFX_RXQ_SIZE(_ndescs) ((_ndescs) * sizeof (efx_qword_t))
2468 #define EFX_RXQ_NBUFS(_ndescs) (EFX_RXQ_SIZE(_ndescs) / EFX_BUF_SIZE)
2469 #define EFX_RXQ_LIMIT(_ndescs) ((_ndescs) - 16)
2470 #define EFX_RXQ_DC_NDESCS(_dcsize) (8 << _dcsize)
2472 typedef enum efx_rxq_type_e {
2473 EFX_RXQ_TYPE_DEFAULT,
2474 EFX_RXQ_TYPE_PACKED_STREAM,
2475 EFX_RXQ_TYPE_ES_SUPER_BUFFER,
2480 * Dummy flag to be used instead of 0 to make it clear that the argument
2481 * is receive queue flags.
2483 #define EFX_RXQ_FLAG_NONE 0x0
2484 #define EFX_RXQ_FLAG_SCATTER 0x1
2486 * If tunnels are supported and Rx event can provide information about
2487 * either outer or inner packet classes (e.g. SFN8xxx adapters with
2488 * full-feature firmware variant running), outer classes are requested by
2489 * default. However, if the driver supports tunnels, the flag allows to
2490 * request inner classes which are required to be able to interpret inner
2491 * Rx checksum offload results.
2493 #define EFX_RXQ_FLAG_INNER_CLASSES 0x2
2495 extern __checkReturn efx_rc_t
2497 __in efx_nic_t *enp,
2498 __in unsigned int index,
2499 __in unsigned int label,
2500 __in efx_rxq_type_t type,
2501 __in efsys_mem_t *esmp,
2504 __in unsigned int flags,
2505 __in efx_evq_t *eep,
2506 __deref_out efx_rxq_t **erpp);
2508 #if EFSYS_OPT_RX_PACKED_STREAM
2510 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_1M (1U * 1024 * 1024)
2511 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_512K (512U * 1024)
2512 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_256K (256U * 1024)
2513 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_128K (128U * 1024)
2514 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_64K (64U * 1024)
2516 extern __checkReturn efx_rc_t
2517 efx_rx_qcreate_packed_stream(
2518 __in efx_nic_t *enp,
2519 __in unsigned int index,
2520 __in unsigned int label,
2521 __in uint32_t ps_buf_size,
2522 __in efsys_mem_t *esmp,
2524 __in efx_evq_t *eep,
2525 __deref_out efx_rxq_t **erpp);
2529 #if EFSYS_OPT_RX_ES_SUPER_BUFFER
2531 /* Maximum head-of-line block timeout in nanoseconds */
2532 #define EFX_RXQ_ES_SUPER_BUFFER_HOL_BLOCK_MAX (400U * 1000 * 1000)
2534 extern __checkReturn efx_rc_t
2535 efx_rx_qcreate_es_super_buffer(
2536 __in efx_nic_t *enp,
2537 __in unsigned int index,
2538 __in unsigned int label,
2539 __in uint32_t n_bufs_per_desc,
2540 __in uint32_t max_dma_len,
2541 __in uint32_t buf_stride,
2542 __in uint32_t hol_block_timeout,
2543 __in efsys_mem_t *esmp,
2545 __in unsigned int flags,
2546 __in efx_evq_t *eep,
2547 __deref_out efx_rxq_t **erpp);
2551 typedef struct efx_buffer_s {
2552 efsys_dma_addr_t eb_addr;
2557 typedef struct efx_desc_s {
2563 __in efx_rxq_t *erp,
2564 __in_ecount(ndescs) efsys_dma_addr_t *addrp,
2566 __in unsigned int ndescs,
2567 __in unsigned int completed,
2568 __in unsigned int added);
2572 __in efx_rxq_t *erp,
2573 __in unsigned int added,
2574 __inout unsigned int *pushedp);
2576 #if EFSYS_OPT_RX_PACKED_STREAM
2579 efx_rx_qpush_ps_credits(
2580 __in efx_rxq_t *erp);
2582 extern __checkReturn uint8_t *
2583 efx_rx_qps_packet_info(
2584 __in efx_rxq_t *erp,
2585 __in uint8_t *buffer,
2586 __in uint32_t buffer_length,
2587 __in uint32_t current_offset,
2588 __out uint16_t *lengthp,
2589 __out uint32_t *next_offsetp,
2590 __out uint32_t *timestamp);
2593 extern __checkReturn efx_rc_t
2595 __in efx_rxq_t *erp);
2599 __in efx_rxq_t *erp);
2603 __in efx_rxq_t *erp);
2607 typedef struct efx_txq_s efx_txq_t;
2609 #if EFSYS_OPT_QSTATS
2611 /* START MKCONFIG GENERATED EfxHeaderTransmitQueueBlock 12dff8778598b2db */
2612 typedef enum efx_tx_qstat_e {
2618 /* END MKCONFIG GENERATED EfxHeaderTransmitQueueBlock */
2620 #endif /* EFSYS_OPT_QSTATS */
2622 extern __checkReturn efx_rc_t
2624 __in efx_nic_t *enp);
2628 __in efx_nic_t *enp);
2630 #define EFX_TXQ_MINNDESCS 512
2632 #define EFX_TXQ_SIZE(_ndescs) ((_ndescs) * sizeof (efx_qword_t))
2633 #define EFX_TXQ_NBUFS(_ndescs) (EFX_TXQ_SIZE(_ndescs) / EFX_BUF_SIZE)
2634 #define EFX_TXQ_LIMIT(_ndescs) ((_ndescs) - 16)
2636 #define EFX_TXQ_MAX_BUFS 8 /* Maximum independent of EFX_BUG35388_WORKAROUND. */
2638 #define EFX_TXQ_CKSUM_IPV4 0x0001
2639 #define EFX_TXQ_CKSUM_TCPUDP 0x0002
2640 #define EFX_TXQ_FATSOV2 0x0004
2641 #define EFX_TXQ_CKSUM_INNER_IPV4 0x0008
2642 #define EFX_TXQ_CKSUM_INNER_TCPUDP 0x0010
2644 extern __checkReturn efx_rc_t
2646 __in efx_nic_t *enp,
2647 __in unsigned int index,
2648 __in unsigned int label,
2649 __in efsys_mem_t *esmp,
2652 __in uint16_t flags,
2653 __in efx_evq_t *eep,
2654 __deref_out efx_txq_t **etpp,
2655 __out unsigned int *addedp);
2657 extern __checkReturn efx_rc_t
2659 __in efx_txq_t *etp,
2660 __in_ecount(ndescs) efx_buffer_t *eb,
2661 __in unsigned int ndescs,
2662 __in unsigned int completed,
2663 __inout unsigned int *addedp);
2665 extern __checkReturn efx_rc_t
2667 __in efx_txq_t *etp,
2668 __in unsigned int ns);
2672 __in efx_txq_t *etp,
2673 __in unsigned int added,
2674 __in unsigned int pushed);
2676 extern __checkReturn efx_rc_t
2678 __in efx_txq_t *etp);
2682 __in efx_txq_t *etp);
2684 extern __checkReturn efx_rc_t
2686 __in efx_txq_t *etp);
2689 efx_tx_qpio_disable(
2690 __in efx_txq_t *etp);
2692 extern __checkReturn efx_rc_t
2694 __in efx_txq_t *etp,
2695 __in_ecount(buf_length) uint8_t *buffer,
2696 __in size_t buf_length,
2697 __in size_t pio_buf_offset);
2699 extern __checkReturn efx_rc_t
2701 __in efx_txq_t *etp,
2702 __in size_t pkt_length,
2703 __in unsigned int completed,
2704 __inout unsigned int *addedp);
2706 extern __checkReturn efx_rc_t
2708 __in efx_txq_t *etp,
2709 __in_ecount(n) efx_desc_t *ed,
2710 __in unsigned int n,
2711 __in unsigned int completed,
2712 __inout unsigned int *addedp);
2715 efx_tx_qdesc_dma_create(
2716 __in efx_txq_t *etp,
2717 __in efsys_dma_addr_t addr,
2720 __out efx_desc_t *edp);
2723 efx_tx_qdesc_tso_create(
2724 __in efx_txq_t *etp,
2725 __in uint16_t ipv4_id,
2726 __in uint32_t tcp_seq,
2727 __in uint8_t tcp_flags,
2728 __out efx_desc_t *edp);
2730 /* Number of FATSOv2 option descriptors */
2731 #define EFX_TX_FATSOV2_OPT_NDESCS 2
2733 /* Maximum number of DMA segments per TSO packet (not superframe) */
2734 #define EFX_TX_FATSOV2_DMA_SEGS_PER_PKT_MAX 24
2737 efx_tx_qdesc_tso2_create(
2738 __in efx_txq_t *etp,
2739 __in uint16_t ipv4_id,
2740 __in uint16_t outer_ipv4_id,
2741 __in uint32_t tcp_seq,
2742 __in uint16_t tcp_mss,
2743 __out_ecount(count) efx_desc_t *edp,
2747 efx_tx_qdesc_vlantci_create(
2748 __in efx_txq_t *etp,
2750 __out efx_desc_t *edp);
2753 efx_tx_qdesc_checksum_create(
2754 __in efx_txq_t *etp,
2755 __in uint16_t flags,
2756 __out efx_desc_t *edp);
2758 #if EFSYS_OPT_QSTATS
2764 __in efx_nic_t *etp,
2765 __in unsigned int id);
2767 #endif /* EFSYS_OPT_NAMES */
2770 efx_tx_qstats_update(
2771 __in efx_txq_t *etp,
2772 __inout_ecount(TX_NQSTATS) efsys_stat_t *stat);
2774 #endif /* EFSYS_OPT_QSTATS */
2778 __in efx_txq_t *etp);
2783 #if EFSYS_OPT_FILTER
2785 #define EFX_ETHER_TYPE_IPV4 0x0800
2786 #define EFX_ETHER_TYPE_IPV6 0x86DD
2788 #define EFX_IPPROTO_TCP 6
2789 #define EFX_IPPROTO_UDP 17
2790 #define EFX_IPPROTO_GRE 47
2792 /* Use RSS to spread across multiple queues */
2793 #define EFX_FILTER_FLAG_RX_RSS 0x01
2794 /* Enable RX scatter */
2795 #define EFX_FILTER_FLAG_RX_SCATTER 0x02
2797 * Override an automatic filter (priority EFX_FILTER_PRI_AUTO).
2798 * May only be set by the filter implementation for each type.
2799 * A removal request will restore the automatic filter in its place.
2801 #define EFX_FILTER_FLAG_RX_OVER_AUTO 0x04
2802 /* Filter is for RX */
2803 #define EFX_FILTER_FLAG_RX 0x08
2804 /* Filter is for TX */
2805 #define EFX_FILTER_FLAG_TX 0x10
2806 /* Set match flag on the received packet */
2807 #define EFX_FILTER_FLAG_ACTION_FLAG 0x20
2808 /* Set match mark on the received packet */
2809 #define EFX_FILTER_FLAG_ACTION_MARK 0x40
2811 typedef uint8_t efx_filter_flags_t;
2814 * Flags which specify the fields to match on. The values are the same as in the
2815 * MC_CMD_FILTER_OP/MC_CMD_FILTER_OP_EXT commands.
2818 /* Match by remote IP host address */
2819 #define EFX_FILTER_MATCH_REM_HOST 0x00000001
2820 /* Match by local IP host address */
2821 #define EFX_FILTER_MATCH_LOC_HOST 0x00000002
2822 /* Match by remote MAC address */
2823 #define EFX_FILTER_MATCH_REM_MAC 0x00000004
2824 /* Match by remote TCP/UDP port */
2825 #define EFX_FILTER_MATCH_REM_PORT 0x00000008
2826 /* Match by remote TCP/UDP port */
2827 #define EFX_FILTER_MATCH_LOC_MAC 0x00000010
2828 /* Match by local TCP/UDP port */
2829 #define EFX_FILTER_MATCH_LOC_PORT 0x00000020
2830 /* Match by Ether-type */
2831 #define EFX_FILTER_MATCH_ETHER_TYPE 0x00000040
2832 /* Match by inner VLAN ID */
2833 #define EFX_FILTER_MATCH_INNER_VID 0x00000080
2834 /* Match by outer VLAN ID */
2835 #define EFX_FILTER_MATCH_OUTER_VID 0x00000100
2836 /* Match by IP transport protocol */
2837 #define EFX_FILTER_MATCH_IP_PROTO 0x00000200
2838 /* Match by VNI or VSID */
2839 #define EFX_FILTER_MATCH_VNI_OR_VSID 0x00000800
2840 /* For encapsulated packets, match by inner frame local MAC address */
2841 #define EFX_FILTER_MATCH_IFRM_LOC_MAC 0x00010000
2842 /* For encapsulated packets, match all multicast inner frames */
2843 #define EFX_FILTER_MATCH_IFRM_UNKNOWN_MCAST_DST 0x01000000
2844 /* For encapsulated packets, match all unicast inner frames */
2845 #define EFX_FILTER_MATCH_IFRM_UNKNOWN_UCAST_DST 0x02000000
2847 * Match by encap type, this flag does not correspond to
2848 * the MCDI match flags and any unoccupied value may be used
2850 #define EFX_FILTER_MATCH_ENCAP_TYPE 0x20000000
2851 /* Match otherwise-unmatched multicast and broadcast packets */
2852 #define EFX_FILTER_MATCH_UNKNOWN_MCAST_DST 0x40000000
2853 /* Match otherwise-unmatched unicast packets */
2854 #define EFX_FILTER_MATCH_UNKNOWN_UCAST_DST 0x80000000
2856 typedef uint32_t efx_filter_match_flags_t;
2858 typedef enum efx_filter_priority_s {
2859 EFX_FILTER_PRI_HINT = 0, /* Performance hint */
2860 EFX_FILTER_PRI_AUTO, /* Automatic filter based on device
2861 * address list or hardware
2862 * requirements. This may only be used
2863 * by the filter implementation for
2865 EFX_FILTER_PRI_MANUAL, /* Manually configured filter */
2866 EFX_FILTER_PRI_REQUIRED, /* Required for correct behaviour of the
2867 * client (e.g. SR-IOV, HyperV VMQ etc.)
2869 } efx_filter_priority_t;
2872 * FIXME: All these fields are assumed to be in little-endian byte order.
2873 * It may be better for some to be big-endian. See bug42804.
2876 typedef struct efx_filter_spec_s {
2877 efx_filter_match_flags_t efs_match_flags;
2878 uint8_t efs_priority;
2879 efx_filter_flags_t efs_flags;
2880 uint16_t efs_dmaq_id;
2881 uint32_t efs_rss_context;
2883 /* Fields below here are hashed for software filter lookup */
2884 uint16_t efs_outer_vid;
2885 uint16_t efs_inner_vid;
2886 uint8_t efs_loc_mac[EFX_MAC_ADDR_LEN];
2887 uint8_t efs_rem_mac[EFX_MAC_ADDR_LEN];
2888 uint16_t efs_ether_type;
2889 uint8_t efs_ip_proto;
2890 efx_tunnel_protocol_t efs_encap_type;
2891 uint16_t efs_loc_port;
2892 uint16_t efs_rem_port;
2893 efx_oword_t efs_rem_host;
2894 efx_oword_t efs_loc_host;
2895 uint8_t efs_vni_or_vsid[EFX_VNI_OR_VSID_LEN];
2896 uint8_t efs_ifrm_loc_mac[EFX_MAC_ADDR_LEN];
2897 } efx_filter_spec_t;
2900 /* Default values for use in filter specifications */
2901 #define EFX_FILTER_SPEC_RX_DMAQ_ID_DROP 0xfff
2902 #define EFX_FILTER_SPEC_VID_UNSPEC 0xffff
2904 extern __checkReturn efx_rc_t
2906 __in efx_nic_t *enp);
2910 __in efx_nic_t *enp);
2912 extern __checkReturn efx_rc_t
2914 __in efx_nic_t *enp,
2915 __inout efx_filter_spec_t *spec);
2917 extern __checkReturn efx_rc_t
2919 __in efx_nic_t *enp,
2920 __inout efx_filter_spec_t *spec);
2922 extern __checkReturn efx_rc_t
2924 __in efx_nic_t *enp);
2926 extern __checkReturn efx_rc_t
2927 efx_filter_supported_filters(
2928 __in efx_nic_t *enp,
2929 __out_ecount(buffer_length) uint32_t *buffer,
2930 __in size_t buffer_length,
2931 __out size_t *list_lengthp);
2934 efx_filter_spec_init_rx(
2935 __out efx_filter_spec_t *spec,
2936 __in efx_filter_priority_t priority,
2937 __in efx_filter_flags_t flags,
2938 __in efx_rxq_t *erp);
2941 efx_filter_spec_init_tx(
2942 __out efx_filter_spec_t *spec,
2943 __in efx_txq_t *etp);
2945 extern __checkReturn efx_rc_t
2946 efx_filter_spec_set_ipv4_local(
2947 __inout efx_filter_spec_t *spec,
2950 __in uint16_t port);
2952 extern __checkReturn efx_rc_t
2953 efx_filter_spec_set_ipv4_full(
2954 __inout efx_filter_spec_t *spec,
2956 __in uint32_t lhost,
2957 __in uint16_t lport,
2958 __in uint32_t rhost,
2959 __in uint16_t rport);
2961 extern __checkReturn efx_rc_t
2962 efx_filter_spec_set_eth_local(
2963 __inout efx_filter_spec_t *spec,
2965 __in const uint8_t *addr);
2968 efx_filter_spec_set_ether_type(
2969 __inout efx_filter_spec_t *spec,
2970 __in uint16_t ether_type);
2972 extern __checkReturn efx_rc_t
2973 efx_filter_spec_set_uc_def(
2974 __inout efx_filter_spec_t *spec);
2976 extern __checkReturn efx_rc_t
2977 efx_filter_spec_set_mc_def(
2978 __inout efx_filter_spec_t *spec);
2980 typedef enum efx_filter_inner_frame_match_e {
2981 EFX_FILTER_INNER_FRAME_MATCH_OTHER = 0,
2982 EFX_FILTER_INNER_FRAME_MATCH_UNKNOWN_MCAST_DST,
2983 EFX_FILTER_INNER_FRAME_MATCH_UNKNOWN_UCAST_DST
2984 } efx_filter_inner_frame_match_t;
2986 extern __checkReturn efx_rc_t
2987 efx_filter_spec_set_encap_type(
2988 __inout efx_filter_spec_t *spec,
2989 __in efx_tunnel_protocol_t encap_type,
2990 __in efx_filter_inner_frame_match_t inner_frame_match);
2992 extern __checkReturn efx_rc_t
2993 efx_filter_spec_set_vxlan(
2994 __inout efx_filter_spec_t *spec,
2995 __in const uint8_t *vni,
2996 __in const uint8_t *inner_addr,
2997 __in const uint8_t *outer_addr);
2999 extern __checkReturn efx_rc_t
3000 efx_filter_spec_set_geneve(
3001 __inout efx_filter_spec_t *spec,
3002 __in const uint8_t *vni,
3003 __in const uint8_t *inner_addr,
3004 __in const uint8_t *outer_addr);
3006 extern __checkReturn efx_rc_t
3007 efx_filter_spec_set_nvgre(
3008 __inout efx_filter_spec_t *spec,
3009 __in const uint8_t *vsid,
3010 __in const uint8_t *inner_addr,
3011 __in const uint8_t *outer_addr);
3013 #if EFSYS_OPT_RX_SCALE
3014 extern __checkReturn efx_rc_t
3015 efx_filter_spec_set_rss_context(
3016 __inout efx_filter_spec_t *spec,
3017 __in uint32_t rss_context);
3019 #endif /* EFSYS_OPT_FILTER */
3023 extern __checkReturn uint32_t
3025 __in_ecount(count) uint32_t const *input,
3027 __in uint32_t init);
3029 extern __checkReturn uint32_t
3031 __in_ecount(length) uint8_t const *input,
3033 __in uint32_t init);
3035 #if EFSYS_OPT_LICENSING
3039 typedef struct efx_key_stats_s {
3041 uint32_t eks_invalid;
3042 uint32_t eks_blacklisted;
3043 uint32_t eks_unverifiable;
3044 uint32_t eks_wrong_node;
3045 uint32_t eks_licensed_apps_lo;
3046 uint32_t eks_licensed_apps_hi;
3047 uint32_t eks_licensed_features_lo;
3048 uint32_t eks_licensed_features_hi;
3051 extern __checkReturn efx_rc_t
3053 __in efx_nic_t *enp);
3057 __in efx_nic_t *enp);
3059 extern __checkReturn boolean_t
3060 efx_lic_check_support(
3061 __in efx_nic_t *enp);
3063 extern __checkReturn efx_rc_t
3064 efx_lic_update_licenses(
3065 __in efx_nic_t *enp);
3067 extern __checkReturn efx_rc_t
3068 efx_lic_get_key_stats(
3069 __in efx_nic_t *enp,
3070 __out efx_key_stats_t *ksp);
3072 extern __checkReturn efx_rc_t
3074 __in efx_nic_t *enp,
3075 __in uint64_t app_id,
3076 __out boolean_t *licensedp);
3078 extern __checkReturn efx_rc_t
3080 __in efx_nic_t *enp,
3081 __in size_t buffer_size,
3082 __out uint32_t *typep,
3083 __out size_t *lengthp,
3084 __out_opt uint8_t *bufferp);
3087 extern __checkReturn efx_rc_t
3089 __in efx_nic_t *enp,
3090 __in_bcount(buffer_size)
3092 __in size_t buffer_size,
3093 __out uint32_t *startp);
3095 extern __checkReturn efx_rc_t
3097 __in efx_nic_t *enp,
3098 __in_bcount(buffer_size)
3100 __in size_t buffer_size,
3101 __in uint32_t offset,
3102 __out uint32_t *endp);
3104 extern __checkReturn __success(return != B_FALSE) boolean_t
3106 __in efx_nic_t *enp,
3107 __in_bcount(buffer_size)
3109 __in size_t buffer_size,
3110 __in uint32_t offset,
3111 __out uint32_t *startp,
3112 __out uint32_t *lengthp);
3114 extern __checkReturn __success(return != B_FALSE) boolean_t
3115 efx_lic_validate_key(
3116 __in efx_nic_t *enp,
3117 __in_bcount(length) caddr_t keyp,
3118 __in uint32_t length);
3120 extern __checkReturn efx_rc_t
3122 __in efx_nic_t *enp,
3123 __in_bcount(buffer_size)
3125 __in size_t buffer_size,
3126 __in uint32_t offset,
3127 __in uint32_t length,
3128 __out_bcount_part(key_max_size, *lengthp)
3130 __in size_t key_max_size,
3131 __out uint32_t *lengthp);
3133 extern __checkReturn efx_rc_t
3135 __in efx_nic_t *enp,
3136 __in_bcount(buffer_size)
3138 __in size_t buffer_size,
3139 __in uint32_t offset,
3140 __in_bcount(length) caddr_t keyp,
3141 __in uint32_t length,
3142 __out uint32_t *lengthp);
3144 __checkReturn efx_rc_t
3146 __in efx_nic_t *enp,
3147 __in_bcount(buffer_size)
3149 __in size_t buffer_size,
3150 __in uint32_t offset,
3151 __in uint32_t length,
3153 __out uint32_t *deltap);
3155 extern __checkReturn efx_rc_t
3156 efx_lic_create_partition(
3157 __in efx_nic_t *enp,
3158 __in_bcount(buffer_size)
3160 __in size_t buffer_size);
3162 extern __checkReturn efx_rc_t
3163 efx_lic_finish_partition(
3164 __in efx_nic_t *enp,
3165 __in_bcount(buffer_size)
3167 __in size_t buffer_size);
3169 #endif /* EFSYS_OPT_LICENSING */
3173 #if EFSYS_OPT_TUNNEL
3175 extern __checkReturn efx_rc_t
3177 __in efx_nic_t *enp);
3181 __in efx_nic_t *enp);
3184 * For overlay network encapsulation using UDP, the firmware needs to know
3185 * the configured UDP port for the overlay so it can decode encapsulated
3187 * The UDP port/protocol list is global.
3190 extern __checkReturn efx_rc_t
3191 efx_tunnel_config_udp_add(
3192 __in efx_nic_t *enp,
3193 __in uint16_t port /* host/cpu-endian */,
3194 __in efx_tunnel_protocol_t protocol);
3196 extern __checkReturn efx_rc_t
3197 efx_tunnel_config_udp_remove(
3198 __in efx_nic_t *enp,
3199 __in uint16_t port /* host/cpu-endian */,
3200 __in efx_tunnel_protocol_t protocol);
3203 efx_tunnel_config_clear(
3204 __in efx_nic_t *enp);
3207 * Apply tunnel UDP ports configuration to hardware.
3209 * EAGAIN is returned if hardware will be reset (datapath and managment CPU
3212 extern __checkReturn efx_rc_t
3213 efx_tunnel_reconfigure(
3214 __in efx_nic_t *enp);
3216 #endif /* EFSYS_OPT_TUNNEL */
3218 #if EFSYS_OPT_FW_SUBVARIANT_AWARE
3221 * Firmware subvariant choice options.
3223 * It may be switched to no Tx checksum if attached drivers are either
3224 * preboot or firmware subvariant aware and no VIS are allocated.
3225 * If may be always switched to default explicitly using set request or
3226 * implicitly if unaware driver is attaching. If switching is done when
3227 * a driver is attached, it gets MC_REBOOT event and should recreate its
3230 * See SF-119419-TC DPDK Firmware Driver Interface and
3231 * SF-109306-TC EF10 for Driver Writers for details.
3233 typedef enum efx_nic_fw_subvariant_e {
3234 EFX_NIC_FW_SUBVARIANT_DEFAULT = 0,
3235 EFX_NIC_FW_SUBVARIANT_NO_TX_CSUM = 1,
3236 EFX_NIC_FW_SUBVARIANT_NTYPES
3237 } efx_nic_fw_subvariant_t;
3239 extern __checkReturn efx_rc_t
3240 efx_nic_get_fw_subvariant(
3241 __in efx_nic_t *enp,
3242 __out efx_nic_fw_subvariant_t *subvariantp);
3244 extern __checkReturn efx_rc_t
3245 efx_nic_set_fw_subvariant(
3246 __in efx_nic_t *enp,
3247 __in efx_nic_fw_subvariant_t subvariant);
3249 #endif /* EFSYS_OPT_FW_SUBVARIANT_AWARE */
3251 typedef enum efx_phy_fec_type_e {
3252 EFX_PHY_FEC_NONE = 0,
3255 } efx_phy_fec_type_t;
3257 extern __checkReturn efx_rc_t
3258 efx_phy_fec_type_get(
3259 __in efx_nic_t *enp,
3260 __out efx_phy_fec_type_t *typep);
3262 typedef struct efx_phy_link_state_s {
3263 uint32_t epls_adv_cap_mask;
3264 uint32_t epls_lp_cap_mask;
3265 uint32_t epls_ld_cap_mask;
3266 unsigned int epls_fcntl;
3267 efx_phy_fec_type_t epls_fec;
3268 efx_link_mode_t epls_link_mode;
3269 } efx_phy_link_state_t;
3271 extern __checkReturn efx_rc_t
3272 efx_phy_link_state_get(
3273 __in efx_nic_t *enp,
3274 __out efx_phy_link_state_t *eplsp);
3281 #endif /* _SYS_EFX_H */