1 /* SPDX-License-Identifier: BSD-3-Clause
3 * Copyright (c) 2006-2018 Solarflare Communications Inc.
11 #include "efx_check.h"
12 #include "efx_phy_ids.h"
18 #define EFX_STATIC_ASSERT(_cond) \
19 ((void)sizeof (char[(_cond) ? 1 : -1]))
21 #define EFX_ARRAY_SIZE(_array) \
22 (sizeof (_array) / sizeof ((_array)[0]))
24 #define EFX_FIELD_OFFSET(_type, _field) \
25 ((size_t)&(((_type *)0)->_field))
27 /* The macro expands divider twice */
28 #define EFX_DIV_ROUND_UP(_n, _d) (((_n) + (_d) - 1) / (_d))
32 typedef __success(return == 0) int efx_rc_t;
37 typedef enum efx_family_e {
39 EFX_FAMILY_FALCON, /* Obsolete and not supported */
41 EFX_FAMILY_HUNTINGTON,
47 extern __checkReturn efx_rc_t
51 __out efx_family_t *efp,
52 __out unsigned int *membarp);
55 #define EFX_PCI_VENID_SFC 0x1924
57 #define EFX_PCI_DEVID_FALCON 0x0710 /* SFC4000 */
59 #define EFX_PCI_DEVID_BETHPAGE 0x0803 /* SFC9020 */
60 #define EFX_PCI_DEVID_SIENA 0x0813 /* SFL9021 */
61 #define EFX_PCI_DEVID_SIENA_F1_UNINIT 0x0810
63 #define EFX_PCI_DEVID_HUNTINGTON_PF_UNINIT 0x0901
64 #define EFX_PCI_DEVID_FARMINGDALE 0x0903 /* SFC9120 PF */
65 #define EFX_PCI_DEVID_GREENPORT 0x0923 /* SFC9140 PF */
67 #define EFX_PCI_DEVID_FARMINGDALE_VF 0x1903 /* SFC9120 VF */
68 #define EFX_PCI_DEVID_GREENPORT_VF 0x1923 /* SFC9140 VF */
70 #define EFX_PCI_DEVID_MEDFORD_PF_UNINIT 0x0913
71 #define EFX_PCI_DEVID_MEDFORD 0x0A03 /* SFC9240 PF */
72 #define EFX_PCI_DEVID_MEDFORD_VF 0x1A03 /* SFC9240 VF */
74 #define EFX_PCI_DEVID_MEDFORD2_PF_UNINIT 0x0B13
75 #define EFX_PCI_DEVID_MEDFORD2 0x0B03 /* SFC9250 PF */
76 #define EFX_PCI_DEVID_MEDFORD2_VF 0x1B03 /* SFC9250 VF */
79 #define EFX_MEM_BAR_SIENA 2
81 #define EFX_MEM_BAR_HUNTINGTON_PF 2
82 #define EFX_MEM_BAR_HUNTINGTON_VF 0
84 #define EFX_MEM_BAR_MEDFORD_PF 2
85 #define EFX_MEM_BAR_MEDFORD_VF 0
87 #define EFX_MEM_BAR_MEDFORD2 0
108 /* Calculate the IEEE 802.3 CRC32 of a MAC addr */
109 extern __checkReturn uint32_t
111 __in uint32_t crc_init,
112 __in_ecount(length) uint8_t const *input,
116 /* Type prototypes */
118 typedef struct efx_rxq_s efx_rxq_t;
122 typedef struct efx_nic_s efx_nic_t;
124 extern __checkReturn efx_rc_t
126 __in efx_family_t family,
127 __in efsys_identifier_t *esip,
128 __in efsys_bar_t *esbp,
129 __in efsys_lock_t *eslp,
130 __deref_out efx_nic_t **enpp);
132 extern __checkReturn efx_rc_t
134 __in efx_nic_t *enp);
136 extern __checkReturn efx_rc_t
138 __in efx_nic_t *enp);
140 extern __checkReturn efx_rc_t
142 __in efx_nic_t *enp);
146 extern __checkReturn efx_rc_t
147 efx_nic_register_test(
148 __in efx_nic_t *enp);
150 #endif /* EFSYS_OPT_DIAG */
154 __in efx_nic_t *enp);
158 __in efx_nic_t *enp);
162 __in efx_nic_t *enp);
164 #define EFX_PCIE_LINK_SPEED_GEN1 1
165 #define EFX_PCIE_LINK_SPEED_GEN2 2
166 #define EFX_PCIE_LINK_SPEED_GEN3 3
168 typedef enum efx_pcie_link_performance_e {
169 EFX_PCIE_LINK_PERFORMANCE_UNKNOWN_BANDWIDTH,
170 EFX_PCIE_LINK_PERFORMANCE_SUBOPTIMAL_BANDWIDTH,
171 EFX_PCIE_LINK_PERFORMANCE_SUBOPTIMAL_LATENCY,
172 EFX_PCIE_LINK_PERFORMANCE_OPTIMAL
173 } efx_pcie_link_performance_t;
175 extern __checkReturn efx_rc_t
176 efx_nic_calculate_pcie_link_bandwidth(
177 __in uint32_t pcie_link_width,
178 __in uint32_t pcie_link_gen,
179 __out uint32_t *bandwidth_mbpsp);
181 extern __checkReturn efx_rc_t
182 efx_nic_check_pcie_link_speed(
184 __in uint32_t pcie_link_width,
185 __in uint32_t pcie_link_gen,
186 __out efx_pcie_link_performance_t *resultp);
190 #if EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD || EFSYS_OPT_MEDFORD2
191 /* Huntington and Medford require MCDIv2 commands */
192 #define WITH_MCDI_V2 1
195 typedef struct efx_mcdi_req_s efx_mcdi_req_t;
197 typedef enum efx_mcdi_exception_e {
198 EFX_MCDI_EXCEPTION_MC_REBOOT,
199 EFX_MCDI_EXCEPTION_MC_BADASSERT,
200 } efx_mcdi_exception_t;
202 #if EFSYS_OPT_MCDI_LOGGING
203 typedef enum efx_log_msg_e {
205 EFX_LOG_MCDI_REQUEST,
206 EFX_LOG_MCDI_RESPONSE,
208 #endif /* EFSYS_OPT_MCDI_LOGGING */
210 typedef struct efx_mcdi_transport_s {
212 efsys_mem_t *emt_dma_mem;
213 void (*emt_execute)(void *, efx_mcdi_req_t *);
214 void (*emt_ev_cpl)(void *);
215 void (*emt_exception)(void *, efx_mcdi_exception_t);
216 #if EFSYS_OPT_MCDI_LOGGING
217 void (*emt_logger)(void *, efx_log_msg_t,
218 void *, size_t, void *, size_t);
219 #endif /* EFSYS_OPT_MCDI_LOGGING */
220 #if EFSYS_OPT_MCDI_PROXY_AUTH
221 void (*emt_ev_proxy_response)(void *, uint32_t, efx_rc_t);
222 #endif /* EFSYS_OPT_MCDI_PROXY_AUTH */
223 } efx_mcdi_transport_t;
225 extern __checkReturn efx_rc_t
228 __in const efx_mcdi_transport_t *mtp);
230 extern __checkReturn efx_rc_t
232 __in efx_nic_t *enp);
236 __in efx_nic_t *enp);
239 efx_mcdi_get_timeout(
241 __in efx_mcdi_req_t *emrp,
242 __out uint32_t *usec_timeoutp);
245 efx_mcdi_request_start(
247 __in efx_mcdi_req_t *emrp,
248 __in boolean_t ev_cpl);
250 extern __checkReturn boolean_t
251 efx_mcdi_request_poll(
252 __in efx_nic_t *enp);
254 extern __checkReturn boolean_t
255 efx_mcdi_request_abort(
256 __in efx_nic_t *enp);
260 __in efx_nic_t *enp);
262 #endif /* EFSYS_OPT_MCDI */
266 #define EFX_NINTR_SIENA 1024
268 typedef enum efx_intr_type_e {
269 EFX_INTR_INVALID = 0,
275 #define EFX_INTR_SIZE (sizeof (efx_oword_t))
277 extern __checkReturn efx_rc_t
280 __in efx_intr_type_t type,
281 __in efsys_mem_t *esmp);
285 __in efx_nic_t *enp);
289 __in efx_nic_t *enp);
292 efx_intr_disable_unlocked(
293 __in efx_nic_t *enp);
295 #define EFX_INTR_NEVQS 32
297 extern __checkReturn efx_rc_t
300 __in unsigned int level);
303 efx_intr_status_line(
305 __out boolean_t *fatalp,
306 __out uint32_t *maskp);
309 efx_intr_status_message(
311 __in unsigned int message,
312 __out boolean_t *fatalp);
316 __in efx_nic_t *enp);
320 __in efx_nic_t *enp);
324 #if EFSYS_OPT_MAC_STATS
326 /* START MKCONFIG GENERATED EfxHeaderMacBlock 7d59c0d68431a5d1 */
327 typedef enum efx_mac_stat_e {
330 EFX_MAC_RX_UNICST_PKTS,
331 EFX_MAC_RX_MULTICST_PKTS,
332 EFX_MAC_RX_BRDCST_PKTS,
333 EFX_MAC_RX_PAUSE_PKTS,
334 EFX_MAC_RX_LE_64_PKTS,
335 EFX_MAC_RX_65_TO_127_PKTS,
336 EFX_MAC_RX_128_TO_255_PKTS,
337 EFX_MAC_RX_256_TO_511_PKTS,
338 EFX_MAC_RX_512_TO_1023_PKTS,
339 EFX_MAC_RX_1024_TO_15XX_PKTS,
340 EFX_MAC_RX_GE_15XX_PKTS,
342 EFX_MAC_RX_FCS_ERRORS,
343 EFX_MAC_RX_DROP_EVENTS,
344 EFX_MAC_RX_FALSE_CARRIER_ERRORS,
345 EFX_MAC_RX_SYMBOL_ERRORS,
346 EFX_MAC_RX_ALIGN_ERRORS,
347 EFX_MAC_RX_INTERNAL_ERRORS,
348 EFX_MAC_RX_JABBER_PKTS,
349 EFX_MAC_RX_LANE0_CHAR_ERR,
350 EFX_MAC_RX_LANE1_CHAR_ERR,
351 EFX_MAC_RX_LANE2_CHAR_ERR,
352 EFX_MAC_RX_LANE3_CHAR_ERR,
353 EFX_MAC_RX_LANE0_DISP_ERR,
354 EFX_MAC_RX_LANE1_DISP_ERR,
355 EFX_MAC_RX_LANE2_DISP_ERR,
356 EFX_MAC_RX_LANE3_DISP_ERR,
357 EFX_MAC_RX_MATCH_FAULT,
358 EFX_MAC_RX_NODESC_DROP_CNT,
361 EFX_MAC_TX_UNICST_PKTS,
362 EFX_MAC_TX_MULTICST_PKTS,
363 EFX_MAC_TX_BRDCST_PKTS,
364 EFX_MAC_TX_PAUSE_PKTS,
365 EFX_MAC_TX_LE_64_PKTS,
366 EFX_MAC_TX_65_TO_127_PKTS,
367 EFX_MAC_TX_128_TO_255_PKTS,
368 EFX_MAC_TX_256_TO_511_PKTS,
369 EFX_MAC_TX_512_TO_1023_PKTS,
370 EFX_MAC_TX_1024_TO_15XX_PKTS,
371 EFX_MAC_TX_GE_15XX_PKTS,
373 EFX_MAC_TX_SGL_COL_PKTS,
374 EFX_MAC_TX_MULT_COL_PKTS,
375 EFX_MAC_TX_EX_COL_PKTS,
376 EFX_MAC_TX_LATE_COL_PKTS,
378 EFX_MAC_TX_EX_DEF_PKTS,
379 EFX_MAC_PM_TRUNC_BB_OVERFLOW,
380 EFX_MAC_PM_DISCARD_BB_OVERFLOW,
381 EFX_MAC_PM_TRUNC_VFIFO_FULL,
382 EFX_MAC_PM_DISCARD_VFIFO_FULL,
383 EFX_MAC_PM_TRUNC_QBB,
384 EFX_MAC_PM_DISCARD_QBB,
385 EFX_MAC_PM_DISCARD_MAPPING,
386 EFX_MAC_RXDP_Q_DISABLED_PKTS,
387 EFX_MAC_RXDP_DI_DROPPED_PKTS,
388 EFX_MAC_RXDP_STREAMING_PKTS,
389 EFX_MAC_RXDP_HLB_FETCH,
390 EFX_MAC_RXDP_HLB_WAIT,
391 EFX_MAC_VADAPTER_RX_UNICAST_PACKETS,
392 EFX_MAC_VADAPTER_RX_UNICAST_BYTES,
393 EFX_MAC_VADAPTER_RX_MULTICAST_PACKETS,
394 EFX_MAC_VADAPTER_RX_MULTICAST_BYTES,
395 EFX_MAC_VADAPTER_RX_BROADCAST_PACKETS,
396 EFX_MAC_VADAPTER_RX_BROADCAST_BYTES,
397 EFX_MAC_VADAPTER_RX_BAD_PACKETS,
398 EFX_MAC_VADAPTER_RX_BAD_BYTES,
399 EFX_MAC_VADAPTER_RX_OVERFLOW,
400 EFX_MAC_VADAPTER_TX_UNICAST_PACKETS,
401 EFX_MAC_VADAPTER_TX_UNICAST_BYTES,
402 EFX_MAC_VADAPTER_TX_MULTICAST_PACKETS,
403 EFX_MAC_VADAPTER_TX_MULTICAST_BYTES,
404 EFX_MAC_VADAPTER_TX_BROADCAST_PACKETS,
405 EFX_MAC_VADAPTER_TX_BROADCAST_BYTES,
406 EFX_MAC_VADAPTER_TX_BAD_PACKETS,
407 EFX_MAC_VADAPTER_TX_BAD_BYTES,
408 EFX_MAC_VADAPTER_TX_OVERFLOW,
409 EFX_MAC_FEC_UNCORRECTED_ERRORS,
410 EFX_MAC_FEC_CORRECTED_ERRORS,
411 EFX_MAC_FEC_CORRECTED_SYMBOLS_LANE0,
412 EFX_MAC_FEC_CORRECTED_SYMBOLS_LANE1,
413 EFX_MAC_FEC_CORRECTED_SYMBOLS_LANE2,
414 EFX_MAC_FEC_CORRECTED_SYMBOLS_LANE3,
415 EFX_MAC_CTPIO_VI_BUSY_FALLBACK,
416 EFX_MAC_CTPIO_LONG_WRITE_SUCCESS,
417 EFX_MAC_CTPIO_MISSING_DBELL_FAIL,
418 EFX_MAC_CTPIO_OVERFLOW_FAIL,
419 EFX_MAC_CTPIO_UNDERFLOW_FAIL,
420 EFX_MAC_CTPIO_TIMEOUT_FAIL,
421 EFX_MAC_CTPIO_NONCONTIG_WR_FAIL,
422 EFX_MAC_CTPIO_FRM_CLOBBER_FAIL,
423 EFX_MAC_CTPIO_INVALID_WR_FAIL,
424 EFX_MAC_CTPIO_VI_CLOBBER_FALLBACK,
425 EFX_MAC_CTPIO_UNQUALIFIED_FALLBACK,
426 EFX_MAC_CTPIO_RUNT_FALLBACK,
427 EFX_MAC_CTPIO_SUCCESS,
428 EFX_MAC_CTPIO_FALLBACK,
429 EFX_MAC_CTPIO_POISON,
434 /* END MKCONFIG GENERATED EfxHeaderMacBlock */
436 #endif /* EFSYS_OPT_MAC_STATS */
438 typedef enum efx_link_mode_e {
439 EFX_LINK_UNKNOWN = 0,
455 #define EFX_MAC_ADDR_LEN 6
457 #define EFX_MAC_ADDR_IS_MULTICAST(_address) (((uint8_t *)_address)[0] & 0x01)
459 #define EFX_MAC_MULTICAST_LIST_MAX 256
461 #define EFX_MAC_SDU_MAX 9202
463 #define EFX_MAC_PDU_ADJUSTMENT \
467 + /* bug16011 */ 16) \
469 #define EFX_MAC_PDU(_sdu) \
470 P2ROUNDUP((_sdu) + EFX_MAC_PDU_ADJUSTMENT, 8)
473 * Due to the P2ROUNDUP in EFX_MAC_PDU(), EFX_MAC_SDU_FROM_PDU() may give
474 * the SDU rounded up slightly.
476 #define EFX_MAC_SDU_FROM_PDU(_pdu) ((_pdu) - EFX_MAC_PDU_ADJUSTMENT)
478 #define EFX_MAC_PDU_MIN 60
479 #define EFX_MAC_PDU_MAX EFX_MAC_PDU(EFX_MAC_SDU_MAX)
481 extern __checkReturn efx_rc_t
486 extern __checkReturn efx_rc_t
491 extern __checkReturn efx_rc_t
496 extern __checkReturn efx_rc_t
499 __in boolean_t all_unicst,
500 __in boolean_t mulcst,
501 __in boolean_t all_mulcst,
502 __in boolean_t brdcst);
504 extern __checkReturn efx_rc_t
505 efx_mac_multicast_list_set(
507 __in_ecount(6*count) uint8_t const *addrs,
510 extern __checkReturn efx_rc_t
511 efx_mac_filter_default_rxq_set(
514 __in boolean_t using_rss);
517 efx_mac_filter_default_rxq_clear(
518 __in efx_nic_t *enp);
520 extern __checkReturn efx_rc_t
523 __in boolean_t enabled);
525 extern __checkReturn efx_rc_t
528 __out boolean_t *mac_upp);
530 #define EFX_FCNTL_RESPOND 0x00000001
531 #define EFX_FCNTL_GENERATE 0x00000002
533 extern __checkReturn efx_rc_t
536 __in unsigned int fcntl,
537 __in boolean_t autoneg);
542 __out unsigned int *fcntl_wantedp,
543 __out unsigned int *fcntl_linkp);
546 #if EFSYS_OPT_MAC_STATS
550 extern __checkReturn const char *
553 __in unsigned int id);
555 #endif /* EFSYS_OPT_NAMES */
557 #define EFX_MAC_STATS_MASK_BITS_PER_PAGE (8 * sizeof (uint32_t))
559 #define EFX_MAC_STATS_MASK_NPAGES \
560 (P2ROUNDUP(EFX_MAC_NSTATS, EFX_MAC_STATS_MASK_BITS_PER_PAGE) / \
561 EFX_MAC_STATS_MASK_BITS_PER_PAGE)
564 * Get mask of MAC statistics supported by the hardware.
566 * If mask_size is insufficient to return the mask, EINVAL error is
567 * returned. EFX_MAC_STATS_MASK_NPAGES multiplied by size of the page
568 * (which is sizeof (uint32_t)) is sufficient.
570 extern __checkReturn efx_rc_t
571 efx_mac_stats_get_mask(
573 __out_bcount(mask_size) uint32_t *maskp,
574 __in size_t mask_size);
576 #define EFX_MAC_STAT_SUPPORTED(_mask, _stat) \
577 ((_mask)[(_stat) / EFX_MAC_STATS_MASK_BITS_PER_PAGE] & \
578 (1ULL << ((_stat) & (EFX_MAC_STATS_MASK_BITS_PER_PAGE - 1))))
581 extern __checkReturn efx_rc_t
583 __in efx_nic_t *enp);
586 * Upload mac statistics supported by the hardware into the given buffer.
588 * The DMA buffer must be 4Kbyte aligned and sized to hold at least
589 * efx_nic_cfg_t::enc_mac_stats_nstats 64bit counters.
591 * The hardware will only DMA statistics that it understands (of course).
592 * Drivers should not make any assumptions about which statistics are
593 * supported, especially when the statistics are generated by firmware.
595 * Thus, drivers should zero this buffer before use, so that not-understood
596 * statistics read back as zero.
598 extern __checkReturn efx_rc_t
599 efx_mac_stats_upload(
601 __in efsys_mem_t *esmp);
603 extern __checkReturn efx_rc_t
604 efx_mac_stats_periodic(
606 __in efsys_mem_t *esmp,
607 __in uint16_t period_ms,
608 __in boolean_t events);
610 extern __checkReturn efx_rc_t
611 efx_mac_stats_update(
613 __in efsys_mem_t *esmp,
614 __inout_ecount(EFX_MAC_NSTATS) efsys_stat_t *stat,
615 __inout_opt uint32_t *generationp);
617 #endif /* EFSYS_OPT_MAC_STATS */
621 typedef enum efx_mon_type_e {
633 __in efx_nic_t *enp);
635 #endif /* EFSYS_OPT_NAMES */
637 extern __checkReturn efx_rc_t
639 __in efx_nic_t *enp);
641 #if EFSYS_OPT_MON_STATS
643 #define EFX_MON_STATS_PAGE_SIZE 0x100
644 #define EFX_MON_MASK_ELEMENT_SIZE 32
646 /* START MKCONFIG GENERATED MonitorHeaderStatsBlock 400fdb0517af1fca */
647 typedef enum efx_mon_stat_e {
654 EFX_MON_STAT_EXT_TEMP,
655 EFX_MON_STAT_INT_TEMP,
658 EFX_MON_STAT_INT_COOLING,
659 EFX_MON_STAT_EXT_COOLING,
667 EFX_MON_STAT_AOE_TEMP,
668 EFX_MON_STAT_PSU_AOE_TEMP,
669 EFX_MON_STAT_PSU_TEMP,
675 EFX_MON_STAT_VAOE_IN,
677 EFX_MON_STAT_IAOE_IN,
678 EFX_MON_STAT_NIC_POWER,
682 EFX_MON_STAT_0_9V_ADC,
683 EFX_MON_STAT_INT_TEMP2,
684 EFX_MON_STAT_VREG_TEMP,
685 EFX_MON_STAT_VREG_0_9V_TEMP,
686 EFX_MON_STAT_VREG_1_2V_TEMP,
687 EFX_MON_STAT_INT_VPTAT,
688 EFX_MON_STAT_INT_ADC_TEMP,
689 EFX_MON_STAT_EXT_VPTAT,
690 EFX_MON_STAT_EXT_ADC_TEMP,
691 EFX_MON_STAT_AMBIENT_TEMP,
692 EFX_MON_STAT_AIRFLOW,
693 EFX_MON_STAT_VDD08D_VSS08D_CSR,
694 EFX_MON_STAT_VDD08D_VSS08D_CSR_EXTADC,
695 EFX_MON_STAT_HOTPOINT_TEMP,
696 EFX_MON_STAT_PHY_POWER_SWITCH_PORT0,
697 EFX_MON_STAT_PHY_POWER_SWITCH_PORT1,
698 EFX_MON_STAT_MUM_VCC,
701 EFX_MON_STAT_0V9_A_TEMP,
704 EFX_MON_STAT_0V9_B_TEMP,
705 EFX_MON_STAT_CCOM_AVREG_1V2_SUPPLY,
706 EFX_MON_STAT_CCOM_AVREG_1V2_SUPPLY_EXT_ADC,
707 EFX_MON_STAT_CCOM_AVREG_1V8_SUPPLY,
708 EFX_MON_STAT_CCOM_AVREG_1V8_SUPPLY_EXT_ADC,
709 EFX_MON_STAT_CONTROLLER_MASTER_VPTAT,
710 EFX_MON_STAT_CONTROLLER_MASTER_INTERNAL_TEMP,
711 EFX_MON_STAT_CONTROLLER_MASTER_VPTAT_EXT_ADC,
712 EFX_MON_STAT_CONTROLLER_MASTER_INTERNAL_TEMP_EXT_ADC,
713 EFX_MON_STAT_CONTROLLER_SLAVE_VPTAT,
714 EFX_MON_STAT_CONTROLLER_SLAVE_INTERNAL_TEMP,
715 EFX_MON_STAT_CONTROLLER_SLAVE_VPTAT_EXT_ADC,
716 EFX_MON_STAT_CONTROLLER_SLAVE_INTERNAL_TEMP_EXT_ADC,
717 EFX_MON_STAT_SODIMM_VOUT,
718 EFX_MON_STAT_SODIMM_0_TEMP,
719 EFX_MON_STAT_SODIMM_1_TEMP,
720 EFX_MON_STAT_PHY0_VCC,
721 EFX_MON_STAT_PHY1_VCC,
722 EFX_MON_STAT_CONTROLLER_TDIODE_TEMP,
723 EFX_MON_STAT_BOARD_FRONT_TEMP,
724 EFX_MON_STAT_BOARD_BACK_TEMP,
734 /* END MKCONFIG GENERATED MonitorHeaderStatsBlock */
736 typedef enum efx_mon_stat_state_e {
737 EFX_MON_STAT_STATE_OK = 0,
738 EFX_MON_STAT_STATE_WARNING = 1,
739 EFX_MON_STAT_STATE_FATAL = 2,
740 EFX_MON_STAT_STATE_BROKEN = 3,
741 EFX_MON_STAT_STATE_NO_READING = 4,
742 } efx_mon_stat_state_t;
744 typedef struct efx_mon_stat_value_s {
747 } efx_mon_stat_value_t;
754 __in efx_mon_stat_t id);
756 #endif /* EFSYS_OPT_NAMES */
758 extern __checkReturn efx_rc_t
759 efx_mon_stats_update(
761 __in efsys_mem_t *esmp,
762 __inout_ecount(EFX_MON_NSTATS) efx_mon_stat_value_t *values);
764 #endif /* EFSYS_OPT_MON_STATS */
768 __in efx_nic_t *enp);
772 extern __checkReturn efx_rc_t
774 __in efx_nic_t *enp);
776 #if EFSYS_OPT_PHY_LED_CONTROL
778 typedef enum efx_phy_led_mode_e {
779 EFX_PHY_LED_DEFAULT = 0,
784 } efx_phy_led_mode_t;
786 extern __checkReturn efx_rc_t
789 __in efx_phy_led_mode_t mode);
791 #endif /* EFSYS_OPT_PHY_LED_CONTROL */
793 extern __checkReturn efx_rc_t
795 __in efx_nic_t *enp);
797 #if EFSYS_OPT_LOOPBACK
799 typedef enum efx_loopback_type_e {
800 EFX_LOOPBACK_OFF = 0,
801 EFX_LOOPBACK_DATA = 1,
802 EFX_LOOPBACK_GMAC = 2,
803 EFX_LOOPBACK_XGMII = 3,
804 EFX_LOOPBACK_XGXS = 4,
805 EFX_LOOPBACK_XAUI = 5,
806 EFX_LOOPBACK_GMII = 6,
807 EFX_LOOPBACK_SGMII = 7,
808 EFX_LOOPBACK_XGBR = 8,
809 EFX_LOOPBACK_XFI = 9,
810 EFX_LOOPBACK_XAUI_FAR = 10,
811 EFX_LOOPBACK_GMII_FAR = 11,
812 EFX_LOOPBACK_SGMII_FAR = 12,
813 EFX_LOOPBACK_XFI_FAR = 13,
814 EFX_LOOPBACK_GPHY = 14,
815 EFX_LOOPBACK_PHY_XS = 15,
816 EFX_LOOPBACK_PCS = 16,
817 EFX_LOOPBACK_PMA_PMD = 17,
818 EFX_LOOPBACK_XPORT = 18,
819 EFX_LOOPBACK_XGMII_WS = 19,
820 EFX_LOOPBACK_XAUI_WS = 20,
821 EFX_LOOPBACK_XAUI_WS_FAR = 21,
822 EFX_LOOPBACK_XAUI_WS_NEAR = 22,
823 EFX_LOOPBACK_GMII_WS = 23,
824 EFX_LOOPBACK_XFI_WS = 24,
825 EFX_LOOPBACK_XFI_WS_FAR = 25,
826 EFX_LOOPBACK_PHYXS_WS = 26,
827 EFX_LOOPBACK_PMA_INT = 27,
828 EFX_LOOPBACK_SD_NEAR = 28,
829 EFX_LOOPBACK_SD_FAR = 29,
830 EFX_LOOPBACK_PMA_INT_WS = 30,
831 EFX_LOOPBACK_SD_FEP2_WS = 31,
832 EFX_LOOPBACK_SD_FEP1_5_WS = 32,
833 EFX_LOOPBACK_SD_FEP_WS = 33,
834 EFX_LOOPBACK_SD_FES_WS = 34,
835 EFX_LOOPBACK_AOE_INT_NEAR = 35,
836 EFX_LOOPBACK_DATA_WS = 36,
837 EFX_LOOPBACK_FORCE_EXT_LINK = 37,
839 } efx_loopback_type_t;
841 typedef enum efx_loopback_kind_e {
842 EFX_LOOPBACK_KIND_OFF = 0,
843 EFX_LOOPBACK_KIND_ALL,
844 EFX_LOOPBACK_KIND_MAC,
845 EFX_LOOPBACK_KIND_PHY,
847 } efx_loopback_kind_t;
851 __in efx_loopback_kind_t loopback_kind,
852 __out efx_qword_t *maskp);
854 extern __checkReturn efx_rc_t
855 efx_port_loopback_set(
857 __in efx_link_mode_t link_mode,
858 __in efx_loopback_type_t type);
862 extern __checkReturn const char *
863 efx_loopback_type_name(
865 __in efx_loopback_type_t type);
867 #endif /* EFSYS_OPT_NAMES */
869 #endif /* EFSYS_OPT_LOOPBACK */
871 extern __checkReturn efx_rc_t
874 __out_opt efx_link_mode_t *link_modep);
878 __in efx_nic_t *enp);
880 typedef enum efx_phy_cap_type_e {
881 EFX_PHY_CAP_INVALID = 0,
888 EFX_PHY_CAP_10000FDX,
892 EFX_PHY_CAP_40000FDX,
894 EFX_PHY_CAP_100000FDX,
895 EFX_PHY_CAP_25000FDX,
896 EFX_PHY_CAP_50000FDX,
897 EFX_PHY_CAP_BASER_FEC,
898 EFX_PHY_CAP_BASER_FEC_REQUESTED,
900 EFX_PHY_CAP_RS_FEC_REQUESTED,
901 EFX_PHY_CAP_25G_BASER_FEC,
902 EFX_PHY_CAP_25G_BASER_FEC_REQUESTED,
904 } efx_phy_cap_type_t;
907 #define EFX_PHY_CAP_CURRENT 0x00000000
908 #define EFX_PHY_CAP_DEFAULT 0x00000001
909 #define EFX_PHY_CAP_PERM 0x00000002
915 __out uint32_t *maskp);
917 extern __checkReturn efx_rc_t
925 __out uint32_t *maskp);
927 extern __checkReturn efx_rc_t
930 __out uint32_t *ouip);
932 typedef enum efx_phy_media_type_e {
933 EFX_PHY_MEDIA_INVALID = 0,
938 EFX_PHY_MEDIA_SFP_PLUS,
939 EFX_PHY_MEDIA_BASE_T,
940 EFX_PHY_MEDIA_QSFP_PLUS,
942 } efx_phy_media_type_t;
945 * Get the type of medium currently used. If the board has ports for
946 * modules, a module is present, and we recognise the media type of
947 * the module, then this will be the media type of the module.
948 * Otherwise it will be the media type of the port.
951 efx_phy_media_type_get(
953 __out efx_phy_media_type_t *typep);
955 extern __checkReturn efx_rc_t
956 efx_phy_module_get_info(
958 __in uint8_t dev_addr,
961 __out_bcount(len) uint8_t *data);
963 #if EFSYS_OPT_PHY_STATS
965 /* START MKCONFIG GENERATED PhyHeaderStatsBlock 30ed56ad501f8e36 */
966 typedef enum efx_phy_stat_e {
968 EFX_PHY_STAT_PMA_PMD_LINK_UP,
969 EFX_PHY_STAT_PMA_PMD_RX_FAULT,
970 EFX_PHY_STAT_PMA_PMD_TX_FAULT,
971 EFX_PHY_STAT_PMA_PMD_REV_A,
972 EFX_PHY_STAT_PMA_PMD_REV_B,
973 EFX_PHY_STAT_PMA_PMD_REV_C,
974 EFX_PHY_STAT_PMA_PMD_REV_D,
975 EFX_PHY_STAT_PCS_LINK_UP,
976 EFX_PHY_STAT_PCS_RX_FAULT,
977 EFX_PHY_STAT_PCS_TX_FAULT,
978 EFX_PHY_STAT_PCS_BER,
979 EFX_PHY_STAT_PCS_BLOCK_ERRORS,
980 EFX_PHY_STAT_PHY_XS_LINK_UP,
981 EFX_PHY_STAT_PHY_XS_RX_FAULT,
982 EFX_PHY_STAT_PHY_XS_TX_FAULT,
983 EFX_PHY_STAT_PHY_XS_ALIGN,
984 EFX_PHY_STAT_PHY_XS_SYNC_A,
985 EFX_PHY_STAT_PHY_XS_SYNC_B,
986 EFX_PHY_STAT_PHY_XS_SYNC_C,
987 EFX_PHY_STAT_PHY_XS_SYNC_D,
988 EFX_PHY_STAT_AN_LINK_UP,
989 EFX_PHY_STAT_AN_MASTER,
990 EFX_PHY_STAT_AN_LOCAL_RX_OK,
991 EFX_PHY_STAT_AN_REMOTE_RX_OK,
992 EFX_PHY_STAT_CL22EXT_LINK_UP,
997 EFX_PHY_STAT_PMA_PMD_SIGNAL_A,
998 EFX_PHY_STAT_PMA_PMD_SIGNAL_B,
999 EFX_PHY_STAT_PMA_PMD_SIGNAL_C,
1000 EFX_PHY_STAT_PMA_PMD_SIGNAL_D,
1001 EFX_PHY_STAT_AN_COMPLETE,
1002 EFX_PHY_STAT_PMA_PMD_REV_MAJOR,
1003 EFX_PHY_STAT_PMA_PMD_REV_MINOR,
1004 EFX_PHY_STAT_PMA_PMD_REV_MICRO,
1005 EFX_PHY_STAT_PCS_FW_VERSION_0,
1006 EFX_PHY_STAT_PCS_FW_VERSION_1,
1007 EFX_PHY_STAT_PCS_FW_VERSION_2,
1008 EFX_PHY_STAT_PCS_FW_VERSION_3,
1009 EFX_PHY_STAT_PCS_FW_BUILD_YY,
1010 EFX_PHY_STAT_PCS_FW_BUILD_MM,
1011 EFX_PHY_STAT_PCS_FW_BUILD_DD,
1012 EFX_PHY_STAT_PCS_OP_MODE,
1016 /* END MKCONFIG GENERATED PhyHeaderStatsBlock */
1022 __in efx_nic_t *enp,
1023 __in efx_phy_stat_t stat);
1025 #endif /* EFSYS_OPT_NAMES */
1027 #define EFX_PHY_STATS_SIZE 0x100
1029 extern __checkReturn efx_rc_t
1030 efx_phy_stats_update(
1031 __in efx_nic_t *enp,
1032 __in efsys_mem_t *esmp,
1033 __inout_ecount(EFX_PHY_NSTATS) uint32_t *stat);
1035 #endif /* EFSYS_OPT_PHY_STATS */
1040 typedef enum efx_bist_type_e {
1041 EFX_BIST_TYPE_UNKNOWN,
1042 EFX_BIST_TYPE_PHY_NORMAL,
1043 EFX_BIST_TYPE_PHY_CABLE_SHORT,
1044 EFX_BIST_TYPE_PHY_CABLE_LONG,
1045 EFX_BIST_TYPE_MC_MEM, /* Test the MC DMEM and IMEM */
1046 EFX_BIST_TYPE_SAT_MEM, /* Test the DMEM and IMEM of satellite cpus */
1047 EFX_BIST_TYPE_REG, /* Test the register memories */
1048 EFX_BIST_TYPE_NTYPES,
1051 typedef enum efx_bist_result_e {
1052 EFX_BIST_RESULT_UNKNOWN,
1053 EFX_BIST_RESULT_RUNNING,
1054 EFX_BIST_RESULT_PASSED,
1055 EFX_BIST_RESULT_FAILED,
1056 } efx_bist_result_t;
1058 typedef enum efx_phy_cable_status_e {
1059 EFX_PHY_CABLE_STATUS_OK,
1060 EFX_PHY_CABLE_STATUS_INVALID,
1061 EFX_PHY_CABLE_STATUS_OPEN,
1062 EFX_PHY_CABLE_STATUS_INTRAPAIRSHORT,
1063 EFX_PHY_CABLE_STATUS_INTERPAIRSHORT,
1064 EFX_PHY_CABLE_STATUS_BUSY,
1065 } efx_phy_cable_status_t;
1067 typedef enum efx_bist_value_e {
1068 EFX_BIST_PHY_CABLE_LENGTH_A,
1069 EFX_BIST_PHY_CABLE_LENGTH_B,
1070 EFX_BIST_PHY_CABLE_LENGTH_C,
1071 EFX_BIST_PHY_CABLE_LENGTH_D,
1072 EFX_BIST_PHY_CABLE_STATUS_A,
1073 EFX_BIST_PHY_CABLE_STATUS_B,
1074 EFX_BIST_PHY_CABLE_STATUS_C,
1075 EFX_BIST_PHY_CABLE_STATUS_D,
1076 EFX_BIST_FAULT_CODE,
1078 * Memory BIST specific values. These match to the MC_CMD_BIST_POLL
1084 EFX_BIST_MEM_EXPECT,
1085 EFX_BIST_MEM_ACTUAL,
1087 EFX_BIST_MEM_ECC_PARITY,
1088 EFX_BIST_MEM_ECC_FATAL,
1092 extern __checkReturn efx_rc_t
1093 efx_bist_enable_offline(
1094 __in efx_nic_t *enp);
1096 extern __checkReturn efx_rc_t
1098 __in efx_nic_t *enp,
1099 __in efx_bist_type_t type);
1101 extern __checkReturn efx_rc_t
1103 __in efx_nic_t *enp,
1104 __in efx_bist_type_t type,
1105 __out efx_bist_result_t *resultp,
1106 __out_opt uint32_t *value_maskp,
1107 __out_ecount_opt(count) unsigned long *valuesp,
1112 __in efx_nic_t *enp,
1113 __in efx_bist_type_t type);
1115 #endif /* EFSYS_OPT_BIST */
1117 #define EFX_FEATURE_IPV6 0x00000001
1118 #define EFX_FEATURE_LFSR_HASH_INSERT 0x00000002
1119 #define EFX_FEATURE_LINK_EVENTS 0x00000004
1120 #define EFX_FEATURE_PERIODIC_MAC_STATS 0x00000008
1121 #define EFX_FEATURE_MCDI 0x00000020
1122 #define EFX_FEATURE_LOOKAHEAD_SPLIT 0x00000040
1123 #define EFX_FEATURE_MAC_HEADER_FILTERS 0x00000080
1124 #define EFX_FEATURE_TURBO 0x00000100
1125 #define EFX_FEATURE_MCDI_DMA 0x00000200
1126 #define EFX_FEATURE_TX_SRC_FILTERS 0x00000400
1127 #define EFX_FEATURE_PIO_BUFFERS 0x00000800
1128 #define EFX_FEATURE_FW_ASSISTED_TSO 0x00001000
1129 #define EFX_FEATURE_FW_ASSISTED_TSO_V2 0x00002000
1130 #define EFX_FEATURE_PACKED_STREAM 0x00004000
1132 typedef enum efx_tunnel_protocol_e {
1133 EFX_TUNNEL_PROTOCOL_NONE = 0,
1134 EFX_TUNNEL_PROTOCOL_VXLAN,
1135 EFX_TUNNEL_PROTOCOL_GENEVE,
1136 EFX_TUNNEL_PROTOCOL_NVGRE,
1138 } efx_tunnel_protocol_t;
1140 typedef enum efx_vi_window_shift_e {
1141 EFX_VI_WINDOW_SHIFT_INVALID = 0,
1142 EFX_VI_WINDOW_SHIFT_8K = 13,
1143 EFX_VI_WINDOW_SHIFT_16K = 14,
1144 EFX_VI_WINDOW_SHIFT_64K = 16,
1145 } efx_vi_window_shift_t;
1147 typedef struct efx_nic_cfg_s {
1148 uint32_t enc_board_type;
1149 uint32_t enc_phy_type;
1151 char enc_phy_name[21];
1153 char enc_phy_revision[21];
1154 efx_mon_type_t enc_mon_type;
1155 #if EFSYS_OPT_MON_STATS
1156 uint32_t enc_mon_stat_dma_buf_size;
1157 uint32_t enc_mon_stat_mask[(EFX_MON_NSTATS + 31) / 32];
1159 unsigned int enc_features;
1160 efx_vi_window_shift_t enc_vi_window_shift;
1161 uint8_t enc_mac_addr[6];
1162 uint8_t enc_port; /* PHY port number */
1163 uint32_t enc_intr_vec_base;
1164 uint32_t enc_intr_limit;
1165 uint32_t enc_evq_limit;
1166 uint32_t enc_txq_limit;
1167 uint32_t enc_rxq_limit;
1168 uint32_t enc_txq_max_ndescs;
1169 uint32_t enc_buftbl_limit;
1170 uint32_t enc_piobuf_limit;
1171 uint32_t enc_piobuf_size;
1172 uint32_t enc_piobuf_min_alloc_size;
1173 uint32_t enc_evq_timer_quantum_ns;
1174 uint32_t enc_evq_timer_max_us;
1175 uint32_t enc_clk_mult;
1176 uint32_t enc_rx_prefix_size;
1177 uint32_t enc_rx_buf_align_start;
1178 uint32_t enc_rx_buf_align_end;
1179 uint32_t enc_rx_scale_max_exclusive_contexts;
1180 #if EFSYS_OPT_LOOPBACK
1181 efx_qword_t enc_loopback_types[EFX_LINK_NMODES];
1182 #endif /* EFSYS_OPT_LOOPBACK */
1183 #if EFSYS_OPT_PHY_FLAGS
1184 uint32_t enc_phy_flags_mask;
1185 #endif /* EFSYS_OPT_PHY_FLAGS */
1186 #if EFSYS_OPT_PHY_LED_CONTROL
1187 uint32_t enc_led_mask;
1188 #endif /* EFSYS_OPT_PHY_LED_CONTROL */
1189 #if EFSYS_OPT_PHY_STATS
1190 uint64_t enc_phy_stat_mask;
1191 #endif /* EFSYS_OPT_PHY_STATS */
1193 uint8_t enc_mcdi_mdio_channel;
1194 #if EFSYS_OPT_PHY_STATS
1195 uint32_t enc_mcdi_phy_stat_mask;
1196 #endif /* EFSYS_OPT_PHY_STATS */
1197 #if EFSYS_OPT_MON_STATS
1198 uint32_t *enc_mcdi_sensor_maskp;
1199 uint32_t enc_mcdi_sensor_mask_size;
1200 #endif /* EFSYS_OPT_MON_STATS */
1201 #endif /* EFSYS_OPT_MCDI */
1203 uint32_t enc_bist_mask;
1204 #endif /* EFSYS_OPT_BIST */
1205 #if EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD || EFSYS_OPT_MEDFORD2
1208 uint32_t enc_privilege_mask;
1209 #endif /* EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD || EFSYS_OPT_MEDFORD2 */
1210 boolean_t enc_bug26807_workaround;
1211 boolean_t enc_bug35388_workaround;
1212 boolean_t enc_bug41750_workaround;
1213 boolean_t enc_bug61265_workaround;
1214 boolean_t enc_rx_batching_enabled;
1215 /* Maximum number of descriptors completed in an rx event. */
1216 uint32_t enc_rx_batch_max;
1217 /* Number of rx descriptors the hardware requires for a push. */
1218 uint32_t enc_rx_push_align;
1219 /* Maximum amount of data in DMA descriptor */
1220 uint32_t enc_tx_dma_desc_size_max;
1222 * Boundary which DMA descriptor data must not cross or 0 if no
1225 uint32_t enc_tx_dma_desc_boundary;
1227 * Maximum number of bytes into the packet the TCP header can start for
1228 * the hardware to apply TSO packet edits.
1230 uint32_t enc_tx_tso_tcp_header_offset_limit;
1231 boolean_t enc_fw_assisted_tso_enabled;
1232 boolean_t enc_fw_assisted_tso_v2_enabled;
1233 boolean_t enc_fw_assisted_tso_v2_encap_enabled;
1234 /* Number of TSO contexts on the NIC (FATSOv2) */
1235 uint32_t enc_fw_assisted_tso_v2_n_contexts;
1236 boolean_t enc_hw_tx_insert_vlan_enabled;
1237 /* Number of PFs on the NIC */
1238 uint32_t enc_hw_pf_count;
1239 /* Datapath firmware vadapter/vport/vswitch support */
1240 boolean_t enc_datapath_cap_evb;
1241 boolean_t enc_rx_disable_scatter_supported;
1242 boolean_t enc_allow_set_mac_with_installed_filters;
1243 boolean_t enc_enhanced_set_mac_supported;
1244 boolean_t enc_init_evq_v2_supported;
1245 boolean_t enc_rx_packed_stream_supported;
1246 boolean_t enc_rx_var_packed_stream_supported;
1247 boolean_t enc_pm_and_rxdp_counters;
1248 boolean_t enc_mac_stats_40g_tx_size_bins;
1249 uint32_t enc_tunnel_encapsulations_supported;
1251 * NIC global maximum for unique UDP tunnel ports shared by all
1254 uint32_t enc_tunnel_config_udp_entries_max;
1255 /* External port identifier */
1256 uint8_t enc_external_port;
1257 uint32_t enc_mcdi_max_payload_length;
1258 /* VPD may be per-PF or global */
1259 boolean_t enc_vpd_is_global;
1260 /* Minimum unidirectional bandwidth in Mb/s to max out all ports */
1261 uint32_t enc_required_pcie_bandwidth_mbps;
1262 uint32_t enc_max_pcie_link_gen;
1263 /* Firmware verifies integrity of NVRAM updates */
1264 uint32_t enc_nvram_update_verify_result_supported;
1265 /* Firmware support for extended MAC_STATS buffer */
1266 uint32_t enc_mac_stats_nstats;
1267 boolean_t enc_fec_counters;
1270 #define EFX_PCI_FUNCTION_IS_PF(_encp) ((_encp)->enc_vf == 0xffff)
1271 #define EFX_PCI_FUNCTION_IS_VF(_encp) ((_encp)->enc_vf != 0xffff)
1273 #define EFX_PCI_FUNCTION(_encp) \
1274 (EFX_PCI_FUNCTION_IS_PF(_encp) ? (_encp)->enc_pf : (_encp)->enc_vf)
1276 #define EFX_PCI_VF_PARENT(_encp) ((_encp)->enc_pf)
1278 extern const efx_nic_cfg_t *
1280 __in efx_nic_t *enp);
1282 typedef struct efx_nic_fw_info_s {
1283 /* Basic FW version information */
1284 uint16_t enfi_mc_fw_version[4];
1286 * If datapath capabilities can be detected,
1287 * additional FW information is to be shown
1289 boolean_t enfi_dpcpu_fw_ids_valid;
1290 /* Rx and Tx datapath CPU FW IDs */
1291 uint16_t enfi_rx_dpcpu_fw_id;
1292 uint16_t enfi_tx_dpcpu_fw_id;
1293 } efx_nic_fw_info_t;
1295 extern __checkReturn efx_rc_t
1296 efx_nic_get_fw_version(
1297 __in efx_nic_t *enp,
1298 __out efx_nic_fw_info_t *enfip);
1300 /* Driver resource limits (minimum required/maximum usable). */
1301 typedef struct efx_drv_limits_s {
1302 uint32_t edl_min_evq_count;
1303 uint32_t edl_max_evq_count;
1305 uint32_t edl_min_rxq_count;
1306 uint32_t edl_max_rxq_count;
1308 uint32_t edl_min_txq_count;
1309 uint32_t edl_max_txq_count;
1311 /* PIO blocks (sub-allocated from piobuf) */
1312 uint32_t edl_min_pio_alloc_size;
1313 uint32_t edl_max_pio_alloc_count;
1316 extern __checkReturn efx_rc_t
1317 efx_nic_set_drv_limits(
1318 __inout efx_nic_t *enp,
1319 __in efx_drv_limits_t *edlp);
1321 typedef enum efx_nic_region_e {
1322 EFX_REGION_VI, /* Memory BAR UC mapping */
1323 EFX_REGION_PIO_WRITE_VI, /* Memory BAR WC mapping */
1326 extern __checkReturn efx_rc_t
1327 efx_nic_get_bar_region(
1328 __in efx_nic_t *enp,
1329 __in efx_nic_region_t region,
1330 __out uint32_t *offsetp,
1331 __out size_t *sizep);
1333 extern __checkReturn efx_rc_t
1334 efx_nic_get_vi_pool(
1335 __in efx_nic_t *enp,
1336 __out uint32_t *evq_countp,
1337 __out uint32_t *rxq_countp,
1338 __out uint32_t *txq_countp);
1343 typedef enum efx_vpd_tag_e {
1350 typedef uint16_t efx_vpd_keyword_t;
1352 typedef struct efx_vpd_value_s {
1353 efx_vpd_tag_t evv_tag;
1354 efx_vpd_keyword_t evv_keyword;
1356 uint8_t evv_value[0x100];
1360 #define EFX_VPD_KEYWORD(x, y) ((x) | ((y) << 8))
1362 extern __checkReturn efx_rc_t
1364 __in efx_nic_t *enp);
1366 extern __checkReturn efx_rc_t
1368 __in efx_nic_t *enp,
1369 __out size_t *sizep);
1371 extern __checkReturn efx_rc_t
1373 __in efx_nic_t *enp,
1374 __out_bcount(size) caddr_t data,
1377 extern __checkReturn efx_rc_t
1379 __in efx_nic_t *enp,
1380 __in_bcount(size) caddr_t data,
1383 extern __checkReturn efx_rc_t
1385 __in efx_nic_t *enp,
1386 __in_bcount(size) caddr_t data,
1389 extern __checkReturn efx_rc_t
1391 __in efx_nic_t *enp,
1392 __in_bcount(size) caddr_t data,
1394 __inout efx_vpd_value_t *evvp);
1396 extern __checkReturn efx_rc_t
1398 __in efx_nic_t *enp,
1399 __inout_bcount(size) caddr_t data,
1401 __in efx_vpd_value_t *evvp);
1403 extern __checkReturn efx_rc_t
1405 __in efx_nic_t *enp,
1406 __inout_bcount(size) caddr_t data,
1408 __out efx_vpd_value_t *evvp,
1409 __inout unsigned int *contp);
1411 extern __checkReturn efx_rc_t
1413 __in efx_nic_t *enp,
1414 __in_bcount(size) caddr_t data,
1419 __in efx_nic_t *enp);
1421 #endif /* EFSYS_OPT_VPD */
1427 typedef enum efx_nvram_type_e {
1428 EFX_NVRAM_INVALID = 0,
1430 EFX_NVRAM_BOOTROM_CFG,
1431 EFX_NVRAM_MC_FIRMWARE,
1432 EFX_NVRAM_MC_GOLDEN,
1438 EFX_NVRAM_FPGA_BACKUP,
1439 EFX_NVRAM_DYNAMIC_CFG,
1442 EFX_NVRAM_MUM_FIRMWARE,
1446 extern __checkReturn efx_rc_t
1448 __in efx_nic_t *enp);
1452 extern __checkReturn efx_rc_t
1454 __in efx_nic_t *enp);
1456 #endif /* EFSYS_OPT_DIAG */
1458 extern __checkReturn efx_rc_t
1460 __in efx_nic_t *enp,
1461 __in efx_nvram_type_t type,
1462 __out size_t *sizep);
1464 extern __checkReturn efx_rc_t
1466 __in efx_nic_t *enp,
1467 __in efx_nvram_type_t type,
1468 __out_opt size_t *pref_chunkp);
1470 extern __checkReturn efx_rc_t
1471 efx_nvram_rw_finish(
1472 __in efx_nic_t *enp,
1473 __in efx_nvram_type_t type,
1474 __out_opt uint32_t *verify_resultp);
1476 extern __checkReturn efx_rc_t
1477 efx_nvram_get_version(
1478 __in efx_nic_t *enp,
1479 __in efx_nvram_type_t type,
1480 __out uint32_t *subtypep,
1481 __out_ecount(4) uint16_t version[4]);
1483 extern __checkReturn efx_rc_t
1484 efx_nvram_read_chunk(
1485 __in efx_nic_t *enp,
1486 __in efx_nvram_type_t type,
1487 __in unsigned int offset,
1488 __out_bcount(size) caddr_t data,
1491 extern __checkReturn efx_rc_t
1492 efx_nvram_read_backup(
1493 __in efx_nic_t *enp,
1494 __in efx_nvram_type_t type,
1495 __in unsigned int offset,
1496 __out_bcount(size) caddr_t data,
1499 extern __checkReturn efx_rc_t
1500 efx_nvram_set_version(
1501 __in efx_nic_t *enp,
1502 __in efx_nvram_type_t type,
1503 __in_ecount(4) uint16_t version[4]);
1505 extern __checkReturn efx_rc_t
1507 __in efx_nic_t *enp,
1508 __in efx_nvram_type_t type,
1509 __in_bcount(partn_size) caddr_t partn_data,
1510 __in size_t partn_size);
1512 extern __checkReturn efx_rc_t
1514 __in efx_nic_t *enp,
1515 __in efx_nvram_type_t type);
1517 extern __checkReturn efx_rc_t
1518 efx_nvram_write_chunk(
1519 __in efx_nic_t *enp,
1520 __in efx_nvram_type_t type,
1521 __in unsigned int offset,
1522 __in_bcount(size) caddr_t data,
1527 __in efx_nic_t *enp);
1529 #endif /* EFSYS_OPT_NVRAM */
1531 #if EFSYS_OPT_BOOTCFG
1533 /* Report size and offset of bootcfg sector in NVRAM partition. */
1534 extern __checkReturn efx_rc_t
1535 efx_bootcfg_sector_info(
1536 __in efx_nic_t *enp,
1538 __out_opt uint32_t *sector_countp,
1539 __out size_t *offsetp,
1540 __out size_t *max_sizep);
1543 * Copy bootcfg sector data to a target buffer which may differ in size.
1544 * Optionally corrects format errors in source buffer.
1547 efx_bootcfg_copy_sector(
1548 __in efx_nic_t *enp,
1549 __inout_bcount(sector_length)
1551 __in size_t sector_length,
1552 __out_bcount(data_size) uint8_t *data,
1553 __in size_t data_size,
1554 __in boolean_t handle_format_errors);
1558 __in efx_nic_t *enp,
1559 __out_bcount(size) uint8_t *data,
1564 __in efx_nic_t *enp,
1565 __in_bcount(size) uint8_t *data,
1568 #endif /* EFSYS_OPT_BOOTCFG */
1570 #if EFSYS_OPT_IMAGE_LAYOUT
1572 #include "ef10_signed_image_layout.h"
1575 * Image header used in unsigned and signed image layouts (see SF-102785-PS).
1578 * The image header format is extensible. However, older drivers require an
1579 * exact match of image header version and header length when validating and
1580 * writing firmware images.
1582 * To avoid breaking backward compatibility, we use the upper bits of the
1583 * controller version fields to contain an extra version number used for
1584 * combined bootROM and UEFI ROM images on EF10 and later (to hold the UEFI ROM
1585 * version). See bug39254 and SF-102785-PS for details.
1587 typedef struct efx_image_header_s {
1589 uint32_t eih_version;
1591 uint32_t eih_subtype;
1592 uint32_t eih_code_size;
1595 uint32_t eih_controller_version_min;
1597 uint16_t eih_controller_version_min_short;
1598 uint8_t eih_extra_version_a;
1599 uint8_t eih_extra_version_b;
1603 uint32_t eih_controller_version_max;
1605 uint16_t eih_controller_version_max_short;
1606 uint8_t eih_extra_version_c;
1607 uint8_t eih_extra_version_d;
1610 uint16_t eih_code_version_a;
1611 uint16_t eih_code_version_b;
1612 uint16_t eih_code_version_c;
1613 uint16_t eih_code_version_d;
1614 } efx_image_header_t;
1616 #define EFX_IMAGE_HEADER_SIZE (40)
1617 #define EFX_IMAGE_HEADER_VERSION (4)
1618 #define EFX_IMAGE_HEADER_MAGIC (0x106F1A5)
1621 typedef struct efx_image_trailer_s {
1623 } efx_image_trailer_t;
1625 #define EFX_IMAGE_TRAILER_SIZE (4)
1627 typedef enum efx_image_format_e {
1628 EFX_IMAGE_FORMAT_NO_IMAGE,
1629 EFX_IMAGE_FORMAT_INVALID,
1630 EFX_IMAGE_FORMAT_UNSIGNED,
1631 EFX_IMAGE_FORMAT_SIGNED,
1632 } efx_image_format_t;
1634 typedef struct efx_image_info_s {
1635 efx_image_format_t eii_format;
1636 uint8_t * eii_imagep;
1637 size_t eii_image_size;
1638 efx_image_header_t * eii_headerp;
1641 extern __checkReturn efx_rc_t
1642 efx_check_reflash_image(
1644 __in uint32_t buffer_size,
1645 __out efx_image_info_t *infop);
1647 extern __checkReturn efx_rc_t
1648 efx_build_signed_image_write_buffer(
1649 __out uint8_t *bufferp,
1650 __in uint32_t buffer_size,
1651 __in efx_image_info_t *infop,
1652 __out efx_image_header_t **headerpp);
1654 #endif /* EFSYS_OPT_IMAGE_LAYOUT */
1658 typedef enum efx_pattern_type_t {
1659 EFX_PATTERN_BYTE_INCREMENT = 0,
1660 EFX_PATTERN_ALL_THE_SAME,
1661 EFX_PATTERN_BIT_ALTERNATE,
1662 EFX_PATTERN_BYTE_ALTERNATE,
1663 EFX_PATTERN_BYTE_CHANGING,
1664 EFX_PATTERN_BIT_SWEEP,
1666 } efx_pattern_type_t;
1669 (*efx_sram_pattern_fn_t)(
1671 __in boolean_t negate,
1672 __out efx_qword_t *eqp);
1674 extern __checkReturn efx_rc_t
1676 __in efx_nic_t *enp,
1677 __in efx_pattern_type_t type);
1679 #endif /* EFSYS_OPT_DIAG */
1681 extern __checkReturn efx_rc_t
1682 efx_sram_buf_tbl_set(
1683 __in efx_nic_t *enp,
1685 __in efsys_mem_t *esmp,
1689 efx_sram_buf_tbl_clear(
1690 __in efx_nic_t *enp,
1694 #define EFX_BUF_TBL_SIZE 0x20000
1696 #define EFX_BUF_SIZE 4096
1700 typedef struct efx_evq_s efx_evq_t;
1702 #if EFSYS_OPT_QSTATS
1704 /* START MKCONFIG GENERATED EfxHeaderEventQueueBlock 6f3843f5fe7cc843 */
1705 typedef enum efx_ev_qstat_e {
1711 EV_RX_PAUSE_FRM_ERR,
1712 EV_RX_BUF_OWNER_ID_ERR,
1713 EV_RX_IPV4_HDR_CHKSUM_ERR,
1714 EV_RX_TCP_UDP_CHKSUM_ERR,
1718 EV_RX_MCAST_HASH_MATCH,
1735 EV_DRIVER_SRM_UPD_DONE,
1736 EV_DRIVER_TX_DESCQ_FLS_DONE,
1737 EV_DRIVER_RX_DESCQ_FLS_DONE,
1738 EV_DRIVER_RX_DESCQ_FLS_FAILED,
1739 EV_DRIVER_RX_DSC_ERROR,
1740 EV_DRIVER_TX_DSC_ERROR,
1746 /* END MKCONFIG GENERATED EfxHeaderEventQueueBlock */
1748 #endif /* EFSYS_OPT_QSTATS */
1750 extern __checkReturn efx_rc_t
1752 __in efx_nic_t *enp);
1756 __in efx_nic_t *enp);
1758 #define EFX_EVQ_MAXNEVS 32768
1759 #define EFX_EVQ_MINNEVS 512
1761 #define EFX_EVQ_SIZE(_nevs) ((_nevs) * sizeof (efx_qword_t))
1762 #define EFX_EVQ_NBUFS(_nevs) (EFX_EVQ_SIZE(_nevs) / EFX_BUF_SIZE)
1764 #define EFX_EVQ_FLAGS_TYPE_MASK (0x3)
1765 #define EFX_EVQ_FLAGS_TYPE_AUTO (0x0)
1766 #define EFX_EVQ_FLAGS_TYPE_THROUGHPUT (0x1)
1767 #define EFX_EVQ_FLAGS_TYPE_LOW_LATENCY (0x2)
1769 #define EFX_EVQ_FLAGS_NOTIFY_MASK (0xC)
1770 #define EFX_EVQ_FLAGS_NOTIFY_INTERRUPT (0x0) /* Interrupting (default) */
1771 #define EFX_EVQ_FLAGS_NOTIFY_DISABLED (0x4) /* Non-interrupting */
1773 extern __checkReturn efx_rc_t
1775 __in efx_nic_t *enp,
1776 __in unsigned int index,
1777 __in efsys_mem_t *esmp,
1781 __in uint32_t flags,
1782 __deref_out efx_evq_t **eepp);
1786 __in efx_evq_t *eep,
1787 __in uint16_t data);
1789 typedef __checkReturn boolean_t
1790 (*efx_initialized_ev_t)(
1791 __in_opt void *arg);
1793 #define EFX_PKT_UNICAST 0x0004
1794 #define EFX_PKT_START 0x0008
1796 #define EFX_PKT_VLAN_TAGGED 0x0010
1797 #define EFX_CKSUM_TCPUDP 0x0020
1798 #define EFX_CKSUM_IPV4 0x0040
1799 #define EFX_PKT_CONT 0x0080
1801 #define EFX_CHECK_VLAN 0x0100
1802 #define EFX_PKT_TCP 0x0200
1803 #define EFX_PKT_UDP 0x0400
1804 #define EFX_PKT_IPV4 0x0800
1806 #define EFX_PKT_IPV6 0x1000
1807 #define EFX_PKT_PREFIX_LEN 0x2000
1808 #define EFX_ADDR_MISMATCH 0x4000
1809 #define EFX_DISCARD 0x8000
1812 * The following flags are used only for packed stream
1813 * mode. The values for the flags are reused to fit into 16 bit,
1814 * since EFX_PKT_START and EFX_PKT_CONT are never used in
1815 * packed stream mode
1817 #define EFX_PKT_PACKED_STREAM_NEW_BUFFER EFX_PKT_START
1818 #define EFX_PKT_PACKED_STREAM_PARSE_INCOMPLETE EFX_PKT_CONT
1821 #define EFX_EV_RX_NLABELS 32
1822 #define EFX_EV_TX_NLABELS 32
1824 typedef __checkReturn boolean_t
1827 __in uint32_t label,
1830 __in uint16_t flags);
1832 #if EFSYS_OPT_RX_PACKED_STREAM
1835 * Packed stream mode is documented in SF-112241-TC.
1836 * The general idea is that, instead of putting each incoming
1837 * packet into a separate buffer which is specified in a RX
1838 * descriptor, a large buffer is provided to the hardware and
1839 * packets are put there in a continuous stream.
1840 * The main advantage of such an approach is that RX queue refilling
1841 * happens much less frequently.
1844 typedef __checkReturn boolean_t
1847 __in uint32_t label,
1849 __in uint32_t pkt_count,
1850 __in uint16_t flags);
1854 typedef __checkReturn boolean_t
1857 __in uint32_t label,
1860 #define EFX_EXCEPTION_RX_RECOVERY 0x00000001
1861 #define EFX_EXCEPTION_RX_DSC_ERROR 0x00000002
1862 #define EFX_EXCEPTION_TX_DSC_ERROR 0x00000003
1863 #define EFX_EXCEPTION_UNKNOWN_SENSOREVT 0x00000004
1864 #define EFX_EXCEPTION_FWALERT_SRAM 0x00000005
1865 #define EFX_EXCEPTION_UNKNOWN_FWALERT 0x00000006
1866 #define EFX_EXCEPTION_RX_ERROR 0x00000007
1867 #define EFX_EXCEPTION_TX_ERROR 0x00000008
1868 #define EFX_EXCEPTION_EV_ERROR 0x00000009
1870 typedef __checkReturn boolean_t
1871 (*efx_exception_ev_t)(
1873 __in uint32_t label,
1874 __in uint32_t data);
1876 typedef __checkReturn boolean_t
1877 (*efx_rxq_flush_done_ev_t)(
1879 __in uint32_t rxq_index);
1881 typedef __checkReturn boolean_t
1882 (*efx_rxq_flush_failed_ev_t)(
1884 __in uint32_t rxq_index);
1886 typedef __checkReturn boolean_t
1887 (*efx_txq_flush_done_ev_t)(
1889 __in uint32_t txq_index);
1891 typedef __checkReturn boolean_t
1892 (*efx_software_ev_t)(
1894 __in uint16_t magic);
1896 typedef __checkReturn boolean_t
1899 __in uint32_t code);
1901 #define EFX_SRAM_CLEAR 0
1902 #define EFX_SRAM_UPDATE 1
1903 #define EFX_SRAM_ILLEGAL_CLEAR 2
1905 typedef __checkReturn boolean_t
1906 (*efx_wake_up_ev_t)(
1908 __in uint32_t label);
1910 typedef __checkReturn boolean_t
1913 __in uint32_t label);
1915 typedef __checkReturn boolean_t
1916 (*efx_link_change_ev_t)(
1918 __in efx_link_mode_t link_mode);
1920 #if EFSYS_OPT_MON_STATS
1922 typedef __checkReturn boolean_t
1923 (*efx_monitor_ev_t)(
1925 __in efx_mon_stat_t id,
1926 __in efx_mon_stat_value_t value);
1928 #endif /* EFSYS_OPT_MON_STATS */
1930 #if EFSYS_OPT_MAC_STATS
1932 typedef __checkReturn boolean_t
1933 (*efx_mac_stats_ev_t)(
1935 __in uint32_t generation);
1937 #endif /* EFSYS_OPT_MAC_STATS */
1939 typedef struct efx_ev_callbacks_s {
1940 efx_initialized_ev_t eec_initialized;
1942 #if EFSYS_OPT_RX_PACKED_STREAM
1943 efx_rx_ps_ev_t eec_rx_ps;
1946 efx_exception_ev_t eec_exception;
1947 efx_rxq_flush_done_ev_t eec_rxq_flush_done;
1948 efx_rxq_flush_failed_ev_t eec_rxq_flush_failed;
1949 efx_txq_flush_done_ev_t eec_txq_flush_done;
1950 efx_software_ev_t eec_software;
1951 efx_sram_ev_t eec_sram;
1952 efx_wake_up_ev_t eec_wake_up;
1953 efx_timer_ev_t eec_timer;
1954 efx_link_change_ev_t eec_link_change;
1955 #if EFSYS_OPT_MON_STATS
1956 efx_monitor_ev_t eec_monitor;
1957 #endif /* EFSYS_OPT_MON_STATS */
1958 #if EFSYS_OPT_MAC_STATS
1959 efx_mac_stats_ev_t eec_mac_stats;
1960 #endif /* EFSYS_OPT_MAC_STATS */
1961 } efx_ev_callbacks_t;
1963 extern __checkReturn boolean_t
1965 __in efx_evq_t *eep,
1966 __in unsigned int count);
1968 #if EFSYS_OPT_EV_PREFETCH
1972 __in efx_evq_t *eep,
1973 __in unsigned int count);
1975 #endif /* EFSYS_OPT_EV_PREFETCH */
1979 __in efx_evq_t *eep,
1980 __inout unsigned int *countp,
1981 __in const efx_ev_callbacks_t *eecp,
1982 __in_opt void *arg);
1984 extern __checkReturn efx_rc_t
1985 efx_ev_usecs_to_ticks(
1986 __in efx_nic_t *enp,
1987 __in unsigned int usecs,
1988 __out unsigned int *ticksp);
1990 extern __checkReturn efx_rc_t
1992 __in efx_evq_t *eep,
1993 __in unsigned int us);
1995 extern __checkReturn efx_rc_t
1997 __in efx_evq_t *eep,
1998 __in unsigned int count);
2000 #if EFSYS_OPT_QSTATS
2006 __in efx_nic_t *enp,
2007 __in unsigned int id);
2009 #endif /* EFSYS_OPT_NAMES */
2012 efx_ev_qstats_update(
2013 __in efx_evq_t *eep,
2014 __inout_ecount(EV_NQSTATS) efsys_stat_t *stat);
2016 #endif /* EFSYS_OPT_QSTATS */
2020 __in efx_evq_t *eep);
2024 extern __checkReturn efx_rc_t
2026 __inout efx_nic_t *enp);
2030 __in efx_nic_t *enp);
2032 #if EFSYS_OPT_RX_SCATTER
2033 __checkReturn efx_rc_t
2034 efx_rx_scatter_enable(
2035 __in efx_nic_t *enp,
2036 __in unsigned int buf_size);
2037 #endif /* EFSYS_OPT_RX_SCATTER */
2039 /* Handle to represent use of the default RSS context. */
2040 #define EFX_RSS_CONTEXT_DEFAULT 0xffffffff
2042 #if EFSYS_OPT_RX_SCALE
2044 typedef enum efx_rx_hash_alg_e {
2045 EFX_RX_HASHALG_LFSR = 0,
2046 EFX_RX_HASHALG_TOEPLITZ
2047 } efx_rx_hash_alg_t;
2049 #define EFX_RX_HASH_IPV4 (1U << 0)
2050 #define EFX_RX_HASH_TCPIPV4 (1U << 1)
2051 #define EFX_RX_HASH_IPV6 (1U << 2)
2052 #define EFX_RX_HASH_TCPIPV6 (1U << 3)
2054 typedef unsigned int efx_rx_hash_type_t;
2056 typedef enum efx_rx_hash_support_e {
2057 EFX_RX_HASH_UNAVAILABLE = 0, /* Hardware hash not inserted */
2058 EFX_RX_HASH_AVAILABLE /* Insert hash with/without RSS */
2059 } efx_rx_hash_support_t;
2061 #define EFX_RSS_KEY_SIZE 40 /* RSS key size (bytes) */
2062 #define EFX_RSS_TBL_SIZE 128 /* Rows in RX indirection table */
2063 #define EFX_MAXRSS 64 /* RX indirection entry range */
2064 #define EFX_MAXRSS_LEGACY 16 /* See bug16611 and bug17213 */
2066 typedef enum efx_rx_scale_context_type_e {
2067 EFX_RX_SCALE_UNAVAILABLE = 0, /* No RX scale context */
2068 EFX_RX_SCALE_EXCLUSIVE, /* Writable key/indirection table */
2069 EFX_RX_SCALE_SHARED /* Read-only key/indirection table */
2070 } efx_rx_scale_context_type_t;
2072 extern __checkReturn efx_rc_t
2073 efx_rx_hash_default_support_get(
2074 __in efx_nic_t *enp,
2075 __out efx_rx_hash_support_t *supportp);
2078 extern __checkReturn efx_rc_t
2079 efx_rx_scale_default_support_get(
2080 __in efx_nic_t *enp,
2081 __out efx_rx_scale_context_type_t *typep);
2083 extern __checkReturn efx_rc_t
2084 efx_rx_scale_context_alloc(
2085 __in efx_nic_t *enp,
2086 __in efx_rx_scale_context_type_t type,
2087 __in uint32_t num_queues,
2088 __out uint32_t *rss_contextp);
2090 extern __checkReturn efx_rc_t
2091 efx_rx_scale_context_free(
2092 __in efx_nic_t *enp,
2093 __in uint32_t rss_context);
2095 extern __checkReturn efx_rc_t
2096 efx_rx_scale_mode_set(
2097 __in efx_nic_t *enp,
2098 __in uint32_t rss_context,
2099 __in efx_rx_hash_alg_t alg,
2100 __in efx_rx_hash_type_t type,
2101 __in boolean_t insert);
2103 extern __checkReturn efx_rc_t
2104 efx_rx_scale_tbl_set(
2105 __in efx_nic_t *enp,
2106 __in uint32_t rss_context,
2107 __in_ecount(n) unsigned int *table,
2110 extern __checkReturn efx_rc_t
2111 efx_rx_scale_key_set(
2112 __in efx_nic_t *enp,
2113 __in uint32_t rss_context,
2114 __in_ecount(n) uint8_t *key,
2117 extern __checkReturn uint32_t
2118 efx_pseudo_hdr_hash_get(
2119 __in efx_rxq_t *erp,
2120 __in efx_rx_hash_alg_t func,
2121 __in uint8_t *buffer);
2123 #endif /* EFSYS_OPT_RX_SCALE */
2125 extern __checkReturn efx_rc_t
2126 efx_pseudo_hdr_pkt_length_get(
2127 __in efx_rxq_t *erp,
2128 __in uint8_t *buffer,
2129 __out uint16_t *pkt_lengthp);
2131 #define EFX_RXQ_MAXNDESCS 4096
2132 #define EFX_RXQ_MINNDESCS 512
2134 #define EFX_RXQ_SIZE(_ndescs) ((_ndescs) * sizeof (efx_qword_t))
2135 #define EFX_RXQ_NBUFS(_ndescs) (EFX_RXQ_SIZE(_ndescs) / EFX_BUF_SIZE)
2136 #define EFX_RXQ_LIMIT(_ndescs) ((_ndescs) - 16)
2137 #define EFX_RXQ_DC_NDESCS(_dcsize) (8 << _dcsize)
2139 typedef enum efx_rxq_type_e {
2140 EFX_RXQ_TYPE_DEFAULT,
2141 EFX_RXQ_TYPE_PACKED_STREAM,
2146 * Dummy flag to be used instead of 0 to make it clear that the argument
2147 * is receive queue flags.
2149 #define EFX_RXQ_FLAG_NONE 0x0
2150 #define EFX_RXQ_FLAG_SCATTER 0x1
2152 * If tunnels are supported and Rx event can provide information about
2153 * either outer or inner packet classes (e.g. SFN8xxx adapters with
2154 * full-feature firmware variant running), outer classes are requested by
2155 * default. However, if the driver supports tunnels, the flag allows to
2156 * request inner classes which are required to be able to interpret inner
2157 * Rx checksum offload results.
2159 #define EFX_RXQ_FLAG_INNER_CLASSES 0x2
2161 extern __checkReturn efx_rc_t
2163 __in efx_nic_t *enp,
2164 __in unsigned int index,
2165 __in unsigned int label,
2166 __in efx_rxq_type_t type,
2167 __in efsys_mem_t *esmp,
2170 __in unsigned int flags,
2171 __in efx_evq_t *eep,
2172 __deref_out efx_rxq_t **erpp);
2174 #if EFSYS_OPT_RX_PACKED_STREAM
2176 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_1M (1U * 1024 * 1024)
2177 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_512K (512U * 1024)
2178 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_256K (256U * 1024)
2179 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_128K (128U * 1024)
2180 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_64K (64U * 1024)
2182 extern __checkReturn efx_rc_t
2183 efx_rx_qcreate_packed_stream(
2184 __in efx_nic_t *enp,
2185 __in unsigned int index,
2186 __in unsigned int label,
2187 __in uint32_t ps_buf_size,
2188 __in efsys_mem_t *esmp,
2190 __in efx_evq_t *eep,
2191 __deref_out efx_rxq_t **erpp);
2195 typedef struct efx_buffer_s {
2196 efsys_dma_addr_t eb_addr;
2201 typedef struct efx_desc_s {
2207 __in efx_rxq_t *erp,
2208 __in_ecount(ndescs) efsys_dma_addr_t *addrp,
2210 __in unsigned int ndescs,
2211 __in unsigned int completed,
2212 __in unsigned int added);
2216 __in efx_rxq_t *erp,
2217 __in unsigned int added,
2218 __inout unsigned int *pushedp);
2220 #if EFSYS_OPT_RX_PACKED_STREAM
2223 efx_rx_qpush_ps_credits(
2224 __in efx_rxq_t *erp);
2226 extern __checkReturn uint8_t *
2227 efx_rx_qps_packet_info(
2228 __in efx_rxq_t *erp,
2229 __in uint8_t *buffer,
2230 __in uint32_t buffer_length,
2231 __in uint32_t current_offset,
2232 __out uint16_t *lengthp,
2233 __out uint32_t *next_offsetp,
2234 __out uint32_t *timestamp);
2237 extern __checkReturn efx_rc_t
2239 __in efx_rxq_t *erp);
2243 __in efx_rxq_t *erp);
2247 __in efx_rxq_t *erp);
2251 typedef struct efx_txq_s efx_txq_t;
2253 #if EFSYS_OPT_QSTATS
2255 /* START MKCONFIG GENERATED EfxHeaderTransmitQueueBlock 12dff8778598b2db */
2256 typedef enum efx_tx_qstat_e {
2262 /* END MKCONFIG GENERATED EfxHeaderTransmitQueueBlock */
2264 #endif /* EFSYS_OPT_QSTATS */
2266 extern __checkReturn efx_rc_t
2268 __in efx_nic_t *enp);
2272 __in efx_nic_t *enp);
2274 #define EFX_TXQ_MINNDESCS 512
2276 #define EFX_TXQ_SIZE(_ndescs) ((_ndescs) * sizeof (efx_qword_t))
2277 #define EFX_TXQ_NBUFS(_ndescs) (EFX_TXQ_SIZE(_ndescs) / EFX_BUF_SIZE)
2278 #define EFX_TXQ_LIMIT(_ndescs) ((_ndescs) - 16)
2280 #define EFX_TXQ_MAX_BUFS 8 /* Maximum independent of EFX_BUG35388_WORKAROUND. */
2282 #define EFX_TXQ_CKSUM_IPV4 0x0001
2283 #define EFX_TXQ_CKSUM_TCPUDP 0x0002
2284 #define EFX_TXQ_FATSOV2 0x0004
2285 #define EFX_TXQ_CKSUM_INNER_IPV4 0x0008
2286 #define EFX_TXQ_CKSUM_INNER_TCPUDP 0x0010
2288 extern __checkReturn efx_rc_t
2290 __in efx_nic_t *enp,
2291 __in unsigned int index,
2292 __in unsigned int label,
2293 __in efsys_mem_t *esmp,
2296 __in uint16_t flags,
2297 __in efx_evq_t *eep,
2298 __deref_out efx_txq_t **etpp,
2299 __out unsigned int *addedp);
2301 extern __checkReturn efx_rc_t
2303 __in efx_txq_t *etp,
2304 __in_ecount(ndescs) efx_buffer_t *eb,
2305 __in unsigned int ndescs,
2306 __in unsigned int completed,
2307 __inout unsigned int *addedp);
2309 extern __checkReturn efx_rc_t
2311 __in efx_txq_t *etp,
2312 __in unsigned int ns);
2316 __in efx_txq_t *etp,
2317 __in unsigned int added,
2318 __in unsigned int pushed);
2320 extern __checkReturn efx_rc_t
2322 __in efx_txq_t *etp);
2326 __in efx_txq_t *etp);
2328 extern __checkReturn efx_rc_t
2330 __in efx_txq_t *etp);
2333 efx_tx_qpio_disable(
2334 __in efx_txq_t *etp);
2336 extern __checkReturn efx_rc_t
2338 __in efx_txq_t *etp,
2339 __in_ecount(buf_length) uint8_t *buffer,
2340 __in size_t buf_length,
2341 __in size_t pio_buf_offset);
2343 extern __checkReturn efx_rc_t
2345 __in efx_txq_t *etp,
2346 __in size_t pkt_length,
2347 __in unsigned int completed,
2348 __inout unsigned int *addedp);
2350 extern __checkReturn efx_rc_t
2352 __in efx_txq_t *etp,
2353 __in_ecount(n) efx_desc_t *ed,
2354 __in unsigned int n,
2355 __in unsigned int completed,
2356 __inout unsigned int *addedp);
2359 efx_tx_qdesc_dma_create(
2360 __in efx_txq_t *etp,
2361 __in efsys_dma_addr_t addr,
2364 __out efx_desc_t *edp);
2367 efx_tx_qdesc_tso_create(
2368 __in efx_txq_t *etp,
2369 __in uint16_t ipv4_id,
2370 __in uint32_t tcp_seq,
2371 __in uint8_t tcp_flags,
2372 __out efx_desc_t *edp);
2374 /* Number of FATSOv2 option descriptors */
2375 #define EFX_TX_FATSOV2_OPT_NDESCS 2
2377 /* Maximum number of DMA segments per TSO packet (not superframe) */
2378 #define EFX_TX_FATSOV2_DMA_SEGS_PER_PKT_MAX 24
2381 efx_tx_qdesc_tso2_create(
2382 __in efx_txq_t *etp,
2383 __in uint16_t ipv4_id,
2384 __in uint16_t outer_ipv4_id,
2385 __in uint32_t tcp_seq,
2386 __in uint16_t tcp_mss,
2387 __out_ecount(count) efx_desc_t *edp,
2391 efx_tx_qdesc_vlantci_create(
2392 __in efx_txq_t *etp,
2394 __out efx_desc_t *edp);
2397 efx_tx_qdesc_checksum_create(
2398 __in efx_txq_t *etp,
2399 __in uint16_t flags,
2400 __out efx_desc_t *edp);
2402 #if EFSYS_OPT_QSTATS
2408 __in efx_nic_t *etp,
2409 __in unsigned int id);
2411 #endif /* EFSYS_OPT_NAMES */
2414 efx_tx_qstats_update(
2415 __in efx_txq_t *etp,
2416 __inout_ecount(TX_NQSTATS) efsys_stat_t *stat);
2418 #endif /* EFSYS_OPT_QSTATS */
2422 __in efx_txq_t *etp);
2427 #if EFSYS_OPT_FILTER
2429 #define EFX_ETHER_TYPE_IPV4 0x0800
2430 #define EFX_ETHER_TYPE_IPV6 0x86DD
2432 #define EFX_IPPROTO_TCP 6
2433 #define EFX_IPPROTO_UDP 17
2434 #define EFX_IPPROTO_GRE 47
2436 /* Use RSS to spread across multiple queues */
2437 #define EFX_FILTER_FLAG_RX_RSS 0x01
2438 /* Enable RX scatter */
2439 #define EFX_FILTER_FLAG_RX_SCATTER 0x02
2441 * Override an automatic filter (priority EFX_FILTER_PRI_AUTO).
2442 * May only be set by the filter implementation for each type.
2443 * A removal request will restore the automatic filter in its place.
2445 #define EFX_FILTER_FLAG_RX_OVER_AUTO 0x04
2446 /* Filter is for RX */
2447 #define EFX_FILTER_FLAG_RX 0x08
2448 /* Filter is for TX */
2449 #define EFX_FILTER_FLAG_TX 0x10
2451 typedef uint8_t efx_filter_flags_t;
2454 * Flags which specify the fields to match on. The values are the same as in the
2455 * MC_CMD_FILTER_OP/MC_CMD_FILTER_OP_EXT commands.
2458 /* Match by remote IP host address */
2459 #define EFX_FILTER_MATCH_REM_HOST 0x00000001
2460 /* Match by local IP host address */
2461 #define EFX_FILTER_MATCH_LOC_HOST 0x00000002
2462 /* Match by remote MAC address */
2463 #define EFX_FILTER_MATCH_REM_MAC 0x00000004
2464 /* Match by remote TCP/UDP port */
2465 #define EFX_FILTER_MATCH_REM_PORT 0x00000008
2466 /* Match by remote TCP/UDP port */
2467 #define EFX_FILTER_MATCH_LOC_MAC 0x00000010
2468 /* Match by local TCP/UDP port */
2469 #define EFX_FILTER_MATCH_LOC_PORT 0x00000020
2470 /* Match by Ether-type */
2471 #define EFX_FILTER_MATCH_ETHER_TYPE 0x00000040
2472 /* Match by inner VLAN ID */
2473 #define EFX_FILTER_MATCH_INNER_VID 0x00000080
2474 /* Match by outer VLAN ID */
2475 #define EFX_FILTER_MATCH_OUTER_VID 0x00000100
2476 /* Match by IP transport protocol */
2477 #define EFX_FILTER_MATCH_IP_PROTO 0x00000200
2478 /* For encapsulated packets, match all multicast inner frames */
2479 #define EFX_FILTER_MATCH_IFRM_UNKNOWN_MCAST_DST 0x01000000
2480 /* For encapsulated packets, match all unicast inner frames */
2481 #define EFX_FILTER_MATCH_IFRM_UNKNOWN_UCAST_DST 0x02000000
2482 /* Match otherwise-unmatched multicast and broadcast packets */
2483 #define EFX_FILTER_MATCH_UNKNOWN_MCAST_DST 0x40000000
2484 /* Match otherwise-unmatched unicast packets */
2485 #define EFX_FILTER_MATCH_UNKNOWN_UCAST_DST 0x80000000
2487 typedef uint32_t efx_filter_match_flags_t;
2489 typedef enum efx_filter_priority_s {
2490 EFX_FILTER_PRI_HINT = 0, /* Performance hint */
2491 EFX_FILTER_PRI_AUTO, /* Automatic filter based on device
2492 * address list or hardware
2493 * requirements. This may only be used
2494 * by the filter implementation for
2496 EFX_FILTER_PRI_MANUAL, /* Manually configured filter */
2497 EFX_FILTER_PRI_REQUIRED, /* Required for correct behaviour of the
2498 * client (e.g. SR-IOV, HyperV VMQ etc.)
2500 } efx_filter_priority_t;
2503 * FIXME: All these fields are assumed to be in little-endian byte order.
2504 * It may be better for some to be big-endian. See bug42804.
2507 typedef struct efx_filter_spec_s {
2508 efx_filter_match_flags_t efs_match_flags;
2509 uint8_t efs_priority;
2510 efx_filter_flags_t efs_flags;
2511 uint16_t efs_dmaq_id;
2512 uint32_t efs_rss_context;
2513 uint16_t efs_outer_vid;
2514 uint16_t efs_inner_vid;
2515 uint8_t efs_loc_mac[EFX_MAC_ADDR_LEN];
2516 uint8_t efs_rem_mac[EFX_MAC_ADDR_LEN];
2517 uint16_t efs_ether_type;
2518 uint8_t efs_ip_proto;
2519 efx_tunnel_protocol_t efs_encap_type;
2520 uint16_t efs_loc_port;
2521 uint16_t efs_rem_port;
2522 efx_oword_t efs_rem_host;
2523 efx_oword_t efs_loc_host;
2524 } efx_filter_spec_t;
2527 /* Default values for use in filter specifications */
2528 #define EFX_FILTER_SPEC_RX_DMAQ_ID_DROP 0xfff
2529 #define EFX_FILTER_SPEC_VID_UNSPEC 0xffff
2531 extern __checkReturn efx_rc_t
2533 __in efx_nic_t *enp);
2537 __in efx_nic_t *enp);
2539 extern __checkReturn efx_rc_t
2541 __in efx_nic_t *enp,
2542 __inout efx_filter_spec_t *spec);
2544 extern __checkReturn efx_rc_t
2546 __in efx_nic_t *enp,
2547 __inout efx_filter_spec_t *spec);
2549 extern __checkReturn efx_rc_t
2551 __in efx_nic_t *enp);
2553 extern __checkReturn efx_rc_t
2554 efx_filter_supported_filters(
2555 __in efx_nic_t *enp,
2556 __out_ecount(buffer_length) uint32_t *buffer,
2557 __in size_t buffer_length,
2558 __out size_t *list_lengthp);
2561 efx_filter_spec_init_rx(
2562 __out efx_filter_spec_t *spec,
2563 __in efx_filter_priority_t priority,
2564 __in efx_filter_flags_t flags,
2565 __in efx_rxq_t *erp);
2568 efx_filter_spec_init_tx(
2569 __out efx_filter_spec_t *spec,
2570 __in efx_txq_t *etp);
2572 extern __checkReturn efx_rc_t
2573 efx_filter_spec_set_ipv4_local(
2574 __inout efx_filter_spec_t *spec,
2577 __in uint16_t port);
2579 extern __checkReturn efx_rc_t
2580 efx_filter_spec_set_ipv4_full(
2581 __inout efx_filter_spec_t *spec,
2583 __in uint32_t lhost,
2584 __in uint16_t lport,
2585 __in uint32_t rhost,
2586 __in uint16_t rport);
2588 extern __checkReturn efx_rc_t
2589 efx_filter_spec_set_eth_local(
2590 __inout efx_filter_spec_t *spec,
2592 __in const uint8_t *addr);
2595 efx_filter_spec_set_ether_type(
2596 __inout efx_filter_spec_t *spec,
2597 __in uint16_t ether_type);
2599 extern __checkReturn efx_rc_t
2600 efx_filter_spec_set_uc_def(
2601 __inout efx_filter_spec_t *spec);
2603 extern __checkReturn efx_rc_t
2604 efx_filter_spec_set_mc_def(
2605 __inout efx_filter_spec_t *spec);
2607 typedef enum efx_filter_inner_frame_match_e {
2608 EFX_FILTER_INNER_FRAME_MATCH_OTHER = 0,
2609 EFX_FILTER_INNER_FRAME_MATCH_UNKNOWN_MCAST_DST,
2610 EFX_FILTER_INNER_FRAME_MATCH_UNKNOWN_UCAST_DST
2611 } efx_filter_inner_frame_match_t;
2613 extern __checkReturn efx_rc_t
2614 efx_filter_spec_set_encap_type(
2615 __inout efx_filter_spec_t *spec,
2616 __in efx_tunnel_protocol_t encap_type,
2617 __in efx_filter_inner_frame_match_t inner_frame_match);
2619 #if EFSYS_OPT_RX_SCALE
2620 extern __checkReturn efx_rc_t
2621 efx_filter_spec_set_rss_context(
2622 __inout efx_filter_spec_t *spec,
2623 __in uint32_t rss_context);
2625 #endif /* EFSYS_OPT_FILTER */
2629 extern __checkReturn uint32_t
2631 __in_ecount(count) uint32_t const *input,
2633 __in uint32_t init);
2635 extern __checkReturn uint32_t
2637 __in_ecount(length) uint8_t const *input,
2639 __in uint32_t init);
2641 #if EFSYS_OPT_LICENSING
2645 typedef struct efx_key_stats_s {
2647 uint32_t eks_invalid;
2648 uint32_t eks_blacklisted;
2649 uint32_t eks_unverifiable;
2650 uint32_t eks_wrong_node;
2651 uint32_t eks_licensed_apps_lo;
2652 uint32_t eks_licensed_apps_hi;
2653 uint32_t eks_licensed_features_lo;
2654 uint32_t eks_licensed_features_hi;
2657 extern __checkReturn efx_rc_t
2659 __in efx_nic_t *enp);
2663 __in efx_nic_t *enp);
2665 extern __checkReturn boolean_t
2666 efx_lic_check_support(
2667 __in efx_nic_t *enp);
2669 extern __checkReturn efx_rc_t
2670 efx_lic_update_licenses(
2671 __in efx_nic_t *enp);
2673 extern __checkReturn efx_rc_t
2674 efx_lic_get_key_stats(
2675 __in efx_nic_t *enp,
2676 __out efx_key_stats_t *ksp);
2678 extern __checkReturn efx_rc_t
2680 __in efx_nic_t *enp,
2681 __in uint64_t app_id,
2682 __out boolean_t *licensedp);
2684 extern __checkReturn efx_rc_t
2686 __in efx_nic_t *enp,
2687 __in size_t buffer_size,
2688 __out uint32_t *typep,
2689 __out size_t *lengthp,
2690 __out_opt uint8_t *bufferp);
2693 extern __checkReturn efx_rc_t
2695 __in efx_nic_t *enp,
2696 __in_bcount(buffer_size)
2698 __in size_t buffer_size,
2699 __out uint32_t *startp);
2701 extern __checkReturn efx_rc_t
2703 __in efx_nic_t *enp,
2704 __in_bcount(buffer_size)
2706 __in size_t buffer_size,
2707 __in uint32_t offset,
2708 __out uint32_t *endp);
2710 extern __checkReturn __success(return != B_FALSE) boolean_t
2712 __in efx_nic_t *enp,
2713 __in_bcount(buffer_size)
2715 __in size_t buffer_size,
2716 __in uint32_t offset,
2717 __out uint32_t *startp,
2718 __out uint32_t *lengthp);
2720 extern __checkReturn __success(return != B_FALSE) boolean_t
2721 efx_lic_validate_key(
2722 __in efx_nic_t *enp,
2723 __in_bcount(length) caddr_t keyp,
2724 __in uint32_t length);
2726 extern __checkReturn efx_rc_t
2728 __in efx_nic_t *enp,
2729 __in_bcount(buffer_size)
2731 __in size_t buffer_size,
2732 __in uint32_t offset,
2733 __in uint32_t length,
2734 __out_bcount_part(key_max_size, *lengthp)
2736 __in size_t key_max_size,
2737 __out uint32_t *lengthp);
2739 extern __checkReturn efx_rc_t
2741 __in efx_nic_t *enp,
2742 __in_bcount(buffer_size)
2744 __in size_t buffer_size,
2745 __in uint32_t offset,
2746 __in_bcount(length) caddr_t keyp,
2747 __in uint32_t length,
2748 __out uint32_t *lengthp);
2750 __checkReturn efx_rc_t
2752 __in efx_nic_t *enp,
2753 __in_bcount(buffer_size)
2755 __in size_t buffer_size,
2756 __in uint32_t offset,
2757 __in uint32_t length,
2759 __out uint32_t *deltap);
2761 extern __checkReturn efx_rc_t
2762 efx_lic_create_partition(
2763 __in efx_nic_t *enp,
2764 __in_bcount(buffer_size)
2766 __in size_t buffer_size);
2768 extern __checkReturn efx_rc_t
2769 efx_lic_finish_partition(
2770 __in efx_nic_t *enp,
2771 __in_bcount(buffer_size)
2773 __in size_t buffer_size);
2775 #endif /* EFSYS_OPT_LICENSING */
2779 #if EFSYS_OPT_TUNNEL
2781 extern __checkReturn efx_rc_t
2783 __in efx_nic_t *enp);
2787 __in efx_nic_t *enp);
2790 * For overlay network encapsulation using UDP, the firmware needs to know
2791 * the configured UDP port for the overlay so it can decode encapsulated
2793 * The UDP port/protocol list is global.
2796 extern __checkReturn efx_rc_t
2797 efx_tunnel_config_udp_add(
2798 __in efx_nic_t *enp,
2799 __in uint16_t port /* host/cpu-endian */,
2800 __in efx_tunnel_protocol_t protocol);
2802 extern __checkReturn efx_rc_t
2803 efx_tunnel_config_udp_remove(
2804 __in efx_nic_t *enp,
2805 __in uint16_t port /* host/cpu-endian */,
2806 __in efx_tunnel_protocol_t protocol);
2809 efx_tunnel_config_clear(
2810 __in efx_nic_t *enp);
2813 * Apply tunnel UDP ports configuration to hardware.
2815 * EAGAIN is returned if hardware will be reset (datapath and managment CPU
2818 extern __checkReturn efx_rc_t
2819 efx_tunnel_reconfigure(
2820 __in efx_nic_t *enp);
2822 #endif /* EFSYS_OPT_TUNNEL */
2829 #endif /* _SYS_EFX_H */