2 Copyright(c) 2017 Intel Corporation. All rights reserved.
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions
9 * Redistributions of source code must retain the above copyright
10 notice, this list of conditions and the following disclaimer.
11 * Redistributions in binary form must reproduce the above copyright
12 notice, this list of conditions and the following disclaimer in
13 the documentation and/or other materials provided with the
15 * Neither the name of Intel Corporation nor the names of its
16 contributors may be used to endorse or promote products derived
17 from this software without specific prior written permission.
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 This section explains the supported features that are listed in the
37 As a guide to implementers it also shows the structs where the features are
38 defined and the APIs that can be use to get/set the values.
40 Following tags used for feature details, these are from driver point of view:
42 ``[uses]`` : Driver uses some kind of input from the application.
44 ``[implements]`` : Driver implements a functionality.
46 ``[provides]`` : Driver provides some kind of data to the application. It is possible
47 to provide data by implementing some function, but "provides" is used
48 for cases where provided data can't be represented simply by a function.
50 ``[related]`` : Related API with that feature.
53 .. _nic_features_speed_capabilities:
58 Supports getting the speed capabilities that the current device is capable of.
60 * **[provides] rte_eth_dev_info**: ``speed_capa:ETH_LINK_SPEED_*``.
61 * **[related] API**: ``rte_eth_dev_info_get()``.
64 .. _nic_features_link_status:
69 Supports getting the link speed, duplex mode and link state (up/down).
71 * **[implements] eth_dev_ops**: ``link_update``.
72 * **[implements] rte_eth_dev_data**: ``dev_link``.
73 * **[related] API**: ``rte_eth_link_get()``, ``rte_eth_link_get_nowait()``.
76 .. _nic_features_link_status_event:
81 Supports Link Status Change interrupts.
83 * **[uses] user config**: ``dev_conf.intr_conf.lsc``.
84 * **[uses] rte_eth_dev_data**: ``dev_flags:RTE_ETH_DEV_INTR_LSC``.
85 * **[uses] rte_eth_event_type**: ``RTE_ETH_EVENT_INTR_LSC``.
86 * **[implements] rte_eth_dev_data**: ``dev_link``.
87 * **[provides] rte_pci_driver.drv_flags**: ``RTE_PCI_DRV_INTR_LSC``.
88 * **[related] API**: ``rte_eth_link_get()``, ``rte_eth_link_get_nowait()``.
91 .. _nic_features_removal_event:
96 Supports device removal interrupts.
98 * **[uses] user config**: ``dev_conf.intr_conf.rmv``.
99 * **[uses] rte_eth_dev_data**: ``dev_flags:RTE_ETH_DEV_INTR_RMV``.
100 * **[uses] rte_eth_event_type**: ``RTE_ETH_EVENT_INTR_RMV``.
101 * **[provides] rte_pci_driver.drv_flags**: ``RTE_PCI_DRV_INTR_RMV``.
104 .. _nic_features_queue_status_event:
109 Supports queue enable/disable events.
111 * **[uses] rte_eth_event_type**: ``RTE_ETH_EVENT_QUEUE_STATE``.
114 .. _nic_features_rx_interrupt:
119 Supports Rx interrupts.
121 * **[uses] user config**: ``dev_conf.intr_conf.rxq``.
122 * **[implements] eth_dev_ops**: ``rx_queue_intr_enable``, ``rx_queue_intr_disable``.
123 * **[related] API**: ``rte_eth_dev_rx_intr_enable()``, ``rte_eth_dev_rx_intr_disable()``.
126 .. _nic_features_lock-free_tx_queue:
131 If a PMD advertises DEV_TX_OFFLOAD_MT_LOCKFREE capable, multiple threads can
132 invoke rte_eth_tx_burst() concurrently on the same Tx queue without SW lock.
134 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_MT_LOCKFREE``.
135 * **[provides] rte_eth_dev_info**: ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_MT_LOCKFREE``.
136 * **[related] API**: ``rte_eth_tx_burst()``.
139 .. _nic_features_free_tx_mbuf_on_demand:
141 Free Tx mbuf on demand
142 ----------------------
144 Supports freeing consumed buffers on a Tx ring.
146 * **[implements] eth_dev_ops**: ``tx_done_cleanup``.
147 * **[related] API**: ``rte_eth_tx_done_cleanup()``.
150 .. _nic_features_queue_start_stop:
155 Supports starting/stopping a specific Rx/Tx queue of a port.
157 * **[implements] eth_dev_ops**: ``rx_queue_start``, ``rx_queue_stop``, ``tx_queue_start``,
159 * **[related] API**: ``rte_eth_dev_rx_queue_start()``, ``rte_eth_dev_rx_queue_stop()``,
160 ``rte_eth_dev_tx_queue_start()``, ``rte_eth_dev_tx_queue_stop()``.
163 .. _nic_features_mtu_update:
168 Supports updating port MTU.
170 * **[implements] eth_dev_ops**: ``mtu_set``.
171 * **[implements] rte_eth_dev_data**: ``mtu``.
172 * **[provides] rte_eth_dev_info**: ``max_rx_pktlen``.
173 * **[related] API**: ``rte_eth_dev_set_mtu()``, ``rte_eth_dev_get_mtu()``.
176 .. _nic_features_jumbo_frame:
181 Supports Rx jumbo frames.
183 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_JUMBO_FRAME``.
184 ``dev_conf.rxmode.max_rx_pkt_len``.
185 * **[related] rte_eth_dev_info**: ``max_rx_pktlen``.
186 * **[related] API**: ``rte_eth_dev_set_mtu()``.
189 .. _nic_features_scattered_rx:
194 Supports receiving segmented mbufs.
196 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_SCATTER``.
197 * **[implements] datapath**: ``Scattered Rx function``.
198 * **[implements] rte_eth_dev_data**: ``scattered_rx``.
199 * **[provides] eth_dev_ops**: ``rxq_info_get:scattered_rx``.
200 * **[related] eth_dev_ops**: ``rx_pkt_burst``.
203 .. _nic_features_lro:
208 Supports Large Receive Offload.
210 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_TCP_LRO``.
211 * **[implements] datapath**: ``LRO functionality``.
212 * **[implements] rte_eth_dev_data**: ``lro``.
213 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_LRO``, ``mbuf.tso_segsz``.
214 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_TCP_LRO``.
217 .. _nic_features_tso:
222 Supports TCP Segmentation Offloading.
224 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_TCP_TSO``.
225 * **[uses] rte_eth_desc_lim**: ``nb_seg_max``, ``nb_mtu_seg_max``.
226 * **[uses] mbuf**: ``mbuf.ol_flags:PKT_TX_TCP_SEG``.
227 * **[uses] mbuf**: ``mbuf.tso_segsz``, ``mbuf.l2_len``, ``mbuf.l3_len``, ``mbuf.l4_len``.
228 * **[implements] datapath**: ``TSO functionality``.
229 * **[provides] rte_eth_dev_info**: ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_TCP_TSO,DEV_TX_OFFLOAD_UDP_TSO``.
232 .. _nic_features_promiscuous_mode:
237 Supports enabling/disabling promiscuous mode for a port.
239 * **[implements] eth_dev_ops**: ``promiscuous_enable``, ``promiscuous_disable``.
240 * **[implements] rte_eth_dev_data**: ``promiscuous``.
241 * **[related] API**: ``rte_eth_promiscuous_enable()``, ``rte_eth_promiscuous_disable()``,
242 ``rte_eth_promiscuous_get()``.
245 .. _nic_features_allmulticast_mode:
250 Supports enabling/disabling receiving multicast frames.
252 * **[implements] eth_dev_ops**: ``allmulticast_enable``, ``allmulticast_disable``.
253 * **[implements] rte_eth_dev_data**: ``all_multicast``.
254 * **[related] API**: ``rte_eth_allmulticast_enable()``,
255 ``rte_eth_allmulticast_disable()``, ``rte_eth_allmulticast_get()``.
258 .. _nic_features_unicast_mac_filter:
263 Supports adding MAC addresses to enable whitelist filtering to accept packets.
265 * **[implements] eth_dev_ops**: ``mac_addr_set``, ``mac_addr_add``, ``mac_addr_remove``.
266 * **[implements] rte_eth_dev_data**: ``mac_addrs``.
267 * **[related] API**: ``rte_eth_dev_default_mac_addr_set()``,
268 ``rte_eth_dev_mac_addr_add()``, ``rte_eth_dev_mac_addr_remove()``,
269 ``rte_eth_macaddr_get()``.
272 .. _nic_features_multicast_mac_filter:
277 Supports setting multicast addresses to filter.
279 * **[implements] eth_dev_ops**: ``set_mc_addr_list``.
280 * **[related] API**: ``rte_eth_dev_set_mc_addr_list()``.
283 .. _nic_features_rss_hash:
288 Supports RSS hashing on RX.
290 * **[uses] user config**: ``dev_conf.rxmode.mq_mode`` = ``ETH_MQ_RX_RSS_FLAG``.
291 * **[uses] user config**: ``dev_conf.rx_adv_conf.rss_conf``.
292 * **[provides] rte_eth_dev_info**: ``flow_type_rss_offloads``.
293 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_RSS_HASH``, ``mbuf.rss``.
296 .. _nic_features_rss_key_update:
301 Supports configuration of Receive Side Scaling (RSS) hash computation. Updating
302 Receive Side Scaling (RSS) hash key.
304 * **[implements] eth_dev_ops**: ``rss_hash_update``, ``rss_hash_conf_get``.
305 * **[provides] rte_eth_dev_info**: ``hash_key_size``.
306 * **[related] API**: ``rte_eth_dev_rss_hash_update()``,
307 ``rte_eth_dev_rss_hash_conf_get()``.
310 .. _nic_features_rss_reta_update:
315 Supports updating Redirection Table of the Receive Side Scaling (RSS).
317 * **[implements] eth_dev_ops**: ``reta_update``, ``reta_query``.
318 * **[provides] rte_eth_dev_info**: ``reta_size``.
319 * **[related] API**: ``rte_eth_dev_rss_reta_update()``, ``rte_eth_dev_rss_reta_query()``.
322 .. _nic_features_vmdq:
327 Supports Virtual Machine Device Queues (VMDq).
329 * **[uses] user config**: ``dev_conf.rxmode.mq_mode`` = ``ETH_MQ_RX_VMDQ_FLAG``.
330 * **[uses] user config**: ``dev_conf.rx_adv_conf.vmdq_dcb_conf``.
331 * **[uses] user config**: ``dev_conf.rx_adv_conf.vmdq_rx_conf``.
332 * **[uses] user config**: ``dev_conf.tx_adv_conf.vmdq_dcb_tx_conf``.
333 * **[uses] user config**: ``dev_conf.tx_adv_conf.vmdq_tx_conf``.
336 .. _nic_features_sriov:
341 Driver supports creating Virtual Functions.
343 * **[implements] rte_eth_dev_data**: ``sriov``.
345 .. _nic_features_dcb:
350 Supports Data Center Bridging (DCB).
352 * **[uses] user config**: ``dev_conf.rxmode.mq_mode`` = ``ETH_MQ_RX_DCB_FLAG``.
353 * **[uses] user config**: ``dev_conf.rx_adv_conf.vmdq_dcb_conf``.
354 * **[uses] user config**: ``dev_conf.rx_adv_conf.dcb_rx_conf``.
355 * **[uses] user config**: ``dev_conf.tx_adv_conf.vmdq_dcb_tx_conf``.
356 * **[uses] user config**: ``dev_conf.tx_adv_conf.vmdq_tx_conf``.
357 * **[implements] eth_dev_ops**: ``get_dcb_info``.
358 * **[related] API**: ``rte_eth_dev_get_dcb_info()``.
361 .. _nic_features_vlan_filter:
366 Supports filtering of a VLAN Tag identifier.
368 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_VLAN_FILTER``.
369 * **[implements] eth_dev_ops**: ``vlan_filter_set``.
370 * **[related] API**: ``rte_eth_dev_vlan_filter()``.
373 .. _nic_features_ethertype_filter:
378 Supports filtering on Ethernet type.
380 * **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_ETHERTYPE``.
381 * **[related] API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``.
383 .. _nic_features_ntuple_filter:
388 Supports filtering on N-tuple values.
390 * **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_NTUPLE``.
391 * **[related] API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``.
394 .. _nic_features_syn_filter:
399 Supports TCP syn filtering.
401 * **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_SYN``.
402 * **[related] API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``.
405 .. _nic_features_tunnel_filter:
410 Supports tunnel filtering.
412 * **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_TUNNEL``.
413 * **[related] API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``.
416 .. _nic_features_flexible_filter:
421 Supports a flexible (non-tuple or Ethertype) filter.
423 * **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_FLEXIBLE``.
424 * **[related] API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``.
427 .. _nic_features_hash_filter:
432 Supports Hash filtering.
434 * **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_HASH``.
435 * **[related] API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``.
438 .. _nic_features_flow_director:
443 Supports Flow Director style filtering to queues.
445 * **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_FDIR``.
446 * **[provides] mbuf**: ``mbuf.ol_flags:`` ``PKT_RX_FDIR``, ``PKT_RX_FDIR_ID``,
448 * **[related] API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``.
451 .. _nic_features_flow_control:
456 Supports configuring link flow control.
458 * **[implements] eth_dev_ops**: ``flow_ctrl_get``, ``flow_ctrl_set``,
459 ``priority_flow_ctrl_set``.
460 * **[related] API**: ``rte_eth_dev_flow_ctrl_get()``, ``rte_eth_dev_flow_ctrl_set()``,
461 ``rte_eth_dev_priority_flow_ctrl_set()``.
464 .. _nic_features_flow_api:
469 Supports the DPDK Flow API for generic filtering.
471 * **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_GENERIC``.
472 * **[implements] rte_flow_ops**: ``All``.
475 .. _nic_features_rate_limitation:
480 Supports Tx rate limitation for a queue.
482 * **[implements] eth_dev_ops**: ``set_queue_rate_limit``.
483 * **[related] API**: ``rte_eth_set_queue_rate_limit()``.
486 .. _nic_features_traffic_mirroring:
491 Supports adding traffic mirroring rules.
493 * **[implements] eth_dev_ops**: ``mirror_rule_set``, ``mirror_rule_reset``.
494 * **[related] API**: ``rte_eth_mirror_rule_set()``, ``rte_eth_mirror_rule_reset()``.
497 .. _nic_features_crc_offload:
502 Supports CRC stripping by hardware.
504 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_CRC_STRIP``.
507 .. _nic_features_vlan_offload:
512 Supports VLAN offload to hardware.
514 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_VLAN_STRIP,DEV_RX_OFFLOAD_VLAN_FILTER,DEV_RX_OFFLOAD_VLAN_EXTEND``.
515 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_VLAN_INSERT``.
516 * **[implements] eth_dev_ops**: ``vlan_offload_set``.
517 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_VLAN_STRIPPED``, ``mbuf.vlan_tci``.
518 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_VLAN_STRIP``,
519 ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_VLAN_INSERT``.
520 * **[related] API**: ``rte_eth_dev_set_vlan_offload()``,
521 ``rte_eth_dev_get_vlan_offload()``.
524 .. _nic_features_qinq_offload:
529 Supports QinQ (queue in queue) offload.
531 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_QINQ_STRIP``.
532 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_QINQ_INSERT``.
533 * **[uses] mbuf**: ``mbuf.ol_flags:PKT_TX_QINQ_PKT``.
534 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_QINQ_STRIPPED``, ``mbuf.vlan_tci``,
535 ``mbuf.vlan_tci_outer``.
536 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_QINQ_STRIP``,
537 ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_QINQ_INSERT``.
540 .. _nic_features_l3_checksum_offload:
545 Supports L3 checksum offload.
547 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_IPV4_CKSUM``.
548 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_IPV4_CKSUM``.
549 * **[uses] mbuf**: ``mbuf.ol_flags:PKT_TX_IP_CKSUM``,
550 ``mbuf.ol_flags:PKT_TX_IPV4`` | ``PKT_TX_IPV6``.
551 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_IP_CKSUM_UNKNOWN`` |
552 ``PKT_RX_IP_CKSUM_BAD`` | ``PKT_RX_IP_CKSUM_GOOD`` |
553 ``PKT_RX_IP_CKSUM_NONE``.
554 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_IPV4_CKSUM``,
555 ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_IPV4_CKSUM``.
558 .. _nic_features_l4_checksum_offload:
563 Supports L4 checksum offload.
565 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_UDP_CKSUM,DEV_RX_OFFLOAD_TCP_CKSUM``.
566 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_UDP_CKSUM,DEV_TX_OFFLOAD_TCP_CKSUM,DEV_TX_OFFLOAD_SCTP_CKSUM``.
567 * **[uses] user config**: ``dev_conf.rxmode.hw_ip_checksum``.
568 * **[uses] mbuf**: ``mbuf.ol_flags:PKT_TX_IPV4`` | ``PKT_TX_IPV6``,
569 ``mbuf.ol_flags:PKT_TX_L4_NO_CKSUM`` | ``PKT_TX_TCP_CKSUM`` |
570 ``PKT_TX_SCTP_CKSUM`` | ``PKT_TX_UDP_CKSUM``.
571 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_L4_CKSUM_UNKNOWN`` |
572 ``PKT_RX_L4_CKSUM_BAD`` | ``PKT_RX_L4_CKSUM_GOOD`` |
573 ``PKT_RX_L4_CKSUM_NONE``.
574 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_UDP_CKSUM,DEV_RX_OFFLOAD_TCP_CKSUM``,
575 ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_UDP_CKSUM,DEV_TX_OFFLOAD_TCP_CKSUM,DEV_TX_OFFLOAD_SCTP_CKSUM``.
578 .. _nic_features_macsec_offload:
585 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_MACSEC_STRIP``.
586 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_MACSEC_INSERT``.
587 * **[uses] mbuf**: ``mbuf.ol_flags:PKT_TX_MACSEC``.
588 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_MACSEC_STRIP``,
589 ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_MACSEC_INSERT``.
592 .. _nic_features_inner_l3_checksum:
597 Supports inner packet L3 checksum.
599 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM``.
600 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM``.
601 * **[uses] mbuf**: ``mbuf.ol_flags:PKT_TX_IP_CKSUM``,
602 ``mbuf.ol_flags:PKT_TX_IPV4`` | ``PKT_TX_IPV6``,
603 ``mbuf.ol_flags:PKT_TX_OUTER_IP_CKSUM``,
604 ``mbuf.ol_flags:PKT_TX_OUTER_IPV4`` | ``PKT_TX_OUTER_IPV6``.
605 * **[uses] mbuf**: ``mbuf.outer_l2_len``, ``mbuf.outer_l3_len``.
606 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_EIP_CKSUM_BAD``.
607 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM``,
608 ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM``.
611 .. _nic_features_inner_l4_checksum:
616 Supports inner packet L4 checksum.
619 .. _nic_features_packet_type_parsing:
624 Supports packet type parsing and returns a list of supported types.
626 * **[implements] eth_dev_ops**: ``dev_supported_ptypes_get``.
627 * **[related] API**: ``rte_eth_dev_get_supported_ptypes()``.
630 .. _nic_features_timesync:
635 Supports optimization for fast release of mbufs following successful Tx.
636 Requires that per queue, all mbufs come from the same mempool and has refcnt = 1.
638 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_MBUF_FAST_FREE``.
639 * **[provides] rte_eth_dev_info**: ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_MBUF_FAST_FREE``.
644 Supports IEEE1588/802.1AS timestamping.
646 * **[implements] eth_dev_ops**: ``timesync_enable``, ``timesync_disable``
647 ``timesync_read_rx_timestamp``, ``timesync_read_tx_timestamp``,
648 ``timesync_adjust_time``, ``timesync_read_time``, ``timesync_write_time``.
649 * **[related] API**: ``rte_eth_timesync_enable()``, ``rte_eth_timesync_disable()``,
650 ``rte_eth_timesync_read_rx_timestamp()``,
651 ``rte_eth_timesync_read_tx_timestamp``, ``rte_eth_timesync_adjust_time()``,
652 ``rte_eth_timesync_read_time()``, ``rte_eth_timesync_write_time()``.
655 .. _nic_features_rx_descriptor_status:
660 Supports check the status of a Rx descriptor. When ``rx_descriptor_status`` is
661 used, status can be "Available", "Done" or "Unavailable". When
662 ``rx_descriptor_done`` is used, status can be "DD bit is set" or "DD bit is
665 * **[implements] eth_dev_ops**: ``rx_descriptor_status``.
666 * **[related] API**: ``rte_eth_rx_descriptor_status()``.
667 * **[implements] eth_dev_ops**: ``rx_descriptor_done``.
668 * **[related] API**: ``rte_eth_rx_descriptor_done()``.
671 .. _nic_features_tx_descriptor_status:
676 Supports checking the status of a Tx descriptor. Status can be "Full", "Done"
679 * **[implements] eth_dev_ops**: ``tx_descriptor_status``.
680 * **[related] API**: ``rte_eth_tx_descriptor_status()``.
683 .. _nic_features_basic_stats:
688 Support basic statistics such as: ipackets, opackets, ibytes, obytes,
689 imissed, ierrors, oerrors, rx_nombuf.
691 And per queue stats: q_ipackets, q_opackets, q_ibytes, q_obytes, q_errors.
693 These apply to all drivers.
695 * **[implements] eth_dev_ops**: ``stats_get``, ``stats_reset``.
696 * **[related] API**: ``rte_eth_stats_get``, ``rte_eth_stats_reset()``.
699 .. _nic_features_extended_stats:
704 Supports Extended Statistics, changes from driver to driver.
706 * **[implements] eth_dev_ops**: ``xstats_get``, ``xstats_reset``, ``xstats_get_names``.
707 * **[implements] eth_dev_ops**: ``xstats_get_by_id``, ``xstats_get_names_by_id``.
708 * **[related] API**: ``rte_eth_xstats_get()``, ``rte_eth_xstats_reset()``,
709 ``rte_eth_xstats_get_names``, ``rte_eth_xstats_get_by_id()``,
710 ``rte_eth_xstats_get_names_by_id()``, ``rte_eth_xstats_get_id_by_name()``.
713 .. _nic_features_stats_per_queue:
718 Supports configuring per-queue stat counter mapping.
720 * **[implements] eth_dev_ops**: ``queue_stats_mapping_set``.
721 * **[related] API**: ``rte_eth_dev_set_rx_queue_stats_mapping()``,
722 ``rte_eth_dev_set_tx_queue_stats_mapping()``.
725 .. _nic_features_fw_version:
730 Supports getting device hardware firmware information.
732 * **[implements] eth_dev_ops**: ``fw_version_get``.
733 * **[related] API**: ``rte_eth_dev_fw_version_get()``.
736 .. _nic_features_eeprom_dump:
741 Supports getting/setting device eeprom data.
743 * **[implements] eth_dev_ops**: ``get_eeprom_length``, ``get_eeprom``, ``set_eeprom``.
744 * **[related] API**: ``rte_eth_dev_get_eeprom_length()``, ``rte_eth_dev_get_eeprom()``,
745 ``rte_eth_dev_set_eeprom()``.
748 .. _nic_features_register_dump:
753 Supports retrieving device registers and registering attributes (number of
754 registers and register size).
756 * **[implements] eth_dev_ops**: ``get_reg``.
757 * **[related] API**: ``rte_eth_dev_get_reg_info()``.
760 .. _nic_features_led:
765 Supports turning on/off a software controllable LED on a device.
767 * **[implements] eth_dev_ops**: ``dev_led_on``, ``dev_led_off``.
768 * **[related] API**: ``rte_eth_led_on()``, ``rte_eth_led_off()``.
771 .. _nic_features_multiprocess_aware:
776 Driver can be used for primary-secondary process model.
779 .. _nic_features_bsd_nic_uio:
784 BSD ``nic_uio`` module supported.
787 .. _nic_features_linux_uio:
792 Works with ``igb_uio`` kernel module.
794 * **[provides] RTE_PMD_REGISTER_KMOD_DEP**: ``igb_uio``.
796 .. _nic_features_linux_vfio:
801 Works with ``vfio-pci`` kernel module.
803 * **[provides] RTE_PMD_REGISTER_KMOD_DEP**: ``vfio-pci``.
805 .. _nic_features_other_kdrv:
810 Kernel module other than above ones supported.
813 .. _nic_features_armv7:
818 Support armv7 architecture.
820 Use ``defconfig_arm-armv7a-*-*``.
823 .. _nic_features_armv8:
828 Support armv8a (64bit) architecture.
830 Use ``defconfig_arm64-armv8a-*-*``
833 .. _nic_features_power8:
838 Support PowerPC architecture.
840 Use ``defconfig_ppc_64-power8-*-*``
842 .. _nic_features_x86-32:
847 Support 32bits x86 architecture.
849 Use ``defconfig_x86_x32-native-*-*`` and ``defconfig_i686-native-*-*``.
852 .. _nic_features_x86-64:
857 Support 64bits x86 architecture.
859 Use ``defconfig_x86_64-native-*-*``.
862 .. _nic_features_usage_doc:
867 Documentation describes usage.
869 See ``doc/guides/nics/*.rst``
872 .. _nic_features_design_doc:
877 Documentation describes design.
879 See ``doc/guides/nics/*.rst``.
882 .. _nic_features_perf_doc:
887 Documentation describes performance values.
889 See ``dpdk.org/doc/perf/*``.
893 .. _nic_features_other:
895 Other dev ops not represented by a Feature
896 ------------------------------------------
901 * ``vlan_strip_queue_set``
904 * ``l2_tunnel_offload_set``
905 * ``uc_hash_table_set``
906 * ``uc_all_hash_table_set``
907 * ``udp_tunnel_port_add``
908 * ``udp_tunnel_port_del``
909 * ``l2_tunnel_eth_type_conf``
910 * ``l2_tunnel_offload_set``