2 * Copyright (c) 2006-2016 Solarflare Communications Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
8 * 1. Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright notice,
11 * this list of conditions and the following disclaimer in the documentation
12 * and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
15 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
16 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
18 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
21 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
22 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
23 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
24 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 * The views and conclusions contained in the software and documentation are
27 * those of the authors and should not be interpreted as representing official
28 * policies, either expressed or implied, of the FreeBSD Project.
35 #include "efx_check.h"
36 #include "efx_phy_ids.h"
42 #define EFX_STATIC_ASSERT(_cond) \
43 ((void)sizeof(char[(_cond) ? 1 : -1]))
45 #define EFX_ARRAY_SIZE(_array) \
46 (sizeof(_array) / sizeof((_array)[0]))
48 #define EFX_FIELD_OFFSET(_type, _field) \
49 ((size_t) &(((_type *)0)->_field))
53 typedef __success(return == 0) int efx_rc_t;
58 typedef enum efx_family_e {
60 EFX_FAMILY_FALCON, /* Obsolete and not supported */
62 EFX_FAMILY_HUNTINGTON,
67 extern __checkReturn efx_rc_t
71 __out efx_family_t *efp);
74 #define EFX_PCI_VENID_SFC 0x1924
76 #define EFX_PCI_DEVID_FALCON 0x0710 /* SFC4000 */
78 #define EFX_PCI_DEVID_BETHPAGE 0x0803 /* SFC9020 */
79 #define EFX_PCI_DEVID_SIENA 0x0813 /* SFL9021 */
80 #define EFX_PCI_DEVID_SIENA_F1_UNINIT 0x0810
82 #define EFX_PCI_DEVID_HUNTINGTON_PF_UNINIT 0x0901
83 #define EFX_PCI_DEVID_FARMINGDALE 0x0903 /* SFC9120 PF */
84 #define EFX_PCI_DEVID_GREENPORT 0x0923 /* SFC9140 PF */
86 #define EFX_PCI_DEVID_FARMINGDALE_VF 0x1903 /* SFC9120 VF */
87 #define EFX_PCI_DEVID_GREENPORT_VF 0x1923 /* SFC9140 VF */
89 #define EFX_PCI_DEVID_MEDFORD_PF_UNINIT 0x0913
90 #define EFX_PCI_DEVID_MEDFORD 0x0A03 /* SFC9240 PF */
91 #define EFX_PCI_DEVID_MEDFORD_VF 0x1A03 /* SFC9240 VF */
100 EFX_ERR_BUFID_DC_OOB,
113 /* Calculate the IEEE 802.3 CRC32 of a MAC addr */
114 extern __checkReturn uint32_t
116 __in uint32_t crc_init,
117 __in_ecount(length) uint8_t const *input,
121 /* Type prototypes */
123 typedef struct efx_rxq_s efx_rxq_t;
127 typedef struct efx_nic_s efx_nic_t;
129 extern __checkReturn efx_rc_t
131 __in efx_family_t family,
132 __in efsys_identifier_t *esip,
133 __in efsys_bar_t *esbp,
134 __in efsys_lock_t *eslp,
135 __deref_out efx_nic_t **enpp);
137 extern __checkReturn efx_rc_t
139 __in efx_nic_t *enp);
141 extern __checkReturn efx_rc_t
143 __in efx_nic_t *enp);
145 extern __checkReturn efx_rc_t
147 __in efx_nic_t *enp);
151 extern __checkReturn efx_rc_t
152 efx_nic_register_test(
153 __in efx_nic_t *enp);
155 #endif /* EFSYS_OPT_DIAG */
159 __in efx_nic_t *enp);
163 __in efx_nic_t *enp);
167 __in efx_nic_t *enp);
169 #define EFX_PCIE_LINK_SPEED_GEN1 1
170 #define EFX_PCIE_LINK_SPEED_GEN2 2
171 #define EFX_PCIE_LINK_SPEED_GEN3 3
173 typedef enum efx_pcie_link_performance_e {
174 EFX_PCIE_LINK_PERFORMANCE_UNKNOWN_BANDWIDTH,
175 EFX_PCIE_LINK_PERFORMANCE_SUBOPTIMAL_BANDWIDTH,
176 EFX_PCIE_LINK_PERFORMANCE_SUBOPTIMAL_LATENCY,
177 EFX_PCIE_LINK_PERFORMANCE_OPTIMAL
178 } efx_pcie_link_performance_t;
180 extern __checkReturn efx_rc_t
181 efx_nic_calculate_pcie_link_bandwidth(
182 __in uint32_t pcie_link_width,
183 __in uint32_t pcie_link_gen,
184 __out uint32_t *bandwidth_mbpsp);
186 extern __checkReturn efx_rc_t
187 efx_nic_check_pcie_link_speed(
189 __in uint32_t pcie_link_width,
190 __in uint32_t pcie_link_gen,
191 __out efx_pcie_link_performance_t *resultp);
195 #if EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD
196 /* Huntington and Medford require MCDIv2 commands */
197 #define WITH_MCDI_V2 1
200 typedef struct efx_mcdi_req_s efx_mcdi_req_t;
202 typedef enum efx_mcdi_exception_e {
203 EFX_MCDI_EXCEPTION_MC_REBOOT,
204 EFX_MCDI_EXCEPTION_MC_BADASSERT,
205 } efx_mcdi_exception_t;
207 #if EFSYS_OPT_MCDI_LOGGING
208 typedef enum efx_log_msg_e {
210 EFX_LOG_MCDI_REQUEST,
211 EFX_LOG_MCDI_RESPONSE,
213 #endif /* EFSYS_OPT_MCDI_LOGGING */
215 typedef struct efx_mcdi_transport_s {
217 efsys_mem_t *emt_dma_mem;
218 void (*emt_execute)(void *, efx_mcdi_req_t *);
219 void (*emt_ev_cpl)(void *);
220 void (*emt_exception)(void *, efx_mcdi_exception_t);
221 #if EFSYS_OPT_MCDI_LOGGING
222 void (*emt_logger)(void *, efx_log_msg_t,
223 void *, size_t, void *, size_t);
224 #endif /* EFSYS_OPT_MCDI_LOGGING */
225 #if EFSYS_OPT_MCDI_PROXY_AUTH
226 void (*emt_ev_proxy_response)(void *, uint32_t, efx_rc_t);
227 #endif /* EFSYS_OPT_MCDI_PROXY_AUTH */
228 } efx_mcdi_transport_t;
230 extern __checkReturn efx_rc_t
233 __in const efx_mcdi_transport_t *mtp);
235 extern __checkReturn efx_rc_t
237 __in efx_nic_t *enp);
241 __in efx_nic_t *enp);
244 efx_mcdi_get_timeout(
246 __in efx_mcdi_req_t *emrp,
247 __out uint32_t *usec_timeoutp);
250 efx_mcdi_request_start(
252 __in efx_mcdi_req_t *emrp,
253 __in boolean_t ev_cpl);
255 extern __checkReturn boolean_t
256 efx_mcdi_request_poll(
257 __in efx_nic_t *enp);
259 extern __checkReturn boolean_t
260 efx_mcdi_request_abort(
261 __in efx_nic_t *enp);
265 __in efx_nic_t *enp);
267 #endif /* EFSYS_OPT_MCDI */
271 #define EFX_NINTR_SIENA 1024
273 typedef enum efx_intr_type_e {
274 EFX_INTR_INVALID = 0,
280 #define EFX_INTR_SIZE (sizeof (efx_oword_t))
282 extern __checkReturn efx_rc_t
285 __in efx_intr_type_t type,
286 __in efsys_mem_t *esmp);
290 __in efx_nic_t *enp);
294 __in efx_nic_t *enp);
297 efx_intr_disable_unlocked(
298 __in efx_nic_t *enp);
300 #define EFX_INTR_NEVQS 32
302 extern __checkReturn efx_rc_t
305 __in unsigned int level);
308 efx_intr_status_line(
310 __out boolean_t *fatalp,
311 __out uint32_t *maskp);
314 efx_intr_status_message(
316 __in unsigned int message,
317 __out boolean_t *fatalp);
321 __in efx_nic_t *enp);
325 __in efx_nic_t *enp);
329 typedef enum efx_link_mode_e {
330 EFX_LINK_UNKNOWN = 0,
343 #define EFX_MAC_ADDR_LEN 6
345 #define EFX_MAC_ADDR_IS_MULTICAST(_address) (((uint8_t *)_address)[0] & 0x01)
347 #define EFX_MAC_MULTICAST_LIST_MAX 256
349 #define EFX_MAC_SDU_MAX 9202
351 #define EFX_MAC_PDU_ADJUSTMENT \
355 + /* bug16011 */ 16) \
357 #define EFX_MAC_PDU(_sdu) \
358 P2ROUNDUP((_sdu) + EFX_MAC_PDU_ADJUSTMENT, 8)
361 * Due to the P2ROUNDUP in EFX_MAC_PDU(), EFX_MAC_SDU_FROM_PDU() may give
362 * the SDU rounded up slightly.
364 #define EFX_MAC_SDU_FROM_PDU(_pdu) ((_pdu) - EFX_MAC_PDU_ADJUSTMENT)
366 #define EFX_MAC_PDU_MIN 60
367 #define EFX_MAC_PDU_MAX EFX_MAC_PDU(EFX_MAC_SDU_MAX)
369 extern __checkReturn efx_rc_t
374 extern __checkReturn efx_rc_t
379 extern __checkReturn efx_rc_t
384 extern __checkReturn efx_rc_t
387 __in boolean_t all_unicst,
388 __in boolean_t mulcst,
389 __in boolean_t all_mulcst,
390 __in boolean_t brdcst);
392 extern __checkReturn efx_rc_t
393 efx_mac_multicast_list_set(
395 __in_ecount(6*count) uint8_t const *addrs,
398 extern __checkReturn efx_rc_t
399 efx_mac_filter_default_rxq_set(
402 __in boolean_t using_rss);
405 efx_mac_filter_default_rxq_clear(
406 __in efx_nic_t *enp);
408 extern __checkReturn efx_rc_t
411 __in boolean_t enabled);
413 extern __checkReturn efx_rc_t
416 __out boolean_t *mac_upp);
418 #define EFX_FCNTL_RESPOND 0x00000001
419 #define EFX_FCNTL_GENERATE 0x00000002
421 extern __checkReturn efx_rc_t
424 __in unsigned int fcntl,
425 __in boolean_t autoneg);
430 __out unsigned int *fcntl_wantedp,
431 __out unsigned int *fcntl_linkp);
436 typedef enum efx_mon_type_e {
448 __in efx_nic_t *enp);
450 #endif /* EFSYS_OPT_NAMES */
452 extern __checkReturn efx_rc_t
454 __in efx_nic_t *enp);
458 __in efx_nic_t *enp);
462 extern __checkReturn efx_rc_t
464 __in efx_nic_t *enp);
466 extern __checkReturn efx_rc_t
468 __in efx_nic_t *enp);
470 extern __checkReturn efx_rc_t
473 __out_opt efx_link_mode_t *link_modep);
477 __in efx_nic_t *enp);
479 typedef enum efx_phy_cap_type_e {
480 EFX_PHY_CAP_INVALID = 0,
487 EFX_PHY_CAP_10000FDX,
491 EFX_PHY_CAP_40000FDX,
493 } efx_phy_cap_type_t;
496 #define EFX_PHY_CAP_CURRENT 0x00000000
497 #define EFX_PHY_CAP_DEFAULT 0x00000001
498 #define EFX_PHY_CAP_PERM 0x00000002
504 __out uint32_t *maskp);
506 extern __checkReturn efx_rc_t
514 __out uint32_t *maskp);
516 extern __checkReturn efx_rc_t
519 __out uint32_t *ouip);
521 typedef enum efx_phy_media_type_e {
522 EFX_PHY_MEDIA_INVALID = 0,
527 EFX_PHY_MEDIA_SFP_PLUS,
528 EFX_PHY_MEDIA_BASE_T,
529 EFX_PHY_MEDIA_QSFP_PLUS,
531 } efx_phy_media_type_t;
533 /* Get the type of medium currently used. If the board has ports for
534 * modules, a module is present, and we recognise the media type of
535 * the module, then this will be the media type of the module.
536 * Otherwise it will be the media type of the port.
539 efx_phy_media_type_get(
541 __out efx_phy_media_type_t *typep);
544 efx_phy_module_get_info(
546 __in uint8_t dev_addr,
549 __out_bcount(len) uint8_t *data);
552 #define EFX_FEATURE_IPV6 0x00000001
553 #define EFX_FEATURE_LFSR_HASH_INSERT 0x00000002
554 #define EFX_FEATURE_LINK_EVENTS 0x00000004
555 #define EFX_FEATURE_PERIODIC_MAC_STATS 0x00000008
556 #define EFX_FEATURE_MCDI 0x00000020
557 #define EFX_FEATURE_LOOKAHEAD_SPLIT 0x00000040
558 #define EFX_FEATURE_MAC_HEADER_FILTERS 0x00000080
559 #define EFX_FEATURE_TURBO 0x00000100
560 #define EFX_FEATURE_MCDI_DMA 0x00000200
561 #define EFX_FEATURE_TX_SRC_FILTERS 0x00000400
562 #define EFX_FEATURE_PIO_BUFFERS 0x00000800
563 #define EFX_FEATURE_FW_ASSISTED_TSO 0x00001000
564 #define EFX_FEATURE_FW_ASSISTED_TSO_V2 0x00002000
565 #define EFX_FEATURE_PACKED_STREAM 0x00004000
567 typedef struct efx_nic_cfg_s {
568 uint32_t enc_board_type;
569 uint32_t enc_phy_type;
571 char enc_phy_name[21];
573 char enc_phy_revision[21];
574 efx_mon_type_t enc_mon_type;
575 unsigned int enc_features;
576 uint8_t enc_mac_addr[6];
577 uint8_t enc_port; /* PHY port number */
578 uint32_t enc_intr_vec_base;
579 uint32_t enc_intr_limit;
580 uint32_t enc_evq_limit;
581 uint32_t enc_txq_limit;
582 uint32_t enc_rxq_limit;
583 uint32_t enc_txq_max_ndescs;
584 uint32_t enc_buftbl_limit;
585 uint32_t enc_piobuf_limit;
586 uint32_t enc_piobuf_size;
587 uint32_t enc_piobuf_min_alloc_size;
588 uint32_t enc_evq_timer_quantum_ns;
589 uint32_t enc_evq_timer_max_us;
590 uint32_t enc_clk_mult;
591 uint32_t enc_rx_prefix_size;
592 uint32_t enc_rx_buf_align_start;
593 uint32_t enc_rx_buf_align_end;
595 uint8_t enc_mcdi_mdio_channel;
596 #endif /* EFSYS_OPT_MCDI */
597 #if EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD
600 uint32_t enc_privilege_mask;
601 #endif /* EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD */
602 boolean_t enc_bug26807_workaround;
603 boolean_t enc_bug35388_workaround;
604 boolean_t enc_bug41750_workaround;
605 boolean_t enc_bug61265_workaround;
606 boolean_t enc_rx_batching_enabled;
607 /* Maximum number of descriptors completed in an rx event. */
608 uint32_t enc_rx_batch_max;
609 /* Number of rx descriptors the hardware requires for a push. */
610 uint32_t enc_rx_push_align;
612 * Maximum number of bytes into the packet the TCP header can start for
613 * the hardware to apply TSO packet edits.
615 uint32_t enc_tx_tso_tcp_header_offset_limit;
616 boolean_t enc_fw_assisted_tso_enabled;
617 boolean_t enc_fw_assisted_tso_v2_enabled;
618 /* Number of TSO contexts on the NIC (FATSOv2) */
619 uint32_t enc_fw_assisted_tso_v2_n_contexts;
620 boolean_t enc_hw_tx_insert_vlan_enabled;
621 /* Number of PFs on the NIC */
622 uint32_t enc_hw_pf_count;
623 /* Datapath firmware vadapter/vport/vswitch support */
624 boolean_t enc_datapath_cap_evb;
625 boolean_t enc_rx_disable_scatter_supported;
626 boolean_t enc_allow_set_mac_with_installed_filters;
627 boolean_t enc_enhanced_set_mac_supported;
628 boolean_t enc_init_evq_v2_supported;
629 boolean_t enc_rx_packed_stream_supported;
630 boolean_t enc_rx_var_packed_stream_supported;
631 boolean_t enc_pm_and_rxdp_counters;
632 boolean_t enc_mac_stats_40g_tx_size_bins;
633 /* External port identifier */
634 uint8_t enc_external_port;
635 uint32_t enc_mcdi_max_payload_length;
636 /* VPD may be per-PF or global */
637 boolean_t enc_vpd_is_global;
638 /* Minimum unidirectional bandwidth in Mb/s to max out all ports */
639 uint32_t enc_required_pcie_bandwidth_mbps;
640 uint32_t enc_max_pcie_link_gen;
641 /* Firmware verifies integrity of NVRAM updates */
642 uint32_t enc_fw_verified_nvram_update_required;
645 #define EFX_PCI_FUNCTION_IS_PF(_encp) ((_encp)->enc_vf == 0xffff)
646 #define EFX_PCI_FUNCTION_IS_VF(_encp) ((_encp)->enc_vf != 0xffff)
648 #define EFX_PCI_FUNCTION(_encp) \
649 (EFX_PCI_FUNCTION_IS_PF(_encp) ? (_encp)->enc_pf : (_encp)->enc_vf)
651 #define EFX_PCI_VF_PARENT(_encp) ((_encp)->enc_pf)
653 extern const efx_nic_cfg_t *
655 __in efx_nic_t *enp);
657 /* Driver resource limits (minimum required/maximum usable). */
658 typedef struct efx_drv_limits_s {
659 uint32_t edl_min_evq_count;
660 uint32_t edl_max_evq_count;
662 uint32_t edl_min_rxq_count;
663 uint32_t edl_max_rxq_count;
665 uint32_t edl_min_txq_count;
666 uint32_t edl_max_txq_count;
668 /* PIO blocks (sub-allocated from piobuf) */
669 uint32_t edl_min_pio_alloc_size;
670 uint32_t edl_max_pio_alloc_count;
673 extern __checkReturn efx_rc_t
674 efx_nic_set_drv_limits(
675 __inout efx_nic_t *enp,
676 __in efx_drv_limits_t *edlp);
678 typedef enum efx_nic_region_e {
679 EFX_REGION_VI, /* Memory BAR UC mapping */
680 EFX_REGION_PIO_WRITE_VI, /* Memory BAR WC mapping */
683 extern __checkReturn efx_rc_t
684 efx_nic_get_bar_region(
686 __in efx_nic_region_t region,
687 __out uint32_t *offsetp,
688 __out size_t *sizep);
690 extern __checkReturn efx_rc_t
693 __out uint32_t *evq_countp,
694 __out uint32_t *rxq_countp,
695 __out uint32_t *txq_countp);
702 typedef enum efx_pattern_type_t {
703 EFX_PATTERN_BYTE_INCREMENT = 0,
704 EFX_PATTERN_ALL_THE_SAME,
705 EFX_PATTERN_BIT_ALTERNATE,
706 EFX_PATTERN_BYTE_ALTERNATE,
707 EFX_PATTERN_BYTE_CHANGING,
708 EFX_PATTERN_BIT_SWEEP,
710 } efx_pattern_type_t;
713 (*efx_sram_pattern_fn_t)(
715 __in boolean_t negate,
716 __out efx_qword_t *eqp);
718 extern __checkReturn efx_rc_t
721 __in efx_pattern_type_t type);
723 #endif /* EFSYS_OPT_DIAG */
725 extern __checkReturn efx_rc_t
726 efx_sram_buf_tbl_set(
729 __in efsys_mem_t *esmp,
733 efx_sram_buf_tbl_clear(
738 #define EFX_BUF_TBL_SIZE 0x20000
740 #define EFX_BUF_SIZE 4096
744 typedef struct efx_evq_s efx_evq_t;
746 extern __checkReturn efx_rc_t
748 __in efx_nic_t *enp);
752 __in efx_nic_t *enp);
754 #define EFX_EVQ_MAXNEVS 32768
755 #define EFX_EVQ_MINNEVS 512
757 #define EFX_EVQ_SIZE(_nevs) ((_nevs) * sizeof (efx_qword_t))
758 #define EFX_EVQ_NBUFS(_nevs) (EFX_EVQ_SIZE(_nevs) / EFX_BUF_SIZE)
760 #define EFX_EVQ_FLAGS_TYPE_MASK (0x3)
761 #define EFX_EVQ_FLAGS_TYPE_AUTO (0x0)
762 #define EFX_EVQ_FLAGS_TYPE_THROUGHPUT (0x1)
763 #define EFX_EVQ_FLAGS_TYPE_LOW_LATENCY (0x2)
765 #define EFX_EVQ_FLAGS_NOTIFY_MASK (0xC)
766 #define EFX_EVQ_FLAGS_NOTIFY_INTERRUPT (0x0) /* Interrupting (default) */
767 #define EFX_EVQ_FLAGS_NOTIFY_DISABLED (0x4) /* Non-interrupting */
769 extern __checkReturn efx_rc_t
772 __in unsigned int index,
773 __in efsys_mem_t *esmp,
778 __deref_out efx_evq_t **eepp);
785 typedef __checkReturn boolean_t
786 (*efx_initialized_ev_t)(
789 #define EFX_PKT_UNICAST 0x0004
790 #define EFX_PKT_START 0x0008
792 #define EFX_PKT_VLAN_TAGGED 0x0010
793 #define EFX_CKSUM_TCPUDP 0x0020
794 #define EFX_CKSUM_IPV4 0x0040
795 #define EFX_PKT_CONT 0x0080
797 #define EFX_CHECK_VLAN 0x0100
798 #define EFX_PKT_TCP 0x0200
799 #define EFX_PKT_UDP 0x0400
800 #define EFX_PKT_IPV4 0x0800
802 #define EFX_PKT_IPV6 0x1000
803 #define EFX_PKT_PREFIX_LEN 0x2000
804 #define EFX_ADDR_MISMATCH 0x4000
805 #define EFX_DISCARD 0x8000
808 * The following flags are used only for packed stream
809 * mode. The values for the flags are reused to fit into 16 bit,
810 * since EFX_PKT_START and EFX_PKT_CONT are never used in
813 #define EFX_PKT_PACKED_STREAM_NEW_BUFFER EFX_PKT_START
814 #define EFX_PKT_PACKED_STREAM_PARSE_INCOMPLETE EFX_PKT_CONT
817 #define EFX_EV_RX_NLABELS 32
818 #define EFX_EV_TX_NLABELS 32
820 typedef __checkReturn boolean_t
826 __in uint16_t flags);
828 typedef __checkReturn boolean_t
834 #define EFX_EXCEPTION_RX_RECOVERY 0x00000001
835 #define EFX_EXCEPTION_RX_DSC_ERROR 0x00000002
836 #define EFX_EXCEPTION_TX_DSC_ERROR 0x00000003
837 #define EFX_EXCEPTION_UNKNOWN_SENSOREVT 0x00000004
838 #define EFX_EXCEPTION_FWALERT_SRAM 0x00000005
839 #define EFX_EXCEPTION_UNKNOWN_FWALERT 0x00000006
840 #define EFX_EXCEPTION_RX_ERROR 0x00000007
841 #define EFX_EXCEPTION_TX_ERROR 0x00000008
842 #define EFX_EXCEPTION_EV_ERROR 0x00000009
844 typedef __checkReturn boolean_t
845 (*efx_exception_ev_t)(
850 typedef __checkReturn boolean_t
851 (*efx_rxq_flush_done_ev_t)(
853 __in uint32_t rxq_index);
855 typedef __checkReturn boolean_t
856 (*efx_rxq_flush_failed_ev_t)(
858 __in uint32_t rxq_index);
860 typedef __checkReturn boolean_t
861 (*efx_txq_flush_done_ev_t)(
863 __in uint32_t txq_index);
865 typedef __checkReturn boolean_t
866 (*efx_software_ev_t)(
868 __in uint16_t magic);
870 typedef __checkReturn boolean_t
875 #define EFX_SRAM_CLEAR 0
876 #define EFX_SRAM_UPDATE 1
877 #define EFX_SRAM_ILLEGAL_CLEAR 2
879 typedef __checkReturn boolean_t
882 __in uint32_t label);
884 typedef __checkReturn boolean_t
887 __in uint32_t label);
889 typedef __checkReturn boolean_t
890 (*efx_link_change_ev_t)(
892 __in efx_link_mode_t link_mode);
894 typedef struct efx_ev_callbacks_s {
895 efx_initialized_ev_t eec_initialized;
898 efx_exception_ev_t eec_exception;
899 efx_rxq_flush_done_ev_t eec_rxq_flush_done;
900 efx_rxq_flush_failed_ev_t eec_rxq_flush_failed;
901 efx_txq_flush_done_ev_t eec_txq_flush_done;
902 efx_software_ev_t eec_software;
903 efx_sram_ev_t eec_sram;
904 efx_wake_up_ev_t eec_wake_up;
905 efx_timer_ev_t eec_timer;
906 efx_link_change_ev_t eec_link_change;
907 } efx_ev_callbacks_t;
909 extern __checkReturn boolean_t
912 __in unsigned int count);
917 __inout unsigned int *countp,
918 __in const efx_ev_callbacks_t *eecp,
921 extern __checkReturn efx_rc_t
922 efx_ev_usecs_to_ticks(
924 __in unsigned int usecs,
925 __out unsigned int *ticksp);
927 extern __checkReturn efx_rc_t
930 __in unsigned int us);
932 extern __checkReturn efx_rc_t
935 __in unsigned int count);
939 __in efx_evq_t *eep);
943 extern __checkReturn efx_rc_t
945 __inout efx_nic_t *enp);
949 __in efx_nic_t *enp);
951 extern __checkReturn efx_rc_t
952 efx_pseudo_hdr_pkt_length_get(
954 __in uint8_t *buffer,
955 __out uint16_t *pkt_lengthp);
957 #define EFX_RXQ_MAXNDESCS 4096
958 #define EFX_RXQ_MINNDESCS 512
960 #define EFX_RXQ_SIZE(_ndescs) ((_ndescs) * sizeof (efx_qword_t))
961 #define EFX_RXQ_NBUFS(_ndescs) (EFX_RXQ_SIZE(_ndescs) / EFX_BUF_SIZE)
962 #define EFX_RXQ_LIMIT(_ndescs) ((_ndescs) - 16)
963 #define EFX_RXQ_DC_NDESCS(_dcsize) (8 << _dcsize)
965 typedef enum efx_rxq_type_e {
966 EFX_RXQ_TYPE_DEFAULT,
967 EFX_RXQ_TYPE_SCATTER,
968 EFX_RXQ_TYPE_PACKED_STREAM_1M,
969 EFX_RXQ_TYPE_PACKED_STREAM_512K,
970 EFX_RXQ_TYPE_PACKED_STREAM_256K,
971 EFX_RXQ_TYPE_PACKED_STREAM_128K,
972 EFX_RXQ_TYPE_PACKED_STREAM_64K,
976 extern __checkReturn efx_rc_t
979 __in unsigned int index,
980 __in unsigned int label,
981 __in efx_rxq_type_t type,
982 __in efsys_mem_t *esmp,
986 __deref_out efx_rxq_t **erpp);
988 typedef struct efx_buffer_s {
989 efsys_dma_addr_t eb_addr;
994 typedef struct efx_desc_s {
1000 __in efx_rxq_t *erp,
1001 __in_ecount(n) efsys_dma_addr_t *addrp,
1003 __in unsigned int n,
1004 __in unsigned int completed,
1005 __in unsigned int added);
1009 __in efx_rxq_t *erp,
1010 __in unsigned int added,
1011 __inout unsigned int *pushedp);
1013 extern __checkReturn efx_rc_t
1015 __in efx_rxq_t *erp);
1019 __in efx_rxq_t *erp);
1023 __in efx_rxq_t *erp);
1027 typedef struct efx_txq_s efx_txq_t;
1029 extern __checkReturn efx_rc_t
1031 __in efx_nic_t *enp);
1035 __in efx_nic_t *enp);
1037 #define EFX_TXQ_MINNDESCS 512
1039 #define EFX_TXQ_SIZE(_ndescs) ((_ndescs) * sizeof (efx_qword_t))
1040 #define EFX_TXQ_NBUFS(_ndescs) (EFX_TXQ_SIZE(_ndescs) / EFX_BUF_SIZE)
1041 #define EFX_TXQ_LIMIT(_ndescs) ((_ndescs) - 16)
1042 #define EFX_TXQ_DC_NDESCS(_dcsize) (8 << _dcsize)
1044 #define EFX_TXQ_MAX_BUFS 8 /* Maximum independent of EFX_BUG35388_WORKAROUND. */
1046 #define EFX_TXQ_CKSUM_IPV4 0x0001
1047 #define EFX_TXQ_CKSUM_TCPUDP 0x0002
1048 #define EFX_TXQ_FATSOV2 0x0004
1050 extern __checkReturn efx_rc_t
1052 __in efx_nic_t *enp,
1053 __in unsigned int index,
1054 __in unsigned int label,
1055 __in efsys_mem_t *esmp,
1058 __in uint16_t flags,
1059 __in efx_evq_t *eep,
1060 __deref_out efx_txq_t **etpp,
1061 __out unsigned int *addedp);
1063 extern __checkReturn efx_rc_t
1065 __in efx_txq_t *etp,
1066 __in_ecount(n) efx_buffer_t *eb,
1067 __in unsigned int n,
1068 __in unsigned int completed,
1069 __inout unsigned int *addedp);
1071 extern __checkReturn efx_rc_t
1073 __in efx_txq_t *etp,
1074 __in unsigned int ns);
1078 __in efx_txq_t *etp,
1079 __in unsigned int added,
1080 __in unsigned int pushed);
1082 extern __checkReturn efx_rc_t
1084 __in efx_txq_t *etp);
1088 __in efx_txq_t *etp);
1090 extern __checkReturn efx_rc_t
1092 __in efx_txq_t *etp);
1095 efx_tx_qpio_disable(
1096 __in efx_txq_t *etp);
1098 extern __checkReturn efx_rc_t
1100 __in efx_txq_t *etp,
1101 __in_ecount(buf_length) uint8_t *buffer,
1102 __in size_t buf_length,
1103 __in size_t pio_buf_offset);
1105 extern __checkReturn efx_rc_t
1107 __in efx_txq_t *etp,
1108 __in size_t pkt_length,
1109 __in unsigned int completed,
1110 __inout unsigned int *addedp);
1112 extern __checkReturn efx_rc_t
1114 __in efx_txq_t *etp,
1115 __in_ecount(n) efx_desc_t *ed,
1116 __in unsigned int n,
1117 __in unsigned int completed,
1118 __inout unsigned int *addedp);
1121 efx_tx_qdesc_dma_create(
1122 __in efx_txq_t *etp,
1123 __in efsys_dma_addr_t addr,
1126 __out efx_desc_t *edp);
1129 efx_tx_qdesc_tso_create(
1130 __in efx_txq_t *etp,
1131 __in uint16_t ipv4_id,
1132 __in uint32_t tcp_seq,
1133 __in uint8_t tcp_flags,
1134 __out efx_desc_t *edp);
1136 /* Number of FATSOv2 option descriptors */
1137 #define EFX_TX_FATSOV2_OPT_NDESCS 2
1139 /* Maximum number of DMA segments per TSO packet (not superframe) */
1140 #define EFX_TX_FATSOV2_DMA_SEGS_PER_PKT_MAX 24
1143 efx_tx_qdesc_tso2_create(
1144 __in efx_txq_t *etp,
1145 __in uint16_t ipv4_id,
1146 __in uint32_t tcp_seq,
1147 __in uint16_t tcp_mss,
1148 __out_ecount(count) efx_desc_t *edp,
1152 efx_tx_qdesc_vlantci_create(
1153 __in efx_txq_t *etp,
1155 __out efx_desc_t *edp);
1159 __in efx_txq_t *etp);
1164 #if EFSYS_OPT_FILTER
1166 #define EFX_ETHER_TYPE_IPV4 0x0800
1167 #define EFX_ETHER_TYPE_IPV6 0x86DD
1169 #define EFX_IPPROTO_TCP 6
1170 #define EFX_IPPROTO_UDP 17
1172 /* Use RSS to spread across multiple queues */
1173 #define EFX_FILTER_FLAG_RX_RSS 0x01
1174 /* Enable RX scatter */
1175 #define EFX_FILTER_FLAG_RX_SCATTER 0x02
1177 * Override an automatic filter (priority EFX_FILTER_PRI_AUTO).
1178 * May only be set by the filter implementation for each type.
1179 * A removal request will restore the automatic filter in its place.
1181 #define EFX_FILTER_FLAG_RX_OVER_AUTO 0x04
1182 /* Filter is for RX */
1183 #define EFX_FILTER_FLAG_RX 0x08
1184 /* Filter is for TX */
1185 #define EFX_FILTER_FLAG_TX 0x10
1187 typedef unsigned int efx_filter_flags_t;
1189 typedef enum efx_filter_match_flags_e {
1190 EFX_FILTER_MATCH_REM_HOST = 0x0001, /* Match by remote IP host
1192 EFX_FILTER_MATCH_LOC_HOST = 0x0002, /* Match by local IP host
1194 EFX_FILTER_MATCH_REM_MAC = 0x0004, /* Match by remote MAC address */
1195 EFX_FILTER_MATCH_REM_PORT = 0x0008, /* Match by remote TCP/UDP port */
1196 EFX_FILTER_MATCH_LOC_MAC = 0x0010, /* Match by remote TCP/UDP port */
1197 EFX_FILTER_MATCH_LOC_PORT = 0x0020, /* Match by local TCP/UDP port */
1198 EFX_FILTER_MATCH_ETHER_TYPE = 0x0040, /* Match by Ether-type */
1199 EFX_FILTER_MATCH_INNER_VID = 0x0080, /* Match by inner VLAN ID */
1200 EFX_FILTER_MATCH_OUTER_VID = 0x0100, /* Match by outer VLAN ID */
1201 EFX_FILTER_MATCH_IP_PROTO = 0x0200, /* Match by IP transport
1203 EFX_FILTER_MATCH_LOC_MAC_IG = 0x0400, /* Match by local MAC address
1204 * I/G bit. Used for RX default
1205 * unicast and multicast/
1206 * broadcast filters. */
1207 } efx_filter_match_flags_t;
1209 typedef enum efx_filter_priority_s {
1210 EFX_FILTER_PRI_HINT = 0, /* Performance hint */
1211 EFX_FILTER_PRI_AUTO, /* Automatic filter based on device
1212 * address list or hardware
1213 * requirements. This may only be used
1214 * by the filter implementation for
1216 EFX_FILTER_PRI_MANUAL, /* Manually configured filter */
1217 EFX_FILTER_PRI_REQUIRED, /* Required for correct behaviour of the
1218 * client (e.g. SR-IOV, HyperV VMQ etc.)
1220 } efx_filter_priority_t;
1223 * FIXME: All these fields are assumed to be in little-endian byte order.
1224 * It may be better for some to be big-endian. See bug42804.
1227 typedef struct efx_filter_spec_s {
1228 uint32_t efs_match_flags:12;
1229 uint32_t efs_priority:2;
1230 uint32_t efs_flags:6;
1231 uint32_t efs_dmaq_id:12;
1232 uint32_t efs_rss_context;
1233 uint16_t efs_outer_vid;
1234 uint16_t efs_inner_vid;
1235 uint8_t efs_loc_mac[EFX_MAC_ADDR_LEN];
1236 uint8_t efs_rem_mac[EFX_MAC_ADDR_LEN];
1237 uint16_t efs_ether_type;
1238 uint8_t efs_ip_proto;
1239 uint16_t efs_loc_port;
1240 uint16_t efs_rem_port;
1241 efx_oword_t efs_rem_host;
1242 efx_oword_t efs_loc_host;
1243 } efx_filter_spec_t;
1246 /* Default values for use in filter specifications */
1247 #define EFX_FILTER_SPEC_RSS_CONTEXT_DEFAULT 0xffffffff
1248 #define EFX_FILTER_SPEC_RX_DMAQ_ID_DROP 0xfff
1249 #define EFX_FILTER_SPEC_VID_UNSPEC 0xffff
1251 extern __checkReturn efx_rc_t
1253 __in efx_nic_t *enp);
1257 __in efx_nic_t *enp);
1259 extern __checkReturn efx_rc_t
1261 __in efx_nic_t *enp,
1262 __inout efx_filter_spec_t *spec);
1264 extern __checkReturn efx_rc_t
1266 __in efx_nic_t *enp,
1267 __inout efx_filter_spec_t *spec);
1269 extern __checkReturn efx_rc_t
1271 __in efx_nic_t *enp);
1273 extern __checkReturn efx_rc_t
1274 efx_filter_supported_filters(
1275 __in efx_nic_t *enp,
1276 __out uint32_t *list,
1277 __out size_t *length);
1280 efx_filter_spec_init_rx(
1281 __out efx_filter_spec_t *spec,
1282 __in efx_filter_priority_t priority,
1283 __in efx_filter_flags_t flags,
1284 __in efx_rxq_t *erp);
1287 efx_filter_spec_init_tx(
1288 __out efx_filter_spec_t *spec,
1289 __in efx_txq_t *etp);
1291 extern __checkReturn efx_rc_t
1292 efx_filter_spec_set_ipv4_local(
1293 __inout efx_filter_spec_t *spec,
1296 __in uint16_t port);
1298 extern __checkReturn efx_rc_t
1299 efx_filter_spec_set_ipv4_full(
1300 __inout efx_filter_spec_t *spec,
1302 __in uint32_t lhost,
1303 __in uint16_t lport,
1304 __in uint32_t rhost,
1305 __in uint16_t rport);
1307 extern __checkReturn efx_rc_t
1308 efx_filter_spec_set_eth_local(
1309 __inout efx_filter_spec_t *spec,
1311 __in const uint8_t *addr);
1313 extern __checkReturn efx_rc_t
1314 efx_filter_spec_set_uc_def(
1315 __inout efx_filter_spec_t *spec);
1317 extern __checkReturn efx_rc_t
1318 efx_filter_spec_set_mc_def(
1319 __inout efx_filter_spec_t *spec);
1321 #endif /* EFSYS_OPT_FILTER */
1325 extern __checkReturn uint32_t
1327 __in_ecount(count) uint32_t const *input,
1329 __in uint32_t init);
1331 extern __checkReturn uint32_t
1333 __in_ecount(length) uint8_t const *input,
1335 __in uint32_t init);
1343 #endif /* _SYS_EFX_H */