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 7b5f45054a3b45bc */
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,
418 /* END MKCONFIG GENERATED EfxHeaderMacBlock */
420 #endif /* EFSYS_OPT_MAC_STATS */
422 typedef enum efx_link_mode_e {
423 EFX_LINK_UNKNOWN = 0,
439 #define EFX_MAC_ADDR_LEN 6
441 #define EFX_MAC_ADDR_IS_MULTICAST(_address) (((uint8_t *)_address)[0] & 0x01)
443 #define EFX_MAC_MULTICAST_LIST_MAX 256
445 #define EFX_MAC_SDU_MAX 9202
447 #define EFX_MAC_PDU_ADJUSTMENT \
451 + /* bug16011 */ 16) \
453 #define EFX_MAC_PDU(_sdu) \
454 P2ROUNDUP((_sdu) + EFX_MAC_PDU_ADJUSTMENT, 8)
457 * Due to the P2ROUNDUP in EFX_MAC_PDU(), EFX_MAC_SDU_FROM_PDU() may give
458 * the SDU rounded up slightly.
460 #define EFX_MAC_SDU_FROM_PDU(_pdu) ((_pdu) - EFX_MAC_PDU_ADJUSTMENT)
462 #define EFX_MAC_PDU_MIN 60
463 #define EFX_MAC_PDU_MAX EFX_MAC_PDU(EFX_MAC_SDU_MAX)
465 extern __checkReturn efx_rc_t
470 extern __checkReturn efx_rc_t
475 extern __checkReturn efx_rc_t
480 extern __checkReturn efx_rc_t
483 __in boolean_t all_unicst,
484 __in boolean_t mulcst,
485 __in boolean_t all_mulcst,
486 __in boolean_t brdcst);
488 extern __checkReturn efx_rc_t
489 efx_mac_multicast_list_set(
491 __in_ecount(6*count) uint8_t const *addrs,
494 extern __checkReturn efx_rc_t
495 efx_mac_filter_default_rxq_set(
498 __in boolean_t using_rss);
501 efx_mac_filter_default_rxq_clear(
502 __in efx_nic_t *enp);
504 extern __checkReturn efx_rc_t
507 __in boolean_t enabled);
509 extern __checkReturn efx_rc_t
512 __out boolean_t *mac_upp);
514 #define EFX_FCNTL_RESPOND 0x00000001
515 #define EFX_FCNTL_GENERATE 0x00000002
517 extern __checkReturn efx_rc_t
520 __in unsigned int fcntl,
521 __in boolean_t autoneg);
526 __out unsigned int *fcntl_wantedp,
527 __out unsigned int *fcntl_linkp);
530 #if EFSYS_OPT_MAC_STATS
534 extern __checkReturn const char *
537 __in unsigned int id);
539 #endif /* EFSYS_OPT_NAMES */
541 #define EFX_MAC_STATS_MASK_BITS_PER_PAGE (8 * sizeof (uint32_t))
543 #define EFX_MAC_STATS_MASK_NPAGES \
544 (P2ROUNDUP(EFX_MAC_NSTATS, EFX_MAC_STATS_MASK_BITS_PER_PAGE) / \
545 EFX_MAC_STATS_MASK_BITS_PER_PAGE)
548 * Get mask of MAC statistics supported by the hardware.
550 * If mask_size is insufficient to return the mask, EINVAL error is
551 * returned. EFX_MAC_STATS_MASK_NPAGES multiplied by size of the page
552 * (which is sizeof (uint32_t)) is sufficient.
554 extern __checkReturn efx_rc_t
555 efx_mac_stats_get_mask(
557 __out_bcount(mask_size) uint32_t *maskp,
558 __in size_t mask_size);
560 #define EFX_MAC_STAT_SUPPORTED(_mask, _stat) \
561 ((_mask)[(_stat) / EFX_MAC_STATS_MASK_BITS_PER_PAGE] & \
562 (1ULL << ((_stat) & (EFX_MAC_STATS_MASK_BITS_PER_PAGE - 1))))
564 #define EFX_MAC_STATS_SIZE 0x400
566 extern __checkReturn efx_rc_t
568 __in efx_nic_t *enp);
571 * Upload mac statistics supported by the hardware into the given buffer.
573 * The reference buffer must be at least %EFX_MAC_STATS_SIZE bytes,
576 * The hardware will only DMA statistics that it understands (of course).
577 * Drivers should not make any assumptions about which statistics are
578 * supported, especially when the statistics are generated by firmware.
580 * Thus, drivers should zero this buffer before use, so that not-understood
581 * statistics read back as zero.
583 extern __checkReturn efx_rc_t
584 efx_mac_stats_upload(
586 __in efsys_mem_t *esmp);
588 extern __checkReturn efx_rc_t
589 efx_mac_stats_periodic(
591 __in efsys_mem_t *esmp,
592 __in uint16_t period_ms,
593 __in boolean_t events);
595 extern __checkReturn efx_rc_t
596 efx_mac_stats_update(
598 __in efsys_mem_t *esmp,
599 __inout_ecount(EFX_MAC_NSTATS) efsys_stat_t *stat,
600 __inout_opt uint32_t *generationp);
602 #endif /* EFSYS_OPT_MAC_STATS */
606 typedef enum efx_mon_type_e {
618 __in efx_nic_t *enp);
620 #endif /* EFSYS_OPT_NAMES */
622 extern __checkReturn efx_rc_t
624 __in efx_nic_t *enp);
626 #if EFSYS_OPT_MON_STATS
628 #define EFX_MON_STATS_PAGE_SIZE 0x100
629 #define EFX_MON_MASK_ELEMENT_SIZE 32
631 /* START MKCONFIG GENERATED MonitorHeaderStatsBlock fcc1b6748432e1ac */
632 typedef enum efx_mon_stat_e {
639 EFX_MON_STAT_EXT_TEMP,
640 EFX_MON_STAT_INT_TEMP,
643 EFX_MON_STAT_INT_COOLING,
644 EFX_MON_STAT_EXT_COOLING,
652 EFX_MON_STAT_AOE_TEMP,
653 EFX_MON_STAT_PSU_AOE_TEMP,
654 EFX_MON_STAT_PSU_TEMP,
660 EFX_MON_STAT_VAOE_IN,
662 EFX_MON_STAT_IAOE_IN,
663 EFX_MON_STAT_NIC_POWER,
667 EFX_MON_STAT_0_9V_ADC,
668 EFX_MON_STAT_INT_TEMP2,
669 EFX_MON_STAT_VREG_TEMP,
670 EFX_MON_STAT_VREG_0_9V_TEMP,
671 EFX_MON_STAT_VREG_1_2V_TEMP,
672 EFX_MON_STAT_INT_VPTAT,
673 EFX_MON_STAT_INT_ADC_TEMP,
674 EFX_MON_STAT_EXT_VPTAT,
675 EFX_MON_STAT_EXT_ADC_TEMP,
676 EFX_MON_STAT_AMBIENT_TEMP,
677 EFX_MON_STAT_AIRFLOW,
678 EFX_MON_STAT_VDD08D_VSS08D_CSR,
679 EFX_MON_STAT_VDD08D_VSS08D_CSR_EXTADC,
680 EFX_MON_STAT_HOTPOINT_TEMP,
681 EFX_MON_STAT_PHY_POWER_SWITCH_PORT0,
682 EFX_MON_STAT_PHY_POWER_SWITCH_PORT1,
683 EFX_MON_STAT_MUM_VCC,
686 EFX_MON_STAT_0V9_A_TEMP,
689 EFX_MON_STAT_0V9_B_TEMP,
690 EFX_MON_STAT_CCOM_AVREG_1V2_SUPPLY,
691 EFX_MON_STAT_CCOM_AVREG_1V2_SUPPLY_EXT_ADC,
692 EFX_MON_STAT_CCOM_AVREG_1V8_SUPPLY,
693 EFX_MON_STAT_CCOM_AVREG_1V8_SUPPLY_EXT_ADC,
694 EFX_MON_STAT_CONTROLLER_MASTER_VPTAT,
695 EFX_MON_STAT_CONTROLLER_MASTER_INTERNAL_TEMP,
696 EFX_MON_STAT_CONTROLLER_MASTER_VPTAT_EXT_ADC,
697 EFX_MON_STAT_CONTROLLER_MASTER_INTERNAL_TEMP_EXT_ADC,
698 EFX_MON_STAT_CONTROLLER_SLAVE_VPTAT,
699 EFX_MON_STAT_CONTROLLER_SLAVE_INTERNAL_TEMP,
700 EFX_MON_STAT_CONTROLLER_SLAVE_VPTAT_EXT_ADC,
701 EFX_MON_STAT_CONTROLLER_SLAVE_INTERNAL_TEMP_EXT_ADC,
702 EFX_MON_STAT_SODIMM_VOUT,
703 EFX_MON_STAT_SODIMM_0_TEMP,
704 EFX_MON_STAT_SODIMM_1_TEMP,
705 EFX_MON_STAT_PHY0_VCC,
706 EFX_MON_STAT_PHY1_VCC,
707 EFX_MON_STAT_CONTROLLER_TDIODE_TEMP,
708 EFX_MON_STAT_BOARD_FRONT_TEMP,
709 EFX_MON_STAT_BOARD_BACK_TEMP,
717 /* END MKCONFIG GENERATED MonitorHeaderStatsBlock */
719 typedef enum efx_mon_stat_state_e {
720 EFX_MON_STAT_STATE_OK = 0,
721 EFX_MON_STAT_STATE_WARNING = 1,
722 EFX_MON_STAT_STATE_FATAL = 2,
723 EFX_MON_STAT_STATE_BROKEN = 3,
724 EFX_MON_STAT_STATE_NO_READING = 4,
725 } efx_mon_stat_state_t;
727 typedef struct efx_mon_stat_value_s {
730 } efx_mon_stat_value_t;
737 __in efx_mon_stat_t id);
739 #endif /* EFSYS_OPT_NAMES */
741 extern __checkReturn efx_rc_t
742 efx_mon_stats_update(
744 __in efsys_mem_t *esmp,
745 __inout_ecount(EFX_MON_NSTATS) efx_mon_stat_value_t *values);
747 #endif /* EFSYS_OPT_MON_STATS */
751 __in efx_nic_t *enp);
755 extern __checkReturn efx_rc_t
757 __in efx_nic_t *enp);
759 #if EFSYS_OPT_PHY_LED_CONTROL
761 typedef enum efx_phy_led_mode_e {
762 EFX_PHY_LED_DEFAULT = 0,
767 } efx_phy_led_mode_t;
769 extern __checkReturn efx_rc_t
772 __in efx_phy_led_mode_t mode);
774 #endif /* EFSYS_OPT_PHY_LED_CONTROL */
776 extern __checkReturn efx_rc_t
778 __in efx_nic_t *enp);
780 #if EFSYS_OPT_LOOPBACK
782 typedef enum efx_loopback_type_e {
783 EFX_LOOPBACK_OFF = 0,
784 EFX_LOOPBACK_DATA = 1,
785 EFX_LOOPBACK_GMAC = 2,
786 EFX_LOOPBACK_XGMII = 3,
787 EFX_LOOPBACK_XGXS = 4,
788 EFX_LOOPBACK_XAUI = 5,
789 EFX_LOOPBACK_GMII = 6,
790 EFX_LOOPBACK_SGMII = 7,
791 EFX_LOOPBACK_XGBR = 8,
792 EFX_LOOPBACK_XFI = 9,
793 EFX_LOOPBACK_XAUI_FAR = 10,
794 EFX_LOOPBACK_GMII_FAR = 11,
795 EFX_LOOPBACK_SGMII_FAR = 12,
796 EFX_LOOPBACK_XFI_FAR = 13,
797 EFX_LOOPBACK_GPHY = 14,
798 EFX_LOOPBACK_PHY_XS = 15,
799 EFX_LOOPBACK_PCS = 16,
800 EFX_LOOPBACK_PMA_PMD = 17,
801 EFX_LOOPBACK_XPORT = 18,
802 EFX_LOOPBACK_XGMII_WS = 19,
803 EFX_LOOPBACK_XAUI_WS = 20,
804 EFX_LOOPBACK_XAUI_WS_FAR = 21,
805 EFX_LOOPBACK_XAUI_WS_NEAR = 22,
806 EFX_LOOPBACK_GMII_WS = 23,
807 EFX_LOOPBACK_XFI_WS = 24,
808 EFX_LOOPBACK_XFI_WS_FAR = 25,
809 EFX_LOOPBACK_PHYXS_WS = 26,
810 EFX_LOOPBACK_PMA_INT = 27,
811 EFX_LOOPBACK_SD_NEAR = 28,
812 EFX_LOOPBACK_SD_FAR = 29,
813 EFX_LOOPBACK_PMA_INT_WS = 30,
814 EFX_LOOPBACK_SD_FEP2_WS = 31,
815 EFX_LOOPBACK_SD_FEP1_5_WS = 32,
816 EFX_LOOPBACK_SD_FEP_WS = 33,
817 EFX_LOOPBACK_SD_FES_WS = 34,
818 EFX_LOOPBACK_AOE_INT_NEAR = 35,
819 EFX_LOOPBACK_DATA_WS = 36,
820 EFX_LOOPBACK_FORCE_EXT_LINK = 37,
822 } efx_loopback_type_t;
824 typedef enum efx_loopback_kind_e {
825 EFX_LOOPBACK_KIND_OFF = 0,
826 EFX_LOOPBACK_KIND_ALL,
827 EFX_LOOPBACK_KIND_MAC,
828 EFX_LOOPBACK_KIND_PHY,
830 } efx_loopback_kind_t;
834 __in efx_loopback_kind_t loopback_kind,
835 __out efx_qword_t *maskp);
837 extern __checkReturn efx_rc_t
838 efx_port_loopback_set(
840 __in efx_link_mode_t link_mode,
841 __in efx_loopback_type_t type);
845 extern __checkReturn const char *
846 efx_loopback_type_name(
848 __in efx_loopback_type_t type);
850 #endif /* EFSYS_OPT_NAMES */
852 #endif /* EFSYS_OPT_LOOPBACK */
854 extern __checkReturn efx_rc_t
857 __out_opt efx_link_mode_t *link_modep);
861 __in efx_nic_t *enp);
863 typedef enum efx_phy_cap_type_e {
864 EFX_PHY_CAP_INVALID = 0,
871 EFX_PHY_CAP_10000FDX,
875 EFX_PHY_CAP_40000FDX,
877 EFX_PHY_CAP_100000FDX,
878 EFX_PHY_CAP_25000FDX,
879 EFX_PHY_CAP_50000FDX,
881 } efx_phy_cap_type_t;
884 #define EFX_PHY_CAP_CURRENT 0x00000000
885 #define EFX_PHY_CAP_DEFAULT 0x00000001
886 #define EFX_PHY_CAP_PERM 0x00000002
892 __out uint32_t *maskp);
894 extern __checkReturn efx_rc_t
902 __out uint32_t *maskp);
904 extern __checkReturn efx_rc_t
907 __out uint32_t *ouip);
909 typedef enum efx_phy_media_type_e {
910 EFX_PHY_MEDIA_INVALID = 0,
915 EFX_PHY_MEDIA_SFP_PLUS,
916 EFX_PHY_MEDIA_BASE_T,
917 EFX_PHY_MEDIA_QSFP_PLUS,
919 } efx_phy_media_type_t;
922 * Get the type of medium currently used. If the board has ports for
923 * modules, a module is present, and we recognise the media type of
924 * the module, then this will be the media type of the module.
925 * Otherwise it will be the media type of the port.
928 efx_phy_media_type_get(
930 __out efx_phy_media_type_t *typep);
932 extern __checkReturn efx_rc_t
933 efx_phy_module_get_info(
935 __in uint8_t dev_addr,
938 __out_bcount(len) uint8_t *data);
940 #if EFSYS_OPT_PHY_STATS
942 /* START MKCONFIG GENERATED PhyHeaderStatsBlock 30ed56ad501f8e36 */
943 typedef enum efx_phy_stat_e {
945 EFX_PHY_STAT_PMA_PMD_LINK_UP,
946 EFX_PHY_STAT_PMA_PMD_RX_FAULT,
947 EFX_PHY_STAT_PMA_PMD_TX_FAULT,
948 EFX_PHY_STAT_PMA_PMD_REV_A,
949 EFX_PHY_STAT_PMA_PMD_REV_B,
950 EFX_PHY_STAT_PMA_PMD_REV_C,
951 EFX_PHY_STAT_PMA_PMD_REV_D,
952 EFX_PHY_STAT_PCS_LINK_UP,
953 EFX_PHY_STAT_PCS_RX_FAULT,
954 EFX_PHY_STAT_PCS_TX_FAULT,
955 EFX_PHY_STAT_PCS_BER,
956 EFX_PHY_STAT_PCS_BLOCK_ERRORS,
957 EFX_PHY_STAT_PHY_XS_LINK_UP,
958 EFX_PHY_STAT_PHY_XS_RX_FAULT,
959 EFX_PHY_STAT_PHY_XS_TX_FAULT,
960 EFX_PHY_STAT_PHY_XS_ALIGN,
961 EFX_PHY_STAT_PHY_XS_SYNC_A,
962 EFX_PHY_STAT_PHY_XS_SYNC_B,
963 EFX_PHY_STAT_PHY_XS_SYNC_C,
964 EFX_PHY_STAT_PHY_XS_SYNC_D,
965 EFX_PHY_STAT_AN_LINK_UP,
966 EFX_PHY_STAT_AN_MASTER,
967 EFX_PHY_STAT_AN_LOCAL_RX_OK,
968 EFX_PHY_STAT_AN_REMOTE_RX_OK,
969 EFX_PHY_STAT_CL22EXT_LINK_UP,
974 EFX_PHY_STAT_PMA_PMD_SIGNAL_A,
975 EFX_PHY_STAT_PMA_PMD_SIGNAL_B,
976 EFX_PHY_STAT_PMA_PMD_SIGNAL_C,
977 EFX_PHY_STAT_PMA_PMD_SIGNAL_D,
978 EFX_PHY_STAT_AN_COMPLETE,
979 EFX_PHY_STAT_PMA_PMD_REV_MAJOR,
980 EFX_PHY_STAT_PMA_PMD_REV_MINOR,
981 EFX_PHY_STAT_PMA_PMD_REV_MICRO,
982 EFX_PHY_STAT_PCS_FW_VERSION_0,
983 EFX_PHY_STAT_PCS_FW_VERSION_1,
984 EFX_PHY_STAT_PCS_FW_VERSION_2,
985 EFX_PHY_STAT_PCS_FW_VERSION_3,
986 EFX_PHY_STAT_PCS_FW_BUILD_YY,
987 EFX_PHY_STAT_PCS_FW_BUILD_MM,
988 EFX_PHY_STAT_PCS_FW_BUILD_DD,
989 EFX_PHY_STAT_PCS_OP_MODE,
993 /* END MKCONFIG GENERATED PhyHeaderStatsBlock */
1000 __in efx_phy_stat_t stat);
1002 #endif /* EFSYS_OPT_NAMES */
1004 #define EFX_PHY_STATS_SIZE 0x100
1006 extern __checkReturn efx_rc_t
1007 efx_phy_stats_update(
1008 __in efx_nic_t *enp,
1009 __in efsys_mem_t *esmp,
1010 __inout_ecount(EFX_PHY_NSTATS) uint32_t *stat);
1012 #endif /* EFSYS_OPT_PHY_STATS */
1017 typedef enum efx_bist_type_e {
1018 EFX_BIST_TYPE_UNKNOWN,
1019 EFX_BIST_TYPE_PHY_NORMAL,
1020 EFX_BIST_TYPE_PHY_CABLE_SHORT,
1021 EFX_BIST_TYPE_PHY_CABLE_LONG,
1022 EFX_BIST_TYPE_MC_MEM, /* Test the MC DMEM and IMEM */
1023 EFX_BIST_TYPE_SAT_MEM, /* Test the DMEM and IMEM of satellite cpus */
1024 EFX_BIST_TYPE_REG, /* Test the register memories */
1025 EFX_BIST_TYPE_NTYPES,
1028 typedef enum efx_bist_result_e {
1029 EFX_BIST_RESULT_UNKNOWN,
1030 EFX_BIST_RESULT_RUNNING,
1031 EFX_BIST_RESULT_PASSED,
1032 EFX_BIST_RESULT_FAILED,
1033 } efx_bist_result_t;
1035 typedef enum efx_phy_cable_status_e {
1036 EFX_PHY_CABLE_STATUS_OK,
1037 EFX_PHY_CABLE_STATUS_INVALID,
1038 EFX_PHY_CABLE_STATUS_OPEN,
1039 EFX_PHY_CABLE_STATUS_INTRAPAIRSHORT,
1040 EFX_PHY_CABLE_STATUS_INTERPAIRSHORT,
1041 EFX_PHY_CABLE_STATUS_BUSY,
1042 } efx_phy_cable_status_t;
1044 typedef enum efx_bist_value_e {
1045 EFX_BIST_PHY_CABLE_LENGTH_A,
1046 EFX_BIST_PHY_CABLE_LENGTH_B,
1047 EFX_BIST_PHY_CABLE_LENGTH_C,
1048 EFX_BIST_PHY_CABLE_LENGTH_D,
1049 EFX_BIST_PHY_CABLE_STATUS_A,
1050 EFX_BIST_PHY_CABLE_STATUS_B,
1051 EFX_BIST_PHY_CABLE_STATUS_C,
1052 EFX_BIST_PHY_CABLE_STATUS_D,
1053 EFX_BIST_FAULT_CODE,
1055 * Memory BIST specific values. These match to the MC_CMD_BIST_POLL
1061 EFX_BIST_MEM_EXPECT,
1062 EFX_BIST_MEM_ACTUAL,
1064 EFX_BIST_MEM_ECC_PARITY,
1065 EFX_BIST_MEM_ECC_FATAL,
1069 extern __checkReturn efx_rc_t
1070 efx_bist_enable_offline(
1071 __in efx_nic_t *enp);
1073 extern __checkReturn efx_rc_t
1075 __in efx_nic_t *enp,
1076 __in efx_bist_type_t type);
1078 extern __checkReturn efx_rc_t
1080 __in efx_nic_t *enp,
1081 __in efx_bist_type_t type,
1082 __out efx_bist_result_t *resultp,
1083 __out_opt uint32_t *value_maskp,
1084 __out_ecount_opt(count) unsigned long *valuesp,
1089 __in efx_nic_t *enp,
1090 __in efx_bist_type_t type);
1092 #endif /* EFSYS_OPT_BIST */
1094 #define EFX_FEATURE_IPV6 0x00000001
1095 #define EFX_FEATURE_LFSR_HASH_INSERT 0x00000002
1096 #define EFX_FEATURE_LINK_EVENTS 0x00000004
1097 #define EFX_FEATURE_PERIODIC_MAC_STATS 0x00000008
1098 #define EFX_FEATURE_MCDI 0x00000020
1099 #define EFX_FEATURE_LOOKAHEAD_SPLIT 0x00000040
1100 #define EFX_FEATURE_MAC_HEADER_FILTERS 0x00000080
1101 #define EFX_FEATURE_TURBO 0x00000100
1102 #define EFX_FEATURE_MCDI_DMA 0x00000200
1103 #define EFX_FEATURE_TX_SRC_FILTERS 0x00000400
1104 #define EFX_FEATURE_PIO_BUFFERS 0x00000800
1105 #define EFX_FEATURE_FW_ASSISTED_TSO 0x00001000
1106 #define EFX_FEATURE_FW_ASSISTED_TSO_V2 0x00002000
1107 #define EFX_FEATURE_PACKED_STREAM 0x00004000
1109 typedef enum efx_tunnel_protocol_e {
1110 EFX_TUNNEL_PROTOCOL_NONE = 0,
1111 EFX_TUNNEL_PROTOCOL_VXLAN,
1112 EFX_TUNNEL_PROTOCOL_GENEVE,
1113 EFX_TUNNEL_PROTOCOL_NVGRE,
1115 } efx_tunnel_protocol_t;
1117 typedef enum efx_vi_window_shift_e {
1118 EFX_VI_WINDOW_SHIFT_INVALID = 0,
1119 EFX_VI_WINDOW_SHIFT_8K = 13,
1120 EFX_VI_WINDOW_SHIFT_16K = 14,
1121 EFX_VI_WINDOW_SHIFT_64K = 16,
1122 } efx_vi_window_shift_t;
1124 typedef struct efx_nic_cfg_s {
1125 uint32_t enc_board_type;
1126 uint32_t enc_phy_type;
1128 char enc_phy_name[21];
1130 char enc_phy_revision[21];
1131 efx_mon_type_t enc_mon_type;
1132 #if EFSYS_OPT_MON_STATS
1133 uint32_t enc_mon_stat_dma_buf_size;
1134 uint32_t enc_mon_stat_mask[(EFX_MON_NSTATS + 31) / 32];
1136 unsigned int enc_features;
1137 efx_vi_window_shift_t enc_vi_window_shift;
1138 uint8_t enc_mac_addr[6];
1139 uint8_t enc_port; /* PHY port number */
1140 uint32_t enc_intr_vec_base;
1141 uint32_t enc_intr_limit;
1142 uint32_t enc_evq_limit;
1143 uint32_t enc_txq_limit;
1144 uint32_t enc_rxq_limit;
1145 uint32_t enc_txq_max_ndescs;
1146 uint32_t enc_buftbl_limit;
1147 uint32_t enc_piobuf_limit;
1148 uint32_t enc_piobuf_size;
1149 uint32_t enc_piobuf_min_alloc_size;
1150 uint32_t enc_evq_timer_quantum_ns;
1151 uint32_t enc_evq_timer_max_us;
1152 uint32_t enc_clk_mult;
1153 uint32_t enc_rx_prefix_size;
1154 uint32_t enc_rx_buf_align_start;
1155 uint32_t enc_rx_buf_align_end;
1156 uint32_t enc_rx_scale_max_exclusive_contexts;
1157 #if EFSYS_OPT_LOOPBACK
1158 efx_qword_t enc_loopback_types[EFX_LINK_NMODES];
1159 #endif /* EFSYS_OPT_LOOPBACK */
1160 #if EFSYS_OPT_PHY_FLAGS
1161 uint32_t enc_phy_flags_mask;
1162 #endif /* EFSYS_OPT_PHY_FLAGS */
1163 #if EFSYS_OPT_PHY_LED_CONTROL
1164 uint32_t enc_led_mask;
1165 #endif /* EFSYS_OPT_PHY_LED_CONTROL */
1166 #if EFSYS_OPT_PHY_STATS
1167 uint64_t enc_phy_stat_mask;
1168 #endif /* EFSYS_OPT_PHY_STATS */
1170 uint8_t enc_mcdi_mdio_channel;
1171 #if EFSYS_OPT_PHY_STATS
1172 uint32_t enc_mcdi_phy_stat_mask;
1173 #endif /* EFSYS_OPT_PHY_STATS */
1174 #if EFSYS_OPT_MON_STATS
1175 uint32_t *enc_mcdi_sensor_maskp;
1176 uint32_t enc_mcdi_sensor_mask_size;
1177 #endif /* EFSYS_OPT_MON_STATS */
1178 #endif /* EFSYS_OPT_MCDI */
1180 uint32_t enc_bist_mask;
1181 #endif /* EFSYS_OPT_BIST */
1182 #if EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD || EFSYS_OPT_MEDFORD2
1185 uint32_t enc_privilege_mask;
1186 #endif /* EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD || EFSYS_OPT_MEDFORD2 */
1187 boolean_t enc_bug26807_workaround;
1188 boolean_t enc_bug35388_workaround;
1189 boolean_t enc_bug41750_workaround;
1190 boolean_t enc_bug61265_workaround;
1191 boolean_t enc_rx_batching_enabled;
1192 /* Maximum number of descriptors completed in an rx event. */
1193 uint32_t enc_rx_batch_max;
1194 /* Number of rx descriptors the hardware requires for a push. */
1195 uint32_t enc_rx_push_align;
1196 /* Maximum amount of data in DMA descriptor */
1197 uint32_t enc_tx_dma_desc_size_max;
1199 * Boundary which DMA descriptor data must not cross or 0 if no
1202 uint32_t enc_tx_dma_desc_boundary;
1204 * Maximum number of bytes into the packet the TCP header can start for
1205 * the hardware to apply TSO packet edits.
1207 uint32_t enc_tx_tso_tcp_header_offset_limit;
1208 boolean_t enc_fw_assisted_tso_enabled;
1209 boolean_t enc_fw_assisted_tso_v2_enabled;
1210 /* Number of TSO contexts on the NIC (FATSOv2) */
1211 uint32_t enc_fw_assisted_tso_v2_n_contexts;
1212 boolean_t enc_hw_tx_insert_vlan_enabled;
1213 /* Number of PFs on the NIC */
1214 uint32_t enc_hw_pf_count;
1215 /* Datapath firmware vadapter/vport/vswitch support */
1216 boolean_t enc_datapath_cap_evb;
1217 boolean_t enc_rx_disable_scatter_supported;
1218 boolean_t enc_allow_set_mac_with_installed_filters;
1219 boolean_t enc_enhanced_set_mac_supported;
1220 boolean_t enc_init_evq_v2_supported;
1221 boolean_t enc_rx_packed_stream_supported;
1222 boolean_t enc_rx_var_packed_stream_supported;
1223 boolean_t enc_pm_and_rxdp_counters;
1224 boolean_t enc_mac_stats_40g_tx_size_bins;
1225 uint32_t enc_tunnel_encapsulations_supported;
1227 * NIC global maximum for unique UDP tunnel ports shared by all
1230 uint32_t enc_tunnel_config_udp_entries_max;
1231 /* External port identifier */
1232 uint8_t enc_external_port;
1233 uint32_t enc_mcdi_max_payload_length;
1234 /* VPD may be per-PF or global */
1235 boolean_t enc_vpd_is_global;
1236 /* Minimum unidirectional bandwidth in Mb/s to max out all ports */
1237 uint32_t enc_required_pcie_bandwidth_mbps;
1238 uint32_t enc_max_pcie_link_gen;
1239 /* Firmware verifies integrity of NVRAM updates */
1240 uint32_t enc_nvram_update_verify_result_supported;
1241 /* Firmware support for extended MAC_STATS buffer */
1242 uint32_t enc_mac_stats_nstats;
1243 boolean_t enc_fec_counters;
1246 #define EFX_PCI_FUNCTION_IS_PF(_encp) ((_encp)->enc_vf == 0xffff)
1247 #define EFX_PCI_FUNCTION_IS_VF(_encp) ((_encp)->enc_vf != 0xffff)
1249 #define EFX_PCI_FUNCTION(_encp) \
1250 (EFX_PCI_FUNCTION_IS_PF(_encp) ? (_encp)->enc_pf : (_encp)->enc_vf)
1252 #define EFX_PCI_VF_PARENT(_encp) ((_encp)->enc_pf)
1254 extern const efx_nic_cfg_t *
1256 __in efx_nic_t *enp);
1258 typedef struct efx_nic_fw_info_s {
1259 /* Basic FW version information */
1260 uint16_t enfi_mc_fw_version[4];
1262 * If datapath capabilities can be detected,
1263 * additional FW information is to be shown
1265 boolean_t enfi_dpcpu_fw_ids_valid;
1266 /* Rx and Tx datapath CPU FW IDs */
1267 uint16_t enfi_rx_dpcpu_fw_id;
1268 uint16_t enfi_tx_dpcpu_fw_id;
1269 } efx_nic_fw_info_t;
1271 extern __checkReturn efx_rc_t
1272 efx_nic_get_fw_version(
1273 __in efx_nic_t *enp,
1274 __out efx_nic_fw_info_t *enfip);
1276 /* Driver resource limits (minimum required/maximum usable). */
1277 typedef struct efx_drv_limits_s {
1278 uint32_t edl_min_evq_count;
1279 uint32_t edl_max_evq_count;
1281 uint32_t edl_min_rxq_count;
1282 uint32_t edl_max_rxq_count;
1284 uint32_t edl_min_txq_count;
1285 uint32_t edl_max_txq_count;
1287 /* PIO blocks (sub-allocated from piobuf) */
1288 uint32_t edl_min_pio_alloc_size;
1289 uint32_t edl_max_pio_alloc_count;
1292 extern __checkReturn efx_rc_t
1293 efx_nic_set_drv_limits(
1294 __inout efx_nic_t *enp,
1295 __in efx_drv_limits_t *edlp);
1297 typedef enum efx_nic_region_e {
1298 EFX_REGION_VI, /* Memory BAR UC mapping */
1299 EFX_REGION_PIO_WRITE_VI, /* Memory BAR WC mapping */
1302 extern __checkReturn efx_rc_t
1303 efx_nic_get_bar_region(
1304 __in efx_nic_t *enp,
1305 __in efx_nic_region_t region,
1306 __out uint32_t *offsetp,
1307 __out size_t *sizep);
1309 extern __checkReturn efx_rc_t
1310 efx_nic_get_vi_pool(
1311 __in efx_nic_t *enp,
1312 __out uint32_t *evq_countp,
1313 __out uint32_t *rxq_countp,
1314 __out uint32_t *txq_countp);
1319 typedef enum efx_vpd_tag_e {
1326 typedef uint16_t efx_vpd_keyword_t;
1328 typedef struct efx_vpd_value_s {
1329 efx_vpd_tag_t evv_tag;
1330 efx_vpd_keyword_t evv_keyword;
1332 uint8_t evv_value[0x100];
1336 #define EFX_VPD_KEYWORD(x, y) ((x) | ((y) << 8))
1338 extern __checkReturn efx_rc_t
1340 __in efx_nic_t *enp);
1342 extern __checkReturn efx_rc_t
1344 __in efx_nic_t *enp,
1345 __out size_t *sizep);
1347 extern __checkReturn efx_rc_t
1349 __in efx_nic_t *enp,
1350 __out_bcount(size) caddr_t data,
1353 extern __checkReturn efx_rc_t
1355 __in efx_nic_t *enp,
1356 __in_bcount(size) caddr_t data,
1359 extern __checkReturn efx_rc_t
1361 __in efx_nic_t *enp,
1362 __in_bcount(size) caddr_t data,
1365 extern __checkReturn efx_rc_t
1367 __in efx_nic_t *enp,
1368 __in_bcount(size) caddr_t data,
1370 __inout efx_vpd_value_t *evvp);
1372 extern __checkReturn efx_rc_t
1374 __in efx_nic_t *enp,
1375 __inout_bcount(size) caddr_t data,
1377 __in efx_vpd_value_t *evvp);
1379 extern __checkReturn efx_rc_t
1381 __in efx_nic_t *enp,
1382 __inout_bcount(size) caddr_t data,
1384 __out efx_vpd_value_t *evvp,
1385 __inout unsigned int *contp);
1387 extern __checkReturn efx_rc_t
1389 __in efx_nic_t *enp,
1390 __in_bcount(size) caddr_t data,
1395 __in efx_nic_t *enp);
1397 #endif /* EFSYS_OPT_VPD */
1403 typedef enum efx_nvram_type_e {
1404 EFX_NVRAM_INVALID = 0,
1406 EFX_NVRAM_BOOTROM_CFG,
1407 EFX_NVRAM_MC_FIRMWARE,
1408 EFX_NVRAM_MC_GOLDEN,
1414 EFX_NVRAM_FPGA_BACKUP,
1415 EFX_NVRAM_DYNAMIC_CFG,
1418 EFX_NVRAM_MUM_FIRMWARE,
1422 extern __checkReturn efx_rc_t
1424 __in efx_nic_t *enp);
1428 extern __checkReturn efx_rc_t
1430 __in efx_nic_t *enp);
1432 #endif /* EFSYS_OPT_DIAG */
1434 extern __checkReturn efx_rc_t
1436 __in efx_nic_t *enp,
1437 __in efx_nvram_type_t type,
1438 __out size_t *sizep);
1440 extern __checkReturn efx_rc_t
1442 __in efx_nic_t *enp,
1443 __in efx_nvram_type_t type,
1444 __out_opt size_t *pref_chunkp);
1446 extern __checkReturn efx_rc_t
1447 efx_nvram_rw_finish(
1448 __in efx_nic_t *enp,
1449 __in efx_nvram_type_t type,
1450 __out_opt uint32_t *verify_resultp);
1452 extern __checkReturn efx_rc_t
1453 efx_nvram_get_version(
1454 __in efx_nic_t *enp,
1455 __in efx_nvram_type_t type,
1456 __out uint32_t *subtypep,
1457 __out_ecount(4) uint16_t version[4]);
1459 extern __checkReturn efx_rc_t
1460 efx_nvram_read_chunk(
1461 __in efx_nic_t *enp,
1462 __in efx_nvram_type_t type,
1463 __in unsigned int offset,
1464 __out_bcount(size) caddr_t data,
1467 extern __checkReturn efx_rc_t
1468 efx_nvram_read_backup(
1469 __in efx_nic_t *enp,
1470 __in efx_nvram_type_t type,
1471 __in unsigned int offset,
1472 __out_bcount(size) caddr_t data,
1475 extern __checkReturn efx_rc_t
1476 efx_nvram_set_version(
1477 __in efx_nic_t *enp,
1478 __in efx_nvram_type_t type,
1479 __in_ecount(4) uint16_t version[4]);
1481 extern __checkReturn efx_rc_t
1483 __in efx_nic_t *enp,
1484 __in efx_nvram_type_t type,
1485 __in_bcount(partn_size) caddr_t partn_data,
1486 __in size_t partn_size);
1488 extern __checkReturn efx_rc_t
1490 __in efx_nic_t *enp,
1491 __in efx_nvram_type_t type);
1493 extern __checkReturn efx_rc_t
1494 efx_nvram_write_chunk(
1495 __in efx_nic_t *enp,
1496 __in efx_nvram_type_t type,
1497 __in unsigned int offset,
1498 __in_bcount(size) caddr_t data,
1503 __in efx_nic_t *enp);
1505 #endif /* EFSYS_OPT_NVRAM */
1507 #if EFSYS_OPT_BOOTCFG
1509 /* Report size and offset of bootcfg sector in NVRAM partition. */
1510 extern __checkReturn efx_rc_t
1511 efx_bootcfg_sector_info(
1512 __in efx_nic_t *enp,
1514 __out_opt uint32_t *sector_countp,
1515 __out size_t *offsetp,
1516 __out size_t *max_sizep);
1519 * Copy bootcfg sector data to a target buffer which may differ in size.
1520 * Optionally corrects format errors in source buffer.
1523 efx_bootcfg_copy_sector(
1524 __in efx_nic_t *enp,
1525 __inout_bcount(sector_length)
1527 __in size_t sector_length,
1528 __out_bcount(data_size) uint8_t *data,
1529 __in size_t data_size,
1530 __in boolean_t handle_format_errors);
1534 __in efx_nic_t *enp,
1535 __out_bcount(size) uint8_t *data,
1540 __in efx_nic_t *enp,
1541 __in_bcount(size) uint8_t *data,
1544 #endif /* EFSYS_OPT_BOOTCFG */
1548 typedef enum efx_pattern_type_t {
1549 EFX_PATTERN_BYTE_INCREMENT = 0,
1550 EFX_PATTERN_ALL_THE_SAME,
1551 EFX_PATTERN_BIT_ALTERNATE,
1552 EFX_PATTERN_BYTE_ALTERNATE,
1553 EFX_PATTERN_BYTE_CHANGING,
1554 EFX_PATTERN_BIT_SWEEP,
1556 } efx_pattern_type_t;
1559 (*efx_sram_pattern_fn_t)(
1561 __in boolean_t negate,
1562 __out efx_qword_t *eqp);
1564 extern __checkReturn efx_rc_t
1566 __in efx_nic_t *enp,
1567 __in efx_pattern_type_t type);
1569 #endif /* EFSYS_OPT_DIAG */
1571 extern __checkReturn efx_rc_t
1572 efx_sram_buf_tbl_set(
1573 __in efx_nic_t *enp,
1575 __in efsys_mem_t *esmp,
1579 efx_sram_buf_tbl_clear(
1580 __in efx_nic_t *enp,
1584 #define EFX_BUF_TBL_SIZE 0x20000
1586 #define EFX_BUF_SIZE 4096
1590 typedef struct efx_evq_s efx_evq_t;
1592 #if EFSYS_OPT_QSTATS
1594 /* START MKCONFIG GENERATED EfxHeaderEventQueueBlock 6f3843f5fe7cc843 */
1595 typedef enum efx_ev_qstat_e {
1601 EV_RX_PAUSE_FRM_ERR,
1602 EV_RX_BUF_OWNER_ID_ERR,
1603 EV_RX_IPV4_HDR_CHKSUM_ERR,
1604 EV_RX_TCP_UDP_CHKSUM_ERR,
1608 EV_RX_MCAST_HASH_MATCH,
1625 EV_DRIVER_SRM_UPD_DONE,
1626 EV_DRIVER_TX_DESCQ_FLS_DONE,
1627 EV_DRIVER_RX_DESCQ_FLS_DONE,
1628 EV_DRIVER_RX_DESCQ_FLS_FAILED,
1629 EV_DRIVER_RX_DSC_ERROR,
1630 EV_DRIVER_TX_DSC_ERROR,
1636 /* END MKCONFIG GENERATED EfxHeaderEventQueueBlock */
1638 #endif /* EFSYS_OPT_QSTATS */
1640 extern __checkReturn efx_rc_t
1642 __in efx_nic_t *enp);
1646 __in efx_nic_t *enp);
1648 #define EFX_EVQ_MAXNEVS 32768
1649 #define EFX_EVQ_MINNEVS 512
1651 #define EFX_EVQ_SIZE(_nevs) ((_nevs) * sizeof (efx_qword_t))
1652 #define EFX_EVQ_NBUFS(_nevs) (EFX_EVQ_SIZE(_nevs) / EFX_BUF_SIZE)
1654 #define EFX_EVQ_FLAGS_TYPE_MASK (0x3)
1655 #define EFX_EVQ_FLAGS_TYPE_AUTO (0x0)
1656 #define EFX_EVQ_FLAGS_TYPE_THROUGHPUT (0x1)
1657 #define EFX_EVQ_FLAGS_TYPE_LOW_LATENCY (0x2)
1659 #define EFX_EVQ_FLAGS_NOTIFY_MASK (0xC)
1660 #define EFX_EVQ_FLAGS_NOTIFY_INTERRUPT (0x0) /* Interrupting (default) */
1661 #define EFX_EVQ_FLAGS_NOTIFY_DISABLED (0x4) /* Non-interrupting */
1663 extern __checkReturn efx_rc_t
1665 __in efx_nic_t *enp,
1666 __in unsigned int index,
1667 __in efsys_mem_t *esmp,
1671 __in uint32_t flags,
1672 __deref_out efx_evq_t **eepp);
1676 __in efx_evq_t *eep,
1677 __in uint16_t data);
1679 typedef __checkReturn boolean_t
1680 (*efx_initialized_ev_t)(
1681 __in_opt void *arg);
1683 #define EFX_PKT_UNICAST 0x0004
1684 #define EFX_PKT_START 0x0008
1686 #define EFX_PKT_VLAN_TAGGED 0x0010
1687 #define EFX_CKSUM_TCPUDP 0x0020
1688 #define EFX_CKSUM_IPV4 0x0040
1689 #define EFX_PKT_CONT 0x0080
1691 #define EFX_CHECK_VLAN 0x0100
1692 #define EFX_PKT_TCP 0x0200
1693 #define EFX_PKT_UDP 0x0400
1694 #define EFX_PKT_IPV4 0x0800
1696 #define EFX_PKT_IPV6 0x1000
1697 #define EFX_PKT_PREFIX_LEN 0x2000
1698 #define EFX_ADDR_MISMATCH 0x4000
1699 #define EFX_DISCARD 0x8000
1702 * The following flags are used only for packed stream
1703 * mode. The values for the flags are reused to fit into 16 bit,
1704 * since EFX_PKT_START and EFX_PKT_CONT are never used in
1705 * packed stream mode
1707 #define EFX_PKT_PACKED_STREAM_NEW_BUFFER EFX_PKT_START
1708 #define EFX_PKT_PACKED_STREAM_PARSE_INCOMPLETE EFX_PKT_CONT
1711 #define EFX_EV_RX_NLABELS 32
1712 #define EFX_EV_TX_NLABELS 32
1714 typedef __checkReturn boolean_t
1717 __in uint32_t label,
1720 __in uint16_t flags);
1722 #if EFSYS_OPT_RX_PACKED_STREAM
1725 * Packed stream mode is documented in SF-112241-TC.
1726 * The general idea is that, instead of putting each incoming
1727 * packet into a separate buffer which is specified in a RX
1728 * descriptor, a large buffer is provided to the hardware and
1729 * packets are put there in a continuous stream.
1730 * The main advantage of such an approach is that RX queue refilling
1731 * happens much less frequently.
1734 typedef __checkReturn boolean_t
1737 __in uint32_t label,
1739 __in uint32_t pkt_count,
1740 __in uint16_t flags);
1744 typedef __checkReturn boolean_t
1747 __in uint32_t label,
1750 #define EFX_EXCEPTION_RX_RECOVERY 0x00000001
1751 #define EFX_EXCEPTION_RX_DSC_ERROR 0x00000002
1752 #define EFX_EXCEPTION_TX_DSC_ERROR 0x00000003
1753 #define EFX_EXCEPTION_UNKNOWN_SENSOREVT 0x00000004
1754 #define EFX_EXCEPTION_FWALERT_SRAM 0x00000005
1755 #define EFX_EXCEPTION_UNKNOWN_FWALERT 0x00000006
1756 #define EFX_EXCEPTION_RX_ERROR 0x00000007
1757 #define EFX_EXCEPTION_TX_ERROR 0x00000008
1758 #define EFX_EXCEPTION_EV_ERROR 0x00000009
1760 typedef __checkReturn boolean_t
1761 (*efx_exception_ev_t)(
1763 __in uint32_t label,
1764 __in uint32_t data);
1766 typedef __checkReturn boolean_t
1767 (*efx_rxq_flush_done_ev_t)(
1769 __in uint32_t rxq_index);
1771 typedef __checkReturn boolean_t
1772 (*efx_rxq_flush_failed_ev_t)(
1774 __in uint32_t rxq_index);
1776 typedef __checkReturn boolean_t
1777 (*efx_txq_flush_done_ev_t)(
1779 __in uint32_t txq_index);
1781 typedef __checkReturn boolean_t
1782 (*efx_software_ev_t)(
1784 __in uint16_t magic);
1786 typedef __checkReturn boolean_t
1789 __in uint32_t code);
1791 #define EFX_SRAM_CLEAR 0
1792 #define EFX_SRAM_UPDATE 1
1793 #define EFX_SRAM_ILLEGAL_CLEAR 2
1795 typedef __checkReturn boolean_t
1796 (*efx_wake_up_ev_t)(
1798 __in uint32_t label);
1800 typedef __checkReturn boolean_t
1803 __in uint32_t label);
1805 typedef __checkReturn boolean_t
1806 (*efx_link_change_ev_t)(
1808 __in efx_link_mode_t link_mode);
1810 #if EFSYS_OPT_MON_STATS
1812 typedef __checkReturn boolean_t
1813 (*efx_monitor_ev_t)(
1815 __in efx_mon_stat_t id,
1816 __in efx_mon_stat_value_t value);
1818 #endif /* EFSYS_OPT_MON_STATS */
1820 #if EFSYS_OPT_MAC_STATS
1822 typedef __checkReturn boolean_t
1823 (*efx_mac_stats_ev_t)(
1825 __in uint32_t generation);
1827 #endif /* EFSYS_OPT_MAC_STATS */
1829 typedef struct efx_ev_callbacks_s {
1830 efx_initialized_ev_t eec_initialized;
1832 #if EFSYS_OPT_RX_PACKED_STREAM
1833 efx_rx_ps_ev_t eec_rx_ps;
1836 efx_exception_ev_t eec_exception;
1837 efx_rxq_flush_done_ev_t eec_rxq_flush_done;
1838 efx_rxq_flush_failed_ev_t eec_rxq_flush_failed;
1839 efx_txq_flush_done_ev_t eec_txq_flush_done;
1840 efx_software_ev_t eec_software;
1841 efx_sram_ev_t eec_sram;
1842 efx_wake_up_ev_t eec_wake_up;
1843 efx_timer_ev_t eec_timer;
1844 efx_link_change_ev_t eec_link_change;
1845 #if EFSYS_OPT_MON_STATS
1846 efx_monitor_ev_t eec_monitor;
1847 #endif /* EFSYS_OPT_MON_STATS */
1848 #if EFSYS_OPT_MAC_STATS
1849 efx_mac_stats_ev_t eec_mac_stats;
1850 #endif /* EFSYS_OPT_MAC_STATS */
1851 } efx_ev_callbacks_t;
1853 extern __checkReturn boolean_t
1855 __in efx_evq_t *eep,
1856 __in unsigned int count);
1858 #if EFSYS_OPT_EV_PREFETCH
1862 __in efx_evq_t *eep,
1863 __in unsigned int count);
1865 #endif /* EFSYS_OPT_EV_PREFETCH */
1869 __in efx_evq_t *eep,
1870 __inout unsigned int *countp,
1871 __in const efx_ev_callbacks_t *eecp,
1872 __in_opt void *arg);
1874 extern __checkReturn efx_rc_t
1875 efx_ev_usecs_to_ticks(
1876 __in efx_nic_t *enp,
1877 __in unsigned int usecs,
1878 __out unsigned int *ticksp);
1880 extern __checkReturn efx_rc_t
1882 __in efx_evq_t *eep,
1883 __in unsigned int us);
1885 extern __checkReturn efx_rc_t
1887 __in efx_evq_t *eep,
1888 __in unsigned int count);
1890 #if EFSYS_OPT_QSTATS
1896 __in efx_nic_t *enp,
1897 __in unsigned int id);
1899 #endif /* EFSYS_OPT_NAMES */
1902 efx_ev_qstats_update(
1903 __in efx_evq_t *eep,
1904 __inout_ecount(EV_NQSTATS) efsys_stat_t *stat);
1906 #endif /* EFSYS_OPT_QSTATS */
1910 __in efx_evq_t *eep);
1914 extern __checkReturn efx_rc_t
1916 __inout efx_nic_t *enp);
1920 __in efx_nic_t *enp);
1922 #if EFSYS_OPT_RX_SCATTER
1923 __checkReturn efx_rc_t
1924 efx_rx_scatter_enable(
1925 __in efx_nic_t *enp,
1926 __in unsigned int buf_size);
1927 #endif /* EFSYS_OPT_RX_SCATTER */
1929 /* Handle to represent use of the default RSS context. */
1930 #define EFX_RSS_CONTEXT_DEFAULT 0xffffffff
1932 #if EFSYS_OPT_RX_SCALE
1934 typedef enum efx_rx_hash_alg_e {
1935 EFX_RX_HASHALG_LFSR = 0,
1936 EFX_RX_HASHALG_TOEPLITZ
1937 } efx_rx_hash_alg_t;
1939 #define EFX_RX_HASH_IPV4 (1U << 0)
1940 #define EFX_RX_HASH_TCPIPV4 (1U << 1)
1941 #define EFX_RX_HASH_IPV6 (1U << 2)
1942 #define EFX_RX_HASH_TCPIPV6 (1U << 3)
1944 typedef unsigned int efx_rx_hash_type_t;
1946 typedef enum efx_rx_hash_support_e {
1947 EFX_RX_HASH_UNAVAILABLE = 0, /* Hardware hash not inserted */
1948 EFX_RX_HASH_AVAILABLE /* Insert hash with/without RSS */
1949 } efx_rx_hash_support_t;
1951 #define EFX_RSS_KEY_SIZE 40 /* RSS key size (bytes) */
1952 #define EFX_RSS_TBL_SIZE 128 /* Rows in RX indirection table */
1953 #define EFX_MAXRSS 64 /* RX indirection entry range */
1954 #define EFX_MAXRSS_LEGACY 16 /* See bug16611 and bug17213 */
1956 typedef enum efx_rx_scale_context_type_e {
1957 EFX_RX_SCALE_UNAVAILABLE = 0, /* No RX scale context */
1958 EFX_RX_SCALE_EXCLUSIVE, /* Writable key/indirection table */
1959 EFX_RX_SCALE_SHARED /* Read-only key/indirection table */
1960 } efx_rx_scale_context_type_t;
1962 extern __checkReturn efx_rc_t
1963 efx_rx_hash_default_support_get(
1964 __in efx_nic_t *enp,
1965 __out efx_rx_hash_support_t *supportp);
1968 extern __checkReturn efx_rc_t
1969 efx_rx_scale_default_support_get(
1970 __in efx_nic_t *enp,
1971 __out efx_rx_scale_context_type_t *typep);
1973 extern __checkReturn efx_rc_t
1974 efx_rx_scale_context_alloc(
1975 __in efx_nic_t *enp,
1976 __in efx_rx_scale_context_type_t type,
1977 __in uint32_t num_queues,
1978 __out uint32_t *rss_contextp);
1980 extern __checkReturn efx_rc_t
1981 efx_rx_scale_context_free(
1982 __in efx_nic_t *enp,
1983 __in uint32_t rss_context);
1985 extern __checkReturn efx_rc_t
1986 efx_rx_scale_mode_set(
1987 __in efx_nic_t *enp,
1988 __in uint32_t rss_context,
1989 __in efx_rx_hash_alg_t alg,
1990 __in efx_rx_hash_type_t type,
1991 __in boolean_t insert);
1993 extern __checkReturn efx_rc_t
1994 efx_rx_scale_tbl_set(
1995 __in efx_nic_t *enp,
1996 __in uint32_t rss_context,
1997 __in_ecount(n) unsigned int *table,
2000 extern __checkReturn efx_rc_t
2001 efx_rx_scale_key_set(
2002 __in efx_nic_t *enp,
2003 __in uint32_t rss_context,
2004 __in_ecount(n) uint8_t *key,
2007 extern __checkReturn uint32_t
2008 efx_pseudo_hdr_hash_get(
2009 __in efx_rxq_t *erp,
2010 __in efx_rx_hash_alg_t func,
2011 __in uint8_t *buffer);
2013 #endif /* EFSYS_OPT_RX_SCALE */
2015 extern __checkReturn efx_rc_t
2016 efx_pseudo_hdr_pkt_length_get(
2017 __in efx_rxq_t *erp,
2018 __in uint8_t *buffer,
2019 __out uint16_t *pkt_lengthp);
2021 #define EFX_RXQ_MAXNDESCS 4096
2022 #define EFX_RXQ_MINNDESCS 512
2024 #define EFX_RXQ_SIZE(_ndescs) ((_ndescs) * sizeof (efx_qword_t))
2025 #define EFX_RXQ_NBUFS(_ndescs) (EFX_RXQ_SIZE(_ndescs) / EFX_BUF_SIZE)
2026 #define EFX_RXQ_LIMIT(_ndescs) ((_ndescs) - 16)
2027 #define EFX_RXQ_DC_NDESCS(_dcsize) (8 << _dcsize)
2029 typedef enum efx_rxq_type_e {
2030 EFX_RXQ_TYPE_DEFAULT,
2031 EFX_RXQ_TYPE_PACKED_STREAM,
2036 * Dummy flag to be used instead of 0 to make it clear that the argument
2037 * is receive queue flags.
2039 #define EFX_RXQ_FLAG_NONE 0x0
2040 #define EFX_RXQ_FLAG_SCATTER 0x1
2042 * If tunnels are supported and Rx event can provide information about
2043 * either outer or inner packet classes (e.g. SFN8xxx adapters with
2044 * full-feature firmware variant running), outer classes are requested by
2045 * default. However, if the driver supports tunnels, the flag allows to
2046 * request inner classes which are required to be able to interpret inner
2047 * Rx checksum offload results.
2049 #define EFX_RXQ_FLAG_INNER_CLASSES 0x2
2051 extern __checkReturn efx_rc_t
2053 __in efx_nic_t *enp,
2054 __in unsigned int index,
2055 __in unsigned int label,
2056 __in efx_rxq_type_t type,
2057 __in efsys_mem_t *esmp,
2060 __in unsigned int flags,
2061 __in efx_evq_t *eep,
2062 __deref_out efx_rxq_t **erpp);
2064 #if EFSYS_OPT_RX_PACKED_STREAM
2066 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_1M (1U * 1024 * 1024)
2067 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_512K (512U * 1024)
2068 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_256K (256U * 1024)
2069 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_128K (128U * 1024)
2070 #define EFX_RXQ_PACKED_STREAM_BUF_SIZE_64K (64U * 1024)
2072 extern __checkReturn efx_rc_t
2073 efx_rx_qcreate_packed_stream(
2074 __in efx_nic_t *enp,
2075 __in unsigned int index,
2076 __in unsigned int label,
2077 __in uint32_t ps_buf_size,
2078 __in efsys_mem_t *esmp,
2080 __in efx_evq_t *eep,
2081 __deref_out efx_rxq_t **erpp);
2085 typedef struct efx_buffer_s {
2086 efsys_dma_addr_t eb_addr;
2091 typedef struct efx_desc_s {
2097 __in efx_rxq_t *erp,
2098 __in_ecount(ndescs) efsys_dma_addr_t *addrp,
2100 __in unsigned int ndescs,
2101 __in unsigned int completed,
2102 __in unsigned int added);
2106 __in efx_rxq_t *erp,
2107 __in unsigned int added,
2108 __inout unsigned int *pushedp);
2110 #if EFSYS_OPT_RX_PACKED_STREAM
2113 efx_rx_qpush_ps_credits(
2114 __in efx_rxq_t *erp);
2116 extern __checkReturn uint8_t *
2117 efx_rx_qps_packet_info(
2118 __in efx_rxq_t *erp,
2119 __in uint8_t *buffer,
2120 __in uint32_t buffer_length,
2121 __in uint32_t current_offset,
2122 __out uint16_t *lengthp,
2123 __out uint32_t *next_offsetp,
2124 __out uint32_t *timestamp);
2127 extern __checkReturn efx_rc_t
2129 __in efx_rxq_t *erp);
2133 __in efx_rxq_t *erp);
2137 __in efx_rxq_t *erp);
2141 typedef struct efx_txq_s efx_txq_t;
2143 #if EFSYS_OPT_QSTATS
2145 /* START MKCONFIG GENERATED EfxHeaderTransmitQueueBlock 12dff8778598b2db */
2146 typedef enum efx_tx_qstat_e {
2152 /* END MKCONFIG GENERATED EfxHeaderTransmitQueueBlock */
2154 #endif /* EFSYS_OPT_QSTATS */
2156 extern __checkReturn efx_rc_t
2158 __in efx_nic_t *enp);
2162 __in efx_nic_t *enp);
2164 #define EFX_TXQ_MINNDESCS 512
2166 #define EFX_TXQ_SIZE(_ndescs) ((_ndescs) * sizeof (efx_qword_t))
2167 #define EFX_TXQ_NBUFS(_ndescs) (EFX_TXQ_SIZE(_ndescs) / EFX_BUF_SIZE)
2168 #define EFX_TXQ_LIMIT(_ndescs) ((_ndescs) - 16)
2170 #define EFX_TXQ_MAX_BUFS 8 /* Maximum independent of EFX_BUG35388_WORKAROUND. */
2172 #define EFX_TXQ_CKSUM_IPV4 0x0001
2173 #define EFX_TXQ_CKSUM_TCPUDP 0x0002
2174 #define EFX_TXQ_FATSOV2 0x0004
2175 #define EFX_TXQ_CKSUM_INNER_IPV4 0x0008
2176 #define EFX_TXQ_CKSUM_INNER_TCPUDP 0x0010
2178 extern __checkReturn efx_rc_t
2180 __in efx_nic_t *enp,
2181 __in unsigned int index,
2182 __in unsigned int label,
2183 __in efsys_mem_t *esmp,
2186 __in uint16_t flags,
2187 __in efx_evq_t *eep,
2188 __deref_out efx_txq_t **etpp,
2189 __out unsigned int *addedp);
2191 extern __checkReturn efx_rc_t
2193 __in efx_txq_t *etp,
2194 __in_ecount(ndescs) efx_buffer_t *eb,
2195 __in unsigned int ndescs,
2196 __in unsigned int completed,
2197 __inout unsigned int *addedp);
2199 extern __checkReturn efx_rc_t
2201 __in efx_txq_t *etp,
2202 __in unsigned int ns);
2206 __in efx_txq_t *etp,
2207 __in unsigned int added,
2208 __in unsigned int pushed);
2210 extern __checkReturn efx_rc_t
2212 __in efx_txq_t *etp);
2216 __in efx_txq_t *etp);
2218 extern __checkReturn efx_rc_t
2220 __in efx_txq_t *etp);
2223 efx_tx_qpio_disable(
2224 __in efx_txq_t *etp);
2226 extern __checkReturn efx_rc_t
2228 __in efx_txq_t *etp,
2229 __in_ecount(buf_length) uint8_t *buffer,
2230 __in size_t buf_length,
2231 __in size_t pio_buf_offset);
2233 extern __checkReturn efx_rc_t
2235 __in efx_txq_t *etp,
2236 __in size_t pkt_length,
2237 __in unsigned int completed,
2238 __inout unsigned int *addedp);
2240 extern __checkReturn efx_rc_t
2242 __in efx_txq_t *etp,
2243 __in_ecount(n) efx_desc_t *ed,
2244 __in unsigned int n,
2245 __in unsigned int completed,
2246 __inout unsigned int *addedp);
2249 efx_tx_qdesc_dma_create(
2250 __in efx_txq_t *etp,
2251 __in efsys_dma_addr_t addr,
2254 __out efx_desc_t *edp);
2257 efx_tx_qdesc_tso_create(
2258 __in efx_txq_t *etp,
2259 __in uint16_t ipv4_id,
2260 __in uint32_t tcp_seq,
2261 __in uint8_t tcp_flags,
2262 __out efx_desc_t *edp);
2264 /* Number of FATSOv2 option descriptors */
2265 #define EFX_TX_FATSOV2_OPT_NDESCS 2
2267 /* Maximum number of DMA segments per TSO packet (not superframe) */
2268 #define EFX_TX_FATSOV2_DMA_SEGS_PER_PKT_MAX 24
2271 efx_tx_qdesc_tso2_create(
2272 __in efx_txq_t *etp,
2273 __in uint16_t ipv4_id,
2274 __in uint32_t tcp_seq,
2275 __in uint16_t tcp_mss,
2276 __out_ecount(count) efx_desc_t *edp,
2280 efx_tx_qdesc_vlantci_create(
2281 __in efx_txq_t *etp,
2283 __out efx_desc_t *edp);
2286 efx_tx_qdesc_checksum_create(
2287 __in efx_txq_t *etp,
2288 __in uint16_t flags,
2289 __out efx_desc_t *edp);
2291 #if EFSYS_OPT_QSTATS
2297 __in efx_nic_t *etp,
2298 __in unsigned int id);
2300 #endif /* EFSYS_OPT_NAMES */
2303 efx_tx_qstats_update(
2304 __in efx_txq_t *etp,
2305 __inout_ecount(TX_NQSTATS) efsys_stat_t *stat);
2307 #endif /* EFSYS_OPT_QSTATS */
2311 __in efx_txq_t *etp);
2316 #if EFSYS_OPT_FILTER
2318 #define EFX_ETHER_TYPE_IPV4 0x0800
2319 #define EFX_ETHER_TYPE_IPV6 0x86DD
2321 #define EFX_IPPROTO_TCP 6
2322 #define EFX_IPPROTO_UDP 17
2323 #define EFX_IPPROTO_GRE 47
2325 /* Use RSS to spread across multiple queues */
2326 #define EFX_FILTER_FLAG_RX_RSS 0x01
2327 /* Enable RX scatter */
2328 #define EFX_FILTER_FLAG_RX_SCATTER 0x02
2330 * Override an automatic filter (priority EFX_FILTER_PRI_AUTO).
2331 * May only be set by the filter implementation for each type.
2332 * A removal request will restore the automatic filter in its place.
2334 #define EFX_FILTER_FLAG_RX_OVER_AUTO 0x04
2335 /* Filter is for RX */
2336 #define EFX_FILTER_FLAG_RX 0x08
2337 /* Filter is for TX */
2338 #define EFX_FILTER_FLAG_TX 0x10
2340 typedef uint8_t efx_filter_flags_t;
2343 * Flags which specify the fields to match on. The values are the same as in the
2344 * MC_CMD_FILTER_OP/MC_CMD_FILTER_OP_EXT commands.
2347 /* Match by remote IP host address */
2348 #define EFX_FILTER_MATCH_REM_HOST 0x00000001
2349 /* Match by local IP host address */
2350 #define EFX_FILTER_MATCH_LOC_HOST 0x00000002
2351 /* Match by remote MAC address */
2352 #define EFX_FILTER_MATCH_REM_MAC 0x00000004
2353 /* Match by remote TCP/UDP port */
2354 #define EFX_FILTER_MATCH_REM_PORT 0x00000008
2355 /* Match by remote TCP/UDP port */
2356 #define EFX_FILTER_MATCH_LOC_MAC 0x00000010
2357 /* Match by local TCP/UDP port */
2358 #define EFX_FILTER_MATCH_LOC_PORT 0x00000020
2359 /* Match by Ether-type */
2360 #define EFX_FILTER_MATCH_ETHER_TYPE 0x00000040
2361 /* Match by inner VLAN ID */
2362 #define EFX_FILTER_MATCH_INNER_VID 0x00000080
2363 /* Match by outer VLAN ID */
2364 #define EFX_FILTER_MATCH_OUTER_VID 0x00000100
2365 /* Match by IP transport protocol */
2366 #define EFX_FILTER_MATCH_IP_PROTO 0x00000200
2367 /* For encapsulated packets, match all multicast inner frames */
2368 #define EFX_FILTER_MATCH_IFRM_UNKNOWN_MCAST_DST 0x01000000
2369 /* For encapsulated packets, match all unicast inner frames */
2370 #define EFX_FILTER_MATCH_IFRM_UNKNOWN_UCAST_DST 0x02000000
2371 /* Match otherwise-unmatched multicast and broadcast packets */
2372 #define EFX_FILTER_MATCH_UNKNOWN_MCAST_DST 0x40000000
2373 /* Match otherwise-unmatched unicast packets */
2374 #define EFX_FILTER_MATCH_UNKNOWN_UCAST_DST 0x80000000
2376 typedef uint32_t efx_filter_match_flags_t;
2378 typedef enum efx_filter_priority_s {
2379 EFX_FILTER_PRI_HINT = 0, /* Performance hint */
2380 EFX_FILTER_PRI_AUTO, /* Automatic filter based on device
2381 * address list or hardware
2382 * requirements. This may only be used
2383 * by the filter implementation for
2385 EFX_FILTER_PRI_MANUAL, /* Manually configured filter */
2386 EFX_FILTER_PRI_REQUIRED, /* Required for correct behaviour of the
2387 * client (e.g. SR-IOV, HyperV VMQ etc.)
2389 } efx_filter_priority_t;
2392 * FIXME: All these fields are assumed to be in little-endian byte order.
2393 * It may be better for some to be big-endian. See bug42804.
2396 typedef struct efx_filter_spec_s {
2397 efx_filter_match_flags_t efs_match_flags;
2398 uint8_t efs_priority;
2399 efx_filter_flags_t efs_flags;
2400 uint16_t efs_dmaq_id;
2401 uint32_t efs_rss_context;
2402 uint16_t efs_outer_vid;
2403 uint16_t efs_inner_vid;
2404 uint8_t efs_loc_mac[EFX_MAC_ADDR_LEN];
2405 uint8_t efs_rem_mac[EFX_MAC_ADDR_LEN];
2406 uint16_t efs_ether_type;
2407 uint8_t efs_ip_proto;
2408 efx_tunnel_protocol_t efs_encap_type;
2409 uint16_t efs_loc_port;
2410 uint16_t efs_rem_port;
2411 efx_oword_t efs_rem_host;
2412 efx_oword_t efs_loc_host;
2413 } efx_filter_spec_t;
2416 /* Default values for use in filter specifications */
2417 #define EFX_FILTER_SPEC_RX_DMAQ_ID_DROP 0xfff
2418 #define EFX_FILTER_SPEC_VID_UNSPEC 0xffff
2420 extern __checkReturn efx_rc_t
2422 __in efx_nic_t *enp);
2426 __in efx_nic_t *enp);
2428 extern __checkReturn efx_rc_t
2430 __in efx_nic_t *enp,
2431 __inout efx_filter_spec_t *spec);
2433 extern __checkReturn efx_rc_t
2435 __in efx_nic_t *enp,
2436 __inout efx_filter_spec_t *spec);
2438 extern __checkReturn efx_rc_t
2440 __in efx_nic_t *enp);
2442 extern __checkReturn efx_rc_t
2443 efx_filter_supported_filters(
2444 __in efx_nic_t *enp,
2445 __out_ecount(buffer_length) uint32_t *buffer,
2446 __in size_t buffer_length,
2447 __out size_t *list_lengthp);
2450 efx_filter_spec_init_rx(
2451 __out efx_filter_spec_t *spec,
2452 __in efx_filter_priority_t priority,
2453 __in efx_filter_flags_t flags,
2454 __in efx_rxq_t *erp);
2457 efx_filter_spec_init_tx(
2458 __out efx_filter_spec_t *spec,
2459 __in efx_txq_t *etp);
2461 extern __checkReturn efx_rc_t
2462 efx_filter_spec_set_ipv4_local(
2463 __inout efx_filter_spec_t *spec,
2466 __in uint16_t port);
2468 extern __checkReturn efx_rc_t
2469 efx_filter_spec_set_ipv4_full(
2470 __inout efx_filter_spec_t *spec,
2472 __in uint32_t lhost,
2473 __in uint16_t lport,
2474 __in uint32_t rhost,
2475 __in uint16_t rport);
2477 extern __checkReturn efx_rc_t
2478 efx_filter_spec_set_eth_local(
2479 __inout efx_filter_spec_t *spec,
2481 __in const uint8_t *addr);
2484 efx_filter_spec_set_ether_type(
2485 __inout efx_filter_spec_t *spec,
2486 __in uint16_t ether_type);
2488 extern __checkReturn efx_rc_t
2489 efx_filter_spec_set_uc_def(
2490 __inout efx_filter_spec_t *spec);
2492 extern __checkReturn efx_rc_t
2493 efx_filter_spec_set_mc_def(
2494 __inout efx_filter_spec_t *spec);
2496 typedef enum efx_filter_inner_frame_match_e {
2497 EFX_FILTER_INNER_FRAME_MATCH_OTHER = 0,
2498 EFX_FILTER_INNER_FRAME_MATCH_UNKNOWN_MCAST_DST,
2499 EFX_FILTER_INNER_FRAME_MATCH_UNKNOWN_UCAST_DST
2500 } efx_filter_inner_frame_match_t;
2502 extern __checkReturn efx_rc_t
2503 efx_filter_spec_set_encap_type(
2504 __inout efx_filter_spec_t *spec,
2505 __in efx_tunnel_protocol_t encap_type,
2506 __in efx_filter_inner_frame_match_t inner_frame_match);
2508 #if EFSYS_OPT_RX_SCALE
2509 extern __checkReturn efx_rc_t
2510 efx_filter_spec_set_rss_context(
2511 __inout efx_filter_spec_t *spec,
2512 __in uint32_t rss_context);
2514 #endif /* EFSYS_OPT_FILTER */
2518 extern __checkReturn uint32_t
2520 __in_ecount(count) uint32_t const *input,
2522 __in uint32_t init);
2524 extern __checkReturn uint32_t
2526 __in_ecount(length) uint8_t const *input,
2528 __in uint32_t init);
2530 #if EFSYS_OPT_LICENSING
2534 typedef struct efx_key_stats_s {
2536 uint32_t eks_invalid;
2537 uint32_t eks_blacklisted;
2538 uint32_t eks_unverifiable;
2539 uint32_t eks_wrong_node;
2540 uint32_t eks_licensed_apps_lo;
2541 uint32_t eks_licensed_apps_hi;
2542 uint32_t eks_licensed_features_lo;
2543 uint32_t eks_licensed_features_hi;
2546 extern __checkReturn efx_rc_t
2548 __in efx_nic_t *enp);
2552 __in efx_nic_t *enp);
2554 extern __checkReturn boolean_t
2555 efx_lic_check_support(
2556 __in efx_nic_t *enp);
2558 extern __checkReturn efx_rc_t
2559 efx_lic_update_licenses(
2560 __in efx_nic_t *enp);
2562 extern __checkReturn efx_rc_t
2563 efx_lic_get_key_stats(
2564 __in efx_nic_t *enp,
2565 __out efx_key_stats_t *ksp);
2567 extern __checkReturn efx_rc_t
2569 __in efx_nic_t *enp,
2570 __in uint64_t app_id,
2571 __out boolean_t *licensedp);
2573 extern __checkReturn efx_rc_t
2575 __in efx_nic_t *enp,
2576 __in size_t buffer_size,
2577 __out uint32_t *typep,
2578 __out size_t *lengthp,
2579 __out_opt uint8_t *bufferp);
2582 extern __checkReturn efx_rc_t
2584 __in efx_nic_t *enp,
2585 __in_bcount(buffer_size)
2587 __in size_t buffer_size,
2588 __out uint32_t *startp);
2590 extern __checkReturn efx_rc_t
2592 __in efx_nic_t *enp,
2593 __in_bcount(buffer_size)
2595 __in size_t buffer_size,
2596 __in uint32_t offset,
2597 __out uint32_t *endp);
2599 extern __checkReturn __success(return != B_FALSE) boolean_t
2601 __in efx_nic_t *enp,
2602 __in_bcount(buffer_size)
2604 __in size_t buffer_size,
2605 __in uint32_t offset,
2606 __out uint32_t *startp,
2607 __out uint32_t *lengthp);
2609 extern __checkReturn __success(return != B_FALSE) boolean_t
2610 efx_lic_validate_key(
2611 __in efx_nic_t *enp,
2612 __in_bcount(length) caddr_t keyp,
2613 __in uint32_t length);
2615 extern __checkReturn efx_rc_t
2617 __in efx_nic_t *enp,
2618 __in_bcount(buffer_size)
2620 __in size_t buffer_size,
2621 __in uint32_t offset,
2622 __in uint32_t length,
2623 __out_bcount_part(key_max_size, *lengthp)
2625 __in size_t key_max_size,
2626 __out uint32_t *lengthp);
2628 extern __checkReturn efx_rc_t
2630 __in efx_nic_t *enp,
2631 __in_bcount(buffer_size)
2633 __in size_t buffer_size,
2634 __in uint32_t offset,
2635 __in_bcount(length) caddr_t keyp,
2636 __in uint32_t length,
2637 __out uint32_t *lengthp);
2639 __checkReturn efx_rc_t
2641 __in efx_nic_t *enp,
2642 __in_bcount(buffer_size)
2644 __in size_t buffer_size,
2645 __in uint32_t offset,
2646 __in uint32_t length,
2648 __out uint32_t *deltap);
2650 extern __checkReturn efx_rc_t
2651 efx_lic_create_partition(
2652 __in efx_nic_t *enp,
2653 __in_bcount(buffer_size)
2655 __in size_t buffer_size);
2657 extern __checkReturn efx_rc_t
2658 efx_lic_finish_partition(
2659 __in efx_nic_t *enp,
2660 __in_bcount(buffer_size)
2662 __in size_t buffer_size);
2664 #endif /* EFSYS_OPT_LICENSING */
2668 #if EFSYS_OPT_TUNNEL
2670 extern __checkReturn efx_rc_t
2672 __in efx_nic_t *enp);
2676 __in efx_nic_t *enp);
2679 * For overlay network encapsulation using UDP, the firmware needs to know
2680 * the configured UDP port for the overlay so it can decode encapsulated
2682 * The UDP port/protocol list is global.
2685 extern __checkReturn efx_rc_t
2686 efx_tunnel_config_udp_add(
2687 __in efx_nic_t *enp,
2688 __in uint16_t port /* host/cpu-endian */,
2689 __in efx_tunnel_protocol_t protocol);
2691 extern __checkReturn efx_rc_t
2692 efx_tunnel_config_udp_remove(
2693 __in efx_nic_t *enp,
2694 __in uint16_t port /* host/cpu-endian */,
2695 __in efx_tunnel_protocol_t protocol);
2698 efx_tunnel_config_clear(
2699 __in efx_nic_t *enp);
2702 * Apply tunnel UDP ports configuration to hardware.
2704 * EAGAIN is returned if hardware will be reset (datapath and managment CPU
2707 extern __checkReturn efx_rc_t
2708 efx_tunnel_reconfigure(
2709 __in efx_nic_t *enp);
2711 #endif /* EFSYS_OPT_TUNNEL */
2718 #endif /* _SYS_EFX_H */