1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2017 Intel Corporation.
7 This section explains the supported features that are listed in the
10 As a guide to implementers it also shows the structs where the features are
11 defined and the APIs that can be use to get/set the values.
13 Following tags used for feature details, these are from driver point of view:
15 ``[uses]`` : Driver uses some kind of input from the application.
17 ``[implements]`` : Driver implements a functionality.
19 ``[provides]`` : Driver provides some kind of data to the application. It is possible
20 to provide data by implementing some function, but "provides" is used
21 for cases where provided data can't be represented simply by a function.
23 ``[related]`` : Related API with that feature.
26 .. _nic_features_speed_capabilities:
31 Supports getting the speed capabilities that the current device is capable of.
33 * **[provides] rte_eth_dev_info**: ``speed_capa:ETH_LINK_SPEED_*``.
34 * **[related] API**: ``rte_eth_dev_info_get()``.
37 .. _nic_features_link_status:
42 Supports getting the link speed, duplex mode and link state (up/down).
44 * **[implements] eth_dev_ops**: ``link_update``.
45 * **[implements] rte_eth_dev_data**: ``dev_link``.
46 * **[related] API**: ``rte_eth_link_get()``, ``rte_eth_link_get_nowait()``.
49 .. _nic_features_link_status_event:
54 Supports Link Status Change interrupts.
56 * **[uses] user config**: ``dev_conf.intr_conf.lsc``.
57 * **[uses] rte_eth_dev_data**: ``dev_flags:RTE_ETH_DEV_INTR_LSC``.
58 * **[uses] rte_eth_event_type**: ``RTE_ETH_EVENT_INTR_LSC``.
59 * **[implements] rte_eth_dev_data**: ``dev_link``.
60 * **[provides] rte_pci_driver.drv_flags**: ``RTE_PCI_DRV_INTR_LSC``.
61 * **[related] API**: ``rte_eth_link_get()``, ``rte_eth_link_get_nowait()``.
64 .. _nic_features_removal_event:
69 Supports device removal interrupts.
71 * **[uses] user config**: ``dev_conf.intr_conf.rmv``.
72 * **[uses] rte_eth_dev_data**: ``dev_flags:RTE_ETH_DEV_INTR_RMV``.
73 * **[uses] rte_eth_event_type**: ``RTE_ETH_EVENT_INTR_RMV``.
74 * **[provides] rte_pci_driver.drv_flags**: ``RTE_PCI_DRV_INTR_RMV``.
77 .. _nic_features_queue_status_event:
82 Supports queue enable/disable events.
84 * **[uses] rte_eth_event_type**: ``RTE_ETH_EVENT_QUEUE_STATE``.
87 .. _nic_features_rx_interrupt:
92 Supports Rx interrupts.
94 * **[uses] user config**: ``dev_conf.intr_conf.rxq``.
95 * **[implements] eth_dev_ops**: ``rx_queue_intr_enable``, ``rx_queue_intr_disable``.
96 * **[related] API**: ``rte_eth_dev_rx_intr_enable()``, ``rte_eth_dev_rx_intr_disable()``.
99 .. _nic_features_lock-free_tx_queue:
104 If a PMD advertises DEV_TX_OFFLOAD_MT_LOCKFREE capable, multiple threads can
105 invoke rte_eth_tx_burst() concurrently on the same Tx queue without SW lock.
107 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_MT_LOCKFREE``.
108 * **[provides] rte_eth_dev_info**: ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_MT_LOCKFREE``.
109 * **[related] API**: ``rte_eth_tx_burst()``.
112 .. _nic_features_fast_mbuf_free:
117 Supports optimization for fast release of mbufs following successful Tx.
118 Requires that per queue, all mbufs come from the same mempool and has refcnt = 1.
120 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_MBUF_FAST_FREE``.
121 * **[provides] rte_eth_dev_info**: ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_MBUF_FAST_FREE``.
124 .. _nic_features_free_tx_mbuf_on_demand:
126 Free Tx mbuf on demand
127 ----------------------
129 Supports freeing consumed buffers on a Tx ring.
131 * **[implements] eth_dev_ops**: ``tx_done_cleanup``.
132 * **[related] API**: ``rte_eth_tx_done_cleanup()``.
135 .. _nic_features_queue_start_stop:
140 Supports starting/stopping a specific Rx/Tx queue of a port.
142 * **[implements] eth_dev_ops**: ``rx_queue_start``, ``rx_queue_stop``, ``tx_queue_start``,
144 * **[related] API**: ``rte_eth_dev_rx_queue_start()``, ``rte_eth_dev_rx_queue_stop()``,
145 ``rte_eth_dev_tx_queue_start()``, ``rte_eth_dev_tx_queue_stop()``.
148 .. _nic_features_mtu_update:
153 Supports updating port MTU.
155 * **[implements] eth_dev_ops**: ``mtu_set``.
156 * **[implements] rte_eth_dev_data**: ``mtu``.
157 * **[provides] rte_eth_dev_info**: ``max_rx_pktlen``.
158 * **[related] API**: ``rte_eth_dev_set_mtu()``, ``rte_eth_dev_get_mtu()``.
161 .. _nic_features_jumbo_frame:
166 Supports Rx jumbo frames.
168 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_JUMBO_FRAME``.
169 ``dev_conf.rxmode.max_rx_pkt_len``.
170 * **[related] rte_eth_dev_info**: ``max_rx_pktlen``.
171 * **[related] API**: ``rte_eth_dev_set_mtu()``.
174 .. _nic_features_scattered_rx:
179 Supports receiving segmented mbufs.
181 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_SCATTER``.
182 * **[implements] datapath**: ``Scattered Rx function``.
183 * **[implements] rte_eth_dev_data**: ``scattered_rx``.
184 * **[provides] eth_dev_ops**: ``rxq_info_get:scattered_rx``.
185 * **[related] eth_dev_ops**: ``rx_pkt_burst``.
188 .. _nic_features_lro:
193 Supports Large Receive Offload.
195 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_TCP_LRO``.
196 * **[implements] datapath**: ``LRO functionality``.
197 * **[implements] rte_eth_dev_data**: ``lro``.
198 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_LRO``, ``mbuf.tso_segsz``.
199 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_TCP_LRO``.
202 .. _nic_features_tso:
207 Supports TCP Segmentation Offloading.
209 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_TCP_TSO``.
210 * **[uses] rte_eth_desc_lim**: ``nb_seg_max``, ``nb_mtu_seg_max``.
211 * **[uses] mbuf**: ``mbuf.ol_flags:PKT_TX_TCP_SEG``.
212 * **[uses] mbuf**: ``mbuf.tso_segsz``, ``mbuf.l2_len``, ``mbuf.l3_len``, ``mbuf.l4_len``.
213 * **[implements] datapath**: ``TSO functionality``.
214 * **[provides] rte_eth_dev_info**: ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_TCP_TSO,DEV_TX_OFFLOAD_UDP_TSO``.
217 .. _nic_features_promiscuous_mode:
222 Supports enabling/disabling promiscuous mode for a port.
224 * **[implements] eth_dev_ops**: ``promiscuous_enable``, ``promiscuous_disable``.
225 * **[implements] rte_eth_dev_data**: ``promiscuous``.
226 * **[related] API**: ``rte_eth_promiscuous_enable()``, ``rte_eth_promiscuous_disable()``,
227 ``rte_eth_promiscuous_get()``.
230 .. _nic_features_allmulticast_mode:
235 Supports enabling/disabling receiving multicast frames.
237 * **[implements] eth_dev_ops**: ``allmulticast_enable``, ``allmulticast_disable``.
238 * **[implements] rte_eth_dev_data**: ``all_multicast``.
239 * **[related] API**: ``rte_eth_allmulticast_enable()``,
240 ``rte_eth_allmulticast_disable()``, ``rte_eth_allmulticast_get()``.
243 .. _nic_features_unicast_mac_filter:
248 Supports adding MAC addresses to enable whitelist filtering to accept packets.
250 * **[implements] eth_dev_ops**: ``mac_addr_set``, ``mac_addr_add``, ``mac_addr_remove``.
251 * **[implements] rte_eth_dev_data**: ``mac_addrs``.
252 * **[related] API**: ``rte_eth_dev_default_mac_addr_set()``,
253 ``rte_eth_dev_mac_addr_add()``, ``rte_eth_dev_mac_addr_remove()``,
254 ``rte_eth_macaddr_get()``.
257 .. _nic_features_multicast_mac_filter:
262 Supports setting multicast addresses to filter.
264 * **[implements] eth_dev_ops**: ``set_mc_addr_list``.
265 * **[related] API**: ``rte_eth_dev_set_mc_addr_list()``.
268 .. _nic_features_rss_hash:
273 Supports RSS hashing on RX.
275 * **[uses] user config**: ``dev_conf.rxmode.mq_mode`` = ``ETH_MQ_RX_RSS_FLAG``.
276 * **[uses] user config**: ``dev_conf.rx_adv_conf.rss_conf``.
277 * **[provides] rte_eth_dev_info**: ``flow_type_rss_offloads``.
278 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_RSS_HASH``, ``mbuf.rss``.
281 .. _nic_features_rss_key_update:
286 Supports configuration of Receive Side Scaling (RSS) hash computation. Updating
287 Receive Side Scaling (RSS) hash key.
289 * **[implements] eth_dev_ops**: ``rss_hash_update``, ``rss_hash_conf_get``.
290 * **[provides] rte_eth_dev_info**: ``hash_key_size``.
291 * **[related] API**: ``rte_eth_dev_rss_hash_update()``,
292 ``rte_eth_dev_rss_hash_conf_get()``.
295 .. _nic_features_rss_reta_update:
300 Supports updating Redirection Table of the Receive Side Scaling (RSS).
302 * **[implements] eth_dev_ops**: ``reta_update``, ``reta_query``.
303 * **[provides] rte_eth_dev_info**: ``reta_size``.
304 * **[related] API**: ``rte_eth_dev_rss_reta_update()``, ``rte_eth_dev_rss_reta_query()``.
307 .. _nic_features_vmdq:
312 Supports Virtual Machine Device Queues (VMDq).
314 * **[uses] user config**: ``dev_conf.rxmode.mq_mode`` = ``ETH_MQ_RX_VMDQ_FLAG``.
315 * **[uses] user config**: ``dev_conf.rx_adv_conf.vmdq_dcb_conf``.
316 * **[uses] user config**: ``dev_conf.rx_adv_conf.vmdq_rx_conf``.
317 * **[uses] user config**: ``dev_conf.tx_adv_conf.vmdq_dcb_tx_conf``.
318 * **[uses] user config**: ``dev_conf.tx_adv_conf.vmdq_tx_conf``.
321 .. _nic_features_sriov:
326 Driver supports creating Virtual Functions.
328 * **[implements] rte_eth_dev_data**: ``sriov``.
330 .. _nic_features_dcb:
335 Supports Data Center Bridging (DCB).
337 * **[uses] user config**: ``dev_conf.rxmode.mq_mode`` = ``ETH_MQ_RX_DCB_FLAG``.
338 * **[uses] user config**: ``dev_conf.rx_adv_conf.vmdq_dcb_conf``.
339 * **[uses] user config**: ``dev_conf.rx_adv_conf.dcb_rx_conf``.
340 * **[uses] user config**: ``dev_conf.tx_adv_conf.vmdq_dcb_tx_conf``.
341 * **[uses] user config**: ``dev_conf.tx_adv_conf.vmdq_tx_conf``.
342 * **[implements] eth_dev_ops**: ``get_dcb_info``.
343 * **[related] API**: ``rte_eth_dev_get_dcb_info()``.
346 .. _nic_features_vlan_filter:
351 Supports filtering of a VLAN Tag identifier.
353 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_VLAN_FILTER``.
354 * **[implements] eth_dev_ops**: ``vlan_filter_set``.
355 * **[related] API**: ``rte_eth_dev_vlan_filter()``.
358 .. _nic_features_ethertype_filter:
363 Supports filtering on Ethernet type.
365 * **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_ETHERTYPE``.
366 * **[related] API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``.
368 .. _nic_features_ntuple_filter:
373 Supports filtering on N-tuple values.
375 * **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_NTUPLE``.
376 * **[related] API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``.
379 .. _nic_features_syn_filter:
384 Supports TCP syn filtering.
386 * **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_SYN``.
387 * **[related] API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``.
390 .. _nic_features_tunnel_filter:
395 Supports tunnel filtering.
397 * **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_TUNNEL``.
398 * **[related] API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``.
401 .. _nic_features_flexible_filter:
406 Supports a flexible (non-tuple or Ethertype) filter.
408 * **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_FLEXIBLE``.
409 * **[related] API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``.
412 .. _nic_features_hash_filter:
417 Supports Hash filtering.
419 * **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_HASH``.
420 * **[related] API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``.
423 .. _nic_features_flow_director:
428 Supports Flow Director style filtering to queues.
430 * **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_FDIR``.
431 * **[provides] mbuf**: ``mbuf.ol_flags:`` ``PKT_RX_FDIR``, ``PKT_RX_FDIR_ID``,
433 * **[related] API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``.
436 .. _nic_features_flow_control:
441 Supports configuring link flow control.
443 * **[implements] eth_dev_ops**: ``flow_ctrl_get``, ``flow_ctrl_set``,
444 ``priority_flow_ctrl_set``.
445 * **[related] API**: ``rte_eth_dev_flow_ctrl_get()``, ``rte_eth_dev_flow_ctrl_set()``,
446 ``rte_eth_dev_priority_flow_ctrl_set()``.
449 .. _nic_features_flow_api:
454 Supports the DPDK Flow API for generic filtering.
456 * **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_GENERIC``.
457 * **[implements] rte_flow_ops**: ``All``.
460 .. _nic_features_rate_limitation:
465 Supports Tx rate limitation for a queue.
467 * **[implements] eth_dev_ops**: ``set_queue_rate_limit``.
468 * **[related] API**: ``rte_eth_set_queue_rate_limit()``.
471 .. _nic_features_traffic_mirroring:
476 Supports adding traffic mirroring rules.
478 * **[implements] eth_dev_ops**: ``mirror_rule_set``, ``mirror_rule_reset``.
479 * **[related] API**: ``rte_eth_mirror_rule_set()``, ``rte_eth_mirror_rule_reset()``.
482 .. _nic_features_inline_crypto_doc:
487 Supports inline crypto processing (eg. inline IPsec). See Security library and PMD documentation for more details.
489 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_SECURITY``,
490 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_SECURITY``.
491 * **[implements] rte_security_ops**: ``session_create``, ``session_update``,
492 ``session_stats_get``, ``session_destroy``, ``set_pkt_metadata``, ``capabilities_get``.
493 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_SECURITY``,
494 ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_SECURITY``.
495 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_SEC_OFFLOAD``,
496 ``mbuf.ol_flags:PKT_TX_SEC_OFFLOAD``, ``mbuf.ol_flags:PKT_RX_SEC_OFFLOAD_FAILED``.
499 .. _nic_features_crc_offload:
504 Supports CRC stripping by hardware.
506 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_CRC_STRIP``.
509 .. _nic_features_vlan_offload:
514 Supports VLAN offload to hardware.
516 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_VLAN_STRIP,DEV_RX_OFFLOAD_VLAN_FILTER,DEV_RX_OFFLOAD_VLAN_EXTEND``.
517 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_VLAN_INSERT``.
518 * **[implements] eth_dev_ops**: ``vlan_offload_set``.
519 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_VLAN_STRIPPED``, ``mbuf.vlan_tci``.
520 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_VLAN_STRIP``,
521 ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_VLAN_INSERT``.
522 * **[related] API**: ``rte_eth_dev_set_vlan_offload()``,
523 ``rte_eth_dev_get_vlan_offload()``.
526 .. _nic_features_qinq_offload:
531 Supports QinQ (queue in queue) offload.
533 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_QINQ_STRIP``.
534 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_QINQ_INSERT``.
535 * **[uses] mbuf**: ``mbuf.ol_flags:PKT_TX_QINQ_PKT``.
536 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_QINQ_STRIPPED``, ``mbuf.vlan_tci``,
537 ``mbuf.vlan_tci_outer``.
538 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_QINQ_STRIP``,
539 ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_QINQ_INSERT``.
542 .. _nic_features_l3_checksum_offload:
547 Supports L3 checksum offload.
549 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_IPV4_CKSUM``.
550 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_IPV4_CKSUM``.
551 * **[uses] mbuf**: ``mbuf.ol_flags:PKT_TX_IP_CKSUM``,
552 ``mbuf.ol_flags:PKT_TX_IPV4`` | ``PKT_TX_IPV6``.
553 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_IP_CKSUM_UNKNOWN`` |
554 ``PKT_RX_IP_CKSUM_BAD`` | ``PKT_RX_IP_CKSUM_GOOD`` |
555 ``PKT_RX_IP_CKSUM_NONE``.
556 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_IPV4_CKSUM``,
557 ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_IPV4_CKSUM``.
560 .. _nic_features_l4_checksum_offload:
565 Supports L4 checksum offload.
567 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_UDP_CKSUM,DEV_RX_OFFLOAD_TCP_CKSUM``.
568 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_UDP_CKSUM,DEV_TX_OFFLOAD_TCP_CKSUM,DEV_TX_OFFLOAD_SCTP_CKSUM``.
569 * **[uses] user config**: ``dev_conf.rxmode.hw_ip_checksum``.
570 * **[uses] mbuf**: ``mbuf.ol_flags:PKT_TX_IPV4`` | ``PKT_TX_IPV6``,
571 ``mbuf.ol_flags:PKT_TX_L4_NO_CKSUM`` | ``PKT_TX_TCP_CKSUM`` |
572 ``PKT_TX_SCTP_CKSUM`` | ``PKT_TX_UDP_CKSUM``.
573 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_L4_CKSUM_UNKNOWN`` |
574 ``PKT_RX_L4_CKSUM_BAD`` | ``PKT_RX_L4_CKSUM_GOOD`` |
575 ``PKT_RX_L4_CKSUM_NONE``.
576 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_UDP_CKSUM,DEV_RX_OFFLOAD_TCP_CKSUM``,
577 ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_UDP_CKSUM,DEV_TX_OFFLOAD_TCP_CKSUM,DEV_TX_OFFLOAD_SCTP_CKSUM``.
579 .. _nic_features_hw_timestamp:
586 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_TIMESTAMP``.
587 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_TIMESTAMP``.
588 * **[provides] mbuf**: ``mbuf.timestamp``.
589 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa: DEV_RX_OFFLOAD_TIMESTAMP``.
591 .. _nic_features_macsec_offload:
598 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_MACSEC_STRIP``.
599 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_MACSEC_INSERT``.
600 * **[uses] mbuf**: ``mbuf.ol_flags:PKT_TX_MACSEC``.
601 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_MACSEC_STRIP``,
602 ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_MACSEC_INSERT``.
605 .. _nic_features_inner_l3_checksum:
610 Supports inner packet L3 checksum.
612 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM``.
613 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM``.
614 * **[uses] mbuf**: ``mbuf.ol_flags:PKT_TX_IP_CKSUM``,
615 ``mbuf.ol_flags:PKT_TX_IPV4`` | ``PKT_TX_IPV6``,
616 ``mbuf.ol_flags:PKT_TX_OUTER_IP_CKSUM``,
617 ``mbuf.ol_flags:PKT_TX_OUTER_IPV4`` | ``PKT_TX_OUTER_IPV6``.
618 * **[uses] mbuf**: ``mbuf.outer_l2_len``, ``mbuf.outer_l3_len``.
619 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_EIP_CKSUM_BAD``.
620 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM``,
621 ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM``.
624 .. _nic_features_inner_l4_checksum:
629 Supports inner packet L4 checksum.
632 .. _nic_features_packet_type_parsing:
637 Supports packet type parsing and returns a list of supported types.
639 * **[implements] eth_dev_ops**: ``dev_supported_ptypes_get``.
640 * **[related] API**: ``rte_eth_dev_get_supported_ptypes()``.
643 .. _nic_features_timesync:
648 Supports IEEE1588/802.1AS timestamping.
650 * **[implements] eth_dev_ops**: ``timesync_enable``, ``timesync_disable``
651 ``timesync_read_rx_timestamp``, ``timesync_read_tx_timestamp``,
652 ``timesync_adjust_time``, ``timesync_read_time``, ``timesync_write_time``.
653 * **[related] API**: ``rte_eth_timesync_enable()``, ``rte_eth_timesync_disable()``,
654 ``rte_eth_timesync_read_rx_timestamp()``,
655 ``rte_eth_timesync_read_tx_timestamp``, ``rte_eth_timesync_adjust_time()``,
656 ``rte_eth_timesync_read_time()``, ``rte_eth_timesync_write_time()``.
659 .. _nic_features_rx_descriptor_status:
664 Supports check the status of a Rx descriptor. When ``rx_descriptor_status`` is
665 used, status can be "Available", "Done" or "Unavailable". When
666 ``rx_descriptor_done`` is used, status can be "DD bit is set" or "DD bit is
669 * **[implements] eth_dev_ops**: ``rx_descriptor_status``.
670 * **[related] API**: ``rte_eth_rx_descriptor_status()``.
671 * **[implements] eth_dev_ops**: ``rx_descriptor_done``.
672 * **[related] API**: ``rte_eth_rx_descriptor_done()``.
675 .. _nic_features_tx_descriptor_status:
680 Supports checking the status of a Tx descriptor. Status can be "Full", "Done"
683 * **[implements] eth_dev_ops**: ``tx_descriptor_status``.
684 * **[related] API**: ``rte_eth_tx_descriptor_status()``.
687 .. _nic_features_basic_stats:
692 Support basic statistics such as: ipackets, opackets, ibytes, obytes,
693 imissed, ierrors, oerrors, rx_nombuf.
695 And per queue stats: q_ipackets, q_opackets, q_ibytes, q_obytes, q_errors.
697 These apply to all drivers.
699 * **[implements] eth_dev_ops**: ``stats_get``, ``stats_reset``.
700 * **[related] API**: ``rte_eth_stats_get``, ``rte_eth_stats_reset()``.
703 .. _nic_features_extended_stats:
708 Supports Extended Statistics, changes from driver to driver.
710 * **[implements] eth_dev_ops**: ``xstats_get``, ``xstats_reset``, ``xstats_get_names``.
711 * **[implements] eth_dev_ops**: ``xstats_get_by_id``, ``xstats_get_names_by_id``.
712 * **[related] API**: ``rte_eth_xstats_get()``, ``rte_eth_xstats_reset()``,
713 ``rte_eth_xstats_get_names``, ``rte_eth_xstats_get_by_id()``,
714 ``rte_eth_xstats_get_names_by_id()``, ``rte_eth_xstats_get_id_by_name()``.
717 .. _nic_features_stats_per_queue:
722 Supports configuring per-queue stat counter mapping.
724 * **[implements] eth_dev_ops**: ``queue_stats_mapping_set``.
725 * **[related] API**: ``rte_eth_dev_set_rx_queue_stats_mapping()``,
726 ``rte_eth_dev_set_tx_queue_stats_mapping()``.
729 .. _nic_features_fw_version:
734 Supports getting device hardware firmware information.
736 * **[implements] eth_dev_ops**: ``fw_version_get``.
737 * **[related] API**: ``rte_eth_dev_fw_version_get()``.
740 .. _nic_features_eeprom_dump:
745 Supports getting/setting device eeprom data.
747 * **[implements] eth_dev_ops**: ``get_eeprom_length``, ``get_eeprom``, ``set_eeprom``.
748 * **[related] API**: ``rte_eth_dev_get_eeprom_length()``, ``rte_eth_dev_get_eeprom()``,
749 ``rte_eth_dev_set_eeprom()``.
752 .. _nic_features_module_eeprom_dump:
757 Supports getting information and data of plugin module eeprom.
759 * **[implements] eth_dev_ops**: ``get_module_info``, ``get_module_eeprom``.
760 * **[related] API**: ``rte_eth_dev_get_module_info()``, ``rte_eth_dev_get_module_eeprom()``.
763 .. _nic_features_register_dump:
768 Supports retrieving device registers and registering attributes (number of
769 registers and register size).
771 * **[implements] eth_dev_ops**: ``get_reg``.
772 * **[related] API**: ``rte_eth_dev_get_reg_info()``.
775 .. _nic_features_led:
780 Supports turning on/off a software controllable LED on a device.
782 * **[implements] eth_dev_ops**: ``dev_led_on``, ``dev_led_off``.
783 * **[related] API**: ``rte_eth_led_on()``, ``rte_eth_led_off()``.
786 .. _nic_features_multiprocess_aware:
791 Driver can be used for primary-secondary process model.
794 .. _nic_features_bsd_nic_uio:
799 BSD ``nic_uio`` module supported.
802 .. _nic_features_linux_uio:
807 Works with ``igb_uio`` kernel module.
809 * **[provides] RTE_PMD_REGISTER_KMOD_DEP**: ``igb_uio``.
811 .. _nic_features_linux_vfio:
816 Works with ``vfio-pci`` kernel module.
818 * **[provides] RTE_PMD_REGISTER_KMOD_DEP**: ``vfio-pci``.
820 .. _nic_features_other_kdrv:
825 Kernel module other than above ones supported.
828 .. _nic_features_armv7:
833 Support armv7 architecture.
835 Use ``defconfig_arm-armv7a-*-*``.
838 .. _nic_features_armv8:
843 Support armv8a (64bit) architecture.
845 Use ``defconfig_arm64-armv8a-*-*``
848 .. _nic_features_power8:
853 Support PowerPC architecture.
855 Use ``defconfig_ppc_64-power8-*-*``
857 .. _nic_features_x86-32:
862 Support 32bits x86 architecture.
864 Use ``defconfig_x86_x32-native-*-*`` and ``defconfig_i686-native-*-*``.
867 .. _nic_features_x86-64:
872 Support 64bits x86 architecture.
874 Use ``defconfig_x86_64-native-*-*``.
877 .. _nic_features_usage_doc:
882 Documentation describes usage.
884 See ``doc/guides/nics/*.rst``
887 .. _nic_features_design_doc:
892 Documentation describes design.
894 See ``doc/guides/nics/*.rst``.
897 .. _nic_features_perf_doc:
902 Documentation describes performance values.
904 See ``dpdk.org/doc/perf/*``.
906 .. _nic_features_runtime_rx_queue_setup:
908 Runtime Rx queue setup
909 ----------------------
911 Supports Rx queue setup after device started.
913 * **[provides] rte_eth_dev_info**: ``dev_capa:RTE_ETH_DEV_CAPA_RUNTIME_RX_QUEUE_SETUP``.
914 * **[related] API**: ``rte_eth_dev_info_get()``.
916 .. _nic_features_runtime_tx_queue_setup:
918 Runtime Tx queue setup
919 ----------------------
921 Supports Tx queue setup after device started.
923 * **[provides] rte_eth_dev_info**: ``dev_capa:RTE_ETH_DEV_CAPA_RUNTIME_TX_QUEUE_SETUP``.
924 * **[related] API**: ``rte_eth_dev_info_get()``.
926 .. _nic_features_other:
928 Other dev ops not represented by a Feature
929 ------------------------------------------
934 * ``vlan_strip_queue_set``
937 * ``l2_tunnel_offload_set``
938 * ``uc_hash_table_set``
939 * ``uc_all_hash_table_set``
940 * ``udp_tunnel_port_add``
941 * ``udp_tunnel_port_del``
942 * ``l2_tunnel_eth_type_conf``
943 * ``l2_tunnel_offload_set``